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