forked from openzfs/zfs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add custom debug printing for your asserts
I kept hackily expanding macros into if (condition) print custom info. So other people would probably find it useful too. Signed-off-by: Rich Ercolani <[email protected]>
- Loading branch information
1 parent
a0d3fe7
commit 87cdaae
Showing
4 changed files
with
360 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,24 +1,29 @@ | ||
| /* | ||
| * Copyright (C) 2007-2010 Lawrence Livermore National Security, LLC. | ||
| * Copyright (C) 2007 The Regents of the University of California. | ||
| * Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER). | ||
| * Written by Brian Behlendorf <[email protected]>. | ||
| * UCRL-CODE-235197 | ||
| * Copyright (c) 2020 iXsystems, Inc. | ||
| * All rights reserved. | ||
| * | ||
| * This file is part of the SPL, Solaris Porting Layer. | ||
| * Redistribution and use in source and binary forms, with or without | ||
| * modification, are permitted provided that the following conditions | ||
| * are met: | ||
| * 1. Redistributions of source code must retain the above copyright | ||
| * notice, this list of conditions and the following disclaimer. | ||
| * 2. Redistributions in binary form must reproduce the above copyright | ||
| * notice, this list of conditions and the following disclaimer in the | ||
| * documentation and/or other materials provided with the distribution. | ||
| * | ||
| * The SPL is free software; you can redistribute it and/or modify it | ||
| * under the terms of the GNU General Public License as published by the | ||
| * Free Software Foundation; either version 2 of the License, or (at your | ||
| * option) any later version. | ||
| * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND | ||
| * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
| * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE | ||
| * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
| * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | ||
| * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
| * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||
| * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||
| * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||
| * SUCH DAMAGE. | ||
| * | ||
| * The SPL is distributed in the hope that it will be useful, but WITHOUT | ||
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | ||
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | ||
| * for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License along | ||
| * with the SPL. If not, see <http://www.gnu.org/licenses/>. | ||
| * $FreeBSD$ | ||
| */ | ||
|
|
||
| /* | ||
|
|
@@ -47,6 +52,7 @@ | |
| #ifndef _SPL_DEBUG_H | ||
| #define _SPL_DEBUG_H | ||
|
|
||
|
|
||
| /* | ||
| * Common DEBUG functionality. | ||
| */ | ||
|
|
@@ -80,6 +86,14 @@ spl_assert(const char *buf, const char *file, const char *func, int line) | |
| return (0); | ||
| } | ||
|
|
||
| #ifndef expect | ||
| #define expect(expr, value) (__builtin_expect((expr), (value))) | ||
| #endif | ||
| #ifndef __linux__ | ||
| #define likely(expr) expect((expr) != 0, 1) | ||
| #define unlikely(expr) expect((expr) != 0, 0) | ||
| #endif | ||
|
|
||
| #define PANIC(fmt, a...) \ | ||
| spl_panic(__FILE__, __FUNCTION__, __LINE__, fmt, ## a) | ||
|
|
||
|
|
@@ -88,6 +102,12 @@ spl_assert(const char *buf, const char *file, const char *func, int line) | |
| spl_assert("VERIFY(" #cond ") failed\n", \ | ||
| __FILE__, __FUNCTION__, __LINE__)) | ||
|
|
||
| #define VERIFYF(cond, str, ...) do { \ | ||
| if (unlikely(!cond)) \ | ||
| spl_panic(__FILE__, __FUNCTION__, __LINE__, \ | ||
| "VERIFY(" #cond ") failed " str "\n", __VA_ARGS__);\ | ||
| } while (0) | ||
|
|
||
| #define VERIFY3B(LEFT, OP, RIGHT) do { \ | ||
| const boolean_t _verify3_left = (boolean_t)(LEFT); \ | ||
| const boolean_t _verify3_right = (boolean_t)(RIGHT); \ | ||
|
|
@@ -150,6 +170,84 @@ spl_assert(const char *buf, const char *file, const char *func, int line) | |
| (void *)_verify0_right); \ | ||
| } while (0) | ||
|
|
||
| /* | ||
| * Note that you should not put any operations you want to always happen | ||
| * in the print section for ASSERTs unless you only want them to run on | ||
| * debug builds! | ||
| * e.g. ASSERT3UF(2, <, 3, "%s", foo(x)), foo(x) won't run on non-debug | ||
| * builds. | ||
| */ | ||
|
|
||
| #define VERIFY3BF(LEFT, OP, RIGHT, STR, ...) do { \ | ||
| const boolean_t _verify3_left = (boolean_t)(LEFT); \ | ||
| const boolean_t _verify3_right = (boolean_t)(RIGHT); \ | ||
| if (unlikely(!(_verify3_left OP _verify3_right))) \ | ||
| spl_panic(__FILE__, __FUNCTION__, __LINE__, \ | ||
| "VERIFY3(" #LEFT " " #OP " " #RIGHT ") " \ | ||
| "failed (%d " #OP " %d) " STR "\n", \ | ||
| (boolean_t)(_verify3_left), \ | ||
| (boolean_t)(_verify3_right), \ | ||
| __VA_ARGS__); \ | ||
| } while (0) | ||
|
|
||
| #define VERIFY3SF(LEFT, OP, RIGHT, STR, ...) do { \ | ||
| const int64_t _verify3_left = (int64_t)(LEFT); \ | ||
| const int64_t _verify3_right = (int64_t)(RIGHT); \ | ||
| if (unlikely(!(_verify3_left OP _verify3_right))) \ | ||
| spl_panic(__FILE__, __FUNCTION__, __LINE__, \ | ||
| "VERIFY3(" #LEFT " " #OP " " #RIGHT ") " \ | ||
| "failed (%lld " #OP " %lld) " STR "\n", \ | ||
| (long long)(_verify3_left), \ | ||
| (long long)(_verify3_right), \ | ||
| __VA_ARGS); \ | ||
| } while (0) | ||
|
|
||
| #define VERIFY3UF(LEFT, OP, RIGHT, STR, ...) do { \ | ||
| const uint64_t _verify3_left = (uint64_t)(LEFT); \ | ||
| const uint64_t _verify3_right = (uint64_t)(RIGHT); \ | ||
| if (unlikely(!(_verify3_left OP _verify3_right))) \ | ||
| spl_panic(__FILE__, __FUNCTION__, __LINE__, \ | ||
| "VERIFY3(" #LEFT " " #OP " " #RIGHT ") " \ | ||
| "failed (%llu " #OP " %llu) " STR "\n", \ | ||
| (unsigned long long)(_verify3_left), \ | ||
| (unsigned long long)(_verify3_right), \ | ||
| __VA_ARGS); \ | ||
| } while (0) | ||
|
|
||
| #define VERIFY3PF(LEFT, OP, RIGHT, STR, ...) do { \ | ||
| const uintptr_t _verify3_left = (uintptr_t)(LEFT); \ | ||
| const uintptr_t _verify3_right = (uintptr_t)(RIGHT); \ | ||
| if (unlikely(!(_verify3_left OP _verify3_right))) \ | ||
| spl_panic(__FILE__, __FUNCTION__, __LINE__, \ | ||
| "VERIFY3(" #LEFT " " #OP " " #RIGHT ") " \ | ||
| "failed (%px " #OP " %px) " STR "\n", \ | ||
| (void *) (_verify3_left), \ | ||
| (void *) (_verify3_right), \ | ||
| __VA_ARGS__); \ | ||
| } while (0) | ||
|
|
||
| #define VERIFY0PF(RIGHT, STR, ...) do { \ | ||
| const uintptr_t _verify3_left = (uintptr_t)(0); \ | ||
| const uintptr_t _verify3_right = (uintptr_t)(RIGHT); \ | ||
| if (unlikely(!(_verify3_left == _verify3_right))) \ | ||
| spl_panic(__FILE__, __FUNCTION__, __LINE__, \ | ||
| "VERIFY0(0 == " #RIGHT ") " \ | ||
| "failed (0 == %px) " STR "\n", \ | ||
| (long long) (_verify3_right), \ | ||
| __VA_ARGS__); \ | ||
| } while (0) | ||
|
|
||
| #define VERIFY0F(RIGHT, STR, ...) do { \ | ||
| const int64_t _verify3_left = (int64_t)(0); \ | ||
| const int64_t _verify3_right = (int64_t)(RIGHT); \ | ||
| if (unlikely(!(_verify3_left == _verify3_right))) \ | ||
| spl_panic(__FILE__, __FUNCTION__, __LINE__, \ | ||
| "VERIFY0(0 == " #RIGHT ") " \ | ||
| "failed (0 == %lld) " STR "\n", \ | ||
| (long long) (_verify3_right), \ | ||
| __VA_ARGS__); \ | ||
| } while (0) | ||
|
|
||
| #define VERIFY_IMPLY(A, B) \ | ||
| ((void)(likely((!(A)) || (B)) || \ | ||
| spl_assert("(" #A ") implies (" #B ")", \ | ||
|
|
@@ -176,6 +274,13 @@ spl_assert(const char *buf, const char *file, const char *func, int line) | |
| ((void) sizeof ((uintptr_t)(x)), (void) sizeof ((uintptr_t)(z))) | ||
| #define ASSERT0(x) ((void) sizeof ((uintptr_t)(x))) | ||
| #define ASSERT0P(x) ((void) sizeof ((uintptr_t)(x))) | ||
| #define ASSERT3BF(x, y, z, str, ...) ASSERT3B(x, y, z) | ||
| #define ASSERT3SF(x, y, z, str, ...) ASSERT3S(x, y, z) | ||
| #define ASSERT3UF(x, y, z, str, ...) ASSERT3U(x, y, z) | ||
| #define ASSERT3PF(x, y, z, str, ...) ASSERT3P(x, y, z) | ||
| #define ASSERT0PF(x, str, ...) ASSERT0P(x) | ||
| #define ASSERT0F(x, str, ...) ASSERT0(x) | ||
| #define ASSERTF(x, str, ...) ASSERT(x) | ||
| #define IMPLY(A, B) \ | ||
| ((void) sizeof ((uintptr_t)(A)), (void) sizeof ((uintptr_t)(B))) | ||
| #define EQUIV(A, B) \ | ||
|
|
@@ -192,6 +297,13 @@ spl_assert(const char *buf, const char *file, const char *func, int line) | |
| #define ASSERT3P VERIFY3P | ||
| #define ASSERT0 VERIFY0 | ||
| #define ASSERT0P VERIFY0P | ||
| #define ASSERT3BF VERIFY3BF | ||
| #define ASSERT3SF VERIFY3SF | ||
| #define ASSERT3UF VERIFY3UF | ||
| #define ASSERT3PF VERIFY3PF | ||
| #define ASSERT0PF VERIFY0PF | ||
| #define ASSERT0F VERIFY0F | ||
| #define ASSERTF VERIFYF | ||
| #define ASSERT VERIFY | ||
| #define IMPLY VERIFY_IMPLY | ||
| #define EQUIV VERIFY_EQUIV | ||
|
|
||
Oops, something went wrong.