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