[apple/system_cmds.git] / lsmp.tproj / common.h

/*
 * Copyright (c) 2002-2016 Apple Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 *
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 *
 * This 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 OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 *
 * @APPLE_LICENSE_HEADER_END@
 */


#ifndef system_cmds_common_h
#define system_cmds_common_h

#include <mach/mach.h>

#define PROC_NAME_LEN 100
#define BUFSTR_LEN 30
#define VOUCHER_DETAIL_MAXLEN 1024

/* common struct to hold all configurations, static and args based */
struct prog_configs {
    boolean_t show_all_tasks;
    boolean_t show_voucher_details;
    boolean_t verbose;
    int       voucher_detail_length;
    pid_t     pid; /* if user focusing only one pid */
};

extern struct prog_configs lsmp_config;

/* exception port information */
struct exc_port_info {
    mach_msg_type_number_t   count;
    mach_port_t      ports[EXC_TYPES_COUNT];
    exception_mask_t masks[EXC_TYPES_COUNT];
    exception_behavior_t behaviors[EXC_TYPES_COUNT];
    thread_state_flavor_t flavors[EXC_TYPES_COUNT];
};

/* private structure to hold thread specific information */
struct my_per_thread_info {
    mach_port_t thread;
    uint32_t th_kobject;
    uint64_t th_id;
    char * voucher_detail;
};

/* kobject to name hash table declarations */
#define K2N_TABLE_SIZE	256

struct k2n_table_node {
    natural_t kobject; /* kobject referred to by the name -- the key into the table */
    ipc_info_name_t *info_name; /* info about the name that refers to the key kobject -- value of the table */
    struct k2n_table_node *next;
};

struct k2n_table_node *k2n_table_lookup_next(struct k2n_table_node *node, natural_t kobject);
struct k2n_table_node *k2n_table_lookup(struct k2n_table_node **table, natural_t kobject);

/* private structure to wrap up per-task info */
typedef struct my_per_task_info {
    task_t task;
    pid_t pid;
    vm_address_t task_kobject;
    ipc_info_space_t info;
    ipc_info_name_array_t table;
    mach_msg_type_number_t tableCount;
    ipc_info_tree_name_array_t tree;
    mach_msg_type_number_t treeCount;
    boolean_t valid; /* TRUE if all data is accurately collected */
    struct k2n_table_node *k2ntable[K2N_TABLE_SIZE];
    char processName[PROC_NAME_LEN];
    struct exc_port_info exceptionInfo;
    struct my_per_thread_info * threadInfos; /* dynamically allocated in collect_per_task_info */
    unsigned int threadCount;
    struct exc_port_info *threadExceptionInfos;  /* this is 2 dimensional array with threadCount X struct exc_port_info  of ports */
} my_per_task_info_t;


/*
 * WARNING - these types are copied from xnu/osfmk/kern/ipc_kobject.h
 * Need to stay in sync to print accurate results.
 */
#define IKOT_NONE                  0
#define IKOT_THREAD                1
#define IKOT_TASK                  2
#define IKOT_HOST                  3
#define IKOT_HOST_PRIV             4
#define IKOT_PROCESSOR             5
#define IKOT_PSET                  6
#define IKOT_PSET_NAME             7
#define IKOT_TIMER                 8
#define IKOT_PAGING_REQUEST        9
#define IKOT_MIG                  10
#define IKOT_MEMORY_OBJECT        11
#define IKOT_XMM_PAGER            12
#define IKOT_XMM_KERNEL           13
#define IKOT_XMM_REPLY            14
#define IKOT_UND_REPLY            15
#define IKOT_HOST_NOTIFY          16
#define IKOT_HOST_SECURITY        17
#define IKOT_LEDGER               18
#define IKOT_MASTER_DEVICE        19
#define IKOT_TASK_NAME            20
#define IKOT_SUBSYSTEM            21
#define IKOT_IO_DONE_QUEUE        22
#define IKOT_SEMAPHORE            23
#define IKOT_LOCK_SET             24
#define IKOT_CLOCK                25
#define IKOT_CLOCK_CTRL           26
#define IKOT_IOKIT_SPARE          27
#define IKOT_NAMED_ENTRY          28
#define IKOT_IOKIT_CONNECT        29
#define IKOT_IOKIT_OBJECT         30
#define IKOT_UPL                  31
#define IKOT_MEM_OBJ_CONTROL      32
#define IKOT_AU_SESSIONPORT       33
#define IKOT_FILEPORT             34
#define IKOT_LABELH               35
#define IKOT_TASK_RESUME          36
#define IKOT_VOUCHER              37
#define IKOT_VOUCHER_ATTR_CONTROL 38
#define IKOT_UNKNOWN              39	/* magic catchall	*/
#define IKOT_MAX_TYPE             (IKOT_UNKNOWN+1)	/* # of IKOT_ types	*/

