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