spelling fixes
[dpdk.git] / lib / librte_eal / linuxapp / eal / eal.c
index 1ddfb65..de182e1 100644 (file)
@@ -2,6 +2,7 @@
  *   BSD LICENSE
  * 
  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
+ *   Copyright(c) 2012-2014 6WIND S.A.
  *   All rights reserved.
  * 
  *   Redistribution and use in source and binary forms, with or without
@@ -41,6 +42,8 @@
 #include <syslog.h>
 #include <getopt.h>
 #include <sys/file.h>
+#include <fcntl.h>
+#include <dlfcn.h>
 #include <stddef.h>
 #include <errno.h>
 #include <limits.h>
@@ -48,8 +51,6 @@
 #include <sys/mman.h>
 #include <sys/queue.h>
 #include <sys/io.h>
-#include <sys/user.h>
-#include <linux/binfmts.h>
 
 #include <rte_common.h>
 #include <rte_debug.h>
@@ -68,6 +69,7 @@
 #include <rte_cpuflags.h>
 #include <rte_interrupts.h>
 #include <rte_pci.h>
+#include <rte_devargs.h>
 #include <rte_common.h>
 #include <rte_version.h>
 #include <rte_atomic.h>
 #define OPT_FILE_PREFIX "file-prefix"
 #define OPT_SOCKET_MEM  "socket-mem"
 #define OPT_USE_DEVICE  "use-device"
+#define OPT_PCI_WHITELIST "pci-whitelist"
+#define OPT_PCI_BLACKLIST "pci-blacklist"
+#define OPT_VDEV        "vdev"
 #define OPT_SYSLOG      "syslog"
 #define OPT_BASE_VIRTADDR   "base-virtaddr"
+#define OPT_XEN_DOM0    "xen-dom0"
+#define OPT_CREATE_UIO_DEV "create-uio-dev"
 
 #define RTE_EAL_BLACKLIST_SIZE 0x100
 
 
 #define BITS_PER_HEX 4
 
-#define GET_BLACKLIST_FIELD(in, fd, lim, dlm)                   \
-{                                                               \
-       unsigned long val;                                      \
-       char *end;                                              \
-       errno = 0;                                              \
-       val = strtoul((in), &end, 16);                          \
-       if (errno != 0 || end[0] != (dlm) || val > (lim))       \
-               return (-EINVAL);                               \
-       (fd) = (typeof (fd))val;                                \
-       (in) = end + 1;                                         \
-}
-
 /* Allow the application to print its usage message too if set */
 static rte_usage_hook_t        rte_application_usage_hook = NULL;
+
+TAILQ_HEAD(shared_driver_list, shared_driver);
+
+/* Definition for shared object drivers. */
+struct shared_driver {
+       TAILQ_ENTRY(shared_driver) next;
+
+       char    name[PATH_MAX];
+       void*   lib_handle;
+};
+
+/* List of external loadable drivers */
+static struct shared_driver_list solib_list =
+TAILQ_HEAD_INITIALIZER(solib_list);
+
 /* early configuration structure, when memory config is not mmapped */
 static struct rte_mem_config early_mem_config;
 
@@ -136,8 +146,6 @@ static struct rte_config rte_config = {
                .mem_config = &early_mem_config,
 };
 
-static struct rte_pci_addr eal_dev_blacklist[RTE_EAL_BLACKLIST_SIZE];
-
 /* internal configuration (per-core) */
 struct lcore_config lcore_config[RTE_MAX_LCORE];
 
