core/hfs_dbg.h

   1 /*
   2  * Copyright (c) 2000, 2005 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28
  29 #ifndef HFS_DBG_H_
  30 #define HFS_DBG_H_
  31
  32 #include <sys/cdefs.h>
  33
  34 __BEGIN_DECLS
  35
  36 #include <stdbool.h>
  37
  38 // So that the analyzer acknowledges assertions...
  39 #if defined(__clang_analyzer__) || DEBUG
  40 #define panic_on_assert true
  41 #else
  42 extern bool panic_on_assert;
  43 #endif
  44
  45 #if DEBUG
  46 extern bool hfs_corruption_panics;
  47 #else
  48 #define hfs_corruption_panics false
  49 #endif
  50
  51 __attribute__((noreturn))
  52 void hfs_assert_fail(const char *file, unsigned line, const char *expr);
  53
  54 #define hfs_assert(expr)                                                                                \
  55         do {                                                                                                            \
  56                 if (__builtin_expect(panic_on_assert, false)                    \
  57                         && __builtin_expect(!(expr), false)) {                          \
  58                         hfs_assert_fail(__FILE__, __LINE__, #expr);                     \
  59                 }                                                                                                               \
  60         } while (0)
  61
  62 // On production, will printf rather than assert
  63 #define hfs_warn(format, ...)                                                                   \
  64         do {                                                                                                            \
  65                 if (__builtin_expect(panic_on_assert, false)) {                 \
  66                         panic(format, ## __VA_ARGS__);                                          \
  67                         __builtin_unreachable();                                                        \
  68                 } else                                                                                                  \
  69                         printf(format, ## __VA_ARGS__);                                         \
  70         } while (0)
  71
  72 // Quiet on production
  73 #define hfs_debug(format, ...)                                                                  \
  74         do {                                                                                                            \
  75                 if (__builtin_expect(panic_on_assert, false))                   \
  76                         printf(format, ## __VA_ARGS__);                                         \
  77         } while (0)
  78
  79 // Panic on debug unless boot-arg tells us not to
  80 #define hfs_corruption_debug(format, ...)                                               \
  81         do {                                                                                                            \
  82                 if (__builtin_expect(hfs_corruption_panics, false)) {   \
  83                         panic(format, ## __VA_ARGS__);                                          \
  84                         __builtin_unreachable();                                                        \
  85                 }                                                                                                               \
  86                 else                                                                                                    \
  87                         printf(format, ## __VA_ARGS__);                                         \
  88         } while (0)
  89
  90 __END_DECLS
  91
  92 #endif // HFS_DBG_H_