lib/librte_eal/common/eal_memcfg.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2019 Intel Corporation
   3  */
   4
   5 #ifndef EAL_MEMCFG_H
   6 #define EAL_MEMCFG_H
   7
   8 #include <rte_config.h>
   9 #include <rte_eal_memconfig.h>
  10 #include <rte_malloc_heap.h>
  11 #include <rte_memory.h>
  12 #include <rte_memzone.h>
  13 #include <rte_pause.h>
  14 #include <rte_rwlock.h>
  15 #include <rte_tailq.h>
  16
  17 /**
  18  * Memory configuration shared across multiple processes.
  19  */
  20 struct rte_mem_config {
  21         volatile uint32_t magic;   /**< Magic number - sanity check. */
  22         uint32_t version;
  23         /**< Prevent secondary processes using different DPDK versions. */
  24
  25         /* memory topology */
  26         uint32_t nchannel;    /**< Number of channels (0 if unknown). */
  27         uint32_t nrank;       /**< Number of ranks (0 if unknown). */
  28
  29         /**
  30          * current lock nest order
  31          *  - qlock->mlock (ring/hash/lpm)
  32          *  - mplock->qlock->mlock (mempool)
  33          * Notice:
  34          *  *ALWAYS* obtain qlock first if having to obtain both qlock and mlock
  35          */
  36         rte_rwlock_t mlock;   /**< used by memzones for thread safety. */
  37         rte_rwlock_t qlock;   /**< used by tailqs for thread safety. */
  38         rte_rwlock_t mplock;  /**< used by mempool library for thread safety. */
  39
  40         rte_rwlock_t memory_hotplug_lock;
  41         /**< Indicates whether memory hotplug request is in progress. */
  42
  43         /* memory segments and zones */
  44         struct rte_fbarray memzones; /**< Memzone descriptors. */
  45
  46         struct rte_memseg_list memsegs[RTE_MAX_MEMSEG_LISTS];
  47         /**< List of dynamic arrays holding memsegs */
  48
  49         struct rte_tailq_head tailq_head[RTE_MAX_TAILQ];
  50         /**< Tailqs for objects */
  51
  52         struct malloc_heap malloc_heaps[RTE_MAX_HEAPS];
  53         /**< DPDK malloc heaps */
  54
  55         int next_socket_id; /**< Next socket ID for external malloc heap */
  56
  57         /* rte_mem_config has to be mapped at the exact same address in all
  58          * processes, so we need to store it.
  59          */
  60         uint64_t mem_cfg_addr; /**< Address of this structure in memory. */
  61
  62         /* Primary and secondary processes cannot run with different legacy or
  63          * single file segments options, so to avoid having to specify these
  64          * options to all processes, store them in shared config and update the
  65          * internal config at init time.
  66          */
  67         uint32_t legacy_mem; /**< stored legacy mem parameter. */
  68         uint32_t single_file_segments;
  69         /**< stored single file segments parameter. */
  70
  71         uint8_t dma_maskbits; /**< Keeps the more restricted dma mask. */
  72 };
  73
  74 /* update internal config from shared mem config */
  75 void
  76 eal_mcfg_update_internal(void);
  77
  78 /* update shared mem config from internal config */
  79 void
  80 eal_mcfg_update_from_internal(void);
  81
  82 /* wait until primary process initialization is complete */
  83 void
  84 eal_mcfg_wait_complete(void);
  85
  86 /* check if DPDK version of current process matches one stored in the config */
  87 int
  88 eal_mcfg_check_version(void);
  89
  90 /* set mem config as complete */
  91 void
  92 eal_mcfg_complete(void);
  93
  94 #endif /* EAL_MEMCFG_H */