1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1997 Berkeley Software Design, Inc. All rights reserved.
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 * 3. Berkeley Software Design Inc's name may not be used to endorse or
15 *    promote products derived from this software without specific prior
16 *    written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY BERKELEY SOFTWARE DESIGN INC ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED.  IN NO EVENT SHALL BERKELEY SOFTWARE DESIGN INC BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
29 *
30 * $FreeBSD$
31 */
32
33#ifndef _SYS__LOCK_H_
34#define	_SYS__LOCK_H_
35
36struct lock_object {
37	const	char *lo_name;		/* Individual lock name. */
38	u_int	lo_flags;
39	u_int	lo_data;		/* General class specific data. */
40	struct	witness *lo_witness;	/* Data for witness. */
41};
42
43#ifdef _KERNEL
44/*
45 * If any of WITNESS, INVARIANTS, or KTR_LOCK KTR tracing has been enabled,
46 * then turn on LOCK_DEBUG.  When this option is on, extra debugging
47 * facilities such as tracking the file and line number of lock operations
48 * are enabled.  Also, mutex locking operations are not inlined to avoid
49 * bloat from all the extra debugging code.  We also have to turn on all the
50 * calling conventions for this debugging code in modules so that modules can
51 * work with both debug and non-debug kernels.
52 */
53#if (defined(KLD_MODULE) && !defined(KLD_TIED)) || defined(WITNESS) || defined(INVARIANTS) || \
54    defined(LOCK_PROFILING) || defined(KTR)
55#define	LOCK_DEBUG	1
56#else
57#define	LOCK_DEBUG	0
58#endif
59
60/*
61 * In the LOCK_DEBUG case, use the filename and line numbers for debugging
62 * operations.  Otherwise, use default values to avoid the unneeded bloat.
63 */
64#if LOCK_DEBUG > 0
65#define LOCK_FILE_LINE_ARG_DEF	, const char *file, int line
66#define LOCK_FILE_LINE_ARG	, file, line
67#define	LOCK_FILE	__FILE__
68#define	LOCK_LINE	__LINE__
69#else
70#define LOCK_FILE_LINE_ARG_DEF
71#define LOCK_FILE_LINE_ARG
72#define	LOCK_FILE	NULL
73#define	LOCK_LINE	0
74#endif
75#endif /* _KERNEL */
76
77#endif /* !_SYS__LOCK_H_ */
78