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