usr/src/uts/common/sys/debug.h

   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 #if DEBUG
  51 #define ASSERT(EX) ((void)((EX) || assfail(#EX, __FILE__, __LINE__)))
  52 #else
  53 #define ASSERT(x)  ((void)0)
  54 #endif
  55 #else   /* defined(__STDC__) */
  56 extern int assfail();
  57 #define VERIFY(EX) ((void)((EX) || assfail("EX", __FILE__, __LINE__)))
  58 #if DEBUG
  59 #define ASSERT(EX) ((void)((EX) || assfail("EX", __FILE__, __LINE__)))
  60 #else
  61 #define ASSERT(x)  ((void)0)
  62 #endif
  63 #endif  /* defined(__STDC__) */
  64
  65 /*
  66  * Assertion variants sensitive to the compilation data model
  67  */
  68 #if defined(_LP64)
  69 #define ASSERT64(x)     ASSERT(x)
  70 #define ASSERT32(x)
  71 #else
  72 #define ASSERT64(x)
  73 #define ASSERT32(x)     ASSERT(x)
  74 #endif
  75
  76 /*
  77  * IMPLY and EQUIV are assertions of the form:
  78  *
  79  *      if (a) then (b)
  80  * and
  81  *      if (a) then (b) *AND* if (b) then (a)
  82  */
  83 #if DEBUG
  84 #define IMPLY(A, B) \
  85         ((void)(((!(A)) || (B)) || \
  86             assfail("(" #A ") implies (" #B ")", __FILE__, __LINE__)))
  87 #define EQUIV(A, B) \
  88         ((void)((!!(A) == !!(B)) || \
  89             assfail("(" #A ") is equivalent to (" #B ")", __FILE__, __LINE__)))
  90 #else
  91 #define IMPLY(A, B) ((void)0)
  92 #define EQUIV(A, B) ((void)0)
  93 #endif
  94
  95 /*
  96  * ASSERT3() behaves like ASSERT() except that it is an explicit conditional,
  97  * and prints out the values of the left and right hand expressions as part of
  98  * the panic message to ease debugging.  The three variants imply the type
  99  * of their arguments.  ASSERT3S() is for signed data types, ASSERT3U() is
 100  * for unsigned, and ASSERT3P() is for pointers.  The VERIFY3*() macros
 101  * have the same relationship as above.
 102  */
 103 extern void assfail3(const char *, uintmax_t, const char *, uintmax_t,
 104     const char *, int);
 105 #define VERIFY3_IMPL(LEFT, OP, RIGHT, TYPE) do { \
 106         const TYPE __left = (TYPE)(LEFT); \
 107         const TYPE __right = (TYPE)(RIGHT); \
 108         if (!(__left OP __right)) \
 109                 assfail3(#LEFT " " #OP " " #RIGHT, \
 110                         (uintmax_t)__left, #OP, (uintmax_t)__right, \
 111                         __FILE__, __LINE__); \
 112 _NOTE(CONSTCOND) } while (0)
 113
 114 #define VERIFY3S(x, y, z)       VERIFY3_IMPL(x, y, z, int64_t)
 115 #define VERIFY3U(x, y, z)       VERIFY3_IMPL(x, y, z, uint64_t)
 116 #define VERIFY3P(x, y, z)       VERIFY3_IMPL(x, y, z, uintptr_t)
 117 #if DEBUG
 118 #define ASSERT3S(x, y, z)       VERIFY3_IMPL(x, y, z, int64_t)
 119 #define ASSERT3U(x, y, z)       VERIFY3_IMPL(x, y, z, uint64_t)
 120 #define ASSERT3P(x, y, z)       VERIFY3_IMPL(x, y, z, uintptr_t)
 121 #else
 122 #define ASSERT3S(x, y, z)       ((void)0)
 123 #define ASSERT3U(x, y, z)       ((void)0)
 124 #define ASSERT3P(x, y, z)       ((void)0)
 125 #endif
 126
 127 #ifdef  _KERNEL
 128
 129 extern void abort_sequence_enter(char *);
 130 extern void debug_enter(char *);
 131
 132 #endif  /* _KERNEL */
 133
 134 #if defined(DEBUG) && !defined(__sun)
 135 /* CSTYLED */
 136 #define STATIC
 137 #else
 138 /* CSTYLED */
 139 #define STATIC static
 140 #endif
 141
 142 #ifdef  __cplusplus
 143 }
 144 #endif
 145
 146 #endif  /* _SYS_DEBUG_H */