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
32typedef unsigned HOST_WIDE_INT bitpack_word_t;
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);
48void bp_pack_var_len_int (struct bitpack_d *, HOST_WIDE_INT);
49void bp_pack_real_value (struct bitpack_d *, const REAL_VALUE_TYPE *);
51unsigned HOST_WIDE_INT bp_unpack_var_len_unsigned (struct bitpack_d *);
52HOST_WIDE_INT bp_unpack_var_len_int (struct bitpack_d *);
53extern unsigned host_num_poly_int_coeffs;
54
55/* In data-streamer-out.cc */
56void streamer_write_zero (struct output_block *);
57void streamer_write_uhwi (struct output_block *, unsigned HOST_WIDE_INT);
58void streamer_write_hwi (struct output_block *, HOST_WIDE_INT);
63 const char *, bool);
65 struct lto_output_stream *,
66 const char *, unsigned int, bool);
68 const char *, unsigned int, bool);
69void bp_pack_string (struct output_block *, struct bitpack_d *,
70 const char *, bool);
72 unsigned HOST_WIDE_INT);
73void streamer_write_hwi_stream (struct lto_output_stream *, HOST_WIDE_INT);
75void streamer_write_data_stream (struct lto_output_stream *, const void *,
76 size_t);
77void streamer_write_wide_int (struct output_block *, const wide_int &);
79void streamer_write_vrange (struct output_block *, const class vrange &);
80
81/* In data-streamer-in.cc */
82const char *streamer_read_string (class data_in *, class lto_input_block *);
83const char *streamer_read_indexed_string (class data_in *,
84 class lto_input_block *,
85 unsigned int *);
86const char *bp_unpack_indexed_string (class data_in *, struct bitpack_d *,
87 unsigned int *);
88const char *bp_unpack_string (class data_in *, struct bitpack_d *);
89unsigned HOST_WIDE_INT streamer_read_uhwi (class lto_input_block *);
90HOST_WIDE_INT streamer_read_hwi (class lto_input_block *);
97 class value_range &);
98
99/* Returns a new bit-packing context for bit-packing into S. */
100inline struct bitpack_d
102{
103 struct bitpack_d bp;
104 bp.pos = 0;
105 bp.word = 0;
106 bp.stream = (void *)s;
107 return bp;
108}
109
110/* Pack the NBITS bit sized value VAL into the bit-packing context BP. */
111inline void
112bp_pack_value (struct bitpack_d *bp, bitpack_word_t val, unsigned nbits)
113{
115 int pos = bp->pos;
116
117 /* Verify that VAL fits in the NBITS. */
119 || !(val & ~(((bitpack_word_t)1<<nbits)-1)));
120
121 /* If val does not fit into the current bitpack word switch to the
122 next one. */
123 if (pos + nbits > BITS_PER_BITPACK_WORD)
124 {
126 word);
127 word = val;
128 pos = nbits;
129 }
130 else
131 {
132 word |= val << pos;
133 pos += nbits;
134 }
135 bp->word = word;
136 bp->pos = pos;
137}
138
139/* Pack VAL into the bit-packing context BP, using NBITS for each
140 coefficient. */
141inline void
144 unsigned nbits)
145{
146 for (int i = 0; i < NUM_POLY_INT_COEFFS; ++i)
147 bp_pack_value (bp, val.coeffs[i], nbits);
148}
149
150/* Finishes bit-packing of BP. */
151inline void
153{
155 bp->word);
156 bp->word = 0;
157 bp->pos = 0;
158}
159
160/* Returns a new bit-packing context for bit-unpacking from IB. */
161inline struct bitpack_d
163{
164 struct bitpack_d bp;
165 bp.word = streamer_read_uhwi (ib);
166 bp.pos = 0;
167 bp.stream = (void *)ib;
168 return bp;
169}
170
171/* Unpacks NBITS bits from the bit-packing context BP and returns them. */
172inline bitpack_word_t
173bp_unpack_value (struct bitpack_d *bp, unsigned nbits)
174{
175 bitpack_word_t mask, val;
176 int pos = bp->pos;
177
178 mask = (nbits == BITS_PER_BITPACK_WORD
179 ? (bitpack_word_t) -1
180 : ((bitpack_word_t) 1 << nbits) - 1);
181
182 /* If there are not continuous nbits in the current bitpack word
183 switch to the next one. */
184 if (pos + nbits > BITS_PER_BITPACK_WORD)
185 {
186 bp->word = val
188 bp->pos = nbits;
189 return val & mask;
190 }
191 val = bp->word;
192 val >>= pos;
193 bp->pos = pos + nbits;
194
195 return val & mask;
196}
197
198/* Common code for reading poly_int. */
199
200template<typename C, typename F, typename ...Args>
202poly_int_read_common (F read_coeff, Args ...args)
203{
205 unsigned i;
206
207#ifdef ACCEL_COMPILER
208 /* Ensure that we have streamed-in host_num_poly_int_coeffs. */
209 const unsigned num_poly_int_coeffs = host_num_poly_int_coeffs;
211#else
212 const unsigned num_poly_int_coeffs = NUM_POLY_INT_COEFFS;
213#endif
214
215 if (num_poly_int_coeffs <= NUM_POLY_INT_COEFFS)
216 {
217 for (i = 0; i < num_poly_int_coeffs; i++)
218 x.coeffs[i] = read_coeff (args...);
219 for (; i < NUM_POLY_INT_COEFFS; i++)
220 x.coeffs[i] = 0;
221 }
222 else
223 {
224 for (i = 0; i < NUM_POLY_INT_COEFFS; i++)
225 x.coeffs[i] = read_coeff (args...);
226
227 /* Ensure that degree of poly_int <= accel NUM_POLY_INT_COEFFS. */
228 for (; i < num_poly_int_coeffs; i++)
229 {
230 C val = read_coeff (args...);
231 if (val != 0)
233 "degree of %<poly_int%> exceeds "
234 "%<NUM_POLY_INT_COEFFS%> (%d)",
236 }
237 }
238 return x;
239}
240
241/* Unpacks a polynomial value from the bit-packing context BP in which each
242 coefficient has NBITS bits. */
244bp_unpack_poly_value (struct bitpack_d *bp, unsigned nbits)
245{
247}
248
249
250/* Write a character to the output block. */
251
252inline void
254{
255 /* No space left. */
256 if (obs->left_in_block == 0)
257 lto_append_block (obs);
258
259 /* Write the actual character. */
260 char *current_pointer = obs->current_pointer;
261 *(current_pointer++) = c;
262 obs->current_pointer = current_pointer;
263 obs->total_size++;
264 obs->left_in_block--;
265}
266
267
268/* Read byte from the input block. */
269
270inline unsigned char
272{
273 if (ib->p >= ib->len)
275 return (ib->data[ib->p++]);
276}
277
278/* Output VAL into OBS and verify it is in range MIN...MAX that is supposed
279 to be compile time constant.
280 Be host independent, limit range to 31bits. */
281
282inline void
284 HOST_WIDE_INT min,
285 HOST_WIDE_INT max,
286 HOST_WIDE_INT val)
287{
288 HOST_WIDE_INT range = max - min;
289
290 gcc_checking_assert (val >= min && val <= max && range > 0
291 && range < 0x7fffffff);
292
293 val -= min;
294 streamer_write_uhwi_stream (obs, (unsigned HOST_WIDE_INT) val);
295}
296
297/* Input VAL into OBS and verify it is in range MIN...MAX that is supposed
298 to be compile time constant. PURPOSE is used for error reporting. */
299
300inline HOST_WIDE_INT
302 const char *purpose,
303 HOST_WIDE_INT min,
304 HOST_WIDE_INT max)
305{
306 HOST_WIDE_INT range = max - min;
307 unsigned HOST_WIDE_INT uval = streamer_read_uhwi (ib);
308
309 gcc_checking_assert (range > 0 && range < 0x7fffffff);
310
311 HOST_WIDE_INT val = (HOST_WIDE_INT) (uval + (unsigned HOST_WIDE_INT) min);
312 if (val < min || val > max)
313 lto_value_range_error (purpose, val, min, max);
314 return val;
315}
316
317/* Output VAL into BP and verify it is in range MIN...MAX that is supposed
318 to be compile time constant.
319 Be host independent, limit range to 31bits. */
320
321inline void
323 HOST_WIDE_INT min,
324 HOST_WIDE_INT max,
325 HOST_WIDE_INT val)
326{
327 HOST_WIDE_INT range = max - min;
328 int nbits = floor_log2 (range) + 1;
329
330 gcc_checking_assert (val >= min && val <= max && range > 0
331 && range < 0x7fffffff);
332
333 val -= min;
334 bp_pack_value (bp, val, nbits);
335}
336
337/* Input VAL into BP and verify it is in range MIN...MAX that is supposed
338 to be compile time constant. PURPOSE is used for error reporting. */
339
340inline HOST_WIDE_INT
342 const char *purpose,
343 HOST_WIDE_INT min,
344 HOST_WIDE_INT max)
345{
346 HOST_WIDE_INT range = max - min;
347 int nbits = floor_log2 (range) + 1;
348 HOST_WIDE_INT val = bp_unpack_value (bp, nbits);
349
350 gcc_checking_assert (range > 0 && range < 0x7fffffff);
351
352 if (val < min || val > max)
353 lto_value_range_error (purpose, val, min, max);
354 return val;
355}
356
357/* Output VAL of type "enum enum_name" into OBS.
358 Assume range 0...ENUM_LAST - 1. */
359#define streamer_write_enum(obs,enum_name,enum_last,val) \
360 streamer_write_hwi_in_range ((obs), 0, (int)(enum_last) - 1, (int)(val))
361
362/* Input enum of type "enum enum_name" from IB.
363 Assume range 0...ENUM_LAST - 1. */
364#define streamer_read_enum(ib,enum_name,enum_last) \
365 (enum enum_name)streamer_read_hwi_in_range ((ib), #enum_name, 0, \
366 (int)(enum_last) - 1)
367
368/* Output VAL of type "enum enum_name" into BP.
369 Assume range 0...ENUM_LAST - 1. */
370#define bp_pack_enum(bp,enum_name,enum_last,val) \
371 bp_pack_int_in_range ((bp), 0, (int)(enum_last) - 1, (int)(val))
372
373/* Input enum of type "enum enum_name" from BP.
374 Assume range 0...ENUM_LAST - 1. */
375#define bp_unpack_enum(bp,enum_name,enum_last) \
376 (enum enum_name)bp_unpack_int_in_range ((bp), #enum_name, 0, \
377 (int)(enum_last) - 1)
378
379/* Output the start of a record with TAG to output block OB. */
380
381inline void
386
387/* Return the next tag in the input block IB. */
388
389inline enum LTO_tags
394
395#endif /* GCC_DATA_STREAMER_H */
Definition lto-streamer.h:745
Definition lto-streamer.h:338
unsigned int len
Definition lto-streamer.h:352
unsigned int p
Definition lto-streamer.h:351
const char * data
Definition lto-streamer.h:349
C coeffs[N]
Definition poly-int.h:433
Definition value-range.h:759
Definition value-range.h:78
int64_t gcov_type
Definition coretypes.h:46
void lto_append_block(struct lto_output_stream *obs)
Definition data-streamer-out.cc:39
void bp_pack_real_value(struct bitpack_d *, const REAL_VALUE_TYPE *)
Definition data-streamer.cc:129
void streamer_write_poly_int64(struct output_block *, poly_int64)
Definition data-streamer-out.cc:238
const char * streamer_read_string(class data_in *, class lto_input_block *)
Definition data-streamer-in.cc:78
void streamer_write_bitpack(struct bitpack_d *bp)
Definition data-streamer.h:152
struct bitpack_d bitpack_create(struct lto_output_stream *s)
Definition data-streamer.h:101
wide_int streamer_read_wide_int(class lto_input_block *)
Definition data-streamer-in.cc:287
void streamer_write_widest_int(struct output_block *, const widest_int &)
Definition data-streamer-out.cc:483
void bp_pack_var_len_int(struct bitpack_d *, HOST_WIDE_INT)
Definition data-streamer.cc:62
void streamer_write_char_stream(struct lto_output_stream *obs, char c)
Definition data-streamer.h:253
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:162
poly_int64 streamer_read_poly_int64(class lto_input_block *)
Definition data-streamer-in.cc:193
const char * streamer_read_indexed_string(class data_in *, class lto_input_block *, unsigned int *)
Definition data-streamer-in.cc:68
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:135
void streamer_write_poly_uint64(struct output_block *, poly_uint64)
Definition data-streamer-out.cc:229
enum LTO_tags streamer_read_record_start(class lto_input_block *ib)
Definition data-streamer.h:390
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:322
poly_int< NUM_POLY_INT_COEFFS, bitpack_word_t > bp_unpack_poly_value(struct bitpack_d *bp, unsigned nbits)
Definition data-streamer.h:244
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:283
const char * bp_unpack_string(class data_in *, struct bitpack_d *)
Definition data-streamer-in.cc:107
void streamer_write_uhwi(struct output_block *, unsigned HOST_WIDE_INT)
Definition data-streamer-out.cc:212
void bp_unpack_real_value(struct bitpack_d *, REAL_VALUE_TYPE *)
Definition data-streamer.cc:144
void bp_pack_string(struct output_block *, struct bitpack_d *, const char *, bool)
Definition data-streamer-out.cc:189
void streamer_write_string(struct output_block *, struct lto_output_stream *, const char *, bool)
Definition data-streamer-out.cc:154
HOST_WIDE_INT streamer_read_hwi(class lto_input_block *)
Definition data-streamer-in.cc:160
void bp_pack_value(struct bitpack_d *bp, bitpack_word_t val, unsigned nbits)
Definition data-streamer.h:112
void bp_pack_string_with_length(struct output_block *, struct bitpack_d *, const char *, unsigned int, bool)
Definition data-streamer-out.cc:173
void bp_pack_var_len_unsigned(struct bitpack_d *, unsigned HOST_WIDE_INT)
Definition data-streamer.cc:43
void streamer_write_gcov_count(struct output_block *, gcov_type)
Definition data-streamer-out.cc:247
unsigned HOST_WIDE_INT streamer_read_uhwi(class lto_input_block *)
Definition data-streamer-in.cc:125
void streamer_write_hwi_stream(struct lto_output_stream *, HOST_WIDE_INT)
Definition data-streamer-out.cc:305
void streamer_write_uhwi_stream(struct lto_output_stream *, unsigned HOST_WIDE_INT)
Definition data-streamer-out.cc:255
void streamer_write_record_start(struct output_block *ob, enum LTO_tags tag)
Definition data-streamer.h:382
void streamer_write_gcov_count_stream(struct lto_output_stream *, gcov_type)
Definition data-streamer-out.cc:362
poly_uint64 streamer_read_poly_uint64(class lto_input_block *)
Definition data-streamer-in.cc:184
void streamer_read_value_range(class lto_input_block *, class data_in *, class value_range &)
Definition data-streamer-in.cc:218
const char * bp_unpack_indexed_string(class data_in *, struct bitpack_d *, unsigned int *)
Definition data-streamer-in.cc:97
void streamer_write_wide_int(struct output_block *, const wide_int &)
Definition data-streamer-out.cc:470
gcov_type streamer_read_gcov_count(class lto_input_block *)
Definition data-streamer-in.cc:202
unsigned host_num_poly_int_coeffs
bitpack_word_t bp_unpack_value(struct bitpack_d *bp, unsigned nbits)
Definition data-streamer.h:173
#define streamer_read_enum(ib, enum_name, enum_last)
Definition data-streamer.h:364
void streamer_write_zero(struct output_block *)
Definition data-streamer-out.cc:203
poly_int< NUM_POLY_INT_COEFFS, C > poly_int_read_common(F read_coeff, Args ...args)
Definition data-streamer.h: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:341
void streamer_write_hwi(struct output_block *, HOST_WIDE_INT)
Definition data-streamer-out.cc:221
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:142
void streamer_write_data_stream(struct lto_output_stream *, const void *, size_t)
Definition data-streamer-out.cc:371
unsigned HOST_WIDE_INT bp_unpack_var_len_unsigned(struct bitpack_d *)
Definition data-streamer.cc:85
unsigned char streamer_read_uchar(class lto_input_block *ib)
Definition data-streamer.h:271
widest_int streamer_read_widest_int(class lto_input_block *)
Definition data-streamer-in.cc:304
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:301
HOST_WIDE_INT bp_unpack_var_len_int(struct bitpack_d *)
Definition data-streamer.cc:105
#define streamer_write_enum(obs, enum_name, enum_last, val)
Definition data-streamer.h:359
unsigned HOST_WIDE_INT bitpack_word_t
Definition data-streamer.h:32
void void void void fatal_error(location_t, const char *,...) ATTRIBUTE_GCC_DIAG(2
#define NUM_POLY_INT_COEFFS
Definition genmodes.cc:859
int floor_log2(unsigned HOST_WIDE_INT x)
Definition hwint.cc:36
#define HOST_BITS_PER_WIDE_INT
Definition hwint.h:53
location_t input_location
Definition input.cc:191
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:468
void lto_section_overrun(class lto_input_block *ib)
Definition lto-section-in.cc:459
LTO_tags
Definition lto-streamer.h:134
@ LTO_NUM_TAGS
Definition lto-streamer.h:193
i
Definition poly-int.h:776
#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:622
unsigned int total_size
Definition lto-streamer.h:639
unsigned int left_in_block
Definition lto-streamer.h:633
char * current_pointer
Definition lto-streamer.h:630
Definition lto-streamer.h:698
struct lto_output_stream * main_stream
Definition lto-streamer.h:703
#define gcc_assert(EXPR)
Definition system.h:821
#define gcc_checking_assert(EXPR)
Definition system.h:828