lib/librte_bitratestats/rte_bitrate.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2017 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 _RTE_BITRATE_H_
  35 #define _RTE_BITRATE_H_
  36
  37 /**
  38  *  Bitrate statistics data structure.
  39  *  This data structure is intentionally opaque.
  40  */
  41 struct rte_stats_bitrates;
  42
  43
  44 /**
  45  * Allocate a bitrate statistics structure
  46  *
  47  * @return
  48  *   - Pointer to structure on success
  49  *   - NULL on error (zmalloc failure)
  50  */
  51 struct rte_stats_bitrates *rte_stats_bitrate_create(void);
  52
  53
  54 /**
  55  * Register bitrate statistics with the metric library.
  56  *
  57  * @param bitrate_data
  58  *   Pointer allocated by rte_stats_create()
  59  *
  60  * @return
  61  *   Zero on success
  62  *   Negative on error
  63  */
  64 int rte_stats_bitrate_reg(struct rte_stats_bitrates *bitrate_data);
  65
  66
  67 /**
  68  * Calculate statistics for current time window. The period with which
  69  * this function is called should be the intended sampling window width.
  70  *
  71  * @param bitrate_data
  72  *   Bitrate statistics data pointer
  73  *
  74  * @param port_id
  75  *   Port id to calculate statistics for
  76  *
  77  * @return
  78  *  - Zero on success
  79  *  - Negative value on error
  80  */
  81 int rte_stats_bitrate_calc(struct rte_stats_bitrates *bitrate_data,
  82         uint8_t port_id);
  83
  84 #endif /* _RTE_BITRATE_H_ */