include/linux/objpool.h

15  * object allocation and reclamation, such as kretprobe instances.
35  * @entries: object entries on this slot
38  * during initialization of object pool. The percpu objpool node is to be
60  * caller-specified callback for object initial setup, it's only called
61  * once for each object (just after the memory allocation of the object)
69  * struct objpool_head - object pooling metadata
70  * @obj_size:   object size, aligned to sizeof(void *)
95 #define OBJPOOL_OBJECT_SIZE_MAX	(1UL << 16) /* maximum size of an object */
99  * @pool:    the object pool to be initialized, declared by caller
100  * @nr_objs: total objects to be pre-allocated by this object pool
101  * @object_size: size of an object (should be > 0)
103  * @context: user context for object initialization callback
104  * @objinit: object initialization callback for extra setup
112  * each object. After that the objpool won't touch any content of the
114  * pop (object allocation) or do clearance before each push (object
122  * objpool_pop() - allocate an object from objpool
123  * @pool: object pool
125  * return value: object ptr or NULL if failed
130  * objpool_push() - reclaim the object and return back to objpool
131  * @obj:  object ptr to be pushed to objpool
132  * @pool: object pool
135  * the same object multiple times or wrong "objects" into objpool)
140  * objpool_drop() - discard the object and deref objpool
141  * @obj:  object ptr to be discarded
142  * @pool: object pool
152  * only when the last outstanding object is dropped could the whole
159  * @pool: object pool to be released
164  * objpool_fini() - deref object pool (also releasing unused objects)
165  * @pool: object pool to be dereferenced