]> git.sur5r.net Git - cc65/blob - doc/ld65.sgml
93b4b06ffbde753bebcc0bbf7d75cf9d62f4b768
[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   -C name               Use linker config file
59   -L path               Specify a library search path
60   -Ln name              Create a VICE label file
61   -Lp                   Mark write protected segments as such (VICE)
62   -S addr               Set the default start address
63   -V                    Print the linker version
64   -h                    Help (this text)
65   -m name               Create a map file
66   -o name               Name the default output file
67   -t sys                Set the target system
68   -v                    Verbose mode
69   -vm                   Verbose map file
70
71 Long options:
72   --cfg-path path       Specify a config file search path
73   --config name         Use linker config file
74   --dump-config name    Dump a builtin configuration
75   --help                Help (this text)
76   --lib file            Link this library
77   --lib-path path       Specify a library search path
78   --mapfile name        Create a map file
79   --module-id id        Specify a module id
80   --obj file            Link this object file
81   --obj-path path       Specify an object file search path
82   --start-addr addr     Set the default start address
83   --target sys          Set the target system
84   --version             Print the linker version
85 ---------------------------------------------------------------------------
86 </verb></tscreen>
87
88
89 <sect1>Command line options in detail<p>
90
91 Here is a description of all the command line options:
92
93 <descrip>
94
95   <tag><tt>-h, --help</tt></tag>
96
97   Print the short option summary shown above.
98
99
100   <label id="option-m">
101   <tag><tt>-m name, --mapfile name</tt></tag>
102
103   This option (which needs an argument that will used as a filename for
104   the generated map file) will cause the linker to generate a map file.
105   The map file does contain a detailed overview over the modules used, the
106   sizes for the different segments, and a table containing exported
107   symbols.
108
109
110   <label id="option-o">
111   <tag><tt>-o name</tt></tag>
112
113   The -o switch is used to give the name of the default output file.
114   Depending on your output configuration, this name may NOT be used as
115   name for the output file. However, for the builtin configurations, this
116   name is used for the output file name.
117
118
119   <label id="option-t">
120   <tag><tt>-t sys, --target sys</tt></tag>
121
122   The argument for the -t switch is the name of the target system. Since this
123   switch will activate a builtin configuration, it may not be used together
124   with the <tt><ref id="option-C" name="-C"></tt> option. The following target
125   systems are currently supported:
126
127   <itemize>
128   <item>none
129   <item>apple2
130   <item>atari
131   <item>atmos
132   <item>c16 (works also for the c116 with memory up to 32K)
133   <item>c64
134   <item>c128
135   <item>plus4
136   <item>cbm510 (CBM-II series with 40 column video)
137   <item>cbm610 (all CBM series-II computers with 80 column video)
138   <item>pet (all CBM PET systems except the 2001)
139   <item>geos
140   <item>lunix
141   <item>atmos
142   <item>nes
143   </itemize>
144
145   There are a few more targets defined but neither of them is actually
146   supported.
147
148
149   <label id="option-v">
150   <tag><tt>-v, --verbose</tt></tag>
151
152   Using the -v option, you may enable more output that may help you to
153   locate problems. If an undefined symbol is encountered, -v causes the
154   linker to print a detailed list of the references (that is, source file
155   and line) for this symbol.
156
157
158   <tag><tt>-vm</tt></tag>
159
160   Must be used in conjunction with <tt><ref id="option-m" name="-m"></tt>
161   (generate map file). Normally the map file will not include empty segments
162   and sections, or unreferenced symbols. Using this option, you can force the
163   linker to include all this information into the map file.
164
165
166   <label id="option-C">
167   <tag><tt>-C</tt></tag>
168
169   This gives the name of an output config file to use. See section 4 for more
170   information about config files. -C may not be used together with <tt><ref
171   id="option-t" name="-t"></tt>.
172
173
174   <tag><tt>-L path, --lib-path path</tt></tag>
175
176   Specify a library search path. This option may be used more than once. It
177   adds a directory to the search path for library files. Libraries specified
178   without a path are searched in current directory and in the list of
179   directories specified using <tt/--lib-path/.
180
181
182   <tag><tt>-Ln</tt></tag>
183
184   This option allows you to create a file that contains all global labels and
185   may be loaded into VICE emulator using the <tt/ll/ (load label) command. You
186   may use this to debug your code with VICE. Note: Older versions had some
187   bugs in the label code. If you have problems, please get the latest VICE
188   version.
189
190
191   <tag><tt>-Lp</tt></tag>
192
193   Deprecated option.
194
195
196   <label id="option-S">
197   <tag><tt>-S addr, --start-addr addr</tt></tag>
198
199   Using -S you may define the default starting address. If and how this
200   address is used depends on the config file in use. For the builtin
201   configurations, only the "none" system honors an explicit start address,
202   all other builtin config provide their own.
203
204
205   <tag><tt>-V, --version</tt></tag>
206
207   This option print the version number of the linker. If you send any
208   suggestions or bugfixes, please include this number.
209
210
211   <tag><tt>--cfg-path path</tt></tag>
212
213   Specify a config file search path. This option may be used more than once.
214   It adds a directory to the search path for config files. A config file given
215   with the <tt><ref id="option-C" name="-C"></tt> option that has no path in
216   its name is searched in the current directory and in the list of directories
217   specified using <tt/--cfg-path/.
218
219
220   <tag><tt>--lib file</tt></tag>
221
222   Links a library to the output. Use this command line option instead of just
223   naming the library file, if the linker is not able to determine the file
224   type because of an unusual extension.
225
226
227   <tag><tt>--obj file</tt></tag>
228
229   Links an object file to the output. Use this command line option instead
230   of just naming the object file, if the linker is not able to determine the
231   file type because of an unusual extension.
232
233
234   <tag><tt>--obj-path path</tt></tag>
235
236   Specify an object file search path. This option may be used more than once.
237   It adds a directory to the search path for object files. An object file
238   passed to the linker that has no path in its name is searched in current
239   directory and in the list of directories specified using <tt/--obj-path/.
240
241 </descrip>
242
243 If one of the modules is not found in the current directory, and the module
244 name does not have a path component, the value of the environment variable
245 <tt/CC65_LIB/ is prepended to the name, and the linker tries to open the
246 module with this new name.
247
248
249
250 <sect>Detailed workings<p>
251
252 The linker does several things when combining object modules:
253
254 First, the command line is parsed from left to right. For each object file
255 encountered (object files are recognized by a magic word in the header, so
256 the linker does not care about the name), imported and exported
257 identifiers are read from the file and inserted in a table. If a library
258 name is given (libraries are also recognized by a magic word, there are no
259 special naming conventions), all modules in the library are checked if an
260 export from this module would satisfy an import from other modules. All
261 modules where this is the case are marked. If duplicate identifiers are
262 found, the linker issues a warning.
263
264 This procedure (parsing and reading from left to right) does mean, that a
265 library may only satisfy references for object modules (given directly or from
266 a library) named <em/before/ that library. With the command line
267
268 <tscreen><verb>
269         ld65 crt0.o clib.lib test.o
270 </verb></tscreen>
271
272 the module test.o may not contain references to modules in the library
273 clib.lib. If this is the case, you have to change the order of the modules
274 on the command line:
275
276 <tscreen><verb>
277         ld65 crt0.o test.o clib.lib
278 </verb></tscreen>
279
280 Step two is, to read the configuration file, and assign start addresses
281 for the segments and define any linker symbols (see <ref id="config-files"
282 name="Configuration files">).
283
284 After that, the linker is ready to produce an output file. Before doing that,
285 it checks it's data for consistency. That is, it checks for unresolved
286 externals (if the output format is not relocatable) and for symbol type
287 mismatches (for example a zero page symbol is imported by a module as absolute
288 symbol).
289
290 Step four is, to write the actual target files. In this step, the linker will
291 resolve any expressions contained in the segment data. Circular references are
292 also detected in this step (a symbol may have a circular reference that goes
293 unnoticed if the symbol is not used).
294
295 Step five is to output a map file with a detailed list of all modules,
296 segments and symbols encountered.
297
298 And, last step, if you give the <tt><ref id="option-v" name="-v"></tt> switch
299 twice, you get a dump of the segment data. However, this may be quite
300 unreadable if you're not a developer:-)
301
302
303
304 <sect>Configuration files<label id="config-files"><p>
305
306 Configuration files are used to describe the layout of the output file(s). Two
307 major topics are covered in a config file: The memory layout of the target
308 architecture, and the assignment of segments to memory areas. In addition,
309 several other attributes may be specified.
310
311 Case is ignored for keywords, that is, section or attribute names, but it is
312 <em/not/ ignored for names and strings.
313
314
315
316 <sect1>Memory areas<p>
317
318 Memory areas are specified in a <tt/MEMORY/ section. Lets have a look at an
319 example (this one describes the usable memory layout of the C64):
320
321 <tscreen><verb>
322         MEMORY {
323             RAM1:  start = $0800, size = $9800;
324             ROM1:  start = $A000, size = $2000;
325             RAM2:  start = $C000, size = $1000;
326             ROM2:  start = $E000, size = $2000;
327         }
328 </verb></tscreen>
329
330 As you can see, there are two ram areas and two rom areas. The names
331 (before the colon) are arbitrary names that must start with a letter, with
332 the remaining characters being letters or digits. The names of the memory
333 areas are used when assigning segments. As mentioned above, case is
334 significant for these names.
335
336 The syntax above is used in all sections of the config file. The name
337 (<tt/ROM1/ etc.) is said to be an identifier, the remaining tokens up to the
338 semicolon specify attributes for this identifier. You may use the equal sign
339 to assign values to attributes, and you may use a comma to separate
340 attributes, you may also leave both out. But you <em/must/ use a semicolon to
341 mark the end of the attributes for one identifier. The section above may also
342 have looked like this:
343
344 <tscreen><verb>
345         # Start of memory section
346         MEMORY
347         {
348             RAM1:
349                 start $0800
350                 size $9800;
351             ROM1:
352                 start $A000
353                 size $2000;
354             RAM2:
355                 start $C000
356                 size $1000;
357             ROM2:
358                 start $E000
359                 size $2000;
360         }
361 </verb></tscreen>
362
363 There are of course more attributes for a memory section than just start and
364 size. Start and size are mandatory attributes, that means, each memory area
365 defined <em/must/ have these attributes given (the linker will check that). I
366 will cover other attributes later. As you may have noticed, I've used a
367 comment in the example above. Comments start with a hash mark (`#'), the
368 remainder of the line is ignored if this character is found.
369
370
371 <sect1>Segments<p>
372
373 Let's assume you have written a program for your trusty old C64, and you would
374 like to run it. For testing purposes, it should run in the <tt/RAM/ area. So
375 we will start to assign segments to memory sections in the <tt/SEGMENTS/
376 section:
377
378 <tscreen><verb>
379         SEGMENTS {
380             CODE:   load = RAM1, type = ro;
381             RODATA: load = RAM1, type = ro;
382             DATA:   load = RAM1, type = rw;
383             BSS:    load = RAM1, type = bss, define = yes;
384         }
385 </verb></tscreen>
386
387 What we are doing here is telling the linker, that all segments go into the
388 <tt/RAM1/ memory area in the order specified in the <tt/SEGMENTS/ section. So
389 the linker will first write the <tt/CODE/ segment, then the <tt/RODATA/
390 segment, then the <tt/DATA/ segment - but it will not write the <tt/BSS/
391 segment. Why? Enter the segment type: For each segment specified, you may also
392 specify a segment attribute. There are five possible segment attributes:
393
394 <tscreen><verb>
395         ro      means readonly
396         wprot   same as ro but will be marked as write protected in
397                 the VICE label file if -Lp is given
398         rw      means read/write
399         bss     means that this is an uninitialized segment
400         zp      a zeropage segment
401 </verb></tscreen>
402
403 So, because we specified that the segment with the name BSS is of type bss,
404 the linker knows that this is uninitialized data, and will not write it to an
405 output file. This is an important point: For the assembler, the <tt/BSS/
406 segment has no special meaning. You specify, which segments have the bss
407 attribute when linking. This approach is much more flexible than having one
408 fixed bss segment, and is a result of the design decision to supporting an
409 arbitrary segment count.
410
411 If you specify "<tt/type = bss/" for a segment, the linker will make sure that
412 this segment does only contain uninitialized data (that is, zeroes), and issue
413 a warning if this is not the case.
414
415 For a <tt/bss/ type segment to be useful, it must be cleared somehow by your
416 program (this happens usually in the startup code - for example the startup
417 code for cc65 generated programs takes care about that). But how does your
418 code know, where the segment starts, and how big it is? The linker is able to
419 give that information, but you must request it. This is, what we're doing with
420 the "<tt/define = yes/" attribute in the <tt/BSS/ definitions. For each
421 segment, where this attribute is true, the linker will export three symbols.
422
423 <tscreen><verb>
424         __NAME_LOAD__   This is set to the address where the
425                         segment is loaded.
426         __NAME_RUN__    This is set to the run address of the
427                         segment. We will cover run addresses
428                         later.
429         __NAME_SIZE__   This is set to the segment size.
430 </verb></tscreen>
431
432 Replace <tt/NAME/ by the name of the segment, in the example above, this would
433 be <tt/BSS/. These symbols may be accessed by your code.
434
435 Now, as we've configured the linker to write the first three segments and
436 create symbols for the last one, there's only one question left: Where does
437 the linker put the data? It would be very convenient to have the data in a
438 file, wouldn't it?
439
440 <sect1>Output files<p>
441
442 We don't have any files specified above, and indeed, this is not needed in a
443 simple configuration like the one above. There is an additional attribute
444 "file" that may be specified for a memory area, that gives a file name to
445 write the area data into. If there is no file name given, the linker will
446 assign the default file name. This is "a.out" or the one given with the
447 <tt><ref id="option-o" name="-o"></tt> option on the command line. Since the
448 default behaviour is ok for our purposes, I did not use the attribute in the
449 example above. Let's have a look at it now.
450
451 The "file" attribute (the keyword may also be written as "FILE" if you like
452 that better) takes a string enclosed in double quotes (`"') that specifies the
453 file, where the data is written. You may specifiy the same file several times,
454 in that case the data for all memory areas having this file name is written
455 into this file, in the order of the memory areas defined in the <tt/MEMORY/
456 section. Let's specify some file names in the <tt/MEMORY/ section used above:
457
458 <tscreen><verb>
459         MEMORY {
460             RAM1:  start = $0800, size = $9800, file = %O;
461             ROM1:  start = $A000, size = $2000, file = "rom1.bin";
462             RAM2:  start = $C000, size = $1000, file = %O;
463             ROM2:  start = $E000, size = $2000, file = "rom2.bin";
464         }
465 </verb></tscreen>
466
467 The <tt/%O/ used here is a way to specify the default behaviour explicitly:
468 <tt/%O/ is replaced by a string (including the quotes) that contains the
469 default output name, that is, "a.out" or the name specified with the <tt><ref
470 id="option-o" name="-o"></tt> option on the command line. Into this file, the
471 linker will first write any segments that go into <tt/RAM1/, and will append
472 then the segments for <tt/RAM2/, because the memory areas are given in this
473 order. So, for the RAM areas, nothing has really changed.
474
475 We've not used the ROM areas, but we will do that below, so we give the file
476 names here. Segments that go into <tt/ROM1/ will be written to a file named
477 "rom1.bin", and segments that go into <tt/ROM2/ will be written to a file
478 named "rom2.bin". The name given on the command line is ignored in both cases.
479
480
481 <sect1>LOAD and RUN addresses (ROMable code)<p>
482
483 Let us look now at a more complex example. Say, you've successfully tested
484 your new "Super Operating System" (SOS for short) for the C64, and you
485 will now go and replace the ROMs by your own code. When doing that, you
486 face a new problem: If the code runs in RAM, we need not to care about
487 read/write data. But now, if the code is in ROM, we must care about it.
488 Remember the default segments (you may of course specify your own):
489
490 <tscreen><verb>
491         CODE            read only code
492         RODATA          read only data
493         DATA            read/write data
494         BSS             uninitialized data, read/write
495 </verb></tscreen>
496
497 Since <tt/BSS/ is not initialized, we must not care about it now, but what
498 about <tt/DATA/? <tt/DATA/ contains initialized data, that is, data that was
499 explicitly assigned a value. And your program will rely on these values on
500 startup. Since there's no other way to remember the contents of the data
501 segment, than storing it into one of the ROMs, we have to put it there. But
502 unfortunately, ROM is not writeable, so we have to copy it into RAM before
503 running the actual code.
504
505 The linker cannot help you copying the data from ROM into RAM (this must be
506 done by the startup code of your program), but it has some features that will
507 help you in this process.
508
509 First, you may not only specify a "<tt/load/" attribute for a segment, but
510 also a "<tt/run/" attribute. The "<tt/load/" attribute is mandatory, and, if
511 you don't specify a "<tt/run/" attribute, the linker assumes that load area
512 and run area are the same. We will use this feature for our data area:
513
514 <tscreen><verb>
515         SEGMENTS {
516             CODE:   load = ROM1, type = ro;
517             RODATA: load = ROM2, type = ro;
518             DATA:   load = ROM2, run = RAM2, type = rw, define = yes;
519             BSS:    load = RAM2, type = bss, define = yes;
520         }
521 </verb></tscreen>
522
523 Let's have a closer look at this <tt/SEGMENTS/ section. We specify that the
524 <tt/CODE/ segment goes into <tt/ROM1/ (the one at $A000). The readonly data
525 goes into <tt/ROM2/. Read/write data will be loaded into <tt/ROM2/ but is run
526 in <tt/RAM2/. That means that all references to labels in the <tt/DATA/
527 segment are relocated to be in <tt/RAM2/, but the segment is written to
528 <tt/ROM2/. All your startup code has to do is, to copy the data from it's
529 location in <tt/ROM2/ to the final location in <tt/RAM2/.
530
531 So, how do you know, where the data is located? This is the second point,
532 where you get help from the linker. Remember the "<tt/define/" attribute?
533 Since we have set this attribute to true, the linker will define three
534 external symbols for the data segment that may be accessed from your code:
535
536 <tscreen><verb>
537         __DATA_LOAD__   This is set to the address where the segment
538                         is loaded, in this case, it is an address in
539                         ROM2.
540         __DATA_RUN__    This is set to the run address of the segment,
541                         in this case, it is an address in RAM2.
542         __DATA_SIZE__   This is set to the segment size.
543 </verb></tscreen>
544
545 So, what your startup code must do, is to copy <tt/__DATA_SIZE__/ bytes from
546 <tt/__DATA_LOAD__/ to <tt/__DATA_RUN__/ before any other routines are called.
547 All references to labels in the <tt/DATA/ segment are relocated to <tt/RAM2/
548 by the linker, so things will work properly.
549
550
551 <sect1>Other MEMORY area attributes<p>
552
553 There are some other attributes not covered above. Before starting the
554 reference section, I will discuss the remaining things here.
555
556 You may request symbols definitions also for memory areas. This may be
557 useful for things like a software stack, or an i/o area.
558
559 <tscreen><verb>
560         MEMORY {
561             STACK:  start = $C000, size = $1000, define = yes;
562         }
563 </verb></tscreen>
564
565 This will define three external symbols that may be used in your code:
566
567 <tscreen><verb>
568         __STACK_START__         This is set to the start of the memory
569                                 area, $C000 in this example.
570         __STACK_SIZE__          The size of the area, here $1000.
571         __STACK_LAST__          This is NOT the same as START+SIZE.
572                                 Instead, it it defined as the first
573                                 address that is not used by data. If we
574                                 don't define any segments for this area,
575                                 the value will be the same as START.
576 </verb></tscreen>
577
578 A memory section may also have a type. Valid types are
579
580 <tscreen><verb>
581         ro      for readonly memory
582         rw      for read/write memory.
583 </verb></tscreen>
584
585 The linker will assure, that no segment marked as read/write or bss is put
586 into a memory area that is marked as readonly.
587
588 Unused memory in a memory area may be filled. Use the "<tt/fill = yes/"
589 attribute to request this. The default value to fill unused space is zero. If
590 you don't like this, you may specify a byte value that is used to fill these
591 areas with the "<tt/fillval/" attribute. This value is also used to fill unfilled
592 areas generated by the assemblers <tt/.ALIGN/ and <tt/.RES/ directives.
593
594
595 <sect1>Other SEGMENT attributes<p>
596
597 Segments may be aligned to some memory boundary. Specify "<tt/align = num/" to
598 request this feature. Num must be a power of two. To align all segments on a
599 page boundary, use
600
601 <tscreen><verb>
602         SEGMENTS {
603             CODE:   load = ROM1, type = ro, align = $100;
604             RODATA: load = ROM2, type = ro, align = $100;
605             DATA:   load = ROM2, run = RAM2, type = rw, define = yes,
606                     align = $100;
607             BSS:    load = RAM2, type = bss, define = yes, align = $100;
608         }
609 </verb></tscreen>
610
611 If an alignment is requested, the linker will add enough space to the output
612 file, so that the new segment starts at an address that is divideable by the
613 given number without a remainder. All addresses are adjusted accordingly. To
614 fill the unused space, bytes of zero are used, or, if the memory area has a
615 "<tt/fillval/" attribute, that value. Alignment is always needed, if you have
616 the used the <tt/.ALIGN/ command in the assembler. The alignment of a segment
617 must be equal or greater than the alignment used in the <tt/.ALIGN/ command.
618 The linker will check that, and issue a warning, if the alignment of a segment
619 is lower than the alignment requested in a <tt/.ALIGN/ command of one of the
620 modules making up this segment.
621
622 For a given segment you may also specify a fixed offset into a memory area or
623 a fixed start address. Use this if you want the code to run at a specific
624 address (a prominent case is the interrupt vector table which must go at
625 address $FFFA). Only one of <tt/ALIGN/ or <tt/OFFSET/ or <tt/START/ may be
626 specified. If the directive creates empty space, it will be filled with zero,
627 of with the value specified with the "<tt/fillval/" attribute if one is given.
628 The linker will warn you if it is not possible to put the code at the
629 specified offset (this may happen if other segments in this area are too
630 large). Here's an example:
631
632 <tscreen><verb>
633         SEGMENTS {
634             VECTORS: load = ROM2, type = ro, start = $FFFA;
635         }
636 </verb></tscreen>
637
638 or (for the segment definitions from above)
639
640 <tscreen><verb>
641         SEGMENTS {
642             VECTORS: load = ROM2, type = ro, offset = $1FFA;
643         }
644 </verb></tscreen>
645
646 To suppress the warning, the linker issues if it encounters a segment that is
647 not found in any of the input files, use "<tt/optional=yes/" as additional
648 segment attribute. Be careful when using this attribute, because a missing
649 segment may be a sign of a problem, and if you're suppressing the warning,
650 there is no one left to tell you about it.
651
652 File names may be empty, data from segments assigned to a memory area with
653 an empty file name is discarded. This is useful, if the a memory area has
654 segments assigned that are empty (for example because they are of type
655 bss). In that case, the linker will create an empty output file. This may
656 be suppressed by assigning an empty file name to that memory area.
657
658 The symbol <tt/%S/ may be used to access the default start address (that is,
659 $200 or the value given on the command line with the <tt><ref id="option-S"
660 name="-S"></tt> option).
661
662
663
664 <sect1>The FILES section<p>
665
666 The <tt/FILES/ section is used to support other formats than straight binary
667 (which is the default, so binary output files do not need an explicit entry
668 in the <tt/FILES/ section).
669
670 The <tt/FILES/ section lists output files and as only attribute the format of
671 each output file. Assigning binary format to the default output file would
672 look like this:
673
674 <tscreen><verb>
675         FILES {
676             %O: format = bin;
677         }
678 </verb></tscreen>
679
680 The only other available output format is the o65 format specified by Andre
681 Fachat. It is defined like this:
682
683 <tscreen><verb>
684         FILES {
685             %O: format = o65;
686         }
687 </verb></tscreen>
688
689 The necessary o65 attributes are defined in a special section labeled
690 <tt/FORMAT/.
691
692
693
694 <sect1>The FORMAT section<p>
695
696 The <tt/FORMAT/ section is used to describe file formats. The default (binary)
697 format has currently no attributes, so, while it may be listed in this
698 section, the attribute list is empty. The second supported format, o65, has
699 several attributes that may be defined here.
700
701 <tscreen><verb>
702     FORMATS {
703         o65: os = lunix, version = 0, type = small,
704              import = LUNIXKERNEL,
705              export = _main;
706     }
707 </verb></tscreen>
708
709
710
711
712
713 <sect1>Features<p>
714
715 In addition to the <tt/MEMORY/ and <tt/SEGMENTS/ sections described above, the
716 linker has features that may be enabled by an additional section labeled
717 <tt/FEATURES/. Currently, one such feature is available: <tt/CONDES/ is used
718 to tell the linker to emit module constructor/destructor tables.
719
720 <tscreen><verb>
721         FEATURES {
722             CONDES: segment = RODATA,
723                     type = constructor,
724                     label = __CONSTRUCTOR_TABLE__,
725                     count = __CONSTRUCTOR_COUNT__;
726         }
727 </verb></tscreen>
728
729 The <tt/CONDES/ feature has several attributes:
730
731 <descrip>
732
733   <tag><tt>segment</tt></tag>
734
735   This attribute tells the linker into which segment the table should be
736   placed. If the segment does not exist, it is created.
737
738
739   <tag><tt>type</tt></tag>
740
741   Describes the type of the routines to place in the table. Type may be
742   one of the predefined types <tt/constructor/ or <tt/destructor/, or a
743   numeric value between 0 and 6.
744
745
746   <tag><tt>label</tt></tag>
747
748   This specifies the label to use for the table. The label points to the
749   start of the table in memory and may be used from within user written
750   code.
751
752
753   <tag><tt>count</tt></tag>
754
755   This is an optional attribute. If specified, an additional symbol is
756   defined by the linker using the given name. The value of this symbol
757   is the number of entries (<em/not/ bytes) in the table. While this
758   attribute is optional, it is often useful to define it.
759
760
761   <tag><tt>order</tt></tag>
762
763   Optional attribute that takes one of the keywords <tt/increasing/ or
764   <tt/decreasing/ as an argument. Specifies the sorting order of the entries
765   within the table. The default is <tt/increasing/, which means that the
766   entries are sorted with increasing priority (the first entry has the lowest
767   priority). You may change this behaviour by specifying <tt/decreasing/ as
768   the argument, the order of entries is reversed in this case.
769
770   Please note that the order of entries with equal priority is undefined.
771
772 </descrip>
773
774 Without specifying the <tt/CONDES/ feature, the linker will not create any
775 tables, even if there are <tt/condes/ entries in the object files.
776
777 For more information see the <tt/.CONDES/ command in the <htmlurl
778 url="ca65.html" name="ca65 manual">.
779
780
781
782 <sect1>Builtin configurations<p>
783
784 The builtin configurations are part of the linker source. They are also
785 distributed together with the machine specific binary packages (usually in the
786 doc directory) and don't have a special format. So if you need a special
787 configuration, it's a good idea to start with the builtin configuration for
788 your system. In a first step, just replace <tt/-t target/ by <tt/-C
789 configfile/. The go on and modify the config file to suit your needs.
790
791
792
793 <sect>Bugs/Feedback<p>
794
795 If you have problems using the linker, if you find any bugs, or if you're
796 doing something interesting with it, I would be glad to hear from you. Feel
797 free to contact me by email (<htmlurl url="mailto:uz@cc65.org"
798 name="uz@cc65.org">).
799
800
801
802 <sect>Copyright<p>
803
804 ld65 (and all cc65 binutils) are (C) Copyright 1998-2001 Ullrich von
805 Bassewitz. For usage of the binaries and/or sources the following
806 conditions do apply:
807
808 This software is provided 'as-is', without any expressed or implied
809 warranty.  In no event will the authors be held liable for any damages
810 arising from the use of this software.
811
812 Permission is granted to anyone to use this software for any purpose,
813 including commercial applications, and to alter it and redistribute it
814 freely, subject to the following restrictions:
815
816 <enum>
817 <item>  The origin of this software must not be misrepresented; you must not
818         claim that you wrote the original software. If you use this software
819         in a product, an acknowledgment in the product documentation would be
820         appreciated but is not required.
821 <item>  Altered source versions must be plainly marked as such, and must not
822         be misrepresented as being the original software.
823 <item>  This notice may not be removed or altered from any source
824         distribution.
825 </enum>
826
827
828
829 </article>
830