chiark / gitweb /
sd-network: fix parameter order for sd_network_monitor_new()
[elogind.git] / src / systemd / sd-shutdown.h
1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
2
3 #ifndef foosdshutdownhfoo
4 #define foosdshutdownhfoo
5
6 /***
7   This file is part of systemd.
8
9   Copyright 2010 Lennart Poettering
10
11   systemd is free software; you can redistribute it and/or modify it
12   under the terms of the GNU Lesser General Public License as published by
13   the Free Software Foundation; either version 2.1 of the License, or
14   (at your option) any later version.
15
16   systemd is distributed in the hope that it will be useful, but
17   WITHOUT ANY WARRANTY; without even the implied warranty of
18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19   Lesser General Public License for more details.
20
21   You should have received a copy of the GNU Lesser General Public License
22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
23 ***/
24
25 /* Interface for scheduling and cancelling timed shutdowns. */
26
27 #include <inttypes.h>
28
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32
33 #ifndef _sd_packed_
34 #  define _sd_packed_ __attribute__((packed))
35 #endif
36
37 typedef enum sd_shutdown_mode {
38         SD_SHUTDOWN_NONE = 0,
39         SD_SHUTDOWN_REBOOT = 'r',
40         SD_SHUTDOWN_POWEROFF = 'P',
41         SD_SHUTDOWN_HALT = 'H',
42         SD_SHUTDOWN_KEXEC = 'K'
43 } sd_shutdown_mode_t;
44
45 /* Calculate the size of the message as "offsetof(struct
46  * sd_shutdown_command, wall_message) +
47  * strlen(command.wall_message)" */
48 struct sd_shutdown_command {
49         /* Microseconds after the epoch 1970 UTC */
50         uint64_t usec;
51
52         /* H, P, r, i.e. the switches usually passed to
53          * /usr/bin/shutdown to select whether to halt, power-off or
54          * reboot the machine */
55         sd_shutdown_mode_t mode:8;
56
57         /* If non-zero, don't actually shut down, just pretend */
58         unsigned dry_run:1;
59
60         /* If non-zero, send our wall message */
61         unsigned warn_wall:1;
62
63         /* The wall message to send around. Leave empty for the
64          * default wall message */
65         char wall_message[];
66 } _sd_packed_;
67
68 /* The scheme is very simple:
69  *
70  * To schedule a shutdown, simply fill in and send a single
71  * AF_UNIX/SOCK_DGRAM datagram with the structure above suffixed with
72  * the wall message to the socket /run/systemd/shutdownd (leave an
73  * empty wall message for the default shutdown message). To calculate
74  * the size of the message, use "offsetof(struct sd_shutdown_command,
75  * wall_message) + strlen(command.wall_message)".
76  *
77  * To cancel a shutdown, do the same, but send a fully zeroed-out
78  * structure.
79  *
80  * To be notified about scheduled shutdowns, create an inotify watch
81  * on /run/shutdown/. Whenever a file called "scheduled" appears, a
82  * shutdown is scheduled. If it is removed, it is canceled. If it is
83  * replaced, the scheduled shutdown has been changed. The file contains
84  * a simple, environment-like block that contains information about
85  * the scheduled shutdown:
86  *
87  * USEC=
88  * encodes the time for the shutdown in usecs since the epoch UTC,
89  * formatted as a numeric string.
90  *
91  * WARN_WALL=
92  * is 1 if a wall message shall be sent
93  *
94  * DRY_RUN=
95  * is 1 if a dry-run shutdown is scheduled
96  *
97  * MODE=
98  * is the shutdown mode, one of "poweroff", "reboot", "halt", "kexec"
99  *
100  * WALL_MESSAGE=
101  * is the wall message to use, with all special characters escaped in C-style.
102  *
103  * Note that some fields might be missing if they do not apply.
104  *
105  * Note that the file is first written to a temporary file and then
106  * renamed, in order to provide atomic properties for readers: if the
107  * file exists under the name "scheduled", it is guaranteed to be fully
108  * written. A reader should ignore all files in that directory by any
109  * other name.
110  *
111  * Scheduled shutdowns are only accepted from privileged processes,
112  * but anyone may watch the directory and the file in it.
113  */
114
115 #ifdef __cplusplus
116 }
117 #endif
118
119 #endif