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