xnu-1699.32.7.tar.gz

[apple/xnu.git] / osfmk / kern / thread.c

/*
 * Copyright (c) 2000-2010 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * @OSF_FREE_COPYRIGHT@
 */
/* 
 * Mach Operating System
 * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
 * All Rights Reserved.
 * 
 * Permission to use, copy, modify and distribute this software and its
 * documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 * 
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 * 
 * Carnegie Mellon requests users of this software to return to
 * 
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 * 
 * any improvements or extensions that they make and grant Carnegie Mellon
 * the rights to redistribute these changes.
 */
/*
 */
/*
 *      File:   kern/thread.c
 *      Author: Avadis Tevanian, Jr., Michael Wayne Young, David Golub
 *      Date:   1986
 *
 *      Thread management primitives implementation.
 */
/*
 * Copyright (c) 1993 The University of Utah and
 * the Computer Systems Laboratory (CSL).  All rights reserved.
 *
 * Permission to use, copy, modify and distribute this software and its
 * documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 *
 * THE UNIVERSITY OF UTAH AND CSL ALLOW FREE USE OF THIS SOFTWARE IN ITS "AS
 * IS" CONDITION.  THE UNIVERSITY OF UTAH AND CSL DISCLAIM ANY LIABILITY OF
 * ANY KIND FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 *
 * CSL requests users of this software to return to csl-dist@cs.utah.edu any
 * improvements that they make and grant CSL redistribution rights.
 *
 */

#include <mach/mach_types.h>
#include <mach/boolean.h>
#include <mach/policy.h>
#include <mach/thread_info.h>
#include <mach/thread_special_ports.h>
#include <mach/thread_status.h>
#include <mach/time_value.h>
#include <mach/vm_param.h>

#include <machine/thread.h>
#include <machine/pal_routines.h>

#include <kern/kern_types.h>
#include <kern/kalloc.h>
#include <kern/cpu_data.h>
#include <kern/counters.h>
#include <kern/extmod_statistics.h>
#include <kern/ipc_mig.h>
#include <kern/ipc_tt.h>
#include <kern/mach_param.h>
#include <kern/machine.h>
#include <kern/misc_protos.h>
#include <kern/processor.h>
#include <kern/queue.h>
#include <kern/sched.h>
#include <kern/sched_prim.h>
#include <kern/sync_lock.h>
#include <kern/syscall_subr.h>
#include <kern/task.h>
#include <kern/thread.h>
#include <kern/host.h>
#include <kern/zalloc.h>
#include <kern/assert.h>

#include <ipc/ipc_kmsg.h>
#include <ipc/ipc_port.h>

#include <vm/vm_kern.h>
#include <vm/vm_pageout.h>

#include <sys/kdebug.h>

#include <mach/sdt.h>

/*
 * Exported interfaces
 */
#include <mach/task_server.h>
#include <mach/thread_act_server.h>
#include <mach/mach_host_server.h>
#include <mach/host_priv_server.h>

static struct zone                      *thread_zone;
static lck_grp_attr_t           thread_lck_grp_attr;
lck_attr_t                                      thread_lck_attr;
lck_grp_t                                       thread_lck_grp;

decl_simple_lock_data(static,thread_stack_lock)
static queue_head_t             thread_stack_queue;

decl_simple_lock_data(static,thread_terminate_lock)
static queue_head_t             thread_terminate_queue;

static struct thread    thread_template, init_thread;

static void             sched_call_null(
                                        int                     type,
                                        thread_t        thread);

#ifdef MACH_BSD
extern void proc_exit(void *);
extern uint64_t get_dispatchqueue_offset_from_proc(void *);
#endif /* MACH_BSD */

extern int debug_task;
int thread_max = CONFIG_THREAD_MAX;     /* Max number of threads */
int task_threadmax = CONFIG_THREAD_MAX;

static uint64_t         thread_unique_id = 0;

void
thread_bootstrap(void)
{
        /*
         *      Fill in a template thread for fast initialization.
         */

        thread_template.runq = PROCESSOR_NULL;

        thread_template.ref_count = 2;

        thread_template.reason = AST_NONE;
        thread_template.at_safe_point = FALSE;
        thread_template.wait_event = NO_EVENT64;
        thread_template.wait_queue = WAIT_QUEUE_NULL;
        thread_template.wait_result = THREAD_WAITING;
        thread_template.options = THREAD_ABORTSAFE;
        thread_template.state = TH_WAIT | TH_UNINT;
        thread_template.wake_active = FALSE;
        thread_template.continuation = THREAD_CONTINUE_NULL;
        thread_template.parameter = NULL;

        thread_template.importance = 0;
        thread_template.sched_mode = TH_MODE_NONE;
        thread_template.sched_flags = 0;
        thread_template.saved_mode = TH_MODE_NONE;
        thread_template.safe_release = 0;

        thread_template.priority = 0;
        thread_template.sched_pri = 0;
        thread_template.max_priority = 0;
        thread_template.task_priority = 0;
        thread_template.promotions = 0;
        thread_template.pending_promoter_index = 0;
        thread_template.pending_promoter[0] =
                thread_template.pending_promoter[1] = NULL;

        thread_template.realtime.deadline = UINT64_MAX;

        thread_template.current_quantum = 0;
        thread_template.last_run_time = 0;
        thread_template.last_quantum_refill_time = 0;

        thread_template.computation_metered = 0;
        thread_template.computation_epoch = 0;

#if defined(CONFIG_SCHED_TRADITIONAL)
        thread_template.sched_stamp = 0;
        thread_template.pri_shift = INT8_MAX;
        thread_template.sched_usage = 0;
        thread_template.cpu_usage = thread_template.cpu_delta = 0;
#endif
        thread_template.c_switch = thread_template.p_switch = thread_template.ps_switch = 0;

        thread_template.bound_processor = PROCESSOR_NULL;
        thread_template.last_processor = PROCESSOR_NULL;

        thread_template.sched_call = sched_call_null;

        timer_init(&thread_template.user_timer);
        timer_init(&thread_template.system_timer);
        thread_template.user_timer_save = 0;
        thread_template.system_timer_save = 0;
        thread_template.vtimer_user_save = 0;
        thread_template.vtimer_prof_save = 0;
        thread_template.vtimer_rlim_save = 0;

        thread_template.wait_timer_is_set = FALSE;
        thread_template.wait_timer_active = 0;

        thread_template.depress_timer_active = 0;

        thread_template.special_handler.handler = special_handler;
        thread_template.special_handler.next = NULL;

        thread_template.funnel_lock = THR_FUNNEL_NULL;
        thread_template.funnel_state = 0;
        thread_template.recover = (vm_offset_t)NULL;
        
        thread_template.map = VM_MAP_NULL;

#if CONFIG_DTRACE
        thread_template.t_dtrace_predcache = 0;
        thread_template.t_dtrace_vtime = 0;
        thread_template.t_dtrace_tracing = 0;
#endif /* CONFIG_DTRACE */

        thread_template.t_chud = 0;
        thread_template.t_page_creation_count = 0;
        thread_template.t_page_creation_time = 0;

        thread_template.affinity_set = NULL;
        
        thread_template.syscalls_unix = 0;
        thread_template.syscalls_mach = 0;

        thread_template.tkm_private.alloc = 0;
        thread_template.tkm_private.free = 0;
        thread_template.tkm_shared.alloc = 0;
        thread_template.tkm_shared.free = 0;
        thread_template.actionstate = default_task_null_policy;
        thread_template.ext_actionstate = default_task_null_policy;
        thread_template.policystate = default_task_proc_policy;
        thread_template.ext_policystate = default_task_proc_policy;

        init_thread = thread_template;
        machine_set_current_thread(&init_thread);
}

