rte_eal.h

Go to the documentation of this file.

/*-
 *   BSD LICENSE
 *
 *   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
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * 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
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _RTE_EAL_H_
#define _RTE_EAL_H_

#include <stdint.h>
#include <sched.h>

#include <rte_per_lcore.h>
#include <rte_config.h>

#ifdef __cplusplus
extern "C" {
#endif

#define RTE_MAGIC 19820526 
/* Maximum thread_name length. */
#define RTE_MAX_THREAD_NAME_LEN 16

enum rte_lcore_role_t {
    ROLE_RTE,
    ROLE_OFF,
};

enum rte_proc_type_t {
    RTE_PROC_AUTO = -1,   /* allow auto-detection of primary/secondary */
    RTE_PROC_PRIMARY = 0, /* set to zero, so primary is the default */
    RTE_PROC_SECONDARY,

    RTE_PROC_INVALID
};

struct rte_config {
    uint32_t master_lcore;       
    uint32_t lcore_count;        
    enum rte_lcore_role_t lcore_role[RTE_MAX_LCORE]; 
    enum rte_proc_type_t process_type;

    struct rte_mem_config *mem_config;
} __attribute__((__packed__));

struct rte_config *rte_eal_get_configuration(void);

enum rte_lcore_role_t rte_eal_lcore_role(unsigned lcore_id);


enum rte_proc_type_t rte_eal_process_type(void);

int rte_eal_iopl_init(void);

int rte_eal_init(int argc, char **argv);

int rte_eal_primary_proc_alive(const char *config_file_path);

typedef void    (*rte_usage_hook_t)(const char * prgname);

rte_usage_hook_t
rte_set_application_usage_hook(rte_usage_hook_t usage_func);

#define RTE_EAL_TAILQ_RWLOCK         (&rte_eal_get_configuration()->mem_config->qlock)

#define RTE_EAL_MEMPOOL_RWLOCK            (&rte_eal_get_configuration()->mem_config->mplock)

int rte_eal_has_hugepages(void);

int rte_sys_gettid(void);

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);
}

#define RTE_INIT(func) \
static void __attribute__((constructor, used)) func(void)

#ifdef __cplusplus
}
#endif

#endif /* _RTE_EAL_H_ */