2 * Aic7xxx SCSI host adapter firmware assembler symbol table implementation
4 * Copyright (c) 1997 Justin T. Gibbs.
5 * Copyright (c) 2002 Adaptec Inc.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions, and the following disclaimer,
13 * without modification.
14 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
15 * substantially similar to the "NO WARRANTY" disclaimer below
16 * ("Disclaimer") and any redistribution must be conditioned upon
17 * including a substantially similar Disclaimer requirement for further
18 * binary redistribution.
19 * 3. Neither the names of the above-listed copyright holders nor the names
20 * of any contributors may be used to endorse or promote products derived
21 * from this software without specific prior written permission.
23 * Alternatively, this software may be distributed under the terms of the
24 * GNU General Public License ("GPL") version 2 as published by the Free
25 * Software Foundation.
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
36 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
37 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38 * POSSIBILITY OF SUCH DAMAGES.
40 * $Id: //depot/aic7xxx/aic7xxx/aicasm/aicasm_symbol.c#24 $
45 #include <sys/types.h>
56 #include "aicasm_symbol.h"
62 symbol_create(char *name
)
66 new_symbol
= (symbol_t
*)malloc(sizeof(symbol_t
));
67 if (new_symbol
== NULL
) {
68 perror("Unable to create new symbol");
71 memset(new_symbol
, 0, sizeof(*new_symbol
));
72 new_symbol
->name
= strdup(name
);
73 if (new_symbol
->name
== NULL
)
74 stop("Unable to strdup symbol name", EX_SOFTWARE
);
75 new_symbol
->type
= UNINITIALIZED
;
76 new_symbol
->count
= 1;
81 symbol_delete(symbol_t
*symbol
)
83 if (symtable
!= NULL
) {
86 key
.data
= symbol
->name
;
87 key
.size
= strlen(symbol
->name
);
88 symtable
->del(symtable
, &key
, /*flags*/0);
90 switch(symbol
->type
) {
94 if (symbol
->info
.rinfo
!= NULL
)
95 free(symbol
->info
.rinfo
);
98 if (symbol
->info
.ainfo
!= NULL
)
99 free(symbol
->info
.ainfo
);
105 if (symbol
->info
.finfo
!= NULL
) {
106 symlist_free(&symbol
->info
.finfo
->symrefs
);
107 free(symbol
->info
.finfo
);
112 if (symbol
->info
.cinfo
!= NULL
)
113 free(symbol
->info
.cinfo
);
116 if (symbol
->info
.linfo
!= NULL
)
117 free(symbol
->info
.linfo
);
130 symtable
= dbopen(/*filename*/NULL
,
131 O_CREAT
| O_NONBLOCK
| O_RDWR
, /*mode*/0, DB_HASH
,
134 if (symtable
== NULL
) {
135 perror("Symbol table creation failed");
144 if (symtable
!= NULL
) {
148 while (symtable
->seq(symtable
, &key
, &data
, R_FIRST
) == 0) {
149 symbol_t
*stored_ptr
;
151 memcpy(&stored_ptr
, data
.data
, sizeof(stored_ptr
));
152 symbol_delete(stored_ptr
);
154 symtable
->close(symtable
);
159 * The semantics of get is to return an uninitialized symbol entry
163 symtable_get(char *name
)
165 symbol_t
*stored_ptr
;
170 key
.data
= (void *)name
;
171 key
.size
= strlen(name
);
173 if ((retval
= symtable
->get(symtable
, &key
, &data
, /*flags*/0)) != 0) {
175 perror("Symbol table get operation failed");
178 } else if (retval
== 1) {
179 /* Symbol wasn't found, so create a new one */
180 symbol_t
*new_symbol
;
182 new_symbol
= symbol_create(name
);
183 data
.data
= &new_symbol
;
184 data
.size
= sizeof(new_symbol
);
185 if (symtable
->put(symtable
, &key
, &data
,
187 perror("Symtable put failed");
192 perror("Unexpected return value from db get routine");
197 memcpy(&stored_ptr
, data
.data
, sizeof(stored_ptr
));
199 data
.data
= &stored_ptr
;
200 if (symtable
->put(symtable
, &key
, &data
, /*flags*/0) !=0) {
201 perror("Symtable put failed");
208 symlist_search(symlist_t
*symlist
, char *symname
)
210 symbol_node_t
*curnode
;
212 curnode
= SLIST_FIRST(symlist
);
213 while(curnode
!= NULL
) {
214 if (strcmp(symname
, curnode
->symbol
->name
) == 0)
216 curnode
= SLIST_NEXT(curnode
, links
);
222 symlist_add(symlist_t
*symlist
, symbol_t
*symbol
, int how
)
224 symbol_node_t
*newnode
;
226 newnode
= (symbol_node_t
*)malloc(sizeof(symbol_node_t
));
227 if (newnode
== NULL
) {
228 stop("symlist_add: Unable to malloc symbol_node", EX_SOFTWARE
);
231 newnode
->symbol
= symbol
;
232 if (how
== SYMLIST_SORT
) {
233 symbol_node_t
*curnode
;
237 switch(symbol
->type
) {
249 stop("symlist_add: Invalid symbol type for sorting",
254 curnode
= SLIST_FIRST(symlist
);
257 && (curnode
->symbol
->type
> newnode
->symbol
->type
258 || (curnode
->symbol
->type
== newnode
->symbol
->type
259 && (curnode
->symbol
->info
.finfo
->value
>
260 newnode
->symbol
->info
.finfo
->value
))))
261 || (!field
&& (curnode
->symbol
->info
.rinfo
->address
>
262 newnode
->symbol
->info
.rinfo
->address
))) {
263 SLIST_INSERT_HEAD(symlist
, newnode
, links
);
268 if (SLIST_NEXT(curnode
, links
) == NULL
) {
269 SLIST_INSERT_AFTER(curnode
, newnode
,
275 cursymbol
= SLIST_NEXT(curnode
, links
)->symbol
;
277 && (cursymbol
->type
> symbol
->type
278 || (cursymbol
->type
== symbol
->type
279 && (cursymbol
->info
.finfo
->value
>
280 symbol
->info
.finfo
->value
))))
282 && (cursymbol
->info
.rinfo
->address
>
283 symbol
->info
.rinfo
->address
))) {
284 SLIST_INSERT_AFTER(curnode
, newnode
,
289 curnode
= SLIST_NEXT(curnode
, links
);
292 SLIST_INSERT_HEAD(symlist
, newnode
, links
);
297 symlist_free(symlist_t
*symlist
)
299 symbol_node_t
*node1
, *node2
;
301 node1
= SLIST_FIRST(symlist
);
302 while (node1
!= NULL
) {
303 node2
= SLIST_NEXT(node1
, links
);
311 symlist_merge(symlist_t
*symlist_dest
, symlist_t
*symlist_src1
,
312 symlist_t
*symlist_src2
)
316 *symlist_dest
= *symlist_src1
;
317 while((node
= SLIST_FIRST(symlist_src2
)) != NULL
) {
318 SLIST_REMOVE_HEAD(symlist_src2
, links
);
319 SLIST_INSERT_HEAD(symlist_dest
, node
, links
);
322 /* These are now empty */
323 SLIST_INIT(symlist_src1
);
324 SLIST_INIT(symlist_src2
);
328 aic_print_file_prologue(FILE *ofile
)
336 " * DO NOT EDIT - This file is automatically generated\n"
337 " * from the following source files:\n"
344 aic_print_include(FILE *dfile
, char *include_file
)
349 fprintf(dfile
, "\n#include \"%s\"\n\n", include_file
);
353 aic_print_reg_dump_types(FILE *ofile
)
359 "typedef int (%sreg_print_t)(u_int, u_int *, u_int);\n"
360 "typedef struct %sreg_parse_entry {\n"
364 "} %sreg_parse_entry_t;\n"
366 prefix
, prefix
, prefix
);
370 aic_print_reg_dump_start(FILE *dfile
, symbol_node_t
*regnode
)
376 "static const %sreg_parse_entry_t %s_parse_table[] = {\n",
378 regnode
->symbol
->name
);
382 aic_print_reg_dump_end(FILE *ofile
, FILE *dfile
,
383 symbol_node_t
*regnode
, u_int num_entries
)
388 lower_name
= strdup(regnode
->symbol
->name
);
389 if (lower_name
== NULL
)
390 stop("Unable to strdup symbol name", EX_SOFTWARE
);
392 for (letter
= lower_name
; *letter
!= '\0'; letter
++)
393 *letter
= tolower(*letter
);
396 if (num_entries
!= 0)
404 "%s%s_print(u_int regvalue, u_int *cur_col, u_int wrap)\n"
406 " return (%sprint_register(%s%s, %d, \"%s\",\n"
407 " 0x%02x, regvalue, cur_col, wrap));\n"
413 num_entries
!= 0 ? regnode
->symbol
->name
: "NULL",
414 num_entries
!= 0 ? "_parse_table" : "",
416 regnode
->symbol
->name
,
417 regnode
->symbol
->info
.rinfo
->address
);
421 "#if AIC_DEBUG_REGISTERS\n"
422 "%sreg_print_t %s%s_print;\n"
424 "#define %s%s_print(regvalue, cur_col, wrap) \\\n"
425 " %sprint_register(NULL, 0, \"%s\", 0x%02x, regvalue, cur_col, wrap)\n"
434 regnode
->symbol
->name
,
435 regnode
->symbol
->info
.rinfo
->address
);
439 aic_print_reg_dump_entry(FILE *dfile
, symbol_node_t
*curnode
)
448 curnode
->symbol
->name
);
450 num_tabs
= 3 - (strlen(curnode
->symbol
->name
) + 5) / 8;
452 while (num_tabs
-- > 0)
454 fprintf(dfile
, "0x%02x, 0x%02x }",
455 curnode
->symbol
->info
.finfo
->value
,
456 curnode
->symbol
->info
.finfo
->mask
);
460 symtable_dump(FILE *ofile
, FILE *dfile
)
463 * Sort the registers by address with a simple insertion sort.
464 * Put bitmasks next to the first register that defines them.
465 * Put constants at the end.
470 symlist_t download_constants
;
472 symlist_t exported_labels
;
473 symbol_node_t
*curnode
;
474 symbol_node_t
*regnode
;
478 int reg_count
= 0, reg_used
= 0;
481 if (symtable
== NULL
)
484 SLIST_INIT(®isters
);
486 SLIST_INIT(&constants
);
487 SLIST_INIT(&download_constants
);
488 SLIST_INIT(&aliases
);
489 SLIST_INIT(&exported_labels
);
491 while (symtable
->seq(symtable
, &key
, &data
, flag
) == 0) {
494 memcpy(&cursym
, data
.data
, sizeof(cursym
));
495 switch(cursym
->type
) {
499 symlist_add(®isters
, cursym
, SYMLIST_SORT
);
505 symlist_add(&masks
, cursym
, SYMLIST_SORT
);
508 symlist_add(&constants
, cursym
,
509 SYMLIST_INSERT_HEAD
);
512 symlist_add(&download_constants
, cursym
,
513 SYMLIST_INSERT_HEAD
);
516 symlist_add(&aliases
, cursym
,
517 SYMLIST_INSERT_HEAD
);
520 if (cursym
->info
.linfo
->exported
== 0)
522 symlist_add(&exported_labels
, cursym
,
523 SYMLIST_INSERT_HEAD
);
531 /* Register dianostic functions/declarations first. */
532 aic_print_file_prologue(ofile
);
533 aic_print_reg_dump_types(ofile
);
534 aic_print_file_prologue(dfile
);
535 aic_print_include(dfile
, stock_include_file
);
536 SLIST_FOREACH(curnode
, ®isters
, links
) {
538 if (curnode
->symbol
->dont_generate_debug_code
)
541 switch(curnode
->symbol
->type
) {
547 symbol_node_t
*fieldnode
;
552 if (curnode
->symbol
->count
== 1)
554 fields
= &curnode
->symbol
->info
.rinfo
->fields
;
555 SLIST_FOREACH(fieldnode
, fields
, links
) {
556 if (num_entries
== 0)
557 aic_print_reg_dump_start(dfile
,
559 else if (dfile
!= NULL
)
562 aic_print_reg_dump_entry(dfile
, fieldnode
);
564 aic_print_reg_dump_end(ofile
, dfile
,
565 curnode
, num_entries
);
572 fprintf(stderr
, "%s: %d of %d register definitions used\n", appname
,
573 reg_used
, reg_count
);
575 /* Fold in the masks and bits */
576 while (SLIST_FIRST(&masks
) != NULL
) {
579 curnode
= SLIST_FIRST(&masks
);
580 SLIST_REMOVE_HEAD(&masks
, links
);
582 regnode
= SLIST_FIRST(&curnode
->symbol
->info
.finfo
->symrefs
);
583 regname
= regnode
->symbol
->name
;
584 regnode
= symlist_search(®isters
, regname
);
585 SLIST_INSERT_AFTER(regnode
, curnode
, links
);
588 /* Add the aliases */
589 while (SLIST_FIRST(&aliases
) != NULL
) {
592 curnode
= SLIST_FIRST(&aliases
);
593 SLIST_REMOVE_HEAD(&aliases
, links
);
595 regname
= curnode
->symbol
->info
.ainfo
->parent
->name
;
596 regnode
= symlist_search(®isters
, regname
);
597 SLIST_INSERT_AFTER(regnode
, curnode
, links
);
600 /* Output generated #defines. */
601 while (SLIST_FIRST(®isters
) != NULL
) {
602 symbol_node_t
*curnode
;
607 curnode
= SLIST_FIRST(®isters
);
608 SLIST_REMOVE_HEAD(®isters
, links
);
609 switch(curnode
->symbol
->type
) {
613 fprintf(ofile
, "\n");
614 value
= curnode
->symbol
->info
.rinfo
->address
;
622 parent
= curnode
->symbol
->info
.ainfo
->parent
;
623 value
= parent
->info
.rinfo
->address
;
632 value
= curnode
->symbol
->info
.finfo
->value
;
637 value
= 0; /* Quiet compiler */
640 stop("symtable_dump: Invalid symbol type "
641 "encountered", EX_SOFTWARE
);
644 fprintf(ofile
, "#define%s%-16s%s0x%02x\n",
645 tab_str
, curnode
->symbol
->name
, tab_str2
,
649 fprintf(ofile
, "\n\n");
651 while (SLIST_FIRST(&constants
) != NULL
) {
652 symbol_node_t
*curnode
;
654 curnode
= SLIST_FIRST(&constants
);
655 SLIST_REMOVE_HEAD(&constants
, links
);
656 fprintf(ofile
, "#define\t%-8s\t0x%02x\n",
657 curnode
->symbol
->name
,
658 curnode
->symbol
->info
.cinfo
->value
);
662 fprintf(ofile
, "\n\n/* Downloaded Constant Definitions */\n");
664 for (i
= 0; SLIST_FIRST(&download_constants
) != NULL
; i
++) {
665 symbol_node_t
*curnode
;
667 curnode
= SLIST_FIRST(&download_constants
);
668 SLIST_REMOVE_HEAD(&download_constants
, links
);
669 fprintf(ofile
, "#define\t%-8s\t0x%02x\n",
670 curnode
->symbol
->name
,
671 curnode
->symbol
->info
.cinfo
->value
);
674 fprintf(ofile
, "#define\tDOWNLOAD_CONST_COUNT\t0x%02x\n", i
);
676 fprintf(ofile
, "\n\n/* Exported Labels */\n");
678 while (SLIST_FIRST(&exported_labels
) != NULL
) {
679 symbol_node_t
*curnode
;
681 curnode
= SLIST_FIRST(&exported_labels
);
682 SLIST_REMOVE_HEAD(&exported_labels
, links
);
683 fprintf(ofile
, "#define\tLABEL_%-8s\t0x%02x\n",
684 curnode
->symbol
->name
,
685 curnode
->symbol
->info
.linfo
->address
);