src/master/service-process.c

	service-process.c revision 9e291f6a7ca67b86d1d65a730ffb71fb9a334fb0
/* Copyright (c) 2005-2011 Dovecot authors, see the included COPYING file */

#include "common.h"
#include "array.h"
#include "aqueue.h"
#include "ioloop.h"
#include "istream.h"
#include "ostream.h"
#include "write-full.h"
#include "base64.h"
#include "hash.h"
#include "str.h"
#include "strescape.h"
#include "llist.h"
#include "hostpid.h"
#include "env-util.h"
#include "fd-close-on-exec.h"
#include "restrict-access.h"
#include "restrict-process-size.h"
#include "eacces-error.h"
#include "master-service.h"
#include "master-service-settings.h"
#include "dup2-array.h"
#include "service.h"
#include "service-anvil.h"
#include "service-log.h"
#include "service-process-notify.h"
#include "service-process.h"

#include <stdlib.h>
#include <unistd.h>
#include <fcntl.h>
#include <syslog.h>
#include <signal.h>
#include <sys/wait.h>

static void
service_dup_fds(struct service *service)
{
    struct service_listener *const *listeners;
    ARRAY_TYPE(dup2) dups;
    string_t *listener_names;
    int fd = MASTER_LISTEN_FD_FIRST;
    unsigned int i, count, socket_listener_count, ssl_socket_count;

    /* stdin/stdout is already redirected to /dev/null. Other master fds
       should have been opened with fd_close_on_exec() so we don't have to
       worry about them.

       because the destination fd might be another one's source fd we have
       to be careful not to overwrite anything. dup() the fd when needed */

        socket_listener_count = 0;
    listeners = array_get(&service->listeners, &count);
    t_array_init(&dups, count + 10);
    listener_names = t_str_new(256);

    switch (service->type) {
    case SERVICE_TYPE_LOG:
        i_assert(fd == MASTER_LISTEN_FD_FIRST);
        services_log_dup2(&dups, service->list, fd,
                  &socket_listener_count);
        fd += socket_listener_count;
        break;
    case SERVICE_TYPE_ANVIL:
        dup2_append(&dups, service_anvil_global->log_fdpass_fd[0],
                MASTER_ANVIL_LOG_FDPASS_FD);
        /* nonblocking anvil fd must be the first one. anvil treats it
           as the master's fd */
        dup2_append(&dups, service_anvil_global->nonblocking_fd[0], fd++);
        dup2_append(&dups, service_anvil_global->blocking_fd[0], fd++);
        socket_listener_count += 2;
        break;
    default:
        break;
    }

    /* anvil/log fds have no names */
    for (i = MASTER_LISTEN_FD_FIRST; i < (unsigned int)fd; i++)
        str_append_c(listener_names, '\t');

    /* first add non-ssl listeners */
    for (i = 0; i < count; i++) {
        if (listeners[i]->fd != -1 &&
            (listeners[i]->type != SERVICE_LISTENER_INET ||
             !listeners[i]->set.inetset.set->ssl)) {
            str_tabescape_write(listener_names, listeners[i]->name);
            str_append_c(listener_names, '\t');
            dup2_append(&dups, listeners[i]->fd, fd++);
            socket_listener_count++;
        }
    }
    /* then ssl-listeners */
    ssl_socket_count = 0;
    for (i = 0; i < count; i++) {
        if (listeners[i]->fd != -1 &&
            listeners[i]->type == SERVICE_LISTENER_INET &&
            listeners[i]->set.inetset.set->ssl) {
            str_tabescape_write(listener_names, listeners[i]->name);
            str_append_c(listener_names, '\t');
            dup2_append(&dups, listeners[i]->fd, fd++);
            socket_listener_count++;
            ssl_socket_count++;
        }
    }

    if (service->login_notify_fd != -1) {
        dup2_append(&dups, service->login_notify_fd,
                MASTER_LOGIN_NOTIFY_FD);
    }
    switch (service->type) {
    case SERVICE_TYPE_LOG:
    case SERVICE_TYPE_ANVIL:
    case SERVICE_TYPE_CONFIG:
        dup2_append(&dups, null_fd, MASTER_ANVIL_FD);
        break;
    case SERVICE_TYPE_UNKNOWN:
    case SERVICE_TYPE_LOGIN:
    case SERVICE_TYPE_STARTUP:
        dup2_append(&dups, service_anvil_global->blocking_fd[1],
                MASTER_ANVIL_FD);
        break;
    }
    dup2_append(&dups, service->status_fd[1], MASTER_STATUS_FD);
    if (service->type != SERVICE_TYPE_ANVIL) {
        dup2_append(&dups, service->list->master_dead_pipe_fd[1],
                MASTER_DEAD_FD);
    } else {
        dup2_append(&dups, global_master_dead_pipe_fd[1],
                MASTER_DEAD_FD);
    }

    if (service->type == SERVICE_TYPE_LOG) {
        /* keep stderr as-is. this is especially important when
           log_path=/dev/stderr, but might be helpful even in other
           situations for logging startup errors */
    } else {
        /* set log file to stderr. dup2() here immediately so that
           we can set up logging to it without causing any log messages
           to be lost. */
        i_assert(service->log_fd[1] != -1);

        env_put("LOG_SERVICE=1");
        if (dup2(service->log_fd[1], STDERR_FILENO) < 0)
            i_fatal("dup2(log fd) failed: %m");
        i_set_failure_internal();
    }

    /* make sure we don't leak syslog fd. try to do it as late as possible,
       but also before dup2()s in case syslog fd is one of them. */
    closelog();

    if (dup2_array(&dups) < 0)
        i_fatal("service(%s): dup2s failed", service->set->name);

    i_assert(fd == MASTER_LISTEN_FD_FIRST + (int)socket_listener_count);
    env_put(t_strdup_printf("SOCKET_COUNT=%d", socket_listener_count));
    env_put(t_strdup_printf("SSL_SOCKET_COUNT=%d", ssl_socket_count));
    env_put(t_strdup_printf("SOCKET_NAMES=%s", str_c(listener_names)));
}

