[apple/xnu.git] / bsd / sys / bsdtask_info.h

/*
 * Copyright (c) 2005, 2015 Apple Computer, 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@
 */

#ifndef _SYS_BSDTASK_INFO_H
#define _SYS_BSDTASK_INFO_H

#include <vm/vm_map.h>

struct proc_taskinfo_internal {
	uint64_t                pti_virtual_size;   /* virtual memory size (bytes) */
	uint64_t                pti_resident_size;  /* resident memory size (bytes) */
	uint64_t                pti_total_user;         /* total time */
	uint64_t                pti_total_system;
	uint64_t                pti_threads_user;       /* existing threads only */
	uint64_t                pti_threads_system;
	int32_t                 pti_policy;             /* default policy for new threads */
	int32_t                 pti_faults;             /* number of page faults */
	int32_t                 pti_pageins;    /* number of actual pageins */
	int32_t                 pti_cow_faults; /* number of copy-on-write faults */
	int32_t                 pti_messages_sent;      /* number of messages sent */
	int32_t                 pti_messages_received; /* number of messages received */
	int32_t                 pti_syscalls_mach;  /* number of mach system calls */
	int32_t                 pti_syscalls_unix;  /* number of unix system calls */
	int32_t                 pti_csw;            /* number of context switches */
	int32_t                 pti_threadnum;          /* number of threads in the task */
	int32_t                 pti_numrunning;         /* number of running threads */
	int32_t                 pti_priority;           /* task priority*/
};

#define MAXTHREADNAMESIZE 64

struct proc_threadinfo_internal {
	uint64_t                pth_user_time;      /* user run time */
	uint64_t                pth_system_time;    /* system run time */
	int32_t                 pth_cpu_usage;      /* scaled cpu usage percentage */
	int32_t                 pth_policy;             /* scheduling policy in effect */
	int32_t                 pth_run_state;      /* run state (see below) */
	int32_t                 pth_flags;          /* various flags (see below) */
	int32_t                 pth_sleep_time;     /* number of seconds that thread */
	int32_t                 pth_curpri;             /* cur priority*/
	int32_t                 pth_priority;           /*  priority*/
	int32_t                 pth_maxpriority;                /* max priority*/
	char                    pth_name[MAXTHREADNAMESIZE];            /* thread name, if any */
};


struct proc_regioninfo_internal {
	uint32_t                pri_protection;
	uint32_t                pri_max_protection;
	uint32_t                pri_inheritance;
	uint32_t                pri_flags;              /* shared, external pager, is submap */
	uint64_t                pri_offset;
	uint32_t                pri_behavior;
	uint32_t                pri_user_wired_count;
	uint32_t                pri_user_tag;
	uint32_t                pri_pages_resident;
	uint32_t                pri_pages_shared_now_private;
	uint32_t                pri_pages_swapped_out;
	uint32_t                pri_pages_dirtied;
	uint32_t                pri_ref_count;
	uint32_t                pri_shadow_depth;
	uint32_t                pri_share_mode;
	uint32_t                pri_private_pages_resident;
	uint32_t                pri_shared_pages_resident;
	uint32_t                pri_obj_id;
	uint32_t                pri_depth;
	uint64_t                pri_address;
	uint64_t                pri_size;
};

#ifdef  MACH_KERNEL_PRIVATE

#define PROC_REGION_SUBMAP      1
#define PROC_REGION_SHARED      2

extern uint32_t vnode_vid(void *vp);

#if CONFIG_IOSCHED
kern_return_t vnode_pager_get_object_devvp(memory_object_t mem_obj, uintptr_t *devvp);
extern struct vnode *vnode_mountdevvp(struct vnode *);
#endif

extern boolean_t vnode_isonexternalstorage(void *vp);

#endif /* MACH_KERNEL_PRIVATE */

