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