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