#ifndef _KERN_THREAD_H_
#define _KERN_THREAD_H_
#include <mach/kern_return.h>
#include <mach/mach_types.h>
#include <mach/message.h>
#include <mach/boolean.h>
#include <mach/vm_param.h>
#include <mach/thread_info.h>
#include <mach/thread_status.h>
#include <mach/exception_types.h>
#include <kern/kern_types.h>
#include <sys/cdefs.h>
#ifdef MACH_KERNEL_PRIVATE
#include <mach_assert.h>
#include <mach_ldebug.h>
#include <ipc/ipc_types.h>
#include <mach/port.h>
#include <kern/cpu_number.h>
#include <kern/smp.h>
#include <kern/queue.h>
#include <kern/timer.h>
#include <kern/simple_lock.h>
#include <kern/locks.h>
#include <kern/sched.h>
#include <kern/sched_prim.h>
#include <mach/sfi_class.h>
#include <kern/thread_call.h>
#include <kern/timer_call.h>
#include <kern/task.h>
#include <kern/exception.h>
#include <kern/affinity.h>
#include <kern/waitq.h>
#include <ipc/ipc_kmsg.h>
#include <machine/cpu_data.h>
#include <machine/thread.h>
struct thread {
queue_chain_t links;
processor_t runq;
event64_t wait_event;
struct waitq *waitq;
#if __SMP__
decl_simple_lock_data(,sched_lock)
decl_simple_lock_data(,wake_lock)
#endif
integer_t options;
#define TH_OPT_INTMASK 0x0003
#define TH_OPT_VMPRIV 0x0004
#define TH_OPT_DTRACE 0x0008
#define TH_OPT_SYSTEM_CRITICAL 0x0010
#define TH_OPT_PROC_CPULIMIT 0x0020
#define TH_OPT_PRVT_CPULIMIT 0x0040
#define TH_OPT_IDLE_THREAD 0x0080
#define TH_OPT_GLOBAL_FORCED_IDLE 0x0100
#define TH_OPT_SCHED_VM_GROUP 0x0200
#define TH_OPT_HONOR_QLIMIT 0x0400
boolean_t wake_active;
int at_safe_point;
ast_t reason;
uint32_t quantum_remaining;
wait_result_t wait_result;
thread_continue_t continuation;
void *parameter;
vm_offset_t kernel_stack;
vm_offset_t reserved_stack;
int state;
#define TH_WAIT 0x01
#define TH_SUSP 0x02
#define TH_RUN 0x04
#define TH_UNINT 0x08
#define TH_TERMINATE 0x10
#define TH_TERMINATE2 0x20
#define TH_IDLE 0x80
sched_mode_t sched_mode;
sched_mode_t saved_mode;
sfi_class_id_t sfi_class;
sfi_class_id_t sfi_wait_class;
uint32_t sched_flags;
#define TH_SFLAG_FAILSAFE 0x0002
#define TH_SFLAG_THROTTLED 0x0004
#define TH_SFLAG_DEMOTED_MASK (TH_SFLAG_THROTTLE_DEMOTED | TH_SFLAG_FAILSAFE)
#define TH_SFLAG_PROMOTED 0x0008
#define TH_SFLAG_ABORT 0x0010
#define TH_SFLAG_ABORTSAFELY 0x0020
#define TH_SFLAG_ABORTED_MASK (TH_SFLAG_ABORT | TH_SFLAG_ABORTSAFELY)
#define TH_SFLAG_DEPRESS 0x0040
#define TH_SFLAG_POLLDEPRESS 0x0080
#define TH_SFLAG_DEPRESSED_MASK (TH_SFLAG_DEPRESS | TH_SFLAG_POLLDEPRESS)
#define TH_SFLAG_PRI_UPDATE 0x0100
#define TH_SFLAG_EAGERPREEMPT 0x0200
#define TH_SFLAG_RW_PROMOTED 0x0400
#define TH_SFLAG_THROTTLE_DEMOTED 0x0800
#define TH_SFLAG_WAITQ_PROMOTED 0x1000
#define TH_SFLAG_PROMOTED_MASK (TH_SFLAG_PROMOTED | TH_SFLAG_RW_PROMOTED | TH_SFLAG_WAITQ_PROMOTED)
#define TH_SFLAG_RW_PROMOTED_BIT (10)
int16_t sched_pri;
int16_t base_pri;
int16_t max_priority;
int16_t task_priority;
#if defined(CONFIG_SCHED_GRRR)
#if 0
uint16_t grrr_deficit;
#endif
#endif
int16_t promotions;
int16_t pending_promoter_index;
uint32_t ref_count;
void *pending_promoter[2];
uint32_t rwlock_count;
#if MACH_ASSERT
uint32_t SHARE_COUNT, BG_COUNT;
#endif
integer_t importance;
uint32_t was_promoted_on_wakeup;
integer_t depress_timer_active;
timer_call_data_t depress_timer;
struct {
uint32_t period;
uint32_t computation;
uint32_t constraint;
boolean_t preemptible;
uint64_t deadline;
} realtime;
uint64_t last_run_time;
uint64_t last_made_runnable_time;
#if defined(CONFIG_SCHED_MULTIQ)
sched_group_t sched_group;
#endif
timer_data_t system_timer;
processor_t bound_processor;
processor_t last_processor;
processor_t chosen_processor;
uint64_t computation_metered;
uint64_t computation_epoch;
uint64_t safe_release;
void (*sched_call)(
int type,
thread_t thread);
#if defined(CONFIG_SCHED_PROTO)
uint32_t runqueue_generation;
#endif
#if defined(CONFIG_SCHED_TIMESHARE_CORE)
natural_t sched_stamp;
natural_t sched_usage;
natural_t pri_shift;
natural_t cpu_usage;
natural_t cpu_delta;
#endif
uint32_t c_switch;
uint32_t p_switch;
uint32_t ps_switch;
integer_t mutex_count;
int precise_user_kernel_time;
timer_data_t user_timer;
uint64_t user_timer_save;
uint64_t system_timer_save;
uint64_t vtimer_user_save;
uint64_t vtimer_prof_save;
uint64_t vtimer_rlim_save;
#if CONFIG_SCHED_SFI
uint64_t wait_sfi_begin_time;
#endif
timer_call_data_t wait_timer;
integer_t wait_timer_active;
boolean_t wait_timer_is_set;
affinity_set_t affinity_set;
queue_chain_t affinity_threads;
union {
struct {
mach_msg_return_t state;
mach_port_seqno_t seqno;
ipc_object_t object;
mach_vm_address_t msg_addr;
mach_msg_size_t msize;
mach_msg_option_t option;
mach_port_name_t receiver_name;
struct ipc_kmsg *kmsg;
mach_msg_continue_t continuation;
} receive;
struct {
struct semaphore *waitsemaphore;
struct semaphore *signalsemaphore;
int options;
kern_return_t result;
mach_msg_continue_t continuation;
} sema;
struct {
int option;
boolean_t reenable_workq_callback;
} swtch;
int misc;
} saved;
struct {
unsigned type;
mach_exception_data_type_t code;
mach_exception_data_type_t subcode;
} guard_exc_info;
int16_t suspend_count;
int16_t user_stop_count;
#if IMPORTANCE_INHERITANCE
natural_t ith_assertions;
#endif
struct ipc_kmsg_queue ith_messages;
mach_port_t ith_rpc_reply;
vm_offset_t recover;
queue_chain_t threads;
queue_chain_t task_threads;
struct task *task;
vm_map_t map;
decl_lck_mtx_data(,mutex)
ast_t ast;
uint32_t
active:1,
started:1,
static_param:1,
inspection:1,
policy_reset:1,
:0;
struct ipc_port *ith_self;
struct ipc_port *ith_sself;
struct exception_action *exc_actions;
#ifdef MACH_BSD
void *uthread;
#endif
#if CONFIG_DTRACE
uint32_t t_dtrace_flags;
#define TH_DTRACE_EXECSUCCESS 0x01
uint32_t t_dtrace_predcache;
int64_t t_dtrace_tracing;
int64_t t_dtrace_vtime;
#endif
clock_sec_t t_page_creation_time;
uint32_t t_page_creation_count;
uint32_t t_page_creation_throttled;
#if (DEVELOPMENT || DEBUG)
uint64_t t_page_creation_throttled_hard;
uint64_t t_page_creation_throttled_soft;
#endif
#define T_CHUD_MARKED 0x01
#define T_IN_CHUD 0x02
#define THREAD_PMC_FLAG 0x04
#define T_AST_CALLSTACK 0x08
#define T_AST_NAME 0x10
#define T_NAME_DONE 0x20
#define T_KPC_ALLOC 0x40
uint32_t t_chud;
uint32_t chud_c_switch;
#ifdef KPC
uint64_t *kpc_buf;
#endif
#ifdef KPERF
uint64_t kperf_pet_cnt;
#endif
#if HYPERVISOR
void *hv_thread_target;
#endif
uint64_t thread_id;
uint32_t syscalls_unix;
uint32_t syscalls_mach;
ledger_t t_ledger;
ledger_t t_threadledger;
uint64_t cpu_time_last_qos;
#ifdef CONFIG_BANK
ledger_t t_bankledger;
uint64_t t_deduct_bank_ledger_time;
#endif
struct task_requested_policy requested_policy;
struct task_effective_policy effective_policy;
struct task_pended_policy pended_policy;
struct thread_qos_override {
struct thread_qos_override *override_next;
uint32_t override_contended_resource_count;
int16_t override_qos;
int16_t override_resource_type;
user_addr_t override_resource;
} *overrides;
int iotier_override;
integer_t saved_importance;
io_stat_info_t thread_io_stats;
uint32_t thread_callout_interrupt_wakeups;
uint32_t thread_callout_platform_idle_wakeups;
uint32_t thread_timer_wakeups_bin_1;
uint32_t thread_timer_wakeups_bin_2;
uint16_t thread_tag;
uint16_t callout_woken_from_icontext:1,
callout_woken_from_platform_idle:1,
callout_woke_thread:1,
thread_bitfield_unused:13;
mach_port_name_t ith_voucher_name;
ipc_voucher_t ith_voucher;
#if CONFIG_IOSCHED
void *decmp_upl;
#endif
uint64_t work_interval_id;
struct machine_thread machine;
};
#define ith_state saved.receive.state
#define ith_object saved.receive.object
#define ith_msg_addr saved.receive.msg_addr
#define ith_msize saved.receive.msize
#define ith_option saved.receive.option
#define ith_receiver_name saved.receive.receiver_name
#define ith_continuation saved.receive.continuation
#define ith_kmsg saved.receive.kmsg
#define ith_seqno saved.receive.seqno
#define sth_waitsemaphore saved.sema.waitsemaphore
#define sth_signalsemaphore saved.sema.signalsemaphore
#define sth_options saved.sema.options
#define sth_result saved.sema.result
#define sth_continuation saved.sema.continuation
extern void thread_bootstrap(void);
extern void thread_init(void);
extern void thread_daemon_init(void);
#define thread_reference_internal(thread) \
(void)hw_atomic_add(&(thread)->ref_count, 1)
#define thread_reference(thread) \
MACRO_BEGIN \
if ((thread) != THREAD_NULL) \
thread_reference_internal(thread); \
MACRO_END
extern void thread_deallocate(
thread_t thread);
extern void thread_deallocate_safe(
thread_t thread);
extern void thread_terminate_self(void);
extern kern_return_t thread_terminate_internal(
thread_t thread);
extern void thread_start_internal(
thread_t thread) __attribute__ ((noinline));
extern void thread_terminate_enqueue(
thread_t thread);
extern void thread_terminate_crashed_threads(void);
extern void thread_stack_enqueue(
thread_t thread);
extern void thread_hold(
thread_t thread);
extern void thread_release(
thread_t thread);
#if __SMP__
#define thread_lock_init(th) simple_lock_init(&(th)->sched_lock, 0)
#define thread_lock(th) simple_lock(&(th)->sched_lock)
#define thread_unlock(th) simple_unlock(&(th)->sched_lock)
#define wake_lock_init(th) simple_lock_init(&(th)->wake_lock, 0)
#define wake_lock(th) simple_lock(&(th)->wake_lock)
#define wake_unlock(th) simple_unlock(&(th)->wake_lock)
#else
#define thread_lock_init(th) do { (void)th; } while(0)
#define thread_lock(th) do { (void)th; } while(0)
#define thread_unlock(th) do { (void)th; } while(0)
#define wake_lock_init(th) do { (void)th; } while(0)
#define wake_lock(th) do { (void)th; } while(0)
#define wake_unlock(th) do { (void)th; } while(0)
#endif
#define thread_should_halt_fast(thread) (!(thread)->active)
extern void stack_alloc(
thread_t thread);
extern void stack_handoff(
thread_t from,
thread_t to);
extern void stack_free(
thread_t thread);
extern void stack_free_reserved(
thread_t thread);
extern boolean_t stack_alloc_try(
thread_t thread);
extern void stack_collect(void);
extern void stack_init(void);
extern kern_return_t thread_info_internal(
thread_t thread,
thread_flavor_t flavor,
thread_info_t thread_info_out,
mach_msg_type_number_t *thread_info_count);
extern void thread_task_priority(
thread_t thread,
integer_t priority,
integer_t max_priority);
extern kern_return_t thread_set_mode_and_absolute_pri(
thread_t thread,
integer_t policy,
integer_t priority);
extern void thread_policy_reset(
thread_t thread);
extern kern_return_t kernel_thread_create(
thread_continue_t continuation,
void *parameter,
integer_t priority,
thread_t *new_thread);
extern kern_return_t kernel_thread_start_priority(
thread_continue_t continuation,
void *parameter,
integer_t priority,
thread_t *new_thread);
extern void machine_stack_attach(
thread_t thread,
vm_offset_t stack);
extern vm_offset_t machine_stack_detach(
thread_t thread);
extern void machine_stack_handoff(
thread_t old,
thread_t new);
extern thread_t machine_switch_context(
thread_t old_thread,
thread_continue_t continuation,
thread_t new_thread);
extern void machine_load_context(
thread_t thread);
extern kern_return_t machine_thread_state_initialize(
thread_t thread);
extern kern_return_t machine_thread_neon_state_initialize(
thread_t thread);
extern kern_return_t machine_thread_set_state(
thread_t thread,
thread_flavor_t flavor,
thread_state_t state,
mach_msg_type_number_t count);
extern kern_return_t machine_thread_get_state(
thread_t thread,
thread_flavor_t flavor,
thread_state_t state,
mach_msg_type_number_t *count);
extern kern_return_t machine_thread_dup(
thread_t self,
thread_t target);
extern void machine_thread_init(void);
extern kern_return_t machine_thread_create(
thread_t thread,
task_t task);
extern void machine_thread_switch_addrmode(
thread_t thread);
extern void machine_thread_destroy(
thread_t thread);
extern void machine_set_current_thread(
thread_t thread);
extern kern_return_t machine_thread_get_kern_state(
thread_t thread,
thread_flavor_t flavor,
thread_state_t tstate,
mach_msg_type_number_t *count);
extern kern_return_t machine_thread_inherit_taskwide(
thread_t thread,
task_t parent_task);
extern kern_return_t machine_thread_set_tsd_base(
thread_t thread,
mach_vm_offset_t tsd_base);
#define thread_mtx_lock(thread) lck_mtx_lock(&(thread)->mutex)
#define thread_mtx_try(thread) lck_mtx_try_lock(&(thread)->mutex)
#define thread_mtx_unlock(thread) lck_mtx_unlock(&(thread)->mutex)
extern void install_special_handler(
thread_t thread);
extern void special_handler(
thread_t thread);
extern void
thread_update_qos_cpu_time(
thread_t thread,
boolean_t lock_needed);
void act_machine_sv_free(thread_t, int);
vm_offset_t min_valid_stack_address(void);
vm_offset_t max_valid_stack_address(void);
static inline uint16_t thread_set_tag_internal(thread_t thread, uint16_t tag) {
return __sync_fetch_and_or(&thread->thread_tag, tag);
}
static inline uint16_t thread_get_tag_internal(thread_t thread) {
return thread->thread_tag;
}
typedef struct {
int qos_pri[THREAD_QOS_LAST];
int qos_iotier[THREAD_QOS_LAST];
uint32_t qos_through_qos[THREAD_QOS_LAST];
uint32_t qos_latency_qos[THREAD_QOS_LAST];
} qos_policy_params_t;
extern void thread_set_options(uint32_t thopt);
#else
__BEGIN_DECLS
extern thread_t current_thread(void);
extern void thread_reference(
thread_t thread);
extern void thread_deallocate(
thread_t thread);
__END_DECLS
#endif
#ifdef KERNEL_PRIVATE
__BEGIN_DECLS
extern uint64_t thread_dispatchqaddr(
thread_t thread);
__END_DECLS
#endif
#ifdef KERNEL
__BEGIN_DECLS
extern uint64_t thread_tid(thread_t thread);
__END_DECLS
#endif
__BEGIN_DECLS
#ifdef XNU_KERNEL_PRIVATE
#define THREAD_TAG_MAINTHREAD 0x1
#define THREAD_TAG_CALLOUT 0x2
#define THREAD_TAG_IOWORKLOOP 0x4
uint16_t thread_set_tag(thread_t, uint16_t);
uint16_t thread_get_tag(thread_t);
extern kern_return_t thread_policy_create_work_interval(
thread_t thread,
uint64_t *work_interval_id);
extern kern_return_t thread_policy_destroy_work_interval(
thread_t thread,
uint64_t work_interval_id);
extern kern_return_t thread_state_initialize(
thread_t thread);
extern kern_return_t thread_setstatus(
thread_t thread,
int flavor,
thread_state_t tstate,
mach_msg_type_number_t count);
extern kern_return_t thread_getstatus(
thread_t thread,
int flavor,
thread_state_t tstate,
mach_msg_type_number_t *count);
extern kern_return_t thread_create_with_continuation(
task_t task,
thread_t *new_thread,
thread_continue_t continuation);
extern kern_return_t thread_create_workq(
task_t task,
thread_continue_t thread_return,
thread_t *new_thread);
extern void thread_yield_internal(
mach_msg_timeout_t interval);
#define THREAD_CPULIMIT_BLOCK 0x1
#define THREAD_CPULIMIT_EXCEPTION 0x2
#define THREAD_CPULIMIT_DISABLE 0x3
struct _thread_ledger_indices {
int cpu_time;
};
extern struct _thread_ledger_indices thread_ledgers;
extern int thread_get_cpulimit(int *action, uint8_t *percentage, uint64_t *interval_ns);
extern int thread_set_cpulimit(int action, uint8_t percentage, uint64_t interval_ns);
extern void thread_read_times(
thread_t thread,
time_value_t *user_time,
time_value_t *system_time);
extern uint64_t thread_get_runtime_self(void);
extern void thread_setuserstack(
thread_t thread,
mach_vm_offset_t user_stack);
extern uint64_t thread_adjuserstack(
thread_t thread,
int adjust);
extern void thread_setentrypoint(
thread_t thread,
mach_vm_offset_t entry);
extern kern_return_t thread_set_tsd_base(
thread_t thread,
mach_vm_offset_t tsd_base);
extern kern_return_t thread_setsinglestep(
thread_t thread,
int on);
extern kern_return_t thread_userstack(
thread_t,
int,
thread_state_t,
unsigned int,
mach_vm_offset_t *,
int *);
extern kern_return_t thread_entrypoint(
thread_t,
int,
thread_state_t,
unsigned int,
mach_vm_offset_t *);
extern kern_return_t thread_userstackdefault(
thread_t,
mach_vm_offset_t *);
extern kern_return_t thread_wire_internal(
host_priv_t host_priv,
thread_t thread,
boolean_t wired,
boolean_t *prev_state);
extern kern_return_t thread_dup(thread_t);
typedef void (*sched_call_t)(
int type,
thread_t thread);
#define SCHED_CALL_BLOCK 0x1
#define SCHED_CALL_UNBLOCK 0x2
extern void thread_sched_call(
thread_t thread,
sched_call_t call);
extern void thread_static_param(
thread_t thread,
boolean_t state);
extern boolean_t thread_is_static_param(
thread_t thread);
extern kern_return_t thread_policy_set_internal(
thread_t thread,
thread_policy_flavor_t flavor,
thread_policy_t policy_info,
mach_msg_type_number_t count);
extern boolean_t thread_has_qos_policy(thread_t thread);
extern kern_return_t thread_remove_qos_policy(thread_t thread);
extern task_t get_threadtask(thread_t);
#define thread_is_64bit(thd) \
task_has_64BitAddr(get_threadtask(thd))
extern void *get_bsdthread_info(thread_t);
extern void set_bsdthread_info(thread_t, void *);
extern void *uthread_alloc(task_t, thread_t, int);
extern void uthread_cleanup_name(void *uthread);
extern void uthread_cleanup(task_t, void *, void *, boolean_t);
extern void uthread_zone_free(void *);
extern void uthread_cred_free(void *);
#if PROC_REF_DEBUG
extern int uthread_get_proc_refcount(void *);
extern void uthread_reset_proc_refcount(void *);
extern int proc_ref_tracking_disabled;
#endif
extern boolean_t thread_should_halt(
thread_t thread);
extern boolean_t thread_should_abort(
thread_t);
extern int is_64signalregset(void);
extern void act_set_kperf(thread_t);
extern void set_astledger(thread_t thread);
extern uint32_t dtrace_get_thread_predcache(thread_t);
extern int64_t dtrace_get_thread_vtime(thread_t);
extern int64_t dtrace_get_thread_tracing(thread_t);
extern boolean_t dtrace_get_thread_reentering(thread_t);
extern int dtrace_get_thread_last_cpu_id(thread_t);
extern vm_offset_t dtrace_get_kernel_stack(thread_t);
extern void dtrace_set_thread_predcache(thread_t, uint32_t);
extern void dtrace_set_thread_vtime(thread_t, int64_t);
extern void dtrace_set_thread_tracing(thread_t, int64_t);
extern void dtrace_set_thread_reentering(thread_t, boolean_t);
extern vm_offset_t dtrace_set_thread_recover(thread_t, vm_offset_t);
extern void dtrace_thread_bootstrap(void);
extern void dtrace_thread_didexec(thread_t);
extern int64_t dtrace_calc_thread_recent_vtime(thread_t);
extern kern_return_t thread_set_wq_state32(
thread_t thread,
thread_state_t tstate);
extern kern_return_t thread_set_wq_state64(
thread_t thread,
thread_state_t tstate);
extern vm_offset_t kernel_stack_mask;
extern vm_offset_t kernel_stack_size;
extern vm_offset_t kernel_stack_depth_max;
void guard_ast(thread_t thread);
extern void fd_guard_ast(thread_t thread);
extern void mach_port_guard_ast(thread_t thread);
extern void thread_guard_violation(thread_t thread, unsigned type);
extern void thread_update_io_stats(thread_t thread, int size, int io_flags);
extern kern_return_t thread_set_voucher_name(mach_port_name_t name);
extern kern_return_t thread_get_current_voucher_origin_pid(int32_t *pid);
#endif
extern kern_return_t kernel_thread_start(
thread_continue_t continuation,
void *parameter,
thread_t *new_thread);
#ifdef KERNEL_PRIVATE
void thread_set_eager_preempt(thread_t thread);
void thread_clear_eager_preempt(thread_t thread);
extern ipc_port_t convert_thread_to_port(thread_t);
extern boolean_t set_vm_privilege(boolean_t);
#endif
__END_DECLS
#endif