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>
26 #include <sys/syslog.h>
28 #if TIME_WITH_SYS_TIME
29 # include <sys/time.h>
33 # include <sys/time.h>
40 #include <sys/resource.h>
41 #include <netinet/in.h>
42 #include <netinet/tcp.h>
43 #include <arpa/inet.h>
56 #include "serv_extensions.h"
57 #include "sysdep_decls.h"
58 #include "citserver.h"
62 #include "housekeeping.h"
64 #include "serv_crypto.h"
65 #include "serv_fulltext.h"
67 #ifdef HAVE_SYS_SELECT_H
68 #include <sys/select.h>
76 #ifdef DEBUG_MEMORY_LEAKS
84 struct igheap *igheap = NULL;
88 pthread_mutex_t Critters[MAX_SEMAPHORES]; /* Things needing locking */
89 pthread_key_t MyConKey; /* TSD key for MyContext() */
91 int verbosity = DEFAULT_VERBOSITY; /* Logging level */
93 struct CitContext masterCC;
94 time_t last_purge = 0; /* Last dead session purge */
95 static int num_threads = 0; /* Current number of threads */
96 int num_sessions = 0; /* Current number of sessions */
97 pthread_t indexer_thread_tid;
98 pthread_t checkpoint_thread_tid;
100 int syslog_facility = LOG_DAEMON;
101 int enable_syslog = 0;
102 extern int running_as_daemon;
105 * lprintf() ... Write logging information
107 void lprintf(enum LogLevel loglevel, const char *format, ...) {
111 va_start(arg_ptr, format);
112 vsyslog((syslog_facility | loglevel), format, arg_ptr);
116 /* stderr output code */
117 if (enable_syslog || running_as_daemon) return;
119 /* if we run in forground and syslog is disabled, log to terminal */
120 if (loglevel <= verbosity) {
125 gettimeofday(&tv, NULL);
126 /* Promote to time_t; types differ on some OSes (like darwin) */
127 unixtime = tv.tv_sec;
128 localtime_r(&unixtime, &tim);
129 if (CC->cs_pid != 0) {
131 "%04d/%02d/%02d %2d:%02d:%02d.%06ld [%3d] ",
132 tim.tm_year + 1900, tim.tm_mon + 1,
133 tim.tm_mday, tim.tm_hour, tim.tm_min,
134 tim.tm_sec, (long)tv.tv_usec,
138 "%04d/%02d/%02d %2d:%02d:%02d.%06ld ",
139 tim.tm_year + 1900, tim.tm_mon + 1,
140 tim.tm_mday, tim.tm_hour, tim.tm_min,
141 tim.tm_sec, (long)tv.tv_usec);
143 va_start(arg_ptr, format);
144 vfprintf(stderr, format, arg_ptr);
153 * Signal handler to shut down the server.
156 volatile int time_to_die = 0;
157 volatile int shutdown_and_halt = 0;
159 static RETSIGTYPE signal_cleanup(int signum) {
160 lprintf(CTDL_DEBUG, "Caught signal %d; shutting down.\n", signum);
162 master_cleanup(signum);
167 * Some initialization stuff...
169 void init_sysdep(void) {
173 /* Avoid vulnerabilities related to FD_SETSIZE if we can. */
177 getrlimit(RLIMIT_NOFILE, &rl);
178 rl.rlim_cur = FD_SETSIZE;
179 rl.rlim_max = FD_SETSIZE;
180 setrlimit(RLIMIT_NOFILE, &rl);
184 /* If we've got OpenSSL, we're going to use it. */
189 /* Set up a bunch of semaphores to be used for critical sections */
190 for (i=0; i<MAX_SEMAPHORES; ++i) {
191 pthread_mutex_init(&Critters[i], NULL);
195 * Set up a place to put thread-specific data.
196 * We only need a single pointer per thread - it points to the
197 * CitContext structure (in the ContextList linked list) of the
198 * session to which the calling thread is currently bound.
200 if (pthread_key_create(&MyConKey, NULL) != 0) {
201 lprintf(CTDL_CRIT, "Can't create TSD key: %s\n",
206 * The action for unexpected signals and exceptions should be to
207 * call signal_cleanup() to gracefully shut down the server.
210 sigaddset(&set, SIGINT);
211 sigaddset(&set, SIGQUIT);
212 sigaddset(&set, SIGHUP);
213 sigaddset(&set, SIGTERM);
214 // sigaddset(&set, SIGSEGV); commented out because
215 // sigaddset(&set, SIGILL); we want core dumps
216 // sigaddset(&set, SIGBUS);
217 sigprocmask(SIG_UNBLOCK, &set, NULL);
219 signal(SIGINT, signal_cleanup);
220 signal(SIGQUIT, signal_cleanup);
221 signal(SIGHUP, signal_cleanup);
222 signal(SIGTERM, signal_cleanup);
223 // signal(SIGSEGV, signal_cleanup); commented out because
224 // signal(SIGILL, signal_cleanup); we want core dumps
225 // signal(SIGBUS, signal_cleanup);
228 * Do not shut down the server on broken pipe signals, otherwise the
229 * whole Citadel service would come down whenever a single client
232 signal(SIGPIPE, SIG_IGN);
237 * Obtain a semaphore lock to begin a critical section.
239 void begin_critical_section(int which_one)
241 /* lprintf(CTDL_DEBUG, "begin_critical_section(%d)\n", which_one); */
243 /* For all types of critical sections except those listed here,
244 * ensure nobody ever tries to do a critical section within a
245 * transaction; this could lead to deadlock.
247 if ( (which_one != S_FLOORCACHE)
248 #ifdef DEBUG_MEMORY_LEAKS
249 && (which_one != S_DEBUGMEMLEAKS)
251 && (which_one != S_RPLIST)
255 pthread_mutex_lock(&Critters[which_one]);
259 * Release a semaphore lock to end a critical section.
261 void end_critical_section(int which_one)
263 pthread_mutex_unlock(&Critters[which_one]);
269 * This is a generic function to set up a master socket for listening on
270 * a TCP port. The server shuts down if the bind fails.
273 int ig_tcp_server(char *ip_addr, int port_number, int queue_len, char **errormessage)
275 struct sockaddr_in sin;
277 int actual_queue_len;
279 actual_queue_len = queue_len;
280 if (actual_queue_len < 5) actual_queue_len = 5;
282 memset(&sin, 0, sizeof(sin));
283 sin.sin_family = AF_INET;
284 sin.sin_port = htons((u_short)port_number);
285 if (ip_addr == NULL) {
286 sin.sin_addr.s_addr = INADDR_ANY;
289 sin.sin_addr.s_addr = inet_addr(ip_addr);
292 if (sin.sin_addr.s_addr == INADDR_NONE) {
293 sin.sin_addr.s_addr = INADDR_ANY;
296 s = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP);
299 *errormessage = (char*) malloc(SIZ + 1);
300 snprintf(*errormessage, SIZ,
301 "citserver: Can't create a socket: %s",
303 lprintf(CTDL_EMERG, "%s\n", *errormessage);
308 setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
310 if (bind(s, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
311 *errormessage = (char*) malloc(SIZ + 1);
312 snprintf(*errormessage, SIZ,
313 "citserver: Can't bind: %s",
315 lprintf(CTDL_EMERG, "%s\n", *errormessage);
320 /* set to nonblock - we need this for some obscure situations */
321 if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
322 *errormessage = (char*) malloc(SIZ + 1);
323 snprintf(*errormessage, SIZ,
324 "citserver: Can't set socket to non-blocking: %s",
326 lprintf(CTDL_EMERG, "%s\n", *errormessage);
331 if (listen(s, actual_queue_len) < 0) {
332 *errormessage = (char*) malloc(SIZ + 1);
333 snprintf(*errormessage, SIZ,
334 "citserver: Can't listen: %s",
336 lprintf(CTDL_EMERG, "%s\n", *errormessage);
347 * Create a Unix domain socket and listen on it
349 int ig_uds_server(char *sockpath, int queue_len, char **errormessage)
351 struct sockaddr_un addr;
354 int actual_queue_len;
356 actual_queue_len = queue_len;
357 if (actual_queue_len < 5) actual_queue_len = 5;
359 i = unlink(sockpath);
360 if (i != 0) if (errno != ENOENT) {
361 *errormessage = (char*) malloc(SIZ + 1);
362 snprintf(*errormessage, SIZ, "citserver: can't unlink %s: %s",
363 sockpath, strerror(errno));
364 lprintf(CTDL_EMERG, "%s\n", *errormessage);
368 memset(&addr, 0, sizeof(addr));
369 addr.sun_family = AF_UNIX;
370 safestrncpy(addr.sun_path, sockpath, sizeof addr.sun_path);
372 s = socket(AF_UNIX, SOCK_STREAM, 0);
374 *errormessage = (char*) malloc(SIZ + 1);
375 snprintf(*errormessage, SIZ,
376 "citserver: Can't create a socket: %s",
378 lprintf(CTDL_EMERG, "%s\n", *errormessage);
382 if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
383 *errormessage = (char*) malloc(SIZ + 1);
384 snprintf(*errormessage, SIZ,
385 "citserver: Can't bind: %s",
387 lprintf(CTDL_EMERG, "%s\n", *errormessage);
391 /* set to nonblock - we need this for some obscure situations */
392 if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
393 *errormessage = (char*) malloc(SIZ + 1);
394 snprintf(*errormessage, SIZ,
395 "citserver: Can't set socket to non-blocking: %s",
397 lprintf(CTDL_EMERG, "%s\n", *errormessage);
402 if (listen(s, actual_queue_len) < 0) {
403 *errormessage = (char*) malloc(SIZ + 1);
404 snprintf(*errormessage, SIZ,
405 "citserver: Can't listen: %s",
407 lprintf(CTDL_EMERG, "%s\n", *errormessage);
411 chmod(sockpath, 0777);
418 * Return a pointer to the CitContext structure bound to the thread which
419 * called this function. If there's no such binding (for example, if it's
420 * called by the housekeeper thread) then a generic 'master' CC is returned.
422 * This function is used *VERY* frequently and must be kept small.
424 struct CitContext *MyContext(void) {
426 register struct CitContext *c;
428 return ((c = (struct CitContext *) pthread_getspecific(MyConKey),
429 c == NULL) ? &masterCC : c
435 * Initialize a new context and place it in the list. The session number
436 * used to be the PID (which is why it's called cs_pid), but that was when we
437 * had one process per session. Now we just assign them sequentially, starting
438 * at 1 (don't change it to 0 because masterCC uses 0).
440 struct CitContext *CreateNewContext(void) {
441 struct CitContext *me;
442 static int next_pid = 0;
444 me = (struct CitContext *) malloc(sizeof(struct CitContext));
446 lprintf(CTDL_ALERT, "citserver: can't allocate memory!!\n");
449 memset(me, 0, sizeof(struct CitContext));
451 /* The new context will be created already in the CON_EXECUTING state
452 * in order to prevent another thread from grabbing it while it's
455 me->state = CON_EXECUTING;
458 * Generate a unique session number and insert this context into
461 begin_critical_section(S_SESSION_TABLE);
462 me->cs_pid = ++next_pid;
464 me->next = ContextList;
466 if (me->next != NULL) {
470 end_critical_section(S_SESSION_TABLE);
476 * The following functions implement output buffering. If the kernel supplies
477 * native TCP buffering (Linux & *BSD), use that; otherwise, emulate it with
478 * user-space buffering.
482 # define HAVE_TCP_BUFFERING
485 # define HAVE_TCP_BUFFERING
486 # define TCP_CORK TCP_NOPUSH
488 #endif /* TCP_CORK */
489 #endif /* HAVE_DARWIN */
491 #ifdef HAVE_TCP_BUFFERING
492 static unsigned on = 1, off = 0;
493 void buffer_output(void) {
494 struct CitContext *ctx = MyContext();
495 setsockopt(ctx->client_socket, IPPROTO_TCP, TCP_CORK, &on, 4);
499 void unbuffer_output(void) {
500 struct CitContext *ctx = MyContext();
501 setsockopt(ctx->client_socket, IPPROTO_TCP, TCP_CORK, &off, 4);
505 void flush_output(void) {
506 struct CitContext *ctx = MyContext();
507 setsockopt(ctx->client_socket, IPPROTO_TCP, TCP_CORK, &off, 4);
508 setsockopt(ctx->client_socket, IPPROTO_TCP, TCP_CORK, &on, 4);
511 /* Stub functions for Darwin/OS X where TCP buffering isn't liked at all */
512 void buffer_output(void) {
515 void unbuffer_output(void) {
518 void flush_output(void) {
521 void buffer_output(void) {
522 if (CC->buffering == 0) {
525 CC->output_buffer = malloc(SIZ);
529 void flush_output(void) {
530 if (CC->buffering == 1) {
531 client_write(CC->output_buffer, CC->buffer_len);
536 void unbuffer_output(void) {
537 if (CC->buffering == 1) {
539 /* We don't call flush_output because we can't. */
540 client_write(CC->output_buffer, CC->buffer_len);
542 free(CC->output_buffer);
543 CC->output_buffer = NULL;
551 * client_write() ... Send binary data to the client.
553 void client_write(char *buf, int nbytes)
555 int bytes_written = 0;
557 #ifndef HAVE_TCP_BUFFERING
558 int old_buffer_len = 0;
561 if (CC->redirect_buffer != NULL) {
562 if ((CC->redirect_len + nbytes + 2) >= CC->redirect_alloc) {
563 CC->redirect_alloc = (CC->redirect_alloc * 2) + nbytes;
564 CC->redirect_buffer = realloc(CC->redirect_buffer,
567 memcpy(&CC->redirect_buffer[CC->redirect_len], buf, nbytes);
568 CC->redirect_len += nbytes;
569 CC->redirect_buffer[CC->redirect_len] = 0;
573 #ifndef HAVE_TCP_BUFFERING
574 /* If we're buffering for later, do that now. */
576 old_buffer_len = CC->buffer_len;
577 CC->buffer_len += nbytes;
578 CC->output_buffer = realloc(CC->output_buffer, CC->buffer_len);
579 memcpy(&CC->output_buffer[old_buffer_len], buf, nbytes);
584 /* Ok, at this point we're not buffering. Go ahead and write. */
587 if (CC->redirect_ssl) {
588 client_write_ssl(buf, nbytes);
593 while (bytes_written < nbytes) {
594 retval = write(CC->client_socket, &buf[bytes_written],
595 nbytes - bytes_written);
598 "client_write(%d bytes) failed: %s (%d)\n",
599 nbytes - bytes_written,
600 strerror(errno), errno);
604 bytes_written = bytes_written + retval;
610 * cprintf() ... Send formatted printable data to the client. It is
611 * implemented in terms of client_write() but remains in
612 * sysdep.c in case we port to somewhere without va_args...
614 void cprintf(const char *format, ...) {
618 va_start(arg_ptr, format);
619 if (vsnprintf(buf, sizeof buf, format, arg_ptr) == -1)
620 buf[sizeof buf - 2] = '\n';
621 client_write(buf, strlen(buf));
627 * Read data from the client socket.
629 * 1 Requested number of bytes has been read.
630 * 0 Request timed out.
631 * -1 The socket is broken.
632 * If the socket breaks, the session will be terminated.
634 int client_read_to(char *buf, int bytes, int timeout)
642 if (CC->redirect_ssl) {
643 return (client_read_ssl(buf, bytes, timeout));
649 FD_SET(CC->client_socket, &rfds);
653 retval = select( (CC->client_socket)+1,
654 &rfds, NULL, NULL, &tv);
656 if (FD_ISSET(CC->client_socket, &rfds) == 0) {
660 rlen = read(CC->client_socket, &buf[len], bytes-len);
662 /* The socket has been disconnected! */
672 * Read data from the client socket with default timeout.
673 * (This is implemented in terms of client_read_to() and could be
674 * justifiably moved out of sysdep.c)
676 INLINE int client_read(char *buf, int bytes)
678 return(client_read_to(buf, bytes, config.c_sleeping));
683 * client_getln() ... Get a LF-terminated line of text from the client.
684 * (This is implemented in terms of client_read() and could be
685 * justifiably moved out of sysdep.c)
687 int client_getln(char *buf, int bufsize)
691 /* Read one character at a time.
694 retval = client_read(&buf[i], 1);
695 if (retval != 1 || buf[i] == '\n' || i == (bufsize-1))
699 /* If we got a long line, discard characters until the newline.
701 if (i == (bufsize-1))
702 while (buf[i] != '\n' && retval == 1)
703 retval = client_read(&buf[i], 1);
705 /* Strip the trailing LF, and the trailing CR if present.
708 while ( (strlen(buf) > 0) && ((buf[strlen(buf)-1]==10) || (buf[strlen(buf)-1] == 13)) ) {
709 buf[strlen(buf)-1] = 0;
711 if (retval < 0) safestrncpy(buf, "000", bufsize);
718 * The system-dependent part of master_cleanup() - close the master socket.
720 void sysdep_master_cleanup(void) {
721 struct ServiceFunctionHook *serviceptr;
724 * close all protocol master sockets
726 for (serviceptr = ServiceHookTable; serviceptr != NULL;
727 serviceptr = serviceptr->next ) {
729 if (serviceptr->tcp_port > 0)
730 lprintf(CTDL_INFO, "Closing listener on port %d\n",
731 serviceptr->tcp_port);
733 if (serviceptr->sockpath != NULL)
734 lprintf(CTDL_INFO, "Closing listener on '%s'\n",
735 serviceptr->sockpath);
737 close(serviceptr->msock);
739 /* If it's a Unix domain socket, remove the file. */
740 if (serviceptr->sockpath != NULL) {
741 unlink(serviceptr->sockpath);
748 * Terminate another session.
749 * (This could justifiably be moved out of sysdep.c because it
750 * no longer does anything that is system-dependent.)
752 void kill_session(int session_to_kill) {
753 struct CitContext *ptr;
755 begin_critical_section(S_SESSION_TABLE);
756 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
757 if (ptr->cs_pid == session_to_kill) {
761 end_critical_section(S_SESSION_TABLE);
765 void graceful_shutdown(int signum) {
766 kill(current_child, signum);
767 unlink(file_pid_file);
773 * Start running as a daemon.
775 void start_daemon(int unused) {
783 /* Close stdin/stdout/stderr and replace them with /dev/null.
784 * We don't just call close() because we don't want these fd's
785 * to be reused for other files.
794 signal(SIGHUP, SIG_IGN);
795 signal(SIGINT, SIG_IGN);
796 signal(SIGQUIT, SIG_IGN);
800 freopen("/dev/null", "r", stdin);
801 freopen("/dev/null", "w", stdout);
802 freopen("/dev/null", "w", stderr);
805 current_child = fork();
807 signal(SIGTERM, graceful_shutdown);
809 if (current_child < 0) {
814 else if (current_child == 0) {
815 return; /* continue starting citadel. */
819 fp = fopen(file_pid_file, "w");
821 fprintf(fp, "%d\n", child);
824 waitpid(current_child, &status, 0);
829 /* Did the main process exit with an actual exit code? */
830 if (WIFEXITED(status)) {
832 /* Exit code 0 means the watcher should exit */
833 if (WEXITSTATUS(status) == 0) {
837 /* Exit code 101-109 means the watcher should exit */
838 else if ( (WEXITSTATUS(status) >= 101) && (WEXITSTATUS(status) <= 109) ) {
842 /* Any other exit code means we should restart. */
848 /* Any other type of termination (signals, etc.) should also restart. */
853 } while (do_restart);
855 unlink(file_pid_file);
856 exit(WEXITSTATUS(status));
862 * Generic routine to convert a login name to a full name (gecos)
863 * Returns nonzero if a conversion took place
865 int convert_login(char NameToConvert[]) {
869 pw = getpwnam(NameToConvert);
874 strcpy(NameToConvert, pw->pw_gecos);
875 for (a=0; a<strlen(NameToConvert); ++a) {
876 if (NameToConvert[a] == ',') NameToConvert[a] = 0;
882 struct worker_node *worker_list = NULL;
886 * create a worker thread. this function must always be called from within
887 * an S_WORKER_LIST critical section!
889 void create_worker(void) {
891 struct worker_node *n;
894 n = malloc(sizeof(struct worker_node));
896 lprintf(CTDL_EMERG, "can't allocate worker_node, exiting\n");
901 if ((ret = pthread_attr_init(&attr))) {
902 lprintf(CTDL_EMERG, "pthread_attr_init: %s\n", strerror(ret));
907 /* Our per-thread stacks need to be bigger than the default size,
908 * otherwise the MIME parser crashes on FreeBSD, and the IMAP service
909 * crashes on 64-bit Linux.
911 if ((ret = pthread_attr_setstacksize(&attr, THREADSTACKSIZE))) {
912 lprintf(CTDL_EMERG, "pthread_attr_setstacksize: %s\n",
915 pthread_attr_destroy(&attr);
919 if ((ret = pthread_create(&n->tid, &attr, worker_thread, NULL) != 0))
922 lprintf(CTDL_ALERT, "Can't create worker thread: %s\n",
926 n->next = worker_list;
928 pthread_attr_destroy(&attr);
933 * Create the indexer thread and begin its operation.
934 * Then create the checkpoint thread and begin its operation.
936 void create_maintenance_threads(void) {
940 if ((ret = pthread_attr_init(&attr))) {
941 lprintf(CTDL_EMERG, "pthread_attr_init: %s\n", strerror(ret));
946 /* Our per-thread stacks need to be bigger than the default size,
947 * otherwise the MIME parser crashes on FreeBSD, and the IMAP service
948 * crashes on 64-bit Linux.
950 if ((ret = pthread_attr_setstacksize(&attr, THREADSTACKSIZE))) {
951 lprintf(CTDL_EMERG, "pthread_attr_setstacksize: %s\n",
954 pthread_attr_destroy(&attr);
958 if ((ret = pthread_create(&indexer_thread_tid, &attr, indexer_thread, NULL) != 0)) {
959 lprintf(CTDL_ALERT, "Can't create thread: %s\n", strerror(ret));
962 if ((ret = pthread_create(&checkpoint_thread_tid, &attr, checkpoint_thread, NULL) != 0)) {
963 lprintf(CTDL_ALERT, "Can't create thread: %s\n", strerror(ret));
966 pthread_attr_destroy(&attr);
972 * Purge all sessions which have the 'kill_me' flag set.
973 * This function has code to prevent it from running more than once every
974 * few seconds, because running it after every single unbind would waste a lot
975 * of CPU time and keep the context list locked too much. To force it to run
976 * anyway, set "force" to nonzero.
979 * After that's done, we raise the size of the worker thread pool
980 * if such an action is appropriate.
982 void dead_session_purge(int force) {
983 struct CitContext *ptr; /* general-purpose utility pointer */
984 struct CitContext *rem = NULL; /* list of sessions to be destroyed */
987 if ( (time(NULL) - last_purge) < 5 ) {
988 return; /* Too soon, go away */
993 begin_critical_section(S_SESSION_TABLE);
994 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
995 if ( (ptr->state == CON_IDLE) && (ptr->kill_me) ) {
997 /* Remove the session from the active list */
999 ptr->prev->next = ptr->next;
1002 ContextList = ptr->next;
1005 ptr->next->prev = ptr->prev;
1010 /* And put it on our to-be-destroyed list */
1016 end_critical_section(S_SESSION_TABLE);
1018 /* Now that we no longer have the session list locked, we can take
1019 * our time and destroy any sessions on the to-be-killed list, which
1020 * is allocated privately on this thread's stack.
1022 while (rem != NULL) {
1023 lprintf(CTDL_DEBUG, "Purging session %d\n", rem->cs_pid);
1030 /* Raise the size of the worker thread pool if necessary. */
1031 if ( (num_sessions > num_threads)
1032 && (num_threads < config.c_max_workers) ) {
1033 begin_critical_section(S_WORKER_LIST);
1035 end_critical_section(S_WORKER_LIST);
1044 * masterCC is the context we use when not attached to a session. This
1045 * function initializes it.
1047 void InitializeMasterCC(void) {
1048 memset(&masterCC, 0, sizeof(struct CitContext));
1049 masterCC.internal_pgm = 1;
1050 masterCC.cs_pid = 0;
1059 * Bind a thread to a context. (It's inline merely to speed things up.)
1061 INLINE void become_session(struct CitContext *which_con) {
1062 pthread_setspecific(MyConKey, (void *)which_con );
1068 * This loop just keeps going and going and going...
1070 void *worker_thread(void *arg) {
1073 struct CitContext *ptr;
1074 struct CitContext *bind_me = NULL;
1077 struct CitContext *con= NULL; /* Temporary context pointer */
1078 struct ServiceFunctionHook *serviceptr;
1079 int ssock; /* Descriptor for client socket */
1081 int force_purge = 0;
1088 while (!time_to_die) {
1090 /* make doubly sure we're not holding any stale db handles
1091 * which might cause a deadlock.
1093 cdb_check_handles();
1094 do_select: force_purge = 0;
1095 bind_me = NULL; /* Which session shall we handle? */
1097 /* Initialize the fdset. */
1101 begin_critical_section(S_SESSION_TABLE);
1102 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
1103 if (ptr->state == CON_IDLE) {
1104 FD_SET(ptr->client_socket, &readfds);
1105 if (ptr->client_socket > highest)
1106 highest = ptr->client_socket;
1108 if ((bind_me == NULL) && (ptr->state == CON_READY)) {
1110 ptr->state = CON_EXECUTING;
1113 end_critical_section(S_SESSION_TABLE);
1119 /* If we got this far, it means that there are no sessions
1120 * which a previous thread marked for attention, so we go
1121 * ahead and get ready to select().
1124 /* First, add the various master sockets to the fdset. */
1125 for (serviceptr = ServiceHookTable; serviceptr != NULL;
1126 serviceptr = serviceptr->next ) {
1127 m = serviceptr->msock;
1128 FD_SET(m, &readfds);
1135 tv.tv_sec = 1; /* wake up every second if no input */
1137 retval = select(highest + 1, &readfds, NULL, NULL, &tv);
1140 if (time_to_die) return(NULL);
1142 /* Now figure out who made this select() unblock.
1143 * First, check for an error or exit condition.
1146 if (errno == EBADF) {
1147 lprintf(CTDL_NOTICE, "select() failed: (%s)\n",
1151 if (errno != EINTR) {
1152 lprintf(CTDL_EMERG, "Exiting (%s)\n", strerror(errno));
1154 } else if (!time_to_die)
1158 /* Next, check to see if it's a new client connecting
1159 * on a master socket.
1161 else for (serviceptr = ServiceHookTable; serviceptr != NULL;
1162 serviceptr = serviceptr->next ) {
1164 if (FD_ISSET(serviceptr->msock, &readfds)) {
1165 ssock = accept(serviceptr->msock, NULL, 0);
1168 "New client socket %d\n",
1171 /* The master socket is non-blocking but the client
1172 * sockets need to be blocking, otherwise certain
1173 * operations barf on FreeBSD. Not a fatal error.
1175 if (fcntl(ssock, F_SETFL, 0) < 0) {
1177 "citserver: Can't set socket to blocking: %s\n",
1181 /* New context will be created already
1182 * set up in the CON_EXECUTING state.
1184 con = CreateNewContext();
1186 /* Assign our new socket number to it. */
1187 con->client_socket = ssock;
1188 con->h_command_function =
1189 serviceptr->h_command_function;
1190 con->h_async_function =
1191 serviceptr->h_async_function;
1193 /* Determine whether it's a local socket */
1194 if (serviceptr->sockpath != NULL)
1195 con->is_local_socket = 1;
1197 /* Set the SO_REUSEADDR socket option */
1199 setsockopt(ssock, SOL_SOCKET,
1203 become_session(con);
1205 serviceptr->h_greeting_function();
1206 become_session(NULL);
1207 con->state = CON_IDLE;
1213 /* It must be a client socket. Find a context that has data
1214 * waiting on its socket *and* is in the CON_IDLE state. Any
1215 * active sockets other than our chosen one are marked as
1216 * CON_READY so the next thread that comes around can just bind
1217 * to one without having to select() again.
1219 begin_critical_section(S_SESSION_TABLE);
1220 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
1221 if ( (FD_ISSET(ptr->client_socket, &readfds))
1222 && (ptr->state != CON_EXECUTING) ) {
1223 ptr->input_waiting = 1;
1225 bind_me = ptr; /* I choose you! */
1226 bind_me->state = CON_EXECUTING;
1229 ptr->state = CON_READY;
1233 end_critical_section(S_SESSION_TABLE);
1236 /* We're bound to a session */
1237 if (bind_me != NULL) {
1238 become_session(bind_me);
1240 /* If the client has sent a command, execute it. */
1241 if (CC->input_waiting) {
1242 CC->h_command_function();
1243 CC->input_waiting = 0;
1246 /* If there are asynchronous messages waiting and the
1247 * client supports it, do those now */
1248 if ((CC->is_async) && (CC->async_waiting)
1249 && (CC->h_async_function != NULL)) {
1250 CC->h_async_function();
1251 CC->async_waiting = 0;
1254 force_purge = CC->kill_me;
1255 become_session(NULL);
1256 bind_me->state = CON_IDLE;
1259 dead_session_purge(force_purge);
1261 check_sched_shutdown();
1264 /* If control reaches this point, the server is shutting down */
1273 * Translate text facility name to syslog.h defined value.
1275 int SyslogFacility(char *name)
1284 { LOG_KERN, "kern" },
1285 { LOG_USER, "user" },
1286 { LOG_MAIL, "mail" },
1287 { LOG_DAEMON, "daemon" },
1288 { LOG_AUTH, "auth" },
1289 { LOG_SYSLOG, "syslog" },
1291 { LOG_NEWS, "news" },
1292 { LOG_UUCP, "uucp" },
1293 { LOG_LOCAL0, "local0" },
1294 { LOG_LOCAL1, "local1" },
1295 { LOG_LOCAL2, "local2" },
1296 { LOG_LOCAL3, "local3" },
1297 { LOG_LOCAL4, "local4" },
1298 { LOG_LOCAL5, "local5" },
1299 { LOG_LOCAL6, "local6" },
1300 { LOG_LOCAL7, "local7" },
1303 for(i = 0; facTbl[i].name != NULL; i++) {
1304 if(!strcasecmp(name, facTbl[i].name))
1305 return facTbl[i].facility;
1312 /********** MEM CHEQQER ***********/
1314 #ifdef DEBUG_MEMORY_LEAKS
1321 void *tracked_malloc(size_t size, char *file, int line) {
1322 struct igheap *thisheap;
1325 block = malloc(size);
1326 if (block == NULL) return(block);
1328 thisheap = malloc(sizeof(struct igheap));
1329 if (thisheap == NULL) {
1334 thisheap->block = block;
1335 strcpy(thisheap->file, file);
1336 thisheap->line = line;
1338 begin_critical_section(S_DEBUGMEMLEAKS);
1339 thisheap->next = igheap;
1341 end_critical_section(S_DEBUGMEMLEAKS);
1347 void *tracked_realloc(void *ptr, size_t size, char *file, int line) {
1348 struct igheap *thisheap;
1351 block = realloc(ptr, size);
1352 if (block == NULL) return(block);
1354 thisheap = malloc(sizeof(struct igheap));
1355 if (thisheap == NULL) {
1360 thisheap->block = block;
1361 strcpy(thisheap->file, file);
1362 thisheap->line = line;
1364 begin_critical_section(S_DEBUGMEMLEAKS);
1365 thisheap->next = igheap;
1367 end_critical_section(S_DEBUGMEMLEAKS);
1374 void tracked_free(void *ptr) {
1375 struct igheap *thisheap;
1376 struct igheap *trash;
1380 if (igheap == NULL) return;
1381 begin_critical_section(S_DEBUGMEMLEAKS);
1382 for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
1383 if (thisheap->next != NULL) {
1384 if (thisheap->next->block == ptr) {
1385 trash = thisheap->next;
1386 thisheap->next = thisheap->next->next;
1391 if (igheap->block == ptr) {
1393 igheap = igheap->next;
1396 end_critical_section(S_DEBUGMEMLEAKS);
1399 char *tracked_strdup(const char *s, char *file, int line) {
1402 if (s == NULL) return(NULL);
1403 ptr = tracked_malloc(strlen(s) + 1, file, line);
1404 if (ptr == NULL) return(NULL);
1405 strncpy(ptr, s, strlen(s));
1409 void dump_heap(void) {
1410 struct igheap *thisheap;
1412 for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
1413 lprintf(CTDL_CRIT, "UNFREED: %30s : %d\n",
1414 thisheap->file, thisheap->line);
1418 #endif /* DEBUG_MEMORY_LEAKS */