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