rte_jobstats.h

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2015 Intel Corporation
 */

#ifndef JOBSTATS_H_
#define JOBSTATS_H_

#include <stdint.h>

#include <rte_memory.h>

#ifdef __cplusplus
extern "C" {
#endif

#define RTE_JOBSTATS_NAMESIZE 32

/* Forward declarations. */
struct rte_jobstats_context;
struct rte_jobstats;

typedef void (*rte_job_update_period_cb_t)(struct rte_jobstats *job,
        int64_t job_result);

struct rte_jobstats {
    uint64_t period;
    uint64_t min_period;
    uint64_t max_period;
    int64_t target;
    rte_job_update_period_cb_t update_period_cb;
    uint64_t exec_time;
    uint64_t min_exec_time;
    uint64_t max_exec_time;
    uint64_t exec_cnt;
    char name[RTE_JOBSTATS_NAMESIZE];
    struct rte_jobstats_context *context;
} __rte_cache_aligned;

struct rte_jobstats_context {
    uint64_t state_time;

    uint64_t loop_executed_jobs;
    /* Statistics start. */

    uint64_t exec_time;
    uint64_t min_exec_time;
    uint64_t max_exec_time;
    uint64_t management_time;

    uint64_t min_management_time;
    uint64_t max_management_time;
    uint64_t start_time;
    uint64_t job_exec_cnt;
    uint64_t loop_cnt;
} __rte_cache_aligned;

int
rte_jobstats_context_init(struct rte_jobstats_context *ctx);

void
rte_jobstats_context_start(struct rte_jobstats_context *ctx);

void
rte_jobstats_context_finish(struct rte_jobstats_context *ctx);

void
rte_jobstats_context_reset(struct rte_jobstats_context *ctx);

int
rte_jobstats_init(struct rte_jobstats *job, const char *name,
        uint64_t min_period, uint64_t max_period, uint64_t initial_period,
        int64_t target);

void
rte_jobstats_set_target(struct rte_jobstats *job, int64_t target);

int
rte_jobstats_start(struct rte_jobstats_context *ctx, struct rte_jobstats *job);

int
rte_jobstats_abort(struct rte_jobstats *job);

int
rte_jobstats_finish(struct rte_jobstats *job, int64_t job_value);

void
rte_jobstats_set_period(struct rte_jobstats *job, uint64_t period,
        uint8_t saturate);
void
rte_jobstats_set_min(struct rte_jobstats *job, uint64_t period);
void
rte_jobstats_set_max(struct rte_jobstats *job, uint64_t period);

void
rte_jobstats_set_update_period_function(struct rte_jobstats *job,
        rte_job_update_period_cb_t update_period_cb);

void
rte_jobstats_reset(struct rte_jobstats *job);

#ifdef __cplusplus
}
#endif

#endif /* JOBSTATS_H_ */