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

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#ifndef	_SYS_FASTTRAP_H
#define	_SYS_FASTTRAP_H

/* #pragma ident	"@(#)fasttrap.h	1.5	06/03/30 SMI" */

#include <sys/fasttrap_isa.h>
#include <sys/dtrace.h>
#include <sys/types.h>

#ifdef	__cplusplus
extern "C" {
#endif

#if !defined(__APPLE__)
#define	FASTTRAPIOC		(('m' << 24) | ('r' << 16) | ('f' << 8))
#else
#define	FASTTRAPIOC		_IO('d', 0)
#endif /* __APPLE__ */
#define	FASTTRAPIOC_MAKEPROBE	(FASTTRAPIOC | 1)
#define	FASTTRAPIOC_GETINSTR	(FASTTRAPIOC | 2)

typedef enum fasttrap_probe_type {
	DTFTP_NONE = 0,
	DTFTP_ENTRY,
	DTFTP_RETURN,
	DTFTP_OFFSETS,
	DTFTP_POST_OFFSETS,
	DTFTP_IS_ENABLED
} fasttrap_probe_type_t;

#if defined(__APPLE__)
typedef enum fasttrap_provider_type {
	DTFTP_PROVIDER_NONE = 0,
	DTFTP_PROVIDER_USDT, 
	DTFTP_PROVIDER_PID,
	DTFTP_PROVIDER_OBJC,
	DTFTP_PROVIDER_ONESHOT
} fasttrap_provider_type_t;

/* Moved from fasttrap.c */
#define	FASTTRAP_PID_NAME		"pid"
#define	FASTTRAP_OBJC_NAME		"objc"
#define	FASTTRAP_ONESHOT_NAME		"oneshot"

#endif

typedef struct fasttrap_probe_spec {
	pid_t				ftps_pid;
#if defined(__APPLE__)
	fasttrap_provider_type_t	ftps_provider_type;
	fasttrap_probe_type_t		ftps_probe_type;
#if defined(__arm__) || defined(__arm64__)
	uint32_t			ftps_arch_subinfo;	// For any additional per probe architecture specific data
#endif
#endif
	char				ftps_func[DTRACE_FUNCNAMELEN];
	char				ftps_mod[DTRACE_MODNAMELEN];

#if defined(__APPLE__)
#if defined(__arm__) || defined(__arm64__)
	// We already have 'padding' from the ftps_arch_subinfo above
#else
#if !defined(__LP64__)
	uint32_t			pad; /* Explicit pad to keep ILP32 and LP64 lined up. */
#endif
#endif
#endif
	uint64_t			ftps_pc;
	uint64_t			ftps_size;
	uint64_t			ftps_noffs;
	uint64_t			ftps_offs[1];
} fasttrap_probe_spec_t;

typedef struct fasttrap_instr_query {
	uint64_t		ftiq_pc;
	pid_t			ftiq_pid;
	fasttrap_instr_t	ftiq_instr;
} fasttrap_instr_query_t;

/*
 * To support the fasttrap provider from very early in a process's life,
 * the run-time linker, ld.so.1, has a program header of type PT_SUNWDTRACE
 * which points to a data object which must be PT_SUNWDTRACE_SIZE bytes.
 * This structure mimics the fasttrap provider section of the ulwp_t structure.
 * When the fasttrap provider is changed to require new or different
 * instructions, the data object in ld.so.1 and the thread initializers in libc
 * (libc_init() and _thrp_create()) need to be updated to include the new
 * instructions, and PT_SUNWDTRACE needs to be changed to a new unique number
 * (while the old value gets assigned something like PT_SUNWDTRACE_1). Since the
 * linker must be backward compatible with old Solaris releases, it must have
 * program headers for each of the PT_SUNWDTRACE versions. The kernel's
 * elfexec() function only has to look for the latest version of the
 * PT_SUNWDTRACE program header.
 */
#define	PT_SUNWDTRACE_SIZE	FASTTRAP_SUNWDTRACE_SIZE

#ifdef	__cplusplus
}
#endif

