src/login/elogind.c

   1 /***
   2   This file is part of elogind.
   3
   4   Copyright 2017 Sven Eden
   5
   6   elogind is free software; you can redistribute it and/or modify it
   7   under the terms of the GNU Lesser General Public License as published by
   8   the Free Software Foundation; either version 2.1 of the License, or
   9   (at your option) any later version.
  10
  11   elogind is distributed in the hope that it will be useful, but
  12   WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14   Lesser General Public License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public License
  17   along with elogind; If not, see <http://www.gnu.org/licenses/>.
  18 ***/
  19
  20
  21 #include "bus-util.h"
  22 #include "cgroup.h"
  23 #include "elogind.h"
  24 #include "fd-util.h"
  25 #include "fileio.h"
  26 #include "fs-util.h"
  27 #include "mount-setup.h"
  28 #include "parse-util.h"
  29 #include "process-util.h"
  30 #include "signal-util.h"
  31 #include "socket-util.h"
  32 #include "stdio-util.h"
  33 #include "string-util.h"
  34 #include "strv.h"
  35 #include "umask-util.h"
  36
  37
  38 #define CGROUPS_AGENT_RCVBUF_SIZE (8*1024*1024)
  39 #ifndef ELOGIND_PID_FILE
  40 #  define ELOGIND_PID_FILE "/run/elogind.pid"
  41 #endif // ELOGIND_PID_FILE
  42
  43
  44 static int elogind_signal_handler(sd_event_source *s,
  45                                    const struct signalfd_siginfo *si,
  46                                    void *userdata) {
  47         Manager *m = userdata;
  48         int r;
  49
  50         log_warning("Received signal %u [%s]", si->ssi_signo,
  51                     signal_to_string(si->ssi_signo));
  52
  53         r = sd_event_get_state(m->event);
  54
  55         if (r != SD_EVENT_FINISHED)
  56                 sd_event_exit(m->event, si->ssi_signo);
  57
  58         return 0;
  59 }
  60
  61
  62 static void remove_pid_file(void) {
  63         if (access(ELOGIND_PID_FILE, F_OK) == 0)
  64                 unlink_noerrno(ELOGIND_PID_FILE);
  65 }
  66
  67
  68 static void write_pid_file(void) {
  69         char c[DECIMAL_STR_MAX(pid_t) + 2];
  70         pid_t pid;
  71         int   r;
  72
  73         pid = getpid();
  74
  75         xsprintf(c, PID_FMT "\n", pid);
  76
  77         r = write_string_file(ELOGIND_PID_FILE, c,
  78                               WRITE_STRING_FILE_CREATE |
  79                               WRITE_STRING_FILE_VERIFY_ON_FAILURE);
  80         if (r < 0)
  81                 log_error_errno(-r, "Failed to write PID file %s: %m",
  82                                 ELOGIND_PID_FILE);
  83
  84         /* Make sure the PID file gets cleaned up on exit! */
  85         atexit(remove_pid_file);
  86 }
  87
  88
  89 /** daemonize elogind by double forking.
  90   * The grand child returns 0.
  91   * The parent and child return their forks PID.
  92   * On error, a value < 0 is returned.
  93 **/
  94 static int elogind_daemonize(void) {
  95         pid_t child;
  96         pid_t grandchild;
  97         pid_t SID;
  98         int r;
  99
 100 #ifdef ENABLE_DEBUG_ELOGIND
 101         log_notice("Double forking elogind");
 102         log_notice("Parent PID     : %5d", getpid());
 103         log_notice("Parent SID     : %5d", getsid(getpid()));
 104 #endif // ENABLE_DEBUG_ELOGIND
 105
 106         child = fork();
 107
 108         if (child < 0)
 109                 return log_error_errno(errno, "Failed to fork: %m");
 110
 111         if (child) {
 112                 /* Wait for the child to terminate, so the decoupling
 113                  * is guaranteed to succeed.
 114                  */
 115                 r = wait_for_terminate_and_warn("elogind control child", child, true);
 116                 if (r < 0)
 117                         return r;
 118                 return child;
 119         }
 120
 121 #ifdef ENABLE_DEBUG_ELOGIND
 122         log_notice("Child PID      : %5d", getpid());
 123         log_notice("Child SID      : %5d", getsid(getpid()));
 124 #endif // ENABLE_DEBUG_ELOGIND
 125
 126         /* The first child has to become a new session leader. */
 127         close_all_fds(NULL, 0);
 128         SID = setsid();
 129         if ((pid_t)-1 == SID)
 130                 return log_error_errno(errno, "Failed to create new SID: %m");
 131
 132 #ifdef ENABLE_DEBUG_ELOGIND
 133         log_notice("Child new SID  : %5d", getsid(getpid()));
 134 #endif // ENABLE_DEBUG_ELOGIND
 135
 136         umask(0022);
 137
 138         /* Now the grandchild, the true daemon, can be created. */
 139         grandchild = fork();
 140
 141         if (grandchild < 0)
 142                 return log_error_errno(errno, "Failed to double fork: %m");
 143
 144         if (grandchild)
 145                 /* Exit immediately! */
 146                 return grandchild;
 147
 148         close_all_fds(NULL, 0);
 149         umask(0022);
 150
 151 #ifdef ENABLE_DEBUG_ELOGIND
 152         log_notice("Grand child PID: %5d", getpid());
 153         log_notice("Grand child SID: %5d", getsid(getpid()));
 154 #endif // ENABLE_DEBUG_ELOGIND
 155
 156         /* Take care of our PID-file now */
 157         write_pid_file();
 158
 159         return 0;
 160 }
 161
 162
 163 /// Simple tool to see, if elogind is already running
 164 static pid_t elogind_is_already_running(bool need_pid_file) {
 165         _cleanup_free_ char *s = NULL;
 166         pid_t pid;
 167         int r;
 168
 169         r = read_one_line_file(ELOGIND_PID_FILE, &s);
 170
 171         if (r < 0)
 172                 goto we_are_alone;
 173
 174         r = safe_atoi32(s, &pid);
 175
 176         if (r < 0)
 177                 goto we_are_alone;
 178
 179         if ( (pid != getpid()) && pid_is_alive(pid))
 180                 return pid;
 181
 182 we_are_alone:
 183
 184         /* Take care of our PID-file now.
 185            If the user is going to fork elogind, the PID file
 186            will be overwritten. */
 187         if (need_pid_file)
 188                 write_pid_file();
 189
 190         return 0;
 191 }
 192
 193
 194 static int manager_dispatch_cgroups_agent_fd(sd_event_source *source, int fd, uint32_t revents, void *userdata) {
 195         Manager *m = userdata;
 196         char buf[PATH_MAX+1];
 197         ssize_t n;
 198
 199         n = recv(fd, buf, sizeof(buf), 0);
 200         if (n < 0)
 201                 return log_error_errno(errno, "Failed to read cgroups agent message: %m");
 202         if (n == 0) {
 203                 log_error("Got zero-length cgroups agent message, ignoring.");
 204                 return 0;
 205         }
 206         if ((size_t) n >= sizeof(buf)) {
 207                 log_error("Got overly long cgroups agent message, ignoring.");
 208                 return 0;
 209         }
 210
 211         if (memchr(buf, 0, n)) {
 212                 log_error("Got cgroups agent message with embedded NUL byte, ignoring.");
 213                 return 0;
 214         }
 215         buf[n] = 0;
 216
 217         manager_notify_cgroup_empty(m, buf);
 218
 219         return 0;
 220 }
 221
 222
 223 /// Add-On for manager_connect_bus()
 224 /// Original: src/core/manager.c:manager_setup_cgroups_agent()
 225 int elogind_setup_cgroups_agent(Manager *m) {
 226
 227         static const union sockaddr_union sa = {
 228                 .un.sun_family = AF_UNIX,
 229                 .un.sun_path = "/run/systemd/cgroups-agent",
 230         };
 231         int r = 0;
 232
 233         /* This creates a listening socket we receive cgroups agent messages on. We do not use D-Bus for delivering
 234          * these messages from the cgroups agent binary to PID 1, as the cgroups agent binary is very short-living, and
 235          * each instance of it needs a new D-Bus connection. Since D-Bus connections are SOCK_STREAM/AF_UNIX, on
 236          * overloaded systems the backlog of the D-Bus socket becomes relevant, as not more than the configured number
 237          * of D-Bus connections may be queued until the kernel will start dropping further incoming connections,
 238          * possibly resulting in lost cgroups agent messages. To avoid this, we'll use a private SOCK_DGRAM/AF_UNIX
 239          * socket, where no backlog is relevant as communication may take place without an actual connect() cycle, and
 240          * we thus won't lose messages.
 241          *
 242          * Note that PID 1 will forward the agent message to system bus, so that the user systemd instance may listen
 243          * to it. The system instance hence listens on this special socket, but the user instances listen on the system
 244          * bus for these messages. */
 245
 246         if (m->test_run)
 247                 return 0;
 248
 249         if (!MANAGER_IS_SYSTEM(m))
 250                 return 0;
 251
 252         r = cg_unified_controller(SYSTEMD_CGROUP_CONTROLLER);
 253         if (r < 0)
 254                 return log_error_errno(r, "Failed to determine whether unified cgroups hierarchy is used: %m");
 255         if (r > 0) /* We don't need this anymore on the unified hierarchy */
 256                 return 0;
 257
 258         if (m->cgroups_agent_fd < 0) {
 259                 _cleanup_close_ int fd = -1;
 260
 261                 /* First free all secondary fields */
 262                 m->cgroups_agent_event_source = sd_event_source_unref(m->cgroups_agent_event_source);
 263
 264                 fd = socket(AF_UNIX, SOCK_DGRAM|SOCK_CLOEXEC|SOCK_NONBLOCK, 0);
 265                 if (fd < 0)
 266                         return log_error_errno(errno, "Failed to allocate cgroups agent socket: %m");
 267
 268                 fd_inc_rcvbuf(fd, CGROUPS_AGENT_RCVBUF_SIZE);
 269
 270                 (void) unlink(sa.un.sun_path);
 271
 272                 /* Only allow root to connect to this socket */
 273                 RUN_WITH_UMASK(0077)
 274                         r = bind(fd, &sa.sa, SOCKADDR_UN_LEN(sa.un));
 275                 if (r < 0)
 276                         return log_error_errno(errno, "bind(%s) failed: %m", sa.un.sun_path);
 277
 278                 m->cgroups_agent_fd = fd;
 279                 fd = -1;
 280         }
 281
 282         if (!m->cgroups_agent_event_source) {
 283                 r = sd_event_add_io(m->event, &m->cgroups_agent_event_source, m->cgroups_agent_fd, EPOLLIN, manager_dispatch_cgroups_agent_fd, m);
 284                 if (r < 0)
 285                         return log_error_errno(r, "Failed to allocate cgroups agent event source: %m");
 286
 287                 /* Process cgroups notifications early, but after having processed service notification messages or
 288                  * SIGCHLD signals, so that a cgroup running empty is always just the last safety net of notification,
 289                  * and we collected the metadata the notification and SIGCHLD stuff offers first. Also see handling of
 290                  * cgroup inotify for the unified cgroup stuff. */
 291                 r = sd_event_source_set_priority(m->cgroups_agent_event_source, SD_EVENT_PRIORITY_NORMAL-5);
 292                 if (r < 0)
 293                         return log_error_errno(r, "Failed to set priority of cgroups agent event source: %m");
 294
 295                 (void) sd_event_source_set_description(m->cgroups_agent_event_source, "manager-cgroups-agent");
 296         }
 297
 298         return 0;
 299 }
 300
 301
 302 /** Extra functionality at startup, exclusive to elogind
 303   * return < 0 on error, exit with failure.
 304   * return = 0 on success, continue normal operation.
 305   * return > 0 if elogind is already running or forked, exit with success.
 306 **/
 307 int elogind_startup(int argc, char *argv[]) {
 308         bool  daemonize = false;
 309         pid_t pid;
 310         int   r         = 0;
 311         bool  show_help = false;
 312         bool  wrong_arg = false;
 313
 314         /* add a -h/--help and a -d/--daemon argument. */
 315         if ( (argc == 2) && argv[1] && strlen(argv[1]) ) {
 316                 if ( streq(argv[1], "-D") || streq(argv[1], "--daemon") )
 317                         daemonize = true;
 318                 else if ( streq(argv[1], "-h") || streq(argv[1], "--help") ) {
 319                         show_help = true;
 320                         r = 1;
 321                 } else
 322                         wrong_arg = true;
 323         } else if (argc > 2)
 324                 wrong_arg = true;
 325
 326         /* Note: At this point, the logging is not initialized, so we can not
 327                  use log_debug_elogind(). */
 328 #ifdef ENABLE_DEBUG_ELOGIND
 329         log_notice("elogind startup: Daemonize: %s, Show Help: %s, Wrong arg: %s",
 330                 daemonize ? "True" : "False",
 331                 show_help ? "True" : "False",
 332                 wrong_arg ? "True" : "False");
 333 #endif // ENABLE_DEBUG_ELOGIND
 334
 335         /* try to get some meaningful output in case of an error */
 336         if (wrong_arg) {
 337                 log_error("Unknown arguments");
 338                 show_help = true;
 339                 r = -EINVAL;
 340         }
 341         if (show_help) {
 342                 log_info("%s [<-D|--daemon>|<-h|--help>]", basename(argv[0]));
 343                 return r;
 344         }
 345
 346         /* Do not continue if elogind is already running */
 347         pid = elogind_is_already_running(!daemonize);
 348         if (pid) {
 349                 log_error("elogind is already running as PID " PID_FMT, pid);
 350                 return pid;
 351         }
 352
 353         /* elogind allows to be daemonized using one argument "-D" / "--daemon" */
 354         if (daemonize)
 355                 r = elogind_daemonize();
 356
 357         return r;
 358 }
 359
 360
 361 /// Add-On for manager_free()
 362 void elogind_manager_free(Manager* m) {
 363
 364         manager_shutdown_cgroup(m, true);
 365
 366         sd_event_source_unref(m->cgroups_agent_event_source);
 367
 368         safe_close(m->cgroups_agent_fd);
 369
 370         strv_free(m->suspend_mode);
 371         strv_free(m->suspend_state);
 372         strv_free(m->hibernate_mode);
 373         strv_free(m->hibernate_state);
 374         strv_free(m->hybrid_sleep_mode);
 375         strv_free(m->hybrid_sleep_state);
 376 }
 377
 378
 379 /// Add-On for manager_new()
 380 int elogind_manager_new(Manager* m) {
 381         int r = 0;
 382
 383         m->cgroups_agent_fd = -1;
 384         m->pin_cgroupfs_fd  = -1;
 385         m->test_run         = false;
 386
 387         /* Init sleep modes and states */
 388         m->suspend_mode       = NULL;
 389         m->suspend_state      = NULL;
 390         m->hibernate_mode     = NULL;
 391         m->hibernate_state    = NULL;
 392         m->hybrid_sleep_mode  = NULL;
 393         m->hybrid_sleep_state = NULL;
 394
 395         /* If elogind should be its own controller, mount its cgroup */
 396         if (streq(SYSTEMD_CGROUP_CONTROLLER, "_elogind")) {
 397                 m->is_system = true;
 398                 r = mount_setup(true);
 399         } else
 400                 m->is_system = false;
 401
 402         /* Make cgroups */
 403         if (r > -1)
 404                 r = manager_setup_cgroup(m);
 405
 406         return r;
 407 }
 408
 409
 410 /// Add-On for manager_reset_config()
 411 void elogind_manager_reset_config(Manager* m) {
 412
 413 #ifdef ENABLE_DEBUG_ELOGIND
 414         int dbg_cnt;
 415 #endif // ENABLE_DEBUG_ELOGIND
 416
 417         /* Set default Sleep config if not already set by logind.conf */
 418         if (!m->suspend_state)
 419                 m->suspend_state = strv_new("mem", "standby", "freeze", NULL);
 420         if (!m->hibernate_mode)
 421                 m->hibernate_mode = strv_new("platform", "shutdown", NULL);
 422         if (!m->hibernate_state)
 423                 m->hibernate_state = strv_new("disk", NULL);
 424         if (!m->hybrid_sleep_mode)
 425                 m->hybrid_sleep_mode = strv_new("suspend", "platform", "shutdown", NULL);
 426         if (!m->hybrid_sleep_state)
 427                 m->hybrid_sleep_state = strv_new("disk", NULL);
 428
 429 #ifdef ENABLE_DEBUG_ELOGIND
 430         dbg_cnt = -1;
 431         while (m->suspend_mode && m->suspend_mode[++dbg_cnt])
 432                 log_debug_elogind("suspend_mode[%d] = %s",
 433                                   dbg_cnt, m->suspend_mode[dbg_cnt]);
 434         dbg_cnt = -1;
 435         while (m->suspend_state[++dbg_cnt])
 436                 log_debug_elogind("suspend_state[%d] = %s",
 437                                   dbg_cnt, m->suspend_state[dbg_cnt]);
 438         dbg_cnt = -1;
 439         while (m->hibernate_mode[++dbg_cnt])
 440                 log_debug_elogind("hibernate_mode[%d] = %s",
 441                                   dbg_cnt, m->hibernate_mode[dbg_cnt]);
 442         dbg_cnt = -1;
 443         while (m->hibernate_state[++dbg_cnt])
 444                 log_debug_elogind("hibernate_state[%d] = %s",
 445                                   dbg_cnt, m->hibernate_state[dbg_cnt]);
 446         dbg_cnt = -1;
 447         while (m->hybrid_sleep_mode[++dbg_cnt])
 448                 log_debug_elogind("hybrid_sleep_mode[%d] = %s",
 449                                   dbg_cnt, m->hybrid_sleep_mode[dbg_cnt]);
 450         dbg_cnt = -1;
 451         while (m->hybrid_sleep_state[++dbg_cnt])
 452                 log_debug_elogind("hybrid_sleep_state[%d] = %s",
 453                                   dbg_cnt, m->hybrid_sleep_state[dbg_cnt]);
 454 #endif // ENABLE_DEBUG_ELOGIND
 455 }
 456
 457
 458 /// Add-On for manager_startup()
 459 int elogind_manager_startup(Manager *m) {
 460         int r;
 461
 462         assert(m);
 463
 464         assert_se(sigprocmask_many(SIG_SETMASK, NULL, SIGINT, -1) >= 0);
 465         r = sd_event_add_signal(m->event, NULL, SIGINT, elogind_signal_handler, m);
 466         if (r < 0)
 467                 return log_error_errno(r, "Failed to register SIGINT handler: %m");
 468
 469         assert_se(sigprocmask_many(SIG_SETMASK, NULL, SIGQUIT, -1) >= 0);
 470         r = sd_event_add_signal(m->event, NULL, SIGQUIT, elogind_signal_handler, m);
 471         if (r < 0)
 472                 return log_error_errno(r, "Failed to register SIGQUIT handler: %m");
 473
 474         assert_se(sigprocmask_many(SIG_SETMASK, NULL, SIGTERM, -1) >= 0);
 475         r = sd_event_add_signal(m->event, NULL, SIGTERM, elogind_signal_handler, m);
 476         if (r < 0)
 477                 return log_error_errno(r, "Failed to register SIGTERM handler: %m");
 478
 479         return 0;
 480 }