cpython/Include/cpython/object.h at 3.14 · python/cpython

History

493 lines (408 loc) · 17 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

#ifndef Py_CPYTHON_OBJECT_H

# error "this header file must not be included directly"

#endif

PyAPI_FUNC(void) _Py_NewReference(PyObject *op);

PyAPI_FUNC(void) _Py_NewReferenceNoTotal(PyObject *op);

PyAPI_FUNC(void) _Py_ResurrectReference(PyObject *op);

PyAPI_FUNC(void) _Py_ForgetReference(PyObject *op);

#ifdef Py_REF_DEBUG

/* These are useful as debugging aids when chasing down refleaks. */

PyAPI_FUNC(Py_ssize_t) _Py_GetGlobalRefTotal(void);

# define _Py_GetRefTotal() _Py_GetGlobalRefTotal()

PyAPI_FUNC(Py_ssize_t) _Py_GetLegacyRefTotal(void);

PyAPI_FUNC(Py_ssize_t) _PyInterpreterState_GetRefTotal(PyInterpreterState *);

#endif

/********************* String Literals ****************************************/

/* This structure helps managing static strings. The basic usage goes like this:

Instead of doing

r = PyObject_CallMethod(o, "foo", "args", ...);

_Py_IDENTIFIER(foo);

...

r = _PyObject_CallMethodId(o, &PyId_foo, "args", ...);

PyId_foo is a static variable, either on block level or file level. On first

usage, the string "foo" is interned, and the structures are linked. On interpreter

shutdown, all strings are released.

Alternatively, _Py_static_string allows choosing the variable name.

_PyUnicode_FromId returns a borrowed reference to the interned string.

_PyObject_{Get,Set,Has}AttrId are __getattr__ versions using _Py_Identifier*.

typedef struct _Py_Identifier {

const char* string;

// Index in PyInterpreterState.unicode.ids.array. It is process-wide

// unique and must be initialized to -1.

Py_ssize_t index;

// Hidden PyMutex struct for non free-threaded build.

struct {

uint8_t v;

} mutex;

} _Py_Identifier;

#ifndef Py_BUILD_CORE

// For now we are keeping _Py_IDENTIFIER for continued use

// in non-builtin extensions (and naughty PyPI modules).

#define _Py_static_string_init(value) { .string = (value), .index = -1 }

#define _Py_static_string(varname, value) static _Py_Identifier varname = _Py_static_string_init(value)

#define _Py_IDENTIFIER(varname) _Py_static_string(PyId_##varname, #varname)

#endif /* !Py_BUILD_CORE */

typedef struct {

/* Number implementations must check *both*

arguments for proper type and implement the necessary conversions

in the slot functions themselves. */

binaryfunc nb_add;

binaryfunc nb_subtract;

binaryfunc nb_multiply;

binaryfunc nb_remainder;

binaryfunc nb_divmod;

ternaryfunc nb_power;

unaryfunc nb_negative;

unaryfunc nb_positive;

unaryfunc nb_absolute;

inquiry nb_bool;

unaryfunc nb_invert;

binaryfunc nb_lshift;

binaryfunc nb_rshift;

binaryfunc nb_and;

binaryfunc nb_xor;

binaryfunc nb_or;

unaryfunc nb_int;

void *nb_reserved; /* the slot formerly known as nb_long */

unaryfunc nb_float;

binaryfunc nb_inplace_add;

binaryfunc nb_inplace_subtract;

binaryfunc nb_inplace_multiply;

binaryfunc nb_inplace_remainder;

ternaryfunc nb_inplace_power;

binaryfunc nb_inplace_lshift;

binaryfunc nb_inplace_rshift;

binaryfunc nb_inplace_and;

binaryfunc nb_inplace_xor;

binaryfunc nb_inplace_or;

binaryfunc nb_floor_divide;

binaryfunc nb_true_divide;

binaryfunc nb_inplace_floor_divide;

binaryfunc nb_inplace_true_divide;

unaryfunc nb_index;

binaryfunc nb_matrix_multiply;

binaryfunc nb_inplace_matrix_multiply;

} PyNumberMethods;

