X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=lib%2Flibrte_eal%2Fcommon%2Finclude%2Frte_eal.h;h=8e4e71cc1ea963f2b87fa4720d66f82b7aab1db2;hb=e32cb57973fc311b4b5f60ae5dac37d99e48c94d;hp=fe1323df65a2872807784489682eb1914fb9a87a;hpb=c5e9eeca5a67a8272f0fdedcd0afc9b2d22be376;p=dpdk.git diff --git a/lib/librte_eal/common/include/rte_eal.h b/lib/librte_eal/common/include/rte_eal.h index fe1323df65..8e4e71cc1e 100644 --- a/lib/librte_eal/common/include/rte_eal.h +++ b/lib/librte_eal/common/include/rte_eal.h @@ -1,13 +1,13 @@ /*- * BSD LICENSE - * - * Copyright(c) 2010-2014 Intel Corporation. All rights reserved. + * + * Copyright(c) 2010-2016 Intel Corporation. All rights reserved. * All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: - * + * * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above copyright @@ -17,7 +17,7 @@ * * Neither the name of Intel Corporation nor the names of its * contributors may be used to endorse or promote products derived * from this software without specific prior written permission. - * + * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR @@ -41,20 +41,29 @@ */ #include +#include + +#include +#include + +#include #ifdef __cplusplus extern "C" { #endif -#define RTE_VERSION 1 /**< The version of the RTE configuration structure. */ #define RTE_MAGIC 19820526 /**< Magic number written by the main partition when ready. */ +/* Maximum thread_name length. */ +#define RTE_MAX_THREAD_NAME_LEN 16 + /** * The lcore role (used in RTE or not). */ enum rte_lcore_role_t { ROLE_RTE, ROLE_OFF, + ROLE_SERVICE, }; /** @@ -72,30 +81,24 @@ enum rte_proc_type_t { * The global RTE configuration structure. */ struct rte_config { - uint32_t version; /**< Configuration [structure] version. */ - uint32_t magic; /**< Magic number - Sanity check. */ - - uint32_t master_lcore; /**< Id of the master lcore */ uint32_t lcore_count; /**< Number of available logical cores. */ + uint32_t service_lcore_count;/**< Number of available service cores. */ enum rte_lcore_role_t lcore_role[RTE_MAX_LCORE]; /**< State of cores. */ /** Primary or secondary configuration */ enum rte_proc_type_t process_type; - /** A set of general status flags */ - unsigned flags; + /** PA or VA mapping mode */ + enum rte_iova_mode iova_mode; /** * Pointer to memory configuration, which may be shared across multiple - * Intel DPDK instances + * DPDK instances */ struct rte_mem_config *mem_config; } __attribute__((__packed__)); -/* Flag definitions for rte_config flags */ -#define EAL_FLG_HIGH_IOPL 1 /**< indicates high IO privilage in a linux env */ - /** * Get the global configuration structure. * @@ -123,15 +126,25 @@ enum rte_lcore_role_t rte_eal_lcore_role(unsigned lcore_id); */ enum rte_proc_type_t rte_eal_process_type(void); +/** + * Request iopl privilege for all RPL. + * + * This function should be called by pmds which need access to ioports. + + * @return + * - On success, returns 0. + * - On failure, returns -1. + */ +int rte_eal_iopl_init(void); + /** * Initialize the Environment Abstraction Layer (EAL). * * This function is to be executed on the MASTER lcore only, as soon * as possible in the application's main() function. * - * The function finishes the initialization process that was started - * during boot (in case of baremetal) or before main() is called (in - * case of linuxapp). It puts the SLAVE lcores in the WAIT state. + * The function finishes the initialization process before main() is called. + * It puts the SLAVE lcores in the WAIT state. * * When the multi-partition feature is supported, depending on the * configuration (if CONFIG_RTE_EAL_MAIN_PARTITION is disabled), this @@ -140,21 +153,71 @@ enum rte_proc_type_t rte_eal_process_type(void); * This behavior may change in the future. * * @param argc - * The argc argument that was given to the main() function. + * A non-negative value. If it is greater than 0, the array members + * for argv[0] through argv[argc] (non-inclusive) shall contain pointers + * to strings. * @param argv - * The argv argument that was given to the main() function. + * An array of strings. The contents of the array, as well as the strings + * which are pointed to by the array, may be modified by this function. * @return * - On success, the number of parsed arguments, which is greater or * equal to zero. After the call to rte_eal_init(), - * all arguments argv[x] with x < ret may be modified and should - * not be accessed by the application. - * - On failure, a negative error value. + * all arguments argv[x] with x < ret may have been modified by this + * function call and should not be further interpreted by the + * application. The EAL does not take any ownership of the memory used + * for either the argv array, or its members. + * - On failure, -1 and rte_errno is set to a value indicating the cause + * for failure. In some instances, the application will need to be + * restarted as part of clearing the issue. + * + * Error codes returned via rte_errno: + * EACCES indicates a permissions issue. + * + * EAGAIN indicates either a bus or system resource was not available, + * setup may be attempted again. + * + * EALREADY indicates that the rte_eal_init function has already been + * called, and cannot be called again. + * + * EFAULT indicates the tailq configuration name was not found in + * memory configuration. + * + * EINVAL indicates invalid parameters were passed as argv/argc. + * + * ENOMEM indicates failure likely caused by an out-of-memory condition. + * + * ENODEV indicates memory setup issues. + * + * ENOTSUP indicates that the EAL cannot initialize on this system. + * + * EPROTO indicates that the PCI bus is either not present, or is not + * readable by the eal. + * + * ENOEXEC indicates that a service core failed to launch successfully. */ int rte_eal_init(int argc, char **argv); + +/** + * Check if a primary process is currently alive + * + * This function returns true when a primary process is currently + * active. + * + * @param config_file_path + * The config_file_path argument provided should point at the location + * that the primary process will create its config file. If NULL, the default + * config file path is used. + * + * @return + * - If alive, returns 1. + * - If dead, returns 0. + */ +int rte_eal_primary_proc_alive(const char *config_file_path); + /** * Usage function typedef used by the application usage function. * - * Use this function typedef to define and call rte_set_applcation_usage_hook() + * Use this function typedef to define and call rte_set_application_usage_hook() * routine. */ typedef void (*rte_usage_hook_t)(const char * prgname); @@ -169,7 +232,7 @@ typedef void (*rte_usage_hook_t)(const char * prgname); * This routine is optional for the application and will behave as if the set * routine was never called as the default behavior. * - * @param func + * @param usage_func * The func argument is a function pointer to the application usage routine. * Called function is defined using rte_usage_hook_t typedef, which is of * the form void rte_usage_func(const char * prgname). @@ -181,10 +244,10 @@ typedef void (*rte_usage_hook_t)(const char * prgname); * the caller to daisy chain the usage routines if needing more then one. */ rte_usage_hook_t -rte_set_application_usage_hook( rte_usage_hook_t usage_func ); +rte_set_application_usage_hook(rte_usage_hook_t usage_func); /** - * macro to get the lock of tailq in mem_config + * macro to get the lock of tailq in mem_config */ #define RTE_EAL_TAILQ_RWLOCK (&rte_eal_get_configuration()->mem_config->qlock) @@ -193,75 +256,84 @@ rte_set_application_usage_hook( rte_usage_hook_t usage_func ); */ #define RTE_EAL_MEMPOOL_RWLOCK (&rte_eal_get_configuration()->mem_config->mplock) - /** - * Utility macro to do a thread-safe tailq 'INSERT' of rte_mem_config - * - * @param idx - * a kind of tailq define in enum rte_tailq_t - * - * @param type - * type of list(tailq head) - * - * @param elm - * The element will be added into the list + * Whether EAL is using huge pages (disabled by --no-huge option). + * The no-huge mode cannot be used with UIO poll-mode drivers like igb/ixgbe. + * It is useful for NIC drivers (e.g. librte_pmd_mlx4, librte_pmd_vmxnet3) or + * crypto drivers (e.g. librte_crypto_nitrox) provided by third-parties such + * as 6WIND. * + * @return + * Nonzero if hugepages are enabled. */ -#define RTE_EAL_TAILQ_INSERT_TAIL(idx, type, elm) do { \ - struct type *list; \ - list = RTE_TAILQ_LOOKUP_BY_IDX(idx, type); \ - rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK); \ - TAILQ_INSERT_TAIL(list, elm, next); \ - rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK); \ -} while (0) +int rte_eal_has_hugepages(void); /** - * Utility macro to do a thread-safe tailq 'REMOVE' of rte_mem_config + * Whether EAL is using PCI bus. + * Disabled by --no-pci option. * - * @param idx - * a kind of tailq define in enum rte_tailq_t - * - * @param type - * type of list(tailq head) + * @return + * Nonzero if the PCI bus is enabled. + */ +int rte_eal_has_pci(void); + +/** + * Whether the EAL was asked to create UIO device. * - * @param elm - * The element will be remove from the list + * @return + * Nonzero if true. + */ +int rte_eal_create_uio_dev(void); + +/** + * The user-configured vfio interrupt mode. * + * @return + * Interrupt mode configured with the command line, + * RTE_INTR_MODE_NONE by default. */ -#define RTE_EAL_TAILQ_REMOVE(idx, type, elm) do { \ - struct type *list; \ - list = RTE_TAILQ_LOOKUP_BY_IDX(idx, type); \ - rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK); \ - TAILQ_REMOVE(list, elm, next); \ - rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK); \ -} while (0) \ +enum rte_intr_mode rte_eal_vfio_intr_mode(void); +/** + * A wrap API for syscall gettid. + * + * @return + * On success, returns the thread ID of calling process. + * It is always successful. + */ +int rte_sys_gettid(void); /** - * macro to check TAILQ exist + * Get system unique thread id. * - * @param idx - * a kind of tailq define in enum rte_tailq_t + * @return + * On success, returns the thread ID of calling process. + * It is always successful. + */ +static inline int rte_gettid(void) +{ + static RTE_DEFINE_PER_LCORE(int, _thread_id) = -1; + if (RTE_PER_LCORE(_thread_id) == -1) + RTE_PER_LCORE(_thread_id) = rte_sys_gettid(); + return RTE_PER_LCORE(_thread_id); +} + +/** + * Get the iova mode * + * @return + * enum rte_iova_mode value. */ -#define RTE_EAL_TAILQ_EXIST_CHECK(idx) do { \ - if (RTE_TAILQ_LOOKUP_BY_IDX(idx, rte_tailq_head) == NULL){ \ - rte_errno = E_RTE_NO_TAILQ; \ - return NULL; \ - } \ -} while(0) +enum rte_iova_mode rte_eal_iova_mode(void); /** - * Whether EAL is using huge pages (disabled by --no-huge option). - * The no-huge mode cannot be used with UIO poll-mode drivers like igb/ixgbe. - * It is useful for NIC drivers (e.g. librte_pmd_mlx4, librte_pmd_vmxnet3) or - * crypto drivers (e.g. librte_crypto_nitrox) provided by third-parties such - * as 6WIND. + * Get default pool ops name for mbuf * * @return - * Nonzero if hugepages are enabled. + * returns default pool ops name. */ -int rte_eal_has_hugepages(void); +const char * +rte_eal_mbuf_default_mempool_ops(void); #ifdef __cplusplus }