src/login/logind.h

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