typedef struct {

lenfunc sq_length;

binaryfunc sq_concat;

ssizeargfunc sq_repeat;

ssizeargfunc sq_item;

void *was_sq_slice;

ssizeobjargproc sq_ass_item;

void *was_sq_ass_slice;

objobjproc sq_contains;

binaryfunc sq_inplace_concat;

ssizeargfunc sq_inplace_repeat;

} PySequenceMethods;

typedef struct {

lenfunc mp_length;

binaryfunc mp_subscript;

objobjargproc mp_ass_subscript;

} PyMappingMethods;

typedef PySendResult (*sendfunc)(PyObject *iter, PyObject *value, PyObject **result);

typedef struct {

unaryfunc am_await;

unaryfunc am_aiter;

unaryfunc am_anext;

sendfunc am_send;

} PyAsyncMethods;

typedef struct {

getbufferproc bf_getbuffer;

releasebufferproc bf_releasebuffer;

} PyBufferProcs;

/* Allow printfunc in the tp_vectorcall_offset slot for

* backwards-compatibility */

typedef Py_ssize_t printfunc;

// If this structure is modified, Doc/includes/typestruct.h should be updated

// as well.

struct _typeobject {

PyObject_VAR_HEAD

const char *tp_name; /* For printing, in format "<module>.<name>" */

Py_ssize_t tp_basicsize, tp_itemsize; /* For allocation */

/* Methods to implement standard operations */

destructor tp_dealloc;

Py_ssize_t tp_vectorcall_offset;

getattrfunc tp_getattr;

setattrfunc tp_setattr;

PyAsyncMethods *tp_as_async; /* formerly known as tp_compare (Python 2)

or tp_reserved (Python 3) */

reprfunc tp_repr;

/* Method suites for standard classes */

PyNumberMethods *tp_as_number;

PySequenceMethods *tp_as_sequence;

PyMappingMethods *tp_as_mapping;

/* More standard operations (here for binary compatibility) */

hashfunc tp_hash;

ternaryfunc tp_call;

reprfunc tp_str;

getattrofunc tp_getattro;

setattrofunc tp_setattro;

/* Functions to access object as input/output buffer */

PyBufferProcs *tp_as_buffer;

/* Flags to define presence of optional/expanded features */

unsigned long tp_flags;

const char *tp_doc; /* Documentation string */

/* Assigned meaning in release 2.0 */

/* call function for all accessible objects */

traverseproc tp_traverse;

/* delete references to contained objects */

inquiry tp_clear;

/* Assigned meaning in release 2.1 */

/* rich comparisons */

richcmpfunc tp_richcompare;

/* weak reference enabler */

Py_ssize_t tp_weaklistoffset;

/* Iterators */

getiterfunc tp_iter;

iternextfunc tp_iternext;

/* Attribute descriptor and subclassing stuff */

PyMethodDef *tp_methods;

PyMemberDef *tp_members;

PyGetSetDef *tp_getset;

// Strong reference on a heap type, borrowed reference on a static type

PyTypeObject *tp_base;

PyObject *tp_dict;

descrgetfunc tp_descr_get;

descrsetfunc tp_descr_set;

Py_ssize_t tp_dictoffset;

initproc tp_init;

allocfunc tp_alloc;

newfunc tp_new;

freefunc tp_free; /* Low-level free-memory routine */

inquiry tp_is_gc; /* For PyObject_IS_GC */

PyObject *tp_bases;

PyObject *tp_mro; /* method resolution order */

PyObject *tp_cache; /* no longer used */

void *tp_subclasses; /* for static builtin types this is an index */

PyObject *tp_weaklist; /* not used for static builtin types */

destructor tp_del;

/* Type attribute cache version tag. Added in version 2.6.

* If zero, the cache is invalid and must be initialized.

unsigned int tp_version_tag;

destructor tp_finalize;

vectorcallfunc tp_vectorcall;

/* bitset of which type-watchers care about this type */

unsigned char tp_watched;

/* Number of tp_version_tag values used.

* Set to _Py_ATTR_CACHE_UNUSED if the attribute cache is

* disabled for this type (e.g. due to custom MRO entries).

* Otherwise, limited to MAX_VERSIONS_PER_CLASS (defined elsewhere).

uint16_t tp_versions_used;

};

#define _Py_ATTR_CACHE_UNUSED (30000) // (see tp_versions_used)

/* This struct is used by the specializer

* It should be treated as an opaque blob

* by code other than the specializer and interpreter. */

struct _specialization_cache {

// In order to avoid bloating the bytecode with lots of inline caches, the

// members of this structure have a somewhat unique contract. They are set

// by the specialization machinery, and are invalidated by PyType_Modified.

// The rules for using them are as follows:

// - If getitem is non-NULL, then it is the same Python function that

// PyType_Lookup(cls, "__getitem__") would return.

// - If getitem is NULL, then getitem_version is meaningless.

// - If getitem->func_version == getitem_version, then getitem can be called

// with two positional arguments and no keyword arguments, and has neither

// *args nor **kwargs (as required by BINARY_OP_SUBSCR_GETITEM):

PyObject *getitem;

uint32_t getitem_version;

PyObject *init;

};

/* The *real* layout of a type object when allocated on the heap */

typedef struct _heaptypeobject {

/* Note: there's a dependency on the order of these members

in slotptr() in typeobject.c . */

PyTypeObject ht_type;

PyAsyncMethods as_async;

PyNumberMethods as_number;

PyMappingMethods as_mapping;

PySequenceMethods as_sequence; /* as_sequence comes after as_mapping,

so that the mapping wins when both

the mapping and the sequence define

a given operator (e.g. __getitem__).

see add_operators() in typeobject.c . */

PyBufferProcs as_buffer;

PyObject *ht_name, *ht_slots, *ht_qualname;

struct _dictkeysobject *ht_cached_keys;

PyObject *ht_module;

char *_ht_tpname; // Storage for "tp_name"; see PyType_FromModuleAndSpec

void *ht_token; // Storage for the "Py_tp_token" slot

struct _specialization_cache _spec_cache; // For use by the specializer.

#ifdef Py_GIL_DISABLED

Py_ssize_t unique_id; // ID used for per-thread refcounting

#endif

/* here are optional user slots, followed by the members. */

} PyHeapTypeObject;

PyAPI_FUNC(const char *) _PyType_Name(PyTypeObject *);

PyAPI_FUNC(PyObject *) _PyType_Lookup(PyTypeObject *, PyObject *);

PyAPI_FUNC(PyObject *) _PyType_LookupRef(PyTypeObject *, PyObject *);

PyAPI_FUNC(PyObject *) PyType_GetDict(PyTypeObject *);

PyAPI_FUNC(int) PyObject_Print(PyObject *, FILE *, int);

PyAPI_FUNC(void) _Py_BreakPoint(void);

PyAPI_FUNC(void) _PyObject_Dump(PyObject *);

PyAPI_FUNC(PyObject*) _PyObject_GetAttrId(PyObject *, _Py_Identifier *);

PyAPI_FUNC(PyObject **) _PyObject_GetDictPtr(PyObject *);

PyAPI_FUNC(void) PyObject_CallFinalizer(PyObject *);

PyAPI_FUNC(int) PyObject_CallFinalizerFromDealloc(PyObject *);

PyAPI_FUNC(void) PyUnstable_Object_ClearWeakRefsNoCallbacks(PyObject *);

/* Same as PyObject_Generic{Get,Set}Attr, but passing the attributes

dict as the last parameter. */

PyAPI_FUNC(PyObject *)

_PyObject_GenericGetAttrWithDict(PyObject *, PyObject *, PyObject *, int);

PyAPI_FUNC(int)

_PyObject_GenericSetAttrWithDict(PyObject *, PyObject *,

PyObject *, PyObject *);

PyAPI_FUNC(PyObject *) _PyObject_FunctionStr(PyObject *);

/* Safely decref `dst` and set `dst` to `src`.

* As in case of Py_CLEAR "the obvious" code can be deadly:

* Py_DECREF(dst);

* dst = src;

* The safe way is:

* Py_SETREF(dst, src);

* That arranges to set `dst` to `src` _before_ decref'ing, so that any code

* triggered as a side-effect of `dst` getting torn down no longer believes

* `dst` points to a valid object.

* Temporary variables are used to only evaluate macro arguments once and so

* avoid the duplication of side effects. _Py_TYPEOF() or memcpy() is used to

* avoid a miscompilation caused by type punning. See Py_CLEAR() comment for

* implementation details about type punning.

* The memcpy() implementation does not emit a compiler warning if 'src' has

* not the same type than 'src': any pointer type is accepted for 'src'.

#ifdef _Py_TYPEOF

#define Py_SETREF(dst, src) \

do { \

_Py_TYPEOF(dst)* _tmp_dst_ptr = &(dst); \

_Py_TYPEOF(dst) _tmp_old_dst = (*_tmp_dst_ptr); \

*_tmp_dst_ptr = (src); \

Py_DECREF(_tmp_old_dst); \

} while (0)

#else

#define Py_SETREF(dst, src) \

do { \

PyObject **_tmp_dst_ptr = _Py_CAST(PyObject**, &(dst)); \

PyObject *_tmp_old_dst = (*_tmp_dst_ptr); \

PyObject *_tmp_src = _PyObject_CAST(src); \

memcpy(_tmp_dst_ptr, &_tmp_src, sizeof(PyObject*)); \

Py_DECREF(_tmp_old_dst); \

} while (0)

#endif

/* Py_XSETREF() is a variant of Py_SETREF() that uses Py_XDECREF() instead of

* Py_DECREF().

#ifdef _Py_TYPEOF

#define Py_XSETREF(dst, src) \

do { \

_Py_TYPEOF(dst)* _tmp_dst_ptr = &(dst); \

_Py_TYPEOF(dst) _tmp_old_dst = (*_tmp_dst_ptr); \

*_tmp_dst_ptr = (src); \

Py_XDECREF(_tmp_old_dst); \

} while (0)

#else

#define Py_XSETREF(dst, src) \

do { \

PyObject **_tmp_dst_ptr = _Py_CAST(PyObject**, &(dst)); \

PyObject *_tmp_old_dst = (*_tmp_dst_ptr); \

PyObject *_tmp_src = _PyObject_CAST(src); \

memcpy(_tmp_dst_ptr, &_tmp_src, sizeof(PyObject*)); \

Py_XDECREF(_tmp_old_dst); \

} while (0)

#endif

/* Define a pair of assertion macros:

_PyObject_ASSERT_FROM(), _PyObject_ASSERT_WITH_MSG() and _PyObject_ASSERT().

These work like the regular C assert(), in that they will abort the

process with a message on stderr if the given condition fails to hold,

but compile away to nothing if NDEBUG is defined.

However, before aborting, Python will also try to call _PyObject_Dump() on

the given object. This may be of use when investigating bugs in which a

particular object is corrupt (e.g. buggy a tp_visit method in an extension

module breaking the garbage collector), to help locate the broken objects.

The WITH_MSG variant allows you to supply an additional message that Python

will attempt to print to stderr, after the object dump. */

#ifdef NDEBUG

/* No debugging: compile away the assertions: */

# define _PyObject_ASSERT_FROM(obj, expr, msg, filename, lineno, func) \

((void)0)

#else

/* With debugging: generate checks: */

# define _PyObject_ASSERT_FROM(obj, expr, msg, filename, lineno, func) \

((expr) \

? (void)(0) \

: _PyObject_AssertFailed((obj), Py_STRINGIFY(expr), \

(msg), (filename), (lineno), (func)))

#endif

#define _PyObject_ASSERT_WITH_MSG(obj, expr, msg) \

_PyObject_ASSERT_FROM((obj), expr, (msg), __FILE__, __LINE__, __func__)

#define _PyObject_ASSERT(obj, expr) \

_PyObject_ASSERT_WITH_MSG((obj), expr, NULL)

#define _PyObject_ASSERT_FAILED_MSG(obj, msg) \

_PyObject_AssertFailed((obj), NULL, (msg), __FILE__, __LINE__, __func__)

/* Declare and define _PyObject_AssertFailed() even when NDEBUG is defined,

to avoid causing compiler/linker errors when building extensions without

NDEBUG against a Python built with NDEBUG defined.

msg, expr and function can be NULL. */

PyAPI_FUNC(void) _Py_NO_RETURN _PyObject_AssertFailed(

PyObject *obj,

const char *expr,

const char *msg,

const char *file,

int line,

const char *function);

PyAPI_FUNC(void) _PyTrash_thread_deposit_object(PyThreadState *tstate, PyObject *op);

PyAPI_FUNC(void) _PyTrash_thread_destroy_chain(PyThreadState *tstate);

PyAPI_FUNC(int) _Py_ReachedRecursionLimitWithMargin(PyThreadState *tstate, int margin_count);

/* For backwards compatibility with the old trashcan mechanism */

#define Py_TRASHCAN_BEGIN(op, dealloc)

#define Py_TRASHCAN_END

PyAPI_FUNC(void *) PyObject_GetItemData(PyObject *obj);

PyAPI_FUNC(int) PyObject_VisitManagedDict(PyObject *obj, visitproc visit, void *arg);

PyAPI_FUNC(int) _PyObject_SetManagedDict(PyObject *obj, PyObject *new_dict);

PyAPI_FUNC(void) PyObject_ClearManagedDict(PyObject *obj);

typedef int(*PyType_WatchCallback)(PyTypeObject *);

PyAPI_FUNC(int) PyType_AddWatcher(PyType_WatchCallback callback);

PyAPI_FUNC(int) PyType_ClearWatcher(int watcher_id);

PyAPI_FUNC(int) PyType_Watch(int watcher_id, PyObject *type);

PyAPI_FUNC(int) PyType_Unwatch(int watcher_id, PyObject *type);

/* Attempt to assign a version tag to the given type.

* Returns 1 if the type already had a valid version tag or a new one was

* assigned, or 0 if a new tag could not be assigned.

PyAPI_FUNC(int) PyUnstable_Type_AssignVersionTag(PyTypeObject *type);

typedef enum {

PyRefTracer_CREATE = 0,

PyRefTracer_DESTROY = 1,

} PyRefTracerEvent;

typedef int (*PyRefTracer)(PyObject *, PyRefTracerEvent event, void *);

PyAPI_FUNC(int) PyRefTracer_SetTracer(PyRefTracer tracer, void *data);

PyAPI_FUNC(PyRefTracer) PyRefTracer_GetTracer(void**);

/* Enable PEP-703 deferred reference counting on the object.

* Returns 1 if deferred reference counting was successfully enabled, and

* 0 if the runtime ignored it. This function cannot fail.

PyAPI_FUNC(int) PyUnstable_Object_EnableDeferredRefcount(PyObject *);

/* Determine if the object exists as a unique temporary variable on the

* topmost frame of the interpreter.

PyAPI_FUNC(int) PyUnstable_Object_IsUniqueReferencedTemporary(PyObject *);

/* Check whether the object is immortal. This cannot fail. */

PyAPI_FUNC(int) PyUnstable_IsImmortal(PyObject *);

// Increments the reference count of the object, if it's not zero.

// PyUnstable_EnableTryIncRef() should be called on the object

// before calling this function in order to avoid spurious failures.

PyAPI_FUNC(int) PyUnstable_TryIncRef(PyObject *);

PyAPI_FUNC(void) PyUnstable_EnableTryIncRef(PyObject *);

PyAPI_FUNC(int) PyUnstable_Object_IsUniquelyReferenced(PyObject *);

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

FilesExpand file tree

object.h

Latest commit

History

object.h

File metadata and controls