examples/l3fwd/l3fwd_lpm.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2016 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 #include <stdio.h>
  35 #include <stdlib.h>
  36 #include <stdint.h>
  37 #include <inttypes.h>
  38 #include <sys/types.h>
  39 #include <string.h>
  40 #include <sys/queue.h>
  41 #include <stdarg.h>
  42 #include <errno.h>
  43 #include <getopt.h>
  44 #include <stdbool.h>
  45
  46 #include <rte_debug.h>
  47 #include <rte_ether.h>
  48 #include <rte_ethdev.h>
  49 #include <rte_mempool.h>
  50 #include <rte_cycles.h>
  51 #include <rte_mbuf.h>
  52 #include <rte_ip.h>
  53 #include <rte_tcp.h>
  54 #include <rte_udp.h>
  55 #include <rte_lpm.h>
  56 #include <rte_lpm6.h>
  57
  58 #include "l3fwd.h"
  59
  60 struct ipv4_l3fwd_lpm_route {
  61         uint32_t ip;
  62         uint8_t  depth;
  63         uint8_t  if_out;
  64 };
  65
  66 struct ipv6_l3fwd_lpm_route {
  67         uint8_t ip[16];
  68         uint8_t  depth;
  69         uint8_t  if_out;
  70 };
  71
  72 static struct ipv4_l3fwd_lpm_route ipv4_l3fwd_lpm_route_array[] = {
  73         {IPv4(1, 1, 1, 0), 24, 0},
  74         {IPv4(2, 1, 1, 0), 24, 1},
  75         {IPv4(3, 1, 1, 0), 24, 2},
  76         {IPv4(4, 1, 1, 0), 24, 3},
  77         {IPv4(5, 1, 1, 0), 24, 4},
  78         {IPv4(6, 1, 1, 0), 24, 5},
  79         {IPv4(7, 1, 1, 0), 24, 6},
  80         {IPv4(8, 1, 1, 0), 24, 7},
  81 };
  82
  83 static struct ipv6_l3fwd_lpm_route ipv6_l3fwd_lpm_route_array[] = {
  84         {{1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1}, 48, 0},
  85         {{2, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1}, 48, 1},
  86         {{3, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1}, 48, 2},
  87         {{4, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1}, 48, 3},
  88         {{5, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1}, 48, 4},
  89         {{6, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1}, 48, 5},
  90         {{7, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1}, 48, 6},
  91         {{8, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1}, 48, 7},
  92 };
  93
  94 #define IPV4_L3FWD_LPM_NUM_ROUTES \
  95         (sizeof(ipv4_l3fwd_lpm_route_array) / sizeof(ipv4_l3fwd_lpm_route_array[0]))
  96 #define IPV6_L3FWD_LPM_NUM_ROUTES \
  97         (sizeof(ipv6_l3fwd_lpm_route_array) / sizeof(ipv6_l3fwd_lpm_route_array[0]))
  98
  99 #define IPV4_L3FWD_LPM_MAX_RULES         1024
 100 #define IPV4_L3FWD_LPM_NUMBER_TBL8S (1 << 8)
 101 #define IPV6_L3FWD_LPM_MAX_RULES         1024
 102 #define IPV6_L3FWD_LPM_NUMBER_TBL8S (1 << 16)
 103
 104 struct rte_lpm *ipv4_l3fwd_lpm_lookup_struct[NB_SOCKETS];
 105 struct rte_lpm6 *ipv6_l3fwd_lpm_lookup_struct[NB_SOCKETS];
 106
 107 static inline uint16_t
 108 lpm_get_ipv4_dst_port(void *ipv4_hdr,  uint8_t portid, void *lookup_struct)
 109 {
 110         uint32_t next_hop;
 111         struct rte_lpm *ipv4_l3fwd_lookup_struct =
 112                 (struct rte_lpm *)lookup_struct;
 113
 114         return (uint16_t) ((rte_lpm_lookup(ipv4_l3fwd_lookup_struct,
 115                 rte_be_to_cpu_32(((struct ipv4_hdr *)ipv4_hdr)->dst_addr),
 116                 &next_hop) == 0) ? next_hop : portid);
 117 }
 118
 119 static inline uint16_t
 120 lpm_get_ipv6_dst_port(void *ipv6_hdr,  uint8_t portid, void *lookup_struct)
 121 {
 122         uint32_t next_hop;
 123         struct rte_lpm6 *ipv6_l3fwd_lookup_struct =
 124                 (struct rte_lpm6 *)lookup_struct;
 125
 126         return (uint16_t) ((rte_lpm6_lookup(ipv6_l3fwd_lookup_struct,
 127                         ((struct ipv6_hdr *)ipv6_hdr)->dst_addr,
 128                         &next_hop) == 0) ?  next_hop : portid);
 129 }
 130
 131 static __rte_always_inline uint16_t
 132 lpm_get_dst_port(const struct lcore_conf *qconf, struct rte_mbuf *pkt,
 133                 uint8_t portid)
 134 {
 135         struct ipv6_hdr *ipv6_hdr;
 136         struct ipv4_hdr *ipv4_hdr;
 137         struct ether_hdr *eth_hdr;
 138
 139         if (RTE_ETH_IS_IPV4_HDR(pkt->packet_type)) {
 140
 141                 eth_hdr = rte_pktmbuf_mtod(pkt, struct ether_hdr *);
 142                 ipv4_hdr = (struct ipv4_hdr *)(eth_hdr + 1);
 143
 144                 return lpm_get_ipv4_dst_port(ipv4_hdr, portid,
 145                                              qconf->ipv4_lookup_struct);
 146         } else if (RTE_ETH_IS_IPV6_HDR(pkt->packet_type)) {
 147
 148                 eth_hdr = rte_pktmbuf_mtod(pkt, struct ether_hdr *);
 149                 ipv6_hdr = (struct ipv6_hdr *)(eth_hdr + 1);
 150
 151                 return lpm_get_ipv6_dst_port(ipv6_hdr, portid,
 152                                              qconf->ipv6_lookup_struct);
 153         }
 154
 155         return portid;
 156 }
 157
 158 /*
 159  * lpm_get_dst_port optimized routine for packets where dst_ipv4 is already
 160  * precalculated. If packet is ipv6 dst_addr is taken directly from packet
 161  * header and dst_ipv4 value is not used.
 162  */
 163 static __rte_always_inline uint16_t
 164 lpm_get_dst_port_with_ipv4(const struct lcore_conf *qconf, struct rte_mbuf *pkt,
 165         uint32_t dst_ipv4, uint8_t portid)
 166 {
 167         uint32_t next_hop;
 168         struct ipv6_hdr *ipv6_hdr;
 169         struct ether_hdr *eth_hdr;
 170
 171         if (RTE_ETH_IS_IPV4_HDR(pkt->packet_type)) {
 172                 return (uint16_t) ((rte_lpm_lookup(qconf->ipv4_lookup_struct,
 173                                                    dst_ipv4, &next_hop) == 0)
 174                                    ? next_hop : portid);
 175
 176         } else if (RTE_ETH_IS_IPV6_HDR(pkt->packet_type)) {
 177
 178                 eth_hdr = rte_pktmbuf_mtod(pkt, struct ether_hdr *);
 179                 ipv6_hdr = (struct ipv6_hdr *)(eth_hdr + 1);
 180
 181                 return (uint16_t) ((rte_lpm6_lookup(qconf->ipv6_lookup_struct,
 182                                 ipv6_hdr->dst_addr, &next_hop) == 0)
 183                                 ? next_hop : portid);
 184
 185         }
 186
 187         return portid;
 188 }
 189
 190 #if defined(RTE_ARCH_X86)
 191 #include "l3fwd_lpm_sse.h"
 192 #else
 193 #include "l3fwd_lpm.h"
 194 #endif
 195
 196 /* main processing loop */
 197 int
 198 lpm_main_loop(__attribute__((unused)) void *dummy)
 199 {
 200         struct rte_mbuf *pkts_burst[MAX_PKT_BURST];
 201         unsigned lcore_id;
 202         uint64_t prev_tsc, diff_tsc, cur_tsc;
 203         int i, nb_rx;
 204         uint8_t portid, queueid;
 205         struct lcore_conf *qconf;
 206         const uint64_t drain_tsc = (rte_get_tsc_hz() + US_PER_S - 1) /
 207                 US_PER_S * BURST_TX_DRAIN_US;
 208
 209         prev_tsc = 0;
 210
 211         lcore_id = rte_lcore_id();
 212         qconf = &lcore_conf[lcore_id];
 213
 214         if (qconf->n_rx_queue == 0) {
 215                 RTE_LOG(INFO, L3FWD, "lcore %u has nothing to do\n", lcore_id);
 216                 return 0;
 217         }
 218
 219         RTE_LOG(INFO, L3FWD, "entering main loop on lcore %u\n", lcore_id);
 220
 221         for (i = 0; i < qconf->n_rx_queue; i++) {
 222
 223                 portid = qconf->rx_queue_list[i].port_id;
 224                 queueid = qconf->rx_queue_list[i].queue_id;
 225                 RTE_LOG(INFO, L3FWD,
 226                         " -- lcoreid=%u portid=%hhu rxqueueid=%hhu\n",
 227                         lcore_id, portid, queueid);
 228         }
 229
 230         while (!force_quit) {
 231
 232                 cur_tsc = rte_rdtsc();
 233
 234                 /*
 235                  * TX burst queue drain
 236                  */
 237                 diff_tsc = cur_tsc - prev_tsc;
 238                 if (unlikely(diff_tsc > drain_tsc)) {
 239
 240                         for (i = 0; i < qconf->n_tx_port; ++i) {
 241                                 portid = qconf->tx_port_id[i];
 242                                 if (qconf->tx_mbufs[portid].len == 0)
 243                                         continue;
 244                                 send_burst(qconf,
 245                                         qconf->tx_mbufs[portid].len,
 246                                         portid);
 247                                 qconf->tx_mbufs[portid].len = 0;
 248                         }
 249
 250                         prev_tsc = cur_tsc;
 251                 }
 252
 253                 /*
 254                  * Read packet from RX queues
 255                  */
 256                 for (i = 0; i < qconf->n_rx_queue; ++i) {
 257                         portid = qconf->rx_queue_list[i].port_id;
 258                         queueid = qconf->rx_queue_list[i].queue_id;
 259                         nb_rx = rte_eth_rx_burst(portid, queueid, pkts_burst,
 260                                 MAX_PKT_BURST);
 261                         if (nb_rx == 0)
 262                                 continue;
 263
 264 #if defined(RTE_ARCH_X86)
 265                         l3fwd_lpm_send_packets(nb_rx, pkts_burst,
 266                                                 portid, qconf);
 267 #else
 268                         l3fwd_lpm_no_opt_send_packets(nb_rx, pkts_burst,
 269                                                         portid, qconf);
 270 #endif /* X86 */
 271                 }
 272         }
 273
 274         return 0;
 275 }
 276
 277 void
 278 setup_lpm(const int socketid)
 279 {
 280         struct rte_lpm6_config config;
 281         struct rte_lpm_config config_ipv4;
 282         unsigned i;
 283         int ret;
 284         char s[64];
 285
 286         /* create the LPM table */
 287         config_ipv4.max_rules = IPV4_L3FWD_LPM_MAX_RULES;
 288         config_ipv4.number_tbl8s = IPV4_L3FWD_LPM_NUMBER_TBL8S;
 289         config_ipv4.flags = 0;
 290         snprintf(s, sizeof(s), "IPV4_L3FWD_LPM_%d", socketid);
 291         ipv4_l3fwd_lpm_lookup_struct[socketid] =
 292                         rte_lpm_create(s, socketid, &config_ipv4);
 293         if (ipv4_l3fwd_lpm_lookup_struct[socketid] == NULL)
 294                 rte_exit(EXIT_FAILURE,
 295                         "Unable to create the l3fwd LPM table on socket %d\n",
 296                         socketid);
 297
 298         /* populate the LPM table */
 299         for (i = 0; i < IPV4_L3FWD_LPM_NUM_ROUTES; i++) {
 300
 301                 /* skip unused ports */
 302                 if ((1 << ipv4_l3fwd_lpm_route_array[i].if_out &
 303                                 enabled_port_mask) == 0)
 304                         continue;
 305
 306                 ret = rte_lpm_add(ipv4_l3fwd_lpm_lookup_struct[socketid],
 307                         ipv4_l3fwd_lpm_route_array[i].ip,
 308                         ipv4_l3fwd_lpm_route_array[i].depth,
 309                         ipv4_l3fwd_lpm_route_array[i].if_out);
 310
 311                 if (ret < 0) {
 312                         rte_exit(EXIT_FAILURE,
 313                                 "Unable to add entry %u to the l3fwd LPM table on socket %d\n",
 314                                 i, socketid);
 315                 }
 316
 317                 printf("LPM: Adding route 0x%08x / %d (%d)\n",
 318                         (unsigned)ipv4_l3fwd_lpm_route_array[i].ip,
 319                         ipv4_l3fwd_lpm_route_array[i].depth,
 320                         ipv4_l3fwd_lpm_route_array[i].if_out);
 321         }
 322
 323         /* create the LPM6 table */
 324         snprintf(s, sizeof(s), "IPV6_L3FWD_LPM_%d", socketid);
 325
 326         config.max_rules = IPV6_L3FWD_LPM_MAX_RULES;
 327         config.number_tbl8s = IPV6_L3FWD_LPM_NUMBER_TBL8S;
 328         config.flags = 0;
 329         ipv6_l3fwd_lpm_lookup_struct[socketid] = rte_lpm6_create(s, socketid,
 330                                 &config);
 331         if (ipv6_l3fwd_lpm_lookup_struct[socketid] == NULL)
 332                 rte_exit(EXIT_FAILURE,
 333                         "Unable to create the l3fwd LPM table on socket %d\n",
 334                         socketid);
 335
 336         /* populate the LPM table */
 337         for (i = 0; i < IPV6_L3FWD_LPM_NUM_ROUTES; i++) {
 338
 339                 /* skip unused ports */
 340                 if ((1 << ipv6_l3fwd_lpm_route_array[i].if_out &
 341                                 enabled_port_mask) == 0)
 342                         continue;
 343
 344                 ret = rte_lpm6_add(ipv6_l3fwd_lpm_lookup_struct[socketid],
 345                         ipv6_l3fwd_lpm_route_array[i].ip,
 346                         ipv6_l3fwd_lpm_route_array[i].depth,
 347                         ipv6_l3fwd_lpm_route_array[i].if_out);
 348
 349                 if (ret < 0) {
 350                         rte_exit(EXIT_FAILURE,
 351                                 "Unable to add entry %u to the l3fwd LPM table on socket %d\n",
 352                                 i, socketid);
 353                 }
 354
 355                 printf("LPM: Adding route %s / %d (%d)\n",
 356                         "IPV6",
 357                         ipv6_l3fwd_lpm_route_array[i].depth,
 358                         ipv6_l3fwd_lpm_route_array[i].if_out);
 359         }
 360 }
 361
 362 int
 363 lpm_check_ptype(int portid)
 364 {
 365         int i, ret;
 366         int ptype_l3_ipv4 = 0, ptype_l3_ipv6 = 0;
 367         uint32_t ptype_mask = RTE_PTYPE_L3_MASK;
 368
 369         ret = rte_eth_dev_get_supported_ptypes(portid, ptype_mask, NULL, 0);
 370         if (ret <= 0)
 371                 return 0;
 372
 373         uint32_t ptypes[ret];
 374
 375         ret = rte_eth_dev_get_supported_ptypes(portid, ptype_mask, ptypes, ret);
 376         for (i = 0; i < ret; ++i) {
 377                 if (ptypes[i] & RTE_PTYPE_L3_IPV4)
 378                         ptype_l3_ipv4 = 1;
 379                 if (ptypes[i] & RTE_PTYPE_L3_IPV6)
 380                         ptype_l3_ipv6 = 1;
 381         }
 382
 383         if (ptype_l3_ipv4 == 0)
 384                 printf("port %d cannot parse RTE_PTYPE_L3_IPV4\n", portid);
 385
 386         if (ptype_l3_ipv6 == 0)
 387                 printf("port %d cannot parse RTE_PTYPE_L3_IPV6\n", portid);
 388
 389         if (ptype_l3_ipv4 && ptype_l3_ipv6)
 390                 return 1;
 391
 392         return 0;
 393
 394 }
 395
 396 static inline void
 397 lpm_parse_ptype(struct rte_mbuf *m)
 398 {
 399         struct ether_hdr *eth_hdr;
 400         uint32_t packet_type = RTE_PTYPE_UNKNOWN;
 401         uint16_t ether_type;
 402
 403         eth_hdr = rte_pktmbuf_mtod(m, struct ether_hdr *);
 404         ether_type = eth_hdr->ether_type;
 405         if (ether_type == rte_cpu_to_be_16(ETHER_TYPE_IPv4))
 406                 packet_type |= RTE_PTYPE_L3_IPV4_EXT_UNKNOWN;
 407         else if (ether_type == rte_cpu_to_be_16(ETHER_TYPE_IPv6))
 408                 packet_type |= RTE_PTYPE_L3_IPV6_EXT_UNKNOWN;
 409
 410         m->packet_type = packet_type;
 411 }
 412
 413 uint16_t
 414 lpm_cb_parse_ptype(uint8_t port __rte_unused, uint16_t queue __rte_unused,
 415                    struct rte_mbuf *pkts[], uint16_t nb_pkts,
 416                    uint16_t max_pkts __rte_unused,
 417                    void *user_param __rte_unused)
 418 {
 419         unsigned i;
 420
 421         for (i = 0; i < nb_pkts; ++i)
 422                 lpm_parse_ptype(pkts[i]);
 423
 424         return nb_pkts;
 425 }
 426
 427 /* Return ipv4/ipv6 lpm fwd lookup struct. */
 428 void *
 429 lpm_get_ipv4_l3fwd_lookup_struct(const int socketid)
 430 {
 431         return ipv4_l3fwd_lpm_lookup_struct[socketid];
 432 }
 433
 434 void *
 435 lpm_get_ipv6_l3fwd_lookup_struct(const int socketid)
 436 {
 437         return ipv6_l3fwd_lpm_lookup_struct[socketid];
 438 }