Merge commit 'fml/master'
[paraslash.git] / server.c
index 98e208ac39d9212d67491faf0ad69e21af785128..459f44621bb5c1f8350f2c5192edaa15362b5335 100644 (file)
--- a/server.c
+++ b/server.c
 /**
  * \mainpage Paraslash API Reference
  *
- * Starting points for getting an overview are
+ * Starting points for getting an overview:
  *
- * probably:
  *
  *     - The main programs: \ref server.c, \ref audiod.c, \ref client.c,
- *       \ref audioc.c, \ref fsck.c,
+ *       \ref audioc.c, \ref fsck.c, \ref afh.c
  *     - Server: \ref server_command, \ref sender,
  *     - Audio file selector: \ref audio_format_handler, \ref mood, \ref afs_table,
  *     - Client: \ref receiver, \ref receiver_node, \ref filter, \ref filter_node.
@@ -23,9 +22,9 @@
  *
  * The gory details, listed by topic:
  *
- *     - Audio format handlers: \ref mp3_afh.c, \ref ogg_afh.c, \ref aac_afh.c,
- *     - Decoders: \ref mp3dec.c, \ref oggdec.c, \ref aacdec.c,
- *     - Volume normalizer: \ref compress.c,
+ *     - Audio format handlers: \ref send_common.c \ref mp3_afh.c, \ref ogg_afh.c, \ref aac_afh.c,
+ *     - Decoders: \ref mp3dec_filter.c, \ref oggdec_filter.c, \ref aacdec_filter.c,
+ *     - Volume normalizer: \ref compress_filter.c,
  *     - Output: \ref alsa_write.c, \ref osx_write.c,
  *     - http: \ref http_recv.c, \ref http_send.c,
  *     - ortp: \ref ortp_recv.c, \ref ortp_send.c,
@@ -64,7 +63,6 @@
  */
 
 #include <signal.h>
-#include <sys/types.h>
 #include <dirent.h>
 
 #include "para.h"
 #include "signal.h"
 #include "user_list.h"
 
-/** define the array of error lists needed by para_server */
+/** Define the array of error lists needed by para_server. */
 INIT_SERVER_ERRLISTS;
 
-/** shut down non-authorized connections after that many seconds */
+/** Shut down non-authorized connections after that many seconds. */
 #define ALARM_TIMEOUT 10
 
 /**
@@ -100,52 +98,43 @@ INIT_SERVER_ERRLISTS;
 struct misc_meta_data *mmd;
 
 /**
- * the configuration of para_server
+ * The configuration of para_server
  *
  * It also contains the options for the audio file selector, audio format
  * handler and all supported senders.
  */
 struct server_args_info conf;
 
-/** the file containing user information (public key, permissions) */
-char *user_list_file = NULL;
-
-extern void dccp_send_init(struct sender *);
-extern void http_send_init(struct sender *);
-extern void ortp_send_init(struct sender *);
-
-/** the list of supported senders */
-struct sender senders[] = {
-       {
-               .name = "http",
-               .init = http_send_init,
-       },
-       {
-               .name = "dccp",
-               .init = dccp_send_init,
-       },
-#ifdef HAVE_ORTP
-       {
-               .name = "ortp",
-               .init = ortp_send_init,
-       },
-#endif
-       {
-               .name = NULL,
-       }
-};
+/** A random value used in child context for authentication. */
+uint32_t afs_socket_cookie;
 
+/** The mutex protecting the shared memory area containing the mmd struct. */
+int mmd_mutex;
 
 /* global variables for server-internal use */
 static FILE *logfile;
-static int mmd_mutex, mmd_shm_id;
-static int signal_pipe;
+/** The file containing user information (public key, permissions). */
+static char *user_list_file = NULL;
+static int mmd_shm_id;
+
+
+/** The task responsible for server command handling. */
+struct server_command_task {
+       /** TCP port on which para_server listens for connections. */
+       int listen_fd;
+       /** Copied from para_server's main function. */
+       int argc;
+       /** Argument vector passed to para_server's main function. */
+       char **argv;
+       /** The command task structure for scheduling. */
+       struct task task;
+};
 
 /**
- * para_server's log function
+ * Para_server's log function.
  *
- * \param ll the log level
- * \param fmt the format string describing the log message
+ * \param ll The log level.
+ * \param fmt The format string describing the log message.
  */
 void para_log(int ll, const char* fmt,...)
 {
@@ -202,34 +191,12 @@ static void shm_init(void)
        mmd->active_connections = 0;
        mmd->vss_status_flags = VSS_NEXT;
        mmd->new_vss_status_flags = VSS_NEXT;
-       mmd->sender_cmd_data.cmd_num = -1;
        return;
 err_out:
-       PARA_EMERG_LOG("%s", para_strerror(-ret));
+       PARA_EMERG_LOG("%s\n", para_strerror(-ret));
        exit(EXIT_FAILURE);
 }
 
