vnet/vnet/devices/netmap/netmap.h

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2016 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *------------------------------------------------------------------
  16  */
  17 /*
  18  * Copyright (C) 2011-2014 Universita` di Pisa. All rights reserved.
  19  *
  20  * Redistribution and use in source and binary forms, with or without
  21  * modification, are permitted provided that the following conditions
  22  * are met:
  23  *
  24  *   1. Redistributions of source code must retain the above copyright
  25  *      notice, this list of conditions and the following disclaimer.
  26  *   2. Redistributions in binary form must reproduce the above copyright
  27  *      notice, this list of conditions and the following disclaimer in the
  28  *      documentation and/or other materials provided with the distribution.
  29  *
  30  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  31  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  32  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  33  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  34  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  35  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  36  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  37  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  38  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  39  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  40  * SUCH DAMAGE.
  41  */
  42
  43 #include <stdint.h>
  44 #include <net/if.h>
  45 #include <sys/ioctl.h>
  46 #include <vnet/devices/netmap/net_netmap.h>
  47
  48 typedef struct {
  49   CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
  50   u8 * host_if_name;
  51   uword if_index;
  52   u32 hw_if_index;
  53   u32 sw_if_index;
  54   u32 unix_file_index;
  55
  56   u32 per_interface_next_index;
  57   u8 is_admin_up;
  58
  59   /* netmap */
  60   struct nmreq * req;
  61   u16 mem_region;
  62   int fd;
  63   struct netmap_if * nifp;
  64   u16 first_tx_ring;
  65   u16 last_tx_ring;
  66   u16 first_rx_ring;
  67   u16 last_rx_ring;
  68
  69 } netmap_if_t;
  70
  71 typedef struct {
  72   char * mem;
  73   u32 region_size;
  74   int refcnt;
  75 } netmap_mem_region_t;
  76
  77 typedef struct {
  78   CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
  79   netmap_if_t * interfaces;
  80
  81   /* bitmap of pending rx interfaces */
  82   uword * pending_input_bitmap;
  83
  84   /* rx buffer cache */
  85   u32 * rx_buffers;
  86
  87   /* hash of host interface names */
  88   mhash_t if_index_by_host_if_name;
  89
  90   /* vector of memory regions */
  91   netmap_mem_region_t * mem_regions;
  92 } netmap_main_t;
  93
  94 netmap_main_t netmap_main;
  95 extern vnet_device_class_t netmap_device_class;
  96 extern vlib_node_registration_t netmap_input_node;
  97
  98 int netmap_create_if(vlib_main_t * vm, u8 * host_if_name, u8 * hw_addr_set, u8 is_pipe, u8 is_master);
  99 int netmap_delete_if(vlib_main_t * vm, u8 * host_if_name);
 100
 101
 102 /* Macros and helper functions from sys/net/netmap_user.h */
 103
 104 #define _NETMAP_OFFSET(type, ptr, offset) \
 105         ((type)(void *)((char *)(ptr) + (offset)))
 106
 107 #define NETMAP_IF(_base, _ofs)  _NETMAP_OFFSET(struct netmap_if *, _base, _ofs)
 108
 109 #define NETMAP_TXRING(nifp, index) _NETMAP_OFFSET(struct netmap_ring *, \
 110         nifp, (nifp)->ring_ofs[index] )
 111
 112 #define NETMAP_RXRING(nifp, index) _NETMAP_OFFSET(struct netmap_ring *, \
 113         nifp, (nifp)->ring_ofs[index + (nifp)->ni_tx_rings + 1] )
 114
 115 #define NETMAP_BUF(ring, index)                         \
 116         ((char *)(ring) + (ring)->buf_ofs + ((index)*(ring)->nr_buf_size))
 117
 118 #define NETMAP_BUF_IDX(ring, buf)                       \
 119         ( ((char *)(buf) - ((char *)(ring) + (ring)->buf_ofs) ) / \
 120                 (ring)->nr_buf_size )
 121
 122 static inline uint32_t
 123 nm_ring_next(struct netmap_ring *ring, uint32_t i)
 124 {
 125         return ( unlikely(i + 1 == ring->num_slots) ? 0 : i + 1);
 126 }
 127
 128
 129 /*
 130  * Return 1 if we have pending transmissions in the tx ring.
 131  * When everything is complete ring->head = ring->tail + 1 (modulo ring size)
 132  */
 133 static inline int
 134 nm_tx_pending(struct netmap_ring *ring)
 135 {
 136         return nm_ring_next(ring, ring->tail) != ring->head;
 137 }
 138
 139 static inline uint32_t
 140 nm_ring_space(struct netmap_ring *ring)
 141 {
 142         int ret = ring->tail - ring->cur;
 143         if (ret < 0)
 144                 ret += ring->num_slots;
 145         return ret;
 146 }
 147
 148