citadel/sysdep.c

   1 /*
   2  * $Id$
   3  *
   4  * Citadel "system dependent" stuff.
   5  * See copyright.txt for copyright information.
   6  *
   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.
   9  *
  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.
  12  *
  13  */
  14
  15 #include "sysdep.h"
  16 #include <stdlib.h>
  17 #include <unistd.h>
  18 #include <stdio.h>
  19 #include <fcntl.h>
  20 #include <ctype.h>
  21 #include <signal.h>
  22 #include <sys/types.h>
  23 #include <sys/stat.h>
  24 #include <sys/wait.h>
  25 #include <sys/socket.h>
  26 #include <syslog.h>
  27 #include <sys/syslog.h>
  28
  29 #if TIME_WITH_SYS_TIME
  30 # include <sys/time.h>
  31 # include <time.h>
  32 #else
  33 # if HAVE_SYS_TIME_H
  34 #  include <sys/time.h>
  35 # else
  36 #  include <time.h>
  37 # endif
  38 #endif
  39
  40 #include <limits.h>
  41 #include <sys/resource.h>
  42 #include <netinet/in.h>
  43 #include <netinet/tcp.h>
  44 #include <arpa/inet.h>
  45 #include <netdb.h>
  46 #include <sys/un.h>
  47 #include <string.h>
  48 #include <pwd.h>
  49 #include <errno.h>
  50 #include <stdarg.h>
  51 #include <grp.h>
  52 #ifdef HAVE_PTHREAD_H
  53 #include <pthread.h>
  54 #endif
  55 #include <libcitadel.h>
  56 #include "citadel.h"
  57 #include "server.h"
  58 #include "sysdep_decls.h"
  59 #include "citserver.h"
  60 #include "support.h"
  61 #include "config.h"
  62 #include "database.h"
  63 #include "housekeeping.h"
  64 #include "modules/crypto/serv_crypto.h" /* Needed for init_ssl, client_write_ssl, client_read_ssl, destruct_ssl */
  65 #include "ecrash.h"
  66
  67 #ifdef HAVE_SYS_SELECT_H
  68 #include <sys/select.h>
  69 #endif
  70
  71 #ifndef HAVE_SNPRINTF
  72 #include "snprintf.h"
  73 #endif
  74
  75 #include "ctdl_module.h"
  76
  77 #ifdef DEBUG_MEMORY_LEAKS
  78 struct igheap {
  79         struct igheap *next;
  80         char file[32];
  81         int line;
  82         void *block;
  83 };
  84
  85 struct igheap *igheap = NULL;
  86 #endif
  87
  88
  89 pthread_mutex_t Critters[MAX_SEMAPHORES];       /* Things needing locking */
  90 pthread_key_t MyConKey;                         /* TSD key for MyContext() */
  91
  92 int verbosity = DEFAULT_VERBOSITY;              /* Logging level */
  93
  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 */
  99
 100 int syslog_facility = LOG_DAEMON;
 101 int enable_syslog = 0;
 102
 103
 104 /*
 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
 107  */
 108
 109 void CtdlLogPrintf(enum LogLevel loglevel, const char *format, ...)
 110 {
 111         va_list arg_ptr;
 112         va_start(arg_ptr, format);
 113         vlprintf(loglevel, format, arg_ptr);
 114         va_end(arg_ptr);
 115 }
 116
 117
 118 /*
 119  * lprintf()  ...   Write logging information
 120  */
 121 void lprintf(enum LogLevel loglevel, const char *format, ...) {
 122         va_list arg_ptr;
 123         va_start(arg_ptr, format);
 124         vlprintf(loglevel, format, arg_ptr);
 125         va_end(arg_ptr);
 126 }
 127
 128 void vlprintf(enum LogLevel loglevel, const char *format, va_list arg_ptr)
 129 {
 130         char buf[SIZ], buf2[SIZ];
 131
 132         if (enable_syslog) {
 133                 vsyslog((syslog_facility | loglevel), format, arg_ptr);
 134         }
 135
 136         /* stderr output code */
 137         if (enable_syslog || running_as_daemon) return;
 138
 139         /* if we run in forground and syslog is disabled, log to terminal */
 140         if (loglevel <= verbosity) {
 141                 struct timeval tv;
 142                 struct tm tim;
 143                 time_t unixtime;
 144
 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) {
 150                         sprintf(buf,
 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,
 155                                 CC->cs_pid);
 156                 } else {
 157                         sprintf(buf,
 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);
 162                 }
 163                 vsprintf(buf2, format, arg_ptr);
 164
 165                 fprintf(stderr, "%s%s", buf, buf2);
 166                 fflush(stderr);
 167         }
 168 }
 169
 170
 171
 172 /*
 173  * Signal handler to shut down the server.
 174  */
 175
 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;
 180
 181 static RETSIGTYPE signal_cleanup(int signum) {
 182         CtdlLogPrintf(CTDL_DEBUG, "Caught signal %d; shutting down.\n", signum);
 183         CtdlThreadStopAll();
 184         exit_signal = signum;
 185 }
 186
 187
 188
 189
 190 void InitialiseSemaphores(void)
 191 {
 192         int i;
 193
 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);
 197         }
 198 }
 199
 200
 201
 202 /*
 203  * Some initialization stuff...
 204  */
 205 void init_sysdep(void) {
 206         sigset_t set;
 207
 208         /* Avoid vulnerabilities related to FD_SETSIZE if we can. */
 209 #ifdef FD_SETSIZE
 210 #ifdef RLIMIT_NOFILE
 211         struct rlimit rl;
 212         getrlimit(RLIMIT_NOFILE, &rl);
 213         rl.rlim_cur = FD_SETSIZE;
 214         rl.rlim_max = FD_SETSIZE;
 215         setrlimit(RLIMIT_NOFILE, &rl);
 216 #endif
 217 #endif
 218
 219         /* If we've got OpenSSL, we're going to use it. */
 220 #ifdef HAVE_OPENSSL
 221         init_ssl();
 222 #endif
 223
 224         /*
 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.
 229          */
 230         if (pthread_key_create(&MyConKey, NULL) != 0) {
 231                 CtdlLogPrintf(CTDL_CRIT, "Can't create TSD key: %s\n",
 232                         strerror(errno));
 233         }
 234
 235         /*
 236          * The action for unexpected signals and exceptions should be to
 237          * call signal_cleanup() to gracefully shut down the server.
 238          */
 239         sigemptyset(&set);
 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);
 248
 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);
 256
 257         /*
 258          * Do not shut down the server on broken pipe signals, otherwise the
 259          * whole Citadel service would come down whenever a single client
 260          * socket breaks.
 261          */
 262         //signal(SIGPIPE, SIG_IGN);
 263         signal(SIGPIPE, signal_cleanup);
 264 }
 265
 266
 267 /*
 268  * Obtain a semaphore lock to begin a critical section.
 269  */
 270 void begin_critical_section(int which_one)
 271 {
 272         /* CtdlLogPrintf(CTDL_DEBUG, "begin_critical_section(%d)\n", which_one); */
 273
 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.
 277          */
 278         if (    (which_one != S_FLOORCACHE)
 279 #ifdef DEBUG_MEMORY_LEAKS
 280                 && (which_one != S_DEBUGMEMLEAKS)
 281 #endif
 282                 && (which_one != S_RPLIST)
 283         ) {
 284                 cdb_check_handles();
 285         }
 286         pthread_mutex_lock(&Critters[which_one]);
 287 }
 288
 289 /*
 290  * Release a semaphore lock to end a critical section.
 291  */
 292 void end_critical_section(int which_one)
 293 {
 294         pthread_mutex_unlock(&Critters[which_one]);
 295 }
 296
 297
 298
 299 /*
 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.
 302  *
 303  */
 304 int ig_tcp_server(char *ip_addr, int port_number, int queue_len, char **errormessage)
 305 {
 306         struct sockaddr_in sin;
 307         int s, i;
 308         int actual_queue_len;
 309
 310         actual_queue_len = queue_len;
 311         if (actual_queue_len < 5) actual_queue_len = 5;
 312
 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;
 318         }
 319         else {
 320                 sin.sin_addr.s_addr = inet_addr(ip_addr);
 321         }
 322
 323         if (sin.sin_addr.s_addr == !INADDR_ANY) {
 324                 sin.sin_addr.s_addr = INADDR_ANY;
 325         }
 326
 327         s = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP);
 328
 329         if (s < 0) {
 330                 *errormessage = (char*) malloc(SIZ + 1);
 331                 snprintf(*errormessage, SIZ,
 332                                  "citserver: Can't create a socket: %s",
 333                                  strerror(errno));
 334                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
 335                 return(-1);
 336         }
 337
 338         i = 1;
 339         setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
 340
 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",
 345                                  strerror(errno));
 346                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
 347                 close(s);
 348                 return(-1);
 349         }
 350
 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",
 356                                  strerror(errno));
 357                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
 358                 close(s);
 359                 return(-1);
 360         }
 361
 362         if (listen(s, actual_queue_len) < 0) {
 363                 *errormessage = (char*) malloc(SIZ + 1);
 364                 snprintf(*errormessage, SIZ,
 365                                  "citserver: Can't listen: %s",
 366                                  strerror(errno));
 367                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
 368                 close(s);
 369                 return(-1);
 370         }
 371
 372         return(s);
 373 }
 374
 375
 376
 377 /*
 378  * Create a Unix domain socket and listen on it
 379  */
 380 int ig_uds_server(char *sockpath, int queue_len, char **errormessage)
 381 {
 382         struct sockaddr_un addr;
 383         int s;
 384         int i;
 385         int actual_queue_len;
 386
 387         actual_queue_len = queue_len;
 388         if (actual_queue_len < 5) actual_queue_len = 5;
 389
 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);
 396                 return(-1);
 397         }
 398
 399         memset(&addr, 0, sizeof(addr));
 400         addr.sun_family = AF_UNIX;
 401         safestrncpy(addr.sun_path, sockpath, sizeof addr.sun_path);
 402
 403         s = socket(AF_UNIX, SOCK_STREAM, 0);
 404         if (s < 0) {
 405                 *errormessage = (char*) malloc(SIZ + 1);
 406                 snprintf(*errormessage, SIZ,
 407                          "citserver: Can't create a socket: %s",
 408                          strerror(errno));
 409                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
 410                 return(-1);
 411         }
 412
 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",
 417                          strerror(errno));
 418                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
 419                 return(-1);
 420         }
 421
 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",
 427                          strerror(errno));
 428                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
 429                 close(s);
 430                 return(-1);
 431         }
 432
 433         if (listen(s, actual_queue_len) < 0) {
 434                 *errormessage = (char*) malloc(SIZ + 1);
 435                 snprintf(*errormessage, SIZ,
 436                          "citserver: Can't listen: %s",
 437                          strerror(errno));
 438                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
 439                 return(-1);
 440         }
 441
 442         chmod(sockpath, S_ISGID|S_IRUSR|S_IWUSR|S_IXUSR|S_IRGRP|S_IWGRP|S_IXGRP|S_IROTH|S_IWOTH|S_IXOTH);
 443         return(s);
 444 }
 445
 446
 447
 448 /*
 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.
 452  *
 453  * This function is used *VERY* frequently and must be kept small.
 454  */
 455 struct CitContext *MyContext(void) {
 456
 457         register struct CitContext *c;
 458
 459         return ((c = (struct CitContext *) pthread_getspecific(MyConKey),
 460                 c == NULL) ? &masterCC : c
 461         );
 462 }
 463
 464
 465 /*
 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).
 470  */
 471 struct CitContext *CreateNewContext(void) {
 472         struct CitContext *me;
 473         static int next_pid = 0;
 474
 475         me = (struct CitContext *) malloc(sizeof(struct CitContext));
 476         if (me == NULL) {
 477                 CtdlLogPrintf(CTDL_ALERT, "citserver: can't allocate memory!!\n");
 478                 return NULL;
 479         }
 480         memset(me, 0, sizeof(struct CitContext));
 481
 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
 484          * being set up.
 485          */
 486         me->state = CON_EXECUTING;
 487
 488         /*
 489          * Generate a unique session number and insert this context into
 490          * the list.
 491          */
 492         begin_critical_section(S_SESSION_TABLE);
 493         me->cs_pid = ++next_pid;
 494         me->prev = NULL;
 495         me->next = ContextList;
 496         ContextList = me;
 497         if (me->next != NULL) {
 498                 me->next->prev = me;
 499         }
 500         ++num_sessions;
 501         end_critical_section(S_SESSION_TABLE);
 502         return(me);
 503 }
 504
 505
 506 /*
 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.
 510  */
 511 #ifndef HAVE_DARWIN
 512 #ifdef TCP_CORK
 513 #       define HAVE_TCP_BUFFERING
 514 #else
 515 #       ifdef TCP_NOPUSH
 516 #               define HAVE_TCP_BUFFERING
 517 #               define TCP_CORK TCP_NOPUSH
 518 #       endif
 519 #endif /* TCP_CORK */
 520 #endif /* HAVE_DARWIN */
 521
 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);
 527         ctx->buffering = 1;
 528 }
 529
 530 void unbuffer_output(void) {
 531         struct CitContext *ctx = MyContext();
 532         setsockopt(ctx->client_socket, IPPROTO_TCP, TCP_CORK, &off, 4);
 533         ctx->buffering = 0;
 534 }
 535
 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);
 540 }
 541 #else
 542 #ifdef HAVE_DARWIN
 543 /* Stub functions for Darwin/OS X where TCP buffering isn't liked at all */
 544 void buffer_output(void) {
 545         CC->buffering = 0;
 546 }
 547 void unbuffer_output(void) {
 548         CC->buffering = 0;
 549 }
 550 void flush_output(void) {
 551 }
 552 #else
 553 void buffer_output(void) {
 554         if (CC->buffering == 0) {
 555                 CC->buffering = 1;
 556                 CC->buffer_len = 0;
 557                 CC->output_buffer = malloc(SIZ);
 558         }
 559 }
 560
 561 void flush_output(void) {
 562         if (CC->buffering == 1) {
 563                 client_write(CC->output_buffer, CC->buffer_len);
 564                 CC->buffer_len = 0;
 565         }
 566 }
 567
 568 void unbuffer_output(void) {
 569         if (CC->buffering == 1) {
 570                 CC->buffering = 0;
 571                 /* We don't call flush_output because we can't. */
 572                 client_write(CC->output_buffer, CC->buffer_len);
 573                 CC->buffer_len = 0;
 574                 free(CC->output_buffer);
 575                 CC->output_buffer = NULL;
 576         }
 577 }
 578 #endif /* HAVE_DARWIN */
 579 #endif /* HAVE_TCP_BUFFERING */
 580
 581
 582
 583 /*
 584  * client_write()   ...    Send binary data to the client.
 585  */
 586 void client_write(char *buf, int nbytes)
 587 {
 588         int bytes_written = 0;
 589         int retval;
 590 #ifndef HAVE_TCP_BUFFERING
 591         int old_buffer_len = 0;
 592 #endif
 593         t_context *Ctx;
 594
 595         Ctx = CC;
 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);
 601                 }
 602                 memcpy(&Ctx->redirect_buffer[Ctx->redirect_len], buf, nbytes);
 603                 Ctx->redirect_len += nbytes;
 604                 Ctx->redirect_buffer[Ctx->redirect_len] = 0;
 605                 return;
 606         }
 607
 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);
 615                 return;
 616         }
 617 #endif
 618
 619         /* Ok, at this point we're not buffering.  Go ahead and write. */
 620
 621 #ifdef HAVE_OPENSSL
 622         if (Ctx->redirect_ssl) {
 623                 client_write_ssl(buf, nbytes);
 624                 return;
 625         }
 626 #endif
 627
 628         while (bytes_written < nbytes) {
 629                 retval = write(Ctx->client_socket, &buf[bytes_written],
 630                         nbytes - bytes_written);
 631                 if (retval < 1) {
 632                         CtdlLogPrintf(CTDL_ERR,
 633                                 "client_write(%d bytes) failed: %s (%d)\n",
 634                                 nbytes - bytes_written,
 635                                 strerror(errno), errno);
 636                         cit_backtrace();
 637                         // CtdlLogPrintf(CTDL_DEBUG, "Tried to send: %s",  &buf[bytes_written]);
 638                         Ctx->kill_me = 1;
 639                         return;
 640                 }
 641                 bytes_written = bytes_written + retval;
 642         }
 643 }
 644
 645
 646 /*
 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...
 650  */
 651 void cprintf(const char *format, ...) {
 652         va_list arg_ptr;
 653         char buf[1024];
 654
 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));
 659         va_end(arg_ptr);
 660 }
 661
 662
 663 /*
 664  * Read data from the client socket.
 665  * Return values are:
 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.
 670  */
 671 int client_read_to(char *buf, int bytes, int timeout)
 672 {
 673         int len,rlen;
 674         fd_set rfds;
 675         int fd;
 676         struct timeval tv;
 677         int retval;
 678
 679 #ifdef HAVE_OPENSSL
 680         if (CC->redirect_ssl) {
 681                 return (client_read_ssl(buf, bytes, timeout));
 682         }
 683 #endif
 684         len = 0;
 685         fd = CC->client_socket;
 686         while(len<bytes) {
 687                 FD_ZERO(&rfds);
 688                 FD_SET(fd, &rfds);
 689                 tv.tv_sec = timeout;
 690                 tv.tv_usec = 0;
 691
 692                 retval = select( (fd)+1,
 693                                  &rfds, NULL, NULL, &tv);
 694
 695                 if (FD_ISSET(fd, &rfds) == 0) {
 696                         return(0);
 697                 }
 698
 699                 rlen = read(fd, &buf[len], bytes-len);
 700                 if (rlen<1) {
 701                         /* The socket has been disconnected! */
 702                         CC->kill_me = 1;
 703                         return(-1);
 704                 }
 705                 len = len + rlen;
 706         }
 707         return(1);
 708 }
 709
 710 /*
 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)
 714  */
 715 INLINE int client_read(char *buf, int bytes)
 716 {
 717         return(client_read_to(buf, bytes, config.c_sleeping));
 718 }
 719
 720
 721 /*
 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)
 725  */
 726 int client_getln(char *buf, int bufsize)
 727 {
 728         int i, retval;
 729
 730         /* Read one character at a time.
 731          */
 732         for (i = 0;;i++) {
 733                 retval = client_read(&buf[i], 1);
 734                 if (retval != 1 || buf[i] == '\n' || i == (bufsize-1))
 735                         break;
 736         }
 737
 738         /* If we got a long line, discard characters until the newline.
 739          */
 740         if (i == (bufsize-1))
 741                 while (buf[i] != '\n' && retval == 1)
 742                         retval = client_read(&buf[i], 1);
 743
 744         /* Strip the trailing LF, and the trailing CR if present.
 745          */
 746         buf[i] = 0;
 747         while ( (i > 0)
 748                 && ( (buf[i - 1]==13)
 749                      || ( buf[i - 1]==10)) ) {
 750                 i--;
 751                 buf[i] = 0;
 752         }
 753         if (retval < 0) safestrncpy(&buf[i], "000", bufsize - i);
 754         return(retval);
 755 }
 756
 757
 758 /*
 759  * Cleanup any contexts that are left lying around
 760  */
 761 void context_cleanup(void)
 762 {
 763         struct CitContext *ptr = NULL;
 764         struct CitContext *rem = NULL;
 765
 766         /*
 767          * Clean up the contexts.
 768          * There are no threads so no critical_section stuff is needed.
 769          */
 770         ptr = ContextList;
 771         while (ptr != NULL){
 772                 /* Remove the session from the active list */
 773                 rem = ptr->next;
 774                 --num_sessions;
 775
 776                 lprintf(CTDL_DEBUG, "Purging session %d\n", ptr->cs_pid);
 777                 RemoveContext(ptr);
 778                 free (ptr);
 779                 ptr = rem;
 780         }
 781
 782 }
 783
 784
 785 /*
 786  * The system-dependent part of master_cleanup() - close the master socket.
 787  */
 788 void sysdep_master_cleanup(void) {
 789         struct ServiceFunctionHook *serviceptr;
 790
 791         /*
 792          * close all protocol master sockets
 793          */
 794         for (serviceptr = ServiceHookTable; serviceptr != NULL;
 795             serviceptr = serviceptr->next ) {
 796
 797                 if (serviceptr->tcp_port > 0)
 798                         CtdlLogPrintf(CTDL_INFO, "Closing listener on port %d\n",
 799                                 serviceptr->tcp_port);
 800
 801                 if (serviceptr->sockpath != NULL)
 802                         CtdlLogPrintf(CTDL_INFO, "Closing listener on '%s'\n",
 803                                 serviceptr->sockpath);
 804
 805                 close(serviceptr->msock);
 806
 807                 /* If it's a Unix domain socket, remove the file. */
 808                 if (serviceptr->sockpath != NULL) {
 809                         unlink(serviceptr->sockpath);
 810                 }
 811         }
 812
 813         context_cleanup();
 814
 815 #ifdef HAVE_OPENSSL
 816         destruct_ssl();
 817 #endif
 818         CtdlDestroyProtoHooks();
 819         CtdlDestroyDeleteHooks();
 820         CtdlDestroyXmsgHooks();
 821         CtdlDestroyNetprocHooks();
 822         CtdlDestroyUserHooks();
 823         CtdlDestroyMessageHook();
 824         CtdlDestroyCleanupHooks();
 825         CtdlDestroyFixedOutputHooks();
 826         CtdlDestroySessionHooks();
 827         CtdlDestroyServiceHook();
 828         #ifdef HAVE_BACKTRACE
 829         eCrash_Uninit();
 830         #endif
 831 }
 832
 833
 834
 835 /*
 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.)
 839  */
 840 void kill_session(int session_to_kill) {
 841         struct CitContext *ptr;
 842
 843         begin_critical_section(S_SESSION_TABLE);
 844         for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
 845                 if (ptr->cs_pid == session_to_kill) {
 846                         ptr->kill_me = 1;
 847                 }
 848         }
 849         end_critical_section(S_SESSION_TABLE);
 850 }
 851
 852 pid_t current_child;
 853 void graceful_shutdown(int signum) {
 854         kill(current_child, signum);
 855         unlink(file_pid_file);
 856         exit(0);
 857 }
 858
 859
 860 /*
 861  * Start running as a daemon.
 862  */
 863 void start_daemon(int unused) {
 864         int status = 0;
 865         pid_t child = 0;
 866         FILE *fp;
 867         int do_restart = 0;
 868
 869         current_child = 0;
 870
 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.
 874          */
 875         chdir(ctdl_run_dir);
 876
 877         child = fork();
 878         if (child != 0) {
 879                 exit(0);
 880         }
 881
 882         signal(SIGHUP, SIG_IGN);
 883         signal(SIGINT, SIG_IGN);
 884         signal(SIGQUIT, SIG_IGN);
 885
 886         setsid();
 887         umask(0);
 888         freopen("/dev/null", "r", stdin);
 889         freopen("/dev/null", "w", stdout);
 890         freopen("/dev/null", "w", stderr);
 891
 892         do {
 893                 current_child = fork();
 894
 895                 signal(SIGTERM, graceful_shutdown);
 896
 897                 if (current_child < 0) {
 898                         perror("fork");
 899                         exit(errno);
 900                 }
 901
 902                 else if (current_child == 0) {
 903                         return; /* continue starting citadel. */
 904                 }
 905
 906                 else {
 907                         fp = fopen(file_pid_file, "w");
 908                         if (fp != NULL) {
 909                 /*
 910                  * NB.. The pid file contains the pid of the actual server.
 911                  * This is not the pid of the watcher process
 912                  */
 913                                 fprintf(fp, ""F_PID_T"\n", current_child);
 914                                 fclose(fp);
 915                         }
 916                         waitpid(current_child, &status, 0);
 917                 }
 918
 919                 do_restart = 0;
 920
 921                 /* Did the main process exit with an actual exit code? */
 922                 if (WIFEXITED(status)) {
 923
 924                         /* Exit code 0 means the watcher should exit */
 925                         if (WEXITSTATUS(status) == 0) {
 926                                 do_restart = 0;
 927                         }
 928
 929                         /* Exit code 101-109 means the watcher should exit */
 930                         else if ( (WEXITSTATUS(status) >= 101) && (WEXITSTATUS(status) <= 109) ) {
 931                                 do_restart = 0;
 932                         }
 933
 934                         /* Any other exit code means we should restart. */
 935                         else {
 936                                 do_restart = 1;
 937                         }
 938                 }
 939
 940                 /* Any other type of termination (signals, etc.) should also restart. */
 941                 else {
 942                         do_restart = 1;
 943                 }
 944
 945         } while (do_restart);
 946
 947         unlink(file_pid_file);
 948         exit(WEXITSTATUS(status));
 949 }
 950
 951
 952
 953 /*
 954  * Generic routine to convert a login name to a full name (gecos)
 955  * Returns nonzero if a conversion took place
 956  */
 957 int convert_login(char NameToConvert[]) {
 958         struct passwd *pw;
 959         int a;
 960
 961         pw = getpwnam(NameToConvert);
 962         if (pw == NULL) {
 963                 return(0);
 964         }
 965         else {
 966                 strcpy(NameToConvert, pw->pw_gecos);
 967                 for (a=0; a<strlen(NameToConvert); ++a) {
 968                         if (NameToConvert[a] == ',') NameToConvert[a] = 0;
 969                 }
 970                 return(1);
 971         }
 972 }
 973
 974
 975
 976 /*
 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;
 981  * pass in &node
 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
 989  */
 990
 991
 992 struct CtdlThreadNode *CtdlThreadList = NULL;
 993
 994 /*
 995  * Condition variable and Mutex for thread garbage collection
 996  */
 997 /*static pthread_mutex_t thread_gc_mutex = PTHREAD_MUTEX_INITIALIZER;
 998 static pthread_cond_t thread_gc_cond = PTHREAD_COND_INITIALIZER;
 999 */
