]> code.citadel.org Git - citadel.git/blobdiff - citadel/sysdep.c
* Use syslog-compatible logging levels in lprintf(); the loglevel chosen
[citadel.git] / citadel / sysdep.c
index fdb38cc277675fc5e1f11bc8aa5f1a8fd65892a7..061b9fee7937d751bf09f7cb758645ab9e7bfc35 100644 (file)
@@ -27,6 +27,7 @@
 #include <sys/stat.h>
 #include <sys/wait.h>
 #include <sys/socket.h>
+#include <sys/syslog.h>
 
 #if TIME_WITH_SYS_TIME
 # include <sys/time.h>
 #include <pwd.h>
 #include <errno.h>
 #include <stdarg.h>
-#include <syslog.h>
 #include <grp.h>
 #ifdef HAVE_PTHREAD_H
 #include <pthread.h>
 #endif
 #include "citadel.h"
 #include "server.h"
-#include "dynloader.h"
+#include "serv_extensions.h"
 #include "sysdep_decls.h"
 #include "citserver.h"
 #include "support.h"
@@ -92,6 +92,8 @@ int masterhighest;
 
 pthread_t initial_thread;              /* tid for main() thread */
 
+int syslog_facility = (-1);
+
 
 /*
  * lprintf()  ...   Write logging information
@@ -99,29 +101,53 @@ pthread_t initial_thread;          /* tid for main() thread */
  * Note: the variable "buf" below needs to be large enough to handle any
  * log data sent through this function.  BE CAREFUL!
  */
-void lprintf(int loglevel, const char *format, ...) {   
+void lprintf(enum LogLevel loglevel, const char *format, ...) {   
         va_list arg_ptr;
-       char buf[4096];
-  
+       char buf[SIZ];
         va_start(arg_ptr, format);   
-        vsprintf(buf, format, arg_ptr);   
+        vsnprintf(buf, sizeof(buf), format, arg_ptr);   
         va_end(arg_ptr);   
 
-       if (loglevel <= verbosity) { 
+       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) { 
                struct timeval tv;
                struct tm *tim;
+               time_t unixtime;
 
                gettimeofday(&tv, NULL);
-               tim = localtime(&(tv.tv_sec));
+               /* 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.
                 */
-               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);
+               if (CC && CC->cs_pid) {
+                       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);
+               } else {
+                       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);
+               }
                fflush(stderr);
        }
 
