doc/guides/linux_gsg/linux_eal_parameters.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2018 Intel Corporation.
   3
   4 EAL parameters
   5 ==============
   6
   7 This document contains a list of all EAL parameters. These parameters can be
   8 used by any DPDK application running on Linux.
   9
  10 Common EAL parameters
  11 ---------------------
  12
  13 The following EAL parameters are common to all platforms supported by DPDK.
  14
  15 .. include:: eal_args.include.rst
  16
  17 Linux-specific EAL parameters
  18 -----------------------------
  19
  20 In addition to common EAL parameters, there are also Linux-specific EAL
  21 parameters.
  22
  23 Device-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 Multiprocessing-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
  58 Memory-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
  93 *   ``--match-allocations``
  94
  95     Free hugepages back to system exactly as they were originally allocated.
  96
  97 Other options
  98 ~~~~~~~~~~~~~
  99
 100 *   ``--syslog <syslog facility>``
 101
 102     Set syslog facility. Valid syslog facilities are::
 103
 104         auth
 105         cron
 106         daemon
 107         ftp
 108         kern
 109         lpr
 110         mail
 111         news
 112         syslog
 113         user
 114         uucp
 115         local0
 116         local1
 117         local2
 118         local3
 119         local4
 120         local5
 121         local6
 122         local7