eal: sort and align options lists
[dpdk.git] / lib / librte_eal / common / eal_common_options.c
index 630dfe0..3dda237 100644 (file)
@@ -32,6 +32,7 @@
  */
 
 #include <stdlib.h>
+#include <unistd.h>
 #include <string.h>
 #include <syslog.h>
 #include <ctype.h>
 const char
 eal_short_options[] =
        "b:" /* pci-blacklist */
+       "c:" /* coremask */
+       "d:" /* driver */
+       "l:" /* corelist */
+       "m:" /* memory size */
+       "n:" /* memory channels */
+       "r:" /* memory ranks */
+       "v"  /* version */
        "w:" /* pci-whitelist */
-       "c:"
-       "d:"
-       "m:"
-       "n:"
-       "r:"
-       "v";
+       ;
 
 const struct option
 eal_long_options[] = {
-       {OPT_HUGE_DIR, 1, 0, OPT_HUGE_DIR_NUM},
-       {OPT_PROC_TYPE, 1, 0, OPT_PROC_TYPE_NUM},
-       {OPT_NO_SHCONF, 0, 0, OPT_NO_SHCONF_NUM},
-       {OPT_NO_HPET, 0, 0, OPT_NO_HPET_NUM},
-       {OPT_VMWARE_TSC_MAP, 0, 0, OPT_VMWARE_TSC_MAP_NUM},
-       {OPT_NO_PCI, 0, 0, OPT_NO_PCI_NUM},
-       {OPT_NO_HUGE, 0, 0, OPT_NO_HUGE_NUM},
-       {OPT_FILE_PREFIX, 1, 0, OPT_FILE_PREFIX_NUM},
-       {OPT_SOCKET_MEM, 1, 0, OPT_SOCKET_MEM_NUM},
-       {OPT_PCI_WHITELIST, 1, 0, OPT_PCI_WHITELIST_NUM},
-       {OPT_PCI_BLACKLIST, 1, 0, OPT_PCI_BLACKLIST_NUM},
-       {OPT_VDEV, 1, 0, OPT_VDEV_NUM},
-       {OPT_SYSLOG, 1, NULL, OPT_SYSLOG_NUM},
-       {OPT_LOG_LEVEL, 1, NULL, OPT_LOG_LEVEL_NUM},
-       {OPT_BASE_VIRTADDR, 1, 0, OPT_BASE_VIRTADDR_NUM},
-       {OPT_XEN_DOM0, 0, 0, OPT_XEN_DOM0_NUM},
-       {OPT_CREATE_UIO_DEV, 1, NULL, OPT_CREATE_UIO_DEV_NUM},
-       {OPT_VFIO_INTR, 1, NULL, OPT_VFIO_INTR_NUM},
-       {0, 0, 0, 0}
+       {OPT_BASE_VIRTADDR,     1, NULL, OPT_BASE_VIRTADDR_NUM    },
+       {OPT_CREATE_UIO_DEV,    1, NULL, OPT_CREATE_UIO_DEV_NUM   },
+       {OPT_FILE_PREFIX,       1, NULL, OPT_FILE_PREFIX_NUM      },
+       {OPT_HUGE_DIR,          1, NULL, OPT_HUGE_DIR_NUM         },
+       {OPT_LOG_LEVEL,         1, NULL, OPT_LOG_LEVEL_NUM        },
+       {OPT_MASTER_LCORE,      1, NULL, OPT_MASTER_LCORE_NUM     },
+       {OPT_NO_HPET,           0, NULL, OPT_NO_HPET_NUM          },
+       {OPT_NO_HUGE,           0, NULL, OPT_NO_HUGE_NUM          },
+       {OPT_NO_PCI,            0, NULL, OPT_NO_PCI_NUM           },
+       {OPT_NO_SHCONF,         0, NULL, OPT_NO_SHCONF_NUM        },
+       {OPT_PCI_BLACKLIST,     1, NULL, OPT_PCI_BLACKLIST_NUM    },
+       {OPT_PCI_WHITELIST,     1, NULL, OPT_PCI_WHITELIST_NUM    },
+       {OPT_PROC_TYPE,         1, NULL, OPT_PROC_TYPE_NUM        },
+       {OPT_SOCKET_MEM,        1, NULL, OPT_SOCKET_MEM_NUM       },
+       {OPT_SYSLOG,            1, NULL, OPT_SYSLOG_NUM           },
+       {OPT_VDEV,              1, NULL, OPT_VDEV_NUM             },
+       {OPT_VFIO_INTR,         1, NULL, OPT_VFIO_INTR_NUM        },
+       {OPT_VMWARE_TSC_MAP,    0, NULL, OPT_VMWARE_TSC_MAP_NUM   },
+       {OPT_XEN_DOM0,          0, NULL, OPT_XEN_DOM0_NUM         },
+       {0,                     0, NULL, 0                        }
 };
 
 static int lcores_parsed;
