Coverage Report

Created: 2025-07-18 06:40

/src/h2o/deps/brotli/c/enc/command.h
Line
Count
Source (jump to first uncovered line)
1
/* Copyright 2013 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
/* This class models a sequence of literals and a backward reference copy. */
8
9
#ifndef BROTLI_ENC_COMMAND_H_
10
#define BROTLI_ENC_COMMAND_H_
11
12
#include "../common/constants.h"
13
#include <brotli/port.h>
14
#include <brotli/types.h>
15
#include "./fast_log.h"
16
#include "./prefix.h"
17
18
#if defined(__cplusplus) || defined(c_plusplus)
19
extern "C" {
20
#endif
21
22
static uint32_t kInsBase[] =   { 0, 1, 2, 3, 4, 5, 6, 8, 10, 14, 18, 26, 34, 50,
23
    66, 98, 130, 194, 322, 578, 1090, 2114, 6210, 22594 };
24
static uint32_t kInsExtra[] =  { 0, 0, 0, 0, 0, 0, 1, 1,  2,  2,  3,  3,  4,  4,
25
    5,   5,   6,   7,   8,   9,   10,   12,   14,    24 };
26
static uint32_t kCopyBase[] =  { 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 14, 18, 22, 30,
27
    38, 54,  70, 102, 134, 198, 326,   582, 1094,  2118 };
28
static uint32_t kCopyExtra[] = { 0, 0, 0, 0, 0, 0, 0, 0,  1,  1,  2,  2,  3,  3,
29
     4,  4,   5,   5,   6,   7,   8,     9,   10,    24 };
30
31
0
static BROTLI_INLINE uint16_t GetInsertLengthCode(size_t insertlen) {
32
0
  if (insertlen < 6) {
33
0
    return (uint16_t)insertlen;
34
0
  } else if (insertlen < 130) {
35
0
    uint32_t nbits = Log2FloorNonZero(insertlen - 2) - 1u;
36
0
    return (uint16_t)((nbits << 1) + ((insertlen - 2) >> nbits) + 2);
37
0
  } else if (insertlen < 2114) {
38
0
    return (uint16_t)(Log2FloorNonZero(insertlen - 66) + 10);
39
0
  } else if (insertlen < 6210) {
40
0
    return 21u;
41
0
  } else if (insertlen < 22594) {
42
0
    return 22u;
43
0
  } else {
44
0
    return 23u;
45
0
  }
46
0
}
Unexecuted instantiation: backward_references.c:GetInsertLengthCode
Unexecuted instantiation: backward_references_hq.c:GetInsertLengthCode
Unexecuted instantiation: bit_cost.c:GetInsertLengthCode
Unexecuted instantiation: block_splitter.c:GetInsertLengthCode
Unexecuted instantiation: brotli_bit_stream.c:GetInsertLengthCode
Unexecuted instantiation: cluster.c:GetInsertLengthCode
Unexecuted instantiation: compress_fragment.c:GetInsertLengthCode
Unexecuted instantiation: compress_fragment_two_pass.c:GetInsertLengthCode
Unexecuted instantiation: encode.c:GetInsertLengthCode
Unexecuted instantiation: histogram.c:GetInsertLengthCode
Unexecuted instantiation: metablock.c:GetInsertLengthCode
47
48
0
static BROTLI_INLINE uint16_t GetCopyLengthCode(size_t copylen) {
49
0
  if (copylen < 10) {
50
0
    return (uint16_t)(copylen - 2);
51
0
  } else if (copylen < 134) {
52
0
    uint32_t nbits = Log2FloorNonZero(copylen - 6) - 1u;
53
0
    return (uint16_t)((nbits << 1) + ((copylen - 6) >> nbits) + 4);
54
0
  } else if (copylen < 2118) {
55
0
    return (uint16_t)(Log2FloorNonZero(copylen - 70) + 12);
56
0
  } else {
57
0
    return 23u;
58
0
  }
59
0
}
Unexecuted instantiation: backward_references.c:GetCopyLengthCode
Unexecuted instantiation: backward_references_hq.c:GetCopyLengthCode
Unexecuted instantiation: bit_cost.c:GetCopyLengthCode
Unexecuted instantiation: block_splitter.c:GetCopyLengthCode
Unexecuted instantiation: brotli_bit_stream.c:GetCopyLengthCode
Unexecuted instantiation: cluster.c:GetCopyLengthCode
Unexecuted instantiation: compress_fragment.c:GetCopyLengthCode
Unexecuted instantiation: compress_fragment_two_pass.c:GetCopyLengthCode
Unexecuted instantiation: encode.c:GetCopyLengthCode
Unexecuted instantiation: histogram.c:GetCopyLengthCode
Unexecuted instantiation: metablock.c:GetCopyLengthCode
60
61
static BROTLI_INLINE uint16_t CombineLengthCodes(
62
0
    uint16_t inscode, uint16_t copycode, BROTLI_BOOL use_last_distance) {
63
0
  uint16_t bits64 =
64
0
      (uint16_t)((copycode & 0x7u) | ((inscode & 0x7u) << 3));
65
0
  if (use_last_distance && inscode < 8 && copycode < 16) {
66
0
    return (copycode < 8) ? bits64 : (bits64 | 64);
67
0
  } else {
68
    /* Specification: 5 Encoding of ... (last table) */
69
    /* offset = 2 * index, where index is in range [0..8] */
70
0
    int offset = 2 * ((copycode >> 3) + 3 * (inscode >> 3));
71
    /* All values in specification are K * 64,
72
       where   K = [2, 3, 6, 4, 5, 8, 7, 9, 10],
73
           i + 1 = [1, 2, 3, 4, 5, 6, 7, 8,  9],
74
       K - i - 1 = [1, 1, 3, 0, 0, 2, 0, 1,  2] = D.
75
       All values in D require only 2 bits to encode.
76
       Magic constant is shifted 6 bits left, to avoid final multiplication. */
77
0
    offset = (offset << 5) + 0x40 + ((0x520D40 >> offset) & 0xC0);
78
0
    return (uint16_t)offset | bits64;
79
0
  }
80
0
}
Unexecuted instantiation: backward_references.c:CombineLengthCodes
Unexecuted instantiation: backward_references_hq.c:CombineLengthCodes
Unexecuted instantiation: bit_cost.c:CombineLengthCodes
Unexecuted instantiation: block_splitter.c:CombineLengthCodes
Unexecuted instantiation: brotli_bit_stream.c:CombineLengthCodes
Unexecuted instantiation: cluster.c:CombineLengthCodes
Unexecuted instantiation: compress_fragment.c:CombineLengthCodes
Unexecuted instantiation: compress_fragment_two_pass.c:CombineLengthCodes
Unexecuted instantiation: encode.c:CombineLengthCodes
Unexecuted instantiation: histogram.c:CombineLengthCodes
Unexecuted instantiation: metablock.c:CombineLengthCodes
81
82
static BROTLI_INLINE void GetLengthCode(size_t insertlen, size_t copylen,
83
                                        BROTLI_BOOL use_last_distance,
84
0
                                        uint16_t* code) {
85
0
  uint16_t inscode = GetInsertLengthCode(insertlen);
86
0
  uint16_t copycode = GetCopyLengthCode(copylen);
87
0
  *code = CombineLengthCodes(inscode, copycode, use_last_distance);
88
0
}
Unexecuted instantiation: backward_references.c:GetLengthCode
Unexecuted instantiation: backward_references_hq.c:GetLengthCode
Unexecuted instantiation: bit_cost.c:GetLengthCode
Unexecuted instantiation: block_splitter.c:GetLengthCode
Unexecuted instantiation: brotli_bit_stream.c:GetLengthCode
Unexecuted instantiation: cluster.c:GetLengthCode
Unexecuted instantiation: compress_fragment.c:GetLengthCode
Unexecuted instantiation: compress_fragment_two_pass.c:GetLengthCode
Unexecuted instantiation: encode.c:GetLengthCode
Unexecuted instantiation: histogram.c:GetLengthCode
Unexecuted instantiation: metablock.c:GetLengthCode
89
90
0
static BROTLI_INLINE uint32_t GetInsertBase(uint16_t inscode) {
91
0
  return kInsBase[inscode];
92
0
}
Unexecuted instantiation: backward_references.c:GetInsertBase
Unexecuted instantiation: backward_references_hq.c:GetInsertBase
Unexecuted instantiation: bit_cost.c:GetInsertBase
Unexecuted instantiation: block_splitter.c:GetInsertBase
Unexecuted instantiation: brotli_bit_stream.c:GetInsertBase
Unexecuted instantiation: cluster.c:GetInsertBase
Unexecuted instantiation: compress_fragment.c:GetInsertBase
Unexecuted instantiation: compress_fragment_two_pass.c:GetInsertBase
Unexecuted instantiation: encode.c:GetInsertBase
Unexecuted instantiation: histogram.c:GetInsertBase
Unexecuted instantiation: metablock.c:GetInsertBase
93
94
0
static BROTLI_INLINE uint32_t GetInsertExtra(uint16_t inscode) {
95
0
  return kInsExtra[inscode];
96
0
}
Unexecuted instantiation: backward_references.c:GetInsertExtra
Unexecuted instantiation: backward_references_hq.c:GetInsertExtra
Unexecuted instantiation: bit_cost.c:GetInsertExtra
Unexecuted instantiation: block_splitter.c:GetInsertExtra
Unexecuted instantiation: brotli_bit_stream.c:GetInsertExtra
Unexecuted instantiation: cluster.c:GetInsertExtra
Unexecuted instantiation: compress_fragment.c:GetInsertExtra
Unexecuted instantiation: compress_fragment_two_pass.c:GetInsertExtra
Unexecuted instantiation: encode.c:GetInsertExtra
Unexecuted instantiation: histogram.c:GetInsertExtra
Unexecuted instantiation: metablock.c:GetInsertExtra
97
98
0
static BROTLI_INLINE uint32_t GetCopyBase(uint16_t copycode) {
99
0
  return kCopyBase[copycode];
100
0
}
Unexecuted instantiation: backward_references.c:GetCopyBase
Unexecuted instantiation: backward_references_hq.c:GetCopyBase
Unexecuted instantiation: bit_cost.c:GetCopyBase
Unexecuted instantiation: block_splitter.c:GetCopyBase
Unexecuted instantiation: brotli_bit_stream.c:GetCopyBase
Unexecuted instantiation: cluster.c:GetCopyBase
Unexecuted instantiation: compress_fragment.c:GetCopyBase
Unexecuted instantiation: compress_fragment_two_pass.c:GetCopyBase
Unexecuted instantiation: encode.c:GetCopyBase
Unexecuted instantiation: histogram.c:GetCopyBase
Unexecuted instantiation: metablock.c:GetCopyBase
101
102
0
static BROTLI_INLINE uint32_t GetCopyExtra(uint16_t copycode) {
103
0
  return kCopyExtra[copycode];
104
0
}
Unexecuted instantiation: backward_references.c:GetCopyExtra
Unexecuted instantiation: backward_references_hq.c:GetCopyExtra
Unexecuted instantiation: bit_cost.c:GetCopyExtra
Unexecuted instantiation: block_splitter.c:GetCopyExtra
Unexecuted instantiation: brotli_bit_stream.c:GetCopyExtra
Unexecuted instantiation: cluster.c:GetCopyExtra
Unexecuted instantiation: compress_fragment.c:GetCopyExtra
Unexecuted instantiation: compress_fragment_two_pass.c:GetCopyExtra
Unexecuted instantiation: encode.c:GetCopyExtra
Unexecuted instantiation: histogram.c:GetCopyExtra
Unexecuted instantiation: metablock.c:GetCopyExtra
105
106
typedef struct Command {
107
  uint32_t insert_len_;
108
  /* Stores copy_len in low 24 bits and copy_len XOR copy_code in high 8 bit. */
109
  uint32_t copy_len_;
110
  uint32_t dist_extra_;
111
  uint16_t cmd_prefix_;
112
  uint16_t dist_prefix_;
113
} Command;
114
115
/* distance_code is e.g. 0 for same-as-last short code, or 16 for offset 1. */
116
static BROTLI_INLINE void InitCommand(Command* self, size_t insertlen,
117
0
    size_t copylen, int copylen_code_delta, size_t distance_code) {
118
  /* Don't rely on signed int representation, use honest casts. */
119
0
  uint32_t delta = (uint8_t)((int8_t)copylen_code_delta);
120
0
  self->insert_len_ = (uint32_t)insertlen;
121
0
  self->copy_len_ = (uint32_t)(copylen | (delta << 24));
122
  /* The distance prefix and extra bits are stored in this Command as if
123
     npostfix and ndirect were 0, they are only recomputed later after the
124
     clustering if needed. */
125
0
  PrefixEncodeCopyDistance(
126
0
      distance_code, 0, 0, &self->dist_prefix_, &self->dist_extra_);
127
0
  GetLengthCode(
128
0
      insertlen, (size_t)((int)copylen + copylen_code_delta),
129
0
      TO_BROTLI_BOOL(self->dist_prefix_ == 0), &self->cmd_prefix_);
130
0
}
Unexecuted instantiation: backward_references.c:InitCommand
Unexecuted instantiation: backward_references_hq.c:InitCommand
Unexecuted instantiation: bit_cost.c:InitCommand
Unexecuted instantiation: block_splitter.c:InitCommand
Unexecuted instantiation: brotli_bit_stream.c:InitCommand
Unexecuted instantiation: cluster.c:InitCommand
Unexecuted instantiation: compress_fragment.c:InitCommand
Unexecuted instantiation: compress_fragment_two_pass.c:InitCommand
Unexecuted instantiation: encode.c:InitCommand
Unexecuted instantiation: histogram.c:InitCommand
Unexecuted instantiation: metablock.c:InitCommand
131
132
0
static BROTLI_INLINE void InitInsertCommand(Command* self, size_t insertlen) {
133
0
  self->insert_len_ = (uint32_t)insertlen;
134
0
  self->copy_len_ = 4 << 24;
135
0
  self->dist_extra_ = 0;
136
0
  self->dist_prefix_ = BROTLI_NUM_DISTANCE_SHORT_CODES;
137
0
  GetLengthCode(insertlen, 4, BROTLI_FALSE, &self->cmd_prefix_);
138
0
}
Unexecuted instantiation: backward_references.c:InitInsertCommand
Unexecuted instantiation: backward_references_hq.c:InitInsertCommand
Unexecuted instantiation: bit_cost.c:InitInsertCommand
Unexecuted instantiation: block_splitter.c:InitInsertCommand
Unexecuted instantiation: brotli_bit_stream.c:InitInsertCommand
Unexecuted instantiation: cluster.c:InitInsertCommand
Unexecuted instantiation: compress_fragment.c:InitInsertCommand
Unexecuted instantiation: compress_fragment_two_pass.c:InitInsertCommand
Unexecuted instantiation: encode.c:InitInsertCommand
Unexecuted instantiation: histogram.c:InitInsertCommand
Unexecuted instantiation: metablock.c:InitInsertCommand
139
140
0
static BROTLI_INLINE uint32_t CommandRestoreDistanceCode(const Command* self) {
141
0
  if (self->dist_prefix_ < BROTLI_NUM_DISTANCE_SHORT_CODES) {
142
0
    return self->dist_prefix_;
143
0
  } else {
144
0
    uint32_t nbits = self->dist_extra_ >> 24;
145
0
    uint32_t extra = self->dist_extra_ & 0xffffff;
146
    /* It is assumed that the distance was first encoded with NPOSTFIX = 0 and
147
       NDIRECT = 0, so the code itself is of this form:
148
         BROTLI_NUM_DISTANCE_SHORT_CODES + 2 * (nbits - 1) + prefix_bit
149
       Therefore, the following expression results in (2 + prefix_bit). */
150
0
    uint32_t prefix =
151
0
        self->dist_prefix_ + 4u - BROTLI_NUM_DISTANCE_SHORT_CODES - 2u * nbits;
152
    /* Subtract 4 for offset (Chapter 4.) and
153
       increase by BROTLI_NUM_DISTANCE_SHORT_CODES - 1  */
154
0
    return (prefix << nbits) + extra + BROTLI_NUM_DISTANCE_SHORT_CODES - 4u;
155
0
  }
156
0
}
Unexecuted instantiation: backward_references.c:CommandRestoreDistanceCode
Unexecuted instantiation: backward_references_hq.c:CommandRestoreDistanceCode
Unexecuted instantiation: bit_cost.c:CommandRestoreDistanceCode
Unexecuted instantiation: block_splitter.c:CommandRestoreDistanceCode
Unexecuted instantiation: brotli_bit_stream.c:CommandRestoreDistanceCode
Unexecuted instantiation: cluster.c:CommandRestoreDistanceCode
Unexecuted instantiation: compress_fragment.c:CommandRestoreDistanceCode
Unexecuted instantiation: compress_fragment_two_pass.c:CommandRestoreDistanceCode
Unexecuted instantiation: encode.c:CommandRestoreDistanceCode
Unexecuted instantiation: histogram.c:CommandRestoreDistanceCode
Unexecuted instantiation: metablock.c:CommandRestoreDistanceCode
157
158
0
static BROTLI_INLINE uint32_t CommandDistanceContext(const Command* self) {
159
0
  uint32_t r = self->cmd_prefix_ >> 6;
160
0
  uint32_t c = self->cmd_prefix_ & 7;
161
0
  if ((r == 0 || r == 2 || r == 4 || r == 7) && (c <= 2)) {
162
0
    return c;
163
0
  }
164
0
  return 3;
165
0
}
Unexecuted instantiation: backward_references.c:CommandDistanceContext
Unexecuted instantiation: backward_references_hq.c:CommandDistanceContext
Unexecuted instantiation: bit_cost.c:CommandDistanceContext
Unexecuted instantiation: block_splitter.c:CommandDistanceContext
Unexecuted instantiation: brotli_bit_stream.c:CommandDistanceContext
Unexecuted instantiation: cluster.c:CommandDistanceContext
Unexecuted instantiation: compress_fragment.c:CommandDistanceContext
Unexecuted instantiation: compress_fragment_two_pass.c:CommandDistanceContext
Unexecuted instantiation: encode.c:CommandDistanceContext
Unexecuted instantiation: histogram.c:CommandDistanceContext
Unexecuted instantiation: metablock.c:CommandDistanceContext
166
167
0
static BROTLI_INLINE uint32_t CommandCopyLen(const Command* self) {
168
0
  return self->copy_len_ & 0xFFFFFF;
169
0
}
Unexecuted instantiation: backward_references.c:CommandCopyLen
Unexecuted instantiation: backward_references_hq.c:CommandCopyLen
Unexecuted instantiation: bit_cost.c:CommandCopyLen
Unexecuted instantiation: block_splitter.c:CommandCopyLen
Unexecuted instantiation: brotli_bit_stream.c:CommandCopyLen
Unexecuted instantiation: cluster.c:CommandCopyLen
Unexecuted instantiation: compress_fragment.c:CommandCopyLen
Unexecuted instantiation: compress_fragment_two_pass.c:CommandCopyLen
Unexecuted instantiation: encode.c:CommandCopyLen
Unexecuted instantiation: histogram.c:CommandCopyLen
Unexecuted instantiation: metablock.c:CommandCopyLen
170
171
0
static BROTLI_INLINE uint32_t CommandCopyLenCode(const Command* self) {
172
0
  int32_t delta = (int8_t)((uint8_t)(self->copy_len_ >> 24));
173
0
  return (uint32_t)((int32_t)(self->copy_len_ & 0xFFFFFF) + delta);
174
0
}
Unexecuted instantiation: backward_references.c:CommandCopyLenCode
Unexecuted instantiation: backward_references_hq.c:CommandCopyLenCode
Unexecuted instantiation: bit_cost.c:CommandCopyLenCode
Unexecuted instantiation: block_splitter.c:CommandCopyLenCode
Unexecuted instantiation: brotli_bit_stream.c:CommandCopyLenCode
Unexecuted instantiation: cluster.c:CommandCopyLenCode
Unexecuted instantiation: compress_fragment.c:CommandCopyLenCode
Unexecuted instantiation: compress_fragment_two_pass.c:CommandCopyLenCode
Unexecuted instantiation: encode.c:CommandCopyLenCode
Unexecuted instantiation: histogram.c:CommandCopyLenCode
Unexecuted instantiation: metablock.c:CommandCopyLenCode
175
176
#if defined(__cplusplus) || defined(c_plusplus)
177
}  /* extern "C" */
178
#endif
179
180
#endif  /* BROTLI_ENC_COMMAND_H_ */