lib/librte_kni/rte_kni.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2013 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 #ifndef _RTE_KNI_H_
  35 #define _RTE_KNI_H_
  36
  37 /**
  38  * @file
  39  * RTE KNI
  40  *
  41  * The KNI library provides the ability to create and destroy kernel NIC
  42  * interfaces that may be used by the RTE application to receive/transmit
  43  * packets from/to Linux kernel net interfaces.
  44  *
  45  * This library provide two APIs to burst receive packets from KNI interfaces,
  46  * and burst transmit packets to KNI interfaces.
  47  */
  48
  49 #include <rte_pci.h>
  50 #include <rte_mbuf.h>
  51
  52 #include <exec-env/rte_kni_common.h>
  53
  54 #ifdef __cplusplus
  55 extern "C" {
  56 #endif
  57
  58 struct rte_kni;
  59
  60 /**
  61  * Structure which has the function pointers for KNI interface.
  62  */
  63 struct rte_kni_ops {
  64         uint8_t port_id; /* Port ID */
  65
  66         /* Pointer to function of changing MTU */
  67         int (*change_mtu)(uint8_t port_id, unsigned new_mtu);
  68
  69         /* Pointer to function of configuring network interface */
  70         int (*config_network_if)(uint8_t port_id, uint8_t if_up);
  71 };
  72
  73 /**
  74  * Structure for configuring KNI device.
  75  */
  76 struct rte_kni_conf {
  77         /*
  78          * KNI name which will be used in relevant network device.
  79          * Let the name as short as possible, as it will be part of
  80          * memzone name.
  81          */
  82         char name[RTE_KNI_NAMESIZE];
  83         uint16_t group_id;  /* Group ID */
  84         unsigned mbuf_size; /* mbuf size */
  85         struct rte_pci_addr addr;
  86         struct rte_pci_id id;
  87 };
  88
  89 /**
  90  * Allocate KNI interface according to the port id, mbuf size, mbuf pool,
  91  * configurations and callbacks for kernel requests.The KNI interface created
  92  * in the kernel space is the net interface the traditional Linux application
  93  * talking to.
  94  *
  95  * @param pktmbuf_pool
  96  *  The mempool for allocting mbufs for packets.
  97  * @param conf
  98  *  The pointer to the configurations of the KNI device.
  99  * @param ops
 100  *  The pointer to the callbacks for the KNI kernel requests.
 101  *
 102  * @return
 103  *  - The pointer to the context of a KNI interface.
 104  *  - NULL indicate error.
 105  */
 106 extern struct rte_kni *rte_kni_alloc(struct rte_mempool *pktmbuf_pool,
 107                                      const struct rte_kni_conf *conf,
 108                                      struct rte_kni_ops *ops);
 109
 110 /**
 111  * It create a KNI device for specific port.
 112  *
 113  * Note: It is deprecated and just for backward compatibility.
 114  *
 115  * @param port_id
 116  *  Port ID.
 117  * @param mbuf_size
 118  *  mbuf size.
 119  * @param pktmbuf_pool
 120  *  The mempool for allocting mbufs for packets.
 121  * @param ops
 122  *  The pointer to the callbacks for the KNI kernel requests.
 123  *
 124  * @return
 125  *  - The pointer to the context of a KNI interface.
 126  *  - NULL indicate error.
 127  */
 128 extern struct rte_kni *rte_kni_create(uint8_t port_id,
 129                                       unsigned mbuf_size,
 130                                       struct rte_mempool *pktmbuf_pool,
 131                                       struct rte_kni_ops *ops) \
 132                                       __attribute__ ((deprecated));
 133
 134 /**
 135  * Release KNI interface according to the context. It will also release the
 136  * paired KNI interface in kernel space. All processing on the specific KNI
 137  * context need to be stopped before calling this interface.
 138  *
 139  * @param kni
 140  *  The pointer to the context of an existant KNI interface.
 141  *
 142  * @return
 143  *  - 0 indicates success.
 144  *  - negative value indicates failure.
 145  */
 146 extern int rte_kni_release(struct rte_kni *kni);
 147
 148 /**
 149  * It is used to handle the request mbufs sent from kernel space.
 150  * Then analyzes it and calls the specific actions for the specific requests.
 151  * Finally constructs the response mbuf and puts it back to the resp_q.
 152  *
 153  * @param kni
 154  *  The pointer to the context of an existant KNI interface.
 155  *
 156  * @return
 157  *  - 0
 158  *  - negative value indicates failure.
 159  */
 160 extern int rte_kni_handle_request(struct rte_kni *kni);
 161
 162 /**
 163  * Retrieve a burst of packets from a KNI interface. The retrieved packets are
 164  * stored in rte_mbuf structures whose pointers are supplied in the array of
 165  * mbufs, and the maximum number is indicated by num. It handles the freeing of
 166  * the mbufs in the free queue of KNI interface.
 167  *
 168  * @param kni
 169  *  The KNI interface context.
 170  * @param mbufs
 171  *  The array to store the pointers of mbufs.
 172  * @param num
 173  *  The maximum number per burst.
 174  *
 175  * @return
 176  *  The actual number of packets retrieved.
 177  */
 178 extern unsigned rte_kni_rx_burst(struct rte_kni *kni,
 179                 struct rte_mbuf **mbufs, unsigned num);
 180
 181 /**
 182  * Send a burst of packets to a KNI interface. The packets to be sent out are
 183  * stored in rte_mbuf structures whose pointers are supplied in the array of
 184  * mbufs, and the maximum number is indicated by num. It handles allocating
 185  * the mbufs for KNI interface alloc queue.
 186  *
 187  * @param kni
 188  *  The KNI interface context.
 189  * @param mbufs
 190  *  The array to store the pointers of mbufs.
 191  * @param num
 192  *  The maximum number per burst.
 193  *
 194  * @return
 195  *  The actual number of packets sent.
 196  */
 197 extern unsigned rte_kni_tx_burst(struct rte_kni *kni,
 198                 struct rte_mbuf **mbufs, unsigned num);
 199
 200 /**
 201  * Get the port id from KNI interface.
 202  *
 203  * Note: It is deprecated and just for backward compatibility.
 204  *
 205  * @param kni
 206  *  The KNI interface context.
 207  *
 208  * @return
 209  *  On success: The port id.
 210  *  On failure: ~0x0
 211  */
 212 extern uint8_t rte_kni_get_port_id(struct rte_kni *kni) \
 213                                 __attribute__ ((deprecated));
 214
 215 /**
 216  * Get the KNI context of its name.
 217  *
 218  * @param name
 219  *  pointer to the KNI device name.
 220  *
 221  * @return
 222  *  On success: Pointer to KNI interface.
 223  *  On failure: NULL.
 224  */
 225 extern struct rte_kni *rte_kni_get(const char *name);
 226
 227 /**
 228  * Get the KNI context of the specific port.
 229  *
 230  * Note: It is deprecated and just for backward compatibility.
 231  *
 232  * @param port_id
 233  *  the port id.
 234  *
 235  * @return
 236  *  On success: Pointer to KNI interface.
 237  *  On failure: NULL
 238  */
 239 extern struct rte_kni *rte_kni_info_get(uint8_t port_id) \
 240                                 __attribute__ ((deprecated));
 241
 242 /**
 243  * Register KNI request handling for a specified port,and it can
 244  * be called by master process or slave process.
 245  *
 246  * @param kni
 247  *  pointer to struct rte_kni.
 248  * @param ops
 249  *  ponter to struct rte_kni_ops.
 250  *
 251  * @return
 252  *  On success: 0
 253  *  On failure: -1
 254  */
 255 extern int rte_kni_register_handlers(struct rte_kni *kni,
 256                         struct rte_kni_ops *ops);
 257
 258 /**
 259  *  Unregister KNI request handling for a specified port.
 260  *
 261  *  @param kni
 262  *   pointer to struct rte_kni.
 263  *
 264  *  @return
 265  *   On success: 0
 266  *   On failure: -1
 267  */
 268 extern int rte_kni_unregister_handlers(struct rte_kni *kni);
 269
 270 #ifdef __cplusplus
 271 }
 272 #endif
 273
 274 #endif /* _RTE_KNI_H_ */
 275