xref: /aosp_15_r20/external/pigweed/pw_varint/varint.cc (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1*61c4878aSAndroid Build Coastguard Worker // Copyright 2020 The Pigweed Authors
2*61c4878aSAndroid Build Coastguard Worker //
3*61c4878aSAndroid Build Coastguard Worker // Licensed under the Apache License, Version 2.0 (the "License"); you may not
4*61c4878aSAndroid Build Coastguard Worker // use this file except in compliance with the License. You may obtain a copy of
5*61c4878aSAndroid Build Coastguard Worker // the License at
6*61c4878aSAndroid Build Coastguard Worker //
7*61c4878aSAndroid Build Coastguard Worker //     https://www.apache.org/licenses/LICENSE-2.0
8*61c4878aSAndroid Build Coastguard Worker //
9*61c4878aSAndroid Build Coastguard Worker // Unless required by applicable law or agreed to in writing, software
10*61c4878aSAndroid Build Coastguard Worker // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11*61c4878aSAndroid Build Coastguard Worker // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12*61c4878aSAndroid Build Coastguard Worker // License for the specific language governing permissions and limitations under
13*61c4878aSAndroid Build Coastguard Worker // the License.
14*61c4878aSAndroid Build Coastguard Worker 
15*61c4878aSAndroid Build Coastguard Worker #include "pw_varint/varint.h"
16*61c4878aSAndroid Build Coastguard Worker 
17*61c4878aSAndroid Build Coastguard Worker #include <algorithm>
18*61c4878aSAndroid Build Coastguard Worker #include <cstddef>
19*61c4878aSAndroid Build Coastguard Worker 
20*61c4878aSAndroid Build Coastguard Worker namespace pw {
21*61c4878aSAndroid Build Coastguard Worker namespace varint {
22*61c4878aSAndroid Build Coastguard Worker namespace {
23*61c4878aSAndroid Build Coastguard Worker 
ZeroTerminated(pw_varint_Format format)24*61c4878aSAndroid Build Coastguard Worker inline bool ZeroTerminated(pw_varint_Format format) {
25*61c4878aSAndroid Build Coastguard Worker   return (static_cast<unsigned>(format) & 0b10) == 0;
26*61c4878aSAndroid Build Coastguard Worker }
27*61c4878aSAndroid Build Coastguard Worker 
LeastSignificant(pw_varint_Format format)28*61c4878aSAndroid Build Coastguard Worker inline bool LeastSignificant(pw_varint_Format format) {
29*61c4878aSAndroid Build Coastguard Worker   return (static_cast<unsigned>(format) & 0b01) == 0;
30*61c4878aSAndroid Build Coastguard Worker }
31*61c4878aSAndroid Build Coastguard Worker 
32*61c4878aSAndroid Build Coastguard Worker }  // namespace
33*61c4878aSAndroid Build Coastguard Worker 
pw_varint_EncodeCustom(uint64_t integer,void * output,size_t output_size,pw_varint_Format format)34*61c4878aSAndroid Build Coastguard Worker extern "C" size_t pw_varint_EncodeCustom(uint64_t integer,
35*61c4878aSAndroid Build Coastguard Worker                                          void* output,
36*61c4878aSAndroid Build Coastguard Worker                                          size_t output_size,
37*61c4878aSAndroid Build Coastguard Worker                                          pw_varint_Format format) {
38*61c4878aSAndroid Build Coastguard Worker   size_t written = 0;
39*61c4878aSAndroid Build Coastguard Worker   std::byte* buffer = static_cast<std::byte*>(output);
40*61c4878aSAndroid Build Coastguard Worker 
41*61c4878aSAndroid Build Coastguard Worker   int value_shift = LeastSignificant(format) ? 1 : 0;
42*61c4878aSAndroid Build Coastguard Worker   int term_shift = value_shift == 1 ? 0 : 7;
43*61c4878aSAndroid Build Coastguard Worker 
44*61c4878aSAndroid Build Coastguard Worker   std::byte cont, term;
45*61c4878aSAndroid Build Coastguard Worker   if (ZeroTerminated(format)) {
46*61c4878aSAndroid Build Coastguard Worker     cont = std::byte(0x01) << term_shift;
47*61c4878aSAndroid Build Coastguard Worker     term = std::byte(0x00) << term_shift;
48*61c4878aSAndroid Build Coastguard Worker   } else {
49*61c4878aSAndroid Build Coastguard Worker     cont = std::byte(0x00) << term_shift;
50*61c4878aSAndroid Build Coastguard Worker     term = std::byte(0x01) << term_shift;
51*61c4878aSAndroid Build Coastguard Worker   }
52*61c4878aSAndroid Build Coastguard Worker 
53*61c4878aSAndroid Build Coastguard Worker   do {
54*61c4878aSAndroid Build Coastguard Worker     if (written >= output_size) {
55*61c4878aSAndroid Build Coastguard Worker       return 0;
56*61c4878aSAndroid Build Coastguard Worker     }
57*61c4878aSAndroid Build Coastguard Worker 
58*61c4878aSAndroid Build Coastguard Worker     bool last_byte = (integer >> 7) == 0u;
59*61c4878aSAndroid Build Coastguard Worker 
60*61c4878aSAndroid Build Coastguard Worker     // Grab 7 bits and set the eighth according to the continuation bit.
61*61c4878aSAndroid Build Coastguard Worker     std::byte value = (static_cast<std::byte>(integer) & std::byte(0x7f))
62*61c4878aSAndroid Build Coastguard Worker                       << value_shift;
63*61c4878aSAndroid Build Coastguard Worker 
64*61c4878aSAndroid Build Coastguard Worker     if (last_byte) {
65*61c4878aSAndroid Build Coastguard Worker       value |= term;
66*61c4878aSAndroid Build Coastguard Worker     } else {
67*61c4878aSAndroid Build Coastguard Worker       value |= cont;
68*61c4878aSAndroid Build Coastguard Worker     }
69*61c4878aSAndroid Build Coastguard Worker 
70*61c4878aSAndroid Build Coastguard Worker     buffer[written++] = value;
71*61c4878aSAndroid Build Coastguard Worker     integer >>= 7;
72*61c4878aSAndroid Build Coastguard Worker   } while (integer != 0u);
73*61c4878aSAndroid Build Coastguard Worker 
74*61c4878aSAndroid Build Coastguard Worker   return written;
75*61c4878aSAndroid Build Coastguard Worker }
76*61c4878aSAndroid Build Coastguard Worker 
pw_varint_DecodeCustom(const void * input,size_t input_size,uint64_t * output,pw_varint_Format format)77*61c4878aSAndroid Build Coastguard Worker extern "C" size_t pw_varint_DecodeCustom(const void* input,
78*61c4878aSAndroid Build Coastguard Worker                                          size_t input_size,
79*61c4878aSAndroid Build Coastguard Worker                                          uint64_t* output,
80*61c4878aSAndroid Build Coastguard Worker                                          pw_varint_Format format) {
81*61c4878aSAndroid Build Coastguard Worker   uint64_t decoded_value = 0;
82*61c4878aSAndroid Build Coastguard Worker   uint_fast8_t count = 0;
83*61c4878aSAndroid Build Coastguard Worker   const std::byte* buffer = static_cast<const std::byte*>(input);
84*61c4878aSAndroid Build Coastguard Worker 
85*61c4878aSAndroid Build Coastguard Worker   // The largest 64-bit ints require 10 B.
86*61c4878aSAndroid Build Coastguard Worker   const size_t max_count = std::min(kMaxVarint64SizeBytes, input_size);
87*61c4878aSAndroid Build Coastguard Worker 
88*61c4878aSAndroid Build Coastguard Worker   std::byte mask;
89*61c4878aSAndroid Build Coastguard Worker   uint32_t shift;
90*61c4878aSAndroid Build Coastguard Worker   if (LeastSignificant(format)) {
91*61c4878aSAndroid Build Coastguard Worker     mask = std::byte(0xfe);
92*61c4878aSAndroid Build Coastguard Worker     shift = 1;
93*61c4878aSAndroid Build Coastguard Worker   } else {
94*61c4878aSAndroid Build Coastguard Worker     mask = std::byte(0x7f);
95*61c4878aSAndroid Build Coastguard Worker     shift = 0;
96*61c4878aSAndroid Build Coastguard Worker   }
97*61c4878aSAndroid Build Coastguard Worker 
98*61c4878aSAndroid Build Coastguard Worker   // Determines whether a byte is the last byte of a varint.
99*61c4878aSAndroid Build Coastguard Worker   auto is_last_byte = [&](std::byte byte) {
100*61c4878aSAndroid Build Coastguard Worker     if (ZeroTerminated(format)) {
101*61c4878aSAndroid Build Coastguard Worker       return (byte & ~mask) == std::byte(0);
102*61c4878aSAndroid Build Coastguard Worker     }
103*61c4878aSAndroid Build Coastguard Worker     return (byte & ~mask) != std::byte(0);
104*61c4878aSAndroid Build Coastguard Worker   };
105*61c4878aSAndroid Build Coastguard Worker 
106*61c4878aSAndroid Build Coastguard Worker   while (true) {
107*61c4878aSAndroid Build Coastguard Worker     if (count >= max_count) {
108*61c4878aSAndroid Build Coastguard Worker       return 0;
109*61c4878aSAndroid Build Coastguard Worker     }
110*61c4878aSAndroid Build Coastguard Worker 
111*61c4878aSAndroid Build Coastguard Worker     // Add the bottom seven bits of the next byte to the result.
112*61c4878aSAndroid Build Coastguard Worker     decoded_value |= static_cast<uint64_t>((buffer[count] & mask) >> shift)
113*61c4878aSAndroid Build Coastguard Worker                      << (7 * count);
114*61c4878aSAndroid Build Coastguard Worker 
115*61c4878aSAndroid Build Coastguard Worker     // Stop decoding if the end is reached.
116*61c4878aSAndroid Build Coastguard Worker     if (is_last_byte(buffer[count++])) {
117*61c4878aSAndroid Build Coastguard Worker       break;
118*61c4878aSAndroid Build Coastguard Worker     }
119*61c4878aSAndroid Build Coastguard Worker   }
120*61c4878aSAndroid Build Coastguard Worker 
121*61c4878aSAndroid Build Coastguard Worker   *output = decoded_value;
122*61c4878aSAndroid Build Coastguard Worker   return count;
123*61c4878aSAndroid Build Coastguard Worker }
124*61c4878aSAndroid Build Coastguard Worker 
pw_varint_EncodedSizeBytes(uint64_t integer)125*61c4878aSAndroid Build Coastguard Worker extern "C" size_t pw_varint_EncodedSizeBytes(uint64_t integer) {
126*61c4878aSAndroid Build Coastguard Worker   return EncodedSize(integer);
127*61c4878aSAndroid Build Coastguard Worker }
128*61c4878aSAndroid Build Coastguard Worker 
129*61c4878aSAndroid Build Coastguard Worker }  // namespace varint
130*61c4878aSAndroid Build Coastguard Worker }  // namespace pw
131