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