src/login/logind.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   Copyright 2011 Lennart Poettering
   6 ***/
   7
   8 #include <stdbool.h>
   9
  10 #if 0 /// elogind needs the systems udev header
  11 #include "libudev.h"
  12 #else
  13 #include <libudev.h>
  14 #endif // 0
  15 #include "sd-bus.h"
  16 #include "sd-event.h"
  17
  18 //#include "conf-parser.h"
  19 #include "hashmap.h"
  20 #include "list.h"
  21 #include "set.h"
  22
  23 typedef struct Manager Manager;
  24
  25 #include "logind-action.h"
  26 #include "logind-button.h"
  27 #include "logind-device.h"
  28 #include "logind-inhibit.h"
  29
  30 /// Additional includes needed by elogind
  31 #include "cgroup-util.h"
  32
  33 #if 1 /// elogind has to ident itself
  34 #define MANAGER_IS_SYSTEM(m) ((m)->is_system)
  35 #define MANAGER_IS_USER(m) (!((m)->is_system))
  36 #endif // 1
  37 struct Manager {
  38         sd_event *event;
  39         sd_bus *bus;
  40
  41         Hashmap *devices;
  42         Hashmap *seats;
  43         Hashmap *sessions;
  44         Hashmap *users;
  45         Hashmap *inhibitors;
  46         Hashmap *buttons;
  47
  48         LIST_HEAD(Seat, seat_gc_queue);
  49         LIST_HEAD(Session, session_gc_queue);
  50         LIST_HEAD(User, user_gc_queue);
  51
  52         struct udev *udev;
  53         struct udev_monitor *udev_seat_monitor, *udev_device_monitor, *udev_vcsa_monitor, *udev_button_monitor;
  54
  55         sd_event_source *console_active_event_source;
  56         sd_event_source *udev_seat_event_source;
  57         sd_event_source *udev_device_event_source;
  58         sd_event_source *udev_vcsa_event_source;
  59         sd_event_source *udev_button_event_source;
  60
  61 #if 0 /// elogind does not support autospawning of vts
  62         int console_active_fd;
  63
  64         unsigned n_autovts;
  65
  66         unsigned reserve_vt;
  67         int reserve_vt_fd;
  68 #else
  69         /* Make sure the user cannot accidentally unmount our cgroup
  70          * file system */
  71         int pin_cgroupfs_fd;
  72
  73         /* fd for handling cgroup socket if elogind is its own cgroups manager */
  74         int cgroups_agent_fd;
  75         sd_event_source *cgroups_agent_event_source;
  76
  77         /* Flags */
  78         unsigned test_run_flags;
  79         bool is_system:1; /* true if elogind is its own cgroups manager */
  80
  81         /* Data specific to the cgroup subsystem */
  82         CGroupMask cgroup_supported;
  83         char *cgroup_root;
  84
  85         int console_active_fd;
  86 #endif // 0
  87
  88         Seat *seat0;
  89
  90         char **kill_only_users, **kill_exclude_users;
  91         bool kill_user_processes;
  92
  93         unsigned long session_counter;
  94         unsigned long inhibit_counter;
  95
  96         Hashmap *session_units;
  97         Hashmap *user_units;
  98
  99         usec_t inhibit_delay_max;
 100
 101         /* If an action is currently being executed or is delayed,
 102          * this is != 0 and encodes what is being done */
 103         InhibitWhat action_what;
 104
 105 #if 0 /// elogind does all relevant actions on its own. No systemd jobs and units.
 106         /* If a shutdown/suspend was delayed due to a inhibitor this
 107            contains the unit name we are supposed to start after the
 108            delay is over */
 109         const char *action_unit;
 110
 111         /* If a shutdown/suspend is currently executed, then this is
 112          * the job of it */
 113         char *action_job;
 114 #else
 115         /* If a shutdown/suspend was delayed due to a inhibitor this
 116            contains the action we are supposed to perform after the
 117            delay is over */
 118         HandleAction pending_action;
 119
 120         char **suspend_state,      **suspend_mode;
 121         char **hibernate_state,    **hibernate_mode;
 122         char **hybrid_sleep_state, **hybrid_sleep_mode;
 123
 124 #endif // 0
 125         sd_event_source *inhibit_timeout_source;
 126
 127         char *scheduled_shutdown_type;
 128         usec_t scheduled_shutdown_timeout;
 129         sd_event_source *scheduled_shutdown_timeout_source;
 130         uid_t scheduled_shutdown_uid;
 131         char *scheduled_shutdown_tty;
 132         sd_event_source *nologin_timeout_source;
 133         bool unlink_nologin;
 134
 135         char *wall_message;
 136         unsigned enable_wall_messages;
 137         sd_event_source *wall_message_timeout_source;
 138
 139         bool shutdown_dry_run;
 140
 141         sd_event_source *idle_action_event_source;
 142         usec_t idle_action_usec;
 143         usec_t idle_action_not_before_usec;
 144         HandleAction idle_action;
 145
 146         HandleAction handle_power_key;
 147         HandleAction handle_suspend_key;
 148         HandleAction handle_hibernate_key;
 149         HandleAction handle_lid_switch;
 150         HandleAction handle_lid_switch_ep;
 151         HandleAction handle_lid_switch_docked;
 152
 153         bool power_key_ignore_inhibited;
 154         bool suspend_key_ignore_inhibited;
 155         bool hibernate_key_ignore_inhibited;
 156         bool lid_switch_ignore_inhibited;
 157
 158         bool remove_ipc;
 159
 160         Hashmap *polkit_registry;
 161
 162         usec_t holdoff_timeout_usec;
 163         sd_event_source *lid_switch_ignore_event_source;
 164
 165         uint64_t runtime_dir_size;
 166         uint64_t user_tasks_max;
 167         uint64_t sessions_max;
 168         uint64_t inhibitors_max;
 169 };
 170
 171 void manager_reset_config(Manager *m);
 172 int manager_parse_config_file(Manager *m);
 173
 174 int manager_add_device(Manager *m, const char *sysfs, bool master, Device **_device);
 175 int manager_add_button(Manager *m, const char *name, Button **_button);
 176 int manager_add_seat(Manager *m, const char *id, Seat **_seat);
 177 int manager_add_session(Manager *m, const char *id, Session **_session);
 178 int manager_add_user(Manager *m, uid_t uid, gid_t gid, const char *name, User **_user);
 179 int manager_add_user_by_name(Manager *m, const char *name, User **_user);
 180 int manager_add_user_by_uid(Manager *m, uid_t uid, User **_user);
 181 int manager_add_inhibitor(Manager *m, const char* id, Inhibitor **_inhibitor);
 182
 183 int manager_process_seat_device(Manager *m, struct udev_device *d);
 184 int manager_process_button_device(Manager *m, struct udev_device *d);
 185
 186 #if 0 /// UNNEEDED by elogind
 187 int manager_spawn_autovt(Manager *m, unsigned int vtnr);
 188 #endif // 0
 189
 190 bool manager_shall_kill(Manager *m, const char *user);
 191
 192 int manager_get_idle_hint(Manager *m, dual_timestamp *t);
 193
 194 int manager_get_user_by_pid(Manager *m, pid_t pid, User **user);
 195 int manager_get_session_by_pid(Manager *m, pid_t pid, Session **session);
 196
 197 bool manager_is_docked_or_external_displays(Manager *m);
 198 bool manager_is_on_external_power(void);
 199 bool manager_all_buttons_ignored(Manager *m);
 200
 201 extern const sd_bus_vtable manager_vtable[];
 202
 203 #if 0 /// UNNEEDED by elogind
 204 int match_job_removed(sd_bus_message *message, void *userdata, sd_bus_error *error);
 205 int match_unit_removed(sd_bus_message *message, void *userdata, sd_bus_error *error);
 206 int match_properties_changed(sd_bus_message *message, void *userdata, sd_bus_error *error);
 207 int match_reloading(sd_bus_message *message, void *userdata, sd_bus_error *error);
 208 int match_name_owner_changed(sd_bus_message *message, void *userdata, sd_bus_error *error);
 209
 210 int bus_manager_shutdown_or_sleep_now_or_later(Manager *m, const char *unit_name, InhibitWhat w, sd_bus_error *error);
 211 #else
 212 /// eloginds own version does the action itself
 213 int bus_manager_shutdown_or_sleep_now_or_later(Manager *m, HandleAction action, InhibitWhat w, sd_bus_error *error);
 214 #endif // 0
 215
 216 int manager_send_changed(Manager *manager, const char *property, ...) _sentinel_;
 217
 218 #if 0 /// UNNEEDED by elogind
 219 int manager_start_scope(Manager *manager, const char *scope, pid_t pid, const char *slice, const char *description, const char *after, const char *after2, sd_bus_message *more_properties, sd_bus_error *error, char **job);
 220 int manager_start_unit(Manager *manager, const char *unit, sd_bus_error *error, char **job);
 221 int manager_stop_unit(Manager *manager, const char *unit, sd_bus_error *error, char **job);
 222 int manager_abandon_scope(Manager *manager, const char *scope, sd_bus_error *error);
 223 int manager_kill_unit(Manager *manager, const char *unit, KillWho who, int signo, sd_bus_error *error);
 224 int manager_unit_is_active(Manager *manager, const char *unit);
 225 int manager_job_is_active(Manager *manager, const char *path);
 226 #endif // 0
 227
 228 /* gperf lookup function */
 229 const struct ConfigPerfItem* logind_gperf_lookup(const char *key, GPERF_LEN_TYPE length);
 230
 231 int manager_set_lid_switch_ignore(Manager *m, usec_t until);
 232
 233 CONFIG_PARSER_PROTOTYPE(config_parse_n_autovts);
 234 CONFIG_PARSER_PROTOTYPE(config_parse_tmpfs_size);
 235
 236 int manager_get_session_from_creds(Manager *m, sd_bus_message *message, const char *name, sd_bus_error *error, Session **ret);
 237 int manager_get_user_from_creds(Manager *m, sd_bus_message *message, uid_t uid, sd_bus_error *error, User **ret);
 238 int manager_get_seat_from_creds(Manager *m, sd_bus_message *message, const char *name, sd_bus_error *error, Seat **ret);
 239
 240 int manager_setup_wall_message_timer(Manager *m);
 241 bool logind_wall_tty_filter(const char *tty, void *userdata);
 242
 243 int manager_dispatch_delayed(Manager *manager, bool timeout);