examples/l3fwd/l3fwd.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2021 Intel Corporation
   3  */
   4
   5 #ifndef __L3_FWD_H__
   6 #define __L3_FWD_H__
   7
   8 #include <rte_ethdev.h>
   9 #include <rte_vect.h>
  10
  11 #define DO_RFC_1812_CHECKS
  12
  13 #define RTE_LOGTYPE_L3FWD RTE_LOGTYPE_USER1
  14
  15 #if !defined(NO_HASH_MULTI_LOOKUP) && defined(__ARM_NEON)
  16 #define NO_HASH_MULTI_LOOKUP 1
  17 #endif
  18
  19 /*
  20  * Configurable number of RX/TX ring descriptors
  21  */
  22 #define RTE_TEST_RX_DESC_DEFAULT 1024
  23 #define RTE_TEST_TX_DESC_DEFAULT 1024
  24
  25 #define MAX_PKT_BURST     32
  26 #define BURST_TX_DRAIN_US 100 /* TX drain every ~100us */
  27
  28 #define MEMPOOL_CACHE_SIZE 256
  29 #define MAX_RX_QUEUE_PER_LCORE 16
  30
  31 #define VECTOR_SIZE_DEFAULT   MAX_PKT_BURST
  32 #define VECTOR_TMO_NS_DEFAULT 1E6 /* 1ms */
  33 /*
  34  * Try to avoid TX buffering if we have at least MAX_TX_BURST packets to send.
  35  */
  36 #define MAX_TX_BURST      (MAX_PKT_BURST / 2)
  37
  38 #define NB_SOCKETS        8
  39
  40 /* Configure how many packets ahead to prefetch, when reading packets */
  41 #define PREFETCH_OFFSET   3
  42
  43 /* Used to mark destination port as 'invalid'. */
  44 #define BAD_PORT ((uint16_t)-1)
  45
  46 #define FWDSTEP 4
  47
  48 /* replace first 12B of the ethernet header. */
  49 #define MASK_ETH 0x3f
  50
  51 /* Hash parameters. */
  52 #ifdef RTE_ARCH_64
  53 /* default to 4 million hash entries (approx) */
  54 #define L3FWD_HASH_ENTRIES              (1024*1024*4)
  55 #else
  56 /* 32-bit has less address-space for hugepage memory, limit to 1M entries */
  57 #define L3FWD_HASH_ENTRIES              (1024*1024*1)
  58 #endif
  59 #define HASH_ENTRY_NUMBER_DEFAULT       16
  60
  61 struct mbuf_table {
  62         uint16_t len;
  63         struct rte_mbuf *m_table[MAX_PKT_BURST];
  64 };
  65
  66 struct lcore_rx_queue {
  67         uint16_t port_id;
  68         uint8_t queue_id;
  69 } __rte_cache_aligned;
  70
  71 struct lcore_conf {
  72         uint16_t n_rx_queue;
  73         struct lcore_rx_queue rx_queue_list[MAX_RX_QUEUE_PER_LCORE];
  74         uint16_t n_tx_port;
  75         uint16_t tx_port_id[RTE_MAX_ETHPORTS];
  76         uint16_t tx_queue_id[RTE_MAX_ETHPORTS];
  77         struct mbuf_table tx_mbufs[RTE_MAX_ETHPORTS];
  78         void *ipv4_lookup_struct;
  79         void *ipv6_lookup_struct;
  80 } __rte_cache_aligned;
  81
  82 extern volatile bool force_quit;
  83
  84 /* ethernet addresses of ports */
  85 extern uint64_t dest_eth_addr[RTE_MAX_ETHPORTS];
  86 extern struct rte_ether_addr ports_eth_addr[RTE_MAX_ETHPORTS];
  87
  88 /* mask of enabled ports */
  89 extern uint32_t enabled_port_mask;
  90
  91 /* Used only in exact match mode. */
  92 extern int ipv6; /**< ipv6 is false by default. */
  93 extern uint32_t hash_entry_number;
  94
  95 extern xmm_t val_eth[RTE_MAX_ETHPORTS];
  96
  97 extern struct lcore_conf lcore_conf[RTE_MAX_LCORE];
  98
  99 /* Send burst of packets on an output interface */
 100 static inline int
 101 send_burst(struct lcore_conf *qconf, uint16_t n, uint16_t port)
 102 {
 103         struct rte_mbuf **m_table;
 104         int ret;
 105         uint16_t queueid;
 106
 107         queueid = qconf->tx_queue_id[port];
 108         m_table = (struct rte_mbuf **)qconf->tx_mbufs[port].m_table;
 109
 110         ret = rte_eth_tx_burst(port, queueid, m_table, n);
 111         if (unlikely(ret < n)) {
 112                 do {
 113                         rte_pktmbuf_free(m_table[ret]);
 114                 } while (++ret < n);
 115         }
 116
 117         return 0;
 118 }
 119
 120 /* Enqueue a single packet, and send burst if queue is filled */
 121 static inline int
 122 send_single_packet(struct lcore_conf *qconf,
 123                    struct rte_mbuf *m, uint16_t port)
 124 {
 125         uint16_t len;
 126
 127         len = qconf->tx_mbufs[port].len;
 128         qconf->tx_mbufs[port].m_table[len] = m;
 129         len++;
 130
 131         /* enough pkts to be sent */
 132         if (unlikely(len == MAX_PKT_BURST)) {
 133                 send_burst(qconf, MAX_PKT_BURST, port);
 134                 len = 0;
 135         }
 136
 137         qconf->tx_mbufs[port].len = len;
 138         return 0;
 139 }
 140
 141 #ifdef DO_RFC_1812_CHECKS
 142 static inline int
 143 is_valid_ipv4_pkt(struct rte_ipv4_hdr *pkt, uint32_t link_len)
 144 {
 145         /* From http://www.rfc-editor.org/rfc/rfc1812.txt section 5.2.2 */
 146         /*
 147          * 1. The packet length reported by the Link Layer must be large
 148          * enough to hold the minimum length legal IP datagram (20 bytes).
 149          */
 150         if (link_len < sizeof(struct rte_ipv4_hdr))
 151                 return -1;
 152
 153         /* 2. The IP checksum must be correct. */
 154         /* this is checked in H/W */
 155
 156         /*
 157          * 3. The IP version number must be 4. If the version number is not 4
 158          * then the packet may be another version of IP, such as IPng or
 159          * ST-II.
 160          */
 161         if (((pkt->version_ihl) >> 4) != 4)
 162                 return -3;
 163         /*
 164          * 4. The IP header length field must be large enough to hold the
 165          * minimum length legal IP datagram (20 bytes = 5 words).
 166          */
 167         if ((pkt->version_ihl & 0xf) < 5)
 168                 return -4;
 169
 170         /*
 171          * 5. The IP total length field must be large enough to hold the IP
 172          * datagram header, whose length is specified in the IP header length
 173          * field.
 174          */
 175         if (rte_cpu_to_be_16(pkt->total_length) < sizeof(struct rte_ipv4_hdr))
 176                 return -5;
 177
 178         return 0;
 179 }
 180 #endif /* DO_RFC_1812_CHECKS */
 181
 182 int
 183 init_mem(uint16_t portid, unsigned int nb_mbuf);
 184
 185 /* Function pointers for LPM, EM or FIB functionality. */
 186 void
 187 setup_lpm(const int socketid);
 188
 189 void
 190 setup_hash(const int socketid);
 191
 192 void
 193 setup_fib(const int socketid);
 194
 195 int
 196 em_check_ptype(int portid);
 197
 198 int
 199 lpm_check_ptype(int portid);
 200
 201 uint16_t
 202 em_cb_parse_ptype(uint16_t port, uint16_t queue, struct rte_mbuf *pkts[],
 203                   uint16_t nb_pkts, uint16_t max_pkts, void *user_param);
 204
 205 uint16_t
 206 lpm_cb_parse_ptype(uint16_t port, uint16_t queue, struct rte_mbuf *pkts[],
 207                    uint16_t nb_pkts, uint16_t max_pkts, void *user_param);
 208
 209 int
 210 em_main_loop(__rte_unused void *dummy);
 211
 212 int
 213 lpm_main_loop(__rte_unused void *dummy);
 214
 215 int
 216 fib_main_loop(__rte_unused void *dummy);
 217
 218 int
 219 lpm_event_main_loop_tx_d(__rte_unused void *dummy);
 220 int
 221 lpm_event_main_loop_tx_d_burst(__rte_unused void *dummy);
 222 int
 223 lpm_event_main_loop_tx_q(__rte_unused void *dummy);
 224 int
 225 lpm_event_main_loop_tx_q_burst(__rte_unused void *dummy);
 226 int
 227 lpm_event_main_loop_tx_d_vector(__rte_unused void *dummy);
 228 int
 229 lpm_event_main_loop_tx_d_burst_vector(__rte_unused void *dummy);
 230 int
 231 lpm_event_main_loop_tx_q_vector(__rte_unused void *dummy);
 232 int
 233 lpm_event_main_loop_tx_q_burst_vector(__rte_unused void *dummy);
 234
 235 int
 236 em_event_main_loop_tx_d(__rte_unused void *dummy);
 237 int
 238 em_event_main_loop_tx_d_burst(__rte_unused void *dummy);
 239 int
 240 em_event_main_loop_tx_q(__rte_unused void *dummy);
 241 int
 242 em_event_main_loop_tx_q_burst(__rte_unused void *dummy);
 243 int
 244 em_event_main_loop_tx_d_vector(__rte_unused void *dummy);
 245 int
 246 em_event_main_loop_tx_d_burst_vector(__rte_unused void *dummy);
 247 int
 248 em_event_main_loop_tx_q_vector(__rte_unused void *dummy);
 249 int
 250 em_event_main_loop_tx_q_burst_vector(__rte_unused void *dummy);
 251
 252 int
 253 fib_event_main_loop_tx_d(__rte_unused void *dummy);
 254 int
 255 fib_event_main_loop_tx_d_burst(__rte_unused void *dummy);
 256 int
 257 fib_event_main_loop_tx_q(__rte_unused void *dummy);
 258 int
 259 fib_event_main_loop_tx_q_burst(__rte_unused void *dummy);
 260 int
 261 fib_event_main_loop_tx_d_vector(__rte_unused void *dummy);
 262 int
 263 fib_event_main_loop_tx_d_burst_vector(__rte_unused void *dummy);
 264 int
 265 fib_event_main_loop_tx_q_vector(__rte_unused void *dummy);
 266 int
 267 fib_event_main_loop_tx_q_burst_vector(__rte_unused void *dummy);
 268
 269
 270 /* Return ipv4/ipv6 fwd lookup struct for LPM, EM or FIB. */
 271 void *
 272 em_get_ipv4_l3fwd_lookup_struct(const int socketid);
 273
 274 void *
 275 em_get_ipv6_l3fwd_lookup_struct(const int socketid);
 276
 277 void *
 278 lpm_get_ipv4_l3fwd_lookup_struct(const int socketid);
 279
 280 void *
 281 lpm_get_ipv6_l3fwd_lookup_struct(const int socketid);
 282
 283 void *
 284 fib_get_ipv4_l3fwd_lookup_struct(const int socketid);
 285
 286 void *
 287 fib_get_ipv6_l3fwd_lookup_struct(const int socketid);
 288
 289 #endif  /* __L3_FWD_H__ */