xref: /illumos-gate/usr/src/uts/common/sys/fasttrap.h (revision 0250c53ad267726f2438e3c6556199a0bbf588a2)
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 #include <sys/fasttrap_isa.h>
31 #include <sys/dtrace.h>
32 #include <sys/types.h>
33 
34 #ifdef	__cplusplus
35 extern "C" {
36 #endif
37 
38 #define	FASTTRAPIOC		(('m' << 24) | ('r' << 16) | ('f' << 8))
39 #define	FASTTRAPIOC_MAKEPROBE	(FASTTRAPIOC | 1)
40 #define	FASTTRAPIOC_GETINSTR	(FASTTRAPIOC | 2)
41 
42 typedef enum fasttrap_probe_type {
43 	DTFTP_NONE = 0,
44 	DTFTP_ENTRY,
45 	DTFTP_RETURN,
46 	DTFTP_OFFSETS,
47 	DTFTP_POST_OFFSETS,
48 	DTFTP_IS_ENABLED
49 } fasttrap_probe_type_t;
50 
51 typedef struct fasttrap_probe_spec {
52 	pid_t			ftps_pid;
53 	fasttrap_probe_type_t	ftps_type;
54 
55 	char			ftps_func[DTRACE_FUNCNAMELEN];
56 	char			ftps_mod[DTRACE_MODNAMELEN];
57 
58 	uint64_t		ftps_pc;
59 	uint64_t		ftps_size;
60 	uint64_t		ftps_noffs;
61 	uint64_t		ftps_offs[1];
62 } fasttrap_probe_spec_t;
63 
64 typedef struct fasttrap_instr_query {
65 	uint64_t		ftiq_pc;
66 	pid_t			ftiq_pid;
67 	fasttrap_instr_t	ftiq_instr;
68 } fasttrap_instr_query_t;
69 
70 /*
71  * To support the fasttrap provider from very early in a process's life,
72  * the run-time linker, ld.so.1, has a program header of type PT_SUNWDTRACE
73  * which points to a data object which must be PT_SUNWDTRACE_SIZE bytes.
74  * This structure mimics the fasttrap provider section of the ulwp_t structure.
75  * When the fasttrap provider is changed to require new or different
76  * instructions, the data object in ld.so.1 and the thread initializers in libc
77  * (libc_init() and _thrp_create()) need to be updated to include the new
78  * instructions, and PT_SUNWDTRACE needs to be changed to a new unique number
79  * (while the old value gets assigned something like PT_SUNWDTRACE_1). Since the
80  * linker must be backward compatible with old Solaris releases, it must have
81  * program headers for each of the PT_SUNWDTRACE versions. The kernel's
82  * elfexec() function only has to look for the latest version of the
83  * PT_SUNWDTRACE program header.
84  */
85 #define	PT_SUNWDTRACE_SIZE	FASTTRAP_SUNWDTRACE_SIZE
86 
87 #ifdef	__cplusplus
88 }
89 #endif
90 
91 #endif	/* _SYS_FASTTRAP_H */
92