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