eal: add option usage string
[dpdk.git] / lib / librte_eal / common / eal_common_options.c
index df5d536..3796dbf 100644 (file)
@@ -58,6 +58,7 @@ eal_long_options[] = {
        {OPT_HELP,              0, NULL, OPT_HELP_NUM             },
        {OPT_HUGE_DIR,          1, NULL, OPT_HUGE_DIR_NUM         },
        {OPT_HUGE_UNLINK,       0, NULL, OPT_HUGE_UNLINK_NUM      },
+       {OPT_IOVA_MODE,         1, NULL, OPT_IOVA_MODE_NUM        },
        {OPT_LCORES,            1, NULL, OPT_LCORES_NUM           },
        {OPT_LOG_LEVEL,         1, NULL, OPT_LOG_LEVEL_NUM        },
        {OPT_MASTER_LCORE,      1, NULL, OPT_MASTER_LCORE_NUM     },
@@ -66,6 +67,7 @@ eal_long_options[] = {
        {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_IN_MEMORY,         0, NULL, OPT_IN_MEMORY_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        },
@@ -77,6 +79,7 @@ eal_long_options[] = {
        {OPT_VMWARE_TSC_MAP,    0, NULL, OPT_VMWARE_TSC_MAP_NUM   },
        {OPT_LEGACY_MEM,        0, NULL, OPT_LEGACY_MEM_NUM       },
        {OPT_SINGLE_FILE_SEGMENTS, 0, NULL, OPT_SINGLE_FILE_SEGMENTS_NUM},
+       {OPT_MATCH_ALLOCATIONS, 0, NULL, OPT_MATCH_ALLOCATIONS_NUM},
        {0,                     0, NULL, 0                        }
 };
 
@@ -166,6 +169,14 @@ eal_option_device_parse(void)
        return ret;
 }
 
+const char *
+eal_get_hugefile_prefix(void)
+{
+       if (internal_config.hugefile_prefix != NULL)
+               return internal_config.hugefile_prefix;
+       return HUGEFILE_PREFIX_DEFAULT;
+}
+
 void
 eal_reset_internal_config(struct internal_config *internal_cfg)
 {
@@ -174,7 +185,7 @@ eal_reset_internal_config(struct internal_config *internal_cfg)
        internal_cfg->memory = 0;
        internal_cfg->force_nrank = 0;
        internal_cfg->force_nchannel = 0;
-       internal_cfg->hugefile_prefix = HUGEFILE_PREFIX_DEFAULT;
+       internal_cfg->hugefile_prefix = NULL;
        internal_cfg->hugepage_dir = NULL;
        internal_cfg->force_sockets = 0;
        /* zero out the NUMA config */
@@ -204,6 +215,7 @@ eal_reset_internal_config(struct internal_config *internal_cfg)
 #endif
        internal_cfg->vmware_tsc_map = 0;
        internal_cfg->create_uio_dev = 0;
+       internal_cfg->iova_mode = RTE_IOVA_DC;
        internal_cfg->user_mbuf_pool_ops_name = NULL;
        internal_cfg->init_complete = 0;
 }
@@ -219,7 +231,7 @@ eal_plugin_add(const char *path)
                return -1;
        }
        memset(solib, 0, sizeof(*solib));
-       strncpy(solib->name, path, PATH_MAX-1);
+       strlcpy(solib->name, path, PATH_MAX-1);
        solib->name[PATH_MAX-1] = 0;
        TAILQ_INSERT_TAIL(&solib_list, solib, next);
 
@@ -320,6 +332,7 @@ eal_parse_service_coremask(const char *coremask)
        unsigned int count = 0;
        char c;
        int val;
+       uint32_t taken_lcore_count = 0;
 
        if (coremask == NULL)
                return -1;
@@ -353,7 +366,7 @@ eal_parse_service_coremask(const char *coremask)
                                if (master_lcore_parsed &&
                                                cfg->master_lcore == lcore) {
                                        RTE_LOG(ERR, EAL,
-                                               "Error: lcore %u is master lcore, cannot use as service core\n",
+                                               "lcore %u is master lcore, cannot use as service core\n",
                                                idx);
                                        return -1;
                                }
@@ -363,6 +376,10 @@ eal_parse_service_coremask(const char *coremask)
                                                "lcore %u unavailable\n", idx);
                                        return -1;
                                }
+
+                               if (cfg->lcore_role[idx] == ROLE_RTE)
+                                       taken_lcore_count++;
+
                                lcore_config[idx].core_role = ROLE_SERVICE;
                                count++;
                        }
@@ -379,10 +396,27 @@ eal_parse_service_coremask(const char *coremask)
        if (count == 0)
                return -1;
 
+       if (core_parsed && taken_lcore_count != count) {
+               RTE_LOG(WARNING, EAL,
+                       "Not all service cores are in the coremask. "
+                       "Please ensure -c or -l includes service cores\n");
+       }
+
        cfg->service_lcore_count = count;
        return 0;
 }
 
