eal: restrict default plugin path to shared lib mode
[dpdk.git] / lib / librte_eal / common / eal_common_options.c
index baaf876..34edd8c 100644 (file)
 #include <getopt.h>
 #ifndef RTE_EXEC_ENV_WINDOWS
 #include <dlfcn.h>
+#include <libgen.h>
 #endif
 #include <sys/types.h>
 #include <sys/stat.h>
+#ifndef RTE_EXEC_ENV_WINDOWS
 #include <dirent.h>
+#endif
 
 #include <rte_string_fns.h>
 #include <rte_eal.h>
@@ -29,6 +32,9 @@
 #include <rte_version.h>
 #include <rte_devargs.h>
 #include <rte_memcpy.h>
+#ifndef RTE_EXEC_ENV_WINDOWS
+#include <rte_telemetry.h>
+#endif
 
 #include "eal_internal_cfg.h"
 #include "eal_options.h"
@@ -112,8 +118,10 @@ struct shared_driver {
 static struct shared_driver_list solib_list =
 TAILQ_HEAD_INITIALIZER(solib_list);
 
+#ifndef RTE_EXEC_ENV_WINDOWS
 /* Default path of external loadable drivers */
 static const char *default_solib_dir = RTE_EAL_PMD_PATH;
+#endif
 
 /*
  * Stringified version of solib path used by dpdk-pmdinfo.py
@@ -139,6 +147,99 @@ static int master_lcore_parsed;
 static int mem_parsed;
 static int core_parsed;
 
+/* Allow the application to print its usage message too if set */
+static rte_usage_hook_t rte_application_usage_hook;
+
+/* Returns rte_usage_hook_t */
+rte_usage_hook_t
+eal_get_application_usage_hook(void)
+{
+       return rte_application_usage_hook;
+}
+
+/* Set a per-application usage message */
+rte_usage_hook_t
+rte_set_application_usage_hook(rte_usage_hook_t usage_func)
+{
+       rte_usage_hook_t old_func;
+
+       /* Will be NULL on the first call to denote the last usage routine. */
+       old_func = rte_application_usage_hook;
+       rte_application_usage_hook = usage_func;
+
+       return old_func;
+}
+
+#ifndef RTE_EXEC_ENV_WINDOWS
+static char **eal_args;
+static char **eal_app_args;
+
+#define EAL_PARAM_REQ "/eal/params"
+#define EAL_APP_PARAM_REQ "/eal/app_params"
+
+/* callback handler for telemetry library to report out EAL flags */
+int
+handle_eal_info_request(const char *cmd, const char *params __rte_unused,
+               struct rte_tel_data *d)
+{
+       char **args;
+       int used = 0;
+       int i = 0;
+
+       if (strcmp(cmd, EAL_PARAM_REQ) == 0)
+               args = eal_args;
+       else
+               args = eal_app_args;
+
+       rte_tel_data_start_array(d, RTE_TEL_STRING_VAL);
+       if (args == NULL || args[0] == NULL)
+               return 0;
+
+       for ( ; args[i] != NULL; i++)
+               used = rte_tel_data_add_array_string(d, args[i]);
+       return used;
+}
+
+int
+eal_save_args(int argc, char **argv)
+{
+       int i, j;
+
+       rte_telemetry_register_cmd(EAL_PARAM_REQ, handle_eal_info_request,
+                       "Returns EAL commandline parameters used. Takes no parameters");
+       rte_telemetry_register_cmd(EAL_APP_PARAM_REQ, handle_eal_info_request,
+                       "Returns app commandline parameters used. Takes no parameters");
+
+       /* clone argv to report out later. We overprovision, but
+        * this does not waste huge amounts of memory
+        */
+       eal_args = calloc(argc + 1, sizeof(*eal_args));
+       if (eal_args == NULL)
+               return -1;
+
+       for (i = 0; i < argc; i++) {
+               eal_args[i] = strdup(argv[i]);
+               if (strcmp(argv[i], "--") == 0)
+                       break;
+       }
+       eal_args[i++] = NULL; /* always finish with NULL */
+
+       /* allow reporting of any app args we know about too */
+       if (i >= argc)
+               return 0;
+
+       eal_app_args = calloc(argc - i + 1, sizeof(*eal_args));
+       if (eal_app_args == NULL)
+               return -1;
+
+       for (j = 0; i < argc; j++, i++)
+               eal_app_args[j] = strdup(argv[i]);
+       eal_app_args[j] = NULL;
+
+       return 0;
+}
+#endif
+
 static int
 eal_option_device_add(enum rte_devtype type, const char *optarg)
 {
@@ -187,8 +288,11 @@ eal_option_device_parse(void)
 const char *
 eal_get_hugefile_prefix(void)
 {
-       if (internal_config.hugefile_prefix != NULL)
-               return internal_config.hugefile_prefix;
+       const struct internal_config *internal_conf =
+               eal_get_internal_configuration();
+
+       if (internal_conf->hugefile_prefix != NULL)
+               return internal_conf->hugefile_prefix;
        return HUGEFILE_PREFIX_DEFAULT;
 }
 
@@ -249,13 +353,20 @@ eal_plugin_add(const char *path)
                return -1;
        }
        memset(solib, 0, sizeof(*solib));
-       strlcpy(solib->name, path, PATH_MAX-1);
-       solib->name[PATH_MAX-1] = 0;
+       strlcpy(solib->name, path, PATH_MAX);
        TAILQ_INSERT_TAIL(&solib_list, solib, next);
 
        return 0;
 }
 
