1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
/*
* ngtcp2
*
* Copyright (c) 2018 ngtcp2 contributors
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#ifndef NGTCP2_LOG_H
#define NGTCP2_LOG_H
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif /* defined(HAVE_CONFIG_H) */
#include <ngtcp2/ngtcp2.h>
#include "ngtcp2_pkt.h"
typedef struct ngtcp2_log {
/* log_printf is a sink to write log. NULL means no logging
output. */
ngtcp2_printf log_printf;
/* events is an event filter. Only events set in this field are
emitted. */
uint8_t events;
/* ts is the time point used to write time delta in the log. */
ngtcp2_tstamp ts;
/* last_ts is the most recent time point that this object is
told. */
ngtcp2_tstamp last_ts;
/* user_data is user-defined opaque data which is passed to
log_pritnf. */
void *user_data;
/* scid is SCID encoded as NULL-terminated hex string. */
uint8_t scid[NGTCP2_MAX_CIDLEN * 2 + 1];
} ngtcp2_log;
/**
* @enum
*
* :type:`ngtcp2_log_event` defines an event of ngtcp2 library
* internal logger.
*/
typedef enum ngtcp2_log_event {
/**
* :enum:`NGTCP2_LOG_EVENT_NONE` represents no event.
*/
NGTCP2_LOG_EVENT_NONE,
/**
* :enum:`NGTCP2_LOG_EVENT_CON` is a connection (catch-all) event
*/
NGTCP2_LOG_EVENT_CON = 0x1,
/**
* :enum:`NGTCP2_LOG_EVENT_PKT` is a packet event.
*/
NGTCP2_LOG_EVENT_PKT = 0x2,
/**
* :enum:`NGTCP2_LOG_EVENT_FRM` is a QUIC frame event.
*/
NGTCP2_LOG_EVENT_FRM = 0x4,
/**
* :enum:`NGTCP2_LOG_EVENT_LDC` is a loss detection and congestion
* control event.
*/
NGTCP2_LOG_EVENT_LDC = 0x8,
/**
* :enum:`NGTCP2_LOG_EVENT_CRY` is a crypto event.
*/
NGTCP2_LOG_EVENT_CRY = 0x10,
/**
* :enum:`NGTCP2_LOG_EVENT_PTV` is a path validation event.
*/
NGTCP2_LOG_EVENT_PTV = 0x20,
/**
* :enum:`NGTCP2_LOG_EVENT_CCA` is a congestion controller algorithm
* event.
*/
NGTCP2_LOG_EVENT_CCA = 0x40,
} ngtcp2_log_event;
void ngtcp2_log_init(ngtcp2_log *log, const ngtcp2_cid *scid,
ngtcp2_printf log_printf, ngtcp2_tstamp ts,
void *user_data);
void ngtcp2_log_rx_fr(ngtcp2_log *log, const ngtcp2_pkt_hd *hd,
const ngtcp2_frame *fr);
void ngtcp2_log_tx_fr(ngtcp2_log *log, const ngtcp2_pkt_hd *hd,
const ngtcp2_frame *fr);
void ngtcp2_log_rx_vn(ngtcp2_log *log, const ngtcp2_pkt_hd *hd,
const uint32_t *sv, size_t nsv);
void ngtcp2_log_rx_sr(ngtcp2_log *log, const ngtcp2_pkt_stateless_reset *sr);
void ngtcp2_log_remote_tp(ngtcp2_log *log,
const ngtcp2_transport_params *params);
void ngtcp2_log_pkt_lost(ngtcp2_log *log, int64_t pkt_num, uint8_t type,
uint8_t flags, ngtcp2_tstamp sent_ts);
void ngtcp2_log_rx_pkt_hd(ngtcp2_log *log, const ngtcp2_pkt_hd *hd);
void ngtcp2_log_tx_pkt_hd(ngtcp2_log *log, const ngtcp2_pkt_hd *hd);
void ngtcp2_log_tx_cancel(ngtcp2_log *log, const ngtcp2_pkt_hd *hd);
#define NGTCP2_LOG_HD "I%08" PRIu64 " 0x%s %s"
uint64_t ngtcp2_log_timestamp(const ngtcp2_log *log);
static inline const char *ngtcp2_log_event_str(ngtcp2_log_event ev) {
switch (ev) {
case NGTCP2_LOG_EVENT_CON:
return "con";
case NGTCP2_LOG_EVENT_PKT:
return "pkt";
case NGTCP2_LOG_EVENT_FRM:
return "frm";
case NGTCP2_LOG_EVENT_LDC:
return "ldc";
case NGTCP2_LOG_EVENT_CRY:
return "cry";
case NGTCP2_LOG_EVENT_PTV:
return "ptv";
case NGTCP2_LOG_EVENT_CCA:
return "cca";
case NGTCP2_LOG_EVENT_NONE:
default:
return "non";
}
}
#define ngtcp2_log_infof_raw(LOG, EV, FMT, ...) \
(LOG)->log_printf((LOG)->user_data, NGTCP2_LOG_HD " " FMT, \
ngtcp2_log_timestamp(LOG), (LOG)->scid, \
ngtcp2_log_event_str(EV), __VA_ARGS__);
/**
* @function
*
* `ngtcp2_log_infof` writes info level log with printf like
* formatting.
*/
#define ngtcp2_log_infof(LOG, EV, FMT, ...) \
do { \
if (!(LOG)->log_printf || !((LOG)->events & (EV))) { \
break; \
} \
\
ngtcp2_log_infof_raw((LOG), (EV), FMT, __VA_ARGS__); \
} while (0)
#define ngtcp2_log_info_raw(LOG, EV, FMT) \
(LOG)->log_printf((LOG)->user_data, NGTCP2_LOG_HD " " FMT, \
ngtcp2_log_timestamp(LOG), (LOG)->scid, \
ngtcp2_log_event_str(EV))
/**
* @function
*
* `ngtcp2_log_info` writes info level log. FMT should not contain
* formatting directive. This function exists to workaround the issue
* that __VA_ARGS__ cannot be empty.
*/
#define ngtcp2_log_info(LOG, EV, FMT) \
do { \
if (!(LOG)->log_printf || !((LOG)->events & (EV))) { \
break; \
} \
\
ngtcp2_log_info_raw((LOG), (EV), FMT); \
} while (0)
#endif /* !defined(NGTCP2_LOG_H) */
|