#define SHOW_PORT_STATUS_FLAGS(flags) \
  (flags & MACH_PORT_STATUS_FLAG_TEMPOWNER)	?"T":"-", \
  (flags & MACH_PORT_STATUS_FLAG_GUARDED)		?"G":"-", \
  (flags & MACH_PORT_STATUS_FLAG_STRICT_GUARD)	?"S":"-", \
  (flags & MACH_PORT_STATUS_FLAG_IMP_DONATION)	?"I":"-", \
  (flags & MACH_PORT_STATUS_FLAG_REVIVE)		?"R":"-", \
  (flags & MACH_PORT_STATUS_FLAG_TASKPTR)		?"P":"-"


uint32_t show_recipe_detail(mach_voucher_attr_recipe_t recipe, char * voucher_outstr, uint32_t maxlen);
char *copy_voucher_detail(mach_port_t task, mach_port_name_t voucher);

/* mach port related functions */
const char * kobject_name(natural_t kotype);
void get_receive_port_context(task_t taskp, mach_port_name_t portname, mach_port_context_t *context);
int get_recieve_port_status(task_t taskp, mach_port_name_t portname, mach_port_info_ext_t *info);
void show_task_mach_ports(my_per_task_info_t *taskinfo, uint32_t taskCount, my_per_task_info_t *allTaskInfos);

/* task and thread related helper functions */
kern_return_t collect_per_task_info(my_per_task_info_t *taskinfo, task_t target_task);
my_per_task_info_t * allocate_taskinfo_memory(uint32_t taskCount);
void deallocate_taskinfo_memory(my_per_task_info_t *data);
kern_return_t print_task_exception_info(my_per_task_info_t *taskinfo);
kern_return_t print_task_threads_special_ports(my_per_task_info_t *taskinfo);
my_per_task_info_t * get_taskinfo_by_kobject(natural_t kobj);

void get_exc_behavior_string(exception_behavior_t b, char *out_string, size_t len);
void get_exc_mask_string(exception_mask_t m, char *out_string, size_t len);
kern_return_t get_taskinfo_of_receiver_by_send_right(ipc_info_name_t *sendright, my_per_task_info_t **out_taskinfo, mach_port_name_t *out_recv_info);
kern_return_t get_ipc_info_from_lsmp_spaceinfo(mach_port_t port_name, ipc_info_name_t *out_sendright);

/* basic util functions */
uint32_t print_hex_data(char *outstr, size_t maxlen, char *prefix, char *desc, void *addr, int len);

#endif
Commit	Line	Data
1a7e3f61	1	/*
cf37c299	2	* Copyright (c) 2002-2016 Apple Inc. All rights reserved.
1a7e3f61 A	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
	6	* The contents of this file constitute Original Code as defined in and
	7	* are subject to the Apple Public Source License Version 1.1 (the
	8	* "License"). You may not use this file except in compliance with the
	9	* License. Please obtain a copy of the License at
	10	* http://www.apple.com/publicsource and read it before using this file.
	11	*
	12	* This Original Code and all software distributed under the License are
	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	16	* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	17	* License for the specific language governing rights and limitations
	18	* under the License.
	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
	22
	23
	24	#ifndef system_cmds_common_h
	25	#define system_cmds_common_h
	26
ac27e6b4 A	27	#include <mach/mach.h>
ac27e6b4 A	28
1a7e3f61 A	29	#define PROC_NAME_LEN 100
1a7e3f61 A	30	#define BUFSTR_LEN 30
ac27e6b4	31	#define VOUCHER_DETAIL_MAXLEN 1024
1a7e3f61 A	32
	33	/* common struct to hold all configurations, static and args based */
	34	struct prog_configs {
	35	boolean_t show_all_tasks;
	36	boolean_t show_voucher_details;
	37	boolean_t verbose;
	38	int voucher_detail_length;
	39	pid_t pid; /* if user focusing only one pid */
1a7e3f61 A	40	};
	41
	42	extern struct prog_configs lsmp_config;
	43
