2 * Copyright (C) 1997-2011 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file daemon.c Some helpers for programs that detach from the console. */
11 #include <sys/types.h> /* getgrnam() */
21 /** The internal state of the daemon. */
23 /** See \ref daemon_flags. */
25 /** Set by \ref daemon_set_logfile(). */
27 /** Current loglevel, see \ref daemon_set_loglevel(). */
30 /** Used by \ref server_uptime() and \ref uptime_str(). */
32 /** The file pointer if the logfile is open. */
34 /** Used by para_log() if \p DF_LOG_HOSTNAME is set. */
36 /** Used for colored log messages. */
37 char log_colors[NUM_LOGLEVELS][COLOR_MAXLEN];
40 static struct daemon the_daemon, *me = &the_daemon;
43 * Activate default log colors.
45 * This should be called early if color support is wanted.
47 void daemon_set_default_log_colors(void)
50 static const char *default_log_colors[NUM_LOGLEVELS] = {
51 [LL_DEBUG] = "normal",
53 [LL_NOTICE] = "normal",
54 [LL_WARNING] = "yellow",
56 [LL_CRIT] = "magenta bold",
57 [LL_EMERG] = "red bold",
59 for (i = 0; i < NUM_LOGLEVELS; i++)
60 color_parse_or_die(default_log_colors[i], me->log_colors[i]);
64 * Set the color for one loglevel.
66 * \param arg The loglevel/color specifier.
68 * \a arg must be of the form "ll:[fg [bg]] [attr]".
70 * \return 1 On success, -1 on errors.
72 void daemon_set_log_color_or_die(char const *arg)
74 char *p = strchr(arg, ':');
79 ret = get_loglevel_by_name(arg);
84 color_parse_or_die(p, me->log_colors[ll]);
87 PARA_EMERG_LOG("%s: color syntax error\n", arg);
92 * Init or change the name of the log file.
94 * \param logfile_name The full path of the logfile.
96 void daemon_set_logfile(char *logfile_name)
98 free(me->logfile_name);
99 me->logfile_name = NULL;
101 me->logfile_name = para_strdup(logfile_name);
105 * Suppress log messages with severity lower than the given loglevel.
107 * \param loglevel The smallest level that should be logged.
109 void daemon_set_loglevel(char *loglevel)
111 int ret = get_loglevel_by_name(loglevel);
118 * Set one of the daemon config flags.
120 * \param flag The flag to set.
122 * \sa \ref daemon_flags.
124 void daemon_set_flag(unsigned flag)
130 * Clear one of the daemon config flags.
132 * \param flag The flag to clear.
134 * \sa \ref daemon_flags.
136 void daemon_clear_flag(unsigned flag)
141 static bool daemon_test_flag(unsigned flag)
143 return me->flags & flag;
147 * Do the usual stuff to become a daemon.
149 * Fork, become session leader, dup fd 0, 1, 2 to /dev/null.
151 * \sa fork(2), setsid(2), dup(2).
158 PARA_INFO_LOG("daemonizing\n");
163 exit(EXIT_SUCCESS); /* parent exits */
164 /* become session leader */
169 null = open("/dev/null", O_RDONLY);
172 if (dup2(null, STDIN_FILENO) < 0)
174 if (dup2(null, STDOUT_FILENO) < 0)
176 if (dup2(null, STDERR_FILENO) < 0)
181 PARA_EMERG_LOG("fatal: %s\n", strerror(errno));
186 * Close the log file of the daemon.
188 void daemon_close_log(void)
192 PARA_INFO_LOG("closing logfile\n");
198 * fopen() the logfile in append mode.
200 * \return Either succeeds or exits.
202 void daemon_open_log_or_die(void)
205 if (!me->logfile_name)
207 me->logfile = fopen(me->logfile_name, "a");
209 PARA_EMERG_LOG("can not open %s: %s\n", me->logfile_name,
213 setlinebuf(me->logfile);
217 * Log the startup message containing the paraslash version.
219 void log_welcome(const char *whoami)
221 PARA_INFO_LOG("welcome to %s " PACKAGE_VERSION " ("BUILD_DATE")\n",
226 * Give up superuser privileges.
228 * \param username The user to switch to.
229 * \param groupname The group to switch to.
231 * This function returns immediately if not invoked with EUID zero. Otherwise,
232 * it tries to obtain the GID of \a groupname and the UID of \a username. On
233 * success, effective and real GID/UID and the saved set-group-ID/set-user-ID
234 * are all set accordingly. On errors, an appropriate message is logged and
235 * exit() is called to terminate the process.
237 * \sa getpwnam(3), getuid(2), setuid(2), getgrnam(2), setgid(2)
239 void drop_privileges_or_die(const char *username, const char *groupname)
247 struct group *g = getgrnam(groupname);
249 PARA_EMERG_LOG("failed to get group %s: %s\n",
250 groupname, strerror(errno));
253 if (setgid(g->gr_gid) < 0) {
254 PARA_EMERG_LOG("failed to set group id %d: %s\n",
255 (int)g->gr_gid, strerror(errno));
260 PARA_EMERG_LOG("root privileges, but no user option given\n");
263 tmp = para_strdup(username);
267 PARA_EMERG_LOG("%s: no such user\n", username);
270 PARA_INFO_LOG("dropping root privileges\n");
271 if (setuid(p->pw_uid) < 0) {
272 PARA_EMERG_LOG("failed to set effective user ID (%s)",
276 PARA_DEBUG_LOG("uid: %d, euid: %d\n", (int)getuid(), (int)geteuid());
280 * Set/get the server uptime.
282 * \param set_or_get Chose one of the two modes.
284 * This should be called at startup time with \a set_or_get equal to \p
285 * UPTIME_SET which sets the uptime to zero. Subsequent calls with \a
286 * set_or_get equal to \p UPTIME_GET return the uptime.
288 * \return Zero if called with \a set_or_get equal to \p UPTIME_SET, the number
289 * of seconds elapsed since the last reset otherwise.
291 * \sa time(2), difftime(3).
293 time_t server_uptime(enum uptime set_or_get)
298 if (set_or_get == UPTIME_SET) {
299 time(&me->startuptime);
303 diff = difftime(now, me->startuptime);
304 return (time_t) diff;
308 * Construct string containing uptime.
310 * \return A dynamically allocated string of the form "days:hours:minutes".
314 __malloc char *uptime_str(void)
316 long t = server_uptime(UPTIME_GET);
317 return make_message("%li:%02li:%02li", t / 86400,
318 (t / 3600) % 24, (t / 60) % 60);
322 * The log function for para_server and para_audiod.
324 * \param ll The log level.
325 * \param fmt The format string describing the log message.
327 __printf_2_3 void para_log(int ll, const char* fmt,...)
333 bool log_time = daemon_test_flag(DF_LOG_TIME), log_timing =
334 daemon_test_flag(DF_LOG_TIMING);
336 ll = PARA_MIN(ll, NUM_LOGLEVELS - 1);
337 ll = PARA_MAX(ll, LL_DEBUG);
338 if (ll < me->loglevel)
341 fp = me->logfile? me->logfile : stderr;
342 color = daemon_test_flag(DF_COLOR_LOG)? me->log_colors[ll] : NULL;
344 fprintf(fp, "%s", color);
345 if (log_time || log_timing) {
347 gettimeofday(&tv, NULL);
348 if (daemon_test_flag(DF_LOG_TIME)) { /* print date and time */
349 time_t t1 = tv.tv_sec;
352 strftime(str, sizeof(str), "%b %d %H:%M:%S", tm);
353 fprintf(fp, "%s%s", str, log_timing? ":" : " ");
355 if (log_timing) /* print milliseconds */
356 fprintf(fp, "%04lu ", (long unsigned)tv.tv_usec / 1000);
358 if (daemon_test_flag(DF_LOG_HOSTNAME)) {
360 me->hostname = para_hostname();
361 fprintf(fp, "%s ", me->hostname);
363 if (daemon_test_flag(DF_LOG_LL)) /* log loglevel */
364 fprintf(fp, "(%d) ", ll);
365 if (daemon_test_flag(DF_LOG_PID)) { /* log pid */
366 pid_t mypid = getpid();
367 fprintf(fp, "(%d) ", (int)mypid);
370 vfprintf(fp, fmt, argp);
373 fprintf(fp, "%s", COLOR_RESET);