extern int fill_procregioninfo(task_t t, uint64_t arg, struct proc_regioninfo_internal *pinfo, uintptr_t *vp, uint32_t *vid);
extern int fill_procregioninfo_onlymappedvnodes(task_t t, uint64_t arg, struct proc_regioninfo_internal *pinfo, uintptr_t *vp, uint32_t *vid);
extern int find_region_details(task_t task, vm_map_offset_t offset, uintptr_t *vnodeaddr, uint32_t *vid, uint64_t *start, uint64_t *len);
void fill_taskprocinfo(task_t task, struct proc_taskinfo_internal * ptinfo);
int fill_taskthreadinfo(task_t task, uint64_t thaddr, bool thuniqueid, struct proc_threadinfo_internal * ptinfo, void *, int *);
int fill_taskthreadlist(task_t task, void * buffer, int thcount, bool thuniqueid);
int get_numthreads(task_t);
boolean_t bsd_hasthreadname(void *uth);
void bsd_getthreadname(void *uth, char* buffer);
void bsd_setthreadname(void *uth, const char* buffer);
void bsd_threadcdir(void * uth, void *vptr, int *vidp);
extern void bsd_copythreadname(void *dst_uth, void *src_uth);
int fill_taskipctableinfo(task_t task, uint32_t *table_size, uint32_t *table_free);

#endif /*_SYS_BSDTASK_INFO_H */
Commit	Line	Data
0c530ab8	1	/*
3e170ce0	2	* Copyright (c) 2005, 2015 Apple Computer, Inc. All rights reserved.
0c530ab8	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
0a7de745	5	*
2d21ac55 A	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.
0a7de745	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
2d21ac55 A	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
0a7de745	17	*
2d21ac55 A	18	* The Original Code and all software distributed under the License are
2d21ac55 A	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
0c530ab8 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
0c530ab8 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
0a7de745	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
0c530ab8 A	27	*/
	28
	29	#ifndef _SYS_BSDTASK_INFO_H
	30	#define _SYS_BSDTASK_INFO_H
	31
3e170ce0 A	32	#include <vm/vm_map.h>
3e170ce0 A	33
0a7de745 A	34	struct proc_taskinfo_internal {
	35	uint64_t pti_virtual_size; /* virtual memory size (bytes) */
	36	uint64_t pti_resident_size; /* resident memory size (bytes) */
	37	uint64_t pti_total_user; /* total time */
	38	uint64_t pti_total_system;
	39	uint64_t pti_threads_user; /* existing threads only */
	40	uint64_t pti_threads_system;
	41	int32_t pti_policy; /* default policy for new threads */
	42	int32_t pti_faults; /* number of page faults */
	43	int32_t pti_pageins; /* number of actual pageins */
	44	int32_t pti_cow_faults; /* number of copy-on-write faults */
	45	int32_t pti_messages_sent; /* number of messages sent */
	46	int32_t pti_messages_received; /* number of messages received */
	47	int32_t pti_syscalls_mach; /* number of mach system calls */
	48	int32_t pti_syscalls_unix; /* number of unix system calls */
	49	int32_t pti_csw; /* number of context switches */
	50	int32_t pti_threadnum; /* number of threads in the task */
	51	int32_t pti_numrunning; /* number of running threads */
0c530ab8 A	52	int32_t pti_priority; /* task priority*/
	53	};
	54
