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, Version 1.0 only 6 * (the "License"). You may not use this file except in compliance 7 * with the License. 8 * 9 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10 * or http://www.opensolaris.org/os/licensing. 11 * See the License for the specific language governing permissions 12 * and limitations under the License. 13 * 14 * When distributing Covered Code, include this CDDL HEADER in each 15 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16 * If applicable, add the following below this CDDL HEADER, with the 17 * fields enclosed by brackets "[]" replaced with your own identifying 18 * information: Portions Copyright [yyyy] [name of copyright owner] 19 * 20 * CDDL HEADER END 21 */ 22 /* 23 * Copyright 2005 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 /* Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */ 28 /* All Rights Reserved */ 29 30 31 #ifndef _SYS_DEBUG_H 32 #define _SYS_DEBUG_H 33 34 #pragma ident "%Z%%M% %I% %E% SMI" 35 36 #include <sys/types.h> 37 38 #ifdef __cplusplus 39 extern "C" { 40 #endif 41 42 /* 43 * ASSERT(ex) causes a panic or debugger entry if expression ex is not 44 * true. ASSERT() is included only for debugging, and is a no-op in 45 * production kernels. VERIFY(ex), on the other hand, behaves like 46 * ASSERT and is evaluated on both debug and non-debug kernels. 47 */ 48 49 #if defined(__STDC__) 50 extern int assfail(const char *, const char *, int); 51 #define VERIFY(EX) ((void)((EX) || assfail(#EX, __FILE__, __LINE__))) 52 #ifdef DEBUG 53 #define ASSERT(EX) VERIFY(EX) 54 #else 55 #define ASSERT(x) ((void)0) 56 #endif 57 #else /* defined(__STDC__) */ 58 extern int assfail(); 59 #define VERIFY(EX) ((void)((EX) || assfail("EX", __FILE__, __LINE__))) 60 #ifdef DEBUG 61 #define ASSERT(EX) VERIFY(EX) 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 * ASSERT3() behaves like ASSERT() except that it is an explicit conditional, 80 * and prints out the values of the left and right hand expressions as part of 81 * the panic message to ease debugging. The three variants imply the type 82 * of their arguments. ASSERT3S() is for signed data types, ASSERT3U() is 83 * for unsigned, and ASSERT3P() is for pointers. The VERIFY3*() macros 84 * have the same relationship as above. 85 */ 86 extern void assfail3(const char *, uintmax_t, const char *, uintmax_t, 87 const char *, int); 88 #define VERIFY3_IMPL(LEFT, OP, RIGHT, TYPE) do { \ 89 const TYPE __left = (TYPE)(LEFT); \ 90 const TYPE __right = (TYPE)(RIGHT); \ 91 if (!(__left OP __right)) \ 92 assfail3(#LEFT " " #OP " " #RIGHT, \ 93 (uintmax_t)__left, #OP, (uintmax_t)__right, \ 94 __FILE__, __LINE__); \ 95 _NOTE(CONSTCOND) } while (0) 96 97 #define VERIFY3S(x, y, z) VERIFY3_IMPL(x, y, z, int64_t) 98 #define VERIFY3U(x, y, z) VERIFY3_IMPL(x, y, z, uint64_t) 99 #define VERIFY3P(x, y, z) VERIFY3_IMPL(x, y, z, uintptr_t) 100 #ifdef DEBUG 101 #define ASSERT3S(x, y, z) VERIFY3S(x, y, z) 102 #define ASSERT3U(x, y, z) VERIFY3U(x, y, z) 103 #define ASSERT3P(x, y, z) VERIFY3P(x, y, z) 104 #else 105 #define ASSERT3S(x, y, z) ((void)0) 106 #define ASSERT3U(x, y, z) ((void)0) 107 #define ASSERT3P(x, y, z) ((void)0) 108 #endif 109 110 #ifdef _KERNEL 111 112 extern void abort_sequence_enter(char *); 113 extern void debug_enter(char *); 114 115 #endif /* _KERNEL */ 116 117 #if defined(DEBUG) && !defined(__sun) 118 /* CSTYLED */ 119 #define STATIC 120 #else 121 /* CSTYLED */ 122 #define STATIC static 123 #endif 124 125 #ifdef __cplusplus 126 } 127 #endif 128 129 #endif /* _SYS_DEBUG_H */ 130