examples/tep_termination/vxlan_setup.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2015 Intel Corporation
   3  */
   4
   5 #include <getopt.h>
   6 #include <linux/if_ether.h>
   7 #include <linux/if_vlan.h>
   8 #include <linux/virtio_net.h>
   9 #include <linux/virtio_ring.h>
  10 #include <sys/param.h>
  11 #include <unistd.h>
  12
  13 #include <rte_ethdev.h>
  14 #include <rte_log.h>
  15 #include <rte_string_fns.h>
  16 #include <rte_mbuf.h>
  17 #include <rte_malloc.h>
  18 #include <rte_ip.h>
  19 #include <rte_udp.h>
  20 #include <rte_tcp.h>
  21
  22 #include "main.h"
  23 #include "rte_vhost.h"
  24 #include "vxlan.h"
  25 #include "vxlan_setup.h"
  26
  27 #define IPV4_HEADER_LEN 20
  28 #define UDP_HEADER_LEN  8
  29 #define VXLAN_HEADER_LEN 8
  30
  31 #define IP_VERSION 0x40
  32 #define IP_HDRLEN  0x05 /* default IP header length == five 32-bits words. */
  33 #define IP_DEFTTL  64   /* from RFC 1340. */
  34 #define IP_VHL_DEF (IP_VERSION | IP_HDRLEN)
  35
  36 #define IP_DN_FRAGMENT_FLAG 0x0040
  37
  38 /* Used to compare MAC addresses. */
  39 #define MAC_ADDR_CMP 0xFFFFFFFFFFFFULL
  40
  41 /* Configurable number of RX/TX ring descriptors */
  42 #define RTE_TEST_RX_DESC_DEFAULT 1024
  43 #define RTE_TEST_TX_DESC_DEFAULT 512
  44
  45 /* Default inner VLAN ID */
  46 #define INNER_VLAN_ID 100
  47
  48 /* VXLAN device */
  49 struct vxlan_conf vxdev;
  50
  51 struct rte_ipv4_hdr app_ip_hdr[VXLAN_N_PORTS];
  52 struct rte_ether_hdr app_l2_hdr[VXLAN_N_PORTS];
  53
  54 /* local VTEP IP address */
  55 uint8_t vxlan_multicast_ips[2][4] = { {239, 1, 1, 1 }, {239, 1, 2, 1 } };
  56
  57 /* Remote VTEP IP address */
  58 uint8_t vxlan_overlay_ips[2][4] = { {192, 168, 10, 1}, {192, 168, 30, 1} };
  59
  60 /* Remote VTEP MAC address */
  61 uint8_t peer_mac[6] = {0x00, 0x11, 0x01, 0x00, 0x00, 0x01};
  62
  63 /* VXLAN RX filter type */
  64 uint8_t tep_filter_type[] = {RTE_TUNNEL_FILTER_IMAC_TENID,
  65                         RTE_TUNNEL_FILTER_IMAC_IVLAN_TENID,
  66                         RTE_TUNNEL_FILTER_OMAC_TENID_IMAC,};
  67
  68 /* Options for configuring ethernet port */
  69 static struct rte_eth_conf port_conf = {
  70         .rxmode = {
  71                 .split_hdr_size = 0,
  72         },
  73         .txmode = {
  74                 .mq_mode = ETH_MQ_TX_NONE,
  75                 .offloads = (DEV_TX_OFFLOAD_IPV4_CKSUM |
  76                              DEV_TX_OFFLOAD_UDP_CKSUM |
  77                              DEV_TX_OFFLOAD_TCP_CKSUM |
  78                              DEV_TX_OFFLOAD_SCTP_CKSUM |
  79                              DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM |
  80                              DEV_TX_OFFLOAD_TCP_TSO |
  81                              DEV_TX_OFFLOAD_MULTI_SEGS |
  82                              DEV_TX_OFFLOAD_VXLAN_TNL_TSO),
  83         },
  84 };
  85
  86 /**
  87  * The one or two device(s) that belongs to the same tenant ID can
  88  * be assigned in a VM.
  89  */
  90 const uint16_t tenant_id_conf[] = {
  91         1000, 1000, 1001, 1001, 1002, 1002, 1003, 1003,
  92         1004, 1004, 1005, 1005, 1006, 1006, 1007, 1007,
  93         1008, 1008, 1009, 1009, 1010, 1010, 1011, 1011,
  94         1012, 1012, 1013, 1013, 1014, 1014, 1015, 1015,
  95         1016, 1016, 1017, 1017, 1018, 1018, 1019, 1019,
  96         1020, 1020, 1021, 1021, 1022, 1022, 1023, 1023,
  97         1024, 1024, 1025, 1025, 1026, 1026, 1027, 1027,
  98         1028, 1028, 1029, 1029, 1030, 1030, 1031, 1031,
  99 };
 100
 101 /**
 102  * Initialises a given port using global settings and with the rx buffers
 103  * coming from the mbuf_pool passed as parameter
 104  */
 105 int
 106 vxlan_port_init(uint16_t port, struct rte_mempool *mbuf_pool)
 107 {
 108         int retval;
 109         uint16_t q;
 110         struct rte_eth_dev_info dev_info;
 111         uint16_t rx_rings, tx_rings = (uint16_t)rte_lcore_count();
 112         uint16_t rx_ring_size = RTE_TEST_RX_DESC_DEFAULT;
 113         uint16_t tx_ring_size = RTE_TEST_TX_DESC_DEFAULT;
 114         struct rte_eth_udp_tunnel tunnel_udp;
 115         struct rte_eth_rxconf *rxconf;
 116         struct rte_eth_txconf *txconf;
 117         struct vxlan_conf *pconf = &vxdev;
 118         struct rte_eth_conf local_port_conf = port_conf;
 119
 120         pconf->dst_port = udp_port;
 121
 122         retval = rte_eth_dev_info_get(port, &dev_info);
 123         if (retval != 0)
 124                 rte_exit(EXIT_FAILURE,
 125                         "Error during getting device (port %u) info: %s\n",
 126                         port, strerror(-retval));
 127
 128         if (dev_info.max_rx_queues > MAX_QUEUES) {
 129                 rte_exit(EXIT_FAILURE,
 130                         "please define MAX_QUEUES no less than %u in %s\n",
 131                         dev_info.max_rx_queues, __FILE__);
 132         }
 133
 134         rxconf = &dev_info.default_rxconf;
 135         txconf = &dev_info.default_txconf;
 136
 137         if (!rte_eth_dev_is_valid_port(port))
 138                 return -1;
 139
 140         rx_rings = nb_devices;
 141         if (dev_info.tx_offload_capa & DEV_TX_OFFLOAD_MBUF_FAST_FREE)
 142                 local_port_conf.txmode.offloads |=
 143                         DEV_TX_OFFLOAD_MBUF_FAST_FREE;
 144         /* Configure ethernet device. */
 145         retval = rte_eth_dev_configure(port, rx_rings, tx_rings,
 146                                        &local_port_conf);
 147         if (retval != 0)
 148                 return retval;
 149
 150         retval = rte_eth_dev_adjust_nb_rx_tx_desc(port, &rx_ring_size,
 151                         &tx_ring_size);
 152         if (retval != 0)
 153                 return retval;
 154
 155         /* Setup the queues. */
 156         rxconf->offloads = local_port_conf.rxmode.offloads;
 157         for (q = 0; q < rx_rings; q++) {
 158                 retval = rte_eth_rx_queue_setup(port, q, rx_ring_size,
 159                                                 rte_eth_dev_socket_id(port),
 160                                                 rxconf,
 161                                                 mbuf_pool);
 162                 if (retval < 0)
 163                         return retval;
 164         }
 165         txconf->offloads = local_port_conf.txmode.offloads;
 166         for (q = 0; q < tx_rings; q++) {
 167                 retval = rte_eth_tx_queue_setup(port, q, tx_ring_size,
 168                                                 rte_eth_dev_socket_id(port),
 169                                                 txconf);
 170                 if (retval < 0)
 171                         return retval;
 172         }
 173
 174         /* Start the device. */
 175         retval  = rte_eth_dev_start(port);
 176         if (retval < 0)
 177                 return retval;
 178
 179         /* Configure UDP port for UDP tunneling */
 180         tunnel_udp.udp_port = udp_port;
 181         tunnel_udp.prot_type = RTE_TUNNEL_TYPE_VXLAN;
 182         retval = rte_eth_dev_udp_tunnel_port_add(port, &tunnel_udp);
 183         if (retval < 0)
 184                 return retval;
 185         rte_eth_macaddr_get(port, &ports_eth_addr[port]);
 186         RTE_LOG(INFO, PORT, "Port %u MAC: %02"PRIx8" %02"PRIx8" %02"PRIx8
 187                         " %02"PRIx8" %02"PRIx8" %02"PRIx8"\n",
 188                         port,
 189                         ports_eth_addr[port].addr_bytes[0],
 190                         ports_eth_addr[port].addr_bytes[1],
 191                         ports_eth_addr[port].addr_bytes[2],
 192                         ports_eth_addr[port].addr_bytes[3],
 193                         ports_eth_addr[port].addr_bytes[4],
 194                         ports_eth_addr[port].addr_bytes[5]);
 195
 196         if (tso_segsz != 0) {
 197                 struct rte_eth_dev_info dev_info;
 198                 rte_eth_dev_info_get(port, &dev_info);
 199                 if ((dev_info.tx_offload_capa & DEV_TX_OFFLOAD_TCP_TSO) == 0)
 200                         RTE_LOG(WARNING, PORT,
 201                                 "hardware TSO offload is not supported\n");
 202         }
 203         return 0;
 204 }
 205
 206 static int
 207 vxlan_rx_process(struct rte_mbuf *pkt)
 208 {
 209         int ret = 0;
 210
 211         if (rx_decap)
 212                 ret = decapsulation(pkt);
 213
 214         return ret;
 215 }
 216
 217 static void
 218 vxlan_tx_process(uint8_t queue_id, struct rte_mbuf *pkt)
 219 {
 220         if (tx_encap)
 221                 encapsulation(pkt, queue_id);
 222
 223         return;
 224 }
 225
 226 /*
 227  * This function learns the MAC address of the device and set init
 228  * L2 header and L3 header info.
 229  */
 230 int
 231 vxlan_link(struct vhost_dev *vdev, struct rte_mbuf *m)
 232 {
 233         int i, ret;
 234         struct rte_ether_hdr *pkt_hdr;
 235         uint64_t portid = vdev->vid;
 236         struct rte_ipv4_hdr *ip;
 237
 238         struct rte_eth_tunnel_filter_conf tunnel_filter_conf;
 239
 240         if (unlikely(portid >= VXLAN_N_PORTS)) {
 241                 RTE_LOG(INFO, VHOST_DATA,
 242                         "(%d) WARNING: Not configuring device,"
 243                         "as already have %d ports for VXLAN.",
 244                         vdev->vid, VXLAN_N_PORTS);
 245                 return -1;
 246         }
 247
 248         /* Learn MAC address of guest device from packet */
 249         pkt_hdr = rte_pktmbuf_mtod(m, struct rte_ether_hdr *);
 250         if (rte_is_same_ether_addr(&(pkt_hdr->s_addr), &vdev->mac_address)) {
 251                 RTE_LOG(INFO, VHOST_DATA,
 252                         "(%d) WARNING: This device is using an existing"
 253                         " MAC address and has not been registered.\n",
 254                         vdev->vid);
 255                 return -1;
 256         }
 257
 258         for (i = 0; i < RTE_ETHER_ADDR_LEN; i++) {
 259                 vdev->mac_address.addr_bytes[i] =
 260                         vxdev.port[portid].vport_mac.addr_bytes[i] =
 261                         pkt_hdr->s_addr.addr_bytes[i];
 262                 vxdev.port[portid].peer_mac.addr_bytes[i] = peer_mac[i];
 263         }
 264
 265         memset(&tunnel_filter_conf, 0,
 266                 sizeof(struct rte_eth_tunnel_filter_conf));
 267
 268         rte_ether_addr_copy(&ports_eth_addr[0], &tunnel_filter_conf.outer_mac);
 269         tunnel_filter_conf.filter_type = tep_filter_type[filter_idx];
 270
 271         /* inner MAC */
 272         rte_ether_addr_copy(&vdev->mac_address, &tunnel_filter_conf.inner_mac);
 273
 274         tunnel_filter_conf.queue_id = vdev->rx_q;
 275         tunnel_filter_conf.tenant_id = tenant_id_conf[vdev->rx_q];
 276
 277         if (tep_filter_type[filter_idx] == RTE_TUNNEL_FILTER_IMAC_IVLAN_TENID)
 278                 tunnel_filter_conf.inner_vlan = INNER_VLAN_ID;
 279
 280         tunnel_filter_conf.tunnel_type = RTE_TUNNEL_TYPE_VXLAN;
 281
 282         ret = rte_eth_dev_filter_ctrl(ports[0],
 283                 RTE_ETH_FILTER_TUNNEL,
 284                 RTE_ETH_FILTER_ADD,
 285                 &tunnel_filter_conf);
 286         if (ret) {
 287                 RTE_LOG(ERR, VHOST_DATA,
 288                         "%d Failed to add device MAC address to cloud filter\n",
 289                 vdev->rx_q);
 290                 return -1;
 291         }
 292
 293         /* Print out inner MAC and VNI info. */
 294         RTE_LOG(INFO, VHOST_DATA,
 295                 "(%d) MAC_ADDRESS %02x:%02x:%02x:%02x:%02x:%02x and VNI %d registered\n",
 296                 vdev->rx_q,
 297                 vdev->mac_address.addr_bytes[0],
 298                 vdev->mac_address.addr_bytes[1],
 299                 vdev->mac_address.addr_bytes[2],
 300                 vdev->mac_address.addr_bytes[3],
 301                 vdev->mac_address.addr_bytes[4],
 302                 vdev->mac_address.addr_bytes[5],
 303                 tenant_id_conf[vdev->rx_q]);
 304
 305         vxdev.port[portid].vport_id = portid;
 306
 307         for (i = 0; i < 4; i++) {
 308                 /* Local VTEP IP */
 309                 vxdev.port_ip |= vxlan_multicast_ips[portid][i] << (8 * i);
 310                 /* Remote VTEP IP */
 311                 vxdev.port[portid].peer_ip |=
 312                         vxlan_overlay_ips[portid][i] << (8 * i);
 313         }
 314
 315         vxdev.out_key = tenant_id_conf[vdev->rx_q];
 316         rte_ether_addr_copy(&vxdev.port[portid].peer_mac,
 317                         &app_l2_hdr[portid].d_addr);
 318         rte_ether_addr_copy(&ports_eth_addr[0],
 319                         &app_l2_hdr[portid].s_addr);
 320         app_l2_hdr[portid].ether_type = rte_cpu_to_be_16(RTE_ETHER_TYPE_IPV4);
 321
 322         ip = &app_ip_hdr[portid];
 323         ip->version_ihl = IP_VHL_DEF;
 324         ip->type_of_service = 0;
 325         ip->total_length = 0;
 326         ip->packet_id = 0;
 327         ip->fragment_offset = IP_DN_FRAGMENT_FLAG;
 328         ip->time_to_live = IP_DEFTTL;
 329         ip->next_proto_id = IPPROTO_UDP;
 330         ip->hdr_checksum = 0;
 331         ip->src_addr = vxdev.port_ip;
 332         ip->dst_addr = vxdev.port[portid].peer_ip;
 333
 334         /* Set device as ready for RX. */
 335         vdev->ready = DEVICE_RX;
 336
 337         return 0;
 338 }
 339
 340 /**
 341  * Removes cloud filter. Ensures that nothing is adding buffers to the RX
 342  * queue before disabling RX on the device.
 343  */
 344 void
 345 vxlan_unlink(struct vhost_dev *vdev)
 346 {
 347         unsigned i = 0, rx_count;
 348         int ret;
 349         struct rte_mbuf *pkts_burst[MAX_PKT_BURST];
 350         struct rte_eth_tunnel_filter_conf tunnel_filter_conf;
 351
 352         if (vdev->ready == DEVICE_RX) {
 353                 memset(&tunnel_filter_conf, 0,
 354                         sizeof(struct rte_eth_tunnel_filter_conf));
 355
 356                 rte_ether_addr_copy(&ports_eth_addr[0],
 357                                 &tunnel_filter_conf.outer_mac);
 358                 rte_ether_addr_copy(&vdev->mac_address,
 359                                 &tunnel_filter_conf.inner_mac);
 360                 tunnel_filter_conf.tenant_id = tenant_id_conf[vdev->rx_q];
 361                 tunnel_filter_conf.filter_type = tep_filter_type[filter_idx];
 362
 363                 if (tep_filter_type[filter_idx] ==
 364                         RTE_TUNNEL_FILTER_IMAC_IVLAN_TENID)
 365                         tunnel_filter_conf.inner_vlan = INNER_VLAN_ID;
 366
 367                 tunnel_filter_conf.queue_id = vdev->rx_q;
 368                 tunnel_filter_conf.tunnel_type = RTE_TUNNEL_TYPE_VXLAN;
 369
 370                 ret = rte_eth_dev_filter_ctrl(ports[0],
 371                                 RTE_ETH_FILTER_TUNNEL,
 372                                 RTE_ETH_FILTER_DELETE,
 373                                 &tunnel_filter_conf);
 374                 if (ret) {
 375                         RTE_LOG(ERR, VHOST_DATA,
 376                                 "%d Failed to add device MAC address to cloud filter\n",
 377                                 vdev->rx_q);
 378                         return;
 379                 }
 380                 for (i = 0; i < RTE_ETHER_ADDR_LEN; i++)
 381                         vdev->mac_address.addr_bytes[i] = 0;
 382
 383                 /* Clear out the receive buffers */
 384                 rx_count = rte_eth_rx_burst(ports[0],
 385                                 (uint16_t)vdev->rx_q,
 386                                 pkts_burst, MAX_PKT_BURST);
 387
 388                 while (rx_count) {
 389                         for (i = 0; i < rx_count; i++)
 390                                 rte_pktmbuf_free(pkts_burst[i]);
 391
 392                         rx_count = rte_eth_rx_burst(ports[0],
 393                                         (uint16_t)vdev->rx_q,
 394                                         pkts_burst, MAX_PKT_BURST);
 395                 }
 396                 vdev->ready = DEVICE_MAC_LEARNING;
 397         }
 398 }
 399
 400 /* Transmit packets after encapsulating */
 401 int
 402 vxlan_tx_pkts(uint16_t port_id, uint16_t queue_id,
 403                 struct rte_mbuf **tx_pkts, uint16_t nb_pkts) {
 404         int ret = 0;
 405         uint16_t i;
 406
 407         for (i = 0; i < nb_pkts; i++)
 408                 vxlan_tx_process(queue_id, tx_pkts[i]);
 409
 410         ret = rte_eth_tx_burst(port_id, queue_id, tx_pkts, nb_pkts);
 411
 412         return ret;
 413 }
 414
 415 /* Check for decapsulation and pass packets directly to VIRTIO device */
 416 int
 417 vxlan_rx_pkts(int vid, struct rte_mbuf **pkts_burst, uint32_t rx_count)
 418 {
 419         uint32_t i = 0;
 420         uint32_t count = 0;
 421         int ret;
 422         struct rte_mbuf *pkts_valid[rx_count];
 423
 424         for (i = 0; i < rx_count; i++) {
 425                 if (enable_stats) {
 426                         rte_atomic64_add(
 427                                 &dev_statistics[vid].rx_bad_ip_csum,
 428                                 (pkts_burst[i]->ol_flags & PKT_RX_IP_CKSUM_BAD)
 429                                 != 0);
 430                         rte_atomic64_add(
 431                                 &dev_statistics[vid].rx_bad_ip_csum,
 432                                 (pkts_burst[i]->ol_flags & PKT_RX_L4_CKSUM_BAD)
 433                                 != 0);
 434                 }
 435                 ret = vxlan_rx_process(pkts_burst[i]);
 436                 if (unlikely(ret < 0))
 437                         continue;
 438
 439                 pkts_valid[count] = pkts_burst[i];
 440                         count++;
 441         }
 442
 443         ret = rte_vhost_enqueue_burst(vid, VIRTIO_RXQ, pkts_valid, count);
 444         return ret;
 445 }