@@ -281,8 +289,6 @@ eal_proc_type_detect(void)
 static void
 rte_config_init(void)
 {
-       /* set the magic in configuration structure */
-       rte_config.magic = RTE_MAGIC;
        rte_config.process_type = (internal_config.process_type == RTE_PROC_AUTO) ?
                        eal_proc_type_detect() : /* for auto, detect the type */
                        internal_config.process_type; /* otherwise use what's already set */
@@ -330,23 +336,32 @@ eal_usage(const char *prgname)
               "  -c COREMASK  : A hexadecimal bitmask of cores to run on\n"
               "  -n NUM       : Number of memory channels\n"
                   "  -v           : Display version information on startup\n"
-              "  -b <domain:bus:devid.func>: to prevent EAL from using specified "
-           "PCI device\n"
-              "                 (multiple -b options are allowed)\n"
+              "  -d LIB.so    : add driver (can be used multiple times)\n"
               "  -m MB        : memory to allocate (see also --"OPT_SOCKET_MEM")\n"
               "  -r NUM       : force number of memory ranks (don't detect)\n"
+              "  --"OPT_XEN_DOM0" : support application running on Xen Domain0 "
+                          "without hugetlbfs\n"
               "  --"OPT_SYSLOG"     : set syslog facility\n"
               "  --"OPT_SOCKET_MEM" : memory to allocate on specific \n"
                   "                 sockets (use comma separated values)\n"
               "  --"OPT_HUGE_DIR"   : directory where hugetlbfs is mounted\n"
               "  --"OPT_PROC_TYPE"  : type of this process\n"
               "  --"OPT_FILE_PREFIX": prefix for hugepage filenames\n"
-              "  --"OPT_USE_DEVICE": use the specified ethernet device(s) only. "
-                          "Use comma-separate <[domain:]bus:devid.func> values.\n"
-              "               [NOTE: Cannot be used with -b option]\n"
+              "  --"OPT_PCI_BLACKLIST", -b: add a PCI device in black list.\n"
+              "               Prevent EAL from using this PCI device. The argument\n"
+              "               format is <domain:bus:devid.func>.\n"
+              "  --"OPT_PCI_WHITELIST", -w: add a PCI device in white list.\n"
+              "               Only use the specified PCI devices. The argument format\n"
+              "               is <[domain:]bus:devid.func>. This option can be present\n"
+              "               several times (once per device).\n"
+              "               [NOTE: PCI whitelist cannot be used with -b option]\n"
+              "  --"OPT_VDEV": add a virtual device.\n"
+              "               The argument format is <driver><id>[,key=val,...]\n"
+              "               (ex: --vdev=eth_pcap0,iface=eth2).\n"
               "  --"OPT_VMWARE_TSC_MAP": use VMware TSC map instead of "
                           "native RDTSC\n"
               "  --"OPT_BASE_VIRTADDR": specify base virtual address\n"
+              "  --"OPT_CREATE_UIO_DEV": create /dev/uioX (usually done by hotplug)\n"
               "\nEAL options for DEBUG use only:\n"
               "  --"OPT_NO_HUGE"  : use malloc instead of hugetlbfs\n"
               "  --"OPT_NO_PCI"   : disable pci\n"
@@ -409,7 +424,7 @@ eal_parse_coremask(const char *coremask)
        if (coremask[0] == '0' && ((coremask[1] == 'x')
                ||  (coremask[1] == 'X')) )
                coremask += 2;
-       i = strnlen(coremask, MAX_ARG_STRLEN);
+       i = strnlen(coremask, PATH_MAX);
        while ((i > 0) && isblank(coremask[i - 1]))
                i--;
        if (i == 0)
@@ -424,6 +439,11 @@ eal_parse_coremask(const char *coremask)
                val = xdigit2val(c);
                for(j = 0; j < BITS_PER_HEX && idx < RTE_MAX_LCORE; j++, idx++) {
                        if((1 << j) & val) {
+                               if (!lcore_config[idx].detected) {
+                                       RTE_LOG(ERR, EAL, "lcore %u "
+                                               "unavailable\n", idx);
+                                       return -1;
+                               }
                                cfg->lcore_role[idx] = ROLE_RTE;
                                if(count == 0)
                                        cfg->master_lcore = idx;
@@ -440,6 +460,8 @@ eal_parse_coremask(const char *coremask)
                cfg->lcore_role[idx] = ROLE_OFF;
        if(count == 0)
                return -1;
+       /* Update the count of enabled logical cores of the EAL configuration */
+       cfg->lcore_count = count;
        return 0;
 }
 
@@ -551,9 +573,9 @@ eal_parse_base_virtaddr(const char *arg)
 #endif
 
        /* align the addr on 2M boundary */
-       addr = RTE_PTR_ALIGN_CEIL(addr, RTE_PGSIZE_2M);
+       internal_config.base_virtaddr = RTE_PTR_ALIGN_CEIL((uintptr_t)addr,
+                                                          RTE_PGSIZE_2M);
 
-       internal_config.base_virtaddr = (uintptr_t) addr;
        return 0;
 }
 
@@ -588,22 +610,6 @@ eal_parse_proc_type(const char *arg)
        return RTE_PROC_INVALID;
 }
 