-/**
- * lock the shared memory area containing the mmd struct
- *
- * \sa semop(2), struct misc_meta_data.
- */
-void mmd_lock(void)
-{
-       mutex_lock(mmd_mutex);
-}
-
-/**
- * unlock the shared memory area containing the mmd struct
- *
- * \sa semop(2), struct misc_meta_data
- */
-
-void mmd_unlock(void)
-{
-       mutex_unlock(mmd_mutex);
-}
-
 static void parse_config(int override)
 {
        char *home = para_homedir();
@@ -257,18 +224,13 @@ static void parse_config(int override)
                struct server_cmdline_parser_params params = {
                        .override = override,
                        .initialize = 0,
-                       .check_required = 0,
-                       .check_ambiguity = 0
+                       .check_required = 1,
+                       .check_ambiguity = 0,
+                       .print_errors = 1
                };
                server_cmdline_parser_config_file(cf, &conf, &params);
                conf.daemon_given = tmp;
        }
-       /* logfile */
-       if (!conf.logfile_given && conf.daemon_given) {
-               ret = -1;
-               PARA_EMERG_LOG("fatal: daemon option, but no log file given\n");
-               goto out;
-       }
        if (conf.logfile_given)
                logfile = open_log(conf.logfile_arg);
        ret = 1;
@@ -282,9 +244,74 @@ out:
        exit(EXIT_FAILURE);
 }
 
-static void setup_signal_handling(void)
+static void signal_pre_select(struct sched *s, struct task *t)
+{
+       struct signal_task *st = container_of(t, struct signal_task, task);
+       para_fd_set(st->fd, &s->rfds, &s->max_fileno);
+}
+
+/*
+ * called when server gets SIGHUP or when client invokes hup command.
+ */
+static void handle_sighup(void)
+{
+       PARA_NOTICE_LOG("SIGHUP\n");
+       close_log(logfile); /* gets reopened if necessary by parse_config */
+       logfile = NULL;
+       parse_config(1); /* reopens log */
+       init_user_list(user_list_file); /* reload user list */
+       if (mmd->afs_pid)
+               kill(mmd->afs_pid, SIGHUP);
+}
+
+static void signal_post_select(struct sched *s, struct task *t)
+{
+       struct signal_task *st = container_of(t, struct signal_task, task);
+
+       if (!FD_ISSET(st->fd, &s->rfds))
+               return;
+
+       st->signum = para_next_signal();
+       switch (st->signum) {
+       case SIGHUP:
+               handle_sighup();
+               break;
+       case SIGCHLD:
+               for (;;) {
+                       pid_t pid;
+                       int ret = para_reap_child(&pid);
+                       if (ret <= 0)
+                               break;
+                       if (pid != mmd->afs_pid)
+                               continue;
+                       PARA_EMERG_LOG("fatal: afs died\n");
+                       goto genocide;
+               }
+               break;
+       /* die on sigint/sigterm. Kill all children too. */
+       case SIGINT:
+       case SIGTERM:
+               PARA_EMERG_LOG("terminating on signal %d\n", st->signum);
+genocide:
+               kill(0, SIGTERM);
+               mutex_destroy(mmd_mutex);
+               shm_detach(mmd);
+               shm_destroy(mmd_shm_id);
+
+               exit(EXIT_FAILURE);
+       }
+}
+
+static void init_signal_task(void)
 {
-       signal_pipe = para_signal_init(); /* always successful */
+       static struct signal_task signal_task_struct,
+               *st = &signal_task_struct;
+
+       st->task.pre_select = signal_pre_select;
+       st->task.post_select = signal_post_select;
+       sprintf(st->task.status, "signal task");
+
+       st->fd = para_signal_init(); /* always successful */
 
        PARA_NOTICE_LOG("setting up signal handlers\n");
        if (para_install_sighandler(SIGINT) < 0)
@@ -299,25 +326,86 @@ static void setup_signal_handling(void)
                goto err;
        if (signal(SIGUSR1, SIG_IGN) == SIG_ERR)
                goto err;
-       add_close_on_fork_list(signal_pipe);
+       add_close_on_fork_list(st->fd);
+       register_task(&st->task);
        return;
 err:
        PARA_EMERG_LOG("could not install signal handlers\n");
        exit(EXIT_FAILURE);
 }
 
