Coverage Report

Created: 2025-08-29 06:47

/src/brotli/c/dec/state.c
Line
Count
Source (jump to first uncovered line)
1
/* Copyright 2015 Google Inc. All Rights Reserved.
2
3
   Distributed under MIT license.
4
   See file LICENSE for detail or copy at https://opensource.org/licenses/MIT
5
*/
6
7
#include "state.h"
8
9
#include "../common/dictionary.h"
10
#include "../common/platform.h"
11
#include "huffman.h"
12
13
#if defined(__cplusplus) || defined(c_plusplus)
14
extern "C" {
15
#endif
16
17
#ifdef BROTLI_REPORTING
18
/* When BROTLI_REPORTING is defined extra reporting module have to be linked. */
19
void BrotliDecoderOnStart(const BrotliDecoderState* s);
20
void BrotliDecoderOnFinish(const BrotliDecoderState* s);
21
#define BROTLI_DECODER_ON_START(s) BrotliDecoderOnStart(s);
22
#define BROTLI_DECODER_ON_FINISH(s) BrotliDecoderOnFinish(s);
23
#else
24
#if !defined(BROTLI_DECODER_ON_START)
25
2.41k
#define BROTLI_DECODER_ON_START(s) (void)(s);
26
#endif
27
#if !defined(BROTLI_DECODER_ON_FINISH)
28
2.41k
#define BROTLI_DECODER_ON_FINISH(s) (void)(s);
29
#endif
30
#endif
31
32
BROTLI_BOOL BrotliDecoderStateInit(BrotliDecoderState* s,
33
2.41k
    brotli_alloc_func alloc_func, brotli_free_func free_func, void* opaque) {
34
2.41k
  BROTLI_DECODER_ON_START(s);
35
2.41k
  if (!alloc_func) {
36
2.41k
    s->alloc_func = BrotliDefaultAllocFunc;
37
2.41k
    s->free_func = BrotliDefaultFreeFunc;
38
2.41k
    s->memory_manager_opaque = 0;
39
2.41k
  } else {
40
0
    s->alloc_func = alloc_func;
41
0
    s->free_func = free_func;
42
0
    s->memory_manager_opaque = opaque;
43
0
  }
44
45
2.41k
  s->error_code = 0; /* BROTLI_DECODER_NO_ERROR */
46
47
2.41k
  BrotliInitBitReader(&s->br);
48
2.41k
  s->state = BROTLI_STATE_UNINITED;
49
2.41k
  s->large_window = 0;
50
2.41k
  s->substate_metablock_header = BROTLI_STATE_METABLOCK_HEADER_NONE;
51
2.41k
  s->substate_uncompressed = BROTLI_STATE_UNCOMPRESSED_NONE;
52
2.41k
  s->substate_decode_uint8 = BROTLI_STATE_DECODE_UINT8_NONE;
53
2.41k
  s->substate_read_block_length = BROTLI_STATE_READ_BLOCK_LENGTH_NONE;
54
55
2.41k
  s->buffer_length = 0;
56
2.41k
  s->loop_counter = 0;
57
2.41k
  s->pos = 0;
58
2.41k
  s->rb_roundtrips = 0;
59
2.41k
  s->partial_pos_out = 0;
60
2.41k
  s->used_input = 0;
61
62
2.41k
  s->block_type_trees = NULL;
63
2.41k
  s->block_len_trees = NULL;
64
2.41k
  s->ringbuffer = NULL;
65
2.41k
  s->ringbuffer_size = 0;
66
2.41k
  s->new_ringbuffer_size = 0;
67
2.41k
  s->ringbuffer_mask = 0;
68
69
2.41k
  s->context_map = NULL;
70
2.41k
  s->context_modes = NULL;
71
2.41k
  s->dist_context_map = NULL;
72
2.41k
  s->context_map_slice = NULL;
73
2.41k
  s->dist_context_map_slice = NULL;
74
75
2.41k
  s->literal_hgroup.codes = NULL;
76
2.41k
  s->literal_hgroup.htrees = NULL;
77
2.41k
  s->insert_copy_hgroup.codes = NULL;
78
2.41k
  s->insert_copy_hgroup.htrees = NULL;
79
2.41k
  s->distance_hgroup.codes = NULL;
80
2.41k
  s->distance_hgroup.htrees = NULL;
81
82
2.41k
  s->is_last_metablock = 0;
83
2.41k
  s->is_uncompressed = 0;
84
2.41k
  s->is_metadata = 0;
85
2.41k
  s->should_wrap_ringbuffer = 0;
86
2.41k
  s->canny_ringbuffer_allocation = 1;
87
88
2.41k
  s->window_bits = 0;
89
2.41k
  s->max_distance = 0;
90
2.41k
  s->dist_rb[0] = 16;
91
2.41k
  s->dist_rb[1] = 15;
92
2.41k
  s->dist_rb[2] = 11;
93
2.41k
  s->dist_rb[3] = 4;
94
2.41k
  s->dist_rb_idx = 0;
95
2.41k
  s->block_type_trees = NULL;
96
2.41k
  s->block_len_trees = NULL;
97
98
2.41k
  s->mtf_upper_bound = 63;
99
100
2.41k
  s->compound_dictionary = NULL;
101
2.41k
  s->dictionary =
102
2.41k
      BrotliSharedDictionaryCreateInstance(alloc_func, free_func, opaque);
103
2.41k
  if (!s->dictionary) return BROTLI_FALSE;
104
105
2.41k
  s->metadata_start_func = NULL;
106
2.41k
  s->metadata_chunk_func = NULL;
107
2.41k
  s->metadata_callback_opaque = 0;
108
109
2.41k
  return BROTLI_TRUE;
110
2.41k
}
111
112
14.2k
void BrotliDecoderStateMetablockBegin(BrotliDecoderState* s) {
113
14.2k
  s->meta_block_remaining_len = 0;
114
14.2k
  s->block_length[0] = BROTLI_BLOCK_SIZE_CAP;
115
14.2k
  s->block_length[1] = BROTLI_BLOCK_SIZE_CAP;
116
14.2k
  s->block_length[2] = BROTLI_BLOCK_SIZE_CAP;
117
14.2k
  s->num_block_types[0] = 1;
118
14.2k
  s->num_block_types[1] = 1;
119
14.2k
  s->num_block_types[2] = 1;
120
14.2k
  s->block_type_rb[0] = 1;
121
14.2k
  s->block_type_rb[1] = 0;
122
14.2k
  s->block_type_rb[2] = 1;
123
14.2k
  s->block_type_rb[3] = 0;
124
14.2k
  s->block_type_rb[4] = 1;
125
14.2k
  s->block_type_rb[5] = 0;
126
14.2k
  s->context_map = NULL;
127
14.2k
  s->context_modes = NULL;
128
14.2k
  s->dist_context_map = NULL;
129
14.2k
  s->context_map_slice = NULL;
130
14.2k
  s->literal_htree = NULL;
131
14.2k
  s->dist_context_map_slice = NULL;
132
14.2k
  s->dist_htree_index = 0;
133
14.2k
  s->context_lookup = NULL;
134
14.2k
  s->literal_hgroup.codes = NULL;
135
14.2k
  s->literal_hgroup.htrees = NULL;
136
14.2k
  s->insert_copy_hgroup.codes = NULL;
137
14.2k
  s->insert_copy_hgroup.htrees = NULL;
138
14.2k
  s->distance_hgroup.codes = NULL;
139
14.2k
  s->distance_hgroup.htrees = NULL;
140
14.2k
}
141
142
14.2k
void BrotliDecoderStateCleanupAfterMetablock(BrotliDecoderState* s) {
143
14.2k
  BROTLI_DECODER_FREE(s, s->context_modes);
144
14.2k
  BROTLI_DECODER_FREE(s, s->context_map);
145
14.2k
  BROTLI_DECODER_FREE(s, s->dist_context_map);
146
14.2k
  BROTLI_DECODER_FREE(s, s->literal_hgroup.htrees);
147
14.2k
  BROTLI_DECODER_FREE(s, s->insert_copy_hgroup.htrees);
148
14.2k
  BROTLI_DECODER_FREE(s, s->distance_hgroup.htrees);
149
14.2k
}
150
151
2.41k
void BrotliDecoderStateCleanup(BrotliDecoderState* s) {
152
2.41k
  BrotliDecoderStateCleanupAfterMetablock(s);
153
154
2.41k
  BROTLI_DECODER_ON_FINISH(s);
155
156
2.41k
  BROTLI_DECODER_FREE(s, s->compound_dictionary);
157
2.41k
  BrotliSharedDictionaryDestroyInstance(s->dictionary);
158
2.41k
  s->dictionary = NULL;
159
2.41k
  BROTLI_DECODER_FREE(s, s->ringbuffer);
160
2.41k
  BROTLI_DECODER_FREE(s, s->block_type_trees);
161
2.41k
}
162
163
BROTLI_BOOL BrotliDecoderHuffmanTreeGroupInit(BrotliDecoderState* s,
164
    HuffmanTreeGroup* group, brotli_reg_t alphabet_size_max,
165
26.6k
    brotli_reg_t alphabet_size_limit, brotli_reg_t ntrees) {
166
  /* 376 = 256 (1-st level table) + 4 + 7 + 15 + 31 + 63 (2-nd level mix-tables)
167
     This number is discovered "unlimited" "enough" calculator; it is actually
168
     a wee bigger than required in several cases (especially for alphabets with
169
     less than 16 symbols). */
170
26.6k
  const size_t max_table_size = alphabet_size_limit + 376;
171
26.6k
  const size_t code_size = sizeof(HuffmanCode) * ntrees * max_table_size;
172
26.6k
  const size_t htree_size = sizeof(HuffmanCode*) * ntrees;
173
  /* Pointer alignment is, hopefully, wider than sizeof(HuffmanCode). */
174
26.6k
  HuffmanCode** p = (HuffmanCode**)BROTLI_DECODER_ALLOC(s,
175
26.6k
      code_size + htree_size);
176
26.6k
  group->alphabet_size_max = (uint16_t)alphabet_size_max;
177
26.6k
  group->alphabet_size_limit = (uint16_t)alphabet_size_limit;
178
26.6k
  group->num_htrees = (uint16_t)ntrees;
179
26.6k
  group->htrees = p;
180
26.6k
  group->codes = p ? (HuffmanCode*)(&p[ntrees]) : NULL;
181
26.6k
  return !!p;
182
26.6k
}
183
184
#if defined(__cplusplus) || defined(c_plusplus)
185
}  /* extern "C" */
186
#endif