annotate lwlink/lwlink.h @ 167:751b99efb1fc

Updated docs
author lost
date Sat, 31 Jan 2009 18:59:40 +0000
parents 106c2fe3c9d9
children d610b8aef91b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
112
a567dbb3f1d4 command line options
lost
parents:
diff changeset
1 /*
a567dbb3f1d4 command line options
lost
parents:
diff changeset
2 lwlink.h
118
d450943305a7 Fixed copyright year
lost
parents: 117
diff changeset
3 Copyright © 2009 William Astle
112
a567dbb3f1d4 command line options
lost
parents:
diff changeset
4
a567dbb3f1d4 command line options
lost
parents:
diff changeset
5 This file is part of LWLINK.
a567dbb3f1d4 command line options
lost
parents:
diff changeset
6
a567dbb3f1d4 command line options
lost
parents:
diff changeset
7 LWLINK is free software: you can redistribute it and/or modify it under the
a567dbb3f1d4 command line options
lost
parents:
diff changeset
8 terms of the GNU General Public License as published by the Free Software
a567dbb3f1d4 command line options
lost
parents:
diff changeset
9 Foundation, either version 3 of the License, or (at your option) any later
a567dbb3f1d4 command line options
lost
parents:
diff changeset
10 version.
a567dbb3f1d4 command line options
lost
parents:
diff changeset
11
a567dbb3f1d4 command line options
lost
parents:
diff changeset
12 This program is distributed in the hope that it will be useful, but WITHOUT
a567dbb3f1d4 command line options
lost
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
a567dbb3f1d4 command line options
lost
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
a567dbb3f1d4 command line options
lost
parents:
diff changeset
15 more details.
a567dbb3f1d4 command line options
lost
parents:
diff changeset
16
a567dbb3f1d4 command line options
lost
parents:
diff changeset
17 You should have received a copy of the GNU General Public License along with
a567dbb3f1d4 command line options
lost
parents:
diff changeset
18 this program. If not, see <http://www.gnu.org/licenses/>.
a567dbb3f1d4 command line options
lost
parents:
diff changeset
19
a567dbb3f1d4 command line options
lost
parents:
diff changeset
20 Contains the main defs used by the linker
a567dbb3f1d4 command line options
lost
parents:
diff changeset
21 */
a567dbb3f1d4 command line options
lost
parents:
diff changeset
22
a567dbb3f1d4 command line options
lost
parents:
diff changeset
23
a567dbb3f1d4 command line options
lost
parents:
diff changeset
24 #ifndef __lwlink_h_seen__
a567dbb3f1d4 command line options
lost
parents:
diff changeset
25 #define __lwlink_h_seen__
a567dbb3f1d4 command line options
lost
parents:
diff changeset
26
116
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
27 #include "expr.h"
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
28
112
a567dbb3f1d4 command line options
lost
parents:
diff changeset
29 #define OUTPUT_DECB 0 // DECB multirecord format
a567dbb3f1d4 command line options
lost
parents:
diff changeset
30 #define OUTPUT_RAW 1 // raw sequence of bytes
a567dbb3f1d4 command line options
lost
parents:
diff changeset
31
116
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
32 typedef struct symtab_s symtab_t;
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
33 struct symtab_s
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
34 {
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
35 unsigned char *sym; // symbol name
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
36 int offset; // local offset
120
36ce328df3c3 resolve incomplete references done
lost
parents: 119
diff changeset
37 // int realval; // resolved value
116
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
38 symtab_t *next; // next symbol
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
39 };
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
40
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
41 typedef struct reloc_s reloc_t;
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
42 struct reloc_s
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
43 {
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
44 int offset; // where in the section
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
45 lw_expr_stack_t *expr; // the expression to calculate it
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
46 reloc_t *next; // ptr to next relocation
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
47 };
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
48
119
8bc00221ae89 section order and address resolution done
lost
parents: 118
diff changeset
49 typedef struct fileinfo_s fileinfo_t;
8bc00221ae89 section order and address resolution done
lost
parents: 118
diff changeset
50
116
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
51 #define SECTION_BSS 1
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
52 typedef struct
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
53 {
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
54 unsigned char *name; // name of the section
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
55 int flags; // section flags
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
56 int codesize; // size of the code
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
57 unsigned char *code; // pointer to the code
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
58 int loadaddress; // the actual load address of the section
119
8bc00221ae89 section order and address resolution done
lost
parents: 118
diff changeset
59 int processed; // was the section processed yet?
8bc00221ae89 section order and address resolution done
lost
parents: 118
diff changeset
60
116
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
61 symtab_t *localsyms; // local symbol table
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
62 symtab_t *exportedsyms; // exported symbols table
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
63
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
64 reloc_t *incompletes; // table of incomplete references
119
8bc00221ae89 section order and address resolution done
lost
parents: 118
diff changeset
65
8bc00221ae89 section order and address resolution done
lost
parents: 118
diff changeset
66 fileinfo_t *file; // the file we are in
116
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
67 } section_t;
115
776d8bea5b46 implement reading files
lost
parents: 114
diff changeset
68
119
8bc00221ae89 section order and address resolution done
lost
parents: 118
diff changeset
69 struct fileinfo_s
115
776d8bea5b46 implement reading files
lost
parents: 114
diff changeset
70 {
776d8bea5b46 implement reading files
lost
parents: 114
diff changeset
71 char *filename;
776d8bea5b46 implement reading files
lost
parents: 114
diff changeset
72 unsigned char *filedata;
776d8bea5b46 implement reading files
lost
parents: 114
diff changeset
73 long filesize;
116
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
74 section_t *sections;
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
75 int nsections;
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
76
119
8bc00221ae89 section order and address resolution done
lost
parents: 118
diff changeset
77 };
115
776d8bea5b46 implement reading files
lost
parents: 114
diff changeset
78
121
7bc853cb2ca9 Added simplistic output module for DECB target
lost
parents: 120
diff changeset
79 struct section_list
7bc853cb2ca9 Added simplistic output module for DECB target
lost
parents: 120
diff changeset
80 {
7bc853cb2ca9 Added simplistic output module for DECB target
lost
parents: 120
diff changeset
81 section_t *ptr; // ptr to section structure
7bc853cb2ca9 Added simplistic output module for DECB target
lost
parents: 120
diff changeset
82 int forceaddr; // was this force to an address by the link script?
7bc853cb2ca9 Added simplistic output module for DECB target
lost
parents: 120
diff changeset
83 };
7bc853cb2ca9 Added simplistic output module for DECB target
lost
parents: 120
diff changeset
84
7bc853cb2ca9 Added simplistic output module for DECB target
lost
parents: 120
diff changeset
85 #ifndef __link_c_seen__
7bc853cb2ca9 Added simplistic output module for DECB target
lost
parents: 120
diff changeset
86 extern struct section_list *sectlist;
7bc853cb2ca9 Added simplistic output module for DECB target
lost
parents: 120
diff changeset
87 extern int nsects;
7bc853cb2ca9 Added simplistic output module for DECB target
lost
parents: 120
diff changeset
88 #endif
116
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
89
817ab0e124fa reading files implemented
lost
parents: 115
diff changeset
90
112
a567dbb3f1d4 command line options
lost
parents:
diff changeset
91 #ifndef __lwlink_c_seen__
a567dbb3f1d4 command line options
lost
parents:
diff changeset
92
a567dbb3f1d4 command line options
lost
parents:
diff changeset
93 extern int debug_level;
a567dbb3f1d4 command line options
lost
parents:
diff changeset
94 extern int outformat;
a567dbb3f1d4 command line options
lost
parents:
diff changeset
95 extern char *outfile;
114
c65fcec346cd Handle input files on command line and add some memory management utility functions
lost
parents: 112
diff changeset
96 extern int ninputfiles;
115
776d8bea5b46 implement reading files
lost
parents: 114
diff changeset
97 extern fileinfo_t **inputfiles;
117
bb3cc989e84b parse linking scripts
lost
parents: 116
diff changeset
98 extern char *scriptfile;
112
a567dbb3f1d4 command line options
lost
parents:
diff changeset
99
114
c65fcec346cd Handle input files on command line and add some memory management utility functions
lost
parents: 112
diff changeset
100 #define __lwlink_E__ extern
c65fcec346cd Handle input files on command line and add some memory management utility functions
lost
parents: 112
diff changeset
101 #else
c65fcec346cd Handle input files on command line and add some memory management utility functions
lost
parents: 112
diff changeset
102 #define __lwlink_E__
112
a567dbb3f1d4 command line options
lost
parents:
diff changeset
103 #endif // __lwlink_c_seen__
a567dbb3f1d4 command line options
lost
parents:
diff changeset
104
114
c65fcec346cd Handle input files on command line and add some memory management utility functions
lost
parents: 112
diff changeset
105 __lwlink_E__ void add_input_file(char *fn);
c65fcec346cd Handle input files on command line and add some memory management utility functions
lost
parents: 112
diff changeset
106
c65fcec346cd Handle input files on command line and add some memory management utility functions
lost
parents: 112
diff changeset
107 #undef __lwlink_E__
117
bb3cc989e84b parse linking scripts
lost
parents: 116
diff changeset
108
bb3cc989e84b parse linking scripts
lost
parents: 116
diff changeset
109 struct scriptline_s
bb3cc989e84b parse linking scripts
lost
parents: 116
diff changeset
110 {
bb3cc989e84b parse linking scripts
lost
parents: 116
diff changeset
111 char *sectname; // name of section, NULL for wildcard
bb3cc989e84b parse linking scripts
lost
parents: 116
diff changeset
112 int loadat; // address to load at (or -1)
bb3cc989e84b parse linking scripts
lost
parents: 116
diff changeset
113 int noflags; // flags to NOT have
bb3cc989e84b parse linking scripts
lost
parents: 116
diff changeset
114 int yesflags; // flags to HAVE
bb3cc989e84b parse linking scripts
lost
parents: 116
diff changeset
115 };
bb3cc989e84b parse linking scripts
lost
parents: 116
diff changeset
116
bb3cc989e84b parse linking scripts
lost
parents: 116
diff changeset
117 typedef struct
bb3cc989e84b parse linking scripts
lost
parents: 116
diff changeset
118 {
bb3cc989e84b parse linking scripts
lost
parents: 116
diff changeset
119 int nlines; // number of lines in the script
bb3cc989e84b parse linking scripts
lost
parents: 116
diff changeset
120 struct scriptline_s *lines; // the parsed script lines (section)
bb3cc989e84b parse linking scripts
lost
parents: 116
diff changeset
121 int padsize; // the size to pad to, -1 for none
121
7bc853cb2ca9 Added simplistic output module for DECB target
lost
parents: 120
diff changeset
122 char *execsym; // entry point symbol
7bc853cb2ca9 Added simplistic output module for DECB target
lost
parents: 120
diff changeset
123 int execaddr; // execution address (entry point)
117
bb3cc989e84b parse linking scripts
lost
parents: 116
diff changeset
124 } linkscript_t;
bb3cc989e84b parse linking scripts
lost
parents: 116
diff changeset
125
bb3cc989e84b parse linking scripts
lost
parents: 116
diff changeset
126 #ifndef __script_c_seen__
bb3cc989e84b parse linking scripts
lost
parents: 116
diff changeset
127 extern linkscript_t linkscript;
bb3cc989e84b parse linking scripts
lost
parents: 116
diff changeset
128 #endif
bb3cc989e84b parse linking scripts
lost
parents: 116
diff changeset
129
112
a567dbb3f1d4 command line options
lost
parents:
diff changeset
130 #endif //__lwlink_h_seen__