2 * Copyright (c) 2000-2010 Apple Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
28 #include <mach/mach_types.h>
29 #include <mach/machine/vm_param.h>
30 #include <mach/task.h>
32 #include <kern/kern_types.h>
33 #include <kern/ledger.h>
34 #include <kern/processor.h>
35 #include <kern/thread.h>
36 #include <kern/task.h>
39 #include <ipc/ipc_port.h>
40 #include <ipc/ipc_object.h>
41 #include <vm/vm_map.h>
42 #include <vm/vm_kern.h>
44 #include <vm/vm_protos.h> /* last */
45 #include <sys/resource.h>
46 #include <sys/signal.h>
48 #undef thread_should_halt
50 /* BSD KERN COMPONENT INTERFACE */
52 task_t bsd_init_task
= TASK_NULL
;
53 boolean_t init_task_died
;
54 extern unsigned int not_in_kdp
; /* Skip acquiring locks if we're in kdp */
56 thread_t
get_firstthread(task_t
);
57 int get_task_userstop(task_t
);
58 int get_thread_userstop(thread_t
);
59 boolean_t
current_thread_aborted(void);
60 void task_act_iterate_wth_args(task_t
, void(*)(thread_t
, void *), void *);
61 kern_return_t
get_signalact(task_t
, thread_t
*, int);
62 int get_vmsubmap_entries(vm_map_t
, vm_object_offset_t
, vm_object_offset_t
);
63 int fill_task_rusage(task_t task
, rusage_info_current
*ri
);
64 int fill_task_io_rusage(task_t task
, rusage_info_current
*ri
);
65 int fill_task_qos_rusage(task_t task
, rusage_info_current
*ri
);
66 void fill_task_billed_usage(task_t task
, rusage_info_current
*ri
);
67 void task_bsdtask_kill(task_t
);
70 extern void psignal(void *, int);
76 void *get_bsdtask_info(task_t t
)
81 void task_bsdtask_kill(task_t t
)
83 void * bsd_info
= get_bsdtask_info(t
);
84 if (bsd_info
!= NULL
) {
85 psignal(bsd_info
, SIGKILL
);
91 void *get_bsdthreadtask_info(thread_t th
)
93 return(th
->task
!= TASK_NULL
? th
->task
->bsd_info
: NULL
);
99 void set_bsdtask_info(task_t t
,void * v
)
107 void *get_bsdthread_info(thread_t th
)
115 int get_thread_lock_count(thread_t th
); /* forced forward */
116 int get_thread_lock_count(thread_t th
)
118 return(th
->mutex_count
);
122 * XXX: wait for BSD to fix signal code
123 * Until then, we cannot block here. We know the task
124 * can't go away, so we make sure it is still active after
125 * retrieving the first thread for extra safety.
127 thread_t
get_firstthread(task_t task
)
129 thread_t thread
= (thread_t
)(void *)queue_first(&task
->threads
);
131 if (queue_end(&task
->threads
, (queue_entry_t
)thread
))
132 thread
= THREAD_NULL
;
135 return (THREAD_NULL
);
143 thread_t
*result_out
,
146 kern_return_t result
= KERN_SUCCESS
;
147 thread_t inc
, thread
= THREAD_NULL
;
154 return (KERN_FAILURE
);
157 for (inc
= (thread_t
)(void *)queue_first(&task
->threads
);
158 !queue_end(&task
->threads
, (queue_entry_t
)inc
); ) {
159 thread_mtx_lock(inc
);
161 (inc
->sched_flags
& TH_SFLAG_ABORTED_MASK
) != TH_SFLAG_ABORT
) {
165 thread_mtx_unlock(inc
);
167 inc
= (thread_t
)(void *)queue_next(&inc
->task_threads
);
171 *result_out
= thread
;
175 act_set_astbsd(thread
);
177 thread_mtx_unlock(thread
);
180 result
= KERN_FAILURE
;
194 kern_return_t result
= KERN_FAILURE
;
202 return (KERN_FAILURE
);
205 for (inc
= (thread_t
)(void *)queue_first(&task
->threads
);
206 !queue_end(&task
->threads
, (queue_entry_t
)inc
); ) {
208 thread_mtx_lock(inc
);
211 (inc
->sched_flags
& TH_SFLAG_ABORTED_MASK
) != TH_SFLAG_ABORT
) {
212 result
= KERN_SUCCESS
;
216 thread_mtx_unlock(inc
);
220 inc
= (thread_t
)(void *)queue_next(&inc
->task_threads
);
223 if (result
== KERN_SUCCESS
) {
225 act_set_astbsd(thread
);
227 thread_mtx_unlock(thread
);
235 ledger_t
get_task_ledger(task_t t
)
241 * This is only safe to call from a thread executing in
242 * in the task's context or if the task is locked. Otherwise,
243 * the map could be switched for the task (and freed) before
244 * we go to return it here.
246 vm_map_t
get_task_map(task_t t
)
251 vm_map_t
get_task_map_reference(task_t t
)
264 vm_map_reference_swap(m
);
272 ipc_space_t
get_task_ipcspace(task_t t
)
274 return(t
->itk_space
);
277 int get_task_numactivethreads(task_t task
)
280 int num_active_thr
=0;
283 for (inc
= (thread_t
)(void *)queue_first(&task
->threads
);
284 !queue_end(&task
->threads
, (queue_entry_t
)inc
); inc
= (thread_t
)(void *)queue_next(&inc
->task_threads
))
290 return num_active_thr
;
293 int get_task_numacts(task_t t
)
295 return(t
->thread_count
);
298 /* does this machine need 64bit register set for signal handler */
299 int is_64signalregset(void)
301 if (task_has_64BitData(current_task())) {
309 * Swap in a new map for the task/thread pair; the old map reference is
313 swap_task_map(task_t task
, thread_t thread
, vm_map_t map
, boolean_t doswitch
)
317 if (task
!= thread
->task
)
318 panic("swap_task_map");
321 mp_disable_preemption();
323 thread
->map
= task
->map
= map
;
325 pmap_switch(map
->pmap
);
327 mp_enable_preemption();
330 #if (defined(__i386__) || defined(__x86_64__)) && NCOPY_WINDOWS > 0
331 inval_copy_windows(thread
);
339 * This is only safe to call from a thread executing in
340 * in the task's context or if the task is locked. Otherwise,
341 * the map could be switched for the task (and freed) before
342 * we go to return it here.
344 pmap_t
get_task_pmap(task_t t
)
346 return(t
->map
->pmap
);
352 uint64_t get_task_resident_size(task_t task
)
356 map
= (task
== kernel_task
) ? kernel_map
: task
->map
;
357 return((uint64_t)pmap_resident_count(map
->pmap
) * PAGE_SIZE_64
);
360 uint64_t get_task_compressed(task_t task
)
364 map
= (task
== kernel_task
) ? kernel_map
: task
->map
;
365 return((uint64_t)pmap_compressed(map
->pmap
) * PAGE_SIZE_64
);
368 uint64_t get_task_resident_max(task_t task
)
372 map
= (task
== kernel_task
) ? kernel_map
: task
->map
;
373 return((uint64_t)pmap_resident_max(map
->pmap
) * PAGE_SIZE_64
);
376 uint64_t get_task_purgeable_size(task_t task
)
379 ledger_amount_t credit
, debit
;
380 uint64_t volatile_size
= 0;
382 ret
= ledger_get_entries(task
->ledger
, task_ledgers
.purgeable_volatile
, &credit
, &debit
);
383 if (ret
!= KERN_SUCCESS
) {
387 volatile_size
+= (credit
- debit
);
389 ret
= ledger_get_entries(task
->ledger
, task_ledgers
.purgeable_volatile_compressed
, &credit
, &debit
);
390 if (ret
!= KERN_SUCCESS
) {
394 volatile_size
+= (credit
- debit
);
396 return volatile_size
;
402 uint64_t get_task_phys_footprint(task_t task
)
405 ledger_amount_t credit
, debit
;
407 ret
= ledger_get_entries(task
->ledger
, task_ledgers
.phys_footprint
, &credit
, &debit
);
408 if (KERN_SUCCESS
== ret
) {
409 return (credit
- debit
);
418 uint64_t get_task_phys_footprint_max(task_t task
)
423 ret
= ledger_get_maximum(task
->ledger
, task_ledgers
.phys_footprint
, &max
);
424 if (KERN_SUCCESS
== ret
) {
431 uint64_t get_task_cpu_time(task_t task
)
434 ledger_amount_t credit
, debit
;
436 ret
= ledger_get_entries(task
->ledger
, task_ledgers
.cpu_time
, &credit
, &debit
);
437 if (KERN_SUCCESS
== ret
) {
438 return (credit
- debit
);
447 task_t
get_threadtask(thread_t th
)
459 return(vm_map_min(map
));
469 return(vm_map_max(map
));
479 get_vmsubmap_entries(
481 vm_object_offset_t start
,
482 vm_object_offset_t end
)
484 int total_entries
= 0;
485 vm_map_entry_t entry
;
489 entry
= vm_map_first_entry(map
);
490 while((entry
!= vm_map_to_entry(map
)) && (entry
->vme_start
< start
)) {
491 entry
= entry
->vme_next
;
494 while((entry
!= vm_map_to_entry(map
)) && (entry
->vme_start
< end
)) {
495 if(entry
->is_sub_map
) {
497 get_vmsubmap_entries(VME_SUBMAP(entry
),
505 entry
= entry
->vme_next
;
509 return(total_entries
);
516 int total_entries
= 0;
517 vm_map_entry_t entry
;
521 entry
= vm_map_first_entry(map
);
523 while(entry
!= vm_map_to_entry(map
)) {
524 if(entry
->is_sub_map
) {
526 get_vmsubmap_entries(VME_SUBMAP(entry
),
534 entry
= entry
->vme_next
;
538 return(total_entries
);
551 return(task
->user_stop_count
);
561 return(th
->user_stop_count
);
568 get_task_pidsuspended(
571 return (task
->pidsuspended
);
581 return (task
->frozen
);
591 return ((th
->sched_flags
& TH_SFLAG_ABORTED_MASK
) == TH_SFLAG_ABORT
);
595 * This routine is like thread_should_abort() above. It checks to
596 * see if the current thread is aborted. But unlike above, it also
597 * checks to see if thread is safely aborted. If so, it returns
598 * that fact, and clears the condition (safe aborts only should
599 * have a single effect, and a poll of the abort status
603 current_thread_aborted (
606 thread_t th
= current_thread();
609 if ((th
->sched_flags
& TH_SFLAG_ABORTED_MASK
) == TH_SFLAG_ABORT
&&
610 (th
->options
& TH_OPT_INTMASK
) != THREAD_UNINT
)
612 if (th
->sched_flags
& TH_SFLAG_ABORTSAFELY
) {
615 if (th
->sched_flags
& TH_SFLAG_ABORTSAFELY
)
616 th
->sched_flags
&= ~TH_SFLAG_ABORTED_MASK
;
627 task_act_iterate_wth_args(
629 void (*func_callback
)(thread_t
, void *),
636 for (inc
= (thread_t
)(void *)queue_first(&task
->threads
);
637 !queue_end(&task
->threads
, (queue_entry_t
)inc
); ) {
638 (void) (*func_callback
)(inc
, func_arg
);
639 inc
= (thread_t
)(void *)queue_next(&inc
->task_threads
);
646 #include <sys/bsdtask_info.h>
649 fill_taskprocinfo(task_t task
, struct proc_taskinfo_internal
* ptinfo
)
652 task_absolutetime_info_data_t tinfo
;
654 uint32_t cswitch
= 0, numrunning
= 0;
655 uint32_t syscalls_unix
= 0;
656 uint32_t syscalls_mach
= 0;
660 map
= (task
== kernel_task
)? kernel_map
: task
->map
;
662 ptinfo
->pti_virtual_size
= map
->size
;
663 ptinfo
->pti_resident_size
=
664 (mach_vm_size_t
)(pmap_resident_count(map
->pmap
))
667 ptinfo
->pti_policy
= ((task
!= kernel_task
)?
668 POLICY_TIMESHARE
: POLICY_RR
);
670 tinfo
.threads_user
= tinfo
.threads_system
= 0;
671 tinfo
.total_user
= task
->total_user_time
;
672 tinfo
.total_system
= task
->total_system_time
;
674 queue_iterate(&task
->threads
, thread
, thread_t
, task_threads
) {
678 if (thread
->options
& TH_OPT_IDLE_THREAD
)
684 if ((thread
->state
& TH_RUN
) == TH_RUN
)
686 cswitch
+= thread
->c_switch
;
687 tval
= timer_grab(&thread
->user_timer
);
688 tinfo
.threads_user
+= tval
;
689 tinfo
.total_user
+= tval
;
691 tval
= timer_grab(&thread
->system_timer
);
693 if (thread
->precise_user_kernel_time
) {
694 tinfo
.threads_system
+= tval
;
695 tinfo
.total_system
+= tval
;
697 /* system_timer may represent either sys or user */
698 tinfo
.threads_user
+= tval
;
699 tinfo
.total_user
+= tval
;
702 syscalls_unix
+= thread
->syscalls_unix
;
703 syscalls_mach
+= thread
->syscalls_mach
;
705 thread_unlock(thread
);
709 ptinfo
->pti_total_system
= tinfo
.total_system
;
710 ptinfo
->pti_total_user
= tinfo
.total_user
;
711 ptinfo
->pti_threads_system
= tinfo
.threads_system
;
712 ptinfo
->pti_threads_user
= tinfo
.threads_user
;
714 ptinfo
->pti_faults
= task
->faults
;
715 ptinfo
->pti_pageins
= task
->pageins
;
716 ptinfo
->pti_cow_faults
= task
->cow_faults
;
717 ptinfo
->pti_messages_sent
= task
->messages_sent
;
718 ptinfo
->pti_messages_received
= task
->messages_received
;
719 ptinfo
->pti_syscalls_mach
= task
->syscalls_mach
+ syscalls_mach
;
720 ptinfo
->pti_syscalls_unix
= task
->syscalls_unix
+ syscalls_unix
;
721 ptinfo
->pti_csw
= task
->c_switch
+ cswitch
;
722 ptinfo
->pti_threadnum
= task
->thread_count
;
723 ptinfo
->pti_numrunning
= numrunning
;
724 ptinfo
->pti_priority
= task
->priority
;
730 fill_taskthreadinfo(task_t task
, uint64_t thaddr
, int thuniqueid
, struct proc_threadinfo_internal
* ptinfo
, void * vpp
, int *vidp
)
734 mach_msg_type_number_t count
;
735 thread_basic_info_data_t basic_info
;
741 for (thact
= (thread_t
)(void *)queue_first(&task
->threads
);
742 !queue_end(&task
->threads
, (queue_entry_t
)thact
); ) {
743 addr
= (thuniqueid
==0)?thact
->machine
.cthread_self
: thact
->thread_id
;
747 count
= THREAD_BASIC_INFO_COUNT
;
748 if ((kret
= thread_info_internal(thact
, THREAD_BASIC_INFO
, (thread_info_t
)&basic_info
, &count
)) != KERN_SUCCESS
) {
752 ptinfo
->pth_user_time
= ((basic_info
.user_time
.seconds
* (integer_t
)NSEC_PER_SEC
) + (basic_info
.user_time
.microseconds
* (integer_t
)NSEC_PER_USEC
));
753 ptinfo
->pth_system_time
= ((basic_info
.system_time
.seconds
* (integer_t
)NSEC_PER_SEC
) + (basic_info
.system_time
.microseconds
* (integer_t
)NSEC_PER_USEC
));
755 ptinfo
->pth_cpu_usage
= basic_info
.cpu_usage
;
756 ptinfo
->pth_policy
= basic_info
.policy
;
757 ptinfo
->pth_run_state
= basic_info
.run_state
;
758 ptinfo
->pth_flags
= basic_info
.flags
;
759 ptinfo
->pth_sleep_time
= basic_info
.sleep_time
;
760 ptinfo
->pth_curpri
= thact
->sched_pri
;
761 ptinfo
->pth_priority
= thact
->base_pri
;
762 ptinfo
->pth_maxpriority
= thact
->max_priority
;
764 if ((vpp
!= NULL
) && (thact
->uthread
!= NULL
))
765 bsd_threadcdir(thact
->uthread
, vpp
, vidp
);
766 bsd_getthreadname(thact
->uthread
,ptinfo
->pth_name
);
770 thact
= (thread_t
)(void *)queue_next(&thact
->task_threads
);
780 fill_taskthreadlist(task_t task
, void * buffer
, int thcount
)
787 uptr
= (uint64_t *)buffer
;
791 for (thact
= (thread_t
)(void *)queue_first(&task
->threads
);
792 !queue_end(&task
->threads
, (queue_entry_t
)thact
); ) {
793 thaddr
= thact
->machine
.cthread_self
;
796 if (numthr
>= thcount
)
798 thact
= (thread_t
)(void *)queue_next(&thact
->task_threads
);
803 return (int)(numthr
* sizeof(uint64_t));
808 get_numthreads(task_t task
)
810 return(task
->thread_count
);
814 * Gather the various pieces of info about the designated task,
815 * and collect it all into a single rusage_info.
818 fill_task_rusage(task_t task
, rusage_info_current
*ri
)
820 struct task_power_info powerinfo
;
822 assert(task
!= TASK_NULL
);
825 task_power_info_locked(task
, &powerinfo
, NULL
);
826 ri
->ri_pkg_idle_wkups
= powerinfo
.task_platform_idle_wakeups
;
827 ri
->ri_interrupt_wkups
= powerinfo
.task_interrupt_wakeups
;
828 ri
->ri_user_time
= powerinfo
.total_user
;
829 ri
->ri_system_time
= powerinfo
.total_system
;
831 ledger_get_balance(task
->ledger
, task_ledgers
.phys_footprint
,
832 (ledger_amount_t
*)&ri
->ri_phys_footprint
);
833 ledger_get_balance(task
->ledger
, task_ledgers
.phys_mem
,
834 (ledger_amount_t
*)&ri
->ri_resident_size
);
835 ledger_get_balance(task
->ledger
, task_ledgers
.wired_mem
,
836 (ledger_amount_t
*)&ri
->ri_wired_size
);
838 ri
->ri_pageins
= task
->pageins
;
845 fill_task_billed_usage(task_t task __unused
, rusage_info_current
*ri
)
848 ri
->ri_billed_system_time
= bank_billed_time(task
->bank_context
);
849 ri
->ri_serviced_system_time
= bank_serviced_time(task
->bank_context
);
851 ri
->ri_billed_system_time
= 0;
852 ri
->ri_serviced_system_time
= 0;
857 fill_task_io_rusage(task_t task
, rusage_info_current
*ri
)
859 assert(task
!= TASK_NULL
);
862 if (task
->task_io_stats
) {
863 ri
->ri_diskio_bytesread
= task
->task_io_stats
->disk_reads
.size
;
864 ri
->ri_diskio_byteswritten
= (task
->task_io_stats
->total_io
.size
- task
->task_io_stats
->disk_reads
.size
);
866 /* I/O Stats unavailable */
867 ri
->ri_diskio_bytesread
= 0;
868 ri
->ri_diskio_byteswritten
= 0;
875 fill_task_qos_rusage(task_t task
, rusage_info_current
*ri
)
879 assert(task
!= TASK_NULL
);
882 /* Rollup Qos time of all the threads to task */
883 queue_iterate(&task
->threads
, thread
, thread_t
, task_threads
) {
884 if (thread
->options
& TH_OPT_IDLE_THREAD
)
887 thread_mtx_lock(thread
);
888 thread_update_qos_cpu_time(thread
, TRUE
);
889 thread_mtx_unlock(thread
);
892 ri
->ri_cpu_time_qos_default
= task
->cpu_time_qos_stats
.cpu_time_qos_default
;
893 ri
->ri_cpu_time_qos_maintenance
= task
->cpu_time_qos_stats
.cpu_time_qos_maintenance
;
894 ri
->ri_cpu_time_qos_background
= task
->cpu_time_qos_stats
.cpu_time_qos_background
;
895 ri
->ri_cpu_time_qos_utility
= task
->cpu_time_qos_stats
.cpu_time_qos_utility
;
896 ri
->ri_cpu_time_qos_legacy
= task
->cpu_time_qos_stats
.cpu_time_qos_legacy
;
897 ri
->ri_cpu_time_qos_user_initiated
= task
->cpu_time_qos_stats
.cpu_time_qos_user_initiated
;
898 ri
->ri_cpu_time_qos_user_interactive
= task
->cpu_time_qos_stats
.cpu_time_qos_user_interactive
;