static void
drop_privileges(struct service *service)
{
    struct restrict_access_settings rset;
    bool disallow_root;
    unsigned int len;

    if (service->vsz_limit != 0)
        restrict_process_size(service->vsz_limit);

    restrict_access_init(&rset);
    rset.uid = service->uid;
    rset.gid = service->gid;
    rset.privileged_gid = service->privileged_gid;
    rset.chroot_dir = *service->set->chroot == '\0' ? NULL :
        service->set->chroot;
    if (rset.chroot_dir != NULL) {
        /* drop trailing / if it exists */
        len = strlen(rset.chroot_dir);
        if (rset.chroot_dir[len-1] == '/')
            rset.chroot_dir = t_strndup(rset.chroot_dir, len-1);
    }
    rset.extra_groups = service->extra_gids;

    restrict_access_set_env(&rset);
    if (service->set->drop_priv_before_exec) {
        disallow_root = service->type == SERVICE_TYPE_LOGIN;
        restrict_access(&rset, NULL, disallow_root);
    }
}

static void service_process_setup_config_environment(struct service *service)
{
    const struct master_service_settings *set = service->list->service_set;

    switch (service->type) {
    case SERVICE_TYPE_CONFIG:
        env_put(t_strconcat(MASTER_CONFIG_FILE_ENV"=",
                    service->config_file_path, NULL));
        break;
    case SERVICE_TYPE_LOG:
        /* give the log's configuration directly, so it won't depend
           on config process */
        env_put("DOVECONF_ENV=1");
        env_put(t_strconcat("LOG_PATH=", set->log_path, NULL));
        env_put(t_strconcat("INFO_LOG_PATH=", set->info_log_path, NULL));
        env_put(t_strconcat("DEBUG_LOG_PATH=", set->debug_log_path, NULL));
        env_put(t_strconcat("LOG_TIMESTAMP=", set->log_timestamp, NULL));
        env_put(t_strconcat("SYSLOG_FACILITY=", set->syslog_facility, NULL));
        break;
    default:
        env_put(t_strconcat(MASTER_CONFIG_FILE_ENV"=",
            services_get_config_socket_path(service->list), NULL));
        break;
    }
}

