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