+#ifdef RTE_EXEC_ENV_WINDOWS
+int
+eal_plugins_init(void)
+{
+       return 0;
+}
+#else
+
 static int
 eal_plugindir_init(const char *path)
 {
@@ -275,9 +386,15 @@ eal_plugindir_init(const char *path)
 
        while ((dent = readdir(d)) != NULL) {
                struct stat sb;
+               int nlen = strnlen(dent->d_name, sizeof(dent->d_name));
+
+               /* check if name ends in .so */
+               if (strcmp(&dent->d_name[nlen - 3], ".so") != 0)
+                       continue;
 
                snprintf(sopath, sizeof(sopath), "%s/%s", path, dent->d_name);
 
+               /* if a regular file, add to list to load */
                if (!(stat(sopath, &sb) == 0 && S_ISREG(sb.st_mode)))
                        continue;
 
@@ -290,15 +407,92 @@ eal_plugindir_init(const char *path)
        return (dent == NULL) ? 0 : -1;
 }
 
+static int
+verify_perms(const char *dirpath)
+{
+       struct stat st;
+
+       /* if not root, check down one level first */
+       if (strcmp(dirpath, "/") != 0) {
+               static __thread char last_dir_checked[PATH_MAX];
+               char copy[PATH_MAX];
+               const char *dir;
+
+               strlcpy(copy, dirpath, PATH_MAX);
+               dir = dirname(copy);
+               if (strncmp(dir, last_dir_checked, PATH_MAX) != 0) {
+                       if (verify_perms(dir) != 0)
+                               return -1;
+                       strlcpy(last_dir_checked, dir, PATH_MAX);
+               }
+       }
+
+       /* call stat to check for permissions and ensure not world writable */
+       if (stat(dirpath, &st) != 0) {
+               RTE_LOG(ERR, EAL, "Error with stat on %s, %s\n",
+                               dirpath, strerror(errno));
+               return -1;
+       }
+       if (st.st_mode & S_IWOTH) {
+               RTE_LOG(ERR, EAL,
+                               "Error, directory path %s is world-writable and insecure\n",
+                               dirpath);
+               return -1;
+       }
+
+       return 0;
+}
+
+static void *
+eal_dlopen(const char *pathname)
+{
+       void *retval = NULL;
+       char *realp = realpath(pathname, NULL);
+
+       if (realp == NULL && errno == ENOENT) {
+               /* not a full or relative path, try a load from system dirs */
+               retval = dlopen(pathname, RTLD_NOW);
+               if (retval == NULL)
+                       RTE_LOG(ERR, EAL, "%s\n", dlerror());
+               return retval;
+       }
+       if (realp == NULL) {
+               RTE_LOG(ERR, EAL, "Error with realpath for %s, %s\n",
+                               pathname, strerror(errno));
+               goto out;
+       }
+       if (strnlen(realp, PATH_MAX) == PATH_MAX) {
+               RTE_LOG(ERR, EAL, "Error, driver path greater than PATH_MAX\n");
+               goto out;
+       }
+
+       /* do permissions checks */
+       if (verify_perms(realp) != 0)
+               goto out;
+
+       retval = dlopen(realp, RTLD_NOW);
+       if (retval == NULL)
+               RTE_LOG(ERR, EAL, "%s\n", dlerror());
+out:
+       free(realp);
+       return retval;
+}
+
 int
 eal_plugins_init(void)
 {
-#ifndef RTE_EXEC_ENV_WINDOWS
        struct shared_driver *solib = NULL;
        struct stat sb;
 
-       if (*default_solib_dir != '\0' && stat(default_solib_dir, &sb) == 0 &&
-                               S_ISDIR(sb.st_mode))
+       /* If we are not statically linked, add default driver loading
+        * path if it exists as a directory.
+        * (Using dlopen with NOLOAD flag on EAL, will return NULL if the EAL
+        * shared library is not already loaded i.e. it's statically linked.)
+        */
+       if (dlopen("librte_eal.so", RTLD_LAZY | RTLD_NOLOAD) != NULL &&
+                       *default_solib_dir != '\0' &&
+                       stat(default_solib_dir, &sb) == 0 &&
+                       S_ISDIR(sb.st_mode))
                eal_plugin_add(default_solib_dir);
 
        TAILQ_FOREACH(solib, &solib_list, next) {
@@ -313,17 +507,15 @@ eal_plugins_init(void)
                } else {
                        RTE_LOG(DEBUG, EAL, "open shared lib %s\n",
                                solib->name);
-                       solib->lib_handle = dlopen(solib->name, RTLD_NOW);
-                       if (solib->lib_handle == NULL) {
-                               RTE_LOG(ERR, EAL, "%s\n", dlerror());
+                       solib->lib_handle = eal_dlopen(solib->name);
+                       if (solib->lib_handle == NULL)
                                return -1;
-                       }
                }
 
        }
        return 0;
-#endif
 }
