1 /* dlltool.c -- tool to generate stuff for PE style DLLs
2 Copyright (C) 1995 Free Software Foundation, Inc.
4 This file is part of GNU Binutils.
6 This program 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 of the License, or
9 (at your option) any later version.
11 This program 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 this program; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
22 This program allows you to build the files necessary to create
23 DLLs to run on a system which understands PE format image files.
26 A DLL contains an export table which contains the information
27 which the runtime loader needs to tie up references from a
30 The export table is generated by this program by reading
31 in a .DEF file or scanning the .a and .o files which will be in the
32 DLL. A .o file can contain information in special ".drective" sections
33 with export information.
35 A DEF file contains any number of the following commands:
38 NAME <name> [ , <base> ]
39 The result is going to be <name>.EXE
41 LIBRARY <name> [ , <base> ]
42 The result is going to be <name>.DLL
44 EXPORTS ( <name1> [ = <name2> ] [ @ <integer> ] [ NONAME ] [CONSTANT] ) *
45 Declares name1 as an exported symbol from the
46 DLL, with optional ordinal number <integer>
48 IMPORTS ( [ <name> = ] <name> . <name> ) *
49 Ignored for compatibility
52 Puts <string> into output .exp file in the .rdata section
54 [STACKSIZE|HEAPSIZE] <number-reserve> [ , <number-commit> ]
55 Generates --stack|--heap <number-reserve>,<number-commit>
56 in the output .drective section. The linker will
57 see this and act upon it.
60 SECTIONS ( <sectionname> <attr>+ )*
61 <attr> = READ | WRITE | EXECUTE | SHARED
62 Generates --attr <sectionname> <attr> in the output
63 .drective section. The linker will see this and act
67 A -export:<name> in a .drective section in an input .o or .a
68 file to this program is equivalent to a EXPORTS <name>
73 The program generates output files with the prefix supplied
74 on the command line, or in the def file, or taken from the first
77 The output files are <prefix>-exp.s and <prefix>-lib.s
79 The .exp.s file contains the information necessary to export
80 the routines in the DLL. The .lib.s file contains the information
81 necessary to use the DLL's routines from a referencing program.
88 asm (".section .drectve");
89 asm (".ascii \"-export:adef\"");
93 printf("hello from the dll %s\n",s);
98 printf("hello from the dll and the other entry point %s\n",s);
102 asm (".section .drectve");
103 asm (".ascii \"-export:cdef\"");
104 asm (".ascii \"-export:ddef\"");
107 printf("hello from the dll %s\n",s);
112 printf("hello from the dll and the other entry point %s\n",s);
130 HEAPSIZE 0x40000, 0x2000
134 SECTIONS donkey READ WRITE
138 # compile up the parts of the dll
143 # put them in a library (you don't have to, you
144 # could name all the .os on the dlltool line)
146 ar qcv thedll.in file1.o file2.o
149 # run this tool over the library and the def file
150 ./dlltool -o thedll -d thedll.def thedll.in
152 # build the export table for the dll
153 as -o thedll.exp thedll-exp.s
154 # build the dll with the library with file1.o, file2.o and the export table
155 ld -o thedll.dll thedll.exp thedll.in
157 # build the import table for the executable
158 as -o thedll.lib thedll-lib.s
163 # link the executable with the import library
164 ld -e main -Tthemain.ld -o themain.exe themain.o thedll.lib
168 #define PAGE_SIZE 4096
169 #define PAGE_MASK (-PAGE_SIZE)
179 char *outfile_prefix;
189 static char *mname = "arm";
193 static char *mname = "i386";
195 #define PATHMAX 250 /* What's the right name for this ? */
197 char outfile[PATHMAX];
214 "arm", ".byte", ".short", ".long", ".asciz", "@", "ldr\tip,[pc]\n\tldr\tpc,[ip]\n\t.long", ".global", ".space"
218 "i386", ".byte", ".short", ".long", ".asciz", "#", "jmp *", ".global", ".space"
224 #define ASM_BYTE mtable[machine].how_byte
225 #define ASM_SHORT mtable[machine].how_short
226 #define ASM_LONG mtable[machine].how_long
227 #define ASM_TEXT mtable[machine].how_asciz
228 #define ASM_C mtable[machine].how_comment
229 #define ASM_JUMP mtable[machine].how_jump
230 #define ASM_GLOBAL mtable[machine].how_global
231 #define ASM_SPACE mtable[machine].how_space
238 FILE *yyin; /* communications with flex */
239 extern int linenumber;
241 process_def_file (name)
244 FILE *f = fopen (name, "r");
247 fprintf (stderr, "%s: Can't open def file %s\n", program_name, name);
256 /**********************************************************************/
258 /* Communications with the parser */
268 typedef struct export
279 static char *d_name; /* Arg to NAME or LIBRARY */
280 static int d_nfuncs; /* Number of functions exported */
281 static int d_ord; /* Base ordinal index */
282 static export_type *d_exports; /*list of exported functions */
283 static char *d_suffix = "dll";
284 static dlist_type *d_list; /* Descriptions */
285 static dlist_type *a_list; /* Stuff to go in directives */
292 fprintf (stderr, "%s: Syntax error in def file %s:%d\n",
293 program_name, def_file, linenumber);
297 def_exports (name, internal_name, ordinal, noname, constant)
304 struct export *p = (struct export *) xmalloc (sizeof (*p));
307 p->internal_name = internal_name ? internal_name : name;
308 p->ordinal = ordinal;
309 p->constant = constant;
318 def_name (name, base)
323 fprintf (stderr, "%s NAME %s base %x\n", program_name, name, base);
326 fprintf (stderr, "Can't have LIBRARY and NAME\n");
329 if (strchr (d_name, '.'))
330 d_suffix = strdup (strchr (d_name, '.') + 1);
335 def_library (name, base)
340 printf ("%s: LIBRARY %s base %x\n", program_name, name, base);
343 fprintf (stderr, "%s: Can't have LIBRARY and NAME\n", program_name);
346 if (strchr (d_name, '.'))
347 d_suffix = strdup (strchr (d_name, '.') + 1);
352 def_description (desc)
355 dlist_type *d = (dlist_type *) xmalloc (sizeof (dlist_type));
356 d->text = strdup (desc);
365 dlist_type *d = (dlist_type *) xmalloc (sizeof (dlist_type));
366 d->text = strdup (dir);
372 def_stacksize (reserve, commit)
378 sprintf (b, "-stack 0x%x,0x%x ", reserve, commit);
380 sprintf (b, "-stack 0x%x ", reserve);
381 new_directive (strdup (b));
385 def_heapsize (reserve, commit)
391 sprintf (b, "-heap 0x%x,0x%x ", reserve, commit);
393 sprintf (b, "-heap 0x%x ", reserve);
394 new_directive (strdup (b));
399 def_import (internal, module, entry)
405 fprintf (stderr, "%s: IMPORTS are ignored", program_name);
409 def_version (major, minor)
411 printf ("VERSION %d.%d\n", major, minor);
416 def_section (name, attr)
433 sprintf (buf, "-attr %s %s", name, atts);
434 new_directive (strdup (buf));
441 def_section ("CODE", attr);
448 def_section ("DATA", attr);
452 /**********************************************************************/
454 /* read in and block out the base relocations */
466 scan_open_obj_file (abfd)
469 /* Look for .drectives */
470 asection *s = bfd_get_section_by_name (abfd, ".drectve");
473 int size = bfd_get_section_size_before_reloc (s);
474 char *buf = xmalloc (size);
477 bfd_get_section_contents (abfd, s, buf, 0, size);
479 fprintf (stderr, "%s: Sucking in info from %s\n",
481 bfd_get_filename (abfd));
483 /* Search for -export: strings */
489 && strncmp (p, "-export:", 8) == 0)
495 while (*p != ' ' && *p != '-' && p < e)
497 c = xmalloc (p - name + 1);
498 memcpy (c, name, p - name);
500 def_exports (c, 0, -1, 0);
511 fprintf (stderr, "%s: Done readin\n",
518 scan_obj_file (filename)
521 bfd *f = bfd_openr (filename, 0);
525 fprintf (stderr, "%s: Unable to open object file %s\n",
530 if (bfd_check_format (f, bfd_archive))
532 bfd *arfile = bfd_openr_next_archived_file (f, 0);
535 if (bfd_check_format (arfile, bfd_object))
536 scan_open_obj_file (arfile);
538 arfile = bfd_openr_next_archived_file (f, arfile);
542 if (bfd_check_format (f, bfd_object))
544 scan_open_obj_file (f);
550 /**********************************************************************/
553 /* return the bit of the name before the last . */
560 char *res = strdup (name);
561 char *p = strrchr (res, '.');
573 fprintf (f, "%s ", ASM_C);
574 for (i = 0; oav[i]; i++)
575 fprintf (f, "%s ", oav[i]);
577 for (i = 0, exp = d_exports; exp; i++, exp = exp->next)
579 fprintf (f, "%s %d = %s %s @ %d %s%s\n",
585 exp->noname ? "NONAME " : "",
586 exp->constant ? "CONSTANT" : "");
589 /* Generate the .exp file */
600 flush_page (f, need, page_addr, on_page)
607 /* Flush this page */
608 fprintf (f, "\t%s\t0x%x\t%s Starting RVA for chunk\n",
612 fprintf (f, "\t%s\t0x%x\t%s Size of block\n",
614 (on_page * 2) + (on_page & 1) * 2 + 8,
616 for (i = 0; i < on_page; i++)
618 fprintf (f, "\t%s\t0x%x\n", ASM_SHORT, need[i] - page_addr | 0x3000);
622 fprintf (f, "\t%s\t0x%x\n", ASM_SHORT, 0 | 0x0000);
636 sprintf (outfile, "%s-exp.s", outfile_prefix);
639 fprintf (stderr, "%s: Generate exp file %s\n",
640 program_name, outfile_prefix);
642 f = fopen (outfile, "w");
645 fprintf (stderr, "%s: Unable to open output file %s\n", program_name, outfile);
650 fprintf (stderr, "%s: Opened file %s\n",
651 program_name, outfile);
655 fprintf (f, "\t.section .edata\n\n");
656 fprintf (f, "\t%s 0 %s Allways 0\n", ASM_LONG, ASM_C);
657 fprintf (f, "\t%s %d %s Time and date\n", ASM_LONG, time (0), ASM_C);
658 fprintf (f, "\t%s 0 %s Major and Minor version\n", ASM_LONG, ASM_C);
659 fprintf (f, "\t%s name %s Ptr to name of dll\n", ASM_LONG, ASM_C);
660 fprintf (f, "\t%s %d %s Starting ordinal of exports\n", ASM_LONG, d_ord, ASM_C);
661 fprintf (f, "\t%s The next field is documented as being the number of functions\n", ASM_C);
662 fprintf (f, "\t%s yet it doesn't look like that in real PE dlls\n", ASM_C);
663 fprintf (f, "\t%s But it shouldn't be a problem, causes there's\n", ASM_C);
664 fprintf (f, "\t%s always the number of names field\n", ASM_C);
665 fprintf (f, "\t%s %d %s Number of functions\n", ASM_LONG, d_nfuncs, ASM_C);
666 fprintf (f, "\t%s %d %s Number of names\n", ASM_LONG, d_nfuncs, ASM_C);
667 fprintf (f, "\t%s afuncs %s Address of functions\n", ASM_LONG, ASM_C);
668 fprintf (f, "\t%s anames %s Address of names\n", ASM_LONG, ASM_C);
669 fprintf (f, "\t%s anords %s Address of ordinals\n", ASM_LONG, ASM_C);
671 fprintf (f, "name: %s \"%s.%s\"\n", ASM_TEXT, outfile_prefix, d_suffix);
673 fprintf (f, "afuncs:\n");
675 for (exp = d_exports; exp; exp = exp->next)
678 /* This seems necessary in the doc, but in real
679 life it's not used.. */
680 if (exp->ordinal != i)
682 fprintf (f, "%s\t%s\t%d\t@ %d..%d missing\n", ASM_C, ASM_SPACE,
683 (exp->ordinal - i) * 4,
684 i, exp->ordinal - 1);
688 fprintf (f, "\t%s %s\t%s %d\n", ASM_LONG, exp->internal_name, ASM_C, exp->ordinal);
693 fprintf (f, "anames:\n");
694 for (i = 0, exp = d_exports; exp; i++, exp = exp->next)
699 fprintf (f, "\t%s nNoname\n", ASM_LONG, ASM_C);
703 fprintf (f, "\t%s n%d\n", ASM_LONG, i);
707 fprintf (f, "anords:\n");
708 for (exp = d_exports; exp; exp = exp->next)
709 fprintf (f, "\t%s %d\n", ASM_SHORT, exp->ordinal - d_ord);
711 for (i = 0, exp = d_exports; exp; i++, exp = exp->next)
713 fprintf (f, "@n%d: %s \"%s\"\n", i, ASM_TEXT, exp->name);
715 fprintf (f, "n%d: %s \"%s\"\n", i, ASM_TEXT, exp->name);
718 fprintf (f, "nNoname: %s \"__noname__\"\n", ASM_TEXT);
722 fprintf (f, "\t.section .drectve\n");
723 for (dl = a_list; dl; dl = dl->next)
725 fprintf (f, "\t%s\t\"%s\"\n", ASM_TEXT, dl->text);
730 fprintf (f, "\t.section .rdata\n");
731 for (dl = d_list; dl; dl = dl->next)
735 /* We dont output as ascii 'cause there can
736 be quote characters in the string */
739 for (p = dl->text; *p; p++)
742 fprintf (f, "\t%s\t", ASM_BYTE);
745 fprintf (f, "%d", *p);
760 /* Dump the reloc section if a base file is provided */
764 long need[PAGE_SIZE];
771 fprintf (f, "\t.section\t.reloc\n");
772 fseek (base_file, 0, SEEK_END);
773 numbytes = ftell (base_file);
774 fseek (base_file, 0, SEEK_SET);
775 copy = malloc (numbytes);
776 fread (copy, 1, numbytes, base_file);
777 num_entries = numbytes / sizeof (long);
779 qsort (copy, num_entries, sizeof (long), sfunc);
782 page_addr = addr & PAGE_MASK; /* work out the page addr */
784 for (j = 0; j < num_entries; j++)
787 if ((addr & PAGE_MASK) != page_addr)
789 flush_page (f, need, page_addr, on_page);
791 page_addr = addr & PAGE_MASK;
793 need[on_page++] = addr;
795 flush_page (f, need, page_addr, on_page);
812 p = strchr (name, '@');
819 /**********************************************************************/
826 sprintf (outfile, "%s-lib.s", outfile_prefix);
828 f = fopen (outfile, "w");
831 fprintf (stderr, "Unable to open output file %s\n", outfile);
837 fprintf (f, "\t.text\n");
838 fprintf (f, "%s Thunk table\n", ASM_C);
839 for (i = 0, exp = d_exports; exp; i++, exp = exp->next)
841 fprintf (f, "\t%s\t%s\n", ASM_GLOBAL, exp->name);
842 fprintf (f, "\t%s\t__imp_%s\n", ASM_GLOBAL, exp->name);
845 for (i = 0, exp = d_exports; exp; i++, exp = exp->next)
847 fprintf (f, "%s:\t%s\t__imp_%s\n", exp->name, ASM_JUMP, exp->name);
851 fprintf (f, "%s IMAGE_IMPORT_DESCRIPTOR\n", ASM_C);
852 fprintf (f, "\t.section .idata$2\n");
853 fprintf (f, "\t%s\thname\t%s Ptr to image import by name list\n", ASM_LONG, ASM_C);
854 fprintf (f, "\t%s\t%d\t%s time\n", ASM_LONG, time (0), ASM_C);
855 fprintf (f, "\t%s\t0\t%s Forwarder chain\n", ASM_LONG, ASM_C);
856 fprintf (f, "\t%s\tiname\t%s imported dll's name\n", ASM_LONG, ASM_C);
857 fprintf (f, "\t%s\tfthunk\t%s pointer to firstthunk\n", ASM_LONG, ASM_C);
859 fprintf (f, "%sStuff for compatibility\n", ASM_C);
860 fprintf (f, "\t.section\t.idata$3\n");
861 fprintf (f, "\t%s\t0\n", ASM_LONG);
862 fprintf (f, "\t%s\t0\n", ASM_LONG);
863 fprintf (f, "\t%s\t0\n", ASM_LONG);
864 fprintf (f, "\t%s\t0\n", ASM_LONG);
865 fprintf (f, "\t%s\t0\n", ASM_LONG);
866 fprintf (f, "\t.section\t.idata$5\n");
867 fprintf (f, "\t%s\t0\n", ASM_LONG);
869 fprintf (f, "\t.section\t.idata$4\n");
870 fprintf (f, "\t%s\t0\n", ASM_LONG);
872 fprintf (f, "\n%s Loader modifies this\n", ASM_C);
873 fprintf (f, "\t.section .idata$5\n");
874 fprintf (f, "fthunk:\n");
875 for (i = 0, exp = d_exports; exp; i++, exp = exp->next)
877 fprintf (f, "__imp_%s:\n", exp->name);
878 fprintf (f, "\t%s\tID%d\n", ASM_LONG, i);
880 fprintf (f, "\t%s\t0\n", ASM_LONG);
882 fprintf (f, "\n%s Hint name array\n", ASM_C);
883 fprintf (f, "\t.section .idata$4\n");
884 fprintf (f, "hname:\n");
885 for (i = 0, exp = d_exports; exp; i++, exp = exp->next)
887 fprintf (f, "\t%s\tID%d\n", ASM_LONG, i);
890 fprintf (f, "\t%s\t0\n", ASM_LONG);
891 fprintf (f, "%s Hint/name array storage and import dll name\n", ASM_C);
892 fprintf (f, "\t.section .idata$6\n");
894 for (i = 0, exp = d_exports; exp; i++, exp = exp->next)
896 fprintf (f, "ID%d:\t%s\t%d\n", i, ASM_SHORT, exp->ordinal);
897 fprintf (f, "\t%s\t\"%s\"\n", ASM_TEXT, xlate (exp->name));
899 fprintf (f, "\t%s\t0\n", ASM_LONG);
900 fprintf (f, "iname:\t%s\t\"%s.%s\"\n", ASM_TEXT, outfile_prefix, d_suffix);
903 /**********************************************************************/
905 /* Run through the information gathered from the .o files and the
906 .def file and work out the best stuff */
912 export_type *ap = *(export_type **) a;
913 export_type *bp = *(export_type **) b;
914 if (ap->ordinal == bp->ordinal)
917 /* unset ordinals go to the bottom */
918 if (ap->ordinal == -1)
920 if (bp->ordinal == -1)
922 return (ap->ordinal - bp->ordinal);
931 export_type *ap = *(export_type **) a;
932 export_type *bp = *(export_type **) b;
934 return (strcmp (ap->name, bp->name));
939 remove_null_names (ptr)
944 for (dst = src = 0; src < d_nfuncs; src++)
961 for (i = 0; i < d_nfuncs; i++)
965 printf ("%d %s @ %d %s%s\n",
966 i, ptr[i]->name, ptr[i]->ordinal,
967 ptr[i]->noname ? "NONAME " : "",
968 ptr[i]->constant ? "CONSTANT" : "");
977 process_duplicates (d_export_vec)
978 export_type **d_export_vec;
985 /* Remove duplicates */
986 qsort (d_export_vec, d_nfuncs, sizeof (export_type *), nfunc);
989 for (i = 0; i < d_nfuncs - 1; i++)
991 if (strcmp (d_export_vec[i]->name,
992 d_export_vec[i + 1]->name) == 0)
995 export_type *a = d_export_vec[i];
996 export_type *b = d_export_vec[i + 1];
1000 fprintf (stderr, "Warning, ignoring duplicate EXPORT %s %d,%d\n",
1004 if (a->ordinal != -1
1005 && b->ordinal != -1)
1008 fprintf (stderr, "Error, duplicate EXPORT with oridinals %s\n",
1012 /* Merge attributes */
1013 b->ordinal = a->ordinal > 0 ? a->ordinal : b->ordinal;
1014 b->constant |= a->constant;
1015 b->noname |= a->noname;
1016 d_export_vec[i] = 0;
1019 dtab (d_export_vec);
1020 remove_null_names (d_export_vec);
1021 dtab (d_export_vec);
1027 fill_ordinals (d_export_vec)
1028 export_type **d_export_vec;
1033 qsort (d_export_vec, d_nfuncs, sizeof (export_type *), pfunc);
1035 /* fill in the unset ordinals with ones from our range */
1037 ptr = (char *) malloc (65536);
1039 memset (ptr, 65536, 0);
1041 /* Mark in our large vector all the numbers that are taken */
1042 for (i = 0; i < d_nfuncs; i++)
1044 if (d_export_vec[i]->ordinal != -1)
1046 ptr[d_export_vec[i]->ordinal] = 1;
1048 lowest = d_export_vec[i]->ordinal;
1052 for (i = 0; i < d_nfuncs; i++)
1054 if (d_export_vec[i]->ordinal == -1)
1057 for (j = lowest; j < 65536; j++)
1061 d_export_vec[i]->ordinal = j;
1065 for (j = 1; j < lowest; j++)
1069 d_export_vec[i]->ordinal = j;
1081 qsort (d_export_vec, d_nfuncs, sizeof (export_type *), pfunc);
1083 /* Work out the lowest ordinal number */
1084 if (d_export_vec[0])
1085 d_ord = d_export_vec[0]->ordinal;
1090 /* First work out the minimum ordinal chosen */
1095 export_type **d_export_vec
1096 = (export_type **) xmalloc (sizeof (export_type *) * d_nfuncs);
1098 for (i = 0, exp = d_exports; exp; i++, exp = exp->next)
1100 d_export_vec[i] = exp;
1103 process_duplicates (d_export_vec);
1104 fill_ordinals (d_export_vec);
1106 /* Put back the list in the new order */
1108 for (i = d_nfuncs - 1; i >= 0; i--)
1110 d_export_vec[i]->next = d_exports;
1111 d_exports = d_export_vec[i];
1116 /**********************************************************************/
1119 usage (file, status)
1123 fprintf (file, "Usage %s <options> <object-files>\n", program_name);
1124 fprintf (file, "\t -m <machine> Generate code for <machine>\n");
1125 fprintf (file, "\t --machine <machine>\n");
1126 fprintf (file, "\t -o <outprefix> Set output prefix\n");
1127 fprintf (file, "\t -d <deffile> Name input .def file\n");
1128 fprintf (file, "\t --def <deffile> \n");
1129 fprintf (file, "\t --base-file <basefile> Read linker generated base file\n");
1130 fprintf (file, "\t -b <basefile> \n");
1131 fprintf (file, "\t -v Verbose\n");
1132 fprintf (file, "\t -u Remove leading underscore from .lib\n");
1133 fprintf (file, "\t -k Kill @<n> from exported names\n");
1137 static struct option long_options[] =
1139 {"def", required_argument, NULL, 'd'},
1140 {"underscore", no_argument, NULL, 'u'},
1141 {"killat", no_argument, NULL, 'k'},
1142 {"help", no_argument, NULL, 'h'},
1143 {"machine", required_argument, NULL, 'm'},
1144 {"base-file", required_argument, NULL, 'b'},
1155 program_name = av[0];
1158 while ((c = getopt_long (ac, av, "kvbuh?m:o:Dd:", long_options, 0)) != EOF)
1170 outfile_prefix = optarg;
1188 base_file = fopen (optarg, "r");
1191 fprintf (stderr, "%s: Unable to open base-file %s\n",
1203 for (i = 0; mtable[i].type; i++)
1205 if (strcmp (mtable[i].type, mname) == 0)
1209 if (!mtable[i].type)
1211 fprintf (stderr, "Machine not supported\n");
1219 process_def_file (def_file);
1224 firstarg = av[optind];
1225 scan_obj_file (av[optind]);
1229 if (!outfile_prefix)
1232 outfile_prefix = d_name;
1234 outfile_prefix = def_file;
1236 outfile_prefix = firstarg;
1239 fprintf (stderr, "No way to create an output filename\n");
1243 outfile_prefix = prefix (outfile_prefix);
1246 fprintf (stderr, "%s: Outfile prefix is %s\n",
1247 program_name, outfile_prefix);