1 #ifndef HEADER_CURL_TRC_H
2 #define HEADER_CURL_TRC_H
3 /***************************************************************************
4 * _ _ ____ _
5 * Project ___| | | | _ \| |
6 * / __| | | | |_) | |
7 * | (__| |_| | _ <| |___
8 * \___|\___/|_| \_\_____|
9 *
10 * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
11 *
12 * This software is licensed as described in the file COPYING, which
13 * you should have received as part of this distribution. The terms
14 * are also available at https://curl.se/docs/copyright.html.
15 *
16 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
17 * copies of the Software, and permit persons to whom the Software is
18 * furnished to do so, under the terms of the COPYING file.
19 *
20 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21 * KIND, either express or implied.
22 *
23 * SPDX-License-Identifier: curl
24 *
25 ***************************************************************************/
26
27 struct Curl_easy;
28 struct Curl_cfilter;
29
30 /**
31 * Init logging, return != 0 on failure.
32 */
33 CURLcode Curl_trc_init(void);
34
35 /**
36 * Configure tracing. May be called several times during global
37 * initialization. Later calls may not take effect.
38 *
39 * Configuration format supported:
40 * - comma-separated list of component names to enable logging on.
41 * E.g. 'http/2,ssl'. Unknown names are ignored. Names are compared
42 * case-insensitive.
43 * - component 'all' applies to all known log components
44 * - prefixing a component with '+' or '-' will en-/disable logging for
45 * that component
46 * Example: 'all,-ssl' would enable logging for all components but the
47 * SSL filters.
48 *
49 * @param config configuration string
50 */
51 CURLcode Curl_trc_opt(const char *config);
52
53 /* the function used to output verbose information */
54 void Curl_debug(struct Curl_easy *data, curl_infotype type,
55 char *ptr, size_t size);
56
57 /**
58 * Output a failure message on registered callbacks for transfer.
59 */
60 void Curl_failf(struct Curl_easy *data,
61 const char *fmt, ...) CURL_PRINTF(2, 3);
62
63 #define failf Curl_failf
64
65 #define CURL_LOG_LVL_NONE 0
66 #define CURL_LOG_LVL_INFO 1
67
68
69 #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
70 #define CURL_HAVE_C99
71 #endif
72
73 #ifdef CURL_HAVE_C99
74 #define infof(data, ...) \
75 do { if(Curl_trc_is_verbose(data)) \
76 Curl_infof(data, __VA_ARGS__); } while(0)
77 #define CURL_TRC_CF(data, cf, ...) \
78 do { if(Curl_trc_cf_is_verbose(cf, data)) \
79 Curl_trc_cf_infof(data, cf, __VA_ARGS__); } while(0)
80 #define CURL_TRC_WRITE(data, ...) \
81 do { if(Curl_trc_ft_is_verbose(data, &Curl_trc_feat_write)) \
82 Curl_trc_write(data, __VA_ARGS__); } while(0)
83 #define CURL_TRC_READ(data, ...) \
84 do { if(Curl_trc_ft_is_verbose(data, &Curl_trc_feat_read)) \
85 Curl_trc_read(data, __VA_ARGS__); } while(0)
86
87 #ifndef CURL_DISABLE_FTP
88 #define CURL_TRC_FTP(data, ...) \
89 do { if(Curl_trc_ft_is_verbose(data, &Curl_trc_feat_ftp)) \
90 Curl_trc_ftp(data, __VA_ARGS__); } while(0)
91 #endif /* !CURL_DISABLE_FTP */
92
93 #else /* CURL_HAVE_C99 */
94
95 #define infof Curl_infof
96 #define CURL_TRC_CF Curl_trc_cf_infof
97 #define CURL_TRC_WRITE Curl_trc_write
98 #define CURL_TRC_READ Curl_trc_read
99
100 #ifndef CURL_DISABLE_FTP
101 #define CURL_TRC_FTP Curl_trc_ftp
102 #endif
103
104 #endif /* !CURL_HAVE_C99 */
105
106 #ifndef CURL_DISABLE_VERBOSE_STRINGS
107 /* informational messages enabled */
108
109 struct curl_trc_feat {
110 const char *name;
111 int log_level;
112 };
113 extern struct curl_trc_feat Curl_trc_feat_read;
114 extern struct curl_trc_feat Curl_trc_feat_write;
115
116 #define Curl_trc_is_verbose(data) \
117 ((data) && (data)->set.verbose && \
118 (!(data)->state.feat || \
119 ((data)->state.feat->log_level >= CURL_LOG_LVL_INFO)))
120 #define Curl_trc_cf_is_verbose(cf, data) \
121 (Curl_trc_is_verbose(data) && \
122 (cf) && (cf)->cft->log_level >= CURL_LOG_LVL_INFO)
123 #define Curl_trc_ft_is_verbose(data, ft) \
124 (Curl_trc_is_verbose(data) && \
125 (ft)->log_level >= CURL_LOG_LVL_INFO)
126
127 /**
128 * Output an informational message when transfer's verbose logging is enabled.
129 */
130 void Curl_infof(struct Curl_easy *data,
131 const char *fmt, ...) CURL_PRINTF(2, 3);
132
133 /**
134 * Output an informational message when both transfer's verbose logging
135 * and connection filters verbose logging are enabled.
136 */
137 void Curl_trc_cf_infof(struct Curl_easy *data, struct Curl_cfilter *cf,
138 const char *fmt, ...) CURL_PRINTF(3, 4);
139 void Curl_trc_ft_infof(struct Curl_easy *data, struct curl_trc_feat *ft,
140 const char *fmt, ...) CURL_PRINTF(3, 4);
141 void Curl_trc_write(struct Curl_easy *data,
142 const char *fmt, ...) CURL_PRINTF(2, 3);
143 void Curl_trc_read(struct Curl_easy *data,
144 const char *fmt, ...) CURL_PRINTF(2, 3);
145
146 #ifndef CURL_DISABLE_FTP
147 extern struct curl_trc_feat Curl_trc_feat_ftp;
148 void Curl_trc_ftp(struct Curl_easy *data,
149 const char *fmt, ...) CURL_PRINTF(2, 3);
150 #endif
151
152
153 #else /* defined(CURL_DISABLE_VERBOSE_STRINGS) */
154 /* All informational messages are not compiled in for size savings */
155
156 #define Curl_trc_is_verbose(d) (FALSE)
157 #define Curl_trc_cf_is_verbose(x,y) (FALSE)
158 #define Curl_trc_ft_is_verbose(x,y) (FALSE)
159
Curl_infof(struct Curl_easy * data,const char * fmt,...)160 static void Curl_infof(struct Curl_easy *data, const char *fmt, ...)
161 {
162 (void)data; (void)fmt;
163 }
164
Curl_trc_cf_infof(struct Curl_easy * data,struct Curl_cfilter * cf,const char * fmt,...)165 static void Curl_trc_cf_infof(struct Curl_easy *data,
166 struct Curl_cfilter *cf,
167 const char *fmt, ...)
168 {
169 (void)data; (void)cf; (void)fmt;
170 }
171
172 struct curl_trc_feat;
173
Curl_trc_ft_infof(struct Curl_easy * data,struct curl_trc_feat * ft,const char * fmt,...)174 static void Curl_trc_ft_infof(struct Curl_easy *data,
175 struct curl_trc_feat *ft,
176 const char *fmt, ...)
177 {
178 (void)data; (void)ft; (void)fmt;
179 }
180
Curl_trc_write(struct Curl_easy * data,const char * fmt,...)181 static void Curl_trc_write(struct Curl_easy *data, const char *fmt, ...)
182 {
183 (void)data; (void)fmt;
184 }
185
Curl_trc_read(struct Curl_easy * data,const char * fmt,...)186 static void Curl_trc_read(struct Curl_easy *data, const char *fmt, ...)
187 {
188 (void)data; (void)fmt;
189 }
190
191 #ifndef CURL_DISABLE_FTP
Curl_trc_ftp(struct Curl_easy * data,const char * fmt,...)192 static void Curl_trc_ftp(struct Curl_easy *data, const char *fmt, ...)
193 {
194 (void)data; (void)fmt;
195 }
196 #endif
197
198 #endif /* !defined(CURL_DISABLE_VERBOSE_STRINGS) */
199
200 #endif /* HEADER_CURL_TRC_H */
201
