citadel/sysdep.c

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