citadel/threads.c

   1 /*
   2  * $Id: sysdep.c 5882 2007-12-13 19:46:05Z davew $
   3  *
   4  * Citadel "system dependent" stuff.
   5  * See copyright.txt for copyright information.
   6  *
   7  * Here's where we have the Citadel thread implimentation
   8  *
   9  */
  10
  11 #include <sys/types.h>
  12 #include <errno.h>
  13 #include <sys/socket.h>
  14 #include <unistd.h>
  15 #include <fcntl.h>
  16
  17 #if TIME_WITH_SYS_TIME
  18 # include <sys/time.h>
  19 # include <time.h>
  20 #else
  21 # if HAVE_SYS_TIME_H
  22 #  include <sys/time.h>
  23 # else
  24 #  include <time.h>
  25 # endif
  26 #endif
  27
  28 #include "threads.h"
  29 #include "ctdl_module.h"
  30 #include "modules_init.h"
  31 #include "housekeeping.h"
  32 #include "config.h"
  33 #include "citserver.h"
  34 #include "sysdep_decls.h"
  35
  36 /*
  37  * define this to use the new worker_thread method of handling connections
  38  */
  39 //#define NEW_WORKER
  40
  41 /*
  42  * New thread interface.
  43  * To create a thread you must call one of the create thread functions.
  44  * You must pass it the address of (a pointer to a CtdlThreadNode initialised to NULL) like this
  45  * struct CtdlThreadNode *node = NULL;
  46  * pass in &node
  47  * If the thread is created *node will point to the thread control structure for the created thread.
  48  * If the thread creation fails *node remains NULL
  49  * Do not free the memory pointed to by *node, it doesn't belong to you.
  50  * This new interface duplicates much of the eCrash stuff. We should go for closer integration since that would
  51  * remove the need for the calls to eCrashRegisterThread and friends
  52  */
  53
  54 static int num_threads = 0;                     /* Current number of threads */
  55 static int num_workers = 0;                     /* Current number of worker threads */
  56
  57 CtdlThreadNode *CtdlThreadList = NULL;
  58 CtdlThreadNode *CtdlThreadSchedList = NULL;
  59
  60 static citthread_t GC_thread;
  61 static char *CtdlThreadStates[CTDL_THREAD_LAST_STATE];
  62 double CtdlThreadLoadAvg = 0;
  63 double CtdlThreadWorkerAvg = 0;
  64 citthread_key_t ThreadKey;
  65
  66 citthread_mutex_t Critters[MAX_SEMAPHORES];     /* Things needing locking */
  67
  68
  69
  70 void InitialiseSemaphores(void)
  71 {
  72         int i;
  73
  74         /* Set up a bunch of semaphores to be used for critical sections */
  75         for (i=0; i<MAX_SEMAPHORES; ++i) {
  76                 citthread_mutex_init(&Critters[i], NULL);
  77         }
  78 }
  79
  80
  81
  82
  83 /*
  84  * Obtain a semaphore lock to begin a critical section.
  85  * but only if no one else has one
  86  */
  87 int try_critical_section(int which_one)
  88 {
  89         /* For all types of critical sections except those listed here,
  90          * ensure nobody ever tries to do a critical section within a
  91          * transaction; this could lead to deadlock.
  92          */
  93         if (    (which_one != S_FLOORCACHE)
  94 #ifdef DEBUG_MEMORY_LEAKS
  95                 && (which_one != S_DEBUGMEMLEAKS)
  96 #endif
  97                 && (which_one != S_RPLIST)
  98         ) {
  99                 cdb_check_handles();
 100         }
 101         return (citthread_mutex_trylock(&Critters[which_one]));
 102 }
 103
 104
 105 /*
 106  * Obtain a semaphore lock to begin a critical section.
 107  */
 108 void begin_critical_section(int which_one)
 109 {
 110         /* CtdlLogPrintf(CTDL_DEBUG, "begin_critical_section(%d)\n", which_one); */
 111
 112         /* For all types of critical sections except those listed here,
 113          * ensure nobody ever tries to do a critical section within a
 114          * transaction; this could lead to deadlock.
 115          */
 116         if (    (which_one != S_FLOORCACHE)
 117 #ifdef DEBUG_MEMORY_LEAKS
 118                 && (which_one != S_DEBUGMEMLEAKS)
 119 #endif
 120                 && (which_one != S_RPLIST)
 121         ) {
 122                 cdb_check_handles();
 123         }
 124         citthread_mutex_lock(&Critters[which_one]);
 125 }
 126
 127 /*
 128  * Release a semaphore lock to end a critical section.
 129  */
 130 void end_critical_section(int which_one)
 131 {
 132         citthread_mutex_unlock(&Critters[which_one]);
 133 }
 134
 135
 136 /*
 137  * A function to destroy the TSD
 138  */
 139 static void ctdl_thread_internal_dest_tsd(void *arg)
 140 {
 141         if (arg != NULL) {
 142                 check_handles(arg);
 143                 free(arg);
 144         }
 145 }
 146
 147
 148 /*
 149  * A function to initialise the thread TSD
 150  */
 151 void ctdl_thread_internal_init_tsd(void)
 152 {
 153         int ret;
 154
 155         if ((ret = citthread_key_create(&ThreadKey, ctdl_thread_internal_dest_tsd))) {
 156                 lprintf(CTDL_EMERG, "citthread_key_create: %s\n", strerror(ret));
 157                 exit(CTDLEXIT_DB);
 158         }
 159 }
 160
 161 /*
 162  * Ensure that we have a key for thread-specific data.
 163  *
 164  * This should be called immediately after startup by any thread
 165  *
 166  */
 167 void CtdlThreadAllocTSD(void)
 168 {
 169         ThreadTSD *tsd;
 170
 171         if (citthread_getspecific(ThreadKey) != NULL)
 172                 return;
 173
 174         tsd = malloc(sizeof(ThreadTSD));
 175
 176         tsd->tid = NULL;
 177
 178         memset(tsd->cursors, 0, sizeof tsd->cursors);
 179         tsd->self = NULL;
 180
 181         citthread_setspecific(ThreadKey, tsd);
 182 }
 183
 184
 185 void ctdl_thread_internal_free_tsd(void)
 186 {
 187         ctdl_thread_internal_dest_tsd(citthread_getspecific(ThreadKey));
 188         citthread_setspecific(ThreadKey, NULL);
 189 }
 190
 191
 192 void ctdl_thread_internal_cleanup(void)
 193 {
 194         int i;
 195         CtdlThreadNode *this_thread, *that_thread;
 196
 197         for (i=0; i<CTDL_THREAD_LAST_STATE; i++)
 198         {
 199                 free (CtdlThreadStates[i]);
 200         }
 201
 202         /* Clean up the scheduled thread list */
 203         this_thread = CtdlThreadSchedList;
 204         while (this_thread)
 205         {
 206                 that_thread = this_thread;
 207                 this_thread = this_thread->next;
 208                 citthread_mutex_destroy(&that_thread->ThreadMutex);
 209                 citthread_cond_destroy(&that_thread->ThreadCond);
 210                 citthread_mutex_destroy(&that_thread->SleepMutex);
 211                 citthread_cond_destroy(&that_thread->SleepCond);
 212                 citthread_attr_destroy(&that_thread->attr);
 213                 free(that_thread);
 214         }
 215         ctdl_thread_internal_free_tsd();
 216 }
 217
 218 void ctdl_thread_internal_init(void)
 219 {
 220         CtdlThreadNode *this_thread;
 221         int ret = 0;
 222
 223         GC_thread = citthread_self();
 224         CtdlThreadStates[CTDL_THREAD_INVALID] = strdup ("Invalid Thread");
 225         CtdlThreadStates[CTDL_THREAD_VALID] = strdup("Valid Thread");
 226         CtdlThreadStates[CTDL_THREAD_CREATE] = strdup("Thread being Created");
 227         CtdlThreadStates[CTDL_THREAD_CANCELLED] = strdup("Thread Cancelled");
 228         CtdlThreadStates[CTDL_THREAD_EXITED] = strdup("Thread Exited");
 229         CtdlThreadStates[CTDL_THREAD_STOPPING] = strdup("Thread Stopping");
 230         CtdlThreadStates[CTDL_THREAD_STOP_REQ] = strdup("Thread Stop Requested");
 231         CtdlThreadStates[CTDL_THREAD_SLEEPING] = strdup("Thread Sleeping");
 232         CtdlThreadStates[CTDL_THREAD_RUNNING] = strdup("Thread Running");
 233         CtdlThreadStates[CTDL_THREAD_BLOCKED] = strdup("Thread Blocked");
 234
 235         /* Get ourself a thread entry */
 236         this_thread = malloc(sizeof(CtdlThreadNode));
 237         if (this_thread == NULL) {
 238                 CtdlLogPrintf(CTDL_EMERG, "Thread system, can't allocate CtdlThreadNode, exiting\n");
 239                 return;
 240         }
 241         // Ensuring this is zero'd means we make sure the thread doesn't start doing its thing until we are ready.
 242         memset (this_thread, 0, sizeof(CtdlThreadNode));
 243
 244         citthread_mutex_init (&(this_thread->ThreadMutex), NULL);
 245         citthread_cond_init (&(this_thread->ThreadCond), NULL);
 246         citthread_mutex_init (&(this_thread->SleepMutex), NULL);
 247         citthread_cond_init (&(this_thread->SleepCond), NULL);
 248
 249         /* We are garbage collector so create us as running */
 250         this_thread->state = CTDL_THREAD_RUNNING;
 251
 252         if ((ret = citthread_attr_init(&this_thread->attr))) {
 253                 CtdlLogPrintf(CTDL_EMERG, "Thread system, citthread_attr_init: %s\n", strerror(ret));
 254                 free(this_thread);
 255                 return;
 256         }
 257
 258         this_thread->name = "Garbage Collection Thread";
 259
 260         this_thread->tid = GC_thread;
 261         CT = this_thread;
 262
 263         num_threads++;  // Increase the count of threads in the system.
 264
 265         this_thread->next = CtdlThreadList;
 266         CtdlThreadList = this_thread;
 267         if (this_thread->next)
 268                 this_thread->next->prev = this_thread;
 269         /* Set up start times */
 270         gettimeofday(&this_thread->start_time, NULL);           /* Time this thread started */
 271         memcpy(&this_thread->last_state_change, &this_thread->start_time, sizeof (struct timeval));     /* Changed state so mark it. */
 272 }
 273
 274
 275 /*
 276  * A function to update a threads load averages
 277  */
 278  void ctdl_thread_internal_update_avgs(CtdlThreadNode *this_thread)
 279  {
 280         struct timeval now, result;
 281         double last_duration;
 282
 283         gettimeofday(&now, NULL);
 284         timersub(&now, &(this_thread->last_state_change), &result);
 285         /* I don't think these mutex's are needed here */
 286         citthread_mutex_lock(&this_thread->ThreadMutex);
 287         // result now has a timeval for the time we spent in the last state since we last updated
 288         last_duration = (double)result.tv_sec + ((double)result.tv_usec / (double) 1000000);
 289         if (this_thread->state == CTDL_THREAD_SLEEPING)
 290                 this_thread->avg_sleeping += last_duration;
 291         if (this_thread->state == CTDL_THREAD_RUNNING)
 292                 this_thread->avg_running += last_duration;
 293         if (this_thread->state == CTDL_THREAD_BLOCKED)
 294                 this_thread->avg_blocked += last_duration;
 295         memcpy (&this_thread->last_state_change, &now, sizeof (struct timeval));
 296         citthread_mutex_unlock(&this_thread->ThreadMutex);
 297 }
 298
 299 /*
 300  * A function to chenge the state of a thread
 301  */
 302 void ctdl_thread_internal_change_state (CtdlThreadNode *this_thread, enum CtdlThreadState new_state)
 303 {
 304         /*
 305          * Wether we change state or not we need update the load values
 306          */
 307         ctdl_thread_internal_update_avgs(this_thread);
 308         /* This mutex not needed here? */
 309         citthread_mutex_lock(&this_thread->ThreadMutex); /* To prevent race condition of a sleeping thread */
 310         if ((new_state == CTDL_THREAD_STOP_REQ) && (this_thread->state > CTDL_THREAD_STOP_REQ))
 311                 this_thread->state = new_state;
 312         if (((new_state == CTDL_THREAD_SLEEPING) || (new_state == CTDL_THREAD_BLOCKED)) && (this_thread->state == CTDL_THREAD_RUNNING))
 313                 this_thread->state = new_state;
 314         if ((new_state == CTDL_THREAD_RUNNING) && ((this_thread->state == CTDL_THREAD_SLEEPING) || (this_thread->state == CTDL_THREAD_BLOCKED)))
 315                 this_thread->state = new_state;
 316         citthread_mutex_unlock(&this_thread->ThreadMutex);
 317 }
 318
 319
 320 /*
 321  * A function to tell all threads to exit
 322  */
 323 void CtdlThreadStopAll(void)
 324 {
 325         //FIXME: The signalling of the condition should not be in the critical_section
 326         // We need to build a list of threads we are going to signal and then signal them afterwards
 327
 328         CtdlThreadNode *this_thread;
 329
 330         begin_critical_section(S_THREAD_LIST);
 331         this_thread = CtdlThreadList;
 332         while(this_thread)
 333         {
 334 #ifdef THREADS_USESIGNALS
 335                 citthread_killl(this_thread->tid, SIGHUP);
 336 #endif
 337                 ctdl_thread_internal_change_state (this_thread, CTDL_THREAD_STOP_REQ);
 338                 citthread_cond_signal(&this_thread->ThreadCond);
 339                 citthread_cond_signal(&this_thread->SleepCond);
 340                 CtdlLogPrintf(CTDL_DEBUG, "Thread system stopping thread \"%s\" (0x%08lx).\n",
 341                         this_thread->name, this_thread->tid);
 342                 this_thread = this_thread->next;
 343         }
 344         end_critical_section(S_THREAD_LIST);
 345 }
 346
 347
 348 /*
 349  * A function to wake up all sleeping threads
 350  */
 351 void CtdlThreadWakeAll(void)
 352 {
 353         CtdlThreadNode *this_thread;
 354
 355         CtdlLogPrintf(CTDL_DEBUG, "Thread system waking all threads.\n");
 356
 357         begin_critical_section(S_THREAD_LIST);
 358         this_thread = CtdlThreadList;
 359         while(this_thread)
 360         {
 361                 if (!this_thread->thread_func)
 362                 {
 363                         citthread_cond_signal(&this_thread->ThreadCond);
 364                         citthread_cond_signal(&this_thread->SleepCond);
 365                 }
 366                 this_thread = this_thread->next;
 367         }
 368         end_critical_section(S_THREAD_LIST);
 369 }
 370
 371
 372 /*
 373  * A function to return the number of threads running in the system
 374  */
 375 int CtdlThreadGetCount(void)
 376 {
 377         return  num_threads;
 378 }
 379
 380 int CtdlThreadGetWorkers(void)
 381 {
 382         return  num_workers;
 383 }
 384
 385 double CtdlThreadGetWorkerAvg(void)
 386 {
 387         double ret;
 388
 389         begin_critical_section(S_THREAD_LIST);
 390         ret =  CtdlThreadWorkerAvg;
 391         end_critical_section(S_THREAD_LIST);
 392         return ret;
 393 }
 394
 395 double CtdlThreadGetLoadAvg(void)
 396 {
 397         double ret;
 398
 399         begin_critical_section(S_THREAD_LIST);
 400         ret =  CtdlThreadLoadAvg;
 401         end_critical_section(S_THREAD_LIST);
 402         return ret;
 403 }
 404
 405
 406
 407
 408 /*
 409  * A function to rename a thread
 410  * Returns a const char *
 411  */
 412 const char *CtdlThreadName(const char *name)
 413 {
 414         const char *old_name;
 415
 416         if (!CT)
 417         {
 418                 CtdlLogPrintf(CTDL_WARNING, "Thread system WARNING. Attempt to CtdlThreadRename() a non thread. %s\n", name);
 419                 return NULL;
 420         }
 421         old_name = CT->name;
 422         if (name)
 423                 CT->name = name;
 424         return (old_name);
 425 }
 426
 427
 428 /*
 429  * A function to force a thread to exit
 430  */
 431 void CtdlThreadCancel(CtdlThreadNode *thread)
 432 {
 433         CtdlThreadNode *this_thread;
 434
 435         if (!thread)
 436                 this_thread = CT;
 437         else
 438                 this_thread = thread;
 439         if (!this_thread)
 440         {
 441                 CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC. Attempt to CtdlThreadCancel() a non thread.\n");
 442                 CtdlThreadStopAll();
 443                 return;
 444         }
 445
 446         if (!this_thread->thread_func)
 447         {
 448                 CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC. Attempt to CtdlThreadCancel() the garbage collector.\n");
 449                 CtdlThreadStopAll();
 450                 return;
 451         }
 452
 453         ctdl_thread_internal_change_state (this_thread, CTDL_THREAD_CANCELLED);
 454         citthread_cancel(this_thread->tid);
 455 }
 456
 457
 458 /*
 459  * A function for a thread to check if it has been asked to stop
 460  */
 461 int CtdlThreadCheckStop(void)
 462 {
 463         int state;
 464
 465         if (!CT)
 466         {
 467                 CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC, CtdlThreadCheckStop() called by a non thread.\n");
 468                 CtdlThreadStopAll();
 469                 return -1;
 470         }
 471
 472         state = CT->state;
 473
 474 #ifdef THREADS_USERSIGNALS
 475         if (CT->signal)
 476                 CtdlLogPrintf(CTDL_DEBUG, "Thread \"%s\" caught signal %d.\n", CT->name, CT->signal);
 477 #endif
 478         if(state == CTDL_THREAD_STOP_REQ)
 479         {
 480                 CT->state = CTDL_THREAD_STOPPING;
 481                 return -1;
 482         }
 483         else if((state < CTDL_THREAD_STOP_REQ) && (state > CTDL_THREAD_CREATE))
 484         {
 485                 return -1;
 486         }
 487         return 0;
 488 }
 489
 490
 491 /*
 492  * A function to ask a thread to exit
 493  * The thread must call CtdlThreadCheckStop() periodically to determine if it should exit
 494  */
 495 void CtdlThreadStop(CtdlThreadNode *thread)
 496 {
 497         CtdlThreadNode *this_thread;
 498
 499         if (!thread)
 500                 this_thread = CT;
 501         else
 502                 this_thread = thread;
 503         if (!this_thread)
 504                 return;
 505         if (!(this_thread->thread_func))
 506                 return;         // Don't stop garbage collector
 507 #ifdef THREADS_USESIGNALS
 508         citthread_kill(this_thread->tid, SIGHUP);
 509 #endif
 510         ctdl_thread_internal_change_state (this_thread, CTDL_THREAD_STOP_REQ);
 511         citthread_cond_signal(&this_thread->ThreadCond);
 512         citthread_cond_signal(&this_thread->SleepCond);
 513 }
 514
 515 /*
 516  * So we now have a sleep command that works with threads but it is in seconds
 517  */
 518 void CtdlThreadSleep(int secs)
 519 {
 520         struct timespec wake_time;
 521         struct timeval time_now;
 522
 523
 524         if (!CT)
 525         {
 526                 CtdlLogPrintf(CTDL_WARNING, "CtdlThreadSleep() called by something that is not a thread. Should we die?\n");
 527                 return;
 528         }
 529
 530         memset (&wake_time, 0, sizeof(struct timespec));
 531         gettimeofday(&time_now, NULL);
 532         wake_time.tv_sec = time_now.tv_sec + secs;
 533         wake_time.tv_nsec = time_now.tv_usec * 10;
 534
 535         ctdl_thread_internal_change_state (CT, CTDL_THREAD_SLEEPING);
 536
 537         citthread_mutex_lock(&CT->ThreadMutex); /* Prevent something asking us to awaken before we've gone to sleep */
 538         citthread_cond_timedwait(&CT->SleepCond, &CT->ThreadMutex, &wake_time);
 539         citthread_mutex_unlock(&CT->ThreadMutex);
 540
 541         ctdl_thread_internal_change_state (CT, CTDL_THREAD_RUNNING);
 542 }
 543
 544
 545 /*
 546  * Routine to clean up our thread function on exit
 547  */
 548 static void ctdl_internal_thread_cleanup(void *arg)
 549 {
 550         /*
 551          * In here we were called by the current thread because it is exiting
 552          * NB. WE ARE THE CURRENT THREAD
 553          */
 554         CtdlLogPrintf(CTDL_NOTICE, "Thread \"%s\" (0x%08lx) exited.\n", CT->name, CT->tid);
 555
 556         #ifdef HAVE_BACKTRACE
 557         eCrash_UnregisterThread();
 558         #endif
 559
 560         citthread_mutex_lock(&CT->ThreadMutex);
 561         CT->state = CTDL_THREAD_EXITED; // needs to be last thing else house keeping will unlink us too early
 562         citthread_mutex_unlock(&CT->ThreadMutex);
 563 }
 564
 565 /*
 566  * A quick function to show the load averages
 567  */
 568 void ctdl_thread_internal_calc_loadavg(void)
 569 {
 570         CtdlThreadNode *that_thread;
 571         double load_avg, worker_avg;
 572         int workers = 0;
 573
 574         that_thread = CtdlThreadList;
 575         load_avg = 0;
 576         worker_avg = 0;
 577         while(that_thread)
 578         {
 579                 /* Update load averages */
 580                 ctdl_thread_internal_update_avgs(that_thread);
 581                 citthread_mutex_lock(&that_thread->ThreadMutex);
 582                 that_thread->load_avg = (that_thread->avg_sleeping + that_thread->avg_running) / (that_thread->avg_sleeping + that_thread->avg_running + that_thread->avg_blocked) * 100;
 583                 that_thread->avg_sleeping /= 2;
 584                 that_thread->avg_running /= 2;
 585                 that_thread->avg_blocked /= 2;
 586                 load_avg += that_thread->load_avg;
 587                 if (that_thread->flags & CTDLTHREAD_WORKER)
 588                 {
 589                         worker_avg += that_thread->load_avg;
 590                         workers++;
 591                 }
 592 #ifdef WITH_THREADLOG
 593                 CtdlLogPrintf(CTDL_DEBUG, "CtdlThread, \"%s\" (%lu) \"%s\" %.2f %.2f %.2f %.2f\n",
 594                         that_thread->name,
 595                         that_thread->tid,
 596                         CtdlThreadStates[that_thread->state],
 597                         that_thread->avg_sleeping,
 598                         that_thread->avg_running,
 599                         that_thread->avg_blocked,
 600                         that_thread->load_avg);
 601 #endif
 602                 citthread_mutex_unlock(&that_thread->ThreadMutex);
 603                 that_thread = that_thread->next;
 604         }
 605         CtdlThreadLoadAvg = load_avg/num_threads;
 606         CtdlThreadWorkerAvg = worker_avg/workers;
 607 #ifdef WITH_THREADLOG
 608         CtdlLogPrintf(CTDL_INFO, "System load average %.2f, workers averag %.2f, threads %d, workers %d, sessions %d\n", CtdlThreadLoadAvg, CtdlThreadWorkerAvg, num_threads, num_workers, num_sessions);
 609 #endif
 610 }
 611
 612
 613 /*
 614  * Garbage collection routine.
 615  * Gets called by main() in a loop to clean up the thread list periodically.
 616  */
 617 void CtdlThreadGC (void)
 618 {
 619         CtdlThreadNode *this_thread, *that_thread;
 620         int workers = 0, sys_workers;
 621         int ret=0;
 622
 623         begin_critical_section(S_THREAD_LIST);
 624
 625         /* Handle exiting of garbage collector thread */
 626         if(num_threads == 1)
 627                 CtdlThreadList->state = CTDL_THREAD_EXITED;
 628
 629 #ifdef WITH_THREADLOG
 630         CtdlLogPrintf(CTDL_DEBUG, "Thread system running garbage collection.\n");
 631 #endif
 632         /*
 633          * Woke up to do garbage collection
 634          */
 635         this_thread = CtdlThreadList;
 636         while(this_thread)
 637         {
 638                 that_thread = this_thread;
 639                 this_thread = this_thread->next;
 640
 641                 if ((that_thread->state == CTDL_THREAD_STOP_REQ || that_thread->state == CTDL_THREAD_STOPPING)
 642                         && (!citthread_equal(that_thread->tid, citthread_self())))
 643                                 that_thread->stop_ticker++;
 644
 645                 if (that_thread->stop_ticker == 5)
 646                 {
 647                         CtdlLogPrintf(CTDL_DEBUG, "Thread System: The thread \"%s\" (0x%08lx) failed to self terminate withing 5 ticks. It would be cancelled now.\n", that_thread->name, that_thread->tid);
 648                         if ((that_thread->flags & CTDLTHREAD_WORKER) == 0)
 649                                 CtdlLogPrintf(CTDL_INFO, "Thread System: A non worker thread would have been canceled this may cause message loss.\n");
 650 //                      that_thread->state = CTDL_THREAD_CANCELLED;
 651                         that_thread->stop_ticker++;
 652 //                      citthread_cancel(that_thread->tid);
 653 //                      continue;
 654                 }
 655
 656                 /* Do we need to clean up this thread? */
 657                 if ((that_thread->state != CTDL_THREAD_EXITED) && (that_thread->state != CTDL_THREAD_CANCELLED))
 658                 {
 659                         if(that_thread->flags & CTDLTHREAD_WORKER)
 660                                 workers++;      /* Sanity check on number of worker threads */
 661                         continue;
 662                 }
 663
 664                 if (citthread_equal(that_thread->tid, citthread_self()) && that_thread->thread_func)
 665                 {       /* Sanity check */
 666                         end_critical_section(S_THREAD_LIST);
 667                         CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC, a thread is trying to clean up after itself.\n");
 668                         abort();
 669                         return;
 670                 }
 671
 672                 if (num_threads <= 0)
 673                 {       /* Sanity check */
 674                         end_critical_section(S_THREAD_LIST);
 675                         CtdlLogPrintf(CTDL_EMERG, "Thread system PANIC, num_threads <= 0 and trying to do Garbage Collection.\n");
 676                         abort();
 677                         return;
 678                 }
 679
 680                 if(that_thread->flags & CTDLTHREAD_WORKER)
 681                         num_workers--;  /* This is a wroker thread so reduce the count. */
 682                 num_threads--;
 683                 /* If we are unlinking the list head then the next becomes the list head */
 684                 if(that_thread->prev)
 685                         that_thread->prev->next = that_thread->next;
 686                 else
 687                         CtdlThreadList = that_thread->next;
 688                 if(that_thread->next)
 689                         that_thread->next->prev = that_thread->prev;
 690
 691                 citthread_cond_signal(&that_thread->ThreadCond);
 692                 citthread_cond_signal(&that_thread->SleepCond); // Make sure this thread is awake
 693                 citthread_mutex_lock(&that_thread->ThreadMutex);        // Make sure it has done what its doing
 694                 citthread_mutex_unlock(&that_thread->ThreadMutex);
 695                 /*
 696                  * Join on the thread to do clean up and prevent memory leaks
 697                  * Also makes sure the thread has cleaned up after itself before we remove it from the list
 698                  * We can join on the garbage collector thread the join should just return EDEADLCK
 699                  */
 700                 ret = citthread_join (that_thread->tid, NULL);
 701                 if (ret == EDEADLK)
 702                         CtdlLogPrintf(CTDL_DEBUG, "Garbage collection on own thread.\n");
 703                 else if (ret == EINVAL)
 704                         CtdlLogPrintf(CTDL_DEBUG, "Garbage collection, that thread already joined on.\n");
 705                 else if (ret == ESRCH)
 706                         CtdlLogPrintf(CTDL_DEBUG, "Garbage collection, no thread to join on.\n");
 707                 else if (ret != 0)
 708                         CtdlLogPrintf(CTDL_DEBUG, "Garbage collection, citthread_join returned an unknown error(%d).\n", ret);
 709                 /*
 710                  * Now we own that thread entry
 711                  */
 712                 CtdlLogPrintf(CTDL_INFO, "Garbage Collection for thread \"%s\" (0x%08lx).\n",
 713                         that_thread->name, that_thread->tid);
 714                 citthread_mutex_destroy(&that_thread->ThreadMutex);
 715                 citthread_cond_destroy(&that_thread->ThreadCond);
 716                 citthread_mutex_destroy(&that_thread->SleepMutex);
 717                 citthread_cond_destroy(&that_thread->SleepCond);
 718                 citthread_attr_destroy(&that_thread->attr);
 719                 free(that_thread);
 720         }
 721         sys_workers = num_workers;
 722         end_critical_section(S_THREAD_LIST);
 723
 724         /* Sanity check number of worker threads */
 725         if (workers != sys_workers)
 726         {
 727                 CtdlLogPrintf(CTDL_EMERG,
 728                         "Thread system PANIC, discrepancy in number of worker threads. Counted %d, should be %d.\n",
 729                         workers, sys_workers
 730                         );
 731                 abort();
 732         }
 733 }
 734
 735
 736
 737
 738 /*
 739  * Runtime function for a Citadel Thread.
 740  * This initialises the threads environment and then calls the user supplied thread function
 741  * Note that this is the REAL thread function and wraps the users thread function.
 742  */
 743 static void *ctdl_internal_thread_func (void *arg)
 744 {
 745         CtdlThreadNode *this_thread;
 746         void *ret = NULL;
 747
 748         /* lock and unlock the thread list.
 749          * This causes this thread to wait until all its creation stuff has finished before it
 750          * can continue its execution.
 751          */
 752         begin_critical_section(S_THREAD_LIST);
 753         this_thread = (CtdlThreadNode *) arg;
 754         gettimeofday(&this_thread->start_time, NULL);           /* Time this thread started */
 755 //      citthread_mutex_lock(&this_thread->ThreadMutex);
 756
 757         // Register the cleanup function to take care of when we exit.
 758         citthread_cleanup_push(ctdl_internal_thread_cleanup, NULL);
 759         // Get our thread data structure
 760         CtdlThreadAllocTSD();
 761         CT = this_thread;
 762         this_thread->pid = getpid();
 763         memcpy(&this_thread->last_state_change, &this_thread->start_time, sizeof (struct timeval));     /* Changed state so mark it. */
 764         /* Only change to running state if we weren't asked to stop during the create cycle
 765          * Other wise there is a window to allow this threads creation to continue to full grown and
 766          * therby prevent a shutdown of the server.
 767          */
 768 //      citthread_mutex_unlock(&this_thread->ThreadMutex);
 769
 770         if (!CtdlThreadCheckStop())
 771         {
 772                 citthread_mutex_lock(&this_thread->ThreadMutex);
 773                 this_thread->state = CTDL_THREAD_RUNNING;
 774                 citthread_mutex_unlock(&this_thread->ThreadMutex);
 775         }
 776         end_critical_section(S_THREAD_LIST);
 777
 778         // Register for tracing
 779         #ifdef HAVE_BACKTRACE
 780         eCrash_RegisterThread(this_thread->name, 0);
 781         #endif
 782
 783         // Tell the world we are here
 784         CtdlLogPrintf(CTDL_NOTICE, "Created a new thread \"%s\" (0x%08lx).\n",
 785                 this_thread->name, this_thread->tid);
 786
 787         /*
 788          * run the thread to do the work but only if we haven't been asked to stop
 789          */
 790         if (!CtdlThreadCheckStop())
 791                 ret = (this_thread->thread_func)(this_thread->user_args);
 792
 793         /*
 794          * Our thread is exiting either because it wanted to end or because the server is stopping
 795          * We need to clean up
 796          */
 797         citthread_cleanup_pop(1);       // Execute our cleanup routine and remove it
 798
 799         return(ret);
 800 }
 801
 802
 803
 804
 805 /*
 806  * Function to initialise an empty thread structure
 807  */
 808 CtdlThreadNode *ctdl_internal_init_thread_struct(CtdlThreadNode *this_thread, long flags)
 809 {
 810         int ret = 0;
 811
 812         // Ensuring this is zero'd means we make sure the thread doesn't start doing its thing until we are ready.
 813         memset (this_thread, 0, sizeof(CtdlThreadNode));
 814
 815         /* Create the mutex's early so we can use them */
 816         citthread_mutex_init (&(this_thread->ThreadMutex), NULL);
 817         citthread_cond_init (&(this_thread->ThreadCond), NULL);
 818         citthread_mutex_init (&(this_thread->SleepMutex), NULL);
 819         citthread_cond_init (&(this_thread->SleepCond), NULL);
 820
 821         this_thread->state = CTDL_THREAD_CREATE;
 822
 823         if ((ret = citthread_attr_init(&this_thread->attr))) {
 824                 citthread_mutex_unlock(&this_thread->ThreadMutex);
 825                 citthread_mutex_destroy(&(this_thread->ThreadMutex));
 826                 citthread_cond_destroy(&(this_thread->ThreadCond));
 827                 citthread_mutex_destroy(&(this_thread->SleepMutex));
 828                 citthread_cond_destroy(&(this_thread->SleepCond));
 829                 CtdlLogPrintf(CTDL_EMERG, "Thread system, citthread_attr_init: %s\n", strerror(ret));
 830                 free(this_thread);
 831                 return NULL;
 832         }
 833
 834         /* Our per-thread stacks need to be bigger than the default size,
 835          * otherwise the MIME parser crashes on FreeBSD, and the IMAP service
 836          * crashes on 64-bit Linux.
 837          */
 838         if (flags & CTDLTHREAD_BIGSTACK)
 839         {
 840 #ifdef WITH_THREADLOG
 841                 CtdlLogPrintf(CTDL_INFO, "Thread system. Creating BIG STACK thread.\n");
 842 #endif
 843                 if ((ret = citthread_attr_setstacksize(&this_thread->attr, THREADSTACKSIZE))) {
 844                         citthread_mutex_unlock(&this_thread->ThreadMutex);
 845                         citthread_mutex_destroy(&(this_thread->ThreadMutex));
 846                         citthread_cond_destroy(&(this_thread->ThreadCond));
 847                         citthread_mutex_destroy(&(this_thread->SleepMutex));
 848                         citthread_cond_destroy(&(this_thread->SleepCond));
 849                         citthread_attr_destroy(&this_thread->attr);
 850                         CtdlLogPrintf(CTDL_EMERG, "Thread system, citthread_attr_setstacksize: %s\n",
 851                                 strerror(ret));
 852                         free(this_thread);
 853                         return NULL;
 854                 }
 855         }
 856
 857         /* Set this new thread with an avg_blocked of 2. We do this so that its creation affects the
 858          * load average for the system. If we don't do this then we create a mass of threads at the same time
 859          * because the creation didn't affect the load average.
 860          */
 861         this_thread->avg_blocked = 2;
 862
 863         return (this_thread);
 864 }
 865
 866
 867
 868
 869 /*
 870  * Internal function to create a thread.
 871  */
 872 CtdlThreadNode *ctdl_internal_create_thread(char *name, long flags, void *(*thread_func) (void *arg), void *args)
 873 {
 874         int ret = 0;
 875         CtdlThreadNode *this_thread;
 876
 877         if (num_threads >= 32767)
 878         {
 879                 CtdlLogPrintf(CTDL_EMERG, "Thread system. Thread list full.\n");
 880                 return NULL;
 881         }
 882
 883         this_thread = malloc(sizeof(CtdlThreadNode));
 884         if (this_thread == NULL) {
 885                 CtdlLogPrintf(CTDL_EMERG, "Thread system, can't allocate CtdlThreadNode, exiting\n");
 886                 return NULL;
 887         }
 888
 889         /* Initialise the thread structure */
 890         if (ctdl_internal_init_thread_struct(this_thread, flags) == NULL)
 891         {
 892                 free(this_thread);
 893                 CtdlLogPrintf(CTDL_EMERG, "Thread system, can't initialise CtdlThreadNode, exiting\n");
 894                 return NULL;
 895         }
 896         /*
 897          * If we got here we are going to create the thread so we must initilise the structure
 898          * first because most implimentations of threading can't create it in a stopped state
 899          * and it might want to do things with its structure that aren't initialised otherwise.
 900          */
 901         if(name)
 902         {
 903                 this_thread->name = name;
 904         }
 905         else
 906         {
 907                 this_thread->name = "Un-named Thread";
 908         }
 909
 910         this_thread->flags = flags;
 911         this_thread->thread_func = thread_func;
 912         this_thread->user_args = args;
 913
 914 //      citthread_mutex_lock(&this_thread->ThreadMutex);
 915
 916         begin_critical_section(S_THREAD_LIST);
 917         /*
 918          * We pass this_thread into the thread as its args so that it can find out information
 919          * about itself and it has a bit of storage space for itself, not to mention that the REAL
 920          * thread function needs to finish off the setup of the structure
 921          */
 922         if ((ret = citthread_create(&this_thread->tid, &this_thread->attr, ctdl_internal_thread_func, this_thread) != 0))
 923         {
 924                 end_critical_section(S_THREAD_LIST);
 925                 CtdlLogPrintf(CTDL_ALERT, "Thread system, Can't create thread: %s\n",
 926                         strerror(ret));
 927                 citthread_mutex_unlock(&this_thread->ThreadMutex);
 928                 citthread_mutex_destroy(&(this_thread->ThreadMutex));
 929                 citthread_cond_destroy(&(this_thread->ThreadCond));
 930                 citthread_mutex_destroy(&(this_thread->SleepMutex));
 931                 citthread_cond_destroy(&(this_thread->SleepCond));
 932                 citthread_attr_destroy(&this_thread->attr);
 933                 free(this_thread);
 934                 return NULL;
 935         }
 936
 937         num_threads++;  // Increase the count of threads in the system.
 938         if(this_thread->flags & CTDLTHREAD_WORKER)
 939                 num_workers++;
 940
 941         this_thread->next = CtdlThreadList;
 942         CtdlThreadList = this_thread;
 943         if (this_thread->next)
 944                 this_thread->next->prev = this_thread;
 945         ctdl_thread_internal_calc_loadavg();
 946
 947 //      citthread_mutex_unlock(&this_thread->ThreadMutex);
 948         end_critical_section(S_THREAD_LIST);
 949
 950         return this_thread;
 951 }
 952
 953 /*
 954  * Wrapper function to create a thread
 955  * ensures the critical section and other protections are in place.
 956  * char *name = name to give to thread, if NULL, use generic name
 957  * int flags = flags to determine type of thread and standard facilities
 958  */
 959 CtdlThreadNode *CtdlThreadCreate(char *name, long flags, void *(*thread_func) (void *arg), void *args)
 960 {
 961         CtdlThreadNode *ret = NULL;
 962
 963         ret = ctdl_internal_create_thread(name, flags, thread_func, args);
 964         return ret;
 965 }
 966
 967
 968
 969 /*
 970  * Internal function to schedule a thread.
 971  * Must be called from within a S_THREAD_LIST critical section
 972  */
 973 CtdlThreadNode *CtdlThreadSchedule(char *name, long flags, void *(*thread_func) (void *arg), void *args, time_t when)
 974 {
 975         CtdlThreadNode *this_thread;
 976
 977         if (num_threads >= 32767)
 978         {
 979                 CtdlLogPrintf(CTDL_EMERG, "Thread system. Thread list full.\n");
 980                 return NULL;
 981         }
 982
 983         this_thread = malloc(sizeof(CtdlThreadNode));
 984         if (this_thread == NULL) {
 985                 CtdlLogPrintf(CTDL_EMERG, "Thread system, can't allocate CtdlThreadNode, exiting\n");
 986                 return NULL;
 987         }
 988         /* Initialise the thread structure */
 989         if (ctdl_internal_init_thread_struct(this_thread, flags) == NULL)
 990         {
 991                 free(this_thread);
 992                 CtdlLogPrintf(CTDL_EMERG, "Thread system, can't initialise CtdlThreadNode, exiting\n");
 993                 return NULL;
 994         }
 995
 996         /*
 997          * If we got here we are going to create the thread so we must initilise the structure
 998          * first because most implimentations of threading can't create it in a stopped state
 999          * and it might want to do things with its structure that aren't initialised otherwise.
1000          */
1001         if(name)
1002         {
1003                 this_thread->name = name;
1004         }
1005         else
1006         {
1007                 this_thread->name = "Un-named Thread";
1008         }
1009
1010         this_thread->flags = flags;
1011         this_thread->thread_func = thread_func;
1012         this_thread->user_args = args;
1013
1014         /*
1015          * When to start this thread
1016          */
1017         this_thread->when = when;
1018
1019         begin_critical_section(S_SCHEDULE_LIST);
1020         this_thread->next = CtdlThreadSchedList;
1021         CtdlThreadSchedList = this_thread;
1022         if (this_thread->next)
1023                 this_thread->next->prev = this_thread;
1024         end_critical_section(S_SCHEDULE_LIST);
1025
1026         return this_thread;
1027 }
1028
1029
1030
1031 CtdlThreadNode *ctdl_thread_internal_start_scheduled (CtdlThreadNode *this_thread)
1032 {
1033         int ret = 0;
1034
1035 //      citthread_mutex_lock(&that_thread->ThreadMutex);
1036         begin_critical_section(S_THREAD_LIST);
1037         /*
1038          * We pass this_thread into the thread as its args so that it can find out information
1039          * about itself and it has a bit of storage space for itself, not to mention that the REAL
1040          * thread function needs to finish off the setup of the structure
1041          */
1042         if ((ret = citthread_create(&this_thread->tid, &this_thread->attr, ctdl_internal_thread_func, this_thread) != 0))
1043         {
1044                 end_critical_section(S_THREAD_LIST);
1045                 CtdlLogPrintf(CTDL_DEBUG, "Failed to start scheduled thread \"%s\": %s\n", this_thread->name, strerror(ret));
1046 //              citthread_mutex_unlock(&this_thread->ThreadMutex);
1047                 citthread_mutex_destroy(&(this_thread->ThreadMutex));
1048                 citthread_cond_destroy(&(this_thread->ThreadCond));
1049                 citthread_mutex_destroy(&(this_thread->SleepMutex));
1050                 citthread_cond_destroy(&(this_thread->SleepCond));
1051                 citthread_attr_destroy(&this_thread->attr);
1052                 free(this_thread);
1053                 return NULL;
1054         }
1055
1056
1057         num_threads++;  // Increase the count of threads in the system.
1058         if(this_thread->flags & CTDLTHREAD_WORKER)
1059                 num_workers++;
1060
1061         this_thread->next = CtdlThreadList;
1062         CtdlThreadList = this_thread;
1063         if (this_thread->next)
1064                 this_thread->next->prev = this_thread;
1065 //      citthread_mutex_unlock(&that_thread->ThreadMutex);
1066
1067         ctdl_thread_internal_calc_loadavg();
1068         end_critical_section(S_THREAD_LIST);
1069
1070
1071         return this_thread;
1072 }
1073
1074
1075
1076 void ctdl_thread_internal_check_scheduled(void)
1077 {
1078         CtdlThreadNode *this_thread, *that_thread;
1079         time_t now;
1080
1081         if (try_critical_section(S_SCHEDULE_LIST))
1082                 return; /* If this list is locked we wait till the next chance */
1083
1084         now = time(NULL);
1085
1086 #ifdef WITH_THREADLOG
1087         CtdlLogPrintf(CTDL_DEBUG, "Checking for scheduled threads to start.\n");
1088 #endif
1089
1090         this_thread = CtdlThreadSchedList;
1091         while(this_thread)
1092         {
1093                 that_thread = this_thread;
1094                 this_thread = this_thread->next;
1095
1096                 if (now > that_thread->when)
1097                 {
1098                         /* Unlink from schedule list */
1099                         if (that_thread->prev)
1100                                 that_thread->prev->next = that_thread->next;
1101                         else
1102                                 CtdlThreadSchedList = that_thread->next;
1103                         if (that_thread->next)
1104                                 that_thread->next->prev = that_thread->prev;
1105
1106                         that_thread->next = that_thread->prev = NULL;
1107 #ifdef WITH_THREADLOG
1108                         CtdlLogPrintf(CTDL_DEBUG, "About to start scheduled thread \"%s\".\n", that_thread->name);
1109 #endif
1110                         if (CT->state > CTDL_THREAD_STOP_REQ)
1111                         {       /* Only start it if the system is not stopping */
1112                                 if (ctdl_thread_internal_start_scheduled (that_thread))
1113                                 {
1114 #ifdef WITH_THREADLOG
1115                                         CtdlLogPrintf(CTDL_INFO, "Thread system, Started a scheduled thread \"%s\" (%ud).\n",
1116                                                 that_thread->name, that_thread->tid);
1117 #endif
1118                                 }
1119                         }
1120                 }
1121 #ifdef WITH_THREADLOG
1122                 else
1123                 {
1124                         CtdlLogPrintf(CTDL_DEBUG, "Thread \"%s\" will start in %ld seconds.\n",
1125                                 that_thread->name, that_thread->when - time(NULL));
1126                 }
1127 #endif
1128         }
1129         end_critical_section(S_SCHEDULE_LIST);
1130 }
1131
1132
1133 /*
1134  * A warapper function for select so we can show a thread as blocked
1135  */
1136 int CtdlThreadSelect(int n, fd_set *readfds, fd_set *writefds, fd_set *exceptfds, struct timeval *timeout)
1137 {
1138         int ret;
1139
1140         ctdl_thread_internal_change_state(CT, CTDL_THREAD_BLOCKED);
1141         ret = select(n, readfds, writefds, exceptfds, timeout);
1142         ctdl_thread_internal_change_state(CT, CTDL_THREAD_RUNNING);
1143         return ret;
1144 }
1145
1146
1147
1148 void *new_worker_thread(void *arg);
1149 extern void close_masters (void);
1150
1151
1152
1153 void go_threading(void)
1154 {
1155         int i;
1156         CtdlThreadNode *last_worker;
1157
1158         /*
1159          * Initialise the thread system
1160          */
1161         ctdl_thread_internal_init();
1162
1163         /* Second call to module init functions now that threading is up */
1164         initialise_modules(1);
1165
1166         /*
1167          * This thread is now used for garbage collection of other threads in the thread list
1168          */
1169         CtdlLogPrintf(CTDL_INFO, "Startup thread %d becoming garbage collector,\n", citthread_self());
1170
1171         /*
1172          * We do a lot of locking and unlocking of the thread list in here.
1173          * We do this so that we can repeatedly release time for other threads
1174          * that may be waiting on the thread list.
1175          * We are a low priority thread so we can afford to do this
1176          */
1177
1178         while (CtdlThreadGetCount())
1179         {
1180                 if (CT->signal)
1181                         exit_signal = CT->signal;
1182                 if (exit_signal)
1183                 {
1184                         CtdlThreadStopAll();
1185 //                      close_masters();
1186                 }
1187                 check_sched_shutdown();
1188                 if (CT->state > CTDL_THREAD_STOP_REQ)
1189                 {
1190                         begin_critical_section(S_THREAD_LIST);
1191                         ctdl_thread_internal_calc_loadavg();
1192                         end_critical_section(S_THREAD_LIST);
1193
1194                         ctdl_thread_internal_check_scheduled(); /* start scheduled threads */
1195                 }
1196
1197                 /* Reduce the size of the worker thread pool if necessary. */
1198                 if ((CtdlThreadGetWorkers() > config.c_min_workers + 1) && (CtdlThreadWorkerAvg < 20) && (CT->state > CTDL_THREAD_STOP_REQ))
1199                 {
1200                         /* Ask a worker thread to stop as we no longer need it */
1201                         begin_critical_section(S_THREAD_LIST);
1202                         last_worker = CtdlThreadList;
1203                         while (last_worker)
1204                         {
1205                                 citthread_mutex_lock(&last_worker->ThreadMutex);
1206                                 if (last_worker->flags & CTDLTHREAD_WORKER && (last_worker->state > CTDL_THREAD_STOPPING) && (last_worker->Context == NULL))
1207                                 {
1208                                         citthread_mutex_unlock(&last_worker->ThreadMutex);
1209                                         break;
1210                                 }
1211                                 citthread_mutex_unlock(&last_worker->ThreadMutex);
1212                                 last_worker = last_worker->next;
1213                         }
1214                         end_critical_section(S_THREAD_LIST);
1215                         if (last_worker)
1216                         {
1217 #ifdef WITH_THREADLOG
1218                                 CtdlLogPrintf(CTDL_DEBUG, "Thread system, stopping excess worker thread \"%s\" (0x%08lx).\n",
1219                                         last_worker->name,
1220                                         last_worker->tid
1221                                         );
1222 #endif
1223                                 CtdlThreadStop(last_worker);
1224                         }
1225                 }
1226
1227                 /*
1228                  * If all our workers are working hard, start some more to help out
1229                  * with things
1230                  */
1231                 /* FIXME: come up with a better way to dynamically alter the number of threads
1232                  * based on the system load
1233                  */
1234 #ifdef NEW_WORKER
1235                 if ((((CtdlThreadGetWorkers() < config.c_max_workers) && (CtdlThreadGetWorkers() <= num_sessions) ) || CtdlThreadGetWorkers() < config.c_min_workers) && (CT->state > CTDL_THREAD_STOP_REQ))
1236 #else
1237                 if ((((CtdlThreadGetWorkers() < config.c_max_workers) && (CtdlThreadGetWorkerAvg() > 60) && (CtdlThreadGetLoadAvg() < 90) ) || CtdlThreadGetWorkers() < config.c_min_workers) && (CT->state > CTDL_THREAD_STOP_REQ))
1238 #endif /* NEW_WORKER */
1239                 {
1240                         for (i=0; i<5 ; i++)
1241                         {
1242 #ifdef NEW_WORKER
1243                                 CtdlThreadCreate("Worker Thread (new)",
1244                                         CTDLTHREAD_BIGSTACK + CTDLTHREAD_WORKER,
1245                                         new_worker_thread,
1246                                         NULL
1247                                         );
1248 #else
1249                                 CtdlThreadCreate("Worker Thread",
1250                                         CTDLTHREAD_BIGSTACK + CTDLTHREAD_WORKER,
1251                                         worker_thread,
1252                                         NULL
1253                                         );
1254 #endif /* NEW_WORKER */
1255                         }
1256                 }
1257
1258                 CtdlThreadGC();
1259
1260                 if (CtdlThreadGetCount() <= 1) // Shutting down clean up the garbage collector
1261                 {
1262                         CtdlThreadGC();
1263                 }
1264
1265                 if (CtdlThreadGetCount())
1266                         CtdlThreadSleep(1);
1267         }
1268         /*
1269          * If the above loop exits we must be shutting down since we obviously have no threads
1270          */
1271         ctdl_thread_internal_cleanup();
1272 }
1273
1274
1275
1276
1277 /*
1278  * Starting a new implimentation of a worker thread.
1279  * This new implimentation will be faster and do more work per thread.
1280  */
1281
1282 /*
1283  * Select on master socket.
1284  * First worker thread in here acquires the lock and builds an FDSET of master sockets.
1285  * then it goes into a loop selecting on the master sockets timing out every few milliseconds.
1286  * If it times out it rebiulds its list and loops.
1287  * If the select succeeds it creates a new context and returns.
1288  * During this time the other workers are selecting on existing contexts or sleeping.
1289  */
1290 void select_on_master(void)
1291 {
1292         fd_set readfds;
1293         struct ServiceFunctionHook *serviceptr;
1294         int ssock;                      /* Descriptor for client socket */
1295         int highest;
1296         int m, i;
1297         int retval = 0;
1298         struct timeval tv;
1299         struct CitContext *con;
1300         const char *old_name;
1301
1302
1303
1304         old_name = CtdlThreadName("select_on_master");
1305
1306         /* Initialize the fdset. */
1307         FD_ZERO(&readfds);
1308         highest = 0;
1309
1310         /* First, add the various master sockets to the fdset. */
1311         for (serviceptr = ServiceHookTable; serviceptr != NULL; serviceptr = serviceptr->next ) {
1312                 m = serviceptr->msock;
1313                 FD_SET(m, &readfds);
1314                 if (m > highest) {
1315                         highest = m;
1316                 }
1317         }
1318
1319         tv.tv_sec = 1;          /* wake up every 1 sec if no input */
1320         tv.tv_usec = 0;
1321         retval = CtdlThreadSelect(highest + 1, &readfds, NULL, NULL, &tv);
1322
1323         /* Select got an error or we are shutting down so get out */
1324         if (retval == 0 || CtdlThreadCheckStop()) {
1325                 CtdlThreadName(old_name);
1326                 return;
1327         }
1328
1329         /* Select says something happened on one of our master sockets so now we handle it */
1330         for (serviceptr = ServiceHookTable; serviceptr != NULL; serviceptr = serviceptr->next ) {
1331                 if (FD_ISSET(serviceptr->msock, &readfds)) {
1332                         ssock = accept(serviceptr->msock, NULL, 0);
1333                         if (ssock >= 0) {
1334                                 CtdlLogPrintf(CTDL_DEBUG, "New client socket %d\n", ssock);
1335                                 /* The master socket is non-blocking but the client
1336                                  * sockets need to be blocking, otherwise certain
1337                                  * operations barf on FreeBSD.  Not a fatal error.
1338                                  */
1339                                 if (fcntl(ssock, F_SETFL, 0) < 0) {
1340                                         CtdlLogPrintf(CTDL_EMERG,
1341                                                       "citserver: Can't set socket to blocking: %s\n",
1342                                                       strerror(errno));
1343                                 }
1344
1345                                 /* New context will be created already
1346                                  * set up in the CON_EXECUTING state.
1347                                  */
1348                                 con = CreateNewContext();
1349                                 CT->Context = con;
1350
1351                                 /* Assign our new socket number to it. */
1352                                 con->client_socket = ssock;
1353                                 con->h_command_function = serviceptr->h_command_function;
1354                                 con->h_async_function = serviceptr->h_async_function;
1355                                 con->ServiceName = serviceptr->ServiceName;
1356                                 /* Determine whether it's a local socket */
1357                                 if (serviceptr->sockpath != NULL)
1358                                         con->is_local_socket = 1;
1359
1360                                 /* Set the SO_REUSEADDR socket option */
1361                                 i = 1;
1362                                 setsockopt(ssock, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
1363
1364                                 become_session(con);
1365                                 begin_session(con);
1366                                 serviceptr->h_greeting_function();
1367                                 become_session(NULL);
1368                                 con->state = CON_IDLE;
1369                                 break;
1370                         }
1371                 }
1372         }
1373
1374         CtdlThreadName(old_name);
1375 }
1376
1377 /*
1378  * Select on client socket.
1379  * First worker thread in here acquires the lock and builds an FDSET of client sockets.
1380  * then it selects on the client sockets timing out after 1 second.
1381  * If it times out the thread goes off to check on housekeeping etc.
1382  * If the select succeeds the thread goes off to handle the client request.
1383  * If the list of client connections is empty the threads all sleep for one second
1384  */
1385 struct CitContext *select_on_client(void)
1386 {
1387         fd_set readfds;
1388         struct timeval tv;
1389         int retval = 0;
1390         int highest=0;
1391         const char *old_name;
1392
1393
1394         old_name = CtdlThreadName("select_on_client");
1395
1396         /* Initialise the fdset */
1397         FD_ZERO(&readfds);
1398         FD_SET(CT->Context->client_socket, &readfds);
1399         highest = CT->Context->client_socket;
1400         /* Now we can select on any connections that are waiting */
1401
1402         if (!CtdlThreadCheckStop())
1403         {
1404                 tv.tv_sec = config.c_sleeping;          /* wake up every second if no input */
1405                 tv.tv_usec = 0;
1406                 retval = select(highest + 1, &readfds, NULL, NULL, &tv);
1407         }
1408         else    /* Shutting down? */
1409         {
1410                 CtdlThreadName(old_name);
1411                 return(NULL);
1412         }
1413
1414
1415         /* Now figure out who made this select() unblock.
1416          * First, check for an error or exit condition.
1417          */
1418         if (retval < 0) {
1419                 if (errno == EBADF) {
1420                         CtdlLogPrintf(CTDL_NOTICE, "select() failed: (%s)\n",
1421                                 strerror(errno));
1422                 }
1423                 if (errno != EINTR) {
1424                         CtdlLogPrintf(CTDL_EMERG, "Exiting (%s)\n", strerror(errno));
1425                         CtdlThreadStopAll();
1426                 } else if (!CtdlThreadCheckStop()) {
1427                         CtdlLogPrintf(CTDL_DEBUG, "Un handled select failure.\n");
1428                 }
1429                 CtdlThreadName(old_name);
1430                 return NULL;
1431         }
1432         else if(retval == 0)
1433         {
1434                 CtdlThreadName(old_name);
1435                 CT->Context->kill_me = 1;
1436                 CT->Context = NULL;
1437                 return CT->Context;
1438         }
1439
1440         CT->Context->state = CON_EXECUTING;
1441         CT->Context->input_waiting = 1;
1442
1443         CtdlThreadName(old_name);
1444         return (CT->Context);
1445 }
1446
1447
1448
1449 /*
1450  * Do the worker threads work when needed
1451  */
1452 int execute_session(struct CitContext *bind_me)
1453 {
1454         int force_purge;
1455
1456         become_session(bind_me);
1457
1458         /* If the client has sent a command, execute it. */
1459         if (CC->input_waiting) {
1460                 CC->h_command_function();
1461                 CC->input_waiting = 0;
1462         }
1463
1464         /* If there are asynchronous messages waiting and the
1465          * client supports it, do those now */
1466         if ((CC->is_async) && (CC->async_waiting)
1467            && (CC->h_async_function != NULL)) {
1468                 CC->h_async_function();
1469                 CC->async_waiting = 0;
1470         }
1471
1472         force_purge = CC->kill_me;
1473         if (force_purge)
1474                 CT->Context = NULL;
1475         become_session(NULL);
1476         bind_me->state = CON_IDLE;
1477         return force_purge;
1478 }
1479
1480
1481
1482 extern void dead_session_purge(int force);
1483
1484 /*
1485  * A new worker_thread loop.
1486  */
1487
1488 void *new_worker_thread(void *arg)
1489 {
1490         struct CitContext *bind_me;
1491         int force_purge;
1492
1493         while (!CtdlThreadCheckStop()) {
1494
1495                 /* make doubly sure we're not holding any stale db handles
1496                  * which might cause a deadlock.
1497                  */
1498                 cdb_check_handles();
1499                 force_purge = 0;
1500                 bind_me = NULL;         /* Which session shall we handle? */
1501
1502                 if (CT->Context == NULL)
1503                         select_on_master();
1504                 if (CtdlThreadCheckStop())
1505                         break;
1506
1507                 if (CT->Context)
1508                         bind_me = select_on_client();
1509                 if (CtdlThreadCheckStop())
1510                         break;
1511
1512                 if (bind_me)
1513                         force_purge = execute_session(bind_me);
1514
1515                 dead_session_purge(force_purge);
1516                 if (CtdlThreadCheckStop())
1517                         break;
1518
1519                 do_housekeeping();
1520         }
1521         return NULL;
1522 }