void
thread_init(void)
{
        thread_zone = zinit(
                        sizeof(struct thread),
                        thread_max * sizeof(struct thread),
                        THREAD_CHUNK * sizeof(struct thread),
                        "threads");

        lck_grp_attr_setdefault(&thread_lck_grp_attr);
        lck_grp_init(&thread_lck_grp, "thread", &thread_lck_grp_attr);
        lck_attr_setdefault(&thread_lck_attr);
        
        stack_init();

        /*
         *      Initialize any machine-dependent
         *      per-thread structures necessary.
         */
        machine_thread_init();
}

static void
thread_terminate_continue(void)
{
        panic("thread_terminate_continue");
        /*NOTREACHED*/
}

/*
 *      thread_terminate_self:
 */
void
thread_terminate_self(void)
{
        thread_t                thread = current_thread();

        task_t                  task;
        spl_t                   s;
        int threadcnt;

        pal_thread_terminate_self(thread);

        DTRACE_PROC(lwp__exit);

        thread_mtx_lock(thread);

        ulock_release_all(thread);

        ipc_thread_disable(thread);
        
        thread_mtx_unlock(thread);

        s = splsched();
        thread_lock(thread);

        /*
         *      Cancel priority depression, wait for concurrent expirations
         *      on other processors.
         */
        if (thread->sched_flags & TH_SFLAG_DEPRESSED_MASK) {
                thread->sched_flags &= ~TH_SFLAG_DEPRESSED_MASK;

                if (timer_call_cancel(&thread->depress_timer))
                        thread->depress_timer_active--;
        }

        while (thread->depress_timer_active > 0) {
                thread_unlock(thread);
                splx(s);

                delay(1);

                s = splsched();
                thread_lock(thread);
        }

        thread_sched_call(thread, NULL);

        thread_unlock(thread);
        splx(s);

        thread_policy_reset(thread);

        task = thread->task;
        uthread_cleanup(task, thread->uthread, task->bsd_info);
        threadcnt = hw_atomic_sub(&task->active_thread_count, 1);

        /*
         * If we are the last thread to terminate and the task is
         * associated with a BSD process, perform BSD process exit.
         */
        if (threadcnt == 0 && task->bsd_info != NULL)
                proc_exit(task->bsd_info);

        uthread_cred_free(thread->uthread);

        s = splsched();
        thread_lock(thread);

        /*
         *      Cancel wait timer, and wait for
         *      concurrent expirations.
         */
        if (thread->wait_timer_is_set) {
                thread->wait_timer_is_set = FALSE;

                if (timer_call_cancel(&thread->wait_timer))
                        thread->wait_timer_active--;
        }

        while (thread->wait_timer_active > 0) {
                thread_unlock(thread);
                splx(s);

                delay(1);

                s = splsched();
                thread_lock(thread);
        }

        /*
         *      If there is a reserved stack, release it.
         */
        if (thread->reserved_stack != 0) {
                stack_free_reserved(thread);
                thread->reserved_stack = 0;
        }

        /*
         *      Mark thread as terminating, and block.
         */
        thread->state |= TH_TERMINATE;
        thread_mark_wait_locked(thread, THREAD_UNINT);
        assert(thread->promotions == 0);
        thread_unlock(thread);
        /* splsched */

        thread_block((thread_continue_t)thread_terminate_continue);
        /*NOTREACHED*/
}

void
thread_deallocate(
        thread_t                        thread)
{
        task_t                          task;

        if (thread == THREAD_NULL)
                return;

        if (thread_deallocate_internal(thread) > 0)
                return;


        ipc_thread_terminate(thread);

        task = thread->task;

#ifdef MACH_BSD 
        {
                void *ut = thread->uthread;

                thread->uthread = NULL;
                uthread_zone_free(ut);
        }
#endif  /* MACH_BSD */   

        if (thread->kernel_stack != 0)
                stack_free(thread);

        lck_mtx_destroy(&thread->mutex, &thread_lck_grp);
        machine_thread_destroy(thread);

        task_deallocate(task);

        zfree(thread_zone, thread);
}

/*
 *      thread_terminate_daemon:
 *
 *      Perform final clean up for terminating threads.
 */
