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 typedef struct {
  44   CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
  45   u8 * host_if_name;
  46   uword if_index;
  47   u32 hw_if_index;
  48   u32 sw_if_index;
  49   u32 unix_file_index;
  50
  51   u32 per_interface_next_index;
  52   u8 is_admin_up;
  53
  54   /* netmap */
  55   struct nmreq * req;
  56   u16 mem_region;
  57   int fd;
  58   struct netmap_if * nifp;
  59   u16 first_tx_ring;
  60   u16 last_tx_ring;
  61   u16 first_rx_ring;
  62   u16 last_rx_ring;
  63
  64 } netmap_if_t;
  65
  66 typedef struct {
  67   char * mem;
  68   u32 region_size;
  69   int refcnt;
  70 } netmap_mem_region_t;
  71
  72 typedef struct {
  73   CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
  74   netmap_if_t * interfaces;
  75
  76   /* bitmap of pending rx interfaces */
  77   uword * pending_input_bitmap;
  78
  79   /* rx buffer cache */
  80   u32 * rx_buffers;
  81
  82   /* hash of host interface names */
  83   mhash_t if_index_by_host_if_name;
  84
  85   /* vector of memory regions */
  86   netmap_mem_region_t * mem_regions;
  87 } netmap_main_t;
  88
  89 netmap_main_t netmap_main;
  90 extern vnet_device_class_t netmap_device_class;
  91 extern vlib_node_registration_t netmap_input_node;
  92
  93 int netmap_create_if(vlib_main_t * vm, u8 * host_if_name, u8 * hw_addr_set,
  94                      u8 is_pipe, u8 is_master, u32 *sw_if_index);
  95 int netmap_delete_if(vlib_main_t * vm, u8 * host_if_name);
  96
  97
  98 /* Macros and helper functions from sys/net/netmap_user.h */
  99
 100 #ifdef _NET_NETMAP_H_
 101
 102 #define _NETMAP_OFFSET(type, ptr, offset) \
 103         ((type)(void *)((char *)(ptr) + (offset)))
 104
 105 #define NETMAP_IF(_base, _ofs)  _NETMAP_OFFSET(struct netmap_if *, _base, _ofs)
 106
 107 #define NETMAP_TXRING(nifp, index) _NETMAP_OFFSET(struct netmap_ring *, \
 108         nifp, (nifp)->ring_ofs[index] )
 109
 110 #define NETMAP_RXRING(nifp, index) _NETMAP_OFFSET(struct netmap_ring *, \
 111         nifp, (nifp)->ring_ofs[index + (nifp)->ni_tx_rings + 1] )
 112
 113 #define NETMAP_BUF(ring, index)                         \
 114         ((char *)(ring) + (ring)->buf_ofs + ((index)*(ring)->nr_buf_size))
 115
 116 #define NETMAP_BUF_IDX(ring, buf)                       \
 117         ( ((char *)(buf) - ((char *)(ring) + (ring)->buf_ofs) ) / \
 118                 (ring)->nr_buf_size )
 119
 120 static inline uint32_t
 121 nm_ring_next(struct netmap_ring *ring, uint32_t i)
 122 {
 123         return ( PREDICT_FALSE(i + 1 == ring->num_slots) ? 0 : i + 1);
 124 }
 125
 126
 127 /*
 128  * Return 1 if we have pending transmissions in the tx ring.
 129  * When everything is complete ring->head = ring->tail + 1 (modulo ring size)
 130  */
 131 static inline int
 132 nm_tx_pending(struct netmap_ring *ring)
 133 {
 134         return nm_ring_next(ring, ring->tail) != ring->head;
 135 }
 136
 137 static inline uint32_t
 138 nm_ring_space(struct netmap_ring *ring)
 139 {
 140         int ret = ring->tail - ring->cur;
 141         if (ret < 0)
 142                 ret += ring->num_slots;
 143         return ret;
 144 }
 145 #endif
 146