lib/librte_kni/rte_kni.h

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