-static ssize_t
-eal_parse_blacklist_opt(const char *optarg, size_t idx)
-{
-       if (idx >= sizeof (eal_dev_blacklist) / sizeof (eal_dev_blacklist[0])) {
-               RTE_LOG(ERR, EAL, "%s - too many devices to blacklist...\n", optarg);
-               return (-EINVAL);
-       } else if (eal_parse_pci_DomBDF(optarg, eal_dev_blacklist + idx) < 0 &&
-                       eal_parse_pci_BDF(optarg, eal_dev_blacklist + idx) < 0) {
-               RTE_LOG(ERR, EAL, "%s - invalid device to blacklist...\n", optarg);
-               return (-EINVAL);
-       }
-
-       idx += 1;
-       return (idx);
-}
-
 /* Parse the argument given in the command line of the application */
 static int
 eal_parse_args(int argc, char **argv)
@@ -612,7 +618,6 @@ eal_parse_args(int argc, char **argv)
        char **argvopt;
        int option_index;
        int coremask_ok = 0;
-       ssize_t blacklist_index = 0;
        char *prgname = argv[0];
        static struct option lgopts[] = {
                {OPT_NO_HUGE, 0, 0, 0},
@@ -624,11 +629,16 @@ eal_parse_args(int argc, char **argv)
                {OPT_PROC_TYPE, 1, 0, 0},
                {OPT_FILE_PREFIX, 1, 0, 0},
                {OPT_SOCKET_MEM, 1, 0, 0},
-               {OPT_USE_DEVICE, 1, 0, 0},
+               {OPT_PCI_WHITELIST, 1, 0, 0},
+               {OPT_PCI_BLACKLIST, 1, 0, 0},
+               {OPT_VDEV, 1, 0, 0},
                {OPT_SYSLOG, 1, NULL, 0},
                {OPT_BASE_VIRTADDR, 1, 0, 0},
+               {OPT_XEN_DOM0, 0, 0, 0},
+               {OPT_CREATE_UIO_DEV, 1, NULL, 0},
                {0, 0, 0, 0}
        };
+       struct shared_driver *solib;
 
        argvopt = argv;
 
@@ -639,6 +649,7 @@ eal_parse_args(int argc, char **argv)
        internal_config.hugepage_dir = NULL;
        internal_config.force_sockets = 0;
        internal_config.syslog_facility = LOG_DAEMON;
+       internal_config.xen_dom0_support = 0;
 #ifdef RTE_LIBEAL_USE_HPET
        internal_config.no_hpet = 0;
 #else
@@ -655,18 +666,26 @@ eal_parse_args(int argc, char **argv)
        internal_config.vmware_tsc_map = 0;
        internal_config.base_virtaddr = 0;
 