b0d623f7	55	#define MAXTHREADNAMESIZE 64
0c530ab8 A	56
0c530ab8 A	57	struct proc_threadinfo_internal {
0a7de745 A	58	uint64_t pth_user_time; /* user run time */
	59	uint64_t pth_system_time; /* system run time */
	60	int32_t pth_cpu_usage; /* scaled cpu usage percentage */
	61	int32_t pth_policy; /* scheduling policy in effect */
	62	int32_t pth_run_state; /* run state (see below) */
	63	int32_t pth_flags; /* various flags (see below) */
	64	int32_t pth_sleep_time; /* number of seconds that thread */
	65	int32_t pth_curpri; /* cur priority*/
	66	int32_t pth_priority; /* priority*/
	67	int32_t pth_maxpriority; /* max priority*/
	68	char pth_name[MAXTHREADNAMESIZE]; /* thread name, if any */
0c530ab8 A	69	};
	70
	71
	72
	73	struct proc_regioninfo_internal {
0a7de745 A	74	uint32_t pri_protection;
	75	uint32_t pri_max_protection;
	76	uint32_t pri_inheritance;
	77	uint32_t pri_flags; /* shared, external pager, is submap */
	78	uint64_t pri_offset;
	79	uint32_t pri_behavior;
	80	uint32_t pri_user_wired_count;
	81	uint32_t pri_user_tag;
	82	uint32_t pri_pages_resident;
	83	uint32_t pri_pages_shared_now_private;
	84	uint32_t pri_pages_swapped_out;
	85	uint32_t pri_pages_dirtied;
	86	uint32_t pri_ref_count;
	87	uint32_t pri_shadow_depth;
	88	uint32_t pri_share_mode;
	89	uint32_t pri_private_pages_resident;
	90	uint32_t pri_shared_pages_resident;
	91	uint32_t pri_obj_id;
	92	uint32_t pri_depth;
	93	uint64_t pri_address;
	94	uint64_t pri_size;
0c530ab8 A	95	};
	96
	97	#ifdef MACH_KERNEL_PRIVATE
	98
0a7de745 A	99	#define PROC_REGION_SUBMAP 1
0a7de745 A	100	#define PROC_REGION_SHARED 2
0c530ab8	101
0c530ab8	102	extern uint32_t vnode_vid(void *vp);
cb323159	103
fe8ab488 A	104	#if CONFIG_IOSCHED
	105	kern_return_t vnode_pager_get_object_devvp(memory_object_t mem_obj, uintptr_t *devvp);
	106	extern struct vnode vnode_mountdevvp(struct vnode );
	107	#endif
0c530ab8	108
cb323159 A	109	extern boolean_t vnode_isonexternalstorage(void *vp);
cb323159 A	110
0c530ab8 A	111	#endif /* MACH_KERNEL_PRIVATE */
0c530ab8 A	112
b0d623f7	113	extern int fill_procregioninfo(task_t t, uint64_t arg, struct proc_regioninfo_internal pinfo, uintptr_t vp, uint32_t *vid);
fe8ab488	114	extern int fill_procregioninfo_onlymappedvnodes(task_t t, uint64_t arg, struct proc_regioninfo_internal pinfo, uintptr_t vp, uint32_t *vid);
cb323159	115	extern int find_region_details(task_t task, vm_map_offset_t offset, uintptr_t vnodeaddr, uint32_t vid, uint64_t start, uint64_t len);
0c530ab8	116	void fill_taskprocinfo(task_t task, struct proc_taskinfo_internal * ptinfo);
d9a64523 A	117	int fill_taskthreadinfo(task_t task, uint64_t thaddr, bool thuniqueid, struct proc_threadinfo_internal * ptinfo, void , int );
d9a64523 A	118	int fill_taskthreadlist(task_t task, void * buffer, int thcount, bool thuniqueid);
0c530ab8	119	int get_numthreads(task_t);
39037602	120	boolean_t bsd_hasthreadname(void *uth);
b0d623f7	121	void bsd_getthreadname(void uth, char buffer);
39037602	122	void bsd_setthreadname(void uth, const char buffer);
2d21ac55	123	void bsd_threadcdir(void * uth, void vptr, int vidp);
39037602	124	extern void bsd_copythreadname(void dst_uth, void src_uth);
cb323159	125	int fill_taskipctableinfo(task_t task, uint32_t table_size, uint32_t table_free);
0c530ab8 A	126
0c530ab8 A	127	#endif /_SYS_BSDTASK_INFO_H /