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