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