diff options
author | Konstantin Ananyev <konstantin.ananyev@intel.com> | 2019-06-27 19:28:26 +0100 |
---|---|---|
committer | Konstantin Ananyev <konstantin.ananyev@intel.com> | 2019-12-31 11:42:11 +0000 |
commit | 703faabf2d44d245fe1dd0b75f1736bf6114a557 (patch) | |
tree | 1695eb924b9ff8236e0eabb084ab6b969c162d88 /lib | |
parent | 0ee0943991b7d2cb43c63c76ba59035cacbc1b91 (diff) |
v6: memtank introduction
For analogy with mempool, named this structure memtank.
Same a s mempool it allows to alloc/free objects of fixed size
in a lightweight manner (not as lightweight as mempool,
but hopefully close enough).
The whole idea is that alloc/free is used at fast-path and don't
allocate/free more than *min_free* objects at one call.
So for majority of cases our fast-path alloc/free should be lightweight
(LIFO enqueue/dequeue operations).
Also user will need to call grow/shrink periodically
(ideally from the slow-path) to make sure there is enough
free objects in the tank.
Internally it is just a simple LIFO for up to *max_free* objects plus
a list of memory buffers (memchunk) from where these objects were
allocated.
v1 -> v2
- Added UT
- Fixed few bugs
v2 -> v3
- extend UT with more parameters
v3 -> v4
- add object alignement as parameter for memtank_create
- extend UT with more parameters
- added memtank dump routine
v4 -> v5
- fixed few bugs inside memtank lib
- extend UT with:
- new test case
- new command-line options: '-s <obj_size>', '-m <mem_func>'
v5 -> v6
- extend memtank dump to collect/display extra information
- make memtank dump routine MT safe
- add memtank sanity check function
- add proper comments for pubic API
Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
Change-Id: I8939772577f5d9e293088eaa9a9fe316c3fe8f87
Diffstat (limited to 'lib')
-rw-r--r-- | lib/Makefile | 1 | ||||
-rw-r--r-- | lib/libtle_memtank/Makefile | 40 | ||||
-rw-r--r-- | lib/libtle_memtank/memtank.c | 507 | ||||
-rw-r--r-- | lib/libtle_memtank/memtank.h | 107 | ||||
-rw-r--r-- | lib/libtle_memtank/misc.c | 381 | ||||
-rw-r--r-- | lib/libtle_memtank/tle_memtank.h | 274 | ||||
-rw-r--r-- | lib/libtle_memtank/tle_memtank_pub.h | 149 |
7 files changed, 1459 insertions, 0 deletions
diff --git a/lib/Makefile b/lib/Makefile index 6317af9..8d61a08 100644 --- a/lib/Makefile +++ b/lib/Makefile @@ -24,6 +24,7 @@ include $(RTE_SDK)/mk/rte.vars.mk DIRS-y += libtle_misc DIRS-y += libtle_dring DIRS-y += libtle_timer +DIRS-y += libtle_memtank DIRS-y += libtle_l4p include $(TLDK_ROOT)/mk/tle.subdir.mk diff --git a/lib/libtle_memtank/Makefile b/lib/libtle_memtank/Makefile new file mode 100644 index 0000000..d87e320 --- /dev/null +++ b/lib/libtle_memtank/Makefile @@ -0,0 +1,40 @@ +# Copyright (c) 2016 Intel Corporation. +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at: +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +ifeq ($(RTE_SDK),) +$(error "Please define RTE_SDK environment variable") +endif + +# Default target, can be overwritten by command line or environment +RTE_TARGET ?= x86_64-native-linuxapp-gcc + +include $(RTE_SDK)/mk/rte.vars.mk + +# library name +LIB = libtle_memtank.a + +CFLAGS += -O3 +CFLAGS += $(WERROR_FLAGS) -I$(SRCDIR) + +EXPORT_MAP := tle_memtank_version.map + +LIBABIVER := 1 + +#source files +SRCS-y += memtank.c +SRCS-y += misc.c + +SYMLINK-y-include += tle_memtank_pub.h +SYMLINK-y-include += tle_memtank.h + +include $(TLDK_ROOT)/mk/tle.lib.mk diff --git a/lib/libtle_memtank/memtank.c b/lib/libtle_memtank/memtank.c new file mode 100644 index 0000000..ceb209c --- /dev/null +++ b/lib/libtle_memtank/memtank.c @@ -0,0 +1,507 @@ +/* + * Copyright (c) 2019 Intel Corporation. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#include "memtank.h" +#include <rte_errno.h> + +#define ALIGN_MUL_CEIL(v, mul) \ + ((typeof(v))(((uint64_t)(v) + (mul) - 1) / (mul))) + + +static inline size_t +memtank_meta_size(uint32_t nb_free) +{ + size_t sz; + static const struct memtank *mt; + + sz = sizeof(*mt) + nb_free * sizeof(mt->pub.free[0]); + sz = RTE_ALIGN_CEIL(sz, alignof(*mt)); + return sz; +} + +static inline size_t +memchunk_meta_size(uint32_t nb_obj) +{ + size_t sz; + static const struct memchunk *ch; + + sz = sizeof(*ch) + nb_obj * sizeof(ch->free[0]); + sz = RTE_ALIGN_CEIL(sz, alignof(*ch)); + return sz; +} + +static inline size_t +memobj_size(uint32_t obj_size, uint32_t obj_align) +{ + size_t sz; + static const struct memobj *obj; + + sz = sizeof(*obj) + obj_size; + sz = RTE_ALIGN_CEIL(sz, obj_align); + return sz; +} + +static inline size_t +memchunk_size(uint32_t nb_obj, uint32_t obj_size, uint32_t obj_align) +{ + size_t algn, sz; + static const struct memchunk *ch; + + algn = RTE_MAX(alignof(*ch), obj_align); + sz = memchunk_meta_size(nb_obj); + sz += nb_obj * memobj_size(obj_size, obj_align); + sz = RTE_ALIGN_CEIL(sz + algn - 1, algn); + return sz; +} + +static void +init_chunk(struct memtank *mt, struct memchunk *ch) +{ + uint32_t i, n, sz; + uintptr_t p; + struct memobj *obj; + + const struct memobj cobj = { + .red_zone1 = RED_ZONE_V1, + .chunk = ch, + .red_zone2 = RED_ZONE_V2, + }; + + n = mt->prm.nb_obj_chunk; + sz = mt->obj_size; + + /* get start of memobj array */ + p = (uintptr_t)ch + memchunk_meta_size(n); + p = RTE_ALIGN_CEIL(p, mt->prm.obj_align); + + for (i = 0; i != n; i++) { + obj = obj_pub_full(p, sz); + obj[0] = cobj; + ch->free[i] = (void *)p; + p += sz; + } + + ch->nb_total = n; + ch->nb_free = n; + + if (mt->prm.init != NULL) + mt->prm.init(ch->free, n, mt->prm.udata); +} + +static void +put_chunk(struct memtank *mt, struct memchunk *ch, void * const obj[], + uint32_t num) +{ + uint32_t k, n; + struct mchunk_list *ls; + + /* chunk should be in the *used* list */ + k = MC_USED; + ls = &mt->chl[k]; + rte_spinlock_lock(&ls->lock); + + n = ch->nb_free; + RTE_ASSERT(n + num <= ch->nb_total); + + _copy_objs(ch->free + n, obj, num); + ch->nb_free = n + num; + + /* chunk is full now */ + if (ch->nb_free == ch->nb_total) { + TAILQ_REMOVE(&ls->chunk, ch, link); + k = MC_FULL; + /* chunk is not empty anymore, move it to the head */ + } else if (n == 0) { + TAILQ_REMOVE(&ls->chunk, ch, link); + TAILQ_INSERT_HEAD(&ls->chunk, ch, link); + } + + rte_spinlock_unlock(&ls->lock); + + /* insert this chunk into the *full* list */ + if (k == MC_FULL) { + ls = &mt->chl[k]; + rte_spinlock_lock(&ls->lock); + TAILQ_INSERT_HEAD(&ls->chunk, ch, link); + rte_spinlock_unlock(&ls->lock); + } +} + +static uint32_t +shrink_chunk(struct memtank *mt, uint32_t num) +{ + uint32_t i, k; + struct mchunk_list *ls; + struct memchunk *ch[num]; + + ls = &mt->chl[MC_FULL]; + rte_spinlock_lock(&ls->lock); + + for (k = 0; k != num; k++) { + ch[k] = TAILQ_LAST(&ls->chunk, mchunk_head); + if (ch[k] == NULL) + break; + TAILQ_REMOVE(&ls->chunk, ch[k], link); + } + + rte_spinlock_unlock(&ls->lock); + + rte_atomic32_sub(&mt->nb_chunks, k); + + for (i = 0; i != k; i++) + mt->prm.free(ch[i]->raw, mt->prm.udata); + + return k; +} + +static struct memchunk * +alloc_chunk(struct memtank *mt) +{ + void *p; + struct memchunk *ch; + + p = mt->prm.alloc(mt->chunk_size, mt->prm.udata); + if (p == NULL) + return NULL; + ch = RTE_PTR_ALIGN_CEIL(p, alignof(*ch)); + ch->raw = p; + return ch; +} + +/* Determine by how many chunks we can actually grow */ +static inline uint32_t +grow_num(struct memtank *mt, uint32_t num) +{ + uint32_t k, n, max; + + max = mt->max_chunk; + n = rte_atomic32_add_return(&mt->nb_chunks, num); + + if (n <= max) + return num; + + k = n - max; + return (k >= num) ? 0 : num - k; +} + +static uint32_t +grow_chunk(struct memtank *mt, uint32_t num) +{ + uint32_t i, k, n; + struct mchunk_list *fls; + struct mchunk_head ls; + struct memchunk *ch[num]; + + /* check can we grow further */ + k = grow_num(mt, num); + + for (n = 0; n != k; n++) { + ch[n] = alloc_chunk(mt); + if (ch[n] == NULL) + break; + } + + TAILQ_INIT(&ls); + + for (i = 0; i != n; i++) { + init_chunk(mt, ch[i]); + TAILQ_INSERT_HEAD(&ls, ch[i], link); + } + + if (n != 0) { + fls = &mt->chl[MC_FULL]; + rte_spinlock_lock(&fls->lock); + TAILQ_CONCAT(&fls->chunk, &ls, link); + rte_spinlock_unlock(&fls->lock); + } + + if (n != num) + rte_atomic32_sub(&mt->nb_chunks, num - n); + + return n; +} + +static void +obj_dbg_alloc(struct memtank *mt, void * const obj[], uint32_t nb_obj) +{ + uint32_t i, sz; + struct memobj *po; + + sz = mt->obj_size; + for (i = 0; i != nb_obj; i++) { + po = obj_pub_full((uintptr_t)obj[i], sz); + RTE_VERIFY(memobj_verify(po, 0) == 0); + po->dbg.nb_alloc++; + } +} + +static void +obj_dbg_free(struct memtank *mt, void * const obj[], uint32_t nb_obj) +{ + uint32_t i, sz; + struct memobj *po; + + sz = mt->obj_size; + for (i = 0; i != nb_obj; i++) { + po = obj_pub_full((uintptr_t)obj[i], sz); + RTE_VERIFY(memobj_verify(po, 1) == 0); + po->dbg.nb_free++; + } +} + + +void +tle_memtank_chunk_free(struct tle_memtank *t, void * const obj[], + uint32_t nb_obj, uint32_t flags) +{ + uint32_t i, j, k, sz; + struct memtank *mt; + struct memobj *mo; + struct memchunk *ch[nb_obj]; + + mt = tank_pub_full(t); + sz = mt->obj_size; + + if (mt->flags & TLE_MTANK_OBJ_DBG) + obj_dbg_free(mt, obj, nb_obj); + + for (i = 0; i != nb_obj; i++) { + mo = obj_pub_full((uintptr_t)obj[i], sz); + ch[i] = mo->chunk; + } + + k = 0; + for (i = 0; i != nb_obj; i = j) { + + /* find number of consequtive objs from the same chunk */ + for (j = i + 1; j != nb_obj && ch[j] == ch[i]; j++) + ; + + put_chunk(mt, ch[i], obj + i, j - i); + k++; + } + + if (flags & TLE_MTANK_FREE_SHRINK) + shrink_chunk(mt, k); +} + +static uint32_t +get_chunk(struct mchunk_list *ls, struct mchunk_head *els, + struct mchunk_head *uls, void *obj[], uint32_t nb_obj) +{ + uint32_t l, k, n; + struct memchunk *ch, *nch; + + rte_spinlock_lock(&ls->lock); + + n = 0; + for (ch = TAILQ_FIRST(&ls->chunk); + n != nb_obj && ch != NULL && ch->nb_free != 0; + ch = nch, n += k) { + + k = RTE_MIN(nb_obj - n, ch->nb_free); + l = ch->nb_free - k; + _copy_objs(obj + n, ch->free + l, k); + ch->nb_free = l; + + nch = TAILQ_NEXT(ch, link); + + /* chunk is empty now */ + if (l == 0) { + TAILQ_REMOVE(&ls->chunk, ch, link); + TAILQ_INSERT_TAIL(els, ch, link); + } else if (uls != NULL) { + TAILQ_REMOVE(&ls->chunk, ch, link); + TAILQ_INSERT_HEAD(uls, ch, link); + } + } + + rte_spinlock_unlock(&ls->lock); + return n; +} + +uint32_t +tle_memtank_chunk_alloc(struct tle_memtank *t, void *obj[], uint32_t nb_obj, + uint32_t flags) +{ + uint32_t k, n; + struct memtank *mt; + struct mchunk_head els, uls; + + mt = tank_pub_full(t); + + /* walk though the the *used* list first */ + n = get_chunk(&mt->chl[MC_USED], &mt->chl[MC_USED].chunk, NULL, + obj, nb_obj); + + if (n != nb_obj) { + + TAILQ_INIT(&els); + TAILQ_INIT(&uls); + + /* walk though the the *full* list */ + n += get_chunk(&mt->chl[MC_FULL], &els, &uls, + obj + n, nb_obj - n); + + if (n != nb_obj && (flags & TLE_MTANK_ALLOC_GROW) != 0) { + + /* try to allocate extra memchunks */ + k = ALIGN_MUL_CEIL(nb_obj - n, + mt->prm.nb_obj_chunk); + k = grow_chunk(mt, k); + + /* walk through the *full* list again */ + if (k != 0) + n += get_chunk(&mt->chl[MC_FULL], &els, &uls, + obj + n, nb_obj - n); + } + + /* concatenate with *used* list our temporary lists */ + rte_spinlock_lock(&mt->chl[MC_USED].lock); + + /* put new non-emtpy elems at head of the *used* list */ + TAILQ_CONCAT(&uls, &mt->chl[MC_USED].chunk, link); + TAILQ_CONCAT(&mt->chl[MC_USED].chunk, &uls, link); + + /* put new emtpy elems at tail of the *used* list */ + TAILQ_CONCAT(&mt->chl[MC_USED].chunk, &els, link); + + rte_spinlock_unlock(&mt->chl[MC_USED].lock); + } + + if (mt->flags & TLE_MTANK_OBJ_DBG) + obj_dbg_alloc(mt, obj, n); + + return n; +} + +int +tle_memtank_grow(struct tle_memtank *t) +{ + uint32_t k, n, num; + struct memtank *mt; + + mt = tank_pub_full(t); + + /* how many chunks we need to grow */ + k = t->min_free - t->nb_free; + if ((int32_t)k <= 0) + return 0; + + num = ALIGN_MUL_CEIL(k, mt->prm.nb_obj_chunk); + + /* try to grow and refill the *free* */ + n = grow_chunk(mt, num); + if (n != 0) + _fill_free(t, k, 0); + + return n; +} + +int +tle_memtank_shrink(struct tle_memtank *t) +{ + uint32_t n; + struct memtank *mt; + + mt = tank_pub_full(t); + + /* how many chunks we need to shrink */ + if (t->nb_free < t->max_free) + return 0; + + /* how many chunks we need to free */ + n = ALIGN_MUL_CEIL(t->min_free, mt->prm.nb_obj_chunk); + + /* free up to *num* chunks */ + return shrink_chunk(mt, n); +} + +static int +check_param(const struct tle_memtank_prm *prm) +{ + if (prm->alloc == NULL || prm->free == NULL || + prm->min_free > prm->max_free || + rte_is_power_of_2(prm->obj_align) == 0) + return -EINVAL; + return 0; +} + +struct tle_memtank * +tle_memtank_create(const struct tle_memtank_prm *prm) +{ + int32_t rc; + size_t sz; + void *p; + struct memtank *mt; + + rc = check_param(prm); + if (rc != 0) { + rte_errno = -rc; + return NULL; + } + + sz = memtank_meta_size(prm->max_free); + p = prm->alloc(sz, prm->udata); + if (p == NULL) { + rte_errno = ENOMEM; + return NULL; + } + + mt = RTE_PTR_ALIGN_CEIL(p, alignof(*mt)); + + memset(mt, 0, sizeof(*mt)); + mt->prm = *prm; + + mt->raw = p; + mt->chunk_size = memchunk_size(prm->nb_obj_chunk, prm->obj_size, + prm->obj_align); + mt->obj_size = memobj_size(prm->obj_size, prm->obj_align); + mt->max_chunk = ALIGN_MUL_CEIL(prm->max_obj, prm->nb_obj_chunk); + mt->flags = prm->flags; + + mt->pub.min_free = prm->min_free; + mt->pub.max_free = prm->max_free; + + TAILQ_INIT(&mt->chl[MC_FULL].chunk); + TAILQ_INIT(&mt->chl[MC_USED].chunk); + + return &mt->pub; +} + +static void +free_mchunk_list(struct memtank *mt, struct mchunk_list *ls) +{ + struct memchunk *ch; + + for (ch = TAILQ_FIRST(&ls->chunk); ch != NULL; + ch = TAILQ_FIRST(&ls->chunk)) { + TAILQ_REMOVE(&ls->chunk, ch, link); + mt->prm.free(ch->raw, mt->prm.udata); + } +} + +void +tle_memtank_destroy(struct tle_memtank *t) +{ + struct memtank *mt; + + if (t != NULL) { + mt = tank_pub_full(t); + free_mchunk_list(mt, &mt->chl[MC_FULL]); + free_mchunk_list(mt, &mt->chl[MC_USED]); + mt->prm.free(mt->raw, mt->prm.udata); + } +} diff --git a/lib/libtle_memtank/memtank.h b/lib/libtle_memtank/memtank.h new file mode 100644 index 0000000..ba3f160 --- /dev/null +++ b/lib/libtle_memtank/memtank.h @@ -0,0 +1,107 @@ +/* + * Copyright (c) 2019 Intel Corporation. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#ifndef _MEMTANK_H_ +#define _MEMTANK_H_ + +#include <tle_memtank.h> +#include <stdalign.h> + +struct memobj { + uint64_t red_zone1; + struct memchunk *chunk; /* ptr to the chunk it belongs to */ + struct { + uint32_t nb_alloc; + uint32_t nb_free; + } dbg; + uint64_t red_zone2; +}; + +#define RED_ZONE_V1 UINT64_C(0xBADECAFEBADECAFE) +#define RED_ZONE_V2 UINT64_C(0xDEADBEEFDEADBEEF) + +struct memchunk { + TAILQ_ENTRY(memchunk) link; /* link to the next chunk in the tank */ + void *raw; /* un-aligned ptr returned by alloc() */ + uint32_t nb_total; /* total number of objects in the chunk */ + uint32_t nb_free; /* number of free object in the chunk */ + void *free[]; /* array of free objects */ +} __rte_cache_aligned; + + +TAILQ_HEAD(mchunk_head, memchunk); + +struct mchunk_list { + rte_spinlock_t lock; + struct mchunk_head chunk; /* list of chunks */ +} __rte_cache_aligned; + +enum { + MC_FULL, /* all memchunk objs are free */ + MC_USED, /* some of memchunk objs are allocated */ + MC_NUM, +}; + +struct memtank { + /* user provided data */ + struct tle_memtank_prm prm; + + /*run-time data */ + void *raw; /* un-aligned ptr returned by alloc() */ + size_t chunk_size; /* full size of each memchunk */ + uint32_t obj_size; /* full size of each memobj */ + uint32_t max_chunk; /* max allowed number of chunks */ + uint32_t flags; /* behavior flags */ + rte_atomic32_t nb_chunks; /* number of allocated chunks */ + + struct mchunk_list chl[MC_NUM]; /* lists of memchunks */ + + struct tle_memtank pub; +}; + +/* + * Obtain pointer to interal memtank struct from public one + */ +static inline struct memtank * +tank_pub_full(const void *p) +{ + uintptr_t v; + + v = (uintptr_t)p - offsetof(struct memtank, pub); + return (struct memtank *)v; +} + +/* + * Obtain pointer to interal memobj struct from public one + */ +static inline struct memobj * +obj_pub_full(uintptr_t p, uint32_t obj_sz) +{ + uintptr_t v; + + v = p + obj_sz - sizeof(struct memobj); + return (struct memobj *)v; +} + +static inline int +memobj_verify(const struct memobj *mo, uint32_t finc) +{ + if (mo->red_zone1 != RED_ZONE_V1 || mo->red_zone2 != RED_ZONE_V2 || + mo->dbg.nb_alloc != mo->dbg.nb_free + finc) + return -EINVAL; + return 0; +} + +#endif /* _MEMTANK_H_ */ diff --git a/lib/libtle_memtank/misc.c b/lib/libtle_memtank/misc.c new file mode 100644 index 0000000..07e73db --- /dev/null +++ b/lib/libtle_memtank/misc.c @@ -0,0 +1,381 @@ +/* + * Copyright (c) 2019 Intel Corporation. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#include "memtank.h" +#include <inttypes.h> + +#define CHUNK_OBJ_LT_NUM 4 + +struct mchunk_stat { + uint32_t nb_empty; + uint32_t nb_full; + struct { + uint32_t nb_chunk; + uint32_t nb_obj; + struct { + uint32_t val; + uint32_t num; + } chunk_obj_lt[CHUNK_OBJ_LT_NUM]; + } used; +}; + +struct mfree_stat { + uint32_t nb_chunk; + struct mchunk_stat chunk; +}; + +#define MTANK_LOG(lvl, fmt, args...) RTE_LOG(lvl, USER1, fmt, ##args) + + +static void +mchunk_stat_dump(FILE *f, const struct mchunk_stat *st) +{ + uint32_t i; + + fprintf(f, "\t\tstat={\n"); + fprintf(f, "\t\t\tnb_empty=%u,\n", st->nb_empty); + fprintf(f, "\t\t\tnb_full=%u,\n", st->nb_full); + fprintf(f, "\t\t\tused={\n"); + fprintf(f, "\t\t\t\tnb_chunk=%u,\n", st->used.nb_chunk); + fprintf(f, "\t\t\t\tnb_obj=%u,\n", st->used.nb_obj); + + for (i = 0; i != RTE_DIM(st->used.chunk_obj_lt); i++) { + if (st->used.chunk_obj_lt[i].num != 0) + fprintf(f, "\t\t\t\tnb_chunk_obj_lt_%u=%u,\n", + st->used.chunk_obj_lt[i].val, + st->used.chunk_obj_lt[i].num); + } + + fprintf(f, "\t\t\t},\n"); + fprintf(f, "\t\t},\n"); +} + +static void +mchunk_stat_init(struct mchunk_stat *st, uint32_t nb_obj_chunk) +{ + uint32_t i; + + memset(st, 0, sizeof(*st)); + for (i = 0; i != RTE_DIM(st->used.chunk_obj_lt); i++) { + st->used.chunk_obj_lt[i].val = (i + 1) * nb_obj_chunk / + RTE_DIM(st->used.chunk_obj_lt); + } +} + +static void +mchunk_stat_collect(struct mchunk_stat *st, const struct memchunk *ch) +{ + uint32_t i, n; + + n = ch->nb_total - ch->nb_free; + + if (ch->nb_free == 0) + st->nb_empty++; + else if (n == 0) + st->nb_full++; + else { + st->used.nb_chunk++; + st->used.nb_obj += n; + + for (i = 0; i != RTE_DIM(st->used.chunk_obj_lt); i++) { + if (n < st->used.chunk_obj_lt[i].val) { + st->used.chunk_obj_lt[i].num++; + break; + } + } + } +} + +static void +mchunk_list_dump(FILE *f, struct memtank *mt, uint32_t idx, uint32_t flags) +{ + struct mchunk_list *ls; + const struct memchunk *ch; + struct mchunk_stat mcs; + + ls = &mt->chl[idx]; + mchunk_stat_init(&mcs, mt->prm.nb_obj_chunk); + + rte_spinlock_lock(&ls->lock); + + for (ch = TAILQ_FIRST(&ls->chunk); ch != NULL; + ch = TAILQ_NEXT(ch, link)) { + + /* collect chunk stats */ + if (flags & TLE_MTANK_DUMP_CHUNK_STAT) + mchunk_stat_collect(&mcs, ch); + + /* dump chunk metadata */ + if (flags & TLE_MTANK_DUMP_CHUNK) { + fprintf(f, "\t\tmemchunk@%p={\n", ch); + fprintf(f, "\t\t\traw=%p,\n", ch->raw); + fprintf(f, "\t\t\tnb_total=%u,\n", ch->nb_total); + fprintf(f, "\t\t\tnb_free=%u,\n", ch->nb_free); + fprintf(f, "\t\t},\n"); + } + } + + rte_spinlock_unlock(&ls->lock); + + /* print chunk stats */ + if (flags & TLE_MTANK_DUMP_CHUNK_STAT) + mchunk_stat_dump(f, &mcs); +} + +static void +mfree_stat_init(struct mfree_stat *st, uint32_t nb_obj_chunk) +{ + st->nb_chunk = 0; + mchunk_stat_init(&st->chunk, nb_obj_chunk); +} + +static int +ptr_cmp(const void *p1, const void *p2) +{ + const intptr_t *v1, *v2; + + v1 = p1; + v2 = p2; + return v1[0] - v2[0]; +} + +static void +mfree_stat_collect(struct mfree_stat *st, struct memtank *mt) +{ + uint32_t i, j, n, sz; + uintptr_t *p; + const struct memobj *mo; + + sz = mt->obj_size; + + p = malloc(mt->pub.max_free * sizeof(*p)); + if (p == NULL) + return; + + /** + * grab free lock and keep it till we analyze related memchunks, + * to make sure none of these memchunks will be freed untill + * we are finished. + */ + rte_spinlock_lock(&mt->pub.lock); + + /* collect chunks for all objects in free[] */ + n = mt->pub.nb_free; + memcpy(p, mt->pub.free, n * sizeof(*p)); + for (i = 0; i != n; i++) { + mo = obj_pub_full(p[i], sz); + p[i] = (uintptr_t)mo->chunk; + } + + /* sort chunk pointers */ + qsort(p, n, sizeof(*p), ptr_cmp); + + /* for each chunk collect stats */ + for (i = 0; i != n; i = j) { + + st->nb_chunk++; + mchunk_stat_collect(&st->chunk, (const struct memchunk *)p[i]); + for (j = i + 1; j != n && p[i] == p[j]; j++) + ; + } + + rte_spinlock_unlock(&mt->pub.lock); + free(p); +} + +static void +mfree_stat_dump(FILE *f, const struct mfree_stat *st) +{ + fprintf(f, "\tfree_stat={\n"); + fprintf(f, "\t\tnb_chunk=%u,\n", st->nb_chunk); + mchunk_stat_dump(f, &st->chunk); + fprintf(f, "\t},\n"); +} + +void +tle_memtank_dump(FILE *f, const struct tle_memtank *t, uint32_t flags) +{ + struct memtank *mt; + + if (f == NULL || t == NULL) + return; + + mt = tank_pub_full(t); + + fprintf(f, "tle_memtank@%p={\n", t); + fprintf(f, "\tmin_free=%u,\n", t->min_free); + fprintf(f, "\tmax_free=%u,\n", t->max_free); + fprintf(f, "\tnb_free=%u,\n", t->nb_free); + fprintf(f, "\tchunk_size=%zu,\n", mt->chunk_size); + fprintf(f, "\tobj_size=%u,\n", mt->obj_size); + fprintf(f, "\tmax_chunk=%u,\n", mt->max_chunk); + fprintf(f, "\tflags=%#x,\n", mt->flags); + fprintf(f, "\tnb_chunks=%u,\n", rte_atomic32_read(&mt->nb_chunks)); + + if (flags & TLE_MTANK_DUMP_FREE_STAT) { + struct mfree_stat mfs; + mfree_stat_init(&mfs, mt->prm.nb_obj_chunk); + mfree_stat_collect(&mfs, mt); + mfree_stat_dump(f, &mfs); + } + + if (flags & (TLE_MTANK_DUMP_CHUNK | TLE_MTANK_DUMP_CHUNK_STAT)) { + + fprintf(f, "\t[FULL]={\n"); + mchunk_list_dump(f, mt, MC_FULL, flags); + fprintf(f, "\t},\n"); + + fprintf(f, "\t[USED]={,\n"); + mchunk_list_dump(f, mt, MC_USED, flags); + fprintf(f, "\t},\n"); + } + fprintf(f, "};\n"); +} + +static int +mobj_bulk_check(const char *fname, const struct memtank *mt, + const uintptr_t p[], uint32_t num, uint32_t fmsk) +{ + int32_t ret; + uintptr_t align; + uint32_t i, k, sz; + const struct memobj *mo; + + k = ((mt->flags & TLE_MTANK_OBJ_DBG) != 0) & fmsk; + sz = mt->obj_size; + align = mt->prm.obj_align - 1; + + ret = 0; + for (i = 0; i != num; i++) { + + if (p[i] == (uintptr_t)NULL) { + ret--; + MTANK_LOG(ERR, + "%s(mt=%p, %p[%u]): NULL object\n", + fname, mt, p, i); + } else if ((p[i] & align) != 0) { + ret--; + MTANK_LOG(ERR, + "%s(mt=%p, %p[%u]): object %#zx violates " + "expected alignment %#zx\n", + fname, mt, p, i, p[i], align); + } else { + mo = obj_pub_full(p[i], sz); + if (memobj_verify(mo, k) != 0) { + ret--; + MTANK_LOG(ERR, + "%s(mt=%p, %p[%u]): " + "invalid object header @%#zx={" + "red_zone1=%#" PRIx64 "," + "dbg={nb_alloc=%u,nb_free=%u}," + "red_zone2=%#" PRIx64 + "}\n", + fname, mt, p, i, p[i], + mo->red_zone1, + mo->dbg.nb_alloc, mo->dbg.nb_free, + mo->red_zone2); + } + } + } + + return ret; +} + +/* grab free lock and check objects in free[] */ +static int +mfree_check(struct memtank *mt) +{ + int32_t rc; + + rte_spinlock_lock(&mt->pub.lock); + rc = mobj_bulk_check(__func__, mt, (const uintptr_t *)mt->pub.free, + mt->pub.nb_free, 1); + rte_spinlock_unlock(&mt->pub.lock); + return rc; +} + +static int +mchunk_check(const struct memtank *mt, const struct memchunk *mc, uint32_t tc) +{ + int32_t n, rc; + + rc = 0; + n = mc->nb_total - mc->nb_free; + + rc -= (mc->nb_total != mt->prm.nb_obj_chunk); + rc -= (tc == MC_FULL) ? (n != 0) : (n <= 0); + rc -= (RTE_PTR_ALIGN_CEIL(mc->raw, alignof(*mc)) != mc); + + if (rc != 0) + MTANK_LOG(ERR, "%s(mt=%p, tc=%u): invalid memchunk @%p={" + "raw=%p, nb_total=%u, nb_free=%u}\n", + __func__, mt, tc, mc, + mc->raw, mc->nb_total, mc->nb_free); + + rc += mobj_bulk_check(__func__, mt, (const uintptr_t *)mc->free, + mc->nb_free, 0); + return rc; +} + +static int +mchunk_list_check(struct memtank *mt, uint32_t tc, uint32_t *nb_chunk) +{ + int32_t rc; + uint32_t n; + struct mchunk_list *ls; + const struct memchunk *ch; + + ls = &mt->chl[tc]; + rte_spinlock_lock(&ls->lock); + + rc = 0; + for (n = 0, ch = TAILQ_FIRST(&ls->chunk); ch != NULL; + ch = TAILQ_NEXT(ch, link), n++) + rc += mchunk_check(mt, ch, tc); + + rte_spinlock_unlock(&ls->lock); + + *nb_chunk = n; + return rc; +} + +int +tle_memtank_sanity_check(const struct tle_memtank *t, int32_t ct) +{ + int32_t rc; + uint32_t n, nf, nu; + struct memtank *mt; + + mt = tank_pub_full(t); + rc = mfree_check(mt); + + nf = 0, nu = 0; + rc += mchunk_list_check(mt, MC_FULL, &nf); + rc += mchunk_list_check(mt, MC_USED, &nu); + + /* + * if some other threads concurently do alloc/free/grow/shrink + * these numbers can still not match. + */ + n = rte_atomic32_read(&mt->nb_chunks); + if (nf + nu != n && ct == 0) { + MTANK_LOG(ERR, + "%s(mt=%p) nb_chunks: expected=%u, full=%u, used=%u\n", + __func__, mt, n, nf, nu); + rc--; + } + + return rc; +} diff --git a/lib/libtle_memtank/tle_memtank.h b/lib/libtle_memtank/tle_memtank.h new file mode 100644 index 0000000..9f12fe0 --- /dev/null +++ b/lib/libtle_memtank/tle_memtank.h @@ -0,0 +1,274 @@ +/* + * Copyright (c) 2019 Intel Corporation. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#ifndef _TLE_MEMTANK_H_ +#define _TLE_MEMTANK_H_ + +#include <string.h> + +#include <rte_common.h> +#include <rte_memory.h> +#include <rte_atomic.h> +#include <rte_spinlock.h> + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @file + * TLE memtank + * + * Same a s mempool it allows to alloc/free objects of fixed size + * in a lightweight manner (probably not as lightweight as mempool, + * but hopefully close enough). + * But in addition it can grow/shrink dynamically plus provides extra + * additional API for higher flexibility: + * - manual grow()/shrink() functions + * - different alloc/free policies + * (can be specified by user via flags parameter). + * Internally it consists of: + * - LIFO queue (fast allocator/deallocator) + * - lists of memchunks (USED, FREE). + * + * For perfomance reasons memtank tries to allocate memory in + * relatively big chunks (memchunks) and then split each memchunk + * in dozens (or hundreds) of objects. + * There are two thresholds: + * - min_free (grow threshold) + * - max_free (shrink threshold) + */ + +struct tle_memtank; + +/** generic memtank behavior flags */ +enum { + TLE_MTANK_OBJ_DBG = 1, +}; + +struct tle_memtank_prm { + /** min number of free objs in the ring (grow threshold). */ + uint32_t min_free; + uint32_t max_free; /**< max number of free objs (empty threshold) */ + uint32_t max_obj; /**< max number of objs (grow limit) */ + uint32_t obj_size; /**< size of each mem object */ + uint32_t obj_align; /**< alignment of each mem object */ + uint32_t nb_obj_chunk; /**< number of objects per chunk */ + uint32_t flags; /**< behavior flags */ + /** user provided function to alloc chunk of memory */ + void * (*alloc)(size_t, void *); + /** user provided function to free chunk of memory */ + void (*free)(void *, void *); + /** user provided function to initialiaze an object */ + void (*init)(void *[], uint32_t, void *); + void *udata; /**< opaque user data for alloc/free/init */ +}; + +/** + * Allocate and intitialize new memtank instance, based on the + * parameters provided. Note that it uses user-provided *alloc()* function + * to allocate space for the memtank metadata. + * @param prm + * Parameters used to create and initialise new memtank. + * @return + * - Pointer to new memtank insteance created, if operation completed + * successfully. + * - NULL on error with rte_errno set appropriately. + */ +struct tle_memtank * +tle_memtank_create(const struct tle_memtank_prm *prm); + +/** + * Destroy the memtank and free all memory referenced by the memtank. + * The objects must not be used by other cores as they will be freed. + * + * @param t + * A pointer to the memtank instance. + */ +void +tle_memtank_destroy(struct tle_memtank *t); + + +/** alloc flags */ +enum { + TLE_MTANK_ALLOC_CHUNK = 1, + TLE_MTANK_ALLOC_GROW = 2, +}; + +/** + * Allocate up to requested number of objects from the memtank. + * Note that depending on *alloc* behavior (flags) some new memory chunks + * can be allocated from the underlying memory subsystem. + * + * @param t + * A pointer to the memtank instance. + * @param obj + * An array of void * pointers (objects) that will be filled. + * @param num + * Number of objects to allocate from the memtank. + * @param flags + * Flags that control allocation behavior. + * @return + * Number of allocated objects. + */ +static inline uint32_t +tle_memtank_alloc(struct tle_memtank *t, void *obj[], uint32_t num, + uint32_t flags); + +/** + * Allocate up to requested number of objects from the memtank. + * Note that this function bypasses *free* cache(s) and tries to allocate + * objects straight from the memory chunks. + * Note that depending on *alloc* behavior (flags) some new memory chunks + * can be allocated from the underlying memory subsystem. + * + * @param t + * A pointer to the memtank instance. + * @param obj + * An array of void * pointers (objects) that will be filled. + * @param nb_obj + * Number of objects to allocate from the memtank. + * @param flags + * Flags that control allocation behavior. + * @return + * Number of allocated objects. + */ +uint32_t +tle_memtank_chunk_alloc(struct tle_memtank *t, void *obj[], uint32_t nb_obj, + uint32_t flags); + +/** free flags */ +enum { + TLE_MTANK_FREE_SHRINK = 1, +}; + +/** + * Free (put) provided objects back to the memtank. + * Note that depending on *free* behavior (flags) some memory chunks can be + * returned (freed) to the underlying memory subsystem. + * + * @param t + * A pointer to the memtank instance. + * @param obj + * An array of object pointers to be freed. + * @param num + * Number of objects to free. + * @param flags + * Flags that control free behavior. + */ +static inline void +tle_memtank_free(struct tle_memtank *t, void * const obj[], uint32_t num, + uint32_t flags); + +/** + * Free (put) provided objects back to the memtank. + * Note that this function bypasses *free* cache(s) and tries to put + * objects straight to the memory chunks. + * Note that depending on *free* behavior (flags) some memory chunks can be + * returned (freed) to the underlying memory subsystem. + * + * @param t + * A pointer to the memtank instance. + * @param obj + * An array of object pointers to be freed. + * @param nb_obj + * Number of objects to allocate from the memtank. + * @param flags + * Flags that control allocation behavior. + */ +void +tle_memtank_chunk_free(struct tle_memtank *t, void * const obj[], + uint32_t nb_obj, uint32_t flags); + +/** + * Check does number of objects in *free* cache is below memtank grow + * threshold (min_free). If yes, then tries to allocate memory for new + * objects from the underlying memory subsystem. + * + * @param t + * A pointer to the memtank instance. + * @return + * Number of newly allocated memory chunks. + */ +int +tle_memtank_grow(struct tle_memtank *t); + +/** + * Check does number of objects in *free* cache have reached memtank shrink + * threshold (max_free). If yes, then tries to return excessive memory to + * the the underlying memory subsystem. + * + * @param t + * A pointer to the memtank instance. + * @return + * Number of freed memory chunks. + */ +int +tle_memtank_shrink(struct tle_memtank *t); + +/* dump flags */ +enum { + TLE_MTANK_DUMP_FREE_STAT = 1, + TLE_MTANK_DUMP_CHUNK_STAT = 2, + TLE_MTANK_DUMP_CHUNK = 4, + /* first not used power of two */ + TLE_MTANK_DUMP_END, + + /* dump all stats */ + TLE_MTANK_DUMP_STAT = + (TLE_MTANK_DUMP_FREE_STAT | TLE_MTANK_DUMP_CHUNK_STAT), + /* dump everything */ + TLE_MTANK_DUMP_ALL = TLE_MTANK_DUMP_END - 1, +}; + +/** + * Dump information about the memtank to the file. + * Note that depending of *flags* value it might cause some internal locks + * grabbing, and might affect perfomance of others threads that + * concurently use same memtank. + * + * @param f + * A pinter to the file. + * @param t + * A pointer to the memtank instance. + * @param flags + * Flags that control dump behavior. + */ +void +tle_memtank_dump(FILE *f, const struct tle_memtank *t, uint32_t flags); + +/** + * Check the consistency of the given memtank instance. + * Dumps error messages to the RTE log subsystem, if some inconsitency + * is detected. + * + * @param t + * A pointer to the memtank instance. + * @param ct + * Value greater then zero, if some other threads do concurently use + * that memtank. + * @return + * Zero on success, or negaive value otherwise. + */ +int +tle_memtank_sanity_check(const struct tle_memtank *t, int32_t ct); + +#ifdef __cplusplus +} +#endif + +#include <tle_memtank_pub.h> + +#endif /* _TLE_MEMTANK_H_ */ diff --git a/lib/libtle_memtank/tle_memtank_pub.h b/lib/libtle_memtank/tle_memtank_pub.h new file mode 100644 index 0000000..78e89b2 --- /dev/null +++ b/lib/libtle_memtank/tle_memtank_pub.h @@ -0,0 +1,149 @@ +/* + * Copyright (c) 2019 Intel Corporation. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#ifndef _TLE_MEMTANK_PUB_H_ +#define _TLE_MEMTANK_PUB_H_ + +#include <tle_memtank.h> + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @file + * TLE memtank public + * It is not recommended to include this file directly, + * include <tle_memtank.h> instead. + */ + +struct tle_memtank { + rte_spinlock_t lock; + uint32_t min_free; + uint32_t max_free; + uint32_t nb_free; + void *free[]; +} __rte_cache_aligned; + + +static inline void +_copy_objs(void *dst[], void * const src[], uint32_t num) +{ + uint32_t i, n; + + n = RTE_ALIGN_FLOOR(num, 4); + + for (i = 0; i != n; i += 4) { + dst[i] = src[i]; + dst[i + 1] = src[i + 1]; + dst[i + 2] = src[i + 2]; + dst[i + 3] = src[i + 3]; + } + + switch (num % 4) { + case 3: + dst[i + 2] = src[i + 2]; + /* fallthrough */ + case 2: + dst[i + 1] = src[i + 1]; + /* fallthrough */ + case 1: + dst[i] = src[i]; + /* fallthrough */ + } +} + +static inline uint32_t +_get_free(struct tle_memtank *t, void *obj[], uint32_t num) +{ + uint32_t len, n; + + rte_spinlock_lock(&t->lock); + + len = t->nb_free; + n = RTE_MIN(num, len); + len -= n; + _copy_objs(obj, t->free + len, n); + t->nb_free = len; + + rte_spinlock_unlock(&t->lock); + return n; +} + +static inline uint32_t +_put_free(struct tle_memtank *t, void * const obj[], uint32_t num) +{ + uint32_t len, n; + + rte_spinlock_lock(&t->lock); + + len = t->nb_free; + n = t->max_free - len; + n = RTE_MIN(num, n); + _copy_objs(t->free + len, obj, n); + t->nb_free = len + n; + + rte_spinlock_unlock(&t->lock); + return n; +} + +static inline void +_fill_free(struct tle_memtank *t, uint32_t num, uint32_t flags) +{ + uint32_t k, n; + void *free[num]; + + k = tle_memtank_chunk_alloc(t, free, RTE_DIM(free), flags); + n = _put_free(t, free, k); + if (n != k) + tle_memtank_chunk_free(t, free + n, k - n, 0); +} + +static inline uint32_t +tle_memtank_alloc(struct tle_memtank *t, void *obj[], uint32_t num, + uint32_t flags) +{ + uint32_t n; + + n = _get_free(t, obj, num); + + /* not enough free objects, try to allocate via memchunks */ + if (n != num && flags != 0) { + n += tle_memtank_chunk_alloc(t, obj + n, num - n, flags); + + /* refill *free* tank */ + if (n == num) + _fill_free(t, t->min_free, flags); + } + + return n; +} + +static inline void +tle_memtank_free(struct tle_memtank *t, void * const obj[], uint32_t num, + uint32_t flags) +{ + uint32_t n; + + n = _put_free(t, obj, num); + if (n != num) + tle_memtank_chunk_free(t, obj + n, num - n, flags); +} + +#ifdef __cplusplus +} +#endif + +#endif /* _TLE_MEMTANK_PUB_H_ */ |