rte_meter.h

Go to the documentation of this file.

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

#ifndef __INCLUDE_RTE_METER_H__
#define __INCLUDE_RTE_METER_H__

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>


/*
 * Application Programmer's Interface (API)
 *
 ***/

enum rte_color {
    RTE_COLOR_GREEN = 0, 
    RTE_COLOR_YELLOW, 
    RTE_COLOR_RED, 
    RTE_COLORS 
};

struct rte_meter_srtcm_params {
    uint64_t cir; 
    uint64_t cbs; 
    uint64_t ebs; 
};

struct rte_meter_trtcm_params {
    uint64_t cir; 
    uint64_t pir; 
    uint64_t cbs; 
    uint64_t pbs; 
};

struct rte_meter_trtcm_rfc4115_params {
    uint64_t cir; 
    uint64_t eir; 
    uint64_t cbs; 
    uint64_t ebs; 
};

struct rte_meter_srtcm_profile;

struct rte_meter_trtcm_profile;

struct rte_meter_trtcm_rfc4115_profile;

struct rte_meter_srtcm;

struct rte_meter_trtcm;

struct rte_meter_trtcm_rfc4115;

int
rte_meter_srtcm_profile_config(struct rte_meter_srtcm_profile *p,
    struct rte_meter_srtcm_params *params);

int
rte_meter_trtcm_profile_config(struct rte_meter_trtcm_profile *p,
    struct rte_meter_trtcm_params *params);
int
rte_meter_trtcm_rfc4115_profile_config(
    struct rte_meter_trtcm_rfc4115_profile *p,
    struct rte_meter_trtcm_rfc4115_params *params);

int
rte_meter_srtcm_config(struct rte_meter_srtcm *m,
    struct rte_meter_srtcm_profile *p);

int
rte_meter_trtcm_config(struct rte_meter_trtcm *m,
    struct rte_meter_trtcm_profile *p);

int
rte_meter_trtcm_rfc4115_config(struct rte_meter_trtcm_rfc4115 *m,
    struct rte_meter_trtcm_rfc4115_profile *p);

static inline enum rte_color
rte_meter_srtcm_color_blind_check(struct rte_meter_srtcm *m,
    struct rte_meter_srtcm_profile *p,
    uint64_t time,
    uint32_t pkt_len);

static inline enum rte_color
rte_meter_srtcm_color_aware_check(struct rte_meter_srtcm *m,
    struct rte_meter_srtcm_profile *p,
    uint64_t time,
    uint32_t pkt_len,
    enum rte_color pkt_color);

static inline enum rte_color
rte_meter_trtcm_color_blind_check(struct rte_meter_trtcm *m,
    struct rte_meter_trtcm_profile *p,
    uint64_t time,
    uint32_t pkt_len);

static inline enum rte_color
rte_meter_trtcm_color_aware_check(struct rte_meter_trtcm *m,
    struct rte_meter_trtcm_profile *p,
    uint64_t time,
    uint32_t pkt_len,
    enum rte_color pkt_color);

static inline enum rte_color
rte_meter_trtcm_rfc4115_color_blind_check(
    struct rte_meter_trtcm_rfc4115 *m,
    struct rte_meter_trtcm_rfc4115_profile *p,
    uint64_t time,
    uint32_t pkt_len);

static inline enum rte_color
rte_meter_trtcm_rfc4115_color_aware_check(
    struct rte_meter_trtcm_rfc4115 *m,
    struct rte_meter_trtcm_rfc4115_profile *p,
    uint64_t time,
    uint32_t pkt_len,
    enum rte_color pkt_color);

/*
 * Inline implementation of run-time methods
 *
 ***/

struct rte_meter_srtcm_profile {
    uint64_t cbs;
    uint64_t ebs;
    uint64_t cir_period;
    uint64_t cir_bytes_per_period;
};

/* Internal data structure storing the srTCM run-time context per metered traffic flow. */
struct rte_meter_srtcm {
    uint64_t time; /* Time of latest update of C and E token buckets */
    uint64_t tc;   /* Number of bytes currently available in the committed (C) token bucket */
    uint64_t te;   /* Number of bytes currently available in the excess (E) token bucket */
};

struct rte_meter_trtcm_profile {
    uint64_t cbs;
    uint64_t pbs;
    uint64_t cir_period;
    uint64_t cir_bytes_per_period;
    uint64_t pir_period;
    uint64_t pir_bytes_per_period;
};

struct rte_meter_trtcm {
    uint64_t time_tc;
    uint64_t time_tp;
    uint64_t tc;
    uint64_t tp;
};

