doxify acl.c.
[paraslash.git] / server.c
index bf4ed37..1022035 100644 (file)
--- a/server.c
+++ b/server.c
@@ -1,17 +1,64 @@
 /*
- * Copyright (C) 1997-2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 1997-2008 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file server.c Paraslash's main server */
+/** \file server.c Paraslash's main server. */
 
 
-/** \mainpage Paraslash API Reference
+/**
+ * \mainpage Paraslash API Reference
+ *
+ * Starting points for getting an overview are
+ *
+ * probably:
+ *
+ *     - The main programs: \ref server.c, \ref audiod.c, \ref client.c,
+ *       \ref audioc.c, \ref fsck.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.
+ *
+ *
+ * The gory details, listed by topic:
  *
- *  Good starting points for reading are probably \ref audio_file_selector,
- *  \ref sender, \ref receiver, \ref receiver_node, \ref filter, \ref
- *  filter_node.
+ *     - 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,
+ *     - 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,
+ *     - dccp: \ref dccp_recv.c, \ref dccp_send.c,
+ *     - Audio file selector: \ref afs.c, \ref aft.c, \ref mood.c,
+ *     - Afs structures: \ref afs_table, \ref audio_file_data,
+ *       \ref afs_info \ref afh_info,
+ *     - Afs tables: \ref aft.c, \ref mood.c, \ref playlist.c,
+ *       \ref attribute.c, \ref score.c,
+ *     - The virtual streaming system: \ref vss.c, \ref chunk_queue.c.
+ *
+ * Lower levels:
+ *
+ *     - Scheduling: \ref sched.c, \ref sched.h,
+ *     - Networking: \ref net.c,
+ *     - File descriptors: \ref fd.c,
+ *     - Signals: \ref signal.c,
+ *     - Daemons: \ref daemon.c,
+ *     - Strings: \ref string.c, \ref string.h,
+ *     - Time: \ref time.c,
+ *     - Spawning processes: \ref exec.c,
+ *     - Inter process communication: \ref ipc.c,
+ *     - The object storage layer: \ref osl.c,
+ *     - Blob tables: \ref blob.c,
+ *     - The error subssystem: \ref error.h.
+ *
+ * Low-level data structures:
+ *
+ *     - Doubly linked lists: \ref list.h,
+ *     - Red-black trees: \ref rbtree.h, \ref rbtree.c,
+ *     - Ring buffer: \ref ringbuffer.c, \ref ringbuffer.h,
+ *     - Hashing: \ref hash.h, \ref sha1.h, \ref sha1.c,
+ *     - Crypto: \ref crypt.c.
  *
  */
 
@@ -46,16 +93,16 @@ INIT_SERVER_ERRLISTS;
 #define ALARM_TIMEOUT 10
 
 /**
- * pointer to shared memory area for communication between para_server
- * and its children. exported to vss.c. command.c and to all selectors.
+ * Pointer to shared memory area for communication between para_server
+ * and its children. Exported to vss.c. command.c and to afs.
  */
 struct misc_meta_data *mmd;
 
 /**
  * the configuration of para_server
  *
- * It also contains the options for all audio file selectors, audio format handler
- * and all supported senders.
+ * It also contains the options for the audio file selector, audio format
+ * handler and all supported senders.
  */
 struct server_args_info conf;
 
@@ -119,7 +166,7 @@ void para_log(int ll, const char* fmt,...)
                fprintf(outfd, "%i: ", ll);
        mypid = getpid();
        if (conf.loglevel_arg <= INFO)
-               fprintf(outfd, "(%d) ", mypid);
+               fprintf(outfd, "(%d) ", (int)mypid);
        va_start(argp, fmt);
        vfprintf(outfd, fmt, argp);
        va_end(argp);
@@ -147,27 +194,24 @@ static void shm_init(void)
                goto err_out;
        mmd_mutex = ret;
 
-       mmd->selector_num = 0;
        mmd->num_played = 0;
        mmd->num_commands = 0;
        mmd->events = 0;
        mmd->num_connects = 0;
        mmd->active_connections = 0;
