4 * Copyright 2017 6WIND S.A.
5 * Copyright 2017 Mellanox.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of 6WIND S.A. nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #ifndef _RTE_ETH_FAILSAFE_PRIVATE_H_
35 #define _RTE_ETH_FAILSAFE_PRIVATE_H_
37 #include <sys/queue.h>
39 #include <rte_atomic.h>
41 #include <rte_ethdev.h>
42 #include <rte_devargs.h>
44 #define FAILSAFE_DRIVER_NAME "Fail-safe PMD"
46 #define PMD_FAILSAFE_MAC_KVARG "mac"
47 #define PMD_FAILSAFE_HOTPLUG_POLL_KVARG "hotplug_poll"
48 #define PMD_FAILSAFE_PARAM_STRING \
50 "exec(<shell command>)," \
55 #define FAILSAFE_HOTPLUG_DEFAULT_TIMEOUT_MS 2000
57 #define FAILSAFE_MAX_ETHPORTS 2
58 #define FAILSAFE_MAX_ETHADDR 128
65 /* id of last sub_device polled */
67 unsigned int socket_id;
68 struct rte_eth_rxq_info info;
69 rte_atomic64_t refcnt[];
75 unsigned int socket_id;
76 struct rte_eth_txq_info info;
77 rte_atomic64_t refcnt[];
81 TAILQ_ENTRY(rte_flow) next;
83 struct rte_flow *flows[FAILSAFE_MAX_ETHPORTS];
84 /* flow description for synchronization */
85 struct rte_flow_desc *fd;
97 /* Exhaustive DPDK device description */
98 struct rte_devargs devargs;
100 struct rte_device *dev;
101 struct rte_eth_dev *edev;
103 /* Device state machine */
104 enum dev_state state;
105 /* Some device are defined as a command line */
107 /* fail-safe device backreference */
108 struct rte_eth_dev *fs_dev;
109 /* flag calling for recollection */
110 volatile unsigned int remove:1;
114 struct rte_eth_dev *dev;
116 * Set of sub_devices.
117 * subs[0] is the preferred device
118 * any other is just another slave
120 struct sub_device *subs;
121 uint8_t subs_head; /* if head == tail, no subs */
122 uint8_t subs_tail; /* first invalid */
123 uint8_t subs_tx; /* current emitting device */
124 uint8_t current_probed;
126 TAILQ_HEAD(sub_flows, rte_flow) flow_list;
127 /* current number of mac_addr slots allocated. */
128 uint32_t nb_mac_addr;
129 struct ether_addr mac_addrs[FAILSAFE_MAX_ETHADDR];
130 uint32_t mac_addr_pool[FAILSAFE_MAX_ETHADDR];
131 /* current capabilities */
132 struct rte_eth_dev_info infos;
134 * Fail-safe state machine.
135 * This level will be tracking state of the EAL and eth
136 * layer at large as defined by the user application.
137 * It will then steer the sub_devices toward the same
138 * synchronized state.
140 enum dev_state state;
141 unsigned int pending_alarm:1; /* An alarm is pending */
146 int failsafe_hotplug_alarm_install(struct rte_eth_dev *dev);
147 int failsafe_hotplug_alarm_cancel(struct rte_eth_dev *dev);
151 void set_burst_fn(struct rte_eth_dev *dev, int force_safe);
153 uint16_t failsafe_rx_burst(void *rxq,
154 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
155 uint16_t failsafe_tx_burst(void *txq,
156 struct rte_mbuf **tx_pkts, uint16_t nb_pkts);
158 uint16_t failsafe_rx_burst_fast(void *rxq,
159 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
160 uint16_t failsafe_tx_burst_fast(void *txq,
161 struct rte_mbuf **tx_pkts, uint16_t nb_pkts);
165 int failsafe_args_parse(struct rte_eth_dev *dev, const char *params);
166 void failsafe_args_free(struct rte_eth_dev *dev);
167 int failsafe_args_count_subdevice(struct rte_eth_dev *dev, const char *params);
168 int failsafe_args_parse_subs(struct rte_eth_dev *dev);
172 int failsafe_eal_init(struct rte_eth_dev *dev);
173 int failsafe_eal_uninit(struct rte_eth_dev *dev);
177 int failsafe_eth_dev_state_sync(struct rte_eth_dev *dev);
178 void failsafe_dev_remove(struct rte_eth_dev *dev);
179 int failsafe_eth_rmv_event_callback(uint8_t port_id,
180 enum rte_eth_event_type type,
181 void *arg, void *out);
182 int failsafe_eth_lsc_event_callback(uint8_t port_id,
183 enum rte_eth_event_type event,
184 void *cb_arg, void *out);
188 extern const char pmd_failsafe_driver_name[];
189 extern const struct eth_dev_ops failsafe_ops;
190 extern const struct rte_flow_ops fs_flow_ops;
191 extern uint64_t hotplug_poll;
192 extern int mac_from_arg;
196 /* dev: (struct rte_eth_dev *) fail-safe device */
198 ((struct fs_priv *)(dev)->data->dev_private)
200 /* sdev: (struct sub_device *) */
204 /* sdev: (struct sub_device *) */
205 #define PORT_ID(sdev) \
206 (ETH(sdev)->data->port_id)
208 /* sdev: (struct sub_device *) */
209 #define SUB_ID(sdev) \
213 * Stateful iterator construct over fail-safe sub-devices:
214 * s: (struct sub_device *), iterator
215 * i: (uint8_t), increment
216 * dev: (struct rte_eth_dev *), fail-safe ethdev
217 * state: (enum dev_state), minimum acceptable device state
219 #define FOREACH_SUBDEV_STATE(s, i, dev, state) \
220 for (i = fs_find_next((dev), 0, state); \
221 i < PRIV(dev)->subs_tail && (s = &PRIV(dev)->subs[i]); \
222 i = fs_find_next((dev), i + 1, state))
225 * Iterator construct over fail-safe sub-devices:
226 * s: (struct sub_device *), iterator
227 * i: (uint8_t), increment
228 * dev: (struct rte_eth_dev *), fail-safe ethdev
230 #define FOREACH_SUBDEV(s, i, dev) \
231 FOREACH_SUBDEV_STATE(s, i, dev, DEV_UNDEFINED)
233 /* dev: (struct rte_eth_dev *) fail-safe device */
234 #define PREFERRED_SUBDEV(dev) \
235 (&PRIV(dev)->subs[0])
237 /* dev: (struct rte_eth_dev *) fail-safe device */
238 #define TX_SUBDEV(dev) \
239 (PRIV(dev)->subs_tx >= PRIV(dev)->subs_tail ? NULL \
240 : (PRIV(dev)->subs[PRIV(dev)->subs_tx].state < DEV_PROBED ? NULL \
241 : &PRIV(dev)->subs[PRIV(dev)->subs_tx]))
244 * s: (struct sub_device *)
245 * ops: (struct eth_dev_ops) member
247 #define SUBOPS(s, ops) \
248 (ETH(s)->dev_ops->ops)
255 * a: (rte_atomic64_t)
257 #define FS_ATOMIC_P(a) \
258 rte_atomic64_add(&(a), 1)
261 * a: (rte_atomic64_t)
263 #define FS_ATOMIC_V(a) \
264 rte_atomic64_sub(&(a), 1)
267 * s: (struct sub_device *)
270 #define FS_ATOMIC_RX(s, i) \
272 &((struct rxq *)((s)->fs_dev->data->rx_queues[i]))->refcnt[(s)->sid] \
275 * s: (struct sub_device *)
278 #define FS_ATOMIC_TX(s, i) \
280 &((struct txq *)((s)->fs_dev->data->tx_queues[i]))->refcnt[(s)->sid] \
283 #define LOG__(level, m, ...) \
284 RTE_LOG(level, PMD, "net_failsafe: " m "%c", __VA_ARGS__)
285 #define LOG_(level, ...) LOG__(level, __VA_ARGS__, '\n')
286 #define DEBUG(...) LOG_(DEBUG, __VA_ARGS__)
287 #define INFO(...) LOG_(INFO, __VA_ARGS__)
288 #define WARN(...) LOG_(WARNING, __VA_ARGS__)
289 #define ERROR(...) LOG_(ERR, __VA_ARGS__)
291 /* inlined functions */
293 static inline uint8_t
294 fs_find_next(struct rte_eth_dev *dev, uint8_t sid,
295 enum dev_state min_state)
297 while (sid < PRIV(dev)->subs_tail) {
298 if (PRIV(dev)->subs[sid].state >= min_state)
302 if (sid >= PRIV(dev)->subs_tail)
303 return PRIV(dev)->subs_tail;
308 * Switch emitting device.
309 * If banned is set, banned must not be considered for
310 * the role of emitting device.
313 fs_switch_dev(struct rte_eth_dev *dev,
314 struct sub_device *banned)
316 struct sub_device *txd;
317 enum dev_state req_state;
319 req_state = PRIV(dev)->state;
320 txd = TX_SUBDEV(dev);
321 if (PREFERRED_SUBDEV(dev)->state >= req_state &&
322 PREFERRED_SUBDEV(dev) != banned) {
323 if (txd != PREFERRED_SUBDEV(dev) &&
325 (req_state == DEV_STARTED) ||
326 (txd && txd->state < DEV_STARTED))) {
327 DEBUG("Switching tx_dev to preferred sub_device");
328 PRIV(dev)->subs_tx = 0;
330 } else if ((txd && txd->state < req_state) ||
333 struct sub_device *sdev;
336 /* Using acceptable device */
337 FOREACH_SUBDEV_STATE(sdev, i, dev, req_state) {
340 DEBUG("Switching tx_dev to sub_device %d",
342 PRIV(dev)->subs_tx = i;
345 } else if (txd && txd->state < req_state) {
346 DEBUG("No device ready, deactivating tx_dev");
347 PRIV(dev)->subs_tx = PRIV(dev)->subs_tail;
351 set_burst_fn(dev, 0);
355 #endif /* _RTE_ETH_FAILSAFE_PRIVATE_H_ */