1 /* Generic stabs parsing for gas.
2 Copyright (C) 1989-2016 Free Software Foundation, Inc.
4 This file is part of GAS, the GNU Assembler.
6 GAS is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as
8 published by the Free Software Foundation; either version 3,
9 or (at your option) any later version.
11 GAS is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
14 the GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GAS; see the file COPYING. If not, write to the Free
18 Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA
22 #include "filenames.h"
27 /* We need this, despite the apparent object format dependency, since
28 it defines stab types, which all object formats can use now. */
30 #include "aout/stab_gnu.h"
32 /* Holds whether the assembler is generating stabs line debugging
33 information or not. Potentially used by md_cleanup function. */
35 int outputting_stabs_line_debug
= 0;
37 static void s_stab_generic (int, const char *, const char *);
38 static void generate_asm_file (int, char *);
40 /* Allow backends to override the names used for the stab sections. */
41 #ifndef STAB_SECTION_NAME
42 #define STAB_SECTION_NAME ".stab"
45 #ifndef STAB_STRING_SECTION_NAME
46 #define STAB_STRING_SECTION_NAME ".stabstr"
49 /* Non-zero if we're in the middle of a .func function, in which case
50 stabs_generate_asm_lineno emits function relative line number stabs.
51 Otherwise it emits line number stabs with absolute addresses. Note that
52 both cases only apply to assembler code assembled with -gstabs. */
53 static int in_dot_func_p
;
55 /* Label at start of current function if in_dot_func_p != 0. */
56 static const char *current_function_label
;
59 * Handle .stabX directives, which used to be open-coded.
60 * So much creeping featurism overloaded the semantics that we decided
61 * to put all .stabX thinking in one place. Here.
63 * We try to make any .stabX directive legal. Other people's AS will often
64 * do assembly-time consistency checks: eg assigning meaning to n_type bits
65 * and "protecting" you from setting them to certain values. (They also zero
66 * certain bits before emitting symbols. Tut tut.)
68 * If an expression is not absolute we either gripe or use the relocation
69 * information. Other people's assemblers silently forget information they
70 * don't need and invent information they need that you didn't supply.
74 * Build a string dictionary entry for a .stabX symbol.
75 * The symbol is added to the .<secname>str section.
78 #ifndef SEPARATE_STAB_SECTIONS
79 #define SEPARATE_STAB_SECTIONS 0
83 get_stab_string_offset (const char *string
, const char *stabstr_secname
)
92 if (! SEPARATE_STAB_SECTIONS
)
95 length
= strlen (string
);
98 save_subseg
= now_subseg
;
100 /* Create the stab string section. */
101 seg
= subseg_new (stabstr_secname
, 0);
103 retval
= seg_info (seg
)->stabu
.stab_string_size
;
106 /* Make sure the first string is empty. */
109 retval
= seg_info (seg
)->stabu
.stab_string_size
= 1;
110 bfd_set_section_flags (stdoutput
, seg
, SEC_READONLY
| SEC_DEBUGGING
);
111 if (seg
->name
== stabstr_secname
)
112 seg
->name
= xstrdup (stabstr_secname
);
116 { /* Ordinary case. */
117 p
= frag_more (length
+ 1);
120 seg_info (seg
)->stabu
.stab_string_size
+= length
+ 1;
125 subseg_set (save_seg
, save_subseg
);
131 #ifndef OBJ_PROCESS_STAB
132 #define OBJ_PROCESS_STAB(SEG,W,S,T,O,D) aout_process_stab(W,S,T,O,D)
135 /* Here instead of obj-aout.c because other formats use it too. */
137 aout_process_stab (what
, string
, type
, other
, desc
)
140 int type
, other
, desc
;
142 /* Put the stab information in the symbol table. */
145 /* Create the symbol now, but only insert it into the symbol chain
146 after any symbols mentioned in the value expression get into the
147 symbol chain. This is to avoid "continuation symbols" (where one
148 ends in "\" and the debug info is continued in the next .stabs
149 directive) from being separated by other random symbols. */
150 symbol
= symbol_create (string
, undefined_section
, 0,
152 if (what
== 's' || what
== 'n')
154 /* Pick up the value from the input line. */
159 /* .stabd sets the name to NULL. Why? */
160 S_SET_NAME (symbol
, NULL
);
161 symbol_set_frag (symbol
, frag_now
);
162 S_SET_VALUE (symbol
, (valueT
) frag_now_fix ());
165 symbol_append (symbol
, symbol_lastP
, &symbol_rootP
, &symbol_lastP
);
167 symbol_get_bfdsym (symbol
)->flags
|= BSF_DEBUGGING
;
169 S_SET_TYPE (symbol
, type
);
170 S_SET_OTHER (symbol
, other
);
171 S_SET_DESC (symbol
, desc
);
175 /* This can handle different kinds of stabs (s,n,d) and different
176 kinds of stab sections. */
179 s_stab_generic (int what
,
180 const char * stab_secname
,
181 const char * stabstr_secname
)
184 char *string
, *saved_string_obstack_end
;
189 /* The general format is:
190 .stabs "STRING",TYPE,OTHER,DESC,VALUE
191 .stabn TYPE,OTHER,DESC,VALUE
192 .stabd TYPE,OTHER,DESC
193 At this point input_line_pointer points after the pseudo-op and
194 any trailing whitespace. The argument what is one of 's', 'n' or
195 'd' indicating which type of .stab this is. */
200 saved_string_obstack_end
= 0;
206 string
= demand_copy_C_string (&length
);
207 /* FIXME: We should probably find some other temporary storage
208 for string, rather than leaking memory if someone else
209 happens to use the notes obstack. */
210 saved_string_obstack_end
= notes
.next_free
;
212 if (*input_line_pointer
== ',')
213 input_line_pointer
++;
216 as_warn (_(".stab%c: missing comma"), what
);
217 ignore_rest_of_line ();
222 if (get_absolute_expression_and_terminator (&longint
) != ',')
224 as_warn (_(".stab%c: missing comma"), what
);
225 ignore_rest_of_line ();
230 if (get_absolute_expression_and_terminator (&longint
) != ',')
232 as_warn (_(".stab%c: missing comma"), what
);
233 ignore_rest_of_line ();
238 desc
= get_absolute_expression ();
240 if ((desc
> 0xffff) || (desc
< -0x8000))
241 /* This could happen for example with a source file with a huge
242 number of lines. The only cure is to use a different debug
243 format, probably DWARF. */
244 as_warn (_(".stab%c: description field '%x' too big, try a different debug format"),
247 if (what
== 's' || what
== 'n')
249 if (*input_line_pointer
!= ',')
251 as_warn (_(".stab%c: missing comma"), what
);
252 ignore_rest_of_line ();
255 input_line_pointer
++;
261 /* Solaris on PowerPC has decided that .stabd can take 4 arguments, so if we were
262 given 4 arguments, make it a .stabn */
263 else if (what
== 'd')
265 char *save_location
= input_line_pointer
;
268 if (*input_line_pointer
== ',')
270 input_line_pointer
++;
274 input_line_pointer
= save_location
;
285 listing_source_line ((unsigned int) desc
);
289 listing_source_file (string
);
293 #endif /* ! NO_LISTING */
295 /* We have now gathered the type, other, and desc information. For
296 .stabs or .stabn, input_line_pointer is now pointing at the
299 if (SEPARATE_STAB_SECTIONS
)
300 /* Output the stab information in a separate section. This is used
301 at least for COFF and ELF. */
303 segT saved_seg
= now_seg
;
304 subsegT saved_subseg
= now_subseg
;
305 fragS
*saved_frag
= frag_now
;
311 static segT cached_sec
;
312 static char *cached_secname
;
314 dot
= frag_now_fix ();
316 #ifdef md_flush_pending_output
317 md_flush_pending_output ();
320 if (cached_secname
&& !strcmp (cached_secname
, stab_secname
))
327 seg
= subseg_new (stab_secname
, 0);
329 free (cached_secname
);
330 cached_secname
= xstrdup (stab_secname
);
334 if (! seg_info (seg
)->hadone
)
336 bfd_set_section_flags (stdoutput
, seg
,
337 SEC_READONLY
| SEC_RELOC
| SEC_DEBUGGING
);
338 #ifdef INIT_STAB_SECTION
339 INIT_STAB_SECTION (seg
);
341 seg_info (seg
)->hadone
= 1;
344 stroff
= get_stab_string_offset (string
, stabstr_secname
);
347 /* Release the string, if nobody else has used the obstack. */
348 if (saved_string_obstack_end
== notes
.next_free
)
349 obstack_free (¬es
, string
);
352 /* At least for now, stabs in a special stab section are always
353 output as 12 byte blocks of information. */
355 md_number_to_chars (p
, (valueT
) stroff
, 4);
356 md_number_to_chars (p
+ 4, (valueT
) type
, 1);
357 md_number_to_chars (p
+ 5, (valueT
) other
, 1);
358 md_number_to_chars (p
+ 6, (valueT
) desc
, 2);
360 if (what
== 's' || what
== 'n')
362 /* Pick up the value from the input line. */
364 input_line_pointer
--;
371 /* Arrange for a value representing the current location. */
372 symbol
= symbol_temp_new (saved_seg
, dot
, saved_frag
);
375 exp
.X_add_symbol
= symbol
;
376 exp
.X_add_number
= 0;
381 #ifdef OBJ_PROCESS_STAB
382 OBJ_PROCESS_STAB (seg
, what
, string
, type
, other
, desc
);
385 subseg_set (saved_seg
, saved_subseg
);
389 #ifdef OBJ_PROCESS_STAB
390 OBJ_PROCESS_STAB (0, what
, string
, type
, other
, desc
);
396 demand_empty_rest_of_line ();
399 /* Regular stab directive. */
404 s_stab_generic (what
, STAB_SECTION_NAME
, STAB_STRING_SECTION_NAME
);
407 /* "Extended stabs", used in Solaris only now. */
413 char *stab_secname
, *stabstr_secname
;
414 static char *saved_secname
, *saved_strsecname
;
416 /* @@ MEMORY LEAK: This allocates a copy of the string, but in most
417 cases it will be the same string, so we could release the storage
418 back to the obstack it came from. */
419 stab_secname
= demand_copy_C_string (&length
);
421 if (*input_line_pointer
== ',')
422 input_line_pointer
++;
425 as_bad (_("comma missing in .xstabs"));
426 ignore_rest_of_line ();
430 /* To get the name of the stab string section, simply add "str" to
431 the stab section name. */
432 if (saved_secname
== 0 || strcmp (saved_secname
, stab_secname
))
434 stabstr_secname
= (char *) xmalloc (strlen (stab_secname
) + 4);
435 strcpy (stabstr_secname
, stab_secname
);
436 strcat (stabstr_secname
, "str");
439 free (saved_secname
);
440 free (saved_strsecname
);
442 saved_secname
= stab_secname
;
443 saved_strsecname
= stabstr_secname
;
445 s_stab_generic (what
, saved_secname
, saved_strsecname
);
450 /* Frob invented at RMS' request. Set the n_desc of a symbol. */
454 int ignore ATTRIBUTE_UNUSED
;
462 c
= get_symbol_name (&name
);
463 p
= input_line_pointer
;
465 SKIP_WHITESPACE_AFTER_NAME ();
466 if (*input_line_pointer
!= ',')
469 as_bad (_("expected comma after \"%s\""), name
);
471 ignore_rest_of_line ();
475 input_line_pointer
++;
476 temp
= get_absolute_expression ();
478 symbolP
= symbol_find_or_make (name
);
480 S_SET_DESC (symbolP
, temp
);
482 demand_empty_rest_of_line ();
485 #endif /* defined (S_SET_DESC) */
487 /* Generate stabs debugging information to denote the main source file. */
490 stabs_generate_asm_file (void)
495 as_where (&file
, &lineno
);
496 if (use_gnu_debug_info_extensions
)
501 dir
= remap_debug_filename (getpwd ());
502 dir2
= (char *) alloca (strlen (dir
) + 2);
503 sprintf (dir2
, "%s%s", dir
, "/");
504 generate_asm_file (N_SO
, dir2
);
505 xfree ((char *) dir
);
507 generate_asm_file (N_SO
, file
);
510 /* Generate stabs debugging information to denote the source file.
511 TYPE is one of N_SO, N_SOL. */
514 generate_asm_file (int type
, char *file
)
516 static char *last_file
;
517 static int label_count
;
522 char *file_endp
= file
+ strlen (file
);
525 if (last_file
!= NULL
526 && filename_cmp (last_file
, file
) == 0)
529 /* Rather than try to do this in some efficient fashion, we just
530 generate a string and then parse it again. That lets us use the
531 existing stabs hook, which expect to see a string, rather than
532 inventing new ones. */
533 hold
= input_line_pointer
;
535 sprintf (sym
, "%sF%d", FAKE_LABEL_NAME
, label_count
);
538 /* Allocate enough space for the file name (possibly extended with
539 doubled up backslashes), the symbol name, and the other characters
540 that make up a stabs file directive. */
541 bufp
= buf
= (char *) xmalloc (2 * strlen (file
) + strlen (sym
) + 12);
545 while (tmp
< file_endp
)
547 char *bslash
= strchr (tmp
, '\\');
548 size_t len
= (bslash
) ? (size_t) (bslash
- tmp
+ 1) : strlen (tmp
);
550 /* Double all backslashes, since demand_copy_C_string (used by
551 s_stab to extract the part in quotes) will try to replace them as
552 escape sequences. backslash may appear in a filespec. */
553 strncpy (bufp
, tmp
, len
);
562 sprintf (bufp
, "\",%d,0,0,%s\n", type
, sym
);
564 input_line_pointer
= buf
;
568 if (last_file
!= NULL
)
570 last_file
= xstrdup (file
);
574 input_line_pointer
= hold
;
577 /* Generate stabs debugging information for the current line. This is
578 used to produce debugging information for an assembler file. */
581 stabs_generate_asm_lineno (void)
583 static int label_count
;
589 /* Remember the last file/line and avoid duplicates. */
590 static unsigned int prev_lineno
= -1;
591 static char *prev_file
= NULL
;
593 /* Rather than try to do this in some efficient fashion, we just
594 generate a string and then parse it again. That lets us use the
595 existing stabs hook, which expect to see a string, rather than
596 inventing new ones. */
598 hold
= input_line_pointer
;
600 as_where (&file
, &lineno
);
602 /* Don't emit sequences of stabs for the same line. */
603 if (prev_file
== NULL
)
605 /* First time thru. */
606 prev_file
= xstrdup (file
);
607 prev_lineno
= lineno
;
609 else if (lineno
== prev_lineno
610 && filename_cmp (file
, prev_file
) == 0)
612 /* Same file/line as last time. */
617 /* Remember file/line for next time. */
618 prev_lineno
= lineno
;
619 if (filename_cmp (file
, prev_file
) != 0)
622 prev_file
= xstrdup (file
);
626 /* Let the world know that we are in the middle of generating a
627 piece of stabs line debugging information. */
628 outputting_stabs_line_debug
= 1;
630 generate_asm_file (N_SOL
, file
);
632 sprintf (sym
, "%sL%d", FAKE_LABEL_NAME
, label_count
);
637 buf
= (char *) alloca (100 + strlen (current_function_label
));
638 sprintf (buf
, "%d,0,%d,%s-%s\n", N_SLINE
, lineno
,
639 sym
, current_function_label
);
643 buf
= (char *) alloca (100);
644 sprintf (buf
, "%d,0,%d,%s\n", N_SLINE
, lineno
, sym
);
646 input_line_pointer
= buf
;
650 input_line_pointer
= hold
;
651 outputting_stabs_line_debug
= 0;
654 /* Emit a function stab.
655 All assembler functions are assumed to have return type `void'. */
658 stabs_generate_asm_func (const char *funcname
, const char *startlabname
)
660 static int void_emitted_p
;
661 char *hold
= input_line_pointer
;
666 if (! void_emitted_p
)
668 input_line_pointer
= "\"void:t1=1\",128,0,0,0";
673 as_where (&file
, &lineno
);
674 if (asprintf (&buf
, "\"%s:F1\",%d,0,%d,%s",
675 funcname
, N_FUN
, lineno
+ 1, startlabname
) == -1)
676 as_fatal ("%s", xstrerror (errno
));
677 input_line_pointer
= buf
;
681 input_line_pointer
= hold
;
682 current_function_label
= xstrdup (startlabname
);
686 /* Emit a stab to record the end of a function. */
689 stabs_generate_asm_endfunc (const char *funcname ATTRIBUTE_UNUSED
,
690 const char *startlabname
)
692 static int label_count
;
693 char *hold
= input_line_pointer
;
697 sprintf (sym
, "%sendfunc%d", FAKE_LABEL_NAME
, label_count
);
701 if (asprintf (&buf
, "\"\",%d,0,0,%s-%s", N_FUN
, sym
, startlabname
) == -1)
702 as_fatal ("%s", xstrerror (errno
));
703 input_line_pointer
= buf
;
707 input_line_pointer
= hold
;
709 current_function_label
= NULL
;