static void
thread_terminate_daemon(void)
{
        thread_t        self, thread;
        task_t          task;

        self = current_thread();
        self->options |= TH_OPT_SYSTEM_CRITICAL;

        (void)splsched();
        simple_lock(&thread_terminate_lock);

        while ((thread = (thread_t)dequeue_head(&thread_terminate_queue)) != THREAD_NULL) {
                simple_unlock(&thread_terminate_lock);
                (void)spllo();

                task = thread->task;

                task_lock(task);
                task->total_user_time += timer_grab(&thread->user_timer);
                task->total_system_time += timer_grab(&thread->system_timer);

                task->c_switch += thread->c_switch;
                task->p_switch += thread->p_switch;
                task->ps_switch += thread->ps_switch;

                task->syscalls_unix += thread->syscalls_unix;
                task->syscalls_mach += thread->syscalls_mach;

                task->tkm_private.alloc += thread->tkm_private.alloc;
                task->tkm_private.free += thread->tkm_private.free;
                task->tkm_shared.alloc += thread->tkm_shared.alloc;
                task->tkm_shared.free += thread->tkm_shared.free;

                queue_remove(&task->threads, thread, thread_t, task_threads);
                task->thread_count--;

                /* 
                 * If the task is being halted, and there is only one thread
                 * left in the task after this one, then wakeup that thread.
                 */
                if (task->thread_count == 1 && task->halting)
                        thread_wakeup((event_t)&task->halting);

                task_unlock(task);

                lck_mtx_lock(&tasks_threads_lock);
                queue_remove(&threads, thread, thread_t, threads);
                threads_count--;
                lck_mtx_unlock(&tasks_threads_lock);

                thread_deallocate(thread);

                (void)splsched();
                simple_lock(&thread_terminate_lock);
        }

        assert_wait((event_t)&thread_terminate_queue, THREAD_UNINT);
        simple_unlock(&thread_terminate_lock);
        /* splsched */

        self->options &= ~TH_OPT_SYSTEM_CRITICAL;
        thread_block((thread_continue_t)thread_terminate_daemon);
        /*NOTREACHED*/
}

/*
 *      thread_terminate_enqueue:
 *
 *      Enqueue a terminating thread for final disposition.
 *
 *      Called at splsched.
 */
void
thread_terminate_enqueue(
        thread_t                thread)
{
        simple_lock(&thread_terminate_lock);
        enqueue_tail(&thread_terminate_queue, (queue_entry_t)thread);
        simple_unlock(&thread_terminate_lock);

        thread_wakeup((event_t)&thread_terminate_queue);
}

/*
 *      thread_stack_daemon:
 *
 *      Perform stack allocation as required due to
 *      invoke failures.
 */
static void
thread_stack_daemon(void)
{
        thread_t                thread;

        simple_lock(&thread_stack_lock);

        while ((thread = (thread_t)dequeue_head(&thread_stack_queue)) != THREAD_NULL) {
                simple_unlock(&thread_stack_lock);

                stack_alloc(thread);
                
                (void)splsched();
                thread_lock(thread);
                thread_setrun(thread, SCHED_PREEMPT | SCHED_TAILQ);
                thread_unlock(thread);
                (void)spllo();

                simple_lock(&thread_stack_lock);
        }

        assert_wait((event_t)&thread_stack_queue, THREAD_UNINT);
        simple_unlock(&thread_stack_lock);

        thread_block((thread_continue_t)thread_stack_daemon);
        /*NOTREACHED*/
}

/*
 *      thread_stack_enqueue:
 *
 *      Enqueue a thread for stack allocation.
 *
 *      Called at splsched.
 */
void
thread_stack_enqueue(
        thread_t                thread)
{
        simple_lock(&thread_stack_lock);
        enqueue_tail(&thread_stack_queue, (queue_entry_t)thread);
        simple_unlock(&thread_stack_lock);

        thread_wakeup((event_t)&thread_stack_queue);
}

void
thread_daemon_init(void)
{
        kern_return_t   result;
        thread_t        thread = NULL;

        simple_lock_init(&thread_terminate_lock, 0);
        queue_init(&thread_terminate_queue);

        result = kernel_thread_start_priority((thread_continue_t)thread_terminate_daemon, NULL, MINPRI_KERNEL, &thread);
        if (result != KERN_SUCCESS)
                panic("thread_daemon_init: thread_terminate_daemon");

        thread_deallocate(thread);

        simple_lock_init(&thread_stack_lock, 0);
        queue_init(&thread_stack_queue);

        result = kernel_thread_start_priority((thread_continue_t)thread_stack_daemon, NULL, BASEPRI_PREEMPT, &thread);
        if (result != KERN_SUCCESS)
                panic("thread_daemon_init: thread_stack_daemon");

        thread_deallocate(thread);
}

/*
 * Create a new thread.
 * Doesn't start the thread running.
 */