1000 static pthread_t GC_thread;
1001 static char *CtdlThreadStates[CTDL_THREAD_LAST_STATE];
1002 double CtdlThreadLoadAvg = 0;
1003 double CtdlThreadWorkerAvg = 0;
1004 /*
1005  * Pinched the following bits regarding signals from Kannel.org
1006  */
1007
1008 /*
1009  * Change this thread's signal mask to block user-visible signals
1010  * (HUP, TERM, QUIT, INT), and store the old signal mask in
1011  * *old_set_storage.
1012  * Return 0 for success, or -1 if an error occurred.
1013  */
1014
1015  /*
1016   * This does not work in Darwin alias MacOS X alias Mach kernel,
1017   * however. So we define a dummy function doing nothing.
1018   */
1019 #if defined(DARWIN_OLD)
1020     static int pthread_sigmask();
1021 #endif
1022
1023 static int ctdl_thread_internal_block_signals(sigset_t *old_set_storage)
1024 {
1025     int ret;
1026     sigset_t block_signals;
1027
1028     ret = sigemptyset(&block_signals);
1029     if (ret != 0) {
1030         CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC. Couldn't initialize signal set\n");
1031             return -1;
1032     }
1033     ret = sigaddset(&block_signals, SIGHUP);
1034     ret |= sigaddset(&block_signals, SIGTERM);
1035     ret |= sigaddset(&block_signals, SIGQUIT);
1036     ret |= sigaddset(&block_signals, SIGINT);
1037     if (ret != 0) {
1038         CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC. Couldn't add signal to signal set.\n");
1039             return -1;
1040     }
1041     ret = pthread_sigmask(SIG_BLOCK, &block_signals, old_set_storage);
1042     if (ret != 0) {
1043         CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC. Couldn't disable signals for thread creation\n");
1044         return -1;
1045     }
1046     return 0;
1047 }
1048
1049 static void ctdl_thread_internal_restore_signals(sigset_t *old_set)
1050 {
1051     int ret;
1052
1053     ret = pthread_sigmask(SIG_SETMASK, old_set, NULL);
1054     if (ret != 0) {
1055         CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC. Couldn't restore signal set.\n");
1056     }
1057 }
1058
1059
1060 void ctdl_thread_internal_cleanup(void)
1061 {
1062         int i;
1063
1064         for (i=0; i<CTDL_THREAD_LAST_STATE; i++)
1065         {
1066                 free (CtdlThreadStates[i]);
1067         }
1068 }
1069
1070 void ctdl_thread_internal_init(void)
1071 {
1072         struct CtdlThreadNode *this_thread;
1073         int ret = 0;
1074
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");
1086
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");
1091                 return;
1092         }
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));
1095
1096         /* We are garbage collector so create us as running */
1097         this_thread->state = CTDL_THREAD_RUNNING;
1098
1099         if ((ret = pthread_attr_init(&this_thread->attr))) {
1100                 CtdlLogPrintf(CTDL_EMERG, "Thread system, pthread_attr_init: %s\n", strerror(ret));
1101                 free(this_thread);
1102                 return;
1103         }
1104
1105         this_thread->name = strdup("Garbage Collection Thread");
1106
1107         pthread_mutex_init (&(this_thread->ThreadMutex), NULL);
1108         pthread_cond_init (&(this_thread->ThreadCond), NULL);
1109
1110         this_thread->tid = GC_thread;
1111
1112         num_threads++;  // Increase the count of threads in the system.
1113
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. */
1121 }
1122
1123
1124 /*
1125  * A function to update a threads load averages
1126  */
1127  void ctdl_thread_internal_update_avgs(struct CtdlThreadNode *this_thread)
1128  {
1129         struct timeval now, result;
1130         double last_duration;
1131
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);
1145 }
1146
1147 /*
1148  * A function to chenge the state of a thread
1149  */
1150 void ctdl_thread_internal_change_state (struct CtdlThreadNode *this_thread, enum CtdlThreadState new_state)
1151 {
1152         /*
1153          * Wether we change state or not we need update the load values
1154          */
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);
1164 }
1165
1166
1167 /*
1168  * A function to tell all threads to exit
1169  */
1170 void CtdlThreadStopAll(void)
1171 {
1172         struct CtdlThreadNode *this_thread;
1173
1174         begin_critical_section(S_THREAD_LIST);
1175         this_thread = CtdlThreadList;
1176         while(this_thread)
1177         {
1178                 if (this_thread->thread_func) // Don't tell garbage collector to stop
1179                 {
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);
1183                 }
1184                 this_thread = this_thread->next;
1185         }
1186         end_critical_section(S_THREAD_LIST);
1187 }
1188
1189
1190 /*
1191  * A function to signal that we need to do garbage collection on the thread list
1192  */
1193 void CtdlThreadGC(void)
1194 {
1195         struct CtdlThreadNode *this_thread;
1196
1197         CtdlLogPrintf(CTDL_DEBUG, "Thread system signalling garbage collection.\n");
1198
1199         begin_critical_section(S_THREAD_LIST);
1200         this_thread = CtdlThreadList;
1201         while(this_thread)
1202         {
1203                 if (!this_thread->thread_func)
1204                         pthread_cond_signal(&this_thread->ThreadCond);
1205
1206                 this_thread = this_thread->next;
1207         }
1208         end_critical_section(S_THREAD_LIST);
1209 }
1210
1211
1212 /*
1213  * A function to return the number of threads running in the system
1214  */
1215 int CtdlThreadGetCount(void)
1216 {
1217         return num_threads;
1218 }
1219
1220 /*
1221  * A function to find the thread structure for this thread
1222  */
1223 struct CtdlThreadNode *CtdlThreadSelf(void)
1224 {
1225         pthread_t self_tid;
1226         struct CtdlThreadNode *this_thread;
1227
1228         self_tid = pthread_self();
1229
1230         begin_critical_section(S_THREAD_LIST);
1231         this_thread = CtdlThreadList;
1232         while(this_thread)
1233         {
1234                 if (pthread_equal(self_tid, this_thread->tid))
1235                 {
1236                         end_critical_section(S_THREAD_LIST);
1237                         return this_thread;
1238                 }
1239                 this_thread = this_thread->next;
1240         }
1241         end_critical_section(S_THREAD_LIST);
1242         return NULL;
1243 }
1244
1245
1246
1247
1248 /*
1249  * A function to rename a thread
1250  * Returns a char * and the caller owns the memory and should free it
1251  */
1252 char *CtdlThreadName(struct CtdlThreadNode *thread, char *name)
1253 {
1254         struct CtdlThreadNode *this_thread;
1255         char *old_name;
1256
1257         if (!thread)
1258                 this_thread = CtdlThreadSelf();
1259         else
1260                 this_thread = thread;
1261         if (!this_thread)
1262         {
1263                 CtdlLogPrintf(CTDL_WARNING, "Thread system WARNING. Attempt to CtdlThreadRename() a non thread.\n");
1264                 return NULL;
1265         }
1266         begin_critical_section(S_THREAD_LIST);
1267         if (name)
1268         {
1269                 old_name = this_thread->name;
1270                 this_thread->name = strdup (name);
1271                 free(old_name);
1272         }
1273         old_name = strdup(this_thread->name);
1274         end_critical_section (S_THREAD_LIST);
1275         return (old_name);
1276 }
1277
1278
1279 /*
1280  * A function to force a thread to exit
1281  */
1282 void CtdlThreadCancel(struct CtdlThreadNode *thread)
1283 {
1284         struct CtdlThreadNode *this_thread;
1285
1286         if (!thread)
1287                 this_thread = CtdlThreadSelf();
1288         else
1289                 this_thread = thread;
1290         if (!this_thread)
1291         {
1292                 CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC. Attempt to CtdlThreadCancel() a non thread.\n");
1293                 CtdlThreadStopAll();
1294                 return;
1295         }
1296
1297         if (!this_thread->thread_func)
1298         {
1299                 CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC. Attempt to CtdlThreadCancel() the garbage collector.\n");
1300                 CtdlThreadStopAll();
1301                 return;
1302         }
1303
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);
1308 }
1309
1310
1311
1312 /*
1313  * A function for a thread to check if it has been asked to stop
1314  */
1315 int CtdlThreadCheckStop(void)
1316 {
1317         struct CtdlThreadNode *this_thread;
1318
1319         this_thread = CtdlThreadSelf();
1320         if (!this_thread)
1321         {
1322                 CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC, CtdlThreadCheckStop() called by a non thread.\n");
1323                 CtdlThreadStopAll();
1324                 return -1;
1325         }
1326         if(this_thread->state == CTDL_THREAD_STOP_REQ)
1327         {
1328                 this_thread->state = CTDL_THREAD_STOPPING;
1329                 return -1;
1330         }
1331         else if(this_thread->state < CTDL_THREAD_STOP_REQ)
1332                 return -1;
1333
1334         return 0;
1335 }
1336
1337
1338 /*
1339  * A function to ask a thread to exit
1340  * The thread must call CtdlThreadCheckStop() periodically to determine if it should exit
1341  */
1342 void CtdlThreadStop(struct CtdlThreadNode *thread)
1343 {
1344         struct CtdlThreadNode *this_thread;
1345
1346         if (!thread)
1347                 this_thread = CtdlThreadSelf();
1348         else
1349                 this_thread = thread;
1350         if (!this_thread)
1351                 return;
1352         if (!(this_thread->thread_func))
1353                 return;         // Don't stop garbage collector
1354
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);
1359 }
1360
1361 /*
1362  * So we now have a sleep command that works with threads but it is in seconds
1363  */
1364 void CtdlThreadSleep(int secs)
1365 {
1366         struct timespec wake_time;
1367         struct timeval time_now;
1368         struct CtdlThreadNode *self;
1369
1370
1371         self = CtdlThreadSelf();
1372         if (!self)
1373         {
1374                 CtdlLogPrintf(CTDL_WARNING, "CtdlThreadSleep() called by something that is not a thread. Should we die?\n");
1375                 return;
1376         }
1377
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);
1382
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);
1392 }
1393
1394
1395 /*
1396  * Routine to clean up our thread function on exit
1397  */
1398 static void ctdl_internal_thread_cleanup(void *arg)
1399 {
1400         struct CtdlThreadNode *this_thread;
1401         this_thread = CtdlThreadSelf();
1402         /*
1403          * In here we were called by the current thread because it is exiting
1404          * NB. WE ARE THE CURRENT THREAD
1405          */
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();
1410         #endif
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);
1413 //      CtdlThreadGC();
1414 }
1415
1416 /*
1417  * A quick function to show the load averages
1418  */
1419 void ctdl_thread_internal_calc_loadavg(void)
1420 {
1421         struct CtdlThreadNode *that_thread;
1422         double load_avg, worker_avg;
1423         int workers = 0;
1424
1425         begin_critical_section(S_THREAD_LIST);
1426         that_thread = CtdlThreadList;
1427         load_avg = 0;
1428         worker_avg = 0;
1429         while(that_thread)
1430         {
1431                 /* Update load averages */
1432                 ctdl_thread_internal_update_avgs(that_thread);
1433                 pthread_mutex_lock(&that_thread->ThreadMutex);
1434                 that_thread->load_avg = that_thread->avg_sleeping + that_thread->avg_running + that_thread->avg_blocked;
1435                 that_thread->load_avg = that_thread->avg_running / that_thread->load_avg * 100;
1436                 that_thread->avg_sleeping /= 2;
1437                 that_thread->avg_running /= 2;
1438                 that_thread->avg_blocked /= 2;
1439                 load_avg += that_thread->load_avg;
1440                 if (that_thread->flags & CTDLTHREAD_WORKER)
1441                 {
1442                         worker_avg += that_thread->load_avg;
1443                         workers++;
1444                 }
1445                 CtdlLogPrintf(CTDL_DEBUG, "CtdlThread, \"%s\" (%ld) \"%s\" %f %f %f %f.\n",
1446                         that_thread->name,
1447                         that_thread->tid,
1448                         CtdlThreadStates[that_thread->state],
1449                         that_thread->avg_sleeping,
1450                         that_thread->avg_running,
1451                         that_thread->avg_blocked,
1452                         that_thread->load_avg);
1453
1454                 pthread_mutex_unlock(&that_thread->ThreadMutex);
1455                 that_thread = that_thread->next;
1456         }
1457         CtdlThreadLoadAvg = load_avg/num_threads;
1458         CtdlThreadWorkerAvg = worker_avg/workers;
1459         CtdlLogPrintf(CTDL_INFO, "System load average %f, workers averag %f\n", CtdlThreadLoadAvg, CtdlThreadWorkerAvg);
1460         end_critical_section(S_THREAD_LIST);
1461 }
1462
1463
1464 /*
1465  * Garbage collection routine.
1466  * Gets called by main() in a loop to clean up the thread list periodically.
1467  */
1468 void ctdl_internal_thread_gc (void)
1469 {
1470         struct CtdlThreadNode *this_thread, *that_thread;
1471         int workers = 0;
1472
1473         /* Handle exiting of garbage collector thread */
1474         if(num_threads == 1)
1475                 CtdlThreadList->state = CTDL_THREAD_EXITED;
1476
1477         CtdlLogPrintf(CTDL_DEBUG, "Thread system running garbage collection.\n");
1478         /*
1479          * Woke up to do garbage collection
1480          */
1481         begin_critical_section(S_THREAD_LIST);
1482         this_thread = CtdlThreadList;
1483         while(this_thread)
1484         {
1485                 that_thread = this_thread;
1486                 this_thread = this_thread->next;
1487
1488                 /* Do we need to clean up this thread? */
1489                 if (that_thread->state != CTDL_THREAD_EXITED)
1490                 {
1491                         if(that_thread->flags & CTDLTHREAD_WORKER)
1492                                 workers++;      /* Sanity check on number of worker threads */
1493                         continue;
1494                 }
1495
1496                 if (pthread_equal(that_thread->tid, pthread_self()) && that_thread->thread_func)
1497                 {       /* Sanity check */
1498                         end_critical_section(S_THREAD_LIST);
1499                         CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC, a thread is trying to clean up after itself.\n");
1500                         CtdlThreadStopAll();
1501                         return;
1502                 }
1503
1504                 if (num_threads <= 0)
1505                 {       /* Sanity check */
1506                         end_critical_section (S_THREAD_LIST);
1507                         CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC, num_threads <= 0 and trying to do Garbage Collection.\n");
1508                         CtdlThreadStopAll();
1509                         return;
1510                 }
1511
1512                 /* If we are unlinking the list head then the next becomes the list head */
1513                 if (that_thread == CtdlThreadList)
1514                         CtdlThreadList = that_thread->next;
1515                 if(that_thread->prev)
1516                         that_thread->prev->next = that_thread->next;
1517                 if(that_thread->next)
1518                         that_thread->next->prev = that_thread->next;
1519                 num_threads--;
1520                 if(that_thread->flags & CTDLTHREAD_WORKER)
1521                         num_workers--;  /* This is a wroker thread so reduce the count. */
1522
1523                 /*
1524                  * Join on the thread to do clean up and prevent memory leaks
1525                  * Also makes sure the thread has cleaned up after itself before we remove it from the list
1526                  * If that thread has no function it must be the garbage collector
1527                  */
1528                 if (that_thread->thread_func)
1529                         pthread_join (that_thread->tid, NULL);
1530
1531                 /*
1532                  * Now we own that thread entry
1533                  */
1534                 CtdlLogPrintf(CTDL_INFO, "Garbage Collection for thread \"%s\" (%ld).\n", that_thread->name, that_thread->tid);
1535                 if(that_thread->name)
1536                         free(that_thread->name);
1537                 pthread_mutex_destroy(&that_thread->ThreadMutex);
1538                 pthread_cond_destroy(&that_thread->ThreadCond);
1539                 pthread_attr_destroy(&that_thread->attr);
1540                 free(that_thread);
1541         }
1542
1543         /* Sanity check number of worker threads */
1544         if (workers != num_workers)
1545         {
1546                 end_critical_section(S_THREAD_LIST);
1547                 CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC, discrepancy in number of worker threads. Counted %d, should be %d.\n", workers, num_workers);
1548                 return;
1549         }
1550         end_critical_section(S_THREAD_LIST);
1551 }
1552
1553
1554
1555
1556 /*
1557  * Runtime function for a Citadel Thread.
1558  * This initialises the threads environment and then calls the user supplied thread function
1559  * Note that this is the REAL thread function and wraps the users thread function.
1560  */
1561 static void *ctdl_internal_thread_func (void *arg)
1562 {
1563         struct CtdlThreadNode *this_thread;
1564         void *ret = NULL;
1565
1566         /* lock and unlock the thread list.
1567          * This causes this thread to wait until all its creation stuff has finished before it
1568          * can continue its execution.
1569          */
1570         begin_critical_section(S_THREAD_LIST);
1571         // Get our thread data structure
1572         this_thread = (struct CtdlThreadNode *) arg;
1573         this_thread->state = CTDL_THREAD_RUNNING;
1574         this_thread->pid = getpid();
1575         gettimeofday(&this_thread->start_time, NULL);           /* Time this thread started */
1576         memcpy(&this_thread->last_state_change, &this_thread->start_time, sizeof (struct timeval));     /* Changed state so mark it. */
1577         end_critical_section(S_THREAD_LIST);
1578
1579         // Tell the world we are here
1580         CtdlLogPrintf(CTDL_NOTICE, "Created a new thread \"%s\" (%ld). \n", this_thread->name, this_thread->tid);
1581
1582         // Register the cleanup function to take care of when we exit.
1583         pthread_cleanup_push(ctdl_internal_thread_cleanup, NULL);
1584
1585
1586         /*
1587          * run the thread to do the work
1588          */
1589         ret = (this_thread->thread_func)(this_thread->user_args);
1590
1591         /*
1592          * Our thread is exiting either because it wanted to end or because the server is stopping
1593          * We need to clean up
1594          */
1595         pthread_cleanup_pop(1); // Execute our cleanup routine and remove it
1596
1597         return(ret);
1598 }
1599
1600
1601
1602 /*
1603  * Internal function to create a thread.
1604  * Must be called from within a S_THREAD_LIST critical section
1605  */
1606 struct CtdlThreadNode *ctdl_internal_create_thread(char *name, long flags, void *(*thread_func) (void *arg), void *args)
1607 {
1608         int ret = 0;
1609         struct CtdlThreadNode *this_thread;
1610         int sigtrick = 0;
1611         sigset_t old_signal_set;
1612
1613         if (num_threads >= 32767)
1614         {
1615                 CtdlLogPrintf(CTDL_EMERG, "Thread system. Thread list full.\n");
1616                 return NULL;
1617         }
1618
1619         this_thread = malloc(sizeof(struct CtdlThreadNode));
1620         if (this_thread == NULL) {
1621                 CtdlLogPrintf(CTDL_EMERG, "Thread system, can't allocate CtdlThreadNode, exiting\n");
1622                 return NULL;
1623         }
1624         // Ensuring this is zero'd means we make sure the thread doesn't start doing its thing until we are ready.
1625         memset (this_thread, 0, sizeof(struct CtdlThreadNode));
1626
1627         this_thread->state = CTDL_THREAD_CREATE;
1628
1629         if ((ret = pthread_attr_init(&this_thread->attr))) {
1630                 CtdlLogPrintf(CTDL_EMERG, "Thread system, pthread_attr_init: %s\n", strerror(ret));
1631                 free(this_thread);
1632                 return NULL;
1633         }
1634
1635         /* Our per-thread stacks need to be bigger than the default size,
1636          * otherwise the MIME parser crashes on FreeBSD, and the IMAP service
1637          * crashes on 64-bit Linux.
1638          */
1639         if (flags & CTDLTHREAD_BIGSTACK)
1640         {
1641                 CtdlLogPrintf(CTDL_INFO, "Thread system. Creating BIG STACK thread.\n");
1642                 if ((ret = pthread_attr_setstacksize(&this_thread->attr, THREADSTACKSIZE))) {
1643                         CtdlLogPrintf(CTDL_EMERG, "Thread system, pthread_attr_setstacksize: %s\n",
1644                                 strerror(ret));
1645                         pthread_attr_destroy(&this_thread->attr);
1646                         free(this_thread);
1647                         return NULL;
1648                 }
1649         }
1650
1651         /*
1652          * If we got here we are going to create the thread so we must initilise the structure
1653          * first because most implimentations of threading can't create it in a stopped state
1654          * and it might want to do things with its structure that aren't initialised otherwise.
1655          */
1656         if(name)
1657         {
1658                 this_thread->name = strdup(name);
1659         }
1660         else
1661         {
1662                 this_thread->name = strdup("Un-named Thread");
1663         }
1664
1665         this_thread->flags = flags;
1666         this_thread->thread_func = thread_func;
1667         this_thread->user_args = args;
1668         pthread_mutex_init (&(this_thread->ThreadMutex), NULL);
1669         pthread_cond_init (&(this_thread->ThreadCond), NULL);
1670
1671         /*
1672          * We want to make sure that only the main thread handles signals,
1673          * so that each signal is handled exactly once.  To do this, we
1674          * make sure that each new thread has all the signals that we
1675          * handle blocked.  To avoid race conditions, we block them in
1676          * the spawning thread first, then create the new thread (which
1677          * inherits the settings), and then restore the old settings in
1678          * the spawning thread.  This means that there is a brief period
1679          * when no signals will be processed, but during that time they
1680          * should be queued by the operating system.
1681          */
1682         if (pthread_equal(GC_thread, pthread_self()))
1683             sigtrick = ctdl_thread_internal_block_signals(&old_signal_set) == 0;
1684
1685         /*
1686          * We pass this_thread into the thread as its args so that it can find out information
1687          * about itself and it has a bit of storage space for itself, not to mention that the REAL
1688          * thread function needs to finish off the setup of the structure
1689          */
1690         if ((ret = pthread_create(&this_thread->tid, &this_thread->attr, ctdl_internal_thread_func, this_thread) != 0))
1691         {
1692
1693                 CtdlLogPrintf(CTDL_ALERT, "Thread system, Can't create thread: %s\n",
1694                         strerror(ret));
1695                 if (this_thread->name)
1696                         free (this_thread->name);
1697                 pthread_mutex_destroy(&(this_thread->ThreadMutex));
1698                 pthread_cond_destroy(&(this_thread->ThreadCond));
1699                 pthread_attr_destroy(&this_thread->attr);
1700                 free(this_thread);
1701                 if (sigtrick)
1702                         ctdl_thread_internal_restore_signals(&old_signal_set);
1703                 return NULL;
1704         }
1705
1706         if (sigtrick)
1707                 ctdl_thread_internal_restore_signals(&old_signal_set);
1708
1709         num_threads++;  // Increase the count of threads in the system.
1710         if(this_thread->flags & CTDLTHREAD_WORKER)
1711                 num_workers++;
1712
1713         this_thread->next = CtdlThreadList;
1714         CtdlThreadList = this_thread;
1715         if (this_thread->next)
1716                 this_thread->next->prev = this_thread;
1717         // Register for tracing
1718         #ifdef HAVE_BACKTRACE
1719         eCrash_RegisterThread(this_thread->name, 0);
1720         #endif
1721         return this_thread;
1722 }
1723
1724 /*
1725  * Wrapper function to create a thread
1726  * ensures the critical section and other protections are in place.
1727  * char *name = name to give to thread, if NULL, use generic name
1728  * int flags = flags to determine type of thread and standard facilities
1729  */
1730 struct CtdlThreadNode *CtdlThreadCreate(char *name, long flags, void *(*thread_func) (void *arg), void *args)
1731 {
1732         struct CtdlThreadNode *ret = NULL;
1733
1734         begin_critical_section(S_THREAD_LIST);
1735         ret = ctdl_internal_create_thread(name, flags, thread_func, args);
1736         end_critical_section(S_THREAD_LIST);
1737         return ret;
1738 }
1739
1740
1741
1742 /*
1743  * A warapper function for select so we can show a thread as blocked
1744  */
1745 int CtdlThreadSelect(int n, fd_set *readfds, fd_set *writefds, fd_set *exceptfds, const struct timeval *timeout)
1746 {
1747         struct CtdlThreadNode *self;
1748         int ret;
1749
1750         self = CtdlThreadSelf();
1751         ctdl_thread_internal_change_state(self, CTDL_THREAD_BLOCKED);
1752         ret = select(n, readfds, writefds, exceptfds, timeout);
1753         ctdl_thread_internal_change_state(self, CTDL_THREAD_RUNNING);
1754         return ret;
1755 }
1756
1757 /*
1758  * Purge all sessions which have the 'kill_me' flag set.
1759  * This function has code to prevent it from running more than once every
1760  * few seconds, because running it after every single unbind would waste a lot
1761  * of CPU time and keep the context list locked too much.  To force it to run
1762  * anyway, set "force" to nonzero.
1763  *
1764  *
1765  * After that's done, we raise the size of the worker thread pool
1766  * if such an action is appropriate.
1767  */
1768 void dead_session_purge(int force) {
1769         struct CitContext *ptr, *ptr2;          /* general-purpose utility pointer */
1770         struct CitContext *rem = NULL;  /* list of sessions to be destroyed */
1771
1772         if (force == 0) {
1773                 if ( (time(NULL) - last_purge) < 5 ) {
1774                         return; /* Too soon, go away */
1775                 }
1776         }
1777         time(&last_purge);
1778
1779         begin_critical_section(S_SESSION_TABLE);
1780         ptr = ContextList;
1781         while (ptr) {
1782                 ptr2 = ptr;
1783                 ptr = ptr->next;
1784
1785                 if ( (ptr2->state == CON_IDLE) && (ptr2->kill_me) ) {
1786                         /* Remove the session from the active list */
1787                         if (ptr2->prev) {
1788                                 ptr2->prev->next = ptr2->next;
1789                         }
1790                         else {
1791                                 ContextList = ptr2->next;
1792                         }
1793                         if (ptr2->next) {
1794                                 ptr2->next->prev = ptr2->prev;
1795                         }
1796
1797                         --num_sessions;
1798
1799                         /* And put it on our to-be-destroyed list */
1800                         ptr2->next = rem;
1801                         rem = ptr2;
1802
1803                 }
1804         }
1805         end_critical_section(S_SESSION_TABLE);
1806
1807         /* Now that we no longer have the session list locked, we can take
1808          * our time and destroy any sessions on the to-be-killed list, which
1809          * is allocated privately on this thread's stack.
1810          */
1811         while (rem != NULL) {
1812                 CtdlLogPrintf(CTDL_DEBUG, "Purging session %d\n", rem->cs_pid);
1813                 RemoveContext(rem);
1814                 ptr = rem;
1815                 rem = rem->next;
1816                 free(ptr);
1817         }
1818
1819         /* Raise the size of the worker thread pool if necessary. */
1820         begin_critical_section(S_THREAD_LIST);
1821         if ( (num_sessions > num_workers)
1822            && (num_workers < config.c_max_workers) ) {
1823                 ctdl_internal_create_thread("Worker Thread", CTDLTHREAD_BIGSTACK + CTDLTHREAD_WORKER, worker_thread, NULL);
1824         }
1825         end_critical_section(S_THREAD_LIST);
1826         // FIXME: reduce the number of worker threads too
1827 }
1828
1829
1830
1831
1832
1833 /*
1834  * masterCC is the context we use when not attached to a session.  This
1835  * function initializes it.
1836  */
1837 void InitializeMasterCC(void) {
1838         memset(&masterCC, 0, sizeof(struct CitContext));
1839         masterCC.internal_pgm = 1;
1840         masterCC.cs_pid = 0;
1841 }
1842
1843
1844
1845
1846
1847
1848 /*
1849  * Bind a thread to a context.  (It's inline merely to speed things up.)
1850  */
1851 INLINE void become_session(struct CitContext *which_con) {
1852         pthread_setspecific(MyConKey, (void *)which_con );
1853 }
1854
1855
1856
1857 /*
1858  * This loop just keeps going and going and going...
1859  */
1860 void *worker_thread(void *arg) {
1861         int i;
1862         int highest;
1863         struct CitContext *ptr;
1864         struct CitContext *bind_me = NULL;
1865         fd_set readfds;
1866         int retval = 0;
1867         struct CitContext *con= NULL;   /* Temporary context pointer */
1868         struct ServiceFunctionHook *serviceptr;
1869         int ssock;                      /* Descriptor for client socket */
1870         struct timeval tv;
1871         int force_purge = 0;
1872         int m;
1873
1874         cdb_allocate_tsd();
1875
1876         while (!CtdlThreadCheckStop()) {
1877
1878                 /* make doubly sure we're not holding any stale db handles
1879                  * which might cause a deadlock.
1880                  */
1881                 cdb_check_handles();
1882 do_select:      force_purge = 0;
1883                 bind_me = NULL;         /* Which session shall we handle? */
1884
1885                 /* Initialize the fdset. */
1886                 FD_ZERO(&readfds);
1887                 highest = 0;
1888
1889                 begin_critical_section(S_SESSION_TABLE);
1890                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
1891                         if (ptr->state == CON_IDLE) {
1892                                 FD_SET(ptr->client_socket, &readfds);
1893                                 if (ptr->client_socket > highest)
1894                                         highest = ptr->client_socket;
1895                         }
1896                         if ((bind_me == NULL) && (ptr->state == CON_READY)) {
1897                                 bind_me = ptr;
1898                                 ptr->state = CON_EXECUTING;
1899                         }
1900                 }
1901                 end_critical_section(S_SESSION_TABLE);
1902
1903                 if (bind_me) {
1904                         goto SKIP_SELECT;
1905                 }
1906
1907                 /* If we got this far, it means that there are no sessions
1908                  * which a previous thread marked for attention, so we go
1909                  * ahead and get ready to select().
1910                  */
1911
1912                 /* First, add the various master sockets to the fdset. */
1913                 for (serviceptr = ServiceHookTable; serviceptr != NULL;
1914                 serviceptr = serviceptr->next ) {
1915                         m = serviceptr->msock;
1916                         FD_SET(m, &readfds);
1917                         if (m > highest) {
1918                                 highest = m;
1919                         }
1920                 }
1921
1922                 if (!CtdlThreadCheckStop()) {
1923                         tv.tv_sec = 1;          /* wake up every second if no input */
1924                         tv.tv_usec = 0;
1925                         retval = CtdlThreadSelect(highest + 1, &readfds, NULL, NULL, &tv);
1926 //                      retval = select(highest + 1, &readfds, NULL, NULL, &tv);
1927                 }
1928
1929                 if (CtdlThreadCheckStop()) return(NULL);
1930
1931                 /* Now figure out who made this select() unblock.
1932                  * First, check for an error or exit condition.
1933                  */
1934                 if (retval < 0) {
1935                         if (errno == EBADF) {
1936                                 CtdlLogPrintf(CTDL_NOTICE, "select() failed: (%s)\n",
1937                                         strerror(errno));
1938                                 goto do_select;
1939                         }
1940                         if (errno != EINTR) {
1941                                 CtdlLogPrintf(CTDL_EMERG, "Exiting (%s)\n", strerror(errno));
1942                                 CtdlThreadStopAll();
1943                         } else if (!CtdlThreadCheckStop()) {
1944                                 CtdlLogPrintf(CTDL_DEBUG, "Un handled select failure.\n");
1945                                 goto do_select;
1946                         }
1947                 }
1948                 else if(retval == 0) {
1949                         goto SKIP_SELECT;
1950                 }
1951                 /* Next, check to see if it's a new client connecting
1952                  * on a master socket.
1953                  */
1954                 else for (serviceptr = ServiceHookTable; serviceptr != NULL;
1955                      serviceptr = serviceptr->next ) {
1956
1957                         if (FD_ISSET(serviceptr->msock, &readfds)) {
1958                                 ssock = accept(serviceptr->msock, NULL, 0);
1959                                 if (ssock >= 0) {
1960                                         CtdlLogPrintf(CTDL_DEBUG,
1961                                                 "New client socket %d\n",
1962                                                 ssock);
1963
1964                                         /* The master socket is non-blocking but the client
1965                                          * sockets need to be blocking, otherwise certain
1966                                          * operations barf on FreeBSD.  Not a fatal error.
1967                                          */
1968                                         if (fcntl(ssock, F_SETFL, 0) < 0) {
1969                                                 CtdlLogPrintf(CTDL_EMERG,
1970                                                         "citserver: Can't set socket to blocking: %s\n",
1971                                                         strerror(errno));
1972                                         }
1973
1974                                         /* New context will be created already
1975                                          * set up in the CON_EXECUTING state.
1976                                          */
1977                                         con = CreateNewContext();
1978
1979                                         /* Assign our new socket number to it. */
1980                                         con->client_socket = ssock;
1981                                         con->h_command_function =
1982                                                 serviceptr->h_command_function;
1983                                         con->h_async_function =
1984                                                 serviceptr->h_async_function;
1985                                         con->ServiceName =
1986                                                 serviceptr->ServiceName;
1987
1988                                         /* Determine whether it's a local socket */
1989                                         if (serviceptr->sockpath != NULL)
1990                                                 con->is_local_socket = 1;
1991
1992                                         /* Set the SO_REUSEADDR socket option */
1993                                         i = 1;
1994                                         setsockopt(ssock, SOL_SOCKET,
1995                                                 SO_REUSEADDR,
1996                                                 &i, sizeof(i));
1997
1998                                         become_session(con);
1999                                         begin_session(con);
2000                                         serviceptr->h_greeting_function();
2001                                         become_session(NULL);
2002                                         con->state = CON_IDLE;
2003                                         goto do_select;
2004                                 }
2005                         }
2006                 }
2007
2008                 /* It must be a client socket.  Find a context that has data
2009                  * waiting on its socket *and* is in the CON_IDLE state.  Any
2010                  * active sockets other than our chosen one are marked as
2011                  * CON_READY so the next thread that comes around can just bind
2012                  * to one without having to select() again.
2013                  */
2014                 begin_critical_section(S_SESSION_TABLE);
2015                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
2016                         if ( (FD_ISSET(ptr->client_socket, &readfds))
2017                            && (ptr->state != CON_EXECUTING) ) {
2018                                 ptr->input_waiting = 1;
2019                                 if (!bind_me) {
2020                                         bind_me = ptr;  /* I choose you! */
2021                                         bind_me->state = CON_EXECUTING;
2022                                 }
2023                                 else {
2024                                         ptr->state = CON_READY;
2025                                 }
2026                         }
2027                 }
2028                 end_critical_section(S_SESSION_TABLE);
2029
2030 SKIP_SELECT:
2031                 /* We're bound to a session */
2032                 if (bind_me != NULL) {
2033                         become_session(bind_me);
2034
2035                         /* If the client has sent a command, execute it. */
2036                         if (CC->input_waiting) {
2037                                 CC->h_command_function();
2038                                 CC->input_waiting = 0;
2039                         }
2040
2041                         /* If there are asynchronous messages waiting and the
2042                          * client supports it, do those now */
2043                         if ((CC->is_async) && (CC->async_waiting)
2044                            && (CC->h_async_function != NULL)) {
2045                                 CC->h_async_function();
2046                                 CC->async_waiting = 0;
2047                         }
2048
2049                         force_purge = CC->kill_me;
2050                         become_session(NULL);
2051                         bind_me->state = CON_IDLE;
2052                 }
2053
2054                 dead_session_purge(force_purge);
2055                 do_housekeeping();
2056                 check_sched_shutdown();
2057         }
2058         /* If control reaches this point, the server is shutting down */
2059         return(NULL);
2060 }
2061
2062
2063
2064
2065 /*
2066  * SyslogFacility()
2067  * Translate text facility name to syslog.h defined value.
2068  */
2069 int SyslogFacility(char *name)
2070 {
2071         int i;
2072         struct
2073         {
2074                 int facility;
2075                 char *name;
2076         }   facTbl[] =
2077         {
2078                 {   LOG_KERN,   "kern"          },
2079                 {   LOG_USER,   "user"          },
2080                 {   LOG_MAIL,   "mail"          },
2081                 {   LOG_DAEMON, "daemon"        },
2082                 {   LOG_AUTH,   "auth"          },
2083                 {   LOG_SYSLOG, "syslog"        },
2084                 {   LOG_LPR,    "lpr"           },
2085                 {   LOG_NEWS,   "news"          },
2086                 {   LOG_UUCP,   "uucp"          },
2087                 {   LOG_LOCAL0, "local0"        },
2088                 {   LOG_LOCAL1, "local1"        },
2089                 {   LOG_LOCAL2, "local2"        },
2090                 {   LOG_LOCAL3, "local3"        },
2091                 {   LOG_LOCAL4, "local4"        },
2092                 {   LOG_LOCAL5, "local5"        },
2093                 {   LOG_LOCAL6, "local6"        },
2094                 {   LOG_LOCAL7, "local7"        },
2095                 {   0,            NULL          }
2096         };
2097         for(i = 0; facTbl[i].name != NULL; i++) {
2098                 if(!strcasecmp(name, facTbl[i].name))
2099                         return facTbl[i].facility;
2100         }
2101         enable_syslog = 0;
2102         return LOG_DAEMON;
2103 }
2104
2105
2106 /********** MEM CHEQQER ***********/
2107
2108 #ifdef DEBUG_MEMORY_LEAKS
2109
2110 #undef malloc
2111 #undef realloc
2112 #undef strdup
2113 #undef free
2114
2115 void *tracked_malloc(size_t size, char *file, int line) {
2116         struct igheap *thisheap;
2117         void *block;
2118
2119         block = malloc(size);
2120         if (block == NULL) return(block);
2121
2122         thisheap = malloc(sizeof(struct igheap));
2123         if (thisheap == NULL) {
2124                 free(block);
2125                 return(NULL);
2126         }
2127
2128         thisheap->block = block;
2129         strcpy(thisheap->file, file);
2130         thisheap->line = line;
2131
2132         begin_critical_section(S_DEBUGMEMLEAKS);
2133         thisheap->next = igheap;
2134         igheap = thisheap;
2135         end_critical_section(S_DEBUGMEMLEAKS);
2136
2137         return(block);
2138 }
2139
2140
2141 void *tracked_realloc(void *ptr, size_t size, char *file, int line) {
2142         struct igheap *thisheap;
2143         void *block;
2144
2145         block = realloc(ptr, size);
2146         if (block == NULL) return(block);
2147
2148         thisheap = malloc(sizeof(struct igheap));
2149         if (thisheap == NULL) {
2150                 free(block);
2151                 return(NULL);
2152         }
2153
2154         thisheap->block = block;
2155         strcpy(thisheap->file, file);
2156         thisheap->line = line;
2157
2158         begin_critical_section(S_DEBUGMEMLEAKS);
2159         thisheap->next = igheap;
2160         igheap = thisheap;
2161         end_critical_section(S_DEBUGMEMLEAKS);
2162
2163         return(block);
2164 }
2165
2166
2167
2168 void tracked_free(void *ptr) {
2169         struct igheap *thisheap;
2170         struct igheap *trash;
2171
2172         free(ptr);
2173
2174         if (igheap == NULL) return;
2175         begin_critical_section(S_DEBUGMEMLEAKS);
2176         for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
2177                 if (thisheap->next != NULL) {
2178                         if (thisheap->next->block == ptr) {
2179                                 trash = thisheap->next;
2180                                 thisheap->next = thisheap->next->next;
2181                                 free(trash);
2182                         }
2183                 }
2184         }
2185         if (igheap->block == ptr) {
2186                 trash = igheap;
2187                 igheap = igheap->next;
2188                 free(trash);
2189         }
2190         end_critical_section(S_DEBUGMEMLEAKS);
2191 }
2192
2193 char *tracked_strdup(const char *s, char *file, int line) {
2194         char *ptr;
2195
2196         if (s == NULL) return(NULL);
2197         ptr = tracked_malloc(strlen(s) + 1, file, line);
2198         if (ptr == NULL) return(NULL);
2199         strncpy(ptr, s, strlen(s));
2200         return(ptr);
2201 }
2202
2203 void dump_heap(void) {
2204         struct igheap *thisheap;
2205
2206         for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
2207                 CtdlLogPrintf(CTDL_CRIT, "UNFREED: %30s : %d\n",
2208                         thisheap->file, thisheap->line);
2209         }
2210 }
2211
2212 #endif /*  DEBUG_MEMORY_LEAKS */