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