rte_dispatcher.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2023 Ericsson AB
 */

#ifndef RTE_DISPATCHER_H
#define RTE_DISPATCHER_H

#include <stdbool.h>
#include <stdint.h>

#include <rte_compat.h>
#include <rte_eventdev.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef bool (*rte_dispatcher_match_t)(const struct rte_event *event,
    void *cb_data);

typedef void (*rte_dispatcher_process_t)(uint8_t event_dev_id,
    uint8_t event_port_id, struct rte_event *events, uint16_t num,
    void *cb_data);

typedef void (*rte_dispatcher_finalize_t)(uint8_t event_dev_id,
    uint8_t event_port_id, void *cb_data);

struct rte_dispatcher_stats {
    uint64_t poll_count;
    uint64_t ev_batch_count;
    uint64_t ev_dispatch_count;
    uint64_t ev_drop_count;
};

__rte_experimental
struct rte_dispatcher *
rte_dispatcher_create(uint8_t event_dev_id);

__rte_experimental
int
rte_dispatcher_free(struct rte_dispatcher *dispatcher);

__rte_experimental
uint32_t
rte_dispatcher_service_id_get(const struct rte_dispatcher *dispatcher);

__rte_experimental
int
rte_dispatcher_bind_port_to_lcore(struct rte_dispatcher *dispatcher,
    uint8_t event_port_id, uint16_t batch_size, uint64_t timeout,
    unsigned int lcore_id);

__rte_experimental
int
rte_dispatcher_unbind_port_from_lcore(struct rte_dispatcher *dispatcher,
    uint8_t event_port_id, unsigned int lcore_id);

__rte_experimental
int
rte_dispatcher_register(struct rte_dispatcher *dispatcher,
    rte_dispatcher_match_t match_fun, void *match_cb_data,
    rte_dispatcher_process_t process_fun, void *process_cb_data);

__rte_experimental
int
rte_dispatcher_unregister(struct rte_dispatcher *dispatcher, int handler_id);

__rte_experimental
int
rte_dispatcher_finalize_register(struct rte_dispatcher *dispatcher,
    rte_dispatcher_finalize_t finalize_fun, void *finalize_data);

__rte_experimental
int
rte_dispatcher_finalize_unregister(struct rte_dispatcher *dispatcher, int reg_id);

__rte_experimental
void
rte_dispatcher_start(struct rte_dispatcher *dispatcher);

__rte_experimental
void
rte_dispatcher_stop(struct rte_dispatcher *dispatcher);

__rte_experimental
void
rte_dispatcher_stats_get(const struct rte_dispatcher *dispatcher,
    struct rte_dispatcher_stats *stats);

__rte_experimental
void
rte_dispatcher_stats_reset(struct rte_dispatcher *dispatcher);

#ifdef __cplusplus
}
#endif

#endif /* RTE_DISPATCHER_H */