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