+#endif
 
 /*
  * Parse the coremask given as argument (hexadecimal string) and fill
@@ -1097,6 +1289,8 @@ static int
 eal_parse_iova_mode(const char *name)
 {
        int mode;
+       struct internal_config *internal_conf =
+               eal_get_internal_configuration();
 
        if (name == NULL)
                return -1;
@@ -1108,7 +1302,7 @@ eal_parse_iova_mode(const char *name)
        else
                return -1;
 
-       internal_config.iova_mode = mode;
+       internal_conf->iova_mode = mode;
        return 0;
 }
 
@@ -1117,6 +1311,8 @@ eal_parse_base_virtaddr(const char *arg)
 {
        char *end;
        uint64_t addr;
+       struct internal_config *internal_conf =
+               eal_get_internal_configuration();
 
        errno = 0;
        addr = strtoull(arg, &end, 16);
@@ -1136,7 +1332,7 @@ eal_parse_base_virtaddr(const char *arg)
         * it can align to 2MB for x86. So this alignment can also be used
         * on x86 and other architectures.
         */
-       internal_config.base_virtaddr =
+       internal_conf->base_virtaddr =
                RTE_PTR_ALIGN_CEIL((uintptr_t)addr, (size_t)RTE_PGSIZE_16M);
 
        return 0;
@@ -1589,12 +1785,14 @@ eal_adjust_config(struct internal_config *internal_cfg)
 {
        int i;
        struct rte_config *cfg = rte_eal_get_configuration();
+       struct internal_config *internal_conf =
+               eal_get_internal_configuration();
 
        if (!core_parsed)
                eal_auto_detect_cores(cfg);
 
-       if (internal_config.process_type == RTE_PROC_AUTO)
-               internal_config.process_type = eal_proc_type_detect();
+       if (internal_conf->process_type == RTE_PROC_AUTO)
+               internal_conf->process_type = eal_proc_type_detect();
 
        /* default master lcore is the first one */
        if (!master_lcore_parsed) {
@@ -1618,6 +1816,8 @@ int
 eal_check_common_options(struct internal_config *internal_cfg)
 {
        struct rte_config *cfg = rte_eal_get_configuration();
+       const struct internal_config *internal_conf =
+               eal_get_internal_configuration();
 
        if (cfg->lcore_role[cfg->master_lcore] != ROLE_RTE) {
                RTE_LOG(ERR, EAL, "Master lcore is not enabled for DPDK\n");
@@ -1664,7 +1864,7 @@ eal_check_common_options(struct internal_config *internal_cfg)
                        "be specified together with --"OPT_NO_HUGE"\n");
                return -1;
        }
-       if (internal_config.force_socket_limits && internal_config.legacy_mem) {
+       if (internal_conf->force_socket_limits && internal_conf->legacy_mem) {
                RTE_LOG(ERR, EAL, "Option --"OPT_SOCKET_LIMIT
                        " is only supported in non-legacy memory mode\n");
        }