ExternalVendorCode/serval-dna
1
0
Fork 0
mirror of https://github.com/servalproject/serval-dna.git synced 2024-12-18 20:57:56 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
029adc177f
serval-dna/debug.h

74 lines
3.4 KiB
C
Raw Normal View History

Move DEBUGF() from "log.h" to "debug.h" Include "debug.h" in lots of places (not all) New macro IDEBUGF() for indirect debug flag, used in HTTP server
2015-07-13 08:53:36 +00:00
/*
Copyright (C) 2015 Serval Project Inc.
Fix header files for Xcode iOS build - make "debug.h" a private header so that the DEBUG() macro does not interfere with Xcode Debug builds, which set DEBUG=1 - move all #include "debug.h" from headers into .c files - move 'struct idebug' into a new public header "idebug.h" so that "log.h" can be public - move HTTPD port number defs from "httpd.h" to "constants.h", so that "httpd.h" can be private and "conf.h" can be public - add missing nested includes so each header compiles stand-alone without error - #include "sodium.h" instead of <sodium.h> - #include "sqlite3.h" instead of <sqlite3.h> - add header guard to "fifo.h" - fix header guard in "sync_keys.h"
2017-11-24 00:03:39 +00:00
Copyright (C) 2017 Flinders University
Move DEBUGF() from "log.h" to "debug.h" Include "debug.h" in lots of places (not all) New macro IDEBUGF() for indirect debug flag, used in HTTP server
2015-07-13 08:53:36 +00:00
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
Fix header files for Xcode iOS build - make "debug.h" a private header so that the DEBUG() macro does not interfere with Xcode Debug builds, which set DEBUG=1 - move all #include "debug.h" from headers into .c files - move 'struct idebug' into a new public header "idebug.h" so that "log.h" can be public - move HTTPD port number defs from "httpd.h" to "constants.h", so that "httpd.h" can be private and "conf.h" can be public - add missing nested includes so each header compiles stand-alone without error - #include "sodium.h" instead of <sodium.h> - #include "sqlite3.h" instead of <sqlite3.h> - add header guard to "fifo.h" - fix header guard in "sync_keys.h"
2017-11-24 00:03:39 +00:00
/* This header file must not be included by other header files (.h), only by
* source files (.c), because it defines macros (DEBUG being the primary
* offender) that can interfere with other projects that include Serval DNA
* header files, such as the iOS ServalDNA.framework.
*/
#include "log.h" // for _DEBUGF_TAG
#include "idebug.h" // for struct idebug
Move DEBUGF() from "log.h" to "debug.h" Include "debug.h" in lots of places (not all) New macro IDEBUGF() for indirect debug flag, used in HTTP server
2015-07-13 08:53:36 +00:00
/* 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))
Rewrite logging system 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.
2017-11-29 13:34:54 +00:00
#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)
Move DEBUGF() from "log.h" to "debug.h" Include "debug.h" in lots of places (not all) New macro IDEBUGF() for indirect debug flag, used in HTTP server
2015-07-13 08:53:36 +00:00
Add API for msp from within the daemon
2016-03-16 00:01:09 +00:00
#define D(FLAG) DEBUG(FLAG, "D")
#define T DEBUG(trace, "T")
Move DEBUGF() from "log.h" to "debug.h" Include "debug.h" in lots of places (not all) New macro IDEBUGF() for indirect debug flag, used in HTTP server
2015-07-13 08:53:36 +00:00
/* 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.
*/
#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
Reference in New Issue Copy Permalink