+static int
+eal_service_cores_parsed(void)
+{
+       int idx;
+       for (idx = 0; idx < RTE_MAX_LCORE; idx++) {
+               if (lcore_config[idx].core_role == ROLE_SERVICE)
+                       return 1;
+       }
+       return 0;
+}
+
 static int
 eal_parse_coremask(const char *coremask)
 {
@@ -392,6 +426,11 @@ eal_parse_coremask(const char *coremask)
        char c;
        int val;
 
+       if (eal_service_cores_parsed())
+               RTE_LOG(WARNING, EAL,
+                       "Service cores parsed before dataplane cores. "
+                       "Please ensure -c is before -s or -S\n");
+
        if (coremask == NULL)
                return -1;
        /* Remove all blank characters ahead and after .
@@ -423,6 +462,7 @@ eal_parse_coremask(const char *coremask)
                                                "unavailable\n", idx);
                                        return -1;
                                }
+
                                cfg->lcore_role[idx] = ROLE_RTE;
                                lcore_config[idx].core_index = count;
                                count++;
@@ -454,6 +494,7 @@ eal_parse_service_corelist(const char *corelist)
        unsigned count = 0;
        char *end = NULL;
        int min, max;
+       uint32_t taken_lcore_count = 0;
 
        if (corelist == NULL)
                return -1;
@@ -495,6 +536,9 @@ eal_parse_service_corelist(const char *corelist)
                                                        idx);
                                                return -1;
                                        }
+                                       if (cfg->lcore_role[idx] == ROLE_RTE)
+                                               taken_lcore_count++;
+
                                        lcore_config[idx].core_role =
                                                        ROLE_SERVICE;
                                        count++;
@@ -509,6 +553,12 @@ eal_parse_service_corelist(const char *corelist)
        if (count == 0)
                return -1;
 
+       if (core_parsed && taken_lcore_count != count) {
+               RTE_LOG(WARNING, EAL,
+                       "Not all service cores were in the coremask. "
+                       "Please ensure -c or -l includes service cores\n");
+       }
+
        return 0;
 }
 
@@ -521,6 +571,11 @@ eal_parse_corelist(const char *corelist)
        char *end = NULL;
        int min, max;
 
+       if (eal_service_cores_parsed())
+               RTE_LOG(WARNING, EAL,
+                       "Service cores parsed before dataplane cores. "
+                       "Please ensure -l is before -s or -S\n");
+
        if (corelist == NULL)
                return -1;
 
@@ -595,7 +650,8 @@ eal_parse_master_lcore(const char *arg)
 
        /* ensure master core is not used as service core */
        if (lcore_config[cfg->master_lcore].core_role == ROLE_SERVICE) {
-               RTE_LOG(ERR, EAL, "Error: Master lcore is used as a service core.\n");
+               RTE_LOG(ERR, EAL,
+                       "Error: Master lcore is used as a service core\n");
                return -1;
        }
 
@@ -1030,6 +1086,25 @@ eal_parse_proc_type(const char *arg)
        return RTE_PROC_INVALID;
 }
 
+static int
+eal_parse_iova_mode(const char *name)
+{
+       int mode;
+
+       if (name == NULL)
+               return -1;
+
+       if (!strcmp("pa", name))
+               mode = RTE_IOVA_PA;
+       else if (!strcmp("va", name))
+               mode = RTE_IOVA_VA;
+       else
+               return -1;
+
+       internal_config.iova_mode = mode;
+       return 0;
+}
+
 int
 eal_parse_common_option(int opt, const char *optarg,
                        struct internal_config *conf)
