DPDK  18.02.0
rte_eth_bond_private.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2017 Intel Corporation
3  */
4 
5 #ifndef _RTE_ETH_BOND_PRIVATE_H_
6 #define _RTE_ETH_BOND_PRIVATE_H_
7 
8 #include <rte_ethdev_driver.h>
9 #include <rte_spinlock.h>
10 #include <rte_bitmap.h>
11 
12 #include "rte_eth_bond.h"
13 #include "rte_eth_bond_8023ad_private.h"
14 #include "rte_eth_bond_alb.h"
15 
16 #define PMD_BOND_SLAVE_PORT_KVARG ("slave")
17 #define PMD_BOND_PRIMARY_SLAVE_KVARG ("primary")
18 #define PMD_BOND_MODE_KVARG ("mode")
19 #define PMD_BOND_AGG_MODE_KVARG ("agg_mode")
20 #define PMD_BOND_XMIT_POLICY_KVARG ("xmit_policy")
21 #define PMD_BOND_SOCKET_ID_KVARG ("socket_id")
22 #define PMD_BOND_MAC_ADDR_KVARG ("mac")
23 #define PMD_BOND_LSC_POLL_PERIOD_KVARG ("lsc_poll_period_ms")
24 #define PMD_BOND_LINK_UP_PROP_DELAY_KVARG ("up_delay")
25 #define PMD_BOND_LINK_DOWN_PROP_DELAY_KVARG ("down_delay")
26 
27 #define PMD_BOND_XMIT_POLICY_LAYER2_KVARG ("l2")
28 #define PMD_BOND_XMIT_POLICY_LAYER23_KVARG ("l23")
29 #define PMD_BOND_XMIT_POLICY_LAYER34_KVARG ("l34")
30 
31 #define RTE_BOND_LOG(lvl, msg, ...) \
32  RTE_LOG(lvl, PMD, "%s(%d) - " msg "\n", __func__, __LINE__, ##__VA_ARGS__)
33 
34 #define BONDING_MODE_INVALID 0xFF
35 
36 extern const char *pmd_bond_init_valid_arguments[];
37 
38 extern struct rte_vdev_driver pmd_bond_drv;
39 
41 struct bond_rx_queue {
42  uint16_t queue_id;
46  uint16_t nb_rx_desc;
52 };
53 
54 struct bond_tx_queue {
55  uint16_t queue_id;
57  struct bond_dev_private *dev_private;
59  uint16_t nb_tx_desc;
61  struct rte_eth_txconf tx_conf;
63 };
64 
67  uint16_t slaves[RTE_MAX_ETHPORTS];
68  uint16_t slave_count;
69 };
70 
71 struct bond_slave_details {
72  uint16_t port_id;
73 
74  uint8_t link_status_poll_enabled;
75  uint8_t link_status_wait_to_complete;
76  uint8_t last_link_status;
78  struct ether_addr persisted_mac_addr;
79 
80  uint16_t reta_size;
81 };
82 
83 typedef void (*burst_xmit_hash_t)(struct rte_mbuf **buf, uint16_t nb_pkts,
84  uint8_t slave_count, uint16_t *slaves);
85 
88  uint16_t port_id;
89  uint8_t mode;
91  rte_spinlock_t lock;
92 
93  uint16_t primary_port;
100  burst_xmit_hash_t burst_xmit_hash;
105  uint8_t promiscuous_en;
109  uint8_t link_status_polling_enabled;
110  uint32_t link_status_polling_interval_ms;
111 
112  uint32_t link_down_delay_ms;
113  uint32_t link_up_delay_ms;
114 
115  uint16_t nb_rx_queues;
116  uint16_t nb_tx_queues;
118  uint16_t active_slave;
120  uint16_t active_slaves[RTE_MAX_ETHPORTS];
122  uint16_t slave_count;
123  struct bond_slave_details slaves[RTE_MAX_ETHPORTS];
126  struct mode8023ad_private mode4;
127  uint16_t tlb_slaves_order[RTE_MAX_ETHPORTS];
129  struct mode_alb_private mode6;
130 
131  uint32_t rx_offload_capa;
132  uint32_t tx_offload_capa;
136 
137  uint16_t reta_size;
138  struct rte_eth_rss_reta_entry64 reta_conf[ETH_RSS_RETA_SIZE_512 /
139  RTE_RETA_GROUP_SIZE];
140 
141  uint8_t rss_key[52];
142  uint8_t rss_key_len;
144  struct rte_kvargs *kvlist;
145  uint8_t slave_update_idx;
146 
147  uint32_t candidate_max_rx_pktlen;
148  uint32_t max_rx_pktlen;
149 
150  void *vlan_filter_bmpmem; /* enabled vlan filter bitmap */
151  struct rte_bitmap *vlan_filter_bmp;
152 };
153 
154 extern const struct eth_dev_ops default_dev_ops;
155 
156 int
157 check_for_master_bonded_ethdev(const struct rte_eth_dev *eth_dev);
158 
159 int
160 check_for_bonded_ethdev(const struct rte_eth_dev *eth_dev);
161 
162 /* Search given slave array to find position of given id.
163  * Return slave pos or slaves_count if not found. */
164 static inline uint16_t
165 find_slave_by_id(uint16_t *slaves, uint16_t slaves_count, uint16_t slave_id) {
166 
167  uint16_t pos;
168  for (pos = 0; pos < slaves_count; pos++) {
169  if (slave_id == slaves[pos])
170  break;
171  }
172 
173  return pos;
174 }
175 
176 int
177 valid_port_id(uint16_t port_id);
178 
179 int
180 valid_bonded_port_id(uint16_t port_id);
181 
182 int
183 valid_slave_port_id(uint16_t port_id, uint8_t mode);
184 
185 void
186 deactivate_slave(struct rte_eth_dev *eth_dev, uint16_t port_id);
187 
188 void
189 activate_slave(struct rte_eth_dev *eth_dev, uint16_t port_id);
190 
191 void
192 link_properties_set(struct rte_eth_dev *bonded_eth_dev,
193  struct rte_eth_link *slave_dev_link);
194 int
195 link_properties_valid(struct rte_eth_dev *bonded_eth_dev,
196  struct rte_eth_link *slave_dev_link);
197 
198 int
199 mac_address_set(struct rte_eth_dev *eth_dev, struct ether_addr *new_mac_addr);
200 
201 int
202 mac_address_get(struct rte_eth_dev *eth_dev, struct ether_addr *dst_mac_addr);
203 
204 int
205 mac_address_slaves_update(struct rte_eth_dev *bonded_eth_dev);
206 
207 int
208 bond_ethdev_mode_set(struct rte_eth_dev *eth_dev, int mode);
209 
210 int
211 slave_configure(struct rte_eth_dev *bonded_eth_dev,
212  struct rte_eth_dev *slave_eth_dev);
213 
214 void
215 slave_remove(struct bond_dev_private *internals,
216  struct rte_eth_dev *slave_eth_dev);
217 
218 void
219 slave_add(struct bond_dev_private *internals,
220  struct rte_eth_dev *slave_eth_dev);
221 
222 void
223 burst_xmit_l2_hash(struct rte_mbuf **buf, uint16_t nb_pkts,
224  uint8_t slave_count, uint16_t *slaves);
225 
226 void
227 burst_xmit_l23_hash(struct rte_mbuf **buf, uint16_t nb_pkts,
228  uint8_t slave_count, uint16_t *slaves);
229 
230 void
231 burst_xmit_l34_hash(struct rte_mbuf **buf, uint16_t nb_pkts,
232  uint8_t slave_count, uint16_t *slaves);
233 
234 
235 void
236 bond_ethdev_primary_set(struct bond_dev_private *internals,
237  uint16_t slave_port_id);
238 
239 int
240 bond_ethdev_lsc_event_callback(uint16_t port_id, enum rte_eth_event_type type,
241  void *param, void *ret_param);
242 
243 int
244 bond_ethdev_parse_slave_port_kvarg(const char *key,
245  const char *value, void *extra_args);
246 
247 int
248 bond_ethdev_parse_slave_mode_kvarg(const char *key,
249  const char *value, void *extra_args);
250 
251 int
252 bond_ethdev_parse_slave_agg_mode_kvarg(const char *key __rte_unused,
253  const char *value, void *extra_args);
254 
255 int
256 bond_ethdev_parse_socket_id_kvarg(const char *key,
257  const char *value, void *extra_args);
258 
259 int
260 bond_ethdev_parse_primary_slave_port_id_kvarg(const char *key,
261  const char *value, void *extra_args);
262 
263 int
264 bond_ethdev_parse_balance_xmit_policy_kvarg(const char *key,
265  const char *value, void *extra_args);
266 
267 int
268 bond_ethdev_parse_bond_mac_addr_kvarg(const char *key,
269  const char *value, void *extra_args);
270 
271 int
272 bond_ethdev_parse_time_ms_kvarg(const char *key,
273  const char *value, void *extra_args);
274 
275 void
276 bond_tlb_disable(struct bond_dev_private *internals);
277 
278 void
279 bond_tlb_enable(struct bond_dev_private *internals);
280 
281 void
282 bond_tlb_activate_slave(struct bond_dev_private *internals);
283 
284 void
285 bond_ethdev_stop(struct rte_eth_dev *eth_dev);
286 
287 void
288 bond_ethdev_close(struct rte_eth_dev *dev);
289 
290 #endif
uint16_t user_defined_primary_port
burst_xmit_hash_t burst_xmit_hash
#define __rte_unused
Definition: rte_common.h:76
struct bond_dev_private * dev_private
uint16_t active_slaves[RTE_MAX_ETHPORTS]
struct rte_mempool * mb_pool
struct bond_slave_details slaves[RTE_MAX_ETHPORTS]
uint16_t tlb_slaves_order[RTE_MAX_ETHPORTS]
uint16_t slaves[RTE_MAX_ETHPORTS]
struct rte_eth_rxconf rx_conf
rte_eth_event_type
Definition: rte_ethdev.h:2443