* elf32-spu.c (build_stub): Fix malloc under-allocation.
[binutils.git] / gas / input-scrub.c
blobc6169b3146ad1dd011b7febee8fb2aacf6521e10
1 /* input_scrub.c - Break up input buffers into whole numbers of lines.
2 Copyright 1987, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
3 2000, 2001, 2003, 2005, 2006, 2007, 2008, 2009, 2010, 2011
4 Free Software Foundation, Inc.
6 This file is part of GAS, the GNU Assembler.
8 GAS is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3, or (at your option)
11 any later version.
13 GAS is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GAS; see the file COPYING. If not, write to the Free
20 Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA
21 02110-1301, USA. */
23 #include "as.h"
24 #include "filenames.h"
25 #include "input-file.h"
26 #include "sb.h"
27 #include "listing.h"
30 * O/S independent module to supply buffers of sanitised source code
31 * to rest of assembler. We get sanitised input data of arbitrary length.
32 * We break these buffers on line boundaries, recombine pieces that
33 * were broken across buffers, and return a buffer of full lines to
34 * the caller.
35 * The last partial line begins the next buffer we build and return to caller.
36 * The buffer returned to caller is preceded by BEFORE_STRING and followed
37 * by AFTER_STRING, as sentinels. The last character before AFTER_STRING
38 * is a newline.
39 * Also looks after line numbers, for e.g. error messages.
43 * We don't care how filthy our buffers are, but our callers assume
44 * that the following sanitation has already been done.
46 * No comments, reduce a comment to a space.
47 * Reduce a tab to a space unless it is 1st char of line.
48 * All multiple tabs and spaces collapsed into 1 char. Tab only
49 * legal if 1st char of line.
50 * # line file statements converted to .line x;.file y; statements.
51 * Escaped newlines at end of line: remove them but add as many newlines
52 * to end of statement as you removed in the middle, to synch line numbers.
55 #define BEFORE_STRING ("\n")
56 #define AFTER_STRING ("\0") /* memcpy of 0 chars might choke. */
57 #define BEFORE_SIZE (1)
58 #define AFTER_SIZE (1)
60 #ifndef TC_EOL_IN_INSN
61 #define TC_EOL_IN_INSN(P) 0
62 #endif
64 static char *buffer_start; /*->1st char of full buffer area. */
65 static char *partial_where; /*->after last full line in buffer. */
66 static int partial_size; /* >=0. Number of chars in partial line in buffer. */
68 /* Because we need AFTER_STRING just after last full line, it clobbers
69 1st part of partial line. So we preserve 1st part of partial line
70 here. */
71 static char save_source[AFTER_SIZE];
73 /* What is the largest size buffer that input_file_give_next_buffer()
74 could return to us? */
75 static unsigned int buffer_length;
77 /* The index into an sb structure we are reading from. -1 if none. */
78 static int sb_index = -1;
80 /* If we are reading from an sb structure, this is it. */
81 static sb from_sb;
83 /* Should we do a conditional check on from_sb? */
84 static int from_sb_is_expansion = 1;
86 /* The number of nested sb structures we have included. */
87 int macro_nest;
89 /* We can have more than one source file open at once, though the info for all
90 but the latest one are saved off in a struct input_save. These files remain
91 open, so we are limited by the number of open files allowed by the
92 underlying OS. We may also sequentially read more than one source file in an
93 assembly. */
95 /* We must track the physical file and line number for error messages. We also
96 track a "logical" file and line number corresponding to (C?) compiler
97 source line numbers. Whenever we open a file we must fill in
98 physical_input_file. So if it is NULL we have not opened any files yet. */
100 static char *physical_input_file;
101 static char *logical_input_file;
103 /* 1-origin line number in a source file. */
104 /* A line ends in '\n' or eof. */
105 static unsigned int physical_input_line;
106 static int logical_input_line;
108 /* Struct used to save the state of the input handler during include files */
109 struct input_save {
110 char * buffer_start;
111 char * partial_where;
112 int partial_size;
113 char save_source[AFTER_SIZE];
114 unsigned int buffer_length;
115 char * physical_input_file;
116 char * logical_input_file;
117 unsigned int physical_input_line;
118 int logical_input_line;
119 int sb_index;
120 sb from_sb;
121 int from_sb_is_expansion; /* Should we do a conditional check? */
122 struct input_save * next_saved_file; /* Chain of input_saves. */
123 char * input_file_save; /* Saved state of input routines. */
124 char * saved_position; /* Caller's saved position in buf. */
127 static struct input_save *input_scrub_push (char *saved_position);
128 static char *input_scrub_pop (struct input_save *arg);
130 /* Saved information about the file that .include'd this one. When we hit EOF,
131 we automatically pop to that file. */
133 static struct input_save *next_saved_file;
135 /* Push the state of input reading and scrubbing so that we can #include.
136 The return value is a 'void *' (fudged for old compilers) to a save
137 area, which can be restored by passing it to input_scrub_pop(). */
139 static struct input_save *
140 input_scrub_push (char *saved_position)
142 register struct input_save *saved;
144 saved = (struct input_save *) xmalloc (sizeof *saved);
146 saved->saved_position = saved_position;
147 saved->buffer_start = buffer_start;
148 saved->partial_where = partial_where;
149 saved->partial_size = partial_size;
150 saved->buffer_length = buffer_length;
151 saved->physical_input_file = physical_input_file;
152 saved->logical_input_file = logical_input_file;
153 saved->physical_input_line = physical_input_line;
154 saved->logical_input_line = logical_input_line;
155 saved->sb_index = sb_index;
156 saved->from_sb = from_sb;
157 saved->from_sb_is_expansion = from_sb_is_expansion;
158 memcpy (saved->save_source, save_source, sizeof (save_source));
159 saved->next_saved_file = next_saved_file;
160 saved->input_file_save = input_file_push ();
162 input_file_begin (); /* Reinitialize! */
163 logical_input_line = -1;
164 logical_input_file = (char *) NULL;
165 buffer_length = input_file_buffer_size ();
166 sb_index = -1;
168 buffer_start = (char *) xmalloc ((BEFORE_SIZE + buffer_length
169 + buffer_length + AFTER_SIZE));
170 memcpy (buffer_start, BEFORE_STRING, (int) BEFORE_SIZE);
172 return saved;
175 static char *
176 input_scrub_pop (struct input_save *saved)
178 char *saved_position;
180 input_scrub_end (); /* Finish off old buffer */
182 input_file_pop (saved->input_file_save);
183 saved_position = saved->saved_position;
184 buffer_start = saved->buffer_start;
185 buffer_length = saved->buffer_length;
186 physical_input_file = saved->physical_input_file;
187 logical_input_file = saved->logical_input_file;
188 physical_input_line = saved->physical_input_line;
189 logical_input_line = saved->logical_input_line;
190 sb_index = saved->sb_index;
191 from_sb = saved->from_sb;
192 from_sb_is_expansion = saved->from_sb_is_expansion;
193 partial_where = saved->partial_where;
194 partial_size = saved->partial_size;
195 next_saved_file = saved->next_saved_file;
196 memcpy (save_source, saved->save_source, sizeof (save_source));
198 free (saved);
199 return saved_position;
202 void
203 input_scrub_begin (void)
205 know (strlen (BEFORE_STRING) == BEFORE_SIZE);
206 know (strlen (AFTER_STRING) == AFTER_SIZE
207 || (AFTER_STRING[0] == '\0' && AFTER_SIZE == 1));
209 input_file_begin ();
211 buffer_length = input_file_buffer_size ();
213 buffer_start = (char *) xmalloc ((BEFORE_SIZE + buffer_length
214 + buffer_length + AFTER_SIZE));
215 memcpy (buffer_start, BEFORE_STRING, (int) BEFORE_SIZE);
217 /* Line number things. */
218 logical_input_line = -1;
219 logical_input_file = (char *) NULL;
220 physical_input_file = NULL; /* No file read yet. */
221 next_saved_file = NULL; /* At EOF, don't pop to any other file */
222 do_scrub_begin (flag_m68k_mri);
225 void
226 input_scrub_end (void)
228 if (buffer_start)
230 free (buffer_start);
231 buffer_start = 0;
232 input_file_end ();
236 /* Start reading input from a new file.
237 Return start of caller's part of buffer. */
239 char *
240 input_scrub_new_file (char *filename)
242 input_file_open (filename, !flag_no_comments);
243 physical_input_file = filename[0] ? filename : _("{standard input}");
244 physical_input_line = 0;
246 partial_size = 0;
247 return (buffer_start + BEFORE_SIZE);
250 /* Include a file from the current file. Save our state, cause it to
251 be restored on EOF, and begin handling a new file. Same result as
252 input_scrub_new_file. */
254 char *
255 input_scrub_include_file (char *filename, char *position)
257 next_saved_file = input_scrub_push (position);
258 return input_scrub_new_file (filename);
261 /* Start getting input from an sb structure. This is used when
262 expanding a macro. */
264 void
265 input_scrub_include_sb (sb *from, char *position, int is_expansion)
267 if (macro_nest > max_macro_nest)
268 as_fatal (_("macros nested too deeply"));
269 ++macro_nest;
271 #ifdef md_macro_start
272 if (is_expansion)
274 md_macro_start ();
276 #endif
278 next_saved_file = input_scrub_push (position);
280 sb_new (&from_sb);
281 from_sb_is_expansion = is_expansion;
282 if (from->len >= 1 && from->ptr[0] != '\n')
284 /* Add the sentinel required by read.c. */
285 sb_add_char (&from_sb, '\n');
287 sb_scrub_and_add_sb (&from_sb, from);
289 /* Make sure the parser looks at defined contents when it scans for
290 e.g. end-of-line at the end of a macro. */
291 sb_add_char (&from_sb, 0);
292 from_sb.len--;
294 sb_index = 1;
296 /* These variables are reset by input_scrub_push. Restore them
297 since we are, after all, still at the same point in the file. */
298 logical_input_line = next_saved_file->logical_input_line;
299 logical_input_file = next_saved_file->logical_input_file;
302 void
303 input_scrub_close (void)
305 input_file_close ();
306 physical_input_line = 0;
307 logical_input_line = -1;
310 char *
311 input_scrub_next_buffer (char **bufp)
313 register char *limit; /*->just after last char of buffer. */
315 if (sb_index >= 0)
317 if (sb_index >= from_sb.len)
319 sb_kill (&from_sb);
320 if (from_sb_is_expansion
323 cond_finish_check (macro_nest);
324 #ifdef md_macro_end
325 /* Allow the target to clean up per-macro expansion
326 data. */
327 md_macro_end ();
328 #endif
330 --macro_nest;
331 partial_where = NULL;
332 if (next_saved_file != NULL)
333 *bufp = input_scrub_pop (next_saved_file);
334 return partial_where;
337 partial_where = from_sb.ptr + from_sb.len;
338 partial_size = 0;
339 *bufp = from_sb.ptr + sb_index;
340 sb_index = from_sb.len;
341 return partial_where;
344 *bufp = buffer_start + BEFORE_SIZE;
346 if (partial_size)
348 memmove (buffer_start + BEFORE_SIZE, partial_where,
349 (unsigned int) partial_size);
350 memcpy (buffer_start + BEFORE_SIZE, save_source, AFTER_SIZE);
352 limit = input_file_give_next_buffer (buffer_start
353 + BEFORE_SIZE
354 + partial_size);
355 if (limit)
357 register char *p; /* Find last newline. */
358 /* Terminate the buffer to avoid confusing TC_EOL_IN_INSN. */
359 *limit = '\0';
360 for (p = limit - 1; *p != '\n' || TC_EOL_IN_INSN (p); --p)
362 ++p;
364 while (p <= buffer_start + BEFORE_SIZE)
366 int limoff;
368 limoff = limit - buffer_start;
369 buffer_length += input_file_buffer_size ();
370 buffer_start = (char *) xrealloc (buffer_start,
371 (BEFORE_SIZE
372 + 2 * buffer_length
373 + AFTER_SIZE));
374 *bufp = buffer_start + BEFORE_SIZE;
375 limit = input_file_give_next_buffer (buffer_start + limoff);
377 if (limit == NULL)
379 as_warn (_("partial line at end of file ignored"));
380 partial_where = NULL;
381 if (next_saved_file)
382 *bufp = input_scrub_pop (next_saved_file);
383 return NULL;
386 /* Terminate the buffer to avoid confusing TC_EOL_IN_INSN. */
387 *limit = '\0';
388 for (p = limit - 1; *p != '\n' || TC_EOL_IN_INSN (p); --p)
390 ++p;
393 partial_where = p;
394 partial_size = limit - p;
395 memcpy (save_source, partial_where, (int) AFTER_SIZE);
396 memcpy (partial_where, AFTER_STRING, (int) AFTER_SIZE);
398 else
400 partial_where = 0;
401 if (partial_size > 0)
403 as_warn (_("partial line at end of file ignored"));
406 /* Tell the listing we've finished the file. */
407 LISTING_EOF ();
409 /* If we should pop to another file at EOF, do it. */
410 if (next_saved_file)
412 *bufp = input_scrub_pop (next_saved_file); /* Pop state */
413 /* partial_where is now correct to return, since we popped it. */
416 return (partial_where);
419 /* The remaining part of this file deals with line numbers, error
420 messages and so on. Return TRUE if we opened any file. */
423 seen_at_least_1_file (void)
425 return (physical_input_file != NULL);
428 void
429 bump_line_counters (void)
431 if (sb_index < 0)
433 ++physical_input_line;
434 if (logical_input_line >= 0)
435 ++logical_input_line;
439 /* Tells us what the new logical line number and file are.
440 If the line_number is -1, we don't change the current logical line
441 number. If it is -2, we decrement the logical line number (this is
442 to support the .appfile pseudo-op inserted into the stream by
443 do_scrub_chars).
444 If the fname is NULL, we don't change the current logical file name.
445 Returns nonzero if the filename actually changes. */
448 new_logical_line_flags (char *fname, /* DON'T destroy it! We point to it! */
449 int line_number,
450 int flags)
452 switch (flags)
454 case 0:
455 break;
456 case 1:
457 if (line_number != -1)
458 abort ();
459 break;
460 case 1 << 1:
461 case 1 << 2:
462 /* FIXME: we could check that include nesting is correct. */
463 break;
464 default:
465 abort ();
468 if (line_number >= 0)
469 logical_input_line = line_number;
470 else if (line_number == -1 && fname && !*fname && (flags & (1 << 2)))
472 logical_input_file = physical_input_file;
473 logical_input_line = physical_input_line;
474 fname = NULL;
477 if (fname
478 && (logical_input_file == NULL
479 || filename_cmp (logical_input_file, fname)))
481 logical_input_file = fname;
482 return 1;
484 else
485 return 0;
489 new_logical_line (char *fname, int line_number)
491 return new_logical_line_flags (fname, line_number, 0);
495 /* Return the current file name and line number.
496 namep should be char * const *, but there are compilers which screw
497 up declarations like that, and it's easier to avoid it. */
499 void
500 as_where (char **namep, unsigned int *linep)
502 if (logical_input_file != NULL
503 && (linep == NULL || logical_input_line >= 0))
505 *namep = logical_input_file;
506 if (linep != NULL)
507 *linep = logical_input_line;
509 else if (physical_input_file != NULL)
511 *namep = physical_input_file;
512 if (linep != NULL)
513 *linep = physical_input_line;
515 else
517 *namep = 0;
518 if (linep != NULL)
519 *linep = 0;