static kern_return_t
thread_create_internal(
        task_t                                  parent_task,
        integer_t                               priority,
        thread_continue_t               continuation,
        int                                             options,
#define TH_OPTION_NONE          0x00
#define TH_OPTION_NOCRED        0x01
#define TH_OPTION_NOSUSP        0x02
        thread_t                                *out_thread)
{
        thread_t                                new_thread;
        static thread_t                 first_thread;

        /*
         *      Allocate a thread and initialize static fields
         */
        if (first_thread == THREAD_NULL)
                new_thread = first_thread = current_thread();
        else
                new_thread = (thread_t)zalloc(thread_zone);
        if (new_thread == THREAD_NULL)
                return (KERN_RESOURCE_SHORTAGE);

        if (new_thread != first_thread)
                *new_thread = thread_template;

#ifdef MACH_BSD
        new_thread->uthread = uthread_alloc(parent_task, new_thread, (options & TH_OPTION_NOCRED) != 0);
        if (new_thread->uthread == NULL) {
                zfree(thread_zone, new_thread);
                return (KERN_RESOURCE_SHORTAGE);
        }
#endif  /* MACH_BSD */

        if (machine_thread_create(new_thread, parent_task) != KERN_SUCCESS) {
#ifdef MACH_BSD
                void *ut = new_thread->uthread;

                new_thread->uthread = NULL;
                /* cred free may not be necessary */
                uthread_cleanup(parent_task, ut, parent_task->bsd_info);
                uthread_cred_free(ut);
                uthread_zone_free(ut);
#endif  /* MACH_BSD */

                zfree(thread_zone, new_thread);
                return (KERN_FAILURE);
        }

    new_thread->task = parent_task;

        thread_lock_init(new_thread);
        wake_lock_init(new_thread);

        lck_mtx_init(&new_thread->mutex, &thread_lck_grp, &thread_lck_attr);

        ipc_thread_init(new_thread);
        queue_init(&new_thread->held_ulocks);

        new_thread->continuation = continuation;

        lck_mtx_lock(&tasks_threads_lock);
        task_lock(parent_task);

        if (    !parent_task->active || parent_task->halting ||
                        ((options & TH_OPTION_NOSUSP) != 0 &&
                                parent_task->suspend_count > 0) ||
                        (parent_task->thread_count >= task_threadmax &&
                                parent_task != kernel_task)             ) {
                task_unlock(parent_task);
                lck_mtx_unlock(&tasks_threads_lock);

#ifdef MACH_BSD
                {
                        void *ut = new_thread->uthread;

                        new_thread->uthread = NULL;
                        uthread_cleanup(parent_task, ut, parent_task->bsd_info);
                        /* cred free may not be necessary */
                        uthread_cred_free(ut);
                        uthread_zone_free(ut);
                }
#endif  /* MACH_BSD */
                ipc_thread_disable(new_thread);
                ipc_thread_terminate(new_thread);
                lck_mtx_destroy(&new_thread->mutex, &thread_lck_grp);
                machine_thread_destroy(new_thread);
                zfree(thread_zone, new_thread);
                return (KERN_FAILURE);
        }

        /* New threads inherit any default state on the task */
        machine_thread_inherit_taskwide(new_thread, parent_task);

        task_reference_internal(parent_task);

        /* Cache the task's map */
        new_thread->map = parent_task->map;

        /* Chain the thread onto the task's list */
        queue_enter(&parent_task->threads, new_thread, thread_t, task_threads);
        parent_task->thread_count++;
        
        /* So terminating threads don't need to take the task lock to decrement */
        hw_atomic_add(&parent_task->active_thread_count, 1);

        /* Protected by the tasks_threads_lock */
        new_thread->thread_id = ++thread_unique_id;

        queue_enter(&threads, new_thread, thread_t, threads);
        threads_count++;

        timer_call_setup(&new_thread->wait_timer, thread_timer_expire, new_thread);
        timer_call_setup(&new_thread->depress_timer, thread_depress_expire, new_thread);

#if CONFIG_COUNTERS
        /*
         * If parent task has any reservations, they need to be propagated to this
         * thread.
         */
        new_thread->t_chud = (TASK_PMC_FLAG == (parent_task->t_chud & TASK_PMC_FLAG)) ? 
                THREAD_PMC_FLAG : 0U;
#endif

        /* Set the thread's scheduling parameters */
        new_thread->sched_mode = SCHED(initial_thread_sched_mode)(parent_task);
        new_thread->sched_flags = 0;
        new_thread->max_priority = parent_task->max_priority;
        new_thread->task_priority = parent_task->priority;
        new_thread->priority = (priority < 0)? parent_task->priority: priority;
        if (new_thread->priority > new_thread->max_priority)
                new_thread->priority = new_thread->max_priority;
#if CONFIG_EMBEDDED 
        if (new_thread->priority < MAXPRI_THROTTLE) {
                new_thread->priority = MAXPRI_THROTTLE;
        }
#endif /* CONFIG_EMBEDDED */
        new_thread->importance =
                                        new_thread->priority - new_thread->task_priority;
#if defined(CONFIG_SCHED_TRADITIONAL)
        new_thread->sched_stamp = sched_tick;
        new_thread->pri_shift = sched_pri_shift;
#endif
        SCHED(compute_priority)(new_thread, FALSE);

        new_thread->active = TRUE;

        *out_thread = new_thread;

        {
                long    dbg_arg1, dbg_arg2, dbg_arg3, dbg_arg4;

                kdbg_trace_data(parent_task->bsd_info, &dbg_arg2);

                KERNEL_DEBUG_CONSTANT(
                                        TRACEDBG_CODE(DBG_TRACE_DATA, 1) | DBG_FUNC_NONE,
                                                        (vm_address_t)(uintptr_t)thread_tid(new_thread), dbg_arg2, 0, 0, 0);

                kdbg_trace_string(parent_task->bsd_info,
                                                        &dbg_arg1, &dbg_arg2, &dbg_arg3, &dbg_arg4);

                KERNEL_DEBUG_CONSTANT(
                                        TRACEDBG_CODE(DBG_TRACE_STRING, 1) | DBG_FUNC_NONE,
                                                        dbg_arg1, dbg_arg2, dbg_arg3, dbg_arg4, 0);
        }

        DTRACE_PROC1(lwp__create, thread_t, *out_thread);

        return (KERN_SUCCESS);
}

static kern_return_t
thread_create_internal2(
        task_t                          task,
        thread_t                        *new_thread,
        boolean_t                       from_user)
{
        kern_return_t           result;
        thread_t                        thread;

        if (task == TASK_NULL || task == kernel_task)
                return (KERN_INVALID_ARGUMENT);

        result = thread_create_internal(task, -1, (thread_continue_t)thread_bootstrap_return, TH_OPTION_NONE, &thread);
        if (result != KERN_SUCCESS)
                return (result);

        thread->user_stop_count = 1;
        thread_hold(thread);
        if (task->suspend_count > 0)
                thread_hold(thread);

        if (from_user)
                extmod_statistics_incr_thread_create(task);

        task_unlock(task);
        lck_mtx_unlock(&tasks_threads_lock);
        
        *new_thread = thread;

        return (KERN_SUCCESS);
}

