]> code.citadel.org Git - citadel.git/blobdiff - citadel/sysdep.c
* Added support for protocols over Unix domain sockets.
[citadel.git] / citadel / sysdep.c
index e3421191171896538adbefb338bf0dc55d8d71d8..59de2f8b5ab682cd8b091a26539ab1c3dfb76933 100644 (file)
@@ -26,6 +26,7 @@
 #include <limits.h>
 #include <netinet/in.h>
 #include <netdb.h>
+#include <sys/un.h>
 #include <string.h>
 #include <pwd.h>
 #include <errno.h>
@@ -64,7 +65,6 @@ struct TheHeap *heap = NULL;
 pthread_mutex_t Critters[MAX_SEMAPHORES];      /* Things needing locking */
 pthread_key_t MyConKey;                                /* TSD key for MyContext() */
 
-int msock;                                     /* master listening socket */
 int verbosity = DEFAULT_VERBOSITY;             /* Logging level */
 
 struct CitContext masterCC;
@@ -73,6 +73,12 @@ time_t last_purge = 0;                               /* Last dead session purge */
 int num_threads = 0;                           /* Current number of threads */
 int num_sessions = 0;                          /* Current number of sessions */
 
+fd_set masterfds;                              /* Master sockets etc. */
+int masterhighest;
+
+time_t last_timer = 0L;                                /* Last timer hook processing */
+
+
 /*
  * lprintf()  ...   Write logging information
  */