-static unsigned init_network(void)
+static void command_pre_select(struct sched *s, struct task *t)
+{
+       struct server_command_task *sct = container_of(t, struct server_command_task, task);
+       para_fd_set(sct->listen_fd, &s->rfds, &s->max_fileno);
+}
+
+static void command_post_select(struct sched *s, struct task *t)
+{
+       struct server_command_task *sct = container_of(t, struct server_command_task, task);
+
+       int new_fd, ret, i;
+       char *peer_name;
+       pid_t child_pid;
+
+       if (!FD_ISSET(sct->listen_fd, &s->rfds))
+               return;
+       ret = para_accept(sct->listen_fd, NULL, 0);
+       if (ret < 0)
+               goto out;
+       new_fd = ret;
+       peer_name = remote_name(new_fd);
+       PARA_INFO_LOG("got connection from %s, forking\n", peer_name);
+       mmd->num_connects++;
+       mmd->active_connections++;
+       random();
+       child_pid = fork();
+       if (child_pid < 0) {
+               ret = -ERRNO_TO_PARA_ERROR(errno);
+               goto out;
+       }
+       if (child_pid) {
+               close(new_fd);
+               /* parent keeps accepting connections */
+               return;
+       }
+       alarm(ALARM_TIMEOUT);
+       close_listed_fds();
+       para_signal_shutdown();
+       /*
+        * put info on who we are serving into argv[0] to make
+        * client ip visible in top/ps
+        */
+       for (i = sct->argc - 1; i >= 0; i--)
+               memset(sct->argv[i], 0, strlen(sct->argv[i]));
+       sprintf(sct->argv[0], "para_server (serving %s)", peer_name);
+       return handle_connect(new_fd, peer_name);
+out:
+       if (ret < 0)
+               PARA_CRIT_LOG("%s\n", para_strerror(-ret));
+}
+
+static void init_server_command_task(int argc, char **argv)
 {
-       int fd, ret = para_listen(AF_UNSPEC, IPPROTO_TCP, conf.port_arg);
+       int ret;
+       static struct server_command_task server_command_task_struct,
+               *sct = &server_command_task_struct;
 
+       PARA_NOTICE_LOG("initializing tcp command socket\n");
+       sct->task.pre_select = command_pre_select;
+       sct->task.post_select = command_post_select;
+       sct->argc = argc;
+       sct->argv = argv;
+       ret = para_listen(AF_UNSPEC, IPPROTO_TCP, conf.port_arg);
        if (ret < 0)
                goto err;
-       fd = ret;
-       ret = mark_fd_nonblocking(fd);
+       sct->listen_fd = ret;
+       ret = mark_fd_nonblocking(sct->listen_fd);
        if (ret < 0)
                goto err;
-       add_close_on_fork_list(fd); /* child doesn't need the listener */
-       return fd;
+       add_close_on_fork_list(sct->listen_fd); /* child doesn't need the listener */
+       register_task(&sct->task);
+       return;
 err:
        PARA_EMERG_LOG("%s\n", para_strerror(-ret));
        exit(EXIT_FAILURE);
@@ -352,11 +440,7 @@ err:
        exit(EXIT_FAILURE);
 }
 
