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