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