src/login/logind-button.c

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2
   3 #include <errno.h>
   4 #include <fcntl.h>
   5 #include <sys/ioctl.h>
   6 #include <unistd.h>
   7
   8 #include "sd-messages.h"
   9
  10 #include "alloc-util.h"
  11 #include "async.h"
  12 #include "fd-util.h"
  13 #include "logind-button.h"
  14 #include "missing_input.h"
  15 #include "string-util.h"
  16
  17 #define CONST_MAX5(a, b, c, d, e) CONST_MAX(CONST_MAX(a, b), CONST_MAX(CONST_MAX(c, d), e))
  18
  19 #define ULONG_BITS (sizeof(unsigned long)*8)
  20
  21 #define LONG_PRESS_DURATION (5 * USEC_PER_SEC)
  22
  23 static bool bitset_get(const unsigned long *bits, unsigned i) {
  24         return (bits[i / ULONG_BITS] >> (i % ULONG_BITS)) & 1UL;
  25 }
  26
  27 static void bitset_put(unsigned long *bits, unsigned i) {
  28         bits[i / ULONG_BITS] |= (unsigned long) 1 << (i % ULONG_BITS);
  29 }
  30
  31 Button* button_new(Manager *m, const char *name) {
  32         Button *b;
  33
  34         assert(m);
  35         assert(name);
  36
  37         b = new0(Button, 1);
  38         if (!b)
  39                 return NULL;
  40
  41         b->name = strdup(name);
  42         if (!b->name)
  43                 return mfree(b);
  44
  45         if (hashmap_put(m->buttons, b->name, b) < 0) {
  46                 free(b->name);
  47                 return mfree(b);
  48         }
  49
  50         b->manager = m;
  51         b->fd = -EBADF;
  52
  53         return b;
  54 }
  55
  56 void button_free(Button *b) {
  57         assert(b);
  58
  59         hashmap_remove(b->manager->buttons, b->name);
  60
  61         sd_event_source_unref(b->io_event_source);
  62         sd_event_source_unref(b->check_event_source);
  63
  64         asynchronous_close(b->fd);
  65
  66         free(b->name);
  67         free(b->seat);
  68         free(b);
  69 }
  70
  71 int button_set_seat(Button *b, const char *sn) {
  72         assert(b);
  73
  74         return free_and_strdup(&b->seat, sn);
  75 }
  76
  77 static void button_lid_switch_handle_action(Manager *manager, bool is_edge) {
  78         HandleAction handle_action;
  79
  80         assert(manager);
  81
  82         /* If we are docked or on external power, handle the lid switch
  83          * differently */
  84         if (manager_is_docked_or_external_displays(manager))
  85                 handle_action = manager->handle_lid_switch_docked;
  86         else if (handle_action_valid(manager->handle_lid_switch_ep) && manager_is_on_external_power())
  87                 handle_action = manager->handle_lid_switch_ep;
  88         else
  89                 handle_action = manager->handle_lid_switch;
  90
  91         manager_handle_action(manager, INHIBIT_HANDLE_LID_SWITCH, handle_action, manager->lid_switch_ignore_inhibited, is_edge);
  92 }
  93
  94 static int button_recheck(sd_event_source *e, void *userdata) {
  95         Button *b = ASSERT_PTR(userdata);
  96
  97         assert(b->lid_closed);
  98
  99         button_lid_switch_handle_action(b->manager, false);
 100         return 1;
 101 }
 102
 103 static int button_install_check_event_source(Button *b) {
 104         int r;
 105         assert(b);
 106
 107         /* Install a post handler, so that we keep rechecking as long as the lid is closed. */
 108
 109         if (b->check_event_source)
 110                 return 0;
 111
 112         r = sd_event_add_post(b->manager->event, &b->check_event_source, button_recheck, b);
 113         if (r < 0)
 114                 return r;
 115
 116         return sd_event_source_set_priority(b->check_event_source, SD_EVENT_PRIORITY_IDLE+1);
 117 }
 118
 119 static int long_press_of_power_key_handler(sd_event_source *e, uint64_t usec, void *userdata) {
 120         Manager *m = ASSERT_PTR(userdata);
 121
 122         assert(e);
 123
 124         m->power_key_long_press_event_source = sd_event_source_unref(m->power_key_long_press_event_source);
 125
 126         log_struct(LOG_INFO,
 127                    LOG_MESSAGE("Power key pressed long."),
 128                    "MESSAGE_ID=" SD_MESSAGE_POWER_KEY_LONG_PRESS_STR);
 129
 130         manager_handle_action(m, INHIBIT_HANDLE_POWER_KEY, m->handle_power_key_long_press, m->power_key_ignore_inhibited, true);
 131         return 0;
 132 }
 133
 134 static int long_press_of_reboot_key_handler(sd_event_source *e, uint64_t usec, void *userdata) {
 135         Manager *m = ASSERT_PTR(userdata);
 136
 137         assert(e);
 138
 139         m->reboot_key_long_press_event_source = sd_event_source_unref(m->reboot_key_long_press_event_source);
 140
 141         log_struct(LOG_INFO,
 142                    LOG_MESSAGE("Reboot key pressed long."),
 143                    "MESSAGE_ID=" SD_MESSAGE_REBOOT_KEY_LONG_PRESS_STR);
 144
 145         manager_handle_action(m, INHIBIT_HANDLE_REBOOT_KEY, m->handle_reboot_key_long_press, m->reboot_key_ignore_inhibited, true);
 146         return 0;
 147 }
 148
 149 static int long_press_of_suspend_key_handler(sd_event_source *e, uint64_t usec, void *userdata) {
 150         Manager *m = ASSERT_PTR(userdata);
 151
 152         assert(e);
 153
 154         m->suspend_key_long_press_event_source = sd_event_source_unref(m->suspend_key_long_press_event_source);
 155
 156         log_struct(LOG_INFO,
 157                    LOG_MESSAGE("Suspend key pressed long."),
 158                    "MESSAGE_ID=" SD_MESSAGE_SUSPEND_KEY_LONG_PRESS_STR);
 159
 160         manager_handle_action(m, INHIBIT_HANDLE_SUSPEND_KEY, m->handle_suspend_key_long_press, m->suspend_key_ignore_inhibited, true);
 161         return 0;
 162 }
 163
 164 static int long_press_of_hibernate_key_handler(sd_event_source *e, uint64_t usec, void *userdata) {
 165         Manager *m = ASSERT_PTR(userdata);
 166
 167         assert(e);
 168
 169         m->hibernate_key_long_press_event_source = sd_event_source_unref(m->hibernate_key_long_press_event_source);
 170
 171         log_struct(LOG_INFO,
 172                    LOG_MESSAGE("Hibernate key pressed long."),
 173                    "MESSAGE_ID=" SD_MESSAGE_HIBERNATE_KEY_LONG_PRESS_STR);
 174
 175         manager_handle_action(m, INHIBIT_HANDLE_HIBERNATE_KEY, m->handle_hibernate_key_long_press, m->hibernate_key_ignore_inhibited, true);
 176         return 0;
 177 }
 178
 179 static void start_long_press(Manager *m, sd_event_source **e, sd_event_time_handler_t callback) {
 180         int r;
 181
 182         assert(m);
 183         assert(e);
 184
 185         if (*e)
 186                 return;
 187
 188         r = sd_event_add_time_relative(
 189                         m->event,
 190                         e,
 191                         CLOCK_MONOTONIC,
 192                         LONG_PRESS_DURATION, 0,
 193                         callback, m);
 194         if (r < 0)
 195                 log_warning_errno(r, "Failed to add long press timer event, ignoring: %m");
 196 }
 197
 198 static int button_dispatch(sd_event_source *s, int fd, uint32_t revents, void *userdata) {
 199         Button *b = ASSERT_PTR(userdata);
 200         struct input_event ev;
 201         ssize_t l;
 202
 203         assert(s);
 204         assert(fd == b->fd);
 205
 206         l = read(b->fd, &ev, sizeof(ev));
 207         if (l < 0)
 208                 return errno != EAGAIN ? -errno : 0;
 209         if ((size_t) l < sizeof(ev))
 210                 return -EIO;
 211
 212         if (ev.type == EV_KEY && ev.value > 0) {
 213
 214                 switch (ev.code) {
 215
 216                 case KEY_POWER:
 217                 case KEY_POWER2:
 218                         if (b->manager->handle_power_key_long_press != HANDLE_IGNORE && b->manager->handle_power_key_long_press != b->manager->handle_power_key) {
 219                                 log_debug("Power key pressed. Further action depends on the key press duration.");
 220                                 start_long_press(b->manager, &b->manager->power_key_long_press_event_source, long_press_of_power_key_handler);
 221                         } else {
 222                                 log_struct(LOG_INFO,
 223                                            LOG_MESSAGE("Power key pressed short."),
 224                                            "MESSAGE_ID=" SD_MESSAGE_POWER_KEY_STR);
 225                                 manager_handle_action(b->manager, INHIBIT_HANDLE_POWER_KEY, b->manager->handle_power_key, b->manager->power_key_ignore_inhibited, true);
 226                         }
 227                         break;
 228
 229                 /* The kernel naming is a bit confusing here:
 230                    KEY_RESTART was probably introduced for media playback purposes, but
 231                    is now being predominantly used to indicate device reboot.
 232                 */
 233
 234                 case KEY_RESTART:
 235                         if (b->manager->handle_reboot_key_long_press != HANDLE_IGNORE && b->manager->handle_reboot_key_long_press != b->manager->handle_reboot_key) {
 236                                 log_debug("Reboot key pressed. Further action depends on the key press duration.");
 237                                 start_long_press(b->manager, &b->manager->reboot_key_long_press_event_source, long_press_of_reboot_key_handler);
 238                         } else {
 239                                 log_struct(LOG_INFO,
 240                                            LOG_MESSAGE("Reboot key pressed short."),
 241                                            "MESSAGE_ID=" SD_MESSAGE_REBOOT_KEY_STR);
 242                                 manager_handle_action(b->manager, INHIBIT_HANDLE_REBOOT_KEY, b->manager->handle_reboot_key, b->manager->reboot_key_ignore_inhibited, true);
 243                         }
 244                         break;
 245
 246                 /* The kernel naming is a bit confusing here:
 247
 248                    KEY_SLEEP   = suspend-to-ram, which everybody else calls "suspend"
 249                    KEY_SUSPEND = suspend-to-disk, which everybody else calls "hibernate"
 250                 */
 251
 252                 case KEY_SLEEP:
 253                         if (b->manager->handle_suspend_key_long_press != HANDLE_IGNORE && b->manager->handle_suspend_key_long_press != b->manager->handle_suspend_key) {
 254                                 log_debug("Suspend key pressed. Further action depends on the key press duration.");
 255                                 start_long_press(b->manager, &b->manager->suspend_key_long_press_event_source, long_press_of_suspend_key_handler);
 256                         } else {
 257                                 log_struct(LOG_INFO,
 258                                            LOG_MESSAGE("Suspend key pressed short."),
 259                                            "MESSAGE_ID=" SD_MESSAGE_SUSPEND_KEY_STR);
 260                                 manager_handle_action(b->manager, INHIBIT_HANDLE_SUSPEND_KEY, b->manager->handle_suspend_key, b->manager->suspend_key_ignore_inhibited, true);
 261                         }
 262                         break;
 263
 264                 case KEY_SUSPEND:
 265                         if (b->manager->handle_hibernate_key_long_press != HANDLE_IGNORE && b->manager->handle_hibernate_key_long_press != b->manager->handle_hibernate_key) {
 266                                 log_debug("Hibernate key pressed. Further action depends on the key press duration.");
 267                                 start_long_press(b->manager, &b->manager->hibernate_key_long_press_event_source, long_press_of_hibernate_key_handler);
 268                         } else {
 269                                 log_struct(LOG_INFO,
 270                                            LOG_MESSAGE("Hibernate key pressed short."),
 271                                            "MESSAGE_ID=" SD_MESSAGE_HIBERNATE_KEY_STR);
 272                                 manager_handle_action(b->manager, INHIBIT_HANDLE_HIBERNATE_KEY, b->manager->handle_hibernate_key, b->manager->hibernate_key_ignore_inhibited, true);
 273                         }
 274                         break;
 275                 }
 276
 277         } else if (ev.type == EV_KEY && ev.value == 0) {
 278
 279                 switch (ev.code) {
 280
 281                 case KEY_POWER:
 282                 case KEY_POWER2:
 283                         if (b->manager->power_key_long_press_event_source) {
 284                                 /* Long press event timer is still pending and key release
 285                                    event happened.  This means that key press duration was
 286                                    insufficient to trigger a long press event
 287                                 */
 288                                 log_struct(LOG_INFO,
 289                                            LOG_MESSAGE("Power key pressed short."),
 290                                            "MESSAGE_ID=" SD_MESSAGE_POWER_KEY_STR);
 291
 292                                 b->manager->power_key_long_press_event_source = sd_event_source_unref(b->manager->power_key_long_press_event_source);
 293
 294                                 manager_handle_action(b->manager, INHIBIT_HANDLE_POWER_KEY, b->manager->handle_power_key, b->manager->power_key_ignore_inhibited, true);
 295                         }
 296                         break;
 297
 298                 case KEY_RESTART:
 299                         if (b->manager->reboot_key_long_press_event_source) {
 300                                 log_struct(LOG_INFO,
 301                                            LOG_MESSAGE("Reboot key pressed short."),
 302                                            "MESSAGE_ID=" SD_MESSAGE_REBOOT_KEY_STR);
 303
 304                                 b->manager->reboot_key_long_press_event_source = sd_event_source_unref(b->manager->reboot_key_long_press_event_source);
 305
 306                                 manager_handle_action(b->manager, INHIBIT_HANDLE_REBOOT_KEY, b->manager->handle_reboot_key, b->manager->reboot_key_ignore_inhibited, true);
 307                         }
 308                         break;
 309
 310                 case KEY_SLEEP:
 311                         if (b->manager->suspend_key_long_press_event_source) {
 312                                 log_struct(LOG_INFO,
 313                                            LOG_MESSAGE("Suspend key pressed short."),
 314                                            "MESSAGE_ID=" SD_MESSAGE_SUSPEND_KEY_STR);
 315
 316                                 b->manager->suspend_key_long_press_event_source = sd_event_source_unref(b->manager->suspend_key_long_press_event_source);
 317
 318                                 manager_handle_action(b->manager, INHIBIT_HANDLE_SUSPEND_KEY, b->manager->handle_suspend_key, b->manager->suspend_key_ignore_inhibited, true);
 319                         }
 320                         break;
 321                 case KEY_SUSPEND:
 322                         if (b->manager->hibernate_key_long_press_event_source) {
 323                                 log_struct(LOG_INFO,
 324                                            LOG_MESSAGE("Hibernate key pressed short."),
 325                                            "MESSAGE_ID=" SD_MESSAGE_HIBERNATE_KEY_STR);
 326
 327                                 b->manager->hibernate_key_long_press_event_source = sd_event_source_unref(b->manager->hibernate_key_long_press_event_source);
 328
 329                                 manager_handle_action(b->manager, INHIBIT_HANDLE_HIBERNATE_KEY, b->manager->handle_hibernate_key, b->manager->hibernate_key_ignore_inhibited, true);
 330                         }
 331                         break;
 332                 }
 333
 334         } else if (ev.type == EV_SW && ev.value > 0) {
 335
 336                 if (ev.code == SW_LID) {
 337                         log_struct(LOG_INFO,
 338                                    LOG_MESSAGE("Lid closed."),
 339                                    "MESSAGE_ID=" SD_MESSAGE_LID_CLOSED_STR);
 340
 341                         b->lid_closed = true;
 342                         button_lid_switch_handle_action(b->manager, true);
 343                         button_install_check_event_source(b);
 344
 345                 } else if (ev.code == SW_DOCK) {
 346                         log_struct(LOG_INFO,
 347                                    LOG_MESSAGE("System docked."),
 348                                    "MESSAGE_ID=" SD_MESSAGE_SYSTEM_DOCKED_STR);
 349
 350                         b->docked = true;
 351                 }
 352
 353         } else if (ev.type == EV_SW && ev.value == 0) {
 354
 355                 if (ev.code == SW_LID) {
 356                         log_struct(LOG_INFO,
 357                                    LOG_MESSAGE("Lid opened."),
 358                                    "MESSAGE_ID=" SD_MESSAGE_LID_OPENED_STR);
 359
 360                         b->lid_closed = false;
 361                         b->check_event_source = sd_event_source_unref(b->check_event_source);
 362
 363                 } else if (ev.code == SW_DOCK) {
 364                         log_struct(LOG_INFO,
 365                                    LOG_MESSAGE("System undocked."),
 366                                    "MESSAGE_ID=" SD_MESSAGE_SYSTEM_UNDOCKED_STR);
 367
 368                         b->docked = false;
 369                 }
 370         }
 371
 372         return 0;
 373 }
 374
 375 static int button_suitable(int fd) {
 376         unsigned long types[CONST_MAX(EV_KEY, EV_SW)/ULONG_BITS+1];
 377
 378         assert(fd >= 0);
 379
 380         if (ioctl(fd, EVIOCGBIT(EV_SYN, sizeof types), types) < 0)
 381                 return -errno;
 382
 383         if (bitset_get(types, EV_KEY)) {
 384                 unsigned long keys[CONST_MAX5(KEY_POWER, KEY_POWER2, KEY_SLEEP, KEY_SUSPEND, KEY_RESTART)/ULONG_BITS+1];
 385
 386                 if (ioctl(fd, EVIOCGBIT(EV_KEY, sizeof keys), keys) < 0)
 387                         return -errno;
 388
 389                 if (bitset_get(keys, KEY_POWER) ||
 390                     bitset_get(keys, KEY_POWER2) ||
 391                     bitset_get(keys, KEY_SLEEP) ||
 392                     bitset_get(keys, KEY_SUSPEND) ||
 393                     bitset_get(keys, KEY_RESTART))
 394                         return true;
 395         }
 396
 397         if (bitset_get(types, EV_SW)) {
 398                 unsigned long switches[CONST_MAX(SW_LID, SW_DOCK)/ULONG_BITS+1];
 399
 400                 if (ioctl(fd, EVIOCGBIT(EV_SW, sizeof switches), switches) < 0)
 401                         return -errno;
 402
 403                 if (bitset_get(switches, SW_LID) ||
 404                     bitset_get(switches, SW_DOCK))
 405                         return true;
 406         }
 407
 408         return false;
 409 }
 410
 411 static int button_set_mask(const char *name, int fd) {
 412         unsigned long
 413                 types[CONST_MAX(EV_KEY, EV_SW)/ULONG_BITS+1] = {},
 414                 keys[CONST_MAX5(KEY_POWER, KEY_POWER2, KEY_SLEEP, KEY_SUSPEND, KEY_RESTART)/ULONG_BITS+1] = {},
 415                 switches[CONST_MAX(SW_LID, SW_DOCK)/ULONG_BITS+1] = {};
 416         struct input_mask mask;
 417
 418         assert(name);
 419         assert(fd >= 0);
 420
 421         bitset_put(types, EV_KEY);
 422         bitset_put(types, EV_SW);
 423
 424         mask = (struct input_mask) {
 425                 .type = EV_SYN,
 426                 .codes_size = sizeof(types),
 427                 .codes_ptr = PTR_TO_UINT64(types),
 428         };
 429
 430         if (ioctl(fd, EVIOCSMASK, &mask) < 0)
 431                 /* Log only at debug level if the kernel doesn't do EVIOCSMASK yet */
 432                 return log_full_errno(IN_SET(errno, ENOTTY, EOPNOTSUPP, EINVAL) ? LOG_DEBUG : LOG_WARNING,
 433                                       errno, "Failed to set EV_SYN event mask on /dev/input/%s: %m", name);
 434
 435         bitset_put(keys, KEY_POWER);
 436         bitset_put(keys, KEY_POWER2);
 437         bitset_put(keys, KEY_SLEEP);
 438         bitset_put(keys, KEY_SUSPEND);
 439         bitset_put(keys, KEY_RESTART);
 440
 441         mask = (struct input_mask) {
 442                 .type = EV_KEY,
 443                 .codes_size = sizeof(keys),
 444                 .codes_ptr = PTR_TO_UINT64(keys),
 445         };
 446
 447         if (ioctl(fd, EVIOCSMASK, &mask) < 0)
 448                 return log_warning_errno(errno, "Failed to set EV_KEY event mask on /dev/input/%s: %m", name);
 449
 450         bitset_put(switches, SW_LID);
 451         bitset_put(switches, SW_DOCK);
 452
 453         mask = (struct input_mask) {
 454                 .type = EV_SW,
 455                 .codes_size = sizeof(switches),
 456                 .codes_ptr = PTR_TO_UINT64(switches),
 457         };
 458
 459         if (ioctl(fd, EVIOCSMASK, &mask) < 0)
 460                 return log_warning_errno(errno, "Failed to set EV_SW event mask on /dev/input/%s: %m", name);
 461
 462         return 0;
 463 }
 464
 465 int button_open(Button *b) {
 466         _cleanup_(asynchronous_closep) int fd = -EBADF;
 467         const char *p;
 468         char name[256];
 469         int r;
 470
 471         assert(b);
 472
 473         b->fd = asynchronous_close(b->fd);
 474
 475         p = strjoina("/dev/input/", b->name);
 476
 477         fd = open(p, O_RDWR|O_CLOEXEC|O_NOCTTY|O_NONBLOCK);
 478         if (fd < 0)
 479                 return log_warning_errno(errno, "Failed to open %s: %m", p);
 480
 481         r = button_suitable(fd);
 482         if (r < 0)
 483                 return log_warning_errno(r, "Failed to determine whether input device %s is relevant to us: %m", p);
 484         if (r == 0)
 485                 return log_debug_errno(SYNTHETIC_ERRNO(EADDRNOTAVAIL),
 486                                        "Device %s does not expose keys or switches relevant to us, ignoring.", p);
 487
 488         if (ioctl(fd, EVIOCGNAME(sizeof name), name) < 0)
 489                 return log_error_errno(errno, "Failed to get input name for %s: %m", p);
 490
 491         (void) button_set_mask(b->name, fd);
 492
 493         b->io_event_source = sd_event_source_unref(b->io_event_source);
 494         r = sd_event_add_io(b->manager->event, &b->io_event_source, fd, EPOLLIN, button_dispatch, b);
 495         if (r < 0)
 496                 return log_error_errno(r, "Failed to add button event for %s: %m", p);
 497
 498         b->fd = TAKE_FD(fd);
 499         log_info("Watching system buttons on %s (%s)", p, name);
 500         return 0;
 501 }
 502
 503 int button_check_switches(Button *b) {
 504         unsigned long switches[CONST_MAX(SW_LID, SW_DOCK)/ULONG_BITS+1] = {};
 505         assert(b);
 506
 507         if (b->fd < 0)
 508                 return -EINVAL;
 509
 510         if (ioctl(b->fd, EVIOCGSW(sizeof(switches)), switches) < 0)
 511                 return -errno;
 512
 513         b->lid_closed = bitset_get(switches, SW_LID);
 514         b->docked = bitset_get(switches, SW_DOCK);
 515
 516         if (b->lid_closed)
 517                 button_install_check_event_source(b);
 518
 519         return 0;
 520 }