]> git.sur5r.net Git - cc65/blob - doc/ld65.sgml
Moved GEOS VLIR assembler sample from 'samples' to 'testcode' because:
[cc65] / doc / ld65.sgml
1 <!doctype linuxdoc system>
2
3 <article>
4 <title>ld65 Users Guide
5 <author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org">
6 <date>02.12.2000, 02.10.2001
7
8 <abstract>
9 The ld65 linker combines object files into an executable file. ld65 is highly
10 configurable and uses configuration files for high flexibility.
11 </abstract>
12
13 <!-- Table of contents -->
14 <toc>
15
16 <!-- Begin the document -->
17
18 <sect>Overview<p>
19
20 The ld65 linker combines several object modules created by the ca65
21 assembler, producing an executable file. The object modules may be read
22 from a library created by the ar65 archiver (this is somewhat faster and
23 more convenient). The linker was designed to be as flexible as possible.
24 It complements the features that are built into the ca65 macroassembler:
25
26 <itemize>
27
28 <item>  Accept any number of segments to form an executable module.
29
30 <item>  Resolve arbitrary expressions stored in the object files.
31
32 <item>  In case of errors, use the meta information stored in the object files
33         to produce helpful error messages. In case of undefined symbols,
34         expression range errors, or symbol type mismatches, ld65 is able to
35         tell you the exact location in the original assembler source, where
36         the symbol was referenced.
37
38 <item>  Flexible output. The output of ld65 is highly configurable by a config
39         file. More common platforms are supported by builtin configurations
40         that may be activated by naming the target system. The output
41         generation was designed with different output formats in mind, so
42         adding other formats shouldn't be a great problem.
43
44 </itemize>
45
46
47 <sect>Usage<p>
48
49
50 <sect1>Command line option overview<p>
51
52 The linker is called as follows:
53
54 <tscreen><verb>
55 ---------------------------------------------------------------------------
56 Usage: ld65 [options] module ...
57 Short options:
58   -(                    Start a library group
59   -)                    End a library group
60   -C name               Use linker config file
61   -D sym=val            Define a symbol
62   -L path               Specify a library search path
63   -Ln name              Create a VICE label file
64   -S addr               Set the default start address
65   -V                    Print the linker version
66   -h                    Help (this text)
67   -m name               Create a map file
68   -o name               Name the default output file
69   -t sys                Set the target system
70   -u sym                Force an import of symbol `sym'
71   -v                    Verbose mode
72   -vm                   Verbose map file
73
74 Long options:
75   --cfg-path path       Specify a config file search path
76   --config name         Use linker config file
77   --dbgfile name        Generate debug information
78   --define sym=val      Define a symbol
79   --dump-config name    Dump a builtin configuration
80   --end-group           End a library group
81   --force-import sym    Force an import of symbol `sym'
82   --help                Help (this text)
83   --lib file            Link this library
84   --lib-path path       Specify a library search path
85   --mapfile name        Create a map file
86   --module-id id        Specify a module id
87   --obj file            Link this object file
88   --obj-path path       Specify an object file search path
89   --start-addr addr     Set the default start address
90   --start-group         Start a library group
91   --target sys          Set the target system
92   --version             Print the linker version
93 ---------------------------------------------------------------------------
94 </verb></tscreen>
95
96
97 <sect1>Command line options in detail<p>
98
99 Here is a description of all the command line options:
100
101 <descrip>
102
103   <label id="option--start-group">
104   <tag><tt>-(, --start-group</tt></tag>
105
106   Start a library group. The libraries specified within a group are searched
107   multiple times to resolve crossreferences within the libraries. Normally,
108   crossreferences are only resolved within a library, that is the library is
109   searched multiple times. Libraries specified later on the command line
110   cannot reference otherwise unreferenced symbols in libraries specified
111   earlier, because the linker has already handled them. Library groups are
112   a solution for this problem, because the linker will search repeatedly
113   through all libraries specified in the group, until all possible open
114   symbol references have been satisfied.
115
116
117   <tag><tt>-), --end-group</tt></tag>
118
119   End a library group. See the explanation of the <tt><ref
120   id="option--start-group" name="--start-group"></tt> option.
121
122
123   <tag><tt>-h, --help</tt></tag>
124
125   Print the short option summary shown above.
126
127
128   <label id="option-m">
129   <tag><tt>-m name, --mapfile name</tt></tag>
130
131   This option (which needs an argument that will used as a filename for
132   the generated map file) will cause the linker to generate a map file.
133   The map file does contain a detailed overview over the modules used, the
134   sizes for the different segments, and a table containing exported
135   symbols.
136
137
138   <label id="option-o">
139   <tag><tt>-o name</tt></tag>
140
141   The -o switch is used to give the name of the default output file.
142   Depending on your output configuration, this name may NOT be used as
143   name for the output file. However, for the builtin configurations, this
144   name is used for the output file name.
145
146
147   <label id="option-t">
148   <tag><tt>-t sys, --target sys</tt></tag>
149
150   The argument for the -t switch is the name of the target system. Since this
151   switch will activate a builtin configuration, it may not be used together
152   with the <tt><ref id="option-C" name="-C"></tt> option. The following target
153   systems are currently supported:
154
155   <itemize>
156   <item>none
157   <item>module
158   <item>apple2
159   <item>apple2enh
160   <item>atari
161   <item>atmos
162   <item>c16 (works also for the c116 with memory up to 32K)
163   <item>c64
164   <item>c128
165   <item>plus4
166   <item>cbm510 (CBM-II series with 40 column video)
167   <item>cbm610 (all CBM series-II computers with 80 column video)
168   <item>pet (all CBM PET systems except the 2001)
169   <item>geos
170   <item>lunix
171   <item>nes
172   <item>supervision
173   </itemize>
174
175   There are a few more targets defined but neither of them is actually
176   supported.
177
178
179   <tag><tt>-u sym[:addrsize], --force-import sym[:addrsize]</tt></tag>
180
181   Force an import of a symbol. While object files are always linked to the
182   output file, regardless if there are any references, object modules from
183   libraries get only linked in if an import can be satisfied by this module.
184   The <tt/--fore-import/ option may be used to add a reference to a symbol and
185   as a result force linkage of the module that exports the identifier.
186
187   The name of the symbol may optionally be followed by a colon and an address
188   size specifier. If no address size is specified, the default address size
189   for the target machine is used.
190
191   Please note that the symbol name needs to have the internal representation,
192   meaning you have to prepend an underline for C identifiers.
193
194
195   <label id="option-v">
196   <tag><tt>-v, --verbose</tt></tag>
197
198   Using the -v option, you may enable more output that may help you to
199   locate problems. If an undefined symbol is encountered, -v causes the
200   linker to print a detailed list of the references (that is, source file
201   and line) for this symbol.
202
203
204   <tag><tt>-vm</tt></tag>
205
206   Must be used in conjunction with <tt><ref id="option-m" name="-m"></tt>
207   (generate map file). Normally the map file will not include empty segments
208   and sections, or unreferenced symbols. Using this option, you can force the
209   linker to include all this information into the map file.
210
211
212   <label id="option-C">
213   <tag><tt>-C</tt></tag>
214
215   This gives the name of an output config file to use. See section 4 for more
216   information about config files. -C may not be used together with <tt><ref
217   id="option-t" name="-t"></tt>.
218
219
220   <label id="option-D">
221   <tag><tt>-D sym=value, --define sym=value</tt></tag>
222
223   This option allows to define an external symbol on the command line. Value
224   may start with a '&dollar;' sign or with <tt/0x/ for hexadecimal values,
225   otherwise a leading zero denotes octal values. See also the <ref
226   id="SYMBOLS" name="SYMBOLS section"> in the configuration file.
227
228
229   <label id="option--lib-path">
230   <tag><tt>-L path, --lib-path path</tt></tag>
231
232   Specify a library search path. This option may be used more than once. It
233   adds a directory to the search path for library files. Libraries specified
234   without a path are searched in current directory, in the directory given in
235   the <tt/LD65_LIB/ environment variable, and in the list of directories
236   specified using <tt/--lib-path/.
237
238
239   <tag><tt>-Ln</tt></tag>
240
241   This option allows you to create a file that contains all global labels and
242   may be loaded into VICE emulator using the <tt/ll/ (load label) command. You
243   may use this to debug your code with VICE. Note: Older versions had some
244   bugs in the label code. If you have problems, please get the latest VICE
245   version.
246
247
248   <label id="option-S">
249   <tag><tt>-S addr, --start-addr addr</tt></tag>
250
251   Using -S you may define the default starting address. If and how this
252   address is used depends on the config file in use. For the builtin
253   configurations, only the "none", "apple2" and "apple2enh" systems honor an
254   explicit start address, all other builtin config provide their own.
255
256
257   <tag><tt>-V, --version</tt></tag>
258
259   This option print the version number of the linker. If you send any
260   suggestions or bugfixes, please include this number.
261
262
263   <label id="option--cfg-path">
264   <tag><tt>--cfg-path path</tt></tag>
265
266   Specify a config file search path. This option may be used more than once.
267   It adds a directory to the search path for config files. A config file given
268   with the <tt><ref id="option-C" name="-C"></tt> option that has no path in
269   its name is searched in the current directory, in the directory given in the
270   <tt/LD65_CFG/ environment variable, and in the list of directories specified
271   using <tt/--cfg-path/.
272
273
274   <label id="option--dbgfile">
275   <tag><tt>--dbgfile name</tt></tag>
276
277   Specify an output file for debug information. Available information will be
278   written to this file. Using the <tt/-g/ option for the compiler and assembler
279   will increase the amount of information available. Please note that debug
280   information generation is currently being developed, so the format of the
281   file and its contents are subject to change without further notice.
282
283
284   <tag><tt>--lib file</tt></tag>
285
286   Links a library to the output. Use this command line option instead of just
287   naming the library file, if the linker is not able to determine the file
288   type because of an unusual extension.
289
290
291   <tag><tt>--obj file</tt></tag>
292
293   Links an object file to the output. Use this command line option instead
294   of just naming the object file, if the linker is not able to determine the
295   file type because of an unusual extension.
296
297
298   <label id="option--obj-path">
299   <tag><tt>--obj-path path</tt></tag>
300
301   Specify an object file search path. This option may be used more than once.
302   It adds a directory to the search path for object files. An object file
303   passed to the linker that has no path in its name is searched in current
304   directory, in the directory given in the <tt/LD65_OBJ/ environment variable,
305   and in the list of directories specified using <tt/--obj-path/.
306
307 </descrip>
308
309
310
311 <sect>Search paths<p>
312
313 Starting with version 2.10 there are now several search paths for files needed
314 by the linker: One for libraries, one for object files and one for config
315 files.
316
317
318 <sect1>Library search path<p>
319
320 The library search path contains in this order:
321
322 <enum>
323 <item>The current directory.
324 <item>A compiled in library path which is often <tt>/usr/lib/cc65/lib</tt> on
325       Linux systems.
326 <item>The value of the environment variable <tt/LD65_LIB/ if it is defined.
327 <item>A subdirectory named <tt/lib/ of the directory defined in the environment
328       variable <tt/CC65_HOME/, if it is defined.
329 <item>Any directory added with the <tt><ref id="option--lib-path"
330       name="--lib-path"></tt> option on the command line.
331 </enum>
332
333
334 <sect1>Object file search path<p>
335
336 The object file search path contains in this order:
337
338 <enum>
339 <item>The current directory.
340 <item>A compiled in directory which is often <tt>/usr/lib/cc65/obj</tt> on
341       Linux systems.
342 <item>The value of the environment variable <tt/LD65_OBJ/ if it is defined.
343 <item>A subdirectory named <tt/obj/ of the directory defined in the environment
344       variable <tt/CC65_HOME/, if it is defined.
345 <item>Any directory added with the <tt><ref id="option--obj-path"
346       name="--obj-path"></tt> option on the command line.
347 </enum>
348
349
350 <sect1>Config file search path<p>
351
352 The config file search path contains in this order:
353
354 <enum>
355 <item>The current directory.
356 <item>A compiled in directory which is often <tt>/usr/lib/cc65/cfg</tt> on
357       Linux systems.
358 <item>The value of the environment variable <tt/LD65_CFG/ if it is defined.
359 <item>A subdirectory named <tt/cfg/ of the directory defined in the environment
360       variable <tt/CC65_HOME/, if it is defined.
361 <item>Any directory added with the <tt><ref id="option--cfg-path"
362       name="--cfg-path"></tt> option on the command line.
363 </enum>
364
365
366
367 <sect>Detailed workings<p>
368
369 The linker does several things when combining object modules:
370
371 First, the command line is parsed from left to right. For each object file
372 encountered (object files are recognized by a magic word in the header, so
373 the linker does not care about the name), imported and exported
374 identifiers are read from the file and inserted in a table. If a library
375 name is given (libraries are also recognized by a magic word, there are no
376 special naming conventions), all modules in the library are checked if an
377 export from this module would satisfy an import from other modules. All
378 modules where this is the case are marked. If duplicate identifiers are
379 found, the linker issues a warning.
380
381 This procedure (parsing and reading from left to right) does mean, that a
382 library may only satisfy references for object modules (given directly or from
383 a library) named <em/before/ that library. With the command line
384
385 <tscreen><verb>
386         ld65 crt0.o clib.lib test.o
387 </verb></tscreen>
388
389 the module test.o may not contain references to modules in the library
390 clib.lib. If this is the case, you have to change the order of the modules
391 on the command line:
392
393 <tscreen><verb>
394         ld65 crt0.o test.o clib.lib
395 </verb></tscreen>
396
397 Step two is, to read the configuration file, and assign start addresses
398 for the segments and define any linker symbols (see <ref id="config-files"
399 name="Configuration files">).
400
401 After that, the linker is ready to produce an output file. Before doing that,
402 it checks its data for consistency. That is, it checks for unresolved
403 externals (if the output format is not relocatable) and for symbol type
404 mismatches (for example a zero page symbol is imported by a module as absolute
405 symbol).
406
407 Step four is, to write the actual target files. In this step, the linker will
408 resolve any expressions contained in the segment data. Circular references are
409 also detected in this step (a symbol may have a circular reference that goes
410 unnoticed if the symbol is not used).
411
412 Step five is to output a map file with a detailed list of all modules,
413 segments and symbols encountered.
414
415 And, last step, if you give the <tt><ref id="option-v" name="-v"></tt> switch
416 twice, you get a dump of the segment data. However, this may be quite
417 unreadable if you're not a developer:-)
418
419
420
421 <sect>Configuration files<label id="config-files"><p>
422
423 Configuration files are used to describe the layout of the output file(s). Two
424 major topics are covered in a config file: The memory layout of the target
425 architecture, and the assignment of segments to memory areas. In addition,
426 several other attributes may be specified.
427
428 Case is ignored for keywords, that is, section or attribute names, but it is
429 <em/not/ ignored for names and strings.
430
431
432
433 <sect1>Memory areas<p>
434
435 Memory areas are specified in a <tt/MEMORY/ section. Lets have a look at an
436 example (this one describes the usable memory layout of the C64):
437
438 <tscreen><verb>
439         MEMORY {
440             RAM1:  start = $0800, size = $9800;
441             ROM1:  start = $A000, size = $2000;
442             RAM2:  start = $C000, size = $1000;
443             ROM2:  start = $E000, size = $2000;
444         }
445 </verb></tscreen>
446
447 As you can see, there are two ram areas and two rom areas. The names
448 (before the colon) are arbitrary names that must start with a letter, with
449 the remaining characters being letters or digits. The names of the memory
450 areas are used when assigning segments. As mentioned above, case is
451 significant for these names.
452
453 The syntax above is used in all sections of the config file. The name
454 (<tt/ROM1/ etc.) is said to be an identifier, the remaining tokens up to the
455 semicolon specify attributes for this identifier. You may use the equal sign
456 to assign values to attributes, and you may use a comma to separate
457 attributes, you may also leave both out. But you <em/must/ use a semicolon to
458 mark the end of the attributes for one identifier. The section above may also
459 have looked like this:
460
461 <tscreen><verb>
462         # Start of memory section
463         MEMORY
464         {
465             RAM1:
466                 start $0800
467                 size $9800;
468             ROM1:
469                 start $A000
470                 size $2000;
471             RAM2:
472                 start $C000
473                 size $1000;
474             ROM2:
475                 start $E000
476                 size $2000;
477         }
478 </verb></tscreen>
479
480 There are of course more attributes for a memory section than just start and
481 size. Start and size are mandatory attributes, that means, each memory area
482 defined <em/must/ have these attributes given (the linker will check that). I
483 will cover other attributes later. As you may have noticed, I've used a
484 comment in the example above. Comments start with a hash mark (`#'), the
485 remainder of the line is ignored if this character is found.
486
487
488 <sect1>Segments<p>
489
490 Let's assume you have written a program for your trusty old C64, and you would
491 like to run it. For testing purposes, it should run in the <tt/RAM/ area. So
492 we will start to assign segments to memory sections in the <tt/SEGMENTS/
493 section:
494
495 <tscreen><verb>
496         SEGMENTS {
497             CODE:   load = RAM1, type = ro;
498             RODATA: load = RAM1, type = ro;
499             DATA:   load = RAM1, type = rw;
500             BSS:    load = RAM1, type = bss, define = yes;
501         }
502 </verb></tscreen>
503
504 What we are doing here is telling the linker, that all segments go into the
505 <tt/RAM1/ memory area in the order specified in the <tt/SEGMENTS/ section. So
506 the linker will first write the <tt/CODE/ segment, then the <tt/RODATA/
507 segment, then the <tt/DATA/ segment - but it will not write the <tt/BSS/
508 segment. Why? Enter the segment type: For each segment specified, you may also
509 specify a segment attribute. There are four possible segment attributes:
510
511 <tscreen><verb>
512         ro      means readonly
513         rw      means read/write
514         bss     means that this is an uninitialized segment
515         zp      a zeropage segment
516 </verb></tscreen>
517
518 So, because we specified that the segment with the name BSS is of type bss,
519 the linker knows that this is uninitialized data, and will not write it to an
520 output file. This is an important point: For the assembler, the <tt/BSS/
521 segment has no special meaning. You specify, which segments have the bss
522 attribute when linking. This approach is much more flexible than having one
523 fixed bss segment, and is a result of the design decision to supporting an
524 arbitrary segment count.
525
526 If you specify "<tt/type = bss/" for a segment, the linker will make sure that
527 this segment does only contain uninitialized data (that is, zeroes), and issue
528 a warning if this is not the case.
529
530 For a <tt/bss/ type segment to be useful, it must be cleared somehow by your
531 program (this happens usually in the startup code - for example the startup
532 code for cc65 generated programs takes care about that). But how does your
533 code know, where the segment starts, and how big it is? The linker is able to
534 give that information, but you must request it. This is, what we're doing with
535 the "<tt/define = yes/" attribute in the <tt/BSS/ definitions. For each
536 segment, where this attribute is true, the linker will export three symbols.
537
538 <tscreen><verb>
539         __NAME_LOAD__   This is set to the address where the
540                         segment is loaded.
541         __NAME_RUN__    This is set to the run address of the
542                         segment. We will cover run addresses
543                         later.
544         __NAME_SIZE__   This is set to the segment size.
545 </verb></tscreen>
546
547 Replace <tt/NAME/ by the name of the segment, in the example above, this would
548 be <tt/BSS/. These symbols may be accessed by your code.
549
550 Now, as we've configured the linker to write the first three segments and
551 create symbols for the last one, there's only one question left: Where does
552 the linker put the data? It would be very convenient to have the data in a
553 file, wouldn't it?
554
555 <sect1>Output files<p>
556
557 We don't have any files specified above, and indeed, this is not needed in a
558 simple configuration like the one above. There is an additional attribute
559 "file" that may be specified for a memory area, that gives a file name to
560 write the area data into. If there is no file name given, the linker will
561 assign the default file name. This is "a.out" or the one given with the
562 <tt><ref id="option-o" name="-o"></tt> option on the command line. Since the
563 default behaviour is ok for our purposes, I did not use the attribute in the
564 example above. Let's have a look at it now.
565
566 The "file" attribute (the keyword may also be written as "FILE" if you like
567 that better) takes a string enclosed in double quotes (`"') that specifies the
568 file, where the data is written. You may specify the same file several times,
569 in that case the data for all memory areas having this file name is written
570 into this file, in the order of the memory areas defined in the <tt/MEMORY/
571 section. Let's specify some file names in the <tt/MEMORY/ section used above:
572
573 <tscreen><verb>
574         MEMORY {
575             RAM1:  start = $0800, size = $9800, file = %O;
576             ROM1:  start = $A000, size = $2000, file = "rom1.bin";
577             RAM2:  start = $C000, size = $1000, file = %O;
578             ROM2:  start = $E000, size = $2000, file = "rom2.bin";
579         }
580 </verb></tscreen>
581
582 The <tt/%O/ used here is a way to specify the default behaviour explicitly:
583 <tt/%O/ is replaced by a string (including the quotes) that contains the
584 default output name, that is, "a.out" or the name specified with the <tt><ref
585 id="option-o" name="-o"></tt> option on the command line. Into this file, the
586 linker will first write any segments that go into <tt/RAM1/, and will append
587 then the segments for <tt/RAM2/, because the memory areas are given in this
588 order. So, for the RAM areas, nothing has really changed.
589
590 We've not used the ROM areas, but we will do that below, so we give the file
591 names here. Segments that go into <tt/ROM1/ will be written to a file named
592 "rom1.bin", and segments that go into <tt/ROM2/ will be written to a file
593 named "rom2.bin". The name given on the command line is ignored in both cases.
594
595 Assigning an empty file name for a memory area will discard the data written
596 to it. This is useful, if the a memory area has segments assigned that are
597 empty (for example because they are of type bss). In that case, the linker
598 will create an empty output file. This may be suppressed by assigning an empty
599 file name to that memory area.
600
601 The <tt/%O/ sequence is also allowed inside a string. So using
602
603 <tscreen><verb>
604         MEMORY {
605             ROM1:  start = $A000, size = $2000, file = "%O-1.bin";
606             ROM2:  start = $E000, size = $2000, file = "%O-2.bin";
607         }
608 </verb></tscreen>
609
610 would write two files that start with the name of the output file specified on
611 the command line, with "-1.bin" and "-2.bin" appended respectively. Because
612 '%' is used as an escape char, the sequence "%%" has to be used if a single
613 percent sign is required.
614
615 <sect1>LOAD and RUN addresses (ROMable code)<p>
616
617 Let us look now at a more complex example. Say, you've successfully tested
618 your new "Super Operating System" (SOS for short) for the C64, and you
619 will now go and replace the ROMs by your own code. When doing that, you
620 face a new problem: If the code runs in RAM, we need not to care about
621 read/write data. But now, if the code is in ROM, we must care about it.
622 Remember the default segments (you may of course specify your own):
623
624 <tscreen><verb>
625         CODE            read only code
626         RODATA          read only data
627         DATA            read/write data
628         BSS             uninitialized data, read/write
629 </verb></tscreen>
630
631 Since <tt/BSS/ is not initialized, we must not care about it now, but what
632 about <tt/DATA/? <tt/DATA/ contains initialized data, that is, data that was
633 explicitly assigned a value. And your program will rely on these values on
634 startup. Since there's no other way to remember the contents of the data
635 segment, than storing it into one of the ROMs, we have to put it there. But
636 unfortunately, ROM is not writable, so we have to copy it into RAM before
637 running the actual code.
638
639 The linker cannot help you copying the data from ROM into RAM (this must be
640 done by the startup code of your program), but it has some features that will
641 help you in this process.
642
643 First, you may not only specify a "<tt/load/" attribute for a segment, but
644 also a "<tt/run/" attribute. The "<tt/load/" attribute is mandatory, and, if
645 you don't specify a "<tt/run/" attribute, the linker assumes that load area
646 and run area are the same. We will use this feature for our data area:
647
648 <tscreen><verb>
649         SEGMENTS {
650             CODE:   load = ROM1, type = ro;
651             RODATA: load = ROM2, type = ro;
652             DATA:   load = ROM2, run = RAM2, type = rw, define = yes;
653             BSS:    load = RAM2, type = bss, define = yes;
654         }
655 </verb></tscreen>
656
657 Let's have a closer look at this <tt/SEGMENTS/ section. We specify that the
658 <tt/CODE/ segment goes into <tt/ROM1/ (the one at $A000). The readonly data
659 goes into <tt/ROM2/. Read/write data will be loaded into <tt/ROM2/ but is run
660 in <tt/RAM2/. That means that all references to labels in the <tt/DATA/
661 segment are relocated to be in <tt/RAM2/, but the segment is written to
662 <tt/ROM2/. All your startup code has to do is, to copy the data from its
663 location in <tt/ROM2/ to the final location in <tt/RAM2/.
664
665 So, how do you know, where the data is located? This is the second point,
666 where you get help from the linker. Remember the "<tt/define/" attribute?
667 Since we have set this attribute to true, the linker will define three
668 external symbols for the data segment that may be accessed from your code:
669
670 <tscreen><verb>
671         __DATA_LOAD__   This is set to the address where the segment
672                         is loaded, in this case, it is an address in
673                         ROM2.
674         __DATA_RUN__    This is set to the run address of the segment,
675                         in this case, it is an address in RAM2.
676         __DATA_SIZE__   This is set to the segment size.
677 </verb></tscreen>
678
679 So, what your startup code must do, is to copy <tt/__DATA_SIZE__/ bytes from
680 <tt/__DATA_LOAD__/ to <tt/__DATA_RUN__/ before any other routines are called.
681 All references to labels in the <tt/DATA/ segment are relocated to <tt/RAM2/
682 by the linker, so things will work properly.
683
684
685 <sect1>Other MEMORY area attributes<p>
686
687 There are some other attributes not covered above. Before starting the
688 reference section, I will discuss the remaining things here.
689
690 You may request symbols definitions also for memory areas. This may be
691 useful for things like a software stack, or an i/o area.
692
693 <tscreen><verb>
694         MEMORY {
695             STACK:  start = $C000, size = $1000, define = yes;
696         }
697 </verb></tscreen>
698
699 This will define three external symbols that may be used in your code:
700
701 <tscreen><verb>
702         __STACK_START__         This is set to the start of the memory
703                                 area, $C000 in this example.
704         __STACK_SIZE__          The size of the area, here $1000.
705         __STACK_LAST__          This is NOT the same as START+SIZE.
706                                 Instead, it it defined as the first
707                                 address that is not used by data. If we
708                                 don't define any segments for this area,
709                                 the value will be the same as START.
710 </verb></tscreen>
711
712 A memory section may also have a type. Valid types are
713
714 <tscreen><verb>
715         ro      for readonly memory
716         rw      for read/write memory.
717 </verb></tscreen>
718
719 The linker will assure, that no segment marked as read/write or bss is put
720 into a memory area that is marked as readonly.
721
722 Unused memory in a memory area may be filled. Use the "<tt/fill = yes/"
723 attribute to request this. The default value to fill unused space is zero. If
724 you don't like this, you may specify a byte value that is used to fill these
725 areas with the "<tt/fillval/" attribute. This value is also used to fill unfilled
726 areas generated by the assemblers <tt/.ALIGN/ and <tt/.RES/ directives.
727
728 The symbol <tt/%S/ may be used to access the default start address (that is,
729 the one defined in the <ref id="FEATURES" name="FEATURES"> section, or the
730 value given on the command line with the <tt><ref id="option-S" name="-S"></tt>
731 option).
732
733
734 <sect1>Other SEGMENT attributes<p>
735
736 Segments may be aligned to some memory boundary. Specify "<tt/align = num/" to
737 request this feature. Num must be a power of two. To align all segments on a
738 page boundary, use
739
740 <tscreen><verb>
741         SEGMENTS {
742             CODE:   load = ROM1, type = ro, align = $100;
743             RODATA: load = ROM2, type = ro, align = $100;
744             DATA:   load = ROM2, run = RAM2, type = rw, define = yes,
745                     align = $100;
746             BSS:    load = RAM2, type = bss, define = yes, align = $100;
747         }
748 </verb></tscreen>
749
750 If an alignment is requested, the linker will add enough space to the output
751 file, so that the new segment starts at an address that is dividable by the
752 given number without a remainder. All addresses are adjusted accordingly. To
753 fill the unused space, bytes of zero are used, or, if the memory area has a
754 "<tt/fillval/" attribute, that value. Alignment is always needed, if you have
755 used the <tt/.ALIGN/ command in the assembler. The alignment of a segment
756 must be equal or greater than the alignment used in the <tt/.ALIGN/ command.
757 The linker will check that, and issue a warning, if the alignment of a segment
758 is lower than the alignment requested in an <tt/.ALIGN/ command of one of the
759 modules making up this segment.
760
761 For a given segment you may also specify a fixed offset into a memory area or
762 a fixed start address. Use this if you want the code to run at a specific
763 address (a prominent case is the interrupt vector table which must go at
764 address $FFFA). Only one of <tt/ALIGN/ or <tt/OFFSET/ or <tt/START/ may be
765 specified. If the directive creates empty space, it will be filled with zero,
766 of with the value specified with the "<tt/fillval/" attribute if one is given.
767 The linker will warn you if it is not possible to put the code at the
768 specified offset (this may happen if other segments in this area are too
769 large). Here's an example:
770
771 <tscreen><verb>
772         SEGMENTS {
773             VECTORS: load = ROM2, type = ro, start = $FFFA;
774         }
775 </verb></tscreen>
776
777 or (for the segment definitions from above)
778
779 <tscreen><verb>
780         SEGMENTS {
781             VECTORS: load = ROM2, type = ro, offset = $1FFA;
782         }
783 </verb></tscreen>
784
785 The "<tt/align/", "<tt/start/" and "<tt/offset/" attributes change placement
786 of the segment in the run memory area, because this is what is usually
787 desired. If load and run memory areas are equal (which is the case if only the
788 load memory area has been specified), the attributes will also work. There is
789 also an "<tt/align_load/" attribute that may be used to align the start of the
790 segment in the load memory area, in case different load and run areas have
791 been specified. There are no special attributes to set start or offset for
792 just the load memory area.
793
794 To suppress the warning, the linker issues if it encounters a segment that is
795 not found in any of the input files, use "<tt/optional=yes/" as additional
796 segment attribute. Be careful when using this attribute, because a missing
797 segment may be a sign of a problem, and if you're suppressing the warning,
798 there is no one left to tell you about it.
799
800 <sect1>The FILES section<p>
801
802 The <tt/FILES/ section is used to support other formats than straight binary
803 (which is the default, so binary output files do not need an explicit entry
804 in the <tt/FILES/ section).
805
806 The <tt/FILES/ section lists output files and as only attribute the format of
807 each output file. Assigning binary format to the default output file would
808 look like this:
809
810 <tscreen><verb>
811         FILES {
812             %O: format = bin;
813         }
814 </verb></tscreen>
815
816 The only other available output format is the o65 format specified by Andre
817 Fachat (see the <htmlurl url="http://www.6502.org/users/andre/o65/fileformat.html"
818 name="6502 binary relocation format specification">). It is defined like this:
819
820 <tscreen><verb>
821         FILES {
822             %O: format = o65;
823         }
824 </verb></tscreen>
825
826 The necessary o65 attributes are defined in a special section labeled
827 <tt/FORMAT/.
828
829
830
831 <sect1>The FORMAT section<p>
832
833 The <tt/FORMAT/ section is used to describe file formats. The default (binary)
834 format has currently no attributes, so, while it may be listed in this
835 section, the attribute list is empty. The second supported format,
836 <htmlurl url="http://www.6502.org/users/andre/o65/fileformat.html" name="o65">,
837 has several attributes that may be defined here.
838
839 <tscreen><verb>
840     FORMATS {
841         o65: os = lunix, version = 0, type = small,
842              import = LUNIXKERNEL,
843              export = _main;
844     }
845 </verb></tscreen>
846
847
848
849 <sect1>The FEATURES section<label id="FEATURES"><p>
850
851 In addition to the <tt/MEMORY/ and <tt/SEGMENTS/ sections described above, the
852 linker has features that may be enabled by an additional section labeled
853 <tt/FEATURES/.
854
855
856 <sect2>The CONDES feature<p>
857
858 <tt/CONDES/ is used to tell the linker to emit module constructor/destructor
859 tables.
860
861 <tscreen><verb>
862         FEATURES {
863             CONDES: segment = RODATA,
864                     type = constructor,
865                     label = __CONSTRUCTOR_TABLE__,
866                     count = __CONSTRUCTOR_COUNT__;
867         }
868 </verb></tscreen>
869
870 The <tt/CONDES/ feature has several attributes:
871
872 <descrip>
873
874   <tag><tt>segment</tt></tag>
875
876   This attribute tells the linker into which segment the table should be
877   placed. If the segment does not exist, it is created.
878
879
880   <tag><tt>type</tt></tag>
881
882   Describes the type of the routines to place in the table. Type may be one of
883   the predefined types <tt/constructor/, <tt/destructor/, <tt/interruptor/, or
884   a numeric value between 0 and 6.
885
886
887   <tag><tt>label</tt></tag>
888
889   This specifies the label to use for the table. The label points to the start
890   of the table in memory and may be used from within user written code.
891
892
893   <tag><tt>count</tt></tag>
894
895   This is an optional attribute. If specified, an additional symbol is defined
896   by the linker using the given name. The value of this symbol is the number
897   of entries (<em/not/ bytes) in the table. While this attribute is optional,
898   it is often useful to define it.
899
900
901   <tag><tt>order</tt></tag>
902
903   Optional attribute that takes one of the keywords <tt/increasing/ or
904   <tt/decreasing/ as an argument. Specifies the sorting order of the entries
905   within the table. The default is <tt/increasing/, which means that the
906   entries are sorted with increasing priority (the first entry has the lowest
907   priority). "Priority" is the priority specified when declaring a symbol as
908   <tt/.CONDES/ with the assembler, higher values mean higher priority. You may
909   change this behaviour by specifying <tt/decreasing/ as the argument, the
910   order of entries is reversed in this case.
911
912   Please note that the order of entries with equal priority is undefined.
913
914 </descrip>
915
916 Without specifying the <tt/CONDES/ feature, the linker will not create any
917 tables, even if there are <tt/condes/ entries in the object files.
918
919 For more information see the <tt/.CONDES/ command in the <htmlurl
920 url="ca65.html" name="ca65 manual">.
921
922
923 <sect2>The STARTADDRESS feature<p>
924
925 <tt/STARTADDRESS/ is used to set the default value for the start address,
926 which can be referenced by the <tt/%S/ symbol. The builtin default for the
927 linker is &dollar;200.
928
929 <tscreen><verb>
930         FEATURES {
931             # Default start address is $1000
932             STARTADDRESS:       default = $1000;
933         }
934 </verb></tscreen>
935
936 Please note that order is important: The default start address must be defined
937 <em/before/ the <tt/%S/ symbol is used in the config file. This does usually
938 mean, that the <tt/FEATURES/ section has to go to the top of the config file.
939
940
941
942 <sect1>The SYMBOLS section<label id="SYMBOLS"><p>
943
944 The configuration file may also be used to define symbols used in the link
945 stage or to force symbols imports. This is done in the SYMBOLS section. The
946 symbol name is followed by a colon and symbol attributes.
947
948 The following symbol attributes are supported:
949
950 <descrip>
951
952   <tag><tt>addrsize</tt></tag>
953
954   The <tt/addrsize/ attribute specifies the address size of the symbol and
955   may be one of
956 <itemize>
957     <item><tt/zp/, <tt/zeropage/ or <tt/direct/
958     <item><tt/abs/, <tt/absolute/ or <tt/near/
959     <item><tt/far/
960     <item><tt/long/ or <tt/dword/.
961 </itemize>
962
963 Without this attribute, the default address size is <tt/abs/.
964
965   <tag><tt>type</tt></tag>
966
967   This attribute is mandatory. Its value is one of <tt/export/, <tt/import/ or
968   <tt/weak/. <tt/export/ means that the symbol is defined and exported from
969   the linker config. <tt/import/ means that an import is generated for this
970   symbol, eventually forcing a module that exports this symbol to be included
971   in the output. <tt/weak/ is similar as <tt/export/. However, the symbol is
972   only defined if it is not defined elsewhere.
973
974   <tag><tt>value</tt></tag>
975
976   This must only be given for symbols of type <tt/export/ or <tt/weak/. It
977   defines the value of the symbol and may be an expression.
978
979 </descrip>
980
981 The following example defines the stack size for an application, but allows
982 the programmer to override the value by specifying <tt/--define
983 __STACKSIZE__=xxx/ on the command line.
984
985 <tscreen><verb>
986         SYMBOLS {
987             # Define the stack size for the application
988             __STACKSIZE__:  type = weak, value = $800;
989         }
990 </verb></tscreen>
991
992
993
994 <sect1>Builtin configurations<p>
995
996 The builtin configurations are part of the linker source. They can be retrieved
997 with <tt/--dump-config/ and don't have a special format. So if you need a
998 special configuration, it's a good idea to start with the builtin configuration
999 for your system. In a first step, just replace <tt/-t target/ by <tt/-C
1000 configfile/. Then go on and modify the config file to suit your needs.
1001
1002
1003
1004 <sect1>Secondary configurations<p>
1005
1006 Several machine specific binary packages are distributed together with secondary
1007 configurations (in the cfg directory). These configurations can be used with
1008 <tt/-C configfile/ too.
1009
1010
1011
1012 <sect>Special segments<p>
1013
1014 The builtin config files do contain segments that have a special meaning for
1015 the compiler and the libraries that come with it. If you replace the builtin
1016 config files, you will need the following information.
1017
1018 <sect1>INIT<p>
1019
1020 The INIT segment is used for initialization code that may be reused once
1021 execution reaches main() - provided that the program runs in RAM. You
1022 may for example add the INIT segment to the heap in really memory
1023 constrained systems.
1024
1025 <sect1>LOWCODE<p>
1026
1027 For the LOWCODE segment, it is guaranteed that it won't be banked out, so it
1028 is reachable at any time by interrupt handlers or similar.
1029
1030 <sect1>STARTUP<p>
1031
1032 This segment contains the startup code which initializes the C software stack
1033 and the libraries. It is placed in its own segment because it needs to be
1034 loaded at the lowest possible program address on several platforms.
1035
1036 <sect1>ZPSAVE<p>
1037
1038 The ZPSAVE segment contains the original values of the zeropage locations used
1039 by the ZEROPAGE segment. It is placed in its own segment because it must not be
1040 initialized.
1041
1042
1043
1044 <sect>Bugs/Feedback<p>
1045
1046 If you have problems using the linker, if you find any bugs, or if you're
1047 doing something interesting with it, I would be glad to hear from you. Feel
1048 free to contact me by email (<htmlurl url="mailto:uz@cc65.org"
1049 name="uz@cc65.org">).
1050
1051
1052
1053 <sect>Copyright<p>
1054
1055 ld65 (and all cc65 binutils) are (C) Copyright 1998-2005 Ullrich von
1056 Bassewitz. For usage of the binaries and/or sources the following
1057 conditions do apply:
1058
1059 This software is provided 'as-is', without any expressed or implied
1060 warranty.  In no event will the authors be held liable for any damages
1061 arising from the use of this software.
1062
1063 Permission is granted to anyone to use this software for any purpose,
1064 including commercial applications, and to alter it and redistribute it
1065 freely, subject to the following restrictions:
1066
1067 <enum>
1068 <item>  The origin of this software must not be misrepresented; you must not
1069         claim that you wrote the original software. If you use this software
1070         in a product, an acknowledgment in the product documentation would be
1071         appreciated but is not required.
1072 <item>  Altered source versions must be plainly marked as such, and must not
1073         be misrepresented as being the original software.
1074 <item>  This notice may not be removed or altered from any source
1075         distribution.
1076 </enum>
1077
1078
1079
1080 </article>