-
-
-/*
- * Runtime function for a Citadel Thread.
- * This initialises the threads environment and then calls the user supplied thread function
- * Note that this is the REAL thread function and wraps the users thread function.
- */
-static void *ctdl_internal_thread_func(void *arg)
-{
- CtdlThreadNode *this_thread;
- void *ret = NULL;
-
- /* lock and unlock the thread list.
- * This causes this thread to wait until all its creation stuff has finished before it
- * can continue its execution.
- */
- begin_critical_section(S_THREAD_LIST);
- this_thread = (CtdlThreadNode *) arg;
- gettimeofday(&this_thread->start_time, NULL); /* Time this thread started */
-// citthread_mutex_lock(&this_thread->ThreadMutex);
-
- // Register the cleanup function to take care of when we exit.
- citthread_cleanup_push(ctdl_internal_thread_cleanup, NULL);
- // Get our thread data structure
- CtdlThreadAllocTSD();
- CT = this_thread;
- this_thread->pid = getpid();
- memcpy(&this_thread->last_state_change, &this_thread->start_time, sizeof(struct timeval)); /* Changed state so mark it. */
- /* Only change to running state if we weren't asked to stop during the create cycle
- * Other wise there is a window to allow this threads creation to continue to full grown and
- * therby prevent a shutdown of the server.
- */
-// citthread_mutex_unlock(&this_thread->ThreadMutex);
-
- if (!CtdlThreadCheckStop()) {
- citthread_mutex_lock(&this_thread->ThreadMutex);
- this_thread->state = CTDL_THREAD_RUNNING;
- citthread_mutex_unlock(&this_thread->ThreadMutex);
- }
- end_critical_section(S_THREAD_LIST);
-
- // Register for tracing
-#ifdef HAVE_BACKTRACE
- eCrash_RegisterThread(this_thread->name, 0);
-#endif
-
- // Tell the world we are here
- CtdlLogPrintf(CTDL_NOTICE, "Created a new thread \"%s\" (%ld). \n",
- this_thread->name, this_thread->tid);
-
-
-
- /*
- * run the thread to do the work but only if we haven't been asked to stop
- */
- if (!CtdlThreadCheckStop())
- ret = (this_thread->thread_func) (this_thread->user_args);
-
- /*
- * Our thread is exiting either because it wanted to end or because the server is stopping
- * We need to clean up
- */
- citthread_cleanup_pop(1); // Execute our cleanup routine and remove it
-
- return (ret);
-}
-
-
-
-
-/*
- * Function to initialise an empty thread structure
- */
-CtdlThreadNode *ctdl_internal_init_thread_struct(CtdlThreadNode *
- this_thread, long flags)
-{
- int ret = 0;
-
- // Ensuring this is zero'd means we make sure the thread doesn't start doing its thing until we are ready.
- memset(this_thread, 0, sizeof(CtdlThreadNode));
-
- /* Create the mutex's early so we can use them */
- citthread_mutex_init(&(this_thread->ThreadMutex), NULL);
- citthread_cond_init(&(this_thread->ThreadCond), NULL);
- citthread_mutex_init(&(this_thread->SleepMutex), NULL);
- citthread_cond_init(&(this_thread->SleepCond), NULL);
-
- this_thread->state = CTDL_THREAD_CREATE;
-
- if ((ret = citthread_attr_init(&this_thread->attr))) {
- citthread_mutex_unlock(&this_thread->ThreadMutex);
- citthread_mutex_destroy(&(this_thread->ThreadMutex));
- citthread_cond_destroy(&(this_thread->ThreadCond));
- citthread_mutex_destroy(&(this_thread->SleepMutex));
- citthread_cond_destroy(&(this_thread->SleepCond));
- CtdlLogPrintf(CTDL_EMERG,
- "Thread system, citthread_attr_init: %s\n",
- strerror(ret));
- free(this_thread);
- return NULL;
- }
-
- /* Our per-thread stacks need to be bigger than the default size,
- * otherwise the MIME parser crashes on FreeBSD, and the IMAP service
- * crashes on 64-bit Linux.
- */
- if (flags & CTDLTHREAD_BIGSTACK) {
-#ifdef WITH_THREADLOG
- CtdlLogPrintf(CTDL_INFO,
- "Thread system. Creating BIG STACK thread.\n");
-#endif
- if ((ret =
- citthread_attr_setstacksize(&this_thread->attr,
- THREADSTACKSIZE))) {
- citthread_mutex_unlock(&this_thread->ThreadMutex);
- citthread_mutex_destroy(&
- (this_thread->
- ThreadMutex));
- citthread_cond_destroy(&(this_thread->ThreadCond));
- citthread_mutex_destroy(&
- (this_thread->SleepMutex));
- citthread_cond_destroy(&(this_thread->SleepCond));
- citthread_attr_destroy(&this_thread->attr);
- CtdlLogPrintf(CTDL_EMERG,
- "Thread system, citthread_attr_setstacksize: %s\n",
- strerror(ret));
- free(this_thread);
- return NULL;
- }
- }
-
- /* Set this new thread with an avg_blocked of 2. We do this so that its creation affects the
- * load average for the system. If we don't do this then we create a mass of threads at the same time
- * because the creation didn't affect the load average.
- */
- this_thread->avg_blocked = 2;
-
- return (this_thread);
-}
-
-
-
-
-/*
- * Internal function to create a thread.
- */
-CtdlThreadNode *ctdl_internal_create_thread(char *name, long flags,
- void *(*thread_func) (void
- *arg),
- void *args)
-{
- int ret = 0;
- CtdlThreadNode *this_thread;
-
- if (num_threads >= 32767) {
- CtdlLogPrintf(CTDL_EMERG,
- "Thread system. Thread list full.\n");
- return NULL;
- }
-
- this_thread = malloc(sizeof(CtdlThreadNode));
- if (this_thread == NULL) {
- CtdlLogPrintf(CTDL_EMERG,
- "Thread system, can't allocate CtdlThreadNode, exiting\n");
- return NULL;
- }
-
- /* Initialise the thread structure */
- if (ctdl_internal_init_thread_struct(this_thread, flags) == NULL) {
- free(this_thread);
- CtdlLogPrintf(CTDL_EMERG,
- "Thread system, can't initialise CtdlThreadNode, exiting\n");
- return NULL;
- }
- /*
- * If we got here we are going to create the thread so we must initilise the structure
- * first because most implimentations of threading can't create it in a stopped state
- * and it might want to do things with its structure that aren't initialised otherwise.
- */
- if (name) {
- this_thread->name = name;
- } else {
- this_thread->name = "Un-named Thread";
- }
-
- this_thread->flags = flags;
- this_thread->thread_func = thread_func;
- this_thread->user_args = args;
-
-// citthread_mutex_lock(&this_thread->ThreadMutex);
-
- begin_critical_section(S_THREAD_LIST);
- /*
- * We pass this_thread into the thread as its args so that it can find out information
- * about itself and it has a bit of storage space for itself, not to mention that the REAL
- * thread function needs to finish off the setup of the structure
- */
- if ((ret =
- citthread_create(&this_thread->tid, &this_thread->attr,
- ctdl_internal_thread_func,
- this_thread) != 0)) {
- end_critical_section(S_THREAD_LIST);
- CtdlLogPrintf(CTDL_ALERT,
- "Thread system, Can't create thread: %s\n",
- strerror(ret));
- citthread_mutex_unlock(&this_thread->ThreadMutex);
- citthread_mutex_destroy(&(this_thread->ThreadMutex));
- citthread_cond_destroy(&(this_thread->ThreadCond));
- citthread_mutex_destroy(&(this_thread->SleepMutex));
- citthread_cond_destroy(&(this_thread->SleepCond));
- citthread_attr_destroy(&this_thread->attr);
- free(this_thread);
- return NULL;
- }
-
- num_threads++; // Increase the count of threads in the system.
- if (this_thread->flags & CTDLTHREAD_WORKER)
- num_workers++;
-
- this_thread->next = CtdlThreadList;
- CtdlThreadList = this_thread;
- if (this_thread->next)
- this_thread->next->prev = this_thread;
- ctdl_thread_internal_calc_loadavg();
-
-// citthread_mutex_unlock(&this_thread->ThreadMutex);
- end_critical_section(S_THREAD_LIST);
-
- return this_thread;
-}
-
-/*
- * Wrapper function to create a thread
- * ensures the critical section and other protections are in place.
- * char *name = name to give to thread, if NULL, use generic name
- * int flags = flags to determine type of thread and standard facilities
- */
-CtdlThreadNode *CtdlThreadCreate(char *name, long flags,
- void *(*thread_func) (void *arg),
- void *args)
-{
- CtdlThreadNode *ret = NULL;
-
- ret = ctdl_internal_create_thread(name, flags, thread_func, args);
- return ret;
-}
-
-
-
-/*
- * Internal function to schedule a thread.
- * Must be called from within a S_THREAD_LIST critical section
- */
-CtdlThreadNode *CtdlThreadSchedule(char *name, long flags,
- void *(*thread_func) (void *arg),
- void *args, time_t when)
-{
- CtdlThreadNode *this_thread;
-
- if (num_threads >= 32767) {
- CtdlLogPrintf(CTDL_EMERG,
- "Thread system. Thread list full.\n");
- return NULL;
- }
-
- this_thread = malloc(sizeof(CtdlThreadNode));
- if (this_thread == NULL) {
- CtdlLogPrintf(CTDL_EMERG,
- "Thread system, can't allocate CtdlThreadNode, exiting\n");
- return NULL;
- }
- /* Initialise the thread structure */
- if (ctdl_internal_init_thread_struct(this_thread, flags) == NULL) {
- free(this_thread);
- CtdlLogPrintf(CTDL_EMERG,
- "Thread system, can't initialise CtdlThreadNode, exiting\n");
- return NULL;
- }
-
- /*
- * If we got here we are going to create the thread so we must initilise the structure
- * first because most implimentations of threading can't create it in a stopped state
- * and it might want to do things with its structure that aren't initialised otherwise.
- */
- if (name) {
- this_thread->name = name;
- } else {
- this_thread->name = "Un-named Thread";
- }
-
- this_thread->flags = flags;
- this_thread->thread_func = thread_func;
- this_thread->user_args = args;
-
- /*
- * When to start this thread
- */
- this_thread->when = when;
-
- begin_critical_section(S_SCHEDULE_LIST);
- this_thread->next = CtdlThreadSchedList;
- CtdlThreadSchedList = this_thread;
- if (this_thread->next)
- this_thread->next->prev = this_thread;
- end_critical_section(S_SCHEDULE_LIST);
-
- return this_thread;
-}
-
-
-
-CtdlThreadNode *ctdl_thread_internal_start_scheduled(CtdlThreadNode *
- this_thread)
-{
- int ret = 0;
-
-// citthread_mutex_lock(&that_thread->ThreadMutex);
- begin_critical_section(S_THREAD_LIST);
- /*
- * We pass this_thread into the thread as its args so that it can find out information
- * about itself and it has a bit of storage space for itself, not to mention that the REAL
- * thread function needs to finish off the setup of the structure
- */
- if ((ret =
- citthread_create(&this_thread->tid, &this_thread->attr,
- ctdl_internal_thread_func,
- this_thread) != 0)) {
- end_critical_section(S_THREAD_LIST);
- CtdlLogPrintf(CTDL_DEBUG,
- "Failed to start scheduled thread \"%s\": %s\n",
- this_thread->name, strerror(ret));
-// citthread_mutex_unlock(&this_thread->ThreadMutex);
- citthread_mutex_destroy(&(this_thread->ThreadMutex));
- citthread_cond_destroy(&(this_thread->ThreadCond));
- citthread_mutex_destroy(&(this_thread->SleepMutex));
- citthread_cond_destroy(&(this_thread->SleepCond));
- citthread_attr_destroy(&this_thread->attr);
- free(this_thread);
- return NULL;
- }
-
-
- num_threads++; // Increase the count of threads in the system.
- if (this_thread->flags & CTDLTHREAD_WORKER)
- num_workers++;
-
- this_thread->next = CtdlThreadList;
- CtdlThreadList = this_thread;
- if (this_thread->next)
- this_thread->next->prev = this_thread;
-// citthread_mutex_unlock(&that_thread->ThreadMutex);
-
- ctdl_thread_internal_calc_loadavg();
- end_critical_section(S_THREAD_LIST);
-
-
- return this_thread;
-}
-
-
-
-void ctdl_thread_internal_check_scheduled(void)
-{
- CtdlThreadNode *this_thread, *that_thread;
- time_t now;
-
- if (try_critical_section(S_SCHEDULE_LIST))
- return; /* If this list is locked we wait till the next chance */
-
- now = time(NULL);
-
-#ifdef WITH_THREADLOG
- CtdlLogPrintf(CTDL_DEBUG,
- "Checking for scheduled threads to start.\n");
-#endif
-
- this_thread = CtdlThreadSchedList;
- while (this_thread) {
- that_thread = this_thread;
- this_thread = this_thread->next;
-
- if (now > that_thread->when) {
- /* Unlink from schedule list */
- if (that_thread->prev)
- that_thread->prev->next =
- that_thread->next;
- else
- CtdlThreadSchedList = that_thread->next;
- if (that_thread->next)
- that_thread->next->prev =
- that_thread->prev;
-
- that_thread->next = that_thread->prev = NULL;
-#ifdef WITH_THREADLOG
- CtdlLogPrintf(CTDL_DEBUG,
- "About to start scheduled thread \"%s\".\n",
- that_thread->name);
-#endif
- if (CT->state > CTDL_THREAD_STOP_REQ) { /* Only start it if the system is not stopping */
- if (ctdl_thread_internal_start_scheduled
- (that_thread)) {
-#ifdef WITH_THREADLOG
- CtdlLogPrintf(CTDL_INFO,
- "Thread system, Started a scheduled thread \"%s\" (%ud).\n",
- that_thread->name,
- that_thread->tid);
-#endif
- }
- }
- }
-#ifdef WITH_THREADLOG
- else {
- CtdlLogPrintf(CTDL_DEBUG,
- "Thread \"%s\" will start in %ld seconds.\n",
- that_thread->name,
- that_thread->when - time(NULL));
- }
-#endif
- }
- end_critical_section(S_SCHEDULE_LIST);