@@ -137,7 +163,7 @@ void *tracked_malloc(size_t tsize, char *tfile, int tline) {
 
        ptr = malloc(tsize);
        if (ptr == NULL) {
-               lprintf(3, "DANGER!  mallok(%d) at %s:%d failed!\n",
+               lprintf(CTDL_ALERT, "DANGER!  mallok(%d) at %s:%d failed!\n",
                        tsize, tfile, tline);
                return(NULL);
        }
@@ -251,7 +277,7 @@ void init_sysdep(void) {
         * session to which the calling thread is currently bound.
         */
        if (pthread_key_create(&MyConKey, NULL) != 0) {
-               lprintf(1, "Can't create TSD key!!  %s\n", strerror(errno));
+               lprintf(CTDL_CRIT, "Can't create TSD key!!  %s\n", strerror(errno));
        }
 
        /*
@@ -277,7 +303,7 @@ void init_sysdep(void) {
  */
 void begin_critical_section(int which_one)
 {
-       /* lprintf(9, "begin_critical_section(%d)\n", which_one); */
+       /* lprintf(CTDL_DEBUG, "begin_critical_section(%d)\n", which_one); */
        /* ensure nobody ever tries to do a critical section within a
           transaction; this could lead to deadlock. */
        cdb_check_handles();
@@ -289,7 +315,7 @@ void begin_critical_section(int which_one)
  */
 void end_critical_section(int which_one)
 {
-       /* lprintf(9, "end_critical_section(%d)\n", which_one); */
+       /* lprintf(CTDL_DEBUG, "end_critical_section(%d)\n", which_one); */
        pthread_mutex_unlock(&Critters[which_one]);
 }
 
@@ -317,7 +343,7 @@ int ig_tcp_server(int port_number, int queue_len)
        s = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP);
 
        if (s < 0) {
-               lprintf(1, "citserver: Can't create a socket: %s\n",
+               lprintf(CTDL_EMERG, "citserver: Can't create a socket: %s\n",
                        strerror(errno));
                return(-1);
        }
@@ -326,14 +352,14 @@ int ig_tcp_server(int port_number, int queue_len)
        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",
+               lprintf(CTDL_EMERG, "citserver: Can't bind: %s\n",
                        strerror(errno));
                close(s);
                return(-1);
        }
 
        if (listen(s, actual_queue_len) < 0) {
-               lprintf(1, "citserver: Can't listen: %s\n", strerror(errno));
+               lprintf(CTDL_EMERG, "citserver: Can't listen: %s\n", strerror(errno));
                close(s);
                return(-1);
        }
@@ -358,7 +384,7 @@ int ig_uds_server(char *sockpath, int queue_len)
 
        i = unlink(sockpath);
        if (i != 0) if (errno != ENOENT) {
-               lprintf(1, "citserver: can't unlink %s: %s\n",
+               lprintf(CTDL_EMERG, "citserver: can't unlink %s: %s\n",
                        sockpath, strerror(errno));
                return(-1);
        }
@@ -369,19 +395,19 @@ int ig_uds_server(char *sockpath, int queue_len)
 
        s = socket(AF_UNIX, SOCK_STREAM, 0);
        if (s < 0) {
-               lprintf(1, "citserver: Can't create a socket: %s\n",
+               lprintf(CTDL_EMERG, "citserver: Can't create a socket: %s\n",
                        strerror(errno));
                return(-1);
        }
 
        if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
-               lprintf(1, "citserver: Can't bind: %s\n",
+               lprintf(CTDL_EMERG, "citserver: Can't bind: %s\n",
                        strerror(errno));
                return(-1);
        }
 
        if (listen(s, actual_queue_len) < 0) {
-               lprintf(1, "citserver: Can't listen: %s\n", strerror(errno));
+               lprintf(CTDL_EMERG, "citserver: Can't listen: %s\n", strerror(errno));
                return(-1);
        }
 
@@ -395,12 +421,14 @@ int ig_uds_server(char *sockpath, int queue_len)
  * Return a pointer to the CitContext structure bound to the thread which
  * 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.
  */
-struct CitContext *MyContext(void) {
-       struct CitContext *retCC;
-       retCC = (struct CitContext *) pthread_getspecific(MyConKey);
-       if (retCC == NULL) retCC = &masterCC;
-       return(retCC);
+INLINE struct CitContext *MyContext(void) {
+       return ((pthread_getspecific(MyConKey) == NULL)
+               ? &masterCC
+               : (struct CitContext *) pthread_getspecific(MyConKey)
+       );
 }
 
 
@@ -416,7 +444,7 @@ struct CitContext *CreateNewContext(void) {
 
        me = (struct CitContext *) mallok(sizeof(struct CitContext));
        if (me == NULL) {
-               lprintf(1, "citserver: can't allocate memory!!\n");
+               lprintf(CTDL_ALERT, "citserver: can't allocate memory!!\n");
                return NULL;
        }
        memset(me, 0, sizeof(struct CitContext));
@@ -469,6 +497,33 @@ DONE:      ++num_sessions;
 }
 
 
+/*
+ * buffer_output() ... tell client_write to buffer all output until
+ *                     instructed to dump it all out later
+ */
+void buffer_output(void) {
+       if (CC->buffering == 0) {
+               CC->buffering = 1;
+               CC->buffer_len = 0;
+               CC->output_buffer = mallok(SIZ);
+       }
+}
+
+/*
+ * unbuffer_output()  ...  dump out all that output we've been buffering.
+ */
+void unbuffer_output(void) {
+       if (CC->buffering == 1) {
+               CC->buffering = 0;
+               client_write(CC->output_buffer, CC->buffer_len);
+               phree(CC->output_buffer);
+               CC->output_buffer = NULL;
+               CC->buffer_len = 0;
+       }
+}
+
+
+
 /*
  * client_write()   ...    Send binary data to the client.
  */
@@ -477,14 +532,7 @@ void client_write(char *buf, int nbytes)
        int bytes_written = 0;
        int retval;
        int sock;
-
-
-#ifdef HAVE_OPENSSL
-       if (CC->redirect_ssl) {
-               client_write_ssl(buf, nbytes);
-               return;
-       }
-#endif
+       int old_buffer_len = 0;
 
        if (CC->redirect_fp != NULL) {
                fwrite(buf, nbytes, 1, CC->redirect_fp);
@@ -498,11 +546,29 @@ void client_write(char *buf, int nbytes)
                sock = CC->client_socket;
        }
 
+       /* If we're buffering for later, do that now. */
+       if (CC->buffering) {
+               old_buffer_len = CC->buffer_len;
+               CC->buffer_len += nbytes;
+               CC->output_buffer = reallok(CC->output_buffer, CC->buffer_len);
+               memcpy(&CC->output_buffer[old_buffer_len], buf, nbytes);
+               return;
+       }
+
+       /* Ok, at this point we're not buffering.  Go ahead and write. */
+
+#ifdef HAVE_OPENSSL
+       if (CC->redirect_ssl) {
+               client_write_ssl(buf, nbytes);
+               return;
+       }
+#endif
+
        while (bytes_written < nbytes) {
                retval = write(sock, &buf[bytes_written],
                        nbytes - bytes_written);
                if (retval < 1) {
-                       lprintf(2, "client_write() failed: %s\n",
+                       lprintf(CTDL_ERR, "client_write() failed: %s\n",
                                strerror(errno));
                        if (sock == CC->client_socket) CC->kill_me = 1;
                        return;
@@ -565,7 +631,7 @@ int client_read_to(char *buf, int bytes, int timeout)
 
                rlen = read(CC->client_socket, &buf[len], bytes-len);
                if (rlen<1) {
-                       lprintf(2, "client_read() failed: %s\n",
+                       lprintf(CTDL_ERR, "client_read() failed: %s\n",
                                strerror(errno));
                        CC->kill_me = 1;
                        return(-1);
@@ -580,7 +646,7 @@ int client_read_to(char *buf, int bytes, int timeout)
  * (This is implemented in terms of client_read_to() and could be
  * justifiably moved out of sysdep.c)
  */
-inline int client_read(char *buf, int bytes)
+INLINE int client_read(char *buf, int bytes)
 {
        return(client_read_to(buf, bytes, config.c_sleeping));
 }
@@ -633,11 +699,11 @@ void sysdep_master_cleanup(void) {
            serviceptr = serviceptr->next ) {
 
                if (serviceptr->tcp_port > 0)
-                       lprintf(3, "Closing listener on port %d\n",
+                       lprintf(CTDL_INFO, "Closing listener on port %d\n",
                                serviceptr->tcp_port);
 
                if (serviceptr->sockpath != NULL)
-                       lprintf(3, "Closing listener on '%s'\n",
+                       lprintf(CTDL_INFO, "Closing listener on '%s'\n",
                                serviceptr->sockpath);
 
                close(serviceptr->msock);
@@ -717,26 +783,26 @@ struct worker_node *worker_list = NULL;
  */
 void create_worker(void) {
        int ret;
-       struct worker_node *n = mallok(sizeof *n);
+       struct worker_node *n;
        pthread_attr_t attr;
 
+       n = mallok(sizeof(struct worker_node));
        if (n == NULL) {
-               lprintf(1, "can't allocate worker_node, exiting\n");
+               lprintf(CTDL_EMERG, "can't allocate worker_node, exiting\n");
                time_to_die = -1;
                return;
        }
 
        if ((ret = pthread_attr_init(&attr))) {
-               lprintf(1, "pthread_attr_init: %s\n", strerror(ret));
+               lprintf(CTDL_EMERG, "pthread_attr_init: %s\n", strerror(ret));
                time_to_die = -1;
                return;
        }
 
-       /* we seem to need something bigger than
-          FreeBSD's default of 64K of stack. */
+       /* we seem to need something bigger than FreeBSD's default 64k stack */
 
        if ((ret = pthread_attr_setstacksize(&attr, 128 * 1024))) {
-               lprintf(1, "pthread_attr_setstacksize: %s\n", strerror(ret));
+               lprintf(CTDL_EMERG, "pthread_attr_setstacksize: %s\n", strerror(ret));
                time_to_die = -1;
                return;
        }
@@ -744,7 +810,7 @@ void create_worker(void) {
        if ((ret = pthread_create(&n->tid, &attr, worker_thread, NULL) != 0))
        {
 
-               lprintf(1, "Can't create worker thread: %s\n",
+               lprintf(CTDL_ALERT, "Can't create worker thread: %s\n",
                        strerror(ret));
        }
 
@@ -785,7 +851,7 @@ void dead_session_purge(void) {
                 * section, so we have to do it like this.
                 */     
                if (rem != NULL) {
-                       lprintf(9, "Purging session %d\n", rem->cs_pid);
+                       lprintf(CTDL_DEBUG, "Purging session %d\n", rem->cs_pid);
                        RemoveContext(rem);
                }
 
@@ -876,25 +942,25 @@ void init_master_fdset(void) {
        struct ServiceFunctionHook *serviceptr;
        int m;
 
-       lprintf(9, "Initializing master fdset\n");
+       lprintf(CTDL_DEBUG, "Initializing master fdset\n");
 
        FD_ZERO(&masterfds);
        masterhighest = 0;
 
-       lprintf(9, "Will listen on rescan pipe %d\n", rescan[0]);
+       lprintf(CTDL_DEBUG, "Will listen on rescan pipe %d\n", rescan[0]);
        FD_SET(rescan[0], &masterfds);
        if (rescan[0] > masterhighest) masterhighest = rescan[0];
 
        for (serviceptr = ServiceHookTable; serviceptr != NULL;
            serviceptr = serviceptr->next ) {
                m = serviceptr->msock;
-               lprintf(9, "Will listen on master socket %d\n", m);
+               lprintf(CTDL_DEBUG, "Will listen on master socket %d\n", m);
                FD_SET(m, &masterfds);
                if (m > masterhighest) {
                        masterhighest = m;
                }
        }
-       lprintf(9, "masterhighest = %d\n", masterhighest);
+       lprintf(CTDL_DEBUG, "masterhighest = %d\n", masterhighest);
 }
 
 
@@ -920,8 +986,6 @@ void *worker_thread(void *arg) {
        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;
 
@@ -933,12 +997,14 @@ void *worker_thread(void *arg) {
 
                /* 
                 * A naive implementation would have all idle threads
-                * calling select() and then they'd all wake up at once.  We
-                * solve this problem by putting the select() in a critical
-                * section, so only one thread has the opportunity to wake
-                * up.  If we wake up on a master socket, create a new
-                * session context; otherwise, just bind the thread to the
-                * context we want and go on our merry way.
+                * calling select() and then they'd all wake up at once
+                * (known in computer science as the "thundering herd"
+                * problem).  We solve this problem by putting the select()
+                * in a critical section, so only one thread has the
+                * opportunity to wake up.  If we wake up on a master
+                * socket, create a new session context; otherwise, just
+                * bind the thread to the context we want and go on our
+                * merry way.
                 */
 
                /* make doubly sure we're not holding any stale db handles
@@ -975,7 +1041,7 @@ SETUP_FD:  memcpy(&readfds, &masterfds, sizeof masterfds);
                 */
                if (retval < 0) {
                        if (errno != EINTR) {
-                               lprintf(9, "Exiting (%s)\n", strerror(errno));
+                               lprintf(CTDL_EMERG, "Exiting (%s)\n", strerror(errno));
                                time_to_die = 1;
                        } else if (!time_to_die)
                                goto do_select;
@@ -988,15 +1054,14 @@ SETUP_FD:        memcpy(&readfds, &masterfds, sizeof masterfds);
                     serviceptr = serviceptr->next ) {
 
                        if (FD_ISSET(serviceptr->msock, &readfds)) {
-                               alen = sizeof fsin;
-                               ssock = accept(serviceptr->msock,
-                                       (struct sockaddr *)&fsin, &alen);
+                               ssock = accept(serviceptr->msock, NULL, 0);
                                if (ssock < 0) {
-                                       lprintf(2, "citserver: accept(): %s\n",
+                                       lprintf(CTDL_CRIT,
+                                               "citserver: accept(): %s\n",
                                                strerror(errno));
                                }
                                else {
-                                       lprintf(7, "citserver: "
+                                       lprintf(CTDL_NOTICE,
                                                "New client socket %d\n",
                                                ssock);
 
@@ -1090,3 +1155,46 @@ SETUP_FD:        memcpy(&readfds, &masterfds, sizeof masterfds);
        --num_threads;
        return NULL;
 }
+
+
+
+
+/*
+ * SyslogFacility()
+ * Translate text facility name to syslog.h defined value.
+ */
+int SyslogFacility(char *name)
+{
+       int i;
+       struct
+       {
+               int facility;
+               char *name;
+       }   facTbl[] =
+       {
+               {   LOG_KERN,   "kern"          },
+               {   LOG_USER,   "user"          },
+               {   LOG_MAIL,   "mail"          },
+               {   LOG_DAEMON, "daemon"        },
+               {   LOG_AUTH,   "auth"          },
+               {   LOG_SYSLOG, "syslog"        },
+               {   LOG_LPR,    "lpr"           },
+               {   LOG_NEWS,   "news"          },
+               {   LOG_UUCP,   "uucp"          },
+               {   LOG_LOCAL0, "local0"        },
+               {   LOG_LOCAL1, "local1"        },
+               {   LOG_LOCAL2, "local2"        },
+               {   LOG_LOCAL3, "local3"        },
+               {   LOG_LOCAL4, "local4"        },
+               {   LOG_LOCAL5, "local5"        },
+               {   LOG_LOCAL6, "local6"        },
+               {   LOG_LOCAL7, "local7"        },
+               {   0,            NULL          }
+       };
+       for(i = 0; facTbl[i].name != NULL; i++) {
+               if(!strcasecmp(name, facTbl[i].name))
+                       return facTbl[i].facility;
+       }
+       return -1;
+}
+