drivers/net/softnic/rte_eth_softnic_internals.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 __INCLUDE_RTE_ETH_SOFTNIC_INTERNALS_H__
  35 #define __INCLUDE_RTE_ETH_SOFTNIC_INTERNALS_H__
  36
  37 #include <stdint.h>
  38
  39 #include <rte_mbuf.h>
  40 #include <rte_sched.h>
  41 #include <rte_ethdev.h>
  42 #include <rte_tm_driver.h>
  43
  44 #include "rte_eth_softnic.h"
  45
  46 /**
  47  * PMD Parameters
  48  */
  49
  50 enum pmd_feature {
  51         PMD_FEATURE_TM = 1, /**< Traffic Management (TM) */
  52 };
  53
  54 #ifndef INTRUSIVE
  55 #define INTRUSIVE                                       0
  56 #endif
  57
  58 struct pmd_params {
  59         /** Parameters for the soft device (to be created) */
  60         struct {
  61                 const char *name; /**< Name */
  62                 uint32_t flags; /**< Flags */
  63
  64                 /** 0 = Access hard device though API only (potentially slower,
  65                  *      but safer);
  66                  *  1 = Access hard device private data structures is allowed
  67                  *      (potentially faster).
  68                  */
  69                 int intrusive;
  70
  71                 /** Traffic Management (TM) */
  72                 struct {
  73                         uint32_t rate; /**< Rate (bytes/second) */
  74                         uint32_t nb_queues; /**< Number of queues */
  75                         uint16_t qsize[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];
  76                         /**< Queue size per traffic class */
  77                         uint32_t enq_bsz; /**< Enqueue burst size */
  78                         uint32_t deq_bsz; /**< Dequeue burst size */
  79                 } tm;
  80         } soft;
  81
  82         /** Parameters for the hard device (existing) */
  83         struct {
  84                 char *name; /**< Name */
  85                 uint16_t tx_queue_id; /**< TX queue ID */
  86         } hard;
  87 };
  88
  89 /**
  90  * Default Internals
  91  */
  92
  93 #ifndef DEFAULT_BURST_SIZE
  94 #define DEFAULT_BURST_SIZE                              32
  95 #endif
  96
  97 #ifndef FLUSH_COUNT_THRESHOLD
  98 #define FLUSH_COUNT_THRESHOLD                   (1 << 17)
  99 #endif
 100
 101 struct default_internals {
 102         struct rte_mbuf **pkts;
 103         uint32_t pkts_len;
 104         uint32_t txq_pos;
 105         uint32_t flush_count;
 106 };
 107
 108 /**
 109  * Traffic Management (TM) Internals
 110  */
 111
 112 #ifndef TM_MAX_SUBPORTS
 113 #define TM_MAX_SUBPORTS                                 8
 114 #endif
 115
 116 #ifndef TM_MAX_PIPES_PER_SUBPORT
 117 #define TM_MAX_PIPES_PER_SUBPORT                        4096
 118 #endif
 119
 120 struct tm_params {
 121         struct rte_sched_port_params port_params;
 122
 123         struct rte_sched_subport_params subport_params[TM_MAX_SUBPORTS];
 124
 125         struct rte_sched_pipe_params
 126                 pipe_profiles[RTE_SCHED_PIPE_PROFILES_PER_PORT];
 127         uint32_t n_pipe_profiles;
 128         uint32_t pipe_to_profile[TM_MAX_SUBPORTS * TM_MAX_PIPES_PER_SUBPORT];
 129 };
 130
 131 /* TM Levels */
 132 enum tm_node_level {
 133         TM_NODE_LEVEL_PORT = 0,
 134         TM_NODE_LEVEL_SUBPORT,
 135         TM_NODE_LEVEL_PIPE,
 136         TM_NODE_LEVEL_TC,
 137         TM_NODE_LEVEL_QUEUE,
 138         TM_NODE_LEVEL_MAX,
 139 };
 140
 141 /* TM Node */
 142 struct tm_node {
 143         TAILQ_ENTRY(tm_node) node;
 144         uint32_t node_id;
 145         uint32_t parent_node_id;
 146         uint32_t priority;
 147         uint32_t weight;
 148         uint32_t level;
 149         struct tm_node *parent_node;
 150         struct rte_tm_node_params params;
 151         struct rte_tm_node_stats stats;
 152         uint32_t n_children;
 153 };
 154
 155 TAILQ_HEAD(tm_node_list, tm_node);
 156
 157 /* TM Hierarchy Specification */
 158 struct tm_hierarchy {
 159         struct tm_node_list nodes;
 160
 161         uint32_t n_tm_nodes[TM_NODE_LEVEL_MAX];
 162 };
 163
 164 struct tm_internals {
 165         /** Hierarchy specification
 166          *
 167          *     -Hierarchy is unfrozen at init and when port is stopped.
 168          *     -Hierarchy is frozen on successful hierarchy commit.
 169          *     -Run-time hierarchy changes are not allowed, therefore it makes
 170          *      sense to keep the hierarchy frozen after the port is started.
 171          */
 172         struct tm_hierarchy h;
 173
 174         /** Blueprints */
 175         struct tm_params params;
 176
 177         /** Run-time */
 178         struct rte_sched_port *sched;
 179         struct rte_mbuf **pkts_enq;
 180         struct rte_mbuf **pkts_deq;
 181         uint32_t pkts_enq_len;
 182         uint32_t txq_pos;
 183         uint32_t flush_count;
 184 };
 185
 186 /**
 187  * PMD Internals
 188  */
 189 struct pmd_internals {
 190         /** Params */
 191         struct pmd_params params;
 192
 193         /** Soft device */
 194         struct {
 195                 struct default_internals def; /**< Default */
 196                 struct tm_internals tm; /**< Traffic Management */
 197         } soft;
 198
 199         /** Hard device */
 200         struct {
 201                 uint16_t port_id;
 202         } hard;
 203 };
 204
 205 struct pmd_rx_queue {
 206         /** Hard device */
 207         struct {
 208                 uint16_t port_id;
 209                 uint16_t rx_queue_id;
 210         } hard;
 211 };
 212
 213 /**
 214  * Traffic Management (TM) Operation
 215  */
 216 extern const struct rte_tm_ops pmd_tm_ops;
 217
 218 int
 219 tm_params_check(struct pmd_params *params, uint32_t hard_rate);
 220
 221 int
 222 tm_init(struct pmd_internals *p, struct pmd_params *params, int numa_node);
 223
 224 void
 225 tm_free(struct pmd_internals *p);
 226
 227 int
 228 tm_start(struct pmd_internals *p);
 229
 230 void
 231 tm_stop(struct pmd_internals *p);
 232
 233 static inline int
 234 tm_enabled(struct rte_eth_dev *dev)
 235 {
 236         struct pmd_internals *p = dev->data->dev_private;
 237
 238         return (p->params.soft.flags & PMD_FEATURE_TM);
 239 }
 240
 241 static inline int
 242 tm_used(struct rte_eth_dev *dev)
 243 {
 244         struct pmd_internals *p = dev->data->dev_private;
 245
 246         return (p->params.soft.flags & PMD_FEATURE_TM) &&
 247                 p->soft.tm.h.n_tm_nodes[TM_NODE_LEVEL_PORT];
 248 }
 249
 250 #endif /* __INCLUDE_RTE_ETH_SOFTNIC_INTERNALS_H__ */