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 2010 Sun Microsystems, Inc. All rights reserved.
23 * Use is subject to license terms.
24 */
25
26 /*
27 * Copyright (c) 2012 by Delphix. All rights reserved.
28 * Copyright 2013 Saso Kiselkov. All rights reserved.
29 */
30
31 /* Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */
32 /* All Rights Reserved */
33
34 #ifndef _SYS_DEBUG_H
35 #define _SYS_DEBUG_H
36
37 #include <sys/isa_defs.h>
38 #include <sys/types.h>
39 #include <sys/note.h>
40
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44
45 /*
46 * ASSERT(ex) causes a panic or debugger entry if expression ex is not
47 * true. ASSERT() is included only for debugging, and is a no-op in
48 * production kernels. VERIFY(ex), on the other hand, behaves like
49 * ASSERT and is evaluated on both debug and non-debug kernels.
50 */
51
52 #if defined(__STDC__)
53 extern int assfail(const char *, const char *, int);
54 #define VERIFY(EX) ((void)((EX) || assfail(#EX, __FILE__, __LINE__)))
55 #if DEBUG
56 #define ASSERT(EX) ((void)((EX) || assfail(#EX, __FILE__, __LINE__)))
57 #else
58 #define ASSERT(x) ((void)0)
59 #endif
60 #else /* defined(__STDC__) */
61 extern int assfail();
62 #define VERIFY(EX) ((void)((EX) || assfail("EX", __FILE__, __LINE__)))
63 #if DEBUG
64 #define ASSERT(EX) ((void)((EX) || assfail("EX", __FILE__, __LINE__)))
65 #else
66 #define ASSERT(x) ((void)0)
67 #endif
68 #endif /* defined(__STDC__) */
69
70 /*
71 * Assertion variants sensitive to the compilation data model
72 */
73 #if defined(_LP64)
74 #define ASSERT64(x) ASSERT(x)
75 #define ASSERT32(x)
76 #else
77 #define ASSERT64(x)
78 #define ASSERT32(x) ASSERT(x)
79 #endif
80
81 /*
82 * IMPLY and EQUIV are assertions of the form:
83 *
84 * if (a) then (b)
85 * and
86 * if (a) then (b) *AND* if (b) then (a)
87 */
88 #if DEBUG
89 #define IMPLY(A, B) \
90 ((void)(((!(A)) || (B)) || \
91 assfail("(" #A ") implies (" #B ")", __FILE__, __LINE__)))
92 #define EQUIV(A, B) \
93 ((void)((!!(A) == !!(B)) || \
94 assfail("(" #A ") is equivalent to (" #B ")", __FILE__, __LINE__)))
95 #else
96 #define IMPLY(A, B) ((void)0)
97 #define EQUIV(A, B) ((void)0)
98 #endif
99
100 /*
101 * ASSERT3() behaves like ASSERT() except that it is an explicit conditional,
102 * and prints out the values of the left and right hand expressions as part of
103 * the panic message to ease debugging. The three variants imply the type
104 * of their arguments. ASSERT3S() is for signed data types, ASSERT3U() is
105 * for unsigned, and ASSERT3P() is for pointers. The VERIFY3*() macros
106 * have the same relationship as above.
107 */
108 extern void assfail3(const char *, uintmax_t, const char *, uintmax_t,
109 const char *, int);
110 #define VERIFY3_IMPL(LEFT, OP, RIGHT, TYPE) do { \
111 const TYPE __left = (TYPE)(LEFT); \
112 const TYPE __right = (TYPE)(RIGHT); \
113 if (!(__left OP __right)) \
114 assfail3(#LEFT " " #OP " " #RIGHT, \
115 (uintmax_t)__left, #OP, (uintmax_t)__right, \
116 __FILE__, __LINE__); \
117 _NOTE(CONSTCOND) } while (0)
118
119 #define VERIFY3S(x, y, z) VERIFY3_IMPL(x, y, z, int64_t)
120 #define VERIFY3U(x, y, z) VERIFY3_IMPL(x, y, z, uint64_t)
121 #define VERIFY3P(x, y, z) VERIFY3_IMPL(x, y, z, uintptr_t)
122 #define VERIFY0(x) VERIFY3_IMPL(x, ==, 0, uintmax_t)
123
124 #if DEBUG
125 #define ASSERT3S(x, y, z) VERIFY3_IMPL(x, y, z, int64_t)
126 #define ASSERT3U(x, y, z) VERIFY3_IMPL(x, y, z, uint64_t)
127 #define ASSERT3P(x, y, z) VERIFY3_IMPL(x, y, z, uintptr_t)
128 #define ASSERT0(x) VERIFY3_IMPL(x, ==, 0, uintmax_t)
129 #else
130 #define ASSERT3S(x, y, z) ((void)0)
131 #define ASSERT3U(x, y, z) ((void)0)
132 #define ASSERT3P(x, y, z) ((void)0)
133 #define ASSERT0(x) ((void)0)
134 #endif
135
136 /*
137 * Compile-time assertion. The condition 'x' must be constant.
138 */
139 #define CTASSERT(x) _CTASSERT(x, __LINE__)
140 #define _CTASSERT(x, y) __CTASSERT(x, y)
141 #define __CTASSERT(x, y) \
142 typedef char __compile_time_assertion__ ## y [(x) ? 1 : -1]
143
144 #ifdef _KERNEL
145
146 extern void abort_sequence_enter(char *);
147 extern void debug_enter(char *);
148
149 #endif /* _KERNEL */
150
151 #if defined(DEBUG) && !defined(__sun)
152 /* CSTYLED */
153 #define STATIC
154 #else
155 /* CSTYLED */
156 #define STATIC static
157 #endif
158
159 #ifdef __cplusplus
160 }
161 #endif
162
163 #endif /* _SYS_DEBUG_H */