DPDK  18.02.2
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  rte_spinlock_t lsc_lock;
93 
94  uint16_t primary_port;
99  uint8_t balance_xmit_policy;
101  burst_xmit_hash_t burst_xmit_hash;
104  uint8_t user_defined_mac;
106  uint8_t promiscuous_en;
110  uint8_t link_status_polling_enabled;
111  uint32_t link_status_polling_interval_ms;
112 
113  uint32_t link_down_delay_ms;
114  uint32_t link_up_delay_ms;
115 
116  uint16_t nb_rx_queues;
117  uint16_t nb_tx_queues;
119  uint16_t active_slave;
121  uint16_t active_slaves[RTE_MAX_ETHPORTS];
123  uint16_t slave_count;
124  struct bond_slave_details slaves[RTE_MAX_ETHPORTS];
127  struct mode8023ad_private mode4;
128  uint16_t tlb_slaves_order[RTE_MAX_ETHPORTS];
130  struct mode_alb_private mode6;
131 
132  uint32_t rx_offload_capa;
133  uint32_t tx_offload_capa;
137 
138  uint16_t reta_size;
139  struct rte_eth_rss_reta_entry64 reta_conf[ETH_RSS_RETA_SIZE_512 /
140  RTE_RETA_GROUP_SIZE];
141 
142  uint8_t rss_key[52];
143  uint8_t rss_key_len;
145  struct rte_kvargs *kvlist;
146  uint8_t slave_update_idx;
147 
148  uint32_t candidate_max_rx_pktlen;
149  uint32_t max_rx_pktlen;
150 
151  void *vlan_filter_bmpmem; /* enabled vlan filter bitmap */
152  struct rte_bitmap *vlan_filter_bmp;
153 };
154 
155 extern const struct eth_dev_ops default_dev_ops;
156 
157 int
158 check_for_master_bonded_ethdev(const struct rte_eth_dev *eth_dev);
159 
160 int
161 check_for_bonded_ethdev(const struct rte_eth_dev *eth_dev);
162 
163 /* Search given slave array to find position of given id.
164  * Return slave pos or slaves_count if not found. */
165 static inline uint16_t
166 find_slave_by_id(uint16_t *slaves, uint16_t slaves_count, uint16_t slave_id) {
167 
168  uint16_t pos;
169  for (pos = 0; pos < slaves_count; pos++) {
170  if (slave_id == slaves[pos])
171  break;
172  }
173 
174  return pos;
175 }
176 
177 int
178 valid_port_id(uint16_t port_id);
179 
180 int
181 valid_bonded_port_id(uint16_t port_id);
182 
183 int
184 valid_slave_port_id(uint16_t port_id, uint8_t mode);
185 
186 void
187 deactivate_slave(struct rte_eth_dev *eth_dev, uint16_t port_id);
188 
189 void
190 activate_slave(struct rte_eth_dev *eth_dev, uint16_t port_id);
191 
192 void
193 link_properties_set(struct rte_eth_dev *bonded_eth_dev,
194  struct rte_eth_link *slave_dev_link);
195 int
196 link_properties_valid(struct rte_eth_dev *bonded_eth_dev,
197  struct rte_eth_link *slave_dev_link);
198 
199 int
200 mac_address_set(struct rte_eth_dev *eth_dev, struct ether_addr *new_mac_addr);
201 
202 int
203 mac_address_get(struct rte_eth_dev *eth_dev, struct ether_addr *dst_mac_addr);
204 
205 int
206 mac_address_slaves_update(struct rte_eth_dev *bonded_eth_dev);
207 
208 int
209 bond_ethdev_mode_set(struct rte_eth_dev *eth_dev, int mode);
210 
211 int
212 slave_configure(struct rte_eth_dev *bonded_eth_dev,
213  struct rte_eth_dev *slave_eth_dev);
214 
215 void
216 slave_remove(struct bond_dev_private *internals,
217  struct rte_eth_dev *slave_eth_dev);
218 
219 void
220 slave_add(struct bond_dev_private *internals,
221  struct rte_eth_dev *slave_eth_dev);
222 
223 void
224 burst_xmit_l2_hash(struct rte_mbuf **buf, uint16_t nb_pkts,
225  uint8_t slave_count, uint16_t *slaves);
226 
227 void
228 burst_xmit_l23_hash(struct rte_mbuf **buf, uint16_t nb_pkts,
229  uint8_t slave_count, uint16_t *slaves);
230 
231 void
232 burst_xmit_l34_hash(struct rte_mbuf **buf, uint16_t nb_pkts,
233  uint8_t slave_count, uint16_t *slaves);
234 
235 
236 void
237 bond_ethdev_primary_set(struct bond_dev_private *internals,
238  uint16_t slave_port_id);
239 
240 int
241 bond_ethdev_lsc_event_callback(uint16_t port_id, enum rte_eth_event_type type,
242  void *param, void *ret_param);
243 
244 int
245 bond_ethdev_parse_slave_port_kvarg(const char *key,
246  const char *value, void *extra_args);
247 
248 int
249 bond_ethdev_parse_slave_mode_kvarg(const char *key,
250  const char *value, void *extra_args);
251 
252 int
253 bond_ethdev_parse_slave_agg_mode_kvarg(const char *key __rte_unused,
254  const char *value, void *extra_args);
255 
256 int
257 bond_ethdev_parse_socket_id_kvarg(const char *key,
258  const char *value, void *extra_args);
259 
260 int
261 bond_ethdev_parse_primary_slave_port_id_kvarg(const char *key,
262  const char *value, void *extra_args);
263 
264 int
265 bond_ethdev_parse_balance_xmit_policy_kvarg(const char *key,
266  const char *value, void *extra_args);
267 
268 int
269 bond_ethdev_parse_bond_mac_addr_kvarg(const char *key,
270  const char *value, void *extra_args);
271 
272 int
273 bond_ethdev_parse_time_ms_kvarg(const char *key,
274  const char *value, void *extra_args);
275 
276 void
277 bond_tlb_disable(struct bond_dev_private *internals);
278 
279 void
280 bond_tlb_enable(struct bond_dev_private *internals);
281 
282 void
283 bond_tlb_activate_slave(struct bond_dev_private *internals);
284 
285 void
286 bond_ethdev_stop(struct rte_eth_dev *eth_dev);
287 
288 void
289 bond_ethdev_close(struct rte_eth_dev *dev);
290 
291 #endif