ac27e6b4 A	44	/* exception port information */
	45	struct exc_port_info {
	46	mach_msg_type_number_t count;
	47	mach_port_t ports[EXC_TYPES_COUNT];
	48	exception_mask_t masks[EXC_TYPES_COUNT];
	49	exception_behavior_t behaviors[EXC_TYPES_COUNT];
	50	thread_state_flavor_t flavors[EXC_TYPES_COUNT];
	51	};
	52
	53	/* private structure to hold thread specific information */
	54	struct my_per_thread_info {
	55	mach_port_t thread;
	56	uint32_t th_kobject;
	57	uint64_t th_id;
	58	char * voucher_detail;
	59	};
	60
cf37c299 A	61	/* kobject to name hash table declarations */
	62	#define K2N_TABLE_SIZE 256
	63
	64	struct k2n_table_node {
	65	natural_t kobject; /* kobject referred to by the name -- the key into the table */
	66	ipc_info_name_t info_name; / info about the name that refers to the key kobject -- value of the table */
	67	struct k2n_table_node *next;
	68	};
	69
	70	struct k2n_table_node k2n_table_lookup_next(struct k2n_table_node node, natural_t kobject);
	71	struct k2n_table_node k2n_table_lookup(struct k2n_table_node *table, natural_t kobject);
	72
1a7e3f61 A	73	/* private structure to wrap up per-task info */
	74	typedef struct my_per_task_info {
	75	task_t task;
	76	pid_t pid;
	77	vm_address_t task_kobject;
	78	ipc_info_space_t info;
	79	ipc_info_name_array_t table;
	80	mach_msg_type_number_t tableCount;
	81	ipc_info_tree_name_array_t tree;
	82	mach_msg_type_number_t treeCount;
	83	boolean_t valid; /* TRUE if all data is accurately collected */
cf37c299	84	struct k2n_table_node *k2ntable[K2N_TABLE_SIZE];
1a7e3f61	85	char processName[PROC_NAME_LEN];
ac27e6b4 A	86	struct exc_port_info exceptionInfo;
	87	struct my_per_thread_info * threadInfos; /* dynamically allocated in collect_per_task_info */
	88	unsigned int threadCount;
	89	struct exc_port_info threadExceptionInfos; / this is 2 dimensional array with threadCount X struct exc_port_info of ports */
1a7e3f61 A	90	} my_per_task_info_t;
	91
	92
	93	/*
	94	* WARNING - these types are copied from xnu/osfmk/kern/ipc_kobject.h
	95	* Need to stay in sync to print accurate results.
	96	*/
	97	#define IKOT_NONE 0
	98	#define IKOT_THREAD 1
	99	#define IKOT_TASK 2
	100	#define IKOT_HOST 3
	101	#define IKOT_HOST_PRIV 4
	102	#define IKOT_PROCESSOR 5
	103	#define IKOT_PSET 6
	104	#define IKOT_PSET_NAME 7
	105	#define IKOT_TIMER 8
	106	#define IKOT_PAGING_REQUEST 9
	107	#define IKOT_MIG 10
	108	#define IKOT_MEMORY_OBJECT 11
	109	#define IKOT_XMM_PAGER 12
	110	#define IKOT_XMM_KERNEL 13
	111	#define IKOT_XMM_REPLY 14
	112	#define IKOT_UND_REPLY 15
	113	#define IKOT_HOST_NOTIFY 16
	114	#define IKOT_HOST_SECURITY 17
	115	#define IKOT_LEDGER 18
	116	#define IKOT_MASTER_DEVICE 19
	117	#define IKOT_TASK_NAME 20
	118	#define IKOT_SUBSYSTEM 21
	119	#define IKOT_IO_DONE_QUEUE 22
	120	#define IKOT_SEMAPHORE 23
	121	#define IKOT_LOCK_SET 24
	122	#define IKOT_CLOCK 25
	123	#define IKOT_CLOCK_CTRL 26
	124	#define IKOT_IOKIT_SPARE 27
	125	#define IKOT_NAMED_ENTRY 28
	126	#define IKOT_IOKIT_CONNECT 29
	127	#define IKOT_IOKIT_OBJECT 30
	128	#define IKOT_UPL 31
	129	#define IKOT_MEM_OBJ_CONTROL 32
	130	#define IKOT_AU_SESSIONPORT 33
	131	#define IKOT_FILEPORT 34
	132	#define IKOT_LABELH 35
	133	#define IKOT_TASK_RESUME 36
	134	#define IKOT_VOUCHER 37
	135	#define IKOT_VOUCHER_ATTR_CONTROL 38
	136	#define IKOT_UNKNOWN 39 /* magic catchall */
	137	#define IKOT_MAX_TYPE (IKOT_UNKNOWN+1) /* # of IKOT_ types */
	138
	139	#define SHOW_PORT_STATUS_FLAGS(flags) \
	140	(flags & MACH_PORT_STATUS_FLAG_TEMPOWNER) ?"T":"-", \
	141	(flags & MACH_PORT_STATUS_FLAG_GUARDED) ?"G":"-", \
	142	(flags & MACH_PORT_STATUS_FLAG_STRICT_GUARD) ?"S":"-", \
	143	(flags & MACH_PORT_STATUS_FLAG_IMP_DONATION) ?"I":"-", \
	144	(flags & MACH_PORT_STATUS_FLAG_REVIVE) ?"R":"-", \
	145	(flags & MACH_PORT_STATUS_FLAG_TASKPTR) ?"P":"-"
	146
	147