static void
service_process_setup_environment(struct service *service, unsigned int uid)
{
    master_service_env_clean();

    env_put(MASTER_IS_PARENT_ENV"=1");
    service_process_setup_config_environment(service);
    env_put(t_strdup_printf(MASTER_CLIENT_LIMIT_ENV"=%u",
                service->client_limit));
    env_put(t_strdup_printf(MASTER_PROCESS_LIMIT_ENV"=%u",
                service->process_limit));
    if (service->set->service_count != 0) {
        env_put(t_strdup_printf(MASTER_SERVICE_COUNT_ENV"=%u",
                    service->set->service_count));
    }
    env_put(t_strdup_printf(MASTER_UID_ENV"=%u", uid));

    if (!service->set->master_set->version_ignore)
        env_put(MASTER_DOVECOT_VERSION_ENV"="PACKAGE_VERSION);

    if (ssl_manual_key_password != NULL && service->have_inet_listeners) {
        /* manually given SSL password. give it only to services
           that have inet listeners. */
        env_put(t_strconcat(MASTER_SSL_KEY_PASSWORD_ENV"=",
                    ssl_manual_key_password, NULL));
    }
    if (service->type == SERVICE_TYPE_ANVIL &&
        service_anvil_global->restarted)
        env_put("ANVIL_RESTARTED=1");
}

static void service_process_status_timeout(struct service_process *process)
{
    service_error(process->service,
              "Initial status notification not received in %d "
              "seconds, killing the process",
              SERVICE_FIRST_STATUS_TIMEOUT_SECS);
    if (kill(process->pid, SIGKILL) < 0 && errno != ESRCH) {
        service_error(process->service, "kill(%s, SIGKILL) failed: %m",
                  dec2str(process->pid));
    }
    timeout_remove(&process->to_status);
}

struct service_process *service_process_create(struct service *service)
{
    static unsigned int uid_counter = 0;
    struct service_process *process;
    unsigned int uid = ++uid_counter;
    pid_t pid;
    bool process_forked;

    i_assert(service->status_fd[0] != -1);

    if (service->to_throttle != NULL) {
        /* throttling service, don't create new processes */
        return NULL;
    }
    if (service->list->destroying) {
        /* these services are being destroyed, no point in creating
           new processes now */
        return NULL;
    }

    if (service->type == SERVICE_TYPE_ANVIL &&
        service_anvil_global->pid != 0) {
        pid = service_anvil_global->pid;
        uid = service_anvil_global->uid;
        process_forked = FALSE;
    } else {
        pid = fork();
        process_forked = TRUE;
    }

    if (pid < 0) {
        service_error(service, "fork() failed: %m");
        return NULL;
    }
    if (pid == 0) {
        /* child */
        service_process_setup_environment(service, uid);
        service_dup_fds(service);
        drop_privileges(service);
        process_exec(service->executable, NULL);
    }

    process = i_new(struct service_process, 1);
    process->service = service;
    process->refcount = 1;
    process->pid = pid;
    process->uid = uid;
    if (process_forked) {
        process->to_status =
            timeout_add(SERVICE_FIRST_STATUS_TIMEOUT_SECS * 1000,
                    service_process_status_timeout, process);
    }

    process->available_count = service->client_limit;
    service->process_count++;
    service->process_avail++;
    DLLIST_PREPEND(&service->processes, process);

    service_list_ref(service->list);
    hash_table_insert(service_pids, &process->pid, process);

    if (service->type == SERVICE_TYPE_ANVIL && process_forked)
        service_anvil_process_created(process);
    return process;
}

void service_process_destroy(struct service_process *process)
{
    struct service *service = process->service;
    struct service_list *service_list = service->list;

    DLLIST_REMOVE(&service->processes, process);
    hash_table_remove(service_pids, &process->pid);

    if (process->available_count > 0)
        service->process_avail--;
    service->process_count--;
    i_assert(service->process_avail <= service->process_count);

    if (process->to_status != NULL)
        timeout_remove(&process->to_status);
    if (process->to_idle != NULL)
        timeout_remove(&process->to_idle);
    if (service->list->log_byes != NULL)
        service_process_notify_add(service->list->log_byes, process);

    process->destroyed = TRUE;
    service_process_unref(process);

    if (service->process_count < service->process_limit &&
        service->type == SERVICE_TYPE_LOGIN)
        service_login_notify(service, FALSE);

    service_list_unref(service_list);
}

void service_process_ref(struct service_process *process)
{
    i_assert(process->refcount > 0);

    process->refcount++;
}

