blob: 78e62a5008671287e855b26b6a3cbe5d6e0f88ec [file] [log] [blame]
Christopher Fauleta3d2a162018-10-22 08:59:39 +02001/*
Willy Tarreaub96b77e2018-12-11 10:22:41 +01002 * include/common/htx.h
Christopher Fauleta3d2a162018-10-22 08:59:39 +02003 * This file defines everything related to the internal HTTP messages.
4 *
5 * Copyright (C) 2018 HAProxy Technologies, Christopher Faulet <cfaulet@haproxy.com>
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation, version 2.1
10 * exclusively.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
Willy Tarreaub96b77e2018-12-11 10:22:41 +010022#ifndef _COMMON_HTX_H
23#define _COMMON_HTX_H
Christopher Fauleta3d2a162018-10-22 08:59:39 +020024
Willy Tarreaub96b77e2018-12-11 10:22:41 +010025#include <stdio.h>
Christopher Fauleta3d2a162018-10-22 08:59:39 +020026#include <common/buf.h>
27#include <common/config.h>
Willy Tarreaub96b77e2018-12-11 10:22:41 +010028#include <common/ist.h>
29#include <common/http.h>
Christopher Fauleta3d2a162018-10-22 08:59:39 +020030#include <common/http-hdr.h>
Willy Tarreaub96b77e2018-12-11 10:22:41 +010031#include <common/standard.h>
32
33/*
34 * The internal representation of an HTTP message is a contiguous array
35 * containing both the blocks (htx_blk) and their contents. Blocks are stored
36 * starting from the end of the array while their contents are stored at the
37 * beginning.
38 *
39 * As data are sent to the peer, blocks and contents are released at the
40 * edges. This free space is reused when no more space left. So blocks and
41 * contents may wrap, not necessarily the same time.
42 *
43 * An HTTP block is as well a header as a body part or a trailer part. For all
44 * these types of block, a content is attached to the block. It can also be a
45 * mark, like the end-of-headers or end-of-message. For these blocks, there is
46 * no content but it count for a byte. It is important to not skip it when data
47 * are forwarded. An HTTP block is composed of 2 fields:
48 *
49 * - .info : It a 32 bits field containing the block's type on 4 bits
50 * followed by content' length. See below for details.
51 *
52 * - .addr : The content's address, if any, relatively to the beginning the
53 * array used to store the HTTP message itself.
54 *
55 * htx_blk.info representation:
56 *
57 * 0b 0000 0000 0000 0000 0000 0000 0000 0000
58 * ---- ------------------------ ---------
59 * type value (1 MB max) name length (header)
60 * ----------------------------------
61 * data length (256 MB max)
62 * (body, method, path, version, status, reason, trailers)
63 *
64 * types:
65 * - 0000 = request start-line
66 * - 0001 = response start-line
67 * - 0010 = header
68 * - 0011 = pseudo-header ou "special" header
69 * - 0100 = end-of-headers
70 * - 0101 = data
71 * - 0110 = end-of-data
72 * - 0111 = trailer
73 * - 1000 = end-of-message
74 * ...
75 * - 1101 = out-of-band
76 * - 1110 = error
77 * - 1111 = unused
78 *
79 */
80
81/*HTX start-line flags */
82#define HTX_SL_F_NONE 0x00000000
83#define HTX_SL_F_IS_RESP 0x00000001 /* It is the response start-line (unset means the request one) */
84#define HTX_SL_F_XFER_LEN 0x00000002 /* The message xfer size can be dertermined */
85#define HTX_SL_F_XFER_ENC 0x00000004 /* The transfer-encoding header was found in message */
86#define HTX_SL_F_CLEN 0x00000008 /* The content-length header was found in message */
87#define HTX_SL_F_CHNK 0x00000010 /* The message payload is chunked */
88#define HTX_SL_F_VER_11 0x00000020 /* The message indicates version 1.1 or above */
89#define HTX_SL_F_BODYLESS 0x00000040 /* The message has no body (content-length = 0) */
90
91/* HTX flags */
92#define HTX_FL_NONE 0x00000000
93#define HTX_FL_PARSING_ERROR 0x00000001
Christopher Faulet0ef372a2019-04-08 10:57:20 +020094#define HTX_FL_UPGRADE 0x00000002
Willy Tarreaub96b77e2018-12-11 10:22:41 +010095
96
97/* Pseudo header types (max 255). */
98enum htx_phdr_type {
99 HTX_PHDR_UNKNOWN = 0,
100 HTX_PHDR_SIZE,
101};
102
103/* HTTP block's type (max 15). */
104enum htx_blk_type {
105 HTX_BLK_REQ_SL = 0, /* Request start-line */
106 HTX_BLK_RES_SL = 1, /* Response start-line */
107 HTX_BLK_HDR = 2, /* header name/value block */
108 HTX_BLK_PHDR = 3, /* pseudo header block */
109 HTX_BLK_EOH = 4, /* end-of-headers block */
110 HTX_BLK_DATA = 5, /* data block */
111 HTX_BLK_EOD = 6, /* end-of-data block */
112 HTX_BLK_TLR = 7, /* trailer name/value block */
113 HTX_BLK_EOM = 8, /* end-of-message block */
Christopher Faulet6f3cb182019-05-07 21:48:12 +0200114 /* 9 .. 14 unused */
Willy Tarreaub96b77e2018-12-11 10:22:41 +0100115 HTX_BLK_UNUSED = 15, /* unused/removed block */
116};
117
118/* One HTTP block descriptor */
119struct htx_blk {
120 uint32_t addr; /* relative storage address of a data block */
121 uint32_t info; /* information about data stored */
122};
123
124struct htx_ret {
125 int32_t ret;
126 struct htx_blk *blk;
127};
128
129struct htx_sl {
130 unsigned int flags; /* HTX_SL_F_* */
131 union {
132 struct {
133 enum http_meth_t meth; /* method */
134 } req;
135 struct {
136 uint16_t status; /* status code */
137 } res;
138 } info;
139
140 /* XXX 2 bytes unused */
141
142 unsigned int len[3]; /* length of differnt parts of the start-line */
143 char l[0];
144};
145
146/* Internal representation of an HTTP message */
147struct htx {
148 uint32_t size; /* the array size, in bytes, used to store the HTTP message itself */
149 uint32_t data; /* the data size, in bytes. To known to total size used by all allocated
150 * blocks (blocks and their contents), you need to add size used by blocks,
151 * i.e. [ used * sizeof(struct htx_blk *) ] */
152
153 uint32_t used; /* number of blocks in use */
154 uint32_t tail; /* last inserted block */
155 uint32_t front; /* block's position of the first content before the blocks table */
156 uint32_t wrap; /* the position were the blocks table wraps, if any */
157
158 uint64_t extra; /* known bytes amount remaining to receive */
159 uint32_t flags; /* HTX_FL_* */
160
161 int32_t sl_off; /* Offset of the start-line of the HTTP message relatively to the beginning the
162 data block. -1 if unset */
163
164 struct htx_blk blocks[0]; /* Blocks representing the HTTP message itself */
165};
166
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200167
168extern struct htx htx_empty;
169
170struct htx_blk *htx_defrag(struct htx *htx, struct htx_blk *blk);
171struct htx_blk *htx_add_blk(struct htx *htx, enum htx_blk_type type, uint32_t blksz);
172struct htx_blk *htx_remove_blk(struct htx *htx, struct htx_blk *blk);
Christopher Faulet00cf6972019-01-07 14:53:27 +0100173void htx_truncate(struct htx *htx, uint32_t offset);
Christopher Faulet549822f2019-02-25 10:23:19 +0100174struct htx_ret htx_drain(struct htx *htx, uint32_t max);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200175
176struct htx_blk *htx_replace_blk_value(struct htx *htx, struct htx_blk *blk,
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100177 const struct ist old, const struct ist new);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200178struct htx_ret htx_xfer_blks(struct htx *dst, struct htx *src, uint32_t count,
179 enum htx_blk_type mark);
180
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100181struct htx_sl *htx_add_stline(struct htx *htx, enum htx_blk_type type, unsigned int flags,
182 const struct ist p1, const struct ist p2, const struct ist p3);
183struct htx_sl *htx_replace_stline(struct htx *htx, struct htx_blk *blk, const struct ist p1,
184 const struct ist p2, const struct ist p3);
185
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200186struct htx_blk *htx_replace_header(struct htx *htx, struct htx_blk *blk,
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100187 const struct ist name, const struct ist value);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200188
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200189struct htx_blk *htx_add_header(struct htx *htx, const struct ist name, const struct ist value);
Willy Tarreau52610e92019-01-03 18:26:17 +0100190struct htx_blk *htx_add_blk_type_size(struct htx *htx, enum htx_blk_type type, uint32_t blksz);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200191struct htx_blk *htx_add_all_headers(struct htx *htx, const struct http_hdr *hdrs);
192struct htx_blk *htx_add_pseudo_header(struct htx *htx, enum htx_phdr_type phdr, const struct ist value);
193struct htx_blk *htx_add_endof(struct htx *htx, enum htx_blk_type type);
194struct htx_blk *htx_add_data(struct htx *htx, const struct ist data);
195struct htx_blk *htx_add_trailer(struct htx *htx, const struct ist tlr);
Christopher Faulet24ed8352018-11-22 11:20:43 +0100196struct htx_blk *htx_add_data_before(struct htx *htx, const struct htx_blk *ref, const struct ist data);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200197
Christopher Fauletc59ff232018-12-03 13:58:44 +0100198int htx_reqline_to_h1(const struct htx_sl *sl, struct buffer *chk);
199int htx_stline_to_h1(const struct htx_sl *sl, struct buffer *chk);
200int htx_hdr_to_h1(const struct ist n, const struct ist v, struct buffer *chk);
201int htx_data_to_h1(const struct ist data, struct buffer *chk, int chunked);
202int htx_trailer_to_h1(const struct ist tlr, struct buffer *chk);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200203
Christopher Faulet570d1612018-11-26 11:13:57 +0100204/* Functions and macros to get parts of the start-line or legnth of these
205 * parts
206 */
207#define HTX_SL_LEN(sl) ((sl)->len[0] + (sl)->len[1] + (sl)->len[2])
208
209#define HTX_SL_P1_LEN(sl) ((sl)->len[0])
210#define HTX_SL_P2_LEN(sl) ((sl)->len[1])
211#define HTX_SL_P3_LEN(sl) ((sl)->len[2])
212#define HTX_SL_P1_PTR(sl) ((sl)->l)
213#define HTX_SL_P2_PTR(sl) (HTX_SL_P1_PTR(sl) + HTX_SL_P1_LEN(sl))
214#define HTX_SL_P3_PTR(sl) (HTX_SL_P2_PTR(sl) + HTX_SL_P2_LEN(sl))
215
216#define HTX_SL_REQ_MLEN(sl) HTX_SL_P1_LEN(sl)
217#define HTX_SL_REQ_ULEN(sl) HTX_SL_P2_LEN(sl)
218#define HTX_SL_REQ_VLEN(sl) HTX_SL_P3_LEN(sl)
219#define HTX_SL_REQ_MPTR(sl) HTX_SL_P1_PTR(sl)
220#define HTX_SL_REQ_UPTR(sl) HTX_SL_P2_PTR(sl)
221#define HTX_SL_REQ_VPTR(sl) HTX_SL_P3_PTR(sl)
222
223#define HTX_SL_RES_VLEN(sl) HTX_SL_P1_LEN(sl)
224#define HTX_SL_RES_CLEN(sl) HTX_SL_P2_LEN(sl)
225#define HTX_SL_RES_RLEN(sl) HTX_SL_P3_LEN(sl)
226#define HTX_SL_RES_VPTR(sl) HTX_SL_P1_PTR(sl)
227#define HTX_SL_RES_CPTR(sl) HTX_SL_P2_PTR(sl)
228#define HTX_SL_RES_RPTR(sl) HTX_SL_P3_PTR(sl)
229
Willy Tarreau8de1df92019-04-15 21:27:18 +0200230static inline struct ist htx_sl_p1(const struct htx_sl *sl)
Willy Tarreaub96b77e2018-12-11 10:22:41 +0100231{
232 return ist2(HTX_SL_P1_PTR(sl), HTX_SL_P1_LEN(sl));
233}
Christopher Faulet570d1612018-11-26 11:13:57 +0100234
Willy Tarreau8de1df92019-04-15 21:27:18 +0200235static inline struct ist htx_sl_p2(const struct htx_sl *sl)
Christopher Faulet570d1612018-11-26 11:13:57 +0100236{
237 return ist2(HTX_SL_P2_PTR(sl), HTX_SL_P2_LEN(sl));
238}
239
Willy Tarreau8de1df92019-04-15 21:27:18 +0200240static inline struct ist htx_sl_p3(const struct htx_sl *sl)
Christopher Faulet570d1612018-11-26 11:13:57 +0100241{
242 return ist2(HTX_SL_P3_PTR(sl), HTX_SL_P3_LEN(sl));
243}
244
Willy Tarreau8de1df92019-04-15 21:27:18 +0200245static inline struct ist htx_sl_req_meth(const struct htx_sl *sl)
Christopher Faulet570d1612018-11-26 11:13:57 +0100246{
247 return htx_sl_p1(sl);
248}
249
Willy Tarreau8de1df92019-04-15 21:27:18 +0200250static inline struct ist htx_sl_req_uri(const struct htx_sl *sl)
Christopher Faulet570d1612018-11-26 11:13:57 +0100251{
252 return htx_sl_p2(sl);
253}
254
Willy Tarreau8de1df92019-04-15 21:27:18 +0200255static inline struct ist htx_sl_req_vsn(const struct htx_sl *sl)
Christopher Faulet570d1612018-11-26 11:13:57 +0100256{
257 return htx_sl_p3(sl);
258}
259
260
Willy Tarreau8de1df92019-04-15 21:27:18 +0200261static inline struct ist htx_sl_res_vsn(const struct htx_sl *sl)
Christopher Faulet570d1612018-11-26 11:13:57 +0100262{
263 return htx_sl_p1(sl);
264}
265
Willy Tarreau8de1df92019-04-15 21:27:18 +0200266static inline struct ist htx_sl_res_code(const struct htx_sl *sl)
Christopher Faulet570d1612018-11-26 11:13:57 +0100267{
268 return htx_sl_p2(sl);
269}
270
Willy Tarreau8de1df92019-04-15 21:27:18 +0200271static inline struct ist htx_sl_res_reason(const struct htx_sl *sl)
Christopher Faulet570d1612018-11-26 11:13:57 +0100272{
273 return htx_sl_p3(sl);
274}
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200275
Christopher Faulet54483df2018-11-26 15:05:52 +0100276/* Returns the HTX start-line if set, otherwise it returns NULL. */
277static inline struct htx_sl *htx_get_stline(struct htx *htx)
278{
279 struct htx_sl *sl = NULL;
280
Christopher Faulet3a4d1be2019-04-17 15:08:42 +0200281 if (htx->used && htx->sl_off != -1)
Christopher Faulet54483df2018-11-26 15:05:52 +0100282 sl = ((void *)htx->blocks + htx->sl_off);
283
284 return sl;
285}
286
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200287/* Returns the array index of a block given its position <pos> */
288static inline uint32_t htx_pos_to_idx(const struct htx *htx, uint32_t pos)
289{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100290 return ((htx->size / sizeof(htx->blocks[0])) - pos - 1);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200291}
292
293/* Returns the position of the block <blk> */
294static inline uint32_t htx_get_blk_pos(const struct htx *htx, const struct htx_blk *blk)
295{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100296 return (htx->blocks + (htx->size / sizeof(htx->blocks[0])) - blk - 1);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200297}
298
299/* Returns the block at the position <pos> */
300static inline struct htx_blk *htx_get_blk(const struct htx *htx, uint32_t pos)
301{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100302 return ((struct htx_blk *)(htx->blocks) + htx_pos_to_idx(htx, pos));
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200303}
304
305/* Returns the type of the block <blk> */
306static inline enum htx_blk_type htx_get_blk_type(const struct htx_blk *blk)
307{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100308 return (blk->info >> 28);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200309}
310
311/* Returns the pseudo-header type of the block <blk>. If it's not a
312 * pseudo-header, HTX_PHDR_UNKNOWN is returned.
313 */
314static inline enum htx_phdr_type htx_get_blk_phdr(const struct htx_blk *blk)
315{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100316 enum htx_blk_type type = htx_get_blk_type(blk);
317 enum htx_phdr_type phdr;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200318
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100319 switch (type) {
320 case HTX_BLK_PHDR:
321 phdr = (blk->info & 0xff);
322 return phdr;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200323
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100324 default:
325 /* Not a pseudo-header */
326 return HTX_PHDR_UNKNOWN;
327 }
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200328}
329
330/* Returns the size of the block <blk>, depending of its type */
331static inline uint32_t htx_get_blksz(const struct htx_blk *blk)
332{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100333 enum htx_blk_type type = htx_get_blk_type(blk);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200334
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100335 switch (type) {
336 case HTX_BLK_HDR:
337 /* name.length + value.length */
338 return ((blk->info & 0xff) + ((blk->info >> 8) & 0xfffff));
339 case HTX_BLK_PHDR:
340 /* value.length */
341 return ((blk->info >> 8) & 0xfffff);
342 default:
343 /* value.length */
344 return (blk->info & 0xfffffff);
345 }
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200346}
347
348/* Returns the position of the oldest entry (head).
349 *
350 * An signed 32-bits integer is returned to handle -1 case. Blocks position are
351 * store on unsigned 32-bits integer, but it is impossible to have so much
352 * blocks to overflow a 32-bits signed integer !
353 */
354static inline int32_t htx_get_head(const struct htx *htx)
355{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100356 if (!htx->used)
357 return -1;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200358
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100359 return (((htx->tail + 1U < htx->used) ? htx->wrap : 0) + htx->tail + 1U - htx->used);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200360}
361
362/* Returns the oldest HTX block (head) if the HTX message is not
363 * empty. Otherwise it returns NULL.
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100364 */
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200365static inline struct htx_blk *htx_get_head_blk(const struct htx *htx)
366{
367 int32_t head = htx_get_head(htx);
368
369 return ((head == -1) ? NULL : htx_get_blk(htx, head));
370}
371
372/* Returns the type of the oldest HTX block (head) if the HTX message is not
373 * empty. Otherwise it returns HTX_BLK_UNUSED.
374 */
375static inline enum htx_blk_type htx_get_head_type(const struct htx *htx)
376{
377 struct htx_blk *blk = htx_get_head_blk(htx);
378
379 return (blk ? htx_get_blk_type(blk) : HTX_BLK_UNUSED);
380}
381
382/* Returns the position of the newest entry (tail).
383 *
384 * An signed 32-bits integer is returned to handle -1 case. Blocks position are
385 * store on unsigned 32-bits integer, but it is impossible to have so much
386 * blocks to overflow a 32-bits signed integer !
387 */
388static inline int32_t htx_get_tail(const struct htx *htx)
389{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100390 return (htx->used ? htx->tail : -1);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200391}
392
393/* Returns the newest HTX block (tail) if the HTX message is not
394 * empty. Otherwise it returns NULL.
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100395 */
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200396static inline struct htx_blk *htx_get_tail_blk(const struct htx *htx)
397{
398 int32_t tail = htx_get_tail(htx);
399
400 return ((tail == -1) ? NULL : htx_get_blk(htx, tail));
401}
402
403/* Returns the type of the newest HTX block (tail) if the HTX message is not
404 * empty. Otherwise it returns HTX_BLK_UNUSED.
405 */
406static inline enum htx_blk_type htx_get_tail_type(const struct htx *htx)
407{
408 struct htx_blk *blk = htx_get_tail_blk(htx);
409
410 return (blk ? htx_get_blk_type(blk) : HTX_BLK_UNUSED);
411}
412
Joseph Herlantc42c0e92018-11-25 10:43:27 -0800413/* Returns the position of block immediately before the one pointed by <pos>. If
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200414 * the message is empty or if <pos> is the position of the head, -1 returned.
415 *
416 * An signed 32-bits integer is returned to handle -1 case. Blocks position are
417 * store on unsigned 32-bits integer, but it is impossible to have so much
418 * blocks to overflow a 32-bits signed integer !
419 */
420static inline int32_t htx_get_prev(const struct htx *htx, uint32_t pos)
421{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100422 int32_t head;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200423
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100424 head = htx_get_head(htx);
425 if (head == -1 || pos == head)
426 return -1;
427 if (!pos)
428 return (htx->wrap - 1);
429 return (pos - 1);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200430}
431
Christopher Fauletd16b0a72018-11-22 11:23:23 +0100432/* Returns the HTX block before <blk> in the HTX message <htx>. If <blk> is the
433 * head, NULL returned.
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100434 */
Christopher Fauletd16b0a72018-11-22 11:23:23 +0100435static inline struct htx_blk *htx_get_prev_blk(const struct htx *htx,
436 const struct htx_blk *blk)
437{
438 int32_t pos;
439
440 pos = htx_get_prev(htx, htx_get_blk_pos(htx, blk));
441 return ((pos == -1) ? NULL : htx_get_blk(htx, pos));
442}
443
Joseph Herlantc42c0e92018-11-25 10:43:27 -0800444/* Returns the position of block immediately after the one pointed by <pos>. If
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200445 * the message is empty or if <pos> is the position of the tail, -1 returned.
446 *
447 * An signed 32-bits integer is returned to handle -1 case. Blocks position are
448 * store on unsigned 32-bits integer, but it is impossible to have so much
449 * blocks to overflow a 32-bits signed integer !
450 */
451static inline int32_t htx_get_next(const struct htx *htx, uint32_t pos)
452{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100453 if (!htx->used)
454 return -1;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200455
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100456 if (pos == htx->tail)
457 return -1;
458 pos++;
459 if (pos >= htx->wrap)
460 pos = 0;
461 return pos;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200462
463}
Christopher Fauletd16b0a72018-11-22 11:23:23 +0100464
465/* Returns the HTX block after <blk> in the HTX message <htx>. If <blk> is the
466 * tail, NULL returned.
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100467 */
Christopher Fauletd16b0a72018-11-22 11:23:23 +0100468static inline struct htx_blk *htx_get_next_blk(const struct htx *htx,
469 const struct htx_blk *blk)
470{
471 int32_t pos;
472
473 pos = htx_get_next(htx, htx_get_blk_pos(htx, blk));
474 return ((pos == -1) ? NULL : htx_get_blk(htx, pos));
475}
476
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200477static inline int32_t htx_find_front(const struct htx *htx)
478{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100479 int32_t front, pos;
480 uint32_t addr = 0;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200481
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100482 if (!htx->used)
483 return -1;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200484
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100485 front = -1;
486 for (pos = htx_get_head(htx); pos != -1; pos = htx_get_next(htx, pos)) {
487 struct htx_blk *blk = htx_get_blk(htx, pos);
488 enum htx_blk_type type = htx_get_blk_type(blk);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200489
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100490 if (type != HTX_BLK_UNUSED && blk->addr >= addr) {
491 front = pos;
492 addr = blk->addr;
493 }
494 }
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200495
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100496 return front;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200497}
498
Christopher Faulet14e88252018-11-22 11:28:18 +0100499/* Returns the HTX block containing data with the <offset>, relatively to the
500 * beginning of the HTX message <htx>. It returns an htx_ret. if the HTX block is
501 * not found, htx_ret.blk is set to NULL. Otherwise, it points to the right HTX
502 * block and htx_ret.ret is set to the remaining offset inside the block.
503 */
504static inline struct htx_ret htx_find_blk(const struct htx *htx, uint32_t offset)
505{
506 int32_t pos;
507
508 for (pos = htx_get_head(htx); pos != -1; pos = htx_get_next(htx, pos)) {
509 struct htx_blk *blk = htx_get_blk(htx, pos);
510 uint32_t sz = htx_get_blksz(blk);
511
512 if (offset < sz)
513 return (struct htx_ret){ .blk = blk, .ret = offset };
514 offset -= sz;
515 }
516
517 return (struct htx_ret){ .blk = NULL };
518}
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200519/* Changes the size of the value. It is the caller responsibility to change the
520 * value itself, make sure there is enough space and update allocated value.
521 */
522static inline void htx_set_blk_value_len(struct htx_blk *blk, uint32_t vlen)
523{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100524 enum htx_blk_type type = htx_get_blk_type(blk);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200525
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100526 switch (type) {
527 case HTX_BLK_HDR:
528 case HTX_BLK_PHDR:
529 blk->info = (type << 28) + (vlen << 8) + (blk->info & 0xff);
530 break;
531 case HTX_BLK_REQ_SL:
532 case HTX_BLK_RES_SL:
533 case HTX_BLK_DATA:
534 case HTX_BLK_TLR:
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100535 blk->info = (type << 28) + vlen;
536 break;
537 default:
538 /* Unexpected case */
539 break;
540 }
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200541}
542
543/* Returns the data pointer of the block <blk> */
544static inline void *htx_get_blk_ptr(const struct htx *htx, const struct htx_blk *blk)
545{
546 return ((void *)htx->blocks + blk->addr);
547}
548
549/* Returns the name of the block <blk>, only if it is a header. Otherwise it
550 * returns an empty name.
551 */
552static inline struct ist htx_get_blk_name(const struct htx *htx, const struct htx_blk *blk)
553{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100554 enum htx_blk_type type = htx_get_blk_type(blk);
555 struct ist ret;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200556
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100557 switch (type) {
558 case HTX_BLK_HDR:
559 ret.ptr = htx_get_blk_ptr(htx, blk);
560 ret.len = blk->info & 0xff;
561 break;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200562
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100563 default:
564 return ist("");
565 }
566 return ret;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200567}
568
Christopher Faulet54483df2018-11-26 15:05:52 +0100569
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200570/* Returns the value of the block <blk>, depending on its type. If there is no
571 * value, an empty one is retruned.
572 */
573static inline struct ist htx_get_blk_value(const struct htx *htx, const struct htx_blk *blk)
574{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100575 enum htx_blk_type type = htx_get_blk_type(blk);
576 struct ist ret;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200577
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100578 switch (type) {
579 case HTX_BLK_HDR:
580 ret.ptr = htx_get_blk_ptr(htx, blk) + (blk->info & 0xff);
581 ret.len = (blk->info >> 8) & 0xfffff;
582 break;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200583
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100584 case HTX_BLK_PHDR:
585 ret.ptr = htx_get_blk_ptr(htx, blk);
586 ret.len = (blk->info >> 8) & 0xfffff;
587 break;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200588
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100589 case HTX_BLK_REQ_SL:
590 case HTX_BLK_RES_SL:
591 case HTX_BLK_DATA:
592 case HTX_BLK_TLR:
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100593 ret.ptr = htx_get_blk_ptr(htx, blk);
594 ret.len = blk->info & 0xfffffff;
595 break;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200596
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100597 default:
598 return ist("");
599 }
600 return ret;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200601}
602
Willy Tarreauc01ed9f2018-11-30 14:29:31 +0100603/* Removes <n> bytes from the beginning of DATA block <blk>. The block's start
604 * address and its length are adjusted, and the htx's total data count is
605 * updated. This is used to mark that part of some data were transfered
606 * from a DATA block without removing this DATA block. No sanity check is
607 * performed, the caller is reponsible for doing this exclusively on DATA
608 * blocks, and never removing more than the block's size.
609 */
610static inline void htx_cut_data_blk(struct htx *htx, struct htx_blk *blk, uint32_t n)
611{
612 blk->addr += n;
613 blk->info -= n;
614 htx->data -= n;
615}
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200616
617/* Returns the space used by metadata in <htx>. */
618static inline uint32_t htx_meta_space(const struct htx *htx)
619{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100620 return (htx->used * sizeof(htx->blocks[0]));
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200621}
622
623/* Returns the space used (data + metadata) in <htx> */
624static inline uint32_t htx_used_space(const struct htx *htx)
625{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100626 return (htx->data + htx_meta_space(htx));
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200627}
628
629/* Returns the free space in <htx> */
630static inline uint32_t htx_free_space(const struct htx *htx)
631{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100632 return (htx->size - htx_used_space(htx));
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200633}
634
Christopher Faulet8564c1f2019-01-07 13:48:55 +0100635/* Returns the maximum space usable for data in <htx>. This is in fact the
636 * maximum sice for a uniq block to fill the HTX message. */
637static inline uint32_t htx_max_data_space(const struct htx *htx)
638{
639 if (!htx->size)
640 return 0;
641 return (htx->size - sizeof(htx->blocks[0]));
642}
643
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200644/* Returns the maximum size available to store some data in <htx> if a new block
645 * is reserved.
646 */
647static inline uint32_t htx_free_data_space(const struct htx *htx)
648{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100649 uint32_t free = htx_free_space(htx);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200650
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100651 if (free < sizeof(htx->blocks[0]))
652 return 0;
653 return (free - sizeof(htx->blocks[0]));
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200654}
655
656/* Returns 1 if the message has less than 1/4 of its capacity free, otherwise 0 */
657static inline int htx_almost_full(const struct htx *htx)
658{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100659 if (!htx->size || htx_free_space(htx) < htx->size / 4)
660 return 1;
661 return 0;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200662}
663
664static inline void htx_reset(struct htx *htx)
665{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100666 htx->data = htx->used = htx->tail = htx->wrap = htx->front = 0;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200667 htx->extra = 0;
668 htx->flags = HTX_FL_NONE;
Christopher Faulet54483df2018-11-26 15:05:52 +0100669 htx->sl_off = -1;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200670}
671
Willy Tarreau3906e222018-12-05 07:56:25 +0100672/* returns the available room for raw data in buffer <buf> once HTX overhead is
673 * taken into account (one HTX header and two blocks). The purpose is to figure
674 * the optimal fill length to avoid copies.
675 */
676static inline size_t buf_room_for_htx_data(const struct buffer *buf)
677{
678 size_t room;
679
680 room = b_room(buf);
681 if (room <= sizeof(struct htx) + 2 * sizeof(struct htx_blk))
682 room = 0;
683 else
684 room -= sizeof(struct htx) + 2 * sizeof(struct htx_blk);
685
686 return room;
687}
688
Christopher Faulet27ba2dc2018-12-05 11:53:24 +0100689
690/* Returns an HTX message using the buffer <buf>. Unlike htx_from_buf(), this
Willy Tarreau245d1892019-01-31 07:21:42 +0100691 * function does not update to the buffer.
692 * Note that it always returns a valid pointer, either to an initialized buffer
693 * or to the empty buffer.
694 */
Christopher Faulet27ba2dc2018-12-05 11:53:24 +0100695static inline struct htx *htxbuf(const struct buffer *buf)
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200696{
Christopher Faulet27ba2dc2018-12-05 11:53:24 +0100697 struct htx *htx;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200698
Christopher Faulet27ba2dc2018-12-05 11:53:24 +0100699 if (b_is_null(buf))
700 return &htx_empty;
701 htx = ((struct htx *)(buf->area));
702 if (!b_data(buf)) {
Willy Tarreau8ae42352018-12-05 09:47:34 +0100703 htx->size = buf->size - sizeof(*htx);
Christopher Faulet27ba2dc2018-12-05 11:53:24 +0100704 htx_reset(htx);
Willy Tarreau8ae42352018-12-05 09:47:34 +0100705 }
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200706 return htx;
707}
708
Christopher Faulet27ba2dc2018-12-05 11:53:24 +0100709/* Returns an HTX message using the buffer <buf>. <buf> is updated to appear as
710 * full. It is the caller responsibility to call htx_to_buf() when it finish to
Willy Tarreau245d1892019-01-31 07:21:42 +0100711 * manipulate the HTX message to update <buf> accordingly. The returned pointer
712 * is always valid.
Christopher Faulet27ba2dc2018-12-05 11:53:24 +0100713 *
Willy Tarreau245d1892019-01-31 07:21:42 +0100714 * The caller can call htxbuf() function to avoid any update of the buffer.
Christopher Faulet27ba2dc2018-12-05 11:53:24 +0100715 */
716static inline struct htx *htx_from_buf(struct buffer *buf)
717{
718 struct htx *htx = htxbuf(buf);
719
720 b_set_data(buf, b_size(buf));
721 return htx;
722}
723
724/* Upate <buf> accordingly to the HTX message <htx> */
725static inline void htx_to_buf(struct htx *htx, struct buffer *buf)
726{
Christopher Faulet0ef372a2019-04-08 10:57:20 +0200727 if (!htx->used && !(htx->flags & (HTX_FL_PARSING_ERROR|HTX_FL_UPGRADE))) {
Christopher Faulet27ba2dc2018-12-05 11:53:24 +0100728 htx_reset(htx);
729 b_set_data(buf, 0);
730 }
731 else
732 b_set_data(buf, b_size(buf));
733}
734
Willy Tarreaue5fcfbe2019-01-31 07:31:18 +0100735/* Returns 1 if the message is empty, otherwise it returns 0. Note that it is
736 * illegal to call this with htx == NULL.
737 */
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200738static inline int htx_is_empty(const struct htx *htx)
739{
Willy Tarreaue5fcfbe2019-01-31 07:31:18 +0100740 return !htx->used;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200741}
742
Willy Tarreaue5fcfbe2019-01-31 07:31:18 +0100743/* Returns 1 if the message is not empty, otherwise it returns 0. Note that it
744 * is illegal to call this with htx == NULL.
745 */
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200746static inline int htx_is_not_empty(const struct htx *htx)
747{
Willy Tarreaue5fcfbe2019-01-31 07:31:18 +0100748 return htx->used;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200749}
750
751/* For debugging purpose */
752static inline const char *htx_blk_type_str(enum htx_blk_type type)
753{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100754 switch (type) {
755 case HTX_BLK_REQ_SL: return "HTX_BLK_REQ_SL";
756 case HTX_BLK_RES_SL: return "HTX_BLK_RES_SL";
757 case HTX_BLK_HDR: return "HTX_BLK_HDR";
758 case HTX_BLK_PHDR: return "HTX_BLK_PHDR";
759 case HTX_BLK_EOH: return "HTX_BLK_EOH";
760 case HTX_BLK_DATA: return "HTX_BLK_DATA";
761 case HTX_BLK_EOD: return "HTX_BLK_EOD";
762 case HTX_BLK_TLR: return "HTX_BLK_TLR";
763 case HTX_BLK_EOM: return "HTX_BLK_EOM";
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100764 case HTX_BLK_UNUSED: return "HTX_BLK_UNUSED";
765 default: return "HTX_BLK_???";
766 };
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200767}
768
769static inline const char *htx_blk_phdr_str(enum htx_phdr_type phdr)
770{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100771 switch (phdr) {
772 case HTX_PHDR_UNKNOWN: return "HTX_PHDR_UNKNOWN";
773 default: return "HTX_PHDR_???";
774 }
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200775}
776
777static inline void htx_dump(struct htx *htx)
778{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100779 int32_t pos;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200780
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100781 fprintf(stderr, "htx:%p [ size=%u - data=%u - used=%u - wrap=%s - extra=%llu]\n",
782 htx, htx->size, htx->data, htx->used,
783 (!htx->used || htx->tail+1 == htx->wrap) ? "NO" : "YES",
Willy Tarreaua7280a12018-11-26 19:41:40 +0100784 (unsigned long long)htx->extra);
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100785 fprintf(stderr, "\thead=%d - tail=%u - front=%u - wrap=%u\n",
786 htx_get_head(htx), htx->tail, htx->front, htx->wrap);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200787
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100788 for (pos = htx_get_head(htx); pos != -1; pos = htx_get_next(htx, pos)) {
Christopher Faulet570d1612018-11-26 11:13:57 +0100789 struct htx_sl *sl;
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100790 struct htx_blk *blk = htx_get_blk(htx, pos);
791 enum htx_blk_type type = htx_get_blk_type(blk);
792 enum htx_phdr_type phdr = htx_get_blk_phdr(blk);
793 uint32_t sz = htx_get_blksz(blk);
794 struct ist n, v;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200795
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100796 n = htx_get_blk_name(htx, blk);
797 v = htx_get_blk_value(htx, blk);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200798
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100799 if (type == HTX_BLK_REQ_SL || type == HTX_BLK_RES_SL) {
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200800 sl = htx_get_blk_ptr(htx, blk);
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100801 fprintf(stderr, "\t\t[%u] type=%-17s - size=%-6u - addr=%-6u\t%.*s %.*s %.*s\n",
802 pos, htx_blk_type_str(type), sz, blk->addr,
803 HTX_SL_P1_LEN(sl), HTX_SL_P1_PTR(sl),
804 HTX_SL_P2_LEN(sl), HTX_SL_P2_PTR(sl),
805 HTX_SL_P3_LEN(sl), HTX_SL_P3_PTR(sl));
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200806 }
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100807 else if (type == HTX_BLK_HDR)
808 fprintf(stderr, "\t\t[%u] type=%-17s - size=%-6u - addr=%-6u\t%.*s: %.*s\n",
809 pos, htx_blk_type_str(type), sz, blk->addr,
810 (int)n.len, n.ptr,
811 (int)v.len, v.ptr);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200812
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100813 else if (type == HTX_BLK_PHDR)
814 fprintf(stderr, "\t\t[%u] type=%-17s - size=%-6u - addr=%-6u\t%.*s\n",
815 pos, htx_blk_phdr_str(phdr), sz, blk->addr,
816 (int)v.len, v.ptr);
817 else
818 fprintf(stderr, "\t\t[%u] type=%-17s - size=%-6u - addr=%-6u%s\n",
819 pos, htx_blk_type_str(type), sz, blk->addr,
820 (!v.len ? "\t<empty>" : ""));
821 }
822 fprintf(stderr, "\n");
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200823}
824
Willy Tarreaub96b77e2018-12-11 10:22:41 +0100825#endif /* _COMMON_HTX_H */
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200826
827/*
828 * Local variables:
829 * c-indent-level: 8
830 * c-basic-offset: 8
831 * End:
832 */