daemon.c

   1 /* Copyright (C) 1997 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
   2
   3 /** \file daemon.c Some helpers for programs that detach from the console. */
   4
   5 #include <regex.h>
   6 #include <pwd.h>
   7 #include <sys/types.h> /* getgrnam() */
   8 #include <grp.h>
   9 #include <signal.h>
  10 #include <sys/resource.h>
  11
  12 #include "para.h"
  13 #include "daemon.h"
  14 #include "string.h"
  15 #include "color.h"
  16
  17 /** The internal state of the daemon. */
  18 struct daemon {
  19         /** See \ref daemon_flags. */
  20         unsigned flags;
  21         /** Set by \ref daemon_set_logfile(). */
  22         char *logfile_name;
  23         /** Current loglevel, see \ref daemon_set_loglevel(). */
  24         int loglevel;
  25         /** Used by \ref server_uptime() and \ref uptime_str(). */
  26         time_t startuptime;
  27         /** The file pointer if the logfile is open. */
  28         FILE *logfile;
  29         /** Used by para_log() if \p DF_LOG_HOSTNAME is set. */
  30         char *hostname;
  31         /** Used for colored log messages. */
  32         char log_colors[NUM_LOGLEVELS][COLOR_MAXLEN];
  33         char *old_cwd;
  34         /*
  35          * If these pointers are non-NULL, the functions are called from
  36          * daemon_log() before and after writing each log message.
  37          */
  38         void (*pre_log_hook)(void);
  39         void (*post_log_hook)(void);
  40 };
  41
  42 static struct daemon the_daemon, *me = &the_daemon;
  43
  44 static void daemon_set_default_log_colors(void)
  45 {
  46         int i;
  47         static const char *default_log_colors[NUM_LOGLEVELS] = {
  48                 [LL_DEBUG] = "normal",
  49                 [LL_INFO] = "normal",
  50                 [LL_NOTICE] = "normal",
  51                 [LL_WARNING] = "yellow",
  52                 [LL_ERROR] = "red",
  53                 [LL_CRIT] = "magenta bold",
  54                 [LL_EMERG] = "red bold",
  55         };
  56         for (i = 0; i < NUM_LOGLEVELS; i++)
  57                 color_parse_or_die(default_log_colors[i], me->log_colors[i]);
  58 }
  59
  60 /**
  61  * Set the color for log messages of the given severity level.
  62  *
  63  * \param arg Must be of the form "severity:[fg [bg]] [attr]".
  64  */
  65 void daemon_set_log_color_or_die(const char *arg)
  66 {
  67         char *p = strchr(arg, ':');
  68         int ret, ll;
  69
  70         if (!p)
  71                 goto err;
  72         ret = get_loglevel_by_name(arg);
  73         if (ret < 0)
  74                 goto err;
  75         ll = ret;
  76         p++;
  77         color_parse_or_die(p, me->log_colors[ll]);
  78         return;
  79 err:
  80         PARA_EMERG_LOG("%s: invalid color argument\n", arg);
  81         exit(EXIT_FAILURE);
  82 }
  83
  84 /**
  85  * Initialize color mode if necessary.
  86  *
  87  * \param color_arg The argument given to --color.
  88  * \param color_arg_auto The value for automatic color detection.
  89  * \param color_arg_no The value to disable colored log messages.
  90  * \param logfile_given In auto mode colors are disabled if this value is true.
  91  *
  92  * If color_arg equals color_arg_no, color mode is disabled. That is, calls to
  93  * para_log() will not produce colored output. If color_arg equals
  94  * color_arg_auto, the function detects automatically whether to activate
  95  * colors. Otherwise color mode is enabled.
  96  *
  97  * If color mode is to be enabled, the default colors are set for each
  98  * loglevel. They can be overwritten by calling daemon_set_log_color_or_die().
  99  *
 100  * \return Whether colors have been enabled by the function.
 101  */
 102 bool daemon_init_colors_or_die(int color_arg, int color_arg_auto,
 103                 int color_arg_no, bool logfile_given)
 104 {
 105         if (color_arg == color_arg_no)
 106                 return false;
 107         if (color_arg == color_arg_auto) {
 108                 if (logfile_given)
 109                         return false;
 110                 if (!isatty(STDERR_FILENO))
 111                         return false;
 112         }
 113         daemon_set_flag(DF_COLOR_LOG);
 114         daemon_set_default_log_colors();
 115         return true;
 116 }
 117
 118 /**
 119  * Init or change the name of the log file.
 120  *
 121  * \param logfile_name The full path of the logfile.
 122  */
 123 void daemon_set_logfile(const char *logfile_name)
 124 {
 125         free(me->logfile_name);
 126         me->logfile_name = NULL;
 127         if (!logfile_name)
 128                 return;
 129         if (me->old_cwd && logfile_name[0] != '/')
 130                 me->logfile_name = make_message("%s/%s", me->old_cwd,
 131                         logfile_name);
 132         else
 133                 me->logfile_name = para_strdup(logfile_name);
 134 }
 135
 136 /**
 137  * Control the verbosity for logging.
 138  *
 139  * This instructs the daemon to not log subsequent messages whose severity is
 140  * lower than the given value.
 141  *
 142  * \param loglevel The new log level.
 143  */
 144 void daemon_set_loglevel(int loglevel)
 145 {
 146         assert(loglevel >= 0);
 147         assert(loglevel < NUM_LOGLEVELS);
 148         me->loglevel = loglevel;
 149
 150 }
 151
 152 /**
 153  * Register functions to be called before and after a message is logged.
 154  *
 155  * \param pre_log_hook Called before the message is logged.
 156  * \param post_log_hook Called after the message is logged.
 157  *
 158  * The purpose of this function is to provide a primitive for multi-threaded
 159  * applications to serialize the access to the log facility, preventing
 160  * interleaving log messages. This can be achieved by having the pre-log hook
 161  * acquire a lock which blocks the other threads on the attempt to log a
 162  * message at the same time.  The post-log hook is responsible for releasing
 163  * the lock.
 164  *
 165  * If these hooks are unnecessary, for example because the application is
 166  * single-threaded, this function does not need to be called.
 167  */
 168 void daemon_set_hooks(void (*pre_log_hook)(void), void (*post_log_hook)(void))
 169 {
 170         me->pre_log_hook = pre_log_hook;
 171         me->post_log_hook = post_log_hook;
 172 }
 173
 174 /**
 175  * Set one of the daemon config flags.
 176  *
 177  * \param flag The flag to set.
 178  *
 179  * \sa \ref daemon_flags.
 180  */
 181 void daemon_set_flag(unsigned flag)
 182 {
 183         me->flags |= flag;
 184 }
 185
 186 static bool daemon_test_flag(unsigned flag)
 187 {
 188         return me->flags & flag;
 189 }
 190
 191 /**
 192  * Do the usual stuff to become a daemon.
 193  *
 194  * \param parent_waits Whether the parent process should pause before exit.
 195  *
 196  * Fork, become session leader, cd to /, and dup fd 0, 1, 2 to /dev/null. If \a
 197  * parent_waits is false, the parent process terminates immediately.
 198  * Otherwise, a pipe is created prior to the fork() and the parent tries to
 199  * read a single byte from the reading end of the pipe. The child is supposed
 200  * to write to the writing end of the pipe after it completed its setup
 201  * procedure successfully. This behaviour is useful to let the parent process
 202  * die with an error if the child process aborts early, since in this case the
 203  * read() will return non-positive.
 204  *
 205  * \return This function either succeeds or calls exit(3). If parent_waits is
 206  * true, the return value is the file descriptor of the writing end of the
 207  * pipe. Otherwise the function returns zero.
 208  *
 209  * \sa fork(2), setsid(2), dup(2), pause(2).
 210  */
 211 int daemonize(bool parent_waits)
 212 {
 213         pid_t pid;
 214         int null, pipe_fd[2];
 215
 216         if (parent_waits && pipe(pipe_fd) < 0)
 217                 goto err;
 218         PARA_INFO_LOG("subsequent log messages go to %s\n", me->logfile_name?
 219                  me->logfile_name : "/dev/null");
 220         pid = fork();
 221         if (pid < 0)
 222                 goto err;
 223         if (pid) { /* parent exits */
 224                 if (parent_waits) {
 225                         char c;
 226                         close(pipe_fd[1]);
 227                         exit(read(pipe_fd[0], &c, 1) <= 0?
 228                                 EXIT_FAILURE : EXIT_SUCCESS);
 229                 }
 230                 exit(EXIT_SUCCESS);
 231         }
 232         if (parent_waits)
 233                 close(pipe_fd[0]);
 234         /* become session leader */
 235         if (setsid() < 0)
 236                 goto err;
 237         me->old_cwd = getcwd(NULL, 0);
 238         if (chdir("/") < 0)
 239                 goto err;
 240         null = open("/dev/null", O_RDWR);
 241         if (null < 0)
 242                 goto err;
 243         if (dup2(null, STDIN_FILENO) < 0)
 244                 goto err;
 245         if (dup2(null, STDOUT_FILENO) < 0)
 246                 goto err;
 247         if (dup2(null, STDERR_FILENO) < 0)
 248                 goto err;
 249         close(null);
 250         return parent_waits? pipe_fd[1] : 0;
 251 err:
 252         PARA_EMERG_LOG("fatal: %s\n", strerror(errno));
 253         exit(EXIT_FAILURE);
 254 }
 255
 256 /**
 257  * Close the log file of the daemon.
 258  */
 259 void daemon_close_log(void)
 260 {
 261         if (!me->logfile)
 262                 return;
 263         PARA_INFO_LOG("closing logfile\n");
 264         fclose(me->logfile);
 265         me->logfile = NULL;
 266 }
 267
 268 /**
 269  * fopen() the logfile in append mode.
 270  *
 271  * \return Either succeeds or exits.
 272  */
 273 void daemon_open_log_or_die(void)
 274 {
 275         FILE *new_log;
 276
 277         if (!me->logfile_name)
 278                 return;
 279         new_log = fopen(me->logfile_name, "a");
 280         if (!new_log) {
 281                 PARA_EMERG_LOG("can not open %s: %s\n", me->logfile_name,
 282                         strerror(errno));
 283                 exit(EXIT_FAILURE);
 284         }
 285         daemon_close_log();
 286         me->logfile = new_log;
 287         /* equivalent to setlinebuf(), but portable */
 288         setvbuf(me->logfile, NULL, _IOLBF, 0);
 289 }
 290
 291 /**
 292  * Log the startup message containing the paraslash version.
 293  *
 294  * \param name The name of the executable.
 295  *
 296  * First the given \a name is prefixed with the string "para_". Next the git
 297  * version is appended. The resulting string is logged with priority "INFO".
 298  */
 299 void daemon_log_welcome(const char *name)
 300 {
 301         PARA_INFO_LOG("welcome to para_%s-" PACKAGE_VERSION " \n", name);
 302 }
 303
 304 /**
 305  * Renice the calling process.
 306  *
 307  * \param prio The priority value to set.
 308  *
 309  * Errors are not considered fatal, but a warning message is logged if the
 310  * underlying call to setpriority(2) fails.
 311  */
 312 void daemon_set_priority(int prio)
 313 {
 314         if (setpriority(PRIO_PROCESS, 0, prio) < 0)
 315                 PARA_WARNING_LOG("could not set priority to %d: %s\n", prio,
 316                         strerror(errno));
 317 }
 318
 319 /**
 320  * Give up superuser privileges.
 321  *
 322  * \param username The user to switch to.
 323  * \param groupname The group to switch to.
 324  *
 325  * This function returns immediately if not invoked with EUID zero. Otherwise,
 326  * it tries to obtain the GID of \a groupname and the UID of \a username.  On
 327  * success, effective and real GID/UID and the saved set-group-ID/set-user-ID
 328  * are all set accordingly. On errors, an appropriate message is logged and
 329  * exit() is called to terminate the process.
 330  *
 331  * \sa getpwnam(3), getuid(2), setuid(2), getgrnam(2), setgid(2)
 332  */
 333 void daemon_drop_privileges_or_die(const char *username, const char *groupname)
 334 {
 335         struct passwd *p;
 336         char *tmp;
 337
 338         if (geteuid())
 339                 return;
 340         if (groupname) {
 341                 struct group *g = getgrnam(groupname);
 342                 if (!g) {
 343                         PARA_EMERG_LOG("failed to get group %s: %s\n",
 344                                 groupname, strerror(errno));
 345                         exit(EXIT_FAILURE);
 346                 }
 347                 if (setgid(g->gr_gid) < 0) {
 348                         PARA_EMERG_LOG("failed to set group id %d: %s\n",
 349                                 (int)g->gr_gid, strerror(errno));
 350                         exit(EXIT_FAILURE);
 351                 }
 352         }
 353         if (!username) {
 354                 PARA_EMERG_LOG("root privileges, but no user option given\n");
 355                 exit(EXIT_FAILURE);
 356         }
 357         tmp = para_strdup(username);
 358         p = getpwnam(tmp);
 359         free(tmp);
 360         if (!p) {
 361                 PARA_EMERG_LOG("%s: no such user\n", username);
 362                 exit(EXIT_FAILURE);
 363         }
 364         PARA_INFO_LOG("dropping root privileges\n");
 365         if (setuid(p->pw_uid) < 0) {
 366                 PARA_EMERG_LOG("failed to set effective user ID (%s)",
 367                         strerror(errno));
 368                 exit(EXIT_FAILURE);
 369         }
 370         PARA_DEBUG_LOG("uid: %d, euid: %d\n", (int)getuid(), (int)geteuid());
 371 }
 372
 373 /**
 374  * Set the startup time.
 375  *
 376  * This should be called once on startup. It sets the start time to the
 377  * current time. The stored time is used for retrieving the server uptime.
 378  *
 379  * \sa time(2), \ref daemon_get_uptime(), \ref daemon_get_uptime_str().
 380  */
 381 void daemon_set_start_time(void)
 382 {
 383         time(&me->startuptime);
 384 }
 385
 386 /**
 387  * Get the uptime.
 388  *
 389  * \param current_time The current time.
 390  *
 391  * The \a current_time pointer may be \p NULL. In this case the function
 392  * obtains the current time from the system.
 393  *
 394  * \return This returns the server uptime in seconds, i.e. the difference
 395  * between the current time and the value stored previously via \ref
 396  * daemon_set_start_time().
 397  */
 398 time_t daemon_get_uptime(const struct timeval *current_time)
 399 {
 400         time_t t;
 401
 402         if (current_time)
 403                 return current_time->tv_sec - me->startuptime;
 404         time(&t);
 405         return difftime(t, me->startuptime);
 406 }
 407
 408 /**
 409  * Construct a string containing the current uptime.
 410  *
 411  * \param current_time See a \ref daemon_get_uptime().
 412  *
 413  * \return A dynamically allocated string of the form "days:hours:minutes".
 414  */
 415 __malloc char *daemon_get_uptime_str(const struct timeval *current_time)
 416 {
 417         long t = daemon_get_uptime(current_time);
 418         return make_message("%li:%02li:%02li", t / 86400,
 419                 (t / 3600) % 24, (t / 60) % 60);
 420 }
 421
 422 /**
 423  * The log function for para_server and para_audiod.
 424  *
 425  * \param ll The log level.
 426  * \param fmt The format string describing the log message.
 427  */
 428 __printf_2_3 void daemon_log(int ll, const char* fmt,...)
 429 {
 430         va_list argp;
 431         FILE *fp;
 432         struct tm *tm;
 433         char *color;
 434         bool log_time = daemon_test_flag(DF_LOG_TIME), log_timing =
 435                 daemon_test_flag(DF_LOG_TIMING);
 436
 437         ll = PARA_MIN(ll, NUM_LOGLEVELS - 1);
 438         ll = PARA_MAX(ll, LL_DEBUG);
 439         if (ll < me->loglevel)
 440                 return;
 441
 442         fp = me->logfile? me->logfile : stderr;
 443         if (me->pre_log_hook)
 444                 me->pre_log_hook();
 445         color = daemon_test_flag(DF_COLOR_LOG)? me->log_colors[ll] : NULL;
 446         if (color)
 447                 fprintf(fp, "%s", color);
 448         if (log_time || log_timing) {
 449                 struct timeval tv;
 450                 clock_get_realtime(&tv);
 451                 if (daemon_test_flag(DF_LOG_TIME)) { /* print date and time */
 452                         time_t t1 = tv.tv_sec;
 453                         char str[100];
 454                         tm = localtime(&t1);
 455                         strftime(str, sizeof(str), "%b %d %H:%M:%S", tm);
 456                         fprintf(fp, "%s%s", str, log_timing? ":" : " ");
 457                 }
 458                 if (log_timing) /* print milliseconds */
 459                         fprintf(fp, "%04lu ", (long unsigned)tv.tv_usec / 1000);
 460         }
 461         if (daemon_test_flag(DF_LOG_HOSTNAME)) {
 462                 if (!me->hostname)
 463                         me->hostname = para_hostname();
 464                 fprintf(fp, "%s ", me->hostname);
 465         }
 466         if (daemon_test_flag(DF_LOG_LL)) /* log loglevel */
 467                 fprintf(fp, "(%d) ", ll);
 468         if (daemon_test_flag(DF_LOG_PID)) { /* log pid */
 469                 pid_t mypid = getpid();
 470                 fprintf(fp, "(%d) ", (int)mypid);
 471         }
 472         va_start(argp, fmt);
 473         vfprintf(fp, fmt, argp);
 474         va_end(argp);
 475         if (color)
 476                 fprintf(fp, "%s", COLOR_RESET);
 477         if (me->post_log_hook)
 478                 me->post_log_hook();
 479 }