xref: /xnu-11215.1.10/bsd/sys/fbt.h (revision 8d741a5de7ff4191bf97d57b9f54c2f6d4a15585)
1*8d741a5dSApple OSS Distributions /*
2*8d741a5dSApple OSS Distributions  * Copyright (c) 2005-2006 Apple Computer, Inc. All rights reserved.
3*8d741a5dSApple OSS Distributions  *
4*8d741a5dSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*8d741a5dSApple OSS Distributions  *
6*8d741a5dSApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*8d741a5dSApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*8d741a5dSApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*8d741a5dSApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*8d741a5dSApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*8d741a5dSApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*8d741a5dSApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*8d741a5dSApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*8d741a5dSApple OSS Distributions  *
15*8d741a5dSApple OSS Distributions  * Please obtain a copy of the License at
16*8d741a5dSApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*8d741a5dSApple OSS Distributions  *
18*8d741a5dSApple OSS Distributions  * The Original Code and all software distributed under the License are
19*8d741a5dSApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*8d741a5dSApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*8d741a5dSApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*8d741a5dSApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*8d741a5dSApple OSS Distributions  * Please see the License for the specific language governing rights and
24*8d741a5dSApple OSS Distributions  * limitations under the License.
25*8d741a5dSApple OSS Distributions  *
26*8d741a5dSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*8d741a5dSApple OSS Distributions  */
28*8d741a5dSApple OSS Distributions 
29*8d741a5dSApple OSS Distributions #ifndef _FBT_H
30*8d741a5dSApple OSS Distributions #define _FBT_H
31*8d741a5dSApple OSS Distributions 
32*8d741a5dSApple OSS Distributions #if defined (__x86_64__)
33*8d741a5dSApple OSS Distributions typedef uint8_t machine_inst_t;
34*8d741a5dSApple OSS Distributions #elif defined(__arm__)
35*8d741a5dSApple OSS Distributions typedef uint16_t machine_inst_t;
36*8d741a5dSApple OSS Distributions #elif defined(__arm64__)
37*8d741a5dSApple OSS Distributions typedef uint32_t machine_inst_t;
38*8d741a5dSApple OSS Distributions #else
39*8d741a5dSApple OSS Distributions #error Unknown Architecture
40*8d741a5dSApple OSS Distributions #endif
41*8d741a5dSApple OSS Distributions 
42*8d741a5dSApple OSS Distributions #define MAX_FBTP_NAME_CHARS 16
43*8d741a5dSApple OSS Distributions 
44*8d741a5dSApple OSS Distributions typedef struct fbt_probe {
45*8d741a5dSApple OSS Distributions 	struct fbt_probe *fbtp_hashnext;
46*8d741a5dSApple OSS Distributions 	machine_inst_t	*fbtp_patchpoint;
47*8d741a5dSApple OSS Distributions 	int8_t			fbtp_rval;
48*8d741a5dSApple OSS Distributions 	machine_inst_t	fbtp_patchval;
49*8d741a5dSApple OSS Distributions 	machine_inst_t	fbtp_savedval;
50*8d741a5dSApple OSS Distributions         machine_inst_t  fbtp_currentval;
51*8d741a5dSApple OSS Distributions 	uintptr_t		fbtp_roffset;
52*8d741a5dSApple OSS Distributions 	dtrace_id_t		fbtp_id;
53*8d741a5dSApple OSS Distributions 	/* FIXME!
54*8d741a5dSApple OSS Distributions 	 * This field appears to only be used in error messages.
55*8d741a5dSApple OSS Distributions 	 * It puts this structure into the next size bucket in kmem_alloc
56*8d741a5dSApple OSS Distributions 	 * wasting 32 bytes per probe. (in i386 only)
57*8d741a5dSApple OSS Distributions 	 */
58*8d741a5dSApple OSS Distributions 	char			fbtp_name[MAX_FBTP_NAME_CHARS];
59*8d741a5dSApple OSS Distributions 	struct modctl	*fbtp_ctl;
60*8d741a5dSApple OSS Distributions 	int		fbtp_loadcnt;
61*8d741a5dSApple OSS Distributions 	struct fbt_probe *fbtp_next;
62*8d741a5dSApple OSS Distributions } fbt_probe_t;
63*8d741a5dSApple OSS Distributions 
64*8d741a5dSApple OSS Distributions extern int dtrace_invop(uintptr_t, uintptr_t *, uintptr_t);
65*8d741a5dSApple OSS Distributions extern int fbt_invop(uintptr_t, uintptr_t *, uintptr_t);
66*8d741a5dSApple OSS Distributions extern void fbt_provide_module(void *, struct modctl *);
67*8d741a5dSApple OSS Distributions extern int fbt_enable (void *arg, dtrace_id_t id, void *parg);
68*8d741a5dSApple OSS Distributions 
69*8d741a5dSApple OSS Distributions extern bool fbt_module_excluded(struct modctl*);
70*8d741a5dSApple OSS Distributions extern bool fbt_excluded(const char *);
71*8d741a5dSApple OSS Distributions 
72*8d741a5dSApple OSS Distributions extern void fbt_blacklist_init(void);
73*8d741a5dSApple OSS Distributions extern void fbt_provide_probe(struct modctl *ctl, const char *modname, const char *name, machine_inst_t *instr, machine_inst_t *limit);
74*8d741a5dSApple OSS Distributions #endif /* _FBT_H */
75