-       while ((opt = getopt_long(argc, argvopt, "b:c:m:n:r:v",
+       while ((opt = getopt_long(argc, argvopt, "b:w:c:d:m:n:r:v",
                                  lgopts, &option_index)) != EOF) {
 
                switch (opt) {
                /* blacklist */
                case 'b':
-                       if ((blacklist_index = eal_parse_blacklist_opt(optarg,
-                           blacklist_index)) < 0) {
+                       if (rte_eal_devargs_add(RTE_DEVTYPE_BLACKLISTED_PCI,
+                                       optarg) < 0) {
                                eal_usage(prgname);
                                return (-1);
                        }
                        break;
+               /* whitelist */
+               case 'w':
+                       if (rte_eal_devargs_add(RTE_DEVTYPE_WHITELISTED_PCI,
+                                       optarg) < 0) {
+                               eal_usage(prgname);
+                               return -1;
+                       }
+                       break;
                /* coremask */
                case 'c':
                        if (eal_parse_coremask(optarg) < 0) {
@@ -676,6 +695,18 @@ eal_parse_args(int argc, char **argv)
                        }
                        coremask_ok = 1;
                        break;
+               /* force loading of external driver */
+               case 'd':
+                       solib = malloc(sizeof(*solib));
+                       if (solib == NULL) {
+                               RTE_LOG(ERR, EAL, "malloc(solib) failed\n");
+                               return -1;
+                       }
+                       memset(solib, 0, sizeof(*solib));
+                       strncpy(solib->name, optarg, PATH_MAX-1);
+                       solib->name[PATH_MAX-1] = 0;
+                       TAILQ_INSERT_TAIL(&solib_list, solib, next);
+                       break;
                /* size of memory */
                case 'm':
                        internal_config.memory = atoi(optarg);
@@ -714,6 +745,16 @@ eal_parse_args(int argc, char **argv)
                        if (!strcmp(lgopts[option_index].name, OPT_NO_HUGE)) {
                                internal_config.no_hugetlbfs = 1;
                        }
+                       if (!strcmp(lgopts[option_index].name, OPT_XEN_DOM0)) {
+               #ifdef RTE_LIBRTE_XEN_DOM0
+                               internal_config.xen_dom0_support = 1;
+               #else
+                               RTE_LOG(ERR, EAL, "Can't support DPDK app "
+                                       "running on Dom0, please configure"
+                                       " RTE_LIBRTE_XEN_DOM0=y\n");
+                               return -1;
+               #endif 
+                       }
                        else if (!strcmp(lgopts[option_index].name, OPT_NO_PCI)) {
                                internal_config.no_pci = 1;
                        }
@@ -744,7 +785,31 @@ eal_parse_args(int argc, char **argv)
                                }
                        }
                        else if (!strcmp(lgopts[option_index].name, OPT_USE_DEVICE)) {
-                               eal_dev_whitelist_add_entry(optarg);
+                               printf("The --use-device option is deprecated, please use\n"
+                                       "--whitelist or --vdev instead.\n");
+                               eal_usage(prgname);
+                               return -1;
+                       }
+                       else if (!strcmp(lgopts[option_index].name, OPT_PCI_BLACKLIST)) {
+                               if (rte_eal_devargs_add(RTE_DEVTYPE_BLACKLISTED_PCI,
+                                               optarg) < 0) {
+                                       eal_usage(prgname);
+                                       return -1;
+                               }
+                       }
+                       else if (!strcmp(lgopts[option_index].name, OPT_PCI_WHITELIST)) {
+                               if (rte_eal_devargs_add(RTE_DEVTYPE_WHITELISTED_PCI,
+                                               optarg) < 0) {
+                                       eal_usage(prgname);
+                                       return -1;
+                               }
+                       }
+                       else if (!strcmp(lgopts[option_index].name, OPT_VDEV)) {
+                               if (rte_eal_devargs_add(RTE_DEVTYPE_VIRTUAL,
+                                               optarg) < 0) {
+                                       eal_usage(prgname);
+                                       return -1;
+                               }
                        }
                        else if (!strcmp(lgopts[option_index].name, OPT_SYSLOG)) {
                                if (eal_parse_syslog(optarg) < 0) {
@@ -762,6 +827,9 @@ eal_parse_args(int argc, char **argv)
                                        return -1;
                                }
                        }
+                       else if (!strcmp(lgopts[option_index].name, OPT_CREATE_UIO_DEV)) {
+                               internal_config.create_uio_dev = 1;
+                       }
                        break;
 
                default:
@@ -810,21 +878,20 @@ eal_parse_args(int argc, char **argv)
                eal_usage(prgname);
                return -1;
        }
+       /* --xen-dom0 doesn't make sense with --socket-mem */
+       if (internal_config.xen_dom0_support && internal_config.force_sockets == 1) {
+               RTE_LOG(ERR, EAL, "Options --socket-mem cannot be specified "
+                                       "together with --xen_dom0!\n");
+               eal_usage(prgname);
+               return -1;
+       }
 
-       /* if no blacklist, parse a whitelist */
-       if (blacklist_index > 0) {
-               if (eal_dev_whitelist_exists()) {
-                       RTE_LOG(ERR, EAL, "Error: blacklist [-b] and whitelist "
-                                       "[--use-device] options cannot be used at the same time\n");
-                       eal_usage(prgname);
-                       return -1;
-               }
-               rte_eal_pci_set_blacklist(eal_dev_blacklist, blacklist_index);
-       } else {
-               if (eal_dev_whitelist_exists() && eal_dev_whitelist_parse() < 0) {
-                       RTE_LOG(ERR,EAL, "Error parsing whitelist[--use-device] options\n");
-                       return -1;
-               }
+       if (rte_eal_devargs_type_count(RTE_DEVTYPE_WHITELISTED_PCI) != 0 &&
+               rte_eal_devargs_type_count(RTE_DEVTYPE_BLACKLISTED_PCI) != 0) {
+               RTE_LOG(ERR, EAL, "Error: blacklist [-b] and whitelist "
+                       "[-w] options cannot be used at the same time\n");
+               eal_usage(prgname);
+               return -1;
        }
 
        if (optind >= 0)
@@ -874,7 +941,7 @@ rte_eal_mcfg_complete(void)
 }
 
 /*
- * Request iopl priviledge for all RPL, returns 0 on success
+ * Request iopl privilege for all RPL, returns 0 on success
  */
 static int
 rte_eal_iopl_init(void)
@@ -889,21 +956,30 @@ rte_eal_init(int argc, char **argv)
        int i, fctret, ret;
        pthread_t thread_id;
        static rte_atomic32_t run_once = RTE_ATOMIC32_INIT(0);
+       struct shared_driver *solib = NULL;
+       const char *logid;
 
        if (!rte_atomic32_test_and_set(&run_once))
                return -1;
 
+       logid = strrchr(argv[0], '/');
+       logid = strdup(logid ? logid + 1: argv[0]);
+
        thread_id = pthread_self();
 
        if (rte_eal_log_early_init() < 0)
                rte_panic("Cannot init early logs\n");
 
+       if (rte_eal_cpu_init() < 0)
+               rte_panic("Cannot detect lcores\n");
+
        fctret = eal_parse_args(argc, argv);
        if (fctret < 0)
                exit(1);
 
        if (internal_config.no_hugetlbfs == 0 &&
                        internal_config.process_type != RTE_PROC_SECONDARY &&
+                       internal_config.xen_dom0_support == 0 &&
                        eal_hugepage_info_init() < 0)
                rte_panic("Cannot get hugepage information\n");
 
@@ -932,9 +1008,6 @@ rte_eal_init(int argc, char **argv)
        if (rte_eal_iopl_init() == 0)
                rte_config.flags |= EAL_FLG_HIGH_IOPL;
        
-       if (rte_eal_cpu_init() < 0)
-               rte_panic("Cannot detect lcores\n");
-
        if (rte_eal_pci_init() < 0)
                rte_panic("Cannot init PCI\n");
 
@@ -960,7 +1033,7 @@ rte_eal_init(int argc, char **argv)
                rte_panic("Cannot init IVSHMEM objects\n");
 #endif
 
-       if (rte_eal_log_init(argv[0], internal_config.syslog_facility) < 0)
+       if (rte_eal_log_init(logid, internal_config.syslog_facility) < 0)
                rte_panic("Cannot init logs\n");
 
        if (rte_eal_alarm_init() < 0)
@@ -972,15 +1045,24 @@ rte_eal_init(int argc, char **argv)
        if (rte_eal_timer_init() < 0)
                rte_panic("Cannot init HPET or TSC timers\n");
 
-       RTE_LOG(DEBUG, EAL, "Master core %u is ready (tid=%x)\n",
-               rte_config.master_lcore, (int)thread_id);
-
        eal_check_mem_on_local_socket();
 
        rte_eal_mcfg_complete();
 
-       if (rte_eal_non_pci_ethdev_init() < 0)
-               rte_panic("Cannot init non-PCI eth_devs\n");
+       TAILQ_FOREACH(solib, &solib_list, next) {
+               RTE_LOG(INFO, EAL, "open shared lib %s\n", solib->name);
+               solib->lib_handle = dlopen(solib->name, RTLD_NOW);
+               if (solib->lib_handle == NULL)
+                       RTE_LOG(WARNING, EAL, "%s\n", dlerror());
+       }
+
+       eal_thread_init_master(rte_config.master_lcore);
+
+       RTE_LOG(DEBUG, EAL, "Master core %u is ready (tid=%x)\n",
+               rte_config.master_lcore, (int)thread_id);
+
+       if (rte_eal_vdev_init() < 0)
+               rte_panic("Cannot init virtual devices\n");
 
        RTE_LCORE_FOREACH_SLAVE(i) {
 
@@ -1002,8 +1084,6 @@ rte_eal_init(int argc, char **argv)
                        rte_panic("Cannot create thread\n");
        }
 
-       eal_thread_init_master(rte_config.master_lcore);
-
        /*
         * Launch a dummy function on all slave lcores, so that master lcore
         * knows they are all ready when this function returns.
@@ -1027,3 +1107,7 @@ rte_eal_process_type(void)
        return (rte_config.process_type);
 }
 
+int rte_eal_has_hugepages(void)
+{
+       return ! internal_config.no_hugetlbfs;
+}