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