xref: /dpdk/doc/guides/linux_gsg/linux_eal_parameters.rst (revision 43d162bc168e5c66346acf9f464495a088a5a9f0)
1..  SPDX-License-Identifier: BSD-3-Clause
2    Copyright(c) 2018 Intel Corporation.
3
4EAL parameters
5==============
6
7This document contains a list of all EAL parameters. These parameters can be
8used by any DPDK application running on Linux.
9
10Common EAL parameters
11---------------------
12
13The following EAL parameters are common to all platforms supported by DPDK.
14
15.. include:: eal_args.include.rst
16
17Linux-specific EAL parameters
18-----------------------------
19
20In addition to common EAL parameters, there are also Linux-specific EAL
21parameters.
22
23Device-related options
24~~~~~~~~~~~~~~~~~~~~~~
25
26*   ``--create-uio-dev``
27
28    Create ``/dev/uioX`` files for devices bound to igb_uio kernel driver
29    (usually done by the igb_uio driver itself).
30
31*   ``--vmware-tsc-map``
32
33    Use VMware TSC map instead of native RDTSC.
34
35*   ``--no-hpet``
36
37    Do not use the HPET timer.
38
39*   ``--vfio-intr <legacy|msi|msix>``
40
41    Use specified interrupt mode for devices bound to VFIO kernel driver.
42
43Multiprocessing-related options
44~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
45
46*   ``--file-prefix <prefix name>``
47
48    Use a different shared data file prefix for a DPDK process. This option
49    allows running multiple independent DPDK primary/secondary processes under
50    different prefixes.
51
52*   ``--base-virtaddr <address>``
53
54    Attempt to use a different starting address for all memory maps of the
55    primary DPDK process. This can be helpful if secondary processes cannot
56    start due to conflicts in address map.
57
58Memory-related options
59~~~~~~~~~~~~~~~~~~~~~~
60
61*   ``--legacy-mem``
62
63    Use legacy DPDK memory allocation mode.
64
65*   ``--socket-mem <amounts of memory per socket>``
66
67    Preallocate specified amounts of memory per socket. The parameter is a
68    comma-separated list of values. For example::
69
70        --socket-mem 1024,2048
71
72    This will allocate 1 gigabyte of memory on socket 0, and 2048 megabytes of
73    memory on socket 1.
74
75*   ``--socket-limit <amounts of memory per socket>``
76
77    Place a per-socket upper limit on memory use (non-legacy memory mode only).
78    0 will disable the limit for a particular socket.
79
80*   ``--single-file-segments``
81
82    Create fewer files in hugetlbfs (non-legacy mode only).
83
84*   ``--huge-dir <path to hugetlbfs directory>``
85
86    Use specified hugetlbfs directory instead of autodetected ones.
87
88*   ``--huge-unlink``
89
90    Unlink hugepage files after creating them (implies no secondary process
91    support).
92
93Other options
94~~~~~~~~~~~~~
95
96*   ``--syslog <syslog facility>``
97
98    Set syslog facility. Valid syslog facilities are::
99
100        auth
101        cron
102        daemon
103        ftp
104        kern
105        lpr
106        mail
107        news
108        syslog
109        user
110        uucp
111        local0
112        local1
113        local2
114        local3
115        local4
116        local5
117        local6
118        local7
119