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_memory.h>
9 #include <rte_memzone.h>
10 #include <rte_pause.h>
11 #include <rte_spinlock.h>
12 #include <rte_rwlock.h>
13 #include <rte_tailq.h>
14 
15 #include "malloc_heap.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 	rte_spinlock_t tlock; /**< used by timer library for thread safety. */
40 
41 	rte_rwlock_t memory_hotplug_lock;
42 	/**< Indicates whether memory hotplug request is in progress. */
43 
44 	uint8_t mp_status; /**< Multiprocess status. */
45 
46 	/* memory segments and zones */
47 	struct rte_fbarray memzones; /**< Memzone descriptors. */
48 
49 	struct rte_memseg_list memsegs[RTE_MAX_MEMSEG_LISTS];
50 	/**< List of dynamic arrays holding memsegs */
51 
52 	struct rte_tailq_head tailq_head[RTE_MAX_TAILQ];
53 	/**< Tailqs for objects */
54 
55 	struct malloc_heap malloc_heaps[RTE_MAX_HEAPS];
56 	/**< DPDK malloc heaps */
57 
58 	int next_socket_id; /**< Next socket ID for external malloc heap */
59 
60 	/* rte_mem_config has to be mapped at the exact same address in all
61 	 * processes, so we need to store it.
62 	 */
63 	uint64_t mem_cfg_addr; /**< Address of this structure in memory. */
64 
65 	/* Primary and secondary processes cannot run with different legacy or
66 	 * single file segments options, so to avoid having to specify these
67 	 * options to all processes, store them in shared config and update the
68 	 * internal config at init time.
69 	 */
70 	uint32_t legacy_mem; /**< stored legacy mem parameter. */
71 	uint32_t single_file_segments;
72 	/**< stored single file segments parameter. */
73 
74 	uint64_t tsc_hz;
75 	/**< TSC rate */
76 
77 	uint8_t dma_maskbits; /**< Keeps the more restricted dma mask. */
78 };
79 
80 /* update internal config from shared mem config */
81 void
82 eal_mcfg_update_internal(void);
83 
84 /* update shared mem config from internal config */
85 void
86 eal_mcfg_update_from_internal(void);
87 
88 /* wait until primary process initialization is complete */
89 void
90 eal_mcfg_wait_complete(void);
91 
92 /* check if DPDK version of current process matches one stored in the config */
93 int
94 eal_mcfg_check_version(void);
95 
96 /* set mem config as complete */
97 void
98 eal_mcfg_complete(void);
99 
100 #endif /* EAL_MEMCFG_H */
101