4 * Citadel "system dependent" stuff.
5 * See copyright.txt for copyright information.
7 * Here's where we (hopefully) have most parts of the Citadel server that
8 * would need to be altered to run the server in a non-POSIX environment.
10 * If we ever port to a different platform and either have multiple
11 * variants of this file or simply load it up with #ifdefs.
22 #include <sys/types.h>
25 #include <sys/socket.h>
27 #include <sys/syslog.h>
29 #if TIME_WITH_SYS_TIME
30 # include <sys/time.h>
34 # include <sys/time.h>
41 #include <sys/resource.h>
42 #include <netinet/in.h>
43 #include <netinet/tcp.h>
44 #include <arpa/inet.h>
55 #include <libcitadel.h>
58 #include "sysdep_decls.h"
59 #include "citserver.h"
63 #include "housekeeping.h"
64 #include "modules/crypto/serv_crypto.h" /* Needed for init_ssl, client_write_ssl, client_read_ssl, destruct_ssl */
67 #ifdef HAVE_SYS_SELECT_H
68 #include <sys/select.h>
75 #include "ctdl_module.h"
77 #ifdef DEBUG_MEMORY_LEAKS
85 struct igheap *igheap = NULL;
89 pthread_mutex_t Critters[MAX_SEMAPHORES]; /* Things needing locking */
90 pthread_key_t MyConKey; /* TSD key for MyContext() */
92 int verbosity = DEFAULT_VERBOSITY; /* Logging level */
94 struct CitContext masterCC;
95 time_t last_purge = 0; /* Last dead session purge */
96 static int num_threads = 0; /* Current number of threads */
97 static int num_workers = 0; /* Current number of worker threads */
98 int num_sessions = 0; /* Current number of sessions */
100 int syslog_facility = LOG_DAEMON;
101 int enable_syslog = 0;
105 * Create an interface to lprintf that follows the coding convention.
106 * This is here until such time as we have replaced all calls to lprintf with CtdlLogPrintf
109 void CtdlLogPrintf(enum LogLevel loglevel, const char *format, ...)
112 va_start(arg_ptr, format);
113 vlprintf(loglevel, format, arg_ptr);
119 * lprintf() ... Write logging information
121 void lprintf(enum LogLevel loglevel, const char *format, ...) {
123 va_start(arg_ptr, format);
124 vlprintf(loglevel, format, arg_ptr);
128 void vlprintf(enum LogLevel loglevel, const char *format, va_list arg_ptr)
130 char buf[SIZ], buf2[SIZ];
133 vsyslog((syslog_facility | loglevel), format, arg_ptr);
136 /* stderr output code */
137 if (enable_syslog || running_as_daemon) return;
139 /* if we run in forground and syslog is disabled, log to terminal */
140 if (loglevel <= verbosity) {
145 gettimeofday(&tv, NULL);
146 /* Promote to time_t; types differ on some OSes (like darwin) */
147 unixtime = tv.tv_sec;
148 localtime_r(&unixtime, &tim);
149 if (CC->cs_pid != 0) {
151 "%04d/%02d/%02d %2d:%02d:%02d.%06ld [%3d] ",
152 tim.tm_year + 1900, tim.tm_mon + 1,
153 tim.tm_mday, tim.tm_hour, tim.tm_min,
154 tim.tm_sec, (long)tv.tv_usec,
158 "%04d/%02d/%02d %2d:%02d:%02d.%06ld ",
159 tim.tm_year + 1900, tim.tm_mon + 1,
160 tim.tm_mday, tim.tm_hour, tim.tm_min,
161 tim.tm_sec, (long)tv.tv_usec);
163 vsprintf(buf2, format, arg_ptr);
165 fprintf(stderr, "%s%s", buf, buf2);
173 * Signal handler to shut down the server.
176 volatile int exit_signal = 0;
177 volatile int shutdown_and_halt = 0;
178 volatile int restart_server = 0;
179 volatile int running_as_daemon = 0;
181 static RETSIGTYPE signal_cleanup(int signum) {
182 CtdlLogPrintf(CTDL_DEBUG, "Caught signal %d; shutting down.\n", signum);
184 exit_signal = signum;
190 void InitialiseSemaphores(void)
194 /* Set up a bunch of semaphores to be used for critical sections */
195 for (i=0; i<MAX_SEMAPHORES; ++i) {
196 pthread_mutex_init(&Critters[i], NULL);
203 * Some initialization stuff...
205 void init_sysdep(void) {
208 /* Avoid vulnerabilities related to FD_SETSIZE if we can. */
212 getrlimit(RLIMIT_NOFILE, &rl);
213 rl.rlim_cur = FD_SETSIZE;
214 rl.rlim_max = FD_SETSIZE;
215 setrlimit(RLIMIT_NOFILE, &rl);
219 /* If we've got OpenSSL, we're going to use it. */
225 * Set up a place to put thread-specific data.
226 * We only need a single pointer per thread - it points to the
227 * CitContext structure (in the ContextList linked list) of the
228 * session to which the calling thread is currently bound.
230 if (pthread_key_create(&MyConKey, NULL) != 0) {
231 CtdlLogPrintf(CTDL_CRIT, "Can't create TSD key: %s\n",
236 * The action for unexpected signals and exceptions should be to
237 * call signal_cleanup() to gracefully shut down the server.
240 sigaddset(&set, SIGINT);
241 sigaddset(&set, SIGQUIT);
242 sigaddset(&set, SIGHUP);
243 sigaddset(&set, SIGTERM);
244 // sigaddset(&set, SIGSEGV); commented out because
245 // sigaddset(&set, SIGILL); we want core dumps
246 // sigaddset(&set, SIGBUS);
247 sigprocmask(SIG_UNBLOCK, &set, NULL);
249 signal(SIGINT, signal_cleanup);
250 signal(SIGQUIT, signal_cleanup);
251 signal(SIGHUP, signal_cleanup);
252 signal(SIGTERM, signal_cleanup);
253 // signal(SIGSEGV, signal_cleanup); commented out because
254 // signal(SIGILL, signal_cleanup); we want core dumps
255 // signal(SIGBUS, signal_cleanup);
258 * Do not shut down the server on broken pipe signals, otherwise the
259 * whole Citadel service would come down whenever a single client
262 //signal(SIGPIPE, SIG_IGN);
263 signal(SIGPIPE, signal_cleanup);
268 * Obtain a semaphore lock to begin a critical section.
270 void begin_critical_section(int which_one)
272 /* CtdlLogPrintf(CTDL_DEBUG, "begin_critical_section(%d)\n", which_one); */
274 /* For all types of critical sections except those listed here,
275 * ensure nobody ever tries to do a critical section within a
276 * transaction; this could lead to deadlock.
278 if ( (which_one != S_FLOORCACHE)
279 #ifdef DEBUG_MEMORY_LEAKS
280 && (which_one != S_DEBUGMEMLEAKS)
282 && (which_one != S_RPLIST)
286 pthread_mutex_lock(&Critters[which_one]);
290 * Release a semaphore lock to end a critical section.
292 void end_critical_section(int which_one)
294 pthread_mutex_unlock(&Critters[which_one]);
300 * This is a generic function to set up a master socket for listening on
301 * a TCP port. The server shuts down if the bind fails.
304 int ig_tcp_server(char *ip_addr, int port_number, int queue_len, char **errormessage)
306 struct sockaddr_in sin;
308 int actual_queue_len;
310 actual_queue_len = queue_len;
311 if (actual_queue_len < 5) actual_queue_len = 5;
313 memset(&sin, 0, sizeof(sin));
314 sin.sin_family = AF_INET;
315 sin.sin_port = htons((u_short)port_number);
316 if (ip_addr == NULL) {
317 sin.sin_addr.s_addr = INADDR_ANY;
320 sin.sin_addr.s_addr = inet_addr(ip_addr);
323 if (sin.sin_addr.s_addr == !INADDR_ANY) {
324 sin.sin_addr.s_addr = INADDR_ANY;
327 s = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP);
330 *errormessage = (char*) malloc(SIZ + 1);
331 snprintf(*errormessage, SIZ,
332 "citserver: Can't create a socket: %s",
334 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
339 setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
341 if (bind(s, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
342 *errormessage = (char*) malloc(SIZ + 1);
343 snprintf(*errormessage, SIZ,
344 "citserver: Can't bind: %s",
346 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
351 /* set to nonblock - we need this for some obscure situations */
352 if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
353 *errormessage = (char*) malloc(SIZ + 1);
354 snprintf(*errormessage, SIZ,
355 "citserver: Can't set socket to non-blocking: %s",
357 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
362 if (listen(s, actual_queue_len) < 0) {
363 *errormessage = (char*) malloc(SIZ + 1);
364 snprintf(*errormessage, SIZ,
365 "citserver: Can't listen: %s",
367 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
378 * Create a Unix domain socket and listen on it
380 int ig_uds_server(char *sockpath, int queue_len, char **errormessage)
382 struct sockaddr_un addr;
385 int actual_queue_len;
387 actual_queue_len = queue_len;
388 if (actual_queue_len < 5) actual_queue_len = 5;
390 i = unlink(sockpath);
391 if (i != 0) if (errno != ENOENT) {
392 *errormessage = (char*) malloc(SIZ + 1);
393 snprintf(*errormessage, SIZ, "citserver: can't unlink %s: %s",
394 sockpath, strerror(errno));
395 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
399 memset(&addr, 0, sizeof(addr));
400 addr.sun_family = AF_UNIX;
401 safestrncpy(addr.sun_path, sockpath, sizeof addr.sun_path);
403 s = socket(AF_UNIX, SOCK_STREAM, 0);
405 *errormessage = (char*) malloc(SIZ + 1);
406 snprintf(*errormessage, SIZ,
407 "citserver: Can't create a socket: %s",
409 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
413 if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
414 *errormessage = (char*) malloc(SIZ + 1);
415 snprintf(*errormessage, SIZ,
416 "citserver: Can't bind: %s",
418 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
422 /* set to nonblock - we need this for some obscure situations */
423 if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
424 *errormessage = (char*) malloc(SIZ + 1);
425 snprintf(*errormessage, SIZ,
426 "citserver: Can't set socket to non-blocking: %s",
428 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
433 if (listen(s, actual_queue_len) < 0) {
434 *errormessage = (char*) malloc(SIZ + 1);
435 snprintf(*errormessage, SIZ,
436 "citserver: Can't listen: %s",
438 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
442 chmod(sockpath, S_ISGID|S_IRUSR|S_IWUSR|S_IXUSR|S_IRGRP|S_IWGRP|S_IXGRP|S_IROTH|S_IWOTH|S_IXOTH);
449 * Return a pointer to the CitContext structure bound to the thread which
450 * called this function. If there's no such binding (for example, if it's
451 * called by the housekeeper thread) then a generic 'master' CC is returned.
453 * This function is used *VERY* frequently and must be kept small.
455 struct CitContext *MyContext(void) {
457 register struct CitContext *c;
459 return ((c = (struct CitContext *) pthread_getspecific(MyConKey),
460 c == NULL) ? &masterCC : c
466 * Initialize a new context and place it in the list. The session number
467 * used to be the PID (which is why it's called cs_pid), but that was when we
468 * had one process per session. Now we just assign them sequentially, starting
469 * at 1 (don't change it to 0 because masterCC uses 0).
471 struct CitContext *CreateNewContext(void) {
472 struct CitContext *me;
473 static int next_pid = 0;
475 me = (struct CitContext *) malloc(sizeof(struct CitContext));
477 CtdlLogPrintf(CTDL_ALERT, "citserver: can't allocate memory!!\n");
480 memset(me, 0, sizeof(struct CitContext));
482 /* The new context will be created already in the CON_EXECUTING state
483 * in order to prevent another thread from grabbing it while it's
486 me->state = CON_EXECUTING;
489 * Generate a unique session number and insert this context into
492 begin_critical_section(S_SESSION_TABLE);
493 me->cs_pid = ++next_pid;
495 me->next = ContextList;
497 if (me->next != NULL) {
501 end_critical_section(S_SESSION_TABLE);
507 * The following functions implement output buffering. If the kernel supplies
508 * native TCP buffering (Linux & *BSD), use that; otherwise, emulate it with
509 * user-space buffering.
513 # define HAVE_TCP_BUFFERING
516 # define HAVE_TCP_BUFFERING
517 # define TCP_CORK TCP_NOPUSH
519 #endif /* TCP_CORK */
520 #endif /* HAVE_DARWIN */
522 #ifdef HAVE_TCP_BUFFERING
523 static unsigned on = 1, off = 0;
524 void buffer_output(void) {
525 struct CitContext *ctx = MyContext();
526 setsockopt(ctx->client_socket, IPPROTO_TCP, TCP_CORK, &on, 4);
530 void unbuffer_output(void) {
531 struct CitContext *ctx = MyContext();
532 setsockopt(ctx->client_socket, IPPROTO_TCP, TCP_CORK, &off, 4);
536 void flush_output(void) {
537 struct CitContext *ctx = MyContext();
538 setsockopt(ctx->client_socket, IPPROTO_TCP, TCP_CORK, &off, 4);
539 setsockopt(ctx->client_socket, IPPROTO_TCP, TCP_CORK, &on, 4);
543 /* Stub functions for Darwin/OS X where TCP buffering isn't liked at all */
544 void buffer_output(void) {
547 void unbuffer_output(void) {
550 void flush_output(void) {
553 void buffer_output(void) {
554 if (CC->buffering == 0) {
557 CC->output_buffer = malloc(SIZ);
561 void flush_output(void) {
562 if (CC->buffering == 1) {
563 client_write(CC->output_buffer, CC->buffer_len);
568 void unbuffer_output(void) {
569 if (CC->buffering == 1) {
571 /* We don't call flush_output because we can't. */
572 client_write(CC->output_buffer, CC->buffer_len);
574 free(CC->output_buffer);
575 CC->output_buffer = NULL;
578 #endif /* HAVE_DARWIN */
579 #endif /* HAVE_TCP_BUFFERING */
584 * client_write() ... Send binary data to the client.
586 void client_write(char *buf, int nbytes)
588 int bytes_written = 0;
590 #ifndef HAVE_TCP_BUFFERING
591 int old_buffer_len = 0;
596 if (Ctx->redirect_buffer != NULL) {
597 if ((Ctx->redirect_len + nbytes + 2) >= Ctx->redirect_alloc) {
598 Ctx->redirect_alloc = (Ctx->redirect_alloc * 2) + nbytes;
599 Ctx->redirect_buffer = realloc(Ctx->redirect_buffer,
600 Ctx->redirect_alloc);
602 memcpy(&Ctx->redirect_buffer[Ctx->redirect_len], buf, nbytes);
603 Ctx->redirect_len += nbytes;
604 Ctx->redirect_buffer[Ctx->redirect_len] = 0;
608 #ifndef HAVE_TCP_BUFFERING
609 /* If we're buffering for later, do that now. */
610 if (Ctx->buffering) {
611 old_buffer_len = Ctx->buffer_len;
612 Ctx->buffer_len += nbytes;
613 Ctx->output_buffer = realloc(Ctx->output_buffer, Ctx->buffer_len);
614 memcpy(&Ctx->output_buffer[old_buffer_len], buf, nbytes);
619 /* Ok, at this point we're not buffering. Go ahead and write. */
622 if (Ctx->redirect_ssl) {
623 client_write_ssl(buf, nbytes);
628 while (bytes_written < nbytes) {
629 retval = write(Ctx->client_socket, &buf[bytes_written],
630 nbytes - bytes_written);
632 CtdlLogPrintf(CTDL_ERR,
633 "client_write(%d bytes) failed: %s (%d)\n",
634 nbytes - bytes_written,
635 strerror(errno), errno);
637 // CtdlLogPrintf(CTDL_DEBUG, "Tried to send: %s", &buf[bytes_written]);
641 bytes_written = bytes_written + retval;
647 * cprintf() ... Send formatted printable data to the client. It is
648 * implemented in terms of client_write() but remains in
649 * sysdep.c in case we port to somewhere without va_args...
651 void cprintf(const char *format, ...) {
655 va_start(arg_ptr, format);
656 if (vsnprintf(buf, sizeof buf, format, arg_ptr) == -1)
657 buf[sizeof buf - 2] = '\n';
658 client_write(buf, strlen(buf));
664 * Read data from the client socket.
666 * 1 Requested number of bytes has been read.
667 * 0 Request timed out.
668 * -1 The socket is broken.
669 * If the socket breaks, the session will be terminated.
671 int client_read_to(char *buf, int bytes, int timeout)
680 if (CC->redirect_ssl) {
681 return (client_read_ssl(buf, bytes, timeout));
685 fd = CC->client_socket;
692 retval = select( (fd)+1,
693 &rfds, NULL, NULL, &tv);
695 if (FD_ISSET(fd, &rfds) == 0) {
699 rlen = read(fd, &buf[len], bytes-len);
701 /* The socket has been disconnected! */
711 * Read data from the client socket with default timeout.
712 * (This is implemented in terms of client_read_to() and could be
713 * justifiably moved out of sysdep.c)
715 INLINE int client_read(char *buf, int bytes)
717 return(client_read_to(buf, bytes, config.c_sleeping));
722 * client_getln() ... Get a LF-terminated line of text from the client.
723 * (This is implemented in terms of client_read() and could be
724 * justifiably moved out of sysdep.c)
726 int client_getln(char *buf, int bufsize)
730 /* Read one character at a time.
733 retval = client_read(&buf[i], 1);
734 if (retval != 1 || buf[i] == '\n' || i == (bufsize-1))
738 /* If we got a long line, discard characters until the newline.
740 if (i == (bufsize-1))
741 while (buf[i] != '\n' && retval == 1)
742 retval = client_read(&buf[i], 1);
744 /* Strip the trailing LF, and the trailing CR if present.
748 && ( (buf[i - 1]==13)
749 || ( buf[i - 1]==10)) ) {
753 if (retval < 0) safestrncpy(&buf[i], "000", bufsize - i);
759 * Cleanup any contexts that are left lying around
761 void context_cleanup(void)
763 struct CitContext *ptr = NULL;
764 struct CitContext *rem = NULL;
767 * Clean up the contexts.
768 * There are no threads so no critical_section stuff is needed.
772 /* Remove the session from the active list */
776 lprintf(CTDL_DEBUG, "Purging session %d\n", ptr->cs_pid);
786 * The system-dependent part of master_cleanup() - close the master socket.
788 void sysdep_master_cleanup(void) {
789 struct ServiceFunctionHook *serviceptr;
792 * close all protocol master sockets
794 for (serviceptr = ServiceHookTable; serviceptr != NULL;
795 serviceptr = serviceptr->next ) {
797 if (serviceptr->tcp_port > 0)
798 CtdlLogPrintf(CTDL_INFO, "Closing listener on port %d\n",
799 serviceptr->tcp_port);
801 if (serviceptr->sockpath != NULL)
802 CtdlLogPrintf(CTDL_INFO, "Closing listener on '%s'\n",
803 serviceptr->sockpath);
805 close(serviceptr->msock);
807 /* If it's a Unix domain socket, remove the file. */
808 if (serviceptr->sockpath != NULL) {
809 unlink(serviceptr->sockpath);
818 CtdlDestroyProtoHooks();
819 CtdlDestroyDeleteHooks();
820 CtdlDestroyXmsgHooks();
821 CtdlDestroyNetprocHooks();
822 CtdlDestroyUserHooks();
823 CtdlDestroyMessageHook();
824 CtdlDestroyCleanupHooks();
825 CtdlDestroyFixedOutputHooks();
826 CtdlDestroySessionHooks();
827 CtdlDestroyServiceHook();
828 #ifdef HAVE_BACKTRACE
836 * Terminate another session.
837 * (This could justifiably be moved out of sysdep.c because it
838 * no longer does anything that is system-dependent.)
840 void kill_session(int session_to_kill) {
841 struct CitContext *ptr;
843 begin_critical_section(S_SESSION_TABLE);
844 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
845 if (ptr->cs_pid == session_to_kill) {
849 end_critical_section(S_SESSION_TABLE);
853 void graceful_shutdown(int signum) {
854 kill(current_child, signum);
855 unlink(file_pid_file);
861 * Start running as a daemon.
863 void start_daemon(int unused) {
871 /* Close stdin/stdout/stderr and replace them with /dev/null.
872 * We don't just call close() because we don't want these fd's
873 * to be reused for other files.
882 signal(SIGHUP, SIG_IGN);
883 signal(SIGINT, SIG_IGN);
884 signal(SIGQUIT, SIG_IGN);
888 freopen("/dev/null", "r", stdin);
889 freopen("/dev/null", "w", stdout);
890 freopen("/dev/null", "w", stderr);
893 current_child = fork();
895 signal(SIGTERM, graceful_shutdown);
897 if (current_child < 0) {
902 else if (current_child == 0) {
903 return; /* continue starting citadel. */
907 fp = fopen(file_pid_file, "w");
910 * NB.. The pid file contains the pid of the actual server.
911 * This is not the pid of the watcher process
913 fprintf(fp, ""F_PID_T"\n", current_child);
916 waitpid(current_child, &status, 0);
921 /* Did the main process exit with an actual exit code? */
922 if (WIFEXITED(status)) {
924 /* Exit code 0 means the watcher should exit */
925 if (WEXITSTATUS(status) == 0) {
929 /* Exit code 101-109 means the watcher should exit */
930 else if ( (WEXITSTATUS(status) >= 101) && (WEXITSTATUS(status) <= 109) ) {
934 /* Any other exit code means we should restart. */
940 /* Any other type of termination (signals, etc.) should also restart. */
945 } while (do_restart);
947 unlink(file_pid_file);
948 exit(WEXITSTATUS(status));
954 * Generic routine to convert a login name to a full name (gecos)
955 * Returns nonzero if a conversion took place
957 int convert_login(char NameToConvert[]) {
961 pw = getpwnam(NameToConvert);
966 strcpy(NameToConvert, pw->pw_gecos);
967 for (a=0; a<strlen(NameToConvert); ++a) {
968 if (NameToConvert[a] == ',') NameToConvert[a] = 0;
977 * New thread interface.
978 * To create a thread you must call one of the create thread functions.
979 * You must pass it the address of (a pointer to a CtdlThreadNode initialised to NULL) like this
980 * struct CtdlThreadNode *node = NULL;
982 * If the thread is created *node will point to the thread control structure for the created thread.
983 * If the thread creation fails *node remains NULL
984 * Do not free the memory pointed to by *node, it doesn't belong to you.
985 * If your thread function returns it will be started again without creating a new thread.
986 * If your thread function wants to exit it should call CtdlThreadExit(ret_code);
987 * This new interface duplicates much of the eCrash stuff. We should go for closer integration since that would
988 * remove the need for the calls to eCrashRegisterThread and friends
992 struct CtdlThreadNode *CtdlThreadList = NULL;
995 * Condition variable and Mutex for thread garbage collection
997 /*static pthread_mutex_t thread_gc_mutex = PTHREAD_MUTEX_INITIALIZER;
998 static pthread_cond_t thread_gc_cond = PTHREAD_COND_INITIALIZER;
1000 static pthread_t GC_thread;
1001 static char *CtdlThreadStates[CTDL_THREAD_LAST_STATE];
1002 double CtdlThreadLoadAvg;
1005 * Pinched the following bits regarding signals from Kannel.org
1009 * Change this thread's signal mask to block user-visible signals
1010 * (HUP, TERM, QUIT, INT), and store the old signal mask in
1012 * Return 0 for success, or -1 if an error occurred.
1016 * This does not work in Darwin alias MacOS X alias Mach kernel,
1017 * however. So we define a dummy function doing nothing.
1019 #if defined(DARWIN_OLD)
1020 static int pthread_sigmask();
1023 static int ctdl_thread_internal_block_signals(sigset_t *old_set_storage)
1026 sigset_t block_signals;
1028 ret = sigemptyset(&block_signals);
1030 CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC. Couldn't initialize signal set\n");
1033 ret = sigaddset(&block_signals, SIGHUP);
1034 ret |= sigaddset(&block_signals, SIGTERM);
1035 ret |= sigaddset(&block_signals, SIGQUIT);
1036 ret |= sigaddset(&block_signals, SIGINT);
1038 CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC. Couldn't add signal to signal set.\n");
1041 ret = pthread_sigmask(SIG_BLOCK, &block_signals, old_set_storage);
1043 CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC. Couldn't disable signals for thread creation\n");
1049 static void ctdl_thread_internal_restore_signals(sigset_t *old_set)
1053 ret = pthread_sigmask(SIG_SETMASK, old_set, NULL);
1055 CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC. Couldn't restore signal set.\n");
1060 void ctdl_thread_internal_cleanup(void)
1064 for (i=0; i<CTDL_THREAD_LAST_STATE; i++)
1066 free (CtdlThreadStates[i]);
1070 void ctdl_thread_internal_init(void)
1072 struct CtdlThreadNode *this_thread;
1075 GC_thread = pthread_self();
1076 CtdlThreadStates[CTDL_THREAD_INVALID] = strdup ("Invalid Thread");
1077 CtdlThreadStates[CTDL_THREAD_VALID] = strdup("Valid Thread");
1078 CtdlThreadStates[CTDL_THREAD_CREATE] = strdup("Thread being Created");
1079 CtdlThreadStates[CTDL_THREAD_CANCELLED] = strdup("Thread Cancelled");
1080 CtdlThreadStates[CTDL_THREAD_EXITED] = strdup("Thread Exited");
1081 CtdlThreadStates[CTDL_THREAD_STOPPING] = strdup("Thread Stopping");
1082 CtdlThreadStates[CTDL_THREAD_STOP_REQ] = strdup("Thread Stop Requested");
1083 CtdlThreadStates[CTDL_THREAD_SLEEPING] = strdup("Thread Sleeping");
1084 CtdlThreadStates[CTDL_THREAD_RUNNING] = strdup("Thread Running");
1085 CtdlThreadStates[CTDL_THREAD_BLOCKED] = strdup("Thread Blocked");
1087 /* Get ourself a thread entry */
1088 this_thread = malloc(sizeof(struct CtdlThreadNode));
1089 if (this_thread == NULL) {
1090 CtdlLogPrintf(CTDL_EMERG, "Thread system, can't allocate CtdlThreadNode, exiting\n");
1093 // Ensuring this is zero'd means we make sure the thread doesn't start doing its thing until we are ready.
1094 memset (this_thread, 0, sizeof(struct CtdlThreadNode));
1096 /* We are garbage collector so create us as running */
1097 this_thread->state = CTDL_THREAD_RUNNING;
1099 if ((ret = pthread_attr_init(&this_thread->attr))) {
1100 CtdlLogPrintf(CTDL_EMERG, "Thread system, pthread_attr_init: %s\n", strerror(ret));
1105 this_thread->name = strdup("Garbage Collection Thread");
1107 pthread_mutex_init (&(this_thread->ThreadMutex), NULL);
1108 pthread_cond_init (&(this_thread->ThreadCond), NULL);
1110 this_thread->tid = GC_thread;
1112 num_threads++; // Increase the count of threads in the system.
1114 this_thread->next = CtdlThreadList;
1115 CtdlThreadList = this_thread;
1116 if (this_thread->next)
1117 this_thread->next->prev = this_thread;
1118 /* Set up start times */
1119 gettimeofday(&this_thread->start_time, NULL); /* Time this thread started */
1120 memcpy(&this_thread->last_state_change, &this_thread->start_time, sizeof (struct timeval)); /* Changed state so mark it. */
1125 * A function to update a threads load averages
1127 void ctdl_thread_internal_update_avgs(struct CtdlThreadNode *this_thread)
1129 struct timeval now, result;
1130 double last_duration;
1132 pthread_mutex_lock(&this_thread->ThreadMutex); /* To prevent race condition of a sleeping thread */
1133 gettimeofday(&now, NULL);
1134 timersub(&now, &(this_thread->last_state_change), &result);
1135 // result now has a timeval for the time we spent in the last state since we last updated
1136 last_duration = (double)result.tv_sec + ((double)result.tv_usec / (double) 1000000);
1137 if (this_thread->state == CTDL_THREAD_SLEEPING)
1138 this_thread->avg_sleeping += last_duration;
1139 if (this_thread->state == CTDL_THREAD_RUNNING)
1140 this_thread->avg_running += last_duration;
1141 if (this_thread->state == CTDL_THREAD_BLOCKED)
1142 this_thread->avg_blocked += last_duration;
1143 memcpy (&this_thread->last_state_change, &now, sizeof (struct timeval));
1144 pthread_mutex_unlock(&this_thread->ThreadMutex);
1148 * A function to chenge the state of a thread
1150 void ctdl_thread_internal_change_state (struct CtdlThreadNode *this_thread, enum CtdlThreadState new_state)
1153 * Wether we change state or not we need update the load values
1155 ctdl_thread_internal_update_avgs(this_thread);
1156 pthread_mutex_lock(&this_thread->ThreadMutex); /* To prevent race condition of a sleeping thread */
1157 if ((new_state == CTDL_THREAD_STOP_REQ) && (this_thread->state > CTDL_THREAD_STOP_REQ))
1158 this_thread->state = new_state;
1159 if (((new_state == CTDL_THREAD_SLEEPING) || (new_state == CTDL_THREAD_BLOCKED)) && (this_thread->state == CTDL_THREAD_RUNNING))
1160 this_thread->state = new_state;
1161 if ((new_state == CTDL_THREAD_RUNNING) && ((this_thread->state == CTDL_THREAD_SLEEPING) || (this_thread->state == CTDL_THREAD_BLOCKED)))
1162 this_thread->state = new_state;
1163 pthread_mutex_unlock(&this_thread->ThreadMutex);
1168 * A function to tell all threads to exit
1170 void CtdlThreadStopAll(void)
1172 struct CtdlThreadNode *this_thread;
1174 begin_critical_section(S_THREAD_LIST);
1175 this_thread = CtdlThreadList;
1178 if (this_thread->thread_func) // Don't tell garbage collector to stop
1180 ctdl_thread_internal_change_state (this_thread, CTDL_THREAD_STOP_REQ);
1181 pthread_cond_signal(&this_thread->ThreadCond);
1182 CtdlLogPrintf(CTDL_DEBUG, "Thread system stopping thread \"%s\" (%ld).\n", this_thread->name, this_thread->tid);
1184 this_thread = this_thread->next;
1186 end_critical_section(S_THREAD_LIST);
1191 * A function to signal that we need to do garbage collection on the thread list
1193 void CtdlThreadGC(void)
1195 struct CtdlThreadNode *this_thread;
1197 CtdlLogPrintf(CTDL_DEBUG, "Thread system signalling garbage collection.\n");
1199 begin_critical_section(S_THREAD_LIST);
1200 this_thread = CtdlThreadList;
1203 if (!this_thread->thread_func)
1204 pthread_cond_signal(&this_thread->ThreadCond);
1206 this_thread = this_thread->next;
1208 end_critical_section(S_THREAD_LIST);
1213 * A function to return the number of threads running in the system
1215 int CtdlThreadGetCount(void)
1221 * A function to find the thread structure for this thread
1223 struct CtdlThreadNode *CtdlThreadSelf(void)
1226 struct CtdlThreadNode *this_thread;
1228 self_tid = pthread_self();
1230 begin_critical_section(S_THREAD_LIST);
1231 this_thread = CtdlThreadList;
1234 if (pthread_equal(self_tid, this_thread->tid))
1236 end_critical_section(S_THREAD_LIST);
1239 this_thread = this_thread->next;
1241 end_critical_section(S_THREAD_LIST);
1249 * A function to rename a thread
1250 * Returns a char * and the caller owns the memory and should free it
1252 char *CtdlThreadName(struct CtdlThreadNode *thread, char *name)
1254 struct CtdlThreadNode *this_thread;
1258 this_thread = CtdlThreadSelf();
1260 this_thread = thread;
1263 CtdlLogPrintf(CTDL_WARNING, "Thread system WARNING. Attempt to CtdlThreadRename() a non thread.\n");
1266 begin_critical_section(S_THREAD_LIST);
1269 old_name = this_thread->name;
1270 this_thread->name = strdup (name);
1273 old_name = strdup(this_thread->name);
1274 end_critical_section (S_THREAD_LIST);
1280 * A function to force a thread to exit
1282 void CtdlThreadCancel(struct CtdlThreadNode *thread)
1284 struct CtdlThreadNode *this_thread;
1287 this_thread = CtdlThreadSelf();
1289 this_thread = thread;
1292 CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC. Attempt to CtdlThreadCancel() a non thread.\n");
1293 CtdlThreadStopAll();
1297 if (!this_thread->thread_func)
1299 CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC. Attempt to CtdlThreadCancel() the garbage collector.\n");
1300 CtdlThreadStopAll();
1304 begin_critical_section(S_THREAD_LIST);
1305 ctdl_thread_internal_change_state (this_thread, CTDL_THREAD_CANCELLED);
1306 pthread_cancel(this_thread->tid);
1307 end_critical_section (S_THREAD_LIST);
1313 * A function for a thread to check if it has been asked to stop
1315 int CtdlThreadCheckStop(void)
1317 struct CtdlThreadNode *this_thread;
1319 this_thread = CtdlThreadSelf();
1322 CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC, CtdlThreadCheckStop() called by a non thread.\n");
1323 CtdlThreadStopAll();
1326 if(this_thread->state == CTDL_THREAD_STOP_REQ)
1328 this_thread->state = CTDL_THREAD_STOPPING;
1331 else if(this_thread->state < CTDL_THREAD_STOP_REQ)
1339 * A function to ask a thread to exit
1340 * The thread must call CtdlThreadCheckStop() periodically to determine if it should exit
1342 void CtdlThreadStop(struct CtdlThreadNode *thread)
1344 struct CtdlThreadNode *this_thread;
1347 this_thread = CtdlThreadSelf();
1349 this_thread = thread;
1352 if (!(this_thread->thread_func))
1353 return; // Don't stop garbage collector
1355 begin_critical_section (S_THREAD_LIST);
1356 ctdl_thread_internal_change_state (this_thread, CTDL_THREAD_STOP_REQ);
1357 pthread_cond_signal(&this_thread->ThreadCond);
1358 end_critical_section(S_THREAD_LIST);
1362 * So we now have a sleep command that works with threads but it is in seconds
1364 void CtdlThreadSleep(int secs)
1366 struct timespec wake_time;
1367 struct timeval time_now;
1368 struct CtdlThreadNode *self;
1371 self = CtdlThreadSelf();
1374 CtdlLogPrintf(CTDL_WARNING, "CtdlThreadSleep() called by something that is not a thread. Should we die?\n");
1378 begin_critical_section(S_THREAD_LIST);
1379 ctdl_thread_internal_change_state (self, CTDL_THREAD_SLEEPING);
1380 pthread_mutex_lock(&self->ThreadMutex); /* Prevent something asking us to awaken before we've gone to sleep */
1381 end_critical_section(S_THREAD_LIST);
1383 memset (&wake_time, 0, sizeof(struct timespec));
1384 gettimeofday(&time_now, NULL);
1385 wake_time.tv_sec = time_now.tv_sec + secs;
1386 wake_time.tv_nsec = time_now.tv_usec * 10;
1387 pthread_cond_timedwait(&self->ThreadCond, &self->ThreadMutex, &wake_time);
1388 begin_critical_section(S_THREAD_LIST);
1389 pthread_mutex_unlock(&self->ThreadMutex);
1390 ctdl_thread_internal_change_state (self, CTDL_THREAD_RUNNING);
1391 end_critical_section(S_THREAD_LIST);
1396 * Routine to clean up our thread function on exit
1398 static void ctdl_internal_thread_cleanup(void *arg)
1400 struct CtdlThreadNode *this_thread;
1401 this_thread = CtdlThreadSelf();
1403 * In here we were called by the current thread because it is exiting
1404 * NB. WE ARE THE CURRENT THREAD
1406 CtdlLogPrintf(CTDL_NOTICE, "Thread \"%s\" (%ld) exited.\n", this_thread->name, this_thread->tid);
1407 begin_critical_section(S_THREAD_LIST);
1408 #ifdef HAVE_BACKTRACE
1409 eCrash_UnregisterThread();
1411 this_thread->state = CTDL_THREAD_EXITED; // needs to be last thing else house keeping will unlink us too early
1412 end_critical_section(S_THREAD_LIST);
1420 * Garbage collection routine.
1421 * Gets called by main() in a loop to clean up the thread list periodically.
1423 void ctdl_internal_thread_gc (void)
1425 struct CtdlThreadNode *this_thread, *that_thread = NULL;
1430 * Wait on the condition variable that tells us garbage collection is needed
1431 * We wake up every 10 seconds just in case someone forgot to inform us of a thread exiting
1434 CtdlThreadSleep(10);
1436 /* Handle exiting of garbage collector thread */
1437 if(num_threads == 1)
1438 CtdlThreadList->state = CTDL_THREAD_EXITED;
1440 CtdlLogPrintf(CTDL_DEBUG, "Thread system running garbage collection.\n");
1442 * Woke up to do garbage collection
1444 begin_critical_section(S_THREAD_LIST);
1445 this_thread = CtdlThreadList;
1449 that_thread = this_thread;
1450 this_thread = this_thread->next;
1452 /* Update load averages */
1453 ctdl_thread_internal_update_avgs(that_thread);
1454 pthread_mutex_lock(&that_thread->ThreadMutex);
1455 that_thread->load_avg = that_thread->avg_sleeping + that_thread->avg_running + that_thread->avg_blocked;
1456 that_thread->load_avg = that_thread->avg_running / that_thread->load_avg / 100;
1457 that_thread->avg_sleeping /= 10;
1458 that_thread->avg_running /= 10;
1459 that_thread->avg_blocked /= 10;
1460 load_avg += that_thread->load_avg;
1462 CtdlLogPrintf(CTDL_DEBUG, "CtdlThread, \"%s\" (%ld) \"%s\" %f %f %f %f.\n", that_thread->name, that_thread->tid, CtdlThreadStates[that_thread->state], that_thread->avg_sleeping, that_thread->avg_running, that_thread->avg_blocked, that_thread->load_avg);
1463 pthread_mutex_unlock(&that_thread->ThreadMutex);
1465 /* Do we need to clean up this thread? */
1466 if (that_thread->state != CTDL_THREAD_EXITED)
1468 if(that_thread->flags & CTDLTHREAD_WORKER)
1469 workers++; /* Sanity check on number of worker threads */
1473 if (pthread_equal(that_thread->tid, pthread_self()) && that_thread->thread_func)
1474 { /* Sanity check */
1475 end_critical_section(S_THREAD_LIST);
1476 CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC, a thread is trying to clean up after itself.\n");
1477 CtdlThreadStopAll();
1481 if (num_threads <= 0)
1482 { /* Sanity check */
1483 end_critical_section (S_THREAD_LIST);
1484 CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC, num_threads <= 0 and trying to do Garbage Collection.\n");
1485 CtdlThreadStopAll();
1489 /* If we are unlinking the list head then the next becomes the list head */
1490 if (that_thread == CtdlThreadList)
1491 CtdlThreadList = that_thread->next;
1492 if(that_thread->prev)
1493 that_thread->prev->next = that_thread->next;
1494 if(that_thread->next)
1495 that_thread->next->prev = that_thread->next;
1497 if(that_thread->flags & CTDLTHREAD_WORKER)
1498 num_workers--; /* This is a wroker thread so reduce the count. */
1501 * Join on the thread to do clean up and prevent memory leaks
1502 * Also makes sure the thread has cleaned up after itself before we remove it from the list
1503 * If that thread has no function it must be the garbage collector
1505 if (that_thread->thread_func)
1506 pthread_join (that_thread->tid, NULL);
1509 * Now we own that thread entry
1511 CtdlLogPrintf(CTDL_INFO, "Garbage Collection for thread \"%s\" (%ld).\n", that_thread->name, that_thread->tid);
1512 if(that_thread->name)
1513 free(that_thread->name);
1514 pthread_mutex_destroy(&that_thread->ThreadMutex);
1515 pthread_cond_destroy(&that_thread->ThreadCond);
1516 pthread_attr_destroy(&that_thread->attr);
1520 /* Sanity check number of worker threads */
1521 if (workers != num_workers)
1523 end_critical_section(S_THREAD_LIST);
1524 CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC, discrepancy in number of worker threads. Counted %d, should be %d.\n", workers, num_workers);
1527 CtdlThreadLoadAvg = load_avg/num_threads;
1528 end_critical_section(S_THREAD_LIST);
1529 CtdlLogPrintf(CTDL_INFO, "System load average %f.\n", CtdlThreadLoadAvg);
1536 * Runtime function for a Citadel Thread.
1537 * This initialises the threads environment and then calls the user supplied thread function
1538 * Note that this is the REAL thread function and wraps the users thread function.
1540 static void *ctdl_internal_thread_func (void *arg)
1542 struct CtdlThreadNode *this_thread;
1545 /* lock and unlock the thread list.
1546 * This causes this thread to wait until all its creation stuff has finished before it
1547 * can continue its execution.
1549 begin_critical_section(S_THREAD_LIST);
1550 // Get our thread data structure
1551 this_thread = (struct CtdlThreadNode *) arg;
1552 this_thread->state = CTDL_THREAD_RUNNING;
1553 this_thread->pid = getpid();
1554 gettimeofday(&this_thread->start_time, NULL); /* Time this thread started */
1555 memcpy(&this_thread->last_state_change, &this_thread->start_time, sizeof (struct timeval)); /* Changed state so mark it. */
1556 end_critical_section(S_THREAD_LIST);
1558 // Tell the world we are here
1559 CtdlLogPrintf(CTDL_NOTICE, "Created a new thread \"%s\" (%ld). \n", this_thread->name, this_thread->tid);
1561 // Register the cleanup function to take care of when we exit.
1562 pthread_cleanup_push(ctdl_internal_thread_cleanup, NULL);
1566 * run the thread to do the work
1568 ret = (this_thread->thread_func)(this_thread->user_args);
1571 * Our thread is exiting either because it wanted to end or because the server is stopping
1572 * We need to clean up
1574 pthread_cleanup_pop(1); // Execute our cleanup routine and remove it
1582 * Internal function to create a thread.
1583 * Must be called from within a S_THREAD_LIST critical section
1585 struct CtdlThreadNode *ctdl_internal_create_thread(char *name, long flags, void *(*thread_func) (void *arg), void *args)
1588 struct CtdlThreadNode *this_thread;
1590 sigset_t old_signal_set;
1592 if (num_threads >= 32767)
1594 CtdlLogPrintf(CTDL_EMERG, "Thread system. Thread list full.\n");
1598 this_thread = malloc(sizeof(struct CtdlThreadNode));
1599 if (this_thread == NULL) {
1600 CtdlLogPrintf(CTDL_EMERG, "Thread system, can't allocate CtdlThreadNode, exiting\n");
1603 // Ensuring this is zero'd means we make sure the thread doesn't start doing its thing until we are ready.
1604 memset (this_thread, 0, sizeof(struct CtdlThreadNode));
1606 this_thread->state = CTDL_THREAD_CREATE;
1608 if ((ret = pthread_attr_init(&this_thread->attr))) {
1609 CtdlLogPrintf(CTDL_EMERG, "Thread system, pthread_attr_init: %s\n", strerror(ret));
1614 /* Our per-thread stacks need to be bigger than the default size,
1615 * otherwise the MIME parser crashes on FreeBSD, and the IMAP service
1616 * crashes on 64-bit Linux.
1618 if (flags & CTDLTHREAD_BIGSTACK)
1620 CtdlLogPrintf(CTDL_INFO, "Thread system. Creating BIG STACK thread.\n");
1621 if ((ret = pthread_attr_setstacksize(&this_thread->attr, THREADSTACKSIZE))) {
1622 CtdlLogPrintf(CTDL_EMERG, "Thread system, pthread_attr_setstacksize: %s\n",
1624 pthread_attr_destroy(&this_thread->attr);
1631 * If we got here we are going to create the thread so we must initilise the structure
1632 * first because most implimentations of threading can't create it in a stopped state
1633 * and it might want to do things with its structure that aren't initialised otherwise.
1637 this_thread->name = strdup(name);
1641 this_thread->name = strdup("Un-named Thread");
1644 this_thread->flags = flags;
1645 this_thread->thread_func = thread_func;
1646 this_thread->user_args = args;
1647 pthread_mutex_init (&(this_thread->ThreadMutex), NULL);
1648 pthread_cond_init (&(this_thread->ThreadCond), NULL);
1651 * We want to make sure that only the main thread handles signals,
1652 * so that each signal is handled exactly once. To do this, we
1653 * make sure that each new thread has all the signals that we
1654 * handle blocked. To avoid race conditions, we block them in
1655 * the spawning thread first, then create the new thread (which
1656 * inherits the settings), and then restore the old settings in
1657 * the spawning thread. This means that there is a brief period
1658 * when no signals will be processed, but during that time they
1659 * should be queued by the operating system.
1661 if (pthread_equal(GC_thread, pthread_self()))
1662 sigtrick = ctdl_thread_internal_block_signals(&old_signal_set) == 0;
1665 * We pass this_thread into the thread as its args so that it can find out information
1666 * about itself and it has a bit of storage space for itself, not to mention that the REAL
1667 * thread function needs to finish off the setup of the structure
1669 if ((ret = pthread_create(&this_thread->tid, &this_thread->attr, ctdl_internal_thread_func, this_thread) != 0))
1672 CtdlLogPrintf(CTDL_ALERT, "Thread system, Can't create thread: %s\n",
1674 if (this_thread->name)
1675 free (this_thread->name);
1676 pthread_mutex_destroy(&(this_thread->ThreadMutex));
1677 pthread_cond_destroy(&(this_thread->ThreadCond));
1678 pthread_attr_destroy(&this_thread->attr);
1681 ctdl_thread_internal_restore_signals(&old_signal_set);
1686 ctdl_thread_internal_restore_signals(&old_signal_set);
1688 num_threads++; // Increase the count of threads in the system.
1689 if(this_thread->flags & CTDLTHREAD_WORKER)
1692 this_thread->next = CtdlThreadList;
1693 CtdlThreadList = this_thread;
1694 if (this_thread->next)
1695 this_thread->next->prev = this_thread;
1696 // Register for tracing
1697 #ifdef HAVE_BACKTRACE
1698 eCrash_RegisterThread(this_thread->name, 0);
1704 * Wrapper function to create a thread
1705 * ensures the critical section and other protections are in place.
1706 * char *name = name to give to thread, if NULL, use generic name
1707 * int flags = flags to determine type of thread and standard facilities
1709 struct CtdlThreadNode *CtdlThreadCreate(char *name, long flags, void *(*thread_func) (void *arg), void *args)
1711 struct CtdlThreadNode *ret = NULL;
1713 begin_critical_section(S_THREAD_LIST);
1714 ret = ctdl_internal_create_thread(name, flags, thread_func, args);
1715 end_critical_section(S_THREAD_LIST);
1722 * A warapper function for select so we can show a thread as blocked
1724 int CtdlThreadSelect(int n, fd_set *readfds, fd_set *writefds, fd_set *exceptfds, const struct timeval *timeout)
1726 struct CtdlThreadNode *self;
1729 self = CtdlThreadSelf();
1730 ctdl_thread_internal_change_state(self, CTDL_THREAD_BLOCKED);
1731 ret = select(n, readfds, writefds, exceptfds, timeout);
1732 ctdl_thread_internal_change_state(self, CTDL_THREAD_RUNNING);
1737 * Purge all sessions which have the 'kill_me' flag set.
1738 * This function has code to prevent it from running more than once every
1739 * few seconds, because running it after every single unbind would waste a lot
1740 * of CPU time and keep the context list locked too much. To force it to run
1741 * anyway, set "force" to nonzero.
1744 * After that's done, we raise the size of the worker thread pool
1745 * if such an action is appropriate.
1747 void dead_session_purge(int force) {
1748 struct CitContext *ptr, *ptr2; /* general-purpose utility pointer */
1749 struct CitContext *rem = NULL; /* list of sessions to be destroyed */
1752 if ( (time(NULL) - last_purge) < 5 ) {
1753 return; /* Too soon, go away */
1758 begin_critical_section(S_SESSION_TABLE);
1764 if ( (ptr2->state == CON_IDLE) && (ptr2->kill_me) ) {
1765 /* Remove the session from the active list */
1767 ptr2->prev->next = ptr2->next;
1770 ContextList = ptr2->next;
1773 ptr2->next->prev = ptr2->prev;
1778 /* And put it on our to-be-destroyed list */
1784 end_critical_section(S_SESSION_TABLE);
1786 /* Now that we no longer have the session list locked, we can take
1787 * our time and destroy any sessions on the to-be-killed list, which
1788 * is allocated privately on this thread's stack.
1790 while (rem != NULL) {
1791 CtdlLogPrintf(CTDL_DEBUG, "Purging session %d\n", rem->cs_pid);
1798 /* Raise the size of the worker thread pool if necessary. */
1799 begin_critical_section(S_THREAD_LIST);
1800 if ( (num_sessions > num_workers)
1801 && (num_workers < config.c_max_workers) ) {
1802 ctdl_internal_create_thread("Worker Thread", CTDLTHREAD_BIGSTACK + CTDLTHREAD_WORKER, worker_thread, NULL);
1804 end_critical_section(S_THREAD_LIST);
1805 // FIXME: reduce the number of worker threads too
1813 * masterCC is the context we use when not attached to a session. This
1814 * function initializes it.
1816 void InitializeMasterCC(void) {
1817 memset(&masterCC, 0, sizeof(struct CitContext));
1818 masterCC.internal_pgm = 1;
1819 masterCC.cs_pid = 0;
1828 * Bind a thread to a context. (It's inline merely to speed things up.)
1830 INLINE void become_session(struct CitContext *which_con) {
1831 pthread_setspecific(MyConKey, (void *)which_con );
1837 * This loop just keeps going and going and going...
1839 void *worker_thread(void *arg) {
1842 struct CitContext *ptr;
1843 struct CitContext *bind_me = NULL;
1846 struct CitContext *con= NULL; /* Temporary context pointer */
1847 struct ServiceFunctionHook *serviceptr;
1848 int ssock; /* Descriptor for client socket */
1850 int force_purge = 0;
1855 while (!CtdlThreadCheckStop()) {
1857 /* make doubly sure we're not holding any stale db handles
1858 * which might cause a deadlock.
1860 cdb_check_handles();
1861 do_select: force_purge = 0;
1862 bind_me = NULL; /* Which session shall we handle? */
1864 /* Initialize the fdset. */
1868 begin_critical_section(S_SESSION_TABLE);
1869 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
1870 if (ptr->state == CON_IDLE) {
1871 FD_SET(ptr->client_socket, &readfds);
1872 if (ptr->client_socket > highest)
1873 highest = ptr->client_socket;
1875 if ((bind_me == NULL) && (ptr->state == CON_READY)) {
1877 ptr->state = CON_EXECUTING;
1880 end_critical_section(S_SESSION_TABLE);
1886 /* If we got this far, it means that there are no sessions
1887 * which a previous thread marked for attention, so we go
1888 * ahead and get ready to select().
1891 /* First, add the various master sockets to the fdset. */
1892 for (serviceptr = ServiceHookTable; serviceptr != NULL;
1893 serviceptr = serviceptr->next ) {
1894 m = serviceptr->msock;
1895 FD_SET(m, &readfds);
1901 if (!CtdlThreadCheckStop()) {
1902 tv.tv_sec = 1; /* wake up every second if no input */
1904 retval = CtdlThreadSelect(highest + 1, &readfds, NULL, NULL, &tv);
1905 // retval = select(highest + 1, &readfds, NULL, NULL, &tv);
1908 if (CtdlThreadCheckStop()) return(NULL);
1910 /* Now figure out who made this select() unblock.
1911 * First, check for an error or exit condition.
1914 if (errno == EBADF) {
1915 CtdlLogPrintf(CTDL_NOTICE, "select() failed: (%s)\n",
1919 if (errno != EINTR) {
1920 CtdlLogPrintf(CTDL_EMERG, "Exiting (%s)\n", strerror(errno));
1921 CtdlThreadStopAll();
1922 } else if (!CtdlThreadCheckStop()) {
1923 CtdlLogPrintf(CTDL_DEBUG, "Un handled select failure.\n");
1927 else if(retval == 0) {
1930 /* Next, check to see if it's a new client connecting
1931 * on a master socket.
1933 else for (serviceptr = ServiceHookTable; serviceptr != NULL;
1934 serviceptr = serviceptr->next ) {
1936 if (FD_ISSET(serviceptr->msock, &readfds)) {
1937 ssock = accept(serviceptr->msock, NULL, 0);
1939 CtdlLogPrintf(CTDL_DEBUG,
1940 "New client socket %d\n",
1943 /* The master socket is non-blocking but the client
1944 * sockets need to be blocking, otherwise certain
1945 * operations barf on FreeBSD. Not a fatal error.
1947 if (fcntl(ssock, F_SETFL, 0) < 0) {
1948 CtdlLogPrintf(CTDL_EMERG,
1949 "citserver: Can't set socket to blocking: %s\n",
1953 /* New context will be created already
1954 * set up in the CON_EXECUTING state.
1956 con = CreateNewContext();
1958 /* Assign our new socket number to it. */
1959 con->client_socket = ssock;
1960 con->h_command_function =
1961 serviceptr->h_command_function;
1962 con->h_async_function =
1963 serviceptr->h_async_function;
1965 serviceptr->ServiceName;
1967 /* Determine whether it's a local socket */
1968 if (serviceptr->sockpath != NULL)
1969 con->is_local_socket = 1;
1971 /* Set the SO_REUSEADDR socket option */
1973 setsockopt(ssock, SOL_SOCKET,
1977 become_session(con);
1979 serviceptr->h_greeting_function();
1980 become_session(NULL);
1981 con->state = CON_IDLE;
1987 /* It must be a client socket. Find a context that has data
1988 * waiting on its socket *and* is in the CON_IDLE state. Any
1989 * active sockets other than our chosen one are marked as
1990 * CON_READY so the next thread that comes around can just bind
1991 * to one without having to select() again.
1993 begin_critical_section(S_SESSION_TABLE);
1994 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
1995 if ( (FD_ISSET(ptr->client_socket, &readfds))
1996 && (ptr->state != CON_EXECUTING) ) {
1997 ptr->input_waiting = 1;
1999 bind_me = ptr; /* I choose you! */
2000 bind_me->state = CON_EXECUTING;
2003 ptr->state = CON_READY;
2007 end_critical_section(S_SESSION_TABLE);
2010 /* We're bound to a session */
2011 if (bind_me != NULL) {
2012 become_session(bind_me);
2014 /* If the client has sent a command, execute it. */
2015 if (CC->input_waiting) {
2016 CC->h_command_function();
2017 CC->input_waiting = 0;
2020 /* If there are asynchronous messages waiting and the
2021 * client supports it, do those now */
2022 if ((CC->is_async) && (CC->async_waiting)
2023 && (CC->h_async_function != NULL)) {
2024 CC->h_async_function();
2025 CC->async_waiting = 0;
2028 force_purge = CC->kill_me;
2029 become_session(NULL);
2030 bind_me->state = CON_IDLE;
2033 dead_session_purge(force_purge);
2035 check_sched_shutdown();
2037 /* If control reaches this point, the server is shutting down */
2046 * Translate text facility name to syslog.h defined value.
2048 int SyslogFacility(char *name)
2057 { LOG_KERN, "kern" },
2058 { LOG_USER, "user" },
2059 { LOG_MAIL, "mail" },
2060 { LOG_DAEMON, "daemon" },
2061 { LOG_AUTH, "auth" },
2062 { LOG_SYSLOG, "syslog" },
2064 { LOG_NEWS, "news" },
2065 { LOG_UUCP, "uucp" },
2066 { LOG_LOCAL0, "local0" },
2067 { LOG_LOCAL1, "local1" },
2068 { LOG_LOCAL2, "local2" },
2069 { LOG_LOCAL3, "local3" },
2070 { LOG_LOCAL4, "local4" },
2071 { LOG_LOCAL5, "local5" },
2072 { LOG_LOCAL6, "local6" },
2073 { LOG_LOCAL7, "local7" },
2076 for(i = 0; facTbl[i].name != NULL; i++) {
2077 if(!strcasecmp(name, facTbl[i].name))
2078 return facTbl[i].facility;
2085 /********** MEM CHEQQER ***********/
2087 #ifdef DEBUG_MEMORY_LEAKS
2094 void *tracked_malloc(size_t size, char *file, int line) {
2095 struct igheap *thisheap;
2098 block = malloc(size);
2099 if (block == NULL) return(block);
2101 thisheap = malloc(sizeof(struct igheap));
2102 if (thisheap == NULL) {
2107 thisheap->block = block;
2108 strcpy(thisheap->file, file);
2109 thisheap->line = line;
2111 begin_critical_section(S_DEBUGMEMLEAKS);
2112 thisheap->next = igheap;
2114 end_critical_section(S_DEBUGMEMLEAKS);
2120 void *tracked_realloc(void *ptr, size_t size, char *file, int line) {
2121 struct igheap *thisheap;
2124 block = realloc(ptr, size);
2125 if (block == NULL) return(block);
2127 thisheap = malloc(sizeof(struct igheap));
2128 if (thisheap == NULL) {
2133 thisheap->block = block;
2134 strcpy(thisheap->file, file);
2135 thisheap->line = line;
2137 begin_critical_section(S_DEBUGMEMLEAKS);
2138 thisheap->next = igheap;
2140 end_critical_section(S_DEBUGMEMLEAKS);
2147 void tracked_free(void *ptr) {
2148 struct igheap *thisheap;
2149 struct igheap *trash;
2153 if (igheap == NULL) return;
2154 begin_critical_section(S_DEBUGMEMLEAKS);
2155 for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
2156 if (thisheap->next != NULL) {
2157 if (thisheap->next->block == ptr) {
2158 trash = thisheap->next;
2159 thisheap->next = thisheap->next->next;
2164 if (igheap->block == ptr) {
2166 igheap = igheap->next;
2169 end_critical_section(S_DEBUGMEMLEAKS);
2172 char *tracked_strdup(const char *s, char *file, int line) {
2175 if (s == NULL) return(NULL);
2176 ptr = tracked_malloc(strlen(s) + 1, file, line);
2177 if (ptr == NULL) return(NULL);
2178 strncpy(ptr, s, strlen(s));
2182 void dump_heap(void) {
2183 struct igheap *thisheap;
2185 for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
2186 CtdlLogPrintf(CTDL_CRIT, "UNFREED: %30s : %d\n",
2187 thisheap->file, thisheap->line);
2191 #endif /* DEBUG_MEMORY_LEAKS */