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