/* No prototype, since task_server.h has the _from_user version if KERNEL_SERVER */
kern_return_t
thread_create(
        task_t                          task,
        thread_t                        *new_thread);

kern_return_t
thread_create(
        task_t                          task,
        thread_t                        *new_thread)
{
        return thread_create_internal2(task, new_thread, FALSE);
}

kern_return_t
thread_create_from_user(
        task_t                          task,
        thread_t                        *new_thread)
{
        return thread_create_internal2(task, new_thread, TRUE);
}

static kern_return_t
thread_create_running_internal2(
        register task_t         task,
        int                     flavor,
        thread_state_t          new_state,
        mach_msg_type_number_t  new_state_count,
        thread_t                                *new_thread,
        boolean_t                               from_user)
{
        register kern_return_t  result;
        thread_t                                thread;

        if (task == TASK_NULL || task == kernel_task)
                return (KERN_INVALID_ARGUMENT);

        result = thread_create_internal(task, -1, (thread_continue_t)thread_bootstrap_return, TH_OPTION_NONE, &thread);
        if (result != KERN_SUCCESS)
                return (result);

        result = machine_thread_set_state(
                                                thread, flavor, new_state, new_state_count);
        if (result != KERN_SUCCESS) {
                task_unlock(task);
                lck_mtx_unlock(&tasks_threads_lock);

                thread_terminate(thread);
                thread_deallocate(thread);
                return (result);
        }

        thread_mtx_lock(thread);
        thread_start_internal(thread);
        thread_mtx_unlock(thread);

        if (from_user)
                extmod_statistics_incr_thread_create(task);

        task_unlock(task);
        lck_mtx_unlock(&tasks_threads_lock);

        *new_thread = thread;

        return (result);
}

/* Prototype, see justification above */
kern_return_t
thread_create_running(
        register task_t         task,
        int                     flavor,
        thread_state_t          new_state,
        mach_msg_type_number_t  new_state_count,
        thread_t                                *new_thread);

kern_return_t
thread_create_running(
        register task_t         task,
        int                     flavor,
        thread_state_t          new_state,
        mach_msg_type_number_t  new_state_count,
        thread_t                                *new_thread)
{
        return thread_create_running_internal2(
                task, flavor, new_state, new_state_count,
                new_thread, FALSE);
}

kern_return_t
thread_create_running_from_user(
        register task_t         task,
        int                     flavor,
        thread_state_t          new_state,
        mach_msg_type_number_t  new_state_count,
        thread_t                                *new_thread)
{
        return thread_create_running_internal2(
                task, flavor, new_state, new_state_count,
                new_thread, TRUE);
}

kern_return_t
thread_create_workq(
        task_t                          task,
        thread_continue_t               thread_return,
        thread_t                        *new_thread)
{
        kern_return_t           result;
        thread_t                        thread;

        if (task == TASK_NULL || task == kernel_task)
                return (KERN_INVALID_ARGUMENT);

        result = thread_create_internal(task, -1, thread_return, TH_OPTION_NOCRED | TH_OPTION_NOSUSP, &thread);
        if (result != KERN_SUCCESS)
                return (result);

        thread->user_stop_count = 1;
        thread_hold(thread);
        if (task->suspend_count > 0)
                thread_hold(thread);

        task_unlock(task);
        lck_mtx_unlock(&tasks_threads_lock);
        
        *new_thread = thread;

        return (KERN_SUCCESS);
}

/*
 *      kernel_thread_create:
 *
 *      Create a thread in the kernel task
 *      to execute in kernel context.
 */
kern_return_t
kernel_thread_create(
        thread_continue_t       continuation,
        void                            *parameter,
        integer_t                       priority,
        thread_t                        *new_thread)
{
        kern_return_t           result;
        thread_t                        thread;
        task_t                          task = kernel_task;

        result = thread_create_internal(task, priority, continuation, TH_OPTION_NONE, &thread);
        if (result != KERN_SUCCESS)
                return (result);

        task_unlock(task);
        lck_mtx_unlock(&tasks_threads_lock);

        stack_alloc(thread);
        assert(thread->kernel_stack != 0);
#if CONFIG_EMBEDDED
        if (priority > BASEPRI_KERNEL)
#endif
        thread->reserved_stack = thread->kernel_stack;

        thread->parameter = parameter;

if(debug_task & 1)
        kprintf("kernel_thread_create: thread = %p continuation = %p\n", thread, continuation);
        *new_thread = thread;

        return (result);
}

kern_return_t
kernel_thread_start_priority(
        thread_continue_t       continuation,
        void                            *parameter,
        integer_t                       priority,
        thread_t                        *new_thread)
{
        kern_return_t   result;
        thread_t                thread;

        result = kernel_thread_create(continuation, parameter, priority, &thread);
        if (result != KERN_SUCCESS)
                return (result);

        *new_thread = thread;   

        thread_mtx_lock(thread);
        thread_start_internal(thread);
        thread_mtx_unlock(thread);

        return (result);
}

kern_return_t
kernel_thread_start(
        thread_continue_t       continuation,
        void                            *parameter,
        thread_t                        *new_thread)
{
        return kernel_thread_start_priority(continuation, parameter, -1, new_thread);
}

#ifndef __LP64__

thread_t
kernel_thread(
        task_t                  task,
        void                    (*start)(void))
{
        kern_return_t   result;
        thread_t                thread;

        if (task != kernel_task)
                panic("kernel_thread");

        result = kernel_thread_start_priority((thread_continue_t)start, NULL, -1, &thread);
        if (result != KERN_SUCCESS)
                return (THREAD_NULL);

        thread_deallocate(thread);

        return (thread);
}

#endif  /* __LP64__ */