+static int master_lcore_parsed;
 static int mem_parsed;
 
 void
@@ -183,19 +188,21 @@ eal_parse_coremask(const char *coremask)
                                        return -1;
                                }
                                cfg->lcore_role[idx] = ROLE_RTE;
-                               if (count == 0)
-                                       cfg->master_lcore = idx;
+                               lcore_config[idx].core_index = count;
                                count++;
                        } else {
                                cfg->lcore_role[idx] = ROLE_OFF;
+                               lcore_config[idx].core_index = -1;
                        }
                }
        }
        for (; i >= 0; i--)
                if (coremask[i] != '0')
                        return -1;
-       for (; idx < RTE_MAX_LCORE; idx++)
+       for (; idx < RTE_MAX_LCORE; idx++) {
                cfg->lcore_role[idx] = ROLE_OFF;
+               lcore_config[idx].core_index = -1;
+       }
        if (count == 0)
                return -1;
        /* Update the count of enabled logical cores of the EAL configuration */
@@ -204,6 +211,88 @@ eal_parse_coremask(const char *coremask)
        return 0;
 }
 
+static int
+eal_parse_corelist(const char *corelist)
+{
+       struct rte_config *cfg = rte_eal_get_configuration();
+       int i, idx = 0;
+       unsigned count = 0;
+       char *end = NULL;
+       int min, max;
+
+       if (corelist == NULL)
+               return -1;
+
+       /* Remove all blank characters ahead and after */
+       while (isblank(*corelist))
+               corelist++;
+       i = strnlen(corelist, sysconf(_SC_ARG_MAX));
+       while ((i > 0) && isblank(corelist[i - 1]))
+               i--;
+
+       /* Reset config */
+       for (idx = 0; idx < RTE_MAX_LCORE; idx++) {
+               cfg->lcore_role[idx] = ROLE_OFF;
+               lcore_config[idx].core_index = -1;
+       }
+
+       /* Get list of cores */
+       min = RTE_MAX_LCORE;
+       do {
+               while (isblank(*corelist))
+                       corelist++;
+               if (*corelist == '\0')
+                       return -1;
+               errno = 0;
+               idx = strtoul(corelist, &end, 10);
+               if (errno || end == NULL)
+                       return -1;
+               while (isblank(*end))
+                       end++;
+               if (*end == '-') {
+                       min = idx;
+               } else if ((*end == ',') || (*end == '\0')) {
+                       max = idx;
+                       if (min == RTE_MAX_LCORE)
+                               min = idx;
+                       for (idx = min; idx <= max; idx++) {
+                               cfg->lcore_role[idx] = ROLE_RTE;
+                               lcore_config[idx].core_index = count;
+                               count++;
+                       }
+                       min = RTE_MAX_LCORE;
+               } else
+                       return -1;
+               corelist = end + 1;
+       } while (*end != '\0');
+
+       if (count == 0)
+               return -1;
+
+       /* Update the count of enabled logical cores of the EAL configuration */
+       cfg->lcore_count = count;
+
+       lcores_parsed = 1;
+       return 0;
+}
+
+/* Changes the lcore id of the master thread */
+static int
+eal_parse_master_lcore(const char *arg)
+{
+       char *parsing_end;
+       struct rte_config *cfg = rte_eal_get_configuration();
+
+       errno = 0;
+       cfg->master_lcore = (uint32_t) strtol(arg, &parsing_end, 0);
+       if (errno || parsing_end[0] != 0)
+               return -1;
+       if (cfg->master_lcore >= RTE_MAX_LCORE)
+               return -1;
+       master_lcore_parsed = 1;
+       return 0;
+}
+
 static int
 eal_parse_syslog(const char *facility, struct internal_config *conf)
 {
@@ -304,6 +393,13 @@ eal_parse_common_option(int opt, const char *optarg,
                        return -1;
                }
                break;
+       /* corelist */
+       case 'l':
+               if (eal_parse_corelist(optarg) < 0) {
+                       RTE_LOG(ERR, EAL, "invalid core list\n");
+                       return -1;
+               }
+               break;
        /* size of memory */
        case 'm':
                conf->memory = atoi(optarg);
@@ -362,6 +458,14 @@ eal_parse_common_option(int opt, const char *optarg,
                conf->process_type = eal_parse_proc_type(optarg);
                break;
 
+       case OPT_MASTER_LCORE_NUM:
+               if (eal_parse_master_lcore(optarg) < 0) {
+                       RTE_LOG(ERR, EAL, "invalid parameter for --"
+                                       OPT_MASTER_LCORE "\n");
+                       return -1;
+               }
+               break;
+
        case OPT_VDEV_NUM:
                if (rte_eal_devargs_add(RTE_DEVTYPE_VIRTUAL,
                                optarg) < 0) {
@@ -399,14 +503,39 @@ eal_parse_common_option(int opt, const char *optarg,
        return 0;
 }
 
+int
+eal_adjust_config(struct internal_config *internal_cfg)
+{
+       int i;
+       struct rte_config *cfg = rte_eal_get_configuration();
+
+       if (internal_config.process_type == RTE_PROC_AUTO)
+               internal_config.process_type = eal_proc_type_detect();
+
+       /* default master lcore is the first one */
+       if (!master_lcore_parsed)
+               cfg->master_lcore = rte_get_next_lcore(-1, 0, 0);
+
+       /* if no memory amounts were requested, this will result in 0 and
+        * will be overridden later, right after eal_hugepage_info_init() */
+       for (i = 0; i < RTE_MAX_NUMA_NODES; i++)
+               internal_cfg->memory += internal_cfg->socket_mem[i];
+
+       return 0;
+}
+
 int
 eal_check_common_options(struct internal_config *internal_cfg)
 {
        struct rte_config *cfg = rte_eal_get_configuration();
 
        if (!lcores_parsed) {
-               RTE_LOG(ERR, EAL, "CPU cores must be enabled with option "
-                       "-c\n");
+               RTE_LOG(ERR, EAL, "CPU cores must be enabled with options "
+                       "-c or -l\n");
+               return -1;
+       }
+       if (cfg->lcore_role[cfg->master_lcore] != ROLE_RTE) {
+               RTE_LOG(ERR, EAL, "Master lcore is not enabled for DPDK\n");
                return -1;
        }
 
@@ -450,33 +579,36 @@ eal_check_common_options(struct internal_config *internal_cfg)
 void
 eal_common_usage(void)
 {
-       printf("-c COREMASK -n NUM [-m NB] [-r NUM] [-b <domain:bus:devid.func>]"
-              "[--proc-type primary|secondary|auto]\n\n"
+       printf("-c COREMASK|-l CORELIST -n CHANNELS [options]\n\n"
               "EAL common options:\n"
-              "  -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"
-              "  -m MB        : memory to allocate (see also --"OPT_SOCKET_MEM")\n"
-              "  -r NUM       : force number of memory ranks (don't detect)\n"
-              "  --"OPT_SYSLOG"     : set syslog facility\n"
-              "  --"OPT_LOG_LEVEL"  : set default log level\n"
-              "  --"OPT_PROC_TYPE"  : type of this process\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"
+              "  -c COREMASK         Hexadecimal bitmask of cores to run on\n"
+              "  -l CORELIST         List of cores to run on\n"
+              "                      The argument format is <c1>[-c2][,c3[-c4],...]\n"
+              "                      where c1, c2, etc are core indexes between 0 and %d\n"
+              "  --"OPT_MASTER_LCORE" ID   Core ID that is used as master\n"
+              "  -n CHANNELS         Number of memory channels\n"
+              "  -m MB               Memory to allocate (see also --"OPT_SOCKET_MEM")\n"
+              "  -r RANKS            Force number of memory ranks (don't detect)\n"
+              "  -b, --"OPT_PCI_BLACKLIST" 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"
+              "  -w, --"OPT_PCI_WHITELIST" 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_PROC_TYPE"         Type of this process (primary|secondary|auto)\n"
+              "  --"OPT_SYSLOG"            Set syslog facility\n"
+              "  --"OPT_LOG_LEVEL"         Set default log level\n"
+              "  -v                  Display version information on startup\n"
               "\nEAL options for DEBUG use only:\n"
-              "  --"OPT_NO_HUGE"  : use malloc instead of hugetlbfs\n"
-              "  --"OPT_NO_PCI"   : disable pci\n"
-              "  --"OPT_NO_HPET"  : disable hpet\n"
-              "  --"OPT_NO_SHCONF": no shared config (mmap'd files)\n"
-              "\n");
+              "  --"OPT_NO_HUGE"           Use malloc instead of hugetlbfs\n"
+              "  --"OPT_NO_PCI"            Disable PCI\n"
+              "  --"OPT_NO_HPET"           Disable HPET\n"
+              "  --"OPT_NO_SHCONF"         No shared config (mmap'd files)\n"
+              "\n", RTE_MAX_LCORE);
 }