4 * (C) Copyright 1989-1995
12 * - add jflag and jfp to control NoICE output file genration
14 * - use a_type == 0 as "virgin area" flag: set == 1 if -b
25 void Timer(int action, char * message)
27 static double start, end, total=0.0;
28 static const double secs_per_tick = 1.0 / CLOCKS_PER_SEC;
30 if(action==0) start=clock()*secs_per_tick;
33 end=clock() * secs_per_tick;
34 printf("%s \t%f seconds.\n", message, (end-start));
39 printf("Total time: \t%f seconds.\n", total);
45 /* yuck - but including unistd.h causes problems on Cygwin by redefining
48 extern int unlink(const char *);
52 * The module lkmain.c contains the functions which
53 * (1) input the linker options, parameters, and specifications
54 * (2) perform a two pass link
55 * (3) produce the appropriate linked data output and/or
56 * link map file and/or relocated listing files.
58 * lkmain.c contains the following functions:
59 * FILE * afile(fn,ft,wf)
64 * VOID main(argc,argv)
71 * lkmain.c contains the following local variables:
72 * char * usetext[] array of pointers to the
73 * command option tect lines
77 /*JCF: Creates some of the default areas so they are allocated in the right order.*/
82 "H 7 areas 0 global symbols",
83 "A _CODE size 0 flags 0", /*Each .rel has one, so...*/
84 "A REG_BANK_0 size 0 flags 4", /*Register banks are overlayable*/
85 "A REG_BANK_1 size 0 flags 4",
86 "A REG_BANK_2 size 0 flags 4",
87 "A REG_BANK_3 size 0 flags 4",
88 "A BSEG size 0 flags 80", /*BSEG must be just before BITS*/
89 "A BSEG_BYTES size 0 flags 0", /*Size will be obtained from BSEG in lnkarea()*/
94 for (j=0; rel[j][0]!=0; j++)
100 /*Set the start address of the default areas:*/
101 for(ap=areap; ap; ap=ap->a_ap)
103 /**/ if (!strcmp(ap->a_id, "REG_BANK_0")) { ap->a_addr=0x00; ap->a_type=1; }
104 else if (!strcmp(ap->a_id, "REG_BANK_1")) { ap->a_addr=0x08; ap->a_type=1; }
105 else if (!strcmp(ap->a_id, "REG_BANK_2")) { ap->a_addr=0x10; ap->a_type=1; }
106 else if (!strcmp(ap->a_id, "REG_BANK_3")) { ap->a_addr=0x18; ap->a_type=1; }
107 else if (!strcmp(ap->a_id, "BSEG_BYTES")) { ap->a_addr=0x20; ap->a_type=1; }
111 /*)Function VOID main(argc,argv)
113 * int argc number of command line arguments + 1
114 * char * argv[] array of pointers to the command line
117 * The function main() evaluates the command line arguments to
118 * determine if the linker parameters are to input through 'stdin'
119 * or read from a command file. The functiond getline() and parse()
120 * are to input and evaluate the linker parameters. The linking process
121 * proceeds by making the first pass through each .rel file in the order
122 * presented to the linker. At the end of the first pass the setbase(),
123 * lnkarea(), setgbl(), and symdef() functions are called to evaluate
124 * the base address terms, link all areas, define global variables,
125 * and look for undefined symbols. Following these routines a linker
126 * map file may be produced and the linker output files may be opened.
127 * The second pass through the .rel files will output the linked data
128 * in one of the four supported formats.
131 * char * p pointer to an argument string
132 * int c character from argument string
137 * lfile *cfp The pointer *cfp points to the
138 * current lfile structure
139 * char ctype[] array of character types, one per
141 * lfile *filep The pointer *filep points to the
142 * beginning of a linked list of
144 * head *hp Pointer to the current
146 * char ib[NINPUT] .rel file text line
147 * char *ip pointer into the .rel file
148 * lfile *linkp pointer to first lfile structure
149 * containing an input .rel file
151 * int lkerr error flag
152 * int mflag Map output flag
153 * int oflag Output file type flag
154 * FILE *ofp Output file handle
156 * FILE *ofph Output file handle
157 * for high byte format
158 * FILE *ofpl Output file handle
159 * for low byte format
160 * int pass linker pass number
161 * int pflag print linker command file flag
162 * int radix current number conversion radix
163 * FILE *sfp The file handle sfp points to the
164 * currently open file
165 * lfile *startp asmlnk startup file structure
166 * FILE * stdin c_library
167 * FILE * stdout c_library
170 * FILE * afile() lkmain.c
171 * int fclose() c_library
172 * int fprintf() c_library
173 * int getline() lklex.c
174 * VOID library() lklibr.c
175 * VOID link_main() lkmain.c
176 * VOID lkexit() lkmain.c
177 * VOID lnkarea() lkarea.c
178 * VOID map() lkmain.c
180 * int parse() lkmain.c
181 * VOID reloc() lkreloc.c
182 * VOID search() lklibr.c
183 * VOID setbas() lkmain.c
184 * VOID setgbl() lkmain.c
185 * VOID symdef() lksym.c
186 * VOID usage() lkmain.c
189 * Completion of main() completes the linking process
190 * and may produce a map file (.map) and/or a linked
191 * data files (.ihx or .s19) and/or one or more
192 * relocated listing files (.rst).
206 startp = (struct lfile *) new (sizeof (struct lfile));
209 for (i=1; i<argc; ++i) {
212 while (ctype[c = *(++p)] & LETTER) {
217 startp->f_type = F_STD;
222 startp->f_type = F_LNK;
240 if (startp->f_type == F_LNK) {
245 if (startp->f_type == 0)
247 if (startp->f_type == F_LNK && startp->f_idp == NULL)
257 if (pflag && sfp != stdin)
258 fprintf(stdout, "%s\n", ip);
259 if (*ip == '\0' || parse())
274 //dfp = afile("temp", "cdb", 1);
275 SaveLinkedFilePath(linkp->f_idp); //Must be the first one...
276 dfp = afile(linkp->f_idp,"cdb",1); //JCF: Nov 30, 2002
281 for (pass=0; pass<2; ++pass) {
288 Areas51(); /*JCF: Create the default 8051 areas in the right order*/
293 /* pass any "magic comments" to NoICE output */
294 if ((ip[0] == ';') && (ip[1] == '!') && jfp) {
295 fprintf( jfp, "%s\n", &ip[2] );
301 * Search libraries for global symbols
305 * Set area base addresses.
309 * Link all area addresses.
313 * Process global definitions.
317 * Check for undefined globals.
321 /* Open NoICE output file if requested */
323 jfp = afile(linkp->f_idp, "NOI", 1);
330 * Output Link Map if requested,
331 * or if NoICE output requested (since NoICE
332 * file is generated in part by map() processing)
337 if (sflag) /*JCF: memory usage summary output*/
338 if(summary(areap))lkexit(1);
347 ofp = afile(linkp->f_idp, "ihx", 1);
351 /* include NoICE command to load hex file */
352 if (jfp) fprintf( jfp, "LOAD %s.IHX\n", linkp->f_idp );
356 ofp = afile(linkp->f_idp, "S19", 1);
360 /* include NoICE command to load hex file */
361 if (jfp) fprintf( jfp, "LOAD %s.S19\n", linkp->f_idp );
365 * Link in library files
375 Timer(1, "Linker execution time");
382 /*)Function VOID lkexit(i)
386 * The function lkexit() explicitly closes all open
387 * files and then terminates the program.
393 * FILE * mfp file handle for .map
394 * FILE * ofp file handle for .ihx/.s19
395 * FILE * rfp file hanlde for .rst
396 * FILE * sfp file handle for .rel
397 * FILE * tfp file handle for .lst
400 * int fclose() c_library
401 * VOID exit() c_library
404 * All files closed. Program terminates.
411 if (mfp != NULL) fclose(mfp);
412 if (jfp != NULL) fclose(jfp);
413 if (ofp != NULL) fclose(ofp);
414 if (rfp != NULL) fclose(rfp);
415 if (sfp != NULL) fclose(sfp);
416 if (tfp != NULL) fclose(tfp);
417 if (dfp != NULL) fclose(dfp);
419 FILE *xfp = afile(linkp->f_idp,"cdb",1);
420 dfp = freopen("temp.cdb","r",dfp);
429 /*)Function link_main()
431 * The function link_main() evaluates the directives for each line of
432 * text read from the .rel file(s). The valid directives processed
434 * X, D, Q, H, M, A, S, T, R, and P.
437 * int c first non blank character of a line
440 * head *headp The pointer to the first
441 * head structure of a linked list
442 * head *hp Pointer to the current
444 * int pass linker pass number
445 * int radix current number conversion radix
448 * char endline() lklex.c
449 * VOID module() lkhead.c
450 * VOID newarea() lkarea.c
451 * VOID newhead() lkhead.c
452 * sym * newsym() lksym.c
453 * VOID reloc() lkreloc.c
456 * Head, area, and symbol structures are created and
457 * the radix is set as the .rel file(s) are read.
465 if ((c=endline()) == 0) { return; }
503 if (sdp.s_area == NULL) {
505 sdp.s_areax = areap->a_axp;
526 if (c == 'X' || c == 'D' || c == 'Q') {
527 if ((c = get()) == 'H') {
537 /*)Function VOID map()
539 * The function map() opens the output map file and calls the various
541 * (1) output the variables in each area,
542 * (2) list the files processed with module names,
543 * (3) list the libraries file processed,
544 * (4) list base address definitions,
545 * (5) list global variable definitions, and
546 * (6) list any undefined variables.
550 * head * hdp pointer to head structure
551 * lbfile *lbfh pointer to library file structure
554 * area *ap Pointer to the current
556 * area *areap The pointer to the first
557 * area structure of a linked list
558 * base *basep The pointer to the first
560 * base *bsp Pointer to the current
562 * lfile *filep The pointer *filep points to the
563 * beginning of a linked list of
565 * globl *globlp The pointer to the first
567 * globl *gsp Pointer to the current
569 * head *headp The pointer to the first
570 * head structure of a linked list
571 * lbfile *lbfhead The pointer to the first
572 * lbfile structure of a linked list
573 * lfile *linkp pointer to first lfile structure
574 * containing an input REL file
576 * int lop current line number on page
577 * FILE *mfp Map output file handle
578 * int page current page number
581 * FILE * afile() lkmain.c
582 * int fprintf() c_library
583 * VOID lkexit() lkmain.c
584 * VOID lstarea() lklist.c
585 * VOID newpag() lklist.c
586 * VOID symdef() lksym.c
589 * The map file is created.
596 register struct head *hdp;
597 register struct lbfile *lbfh;
602 mfp = afile(linkp->f_idp, "map", 1);
608 * Output Map Area Lists
621 fprintf(mfp, "\nFiles Linked [ module(s) ]\n\n");
625 fprintf(mfp, "%-16s", filep->f_idp);
627 while ((hdp != NULL) && (hdp->h_lfile == filep)) {
629 fprintf(mfp, ", %8.8s", hdp->m_id);
632 fprintf(mfp, ",\n%20s%8.8s", "", hdp->m_id);
634 fprintf(mfp, " [ %8.8s", hdp->m_id);
643 filep = filep->f_flp;
646 * List Linked Libraries
648 if (lbfhead != NULL) {
650 "\nLibraries Linked [ object file ]\n\n");
651 for (lbfh=lbfhead; lbfh; lbfh=lbfh->next) {
652 fprintf(mfp, "%-32s [ %16.16s ]\n",
653 lbfh->libspc, lbfh->relfil);
658 * List Base Address Definitions
662 fprintf(mfp, "\nUser Base Address Definitions\n\n");
665 fprintf(mfp, "%s\n", bsp->b_strp);
670 * List Global Definitions
674 fprintf(mfp, "\nUser Global Definitions\n\n");
677 fprintf(mfp, "%s\n", gsp->g_strp);
681 fprintf(mfp, "\n\f");
685 /*)Function int parse()
687 * The function parse() evaluates all command line or file input
688 * linker directives and updates the appropriate variables.
691 * int c character value
692 * char fid[] file id string
695 * char ctype[] array of character types, one per
697 * lfile *lfp pointer to current lfile structure
698 * being processed by parse()
699 * lfile *linkp pointer to first lfile structure
700 * containing an input REL file
702 * int mflag Map output flag
703 * int oflag Output file type flag
704 * int pflag print linker command file flag
705 * FILE * stderr c_library
706 * int uflag Relocated listing flag
707 * int xflag Map file radix type flag
710 * VOID addlib() lklibr.c
711 * VOID addpath() lklibr.c
712 * VOID bassav() lkmain.c
713 * int fprintf() c_library
714 * VOID gblsav() lkmain.c
715 * VOID getfid() lklex.c
716 * char getnb() lklex.c
717 * VOID lkexit() lkmain.c
718 * char * strcpy() c_library
719 * int strlen() c_library
722 * Various linker flags are updated and the linked
723 * structure lfile is created.
732 while ((c = getnb()) != 0) {
734 while (ctype[c=get()] & LETTER) {
752 case 'y': /*JCF: memory usage summary output*/
839 fprintf(stderr, "Invalid option\n");
844 if (ctype[c] & ILL) {
845 fprintf(stderr, "Invalid input");
849 linkp = (struct lfile *)
850 new (sizeof (struct lfile));
853 lfp->f_flp = (struct lfile *)
854 new (sizeof (struct lfile));
858 lfp->f_idp = (char *) new (strlen(fid)+1);
859 strcpy(lfp->f_idp, fid);
866 /*)Function VOID bassav()
868 * The function bassav() creates a linked structure containing
869 * the base address strings input to the linker.
875 * base *basep The pointer to the first
877 * base *bsp Pointer to the current
879 * char *ip pointer into the REL file
883 * char getnb() lklex.c
884 * VOID * new() lksym.c
885 * int strlen() c_library
886 * char * strcpy() c_library
887 * VOID unget() lklex.c
890 * The basep structure is created.
897 basep = (struct base *)
898 new (sizeof (struct base));
901 bsp->b_base = (struct base *)
902 new (sizeof (struct base));
906 bsp->b_strp = (char *) new (strlen(ip)+1);
907 strcpy(bsp->b_strp, ip);
910 /*)Function VOID setbas()
912 * The function setbas() scans the base address lines in hte
913 * basep structure, evaluates the arguments, and sets beginning
914 * address of the specified areas.
917 * int v expression value
918 * char id[] base id string
921 * area *ap Pointer to the current
923 * area *areap The pointer to the first
924 * area structure of a linked list
925 * base *basep The pointer to the first
927 * base *bsp Pointer to the current
929 * char *ip pointer into the REL file
931 * int lkerr error flag
934 * Addr_T expr() lkeval.c
935 * int fprintf() c_library
936 * VOID getid() lklex.c
937 * char getnb() lklex.c
938 * int symeq() lksym.c
941 * The base address of an area is set.
954 if (getnb() == '=') {
956 for (ap = areap; ap != NULL; ap = ap->a_ap) {
957 if (symeq(id, ap->a_id))
962 "ASlink-Warning-No definition of area %s\n", id);
966 ap->a_type = 1; /* JLH: value set */
969 fprintf(stderr, "ASlink-Warning-No '=' in base expression");
976 /*)Function VOID gblsav()
978 * The function gblsav() creates a linked structure containing
979 * the global variable strings input to the linker.
985 * globl *globlp The pointer to the first
987 * globl *gsp Pointer to the current
989 * char *ip pointer into the REL file
991 * int lkerr error flag
994 * char getnb() lklex.c
995 * VOID * new() lksym.c
996 * int strlen() c_library
997 * char * strcpy() c_library
998 * VOID unget() lklex.c
1001 * The globlp structure is created.
1007 if (globlp == NULL) {
1008 globlp = (struct globl *)
1009 new (sizeof (struct globl));
1012 gsp->g_globl = (struct globl *)
1013 new (sizeof (struct globl));
1017 gsp->g_strp = (char *) new (strlen(ip)+1);
1018 strcpy(gsp->g_strp, ip);
1021 /*)Function VOID setgbl()
1023 * The function setgbl() scans the global variable lines in hte
1024 * globlp structure, evaluates the arguments, and sets a variable
1028 * int v expression value
1029 * char id[] base id string
1030 * sym * sp pointer to a symbol structure
1033 * char *ip pointer into the REL file
1035 * globl *globlp The pointer to the first
1037 * globl *gsp Pointer to the current
1039 * FILE * stderr c_library
1040 * int lkerr error flag
1043 * Addr_T expr() lkeval.c
1044 * int fprintf() c_library
1045 * VOID getid() lklex.c
1046 * char getnb() lklex.c
1047 * sym * lkpsym() lksym.c
1050 * The value of a variable is set.
1057 register struct sym *sp;
1064 if (getnb() == '=') {
1069 "No definition of symbol %s\n", id);
1072 if (sp->s_flag & S_DEF) {
1074 "Redefinition of symbol %s\n", id);
1079 sp->s_type |= S_DEF;
1082 fprintf(stderr, "No '=' in global expression");
1089 /*)Function FILE * afile(fn,, ft, wf)
1091 * char * fn file specification string
1092 * char * ft file type string
1093 * int wf read(0)/write(1) flag
1095 * The function afile() opens a file for reading or writing.
1096 * (1) If the file type specification string ft
1097 * is not NULL then a file specification is
1098 * constructed with the file path\name in fn
1099 * and the extension in ft.
1100 * (2) If the file type specification string ft
1101 * is NULL then the file specification is
1102 * constructed from fn. If fn does not have
1103 * a file type then the default .rel file
1104 * type is appended to the file specification.
1106 * afile() returns a file handle for the opened file or aborts
1107 * the assembler on an open error.
1110 * char fb[] constructed file specification string
1111 * FILE * fp filehandle for opened file
1114 * int lkerr error flag
1117 * FILE * fopen() c_library
1118 * int fprintf() c_library
1121 * File is opened for read or write.
1131 char *omode = (wf ? (wf == 2 ? "a" : "w") : "r");
1134 /*Look backward the name path and get rid of the extension, if any*/
1136 for(; (fn[i]!='.')&&(fn[i]!='\\')&&(fn[i]!='/')&&(i>=0); i--);
1137 if( (fn[i]=='.') && strcmp(ft, "lnk") )
1147 /*Add the extension*/
1149 strcat(fb, strlen(ft)?ft:"rel");
1151 fp = fopen(fb, omode);
1154 if (strcmp(ft,"adb"))/*Do not complaint for optional adb files*/
1156 fprintf(stderr, "%s: cannot %s.\n", fb, wf?"create":"open");
1163 /*)Function VOID iramsav()
1165 * The function iramsav() stores the size of the chip's internal RAM.
1166 * This is used after linking to check that variable assignment to this
1167 * dataspace didn't overflow into adjoining segments. Variables in the
1168 * DSEG, OSEG, and ISEG are assigned to this dataspace.
1174 * char *ip pointer into the REL file
1176 * unsigned int size of chip's internal
1177 * iram_size RAM segment
1180 * char getnb() lklex.c
1181 * VOID unget() lklex.c
1182 * Addr_T expr() lkeval.c
1185 * The iram_size may be modified.
1193 //iram_size = atoi(ip);
1194 iram_size = expr(0); /* evaluate size expression */
1196 iram_size = 128; /* Default is 128 (0x80) bytes */
1199 /*Similar to iramsav but for xram memory*/
1205 xram_size = expr(0); /* evaluate size expression */
1207 xram_size = rflag?0x1000000:0x10000;
1210 /*Similar to iramsav but for code memory*/
1216 code_size = expr(0); /* evaluate size expression */
1218 code_size = rflag?0x1000000:0x10000;
1222 /*)Function VOID iramcheck()
1224 * The function iramcheck() is used at the end of linking to check that
1225 * the internal RAM area wasn't overflowed by too many variable
1226 * assignments. Variables in the DSEG, ISEG, and OSEG are assigned to
1227 * the chip's internal RAM.
1233 * unsigned int size of chip's internal
1234 * iram_size RAM segment
1235 * struct area linked list of memory
1246 register unsigned int last_addr;
1247 register struct area *ap;
1249 for (ap = areap; ap; ap=ap->a_ap) {
1250 if ((ap->a_size != 0) &&
1251 (!strcmp(ap->a_id, "DSEG") ||
1252 !strcmp(ap->a_id, "OSEG") ||
1253 !strcmp(ap->a_id, "ISEG")
1257 last_addr = ap->a_addr + ap->a_size - 1;
1258 if (last_addr >= iram_size)
1260 "\nWARNING! Segment %s extends past the end\n"
1261 " of internal RAM. Check map file.\n",
1269 " -c Command line input",
1270 " -f file[LNK] File input",
1271 " -p Prompt and echo of file[LNK] to stdout (default)",
1272 " -n No echo of file[LNK] to stdout",
1273 /* "Usage: [-Options] file [file ...]", */
1275 " -k Library path specification, one per -k",
1276 " -l Library file specification, one per -l",
1278 " -b area base address = expression",
1279 " -g global symbol = expression",
1281 " -m Map output generated as file[MAP]",
1282 " -x Hexadecimal (default), -d Decimal, -q Octal",
1284 " -i Intel Hex as file[IHX]",
1285 " -s Motorola S19 as file[S19]",
1286 " -j Produce NoICE debug as file[NOI]",
1287 " -z Produce SDCdb debug as file[cdb]",
1289 " -u Update listing file(s) with link data as file(s)[.RST]",
1291 " -a [iram-size] Check for internal RAM overflow",
1292 " -v [xram-size] Check for external RAM overflow",
1293 " -w [code-size] Check for code overflow",
1295 " -e or null line terminates input",
1299 /*)Function VOID usage()
1301 * The function usage() outputs to the stderr device the
1302 * assembler name and version and a list of valid assembler options.
1305 * char ** dp pointer to an array of
1306 * text string pointers.
1309 * FILE * stderr c_library
1312 * int fprintf() c_library
1323 fprintf(stderr, "\nASxxxx Linker %s\n\n", VERSION);
1324 for (dp = usetxt; *dp; dp++)
1325 fprintf(stderr, "%s\n", *dp);
1329 /*)Function VOID copyfile()
1331 * FILE *dest destination file
1332 * FILE *src source file
1334 * function will copy source file to destination file
1338 * int fgetc() c_library
1339 * int fputc() c_library
1344 VOID copyfile (dest,src)
1348 while ((ch = fgetc(src)) != EOF) {