int service_process_unref(struct service_process *process)
{
    i_assert(process->refcount > 0);

    if (--process->refcount > 0)
        return TRUE;

    i_assert(process->destroyed);

    i_free(process);
    return FALSE;
}

static const char *
get_exit_status_message(struct service *service, enum fatal_exit_status status)
{
    switch (status) {
    case FATAL_LOGOPEN:
        return "Can't open log file";
    case FATAL_LOGWRITE:
        return "Can't write to log file";
    case FATAL_LOGERROR:
        return "Internal logging error";
    case FATAL_OUTOFMEM:
        if (service->vsz_limit == 0)
            return "Out of memory";
        return t_strdup_printf("Out of memory (service %s { vsz_limit=%u MB }, "
                "you may need to increase it)",
                service->set->name,
                (unsigned int)(service->vsz_limit/1024/1024));
    case FATAL_EXEC:
        return "exec() failed";

    case FATAL_DEFAULT:
        return "Fatal failure";
    }

    return NULL;
}

static void
log_coredump(struct service *service, string_t *str, int status)
{
#ifdef WCOREDUMP
    int signum = WTERMSIG(status);

    if (WCOREDUMP(status)) {
        str_append(str, " (core dumped)");
        return;
    }

    if (signum != SIGABRT && signum != SIGSEGV && signum != SIGBUS)
        return;

    /* let's try to figure out why we didn't get a core dump */
    if (core_dumps_disabled) {
        str_printfa(str, " (core dumps disabled)");
        return;
    }

#ifndef HAVE_PR_SET_DUMPABLE
    if (!service->set->drop_priv_before_exec && service->uid != 0) {
        str_printfa(str, " (core not dumped - set service %s "
                "{ drop_priv_before_exec=yes })",
                service->set->name);
        return;
    }
    if (*service->set->privileged_group != '\0' && service->uid != 0) {
        str_printfa(str, " (core not dumped - service %s "
                "{ privileged_group } prevented it)",
                service->set->name);
        return;
    }
#else
    if (!service->set->login_dump_core &&
        service->type == SERVICE_TYPE_LOGIN) {
        str_printfa(str, " (core not dumped - add -D parameter to "
                "service %s { executable }", service->set->name);
        return;
    }
#endif

    str_append(str, " (core not dumped)");
#endif
}

static void
service_process_get_status_error(string_t *str, struct service_process *process,
                 int status, bool *default_fatal_r)
{
    struct service *service = process->service;
    const char *msg;

    *default_fatal_r = FALSE;

    str_printfa(str, "service(%s): child %s ", service->set->name,
            dec2str(process->pid));
    if (WIFSIGNALED(status)) {
        str_printfa(str, "killed with signal %d", WTERMSIG(status));
        log_coredump(service, str, status);
        return;
    }
    if (!WIFEXITED(status)) {
        str_printfa(str, "died with status %d", status);
        return;
    }

    status = WEXITSTATUS(status);
    if (status == 0) {
        str_truncate(str, 0);
        return;
    }
    str_printfa(str, "returned error %d", status);

    msg = get_exit_status_message(service, status);
    if (msg != NULL)
        str_printfa(str, " (%s)", msg);

    if (status == FATAL_DEFAULT)
        *default_fatal_r = TRUE;
}

static void service_process_log(struct service_process *process,
                bool default_fatal, const char *str)
{
    const char *data;

    if (process->service->log_fd[1] == -1) {
        i_error("%s", str);
        return;
    }

    /* log it via the log process in charge of handling
       this process's logging */
    data = t_strdup_printf("%d %s %s %s\n",
                   process->service->log_process_internal_fd,
                   dec2str(process->pid),
                   default_fatal ? "DEFAULT-FATAL" : "FATAL", str);
    if (write(process->service->list->master_log_fd[1],
          data, strlen(data)) < 0) {
        i_error("write(log process) failed: %m");
        i_error("%s", str);
    }
}

void service_process_log_status_error(struct service_process *process,
                      int status)
{
    if (WIFEXITED(status) && WEXITSTATUS(status) == 0) {
        /* fast path */
        return;
    }
    T_BEGIN {
        string_t *str = t_str_new(256);
        bool default_fatal;

        service_process_get_status_error(str, process, status,
                         &default_fatal);
        if (str_len(str) > 0)
            service_process_log(process, default_fatal, str_c(str));
    } T_END;
}