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
 201         s->flags = 0;
 202         dev->disabled = false;
 203
 204         if ((cur = tb[DEV_ATTR_ENABLED]))
 205                 device_set_disabled(dev, !blobmsg_get_bool(cur));
 206
 207         if ((cur = tb[DEV_ATTR_MTU])) {
 208                 s->mtu = blobmsg_get_u32(cur);
 209                 s->flags |= DEV_OPT_MTU;
 210         }
 211
 212         if ((cur = tb[DEV_ATTR_TXQUEUELEN])) {
 213                 s->txqueuelen = blobmsg_get_u32(cur);
 214                 s->flags |= DEV_OPT_TXQUEUELEN;
 215         }
 216
 217         if ((cur = tb[DEV_ATTR_MACADDR])) {
 218                 ea = ether_aton(blob_data(cur));
 219                 if (ea) {
 220                         memcpy(s->macaddr, ea, 6);
 221                         s->flags |= DEV_OPT_MACADDR;
 222                 }
 223         }
 224 }
 225
 226 static void __init dev_init(void)
 227 {
 228         avl_init(&devices, avl_strcmp, true, NULL);
 229         avl_init(&aliases, avl_strcmp, false, NULL);
 230 }
 231
 232 static void device_broadcast_event(struct device *dev, enum device_event ev)
 233 {
 234         struct device_user *dep, *tmp;
 235
 236         list_for_each_entry_safe(dep, tmp, &dev->users, list) {
 237                 if (!dep->cb)
 238                         continue;
 239
 240                 dep->cb(dep, ev);
 241         }
 242 }
 243
 244 void
 245 alias_notify_device(const char *name, struct device *dev)
 246 {
 247         struct alias_device *alias;
 248
 249         device_lock();
 250
 251         alias = avl_find_element(&aliases, name, alias, avl);
 252         if (!alias)
 253                 return;
 254
 255         alias->cleanup = !dev;
 256         if (dev) {
 257                 if (dev != alias->dep.dev) {
 258                         device_remove_user(&alias->dep);
 259                         strcpy(alias->dev.ifname, dev->ifname);
 260                         device_add_user(&alias->dep, dev);
 261                 }
 262         }
 263
 264         device_set_present(&alias->dev, !!dev);
 265
 266         if (!dev && alias->dep.dev && !alias->dep.dev->active)
 267                 device_remove_user(&alias->dep);
 268
 269         device_unlock();
 270 }
 271
 272 int device_claim(struct device_user *dep)
 273 {
 274         struct device *dev = dep->dev;
 275         int ret;
 276
 277         if (dep->claimed)
 278                 return 0;
 279
 280         dep->claimed = true;
 281         D(DEVICE, "Claim %s %s, new refcount: %d\n", dev->type->name, dev->ifname, dev->active + 1);
 282         if (++dev->active != 1)
 283                 return 0;
 284
 285         device_broadcast_event(dev, DEV_EVENT_SETUP);
 286         ret = dev->set_state(dev, true);
 287         if (ret == 0)
 288                 device_broadcast_event(dev, DEV_EVENT_UP);
 289         else {
 290                 D(DEVICE, "claim device %s failed: %d\n", dev->ifname, ret);
 291                 dev->active = 0;
 292                 dep->claimed = false;
 293         }
 294
 295         return ret;
 296 }
 297
 298 void device_release(struct device_user *dep)
 299 {
 300         struct device *dev = dep->dev;
 301
 302         if (!dep->claimed)
 303                 return;
 304
 305         dep->claimed = false;
 306         dev->active--;
 307         D(DEVICE, "Release %s %s, new refcount: %d\n", dev->type->name, dev->ifname, dev->active);
 308         assert(dev->active >= 0);
 309
 310         if (dev->active)
 311                 return;
 312
 313         device_broadcast_event(dev, DEV_EVENT_TEARDOWN);
 314         dev->set_state(dev, false);
 315         device_broadcast_event(dev, DEV_EVENT_DOWN);
 316 }
 317
 318 int device_check_state(struct device *dev)
 319 {
 320         if (!dev->type->check_state)
 321                 return 0;
 322
 323         return dev->type->check_state(dev);
 324 }
 325
 326 void device_init_virtual(struct device *dev, const struct device_type *type, const char *name)
 327 {
 328         assert(dev);
 329         assert(type);
 330
 331         if (name)
 332                 strncpy(dev->ifname, name, IFNAMSIZ);
 333
 334         D(DEVICE, "Initialize device '%s'\n", dev->ifname);
 335         INIT_LIST_HEAD(&dev->users);
 336         dev->type = type;
 337 }
 338
 339 int device_init(struct device *dev, const struct device_type *type, const char *ifname)
 340 {
 341         int ret;
 342
 343         device_init_virtual(dev, type, ifname);
 344
 345         if (!dev->set_state)
 346                 dev->set_state = set_device_state;
 347
 348         dev->avl.key = dev->ifname;
 349
 350         ret = avl_insert(&devices, &dev->avl);
 351         if (ret < 0)
 352                 return ret;
 353
 354         system_if_clear_state(dev);
 355         device_check_state(dev);
 356
 357         return 0;
 358 }
 359
 360 static struct device *
 361 device_create_default(const char *name, bool external)
 362 {
 363         struct device *dev;
 364
 365         D(DEVICE, "Create simple device '%s'\n", name);
 366         dev = calloc(1, sizeof(*dev));
 367         dev->external = external;
 368         dev->set_state = simple_device_set_state;
 369         device_init(dev, &simple_device_type, name);
 370         dev->default_config = true;
 371         return dev;
 372 }
 373
 374 static struct device *
 375 device_alias_get(const char *name)
 376 {
 377         struct alias_device *alias;
 378
 379         alias = avl_find_element(&aliases, name, alias, avl);
 380         if (alias)
 381                 return &alias->dev;
 382
 383         return alias_device_create(name, NULL);
 384 }
 385
 386 struct device *
 387 device_get(const char *name, int create)
 388 {
 389         struct device *dev;
 390
 391         if (strchr(name, '.'))
 392                 return get_vlan_device_chain(name, create);
 393
 394         if (name[0] == '@')
 395                 return device_alias_get(name + 1);
 396
 397         dev = avl_find_element(&devices, name, dev, avl);
 398         if (dev)
 399                 return dev;
 400
 401         if (!create)
 402                 return NULL;
 403
 404         return device_create_default(name, create > 1);
 405 }
 406
 407 static void
 408 device_delete(struct device *dev)
 409 {
 410         if (!dev->avl.key)
 411                 return;
 412
 413         D(DEVICE, "Delete device '%s' from list\n", dev->ifname);
 414         avl_delete(&devices, &dev->avl);
 415         dev->avl.key = NULL;
 416 }
 417
 418 void device_cleanup(struct device *dev)
 419 {
 420         struct device_user *dep, *tmp;
 421
 422         D(DEVICE, "Clean up device '%s'\n", dev->ifname);
 423         list_for_each_entry_safe(dep, tmp, &dev->users, list) {
 424                 if (!dep->cb)
 425                         continue;
 426
 427                 dep->cb(dep, DEV_EVENT_REMOVE);
 428                 device_release(dep);
 429         }
 430
 431         device_delete(dev);
 432 }
 433
 434 static void __device_set_present(struct device *dev, bool state)
 435 {
 436         if (dev->present == state)
 437                 return;
 438
 439         dev->present = state;
 440         device_broadcast_event(dev, state ? DEV_EVENT_ADD : DEV_EVENT_REMOVE);
 441 }
 442
 443 void device_set_present(struct device *dev, bool state)
 444 {
 445         if (dev->sys_present == state)
 446                 return;
 447
 448         dev->sys_present = state;
 449         D(DEVICE, "%s '%s' %s present\n", dev->type->name, dev->ifname, state ? "is now" : "is no longer" );
 450
 451         if (state && dev->disabled)
 452                 return;
 453
 454         __device_set_present(dev, state);
 455 }
 456
 457 void
 458 device_set_disabled(struct device *dev, bool value)
 459 {
 460         dev->disabled = value;
 461         if (dev->sys_present)
 462                 __device_set_present(dev, !value);
 463 }
 464
 465 void device_add_user(struct device_user *dep, struct device *dev)
 466 {
 467         dep->dev = dev;
 468         list_add_tail(&dep->list, &dev->users);
 469         if (dep->cb && dev->present) {
 470                 dep->cb(dep, DEV_EVENT_ADD);
 471                 if (dev->active)
 472                         dep->cb(dep, DEV_EVENT_UP);
 473         }
 474 }
 475
 476 void
 477 device_free(struct device *dev)
 478 {
 479         __devlock++;
 480         dev->type->free(dev);
 481         __devlock--;
 482 }
 483
 484 static void
 485 __device_free_unused(struct device *dev)
 486 {
 487         if (!list_empty(&dev->users) || dev->current_config || __devlock)
 488                 return;
 489
 490         device_free(dev);
 491 }
 492
 493 void device_remove_user(struct device_user *dep)
 494 {
 495         struct device *dev = dep->dev;
 496
 497         if (!dep->dev)
 498                 return;
 499
 500         dep->hotplug = false;
 501         if (dep->claimed)
 502                 device_release(dep);
 503
 504         list_del(&dep->list);
 505         dep->dev = NULL;
 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 config_param_list *cfg = dev->type->config_params;
 540
 541         if (config_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_APPLIED;
 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) {
 580                 device_release(dep);
 581                 list_move_tail(&dep->list, &dev->users);
 582                 dep->dev = dev;
 583         }
 584         device_free(odev);
 585
 586         if (present)
 587                 device_set_present(dev, true);
 588 }
 589
 590 void
 591 device_reset_config(void)
 592 {
 593         struct device *dev;
 594
 595         avl_for_each_element(&devices, dev, avl)
 596                 dev->current_config = false;
 597 }
 598
 599 void
 600 device_reset_old(void)
 601 {
 602         struct device *dev, *tmp, *ndev;
 603
 604         avl_for_each_element_safe(&devices, dev, avl, tmp) {
 605                 if (dev->current_config || dev->default_config)
 606                         continue;
 607
 608                 if (dev->type != &simple_device_type)
 609                         continue;
 610
 611                 ndev = device_create_default(dev->ifname, dev->external);
 612                 device_replace(ndev, dev);
 613         }
 614 }
 615
 616 struct device *
 617 device_create(const char *name, const struct device_type *type,
 618               struct blob_attr *config)
 619 {
 620         struct device *odev = NULL, *dev;
 621         enum dev_change_type change;
 622
 623         config = config_memdup(config);
 624         if (!config)
 625                 return NULL;
 626
 627         odev = device_get(name, false);
 628         if (odev) {
 629                 odev->current_config = true;
 630                 change = device_set_config(odev, type, config);
 631                 switch (change) {
 632                 case DEV_CONFIG_APPLIED:
 633                         D(DEVICE, "Device '%s': config applied\n", odev->ifname);
 634                         free(odev->config);
 635                         odev->config = config;
 636                         if (odev->present) {
 637                                 device_set_present(odev, false);
 638                                 device_set_present(odev, true);
 639                         }
 640                         return odev;
 641                 case DEV_CONFIG_NO_CHANGE:
 642                         D(DEVICE, "Device '%s': no configuration change\n", odev->ifname);
 643                         free(config);
 644                         return odev;
 645                 case DEV_CONFIG_RECREATE:
 646                         D(DEVICE, "Device '%s': recreate device\n", odev->ifname);
 647                         device_delete(odev);
 648                         break;
 649                 }
 650         } else
 651                 D(DEVICE, "Create new device '%s' (%s)\n", name, type->name);
 652
 653         dev = type->create(name, config);
 654         if (!dev)
 655                 return NULL;
 656
 657         dev->current_config = true;
 658         dev->config = config;
 659         if (odev)
 660                 device_replace(dev, odev);
 661
 662         if (!config_init && dev->config_pending)
 663                 type->config_init(dev);
 664
 665         return dev;
 666 }
 667
 668 void
 669 device_dump_status(struct blob_buf *b, struct device *dev)
 670 {
 671         struct device_settings st;
 672         void *c, *s;
 673
 674         if (!dev) {
 675                 avl_for_each_element(&devices, dev, avl) {
 676                         if (!dev->present)
 677                                 continue;
 678                         c = blobmsg_open_table(b, dev->ifname);
 679                         device_dump_status(b, dev);
 680                         blobmsg_close_table(b, c);
 681                 }
 682
 683                 return;
 684         }
 685
 686         if (!dev->present)
 687                 return;
 688
 689         blobmsg_add_string(b, "type", dev->type->name);
 690         blobmsg_add_u8(b, "up", !!dev->active);
 691         if (dev->type->dump_info)
 692                 dev->type->dump_info(dev, b);
 693         else
 694                 system_if_dump_info(dev, b);
 695
 696         if (dev->active) {
 697                 device_merge_settings(dev, &st);
 698                 if (st.flags & DEV_OPT_MTU)
 699                         blobmsg_add_u32(b, "mtu", st.mtu);
 700                 if (st.flags & DEV_OPT_MACADDR)
 701                         blobmsg_add_string(b, "macaddr", ether_ntoa((struct ether_addr *) st.macaddr));
 702                 if (st.flags & DEV_OPT_TXQUEUELEN)
 703                         blobmsg_add_u32(b, "txqueuelen", st.txqueuelen);
 704         }
 705
 706         s = blobmsg_open_table(b, "statistics");
 707         if (dev->type->dump_stats)
 708                 dev->type->dump_stats(dev, b);
 709         else
 710                 system_if_dump_stats(dev, b);
 711         blobmsg_close_table(b, s);
 712 }