lockstat.h revision 1.3
1 /* $NetBSD: lockstat.h,v 1.3 2007/01/29 01:52:45 hubertf Exp $ */ 2 3 /*- 4 * Copyright (c) 2006 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Andrew Doran. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. All advertising materials mentioning features or use of this software 19 * must display the following acknowledgement: 20 * This product includes software developed by the NetBSD 21 * Foundation, Inc. and its contributors. 22 * 4. Neither the name of The NetBSD Foundation nor the names of its 23 * contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 36 * POSSIBILITY OF SUCH DAMAGE. 37 */ 38 39 #ifndef _SYS_LOCKSTAT_H_ 40 #define _SYS_LOCKSTAT_H_ 41 42 #ifdef _KERNEL_OPT 43 #include <lockstat.h> 44 #endif 45 46 #include <sys/types.h> 47 #include <sys/ioccom.h> 48 #include <sys/queue.h> 49 #include <sys/time.h> 50 51 #if defined(_KERNEL) && defined(__HAVE_CPU_COUNTER) 52 #include <machine/cpu_counter.h> 53 #endif 54 55 /* 56 * Interface version. The interface is not designed to provide 57 * compatibility across NetBSD releases. 58 */ 59 60 #define IOC_LOCKSTAT_GVERSION _IOR('L', 0, int) 61 62 #define LS_VERSION 3 63 64 /* 65 * Enable request. We can limit tracing by the call site and by 66 * the lock. We also specify the number of event buffers to 67 * allocate up front, and what kind of events to track. 68 */ 69 70 #define IOC_LOCKSTAT_ENABLE _IOW('L', 1, lsenable_t) 71 72 #define LE_CALLSITE 0x01 /* track call sites */ 73 #define LE_ONE_CALLSITE 0x02 /* specific call site */ 74 #define LE_ONE_LOCK 0x04 /* specific lock */ 75 76 typedef struct lsenable { 77 uintptr_t le_csstart; /* callsite start */ 78 uintptr_t le_csend; /* callsite end */ 79 uintptr_t le_lockstart; /* lock address start */ 80 uintptr_t le_lockend; /* lock address end */ 81 uintptr_t le_nbufs; /* buffers to allocate, 0 = default */ 82 u_int le_flags; /* request flags */ 83 u_int le_mask; /* event mask (LB_*) */ 84 } lsenable_t; 85 86 /* 87 * Disable request. 88 */ 89 90 #define IOC_LOCKSTAT_DISABLE _IOR('L', 2, lsdisable_t) 91 92 typedef struct lsdisable { 93 size_t ld_size; /* buffer space allocated */ 94 struct timespec ld_time; /* time spent enabled */ 95 uint64_t ld_freq[64]; /* counter HZ by CPU number */ 96 } lsdisable_t; 97 98 /* 99 * Event buffers returned from reading from the devices. 100 */ 101 102 /* 103 * Event types, for lockstat_event(). Stored in lb_flags but should be 104 * meaningless to the consumer, also provided with the enable request 105 * in le_mask. 106 */ 107 #define LB_SPIN 0x00000001 108 #define LB_SLEEP1 0x00000002 109 #define LB_SLEEP2 0x00000003 110 #define LB_NEVENT 0x00000003 111 #define LB_EVENT_MASK 0x000000ff 112 113 /* 114 * Lock types, the only part of lb_flags that should be inspected. Also 115 * provided with the enable request in le_mask. 116 */ 117 #define LB_ADAPTIVE_MUTEX 0x00000100 118 #define LB_SPIN_MUTEX 0x00000200 119 #define LB_RWLOCK 0x00000300 120 #define LB_LOCKMGR 0x00000400 121 #define LB_KERNEL_LOCK 0x00000500 122 #define LB_NLOCK 0x00000500 123 #define LB_LOCK_MASK 0x0000ff00 124 #define LB_LOCK_SHIFT 8 125 126 typedef struct lsbuf { 127 union { 128 LIST_ENTRY(lsbuf) list; 129 SLIST_ENTRY(lsbuf) slist; 130 TAILQ_ENTRY(lsbuf) tailq; 131 } lb_chain; 132 uintptr_t lb_lock; /* lock address */ 133 uintptr_t lb_callsite; /* call site */ 134 uint64_t lb_times[LB_NEVENT]; /* cumulative times */ 135 uint32_t lb_counts[LB_NEVENT]; /* count of events */ 136 uint16_t lb_flags; /* lock type */ 137 uint16_t lb_cpu; /* CPU number */ 138 } lsbuf_t; 139 140 /* 141 * Tracing stubs used by lock providers, e.g. lockmgr(). 142 */ 143 144 #if defined(_KERNEL) && defined(__HAVE_CPU_COUNTER) && NLOCKSTAT > 0 145 146 #define LOCKSTAT_EVENT(lock, type, count, time) \ 147 do { \ 148 if (__predict_false(lockstat_enabled)) \ 149 lockstat_event((uintptr_t)(lock), \ 150 (uintptr_t)__builtin_return_address(0), \ 151 (type), (count), (time)); \ 152 } while (/* CONSTCOND */ 0); 153 154 #define LOCKSTAT_EVENT_RA(lock, type, count, time, ra) \ 155 do { \ 156 if (__predict_false(lockstat_enabled)) \ 157 lockstat_event((uintptr_t)(lock), (uintptr_t)ra, \ 158 (type), (count), (time)); \ 159 } while (/* CONSTCOND */ 0); 160 161 #define LOCKSTAT_TIMER(name) uint64_t name = 0 162 #define LOCKSTAT_COUNTER(name) uint64_t name = 0 163 164 #define LOCKSTAT_START_TIMER(name) \ 165 do { \ 166 (name) -= cpu_counter(); \ 167 } while (/* CONSTCOND */ 0) 168 169 #define LOCKSTAT_STOP_TIMER(name) \ 170 do { \ 171 (name) += cpu_counter(); \ 172 } while (/* CONSTCOND */ 0) 173 174 #define LOCKSTAT_COUNT(name, inc) \ 175 do { \ 176 (name) += (inc); \ 177 } while (/* CONSTCOND */ 0) 178 179 void lockstat_event(uintptr_t, uintptr_t, u_int, u_int, uint64_t); 180 181 extern volatile u_int lockstat_enabled; 182 183 #else 184 185 #define LOCKSTAT_EVENT(lock, type, count, time) /* nothing */ 186 #define LOCKSTAT_EVENT_RA(lock, type, count, time, ra) /* nothing */ 187 #define LOCKSTAT_TIMER(void) /* nothing */ 188 #define LOCKSTAT_COUNTER(void) /* nothing */ 189 #define LOCKSTAT_START_TIMER(void) /* nothing */ 190 #define LOCKSTAT_STOP_TIMER(void) /* nothing */ 191 #define LOCKSTAT_COUNT(name, int) /* nothing */ 192 193 #endif 194 195 #endif /* _SYS_LOCKSTAT_H_ */ 196
Indexes created Fri Oct 03 02:09:57 GMT 2025