kern_return_t
thread_info_internal(
        register thread_t               thread,
        thread_flavor_t                 flavor,
        thread_info_t                   thread_info_out,        /* ptr to OUT array */
        mach_msg_type_number_t  *thread_info_count)     /*IN/OUT*/
{
        int                                             state, flags;
        spl_t                                   s;

        if (thread == THREAD_NULL)
                return (KERN_INVALID_ARGUMENT);

        if (flavor == THREAD_BASIC_INFO) {
            register thread_basic_info_t        basic_info;

            if (*thread_info_count < THREAD_BASIC_INFO_COUNT)
                        return (KERN_INVALID_ARGUMENT);

            basic_info = (thread_basic_info_t) thread_info_out;

            s = splsched();
            thread_lock(thread);

            /* fill in info */

            thread_read_times(thread, &basic_info->user_time,
                                                                        &basic_info->system_time);

                /*
                 *      Update lazy-evaluated scheduler info because someone wants it.
                 */
                if (SCHED(can_update_priority)(thread))
                        SCHED(update_priority)(thread);

                basic_info->sleep_time = 0;

                /*
                 *      To calculate cpu_usage, first correct for timer rate,
                 *      then for 5/8 ageing.  The correction factor [3/5] is
                 *      (1/(5/8) - 1).
                 */
                basic_info->cpu_usage = 0;
#if defined(CONFIG_SCHED_TRADITIONAL)
                if (sched_tick_interval) {
                        basic_info->cpu_usage = (integer_t)(((uint64_t)thread->cpu_usage
                                                                                * TH_USAGE_SCALE) /     sched_tick_interval);
                        basic_info->cpu_usage = (basic_info->cpu_usage * 3) / 5;
                }
#endif
                
                if (basic_info->cpu_usage > TH_USAGE_SCALE)
                        basic_info->cpu_usage = TH_USAGE_SCALE;

                basic_info->policy = ((thread->sched_mode == TH_MODE_TIMESHARE)?
                                                                                                POLICY_TIMESHARE: POLICY_RR);

            flags = 0;
                if (thread->bound_processor != PROCESSOR_NULL && thread->bound_processor->idle_thread == thread)
                        flags |= TH_FLAGS_IDLE;

            if (!thread->kernel_stack)
                        flags |= TH_FLAGS_SWAPPED;

            state = 0;
            if (thread->state & TH_TERMINATE)
                        state = TH_STATE_HALTED;
            else
                if (thread->state & TH_RUN)
                        state = TH_STATE_RUNNING;
            else
                if (thread->state & TH_UNINT)
                        state = TH_STATE_UNINTERRUPTIBLE;
            else
                if (thread->state & TH_SUSP)
                        state = TH_STATE_STOPPED;
            else
                if (thread->state & TH_WAIT)
                        state = TH_STATE_WAITING;

            basic_info->run_state = state;
            basic_info->flags = flags;

            basic_info->suspend_count = thread->user_stop_count;

            thread_unlock(thread);
            splx(s);

            *thread_info_count = THREAD_BASIC_INFO_COUNT;

            return (KERN_SUCCESS);
        }
        else
        if (flavor == THREAD_IDENTIFIER_INFO) {
            register thread_identifier_info_t   identifier_info;

            if (*thread_info_count < THREAD_IDENTIFIER_INFO_COUNT)
                        return (KERN_INVALID_ARGUMENT);

            identifier_info = (thread_identifier_info_t) thread_info_out;

            s = splsched();
            thread_lock(thread);

            identifier_info->thread_id = thread->thread_id;
            identifier_info->thread_handle = thread->machine.cthread_self;
            if(thread->task->bsd_info) {
                identifier_info->dispatch_qaddr =  identifier_info->thread_handle + get_dispatchqueue_offset_from_proc(thread->task->bsd_info);
            } else {
                    thread_unlock(thread);
                    splx(s);
                    return KERN_INVALID_ARGUMENT;
            }

            thread_unlock(thread);
            splx(s);
            return KERN_SUCCESS;
        }
        else
        if (flavor == THREAD_SCHED_TIMESHARE_INFO) {
                policy_timeshare_info_t         ts_info;

                if (*thread_info_count < POLICY_TIMESHARE_INFO_COUNT)
                        return (KERN_INVALID_ARGUMENT);

                ts_info = (policy_timeshare_info_t)thread_info_out;

            s = splsched();
                thread_lock(thread);

            if (thread->sched_mode != TH_MODE_TIMESHARE) {
                thread_unlock(thread);
                        splx(s);

                        return (KERN_INVALID_POLICY);
            }

                ts_info->depressed = (thread->sched_flags & TH_SFLAG_DEPRESSED_MASK) != 0;
                if (ts_info->depressed) {
                        ts_info->base_priority = DEPRESSPRI;
                        ts_info->depress_priority = thread->priority;
                }
                else {
                        ts_info->base_priority = thread->priority;
                        ts_info->depress_priority = -1;
                }

                ts_info->cur_priority = thread->sched_pri;
                ts_info->max_priority = thread->max_priority;

                thread_unlock(thread);
            splx(s);

                *thread_info_count = POLICY_TIMESHARE_INFO_COUNT;

                return (KERN_SUCCESS);  
        }
        else
        if (flavor == THREAD_SCHED_FIFO_INFO) {
                if (*thread_info_count < POLICY_FIFO_INFO_COUNT)
                        return (KERN_INVALID_ARGUMENT);

                return (KERN_INVALID_POLICY);
        }
        else
        if (flavor == THREAD_SCHED_RR_INFO) {
                policy_rr_info_t                        rr_info;
                uint32_t quantum_time;
                uint64_t quantum_ns;
                
                if (*thread_info_count < POLICY_RR_INFO_COUNT)
                        return (KERN_INVALID_ARGUMENT);

                rr_info = (policy_rr_info_t) thread_info_out;

            s = splsched();
                thread_lock(thread);

            if (thread->sched_mode == TH_MODE_TIMESHARE) {
                thread_unlock(thread);
                        splx(s);

                        return (KERN_INVALID_POLICY);
            }

                rr_info->depressed = (thread->sched_flags & TH_SFLAG_DEPRESSED_MASK) != 0;
                if (rr_info->depressed) {
                        rr_info->base_priority = DEPRESSPRI;
                        rr_info->depress_priority = thread->priority;
                }
                else {
                        rr_info->base_priority = thread->priority;
                        rr_info->depress_priority = -1;
                }

                quantum_time = SCHED(initial_quantum_size)(THREAD_NULL);
                absolutetime_to_nanoseconds(quantum_time, &quantum_ns);
                
                rr_info->max_priority = thread->max_priority;
            rr_info->quantum = (uint32_t)(quantum_ns / 1000 / 1000);

                thread_unlock(thread);
            splx(s);

                *thread_info_count = POLICY_RR_INFO_COUNT;

                return (KERN_SUCCESS);  
        }

        return (KERN_INVALID_ARGUMENT);
}

