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_AVAILABLE] = UNIT_ACTIVE
  36 };
  37
  38 static void device_done(Unit *u) {
  39         Device *d = DEVICE(u);
  40
  41         assert(d);
  42
  43         free(d->sysfs);
  44         d->sysfs = NULL;
  45 }
  46
  47 static void device_set_state(Device *d, DeviceState state) {
  48         DeviceState old_state;
  49         assert(d);
  50
  51         old_state = d->state;
  52         d->state = state;
  53
  54         if (state != old_state)
  55                 log_debug("%s changed %s -> %s",
  56                           UNIT(d)->meta.id,
  57                           device_state_to_string(old_state),
  58                           device_state_to_string(state));
  59
  60         unit_notify(UNIT(d), state_translation_table[old_state], state_translation_table[state]);
  61 }
  62
  63 static int device_coldplug(Unit *u) {
  64         Device *d = DEVICE(u);
  65
  66         assert(d);
  67         assert(d->state == DEVICE_DEAD);
  68
  69         if (d->sysfs)
  70                 device_set_state(d, DEVICE_AVAILABLE);
  71
  72         return 0;
  73 }
  74
  75 static void device_dump(Unit *u, FILE *f, const char *prefix) {
  76         Device *d = DEVICE(u);
  77
  78         assert(d);
  79
  80         fprintf(f,
  81                 "%sDevice State: %s\n"
  82                 "%sSysfs Path: %s\n",
  83                 prefix, device_state_to_string(d->state),
  84                 prefix, strna(d->sysfs));
  85 }
  86
  87 static UnitActiveState device_active_state(Unit *u) {
  88         assert(u);
  89
  90         return state_translation_table[DEVICE(u)->state];
  91 }
  92
  93 static const char *device_sub_state_to_string(Unit *u) {
  94         assert(u);
  95
  96         return device_state_to_string(DEVICE(u)->state);
  97 }
  98
  99 static int device_add_escaped_name(Unit *u, const char *dn, bool make_id) {
 100         char *e;
 101         int r;
 102
 103         assert(u);
 104         assert(dn);
 105         assert(dn[0] == '/');
 106
 107         if (!(e = unit_name_from_path(dn, ".device")))
 108                 return -ENOMEM;
 109
 110         r = unit_add_name(u, e);
 111
 112         if (r >= 0 && make_id)
 113                 unit_choose_id(u, e);
 114
 115         free(e);
 116
 117         if (r < 0 && r != -EEXIST)
 118                 return r;
 119
 120         return 0;
 121 }
 122
 123 static int device_find_escape_name(Manager *m, const char *dn, Unit **_u) {
 124         char *e;
 125         Unit *u;
 126
 127         assert(m);
 128         assert(dn);
 129         assert(dn[0] == '/');
 130         assert(_u);
 131
 132         if (!(e = unit_name_from_path(dn, ".device")))
 133                 return -ENOMEM;
 134
 135         u = manager_get_unit(m, e);
 136         free(e);
 137
 138         if (u) {
 139                 *_u = u;
 140                 return 1;
 141         }
 142
 143         return 0;
 144 }
 145
 146 static int device_process_new_device(Manager *m, struct udev_device *dev, bool update_state) {
 147         const char *dn, *wants, *sysfs, *expose, *model, *alias;
 148         Unit *u = NULL;
 149         int r;
 150         char *w, *state;
 151         size_t l;
 152         bool delete;
 153         struct udev_list_entry *item = NULL, *first = NULL;
 154         int b;
 155
 156         assert(m);
 157
 158         if (!(sysfs = udev_device_get_syspath(dev)))
 159                 return -ENOMEM;
 160
 161         if (!(expose = udev_device_get_property_value(dev, "SYSTEMD_EXPOSE")))
 162                 return 0;
 163
 164         if ((b = parse_boolean(expose)) < 0) {
 165                 log_error("Failed to parse SYSTEMD_EXPOSE udev property for device %s: %s", sysfs, expose);
 166                 return 0;
 167         }
 168
 169         if (!b)
 170                 return 0;
 171
 172         /* Check whether this entry is even relevant for us. */
 173         dn = udev_device_get_devnode(dev);
 174         wants = udev_device_get_property_value(dev, "SYSTEMD_WANTS");
 175         alias = udev_device_get_property_value(dev, "SYSTEMD_ALIAS");
 176
 177         /* We allow exactly one alias to be configured a this time and
 178          * it must be a path */
 179
 180         if (alias && !is_path(alias)) {
 181                 log_warning("SYSTEMD_ALIAS for %s is not a path, ignoring: %s", sysfs, alias);
 182                 alias = NULL;
 183         }
 184
 185         if ((r = device_find_escape_name(m, sysfs, &u)) < 0)
 186                 return r;
 187
 188         if (r == 0 && dn)
 189                 if ((r = device_find_escape_name(m, dn, &u)) < 0)
 190                         return r;
 191
 192         if (r == 0) {
 193                 first = udev_device_get_devlinks_list_entry(dev);
 194                 udev_list_entry_foreach(item, first) {
 195                         if ((r = device_find_escape_name(m, udev_list_entry_get_name(item), &u)) < 0)
 196                                 return r;
 197
 198                         if (r > 0)
 199                                 break;
 200                 }
 201         }
 202
 203         if (r == 0 && alias)
 204                 if ((r = device_find_escape_name(m, alias, &u)) < 0)
 205                         return r;
 206
 207         /* FIXME: this needs proper merging */
 208
 209         assert((r > 0) == !!u);
 210
 211         /* If this is a different unit, then let's not merge things */
 212         if (u && DEVICE(u)->sysfs && !path_equal(DEVICE(u)->sysfs, sysfs))
 213                 u = NULL;
 214
 215         if (!u) {
 216                 delete = true;
 217
 218                 if (!(u = unit_new(m)))
 219                         return -ENOMEM;
 220
 221                 if ((r = device_add_escaped_name(u, sysfs, true)) < 0)
 222                         goto fail;
 223
 224                 unit_add_to_load_queue(u);
 225         } else
 226                 delete = false;
 227
 228         if (!(DEVICE(u)->sysfs))
 229                 if (!(DEVICE(u)->sysfs = strdup(sysfs))) {
 230                         r = -ENOMEM;
 231                         goto fail;
 232                 }
 233
 234         if (alias)
 235                 if ((r = device_add_escaped_name(u, alias, true)) < 0)
 236                         goto fail;
 237
 238         if (dn)
 239                 if ((r = device_add_escaped_name(u, dn, true)) < 0)
 240                         goto fail;
 241
 242         first = udev_device_get_devlinks_list_entry(dev);
 243         udev_list_entry_foreach(item, first)
 244                 if ((r = device_add_escaped_name(u, udev_list_entry_get_name(item), false)) < 0)
 245                         goto fail;
 246
 247         if ((model = udev_device_get_property_value(dev, "ID_MODEL_FROM_DATABASE")) ||
 248             (model = udev_device_get_property_value(dev, "ID_MODEL"))) {
 249                 if ((r = unit_set_description(u, model)) < 0)
 250                         goto fail;
 251         } else if (dn) {
 252                 if ((r = unit_set_description(u, dn)) < 0)
 253                         goto fail;
 254         } else
 255                 if ((r = unit_set_description(u, sysfs)) < 0)
 256                         goto fail;
 257
 258         if (wants) {
 259                 FOREACH_WORD(w, l, wants, state) {
 260                         char *e;
 261
 262                         if (!(e = strndup(w, l))) {
 263                                 r = -ENOMEM;
 264                                 goto fail;
 265                         }
 266
 267                         r = unit_add_dependency_by_name(u, UNIT_WANTS, NULL, e, true);
 268                         free(e);
 269
 270                         if (r < 0)
 271                                 goto fail;
 272                 }
 273         }
 274
 275         if (update_state) {
 276                 manager_dispatch_load_queue(u->meta.manager);
 277                 device_set_state(DEVICE(u), DEVICE_AVAILABLE);
 278         }
 279
 280         unit_add_to_dbus_queue(u);
 281
 282         return 0;
 283
 284 fail:
 285         if (delete && u)
 286                 unit_free(u);
 287         return r;
 288 }
 289
 290 static int device_process_path(Manager *m, const char *path, bool update_state) {
 291         int r;
 292         struct udev_device *dev;
 293
 294         assert(m);
 295         assert(path);
 296
 297         if (!(dev = udev_device_new_from_syspath(m->udev, path))) {
 298                 log_warning("Failed to get udev device object from udev for path %s.", path);
 299                 return -ENOMEM;
 300         }
 301
 302         r = device_process_new_device(m, dev, update_state);
 303         udev_device_unref(dev);
 304         return r;
 305 }
 306
 307 static int device_process_removed_device(Manager *m, struct udev_device *dev) {
 308         const char *sysfs;
 309         char *e;
 310         Unit *u;
 311         Device *d;
 312
 313         assert(m);
 314         assert(dev);
 315
 316         if (!(sysfs = udev_device_get_syspath(dev)))
 317                 return -ENOMEM;
 318
 319         assert(sysfs[0] == '/');
 320         if (!(e = unit_name_from_path(sysfs, ".device")))
 321                 return -ENOMEM;
 322
 323         u = manager_get_unit(m, e);
 324         free(e);
 325
 326         if (!u)
 327                 return 0;
 328
 329         d = DEVICE(u);
 330         free(d->sysfs);
 331         d->sysfs = NULL;
 332
 333         device_set_state(d, DEVICE_DEAD);
 334         return 0;
 335 }
 336
 337 static void device_shutdown(Manager *m) {
 338         assert(m);
 339
 340         if (m->udev_monitor) {
 341                 udev_monitor_unref(m->udev_monitor);
 342                 m->udev_monitor = NULL;
 343         }
 344
 345         if (m->udev) {
 346                 udev_unref(m->udev);
 347                 m->udev = NULL;
 348         }
 349 }
 350
 351 static int device_enumerate(Manager *m) {
 352         struct epoll_event ev;
 353         int r;
 354         struct udev_enumerate *e = NULL;
 355         struct udev_list_entry *item = NULL, *first = NULL;
 356
 357         assert(m);
 358
 359         if (!m->udev) {
 360                 if (!(m->udev = udev_new()))
 361                         return -ENOMEM;
 362
 363                 if (!(m->udev_monitor = udev_monitor_new_from_netlink(m->udev, "udev"))) {
 364                         r = -ENOMEM;
 365                         goto fail;
 366                 }
 367
 368                 if (udev_monitor_enable_receiving(m->udev_monitor) < 0) {
 369                         r = -EIO;
 370                         goto fail;
 371                 }
 372
 373                 m->udev_watch.type = WATCH_UDEV;
 374                 m->udev_watch.fd = udev_monitor_get_fd(m->udev_monitor);
 375
 376                 zero(ev);
 377                 ev.events = EPOLLIN;
 378                 ev.data.ptr = &m->udev_watch;
 379
 380                 if (epoll_ctl(m->epoll_fd, EPOLL_CTL_ADD, m->udev_watch.fd, &ev) < 0)
 381                         return -errno;
 382         }
 383
 384         if (!(e = udev_enumerate_new(m->udev))) {
 385                 r = -ENOMEM;
 386                 goto fail;
 387         }
 388
 389         if (udev_enumerate_scan_devices(e) < 0) {
 390                 r = -EIO;
 391                 goto fail;
 392         }
 393
 394         first = udev_enumerate_get_list_entry(e);
 395         udev_list_entry_foreach(item, first)
 396                 device_process_path(m, udev_list_entry_get_name(item), false);
 397
 398         udev_enumerate_unref(e);
 399         return 0;
 400
 401 fail:
 402         if (e)
 403                 udev_enumerate_unref(e);
 404
 405         device_shutdown(m);
 406         return r;
 407 }
 408
 409 void device_fd_event(Manager *m, int events) {
 410         struct udev_device *dev;
 411         int r;
 412         const char *action;
 413
 414         assert(m);
 415         assert(events == EPOLLIN);
 416
 417         if (!(dev = udev_monitor_receive_device(m->udev_monitor))) {
 418                 log_error("Failed to receive device.");
 419                 return;
 420         }
 421
 422         if (!(action = udev_device_get_action(dev))) {
 423                 log_error("Failed to get udev action string.");
 424                 goto fail;
 425         }
 426
 427         if (streq(action, "remove")) {
 428                 if ((r = device_process_removed_device(m, dev)) < 0) {
 429                         log_error("Failed to process udev device event: %s", strerror(-r));
 430                         goto fail;
 431                 }
 432         } else {
 433                 if ((r = device_process_new_device(m, dev, true)) < 0) {
 434                         log_error("Failed to process udev device event: %s", strerror(-r));
 435                         goto fail;
 436                 }
 437         }
 438
 439 fail:
 440         udev_device_unref(dev);
 441 }
 442
 443 static const char* const device_state_table[_DEVICE_STATE_MAX] = {
 444         [DEVICE_DEAD] = "dead",
 445         [DEVICE_AVAILABLE] = "available"
 446 };
 447
 448 DEFINE_STRING_TABLE_LOOKUP(device_state, DeviceState);
 449
 450 const UnitVTable device_vtable = {
 451         .suffix = ".device",
 452
 453         .no_requires = true,
 454         .no_instances = true,
 455         .no_snapshots = true,
 456         .no_isolate = true,
 457
 458         .load = unit_load_fragment_and_dropin_optional,
 459         .done = device_done,
 460         .coldplug = device_coldplug,
 461
 462         .dump = device_dump,
 463
 464         .active_state = device_active_state,
 465         .sub_state_to_string = device_sub_state_to_string,
 466
 467         .bus_message_handler = bus_device_message_handler,
 468
 469         .enumerate = device_enumerate,
 470         .shutdown = device_shutdown
 471 };