clixon/lib/clixon/clixon_debug.h
2024-01-11 17:29:37 +01:00

128 lines
4.3 KiB
C

/*
*
***** BEGIN LICENSE BLOCK *****
Copyright (C) 2009-2016 Olof Hagsand and Benny Holmgren
Copyright (C) 2017-2019 Olof Hagsand
Copyright (C) 2020-2022 Olof Hagsand and Rubicon Communications, LLC (Netgate)
This file is part of CLIXON.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Alternatively, the contents of this file may be used under the terms of
the GNU General Public License Version 3 or later (the "GPL"),
in which case the provisions of the GPL are applicable instead
of those above. If you wish to allow use of your version of this file only
under the terms of the GPL, and not to allow others to
use your version of this file under the terms of Apache License version 2,
indicate your decision by deleting the provisions above and replace them with
the notice and other provisions required by the GPL. If you do not delete
the provisions above, a recipient may use your version of this file under
the terms of any one of the Apache License version 2 or the GPL.
***** END LICENSE BLOCK *****
*
* Clixon debugging
*/
#ifndef _CLIXON_DEBUG_H_
#define _CLIXON_DEBUG_H_
#include "clixon_xml.h" /* for cxobj */
/*
* Constants
*/
/* Detail level */
#define CLIXON_DBG_ALWAYS 0x0 /* Unconditionally logged */
#define CLIXON_DBG_DETAIL 0x1 /* Details: traces, parse trees, etc */
#define CLIXON_DBG_DETAIL2 0x2 /* Extra details */
#define CLIXON_DBG_DETAIL3 0x3 /* Probably more detail than you want */
#define CLIXON_DBG_DMASK 0x3 /* Detail mask */
/* Subject area */
#define CLIXON_DBG_DEFAULT 0x04 /* Default logs */
#define CLIXON_DBG_MSG 0x08 /* In/out messages and datastore reads */
#define CLIXON_DBG_XML 0x10 /* XML processing */
#define CLIXON_DBG_XPATH 0x20 /* XPath processing */
#define CLIXON_DBG_YANG 0x40 /* YANG processing */
#define CLIXON_DBG_CLIENT 0x80 /* App-specific */
#define CLIXON_DBG_SMASK ~0x03 /* Subject mask */
/*
* Macros
*/
#if defined(__GNUC__)
#define clixon_debug(l, _fmt, args...) \
do { \
_Pragma("GCC diagnostic push") \
_Pragma("GCC diagnostic ignored \"-Wformat-zero-length\"") \
clixon_debug_fn(NULL, __FUNCTION__, __LINE__, (l), NULL, _fmt, ##args); \
_Pragma("GCC diagnostic pop") \
} while (0)
#define clixon_debug_xml(l, x, _fmt, args...) \
do { \
_Pragma("GCC diagnostic push") \
_Pragma("GCC diagnostic ignored \"-Wformat-zero-length\"") \
clixon_debug_fn(NULL, __FUNCTION__, __LINE__, (l), (x), _fmt, ##args); \
_Pragma("GCC diagnostic pop") \
} while (0)
#elif defined(__clang__)
#define clixon_debug(l, _fmt, args...) \
do { \
_Pragma("clang diagnostic push") \
_Pragma("clangGCC diagnostic ignored \"-Wformat-zero-length\"") \
clixon_debug_fn(NULL, __FUNCTION__, __LINE__, (l), NULL, _fmt, ##args); \
_Pragma("clangGCC diagnostic pop") \
} while (0)
#define clixon_debug_xml(l, x, _fmt, args...) \
do { \
_Pragma("clangGCC diagnostic push") \
_Pragma("clangGCC diagnostic ignored \"-Wformat-zero-length\"") \
clixon_debug_fn(NULL, __FUNCTION__, __LINE__, (l), (x), _fmt, ##args); \
_Pragma("clangGCC diagnostic pop") \
} while (0)
#else
#define clixon_debug(l, _fmt, args...) \
clixon_debug_fn(NULL, __FUNCTION__, __LINE__, (l), NULL, _fmt, ##args)
#define clixon_debug_xml(l, x, _fmt, args...) \
clixon_debug_fn(NULL, __FUNCTION__, __LINE__, (l), (x), _fmt, ##args)
#endif
/*
* Prototypes
*/
int clixon_debug_init(clixon_handle h, int dbglevel);
int clixon_debug_get(void);
int clixon_debug_fn(clixon_handle h, const char *fn, const int line, int dbglevel, cxobj *x, const char *format, ...) __attribute__ ((format (printf, 6, 7)));
static inline int clixon_debug_isset(unsigned n)
{
unsigned level = clixon_debug_get();
unsigned detail = (n & CLIXON_DBG_DMASK);
unsigned subject = (n & CLIXON_DBG_SMASK);
/* not this subject */
if ((level & subject) == 0)
return 0;
return ((level & CLIXON_DBG_DMASK) >= detail);
}
#endif /* _CLIXON_DEBUG_H_ */