xref: /dpdk/doc/guides/linux_gsg/linux_eal_parameters.rst (revision fda34680eb9abf53872bde66e119f4c0288fd62f)
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
43*   ``--vfio-vf-token <uuid>``
44
45    Use specified VF token for devices bound to VFIO kernel driver.
46
47Multiprocessing-related options
48~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
49
50*   ``--file-prefix <prefix name>``
51
52    Use a different shared data file prefix for a DPDK process. This option
53    allows running multiple independent DPDK primary/secondary processes under
54    different prefixes.
55
56Memory-related options
57~~~~~~~~~~~~~~~~~~~~~~
58
59*   ``--legacy-mem``
60
61    Use legacy DPDK memory allocation mode.
62
63*   ``--socket-mem <amounts of memory per socket>``
64
65    Preallocate specified amounts of memory per socket. The parameter is a
66    comma-separated list of values. For example::
67
68        --socket-mem 1024,2048
69
70    This will allocate 1 gigabyte of memory on socket 0, and 2048 megabytes of
71    memory on socket 1.
72
73*   ``--socket-limit <amounts of memory per socket>``
74
75    Place a per-socket upper limit on memory use (non-legacy memory mode only).
76    0 will disable the limit for a particular socket.
77
78*   ``--single-file-segments``
79
80    Create fewer files in hugetlbfs (non-legacy mode only).
81
82*   ``--huge-dir <path to hugetlbfs directory>``
83
84    Use specified hugetlbfs directory instead of autodetected ones.
85
86*   ``--huge-unlink``
87
88    Unlink hugepage files after creating them (implies no secondary process
89    support).
90
91*   ``--match-allocations``
92
93    Free hugepages back to system exactly as they were originally allocated.
94
95Other options
96~~~~~~~~~~~~~
97
98*   ``--syslog <syslog facility>``
99
100    Set syslog facility. Valid syslog facilities are::
101
102        auth
103        cron
104        daemon
105        ftp
106        kern
107        lpr
108        mail
109        news
110        syslog
111        user
112        uucp
113        local0
114        local1
115        local2
116        local3
117        local4
118        local5
119        local6
120        local7
121