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_
38 #include <rte_ethdev.h>
39 #include <rte_devargs.h>
41 #define FAILSAFE_DRIVER_NAME "Fail-safe PMD"
43 #define PMD_FAILSAFE_MAC_KVARG "mac"
44 #define PMD_FAILSAFE_HOTPLUG_POLL_KVARG "hotplug_poll"
45 #define PMD_FAILSAFE_PARAM_STRING \
47 "exec(<shell command>)," \
52 #define FAILSAFE_HOTPLUG_DEFAULT_TIMEOUT_MS 2000
54 #define FAILSAFE_MAX_ETHPORTS 2
55 #define FAILSAFE_MAX_ETHADDR 128
62 /* id of last sub_device polled */
64 unsigned int socket_id;
65 struct rte_eth_rxq_info info;
71 unsigned int socket_id;
72 struct rte_eth_txq_info info;
84 /* Exhaustive DPDK device description */
85 struct rte_devargs devargs;
87 struct rte_device *dev;
88 struct rte_eth_dev *edev;
89 /* Device state machine */
91 /* Some device are defined as a command line */
96 struct rte_eth_dev *dev;
99 * subs[0] is the preferred device
100 * any other is just another slave
102 struct sub_device *subs;
103 uint8_t subs_head; /* if head == tail, no subs */
104 uint8_t subs_tail; /* first invalid */
105 uint8_t subs_tx; /* current emitting device */
106 uint8_t current_probed;
107 /* current number of mac_addr slots allocated. */
108 uint32_t nb_mac_addr;
109 struct ether_addr mac_addrs[FAILSAFE_MAX_ETHADDR];
110 uint32_t mac_addr_pool[FAILSAFE_MAX_ETHADDR];
111 /* current capabilities */
112 struct rte_eth_dev_info infos;
114 * Fail-safe state machine.
115 * This level will be tracking state of the EAL and eth
116 * layer at large as defined by the user application.
117 * It will then steer the sub_devices toward the same
118 * synchronized state.
120 enum dev_state state;
121 unsigned int pending_alarm:1; /* An alarm is pending */
126 int failsafe_hotplug_alarm_install(struct rte_eth_dev *dev);
127 int failsafe_hotplug_alarm_cancel(struct rte_eth_dev *dev);
131 uint16_t failsafe_rx_burst(void *rxq,
132 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
133 uint16_t failsafe_tx_burst(void *txq,
134 struct rte_mbuf **tx_pkts, uint16_t nb_pkts);
138 int failsafe_args_parse(struct rte_eth_dev *dev, const char *params);
139 void failsafe_args_free(struct rte_eth_dev *dev);
140 int failsafe_args_count_subdevice(struct rte_eth_dev *dev, const char *params);
141 int failsafe_args_parse_subs(struct rte_eth_dev *dev);
145 int failsafe_eal_init(struct rte_eth_dev *dev);
146 int failsafe_eal_uninit(struct rte_eth_dev *dev);
150 int failsafe_eth_dev_state_sync(struct rte_eth_dev *dev);
154 extern const char pmd_failsafe_driver_name[];
155 extern const struct eth_dev_ops failsafe_ops;
156 extern uint64_t hotplug_poll;
157 extern int mac_from_arg;
161 /* dev: (struct rte_eth_dev *) fail-safe device */
163 ((struct fs_priv *)(dev)->data->dev_private)
165 /* sdev: (struct sub_device *) */
169 /* sdev: (struct sub_device *) */
170 #define PORT_ID(sdev) \
171 (ETH(sdev)->data->port_id)
174 * Stateful iterator construct over fail-safe sub-devices:
175 * s: (struct sub_device *), iterator
176 * i: (uint8_t), increment
177 * dev: (struct rte_eth_dev *), fail-safe ethdev
178 * state: (enum dev_state), minimum acceptable device state
180 #define FOREACH_SUBDEV_STATE(s, i, dev, state) \
181 for (i = fs_find_next((dev), 0, state); \
182 i < PRIV(dev)->subs_tail && (s = &PRIV(dev)->subs[i]); \
183 i = fs_find_next((dev), i + 1, state))
186 * Iterator construct over fail-safe sub-devices:
187 * s: (struct sub_device *), iterator
188 * i: (uint8_t), increment
189 * dev: (struct rte_eth_dev *), fail-safe ethdev
191 #define FOREACH_SUBDEV(s, i, dev) \
192 FOREACH_SUBDEV_STATE(s, i, dev, DEV_UNDEFINED)
194 /* dev: (struct rte_eth_dev *) fail-safe device */
195 #define PREFERRED_SUBDEV(dev) \
196 (&PRIV(dev)->subs[0])
198 /* dev: (struct rte_eth_dev *) fail-safe device */
199 #define TX_SUBDEV(dev) \
200 (PRIV(dev)->subs_tx >= PRIV(dev)->subs_tail ? NULL \
201 : (PRIV(dev)->subs[PRIV(dev)->subs_tx].state < DEV_PROBED ? NULL \
202 : &PRIV(dev)->subs[PRIV(dev)->subs_tx]))
205 * s: (struct sub_device *)
206 * ops: (struct eth_dev_ops) member
208 #define SUBOPS(s, ops) \
209 (ETH(s)->dev_ops->ops)
211 #define LOG__(level, m, ...) \
212 RTE_LOG(level, PMD, "net_failsafe: " m "%c", __VA_ARGS__)
213 #define LOG_(level, ...) LOG__(level, __VA_ARGS__, '\n')
214 #define DEBUG(...) LOG_(DEBUG, __VA_ARGS__)
215 #define INFO(...) LOG_(INFO, __VA_ARGS__)
216 #define WARN(...) LOG_(WARNING, __VA_ARGS__)
217 #define ERROR(...) LOG_(ERR, __VA_ARGS__)
219 /* inlined functions */
221 static inline uint8_t
222 fs_find_next(struct rte_eth_dev *dev, uint8_t sid,
223 enum dev_state min_state)
225 while (sid < PRIV(dev)->subs_tail) {
226 if (PRIV(dev)->subs[sid].state >= min_state)
230 if (sid >= PRIV(dev)->subs_tail)
231 return PRIV(dev)->subs_tail;
236 fs_switch_dev(struct rte_eth_dev *dev)
238 enum dev_state req_state;
240 req_state = PRIV(dev)->state;
241 if (PREFERRED_SUBDEV(dev)->state >= req_state) {
242 if (TX_SUBDEV(dev) != PREFERRED_SUBDEV(dev) &&
243 (TX_SUBDEV(dev) == NULL ||
244 (req_state == DEV_STARTED) ||
245 (TX_SUBDEV(dev) && TX_SUBDEV(dev)->state < DEV_STARTED))) {
246 DEBUG("Switching tx_dev to preferred sub_device");
247 PRIV(dev)->subs_tx = 0;
249 } else if ((TX_SUBDEV(dev) && TX_SUBDEV(dev)->state < req_state) ||
250 TX_SUBDEV(dev) == NULL) {
251 struct sub_device *sdev;
254 /* Using acceptable device */
255 FOREACH_SUBDEV_STATE(sdev, i, dev, req_state) {
256 DEBUG("Switching tx_dev to sub_device %d",
258 PRIV(dev)->subs_tx = i;
261 } else if (TX_SUBDEV(dev) && TX_SUBDEV(dev)->state < req_state) {
262 DEBUG("No device ready, deactivating tx_dev");
263 PRIV(dev)->subs_tx = PRIV(dev)->subs_tail;
270 #endif /* _RTE_ETH_FAILSAFE_PRIVATE_H_ */