1 /*
2 * CDDL HEADER START
3 *
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
7 *
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
12 *
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 *
19 * CDDL HEADER END
20 */
21 /*
22 * Copyright 2014 Garrett D'Amore <garrett@damore.org>
23 *
24 * Copyright 2010 Sun Microsystems, Inc. All rights reserved.
25 * Use is subject to license terms.
26 */
27
28 /*
29 * Copyright (c) 2012, 2017 by Delphix. All rights reserved.
30 * Copyright 2013 Saso Kiselkov. All rights reserved.
31 * Copyright 2015 Nexenta Systems, Inc. All rights reserved.
32 */
33
34 /* Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */
35 /* All Rights Reserved */
36
37 #ifndef _SYS_DEBUG_H
38 #define _SYS_DEBUG_H
39
40 #include <sys/isa_defs.h>
41 #include <sys/types.h>
42 #include <sys/note.h>
43
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47
48 /*
49 * ASSERT(ex) causes a panic or debugger entry if expression ex is not
50 * true. ASSERT() is included only for debugging, and is a no-op in
51 * production kernels. VERIFY(ex), on the other hand, behaves like
52 * ASSERT and is evaluated on both debug and non-debug kernels.
53 */
54
55 extern int assfail(const char *, const char *, int);
56 #define VERIFY(EX) ((void)((EX) || assfail(#EX, __FILE__, __LINE__)))
57 #if DEBUG
58 #define ASSERT(EX) ((void)((EX) || assfail(#EX, __FILE__, __LINE__)))
59 #else
60 #define ASSERT(x) ((void)0)
61 #endif
62
63 /*
64 * Assertion variants sensitive to the compilation data model
65 */
66 #if defined(_LP64)
67 #define ASSERT64(x) ASSERT(x)
68 #define ASSERT32(x)
69 #else
70 #define ASSERT64(x)
71 #define ASSERT32(x) ASSERT(x)
72 #endif
73
74 /*
75 * IMPLY and EQUIV are assertions of the form:
76 *
77 * if (a) then (b)
78 * and
79 * if (a) then (b) *AND* if (b) then (a)
80 */
81 #if DEBUG
82 #define IMPLY(A, B) \
83 ((void)(((!(A)) || (B)) || \
84 assfail("(" #A ") implies (" #B ")", __FILE__, __LINE__)))
85 #define EQUIV(A, B) \
86 ((void)((!!(A) == !!(B)) || \
87 assfail("(" #A ") is equivalent to (" #B ")", __FILE__, __LINE__)))
88 #else
89 #define IMPLY(A, B) ((void)0)
90 #define EQUIV(A, B) ((void)0)
91 #endif
92
93 /*
94 * ASSERT3() behaves like ASSERT() except that it is an explicit conditional,
95 * and prints out the values of the left and right hand expressions as part of
96 * the panic message to ease debugging. The three variants imply the type
97 * of their arguments. ASSERT3S() is for signed data types, ASSERT3U() is
98 * for unsigned, and ASSERT3P() is for pointers. The VERIFY3*() macros
99 * have the same relationship as above.
100 */
101 extern void assfail3(const char *, uintmax_t, const char *, uintmax_t,
102 const char *, int);
103 #define VERIFY3_IMPL(LEFT, OP, RIGHT, TYPE) do { \
104 const TYPE __left = (TYPE)(LEFT); \
105 const TYPE __right = (TYPE)(RIGHT); \
106 if (!(__left OP __right)) \
107 assfail3(#LEFT " " #OP " " #RIGHT, \
108 (uintmax_t)__left, #OP, (uintmax_t)__right, \
109 __FILE__, __LINE__); \
110 _NOTE(CONSTCOND) } while (0)
111
112 #define VERIFY3B(x, y, z) VERIFY3_IMPL(x, y, z, boolean_t)
113 #define VERIFY3S(x, y, z) VERIFY3_IMPL(x, y, z, int64_t)
114 #define VERIFY3U(x, y, z) VERIFY3_IMPL(x, y, z, uint64_t)
115 #define VERIFY3P(x, y, z) VERIFY3_IMPL(x, y, z, uintptr_t)
116 #define VERIFY0(x) VERIFY3_IMPL(x, ==, 0, uintmax_t)
117
118 #if DEBUG
119 #define ASSERT3B(x, y, z) VERIFY3_IMPL(x, y, z, boolean_t)
120 #define ASSERT3S(x, y, z) VERIFY3_IMPL(x, y, z, int64_t)
121 #define ASSERT3U(x, y, z) VERIFY3_IMPL(x, y, z, uint64_t)
122 #define ASSERT3P(x, y, z) VERIFY3_IMPL(x, y, z, uintptr_t)
123 #define ASSERT0(x) VERIFY3_IMPL(x, ==, 0, uintmax_t)
124 #else
125 #define ASSERT3B(x, y, z) ((void)0)
126 #define ASSERT3S(x, y, z) ((void)0)
127 #define ASSERT3U(x, y, z) ((void)0)
128 #define ASSERT3P(x, y, z) ((void)0)
129 #define ASSERT0(x) ((void)0)
130 #endif
131
132 /*
133 * Compile-time assertion. The condition 'x' must be constant.
134 */
135 #define CTASSERT(x) _CTASSERT(x, __LINE__)
136 #define _CTASSERT(x, y) __CTASSERT(x, y)
137 #define __CTASSERT(x, y) \
138 typedef char __compile_time_assertion__ ## y [(x) ? 1 : -1] __unused
139
140 #if defined(_KERNEL) || defined(_FAKE_KERNEL)
141
142 extern void abort_sequence_enter(char *);
143 extern void debug_enter(char *);
144
145 #endif /* _KERNEL || _FAKE_KERNEL */
146
147 #if defined(DEBUG) && !defined(__sun)
148 /* CSTYLED */
149 #define STATIC
150 #else
151 /* CSTYLED */
152 #define STATIC static
153 #endif
154
155 #ifdef __cplusplus
156 }
157 #endif
158
159 #endif /* _SYS_DEBUG_H */