lib/libtle_l4p/tle_ctx.h

   1 /*
   2  * Copyright (c) 2016  Intel Corporation.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #ifndef _TLE_CTX_H_
  17 #define _TLE_CTX_H_
  18
  19 #include <stdint.h>
  20 #include <sys/socket.h>
  21 #include <netinet/in.h>
  22 #include <rte_common.h>
  23 #include <rte_mbuf.h>
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif
  28
  29 /**
  30  * <tle_ctx>  - each such ctx represents an 'independent copy of the stack'.
  31  * It owns set of <stream>s and <dev>s entities and provides
  32  * (de)multiplexing input/output packets from/into devices into/from streams.
  33  * <dev> is an abstraction for the underlying device, that is able
  34  * to RX/TX packets and may provide some HW offload capabilities.
  35  * It is a user responsibility to add to the <ctx> all <dev>s,
  36  * that context has to manage, before starting to do stream operations
  37  * (open/send/recv,close) over that context.
  38  * Right now adding/deleting <dev>s to the context with open
  39  * streams is not supported.
  40  * <stream> represents an L4(UDP/TCP, etc.) endpoint <addr, port> and
  41  * is an analogy to socket entity.
  42  * As with a socket, there are ability to do recv/send over it.
  43  * <stream> belongs to particular <ctx> but is visible globally across
  44  * the process, i.e. any thread within the process can do recv/send over it
  45  * without any further synchronisation.
  46  * While 'upper' layer API is thread safe, lower layer API (rx_bulk/tx_bulk)
  47  * is not thread safe and is not supposed to be run on multiple threads
  48  * in parallel.
  49  * So single thread can drive multiple <ctx>s and do IO for them,
  50  * but multiple threads can't drive same <ctx> without some
  51  * explicit synchronization.
  52  */
  53
  54 struct tle_ctx;
  55 struct tle_dev;
  56
  57 /**
  58  * Blocked L4 ports info.
  59  */
  60 struct tle_bl_port {
  61         uint32_t nb_port;     /**< number of blocked ports. */
  62         const uint16_t *port; /**< list of blocked ports. */
  63 };
  64
  65
  66 /**
  67  * device parameters.
  68  */
  69 struct tle_dev_param {
  70         uint32_t rx_offload; /**< DEV_RX_OFFLOAD_* supported. */
  71         uint32_t tx_offload; /**< DEV_TX_OFFLOAD_* supported. */
  72         struct in_addr local_addr4;  /**< local IPv4 address assigned. */
  73         struct in6_addr local_addr6; /**< local IPv6 address assigned. */
  74         struct tle_bl_port bl4; /**< blocked ports for IPv4 address. */
  75         struct tle_bl_port bl6; /**< blocked ports for IPv4 address. */
  76 };
  77
  78 #define TLE_DST_MAX_HDR 0x60
  79
  80 struct tle_dest {
  81         struct rte_mempool *head_mp;
  82         /**< MP for fragment headers and control packets. */
  83         struct tle_dev *dev;     /**< device to send packets through. */
  84         uint16_t mtu;                /**< MTU for given destination. */
  85         uint8_t l2_len;  /**< L2 header length. */
  86         uint8_t l3_len;  /**< L3 header length. */
  87         uint8_t hdr[TLE_DST_MAX_HDR]; /**< L2/L3 headers. */
  88 };
  89
  90 /**
  91  * context creation parameters.
  92  */
  93
  94 enum {
  95         TLE_PROTO_UDP,
  96         TLE_PROTO_TCP,
  97         TLE_PROTO_NUM
  98 };
  99
 100 struct tle_ctx_param {
 101         int32_t socket_id;         /**< socket ID to allocate memory for. */
 102         uint32_t proto;            /**< L4 proto to handle. */
 103         uint32_t max_streams;      /**< max number of streams in context. */
 104         uint32_t max_stream_rbufs; /**< max recv mbufs per stream. */
 105         uint32_t max_stream_sbufs; /**< max send mbufs per stream. */
 106         uint32_t send_bulk_size;   /**< expected # of packets per send call. */
 107
 108         int (*lookup4)(void *opaque, const struct in_addr *addr,
 109                 struct tle_dest *res);
 110         /**< will be called by send() to get IPv4 packet destination info. */
 111         void *lookup4_data;
 112         /**< opaque data pointer for lookup4() callback. */
 113
 114         int (*lookup6)(void *opaque, const struct in6_addr *addr,
 115                 struct tle_dest *res);
 116         /**< will be called by send() to get IPv6 packet destination info. */
 117         void *lookup6_data;
 118         /**< opaque data pointer for lookup6() callback. */
 119 };
 120
 121 /**
 122  * create L4 processing context.
 123  * @param ctx_prm
 124  *   Parameters used to create and initialise the L4 context.
 125  * @return
 126  *   Pointer to context structure that can be used in future operations,
 127  *   or NULL on error, with error code set in rte_errno.
 128  *
 129  *   Possible rte_errno errors include:
 130  *   - EINVAL - invalid parameter passed to function
 131  *   - ENOMEM - out of memory
 132  */
 133 struct tle_ctx *
 134 tle_ctx_create(const struct tle_ctx_param *ctx_prm);
 135
 136 /**
 137  * Destroy given context.
 138  *
 139  * @param ctx
 140  *   context to destroy
 141  */
 142 void tle_ctx_destroy(struct tle_ctx *ctx);
 143
 144 /**
 145  * Add new device into the given context.
 146  * This function is not multi-thread safe.
 147  *
 148  * @param ctx
 149  *   context to add new device into.
 150  * @param dev_prm
 151  *   Parameters used to create and initialise new device inside the context.
 152  * @return
 153  *   Pointer to device structure that can be used in future operations,
 154  *   or NULL on error, with error code set in rte_errno.
 155  *   Possible rte_errno errors include:
 156  *   - EINVAL - invalid parameter passed to function
 157  *   - ENODEV - max possible value of open devices is reached
 158  *   - ENOMEM - out of memory
 159  */
 160 struct tle_dev *
 161 tle_add_dev(struct tle_ctx *ctx, const struct tle_dev_param *dev_prm);
 162
 163 /**
 164  * Remove and destroy previously added device from the given context.
 165  * This function is not multi-thread safe.
 166  *
 167  * @param dev
 168  *   device to remove and destroy.
 169  * @return
 170  *   zero on successful completion.
 171  *   - -EINVAL - invalid parameter passed to function
 172  */
 173 int tle_del_dev(struct tle_dev *dev);
 174
 175 /**
 176  * Flags to the context that destinations info might be changed,
 177  * so if it has any destinations data cached, then
 178  * it has to be invalidated.
 179  * @param ctx
 180  *   context to invalidate.
 181  */
 182 void tle_ctx_invalidate(struct tle_ctx *ctx);
 183
 184 /**
 185  * Stream asynchronous notification mechanisms:
 186  * a) recv/send callback.
 187  * Stream recv/send notification callbacks behaviour is edge-triggered (ET).
 188  * recv callback will be invoked if stream receive buffer was empty and
 189  * new packet(s) have arrived.
 190  * send callback will be invoked when stream send buffer was full,
 191  * and some packets belonging to that stream were sent
 192  * (part of send buffer became free again).
 193  * Note that both recv and send callbacks are called with sort of read lock
 194  * held on that stream. So it is not permitted to call stream_close()
 195  * within the callback function. Doing that would cause a deadlock.
 196  * While it is allowed to call stream send/recv functions within the
 197  * callback, it is not recommended: callback function will be invoked
 198  * within tle_udp_rx_bulk/tle_udp_tx_bulk context and some heavy processing
 199  * within the callback functions might cause performance degradation
 200  * or even loss of packets for further streams.
 201  * b) recv/send event.
 202  * Stream recv/send events behaviour is level-triggered (LT).
 203  * receive event will be raised by either
 204  * tle_udp_rx_burst() or tle_udp_stream_recv() as long as there are any
 205  * remaining packets inside stream receive buffer.
 206  * send event will be raised by either
 207  * tle_udp_tx_burst() or tle_udp_stream_send() as long as there are any
 208  * free space inside stream send buffer.
 209  * Note that callback and event are mutually exclusive on <stream, op> basis.
 210  * It is not possible to  open a stream with both recv event and callback
 211  * specified.
 212  * Though it is possible to open a stream with recv callback and send event,
 213  * or visa-versa.
 214  * If the user doesn't need any notification mechanism for that stream,
 215  * both event and callback could be set to zero.
 216  */
 217
 218 struct tle_event;
 219 struct tle_stream;
 220
 221 /**
 222  * Stream recv/send callback function and data.
 223  */
 224 struct tle_stream_cb {
 225         void (*func)(void *, struct tle_stream *);
 226         void *data;
 227 };
 228
 229 #ifdef __cplusplus
 230 }
 231 #endif
 232
 233 #endif /* _TLE_CTX_H_ */