src/device.c

   1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
   2
   3 /***
   4   This file is part of systemd.
   5
   6   Copyright 2010 Lennart Poettering
   7
   8   systemd is free software; you can redistribute it and/or modify it
   9   under the terms of the GNU General Public License as published by
  10   the Free Software Foundation; either version 2 of the License, or
  11   (at your option) any later version.
  12
  13   systemd is distributed in the hope that it will be useful, but
  14   WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16   General Public License for more details.
  17
  18   You should have received a copy of the GNU General Public License
  19   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  20 ***/
  21
  22 #include <errno.h>
  23 #include <sys/epoll.h>
  24 #include <libudev.h>
  25
  26 #include "unit.h"
  27 #include "device.h"
  28 #include "strv.h"
  29 #include "log.h"
  30 #include "unit-name.h"
  31 #include "dbus-device.h"
  32
  33 static const UnitActiveState state_translation_table[_DEVICE_STATE_MAX] = {
  34         [DEVICE_DEAD] = UNIT_INACTIVE,
  35         [DEVICE_PLUGGED] = UNIT_ACTIVE
  36 };
  37
  38 static void device_unset_sysfs(Device *d) {
  39         Device *first;
  40
  41         assert(d);
  42
  43         if (!d->sysfs)
  44                 return;
  45
  46         /* Remove this unit from the chain of devices which share the
  47          * same sysfs path. */
  48         first = hashmap_get(d->meta.manager->devices_by_sysfs, d->sysfs);
  49         LIST_REMOVE(Device, same_sysfs, first, d);
  50
  51         if (first)
  52                 hashmap_remove_and_replace(d->meta.manager->devices_by_sysfs, d->sysfs, first->sysfs, first);
  53         else
  54                 hashmap_remove(d->meta.manager->devices_by_sysfs, d->sysfs);
  55
  56         free(d->sysfs);
  57         d->sysfs = NULL;
  58 }
  59
  60 static void device_init(Unit *u) {
  61         Device *d = DEVICE(u);
  62
  63         assert(d);
  64         assert(d->meta.load_state == UNIT_STUB);
  65
  66         /* In contrast to all other unit types we timeout jobs waiting
  67          * for devices by default. This is because they otherwise wait
  68          * indefinetely for plugged in devices, something which cannot
  69          * happen for the other units since their operations time out
  70          * anyway. */
  71         d->meta.job_timeout = DEFAULT_TIMEOUT_USEC;
  72 }
  73
  74 static void device_done(Unit *u) {
  75         Device *d = DEVICE(u);
  76
  77         assert(d);
  78
  79         device_unset_sysfs(d);
  80 }
  81
  82 static void device_set_state(Device *d, DeviceState state) {
  83         DeviceState old_state;
  84         assert(d);
  85
  86         old_state = d->state;
  87         d->state = state;
  88
  89         if (state != old_state)
  90                 log_debug("%s changed %s -> %s",
  91                           d->meta.id,
  92                           device_state_to_string(old_state),
  93                           device_state_to_string(state));
  94
  95         unit_notify(UNIT(d), state_translation_table[old_state], state_translation_table[state]);
  96 }
  97
  98 static int device_coldplug(Unit *u) {
  99         Device *d = DEVICE(u);
 100
 101         assert(d);
 102         assert(d->state == DEVICE_DEAD);
 103
 104         if (d->sysfs)
 105                 device_set_state(d, DEVICE_PLUGGED);
 106
 107         return 0;
 108 }
 109
 110 static void device_dump(Unit *u, FILE *f, const char *prefix) {
 111         Device *d = DEVICE(u);
 112
 113         assert(d);
 114
 115         fprintf(f,
 116                 "%sDevice State: %s\n"
 117                 "%sSysfs Path: %s\n",
 118                 prefix, device_state_to_string(d->state),
 119                 prefix, strna(d->sysfs));
 120 }
 121
 122 static UnitActiveState device_active_state(Unit *u) {
 123         assert(u);
 124
 125         return state_translation_table[DEVICE(u)->state];
 126 }
 127
 128 static const char *device_sub_state_to_string(Unit *u) {
 129         assert(u);
 130
 131         return device_state_to_string(DEVICE(u)->state);
 132 }
 133
 134 static int device_add_escaped_name(Unit *u, const char *dn) {
 135         char *e;
 136         int r;
 137
 138         assert(u);
 139         assert(dn);
 140         assert(dn[0] == '/');
 141
 142         if (!(e = unit_name_from_path(dn, ".device")))
 143                 return -ENOMEM;
 144
 145         r = unit_add_name(u, e);
 146         free(e);
 147
 148         if (r < 0 && r != -EEXIST)
 149                 return r;
 150
 151         return 0;
 152 }
 153
 154 static int device_find_escape_name(Manager *m, const char *dn, Unit **_u) {
 155         char *e;
 156         Unit *u;
 157
 158         assert(m);
 159         assert(dn);
 160         assert(dn[0] == '/');
 161         assert(_u);
 162
 163         if (!(e = unit_name_from_path(dn, ".device")))
 164                 return -ENOMEM;
 165
 166         u = manager_get_unit(m, e);
 167         free(e);
 168
 169         if (u) {
 170                 *_u = u;
 171                 return 1;
 172         }
 173
 174         return 0;
 175 }
 176
 177 static int device_update_unit(Manager *m, struct udev_device *dev, const char *path, bool main) {
 178         const char *sysfs, *model;
 179         Unit *u = NULL;
 180         int r;
 181         bool delete;
 182
 183         assert(m);
 184
 185         if (!(sysfs = udev_device_get_syspath(dev)))
 186                 return -ENOMEM;
 187
 188         if ((r = device_find_escape_name(m, path, &u)) < 0)
 189                 return r;
 190
 191         /* If this is a different unit, then let's not merge things */
 192         if (u && DEVICE(u)->sysfs && !path_equal(DEVICE(u)->sysfs, sysfs)) {
 193                 log_error("Hmm, something's broken. Asked to create two devices with same name but different sysfs paths.");
 194                 return -EEXIST;
 195         }
 196
 197         if (!u) {
 198                 delete = true;
 199
 200                 if (!(u = unit_new(m)))
 201                         return -ENOMEM;
 202
 203                 if ((r = device_add_escaped_name(u, path)) < 0)
 204                         goto fail;
 205
 206                 unit_add_to_load_queue(u);
 207         } else
 208                 delete = false;
 209
 210         /* If this was created via some dependency and has not
 211          * actually been seen yet ->sysfs will not be
 212          * initialized. Hence initialize it if necessary. */
 213
 214         if (!DEVICE(u)->sysfs) {
 215                 Device *first;
 216
 217                 if (!(DEVICE(u)->sysfs = strdup(sysfs))) {
 218                         r = -ENOMEM;
 219                         goto fail;
 220                 }
 221
 222                 if (!m->devices_by_sysfs)
 223                         if (!(m->devices_by_sysfs = hashmap_new(string_hash_func, string_compare_func))) {
 224                                 r = -ENOMEM;
 225                                 goto fail;
 226                         }
 227
 228                 first = hashmap_get(m->devices_by_sysfs, sysfs);
 229                 LIST_PREPEND(Device, same_sysfs, first, DEVICE(u));
 230
 231                 if ((r = hashmap_replace(m->devices_by_sysfs, DEVICE(u)->sysfs, first)) < 0)
 232                         goto fail;
 233         }
 234
 235         if ((model = udev_device_get_property_value(dev, "ID_MODEL_FROM_DATABASE")) ||
 236             (model = udev_device_get_property_value(dev, "ID_MODEL"))) {
 237                 if ((r = unit_set_description(u, model)) < 0)
 238                         goto fail;
 239         } else
 240                 if ((r = unit_set_description(u, path)) < 0)
 241                         goto fail;
 242
 243         if (main) {
 244                 /* The additional systemd udev properties we only
 245                  * interpret for the main object */
 246                 const char *wants, *alias;
 247
 248                 if ((alias = udev_device_get_property_value(dev, "SYSTEMD_ALIAS"))) {
 249                         if (!is_path(alias))
 250                                 log_warning("SYSTEMD_ALIAS for %s is not a path, ignoring: %s", sysfs, alias);
 251                         else {
 252                                 if ((r = device_add_escaped_name(u, alias)) < 0)
 253                                         goto fail;
 254                         }
 255                 }
 256
 257                 if ((wants = udev_device_get_property_value(dev, "SYSTEMD_WANTS"))) {
 258                         char *state, *w;
 259                         size_t l;
 260
 261                         FOREACH_WORD_QUOTED(w, l, wants, state) {
 262                                 char *e;
 263
 264                                 if (!(e = strndup(w, l))) {
 265                                         r = -ENOMEM;
 266                                         goto fail;
 267                                 }
 268
 269                                 r = unit_add_dependency_by_name(u, UNIT_WANTS, e, NULL, true);
 270                                 free(e);
 271
 272                                 if (r < 0)
 273                                         goto fail;
 274                         }
 275                 }
 276         }
 277
 278         unit_add_to_dbus_queue(u);
 279         return 0;
 280
 281 fail:
 282         log_warning("Failed to load device unit: %s", strerror(-r));
 283
 284         if (delete && u)
 285                 unit_free(u);
 286
 287         return r;
 288 }
 289
 290 static int device_process_new_device(Manager *m, struct udev_device *dev, bool update_state) {
 291         const char *sysfs, *dn;
 292         struct udev_list_entry *item = NULL, *first = NULL;
 293
 294         assert(m);
 295
 296         if (!(sysfs = udev_device_get_syspath(dev)))
 297                 return -ENOMEM;
 298
 299         /* Add the main unit named after the sysfs path */
 300         device_update_unit(m, dev, sysfs, true);
 301
 302         /* Add an additional unit for the device node */
 303         if ((dn = udev_device_get_devnode(dev)))
 304                 device_update_unit(m, dev, dn, false);
 305
 306         /* Add additional units for all symlinks */
 307         first = udev_device_get_devlinks_list_entry(dev);
 308         udev_list_entry_foreach(item, first) {
 309                 const char *p;
 310
 311                 /* Don't bother with the /dev/block links */
 312                 p = udev_list_entry_get_name(item);
 313
 314                 if (path_startswith(p, "/dev/block/") ||
 315                     path_startswith(p, "/dev/char/"))
 316                         continue;
 317
 318                 device_update_unit(m, dev, p, false);
 319         }
 320
 321         if (update_state) {
 322                 Device *d, *l;
 323
 324                 manager_dispatch_load_queue(m);
 325
 326                 l = hashmap_get(m->devices_by_sysfs, sysfs);
 327                 LIST_FOREACH(same_sysfs, d, l)
 328                         device_set_state(d, DEVICE_PLUGGED);
 329         }
 330
 331         return 0;
 332 }
 333
 334 static int device_process_path(Manager *m, const char *path, bool update_state) {
 335         int r;
 336         struct udev_device *dev;
 337
 338         assert(m);
 339         assert(path);
 340
 341         if (!(dev = udev_device_new_from_syspath(m->udev, path))) {
 342                 log_warning("Failed to get udev device object from udev for path %s.", path);
 343                 return -ENOMEM;
 344         }
 345
 346         r = device_process_new_device(m, dev, update_state);
 347         udev_device_unref(dev);
 348         return r;
 349 }
 350
 351 static int device_process_removed_device(Manager *m, struct udev_device *dev) {
 352         const char *sysfs;
 353         Device *d;
 354
 355         assert(m);
 356         assert(dev);
 357
 358         if (!(sysfs = udev_device_get_syspath(dev)))
 359                 return -ENOMEM;
 360
 361         /* Remove all units of this sysfs path */
 362         while ((d = hashmap_get(m->devices_by_sysfs, sysfs))) {
 363                 device_unset_sysfs(d);
 364                 device_set_state(d, DEVICE_DEAD);
 365         }
 366
 367         return 0;
 368 }
 369
 370 static Unit *device_following(Unit *u) {
 371         Device *d = DEVICE(u);
 372         Device *other, *first = NULL;
 373
 374         assert(d);
 375
 376         if (startswith(u->meta.id, "sys-"))
 377                 return NULL;
 378
 379         /* Make everybody follow the unit that's named after the sysfs path */
 380         for (other = d->same_sysfs_next; other; other = other->same_sysfs_next)
 381                 if (startswith(other->meta.id, "sys-"))
 382                         return UNIT(other);
 383
 384         for (other = d->same_sysfs_prev; other; other = other->same_sysfs_prev) {
 385                 if (startswith(other->meta.id, "sys-"))
 386                         return UNIT(other);
 387
 388                 first = other;
 389         }
 390
 391         return UNIT(first);
 392 }
 393
 394 static void device_shutdown(Manager *m) {
 395         assert(m);
 396
 397         if (m->udev_monitor) {
 398                 udev_monitor_unref(m->udev_monitor);
 399                 m->udev_monitor = NULL;
 400         }
 401
 402         if (m->udev) {
 403                 udev_unref(m->udev);
 404                 m->udev = NULL;
 405         }
 406
 407         hashmap_free(m->devices_by_sysfs);
 408         m->devices_by_sysfs = NULL;
 409 }
 410
 411 static int device_enumerate(Manager *m) {
 412         struct epoll_event ev;
 413         int r;
 414         struct udev_enumerate *e = NULL;
 415         struct udev_list_entry *item = NULL, *first = NULL;
 416
 417         assert(m);
 418
 419         if (!m->udev) {
 420                 if (!(m->udev = udev_new()))
 421                         return -ENOMEM;
 422
 423                 if (!(m->udev_monitor = udev_monitor_new_from_netlink(m->udev, "udev"))) {
 424                         r = -ENOMEM;
 425                         goto fail;
 426                 }
 427
 428                 if (udev_monitor_filter_add_match_tag(m->udev_monitor, "systemd") < 0) {
 429                         r = -ENOMEM;
 430                         goto fail;
 431                 }
 432
 433                 if (udev_monitor_enable_receiving(m->udev_monitor) < 0) {
 434                         r = -EIO;
 435                         goto fail;
 436                 }
 437
 438                 m->udev_watch.type = WATCH_UDEV;
 439                 m->udev_watch.fd = udev_monitor_get_fd(m->udev_monitor);
 440
 441                 zero(ev);
 442                 ev.events = EPOLLIN;
 443                 ev.data.ptr = &m->udev_watch;
 444
 445                 if (epoll_ctl(m->epoll_fd, EPOLL_CTL_ADD, m->udev_watch.fd, &ev) < 0)
 446                         return -errno;
 447         }
 448
 449         if (!(e = udev_enumerate_new(m->udev))) {
 450                 r = -ENOMEM;
 451                 goto fail;
 452         }
 453         if (udev_enumerate_add_match_tag(e, "systemd") < 0) {
 454                 r = -EIO;
 455                 goto fail;
 456         }
 457
 458         if (udev_enumerate_scan_devices(e) < 0) {
 459                 r = -EIO;
 460                 goto fail;
 461         }
 462
 463         first = udev_enumerate_get_list_entry(e);
 464         udev_list_entry_foreach(item, first)
 465                 device_process_path(m, udev_list_entry_get_name(item), false);
 466
 467         udev_enumerate_unref(e);
 468         return 0;
 469
 470 fail:
 471         if (e)
 472                 udev_enumerate_unref(e);
 473
 474         device_shutdown(m);
 475         return r;
 476 }
 477
 478 void device_fd_event(Manager *m, int events) {
 479         struct udev_device *dev;
 480         int r;
 481         const char *action;
 482
 483         assert(m);
 484         assert(events == EPOLLIN);
 485
 486         if (!(dev = udev_monitor_receive_device(m->udev_monitor))) {
 487                 log_error("Failed to receive device.");
 488                 return;
 489         }
 490
 491         if (!(action = udev_device_get_action(dev))) {
 492                 log_error("Failed to get udev action string.");
 493                 goto fail;
 494         }
 495
 496         if (streq(action, "remove")) {
 497                 if ((r = device_process_removed_device(m, dev)) < 0) {
 498                         log_error("Failed to process udev device event: %s", strerror(-r));
 499                         goto fail;
 500                 }
 501         } else {
 502                 if ((r = device_process_new_device(m, dev, true)) < 0) {
 503                         log_error("Failed to process udev device event: %s", strerror(-r));
 504                         goto fail;
 505                 }
 506         }
 507
 508 fail:
 509         udev_device_unref(dev);
 510 }
 511
 512 static const char* const device_state_table[_DEVICE_STATE_MAX] = {
 513         [DEVICE_DEAD] = "dead",
 514         [DEVICE_PLUGGED] = "plugged"
 515 };
 516
 517 DEFINE_STRING_TABLE_LOOKUP(device_state, DeviceState);
 518
 519 const UnitVTable device_vtable = {
 520         .suffix = ".device",
 521
 522         .no_requires = true,
 523         .no_instances = true,
 524         .no_snapshots = true,
 525         .no_isolate = true,
 526         .no_alias = true,
 527
 528         .init = device_init,
 529
 530         .load = unit_load_fragment_and_dropin_optional,
 531         .done = device_done,
 532         .coldplug = device_coldplug,
 533
 534         .dump = device_dump,
 535
 536         .active_state = device_active_state,
 537         .sub_state_to_string = device_sub_state_to_string,
 538
 539         .bus_message_handler = bus_device_message_handler,
 540
 541         .following = device_following,
 542
 543         .enumerate = device_enumerate,
 544         .shutdown = device_shutdown
 545 };