xref: /freebsd/sys/dev/aic7xxx/aicasm/aicasm_symbol.c (revision d6b92ffa) 
1 /*-
2  * Aic7xxx SCSI host adapter firmware asssembler symbol table implementation
3  *
4  * Copyright (c) 1997 Justin T. Gibbs.
5  * Copyright (c) 2002 Adaptec Inc.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
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.
22  *
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.
26  *
27  * NO WARRANTY
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.
39  *
40  * $Id: //depot/aic7xxx/aic7xxx/aicasm/aicasm_symbol.c#24 $
41  *
42  * $FreeBSD$
43  */
44 
45 #include <sys/types.h>
46 #include <sys/param.h>
47 #if defined(BSD) && !defined(__GNU__)
48 #include <db.h>
49 #else
50 #include <db_185.h>
51 #endif
52 #include <ctype.h>
53 #include <fcntl.h>
54 #include <inttypes.h>
55 #include <regex.h>
56 #include <stdio.h>
57 #include <stdlib.h>
58 #include <string.h>
59 #include <sysexits.h>
60 
61 #include "aicasm_symbol.h"
62 #include "aicasm.h"
63 
64 static DB *symtable;
65 
66 static symbol_t *
67 symbol_create(const char *name)
68 {
69 	symbol_t *new_symbol;
70 
71 	new_symbol = (symbol_t *)malloc(sizeof(symbol_t));
72 	if (new_symbol == NULL) {
73 		perror("Unable to create new symbol");
74 		exit(EX_SOFTWARE);
75 	}
76 	memset(new_symbol, 0, sizeof(*new_symbol));
77 	new_symbol->name = strdup(name);
78 	if (new_symbol->name == NULL)
79 		 stop("Unable to strdup symbol name", EX_SOFTWARE);
80 	new_symbol->type = UNINITIALIZED;
81 	return (new_symbol);
82 }
83 
84 void
85 symbol_delete(symbol_t *symbol)
86 {
87 	if (symtable != NULL) {
88 		DBT	 key;
89 
90 		key.data = symbol->name;
91 		key.size = strlen(symbol->name);
92 		symtable->del(symtable, &key, /*flags*/0);
93 	}
94 	switch(symbol->type) {
95 	case SCBLOC:
96 	case SRAMLOC:
97 	case REGISTER:
98 		if (symbol->info.rinfo != NULL)
99 			free(symbol->info.rinfo);
100 		break;
101 	case ALIAS:
102 		if (symbol->info.ainfo != NULL)
103 			free(symbol->info.ainfo);
104 		break;
105 	case MASK:
106 	case FIELD:
107 	case ENUM:
108 	case ENUM_ENTRY:
109 		if (symbol->info.finfo != NULL) {
110 			symlist_free(&symbol->info.finfo->symrefs);
111 			free(symbol->info.finfo);
112 		}
113 		break;
114 	case DOWNLOAD_CONST:
115 	case CONST:
116 		if (symbol->info.cinfo != NULL)
117 			free(symbol->info.cinfo);
118 		break;
119 	case LABEL:
120 		if (symbol->info.linfo != NULL)
121 			free(symbol->info.linfo);
122 		break;
123 	case UNINITIALIZED:
124 	default:
125 		break;
126 	}
127 	free(symbol->name);
128 	free(symbol);
129 }
130 
131 void
132 symtable_open(void)
133 {
134 	symtable = dbopen(/*filename*/NULL,
135 			  O_CREAT | O_NONBLOCK | O_RDWR, /*mode*/0, DB_HASH,
136 			  /*openinfo*/NULL);
137 
138 	if (symtable == NULL) {
139 		perror("Symbol table creation failed");
140 		exit(EX_SOFTWARE);
141 		/* NOTREACHED */
142 	}
143 }
144 
145 void
146 symtable_close(void)
147 {
148 	if (symtable != NULL) {
149 		DBT	 key;
150 		DBT	 data;
151 
152 		while (symtable->seq(symtable, &key, &data, R_FIRST) == 0) {
153 			symbol_t *stored_ptr;
154 
155 			memcpy(&stored_ptr, data.data, sizeof(stored_ptr));
156 			symbol_delete(stored_ptr);
157 		}
158 		symtable->close(symtable);
159 	}
160 }
161 
162 /*
163  * The semantics of get is to return an uninitialized symbol entry
164  * if a lookup fails.
165  */
166 symbol_t *
167 symtable_get(const char *name)
168 {
169 	symbol_t *stored_ptr;
170 	DBT	  key;
171 	DBT	  data;
172 	int	  retval;
173 
174 	key.data = strdup(name);
175 	key.size = strlen(name);
176 
177 	if ((retval = symtable->get(symtable, &key, &data, /*flags*/0)) != 0) {
178 		if (retval == -1) {
179 			perror("Symbol table get operation failed");
180 			exit(EX_SOFTWARE);
181 			/* NOTREACHED */
182 		} else if (retval == 1) {
183 			/* Symbol wasn't found, so create a new one */
184 			symbol_t *new_symbol;
185 
186 			new_symbol = symbol_create(name);
187 			data.data = &new_symbol;
188 			data.size = sizeof(new_symbol);
189 			if (symtable->put(symtable, &key, &data,
190 					  /*flags*/0) !=0) {
191 				perror("Symtable put failed");
192 				exit(EX_SOFTWARE);
193 			}
194 			free(key.data);
195 			return (new_symbol);
196 		} else {
197 			perror("Unexpected return value from db get routine");
198 			exit(EX_SOFTWARE);
199 			/* NOTREACHED */
200 		}
201 	}
202 	memcpy(&stored_ptr, data.data, sizeof(stored_ptr));
203 	free(key.data);
204 	return (stored_ptr);
205 }
206 
207 symbol_node_t *
208 symlist_search(symlist_t *symlist, char *symname)
209 {
210 	symbol_node_t *curnode;
211 
212 	curnode = SLIST_FIRST(symlist);
213 	while(curnode != NULL) {
214 		if (strcmp(symname, curnode->symbol->name) == 0)
215 			break;
216 		curnode = SLIST_NEXT(curnode, links);
217 	}
218 	return (curnode);
219 }
220 
221 void
222 symlist_add(symlist_t *symlist, symbol_t *symbol, int how)
223 {
224 	symbol_node_t *newnode;
225 
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);
229 		/* NOTREACHED */
230 	}
231 	newnode->symbol = symbol;
232 	if (how == SYMLIST_SORT) {
233 		symbol_node_t *curnode;
234 		int field;
235 
236 		field = FALSE;
237 		switch(symbol->type) {
238 		case REGISTER:
239 		case SCBLOC:
240 		case SRAMLOC:
241 			break;
242 		case FIELD:
243 		case MASK:
244 		case ENUM:
245 		case ENUM_ENTRY:
246 			field = TRUE;
247 			break;
248 		default:
249 			stop("symlist_add: Invalid symbol type for sorting",
250 			     EX_SOFTWARE);
251 			/* NOTREACHED */
252 		}
253 
254 		curnode = SLIST_FIRST(symlist);
255 		if (curnode == NULL
256 		 || (field
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);
264 			return;
265 		}
266 
267 		while (1) {
268 			if (SLIST_NEXT(curnode, links) == NULL) {
269 				SLIST_INSERT_AFTER(curnode, newnode,
270 						   links);
271 				break;
272 			} else {
273 				symbol_t *cursymbol;
274 
275 				cursymbol = SLIST_NEXT(curnode, links)->symbol;
276 				if ((field
277 		  		  && (cursymbol->type > symbol->type
278 				   || (cursymbol->type == symbol->type
279 				    && (cursymbol->info.finfo->value >
280 					symbol->info.finfo->value))))
281 				 || (!field
282 				   && (cursymbol->info.rinfo->address >
283 				       symbol->info.rinfo->address))) {
284 					SLIST_INSERT_AFTER(curnode, newnode,
285 							   links);
286 					break;
287 				}
288 			}
289 			curnode = SLIST_NEXT(curnode, links);
290 		}
291 	} else {
292 		SLIST_INSERT_HEAD(symlist, newnode, links);
293 	}
294 }
295 
296 void
297 symlist_free(symlist_t *symlist)
298 {
299 	symbol_node_t *node1, *node2;
300 
301 	node1 = SLIST_FIRST(symlist);
302 	while (node1 != NULL) {
303 		node2 = SLIST_NEXT(node1, links);
304 		free(node1);
305 		node1 = node2;
306 	}
307 	SLIST_INIT(symlist);
308 }
309 
310 void
311 symlist_merge(symlist_t *symlist_dest, symlist_t *symlist_src1,
312 	      symlist_t *symlist_src2)
313 {
314 	symbol_node_t *node;
315 
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);
320 	}
321 
322 	/* These are now empty */
323 	SLIST_INIT(symlist_src1);
324 	SLIST_INIT(symlist_src2);
325 }
326 
327 static void
328 aic_print_file_prologue(FILE *ofile)
329 {
330 
331 	if (ofile == NULL)
332 		return;
333 
334 	fprintf(ofile,
335 "/*\n"
336 " * DO NOT EDIT - This file is automatically generated\n"
337 " *		 from the following source files:\n"
338 " *\n"
339 "%s */\n",
340 		versions);
341 }
342 
343 static void
344 aic_print_include(FILE *dfile, char *header_file)
345 {
346 
347 	if (dfile == NULL)
348 		return;
349 	fprintf(dfile, "\n#include \"%s\"\n\n", header_file);
350 }
351 
352 static void
353 aic_print_reg_dump_types(FILE *ofile)
354 {
355 	if (ofile == NULL)
356 		return;
357 
358 	fprintf(ofile,
359 "typedef int (%sreg_print_t)(u_int, u_int *, u_int);\n"
360 "typedef struct %sreg_parse_entry {\n"
361 "	char	*name;\n"
362 "	uint8_t	 value;\n"
363 "	uint8_t	 mask;\n"
364 "} %sreg_parse_entry_t;\n"
365 "\n",
366 		prefix, prefix, prefix);
367 }
368 
369 static void
370 aic_print_reg_dump_start(FILE *dfile, symbol_node_t *regnode)
371 {
372 	if (dfile == NULL)
373 		return;
374 
375 	fprintf(dfile,
376 "static %sreg_parse_entry_t %s_parse_table[] = {\n",
377 		prefix,
378 		regnode->symbol->name);
379 }
380 
381 static void
382 aic_print_reg_dump_end(FILE *ofile, FILE *dfile,
383 		       symbol_node_t *regnode, u_int num_entries)
384 {
385 	char *lower_name;
386 	char *letter;
387 
388 	lower_name = strdup(regnode->symbol->name);
389 	if (lower_name == NULL)
390 		 stop("Unable to strdup symbol name", EX_SOFTWARE);
391 
392 	for (letter = lower_name; *letter != '\0'; letter++)
393 		*letter = tolower(*letter);
394 
395 	if (dfile != NULL) {
396 		if (num_entries != 0)
397 			fprintf(dfile,
398 "\n"
399 "};\n"
400 "\n");
401 
402 		fprintf(dfile,
403 "int\n"
404 "%s%s_print(u_int regvalue, u_int *cur_col, u_int wrap)\n"
405 "{\n"
406 "	return (%sprint_register(%s%s, %d, \"%s\",\n"
407 "	    0x%02x, regvalue, cur_col, wrap));\n"
408 "}\n"
409 "\n",
410 			prefix,
411 			lower_name,
412 			prefix,
413 			num_entries != 0 ? regnode->symbol->name : "NULL",
414 			num_entries != 0 ? "_parse_table" : "",
415 			num_entries,
416 			regnode->symbol->name,
417 			regnode->symbol->info.rinfo->address);
418 	}
419 
420 	fprintf(ofile,
421 "#if AIC_DEBUG_REGISTERS\n"
422 "%sreg_print_t %s%s_print;\n"
423 "#else\n"
424 "#define %s%s_print(regvalue, cur_col, wrap) \\\n"
425 "    %sprint_register(NULL, 0, \"%s\", 0x%02x, regvalue, cur_col, wrap)\n"
426 "#endif\n"
427 "\n",
428 		prefix,
429 		prefix,
430 		lower_name,
431 		prefix,
432 		lower_name,
433 		prefix,
434 		regnode->symbol->name,
435 		regnode->symbol->info.rinfo->address);
436 }
437 
438 static void
439 aic_print_reg_dump_entry(FILE *dfile, symbol_node_t *curnode)
440 {
441 	int num_tabs;
442 
443 	if (dfile == NULL)
444 		return;
445 
446 	fprintf(dfile,
447 "	{ \"%s\",",
448 		curnode->symbol->name);
449 
450 	num_tabs = 3 - (strlen(curnode->symbol->name) + 5) / 8;
451 
452 	while (num_tabs-- > 0)
453 		fputc('\t', dfile);
454 	fprintf(dfile, "0x%02x, 0x%02x }",
455 		curnode->symbol->info.finfo->value,
456 		curnode->symbol->info.finfo->mask);
457 }
458 
459 void
460 symtable_dump(FILE *ofile, FILE *dfile)
461 {
462 	/*
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.
466 	 */
467 	symlist_t	 registers;
468 	symlist_t	 masks;
469 	symlist_t	 constants;
470 	symlist_t	 download_constants;
471 	symlist_t	 aliases;
472 	symlist_t	 exported_labels;
473 	symbol_node_t	*curnode;
474 	symbol_node_t	*regnode;
475 	DBT		 key;
476 	DBT		 data;
477 	int		 flag;
478 	u_int		 i;
479 
480 	if (symtable == NULL)
481 		return;
482 
483 	SLIST_INIT(&registers);
484 	SLIST_INIT(&masks);
485 	SLIST_INIT(&constants);
486 	SLIST_INIT(&download_constants);
487 	SLIST_INIT(&aliases);
488 	SLIST_INIT(&exported_labels);
489 	flag = R_FIRST;
490 	while (symtable->seq(symtable, &key, &data, flag) == 0) {
491 		symbol_t *cursym;
492 
493 		memcpy(&cursym, data.data, sizeof(cursym));
494 		switch(cursym->type) {
495 		case REGISTER:
496 		case SCBLOC:
497 		case SRAMLOC:
498 			symlist_add(&registers, cursym, SYMLIST_SORT);
499 			break;
500 		case MASK:
501 		case FIELD:
502 		case ENUM:
503 		case ENUM_ENTRY:
504 			symlist_add(&masks, cursym, SYMLIST_SORT);
505 			break;
506 		case CONST:
507 			symlist_add(&constants, cursym,
508 				    SYMLIST_INSERT_HEAD);
509 			break;
510 		case DOWNLOAD_CONST:
511 			symlist_add(&download_constants, cursym,
512 				    SYMLIST_INSERT_HEAD);
513 			break;
514 		case ALIAS:
515 			symlist_add(&aliases, cursym,
516 				    SYMLIST_INSERT_HEAD);
517 			break;
518 		case LABEL:
519 			if (cursym->info.linfo->exported == 0)
520 				break;
521 			symlist_add(&exported_labels, cursym,
522 				    SYMLIST_INSERT_HEAD);
523 			break;
524 		default:
525 			break;
526 		}
527 		flag = R_NEXT;
528 	}
529 
530 	/* Register dianostic functions/declarations first. */
531 	aic_print_file_prologue(ofile);
532 	aic_print_reg_dump_types(ofile);
533 	aic_print_file_prologue(dfile);
534 	aic_print_include(dfile, stock_include_file);
535 	SLIST_FOREACH(curnode, &registers, links) {
536 
537 		switch(curnode->symbol->type) {
538 		case REGISTER:
539 		case SCBLOC:
540 		case SRAMLOC:
541 		{
542 			symlist_t	*fields;
543 			symbol_node_t	*fieldnode;
544 			int		 num_entries;
545 
546 			num_entries = 0;
547 			fields = &curnode->symbol->info.rinfo->fields;
548 			SLIST_FOREACH(fieldnode, fields, links) {
549 				if (num_entries == 0)
550 					aic_print_reg_dump_start(dfile,
551 								 curnode);
552 				else if (dfile != NULL)
553 					fputs(",\n", dfile);
554 				num_entries++;
555 				aic_print_reg_dump_entry(dfile, fieldnode);
556 			}
557 			aic_print_reg_dump_end(ofile, dfile,
558 					       curnode, num_entries);
559 		}
560 		default:
561 			break;
562 		}
563 	}
564 
565 	/* Fold in the masks and bits */
566 	while (SLIST_FIRST(&masks) != NULL) {
567 		char *regname;
568 
569 		curnode = SLIST_FIRST(&masks);
570 		SLIST_REMOVE_HEAD(&masks, links);
571 
572 		regnode = SLIST_FIRST(&curnode->symbol->info.finfo->symrefs);
573 		regname = regnode->symbol->name;
574 		regnode = symlist_search(&registers, regname);
575 		SLIST_INSERT_AFTER(regnode, curnode, links);
576 	}
577 
578 	/* Add the aliases */
579 	while (SLIST_FIRST(&aliases) != NULL) {
580 		char *regname;
581 
582 		curnode = SLIST_FIRST(&aliases);
583 		SLIST_REMOVE_HEAD(&aliases, links);
584 
585 		regname = curnode->symbol->info.ainfo->parent->name;
586 		regnode = symlist_search(&registers, regname);
587 		SLIST_INSERT_AFTER(regnode, curnode, links);
588 	}
589 
590 	/* Output generated #defines. */
591 	while (SLIST_FIRST(&registers) != NULL) {
592 		u_int value;
593 		const char *tab_str;
594 		const char *tab_str2;
595 
596 		curnode = SLIST_FIRST(&registers);
597 		SLIST_REMOVE_HEAD(&registers, links);
598 		switch(curnode->symbol->type) {
599 		case REGISTER:
600 		case SCBLOC:
601 		case SRAMLOC:
602 			fprintf(ofile, "\n");
603 			value = curnode->symbol->info.rinfo->address;
604 			tab_str = "\t";
605 			tab_str2 = "\t\t";
606 			break;
607 		case ALIAS:
608 		{
609 			symbol_t *parent;
610 
611 			parent = curnode->symbol->info.ainfo->parent;
612 			value = parent->info.rinfo->address;
613 			tab_str = "\t";
614 			tab_str2 = "\t\t";
615 			break;
616 		}
617 		case MASK:
618 		case FIELD:
619 		case ENUM:
620 		case ENUM_ENTRY:
621 			value = curnode->symbol->info.finfo->value;
622 			tab_str = "\t\t";
623 			tab_str2 = "\t";
624 			break;
625 		default:
626 			value = 0; /* Quiet compiler */
627 			tab_str = NULL;
628 			tab_str2 = NULL;
629 			stop("symtable_dump: Invalid symbol type "
630 			     "encountered", EX_SOFTWARE);
631 			break;
632 		}
633 		fprintf(ofile, "#define%s%-16s%s0x%02x\n",
634 			tab_str, curnode->symbol->name, tab_str2,
635 			value);
636 		free(curnode);
637 	}
638 	fprintf(ofile, "\n\n");
639 
640 	while (SLIST_FIRST(&constants) != NULL) {
641 
642 		curnode = SLIST_FIRST(&constants);
643 		SLIST_REMOVE_HEAD(&constants, links);
644 		fprintf(ofile, "#define\t%-8s\t0x%02x\n",
645 			curnode->symbol->name,
646 			curnode->symbol->info.cinfo->value);
647 		free(curnode);
648 	}
649 
650 
651 	fprintf(ofile, "\n\n/* Downloaded Constant Definitions */\n");
652 
653 	for (i = 0; SLIST_FIRST(&download_constants) != NULL; i++) {
654 
655 		curnode = SLIST_FIRST(&download_constants);
656 		SLIST_REMOVE_HEAD(&download_constants, links);
657 		fprintf(ofile, "#define\t%-8s\t0x%02x\n",
658 			curnode->symbol->name,
659 			curnode->symbol->info.cinfo->value);
660 		free(curnode);
661 	}
662 	fprintf(ofile, "#define\tDOWNLOAD_CONST_COUNT\t0x%02x\n", i);
663 
664 	fprintf(ofile, "\n\n/* Exported Labels */\n");
665 
666 	while (SLIST_FIRST(&exported_labels) != NULL) {
667 
668 		curnode = SLIST_FIRST(&exported_labels);
669 		SLIST_REMOVE_HEAD(&exported_labels, links);
670 		fprintf(ofile, "#define\tLABEL_%-8s\t0x%02x\n",
671 			curnode->symbol->name,
672 			curnode->symbol->info.linfo->address);
673 		free(curnode);
674 	}
675 }
676 
677