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