1 /* listing.c - mainting assembly listings
2 Copyright (C) 1991, 92, 93, 94, 95, 96, 97, 1998
3 Free Software Foundation, Inc.
5 This file is part of GAS, the GNU Assembler.
7 GAS is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GAS is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GAS; see the file COPYING. If not, write to the Free
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
23 Contributed by Steve Chamberlain
27 A listing page looks like:
29 LISTING_HEADER sourcefilename pagenumber
32 linenumber address data source
33 linenumber address data source
34 linenumber address data source
35 linenumber address data source
37 If not overridden, the listing commands are:
40 Put "stuff" onto the title line
42 Put stuff onto the subtitle line
44 If these commands come within 10 lines of the top of the page, they
45 will affect the page they are on, as well as any subsequent page
50 Increment the enable listing counter
52 Decrement the enable listing counter
55 Set the paper size to X wide and Y high. Setting a psize Y of
56 zero will suppress form feeds except where demanded by .eject
58 If the counter goes below zero, listing is suppressed.
61 Listings are a maintained by read calling various listing_<foo>
62 functions. What happens most is that the macro NO_LISTING is not
63 defined (from the Makefile), then the macro LISTING_NEWLINE expands
64 into a call to listing_newline. The call is done from read.c, every
65 time it sees a newline, and -l is on the command line.
67 The function listing_newline remembers the frag associated with the
68 newline, and creates a new frag - note that this is wasteful, but not
69 a big deal, since listing slows things down a lot anyway. The
70 function also rememebers when the filename changes.
72 When all the input has finished, and gas has had a chance to settle
73 down, the listing is output. This is done by running down the list of
74 frag/source file records, and opening the files as needed and printing
75 out the bytes and chars associated with them.
77 The only things which the architecture can change about the listing
78 are defined in these macros:
80 LISTING_HEADER The name of the architecture
81 LISTING_WORD_SIZE The make of the number of bytes in a word, this determines
82 the clumping of the output data. eg a value of
83 2 makes words look like 1234 5678, whilst 1
84 would make the same value look like 12 34 56
86 LISTING_LHS_WIDTH Number of words of above size for the lhs
88 LISTING_LHS_WIDTH_SECOND Number of words for the data on the lhs
91 LISTING_LHS_CONT_LINES Max number of lines to use up for a continutation
92 LISTING_RHS_WIDTH Number of chars from the input file to print
100 #include "input-file.h"
105 #ifndef LISTING_HEADER
106 #define LISTING_HEADER "GAS LISTING"
108 #ifndef LISTING_WORD_SIZE
109 #define LISTING_WORD_SIZE 4
111 #ifndef LISTING_LHS_WIDTH
112 #define LISTING_LHS_WIDTH 1
114 #ifndef LISTING_LHS_WIDTH_SECOND
115 #define LISTING_LHS_WIDTH_SECOND 1
117 #ifndef LISTING_RHS_WIDTH
118 #define LISTING_RHS_WIDTH 100
120 #ifndef LISTING_LHS_CONT_LINES
121 #define LISTING_LHS_CONT_LINES 4
124 /* This structure remembers which .s were used */
125 typedef struct file_info_struct
127 struct file_info_struct * next;
130 unsigned int linenum;
135 /* This structure rememebrs which line from which file goes into which
137 struct list_info_struct
139 /* Frag which this line of source is nearest to */
142 /* The actual line in the source file */
144 /* Pointer to the file info struct for the file which this line
146 file_info_type * file;
148 /* The expanded text of any macro that may have been executing. */
149 char * line_contents;
152 struct list_info_struct * next;
154 /* Pointer to the file info struct for the high level language
155 source line that belongs here */
156 file_info_type * hll_file;
157 /* High level language source line */
158 unsigned int hll_line;
160 /* Pointer to any error message associated with this line */
175 /* Nonzero if this line is to be omitted because it contains
176 debugging information. This can become a flags field if we come
177 up with more information to store here. */
181 typedef struct list_info_struct list_info_type;
184 int listing_lhs_width = LISTING_LHS_WIDTH;
185 int listing_lhs_width_second = LISTING_LHS_WIDTH_SECOND;
186 int listing_lhs_cont_lines = LISTING_LHS_CONT_LINES;
187 int listing_rhs_width = LISTING_RHS_WIDTH;
189 struct list_info_struct * listing_tail;
191 static file_info_type * file_info_head;
192 static file_info_type * last_open_file_info;
193 static FILE * last_open_file;
194 static struct list_info_struct * head;
195 static int paper_width = 200;
196 static int paper_height = 60;
200 /* File to output listings to. */
201 static FILE * list_file;
203 /* This static array is used to keep the text of data to be printed
204 before the start of the line. */
207 (((LISTING_WORD_SIZE * 2) + 1) * listing_lhs_width \
208 + ((((LISTING_WORD_SIZE * 2) + 1) * listing_lhs_width_second) \
209 * listing_lhs_cont_lines) \
212 static char * data_buffer;
215 static void listing_message PARAMS ((const char *name, const char *message));
216 static file_info_type * file_info PARAMS ((const char *file_name));
217 static void new_frag PARAMS ((void));
218 static char * buffer_line PARAMS ((file_info_type *file,
219 char *line, unsigned int size));
220 static void listing_page PARAMS ((list_info_type *list));
221 static unsigned int calc_hex PARAMS ((list_info_type *list));
222 static void print_lines PARAMS ((list_info_type *, unsigned int,
223 char *, unsigned int));
224 static void list_symbol_table PARAMS ((void));
225 static void print_source PARAMS ((file_info_type *current_file,
226 list_info_type *list,
228 unsigned int width));
229 static int debugging_pseudo PARAMS ((list_info_type *, const char *));
230 static void listing_listing PARAMS ((char *name));
234 listing_message (name, message)
238 unsigned int l = strlen (name) + strlen (message) + 1;
239 char *n = (char *) xmalloc (l);
242 if (listing_tail != (list_info_type *) NULL)
244 listing_tail->message = n;
249 listing_warning (message)
252 listing_message (_("Warning:"), message);
256 listing_error (message)
259 listing_message (_("Error:"), message);
262 static file_info_type *
263 file_info (file_name)
264 const char *file_name;
266 /* Find an entry with this file name */
267 file_info_type *p = file_info_head;
269 while (p != (file_info_type *) NULL)
271 if (strcmp (p->filename, file_name) == 0)
278 p = (file_info_type *) xmalloc (sizeof (file_info_type));
279 p->next = file_info_head;
281 p->filename = xmalloc ((unsigned long) strlen (file_name) + 1);
282 strcpy (p->filename, file_name);
295 frag_wane (frag_now);
306 static unsigned int last_line = 0xffff;
307 static char *last_file = NULL;
308 list_info_type *new = NULL;
313 if (now_seg == absolute_section)
317 /* In ELF, anything in a section beginning with .debug or .line is
318 considered to be debugging information. This includes the
319 statement which switches us into the debugging section, which we
320 can only set after we are already in the debugging section. */
321 if ((listing & LISTING_NODEBUG) != 0
322 && listing_tail != NULL
323 && ! listing_tail->debugging)
327 segname = segment_name (now_seg);
328 if (strncmp (segname, ".debug", sizeof ".debug" - 1) == 0
329 || strncmp (segname, ".line", sizeof ".line" - 1) == 0)
330 listing_tail->debugging = 1;
334 as_where (&file, &line);
337 if (line == last_line && !(last_file && file && strcmp (file, last_file)))
340 new = (list_info_type *) xmalloc (sizeof (list_info_type));
342 /* Detect if we are reading from stdin by examining the file
343 name returned by as_where().
345 [FIXME: We rely upon the name in the strcmp below being the
346 same as the one used by input_scrub_new_file(), if that is
347 not true, then this code will fail].
349 If we are reading from stdin, then we need to save each input line
350 here (assuming of course that we actually have a line of input to read),
351 so that it can be displayed in the listing that is produced at the end
353 if (strcmp (file, _("{standard input}")) == 0
354 && input_line_pointer != NULL)
359 for (copy = input_line_pointer - 1;
360 * copy && ! is_end_of_line [* copy];
364 len = (copy - input_line_pointer) + 2;
366 copy = xmalloc (len);
370 char * src = input_line_pointer - 1;
377 /* Omit control characters in the listing. */
378 if (isascii (c) && ! iscntrl (c))
385 new->line_contents = copy;
388 new->line_contents = NULL;
392 new = (list_info_type *) xmalloc (sizeof (list_info_type));
393 new->line_contents = ps;
402 listing_tail->next = new;
408 new->frag = frag_now;
410 new->file = file_info (file);
411 new->next = (list_info_type *) NULL;
412 new->message = (char *) NULL;
413 new->edict = EDICT_NONE;
414 new->hll_file = (file_info_type *) NULL;
421 /* In ELF, anything in a section beginning with .debug or .line is
422 considered to be debugging information. */
423 if ((listing & LISTING_NODEBUG) != 0)
427 segname = segment_name (now_seg);
428 if (strncmp (segname, ".debug", sizeof ".debug" - 1) == 0
429 || strncmp (segname, ".line", sizeof ".line" - 1) == 0)
435 /* Attach all current frags to the previous line instead of the
436 current line. This is called by the MIPS backend when it discovers
437 that it needs to add some NOP instructions; the added NOP
438 instructions should go with the instruction that has the delay, not
439 with the new instruction. */
447 if (head == (list_info_type *) NULL
448 || head == listing_tail)
453 for (l = head; l->next != listing_tail; l = l->next)
456 for (f = frchain_now->frch_root; f != (fragS *) NULL; f = f->fr_next)
457 if (f->line == listing_tail)
460 listing_tail->frag = frag_now;
465 This function returns the next source line from the file supplied,
466 truncated to size. It appends a fake line to the end of each input
471 buffer_line (file, line, size)
472 file_info_type * file;
476 unsigned int count = 0;
481 /* If we couldn't open the file, return an empty line */
485 /* Check the cache and see if we last used this file. */
486 if (!last_open_file_info || file != last_open_file_info)
490 last_open_file_info->pos = ftell (last_open_file);
491 fclose (last_open_file);
494 last_open_file_info = file;
495 last_open_file = fopen (file->filename, "r");
496 if (last_open_file == NULL)
502 /* Seek to where we were last time this file was open. */
504 fseek(last_open_file, file->pos, SEEK_SET);
507 c = fgetc (last_open_file);
509 size -= 1; /* leave room for null */
511 while (c != EOF && c != '\n')
517 c = fgetc (last_open_file);
533 static const char *fn;
535 static unsigned int eject; /* Eject pending */
536 static unsigned int page; /* Current page number */
537 static char *title; /* current title */
538 static char *subtitle; /* current subtitle */
539 static unsigned int on_page; /* number of lines printed on current page */
544 list_info_type *list;
546 /* Grope around, see if we can see a title or subtitle edict coming up
547 soon (we look down 10 lines of the page and see if it's there)*/
548 if ((eject || (on_page >= (unsigned int) paper_height)) && paper_height != 0)
552 int had_subtitle = 0;
556 while (c != 0 && list)
558 if (list->edict == EDICT_SBTTL && !had_subtitle)
561 subtitle = list->edict_arg;
563 if (list->edict == EDICT_TITLE && !had_title)
566 title = list->edict_arg;
575 fprintf (list_file, "\f");
578 fprintf (list_file, "%s %s \t\t\tpage %d\n", LISTING_HEADER, fn, page);
579 fprintf (list_file, "%s\n", title);
580 fprintf (list_file, "%s\n", subtitle);
589 list_info_type * list;
591 int data_buffer_size;
592 list_info_type *first = list;
593 unsigned int address = ~ (unsigned int) 0;
596 unsigned int byte_in_frag;
598 /* Find first frag which says it belongs to this line */
600 while (frag && frag->line != list)
601 frag = frag->fr_next;
605 data_buffer_size = 0;
607 /* Dump all the frags which belong to this line */
608 while (frag_ptr != (fragS *) NULL && frag_ptr->line == first)
610 /* Print as many bytes from the fixed part as is sensible */
612 while ((offsetT) byte_in_frag < frag_ptr->fr_fix
613 && data_buffer_size < MAX_BYTES - 3)
615 if (address == ~ (unsigned int) 0)
617 address = frag_ptr->fr_address;
620 sprintf (data_buffer + data_buffer_size,
622 (frag_ptr->fr_literal[byte_in_frag]) & 0xff);
623 data_buffer_size += 2;
627 unsigned int var_rep_max = byte_in_frag;
628 unsigned int var_rep_idx = byte_in_frag;
630 /* Print as many bytes from the variable part as is sensible */
631 while (((offsetT) byte_in_frag
632 < frag_ptr->fr_fix + frag_ptr->fr_var * frag_ptr->fr_offset)
633 && data_buffer_size < MAX_BYTES - 3)
635 if (address == ~ (unsigned int) 0)
637 address = frag_ptr->fr_address;
639 sprintf (data_buffer + data_buffer_size,
641 (frag_ptr->fr_literal[var_rep_idx]) & 0xff);
643 data_buffer[data_buffer_size++] = '*';
644 data_buffer[data_buffer_size++] = '*';
646 data_buffer_size += 2;
651 if ((offsetT) var_rep_idx >= frag_ptr->fr_fix + frag_ptr->fr_var)
652 var_rep_idx = var_rep_max;
656 frag_ptr = frag_ptr->fr_next;
658 data_buffer[data_buffer_size] = '\0';
668 print_lines (list, lineno, string, address)
669 list_info_type *list;
672 unsigned int address;
677 unsigned int byte_in_word = 0;
678 char *src = data_buffer;
680 /* Print the stuff on the first line */
682 nchars = (LISTING_WORD_SIZE * 2 + 1) * listing_lhs_width;
684 /* Print the hex for the first line */
685 if (address == ~ (unsigned int) 0)
687 fprintf (list_file, "% 4d ", lineno);
688 for (idx = 0; idx < nchars; idx++)
689 fprintf (list_file, " ");
691 fprintf (list_file, "\t%s\n", string ? string : "");
701 fprintf (list_file, "% 4d ???? ", lineno);
703 fprintf (list_file, "% 4d %04x ", lineno, address);
705 /* And the data to go along with it */
708 while (*src && idx < nchars)
710 fprintf (list_file, "%c%c", src[0], src[1]);
714 if (byte_in_word == LISTING_WORD_SIZE)
716 fprintf (list_file, " ");
724 for (; idx < nchars; idx++)
725 fprintf (list_file, " ");
727 fprintf (list_file, "\t%s\n", string ? string : "");
733 fprintf (list_file, "**** %s\n", list->message);
739 lines < (unsigned int) listing_lhs_cont_lines
743 nchars = ((LISTING_WORD_SIZE * 2) + 1)
744 * listing_lhs_width_second - 1;
747 /* Print any more lines of data, but more compactly */
748 fprintf (list_file, "% 4d ", lineno);
750 while (*src && idx < nchars)
752 fprintf (list_file, "%c%c", src[0], src[1]);
757 if (byte_in_word == LISTING_WORD_SIZE)
759 fprintf (list_file, " ");
765 fprintf (list_file, "\n");
775 extern symbolS *symbol_rootP;
782 for (ptr = symbol_rootP; ptr != (symbolS *) NULL; ptr = symbol_next (ptr))
784 if (SEG_NORMAL (S_GET_SEGMENT (ptr))
785 || S_GET_SEGMENT (ptr) == absolute_section)
788 /* Don't report section symbols. They are not interesting. */
789 if (ptr->bsym->flags & BSF_SECTION_SYM)
792 if (S_GET_NAME (ptr))
794 char buf[30], fmt[8];
795 valueT val = S_GET_VALUE (ptr);
797 /* @@ Note that this is dependent on the compilation options,
798 not solely on the target characteristics. */
799 if (sizeof (val) == 4 && sizeof (int) == 4)
800 sprintf (buf, "%08lx", (unsigned long) val);
801 else if (sizeof (val) <= sizeof (unsigned long))
803 sprintf (fmt, "%%0%lulx",
804 (unsigned long) (sizeof (val) * 2));
805 sprintf (buf, fmt, (unsigned long) val);
808 else if (sizeof (val) > 4)
809 sprintf_vma (buf, val);
816 fprintf (list_file, "DEFINED SYMBOLS\n");
821 if (ptr->sy_frag && ptr->sy_frag->line)
823 fprintf (list_file, "%20s:%-5d %s:%s %s\n",
824 ptr->sy_frag->line->file->filename,
825 ptr->sy_frag->line->line,
826 segment_name (S_GET_SEGMENT (ptr)),
827 buf, S_GET_NAME (ptr));
831 fprintf (list_file, "%33s:%s %s\n",
832 segment_name (S_GET_SEGMENT (ptr)),
833 buf, S_GET_NAME (ptr));
844 fprintf (list_file, "NO DEFINED SYMBOLS\n");
847 fprintf (list_file, "\n");
853 for (ptr = symbol_rootP; ptr != (symbolS *) NULL; ptr = symbol_next (ptr))
855 if (S_GET_NAME (ptr) && strlen (S_GET_NAME (ptr)) != 0)
857 if (S_GET_SEGMENT (ptr) == undefined_section)
862 fprintf (list_file, "UNDEFINED SYMBOLS\n");
866 fprintf (list_file, "%s\n", S_GET_NAME (ptr));
874 fprintf (list_file, "NO UNDEFINED SYMBOLS\n");
881 print_source (current_file, list, buffer, width)
882 file_info_type *current_file;
883 list_info_type *list;
887 if (!current_file->at_end)
889 while (current_file->linenum < list->hll_line
890 && !current_file->at_end)
892 char *p = buffer_line (current_file, buffer, width);
893 fprintf (list_file, "%4u:%-13s **** %s\n", current_file->linenum,
894 current_file->filename, p);
901 /* Sometimes the user doesn't want to be bothered by the debugging
902 records inserted by the compiler, see if the line is suspicious. */
905 debugging_pseudo (list, line)
906 list_info_type *list;
918 was_debug = in_debug;
921 while (isspace ((unsigned char) *line))
927 /* The ELF compiler sometimes emits blank lines after switching
928 out of a debugging section. If the next line drops us back
929 into debugging information, then don't print the blank line.
930 This is a hack for a particular compiler behaviour, not a
934 && list->next != NULL
935 && list->next->debugging)
947 if (strncmp (line, "def", 3) == 0)
949 if (strncmp (line, "val", 3) == 0)
951 if (strncmp (line, "scl", 3) == 0)
953 if (strncmp (line, "line", 4) == 0)
955 if (strncmp (line, "endef", 5) == 0)
957 if (strncmp (line, "ln", 2) == 0)
959 if (strncmp (line, "type", 4) == 0)
961 if (strncmp (line, "size", 4) == 0)
963 if (strncmp (line, "dim", 3) == 0)
965 if (strncmp (line, "tag", 3) == 0)
968 if (strncmp (line, "stabs", 5) == 0)
970 if (strncmp (line, "stabn", 5) == 0)
977 listing_listing (name)
980 list_info_type *list = head;
981 file_info_type *current_hll_file = (file_info_type *) NULL;
985 int show_listing = 1;
988 buffer = xmalloc (listing_rhs_width);
989 data_buffer = xmalloc (MAX_BYTES);
993 while (list != (list_info_type *) NULL && 0)
996 list->frag = list->next->frag;
1008 width = listing_rhs_width > paper_width ? paper_width :
1011 list_line = list->line;
1012 switch (list->edict)
1015 /* Skip all lines up to the current. */
1021 case EDICT_NOLIST_NEXT:
1028 title = list->edict_arg;
1031 subtitle = list->edict_arg;
1037 if (show_listing <= 0)
1039 while (list->file->linenum < list_line
1040 && !list->file->at_end)
1041 p = buffer_line (list->file, buffer, width);
1044 if (list->edict == EDICT_LIST)
1046 /* Enable listing for the single line that caused the enable. */
1051 if (show_listing > 0)
1053 /* Scan down the list and print all the stuff which can be done
1054 with this line (or lines). */
1059 current_hll_file = list->hll_file;
1062 if (current_hll_file && list->hll_line && (listing & LISTING_HLL))
1064 print_source (current_hll_file, list, buffer, width);
1067 if (list->line_contents)
1069 if (!((listing & LISTING_NODEBUG)
1070 && debugging_pseudo (list, list->line_contents)))
1073 list->file->linenum == 0 ? list->line : list->file->linenum,
1074 list->line_contents, calc_hex (list));
1076 free (list->line_contents);
1077 list->line_contents = NULL;
1081 while (list->file->linenum < list_line
1082 && !list->file->at_end)
1084 unsigned int address;
1086 p = buffer_line (list->file, buffer, width);
1088 if (list->file->linenum < list_line)
1089 address = ~ (unsigned int) 0;
1091 address = calc_hex (list);
1093 if (!((listing & LISTING_NODEBUG)
1094 && debugging_pseudo (list, p)))
1095 print_lines (list, list->file->linenum, p, address);
1099 if (list->edict == EDICT_EJECT)
1105 if (list->edict == EDICT_NOLIST_NEXT)
1117 listing_print (name)
1132 list_file = fopen (name, "w");
1133 if (list_file != NULL)
1137 as_perror (_("can't open list file: %s"), name);
1143 if (listing & LISTING_NOFORM)
1148 if (listing & LISTING_LISTING)
1150 listing_listing (name);
1153 if (listing & LISTING_SYMBOLS)
1155 list_symbol_table ();
1160 if (fclose (list_file) == EOF)
1161 as_perror (_("error closing list file: %s"), name);
1166 fclose (last_open_file);
1179 listing_eject (ignore)
1183 listing_tail->edict = EDICT_EJECT;
1187 listing_flags (ignore)
1190 while ((*input_line_pointer++) && (*input_line_pointer != '\n'))
1191 input_line_pointer++;
1195 /* Turn listing on or off. An argument of 0 means to turn off
1196 listing. An argument of 1 means to turn on listing. An argument
1197 of 2 means to turn off listing, but as of the next line; that is,
1198 the current line should be listed, but the next line should not. */
1209 if (listing_tail->edict == EDICT_LIST)
1210 listing_tail->edict = EDICT_NONE;
1212 listing_tail->edict = EDICT_NOLIST;
1215 if (listing_tail->edict == EDICT_NOLIST
1216 || listing_tail->edict == EDICT_NOLIST_NEXT)
1217 listing_tail->edict = EDICT_NONE;
1219 listing_tail->edict = EDICT_LIST;
1222 listing_tail->edict = EDICT_NOLIST_NEXT;
1232 listing_psize (width_only)
1237 paper_height = get_absolute_expression ();
1239 if (paper_height < 0 || paper_height > 1000)
1242 as_warn (_("strange paper height, set to no form"));
1245 if (*input_line_pointer != ',')
1247 demand_empty_rest_of_line ();
1251 ++input_line_pointer;
1254 paper_width = get_absolute_expression ();
1256 demand_empty_rest_of_line ();
1260 listing_nopage (ignore)
1267 listing_title (depth)
1273 unsigned int length;
1276 if (*input_line_pointer != '\"')
1281 ++input_line_pointer;
1284 start = input_line_pointer;
1286 while (*input_line_pointer)
1289 ? *input_line_pointer == '\"'
1290 : is_end_of_line[(unsigned char) *input_line_pointer])
1294 length = input_line_pointer - start;
1295 ttl = xmalloc (length + 1);
1296 memcpy (ttl, start, length);
1298 listing_tail->edict = depth ? EDICT_SBTTL : EDICT_TITLE;
1299 listing_tail->edict_arg = ttl;
1302 input_line_pointer++;
1303 demand_empty_rest_of_line ();
1306 else if (*input_line_pointer == '\n')
1308 as_bad (_("New line in title"));
1309 demand_empty_rest_of_line ();
1314 input_line_pointer++;
1322 listing_source_line (line)
1328 listing_tail->hll_line = line;
1334 listing_source_file (file)
1338 listing_tail->hll_file = file_info (file);
1346 /* Dummy functions for when compiled without listing enabled */
1349 listing_flags (ignore)
1363 listing_eject (ignore)
1370 listing_psize (ignore)
1377 listing_nopage (ignore)
1384 listing_title (depth)
1398 listing_newline (name)
1405 listing_source_line (n)
1411 listing_source_file (n)