1 /* listing.c - mainting assembly listings
2 Copyright (C) 1991, 1992 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 published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GAS is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 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
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
21 Contributed by Steve Chamberlain
25 A listing page looks like:
27 LISTING_HEADER sourcefilename pagenumber
30 linenumber address data source
31 linenumber address data source
32 linenumber address data source
33 linenumber address data source
35 If not overridden, the listing commands are:
38 Put "stuff" onto the title line
40 Put stuff onto the subtitle line
42 If these commands come within 10 lines of the top of the page, they
43 will affect the page they are on, as well as any subsequent page
48 Increment the enable listing counter
50 Decrement the enable listing counter
53 Set the paper size to X wide and Y high. Setting a psize Y of
54 zero will suppress form feeds except where demanded by .eject
56 If the counter goes below zero, listing is suppressed.
59 Listings are a maintained by read calling various listing_<foo>
60 functions. What happens most is that the macro NO_LISTING is not
61 defined (from the Makefile), then the macro LISTING_NEWLINE expands
62 into a call to listing_newline. The call is done from read.c, every
63 time it sees a newline, and -l is on the command line.
65 The function listing_newline remembers the frag associated with the
66 newline, and creates a new frag - note that this is wasteful, but not
67 a big deal, since listing slows things down a lot anyway. The
68 function also rememebers when the filename changes.
70 When all the input has finished, and gas has had a chance to settle
71 down, the listing is output. This is done by running down the list of
72 frag/source file records, and opening the files as needed and printing
73 out the bytes and chars associated with them.
75 The only things which the architecture can change about the listing
76 are defined in these macros:
78 LISTING_HEADER The name of the architecture
79 LISTING_WORD_SIZE The make of the number of bytes in a word, this determines
80 the clumping of the output data. eg a value of
81 2 makes words look like 1234 5678, whilst 1
82 would make the same value look like 12 34 56
84 LISTING_LHS_WIDTH Number of words of above size for the lhs
86 LISTING_LHS_WIDTH_SECOND Number of words for the data on the lhs
89 LISTING_LHS_CONT_LINES Max number of lines to use up for a continutation
90 LISTING_RHS_WIDTH Number of chars from the input file to print
101 #include "input-file.h"
102 #include "targ-cpu.h"
107 #ifndef LISTING_HEADER
108 #define LISTING_HEADER "GAS LISTING"
110 #ifndef LISTING_WORD_SIZE
111 #define LISTING_WORD_SIZE 4
113 #ifndef LISTING_LHS_WIDTH
114 #define LISTING_LHS_WIDTH 1
116 #ifndef LISTING_LHS_WIDTH_SECOND
117 #define LISTING_LHS_WIDTH_SECOND 1
119 #ifndef LISTING_RHS_WIDTH
120 #define LISTING_RHS_WIDTH 100
122 #ifndef LISTING_LHS_CONT_LINES
123 #define LISTING_LHS_CONT_LINES 4
129 /* This structure remembers which .s were used */
130 typedef struct file_info_struct
135 struct file_info_struct *next;
141 /* this structure rememebrs which line from which file goes into which
143 typedef struct list_info_struct
145 /* Frag which this line of source is nearest to */
147 /* The actual line in the source file */
149 /* Pointer to the file info struct for the file which this line
151 file_info_type *file;
154 struct list_info_struct *next;
157 /* Pointer to the file info struct for the high level language
158 source line that belongs here */
159 file_info_type *hll_file;
161 /* High level language source line */
165 /* Pointer to any error message associated with this line */
182 static struct list_info_struct *head;
183 struct list_info_struct *listing_tail;
185 extern unsigned int physical_input_line;
186 extern fragS *frag_now;
189 static int paper_width = 200;
190 static int paper_height = 60;
193 /* this static array is used to keep the text of data to be printed
194 before the start of the line.
195 It is stored so we can give a bit more info on the next line. To much, and large
196 initialized arrays will use up lots of paper.
199 static char data_buffer[100];
200 static unsigned int data_buffer_size;
204 DEFUN(listing_message,(name, message),
208 unsigned int l = strlen(name) + strlen(message)+1;
209 char *n = (char*)malloc(l);
212 if(listing_tail != (list_info_type *)NULL)
214 listing_tail->message = n;
223 DEFUN(listing_warning,(message),
226 listing_message("Warning:", message);
230 DEFUN(listing_error,(message),
233 listing_message("Error:", message);
239 static file_info_type *file_info_head;
241 static file_info_type *
242 DEFUN(file_info, (file_name),
245 /* Find an entry with this file name */
246 file_info_type *p = file_info_head;
248 while (p != (file_info_type *)NULL)
250 if (strcmp(p->filename, file_name) == 0)
257 p = (file_info_type *)xmalloc(sizeof(file_info_type));
258 p->next = file_info_head;
260 p->filename = xmalloc(strlen(file_name)+1);
261 strcpy(p->filename, file_name);
265 p->file = fopen(p->filename,"rb");
266 if (p->file) fgetc(p->file);
285 DEFUN(listing_newline,(ps),
289 extern char *file_name;
290 static unsigned int last_line =0xffff ;
294 if (physical_input_line != last_line)
296 last_line = physical_input_line;
299 new = (list_info_type *)malloc(sizeof(list_info_type));
300 new->frag = frag_now;
301 new->line = physical_input_line ;
302 new->file = file_info(file_name);
306 listing_tail->next = new;
313 new->next = (list_info_type *)NULL;
314 new->message = (char *)NULL;
315 new->edict = EDICT_NONE;
316 new->hll_file = (file_info_type*)NULL;
324 This function returns the next source line from the file supplied,
325 truncated to size. It appends a fake line to the end of each input
330 DEFUN(buffer_line,(file, line, size),
331 file_info_type *file AND
335 unsigned int count = 0;
340 /* If we couldn't open the file, return an empty line */
341 if (file->file == (FILE*)NULL)
346 if (file->end_pending == 10) {
348 fseek(file->file, 0,0 );
350 file->end_pending = 0;
352 c = fgetc(file->file);
355 size -= 1; /* leave room for null */
357 while (c != EOF && c != '\n')
363 c= fgetc(file->file);
368 file->end_pending ++;
381 static unsigned int eject; /* Eject pending */
382 static unsigned int page; /* Current page number */
383 static char *title; /* current title */
384 static char *subtitle; /* current subtitle */
385 static unsigned int on_page; /* number of lines printed on current page */
389 DEFUN(listing_page,(list),
390 list_info_type *list)
392 /* Grope around, see if we can see a title or subtitle edict coming up
393 soon (we look down 10 lines of the page and see if it's there)*/
394 if ((eject || (on_page >= paper_height)) && paper_height != 0)
398 int had_subtitle = 0;
402 while (c != 0 && list)
404 if (list->edict == EDICT_SBTTL && !had_subtitle)
407 subtitle = list->edict_arg;
409 if (list->edict == EDICT_TITLE && !had_title)
412 title = list->edict_arg;
424 printf("%s %s \t\t\tpage %d\n", LISTING_HEADER, fn, page);
425 printf("%s\n", title);
426 printf("%s\n", subtitle);
434 DEFUN(calc_hex,(list),
435 list_info_type *list)
437 list_info_type *first = list;
438 list_info_type *last = first;
439 unsigned int address = ~0;
444 unsigned int byte_in_frag = 0;
448 /* Find first frag which says it belongs to this line */
450 while (frag && frag->line != list)
451 frag = frag->fr_next;
455 data_buffer_size = 0;
457 /* Dump all the frags which belong to this line */
458 while (frag_ptr != (fragS *)NULL && frag_ptr->line == first)
460 /* Print as many bytes from the fixed part as is sensible */
461 while(byte_in_frag < frag_ptr->fr_fix && data_buffer_size < sizeof(data_buffer)-10)
465 address = frag_ptr->fr_address;
468 sprintf(data_buffer + data_buffer_size,
470 (frag_ptr->fr_literal[byte_in_frag]) & 0xff);
471 data_buffer_size += 2;
475 unsigned int var_rep_max = byte_in_frag;
476 unsigned int var_rep_idx = byte_in_frag;
478 /* Print as many bytes from the variable part as is sensible */
479 while (byte_in_frag < frag_ptr->fr_var * frag_ptr->fr_offset
480 && data_buffer_size < sizeof(data_buffer)-10)
484 address = frag_ptr->fr_address;
486 sprintf(data_buffer + data_buffer_size,
488 (frag_ptr->fr_literal[var_rep_idx]) & 0xff);
490 data_buffer[data_buffer_size++] = '*';
491 data_buffer[data_buffer_size++] = '*';
493 data_buffer_size +=2;
498 if (var_rep_idx >= frag_ptr->fr_var)
499 var_rep_idx = var_rep_max;
503 frag_ptr = frag_ptr->fr_next;
505 data_buffer[data_buffer_size++] = 0;
515 DEFUN(print_lines,(list, string, address),
516 list_info_type *list AND
518 unsigned int address)
523 unsigned int byte_in_word =0;
524 char *src = data_buffer;
526 /* Print the stuff on the first line */
528 nchars = (LISTING_WORD_SIZE*2 +1) * LISTING_LHS_WIDTH ;
529 /* Print the hex for the first line */
532 printf("% 4d ", list->line);
533 for (idx = 0; idx < nchars; idx++)
536 printf("\t%s\n", string ? string : "");
545 printf("% 4d ???? ", list->line);
549 printf("% 4d %04x ", list->line, address);
552 /* And the data to go along with it */
555 while (*src && idx < nchars)
557 printf("%c%c", src[0], src[1]);
560 if (byte_in_word == LISTING_WORD_SIZE)
569 for (;idx < nchars; idx++)
572 printf("\t%s\n", string ? string : "");
577 printf("**** %s\n",list->message);
583 lines < LISTING_LHS_CONT_LINES
586 nchars = ((LISTING_WORD_SIZE*2) +1) * LISTING_LHS_WIDTH_SECOND -1;
588 /* Print any more lines of data, but more compactly */
589 printf("% 4d ", list->line);
591 while (*src && idx < nchars)
593 printf("%c%c", src[0], src[1]);
597 if (byte_in_word == LISTING_WORD_SIZE)
621 DEFUN_VOID(list_symbol_table)
623 extern symbolS *symbol_rootP;
628 printf("DEFINED SYMBOLS\n");
631 for (ptr = symbol_rootP; ptr != (symbolS*)NULL; ptr = symbol_next(ptr))
633 if (ptr->sy_frag->line)
638 if (strlen(S_GET_NAME(ptr)))
640 printf("%20s:%-5d %2d:%08x %s \n",
641 ptr->sy_frag->line->file->filename,
642 ptr->sy_frag->line->line,
650 printf("%20s:%-5d %2d:%08x\n",
651 ptr->sy_frag->line->file->filename,
652 ptr->sy_frag->line->line,
668 printf("UNDEFINED SYMBOLS\n");
672 for (ptr = symbol_rootP; ptr != (symbolS*)NULL; ptr = symbol_next(ptr))
674 if (S_GET_NAME(ptr) && strlen(S_GET_NAME(ptr)) != 0)
676 if (ptr->sy_frag->line == 0)
678 printf("%s\n", S_GET_NAME(ptr));
687 DEFUN(print_source,(current_file, list, buffer, width),
688 file_info_type *current_file AND
689 list_info_type *list AND
693 if (current_file->file) {
694 while (current_file->linenum < list->hll_line)
696 char * p = buffer_line(current_file, buffer, width);
697 printf("%4d:%-13s **** %s\n", current_file->linenum, current_file->filename, p);
704 /* Sometimes the user doesn't want to be bothered by the debugging
705 records inserted by the compiler, see if the line is suspicioous */
708 DEFUN(debugging_pseudo,(line),
711 while (isspace(*line))
714 if(*line != '.') return 0;
718 if (strncmp(line, "def",3) == 0) return 1;
719 if (strncmp(line, "val",3) == 0) return 1;
720 if (strncmp(line, "scl",3) == 0) return 1;
721 if (strncmp(line, "line",4) == 0) return 1;
722 if (strncmp(line, "endef",5) == 0) return 1;
723 if (strncmp(line, "ln",2) ==0) return 1;
724 if (strncmp(line, "type",4) ==0) return 1;
725 if (strncmp(line, "size",4) == 0) return 1;
726 if (strncmp(line, "dim",3) ==0) return 1;
727 if (strncmp(line, "tag",3) == 0) return 1;
734 DEFUN(listing_listing,(name),
737 list_info_type *list = head;
738 file_info_type *current_hll_file = (file_info_type *)NULL;
740 unsigned int page= 1;
741 unsigned int prev = 0;
745 unsigned int addr = 0;
747 int show_listing = 1;
750 buffer = malloc(LISTING_RHS_WIDTH);
754 while (list != (list_info_type *)NULL && 0)
757 list->frag = list->next->frag;
767 width = LISTING_RHS_WIDTH > paper_width ? paper_width :
770 switch (list->edict) {
782 title = list->edict_arg;
785 subtitle = list->edict_arg;
791 if (show_listing > 0)
793 /* Scan down the list and print all the stuff which can be done
794 with this line (or lines) */
799 current_hll_file = list->hll_file;
802 if (current_hll_file && list->hll_line && listing & LISTING_HLL)
804 print_source(current_hll_file, list, buffer, width);
807 p = buffer_line(list->file, buffer, width);
809 if (! ((listing & LISTING_NODEBUG) && debugging_pseudo(p)))
811 print_lines(list, p, calc_hex(list));
814 if (list->edict == EDICT_EJECT)
822 p = buffer_line(list->file, buffer, width);
831 DEFUN(listing_print,(name),
837 if (listing & LISTING_NOFORM)
842 if (listing & LISTING_LISTING)
844 listing_listing(name);
847 if (listing & LISTING_SYMBOLS)
855 DEFUN(listing_file,(name),
862 DEFUN_VOID(listing_eject)
864 listing_tail->edict = EDICT_EJECT;
868 DEFUN_VOID(listing_flags)
873 DEFUN(listing_list,(on),
876 listing_tail->edict = on ? EDICT_LIST : EDICT_NOLIST;
881 DEFUN_VOID(listing_psize)
883 paper_height = get_absolute_expression();
885 if (paper_height < 0 || paper_height > 1000)
888 as_warn("strange paper height, set to no form");
890 if (*input_line_pointer == ',')
892 input_line_pointer++;
893 paper_width = get_absolute_expression();
899 DEFUN(listing_title,(depth),
907 if (*input_line_pointer=='\"') {
908 input_line_pointer++;
909 start = input_line_pointer;
911 while (*input_line_pointer)
913 if (*input_line_pointer == '\"')
915 length = input_line_pointer - start;
916 title = malloc(length + 1);
917 memcpy(title, start, length);
919 listing_tail->edict = depth ? EDICT_SBTTL : EDICT_TITLE;
920 listing_tail->edict_arg = title;
921 input_line_pointer++;
922 demand_empty_rest_of_line();
925 else if (*input_line_pointer == '\n')
927 as_bad("New line in title");
928 demand_empty_rest_of_line();
933 input_line_pointer++;
939 as_bad("expecting title in quotes");
946 DEFUN(listing_source_line,(line),
950 listing_tail->hll_line = line;
956 DEFUN(listing_source_file,(file),
959 listing_tail->hll_file = file_info(file);
967 /* Dummy functions for when compiled without listing enabled */
970 DEFUN_VOID(listing_flags)
975 void DEFUN_VOID(listing_list)
980 void DEFUN_VOID(listing_eject)
984 void DEFUN_VOID(listing_psize)
989 void DEFUN(listing_title, (depth),
995 DEFUN(listing_file,(name),
1001 void DEFUN(listing_newline,(name),
1007 void DEFUN(listing_source_line,(n),
1012 void DEFUN(listing_source_file, (n),