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 #ifdef DLL_EXPORT
  16 #define IN_LIBCIT
  17 #endif
  18
  19 #include "sysdep.h"
  20 #include <stdlib.h>
  21 #include <unistd.h>
  22 #include <stdio.h>
  23 #include <fcntl.h>
  24 #include <ctype.h>
  25 #include <signal.h>
  26 #include <sys/types.h>
  27 #include <sys/stat.h>
  28 #include <sys/wait.h>
  29 #include <sys/socket.h>
  30 #include <sys/syslog.h>
  31
  32 #if TIME_WITH_SYS_TIME
  33 # include <sys/time.h>
  34 # include <time.h>
  35 #else
  36 # if HAVE_SYS_TIME_H
  37 #  include <sys/time.h>
  38 # else
  39 #  include <time.h>
  40 # endif
  41 #endif
  42
  43 #include <limits.h>
  44 #include <sys/resource.h>
  45 #include <netinet/in.h>
  46 #include <arpa/inet.h>
  47 #include <netdb.h>
  48 #include <sys/un.h>
  49 #include <string.h>
  50 #include <pwd.h>
  51 #include <errno.h>
  52 #include <stdarg.h>
  53 #include <grp.h>
  54 #ifdef HAVE_PTHREAD_H
  55 #include <pthread.h>
  56 #endif
  57 #include "citadel.h"
  58 #include "server.h"
  59 #include "serv_extensions.h"
  60 #include "sysdep_decls.h"
  61 #include "citserver.h"
  62 #include "support.h"
  63 #include "config.h"
  64 #include "database.h"
  65 #include "housekeeping.h"
  66 #include "tools.h"
  67 #include "serv_crypto.h"
  68
  69 #ifdef HAVE_SYS_SELECT_H
  70 #include <sys/select.h>
  71 #endif
  72
  73 #ifndef HAVE_SNPRINTF
  74 #include "snprintf.h"
  75 #endif
  76
  77
  78 #ifdef DEBUG_MEMORY_LEAKS
  79 struct igheap {
  80         struct igheap *next;
  81         char file[32];
  82         int line;
  83         void *block;
  84 };
  85
  86 struct igheap *igheap = NULL;
  87 #endif
  88
  89
  90 pthread_mutex_t Critters[MAX_SEMAPHORES];       /* Things needing locking */
  91 pthread_key_t MyConKey;                         /* TSD key for MyContext() */
  92
  93 int verbosity = DEFAULT_VERBOSITY;              /* Logging level */
  94
  95 struct CitContext masterCC;
  96 time_t last_purge = 0;                          /* Last dead session purge */
  97 static int num_threads = 0;                     /* Current number of threads */
  98 int num_sessions = 0;                           /* Current number of sessions */
  99
 100 int syslog_facility = (-1);
 101
 102
 103 /*
 104  * lprintf()  ...   Write logging information
 105  *
 106  * Note: the variable "buf" below needs to be large enough to handle any
 107  * log data sent through this function.  BE CAREFUL!
 108  */
 109 extern int running_as_daemon;
 110 static int enable_syslog = 1;
 111 void lprintf(enum LogLevel loglevel, const char *format, ...) {
 112         va_list arg_ptr;
 113
 114         if (enable_syslog) {
 115                 va_start(arg_ptr, format);
 116                         vsyslog(loglevel, format, arg_ptr);
 117                 va_end(arg_ptr);
 118         }
 119
 120         if (enable_syslog && LogHookTable == 0) return;
 121
 122         /* legacy output code; hooks get processed first */
 123         char buf[SIZ];
 124         va_start(arg_ptr, format);
 125                 vsnprintf(buf, sizeof(buf), format, arg_ptr);
 126         va_end(arg_ptr);
 127         PerformLogHooks(loglevel, buf);
 128
 129         if (enable_syslog || running_as_daemon) return;
 130
 131         /* if we run in forground and syslog is disabled, log to terminal */
 132         if (loglevel <= verbosity) {
 133                 struct timeval tv;
 134                 struct tm tim;
 135                 time_t unixtime;
 136
 137                 gettimeofday(&tv, NULL);
 138                 /* Promote to time_t; types differ on some OSes (like darwin) */
 139                 unixtime = tv.tv_sec;
 140                 localtime_r(&unixtime, &tim);
 141                 if (CC->cs_pid != 0) {
 142                         fprintf(stderr,
 143                                 "%04d/%02d/%02d %2d:%02d:%02d.%06ld [%3d] %s",
 144                                 tim.tm_year + 1900, tim.tm_mon + 1,
 145                                 tim.tm_mday, tim.tm_hour, tim.tm_min,
 146                                 tim.tm_sec, (long)tv.tv_usec,
 147                                 CC->cs_pid, buf);
 148                 } else {
 149                         fprintf(stderr,
 150                                 "%04d/%02d/%02d %2d:%02d:%02d.%06ld %s",
 151                                 tim.tm_year + 1900, tim.tm_mon + 1,
 152                                 tim.tm_mday, tim.tm_hour, tim.tm_min,
 153                                 tim.tm_sec, (long)tv.tv_usec, buf);
 154                 }
 155                 fflush(stderr);
 156         }
 157 }
 158
 159
 160
 161 /*
 162  * We used to use master_cleanup() as a signal handler to shut down the server.
 163  * however, master_cleanup() and the functions it calls do some things that
 164  * aren't such a good idea to do from a signal handler: acquiring mutexes,
 165  * playing with signal masks on BSDI systems, etc. so instead we install the
 166  * following signal handler to set a global variable to inform the main loop
 167  * that it's time to call master_cleanup() and exit.
 168  */
 169
 170 volatile int time_to_die = 0;
 171
 172 static RETSIGTYPE signal_cleanup(int signum) {
 173         time_to_die = 1;
 174 }
 175
 176
 177 /*
 178  * Some initialization stuff...
 179  */
 180 void init_sysdep(void) {
 181         int i;
 182
 183         /* Avoid vulnerabilities related to FD_SETSIZE if we can. */
 184 #ifdef FD_SETSIZE
 185 #ifdef RLIMIT_NOFILE
 186         struct rlimit rl;
 187         getrlimit(RLIMIT_NOFILE, &rl);
 188         rl.rlim_cur = FD_SETSIZE;
 189         rl.rlim_max = FD_SETSIZE;
 190         setrlimit(RLIMIT_NOFILE, &rl);
 191 #endif
 192 #endif
 193
 194         /* If we've got OpenSSL, we're going to use it. */
 195 #ifdef HAVE_OPENSSL
 196         init_ssl();
 197 #endif
 198
 199         /* Set up a bunch of semaphores to be used for critical sections */
 200         for (i=0; i<MAX_SEMAPHORES; ++i) {
 201                 pthread_mutex_init(&Critters[i], NULL);
 202         }
 203
 204         /*
 205          * Set up a place to put thread-specific data.
 206          * We only need a single pointer per thread - it points to the
 207          * CitContext structure (in the ContextList linked list) of the
 208          * session to which the calling thread is currently bound.
 209          */
 210         if (pthread_key_create(&MyConKey, NULL) != 0) {
 211                 lprintf(CTDL_CRIT, "Can't create TSD key!!  %s\n", strerror(errno));
 212         }
 213
 214         /*
 215          * The action for unexpected signals and exceptions should be to
 216          * call signal_cleanup() to gracefully shut down the server.
 217          */
 218         signal(SIGINT, signal_cleanup);
 219         signal(SIGQUIT, signal_cleanup);
 220         signal(SIGHUP, signal_cleanup);
 221         signal(SIGTERM, signal_cleanup);
 222
 223         /*
 224          * Do not shut down the server on broken pipe signals, otherwise the
 225          * whole Citadel service would come down whenever a single client
 226          * socket breaks.
 227          */
 228         signal(SIGPIPE, SIG_IGN);
 229 }
 230
 231
 232 /*
 233  * Obtain a semaphore lock to begin a critical section.
 234  */
 235 void begin_critical_section(int which_one)
 236 {
 237         /* lprintf(CTDL_DEBUG, "begin_critical_section(%d)\n", which_one); */
 238
 239         /* For all types of critical sections except those listed here,
 240          * ensure nobody ever tries to do a critical section within a
 241          * transaction; this could lead to deadlock.
 242          */
 243         if (    (which_one != S_FLOORCACHE)
 244 #ifdef DEBUG_MEMORY_LEAKS
 245                 && (which_one != S_DEBUGMEMLEAKS)
 246 #endif
 247         ) {
 248                 cdb_check_handles();
 249         }
 250         pthread_mutex_lock(&Critters[which_one]);
 251 }
 252
 253 /*
 254  * Release a semaphore lock to end a critical section.
 255  */
 256 void end_critical_section(int which_one)
 257 {
 258         pthread_mutex_unlock(&Critters[which_one]);
 259 }
 260
 261
 262
 263 /*
 264  * This is a generic function to set up a master socket for listening on
 265  * a TCP port.  The server shuts down if the bind fails.
 266  *
 267  */
 268 int ig_tcp_server(char *ip_addr, int port_number, int queue_len)
 269 {
 270         struct sockaddr_in sin;
 271         int s, i;
 272         int actual_queue_len;
 273
 274         actual_queue_len = queue_len;
 275         if (actual_queue_len < 5) actual_queue_len = 5;
 276
 277         memset(&sin, 0, sizeof(sin));
 278         sin.sin_family = AF_INET;
 279         sin.sin_port = htons((u_short)port_number);
 280         if (ip_addr == NULL) {
 281                 sin.sin_addr.s_addr = INADDR_ANY;
 282         }
 283         else {
 284                 sin.sin_addr.s_addr = inet_addr(ip_addr);
 285         }
 286
 287         if (sin.sin_addr.s_addr == INADDR_NONE) {
 288                 sin.sin_addr.s_addr = INADDR_ANY;
 289         }
 290
 291         s = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP);
 292
 293         if (s < 0) {
 294                 lprintf(CTDL_EMERG, "citserver: Can't create a socket: %s\n",
 295                         strerror(errno));
 296                 return(-1);
 297         }
 298
 299         i = 1;
 300         setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
 301
 302         if (bind(s, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
 303                 lprintf(CTDL_EMERG, "citserver: Can't bind: %s\n",
 304                         strerror(errno));
 305                 close(s);
 306                 return(-1);
 307         }
 308
 309         if (listen(s, actual_queue_len) < 0) {
 310                 lprintf(CTDL_EMERG, "citserver: Can't listen: %s\n", strerror(errno));
 311                 close(s);
 312                 return(-1);
 313         }
 314
 315         return(s);
 316 }
 317
 318
 319
 320 /*
 321  * Create a Unix domain socket and listen on it
 322  */
 323 int ig_uds_server(char *sockpath, int queue_len)
 324 {
 325         struct sockaddr_un addr;
 326         int s;
 327         int i;
 328         int actual_queue_len;
 329
 330         actual_queue_len = queue_len;
 331         if (actual_queue_len < 5) actual_queue_len = 5;
 332
 333         i = unlink(sockpath);
 334         if (i != 0) if (errno != ENOENT) {
 335                 lprintf(CTDL_EMERG, "citserver: can't unlink %s: %s\n",
 336                         sockpath, strerror(errno));
 337                 return(-1);
 338         }
 339
 340         memset(&addr, 0, sizeof(addr));
 341         addr.sun_family = AF_UNIX;
 342         safestrncpy(addr.sun_path, sockpath, sizeof addr.sun_path);
 343
 344         s = socket(AF_UNIX, SOCK_STREAM, 0);
 345         if (s < 0) {
 346                 lprintf(CTDL_EMERG, "citserver: Can't create a socket: %s\n",
 347                         strerror(errno));
 348                 return(-1);
 349         }
 350
 351         if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
 352                 lprintf(CTDL_EMERG, "citserver: Can't bind: %s\n",
 353                         strerror(errno));
 354                 return(-1);
 355         }
 356
 357         if (listen(s, actual_queue_len) < 0) {
 358                 lprintf(CTDL_EMERG, "citserver: Can't listen: %s\n", strerror(errno));
 359                 return(-1);
 360         }
 361
 362         chmod(sockpath, 0777);
 363         return(s);
 364 }
 365
 366
 367
 368 /*
 369  * Return a pointer to the CitContext structure bound to the thread which
 370  * called this function.  If there's no such binding (for example, if it's
 371  * called by the housekeeper thread) then a generic 'master' CC is returned.
 372  *
 373  * This function is used *VERY* frequently and must be kept small.
 374  */
 375 struct CitContext *MyContext(void) {
 376
 377         register struct CitContext *c;
 378
 379         return ((c = (struct CitContext *) pthread_getspecific(MyConKey),
 380                 c == NULL) ? &masterCC : c
 381         );
 382 }
 383
 384
 385 /*
 386  * Initialize a new context and place it in the list.  The session number
 387  * used to be the PID (which is why it's called cs_pid), but that was when we
 388  * had one process per session.  Now we just assign them sequentially, starting
 389  * at 1 (don't change it to 0 because masterCC uses 0) and re-using them when
 390  * sessions terminate.
 391  */
 392 struct CitContext *CreateNewContext(void) {
 393         struct CitContext *me, *ptr;
 394
 395         me = (struct CitContext *) malloc(sizeof(struct CitContext));
 396         if (me == NULL) {
 397                 lprintf(CTDL_ALERT, "citserver: can't allocate memory!!\n");
 398                 return NULL;
 399         }
 400         memset(me, 0, sizeof(struct CitContext));
 401
 402         /* The new context will be created already in the CON_EXECUTING state
 403          * in order to prevent another thread from grabbing it while it's
 404          * being set up.
 405          */
 406         me->state = CON_EXECUTING;
 407
 408
 409         /*
 410          * Generate a unique session number and insert this context into
 411          * the list.
 412          */
 413         begin_critical_section(S_SESSION_TABLE);
 414
 415         if (ContextList == NULL) {
 416                 ContextList = me;
 417                 me->cs_pid = 1;
 418                 me->next = NULL;
 419         }
 420
 421         else if (ContextList->cs_pid > 1) {
 422                 me->next = ContextList;
 423                 ContextList = me;
 424                 me->cs_pid = 1;
 425         }
 426
 427         else {
 428                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
 429                         if (ptr->next == NULL) {
 430                                 ptr->next = me;
 431                                 me->cs_pid = ptr->cs_pid + 1;
 432                                 me->next = NULL;
 433                                 goto DONE;
 434                         }
 435                         else if (ptr->next->cs_pid > (ptr->cs_pid+1)) {
 436                                 me->next = ptr->next;
 437                                 ptr->next = me;
 438                                 me->cs_pid = ptr->cs_pid + 1;
 439                                 goto DONE;
 440                         }
 441                 }
 442         }
 443
 444 DONE:   ++num_sessions;
 445         end_critical_section(S_SESSION_TABLE);
 446         return(me);
 447 }
 448
 449
 450 /*
 451  * buffer_output() ... tell client_write to buffer all output until
 452  *                   instructed to dump it all out later
 453  */
 454 void buffer_output(void) {
 455         if (CC->buffering == 0) {
 456                 CC->buffering = 1;
 457                 CC->buffer_len = 0;
 458                 CC->output_buffer = malloc(SIZ);
 459         }
 460 }
 461
 462 /*
 463  * flush_output()  ...   dump out all that output we've been buffering.
 464  */
 465 void flush_output(void) {
 466         if (CC->buffering == 1) {
 467                 client_write(CC->output_buffer, CC->buffer_len);
 468                 CC->buffer_len = 0;
 469         }
 470 }
 471
 472 /*
 473  * unbuffer_output()  ...  stop buffering output.
 474  */
 475 void unbuffer_output(void) {
 476         if (CC->buffering == 1) {
 477                 CC->buffering = 0;
 478                 /* We don't call flush_output because we can't. */
 479                 client_write(CC->output_buffer, CC->buffer_len);
 480                 CC->buffer_len = 0;
 481                 free(CC->output_buffer);
 482                 CC->output_buffer = NULL;
 483         }
 484 }
 485
 486
 487
 488 /*
 489  * client_write()   ...    Send binary data to the client.
 490  */
 491 void client_write(char *buf, int nbytes)
 492 {
 493         int bytes_written = 0;
 494         int retval;
 495         int sock;
 496         int old_buffer_len = 0;
 497
 498         if (CC->redirect_fp != NULL) {
 499                 fwrite(buf, (size_t)nbytes, (size_t)1, CC->redirect_fp);
 500                 return;
 501         }
 502
 503         if (CC->redirect_sock > 0) {
 504                 sock = CC->redirect_sock;       /* and continue below... */
 505         }
 506         else {
 507                 sock = CC->client_socket;
 508         }
 509
 510         /* If we're buffering for later, do that now. */
 511         if (CC->buffering) {
 512                 old_buffer_len = CC->buffer_len;
 513                 CC->buffer_len += nbytes;
 514                 CC->output_buffer = realloc(CC->output_buffer, CC->buffer_len);
 515                 memcpy(&CC->output_buffer[old_buffer_len], buf, nbytes);
 516                 return;
 517         }
 518
 519         /* Ok, at this point we're not buffering.  Go ahead and write. */
 520
 521 #ifdef HAVE_OPENSSL
 522         if (CC->redirect_ssl) {
 523                 client_write_ssl(buf, nbytes);
 524                 return;
 525         }
 526 #endif
 527
 528         while (bytes_written < nbytes) {
 529                 retval = write(sock, &buf[bytes_written],
 530                         nbytes - bytes_written);
 531                 if (retval < 1) {
 532                         lprintf(CTDL_ERR, "client_write() failed: %s\n",
 533                                 strerror(errno));
 534                         if (sock == CC->client_socket) CC->kill_me = 1;
 535                         return;
 536                 }
 537                 bytes_written = bytes_written + retval;
 538         }
 539 }
 540
 541
 542 /*
 543  * cprintf()  ...   Send formatted printable data to the client.   It is
 544  *                implemented in terms of client_write() but remains in
 545  *                sysdep.c in case we port to somewhere without va_args...
 546  */
 547 void cprintf(const char *format, ...) {
 548         va_list arg_ptr;
 549         char buf[SIZ];
 550
 551         va_start(arg_ptr, format);
 552         if (vsnprintf(buf, sizeof buf, format, arg_ptr) == -1)
 553                 buf[sizeof buf - 2] = '\n';
 554         client_write(buf, strlen(buf));
 555         va_end(arg_ptr);
 556 }
 557
 558
 559 /*
 560  * Read data from the client socket.
 561  * Return values are:
 562  *      1       Requested number of bytes has been read.
 563  *      0       Request timed out.
 564  *      -1      The socket is broken.
 565  * If the socket breaks, the session will be terminated.
 566  */
 567 int client_read_to(char *buf, int bytes, int timeout)
 568 {
 569         int len,rlen;
 570         fd_set rfds;
 571         struct timeval tv;
 572         int retval;
 573
 574 #ifdef HAVE_OPENSSL
 575         if (CC->redirect_ssl) {
 576                 return (client_read_ssl(buf, bytes, timeout));
 577         }
 578 #endif
 579         len = 0;
 580         while(len<bytes) {
 581                 FD_ZERO(&rfds);
 582                 FD_SET(CC->client_socket, &rfds);
 583                 tv.tv_sec = timeout;
 584                 tv.tv_usec = 0;
 585
 586                 retval = select( (CC->client_socket)+1,
 587                                         &rfds, NULL, NULL, &tv);
 588
 589                 if (FD_ISSET(CC->client_socket, &rfds) == 0) {
 590                         return(0);
 591                 }
 592
 593                 rlen = read(CC->client_socket, &buf[len], bytes-len);
 594                 if (rlen<1) {
 595                         lprintf(CTDL_ERR, "client_read() failed: %s\n",
 596                                 strerror(errno));
 597                         CC->kill_me = 1;
 598                         return(-1);
 599                 }
 600                 len = len + rlen;
 601         }
 602         return(1);
 603 }
 604
 605 /*
 606  * Read data from the client socket with default timeout.
 607  * (This is implemented in terms of client_read_to() and could be
 608  * justifiably moved out of sysdep.c)
 609  */
 610 INLINE int client_read(char *buf, int bytes)
 611 {
 612         return(client_read_to(buf, bytes, config.c_sleeping));
 613 }
 614
 615
 616 /*
 617  * client_getln()   ...   Get a LF-terminated line of text from the client.
 618  * (This is implemented in terms of client_read() and could be
 619  * justifiably moved out of sysdep.c)
 620  */
 621 int client_getln(char *buf, int bufsize)
 622 {
 623         int i, retval;
 624
 625         /* Read one character at a time.
 626          */
 627         for (i = 0;;i++) {
 628                 retval = client_read(&buf[i], 1);
 629                 if (retval != 1 || buf[i] == '\n' || i == (bufsize-1))
 630                         break;
 631         }
 632
 633         /* If we got a long line, discard characters until the newline.
 634          */
 635         if (i == (bufsize-1))
 636                 while (buf[i] != '\n' && retval == 1)
 637                         retval = client_read(&buf[i], 1);
 638
 639         /* Strip the trailing newline and any trailing nonprintables (cr's)
 640          */
 641         buf[i] = 0;
 642         while ((strlen(buf)>0)&&(!isprint(buf[strlen(buf)-1])))
 643                 buf[strlen(buf)-1] = 0;
 644         if (retval < 0) strcpy(buf, "000");
 645         return(retval);
 646 }
 647
 648
 649
 650 /*
 651  * The system-dependent part of master_cleanup() - close the master socket.
 652  */
 653 void sysdep_master_cleanup(void) {
 654         struct ServiceFunctionHook *serviceptr;
 655
 656         /*
 657          * close all protocol master sockets
 658          */
 659         for (serviceptr = ServiceHookTable; serviceptr != NULL;
 660             serviceptr = serviceptr->next ) {
 661
 662                 if (serviceptr->tcp_port > 0)
 663                         lprintf(CTDL_INFO, "Closing listener on port %d\n",
 664                                 serviceptr->tcp_port);
 665
 666                 if (serviceptr->sockpath != NULL)
 667                         lprintf(CTDL_INFO, "Closing listener on '%s'\n",
 668                                 serviceptr->sockpath);
 669
 670                 close(serviceptr->msock);
 671
 672                 /* If it's a Unix domain socket, remove the file. */
 673                 if (serviceptr->sockpath != NULL) {
 674                         unlink(serviceptr->sockpath);
 675                 }
 676         }
 677 }
 678
 679
 680 /*
 681  * Terminate another session.
 682  * (This could justifiably be moved out of sysdep.c because it
 683  * no longer does anything that is system-dependent.)
 684  */
 685 void kill_session(int session_to_kill) {
 686         struct CitContext *ptr;
 687
 688         begin_critical_section(S_SESSION_TABLE);
 689         for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
 690                 if (ptr->cs_pid == session_to_kill) {
 691                         ptr->kill_me = 1;
 692                 }
 693         }
 694         end_critical_section(S_SESSION_TABLE);
 695 }
 696
 697
 698
 699
 700 /*
 701  * Start running as a daemon.
 702  */
 703 void start_daemon(int unused) {
 704         close(0); close(1); close(2);
 705         if (fork()) exit(0);
 706         setsid();
 707         signal(SIGHUP,SIG_IGN);
 708         signal(SIGINT,SIG_IGN);
 709         signal(SIGQUIT,SIG_IGN);
 710 }
 711
 712
 713
 714 /*
 715  * Generic routine to convert a login name to a full name (gecos)
 716  * Returns nonzero if a conversion took place
 717  */
 718 int convert_login(char NameToConvert[]) {
 719         struct passwd *pw;
 720         int a;
 721
 722         pw = getpwnam(NameToConvert);
 723         if (pw == NULL) {
 724                 return(0);
 725         }
 726         else {
 727                 strcpy(NameToConvert, pw->pw_gecos);
 728                 for (a=0; a<strlen(NameToConvert); ++a) {
 729                         if (NameToConvert[a] == ',') NameToConvert[a] = 0;
 730                 }
 731                 return(1);
 732         }
 733 }
 734
 735 struct worker_node *worker_list = NULL;
 736
 737
 738 /*
 739  * create a worker thread. this function must always be called from within
 740  * an S_WORKER_LIST critical section!
 741  */
 742 void create_worker(void) {
 743         int ret;
 744         struct worker_node *n;
 745         pthread_attr_t attr;
 746
 747         n = malloc(sizeof(struct worker_node));
 748         if (n == NULL) {
 749                 lprintf(CTDL_EMERG, "can't allocate worker_node, exiting\n");
 750                 time_to_die = -1;
 751                 return;
 752         }
 753
 754         if ((ret = pthread_attr_init(&attr))) {
 755                 lprintf(CTDL_EMERG, "pthread_attr_init: %s\n", strerror(ret));
 756                 time_to_die = -1;
 757                 return;
 758         }
 759
 760         /* Our per-thread stacks need to be bigger than the default size, otherwise
 761          * the MIME parser crashes on FreeBSD, and the IMAP service crashes on
 762          * 64-bit Linux.
 763          */
 764         if ((ret = pthread_attr_setstacksize(&attr, 1024 * 1024))) {
 765                 lprintf(CTDL_EMERG, "pthread_attr_setstacksize: %s\n", strerror(ret));
 766                 time_to_die = -1;
 767                 pthread_attr_destroy(&attr);
 768                 return;
 769         }
 770
 771         if ((ret = pthread_create(&n->tid, &attr, worker_thread, NULL) != 0))
 772         {
 773
 774                 lprintf(CTDL_ALERT, "Can't create worker thread: %s\n",
 775                         strerror(ret));
 776         }
 777
 778         n->next = worker_list;
 779         worker_list = n;
 780         pthread_attr_destroy(&attr);
 781 }
 782
 783
 784
 785 /*
 786  * Purge all sessions which have the 'kill_me' flag set.
 787  * This function has code to prevent it from running more than once every
 788  * few seconds, because running it after every single unbind would waste a lot
 789  * of CPU time and keep the context list locked too much.  To force it to run
 790  * anyway, set "force" to nonzero.
 791  *
 792  *
 793  * After that's done, we raise the size of the worker thread pool
 794  * if such an action is appropriate.
 795  */
 796 void dead_session_purge(int force) {
 797         struct CitContext *ptr, *rem;
 798
 799         if (force == 0) {
 800                 if ( (time(NULL) - last_purge) < 5 ) {
 801                         return; /* Too soon, go away */
 802                 }
 803         }
 804         time(&last_purge);
 805
 806         do {
 807                 rem = NULL;
 808                 begin_critical_section(S_SESSION_TABLE);
 809                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
 810                         if ( (ptr->state == CON_IDLE) && (ptr->kill_me) ) {
 811                                 rem = ptr;
 812                         }
 813                 }
 814                 end_critical_section(S_SESSION_TABLE);
 815
 816                 /* RemoveContext() enters its own S_SESSION_TABLE critical
 817                  * section, so we have to do it like this.
 818                  */
 819                 if (rem != NULL) {
 820                         lprintf(CTDL_DEBUG, "Purging session %d\n", rem->cs_pid);
 821                         RemoveContext(rem);
 822                 }
 823
 824         } while (rem != NULL);
 825
 826         /* Raise the size of the worker thread pool if necessary. */
 827
 828         if ( (num_sessions > num_threads)
 829            && (num_threads < config.c_max_workers) ) {
 830                 begin_critical_section(S_WORKER_LIST);
 831                 create_worker();
 832                 end_critical_section(S_WORKER_LIST);
 833         }
 834 }
 835
 836
 837
 838
 839
 840 /*
 841  * Redirect a session's output to a file or socket.
 842  * This function may be called with a file handle *or* a socket (but not
 843  * both).  Call with neither to return output to its normal client socket.
 844  */
 845 void CtdlRedirectOutput(FILE *fp, int sock) {
 846
 847         if (fp != NULL) CC->redirect_fp = fp;
 848         else CC->redirect_fp = NULL;
 849
 850         if (sock > 0) CC->redirect_sock = sock;
 851         else CC->redirect_sock = (-1);
 852
 853 }
 854
 855
 856 /*
 857  * masterCC is the context we use when not attached to a session.  This
 858  * function initializes it.
 859  */
 860 void InitializeMasterCC(void) {
 861         memset(&masterCC, 0, sizeof(struct CitContext));
 862         masterCC.internal_pgm = 1;
 863         masterCC.cs_pid = 0;
 864 }
 865
 866
 867
 868
 869
 870
 871 /*
 872  * Bind a thread to a context.  (It's inline merely to speed things up.)
 873  */
 874 INLINE void become_session(struct CitContext *which_con) {
 875         pthread_setspecific(MyConKey, (void *)which_con );
 876 }
 877
 878
 879
 880 /*
 881  * This loop just keeps going and going and going...
 882  */
 883 void *worker_thread(void *arg) {
 884         int i;
 885         int highest;
 886         struct CitContext *ptr;
 887         struct CitContext *bind_me = NULL;
 888         fd_set readfds;
 889         int retval = 0;
 890         struct CitContext *con= NULL;   /* Temporary context pointer */
 891         struct ServiceFunctionHook *serviceptr;
 892         int ssock;                      /* Descriptor for client socket */
 893         struct timeval tv;
 894         int force_purge = 0;
 895         int m;
 896
 897         num_threads++;
 898
 899         cdb_allocate_tsd();
 900
 901         while (!time_to_die) {
 902
 903                 /* make doubly sure we're not holding any stale db handles
 904                  * which might cause a deadlock.
 905                  */
 906                 cdb_check_handles();
 907 do_select:      force_purge = 0;
 908                 bind_me = NULL;         /* Which session shall we handle? */
 909
 910                 /* Initialize the fdset. */
 911                 FD_ZERO(&readfds);
 912                 highest = 0;
 913
 914                 begin_critical_section(S_SESSION_TABLE);
 915                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
 916                         if (ptr->state == CON_IDLE) {
 917                                 FD_SET(ptr->client_socket, &readfds);
 918                                 if (ptr->client_socket > highest)
 919                                         highest = ptr->client_socket;
 920                         }
 921                         if ((bind_me == NULL) && (ptr->state == CON_READY)) {
 922                                 bind_me = ptr;
 923                                 ptr->state = CON_EXECUTING;
 924                         }
 925                 }
 926                 end_critical_section(S_SESSION_TABLE);
 927
 928                 if (bind_me) goto SKIP_SELECT;
 929
 930                 /* If we got this far, it means that there are no sessions
 931                  * which a previous thread marked for attention, so we go
 932                  * ahead and get ready to select().
 933                  */
 934
 935                 /* First, add the various master sockets to the fdset. */
 936                 for (serviceptr = ServiceHookTable; serviceptr != NULL;
 937                 serviceptr = serviceptr->next ) {
 938                         m = serviceptr->msock;
 939                         FD_SET(m, &readfds);
 940                         if (m > highest) {
 941                                 highest = m;
 942                         }
 943                 }
 944
 945                 if (!time_to_die) {
 946                         tv.tv_sec = 1;          /* wake up every second if no input */
 947                         tv.tv_usec = 0;
 948                         retval = select(highest + 1, &readfds, NULL, NULL, &tv);
 949                 }
 950
 951                 if (time_to_die) return(NULL);
 952
 953                 /* Now figure out who made this select() unblock.
 954                  * First, check for an error or exit condition.
 955                  */
 956                 if (retval < 0) {
 957                         if (errno == EBADF) {
 958                                 lprintf(CTDL_NOTICE, "select() failed: (%s)\n",
 959                                         strerror(errno));
 960                                 goto do_select;
 961                         }
 962                         if (errno != EINTR) {
 963                                 lprintf(CTDL_EMERG, "Exiting (%s)\n", strerror(errno));
 964                                 time_to_die = 1;
 965                         } else if (!time_to_die)
 966                                 goto do_select;
 967                 }
 968
 969                 /* Next, check to see if it's a new client connecting
 970                  * on a master socket.
 971                  */
 972                 else for (serviceptr = ServiceHookTable; serviceptr != NULL;
 973                      serviceptr = serviceptr->next ) {
 974
 975                         if (FD_ISSET(serviceptr->msock, &readfds)) {
 976                                 ssock = accept(serviceptr->msock, NULL, 0);
 977                                 if (ssock < 0) {
 978                                         lprintf(CTDL_CRIT,
 979                                                 "citserver: accept(): %s\n",
 980                                                 strerror(errno));
 981                                 }
 982                                 else {
 983                                         lprintf(CTDL_DEBUG,
 984                                                 "New client socket %d\n",
 985                                                 ssock);
 986
 987                                         /* New context will be created already
 988                                         * set up in the CON_EXECUTING state.
 989                                         */
 990                                         con = CreateNewContext();
 991
 992                                         /* Assign new socket number to it. */
 993                                         con->client_socket = ssock;
 994                                         con->h_command_function =
 995                                                 serviceptr->h_command_function;
 996                                         con->h_async_function =
 997                                                 serviceptr->h_async_function;
 998
 999                                         /* Determine whether local socket */
1000                                         if (serviceptr->sockpath != NULL)
1001                                                 con->is_local_socket = 1;
1002
1003                                         /* Set the SO_REUSEADDR socket option */
1004                                         i = 1;
1005                                         setsockopt(ssock, SOL_SOCKET,
1006                                                 SO_REUSEADDR,
1007                                                 &i, sizeof(i));
1008
1009                                         become_session(con);
1010                                         begin_session(con);
1011                                         serviceptr->h_greeting_function();
1012                                         become_session(NULL);
1013                                         con->state = CON_IDLE;
1014                                         goto do_select;
1015                                 }
1016                         }
1017                 }
1018
1019                 /* It must be a client socket.  Find a context that has data
1020                  * waiting on its socket *and* is in the CON_IDLE state.  Any
1021                  * active sockets other than our chosen one are marked as
1022                  * CON_READY so the next thread that comes around can just bind
1023                  * to one without having to select() again.
1024                  */
1025                 begin_critical_section(S_SESSION_TABLE);
1026                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
1027                         if ( (FD_ISSET(ptr->client_socket, &readfds))
1028                            && (ptr->state != CON_EXECUTING) ) {
1029                                 ptr->input_waiting = 1;
1030                                 if (!bind_me) {
1031                                         bind_me = ptr;  /* I choose you! */
1032                                         bind_me->state = CON_EXECUTING;
1033                                 }
1034                                 else {
1035                                         ptr->state = CON_READY;
1036                                 }
1037                         }
1038                 }
1039                 end_critical_section(S_SESSION_TABLE);
1040
1041 SKIP_SELECT:
1042                 /* We're bound to a session */
1043                 if (bind_me != NULL) {
1044                         become_session(bind_me);
1045
1046                         /* If the client has sent a command, execute it. */
1047                         if (CC->input_waiting) {
1048                                 CC->h_command_function();
1049                                 CC->input_waiting = 0;
1050                         }
1051
1052                         /* If there are asynchronous messages waiting and the
1053                          * client supports it, do those now */
1054                         if ((CC->is_async) && (CC->async_waiting)
1055                            && (CC->h_async_function != NULL)) {
1056                                 CC->h_async_function();
1057                                 CC->async_waiting = 0;
1058                         }
1059
1060                         force_purge = CC->kill_me;
1061                         become_session(NULL);
1062                         bind_me->state = CON_IDLE;
1063                 }
1064
1065                 dead_session_purge(force_purge);
1066                 do_housekeeping();
1067                 check_sched_shutdown();
1068         }
1069
1070         /* If control reaches this point, the server is shutting down */
1071         return(NULL);
1072 }
1073
1074
1075
1076
1077 /*
1078  * SyslogFacility()
1079  * Translate text facility name to syslog.h defined value.
1080  */
1081 int SyslogFacility(char *name)
1082 {
1083         int i;
1084         struct
1085         {
1086                 int facility;
1087                 char *name;
1088         }   facTbl[] =
1089         {
1090                 {   LOG_KERN,   "kern"          },
1091                 {   LOG_USER,   "user"          },
1092                 {   LOG_MAIL,   "mail"          },
1093                 {   LOG_DAEMON, "daemon"        },
1094                 {   LOG_AUTH,   "auth"          },
1095                 {   LOG_SYSLOG, "syslog"        },
1096                 {   LOG_LPR,    "lpr"           },
1097                 {   LOG_NEWS,   "news"          },
1098                 {   LOG_UUCP,   "uucp"          },
1099                 {   LOG_LOCAL0, "local0"        },
1100                 {   LOG_LOCAL1, "local1"        },
1101                 {   LOG_LOCAL2, "local2"        },
1102                 {   LOG_LOCAL3, "local3"        },
1103                 {   LOG_LOCAL4, "local4"        },
1104                 {   LOG_LOCAL5, "local5"        },
1105                 {   LOG_LOCAL6, "local6"        },
1106                 {   LOG_LOCAL7, "local7"        },
1107                 {   0,            NULL          }
1108         };
1109         for(i = 0; facTbl[i].name != NULL; i++) {
1110                 if(!strcasecmp(name, facTbl[i].name))
1111                         return facTbl[i].facility;
1112         }
1113         enable_syslog = 0;
1114         return LOG_DAEMON;
1115 }
1116
1117
1118 /********** MEM CHEQQER ***********/
1119
1120 #ifdef DEBUG_MEMORY_LEAKS
1121
1122 #undef malloc
1123 #undef realloc
1124 #undef strdup
1125 #undef free
1126
1127 void *tracked_malloc(size_t size, char *file, int line) {
1128         struct igheap *thisheap;
1129         void *block;
1130
1131         block = malloc(size);
1132         if (block == NULL) return(block);
1133
1134         thisheap = malloc(sizeof(struct igheap));
1135         if (thisheap == NULL) {
1136                 free(block);
1137                 return(NULL);
1138         }
1139
1140         thisheap->block = block;
1141         strcpy(thisheap->file, file);
1142         thisheap->line = line;
1143
1144         begin_critical_section(S_DEBUGMEMLEAKS);
1145         thisheap->next = igheap;
1146         igheap = thisheap;
1147         end_critical_section(S_DEBUGMEMLEAKS);
1148
1149         return(block);
1150 }
1151
1152
1153 void *tracked_realloc(void *ptr, size_t size, char *file, int line) {
1154         struct igheap *thisheap;
1155         void *block;
1156
1157         block = realloc(ptr, size);
1158         if (block == NULL) return(block);
1159
1160         thisheap = malloc(sizeof(struct igheap));
1161         if (thisheap == NULL) {
1162                 free(block);
1163                 return(NULL);
1164         }
1165
1166         thisheap->block = block;
1167         strcpy(thisheap->file, file);
1168         thisheap->line = line;
1169
1170         begin_critical_section(S_DEBUGMEMLEAKS);
1171         thisheap->next = igheap;
1172         igheap = thisheap;
1173         end_critical_section(S_DEBUGMEMLEAKS);
1174
1175         return(block);
1176 }
1177
1178
1179
1180 void tracked_free(void *ptr) {
1181         struct igheap *thisheap;
1182         struct igheap *trash;
1183
1184         free(ptr);
1185
1186         if (igheap == NULL) return;
1187         begin_critical_section(S_DEBUGMEMLEAKS);
1188         for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
1189                 if (thisheap->next != NULL) {
1190                         if (thisheap->next->block == ptr) {
1191                                 trash = thisheap->next;
1192                                 thisheap->next = thisheap->next->next;
1193                                 free(trash);
1194                         }
1195                 }
1196         }
1197         if (igheap->block == ptr) {
1198                 trash = igheap;
1199                 igheap = igheap->next;
1200                 free(trash);
1201         }
1202         end_critical_section(S_DEBUGMEMLEAKS);
1203 }
1204
1205 char *tracked_strdup(const char *s, char *file, int line) {
1206         char *ptr;
1207
1208         if (s == NULL) return(NULL);
1209         ptr = tracked_malloc(strlen(s) + 1, file, line);
1210         if (ptr == NULL) return(NULL);
1211         strncpy(ptr, s, strlen(s));
1212         return(ptr);
1213 }
1214
1215 void dump_heap(void) {
1216         struct igheap *thisheap;
1217
1218         for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
1219                 lprintf(CTDL_CRIT, "UNFREED: %30s : %d\n",
1220                         thisheap->file, thisheap->line);
1221         }
1222 }
1223
1224 #endif /*  DEBUG_MEMORY_LEAKS */