lib/librte_eal/common/eal_common_memzone.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation
   3  */
   4
   5 #include <stdlib.h>
   6 #include <stdio.h>
   7 #include <stdint.h>
   8 #include <stdarg.h>
   9 #include <inttypes.h>
  10 #include <string.h>
  11 #include <errno.h>
  12 #include <sys/queue.h>
  13
  14 #include <rte_log.h>
  15 #include <rte_memory.h>
  16 #include <rte_memzone.h>
  17 #include <rte_eal.h>
  18 #include <rte_eal_memconfig.h>
  19 #include <rte_per_lcore.h>
  20 #include <rte_errno.h>
  21 #include <rte_string_fns.h>
  22 #include <rte_common.h>
  23
  24 #include "malloc_heap.h"
  25 #include "malloc_elem.h"
  26 #include "eal_private.h"
  27
  28 static inline const struct rte_memzone *
  29 memzone_lookup_thread_unsafe(const char *name)
  30 {
  31         const struct rte_mem_config *mcfg;
  32         const struct rte_memzone *mz;
  33         unsigned i = 0;
  34
  35         /* get pointer to global configuration */
  36         mcfg = rte_eal_get_configuration()->mem_config;
  37
  38         /*
  39          * the algorithm is not optimal (linear), but there are few
  40          * zones and this function should be called at init only
  41          */
  42         for (i = 0; i < RTE_MAX_MEMZONE; i++) {
  43                 mz = &mcfg->memzone[i];
  44                 if (mz->addr != NULL && !strncmp(name, mz->name, RTE_MEMZONE_NAMESIZE))
  45                         return &mcfg->memzone[i];
  46         }
  47
  48         return NULL;
  49 }
  50
  51 static inline struct rte_memzone *
  52 get_next_free_memzone(void)
  53 {
  54         struct rte_mem_config *mcfg;
  55         unsigned i = 0;
  56
  57         /* get pointer to global configuration */
  58         mcfg = rte_eal_get_configuration()->mem_config;
  59
  60         for (i = 0; i < RTE_MAX_MEMZONE; i++) {
  61                 if (mcfg->memzone[i].addr == NULL)
  62                         return &mcfg->memzone[i];
  63         }
  64
  65         return NULL;
  66 }
  67
  68 /* This function will return the greatest free block if a heap has been
  69  * specified. If no heap has been specified, it will return the heap and
  70  * length of the greatest free block available in all heaps */
  71 static size_t
  72 find_heap_max_free_elem(int *s, unsigned align)
  73 {
  74         struct rte_mem_config *mcfg;
  75         struct rte_malloc_socket_stats stats;
  76         int i, socket = *s;
  77         size_t len = 0;
  78
  79         /* get pointer to global configuration */
  80         mcfg = rte_eal_get_configuration()->mem_config;
  81
  82         for (i = 0; i < RTE_MAX_NUMA_NODES; i++) {
  83                 if ((socket != SOCKET_ID_ANY) && (socket != i))
  84                         continue;
  85
  86                 malloc_heap_get_stats(&mcfg->malloc_heaps[i], &stats);
  87                 if (stats.greatest_free_size > len) {
  88                         len = stats.greatest_free_size;
  89                         *s = i;
  90                 }
  91         }
  92
  93         if (len < MALLOC_ELEM_OVERHEAD + align)
  94                 return 0;
  95
  96         return len - MALLOC_ELEM_OVERHEAD - align;
  97 }
  98
  99 static const struct rte_memzone *
 100 memzone_reserve_aligned_thread_unsafe(const char *name, size_t len,
 101                 int socket_id, unsigned flags, unsigned align, unsigned bound)
 102 {
 103         struct rte_memzone *mz;
 104         struct rte_mem_config *mcfg;
 105         size_t requested_len;
 106         int socket, i;
 107
 108         /* get pointer to global configuration */
 109         mcfg = rte_eal_get_configuration()->mem_config;
 110
 111         /* no more room in config */
 112         if (mcfg->memzone_cnt >= RTE_MAX_MEMZONE) {
 113                 RTE_LOG(ERR, EAL, "%s(): No more room in config\n", __func__);
 114                 rte_errno = ENOSPC;
 115                 return NULL;
 116         }
 117
 118         if (strlen(name) > sizeof(mz->name) - 1) {
 119                 RTE_LOG(DEBUG, EAL, "%s(): memzone <%s>: name too long\n",
 120                         __func__, name);
 121                 rte_errno = ENAMETOOLONG;
 122                 return NULL;
 123         }
 124
 125         /* zone already exist */
 126         if ((memzone_lookup_thread_unsafe(name)) != NULL) {
 127                 RTE_LOG(DEBUG, EAL, "%s(): memzone <%s> already exists\n",
 128                         __func__, name);
 129                 rte_errno = EEXIST;
 130                 return NULL;
 131         }
 132
 133         /* if alignment is not a power of two */
 134         if (align && !rte_is_power_of_2(align)) {
 135                 RTE_LOG(ERR, EAL, "%s(): Invalid alignment: %u\n", __func__,
 136                                 align);
 137                 rte_errno = EINVAL;
 138                 return NULL;
 139         }
 140
 141         /* alignment less than cache size is not allowed */
 142         if (align < RTE_CACHE_LINE_SIZE)
 143                 align = RTE_CACHE_LINE_SIZE;
 144
 145         /* align length on cache boundary. Check for overflow before doing so */
 146         if (len > SIZE_MAX - RTE_CACHE_LINE_MASK) {
 147                 rte_errno = EINVAL; /* requested size too big */
 148                 return NULL;
 149         }
 150
 151         len += RTE_CACHE_LINE_MASK;
 152         len &= ~((size_t) RTE_CACHE_LINE_MASK);
 153
 154         /* save minimal requested  length */
 155         requested_len = RTE_MAX((size_t)RTE_CACHE_LINE_SIZE,  len);
 156
 157         /* check that boundary condition is valid */
 158         if (bound != 0 && (requested_len > bound || !rte_is_power_of_2(bound))) {
 159                 rte_errno = EINVAL;
 160                 return NULL;
 161         }
 162
 163         if ((socket_id != SOCKET_ID_ANY) &&
 164             (socket_id >= RTE_MAX_NUMA_NODES || socket_id < 0)) {
 165                 rte_errno = EINVAL;
 166                 return NULL;
 167         }
 168
 169         if (!rte_eal_has_hugepages())
 170                 socket_id = SOCKET_ID_ANY;
 171
 172         if (len == 0) {
 173                 if (bound != 0)
 174                         requested_len = bound;
 175                 else {
 176                         requested_len = find_heap_max_free_elem(&socket_id, align);
 177                         if (requested_len == 0) {
 178                                 rte_errno = ENOMEM;
 179                                 return NULL;
 180                         }
 181                 }
 182         }
 183
 184         if (socket_id == SOCKET_ID_ANY)
 185                 socket = malloc_get_numa_socket();
 186         else
 187                 socket = socket_id;
 188
 189         /* allocate memory on heap */
 190         void *mz_addr = malloc_heap_alloc(&mcfg->malloc_heaps[socket], NULL,
 191                         requested_len, flags, align, bound);
 192
 193         if ((mz_addr == NULL) && (socket_id == SOCKET_ID_ANY)) {
 194                 /* try other heaps */
 195                 for (i = 0; i < RTE_MAX_NUMA_NODES; i++) {
 196                         if (socket == i)
 197                                 continue;
 198
 199                         mz_addr = malloc_heap_alloc(&mcfg->malloc_heaps[i],
 200                                         NULL, requested_len, flags, align, bound);
 201                         if (mz_addr != NULL)
 202                                 break;
 203                 }
 204         }
 205
 206         if (mz_addr == NULL) {
 207                 rte_errno = ENOMEM;
 208                 return NULL;
 209         }
 210
 211         struct malloc_elem *elem = malloc_elem_from_data(mz_addr);
 212
 213         /* fill the zone in config */
 214         mz = get_next_free_memzone();
 215
 216         if (mz == NULL) {
 217                 RTE_LOG(ERR, EAL, "%s(): Cannot find free memzone but there is room "
 218                                 "in config!\n", __func__);
 219                 malloc_elem_free(elem);
 220                 rte_errno = ENOSPC;
 221                 return NULL;
 222         }
 223
 224         mcfg->memzone_cnt++;
 225         snprintf(mz->name, sizeof(mz->name), "%s", name);
 226         mz->iova = rte_malloc_virt2iova(mz_addr);
 227         mz->addr = mz_addr;
 228         mz->len = (requested_len == 0 ? elem->size : requested_len);
 229         mz->hugepage_sz = elem->ms->hugepage_sz;
 230         mz->socket_id = elem->ms->socket_id;
 231         mz->flags = 0;
 232         mz->memseg_id = elem->ms - rte_eal_get_configuration()->mem_config->memseg;
 233
 234         return mz;
 235 }
 236
 237 static const struct rte_memzone *
 238 rte_memzone_reserve_thread_safe(const char *name, size_t len,
 239                                 int socket_id, unsigned flags, unsigned align,
 240                                 unsigned bound)
 241 {
 242         struct rte_mem_config *mcfg;
 243         const struct rte_memzone *mz = NULL;
 244
 245         /* get pointer to global configuration */
 246         mcfg = rte_eal_get_configuration()->mem_config;
 247
 248         rte_rwlock_write_lock(&mcfg->mlock);
 249
 250         mz = memzone_reserve_aligned_thread_unsafe(
 251                 name, len, socket_id, flags, align, bound);
 252
 253         rte_rwlock_write_unlock(&mcfg->mlock);
 254
 255         return mz;
 256 }
 257
 258 /*
 259  * Return a pointer to a correctly filled memzone descriptor (with a
 260  * specified alignment and boundary). If the allocation cannot be done,
 261  * return NULL.
 262  */
 263 const struct rte_memzone *
 264 rte_memzone_reserve_bounded(const char *name, size_t len, int socket_id,
 265                             unsigned flags, unsigned align, unsigned bound)
 266 {
 267         return rte_memzone_reserve_thread_safe(name, len, socket_id, flags,
 268                                                align, bound);
 269 }
 270
 271 /*
 272  * Return a pointer to a correctly filled memzone descriptor (with a
 273  * specified alignment). If the allocation cannot be done, return NULL.
 274  */
 275 const struct rte_memzone *
 276 rte_memzone_reserve_aligned(const char *name, size_t len, int socket_id,
 277                             unsigned flags, unsigned align)
 278 {
 279         return rte_memzone_reserve_thread_safe(name, len, socket_id, flags,
 280                                                align, 0);
 281 }
 282
 283 /*
 284  * Return a pointer to a correctly filled memzone descriptor. If the
 285  * allocation cannot be done, return NULL.
 286  */
 287 const struct rte_memzone *
 288 rte_memzone_reserve(const char *name, size_t len, int socket_id,
 289                     unsigned flags)
 290 {
 291         return rte_memzone_reserve_thread_safe(name, len, socket_id,
 292                                                flags, RTE_CACHE_LINE_SIZE, 0);
 293 }
 294
 295 int
 296 rte_memzone_free(const struct rte_memzone *mz)
 297 {
 298         struct rte_mem_config *mcfg;
 299         int ret = 0;
 300         void *addr;
 301         unsigned idx;
 302
 303         if (mz == NULL)
 304                 return -EINVAL;
 305
 306         mcfg = rte_eal_get_configuration()->mem_config;
 307
 308         rte_rwlock_write_lock(&mcfg->mlock);
 309
 310         idx = ((uintptr_t)mz - (uintptr_t)mcfg->memzone);
 311         idx = idx / sizeof(struct rte_memzone);
 312
 313         addr = mcfg->memzone[idx].addr;
 314         if (addr == NULL)
 315                 ret = -EINVAL;
 316         else if (mcfg->memzone_cnt == 0) {
 317                 rte_panic("%s(): memzone address not NULL but memzone_cnt is 0!\n",
 318                                 __func__);
 319         } else {
 320                 memset(&mcfg->memzone[idx], 0, sizeof(mcfg->memzone[idx]));
 321                 mcfg->memzone_cnt--;
 322         }
 323
 324         rte_rwlock_write_unlock(&mcfg->mlock);
 325
 326         rte_free(addr);
 327
 328         return ret;
 329 }
 330
 331 /*
 332  * Lookup for the memzone identified by the given name
 333  */
 334 const struct rte_memzone *
 335 rte_memzone_lookup(const char *name)
 336 {
 337         struct rte_mem_config *mcfg;
 338         const struct rte_memzone *memzone = NULL;
 339
 340         mcfg = rte_eal_get_configuration()->mem_config;
 341
 342         rte_rwlock_read_lock(&mcfg->mlock);
 343
 344         memzone = memzone_lookup_thread_unsafe(name);
 345
 346         rte_rwlock_read_unlock(&mcfg->mlock);
 347
 348         return memzone;
 349 }
 350
 351 /* Dump all reserved memory zones on console */
 352 void
 353 rte_memzone_dump(FILE *f)
 354 {
 355         struct rte_mem_config *mcfg;
 356         unsigned i = 0;
 357
 358         /* get pointer to global configuration */
 359         mcfg = rte_eal_get_configuration()->mem_config;
 360
 361         rte_rwlock_read_lock(&mcfg->mlock);
 362         /* dump all zones */
 363         for (i=0; i<RTE_MAX_MEMZONE; i++) {
 364                 if (mcfg->memzone[i].addr == NULL)
 365                         break;
 366                 fprintf(f, "Zone %u: name:<%s>, IO:0x%"PRIx64", len:0x%zx"
 367                        ", virt:%p, socket_id:%"PRId32", flags:%"PRIx32"\n", i,
 368                        mcfg->memzone[i].name,
 369                        mcfg->memzone[i].iova,
 370                        mcfg->memzone[i].len,
 371                        mcfg->memzone[i].addr,
 372                        mcfg->memzone[i].socket_id,
 373                        mcfg->memzone[i].flags);
 374         }
 375         rte_rwlock_read_unlock(&mcfg->mlock);
 376 }
 377
 378 /*
 379  * Init the memzone subsystem
 380  */
 381 int
 382 rte_eal_memzone_init(void)
 383 {
 384         struct rte_mem_config *mcfg;
 385         const struct rte_memseg *memseg;
 386
 387         /* get pointer to global configuration */
 388         mcfg = rte_eal_get_configuration()->mem_config;
 389
 390         /* secondary processes don't need to initialise anything */
 391         if (rte_eal_process_type() == RTE_PROC_SECONDARY)
 392                 return 0;
 393
 394         memseg = rte_eal_get_physmem_layout();
 395         if (memseg == NULL) {
 396                 RTE_LOG(ERR, EAL, "%s(): Cannot get physical layout\n", __func__);
 397                 return -1;
 398         }
 399
 400         rte_rwlock_write_lock(&mcfg->mlock);
 401
 402         /* delete all zones */
 403         mcfg->memzone_cnt = 0;
 404         memset(mcfg->memzone, 0, sizeof(mcfg->memzone));
 405
 406         rte_rwlock_write_unlock(&mcfg->mlock);
 407
 408         return rte_eal_malloc_heap_init();
 409 }
 410
 411 /* Walk all reserved memory zones */
 412 void rte_memzone_walk(void (*func)(const struct rte_memzone *, void *),
 413                       void *arg)
 414 {
 415         struct rte_mem_config *mcfg;
 416         unsigned i;
 417
 418         mcfg = rte_eal_get_configuration()->mem_config;
 419
 420         rte_rwlock_read_lock(&mcfg->mlock);
 421         for (i=0; i<RTE_MAX_MEMZONE; i++) {
 422                 if (mcfg->memzone[i].addr != NULL)
 423                         (*func)(&mcfg->memzone[i], arg);
 424         }
 425         rte_rwlock_read_unlock(&mcfg->mlock);
 426 }