serval-dna/xprintf.c
Andrew Bettison 92fa6c196a 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.
2018-03-06 15:16:56 +10:30

132 lines
3.4 KiB
C

/*
Serval extensible printf.
Copyright (C) 2012 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.
*/
#include <stdio.h>
#include <stdlib.h>
#include "strbuf.h"
#include "xprintf.h"
/* Primitives.
*/
void xprintf(XPRINTF xfp, const char *fmt, ...)
{
va_list ap;
va_start(ap, fmt);
vxprintf(xfp, fmt, ap);
va_end(ap);
}
void vxprintf(XPRINTF xfp, const char *fmt, va_list ap)
{
(*xfp.func)(xfp.context, fmt, ap);
}
void xputs(const char *str, XPRINTF xpf)
{
xprintf(xpf, "%s", str);
}
void xputc(char c, XPRINTF xpf)
{
xprintf(xpf, "%c", c);
}
size_t xhexdump_line(XPRINTF xpf, const unsigned char *addr, const size_t len, const size_t off)
{
xprintf(xpf, "%04zx :", off);
size_t i;
for (i = 0; i < 16 && off + i < len; i++)
xprintf(xpf, " %02x", addr[off + i]);
for (; i < 16; i++)
xputs(" ", xpf);
xputs(" ", xpf);
for (i = 0; i < 16 && off + i < len; ++i) {
unsigned char c = addr[off + i];
xprintf(xpf, "%c", c >= ' ' && c < 0x7f ? c : '.');
}
return i;
}
void xhexdump(XPRINTF xpf, const unsigned char *addr, const size_t len, const char *line_prefix)
{
size_t off = 0;
while (off < len) {
xputs(line_prefix, xpf);
size_t skip = xhexdump_line(xpf, addr, len, off);
off += skip;
addr += skip;
xputc('\n', xpf);
}
}
/* Implementations for various destinations.
*/
void _cx_vprintf_stdio(void *context, const char *fmt, va_list ap)
{
vfprintf((FILE *)context, fmt, ap);
}
static void grow_mallocbuf(struct mallocbuf *mb, size_t extra)
{
size_t newsize = mb->size + extra;
// Round up to nearest multiple of 1024.
newsize = newsize + 1024 - ((newsize - 1) % 1024 + 1);
char *newbuf = realloc(mb->buffer, newsize);
if (newbuf) {
mb->current += newbuf - mb->buffer;
mb->size = newsize;
mb->buffer = newbuf;
}
}
void _cx_vprintf_mallocbuf(void *context, const char *fmt, va_list ap)
{
struct mallocbuf *mb = (struct mallocbuf *) context;
if (mb->buffer == NULL)
grow_mallocbuf(mb, 1024);
if (mb->current) {
if (mb->current + 1 >= mb->buffer + mb->size)
grow_mallocbuf(mb, 1024);
int n = vsnprintf(mb->current, mb->buffer + mb->size - mb->current, fmt, ap);
char *newcurrent = mb->current + n;
char *end = mb->buffer + mb->size;
if (newcurrent < end)
mb->current = newcurrent;
else {
grow_mallocbuf(mb, newcurrent - end + 1);
n = vsnprintf(mb->current, mb->buffer + mb->size - mb->current, fmt, ap);
char *newcurrent = mb->current + n;
char *end = mb->buffer + mb->size;
if (newcurrent < end)
mb->current = newcurrent;
else {
mb->current = mb->buffer + mb->size - 1;
*mb->current = '\0';
}
}
}
}
void _cx_vprintf_strbuf(void *context, const char *fmt, va_list ap)
{
strbuf_vsprintf((strbuf)context, fmt, ap);
}