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