1 #! {- $config{HASHBANGPERL} -}
4 # We must make sourcedir() return an absolute path, because configdata.pm
5 # may be loaded as a module from any script in any directory, making
6 # relative paths untrustable. Because the result is used with 'use lib',
7 # we must ensure that it returns a Unix style path. Mixing File::Spec
8 # and File::Spec::Unix does just that.
15 # Make the path absolute at all times
16 $path = abs_path($path);
19 # Convert any path of the VMS form VOLUME:[DIR1.DIR2]FILE to the
20 # Unix form /VOLUME/DIR1/DIR2/FILE, which is what VMS perl supports
23 # Start with spliting the native path
24 (my $vol, my $dirs, my $file) = File::Spec->splitpath($path);
25 my @dirs = File::Spec->splitdir($dirs);
27 # Reassemble it as a Unix path
29 $dirs = File::Spec::Unix->catdir('', $vol, @dirs);
30 $path = File::Spec::Unix->catpath('', $dirs, $file);
36 return _fixup_path(File::Spec->catdir($config{sourcedir}, @_))
39 return _fixup_path(File::Spec->catfile($config{sourcedir}, @_))
41 use lib sourcedir('util', 'perl');
50 our @ISA = qw(Exporter);
52 %config %target %disabled %withargs %unified_info
53 @disablables @disablables_int
56 our %config = ({- dump_data(\%config, indent => 0); -});
57 our %target = ({- dump_data(\%target, indent => 0); -});
58 our @disablables = ({- dump_data(\@disablables, indent => 0) -});
59 our @disablables_int = ({- dump_data(\@disablables_int, indent => 0) -});
60 our %disabled = ({- dump_data(\%disabled, indent => 0); -});
61 our %withargs = ({- dump_data(\%withargs, indent => 0); -});
62 our %unified_info = ({- dump_data(\%unified_info, indent => 0); -});
64 # Unexported, only used by OpenSSL::Test::Utils::available_protocols()
65 our %available_protocols = (
66 tls => [{- dump_data(\@tls, indent => 0) -}],
67 dtls => [{- dump_data(\@dtls, indent => 0) -}],
70 # The following data is only used when this files is use as a script
71 my @makevars = ({- dump_data(\@makevars, indent => 0); -});
72 my %disabled_info = ({- dump_data(\%disabled_info, indent => 0); -});
73 my @user_crossable = qw( {- join (' ', @user_crossable) -} );
75 # If run directly, we can give some answers, and even reconfigure
78 use File::Spec::Functions;
83 use lib '{- sourcedir('util', 'perl') -}';
84 use OpenSSL::fallback '{- sourcefile('external', 'perl', 'MODULES.txt') -}';
86 my $here = dirname($0);
88 if (scalar @ARGV == 0) {
89 # With no arguments, re-create the build file
90 # We do that in two steps, where the first step emits perl
93 my $buildfile = $target{build_file};
94 my $buildfile_template = "$buildfile.in";
96 'WARNING: do not edit!',
97 "Generated by configdata.pm from "
98 .join(", ", @{$config{build_file_templates}}),
99 "via $buildfile_template"
104 disabled => \%disabled,
105 withargs => \%withargs,
106 unified_info => \%unified_info,
107 autowarntext => \@autowarntext,
111 use lib '{- sourcedir('Configurations') -}';
114 print 'Creating ',$buildfile_template,"\n";
115 open my $buildfile_template_fh, ">$buildfile_template"
116 or die "Trying to create $buildfile_template: $!";
117 foreach (@{$config{build_file_templates}}) {
118 copy($_, $buildfile_template_fh)
119 or die "Trying to copy $_ into $buildfile_template: $!";
121 gentemplate(output => $buildfile_template_fh, %gendata);
122 close $buildfile_template_fh;
124 use OpenSSL::Template;
126 my $prepend = <<'_____';
127 use File::Spec::Functions;
128 use lib '{- sourcedir('util', 'perl') -}';
129 use lib '{- sourcedir('Configurations') -}';
130 use lib '{- $config{builddir} -}';
134 print 'Creating ',$buildfile,"\n";
135 open BUILDFILE, ">$buildfile.new"
136 or die "Trying to create $buildfile.new: $!";
137 my $tmpl = OpenSSL::Template->new(TYPE => 'FILE',
138 SOURCE => $buildfile_template);
139 $tmpl->fill_in(FILENAME => $_,
140 OUTPUT => \*BUILDFILE,
143 # To ensure that global variables and functions
144 # defined in one template stick around for the
145 # next, making them combinable
146 PACKAGE => 'OpenSSL::safe')
147 or die $Text::Template::ERROR;
149 rename("$buildfile.new", $buildfile)
150 or die "Trying to rename $buildfile.new to $buildfile: $!";
160 my $makevars = undef;
161 my $buildparams = undef;
167 GetOptions('dump|d' => \$dump,
168 'command-line|c' => \$cmdline,
169 'options|o' => \$options,
170 'target|t' => \$target,
171 'environment|e' => \$envvars,
172 'make-variables|m' => \$makevars,
173 'build-parameters|b' => \$buildparams,
174 'reconfigure|reconf|r' => \$reconf,
175 'verbose|v' => \$verbose,
176 'query|q=s' => \$query,
179 or die "Errors in command line arguments\n";
181 if (scalar @ARGV > 0) {
182 print STDERR <<"_____";
183 Unrecognised arguments.
184 For more information, do '$0 --help'
190 pod2usage(-exitval => 0,
194 pod2usage(-exitval => 0,
197 if ($dump || $cmdline) {
198 print "\nCommand line (with current working directory = $here):\n\n";
201 catfile($config{sourcedir}, 'Configure'),
202 @{$config{perlargv}}), "\n";
203 print "\nPerl information:\n\n";
204 print ' ',$config{perl_cmd},"\n";
205 print ' ',$config{perl_version},' for ',$config{perl_archname},"\n";
207 if ($dump || $options) {
210 foreach my $what (@disablables) {
211 $longest = length($what) if $longest < length($what);
212 $longest2 = length($disabled{$what})
213 if $disabled{$what} && $longest2 < length($disabled{$what});
215 print "\nEnabled features:\n\n";
216 foreach my $what (@disablables) {
217 print " $what\n" unless $disabled{$what};
219 print "\nDisabled features:\n\n";
220 foreach my $what (@disablables) {
221 if ($disabled{$what}) {
222 print " $what", ' ' x ($longest - length($what) + 1),
223 "[$disabled{$what}]", ' ' x ($longest2 - length($disabled{$what}) + 1);
224 print $disabled_info{$what}->{macro}
225 if $disabled_info{$what}->{macro};
227 join(', ', @{$disabled_info{$what}->{skipped}}),
229 if $disabled_info{$what}->{skipped};
234 if ($dump || $target) {
235 print "\nConfig target attributes:\n\n";
236 foreach (sort keys %target) {
237 next if $_ =~ m|^_| || $_ eq 'template';
241 (my $x = $_) =~ s|([\\\$\@"])|\\$1|g; "\"$x\""
247 print ' ', $_, ' => ';
248 if (ref($target{$_}) eq "ARRAY") {
249 print '[ ', join(', ', $quotify->(@{$target{$_}})), " ],\n";
251 print $quotify->($target{$_}), ",\n"
255 if ($dump || $envvars) {
256 print "\nRecorded environment:\n\n";
257 foreach (sort keys %{$config{perlenv}}) {
258 print ' ',$_,' = ',($config{perlenv}->{$_} || ''),"\n";
261 if ($dump || $makevars) {
262 print "\nMakevars:\n\n";
263 foreach my $var (@makevars) {
265 $prefix = $config{CROSS_COMPILE}
266 if grep { $var eq $_ } @user_crossable;
268 print ' ',$var,' ' x (16 - length $var),'= ',
269 (ref $config{$var} eq 'ARRAY'
270 ? join(' ', @{$config{$var}})
271 : $prefix.$config{$var}),
273 if defined $config{$var};
276 my @buildfile = ($config{builddir}, $config{build_file});
277 unshift @buildfile, $here
278 unless file_name_is_absolute($config{builddir});
279 my $buildfile = canonpath(catdir(@buildfile));
282 NOTE: These variables only represent the configuration view. The build file
283 template may have processed these variables further, please have a look at the
284 build file for more exact data:
288 if ($dump || $buildparams) {
289 my @buildfile = ($config{builddir}, $config{build_file});
290 unshift @buildfile, $here
291 unless file_name_is_absolute($config{builddir});
292 print "\nbuild file:\n\n";
293 print " ", canonpath(catfile(@buildfile)),"\n";
295 print "\nbuild file templates:\n\n";
296 foreach (@{$config{build_file_templates}}) {
299 unless file_name_is_absolute($config{sourcedir});
300 print ' ',canonpath(catfile(@tmpl)),"\n";
305 print 'Reconfiguring with: ', join(' ',@{$config{perlargv}}), "\n";
306 foreach (sort keys %{$config{perlenv}}) {
307 print ' ',$_,' = ',($config{perlenv}->{$_} || ""),"\n";
312 exec $^X,catfile($config{sourcedir}, 'Configure'),'reconf';
315 use OpenSSL::Config::Query;
317 my $confquery = OpenSSL::Config::Query->new(info => \%unified_info,
319 my $result = eval "\$confquery->$query";
321 # We may need a result class with a printing function at some point.
322 # Until then, we assume that we get a scalar, or a list or a hash table
323 # with scalar values and simply print them in some orderly fashion.
324 if (ref $result eq 'ARRAY') {
325 print "$_\n" foreach @$result;
326 } elsif (ref $result eq 'HASH') {
327 print "$_ : \\\n ", join(" \\\n ", @{$result->{$_}}), "\n"
328 foreach sort keys %$result;
329 } elsif (ref $result eq 'SCALAR') {
341 configdata.pm - configuration data for OpenSSL builds
347 perl configdata.pm [options]
355 This module can be used in two modes, interactively and as a module containing
356 all the data recorded by OpenSSL's Configure script.
358 When used interactively, simply run it as any perl script.
359 If run with no arguments, it will rebuild the build file (Makefile or
361 With at least one option, it will instead get the information you ask for, or
362 re-run the configuration process.
363 See L</OPTIONS> below for more information.
365 When loaded as a module, you get a few databanks with useful information to
366 perform build related tasks. The databanks are:
368 %config Configured things.
369 %target The OpenSSL config target with all inheritances
371 %disabled The features that are disabled.
372 @disablables The list of features that can be disabled.
373 %withargs All data given through --with-THING options.
374 %unified_info All information that was computed from the build.info
383 Print a brief help message and exit.
387 Print the manual page and exit.
389 =item B<--dump> | B<-d>
391 Print all relevant configuration data. This is equivalent to B<--command-line>
392 B<--options> B<--target> B<--environment> B<--make-variables>
393 B<--build-parameters>.
395 =item B<--command-line> | B<-c>
397 Print the current configuration command line.
399 =item B<--options> | B<-o>
401 Print the features, both enabled and disabled, and display defined macro and
402 skipped directories where applicable.
404 =item B<--target> | B<-t>
406 Print the config attributes for this config target.
408 =item B<--environment> | B<-e>
410 Print the environment variables and their values at the time of configuration.
412 =item B<--make-variables> | B<-m>
414 Print the main make variables generated in the current configuration
416 =item B<--build-parameters> | B<-b>
418 Print the build parameters, i.e. build file and build file templates.
420 =item B<--reconfigure> | B<--reconf> | B<-r>
422 Re-run the configuration process.
424 =item B<--verbose> | B<-v>