mirror of
https://github.com/servalproject/serval-dna.git
synced 2024-12-19 21:27:57 +00:00
92fa6c196a
Rename the logging primitive functions and utility functions, prefixing all with 'serval_log', eg: logMessage() -> serval_logf() etc. Add an XPRINTF xhexdump() function and use it to implement the serval_log_hexdump() utility, renamed from dump(). Add macros WHY_dump(), WARN_dump(), HINT_dump() and DEBUG_dump(), and use them everywhere. Remove the 'log.console.dump_config' and 'log.file.dump_config' configuration options; configuration is now dumped in every log prolog. The logging system now constructs the log prolog by invoking the new 'log_prolog' trigger, so that it no longer depends on the version string and configuration system. Any system that wants to present a message in the log prolog can define its own trigger, which calls standard log primitives to print the message. Split the logging system into a front-end (log.c) that provides the logging primitives and is independent of the configuration system, and a set of back-end "outputters" (log_output_console.c, log_output_file.c, log_output_android.c) that may depend on the configuration system and are decoupled from the front-end using the 'logoutput' link section. These log outputters are explicitly linked into executables by the Makefile rules, but could also be linked in using USE_FEATURE(). The USE_FEATURE() calls have _not_ been added to servald_features.c, so that different daemon executables can be built with the same feature set but different log outputs.
72 lines
3.2 KiB
C
72 lines
3.2 KiB
C
/*
|
|
Copyright (C) 2015 Serval Project Inc.
|
|
|
|
This program 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 program 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 this program; if not, write to the Free Software
|
|
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef __SERVAL_DNA__DEBUG_H
|
|
#define __SERVAL_DNA__DEBUG_H
|
|
|
|
#include "serval_types.h" // for bool_t
|
|
#include "log.h"
|
|
|
|
/* These DEBUG macros use the IF_DEBUG(FLAG) macro as the conditional.
|
|
*
|
|
* The compilation environment may define IF_DEBUG(FLAG) to be constant (0) to
|
|
* disable all debug statements, which should omit them from the compilation
|
|
* altogether if the compiler is optimising properly.
|
|
*
|
|
* Alternatively, the compilation environment may define IF_DEBUG(FLAG) to be
|
|
* constant (1) to enable all debug statements unconditionally, which will
|
|
* produce a large and verbose executable.
|
|
*
|
|
* The common definition of IF_DEBUG(FLAG) will use FLAG to index into a local
|
|
* struct of debug flags; see "conf.h".
|
|
*/
|
|
|
|
#define DEBUGF(FLAG,F,...) do { if (IF_DEBUG(FLAG)) _DEBUGF_TAG(#FLAG, F, ##__VA_ARGS__); } while (0)
|
|
#define DEBUGF2(FLAG1,FLAG2,F,...) do { if (IF_DEBUG(FLAG1) || IF_DEBUG(FLAG2)) _DEBUGF_TAG((IF_DEBUG(FLAG1) ? #FLAG1 : #FLAG2), F, ##__VA_ARGS__); } while (0)
|
|
#define DEBUG(FLAG,X) DEBUGF(FLAG, "%s", (X))
|
|
#define DEBUGF_perror(FLAG,F,...) do { if (IF_DEBUG(FLAG)) _DEBUGF_TAG_perror(#FLAG, F, ##__VA_ARGS__); } while (0)
|
|
#define DEBUG_perror(FLAG,X) DEBUGF_perror(FLAG, "%s", (X))
|
|
#define DEBUG_argv(FLAG,X,ARGC,ARGV) do { if (IF_DEBUG(FLAG)) _DEBUG_TAG_argv(#FLAG, X, (ARGC), (ARGV)); } while (0)
|
|
#define DEBUG_dump(FLAG,X,ADDR,LEN) do { if (IF_DEBUG(FLAG)) _DEBUG_TAG_dump(#FLAG, X, (ADDR), (LEN)); } while (0)
|
|
|
|
#define D(FLAG) DEBUG(FLAG, "D")
|
|
#define T DEBUG(trace, "T")
|
|
|
|
/* These IDEBUG macros use the IF_IDEBUG(IND) macro as the conditional.
|
|
*
|
|
* An "indirect debug flag" is a struct that contains a pointer to a flag and a
|
|
* string constant with the name of the flag.
|
|
*/
|
|
|
|
struct idebug {
|
|
bool_t *flagp;
|
|
const char *flagname;
|
|
};
|
|
|
|
#define INDIRECT_CONFIG_DEBUG(FLAG) ((struct idebug){.flagp=&(config.debug.FLAG), .flagname=#FLAG})
|
|
|
|
#define IF_IDEBUG(IND) ((IND).flagp && *(IND).flagp)
|
|
#define IDEBUG_TAG(IND) ((IND).flagname ? (IND).flagname : "")
|
|
|
|
#define IDEBUGF(IND,F,...) do { if (IF_IDEBUG(IND)) _DEBUGF_TAG(IDEBUG_TAG(IND), F, ##__VA_ARGS__); } while (0)
|
|
#define IDEBUG(IND,X) IDEBUGF(IND, "%s", (X))
|
|
#define IDEBUGF_perror(IND,F,...) do { if (IF_IDEBUG(IND)) _DEBUGF_TAG_perror(IDEBUG_TAG(IND), F, ##__VA_ARGS__); } while (0)
|
|
#define IDEBUG_perror(IND,X) IDEBUGF_perror(IND, "%s", (X))
|
|
|
|
#endif // __SERVAL_DNA__DEBUG_H
|