lsquic_logger.h revision e8bd737d
110c492f0SDmitri Tikhonov/* Copyright (c) 2017 - 2018 LiteSpeed Technologies Inc.  See LICENSE. */
250aadb33SDmitri Tikhonov/*
350aadb33SDmitri Tikhonov * lsquic_logger.h -- logging functions and macros.
450aadb33SDmitri Tikhonov *
550aadb33SDmitri Tikhonov * Usage (this assumes MY_MODULE) is a part of enum lsquic_logger_module):
650aadb33SDmitri Tikhonov *   #define LSQUIC_LOGGER_MODULE MY_MODULE
750aadb33SDmitri Tikhonov *   #include "lsquic_logger.h"
850aadb33SDmitri Tikhonov *   LSQ_INFO("info message");
950aadb33SDmitri Tikhonov *
1050aadb33SDmitri Tikhonov * If you want log messages from your module to contain connection ID, #define
1150aadb33SDmitri Tikhonov * LSQUIC_LOG_CONN_ID so that it evaluates to connection ID.  If, in addition,
1250aadb33SDmitri Tikhonov * you want stream ID to be logged, #define LSQUIC_LOG_STREAM_ID similarly.
1350aadb33SDmitri Tikhonov * See existing code for examples.
1450aadb33SDmitri Tikhonov *
1550aadb33SDmitri Tikhonov * To add a module:
1650aadb33SDmitri Tikhonov *   1. Add entry to enum lsquic_logger_module.
1750aadb33SDmitri Tikhonov *   2. Update lsqlm_to_str.
1850aadb33SDmitri Tikhonov *   3. Update lsq_log_levels.
1950aadb33SDmitri Tikhonov */
2050aadb33SDmitri Tikhonov
2150aadb33SDmitri Tikhonov#ifndef LSQUIC_LOGGER_H
2250aadb33SDmitri Tikhonov#define LSQUIC_LOGGER_H
2350aadb33SDmitri Tikhonov
2450aadb33SDmitri Tikhonov#include <stdint.h>
2550aadb33SDmitri Tikhonov#include <stdio.h>
2650aadb33SDmitri Tikhonov
2750aadb33SDmitri Tikhonov#ifdef __cplusplus
2850aadb33SDmitri Tikhonovextern "C" {
2950aadb33SDmitri Tikhonov#endif
3050aadb33SDmitri Tikhonov
3150aadb33SDmitri Tikhonov#ifndef LSQUIC_LOWEST_LOG_LEVEL
3250aadb33SDmitri Tikhonov#   define LSQUIC_LOWEST_LOG_LEVEL LSQ_LOG_DEBUG
3350aadb33SDmitri Tikhonov#endif
3450aadb33SDmitri Tikhonov
3550aadb33SDmitri Tikhonov/* Same levels as in sys/syslog.h: */
3650aadb33SDmitri Tikhonovenum lsq_log_level {
3750aadb33SDmitri Tikhonov    LSQ_LOG_EMERG,
3850aadb33SDmitri Tikhonov    LSQ_LOG_ALERT,
3950aadb33SDmitri Tikhonov    LSQ_LOG_CRIT,
4050aadb33SDmitri Tikhonov    LSQ_LOG_ERROR,
4150aadb33SDmitri Tikhonov    LSQ_LOG_WARN,
4250aadb33SDmitri Tikhonov    LSQ_LOG_NOTICE,
4350aadb33SDmitri Tikhonov    LSQ_LOG_INFO,
4450aadb33SDmitri Tikhonov    LSQ_LOG_DEBUG,
4550aadb33SDmitri Tikhonov    N_LSQUIC_LOG_LEVELS
4650aadb33SDmitri Tikhonov};
4750aadb33SDmitri Tikhonov
4850aadb33SDmitri Tikhonovenum lsquic_logger_module {
4950aadb33SDmitri Tikhonov    LSQLM_NOMODULE,
5050aadb33SDmitri Tikhonov    LSQLM_LOGGER,
5150aadb33SDmitri Tikhonov    LSQLM_EVENT,
5250aadb33SDmitri Tikhonov    LSQLM_ENGINE,
5350aadb33SDmitri Tikhonov    LSQLM_CONN,
5450aadb33SDmitri Tikhonov    LSQLM_RECHIST,
5550aadb33SDmitri Tikhonov    LSQLM_STREAM,
5650aadb33SDmitri Tikhonov    LSQLM_PARSE,
5750aadb33SDmitri Tikhonov    LSQLM_CFCW,
5850aadb33SDmitri Tikhonov    LSQLM_SFCW,
5950aadb33SDmitri Tikhonov    LSQLM_SENDCTL,
6050aadb33SDmitri Tikhonov    LSQLM_ALARMSET,
6150aadb33SDmitri Tikhonov    LSQLM_CRYPTO,
6250aadb33SDmitri Tikhonov    LSQLM_HANDSHAKE,
6350aadb33SDmitri Tikhonov    LSQLM_HSK_ADAPTER,
6450aadb33SDmitri Tikhonov    LSQLM_CUBIC,
6550aadb33SDmitri Tikhonov    LSQLM_HEADERS,
6650aadb33SDmitri Tikhonov    LSQLM_FRAME_WRITER,
6750aadb33SDmitri Tikhonov    LSQLM_FRAME_READER,
6850aadb33SDmitri Tikhonov    LSQLM_CONN_HASH,
6950aadb33SDmitri Tikhonov    LSQLM_ENG_HIST,
7050aadb33SDmitri Tikhonov    LSQLM_SPI,
7150aadb33SDmitri Tikhonov    LSQLM_DI,
7250aadb33SDmitri Tikhonov    LSQLM_PACER,
73e8bd737dSDmitri Tikhonov    LSQLM_MIN_HEAP,
7450aadb33SDmitri Tikhonov    N_LSQUIC_LOGGER_MODULES
7550aadb33SDmitri Tikhonov};
7650aadb33SDmitri Tikhonov
7750aadb33SDmitri Tikhonov/* Each module has its own log level.
7850aadb33SDmitri Tikhonov */
7950aadb33SDmitri Tikhonovextern enum lsq_log_level lsq_log_levels[N_LSQUIC_LOGGER_MODULES];
8050aadb33SDmitri Tikhonov
8150aadb33SDmitri Tikhonovextern const char *const lsqlm_to_str[N_LSQUIC_LOGGER_MODULES];
8250aadb33SDmitri Tikhonov
8350aadb33SDmitri Tikhonovextern const char *const lsq_loglevel2str[N_LSQUIC_LOG_LEVELS];
8450aadb33SDmitri Tikhonov
8550aadb33SDmitri Tikhonov#define LSQ_LOG_ENABLED_EXT(level, module) (                            \
8650aadb33SDmitri Tikhonov    level <= LSQUIC_LOWEST_LOG_LEVEL && level <= lsq_log_levels[module])
8750aadb33SDmitri Tikhonov
8850aadb33SDmitri Tikhonov#define LSQ_LOG_ENABLED(level) LSQ_LOG_ENABLED_EXT(level, LSQUIC_LOGGER_MODULE)
8950aadb33SDmitri Tikhonov
9050aadb33SDmitri Tikhonov/* The functions that perform actual logging are void.  This is an
9150aadb33SDmitri Tikhonov * optimization.  In majority of cases the calls will succeed; even if
9250aadb33SDmitri Tikhonov * they fail, there is nothing (at least, nothing simple) to be done to
9350aadb33SDmitri Tikhonov * handle logging failure.
9450aadb33SDmitri Tikhonov */
9550aadb33SDmitri Tikhonov
9650aadb33SDmitri Tikhonov/* There are four levels of log functions, depending on whether they take
9750aadb33SDmitri Tikhonov * the following arguments:
9850aadb33SDmitri Tikhonov *  1. Logger module
9950aadb33SDmitri Tikhonov *  2. Connection ID
10050aadb33SDmitri Tikhonov *  3. Stream ID
10150aadb33SDmitri Tikhonov *
10250aadb33SDmitri Tikhonov * Each level of logging function supports one additional argument, as seen
10350aadb33SDmitri Tikhonov * below.  LSQ_LOG is set to one of LSQ_LOG0, LSQ_LOG1, LSQ_LOG2, or LSQ_LOG3.
10450aadb33SDmitri Tikhonov * You can still use LSQ_LOG{0..3} directly.
10550aadb33SDmitri Tikhonov */
10650aadb33SDmitri Tikhonov
10750aadb33SDmitri Tikhonovvoid
10850aadb33SDmitri Tikhonovlsquic_logger_log3 (enum lsq_log_level, enum lsquic_logger_module,
10950aadb33SDmitri Tikhonov                    uint64_t conn_id, uint32_t stream_id,
11050aadb33SDmitri Tikhonov                    const char *format, ...)
11150aadb33SDmitri Tikhonov#if __GNUC__
11250aadb33SDmitri Tikhonov            __attribute__((format(printf, 5, 6)))
11350aadb33SDmitri Tikhonov#endif
11450aadb33SDmitri Tikhonov;
11550aadb33SDmitri Tikhonov#   define LSQ_LOG3(level, ...) do {                                         \
11650aadb33SDmitri Tikhonov        if (LSQ_LOG_ENABLED(level))                                          \
11750aadb33SDmitri Tikhonov            lsquic_logger_log3(level, LSQUIC_LOGGER_MODULE,                  \
11850aadb33SDmitri Tikhonov                     LSQUIC_LOG_CONN_ID, LSQUIC_LOG_STREAM_ID, __VA_ARGS__); \
11950aadb33SDmitri Tikhonov    } while (0)
12050aadb33SDmitri Tikhonov
12150aadb33SDmitri Tikhonovvoid
12250aadb33SDmitri Tikhonovlsquic_logger_log2 (enum lsq_log_level, enum lsquic_logger_module,
12350aadb33SDmitri Tikhonov                    uint64_t conn_id, const char *format, ...)
12450aadb33SDmitri Tikhonov#if __GNUC__
12550aadb33SDmitri Tikhonov            __attribute__((format(printf, 4, 5)))
12650aadb33SDmitri Tikhonov#endif
12750aadb33SDmitri Tikhonov;
12850aadb33SDmitri Tikhonov#   define LSQ_LOG2(level, ...) do {                                         \
12950aadb33SDmitri Tikhonov        if (LSQ_LOG_ENABLED(level))                                          \
13050aadb33SDmitri Tikhonov            lsquic_logger_log2(level, LSQUIC_LOGGER_MODULE,                  \
13150aadb33SDmitri Tikhonov                                        LSQUIC_LOG_CONN_ID, __VA_ARGS__);    \
13250aadb33SDmitri Tikhonov    } while (0)
13350aadb33SDmitri Tikhonov
13450aadb33SDmitri Tikhonovvoid
13550aadb33SDmitri Tikhonovlsquic_logger_log1 (enum lsq_log_level, enum lsquic_logger_module,
13650aadb33SDmitri Tikhonov                    const char *format, ...)
13750aadb33SDmitri Tikhonov#if __GNUC__
13850aadb33SDmitri Tikhonov            __attribute__((format(printf, 3, 4)))
13950aadb33SDmitri Tikhonov#endif
14050aadb33SDmitri Tikhonov;
14150aadb33SDmitri Tikhonov#   define LSQ_LOG1(level, ...) do {                                         \
14250aadb33SDmitri Tikhonov        if (LSQ_LOG_ENABLED(level))                                          \
14350aadb33SDmitri Tikhonov            lsquic_logger_log1(level, LSQUIC_LOGGER_MODULE, __VA_ARGS__);    \
14450aadb33SDmitri Tikhonov    } while (0)
14550aadb33SDmitri Tikhonov
14650aadb33SDmitri Tikhonovvoid
14750aadb33SDmitri Tikhonovlsquic_logger_log0 (enum lsq_log_level, const char *format, ...)
14850aadb33SDmitri Tikhonov#if __GNUC__
14950aadb33SDmitri Tikhonov            __attribute__((format(printf, 2, 3)))
15050aadb33SDmitri Tikhonov#endif
15150aadb33SDmitri Tikhonov;
15250aadb33SDmitri Tikhonov#   define LSQ_LOG0(level, ...) do {                                         \
15350aadb33SDmitri Tikhonov        if (LSQ_LOG_ENABLED(level))                                          \
15450aadb33SDmitri Tikhonov            lsquic_logger_log0(level, __VA_ARGS__);                          \
15550aadb33SDmitri Tikhonov    } while (0)
15650aadb33SDmitri Tikhonov
15750aadb33SDmitri Tikhonov#if defined(LSQUIC_LOGGER_MODULE)
15850aadb33SDmitri Tikhonov#if defined(LSQUIC_LOG_CONN_ID)
15950aadb33SDmitri Tikhonov#if defined(LSQUIC_LOG_STREAM_ID)
16050aadb33SDmitri Tikhonov#       define LSQ_LOG LSQ_LOG3
16150aadb33SDmitri Tikhonov#else
16250aadb33SDmitri Tikhonov#       define LSQ_LOG LSQ_LOG2
16350aadb33SDmitri Tikhonov#endif
16450aadb33SDmitri Tikhonov#else
16550aadb33SDmitri Tikhonov#       define LSQ_LOG LSQ_LOG1
16650aadb33SDmitri Tikhonov#endif
16750aadb33SDmitri Tikhonov#else
16850aadb33SDmitri Tikhonov#       define LSQ_LOG LSQ_LOG0
16950aadb33SDmitri Tikhonov#       define LSQUIC_LOGGER_MODULE LSQLM_NOMODULE
17050aadb33SDmitri Tikhonov#endif
17150aadb33SDmitri Tikhonov
17250aadb33SDmitri Tikhonov#define LSQ_DEBUG(...)   LSQ_LOG(LSQ_LOG_DEBUG,  __VA_ARGS__)
17350aadb33SDmitri Tikhonov#define LSQ_WARN(...)    LSQ_LOG(LSQ_LOG_WARN,   __VA_ARGS__)
17450aadb33SDmitri Tikhonov#define LSQ_ALERT(...)   LSQ_LOG(LSQ_LOG_ALERT,  __VA_ARGS__)
17550aadb33SDmitri Tikhonov#define LSQ_CRIT(...)    LSQ_LOG(LSQ_LOG_CRIT,   __VA_ARGS__)
17650aadb33SDmitri Tikhonov#define LSQ_ERROR(...)   LSQ_LOG(LSQ_LOG_ERROR,  __VA_ARGS__)
17750aadb33SDmitri Tikhonov#define LSQ_NOTICE(...)  LSQ_LOG(LSQ_LOG_NOTICE, __VA_ARGS__)
17850aadb33SDmitri Tikhonov#define LSQ_INFO(...)    LSQ_LOG(LSQ_LOG_INFO,   __VA_ARGS__)
17950aadb33SDmitri Tikhonov#define LSQ_EMERG(...)   LSQ_LOG(LSQ_LOG_EMERG,  __VA_ARGS__)
18050aadb33SDmitri Tikhonov
18150aadb33SDmitri Tikhonov/* Shorthand for printing to file streams using internal lsquic_logger_if
18250aadb33SDmitri Tikhonov */
18350aadb33SDmitri Tikhonovvoid
18450aadb33SDmitri Tikhonovlsquic_log_to_fstream (FILE *, unsigned llts);
18550aadb33SDmitri Tikhonov
18650aadb33SDmitri Tikhonovenum lsquic_logger_module
18750aadb33SDmitri Tikhonovlsquic_str_to_logger_module (const char *);
18850aadb33SDmitri Tikhonov
18950aadb33SDmitri Tikhonovenum lsq_log_level
19050aadb33SDmitri Tikhonovlsquic_str_to_log_level (const char *);
19150aadb33SDmitri Tikhonov
19250aadb33SDmitri Tikhonov/* Parse and set log levels passed via -l flag.  If an error is encountered,
19350aadb33SDmitri Tikhonov * an error message is printed to stderr and negative value is returned.
19450aadb33SDmitri Tikhonov */
19550aadb33SDmitri Tikhonovint
19650aadb33SDmitri Tikhonovlsquic_logger_lopt (const char *optarg);
19750aadb33SDmitri Tikhonov
19850aadb33SDmitri Tikhonov#ifdef __cplusplus
19950aadb33SDmitri Tikhonov}
20050aadb33SDmitri Tikhonov#endif
20150aadb33SDmitri Tikhonov
20250aadb33SDmitri Tikhonov#endif
203