examples/qos_meter/rte_policer.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef __INCLUDE_RTE_POLICER_H__
  35 #define __INCLUDE_RTE_POLICER_H__
  36
  37 #include <stdint.h>
  38 #include <rte_meter.h>
  39
  40 enum rte_phb_action {
  41         e_RTE_PHB_ACTION_GREEN = e_RTE_METER_GREEN,
  42         e_RTE_PHB_ACTION_YELLOW = e_RTE_METER_YELLOW,
  43         e_RTE_PHB_ACTION_RED = e_RTE_METER_RED,
  44         e_RTE_PHB_ACTION_DROP = 3,
  45 };
  46
  47 struct rte_phb {
  48         enum rte_phb_action actions[e_RTE_METER_COLORS][e_RTE_METER_COLORS];
  49 };
  50
  51 int
  52 rte_phb_config(struct rte_phb *phb_table, uint32_t phb_table_index,
  53         enum rte_meter_color pre_meter, enum rte_meter_color post_meter, enum rte_phb_action action);
  54
  55 static inline enum rte_phb_action
  56 policer_run(struct rte_phb *phb_table, uint32_t phb_table_index, enum rte_meter_color pre_meter, enum rte_meter_color post_meter)
  57 {
  58         struct rte_phb *phb = &phb_table[phb_table_index];
  59         enum rte_phb_action action = phb->actions[pre_meter][post_meter];
  60
  61         return action;
  62 }
  63
  64 #endif