]> code.citadel.org Git - citadel.git/blobdiff - citadel/sysdep.c
* master_cleanup() now passes along an exit code from its caller to the OS.
[citadel.git] / citadel / sysdep.c
index 5925aa6137bfcc3fb267e972a80d49db8945f3b8..5b51e1286cb02f8600d3e1c57ed8304a57fd34d6 100644 (file)
 #endif
 
 #include <limits.h>
+#include <sys/resource.h>
 #include <netinet/in.h>
+#include <netinet/tcp.h>
+#include <arpa/inet.h>
 #include <netdb.h>
 #include <sys/un.h>
 #include <string.h>
@@ -95,8 +98,6 @@ time_t last_purge = 0;                                /* Last dead session purge */
 static int num_threads = 0;                    /* Current number of threads */
 int num_sessions = 0;                          /* Current number of sessions */
 
-pthread_t initial_thread;              /* tid for main() thread */
-
 int syslog_facility = (-1);
 
 
@@ -106,93 +107,68 @@ int syslog_facility = (-1);
  * Note: the variable "buf" below needs to be large enough to handle any
  * log data sent through this function.  BE CAREFUL!
  */
+extern int running_as_daemon;
+static int enable_syslog = 1;
 void lprintf(enum LogLevel loglevel, const char *format, ...) {   
        va_list arg_ptr;
+
+       if (enable_syslog) {
+               va_start(arg_ptr, format);
+                       vsyslog(loglevel, format, arg_ptr);
+               va_end(arg_ptr);
+       }
+
+       if (enable_syslog && LogHookTable == 0) return;
+
+       /* legacy output code; hooks get processed first */
        char buf[SIZ];
        va_start(arg_ptr, format);   
-       vsnprintf(buf, sizeof(buf), format, arg_ptr);   
+               vsnprintf(buf, sizeof(buf), format, arg_ptr);   
        va_end(arg_ptr);   
+       PerformLogHooks(loglevel, buf);
 
-       if (syslog_facility >= 0) {
-               if (loglevel <= verbosity) {
-                       /* Hackery -IO */
-                       if (CC && CC->cs_pid) {
-                               memmove(buf + 6, buf, sizeof(buf) - 6);
-                               snprintf(buf, 6, "[%3d]", CC->cs_pid);
-                               buf[5] = ' ';
-                       }
-                       syslog(loglevel, buf);
-               }
-       }
-       else if (loglevel <= verbosity) { 
+       if (enable_syslog || running_as_daemon) return;
+
+       /* if we run in forground and syslog is disabled, log to terminal */
+       if (loglevel <= verbosity) { 
                struct timeval tv;
-               struct tm *tim;
+               struct tm tim;
                time_t unixtime;
 
                gettimeofday(&tv, NULL);
                /* Promote to time_t; types differ on some OSes (like darwin) */
                unixtime = tv.tv_sec;
-               tim = localtime(&unixtime);
-               /*
-                * Log provides millisecond accuracy.  If you need
-                * microsecond accuracy and your OS supports it, change
-                * %03ld to %06ld and remove " / 1000" after tv.tv_usec.
-                */
-               if (CC && CC->cs_pid) {
-#if 0
-                       /* Millisecond display */
-                       fprintf(stderr,
-                               "%04d/%02d/%02d %2d:%02d:%02d.%03ld [%3d] %s",
-                               tim->tm_year + 1900, tim->tm_mon + 1,
-                               tim->tm_mday, tim->tm_hour, tim->tm_min,
-                               tim->tm_sec, (long)tv.tv_usec / 1000,
-                               CC->cs_pid, buf);
-#endif
-                       /* Microsecond display */
+               localtime_r(&unixtime, &tim);
+               if (CC->cs_pid != 0) {
                        fprintf(stderr,
                                "%04d/%02d/%02d %2d:%02d:%02d.%06ld [%3d] %s",
-                               tim->tm_year + 1900, tim->tm_mon + 1,
-                               tim->tm_mday, tim->tm_hour, tim->tm_min,
-                               tim->tm_sec, (long)tv.tv_usec,
+                               tim.tm_year + 1900, tim.tm_mon + 1,
+                               tim.tm_mday, tim.tm_hour, tim.tm_min,
+                               tim.tm_sec, (long)tv.tv_usec,
                                CC->cs_pid, buf);
                } else {
-#if 0
-                       /* Millisecond display */
-                       fprintf(stderr,
-                               "%04d/%02d/%02d %2d:%02d:%02d.%03ld %s",
-                               tim->tm_year + 1900, tim->tm_mon + 1,
-                               tim->tm_mday, tim->tm_hour, tim->tm_min,
-                               tim->tm_sec, (long)tv.tv_usec / 1000, buf);
-#endif
-                       /* Microsecond display */
                        fprintf(stderr,
                                "%04d/%02d/%02d %2d:%02d:%02d.%06ld %s",
-                               tim->tm_year + 1900, tim->tm_mon + 1,
-                               tim->tm_mday, tim->tm_hour, tim->tm_min,
-                               tim->tm_sec, (long)tv.tv_usec, buf);
+                               tim.tm_year + 1900, tim.tm_mon + 1,
+                               tim.tm_mday, tim.tm_hour, tim.tm_min,
+                               tim.tm_sec, (long)tv.tv_usec, buf);
                }
                fflush(stderr);
        }
-
-       PerformLogHooks(loglevel, buf);
 }   
 
 
 
 /*
- * We used to use master_cleanup() as a signal handler to shut down the server.
- * however, master_cleanup() and the functions it calls do some things that
- * aren't such a good idea to do from a signal handler: acquiring mutexes,
- * playing with signal masks on BSDI systems, etc. so instead we install the
- * following signal handler to set a global variable to inform the main loop
- * that it's time to call master_cleanup() and exit.
+ * Signal handler to shut down the server.
  */
 
 volatile int time_to_die = 0;
 
 static RETSIGTYPE signal_cleanup(int signum) {
+       lprintf(CTDL_DEBUG, "Caught signal %d; shutting down.\n", signum);
        time_to_die = 1;
+       master_cleanup(signum);
 }
 
 
@@ -200,15 +176,27 @@ static RETSIGTYPE signal_cleanup(int signum) {
  * Some initialization stuff...
  */
 void init_sysdep(void) {
-       int a;
+       int i;
+
+       /* Avoid vulnerabilities related to FD_SETSIZE if we can. */
+#ifdef FD_SETSIZE
+#ifdef RLIMIT_NOFILE
+       struct rlimit rl;
+       getrlimit(RLIMIT_NOFILE, &rl);
+       rl.rlim_cur = FD_SETSIZE;
+       rl.rlim_max = FD_SETSIZE;
+       setrlimit(RLIMIT_NOFILE, &rl);
+#endif
+#endif
 
+       /* If we've got OpenSSL, we're going to use it. */
 #ifdef HAVE_OPENSSL
        init_ssl();
 #endif
 
        /* Set up a bunch of semaphores to be used for critical sections */
-       for (a=0; a<MAX_SEMAPHORES; ++a) {
-               pthread_mutex_init(&Critters[a], NULL);
+       for (i=0; i<MAX_SEMAPHORES; ++i) {
+               pthread_mutex_init(&Critters[i], NULL);
        }
 
        /*
@@ -229,6 +217,7 @@ void init_sysdep(void) {
        signal(SIGQUIT, signal_cleanup);
        signal(SIGHUP, signal_cleanup);
        signal(SIGTERM, signal_cleanup);
+       signal(SIGSEGV, signal_cleanup);
 
        /*
         * Do not shut down the server on broken pipe signals, otherwise the
@@ -380,12 +369,14 @@ int ig_uds_server(char *sockpath, int queue_len)
  * called this function.  If there's no such binding (for example, if it's
  * called by the housekeeper thread) then a generic 'master' CC is returned.
  *
- * It's inlined because it's used *VERY* frequently.
+ * This function is used *VERY* frequently and must be kept small.
  */
-INLINE struct CitContext *MyContext(void) {
-       return ((pthread_getspecific(MyConKey) == NULL)
-               ? &masterCC
-               : (struct CitContext *) pthread_getspecific(MyConKey)
+struct CitContext *MyContext(void) {
+
+       register struct CitContext *c;
+
+       return ((c = (struct CitContext *) pthread_getspecific(MyConKey),
+               c == NULL) ? &masterCC : c
        );
 }
 
@@ -423,10 +414,12 @@ struct CitContext *CreateNewContext(void) {
        if (ContextList == NULL) {
                ContextList = me;
                me->cs_pid = 1;
+               me->prev = NULL;
                me->next = NULL;
        }
 
        else if (ContextList->cs_pid > 1) {
+               me->prev = NULL;
                me->next = ContextList;
                ContextList = me;
                me->cs_pid = 1;
@@ -437,11 +430,14 @@ struct CitContext *CreateNewContext(void) {
                        if (ptr->next == NULL) {
                                ptr->next = me;
                                me->cs_pid = ptr->cs_pid + 1;
+                               me->prev = ptr;
                                me->next = NULL;
                                goto DONE;
                        }
                        else if (ptr->next->cs_pid > (ptr->cs_pid+1)) {
+                               me->prev = ptr;
                                me->next = ptr->next;
+                               ptr->next->prev = me;
                                ptr->next = me;
                                me->cs_pid = ptr->cs_pid + 1;
                                goto DONE;
@@ -456,9 +452,40 @@ DONE:      ++num_sessions;
 
 
 /*
- * buffer_output() ... tell client_write to buffer all output until
- *                  instructed to dump it all out later
+ * The following functions implement output buffering. If the kernel supplies
+ * native TCP buffering (Linux & *BSD), use that; otherwise, emulate it with
+ * user-space buffering.
  */
+#ifdef TCP_CORK
+#      define HAVE_TCP_BUFFERING
+#else
+#      ifdef TCP_NOPUSH
+#              define HAVE_TCP_BUFFERING
+#              define TCP_CORK TCP_NOPUSH
+#      endif
+#endif
+
+
+#ifdef HAVE_TCP_BUFFERING
+static unsigned on = 1, off = 0;
+void buffer_output(void) {
+       struct CitContext *ctx = MyContext();
+       setsockopt(ctx->client_socket, IPPROTO_TCP, TCP_CORK, &on, 4);
+       ctx->buffering = 1;
+}
+
+void unbuffer_output(void) {
+       struct CitContext *ctx = MyContext();
+       setsockopt(ctx->client_socket, IPPROTO_TCP, TCP_CORK, &off, 4);
+       ctx->buffering = 0;
+}
+
+void flush_output(void) {
+       struct CitContext *ctx = MyContext();
+       setsockopt(ctx->client_socket, IPPROTO_TCP, TCP_CORK, &off, 4);
+       setsockopt(ctx->client_socket, IPPROTO_TCP, TCP_CORK, &on, 4);
+}
+#else
 void buffer_output(void) {
        if (CC->buffering == 0) {
                CC->buffering = 1;
@@ -467,9 +494,6 @@ void buffer_output(void) {
        }
 }
 
-/*
- * flush_output()  ...   dump out all that output we've been buffering.
- */
 void flush_output(void) {
        if (CC->buffering == 1) {
                client_write(CC->output_buffer, CC->buffer_len);
@@ -477,17 +501,17 @@ void flush_output(void) {
        }
 }
 
-/*
- * unbuffer_output()  ...  stop buffering output.
- */
 void unbuffer_output(void) {
        if (CC->buffering == 1) {
-               flush_output();
                CC->buffering = 0;
+               /* We don't call flush_output because we can't. */
+               client_write(CC->output_buffer, CC->buffer_len);
+               CC->buffer_len = 0;
                free(CC->output_buffer);
                CC->output_buffer = NULL;
        }
 }
+#endif
 
 
 
@@ -499,10 +523,12 @@ void client_write(char *buf, int nbytes)
        int bytes_written = 0;
        int retval;
        int sock;
+#ifndef HAVE_TCP_BUFFERING
        int old_buffer_len = 0;
+#endif
 
        if (CC->redirect_fp != NULL) {
-               fwrite(buf, nbytes, 1, CC->redirect_fp);
+               fwrite(buf, (size_t)nbytes, (size_t)1, CC->redirect_fp);
                return;
        }
 
@@ -513,6 +539,7 @@ void client_write(char *buf, int nbytes)
                sock = CC->client_socket;
        }
 
+#ifndef HAVE_TCP_BUFFERING
        /* If we're buffering for later, do that now. */
        if (CC->buffering) {
                old_buffer_len = CC->buffer_len;
@@ -521,6 +548,7 @@ void client_write(char *buf, int nbytes)
                memcpy(&CC->output_buffer[old_buffer_len], buf, nbytes);
                return;
        }
+#endif
 
        /* Ok, at this point we're not buffering.  Go ahead and write. */
 
@@ -620,11 +648,11 @@ INLINE int client_read(char *buf, int bytes)
 
 
 /*
- * client_gets()   ...   Get a LF-terminated line of text from the client.
+ * client_getln()   ...   Get a LF-terminated line of text from the client.
  * (This is implemented in terms of client_read() and could be
  * justifiably moved out of sysdep.c)
  */
-int client_gets(char *buf)
+int client_getln(char *buf, int bufsize)
 {
        int i, retval;
 
@@ -632,13 +660,13 @@ int client_gets(char *buf)
         */
        for (i = 0;;i++) {
                retval = client_read(&buf[i], 1);
-               if (retval != 1 || buf[i] == '\n' || i == (SIZ-1))
+               if (retval != 1 || buf[i] == '\n' || i == (bufsize-1))
                        break;
        }
 
        /* If we got a long line, discard characters until the newline.
         */
-       if (i == (SIZ-1))
+       if (i == (bufsize-1))
                while (buf[i] != '\n' && retval == 1)
                        retval = client_read(&buf[i], 1);
 
@@ -704,18 +732,15 @@ void kill_session(int session_to_kill) {
 
 
 /*
- * Start running as a daemon.  Only close stdio if do_close_stdio is set.
+ * Start running as a daemon.
  */
-void start_daemon(int do_close_stdio) {
-       if (do_close_stdio) {
-               /* close(0); */
-               close(1);
-               close(2);
-       }
+void start_daemon(int unused) {
+       close(0); close(1); close(2);
+       if (fork()) exit(0);
+       setsid();
        signal(SIGHUP,SIG_IGN);
        signal(SIGINT,SIG_IGN);
        signal(SIGQUIT,SIG_IGN);
-       if (fork()!=0) exit(0);
 }
 
 
@@ -766,11 +791,14 @@ void create_worker(void) {
                return;
        }
 
-       /* we seem to need something bigger than FreeBSD's default 64k stack */
-
-       if ((ret = pthread_attr_setstacksize(&attr, 128 * 1024))) {
+       /* Our per-thread stacks need to be bigger than the default size, otherwise
+        * the MIME parser crashes on FreeBSD, and the IMAP service crashes on
+        * 64-bit Linux.
+        */
+       if ((ret = pthread_attr_setstacksize(&attr, 1024 * 1024))) {
                lprintf(CTDL_EMERG, "pthread_attr_setstacksize: %s\n", strerror(ret));
                time_to_die = -1;
+               pthread_attr_destroy(&attr);
                return;
        }
 
@@ -783,6 +811,7 @@ void create_worker(void) {
 
        n->next = worker_list;
        worker_list = n;
+       pthread_attr_destroy(&attr);
 }
 
 
@@ -891,7 +920,7 @@ void *worker_thread(void *arg) {
        struct CitContext *ptr;
        struct CitContext *bind_me = NULL;
        fd_set readfds;
-       int retval;
+       int retval = 0;
        struct CitContext *con= NULL;   /* Temporary context pointer */
        struct ServiceFunctionHook *serviceptr;
        int ssock;                      /* Descriptor for client socket */
@@ -952,9 +981,8 @@ do_select:  force_purge = 0;
                        tv.tv_usec = 0;
                        retval = select(highest + 1, &readfds, NULL, NULL, &tv);
                }
-               else {
-                       break;
-               }
+
+               if (time_to_die) return(NULL);
 
                /* Now figure out who made this select() unblock.
                 * First, check for an error or exit condition.
@@ -1022,10 +1050,6 @@ do_select:       force_purge = 0;
                        }
                }
 
-               if (time_to_die) {
-                       break;
-               }
-
                /* It must be a client socket.  Find a context that has data
                 * waiting on its socket *and* is in the CON_IDLE state.  Any
                 * active sockets other than our chosen one are marked as
@@ -1078,8 +1102,7 @@ SKIP_SELECT:
        }
 
        /* If control reaches this point, the server is shutting down */        
-       --num_threads;
-       return NULL;
+       return(NULL);
 }
 
 
@@ -1121,7 +1144,8 @@ int SyslogFacility(char *name)
                if(!strcasecmp(name, facTbl[i].name))
                        return facTbl[i].facility;
        }
-       return -1;
+       enable_syslog = 0;
+       return LOG_DAEMON;
 }