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 active count: %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 active count: %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 void device_set_link(struct device *dev, bool state)
 398 {
 399         if (dev->link_active == state)
 400                 return;
 401
 402         netifd_log_message(L_NOTICE, "%s '%s' link is %s\n", dev->type->name, dev->ifname, state ? "up" : "down" );
 403
 404         dev->link_active = state;
 405         device_broadcast_event(dev, state ? DEV_EVENT_LINK_UP : DEV_EVENT_LINK_DOWN);
 406 }
 407
 408 void device_set_ifindex(struct device *dev, int ifindex)
 409 {
 410         if (dev->ifindex == ifindex)
 411                 return;
 412
 413         dev->ifindex = ifindex;
 414         device_broadcast_event(dev, DEV_EVENT_UPDATE_IFINDEX);
 415 }
 416
 417 static int device_refcount(struct device *dev)
 418 {
 419         struct list_head *list;
 420         int count = 0;
 421
 422         list_for_each(list, &dev->users.list)
 423                 count++;
 424
 425         list_for_each(list, &dev->aliases.list)
 426                 count++;
 427
 428         return count;
 429 }
 430
 431 void device_add_user(struct device_user *dep, struct device *dev)
 432 {
 433         struct safe_list *head;
 434
 435         if (dep->dev == dev)
 436                 return;
 437
 438         if (dep->dev)
 439                 device_remove_user(dep);
 440
 441         if (!dev)
 442                 return;
 443
 444         dep->dev = dev;
 445
 446         if (dep->alias)
 447                 head = &dev->aliases;
 448         else
 449                 head = &dev->users;
 450
 451         safe_list_add(&dep->list, head);
 452         D(DEVICE, "Add user for device '%s', refcount=%d\n", dev->ifname, device_refcount(dev));
 453
 454         if (dep->cb && dev->present) {
 455                 dep->cb(dep, DEV_EVENT_ADD);
 456                 if (dev->active)
 457                         dep->cb(dep, DEV_EVENT_UP);
 458
 459                 if (dev->link_active)
 460                         dep->cb(dep, DEV_EVENT_LINK_UP);
 461         }
 462 }
 463
 464 void
 465 device_free(struct device *dev)
 466 {
 467         __devlock++;
 468         free(dev->config);
 469         device_cleanup(dev);
 470         dev->type->free(dev);
 471         __devlock--;
 472 }
 473
 474 static void
 475 __device_free_unused(struct device *dev)
 476 {
 477         if (!safe_list_empty(&dev->users) ||
 478                 !safe_list_empty(&dev->aliases) ||
 479             dev->current_config || __devlock)
 480                 return;
 481
 482         device_free(dev);
 483 }
 484
 485 void device_remove_user(struct device_user *dep)
 486 {
 487         struct device *dev = dep->dev;
 488
 489         if (!dep->dev)
 490                 return;
 491
 492         dep->hotplug = false;
 493         if (dep->claimed)
 494                 device_release(dep);
 495
 496         safe_list_del(&dep->list);
 497         dep->dev = NULL;
 498         D(DEVICE, "Remove user for device '%s', refcount=%d\n", dev->ifname, device_refcount(dev));
 499         __device_free_unused(dev);
 500 }
 501
 502 void
 503 device_free_unused(struct device *dev)
 504 {
 505         struct device *tmp;
 506
 507         if (dev)
 508                 return __device_free_unused(dev);
 509
 510         avl_for_each_element_safe(&devices, dev, avl, tmp)
 511                 __device_free_unused(dev);
 512 }
 513
 514 void
 515 device_init_pending(void)
 516 {
 517         struct device *dev, *tmp;
 518
 519         avl_for_each_element_safe(&devices, dev, avl, tmp) {
 520                 if (!dev->config_pending)
 521                         continue;
 522
 523                 dev->type->config_init(dev);
 524                 dev->config_pending = false;
 525         }
 526 }
 527
 528 static enum dev_change_type
 529 device_reload_config(struct device *dev, struct blob_attr *attr)
 530 {
 531         struct blob_attr *tb[__DEV_ATTR_MAX];
 532         const struct uci_blob_param_list *cfg = dev->type->config_params;
 533
 534         if (uci_blob_check_equal(dev->config, attr, cfg))
 535                 return DEV_CONFIG_NO_CHANGE;
 536
 537         if (cfg == &device_attr_list) {
 538                 memset(tb, 0, sizeof(tb));
 539
 540                 if (attr)
 541                         blobmsg_parse(dev_attrs, __DEV_ATTR_MAX, tb,
 542                                 blob_data(attr), blob_len(attr));
 543
 544                 device_init_settings(dev, tb);
 545                 return DEV_CONFIG_RESTART;
 546         } else
 547                 return DEV_CONFIG_RECREATE;
 548 }
 549
 550 enum dev_change_type
 551 device_set_config(struct device *dev, const struct device_type *type,
 552                   struct blob_attr *attr)
 553 {
 554         if (type != dev->type)
 555                 return DEV_CONFIG_RECREATE;
 556
 557         if (dev->type->reload)
 558                 return dev->type->reload(dev, attr);
 559
 560         return device_reload_config(dev, attr);
 561 }
 562
 563 static void
 564 device_replace(struct device *dev, struct device *odev)
 565 {
 566         struct device_user *dep, *tmp;
 567         bool present = odev->present;
 568
 569         if (present)
 570                 device_set_present(odev, false);
 571
 572         list_for_each_entry_safe(dep, tmp, &odev->users.list, list.list) {
 573                 device_release(dep);
 574                 safe_list_del(&dep->list);
 575                 safe_list_add(&dep->list, &dev->users);
 576                 dep->dev = dev;
 577         }
 578         device_free(odev);
 579
 580         if (present)
 581                 device_set_present(dev, true);
 582 }
 583
 584 void
 585 device_reset_config(void)
 586 {
 587         struct device *dev;
 588
 589         avl_for_each_element(&devices, dev, avl)
 590                 dev->current_config = false;
 591 }
 592
 593 void
 594 device_reset_old(void)
 595 {
 596         struct device *dev, *tmp, *ndev;
 597
 598         avl_for_each_element_safe(&devices, dev, avl, tmp) {
 599                 if (dev->current_config || dev->default_config)
 600                         continue;
 601
 602                 if (dev->type != &simple_device_type)
 603                         continue;
 604
 605                 ndev = device_create_default(dev->ifname, dev->external);
 606                 device_replace(ndev, dev);
 607         }
 608 }
 609
 610 struct device *
 611 device_create(const char *name, const struct device_type *type,
 612               struct blob_attr *config)
 613 {
 614         struct device *odev = NULL, *dev;
 615         enum dev_change_type change;
 616
 617         config = blob_memdup(config);
 618         if (!config)
 619                 return NULL;
 620
 621         odev = device_get(name, false);
 622         if (odev) {
 623                 odev->current_config = true;
 624                 change = device_set_config(odev, type, config);
 625                 if (odev->external) {
 626                         system_if_apply_settings(odev, &odev->settings, odev->settings.flags);
 627                         change = DEV_CONFIG_APPLIED;
 628                 }
 629                 switch (change) {
 630                 case DEV_CONFIG_RESTART:
 631                 case DEV_CONFIG_APPLIED:
 632                         D(DEVICE, "Device '%s': config applied\n", odev->ifname);
 633                         free(odev->config);
 634                         odev->config = config;
 635                         if (change == DEV_CONFIG_RESTART && odev->present) {
 636                                 device_set_present(odev, false);
 637                                 device_set_present(odev, true);
 638                         }
 639                         return odev;
 640                 case DEV_CONFIG_NO_CHANGE:
 641                         D(DEVICE, "Device '%s': no configuration change\n", odev->ifname);
 642                         free(config);
 643                         return odev;
 644                 case DEV_CONFIG_RECREATE:
 645                         D(DEVICE, "Device '%s': recreate device\n", odev->ifname);
 646                         device_delete(odev);
 647                         break;
 648                 }
 649         } else
 650                 D(DEVICE, "Create new device '%s' (%s)\n", name, type->name);
 651
 652         dev = type->create(name, config);
 653         if (!dev)
 654                 return NULL;
 655
 656         dev->current_config = true;
 657         dev->config = config;
 658         if (odev)
 659                 device_replace(dev, odev);
 660
 661         if (!config_init && dev->config_pending)
 662                 type->config_init(dev);
 663
 664         return dev;
 665 }
 666
 667 void
 668 device_dump_status(struct blob_buf *b, struct device *dev)
 669 {
 670         struct device_settings st;
 671         void *c, *s;
 672
 673         if (!dev) {
 674                 avl_for_each_element(&devices, dev, avl) {
 675                         if (!dev->present)
 676                                 continue;
 677                         c = blobmsg_open_table(b, dev->ifname);
 678                         device_dump_status(b, dev);
 679                         blobmsg_close_table(b, c);
 680                 }
 681
 682                 return;
 683         }
 684
 685         blobmsg_add_u8(b, "external", dev->external);
 686         blobmsg_add_u8(b, "present", dev->present);
 687         blobmsg_add_string(b, "type", dev->type->name);
 688
 689         if (!dev->present)
 690                 return;
 691
 692         blobmsg_add_u8(b, "up", !!dev->active);
 693         blobmsg_add_u8(b, "carrier", !!dev->link_active);
 694
 695         if (dev->type->dump_info)
 696                 dev->type->dump_info(dev, b);
 697         else
 698                 system_if_dump_info(dev, b);
 699
 700         if (dev->active) {
 701                 device_merge_settings(dev, &st);
 702                 if (st.flags & DEV_OPT_MTU)
 703                         blobmsg_add_u32(b, "mtu", st.mtu);
 704                 if (st.flags & DEV_OPT_MACADDR)
 705                         blobmsg_add_string(b, "macaddr", format_macaddr(st.macaddr));
 706                 if (st.flags & DEV_OPT_TXQUEUELEN)
 707                         blobmsg_add_u32(b, "txqueuelen", st.txqueuelen);
 708         }
 709
 710         s = blobmsg_open_table(b, "statistics");
 711         if (dev->type->dump_stats)
 712                 dev->type->dump_stats(dev, b);
 713         else
 714                 system_if_dump_stats(dev, b);
 715         blobmsg_close_table(b, s);
 716 }