void
thread_read_times(
        thread_t                thread,
        time_value_t    *user_time,
        time_value_t    *system_time)
{
        clock_sec_t             secs;
        clock_usec_t    usecs;

        absolutetime_to_microtime(timer_grab(&thread->user_timer), &secs, &usecs);
        user_time->seconds = (typeof(user_time->seconds))secs;
        user_time->microseconds = usecs;

        absolutetime_to_microtime(timer_grab(&thread->system_timer), &secs, &usecs);
        system_time->seconds = (typeof(system_time->seconds))secs;
        system_time->microseconds = usecs;
}

kern_return_t
thread_assign(
        __unused thread_t                       thread,
        __unused processor_set_t        new_pset)
{
        return (KERN_FAILURE);
}

/*
 *      thread_assign_default:
 *
 *      Special version of thread_assign for assigning threads to default
 *      processor set.
 */
kern_return_t
thread_assign_default(
        thread_t                thread)
{
        return (thread_assign(thread, &pset0));
}

/*
 *      thread_get_assignment
 *
 *      Return current assignment for this thread.
 */         
kern_return_t
thread_get_assignment(
        thread_t                thread,
        processor_set_t *pset)
{
        if (thread == NULL)
                return (KERN_INVALID_ARGUMENT);

        *pset = &pset0;

        return (KERN_SUCCESS);
}

/*
 *      thread_wire_internal:
 *
 *      Specify that the target thread must always be able
 *      to run and to allocate memory.
 */
kern_return_t
thread_wire_internal(
        host_priv_t             host_priv,
        thread_t                thread,
        boolean_t               wired,
        boolean_t               *prev_state)
{
        if (host_priv == NULL || thread != current_thread())
                return (KERN_INVALID_ARGUMENT);

        assert(host_priv == &realhost);

        if (prev_state)
            *prev_state = (thread->options & TH_OPT_VMPRIV) != 0;
        
        if (wired) {
            if (!(thread->options & TH_OPT_VMPRIV)) 
                    vm_page_free_reserve(1);    /* XXX */
            thread->options |= TH_OPT_VMPRIV;
        }
        else {
            if (thread->options & TH_OPT_VMPRIV) 
                    vm_page_free_reserve(-1);   /* XXX */
            thread->options &= ~TH_OPT_VMPRIV;
        }

        return (KERN_SUCCESS);
}


/*
 *      thread_wire:
 *
 *      User-api wrapper for thread_wire_internal()
 */
kern_return_t
thread_wire(
        host_priv_t     host_priv,
        thread_t        thread,
        boolean_t       wired)
{
    return (thread_wire_internal(host_priv, thread, wired, NULL));
}

int             split_funnel_off = 0;
lck_grp_t       *funnel_lck_grp = LCK_GRP_NULL;
lck_grp_attr_t  *funnel_lck_grp_attr;
lck_attr_t      *funnel_lck_attr;

funnel_t *
funnel_alloc(
        int type)
{
        lck_mtx_t       *m;
        funnel_t        *fnl;

        if (funnel_lck_grp == LCK_GRP_NULL) {
                funnel_lck_grp_attr = lck_grp_attr_alloc_init();

                funnel_lck_grp = lck_grp_alloc_init("Funnel",  funnel_lck_grp_attr);

                funnel_lck_attr = lck_attr_alloc_init();
        }
        if ((fnl = (funnel_t *)kalloc(sizeof(funnel_t))) != 0){
                bzero((void *)fnl, sizeof(funnel_t));
                if ((m = lck_mtx_alloc_init(funnel_lck_grp, funnel_lck_attr)) == (lck_mtx_t *)NULL) {
                        kfree(fnl, sizeof(funnel_t));
                        return(THR_FUNNEL_NULL);
                }
                fnl->fnl_mutex = m;
                fnl->fnl_type = type;
        }
        return(fnl);
}

void 
funnel_free(
        funnel_t * fnl)
{
        lck_mtx_free(fnl->fnl_mutex, funnel_lck_grp);
        if (fnl->fnl_oldmutex)
                lck_mtx_free(fnl->fnl_oldmutex, funnel_lck_grp);
        kfree(fnl, sizeof(funnel_t));
}

void 
funnel_lock(
        funnel_t * fnl)
{
        lck_mtx_lock(fnl->fnl_mutex);
        fnl->fnl_mtxholder = current_thread();
}

void 
funnel_unlock(
        funnel_t * fnl)
{
        lck_mtx_unlock(fnl->fnl_mutex);
        fnl->fnl_mtxholder = NULL;
        fnl->fnl_mtxrelease = current_thread();
}

funnel_t *
thread_funnel_get(
        void)
{
        thread_t th = current_thread();

        if (th->funnel_state & TH_FN_OWNED) {
                return(th->funnel_lock);
        }
        return(THR_FUNNEL_NULL);
}

