]>
Commit | Line | Data |
---|---|---|
44eb65ce RL |
1 | Intro |
2 | ===== | |
3 | ||
4 | This directory contains a few sets of files that are used for | |
5 | configuration in diverse ways: | |
6 | ||
7 | *.conf Target platform configurations, please read | |
8 | 'Configurations of OpenSSL target platforms' for more | |
9 | information. | |
10 | *.tmpl Build file templates, please read 'Build-file | |
11 | programming with the "unified" build system' as well | |
12 | as 'Build info files' for more information. | |
13 | *.pm Helper scripts / modules for the main `Configure` | |
14 | script. See 'Configure helper scripts for more | |
15 | information. | |
16 | ||
17 | ||
9e0724a1 | 18 | Configurations of OpenSSL target platforms |
ddf1847d | 19 | ========================================== |
9e0724a1 | 20 | |
225f980d | 21 | Configuration targets are a collection of facts that we know about |
9e0724a1 RL |
22 | different platforms and their capabilities. We organise them in a |
23 | hash table, where each entry represent a specific target. | |
24 | ||
225f980d RL |
25 | Note that configuration target names must be unique across all config |
26 | files. The Configure script does check that a config file doesn't | |
27 | have config targets that shadow config targets from other files. | |
28 | ||
9e0724a1 RL |
29 | In each table entry, the following keys are significant: |
30 | ||
31 | inherit_from => Other targets to inherit values from. | |
32 | Explained further below. [1] | |
33 | template => Set to 1 if this isn't really a platform | |
34 | target. Instead, this target is a template | |
35 | upon which other targets can be built. | |
36 | Explained further below. [1] | |
37 | ||
38 | sys_id => System identity for systems where that | |
39 | is difficult to determine automatically. | |
40 | ||
906eb3d0 RL |
41 | enable => Enable specific configuration features. |
42 | This MUST be an array of words. | |
43 | disable => Disable specific configuration features. | |
44 | This MUST be an array of words. | |
45 | Note: if the same feature is both enabled | |
46 | and disabled, disable wins. | |
47 | ||
310f28df RL |
48 | as => The assembler command. This is not always |
49 | used (for example on Unix, where the C | |
50 | compiler is used instead). | |
51 | asflags => Default assembler command flags [4]. | |
8c3bc594 RL |
52 | cpp => The C preprocessor command, normally not |
53 | given, as the build file defaults are | |
54 | usually good enough. | |
310f28df | 55 | cppflags => Default C preprocessor flags [4]. |
8c3bc594 | 56 | defines => As an alternative, macro definitions may be |
310f28df RL |
57 | given here instead of in `cppflags' [4]. |
58 | If given here, they MUST be as an array of | |
59 | the string such as "MACRO=value", or just | |
8c3bc594 RL |
60 | "MACRO" for definitions without value. |
61 | includes => As an alternative, inclusion directories | |
310f28df RL |
62 | may be given here instead of in `cppflags' |
63 | [4]. If given here, the MUST be an array | |
64 | of strings, one directory specification | |
65 | each. | |
ea241958 | 66 | cc => The C compiler command, usually one of "cc", |
9e0724a1 RL |
67 | "gcc" or "clang". This command is normally |
68 | also used to link object files and | |
69 | libraries into the final program. | |
ea241958 RL |
70 | cxx => The C++ compiler command, usually one of |
71 | "c++", "g++" or "clang++". This command is | |
72 | also used when linking a program where at | |
73 | least one of the object file is made from | |
74 | C++ source. | |
310f28df RL |
75 | cflags => Defaults C compiler flags [4]. |
76 | cxxflags => Default C++ compiler flags [4]. If unset, | |
77 | it gets the same value as cflags. | |
9e0724a1 | 78 | |
c86ddbe6 RL |
79 | (linking is a complex thing, see [3] below) |
80 | ld => Linker command, usually not defined | |
9e0724a1 RL |
81 | (meaning the compiler command is used |
82 | instead). | |
83 | (NOTE: this is here for future use, it's | |
84 | not implemented yet) | |
310f28df RL |
85 | lflags => Default flags used when linking apps, |
86 | shared libraries or DSOs [4]. | |
c86ddbe6 | 87 | ex_libs => Extra libraries that are needed when |
310f28df | 88 | linking shared libraries, DSOs or programs. |
edc79fc9 AP |
89 | The value is also assigned to Libs.private |
90 | in $(libdir)/pkgconfig/libcrypto.pc. | |
310f28df RL |
91 | |
92 | shared_cppflags => Extra C preprocessor flags used when | |
93 | processing C files for shared libraries. | |
94 | shared_cflag => Extra C compiler flags used when compiling | |
95 | for shared libraries, typically something | |
96 | like "-fPIC". | |
97 | shared_ldflag => Extra linking flags used when linking | |
98 | shared libraries. | |
99 | module_cppflags | |
100 | module_cflags | |
101 | module_ldflags => Has the same function as the corresponding | |
102 | `shared_' attributes, but for building DSOs. | |
103 | When unset, they get the same values as the | |
104 | corresponding `shared_' attributes. | |
9e0724a1 | 105 | |
9e0724a1 RL |
106 | ar => The library archive command, the default is |
107 | "ar". | |
108 | (NOTE: this is here for future use, it's | |
109 | not implemented yet) | |
110 | arflags => Flags to be used with the library archive | |
6475b649 RL |
111 | command. On Unix, this includes the |
112 | command letter, 'r' by default. | |
9e0724a1 RL |
113 | |
114 | ranlib => The library archive indexing command, the | |
115 | default is 'ranlib' it it exists. | |
116 | ||
117 | unistd => An alternative header to the typical | |
118 | '<unistd.h>'. This is very rarely needed. | |
119 | ||
120 | shared_extension => File name extension used for shared | |
df443918 | 121 | libraries. |
9e0724a1 RL |
122 | obj_extension => File name extension used for object files. |
123 | On unix, this defaults to ".o" (NOTE: this | |
124 | is here for future use, it's not | |
125 | implemented yet) | |
126 | exe_extension => File name extension used for executable | |
127 | files. On unix, this defaults to "" (NOTE: | |
128 | this is here for future use, it's not | |
129 | implemented yet) | |
822b5e26 VD |
130 | shlib_variant => A "variant" identifier inserted between the base |
131 | shared library name and the extension. On "unixy" | |
132 | platforms (BSD, Linux, Solaris, MacOS/X, ...) this | |
133 | supports installation of custom OpenSSL libraries | |
134 | that don't conflict with other builds of OpenSSL | |
135 | installed on the system. The variant identifier | |
136 | becomes part of the SONAME of the library and also | |
137 | any symbol versions (symbol versions are not used or | |
138 | needed with MacOS/X). For example, on a system | |
139 | where a default build would normally create the SSL | |
140 | shared library as 'libssl.so -> libssl.so.1.1' with | |
141 | the value of the symlink as the SONAME, a target | |
142 | definition that sets 'shlib_variant => "-abc"' will | |
143 | create 'libssl.so -> libssl-abc.so.1.1', again with | |
144 | an SONAME equal to the value of the symlink. The | |
145 | symbol versions associated with the variant library | |
146 | would then be 'OPENSSL_ABC_<version>' rather than | |
147 | the default 'OPENSSL_<version>'. The string inserted | |
148 | into symbol versions is obtained by mapping all | |
149 | letters in the "variant" identifier to upper case | |
150 | and all non-alphanumeric characters to '_'. | |
9e0724a1 | 151 | |
2ad9ef06 RL |
152 | thread_scheme => The type of threads is used on the |
153 | configured platform. Currently known | |
154 | values are "(unknown)", "pthreads", | |
155 | "uithreads" (a.k.a solaris threads) and | |
156 | "winthreads". Except for "(unknown)", the | |
157 | actual value is currently ignored but may | |
158 | be used in the future. See further notes | |
159 | below [2]. | |
9e0724a1 RL |
160 | dso_scheme => The type of dynamic shared objects to build |
161 | for. This mostly comes into play with | |
1842f369 | 162 | modules, but can be used for other purposes |
9e0724a1 RL |
163 | as well. Valid values are "DLFCN" |
164 | (dlopen() et al), "DLFCN_NO_H" (for systems | |
165 | that use dlopen() et al but do not have | |
166 | fcntl.h), "DL" (shl_load() et al), "WIN32" | |
167 | and "VMS". | |
e6f98ae4 RL |
168 | asm_arch => The architecture to be used for compiling assembly |
169 | source. This acts as a selector in build.info files. | |
b19fe714 RL |
170 | uplink_arch => The architecture to be used for compiling uplink |
171 | source. This acts as a selector in build.info files. | |
172 | This is separate from asm_arch because it's compiled | |
173 | even when 'no-asm' is given, even though it contains | |
174 | assembler source. | |
a8b2b52f | 175 | perlasm_scheme => The perlasm method used to create the |
9e0724a1 RL |
176 | assembler files used when compiling with |
177 | assembler implementations. | |
178 | shared_target => The shared library building method used. | |
ef2dfc99 RL |
179 | This serves multiple purposes: |
180 | - as index for targets found in shared_info.pl. | |
181 | - as linker script generation selector. | |
182 | To serve both purposes, the index for shared_info.pl | |
183 | should end with '-shared', and this suffix will be | |
184 | removed for use as a linker script generation | |
185 | selector. Note that the latter is only used if | |
186 | 'shared_defflag' is defined. | |
9e0724a1 | 187 | build_scheme => The scheme used to build up a Makefile. |
88087414 RL |
188 | In its simplest form, the value is a string |
189 | with the name of the build scheme. | |
190 | The value may also take the form of a list | |
191 | of strings, if the build_scheme is to have | |
192 | some options. In this case, the first | |
193 | string in the list is the name of the build | |
194 | scheme. | |
45c6e23c | 195 | Currently recognised build scheme is "unified". |
9fe2bb77 RL |
196 | For the "unified" build scheme, this item |
197 | *must* be an array with the first being the | |
198 | word "unified" and the second being a word | |
199 | to identify the platform family. | |
9e0724a1 RL |
200 | |
201 | multilib => On systems that support having multiple | |
202 | implementations of a library (typically a | |
203 | 32-bit and a 64-bit variant), this is used | |
204 | to have the different variants in different | |
205 | directories. | |
206 | ||
1bc563ca AP |
207 | bn_ops => Building options (was just bignum options in |
208 | the earlier history of this option, hence the | |
209 | name). This is a string of words that describe | |
210 | algorithms' implementation parameters that | |
211 | are optimal for the designated target platform, | |
212 | such as the type of integers used to build up | |
213 | the bignum, different ways to implement certain | |
214 | ciphers and so on. To fully comprehend the | |
9e0724a1 RL |
215 | meaning, the best is to read the affected |
216 | source. | |
217 | The valid words are: | |
218 | ||
1bc563ca AP |
219 | THIRTY_TWO_BIT bignum limbs are 32 bits, |
220 | this is default if no | |
221 | option is specified, it | |
222 | works on any supported | |
223 | system [unless "wider" | |
224 | limb size is implied in | |
225 | assembly code]; | |
226 | BN_LLONG bignum limbs are 32 bits, | |
227 | but 64-bit 'unsigned long | |
228 | long' is used internally | |
229 | in calculations; | |
230 | SIXTY_FOUR_BIT_LONG bignum limbs are 64 bits | |
231 | and sizeof(long) is 8; | |
232 | SIXTY_FOUR_BIT bignums limbs are 64 bits, | |
233 | but execution environment | |
234 | is ILP32; | |
235 | RC4_CHAR RC4 key schedule is made | |
236 | up of 'unsigned char's; | |
237 | RC4_INT RC4 key schedule is made | |
238 | up of 'unsigned int's; | |
9e0724a1 RL |
239 | EXPORT_VAR_AS_FN for shared libraries, |
240 | export vars as | |
241 | accessor functions. | |
242 | ||
9fe2bb77 | 243 | ec_asm_src => Assembler implementation of core EC |
9e0724a1 | 244 | functions. |
9fe2bb77 | 245 | des_asm_src => Assembler implementation of core DES |
9e0724a1 | 246 | encryption functions. |
9fe2bb77 RL |
247 | Defaults to 'des_enc.c fcrypt_b.c' |
248 | aes_asm_src => Assembler implementation of core AES | |
9e0724a1 | 249 | functions. |
9fe2bb77 RL |
250 | Defaults to 'aes_core.c aes_cbc.c' |
251 | bf_asm_src => Assembler implementation of core BlowFish | |
9e0724a1 | 252 | functions. |
9fe2bb77 RL |
253 | Defaults to 'bf_enc.c' |
254 | md5_asm_src => Assembler implementation of core MD5 | |
9e0724a1 | 255 | functions. |
9fe2bb77 | 256 | sha1_asm_src => Assembler implementation of core SHA1, |
9e0724a1 RL |
257 | functions, and also possibly SHA256 and |
258 | SHA512 ones. | |
9fe2bb77 | 259 | cast_asm_src => Assembler implementation of core CAST |
9e0724a1 | 260 | functions. |
9fe2bb77 RL |
261 | Defaults to 'c_enc.c' |
262 | rc4_asm_src => Assembler implementation of core RC4 | |
9e0724a1 | 263 | functions. |
9fe2bb77 RL |
264 | Defaults to 'rc4_enc.c rc4_skey.c' |
265 | rmd160_asm_src => Assembler implementation of core RMD160 | |
9e0724a1 | 266 | functions. |
9fe2bb77 | 267 | rc5_asm_src => Assembler implementation of core RC5 |
9e0724a1 | 268 | functions. |
9fe2bb77 RL |
269 | Defaults to 'rc5_enc.c' |
270 | wp_asm_src => Assembler implementation of core WHIRLPOOL | |
9e0724a1 | 271 | functions. |
9fe2bb77 | 272 | cmll_asm_src => Assembler implementation of core CAMELLIA |
9e0724a1 | 273 | functions. |
9fe2bb77 RL |
274 | Defaults to 'camellia.c cmll_misc.c cmll_cbc.c' |
275 | modes_asm_src => Assembler implementation of cipher modes, | |
276 | currently the functions gcm_gmult_4bit and | |
277 | gcm_ghash_4bit. | |
278 | padlock_asm_src => Assembler implementation of core parts of | |
9e0724a1 RL |
279 | the padlock engine. This is mandatory on |
280 | any platform where the padlock engine might | |
281 | actually be built. | |
282 | ||
283 | ||
284 | [1] as part of the target configuration, one can have a key called | |
285 | 'inherit_from' that indicate what other configurations to inherit | |
286 | data from. These are resolved recursively. | |
287 | ||
b6453a68 | 288 | Inheritance works as a set of default values that can be overridden |
9e0724a1 RL |
289 | by corresponding key values in the inheriting configuration. |
290 | ||
291 | Note 1: any configuration table can be used as a template. | |
292 | Note 2: pure templates have the attribute 'template => 1' and | |
293 | cannot be used as build targets. | |
294 | ||
295 | If several configurations are given in the 'inherit_from' array, | |
296 | the values of same attribute are concatenated with space | |
297 | separation. With this, it's possible to have several smaller | |
298 | templates for different configuration aspects that can be combined | |
299 | into a complete configuration. | |
300 | ||
301 | instead of a scalar value or an array, a value can be a code block | |
302 | of the form 'sub { /* your code here */ }'. This code block will | |
303 | be called with the list of inherited values for that key as | |
304 | arguments. In fact, the concatenation of strings is really done | |
305 | by using 'sub { join(" ",@_) }' on the list of inherited values. | |
306 | ||
307 | An example: | |
308 | ||
309 | "foo" => { | |
310 | template => 1, | |
311 | haha => "ha ha", | |
312 | hoho => "ho", | |
313 | ignored => "This should not appear in the end result", | |
314 | }, | |
315 | "bar" => { | |
316 | template => 1, | |
317 | haha => "ah", | |
318 | hoho => "haho", | |
319 | hehe => "hehe" | |
320 | }, | |
321 | "laughter" => { | |
322 | inherit_from => [ "foo", "bar" ], | |
323 | hehe => sub { join(" ",(@_,"!!!")) }, | |
324 | ignored => "", | |
325 | } | |
326 | ||
327 | The entry for "laughter" will become as follows after processing: | |
328 | ||
329 | "laughter" => { | |
330 | haha => "ha ha ah", | |
331 | hoho => "ho haho", | |
332 | hehe => "hehe !!!", | |
333 | ignored => "" | |
334 | } | |
335 | ||
336 | [2] OpenSSL is built with threading capabilities unless the user | |
2ad9ef06 | 337 | specifies 'no-threads'. The value of the key 'thread_scheme' may |
9e0724a1 RL |
338 | be "(unknown)", in which case the user MUST give some compilation |
339 | flags to Configure. | |
340 | ||
c86ddbe6 RL |
341 | [3] OpenSSL has three types of things to link from object files or |
342 | static libraries: | |
343 | ||
344 | - shared libraries; that would be libcrypto and libssl. | |
345 | - shared objects (sometimes called dynamic libraries); that would | |
1842f369 | 346 | be the modules. |
c86ddbe6 RL |
347 | - applications; those are apps/openssl and all the test apps. |
348 | ||
349 | Very roughly speaking, linking is done like this (words in braces | |
350 | represent the configuration settings documented at the beginning | |
351 | of this file): | |
352 | ||
353 | shared libraries: | |
310f28df RL |
354 | {ld} $(CFLAGS) {lflags} {shared_ldflag} -o libfoo.so \ |
355 | foo/something.o foo/somethingelse.o {ex_libs} | |
c86ddbe6 RL |
356 | |
357 | shared objects: | |
310f28df | 358 | {ld} $(CFLAGS) {lflags} {module_ldflags} -o libeng.so \ |
150624bc | 359 | blah1.o blah2.o -lcrypto {ex_libs} |
c86ddbe6 RL |
360 | |
361 | applications: | |
362 | {ld} $(CFLAGS) {lflags} -o app \ | |
150624bc | 363 | app1.o utils.o -lssl -lcrypto {ex_libs} |
c86ddbe6 | 364 | |
310f28df RL |
365 | [4] There are variants of these attribute, prefixed with `lib_', |
366 | `dso_' or `bin_'. Those variants replace the unprefixed attribute | |
367 | when building library, DSO or program modules specifically. | |
9e0724a1 RL |
368 | |
369 | Historically, the target configurations came in form of a string with | |
df71f0b8 RL |
370 | values separated by colons. This use is deprecated. The string form |
371 | looked like this: | |
9e0724a1 | 372 | |
f0bd4686 | 373 | "target" => "{cc}:{cflags}:{unistd}:{thread_cflag}:{sys_id}:{lflags}:{bn_ops}:{cpuid_obj}:{bn_obj}:{ec_obj}:{des_obj}:{aes_obj}:{bf_obj}:{md5_obj}:{sha1_obj}:{cast_obj}:{rc4_obj}:{rmd160_obj}:{rc5_obj}:{wp_obj}:{cmll_obj}:{modes_obj}:{padlock_obj}:{perlasm_scheme}:{dso_scheme}:{shared_target}:{shared_cflag}:{shared_ldflag}:{shared_extension}:{ranlib}:{arflags}:{multilib}" |
9fe2bb77 RL |
374 | |
375 | ||
376 | Build info files | |
377 | ================ | |
378 | ||
379 | The build.info files that are spread over the source tree contain the | |
380 | minimum information needed to build and distribute OpenSSL. It uses a | |
381 | simple and yet fairly powerful language to determine what needs to be | |
382 | built, from what sources, and other relationships between files. | |
383 | ||
384 | For every build.info file, all file references are relative to the | |
385 | directory of the build.info file for source files, and the | |
386 | corresponding build directory for built files if the build tree | |
387 | differs from the source tree. | |
388 | ||
389 | When processed, every line is processed with the perl module | |
390 | Text::Template, using the delimiters "{-" and "-}". The hashes | |
391 | %config and %target are passed to the perl fragments, along with | |
392 | $sourcedir and $builddir, which are the locations of the source | |
393 | directory for the current build.info file and the corresponding build | |
394 | directory, all relative to the top of the build tree. | |
395 | ||
7f73eafe RL |
396 | 'Configure' only knows inherently about the top build.info file. For |
397 | any other directory that has one, further directories to look into | |
398 | must be indicated like this: | |
399 | ||
400 | SUBDIRS=something someelse | |
401 | ||
402 | On to things to be built; they are declared by setting specific | |
9fe2bb77 RL |
403 | variables: |
404 | ||
405 | PROGRAMS=foo bar | |
406 | LIBS=libsomething | |
1842f369 | 407 | MODULES=libeng |
9fe2bb77 | 408 | SCRIPTS=myhack |
9fe2bb77 | 409 | |
1842f369 | 410 | Note that the files mentioned for PROGRAMS, LIBS and MODULES *must* be |
9fe2bb77 RL |
411 | without extensions. The build file templates will figure them out. |
412 | ||
413 | For each thing to be built, it is then possible to say what sources | |
414 | they are built from: | |
415 | ||
416 | PROGRAMS=foo bar | |
417 | SOURCE[foo]=foo.c common.c | |
418 | SOURCE[bar]=bar.c extra.c common.c | |
419 | ||
420 | It's also possible to tell some other dependencies: | |
421 | ||
422 | DEPEND[foo]=libsomething | |
423 | DEPEND[libbar]=libsomethingelse | |
424 | ||
425 | (it could be argued that 'libsomething' and 'libsomethingelse' are | |
426 | source as well. However, the files given through SOURCE are expected | |
427 | to be located in the source tree while files given through DEPEND are | |
428 | expected to be located in the build tree) | |
429 | ||
46f4e1be | 430 | It's also possible to depend on static libraries explicitly: |
473a9547 RL |
431 | |
432 | DEPEND[foo]=libsomething.a | |
433 | DEPEND[libbar]=libsomethingelse.a | |
434 | ||
435 | This should be rarely used, and care should be taken to make sure it's | |
436 | only used when supported. For example, native Windows build doesn't | |
a8b2b52f | 437 | support building static libraries and DLLs at the same time, so using |
473a9547 RL |
438 | static libraries on Windows can only be done when configured |
439 | 'no-shared'. | |
440 | ||
2a08d1a0 RL |
441 | In some cases, it's desirable to include some source files in the |
442 | shared form of a library only: | |
443 | ||
444 | SHARED_SOURCE[libfoo]=dllmain.c | |
445 | ||
9fe2bb77 RL |
446 | For any file to be built, it's also possible to tell what extra |
447 | include paths the build of their source files should use: | |
448 | ||
449 | INCLUDE[foo]=include | |
450 | ||
b96ab5e6 RL |
451 | It's also possible to specify C macros that should be defined: |
452 | ||
453 | DEFINE[foo]=FOO BAR=1 | |
454 | ||
ae4c7450 RL |
455 | In some cases, one might want to generate some source files from |
456 | others, that's done as follows: | |
457 | ||
458 | GENERATE[foo.s]=asm/something.pl $(CFLAGS) | |
459 | GENERATE[bar.s]=asm/bar.S | |
460 | ||
461 | The value of each GENERATE line is a command line or part of it. | |
436ad81f DB |
462 | Configure places no rules on the command line, except that the first |
463 | item must be the generator file. It is, however, entirely up to the | |
ae4c7450 RL |
464 | build file template to define exactly how those command lines should |
465 | be handled, how the output is captured and so on. | |
466 | ||
2036fd50 RL |
467 | Sometimes, the generator file itself depends on other files, for |
468 | example if it is a perl script that depends on other perl modules. | |
469 | This can be expressed using DEPEND like this: | |
470 | ||
471 | DEPEND[asm/something.pl]=../perlasm/Foo.pm | |
472 | ||
473 | There may also be cases where the exact file isn't easily specified, | |
474 | but an inclusion directory still needs to be specified. INCLUDE can | |
475 | be used in that case: | |
476 | ||
477 | INCLUDE[asm/something.pl]=../perlasm | |
478 | ||
ae4c7450 RL |
479 | NOTE: GENERATE lines are limited to one command only per GENERATE. |
480 | ||
9fe2bb77 RL |
481 | Finally, you can have some simple conditional use of the build.info |
482 | information, looking like this: | |
483 | ||
484 | IF[1] | |
485 | something | |
486 | ELSIF[2] | |
487 | something other | |
488 | ELSE | |
489 | something else | |
490 | ENDIF | |
491 | ||
492 | The expression in square brackets is interpreted as a string in perl, | |
493 | and will be seen as true if perl thinks it is, otherwise false. For | |
494 | example, the above would have "something" used, since 1 is true. | |
495 | ||
496 | Together with the use of Text::Template, this can be used as | |
497 | conditions based on something in the passed variables, for example: | |
498 | ||
84af1bae | 499 | IF[{- $disabled{shared} -}] |
9fe2bb77 RL |
500 | LIBS=libcrypto |
501 | SOURCE[libcrypto]=... | |
502 | ELSE | |
503 | LIBS=libfoo | |
504 | SOURCE[libfoo]=... | |
505 | ENDIF | |
506 | ||
ddf1847d RL |
507 | |
508 | Build-file programming with the "unified" build system | |
509 | ====================================================== | |
510 | ||
511 | "Build files" are called "Makefile" on Unix-like operating systems, | |
512 | "descrip.mms" for MMS on VMS, "makefile" for nmake on Windows, etc. | |
513 | ||
514 | To use the "unified" build system, the target configuration needs to | |
515 | set the three items 'build_scheme', 'build_file' and 'build_command'. | |
516 | In the rest of this section, we will assume that 'build_scheme' is set | |
517 | to "unified" (see the configurations documentation above for the | |
518 | details). | |
519 | ||
520 | For any name given by 'build_file', the "unified" system expects a | |
521 | template file in Configurations/ named like the build file, with | |
522 | ".tmpl" appended, or in case of possible ambiguity, a combination of | |
523 | the second 'build_scheme' list item and the 'build_file' name. For | |
524 | example, if 'build_file' is set to "Makefile", the template could be | |
525 | Configurations/Makefile.tmpl or Configurations/unix-Makefile.tmpl. | |
526 | In case both Configurations/unix-Makefile.tmpl and | |
527 | Configurations/Makefile.tmpl are present, the former takes | |
528 | precedence. | |
529 | ||
530 | The build-file template is processed with the perl module | |
531 | Text::Template, using "{-" and "-}" as delimiters that enclose the | |
532 | perl code fragments that generate configuration-dependent content. | |
533 | Those perl fragments have access to all the hash variables from | |
534 | configdata.pem. | |
535 | ||
536 | The build-file template is expected to define at least the following | |
537 | perl functions in a perl code fragment enclosed with "{-" and "-}". | |
538 | They are all expected to return a string with the lines they produce. | |
539 | ||
ae4c7450 RL |
540 | generatesrc - function that produces build file lines to generate |
541 | a source file from some input. | |
542 | ||
543 | It's called like this: | |
544 | ||
545 | generatesrc(src => "PATH/TO/tobegenerated", | |
546 | generator => [ "generatingfile", ... ] | |
2036fd50 RL |
547 | generator_incs => [ "INCL/PATH", ... ] |
548 | generator_deps => [ "dep1", ... ] | |
e38bd948 RL |
549 | generator => [ "generatingfile", ... ] |
550 | incs => [ "INCL/PATH", ... ], | |
ae4c7450 RL |
551 | deps => [ "dep1", ... ], |
552 | intent => one of "libs", "dso", "bin" ); | |
553 | ||
554 | 'src' has the name of the file to be generated. | |
555 | 'generator' is the command or part of command to | |
556 | generate the file, of which the first item is | |
557 | expected to be the file to generate from. | |
558 | generatesrc() is expected to analyse and figure out | |
559 | exactly how to apply that file and how to capture | |
2036fd50 RL |
560 | the result. 'generator_incs' and 'generator_deps' |
561 | are include directories and files that the generator | |
562 | file itself depends on. 'incs' and 'deps' are | |
563 | include directories and files that are used if $(CC) | |
564 | is used as an intermediary step when generating the | |
565 | end product (the file indicated by 'src'). 'intent' | |
566 | indicates what the generated file is going to be | |
567 | used for. | |
ae4c7450 | 568 | |
ddf1847d RL |
569 | src2obj - function that produces build file lines to build an |
570 | object file from source files and associated data. | |
571 | ||
572 | It's called like this: | |
573 | ||
574 | src2obj(obj => "PATH/TO/objectfile", | |
575 | srcs => [ "PATH/TO/sourcefile", ... ], | |
576 | deps => [ "dep1", ... ], | |
45502bfe RL |
577 | incs => [ "INCL/PATH", ... ] |
578 | intent => one of "lib", "dso", "bin" ); | |
ddf1847d | 579 | |
aa343982 RL |
580 | 'obj' has the intended object file with '.o' |
581 | extension, src2obj() is expected to change it to | |
582 | something more suitable for the platform. | |
ddf1847d RL |
583 | 'srcs' has the list of source files to build the |
584 | object file, with the first item being the source | |
585 | file that directly corresponds to the object file. | |
50e83cdd | 586 | 'deps' is a list of explicit dependencies. 'incs' |
45502bfe RL |
587 | is a list of include file directories. Finally, |
588 | 'intent' indicates what this object file is going | |
589 | to be used for. | |
ddf1847d RL |
590 | |
591 | obj2lib - function that produces build file lines to build a | |
592 | static library file ("libfoo.a" in Unix terms) from | |
593 | object files. | |
594 | ||
595 | called like this: | |
596 | ||
597 | obj2lib(lib => "PATH/TO/libfile", | |
598 | objs => [ "PATH/TO/objectfile", ... ]); | |
599 | ||
600 | 'lib' has the intended library file name *without* | |
601 | extension, obj2lib is expected to add that. 'objs' | |
aa343982 | 602 | has the list of object files to build this library. |
ddf1847d | 603 | |
aa343982 RL |
604 | libobj2shlib - backward compatibility function that's used the |
605 | same way as obj2shlib (described next), and was | |
606 | expected to build the shared library from the | |
607 | corresponding static library when that was suitable. | |
608 | NOTE: building a shared library from a static | |
609 | library is now DEPRECATED, as they no longer share | |
610 | object files. Attempting to do this will fail. | |
611 | ||
612 | obj2shlib - function that produces build file lines to build a | |
ddf1847d | 613 | shareable object library file ("libfoo.so" in Unix |
aa343982 | 614 | terms) from the corresponding object files. |
ddf1847d RL |
615 | |
616 | called like this: | |
617 | ||
aa343982 RL |
618 | obj2shlib(shlib => "PATH/TO/shlibfile", |
619 | lib => "PATH/TO/libfile", | |
620 | objs => [ "PATH/TO/objectfile", ... ], | |
621 | deps => [ "PATH/TO/otherlibfile", ... ]); | |
ddf1847d | 622 | |
aa343982 RL |
623 | 'lib' has the base (static) library ffile name |
624 | *without* extension. This is useful in case | |
625 | supporting files are needed (such as import | |
626 | libraries on Windows). | |
b6453a68 | 627 | 'shlib' has the corresponding shared library name |
ddf1847d RL |
628 | *without* extension. 'deps' has the list of other |
629 | libraries (also *without* extension) this library | |
630 | needs to be linked with. 'objs' has the list of | |
aa343982 | 631 | object files to build this library. |
ddf1847d | 632 | |
5386287c RL |
633 | obj2dso - function that produces build file lines to build a |
634 | dynamic shared object file from object files. | |
ddf1847d RL |
635 | |
636 | called like this: | |
637 | ||
5386287c RL |
638 | obj2dso(lib => "PATH/TO/libfile", |
639 | objs => [ "PATH/TO/objectfile", ... ], | |
640 | deps => [ "PATH/TO/otherlibfile", | |
641 | ... ]); | |
ddf1847d | 642 | |
aa343982 | 643 | This is almost the same as obj2shlib, but the |
ddf1847d | 644 | intent is to build a shareable library that can be |
aa343982 | 645 | loaded in runtime (a "plugin"...). |
ddf1847d RL |
646 | |
647 | obj2bin - function that produces build file lines to build an | |
648 | executable file from object files. | |
649 | ||
650 | called like this: | |
651 | ||
652 | obj2bin(bin => "PATH/TO/binfile", | |
653 | objs => [ "PATH/TO/objectfile", ... ], | |
654 | deps => [ "PATH/TO/libfile", ... ]); | |
655 | ||
656 | 'bin' has the intended executable file name | |
657 | *without* extension, obj2bin is expected to add | |
aa343982 RL |
658 | that. 'objs' has the list of object files to build |
659 | this library. 'deps' has the list of library files | |
660 | (also *without* extension) that the programs needs | |
661 | to be linked with. | |
ddf1847d RL |
662 | |
663 | in2script - function that produces build file lines to build a | |
664 | script file from some input. | |
665 | ||
666 | called like this: | |
667 | ||
668 | in2script(script => "PATH/TO/scriptfile", | |
669 | sources => [ "PATH/TO/infile", ... ]); | |
670 | ||
671 | 'script' has the intended script file name. | |
672 | 'sources' has the list of source files to build the | |
673 | resulting script from. | |
674 | ||
675 | In all cases, file file paths are relative to the build tree top, and | |
676 | the build file actions run with the build tree top as current working | |
677 | directory. | |
678 | ||
679 | Make sure to end the section with these functions with a string that | |
b6453a68 | 680 | you thing is appropriate for the resulting build file. If nothing |
ddf1847d RL |
681 | else, end it like this: |
682 | ||
683 | ""; # Make sure no lingering values end up in the Makefile | |
684 | -} | |
44eb65ce RL |
685 | |
686 | ||
687 | Configure helper scripts | |
688 | ======================== | |
689 | ||
690 | Configure uses helper scripts in this directory: | |
691 | ||
692 | Checker scripts | |
693 | --------------- | |
694 | ||
695 | These scripts are per platform family, to check the integrity of the | |
696 | tools used for configuration and building. The checker script used is | |
697 | either {build_platform}-{build_file}-checker.pm or | |
698 | {build_platform}-checker.pm, where {build_platform} is the second | |
699 | 'build_scheme' list element from the configuration target data, and | |
700 | {build_file} is 'build_file' from the same target data. | |
701 | ||
702 | If the check succeeds, the script is expected to end with a non-zero | |
703 | expression. If the check fails, the script can end with a zero, or | |
704 | with a `die`. |