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 #include "util.h"
  17
  18 #define CONST_MAX5(a, b, c, d, e) CONST_MAX(CONST_MAX(a, b), CONST_MAX(CONST_MAX(c, d), e))
  19
  20 #define ULONG_BITS (sizeof(unsigned long)*8)
  21
  22 static bool bitset_get(const unsigned long *bits, unsigned i) {
  23         return (bits[i / ULONG_BITS] >> (i % ULONG_BITS)) & 1UL;
  24 }
  25
  26 static void bitset_put(unsigned long *bits, unsigned i) {
  27         bits[i / ULONG_BITS] |= (unsigned long) 1 << (i % ULONG_BITS);
  28 }
  29
  30 Button* button_new(Manager *m, const char *name) {
  31         Button *b;
  32
  33         assert(m);
  34         assert(name);
  35
  36         b = new0(Button, 1);
  37         if (!b)
  38                 return NULL;
  39
  40         b->name = strdup(name);
  41         if (!b->name)
  42                 return mfree(b);
  43
  44         if (hashmap_put(m->buttons, b->name, b) < 0) {
  45                 free(b->name);
  46                 return mfree(b);
  47         }
  48
  49         b->manager = m;
  50         b->fd = -1;
  51
  52         return b;
  53 }
  54
  55 void button_free(Button *b) {
  56         assert(b);
  57
  58         hashmap_remove(b->manager->buttons, b->name);
  59
  60         sd_event_source_unref(b->io_event_source);
  61         sd_event_source_unref(b->check_event_source);
  62
  63         asynchronous_close(b->fd);
  64
  65         free(b->name);
  66         free(b->seat);
  67         free(b);
  68 }
  69
  70 int button_set_seat(Button *b, const char *sn) {
  71         assert(b);
  72
  73         return free_and_strdup(&b->seat, sn);
  74 }
  75
  76 static void button_lid_switch_handle_action(Manager *manager, bool is_edge) {
  77         HandleAction handle_action;
  78
  79         assert(manager);
  80
  81         /* If we are docked or on external power, handle the lid switch
  82          * differently */
  83         if (manager_is_docked_or_external_displays(manager))
  84                 handle_action = manager->handle_lid_switch_docked;
  85         else if (manager->handle_lid_switch_ep != _HANDLE_ACTION_INVALID &&
  86                  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 = userdata;
  96
  97         assert(b);
  98         assert(b->lid_closed);
  99
 100         button_lid_switch_handle_action(b->manager, false);
 101         return 1;
 102 }
 103
 104 static int button_install_check_event_source(Button *b) {
 105         int r;
 106         assert(b);
 107
 108         /* Install a post handler, so that we keep rechecking as long as the lid is closed. */
 109
 110         if (b->check_event_source)
 111                 return 0;
 112
 113         r = sd_event_add_post(b->manager->event, &b->check_event_source, button_recheck, b);
 114         if (r < 0)
 115                 return r;
 116
 117         return sd_event_source_set_priority(b->check_event_source, SD_EVENT_PRIORITY_IDLE+1);
 118 }
 119
 120 static int button_dispatch(sd_event_source *s, int fd, uint32_t revents, void *userdata) {
 121         Button *b = userdata;
 122         struct input_event ev;
 123         ssize_t l;
 124
 125         assert(s);
 126         assert(fd == b->fd);
 127         assert(b);
 128
 129         l = read(b->fd, &ev, sizeof(ev));
 130         if (l < 0)
 131                 return errno != EAGAIN ? -errno : 0;
 132         if ((size_t) l < sizeof(ev))
 133                 return -EIO;
 134
 135         if (ev.type == EV_KEY && ev.value > 0) {
 136
 137                 switch (ev.code) {
 138
 139                 case KEY_POWER:
 140                 case KEY_POWER2:
 141                         log_struct(LOG_INFO,
 142                                    LOG_MESSAGE("Power key pressed."),
 143                                    "MESSAGE_ID=" SD_MESSAGE_POWER_KEY_STR);
 144
 145                         manager_handle_action(b->manager, INHIBIT_HANDLE_POWER_KEY, b->manager->handle_power_key, b->manager->power_key_ignore_inhibited, true);
 146                         break;
 147
 148                 /* The kernel naming is a bit confusing here:
 149                    KEY_RESTART was probably introduced for media playback purposes, but
 150                    is now being predominantly used to indicate device reboot.
 151                 */
 152
 153                 case KEY_RESTART:
 154                         log_struct(LOG_INFO,
 155                                    LOG_MESSAGE("Reboot key pressed."),
 156                                    "MESSAGE_ID=" SD_MESSAGE_REBOOT_KEY_STR);
 157
 158                         manager_handle_action(b->manager, INHIBIT_HANDLE_REBOOT_KEY, b->manager->handle_reboot_key, b->manager->reboot_key_ignore_inhibited, true);
 159                         break;
 160
 161                 /* The kernel naming is a bit confusing here:
 162
 163                    KEY_SLEEP   = suspend-to-ram, which everybody else calls "suspend"
 164                    KEY_SUSPEND = suspend-to-disk, which everybody else calls "hibernate"
 165                 */
 166
 167                 case KEY_SLEEP:
 168                         log_struct(LOG_INFO,
 169                                    LOG_MESSAGE("Suspend key pressed."),
 170                                    "MESSAGE_ID=" SD_MESSAGE_SUSPEND_KEY_STR);
 171
 172                         manager_handle_action(b->manager, INHIBIT_HANDLE_SUSPEND_KEY, b->manager->handle_suspend_key, b->manager->suspend_key_ignore_inhibited, true);
 173                         break;
 174
 175                 case KEY_SUSPEND:
 176                         log_struct(LOG_INFO,
 177                                    LOG_MESSAGE("Hibernate key pressed."),
 178                                    "MESSAGE_ID=" SD_MESSAGE_HIBERNATE_KEY_STR);
 179
 180                         manager_handle_action(b->manager, INHIBIT_HANDLE_HIBERNATE_KEY, b->manager->handle_hibernate_key, b->manager->hibernate_key_ignore_inhibited, true);
 181                         break;
 182                 }
 183
 184         } else if (ev.type == EV_SW && ev.value > 0) {
 185
 186                 if (ev.code == SW_LID) {
 187                         log_struct(LOG_INFO,
 188                                    LOG_MESSAGE("Lid closed."),
 189                                    "MESSAGE_ID=" SD_MESSAGE_LID_CLOSED_STR);
 190
 191                         b->lid_closed = true;
 192                         button_lid_switch_handle_action(b->manager, true);
 193                         button_install_check_event_source(b);
 194
 195                 } else if (ev.code == SW_DOCK) {
 196                         log_struct(LOG_INFO,
 197                                    LOG_MESSAGE("System docked."),
 198                                    "MESSAGE_ID=" SD_MESSAGE_SYSTEM_DOCKED_STR);
 199
 200                         b->docked = true;
 201                 }
 202
 203         } else if (ev.type == EV_SW && ev.value == 0) {
 204
 205                 if (ev.code == SW_LID) {
 206                         log_struct(LOG_INFO,
 207                                    LOG_MESSAGE("Lid opened."),
 208                                    "MESSAGE_ID=" SD_MESSAGE_LID_OPENED_STR);
 209
 210                         b->lid_closed = false;
 211                         b->check_event_source = sd_event_source_unref(b->check_event_source);
 212
 213                 } else if (ev.code == SW_DOCK) {
 214                         log_struct(LOG_INFO,
 215                                    LOG_MESSAGE("System undocked."),
 216                                    "MESSAGE_ID=" SD_MESSAGE_SYSTEM_UNDOCKED_STR);
 217
 218                         b->docked = false;
 219                 }
 220         }
 221
 222         return 0;
 223 }
 224
 225 static int button_suitable(int fd) {
 226         unsigned long types[CONST_MAX(EV_KEY, EV_SW)/ULONG_BITS+1];
 227
 228         assert(fd >= 0);
 229
 230         if (ioctl(fd, EVIOCGBIT(EV_SYN, sizeof types), types) < 0)
 231                 return -errno;
 232
 233         if (bitset_get(types, EV_KEY)) {
 234                 unsigned long keys[CONST_MAX5(KEY_POWER, KEY_POWER2, KEY_SLEEP, KEY_SUSPEND, KEY_RESTART)/ULONG_BITS+1];
 235
 236                 if (ioctl(fd, EVIOCGBIT(EV_KEY, sizeof keys), keys) < 0)
 237                         return -errno;
 238
 239                 if (bitset_get(keys, KEY_POWER) ||
 240                     bitset_get(keys, KEY_POWER2) ||
 241                     bitset_get(keys, KEY_SLEEP) ||
 242                     bitset_get(keys, KEY_SUSPEND) ||
 243                     bitset_get(keys, KEY_RESTART))
 244                         return true;
 245         }
 246
 247         if (bitset_get(types, EV_SW)) {
 248                 unsigned long switches[CONST_MAX(SW_LID, SW_DOCK)/ULONG_BITS+1];
 249
 250                 if (ioctl(fd, EVIOCGBIT(EV_SW, sizeof switches), switches) < 0)
 251                         return -errno;
 252
 253                 if (bitset_get(switches, SW_LID) ||
 254                     bitset_get(switches, SW_DOCK))
 255                         return true;
 256         }
 257
 258         return false;
 259 }
 260
 261 static int button_set_mask(const char *name, int fd) {
 262         unsigned long
 263                 types[CONST_MAX(EV_KEY, EV_SW)/ULONG_BITS+1] = {},
 264                 keys[CONST_MAX5(KEY_POWER, KEY_POWER2, KEY_SLEEP, KEY_SUSPEND, KEY_RESTART)/ULONG_BITS+1] = {},
 265                 switches[CONST_MAX(SW_LID, SW_DOCK)/ULONG_BITS+1] = {};
 266         struct input_mask mask;
 267
 268         assert(name);
 269         assert(fd >= 0);
 270
 271         bitset_put(types, EV_KEY);
 272         bitset_put(types, EV_SW);
 273
 274         mask = (struct input_mask) {
 275                 .type = EV_SYN,
 276                 .codes_size = sizeof(types),
 277                 .codes_ptr = PTR_TO_UINT64(types),
 278         };
 279
 280         if (ioctl(fd, EVIOCSMASK, &mask) < 0)
 281                 /* Log only at debug level if the kernel doesn't do EVIOCSMASK yet */
 282                 return log_full_errno(IN_SET(errno, ENOTTY, EOPNOTSUPP, EINVAL) ? LOG_DEBUG : LOG_WARNING,
 283                                       errno, "Failed to set EV_SYN event mask on /dev/input/%s: %m", name);
 284
 285         bitset_put(keys, KEY_POWER);
 286         bitset_put(keys, KEY_POWER2);
 287         bitset_put(keys, KEY_SLEEP);
 288         bitset_put(keys, KEY_SUSPEND);
 289         bitset_put(keys, KEY_RESTART);
 290
 291         mask = (struct input_mask) {
 292                 .type = EV_KEY,
 293                 .codes_size = sizeof(keys),
 294                 .codes_ptr = PTR_TO_UINT64(keys),
 295         };
 296
 297         if (ioctl(fd, EVIOCSMASK, &mask) < 0)
 298                 return log_warning_errno(errno, "Failed to set EV_KEY event mask on /dev/input/%s: %m", name);
 299
 300         bitset_put(switches, SW_LID);
 301         bitset_put(switches, SW_DOCK);
 302
 303         mask = (struct input_mask) {
 304                 .type = EV_SW,
 305                 .codes_size = sizeof(switches),
 306                 .codes_ptr = PTR_TO_UINT64(switches),
 307         };
 308
 309         if (ioctl(fd, EVIOCSMASK, &mask) < 0)
 310                 return log_warning_errno(errno, "Failed to set EV_SW event mask on /dev/input/%s: %m", name);
 311
 312         return 0;
 313 }
 314
 315 int button_open(Button *b) {
 316         _cleanup_(asynchronous_closep) int fd = -1;
 317         const char *p;
 318         char name[256];
 319         int r;
 320
 321         assert(b);
 322
 323         b->fd = asynchronous_close(b->fd);
 324
 325         p = strjoina("/dev/input/", b->name);
 326
 327         fd = open(p, O_RDWR|O_CLOEXEC|O_NOCTTY|O_NONBLOCK);
 328         if (fd < 0)
 329                 return log_warning_errno(errno, "Failed to open %s: %m", p);
 330
 331         r = button_suitable(fd);
 332         if (r < 0)
 333                 return log_warning_errno(r, "Failed to determine whether input device %s is relevant to us: %m", p);
 334         if (r == 0)
 335                 return log_debug_errno(SYNTHETIC_ERRNO(EADDRNOTAVAIL),
 336                                        "Device %s does not expose keys or switches relevant to us, ignoring.", p);
 337
 338         if (ioctl(fd, EVIOCGNAME(sizeof name), name) < 0)
 339                 return log_error_errno(errno, "Failed to get input name for %s: %m", p);
 340
 341         (void) button_set_mask(b->name, fd);
 342
 343         b->io_event_source = sd_event_source_unref(b->io_event_source);
 344         r = sd_event_add_io(b->manager->event, &b->io_event_source, fd, EPOLLIN, button_dispatch, b);
 345         if (r < 0)
 346                 return log_error_errno(r, "Failed to add button event for %s: %m", p);
 347
 348         b->fd = TAKE_FD(fd);
 349         log_info("Watching system buttons on %s (%s)", p, name);
 350         return 0;
 351 }
 352
 353 int button_check_switches(Button *b) {
 354         unsigned long switches[CONST_MAX(SW_LID, SW_DOCK)/ULONG_BITS+1] = {};
 355         assert(b);
 356
 357         if (b->fd < 0)
 358                 return -EINVAL;
 359
 360         if (ioctl(b->fd, EVIOCGSW(sizeof(switches)), switches) < 0)
 361                 return -errno;
 362
 363         b->lid_closed = bitset_get(switches, SW_LID);
 364         b->docked = bitset_get(switches, SW_DOCK);
 365
 366         if (b->lid_closed)
 367                 button_install_check_event_source(b);
 368
 369         return 0;
 370 }