citadel/sysdep.c

   1 /*
   2  * $Id$
   3  *
   4  * Citadel/UX "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
  31 #if TIME_WITH_SYS_TIME
  32 # include <sys/time.h>
  33 # include <time.h>
  34 #else
  35 # if HAVE_SYS_TIME_H
  36 #  include <sys/time.h>
  37 # else
  38 #  include <time.h>
  39 # endif
  40 #endif
  41
  42 #include <limits.h>
  43 #include <netinet/in.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 <syslog.h>
  51 #include <grp.h>
  52 #ifdef HAVE_PTHREAD_H
  53 #include <pthread.h>
  54 #endif
  55 #include "citadel.h"
  56 #include "server.h"
  57 #include "serv_extensions.h"
  58 #include "sysdep_decls.h"
  59 #include "citserver.h"
  60 #include "support.h"
  61 #include "config.h"
  62 #include "database.h"
  63 #include "housekeeping.h"
  64 #include "tools.h"
  65 #include "serv_crypto.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 #ifdef DEBUG_MEMORY_LEAKS
  76 struct TheHeap *heap = NULL;
  77 #endif
  78
  79 pthread_mutex_t Critters[MAX_SEMAPHORES];       /* Things needing locking */
  80 pthread_key_t MyConKey;                         /* TSD key for MyContext() */
  81
  82 int verbosity = DEFAULT_VERBOSITY;              /* Logging level */
  83
  84 struct CitContext masterCC;
  85 int rescan[2];                                  /* The Rescan Pipe */
  86 time_t last_purge = 0;                          /* Last dead session purge */
  87 static int num_threads = 0;                     /* Current number of threads */
  88 int num_sessions = 0;                           /* Current number of sessions */
  89
  90 fd_set masterfds;                               /* Master sockets etc. */
  91 int masterhighest;
  92
  93 pthread_t initial_thread;               /* tid for main() thread */
  94
  95
  96 /*
  97  * lprintf()  ...   Write logging information
  98  *
  99  * Note: the variable "buf" below needs to be large enough to handle any
 100  * log data sent through this function.  BE CAREFUL!
 101  */
 102 void lprintf(int loglevel, const char *format, ...) {
 103         va_list arg_ptr;
 104         char buf[SIZ];
 105
 106         va_start(arg_ptr, format);
 107         vsnprintf(buf, sizeof(buf), format, arg_ptr);
 108         va_end(arg_ptr);
 109
 110         if (loglevel <= verbosity) {
 111                 struct timeval tv;
 112                 struct tm *tim;
 113                 time_t unixtime;
 114
 115                 gettimeofday(&tv, NULL);
 116                 /* Promote to time_t; types differ on some OSes (like darwin) */
 117                 unixtime = tv.tv_sec;
 118                 tim = localtime(&unixtime);
 119                 /*
 120                  * Log provides millisecond accuracy.  If you need
 121                  * microsecond accuracy and your OS supports it, change
 122                  * %03ld to %06ld and remove " / 1000" after tv.tv_usec.
 123                  */
 124                 if (CC && CC->cs_pid) {
 125                         fprintf(stderr,
 126                                 "%04d/%02d/%02d %2d:%02d:%02d.%03ld [%3d] %s",
 127                                 tim->tm_year + 1900, tim->tm_mon + 1,
 128                                 tim->tm_mday, tim->tm_hour, tim->tm_min,
 129                                 tim->tm_sec, (long)tv.tv_usec / 1000,
 130                                 CC->cs_pid, buf);
 131                 } else {
 132                         fprintf(stderr,
 133                                 "%04d/%02d/%02d %2d:%02d:%02d.%03ld %s",
 134                                 tim->tm_year + 1900, tim->tm_mon + 1,
 135                                 tim->tm_mday, tim->tm_hour, tim->tm_min,
 136                                 tim->tm_sec, (long)tv.tv_usec / 1000, buf);
 137                 }
 138                 fflush(stderr);
 139         }
 140
 141         PerformLogHooks(loglevel, buf);
 142 }
 143
 144
 145
 146 #ifdef DEBUG_MEMORY_LEAKS
 147 void *tracked_malloc(size_t tsize, char *tfile, int tline) {
 148         void *ptr;
 149         struct TheHeap *hptr;
 150
 151         ptr = malloc(tsize);
 152         if (ptr == NULL) {
 153                 lprintf(3, "DANGER!  mallok(%d) at %s:%d failed!\n",
 154                         tsize, tfile, tline);
 155                 return(NULL);
 156         }
 157
 158         hptr = (struct TheHeap *) malloc(sizeof(struct TheHeap));
 159         strcpy(hptr->h_file, tfile);
 160         hptr->h_line = tline;
 161         hptr->next = heap;
 162         hptr->h_ptr = ptr;
 163         heap = hptr;
 164         return ptr;
 165 }
 166
 167 char *tracked_strdup(const char *orig, char *tfile, int tline) {
 168         char *s;
 169
 170         s = tracked_malloc( (strlen(orig)+1), tfile, tline);
 171         if (s == NULL) return NULL;
 172
 173         strcpy(s, orig);
 174         return s;
 175 }
 176
 177 void tracked_free(void *ptr) {
 178         struct TheHeap *hptr, *freeme;
 179
 180         if (heap->h_ptr == ptr) {
 181                 hptr = heap->next;
 182                 free(heap);
 183                 heap = hptr;
 184         }
 185         else {
 186                 for (hptr=heap; hptr->next!=NULL; hptr=hptr->next) {
 187                         if (hptr->next->h_ptr == ptr) {
 188                                 freeme = hptr->next;
 189                                 hptr->next = hptr->next->next;
 190                                 free(freeme);
 191                         }
 192                 }
 193         }
 194
 195         free(ptr);
 196 }
 197
 198 void *tracked_realloc(void *ptr, size_t size) {
 199         void *newptr;
 200         struct TheHeap *hptr;
 201
 202         newptr = realloc(ptr, size);
 203
 204         for (hptr=heap; hptr!=NULL; hptr=hptr->next) {
 205                 if (hptr->h_ptr == ptr) hptr->h_ptr = newptr;
 206         }
 207
 208         return newptr;
 209 }
 210
 211
 212 void dump_tracked() {
 213         struct TheHeap *hptr;
 214
 215         cprintf("%d Here's what's allocated...\n", LISTING_FOLLOWS);
 216         for (hptr=heap; hptr!=NULL; hptr=hptr->next) {
 217                 cprintf("%20s %5d\n",
 218                         hptr->h_file, hptr->h_line);
 219         }
 220 #ifdef __GNUC__
 221         malloc_stats();
 222 #endif
 223
 224         cprintf("000\n");
 225 }
 226 #endif
 227
 228
 229 /*
 230  * We used to use master_cleanup() as a signal handler to shut down the server.
 231  * however, master_cleanup() and the functions it calls do some things that
 232  * aren't such a good idea to do from a signal handler: acquiring mutexes,
 233  * playing with signal masks on BSDI systems, etc. so instead we install the
 234  * following signal handler to set a global variable to inform the main loop
 235  * that it's time to call master_cleanup() and exit.
 236  */
 237
 238 volatile int time_to_die = 0;
 239
 240 static RETSIGTYPE signal_cleanup(int signum) {
 241         time_to_die = 1;
 242 }
 243
 244
 245 /*
 246  * Some initialization stuff...
 247  */
 248 void init_sysdep(void) {
 249         int a;
 250
 251 #ifdef HAVE_OPENSSL
 252         init_ssl();
 253 #endif
 254
 255         /* Set up a bunch of semaphores to be used for critical sections */
 256         for (a=0; a<MAX_SEMAPHORES; ++a) {
 257                 pthread_mutex_init(&Critters[a], NULL);
 258         }
 259
 260         /*
 261          * Set up a place to put thread-specific data.
 262          * We only need a single pointer per thread - it points to the
 263          * CitContext structure (in the ContextList linked list) of the
 264          * session to which the calling thread is currently bound.
 265          */
 266         if (pthread_key_create(&MyConKey, NULL) != 0) {
 267                 lprintf(1, "Can't create TSD key!!  %s\n", strerror(errno));
 268         }
 269
 270         /*
 271          * The action for unexpected signals and exceptions should be to
 272          * call signal_cleanup() to gracefully shut down the server.
 273          */
 274         signal(SIGINT, signal_cleanup);
 275         signal(SIGQUIT, signal_cleanup);
 276         signal(SIGHUP, signal_cleanup);
 277         signal(SIGTERM, signal_cleanup);
 278
 279         /*
 280          * Do not shut down the server on broken pipe signals, otherwise the
 281          * whole Citadel service would come down whenever a single client
 282          * socket breaks.
 283          */
 284         signal(SIGPIPE, SIG_IGN);
 285 }
 286
 287
 288 /*
 289  * Obtain a semaphore lock to begin a critical section.
 290  */
 291 void begin_critical_section(int which_one)
 292 {
 293         /* lprintf(9, "begin_critical_section(%d)\n", which_one); */
 294         /* ensure nobody ever tries to do a critical section within a
 295            transaction; this could lead to deadlock. */
 296         cdb_check_handles();
 297         pthread_mutex_lock(&Critters[which_one]);
 298 }
 299
 300 /*
 301  * Release a semaphore lock to end a critical section.
 302  */
 303 void end_critical_section(int which_one)
 304 {
 305         /* lprintf(9, "end_critical_section(%d)\n", which_one); */
 306         pthread_mutex_unlock(&Critters[which_one]);
 307 }
 308
 309
 310
 311 /*
 312  * This is a generic function to set up a master socket for listening on
 313  * a TCP port.  The server shuts down if the bind fails.
 314  *
 315  */
 316 int ig_tcp_server(int port_number, int queue_len)
 317 {
 318         struct sockaddr_in sin;
 319         int s, i;
 320         int actual_queue_len;
 321
 322         actual_queue_len = queue_len;
 323         if (actual_queue_len < 5) actual_queue_len = 5;
 324
 325         memset(&sin, 0, sizeof(sin));
 326         sin.sin_family = AF_INET;
 327         sin.sin_addr.s_addr = INADDR_ANY;
 328         sin.sin_port = htons((u_short)port_number);
 329
 330         s = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP);
 331
 332         if (s < 0) {
 333                 lprintf(1, "citserver: Can't create a socket: %s\n",
 334                         strerror(errno));
 335                 return(-1);
 336         }
 337
 338         i = 1;
 339         setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
 340
 341         if (bind(s, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
 342                 lprintf(1, "citserver: Can't bind: %s\n",
 343                         strerror(errno));
 344                 close(s);
 345                 return(-1);
 346         }
 347
 348         if (listen(s, actual_queue_len) < 0) {
 349                 lprintf(1, "citserver: Can't listen: %s\n", strerror(errno));
 350                 close(s);
 351                 return(-1);
 352         }
 353
 354         return(s);
 355 }
 356
 357
 358
 359 /*
 360  * Create a Unix domain socket and listen on it
 361  */
 362 int ig_uds_server(char *sockpath, int queue_len)
 363 {
 364         struct sockaddr_un addr;
 365         int s;
 366         int i;
 367         int actual_queue_len;
 368
 369         actual_queue_len = queue_len;
 370         if (actual_queue_len < 5) actual_queue_len = 5;
 371
 372         i = unlink(sockpath);
 373         if (i != 0) if (errno != ENOENT) {
 374                 lprintf(1, "citserver: can't unlink %s: %s\n",
 375                         sockpath, strerror(errno));
 376                 return(-1);
 377         }
 378
 379         memset(&addr, 0, sizeof(addr));
 380         addr.sun_family = AF_UNIX;
 381         safestrncpy(addr.sun_path, sockpath, sizeof addr.sun_path);
 382
 383         s = socket(AF_UNIX, SOCK_STREAM, 0);
 384         if (s < 0) {
 385                 lprintf(1, "citserver: Can't create a socket: %s\n",
 386                         strerror(errno));
 387                 return(-1);
 388         }
 389
 390         if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
 391                 lprintf(1, "citserver: Can't bind: %s\n",
 392                         strerror(errno));
 393                 return(-1);
 394         }
 395
 396         if (listen(s, actual_queue_len) < 0) {
 397                 lprintf(1, "citserver: Can't listen: %s\n", strerror(errno));
 398                 return(-1);
 399         }
 400
 401         chmod(sockpath, 0777);
 402         return(s);
 403 }
 404
 405
 406
 407 /*
 408  * Return a pointer to the CitContext structure bound to the thread which
 409  * called this function.  If there's no such binding (for example, if it's
 410  * called by the housekeeper thread) then a generic 'master' CC is returned.
 411  */
 412 struct CitContext *MyContext(void) {
 413         struct CitContext *retCC;
 414         retCC = (struct CitContext *) pthread_getspecific(MyConKey);
 415         if (retCC == NULL) retCC = &masterCC;
 416         return(retCC);
 417 }
 418
 419
 420 /*
 421  * Initialize a new context and place it in the list.  The session number
 422  * used to be the PID (which is why it's called cs_pid), but that was when we
 423  * had one process per session.  Now we just assign them sequentially, starting
 424  * at 1 (don't change it to 0 because masterCC uses 0) and re-using them when
 425  * sessions terminate.
 426  */
 427 struct CitContext *CreateNewContext(void) {
 428         struct CitContext *me, *ptr;
 429
 430         me = (struct CitContext *) mallok(sizeof(struct CitContext));
 431         if (me == NULL) {
 432                 lprintf(1, "citserver: can't allocate memory!!\n");
 433                 return NULL;
 434         }
 435         memset(me, 0, sizeof(struct CitContext));
 436
 437         /* The new context will be created already in the CON_EXECUTING state
 438          * in order to prevent another thread from grabbing it while it's
 439          * being set up.
 440          */
 441         me->state = CON_EXECUTING;
 442
 443
 444         /*
 445          * Generate a unique session number and insert this context into
 446          * the list.
 447          */
 448         begin_critical_section(S_SESSION_TABLE);
 449
 450         if (ContextList == NULL) {
 451                 ContextList = me;
 452                 me->cs_pid = 1;
 453                 me->next = NULL;
 454         }
 455
 456         else if (ContextList->cs_pid > 1) {
 457                 me->next = ContextList;
 458                 ContextList = me;
 459                 me->cs_pid = 1;
 460         }
 461
 462         else {
 463                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
 464                         if (ptr->next == NULL) {
 465                                 ptr->next = me;
 466                                 me->cs_pid = ptr->cs_pid + 1;
 467                                 me->next = NULL;
 468                                 goto DONE;
 469                         }
 470                         else if (ptr->next->cs_pid > (ptr->cs_pid+1)) {
 471                                 me->next = ptr->next;
 472                                 ptr->next = me;
 473                                 me->cs_pid = ptr->cs_pid + 1;
 474                                 goto DONE;
 475                         }
 476                 }
 477         }
 478
 479 DONE:   ++num_sessions;
 480         end_critical_section(S_SESSION_TABLE);
 481         return(me);
 482 }
 483
 484
 485 /*
 486  * client_write()   ...    Send binary data to the client.
 487  */
 488 void client_write(char *buf, int nbytes)
 489 {
 490         int bytes_written = 0;
 491         int retval;
 492         int sock;
 493
 494         if (CC->redirect_fp != NULL) {
 495                 fwrite(buf, nbytes, 1, CC->redirect_fp);
 496                 return;
 497         }
 498
 499         if (CC->redirect_sock > 0) {
 500                 sock = CC->redirect_sock;       /* and continue below... */
 501         }
 502         else {
 503                 sock = CC->client_socket;
 504         }
 505
 506 #ifdef HAVE_OPENSSL
 507         if (CC->redirect_ssl) {
 508                 client_write_ssl(buf, nbytes);
 509                 return;
 510         }
 511 #endif
 512
 513         while (bytes_written < nbytes) {
 514                 retval = write(sock, &buf[bytes_written],
 515                         nbytes - bytes_written);
 516                 if (retval < 1) {
 517                         lprintf(2, "client_write() failed: %s\n",
 518                                 strerror(errno));
 519                         if (sock == CC->client_socket) CC->kill_me = 1;
 520                         return;
 521                 }
 522                 bytes_written = bytes_written + retval;
 523         }
 524 }
 525
 526
 527 /*
 528  * cprintf()  ...   Send formatted printable data to the client.   It is
 529  *                  implemented in terms of client_write() but remains in
 530  *                  sysdep.c in case we port to somewhere without va_args...
 531  */
 532 void cprintf(const char *format, ...) {
 533         va_list arg_ptr;
 534         char buf[SIZ];
 535
 536         va_start(arg_ptr, format);
 537         if (vsnprintf(buf, sizeof buf, format, arg_ptr) == -1)
 538                 buf[sizeof buf - 2] = '\n';
 539         client_write(buf, strlen(buf));
 540         va_end(arg_ptr);
 541 }
 542
 543
 544 /*
 545  * Read data from the client socket.
 546  * Return values are:
 547  *      1       Requested number of bytes has been read.
 548  *      0       Request timed out.
 549  *      -1      The socket is broken.
 550  * If the socket breaks, the session will be terminated.
 551  */
 552 int client_read_to(char *buf, int bytes, int timeout)
 553 {
 554         int len,rlen;
 555         fd_set rfds;
 556         struct timeval tv;
 557         int retval;
 558
 559 #ifdef HAVE_OPENSSL
 560         if (CC->redirect_ssl) {
 561                 return (client_read_ssl(buf, bytes, timeout));
 562         }
 563 #endif
 564         len = 0;
 565         while(len<bytes) {
 566                 FD_ZERO(&rfds);
 567                 FD_SET(CC->client_socket, &rfds);
 568                 tv.tv_sec = timeout;
 569                 tv.tv_usec = 0;
 570
 571                 retval = select( (CC->client_socket)+1,
 572                                         &rfds, NULL, NULL, &tv);
 573
 574                 if (FD_ISSET(CC->client_socket, &rfds) == 0) {
 575                         return(0);
 576                 }
 577
 578                 rlen = read(CC->client_socket, &buf[len], bytes-len);
 579                 if (rlen<1) {
 580                         lprintf(2, "client_read() failed: %s\n",
 581                                 strerror(errno));
 582                         CC->kill_me = 1;
 583                         return(-1);
 584                 }
 585                 len = len + rlen;
 586         }
 587         return(1);
 588 }
 589
 590 /*
 591  * Read data from the client socket with default timeout.
 592  * (This is implemented in terms of client_read_to() and could be
 593  * justifiably moved out of sysdep.c)
 594  */
 595 inline int client_read(char *buf, int bytes)
 596 {
 597         return(client_read_to(buf, bytes, config.c_sleeping));
 598 }
 599
 600
 601 /*
 602  * client_gets()   ...   Get a LF-terminated line of text from the client.
 603  * (This is implemented in terms of client_read() and could be
 604  * justifiably moved out of sysdep.c)
 605  */
 606 int client_gets(char *buf)
 607 {
 608         int i, retval;
 609
 610         /* Read one character at a time.
 611          */
 612         for (i = 0;;i++) {
 613                 retval = client_read(&buf[i], 1);
 614                 if (retval != 1 || buf[i] == '\n' || i == (SIZ-1))
 615                         break;
 616         }
 617
 618         /* If we got a long line, discard characters until the newline.
 619          */
 620         if (i == (SIZ-1))
 621                 while (buf[i] != '\n' && retval == 1)
 622                         retval = client_read(&buf[i], 1);
 623
 624         /* Strip the trailing newline and any trailing nonprintables (cr's)
 625          */
 626         buf[i] = 0;
 627         while ((strlen(buf)>0)&&(!isprint(buf[strlen(buf)-1])))
 628                 buf[strlen(buf)-1] = 0;
 629         if (retval < 0) strcpy(buf, "000");
 630         return(retval);
 631 }
 632
 633
 634
 635 /*
 636  * The system-dependent part of master_cleanup() - close the master socket.
 637  */
 638 void sysdep_master_cleanup(void) {
 639         struct ServiceFunctionHook *serviceptr;
 640
 641         /*
 642          * close all protocol master sockets
 643          */
 644         for (serviceptr = ServiceHookTable; serviceptr != NULL;
 645             serviceptr = serviceptr->next ) {
 646
 647                 if (serviceptr->tcp_port > 0)
 648                         lprintf(3, "Closing listener on port %d\n",
 649                                 serviceptr->tcp_port);
 650
 651                 if (serviceptr->sockpath != NULL)
 652                         lprintf(3, "Closing listener on '%s'\n",
 653                                 serviceptr->sockpath);
 654
 655                 close(serviceptr->msock);
 656
 657                 /* If it's a Unix domain socket, remove the file. */
 658                 if (serviceptr->sockpath != NULL) {
 659                         unlink(serviceptr->sockpath);
 660                 }
 661         }
 662 }
 663
 664
 665 /*
 666  * Terminate another session.
 667  * (This could justifiably be moved out of sysdep.c because it
 668  * no longer does anything that is system-dependent.)
 669  */
 670 void kill_session(int session_to_kill) {
 671         struct CitContext *ptr;
 672
 673         begin_critical_section(S_SESSION_TABLE);
 674         for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
 675                 if (ptr->cs_pid == session_to_kill) {
 676                         ptr->kill_me = 1;
 677                 }
 678         }
 679         end_critical_section(S_SESSION_TABLE);
 680 }
 681
 682
 683
 684
 685 /*
 686  * Start running as a daemon.  Only close stdio if do_close_stdio is set.
 687  */
 688 void start_daemon(int do_close_stdio) {
 689         if (do_close_stdio) {
 690                 /* close(0); */
 691                 close(1);
 692                 close(2);
 693         }
 694         signal(SIGHUP,SIG_IGN);
 695         signal(SIGINT,SIG_IGN);
 696         signal(SIGQUIT,SIG_IGN);
 697         if (fork()!=0) exit(0);
 698 }
 699
 700
 701
 702 /*
 703  * Generic routine to convert a login name to a full name (gecos)
 704  * Returns nonzero if a conversion took place
 705  */
 706 int convert_login(char NameToConvert[]) {
 707         struct passwd *pw;
 708         int a;
 709
 710         pw = getpwnam(NameToConvert);
 711         if (pw == NULL) {
 712                 return(0);
 713         }
 714         else {
 715                 strcpy(NameToConvert, pw->pw_gecos);
 716                 for (a=0; a<strlen(NameToConvert); ++a) {
 717                         if (NameToConvert[a] == ',') NameToConvert[a] = 0;
 718                 }
 719                 return(1);
 720         }
 721 }
 722
 723 struct worker_node *worker_list = NULL;
 724
 725
 726 /*
 727  * create a worker thread. this function must always be called from within
 728  * an S_WORKER_LIST critical section!
 729  */
 730 void create_worker(void) {
 731         int ret;
 732         struct worker_node *n;
 733         pthread_attr_t attr;
 734
 735         n = mallok(sizeof(struct worker_node));
 736         if (n == NULL) {
 737                 lprintf(1, "can't allocate worker_node, exiting\n");
 738                 time_to_die = -1;
 739                 return;
 740         }
 741
 742         if ((ret = pthread_attr_init(&attr))) {
 743                 lprintf(1, "pthread_attr_init: %s\n", strerror(ret));
 744                 time_to_die = -1;
 745                 return;
 746         }
 747
 748         /* we seem to need something bigger than FreeBSD's default 64k stack */
 749
 750         if ((ret = pthread_attr_setstacksize(&attr, 128 * 1024))) {
 751                 lprintf(1, "pthread_attr_setstacksize: %s\n", strerror(ret));
 752                 time_to_die = -1;
 753                 return;
 754         }
 755
 756         if ((ret = pthread_create(&n->tid, &attr, worker_thread, NULL) != 0))
 757         {
 758
 759                 lprintf(1, "Can't create worker thread: %s\n",
 760                         strerror(ret));
 761         }
 762
 763         n->next = worker_list;
 764         worker_list = n;
 765 }
 766
 767
 768
 769 /*
 770  * Purge all sessions which have the 'kill_me' flag set.
 771  * This function has code to prevent it from running more than once every
 772  * few seconds, because running it after every single unbind would waste a lot
 773  * of CPU time and keep the context list locked too much.
 774  *
 775  * After that's done, we raise or lower the size of the worker thread pool
 776  * if such an action is appropriate.
 777  */
 778 void dead_session_purge(void) {
 779         struct CitContext *ptr, *rem;
 780         struct worker_node **node, *tmp;
 781         pthread_t self;
 782
 783         if ( (time(NULL) - last_purge) < 5 ) return;    /* Too soon, go away */
 784         time(&last_purge);
 785
 786         do {
 787                 rem = NULL;
 788                 begin_critical_section(S_SESSION_TABLE);
 789                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
 790                         if ( (ptr->state == CON_IDLE) && (ptr->kill_me) ) {
 791                                 rem = ptr;
 792                         }
 793                 }
 794                 end_critical_section(S_SESSION_TABLE);
 795
 796                 /* RemoveContext() enters its own S_SESSION_TABLE critical
 797                  * section, so we have to do it like this.
 798                  */
 799                 if (rem != NULL) {
 800                         lprintf(9, "Purging session %d\n", rem->cs_pid);
 801                         RemoveContext(rem);
 802                 }
 803
 804         } while (rem != NULL);
 805
 806
 807         /* Raise or lower the size of the worker thread pool if such
 808          * an action is appropriate.
 809          */
 810
 811         self = pthread_self();
 812
 813         if ( (num_sessions > num_threads)
 814            && (num_threads < config.c_max_workers) ) {
 815                 begin_critical_section(S_WORKER_LIST);
 816                 create_worker();
 817                 end_critical_section(S_WORKER_LIST);
 818         }
 819
 820         /* don't let the initial thread die since it's responsible for
 821            waiting for all the other threads to terminate. */
 822         else if ( (num_sessions < num_threads)
 823            && (num_threads > config.c_min_workers)
 824            && (self != initial_thread) ) {
 825                 cdb_free_tsd();
 826                 begin_critical_section(S_WORKER_LIST);
 827                 --num_threads;
 828
 829                 /* we're exiting before server shutdown... unlink ourself from
 830                    the worker list and detach our thread to avoid memory leaks
 831                  */
 832
 833                 for (node = &worker_list; *node != NULL; node = &(*node)->next)
 834                         if ((*node)->tid == self) {
 835                                 tmp = *node;
 836                                 *node = (*node)->next;
 837                                 phree(tmp);
 838                                 break;
 839                         }
 840
 841                 pthread_detach(self);
 842                 end_critical_section(S_WORKER_LIST);
 843                 pthread_exit(NULL);
 844         }
 845
 846 }
 847
 848
 849
 850
 851
 852 /*
 853  * Redirect a session's output to a file or socket.
 854  * This function may be called with a file handle *or* a socket (but not
 855  * both).  Call with neither to return output to its normal client socket.
 856  */
 857 void CtdlRedirectOutput(FILE *fp, int sock) {
 858
 859         if (fp != NULL) CC->redirect_fp = fp;
 860         else CC->redirect_fp = NULL;
 861
 862         if (sock > 0) CC->redirect_sock = sock;
 863         else CC->redirect_sock = (-1);
 864
 865 }
 866
 867
 868 /*
 869  * masterCC is the context we use when not attached to a session.  This
 870  * function initializes it.
 871  */
 872 void InitializeMasterCC(void) {
 873         memset(&masterCC, 0, sizeof(struct CitContext));
 874         masterCC.internal_pgm = 1;
 875         masterCC.cs_pid = 0;
 876 }
 877
 878
 879
 880 /*
 881  * Set up a fd_set containing all the master sockets to which we
 882  * always listen.  It's computationally less expensive to just copy
 883  * this to a local fd_set when starting a new select() and then add
 884  * the client sockets than it is to initialize a new one and then
 885  * figure out what to put there.
 886  */
 887 void init_master_fdset(void) {
 888         struct ServiceFunctionHook *serviceptr;
 889         int m;
 890
 891         lprintf(9, "Initializing master fdset\n");
 892
 893         FD_ZERO(&masterfds);
 894         masterhighest = 0;
 895
 896         lprintf(9, "Will listen on rescan pipe %d\n", rescan[0]);
 897         FD_SET(rescan[0], &masterfds);
 898         if (rescan[0] > masterhighest) masterhighest = rescan[0];
 899
 900         for (serviceptr = ServiceHookTable; serviceptr != NULL;
 901             serviceptr = serviceptr->next ) {
 902                 m = serviceptr->msock;
 903                 lprintf(9, "Will listen on master socket %d\n", m);
 904                 FD_SET(m, &masterfds);
 905                 if (m > masterhighest) {
 906                         masterhighest = m;
 907                 }
 908         }
 909         lprintf(9, "masterhighest = %d\n", masterhighest);
 910 }
 911
 912
 913 /*
 914  * Bind a thread to a context.  (It's inline merely to speed things up.)
 915  */
 916 INLINE void become_session(struct CitContext *which_con) {
 917         pthread_setspecific(MyConKey, (void *)which_con );
 918 }
 919
 920
 921
 922 /*
 923  * This loop just keeps going and going and going...
 924  */
 925 void *worker_thread(void *arg) {
 926         int i;
 927         char junk;
 928         int highest;
 929         struct CitContext *ptr;
 930         struct CitContext *bind_me = NULL;
 931         fd_set readfds;
 932         int retval;
 933         struct CitContext *con= NULL;   /* Temporary context pointer */
 934         struct ServiceFunctionHook *serviceptr;
 935         struct sockaddr_in fsin;        /* Data for master socket */
 936         int alen;                       /* Data for master socket */
 937         int ssock;                      /* Descriptor for client socket */
 938         struct timeval tv;
 939
 940         num_threads++;
 941
 942         cdb_allocate_tsd();
 943
 944         while (!time_to_die) {
 945
 946                 /*
 947                  * A naive implementation would have all idle threads
 948                  * calling select() and then they'd all wake up at once.  We
 949                  * solve this problem by putting the select() in a critical
 950                  * section, so only one thread has the opportunity to wake
 951                  * up.  If we wake up on a master socket, create a new
 952                  * session context; otherwise, just bind the thread to the
 953                  * context we want and go on our merry way.
 954                  */
 955
 956                 /* make doubly sure we're not holding any stale db handles
 957                  * which might cause a deadlock.
 958                  */
 959                 cdb_check_handles();
 960
 961                 begin_critical_section(S_I_WANNA_SELECT);
 962 SETUP_FD:       memcpy(&readfds, &masterfds, sizeof masterfds);
 963                 highest = masterhighest;
 964                 begin_critical_section(S_SESSION_TABLE);
 965                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
 966                         if (ptr->state == CON_IDLE) {
 967                                 FD_SET(ptr->client_socket, &readfds);
 968                                 if (ptr->client_socket > highest)
 969                                         highest = ptr->client_socket;
 970                         }
 971                 }
 972                 end_critical_section(S_SESSION_TABLE);
 973
 974                 tv.tv_sec = 1;          /* wake up every second if no input */
 975                 tv.tv_usec = 0;
 976
 977                 do_select:
 978                 if (!time_to_die)
 979                         retval = select(highest + 1, &readfds, NULL, NULL, &tv);
 980                 else {
 981                         end_critical_section(S_I_WANNA_SELECT);
 982                         break;
 983                 }
 984
 985                 /* Now figure out who made this select() unblock.
 986                  * First, check for an error or exit condition.
 987                  */
 988                 if (retval < 0) {
 989                         if (errno != EINTR) {
 990                                 lprintf(9, "Exiting (%s)\n", strerror(errno));
 991                                 time_to_die = 1;
 992                         } else if (!time_to_die)
 993                                 goto do_select;
 994                 }
 995
 996                 /* Next, check to see if it's a new client connecting
 997                  * on a master socket.
 998                  */
 999                 else for (serviceptr = ServiceHookTable; serviceptr != NULL;
1000                      serviceptr = serviceptr->next ) {
1001
1002                         if (FD_ISSET(serviceptr->msock, &readfds)) {
1003                                 alen = sizeof fsin;
1004                                 ssock = accept(serviceptr->msock,
1005                                         (struct sockaddr *)&fsin, &alen);
1006                                 if (ssock < 0) {
1007                                         lprintf(2, "citserver: accept(): %s\n",
1008                                                 strerror(errno));
1009                                 }
1010                                 else {
1011                                         lprintf(7, "citserver: "
1012                                                 "New client socket %d\n",
1013                                                 ssock);
1014
1015                                         /* New context will be created already
1016                                         * set up in the CON_EXECUTING state.
1017                                         */
1018                                         con = CreateNewContext();
1019
1020                                         /* Assign new socket number to it. */
1021                                         con->client_socket = ssock;
1022                                         con->h_command_function =
1023                                                 serviceptr->h_command_function;
1024
1025                                         /* Determine whether local socket */
1026                                         if (serviceptr->sockpath != NULL)
1027                                                 con->is_local_socket = 1;
1028
1029                                         /* Set the SO_REUSEADDR socket option */
1030                                         i = 1;
1031                                         setsockopt(ssock, SOL_SOCKET,
1032                                                 SO_REUSEADDR,
1033                                                 &i, sizeof(i));
1034
1035                                         become_session(con);
1036                                         begin_session(con);
1037                                         serviceptr->h_greeting_function();
1038                                         become_session(NULL);
1039                                         con->state = CON_IDLE;
1040                                         goto SETUP_FD;
1041                                 }
1042                         }
1043                 }
1044
1045                 /* If the rescan pipe went active, someone is telling this
1046                  * thread that the &readfds needs to be refreshed with more
1047                  * current data.
1048                  */
1049                 if (time_to_die) {
1050                         end_critical_section(S_I_WANNA_SELECT);
1051                         break;
1052                 }
1053
1054                 if (FD_ISSET(rescan[0], &readfds)) {
1055                         read(rescan[0], &junk, 1);
1056                         goto SETUP_FD;
1057                 }
1058
1059                 /* It must be a client socket.  Find a context that has data
1060                  * waiting on its socket *and* is in the CON_IDLE state.
1061                  */
1062                 else {
1063                         bind_me = NULL;
1064                         begin_critical_section(S_SESSION_TABLE);
1065                         for (ptr = ContextList;
1066                             ( (ptr != NULL) && (bind_me == NULL) );
1067                             ptr = ptr->next) {
1068                                 if ( (FD_ISSET(ptr->client_socket, &readfds))
1069                                    && (ptr->state == CON_IDLE) ) {
1070                                         bind_me = ptr;
1071                                 }
1072                         }
1073                         if (bind_me != NULL) {
1074                                 /* Found one.  Stake a claim to it before
1075                                  * letting anyone else touch the context list.
1076                                  */
1077                                 bind_me->state = CON_EXECUTING;
1078                         }
1079
1080                         end_critical_section(S_SESSION_TABLE);
1081                         end_critical_section(S_I_WANNA_SELECT);
1082
1083                         /* We're bound to a session, now do *one* command */
1084                         if (bind_me != NULL) {
1085                                 become_session(bind_me);
1086                                 CC->h_command_function();
1087                                 become_session(NULL);
1088                                 bind_me->state = CON_IDLE;
1089                                 if (bind_me->kill_me == 1) {
1090                                         RemoveContext(bind_me);
1091                                 }
1092                                 write(rescan[1], &junk, 1);
1093                         }
1094
1095                 }
1096                 dead_session_purge();
1097                 do_housekeeping();
1098                 check_sched_shutdown();
1099         }
1100
1101         /* If control reaches this point, the server is shutting down */
1102         --num_threads;
1103         return NULL;
1104 }