xref: /netbsd-src/external/bsd/openpam/dist/lib/libpam/openpam_debug.h (revision 0d9d0fd8a30be9a1924e715bbcf67a4a83efd262)
1 /*	$NetBSD: openpam_debug.h,v 1.5 2023/06/30 21:46:20 christos Exp $	*/
2 
3 /*-
4  * Copyright (c) 2001-2003 Networks Associates Technology, Inc.
5  * Copyright (c) 2004-2011 Dag-Erling Smørgrav
6  * All rights reserved.
7  *
8  * This software was developed for the FreeBSD Project by ThinkSec AS and
9  * Network Associates Laboratories, the Security Research Division of
10  * Network Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
11  * ("CBOSS"), as part of the DARPA CHATS research program.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  * 3. The name of the author may not be used to endorse or promote
22  *    products derived from this software without specific prior written
23  *    permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  */
37 
38 #ifndef OPENPAM_DEBUG_H_INCLUDED
39 #define OPENPAM_DEBUG_H_INCLUDED
40 
41 #ifdef OPENPAM_DEBUG
42 #define ENTER() openpam_log(PAM_LOG_LIBDEBUG, "entering")
43 #define ENTERI(i) do { \
44 	int i_ = (i); \
45 	if (i_ > 0 && i_ < PAM_NUM_ITEMS) \
46 		openpam_log(PAM_LOG_LIBDEBUG, "entering: %s", pam_item_name[i_]); \
47 	else \
48 		openpam_log(PAM_LOG_LIBDEBUG, "entering: %d", i_); \
49 } while (/*CONSTCOND*/0)
50 #define ENTERN(n) do { \
51 	intmax_t n_ = (n); \
52 	openpam_log(PAM_LOG_LIBDEBUG, "entering: %jd", n_); \
53 } while (/*CONSTCOND*/0)
54 #define ENTERS(s) do { \
55 	const char *s_ = (s); \
56 	if (s_ == NULL) \
57 		openpam_log(PAM_LOG_LIBDEBUG, "entering: NULL"); \
58 	else \
59 		openpam_log(PAM_LOG_LIBDEBUG, "entering: '%s'", s_); \
60 } while (/*CONSTCOND*/0)
61 #define ENTERF(f) do { \
62 	int f_ = (f); \
63 	if (f_ >= 0 && f_ <= OPENPAM_NUM_FEATURES) \
64 		openpam_log(PAM_LOG_LIBDEBUG, "entering: %s", \
65 		    openpam_features[f_].name); \
66 	else \
67 		openpam_log(PAM_LOG_LIBDEBUG, "entering: %d", f_); \
68 } while (/*CONSTCOND*/0)
69 #define	RETURNV() openpam_log(PAM_LOG_LIBDEBUG, "returning")
70 #define RETURNC(c) do { \
71 	int c_ = (c); \
72 	if (c_ >= 0 && c_ < PAM_NUM_ERRORS) \
73 		openpam_log(PAM_LOG_LIBDEBUG, "returning %s", pam_err_name[c_]); \
74 	else \
75 		openpam_log(PAM_LOG_LIBDEBUG, "returning %d!", c_); \
76 	return (c_); \
77 } while (/*CONSTCOND*/0)/*NOTREACHED*/
78 #define	RETURNN(n) do { \
79 	int n_ = (n); \
80 	openpam_log(PAM_LOG_LIBDEBUG, "returning %d", n_); \
81 	return (n_); \
82 } while (/*CONSTCOND*/0)/*NOTREACHED*/
83 #define	RETURNP(p) do { \
84 	void *p_ = (p); \
85 	if (p_ == NULL) \
86 		openpam_log(PAM_LOG_LIBDEBUG, "returning NULL"); \
87 	else \
88 		openpam_log(PAM_LOG_LIBDEBUG, "returning %p", p_); \
89 	return (p_); \
90 } while (/*CONSTCOND*/0)/*NOTREACHED*/
91 #define	RETURNS(s) do { \
92 	const char *s_ = (s); \
93 	if (s_ == NULL) \
94 		openpam_log(PAM_LOG_LIBDEBUG, "returning NULL"); \
95 	else \
96 		openpam_log(PAM_LOG_LIBDEBUG, "returning '%s'", s_); \
97 	return (s_); \
98 } while (/*CONSTCOND*/0)/*NOTREACHED*/
99 #else
100 #define ENTER()
101 #define ENTERI(i)
102 #define ENTERN(n)
103 #define ENTERS(s)
104 #define ENTERF(f)
105 #define RETURNV() return
106 #define RETURNC(c) return (c)
107 #define RETURNN(n) return (n)
108 #define RETURNP(p) return (p)
109 #define RETURNS(s) return (s)
110 #endif
111 
112 #endif
113