Mercurial

comparison third_party/wrk/src/http_parser.h @ 178:94705b5986b3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[ThirdParty] Added WRK and luajit for load testing.
author MrJuneJune <me@mrjunejune.com>
date Thu, 22 Jan 2026 20:10:30 -0800
parents
children
comparison
equal deleted inserted replaced
177:24fe8ff94056 178:94705b5986b3
1 /* Copyright Joyent, Inc. and other Node contributors. All rights reserved.
2 *
3 * Permission is hereby granted, free of charge, to any person obtaining a copy
4 * of this software and associated documentation files (the "Software"), to
5 * deal in the Software without restriction, including without limitation the
6 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
7 * sell copies of the Software, and to permit persons to whom the Software is
8 * furnished to do so, subject to the following conditions:
9 *
10 * The above copyright notice and this permission notice shall be included in
11 * all copies or substantial portions of the Software.
12 *
13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
18 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
19 * IN THE SOFTWARE.
20 */
21 #ifndef http_parser_h
22 #define http_parser_h
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26
27 /* Also update SONAME in the Makefile whenever you change these. */
28 #define HTTP_PARSER_VERSION_MAJOR 2
29 #define HTTP_PARSER_VERSION_MINOR 7
30 #define HTTP_PARSER_VERSION_PATCH 1
31
32 #include <stddef.h>
33 #if defined(_WIN32) && !defined(__MINGW32__) && \
34 (!defined(_MSC_VER) || _MSC_VER<1600) && !defined(__WINE__)
35 #include <BaseTsd.h>
36 typedef __int8 int8_t;
37 typedef unsigned __int8 uint8_t;
38 typedef __int16 int16_t;
39 typedef unsigned __int16 uint16_t;
40 typedef __int32 int32_t;
41 typedef unsigned __int32 uint32_t;
42 typedef __int64 int64_t;
43 typedef unsigned __int64 uint64_t;
44 #else
45 #include <stdint.h>
46 #endif
47
48 /* Compile with -DHTTP_PARSER_STRICT=0 to make less checks, but run
49 * faster
50 */
51 #ifndef HTTP_PARSER_STRICT
52 # define HTTP_PARSER_STRICT 1
53 #endif
54
55 /* Maximium header size allowed. If the macro is not defined
56 * before including this header then the default is used. To
57 * change the maximum header size, define the macro in the build
58 * environment (e.g. -DHTTP_MAX_HEADER_SIZE=<value>). To remove
59 * the effective limit on the size of the header, define the macro
60 * to a very large number (e.g. -DHTTP_MAX_HEADER_SIZE=0x7fffffff)
61 */
62 #ifndef HTTP_MAX_HEADER_SIZE
63 # define HTTP_MAX_HEADER_SIZE (80*1024)
64 #endif
65
66 typedef struct http_parser http_parser;
67 typedef struct http_parser_settings http_parser_settings;
68
69
70 /* Callbacks should return non-zero to indicate an error. The parser will
71 * then halt execution.
72 *
73 * The one exception is on_headers_complete. In a HTTP_RESPONSE parser
74 * returning '1' from on_headers_complete will tell the parser that it
75 * should not expect a body. This is used when receiving a response to a
76 * HEAD request which may contain 'Content-Length' or 'Transfer-Encoding:
77 * chunked' headers that indicate the presence of a body.
78 *
79 * Returning `2` from on_headers_complete will tell parser that it should not
80 * expect neither a body nor any futher responses on this connection. This is
81 * useful for handling responses to a CONNECT request which may not contain
82 * `Upgrade` or `Connection: upgrade` headers.
83 *
84 * http_data_cb does not return data chunks. It will be called arbitrarily
85 * many times for each string. E.G. you might get 10 callbacks for "on_url"
86 * each providing just a few characters more data.
87 */
88 typedef int (*http_data_cb) (http_parser*, const char *at, size_t length);
89 typedef int (*http_cb) (http_parser*);
90
91
92 /* Status Codes */
93 #define HTTP_STATUS_MAP(XX) \
94 XX(100, CONTINUE, Continue) \
95 XX(101, SWITCHING_PROTOCOLS, Switching Protocols) \
96 XX(102, PROCESSING, Processing) \
97 XX(200, OK, OK) \
98 XX(201, CREATED, Created) \
99 XX(202, ACCEPTED, Accepted) \
100 XX(203, NON_AUTHORITATIVE_INFORMATION, Non-Authoritative Information) \
101 XX(204, NO_CONTENT, No Content) \
102 XX(205, RESET_CONTENT, Reset Content) \
103 XX(206, PARTIAL_CONTENT, Partial Content) \
104 XX(207, MULTI_STATUS, Multi-Status) \
105 XX(208, ALREADY_REPORTED, Already Reported) \
106 XX(226, IM_USED, IM Used) \
107 XX(300, MULTIPLE_CHOICES, Multiple Choices) \
108 XX(301, MOVED_PERMANENTLY, Moved Permanently) \
109 XX(302, FOUND, Found) \
110 XX(303, SEE_OTHER, See Other) \
111 XX(304, NOT_MODIFIED, Not Modified) \
112 XX(305, USE_PROXY, Use Proxy) \
113 XX(307, TEMPORARY_REDIRECT, Temporary Redirect) \
114 XX(308, PERMANENT_REDIRECT, Permanent Redirect) \
115 XX(400, BAD_REQUEST, Bad Request) \
116 XX(401, UNAUTHORIZED, Unauthorized) \
117 XX(402, PAYMENT_REQUIRED, Payment Required) \
118 XX(403, FORBIDDEN, Forbidden) \
119 XX(404, NOT_FOUND, Not Found) \
120 XX(405, METHOD_NOT_ALLOWED, Method Not Allowed) \
121 XX(406, NOT_ACCEPTABLE, Not Acceptable) \
122 XX(407, PROXY_AUTHENTICATION_REQUIRED, Proxy Authentication Required) \
123 XX(408, REQUEST_TIMEOUT, Request Timeout) \
124 XX(409, CONFLICT, Conflict) \
125 XX(410, GONE, Gone) \
126 XX(411, LENGTH_REQUIRED, Length Required) \
127 XX(412, PRECONDITION_FAILED, Precondition Failed) \
128 XX(413, PAYLOAD_TOO_LARGE, Payload Too Large) \
129 XX(414, URI_TOO_LONG, URI Too Long) \
130 XX(415, UNSUPPORTED_MEDIA_TYPE, Unsupported Media Type) \
131 XX(416, RANGE_NOT_SATISFIABLE, Range Not Satisfiable) \
132 XX(417, EXPECTATION_FAILED, Expectation Failed) \
133 XX(421, MISDIRECTED_REQUEST, Misdirected Request) \
134 XX(422, UNPROCESSABLE_ENTITY, Unprocessable Entity) \
135 XX(423, LOCKED, Locked) \
136 XX(424, FAILED_DEPENDENCY, Failed Dependency) \
137 XX(426, UPGRADE_REQUIRED, Upgrade Required) \
138 XX(428, PRECONDITION_REQUIRED, Precondition Required) \
139 XX(429, TOO_MANY_REQUESTS, Too Many Requests) \
140 XX(431, REQUEST_HEADER_FIELDS_TOO_LARGE, Request Header Fields Too Large) \
141 XX(451, UNAVAILABLE_FOR_LEGAL_REASONS, Unavailable For Legal Reasons) \
142 XX(500, INTERNAL_SERVER_ERROR, Internal Server Error) \
143 XX(501, NOT_IMPLEMENTED, Not Implemented) \
144 XX(502, BAD_GATEWAY, Bad Gateway) \
145 XX(503, SERVICE_UNAVAILABLE, Service Unavailable) \
146 XX(504, GATEWAY_TIMEOUT, Gateway Timeout) \
147 XX(505, HTTP_VERSION_NOT_SUPPORTED, HTTP Version Not Supported) \
148 XX(506, VARIANT_ALSO_NEGOTIATES, Variant Also Negotiates) \
149 XX(507, INSUFFICIENT_STORAGE, Insufficient Storage) \
150 XX(508, LOOP_DETECTED, Loop Detected) \
151 XX(510, NOT_EXTENDED, Not Extended) \
152 XX(511, NETWORK_AUTHENTICATION_REQUIRED, Network Authentication Required) \
153
154 enum http_status
155 {
156 #define XX(num, name, string) HTTP_STATUS_##name = num,
157 HTTP_STATUS_MAP(XX)
158 #undef XX
159 };
160
161
162 /* Request Methods */
163 #define HTTP_METHOD_MAP(XX) \
164 XX(0, DELETE, DELETE) \
165 XX(1, GET, GET) \
166 XX(2, HEAD, HEAD) \
167 XX(3, POST, POST) \
168 XX(4, PUT, PUT) \
169 /* pathological */ \
170 XX(5, CONNECT, CONNECT) \
171 XX(6, OPTIONS, OPTIONS) \
172 XX(7, TRACE, TRACE) \
173 /* WebDAV */ \
174 XX(8, COPY, COPY) \
175 XX(9, LOCK, LOCK) \
176 XX(10, MKCOL, MKCOL) \
177 XX(11, MOVE, MOVE) \
178 XX(12, PROPFIND, PROPFIND) \
179 XX(13, PROPPATCH, PROPPATCH) \
180 XX(14, SEARCH, SEARCH) \
181 XX(15, UNLOCK, UNLOCK) \
182 XX(16, BIND, BIND) \
183 XX(17, REBIND, REBIND) \
184 XX(18, UNBIND, UNBIND) \
185 XX(19, ACL, ACL) \
186 /* subversion */ \
187 XX(20, REPORT, REPORT) \
188 XX(21, MKACTIVITY, MKACTIVITY) \
189 XX(22, CHECKOUT, CHECKOUT) \
190 XX(23, MERGE, MERGE) \
191 /* upnp */ \
192 XX(24, MSEARCH, M-SEARCH) \
193 XX(25, NOTIFY, NOTIFY) \
194 XX(26, SUBSCRIBE, SUBSCRIBE) \
195 XX(27, UNSUBSCRIBE, UNSUBSCRIBE) \
196 /* RFC-5789 */ \
197 XX(28, PATCH, PATCH) \
198 XX(29, PURGE, PURGE) \
199 /* CalDAV */ \
200 XX(30, MKCALENDAR, MKCALENDAR) \
201 /* RFC-2068, section 19.6.1.2 */ \
202 XX(31, LINK, LINK) \
203 XX(32, UNLINK, UNLINK) \
204
205 enum http_method
206 {
207 #define XX(num, name, string) HTTP_##name = num,
208 HTTP_METHOD_MAP(XX)
209 #undef XX
210 };
211
212
213 enum http_parser_type { HTTP_REQUEST, HTTP_RESPONSE, HTTP_BOTH };
214
215
216 /* Flag values for http_parser.flags field */
217 enum flags
218 { F_CHUNKED = 1 << 0
219 , F_CONNECTION_KEEP_ALIVE = 1 << 1
220 , F_CONNECTION_CLOSE = 1 << 2
221 , F_CONNECTION_UPGRADE = 1 << 3
222 , F_TRAILING = 1 << 4
223 , F_UPGRADE = 1 << 5
224 , F_SKIPBODY = 1 << 6
225 , F_CONTENTLENGTH = 1 << 7
226 };
227
228
229 /* Map for errno-related constants
230 *
231 * The provided argument should be a macro that takes 2 arguments.
232 */
233 #define HTTP_ERRNO_MAP(XX) \
234 /* No error */ \
235 XX(OK, "success") \
236 \
237 /* Callback-related errors */ \
238 XX(CB_message_begin, "the on_message_begin callback failed") \
239 XX(CB_url, "the on_url callback failed") \
240 XX(CB_header_field, "the on_header_field callback failed") \
241 XX(CB_header_value, "the on_header_value callback failed") \
242 XX(CB_headers_complete, "the on_headers_complete callback failed") \
243 XX(CB_body, "the on_body callback failed") \
244 XX(CB_message_complete, "the on_message_complete callback failed") \
245 XX(CB_status, "the on_status callback failed") \
246 XX(CB_chunk_header, "the on_chunk_header callback failed") \
247 XX(CB_chunk_complete, "the on_chunk_complete callback failed") \
248 \
249 /* Parsing-related errors */ \
250 XX(INVALID_EOF_STATE, "stream ended at an unexpected time") \
251 XX(HEADER_OVERFLOW, \
252 "too many header bytes seen; overflow detected") \
253 XX(CLOSED_CONNECTION, \
254 "data received after completed connection: close message") \
255 XX(INVALID_VERSION, "invalid HTTP version") \
256 XX(INVALID_STATUS, "invalid HTTP status code") \
257 XX(INVALID_METHOD, "invalid HTTP method") \
258 XX(INVALID_URL, "invalid URL") \
259 XX(INVALID_HOST, "invalid host") \
260 XX(INVALID_PORT, "invalid port") \
261 XX(INVALID_PATH, "invalid path") \
262 XX(INVALID_QUERY_STRING, "invalid query string") \
263 XX(INVALID_FRAGMENT, "invalid fragment") \
264 XX(LF_EXPECTED, "LF character expected") \
265 XX(INVALID_HEADER_TOKEN, "invalid character in header") \
266 XX(INVALID_CONTENT_LENGTH, \
267 "invalid character in content-length header") \
268 XX(UNEXPECTED_CONTENT_LENGTH, \
269 "unexpected content-length header") \
270 XX(INVALID_CHUNK_SIZE, \
271 "invalid character in chunk size header") \
272 XX(INVALID_CONSTANT, "invalid constant string") \
273 XX(INVALID_INTERNAL_STATE, "encountered unexpected internal state")\
274 XX(STRICT, "strict mode assertion failed") \
275 XX(PAUSED, "parser is paused") \
276 XX(UNKNOWN, "an unknown error occurred")
277
278
279 /* Define HPE_* values for each errno value above */
280 #define HTTP_ERRNO_GEN(n, s) HPE_##n,
281 enum http_errno {
282 HTTP_ERRNO_MAP(HTTP_ERRNO_GEN)
283 };
284 #undef HTTP_ERRNO_GEN
285
286
287 /* Get an http_errno value from an http_parser */
288 #define HTTP_PARSER_ERRNO(p) ((enum http_errno) (p)->http_errno)
289
290
291 struct http_parser {
292 /** PRIVATE **/
293 unsigned int type : 2; /* enum http_parser_type */
294 unsigned int flags : 8; /* F_* values from 'flags' enum; semi-public */
295 unsigned int state : 7; /* enum state from http_parser.c */
296 unsigned int header_state : 7; /* enum header_state from http_parser.c */
297 unsigned int index : 7; /* index into current matcher */
298 unsigned int lenient_http_headers : 1;
299
300 uint32_t nread; /* # bytes read in various scenarios */
301 uint64_t content_length; /* # bytes in body (0 if no Content-Length header) */
302
303 /** READ-ONLY **/
304 unsigned short http_major;
305 unsigned short http_minor;
306 unsigned int status_code : 16; /* responses only */
307 unsigned int method : 8; /* requests only */
308 unsigned int http_errno : 7;
309
310 /* 1 = Upgrade header was present and the parser has exited because of that.
311 * 0 = No upgrade header present.
312 * Should be checked when http_parser_execute() returns in addition to
313 * error checking.
314 */
315 unsigned int upgrade : 1;
316
317 /** PUBLIC **/
318 void *data; /* A pointer to get hook to the "connection" or "socket" object */
319 };
320
321
322 struct http_parser_settings {
323 http_cb on_message_begin;
324 http_data_cb on_url;
325 http_data_cb on_status;
326 http_data_cb on_header_field;
327 http_data_cb on_header_value;
328 http_cb on_headers_complete;
329 http_data_cb on_body;
330 http_cb on_message_complete;
331 /* When on_chunk_header is called, the current chunk length is stored
332 * in parser->content_length.
333 */
334 http_cb on_chunk_header;
335 http_cb on_chunk_complete;
336 };
337
338
339 enum http_parser_url_fields
340 { UF_SCHEMA = 0
341 , UF_HOST = 1
342 , UF_PORT = 2
343 , UF_PATH = 3
344 , UF_QUERY = 4
345 , UF_FRAGMENT = 5
346 , UF_USERINFO = 6
347 , UF_MAX = 7
348 };
349
350
351 /* Result structure for http_parser_parse_url().
352 *
353 * Callers should index into field_data[] with UF_* values iff field_set
354 * has the relevant (1 << UF_*) bit set. As a courtesy to clients (and
355 * because we probably have padding left over), we convert any port to
356 * a uint16_t.
357 */
358 struct http_parser_url {
359 uint16_t field_set; /* Bitmask of (1 << UF_*) values */
360 uint16_t port; /* Converted UF_PORT string */
361
362 struct {
363 uint16_t off; /* Offset into buffer in which field starts */
364 uint16_t len; /* Length of run in buffer */
365 } field_data[UF_MAX];
366 };
367
368
369 /* Returns the library version. Bits 16-23 contain the major version number,
370 * bits 8-15 the minor version number and bits 0-7 the patch level.
371 * Usage example:
372 *
373 * unsigned long version = http_parser_version();
374 * unsigned major = (version >> 16) & 255;
375 * unsigned minor = (version >> 8) & 255;
376 * unsigned patch = version & 255;
377 * printf("http_parser v%u.%u.%u\n", major, minor, patch);
378 */
379 unsigned long http_parser_version(void);
380
381 void http_parser_init(http_parser *parser, enum http_parser_type type);
382
383
384 /* Initialize http_parser_settings members to 0
385 */
386 void http_parser_settings_init(http_parser_settings *settings);
387
388
389 /* Executes the parser. Returns number of parsed bytes. Sets
390 * `parser->http_errno` on error. */
391 size_t http_parser_execute(http_parser *parser,
392 const http_parser_settings *settings,
393 const char *data,
394 size_t len);
395
396
397 /* If http_should_keep_alive() in the on_headers_complete or
398 * on_message_complete callback returns 0, then this should be
399 * the last message on the connection.
400 * If you are the server, respond with the "Connection: close" header.
401 * If you are the client, close the connection.
402 */
403 int http_should_keep_alive(const http_parser *parser);
404
405 /* Returns a string version of the HTTP method. */
406 const char *http_method_str(enum http_method m);
407
408 /* Return a string name of the given error */
409 const char *http_errno_name(enum http_errno err);
410
411 /* Return a string description of the given error */
412 const char *http_errno_description(enum http_errno err);
413
414 /* Initialize all http_parser_url members to 0 */
415 void http_parser_url_init(struct http_parser_url *u);
416
417 /* Parse a URL; return nonzero on failure */
418 int http_parser_parse_url(const char *buf, size_t buflen,
419 int is_connect,
420 struct http_parser_url *u);
421
422 /* Pause or un-pause the parser; a nonzero value pauses */
423 void http_parser_pause(http_parser *parser, int paused);
424
425 /* Checks if this is the final chunk of the body. */
426 int http_body_is_final(const http_parser *parser);
427
428 #ifdef __cplusplus
429 }
430 #endif
431 #endif