lib/librte_eal/common/eal_options.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2014 6WIND S.A.
   5  *
   6  *   Redistribution and use in source and binary forms, with or without
   7  *   modification, are permitted provided that the following conditions
   8  *   are met:
   9  *
  10  *     * Redistributions of source code must retain the above copyright
  11  *       notice, this list of conditions and the following disclaimer.
  12  *     * Redistributions in binary form must reproduce the above copyright
  13  *       notice, this list of conditions and the following disclaimer in
  14  *       the documentation and/or other materials provided with the
  15  *       distribution.
  16  *     * Neither the name of Intel Corporation nor the names of its
  17  *       contributors may be used to endorse or promote products derived
  18  *       from this software without specific prior written permission.
  19  *
  20  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  24  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 #ifndef EAL_OPTIONS_H
  34 #define EAL_OPTIONS_H
  35
  36 enum {
  37         /* long options mapped to a short option */
  38 #define OPT_HELP              "help"
  39         OPT_HELP_NUM            = 'h',
  40 #define OPT_PCI_BLACKLIST     "pci-blacklist"
  41         OPT_PCI_BLACKLIST_NUM   = 'b',
  42 #define OPT_PCI_WHITELIST     "pci-whitelist"
  43         OPT_PCI_WHITELIST_NUM   = 'w',
  44
  45         /* first long only option value must be >= 256, so that we won't
  46          * conflict with short options */
  47         OPT_LONG_MIN_NUM = 256,
  48 #define OPT_BASE_VIRTADDR     "base-virtaddr"
  49         OPT_BASE_VIRTADDR_NUM,
  50 #define OPT_CREATE_UIO_DEV    "create-uio-dev"
  51         OPT_CREATE_UIO_DEV_NUM,
  52 #define OPT_FILE_PREFIX       "file-prefix"
  53         OPT_FILE_PREFIX_NUM,
  54 #define OPT_HUGE_DIR          "huge-dir"
  55         OPT_HUGE_DIR_NUM,
  56 #define OPT_HUGE_UNLINK       "huge-unlink"
  57         OPT_HUGE_UNLINK_NUM,
  58 #define OPT_LCORES            "lcores"
  59         OPT_LCORES_NUM,
  60 #define OPT_LOG_LEVEL         "log-level"
  61         OPT_LOG_LEVEL_NUM,
  62 #define OPT_MASTER_LCORE      "master-lcore"
  63         OPT_MASTER_LCORE_NUM,
  64 #define OPT_MBUF_POOL_OPS_NAME "mbuf-pool-ops-name"
  65         OPT_MBUF_POOL_OPS_NAME_NUM,
  66 #define OPT_PROC_TYPE         "proc-type"
  67         OPT_PROC_TYPE_NUM,
  68 #define OPT_NO_HPET           "no-hpet"
  69         OPT_NO_HPET_NUM,
  70 #define OPT_NO_HUGE           "no-huge"
  71         OPT_NO_HUGE_NUM,
  72 #define OPT_NO_PCI            "no-pci"
  73         OPT_NO_PCI_NUM,
  74 #define OPT_NO_SHCONF         "no-shconf"
  75         OPT_NO_SHCONF_NUM,
  76 #define OPT_SOCKET_MEM        "socket-mem"
  77         OPT_SOCKET_MEM_NUM,
  78 #define OPT_SYSLOG            "syslog"
  79         OPT_SYSLOG_NUM,
  80 #define OPT_VDEV              "vdev"
  81         OPT_VDEV_NUM,
  82 #define OPT_VFIO_INTR         "vfio-intr"
  83         OPT_VFIO_INTR_NUM,
  84 #define OPT_VMWARE_TSC_MAP    "vmware-tsc-map"
  85         OPT_VMWARE_TSC_MAP_NUM,
  86         OPT_LONG_MAX_NUM
  87 };
  88
  89 extern const char eal_short_options[];
  90 extern const struct option eal_long_options[];
  91
  92 int eal_parse_common_option(int opt, const char *argv,
  93                             struct internal_config *conf);
  94 int eal_option_device_parse(void);
  95 int eal_adjust_config(struct internal_config *internal_cfg);
  96 int eal_check_common_options(struct internal_config *internal_cfg);
  97 void eal_common_usage(void);
  98 enum rte_proc_type_t eal_proc_type_detect(void);
  99 int eal_plugins_init(void);
 100
 101 #endif /* EAL_OPTIONS_H */