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