-uint32_t afs_socket_cookie;
-int afs_socket;
-static pid_t afs_pid;
-
-static void init_afs(void)
+static int init_afs(void)
 {
        int ret, afs_server_socket[2];
 
@@ -364,31 +448,38 @@ static void init_afs(void)
        if (ret < 0)
                exit(EXIT_FAILURE);
        afs_socket_cookie = para_random((uint32_t)-1);
-       afs_pid = fork();
-       if (afs_pid < 0)
+       mmd->afs_pid = fork();
+       if (mmd->afs_pid < 0)
                exit(EXIT_FAILURE);
-       if (!afs_pid) { /* child (afs) */
+       if (!mmd->afs_pid) { /* child (afs) */
                close(afs_server_socket[0]);
                afs_init(afs_socket_cookie, afs_server_socket[1]);
        }
        close(afs_server_socket[1]);
-       afs_socket = afs_server_socket[0];
-       ret = mark_fd_nonblocking(afs_socket);
+       ret = mark_fd_nonblocking(afs_server_socket[0]);
        if (ret < 0)
                exit(EXIT_FAILURE);
-       add_close_on_fork_list(afs_socket);
-       PARA_INFO_LOG("afs_socket: %d, afs_socket_cookie: %u\n", afs_socket,
-               (unsigned) afs_socket_cookie);
+       add_close_on_fork_list(afs_server_socket[0]);
+       PARA_INFO_LOG("afs_socket: %d, afs_socket_cookie: %u\n",
+               afs_server_socket[0], (unsigned) afs_socket_cookie);
+       return afs_server_socket[0];
 }
 
-static unsigned server_init(int argc, char **argv)
+static void server_init(int argc, char **argv)
 {
-       /* connector's address information */
-       int sockfd;
+       struct server_cmdline_parser_params params = {
+               .override = 0,
+               .initialize = 1,
+               .check_required = 0,
+               .check_ambiguity = 0,
+               .print_errors = 1
+       };
+       int afs_socket;
 
+       valid_fd_012();
        init_random_seed();
        /* parse command line options */
-       server_cmdline_parser(argc, argv, &conf);
+       server_cmdline_parser_ext(argc, argv, &conf, &params);
        HANDLE_VERSION_FLAG("server", conf);
        para_drop_privileges(conf.user_arg, conf.group_arg);
        /* parse config file, open log and set defaults */
@@ -402,32 +493,13 @@ static unsigned server_init(int argc, char **argv)
                daemon_init();
        PARA_NOTICE_LOG("initializing audio format handlers\n");
        afh_init();
-       PARA_NOTICE_LOG("initializing virtual streaming system\n");
-       mmd->server_pid = getpid();
-       setup_signal_handling();
        PARA_NOTICE_LOG("initializing the audio file selector\n");
-       init_afs();
-       vss_init();
-       mmd_lock();
-       /* init network socket */
-       PARA_NOTICE_LOG("initializing tcp command socket\n");
-       sockfd = init_network();
+       afs_socket = init_afs();
+       init_signal_task();
+       PARA_NOTICE_LOG("initializing virtual streaming system\n");
+       init_vss_task(afs_socket);
+       init_server_command_task(argc, argv);
        PARA_NOTICE_LOG("server init complete\n");
-       return sockfd;
-}
-
-/*
- * called when server gets SIGHUP or when client invokes hup command.
- */
-static void handle_sighup(void)
-{
-       PARA_NOTICE_LOG("%s", "SIGHUP\n");
-       close_log(logfile); /* gets reopened if necessary by parse_config */
-       logfile = NULL;
-       parse_config(1); /* reopens log */
-       init_user_list(user_list_file); /* reload user list */
-       if (afs_pid)
-               kill(afs_pid, SIGHUP);
 }
 
 static void status_refresh(void)
@@ -438,10 +510,12 @@ static void status_refresh(void)
        if (prev_events != mmd->events)
                goto out;
        if (mmd->new_vss_status_flags != mmd->vss_status_flags)
-               goto out;
+               goto out_inc_events;
        if (uptime / 60 != prev_uptime / 60)
-               goto out;
-       ret = 0;
+               goto out_inc_events;
+       return;
+out_inc_events:
+       mmd->events++;
 out:
        prev_uptime = uptime;
        prev_events = mmd->events;
@@ -453,124 +527,42 @@ out:
        }
 }
 
