lib/librte_kni/rte_kni.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation
   3  */
   4
   5 #ifndef _RTE_KNI_H_
   6 #define _RTE_KNI_H_
   7
   8 /**
   9  * @file
  10  * RTE KNI
  11  *
  12  * The KNI library provides the ability to create and destroy kernel NIC
  13  * interfaces that may be used by the RTE application to receive/transmit
  14  * packets from/to Linux kernel net interfaces.
  15  *
  16  * This library provides two APIs to burst receive packets from KNI interfaces,
  17  * and burst transmit packets to KNI interfaces.
  18  */
  19
  20 #include <rte_pci.h>
  21 #include <rte_memory.h>
  22 #include <rte_mempool.h>
  23 #include <rte_ether.h>
  24
  25 #include <exec-env/rte_kni_common.h>
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 struct rte_kni;
  32 struct rte_mbuf;
  33
  34 /**
  35  * Structure which has the function pointers for KNI interface.
  36  */
  37 struct rte_kni_ops {
  38         uint16_t port_id; /* Port ID */
  39
  40         /* Pointer to function of changing MTU */
  41         int (*change_mtu)(uint16_t port_id, unsigned int new_mtu);
  42
  43         /* Pointer to function of configuring network interface */
  44         int (*config_network_if)(uint16_t port_id, uint8_t if_up);
  45
  46         /* Pointer to function of configuring mac address */
  47         int (*config_mac_address)(uint16_t port_id, uint8_t mac_addr[]);
  48
  49         /* Pointer to function of configuring promiscuous mode */
  50         int (*config_promiscusity)(uint16_t port_id, uint8_t to_on);
  51 };
  52
  53 /**
  54  * Structure for configuring KNI device.
  55  */
  56 struct rte_kni_conf {
  57         /*
  58          * KNI name which will be used in relevant network device.
  59          * Let the name as short as possible, as it will be part of
  60          * memzone name.
  61          */
  62         char name[RTE_KNI_NAMESIZE];
  63         uint32_t core_id;   /* Core ID to bind kernel thread on */
  64         uint16_t group_id;  /* Group ID */
  65         unsigned mbuf_size; /* mbuf size */
  66         struct rte_pci_addr addr;
  67         struct rte_pci_id id;
  68
  69         __extension__
  70         uint8_t force_bind : 1; /* Flag to bind kernel thread */
  71         char mac_addr[ETHER_ADDR_LEN]; /* MAC address assigned to KNI */
  72 };
  73
  74 /**
  75  * Initialize and preallocate KNI subsystem
  76  *
  77  * This function is to be executed on the MASTER lcore only, after EAL
  78  * initialization and before any KNI interface is attempted to be
  79  * allocated
  80  *
  81  * @param max_kni_ifaces
  82  *  The maximum number of KNI interfaces that can coexist concurrently
  83  */
  84 void rte_kni_init(unsigned int max_kni_ifaces);
  85
  86
  87 /**
  88  * Allocate KNI interface according to the port id, mbuf size, mbuf pool,
  89  * configurations and callbacks for kernel requests.The KNI interface created
  90  * in the kernel space is the net interface the traditional Linux application
  91  * talking to.
  92  *
  93  * The rte_kni_alloc shall not be called before rte_kni_init() has been
  94  * called. rte_kni_alloc is thread safe.
  95  *
  96  * The mempool should have capacity of more than "2 x KNI_FIFO_COUNT_MAX"
  97  * elements for each KNI interface allocated.
  98  *
  99  * @param pktmbuf_pool
 100  *  The mempool for allocating mbufs for packets.
 101  * @param conf
 102  *  The pointer to the configurations of the KNI device.
 103  * @param ops
 104  *  The pointer to the callbacks for the KNI kernel requests.
 105  *
 106  * @return
 107  *  - The pointer to the context of a KNI interface.
 108  *  - NULL indicate error.
 109  */
 110 struct rte_kni *rte_kni_alloc(struct rte_mempool *pktmbuf_pool,
 111                 const struct rte_kni_conf *conf, struct rte_kni_ops *ops);
 112
 113 /**
 114  * Release KNI interface according to the context. It will also release the
 115  * paired KNI interface in kernel space. All processing on the specific KNI
 116  * context need to be stopped before calling this interface.
 117  *
 118  * rte_kni_release is thread safe.
 119  *
 120  * @param kni
 121  *  The pointer to the context of an existent KNI interface.
 122  *
 123  * @return
 124  *  - 0 indicates success.
 125  *  - negative value indicates failure.
 126  */
 127 int rte_kni_release(struct rte_kni *kni);
 128
 129 /**
 130  * It is used to handle the request mbufs sent from kernel space.
 131  * Then analyzes it and calls the specific actions for the specific requests.
 132  * Finally constructs the response mbuf and puts it back to the resp_q.
 133  *
 134  * @param kni
 135  *  The pointer to the context of an existent KNI interface.
 136  *
 137  * @return
 138  *  - 0
 139  *  - negative value indicates failure.
 140  */
 141 int rte_kni_handle_request(struct rte_kni *kni);
 142
 143 /**
 144  * Retrieve a burst of packets from a KNI interface. The retrieved packets are
 145  * stored in rte_mbuf structures whose pointers are supplied in the array of
 146  * mbufs, and the maximum number is indicated by num. It handles allocating
 147  * the mbufs for KNI interface alloc queue.
 148  *
 149  * @param kni
 150  *  The KNI interface context.
 151  * @param mbufs
 152  *  The array to store the pointers of mbufs.
 153  * @param num
 154  *  The maximum number per burst.
 155  *
 156  * @return
 157  *  The actual number of packets retrieved.
 158  */
 159 unsigned rte_kni_rx_burst(struct rte_kni *kni, struct rte_mbuf **mbufs,
 160                 unsigned num);
 161
 162 /**
 163  * Send a burst of packets to a KNI interface. The packets to be sent out 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 sent.
 177  */
 178 unsigned rte_kni_tx_burst(struct rte_kni *kni, struct rte_mbuf **mbufs,
 179                 unsigned num);
 180
 181 /**
 182  * Get the KNI context of its name.
 183  *
 184  * @param name
 185  *  pointer to the KNI device name.
 186  *
 187  * @return
 188  *  On success: Pointer to KNI interface.
 189  *  On failure: NULL.
 190  */
 191 struct rte_kni *rte_kni_get(const char *name);
 192
 193 /**
 194  * Get the name given to a KNI device
 195  *
 196  * @param kni
 197  *   The KNI instance to query
 198  * @return
 199  *   The pointer to the KNI name
 200  */
 201 const char *rte_kni_get_name(const struct rte_kni *kni);
 202
 203 /**
 204  * Register KNI request handling for a specified port,and it can
 205  * be called by master process or slave process.
 206  *
 207  * @param kni
 208  *  pointer to struct rte_kni.
 209  * @param ops
 210  *  pointer to struct rte_kni_ops.
 211  *
 212  * @return
 213  *  On success: 0
 214  *  On failure: -1
 215  */
 216 int rte_kni_register_handlers(struct rte_kni *kni, struct rte_kni_ops *ops);
 217
 218 /**
 219  *  Unregister KNI request handling for a specified port.
 220  *
 221  *  @param kni
 222  *   pointer to struct rte_kni.
 223  *
 224  *  @return
 225  *   On success: 0
 226  *   On failure: -1
 227  */
 228 int rte_kni_unregister_handlers(struct rte_kni *kni);
 229
 230 /**
 231  *  Close KNI device.
 232  */
 233 void rte_kni_close(void);
 234
 235 #ifdef __cplusplus
 236 }
 237 #endif
 238
 239 #endif /* _RTE_KNI_H_ */