citadel/threads.c

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