#include <errno.h>
#include <stdarg.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 "tools.h"
#include "modules/crypto/serv_crypto.h" /* Needed for init_ssl, client_write_ssl, client_read_ssl, destruct_ssl */
#include "ecrash.h"
#include "snprintf.h"
#endif
+#include "ctdl_module.h"
+#include "threads.h"
#ifdef DEBUG_MEMORY_LEAKS
struct igheap {
#endif
-pthread_mutex_t Critters[MAX_SEMAPHORES]; /* Things needing locking */
-pthread_key_t MyConKey; /* TSD key for MyContext() */
+citthread_key_t MyConKey; /* TSD key for MyContext() */
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;
-void DestroyWorkerList(void);
-
/*
* Create an interface to lprintf that follows the coding convention.
* Signal handler to shut down the server.
*/
-volatile int time_to_die = 0;
+volatile int exit_signal = 0;
volatile int shutdown_and_halt = 0;
volatile int restart_server = 0;
volatile int running_as_daemon = 0;
static RETSIGTYPE signal_cleanup(int signum) {
- lprintf(CTDL_DEBUG, "Caught signal %d; shutting down.\n", signum);
- time_to_die = 1;
- master_cleanup(signum);
-}
-
-
-
-
-void InitialiseSemaphores(void)
-{
- int i;
-
- /* 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);
+ CtdlLogPrintf(CTDL_DEBUG, "Caught signal %d; shutting down.\n", signum);
+#ifdef THREADS_USESIGNALS
+ if (CT)
+ {
+ CtdlLogPrintf(CTDL_DEBUG, "Thread \"%s\" caught signal %d.\n", CT->name, signum);
+ CT->signal = signum;
}
+ else
+#endif
+ exit_signal = signum;
}
* 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(CTDL_CRIT, "Can't create TSD key: %s\n",
+ if (citthread_key_create(&MyConKey, NULL) != 0) {
+ CtdlLogPrintf(CTDL_CRIT, "Can't create TSD key: %s\n",
strerror(errno));
}
}
-/*
- * Obtain a semaphore lock to begin a critical section.
- */
-void begin_critical_section(int which_one)
-{
- /* lprintf(CTDL_DEBUG, "begin_critical_section(%d)\n", which_one); */
-
- /* 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
- && (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)
-{
- pthread_mutex_unlock(&Critters[which_one]);
-}
-
/*
snprintf(*errormessage, SIZ,
"citserver: Can't create a socket: %s",
strerror(errno));
- lprintf(CTDL_EMERG, "%s\n", *errormessage);
+ CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
return(-1);
}
snprintf(*errormessage, SIZ,
"citserver: Can't bind: %s",
strerror(errno));
- lprintf(CTDL_EMERG, "%s\n", *errormessage);
+ CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
close(s);
return(-1);
}
snprintf(*errormessage, SIZ,
"citserver: Can't set socket to non-blocking: %s",
strerror(errno));
- lprintf(CTDL_EMERG, "%s\n", *errormessage);
+ CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
close(s);
return(-1);
}
snprintf(*errormessage, SIZ,
"citserver: Can't listen: %s",
strerror(errno));
- lprintf(CTDL_EMERG, "%s\n", *errormessage);
+ CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
close(s);
return(-1);
}
*errormessage = (char*) malloc(SIZ + 1);
snprintf(*errormessage, SIZ, "citserver: can't unlink %s: %s",
sockpath, strerror(errno));
- lprintf(CTDL_EMERG, "%s\n", *errormessage);
+ CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
return(-1);
}
snprintf(*errormessage, SIZ,
"citserver: Can't create a socket: %s",
strerror(errno));
- lprintf(CTDL_EMERG, "%s\n", *errormessage);
+ CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
return(-1);
}
snprintf(*errormessage, SIZ,
"citserver: Can't bind: %s",
strerror(errno));
- lprintf(CTDL_EMERG, "%s\n", *errormessage);
+ CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
return(-1);
}
snprintf(*errormessage, SIZ,
"citserver: Can't set socket to non-blocking: %s",
strerror(errno));
- lprintf(CTDL_EMERG, "%s\n", *errormessage);
+ CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
close(s);
return(-1);
}
snprintf(*errormessage, SIZ,
"citserver: Can't listen: %s",
strerror(errno));
- lprintf(CTDL_EMERG, "%s\n", *errormessage);
+ CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
return(-1);
}
register struct CitContext *c;
- return ((c = (struct CitContext *) pthread_getspecific(MyConKey),
+ return ((c = (struct CitContext *) citthread_getspecific(MyConKey),
c == NULL) ? &masterCC : c
);
}
me = (struct CitContext *) malloc(sizeof(struct CitContext));
if (me == NULL) {
- lprintf(CTDL_ALERT, "citserver: can't allocate memory!!\n");
+ CtdlLogPrintf(CTDL_ALERT, "citserver: can't allocate memory!!\n");
return NULL;
}
memset(me, 0, sizeof(struct CitContext));
* being set up.
*/
me->state = CON_EXECUTING;
-
/*
* Generate a unique session number and insert this context into
* the list.
}
++num_sessions;
end_critical_section(S_SESSION_TABLE);
- return(me);
+ return (me);
}
retval = write(Ctx->client_socket, &buf[bytes_written],
nbytes - bytes_written);
if (retval < 1) {
- lprintf(CTDL_ERR,
+ CtdlLogPrintf(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]);
+ // CtdlLogPrintf(CTDL_DEBUG, "Tried to send: %s", &buf[bytes_written]);
Ctx->kill_me = 1;
return;
}
}
-
/*
- * The system-dependent part of master_cleanup() - close the master socket.
+ * Cleanup any contexts that are left lying around
*/
-void sysdep_master_cleanup(void) {
- struct ServiceFunctionHook *serviceptr;
+void context_cleanup(void)
+{
+ struct CitContext *ptr = NULL;
+ struct CitContext *rem = NULL;
-///// DestroyWorkerList();
+ /*
+ * Clean up the contexts.
+ * There are no threads so no critical_section stuff is needed.
+ */
+ ptr = ContextList;
+
+ /* We need to update the ContextList because some modules may want to itterate it
+ * Question is should we NULL it before iterating here or should we just keep updating it
+ * as we remove items?
+ *
+ * Answer is to NULL it first to prevent modules from doing any actions on the list at all
+ */
+ ContextList=NULL;
+ while (ptr != NULL){
+ /* Remove the session from the active list */
+ rem = ptr->next;
+ --num_sessions;
+
+ lprintf(CTDL_DEBUG, "Purging session %d\n", ptr->cs_pid);
+ RemoveContext(ptr);
+ free (ptr);
+ ptr = rem;
+ }
+}
+
+
+
+void close_masters (void)
+{
+ struct ServiceFunctionHook *serviceptr;
+
/*
* close all protocol master sockets
*/
serviceptr = serviceptr->next ) {
if (serviceptr->tcp_port > 0)
- lprintf(CTDL_INFO, "Closing listener on port %d\n",
+ {
+ CtdlLogPrintf(CTDL_INFO, "Closing listener on port %d\n",
serviceptr->tcp_port);
-
+ serviceptr->tcp_port = 0;
+ }
+
if (serviceptr->sockpath != NULL)
- lprintf(CTDL_INFO, "Closing listener on '%s'\n",
+ CtdlLogPrintf(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);
+ serviceptr->sockpath = NULL;
}
}
+}
+
+
+/*
+ * The system-dependent part of master_cleanup() - close the master socket.
+ */
+void sysdep_master_cleanup(void) {
+
+ close_masters();
+
+ context_cleanup();
+
#ifdef HAVE_OPENSSL
destruct_ssl();
#endif
- serv_calendar_destroy();
CtdlDestroyProtoHooks();
CtdlDestroyDeleteHooks();
CtdlDestroyXmsgHooks();
CtdlDestroyFixedOutputHooks();
CtdlDestroySessionHooks();
CtdlDestroyServiceHook();
+ CtdlDestroyRoomHooks();
+ CtdlDestroyDirectoryServiceFuncs();
#ifdef HAVE_BACKTRACE
eCrash_Uninit();
#endif
-
/*
* Terminate another session.
* (This could justifiably be moved out of sysdep.c because it
}
}
-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);
-}
-
-
-
/*
* 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.
*/
void dead_session_purge(int force) {
- struct CitContext *ptr; /* general-purpose utility pointer */
+ struct CitContext *ptr, *ptr2; /* 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) ) {
-
+ if (try_critical_section(S_SESSION_TABLE))
+ return;
+
+ ptr = ContextList;
+ while (ptr) {
+ ptr2 = ptr;
+ ptr = ptr->next;
+
+ if ( (ptr2->state == CON_IDLE) && (ptr2->kill_me) ) {
/* Remove the session from the active list */
- if (ptr->prev) {
- ptr->prev->next = ptr->next;
+ if (ptr2->prev) {
+ ptr2->prev->next = ptr2->next;
}
else {
- ContextList = ptr->next;
+ ContextList = ptr2->next;
}
- if (ptr->next) {
- ptr->next->prev = ptr->prev;
+ if (ptr2->next) {
+ ptr2->next->prev = ptr2->prev;
}
--num_sessions;
-
/* And put it on our to-be-destroyed list */
- ptr->next = rem;
- rem = ptr;
-
+ ptr2->next = rem;
+ rem = ptr2;
}
}
end_critical_section(S_SESSION_TABLE);
* is allocated privately on this thread's stack.
*/
while (rem != NULL) {
- lprintf(CTDL_DEBUG, "Purging session %d\n", rem->cs_pid);
+ CtdlLogPrintf(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);
- }
}
* 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 );
+ citthread_setspecific(MyConKey, (void *)which_con );
}
/*
* This loop just keeps going and going and going...
- */
+ */
+/*
+ * FIXME:
+ * This current implimentation of worker_thread creates a bottle neck in several situations
+ * The first thing to remember is that a single thread can handle more than one connection at a time.
+ * More threads mean less memory for the system to run in.
+ * So for efficiency we want every thread to be doing something useful or waiting in the main loop for
+ * something to happen anywhere.
+ * This current implimentation requires worker threads to wait in other locations, after it has
+ * been committed to a single connection which is very wasteful.
+ * As an extreme case consider this:
+ * A slow client connects and this slow client sends only one character each second.
+ * With this current implimentation a single worker thread is dispatched to handle that connection
+ * until such times as the client timeout expires, an error occurs on the socket or the client
+ * completes its transmission.
+ * THIS IS VERY BAD since that thread could have handled a read from many more clients in each one
+ * second interval between chars.
+ *
+ * It is my intention to re-write this code and the associated client_getln, client_read functions
+ * to allow any thread to read data on behalf of any connection (context).
+ * To do this I intend to have this main loop read chars into a buffer stored in the context.
+ * Once the correct criteria for a full buffer is met then we will dispatch a thread to
+ * process it.
+ * This worker thread loop also needs to be able to handle binary data.
+ */
+
void *worker_thread(void *arg) {
int i;
int highest;
struct timeval tv;
int force_purge = 0;
int m;
+
- num_threads++;
-
- cdb_allocate_tsd();
-
- // Register for tracing
- #ifdef HAVE_BACKTRACE
- eCrash_RegisterThread("WorkerThread", 0);
- #endif
- while (!time_to_die) {
+ while (!CtdlThreadCheckStop()) {
/* make doubly sure we're not holding any stale db handles
* which might cause a deadlock.
}
}
- if (!time_to_die) {
+ if (!CtdlThreadCheckStop()) {
tv.tv_sec = 1; /* wake up every second if no input */
tv.tv_usec = 0;
- retval = select(highest + 1, &readfds, NULL, NULL, &tv);
+ retval = CtdlThreadSelect(highest + 1, &readfds, NULL, NULL, &tv);
}
- if (time_to_die) return(NULL);
+ if (CtdlThreadCheckStop()) 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",
+ CtdlLogPrintf(CTDL_NOTICE, "select() failed: (%s)\n",
strerror(errno));
goto do_select;
}
if (errno != EINTR) {
- lprintf(CTDL_EMERG, "Exiting (%s)\n", strerror(errno));
- time_to_die = 1;
- } else if (!time_to_die)
+ CtdlLogPrintf(CTDL_EMERG, "Exiting (%s)\n", strerror(errno));
+ CtdlThreadStopAll();
+ } else if (!CtdlThreadCheckStop()) {
+ CtdlLogPrintf(CTDL_DEBUG, "Un handled select failure.\n");
goto do_select;
+ }
+ }
+ else if(retval == 0) {
+ goto SKIP_SELECT;
}
-
/* Next, check to see if it's a new client connecting
* on a master socket.
*/
if (FD_ISSET(serviceptr->msock, &readfds)) {
ssock = accept(serviceptr->msock, NULL, 0);
if (ssock >= 0) {
- lprintf(CTDL_DEBUG,
+ CtdlLogPrintf(CTDL_DEBUG,
"New client socket %d\n",
ssock);
* operations barf on FreeBSD. Not a fatal error.
*/
if (fcntl(ssock, F_SETFL, 0) < 0) {
- lprintf(CTDL_EMERG,
+ CtdlLogPrintf(CTDL_EMERG,
"citserver: Can't set socket to blocking: %s\n",
strerror(errno));
}
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);
}
struct igheap *thisheap;
for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
- lprintf(CTDL_CRIT, "UNFREED: %30s : %d\n",
+ CtdlLogPrintf(CTDL_CRIT, "UNFREED: %30s : %d\n",
thisheap->file, thisheap->line);
}
}