rte_service.h

Go to the documentation of this file.

/*
 *   BSD LICENSE
 *
 *   Copyright(c) 2017 Intel Corporation. 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_SERVICE_H_
#define _RTE_SERVICE_H_

#ifdef __cplusplus
extern "C" {
#endif

#include<stdio.h>
#include <stdint.h>
#include <sys/queue.h>

#include <rte_lcore.h>

/* forward declaration only. Definition in rte_service_private.h */
struct rte_service_spec;

#define RTE_SERVICE_NAME_MAX 32

/* Capabilities of a service.
 *
 * Use the *rte_service_probe_capability* function to check if a service is
 * capable of a specific capability.
 */
#define RTE_SERVICE_CAP_MT_SAFE (1 << 0)

uint32_t rte_service_get_count(void);


struct rte_service_spec *rte_service_get_by_id(uint32_t id);

struct rte_service_spec *rte_service_get_by_name(const char *name);

const char *rte_service_get_name(const struct rte_service_spec *service);

int32_t rte_service_probe_capability(const struct rte_service_spec *service,
                                     uint32_t capability);

int32_t rte_service_enable_on_lcore(struct rte_service_spec *service,
                                   uint32_t lcore);

int32_t rte_service_disable_on_lcore(struct rte_service_spec *service,
                                   uint32_t lcore);

int32_t rte_service_get_enabled_on_lcore(struct rte_service_spec *service,
                                        uint32_t lcore);


int32_t rte_service_start(struct rte_service_spec *service);

int32_t rte_service_stop(struct rte_service_spec *service);

int32_t rte_service_is_running(const struct rte_service_spec *service);

int32_t rte_service_lcore_start(uint32_t lcore_id);

int32_t rte_service_lcore_stop(uint32_t lcore_id);

int32_t rte_service_lcore_add(uint32_t lcore);

int32_t rte_service_lcore_del(uint32_t lcore);

int32_t rte_service_lcore_count(void);

int32_t rte_service_lcore_reset_all(void);

int32_t rte_service_set_stats_enable(struct rte_service_spec *service,
                                  int32_t enable);

int32_t rte_service_lcore_list(uint32_t array[], uint32_t n);

int32_t rte_service_dump(FILE *f, struct rte_service_spec *service);

#ifdef __cplusplus
}
#endif


#endif /* _RTE_SERVICE_H_ */