@@ -1170,6 +1245,13 @@ eal_parse_common_option(int opt, const char *optarg,
                conf->no_shconf = 1;
                break;
 
+       case OPT_IN_MEMORY_NUM:
+               conf->in_memory = 1;
+               /* in-memory is a superset of noshconf and huge-unlink */
+               conf->no_shconf = 1;
+               conf->hugepage_unlink = 1;
+               break;
+
        case OPT_PROC_TYPE_NUM:
                conf->process_type = eal_parse_proc_type(optarg);
                break;
@@ -1229,6 +1311,13 @@ eal_parse_common_option(int opt, const char *optarg,
        case OPT_SINGLE_FILE_SEGMENTS_NUM:
                conf->single_file_segments = 1;
                break;
+       case OPT_IOVA_MODE_NUM:
+               if (eal_parse_iova_mode(optarg) < 0) {
+                       RTE_LOG(ERR, EAL, "invalid parameters for --"
+                               OPT_IOVA_MODE "\n");
+                       return -1;
+               }
+               break;
 
        /* don't know what to do, leave this to caller */
        default:
@@ -1266,6 +1355,19 @@ eal_auto_detect_cores(struct rte_config *cfg)
        cfg->lcore_count -= removed;
 }
 
+int
+eal_cleanup_config(struct internal_config *internal_cfg)
+{
+       if (internal_cfg->hugefile_prefix != NULL)
+               free(internal_cfg->hugefile_prefix);
+       if (internal_cfg->hugepage_dir != NULL)
+               free(internal_cfg->hugepage_dir);
+       if (internal_cfg->user_mbuf_pool_ops_name != NULL)
+               free(internal_cfg->user_mbuf_pool_ops_name);
+
+       return 0;
+}
+
 int
 eal_adjust_config(struct internal_config *internal_cfg)
 {
@@ -1306,7 +1408,7 @@ eal_check_common_options(struct internal_config *internal_cfg)
                RTE_LOG(ERR, EAL, "Invalid process type specified\n");
                return -1;
        }
-       if (index(internal_cfg->hugefile_prefix, '%') != NULL) {
+       if (index(eal_get_hugefile_prefix(), '%') != NULL) {
                RTE_LOG(ERR, EAL, "Invalid char, '%%', in --"OPT_FILE_PREFIX" "
                        "option\n");
                return -1;
@@ -1321,8 +1423,8 @@ eal_check_common_options(struct internal_config *internal_cfg)
                        "be specified together with --"OPT_NO_HUGE"\n");
                return -1;
        }
-
-       if (internal_cfg->no_hugetlbfs && internal_cfg->hugepage_unlink) {
+       if (internal_cfg->no_hugetlbfs && internal_cfg->hugepage_unlink &&
+                       !internal_cfg->in_memory) {
                RTE_LOG(ERR, EAL, "Option --"OPT_HUGE_UNLINK" cannot "
                        "be specified together with --"OPT_NO_HUGE"\n");
                return -1;
@@ -1330,14 +1432,30 @@ eal_check_common_options(struct internal_config *internal_cfg)
        if (internal_config.force_socket_limits && internal_config.legacy_mem) {
                RTE_LOG(ERR, EAL, "Option --"OPT_SOCKET_LIMIT
                        " is only supported in non-legacy memory mode\n");
-               return -1;
        }
        if (internal_cfg->single_file_segments &&
-                       internal_cfg->hugepage_unlink) {
+                       internal_cfg->hugepage_unlink &&
+                       !internal_cfg->in_memory) {
                RTE_LOG(ERR, EAL, "Option --"OPT_SINGLE_FILE_SEGMENTS" is "
                        "not compatible with --"OPT_HUGE_UNLINK"\n");
                return -1;
        }
+       if (internal_cfg->legacy_mem &&
+                       internal_cfg->in_memory) {
+               RTE_LOG(ERR, EAL, "Option --"OPT_LEGACY_MEM" is not compatible "
+                               "with --"OPT_IN_MEMORY"\n");
+               return -1;
+       }
+       if (internal_cfg->legacy_mem && internal_cfg->match_allocations) {
+               RTE_LOG(ERR, EAL, "Option --"OPT_LEGACY_MEM" is not compatible "
+                               "with --"OPT_MATCH_ALLOCATIONS"\n");
+               return -1;
+       }
+       if (internal_cfg->no_hugetlbfs && internal_cfg->match_allocations) {
+               RTE_LOG(ERR, EAL, "Option --"OPT_NO_HUGE" is not compatible "
+                               "with --"OPT_MATCH_ALLOCATIONS"\n");
+               return -1;
+       }
 
        return 0;
 }
@@ -1376,6 +1494,8 @@ eal_common_usage(void)
               "  --"OPT_VDEV"              Add a virtual device.\n"
               "                      The argument format is <driver><id>[,key=val,...]\n"
               "                      (ex: --vdev=net_pcap0,iface=eth2).\n"
+              "  --"OPT_IOVA_MODE"   Set IOVA mode. 'pa' for IOVA_PA\n"
+              "                      'va' for IOVA_VA\n"
               "  -d LIB.so|DIR       Add a driver or driver directory\n"
               "                      (can be used multiple times)\n"
               "  --"OPT_VMWARE_TSC_MAP"    Use VMware TSC map instead of native RDTSC\n"
@@ -1386,6 +1506,8 @@ eal_common_usage(void)
               "                      Set specific log level\n"
               "  -v                  Display version information on startup\n"
               "  -h, --help          This help\n"
+              "  --"OPT_IN_MEMORY"   Operate entirely in memory. This will\n"
+              "                      disable secondary process support\n"
               "\nEAL options for DEBUG use only:\n"
               "  --"OPT_HUGE_UNLINK"       Unlink hugepage files after init\n"
               "  --"OPT_NO_HUGE"           Use malloc instead of hugetlbfs\n"
@@ -1393,4 +1515,5 @@ eal_common_usage(void)
               "  --"OPT_NO_HPET"           Disable HPET\n"
               "  --"OPT_NO_SHCONF"         No shared config (mmap'd files)\n"
               "\n", RTE_MAX_LCORE);
+       rte_option_usage();
 }