GRPC Core 0.10.0.0

- Main Page
- Data Structures
- Files

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
hpack_table.h
Go to the documentation of this file.
1 /*
2 *
3 * Copyright 2015, Google Inc.
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met:
9 *
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above
13 * copyright notice, this list of conditions and the following disclaimer
14 * in the documentation and/or other materials provided with the
15 * distribution.
16 * * Neither the name of Google Inc. nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 *
32 */
33
34 #ifndef GRPC_INTERNAL_CORE_TRANSPORT_CHTTP2_HPACK_TABLE_H
35 #define GRPC_INTERNAL_CORE_TRANSPORT_CHTTP2_HPACK_TABLE_H
36
37 #include "src/core/transport/metadata.h"
38 #include <grpc/support/port_platform.h>
39 #include <grpc/support/slice.h>
40
41 /* HPACK header table */
42
43 /* last index in the static table */
44 #define GRPC_CHTTP2_LAST_STATIC_ENTRY 61
45
46 /* Initial table size as per the spec */
47 #define GRPC_CHTTP2_INITIAL_HPACK_TABLE_SIZE 4096
48 /* Maximum table size that we'll use */
49 #define GRPC_CHTTP2_MAX_HPACK_TABLE_SIZE GRPC_CHTTP2_INITIAL_HPACK_TABLE_SIZE
50 /* Per entry overhead bytes as per the spec */
51 #define GRPC_CHTTP2_HPACK_ENTRY_OVERHEAD 32
52 /* Maximum number of entries we could possibly fit in the table, given defined
53 overheads */
54 #define GRPC_CHTTP2_MAX_TABLE_COUNT \
55 ((GRPC_CHTTP2_MAX_HPACK_TABLE_SIZE + GRPC_CHTTP2_HPACK_ENTRY_OVERHEAD - 1) / \
56 GRPC_CHTTP2_HPACK_ENTRY_OVERHEAD)
57
58 /* hpack decoder table */
59 typedef struct {
60 grpc_mdctx *mdctx;
61 /* the first used entry in ents */
62 gpr_uint16 first_ent;
63 /* the last used entry in ents */
64 gpr_uint16 last_ent;
65 /* how many entries are in the table */
66 gpr_uint16 num_ents;
67 /* the amount of memory used by the table, according to the hpack algorithm */
68 gpr_uint16 mem_used;
69 /* the max memory allowed to be used by the table, according to the hpack
70 algorithm */
71 gpr_uint16 max_bytes;
72 /* a circular buffer of headers - this is stored in the opposite order to
73 what hpack specifies, in order to simplify table management a little...
74 meaning lookups need to SUBTRACT from the end position */
75 grpc_mdelem *ents[GRPC_CHTTP2_MAX_TABLE_COUNT];
76 grpc_mdelem *static_ents[GRPC_CHTTP2_LAST_STATIC_ENTRY];
77 } grpc_chttp2_hptbl;
78
79 /* initialize a hpack table */
80 void grpc_chttp2_hptbl_init(grpc_chttp2_hptbl *tbl, grpc_mdctx *mdctx);
81 void grpc_chttp2_hptbl_destroy(grpc_chttp2_hptbl *tbl);
82
83 /* lookup a table entry based on its hpack index */
84 grpc_mdelem *grpc_chttp2_hptbl_lookup(const grpc_chttp2_hptbl *tbl,
85 gpr_uint32 index);
86 /* add a table entry to the index */
87 void grpc_chttp2_hptbl_add(grpc_chttp2_hptbl *tbl, grpc_mdelem *md);
88 /* Find a key/value pair in the table... returns the index in the table of the
89 most similar entry, or 0 if the value was not found */
90 typedef struct {
91 gpr_uint16 index;
92 gpr_uint8 has_value;
93 } grpc_chttp2_hptbl_find_result;
94 grpc_chttp2_hptbl_find_result grpc_chttp2_hptbl_find(
95 const grpc_chttp2_hptbl *tbl, grpc_mdelem *md);
96
97 #endif /* GRPC_INTERNAL_CORE_TRANSPORT_CHTTP2_HPACK_TABLE_H */
grpc_chttp2_hptbl_destroy
void grpc_chttp2_hptbl_destroy(grpc_chttp2_hptbl *tbl)
Definition: hpack_table.c:122
port_platform.h
gpr_uint8
uint8_t gpr_uint8
Definition: port_platform.h:307
grpc_chttp2_hptbl_find_result::index
gpr_uint16 index
Definition: hpack_table.h:91
grpc_chttp2_hptbl::max_bytes
gpr_uint16 max_bytes
Definition: hpack_table.h:71
GRPC_CHTTP2_LAST_STATIC_ENTRY
#define GRPC_CHTTP2_LAST_STATIC_ENTRY
Definition: hpack_table.h:44
grpc_chttp2_hptbl
Definition: hpack_table.h:59
metadata.h
gpr_uint32
uint32_t gpr_uint32
Definition: port_platform.h:309
grpc_chttp2_hptbl_lookup
grpc_mdelem * grpc_chttp2_hptbl_lookup(const grpc_chttp2_hptbl *tbl, gpr_uint32 index)
Definition: hpack_table.c:133
grpc_chttp2_hptbl::num_ents
gpr_uint16 num_ents
Definition: hpack_table.h:66
grpc_chttp2_hptbl::mdctx
grpc_mdctx * mdctx
Definition: hpack_table.h:60
grpc_chttp2_hptbl::last_ent
gpr_uint16 last_ent
Definition: hpack_table.h:64
grpc_mdctx
Definition: metadata.c:98
grpc_mdelem
Definition: metadata.h:78
grpc_chttp2_hptbl_add
void grpc_chttp2_hptbl_add(grpc_chttp2_hptbl *tbl, grpc_mdelem *md)
Definition: hpack_table.c:161
gpr_uint16
uint16_t gpr_uint16
Definition: port_platform.h:308
grpc_chttp2_hptbl::first_ent
gpr_uint16 first_ent
Definition: hpack_table.h:62
slice.h
grpc_chttp2_hptbl_find
grpc_chttp2_hptbl_find_result grpc_chttp2_hptbl_find(const grpc_chttp2_hptbl *tbl, grpc_mdelem *md)
Definition: hpack_table.c:198
grpc_chttp2_hptbl_find_result::has_value
gpr_uint8 has_value
Definition: hpack_table.h:92
grpc_chttp2_hptbl_find_result
Definition: hpack_table.h:90
GRPC_CHTTP2_MAX_TABLE_COUNT
#define GRPC_CHTTP2_MAX_TABLE_COUNT
Definition: hpack_table.h:54
grpc_chttp2_hptbl::mem_used
gpr_uint16 mem_used
Definition: hpack_table.h:68
grpc_chttp2_hptbl_init
void grpc_chttp2_hptbl_init(grpc_chttp2_hptbl *tbl, grpc_mdctx *mdctx)
Definition: hpack_table.c:110