+static int server_select(int max_fileno, fd_set *readfds, fd_set *writefds,
+               struct timeval *timeout_tv)
+{
+       int ret;
+
+       status_refresh();
+       mutex_unlock(mmd_mutex);
+       ret = para_select(max_fileno + 1, readfds, writefds, timeout_tv);
+       mutex_lock(mmd_mutex);
+       return ret;
+}
+
 /**
- * the main function of para_server
- *
- * \param argc usual argument count
- * \param argv usual argument vector
+ * The main function of para_server.
  *
- * \return EXIT_SUCCESS or EXIT_FAILURE
+ * \param argc Usual argument count.
+ * \param argv Usual argument vector.
  *
+ * \return EXIT_SUCCESS or EXIT_FAILURE.
  */
 int main(int argc, char *argv[])
 {
-       /* listen on sock_fd, new connection on new_fd */
-       int sockfd, new_fd;
-       char *peer_name;
-       int i, max_fileno, ret;
-       pid_t chld_pid;
-       fd_set rfds, wfds;
-       struct timeval *timeout;
-
-       valid_fd_012();
-       sockfd = server_init(argc, argv);
-repeat:
-       FD_ZERO(&rfds);
-       FD_ZERO(&wfds);
-       max_fileno = -1;
-       /* check socket and signal pipe in any case */
-       para_fd_set(sockfd, &rfds, &max_fileno);
-       para_fd_set(signal_pipe, &rfds, &max_fileno);
-       timeout = vss_preselect(&rfds, &wfds, &max_fileno);
-       status_refresh();
-       for (i = 0; senders[i].name; i++) {
-               if (!senders[i].pre_select)
-                       continue;
-               senders[i].pre_select(&max_fileno, &rfds, &wfds);
-       }
-       mmd_unlock();
-       ret = para_select(max_fileno + 1, &rfds, &wfds, timeout);
-       mmd_lock();
-       vss_post_select(&rfds, &wfds);
-       if (ret < 0)
-               goto repeat;
-       for (i = 0; senders[i].name; i++) {
-               if (!senders[i].post_select)
-                       continue;
-               senders[i].post_select(&rfds, &wfds);
-       }
-       vss_send_chunk();
-       status_refresh();
-       if (FD_ISSET(signal_pipe, &rfds)) {
-               int sig;
-               pid_t pid;
-               sig = para_next_signal();
-               switch (sig) {
-               case SIGHUP:
-                       handle_sighup();
-                       break;
-               case SIGCHLD:
-                       for (;;) {
-                               ret = para_reap_child(&pid);
-                               if (ret <= 0)
-                                       break;
-                               if (pid != afs_pid)
-                                       continue;
-                               PARA_EMERG_LOG("fatal: afs died\n");
-                               goto genocide;
-                       }
-                       break;
-               /* die on sigint/sigterm. Kill all children too. */
-               case SIGINT:
-               case SIGTERM:
-                       PARA_EMERG_LOG("terminating on signal %d\n", sig);
-genocide:
-                       kill(0, SIGTERM);
-                       mutex_destroy(mmd_mutex);
-                       shm_detach(mmd);
-                       shm_destroy(mmd_shm_id);
-
-                       exit(EXIT_FAILURE);
-               }
-       }
-       if (mmd->sender_cmd_data.cmd_num >= 0) {
-               int num = mmd->sender_cmd_data.cmd_num,
-                       s = mmd->sender_cmd_data.sender_num;
-
-               if (senders[s].client_cmds[num])
-                       senders[s].client_cmds[num](&mmd->sender_cmd_data);
-               mmd->sender_cmd_data.cmd_num = -1;
-       }
-       if (!FD_ISSET(sockfd, &rfds))
-               goto repeat;
-
-       new_fd = para_accept(sockfd, NULL, 0);
-       if (new_fd < 0)
-               goto repeat;
-       peer_name = remote_name(new_fd);
-       PARA_INFO_LOG("got connection from %s, forking\n", peer_name);
-       mmd->num_connects++;
-       mmd->active_connections++;
-       random();
-       chld_pid = fork();
-       if (chld_pid < 0) {
-               PARA_CRIT_LOG("%s", "fork failed\n");
-               goto repeat;
-       }
-       if (chld_pid) {
-               close(new_fd);
-               /* parent keeps accepting connections */
-               goto repeat;
+       int ret;
+       static struct sched s = {
+               .default_timeout = {
+                       .tv_sec = 1,
+                       .tv_usec = 0
+               },
+               .select_function = server_select
+       };
+       server_init(argc, argv);
+       mutex_lock(mmd_mutex);
+       ret = schedule(&s);
+       if (ret < 0) {
+               PARA_EMERG_LOG("%s\n", para_strerror(-ret));
+               exit(EXIT_FAILURE);
        }
-       alarm(ALARM_TIMEOUT);
-       close_listed_fds();
-       para_signal_shutdown();
-       /*
-        * put info on who we are serving into argv[0] to make
-        * client ip visible in top/ps
-        */
-       for (i = argc - 1; i >= 0; i--)
-               memset(argv[i], 0, strlen(argv[i]));
-       sprintf(argv[0], "para_server (serving %s)", peer_name);
-       return handle_connect(new_fd, peer_name);
+       exit(EXIT_SUCCESS);
 }