lsquic_logger.h revision 06b2a236
106b2a236SDmitri Tikhonov/* Copyright (c) 2017 - 2021 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_STREAM, 5550aadb33SDmitri Tikhonov LSQLM_PARSE, 5650aadb33SDmitri Tikhonov LSQLM_CFCW, 5750aadb33SDmitri Tikhonov LSQLM_SFCW, 5850aadb33SDmitri Tikhonov LSQLM_SENDCTL, 5950aadb33SDmitri Tikhonov LSQLM_ALARMSET, 6050aadb33SDmitri Tikhonov LSQLM_CRYPTO, 6150aadb33SDmitri Tikhonov LSQLM_HANDSHAKE, 6250aadb33SDmitri Tikhonov LSQLM_HSK_ADAPTER, 635392f7a3SLiteSpeed Tech LSQLM_BBR, 6450aadb33SDmitri Tikhonov LSQLM_CUBIC, 65b1a7c3f9SDmitri Tikhonov LSQLM_ADAPTIVE_CC, 6650aadb33SDmitri Tikhonov LSQLM_HEADERS, 6750aadb33SDmitri Tikhonov LSQLM_FRAME_WRITER, 6850aadb33SDmitri Tikhonov LSQLM_FRAME_READER, 695392f7a3SLiteSpeed Tech LSQLM_MINI_CONN, 705392f7a3SLiteSpeed Tech LSQLM_TOKGEN, 7150aadb33SDmitri Tikhonov LSQLM_ENG_HIST, 7250aadb33SDmitri Tikhonov LSQLM_SPI, 73fbc6cc04SDmitri Tikhonov LSQLM_HPI, 7450aadb33SDmitri Tikhonov LSQLM_DI, 755392f7a3SLiteSpeed Tech LSQLM_PRQ, 7650aadb33SDmitri Tikhonov LSQLM_PACER, 773b55e6aeSDmitri Tikhonov LSQLM_HTTP1X, 7855cd0b38SDmitri Tikhonov LSQLM_QLOG, 795392f7a3SLiteSpeed Tech LSQLM_TRAPA, 805392f7a3SLiteSpeed Tech LSQLM_PURGA, 815392f7a3SLiteSpeed Tech LSQLM_HCSI_READER, 825392f7a3SLiteSpeed Tech LSQLM_HCSO_WRITER, 835392f7a3SLiteSpeed Tech LSQLM_QENC_HDL, 845392f7a3SLiteSpeed Tech LSQLM_QDEC_HDL, 855392f7a3SLiteSpeed Tech LSQLM_QPACK_ENC, 865392f7a3SLiteSpeed Tech LSQLM_QPACK_DEC, 875392f7a3SLiteSpeed Tech LSQLM_PRIO, 885392f7a3SLiteSpeed Tech LSQLM_BW_SAMPLER, 89b8fa6195SDmitri Tikhonov LSQLM_PACKET_RESIZE, 90758aff32SDmitri Tikhonov LSQLM_CONN_STATS, 9150aadb33SDmitri Tikhonov N_LSQUIC_LOGGER_MODULES 9250aadb33SDmitri Tikhonov}; 9350aadb33SDmitri Tikhonov 9450aadb33SDmitri Tikhonov/* Each module has its own log level. 9550aadb33SDmitri Tikhonov */ 9650aadb33SDmitri Tikhonovextern enum lsq_log_level lsq_log_levels[N_LSQUIC_LOGGER_MODULES]; 9750aadb33SDmitri Tikhonov 9850aadb33SDmitri Tikhonovextern const char *const lsqlm_to_str[N_LSQUIC_LOGGER_MODULES]; 9950aadb33SDmitri Tikhonov 10050aadb33SDmitri Tikhonovextern const char *const lsq_loglevel2str[N_LSQUIC_LOG_LEVELS]; 10150aadb33SDmitri Tikhonov 10250aadb33SDmitri Tikhonov#define LSQ_LOG_ENABLED_EXT(level, module) ( \ 10350aadb33SDmitri Tikhonov level <= LSQUIC_LOWEST_LOG_LEVEL && level <= lsq_log_levels[module]) 10450aadb33SDmitri Tikhonov 10550aadb33SDmitri Tikhonov#define LSQ_LOG_ENABLED(level) LSQ_LOG_ENABLED_EXT(level, LSQUIC_LOGGER_MODULE) 10650aadb33SDmitri Tikhonov 1075392f7a3SLiteSpeed Techstruct lsquic_cid; 1085392f7a3SLiteSpeed Tech 10950aadb33SDmitri Tikhonov/* The functions that perform actual logging are void. This is an 11050aadb33SDmitri Tikhonov * optimization. In majority of cases the calls will succeed; even if 11150aadb33SDmitri Tikhonov * they fail, there is nothing (at least, nothing simple) to be done to 11250aadb33SDmitri Tikhonov * handle logging failure. 11350aadb33SDmitri Tikhonov */ 11450aadb33SDmitri Tikhonov 11550aadb33SDmitri Tikhonov/* There are four levels of log functions, depending on whether they take 11650aadb33SDmitri Tikhonov * the following arguments: 11750aadb33SDmitri Tikhonov * 1. Logger module 11850aadb33SDmitri Tikhonov * 2. Connection ID 11950aadb33SDmitri Tikhonov * 3. Stream ID 12050aadb33SDmitri Tikhonov * 12150aadb33SDmitri Tikhonov * Each level of logging function supports one additional argument, as seen 12250aadb33SDmitri Tikhonov * below. LSQ_LOG is set to one of LSQ_LOG0, LSQ_LOG1, LSQ_LOG2, or LSQ_LOG3. 12350aadb33SDmitri Tikhonov * You can still use LSQ_LOG{0..3} directly. 12450aadb33SDmitri Tikhonov */ 12550aadb33SDmitri Tikhonov 12650aadb33SDmitri Tikhonovvoid 12750aadb33SDmitri Tikhonovlsquic_logger_log3 (enum lsq_log_level, enum lsquic_logger_module, 1285392f7a3SLiteSpeed Tech const struct lsquic_cid *conn_id, 1295392f7a3SLiteSpeed Tech lsquic_stream_id_t stream_id, const char *format, ...) 13050aadb33SDmitri Tikhonov#if __GNUC__ 13150aadb33SDmitri Tikhonov __attribute__((format(printf, 5, 6))) 13250aadb33SDmitri Tikhonov#endif 13350aadb33SDmitri Tikhonov; 13450aadb33SDmitri Tikhonov# define LSQ_LOG3(level, ...) do { \ 13550aadb33SDmitri Tikhonov if (LSQ_LOG_ENABLED(level)) \ 13650aadb33SDmitri Tikhonov lsquic_logger_log3(level, LSQUIC_LOGGER_MODULE, \ 1375392f7a3SLiteSpeed Tech LSQUIC_LOG_CONN_ID, LSQUIC_LOG_STREAM_ID, __VA_ARGS__); \ 13850aadb33SDmitri Tikhonov } while (0) 13950aadb33SDmitri Tikhonov 1405392f7a3SLiteSpeed Tech 14150aadb33SDmitri Tikhonovvoid 14250aadb33SDmitri Tikhonovlsquic_logger_log2 (enum lsq_log_level, enum lsquic_logger_module, 1435392f7a3SLiteSpeed Tech const struct lsquic_cid *conn_id, const char *format, ...) 14450aadb33SDmitri Tikhonov#if __GNUC__ 14550aadb33SDmitri Tikhonov __attribute__((format(printf, 4, 5))) 14650aadb33SDmitri Tikhonov#endif 14750aadb33SDmitri Tikhonov; 14850aadb33SDmitri Tikhonov# define LSQ_LOG2(level, ...) do { \ 14950aadb33SDmitri Tikhonov if (LSQ_LOG_ENABLED(level)) \ 15050aadb33SDmitri Tikhonov lsquic_logger_log2(level, LSQUIC_LOGGER_MODULE, \ 1515392f7a3SLiteSpeed Tech LSQUIC_LOG_CONN_ID, __VA_ARGS__); \ 1525392f7a3SLiteSpeed Tech } while (0) 1535392f7a3SLiteSpeed Tech# define LSQ_LOG2C(level, ...) do { \ 1545392f7a3SLiteSpeed Tech if (LSQ_LOG_ENABLED(level)) \ 1555392f7a3SLiteSpeed Tech { \ 1565392f7a3SLiteSpeed Tech char cidbuf_[MAX_CID_LEN * 2 + 1]; \ 1575392f7a3SLiteSpeed Tech lsquic_logger_log2(level, LSQUIC_LOGGER_MODULE, \ 1585392f7a3SLiteSpeed Tech LSQUIC_LOG_CONN_ID, __VA_ARGS__); \ 1595392f7a3SLiteSpeed Tech } \ 16050aadb33SDmitri Tikhonov } while (0) 16150aadb33SDmitri Tikhonov 16250aadb33SDmitri Tikhonovvoid 16350aadb33SDmitri Tikhonovlsquic_logger_log1 (enum lsq_log_level, enum lsquic_logger_module, 16450aadb33SDmitri Tikhonov const char *format, ...) 16550aadb33SDmitri Tikhonov#if __GNUC__ 16650aadb33SDmitri Tikhonov __attribute__((format(printf, 3, 4))) 16750aadb33SDmitri Tikhonov#endif 16850aadb33SDmitri Tikhonov; 16950aadb33SDmitri Tikhonov# define LSQ_LOG1(level, ...) do { \ 17050aadb33SDmitri Tikhonov if (LSQ_LOG_ENABLED(level)) \ 17150aadb33SDmitri Tikhonov lsquic_logger_log1(level, LSQUIC_LOGGER_MODULE, __VA_ARGS__); \ 17250aadb33SDmitri Tikhonov } while (0) 1735392f7a3SLiteSpeed Tech# define LSQ_LOG1C(level, ...) do { \ 1745392f7a3SLiteSpeed Tech if (LSQ_LOG_ENABLED(level)) \ 1755392f7a3SLiteSpeed Tech { \ 1765392f7a3SLiteSpeed Tech char cidbuf_[MAX_CID_LEN * 2 + 1]; \ 1775392f7a3SLiteSpeed Tech lsquic_logger_log1(level, LSQUIC_LOGGER_MODULE, __VA_ARGS__); \ 1785392f7a3SLiteSpeed Tech } \ 1795392f7a3SLiteSpeed Tech } while (0) 18050aadb33SDmitri Tikhonov 18150aadb33SDmitri Tikhonovvoid 18250aadb33SDmitri Tikhonovlsquic_logger_log0 (enum lsq_log_level, const char *format, ...) 18350aadb33SDmitri Tikhonov#if __GNUC__ 18450aadb33SDmitri Tikhonov __attribute__((format(printf, 2, 3))) 18550aadb33SDmitri Tikhonov#endif 18650aadb33SDmitri Tikhonov; 18750aadb33SDmitri Tikhonov# define LSQ_LOG0(level, ...) do { \ 18850aadb33SDmitri Tikhonov if (LSQ_LOG_ENABLED(level)) \ 18950aadb33SDmitri Tikhonov lsquic_logger_log0(level, __VA_ARGS__); \ 19050aadb33SDmitri Tikhonov } while (0) 1915392f7a3SLiteSpeed Tech# define LSQ_LOG0C(level, ...) do { \ 1925392f7a3SLiteSpeed Tech if (LSQ_LOG_ENABLED(level)) \ 1935392f7a3SLiteSpeed Tech { \ 1945392f7a3SLiteSpeed Tech char cidbuf_[MAX_CID_LEN * 2 + 1]; \ 1955392f7a3SLiteSpeed Tech lsquic_logger_log0(level, __VA_ARGS__); \ 1965392f7a3SLiteSpeed Tech } \ 1975392f7a3SLiteSpeed Tech } while (0) 19850aadb33SDmitri Tikhonov 19950aadb33SDmitri Tikhonov#if defined(LSQUIC_LOGGER_MODULE) 20050aadb33SDmitri Tikhonov#if defined(LSQUIC_LOG_CONN_ID) 20150aadb33SDmitri Tikhonov#if defined(LSQUIC_LOG_STREAM_ID) 20250aadb33SDmitri Tikhonov# define LSQ_LOG LSQ_LOG3 20350aadb33SDmitri Tikhonov#else 20450aadb33SDmitri Tikhonov# define LSQ_LOG LSQ_LOG2 2055392f7a3SLiteSpeed Tech# define LSQ_LOGC LSQ_LOG2C 20650aadb33SDmitri Tikhonov#endif 20750aadb33SDmitri Tikhonov#else 20850aadb33SDmitri Tikhonov# define LSQ_LOG LSQ_LOG1 2095392f7a3SLiteSpeed Tech# define LSQ_LOGC LSQ_LOG1C 21050aadb33SDmitri Tikhonov#endif 21150aadb33SDmitri Tikhonov#else 21250aadb33SDmitri Tikhonov# define LSQ_LOG LSQ_LOG0 2135392f7a3SLiteSpeed Tech# define LSQ_LOGC LSQ_LOG0C 21450aadb33SDmitri Tikhonov# define LSQUIC_LOGGER_MODULE LSQLM_NOMODULE 21550aadb33SDmitri Tikhonov#endif 21650aadb33SDmitri Tikhonov 21750aadb33SDmitri Tikhonov#define LSQ_DEBUG(...) LSQ_LOG(LSQ_LOG_DEBUG, __VA_ARGS__) 21850aadb33SDmitri Tikhonov#define LSQ_WARN(...) LSQ_LOG(LSQ_LOG_WARN, __VA_ARGS__) 21950aadb33SDmitri Tikhonov#define LSQ_ALERT(...) LSQ_LOG(LSQ_LOG_ALERT, __VA_ARGS__) 22050aadb33SDmitri Tikhonov#define LSQ_CRIT(...) LSQ_LOG(LSQ_LOG_CRIT, __VA_ARGS__) 22150aadb33SDmitri Tikhonov#define LSQ_ERROR(...) LSQ_LOG(LSQ_LOG_ERROR, __VA_ARGS__) 22250aadb33SDmitri Tikhonov#define LSQ_NOTICE(...) LSQ_LOG(LSQ_LOG_NOTICE, __VA_ARGS__) 22350aadb33SDmitri Tikhonov#define LSQ_INFO(...) LSQ_LOG(LSQ_LOG_INFO, __VA_ARGS__) 22450aadb33SDmitri Tikhonov#define LSQ_EMERG(...) LSQ_LOG(LSQ_LOG_EMERG, __VA_ARGS__) 22550aadb33SDmitri Tikhonov 2265392f7a3SLiteSpeed Tech#define LSQ_DEBUGC(...) LSQ_LOGC(LSQ_LOG_DEBUG, __VA_ARGS__) 2275392f7a3SLiteSpeed Tech#define LSQ_WARNC(...) LSQ_LOGC(LSQ_LOG_WARN, __VA_ARGS__) 2285392f7a3SLiteSpeed Tech#define LSQ_ALERTC(...) LSQ_LOGC(LSQ_LOG_ALERT, __VA_ARGS__) 2295392f7a3SLiteSpeed Tech#define LSQ_CRITC(...) LSQ_LOGC(LSQ_LOG_CRIT, __VA_ARGS__) 2305392f7a3SLiteSpeed Tech#define LSQ_ERRORC(...) LSQ_LOGC(LSQ_LOG_ERROR, __VA_ARGS__) 2315392f7a3SLiteSpeed Tech#define LSQ_NOTICEC(...) LSQ_LOGC(LSQ_LOG_NOTICE, __VA_ARGS__) 2325392f7a3SLiteSpeed Tech#define LSQ_INFOC(...) LSQ_LOGC(LSQ_LOG_INFO, __VA_ARGS__) 2335392f7a3SLiteSpeed Tech#define LSQ_EMERGC(...) LSQ_LOGC(LSQ_LOG_EMERG, __VA_ARGS__) 2345392f7a3SLiteSpeed Tech 23550aadb33SDmitri Tikhonov/* Shorthand for printing to file streams using internal lsquic_logger_if 23650aadb33SDmitri Tikhonov */ 23750aadb33SDmitri Tikhonovvoid 23850aadb33SDmitri Tikhonovlsquic_log_to_fstream (FILE *, unsigned llts); 23950aadb33SDmitri Tikhonov 24050aadb33SDmitri Tikhonovenum lsquic_logger_module 24150aadb33SDmitri Tikhonovlsquic_str_to_logger_module (const char *); 24250aadb33SDmitri Tikhonov 24350aadb33SDmitri Tikhonovenum lsq_log_level 24450aadb33SDmitri Tikhonovlsquic_str_to_log_level (const char *); 24550aadb33SDmitri Tikhonov 24650aadb33SDmitri Tikhonov/* Parse and set log levels passed via -l flag. If an error is encountered, 24750aadb33SDmitri Tikhonov * an error message is printed to stderr and negative value is returned. 24850aadb33SDmitri Tikhonov */ 24950aadb33SDmitri Tikhonovint 25050aadb33SDmitri Tikhonovlsquic_logger_lopt (const char *optarg); 25150aadb33SDmitri Tikhonov 2525392f7a3SLiteSpeed Tech#define CID_FMT ".*s" 2535392f7a3SLiteSpeed Tech 254fb73393fSDmitri Tikhonov#define CID_BITS_B(cid, b) 2 * (int) (cid)->len, \ 255fb73393fSDmitri Tikhonov (lsquic_cid2str(cid, b), b) 256fb73393fSDmitri Tikhonov 257fb73393fSDmitri Tikhonov#define CID_BITS(cid) CID_BITS_B(cid, cidbuf_) 2585392f7a3SLiteSpeed Tech 2595392f7a3SLiteSpeed Techvoid 2605392f7a3SLiteSpeed Techlsquic_cid2str (const struct lsquic_cid *, char *out); 2615392f7a3SLiteSpeed Tech 2625392f7a3SLiteSpeed Techconst struct lsquic_cid * 2635392f7a3SLiteSpeed Techlsquic_conn_log_cid (const struct lsquic_conn *); 2645392f7a3SLiteSpeed Tech 26550aadb33SDmitri Tikhonov#ifdef __cplusplus 26650aadb33SDmitri Tikhonov} 26750aadb33SDmitri Tikhonov#endif 26850aadb33SDmitri Tikhonov 26950aadb33SDmitri Tikhonov#endif 270