summaryrefslogtreecommitdiff
path: root/common/debug.h
blob: 6106f19e6df3a8e26ede239167191ae1c01b6770 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/*
 * Copyright (c) 2011 Collabora Ltd.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *     * Redistributions of source code must retain the above
 *       copyright notice, this list of conditions and the
 *       following disclaimer.
 *     * 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 names of contributors to this software may not be
 *       used to endorse or promote products derived from this
 *       software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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
 * COPYRIGHT OWNER 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.
 *
 * Author: Stef Walter <stefw@collabora.co.uk>
 */

#ifndef P11_DEBUG_H
#define P11_DEBUG_H

#include "compat.h"

/* Please keep this enum in sync with keys in debug.c */
enum {
	P11_DEBUG_LIB = 1 << 1,
	P11_DEBUG_CONF = 1 << 2,
	P11_DEBUG_URI = 1 << 3,
	P11_DEBUG_PROXY = 1 << 4,
	P11_DEBUG_TRUST = 1 << 5,
	P11_DEBUG_TOOL = 1 << 6,
	P11_DEBUG_RPC = 1 << 7,
};

extern int        p11_debug_current_flags;

void              p11_debug_init                (void);

void              p11_debug_message             (int flag,
                                                 const char *format,
                                                 ...) GNUC_PRINTF (2, 3);

void              p11_debug_precond             (const char *format,
                                                 ...) GNUC_PRINTF (1, 2)
                                                 CLANG_ANALYZER_NORETURN;

#ifndef assert_not_reached
#define assert_not_reached() \
	(assert (false && "this code should not be reached"))
#endif

#define return_val_if_fail(x, v) \
	do { if (!(x)) { \
	     p11_debug_precond ("p11-kit: '%s' not true at %s\n", #x, __func__); \
	     return v; \
	} } while (false)

#define return_if_fail(x) \
	do { if (!(x)) { \
	     p11_debug_precond ("p11-kit: '%s' not true at %s\n", #x, __func__); \
	     return; \
	} } while (false)

#define return_if_reached() \
	do { \
	     p11_debug_precond ("p11-kit: shouldn't be reached at %s\n", __func__); \
	     return; \
	} while (false)

#define return_val_if_reached(v) \
	do { \
	     p11_debug_precond ("p11-kit: shouldn't be reached at %s\n", __func__); \
	     return v; \
	} while (false)

#define warn_if_reached(v) \
	do { \
	     p11_debug_precond ("p11-kit: shouldn't be reached at %s\n", __func__); \
	} while (false)

#define warn_if_fail(x) \
	do { if (!(x)) { \
	     p11_debug_precond ("p11-kit: '%s' not true at %s\n", #x, __func__); \
	} } while (false)

#endif /* DEBUG_H */

/* -----------------------------------------------------------------------------
 * Below this point is outside the DEBUG_H guard - so it can take effect
 * more than once. So you can do:
 *
 * #define P11_DEBUG_FLAG P11_DEBUG_ONE_THING
 * #include "debug.h"
 * ...
 * p11_debug ("if we're debugging one thing");
 * ...
 * #undef P11_DEBUG_FLAG
 * #define P11_DEBUG_FLAG DEBUG_OTHER_THING
 * #include "debug.h"
 * ...
 * p11_debug ("if we're debugging the other thing");
 * ...
 */

#ifdef P11_DEBUG_FLAG
#ifdef WITH_DEBUG

#undef p11_debug
#define p11_debug(format, ...) do { \
	if (P11_DEBUG_FLAG & p11_debug_current_flags) \
		p11_debug_message (P11_DEBUG_FLAG, "%s: " format, __PRETTY_FUNCTION__, ##__VA_ARGS__); \
	} while (0)

#undef p11_debugging
#define p11_debugging \
	(P11_DEBUG_FLAG & p11_debug_current_flags)

#else /* !defined (WITH_DEBUG) */

#undef p11_debug
#define p11_debug(format, ...) \
	do {} while (false)

#undef p11_debugging
#define p11_debugging (0)

#endif /* !defined (WITH_DEBUG) */

#endif /* defined (P11_DEBUG_FLAG) */