Line data Source code
1 : /* Routines for saving various data types to a file stream. This deals
2 : with various data types like strings, integers, enums, etc.
3 :
4 : Copyright (C) 2011-2026 Free Software Foundation, Inc.
5 : Contributed by Diego Novillo <dnovillo@google.com>
6 :
7 : This file is part of GCC.
8 :
9 : GCC is free software; you can redistribute it and/or modify it under
10 : the terms of the GNU General Public License as published by the Free
11 : Software Foundation; either version 3, or (at your option) any later
12 : version.
13 :
14 : GCC is distributed in the hope that it will be useful, but WITHOUT ANY
15 : WARRANTY; without even the implied warranty of MERCHANTABILITY or
16 : FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 : for more details.
18 :
19 : You should have received a copy of the GNU General Public License
20 : along with GCC; see the file COPYING3. If not see
21 : <http://www.gnu.org/licenses/>. */
22 :
23 : #include "config.h"
24 : #include "system.h"
25 : #include "coretypes.h"
26 : #include "backend.h"
27 : #include "tree.h"
28 : #include "gimple.h"
29 : #include "cgraph.h"
30 : #include "data-streamer.h"
31 : #include "value-range.h"
32 : #include "streamer-hooks.h"
33 :
34 :
35 : /* Adds a new block to output stream OBS. */
36 :
37 : void
38 705141 : lto_append_block (struct lto_output_stream *obs)
39 : {
40 705141 : struct lto_char_ptr_base *new_block;
41 :
42 705141 : gcc_assert (obs->left_in_block == 0);
43 :
44 705141 : if (obs->first_block == NULL)
45 : {
46 : /* This is the first time the stream has been written
47 : into. */
48 659089 : obs->block_size = 1024;
49 659089 : new_block = (struct lto_char_ptr_base*) xmalloc (obs->block_size);
50 659089 : obs->first_block = new_block;
51 : }
52 : else
53 : {
54 46052 : struct lto_char_ptr_base *tptr;
55 : /* Get a new block that is twice as big as the last block
56 : and link it into the list. */
57 46052 : obs->block_size *= 2;
58 46052 : new_block = (struct lto_char_ptr_base*) xmalloc (obs->block_size);
59 : /* The first bytes of the block are reserved as a pointer to
60 : the next block. Set the chain of the full block to the
61 : pointer to the new block. */
62 46052 : tptr = obs->current_block;
63 46052 : tptr->ptr = (char *) new_block;
64 : }
65 :
66 : /* Set the place for the next char at the first position after the
67 : chain to the next block. */
68 705141 : obs->current_pointer
69 705141 : = ((char *) new_block) + sizeof (struct lto_char_ptr_base);
70 705141 : obs->current_block = new_block;
71 : /* Null out the newly allocated block's pointer to the next block. */
72 705141 : new_block->ptr = NULL;
73 705141 : obs->left_in_block = obs->block_size - sizeof (struct lto_char_ptr_base);
74 705141 : }
75 :
76 :
77 : /* Return index used to reference STRING of LEN characters in the string table
78 : in OB. The string might or might not include a trailing '\0'.
79 : Then put the index onto the INDEX_STREAM.
80 : When PERSISTENT is set, the string S is supposed to not change during
81 : duration of the OB and thus OB can keep pointer into it. */
82 :
83 : static unsigned
84 2222247 : streamer_string_index (struct output_block *ob, const char *s, unsigned int len,
85 : bool persistent)
86 : {
87 2222247 : struct string_slot **slot;
88 2222247 : struct string_slot s_slot;
89 :
90 2222247 : s_slot.s = s;
91 2222247 : s_slot.len = len;
92 2222247 : s_slot.slot_num = 0;
93 :
94 2222247 : slot = ob->string_hash_table->find_slot (&s_slot, INSERT);
95 2222247 : if (*slot == NULL)
96 : {
97 1963264 : struct lto_output_stream *string_stream = ob->string_stream;
98 1963264 : unsigned int start = string_stream->total_size;
99 1963264 : struct string_slot *new_slot = XOBNEW (&ob->obstack, struct string_slot);
100 1963264 : const char *string;
101 :
102 1963264 : if (!persistent)
103 : {
104 0 : char *tmp;
105 0 : string = tmp = XOBNEWVEC (&ob->obstack, char, len);
106 0 : memcpy (tmp, s, len);
107 : }
108 : else
109 : string = s;
110 :
111 1963264 : new_slot->s = string;
112 1963264 : new_slot->len = len;
113 1963264 : new_slot->slot_num = start;
114 1963264 : *slot = new_slot;
115 1963264 : streamer_write_uhwi_stream (string_stream, len);
116 1963264 : streamer_write_data_stream (string_stream, string, len);
117 1963264 : return start + 1;
118 : }
119 : else
120 : {
121 258983 : struct string_slot *old_slot = *slot;
122 258983 : return old_slot->slot_num + 1;
123 : }
124 : }
125 :
126 :
127 : /* Output STRING of LEN characters to the string table in OB. The
128 : string might or might not include a trailing '\0'. Then put the
129 : index onto the INDEX_STREAM.
130 : When PERSISTENT is set, the string S is supposed to not change during
131 : duration of the OB and thus OB can keep pointer into it. */
132 :
133 : void
134 1725289 : streamer_write_string_with_length (struct output_block *ob,
135 : struct lto_output_stream *index_stream,
136 : const char *s, unsigned int len,
137 : bool persistent)
138 : {
139 1725289 : if (s)
140 1725289 : streamer_write_uhwi_stream (index_stream,
141 1725289 : streamer_string_index (ob, s, len, persistent));
142 : else
143 0 : streamer_write_char_stream (index_stream, 0);
144 1725289 : }
145 :
146 :
147 : /* Output the '\0' terminated STRING to the string
148 : table in OB. Then put the index onto the INDEX_STREAM.
149 : When PERSISTENT is set, the string S is supposed to not change during
150 : duration of the OB and thus OB can keep pointer into it. */
151 :
152 : void
153 1753663 : streamer_write_string (struct output_block *ob,
154 : struct lto_output_stream *index_stream,
155 : const char *string, bool persistent)
156 : {
157 1753663 : if (string)
158 57702 : streamer_write_string_with_length (ob, index_stream, string,
159 57702 : strlen (string) + 1,
160 : persistent);
161 : else
162 1695961 : streamer_write_char_stream (index_stream, 0);
163 1753663 : }
164 :
165 :
166 : /* Output STRING of LEN characters to the string table in OB. Then
167 : put the index into BP.
168 : When PERSISTENT is set, the string S is supposed to not change during
169 : duration of the OB and thus OB can keep pointer into it. */
170 :
171 : void
172 0 : bp_pack_string_with_length (struct output_block *ob, struct bitpack_d *bp,
173 : const char *s, unsigned int len, bool persistent)
174 : {
175 0 : unsigned index = 0;
176 0 : if (s)
177 0 : index = streamer_string_index (ob, s, len, persistent);
178 0 : bp_pack_var_len_unsigned (bp, index);
179 0 : }
180 :
181 :
182 : /* Output the '\0' terminated STRING to the string
183 : table in OB. Then put the index onto the bitpack BP.
184 : When PERSISTENT is set, the string S is supposed to not change during
185 : duration of the OB and thus OB can keep pointer into it. */
186 :
187 : void
188 765288 : bp_pack_string (struct output_block *ob, struct bitpack_d *bp,
189 : const char *s, bool persistent)
190 : {
191 765288 : unsigned index = 0;
192 765288 : if (s)
193 496958 : index = streamer_string_index (ob, s, strlen (s) + 1, persistent);
194 765288 : bp_pack_var_len_unsigned (bp, index);
195 765288 : }
196 :
197 :
198 :
199 : /* Write a zero to the output stream. */
200 :
201 : void
202 12395511 : streamer_write_zero (struct output_block *ob)
203 : {
204 12395511 : streamer_write_char_stream (ob->main_stream, 0);
205 12395511 : }
206 :
207 :
208 : /* Write an unsigned HOST_WIDE_INT value WORK to OB->main_stream. */
209 :
210 : void
211 36303794 : streamer_write_uhwi (struct output_block *ob, unsigned HOST_WIDE_INT work)
212 : {
213 36303794 : streamer_write_uhwi_stream (ob->main_stream, work);
214 36303794 : }
215 :
216 :
217 : /* Write a HOST_WIDE_INT value WORK to OB->main_stream. */
218 :
219 : void
220 28106091 : streamer_write_hwi (struct output_block *ob, HOST_WIDE_INT work)
221 : {
222 28106091 : streamer_write_hwi_stream (ob->main_stream, work);
223 28106091 : }
224 :
225 : /* Write a poly_uint64 value WORK to OB->main_stream. */
226 :
227 : void
228 0 : streamer_write_poly_uint64 (struct output_block *ob, poly_uint64 work)
229 : {
230 0 : for (int i = 0; i < NUM_POLY_INT_COEFFS; ++i)
231 0 : streamer_write_uhwi_stream (ob->main_stream, work.coeffs[i]);
232 0 : }
233 :
234 : /* Write a poly_int64 value WORK to OB->main_stream. */
235 :
236 : void
237 78592 : streamer_write_poly_int64 (struct output_block *ob, poly_int64 work)
238 : {
239 157184 : for (int i = 0; i < NUM_POLY_INT_COEFFS; ++i)
240 78592 : streamer_write_hwi_stream (ob->main_stream, work.coeffs[i]);
241 78592 : }
242 :
243 : /* Write a gcov counter value WORK to OB->main_stream. */
244 :
245 : void
246 913519 : streamer_write_gcov_count (struct output_block *ob, gcov_type work)
247 : {
248 913519 : streamer_write_gcov_count_stream (ob->main_stream, work);
249 913519 : }
250 :
251 : /* Write an unsigned HOST_WIDE_INT value WORK to OBS. */
252 :
253 : void
254 93440411 : streamer_write_uhwi_stream (struct lto_output_stream *obs,
255 : unsigned HOST_WIDE_INT work)
256 : {
257 93440411 : if (obs->left_in_block == 0)
258 509963 : lto_append_block (obs);
259 93440411 : char *current_pointer = obs->current_pointer;
260 93440411 : unsigned int left_in_block = obs->left_in_block;
261 93440411 : unsigned int size = 0;
262 161545104 : do
263 : {
264 161545104 : unsigned int byte = (work & 0x7f);
265 161545104 : work >>= 7;
266 161545104 : if (work != 0)
267 : /* More bytes to follow. */
268 68116774 : byte |= 0x80;
269 :
270 161545104 : *(current_pointer++) = byte;
271 161545104 : left_in_block--;
272 161545104 : size++;
273 : }
274 161545104 : while (work != 0 && left_in_block > 0);
275 93440411 : if (work != 0)
276 : {
277 12081 : obs->left_in_block = 0;
278 12081 : lto_append_block (obs);
279 12081 : current_pointer = obs->current_pointer;
280 12081 : left_in_block = obs->left_in_block;
281 35868 : do
282 : {
283 35868 : unsigned int byte = (work & 0x7f);
284 35868 : work >>= 7;
285 35868 : if (work != 0)
286 : /* More bytes to follow. */
287 23787 : byte |= 0x80;
288 :
289 35868 : *(current_pointer++) = byte;
290 35868 : left_in_block--;
291 35868 : size++;
292 : }
293 35868 : while (work != 0);
294 : }
295 93440411 : obs->current_pointer = current_pointer;
296 93440411 : obs->left_in_block = left_in_block;
297 93440411 : obs->total_size += size;
298 93440411 : }
299 :
300 :
301 : /* Write a HOST_WIDE_INT value WORK to OBS. */
302 :
303 : void
304 36103975 : streamer_write_hwi_stream (struct lto_output_stream *obs, HOST_WIDE_INT work)
305 : {
306 36103975 : if (obs->left_in_block == 0)
307 21718 : lto_append_block (obs);
308 36103975 : char *current_pointer = obs->current_pointer;
309 36103975 : unsigned int left_in_block = obs->left_in_block;
310 36103975 : unsigned int size = 0;
311 66910488 : bool more;
312 66910488 : do
313 : {
314 66910488 : unsigned int byte = (work & 0x7f);
315 : /* If the lower 7-bits are sign-extended 0 or -1 we are finished. */
316 66910488 : work >>= 6;
317 66910488 : more = !(work == 0 || work == -1);
318 66910488 : if (more)
319 : {
320 : /* More bits to follow. */
321 30811463 : work >>= 1;
322 30811463 : byte |= 0x80;
323 : }
324 :
325 66910488 : *(current_pointer++) = byte;
326 66910488 : left_in_block--;
327 66910488 : size++;
328 : }
329 66910488 : while (more && left_in_block > 0);
330 36103975 : if (more)
331 : {
332 4950 : obs->left_in_block = 0;
333 4950 : lto_append_block (obs);
334 4950 : current_pointer = obs->current_pointer;
335 4950 : left_in_block = obs->left_in_block;
336 15142 : do
337 : {
338 7571 : unsigned int byte = (work & 0x7f);
339 7571 : work >>= 6;
340 7571 : more = !(work == 0 || work == -1);
341 7571 : if (more)
342 : {
343 2621 : work >>= 1;
344 2621 : byte |= 0x80;
345 : }
346 :
347 7571 : *(current_pointer++) = byte;
348 7571 : left_in_block--;
349 7571 : size++;
350 : }
351 : while (more);
352 : }
353 36103975 : obs->current_pointer = current_pointer;
354 36103975 : obs->left_in_block = left_in_block;
355 36103975 : obs->total_size += size;
356 36103975 : }
357 :
358 : /* Write a GCOV counter value WORK to OBS. */
359 :
360 : void
361 2038501 : streamer_write_gcov_count_stream (struct lto_output_stream *obs, gcov_type work)
362 : {
363 2038501 : gcc_assert ((HOST_WIDE_INT) work == work);
364 2038501 : streamer_write_hwi_stream (obs, work);
365 2038501 : }
366 :
367 : /* Write raw DATA of length LEN to the output block OB. */
368 :
369 : void
370 3376496 : streamer_write_data_stream (struct lto_output_stream *obs, const void *data,
371 : size_t len)
372 : {
373 6755599 : while (len)
374 : {
375 3379103 : size_t copy;
376 :
377 : /* No space left. */
378 3379103 : if (obs->left_in_block == 0)
379 2960 : lto_append_block (obs);
380 :
381 : /* Determine how many bytes to copy in this loop. */
382 3379103 : if (len <= obs->left_in_block)
383 : copy = len;
384 : else
385 : copy = obs->left_in_block;
386 :
387 : /* Copy the data and do bookkeeping. */
388 3379103 : memcpy (obs->current_pointer, data, copy);
389 3379103 : obs->current_pointer += copy;
390 3379103 : obs->total_size += copy;
391 3379103 : obs->left_in_block -= copy;
392 3379103 : data = (const char *) data + copy;
393 3379103 : len -= copy;
394 : }
395 3376496 : }
396 :
397 : /* Write REAL_VALUE_TYPE into OB. */
398 :
399 : void
400 956 : streamer_write_real_value (struct output_block *ob, const REAL_VALUE_TYPE *r)
401 : {
402 956 : bitpack_d bp = bitpack_create (ob->main_stream);
403 956 : bp_pack_real_value (&bp, r);
404 956 : streamer_write_bitpack (&bp);
405 956 : }
406 :
407 : void
408 466334 : streamer_write_vrange (struct output_block *ob, const vrange &v)
409 : {
410 466334 : gcc_checking_assert (!v.undefined_p ());
411 :
412 : // Write the common fields to all vranges.
413 466334 : value_range_kind kind = v.m_kind;
414 466334 : streamer_write_enum (ob->main_stream, value_range_kind, VR_LAST, kind);
415 466334 : stream_write_tree (ob, v.type (), true);
416 :
417 466334 : if (is_a <irange> (v))
418 : {
419 256900 : const irange &r = as_a <irange> (v);
420 256900 : streamer_write_uhwi (ob, r.num_pairs ());
421 528800 : for (unsigned i = 0; i < r.num_pairs (); ++i)
422 : {
423 271900 : streamer_write_wide_int (ob, r.lower_bound (i));
424 271921 : streamer_write_wide_int (ob, r.upper_bound (i));
425 : }
426 : // TODO: We could avoid streaming out the value if the mask is -1.
427 256900 : irange_bitmask bm = r.get_bitmask ();
428 256900 : streamer_write_wide_int (ob, bm.value ());
429 256900 : streamer_write_wide_int (ob, bm.mask ());
430 256900 : return;
431 256900 : }
432 209434 : if (is_a <frange> (v))
433 : {
434 481 : const frange &r = as_a <frange> (v);
435 :
436 : // Stream out NAN bits.
437 481 : bitpack_d bp = bitpack_create (ob->main_stream);
438 481 : nan_state nan = r.get_nan_state ();
439 481 : bp_pack_value (&bp, nan.pos_p (), 1);
440 481 : bp_pack_value (&bp, nan.neg_p (), 1);
441 481 : streamer_write_bitpack (&bp);
442 :
443 : // Stream out bounds.
444 481 : if (kind != VR_NAN)
445 : {
446 478 : REAL_VALUE_TYPE lb = r.lower_bound ();
447 478 : REAL_VALUE_TYPE ub = r.upper_bound ();
448 478 : streamer_write_real_value (ob, &lb);
449 478 : streamer_write_real_value (ob, &ub);
450 : }
451 481 : return;
452 : }
453 208953 : if (is_a <prange> (v))
454 : {
455 208953 : const prange &r = as_a <prange> (v);
456 208953 : streamer_write_wide_int (ob, r.lower_bound ());
457 208953 : streamer_write_wide_int (ob, r.upper_bound ());
458 208953 : irange_bitmask bm = r.get_bitmask ();
459 208953 : streamer_write_wide_int (ob, bm.value ());
460 208953 : streamer_write_wide_int (ob, bm.mask ());
461 208953 : return;
462 208953 : }
463 0 : gcc_unreachable ();
464 : }
465 :
466 : /* Emit the physical representation of wide_int VAL to output block OB. */
467 :
468 : void
469 1895413 : streamer_write_wide_int (struct output_block *ob, const wide_int &val)
470 : {
471 1895413 : int len = val.get_len ();
472 :
473 1895413 : streamer_write_uhwi (ob, val.get_precision ());
474 1895413 : streamer_write_uhwi (ob, len);
475 3798537 : for (int i = 0; i < len; i++)
476 1903124 : streamer_write_hwi (ob, val.elt (i));
477 1895413 : }
478 :
479 : /* Emit the physical representation of widest_int W to output block OB. */
480 :
481 : void
482 113451 : streamer_write_widest_int (struct output_block *ob,
483 : const widest_int &w)
484 : {
485 113451 : int len = w.get_len ();
486 :
487 113451 : streamer_write_uhwi (ob, w.get_precision ());
488 113451 : streamer_write_uhwi (ob, len);
489 228080 : for (int i = 0; i < len; i++)
490 114629 : streamer_write_hwi (ob, w.elt (i));
491 113451 : }
492 :
|
