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