citadel/sysdep.c

   1 /*
   2  * Citadel/UX "system dependent" stuff.
   3  * See copyright.txt for copyright information.
   4  *
   5  * $Id$
   6  *
   7  * Here's where we (hopefully) have all the parts of the Citadel server that
   8  * would need to be altered to run the server in a non-POSIX environment.
   9  *
  10  * Eventually we'll try porting to a different platform and either have
  11  * multiple 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/wait.h>
  24 #include <sys/socket.h>
  25 #include <sys/time.h>
  26 #include <limits.h>
  27 #include <netinet/in.h>
  28 #include <netdb.h>
  29 #include <string.h>
  30 #include <pwd.h>
  31 #include <errno.h>
  32 #include <stdarg.h>
  33 #include <syslog.h>
  34 #include <grp.h>
  35 #ifdef __GNUC__
  36 #include <malloc.h>
  37 #endif
  38 #ifdef HAVE_PTHREAD_H
  39 #include <pthread.h>
  40 #endif
  41 #include "citadel.h"
  42 #include "server.h"
  43 #include "sysdep_decls.h"
  44 #include "citserver.h"
  45 #include "support.h"
  46 #include "config.h"
  47 #include "database.h"
  48 #include "housekeeping.h"
  49 #include "dynloader.h"
  50 #include "tools.h"
  51
  52 #ifdef HAVE_SYS_SELECT_H
  53 #include <sys/select.h>
  54 #endif
  55
  56 #ifndef HAVE_SNPRINTF
  57 #include "snprintf.h"
  58 #endif
  59
  60 #ifdef DEBUG_MEMORY_LEAKS
  61 struct TheHeap *heap = NULL;
  62 #endif
  63
  64 pthread_mutex_t Critters[MAX_SEMAPHORES];       /* Things needing locking */
  65 pthread_key_t MyConKey;                         /* TSD key for MyContext() */
  66
  67 int msock;                                      /* master listening socket */
  68 int verbosity = DEFAULT_VERBOSITY;              /* Logging level */
  69
  70 struct CitContext masterCC;
  71 int rescan[2];                                  /* The Rescan Pipe */
  72 time_t last_purge = 0;                          /* Last dead session purge */
  73 int num_threads = 0;                            /* Current number of threads */
  74 int num_sessions = 0;                           /* Current number of sessions */
  75
  76 /*
  77  * lprintf()  ...   Write logging information
  78  */
  79 void lprintf(int loglevel, const char *format, ...) {
  80         va_list arg_ptr;
  81         char buf[512];
  82
  83         va_start(arg_ptr, format);
  84         vsprintf(buf, format, arg_ptr);
  85         va_end(arg_ptr);
  86
  87         if (loglevel <= verbosity) {
  88                 fprintf(stderr, "%s", buf);
  89                 fflush(stderr);
  90                 }
  91
  92         PerformLogHooks(loglevel, buf);
  93         }
  94
  95
  96
  97 #ifdef DEBUG_MEMORY_LEAKS
  98 void *tracked_malloc(size_t tsize, char *tfile, int tline) {
  99         void *ptr;
 100         struct TheHeap *hptr;
 101
 102         ptr = malloc(tsize);
 103         if (ptr == NULL) {
 104                 lprintf(3, "DANGER!  mallok(%d) at %s:%d failed!\n",
 105                         tsize, tfile, tline);
 106                 return(NULL);
 107         }
 108
 109         hptr = (struct TheHeap *) malloc(sizeof(struct TheHeap));
 110         strcpy(hptr->h_file, tfile);
 111         hptr->h_line = tline;
 112         hptr->next = heap;
 113         hptr->h_ptr = ptr;
 114         heap = hptr;
 115         return ptr;
 116         }
 117
 118 char *tracked_strdup(const char *orig, char *tfile, int tline) {
 119         char *s;
 120
 121         s = tracked_malloc( (strlen(orig)+1), tfile, tline);
 122         if (s == NULL) return NULL;
 123
 124         strcpy(s, orig);
 125         return s;
 126 }
 127
 128 void tracked_free(void *ptr) {
 129         struct TheHeap *hptr, *freeme;
 130
 131         if (heap->h_ptr == ptr) {
 132                 hptr = heap->next;
 133                 free(heap);
 134                 heap = hptr;
 135                 }
 136         else {
 137                 for (hptr=heap; hptr->next!=NULL; hptr=hptr->next) {
 138                         if (hptr->next->h_ptr == ptr) {
 139                                 freeme = hptr->next;
 140                                 hptr->next = hptr->next->next;
 141                                 free(freeme);
 142                                 }
 143                         }
 144                 }
 145
 146         free(ptr);
 147         }
 148
 149 void *tracked_realloc(void *ptr, size_t size) {
 150         void *newptr;
 151         struct TheHeap *hptr;
 152
 153         newptr = realloc(ptr, size);
 154
 155         for (hptr=heap; hptr!=NULL; hptr=hptr->next) {
 156                 if (hptr->h_ptr == ptr) hptr->h_ptr = newptr;
 157                 }
 158
 159         return newptr;
 160         }
 161
 162
 163 void dump_tracked() {
 164         struct TheHeap *hptr;
 165
 166         cprintf("%d Here's what's allocated...\n", LISTING_FOLLOWS);
 167         for (hptr=heap; hptr!=NULL; hptr=hptr->next) {
 168                 cprintf("%20s %5d\n",
 169                         hptr->h_file, hptr->h_line);
 170                 }
 171 #ifdef __GNUC__
 172         malloc_stats();
 173 #endif
 174
 175         cprintf("000\n");
 176         }
 177 #endif
 178
 179
 180 /*
 181  * we used to use master_cleanup() as a signal handler to shut down the server.
 182  * however, master_cleanup() and the functions it calls do some things that
 183  * aren't such a good idea to do from a signal handler: acquiring mutexes,
 184  * playing with signal masks on BSDI systems, etc. so instead we install the
 185  * following signal handler to set a global variable to inform the main loop
 186  * that it's time to call master_cleanup() and exit.
 187  */
 188
 189 static volatile int time_to_die = 0;
 190
 191 static RETSIGTYPE signal_cleanup(int signum) {
 192         time_to_die = 1;
 193 }
 194
 195
 196 /*
 197  * Some initialization stuff...
 198  */
 199 void init_sysdep(void) {
 200         int a;
 201
 202         /* Set up a bunch of semaphores to be used for critical sections */
 203         for (a=0; a<MAX_SEMAPHORES; ++a) {
 204                 pthread_mutex_init(&Critters[a], NULL);
 205         }
 206
 207         /*
 208          * Set up a place to put thread-specific data.
 209          * We only need a single pointer per thread - it points to the
 210          * thread's CitContext structure in the ContextList linked list.
 211          */
 212         if (pthread_key_create(&MyConKey, NULL) != 0) {
 213                 lprintf(1, "Can't create TSD key!!  %s\n", strerror(errno));
 214         }
 215
 216         /*
 217          * The action for unexpected signals and exceptions should be to
 218          * call signal_cleanup() to gracefully shut down the server.
 219          */
 220         signal(SIGINT, signal_cleanup);
 221         signal(SIGQUIT, signal_cleanup);
 222         signal(SIGHUP, signal_cleanup);
 223         signal(SIGTERM, signal_cleanup);
 224
 225         /*
 226          * Do not shut down the server on broken pipe signals, otherwise the
 227          * whole Citadel service would come down whenever a single client
 228          * socket breaks.
 229          */
 230         signal(SIGPIPE, SIG_IGN);
 231 }
 232
 233
 234 /*
 235  * Obtain a semaphore lock to begin a critical section.
 236  */
 237 void begin_critical_section(int which_one)
 238 {
 239         pthread_mutex_lock(&Critters[which_one]);
 240 }
 241
 242 /*
 243  * Release a semaphore lock to end a critical section.
 244  */
 245 void end_critical_section(int which_one)
 246 {
 247         pthread_mutex_unlock(&Critters[which_one]);
 248 }
 249
 250
 251
 252 /*
 253  * This is a generic function to set up a master socket for listening on
 254  * a TCP port.  The server shuts down if the bind fails.
 255  */
 256 int ig_tcp_server(int port_number, int queue_len)
 257 {
 258         struct sockaddr_in sin;
 259         int s, i;
 260
 261         memset(&sin, 0, sizeof(sin));
 262         sin.sin_family = AF_INET;
 263         sin.sin_addr.s_addr = INADDR_ANY;
 264
 265         if (port_number == 0) {
 266                 lprintf(1,
 267                         "citserver: No port number specified.  Run setup.\n");
 268                 exit(1);
 269         }
 270
 271         sin.sin_port = htons((u_short)port_number);
 272
 273         s = socket(PF_INET, SOCK_STREAM, (getprotobyname("tcp")->p_proto));
 274         if (s < 0) {
 275                 lprintf(1, "citserver: Can't create a socket: %s\n",
 276                         strerror(errno));
 277                 exit(errno);
 278         }
 279
 280         /* Set the SO_REUSEADDR socket option, because it makes sense. */
 281         i = 1;
 282         setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
 283
 284         if (bind(s, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
 285                 lprintf(1, "citserver: Can't bind: %s\n", strerror(errno));
 286                 exit(errno);
 287         }
 288
 289         if (listen(s, queue_len) < 0) {
 290                 lprintf(1, "citserver: Can't listen: %s\n", strerror(errno));
 291                 exit(errno);
 292         }
 293
 294         return(s);
 295 }
 296
 297
 298
 299 /*
 300  * Return a pointer to the CitContext structure bound to the thread which
 301  * called this function.  If there's no such binding (for example, if it's
 302  * called by the housekeeper thread) then a generic 'master' CC is returned.
 303  */
 304 struct CitContext *MyContext(void) {
 305         struct CitContext *retCC;
 306         retCC = (struct CitContext *) pthread_getspecific(MyConKey);
 307         if (retCC == NULL) retCC = &masterCC;
 308         return(retCC);
 309 }
 310
 311
 312 /*
 313  * Initialize a new context and place it in the list.
 314  */
 315 struct CitContext *CreateNewContext(void) {
 316         struct CitContext *me, *ptr;
 317         int num = 1;
 318         int startover = 0;
 319
 320         me = (struct CitContext *) mallok(sizeof(struct CitContext));
 321         if (me == NULL) {
 322                 lprintf(1, "citserver: can't allocate memory!!\n");
 323                 return NULL;
 324         }
 325         memset(me, 0, sizeof(struct CitContext));
 326
 327         /* The new context will be created already in the CON_EXECUTING state
 328          * in order to prevent another thread from grabbing it while it's
 329          * being set up.
 330          */
 331         me->state = CON_EXECUTING;
 332
 333         begin_critical_section(S_SESSION_TABLE);
 334
 335         /* obtain a unique session number */
 336         do {
 337                 startover = 0;
 338                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
 339                         if (ptr->cs_pid == num) {
 340                                 ++num;
 341                                 startover = 1;
 342                         }
 343                 }
 344         } while (startover == 1);
 345
 346         me->cs_pid = num;
 347         me->next = ContextList;
 348         ContextList = me;
 349         ++num_sessions;
 350
 351         end_critical_section(S_SESSION_TABLE);
 352         return(me);
 353 }
 354
 355
 356
 357 /*
 358  * client_write()   ...    Send binary data to the client.
 359  */
 360 void client_write(char *buf, int nbytes)
 361 {
 362         int bytes_written = 0;
 363         int retval;
 364         while (bytes_written < nbytes) {
 365                 retval = write(CC->client_socket, &buf[bytes_written],
 366                         nbytes - bytes_written);
 367                 if (retval < 1) {
 368                         lprintf(2, "client_write() failed: %s\n",
 369                                 strerror(errno));
 370                         CC->kill_me = 1;
 371                         return;
 372                 }
 373                 bytes_written = bytes_written + retval;
 374         }
 375 }
 376
 377
 378 /*
 379  * cprintf()  ...   Send formatted printable data to the client.   It is
 380  *                  implemented in terms of client_write() but remains in
 381  *                  sysdep.c in case we port to somewhere without va_args...
 382  */
 383 void cprintf(const char *format, ...) {
 384         va_list arg_ptr;
 385         char buf[256];
 386
 387         va_start(arg_ptr, format);
 388         if (vsnprintf(buf, sizeof buf, format, arg_ptr) == -1)
 389                 buf[sizeof buf - 2] = '\n';
 390         client_write(buf, strlen(buf));
 391         va_end(arg_ptr);
 392 }
 393
 394
 395 /*
 396  * Read data from the client socket.
 397  * Return values are:
 398  *      1       Requested number of bytes has been read.
 399  *      0       Request timed out.
 400  * If the socket breaks, the session is immediately terminated.
 401  */
 402 int client_read_to(char *buf, int bytes, int timeout)
 403 {
 404         int len,rlen;
 405         fd_set rfds;
 406         struct timeval tv;
 407         int retval;
 408
 409         len = 0;
 410         while(len<bytes) {
 411                 FD_ZERO(&rfds);
 412                 FD_SET(CC->client_socket, &rfds);
 413                 tv.tv_sec = timeout;
 414                 tv.tv_usec = 0;
 415
 416                 retval = select( (CC->client_socket)+1,
 417                                         &rfds, NULL, NULL, &tv);
 418
 419                 if (FD_ISSET(CC->client_socket, &rfds) == 0) {
 420                         return(0);
 421                 }
 422
 423                 rlen = read(CC->client_socket, &buf[len], bytes-len);
 424                 if (rlen<1) {
 425                         lprintf(2, "client_read() failed: %s\n",
 426                                 strerror(errno));
 427                         CC->kill_me = 1;
 428                         return(-1);
 429                 }
 430                 len = len + rlen;
 431         }
 432         return(1);
 433 }
 434
 435 /*
 436  * Read data from the client socket with default timeout.
 437  * (This is implemented in terms of client_read_to() and could be
 438  * justifiably moved out of sysdep.c)
 439  */
 440 int client_read(char *buf, int bytes)
 441 {
 442         return(client_read_to(buf, bytes, config.c_sleeping));
 443 }
 444
 445
 446 /*
 447  * client_gets()   ...   Get a LF-terminated line of text from the client.
 448  * (This is implemented in terms of client_read() and could be
 449  * justifiably moved out of sysdep.c)
 450  */
 451 int client_gets(char *buf)
 452 {
 453         int i, retval;
 454
 455         /* Read one character at a time.
 456          */
 457         for (i = 0;;i++) {
 458                 retval = client_read(&buf[i], 1);
 459                 if (retval != 1 || buf[i] == '\n' || i == 255)
 460                         break;
 461         }
 462
 463         /* If we got a long line, discard characters until the newline.
 464          */
 465         if (i == 255)
 466                 while (buf[i] != '\n' && retval == 1)
 467                         retval = client_read(&buf[i], 1);
 468
 469         /* Strip the trailing newline and any trailing nonprintables (cr's)
 470          */
 471         buf[i] = 0;
 472         while ((strlen(buf)>0)&&(!isprint(buf[strlen(buf)-1])))
 473                 buf[strlen(buf)-1] = 0;
 474         return(retval);
 475 }
 476
 477
 478
 479 /*
 480  * The system-dependent part of master_cleanup() - close the master socket.
 481  */
 482 void sysdep_master_cleanup(void) {
 483         lprintf(7, "Closing master socket %d\n", msock);
 484         close(msock);
 485 }
 486
 487
 488 /*
 489  * Terminate another session.
 490  * (This could justifiably be moved out of sysdep.c because it
 491  * no longer does anything that is system-dependent.)
 492  */
 493 void kill_session(int session_to_kill) {
 494         struct CitContext *ptr;
 495
 496         begin_critical_section(S_SESSION_TABLE);
 497         for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
 498                 if (ptr->cs_pid == session_to_kill) {
 499                         ptr->kill_me = 1;
 500                 }
 501         }
 502         end_critical_section(S_SESSION_TABLE);
 503 }
 504
 505
 506
 507
 508 /*
 509  * Start running as a daemon.  Only close stdio if do_close_stdio is set.
 510  */
 511 void start_daemon(int do_close_stdio) {
 512         if (do_close_stdio) {
 513                 /* close(0); */
 514                 close(1);
 515                 close(2);
 516         }
 517         signal(SIGHUP,SIG_IGN);
 518         signal(SIGINT,SIG_IGN);
 519         signal(SIGQUIT,SIG_IGN);
 520         if (fork()!=0) exit(0);
 521 }
 522
 523
 524
 525 /*
 526  * Tie in to the 'netsetup' program.
 527  *
 528  * (We're going to hope that netsetup never feeds more than 4096 bytes back.)
 529  */
 530 void cmd_nset(char *cmdbuf)
 531 {
 532         int retcode;
 533         char fbuf[4096];
 534         FILE *netsetup;
 535         int ch;
 536         int a, b;
 537         char netsetup_args[3][256];
 538
 539         if (CC->usersupp.axlevel < 6) {
 540                 cprintf("%d Higher access required.\n",
 541                         ERROR + HIGHER_ACCESS_REQUIRED);
 542                 return;
 543         }
 544
 545         for (a=1; a<=3; ++a) {
 546                 if (num_parms(cmdbuf) >= a) {
 547                         extract(netsetup_args[a-1], cmdbuf, a-1);
 548                         for (b=0; b<strlen(netsetup_args[a-1]); ++b) {
 549                                 if (netsetup_args[a-1][b] == 34) {
 550                                         netsetup_args[a-1][b] = '_';
 551                                 }
 552                         }
 553                 }
 554                 else {
 555                         netsetup_args[a-1][0] = 0;
 556                 }
 557         }
 558
 559         sprintf(fbuf, "./netsetup \"%s\" \"%s\" \"%s\" </dev/null 2>&1",
 560                 netsetup_args[0], netsetup_args[1], netsetup_args[2]);
 561         netsetup = popen(fbuf, "r");
 562         if (netsetup == NULL) {
 563                 cprintf("%d %s\n", ERROR, strerror(errno));
 564                 return;
 565         }
 566
 567         fbuf[0] = 0;
 568         while (ch = getc(netsetup), (ch > 0)) {
 569                 fbuf[strlen(fbuf)+1] = 0;
 570                 fbuf[strlen(fbuf)] = ch;
 571         }
 572
 573         retcode = pclose(netsetup);
 574
 575         if (retcode != 0) {
 576                 for (a=0; a<strlen(fbuf); ++a) {
 577                         if (fbuf[a] < 32) fbuf[a] = 32;
 578                 }
 579                 fbuf[245] = 0;
 580                 cprintf("%d %s\n", ERROR, fbuf);
 581                 return;
 582         }
 583
 584         cprintf("%d Command succeeded.  Output follows:\n", LISTING_FOLLOWS);
 585         cprintf("%s", fbuf);
 586         if (fbuf[strlen(fbuf)-1] != 10) cprintf("\n");
 587         cprintf("000\n");
 588 }
 589
 590
 591
 592 /*
 593  * Generic routine to convert a login name to a full name (gecos)
 594  * Returns nonzero if a conversion took place
 595  */
 596 int convert_login(char NameToConvert[]) {
 597         struct passwd *pw;
 598         int a;
 599
 600         pw = getpwnam(NameToConvert);
 601         if (pw == NULL) {
 602                 return(0);
 603         }
 604         else {
 605                 strcpy(NameToConvert, pw->pw_gecos);
 606                 for (a=0; a<strlen(NameToConvert); ++a) {
 607                         if (NameToConvert[a] == ',') NameToConvert[a] = 0;
 608                 }
 609                 return(1);
 610         }
 611 }
 612
 613
 614
 615 /*
 616  * Purge all sessions which have the 'kill_me' flag set.
 617  * This function has code to prevent it from running more than once every
 618  * few seconds, because running it after every single unbind would waste a lot
 619  * of CPU time and keep the context list locked too much.
 620  *
 621  * After that's done, we raise or lower the size of the worker thread pool
 622  * if such an action is appropriate.
 623  */
 624 void dead_session_purge(void) {
 625         struct CitContext *ptr, *rem;
 626         pthread_attr_t attr;
 627         pthread_t newthread;
 628
 629         if ( (time(NULL) - last_purge) < 5 ) return;    /* Too soon, go away */
 630         time(&last_purge);
 631
 632         do {
 633                 rem = NULL;
 634                 begin_critical_section(S_SESSION_TABLE);
 635                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
 636                         if ( (ptr->state == CON_IDLE) && (ptr->kill_me) ) {
 637                                 rem = ptr;
 638                         }
 639                 }
 640                 end_critical_section(S_SESSION_TABLE);
 641
 642                 /* RemoveContext() enters its own S_SESSION_TABLE critical
 643                  * section, so we have to do it like this.
 644                  */
 645                 if (rem != NULL) {
 646                         lprintf(9, "Purging session %d\n", rem->cs_pid);
 647                         RemoveContext(rem);
 648                 }
 649
 650         } while (rem != NULL);
 651
 652
 653         /* Raise or lower the size of the worker thread pool if such
 654          * an action is appropriate.
 655          */
 656
 657         if ( (num_sessions > num_threads)
 658            && (num_threads < config.c_max_workers) ) {
 659
 660                 pthread_attr_init(&attr);
 661                 pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
 662                 if (pthread_create(&newthread, &attr,
 663                    (void* (*)(void*)) worker_thread, NULL) != 0) {
 664                         lprintf(1, "Can't create worker thead: %s\n",
 665                         strerror(errno));
 666                 }
 667
 668         }
 669
 670         else if ( (num_sessions < num_threads)
 671            && (num_threads > config.c_min_workers) ) {
 672                 --num_threads;
 673                 pthread_exit(NULL);
 674         }
 675
 676 }
 677
 678
 679
 680
 681 /*
 682  * Here's where it all begins.
 683  */
 684 int main(int argc, char **argv)
 685 {
 686         pthread_t HousekeepingThread;   /* Thread descriptor */
 687         pthread_attr_t attr;            /* Thread attributes */
 688         char tracefile[128];            /* Name of file to log traces to */
 689         int a, i;                       /* General-purpose variables */
 690         struct passwd *pw;
 691         int drop_root_perms = 1;
 692         char *moddir;
 693
 694         /* specify default port name and trace file */
 695         strcpy(tracefile, "");
 696
 697         /* parse command-line arguments */
 698         for (a=1; a<argc; ++a) {
 699
 700                 /* -t specifies where to log trace messages to */
 701                 if (!strncmp(argv[a], "-t", 2)) {
 702                         strcpy(tracefile, argv[a]);
 703                         strcpy(tracefile, &tracefile[2]);
 704                         freopen(tracefile, "r", stdin);
 705                         freopen(tracefile, "w", stdout);
 706                         freopen(tracefile, "w", stderr);
 707                 }
 708
 709                 /* run in the background if -d was specified */
 710                 else if (!strcmp(argv[a], "-d")) {
 711                         start_daemon( (strlen(tracefile) > 0) ? 0 : 1 ) ;
 712                 }
 713
 714                 /* -x specifies the desired logging level */
 715                 else if (!strncmp(argv[a], "-x", 2)) {
 716                         verbosity = atoi(&argv[a][2]);
 717                 }
 718
 719                 else if (!strncmp(argv[a], "-h", 2)) {
 720                         safestrncpy(bbs_home_directory, &argv[a][2],
 721                                     sizeof bbs_home_directory);
 722                         home_specified = 1;
 723                 }
 724
 725                 else if (!strncmp(argv[a], "-f", 2)) {
 726                         do_defrag = 1;
 727                 }
 728
 729                 /* -r tells the server not to drop root permissions. don't use
 730                  * this unless you know what you're doing. this should be
 731                  * removed in the next release if it proves unnecessary. */
 732                 else if (!strcmp(argv[a], "-r"))
 733                         drop_root_perms = 0;
 734
 735                 /* any other parameter makes it crash and burn */
 736                 else {
 737                         lprintf(1,      "citserver: usage: "
 738                                         "citserver [-tTraceFile] [-d] [-f]"
 739                                         " [-xLogLevel] [-hHomeDir]\n");
 740                         exit(1);
 741                 }
 742
 743         }
 744
 745         /* Tell 'em who's in da house */
 746         lprintf(1,
 747 "\nMultithreaded message server for Citadel/UX\n"
 748 "Copyright (C) 1987-1999 by the Citadel/UX development team.\n"
 749 "Citadel/UX is free software, covered by the GNU General Public License, and\n"
 750 "you are welcome to change it and/or distribute copies of it under certain\n"
 751 "conditions.  There is absolutely no warranty for this software.  Please\n"
 752 "read the 'COPYING.txt' file for details.\n\n");
 753
 754         /* Initialize... */
 755         init_sysdep();
 756         openlog("citserver",LOG_PID,LOG_USER);
 757
 758         /* Load site-specific parameters */
 759         lprintf(7, "Loading citadel.config\n");
 760         get_config();
 761
 762         /*
 763          * Bind the server to our favourite port.
 764          * There is no need to check for errors, because ig_tcp_server()
 765          * exits if it doesn't succeed.
 766          */
 767         lprintf(7, "Attempting to bind to port %d...\n", config.c_port_number);
 768         msock = ig_tcp_server(config.c_port_number, 5);
 769         lprintf(7, "Listening on socket %d\n", msock);
 770
 771         /*
 772          * Now that we've bound the socket, change to the BBS user id and its
 773          * corresponding group ids
 774          */
 775         if (drop_root_perms) {
 776                 if ((pw = getpwuid(BBSUID)) == NULL)
 777                         lprintf(1, "WARNING: getpwuid(%d): %s\n"
 778                                    "Group IDs will be incorrect.\n", BBSUID,
 779                                 strerror(errno));
 780                 else {
 781                         initgroups(pw->pw_name, pw->pw_gid);
 782                         if (setgid(pw->pw_gid))
 783                                 lprintf(3, "setgid(%d): %s\n", pw->pw_gid,
 784                                         strerror(errno));
 785                 }
 786                 lprintf(7, "Changing uid to %d\n", BBSUID);
 787                 if (setuid(BBSUID) != 0) {
 788                         lprintf(3, "setuid() failed: %s\n", strerror(errno));
 789                 }
 790         }
 791
 792         /*
 793          * Do non system dependent startup functions.
 794          */
 795         master_startup();
 796
 797         /*
 798          * Load any server-side modules (plugins) available here.
 799          */
 800         lprintf(7, "Initializing loadable modules\n");
 801         if ((moddir = malloc(strlen(bbs_home_directory) + 9)) != NULL) {
 802                 sprintf(moddir, "%s/modules", bbs_home_directory);
 803                 DLoader_Init(moddir);
 804                 free(moddir);
 805         }
 806
 807         lprintf(7, "Starting housekeeper thread\n");
 808         pthread_attr_init(&attr);
 809         pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
 810         if (pthread_create(&HousekeepingThread, &attr,
 811            (void* (*)(void*)) housekeeping_loop, NULL) != 0) {
 812                 lprintf(1, "Can't create housekeeping thead: %s\n",
 813                         strerror(errno));
 814         }
 815
 816
 817         /*
 818          * The rescan pipe exists so that worker threads can be woken up and
 819          * told to re-scan the context list for fd's to listen on.  This is
 820          * necessary, for example, when a context is about to go idle and needs
 821          * to get back on that list.
 822          */
 823         if (pipe(rescan)) {
 824                 lprintf(1, "Can't create rescan pipe!\n");
 825                 exit(errno);
 826         }
 827
 828         /*
 829          * Now create a bunch of worker threads.
 830          */
 831         for (i=0; i<(config.c_min_workers-1); ++i) {
 832                 pthread_attr_init(&attr);
 833                 pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
 834                 if (pthread_create(&HousekeepingThread, &attr,
 835                    (void* (*)(void*)) worker_thread, NULL) != 0) {
 836                         lprintf(1, "Can't create worker thead: %s\n",
 837                         strerror(errno));
 838                 }
 839         }
 840
 841         /* Now this thread can become a worker as well. */
 842         worker_thread();
 843
 844         return(0);
 845 }
 846
 847
 848
 849
 850
 851
 852
 853 /*
 854  * This loop just keeps going and going and going...
 855  */
 856 void worker_thread(void) {
 857         int i;
 858         char junk;
 859         int numselect = 0;
 860         int highest;
 861         struct CitContext *ptr;
 862         struct CitContext *bind_me = NULL;
 863         fd_set readfds;
 864         int retval;
 865         struct CitContext *con= NULL;   /* Temporary context pointer */
 866         struct sockaddr_in fsin;        /* Data for master socket */
 867         int alen;                       /* Data for master socket */
 868         int ssock;                      /* Descriptor for client socket */
 869
 870         ++num_threads;
 871         while (!time_to_die) {
 872
 873                 /*
 874                  * A naive implementation would have all idle threads
 875                  * calling select() and then they'd all wake up at once.  We
 876                  * solve this problem by putting the select() in a critical
 877                  * section, so only one thread has the opportunity to wake
 878                  * up.  If we wake up on the master socket, create a new
 879                  * session context; otherwise, just bind the thread to the
 880                  * context we want and go on our merry way.
 881                  */
 882
 883                 begin_critical_section(S_I_WANNA_SELECT);
 884 SETUP_FD:       FD_ZERO(&readfds);
 885                 FD_SET(msock, &readfds);
 886                 highest = msock;
 887                 FD_SET(rescan[0], &readfds);
 888                 if (rescan[0] > highest) highest = rescan[0];
 889                 numselect = 2;
 890
 891                 begin_critical_section(S_SESSION_TABLE);
 892                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
 893                         if (ptr->state == CON_IDLE) {
 894                                 FD_SET(ptr->client_socket, &readfds);
 895                                 if (ptr->client_socket > highest)
 896                                         highest = ptr->client_socket;
 897                                 ++numselect;
 898                         }
 899                 }
 900                 end_critical_section(S_SESSION_TABLE);
 901
 902                 retval = select(highest + 1, &readfds, NULL, NULL, NULL);
 903
 904                 /* Now figure out who made this select() unblock.
 905                  * First, check for an error or exit condition.
 906                  */
 907                 if (retval < 0) {
 908                         end_critical_section(S_I_WANNA_SELECT);
 909                         lprintf(9, "Exiting (%s)\n", strerror(errno));
 910                         time_to_die = 1;
 911                 }
 912
 913                 /* Next, check to see if it's a new client connecting
 914                  * on the master socket.
 915                  */
 916                 else if (FD_ISSET(msock, &readfds)) {
 917                         alen = sizeof fsin;
 918                         ssock = accept(msock, (struct sockaddr *)&fsin, &alen);
 919                         if (ssock < 0) {
 920                                 lprintf(2, "citserver: accept() failed: %s\n",
 921                                         strerror(errno));
 922                         }
 923                         else {
 924                                 lprintf(7, "citserver: New client socket %d\n",
 925                                         ssock);
 926
 927                                 /* New context will be created already set up
 928                                  * in the CON_EXECUTING state.
 929                                  */
 930                                 con = CreateNewContext();
 931
 932                                 /* Assign our new socket number to it. */
 933                                 con->client_socket = ssock;
 934
 935                                 /* Set the SO_REUSEADDR socket option */
 936                                 i = 1;
 937                                 setsockopt(ssock, SOL_SOCKET, SO_REUSEADDR,
 938                                         &i, sizeof(i));
 939
 940                                 pthread_setspecific(MyConKey, (void *)con);
 941                                 begin_session(con);
 942                                 /* do_command_loop(); */
 943                                 pthread_setspecific(MyConKey, (void *)NULL);
 944                                 con->state = CON_IDLE;
 945                                 goto SETUP_FD;
 946                         }
 947                 }
 948
 949                 /* If the rescan pipe went active, someone is telling this
 950                  * thread that the &readfds needs to be refreshed with more
 951                  * current data.
 952                  */
 953                 else if (FD_ISSET(rescan[0], &readfds)) {
 954                         read(rescan[0], &junk, 1);
 955                         goto SETUP_FD;
 956                 }
 957
 958                 /* It must be a client socket.  Find a context that has data
 959                  * waiting on its socket *and* is in the CON_IDLE state.
 960                  */
 961                 else {
 962                         bind_me = NULL;
 963                         begin_critical_section(S_SESSION_TABLE);
 964                         for (ptr = ContextList;
 965                             ( (ptr != NULL) && (bind_me == NULL) );
 966                             ptr = ptr->next) {
 967                                 if ( (FD_ISSET(ptr->client_socket, &readfds))
 968                                    && (ptr->state == CON_IDLE) ) {
 969                                         bind_me = ptr;
 970                                 }
 971                         }
 972                         if (bind_me != NULL) {
 973                                 /* Found one.  Stake a claim to it before
 974                                  * letting anyone else touch the context list.
 975                                  */
 976                                 bind_me->state = CON_EXECUTING;
 977                         }
 978
 979                         end_critical_section(S_SESSION_TABLE);
 980                         end_critical_section(S_I_WANNA_SELECT);
 981
 982                         /* We're bound to a session, now do *one* command */
 983                         if (bind_me != NULL) {
 984                                 pthread_setspecific(MyConKey, (void *)bind_me);
 985                                 do_command_loop();
 986                                 pthread_setspecific(MyConKey, (void *)NULL);
 987                                 bind_me->state = CON_IDLE;
 988                                 if (bind_me->kill_me == 1) {
 989                                         RemoveContext(bind_me);
 990                                 }
 991                                 write(rescan[1], &junk, 1);
 992                         }
 993                         else {
 994                                 lprintf(9, "Thread found nothing to do!\n");
 995                         }
 996
 997                 }
 998                 dead_session_purge();
 999         }
1000
1001         /* If control reaches this point, the server is shutting down */
1002         master_cleanup();
1003         --num_threads;
1004         pthread_exit(NULL);
1005 }
1006