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         dev->set_state(dev, false);
 316         device_broadcast_event(dev, DEV_EVENT_DOWN);
 317 }
 318
 319 int device_check_state(struct device *dev)
 320 {
 321         if (!dev->type->check_state)
 322                 return 0;
 323
 324         return dev->type->check_state(dev);
 325 }
 326
 327 void device_init_virtual(struct device *dev, const struct device_type *type, const char *name)
 328 {
 329         assert(dev);
 330         assert(type);
 331
 332         if (name)
 333                 strncpy(dev->ifname, name, IFNAMSIZ);
 334
 335         D(DEVICE, "Initialize device '%s'\n", dev->ifname);
 336         INIT_LIST_HEAD(&dev->users);
 337         dev->type = type;
 338 }
 339
 340 int device_init(struct device *dev, const struct device_type *type, const char *ifname)
 341 {
 342         int ret;
 343
 344         device_init_virtual(dev, type, ifname);
 345
 346         if (!dev->set_state)
 347                 dev->set_state = set_device_state;
 348
 349         dev->avl.key = dev->ifname;
 350
 351         ret = avl_insert(&devices, &dev->avl);
 352         if (ret < 0)
 353                 return ret;
 354
 355         system_if_clear_state(dev);
 356         device_check_state(dev);
 357
 358         return 0;
 359 }
 360
 361 static struct device *
 362 device_create_default(const char *name, bool external)
 363 {
 364         struct device *dev;
 365
 366         D(DEVICE, "Create simple device '%s'\n", name);
 367         dev = calloc(1, sizeof(*dev));
 368         dev->external = external;
 369         dev->set_state = simple_device_set_state;
 370         device_init(dev, &simple_device_type, name);
 371         dev->default_config = true;
 372         return dev;
 373 }
 374
 375 static struct device *
 376 device_alias_get(const char *name)
 377 {
 378         struct alias_device *alias;
 379
 380         alias = avl_find_element(&aliases, name, alias, avl);
 381         if (alias)
 382                 return &alias->dev;
 383
 384         return alias_device_create(name, NULL);
 385 }
 386
 387 struct device *
 388 device_get(const char *name, int create)
 389 {
 390         struct device *dev;
 391
 392         if (strchr(name, '.'))
 393                 return get_vlan_device_chain(name, create);
 394
 395         if (name[0] == '@')
 396                 return device_alias_get(name + 1);
 397
 398         dev = avl_find_element(&devices, name, dev, avl);
 399         if (dev)
 400                 return dev;
 401
 402         if (!create)
 403                 return NULL;
 404
 405         return device_create_default(name, create > 1);
 406 }
 407
 408 static void
 409 device_delete(struct device *dev)
 410 {
 411         if (!dev->avl.key)
 412                 return;
 413
 414         D(DEVICE, "Delete device '%s' from list\n", dev->ifname);
 415         avl_delete(&devices, &dev->avl);
 416         dev->avl.key = NULL;
 417 }
 418
 419 void device_cleanup(struct device *dev)
 420 {
 421         struct device_user *dep, *tmp;
 422
 423         D(DEVICE, "Clean up device '%s'\n", dev->ifname);
 424         list_for_each_entry_safe(dep, tmp, &dev->users, list) {
 425                 if (!dep->cb)
 426                         continue;
 427
 428                 dep->cb(dep, DEV_EVENT_REMOVE);
 429                 device_release(dep);
 430         }
 431
 432         device_delete(dev);
 433 }
 434
 435 static void __device_set_present(struct device *dev, bool state)
 436 {
 437         if (dev->present == state)
 438                 return;
 439
 440         dev->present = state;
 441         device_broadcast_event(dev, state ? DEV_EVENT_ADD : DEV_EVENT_REMOVE);
 442 }
 443
 444 void device_set_present(struct device *dev, bool state)
 445 {
 446         if (dev->sys_present == state)
 447                 return;
 448
 449         dev->sys_present = state;
 450         D(DEVICE, "%s '%s' %s present\n", dev->type->name, dev->ifname, state ? "is now" : "is no longer" );
 451
 452         if (state && dev->disabled)
 453                 return;
 454
 455         __device_set_present(dev, state);
 456 }
 457
 458 void
 459 device_set_disabled(struct device *dev, bool value)
 460 {
 461         dev->disabled = value;
 462         if (dev->sys_present)
 463                 __device_set_present(dev, !value);
 464 }
 465
 466 void device_add_user(struct device_user *dep, struct device *dev)
 467 {
 468         dep->dev = dev;
 469         list_add_tail(&dep->list, &dev->users);
 470         if (dep->cb && dev->present) {
 471                 dep->cb(dep, DEV_EVENT_ADD);
 472                 if (dev->active)
 473                         dep->cb(dep, DEV_EVENT_UP);
 474         }
 475 }
 476
 477 void
 478 device_free(struct device *dev)
 479 {
 480         __devlock++;
 481         dev->type->free(dev);
 482         __devlock--;
 483 }
 484
 485 static void
 486 __device_free_unused(struct device *dev)
 487 {
 488         if (!list_empty(&dev->users) || dev->current_config || __devlock)
 489                 return;
 490
 491         device_free(dev);
 492 }
 493
 494 void device_remove_user(struct device_user *dep)
 495 {
 496         struct device *dev = dep->dev;
 497
 498         if (!dep->dev)
 499                 return;
 500
 501         dep->hotplug = false;
 502         if (dep->claimed)
 503                 device_release(dep);
 504
 505         list_del(&dep->list);
 506         dep->dev = NULL;
 507         __device_free_unused(dev);
 508 }
 509
 510 void
 511 device_free_unused(struct device *dev)
 512 {
 513         struct device *tmp;
 514
 515         if (dev)
 516                 return __device_free_unused(dev);
 517
 518         avl_for_each_element_safe(&devices, dev, avl, tmp)
 519                 __device_free_unused(dev);
 520 }
 521
 522 void
 523 device_init_pending(void)
 524 {
 525         struct device *dev, *tmp;
 526
 527         avl_for_each_element_safe(&devices, dev, avl, tmp) {
 528                 if (!dev->config_pending)
 529                         continue;
 530
 531                 dev->type->config_init(dev);
 532                 dev->config_pending = false;
 533         }
 534 }
 535
 536 static enum dev_change_type
 537 device_reload_config(struct device *dev, struct blob_attr *attr)
 538 {
 539         struct blob_attr *tb[__DEV_ATTR_MAX];
 540         const struct config_param_list *cfg = dev->type->config_params;
 541
 542         if (config_check_equal(dev->config, attr, cfg))
 543                 return DEV_CONFIG_NO_CHANGE;
 544
 545         if (cfg == &device_attr_list) {
 546                 memset(tb, 0, sizeof(tb));
 547
 548                 if (attr)
 549                         blobmsg_parse(dev_attrs, __DEV_ATTR_MAX, tb,
 550                                 blob_data(attr), blob_len(attr));
 551
 552                 device_init_settings(dev, tb);
 553                 return DEV_CONFIG_APPLIED;
 554         } else
 555                 return DEV_CONFIG_RECREATE;
 556 }
 557
 558 enum dev_change_type
 559 device_set_config(struct device *dev, const struct device_type *type,
 560                   struct blob_attr *attr)
 561 {
 562         if (type != dev->type)
 563                 return DEV_CONFIG_RECREATE;
 564
 565         if (dev->type->reload)
 566                 return dev->type->reload(dev, attr);
 567
 568         return device_reload_config(dev, attr);
 569 }
 570
 571 static void
 572 device_replace(struct device *dev, struct device *odev)
 573 {
 574         struct device_user *dep, *tmp;
 575         bool present = odev->present;
 576
 577         if (present)
 578                 device_set_present(odev, false);
 579
 580         list_for_each_entry_safe(dep, tmp, &odev->users, list) {
 581                 device_release(dep);
 582                 list_move_tail(&dep->list, &dev->users);
 583                 dep->dev = dev;
 584         }
 585         device_free(odev);
 586
 587         if (present)
 588                 device_set_present(dev, true);
 589 }
 590
 591 void
 592 device_reset_config(void)
 593 {
 594         struct device *dev;
 595
 596         avl_for_each_element(&devices, dev, avl)
 597                 dev->current_config = false;
 598 }
 599
 600 void
 601 device_reset_old(void)
 602 {
 603         struct device *dev, *tmp, *ndev;
 604
 605         avl_for_each_element_safe(&devices, dev, avl, tmp) {
 606                 if (dev->current_config || dev->default_config)
 607                         continue;
 608
 609                 if (dev->type != &simple_device_type)
 610                         continue;
 611
 612                 ndev = device_create_default(dev->ifname, dev->external);
 613                 device_replace(ndev, dev);
 614         }
 615 }
 616
 617 struct device *
 618 device_create(const char *name, const struct device_type *type,
 619               struct blob_attr *config)
 620 {
 621         struct device *odev = NULL, *dev;
 622         enum dev_change_type change;
 623
 624         config = config_memdup(config);
 625         if (!config)
 626                 return NULL;
 627
 628         odev = device_get(name, false);
 629         if (odev) {
 630                 odev->current_config = true;
 631                 change = device_set_config(odev, type, config);
 632                 switch (change) {
 633                 case DEV_CONFIG_APPLIED:
 634                         D(DEVICE, "Device '%s': config applied\n", odev->ifname);
 635                         free(odev->config);
 636                         odev->config = config;
 637                         if (odev->present) {
 638                                 device_set_present(odev, false);
 639                                 device_set_present(odev, true);
 640                         }
 641                         return odev;
 642                 case DEV_CONFIG_NO_CHANGE:
 643                         D(DEVICE, "Device '%s': no configuration change\n", odev->ifname);
 644                         free(config);
 645                         return odev;
 646                 case DEV_CONFIG_RECREATE:
 647                         D(DEVICE, "Device '%s': recreate device\n", odev->ifname);
 648                         device_delete(odev);
 649                         break;
 650                 }
 651         } else
 652                 D(DEVICE, "Create new device '%s' (%s)\n", name, type->name);
 653
 654         dev = type->create(name, config);
 655         if (!dev)
 656                 return NULL;
 657
 658         dev->current_config = true;
 659         dev->config = config;
 660         if (odev)
 661                 device_replace(dev, odev);
 662
 663         if (!config_init && dev->config_pending)
 664                 type->config_init(dev);
 665
 666         return dev;
 667 }
 668
 669 void
 670 device_dump_status(struct blob_buf *b, struct device *dev)
 671 {
 672         struct device_settings st;
 673         void *c, *s;
 674
 675         if (!dev) {
 676                 avl_for_each_element(&devices, dev, avl) {
 677                         if (!dev->present)
 678                                 continue;
 679                         c = blobmsg_open_table(b, dev->ifname);
 680                         device_dump_status(b, dev);
 681                         blobmsg_close_table(b, c);
 682                 }
 683
 684                 return;
 685         }
 686
 687         if (!dev->present)
 688                 return;
 689
 690         blobmsg_add_string(b, "type", dev->type->name);
 691         blobmsg_add_u8(b, "up", !!dev->active);
 692         if (dev->type->dump_info)
 693                 dev->type->dump_info(dev, b);
 694         else
 695                 system_if_dump_info(dev, b);
 696
 697         if (dev->active) {
 698                 device_merge_settings(dev, &st);
 699                 if (st.flags & DEV_OPT_MTU)
 700                         blobmsg_add_u32(b, "mtu", st.mtu);
 701                 if (st.flags & DEV_OPT_MACADDR)
 702                         blobmsg_add_string(b, "macaddr", ether_ntoa((struct ether_addr *) st.macaddr));
 703                 if (st.flags & DEV_OPT_TXQUEUELEN)
 704                         blobmsg_add_u32(b, "txqueuelen", st.txqueuelen);
 705         }
 706
 707         s = blobmsg_open_table(b, "statistics");
 708         if (dev->type->dump_stats)
 709                 dev->type->dump_stats(dev, b);
 710         else
 711                 system_if_dump_stats(dev, b);
 712         blobmsg_close_table(b, s);
 713 }