xref: /freebsd/sys/sys/lock_profile.h (revision 2be1a816b9ff69588e55be0a84cbe2a31efc0f2f)
1 /*-
2  * Copyright (c) 2006 Kip Macy kmacy@FreeBSD.org
3  * Copyright (c) 2006 Kris Kennaway kris@FreeBSD.org
4  * Copyright (c) 2006 Dag-Erling Smorgrav des@des.no
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHAL THE AUTHORS BE LIABLE FOR ANY
19  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  *
27  * $FreeBSD$
28  */
29 
30 
31 #ifndef _SYS_LOCK_PROFILE_H_
32 #define _SYS_LOCK_PROFILE_H_
33 
34 struct lock_profile_object;
35 LIST_HEAD(lpohead, lock_profile_object);
36 
37 #ifdef _KERNEL
38 #ifdef LOCK_PROFILING
39 #include <machine/cpufunc.h>
40 #include <sys/lock.h>
41 
42 #ifndef USE_CPU_NANOSECONDS
43 u_int64_t nanoseconds(void);
44 #endif
45 
46 extern int lock_prof_enable;
47 
48 void lock_profile_obtain_lock_success(struct lock_object *lo, int contested,
49     uint64_t waittime, const char *file, int line);
50 void lock_profile_release_lock(struct lock_object *lo);
51 
52 static inline void
53 lock_profile_obtain_lock_failed(struct lock_object *lo, int *contested,
54     uint64_t *waittime)
55 {
56 	if (!lock_prof_enable || (lo->lo_flags & LO_NOPROFILE) || *contested)
57 		return;
58 	*waittime = nanoseconds();
59 	*contested = 1;
60 }
61 
62 #else /* !LOCK_PROFILING */
63 
64 static inline void
65 lock_profile_release_lock(struct lock_object *lo)
66 {
67 }
68 
69 static inline void
70 lock_profile_obtain_lock_failed(struct lock_object *lo, int *contested, uint64_t *waittime)
71 {
72 }
73 
74 static inline void
75 lock_profile_obtain_lock_success(struct lock_object *lo, int contested, uint64_t waittime,
76     const char *file, int line)
77 {
78 }
79 
80 #endif  /* !LOCK_PROFILING */
81 
82 #endif /* _KERNEL */
83 
84 #endif /* _SYS_LOCK_PROFILE_H_ */
85