| | varnish-cache/bin/varnishtest/vtc_h2_hpack.c |
0 |
|
/*- |
1 |
|
* Copyright (c) 2008-2016 Varnish Software AS |
2 |
|
* All rights reserved. |
3 |
|
* |
4 |
|
* Author: Guillaume Quintard <guillaume.quintard@gmail.com> |
5 |
|
* |
6 |
|
* SPDX-License-Identifier: BSD-2-Clause |
7 |
|
* |
8 |
|
* Redistribution and use in source and binary forms, with or without |
9 |
|
* modification, are permitted provided that the following conditions |
10 |
|
* are met: |
11 |
|
* 1. Redistributions of source code must retain the above copyright |
12 |
|
* notice, this list of conditions and the following disclaimer. |
13 |
|
* 2. Redistributions in binary form must reproduce the above copyright |
14 |
|
* notice, this list of conditions and the following disclaimer in the |
15 |
|
* documentation and/or other materials provided with the distribution. |
16 |
|
* |
17 |
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND |
18 |
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
19 |
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
20 |
|
* ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE |
21 |
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
22 |
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
23 |
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
24 |
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
25 |
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
26 |
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
27 |
|
* SUCH DAMAGE. |
28 |
|
*/ |
29 |
|
|
30 |
|
#include <stdint.h> |
31 |
|
#include <stdio.h> |
32 |
|
#include <stdlib.h> |
33 |
|
#include <string.h> |
34 |
|
|
35 |
|
|
36 |
|
#include "vdef.h" |
37 |
|
|
38 |
|
#include "vas.h" |
39 |
|
#include "vqueue.h" |
40 |
|
|
41 |
|
#include "hpack.h" |
42 |
|
#include "vtc_h2_priv.h" |
43 |
|
|
44 |
|
struct symbol { |
45 |
|
uint32_t val; |
46 |
|
uint8_t size; |
47 |
|
}; |
48 |
|
|
49 |
|
static const struct symbol coding_table[] = { |
50 |
|
#define HPACK(i, v, l) {v, l}, |
51 |
|
#include "vtc_h2_enctbl.h" |
52 |
|
#undef HPACK |
53 |
|
{0, 0} |
54 |
|
}; |
55 |
|
|
56 |
|
#include "vtc_h2_dectbl.h" |
57 |
|
|
58 |
|
#define MASK(pack, n) (pack >> (64 - n)) |
59 |
|
static int |
60 |
99 |
huff_decode(char *str, int nm, struct hpk_iter *iter, int ilen) |
61 |
|
{ |
62 |
99 |
int l = 0; |
63 |
99 |
uint64_t pack = 0; |
64 |
99 |
unsigned pl = 0; /* pack length*/ |
65 |
99 |
struct stbl *tbl = &tbl_0; |
66 |
|
struct ssym *sym; |
67 |
|
|
68 |
99 |
(void)nm; |
69 |
1143 |
while (ilen > 0 || pl != 0) { |
70 |
|
/* make sure we have enough data*/ |
71 |
1143 |
if (pl < tbl->msk) { |
72 |
243 |
if (ilen == 0) { |
73 |
99 |
if (pl == 0 || (MASK(pack, pl) == |
74 |
99 |
(unsigned)((1U << pl) - 1U))) { |
75 |
99 |
assert(tbl == &tbl_0); |
76 |
99 |
return (l); |
77 |
|
} |
78 |
0 |
} |
79 |
|
/* fit as many bytes as we can in pack */ |
80 |
963 |
while (pl <= 56 && ilen > 0) { |
81 |
1638 |
pack |= (uint64_t)(*iter->buf & 0xff) |
82 |
819 |
<< (56 - pl); |
83 |
819 |
pl += 8; |
84 |
819 |
iter->buf++; |
85 |
819 |
ilen--; |
86 |
|
} |
87 |
144 |
} |
88 |
1044 |
assert(tbl); |
89 |
1044 |
assert(tbl->msk); |
90 |
1044 |
sym = &tbl->syms[MASK(pack, tbl->msk)]; |
91 |
|
|
92 |
1044 |
assert(sym->csm <= tbl->msk); |
93 |
|
|
94 |
1044 |
if (sym->csm == 0 || pl < sym->csm) |
95 |
0 |
return (0); |
96 |
|
|
97 |
1044 |
assert(sym->csm <= 8); |
98 |
1044 |
pack <<= sym->csm; |
99 |
1044 |
assert(sym->csm <= pl); |
100 |
1044 |
pl -= sym->csm; |
101 |
1044 |
if (sym->nxt) { |
102 |
0 |
tbl = sym->nxt; |
103 |
0 |
continue; |
104 |
|
} |
105 |
1044 |
str[l++] = sym->chr; |
106 |
1044 |
tbl = &tbl_0; |
107 |
|
} |
108 |
0 |
return (l); |
109 |
99 |
} |
110 |
|
|
111 |
|
/* inspired from Dridi Boukelmoune's cashpack. */ |
112 |
|
static enum hpk_result |
113 |
126 |
huff_encode(struct hpk_iter *iter, const char *str, int len) |
114 |
|
{ |
115 |
126 |
uint64_t pack = 0; |
116 |
126 |
int pl = 0; /* pack length*/ |
117 |
|
uint32_t v; |
118 |
|
uint8_t s; |
119 |
|
|
120 |
126 |
assert(iter->buf < iter->end); |
121 |
|
|
122 |
1422 |
while (len--) { |
123 |
1296 |
v = coding_table[(uint8_t)*str].val; |
124 |
1296 |
s = coding_table[(uint8_t)*str].size; |
125 |
|
|
126 |
1296 |
pl += s; |
127 |
1296 |
pack |= (uint64_t)v << (64 - pl); |
128 |
|
|
129 |
2196 |
while (pl >= 8) { |
130 |
900 |
if (iter->buf == iter->end) |
131 |
0 |
return (hpk_done); |
132 |
900 |
*iter->buf = (char)(pack >> 56); |
133 |
900 |
iter->buf++; |
134 |
900 |
pack <<= 8; |
135 |
900 |
pl -= 8; |
136 |
|
} |
137 |
1296 |
str++; |
138 |
|
} |
139 |
|
|
140 |
|
/* padding */ |
141 |
126 |
if (pl) { |
142 |
126 |
assert(pl < 8); |
143 |
126 |
if (iter->buf == iter->end) |
144 |
0 |
return (hpk_done); |
145 |
126 |
pl += 8; |
146 |
126 |
pack |= (uint64_t)0xff << (64 - pl); |
147 |
126 |
*iter->buf = (char)(pack >> 56); |
148 |
126 |
iter->buf++; |
149 |
126 |
} |
150 |
|
|
151 |
126 |
return (hpk_more); |
152 |
126 |
} |
153 |
|
|
154 |
|
static int |
155 |
32940 |
huff_simulate(const char *str, int ilen, int huff) |
156 |
|
{ |
157 |
32940 |
int olen = 0; |
158 |
32940 |
if (!huff || !ilen) |
159 |
32814 |
return (ilen); |
160 |
1422 |
while (ilen--) { |
161 |
1296 |
olen += coding_table[(unsigned char)*str].size; |
162 |
1296 |
str++; |
163 |
|
} |
164 |
126 |
return ((olen + 7) / 8); |
165 |
32940 |
} |
166 |
|
|
167 |
|
static enum hpk_result |
168 |
17982 |
num_decode(uint32_t *result, struct hpk_iter *iter, uint8_t prefix) |
169 |
|
{ |
170 |
17982 |
uint8_t shift = 0; |
171 |
|
|
172 |
17982 |
assert(iter->buf < iter->end); |
173 |
17982 |
assert(prefix); |
174 |
17982 |
assert(prefix <= 8); |
175 |
|
|
176 |
17982 |
*result = 0; |
177 |
17982 |
*result = *iter->buf & (0xff >> (8-prefix)); |
178 |
17982 |
if (*result < (1U << prefix) - 1U) { |
179 |
13851 |
iter->buf++; |
180 |
13851 |
return (ITER_DONE(iter)); |
181 |
|
} |
182 |
4131 |
do { |
183 |
4167 |
iter->buf++; |
184 |
4167 |
if (iter->end == iter->buf) |
185 |
0 |
return (hpk_err); |
186 |
|
/* check for overflow */ |
187 |
4167 |
if ((UINT32_MAX - *result) >> shift < (*iter->buf & 0x7f)) |
188 |
0 |
return (hpk_err); |
189 |
|
|
190 |
4167 |
*result += (uint32_t)(*iter->buf & 0x7f) << shift; |
191 |
4167 |
shift += 7; |
192 |
4167 |
} while (*iter->buf & 0x80); |
193 |
4131 |
iter->buf++; |
194 |
|
|
195 |
4131 |
return (ITER_DONE(iter)); |
196 |
17982 |
} |
197 |
|
|
198 |
|
static enum hpk_result |
199 |
33462 |
num_encode(struct hpk_iter *iter, uint8_t prefix, uint32_t num) |
200 |
|
{ |
201 |
33462 |
assert(prefix); |
202 |
33462 |
assert(prefix <= 8); |
203 |
33462 |
assert(iter->buf < iter->end); |
204 |
|
|
205 |
33462 |
uint8_t pmax = (1U << prefix) - 1U; |
206 |
|
|
207 |
33462 |
*iter->buf &= 0xffU << prefix; |
208 |
33462 |
if (num <= pmax) { |
209 |
24453 |
*iter->buf++ |= num; |
210 |
24453 |
return (ITER_DONE(iter)); |
211 |
9009 |
} else if (iter->end - iter->buf < 2) |
212 |
0 |
return (hpk_err); |
213 |
|
|
214 |
9009 |
iter->buf[0] |= pmax; |
215 |
9009 |
num -= pmax; |
216 |
9009 |
do { |
217 |
18009 |
iter->buf++; |
218 |
18009 |
if (iter->end == iter->buf) |
219 |
0 |
return (hpk_err); |
220 |
18009 |
*iter->buf = num % 128; |
221 |
18009 |
*iter->buf |= 0x80; |
222 |
18009 |
num /= 128; |
223 |
18009 |
} while (num); |
224 |
9009 |
*iter->buf++ &= 127; |
225 |
9009 |
return (ITER_DONE(iter)); |
226 |
33462 |
} |
227 |
|
|
228 |
|
static enum hpk_result |
229 |
32940 |
str_encode(struct hpk_iter *iter, const struct hpk_txt *t) |
230 |
|
{ |
231 |
32940 |
int slen = huff_simulate(t->ptr, t->len, t->huff); |
232 |
32940 |
assert(iter->buf < iter->end); |
233 |
32940 |
if (t->huff) |
234 |
126 |
*iter->buf = 0x80; |
235 |
|
else |
236 |
32814 |
*iter->buf = 0; |
237 |
|
|
238 |
32940 |
if (hpk_err == num_encode(iter, 7, slen)) |
239 |
0 |
return (hpk_err); |
240 |
|
|
241 |
32940 |
if (slen > iter->end - iter->buf) |
242 |
0 |
return (hpk_err); |
243 |
|
|
244 |
32940 |
if (t->huff) { |
245 |
126 |
return (huff_encode(iter, t->ptr, t->len)); |
246 |
|
} else { |
247 |
32814 |
memcpy(iter->buf, t->ptr, slen); |
248 |
32814 |
iter->buf += slen; |
249 |
32814 |
return (ITER_DONE(iter)); |
250 |
|
} |
251 |
32940 |
} |
252 |
|
|
253 |
|
static enum hpk_result |
254 |
9864 |
str_decode(struct hpk_iter *iter, struct hpk_txt *t) |
255 |
|
{ |
256 |
|
uint32_t num; |
257 |
|
int huff; |
258 |
|
|
259 |
9864 |
assert(iter->buf < iter->end); |
260 |
|
|
261 |
9864 |
huff = (*iter->buf & 0x80); |
262 |
9864 |
if (hpk_more != num_decode(&num, iter, 7)) |
263 |
0 |
return (hpk_err); |
264 |
9864 |
assert(iter->buf < iter->end); |
265 |
9864 |
if (num > (unsigned)(iter->end - iter->buf)) |
266 |
0 |
return (hpk_err); |
267 |
9864 |
if (huff) { /*Huffman encoding */ |
268 |
99 |
t->ptr = malloc((num * 8L) / 5L + 1L); |
269 |
99 |
AN(t->ptr); |
270 |
99 |
num = huff_decode(t->ptr, (num * 8) / 5, iter, num); |
271 |
99 |
if (!num) { |
272 |
0 |
free(t->ptr); |
273 |
0 |
return (hpk_err); |
274 |
|
} |
275 |
99 |
t->huff = 1; |
276 |
|
/* XXX: do we care? */ |
277 |
99 |
t->ptr = realloc(t->ptr, num + 1L); |
278 |
99 |
AN(t->ptr); |
279 |
99 |
} else { /* literal string */ |
280 |
9765 |
t->huff = 0; |
281 |
9765 |
t->ptr = malloc(num + 1L); |
282 |
9765 |
AN(t->ptr); |
283 |
9765 |
memcpy(t->ptr, iter->buf, num); |
284 |
9765 |
iter->buf += num; |
285 |
|
} |
286 |
|
|
287 |
9864 |
t->ptr[num] = '\0'; |
288 |
9864 |
t->len = num; |
289 |
|
|
290 |
9864 |
return (ITER_DONE(iter)); |
291 |
9864 |
} |
292 |
|
|
293 |
|
static inline void |
294 |
6336 |
txtcpy(struct hpk_txt *to, const struct hpk_txt *from) |
295 |
|
{ |
296 |
|
//AZ(to->ptr); |
297 |
6336 |
to->ptr = malloc(from->len + 1L); |
298 |
6336 |
AN(to->ptr); |
299 |
6336 |
memcpy(to->ptr, from->ptr, from->len + 1L); |
300 |
6336 |
to->len = from->len; |
301 |
6336 |
} |
302 |
|
|
303 |
|
int |
304 |
11421 |
gethpk_iterLen(const struct hpk_iter *iter) |
305 |
|
{ |
306 |
11421 |
return (iter->buf - iter->orig); |
307 |
|
} |
308 |
|
|
309 |
|
enum hpk_result |
310 |
8118 |
HPK_DecHdr(struct hpk_iter *iter, struct hpk_hdr *header) |
311 |
|
{ |
312 |
8118 |
int pref = 0; |
313 |
|
const struct hpk_txt *t; |
314 |
|
uint32_t num; |
315 |
8118 |
int must_index = 0; |
316 |
8118 |
assert(iter); |
317 |
8118 |
assert(iter->buf < iter->end); |
318 |
|
/* Indexed Header Field */ |
319 |
8118 |
if (*iter->buf & 128) { |
320 |
1035 |
header->t = hpk_idx; |
321 |
1035 |
if (hpk_err == num_decode(&num, iter, 7)) |
322 |
0 |
return (hpk_err); |
323 |
|
|
324 |
1035 |
if (num) { /* indexed key and value*/ |
325 |
1035 |
t = tbl_get_key(iter->ctx, num); |
326 |
1035 |
if (!t) |
327 |
18 |
return (hpk_err); |
328 |
1017 |
txtcpy(&header->key, t); |
329 |
|
|
330 |
1017 |
t = tbl_get_value(iter->ctx, num); |
331 |
1017 |
if (!t) { |
332 |
0 |
free(header->key.ptr); |
333 |
0 |
return (hpk_err); |
334 |
|
} |
335 |
|
|
336 |
1017 |
txtcpy(&header->value, t); |
337 |
|
|
338 |
1017 |
if (iter->buf < iter->end) |
339 |
999 |
return (hpk_more); |
340 |
|
else |
341 |
18 |
return (hpk_done); |
342 |
|
} else |
343 |
0 |
return (hpk_err); |
344 |
|
|
345 |
|
} |
346 |
|
/* Literal Header Field with Incremental Indexing */ |
347 |
7083 |
else if (*iter->buf >> 6 == 1) { |
348 |
162 |
header->t = hpk_inc; |
349 |
162 |
pref = 6; |
350 |
162 |
must_index = 1; |
351 |
162 |
} |
352 |
|
/* Literal Header Field without Indexing */ |
353 |
6921 |
else if (*iter->buf >> 4 == 0) { |
354 |
1854 |
header->t = hpk_not; |
355 |
1854 |
pref = 4; |
356 |
1854 |
} |
357 |
|
/* Literal Header Field never Indexed */ |
358 |
5067 |
else if (*iter->buf >> 4 == 1) { |
359 |
5067 |
header->t = hpk_never; |
360 |
5067 |
pref = 4; |
361 |
5067 |
} |
362 |
|
/* Dynamic Table Size Update */ |
363 |
|
/* XXX if under max allowed value */ |
364 |
0 |
else if (*iter->buf >> 5 == 1) { |
365 |
0 |
if (hpk_done != num_decode(&num, iter, 5)) |
366 |
0 |
return (hpk_err); |
367 |
0 |
return (HPK_ResizeTbl(iter->ctx, num)); |
368 |
|
} else { |
369 |
0 |
return (hpk_err); |
370 |
|
} |
371 |
|
|
372 |
7083 |
assert(pref); |
373 |
7083 |
if (hpk_more != num_decode(&num, iter, pref)) |
374 |
0 |
return (hpk_err); |
375 |
|
|
376 |
7083 |
header->i = num; |
377 |
7083 |
if (num) { /* indexed key */ |
378 |
4302 |
t = tbl_get_key(iter->ctx, num); |
379 |
4302 |
if (!t) |
380 |
0 |
return (hpk_err); |
381 |
4302 |
txtcpy(&header->key, t); |
382 |
4302 |
} else { |
383 |
2781 |
if (hpk_more != str_decode(iter, &header->key)) { |
384 |
0 |
free(header->key.ptr); |
385 |
0 |
return (hpk_err); |
386 |
|
} |
387 |
|
} |
388 |
|
|
389 |
7083 |
if (hpk_err == str_decode(iter, &header->value)) { |
390 |
0 |
free(header->key.ptr); |
391 |
0 |
return (hpk_err); |
392 |
|
} |
393 |
|
|
394 |
7083 |
if (must_index) |
395 |
162 |
push_header(iter->ctx, header); |
396 |
7083 |
return (ITER_DONE(iter)); |
397 |
8118 |
} |
398 |
|
|
399 |
|
enum hpk_result |
400 |
16920 |
HPK_EncHdr(struct hpk_iter *iter, const struct hpk_hdr *h) |
401 |
|
{ |
402 |
|
int pref; |
403 |
16920 |
int must_index = 0; |
404 |
|
enum hpk_result ret; |
405 |
16920 |
switch (h->t) { |
406 |
|
case hpk_idx: |
407 |
378 |
*iter->buf = 0x80; |
408 |
378 |
assert(num_encode(iter, 7, h->i) != hpk_err); |
409 |
378 |
return (ITER_DONE(iter)); |
410 |
|
case hpk_inc: |
411 |
198 |
*iter->buf = 0x40; |
412 |
198 |
pref = 6; |
413 |
198 |
must_index = 1; |
414 |
198 |
break; |
415 |
|
case hpk_not: |
416 |
16335 |
*iter->buf = 0x00; |
417 |
16335 |
pref = 4; |
418 |
16335 |
break; |
419 |
|
case hpk_never: |
420 |
9 |
*iter->buf = 0x10; |
421 |
9 |
pref = 4; |
422 |
9 |
break; |
423 |
|
default: |
424 |
0 |
INCOMPL(); |
425 |
0 |
} |
426 |
16542 |
if (h->i) { |
427 |
144 |
if (hpk_more != num_encode(iter, pref, h->i)) |
428 |
0 |
return (hpk_err); |
429 |
144 |
} else { |
430 |
16398 |
iter->buf++; |
431 |
16398 |
if (hpk_more != str_encode(iter, &h->key)) |
432 |
0 |
return (hpk_err); |
433 |
|
} |
434 |
16542 |
ret = str_encode(iter, &h->value); |
435 |
16542 |
if (ret == hpk_err) |
436 |
0 |
return (hpk_err); |
437 |
16542 |
if (must_index) |
438 |
198 |
push_header(iter->ctx, h); |
439 |
16542 |
return (ret); |
440 |
|
|
441 |
16920 |
} |