1 #! {- $config{HASHBANGPERL} -}
7 # indent => callers indentation (int)
8 # delimiters => 1 if outer delimiters should be added
11 my $indent = $opts{indent} // 0;
12 # Indentation of the whole structure, where applicable
13 my $nlindent1 = "\n" . ' ' x $indent;
14 # Indentation of individual items, where applicable
15 my $nlindent2 = "\n" . ' ' x ($indent + 4);
17 my $product; # Finished product, or reference to a function that
18 # produces a string, given $_
19 # The following are only used when $product is a function reference
20 my $delim_l; # Left delimiter of structure
21 my $delim_r; # Right delimiter of structure
22 my $separator; # Item separator
23 my @items; # Items to iterate over
25 if (ref($ref) eq "ARRAY") {
26 if (scalar @$ref == 0) {
27 $product = $opts{delimiters} ? '[]' : '';
30 out_item(\$_, delimiters => 1, indent => $indent + 4)
32 $delim_l = ($opts{delimiters} ? '[' : '').$nlindent2;
33 $delim_r = $nlindent1.($opts{delimiters} ? ']' : '');
34 $separator = ",$nlindent2";
37 } elsif (ref($ref) eq "HASH") {
38 if (scalar keys %$ref == 0) {
39 $product = $opts{delimiters} ? '{}' : '';
43 . out_item($ref->{$_}, delimiters => 1, indent => $indent + 4)
45 $delim_l = ($opts{delimiters} ? '{' : '').$nlindent2;
46 $delim_r = $nlindent1.($opts{delimiters} ? '}' : '');
47 $separator = ",$nlindent2";
48 @items = sort keys %$ref;
50 } elsif (ref($ref) eq "SCALAR") {
51 $product = defined $$ref ? quotify1 $$ref : "undef";
53 $product = defined $ref ? quotify1 $ref : "undef";
56 if (ref($product) eq "CODE") {
57 $delim_l . join($separator, map { &$product } @items) . $delim_r;
63 # We must make sourcedir() return an absolute path, because configdata.pm
64 # may be loaded as a module from any script in any directory, making
65 # relative paths untrustable. Because the result is used with 'use lib',
66 # we must ensure that it returns a Unix style path. Cwd::abs_path does
67 # that (File::Spec::Functions::rel2abs return O/S specific paths)
68 use File::Spec::Functions;
71 return abs_path(catdir($config{sourcedir}, @_));
74 return abs_path(catfile($config{sourcedir}, @_));
83 our @ISA = qw(Exporter);
85 %config %target %disabled %withargs %unified_info
86 @disablables @disablables_int
89 our %config = ({- out_item(\%config); -});
90 our %target = ({- out_item(\%target); -});
91 our @disablables = ({- out_item(\@disablables) -});
92 our @disablables_int = ({- out_item(\@disablables_int) -});
93 our %disabled = ({- out_item(\%disabled); -});
94 our %withargs = ({- out_item(\%withargs); -});
95 our %unified_info = ({- out_item(\%unified_info); -});
97 # Unexported, only used by OpenSSL::Test::Utils::available_protocols()
98 our %available_protocols = (
99 tls => [{- out_item(\@tls) -}],
100 dtls => [{- out_item(\@dtls) -}],
103 # The following data is only used when this files is use as a script
104 my @makevars = ({- out_item(\@makevars); -});
105 my %disabled_info = ({- out_item(\%disabled_info); -});
106 my @user_crossable = qw( {- join (' ', @user_crossable) -} );
108 # If run directly, we can give some answers, and even reconfigure
111 use File::Spec::Functions;
115 my $here = dirname($0);
117 if (scalar @ARGV == 0) {
118 # With no arguments, re-create the build file
120 use lib '{- sourcedir('util', 'perl') -}';
121 use OpenSSL::fallback '{- sourcefile('external', 'perl', 'MODULES.txt') -}';
122 use OpenSSL::Template;
124 my $prepend = <<"_____";
125 use File::Spec::Functions;
126 use lib '{- sourcedir('util', 'perl') -}';
127 use lib '{- sourcedir('Configurations') -}';
128 use lib '{- $config{builddir} -}';
133 'WARNING: do not edit!',
134 "Generated by configdata.pm from "
135 .join(", ", @{$config{build_file_templates}})
138 print 'Creating ',$target{build_file},"\n";
139 open BUILDFILE, ">$target{build_file}.new"
140 or die "Trying to create $target{build_file}.new: $!";
141 foreach (@{$config{build_file_templates}}) {
142 my $tmpl = OpenSSL::Template->new(TYPE => 'FILE',
144 $tmpl->fill_in(FILENAME => $_,
145 OUTPUT => \*BUILDFILE,
146 HASH => { config => \%config,
148 disabled => \%disabled,
149 withargs => \%withargs,
150 unified_info => \%unified_info,
151 autowarntext => \@autowarntext },
153 # To ensure that global variables and functions
154 # defined in one template stick around for the
155 # next, making them combinable
156 PACKAGE => 'OpenSSL::safe')
157 or die $Text::Template::ERROR;
160 rename("$target{build_file}.new", $target{build_file})
161 or die "Trying to rename $target{build_file}.new to $target{build_file}: $!";
171 my $makevars = undef;
172 my $buildparams = undef;
177 GetOptions('dump|d' => \$dump,
178 'command-line|c' => \$cmdline,
179 'options|o' => \$options,
180 'target|t' => \$target,
181 'environment|e' => \$envvars,
182 'make-variables|m' => \$makevars,
183 'build-parameters|b' => \$buildparams,
184 'reconfigure|reconf|r' => \$reconf,
185 'verbose|v' => \$verbose,
188 or die "Errors in command line arguments\n";
190 if (scalar @ARGV > 0) {
191 print STDERR <<"_____";
192 Unrecognised arguments.
193 For more information, do '$0 --help'
199 pod2usage(-exitval => 0,
203 pod2usage(-exitval => 0,
206 if ($dump || $cmdline) {
207 print "\nCommand line (with current working directory = $here):\n\n";
210 catfile($config{sourcedir}, 'Configure'),
211 @{$config{perlargv}}), "\n";
212 print "\nPerl information:\n\n";
213 print ' ',$config{perl_cmd},"\n";
214 print ' ',$config{perl_version},' for ',$config{perl_archname},"\n";
216 if ($dump || $options) {
219 foreach my $what (@disablables) {
220 $longest = length($what) if $longest < length($what);
221 $longest2 = length($disabled{$what})
222 if $disabled{$what} && $longest2 < length($disabled{$what});
224 print "\nEnabled features:\n\n";
225 foreach my $what (@disablables) {
226 print " $what\n" unless $disabled{$what};
228 print "\nDisabled features:\n\n";
229 foreach my $what (@disablables) {
230 if ($disabled{$what}) {
231 print " $what", ' ' x ($longest - length($what) + 1),
232 "[$disabled{$what}]", ' ' x ($longest2 - length($disabled{$what}) + 1);
233 print $disabled_info{$what}->{macro}
234 if $disabled_info{$what}->{macro};
236 join(', ', @{$disabled_info{$what}->{skipped}}),
238 if $disabled_info{$what}->{skipped};
243 if ($dump || $target) {
244 print "\nConfig target attributes:\n\n";
245 foreach (sort keys %target) {
246 next if $_ =~ m|^_| || $_ eq 'template';
250 (my $x = $_) =~ s|([\\\$\@"])|\\$1|g; "\"$x\""
256 print ' ', $_, ' => ';
257 if (ref($target{$_}) eq "ARRAY") {
258 print '[ ', join(', ', $quotify->(@{$target{$_}})), " ],\n";
260 print $quotify->($target{$_}), ",\n"
264 if ($dump || $envvars) {
265 print "\nRecorded environment:\n\n";
266 foreach (sort keys %{$config{perlenv}}) {
267 print ' ',$_,' = ',($config{perlenv}->{$_} || ''),"\n";
270 if ($dump || $makevars) {
271 print "\nMakevars:\n\n";
272 foreach my $var (@makevars) {
274 $prefix = $config{CROSS_COMPILE}
275 if grep { $var eq $_ } @user_crossable;
277 print ' ',$var,' ' x (16 - length $var),'= ',
278 (ref $config{$var} eq 'ARRAY'
279 ? join(' ', @{$config{$var}})
280 : $prefix.$config{$var}),
282 if defined $config{$var};
285 my @buildfile = ($config{builddir}, $config{build_file});
286 unshift @buildfile, $here
287 unless file_name_is_absolute($config{builddir});
288 my $buildfile = canonpath(catdir(@buildfile));
291 NOTE: These variables only represent the configuration view. The build file
292 template may have processed these variables further, please have a look at the
293 build file for more exact data:
297 if ($dump || $buildparams) {
298 my @buildfile = ($config{builddir}, $config{build_file});
299 unshift @buildfile, $here
300 unless file_name_is_absolute($config{builddir});
301 print "\nbuild file:\n\n";
302 print " ", canonpath(catfile(@buildfile)),"\n";
304 print "\nbuild file templates:\n\n";
305 foreach (@{$config{build_file_templates}}) {
308 unless file_name_is_absolute($config{sourcedir});
309 print ' ',canonpath(catfile(@tmpl)),"\n";
314 print 'Reconfiguring with: ', join(' ',@{$config{perlargv}}), "\n";
315 foreach (sort keys %{$config{perlenv}}) {
316 print ' ',$_,' = ',($config{perlenv}->{$_} || ""),"\n";
321 exec $^X,catfile($config{sourcedir}, 'Configure'),'reconf';
331 configdata.pm - configuration data for OpenSSL builds
337 perl configdata.pm [options]
345 This module can be used in two modes, interactively and as a module containing
346 all the data recorded by OpenSSL's Configure script.
348 When used interactively, simply run it as any perl script.
349 If run with no arguments, it will rebuild the build file (Makefile or
351 With at least one option, it will instead get the information you ask for, or
352 re-run the configuration process.
353 See L</OPTIONS> below for more information.
355 When loaded as a module, you get a few databanks with useful information to
356 perform build related tasks. The databanks are:
358 %config Configured things.
359 %target The OpenSSL config target with all inheritances
361 %disabled The features that are disabled.
362 @disablables The list of features that can be disabled.
363 %withargs All data given through --with-THING options.
364 %unified_info All information that was computed from the build.info
373 Print a brief help message and exit.
377 Print the manual page and exit.
379 =item B<--dump> | B<-d>
381 Print all relevant configuration data. This is equivalent to B<--command-line>
382 B<--options> B<--target> B<--environment> B<--make-variables>
383 B<--build-parameters>.
385 =item B<--command-line> | B<-c>
387 Print the current configuration command line.
389 =item B<--options> | B<-o>
391 Print the features, both enabled and disabled, and display defined macro and
392 skipped directories where applicable.
394 =item B<--target> | B<-t>
396 Print the config attributes for this config target.
398 =item B<--environment> | B<-e>
400 Print the environment variables and their values at the time of configuration.
402 =item B<--make-variables> | B<-m>
404 Print the main make variables generated in the current configuration
406 =item B<--build-parameters> | B<-b>
408 Print the build parameters, i.e. build file and build file templates.
410 =item B<--reconfigure> | B<--reconf> | B<-r>
412 Re-run the configuration process.
414 =item B<--verbose> | B<-v>