-       strcpy(mmd->filename, "(none)");
-       mmd->audio_format = -1;
        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", para_strerror(-ret));
        exit(EXIT_FAILURE);
 }
 
 /**
  * lock the shared memory area containing the mmd struct
  *
- * \sa semop(2), struct misc_meta_data
+ * \sa semop(2), struct misc_meta_data.
  */
 void mmd_lock(void)
 {
@@ -193,7 +237,7 @@ static void parse_config(int override)
        char *cf;
 
        if (conf.config_file_given)
-               cf = conf.config_file_arg;
+               cf = para_strdup(conf.config_file_arg);
        else
                cf = make_message("%s/.paraslash/server.conf", home);
        free(user_list_file);
@@ -239,35 +283,42 @@ out:
 
 static void setup_signal_handling(void)
 {
-       int ret = 0;
-
-       signal_pipe = para_signal_init();
-       PARA_NOTICE_LOG("%s", "setting up signal handlers\n");
-       ret += para_install_sighandler(SIGINT);
-       ret += para_install_sighandler(SIGTERM);
-       ret += para_install_sighandler(SIGHUP);
-       ret += para_install_sighandler(SIGCHLD);
-       ret += para_install_sighandler(SIGUSR1);
-       signal(SIGPIPE, SIG_IGN);
-       if (ret != 5) {
-               PARA_EMERG_LOG("%s", "could not install signal handlers\n");
-               exit(EXIT_FAILURE);
-       }
+       signal_pipe = para_signal_init(); /* always successful */
+
+       PARA_NOTICE_LOG("setting up signal handlers\n");
+       if (para_install_sighandler(SIGINT) < 0)
+               goto err;
+       if (para_install_sighandler(SIGTERM) < 0)
+               goto err;
+       if (para_install_sighandler(SIGHUP) < 0)
+               goto err;
+       if (para_install_sighandler(SIGCHLD) < 0)
+               goto err;
+       if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
+               goto err;
+       if (signal(SIGUSR1, SIG_IGN) == SIG_ERR)
+               goto err;
+       add_close_on_fork_list(signal_pipe);
+       return;
+err:
+       PARA_EMERG_LOG("could not install signal handlers\n");
+       exit(EXIT_FAILURE);
 }
 
 static unsigned init_network(void)
 {
-       int fd, ret = init_tcp_socket(conf.port_arg);
+       int fd, ret = para_listen(AF_UNSPEC, IPPROTO_TCP, conf.port_arg);
 
        if (ret < 0)
                goto err;
        fd = ret;
-       ret = mark_fd_nonblock(fd);
+       ret = mark_fd_nonblocking(fd);
        if (ret < 0)
                goto err;
+       add_close_on_fork_list(fd); /* child doesn't need the listener */
        return fd;
 err:
-       PARA_EMERG_LOG("%s\n", PARA_STRERROR(-ret));
+       PARA_EMERG_LOG("%s\n", para_strerror(-ret));
        exit(EXIT_FAILURE);
 }
 
@@ -316,7 +367,7 @@ static void init_afs(void)
        }
        close(afs_server_socket[1]);
        afs_socket = afs_server_socket[0];
-       ret = mark_fd_nonblock(afs_socket);
+       ret = mark_fd_nonblocking(afs_socket);
        if (ret < 0)
                exit(EXIT_FAILURE);
        add_close_on_fork_list(afs_socket);
@@ -325,7 +376,7 @@ static void init_afs(void)
 }
 
 
-static unsigned do_inits(int argc, char **argv)
+static unsigned server_init(int argc, char **argv)
 {
        /* connector's address information */
        int sockfd;
@@ -344,19 +395,19 @@ static unsigned do_inits(int argc, char **argv)
        /* become daemon */
        if (conf.daemon_given)
                daemon_init();
-//     init_selector();
-//     PARA_ERROR_LOG("num: %d\n", mmd->selector_num);
-       PARA_NOTICE_LOG("%s", "initializing virtual streaming system\n");
+       PARA_NOTICE_LOG("initializing audio format handlers\n");
        afh_init();
+       PARA_NOTICE_LOG("initializing virtual streaming system\n");
        vss_init();
        mmd->server_pid = getpid();
        setup_signal_handling();
+       PARA_NOTICE_LOG("initializing the audio file selector\n");
        init_afs();
        mmd_lock();
        /* init network socket */
-       PARA_NOTICE_LOG("%s", "initializing tcp command socket\n");
+       PARA_NOTICE_LOG("initializing tcp command socket\n");
        sockfd = init_network();
-       PARA_NOTICE_LOG("%s", "init complete\n");
+       PARA_NOTICE_LOG("server init complete\n");
        return sockfd;
 }
 
@@ -391,8 +442,8 @@ out:
        prev_events = mmd->events;
        mmd->vss_status_flags = mmd->new_vss_status_flags;
        if (ret) {
-               PARA_DEBUG_LOG("%d events, forcing status update, af = %d\n",
-                       mmd->events, mmd->audio_format);
+               PARA_DEBUG_LOG("%d events, forcing status update\n",
+                       mmd->events);
                killpg(0, SIGUSR1);
        }
 }
@@ -410,14 +461,14 @@ int main(int argc, char *argv[])
 {
        /* listen on sock_fd, new connection on new_fd */
        int sockfd, new_fd;
-       struct sockaddr_in their_addr;
+       char *peer_name;
        int i, max_fileno, ret;
        pid_t chld_pid;
        fd_set rfds, wfds;
        struct timeval *timeout;
 
        valid_fd_012();
-       sockfd = do_inits(argc, argv);
+       sockfd = server_init(argc, argv);
 repeat:
        FD_ZERO(&rfds);
        FD_ZERO(&wfds);
@@ -492,11 +543,11 @@ genocide:
        if (!FD_ISSET(sockfd, &rfds))
                goto repeat;
 
-       new_fd = para_accept(sockfd, &their_addr, sizeof(struct sockaddr_in));
+       new_fd = para_accept(sockfd, NULL, 0);
        if (new_fd < 0)
                goto repeat;
-       PARA_INFO_LOG("got connection from %s, forking\n",
-               inet_ntoa(their_addr.sin_addr));
+       peer_name = remote_name(new_fd);
+       PARA_INFO_LOG("got connection from %s, forking\n", peer_name);
        mmd->num_connects++;
        mmd->active_connections++;
        random();
@@ -512,14 +563,13 @@ genocide:
        }
        alarm(ALARM_TIMEOUT);
        close_listed_fds();
-       close(sockfd); /* child doesn't need the listener */
+       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)",
-               inet_ntoa(their_addr.sin_addr));
-       return handle_connect(new_fd, &their_addr);
+       sprintf(argv[0], "para_server (serving %s)", peer_name);
+       return handle_connect(new_fd, peer_name);
 }