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