Where Online Learning is simpler!

The C and C++ Include Header Files

cat -n /usr/include/python3.14/internal/pycore_freelist.h

     1	#ifndef Py_INTERNAL_FREELIST_H
     2	#define Py_INTERNAL_FREELIST_H
     3	#ifdef __cplusplus
     4	extern "C" {
     5	#endif
     6	
     7	#ifndef Py_BUILD_CORE
     8	#  error "this header requires Py_BUILD_CORE define"
     9	#endif
    10	
    11	#include "pycore_freelist_state.h"      // struct _Py_freelists
    12	#include "pycore_interp_structs.h"      // PyInterpreterState
    13	#include "pycore_pyatomic_ft_wrappers.h" // FT_ATOMIC_STORE_PTR_RELAXED()
    14	#include "pycore_pystate.h"             // _PyThreadState_GET
    15	#include "pycore_stats.h"               // OBJECT_STAT_INC
    16	
    17	static inline struct _Py_freelists *
    18	_Py_freelists_GET(void)
    19	{
    20	    PyThreadState *tstate = _PyThreadState_GET();
    21	#ifdef Py_DEBUG
    22	    _Py_EnsureTstateNotNULL(tstate);
    23	#endif
    24	
    25	#ifdef Py_GIL_DISABLED
    26	    return &((_PyThreadStateImpl*)tstate)->freelists;
    27	#else
    28	    return &tstate->interp->object_state.freelists;
    29	#endif
    30	}
    31	
    32	// Pushes `op` to the freelist, calls `freefunc` if the freelist is full
    33	#define _Py_FREELIST_FREE(NAME, op, freefunc) \
    34	    _PyFreeList_Free(&_Py_freelists_GET()->NAME, _PyObject_CAST(op), \
    35	                     Py_ ## NAME ## _MAXFREELIST, freefunc)
    36	// Pushes `op` to the freelist, returns 1 if successful, 0 if the freelist is full
    37	#define _Py_FREELIST_PUSH(NAME, op, limit) \
    38	    _PyFreeList_Push(&_Py_freelists_GET()->NAME, _PyObject_CAST(op), limit)
    39	
    40	// Pops a PyObject from the freelist, returns NULL if the freelist is empty.
    41	#define _Py_FREELIST_POP(TYPE, NAME) \
    42	    _Py_CAST(TYPE*, _PyFreeList_Pop(&_Py_freelists_GET()->NAME))
    43	
    44	// Pops a non-PyObject data structure from the freelist, returns NULL if the
    45	// freelist is empty.
    46	#define _Py_FREELIST_POP_MEM(NAME) \
    47	    _PyFreeList_PopMem(&_Py_freelists_GET()->NAME)
    48	
    49	#define _Py_FREELIST_SIZE(NAME) (int)((_Py_freelists_GET()->NAME).size)
    50	
    51	static inline int
    52	_PyFreeList_Push(struct _Py_freelist *fl, void *obj, Py_ssize_t maxsize)
    53	{
    54	    if (fl->size < maxsize && fl->size >= 0) {
    55	        FT_ATOMIC_STORE_PTR_RELAXED(*(void **)obj, fl->freelist);
    56	        fl->freelist = obj;
    57	        fl->size++;
    58	        OBJECT_STAT_INC(to_freelist);
    59	        return 1;
    60	    }
    61	    return 0;
    62	}
    63	
    64	static inline void
    65	_PyFreeList_Free(struct _Py_freelist *fl, void *obj, Py_ssize_t maxsize,
    66	                 freefunc dofree)
    67	{
    68	    if (!_PyFreeList_Push(fl, obj, maxsize)) {
    69	        dofree(obj);
    70	    }
    71	}
    72	
    73	static inline void *
    74	_PyFreeList_PopNoStats(struct _Py_freelist *fl)
    75	{
    76	    void *obj = fl->freelist;
    77	    if (obj != NULL) {
    78	        assert(fl->size > 0);
    79	        fl->freelist = *(void **)obj;
    80	        fl->size--;
    81	    }
    82	    return obj;
    83	}
    84	
    85	static inline PyObject *
    86	_PyFreeList_Pop(struct _Py_freelist *fl)
    87	{
    88	    PyObject *op = _PyFreeList_PopNoStats(fl);
    89	    if (op != NULL) {
    90	        OBJECT_STAT_INC(from_freelist);
    91	        _Py_NewReference(op);
    92	    }
    93	    return op;
    94	}
    95	
    96	static inline void *
    97	_PyFreeList_PopMem(struct _Py_freelist *fl)
    98	{
    99	    void *op = _PyFreeList_PopNoStats(fl);
   100	    if (op != NULL) {
   101	        OBJECT_STAT_INC(from_freelist);
   102	    }
   103	    return op;
   104	}
   105	
   106	extern void _PyObject_ClearFreeLists(struct _Py_freelists *freelists, int is_finalization);
   107	
   108	#ifdef __cplusplus
   109	}
   110	#endif
   111	#endif /* !Py_INTERNAL_FREELIST_H */