1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
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
30#ifndef _SYS_LOCK_PROFILE_H_
31#define _SYS_LOCK_PROFILE_H_
32
33struct lock_profile_object;
34LIST_HEAD(lpohead, lock_profile_object);
35
36#ifdef _KERNEL
37#ifdef LOCK_PROFILING
38#include <machine/cpufunc.h>
39#include <sys/lock.h>
40
41#ifndef USE_CPU_NANOSECONDS
42u_int64_t nanoseconds(void);
43#endif
44
45extern volatile int lock_prof_enable;
46
47void lock_profile_obtain_lock_success(struct lock_object *lo, bool spin,
48    int contested, uint64_t waittime, const char *file, int line);
49void lock_profile_release_lock(struct lock_object *lo, bool spin);
50void lock_profile_thread_exit(struct thread *td);
51
52static inline void
53lock_profile_obtain_lock_failed(struct lock_object *lo, bool spin,
54    int *contested, 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#define	lock_profile_release_lock(lo, spin)				(void)0
65#define lock_profile_obtain_lock_failed(lo, spin, contested, waittime)	(void)0
66#define lock_profile_obtain_lock_success(lo, spin, contested, waittime, file, line)	(void)0
67#define	lock_profile_thread_exit(td)					(void)0
68
69#endif  /* !LOCK_PROFILING */
70
71#endif /* _KERNEL */
72
73#endif /* _SYS_LOCK_PROFILE_H_ */
74