@@ -236,6 +242,7 @@ void init_sysdep(void) {
  */
 void begin_critical_section(int which_one)
 {
+       /* lprintf(9, "begin_critical_section(%d)\n", which_one); */
        pthread_mutex_lock(&Critters[which_one]);
 }
 
@@ -244,6 +251,7 @@ void begin_critical_section(int which_one)
  */
 void end_critical_section(int which_one)
 {
+       /* lprintf(9, "end_critical_section(%d)\n", which_one); */
        pthread_mutex_unlock(&Critters[which_one]);
 }
 
@@ -252,43 +260,70 @@ void end_critical_section(int which_one)
 /*
  * This is a generic function to set up a master socket for listening on
  * a TCP port.  The server shuts down if the bind fails.
+ *
+ * If a negative number is specified, a Unix domain socket is created.
  */
 int ig_tcp_server(int port_number, int queue_len)
 {
        struct sockaddr_in sin;
+       struct sockaddr_un addr;
        int s, i;
+       int is_unix = 0;
 
-       memset(&sin, 0, sizeof(sin));
-       sin.sin_family = AF_INET;
-       sin.sin_addr.s_addr = INADDR_ANY;
+       if (port_number < 0) {
+               is_unix = 1;
+       }
 
-       if (port_number == 0) {
-               lprintf(1,
-                       "citserver: No port number specified.  Run setup.\n");
-               exit(1);
+       if (is_unix) {
+               memset(&addr, 0, sizeof(addr));
+               addr.sun_family = AF_UNIX;
+               sprintf(addr.sun_path, USOCKPATH, 0-port_number);
+       }
+       else {
+               memset(&sin, 0, sizeof(sin));
+               sin.sin_family = AF_INET;
+               sin.sin_addr.s_addr = INADDR_ANY;
+               sin.sin_port = htons((u_short)port_number);
+       }
+
+       if (is_unix) {
+               s = socket(AF_UNIX, SOCK_STREAM, 0);
+       }
+       else {
+               s = socket(PF_INET, SOCK_STREAM,
+                       (getprotobyname("tcp")->p_proto));
        }
-       
-       sin.sin_port = htons((u_short)port_number);
 
-       s = socket(PF_INET, SOCK_STREAM, (getprotobyname("tcp")->p_proto));
        if (s < 0) {
                lprintf(1, "citserver: Can't create a socket: %s\n",
                        strerror(errno));
-               exit(errno);
+               return(-1);
        }
 
        /* Set the SO_REUSEADDR socket option, because it makes sense. */
-       i = 1;
-       setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
+       if (!is_unix) {
+               i = 1;
+               setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
+       }
 
-       if (bind(s, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
-               lprintf(1, "citserver: Can't bind: %s\n", strerror(errno));
-               exit(errno);
+       if (is_unix) {
+               if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
+                       lprintf(1, "citserver: Can't bind: %s\n",
+                               strerror(errno));
+                       return(-1);
+               }
+       }
+       else {
+               if (bind(s, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
+                       lprintf(1, "citserver: Can't bind: %s\n",
+                               strerror(errno));
+                       return(-1);
+               }
        }
 
        if (listen(s, queue_len) < 0) {
                lprintf(1, "citserver: Can't listen: %s\n", strerror(errno));
-               exit(errno);
+               return(-1);
        }
 
        return(s);
@@ -361,13 +396,27 @@ void client_write(char *buf, int nbytes)
 {
        int bytes_written = 0;
        int retval;
+       int sock;
+
+       if (CC->redirect_fp != NULL) {
+               fwrite(buf, nbytes, 1, CC->redirect_fp);
+               return;
+       }
+
+       if (CC->redirect_sock > 0) {
+               sock = CC->redirect_sock;       /* and continue below... */
+       }
+       else {
+               sock = CC->client_socket;
+       }
+
        while (bytes_written < nbytes) {
-               retval = write(CC->client_socket, &buf[bytes_written],
+               retval = write(sock, &buf[bytes_written],
                        nbytes - bytes_written);
                if (retval < 1) {
                        lprintf(2, "client_write() failed: %s\n",
                                strerror(errno));
-                       CC->kill_me = 1;
+                       if (sock == CC->client_socket) CC->kill_me = 1;
                        return;
                }
                bytes_written = bytes_written + retval;
@@ -481,8 +530,25 @@ int client_gets(char *buf)
  * The system-dependent part of master_cleanup() - close the master socket.
  */
 void sysdep_master_cleanup(void) {
-       lprintf(7, "Closing master socket %d\n", msock);
-       close(msock);
+       struct ServiceFunctionHook *serviceptr;
+       char sockpath[256];
+
+       /*
+        * close all protocol master sockets
+        */
+       for (serviceptr = ServiceHookTable; serviceptr != NULL;
+           serviceptr = serviceptr->next ) {
+               lprintf(3, "Closing listener on port %d\n",
+                       serviceptr->tcp_port);
+               close(serviceptr->msock);
+
+               /* If it's a Unix domain socket, remove the file. */
+               if (serviceptr->tcp_port < 0) {
+                       sprintf(sockpath, USOCKPATH, 0-(serviceptr->tcp_port));
+                       lprintf(9, "Removing <%s>\n", sockpath);
+                       unlink(sockpath);
+               }
+       }
 }
 
 
@@ -677,7 +743,35 @@ void dead_session_purge(void) {
 }
 
 
-       
+
+
+
+/*
+ * Redirect a session's output to a file or socket.
+ * This function may be called with a file handle *or* a socket (but not
+ * both).  Call with neither to return output to its normal client socket.
+ */
+void CtdlRedirectOutput(FILE *fp, int sock) {
+
+       if (fp != NULL) CC->redirect_fp = fp;
+       else CC->redirect_fp = NULL;
+
+       if (sock > 0) CC->redirect_sock = sock;
+       else CC->redirect_sock = (-1);
+
+}
+
+
+/*
+ * masterCC is the context we use when not attached to a session.  This
+ * function initializes it.
+ */
+void InitializeMasterCC(void) {
+       memset(&masterCC, 0, sizeof(struct CitContext));
+       masterCC.internal_pgm = 1;
+}
+
+
 
 /*
  * Here's where it all begins.
@@ -691,10 +785,14 @@ int main(int argc, char **argv)
        struct passwd *pw;
        int drop_root_perms = 1;
        char *moddir;
+       struct ServiceFunctionHook *serviceptr;
         
        /* specify default port name and trace file */
        strcpy(tracefile, "");
 
+       /* initialize the master context */
+       InitializeMasterCC();
+
        /* parse command-line arguments */
        for (a=1; a<argc; ++a) {
 
@@ -761,16 +859,64 @@ int main(int argc, char **argv)
        get_config();
 
        /*
-        * Bind the server to our favourite port.
-        * There is no need to check for errors, because ig_tcp_server()
-        * exits if it doesn't succeed.
+        * Do non system dependent startup functions.
+        */
+       master_startup();
+
+       /*
+        * Bind the server to our favorite ports.
+        */
+       CtdlRegisterServiceHook(config.c_port_number,           /* TCP */
+                               citproto_begin_session,
+                               do_command_loop);
+       CtdlRegisterServiceHook(0-config.c_port_number,         /* Unix */
+                               citproto_begin_session,
+                               do_command_loop);
+
+       /*
+        * Load any server-side modules (plugins) available here.
+        */
+       lprintf(7, "Initializing loadable modules\n");
+       if ((moddir = malloc(strlen(bbs_home_directory) + 9)) != NULL) {
+               sprintf(moddir, "%s/modules", bbs_home_directory);
+               DLoader_Init(moddir);
+               free(moddir);
+       }
+
+       /*
+        * The rescan pipe exists so that worker threads can be woken up and
+        * told to re-scan the context list for fd's to listen on.  This is
+        * necessary, for example, when a context is about to go idle and needs
+        * to get back on that list.
         */
-       lprintf(7, "Attempting to bind to port %d...\n", config.c_port_number);
-       msock = ig_tcp_server(config.c_port_number, 5);
-       lprintf(7, "Listening on socket %d\n", msock);
+       if (pipe(rescan)) {
+               lprintf(1, "Can't create rescan pipe!\n");
+               exit(errno);
+       }
 
        /*
-        * Now that we've bound the socket, change to the BBS user id and its
+        * Set up a fd_set containing all the master sockets to which we
+        * always listen.  It's computationally less expensive to just copy
+        * this to a local fd_set when starting a new select() and then add
+        * the client sockets than it is to initialize a new one and then
+        * figure out what to put there.
+        */
+       FD_ZERO(&masterfds);
+       masterhighest = 0;
+       FD_SET(rescan[0], &masterfds);
+       if (rescan[0] > masterhighest) masterhighest = rescan[0];
+
+       for (serviceptr = ServiceHookTable; serviceptr != NULL;
+           serviceptr = serviceptr->next ) {
+               FD_SET(serviceptr->msock, &masterfds);
+               if (serviceptr->msock > masterhighest) {
+                       masterhighest = serviceptr->msock;
+               }
+       }
+
+
+       /*
+        * Now that we've bound the sockets, change to the BBS user id and its
         * corresponding group ids
         */
        if (drop_root_perms) {
@@ -791,20 +937,8 @@ int main(int argc, char **argv)
        }
 
        /*
-        * Do non system dependent startup functions.
-        */
-       master_startup();
-
-       /*
-        * Load any server-side modules (plugins) available here.
+        * Create the housekeeper thread
         */
-       lprintf(7, "Initializing loadable modules\n");
-       if ((moddir = malloc(strlen(bbs_home_directory) + 9)) != NULL) {
-               sprintf(moddir, "%s/modules", bbs_home_directory);
-               DLoader_Init(moddir);
-               free(moddir);
-       }
-
        lprintf(7, "Starting housekeeper thread\n");
        pthread_attr_init(&attr);
                pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
@@ -815,17 +949,6 @@ int main(int argc, char **argv)
        }
 
 
-       /*
-        * The rescan pipe exists so that worker threads can be woken up and
-        * told to re-scan the context list for fd's to listen on.  This is
-        * necessary, for example, when a context is about to go idle and needs
-        * to get back on that list.
-        */
-       if (pipe(rescan)) {
-               lprintf(1, "Can't create rescan pipe!\n");
-               exit(errno);
-       }
-
        /*
         * Now create a bunch of worker threads.
         */
@@ -846,8 +969,12 @@ int main(int argc, char **argv)
 }
 
 
-
-
+/*
+ * Bind a thread to a context.
+ */
+inline void become_session(struct CitContext *which_con) {
+       pthread_setspecific(MyConKey, (void *)which_con );
+}
 
 
 
@@ -857,18 +984,20 @@ int main(int argc, char **argv)
 void worker_thread(void) {
        int i;
        char junk;
-       int numselect = 0;
        int highest;
        struct CitContext *ptr;
        struct CitContext *bind_me = NULL;
        fd_set readfds;
        int retval;
        struct CitContext *con= NULL;   /* Temporary context pointer */
+       struct ServiceFunctionHook *serviceptr;
        struct sockaddr_in fsin;        /* Data for master socket */
        int alen;                       /* Data for master socket */
        int ssock;                      /* Descriptor for client socket */
+       struct timeval tv;
 
        ++num_threads;
+
        while (!time_to_die) {
 
                /* 
@@ -882,25 +1011,21 @@ void worker_thread(void) {
                 */
 
                begin_critical_section(S_I_WANNA_SELECT);
-SETUP_FD:      FD_ZERO(&readfds);
-               FD_SET(msock, &readfds);
-               highest = msock;
-               FD_SET(rescan[0], &readfds);
-               if (rescan[0] > highest) highest = rescan[0];
-               numselect = 2;
-
+SETUP_FD:      memcpy(&readfds, &masterfds, sizeof(fd_set) );
+               highest = masterhighest;
                begin_critical_section(S_SESSION_TABLE);
                for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
                        if (ptr->state == CON_IDLE) {
                                FD_SET(ptr->client_socket, &readfds);
                                if (ptr->client_socket > highest)
                                        highest = ptr->client_socket;
-                               ++numselect;
                        }
                }
                end_critical_section(S_SESSION_TABLE);
 
-               retval = select(highest + 1, &readfds, NULL, NULL, NULL);
+               tv.tv_sec = 60;         /* wake up every minute if no input */
+               tv.tv_usec = 0;
+               retval = select(highest + 1, &readfds, NULL, NULL, &tv);
 
                /* Now figure out who made this select() unblock.
                 * First, check for an error or exit condition.
@@ -914,36 +1039,45 @@ SETUP_FD:        FD_ZERO(&readfds);
                /* Next, check to see if it's a new client connecting
                 * on the master socket.
                 */
-               else if (FD_ISSET(msock, &readfds)) {
-                       alen = sizeof fsin;
-                       ssock = accept(msock, (struct sockaddr *)&fsin, &alen);
-                       if (ssock < 0) {
-                               lprintf(2, "citserver: accept() failed: %s\n",
-                                       strerror(errno));
-                       }
-                       else {
-                               lprintf(7, "citserver: New client socket %d\n",
-                                       ssock);
-
-                               /* New context will be created already set up
-                                * in the CON_EXECUTING state.
-                                */
-                               con = CreateNewContext();
-
-                               /* Assign our new socket number to it. */
-                               con->client_socket = ssock;
+               else for (serviceptr = ServiceHookTable; serviceptr != NULL;
+                    serviceptr = serviceptr->next ) {
+
+                       if (FD_ISSET(serviceptr->msock, &readfds)) {
+                               alen = sizeof fsin;
+                               ssock = accept(serviceptr->msock,
+                                       (struct sockaddr *)&fsin, &alen);
+                               if (ssock < 0) {
+                                       lprintf(2, "citserver: accept(): %s\n",
+                                               strerror(errno));
+                               }
+                               else {
+                                       lprintf(7, "citserver: "
+                                               "New client socket %d\n",
+                                               ssock);
+
+                                       /* New context will be created already
+                                       * set up in the CON_EXECUTING state.
+                                       */
+                                       con = CreateNewContext();
+
+                                       /* Assign new socket number to it. */
+                                       con->client_socket = ssock;
+                                       con->h_command_function =
+                                               serviceptr->h_command_function;
        
-                               /* Set the SO_REUSEADDR socket option */
-                               i = 1;
-                               setsockopt(ssock, SOL_SOCKET, SO_REUSEADDR,
-                                       &i, sizeof(i));
-
-                               pthread_setspecific(MyConKey, (void *)con);
-                               begin_session(con);
-                               /* do_command_loop(); */
-                               pthread_setspecific(MyConKey, (void *)NULL);
-                               con->state = CON_IDLE;
-                               goto SETUP_FD;
+                                       /* Set the SO_REUSEADDR socket option */
+                                       i = 1;
+                                       setsockopt(ssock, SOL_SOCKET,
+                                               SO_REUSEADDR,
+                                               &i, sizeof(i));
+
+                                       become_session(con);
+                                       begin_session(con);
+                                       serviceptr->h_greeting_function();
+                                       become_session(NULL);
+                                       con->state = CON_IDLE;
+                                       goto SETUP_FD;
+                               }
                        }
                }
 
@@ -951,7 +1085,7 @@ SETUP_FD:  FD_ZERO(&readfds);
                 * thread that the &readfds needs to be refreshed with more
                 * current data.
                 */
-               else if (FD_ISSET(rescan[0], &readfds)) {
+               if (!time_to_die) if (FD_ISSET(rescan[0], &readfds)) {
                        read(rescan[0], &junk, 1);
                        goto SETUP_FD;
                }
@@ -982,21 +1116,22 @@ SETUP_FD:        FD_ZERO(&readfds);
 
                        /* We're bound to a session, now do *one* command */
                        if (bind_me != NULL) {
-                               pthread_setspecific(MyConKey, (void *)bind_me);
-                               do_command_loop();
-                               pthread_setspecific(MyConKey, (void *)NULL);
+                               become_session(bind_me);
+                               CC->h_command_function();
+                               become_session(NULL);
                                bind_me->state = CON_IDLE;
                                if (bind_me->kill_me == 1) {
                                        RemoveContext(bind_me);
                                } 
                                write(rescan[1], &junk, 1);
                        }
-                       else {
-                               lprintf(9, "Thread found nothing to do!\n");
-                       }
 
                }
                dead_session_purge();
+               if ((time(NULL) - last_timer) > 60L) {
+                       last_timer = time(NULL);
+                       PerformSessionHooks(EVT_TIMER);
+               }
        }
 
        /* If control reaches this point, the server is shutting down */