doc/guides/linux_gsg/eal_args.include.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2018 Intel Corporation.
   3
   4 Lcore-related options
   5 ~~~~~~~~~~~~~~~~~~~~~
   6
   7 *   ``-c <core mask>``
   8
   9     Set the hexadecimal bitmask of the cores to run on.
  10
  11 *   ``-l <core list>``
  12
  13     List of cores to run on
  14
  15     The argument format is ``<c1>[-c2][,c3[-c4],...]``
  16     where ``c1``, ``c2``, etc are core indexes between 0 and 128.
  17
  18 *   ``--lcores <core map>``
  19
  20     Map lcore set to physical cpu set
  21
  22     The argument format is::
  23
  24        <lcores[@cpus]>[<,lcores[@cpus]>...]
  25
  26     Lcore and CPU lists are grouped by ``(`` and ``)`` Within the group.
  27     The ``-`` character is used as a range separator and ``,`` is used as a
  28     single number separator.
  29     The grouping ``()`` can be omitted for single element group.
  30     The ``@`` can be omitted if cpus and lcores have the same value.
  31
  32 .. Note::
  33     At a given instance only one core option ``--lcores``, ``-l`` or ``-c`` can
  34     be used.
  35
  36 *   ``--master-lcore <core ID>``
  37
  38     Core ID that is used as master.
  39
  40 *   ``-s <service core mask>``
  41
  42     Hexadecimal bitmask of cores to be used as service cores.
  43
  44 Device-related options
  45 ~~~~~~~~~~~~~~~~~~~~~~
  46
  47 *   ``-b, --pci-blacklist <[domain:]bus:devid.func>``
  48
  49     Blacklist a PCI device to prevent EAL from using it. Multiple -b options are
  50     allowed.
  51
  52 .. Note::
  53     PCI blacklist cannot be used with ``-w`` option.
  54
  55 *   ``-w, --pci-whitelist <[domain:]bus:devid.func>``
  56
  57     Add a PCI device in white list.
  58
  59 .. Note::
  60     PCI whitelist cannot be used with ``-b`` option.
  61
  62 *   ``--vdev <device arguments>``
  63
  64     Add a virtual device using the format::
  65
  66        <driver><id>[,key=val, ...]
  67
  68     For example::
  69
  70        --vdev 'net_pcap0,rx_pcap=input.pcap,tx_pcap=output.pcap'
  71
  72 *   ``-d <path to shared object or directory>``
  73
  74     Load external drivers. An argument can be a single shared object file, or a
  75     directory containing multiple driver shared objects. Multiple -d options are
  76     allowed.
  77
  78 *   ``--no-pci``
  79
  80     Disable PCI bus.
  81
  82 Multiprocessing-related options
  83 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  84
  85 *   ``--proc-type <primary|secondary|auto>``
  86
  87     Set the type of the current process.
  88
  89 Memory-related options
  90 ~~~~~~~~~~~~~~~~~~~~~~
  91
  92 *   ``-n <number of channels>``
  93
  94     Set the number of memory channels to use.
  95
  96 *   ``-r <number of ranks>``
  97
  98     Set the number of memory ranks (auto-detected by default).
  99
 100 *   ``-m <megabytes>``
 101
 102     Amount of memory to preallocate at startup.
 103
 104 *   ``--in-memory``
 105
 106     Do not create any shared data structures and run entirely in memory. Implies
 107     ``--no-shconf`` and (if applicable) ``--huge-unlink``.
 108
 109 *   ``--iova-mode <pa|va>``
 110
 111     Force IOVA mode to a specific value.
 112
 113 Debugging options
 114 ~~~~~~~~~~~~~~~~~
 115
 116 *   ``--no-shconf``
 117
 118     No shared files created (implies no secondary process support).
 119
 120 *   ``--no-huge``
 121
 122     Use anonymous memory instead of hugepages (implies no secondary process
 123     support).
 124
 125 *   ``--log-level <type:val>``
 126
 127     Specify log level for a specific component. For example::
 128
 129         --log-level eal:8
 130
 131     Can be specified multiple times.
 132
 133 Other options
 134 ~~~~~~~~~~~~~
 135
 136 *   ``-h``, ``--help``
 137
 138     Display help message listing all EAL parameters.
 139
 140 *   ``-v``
 141
 142     Display the version information on startup.
 143
 144 *   ``mbuf-pool-ops-name``:
 145
 146     Pool ops name for mbuf to use.