2361c3b8f21628f6199d4a0dbd7adc058910af20
[dpdk.git] / doc / guides / prog_guide / env_abstraction_layer.rst
1 ..  SPDX-License-Identifier: BSD-3-Clause
2     Copyright(c) 2010-2014 Intel Corporation.
3
4 .. _Environment_Abstraction_Layer:
5
6 Environment Abstraction Layer
7 =============================
8
9 The Environment Abstraction Layer (EAL) is responsible for gaining access to low-level resources such as hardware and memory space.
10 It provides a generic interface that hides the environment specifics from the applications and libraries.
11 It is the responsibility of the initialization routine to decide how to allocate these resources
12 (that is, memory space, devices, timers, consoles, and so on).
13
14 Typical services expected from the EAL are:
15
16 *   DPDK Loading and Launching:
17     The DPDK and its application are linked as a single application and must be loaded by some means.
18
19 *   Core Affinity/Assignment Procedures:
20     The EAL provides mechanisms for assigning execution units to specific cores as well as creating execution instances.
21
22 *   System Memory Reservation:
23     The EAL facilitates the reservation of different memory zones, for example, physical memory areas for device interactions.
24
25 *   Trace and Debug Functions: Logs, dump_stack, panic and so on.
26
27 *   Utility Functions: Spinlocks and atomic counters that are not provided in libc.
28
29 *   CPU Feature Identification: Determine at runtime if a particular feature, for example, IntelĀ® AVX is supported.
30     Determine if the current CPU supports the feature set that the binary was compiled for.
31
32 *   Interrupt Handling: Interfaces to register/unregister callbacks to specific interrupt sources.
33
34 *   Alarm Functions: Interfaces to set/remove callbacks to be run at a specific time.
35
36 EAL in a Linux-userland Execution Environment
37 ---------------------------------------------
38
39 In a Linux user space environment, the DPDK application runs as a user-space application using the pthread library.
40
41 The EAL performs physical memory allocation using mmap() in hugetlbfs (using huge page sizes to increase performance).
42 This memory is exposed to DPDK service layers such as the :ref:`Mempool Library <Mempool_Library>`.
43
44 At this point, the DPDK services layer will be initialized, then through pthread setaffinity calls,
45 each execution unit will be assigned to a specific logical core to run as a user-level thread.
46
47 The time reference is provided by the CPU Time-Stamp Counter (TSC) or by the HPET kernel API through a mmap() call.
48
49 Initialization and Core Launching
50 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
51
52 Part of the initialization is done by the start function of glibc.
53 A check is also performed at initialization time to ensure that the micro architecture type chosen in the config file is supported by the CPU.
54 Then, the main() function is called. The core initialization and launch is done in rte_eal_init() (see the API documentation).
55 It consist of calls to the pthread library (more specifically, pthread_self(), pthread_create(), and pthread_setaffinity_np()).
56
57 .. _figure_linux_launch:
58
59 .. figure:: img/linuxapp_launch.*
60
61    EAL Initialization in a Linux Application Environment
62
63
64 .. note::
65
66     Initialization of objects, such as memory zones, rings, memory pools, lpm tables and hash tables,
67     should be done as part of the overall application initialization on the master lcore.
68     The creation and initialization functions for these objects are not multi-thread safe.
69     However, once initialized, the objects themselves can safely be used in multiple threads simultaneously.
70
71 Shutdown and Cleanup
72 ~~~~~~~~~~~~~~~~~~~~
73
74 During the initialization of EAL resources such as hugepage backed memory can be
75 allocated by core components.  The memory allocated during ``rte_eal_init()``
76 can be released by calling the ``rte_eal_cleanup()`` function. Refer to the
77 API documentation for details.
78
79 Multi-process Support
80 ~~~~~~~~~~~~~~~~~~~~~
81
82 The Linux EAL allows a multi-process as well as a multi-threaded (pthread) deployment model.
83 See chapter
84 :ref:`Multi-process Support <Multi-process_Support>` for more details.
85
86 Memory Mapping Discovery and Memory Reservation
87 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
88
89 The allocation of large contiguous physical memory is done using the hugetlbfs kernel filesystem.
90 The EAL provides an API to reserve named memory zones in this contiguous memory.
91 The physical address of the reserved memory for that memory zone is also returned to the user by the memory zone reservation API.
92
93 There are two modes in which DPDK memory subsystem can operate: dynamic mode,
94 and legacy mode. Both modes are explained below.
95
96 .. note::
97
98     Memory reservations done using the APIs provided by rte_malloc are also backed by pages from the hugetlbfs filesystem.
99
100 + Dynamic memory mode
101
102 Currently, this mode is only supported on Linux.
103
104 In this mode, usage of hugepages by DPDK application will grow and shrink based
105 on application's requests. Any memory allocation through ``rte_malloc()``,
106 ``rte_memzone_reserve()`` or other methods, can potentially result in more
107 hugepages being reserved from the system. Similarly, any memory deallocation can
108 potentially result in hugepages being released back to the system.
109
110 Memory allocated in this mode is not guaranteed to be IOVA-contiguous. If large
111 chunks of IOVA-contiguous are required (with "large" defined as "more than one
112 page"), it is recommended to either use VFIO driver for all physical devices (so
113 that IOVA and VA addresses can be the same, thereby bypassing physical addresses
114 entirely), or use legacy memory mode.
115
116 For chunks of memory which must be IOVA-contiguous, it is recommended to use
117 ``rte_memzone_reserve()`` function with ``RTE_MEMZONE_IOVA_CONTIG`` flag
118 specified. This way, memory allocator will ensure that, whatever memory mode is
119 in use, either reserved memory will satisfy the requirements, or the allocation
120 will fail.
121
122 There is no need to preallocate any memory at startup using ``-m`` or
123 ``--socket-mem`` command-line parameters, however it is still possible to do so,
124 in which case preallocate memory will be "pinned" (i.e. will never be released
125 by the application back to the system). It will be possible to allocate more
126 hugepages, and deallocate those, but any preallocated pages will not be freed.
127 If neither ``-m`` nor ``--socket-mem`` were specified, no memory will be
128 preallocated, and all memory will be allocated at runtime, as needed.
129
130 Another available option to use in dynamic memory mode is
131 ``--single-file-segments`` command-line option. This option will put pages in
132 single files (per memseg list), as opposed to creating a file per page. This is
133 normally not needed, but can be useful for use cases like userspace vhost, where
134 there is limited number of page file descriptors that can be passed to VirtIO.
135
136 If the application (or DPDK-internal code, such as device drivers) wishes to
137 receive notifications about newly allocated memory, it is possible to register
138 for memory event callbacks via ``rte_mem_event_callback_register()`` function.
139 This will call a callback function any time DPDK's memory map has changed.
140
141 If the application (or DPDK-internal code, such as device drivers) wishes to be
142 notified about memory allocations above specified threshold (and have a chance
143 to deny them), allocation validator callbacks are also available via
144 ``rte_mem_alloc_validator_callback_register()`` function.
145
146 A default validator callback is provided by EAL, which can be enabled with a
147 ``--socket-limit`` command-line option, for a simple way to limit maximum amount
148 of memory that can be used by DPDK application.
149
150 + Legacy memory mode
151
152 This mode is enabled by specifying ``--legacy-mem`` command-line switch to the
153 EAL. This switch will have no effect on FreeBSD as FreeBSD only supports
154 legacy mode anyway.
155
156 This mode mimics historical behavior of EAL. That is, EAL will reserve all
157 memory at startup, sort all memory into large IOVA-contiguous chunks, and will
158 not allow acquiring or releasing hugepages from the system at runtime.
159
160 If neither ``-m`` nor ``--socket-mem`` were specified, the entire available
161 hugepage memory will be preallocated.
162
163 + Hugepage allocation matching
164
165 This behavior is enabled by specifying the ``--match-allocations`` command-line
166 switch to the EAL. This switch is Linux-only and not supported with
167 ``--legacy-mem`` nor ``--no-huge``.
168
169 Some applications using memory event callbacks may require that hugepages be
170 freed exactly as they were allocated. These applications may also require
171 that any allocation from the malloc heap not span across allocations
172 associated with two different memory event callbacks. Hugepage allocation
173 matching can be used by these types of applications to satisfy both of these
174 requirements. This can result in some increased memory usage which is
175 very dependent on the memory allocation patterns of the application.
176
177 + 32-bit support
178
179 Additional restrictions are present when running in 32-bit mode. In dynamic
180 memory mode, by default maximum of 2 gigabytes of VA space will be preallocated,
181 and all of it will be on master lcore NUMA node unless ``--socket-mem`` flag is
182 used.
183
184 In legacy mode, VA space will only be preallocated for segments that were
185 requested (plus padding, to keep IOVA-contiguousness).
186
187 + Maximum amount of memory
188
189 All possible virtual memory space that can ever be used for hugepage mapping in
190 a DPDK process is preallocated at startup, thereby placing an upper limit on how
191 much memory a DPDK application can have. DPDK memory is stored in segment lists,
192 each segment is strictly one physical page. It is possible to change the amount
193 of virtual memory being preallocated at startup by editing the following config
194 variables:
195
196 * ``CONFIG_RTE_MAX_MEMSEG_LISTS`` controls how many segment lists can DPDK have
197 * ``CONFIG_RTE_MAX_MEM_MB_PER_LIST`` controls how much megabytes of memory each
198   segment list can address
199 * ``CONFIG_RTE_MAX_MEMSEG_PER_LIST`` controls how many segments each segment can
200   have
201 * ``CONFIG_RTE_MAX_MEMSEG_PER_TYPE`` controls how many segments each memory type
202   can have (where "type" is defined as "page size + NUMA node" combination)
203 * ``CONFIG_RTE_MAX_MEM_MB_PER_TYPE`` controls how much megabytes of memory each
204   memory type can address
205 * ``CONFIG_RTE_MAX_MEM_MB`` places a global maximum on the amount of memory
206   DPDK can reserve
207
208 Normally, these options do not need to be changed.
209
210 .. note::
211
212     Preallocated virtual memory is not to be confused with preallocated hugepage
213     memory! All DPDK processes preallocate virtual memory at startup. Hugepages
214     can later be mapped into that preallocated VA space (if dynamic memory mode
215     is enabled), and can optionally be mapped into it at startup.
216
217 Support for Externally Allocated Memory
218 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
219
220 It is possible to use externally allocated memory in DPDK. There are two ways in
221 which using externally allocated memory can work: the malloc heap API's, and
222 manual memory management.
223
224 + Using heap API's for externally allocated memory
225
226 Using using a set of malloc heap API's is the recommended way to use externally
227 allocated memory in DPDK. In this way, support for externally allocated memory
228 is implemented through overloading the socket ID - externally allocated heaps
229 will have socket ID's that would be considered invalid under normal
230 circumstances. Requesting an allocation to take place from a specified
231 externally allocated memory is a matter of supplying the correct socket ID to
232 DPDK allocator, either directly (e.g. through a call to ``rte_malloc``) or
233 indirectly (through data structure-specific allocation API's such as
234 ``rte_ring_create``). Using these API's also ensures that mapping of externally
235 allocated memory for DMA is also performed on any memory segment that is added
236 to a DPDK malloc heap.
237
238 Since there is no way DPDK can verify whether memory is available or valid, this
239 responsibility falls on the shoulders of the user. All multiprocess
240 synchronization is also user's responsibility, as well as ensuring  that all
241 calls to add/attach/detach/remove memory are done in the correct order. It is
242 not required to attach to a memory area in all processes - only attach to memory
243 areas as needed.
244
245 The expected workflow is as follows:
246
247 * Get a pointer to memory area
248 * Create a named heap
249 * Add memory area(s) to the heap
250     - If IOVA table is not specified, IOVA addresses will be assumed to be
251       unavailable, and DMA mappings will not be performed
252     - Other processes must attach to the memory area before they can use it
253 * Get socket ID used for the heap
254 * Use normal DPDK allocation procedures, using supplied socket ID
255 * If memory area is no longer needed, it can be removed from the heap
256     - Other processes must detach from this memory area before it can be removed
257 * If heap is no longer needed, remove it
258     - Socket ID will become invalid and will not be reused
259
260 For more information, please refer to ``rte_malloc`` API documentation,
261 specifically the ``rte_malloc_heap_*`` family of function calls.
262
263 + Using externally allocated memory without DPDK API's
264
265 While using heap API's is the recommended method of using externally allocated
266 memory in DPDK, there are certain use cases where the overhead of DPDK heap API
267 is undesirable - for example, when manual memory management is performed on an
268 externally allocated area. To support use cases where externally allocated
269 memory will not be used as part of normal DPDK workflow, there is also another
270 set of API's under the ``rte_extmem_*`` namespace.
271
272 These API's are (as their name implies) intended to allow registering or
273 unregistering externally allocated memory to/from DPDK's internal page table, to
274 allow API's like ``rte_virt2memseg`` etc. to work with externally allocated
275 memory. Memory added this way will not be available for any regular DPDK
276 allocators; DPDK will leave this memory for the user application to manage.
277
278 The expected workflow is as follows:
279
280 * Get a pointer to memory area
281 * Register memory within DPDK
282     - If IOVA table is not specified, IOVA addresses will be assumed to be
283       unavailable
284     - Other processes must attach to the memory area before they can use it
285 * Perform DMA mapping with ``rte_vfio_dma_map`` if needed
286 * Use the memory area in your application
287 * If memory area is no longer needed, it can be unregistered
288     - If the area was mapped for DMA, unmapping must be performed before
289       unregistering memory
290     - Other processes must detach from the memory area before it can be
291       unregistered
292
293 Since these externally allocated memory areas will not be managed by DPDK, it is
294 therefore up to the user application to decide how to use them and what to do
295 with them once they're registered.
296
297 Per-lcore and Shared Variables
298 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
299
300 .. note::
301
302     lcore refers to a logical execution unit of the processor, sometimes called a hardware *thread*.
303
304 Shared variables are the default behavior.
305 Per-lcore variables are implemented using *Thread Local Storage* (TLS) to provide per-thread local storage.
306
307 Logs
308 ~~~~
309
310 A logging API is provided by EAL.
311 By default, in a Linux application, logs are sent to syslog and also to the console.
312 However, the log function can be overridden by the user to use a different logging mechanism.
313
314 Trace and Debug Functions
315 ^^^^^^^^^^^^^^^^^^^^^^^^^
316
317 There are some debug functions to dump the stack in glibc.
318 The rte_panic() function can voluntarily provoke a SIG_ABORT,
319 which can trigger the generation of a core file, readable by gdb.
320
321 CPU Feature Identification
322 ~~~~~~~~~~~~~~~~~~~~~~~~~~
323
324 The EAL can query the CPU at runtime (using the rte_cpu_get_features() function) to determine which CPU features are available.
325
326 User Space Interrupt Event
327 ~~~~~~~~~~~~~~~~~~~~~~~~~~
328
329 + User Space Interrupt and Alarm Handling in Host Thread
330
331 The EAL creates a host thread to poll the UIO device file descriptors to detect the interrupts.
332 Callbacks can be registered or unregistered by the EAL functions for a specific interrupt event
333 and are called in the host thread asynchronously.
334 The EAL also allows timed callbacks to be used in the same way as for NIC interrupts.
335
336 .. note::
337
338     In DPDK PMD, the only interrupts handled by the dedicated host thread are those for link status change
339     (link up and link down notification) and for sudden device removal.
340
341
342 + RX Interrupt Event
343
344 The receive and transmit routines provided by each PMD don't limit themselves to execute in polling thread mode.
345 To ease the idle polling with tiny throughput, it's useful to pause the polling and wait until the wake-up event happens.
346 The RX interrupt is the first choice to be such kind of wake-up event, but probably won't be the only one.
347
348 EAL provides the event APIs for this event-driven thread mode.
349 Taking Linux as an example, the implementation relies on epoll. Each thread can monitor an epoll instance
350 in which all the wake-up events' file descriptors are added. The event file descriptors are created and mapped to
351 the interrupt vectors according to the UIO/VFIO spec.
352 From FreeBSD's perspective, kqueue is the alternative way, but not implemented yet.
353
354 EAL initializes the mapping between event file descriptors and interrupt vectors, while each device initializes the mapping
355 between interrupt vectors and queues. In this way, EAL actually is unaware of the interrupt cause on the specific vector.
356 The eth_dev driver takes responsibility to program the latter mapping.
357
358 .. note::
359
360     Per queue RX interrupt event is only allowed in VFIO which supports multiple MSI-X vector. In UIO, the RX interrupt
361     together with other interrupt causes shares the same vector. In this case, when RX interrupt and LSC(link status change)
362     interrupt are both enabled(intr_conf.lsc == 1 && intr_conf.rxq == 1), only the former is capable.
363
364 The RX interrupt are controlled/enabled/disabled by ethdev APIs - 'rte_eth_dev_rx_intr_*'. They return failure if the PMD
365 hasn't support them yet. The intr_conf.rxq flag is used to turn on the capability of RX interrupt per device.
366
367 + Device Removal Event
368
369 This event is triggered by a device being removed at a bus level. Its
370 underlying resources may have been made unavailable (i.e. PCI mappings
371 unmapped). The PMD must make sure that on such occurrence, the application can
372 still safely use its callbacks.
373
374 This event can be subscribed to in the same way one would subscribe to a link
375 status change event. The execution context is thus the same, i.e. it is the
376 dedicated interrupt host thread.
377
378 Considering this, it is likely that an application would want to close a
379 device having emitted a Device Removal Event. In such case, calling
380 ``rte_eth_dev_close()`` can trigger it to unregister its own Device Removal Event
381 callback. Care must be taken not to close the device from the interrupt handler
382 context. It is necessary to reschedule such closing operation.
383
384 Blacklisting
385 ~~~~~~~~~~~~
386
387 The EAL PCI device blacklist functionality can be used to mark certain NIC ports as blacklisted,
388 so they are ignored by the DPDK.
389 The ports to be blacklisted are identified using the PCIe* description (Domain:Bus:Device.Function).
390
391 Misc Functions
392 ~~~~~~~~~~~~~~
393
394 Locks and atomic operations are per-architecture (i686 and x86_64).
395
396 IOVA Mode Configuration
397 ~~~~~~~~~~~~~~~~~~~~~~~
398
399 Auto detection of the IOVA mode, based on probing the bus and IOMMU configuration, may not report
400 the desired addressing mode when virtual devices that are not directly attached to the bus are present.
401 To facilitate forcing the IOVA mode to a specific value the EAL command line option ``--iova-mode`` can
402 be used to select either physical addressing('pa') or virtual addressing('va').
403
404 Memory Segments and Memory Zones (memzone)
405 ------------------------------------------
406
407 The mapping of physical memory is provided by this feature in the EAL.
408 As physical memory can have gaps, the memory is described in a table of descriptors,
409 and each descriptor (called rte_memseg ) describes a physical page.
410
411 On top of this, the memzone allocator's role is to reserve contiguous portions of physical memory.
412 These zones are identified by a unique name when the memory is reserved.
413
414 The rte_memzone descriptors are also located in the configuration structure.
415 This structure is accessed using rte_eal_get_configuration().
416 The lookup (by name) of a memory zone returns a descriptor containing the physical address of the memory zone.
417
418 Memory zones can be reserved with specific start address alignment by supplying the align parameter
419 (by default, they are aligned to cache line size).
420 The alignment value should be a power of two and not less than the cache line size (64 bytes).
421 Memory zones can also be reserved from either 2 MB or 1 GB hugepages, provided that both are available on the system.
422
423 Both memsegs and memzones are stored using ``rte_fbarray`` structures. Please
424 refer to *DPDK API Reference* for more information.
425
426
427 Multiple pthread
428 ----------------
429
430 DPDK usually pins one pthread per core to avoid the overhead of task switching.
431 This allows for significant performance gains, but lacks flexibility and is not always efficient.
432
433 Power management helps to improve the CPU efficiency by limiting the CPU runtime frequency.
434 However, alternately it is possible to utilize the idle cycles available to take advantage of
435 the full capability of the CPU.
436
437 By taking advantage of cgroup, the CPU utilization quota can be simply assigned.
438 This gives another way to improve the CPU efficiency, however, there is a prerequisite;
439 DPDK must handle the context switching between multiple pthreads per core.
440
441 For further flexibility, it is useful to set pthread affinity not only to a CPU but to a CPU set.
442
443 EAL pthread and lcore Affinity
444 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
445
446 The term "lcore" refers to an EAL thread, which is really a Linux/FreeBSD pthread.
447 "EAL pthreads"  are created and managed by EAL and execute the tasks issued by *remote_launch*.
448 In each EAL pthread, there is a TLS (Thread Local Storage) called *_lcore_id* for unique identification.
449 As EAL pthreads usually bind 1:1 to the physical CPU, the *_lcore_id* is typically equal to the CPU ID.
450
451 When using multiple pthreads, however, the binding is no longer always 1:1 between an EAL pthread and a specified physical CPU.
452 The EAL pthread may have affinity to a CPU set, and as such the *_lcore_id* will not be the same as the CPU ID.
453 For this reason, there is an EAL long option '--lcores' defined to assign the CPU affinity of lcores.
454 For a specified lcore ID or ID group, the option allows setting the CPU set for that EAL pthread.
455
456 The format pattern:
457         --lcores='<lcore_set>[@cpu_set][,<lcore_set>[@cpu_set],...]'
458
459 'lcore_set' and 'cpu_set' can be a single number, range or a group.
460
461 A number is a "digit([0-9]+)"; a range is "<number>-<number>"; a group is "(<number|range>[,<number|range>,...])".
462
463 If a '\@cpu_set' value is not supplied, the value of 'cpu_set' will default to the value of 'lcore_set'.
464
465     ::
466
467         For example, "--lcores='1,2@(5-7),(3-5)@(0,2),(0,6),7-8'" which means start 9 EAL thread;
468             lcore 0 runs on cpuset 0x41 (cpu 0,6);
469             lcore 1 runs on cpuset 0x2 (cpu 1);
470             lcore 2 runs on cpuset 0xe0 (cpu 5,6,7);
471             lcore 3,4,5 runs on cpuset 0x5 (cpu 0,2);
472             lcore 6 runs on cpuset 0x41 (cpu 0,6);
473             lcore 7 runs on cpuset 0x80 (cpu 7);
474             lcore 8 runs on cpuset 0x100 (cpu 8).
475
476 Using this option, for each given lcore ID, the associated CPUs can be assigned.
477 It's also compatible with the pattern of corelist('-l') option.
478
479 non-EAL pthread support
480 ~~~~~~~~~~~~~~~~~~~~~~~
481
482 It is possible to use the DPDK execution context with any user pthread (aka. Non-EAL pthreads).
483 In a non-EAL pthread, the *_lcore_id* is always LCORE_ID_ANY which identifies that it is not an EAL thread with a valid, unique, *_lcore_id*.
484 Some libraries will use an alternative unique ID (e.g. TID), some will not be impacted at all, and some will work but with limitations (e.g. timer and mempool libraries).
485
486 All these impacts are mentioned in :ref:`known_issue_label` section.
487
488 Public Thread API
489 ~~~~~~~~~~~~~~~~~
490
491 There are two public APIs ``rte_thread_set_affinity()`` and ``rte_thread_get_affinity()`` introduced for threads.
492 When they're used in any pthread context, the Thread Local Storage(TLS) will be set/get.
493
494 Those TLS include *_cpuset* and *_socket_id*:
495
496 *       *_cpuset* stores the CPUs bitmap to which the pthread is affinitized.
497
498 *       *_socket_id* stores the NUMA node of the CPU set. If the CPUs in CPU set belong to different NUMA node, the *_socket_id* will be set to SOCKET_ID_ANY.
499
500
501 Control Thread API
502 ~~~~~~~~~~~~~~~~~~
503
504 It is possible to create Control Threads using the public API
505 ``rte_ctrl_thread_create()``.
506 Those threads can be used for management/infrastructure tasks and are used
507 internally by DPDK for multi process support and interrupt handling.
508
509 Those threads will be scheduled on CPUs part of the original process CPU
510 affinity from which the dataplane and service lcores are excluded.
511
512 For example, on a 8 CPUs system, starting a dpdk application with -l 2,3
513 (dataplane cores), then depending on the affinity configuration which can be
514 controlled with tools like taskset (Linux) or cpuset (FreeBSD),
515
516 - with no affinity configuration, the Control Threads will end up on
517   0-1,4-7 CPUs.
518 - with affinity restricted to 2-4, the Control Threads will end up on
519   CPU 4.
520 - with affinity restricted to 2-3, the Control Threads will end up on
521   CPU 2 (master lcore, which is the default when no CPU is available).
522
523 .. _known_issue_label:
524
525 Known Issues
526 ~~~~~~~~~~~~
527
528 + rte_mempool
529
530   The rte_mempool uses a per-lcore cache inside the mempool.
531   For non-EAL pthreads, ``rte_lcore_id()`` will not return a valid number.
532   So for now, when rte_mempool is used with non-EAL pthreads, the put/get operations will bypass the default mempool cache and there is a performance penalty because of this bypass.
533   Only user-owned external caches can be used in a non-EAL context in conjunction with ``rte_mempool_generic_put()`` and ``rte_mempool_generic_get()`` that accept an explicit cache parameter.
534
535 + rte_ring
536
537   rte_ring supports multi-producer enqueue and multi-consumer dequeue.
538   However, it is non-preemptive, this has a knock on effect of making rte_mempool non-preemptable.
539
540   .. note::
541
542     The "non-preemptive" constraint means:
543
544     - a pthread doing multi-producers enqueues on a given ring must not
545       be preempted by another pthread doing a multi-producer enqueue on
546       the same ring.
547     - a pthread doing multi-consumers dequeues on a given ring must not
548       be preempted by another pthread doing a multi-consumer dequeue on
549       the same ring.
550
551     Bypassing this constraint may cause the 2nd pthread to spin until the 1st one is scheduled again.
552     Moreover, if the 1st pthread is preempted by a context that has an higher priority, it may even cause a dead lock.
553
554   This means, use cases involving preemptible pthreads should consider using rte_ring carefully.
555
556   1. It CAN be used for preemptible single-producer and single-consumer use case.
557
558   2. It CAN be used for non-preemptible multi-producer and preemptible single-consumer use case.
559
560   3. It CAN be used for preemptible single-producer and non-preemptible multi-consumer use case.
561
562   4. It MAY be used by preemptible multi-producer and/or preemptible multi-consumer pthreads whose scheduling policy are all SCHED_OTHER(cfs), SCHED_IDLE or SCHED_BATCH. User SHOULD be aware of the performance penalty before using it.
563
564   5. It MUST not be used by multi-producer/consumer pthreads, whose scheduling policies are SCHED_FIFO or SCHED_RR.
565
566 + rte_timer
567
568   Running  ``rte_timer_manage()`` on a non-EAL pthread is not allowed. However, resetting/stopping the timer from a non-EAL pthread is allowed.
569
570 + rte_log
571
572   In non-EAL pthreads, there is no per thread loglevel and logtype, global loglevels are used.
573
574 + misc
575
576   The debug statistics of rte_ring, rte_mempool and rte_timer are not supported in a non-EAL pthread.
577
578 cgroup control
579 ~~~~~~~~~~~~~~
580
581 The following is a simple example of cgroup control usage, there are two pthreads(t0 and t1) doing packet I/O on the same core ($CPU).
582 We expect only 50% of CPU spend on packet IO.
583
584   .. code-block:: console
585
586     mkdir /sys/fs/cgroup/cpu/pkt_io
587     mkdir /sys/fs/cgroup/cpuset/pkt_io
588
589     echo $cpu > /sys/fs/cgroup/cpuset/cpuset.cpus
590
591     echo $t0 > /sys/fs/cgroup/cpu/pkt_io/tasks
592     echo $t0 > /sys/fs/cgroup/cpuset/pkt_io/tasks
593
594     echo $t1 > /sys/fs/cgroup/cpu/pkt_io/tasks
595     echo $t1 > /sys/fs/cgroup/cpuset/pkt_io/tasks
596
597     cd /sys/fs/cgroup/cpu/pkt_io
598     echo 100000 > pkt_io/cpu.cfs_period_us
599     echo  50000 > pkt_io/cpu.cfs_quota_us
600
601
602 Malloc
603 ------
604
605 The EAL provides a malloc API to allocate any-sized memory.
606
607 The objective of this API is to provide malloc-like functions to allow
608 allocation from hugepage memory and to facilitate application porting.
609 The *DPDK API Reference* manual describes the available functions.
610
611 Typically, these kinds of allocations should not be done in data plane
612 processing because they are slower than pool-based allocation and make
613 use of locks within the allocation and free paths.
614 However, they can be used in configuration code.
615
616 Refer to the rte_malloc() function description in the *DPDK API Reference*
617 manual for more information.
618
619 Cookies
620 ~~~~~~~
621
622 When CONFIG_RTE_MALLOC_DEBUG is enabled, the allocated memory contains
623 overwrite protection fields to help identify buffer overflows.
624
625 Alignment and NUMA Constraints
626 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
627
628 The rte_malloc() takes an align argument that can be used to request a memory
629 area that is aligned on a multiple of this value (which must be a power of two).
630
631 On systems with NUMA support, a call to the rte_malloc() function will return
632 memory that has been allocated on the NUMA socket of the core which made the call.
633 A set of APIs is also provided, to allow memory to be explicitly allocated on a
634 NUMA socket directly, or by allocated on the NUMA socket where another core is
635 located, in the case where the memory is to be used by a logical core other than
636 on the one doing the memory allocation.
637
638 Use Cases
639 ~~~~~~~~~
640
641 This API is meant to be used by an application that requires malloc-like
642 functions at initialization time.
643
644 For allocating/freeing data at runtime, in the fast-path of an application,
645 the memory pool library should be used instead.
646
647 Internal Implementation
648 ~~~~~~~~~~~~~~~~~~~~~~~
649
650 Data Structures
651 ^^^^^^^^^^^^^^^
652
653 There are two data structure types used internally in the malloc library:
654
655 *   struct malloc_heap - used to track free space on a per-socket basis
656
657 *   struct malloc_elem - the basic element of allocation and free-space
658     tracking inside the library.
659
660 Structure: malloc_heap
661 """"""""""""""""""""""
662
663 The malloc_heap structure is used to manage free space on a per-socket basis.
664 Internally, there is one heap structure per NUMA node, which allows us to
665 allocate memory to a thread based on the NUMA node on which this thread runs.
666 While this does not guarantee that the memory will be used on that NUMA node,
667 it is no worse than a scheme where the memory is always allocated on a fixed
668 or random node.
669
670 The key fields of the heap structure and their function are described below
671 (see also diagram above):
672
673 *   lock - the lock field is needed to synchronize access to the heap.
674     Given that the free space in the heap is tracked using a linked list,
675     we need a lock to prevent two threads manipulating the list at the same time.
676
677 *   free_head - this points to the first element in the list of free nodes for
678     this malloc heap.
679
680 *   first - this points to the first element in the heap.
681
682 *   last - this points to the last element in the heap.
683
684 .. _figure_malloc_heap:
685
686 .. figure:: img/malloc_heap.*
687
688    Example of a malloc heap and malloc elements within the malloc library
689
690
691 .. _malloc_elem:
692
693 Structure: malloc_elem
694 """"""""""""""""""""""
695
696 The malloc_elem structure is used as a generic header structure for various
697 blocks of memory.
698 It is used in two different ways - all shown in the diagram above:
699
700 #.  As a header on a block of free or allocated memory - normal case
701
702 #.  As a padding header inside a block of memory
703
704 The most important fields in the structure and how they are used are described below.
705
706 Malloc heap is a doubly-linked list, where each element keeps track of its
707 previous and next elements. Due to the fact that hugepage memory can come and
708 go, neighbouring malloc elements may not necessarily be adjacent in memory.
709 Also, since a malloc element may span multiple pages, its contents may not
710 necessarily be IOVA-contiguous either - each malloc element is only guaranteed
711 to be virtually contiguous.
712
713 .. note::
714
715     If the usage of a particular field in one of the above three usages is not
716     described, the field can be assumed to have an undefined value in that
717     situation, for example, for padding headers only the "state" and "pad"
718     fields have valid values.
719
720 *   heap - this pointer is a reference back to the heap structure from which
721     this block was allocated.
722     It is used for normal memory blocks when they are being freed, to add the
723     newly-freed block to the heap's free-list.
724
725 *   prev - this pointer points to previous header element/block in memory. When
726     freeing a block, this pointer is used to reference the previous block to
727     check if that block is also free. If so, and the two blocks are immediately
728     adjacent to each other, then the two free blocks are merged to form a single
729     larger block.
730
731 *   next - this pointer points to next header element/block in memory. When
732     freeing a block, this pointer is used to reference the next block to check
733     if that block is also free. If so, and the two blocks are immediately
734     adjacent to each other, then the two free blocks are merged to form a single
735     larger block.
736
737 *   free_list - this is a structure pointing to previous and next elements in
738     this heap's free list.
739     It is only used in normal memory blocks; on ``malloc()`` to find a suitable
740     free block to allocate and on ``free()`` to add the newly freed element to
741     the free-list.
742
743 *   state - This field can have one of three values: ``FREE``, ``BUSY`` or
744     ``PAD``.
745     The former two are to indicate the allocation state of a normal memory block
746     and the latter is to indicate that the element structure is a dummy structure
747     at the end of the start-of-block padding, i.e. where the start of the data
748     within a block is not at the start of the block itself, due to alignment
749     constraints.
750     In that case, the pad header is used to locate the actual malloc element
751     header for the block.
752
753 *   pad - this holds the length of the padding present at the start of the block.
754     In the case of a normal block header, it is added to the address of the end
755     of the header to give the address of the start of the data area, i.e. the
756     value passed back to the application on a malloc.
757     Within a dummy header inside the padding, this same value is stored, and is
758     subtracted from the address of the dummy header to yield the address of the
759     actual block header.
760
761 *   size - the size of the data block, including the header itself.
762
763 Memory Allocation
764 ^^^^^^^^^^^^^^^^^
765
766 On EAL initialization, all preallocated memory segments are setup as part of the
767 malloc heap. This setup involves placing an :ref:`element header<malloc_elem>`
768 with ``FREE`` at the start of each virtually contiguous segment of memory.
769 The ``FREE`` element is then added to the ``free_list`` for the malloc heap.
770
771 This setup also happens whenever memory is allocated at runtime (if supported),
772 in which case newly allocated pages are also added to the heap, merging with any
773 adjacent free segments if there are any.
774
775 When an application makes a call to a malloc-like function, the malloc function
776 will first index the ``lcore_config`` structure for the calling thread, and
777 determine the NUMA node of that thread.
778 The NUMA node is used to index the array of ``malloc_heap`` structures which is
779 passed as a parameter to the ``heap_alloc()`` function, along with the
780 requested size, type, alignment and boundary parameters.
781
782 The ``heap_alloc()`` function will scan the free_list of the heap, and attempt
783 to find a free block suitable for storing data of the requested size, with the
784 requested alignment and boundary constraints.
785
786 When a suitable free element has been identified, the pointer to be returned
787 to the user is calculated.
788 The cache-line of memory immediately preceding this pointer is filled with a
789 struct malloc_elem header.
790 Because of alignment and boundary constraints, there could be free space at
791 the start and/or end of the element, resulting in the following behavior:
792
793 #. Check for trailing space.
794    If the trailing space is big enough, i.e. > 128 bytes, then the free element
795    is split.
796    If it is not, then we just ignore it (wasted space).
797
798 #. Check for space at the start of the element.
799    If the space at the start is small, i.e. <=128 bytes, then a pad header is
800    used, and the remaining space is wasted.
801    If, however, the remaining space is greater, then the free element is split.
802
803 The advantage of allocating the memory from the end of the existing element is
804 that no adjustment of the free list needs to take place - the existing element
805 on the free list just has its size value adjusted, and the next/previous elements
806 have their "prev"/"next" pointers redirected to the newly created element.
807
808 In case when there is not enough memory in the heap to satisfy allocation
809 request, EAL will attempt to allocate more memory from the system (if supported)
810 and, following successful allocation, will retry reserving the memory again. In
811 a multiprocessing scenario, all primary and secondary processes will synchronize
812 their memory maps to ensure that any valid pointer to DPDK memory is guaranteed
813 to be valid at all times in all currently running processes.
814
815 Failure to synchronize memory maps in one of the processes will cause allocation
816 to fail, even though some of the processes may have allocated the memory
817 successfully. The memory is not added to the malloc heap unless primary process
818 has ensured that all other processes have mapped this memory successfully.
819
820 Any successful allocation event will trigger a callback, for which user
821 applications and other DPDK subsystems can register. Additionally, validation
822 callbacks will be triggered before allocation if the newly allocated memory will
823 exceed threshold set by the user, giving a chance to allow or deny allocation.
824
825 .. note::
826
827     Any allocation of new pages has to go through primary process. If the
828     primary process is not active, no memory will be allocated even if it was
829     theoretically possible to do so. This is because primary's process map acts
830     as an authority on what should or should not be mapped, while each secondary
831     process has its own, local memory map. Secondary processes do not update the
832     shared memory map, they only copy its contents to their local memory map.
833
834 Freeing Memory
835 ^^^^^^^^^^^^^^
836
837 To free an area of memory, the pointer to the start of the data area is passed
838 to the free function.
839 The size of the ``malloc_elem`` structure is subtracted from this pointer to get
840 the element header for the block.
841 If this header is of type ``PAD`` then the pad length is further subtracted from
842 the pointer to get the proper element header for the entire block.
843
844 From this element header, we get pointers to the heap from which the block was
845 allocated and to where it must be freed, as well as the pointer to the previous
846 and next elements. These next and previous elements are then checked to see if
847 they are also ``FREE`` and are immediately adjacent to the current one, and if
848 so, they are merged with the current element. This means that we can never have
849 two ``FREE`` memory blocks adjacent to one another, as they are always merged
850 into a single block.
851
852 If deallocating pages at runtime is supported, and the free element encloses
853 one or more pages, those pages can be deallocated and be removed from the heap.
854 If DPDK was started with command-line parameters for preallocating memory
855 (``-m`` or ``--socket-mem``), then those pages that were allocated at startup
856 will not be deallocated.
857
858 Any successful deallocation event will trigger a callback, for which user
859 applications and other DPDK subsystems can register.