lib/librte_eal/common/eal_common_memzone.c

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