Received: by 2002:a05:6358:d09b:b0:dc:cd0c:909e with SMTP id jc27csp6657771rwb; Mon, 12 Dec 2022 05:00:45 -0800 (PST) X-Google-Smtp-Source: AA0mqf7nMuxLOJ0yuBwogC76ulzExzh1oZw0BV/dqRplwoNGl0NqPW7aRZdM6IJLxgJhItkxTguU X-Received: by 2002:a05:6a20:d704:b0:9d:efbf:48de with SMTP id iz4-20020a056a20d70400b0009defbf48demr19408115pzb.34.1670850045113; Mon, 12 Dec 2022 05:00:45 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1670850045; cv=none; d=google.com; s=arc-20160816; b=dHuBqiBPOa+WQLj46Fi+iaOsVL6JZnUePeYDnnHTYGoA0vh88/gMLLE+9Z3WvtRbai 6l0os8QoZ3JfYC1mg10o1RjQK4zOGq6g0Mxr0HEX7Ow3ksZVwbzc3LAN1NhkeI58jlPQ +qFcHotjYGTh17zoV8gLrPC3WK/uw90ruLsoLV3zZulEG6OIVeyVr3RYFmEDLtLIiavX HVcw54SUSBAeLjA/09dxqGyOYifgLnoSVTjtzHNyhxnAlNU9eVeEz2uJOpjE/u79M6LX wB0hngiWpyJdvDCVmphpyIidalIPywVeoeP0lHV2FG1Ldn5P+26B0IVHA0HbgeMx4ruG p1NA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=mw7SboPpZuiyRJowRlWiQwh9TLDhl54cfoFb4bbn8Ng=; b=S+EcpR5zpHrLFp8DjdcN9ESl4YKLCx7RZchPgyHN9O5Ijla60WIkR2Eklp7emS3QJA tpqsbqNY1pqky80cJ09EWXoIUOYkyPfeK79djHUhxAqH/9BNuFY1bwgObcgFDeNHbeEl otNhO2j7+vjX0fVi+x9mCxgnACW/9t60/vEY6gA7pMJ5DlYhM7e/ZVyBMlRu+Zwqej5P 4nuvzuJmlXjFsdW/0q0tgD4ZELdLb979ANPl8dFx6oQa+iBc8Bu5TylkizXXcQi+rAJD yEu001ai9sRLxtXUl8Fu5ioueZGwlNXvzSqhSsQaMvYGIZQ0WqL2VVmomvAtUBnGmO1D MBGw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@bytedance-com.20210112.gappssmtp.com header.s=20210112 header.b=HTyc5qFe; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=bytedance.com Return-Path: Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id 5-20020a630005000000b00479433ac8aasi3676888pga.260.2022.12.12.05.00.35; Mon, 12 Dec 2022 05:00:45 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@bytedance-com.20210112.gappssmtp.com header.s=20210112 header.b=HTyc5qFe; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=bytedance.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232106AbiLLMcs (ORCPT + 75 others); Mon, 12 Dec 2022 07:32:48 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:43328 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232125AbiLLMcn (ORCPT ); Mon, 12 Dec 2022 07:32:43 -0500 Received: from mail-pl1-x631.google.com (mail-pl1-x631.google.com [IPv6:2607:f8b0:4864:20::631]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 96523CDB for ; Mon, 12 Dec 2022 04:32:39 -0800 (PST) Received: by mail-pl1-x631.google.com with SMTP id jn7so11895253plb.13 for ; Mon, 12 Dec 2022 04:32:39 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bytedance-com.20210112.gappssmtp.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=mw7SboPpZuiyRJowRlWiQwh9TLDhl54cfoFb4bbn8Ng=; b=HTyc5qFeHcrSjKoVz/+SDAsZGa75DM0u9AeQKVg2svNqj4tXmj1JTOSg6GcvBotTbA JX+WMUR9QhGYjRld2dUJWYXM/l+RUGfLBCiDMYlMfgHIurQUZmqoBNvzDQu4b4NthogK goSt/uoUuvr/pP+/+F+iteJlTG/+uks9ZmG3woG/VI6i/cD4YQLmtn1An1qhqGVrQFzA BPXJyxt7bujdL2Cz+onoBVWD4tC7h4h3q4uY1Ks1bzXhLhns/FDR1/Suuow6h6EDtfkP 5KmHM9moP+P8e0j1SFg6nleirEoic7ed2prxBkWdECRwKbrK2eBM9QR/dlwuG4Z2Quss pZkQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=mw7SboPpZuiyRJowRlWiQwh9TLDhl54cfoFb4bbn8Ng=; b=HkFKo1hgzTZLOyt3dssx27uOUcjNQiiCCaIM9cv0XKCn2N+RLnY0LDbyzfLCFdUoXC Ww6L/qo7e54CAv8CcAw1o9TNUM6dm9sIZNYGpS2YL2+OfEwUAEXugeiBUQ5vm1LXtuWO 99AEEsTmrWbiT1X/6YW8Pd0dLN02MhAVi5sWye8+0Lfcg91MWObSi4lMl7lJ0V5chzML /7xDwLFlyLGsfGhagYJzdu8ZIvJYPJGTvrdAUuR+ajsFrwmTtkIhukMyqL2u73Gg2VbJ txEg3IwIc45Fy6mep0AGdsXVm3ESDAY+4wlcKf6+oOYb53nBSdapRsawaK7u569FUqze 06QQ== X-Gm-Message-State: ANoB5pkIevqswhsmMtIVZqAvYBBFCBaolRYwCSlnMTJcw+oLJq3f+p3T 2c7GgaDqfRkHOipuqIqnyfPhVQ== X-Received: by 2002:a17:902:b087:b0:189:e81b:d254 with SMTP id p7-20020a170902b08700b00189e81bd254mr15307147plr.60.1670848358948; Mon, 12 Dec 2022 04:32:38 -0800 (PST) Received: from devtp.bytedance.net ([139.177.225.227]) by smtp.gmail.com with ESMTPSA id jw1-20020a170903278100b001869ba04c83sm6219987plb.245.2022.12.12.04.32.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 12 Dec 2022 04:32:38 -0800 (PST) From: wuqiang To: mhiramat@kernel.org, davem@davemloft.net, anil.s.keshavamurthy@intel.com, naveen.n.rao@linux.ibm.com, rostedt@goodmis.org, peterz@infradead.org, akpm@linux-foundation.org, sander@svanheule.net, ebiggers@google.com, dan.j.williams@intel.com, jpoimboe@kernel.org Cc: linux-kernel@vger.kernel.org, lkp@intel.com, mattwu@163.com, wuqiang Subject: [PATCH v7 1/5] lib: objpool added: ring-array based lockless MPMC queue Date: Mon, 12 Dec 2022 20:31:49 +0800 Message-Id: <20221212123153.190888-2-wuqiang.matt@bytedance.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20221212123153.190888-1-wuqiang.matt@bytedance.com> References: <20221212123153.190888-1-wuqiang.matt@bytedance.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,RCVD_IN_DNSWL_NONE,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org The object pool is a scalable implementaion of high performance queue for objects allocation and reclamation, such as kretprobe instances. With leveraging per-cpu ring-array to mitigate the hot spots of memory contention, it could deliver near-linear scalability for high parallel scenarios. The ring-array is compactly managed in a single cache-line to benefit from warmed L1 cache for most cases (<= 4 objects per-core). The body of pre-allocated objects is stored in continuous cache-lines just after the ring-array. The object pool is interrupt safe. Both allocation and reclamation (object pop and push operations) can be preemptible or interruptable. It's best suited for following cases: 1) Memory allocation or reclamation are prohibited or too expensive 2) Consumers are of different priorities, such as irqs and threads Limitations: 1) Maximum objects (capacity) is determined during pool initializing 2) The memory of objects won't be freed until the poll is finalized 3) Object allocation (pop) may fail after trying all cpu slots 4) Object reclamation (push) won't fail but may take long time to finish for imbalanced scenarios. You can try larger max_entries to mitigate, or ( >= CPUS * nr_objs) to avoid Signed-off-by: wuqiang --- include/linux/objpool.h | 109 ++++++++++++++ lib/Makefile | 2 +- lib/objpool.c | 320 ++++++++++++++++++++++++++++++++++++++++ 3 files changed, 430 insertions(+), 1 deletion(-) create mode 100644 include/linux/objpool.h create mode 100644 lib/objpool.c diff --git a/include/linux/objpool.h b/include/linux/objpool.h new file mode 100644 index 000000000000..922e1bc96f2b --- /dev/null +++ b/include/linux/objpool.h @@ -0,0 +1,109 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +#ifndef _LINUX_OBJPOOL_H +#define _LINUX_OBJPOOL_H + +#include + +/* + * objpool: ring-array based lockless MPMC queue + * + * Copyright: wuqiang.matt@bytedance.com + * + * The object pool is a scalable implementaion of high performance queue + * for objects allocation and reclamation, such as kretprobe instances. + * + * With leveraging per-cpu ring-array to mitigate the hot spots of memory + * contention, it could deliver near-linear scalability for high parallel + * scenarios. The ring-array is compactly managed in a single cache-line + * to benefit from warmed L1 cache for most cases (<= 4 objects per-core). + * The body of pre-allocated objects is stored in continuous cache-lines + * just after the ring-array. + * + * The object pool is interrupt safe. Both allocation and reclamation + * (object pop and push operations) can be preemptible or interruptable. + * + * It's best suited for following cases: + * 1) Memory allocation or reclamation are prohibited or too expensive + * 2) Consumers are of different priorities, such as irqs and threads + * + * Limitations: + * 1) Maximum objects (capacity) is determined during pool initializing + * 2) The memory of objects won't be freed until the poll is finalized + * 3) Object allocation (pop) may fail after trying all cpu slots + */ + +/* + * objpool_slot: per-cpu ring array + * + * Represents a cpu-local array-based ring buffer, its size is specialized + * during initialization of object pool. + * + * The objpool_slot is allocated from local memory for NUMA system, and to + * be kept compact in a single cacheline. ages[] is stored just after the + * body of objpool_slot, and then entries[]. The Array of ages[] describes + * revision of each item, solely used to avoid ABA. And array of entries[] + * contains the pointers of objects. + * + * The default size of objpool_slot is a single cache-line, aka. 64 bytes. + * + * 64bit: + * 4 8 12 16 32 64 + * | head | tail | size | mask | ages[4] | ents[4]: (8 * 4) | objects + * + * 32bit: + * 4 8 12 16 32 48 64 + * | head | tail | size | mask | ages[4] | ents[4] | unused | objects + * + */ + +struct objpool_slot { + uint32_t head; /* head of ring array */ + uint32_t tail; /* tail of ring array */ + uint32_t size; /* array size, pow of 2 */ + uint32_t mask; /* size - 1 */ +} __packed; + +struct objpool_head; + +/* caller-specified callback for object initial setup, only called once */ +typedef int (*objpool_init_obj_cb)(void *obj, void *context); + +/* caller-specified cleanup callback for objpool destruction */ +typedef int (*objpool_fini_cb)(struct objpool_head *head, void *context); + +/* + * objpool_head: object pooling metadata + */ + +struct objpool_head { + int obj_size; /* object & element size */ + int nr_objs; /* total objs (to be pre-allocated) */ + int nr_cpus; /* nr_cpu_ids */ + int capacity; /* max objects per cpuslot */ + gfp_t gfp; /* gfp flags for kmalloc & vmalloc */ + unsigned long flags; /* flags for objpool management */ + struct objpool_slot **cpu_slots; /* array of percpu slots */ + int *slot_sizes; /* size in bytes of slots */ + objpool_fini_cb release; /* resource cleanup callback */ + void *context; /* caller-provided context */ +}; + +#define OBJPOOL_FROM_VMALLOC (0x800000000) /* objpool allocated from vmalloc area */ +#define OBJPOOL_HAVE_OBJECTS (0x400000000) /* objects allocated along with objpool */ + +/* initialize object pool and pre-allocate objects */ +int objpool_init(struct objpool_head *head, int nr_objs, int object_size, + gfp_t gfp, void *context, objpool_init_obj_cb objinit, + objpool_fini_cb release); + +/* allocate an object from objects pool */ +void *objpool_pop(struct objpool_head *head); + +/* reclaim an object to objects pool */ +int objpool_push(void *node, struct objpool_head *head); + +/* cleanup the whole object pool (objects including) */ +void objpool_fini(struct objpool_head *head); + +#endif /* _LINUX_OBJPOOL_H */ diff --git a/lib/Makefile b/lib/Makefile index 59bd7c2f793a..f23d9c4fe639 100644 --- a/lib/Makefile +++ b/lib/Makefile @@ -34,7 +34,7 @@ lib-y := ctype.o string.o vsprintf.o cmdline.o \ is_single_threaded.o plist.o decompress.o kobject_uevent.o \ earlycpio.o seq_buf.o siphash.o dec_and_lock.o \ nmi_backtrace.o win_minmax.o memcat_p.o \ - buildid.o + buildid.o objpool.o lib-$(CONFIG_PRINTK) += dump_stack.o lib-$(CONFIG_SMP) += cpumask.o diff --git a/lib/objpool.c b/lib/objpool.c new file mode 100644 index 000000000000..bab8b27e75d7 --- /dev/null +++ b/lib/objpool.c @@ -0,0 +1,320 @@ +// SPDX-License-Identifier: GPL-2.0 + +#include +#include +#include +#include +#include +#include + +/* + * objpool: ring-array based lockless MPMC/FIFO queues + * + * Copyright: wuqiang.matt@bytedance.com + */ + +/* compute the suitable num of objects to be managed by slot */ +static inline int objpool_nobjs(int size) +{ + return rounddown_pow_of_two((size - sizeof(struct objpool_slot)) / + (sizeof(uint32_t) + sizeof(void *))); +} + +#define SLOT_AGES(s) ((uint32_t *)((char *)(s) + sizeof(struct objpool_slot))) +#define SLOT_ENTS(s) ((void **)((char *)(s) + sizeof(struct objpool_slot) + \ + sizeof(uint32_t) * (s)->size)) +#define SLOT_OBJS(s) ((void *)((char *)(s) + sizeof(struct objpool_slot) + \ + (sizeof(uint32_t) + sizeof(void *)) * (s)->size)) +#define SLOT_CORE(n) cpumask_nth((n) % num_possible_cpus(), cpu_possible_mask) + +/* allocate and initialize percpu slots */ +static inline int +objpool_init_percpu_slots(struct objpool_head *head, int nobjs, + void *context, objpool_init_obj_cb objinit) +{ + int i, j, n, size, objsz, cpu = 0, nents = head->capacity; + + /* aligned object size by sizeof(void *) */ + objsz = ALIGN(head->obj_size, sizeof(void *)); + /* shall we allocate objects along with objpool_slot */ + if (objsz) + head->flags |= OBJPOOL_HAVE_OBJECTS; + + for (i = 0; i < head->nr_cpus; i++) { + struct objpool_slot *os; + + /* skip the cpus which could never be present */ + if (!cpu_possible(i)) + continue; + + /* compute how many objects to be managed by this slot */ + n = nobjs / num_possible_cpus(); + if (cpu < (nobjs % num_possible_cpus())) + n++; + size = sizeof(struct objpool_slot) + sizeof(void *) * nents + + sizeof(uint32_t) * nents + objsz * n; + + /* decide memory area for cpu-slot allocation */ + if (!cpu && !(head->gfp & GFP_ATOMIC) && size > PAGE_SIZE / 2) + head->flags |= OBJPOOL_FROM_VMALLOC; + + /* allocate percpu slot & objects from local memory */ + if (head->flags & OBJPOOL_FROM_VMALLOC) + os = __vmalloc_node(size, sizeof(void *), head->gfp, + cpu_to_node(i), __builtin_return_address(0)); + else + os = kmalloc_node(size, head->gfp, cpu_to_node(i)); + if (!os) + return -ENOMEM; + + /* initialize percpu slot for the i-th slot */ + memset(os, 0, size); + os->size = head->capacity; + os->mask = os->size - 1; + head->cpu_slots[i] = os; + head->slot_sizes[i] = size; + cpu = cpu + 1; + + /* + * start from 2nd round to avoid conflict of 1st item. + * we assume that the head item is ready for retrieval + * iff head is equal to ages[head & mask]. but ages is + * initialized as 0, so in view of the caller of pop(), + * the 1st item (0th) is always ready, but fact could + * be: push() is stalled before the final update, thus + * the item being inserted will be lost forever. + */ + os->head = os->tail = head->capacity; + + if (!objsz) + continue; + + for (j = 0; j < n; j++) { + uint32_t *ages = SLOT_AGES(os); + void **ents = SLOT_ENTS(os); + void *obj = SLOT_OBJS(os) + j * objsz; + uint32_t ie = os->tail & os->mask; + + /* perform object initialization */ + if (objinit) { + int rc = objinit(obj, context); + if (rc) + return rc; + } + + /* add obj into the ring array */ + ents[ie] = obj; + ages[ie] = os->tail; + os->tail++; + head->nr_objs++; + } + } + + return 0; +} + +/* cleanup all percpu slots of the object pool */ +static inline void objpool_fini_percpu_slots(struct objpool_head *head) +{ + int i; + + if (!head->cpu_slots) + return; + + for (i = 0; i < head->nr_cpus; i++) { + if (!head->cpu_slots[i]) + continue; + if (head->flags & OBJPOOL_FROM_VMALLOC) + vfree(head->cpu_slots[i]); + else + kfree(head->cpu_slots[i]); + } + kfree(head->cpu_slots); + head->cpu_slots = NULL; + head->slot_sizes = NULL; +} + +/** + * objpool_init: initialize object pool and pre-allocate objects + * + * args: + * @head: the object pool to be initialized, declared by caller + * @nr_objs: total objects to be pre-allocated by this object pool + * @object_size: size of an object, no objects pre-allocated if 0 + * @gfp: flags for memory allocation (via kmalloc or vmalloc) + * @context: user context for object initialization callback + * @objinit: object initialization callback for extra setting-up + * @release: cleanup callback for private objects/pool/context + * + * return: + * 0 for success, otherwise error code + * + * All pre-allocated objects are to be zeroed. Caller could do extra + * initialization in objinit callback. The objinit callback will be + * called once and only once after the slot allocation. Then objpool + * won't touch any content of the objects since then. It's caller's + * duty to perform reinitialization after object allocation (pop) or + * clearance before object reclamation (push) if required. + */ +int objpool_init(struct objpool_head *head, int nr_objs, int object_size, + gfp_t gfp, void *context, objpool_init_obj_cb objinit, + objpool_fini_cb release) +{ + int nents, rc; + + /* check input parameters */ + if (nr_objs <= 0 || object_size < 0) + return -EINVAL; + + /* calculate percpu slot size (rounded to pow of 2) */ + nents = max_t(int, roundup_pow_of_two(nr_objs), + objpool_nobjs(L1_CACHE_BYTES)); + + /* initialize objpool head */ + memset(head, 0, sizeof(struct objpool_head)); + head->nr_cpus = nr_cpu_ids; + head->obj_size = object_size; + head->capacity = nents; + head->gfp = gfp & ~__GFP_ZERO; + head->context = context; + head->release = release; + + /* allocate array for percpu slots */ + head->cpu_slots = kzalloc(head->nr_cpus * sizeof(void *) + + head->nr_cpus * sizeof(uint32_t), head->gfp); + if (!head->cpu_slots) + return -ENOMEM; + head->slot_sizes = (uint32_t *)&head->cpu_slots[head->nr_cpus]; + + /* initialize per-cpu slots */ + rc = objpool_init_percpu_slots(head, nr_objs, context, objinit); + if (rc) + objpool_fini_percpu_slots(head); + + return rc; +} +EXPORT_SYMBOL_GPL(objpool_init); + +/* adding object to slot tail, the given slot must NOT be full */ +static inline int objpool_add_slot(void *obj, struct objpool_slot *os) +{ + uint32_t *ages = SLOT_AGES(os); + void **ents = SLOT_ENTS(os); + uint32_t tail = atomic_inc_return((atomic_t *)&os->tail) - 1; + + WRITE_ONCE(ents[tail & os->mask], obj); + + /* order matters: obj must be updated before tail updating */ + smp_store_release(&ages[tail & os->mask], tail); + return 0; +} + +/** + * objpool_push: reclaim the object and return back to objects pool + * + * args: + * @obj: object pointer to be pushed to object pool + * @head: object pool + * + * return: + * 0 or error code: it fails only when objects pool are full + * + * objpool_push is non-blockable, and can be nested + */ +int objpool_push(void *obj, struct objpool_head *head) +{ + int cpu = raw_smp_processor_id(); + + return objpool_add_slot(obj, head->cpu_slots[cpu]); +} +EXPORT_SYMBOL_GPL(objpool_push); + +/* try to retrieve object from slot */ +static inline void *objpool_try_get_slot(struct objpool_slot *os) +{ + uint32_t *ages = SLOT_AGES(os); + void **ents = SLOT_ENTS(os); + /* do memory load of head to local head */ + uint32_t head = smp_load_acquire(&os->head); + + /* loop if slot isn't empty */ + while (head != READ_ONCE(os->tail)) { + uint32_t id = head & os->mask, prev = head; + + /* do prefetching of object ents */ + prefetch(&ents[id]); + + /* + * check whether this item was ready for retrieval ? There's + * possibility * in theory * we might retrieve wrong object, + * in case ages[id] overflows when current task is sleeping, + * but it will take very very long to overflow an uint32_t + */ + if (smp_load_acquire(&ages[id]) == head) { + /* node must have been udpated by push() */ + void *node = READ_ONCE(ents[id]); + /* commit and move forward head of the slot */ + if (try_cmpxchg_release(&os->head, &head, head + 1)) + return node; + } + + /* re-load head from memory and continue trying */ + head = READ_ONCE(os->head); + /* + * head stays unchanged, so it's very likely current pop() + * just preempted/interrupted an ongoing push() operation + */ + if (head == prev) + break; + } + + return NULL; +} + +/** + * objpool_pop: allocate an object from objects pool + * + * args: + * @head: object pool + * + * return: + * object: NULL if failed (object pool is empty) + * + * objpool_pop can be nested, so can be used in any context. + */ +void *objpool_pop(struct objpool_head *head) +{ + int i, cpu = raw_smp_processor_id(); + void *obj = NULL; + + for (i = 0; i < num_possible_cpus(); i++) { + obj = objpool_try_get_slot(head->cpu_slots[cpu]); + if (obj) + break; + cpu = cpumask_next_wrap(cpu, cpu_possible_mask, -1, 1); + } + + return obj; +} +EXPORT_SYMBOL_GPL(objpool_pop); + +/** + * objpool_fini: cleanup the whole object pool (releasing all objects) + * + * args: + * @head: object pool to be released + * + */ +void objpool_fini(struct objpool_head *head) +{ + if (!head->cpu_slots) + return; + + /* release percpu slots */ + objpool_fini_percpu_slots(head); + + /* call user's cleanup callback if provided */ + if (head->release) + head->release(head, head->context); +} +EXPORT_SYMBOL_GPL(objpool_fini); -- 2.34.1