#endif	/* _SYS_FASTTRAP_H */
Commit	Line	Data
2d21ac55 A	1	/*
	2	* CDDL HEADER START
	3	*
	4	* The contents of this file are subject to the terms of the
	5	* Common Development and Distribution License (the "License").
	6	* You may not use this file except in compliance with the License.
	7	*
	8	* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
	9	* or http://www.opensolaris.org/os/licensing.
	10	* See the License for the specific language governing permissions
	11	* and limitations under the License.
	12	*
	13	* When distributing Covered Code, include this CDDL HEADER in each
	14	* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
	15	* If applicable, add the following below this CDDL HEADER, with the
	16	* fields enclosed by brackets "[]" replaced with your own identifying
	17	* information: Portions Copyright [yyyy] [name of copyright owner]
	18	*
	19	* CDDL HEADER END
	20	*/
	21
	22	/*
	23	* Copyright 2006 Sun Microsystems, Inc. All rights reserved.
	24	* Use is subject to license terms.
	25	*/
	26
	27	#ifndef _SYS_FASTTRAP_H
	28	#define _SYS_FASTTRAP_H
	29
	30	/* #pragma ident "@(#)fasttrap.h 1.5 06/03/30 SMI" */
	31
	32	#include <sys/fasttrap_isa.h>
	33	#include <sys/dtrace.h>
	34	#include <sys/types.h>
	35
	36	#ifdef __cplusplus
	37	extern "C" {
	38	#endif
	39
	40	#if !defined(__APPLE__)
	41	#define FASTTRAPIOC (('m' << 24) \| ('r' << 16) \| ('f' << 8))
	42	#else
	43	#define FASTTRAPIOC _IO('d', 0)
	44	#endif /* __APPLE__ */
	45	#define FASTTRAPIOC_MAKEPROBE (FASTTRAPIOC \| 1)
	46	#define FASTTRAPIOC_GETINSTR (FASTTRAPIOC \| 2)
	47
	48	typedef enum fasttrap_probe_type {
	49	DTFTP_NONE = 0,
	50	DTFTP_ENTRY,
	51	DTFTP_RETURN,
	52	DTFTP_OFFSETS,
	53	DTFTP_POST_OFFSETS,
	54	DTFTP_IS_ENABLED
	55	} fasttrap_probe_type_t;
	56
	57	#if defined(__APPLE__)
	58	typedef enum fasttrap_provider_type {
	59	DTFTP_PROVIDER_NONE = 0,
	60	DTFTP_PROVIDER_USDT,
	61	DTFTP_PROVIDER_PID,
	62	DTFTP_PROVIDER_OBJC,
	63	DTFTP_PROVIDER_ONESHOT
	64	} fasttrap_provider_type_t;
65
66	/* Moved from fasttrap.c */
67	#define FASTTRAP_PID_NAME "pid"
68	#define FASTTRAP_OBJC_NAME "objc"
69	#define FASTTRAP_ONESHOT_NAME "oneshot"
70
71	#endif
72
73	typedef struct fasttrap_probe_spec {
74	pid_t ftps_pid;
75	#if defined(__APPLE__)
76	fasttrap_provider_type_t ftps_provider_type;
77	fasttrap_probe_type_t ftps_probe_type;
5ba3f43e A	78	#if defined(__arm__) \|\| defined(__arm64__)
	79	uint32_t ftps_arch_subinfo; // For any additional per probe architecture specific data
	80	#endif
2d21ac55 A	81	#endif
	82	char ftps_func[DTRACE_FUNCNAMELEN];
	83	char ftps_mod[DTRACE_MODNAMELEN];
	84
b0d623f7	85	#if defined(__APPLE__)
5ba3f43e A	86	#if defined(__arm__) \|\| defined(__arm64__)
	87	// We already have 'padding' from the ftps_arch_subinfo above
	88	#else
b0d623f7 A	89	#if !defined(__LP64__)
	90	uint32_t pad; /* Explicit pad to keep ILP32 and LP64 lined up. */
	91	#endif
5ba3f43e	92	#endif
b0d623f7	93	#endif
2d21ac55 A	94	uint64_t ftps_pc;
	95	uint64_t ftps_size;
	96	uint64_t ftps_noffs;
	97	uint64_t ftps_offs[1];
	98	} fasttrap_probe_spec_t;
	99
	100	typedef struct fasttrap_instr_query {
	101	uint64_t ftiq_pc;
	102	pid_t ftiq_pid;
	103	fasttrap_instr_t ftiq_instr;
	104	} fasttrap_instr_query_t;
	105
	106	/*
	107	* To support the fasttrap provider from very early in a process's life,
	108	* the run-time linker, ld.so.1, has a program header of type PT_SUNWDTRACE
	109	* which points to a data object which must be PT_SUNWDTRACE_SIZE bytes.
	110	* This structure mimics the fasttrap provider section of the ulwp_t structure.
	111	* When the fasttrap provider is changed to require new or different
	112	* instructions, the data object in ld.so.1 and the thread initializers in libc
	113	* (libc_init() and _thrp_create()) need to be updated to include the new
	114	* instructions, and PT_SUNWDTRACE needs to be changed to a new unique number
	115	* (while the old value gets assigned something like PT_SUNWDTRACE_1). Since the
	116	* linker must be backward compatible with old Solaris releases, it must have
	117	* program headers for each of the PT_SUNWDTRACE versions. The kernel's
	118	* elfexec() function only has to look for the latest version of the
	119	* PT_SUNWDTRACE program header.
	120	*/
	121	#define PT_SUNWDTRACE_SIZE FASTTRAP_SUNWDTRACE_SIZE
	122
	123	#ifdef __cplusplus
	124	}
	125	#endif
	126
	127	#endif /* _SYS_FASTTRAP_H */