2 * Thread handling stuff for Citadel server
4 * Copyright (c) 1987-2011 by the citadel.org team
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.
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.
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
24 #include <sys/types.h>
26 #include <sys/socket.h>
33 #if TIME_WITH_SYS_TIME
34 # include <sys/time.h>
38 # include <sys/time.h>
47 # if HAVE_SYS_SYSCALL_H
48 # include <sys/syscall.h>
52 #include <libcitadel.h>
55 #include "ctdl_module.h"
56 #include "modules_init.h"
57 #include "housekeeping.h"
59 #include "citserver.h"
60 #include "sysdep_decls.h"
64 * define this to use the new worker_thread method of handling connections
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;
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
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;
86 CtdlThreadNode *CtdlThreadList = NULL;
87 CtdlThreadNode *CtdlThreadSchedList = NULL;
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;
95 citthread_mutex_t Critters[MAX_SEMAPHORES]; /* Things needing locking */
99 void InitialiseSemaphores(void)
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);
113 * Obtain a semaphore lock to begin a critical section.
114 * but only if no one else has one
116 int try_critical_section(int which_one)
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.
122 if ( (which_one != S_FLOORCACHE)
123 #ifdef DEBUG_MEMORY_LEAKS
124 && (which_one != S_DEBUGMEMLEAKS)
126 && (which_one != S_RPLIST)
130 return (citthread_mutex_trylock(&Critters[which_one]));
135 * Obtain a semaphore lock to begin a critical section.
137 void begin_critical_section(int which_one)
139 /* syslog(LOG_DEBUG, "begin_critical_section(%d)\n", which_one); */
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.
145 if ( (which_one != S_FLOORCACHE)
146 #ifdef DEBUG_MEMORY_LEAKS
147 && (which_one != S_DEBUGMEMLEAKS)
149 && (which_one != S_RPLIST)
153 citthread_mutex_lock(&Critters[which_one]);
157 * Release a semaphore lock to end a critical section.
159 void end_critical_section(int which_one)
161 citthread_mutex_unlock(&Critters[which_one]);
166 * A function to destroy the TSD
168 static void ctdl_thread_internal_dest_tsd(void *arg)
178 * A function to initialise the thread TSD
180 void ctdl_thread_internal_init_tsd(void)
184 if ((ret = citthread_key_create(&ThreadKey, ctdl_thread_internal_dest_tsd))) {
185 syslog(LOG_EMERG, "citthread_key_create: %s\n", strerror(ret));
191 * Ensure that we have a key for thread-specific data.
193 * This should be called immediately after startup by any thread
196 void CtdlThreadAllocTSD(void)
200 if (citthread_getspecific(ThreadKey) != NULL)
203 tsd = malloc(sizeof(ThreadTSD));
207 memset(tsd->cursors, 0, sizeof tsd->cursors);
210 citthread_setspecific(ThreadKey, tsd);
214 void ctdl_thread_internal_free_tsd(void)
216 ctdl_thread_internal_dest_tsd(citthread_getspecific(ThreadKey));
217 citthread_setspecific(ThreadKey, NULL);
221 void ctdl_thread_internal_cleanup(void)
224 CtdlThreadNode *this_thread, *that_thread;
226 for (i=0; i<CTDL_THREAD_LAST_STATE; i++)
228 free (CtdlThreadStates[i]);
231 /* Clean up the scheduled thread list */
232 this_thread = CtdlThreadSchedList;
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);
244 ctdl_thread_internal_free_tsd();
247 void ctdl_thread_internal_init(void)
249 CtdlThreadNode *this_thread;
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");
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");
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));
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);
277 /* We are garbage collector so create us as running */
278 this_thread->state = CTDL_THREAD_RUNNING;
280 if ((ret = citthread_attr_init(&this_thread->attr))) {
281 syslog(LOG_EMERG, "Thread system, citthread_attr_init: %s\n", strerror(ret));
286 this_thread->name = "Garbage Collection Thread";
288 this_thread->tid = citthread_self();
289 GC_thread = this_thread;
292 num_threads++; // Increase the count of threads in the system.
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. */
305 * A function to update a threads load averages
307 void ctdl_thread_internal_update_avgs(CtdlThreadNode *this_thread)
309 struct timeval now, result;
310 double last_duration;
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);
329 * A function to chenge the state of a thread
331 void ctdl_thread_internal_change_state (CtdlThreadNode *this_thread, enum CtdlThreadState new_state)
334 * Wether we change state or not we need update the load values
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);
350 * A function to tell all threads to exit
352 void CtdlThreadStopAll(void)
354 /* First run any registered shutdown hooks. This probably doesn't belong here. */
355 PerformSessionHooks(EVT_SHUTDOWN);
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
362 CtdlThreadNode *this_thread;
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;
370 if (!citthread_equal(this_thread->tid, GC_thread->tid))
371 citthread_kill(this_thread->tid, SIGHUP);
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;
381 end_critical_section(S_THREAD_LIST);
386 * A function to wake up all sleeping threads
388 void CtdlThreadWakeAll(void)
390 CtdlThreadNode *this_thread;
392 syslog(LOG_DEBUG, "Thread system waking all threads.\n");
394 begin_critical_section(S_THREAD_LIST);
395 this_thread = CtdlThreadList;
398 if (!this_thread->thread_func)
400 citthread_cond_signal(&this_thread->ThreadCond);
401 citthread_cond_signal(&this_thread->SleepCond);
403 this_thread = this_thread->next;
405 end_critical_section(S_THREAD_LIST);
410 * A function to return the number of threads running in the system
412 int CtdlThreadGetCount(void)
417 int CtdlThreadGetWorkers(void)
422 double CtdlThreadGetWorkerAvg(void)
426 begin_critical_section(S_THREAD_LIST);
427 ret = CtdlThreadWorkerAvg;
428 end_critical_section(S_THREAD_LIST);
432 double CtdlThreadGetLoadAvg(void)
434 double load_avg[3] = {0.0, 0.0, 0.0};
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 */
443 #ifdef HAVE_GETLOADAVG
444 ret = getloadavg(load_avg, 3);
448 return load_avg[0] / smp_num_cpus;
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.
458 begin_critical_section(S_THREAD_LIST);
459 ret = CtdlThreadLoadAvg;
460 end_critical_section(S_THREAD_LIST);
469 * A function to rename a thread
470 * Returns a const char *
472 const char *CtdlThreadName(const char *name)
474 const char *old_name;
478 syslog(LOG_WARNING, "Thread system WARNING. Attempt to CtdlThreadRename() a non thread. %s\n", name);
489 * A function to force a thread to exit
491 void CtdlThreadCancel(CtdlThreadNode *thread)
493 CtdlThreadNode *this_thread;
498 this_thread = thread;
501 syslog(LOG_EMERG, "Thread system PANIC. Attempt to CtdlThreadCancel() a non thread.\n");
506 if (!this_thread->thread_func)
508 syslog(LOG_EMERG, "Thread system PANIC. Attempt to CtdlThreadCancel() the garbage collector.\n");
513 ctdl_thread_internal_change_state (this_thread, CTDL_THREAD_CANCELLED);
514 citthread_cancel(this_thread->tid);
519 * A function for a thread to check if it has been asked to stop
521 int CtdlThreadCheckStop(void)
527 syslog(LOG_EMERG, "Thread system PANIC, CtdlThreadCheckStop() called by a non thread.\n");
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;
541 if(state == CTDL_THREAD_STOP_REQ)
543 CT->state = CTDL_THREAD_STOPPING;
546 else if((state < CTDL_THREAD_STOP_REQ) && (state > CTDL_THREAD_CREATE))
555 * A function to ask a thread to exit
556 * The thread must call CtdlThreadCheckStop() periodically to determine if it should exit
558 void CtdlThreadStop(CtdlThreadNode *thread)
560 CtdlThreadNode *this_thread;
565 this_thread = thread;
568 if (!(this_thread->thread_func))
569 return; // Don't stop garbage collector
571 if (!citthread_equal(this_thread->tid, GC_thread->tid))
572 citthread_kill(this_thread->tid, SIGHUP);
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);
581 * So we now have a sleep command that works with threads but it is in seconds
583 void CtdlThreadSleep(int secs)
585 struct timespec wake_time;
586 struct timeval time_now;
591 syslog(LOG_WARNING, "CtdlThreadSleep() called by something that is not a thread. Should we die?\n");
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;
600 ctdl_thread_internal_change_state (CT, CTDL_THREAD_SLEEPING);
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);
606 ctdl_thread_internal_change_state (CT, CTDL_THREAD_RUNNING);
611 * Routine to clean up our thread function on exit
613 static void ctdl_internal_thread_cleanup(void *arg)
616 * In here we were called by the current thread because it is exiting
617 * NB. WE ARE THE CURRENT THREAD
621 const char *name = CT->name;
622 const pid_t tid = CT->tid;
624 syslog(LOG_NOTICE, "Thread \"%s\" (0x%08lx) exited.\n", name, (unsigned long) tid);
628 syslog(LOG_NOTICE, "some ((unknown ? ? ?) Thread exited.\n");
631 #ifdef HAVE_BACKTRACE
632 /// eCrash_UnregisterThread();
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);
641 * A quick function to show the load averages
643 void ctdl_thread_internal_calc_loadavg(void)
645 CtdlThreadNode *that_thread;
646 double load_avg, worker_avg;
649 that_thread = CtdlThreadList;
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)
664 worker_avg += that_thread->load_avg;
667 #ifdef WITH_THREADLOG
668 syslog(LOG_DEBUG, "CtdlThread, \"%s\" (%lu) \"%s\" %.2f %.2f %.2f %.2f\n",
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);
677 citthread_mutex_unlock(&that_thread->ThreadMutex);
678 that_thread = that_thread->next;
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);
689 * Garbage collection routine.
690 * Gets called by main() in a loop to clean up the thread list periodically.
692 void CtdlThreadGC (void)
694 CtdlThreadNode *this_thread, *that_thread;
695 int workers = 0, sys_workers;
698 begin_critical_section(S_THREAD_LIST);
700 /* Handle exiting of garbage collector thread */
702 CtdlThreadList->state = CTDL_THREAD_EXITED;
704 #ifdef WITH_THREADLOG
705 syslog(LOG_DEBUG, "Thread system running garbage collection.\n");
708 * Woke up to do garbage collection
710 this_thread = CtdlThreadList;
713 that_thread = this_thread;
714 this_thread = this_thread->next;
716 if ((that_thread->state == CTDL_THREAD_STOP_REQ || that_thread->state == CTDL_THREAD_STOPPING)
717 && (!citthread_equal(that_thread->tid, citthread_self())))
719 syslog(LOG_DEBUG, "Waiting for thread %s (0x%08lx) to exit.\n", that_thread->name, that_thread->tid);
720 terminate_stuck_sessions();
725 * Catch the situation where a worker was asked to stop but couldn't and we are not
728 that_thread->stop_ticker = 0;
731 if (that_thread->stop_ticker + 5 == time(NULL))
733 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);
734 if ((that_thread->flags & CTDLTHREAD_WORKER) == 0)
735 syslog(LOG_INFO, "Thread System: A non worker thread would have been canceled this may cause message loss.\n");
736 // that_thread->state = CTDL_THREAD_CANCELLED;
737 that_thread->stop_ticker++;
738 // citthread_cancel(that_thread->tid);
742 /* Do we need to clean up this thread? */
743 if ((that_thread->state != CTDL_THREAD_EXITED) && (that_thread->state != CTDL_THREAD_CANCELLED))
745 if(that_thread->flags & CTDLTHREAD_WORKER)
746 workers++; /* Sanity check on number of worker threads */
750 if (citthread_equal(that_thread->tid, citthread_self()) && that_thread->thread_func)
752 end_critical_section(S_THREAD_LIST);
753 syslog(LOG_EMERG, "Thread system PANIC, a thread is trying to clean up after itself.\n");
758 if (num_threads <= 0)
760 end_critical_section(S_THREAD_LIST);
761 syslog(LOG_EMERG, "Thread system PANIC, num_threads <= 0 and trying to do Garbage Collection.\n");
766 if(that_thread->flags & CTDLTHREAD_WORKER)
767 num_workers--; /* This is a wroker thread so reduce the count. */
769 /* If we are unlinking the list head then the next becomes the list head */
770 if(that_thread->prev)
771 that_thread->prev->next = that_thread->next;
773 CtdlThreadList = that_thread->next;
774 if(that_thread->next)
775 that_thread->next->prev = that_thread->prev;
777 citthread_cond_signal(&that_thread->ThreadCond);
778 citthread_cond_signal(&that_thread->SleepCond); // Make sure this thread is awake
779 citthread_mutex_lock(&that_thread->ThreadMutex); // Make sure it has done what its doing
780 citthread_mutex_unlock(&that_thread->ThreadMutex);
782 * Join on the thread to do clean up and prevent memory leaks
783 * Also makes sure the thread has cleaned up after itself before we remove it from the list
784 * We can join on the garbage collector thread the join should just return EDEADLCK
786 ret = citthread_join (that_thread->tid, NULL);
788 syslog(LOG_DEBUG, "Garbage collection on own thread.\n");
789 else if (ret == EINVAL)
790 syslog(LOG_DEBUG, "Garbage collection, that thread already joined on.\n");
791 else if (ret == ESRCH)
792 syslog(LOG_DEBUG, "Garbage collection, no thread to join on.\n");
794 syslog(LOG_DEBUG, "Garbage collection, citthread_join returned an unknown error(%d).\n", ret);
796 * Now we own that thread entry
798 syslog(LOG_INFO, "Garbage Collection for thread \"%s\" (0x%08lx).\n",
799 that_thread->name, that_thread->tid);
800 citthread_mutex_destroy(&that_thread->ThreadMutex);
801 citthread_cond_destroy(&that_thread->ThreadCond);
802 citthread_mutex_destroy(&that_thread->SleepMutex);
803 citthread_cond_destroy(&that_thread->SleepCond);
804 citthread_attr_destroy(&that_thread->attr);
807 sys_workers = num_workers;
808 end_critical_section(S_THREAD_LIST);
810 /* Sanity check number of worker threads */
811 if (workers != sys_workers)
814 "Thread system PANIC, discrepancy in number of worker threads. Counted %d, should be %d.\n",
825 * Runtime function for a Citadel Thread.
826 * This initialises the threads environment and then calls the user supplied thread function
827 * Note that this is the REAL thread function and wraps the users thread function.
829 static void *ctdl_internal_thread_func (void *arg)
831 CtdlThreadNode *this_thread;
834 /* lock and unlock the thread list.
835 * This causes this thread to wait until all its creation stuff has finished before it
836 * can continue its execution.
838 begin_critical_section(S_THREAD_LIST);
839 this_thread = (CtdlThreadNode *) arg;
840 gettimeofday(&this_thread->start_time, NULL); /* Time this thread started */
842 // Register the cleanup function to take care of when we exit.
843 citthread_cleanup_push(ctdl_internal_thread_cleanup, NULL);
844 // Get our thread data structure
845 CtdlThreadAllocTSD();
847 this_thread->pid = getpid();
848 memcpy(&this_thread->last_state_change, &this_thread->start_time, sizeof (struct timeval)); /* Changed state so mark it. */
849 /* Only change to running state if we weren't asked to stop during the create cycle
850 * Other wise there is a window to allow this threads creation to continue to full grown and
851 * therby prevent a shutdown of the server.
853 if (!CtdlThreadCheckStop())
855 citthread_mutex_lock(&this_thread->ThreadMutex);
856 this_thread->state = CTDL_THREAD_RUNNING;
857 citthread_mutex_unlock(&this_thread->ThreadMutex);
859 end_critical_section(S_THREAD_LIST);
861 // Register for tracing
862 #ifdef HAVE_BACKTRACE
863 /// eCrash_RegisterThread(this_thread->name, 0);
866 // Tell the world we are here
867 #if defined(HAVE_SYSCALL_H) && defined (SYS_gettid)
868 this_thread->reltid = syscall(SYS_gettid);
870 syslog(LOG_NOTICE, "Created a new thread \"%s\" (0x%08lx).\n",
871 this_thread->name, this_thread->tid);
874 * run the thread to do the work but only if we haven't been asked to stop
876 if (!CtdlThreadCheckStop())
877 ret = (this_thread->thread_func)(this_thread->user_args);
880 * Our thread is exiting either because it wanted to end or because the server is stopping
881 * We need to clean up
883 citthread_cleanup_pop(1); // Execute our cleanup routine and remove it
892 * Function to initialise an empty thread structure
894 CtdlThreadNode *ctdl_internal_init_thread_struct(CtdlThreadNode *this_thread, long flags)
898 // Ensuring this is zero'd means we make sure the thread doesn't start doing its thing until we are ready.
899 memset (this_thread, 0, sizeof(CtdlThreadNode));
901 /* Create the mutex's early so we can use them */
902 citthread_mutex_init (&(this_thread->ThreadMutex), NULL);
903 citthread_cond_init (&(this_thread->ThreadCond), NULL);
904 citthread_mutex_init (&(this_thread->SleepMutex), NULL);
905 citthread_cond_init (&(this_thread->SleepCond), NULL);
907 this_thread->state = CTDL_THREAD_CREATE;
909 if ((ret = citthread_attr_init(&this_thread->attr))) {
910 citthread_mutex_unlock(&this_thread->ThreadMutex);
911 citthread_mutex_destroy(&(this_thread->ThreadMutex));
912 citthread_cond_destroy(&(this_thread->ThreadCond));
913 citthread_mutex_destroy(&(this_thread->SleepMutex));
914 citthread_cond_destroy(&(this_thread->SleepCond));
915 syslog(LOG_EMERG, "Thread system, citthread_attr_init: %s\n", strerror(ret));
920 /* Our per-thread stacks need to be bigger than the default size,
921 * otherwise the MIME parser crashes on FreeBSD, and the IMAP service
922 * crashes on 64-bit Linux.
924 if (flags & CTDLTHREAD_BIGSTACK)
926 #ifdef WITH_THREADLOG
927 syslog(LOG_INFO, "Thread system. Creating BIG STACK thread.\n");
929 if ((ret = citthread_attr_setstacksize(&this_thread->attr, THREADSTACKSIZE))) {
930 citthread_mutex_unlock(&this_thread->ThreadMutex);
931 citthread_mutex_destroy(&(this_thread->ThreadMutex));
932 citthread_cond_destroy(&(this_thread->ThreadCond));
933 citthread_mutex_destroy(&(this_thread->SleepMutex));
934 citthread_cond_destroy(&(this_thread->SleepCond));
935 citthread_attr_destroy(&this_thread->attr);
936 syslog(LOG_EMERG, "Thread system, citthread_attr_setstacksize: %s\n",
943 /* Set this new thread with an avg_blocked of 2. We do this so that its creation affects the
944 * load average for the system. If we don't do this then we create a mass of threads at the same time
945 * because the creation didn't affect the load average.
947 this_thread->avg_blocked = 2;
949 return (this_thread);
956 * Internal function to create a thread.
958 CtdlThreadNode *ctdl_internal_create_thread(char *name, long flags, void *(*thread_func) (void *arg), void *args)
961 CtdlThreadNode *this_thread;
963 if (num_threads >= 32767)
965 syslog(LOG_EMERG, "Thread system. Thread list full.\n");
969 this_thread = malloc(sizeof(CtdlThreadNode));
970 if (this_thread == NULL) {
971 syslog(LOG_EMERG, "Thread system, can't allocate CtdlThreadNode, exiting\n");
975 /* Initialise the thread structure */
976 if (ctdl_internal_init_thread_struct(this_thread, flags) == NULL)
979 syslog(LOG_EMERG, "Thread system, can't initialise CtdlThreadNode, exiting\n");
983 * If we got here we are going to create the thread so we must initilise the structure
984 * first because most implimentations of threading can't create it in a stopped state
985 * and it might want to do things with its structure that aren't initialised otherwise.
989 this_thread->name = name;
993 this_thread->name = "Un-named Thread";
996 this_thread->flags = flags;
997 this_thread->thread_func = thread_func;
998 this_thread->user_args = args;
1000 begin_critical_section(S_THREAD_LIST);
1002 * We pass this_thread into the thread as its args so that it can find out information
1003 * about itself and it has a bit of storage space for itself, not to mention that the REAL
1004 * thread function needs to finish off the setup of the structure
1006 if ((ret = citthread_create(&this_thread->tid, &this_thread->attr, ctdl_internal_thread_func, this_thread) != 0))
1008 end_critical_section(S_THREAD_LIST);
1009 syslog(LOG_ALERT, "Thread system, Can't create thread: %s\n",
1011 citthread_mutex_unlock(&this_thread->ThreadMutex);
1012 citthread_mutex_destroy(&(this_thread->ThreadMutex));
1013 citthread_cond_destroy(&(this_thread->ThreadCond));
1014 citthread_mutex_destroy(&(this_thread->SleepMutex));
1015 citthread_cond_destroy(&(this_thread->SleepCond));
1016 citthread_attr_destroy(&this_thread->attr);
1020 num_threads++; // Increase the count of threads in the system.
1021 if(this_thread->flags & CTDLTHREAD_WORKER)
1024 this_thread->next = CtdlThreadList;
1025 CtdlThreadList = this_thread;
1026 if (this_thread->next)
1027 this_thread->next->prev = this_thread;
1028 ctdl_thread_internal_calc_loadavg();
1030 end_critical_section(S_THREAD_LIST);
1036 * Wrapper function to create a thread
1037 * ensures the critical section and other protections are in place.
1038 * char *name = name to give to thread, if NULL, use generic name
1039 * int flags = flags to determine type of thread and standard facilities
1041 CtdlThreadNode *CtdlThreadCreate(char *name, long flags, void *(*thread_func) (void *arg), void *args)
1043 CtdlThreadNode *ret = NULL;
1045 ret = ctdl_internal_create_thread(name, flags, thread_func, args);
1051 CtdlThreadNode *ctdl_thread_internal_start_scheduled (CtdlThreadNode *this_thread)
1055 begin_critical_section(S_THREAD_LIST);
1057 * We pass this_thread into the thread as its args so that it can find out information
1058 * about itself and it has a bit of storage space for itself, not to mention that the REAL
1059 * thread function needs to finish off the setup of the structure
1061 if ((ret = citthread_create(&this_thread->tid, &this_thread->attr, ctdl_internal_thread_func, this_thread) != 0))
1063 end_critical_section(S_THREAD_LIST);
1064 syslog(LOG_DEBUG, "Failed to start scheduled thread \"%s\": %s\n", this_thread->name, strerror(ret));
1065 citthread_mutex_destroy(&(this_thread->ThreadMutex));
1066 citthread_cond_destroy(&(this_thread->ThreadCond));
1067 citthread_mutex_destroy(&(this_thread->SleepMutex));
1068 citthread_cond_destroy(&(this_thread->SleepCond));
1069 citthread_attr_destroy(&this_thread->attr);
1075 num_threads++; // Increase the count of threads in the system.
1076 if(this_thread->flags & CTDLTHREAD_WORKER)
1079 this_thread->next = CtdlThreadList;
1080 CtdlThreadList = this_thread;
1081 if (this_thread->next)
1082 this_thread->next->prev = this_thread;
1084 ctdl_thread_internal_calc_loadavg();
1085 end_critical_section(S_THREAD_LIST);
1093 void ctdl_thread_internal_check_scheduled(void)
1095 CtdlThreadNode *this_thread, *that_thread;
1098 /* Don't start scheduled threads if the system wants single user mode */
1099 if (CtdlWantSingleUser())
1102 if (try_critical_section(S_SCHEDULE_LIST))
1103 return; /* If this list is locked we wait till the next chance */
1107 #ifdef WITH_THREADLOG
1108 syslog(LOG_DEBUG, "Checking for scheduled threads to start.\n");
1111 this_thread = CtdlThreadSchedList;
1114 that_thread = this_thread;
1115 this_thread = this_thread->next;
1117 if (now > that_thread->when)
1119 /* Unlink from schedule list */
1120 if (that_thread->prev)
1121 that_thread->prev->next = that_thread->next;
1123 CtdlThreadSchedList = that_thread->next;
1124 if (that_thread->next)
1125 that_thread->next->prev = that_thread->prev;
1127 that_thread->next = that_thread->prev = NULL;
1128 #ifdef WITH_THREADLOG
1129 syslog(LOG_DEBUG, "About to start scheduled thread \"%s\".\n", that_thread->name);
1131 if (CT->state > CTDL_THREAD_STOP_REQ)
1132 { /* Only start it if the system is not stopping */
1133 if (ctdl_thread_internal_start_scheduled (that_thread))
1135 #ifdef WITH_THREADLOG
1136 syslog(LOG_INFO, "Thread system, Started a scheduled thread \"%s\" (0x%08lx).\n",
1137 that_thread->name, that_thread->tid);
1142 #ifdef WITH_THREADLOG
1145 syslog(LOG_DEBUG, "Thread \"%s\" will start in %ld seconds.\n",
1146 that_thread->name, that_thread->when - time(NULL));
1150 end_critical_section(S_SCHEDULE_LIST);
1155 * A warapper function for select so we can show a thread as blocked
1157 int CtdlThreadSelect(int n, fd_set *readfds, fd_set *writefds, fd_set *exceptfds, struct timeval *timeout)
1161 ctdl_thread_internal_change_state(CT, CTDL_THREAD_BLOCKED);
1162 if (!CtdlThreadCheckStop())
1163 ret = select(n, readfds, writefds, exceptfds, timeout);
1165 * If the select returned <= 0 then it failed due to an error
1166 * or timeout so this thread could stop if asked to do so.
1167 * Anything else means it needs to continue unless the system is shutting down
1172 * The select says this thread needs to do something useful.
1173 * This thread was in an idle state so it may have been asked to stop
1174 * but if the system isn't shutting down this thread is no longer
1175 * idle and select has given it a task to do so it must not stop
1176 * In this condition we need to force it into the running state.
1177 * CtdlThreadGC will clear its ticker for us.
1179 * FIXME: there is still a small hole here. It is possible for the sequence of locking
1180 * to allow the state to get changed to STOP_REQ just after this code if the other thread
1181 * has decided to change the state before this lock, it there fore has to wait till the lock
1182 * completes but it will continue to change the state. We need something a bit better here.
1184 citthread_mutex_lock(&CT->ThreadMutex); /* To prevent race condition of a sleeping thread */
1185 if (GC_thread->state > CTDL_THREAD_STOP_REQ && CT->state <= CTDL_THREAD_STOP_REQ)
1187 syslog(LOG_DEBUG, "Thread %s (0x%08lx) refused stop request.\n", CT->name, CT->tid);
1188 CT->state = CTDL_THREAD_RUNNING;
1190 citthread_mutex_unlock(&CT->ThreadMutex);
1193 ctdl_thread_internal_change_state(CT, CTDL_THREAD_RUNNING);
1200 void *new_worker_thread(void *arg);
1201 extern void close_masters (void);
1204 void *simulation_worker (void*arg) {
1205 struct CitContext *this;
1207 this = CreateNewContext();
1210 this->state = CON_IDLE;
1211 dead_session_purge(1);
1212 begin_critical_section(S_SESSION_TABLE);
1214 end_critical_section(S_SESSION_TABLE);
1219 void *simulation_thread (void *arg)
1221 long stats = statcount;
1223 while(stats && !CtdlThreadCheckStop()) {
1224 CtdlThreadCreate("Connection simulation worker", CTDLTHREAD_BIGSTACK, simulation_worker, NULL);
1227 CtdlThreadStopAll();
1231 void go_threading(void)
1234 CtdlThreadNode *last_worker;
1235 struct timeval start, now, result;
1236 double last_duration;
1239 * Initialise the thread system
1241 ctdl_thread_internal_init();
1243 /* Second call to module init functions now that threading is up */
1245 initialise_modules(1);
1246 CtdlThreadCreate("select_on_master", CTDLTHREAD_BIGSTACK, select_on_master, NULL);
1249 syslog(LOG_EMERG, "Running connection simulation stats\n");
1250 gettimeofday(&start, NULL);
1251 CtdlThreadCreate("Connection simulation master", CTDLTHREAD_BIGSTACK, simulation_thread, NULL);
1256 * This thread is now used for garbage collection of other threads in the thread list
1258 syslog(LOG_INFO, "Startup thread %ld becoming garbage collector,\n", (long) citthread_self());
1261 * We do a lot of locking and unlocking of the thread list in here.
1262 * We do this so that we can repeatedly release time for other threads
1263 * that may be waiting on the thread list.
1264 * We are a low priority thread so we can afford to do this
1267 while (CtdlThreadGetCount())
1270 exit_signal = CT->signal;
1273 CtdlThreadStopAll();
1275 check_sched_shutdown();
1276 if (CT->state > CTDL_THREAD_STOP_REQ)
1278 begin_critical_section(S_THREAD_LIST);
1279 ctdl_thread_internal_calc_loadavg();
1280 end_critical_section(S_THREAD_LIST);
1282 ctdl_thread_internal_check_scheduled(); /* start scheduled threads */
1285 /* Reduce the size of the worker thread pool if necessary. */
1286 if ((CtdlThreadGetWorkers() > config.c_min_workers + 1) && (CtdlThreadWorkerAvg < 20) && (CT->state > CTDL_THREAD_STOP_REQ))
1288 /* Ask a worker thread to stop as we no longer need it */
1289 begin_critical_section(S_THREAD_LIST);
1290 last_worker = CtdlThreadList;
1293 citthread_mutex_lock(&last_worker->ThreadMutex);
1294 if (last_worker->flags & CTDLTHREAD_WORKER && (last_worker->state > CTDL_THREAD_STOPPING) && (last_worker->Context == NULL))
1296 citthread_mutex_unlock(&last_worker->ThreadMutex);
1299 citthread_mutex_unlock(&last_worker->ThreadMutex);
1300 last_worker = last_worker->next;
1302 end_critical_section(S_THREAD_LIST);
1305 #ifdef WITH_THREADLOG
1306 syslog(LOG_DEBUG, "Thread system, stopping excess worker thread \"%s\" (0x%08lx).\n",
1311 CtdlThreadStop(last_worker);
1316 * If all our workers are working hard, start some more to help out
1319 /* FIXME: come up with a better way to dynamically alter the number of threads
1320 * based on the system load
1323 if ((((CtdlThreadGetWorkers() < config.c_max_workers) && (CtdlThreadGetWorkerAvg() > 60)) || CtdlThreadGetWorkers() < config.c_min_workers) && (CT->state > CTDL_THREAD_STOP_REQ))
1325 /* Only start new threads if we are not going to overload the machine */
1326 /* Temporarily set to 10 should be enough to make sure we don't stranglew the server
1327 * at least until we make this a config option */
1328 if (CtdlThreadGetLoadAvg() < ((double)10.00)) {
1329 for (i=0; i<5 ; i++) {
1330 CtdlThreadCreate("Worker Thread",
1331 CTDLTHREAD_BIGSTACK + CTDLTHREAD_WORKER,
1338 syslog(LOG_WARNING, "Server strangled due to machine load average too high.\n");
1344 if (CtdlThreadGetCount() <= 1) // Shutting down clean up the garbage collector
1349 #ifdef THREADS_USESIGNALS
1350 if (CtdlThreadGetCount() && CT->state > CTDL_THREAD_STOP_REQ)
1352 if (CtdlThreadGetCount())
1357 * If the above loop exits we must be shutting down since we obviously have no threads
1359 ctdl_thread_internal_cleanup();
1362 gettimeofday(&now, NULL);
1363 timersub(&now, &start, &result);
1364 last_duration = (double)result.tv_sec + ((double)result.tv_usec / (double) 1000000);
1365 syslog(LOG_EMERG, "Simulated %ld connections in %f seconds\n", stats_done, last_duration);