struct rte_meter_trtcm_rfc4115_profile {
    uint64_t cbs;
    uint64_t ebs;
    uint64_t cir_period;
    uint64_t cir_bytes_per_period;
    uint64_t eir_period;
    uint64_t eir_bytes_per_period;
};

struct rte_meter_trtcm_rfc4115 {
    uint64_t time_tc;
    uint64_t time_te;
    uint64_t tc;
    uint64_t te;
};

static inline enum rte_color
rte_meter_srtcm_color_blind_check(struct rte_meter_srtcm *m,
    struct rte_meter_srtcm_profile *p,
    uint64_t time,
    uint32_t pkt_len)
{
    uint64_t time_diff, n_periods, tc, te;

    /* Bucket update */
    time_diff = time - m->time;
    n_periods = time_diff / p->cir_period;
    m->time += n_periods * p->cir_period;

    /* Put the tokens overflowing from tc into te bucket */
    tc = m->tc + n_periods * p->cir_bytes_per_period;
    te = m->te;
    if (tc > p->cbs) {
        te += (tc - p->cbs);
        if (te > p->ebs)
            te = p->ebs;
        tc = p->cbs;
    }

    /* Color logic */
    if (tc >= pkt_len) {
        m->tc = tc - pkt_len;
        m->te = te;
        return RTE_COLOR_GREEN;
    }

    if (te >= pkt_len) {
        m->tc = tc;
        m->te = te - pkt_len;
        return RTE_COLOR_YELLOW;
    }

    m->tc = tc;
    m->te = te;
    return RTE_COLOR_RED;
}

static inline enum rte_color
rte_meter_srtcm_color_aware_check(struct rte_meter_srtcm *m,
    struct rte_meter_srtcm_profile *p,
    uint64_t time,
    uint32_t pkt_len,
    enum rte_color pkt_color)
{
    uint64_t time_diff, n_periods, tc, te;

    /* Bucket update */
    time_diff = time - m->time;
    n_periods = time_diff / p->cir_period;
    m->time += n_periods * p->cir_period;

    /* Put the tokens overflowing from tc into te bucket */
    tc = m->tc + n_periods * p->cir_bytes_per_period;
    te = m->te;
    if (tc > p->cbs) {
        te += (tc - p->cbs);
        if (te > p->ebs)
            te = p->ebs;
        tc = p->cbs;
    }

    /* Color logic */
    if ((pkt_color == RTE_COLOR_GREEN) && (tc >= pkt_len)) {
        m->tc = tc - pkt_len;
        m->te = te;
        return RTE_COLOR_GREEN;
    }

    if ((pkt_color != RTE_COLOR_RED) && (te >= pkt_len)) {
        m->tc = tc;
        m->te = te - pkt_len;
        return RTE_COLOR_YELLOW;
    }

    m->tc = tc;
    m->te = te;
    return RTE_COLOR_RED;
}

static inline enum rte_color
rte_meter_trtcm_color_blind_check(struct rte_meter_trtcm *m,
    struct rte_meter_trtcm_profile *p,
    uint64_t time,
    uint32_t pkt_len)
{
    uint64_t time_diff_tc, time_diff_tp, n_periods_tc, n_periods_tp, tc, tp;

    /* Bucket update */
    time_diff_tc = time - m->time_tc;
    time_diff_tp = time - m->time_tp;
    n_periods_tc = time_diff_tc / p->cir_period;
    n_periods_tp = time_diff_tp / p->pir_period;
    m->time_tc += n_periods_tc * p->cir_period;
    m->time_tp += n_periods_tp * p->pir_period;

    tc = m->tc + n_periods_tc * p->cir_bytes_per_period;
    if (tc > p->cbs)
        tc = p->cbs;

    tp = m->tp + n_periods_tp * p->pir_bytes_per_period;
    if (tp > p->pbs)
        tp = p->pbs;

    /* Color logic */
    if (tp < pkt_len) {
        m->tc = tc;
        m->tp = tp;
        return RTE_COLOR_RED;
    }

    if (tc < pkt_len) {
        m->tc = tc;
        m->tp = tp - pkt_len;
        return RTE_COLOR_YELLOW;
    }

    m->tc = tc - pkt_len;
    m->tp = tp - pkt_len;
    return RTE_COLOR_GREEN;
}

