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>
52 #include <libcitadel.h>
55 #include "sysdep_decls.h"
56 #include "citserver.h"
60 #include "housekeeping.h"
61 #include "modules/crypto/serv_crypto.h" /* Needed for init_ssl, client_write_ssl, client_read_ssl, destruct_ssl */
64 #ifdef HAVE_SYS_SELECT_H
65 #include <sys/select.h>
72 #include "ctdl_module.h"
78 #ifdef DEBUG_MEMORY_LEAKS
86 struct igheap *igheap = NULL;
90 citthread_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 int num_sessions = 0; /* Current number of sessions */
98 int syslog_facility = LOG_DAEMON;
99 int enable_syslog = 0;
102 /* Flag for single user mode */
103 static int want_single_user = 0;
105 /* Try to go single user */
107 int CtdlTrySingleUser(void)
111 begin_critical_section(S_SINGLE_USER);
112 if (want_single_user)
117 want_single_user = 1;
119 end_critical_section(S_SINGLE_USER);
123 void CtdlEndSingleUser(void)
125 begin_critical_section(S_SINGLE_USER);
126 want_single_user = 0;
127 end_critical_section(S_SINGLE_USER);
131 int CtdlWantSingleUser(void)
133 return want_single_user;
136 int CtdlIsSingleUser(void)
138 if (want_single_user)
140 /* check for only one context here */
141 if (num_sessions == 1)
149 * CtdlLogPrintf() ... Write logging information
151 void CtdlLogPrintf(enum LogLevel loglevel, const char *format, ...) {
153 va_start(arg_ptr, format);
154 vCtdlLogPrintf(loglevel, format, arg_ptr);
158 void vCtdlLogPrintf(enum LogLevel loglevel, const char *format, va_list arg_ptr)
160 char buf[SIZ], buf2[SIZ];
163 vsyslog((syslog_facility | loglevel), format, arg_ptr);
166 /* stderr output code */
167 if (enable_syslog || running_as_daemon) return;
169 /* if we run in forground and syslog is disabled, log to terminal */
170 if (loglevel <= verbosity) {
175 gettimeofday(&tv, NULL);
176 /* Promote to time_t; types differ on some OSes (like darwin) */
177 unixtime = tv.tv_sec;
178 localtime_r(&unixtime, &tim);
179 if (CC->cs_pid != 0) {
181 "%04d/%02d/%02d %2d:%02d:%02d.%06ld [%3d] ",
182 tim.tm_year + 1900, tim.tm_mon + 1,
183 tim.tm_mday, tim.tm_hour, tim.tm_min,
184 tim.tm_sec, (long)tv.tv_usec,
188 "%04d/%02d/%02d %2d:%02d:%02d.%06ld ",
189 tim.tm_year + 1900, tim.tm_mon + 1,
190 tim.tm_mday, tim.tm_hour, tim.tm_min,
191 tim.tm_sec, (long)tv.tv_usec);
193 vsnprintf(buf2, SIZ, format, arg_ptr);
195 fprintf(stderr, "%s%s", buf, buf2);
203 * Signal handler to shut down the server.
206 volatile int exit_signal = 0;
207 volatile int shutdown_and_halt = 0;
208 volatile int restart_server = 0;
209 volatile int running_as_daemon = 0;
211 static RETSIGTYPE signal_cleanup(int signum) {
212 #ifdef THREADS_USESIGNALS
218 CtdlLogPrintf(CTDL_DEBUG, "Caught signal %d; shutting down.\n", signum);
219 exit_signal = signum;
226 * Some initialization stuff...
228 void init_sysdep(void) {
231 /* Avoid vulnerabilities related to FD_SETSIZE if we can. */
235 getrlimit(RLIMIT_NOFILE, &rl);
236 rl.rlim_cur = FD_SETSIZE;
237 rl.rlim_max = FD_SETSIZE;
238 setrlimit(RLIMIT_NOFILE, &rl);
242 /* If we've got OpenSSL, we're going to use it. */
248 * Set up a place to put thread-specific data.
249 * We only need a single pointer per thread - it points to the
250 * CitContext structure (in the ContextList linked list) of the
251 * session to which the calling thread is currently bound.
253 if (citthread_key_create(&MyConKey, NULL) != 0) {
254 CtdlLogPrintf(CTDL_CRIT, "Can't create TSD key: %s\n",
259 * The action for unexpected signals and exceptions should be to
260 * call signal_cleanup() to gracefully shut down the server.
263 sigaddset(&set, SIGINT);
264 sigaddset(&set, SIGQUIT);
265 sigaddset(&set, SIGHUP);
266 sigaddset(&set, SIGTERM);
267 // sigaddset(&set, SIGSEGV); commented out because
268 // sigaddset(&set, SIGILL); we want core dumps
269 // sigaddset(&set, SIGBUS);
270 sigprocmask(SIG_UNBLOCK, &set, NULL);
272 signal(SIGINT, signal_cleanup);
273 signal(SIGQUIT, signal_cleanup);
274 signal(SIGHUP, signal_cleanup);
275 signal(SIGTERM, signal_cleanup);
276 // signal(SIGSEGV, signal_cleanup); commented out because
277 // signal(SIGILL, signal_cleanup); we want core dumps
278 // signal(SIGBUS, signal_cleanup);
281 * Do not shut down the server on broken pipe signals, otherwise the
282 * whole Citadel service would come down whenever a single client
285 signal(SIGPIPE, SIG_IGN);
292 * This is a generic function to set up a master socket for listening on
293 * a TCP port. The server shuts down if the bind fails.
296 int ig_tcp_server(char *ip_addr, int port_number, int queue_len, char **errormessage)
298 struct sockaddr_in sin;
300 int actual_queue_len;
302 actual_queue_len = queue_len;
303 if (actual_queue_len < 5) actual_queue_len = 5;
305 memset(&sin, 0, sizeof(sin));
306 sin.sin_family = AF_INET;
307 sin.sin_port = htons((u_short)port_number);
308 if (ip_addr == NULL) {
309 sin.sin_addr.s_addr = INADDR_ANY;
312 sin.sin_addr.s_addr = inet_addr(ip_addr);
315 if (sin.sin_addr.s_addr == !INADDR_ANY) {
316 sin.sin_addr.s_addr = INADDR_ANY;
319 s = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP);
322 *errormessage = (char*) malloc(SIZ + 1);
323 snprintf(*errormessage, SIZ,
324 "citserver: Can't create a socket: %s",
326 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
331 setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
333 if (bind(s, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
334 *errormessage = (char*) malloc(SIZ + 1);
335 snprintf(*errormessage, SIZ,
336 "citserver: Can't bind: %s",
338 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
343 /* set to nonblock - we need this for some obscure situations */
344 if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
345 *errormessage = (char*) malloc(SIZ + 1);
346 snprintf(*errormessage, SIZ,
347 "citserver: Can't set socket to non-blocking: %s",
349 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
354 if (listen(s, actual_queue_len) < 0) {
355 *errormessage = (char*) malloc(SIZ + 1);
356 snprintf(*errormessage, SIZ,
357 "citserver: Can't listen: %s",
359 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
370 * Create a Unix domain socket and listen on it
372 int ig_uds_server(char *sockpath, int queue_len, char **errormessage)
374 struct sockaddr_un addr;
377 int actual_queue_len;
379 actual_queue_len = queue_len;
380 if (actual_queue_len < 5) actual_queue_len = 5;
382 i = unlink(sockpath);
383 if ((i != 0) && (errno != ENOENT)) {
384 *errormessage = (char*) malloc(SIZ + 1);
385 snprintf(*errormessage, SIZ, "citserver: can't unlink %s: %s",
386 sockpath, strerror(errno));
387 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
391 memset(&addr, 0, sizeof(addr));
392 addr.sun_family = AF_UNIX;
393 safestrncpy(addr.sun_path, sockpath, sizeof addr.sun_path);
395 s = socket(AF_UNIX, SOCK_STREAM, 0);
397 *errormessage = (char*) malloc(SIZ + 1);
398 snprintf(*errormessage, SIZ,
399 "citserver: Can't create a socket: %s",
401 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
405 if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
406 *errormessage = (char*) malloc(SIZ + 1);
407 snprintf(*errormessage, SIZ,
408 "citserver: Can't bind: %s",
410 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
414 /* set to nonblock - we need this for some obscure situations */
415 if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
416 *errormessage = (char*) malloc(SIZ + 1);
417 snprintf(*errormessage, SIZ,
418 "citserver: Can't set socket to non-blocking: %s",
420 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
425 if (listen(s, actual_queue_len) < 0) {
426 *errormessage = (char*) malloc(SIZ + 1);
427 snprintf(*errormessage, SIZ,
428 "citserver: Can't listen: %s",
430 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
434 chmod(sockpath, S_ISGID|S_IRUSR|S_IWUSR|S_IXUSR|S_IRGRP|S_IWGRP|S_IXGRP|S_IROTH|S_IWOTH|S_IXOTH);
441 * Return a pointer to the CitContext structure bound to the thread which
442 * called this function. If there's no such binding (for example, if it's
443 * called by the housekeeper thread) then a generic 'master' CC is returned.
445 * This function is used *VERY* frequently and must be kept small.
447 struct CitContext *MyContext(void) {
449 register struct CitContext *c;
451 return ((c = (struct CitContext *) citthread_getspecific(MyConKey),
452 c == NULL) ? &masterCC : c
458 * Initialize a new context and place it in the list. The session number
459 * used to be the PID (which is why it's called cs_pid), but that was when we
460 * had one process per session. Now we just assign them sequentially, starting
461 * at 1 (don't change it to 0 because masterCC uses 0).
463 struct CitContext *CreateNewContext(void) {
464 struct CitContext *me;
465 static int next_pid = 0;
467 me = (struct CitContext *) malloc(sizeof(struct CitContext));
469 CtdlLogPrintf(CTDL_ALERT, "citserver: can't allocate memory!!\n");
473 memset(me, 0, sizeof(struct CitContext));
475 /* Give the contaxt a name. Hopefully makes it easier to track */
476 strcpy (me->user.fullname, "SYS_notauth");
478 /* The new context will be created already in the CON_EXECUTING state
479 * in order to prevent another thread from grabbing it while it's
482 me->state = CON_EXECUTING;
484 * Generate a unique session number and insert this context into
487 begin_critical_section(S_SESSION_TABLE);
488 me->cs_pid = ++next_pid;
490 me->next = ContextList;
492 if (me->next != NULL) {
496 end_critical_section(S_SESSION_TABLE);
501 struct CitContext *CtdlGetContextArray(int *count)
504 struct CitContext *nptr, *cptr;
506 nContexts = num_sessions;
507 nptr = malloc(sizeof(struct CitContext) * nContexts);
510 begin_critical_section(S_SESSION_TABLE);
511 for (cptr = ContextList, i=0; cptr != NULL && i < nContexts; cptr = cptr->next, i++)
512 memcpy(&nptr[i], cptr, sizeof (struct CitContext));
513 end_critical_section (S_SESSION_TABLE);
522 * This function fills in a context and its user field correctly
523 * Then creates/loads that user
525 void CtdlFillSystemContext(struct CitContext *context, char *name)
527 char sysname[USERNAME_SIZE];
529 memset(context, 0, sizeof(struct CitContext));
530 context->internal_pgm = 1;
532 strcpy (sysname, "SYS_");
533 strcat (sysname, name);
534 /* internal_create_user has the side effect of loading the user regardless of wether they
535 * already existed or needed to be created
537 internal_create_user (sysname, &(context->user), -1) ;
539 /* Check to see if the system user needs upgrading */
540 if (context->user.usernum == 0)
541 { /* old system user with number 0, upgrade it */
542 context->user.usernum = get_new_user_number();
543 CtdlLogPrintf(CTDL_DEBUG, "Upgrading system user \"%s\" from user number 0 to user number %d\n", context->user.fullname, context->user.usernum);
544 /* add user to the database */
545 putuser(&(context->user));
546 cdb_store(CDB_USERSBYNUMBER, &(context->user.usernum), sizeof(long), context->user.fullname, strlen(context->user.fullname)+1);
551 * The following functions implement output buffering. If the kernel supplies
552 * native TCP buffering (Linux & *BSD), use that; otherwise, emulate it with
553 * user-space buffering.
557 # define HAVE_TCP_BUFFERING
560 # define HAVE_TCP_BUFFERING
561 # define TCP_CORK TCP_NOPUSH
563 #endif /* TCP_CORK */
564 #endif /* HAVE_DARWIN */
566 #ifdef HAVE_TCP_BUFFERING
567 static unsigned on = 1, off = 0;
568 void buffer_output(void) {
569 struct CitContext *ctx = MyContext();
570 setsockopt(ctx->client_socket, IPPROTO_TCP, TCP_CORK, &on, 4);
574 void unbuffer_output(void) {
575 struct CitContext *ctx = MyContext();
576 setsockopt(ctx->client_socket, IPPROTO_TCP, TCP_CORK, &off, 4);
580 void flush_output(void) {
581 struct CitContext *ctx = MyContext();
582 setsockopt(ctx->client_socket, IPPROTO_TCP, TCP_CORK, &off, 4);
583 setsockopt(ctx->client_socket, IPPROTO_TCP, TCP_CORK, &on, 4);
587 /* Stub functions for Darwin/OS X where TCP buffering isn't liked at all */
588 void buffer_output(void) {
591 void unbuffer_output(void) {
594 void flush_output(void) {
597 void buffer_output(void) {
598 if (CC->buffering == 0) {
601 CC->output_buffer = malloc(SIZ);
605 void flush_output(void) {
606 if (CC->buffering == 1) {
607 client_write(CC->output_buffer, CC->buffer_len);
612 void unbuffer_output(void) {
613 if (CC->buffering == 1) {
615 /* We don't call flush_output because we can't. */
616 client_write(CC->output_buffer, CC->buffer_len);
618 free(CC->output_buffer);
619 CC->output_buffer = NULL;
622 #endif /* HAVE_DARWIN */
623 #endif /* HAVE_TCP_BUFFERING */
628 * client_write() ... Send binary data to the client.
630 int client_write(char *buf, int nbytes)
632 int bytes_written = 0;
634 #ifndef HAVE_TCP_BUFFERING
635 int old_buffer_len = 0;
642 if (Ctx->redirect_buffer != NULL) {
643 if ((Ctx->redirect_len + nbytes + 2) >= Ctx->redirect_alloc) {
644 Ctx->redirect_alloc = (Ctx->redirect_alloc * 2) + nbytes;
645 Ctx->redirect_buffer = realloc(Ctx->redirect_buffer,
646 Ctx->redirect_alloc);
648 memcpy(&Ctx->redirect_buffer[Ctx->redirect_len], buf, nbytes);
649 Ctx->redirect_len += nbytes;
650 Ctx->redirect_buffer[Ctx->redirect_len] = 0;
654 #ifndef HAVE_TCP_BUFFERING
655 /* If we're buffering for later, do that now. */
656 if (Ctx->buffering) {
657 old_buffer_len = Ctx->buffer_len;
658 Ctx->buffer_len += nbytes;
659 Ctx->output_buffer = realloc(Ctx->output_buffer, Ctx->buffer_len);
660 memcpy(&Ctx->output_buffer[old_buffer_len], buf, nbytes);
665 /* Ok, at this point we're not buffering. Go ahead and write. */
668 if (Ctx->redirect_ssl) {
669 client_write_ssl(buf, nbytes);
674 fdflags = fcntl(Ctx->client_socket, F_GETFL);
676 while (bytes_written < nbytes) {
677 if ((fdflags & O_NONBLOCK) == O_NONBLOCK) {
679 FD_SET(Ctx->client_socket, &wset);
680 if (select(1, NULL, &wset, NULL, NULL) == -1) {
681 CtdlLogPrintf(CTDL_ERR,
682 "client_write(%d bytes) select failed: %s (%d)\n",
683 nbytes - bytes_written,
684 strerror(errno), errno);
691 retval = write(Ctx->client_socket, &buf[bytes_written],
692 nbytes - bytes_written);
694 CtdlLogPrintf(CTDL_ERR,
695 "client_write(%d bytes) failed: %s (%d)\n",
696 nbytes - bytes_written,
697 strerror(errno), errno);
699 // CtdlLogPrintf(CTDL_DEBUG, "Tried to send: %s", &buf[bytes_written]);
703 bytes_written = bytes_written + retval;
710 * cprintf() ... Send formatted printable data to the client. It is
711 * implemented in terms of client_write() but remains in
712 * sysdep.c in case we port to somewhere without va_args...
714 void cprintf(const char *format, ...) {
718 va_start(arg_ptr, format);
719 if (vsnprintf(buf, sizeof buf, format, arg_ptr) == -1)
720 buf[sizeof buf - 2] = '\n';
721 client_write(buf, strlen(buf));
727 * Read data from the client socket.
729 * 1 Requested number of bytes has been read.
730 * 0 Request timed out.
731 * -1 The socket is broken.
732 * If the socket breaks, the session will be terminated.
734 int client_read_to(char *buf, int bytes, int timeout)
743 if (CC->redirect_ssl) {
744 return (client_read_ssl(buf, bytes, timeout));
748 fd = CC->client_socket;
755 retval = select( (fd)+1,
756 &rfds, NULL, NULL, &tv);
761 CtdlLogPrintf(CTDL_DEBUG, "Interrupted select().\n");
767 if (FD_ISSET(fd, &rfds) == 0) {
771 rlen = read(fd, &buf[len], bytes-len);
773 /* The socket has been disconnected! */
783 * Read data from the client socket with default timeout.
784 * (This is implemented in terms of client_read_to() and could be
785 * justifiably moved out of sysdep.c)
787 INLINE int client_read(char *buf, int bytes)
789 return(client_read_to(buf, bytes, config.c_sleeping));
794 * client_getln() ... Get a LF-terminated line of text from the client.
795 * (This is implemented in terms of client_read() and could be
796 * justifiably moved out of sysdep.c)
798 int client_getln(char *buf, int bufsize)
802 /* Read one character at a time.
805 retval = client_read(&buf[i], 1);
806 if (retval != 1 || buf[i] == '\n' || i == (bufsize-1))
810 /* If we got a long line, discard characters until the newline.
812 if (i == (bufsize-1))
813 while (buf[i] != '\n' && retval == 1)
814 retval = client_read(&buf[i], 1);
816 /* Strip the trailing LF, and the trailing CR if present.
820 && ( (buf[i - 1]==13)
821 || ( buf[i - 1]==10)) ) {
825 if (retval < 0) safestrncpy(&buf[i], "000", bufsize - i);
831 * Cleanup any contexts that are left lying around
833 void context_cleanup(void)
835 struct CitContext *ptr = NULL;
836 struct CitContext *rem = NULL;
839 * Clean up the contexts.
840 * There are no threads so no critical_section stuff is needed.
844 /* We need to update the ContextList because some modules may want to itterate it
845 * Question is should we NULL it before iterating here or should we just keep updating it
846 * as we remove items?
848 * Answer is to NULL it first to prevent modules from doing any actions on the list at all
852 /* Remove the session from the active list */
856 CtdlLogPrintf(CTDL_DEBUG, "Purging session %d\n", ptr->cs_pid);
865 void close_masters (void)
867 struct ServiceFunctionHook *serviceptr;
870 * close all protocol master sockets
872 for (serviceptr = ServiceHookTable; serviceptr != NULL;
873 serviceptr = serviceptr->next ) {
875 if (serviceptr->tcp_port > 0)
877 CtdlLogPrintf(CTDL_INFO, "Closing listener on port %d\n",
878 serviceptr->tcp_port);
879 serviceptr->tcp_port = 0;
882 if (serviceptr->sockpath != NULL)
883 CtdlLogPrintf(CTDL_INFO, "Closing listener on '%s'\n",
884 serviceptr->sockpath);
886 close(serviceptr->msock);
887 /* If it's a Unix domain socket, remove the file. */
888 if (serviceptr->sockpath != NULL) {
889 unlink(serviceptr->sockpath);
890 serviceptr->sockpath = NULL;
897 * The system-dependent part of master_cleanup() - close the master socket.
899 void sysdep_master_cleanup(void) {
908 CtdlDestroyProtoHooks();
909 CtdlDestroyDeleteHooks();
910 CtdlDestroyXmsgHooks();
911 CtdlDestroyNetprocHooks();
912 CtdlDestroyUserHooks();
913 CtdlDestroyMessageHook();
914 CtdlDestroyCleanupHooks();
915 CtdlDestroyFixedOutputHooks();
916 CtdlDestroySessionHooks();
917 CtdlDestroyServiceHook();
918 CtdlDestroyRoomHooks();
919 CtdlDestroyDirectoryServiceFuncs();
920 #ifdef HAVE_BACKTRACE
928 * Terminate another session.
929 * (This could justifiably be moved out of sysdep.c because it
930 * no longer does anything that is system-dependent.)
932 void kill_session(int session_to_kill) {
933 struct CitContext *ptr;
935 begin_critical_section(S_SESSION_TABLE);
936 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
937 if (ptr->cs_pid == session_to_kill) {
941 end_critical_section(S_SESSION_TABLE);
945 void graceful_shutdown(int signum) {
946 kill(current_child, signum);
947 unlink(file_pid_file);
953 * Start running as a daemon.
955 void start_daemon(int unused) {
963 /* Close stdin/stdout/stderr and replace them with /dev/null.
964 * We don't just call close() because we don't want these fd's
965 * to be reused for other files.
974 signal(SIGHUP, SIG_IGN);
975 signal(SIGINT, SIG_IGN);
976 signal(SIGQUIT, SIG_IGN);
980 freopen("/dev/null", "r", stdin);
981 freopen("/dev/null", "w", stdout);
982 freopen("/dev/null", "w", stderr);
985 current_child = fork();
987 signal(SIGTERM, graceful_shutdown);
989 if (current_child < 0) {
994 else if (current_child == 0) {
995 return; /* continue starting citadel. */
999 fp = fopen(file_pid_file, "w");
1001 fprintf(fp, ""F_PID_T"\n", getpid());
1004 waitpid(current_child, &status, 0);
1009 /* Did the main process exit with an actual exit code? */
1010 if (WIFEXITED(status)) {
1012 /* Exit code 0 means the watcher should exit */
1013 if (WEXITSTATUS(status) == 0) {
1017 /* Exit code 101-109 means the watcher should exit */
1018 else if ( (WEXITSTATUS(status) >= 101) && (WEXITSTATUS(status) <= 109) ) {
1022 /* Any other exit code means we should restart. */
1028 /* Any other type of termination (signals, etc.) should also restart. */
1033 } while (do_restart);
1035 unlink(file_pid_file);
1036 exit(WEXITSTATUS(status));
1042 * Generic routine to convert a login name to a full name (gecos)
1043 * Returns nonzero if a conversion took place
1045 int convert_login(char NameToConvert[]) {
1049 pw = getpwnam(NameToConvert);
1054 strcpy(NameToConvert, pw->pw_gecos);
1055 for (a=0; a<strlen(NameToConvert); ++a) {
1056 if (NameToConvert[a] == ',') NameToConvert[a] = 0;
1063 * Purge all sessions which have the 'kill_me' flag set.
1064 * This function has code to prevent it from running more than once every
1065 * few seconds, because running it after every single unbind would waste a lot
1066 * of CPU time and keep the context list locked too much. To force it to run
1067 * anyway, set "force" to nonzero.
1069 void dead_session_purge(int force) {
1070 struct CitContext *ptr, *ptr2; /* general-purpose utility pointer */
1071 struct CitContext *rem = NULL; /* list of sessions to be destroyed */
1074 if ( (time(NULL) - last_purge) < 5 ) {
1075 return; /* Too soon, go away */
1080 if (try_critical_section(S_SESSION_TABLE))
1088 if ( (ptr2->state == CON_IDLE) && (ptr2->kill_me) ) {
1089 /* Remove the session from the active list */
1091 ptr2->prev->next = ptr2->next;
1094 ContextList = ptr2->next;
1097 ptr2->next->prev = ptr2->prev;
1101 /* And put it on our to-be-destroyed list */
1106 end_critical_section(S_SESSION_TABLE);
1108 /* Now that we no longer have the session list locked, we can take
1109 * our time and destroy any sessions on the to-be-killed list, which
1110 * is allocated privately on this thread's stack.
1112 while (rem != NULL) {
1113 CtdlLogPrintf(CTDL_DEBUG, "Purging session %d\n", rem->cs_pid);
1126 * masterCC is the context we use when not attached to a session. This
1127 * function initializes it.
1129 void InitializeMasterCC(void) {
1130 memset(&masterCC, 0, sizeof(struct CitContext));
1131 masterCC.internal_pgm = 1;
1132 masterCC.cs_pid = 0;
1139 * Bind a thread to a context. (It's inline merely to speed things up.)
1141 INLINE void become_session(struct CitContext *which_con) {
1142 citthread_setspecific(MyConKey, (void *)which_con );
1148 * This loop just keeps going and going and going...
1152 * This current implimentation of worker_thread creates a bottle neck in several situations
1153 * The first thing to remember is that a single thread can handle more than one connection at a time.
1154 * More threads mean less memory for the system to run in.
1155 * So for efficiency we want every thread to be doing something useful or waiting in the main loop for
1156 * something to happen anywhere.
1157 * This current implimentation requires worker threads to wait in other locations, after it has
1158 * been committed to a single connection which is very wasteful.
1159 * As an extreme case consider this:
1160 * A slow client connects and this slow client sends only one character each second.
1161 * With this current implimentation a single worker thread is dispatched to handle that connection
1162 * until such times as the client timeout expires, an error occurs on the socket or the client
1163 * completes its transmission.
1164 * THIS IS VERY BAD since that thread could have handled a read from many more clients in each one
1165 * second interval between chars.
1167 * It is my intention to re-write this code and the associated client_getln, client_read functions
1168 * to allow any thread to read data on behalf of any connection (context).
1169 * To do this I intend to have this main loop read chars into a buffer stored in the context.
1170 * Once the correct criteria for a full buffer is met then we will dispatch a thread to
1172 * This worker thread loop also needs to be able to handle binary data.
1175 void *worker_thread(void *arg) {
1178 struct CitContext *ptr;
1179 struct CitContext *bind_me = NULL;
1182 struct CitContext *con= NULL; /* Temporary context pointer */
1183 struct ServiceFunctionHook *serviceptr;
1184 int ssock; /* Descriptor for client socket */
1186 int force_purge = 0;
1190 while (!CtdlThreadCheckStop()) {
1192 /* make doubly sure we're not holding any stale db handles
1193 * which might cause a deadlock.
1195 cdb_check_handles();
1196 do_select: force_purge = 0;
1197 bind_me = NULL; /* Which session shall we handle? */
1199 /* Initialize the fdset. */
1203 begin_critical_section(S_SESSION_TABLE);
1204 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
1205 if (ptr->state == CON_IDLE) {
1206 FD_SET(ptr->client_socket, &readfds);
1207 if (ptr->client_socket > highest)
1208 highest = ptr->client_socket;
1210 if ((bind_me == NULL) && (ptr->state == CON_READY)) {
1212 ptr->state = CON_EXECUTING;
1215 end_critical_section(S_SESSION_TABLE);
1221 /* If we got this far, it means that there are no sessions
1222 * which a previous thread marked for attention, so we go
1223 * ahead and get ready to select().
1226 /* First, add the various master sockets to the fdset. */
1227 for (serviceptr = ServiceHookTable; serviceptr != NULL;
1228 serviceptr = serviceptr->next ) {
1229 m = serviceptr->msock;
1230 FD_SET(m, &readfds);
1236 if (!CtdlThreadCheckStop()) {
1237 tv.tv_sec = 1; /* wake up every second if no input */
1239 retval = CtdlThreadSelect(highest + 1, &readfds, NULL, NULL, &tv);
1244 /* Now figure out who made this select() unblock.
1245 * First, check for an error or exit condition.
1248 if (errno == EBADF) {
1249 CtdlLogPrintf(CTDL_NOTICE, "select() failed: (%s)\n",
1253 if (errno != EINTR) {
1254 CtdlLogPrintf(CTDL_EMERG, "Exiting (%s)\n", strerror(errno));
1255 CtdlThreadStopAll();
1257 CtdlLogPrintf(CTDL_DEBUG, "Interrupted CtdlThreadSelect.\n");
1258 if (CtdlThreadCheckStop()) return(NULL);
1262 else if(retval == 0) {
1263 if (CtdlThreadCheckStop()) return(NULL);
1266 /* Next, check to see if it's a new client connecting
1267 * on a master socket.
1269 else for (serviceptr = ServiceHookTable; serviceptr != NULL;
1270 serviceptr = serviceptr->next ) {
1272 if (FD_ISSET(serviceptr->msock, &readfds)) {
1273 ssock = accept(serviceptr->msock, NULL, 0);
1275 CtdlLogPrintf(CTDL_DEBUG,
1276 "New client socket %d\n",
1279 /* The master socket is non-blocking but the client
1280 * sockets need to be blocking, otherwise certain
1281 * operations barf on FreeBSD. Not a fatal error.
1283 if (fcntl(ssock, F_SETFL, 0) < 0) {
1284 CtdlLogPrintf(CTDL_EMERG,
1285 "citserver: Can't set socket to blocking: %s\n",
1289 /* New context will be created already
1290 * set up in the CON_EXECUTING state.
1292 con = CreateNewContext();
1294 /* Assign our new socket number to it. */
1295 con->client_socket = ssock;
1296 con->h_command_function =
1297 serviceptr->h_command_function;
1298 con->h_async_function =
1299 serviceptr->h_async_function;
1301 serviceptr->ServiceName;
1303 /* Determine whether it's a local socket */
1304 if (serviceptr->sockpath != NULL)
1305 con->is_local_socket = 1;
1307 /* Set the SO_REUSEADDR socket option */
1309 setsockopt(ssock, SOL_SOCKET,
1313 become_session(con);
1315 serviceptr->h_greeting_function();
1316 become_session(NULL);
1317 con->state = CON_IDLE;
1323 /* It must be a client socket. Find a context that has data
1324 * waiting on its socket *and* is in the CON_IDLE state. Any
1325 * active sockets other than our chosen one are marked as
1326 * CON_READY so the next thread that comes around can just bind
1327 * to one without having to select() again.
1329 begin_critical_section(S_SESSION_TABLE);
1330 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
1331 if ( (FD_ISSET(ptr->client_socket, &readfds))
1332 && (ptr->state != CON_EXECUTING) ) {
1333 ptr->input_waiting = 1;
1335 bind_me = ptr; /* I choose you! */
1336 bind_me->state = CON_EXECUTING;
1339 ptr->state = CON_READY;
1343 end_critical_section(S_SESSION_TABLE);
1346 /* We're bound to a session */
1347 if (bind_me != NULL) {
1348 become_session(bind_me);
1350 /* If the client has sent a command, execute it. */
1351 if (CC->input_waiting) {
1352 CC->h_command_function();
1353 CC->input_waiting = 0;
1356 /* If there are asynchronous messages waiting and the
1357 * client supports it, do those now */
1358 if ((CC->is_async) && (CC->async_waiting)
1359 && (CC->h_async_function != NULL)) {
1360 CC->h_async_function();
1361 CC->async_waiting = 0;
1364 force_purge = CC->kill_me;
1365 become_session(NULL);
1366 bind_me->state = CON_IDLE;
1369 dead_session_purge(force_purge);
1372 /* If control reaches this point, the server is shutting down */
1381 * Translate text facility name to syslog.h defined value.
1383 int SyslogFacility(char *name)
1392 { LOG_KERN, "kern" },
1393 { LOG_USER, "user" },
1394 { LOG_MAIL, "mail" },
1395 { LOG_DAEMON, "daemon" },
1396 { LOG_AUTH, "auth" },
1397 { LOG_SYSLOG, "syslog" },
1399 { LOG_NEWS, "news" },
1400 { LOG_UUCP, "uucp" },
1401 { LOG_LOCAL0, "local0" },
1402 { LOG_LOCAL1, "local1" },
1403 { LOG_LOCAL2, "local2" },
1404 { LOG_LOCAL3, "local3" },
1405 { LOG_LOCAL4, "local4" },
1406 { LOG_LOCAL5, "local5" },
1407 { LOG_LOCAL6, "local6" },
1408 { LOG_LOCAL7, "local7" },
1411 for(i = 0; facTbl[i].name != NULL; i++) {
1412 if(!strcasecmp(name, facTbl[i].name))
1413 return facTbl[i].facility;
1420 /********** MEM CHEQQER ***********/
1422 #ifdef DEBUG_MEMORY_LEAKS
1429 void *tracked_malloc(size_t size, char *file, int line) {
1430 struct igheap *thisheap;
1433 block = malloc(size);
1434 if (block == NULL) return(block);
1436 thisheap = malloc(sizeof(struct igheap));
1437 if (thisheap == NULL) {
1442 thisheap->block = block;
1443 strcpy(thisheap->file, file);
1444 thisheap->line = line;
1446 begin_critical_section(S_DEBUGMEMLEAKS);
1447 thisheap->next = igheap;
1449 end_critical_section(S_DEBUGMEMLEAKS);
1455 void *tracked_realloc(void *ptr, size_t size, char *file, int line) {
1456 struct igheap *thisheap;
1459 block = realloc(ptr, size);
1460 if (block == NULL) return(block);
1462 thisheap = malloc(sizeof(struct igheap));
1463 if (thisheap == NULL) {
1468 thisheap->block = block;
1469 strcpy(thisheap->file, file);
1470 thisheap->line = line;
1472 begin_critical_section(S_DEBUGMEMLEAKS);
1473 thisheap->next = igheap;
1475 end_critical_section(S_DEBUGMEMLEAKS);
1482 void tracked_free(void *ptr) {
1483 struct igheap *thisheap;
1484 struct igheap *trash;
1488 if (igheap == NULL) return;
1489 begin_critical_section(S_DEBUGMEMLEAKS);
1490 for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
1491 if (thisheap->next != NULL) {
1492 if (thisheap->next->block == ptr) {
1493 trash = thisheap->next;
1494 thisheap->next = thisheap->next->next;
1499 if (igheap->block == ptr) {
1501 igheap = igheap->next;
1504 end_critical_section(S_DEBUGMEMLEAKS);
1507 char *tracked_strdup(const char *s, char *file, int line) {
1510 if (s == NULL) return(NULL);
1511 ptr = tracked_malloc(strlen(s) + 1, file, line);
1512 if (ptr == NULL) return(NULL);
1513 strncpy(ptr, s, strlen(s));
1517 void dump_heap(void) {
1518 struct igheap *thisheap;
1520 for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
1521 CtdlLogPrintf(CTDL_CRIT, "UNFREED: %30s : %d\n",
1522 thisheap->file, thisheap->line);
1526 #endif /* DEBUG_MEMORY_LEAKS */