xref: /dpdk/drivers/net/failsafe/failsafe.c (revision daa02b5cddbb8e11b31d41e2bf7bb1ae64dcae2f)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright 2017 6WIND S.A.
3  * Copyright 2017 Mellanox Technologies, Ltd
4  */
5 
6 #include <stdbool.h>
7 
8 #include <rte_alarm.h>
9 #include <rte_malloc.h>
10 #include <ethdev_driver.h>
11 #include <ethdev_vdev.h>
12 #include <rte_devargs.h>
13 #include <rte_kvargs.h>
14 #include <rte_bus_vdev.h>
15 
16 #include "failsafe_private.h"
17 
18 const char pmd_failsafe_driver_name[] = FAILSAFE_DRIVER_NAME;
19 static const struct rte_eth_link eth_link = {
20 	.link_speed = RTE_ETH_SPEED_NUM_10G,
21 	.link_duplex = RTE_ETH_LINK_FULL_DUPLEX,
22 	.link_status = RTE_ETH_LINK_UP,
23 	.link_autoneg = RTE_ETH_LINK_AUTONEG,
24 };
25 
26 static int
27 fs_sub_device_alloc(struct rte_eth_dev *dev,
28 		const char *params)
29 {
30 	uint8_t nb_subs;
31 	int ret;
32 	int i;
33 	struct sub_device *sdev;
34 	uint8_t sdev_iterator;
35 
36 	ret = failsafe_args_count_subdevice(dev, params);
37 	if (ret)
38 		return ret;
39 	if (PRIV(dev)->subs_tail > FAILSAFE_MAX_ETHPORTS) {
40 		ERROR("Cannot allocate more than %d ports",
41 			FAILSAFE_MAX_ETHPORTS);
42 		return -ENOSPC;
43 	}
44 	nb_subs = PRIV(dev)->subs_tail;
45 	PRIV(dev)->subs = rte_zmalloc(NULL,
46 			sizeof(struct sub_device) * nb_subs,
47 			RTE_CACHE_LINE_SIZE);
48 	if (PRIV(dev)->subs == NULL) {
49 		ERROR("Could not allocate sub_devices");
50 		return -ENOMEM;
51 	}
52 	/* Initiate static sub devices linked list. */
53 	for (i = 1; i < nb_subs; i++)
54 		PRIV(dev)->subs[i - 1].next = PRIV(dev)->subs + i;
55 	PRIV(dev)->subs[i - 1].next = PRIV(dev)->subs;
56 
57 	FOREACH_SUBDEV(sdev, sdev_iterator, dev) {
58 		sdev->sdev_port_id = RTE_MAX_ETHPORTS;
59 	}
60 	return 0;
61 }
62 
63 static void fs_hotplug_alarm(void *arg);
64 
65 int
66 failsafe_hotplug_alarm_install(struct rte_eth_dev *dev)
67 {
68 	int ret;
69 
70 	if (dev == NULL)
71 		return -EINVAL;
72 	if (PRIV(dev)->pending_alarm)
73 		return 0;
74 	ret = rte_eal_alarm_set(failsafe_hotplug_poll * 1000,
75 				fs_hotplug_alarm,
76 				dev);
77 	if (ret) {
78 		ERROR("Could not set up plug-in event detection");
79 		return ret;
80 	}
81 	PRIV(dev)->pending_alarm = 1;
82 	return 0;
83 }
84 
85 int
86 failsafe_hotplug_alarm_cancel(struct rte_eth_dev *dev)
87 {
88 	int ret = 0;
89 
90 	rte_errno = 0;
91 	rte_eal_alarm_cancel(fs_hotplug_alarm, dev);
92 	if (rte_errno) {
93 		ERROR("rte_eal_alarm_cancel failed (errno: %s)",
94 		      strerror(rte_errno));
95 		ret = -rte_errno;
96 	} else {
97 		PRIV(dev)->pending_alarm = 0;
98 	}
99 	return ret;
100 }
101 
102 static void
103 fs_hotplug_alarm(void *arg)
104 {
105 	struct rte_eth_dev *dev = arg;
106 	struct sub_device *sdev;
107 	int ret;
108 	uint8_t i;
109 
110 	if (!PRIV(dev)->pending_alarm)
111 		return;
112 	PRIV(dev)->pending_alarm = 0;
113 	FOREACH_SUBDEV(sdev, i, dev)
114 		if (sdev->state != PRIV(dev)->state)
115 			break;
116 	/* if we have non-probed device */
117 	if (i != PRIV(dev)->subs_tail) {
118 		if (fs_lock(dev, 1) != 0)
119 			goto reinstall;
120 		ret = failsafe_eth_dev_state_sync(dev);
121 		fs_unlock(dev, 1);
122 		if (ret)
123 			ERROR("Unable to synchronize sub_device state");
124 	}
125 	failsafe_dev_remove(dev);
126 reinstall:
127 	ret = failsafe_hotplug_alarm_install(dev);
128 	if (ret)
129 		ERROR("Unable to set up next alarm");
130 }
131 
132 static int
133 fs_mutex_init(struct fs_priv *priv)
134 {
135 	int ret;
136 	pthread_mutexattr_t attr;
137 
138 	ret = pthread_mutexattr_init(&attr);
139 	if (ret) {
140 		ERROR("Cannot initiate mutex attributes - %s", strerror(ret));
141 		return ret;
142 	}
143 	/* Allow mutex relocks for the thread holding the mutex. */
144 	ret = pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_RECURSIVE);
145 	if (ret) {
146 		ERROR("Cannot set mutex type - %s", strerror(ret));
147 		return ret;
148 	}
149 	ret = pthread_mutex_init(&priv->hotplug_mutex, &attr);
150 	if (ret) {
151 		ERROR("Cannot initiate mutex - %s", strerror(ret));
152 		return ret;
153 	}
154 	return 0;
155 }
156 
157 static int
158 fs_eth_dev_create(struct rte_vdev_device *vdev)
159 {
160 	struct rte_eth_dev *dev;
161 	struct rte_ether_addr *mac;
162 	struct fs_priv *priv;
163 	struct sub_device *sdev;
164 	const char *params;
165 	unsigned int socket_id;
166 	uint8_t i;
167 	int ret;
168 
169 	dev = NULL;
170 	priv = NULL;
171 	socket_id = rte_socket_id();
172 	INFO("Creating fail-safe device on NUMA socket %u", socket_id);
173 	params = rte_vdev_device_args(vdev);
174 	if (params == NULL) {
175 		ERROR("This PMD requires sub-devices, none provided");
176 		return -1;
177 	}
178 	dev = rte_eth_vdev_allocate(vdev, sizeof(*priv));
179 	if (dev == NULL) {
180 		ERROR("Unable to allocate rte_eth_dev");
181 		return -1;
182 	}
183 	priv = PRIV(dev);
184 	priv->data = dev->data;
185 	priv->rxp = FS_RX_PROXY_INIT;
186 	dev->dev_ops = &failsafe_ops;
187 	dev->data->mac_addrs = &PRIV(dev)->mac_addrs[0];
188 	dev->data->dev_link = eth_link;
189 	PRIV(dev)->nb_mac_addr = 1;
190 	TAILQ_INIT(&PRIV(dev)->flow_list);
191 	dev->rx_pkt_burst = (eth_rx_burst_t)&failsafe_rx_burst;
192 	dev->tx_pkt_burst = (eth_tx_burst_t)&failsafe_tx_burst;
193 	ret = fs_sub_device_alloc(dev, params);
194 	if (ret) {
195 		ERROR("Could not allocate sub_devices");
196 		goto free_dev;
197 	}
198 	ret = failsafe_args_parse(dev, params);
199 	if (ret)
200 		goto free_subs;
201 	ret = rte_eth_dev_owner_new(&priv->my_owner.id);
202 	if (ret) {
203 		ERROR("Failed to get unique owner identifier");
204 		goto free_args;
205 	}
206 	snprintf(priv->my_owner.name, sizeof(priv->my_owner.name),
207 		 FAILSAFE_OWNER_NAME);
208 	DEBUG("Failsafe port %u owner info: %s_%016"PRIX64, dev->data->port_id,
209 	      priv->my_owner.name, priv->my_owner.id);
210 	ret = rte_eth_dev_callback_register(RTE_ETH_ALL, RTE_ETH_EVENT_NEW,
211 					    failsafe_eth_new_event_callback,
212 					    dev);
213 	if (ret) {
214 		ERROR("Failed to register NEW callback");
215 		goto free_args;
216 	}
217 	ret = failsafe_eal_init(dev);
218 	if (ret)
219 		goto unregister_new_callback;
220 	ret = fs_mutex_init(priv);
221 	if (ret)
222 		goto unregister_new_callback;
223 	ret = failsafe_hotplug_alarm_install(dev);
224 	if (ret) {
225 		ERROR("Could not set up plug-in event detection");
226 		goto unregister_new_callback;
227 	}
228 	mac = &dev->data->mac_addrs[0];
229 	if (failsafe_mac_from_arg) {
230 		/*
231 		 * If MAC address was provided as a parameter,
232 		 * apply to all probed subdevices.
233 		 */
234 		FOREACH_SUBDEV_STATE(sdev, i, dev, DEV_PROBED) {
235 			ret = rte_eth_dev_default_mac_addr_set(PORT_ID(sdev),
236 							       mac);
237 			if (ret) {
238 				ERROR("Failed to set default MAC address");
239 				goto cancel_alarm;
240 			}
241 		}
242 	} else {
243 		/*
244 		 * Use the ether_addr from first probed
245 		 * device, either preferred or fallback.
246 		 */
247 		FOREACH_SUBDEV(sdev, i, dev)
248 			if (sdev->state >= DEV_PROBED) {
249 				rte_ether_addr_copy(
250 					&ETH(sdev)->data->mac_addrs[0], mac);
251 				break;
252 			}
253 		/*
254 		 * If no device has been probed and no ether_addr
255 		 * has been provided on the command line, use a random
256 		 * valid one.
257 		 * It will be applied during future state syncs to
258 		 * probed subdevices.
259 		 */
260 		if (i == priv->subs_tail)
261 			rte_eth_random_addr(&mac->addr_bytes[0]);
262 	}
263 	INFO("MAC address is " RTE_ETHER_ADDR_PRT_FMT,
264 		RTE_ETHER_ADDR_BYTES(mac));
265 	dev->data->dev_flags |= RTE_ETH_DEV_INTR_LSC |
266 				RTE_ETH_DEV_AUTOFILL_QUEUE_XSTATS;
267 	PRIV(dev)->intr_handle = (struct rte_intr_handle){
268 		.fd = -1,
269 		.type = RTE_INTR_HANDLE_EXT,
270 	};
271 	rte_eth_dev_probing_finish(dev);
272 	return 0;
273 cancel_alarm:
274 	failsafe_hotplug_alarm_cancel(dev);
275 unregister_new_callback:
276 	rte_eth_dev_callback_unregister(RTE_ETH_ALL, RTE_ETH_EVENT_NEW,
277 					failsafe_eth_new_event_callback, dev);
278 free_args:
279 	failsafe_args_free(dev);
280 free_subs:
281 	rte_free(PRIV(dev)->subs);
282 free_dev:
283 	/* mac_addrs must not be freed alone because part of dev_private */
284 	dev->data->mac_addrs = NULL;
285 	rte_eth_dev_release_port(dev);
286 	return -1;
287 }
288 
289 static int
290 fs_rte_eth_free(const char *name)
291 {
292 	struct rte_eth_dev *dev;
293 	int ret;
294 
295 	dev = rte_eth_dev_allocated(name);
296 	if (dev == NULL)
297 		return 0; /* port already released */
298 	ret = failsafe_eth_dev_close(dev);
299 	rte_eth_dev_release_port(dev);
300 	return ret;
301 }
302 
303 static bool
304 devargs_already_listed(struct rte_devargs *devargs)
305 {
306 	struct rte_devargs *list_da;
307 
308 	RTE_EAL_DEVARGS_FOREACH(devargs->bus->name, list_da) {
309 		if (strcmp(list_da->name, devargs->name) == 0)
310 			/* devargs already in the list */
311 			return true;
312 	}
313 	return false;
314 }
315 
316 static int
317 rte_pmd_failsafe_probe(struct rte_vdev_device *vdev)
318 {
319 	const char *name;
320 	struct rte_eth_dev *eth_dev;
321 	struct sub_device  *sdev;
322 	struct rte_devargs devargs;
323 	uint8_t i;
324 	int ret;
325 
326 	name = rte_vdev_device_name(vdev);
327 	INFO("Initializing " FAILSAFE_DRIVER_NAME " for %s",
328 			name);
329 
330 	if (rte_eal_process_type() == RTE_PROC_SECONDARY &&
331 	    strlen(rte_vdev_device_args(vdev)) == 0) {
332 		eth_dev = rte_eth_dev_attach_secondary(name);
333 		if (!eth_dev) {
334 			ERROR("Failed to probe %s", name);
335 			return -1;
336 		}
337 		eth_dev->dev_ops = &failsafe_ops;
338 		eth_dev->device = &vdev->device;
339 		eth_dev->rx_pkt_burst = (eth_rx_burst_t)&failsafe_rx_burst;
340 		eth_dev->tx_pkt_burst = (eth_tx_burst_t)&failsafe_tx_burst;
341 		/*
342 		 * Failsafe will attempt to probe all of its sub-devices.
343 		 * Any failure in sub-devices is not a fatal error.
344 		 * A sub-device can be plugged later.
345 		 */
346 		FOREACH_SUBDEV(sdev, i, eth_dev) {
347 			/* skip empty devargs */
348 			if (sdev->devargs.name[0] == '\0')
349 				continue;
350 
351 			/* rebuild devargs to be able to get the bus name. */
352 			ret = rte_devargs_parse(&devargs,
353 						sdev->devargs.name);
354 			if (ret != 0) {
355 				ERROR("Failed to parse devargs %s",
356 					devargs.name);
357 				continue;
358 			}
359 			if (!devargs_already_listed(&devargs)) {
360 				ret = rte_dev_probe(devargs.name);
361 				if (ret < 0) {
362 					ERROR("Failed to probe devargs %s",
363 					      devargs.name);
364 					continue;
365 				}
366 			}
367 		}
368 		rte_eth_dev_probing_finish(eth_dev);
369 		return 0;
370 	}
371 
372 	return fs_eth_dev_create(vdev);
373 }
374 
375 static int
376 rte_pmd_failsafe_remove(struct rte_vdev_device *vdev)
377 {
378 	const char *name;
379 
380 	name = rte_vdev_device_name(vdev);
381 	INFO("Uninitializing " FAILSAFE_DRIVER_NAME " for %s", name);
382 	return fs_rte_eth_free(name);
383 }
384 
385 static struct rte_vdev_driver failsafe_drv = {
386 	.probe = rte_pmd_failsafe_probe,
387 	.remove = rte_pmd_failsafe_remove,
388 };
389 
390 RTE_PMD_REGISTER_VDEV(net_failsafe, failsafe_drv);
391 RTE_PMD_REGISTER_PARAM_STRING(net_failsafe, PMD_FAILSAFE_PARAM_STRING);
392 RTE_LOG_REGISTER_DEFAULT(failsafe_logtype, NOTICE)
393