/*
- * Citadel/UX "system dependent" stuff.
- * See copyright.txt for copyright information.
- *
* $Id$
*
- * Here's where we (hopefully) have all the parts of the Citadel server that
+ * Citadel "system dependent" stuff.
+ * See copyright.txt for copyright information.
+ *
+ * Here's where we (hopefully) have most parts of the Citadel server that
* would need to be altered to run the server in a non-POSIX environment.
- * Wherever possible, we use function wrappers and type definitions to create
- * abstractions that are platform-independent from the calling side.
*
- * Eventually we'll try porting to a different platform and either have
- * multiple variants of this file or simply load it up with #ifdefs.
+ * If we ever port to a different platform and either have multiple
+ * variants of this file or simply load it up with #ifdefs.
+ *
*/
-
#include "sysdep.h"
#include <stdlib.h>
#include <unistd.h>
#include <ctype.h>
#include <signal.h>
#include <sys/types.h>
+#include <sys/stat.h>
#include <sys/wait.h>
#include <sys/socket.h>
-#include <sys/time.h>
+#include <syslog.h>
+#include <sys/syslog.h>
+
+#if TIME_WITH_SYS_TIME
+# include <sys/time.h>
+# include <time.h>
+#else
+# if HAVE_SYS_TIME_H
+# include <sys/time.h>
+# else
+# include <time.h>
+# endif
+#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>
#include <pwd.h>
#include <errno.h>
#include <stdarg.h>
-#include <syslog.h>
#include <grp.h>
#ifdef HAVE_PTHREAD_H
#include <pthread.h>
#endif
+#include <libcitadel.h>
#include "citadel.h"
#include "server.h"
#include "sysdep_decls.h"
#include "config.h"
#include "database.h"
#include "housekeeping.h"
-#include "dynloader.h"
-#include "tools.h"
+#include "modules/crypto/serv_crypto.h" /* Needed for init_ssl, client_write_ssl, client_read_ssl, destruct_ssl */
+#include "ecrash.h"
#ifdef HAVE_SYS_SELECT_H
#include <sys/select.h>
#include "snprintf.h"
#endif
+
#ifdef DEBUG_MEMORY_LEAKS
-struct TheHeap *heap = NULL;
+struct igheap {
+ struct igheap *next;
+ char file[32];
+ int line;
+ void *block;
+};
+
+struct igheap *igheap = NULL;
#endif
+
pthread_mutex_t Critters[MAX_SEMAPHORES]; /* Things needing locking */
pthread_key_t MyConKey; /* TSD key for MyContext() */
-int msock; /* master listening socket */
-int verbosity = 3; /* Logging level */
+int verbosity = DEFAULT_VERBOSITY; /* Logging level */
struct CitContext masterCC;
+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 */
+int syslog_facility = LOG_DAEMON;
+int enable_syslog = 0;
-/*
- * lprintf() ... Write logging information
- */
-void lprintf(int loglevel, const char *format, ...) {
- va_list arg_ptr;
- char buf[512];
-
- va_start(arg_ptr, format);
- vsprintf(buf, format, arg_ptr);
- va_end(arg_ptr);
+void DestroyWorkerList(void);
- if (loglevel <= verbosity) {
- fprintf(stderr, "%s", buf);
- fflush(stderr);
- }
-
- PerformLogHooks(loglevel, buf);
- }
+/*
+ * Create an interface to lprintf that follows the coding convention.
+ * This is here until such time as we have replaced all calls to lprintf with CtdlLogPrintf
+ */
+
+void CtdlLogPrintf(enum LogLevel loglevel, const char *format, ...)
+{
+ va_list arg_ptr;
+ va_start(arg_ptr, format);
+ vlprintf(loglevel, format, arg_ptr);
+ va_end(arg_ptr);
+}
-#ifdef DEBUG_MEMORY_LEAKS
-void *tracked_malloc(size_t tsize, char *tfile, int tline) {
- void *ptr;
- struct TheHeap *hptr;
+/*
+ * lprintf() ... Write logging information
+ */
+void lprintf(enum LogLevel loglevel, const char *format, ...) {
+ va_list arg_ptr;
+ va_start(arg_ptr, format);
+ vlprintf(loglevel, format, arg_ptr);
+ va_end(arg_ptr);
+}
- ptr = malloc(tsize);
- if (ptr == NULL) return(NULL);
+void vlprintf(enum LogLevel loglevel, const char *format, va_list arg_ptr)
+{
+ char buf[SIZ], buf2[SIZ];
- hptr = (struct TheHeap *) malloc(sizeof(struct TheHeap));
- strcpy(hptr->h_file, tfile);
- hptr->h_line = tline;
- hptr->next = heap;
- hptr->h_ptr = ptr;
- heap = hptr;
- return ptr;
+ if (enable_syslog) {
+ vsyslog((syslog_facility | loglevel), format, arg_ptr);
}
+ /* stderr output code */
+ if (enable_syslog || running_as_daemon) return;
-void tracked_free(void *ptr) {
- struct TheHeap *hptr, *freeme;
-
- if (heap->h_ptr == ptr) {
- hptr = heap->next;
- free(heap);
- heap = hptr;
- }
- else {
- for (hptr=heap; hptr->next!=NULL; hptr=hptr->next) {
- if (hptr->next->h_ptr == ptr) {
- freeme = hptr->next;
- hptr->next = hptr->next->next;
- free(freeme);
- }
- }
+ /* if we run in forground and syslog is disabled, log to terminal */
+ if (loglevel <= verbosity) {
+ struct timeval tv;
+ struct tm tim;
+ time_t unixtime;
+
+ gettimeofday(&tv, NULL);
+ /* Promote to time_t; types differ on some OSes (like darwin) */
+ unixtime = tv.tv_sec;
+ localtime_r(&unixtime, &tim);
+ if (CC->cs_pid != 0) {
+ sprintf(buf,
+ "%04d/%02d/%02d %2d:%02d:%02d.%06ld [%3d] ",
+ 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);
+ } else {
+ sprintf(buf,
+ "%04d/%02d/%02d %2d:%02d:%02d.%06ld ",
+ tim.tm_year + 1900, tim.tm_mon + 1,
+ tim.tm_mday, tim.tm_hour, tim.tm_min,
+ tim.tm_sec, (long)tv.tv_usec);
}
+ vsprintf(buf2, format, arg_ptr);
- free(ptr);
+ fprintf(stderr, "%s%s", buf, buf2);
+ fflush(stderr);
}
+}
-void *tracked_realloc(void *ptr, size_t size) {
- void *newptr;
- struct TheHeap *hptr;
-
- newptr = realloc(ptr, size);
- for (hptr=heap; hptr!=NULL; hptr=hptr->next) {
- if (hptr->h_ptr == ptr) hptr->h_ptr = newptr;
- }
-
- return newptr;
- }
+/*
+ * Signal handler to shut down the server.
+ */
-void dump_tracked() {
- struct TheHeap *hptr;
+volatile int time_to_die = 0;
+volatile int shutdown_and_halt = 0;
+volatile int restart_server = 0;
+volatile int running_as_daemon = 0;
- cprintf("%d Here's what's allocated...\n", LISTING_FOLLOWS);
- for (hptr=heap; hptr!=NULL; hptr=hptr->next) {
- cprintf("%20s %5d\n",
- hptr->h_file, hptr->h_line);
- }
- cprintf("000\n");
- }
-#endif
+static RETSIGTYPE signal_cleanup(int signum) {
+ lprintf(CTDL_DEBUG, "Caught signal %d; shutting down.\n", signum);
+ time_to_die = 1;
+ master_cleanup(signum);
+}
-static pthread_t main_thread_id;
-#ifndef HAVE_PTHREAD_CANCEL
-/*
- * signal handler to fake thread cancellation; only required on BSDI as far
- * as I know.
- */
-static RETSIGTYPE cancel_thread(int signum) {
- pthread_exit(NULL);
- }
-#endif
-/*
- * 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.
- */
-static volatile int time_to_die = 0;
+void InitialiseSemaphores(void)
+{
+ int i;
-static RETSIGTYPE signal_cleanup(int signum) {
- time_to_die = 1;
+ /* Set up a bunch of semaphores to be used for critical sections */
+ for (i=0; i<MAX_SEMAPHORES; ++i) {
+ pthread_mutex_init(&Critters[i], NULL);
}
+}
+
/*
* Some initialization stuff...
*/
void init_sysdep(void) {
- int a;
+ sigset_t set;
- /* 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);
- }
+ /* 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 place to put thread-specific data.
* We only need a single pointer per thread - it points to the
- * thread's CitContext structure in the ContextList linked list.
+ * CitContext structure (in the ContextList linked list) of the
+ * 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));
+ }
/*
* The action for unexpected signals and exceptions should be to
* call signal_cleanup() to gracefully shut down the server.
*/
+ sigemptyset(&set);
+ sigaddset(&set, SIGINT);
+ sigaddset(&set, SIGQUIT);
+ sigaddset(&set, SIGHUP);
+ sigaddset(&set, SIGTERM);
+ // sigaddset(&set, SIGSEGV); commented out because
+ // sigaddset(&set, SIGILL); we want core dumps
+ // sigaddset(&set, SIGBUS);
+ sigprocmask(SIG_UNBLOCK, &set, NULL);
+
signal(SIGINT, signal_cleanup);
signal(SIGQUIT, signal_cleanup);
signal(SIGHUP, signal_cleanup);
signal(SIGTERM, signal_cleanup);
+ // signal(SIGSEGV, signal_cleanup); commented out because
+ // signal(SIGILL, signal_cleanup); we want core dumps
+ // signal(SIGBUS, signal_cleanup);
+
+ /*
+ * Do not shut down the server on broken pipe signals, otherwise the
+ * whole Citadel service would come down whenever a single client
+ * socket breaks.
+ */
signal(SIGPIPE, SIG_IGN);
- main_thread_id = pthread_self();
-#ifndef HAVE_PTHREAD_CANCEL /* fake it - only BSDI afaik */
- signal(SIGUSR1, cancel_thread);
-#endif
- }
+}
/*
*/
void begin_critical_section(int which_one)
{
-#ifdef HAVE_PTHREAD_CANCEL
- int oldval;
-#else
- sigset_t set;
-#endif
-
- /* lprintf(8, "begin_critical_section(%d)\n", which_one); */
+ /* lprintf(CTDL_DEBUG, "begin_critical_section(%d)\n", which_one); */
- if (!pthread_equal(pthread_self(), main_thread_id)) {
- /* Keep a count of how many critical sections this thread has
- * open, so that end_critical_section() doesn't enable
- * cancellation prematurely. */
- CC->n_crit++;
-#ifdef HAVE_PTHREAD_CANCEL
- /* Don't get interrupted during the critical section */
- pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, &oldval);
-#else
- /* We're faking cancellation with signals. Block SIGUSR1 while
- * we're in the critical section. */
- sigemptyset(&set);
- sigaddset(&set, SIGUSR1);
- pthread_sigmask(SIG_BLOCK, &set, NULL);
+ /* For all types of critical sections except those listed here,
+ * ensure nobody ever tries to do a critical section within a
+ * transaction; this could lead to deadlock.
+ */
+ if ( (which_one != S_FLOORCACHE)
+#ifdef DEBUG_MEMORY_LEAKS
+ && (which_one != S_DEBUGMEMLEAKS)
#endif
- }
-
- /* Obtain a semaphore */
- pthread_mutex_lock(&Critters[which_one]);
-
+ && (which_one != S_RPLIST)
+ ) {
+ cdb_check_handles();
}
+ pthread_mutex_lock(&Critters[which_one]);
+}
/*
* Release a semaphore lock to end a critical section.
*/
void end_critical_section(int which_one)
{
-#ifdef HAVE_PTHREAD_CANCEL
- int oldval;
-#else
- sigset_t set;
-#endif
-
- /* lprintf(8, " end_critical_section(%d)\n", which_one); */
-
- /* Let go of the semaphore */
pthread_mutex_unlock(&Critters[which_one]);
-
- if (!pthread_equal(pthread_self(), main_thread_id))
- if (!--CC->n_crit) {
-#ifdef HAVE_PTHREAD_CANCEL
- /* If a cancel was sent during the critical section, do it now.
- * Then re-enable thread cancellation.
- */
- pthread_testcancel();
- pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, &oldval);
- pthread_testcancel();
-#else
- /* We're faking it. Unblock SIGUSR1; signals sent during the
- * critical section should now be able to kill us. */
- sigemptyset(&set);
- sigaddset(&set, SIGUSR1);
- pthread_sigmask(SIG_UNBLOCK, &set, NULL);
-#endif
- }
-
- }
+}
/*
* 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.
+ *
*/
-int ig_tcp_server(int port_number, int queue_len)
+int ig_tcp_server(char *ip_addr, int port_number, int queue_len, char **errormessage)
{
struct sockaddr_in sin;
int s, i;
+ int actual_queue_len;
+
+ actual_queue_len = queue_len;
+ if (actual_queue_len < 5) actual_queue_len = 5;
memset(&sin, 0, sizeof(sin));
sin.sin_family = AF_INET;
- sin.sin_addr.s_addr = INADDR_ANY;
-
- if (port_number == 0) {
- lprintf(1,
- "citserver: No port number specified. Run setup.\n");
- exit(1);
- }
-
sin.sin_port = htons((u_short)port_number);
+ if (ip_addr == NULL) {
+ sin.sin_addr.s_addr = INADDR_ANY;
+ }
+ else {
+ sin.sin_addr.s_addr = inet_addr(ip_addr);
+ }
+
+ if (sin.sin_addr.s_addr == !INADDR_ANY) {
+ sin.sin_addr.s_addr = INADDR_ANY;
+ }
+
+ s = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP);
- 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);
- }
+ *errormessage = (char*) malloc(SIZ + 1);
+ snprintf(*errormessage, SIZ,
+ "citserver: Can't create a socket: %s",
+ strerror(errno));
+ lprintf(CTDL_EMERG, "%s\n", *errormessage);
+ return(-1);
+ }
- /* Set the SO_REUSEADDR socket option, because it makes sense. */
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);
- }
+ *errormessage = (char*) malloc(SIZ + 1);
+ snprintf(*errormessage, SIZ,
+ "citserver: Can't bind: %s",
+ strerror(errno));
+ lprintf(CTDL_EMERG, "%s\n", *errormessage);
+ close(s);
+ return(-1);
+ }
- if (listen(s, queue_len) < 0) {
- lprintf(1, "citserver: Can't listen: %s\n", strerror(errno));
- exit(errno);
- }
+ /* set to nonblock - we need this for some obscure situations */
+ if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
+ *errormessage = (char*) malloc(SIZ + 1);
+ snprintf(*errormessage, SIZ,
+ "citserver: Can't set socket to non-blocking: %s",
+ strerror(errno));
+ lprintf(CTDL_EMERG, "%s\n", *errormessage);
+ close(s);
+ return(-1);
+ }
- return(s);
+ if (listen(s, actual_queue_len) < 0) {
+ *errormessage = (char*) malloc(SIZ + 1);
+ snprintf(*errormessage, SIZ,
+ "citserver: Can't listen: %s",
+ strerror(errno));
+ lprintf(CTDL_EMERG, "%s\n", *errormessage);
+ close(s);
+ return(-1);
}
+ return(s);
+}
+
-/*
- * Return a pointer to a thread's own CitContext structure (old)
- * NOTE: this version of MyContext() is commented out because it is no longer
- * in use. It was written before I discovered TSD keys. This
- * version pounds through the context list until it finds the one matching
- * the currently running thread. It remains here, commented out, in case it
- * is needed for future ports to threading libraries which have the equivalent
- * of pthread_self() but not pthread_key_create() and its ilk.
- *
- * struct CitContext *MyContext() {
- * struct CitContext *ptr;
- * THREAD me;
- *
- * me = pthread_self();
- * for (ptr=ContextList; ptr!=NULL; ptr=ptr->next) {
- * if (ptr->mythread == me) return(ptr);
- * }
- * return(NULL);
- * }
- */
/*
- * Return a pointer to a thread's own CitContext structure (new)
+ * Create a Unix domain socket and listen on it
*/
-struct CitContext *MyContext(void) {
- struct CitContext *retCC;
- retCC = (struct CitContext *) pthread_getspecific(MyConKey);
- if (retCC == NULL) retCC = &masterCC;
- return(retCC);
+int ig_uds_server(char *sockpath, int queue_len, char **errormessage)
+{
+ struct sockaddr_un addr;
+ int s;
+ int i;
+ int actual_queue_len;
+
+ actual_queue_len = queue_len;
+ if (actual_queue_len < 5) actual_queue_len = 5;
+
+ i = unlink(sockpath);
+ if (i != 0) if (errno != ENOENT) {
+ *errormessage = (char*) malloc(SIZ + 1);
+ snprintf(*errormessage, SIZ, "citserver: can't unlink %s: %s",
+ sockpath, strerror(errno));
+ lprintf(CTDL_EMERG, "%s\n", *errormessage);
+ return(-1);
}
+ memset(&addr, 0, sizeof(addr));
+ addr.sun_family = AF_UNIX;
+ safestrncpy(addr.sun_path, sockpath, sizeof addr.sun_path);
-/*
- * Wedge our way into the context list.
- */
-struct CitContext *CreateNewContext(void) {
- struct CitContext *me;
+ s = socket(AF_UNIX, SOCK_STREAM, 0);
+ if (s < 0) {
+ *errormessage = (char*) malloc(SIZ + 1);
+ snprintf(*errormessage, SIZ,
+ "citserver: Can't create a socket: %s",
+ strerror(errno));
+ lprintf(CTDL_EMERG, "%s\n", *errormessage);
+ return(-1);
+ }
- lprintf(9, "CreateNewContext: calling malloc()\n");
- me = (struct CitContext *) mallok(sizeof(struct CitContext));
- if (me == NULL) {
- lprintf(1, "citserver: can't allocate memory!!\n");
- pthread_exit(NULL);
- }
- memset(me, 0, sizeof(struct CitContext));
+ if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
+ *errormessage = (char*) malloc(SIZ + 1);
+ snprintf(*errormessage, SIZ,
+ "citserver: Can't bind: %s",
+ strerror(errno));
+ lprintf(CTDL_EMERG, "%s\n", *errormessage);
+ return(-1);
+ }
- begin_critical_section(S_SESSION_TABLE);
- me->next = ContextList;
- ContextList = me;
- end_critical_section(S_SESSION_TABLE);
- return(me);
+ /* set to nonblock - we need this for some obscure situations */
+ if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
+ *errormessage = (char*) malloc(SIZ + 1);
+ snprintf(*errormessage, SIZ,
+ "citserver: Can't set socket to non-blocking: %s",
+ strerror(errno));
+ lprintf(CTDL_EMERG, "%s\n", *errormessage);
+ close(s);
+ return(-1);
}
+ if (listen(s, actual_queue_len) < 0) {
+ *errormessage = (char*) malloc(SIZ + 1);
+ snprintf(*errormessage, SIZ,
+ "citserver: Can't listen: %s",
+ strerror(errno));
+ lprintf(CTDL_EMERG, "%s\n", *errormessage);
+ return(-1);
+ }
+
+ chmod(sockpath, S_ISGID|S_IRUSR|S_IWUSR|S_IXUSR|S_IRGRP|S_IWGRP|S_IXGRP|S_IROTH|S_IWOTH|S_IXOTH);
+ return(s);
+}
+
+
+
/*
- * Add a thread's thread ID to the context
+ * 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.
+ *
+ * This function is used *VERY* frequently and must be kept small.
*/
-void InitMyContext(struct CitContext *con)
-{
-#ifdef HAVE_PTHREAD_CANCEL
- int oldval;
-#endif
+struct CitContext *MyContext(void) {
+
+ register struct CitContext *c;
+
+ return ((c = (struct CitContext *) pthread_getspecific(MyConKey),
+ c == NULL) ? &masterCC : c
+ );
+}
- con->mythread = pthread_self();
-#ifdef HAVE_PTHREAD_CANCEL
- pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, &oldval);
- pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, &oldval);
-#endif
- if (pthread_setspecific(MyConKey, (void *)con) != 0) {
- lprintf(1, "ERROR! pthread_setspecific() failed: %s\n",
- strerror(errno));
- }
- }
/*
- * Remove a context from the context list.
+ * Initialize a new context and place it in the list. The session number
+ * used to be the PID (which is why it's called cs_pid), but that was when we
+ * had one process per session. Now we just assign them sequentially, starting
+ * at 1 (don't change it to 0 because masterCC uses 0).
*/
-void RemoveContext(struct CitContext *con)
-{
- struct CitContext *ptr;
+struct CitContext *CreateNewContext(void) {
+ struct CitContext *me;
+ static int next_pid = 0;
- lprintf(7, "Starting RemoveContext()\n");
- lprintf(9, "Session count before RemoveContext is %d\n",
- session_count());
- if (con==NULL) {
- lprintf(7, "WARNING: RemoveContext() called with null!\n");
- return;
- }
+ me = (struct CitContext *) malloc(sizeof(struct CitContext));
+ if (me == NULL) {
+ lprintf(CTDL_ALERT, "citserver: can't allocate memory!!\n");
+ return NULL;
+ }
+ memset(me, 0, sizeof(struct CitContext));
+
+ /* The new context will be created already in the CON_EXECUTING state
+ * in order to prevent another thread from grabbing it while it's
+ * being set up.
+ */
+ me->state = CON_EXECUTING;
/*
- * session_count() starts its own S_SESSION_TABLE critical section;
- * so do not call it from within this loop.
+ * Generate a unique session number and insert this context into
+ * the list.
*/
begin_critical_section(S_SESSION_TABLE);
- lprintf(7, "Closing socket %d\n", con->client_socket);
- close(con->client_socket);
-
- lprintf(9, "Dereferencing session context\n");
- if (ContextList==con) {
- ContextList = ContextList->next;
- }
- else {
- for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
- if (ptr->next == con) {
- ptr->next = con->next;
- }
- }
- }
-
- lprintf(9, "Freeing session context...\n");
- phree(con);
- lprintf(9, "...done.\n");
- end_critical_section(S_SESSION_TABLE);
-
- lprintf(9, "Session count after RemoveContext is %d\n",
- session_count());
-
- lprintf(7, "Done with RemoveContext\n");
+ me->cs_pid = ++next_pid;
+ me->prev = NULL;
+ me->next = ContextList;
+ ContextList = me;
+ if (me->next != NULL) {
+ me->next->prev = me;
}
+ ++num_sessions;
+ end_critical_section(S_SESSION_TABLE);
+ return(me);
+}
/*
- * Return the number of sessions currently running.
- * (This should probably be moved out of sysdep.c)
+ * The following functions implement output buffering. If the kernel supplies
+ * native TCP buffering (Linux & *BSD), use that; otherwise, emulate it with
+ * user-space buffering.
*/
-int session_count(void) {
- struct CitContext *ptr;
- int TheCount = 0;
-
- lprintf(9, "session_count() starting\n");
- begin_critical_section(S_SESSION_TABLE);
- for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
- ++TheCount;
- lprintf(9, "Counted session %3d (%d)\n", ptr->cs_pid, TheCount);
- }
- end_critical_section(S_SESSION_TABLE);
+#ifndef HAVE_DARWIN
+#ifdef TCP_CORK
+# define HAVE_TCP_BUFFERING
+#else
+# ifdef TCP_NOPUSH
+# define HAVE_TCP_BUFFERING
+# define TCP_CORK TCP_NOPUSH
+# endif
+#endif /* TCP_CORK */
+#endif /* HAVE_DARWIN */
+
+#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
+#ifdef HAVE_DARWIN
+/* Stub functions for Darwin/OS X where TCP buffering isn't liked at all */
+void buffer_output(void) {
+ CC->buffering = 0;
+}
+void unbuffer_output(void) {
+ CC->buffering = 0;
+}
+void flush_output(void) {
+}
+#else
+void buffer_output(void) {
+ if (CC->buffering == 0) {
+ CC->buffering = 1;
+ CC->buffer_len = 0;
+ CC->output_buffer = malloc(SIZ);
+ }
+}
- lprintf(9, "session_count() finishing\n");
- return(TheCount);
+void flush_output(void) {
+ if (CC->buffering == 1) {
+ client_write(CC->output_buffer, CC->buffer_len);
+ CC->buffer_len = 0;
}
+}
+
+void unbuffer_output(void) {
+ if (CC->buffering == 1) {
+ 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 /* HAVE_DARWIN */
+#endif /* HAVE_TCP_BUFFERING */
+
/*
{
int bytes_written = 0;
int retval;
+#ifndef HAVE_TCP_BUFFERING
+ int old_buffer_len = 0;
+#endif
+ t_context *Ctx;
+
+ Ctx = CC;
+ if (Ctx->redirect_buffer != NULL) {
+ if ((Ctx->redirect_len + nbytes + 2) >= Ctx->redirect_alloc) {
+ Ctx->redirect_alloc = (Ctx->redirect_alloc * 2) + nbytes;
+ Ctx->redirect_buffer = realloc(Ctx->redirect_buffer,
+ Ctx->redirect_alloc);
+ }
+ memcpy(&Ctx->redirect_buffer[Ctx->redirect_len], buf, nbytes);
+ Ctx->redirect_len += nbytes;
+ Ctx->redirect_buffer[Ctx->redirect_len] = 0;
+ return;
+ }
+
+#ifndef HAVE_TCP_BUFFERING
+ /* If we're buffering for later, do that now. */
+ if (Ctx->buffering) {
+ old_buffer_len = Ctx->buffer_len;
+ Ctx->buffer_len += nbytes;
+ Ctx->output_buffer = realloc(Ctx->output_buffer, Ctx->buffer_len);
+ memcpy(&Ctx->output_buffer[old_buffer_len], buf, nbytes);
+ return;
+ }
+#endif
+
+ /* Ok, at this point we're not buffering. Go ahead and write. */
+
+#ifdef HAVE_OPENSSL
+ if (Ctx->redirect_ssl) {
+ client_write_ssl(buf, nbytes);
+ return;
+ }
+#endif
+
while (bytes_written < nbytes) {
- retval = write(CC->client_socket, &buf[bytes_written],
+ retval = write(Ctx->client_socket, &buf[bytes_written],
nbytes - bytes_written);
if (retval < 1) {
- lprintf(2, "client_write() failed: %s\n",
- strerror(errno));
- cleanup(errno);
- }
- bytes_written = bytes_written + retval;
+ lprintf(CTDL_ERR,
+ "client_write(%d bytes) failed: %s (%d)\n",
+ nbytes - bytes_written,
+ strerror(errno), errno);
+ cit_backtrace();
+ // lprintf(CTDL_DEBUG, "Tried to send: %s", &buf[bytes_written]);
+ Ctx->kill_me = 1;
+ return;
}
+ bytes_written = bytes_written + retval;
}
+}
/*
* cprintf() ... Send formatted printable data to the client. It is
- * implemented in terms of client_write() but remains in
- * sysdep.c in case we port to somewhere without va_args...
+ * implemented in terms of client_write() but remains in
+ * sysdep.c in case we port to somewhere without va_args...
*/
void cprintf(const char *format, ...) {
- va_list arg_ptr;
- char buf[256];
+ va_list arg_ptr;
+ char buf[1024];
- va_start(arg_ptr, format);
- if (vsnprintf(buf, sizeof buf, format, arg_ptr) == -1)
+ va_start(arg_ptr, format);
+ if (vsnprintf(buf, sizeof buf, format, arg_ptr) == -1)
buf[sizeof buf - 2] = '\n';
client_write(buf, strlen(buf));
va_end(arg_ptr);
- }
+}
/*
* Return values are:
* 1 Requested number of bytes has been read.
* 0 Request timed out.
- * If the socket breaks, the session is immediately terminated.
+ * -1 The socket is broken.
+ * If the socket breaks, the session will be terminated.
*/
int client_read_to(char *buf, int bytes, int timeout)
{
int len,rlen;
fd_set rfds;
+ int fd;
struct timeval tv;
int retval;
+#ifdef HAVE_OPENSSL
+ if (CC->redirect_ssl) {
+ return (client_read_ssl(buf, bytes, timeout));
+ }
+#endif
len = 0;
+ fd = CC->client_socket;
while(len<bytes) {
FD_ZERO(&rfds);
- FD_SET(CC->client_socket, &rfds);
+ FD_SET(fd, &rfds);
tv.tv_sec = timeout;
tv.tv_usec = 0;
- retval = select( (CC->client_socket)+1,
- &rfds, NULL, NULL, &tv);
- if (FD_ISSET(CC->client_socket, &rfds) == 0) {
+ retval = select( (fd)+1,
+ &rfds, NULL, NULL, &tv);
+
+ if (FD_ISSET(fd, &rfds) == 0) {
return(0);
- }
+ }
- rlen = read(CC->client_socket, &buf[len], bytes-len);
+ rlen = read(fd, &buf[len], bytes-len);
if (rlen<1) {
- lprintf(2, "client_read() failed: %s\n",
- strerror(errno));
- cleanup(errno);
- }
- len = len + rlen;
+ /* The socket has been disconnected! */
+ CC->kill_me = 1;
+ return(-1);
}
- return(1);
+ len = len + rlen;
}
+ return(1);
+}
/*
* Read data from the client socket with default timeout.
* (This is implemented in terms of client_read_to() and could be
* justifiably moved out of sysdep.c)
*/
-int client_read(char *buf, int bytes)
+INLINE int client_read(char *buf, int bytes)
{
return(client_read_to(buf, bytes, config.c_sleeping));
- }
+}
/*
- * 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;
*/
for (i = 0;;i++) {
retval = client_read(&buf[i], 1);
- if (retval != 1 || buf[i] == '\n' || i == 255)
+ if (retval != 1 || buf[i] == '\n' || i == (bufsize-1))
break;
- }
+ }
/* If we got a long line, discard characters until the newline.
*/
- if (i == 255)
+ if (i == (bufsize-1))
while (buf[i] != '\n' && retval == 1)
retval = client_read(&buf[i], 1);
- /* Strip the trailing newline and any trailing nonprintables (cr's)
+ /* Strip the trailing LF, and the trailing CR if present.
*/
buf[i] = 0;
- while ((strlen(buf)>0)&&(!isprint(buf[strlen(buf)-1])))
- buf[strlen(buf)-1] = 0;
- return(retval);
+ while ( (i > 0)
+ && ( (buf[i - 1]==13)
+ || ( buf[i - 1]==10)) ) {
+ i--;
+ buf[i] = 0;
}
+ if (retval < 0) safestrncpy(&buf[i], "000", bufsize - i);
+ return(retval);
+}
* 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;
-/*
- * Cleanup routine to be called when one thread is shutting down.
- */
-void cleanup(int exit_code)
-{
- /* Terminate the thread.
- * Its cleanup handler will call cleanup_stuff()
+///// DestroyWorkerList();
+ /*
+ * close all protocol master sockets
*/
- lprintf(7, "Calling pthread_exit()\n");
- pthread_exit(NULL);
+ for (serviceptr = ServiceHookTable; serviceptr != NULL;
+ serviceptr = serviceptr->next ) {
+
+ if (serviceptr->tcp_port > 0)
+ lprintf(CTDL_INFO, "Closing listener on port %d\n",
+ serviceptr->tcp_port);
+
+ if (serviceptr->sockpath != NULL)
+ lprintf(CTDL_INFO, "Closing listener on '%s'\n",
+ serviceptr->sockpath);
+
+ close(serviceptr->msock);
+
+ /* If it's a Unix domain socket, remove the file. */
+ if (serviceptr->sockpath != NULL) {
+ unlink(serviceptr->sockpath);
+ }
}
+#ifdef HAVE_OPENSSL
+ destruct_ssl();
+#endif
+ serv_calendar_destroy();
+ CtdlDestroyProtoHooks();
+ CtdlDestroyDeleteHooks();
+ CtdlDestroyXmsgHooks();
+ CtdlDestroyNetprocHooks();
+ CtdlDestroyUserHooks();
+ CtdlDestroyMessageHook();
+ CtdlDestroyCleanupHooks();
+ CtdlDestroyFixedOutputHooks();
+ CtdlDestroySessionHooks();
+ CtdlDestroyServiceHook();
+ #ifdef HAVE_BACKTRACE
+ eCrash_Uninit();
+ #endif
+}
+
+
+
/*
* Terminate another session.
+ * (This could justifiably be moved out of sysdep.c because it
+ * no longer does anything that is system-dependent.)
*/
void kill_session(int session_to_kill) {
struct CitContext *ptr;
- THREAD killme = 0;
- lprintf(9, "kill_session() scanning for thread to cancel...\n");
begin_critical_section(S_SESSION_TABLE);
for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
if (ptr->cs_pid == session_to_kill) {
- killme = ptr->mythread;
- }
+ ptr->kill_me = 1;
}
+ }
end_critical_section(S_SESSION_TABLE);
- lprintf(9, "kill_session() finished scanning.\n");
+}
- if (killme != 0) {
-#ifdef HAVE_PTHREAD_CANCEL
- lprintf(9, "calling pthread_cancel()\n");
- pthread_cancel(killme);
-#else
- pthread_kill(killme, SIGUSR1);
-#ifdef __FreeBSD__
- /* there's a very stupid bug in the user threads package on
- FreeBSD 3.1 which prevents a signal from being properly
- dispatched to a thread that's in a blocking syscall. the
- first signal interrupts the syscall, the second one actually
- gets delivered. */
- pthread_kill(killme, SIGUSR1);
-#endif
-#endif
- }
- }
+pid_t current_child;
+void graceful_shutdown(int signum) {
+ kill(current_child, signum);
+ unlink(file_pid_file);
+ exit(0);
+}
/*
- * The system-dependent wrapper around the main context loop.
+ * Start running as a daemon.
*/
-void *sd_context_loop(struct CitContext *con) {
- pthread_cleanup_push(*cleanup_stuff, NULL);
- context_loop(con);
- pthread_cleanup_pop(0);
- return NULL;
- }
+void start_daemon(int unused) {
+ int status = 0;
+ pid_t child = 0;
+ FILE *fp;
+ int do_restart = 0;
+ current_child = 0;
-/*
- * Start running as a daemon. Only close stdio if do_close_stdio is set.
- */
-void start_daemon(int do_close_stdio) {
- if (do_close_stdio) {
- /* close(0); */
- close(1);
- close(2);
- }
- signal(SIGHUP,SIG_IGN);
- signal(SIGINT,SIG_IGN);
- signal(SIGQUIT,SIG_IGN);
- if (fork()!=0) exit(0);
+ /* Close stdin/stdout/stderr and replace them with /dev/null.
+ * We don't just call close() because we don't want these fd's
+ * to be reused for other files.
+ */
+ chdir(ctdl_run_dir);
+
+ child = fork();
+ if (child != 0) {
+ exit(0);
}
+
+ signal(SIGHUP, SIG_IGN);
+ signal(SIGINT, SIG_IGN);
+ signal(SIGQUIT, SIG_IGN);
+ setsid();
+ umask(0);
+ freopen("/dev/null", "r", stdin);
+ freopen("/dev/null", "w", stdout);
+ freopen("/dev/null", "w", stderr);
+ do {
+ current_child = fork();
-/*
- * Tie in to the 'netsetup' program.
- *
- * (We're going to hope that netsetup never feeds more than 4096 bytes back.)
- */
-void cmd_nset(char *cmdbuf)
-{
- int retcode;
- char fbuf[4096];
- FILE *netsetup;
- int ch;
- int a, b;
- char netsetup_args[3][256];
-
- if (CC->usersupp.axlevel < 6) {
- cprintf("%d Higher access required.\n",
- ERROR + HIGHER_ACCESS_REQUIRED);
- return;
+ signal(SIGTERM, graceful_shutdown);
+
+ if (current_child < 0) {
+ perror("fork");
+ exit(errno);
}
-
- for (a=1; a<=3; ++a) {
- if (num_parms(cmdbuf) >= a) {
- extract(netsetup_args[a-1], cmdbuf, a-1);
- for (b=0; b<strlen(netsetup_args[a-1]); ++b) {
- if (netsetup_args[a-1][b] == 34) {
- netsetup_args[a-1][b] = '_';
- }
- }
- }
+
+ else if (current_child == 0) {
+ return; /* continue starting citadel. */
+ }
+
else {
- netsetup_args[a-1][0] = 0;
+ fp = fopen(file_pid_file, "w");
+ if (fp != NULL) {
+ /*
+ * NB.. The pid file contains the pid of the actual server.
+ * This is not the pid of the watcher process
+ */
+ fprintf(fp, ""F_PID_T"\n", current_child);
+ fclose(fp);
}
+ waitpid(current_child, &status, 0);
}
- sprintf(fbuf, "./netsetup \"%s\" \"%s\" \"%s\" </dev/null 2>&1",
- netsetup_args[0], netsetup_args[1], netsetup_args[2]);
- netsetup = popen(fbuf, "r");
- if (netsetup == NULL) {
- cprintf("%d %s\n", ERROR, strerror(errno));
- return;
- }
+ do_restart = 0;
- fbuf[0] = 0;
- while (ch = getc(netsetup), (ch > 0)) {
- fbuf[strlen(fbuf)+1] = 0;
- fbuf[strlen(fbuf)] = ch;
- }
+ /* Did the main process exit with an actual exit code? */
+ if (WIFEXITED(status)) {
- retcode = pclose(netsetup);
+ /* Exit code 0 means the watcher should exit */
+ if (WEXITSTATUS(status) == 0) {
+ do_restart = 0;
+ }
- if (retcode != 0) {
- for (a=0; a<strlen(fbuf); ++a) {
- if (fbuf[a] < 32) fbuf[a] = 32;
+ /* Exit code 101-109 means the watcher should exit */
+ else if ( (WEXITSTATUS(status) >= 101) && (WEXITSTATUS(status) <= 109) ) {
+ do_restart = 0;
+ }
+
+ /* Any other exit code means we should restart. */
+ else {
+ do_restart = 1;
}
- fbuf[245] = 0;
- cprintf("%d %s\n", ERROR, fbuf);
- return;
}
- cprintf("%d Command succeeded. Output follows:\n", LISTING_FOLLOWS);
- cprintf("%s", fbuf);
- if (fbuf[strlen(fbuf)-1] != 10) cprintf("\n");
- cprintf("000\n");
- }
+ /* Any other type of termination (signals, etc.) should also restart. */
+ else {
+ do_restart = 1;
+ }
+
+ } while (do_restart);
+
+ unlink(file_pid_file);
+ exit(WEXITSTATUS(status));
+}
pw = getpwnam(NameToConvert);
if (pw == NULL) {
return(0);
- }
+ }
else {
strcpy(NameToConvert, pw->pw_gecos);
for (a=0; a<strlen(NameToConvert); ++a) {
if (NameToConvert[a] == ',') NameToConvert[a] = 0;
- }
- return(1);
}
+ return(1);
+ }
+}
+
+struct worker_node *worker_list = NULL;
+
+
+/*
+ * create a worker thread. this function must always be called from within
+ * an S_WORKER_LIST critical section!
+ */
+void create_worker(void) {
+ int ret;
+ struct worker_node *n;
+ pthread_attr_t attr;
+
+ n = malloc(sizeof(struct worker_node));
+ if (n == NULL) {
+ lprintf(CTDL_EMERG, "can't allocate worker_node, exiting\n");
+ time_to_die = -1;
+ return;
}
+ if ((ret = pthread_attr_init(&attr))) {
+ lprintf(CTDL_EMERG, "pthread_attr_init: %s\n", strerror(ret));
+ time_to_die = -1;
+ return;
+ }
+ /* 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, THREADSTACKSIZE))) {
+ lprintf(CTDL_EMERG, "pthread_attr_setstacksize: %s\n",
+ strerror(ret));
+ time_to_die = -1;
+ pthread_attr_destroy(&attr);
+ return;
+ }
+ if ((ret = pthread_create(&n->tid, &attr, worker_thread, NULL) != 0))
+ {
+ lprintf(CTDL_ALERT, "Can't create worker thread: %s\n",
+ strerror(ret));
+ }
+
+ n->next = worker_list;
+ worker_list = n;
+ pthread_attr_destroy(&attr);
+}
+
+void DestroyWorkerList(void)
+{
+ struct CitContext *ptr; /* general-purpose utility pointer */
+ struct CitContext *rem = NULL; /* list of sessions to be destroyed */
+
+ begin_critical_section(S_SESSION_TABLE);
+ ptr = ContextList;
+ while (ptr != NULL){
+ /* Remove the session from the active list */
+ rem = ptr->next;
+ --num_sessions;
+
+ lprintf(CTDL_DEBUG, "Purging session %d\n", rem->cs_pid);
+ end_critical_section(S_SESSION_TABLE);
+ RemoveContext(ptr);
+ begin_critical_section(S_SESSION_TABLE);
+ free (ptr);
+ ptr = rem;
+ }
+ end_critical_section(S_SESSION_TABLE);
+
+ struct worker_node *cur, *p;
+ cur = worker_list;
+ while (cur != NULL)
+ {
+ p = cur->next;
+ free (cur);
+ cur = p;
+ }
+ worker_list = NULL;
+}
+
+/*
+ * Create the maintenance threads and begin their operation.
+ */
+void create_maintenance_threads(void) {
+ int ret;
+ pthread_attr_t attr;
+
+ if ((ret = pthread_attr_init(&attr))) {
+ lprintf(CTDL_EMERG, "pthread_attr_init: %s\n", strerror(ret));
+ time_to_die = -1;
+ return;
+ }
+
+ /* 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, THREADSTACKSIZE))) {
+ lprintf(CTDL_EMERG, "pthread_attr_setstacksize: %s\n",
+ strerror(ret));
+ time_to_die = -1;
+ pthread_attr_destroy(&attr);
+ return;
+ }
+ struct MaintenanceThreadHook *fcn;
+
+ lprintf(CTDL_DEBUG, "Performing startup of maintenance thread hooks\n");
+
+ for (fcn = MaintenanceThreadHookTable; fcn != NULL; fcn = fcn->next) {
+ if ((ret = pthread_create(&(fcn->MaintenanceThread_tid), &attr, fcn->fcn_ptr, NULL) != 0)) {
+ lprintf(CTDL_ALERT, "Can't create thread: %s\n", strerror(ret));
+ }
+ else
+ {
+ lprintf(CTDL_NOTICE, "Spawned a new maintenance thread \"%s\" (%ld). \n", fcn->name,
+ fcn->MaintenanceThread_tid);
+ }
+ }
+
+
+ pthread_attr_destroy(&attr);
+}
+
+
/*
- * Here's where it all begins.
+ * Purge all sessions which have the 'kill_me' flag set.
+ * This function has code to prevent it from running more than once every
+ * few seconds, because running it after every single unbind would waste a lot
+ * of CPU time and keep the context list locked too much. To force it to run
+ * anyway, set "force" to nonzero.
+ *
+ *
+ * After that's done, we raise the size of the worker thread pool
+ * if such an action is appropriate.
*/
-int main(int argc, char **argv)
-{
- struct sockaddr_in fsin; /* Data for master socket */
- int alen; /* Data for master socket */
- int ssock; /* Descriptor for master socket */
- THREAD SessThread; /* Thread descriptor */
- pthread_attr_t attr; /* Thread attributes */
- struct CitContext *con; /* Temporary context pointer */
- char tracefile[128]; /* Name of file to log traces to */
- int a, i; /* General-purpose variables */
+void dead_session_purge(int force) {
+ struct CitContext *ptr; /* general-purpose utility pointer */
+ struct CitContext *rem = NULL; /* list of sessions to be destroyed */
+
+ if (force == 0) {
+ if ( (time(NULL) - last_purge) < 5 ) {
+ return; /* Too soon, go away */
+ }
+ }
+ time(&last_purge);
+
+ begin_critical_section(S_SESSION_TABLE);
+ for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
+ if ( (ptr->state == CON_IDLE) && (ptr->kill_me) ) {
+
+ /* Remove the session from the active list */
+ if (ptr->prev) {
+ ptr->prev->next = ptr->next;
+ }
+ else {
+ ContextList = ptr->next;
+ }
+ if (ptr->next) {
+ ptr->next->prev = ptr->prev;
+ }
+
+ --num_sessions;
+
+ /* And put it on our to-be-destroyed list */
+ ptr->next = rem;
+ rem = ptr;
+
+ }
+ }
+ end_critical_section(S_SESSION_TABLE);
+
+ /* Now that we no longer have the session list locked, we can take
+ * our time and destroy any sessions on the to-be-killed list, which
+ * is allocated privately on this thread's stack.
+ */
+ while (rem != NULL) {
+ lprintf(CTDL_DEBUG, "Purging session %d\n", rem->cs_pid);
+ RemoveContext(rem);
+ ptr = rem;
+ rem = rem->next;
+ free(ptr);
+ }
+
+ /* Raise the size of the worker thread pool if necessary. */
+ if ( (num_sessions > num_threads)
+ && (num_threads < config.c_max_workers) ) {
+ begin_critical_section(S_WORKER_LIST);
+ create_worker();
+ end_critical_section(S_WORKER_LIST);
+ }
+}
+
+
+
+
+
+/*
+ * 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;
+ masterCC.cs_pid = 0;
+}
+
+
+
+
+
+
+/*
+ * Bind a thread to a context. (It's inline merely to speed things up.)
+ */
+INLINE void become_session(struct CitContext *which_con) {
+ pthread_setspecific(MyConKey, (void *)which_con );
+}
+
+
+
+/*
+ * This loop just keeps going and going and going...
+ */
+void *worker_thread(void *arg) {
+ int i;
+ int highest;
+ struct CitContext *ptr;
+ struct CitContext *bind_me = NULL;
fd_set readfds;
+ int retval = 0;
+ struct CitContext *con= NULL; /* Temporary context pointer */
+ struct ServiceFunctionHook *serviceptr;
+ int ssock; /* Descriptor for client socket */
struct timeval tv;
- struct passwd *pw;
- int drop_root_perms = 1;
- char *moddir;
-
- /* specify default port name and trace file */
- strcpy(tracefile, "");
-
- /* parse command-line arguments */
- for (a=1; a<argc; ++a) {
-
- /* -t specifies where to log trace messages to */
- if (!strncmp(argv[a], "-t", 2)) {
- strcpy(tracefile, argv[a]);
- strcpy(tracefile, &tracefile[2]);
- freopen(tracefile, "r", stdin);
- freopen(tracefile, "w", stdout);
- freopen(tracefile, "w", stderr);
- }
+ int force_purge = 0;
+ int m;
- /* run in the background if -d was specified */
- else if (!strcmp(argv[a], "-d")) {
- start_daemon( (strlen(tracefile) > 0) ? 0 : 1 ) ;
- }
+ num_threads++;
- /* -x specifies the desired logging level */
- else if (!strncmp(argv[a], "-x", 2)) {
- verbosity = atoi(&argv[a][2]);
- }
+ cdb_allocate_tsd();
- else if (!strncmp(argv[a], "-h", 2)) {
- safestrncpy(bbs_home_directory, &argv[a][2],
- sizeof bbs_home_directory);
- home_specified = 1;
- }
+ // Register for tracing
+ #ifdef HAVE_BACKTRACE
+ eCrash_RegisterThread("WorkerThread", 0);
+ #endif
+ while (!time_to_die) {
- /* -r tells the server not to drop root permissions. don't use
- * this unless you know what you're doing. this should be
- * removed in the next release if it proves unnecessary. */
- else if (!strcmp(argv[a], "-r"))
- drop_root_perms = 0;
+ /* make doubly sure we're not holding any stale db handles
+ * which might cause a deadlock.
+ */
+ cdb_check_handles();
+do_select: force_purge = 0;
+ bind_me = NULL; /* Which session shall we handle? */
- /* any other parameter makes it crash and burn */
- else {
- lprintf(1, "citserver: usage: ");
- lprintf(1, "citserver [-tTraceFile]");
- lprintf(1, " [-d] [-xLogLevel] [-hHomeDir]\n");
- exit(1);
+ /* Initialize the fdset. */
+ FD_ZERO(&readfds);
+ highest = 0;
+
+ 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;
+ }
+ if ((bind_me == NULL) && (ptr->state == CON_READY)) {
+ bind_me = ptr;
+ ptr->state = CON_EXECUTING;
}
+ }
+ end_critical_section(S_SESSION_TABLE);
+ if (bind_me) {
+ goto SKIP_SELECT;
}
- /* Tell 'em who's in da house */
- lprintf(1,
-"\nMultithreaded message server for Citadel/UX\n"
-"Copyright (C) 1987-1999 by the Citadel/UX development team.\n"
-"Citadel/UX is free software, covered by the GNU General Public License, and\n"
-"you are welcome to change it and/or distribute copies of it under certain\n"
-"conditions. There is absolutely no warranty for this software. Please\n"
-"read the 'COPYING.txt' file for details.\n\n");
-
- /* Initialize... */
- init_sysdep();
- openlog("citserver",LOG_PID,LOG_USER);
- /* Load site-specific parameters */
- lprintf(7, "Loading citadel.config\n");
- get_config();
+ /* If we got this far, it means that there are no sessions
+ * which a previous thread marked for attention, so we go
+ * ahead and get ready to select().
+ */
- /*
- * 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.
- */
- 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);
+ /* First, add the various master sockets to the fdset. */
+ for (serviceptr = ServiceHookTable; serviceptr != NULL;
+ serviceptr = serviceptr->next ) {
+ m = serviceptr->msock;
+ FD_SET(m, &readfds);
+ if (m > highest) {
+ highest = m;
+ }
+ }
- /*
- * Now that we've bound the socket, change to the BBS user id and its
- * corresponding group ids
- */
- if (drop_root_perms) {
- if ((pw = getpwuid(BBSUID)) == NULL)
- lprintf(1, "WARNING: getpwuid(%d): %s\n"
- "Group IDs will be incorrect.\n", BBSUID,
- strerror(errno));
- else {
- initgroups(pw->pw_name, pw->pw_gid);
- if (setgid(pw->pw_gid))
- lprintf(3, "setgid(%d): %s\n", pw->pw_gid,
+ if (!time_to_die) {
+ tv.tv_sec = 1; /* wake up every second if no input */
+ tv.tv_usec = 0;
+ retval = select(highest + 1, &readfds, NULL, NULL, &tv);
+ }
+
+ if (time_to_die) return(NULL);
+
+ /* Now figure out who made this select() unblock.
+ * First, check for an error or exit condition.
+ */
+ if (retval < 0) {
+ if (errno == EBADF) {
+ lprintf(CTDL_NOTICE, "select() failed: (%s)\n",
strerror(errno));
+ goto do_select;
}
- lprintf(7, "Changing uid to %d\n", BBSUID);
- if (setuid(BBSUID) != 0) {
- lprintf(3, "setuid() failed: %s\n", strerror(errno));
+ if (errno != EINTR) {
+ lprintf(CTDL_EMERG, "Exiting (%s)\n", strerror(errno));
+ time_to_die = 1;
+ } else if (!time_to_die)
+ goto do_select;
+ }
+
+ /* Next, check to see if it's a new client connecting
+ * on a master socket.
+ */
+ else for (serviceptr = ServiceHookTable; serviceptr != NULL;
+ serviceptr = serviceptr->next ) {
+
+ if (FD_ISSET(serviceptr->msock, &readfds)) {
+ ssock = accept(serviceptr->msock, NULL, 0);
+ if (ssock >= 0) {
+ lprintf(CTDL_DEBUG,
+ "New client socket %d\n",
+ ssock);
+
+ /* The master socket is non-blocking but the client
+ * sockets need to be blocking, otherwise certain
+ * operations barf on FreeBSD. Not a fatal error.
+ */
+ if (fcntl(ssock, F_SETFL, 0) < 0) {
+ lprintf(CTDL_EMERG,
+ "citserver: Can't set socket to blocking: %s\n",
+ strerror(errno));
+ }
+
+ /* 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;
+ con->h_command_function =
+ serviceptr->h_command_function;
+ con->h_async_function =
+ serviceptr->h_async_function;
+ con->ServiceName =
+ serviceptr->ServiceName;
+
+ /* Determine whether it's a local socket */
+ if (serviceptr->sockpath != NULL)
+ con->is_local_socket = 1;
+
+ /* 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 do_select;
+ }
}
}
- 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);
+ /* 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
+ * CON_READY so the next thread that comes around can just bind
+ * to one without having to select() again.
+ */
+ begin_critical_section(S_SESSION_TABLE);
+ for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
+ if ( (FD_ISSET(ptr->client_socket, &readfds))
+ && (ptr->state != CON_EXECUTING) ) {
+ ptr->input_waiting = 1;
+ if (!bind_me) {
+ bind_me = ptr; /* I choose you! */
+ bind_me->state = CON_EXECUTING;
+ }
+ else {
+ ptr->state = CON_READY;
+ }
+ }
}
- lprintf(9, "Modules done initializing.\n");
+ end_critical_section(S_SESSION_TABLE);
- /*
- * Do non system dependent startup functions.
- */
- master_startup();
+SKIP_SELECT:
+ /* We're bound to a session */
+ if (bind_me != NULL) {
+ become_session(bind_me);
- /*
- * Endless loop. Listen on the master socket. When a connection
- * comes in, create a socket, a context, and a thread.
- */
- while (!time_to_die) {
- /* we need to check if a signal has been delivered. because
- * syscalls may be restartable across signals, we call
- * select with a timeout of 1 second and repeatedly check for
- * time_to_die... */
- FD_ZERO(&readfds);
- FD_SET(msock, &readfds);
- tv.tv_sec = 1;
- tv.tv_usec = 0;
- if (select(msock + 1, &readfds, NULL, NULL, &tv) <= 0)
- continue;
- alen = sizeof fsin;
- ssock = accept(msock, (struct sockaddr *)&fsin, &alen);
- if (ssock < 0) {
- lprintf(2, "citserver: accept() failed: %s\n",
- strerror(errno));
+ /* If the client has sent a command, execute it. */
+ if (CC->input_waiting) {
+ CC->h_command_function();
+ CC->input_waiting = 0;
}
- else {
- lprintf(7, "citserver: Client socket %d\n", ssock);
- lprintf(9, "creating context\n");
- con = CreateNewContext();
- con->client_socket = ssock;
-
- /* Set the SO_REUSEADDR socket option */
- lprintf(9, "setting socket options\n");
- i = 1;
- setsockopt(ssock, SOL_SOCKET, SO_REUSEADDR,
- &i, sizeof(i));
-
- /* set attributes for the new thread */
- lprintf(9, "setting thread attributes\n");
- pthread_attr_init(&attr);
- pthread_attr_setdetachstate(&attr,
- PTHREAD_CREATE_DETACHED);
-
- /* now create the thread */
- lprintf(9, "creating thread\n");
- if (pthread_create(&SessThread, &attr,
- (void* (*)(void*)) sd_context_loop,
- con)
- != 0) {
- lprintf(1,
- "citserver: can't create thread: %s\n",
- strerror(errno));
- }
- /* detach the thread
- * (defunct -- now done at thread creation time)
- * if (pthread_detach(&SessThread) != 0) {
- * lprintf(1,
- * "citserver: can't detach thread: %s\n",
- * strerror(errno));
- * }
- */
- lprintf(9, "done!\n");
+ /* If there are asynchronous messages waiting and the
+ * client supports it, do those now */
+ if ((CC->is_async) && (CC->async_waiting)
+ && (CC->h_async_function != NULL)) {
+ CC->h_async_function();
+ CC->async_waiting = 0;
+ }
+
+ force_purge = CC->kill_me;
+ become_session(NULL);
+ bind_me->state = CON_IDLE;
+ }
+
+ dead_session_purge(force_purge);
+ do_housekeeping();
+ check_sched_shutdown();
+ }
+ if (con != NULL) free (con);//// TODO: could this harm other threads?
+ /* If control reaches this point, the server is shutting down */
+ #ifdef HAVE_BACKTRACE
+ eCrash_UnregisterThread();
+ #endif
+ 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;
+ }
+ enable_syslog = 0;
+ return LOG_DAEMON;
+}
+
+
+/********** MEM CHEQQER ***********/
+
+#ifdef DEBUG_MEMORY_LEAKS
+
+#undef malloc
+#undef realloc
+#undef strdup
+#undef free
+
+void *tracked_malloc(size_t size, char *file, int line) {
+ struct igheap *thisheap;
+ void *block;
+
+ block = malloc(size);
+ if (block == NULL) return(block);
+
+ thisheap = malloc(sizeof(struct igheap));
+ if (thisheap == NULL) {
+ free(block);
+ return(NULL);
+ }
+
+ thisheap->block = block;
+ strcpy(thisheap->file, file);
+ thisheap->line = line;
+
+ begin_critical_section(S_DEBUGMEMLEAKS);
+ thisheap->next = igheap;
+ igheap = thisheap;
+ end_critical_section(S_DEBUGMEMLEAKS);
+
+ return(block);
+}
+
+
+void *tracked_realloc(void *ptr, size_t size, char *file, int line) {
+ struct igheap *thisheap;
+ void *block;
+
+ block = realloc(ptr, size);
+ if (block == NULL) return(block);
+
+ thisheap = malloc(sizeof(struct igheap));
+ if (thisheap == NULL) {
+ free(block);
+ return(NULL);
+ }
+
+ thisheap->block = block;
+ strcpy(thisheap->file, file);
+ thisheap->line = line;
+
+ begin_critical_section(S_DEBUGMEMLEAKS);
+ thisheap->next = igheap;
+ igheap = thisheap;
+ end_critical_section(S_DEBUGMEMLEAKS);
+
+ return(block);
+}
+
+
+
+void tracked_free(void *ptr) {
+ struct igheap *thisheap;
+ struct igheap *trash;
+
+ free(ptr);
+
+ if (igheap == NULL) return;
+ begin_critical_section(S_DEBUGMEMLEAKS);
+ for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
+ if (thisheap->next != NULL) {
+ if (thisheap->next->block == ptr) {
+ trash = thisheap->next;
+ thisheap->next = thisheap->next->next;
+ free(trash);
}
}
- master_cleanup();
- return 0;
}
+ if (igheap->block == ptr) {
+ trash = igheap;
+ igheap = igheap->next;
+ free(trash);
+ }
+ end_critical_section(S_DEBUGMEMLEAKS);
+}
+
+char *tracked_strdup(const char *s, char *file, int line) {
+ char *ptr;
+
+ if (s == NULL) return(NULL);
+ ptr = tracked_malloc(strlen(s) + 1, file, line);
+ if (ptr == NULL) return(NULL);
+ strncpy(ptr, s, strlen(s));
+ return(ptr);
+}
+
+void dump_heap(void) {
+ struct igheap *thisheap;
+
+ for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
+ lprintf(CTDL_CRIT, "UNFREED: %30s : %d\n",
+ thisheap->file, thisheap->line);
+ }
+}
+#endif /* DEBUG_MEMORY_LEAKS */
projects / citadel.git / blobdiff