move device cleanup to common code, fixes use-after-free in tunnel code
[project/netifd.git] / device.c
1 #include <string.h>
2 #include <stdlib.h>
3 #include <stdio.h>
4 #include <assert.h>
5
6 #include <sys/types.h>
7 #include <sys/socket.h>
8 #include <net/ethernet.h>
9
10 #ifdef linux
11 #include <netinet/ether.h>
12 #endif
13
14 #include "netifd.h"
15 #include "system.h"
16 #include "config.h"
17
18 static struct avl_tree devices;
19 static struct avl_tree aliases;
20
21 struct alias_device {
22 struct avl_node avl;
23 struct device dev;
24 struct device_user dep;
25 bool cleanup;
26 char name[];
27 };
28
29 static const struct device_type alias_device_type;
30
31 static const struct blobmsg_policy dev_attrs[__DEV_ATTR_MAX] = {
32 [DEV_ATTR_TYPE] = { "type", BLOBMSG_TYPE_STRING },
33 [DEV_ATTR_IFNAME] = { "ifname", BLOBMSG_TYPE_ARRAY },
34 [DEV_ATTR_MTU] = { "mtu", BLOBMSG_TYPE_INT32 },
35 [DEV_ATTR_MACADDR] = { "macaddr", BLOBMSG_TYPE_STRING },
36 [DEV_ATTR_TXQUEUELEN] = { "txqueuelen", BLOBMSG_TYPE_INT32 },
37 [DEV_ATTR_ENABLED] = { "enabled", BLOBMSG_TYPE_BOOL },
38 };
39
40 const struct config_param_list device_attr_list = {
41 .n_params = __DEV_ATTR_MAX,
42 .params = dev_attrs,
43 };
44
45 static int __devlock = 0;
46
47 void device_lock(void)
48 {
49 __devlock++;
50 }
51
52 void device_unlock(void)
53 {
54 __devlock--;
55 if (!__devlock)
56 device_free_unused(NULL);
57 }
58
59 static int set_device_state(struct device *dev, bool state)
60 {
61 if (state)
62 system_if_up(dev);
63 else
64 system_if_down(dev);
65
66 return 0;
67 }
68
69 static int
70 simple_device_set_state(struct device *dev, bool state)
71 {
72 struct device *pdev;
73 int ret = 0;
74
75 pdev = dev->parent.dev;
76 if (state && !pdev) {
77 pdev = system_if_get_parent(dev);
78 if (pdev)
79 device_add_user(&dev->parent, pdev);
80 }
81
82 if (pdev) {
83 if (state)
84 ret = device_claim(&dev->parent);
85 else
86 device_release(&dev->parent);
87
88 if (ret < 0)
89 return ret;
90 }
91 return set_device_state(dev, state);
92 }
93
94 static struct device *
95 simple_device_create(const char *name, struct blob_attr *attr)
96 {
97 struct blob_attr *tb[__DEV_ATTR_MAX];
98 struct device *dev = NULL;
99
100 blobmsg_parse(dev_attrs, __DEV_ATTR_MAX, tb, blob_data(attr), blob_len(attr));
101 dev = device_get(name, true);
102 if (!dev)
103 return NULL;
104
105 dev->set_state = simple_device_set_state;
106 device_init_settings(dev, tb);
107
108 return dev;
109 }
110
111 static void simple_device_free(struct device *dev)
112 {
113 if (dev->parent.dev)
114 device_remove_user(&dev->parent);
115 free(dev);
116 }
117
118 const struct device_type simple_device_type = {
119 .name = "Network device",
120 .config_params = &device_attr_list,
121
122 .create = simple_device_create,
123 .check_state = system_if_check,
124 .free = simple_device_free,
125 };
126
127 static int
128 alias_device_set_state(struct device *dev, bool state)
129 {
130 struct alias_device *alias;
131
132 alias = container_of(dev, struct alias_device, dev);
133 if (!alias->dep.dev)
134 return -1;
135
136 if (state)
137 return device_claim(&alias->dep);
138
139 device_release(&alias->dep);
140 if (alias->cleanup)
141 device_remove_user(&alias->dep);
142 return 0;
143 }
144
145 static struct device *
146 alias_device_create(const char *name, struct blob_attr *attr)
147 {
148 struct alias_device *alias;
149
150 alias = calloc(1, sizeof(*alias) + strlen(name) + 1);
151 strcpy(alias->name, name);
152 alias->dev.set_state = alias_device_set_state;
153 device_init_virtual(&alias->dev, &alias_device_type, NULL);
154 alias->avl.key = alias->name;
155 avl_insert(&aliases, &alias->avl);
156
157 return &alias->dev;
158 }
159
160 static void alias_device_free(struct device *dev)
161 {
162 struct alias_device *alias;
163
164 alias = container_of(dev, struct alias_device, dev);
165 avl_delete(&aliases, &alias->avl);
166 free(alias);
167 }
168
169 static const struct device_type alias_device_type = {
170 .name = "Network alias",
171 .create = alias_device_create,
172 .free = alias_device_free,
173 };
174
175 static void
176 device_merge_settings(struct device *dev, struct device_settings *n)
177 {
178 struct device_settings *os = &dev->orig_settings;
179 struct device_settings *s = &dev->settings;
180
181 memset(n, 0, sizeof(*n));
182 n->mtu = s->flags & DEV_OPT_MTU ? s->mtu : os->mtu;
183 n->txqueuelen = s->flags & DEV_OPT_TXQUEUELEN ?
184 s->txqueuelen : os->txqueuelen;
185 memcpy(n->macaddr,
186 (s->flags & DEV_OPT_MACADDR ? s->macaddr : os->macaddr),
187 sizeof(n->macaddr));
188 n->flags = s->flags | os->flags;
189 }
190
191 void
192 device_init_settings(struct device *dev, struct blob_attr **tb)
193 {
194 struct device_settings *s = &dev->settings;
195 struct blob_attr *cur;
196 struct ether_addr *ea;
197 bool disabled = false;
198
199 s->flags = 0;
200 if ((cur = tb[DEV_ATTR_ENABLED]))
201 disabled = !blobmsg_get_bool(cur);
202
203 if ((cur = tb[DEV_ATTR_MTU])) {
204 s->mtu = blobmsg_get_u32(cur);
205 s->flags |= DEV_OPT_MTU;
206 }
207
208 if ((cur = tb[DEV_ATTR_TXQUEUELEN])) {
209 s->txqueuelen = blobmsg_get_u32(cur);
210 s->flags |= DEV_OPT_TXQUEUELEN;
211 }
212
213 if ((cur = tb[DEV_ATTR_MACADDR])) {
214 ea = ether_aton(blobmsg_data(cur));
215 if (ea) {
216 memcpy(s->macaddr, ea, 6);
217 s->flags |= DEV_OPT_MACADDR;
218 }
219 }
220
221 device_set_disabled(dev, disabled);
222 }
223
224 static void __init dev_init(void)
225 {
226 avl_init(&devices, avl_strcmp, true, NULL);
227 avl_init(&aliases, avl_strcmp, false, NULL);
228 }
229
230 static void device_broadcast_event(struct device *dev, enum device_event ev)
231 {
232 struct device_user *dep, *tmp;
233
234 list_for_each_entry_safe(dep, tmp, &dev->users, list) {
235 if (!dep->cb)
236 continue;
237
238 dep->cb(dep, ev);
239 }
240 }
241
242 void
243 alias_notify_device(const char *name, struct device *dev)
244 {
245 struct alias_device *alias;
246
247 device_lock();
248
249 alias = avl_find_element(&aliases, name, alias, avl);
250 if (!alias)
251 return;
252
253 alias->cleanup = !dev;
254 if (dev) {
255 if (dev != alias->dep.dev) {
256 device_remove_user(&alias->dep);
257 strcpy(alias->dev.ifname, dev->ifname);
258 device_add_user(&alias->dep, dev);
259 }
260 }
261
262 device_set_present(&alias->dev, !!dev);
263
264 if (!dev && alias->dep.dev && !alias->dep.dev->active)
265 device_remove_user(&alias->dep);
266
267 device_unlock();
268 }
269
270 int device_claim(struct device_user *dep)
271 {
272 struct device *dev = dep->dev;
273 int ret;
274
275 if (dep->claimed)
276 return 0;
277
278 dep->claimed = true;
279 D(DEVICE, "Claim %s %s, new refcount: %d\n", dev->type->name, dev->ifname, dev->active + 1);
280 if (++dev->active != 1)
281 return 0;
282
283 device_broadcast_event(dev, DEV_EVENT_SETUP);
284 ret = dev->set_state(dev, true);
285 if (ret == 0)
286 device_broadcast_event(dev, DEV_EVENT_UP);
287 else {
288 D(DEVICE, "claim device %s failed: %d\n", dev->ifname, ret);
289 dev->active = 0;
290 dep->claimed = false;
291 }
292
293 return ret;
294 }
295
296 void device_release(struct device_user *dep)
297 {
298 struct device *dev = dep->dev;
299
300 if (!dep->claimed)
301 return;
302
303 dep->claimed = false;
304 dev->active--;
305 D(DEVICE, "Release %s %s, new refcount: %d\n", dev->type->name, dev->ifname, dev->active);
306 assert(dev->active >= 0);
307
308 if (dev->active)
309 return;
310
311 device_broadcast_event(dev, DEV_EVENT_TEARDOWN);
312 if (!dep->hotplug)
313 dev->set_state(dev, false);
314 device_broadcast_event(dev, DEV_EVENT_DOWN);
315 }
316
317 int device_check_state(struct device *dev)
318 {
319 if (!dev->type->check_state)
320 return 0;
321
322 return dev->type->check_state(dev);
323 }
324
325 void device_init_virtual(struct device *dev, const struct device_type *type, const char *name)
326 {
327 assert(dev);
328 assert(type);
329
330 if (name)
331 strncpy(dev->ifname, name, IFNAMSIZ);
332
333 D(DEVICE, "Initialize device '%s'\n", dev->ifname);
334 INIT_LIST_HEAD(&dev->users);
335 dev->type = type;
336 }
337
338 int device_init(struct device *dev, const struct device_type *type, const char *ifname)
339 {
340 int ret;
341
342 device_init_virtual(dev, type, ifname);
343
344 if (!dev->set_state)
345 dev->set_state = set_device_state;
346
347 dev->avl.key = dev->ifname;
348
349 ret = avl_insert(&devices, &dev->avl);
350 if (ret < 0)
351 return ret;
352
353 system_if_clear_state(dev);
354 device_check_state(dev);
355
356 return 0;
357 }
358
359 static struct device *
360 device_create_default(const char *name, bool external)
361 {
362 struct device *dev;
363
364 D(DEVICE, "Create simple device '%s'\n", name);
365 dev = calloc(1, sizeof(*dev));
366 dev->external = external;
367 dev->set_state = simple_device_set_state;
368 device_init(dev, &simple_device_type, name);
369 dev->default_config = true;
370 return dev;
371 }
372
373 static struct device *
374 device_alias_get(const char *name)
375 {
376 struct alias_device *alias;
377
378 alias = avl_find_element(&aliases, name, alias, avl);
379 if (alias)
380 return &alias->dev;
381
382 return alias_device_create(name, NULL);
383 }
384
385 struct device *
386 device_get(const char *name, int create)
387 {
388 struct device *dev;
389
390 if (strchr(name, '.'))
391 return get_vlan_device_chain(name, create);
392
393 if (name[0] == '@')
394 return device_alias_get(name + 1);
395
396 dev = avl_find_element(&devices, name, dev, avl);
397 if (dev)
398 return dev;
399
400 if (!create)
401 return NULL;
402
403 return device_create_default(name, create > 1);
404 }
405
406 static void
407 device_delete(struct device *dev)
408 {
409 if (!dev->avl.key)
410 return;
411
412 D(DEVICE, "Delete device '%s' from list\n", dev->ifname);
413 avl_delete(&devices, &dev->avl);
414 dev->avl.key = NULL;
415 }
416
417 void device_cleanup(struct device *dev)
418 {
419 struct device_user *dep, *tmp;
420
421 D(DEVICE, "Clean up device '%s'\n", dev->ifname);
422 list_for_each_entry_safe(dep, tmp, &dev->users, list) {
423 if (!dep->cb)
424 continue;
425
426 dep->cb(dep, DEV_EVENT_REMOVE);
427 device_release(dep);
428 }
429
430 device_delete(dev);
431 }
432
433 static void __device_set_present(struct device *dev, bool state)
434 {
435 if (dev->present == state)
436 return;
437
438 dev->present = state;
439 device_broadcast_event(dev, state ? DEV_EVENT_ADD : DEV_EVENT_REMOVE);
440 }
441
442 void device_set_present(struct device *dev, bool state)
443 {
444 if (dev->sys_present == state)
445 return;
446
447 dev->sys_present = state;
448 D(DEVICE, "%s '%s' %s present\n", dev->type->name, dev->ifname, state ? "is now" : "is no longer" );
449
450 if (state && dev->disabled)
451 return;
452
453 __device_set_present(dev, state);
454 }
455
456 void
457 device_set_disabled(struct device *dev, bool value)
458 {
459 dev->disabled = value;
460 if (dev->sys_present)
461 __device_set_present(dev, !value);
462 }
463
464 void device_add_user(struct device_user *dep, struct device *dev)
465 {
466 if (dep->dev)
467 device_remove_user(dep);
468
469 dep->dev = dev;
470 list_add_tail(&dep->list, &dev->users);
471 if (dep->cb && dev->present) {
472 dep->cb(dep, DEV_EVENT_ADD);
473 if (dev->active)
474 dep->cb(dep, DEV_EVENT_UP);
475 }
476 }
477
478 void
479 device_free(struct device *dev)
480 {
481 __devlock++;
482 free(dev->config);
483 device_cleanup(dev);
484 dev->type->free(dev);
485 __devlock--;
486 }
487
488 static void
489 __device_free_unused(struct device *dev)
490 {
491 if (!list_empty(&dev->users) || dev->current_config || __devlock)
492 return;
493
494 device_free(dev);
495 }
496
497 void device_remove_user(struct device_user *dep)
498 {
499 struct device *dev = dep->dev;
500
501 if (!dep->dev)
502 return;
503
504 dep->hotplug = false;
505 if (dep->claimed)
506 device_release(dep);
507
508 list_del(&dep->list);
509 dep->dev = NULL;
510 __device_free_unused(dev);
511 }
512
513 void
514 device_free_unused(struct device *dev)
515 {
516 struct device *tmp;
517
518 if (dev)
519 return __device_free_unused(dev);
520
521 avl_for_each_element_safe(&devices, dev, avl, tmp)
522 __device_free_unused(dev);
523 }
524
525 void
526 device_init_pending(void)
527 {
528 struct device *dev, *tmp;
529
530 avl_for_each_element_safe(&devices, dev, avl, tmp) {
531 if (!dev->config_pending)
532 continue;
533
534 dev->type->config_init(dev);
535 dev->config_pending = false;
536 }
537 }
538
539 static enum dev_change_type
540 device_reload_config(struct device *dev, struct blob_attr *attr)
541 {
542 struct blob_attr *tb[__DEV_ATTR_MAX];
543 const struct config_param_list *cfg = dev->type->config_params;
544
545 if (config_check_equal(dev->config, attr, cfg))
546 return DEV_CONFIG_NO_CHANGE;
547
548 if (cfg == &device_attr_list) {
549 memset(tb, 0, sizeof(tb));
550
551 if (attr)
552 blobmsg_parse(dev_attrs, __DEV_ATTR_MAX, tb,
553 blob_data(attr), blob_len(attr));
554
555 device_init_settings(dev, tb);
556 return DEV_CONFIG_RESTART;
557 } else
558 return DEV_CONFIG_RECREATE;
559 }
560
561 enum dev_change_type
562 device_set_config(struct device *dev, const struct device_type *type,
563 struct blob_attr *attr)
564 {
565 if (type != dev->type)
566 return DEV_CONFIG_RECREATE;
567
568 if (dev->type->reload)
569 return dev->type->reload(dev, attr);
570
571 return device_reload_config(dev, attr);
572 }
573
574 static void
575 device_replace(struct device *dev, struct device *odev)
576 {
577 struct device_user *dep, *tmp;
578 bool present = odev->present;
579
580 if (present)
581 device_set_present(odev, false);
582
583 list_for_each_entry_safe(dep, tmp, &odev->users, list) {
584 device_release(dep);
585 list_move_tail(&dep->list, &dev->users);
586 dep->dev = dev;
587 }
588 device_free(odev);
589
590 if (present)
591 device_set_present(dev, true);
592 }
593
594 void
595 device_reset_config(void)
596 {
597 struct device *dev;
598
599 avl_for_each_element(&devices, dev, avl)
600 dev->current_config = false;
601 }
602
603 void
604 device_reset_old(void)
605 {
606 struct device *dev, *tmp, *ndev;
607
608 avl_for_each_element_safe(&devices, dev, avl, tmp) {
609 if (dev->current_config || dev->default_config)
610 continue;
611
612 if (dev->type != &simple_device_type)
613 continue;
614
615 ndev = device_create_default(dev->ifname, dev->external);
616 device_replace(ndev, dev);
617 }
618 }
619
620 struct device *
621 device_create(const char *name, const struct device_type *type,
622 struct blob_attr *config)
623 {
624 struct device *odev = NULL, *dev;
625 enum dev_change_type change;
626
627 config = config_memdup(config);
628 if (!config)
629 return NULL;
630
631 odev = device_get(name, false);
632 if (odev) {
633 odev->current_config = true;
634 change = device_set_config(odev, type, config);
635 switch (change) {
636 case DEV_CONFIG_RESTART:
637 case DEV_CONFIG_APPLIED:
638 D(DEVICE, "Device '%s': config applied\n", odev->ifname);
639 free(odev->config);
640 odev->config = config;
641 if (change == DEV_CONFIG_RESTART && odev->present) {
642 device_set_present(odev, false);
643 device_set_present(odev, true);
644 }
645 return odev;
646 case DEV_CONFIG_NO_CHANGE:
647 D(DEVICE, "Device '%s': no configuration change\n", odev->ifname);
648 free(config);
649 return odev;
650 case DEV_CONFIG_RECREATE:
651 D(DEVICE, "Device '%s': recreate device\n", odev->ifname);
652 device_delete(odev);
653 break;
654 }
655 } else
656 D(DEVICE, "Create new device '%s' (%s)\n", name, type->name);
657
658 dev = type->create(name, config);
659 if (!dev)
660 return NULL;
661
662 dev->current_config = true;
663 dev->config = config;
664 if (odev)
665 device_replace(dev, odev);
666
667 if (!config_init && dev->config_pending)
668 type->config_init(dev);
669
670 return dev;
671 }
672
673 void
674 device_dump_status(struct blob_buf *b, struct device *dev)
675 {
676 struct device_settings st;
677 void *c, *s;
678
679 if (!dev) {
680 avl_for_each_element(&devices, dev, avl) {
681 if (!dev->present)
682 continue;
683 c = blobmsg_open_table(b, dev->ifname);
684 device_dump_status(b, dev);
685 blobmsg_close_table(b, c);
686 }
687
688 return;
689 }
690
691 if (!dev->present)
692 return;
693
694 blobmsg_add_string(b, "type", dev->type->name);
695 blobmsg_add_u8(b, "up", !!dev->active);
696 if (dev->type->dump_info)
697 dev->type->dump_info(dev, b);
698 else
699 system_if_dump_info(dev, b);
700
701 if (dev->active) {
702 device_merge_settings(dev, &st);
703 if (st.flags & DEV_OPT_MTU)
704 blobmsg_add_u32(b, "mtu", st.mtu);
705 if (st.flags & DEV_OPT_MACADDR)
706 blobmsg_add_string(b, "macaddr", ether_ntoa((struct ether_addr *) st.macaddr));
707 if (st.flags & DEV_OPT_TXQUEUELEN)
708 blobmsg_add_u32(b, "txqueuelen", st.txqueuelen);
709 }
710
711 s = blobmsg_open_table(b, "statistics");
712 if (dev->type->dump_stats)
713 dev->type->dump_stats(dev, b);
714 else
715 system_if_dump_stats(dev, b);
716 blobmsg_close_table(b, s);
717 }