rte_jobstats.h

/*-
 *   BSD LICENSE
 *
 *   Copyright(c) 2015 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 JOBSTATS_H_
#define JOBSTATS_H_

#include <stdint.h>

#include <rte_memory.h>
#include <rte_memcpy.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_ */