[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>
#include <mach_debug/ipc_info.h>
#include "json.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 */
    JSON_t    json_output;
};

extern struct prog_configs lsmp_config;

/* exception port information */
struct exc_port_info {
    mach_msg_type_number_t   count;
    ipc_info_port_t  ports_info[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_read_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_CONTROL        1
#define IKOT_TASK_CONTROL          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_IDENT          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_WORK_INTERVAL        39
#define IKOT_UX_HANDLER           40
#define IKOT_UEXT_OBJECT          41
#define IKOT_ARCADE_REG           42
#define IKOT_EVENTLINK            43
#define IKOT_TASK_INSPECT         44
#define IKOT_TASK_READ            45
#define IKOT_THREAD_INSPECT       46
#define IKOT_THREAD_READ          47
#define IKOT_SUID_CRED            48
#define IKOT_HYPERVISOR           49

#define IKOT_UNKNOWN              50	/* magic catchall	*/
#define IKOT_MAX_TYPE             (IKOT_UNKNOWN+1)	/* # of IKOT_ types	*/


#define PORT_FLAG_TO_INDEX(flag) ( __builtin_ctz(flag) ) /* count trailing zeros */
#define INDEX_TO_PORT_FLAG(idx) ( 1 << idx )
typedef struct port_status_flag_info {
    natural_t flag; /* MACH_PORT_STATUS_FLAG_* */
    const char *compact_name; /* Single character name for compact representation */
    const char *name; /* human readable long name */
} port_status_flag_info_t;

/*
 * list of names for possible MACH_PORT_STATUS_FLAG_*
 * indexed by PORT_FLAG_TO_INDEX(MACH_PORT_STATUS_FLAG_*)
 */
extern const port_status_flag_info_t port_status_flags[];

#define _SHOW_PORT_STATUS_FLAG(flags, flag) \
  (flags & flag) ? port_status_flags[PORT_FLAG_TO_INDEX(flag)].compact_name : "-"
#define SHOW_PORT_STATUS_FLAGS(flags) \
  _SHOW_PORT_STATUS_FLAG(flags, MACH_PORT_STATUS_FLAG_TEMPOWNER), \
  _SHOW_PORT_STATUS_FLAG(flags, MACH_PORT_STATUS_FLAG_GUARDED), \
  _SHOW_PORT_STATUS_FLAG(flags, MACH_PORT_STATUS_FLAG_STRICT_GUARD), \
  _SHOW_PORT_STATUS_FLAG(flags, MACH_PORT_STATUS_FLAG_IMP_DONATION), \
  _SHOW_PORT_STATUS_FLAG(flags, MACH_PORT_STATUS_FLAG_REVIVE), \
  _SHOW_PORT_STATUS_FLAG(flags, MACH_PORT_STATUS_FLAG_TASKPTR)


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

/* mach port related functions */
const char * kobject_name(natural_t kotype);
void get_receive_port_context(task_read_t taskp, mach_port_name_t portname, mach_port_context_t *context);
int get_recieve_port_status(task_read_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, JSON_t json);

/* task and thread related helper functions */
kern_return_t collect_per_task_info(my_per_task_info_t *taskinfo, task_read_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, JSON_t json);
kern_return_t print_task_threads_special_ports(my_per_task_info_t *taskinfo, JSON_t json);
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_taskinfo_of_receiver_by_send_right_info(ipc_info_port_t sendright_info, my_per_task_info_t **out_taskinfo, mach_port_name_t *out_recv_info);

/* basic util functions */
uint32_t print_hex_data(char *outstr, uint32_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	27	#include <mach/mach.h>
00bf83c0	28	#include <mach_debug/ipc_info.h>
887d5eed	29	#include "json.h"
ac27e6b4	30
1a7e3f61 A	31	#define PROC_NAME_LEN 100
1a7e3f61 A	32	#define BUFSTR_LEN 30
ac27e6b4	33	#define VOUCHER_DETAIL_MAXLEN 1024
1a7e3f61 A	34
	35	/* common struct to hold all configurations, static and args based */
	36	struct prog_configs {
	37	boolean_t show_all_tasks;
	38	boolean_t show_voucher_details;
	39	boolean_t verbose;
	40	int voucher_detail_length;
	41	pid_t pid; /* if user focusing only one pid */
887d5eed	42	JSON_t json_output;
1a7e3f61 A	43	};
	44
	45	extern struct prog_configs lsmp_config;
	46
ac27e6b4 A	47	/* exception port information */
	48	struct exc_port_info {
	49	mach_msg_type_number_t count;
00bf83c0	50	ipc_info_port_t ports_info[EXC_TYPES_COUNT];
ac27e6b4 A	51	exception_mask_t masks[EXC_TYPES_COUNT];
	52	exception_behavior_t behaviors[EXC_TYPES_COUNT];
	53	thread_state_flavor_t flavors[EXC_TYPES_COUNT];
	54	};
	55
	56	/* private structure to hold thread specific information */
	57	struct my_per_thread_info {
	58	mach_port_t thread;
	59	uint32_t th_kobject;
	60	uint64_t th_id;
	61	char * voucher_detail;
	62	};
	63
cf37c299 A	64	/* kobject to name hash table declarations */
	65	#define K2N_TABLE_SIZE 256
	66
	67	struct k2n_table_node {
	68	natural_t kobject; /* kobject referred to by the name -- the key into the table */
	69	ipc_info_name_t info_name; / info about the name that refers to the key kobject -- value of the table */
	70	struct k2n_table_node *next;
	71	};
	72
	73	struct k2n_table_node k2n_table_lookup_next(struct k2n_table_node node, natural_t kobject);
	74	struct k2n_table_node k2n_table_lookup(struct k2n_table_node *table, natural_t kobject);
	75
1a7e3f61 A	76	/* private structure to wrap up per-task info */
1a7e3f61 A	77	typedef struct my_per_task_info {
00bf83c0	78	task_read_t task;
1a7e3f61 A	79	pid_t pid;
	80	vm_address_t task_kobject;
	81	ipc_info_space_t info;
	82	ipc_info_name_array_t table;
	83	mach_msg_type_number_t tableCount;
	84	ipc_info_tree_name_array_t tree;
	85	mach_msg_type_number_t treeCount;
	86	boolean_t valid; /* TRUE if all data is accurately collected */
cf37c299	87	struct k2n_table_node *k2ntable[K2N_TABLE_SIZE];
1a7e3f61	88	char processName[PROC_NAME_LEN];
ac27e6b4 A	89	struct exc_port_info exceptionInfo;
	90	struct my_per_thread_info * threadInfos; /* dynamically allocated in collect_per_task_info */
	91	unsigned int threadCount;
	92	struct exc_port_info threadExceptionInfos; / this is 2 dimensional array with threadCount X struct exc_port_info of ports */
1a7e3f61 A	93	} my_per_task_info_t;
	94
	95
	96	/*
	97	* WARNING - these types are copied from xnu/osfmk/kern/ipc_kobject.h
	98	* Need to stay in sync to print accurate results.
	99	*/
	100	#define IKOT_NONE 0
c0bbac3a A	101	#define IKOT_THREAD_CONTROL 1
c0bbac3a A	102	#define IKOT_TASK_CONTROL 2
1a7e3f61 A	103	#define IKOT_HOST 3
	104	#define IKOT_HOST_PRIV 4
	105	#define IKOT_PROCESSOR 5
	106	#define IKOT_PSET 6
	107	#define IKOT_PSET_NAME 7
	108	#define IKOT_TIMER 8
	109	#define IKOT_PAGING_REQUEST 9
	110	#define IKOT_MIG 10
	111	#define IKOT_MEMORY_OBJECT 11
	112	#define IKOT_XMM_PAGER 12
	113	#define IKOT_XMM_KERNEL 13
	114	#define IKOT_XMM_REPLY 14
	115	#define IKOT_UND_REPLY 15
	116	#define IKOT_HOST_NOTIFY 16
	117	#define IKOT_HOST_SECURITY 17
	118	#define IKOT_LEDGER 18
	119	#define IKOT_MASTER_DEVICE 19
	120	#define IKOT_TASK_NAME 20
	121	#define IKOT_SUBSYSTEM 21
	122	#define IKOT_IO_DONE_QUEUE 22
	123	#define IKOT_SEMAPHORE 23
	124	#define IKOT_LOCK_SET 24
	125	#define IKOT_CLOCK 25
	126	#define IKOT_CLOCK_CTRL 26
570be395	127	#define IKOT_IOKIT_IDENT 27
1a7e3f61 A	128	#define IKOT_NAMED_ENTRY 28
	129	#define IKOT_IOKIT_CONNECT 29
	130	#define IKOT_IOKIT_OBJECT 30
	131	#define IKOT_UPL 31
	132	#define IKOT_MEM_OBJ_CONTROL 32
	133	#define IKOT_AU_SESSIONPORT 33
	134	#define IKOT_FILEPORT 34
	135	#define IKOT_LABELH 35
	136	#define IKOT_TASK_RESUME 36
	137	#define IKOT_VOUCHER 37
	138	#define IKOT_VOUCHER_ATTR_CONTROL 38
c0bbac3a A	139	#define IKOT_WORK_INTERVAL 39
	140	#define IKOT_UX_HANDLER 40
	141	#define IKOT_UEXT_OBJECT 41
	142	#define IKOT_ARCADE_REG 42
	143	#define IKOT_EVENTLINK 43
	144	#define IKOT_TASK_INSPECT 44
	145	#define IKOT_TASK_READ 45
	146	#define IKOT_THREAD_INSPECT 46
	147	#define IKOT_THREAD_READ 47
	148	#define IKOT_SUID_CRED 48
	149	#define IKOT_HYPERVISOR 49
	150
	151	#define IKOT_UNKNOWN 50 /* magic catchall */
1a7e3f61 A	152	#define IKOT_MAX_TYPE (IKOT_UNKNOWN+1) /* # of IKOT_ types */
1a7e3f61 A	153
887d5eed A	154
	155	#define PORT_FLAG_TO_INDEX(flag) ( __builtin_ctz(flag) ) /* count trailing zeros */
	156	#define INDEX_TO_PORT_FLAG(idx) ( 1 << idx )
	157	typedef struct port_status_flag_info {
	158	natural_t flag; /* MACH_PORT_STATUS_FLAG_* */
	159	const char compact_name; / Single character name for compact representation */
	160	const char name; / human readable long name */
	161	} port_status_flag_info_t;
	162
	163	/*
	164	* list of names for possible MACH_PORT_STATUS_FLAG_*
	165	* indexed by PORT_FLAG_TO_INDEX(MACH_PORT_STATUS_FLAG_*)
	166	*/
	167	extern const port_status_flag_info_t port_status_flags[];
	168
	169	#define _SHOW_PORT_STATUS_FLAG(flags, flag) \
	170	(flags & flag) ? port_status_flags[PORT_FLAG_TO_INDEX(flag)].compact_name : "-"
1a7e3f61	171	#define SHOW_PORT_STATUS_FLAGS(flags) \
887d5eed A	172	_SHOW_PORT_STATUS_FLAG(flags, MACH_PORT_STATUS_FLAG_TEMPOWNER), \
	173	_SHOW_PORT_STATUS_FLAG(flags, MACH_PORT_STATUS_FLAG_GUARDED), \
	174	_SHOW_PORT_STATUS_FLAG(flags, MACH_PORT_STATUS_FLAG_STRICT_GUARD), \
	175	_SHOW_PORT_STATUS_FLAG(flags, MACH_PORT_STATUS_FLAG_IMP_DONATION), \
	176	_SHOW_PORT_STATUS_FLAG(flags, MACH_PORT_STATUS_FLAG_REVIVE), \
	177	_SHOW_PORT_STATUS_FLAG(flags, MACH_PORT_STATUS_FLAG_TASKPTR)
1a7e3f61 A	178
1a7e3f61 A	179
887d5eed A	180	uint32_t show_recipe_detail(mach_voucher_attr_recipe_t recipe, char * voucher_outstr, uint32_t maxlen, JSON_t json);
887d5eed A	181	char *copy_voucher_detail(mach_port_t task, mach_port_name_t voucher, JSON_t json);
1a7e3f61 A	182
	183	/* mach port related functions */
	184	const char * kobject_name(natural_t kotype);
00bf83c0 A	185	void get_receive_port_context(task_read_t taskp, mach_port_name_t portname, mach_port_context_t *context);
00bf83c0 A	186	int get_recieve_port_status(task_read_t taskp, mach_port_name_t portname, mach_port_info_ext_t *info);
887d5eed	187	void show_task_mach_ports(my_per_task_info_t taskinfo, uint32_t taskCount, my_per_task_info_t allTaskInfos, JSON_t json);
1a7e3f61 A	188
1a7e3f61 A	189	/* task and thread related helper functions */
00bf83c0	190	kern_return_t collect_per_task_info(my_per_task_info_t *taskinfo, task_read_t target_task);
1a7e3f61 A	191	my_per_task_info_t * allocate_taskinfo_memory(uint32_t taskCount);
1a7e3f61 A	192	void deallocate_taskinfo_memory(my_per_task_info_t *data);
887d5eed A	193	kern_return_t print_task_exception_info(my_per_task_info_t *taskinfo, JSON_t json);
887d5eed A	194	kern_return_t print_task_threads_special_ports(my_per_task_info_t *taskinfo, JSON_t json);
1a7e3f61 A	195	my_per_task_info_t * get_taskinfo_by_kobject(natural_t kobj);
	196
	197	void get_exc_behavior_string(exception_behavior_t b, char *out_string, size_t len);
	198	void get_exc_mask_string(exception_mask_t m, char *out_string, size_t len);
00bf83c0 A	199	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);
00bf83c0 A	200	kern_return_t get_taskinfo_of_receiver_by_send_right_info(ipc_info_port_t sendright_info, my_per_task_info_t *out_taskinfo, mach_port_name_t out_recv_info);
1a7e3f61 A	201
1a7e3f61 A	202	/* basic util functions */
530d02b6	203	uint32_t print_hex_data(char outstr, uint32_t maxlen, char prefix, char desc, void addr, int len);
1a7e3f61 A	204
1a7e3f61 A	205	#endif