boolean_t
thread_funnel_set(
        funnel_t *      fnl,
        boolean_t       funneled)
{
        thread_t        cur_thread;
        boolean_t       funnel_state_prev;
        boolean_t       intr;
        
        cur_thread = current_thread();
        funnel_state_prev = ((cur_thread->funnel_state & TH_FN_OWNED) == TH_FN_OWNED);

        if (funnel_state_prev != funneled) {
                intr = ml_set_interrupts_enabled(FALSE);

                if (funneled == TRUE) {
                        if (cur_thread->funnel_lock)
                                panic("Funnel lock called when holding one %p", cur_thread->funnel_lock);
                        KERNEL_DEBUG(0x6032428 | DBG_FUNC_NONE,
                                                                                        fnl, 1, 0, 0, 0);
                        funnel_lock(fnl);
                        KERNEL_DEBUG(0x6032434 | DBG_FUNC_NONE,
                                                                                        fnl, 1, 0, 0, 0);
                        cur_thread->funnel_state |= TH_FN_OWNED;
                        cur_thread->funnel_lock = fnl;
                } else {
                        if(cur_thread->funnel_lock->fnl_mutex != fnl->fnl_mutex)
                                panic("Funnel unlock  when not holding funnel");
                        cur_thread->funnel_state &= ~TH_FN_OWNED;
                        KERNEL_DEBUG(0x603242c | DBG_FUNC_NONE,
                                                                fnl, 1, 0, 0, 0);

                        cur_thread->funnel_lock = THR_FUNNEL_NULL;
                        funnel_unlock(fnl);
                }
                (void)ml_set_interrupts_enabled(intr);
        } else {
                /* if we are trying to acquire funnel recursively
                 * check for funnel to be held already
                 */
                if (funneled && (fnl->fnl_mutex != cur_thread->funnel_lock->fnl_mutex)) {
                                panic("thread_funnel_set: already holding a different funnel");
                }
        }
        return(funnel_state_prev);
}

static void
sched_call_null(
__unused        int                     type,
__unused        thread_t        thread)
{
        return;
}

void
thread_sched_call(
        thread_t                thread,
        sched_call_t    call)
{
        thread->sched_call = (call != NULL)? call: sched_call_null;
}

void
thread_static_param(
        thread_t                thread,
        boolean_t               state)
{
        thread_mtx_lock(thread);
        thread->static_param = state;
        thread_mtx_unlock(thread);
}

uint64_t
thread_tid(
        thread_t        thread)
{
        return (thread != THREAD_NULL? thread->thread_id: 0);
}

uint64_t
thread_dispatchqaddr(
        thread_t                thread)
{
        uint64_t        dispatchqueue_addr = 0;
        uint64_t        thread_handle = 0;

        if (thread != THREAD_NULL) {
                thread_handle = thread->machine.cthread_self;

                if (thread->task->bsd_info)
                        dispatchqueue_addr = thread_handle + get_dispatchqueue_offset_from_proc(thread->task->bsd_info);
        }

        return (dispatchqueue_addr);
}

/*
 * Export routines to other components for things that are done as macros
 * within the osfmk component.
 */

#undef thread_reference
void thread_reference(thread_t thread);
void
thread_reference(
        thread_t        thread)
{
        if (thread != THREAD_NULL)
                thread_reference_internal(thread);
}

#undef thread_should_halt

boolean_t
thread_should_halt(
        thread_t                th)
{
        return (thread_should_halt_fast(th));
}

#if CONFIG_DTRACE
uint32_t dtrace_get_thread_predcache(thread_t thread)
{
        if (thread != THREAD_NULL)
                return thread->t_dtrace_predcache;
        else
                return 0;
}

int64_t dtrace_get_thread_vtime(thread_t thread)
{
        if (thread != THREAD_NULL)
                return thread->t_dtrace_vtime;
        else
                return 0;
}

int64_t dtrace_get_thread_tracing(thread_t thread)
{
        if (thread != THREAD_NULL)
                return thread->t_dtrace_tracing;
        else
                return 0;
}

boolean_t dtrace_get_thread_reentering(thread_t thread)
{
        if (thread != THREAD_NULL)
                return (thread->options & TH_OPT_DTRACE) ? TRUE : FALSE;
        else
                return 0;
}

vm_offset_t dtrace_get_kernel_stack(thread_t thread)
{
        if (thread != THREAD_NULL)
                return thread->kernel_stack;
        else
                return 0;
}

int64_t dtrace_calc_thread_recent_vtime(thread_t thread)
{
#if STAT_TIME
        if (thread != THREAD_NULL) {
                return timer_grab(&(thread->system_timer)) + timer_grab(&(thread->user_timer));
        } else
                return 0;
#else
        if (thread != THREAD_NULL) {
                processor_t             processor = current_processor();
                uint64_t                                abstime = mach_absolute_time();
                timer_t                                 timer;

                timer = PROCESSOR_DATA(processor, thread_timer);

                return timer_grab(&(thread->system_timer)) + timer_grab(&(thread->user_timer)) +
                                (abstime - timer->tstamp); /* XXX need interrupts off to prevent missed time? */
        } else
                return 0;
#endif
}

void dtrace_set_thread_predcache(thread_t thread, uint32_t predcache)
{
        if (thread != THREAD_NULL)
                thread->t_dtrace_predcache = predcache;
}

void dtrace_set_thread_vtime(thread_t thread, int64_t vtime)
{
        if (thread != THREAD_NULL)
                thread->t_dtrace_vtime = vtime;
}

void dtrace_set_thread_tracing(thread_t thread, int64_t accum)
{
        if (thread != THREAD_NULL)
                thread->t_dtrace_tracing = accum;
}

void dtrace_set_thread_reentering(thread_t thread, boolean_t vbool)
{
        if (thread != THREAD_NULL) {
                if (vbool)
                        thread->options |= TH_OPT_DTRACE;
                else
                        thread->options &= (~TH_OPT_DTRACE);
        }
}

vm_offset_t dtrace_set_thread_recover(thread_t thread, vm_offset_t recover)
{
        vm_offset_t prev = 0;

        if (thread != THREAD_NULL) {
                prev = thread->recover;
                thread->recover = recover;
        }
        return prev;
}

void dtrace_thread_bootstrap(void)
{
        task_t task = current_task();
        if(task->thread_count == 1) {
                DTRACE_PROC(start);
        }
        DTRACE_PROC(lwp__start);

}
#endif /* CONFIG_DTRACE */