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 275
huff_decode(char *str, int nm, struct hpk_iter *iter, int ilen)
61
{
62 275
        int l = 0;
63 275
        uint64_t pack = 0;
64 275
        unsigned pl = 0; /* pack length*/
65 275
        struct stbl *tbl = &tbl_0;
66
        struct ssym *sym;
67
68 275
        (void)nm;
69 3175
        while (ilen > 0 || pl != 0) {
70
                /* make sure we have enough data*/
71 3175
                if (pl < tbl->msk) {
72 675
                        if (ilen == 0) {
73 275
                                if (pl == 0 || (MASK(pack, pl) ==
74 275
                                                (unsigned)((1U << pl) - 1U))) {
75 275
                                        assert(tbl == &tbl_0);
76 275
                                        return (l);
77
                                }
78 0
                        }
79
                        /* fit as many bytes as we can in pack */
80 2675
                        while (pl <= 56 && ilen > 0) {
81 4550
                                pack |= (uint64_t)(*iter->buf & 0xff)
82 2275
                                        << (56 - pl);
83 2275
                                pl += 8;
84 2275
                                iter->buf++;
85 2275
                                ilen--;
86
                        }
87 400
                }
88 2900
                assert(tbl);
89 2900
                assert(tbl->msk);
90 2900
                sym = &tbl->syms[MASK(pack, tbl->msk)];
91
92 2900
                assert(sym->csm <= tbl->msk);
93
94 2900
                if (sym->csm == 0 || pl < sym->csm)
95 0
                        return (0);
96
97 2900
                assert(sym->csm <= 8);
98 2900
                pack <<= sym->csm;
99 2900
                assert(sym->csm <= pl);
100 2900
                pl -= sym->csm;
101 2900
                if (sym->nxt) {
102 0
                        tbl = sym->nxt;
103 0
                        continue;
104
                }
105 2900
                str[l++] = sym->chr;
106 2900
                tbl = &tbl_0;
107
        }
108 0
        return (l);
109 275
}
110
111
/* inspired from Dridi Boukelmoune's cashpack. */
112
static enum hpk_result
113 350
huff_encode(struct hpk_iter *iter, const char *str, int len)
114
{
115 350
        uint64_t pack = 0;
116 350
        int pl = 0; /* pack length*/
117
        uint32_t        v;
118
        uint8_t         s;
119
120 350
        assert(iter->buf < iter->end);
121
122 3950
        while (len--) {
123 3600
                v = coding_table[(uint8_t)*str].val;
124 3600
                s = coding_table[(uint8_t)*str].size;
125
126 3600
                pl += s;
127 3600
                pack |= (uint64_t)v << (64 - pl);
128
129 6100
                while (pl >= 8) {
130 2500
                        if (iter->buf == iter->end)
131 0
                                return (hpk_done);
132 2500
                        *iter->buf = (char)(pack >> 56);
133 2500
                        iter->buf++;
134 2500
                        pack <<= 8;
135 2500
                        pl -= 8;
136
                }
137 3600
                str++;
138
        }
139
140
        /* padding */
141 350
        if (pl) {
142 350
                assert(pl < 8);
143 350
                if (iter->buf == iter->end)
144 0
                        return (hpk_done);
145 350
                pl += 8;
146 350
                pack |= (uint64_t)0xff << (64 - pl);
147 350
                *iter->buf = (char)(pack >> 56);
148 350
                iter->buf++;
149 350
        }
150
151 350
        return (hpk_more);
152 350
}
153
154
static int
155 38100
huff_simulate(const char *str, int ilen, int huff)
156
{
157 38100
        int olen = 0;
158 38100
        if (!huff || !ilen)
159 37750
                return (ilen);
160 3950
        while (ilen--) {
161 3600
                olen += coding_table[(unsigned char)*str].size;
162 3600
                str++;
163
        }
164 350
        return ((olen + 7) / 8);
165 38100
}
166
167
static enum hpk_result
168 49550
num_decode(uint32_t *result, struct hpk_iter *iter, uint8_t prefix)
169
{
170 49550
        uint8_t shift = 0;
171
172 49550
        assert(iter->buf < iter->end);
173 49550
        assert(prefix);
174 49550
        assert(prefix <= 8);
175
176 49550
        *result = 0;
177 49550
        *result = *iter->buf & (0xff >> (8-prefix));
178 49550
        if (*result < (1U << prefix) - 1U) {
179 38225
                iter->buf++;
180 38225
                return (ITER_DONE(iter));
181
        }
182 11325
        do {
183 11425
                iter->buf++;
184 11425
                if (iter->end == iter->buf)
185 0
                        return (hpk_err);
186
                /* check for overflow */
187 11425
                if ((UINT32_MAX - *result) >> shift < (*iter->buf & 0x7f))
188 0
                        return (hpk_err);
189
190 11425
                *result += (uint32_t)(*iter->buf & 0x7f) << shift;
191 11425
                shift += 7;
192 11425
        } while (*iter->buf & 0x80);
193 11325
        iter->buf++;
194
195 11325
        return (ITER_DONE(iter));
196 49550
}
197
198
static enum hpk_result
199 39550
num_encode(struct hpk_iter *iter, uint8_t prefix, uint32_t num)
200
{
201 39550
        assert(prefix);
202 39550
        assert(prefix <= 8);
203 39550
        assert(iter->buf < iter->end);
204
205 39550
        uint8_t pmax = (1U << prefix) - 1U;
206
207 39550
        *iter->buf &= 0xffU << prefix;
208 39550
        if (num <= pmax) {
209 39525
                *iter->buf++ |= num;
210 39525
                return (ITER_DONE(iter));
211 25
        } else if (iter->end - iter->buf < 2)
212 0
                return (hpk_err);
213
214 25
        iter->buf[0] |= pmax;
215 25
        num -= pmax;
216 25
        do {
217 25
                iter->buf++;
218 25
                if (iter->end == iter->buf)
219 0
                        return (hpk_err);
220 25
                *iter->buf = num % 128;
221 25
                *iter->buf |= 0x80;
222 25
                num /= 128;
223 25
        } while (num);
224 25
        *iter->buf++ &= 127;
225 25
        return (ITER_DONE(iter));
226 39550
}
227
228
static enum hpk_result
229 38100
str_encode(struct hpk_iter *iter, const struct hpk_txt *t)
230
{
231 38100
        int slen = huff_simulate(t->ptr, t->len, t->huff);
232 38100
        assert(iter->buf < iter->end);
233 38100
        if (t->huff)
234 350
                *iter->buf = 0x80;
235
        else
236 37750
                *iter->buf = 0;
237
238 38100
        if (hpk_err == num_encode(iter, 7, slen))
239 0
                return (hpk_err);
240
241 38100
        if (slen > iter->end - iter->buf)
242 0
                return (hpk_err);
243
244 38100
        if (t->huff) {
245 350
                return (huff_encode(iter, t->ptr, t->len));
246
        } else {
247 37750
                memcpy(iter->buf, t->ptr, slen);
248 37750
                iter->buf += slen;
249 37750
                return (ITER_DONE(iter));
250
        }
251 38100
}
252
253
static enum hpk_result
254 27200
str_decode(struct hpk_iter *iter, struct hpk_txt *t)
255
{
256
        uint32_t num;
257
        int huff;
258
259 27200
        assert(iter->buf < iter->end);
260
261 27200
        huff = (*iter->buf & 0x80);
262 27200
        if (hpk_more != num_decode(&num, iter, 7))
263 0
                return (hpk_err);
264 27200
        assert(iter->buf < iter->end);
265 27200
        if (num > (unsigned)(iter->end - iter->buf))
266 0
                return (hpk_err);
267 27200
        if (huff) { /*Huffman encoding */
268 275
                t->ptr = malloc((num * 8L) / 5L + 1L);
269 275
                AN(t->ptr);
270 275
                num = huff_decode(t->ptr, (num * 8) / 5, iter, num);
271 275
                if (!num) {
272 0
                        free(t->ptr);
273 0
                        return (hpk_err);
274
                }
275 275
                t->huff = 1;
276
                /* XXX: do we care? */
277 275
                t->ptr = realloc(t->ptr, num + 1L);
278 275
                AN(t->ptr);
279 275
        } else { /* literal string */
280 26925
                t->huff = 0;
281 26925
                t->ptr = malloc(num + 1L);
282 26925
                AN(t->ptr);
283 26925
                memcpy(t->ptr, iter->buf, num);
284 26925
                iter->buf += num;
285
        }
286
287 27200
        t->ptr[num] = '\0';
288 27200
        t->len = num;
289
290 27200
        return (ITER_DONE(iter));
291 27200
}
292
293
static inline void
294 17400
txtcpy(struct hpk_txt *to, const struct hpk_txt *from)
295
{
296
        //AZ(to->ptr);
297 17400
        to->ptr = malloc(from->len + 1L);
298 17400
        AN(to->ptr);
299 17400
        memcpy(to->ptr, from->ptr, from->len + 1L);
300 17400
        to->len = from->len;
301 17400
}
302
303
int
304 6525
gethpk_iterLen(const struct hpk_iter *iter)
305
{
306 6525
        return (iter->buf - iter->orig);
307
}
308
309
enum hpk_result
310 22350
HPK_DecHdr(struct hpk_iter *iter, struct hpk_hdr *header)
311
{
312 22350
        int pref = 0;
313
        const struct hpk_txt *t;
314
        uint32_t num;
315 22350
        int must_index = 0;
316 22350
        assert(iter);
317 22350
        assert(iter->buf < iter->end);
318
        /* Indexed Header Field */
319 22350
        if (*iter->buf & 128) {
320 2850
                header->t = hpk_idx;
321 2850
                if (hpk_err == num_decode(&num, iter, 7))
322 0
                        return (hpk_err);
323
324 2850
                if (num) { /* indexed key and value*/
325 2850
                        t = tbl_get_key(iter->ctx, num);
326 2850
                        if (!t)
327 50
                                return (hpk_err);
328 2800
                        txtcpy(&header->key, t);
329
330 2800
                        t = tbl_get_value(iter->ctx, num);
331 2800
                        if (!t) {
332 0
                                free(header->key.ptr);
333 0
                                return (hpk_err);
334
                        }
335
336 2800
                        txtcpy(&header->value, t);
337
338 2800
                        if (iter->buf < iter->end)
339 2750
                                return (hpk_more);
340
                        else
341 50
                                return (hpk_done);
342
                } else
343 0
                        return (hpk_err);
344
345
        }
346
        /* Literal Header Field with Incremental Indexing */
347 19500
        else if (*iter->buf >> 6 == 1) {
348 450
                header->t = hpk_inc;
349 450
                pref = 6;
350 450
                must_index = 1;
351 450
        }
352
        /* Literal Header Field without Indexing */
353 19050
        else if (*iter->buf >> 4 == 0) {
354 5150
                header->t = hpk_not;
355 5150
                pref = 4;
356 5150
        }
357
        /* Literal Header Field never Indexed */
358 13900
        else if (*iter->buf >> 4 == 1) {
359 13900
                header->t = hpk_never;
360 13900
                pref = 4;
361 13900
        }
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 19500
        assert(pref);
373 19500
        if (hpk_more != num_decode(&num, iter, pref))
374 0
                return (hpk_err);
375
376 19500
        header->i = num;
377 19500
        if (num) { /* indexed key */
378 11800
                t = tbl_get_key(iter->ctx, num);
379 11800
                if (!t)
380 0
                        return (hpk_err);
381 11800
                txtcpy(&header->key, t);
382 11800
        } else {
383 7700
                if (hpk_more != str_decode(iter, &header->key)) {
384 0
                        free(header->key.ptr);
385 0
                        return (hpk_err);
386
                }
387
        }
388
389 19500
        if (hpk_err == str_decode(iter, &header->value)) {
390 0
                free(header->key.ptr);
391 0
                return (hpk_err);
392
        }
393
394 19500
        if (must_index)
395 450
                push_header(iter->ctx, header);
396 19500
        return (ITER_DONE(iter));
397 22350
}
398
399
enum hpk_result
400 20300
HPK_EncHdr(struct hpk_iter *iter, const struct hpk_hdr *h)
401
{
402
        int pref;
403 20300
        int must_index = 0;
404
        enum hpk_result ret;
405 20300
        switch (h->t) {
406
                case hpk_idx:
407 1050
                        *iter->buf = 0x80;
408 1050
                        assert(num_encode(iter, 7, h->i) != hpk_err);
409 1050
                        return (ITER_DONE(iter));
410
                case hpk_inc:
411 550
                        *iter->buf = 0x40;
412 550
                        pref = 6;
413 550
                        must_index = 1;
414 550
                        break;
415
                case hpk_not:
416 18675
                        *iter->buf = 0x00;
417 18675
                        pref = 4;
418 18675
                        break;
419
                case hpk_never:
420 25
                        *iter->buf = 0x10;
421 25
                        pref = 4;
422 25
                        break;
423
                default:
424 0
                        INCOMPL();
425 0
        }
426 19250
        if (h->i) {
427 400
                if (hpk_more != num_encode(iter, pref, h->i))
428 0
                        return (hpk_err);
429 400
        } else {
430 18850
                iter->buf++;
431 18850
                if (hpk_more != str_encode(iter, &h->key))
432 0
                        return (hpk_err);
433
        }
434 19250
        ret = str_encode(iter, &h->value);
435 19250
        if (ret == hpk_err)
436 0
                return (hpk_err);
437 19250
        if (must_index)
438 550
                push_header(iter->ctx, h);
439 19250
        return (ret);
440
441 20300
}