xref: /spdk/lib/env_ocf/mpool.h (revision cc6920a4763d4b9a43aa40583c8397d8f14fa100)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright (c) Intel Corporation.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #ifndef OCF_MPOOL_H
35 #define OCF_MPOOL_H
36 
37 enum {
38 	env_mpool_1,
39 	env_mpool_2,
40 	env_mpool_4,
41 	env_mpool_8,
42 	env_mpool_16,
43 	env_mpool_32,
44 	env_mpool_64,
45 	env_mpool_128,
46 
47 	env_mpool_max
48 };
49 
50 struct env_mpool;
51 
52 struct env_mpool *env_mpool_create(uint32_t hdr_size, uint32_t elem_size,
53 				   int flags, int mpool_max, bool fallback,
54 				   const uint32_t limits[env_mpool_max],
55 				   const char *name_perfix, bool zero);
56 
57 void env_mpool_destroy(struct env_mpool *mpools);
58 
59 void *env_mpool_new(struct env_mpool *mpool, uint32_t count);
60 
61 bool env_mpool_del(struct env_mpool *mpool,
62 		   void *items, uint32_t count);
63 
64 #endif
65