ff3512a77e
f785959eace chore: add to_string functions for netprof enums a95b7957288 cleanup: Heap allocate network profile objects a3c80149edd feat: Implement Tox network profiler ac812871a2e feat: implement the last 2 missing network struct functions and make use of them 29d1043be0b test: friend request test now tests min/max message sizes 93aafd78c1f fix: friend requests with very long messages are no longer dropped 819aa2b2618 feat: Add option to disable DNS lookups in toxcore. 0ac23cee035 fix: windows use of REUSEADDR 7d2811d302d chore(ci): make bazel server shutdown faster 1dc399ba20d chore: Use vcpkg instead of conan in the MSVC build. 14d823165d9 chore: Migrate to conan 2. bdd17c16787 cleanup: Allocate logger using tox memory allocator. b396c061515 chore(deps): bump third_party/cmp from `2ac6bca` to `52bfcfa` 2e94da60d09 feat(net): add missing connect to network struct 41fb1839c7b chore: Add check to ensure version numbers agree. 934a8301113 chore: Release 0.2.20 3acef4bf044 fix: Add missing free in dht_get_nodes_response event. git-subtree-dir: external/toxcore/c-toxcore git-subtree-split: f785959eacebc59590f756b133b52601c335a1d1
108 lines
3.5 KiB
C
108 lines
3.5 KiB
C
/* SPDX-License-Identifier: GPL-3.0-or-later
|
|
* Copyright © 2016-2018 The TokTok team.
|
|
* Copyright © 2013 Tox project.
|
|
*/
|
|
|
|
/**
|
|
* Logger abstraction backed by callbacks for writing.
|
|
*/
|
|
#ifndef C_TOXCORE_TOXCORE_LOGGER_H
|
|
#define C_TOXCORE_TOXCORE_LOGGER_H
|
|
|
|
#include <stdint.h>
|
|
|
|
#include "attributes.h"
|
|
#include "mem.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#ifndef MIN_LOGGER_LEVEL
|
|
#define MIN_LOGGER_LEVEL LOGGER_LEVEL_INFO
|
|
#endif /* MIN_LOGGER_LEVEL */
|
|
|
|
// NOTE: Don't forget to update build system files after modifying the enum.
|
|
typedef enum Logger_Level {
|
|
LOGGER_LEVEL_TRACE,
|
|
LOGGER_LEVEL_DEBUG,
|
|
LOGGER_LEVEL_INFO,
|
|
LOGGER_LEVEL_WARNING,
|
|
LOGGER_LEVEL_ERROR,
|
|
} Logger_Level;
|
|
|
|
typedef struct Logger Logger;
|
|
|
|
typedef void logger_cb(void *context, Logger_Level level, const char *file, int line,
|
|
const char *func, const char *message, void *userdata);
|
|
|
|
/**
|
|
* Creates a new logger with logging disabled (callback is NULL) by default.
|
|
*/
|
|
non_null()
|
|
Logger *logger_new(const Memory *mem);
|
|
|
|
/**
|
|
* Frees all resources associated with the logger.
|
|
*/
|
|
nullable(1)
|
|
void logger_kill(Logger *log);
|
|
|
|
/**
|
|
* Sets the logger callback. Disables logging if set to NULL.
|
|
* The context parameter is passed to the callback as first argument.
|
|
*/
|
|
non_null(1) nullable(2, 3, 4)
|
|
void logger_callback_log(Logger *log, logger_cb *function, void *context, void *userdata);
|
|
|
|
/** @brief Main write function. If logging is disabled, this does nothing.
|
|
*
|
|
* If the logger is NULL and `NDEBUG` is not defined, this writes to stderr.
|
|
* This behaviour should not be used in production code, but can be useful for
|
|
* temporarily debugging a function that does not have a logger available. It's
|
|
* essentially `fprintf(stderr, ...)`, but with source location.
|
|
*
|
|
* If `NDEBUG` is defined, the NULL logger does nothing.
|
|
*/
|
|
non_null(3, 5, 6) nullable(1) GNU_PRINTF(6, 7)
|
|
void logger_write(
|
|
const Logger *log, Logger_Level level, const char *file, int line, const char *func,
|
|
const char *format, ...);
|
|
|
|
/* @brief Terminate the program with a signal. */
|
|
void logger_abort(void);
|
|
|
|
#define LOGGER_WRITE(log, level, ...) \
|
|
do { \
|
|
if (level >= MIN_LOGGER_LEVEL) { \
|
|
logger_write(log, level, __FILE__, __LINE__, __func__, __VA_ARGS__); \
|
|
} \
|
|
} while (0)
|
|
|
|
/* To log with an logger */
|
|
#define LOGGER_TRACE(log, ...) LOGGER_WRITE(log, LOGGER_LEVEL_TRACE, __VA_ARGS__)
|
|
#define LOGGER_DEBUG(log, ...) LOGGER_WRITE(log, LOGGER_LEVEL_DEBUG, __VA_ARGS__)
|
|
#define LOGGER_INFO(log, ...) LOGGER_WRITE(log, LOGGER_LEVEL_INFO, __VA_ARGS__)
|
|
#define LOGGER_WARNING(log, ...) LOGGER_WRITE(log, LOGGER_LEVEL_WARNING, __VA_ARGS__)
|
|
#define LOGGER_ERROR(log, ...) LOGGER_WRITE(log, LOGGER_LEVEL_ERROR, __VA_ARGS__)
|
|
|
|
#define LOGGER_FATAL(log, ...) \
|
|
do { \
|
|
LOGGER_ERROR(log, __VA_ARGS__); \
|
|
logger_abort(); \
|
|
} while (0)
|
|
|
|
#define LOGGER_ASSERT(log, cond, ...) \
|
|
do { \
|
|
if (!(cond)) { \
|
|
LOGGER_ERROR(log, "Assertion failed"); \
|
|
LOGGER_FATAL(log, __VA_ARGS__); \
|
|
} \
|
|
} while (0)
|
|
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
|
|
#endif /* C_TOXCORE_TOXCORE_LOGGER_H */
|