2 * uuidd.c --- UUID-generation daemon
4 * Copyright (C) 2007 Theodore Ts'o
7 * This file may be redistributed under the terms of the GNU Public
17 #include <sys/types.h>
19 #include <sys/socket.h>
25 #include <sys/signalfd.h>
32 #include "closestream.h"
35 #include "monotonic.h"
38 #ifdef HAVE_LIBSYSTEMD
39 # include <systemd/sd-daemon.h>
44 /* length of textual representation of UUID, including trailing \0 */
45 #define UUID_STR_LEN 37
47 /* length of binary representation of UUID */
48 #define UUID_LEN (sizeof(uuid_t))
50 /* server loop control structure */
52 const char *cleanup_pidfile
;
53 const char *cleanup_socket
;
55 unsigned int debug
: 1,
61 static void __attribute__ ((__noreturn__
)) usage(FILE * out
)
63 fputs(USAGE_HEADER
, out
);
64 fprintf(out
, _(" %s [options]\n"), program_invocation_short_name
);
65 fputs(USAGE_SEPARATOR
, out
);
66 fputs(_("A daemon for generating UUIDs.\n"), out
);
67 fputs(USAGE_OPTIONS
, out
);
68 fputs(_(" -p, --pid <path> path to pid file\n"), out
);
69 fputs(_(" -s, --socket <path> path to socket\n"), out
);
70 fputs(_(" -T, --timeout <sec> specify inactivity timeout\n"), out
);
71 fputs(_(" -k, --kill kill running daemon\n"), out
);
72 fputs(_(" -r, --random test random-based generation\n"), out
);
73 fputs(_(" -t, --time test time-based generation\n"), out
);
74 fputs(_(" -n, --uuids <num> request number of uuids\n"), out
);
75 fputs(_(" -P, --no-pid do not create pid file\n"), out
);
76 fputs(_(" -F, --no-fork do not daemonize using double-fork\n"), out
);
77 fputs(_(" -S, --socket-activation do not create listening socket\n"), out
);
78 fputs(_(" -d, --debug run in debugging mode\n"), out
);
79 fputs(_(" -q, --quiet turn on quiet mode\n"), out
);
80 fputs(USAGE_SEPARATOR
, out
);
81 fputs(USAGE_HELP
, out
);
82 fputs(USAGE_VERSION
, out
);
83 fprintf(out
, USAGE_MAN_TAIL("uuidd(8)"));
84 exit(out
== stderr
? EXIT_FAILURE
: EXIT_SUCCESS
);
87 static void create_daemon(void)
92 err(EXIT_FAILURE
, "daemon");
95 if (setreuid(euid
, euid
) < 0)
96 err(EXIT_FAILURE
, "setreuid");
99 static int call_daemon(const char *socket_path
, int op
, char *buf
,
100 size_t buflen
, int *num
, const char **err_context
)
106 int32_t reply_len
= 0;
107 struct sockaddr_un srv_addr
;
109 if (((op
== UUIDD_OP_BULK_TIME_UUID
) ||
110 (op
== UUIDD_OP_BULK_RANDOM_UUID
)) && !num
) {
112 *err_context
= _("bad arguments");
117 if ((s
= socket(AF_UNIX
, SOCK_STREAM
, 0)) < 0) {
119 *err_context
= _("socket");
123 srv_addr
.sun_family
= AF_UNIX
;
124 strncpy(srv_addr
.sun_path
, socket_path
, sizeof(srv_addr
.sun_path
));
125 srv_addr
.sun_path
[sizeof(srv_addr
.sun_path
) - 1] = '\0';
127 if (connect(s
, (const struct sockaddr
*) &srv_addr
,
128 sizeof(struct sockaddr_un
)) < 0) {
130 *err_context
= _("connect");
135 if (op
== UUIDD_OP_BULK_RANDOM_UUID
) {
136 if ((*num
) * UUID_LEN
> buflen
- 4)
137 *num
= (buflen
- 4) / UUID_LEN
;
141 if ((op
== UUIDD_OP_BULK_TIME_UUID
) ||
142 (op
== UUIDD_OP_BULK_RANDOM_UUID
)) {
143 memcpy(op_buf
+ 1, num
, sizeof(int));
144 op_len
+= sizeof(int);
147 ret
= write_all(s
, op_buf
, op_len
);
150 *err_context
= _("write");
155 ret
= read_all(s
, (char *) &reply_len
, sizeof(reply_len
));
158 *err_context
= _("read count");
162 if (reply_len
< 0 || (size_t) reply_len
> buflen
) {
164 *err_context
= _("bad response length");
168 ret
= read_all(s
, (char *) buf
, reply_len
);
170 if ((ret
> 0) && (op
== UUIDD_OP_BULK_TIME_UUID
)) {
171 if (reply_len
>= (int) (UUID_LEN
+ sizeof(int)))
172 memcpy(buf
+ UUID_LEN
, num
, sizeof(int));
176 if ((ret
> 0) && (op
== UUIDD_OP_BULK_RANDOM_UUID
)) {
177 if (reply_len
>= (int) sizeof(int))
178 memcpy(buf
, num
, sizeof(int));
189 * Exclusively create and open a pid file with path @pidfile_path
191 * Return file descriptor of the created pid_file.
193 static int create_pidfile(struct uuidd_cxt_t
*cxt
, const char *pidfile_path
)
198 fd_pidfile
= open(pidfile_path
, O_CREAT
| O_RDWR
, 0664);
199 if (fd_pidfile
< 0) {
201 warn(_("cannot open %s"), pidfile_path
);
204 cxt
->cleanup_pidfile
= pidfile_path
;
207 fl
.l_whence
= SEEK_SET
;
211 while (fcntl(fd_pidfile
, F_SETLKW
, &fl
) < 0) {
212 if ((errno
== EAGAIN
) || (errno
== EINTR
))
215 warn(_("cannot lock %s"), pidfile_path
);
223 * Create AF_UNIX, SOCK_STREAM socket and bind to @socket_path
225 * If @will_fork is true, then make sure the descriptor
226 * of the socket is >2, so that it won't be later closed
227 * during create_daemon().
229 * Return file descriptor corresponding to created socket.
231 static int create_socket(struct uuidd_cxt_t
*uuidd_cxt
,
232 const char *socket_path
, int will_fork
)
234 struct sockaddr_un my_addr
;
238 if ((s
= socket(AF_UNIX
, SOCK_STREAM
, 0)) < 0) {
239 if (!uuidd_cxt
->quiet
)
240 warn(_("couldn't create unix stream socket"));
245 * Make sure the socket isn't using fd numbers 0-2 to avoid it
246 * getting closed by create_daemon()
248 while (will_fork
&& s
<= 2) {
251 err(EXIT_FAILURE
, "dup");
255 * Create the address we will be binding to.
257 my_addr
.sun_family
= AF_UNIX
;
258 strncpy(my_addr
.sun_path
, socket_path
, sizeof(my_addr
.sun_path
));
259 my_addr
.sun_path
[sizeof(my_addr
.sun_path
) - 1] = '\0';
261 save_umask
= umask(0);
262 if (bind(s
, (const struct sockaddr
*) &my_addr
,
263 sizeof(struct sockaddr_un
)) < 0) {
264 if (!uuidd_cxt
->quiet
)
265 warn(_("couldn't bind unix socket %s"), socket_path
);
269 uuidd_cxt
->cleanup_socket
= socket_path
;
274 static void __attribute__((__noreturn__
)) all_done(const struct uuidd_cxt_t
*uuidd_cxt
, int ret
)
276 if (uuidd_cxt
->cleanup_pidfile
)
277 unlink(uuidd_cxt
->cleanup_pidfile
);
278 if (uuidd_cxt
->cleanup_socket
)
279 unlink(uuidd_cxt
->cleanup_socket
);
283 static void handle_signal(const struct uuidd_cxt_t
*uuidd_cxt
, int fd
)
285 struct signalfd_siginfo info
;
288 bytes
= read(fd
, &info
, sizeof(info
));
289 if (bytes
!= sizeof(info
)) {
292 warn(_("receiving signal failed"));
295 if (info
.ssi_signo
== SIGPIPE
)
296 return; /* ignored */
297 all_done(uuidd_cxt
, EXIT_SUCCESS
);
300 static void timeout_handler(int sig
__attribute__((__unused__
)),
302 void *context
__attribute__((__unused__
)))
304 if (info
->si_code
== SI_TIMER
)
305 errx(EXIT_FAILURE
, _("timed out"));
308 static void server_loop(const char *socket_path
, const char *pidfile_path
,
309 struct uuidd_cxt_t
*uuidd_cxt
)
311 struct sockaddr_un from_addr
;
313 int32_t reply_len
= 0;
315 char reply_buf
[1024], *cp
;
316 char op
, str
[UUID_STR_LEN
];
321 struct pollfd pfd
[2];
329 #ifdef HAVE_LIBSYSTEMD
330 if (!uuidd_cxt
->no_sock
) /* no_sock implies no_fork and no_pid */
334 struct itimerval timeout
;
336 memset(&timeout
, 0, sizeof timeout
);
337 timeout
.it_value
.tv_sec
= 30;
338 if (setup_timer(&t_id
, &timeout
, &timeout_handler
))
339 err(EXIT_FAILURE
, _("cannot set up timer"));
341 fd_pidfile
= create_pidfile(uuidd_cxt
, pidfile_path
);
342 ret
= call_daemon(socket_path
, UUIDD_OP_GETPID
, reply_buf
,
343 sizeof(reply_buf
), 0, NULL
);
346 if (!uuidd_cxt
->quiet
)
347 warnx(_("uuidd daemon is already running at pid %s"),
352 s
= create_socket(uuidd_cxt
, socket_path
,
353 (!uuidd_cxt
->debug
|| !uuidd_cxt
->no_fork
));
354 if (listen(s
, SOMAXCONN
) < 0) {
355 if (!uuidd_cxt
->quiet
)
356 warn(_("couldn't listen on unix socket %s"), socket_path
);
360 if (!uuidd_cxt
->debug
&& !uuidd_cxt
->no_fork
)
364 sprintf(reply_buf
, "%8d\n", getpid());
365 if (ftruncate(fd_pidfile
, 0))
366 err(EXIT_FAILURE
, _("could not truncate file: %s"), pidfile_path
);
367 write_all(fd_pidfile
, reply_buf
, strlen(reply_buf
));
368 if (fd_pidfile
> 1 && close_fd(fd_pidfile
) != 0)
369 err(EXIT_FAILURE
, _("write failed: %s"), pidfile_path
);
374 #ifdef HAVE_LIBSYSTEMD
375 if (uuidd_cxt
->no_sock
) {
376 const int r
= sd_listen_fds(0);
380 err(EXIT_FAILURE
, _("sd_listen_fds() failed"));
383 _("no file descriptors received, check systemctl status uuidd.socket"));
386 _("too many file descriptors received, check uuidd.socket"));
387 s
= SD_LISTEN_FDS_START
+ 0;
391 sigemptyset(&sigmask
);
392 sigaddset(&sigmask
, SIGHUP
);
393 sigaddset(&sigmask
, SIGINT
);
394 sigaddset(&sigmask
, SIGTERM
);
395 sigaddset(&sigmask
, SIGALRM
);
396 sigaddset(&sigmask
, SIGPIPE
);
397 /* Block signals so that they aren't handled according to their
398 * default dispositions */
399 sigprocmask(SIG_BLOCK
, &sigmask
, NULL
);
400 if ((sigfd
= signalfd(-1, &sigmask
, 0)) < 0)
401 err(EXIT_FAILURE
, _("cannot set signal handler"));
403 pfd
[POLLFD_SIGNAL
].fd
= sigfd
;
404 pfd
[POLLFD_SOCKET
].fd
= s
;
405 pfd
[POLLFD_SIGNAL
].events
= pfd
[POLLFD_SOCKET
].events
= POLLIN
| POLLERR
| POLLHUP
;
408 ret
= poll(pfd
, ARRAY_SIZE(pfd
),
410 (int) uuidd_cxt
->timeout
* 1000 : -1);
414 warn(_("poll failed"));
415 all_done(uuidd_cxt
, EXIT_FAILURE
);
417 if (ret
== 0) { /* true when poll() times out */
418 if (uuidd_cxt
->debug
)
419 fprintf(stderr
, _("timeout [%d sec]\n"), uuidd_cxt
->timeout
),
420 all_done(uuidd_cxt
, EXIT_SUCCESS
);
422 if (pfd
[POLLFD_SIGNAL
].revents
!= 0)
423 handle_signal(uuidd_cxt
, sigfd
);
424 if (pfd
[POLLFD_SOCKET
].revents
== 0)
426 fromlen
= sizeof(from_addr
);
427 ns
= accept(s
, (struct sockaddr
*) &from_addr
, &fromlen
);
429 if ((errno
== EAGAIN
) || (errno
== EINTR
))
432 err(EXIT_FAILURE
, "accept");
434 len
= read(ns
, &op
, 1);
437 warn(_("read failed"));
439 warnx(_("error reading from client, len = %d"),
441 goto shutdown_socket
;
443 if ((op
== UUIDD_OP_BULK_TIME_UUID
) ||
444 (op
== UUIDD_OP_BULK_RANDOM_UUID
)) {
445 if (read_all(ns
, (char *) &num
, sizeof(num
)) != 4)
446 goto shutdown_socket
;
447 if (uuidd_cxt
->debug
)
448 fprintf(stderr
, _("operation %d, incoming num = %d\n"),
450 } else if (uuidd_cxt
->debug
)
451 fprintf(stderr
, _("operation %d\n"), op
);
454 case UUIDD_OP_GETPID
:
455 sprintf(reply_buf
, "%d", getpid());
456 reply_len
= strlen(reply_buf
) + 1;
458 case UUIDD_OP_GET_MAXOP
:
459 sprintf(reply_buf
, "%d", UUIDD_MAX_OP
);
460 reply_len
= strlen(reply_buf
) + 1;
462 case UUIDD_OP_TIME_UUID
:
464 __uuid_generate_time(uu
, &num
);
465 if (uuidd_cxt
->debug
) {
466 uuid_unparse(uu
, str
);
467 fprintf(stderr
, _("Generated time UUID: %s\n"), str
);
469 memcpy(reply_buf
, uu
, sizeof(uu
));
470 reply_len
= sizeof(uu
);
472 case UUIDD_OP_RANDOM_UUID
:
474 __uuid_generate_random(uu
, &num
);
475 if (uuidd_cxt
->debug
) {
476 uuid_unparse(uu
, str
);
477 fprintf(stderr
, _("Generated random UUID: %s\n"), str
);
479 memcpy(reply_buf
, uu
, sizeof(uu
));
480 reply_len
= sizeof(uu
);
482 case UUIDD_OP_BULK_TIME_UUID
:
483 __uuid_generate_time(uu
, &num
);
484 if (uuidd_cxt
->debug
) {
485 uuid_unparse(uu
, str
);
486 fprintf(stderr
, P_("Generated time UUID %s "
487 "and %d following\n",
488 "Generated time UUID %s "
489 "and %d following\n", num
- 1),
492 memcpy(reply_buf
, uu
, sizeof(uu
));
493 reply_len
= sizeof(uu
);
494 memcpy(reply_buf
+ reply_len
, &num
, sizeof(num
));
495 reply_len
+= sizeof(num
);
497 case UUIDD_OP_BULK_RANDOM_UUID
:
502 if (num
* UUID_LEN
> (int) (sizeof(reply_buf
) - sizeof(num
)))
503 num
= (sizeof(reply_buf
) - sizeof(num
)) / UUID_LEN
;
504 __uuid_generate_random((unsigned char *) reply_buf
+
506 if (uuidd_cxt
->debug
) {
507 fprintf(stderr
, P_("Generated %d UUID:\n",
508 "Generated %d UUIDs:\n", num
), num
);
509 for (i
= 0, cp
= reply_buf
+ sizeof(num
);
511 i
++, cp
+= UUID_LEN
) {
512 uuid_unparse((unsigned char *)cp
, str
);
513 fprintf(stderr
, "\t%s\n", str
);
516 reply_len
= (num
* UUID_LEN
) + sizeof(num
);
517 memcpy(reply_buf
, &num
, sizeof(num
));
520 if (uuidd_cxt
->debug
)
521 fprintf(stderr
, _("Invalid operation %d\n"), op
);
522 goto shutdown_socket
;
524 write_all(ns
, (char *) &reply_len
, sizeof(reply_len
));
525 write_all(ns
, reply_buf
, reply_len
);
531 static void __attribute__ ((__noreturn__
)) unexpected_size(int size
)
533 errx(EXIT_FAILURE
, _("Unexpected reply length from server %d"), size
);
536 int main(int argc
, char **argv
)
538 const char *socket_path
= UUIDD_SOCKET_PATH
;
539 const char *pidfile_path
= NULL
;
540 const char *err_context
= NULL
;
542 char str
[UUID_STR_LEN
];
545 int do_type
= 0, do_kill
= 0, num
= 0;
549 struct uuidd_cxt_t uuidd_cxt
= { .timeout
= 0 };
551 static const struct option longopts
[] = {
552 {"pid", required_argument
, NULL
, 'p'},
553 {"socket", required_argument
, NULL
, 's'},
554 {"timeout", required_argument
, NULL
, 'T'},
555 {"kill", no_argument
, NULL
, 'k'},
556 {"random", no_argument
, NULL
, 'r'},
557 {"time", no_argument
, NULL
, 't'},
558 {"uuids", required_argument
, NULL
, 'n'},
559 {"no-pid", no_argument
, NULL
, 'P'},
560 {"no-fork", no_argument
, NULL
, 'F'},
561 {"socket-activation", no_argument
, NULL
, 'S'},
562 {"debug", no_argument
, NULL
, 'd'},
563 {"quiet", no_argument
, NULL
, 'q'},
564 {"version", no_argument
, NULL
, 'V'},
565 {"help", no_argument
, NULL
, 'h'},
568 static const ul_excl_t excl
[] = {
574 int excl_st
[ARRAY_SIZE(excl
)] = UL_EXCL_STATUS_INIT
;
576 setlocale(LC_ALL
, "");
577 bindtextdomain(PACKAGE
, LOCALEDIR
);
579 atexit(close_stdout
);
582 getopt_long(argc
, argv
, "p:s:T:krtn:PFSdqVh", longopts
,
584 err_exclusive_options(c
, longopts
, excl
, excl_st
);
593 num
= strtou32_or_err(optarg
,
594 _("failed to parse --uuids"));
597 pidfile_path
= optarg
;
603 uuidd_cxt
.no_fork
= 1;
606 #ifdef HAVE_LIBSYSTEMD
607 uuidd_cxt
.no_sock
= 1;
608 uuidd_cxt
.no_fork
= 1;
611 errx(EXIT_FAILURE
, _("uuidd has been built without "
612 "support for socket activation"));
619 do_type
= UUIDD_OP_RANDOM_UUID
;
622 socket_path
= optarg
;
626 do_type
= UUIDD_OP_TIME_UUID
;
629 uuidd_cxt
.timeout
= strtou32_or_err(optarg
,
630 _("failed to parse --timeout"));
633 printf(UTIL_LINUX_VERSION
);
638 errtryhelp(EXIT_FAILURE
);
642 if (!no_pid
&& !pidfile_path
)
643 pidfile_path
= UUIDD_PIDFILE_PATH
;
645 /* custom socket path and socket-activation make no sense */
646 if (s_flag
&& uuidd_cxt
.no_sock
&& !uuidd_cxt
.quiet
)
647 warnx(_("Both --socket-activation and --socket specified. "
648 "Ignoring --socket."));
650 if (num
&& do_type
) {
651 ret
= call_daemon(socket_path
, do_type
+ 2, buf
,
652 sizeof(buf
), &num
, &err_context
);
654 err(EXIT_FAILURE
, _("error calling uuidd daemon (%s)"),
655 err_context
? : _("unexpected error"));
657 if (do_type
== UUIDD_OP_TIME_UUID
) {
658 if (ret
!= sizeof(uu
) + sizeof(num
))
659 unexpected_size(ret
);
661 uuid_unparse((unsigned char *) buf
, str
);
663 printf(P_("%s and %d subsequent UUID\n",
664 "%s and %d subsequent UUIDs\n", num
- 1),
667 printf(_("List of UUIDs:\n"));
669 if (ret
!= (int) (sizeof(num
) + num
* sizeof(uu
)))
670 unexpected_size(ret
);
671 for (i
= 0; i
< num
; i
++, cp
+= UUID_LEN
) {
672 uuid_unparse((unsigned char *) cp
, str
);
673 printf("\t%s\n", str
);
679 ret
= call_daemon(socket_path
, do_type
, (char *) &uu
,
680 sizeof(uu
), 0, &err_context
);
682 err(EXIT_FAILURE
, _("error calling uuidd daemon (%s)"),
683 err_context
? : _("unexpected error"));
684 if (ret
!= sizeof(uu
))
685 unexpected_size(ret
);
687 uuid_unparse(uu
, str
);
694 ret
= call_daemon(socket_path
, UUIDD_OP_GETPID
, buf
, sizeof(buf
), 0, NULL
);
695 if ((ret
> 0) && ((do_kill
= atoi((char *) buf
)) > 0)) {
696 ret
= kill(do_kill
, SIGTERM
);
698 if (!uuidd_cxt
.quiet
)
699 warn(_("couldn't kill uuidd running "
700 "at pid %d"), do_kill
);
703 if (!uuidd_cxt
.quiet
)
704 printf(_("Killed uuidd running at pid %d.\n"),
710 server_loop(socket_path
, pidfile_path
, &uuidd_cxt
);