xref: /dpdk/doc/guides/linux_gsg/linux_eal_parameters.rst (revision daa02b5cddbb8e11b31d41e2bf7bb1ae64dcae2f)
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. This can be
85    a sub-directory within a hugetlbfs mountpoint.
86
87*   ``--huge-unlink``
88
89    Unlink hugepage files after creating them (implies no secondary process
90    support).
91
92*   ``--match-allocations``
93
94    Free hugepages back to system exactly as they were originally allocated.
95
96Other options
97~~~~~~~~~~~~~
98
99*   ``--syslog <syslog facility>``
100
101    Set syslog facility. Valid syslog facilities are::
102
103        auth
104        cron
105        daemon
106        ftp
107        kern
108        lpr
109        mail
110        news
111        syslog
112        user
113        uucp
114        local0
115        local1
116        local2
117        local3
118        local4
119        local5
120        local6
121        local7
122