cf37c299	148	uint32_t show_recipe_detail(mach_voucher_attr_recipe_t recipe, char * voucher_outstr, uint32_t maxlen);
ac27e6b4	149	char *copy_voucher_detail(mach_port_t task, mach_port_name_t voucher);
1a7e3f61 A	150
	151	/* mach port related functions */
	152	const char * kobject_name(natural_t kotype);
	153	void get_receive_port_context(task_t taskp, mach_port_name_t portname, mach_port_context_t *context);
	154	int get_recieve_port_status(task_t taskp, mach_port_name_t portname, mach_port_info_ext_t *info);
	155	void show_task_mach_ports(my_per_task_info_t taskinfo, uint32_t taskCount, my_per_task_info_t allTaskInfos);
	156
	157	/* task and thread related helper functions */
	158	kern_return_t collect_per_task_info(my_per_task_info_t *taskinfo, task_t target_task);
	159	my_per_task_info_t * allocate_taskinfo_memory(uint32_t taskCount);
	160	void deallocate_taskinfo_memory(my_per_task_info_t *data);
	161	kern_return_t print_task_exception_info(my_per_task_info_t *taskinfo);
	162	kern_return_t print_task_threads_special_ports(my_per_task_info_t *taskinfo);
	163	my_per_task_info_t * get_taskinfo_by_kobject(natural_t kobj);
	164
	165	void get_exc_behavior_string(exception_behavior_t b, char *out_string, size_t len);
	166	void get_exc_mask_string(exception_mask_t m, char *out_string, size_t len);
	167	kern_return_t get_taskinfo_of_receiver_by_send_right(ipc_info_name_t sendright, my_per_task_info_t out_taskinfo, mach_port_name_t out_recv_info);
ac27e6b4	168	kern_return_t get_ipc_info_from_lsmp_spaceinfo(mach_port_t port_name, ipc_info_name_t *out_sendright);
1a7e3f61 A	169
1a7e3f61 A	170	/* basic util functions */
cf37c299	171	uint32_t print_hex_data(char outstr, size_t maxlen, char prefix, char desc, void addr, int len);
1a7e3f61 A	172
1a7e3f61 A	173	#endif