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