GCC Middle and Back End API Reference
data-streamer.h
Go to the documentation of this file.
1/* Generic streaming support for various data types.
2
3 Copyright (C) 2011-2024 Free Software Foundation, Inc.
4 Contributed by Diego Novillo <dnovillo@google.com>
5
6This file is part of GCC.
7
8GCC is free software; you can redistribute it and/or modify it under
9the terms of the GNU General Public License as published by the Free
10Software Foundation; either version 3, or (at your option) any later
11version.
12
13GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14WARRANTY; without even the implied warranty of MERCHANTABILITY or
15FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16for more details.
17
18You should have received a copy of the GNU General Public License
19along with GCC; see the file COPYING3. If not see
20<http://www.gnu.org/licenses/>. */
21
22#ifndef GCC_DATA_STREAMER_H
23#define GCC_DATA_STREAMER_H
24
25#include "lto-streamer.h"
26
27/* Data structures used to pack values and bitflags into a vector of
28 words. Used to stream values of a fixed number of bits in a space
29 efficient way. */
31
33
35{
36 /* The position of the first unused or unconsumed bit in the word. */
37 unsigned pos;
38
39 /* The current word we are (un)packing. */
41
42 /* The lto_output_stream or the lto_input_block we are streaming to/from. */
43 void *stream;
44};
45
46/* In data-streamer.cc */
47void bp_pack_var_len_unsigned (struct bitpack_d *, unsigned HOST_WIDE_INT);
49void bp_pack_real_value (struct bitpack_d *, const REAL_VALUE_TYPE *);
53
54/* In data-streamer-out.cc */
55void streamer_write_zero (struct output_block *);
56void streamer_write_uhwi (struct output_block *, unsigned HOST_WIDE_INT);
62 const char *, bool);
64 struct lto_output_stream *,
65 const char *, unsigned int, bool);
67 const char *, unsigned int, bool);
68void bp_pack_string (struct output_block *, struct bitpack_d *,
69 const char *, bool);
71 unsigned HOST_WIDE_INT);
74void streamer_write_data_stream (struct lto_output_stream *, const void *,
75 size_t);
76void streamer_write_wide_int (struct output_block *, const wide_int &);
78void streamer_write_vrange (struct output_block *, const class vrange &);
79
80/* In data-streamer-in.cc */
81const char *streamer_read_string (class data_in *, class lto_input_block *);
82const char *streamer_read_indexed_string (class data_in *,
83 class lto_input_block *,
84 unsigned int *);
85const char *bp_unpack_indexed_string (class data_in *, struct bitpack_d *,
86 unsigned int *);
87const char *bp_unpack_string (class data_in *, struct bitpack_d *);
96 class Value_Range &);
97
98/* Returns a new bit-packing context for bit-packing into S. */
99inline struct bitpack_d
101{
102 struct bitpack_d bp;
103 bp.pos = 0;
104 bp.word = 0;
105 bp.stream = (void *)s;
106 return bp;
107}
108
109/* Pack the NBITS bit sized value VAL into the bit-packing context BP. */
110inline void
112{
113 bitpack_word_t word = bp->word;
114 int pos = bp->pos;
115
116 /* Verify that VAL fits in the NBITS. */
118 || !(val & ~(((bitpack_word_t)1<<nbits)-1)));
119
120 /* If val does not fit into the current bitpack word switch to the
121 next one. */
123 {
125 word);
126 word = val;
127 pos = nbits;
128 }
129 else
130 {
131 word |= val << pos;
132 pos += nbits;
133 }
134 bp->word = word;
135 bp->pos = pos;
136}
137
138/* Pack VAL into the bit-packing context BP, using NBITS for each
139 coefficient. */
140inline void
143 unsigned nbits)
144{
145 for (int i = 0; i < NUM_POLY_INT_COEFFS; ++i)
146 bp_pack_value (bp, val.coeffs[i], nbits);
147}
148
149/* Finishes bit-packing of BP. */
150inline void
152{
154 bp->word);
155 bp->word = 0;
156 bp->pos = 0;
157}
158
159/* Returns a new bit-packing context for bit-unpacking from IB. */
160inline struct bitpack_d
162{
163 struct bitpack_d bp;
164 bp.word = streamer_read_uhwi (ib);
165 bp.pos = 0;
166 bp.stream = (void *)ib;
167 return bp;
168}
169
170/* Unpacks NBITS bits from the bit-packing context BP and returns them. */
171inline bitpack_word_t
173{
174 bitpack_word_t mask, val;
175 int pos = bp->pos;
176
178 ? (bitpack_word_t) -1
179 : ((bitpack_word_t) 1 << nbits) - 1);
180
181 /* If there are not continuous nbits in the current bitpack word
182 switch to the next one. */
184 {
185 bp->word = val
186 = streamer_read_uhwi ((class lto_input_block *)bp->stream);
187 bp->pos = nbits;
188 return val & mask;
189 }
190 val = bp->word;
191 val >>= pos;
192 bp->pos = pos + nbits;
193
194 return val & mask;
195}
196
197/* Unpacks a polynomial value from the bit-packing context BP in which each
198 coefficient has NBITS bits. */
201{
203 for (int i = 0; i < NUM_POLY_INT_COEFFS; ++i)
205 return x;
206}
207
208
209/* Write a character to the output block. */
210
211inline void
213{
214 /* No space left. */
215 if (obs->left_in_block == 0)
217
218 /* Write the actual character. */
219 char *current_pointer = obs->current_pointer;
220 *(current_pointer++) = c;
221 obs->current_pointer = current_pointer;
222 obs->total_size++;
223 obs->left_in_block--;
224}
225
226
227/* Read byte from the input block. */
228
229inline unsigned char
231{
232 if (ib->p >= ib->len)
234 return (ib->data[ib->p++]);
235}
236
237/* Output VAL into OBS and verify it is in range MIN...MAX that is supposed
238 to be compile time constant.
239 Be host independent, limit range to 31bits. */
240
241inline void
243 HOST_WIDE_INT min,
244 HOST_WIDE_INT max,
245 HOST_WIDE_INT val)
246{
247 HOST_WIDE_INT range = max - min;
248
250 && range < 0x7fffffff);
251
252 val -= min;
254}
255
256/* Input VAL into OBS and verify it is in range MIN...MAX that is supposed
257 to be compile time constant. PURPOSE is used for error reporting. */
258
259inline HOST_WIDE_INT
261 const char *purpose,
262 HOST_WIDE_INT min,
263 HOST_WIDE_INT max)
264{
265 HOST_WIDE_INT range = max - min;
266 unsigned HOST_WIDE_INT uval = streamer_read_uhwi (ib);
267
268 gcc_checking_assert (range > 0 && range < 0x7fffffff);
269
270 HOST_WIDE_INT val = (HOST_WIDE_INT) (uval + (unsigned HOST_WIDE_INT) min);
271 if (val < min || val > max)
272 lto_value_range_error (purpose, val, min, max);
273 return val;
274}
275
276/* Output VAL into BP and verify it is in range MIN...MAX that is supposed
277 to be compile time constant.
278 Be host independent, limit range to 31bits. */
279
280inline void
282 HOST_WIDE_INT min,
283 HOST_WIDE_INT max,
284 HOST_WIDE_INT val)
285{
286 HOST_WIDE_INT range = max - min;
287 int nbits = floor_log2 (range) + 1;
288
290 && range < 0x7fffffff);
291
292 val -= min;
293 bp_pack_value (bp, val, nbits);
294}
295
296/* Input VAL into BP and verify it is in range MIN...MAX that is supposed
297 to be compile time constant. PURPOSE is used for error reporting. */
298
299inline HOST_WIDE_INT
301 const char *purpose,
302 HOST_WIDE_INT min,
303 HOST_WIDE_INT max)
304{
305 HOST_WIDE_INT range = max - min;
306 int nbits = floor_log2 (range) + 1;
308
309 gcc_checking_assert (range > 0 && range < 0x7fffffff);
310
311 if (val < min || val > max)
312 lto_value_range_error (purpose, val, min, max);
313 return val;
314}
315
316/* Output VAL of type "enum enum_name" into OBS.
317 Assume range 0...ENUM_LAST - 1. */
318#define streamer_write_enum(obs,enum_name,enum_last,val) \
319 streamer_write_hwi_in_range ((obs), 0, (int)(enum_last) - 1, (int)(val))
320
321/* Input enum of type "enum enum_name" from IB.
322 Assume range 0...ENUM_LAST - 1. */
323#define streamer_read_enum(ib,enum_name,enum_last) \
324 (enum enum_name)streamer_read_hwi_in_range ((ib), #enum_name, 0, \
325 (int)(enum_last) - 1)
326
327/* Output VAL of type "enum enum_name" into BP.
328 Assume range 0...ENUM_LAST - 1. */
329#define bp_pack_enum(bp,enum_name,enum_last,val) \
330 bp_pack_int_in_range ((bp), 0, (int)(enum_last) - 1, (int)(val))
331
332/* Input enum of type "enum enum_name" from BP.
333 Assume range 0...ENUM_LAST - 1. */
334#define bp_unpack_enum(bp,enum_name,enum_last) \
335 (enum enum_name)bp_unpack_int_in_range ((bp), #enum_name, 0, \
336 (int)(enum_last) - 1)
337
338/* Output the start of a record with TAG to output block OB. */
339
340inline void
345
346/* Return the next tag in the input block IB. */
347
348inline enum LTO_tags
353
354#endif /* GCC_DATA_STREAMER_H */
Definition value-range.h:682
Definition lto-streamer.h:746
Definition lto-streamer.h:342
C coeffs[N]
Definition poly-int.h:429
Definition value-range.h:76
int64_t gcov_type
Definition coretypes.h:46
void lto_append_block(struct lto_output_stream *obs)
Definition data-streamer-out.cc:38
void bp_pack_real_value(struct bitpack_d *, const REAL_VALUE_TYPE *)
Definition data-streamer.cc:120
void streamer_write_poly_int64(struct output_block *, poly_int64)
Definition data-streamer-out.cc:237
const char * streamer_read_string(class data_in *, class lto_input_block *)
Definition data-streamer-in.cc:77
void streamer_write_bitpack(struct bitpack_d *bp)
Definition data-streamer.h:151
struct bitpack_d bitpack_create(struct lto_output_stream *s)
Definition data-streamer.h:100
wide_int streamer_read_wide_int(class lto_input_block *)
Definition data-streamer-in.cc:278
void streamer_write_widest_int(struct output_block *, const widest_int &)
Definition data-streamer-out.cc:472
void bp_pack_var_len_int(struct bitpack_d *, HOST_WIDE_INT)
Definition data-streamer.cc:53
void streamer_write_char_stream(struct lto_output_stream *obs, char c)
Definition data-streamer.h:212
static unsigned const BITS_PER_BITPACK_WORD
Definition data-streamer.h:30
struct bitpack_d streamer_read_bitpack(class lto_input_block *ib)
Definition data-streamer.h:161
poly_int64 streamer_read_poly_int64(class lto_input_block *)
Definition data-streamer-in.cc:194
const char * streamer_read_indexed_string(class data_in *, class lto_input_block *, unsigned int *)
Definition data-streamer-in.cc:67
void streamer_read_value_range(class lto_input_block *, class data_in *, class Value_Range &)
Definition data-streamer-in.cc:221
void streamer_write_vrange(struct output_block *, const class vrange &)
void streamer_write_string_with_length(struct output_block *, struct lto_output_stream *, const char *, unsigned int, bool)
Definition data-streamer-out.cc:134
void streamer_write_poly_uint64(struct output_block *, poly_uint64)
Definition data-streamer-out.cc:228
enum LTO_tags streamer_read_record_start(class lto_input_block *ib)
Definition data-streamer.h:349
void bp_pack_int_in_range(struct bitpack_d *bp, HOST_WIDE_INT min, HOST_WIDE_INT max, HOST_WIDE_INT val)
Definition data-streamer.h:281
poly_int< NUM_POLY_INT_COEFFS, bitpack_word_t > bp_unpack_poly_value(struct bitpack_d *bp, unsigned nbits)
Definition data-streamer.h:200
void streamer_write_hwi_in_range(struct lto_output_stream *obs, HOST_WIDE_INT min, HOST_WIDE_INT max, HOST_WIDE_INT val)
Definition data-streamer.h:242
const char * bp_unpack_string(class data_in *, struct bitpack_d *)
Definition data-streamer-in.cc:106
void streamer_write_uhwi(struct output_block *, unsigned HOST_WIDE_INT)
Definition data-streamer-out.cc:211
void bp_unpack_real_value(struct bitpack_d *, REAL_VALUE_TYPE *)
Definition data-streamer.cc:135
void bp_pack_string(struct output_block *, struct bitpack_d *, const char *, bool)
Definition data-streamer-out.cc:188
void streamer_write_string(struct output_block *, struct lto_output_stream *, const char *, bool)
Definition data-streamer-out.cc:153
HOST_WIDE_INT streamer_read_hwi(class lto_input_block *)
Definition data-streamer-in.cc:159
void bp_pack_value(struct bitpack_d *bp, bitpack_word_t val, unsigned nbits)
Definition data-streamer.h:111
void bp_pack_string_with_length(struct output_block *, struct bitpack_d *, const char *, unsigned int, bool)
Definition data-streamer-out.cc:172
void bp_pack_var_len_unsigned(struct bitpack_d *, unsigned HOST_WIDE_INT)
Definition data-streamer.cc:34
void streamer_write_gcov_count(struct output_block *, gcov_type)
Definition data-streamer-out.cc:246
unsigned HOST_WIDE_INT streamer_read_uhwi(class lto_input_block *)
Definition data-streamer-in.cc:124
void streamer_write_hwi_stream(struct lto_output_stream *, HOST_WIDE_INT)
Definition data-streamer-out.cc:304
void streamer_write_uhwi_stream(struct lto_output_stream *, unsigned HOST_WIDE_INT)
Definition data-streamer-out.cc:254
void streamer_write_record_start(struct output_block *ob, enum LTO_tags tag)
Definition data-streamer.h:341
void streamer_write_gcov_count_stream(struct lto_output_stream *, gcov_type)
Definition data-streamer-out.cc:361
poly_uint64 streamer_read_poly_uint64(class lto_input_block *)
Definition data-streamer-in.cc:183
const char * bp_unpack_indexed_string(class data_in *, struct bitpack_d *, unsigned int *)
Definition data-streamer-in.cc:96
void streamer_write_wide_int(struct output_block *, const wide_int &)
Definition data-streamer-out.cc:459
gcov_type streamer_read_gcov_count(class lto_input_block *)
Definition data-streamer-in.cc:205
bitpack_word_t bp_unpack_value(struct bitpack_d *bp, unsigned nbits)
Definition data-streamer.h:172
#define streamer_read_enum(ib, enum_name, enum_last)
Definition data-streamer.h:323
void streamer_write_zero(struct output_block *)
Definition data-streamer-out.cc:202
HOST_WIDE_INT bp_unpack_int_in_range(struct bitpack_d *bp, const char *purpose, HOST_WIDE_INT min, HOST_WIDE_INT max)
Definition data-streamer.h:300
void streamer_write_hwi(struct output_block *, HOST_WIDE_INT)
Definition data-streamer-out.cc:220
void bp_pack_poly_value(struct bitpack_d *bp, const poly_int< NUM_POLY_INT_COEFFS, bitpack_word_t > &val, unsigned nbits)
Definition data-streamer.h:141
void streamer_write_data_stream(struct lto_output_stream *, const void *, size_t)
Definition data-streamer-out.cc:370
unsigned HOST_WIDE_INT bp_unpack_var_len_unsigned(struct bitpack_d *)
Definition data-streamer.cc:76
unsigned char streamer_read_uchar(class lto_input_block *ib)
Definition data-streamer.h:230
widest_int streamer_read_widest_int(class lto_input_block *)
Definition data-streamer-in.cc:295
HOST_WIDE_INT streamer_read_hwi_in_range(class lto_input_block *ib, const char *purpose, HOST_WIDE_INT min, HOST_WIDE_INT max)
Definition data-streamer.h:260
HOST_WIDE_INT bp_unpack_var_len_int(struct bitpack_d *)
Definition data-streamer.cc:96
#define streamer_write_enum(obs, enum_name, enum_last, val)
Definition data-streamer.h:318
unsigned HOST_WIDE_INT bitpack_word_t
Definition data-streamer.h:32
#define NUM_POLY_INT_COEFFS
Definition genmodes.cc:859
T * ggc_alloc(ALONE_CXX_MEM_STAT_INFO)
Definition ggc.h:184
int floor_log2(unsigned HOST_WIDE_INT x)
Definition hwint.cc:36
#define HOST_BITS_PER_WIDE_INT
Definition hwint.h:53
void lto_value_range_error(const char *purpose, HOST_WIDE_INT val, HOST_WIDE_INT min, HOST_WIDE_INT max)
Definition lto-section-in.cc:467
void lto_section_overrun(class lto_input_block *ib)
Definition lto-section-in.cc:458
LTO_tags
Definition lto-streamer.h:138
@ LTO_NUM_TAGS
Definition lto-streamer.h:197
i
Definition poly-int.h:772
#define REAL_VALUE_TYPE
Definition real.h:68
Definition data-streamer.h:35
void * stream
Definition data-streamer.h:43
bitpack_word_t word
Definition data-streamer.h:40
unsigned pos
Definition data-streamer.h:37
Definition lto-streamer.h:623
Definition lto-streamer.h:699
struct lto_output_stream * main_stream
Definition lto-streamer.h:704
#define gcc_checking_assert(EXPR)
Definition system.h:828