1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
4 This file is part of systemd.
6 Copyright 2015 Canonical
9 Didier Roche <didrocks@ubuntu.com>
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.
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.
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/>.
32 #include <sys/socket.h>
33 #include <sys/types.h>
39 #include "event-util.h"
44 #include "sd-daemon.h"
45 #include "socket-util.h"
48 #define IDLE_TIME_SECONDS 30
49 #define PLYMOUTH_REQUEST_KEY "K\2\2\3"
53 typedef struct Client {
54 struct Manager *manager;
64 LIST_FIELDS(struct Client, clients);
67 typedef struct Manager {
76 bool plymouth_cancel_sent;
77 bool cancel_requested;
80 static int connect_plymouth(Manager *m);
81 static int update_global_progress(Manager *m);
82 static void manager_free(Manager *m);
83 DEFINE_TRIVIAL_CLEANUP_FUNC(Manager*, manager_free);
84 #define _cleanup_manager_free_ _cleanup_(manager_freep)
86 static double compute_percent(int pass, size_t cur, size_t max) {
87 /* Values stolen from e2fsck */
89 static const double pass_table[] = {
90 0, 70, 90, 92, 95, 100
96 if ((unsigned) pass >= ELEMENTSOF(pass_table) || max == 0)
99 return pass_table[pass-1] +
100 (pass_table[pass] - pass_table[pass-1]) *
104 static int request_cancel_client(Client *current) {
105 FsckdMessage cancel_msg;
107 cancel_msg.cancel = 1;
109 n = send(current->fd, &cancel_msg, sizeof(FsckdMessage), 0);
110 if (n < 0 || (size_t) n < sizeof(FsckdMessage))
111 return log_warning_errno(n, "Cannot send cancel to fsck on (%u, %u): %m",
112 major(current->devnum), minor(current->devnum));
114 current->cancelled = true;
118 static void remove_client(Client **first, Client *item) {
119 LIST_REMOVE(clients, *first, item);
120 safe_close(item->fd);
124 static void on_plymouth_disconnect(Manager *m) {
125 m->plymouth_fd = safe_close(m->plymouth_fd);
126 m->plymouth_cancel_sent = false;
129 static int plymouth_feedback_handler(sd_event_source *s, int fd, uint32_t revents, void *userdata) {
130 Manager *m = userdata;
137 r = read(m->plymouth_fd, buffer, sizeof(buffer));
139 on_plymouth_disconnect(m);
141 if (buffer[0] == '\15')
142 log_error("Message update to plymouth wasn't delivered successfully");
144 /* the only answer support type we requested is a key interruption */
145 if (buffer[0] == '\2' && buffer[5] == '\3') {
146 m->cancel_requested = true;
147 /* cancel all connected clients */
148 LIST_FOREACH(clients, current, m->clients)
149 request_cancel_client(current);
156 static int send_message_plymouth_socket(int plymouth_fd, const char *message, bool update) {
157 _cleanup_free_ char *packet = NULL;
164 if (asprintf(&packet, "%c\002%c%s%n", mode, (int) (strlen(message) + 1), message, &n) < 0)
166 r = loop_write(plymouth_fd, packet, n + 1, true);
171 static int send_message_plymouth(Manager *m, const char *message) {
173 const char *plymouth_cancel_message = NULL;
175 r = connect_plymouth(m);
179 if (!m->plymouth_cancel_sent) {
180 /* indicate to plymouth that we listen to Ctrl+C */
181 r = loop_write(m->plymouth_fd, PLYMOUTH_REQUEST_KEY, sizeof(PLYMOUTH_REQUEST_KEY), true);
183 return log_warning_errno(errno, "Can't send to plymouth cancel key: %m");
184 m->plymouth_cancel_sent = true;
185 plymouth_cancel_message = strjoina("fsckd-cancel-msg:", _("Press Ctrl+C to cancel all filesystem checks in progress"));
186 r = send_message_plymouth_socket(m->plymouth_fd, plymouth_cancel_message, false);
188 log_warning_errno(r, "Can't send filesystem cancel message to plymouth: %m");
189 } else if (m->numdevices == 0) {
190 m->plymouth_cancel_sent = false;
191 r = send_message_plymouth_socket(m->plymouth_fd, "", false);
193 log_warning_errno(r, "Can't clear plymouth filesystem cancel message: %m");
196 r = send_message_plymouth_socket(m->plymouth_fd, message, true);
198 return log_warning_errno(errno, "Couldn't send \"%s\" to plymouth: %m", message);
203 static int update_global_progress(Manager *m) {
204 Client *current = NULL;
205 _cleanup_free_ char *console_message = NULL;
206 _cleanup_free_ char *fsck_message = NULL;
207 int current_numdevices = 0, l = 0, r;
208 double current_percent = 100;
210 /* get the overall percentage */
211 LIST_FOREACH(clients, current, m->clients) {
212 current_numdevices++;
214 /* right now, we only keep the minimum % of all fsckd processes. We could in the future trying to be
215 linear, but max changes and corresponds to the pass. We have all the informations into fsckd
216 already if we can treat that in a smarter way. */
217 current_percent = MIN(current_percent, current->percent);
220 /* update if there is anything user-visible to update */
221 if (fabs(current_percent - m->percent) > 0.001 || current_numdevices != m->numdevices) {
222 m->numdevices = current_numdevices;
223 m->percent = current_percent;
225 if (asprintf(&console_message,
226 ngettext("Checking in progress on %d disk (%3.1f%% complete)",
227 "Checking in progress on %d disks (%3.1f%% complete)", m->numdevices),
228 m->numdevices, m->percent) < 0)
230 if (asprintf(&fsck_message, "fsckd:%d:%3.1f:%s", m->numdevices, m->percent, console_message) < 0)
233 /* write to console */
235 fprintf(m->console, "\r%s\r%n", console_message, &l);
239 /* try to connect to plymouth and send message */
240 r = send_message_plymouth(m, fsck_message);
242 log_debug("Couldn't send message to plymouth");
250 static int connect_plymouth(Manager *m) {
251 union sockaddr_union sa = PLYMOUTH_SOCKET;
254 /* try to connect or reconnect if sending a message */
255 if (m->plymouth_fd <= 0) {
256 m->plymouth_fd = socket(AF_UNIX, SOCK_STREAM|SOCK_CLOEXEC, 0);
257 if (m->plymouth_fd < 0) {
258 return log_warning_errno(errno, "Connection to plymouth socket failed: %m");
260 if (connect(m->plymouth_fd, &sa.sa, offsetof(struct sockaddr_un, sun_path) + 1 + strlen(sa.un.sun_path+1)) < 0) {
261 on_plymouth_disconnect(m);
262 return log_warning_errno(errno, "Couldn't connect to plymouth: %m");
264 r = sd_event_add_io(m->event, NULL, m->plymouth_fd, EPOLLIN, plymouth_feedback_handler, m);
266 on_plymouth_disconnect(m);
267 return log_warning_errno(r, "Can't listen to plymouth socket: %m");
274 static int progress_handler(sd_event_source *s, int fd, uint32_t revents, void *userdata) {
275 Client *client = userdata;
277 FsckProgress fsck_data;
284 /* check first if we need to cancel this client */
285 if (m->cancel_requested) {
286 if (!client->cancelled)
287 request_cancel_client(client);
290 /* ensure we have enough data to read */
291 r = ioctl(fd, FIONREAD, &buflen);
292 if (r == 0 && buflen != 0 && (size_t) buflen < sizeof(FsckProgress)) {
293 if (client->buflen != buflen)
294 client->buflen = buflen;
295 /* we got twice the same size from a bad behaving client, kick it off the list */
297 log_warning("Closing bad behaving fsck client connection at fd %d", client->fd);
298 remove_client(&(m->clients), client);
299 r = update_global_progress(m);
301 log_warning_errno(r, "Couldn't update global progress: %m");
306 /* read actual data */
307 r = recv(fd, &fsck_data, sizeof(FsckProgress), 0);
309 log_debug("Fsck client connected to fd %d disconnected", client->fd);
310 remove_client(&(m->clients), client);
311 } else if (r > 0 && r != sizeof(FsckProgress))
312 log_warning("Unexpected data structure sent to fsckd socket from fd: %d. Ignoring", client->fd);
313 else if (r > 0 && r == sizeof(FsckProgress)) {
314 client->devnum = fsck_data.devnum;
315 client->cur = fsck_data.cur;
316 client->max = fsck_data.max;
317 client->pass = fsck_data.pass;
318 client->percent = compute_percent(client->pass, client->cur, client->max);
319 log_debug("Getting progress for %u:%u (%lu, %lu, %d) : %3.1f%%",
320 major(client->devnum), minor(client->devnum),
321 client->cur, client->max, client->pass, client->percent);
323 log_error_errno(r, "Unknown error while trying to read fsck data: %m");
325 r = update_global_progress(m);
327 log_warning_errno(r, "Couldn't update global progress: %m");
332 static int new_connection_handler(sd_event_source *s, int fd, uint32_t revents, void *userdata) {
333 Manager *m = userdata;
334 Client *client = NULL;
335 int new_client_fd, r;
339 /* Initialize and list new clients */
340 new_client_fd = accept4(m->connection_fd, NULL, NULL, SOCK_CLOEXEC);
341 if (new_client_fd > 0) {
342 log_debug("New fsck client connected to fd: %d", new_client_fd);
343 client = new0(Client, 1);
346 client->fd = new_client_fd;
348 LIST_PREPEND(clients, m->clients, client);
349 r = sd_event_add_io(m->event, NULL, client->fd, EPOLLIN, progress_handler, client);
351 remove_client(&(m->clients), client);
354 /* only request the client to cancel now in case the request is dropped by the client (chance to recancel) */
355 if (m->cancel_requested)
356 request_cancel_client(client);
358 return log_error_errno(errno, "Couldn't accept a new connection: %m");
363 static void manager_free(Manager *m) {
364 Client *current = NULL, *l = NULL;
368 /* clear last line */
369 if (m->console && m->clear > 0) {
372 fputc('\r', m->console);
373 for (j = 0; j < (unsigned) m->clear; j++)
374 fputc(' ', m->console);
375 fputc('\r', m->console);
379 safe_close(m->connection_fd);
380 safe_close(m->plymouth_fd);
384 LIST_FOREACH_SAFE(clients, current, l, m->clients)
385 remove_client(&(m->clients), current);
387 sd_event_unref(m->event);
392 static int manager_new(Manager **ret, int fd) {
393 _cleanup_manager_free_ Manager *m = NULL;
398 m = new0(Manager, 1);
402 r = sd_event_default(&m->event);
406 m->connection_fd = fd;
407 if (access("/run/systemd/show-status", F_OK) >= 0) {
408 m->console = fopen("/dev/console", "we");
410 return log_warning_errno(errno, "Can't connect to /dev/console: %m");
421 static int run_event_loop_with_timeout(sd_event *e, usec_t timeout) {
427 r = sd_event_get_state(e);
430 if (r == SD_EVENT_FINISHED)
433 r = sd_event_run(e, timeout);
437 /* timeout reached */
444 r = sd_event_get_exit_code(e, &code);
451 static void help(void) {
452 printf("%s [OPTIONS...]\n\n"
453 "Capture fsck progress and forward one stream to plymouth\n\n"
454 " -h --help Show this help\n"
455 " --version Show package version\n",
456 program_invocation_short_name);
459 static int parse_argv(int argc, char *argv[]) {
466 static const struct option options[] = {
467 { "help", no_argument, NULL, 'h' },
468 { "version", no_argument, NULL, ARG_VERSION },
477 while ((c = getopt_long(argc, argv, "hv", options, NULL)) >= 0)
485 puts(PACKAGE_STRING);
486 puts(SYSTEMD_FEATURES);
493 assert_not_reached("Unhandled option");
497 log_error("Extraneous arguments");
504 int main(int argc, char *argv[]) {
505 _cleanup_manager_free_ Manager *m = NULL;
509 log_set_target(LOG_TARGET_AUTO);
510 log_parse_environment();
514 r = parse_argv(argc, argv);
516 return r < 0 ? EXIT_FAILURE : EXIT_SUCCESS;
518 n = sd_listen_fds(0);
520 log_error("Too many file descriptors received.");
523 fd = SD_LISTEN_FDS_START + 0;
525 fd = make_socket_fd(LOG_DEBUG, FSCKD_SOCKET_PATH, SOCK_STREAM | SOCK_CLOEXEC);
527 log_error_errno(r, "Couldn't create listening socket fd on %s: %m", FSCKD_SOCKET_PATH);
532 r = manager_new(&m, fd);
534 log_error_errno(r, "Failed to allocate manager: %m");
538 r = sd_event_add_io(m->event, NULL, fd, EPOLLIN, new_connection_handler, m);
540 log_error_errno(r, "Can't listen to connection socket: %m");
544 r = run_event_loop_with_timeout(m->event, IDLE_TIME_SECONDS * USEC_PER_SEC);
546 log_error_errno(r, "Failed to run event loop: %m");
550 sd_event_get_exit_code(m->event, &r);
552 return r < 0 ? EXIT_FAILURE : EXIT_SUCCESS;