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 static void
 179 device_merge_settings(struct device *dev, struct device_settings *n)
 180 {
 181         struct device_settings *os = &dev->orig_settings;
 182         struct device_settings *s = &dev->settings;
 183
 184         memset(n, 0, sizeof(*n));
 185         n->mtu = s->flags & DEV_OPT_MTU ? s->mtu : os->mtu;
 186         n->txqueuelen = s->flags & DEV_OPT_TXQUEUELEN ?
 187                 s->txqueuelen : os->txqueuelen;
 188         memcpy(n->macaddr,
 189                 (s->flags & DEV_OPT_MACADDR ? s->macaddr : os->macaddr),
 190                 sizeof(n->macaddr));
 191         n->flags = s->flags | os->flags;
 192 }
 193
 194 void
 195 device_init_settings(struct device *dev, struct blob_attr **tb)
 196 {
 197         struct device_settings *s = &dev->settings;
 198         struct blob_attr *cur;
 199         struct ether_addr *ea;
 200         bool disabled = false;
 201
 202         s->flags = 0;
 203         if ((cur = tb[DEV_ATTR_ENABLED]))
 204                 disabled = !blobmsg_get_bool(cur);
 205
 206         if ((cur = tb[DEV_ATTR_MTU])) {
 207                 s->mtu = blobmsg_get_u32(cur);
 208                 s->flags |= DEV_OPT_MTU;
 209         }
 210
 211         if ((cur = tb[DEV_ATTR_TXQUEUELEN])) {
 212                 s->txqueuelen = blobmsg_get_u32(cur);
 213                 s->flags |= DEV_OPT_TXQUEUELEN;
 214         }
 215
 216         if ((cur = tb[DEV_ATTR_MACADDR])) {
 217                 ea = ether_aton(blobmsg_data(cur));
 218                 if (ea) {
 219                         memcpy(s->macaddr, ea, 6);
 220                         s->flags |= DEV_OPT_MACADDR;
 221                 }
 222         }
 223
 224         device_set_disabled(dev, disabled);
 225 }
 226
 227 static void __init dev_init(void)
 228 {
 229         avl_init(&devices, avl_strcmp, true, NULL);
 230         avl_init(&aliases, avl_strcmp, false, NULL);
 231 }
 232
 233 static void device_broadcast_event(struct device *dev, enum device_event ev)
 234 {
 235         struct device_user *dep, *tmp;
 236
 237         list_for_each_entry_safe(dep, tmp, &dev->users, list) {
 238                 if (!dep->cb)
 239                         continue;
 240
 241                 dep->cb(dep, ev);
 242         }
 243 }
 244
 245 void
 246 alias_notify_device(const char *name, struct device *dev)
 247 {
 248         struct alias_device *alias;
 249
 250         device_lock();
 251
 252         alias = avl_find_element(&aliases, name, alias, avl);
 253         if (!alias)
 254                 return;
 255
 256         alias->cleanup = !dev;
 257         if (dev) {
 258                 if (dev != alias->dep.dev) {
 259                         device_remove_user(&alias->dep);
 260                         strcpy(alias->dev.ifname, dev->ifname);
 261                         device_add_user(&alias->dep, dev);
 262                 }
 263         }
 264
 265         device_set_present(&alias->dev, !!dev);
 266
 267         if (!dev && alias->dep.dev && !alias->dep.dev->active)
 268                 device_remove_user(&alias->dep);
 269
 270         device_unlock();
 271 }
 272
 273 int device_claim(struct device_user *dep)
 274 {
 275         struct device *dev = dep->dev;
 276         int ret;
 277
 278         if (dep->claimed)
 279                 return 0;
 280
 281         dep->claimed = true;
 282         D(DEVICE, "Claim %s %s, new refcount: %d\n", dev->type->name, dev->ifname, dev->active + 1);
 283         if (++dev->active != 1)
 284                 return 0;
 285
 286         device_broadcast_event(dev, DEV_EVENT_SETUP);
 287         ret = dev->set_state(dev, true);
 288         if (ret == 0)
 289                 device_broadcast_event(dev, DEV_EVENT_UP);
 290         else {
 291                 D(DEVICE, "claim device %s failed: %d\n", dev->ifname, ret);
 292                 dev->active = 0;
 293                 dep->claimed = false;
 294         }
 295
 296         return ret;
 297 }
 298
 299 void device_release(struct device_user *dep)
 300 {
 301         struct device *dev = dep->dev;
 302
 303         if (!dep->claimed)
 304                 return;
 305
 306         dep->claimed = false;
 307         dev->active--;
 308         D(DEVICE, "Release %s %s, new refcount: %d\n", dev->type->name, dev->ifname, dev->active);
 309         assert(dev->active >= 0);
 310
 311         if (dev->active)
 312                 return;
 313
 314         device_broadcast_event(dev, DEV_EVENT_TEARDOWN);
 315         if (!dep->hotplug)
 316                 dev->set_state(dev, false);
 317         device_broadcast_event(dev, DEV_EVENT_DOWN);
 318 }
 319
 320 int device_check_state(struct device *dev)
 321 {
 322         if (!dev->type->check_state)
 323                 return 0;
 324
 325         return dev->type->check_state(dev);
 326 }
 327
 328 void device_init_virtual(struct device *dev, const struct device_type *type, const char *name)
 329 {
 330         assert(dev);
 331         assert(type);
 332
 333         if (name)
 334                 strncpy(dev->ifname, name, IFNAMSIZ);
 335
 336         D(DEVICE, "Initialize device '%s'\n", dev->ifname);
 337         INIT_LIST_HEAD(&dev->users);
 338         dev->type = type;
 339 }
 340
 341 int device_init(struct device *dev, const struct device_type *type, const char *ifname)
 342 {
 343         int ret;
 344
 345         device_init_virtual(dev, type, ifname);
 346
 347         if (!dev->set_state)
 348                 dev->set_state = set_device_state;
 349
 350         dev->avl.key = dev->ifname;
 351
 352         ret = avl_insert(&devices, &dev->avl);
 353         if (ret < 0)
 354                 return ret;
 355
 356         system_if_clear_state(dev);
 357         device_check_state(dev);
 358
 359         return 0;
 360 }
 361
 362 static struct device *
 363 device_create_default(const char *name, bool external)
 364 {
 365         struct device *dev;
 366
 367         D(DEVICE, "Create simple device '%s'\n", name);
 368         dev = calloc(1, sizeof(*dev));
 369         dev->external = external;
 370         dev->set_state = simple_device_set_state;
 371         device_init(dev, &simple_device_type, name);
 372         dev->default_config = true;
 373         return dev;
 374 }
 375
 376 static struct device *
 377 device_alias_get(const char *name)
 378 {
 379         struct alias_device *alias;
 380
 381         alias = avl_find_element(&aliases, name, alias, avl);
 382         if (alias)
 383                 return &alias->dev;
 384
 385         return alias_device_create(name, NULL);
 386 }
 387
 388 struct device *
 389 device_get(const char *name, int create)
 390 {
 391         struct device *dev;
 392
 393         if (strchr(name, '.'))
 394                 return get_vlan_device_chain(name, create);
 395
 396         if (name[0] == '@')
 397                 return device_alias_get(name + 1);
 398
 399         dev = avl_find_element(&devices, name, dev, avl);
 400         if (dev)
 401                 return dev;
 402
 403         if (!create)
 404                 return NULL;
 405
 406         return device_create_default(name, create > 1);
 407 }
 408
 409 static void
 410 device_delete(struct device *dev)
 411 {
 412         if (!dev->avl.key)
 413                 return;
 414
 415         D(DEVICE, "Delete device '%s' from list\n", dev->ifname);
 416         avl_delete(&devices, &dev->avl);
 417         dev->avl.key = NULL;
 418 }
 419
 420 void device_cleanup(struct device *dev)
 421 {
 422         struct device_user *dep, *tmp;
 423
 424         D(DEVICE, "Clean up device '%s'\n", dev->ifname);
 425         list_for_each_entry_safe(dep, tmp, &dev->users, list) {
 426                 if (!dep->cb)
 427                         continue;
 428
 429                 dep->cb(dep, DEV_EVENT_REMOVE);
 430                 device_release(dep);
 431         }
 432
 433         device_delete(dev);
 434 }
 435
 436 static void __device_set_present(struct device *dev, bool state)
 437 {
 438         if (dev->present == state)
 439                 return;
 440
 441         dev->present = state;
 442         device_broadcast_event(dev, state ? DEV_EVENT_ADD : DEV_EVENT_REMOVE);
 443 }
 444
 445 void device_set_present(struct device *dev, bool state)
 446 {
 447         if (dev->sys_present == state)
 448                 return;
 449
 450         dev->sys_present = state;
 451         D(DEVICE, "%s '%s' %s present\n", dev->type->name, dev->ifname, state ? "is now" : "is no longer" );
 452
 453         if (state && dev->disabled)
 454                 return;
 455
 456         __device_set_present(dev, state);
 457 }
 458
 459 void
 460 device_set_disabled(struct device *dev, bool value)
 461 {
 462         dev->disabled = value;
 463         if (dev->sys_present)
 464                 __device_set_present(dev, !value);
 465 }
 466
 467 void device_add_user(struct device_user *dep, struct device *dev)
 468 {
 469         if (dep->dev)
 470                 device_remove_user(dep);
 471
 472         dep->dev = dev;
 473         list_add_tail(&dep->list, &dev->users);
 474         if (dep->cb && dev->present) {
 475                 dep->cb(dep, DEV_EVENT_ADD);
 476                 if (dev->active)
 477                         dep->cb(dep, DEV_EVENT_UP);
 478         }
 479 }
 480
 481 void
 482 device_free(struct device *dev)
 483 {
 484         __devlock++;
 485         dev->type->free(dev);
 486         __devlock--;
 487 }
 488
 489 static void
 490 __device_free_unused(struct device *dev)
 491 {
 492         if (!list_empty(&dev->users) || dev->current_config || __devlock)
 493                 return;
 494
 495         device_free(dev);
 496 }
 497
 498 void device_remove_user(struct device_user *dep)
 499 {
 500         struct device *dev = dep->dev;
 501
 502         if (!dep->dev)
 503                 return;
 504
 505         dep->hotplug = false;
 506         if (dep->claimed)
 507                 device_release(dep);
 508
 509         list_del(&dep->list);
 510         dep->dev = NULL;
 511         __device_free_unused(dev);
 512 }
 513
 514 void
 515 device_free_unused(struct device *dev)
 516 {
 517         struct device *tmp;
 518
 519         if (dev)
 520                 return __device_free_unused(dev);
 521
 522         avl_for_each_element_safe(&devices, dev, avl, tmp)
 523                 __device_free_unused(dev);
 524 }
 525
 526 void
 527 device_init_pending(void)
 528 {
 529         struct device *dev, *tmp;
 530
 531         avl_for_each_element_safe(&devices, dev, avl, tmp) {
 532                 if (!dev->config_pending)
 533                         continue;
 534
 535                 dev->type->config_init(dev);
 536                 dev->config_pending = false;
 537         }
 538 }
 539
 540 static enum dev_change_type
 541 device_reload_config(struct device *dev, struct blob_attr *attr)
 542 {
 543         struct blob_attr *tb[__DEV_ATTR_MAX];
 544         const struct config_param_list *cfg = dev->type->config_params;
 545
 546         if (config_check_equal(dev->config, attr, cfg))
 547                 return DEV_CONFIG_NO_CHANGE;
 548
 549         if (cfg == &device_attr_list) {
 550                 memset(tb, 0, sizeof(tb));
 551
 552                 if (attr)
 553                         blobmsg_parse(dev_attrs, __DEV_ATTR_MAX, tb,
 554                                 blob_data(attr), blob_len(attr));
 555
 556                 device_init_settings(dev, tb);
 557                 return DEV_CONFIG_RESTART;
 558         } else
 559                 return DEV_CONFIG_RECREATE;
 560 }
 561
 562 enum dev_change_type
 563 device_set_config(struct device *dev, const struct device_type *type,
 564                   struct blob_attr *attr)
 565 {
 566         if (type != dev->type)
 567                 return DEV_CONFIG_RECREATE;
 568
 569         if (dev->type->reload)
 570                 return dev->type->reload(dev, attr);
 571
 572         return device_reload_config(dev, attr);
 573 }
 574
 575 static void
 576 device_replace(struct device *dev, struct device *odev)
 577 {
 578         struct device_user *dep, *tmp;
 579         bool present = odev->present;
 580
 581         if (present)
 582                 device_set_present(odev, false);
 583
 584         list_for_each_entry_safe(dep, tmp, &odev->users, list) {
 585                 device_release(dep);
 586                 list_move_tail(&dep->list, &dev->users);
 587                 dep->dev = dev;
 588         }
 589         device_free(odev);
 590
 591         if (present)
 592                 device_set_present(dev, true);
 593 }
 594
 595 void
 596 device_reset_config(void)
 597 {
 598         struct device *dev;
 599
 600         avl_for_each_element(&devices, dev, avl)
 601                 dev->current_config = false;
 602 }
 603
 604 void
 605 device_reset_old(void)
 606 {
 607         struct device *dev, *tmp, *ndev;
 608
 609         avl_for_each_element_safe(&devices, dev, avl, tmp) {
 610                 if (dev->current_config || dev->default_config)
 611                         continue;
 612
 613                 if (dev->type != &simple_device_type)
 614                         continue;
 615
 616                 ndev = device_create_default(dev->ifname, dev->external);
 617                 device_replace(ndev, dev);
 618         }
 619 }
 620
 621 struct device *
 622 device_create(const char *name, const struct device_type *type,
 623               struct blob_attr *config)
 624 {
 625         struct device *odev = NULL, *dev;
 626         enum dev_change_type change;
 627
 628         config = config_memdup(config);
 629         if (!config)
 630                 return NULL;
 631
 632         odev = device_get(name, false);
 633         if (odev) {
 634                 odev->current_config = true;
 635                 change = device_set_config(odev, type, config);
 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         if (!dev->present)
 693                 return;
 694
 695         blobmsg_add_string(b, "type", dev->type->name);
 696         blobmsg_add_u8(b, "up", !!dev->active);
 697         if (dev->type->dump_info)
 698                 dev->type->dump_info(dev, b);
 699         else
 700                 system_if_dump_info(dev, b);
 701
 702         if (dev->active) {
 703                 device_merge_settings(dev, &st);
 704                 if (st.flags & DEV_OPT_MTU)
 705                         blobmsg_add_u32(b, "mtu", st.mtu);
 706                 if (st.flags & DEV_OPT_MACADDR)
 707                         blobmsg_add_string(b, "macaddr", ether_ntoa((struct ether_addr *) st.macaddr));
 708                 if (st.flags & DEV_OPT_TXQUEUELEN)
 709                         blobmsg_add_u32(b, "txqueuelen", st.txqueuelen);
 710         }
 711
 712         s = blobmsg_open_table(b, "statistics");
 713         if (dev->type->dump_stats)
 714                 dev->type->dump_stats(dev, b);
 715         else
 716                 system_if_dump_stats(dev, b);
 717         blobmsg_close_table(b, s);
 718 }