4 This directory contains a few sets of files that are used for
5 configuration in diverse ways:
7 *.conf Target platform configurations, please read
8 'Configurations of OpenSSL target platforms' for more
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
18 Configurations of OpenSSL target platforms
19 ==========================================
21 Target configurations are a collection of facts that we know about
22 different platforms and their capabilities. We organise them in a
23 hash table, where each entry represent a specific target.
25 In each table entry, the following keys are significant:
27 inherit_from => Other targets to inherit values from.
28 Explained further below. [1]
29 template => Set to 1 if this isn't really a platform
30 target. Instead, this target is a template
31 upon which other targets can be built.
32 Explained further below. [1]
34 sys_id => System identity for systems where that
35 is difficult to determine automatically.
37 cc => The compiler command, usually one of "cc",
38 "gcc" or "clang". This command is normally
39 also used to link object files and
40 libraries into the final program.
41 cflags => Flags that are used at all times when
43 defines => As an alternative, macro definitions may be
44 present here instead of in `cflags'. If
45 given here, they MUST be as an array of the
46 string such as "MACRO=value", or just
47 "MACRO" for definitions without value.
48 shared_cflag => Extra compilation flags used when
49 compiling for shared libraries, typically
50 something like "-fPIC".
52 (linking is a complex thing, see [3] below)
53 ld => Linker command, usually not defined
54 (meaning the compiler command is used
56 (NOTE: this is here for future use, it's
58 lflags => Flags that are used when linking apps.
59 shared_ldflag => Flags that are used when linking shared
61 plib_lflags => Extra linking flags to appear just before
62 the libraries on the command line.
63 ex_libs => Extra libraries that are needed when
66 ar => The library archive command, the default is
68 (NOTE: this is here for future use, it's
70 arflags => Flags to be used with the library archive
73 ranlib => The library archive indexing command, the
74 default is 'ranlib' it it exists.
76 unistd => An alternative header to the typical
77 '<unistd.h>'. This is very rarely needed.
79 shared_extension => File name extension used for shared
81 obj_extension => File name extension used for object files.
82 On unix, this defaults to ".o" (NOTE: this
83 is here for future use, it's not
85 exe_extension => File name extension used for executable
86 files. On unix, this defaults to "" (NOTE:
87 this is here for future use, it's not
90 thread_scheme => The type of threads is used on the
91 configured platform. Currently known
92 values are "(unknown)", "pthreads",
93 "uithreads" (a.k.a solaris threads) and
94 "winthreads". Except for "(unknown)", the
95 actual value is currently ignored but may
96 be used in the future. See further notes
98 dso_scheme => The type of dynamic shared objects to build
99 for. This mostly comes into play with
100 engines, but can be used for other purposes
101 as well. Valid values are "DLFCN"
102 (dlopen() et al), "DLFCN_NO_H" (for systems
103 that use dlopen() et al but do not have
104 fcntl.h), "DL" (shl_load() et al), "WIN32"
106 perlasm_scheme => The perlasm method used to created the
107 assembler files used when compiling with
108 assembler implementations.
109 shared_target => The shared library building method used.
110 This is a target found in Makefile.shared.
111 build_scheme => The scheme used to build up a Makefile.
112 In its simplest form, the value is a string
113 with the name of the build scheme.
114 The value may also take the form of a list
115 of strings, if the build_scheme is to have
116 some options. In this case, the first
117 string in the list is the name of the build
119 Currently recognised build scheme is "unified".
120 For the "unified" build scheme, this item
121 *must* be an array with the first being the
122 word "unified" and the second being a word
123 to identify the platform family.
125 multilib => On systems that support having multiple
126 implementations of a library (typically a
127 32-bit and a 64-bit variant), this is used
128 to have the different variants in different
131 bn_ops => Building options (was just bignum options in
132 the earlier history of this option, hence the
133 name). This is a string of words that describe
134 algorithms' implementation parameters that
135 are optimal for the designated target platform,
136 such as the type of integers used to build up
137 the bignum, different ways to implement certain
138 ciphers and so on. To fully comprehend the
139 meaning, the best is to read the affected
143 THIRTY_TWO_BIT bignum limbs are 32 bits,
144 this is default if no
145 option is specified, it
146 works on any supported
147 system [unless "wider"
148 limb size is implied in
150 BN_LLONG bignum limbs are 32 bits,
151 but 64-bit 'unsigned long
152 long' is used internally
154 SIXTY_FOUR_BIT_LONG bignum limbs are 64 bits
155 and sizeof(long) is 8;
156 SIXTY_FOUR_BIT bignums limbs are 64 bits,
157 but execution environment
159 RC4_CHAR RC4 key schedule is made
160 up of 'unsigned char's;
161 RC4_INT RC4 key schedule is made
162 up of 'unsigned int's;
163 EXPORT_VAR_AS_FN for shared libraries,
167 apps_extra_src => Extra source to build apps/openssl, as
168 needed by the target.
169 cpuid_asm_src => assembler implementation of cpuid code as
170 well as OPENSSL_cleanse().
172 bn_asm_src => Assembler implementation of core bignum
175 ec_asm_src => Assembler implementation of core EC
177 des_asm_src => Assembler implementation of core DES
178 encryption functions.
179 Defaults to 'des_enc.c fcrypt_b.c'
180 aes_asm_src => Assembler implementation of core AES
182 Defaults to 'aes_core.c aes_cbc.c'
183 bf_asm_src => Assembler implementation of core BlowFish
185 Defaults to 'bf_enc.c'
186 md5_asm_src => Assembler implementation of core MD5
188 sha1_asm_src => Assembler implementation of core SHA1,
189 functions, and also possibly SHA256 and
191 cast_asm_src => Assembler implementation of core CAST
193 Defaults to 'c_enc.c'
194 rc4_asm_src => Assembler implementation of core RC4
196 Defaults to 'rc4_enc.c rc4_skey.c'
197 rmd160_asm_src => Assembler implementation of core RMD160
199 rc5_asm_src => Assembler implementation of core RC5
201 Defaults to 'rc5_enc.c'
202 wp_asm_src => Assembler implementation of core WHIRLPOOL
204 cmll_asm_src => Assembler implementation of core CAMELLIA
206 Defaults to 'camellia.c cmll_misc.c cmll_cbc.c'
207 modes_asm_src => Assembler implementation of cipher modes,
208 currently the functions gcm_gmult_4bit and
210 padlock_asm_src => Assembler implementation of core parts of
211 the padlock engine. This is mandatory on
212 any platform where the padlock engine might
216 [1] as part of the target configuration, one can have a key called
217 'inherit_from' that indicate what other configurations to inherit
218 data from. These are resolved recursively.
220 Inheritance works as a set of default values that can be overridden
221 by corresponding key values in the inheriting configuration.
223 Note 1: any configuration table can be used as a template.
224 Note 2: pure templates have the attribute 'template => 1' and
225 cannot be used as build targets.
227 If several configurations are given in the 'inherit_from' array,
228 the values of same attribute are concatenated with space
229 separation. With this, it's possible to have several smaller
230 templates for different configuration aspects that can be combined
231 into a complete configuration.
233 instead of a scalar value or an array, a value can be a code block
234 of the form 'sub { /* your code here */ }'. This code block will
235 be called with the list of inherited values for that key as
236 arguments. In fact, the concatenation of strings is really done
237 by using 'sub { join(" ",@_) }' on the list of inherited values.
245 ignored => "This should not appear in the end result",
254 inherit_from => [ "foo", "bar" ],
255 hehe => sub { join(" ",(@_,"!!!")) },
259 The entry for "laughter" will become as follows after processing:
268 [2] OpenSSL is built with threading capabilities unless the user
269 specifies 'no-threads'. The value of the key 'thread_scheme' may
270 be "(unknown)", in which case the user MUST give some compilation
273 [3] OpenSSL has three types of things to link from object files or
276 - shared libraries; that would be libcrypto and libssl.
277 - shared objects (sometimes called dynamic libraries); that would
279 - applications; those are apps/openssl and all the test apps.
281 Very roughly speaking, linking is done like this (words in braces
282 represent the configuration settings documented at the beginning
286 {ld} $(CFLAGS) {shared_ldflag} -shared -o libfoo.so \
287 -Wl,--whole-archive libfoo.a -Wl,--no-whole-archive \
288 {plib_lflags} -lcrypto {ex_libs}
291 {ld} $(CFLAGS) {shared_ldflag} -shared -o libeng.so \
292 blah1.o blah2.o {plib_lflags} -lcrypto {ex_libs}
295 {ld} $(CFLAGS) {lflags} -o app \
296 app1.o utils.o {plib_lflags} -lssl -lcrypto {ex_libs}
299 Historically, the target configurations came in form of a string with
300 values separated by colons. This use is deprecated. The string form
303 "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}"
309 The build.info files that are spread over the source tree contain the
310 minimum information needed to build and distribute OpenSSL. It uses a
311 simple and yet fairly powerful language to determine what needs to be
312 built, from what sources, and other relationships between files.
314 For every build.info file, all file references are relative to the
315 directory of the build.info file for source files, and the
316 corresponding build directory for built files if the build tree
317 differs from the source tree.
319 When processed, every line is processed with the perl module
320 Text::Template, using the delimiters "{-" and "-}". The hashes
321 %config and %target are passed to the perl fragments, along with
322 $sourcedir and $builddir, which are the locations of the source
323 directory for the current build.info file and the corresponding build
324 directory, all relative to the top of the build tree.
326 To begin with, things to be built are declared by setting specific
335 Note that the files mentioned for PROGRAMS, LIBS and ENGINES *must* be
336 without extensions. The build file templates will figure them out.
338 For each thing to be built, it is then possible to say what sources
342 SOURCE[foo]=foo.c common.c
343 SOURCE[bar]=bar.c extra.c common.c
345 It's also possible to tell some other dependencies:
347 DEPEND[foo]=libsomething
348 DEPEND[libbar]=libsomethingelse
350 (it could be argued that 'libsomething' and 'libsomethingelse' are
351 source as well. However, the files given through SOURCE are expected
352 to be located in the source tree while files given through DEPEND are
353 expected to be located in the build tree)
355 For some libraries, we maintain files with public symbols and their
356 slot in a transfer vector (important on some platforms). It can be
359 ORDINALS[libcrypto]=crypto
361 The value is not the name of the file in question, but rather the
362 argument to util/mkdef.pl that indicates which file to use.
364 One some platforms, shared libraries come with a name that's different
365 from their static counterpart. That's declared as follows:
367 SHARED_NAME[libfoo]=cygfoo-{- $config{shlibver} -}
369 The example is from Cygwin, which has a required naming convention.
371 Sometimes, it makes sense to rename an output file, for example a
374 RENAME[libfoo]=libbar
376 That lines has "libfoo" get renamed to "libbar". While it makes no
377 sense at all to just have a rename like that (why not just use
378 "libbar" everywhere?), it does make sense when it can be used
379 conditionally. See a little further below for an example.
381 In some cases, it's desirable to include some source files in the
382 shared form of a library only:
384 SHARED_SOURCE[libfoo]=dllmain.c
386 For any file to be built, it's also possible to tell what extra
387 include paths the build of their source files should use:
391 In some cases, one might want to generate some source files from
392 others, that's done as follows:
394 GENERATE[foo.s]=asm/something.pl $(CFLAGS)
395 GENERATE[bar.s]=asm/bar.S
397 The value of each GENERATE line is a command line or part of it.
398 Configure places no rules on the command line, except the the first
399 item muct be the generator file. It is, however, entirely up to the
400 build file template to define exactly how those command lines should
401 be handled, how the output is captured and so on.
403 Sometimes, the generator file itself depends on other files, for
404 example if it is a perl script that depends on other perl modules.
405 This can be expressed using DEPEND like this:
407 DEPEND[asm/something.pl]=../perlasm/Foo.pm
409 There may also be cases where the exact file isn't easily specified,
410 but an inclusion directory still needs to be specified. INCLUDE can
411 be used in that case:
413 INCLUDE[asm/something.pl]=../perlasm
415 NOTE: GENERATE lines are limited to one command only per GENERATE.
417 As a last resort, it's possible to have raw build file lines, between
418 BEGINRAW and ENDRAW lines as follows:
420 BEGINRAW[Makefile(unix)]
421 haha.h: {- $builddir -}/Makefile
422 echo "/* haha */" > haha.h
423 ENDRAW[Makefile(unix)]
425 The word within square brackets is the build_file configuration item
426 or the build_file configuration item followed by the second word in the
427 build_scheme configuration item for the configured target within
428 parenthesis as shown above. For example, with the following relevant
431 build_file => "build.ninja"
432 build_scheme => [ "unified", "unix" ]
434 ... these lines will be considered:
436 BEGINRAW[build.ninja]
437 build haha.h: echo "/* haha */" > haha.h
440 BEGINRAW[build.ninja(unix)]
441 build hoho.h: echo "/* hoho */" > hoho.h
442 ENDRAW[build.ninja(unix)]
444 Should it be needed because the recipes within a RAW section might
445 clash with those generated by Configure, it's possible to tell it
446 not to generate them with the use of OVERRIDES, for example:
448 SOURCE[libfoo]=foo.c bar.c
451 BEGINRAW[Makefile(unix)]
453 $(CC) $(CFLAGS) -DSPECIAL -c -o $@ $<
454 ENDRAW[Makefile(unix)]
456 See the documentation further up for more information on configuration
459 Finally, you can have some simple conditional use of the build.info
460 information, looking like this:
470 The expression in square brackets is interpreted as a string in perl,
471 and will be seen as true if perl thinks it is, otherwise false. For
472 example, the above would have "something" used, since 1 is true.
474 Together with the use of Text::Template, this can be used as
475 conditions based on something in the passed variables, for example:
477 IF[{- $disabled{shared} -}]
479 SOURCE[libcrypto]=...
487 # VMS has a cultural standard where all libraries are prefixed.
488 # For OpenSSL, the choice is 'ossl_'
489 IF[{- $config{target} =~ /^vms/ -}]
490 RENAME[libcrypto]=ossl_libcrypto
491 RENAME[libssl]=ossl_libssl
495 Build-file programming with the "unified" build system
496 ======================================================
498 "Build files" are called "Makefile" on Unix-like operating systems,
499 "descrip.mms" for MMS on VMS, "makefile" for nmake on Windows, etc.
501 To use the "unified" build system, the target configuration needs to
502 set the three items 'build_scheme', 'build_file' and 'build_command'.
503 In the rest of this section, we will assume that 'build_scheme' is set
504 to "unified" (see the configurations documentation above for the
507 For any name given by 'build_file', the "unified" system expects a
508 template file in Configurations/ named like the build file, with
509 ".tmpl" appended, or in case of possible ambiguity, a combination of
510 the second 'build_scheme' list item and the 'build_file' name. For
511 example, if 'build_file' is set to "Makefile", the template could be
512 Configurations/Makefile.tmpl or Configurations/unix-Makefile.tmpl.
513 In case both Configurations/unix-Makefile.tmpl and
514 Configurations/Makefile.tmpl are present, the former takes
517 The build-file template is processed with the perl module
518 Text::Template, using "{-" and "-}" as delimiters that enclose the
519 perl code fragments that generate configuration-dependent content.
520 Those perl fragments have access to all the hash variables from
523 The build-file template is expected to define at least the following
524 perl functions in a perl code fragment enclosed with "{-" and "-}".
525 They are all expected to return a string with the lines they produce.
527 generatesrc - function that produces build file lines to generate
528 a source file from some input.
530 It's called like this:
532 generatesrc(src => "PATH/TO/tobegenerated",
533 generator => [ "generatingfile", ... ]
534 generator_incs => [ "INCL/PATH", ... ]
535 generator_deps => [ "dep1", ... ]
536 generator => [ "generatingfile", ... ]
537 incs => [ "INCL/PATH", ... ],
538 deps => [ "dep1", ... ],
539 intent => one of "libs", "dso", "bin" );
541 'src' has the name of the file to be generated.
542 'generator' is the command or part of command to
543 generate the file, of which the first item is
544 expected to be the file to generate from.
545 generatesrc() is expected to analyse and figure out
546 exactly how to apply that file and how to capture
547 the result. 'generator_incs' and 'generator_deps'
548 are include directories and files that the generator
549 file itself depends on. 'incs' and 'deps' are
550 include directories and files that are used if $(CC)
551 is used as an intermediary step when generating the
552 end product (the file indicated by 'src'). 'intent'
553 indicates what the generated file is going to be
556 src2obj - function that produces build file lines to build an
557 object file from source files and associated data.
559 It's called like this:
561 src2obj(obj => "PATH/TO/objectfile",
562 srcs => [ "PATH/TO/sourcefile", ... ],
563 deps => [ "dep1", ... ],
564 incs => [ "INCL/PATH", ... ]
565 intent => one of "lib", "dso", "bin" );
567 'obj' has the intended object file *without*
568 extension, src2obj() is expected to add that.
569 'srcs' has the list of source files to build the
570 object file, with the first item being the source
571 file that directly corresponds to the object file.
572 'deps' is a list of explicit dependencies. 'incs'
573 is a list of include file directories. Finally,
574 'intent' indicates what this object file is going
577 obj2lib - function that produces build file lines to build a
578 static library file ("libfoo.a" in Unix terms) from
583 obj2lib(lib => "PATH/TO/libfile",
584 objs => [ "PATH/TO/objectfile", ... ]);
586 'lib' has the intended library file name *without*
587 extension, obj2lib is expected to add that. 'objs'
588 has the list of object files (also *without*
589 extension) to build this library.
591 libobj2shlib - function that produces build file lines to build a
592 shareable object library file ("libfoo.so" in Unix
593 terms) from the corresponding static library file
598 libobj2shlib(shlib => "PATH/TO/shlibfile",
599 lib => "PATH/TO/libfile",
600 objs => [ "PATH/TO/objectfile", ... ],
601 deps => [ "PATH/TO/otherlibfile", ... ],
602 ordinals => [ "word", "/PATH/TO/ordfile" ]);
604 'lib' has the intended library file name *without*
605 extension, libobj2shlib is expected to add that.
606 'shlib' has the corresponding shared library name
607 *without* extension. 'deps' has the list of other
608 libraries (also *without* extension) this library
609 needs to be linked with. 'objs' has the list of
610 object files (also *without* extension) to build
611 this library. 'ordinals' MAY be present, and when
612 it is, its value is an array where the word is
613 "crypto" or "ssl" and the file is one of the ordinal
614 files util/libeay.num or util/ssleay.num in the
617 This function has a choice; it can use the
618 corresponding static library as input to make the
619 shared library, or the list of object files.
621 obj2dso - function that produces build file lines to build a
622 dynamic shared object file from object files.
626 obj2dso(lib => "PATH/TO/libfile",
627 objs => [ "PATH/TO/objectfile", ... ],
628 deps => [ "PATH/TO/otherlibfile",
631 This is almost the same as libobj2shlib, but the
632 intent is to build a shareable library that can be
633 loaded in runtime (a "plugin"...). The differences
634 are subtle, one of the most visible ones is that the
635 resulting shareable library is produced from object
638 obj2bin - function that produces build file lines to build an
639 executable file from object files.
643 obj2bin(bin => "PATH/TO/binfile",
644 objs => [ "PATH/TO/objectfile", ... ],
645 deps => [ "PATH/TO/libfile", ... ]);
647 'bin' has the intended executable file name
648 *without* extension, obj2bin is expected to add
649 that. 'objs' has the list of object files (also
650 *without* extension) to build this library. 'deps'
651 has the list of library files (also *without*
652 extension) that the programs needs to be linked
655 in2script - function that produces build file lines to build a
656 script file from some input.
660 in2script(script => "PATH/TO/scriptfile",
661 sources => [ "PATH/TO/infile", ... ]);
663 'script' has the intended script file name.
664 'sources' has the list of source files to build the
665 resulting script from.
667 In all cases, file file paths are relative to the build tree top, and
668 the build file actions run with the build tree top as current working
671 Make sure to end the section with these functions with a string that
672 you thing is appropriate for the resulting build file. If nothing
673 else, end it like this:
675 ""; # Make sure no lingering values end up in the Makefile
679 Configure helper scripts
680 ========================
682 Configure uses helper scripts in this directory:
687 These scripts are per platform family, to check the integrity of the
688 tools used for configuration and building. The checker script used is
689 either {build_platform}-{build_file}-checker.pm or
690 {build_platform}-checker.pm, where {build_platform} is the second
691 'build_scheme' list element from the configuration target data, and
692 {build_file} is 'build_file' from the same target data.
694 If the check succeeds, the script is expected to end with a non-zero
695 expression. If the check fails, the script can end with a zero, or