static inline enum rte_color
rte_meter_trtcm_color_aware_check(struct rte_meter_trtcm *m,
    struct rte_meter_trtcm_profile *p,
    uint64_t time,
    uint32_t pkt_len,
    enum rte_color pkt_color)
{
    uint64_t time_diff_tc, time_diff_tp, n_periods_tc, n_periods_tp, tc, tp;

    /* Bucket update */
    time_diff_tc = time - m->time_tc;
    time_diff_tp = time - m->time_tp;
    n_periods_tc = time_diff_tc / p->cir_period;
    n_periods_tp = time_diff_tp / p->pir_period;
    m->time_tc += n_periods_tc * p->cir_period;
    m->time_tp += n_periods_tp * p->pir_period;

    tc = m->tc + n_periods_tc * p->cir_bytes_per_period;
    if (tc > p->cbs)
        tc = p->cbs;

    tp = m->tp + n_periods_tp * p->pir_bytes_per_period;
    if (tp > p->pbs)
        tp = p->pbs;

    /* Color logic */
    if ((pkt_color == RTE_COLOR_RED) || (tp < pkt_len)) {
        m->tc = tc;
        m->tp = tp;
        return RTE_COLOR_RED;
    }

    if ((pkt_color == RTE_COLOR_YELLOW) || (tc < pkt_len)) {
        m->tc = tc;
        m->tp = tp - pkt_len;
        return RTE_COLOR_YELLOW;
    }

    m->tc = tc - pkt_len;
    m->tp = tp - pkt_len;
    return RTE_COLOR_GREEN;
}

static inline enum rte_color
rte_meter_trtcm_rfc4115_color_blind_check(
    struct rte_meter_trtcm_rfc4115 *m,
    struct rte_meter_trtcm_rfc4115_profile *p,
    uint64_t time,
    uint32_t pkt_len)
{
    uint64_t time_diff_tc, time_diff_te, n_periods_tc, n_periods_te, tc, te;

    /* Bucket update */
    time_diff_tc = time - m->time_tc;
    time_diff_te = time - m->time_te;
    n_periods_tc = time_diff_tc / p->cir_period;
    n_periods_te = time_diff_te / p->eir_period;
    m->time_tc += n_periods_tc * p->cir_period;
    m->time_te += n_periods_te * p->eir_period;

    tc = m->tc + n_periods_tc * p->cir_bytes_per_period;
    if (tc > p->cbs)
        tc = p->cbs;

    te = m->te + n_periods_te * p->eir_bytes_per_period;
    if (te > p->ebs)
        te = p->ebs;

    /* Color logic */
    if (tc >= pkt_len) {
        m->tc = tc - pkt_len;
        m->te = te;
        return RTE_COLOR_GREEN;
    }
    if (te >= pkt_len) {
        m->tc = tc;
        m->te = te - pkt_len;
        return RTE_COLOR_YELLOW;
    }

    /* If we end up here the color is RED */
    m->tc = tc;
    m->te = te;
    return RTE_COLOR_RED;
}

static inline enum rte_color
rte_meter_trtcm_rfc4115_color_aware_check(
    struct rte_meter_trtcm_rfc4115 *m,
    struct rte_meter_trtcm_rfc4115_profile *p,
    uint64_t time,
    uint32_t pkt_len,
    enum rte_color pkt_color)
{
    uint64_t time_diff_tc, time_diff_te, n_periods_tc, n_periods_te, tc, te;

    /* Bucket update */
    time_diff_tc = time - m->time_tc;
    time_diff_te = time - m->time_te;
    n_periods_tc = time_diff_tc / p->cir_period;
    n_periods_te = time_diff_te / p->eir_period;
    m->time_tc += n_periods_tc * p->cir_period;
    m->time_te += n_periods_te * p->eir_period;

    tc = m->tc + n_periods_tc * p->cir_bytes_per_period;
    if (tc > p->cbs)
        tc = p->cbs;

    te = m->te + n_periods_te * p->eir_bytes_per_period;
    if (te > p->ebs)
        te = p->ebs;

    /* Color logic */
    if ((pkt_color == RTE_COLOR_GREEN) && (tc >= pkt_len)) {
        m->tc = tc - pkt_len;
        m->te = te;
        return RTE_COLOR_GREEN;
    }

    if ((pkt_color != RTE_COLOR_RED) && (te >= pkt_len)) {
        m->tc = tc;
        m->te = te - pkt_len;
        return RTE_COLOR_YELLOW;
    }

    /* If we end up here the color is RED */
    m->tc = tc;
    m->te = te;
    return RTE_COLOR_RED;
}


#ifdef __cplusplus
}
#endif

#endif /* __INCLUDE_RTE_METER_H__ */