blob: 91acee54f03d96893ea92aff6dc957b3d9e5f53e [file] [log] [blame]
Christopher Fauleta3d2a162018-10-22 08:59:39 +02001/*
2 * internal HTTP message
3 *
4 * Copyright 2018 HAProxy Technologies, Christopher Faulet <cfaulet@haproxy.com>
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 *
11 */
12
Willy Tarreauc13ed532020-06-02 10:22:45 +020013#include <haproxy/chunk.h>
Willy Tarreau16f958c2020-06-03 08:44:35 +020014#include <haproxy/htx.h>
Christopher Fauleta3d2a162018-10-22 08:59:39 +020015
Christopher Faulet192c6a22019-06-11 16:32:24 +020016struct htx htx_empty = { .size = 0, .data = 0, .head = -1, .tail = -1, .first = -1 };
Christopher Fauleta3d2a162018-10-22 08:59:39 +020017
Christopher Faulet3b219722019-06-19 13:48:09 +020018/* Defragments an HTX message. It removes unused blocks and unwraps the payloads
19 * part. A temporary buffer is used to do so. This function never fails. if
20 * <blk> is not NULL, we replace it by the new block address, after the
21 * defragmentation. The new <blk> is returned.
Christopher Fauleta3d2a162018-10-22 08:59:39 +020022 */
23/* TODO: merge data blocks into one */
24struct htx_blk *htx_defrag(struct htx *htx, struct htx_blk *blk)
25{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +010026 struct buffer *chunk = get_trash_chunk();
27 struct htx *tmp = htxbuf(chunk);
28 struct htx_blk *newblk, *oldblk;
Christopher Faulet200f8952019-01-02 11:23:44 +010029 uint32_t new, old, blkpos;
Christopher Fauletaa75b3d2018-12-05 16:20:40 +010030 uint32_t addr, blksz;
Christopher Faulet29f17582019-05-23 11:03:26 +020031 int32_t first = -1;
Christopher Fauleta3d2a162018-10-22 08:59:39 +020032
Christopher Faulet192c6a22019-06-11 16:32:24 +020033 if (htx->head == -1)
Christopher Fauletaa75b3d2018-12-05 16:20:40 +010034 return NULL;
Christopher Fauleta3d2a162018-10-22 08:59:39 +020035
Christopher Faulet200f8952019-01-02 11:23:44 +010036 blkpos = -1;
37
Christopher Fauletaa75b3d2018-12-05 16:20:40 +010038 new = 0;
39 addr = 0;
40 tmp->size = htx->size;
Christopher Fauleta3d2a162018-10-22 08:59:39 +020041
Christopher Fauletaa75b3d2018-12-05 16:20:40 +010042 /* start from the head */
43 for (old = htx_get_head(htx); old != -1; old = htx_get_next(htx, old)) {
44 oldblk = htx_get_blk(htx, old);
Christopher Faulet28f29c72019-04-30 17:55:45 +020045 if (htx_get_blk_type(oldblk) == HTX_BLK_UNUSED)
Christopher Fauletaa75b3d2018-12-05 16:20:40 +010046 continue;
Christopher Fauleta3d2a162018-10-22 08:59:39 +020047
Christopher Fauletaa75b3d2018-12-05 16:20:40 +010048 newblk = htx_get_blk(tmp, new);
49 newblk->addr = addr;
50 newblk->info = oldblk->info;
51 blksz = htx_get_blksz(oldblk);
Christopher Fauleta3d2a162018-10-22 08:59:39 +020052
Christopher Faulet9c66b982019-04-30 18:08:26 +020053 /* update the start-line position */
Christopher Faulet29f17582019-05-23 11:03:26 +020054 if (htx->first == old)
55 first = new;
Christopher Faulet174bfb12018-12-06 14:31:12 +010056
Christopher Faulet3b219722019-06-19 13:48:09 +020057 /* if <blk> is defined, save its new position */
Christopher Faulet200f8952019-01-02 11:23:44 +010058 if (blk != NULL && blk == oldblk)
59 blkpos = new;
60
Christopher Fauletaa75b3d2018-12-05 16:20:40 +010061 memcpy((void *)tmp->blocks + addr, htx_get_blk_ptr(htx, oldblk), blksz);
62 new++;
63 addr += blksz;
Christopher Fauleta3d2a162018-10-22 08:59:39 +020064
Christopher Fauletb8fd4c02019-05-20 09:32:25 +020065 }
Christopher Fauleta3d2a162018-10-22 08:59:39 +020066
Christopher Faulet29f17582019-05-23 11:03:26 +020067 htx->first = first;
Christopher Faulet28f29c72019-04-30 17:55:45 +020068 htx->head = 0;
Christopher Fauletd7884d32019-06-11 10:40:43 +020069 htx->tail = new - 1;
70 htx->head_addr = htx->end_addr = 0;
71 htx->tail_addr = addr;
Christopher Fauletaa75b3d2018-12-05 16:20:40 +010072 memcpy((void *)htx->blocks, (void *)tmp->blocks, htx->size);
Christopher Fauleta3d2a162018-10-22 08:59:39 +020073
Christopher Faulet200f8952019-01-02 11:23:44 +010074 return ((blkpos == -1) ? NULL : htx_get_blk(htx, blkpos));
Christopher Fauleta3d2a162018-10-22 08:59:39 +020075}
76
Christopher Faulet3b219722019-06-19 13:48:09 +020077/* Degragments HTX blocks of an HTX message. Payloads part is keep untouched
78 * here. This function will move back all blocks starting at the position 0,
79 * removing unused blocks. It must never be called with an empty message.
80 */
Christopher Fauletd7884d32019-06-11 10:40:43 +020081static void htx_defrag_blks(struct htx *htx)
82{
83 int32_t pos, new;
84
85 new = 0;
86 for (pos = htx_get_head(htx); pos != -1; pos = htx_get_next(htx, pos)) {
87 struct htx_blk *posblk, *newblk;
88
89 if (pos == new) {
90 new++;
91 continue;
92 }
93
94 posblk = htx_get_blk(htx, pos);
95 if (htx_get_blk_type(posblk) == HTX_BLK_UNUSED)
96 continue;
97
98 if (htx->first == pos)
99 htx->first = new;
100 newblk = htx_get_blk(htx, new++);
101 newblk->info = posblk->info;
102 newblk->addr = posblk->addr;
103 }
104 BUG_ON(!new);
105 htx->head = 0;
106 htx->tail = new - 1;
107}
108
Christopher Faulet3b219722019-06-19 13:48:09 +0200109/* Reserves a new block in the HTX message <htx> with a content of <blksz>
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200110 * bytes. If there is not enough space, NULL is returned. Otherwise the reserved
Christopher Faulet3b219722019-06-19 13:48:09 +0200111 * block is returned and the HTX message is updated. Space for this new block is
112 * reserved in the HTX message. But it is the caller responsibility to set right
113 * info in the block to reflect the stored data.
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200114 */
115static struct htx_blk *htx_reserve_nxblk(struct htx *htx, uint32_t blksz)
116{
Christopher Fauletd7884d32019-06-11 10:40:43 +0200117 struct htx_blk *blk;
Christopher Faulet192c6a22019-06-11 16:32:24 +0200118 uint32_t tail, headroom, tailroom;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200119
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100120 if (blksz > htx_free_data_space(htx))
121 return NULL; /* full */
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200122
Christopher Faulet192c6a22019-06-11 16:32:24 +0200123 if (htx->head == -1) {
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100124 /* Empty message */
Christopher Fauletd7884d32019-06-11 10:40:43 +0200125 htx->head = htx->tail = htx->first = 0;
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100126 blk = htx_get_blk(htx, htx->tail);
127 blk->addr = 0;
128 htx->data = blksz;
Christopher Fauletd7884d32019-06-11 10:40:43 +0200129 htx->tail_addr = blksz;
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100130 return blk;
131 }
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200132
Christopher Fauletd7884d32019-06-11 10:40:43 +0200133 /* Find the block's position. First, we try to get the next position in
134 * the message, increasing the tail by one. If this position is not
135 * available with some holes, we try to defrag the blocks without
136 * touching their paylood. If it is impossible, we fully defrag the
137 * message.
138 */
Christopher Faulet28f29c72019-04-30 17:55:45 +0200139 tail = htx->tail + 1;
Christopher Faulet2bf43f02019-06-12 11:28:11 +0200140 if (htx_pos_to_addr(htx, tail) >= htx->tail_addr)
Christopher Faulet192c6a22019-06-11 16:32:24 +0200141 ;
142 else if (htx->head > 0) {
Christopher Fauletd7884d32019-06-11 10:40:43 +0200143 htx_defrag_blks(htx);
144 tail = htx->tail + 1;
Christopher Faulet2bf43f02019-06-12 11:28:11 +0200145 BUG_ON(htx_pos_to_addr(htx, tail) < htx->tail_addr);
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100146 }
Christopher Fauletd7884d32019-06-11 10:40:43 +0200147 else
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100148 goto defrag;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200149
Christopher Fauletd7884d32019-06-11 10:40:43 +0200150 /* Now, we have found the block's position. Try do find where to put its
151 * payload. The free space is split in two areas:
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100152 *
Christopher Fauletd7884d32019-06-11 10:40:43 +0200153 * * The free space in front of the blocks table. This one is used iff
154 * the other one was not used yet.
155 *
156 * * The free space at the beginning of the message. Once this one is
157 * used, the other one is never used again, until the next defrag.
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100158 */
Christopher Fauletd7884d32019-06-11 10:40:43 +0200159 headroom = (htx->end_addr - htx->head_addr);
Christopher Faulet2bf43f02019-06-12 11:28:11 +0200160 tailroom = (!htx->head_addr ? htx_pos_to_addr(htx, tail) - htx->tail_addr : 0);
Christopher Fauletd7884d32019-06-11 10:40:43 +0200161 BUG_ON((int32_t)headroom < 0);
162 BUG_ON((int32_t)tailroom < 0);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200163
Christopher Fauletd7884d32019-06-11 10:40:43 +0200164 if (blksz <= tailroom) {
165 blk = htx_get_blk(htx, tail);
166 blk->addr = htx->tail_addr;
167 htx->tail_addr += blksz;
168 }
169 else if (blksz <= headroom) {
170 blk = htx_get_blk(htx, tail);
171 blk->addr = htx->head_addr;
172 htx->head_addr += blksz;
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100173 }
174 else {
Christopher Fauletd7884d32019-06-11 10:40:43 +0200175 defrag:
Christopher Faulet3b219722019-06-19 13:48:09 +0200176 /* need to defragment the message before inserting upfront */
Christopher Fauletd7884d32019-06-11 10:40:43 +0200177 htx_defrag(htx, NULL);
178 tail = htx->tail + 1;
Christopher Fauletd7884d32019-06-11 10:40:43 +0200179 blk = htx_get_blk(htx, tail);
180 blk->addr = htx->tail_addr;
181 htx->tail_addr += blksz;
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100182 }
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200183
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100184 htx->tail = tail;
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100185 htx->data += blksz;
Christopher Faulet29f17582019-05-23 11:03:26 +0200186 /* Set first position if not already set */
187 if (htx->first == -1)
188 htx->first = tail;
Christopher Fauletd7884d32019-06-11 10:40:43 +0200189
190 BUG_ON((int32_t)htx->tail_addr < 0);
191 BUG_ON((int32_t)htx->head_addr < 0);
192 BUG_ON(htx->end_addr > htx->tail_addr);
193 BUG_ON(htx->head_addr > htx->end_addr);
194
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100195 return blk;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200196}
197
Christopher Fauletd7884d32019-06-11 10:40:43 +0200198/* Prepares the block to an expansion of its payload. The payload will be
199 * expanded by <delta> bytes and we need find where this expansion will be
200 * performed. It can be a compression if <delta> is negative. This function only
Ilya Shipitsin47d17182020-06-21 21:42:57 +0500201 * updates all addresses. The caller have the responsibility to perform the
Christopher Faulet3b219722019-06-19 13:48:09 +0200202 * expansion and update the block and the HTX message accordingly. No error must
Ilya Shipitsin47d17182020-06-21 21:42:57 +0500203 * occur. It returns following values:
Christopher Fauletd7884d32019-06-11 10:40:43 +0200204 *
205 * 0: The expansion cannot be performed, there is not enough space.
206 *
Ilya Shipitsin47d17182020-06-21 21:42:57 +0500207 * 1: the expansion must be performed in place, there is enough space after
Christopher Fauletd7884d32019-06-11 10:40:43 +0200208 * the block's payload to handle it. This is especially true if it is a
209 * compression and not an expension.
210 *
211 * 2: the block's payload must be moved at the new block address before doing
212 * the expansion.
213 *
214 * 3: the HTX message message must be defragmented
215 */
216static int htx_prepare_blk_expansion(struct htx *htx, struct htx_blk *blk, int32_t delta)
217{
218 uint32_t sz, tailroom, headroom;
219 int ret = 3;
220
Christopher Faulet192c6a22019-06-11 16:32:24 +0200221 BUG_ON(htx->head == -1);
222
Christopher Fauletd7884d32019-06-11 10:40:43 +0200223 headroom = (htx->end_addr - htx->head_addr);
Christopher Faulet2bf43f02019-06-12 11:28:11 +0200224 tailroom = (htx_pos_to_addr(htx, htx->tail) - htx->tail_addr);
Christopher Fauletd7884d32019-06-11 10:40:43 +0200225 BUG_ON((int32_t)headroom < 0);
226 BUG_ON((int32_t)tailroom < 0);
227
228 sz = htx_get_blksz(blk);
229 if (delta <= 0) {
230 /* It is a compression, it can be performed in place */
231 if (blk->addr+sz == htx->tail_addr)
232 htx->tail_addr += delta;
233 else if (blk->addr+sz == htx->head_addr)
234 htx->head_addr += delta;
235 ret = 1;
236 }
237 else if (delta > htx_free_space(htx)) {
Ilya Shipitsin46a030c2020-07-05 16:36:08 +0500238 /* There is not enough space to handle the expansion */
Christopher Fauletd7884d32019-06-11 10:40:43 +0200239 ret = 0;
240 }
241 else if (blk->addr+sz == htx->tail_addr) {
242 /* The block's payload is just before the tail room */
243 if (delta < tailroom) {
244 /* Expand the block's payload */
245 htx->tail_addr += delta;
246 ret = 1;
247 }
248 else if ((sz + delta) < headroom) {
Christopher Faulet61ed7792019-07-29 10:50:28 +0200249 uint32_t oldaddr = blk->addr;
250
Christopher Fauletd7884d32019-06-11 10:40:43 +0200251 /* Move the block's payload into the headroom */
Christopher Fauletd7884d32019-06-11 10:40:43 +0200252 blk->addr = htx->head_addr;
253 htx->tail_addr -= sz;
254 htx->head_addr += sz + delta;
Christopher Faulet61ed7792019-07-29 10:50:28 +0200255 if (oldaddr == htx->end_addr) {
Christopher Faulet8c654862019-06-12 11:08:11 +0200256 if (htx->end_addr == htx->tail_addr) {
257 htx->tail_addr = htx->head_addr;
258 htx->head_addr = htx->end_addr = 0;
259 }
260 else
261 htx->end_addr += sz;
262 }
Christopher Fauletd7884d32019-06-11 10:40:43 +0200263 ret = 2;
264 }
265 }
266 else if (blk->addr+sz == htx->head_addr) {
267 /* The block's payload is just before the head room */
268 if (delta < headroom) {
269 /* Expand the block's payload */
270 htx->head_addr += delta;
271 ret = 1;
272 }
273 }
274 else {
275 /* The block's payload is not at the rooms edge */
276 if (!htx->head_addr && sz+delta < tailroom) {
277 /* Move the block's payload into the tailroom */
278 if (blk->addr == htx->end_addr)
279 htx->end_addr += sz;
280 blk->addr = htx->tail_addr;
281 htx->tail_addr += sz + delta;
282 ret = 2;
283 }
284 else if (sz+delta < headroom) {
285 /* Move the block's payload into the headroom */
286 if (blk->addr == htx->end_addr)
287 htx->end_addr += sz;
288 blk->addr = htx->head_addr;
289 htx->head_addr += sz + delta;
290 ret = 2;
291 }
292 }
293 /* Otherwise defrag the HTX message */
294
295 BUG_ON((int32_t)htx->tail_addr < 0);
296 BUG_ON((int32_t)htx->head_addr < 0);
297 BUG_ON(htx->end_addr > htx->tail_addr);
298 BUG_ON(htx->head_addr > htx->end_addr);
299 return ret;
300}
301
Christopher Faulet3b219722019-06-19 13:48:09 +0200302/* Adds a new block of type <type> in the HTX message <htx>. Its content size is
303 * passed but it is the caller responsibility to do the copy.
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200304 */
305struct htx_blk *htx_add_blk(struct htx *htx, enum htx_blk_type type, uint32_t blksz)
306{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100307 struct htx_blk *blk;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200308
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100309 blk = htx_reserve_nxblk(htx, blksz);
310 if (!blk)
311 return NULL;
Christopher Fauletd7884d32019-06-11 10:40:43 +0200312 BUG_ON(blk->addr > htx->size);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200313
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100314 blk->info = (type << 28);
315 return blk;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200316}
317
Christopher Faulet3b219722019-06-19 13:48:09 +0200318/* Removes the block <blk> from the HTX message <htx>. The function returns the
319 * block following <blk> or NULL if <blk> is the last block or the last inserted
320 * one.
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200321 */
322struct htx_blk *htx_remove_blk(struct htx *htx, struct htx_blk *blk)
323{
Christopher Fauletd7884d32019-06-11 10:40:43 +0200324 enum htx_blk_type type;
325 uint32_t pos, addr, sz;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200326
Christopher Faulet192c6a22019-06-11 16:32:24 +0200327 BUG_ON(htx->head == -1);
328
Christopher Fauletd7884d32019-06-11 10:40:43 +0200329 /* This is the last block in use */
Christopher Faulet192c6a22019-06-11 16:32:24 +0200330 if (htx->head == htx->tail) {
Christopher Fauletd7884d32019-06-11 10:40:43 +0200331 htx_reset(htx);
332 return NULL;
333 }
334
335 type = htx_get_blk_type(blk);
Christopher Faulet9c66b982019-04-30 18:08:26 +0200336 pos = htx_get_blk_pos(htx, blk);
Christopher Fauletd7884d32019-06-11 10:40:43 +0200337 sz = htx_get_blksz(blk);
338 addr = blk->addr;
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100339 if (type != HTX_BLK_UNUSED) {
340 /* Mark the block as unused, decrement allocated size */
341 htx->data -= htx_get_blksz(blk);
342 blk->info = ((uint32_t)HTX_BLK_UNUSED << 28);
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100343 }
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200344
Christopher Faulet3b219722019-06-19 13:48:09 +0200345 /* There is at least 2 blocks, so tail is always > 0 */
Christopher Fauletd7884d32019-06-11 10:40:43 +0200346 if (pos == htx->head) {
347 /* move the head forward */
Christopher Fauletd7884d32019-06-11 10:40:43 +0200348 htx->head++;
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100349 }
Christopher Fauletd7884d32019-06-11 10:40:43 +0200350 else if (pos == htx->tail) {
351 /* remove the tail. this was the last inserted block so
352 * return NULL. */
353 htx->tail--;
Christopher Fauletd7884d32019-06-11 10:40:43 +0200354 blk = NULL;
355 goto end;
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100356 }
Christopher Fauletd7884d32019-06-11 10:40:43 +0200357 blk = htx_get_blk(htx, pos+1);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200358
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200359 end:
Christopher Faulet29f17582019-05-23 11:03:26 +0200360 if (pos == htx->first)
361 htx->first = (blk ? htx_get_blk_pos(htx, blk) : -1);
Christopher Fauletd7884d32019-06-11 10:40:43 +0200362
Christopher Faulet192c6a22019-06-11 16:32:24 +0200363 if (htx->head == htx->tail) {
Christopher Fauletd7884d32019-06-11 10:40:43 +0200364 /* If there is just one block in the HTX message, free space can
Ilya Shipitsin47d17182020-06-21 21:42:57 +0500365 * be adjusted. This operation could save some defrags. */
Christopher Fauletd7884d32019-06-11 10:40:43 +0200366 struct htx_blk *lastblk = htx_get_blk(htx, htx->tail);
367
368 htx->head_addr = 0;
369 htx->end_addr = lastblk->addr;
370 htx->tail_addr = lastblk->addr+htx->data;
371 }
372 else {
373 if (addr+sz == htx->tail_addr)
374 htx->tail_addr = addr;
375 else if (addr+sz == htx->head_addr)
376 htx->head_addr = addr;
Christopher Faulet8c654862019-06-12 11:08:11 +0200377 if (addr == htx->end_addr) {
378 if (htx->tail_addr == htx->end_addr) {
379 htx->tail_addr = htx->head_addr;
380 htx->head_addr = htx->end_addr = 0;
381 }
382 else
383 htx->end_addr += sz;
Christopher Fauletd7884d32019-06-11 10:40:43 +0200384 }
385 }
386
387 BUG_ON((int32_t)htx->tail_addr < 0);
388 BUG_ON((int32_t)htx->head_addr < 0);
389 BUG_ON(htx->end_addr > htx->tail_addr);
390 BUG_ON(htx->head_addr > htx->end_addr);
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100391 return blk;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200392}
393
Christopher Faulet1cdceb92020-02-24 11:41:59 +0100394/* Looks for the HTX block containing the offset <offset>, starting at the HTX
395 * message's head. The function returns an htx_ret with the found HTX block and
396 * the position inside this block where the offset is. If the offset <offset> is
Ilya Shipitsin47d17182020-06-21 21:42:57 +0500397 * outside of the HTX message, htx_ret.blk is set to NULL.
Christopher Faulet1cdceb92020-02-24 11:41:59 +0100398 */
399struct htx_ret htx_find_offset(struct htx *htx, uint32_t offset)
400{
401 struct htx_blk *blk;
402 struct htx_ret htxret = { .blk = NULL, .ret = 0 };
403
404 if (offset >= htx->data)
405 return htxret;
406
407 for (blk = htx_get_head_blk(htx); blk && offset; blk = htx_get_next_blk(htx, blk)) {
408 uint32_t sz = htx_get_blksz(blk);
409
410 if (offset < sz)
411 break;
412 offset -= sz;
413 }
414 htxret.blk = blk;
415 htxret.ret = offset;
416 return htxret;
417}
418
Christopher Faulet3b219722019-06-19 13:48:09 +0200419/* Removes all blocks after the one containing the offset <offset>. This last
420 * one may be truncated if it is a DATA block.
Christopher Faulet00cf6972019-01-07 14:53:27 +0100421 */
422void htx_truncate(struct htx *htx, uint32_t offset)
423{
424 struct htx_blk *blk;
Christopher Fauletbb76aa42020-02-24 15:09:24 +0100425 struct htx_ret htxret = htx_find_offset(htx, offset);
Christopher Faulet00cf6972019-01-07 14:53:27 +0100426
Christopher Fauletbb76aa42020-02-24 15:09:24 +0100427 blk = htxret.blk;
428 if (blk && htxret.ret && htx_get_blk_type(blk) == HTX_BLK_DATA) {
429 htx_change_blk_value_len(htx, blk, htxret.ret);
430 blk = htx_get_next_blk(htx, blk);
Christopher Faulet00cf6972019-01-07 14:53:27 +0100431 }
432 while (blk)
433 blk = htx_remove_blk(htx, blk);
434}
435
Christopher Faulet3b219722019-06-19 13:48:09 +0200436/* Drains <count> bytes from the HTX message <htx>. If the last block is a DATA
437 * block, it will be cut if necessary. Others blocks will be removed at once if
438 * <count> is large enough. The function returns an htx_ret with the first block
Ilya Shipitsin47d17182020-06-21 21:42:57 +0500439 * remaining in the message and the amount of data drained. If everything is
Christopher Faulet3b219722019-06-19 13:48:09 +0200440 * removed, htx_ret.blk is set to NULL.
Christopher Faulet549822f2019-02-25 10:23:19 +0100441 */
442struct htx_ret htx_drain(struct htx *htx, uint32_t count)
443{
444 struct htx_blk *blk;
445 struct htx_ret htxret = { .blk = NULL, .ret = 0 };
446
Christopher Faulet0f6d6a92019-05-23 11:11:52 +0200447 if (count == htx->data) {
448 htx_reset(htx);
449 htxret.ret = count;
450 return htxret;
451 }
452
Christopher Faulet549822f2019-02-25 10:23:19 +0100453 blk = htx_get_head_blk(htx);
454 while (count && blk) {
455 uint32_t sz = htx_get_blksz(blk);
456 enum htx_blk_type type = htx_get_blk_type(blk);
457
Ilya Shipitsin47d17182020-06-21 21:42:57 +0500458 /* Ignore unused block */
Christopher Faulet549822f2019-02-25 10:23:19 +0100459 if (type == HTX_BLK_UNUSED)
460 goto next;
461
462 if (sz > count) {
463 if (type == HTX_BLK_DATA) {
464 htx_cut_data_blk(htx, blk, count);
465 htxret.ret += count;
466 }
467 break;
468 }
469 count -= sz;
470 htxret.ret += sz;
471 next:
472 blk = htx_remove_blk(htx, blk);
473 }
474 htxret.blk = blk;
475
476 return htxret;
477}
478
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200479/* Tries to append data to the last inserted block, if the type matches and if
Willy Tarreaud4908fa2019-05-28 10:23:46 +0200480 * there is enough space to take it all. If the space wraps, the buffer is
481 * defragmented and a new block is inserted. If an error occurred, NULL is
Christopher Faulet61775092019-05-07 21:42:27 +0200482 * returned. Otherwise, on success, the updated block (or the new one) is
Willy Tarreaud4908fa2019-05-28 10:23:46 +0200483 * returned. Due to its nature this function can be expensive and should be
484 * avoided whenever possible.
485 */
Christopher Fauletd7884d32019-06-11 10:40:43 +0200486struct htx_blk *htx_add_data_atonce(struct htx *htx, struct ist data)
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200487{
Christopher Fauletd7884d32019-06-11 10:40:43 +0200488 struct htx_blk *blk, *tailblk;
489 void *ptr;
490 uint32_t len, sz, tailroom, headroom;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200491
Christopher Faulet192c6a22019-06-11 16:32:24 +0200492 if (htx->head == -1)
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100493 goto add_new_block;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200494
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100495 /* Not enough space to store data */
496 if (data.len > htx_free_data_space(htx))
497 return NULL;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200498
Christopher Fauletd7884d32019-06-11 10:40:43 +0200499 /* get the tail block and its size */
Christopher Fauletf1449b72019-04-10 14:54:46 +0200500 tailblk = htx_get_tail_blk(htx);
Christopher Fauletd7884d32019-06-11 10:40:43 +0200501 if (tailblk == NULL)
Christopher Fauletf1449b72019-04-10 14:54:46 +0200502 goto add_new_block;
Christopher Fauletd7884d32019-06-11 10:40:43 +0200503 sz = htx_get_blksz(tailblk);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200504
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100505 /* Don't try to append data if the last inserted block is not of the
506 * same type */
Willy Tarreaud4908fa2019-05-28 10:23:46 +0200507 if (htx_get_blk_type(tailblk) != HTX_BLK_DATA)
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100508 goto add_new_block;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200509
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100510 /*
511 * Same type and enough space: append data
512 */
Christopher Fauletd7884d32019-06-11 10:40:43 +0200513 headroom = (htx->end_addr - htx->head_addr);
Christopher Faulet2bf43f02019-06-12 11:28:11 +0200514 tailroom = (htx_pos_to_addr(htx, htx->tail) - htx->tail_addr);
Christopher Fauletd7884d32019-06-11 10:40:43 +0200515 BUG_ON((int32_t)headroom < 0);
516 BUG_ON((int32_t)tailroom < 0);
517
518 len = data.len;
519 if (tailblk->addr+sz == htx->tail_addr) {
520 if (data.len <= tailroom)
521 goto append_data;
522 else if (!htx->head_addr) {
523 len = tailroom;
524 goto append_data;
525 }
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100526 }
Christopher Fauletd7884d32019-06-11 10:40:43 +0200527 else if (tailblk->addr+sz == htx->head_addr && data.len <= headroom)
528 goto append_data;
Christopher Fauletf1449b72019-04-10 14:54:46 +0200529
Christopher Fauletd7884d32019-06-11 10:40:43 +0200530 goto add_new_block;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200531
532 append_data:
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100533 /* FIXME: check v.len + data.len < 256MB */
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100534 /* Append data and update the block itself */
Christopher Fauletd7884d32019-06-11 10:40:43 +0200535 ptr = htx_get_blk_ptr(htx, tailblk);
536 memcpy(ptr+sz, data.ptr, len);
Christopher Faulet3e2638e2019-06-18 09:49:16 +0200537 htx_change_blk_value_len(htx, tailblk, sz+len);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200538
Christopher Fauletd7884d32019-06-11 10:40:43 +0200539 if (data.len == len) {
540 blk = tailblk;
541 goto end;
542 }
543 data.ptr += len;
544 data.len -= len;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200545
546 add_new_block:
Christopher Faulet2d7c5392019-06-03 10:41:26 +0200547 /* FIXME: check data.len (< 256MB) */
Willy Tarreaud4908fa2019-05-28 10:23:46 +0200548 blk = htx_add_blk(htx, HTX_BLK_DATA, data.len);
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100549 if (!blk)
550 return NULL;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200551
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100552 blk->info += data.len;
553 memcpy(htx_get_blk_ptr(htx, blk), data.ptr, data.len);
Christopher Fauletd7884d32019-06-11 10:40:43 +0200554
555 end:
556 BUG_ON((int32_t)htx->tail_addr < 0);
557 BUG_ON((int32_t)htx->head_addr < 0);
558 BUG_ON(htx->end_addr > htx->tail_addr);
559 BUG_ON(htx->head_addr > htx->end_addr);
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100560 return blk;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200561}
562
563/* Replaces a value part of a block by a new one. The new part can be smaller or
564 * larger than the old one. This function works for any kind of block with
565 * attached data. It returns the new block on success, otherwise it returns
566 * NULL.
567 */
568struct htx_blk *htx_replace_blk_value(struct htx *htx, struct htx_blk *blk,
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100569 const struct ist old, const struct ist new)
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200570{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100571 struct ist n, v;
Christopher Faulete97f3ba2018-12-10 15:39:40 +0100572 int32_t delta;
Christopher Fauletd7884d32019-06-11 10:40:43 +0200573 int ret;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200574
Christopher Fauletd7884d32019-06-11 10:40:43 +0200575 n = htx_get_blk_name(htx, blk);
576 v = htx_get_blk_value(htx, blk);
Christopher Faulete97f3ba2018-12-10 15:39:40 +0100577 delta = new.len - old.len;
Christopher Fauletd7884d32019-06-11 10:40:43 +0200578 ret = htx_prepare_blk_expansion(htx, blk, delta);
579 if (!ret)
580 return NULL; /* not enough space */
Christopher Faulete97f3ba2018-12-10 15:39:40 +0100581
Christopher Fauletd7884d32019-06-11 10:40:43 +0200582 /* Before updating the payload, set the new block size and update HTX
583 * message */
584 htx_set_blk_value_len(blk, v.len + delta);
585 htx->data += delta;
586
Christopher Faulet3b219722019-06-19 13:48:09 +0200587 if (ret == 1) { /* Replace in place */
Christopher Fauletd7884d32019-06-11 10:40:43 +0200588 if (delta <= 0) {
Christopher Faulet3b219722019-06-19 13:48:09 +0200589 /* compression: copy new data first then move the end */
Christopher Fauletd7884d32019-06-11 10:40:43 +0200590 memcpy(old.ptr, new.ptr, new.len);
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100591 memmove(old.ptr + new.len, old.ptr + old.len, (v.ptr + v.len) - (old.ptr + old.len));
Christopher Fauletd7884d32019-06-11 10:40:43 +0200592 }
593 else {
Christopher Faulet3b219722019-06-19 13:48:09 +0200594 /* expansion: move the end first then copy new data */
Christopher Fauletd7884d32019-06-11 10:40:43 +0200595 memmove(old.ptr + new.len, old.ptr + old.len, (v.ptr + v.len) - (old.ptr + old.len));
596 memcpy(old.ptr, new.ptr, new.len);
597 }
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100598 }
Christopher Faulet3b219722019-06-19 13:48:09 +0200599 else if (ret == 2) { /* New address but no defrag */
Christopher Fauletd7884d32019-06-11 10:40:43 +0200600 void *ptr = htx_get_blk_ptr(htx, blk);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200601
Christopher Fauletd7884d32019-06-11 10:40:43 +0200602 /* Copy the name, if any */
603 memcpy(ptr, n.ptr, n.len);
604 ptr += n.len;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200605
Christopher Fauletd7884d32019-06-11 10:40:43 +0200606 /* Copy value before old part, if any */
607 memcpy(ptr, v.ptr, old.ptr - v.ptr);
608 ptr += old.ptr - v.ptr;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200609
Christopher Fauletd7884d32019-06-11 10:40:43 +0200610 /* Copy new value */
611 memcpy(ptr, new.ptr, new.len);
612 ptr += new.len;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200613
Christopher Fauletd7884d32019-06-11 10:40:43 +0200614 /* Copy value after old part, if any */
615 memcpy(ptr, old.ptr + old.len, (v.ptr + v.len) - (old.ptr + old.len));
616 }
Christopher Faulet3b219722019-06-19 13:48:09 +0200617 else { /* Do a degrag first */
Christopher Fauletd7884d32019-06-11 10:40:43 +0200618 struct buffer *tmp = get_trash_chunk();
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200619
Christopher Fauletd7884d32019-06-11 10:40:43 +0200620 /* Copy the header name, if any */
621 chunk_memcat(tmp, n.ptr, n.len);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200622
Christopher Fauletd7884d32019-06-11 10:40:43 +0200623 /* Copy value before old part, if any */
624 chunk_memcat(tmp, v.ptr, old.ptr - v.ptr);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200625
Christopher Fauletd7884d32019-06-11 10:40:43 +0200626 /* Copy new value */
627 chunk_memcat(tmp, new.ptr, new.len);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200628
Christopher Fauletd7884d32019-06-11 10:40:43 +0200629 /* Copy value after old part if any */
630 chunk_memcat(tmp, old.ptr + old.len, (v.ptr + v.len) - (old.ptr + old.len));
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200631
Christopher Fauletd7884d32019-06-11 10:40:43 +0200632 blk = htx_defrag(htx, blk);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200633
Ilya Shipitsin47d17182020-06-21 21:42:57 +0500634 /* Finally, copy data. */
Christopher Fauletd7884d32019-06-11 10:40:43 +0200635 memcpy(htx_get_blk_ptr(htx, blk), tmp->area, tmp->data);
636 }
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100637 return blk;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200638}
639
640/* Transfer HTX blocks from <src> to <dst>, stopping on the first block of the
Christopher Faulet54b5e212019-06-04 10:08:28 +0200641 * type <mark> (typically EOH or EOM) or when <count> bytes were moved
Christopher Faulet156852b2019-05-16 11:29:13 +0200642 * (including payload and meta-data). It returns the number of bytes moved and
643 * the last HTX block inserted in <dst>.
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200644 */
645struct htx_ret htx_xfer_blks(struct htx *dst, struct htx *src, uint32_t count,
646 enum htx_blk_type mark)
647{
648 struct htx_blk *blk, *dstblk;
649 enum htx_blk_type type;
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100650 uint32_t info, max, sz, ret;
Christopher Faulet2d7c5392019-06-03 10:41:26 +0200651 int inside_trailers = 0;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200652
Christopher Faulet156852b2019-05-16 11:29:13 +0200653 ret = htx_used_space(dst);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200654 blk = htx_get_blk(src, htx_get_head(src));
655 dstblk = NULL;
Christopher Faulet156852b2019-05-16 11:29:13 +0200656
657 while (blk && count) {
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200658 type = htx_get_blk_type(blk);
659
Ilya Shipitsin47d17182020-06-21 21:42:57 +0500660 /* Ignore unused block */
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200661 if (type == HTX_BLK_UNUSED)
662 goto next;
663
Christopher Faulet2d7c5392019-06-03 10:41:26 +0200664 /* Be sure to have enough space to xfer all headers/trailers in
665 * one time. If not while <dst> is empty, we report a parsing
666 * error on <src>.
Christopher Fauleta61e97b2019-05-16 11:30:31 +0200667 */
668 if (mark >= HTX_BLK_EOH && (type == HTX_BLK_REQ_SL || type == HTX_BLK_RES_SL)) {
669 struct htx_sl *sl = htx_get_blk_ptr(src, blk);
670
671 if (sl->hdrs_bytes != -1 && sl->hdrs_bytes > count) {
672 if (htx_is_empty(dst))
673 src->flags |= HTX_FL_PARSING_ERROR;
674 break;
675 }
676 }
Christopher Faulet2d7c5392019-06-03 10:41:26 +0200677 else if ((type == HTX_BLK_TLR || type == HTX_BLK_EOT) &&
678 !inside_trailers && mark >= HTX_BLK_EOT) {
679 inside_trailers = 1;
680 if (htx_used_space(src) > count) {
681 if (htx_is_empty(dst))
682 src->flags |= HTX_FL_PARSING_ERROR;
683 break;
684 }
685 }
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200686
Christopher Faulet156852b2019-05-16 11:29:13 +0200687 sz = htx_get_blksz(blk);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200688 info = blk->info;
Christopher Faulet156852b2019-05-16 11:29:13 +0200689 max = htx_get_max_blksz(dst, count);
690 if (!max)
691 break;
Willy Tarreau90caa072019-04-09 16:21:54 +0200692 if (sz > max) {
Christopher Faulet3b219722019-06-19 13:48:09 +0200693 /* Only DATA blocks can be partially xferred */
Christopher Faulet156852b2019-05-16 11:29:13 +0200694 if (type != HTX_BLK_DATA)
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200695 break;
Christopher Faulet156852b2019-05-16 11:29:13 +0200696 sz = max;
697 info = (type << 28) + sz;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200698 }
699
700 dstblk = htx_reserve_nxblk(dst, sz);
701 if (!dstblk)
702 break;
703 dstblk->info = info;
704 memcpy(htx_get_blk_ptr(dst, dstblk), htx_get_blk_ptr(src, blk), sz);
705
Christopher Faulet156852b2019-05-16 11:29:13 +0200706 count -= sizeof(dstblk) + sz;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200707 if (blk->info != info) {
Christopher Faulet3b219722019-06-19 13:48:09 +0200708 /* Partial xfer: don't remove <blk> from <src> but
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200709 * resize its content */
Christopher Faulet156852b2019-05-16 11:29:13 +0200710 htx_cut_data_blk(src, blk, sz);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200711 break;
712 }
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200713 next:
714 blk = htx_remove_blk(src, blk);
715 if (type == mark)
716 break;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200717 }
718
Christopher Faulet156852b2019-05-16 11:29:13 +0200719 end:
720 ret = htx_used_space(dst) - ret;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200721 return (struct htx_ret){.ret = ret, .blk = dstblk};
722}
723
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200724/* Replaces an header by a new one. The new header can be smaller or larger than
725 * the old one. It returns the new block on success, otherwise it returns NULL.
Willy Tarreaued00e342018-12-07 08:47:45 +0100726 * The header name is always lower cased.
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200727 */
728struct htx_blk *htx_replace_header(struct htx *htx, struct htx_blk *blk,
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100729 const struct ist name, const struct ist value)
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200730{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100731 enum htx_blk_type type;
Christopher Fauletd7884d32019-06-11 10:40:43 +0200732 void *ptr;
Christopher Faulete97f3ba2018-12-10 15:39:40 +0100733 int32_t delta;
Christopher Fauletd7884d32019-06-11 10:40:43 +0200734 int ret;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200735
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100736 type = htx_get_blk_type(blk);
737 if (type != HTX_BLK_HDR)
738 return NULL;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200739
Christopher Faulete97f3ba2018-12-10 15:39:40 +0100740 delta = name.len + value.len - htx_get_blksz(blk);
Christopher Fauletd7884d32019-06-11 10:40:43 +0200741 ret = htx_prepare_blk_expansion(htx, blk, delta);
742 if (!ret)
Christopher Faulete97f3ba2018-12-10 15:39:40 +0100743 return NULL; /* not enough space */
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200744
Christopher Fauletd7884d32019-06-11 10:40:43 +0200745 /* Set the new block size and update HTX message */
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200746 blk->info = (type << 28) + (value.len << 8) + name.len;
Christopher Faulete97f3ba2018-12-10 15:39:40 +0100747 htx->data += delta;
Christopher Faulete97f3ba2018-12-10 15:39:40 +0100748
Christopher Faulet3b219722019-06-19 13:48:09 +0200749 /* Replace in place or at a new address is the same. We replace all the
750 * header (name+value). Only take care to defrag the message if
751 * necessary. */
Christopher Fauletd7884d32019-06-11 10:40:43 +0200752 if (ret == 3)
753 blk = htx_defrag(htx, blk);
754
Ilya Shipitsin47d17182020-06-21 21:42:57 +0500755 /* Finally, copy data. */
Christopher Fauletd7884d32019-06-11 10:40:43 +0200756 ptr = htx_get_blk_ptr(htx, blk);
757 ist2bin_lc(ptr, name);
758 memcpy(ptr + name.len, value.ptr, value.len);
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100759 return blk;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200760}
761
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100762/* Replaces the parts of the start-line. It returns the new start-line on
763 * success, otherwise it returns NULL. It is the caller responsibility to update
764 * sl->info, if necessary.
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200765 */
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100766struct htx_sl *htx_replace_stline(struct htx *htx, struct htx_blk *blk, const struct ist p1,
767 const struct ist p2, const struct ist p3)
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200768{
Christopher Fauletd7884d32019-06-11 10:40:43 +0200769 enum htx_blk_type type;
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100770 struct htx_sl *sl;
771 struct htx_sl tmp; /* used to save sl->info and sl->flags */
Christopher Fauletd7884d32019-06-11 10:40:43 +0200772 uint32_t sz;
Christopher Faulete97f3ba2018-12-10 15:39:40 +0100773 int32_t delta;
Christopher Fauletd7884d32019-06-11 10:40:43 +0200774 int ret;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200775
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100776 type = htx_get_blk_type(blk);
Willy Tarreauc706cd72018-12-07 17:12:22 +0100777 if (type != HTX_BLK_REQ_SL && type != HTX_BLK_RES_SL)
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100778 return NULL;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200779
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100780 /* Save start-line info and flags */
781 sl = htx_get_blk_ptr(htx, blk);
782 tmp.info = sl->info;
783 tmp.flags = sl->flags;
Christopher Faulet2bce0462019-06-25 21:31:26 +0200784 tmp.hdrs_bytes = sl->hdrs_bytes;
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100785
Christopher Fauletd7884d32019-06-11 10:40:43 +0200786 sz = htx_get_blksz(blk);
787 delta = sizeof(*sl) + p1.len + p2.len + p3.len - sz;
788 ret = htx_prepare_blk_expansion(htx, blk, delta);
789 if (!ret)
Christopher Faulete97f3ba2018-12-10 15:39:40 +0100790 return NULL; /* not enough space */
791
Christopher Fauletd7884d32019-06-11 10:40:43 +0200792 /* Set the new block size and update HTX message */
793 htx_set_blk_value_len(blk, sz+delta);
Christopher Faulete97f3ba2018-12-10 15:39:40 +0100794 htx->data += delta;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200795
Christopher Faulet3b219722019-06-19 13:48:09 +0200796 /* Replace in place or at a new address is the same. We replace all the
797 * start-line. Only take care to defrag the message if necessary. */
Christopher Fauletd7884d32019-06-11 10:40:43 +0200798 if (ret == 3)
799 blk = htx_defrag(htx, blk);
800
Christopher Faulete97f3ba2018-12-10 15:39:40 +0100801 /* Restore start-line info and flags and copy parts of the start-line */
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100802 sl = htx_get_blk_ptr(htx, blk);
803 sl->info = tmp.info;
804 sl->flags = tmp.flags;
Christopher Faulet2bce0462019-06-25 21:31:26 +0200805 sl->hdrs_bytes = tmp.hdrs_bytes;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200806
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100807 HTX_SL_P1_LEN(sl) = p1.len;
808 HTX_SL_P2_LEN(sl) = p2.len;
809 HTX_SL_P3_LEN(sl) = p3.len;
Christopher Faulet54483df2018-11-26 15:05:52 +0100810
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100811 memcpy(HTX_SL_P1_PTR(sl), p1.ptr, p1.len);
812 memcpy(HTX_SL_P2_PTR(sl), p2.ptr, p2.len);
813 memcpy(HTX_SL_P3_PTR(sl), p3.ptr, p3.len);
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200814
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100815 return sl;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200816}
817
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100818/* Add a new start-line. It returns it on success, otherwise it returns NULL. It
819 * is the caller responsibility to set sl->info, if necessary.
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200820 */
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100821struct htx_sl *htx_add_stline(struct htx *htx, enum htx_blk_type type, unsigned int flags,
822 const struct ist p1, const struct ist p2, const struct ist p3)
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200823{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100824 struct htx_blk *blk;
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100825 struct htx_sl *sl;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200826 uint32_t size;
827
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100828 if (type != HTX_BLK_REQ_SL && type != HTX_BLK_RES_SL)
829 return NULL;
830
831 size = sizeof(*sl) + p1.len + p2.len + p3.len;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200832
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100833 /* FIXME: check size (< 256MB) */
834 blk = htx_add_blk(htx, type, size);
835 if (!blk)
836 return NULL;
837 blk->info += size;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200838
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100839 sl = htx_get_blk_ptr(htx, blk);
Christopher Faulet05c083c2019-05-15 14:56:47 +0200840 sl->hdrs_bytes = -1;
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100841 sl->flags = flags;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200842
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100843 HTX_SL_P1_LEN(sl) = p1.len;
844 HTX_SL_P2_LEN(sl) = p2.len;
845 HTX_SL_P3_LEN(sl) = p3.len;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200846
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100847 memcpy(HTX_SL_P1_PTR(sl), p1.ptr, p1.len);
848 memcpy(HTX_SL_P2_PTR(sl), p2.ptr, p2.len);
849 memcpy(HTX_SL_P3_PTR(sl), p3.ptr, p3.len);
850
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100851 return sl;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200852}
853
854/* Adds an HTX block of type HDR in <htx>. It returns the new block on
Willy Tarreaued00e342018-12-07 08:47:45 +0100855 * success. Otherwise, it returns NULL. The header name is always lower cased.
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200856 */
857struct htx_blk *htx_add_header(struct htx *htx, const struct ist name,
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100858 const struct ist value)
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200859{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100860 struct htx_blk *blk;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200861
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100862 /* FIXME: check name.len (< 256B) and value.len (< 1MB) */
863 blk = htx_add_blk(htx, HTX_BLK_HDR, name.len + value.len);
864 if (!blk)
865 return NULL;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200866
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100867 blk->info += (value.len << 8) + name.len;
Willy Tarreaued00e342018-12-07 08:47:45 +0100868 ist2bin_lc(htx_get_blk_ptr(htx, blk), name);
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100869 memcpy(htx_get_blk_ptr(htx, blk) + name.len, value.ptr, value.len);
870 return blk;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200871}
872
Christopher Faulet2d7c5392019-06-03 10:41:26 +0200873/* Adds an HTX block of type TLR in <htx>. It returns the new block on
Christopher Faulet3b219722019-06-19 13:48:09 +0200874 * success. Otherwise, it returns NULL. The trailer name is always lower cased.
Christopher Faulet2d7c5392019-06-03 10:41:26 +0200875 */
876struct htx_blk *htx_add_trailer(struct htx *htx, const struct ist name,
877 const struct ist value)
878{
879 struct htx_blk *blk;
880
881 /* FIXME: check name.len (< 256B) and value.len (< 1MB) */
882 blk = htx_add_blk(htx, HTX_BLK_TLR, name.len + value.len);
883 if (!blk)
884 return NULL;
885
886 blk->info += (value.len << 8) + name.len;
887 ist2bin_lc(htx_get_blk_ptr(htx, blk), name);
888 memcpy(htx_get_blk_ptr(htx, blk) + name.len, value.ptr, value.len);
889 return blk;
890}
891
Christopher Faulet3b219722019-06-19 13:48:09 +0200892/* Add all headers from the list <hdrs> into the HTX message <htx>, followed by
Ilya Shipitsin47d17182020-06-21 21:42:57 +0500893 * the EOH. On success, it returns the last block inserted (the EOH), otherwise
Christopher Faulet3b219722019-06-19 13:48:09 +0200894 * NULL is returned. */
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200895struct htx_blk *htx_add_all_headers(struct htx *htx, const struct http_hdr *hdrs)
896{
897 int i;
898
899 for (i = 0; hdrs[i].n.len; i++) {
900 if (!htx_add_header(htx, hdrs[i].n, hdrs[i].v))
901 return NULL;
902 }
903 return htx_add_endof(htx, HTX_BLK_EOH);
904}
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200905
Christopher Faulet3b219722019-06-19 13:48:09 +0200906/* Add all trailers from the list <hdrs> into the HTX message <htx>, followed by
Ilya Shipitsin47d17182020-06-21 21:42:57 +0500907 * the EOT. On success, it returns the last block inserted (the EOT), otherwise
Christopher Faulet3b219722019-06-19 13:48:09 +0200908 * NULL is returned. */
Christopher Faulet2d7c5392019-06-03 10:41:26 +0200909struct htx_blk *htx_add_all_trailers(struct htx *htx, const struct http_hdr *hdrs)
910{
911 int i;
912
913 for (i = 0; hdrs[i].n.len; i++) {
914 if (!htx_add_trailer(htx, hdrs[i].n, hdrs[i].v))
915 return NULL;
916 }
917 return htx_add_endof(htx, HTX_BLK_EOT);
918}
919
Christopher Faulet3b219722019-06-19 13:48:09 +0200920/* Adds an HTX block of type EOH, EOT, or EOM in <htx>. It returns the new block
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200921 * on success. Otherwise, it returns NULL.
922 */
923struct htx_blk *htx_add_endof(struct htx *htx, enum htx_blk_type type)
924{
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100925 struct htx_blk *blk;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200926
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100927 blk = htx_add_blk(htx, type, 1);
928 if (!blk)
929 return NULL;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200930
Christopher Fauletaa75b3d2018-12-05 16:20:40 +0100931 blk->info += 1;
932 return blk;
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200933}
934
935
936/* Adds an HTX block of type DATA in <htx>. It first tries to append data if
Willy Tarreau0a7ef022019-05-28 10:30:11 +0200937 * possible. It returns the number of bytes consumed from <data>, which may be
938 * zero if nothing could be copied.
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200939 */
Willy Tarreau0a7ef022019-05-28 10:30:11 +0200940size_t htx_add_data(struct htx *htx, const struct ist data)
Christopher Fauleta3d2a162018-10-22 08:59:39 +0200941{
Christopher Fauletd7884d32019-06-11 10:40:43 +0200942 struct htx_blk *blk, *tailblk;
943 void *ptr;
944 uint32_t sz, room;
Willy Tarreau0350b902019-05-28 10:58:50 +0200945 int32_t len = data.len;
Willy Tarreau0a7ef022019-05-28 10:30:11 +0200946
Christopher Faulet192c6a22019-06-11 16:32:24 +0200947 if (htx->head == -1)
Willy Tarreau0350b902019-05-28 10:58:50 +0200948 goto add_new_block;
949
950 /* Not enough space to store data */
951 if (len > htx_free_data_space(htx))
952 len = htx_free_data_space(htx);
953
954 if (!len)
955 return 0;
956
957 /* get the tail and head block */
958 tailblk = htx_get_tail_blk(htx);
Christopher Fauletd7884d32019-06-11 10:40:43 +0200959 if (tailblk == NULL)
Willy Tarreau0350b902019-05-28 10:58:50 +0200960 goto add_new_block;
Christopher Fauletd7884d32019-06-11 10:40:43 +0200961 sz = htx_get_blksz(tailblk);
Willy Tarreau0350b902019-05-28 10:58:50 +0200962
963 /* Don't try to append data if the last inserted block is not of the
964 * same type */
965 if (htx_get_blk_type(tailblk) != HTX_BLK_DATA)
966 goto add_new_block;
967
968 /*
969 * Same type and enough space: append data
970 */
Christopher Fauletd7884d32019-06-11 10:40:43 +0200971 if (!htx->head_addr) {
972 if (tailblk->addr+sz != htx->tail_addr)
Willy Tarreau0350b902019-05-28 10:58:50 +0200973 goto add_new_block;
Christopher Faulet2bf43f02019-06-12 11:28:11 +0200974 room = (htx_pos_to_addr(htx, htx->tail) - htx->tail_addr);
Willy Tarreau0350b902019-05-28 10:58:50 +0200975 }
Christopher Fauletd7884d32019-06-11 10:40:43 +0200976 else {
977 if (tailblk->addr+sz != htx->head_addr)
978 goto add_new_block;
979 room = (htx->end_addr - htx->head_addr);
980 }
981 BUG_ON((int32_t)room < 0);
Willy Tarreau0350b902019-05-28 10:58:50 +0200982 if (room < len)
983 len = room;
984
985 append_data:
Christopher Fauletd7884d32019-06-11 10:40:43 +0200986 /* FIXME: check v.len + data.len < 256MB */
Willy Tarreau0350b902019-05-28 10:58:50 +0200987 /* Append data and update the block itself */
Christopher Fauletd7884d32019-06-11 10:40:43 +0200988 ptr = htx_get_blk_ptr(htx, tailblk);
989 memcpy(ptr + sz, data.ptr, len);
Christopher Faulet3e2638e2019-06-18 09:49:16 +0200990 htx_change_blk_value_len(htx, tailblk, sz+len);
Christopher Fauletd7884d32019-06-11 10:40:43 +0200991
992 BUG_ON((int32_t)htx->tail_addr < 0);
993 BUG_ON((int32_t)htx->head_addr < 0);
994 BUG_ON(htx->end_addr > htx->tail_addr);
995 BUG_ON(htx->head_addr > htx->end_addr);
Willy Tarreau0350b902019-05-28 10:58:50 +0200996 return len;
997
998 add_new_block:
Christopher Faulet2d7c5392019-06-03 10:41:26 +0200999 /* FIXME: check data.len (< 256MB) */
Willy Tarreau0350b902019-05-28 10:58:50 +02001000 blk = htx_add_blk(htx, HTX_BLK_DATA, len);
1001 if (!blk)
Willy Tarreau0a7ef022019-05-28 10:30:11 +02001002 return 0;
Willy Tarreau0350b902019-05-28 10:58:50 +02001003
1004 blk->info += len;
1005 memcpy(htx_get_blk_ptr(htx, blk), data.ptr, len);
1006 return len;
Christopher Fauleta3d2a162018-10-22 08:59:39 +02001007}
1008
Christopher Faulet86bc8df2019-06-11 10:38:38 +02001009
1010/* Adds an HTX block of type DATA in <htx> just after all other DATA
1011 * blocks. Because it relies on htx_add_data_atonce(), It may be happened to a
1012 * DATA block if possible. But, if the function succeeds, it will be the last
1013 * DATA block in all cases. If an error occurred, NULL is returned. Otherwise,
1014 * on success, the updated block (or the new one) is returned.
1015 */
1016struct htx_blk *htx_add_last_data(struct htx *htx, struct ist data)
Christopher Faulet24ed8352018-11-22 11:20:43 +01001017{
Christopher Faulet86bc8df2019-06-11 10:38:38 +02001018 struct htx_blk *blk, *pblk;
Christopher Faulet24ed8352018-11-22 11:20:43 +01001019
Christopher Faulet86bc8df2019-06-11 10:38:38 +02001020 blk = htx_add_data_atonce(htx, data);
Christopher Fauletaa75b3d2018-12-05 16:20:40 +01001021 if (!blk)
1022 return NULL;
Christopher Faulet24ed8352018-11-22 11:20:43 +01001023
Christopher Faulet86bc8df2019-06-11 10:38:38 +02001024 for (pblk = htx_get_prev_blk(htx, blk); pblk; pblk = htx_get_prev_blk(htx, pblk)) {
Christopher Faulet86bc8df2019-06-11 10:38:38 +02001025 if (htx_get_blk_type(pblk) <= HTX_BLK_DATA)
1026 break;
Christopher Faulet24ed8352018-11-22 11:20:43 +01001027
Christopher Faulet24ed8352018-11-22 11:20:43 +01001028 /* Swap .addr and .info fields */
1029 blk->addr ^= pblk->addr; pblk->addr ^= blk->addr; blk->addr ^= pblk->addr;
1030 blk->info ^= pblk->info; pblk->info ^= blk->info; blk->info ^= pblk->info;
1031
1032 if (blk->addr == pblk->addr)
1033 blk->addr += htx_get_blksz(pblk);
Christopher Faulet24ed8352018-11-22 11:20:43 +01001034 blk = pblk;
1035 }
Christopher Faulet05aab642019-04-11 13:43:57 +02001036
Christopher Faulet24ed8352018-11-22 11:20:43 +01001037 return blk;
1038}
Christopher Fauleta3d2a162018-10-22 08:59:39 +02001039
Christopher Faulet86fcf6d2019-06-11 10:41:19 +02001040/* Moves the block <blk> just before the block <ref>. Both blocks must be in the
1041 * HTX message <htx> and <blk> must be placed after <ref>. pointer to these
1042 * blocks are updated to remain valid after the move. */
1043void htx_move_blk_before(struct htx *htx, struct htx_blk **blk, struct htx_blk **ref)
1044{
1045 struct htx_blk *cblk, *pblk;
1046
1047 cblk = *blk;
1048 for (pblk = htx_get_prev_blk(htx, cblk); pblk; pblk = htx_get_prev_blk(htx, pblk)) {
1049 /* Swap .addr and .info fields */
1050 cblk->addr ^= pblk->addr; pblk->addr ^= cblk->addr; cblk->addr ^= pblk->addr;
1051 cblk->info ^= pblk->info; pblk->info ^= cblk->info; cblk->info ^= pblk->info;
1052
1053 if (cblk->addr == pblk->addr)
1054 cblk->addr += htx_get_blksz(pblk);
1055 if (pblk == *ref)
1056 break;
1057 cblk = pblk;
1058 }
1059 *blk = cblk;
1060 *ref = pblk;
1061}
Christopher Faulet0ea0c862020-01-23 11:47:53 +01001062
1063/* Append the HTX message <src> to the HTX message <dst>. It returns 1 on
1064 * success and 0 on error. All the message or nothing is copied. If an error
1065 * occurred, all blocks from <src> already appended to <dst> are truncated.
1066 */
1067int htx_append_msg(struct htx *dst, const struct htx *src)
1068{
1069 struct htx_blk *blk, *newblk;
1070 enum htx_blk_type type;
1071 uint32_t blksz, offset = dst->data;
1072
1073 for (blk = htx_get_head_blk(src); blk; blk = htx_get_next_blk(src, blk)) {
1074 type = htx_get_blk_type(blk);
1075
1076 if (type == HTX_BLK_UNUSED)
1077 continue;
1078
1079 blksz = htx_get_blksz(blk);
1080 newblk = htx_add_blk(dst, type, blksz);
1081 if (!newblk)
1082 goto error;
1083 newblk->info = blk->info;
1084 memcpy(htx_get_blk_ptr(dst, newblk), htx_get_blk_ptr(src, blk), blksz);
1085 }
1086
1087 return 1;
1088
1089 error:
1090 htx_truncate(dst, offset);
1091 return 0;
1092}