VNFs/DPPD-PROX/tx_pkt.h

   1 /*
   2 // Copyright (c) 2010-2020 Intel Corporation
   3 //
   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 #ifndef _TX_PKT_H_
  18 #define _TX_PKT_H_
  19
  20 #include <inttypes.h>
  21 #include <string.h>
  22 #include <rte_mbuf.h>
  23 #include "ip6_addr.h"
  24
  25 struct task_base;
  26
  27 struct prox_headroom {
  28         uint64_t command;
  29         uint32_t ip;
  30         uint32_t prefix;
  31         uint32_t gateway_ip;
  32         uint64_t data64;
  33         struct ipv6_addr ipv6_addr;
  34 } __attribute__((packed));
  35
  36 void flush_queues_hw(struct task_base *tbase);
  37 void flush_queues_sw(struct task_base *tbase);
  38
  39 void flush_queues_no_drop_hw(struct task_base *tbase);
  40 void flush_queues_no_drop_sw(struct task_base *tbase);
  41
  42 /* The following four transmit functions always send packets to the
  43    single output unless the packet should be dropped. These functions
  44    are used if (1) the task is only sending to one destination and
  45    (2), packets can potentially be dropped (as specified by the out
  46    parameter, which is either NO_PORT_AVAIL or 0). */
  47 int tx_pkt_no_drop_hw1(struct task_base *tbase, struct rte_mbuf **mbufs, const uint16_t n_pkts, uint8_t *out);
  48 int tx_pkt_no_drop_sw1(struct task_base *tbase, struct rte_mbuf **mbufs, const uint16_t n_pkts, uint8_t *out);
  49 int tx_pkt_hw1(struct task_base *tbase, struct rte_mbuf **mbufs, const uint16_t n_pkts, uint8_t *out);
  50 int tx_pkt_sw1(struct task_base *tbase, struct rte_mbuf **mbufs, const uint16_t n_pkts, uint8_t *out);
  51
  52 /* The following four transmit functions are used if (1) the task is
  53    only sending to one destination and (2), packets are never dropped
  54    by the task (the out parameter is ignored). */
  55 int tx_pkt_no_drop_never_discard_hw1_lat_opt(struct task_base *tbase, struct rte_mbuf **mbufs, const uint16_t n_pkts, uint8_t *out);
  56 int tx_pkt_no_drop_never_discard_hw1_thrpt_opt(struct task_base *tbase, struct rte_mbuf **mbufs, const uint16_t n_pkts, uint8_t *out);
  57 int tx_pkt_no_drop_never_discard_hw1_no_pointer(struct task_base *tbase, struct rte_mbuf **mbufs, const uint16_t n_pkts, uint8_t *out);
  58 int tx_pkt_no_drop_never_discard_sw1(struct task_base *tbase, struct rte_mbuf **mbufs, const uint16_t n_pkts, uint8_t *out);
  59 int tx_pkt_never_discard_hw1_lat_opt(struct task_base *tbase, struct rte_mbuf **mbufs, const uint16_t n_pkts, uint8_t *out);
  60 int tx_pkt_never_discard_hw1_thrpt_opt(struct task_base *tbase, struct rte_mbuf **mbufs, const uint16_t n_pkts, uint8_t *out);
  61 int tx_pkt_never_discard_sw1(struct task_base *tbase, struct rte_mbuf **mbufs, const uint16_t n_pkts, uint8_t *out);
  62
  63 /* The two "self" transmit functions are used if the task is
  64    transmitting to another task running on the same core and the
  65    destination task ID is one higher than the current task. The never_discard
  66    version of the function ignores the out parameter and should
  67    therefor only be used if the task never discards packets.*/
  68 int tx_pkt_self(struct task_base *tbase, struct rte_mbuf **mbufs, const uint16_t n_pkts, uint8_t *out);
  69 int tx_pkt_never_discard_self(struct task_base *tbase, struct rte_mbuf **mbufs, const uint16_t n_pkts, uint8_t *out);
  70
  71 /* The following four tarnsmit functions are the most general. They
  72    are used if (1) packets can be dropped and (2) there are multiple
  73    outputs in the task. */
  74 int tx_pkt_no_drop_hw(struct task_base *tbase, struct rte_mbuf **mbufs, uint16_t n_pkts, uint8_t *out);
  75 int tx_pkt_no_drop_sw(struct task_base *tbase, struct rte_mbuf **mbufs, uint16_t n_pkts, uint8_t *out);
  76 int tx_pkt_hw(struct task_base *tbase, struct rte_mbuf **mbufs, uint16_t n_pkts, uint8_t *out);
  77 int tx_pkt_sw(struct task_base *tbase, struct rte_mbuf **mbufs, uint16_t n_pkts, uint8_t *out);
  78 int tx_ctrlplane_hw(struct task_base *tbase, struct rte_mbuf **mbufs, uint16_t n_pkts, uint8_t *out);
  79 int tx_ctrlplane_sw(struct task_base *tbase, struct rte_mbuf **mbufs, uint16_t n_pkts, uint8_t *out);
  80
  81 int tx_pkt_trace(struct task_base *tbase, struct rte_mbuf **mbufs, uint16_t n_pkts, uint8_t *out);
  82 int tx_pkt_dump(struct task_base *tbase, struct rte_mbuf **mbufs, uint16_t n_pkts, uint8_t *out);
  83 int tx_pkt_distr(struct task_base *tbase, struct rte_mbuf **mbufs, uint16_t n_pkts, uint8_t *out);
  84 int tx_pkt_bw(struct task_base *tbase, struct rte_mbuf **mbufs, uint16_t n_pkts, uint8_t *out);
  85
  86 uint16_t tx_try_sw1(struct task_base *tbase, struct rte_mbuf **mbufs, uint16_t n_pkts);
  87 uint16_t tx_try_hw1(struct task_base *tbase, struct rte_mbuf **mbufs, uint16_t n_pkts);
  88 uint16_t tx_try_self(struct task_base *tbase, struct rte_mbuf **mbufs, uint16_t n_pkts);
  89
  90 /* When there are no output ports, this function is configured as the
  91    tx function. This tx function can be used to make each task a
  92    sink. */
  93 int tx_pkt_drop_all(struct task_base *tbase, struct rte_mbuf **mbufs, uint16_t n_pkts, uint8_t *out);
  94 int tx_pkt_l3(struct task_base *tbase, struct rte_mbuf **mbufs, uint16_t n_pkts, uint8_t *out);
  95 int tx_pkt_ndp(struct task_base *tbase, struct rte_mbuf **mbufs, uint16_t n_pkts, uint8_t *out);
  96
  97 static inline uint8_t get_command(struct rte_mbuf *mbuf)
  98 {
  99         struct prox_headroom *prox_headroom = (struct prox_headroom *)(rte_pktmbuf_mtod(mbuf, uint8_t*) - sizeof(struct prox_headroom));
 100         return prox_headroom->command & 0xFF;
 101 }
 102 static inline uint8_t get_task(struct rte_mbuf *mbuf)
 103 {
 104         struct prox_headroom *prox_headroom = (struct prox_headroom *)(rte_pktmbuf_mtod(mbuf, uint8_t*) - sizeof(struct prox_headroom));
 105         return (prox_headroom->command >> 8) & 0xFF;
 106 }
 107 static inline uint8_t get_core(struct rte_mbuf *mbuf)
 108 {
 109         struct prox_headroom *prox_headroom = (struct prox_headroom *)(rte_pktmbuf_mtod(mbuf, uint8_t*) - sizeof(struct prox_headroom));
 110         return (prox_headroom->command >> 16) & 0xFF;
 111 }
 112 static inline uint32_t get_ip(struct rte_mbuf *mbuf)
 113 {
 114         struct prox_headroom *prox_headroom = (struct prox_headroom *)(rte_pktmbuf_mtod(mbuf, uint8_t*) - sizeof(struct prox_headroom));
 115         return (prox_headroom->command >> 32) & 0xFFFFFFFF;
 116 }
 117
 118 static inline void ctrl_ring_set_command_core_task_ip(struct rte_mbuf *mbuf, uint64_t udata64)
 119 {
 120         struct prox_headroom *prox_headroom = (struct prox_headroom *)(rte_pktmbuf_mtod(mbuf, uint8_t*) - sizeof(struct prox_headroom));
 121         prox_headroom->command = udata64;
 122 }
 123
 124 static inline void ctrl_ring_set_command(struct rte_mbuf *mbuf, uint8_t command)
 125 {
 126         struct prox_headroom *prox_headroom = (struct prox_headroom *)(rte_pktmbuf_mtod(mbuf, uint8_t*) - sizeof(struct prox_headroom));
 127         prox_headroom->command = command;
 128 }
 129
 130 static inline void ctrl_ring_set_ip(struct rte_mbuf *mbuf, uint32_t udata32)
 131 {
 132         struct prox_headroom *prox_headroom = (struct prox_headroom *)(rte_pktmbuf_mtod(mbuf, uint8_t*) - sizeof(struct prox_headroom));
 133         prox_headroom->ip = udata32;
 134 }
 135
 136 static inline uint32_t ctrl_ring_get_ip(struct rte_mbuf *mbuf)
 137 {
 138         struct prox_headroom *prox_headroom = (struct prox_headroom *)(rte_pktmbuf_mtod(mbuf, uint8_t*) - sizeof(struct prox_headroom));
 139         return prox_headroom->ip;
 140 }
 141
 142 static inline void ctrl_ring_set_gateway_ip(struct rte_mbuf *mbuf, uint32_t udata32)
 143 {
 144         struct prox_headroom *prox_headroom = (struct prox_headroom *)(rte_pktmbuf_mtod(mbuf, uint8_t*) - sizeof(struct prox_headroom));
 145         prox_headroom->gateway_ip = udata32;
 146 }
 147
 148 static inline uint32_t ctrl_ring_get_gateway_ip(struct rte_mbuf *mbuf)
 149 {
 150         struct prox_headroom *prox_headroom = (struct prox_headroom *)(rte_pktmbuf_mtod(mbuf, uint8_t*) - sizeof(struct prox_headroom));
 151         return prox_headroom->gateway_ip;
 152 }
 153
 154 static inline void ctrl_ring_set_prefix(struct rte_mbuf *mbuf, uint32_t udata32)
 155 {
 156         struct prox_headroom *prox_headroom = (struct prox_headroom *)(rte_pktmbuf_mtod(mbuf, uint8_t*) - sizeof(struct prox_headroom));
 157         prox_headroom->prefix = udata32;
 158 }
 159
 160 static inline uint32_t ctrl_ring_get_prefix(struct rte_mbuf *mbuf)
 161 {
 162         struct prox_headroom *prox_headroom = (struct prox_headroom *)(rte_pktmbuf_mtod(mbuf, uint8_t*) - sizeof(struct prox_headroom));
 163         return prox_headroom->prefix;
 164 }
 165
 166 static inline void ctrl_ring_set_data(struct rte_mbuf *mbuf, uint64_t data)
 167 {
 168         struct prox_headroom *prox_headroom = (struct prox_headroom *)(rte_pktmbuf_mtod(mbuf, uint8_t*) - sizeof(struct prox_headroom));
 169         prox_headroom->data64 = data;
 170 }
 171
 172 static inline uint64_t ctrl_ring_get_data(struct rte_mbuf *mbuf)
 173 {
 174         struct prox_headroom *prox_headroom = (struct prox_headroom *)(rte_pktmbuf_mtod(mbuf, uint8_t*) - sizeof(struct prox_headroom));
 175         return prox_headroom->data64;
 176 }
 177
 178 static inline void ctrl_ring_set_ipv6_addr(struct rte_mbuf *mbuf, struct ipv6_addr *ip)
 179 {
 180         struct prox_headroom *prox_headroom = (struct prox_headroom *)(rte_pktmbuf_mtod(mbuf, uint8_t*) - sizeof(struct prox_headroom));
 181         memcpy(&prox_headroom->ipv6_addr, ip, sizeof(struct ipv6_addr));
 182 }
 183
 184 static inline struct ipv6_addr *ctrl_ring_get_ipv6_addr(struct rte_mbuf *mbuf)
 185 {
 186         struct prox_headroom *prox_headroom = (struct prox_headroom *)(rte_pktmbuf_mtod(mbuf, uint8_t*) - sizeof(struct prox_headroom));
 187         return &prox_headroom->ipv6_addr;
 188 }
 189
 190 int tx_ring_cti(struct task_base *tbase, struct rte_ring *ring, uint8_t command, struct rte_mbuf *mbuf, uint8_t core_id, uint8_t task_id, uint32_t ip);
 191 void tx_ring_cti6(struct task_base *tbase, struct rte_ring *ring, uint8_t command, struct rte_mbuf *mbuf, uint8_t core_id, uint8_t task_id, struct ipv6_addr *ip);
 192 void tx_ring_ip(struct task_base *tbase, struct rte_ring *ring, uint8_t command, struct rte_mbuf *mbuf, uint32_t ip);
 193 void tx_ring_ip6(struct task_base *tbase, struct rte_ring *ring, uint8_t command,  struct rte_mbuf *mbuf, struct ipv6_addr *ip);
 194 void tx_ring_ip6_data(struct task_base *tbase, struct rte_ring *ring, uint8_t command,  struct rte_mbuf *mbuf, struct ipv6_addr *ip, uint64_t data);
 195 void tx_ring(struct task_base *tbase, struct rte_ring *ring, uint16_t command, struct rte_mbuf *mbuf);
 196 void tx_ring_route(struct task_base *tbase, struct rte_ring *ring, int add, struct rte_mbuf *mbuf, uint32_t ip, uint32_t gateway_ip, uint32_t prefix);
 197 static void store_packet(struct task_base *tbase, struct rte_mbuf *mbufs);
 198
 199 #endif /* _TX_PKT_H_ */