1 | /* |
2 | * Copyright (c) 2012 Apple 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 _KERN_BTLOG_H_ |
30 | #define _KERN_BTLOG_H_ |
31 | |
32 | #include <kern/kern_types.h> |
33 | #include <kern/debug.h> |
34 | #include <sys/cdefs.h> |
35 | #include <stdint.h> |
36 | #include <mach_debug/zone_info.h> |
37 | |
38 | #ifdef XNU_KERNEL_PRIVATE |
39 | |
40 | /* |
41 | * The btlog subsystem allows for fast unobtrusive backtraces |
42 | * to be recorded and maintained in chronological order. |
43 | * |
44 | * Each backtrace is associated with an element/object, |
45 | * and an operation. For example, memory allocations and |
46 | * frees can be tracked with this infrastructure. So |
47 | * can refcounts. The "operation" namespace is maintained |
48 | * by the caller. |
49 | * |
50 | * When the event buffer fills, records are reused in FIFO |
51 | * order. |
52 | * |
53 | * When a btlog_t is created, callbacks can be provided |
54 | * to ensure proper locking of the datastructures. If these |
55 | * are not provided, the caller is responsible for |
56 | * preventing simultaneous modification. |
57 | */ |
58 | |
59 | /* |
60 | * BTLOG_MAX_DEPTH configures how deep of a stack trace is stored. 15 |
61 | * levels is usually enough to get past all the layers of code in |
62 | * kalloc and IOKit and see who the actual caller is up above these |
63 | * lower levels, when used by the zone allocator logging code. |
64 | */ |
65 | |
66 | #define BTLOG_MAX_DEPTH 15 |
67 | |
68 | struct btlog; |
69 | typedef struct btlog btlog_t; |
70 | |
71 | extern btlog_t *btlog_create(size_t numrecords, |
72 | size_t record_btdepth, |
73 | boolean_t caller_will_remove_entries_for_element); |
74 | |
75 | extern void btlog_add_entry(btlog_t *btlog, |
76 | void *element, |
77 | uint8_t operation, |
78 | void *bt[], |
79 | size_t btcount); |
80 | |
81 | extern void btlog_remove_entries_for_element(btlog_t *btlog, |
82 | void *element); |
83 | |
84 | #if DEBUG || DEVELOPMENT |
85 | void btlog_copy_backtraces_for_elements(btlog_t * btlog, |
86 | uintptr_t * instances, |
87 | uint32_t * count, |
88 | uint32_t zoneSize, |
89 | leak_site_proc proc, |
90 | void * refCon); |
91 | |
92 | size_t get_btlog_records_count(btlog_t *btlog); |
93 | |
94 | void get_btlog_records(btlog_t *btlog, |
95 | zone_btrecord_t *records, |
96 | unsigned int *numrecs); |
97 | |
98 | #endif /* DEBUG || DEVELOPMENT */ |
99 | |
100 | #endif /* XNU_KERNEL_PRIVATE */ |
101 | |
102 | #endif /* _KERN_BTLOG_H_ */ |
103 | |