2 # InspIRCd -- Internet Relay Chat Daemon
4 # Copyright (C) 2012-2017 Peter Powell <petpow@saberuk.com>
5 # Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
6 # Copyright (C) 2007-2008 Craig Edwards <craigedwards@brainbox.cc>
7 # Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
8 # Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
10 # This file is part of InspIRCd. InspIRCd is free software: you can
11 # redistribute it and/or modify it under the terms of the GNU General Public
12 # License as published by the Free Software Foundation, version 2.
14 # This program is distributed in the hope that it will be useful, but WITHOUT
15 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
19 # You should have received a copy of the GNU General Public License
20 # along with this program. If not, see <http://www.gnu.org/licenses/>.
28 package make::configure;
32 use warnings FATAL => qw(all);
35 use Exporter qw(import);
36 use File::Basename qw(basename dirname);
37 use File::Spec::Functions qw(catfile);
42 use constant CONFIGURE_DIRECTORY => '.configure';
43 use constant CONFIGURE_CACHE_FILE => catfile(CONFIGURE_DIRECTORY, 'cache.cfg');
44 use constant CONFIGURE_CACHE_VERSION => '1';
45 use constant CONFIGURE_ERROR_PIPE => $ENV{INSPIRCD_VERBOSE} ? '' : '1>/dev/null 2>/dev/null';
47 our @EXPORT = qw(CONFIGURE_CACHE_FILE
48 CONFIGURE_CACHE_VERSION
60 sub __get_socketengines {
62 foreach (<src/socketengines/socketengine_*.cpp>) {
63 s/src\/socketengines\/socketengine_(\w+)\.cpp/$1/;
64 push @socketengines, $1;
66 return @socketengines;
69 # TODO: when buildtool is done this can be mostly removed with
70 # the remainder being merged into parse_templates.
71 sub __get_template_settings($$$) {
73 # These are actually hash references
74 my ($config, $compiler, $version) = @_;
76 # Start off by populating with the config
77 my %settings = %$config;
79 # Compiler information
80 while (my ($key, $value) = each %{$compiler}) {
81 $settings{'COMPILER_' . $key} = $value;
85 while (my ($key, $value) = each %{$version}) {
86 $settings{'VERSION_' . $key} = $value;
89 # Miscellaneous information
90 $settings{CONFIGURE_DIRECTORY} = CONFIGURE_DIRECTORY;
91 $settings{CONFIGURE_CACHE_FILE} = CONFIGURE_CACHE_FILE;
92 $settings{SYSTEM_NAME} = lc $^O;
93 chomp($settings{SYSTEM_NAME_VERSION} = `uname -sr 2>/dev/null`);
98 sub __test_compiler($) {
100 return 0 unless run_test("`$compiler`", !system "$compiler -v ${\CONFIGURE_ERROR_PIPE}");
101 return 0 unless run_test("`$compiler`", test_file($compiler, 'compiler.cpp', '-fno-rtti'), 'compatible');
106 unlink CONFIGURE_CACHE_FILE;
111 my $SELIST = join ', ', __get_socketengines();
115 When no options are specified, configure runs in interactive mode and you must
116 specify any required values manually. If one or more options are specified,
117 non-interactive configuration is started and any omitted values are defaulted.
121 --system Automatically set up the installation paths
122 for system-wide installation.
123 --prefix=[dir] The root install directory. If this is set then
124 all subdirectories will be adjusted accordingly.
126 --binary-dir=[dir] The location where the main server binary is
129 --config-dir=[dir] The location where the configuration files and
130 SSL certificates are stored.
132 --data-dir=[dir] The location where the data files, such as the
133 pid file, are stored.
135 --log-dir=[dir] The location where the log files are stored.
137 --manual-dir=[dir] The location where the manual files are stored.
139 --module-dir=[dir] The location where the loadable modules are
145 --enable-extras=[extras] Enables a comma separated list of extra modules.
146 --disable-extras=[extras] Disables a comma separated list of extra modules.
147 --list-extras Shows the availability status of all extra
152 --clean Remove the configuration cache file and start
153 the interactive configuration wizard.
154 --disable-interactive Disables the interactive configuration wizard.
155 --distribution-label=[text] Sets a distribution specific version label in
156 the build configuration.
157 --gid=[id|name] Sets the group to run InspIRCd as.
158 --help Show this message and exit.
159 --socketengine=[name] Sets the socket engine to be used. Possible
161 --uid=[id|name] Sets the user to run InspIRCd as.
162 --update Updates the build environment with the settings
168 CXX=[name] Sets the C++ compiler to use when building the
169 server. If not specified then the build system
170 will search for c++, g++, clang++ or icpc.
172 If you have any problems with configuring InspIRCd then visit our IRC channel
173 at irc.inspircd.org #InspIRCd for support.
180 print_error "You have not run $0 before. Please do this before trying to update the generated files." unless -f CONFIGURE_CACHE_FILE;
182 my %config = read_config_file(CONFIGURE_CACHE_FILE);
183 my %compiler = get_compiler_info($config{CXX});
184 my %version = get_version $config{DISTRIBUTION};
185 parse_templates(\%config, \%compiler, \%version);
186 say 'Update complete!';
191 my ($what, $result, $adjective) = @_;
192 $adjective //= 'available';
193 print_format "Checking whether <|GREEN $what|> is $adjective ... ";
194 print_format $result ? "<|GREEN yes|>\n" : "<|RED no|>\n";
198 sub test_file($$;$) {
199 my ($compiler, $file, $args) = @_;
202 $status ||= system "$compiler -o __test_$file make/test/$file $args ${\CONFIGURE_ERROR_PIPE}";
203 $status ||= system "./__test_$file ${\CONFIGURE_ERROR_PIPE}";
204 unlink "./__test_$file";
208 sub test_header($$;$) {
209 my ($compiler, $header, $args) = @_;
211 open(COMPILER, "| $compiler -E - $args ${\CONFIGURE_ERROR_PIPE}") or return 0;
212 print COMPILER "#include <$header>";
217 sub write_configure_cache(%) {
218 unless (-e CONFIGURE_DIRECTORY) {
219 print_format "Creating <|GREEN ${\CONFIGURE_DIRECTORY}|> ...\n";
220 create_directory CONFIGURE_DIRECTORY, 0750 or print_error "unable to create ${\CONFIGURE_DIRECTORY}: $!";
223 print_format "Writing <|GREEN ${\CONFIGURE_CACHE_FILE}|> ...\n";
225 open(CACHE, '>', CONFIGURE_CACHE_FILE) or print_error "unable to write ${\CONFIGURE_CACHE_FILE}: $!";
226 while (my ($key, $value) = each %config) {
228 say CACHE "$key $value";
233 sub get_compiler_info($) {
235 my $version = `$binary -v 2>&1`;
236 if ($version =~ /Apple\sLLVM\sversion\s(\d+\.\d+)/i) {
237 # Apple version their LLVM releases slightly differently to the mainline LLVM.
238 # See https://trac.macports.org/wiki/XcodeVersionInfo for more information.
239 return (NAME => 'AppleClang', VERSION => $1);
240 } elsif ($version =~ /clang\sversion\s(\d+\.\d+)/i) {
241 return (NAME => 'Clang', VERSION => $1);
242 } elsif ($version =~ /gcc\sversion\s(\d+\.\d+)/i) {
243 return (NAME => 'GCC', VERSION => $1);
244 } elsif ($version =~ /(?:icc|icpc)\sversion\s(\d+\.\d+).\d+\s\(gcc\sversion\s(\d+\.\d+).\d+/i) {
245 return (NAME => 'ICC', VERSION => $1);
247 return (NAME => $binary, VERSION => '0.0');
251 my @compilers = qw(c++ g++ clang++ icpc);
252 foreach my $compiler (shift // @compilers) {
253 return $compiler if __test_compiler $compiler;
254 return "xcrun $compiler" if $^O eq 'darwin' && __test_compiler "xcrun $compiler";
258 sub parse_templates($$$) {
260 # These are actually hash references
261 my ($config, $compiler, $version) = @_;
263 # Collect settings to be used when generating files
264 my %settings = __get_template_settings($config, $compiler, $version);
266 # Iterate through files in make/template.
267 foreach (<make/template/*>) {
268 print_format "Parsing <|GREEN $_|> ...\n";
269 open(TEMPLATE, $_) or print_error "unable to read $_: $!";
270 my (@lines, $mode, @platforms, %targets);
272 # First pass: parse template variables and directives.
273 while (my $line = <TEMPLATE>) {
276 # Does this line match a variable?
277 while ($line =~ /(@(\w+?)@)/) {
278 my ($variable, $name) = ($1, $2);
279 if (defined $settings{$name}) {
280 $line =~ s/\Q$variable\E/$settings{$name}/;
282 print_warning "unknown template variable '$name' in $_!";
287 # Does this line match a directive?
288 if ($line =~ /^\s*%(\w+)\s+(.+)$/) {
289 if ($1 eq 'define') {
291 push @lines, "#define $2";
293 push @lines, "#undef $2";
295 } elsif ($1 eq 'mode') {
297 } elsif ($1 eq 'platform') {
299 } elsif ($1 eq 'target') {
300 if ($2 =~ /(\w+)\s(.+)/) {
303 $targets{DEFAULT} = $2;
306 print_warning "unknown template command '$1' in $_!";
315 # Only proceed if this file should be templated on this platform.
316 if ($#platforms < 0 || grep { $_ eq $^O } @platforms) {
318 # Add a default target if the template has not defined one.
319 unless (scalar keys %targets) {
320 $targets{DEFAULT} = catfile(CONFIGURE_DIRECTORY, basename $_);
323 # Second pass: parse makefile junk and write files.
324 while (my ($name, $target) = each %targets) {
326 # TODO: when buildtool is done this mess can be removed completely.
328 foreach my $line (@lines) {
330 # Are we parsing a makefile and does this line match a statement?
331 if ($name =~ /(?:BSD|GNU)_MAKE/ && $line =~ /^\s*\@(\w+)(?:\s+(.+))?$/) {
332 my @tokens = split /\s/, $2 if defined $2;
333 if ($1 eq 'DO_EXPORT' && defined $2) {
334 if ($name eq 'BSD_MAKE') {
335 foreach my $variable (@tokens) {
336 push @final_lines, "MAKEENV += $variable='\${$variable}'";
338 } elsif ($name eq 'GNU_MAKE') {
339 push @final_lines, "export $2";
341 } elsif ($1 eq 'ELSE') {
342 if ($name eq 'BSD_MAKE') {
343 push @final_lines, ".else";
344 } elsif ($name eq 'GNU_MAKE') {
345 push @final_lines, "else";
347 } elsif ($1 eq 'ENDIF') {
348 if ($name eq 'BSD_MAKE') {
349 push @final_lines, ".endif";
350 } elsif ($name eq 'GNU_MAKE') {
351 push @final_lines, "endif";
353 } elsif ($1 eq 'ELSIFEQ' && defined $2) {
354 if ($name eq 'BSD_MAKE') {
355 push @final_lines, ".elif $tokens[0] == $tokens[1]";
356 } elsif ($name eq 'GNU_MAKE') {
357 push @final_lines, "else ifeq ($tokens[0], $tokens[1])";
359 } elsif ($1 eq 'IFDEF' && defined $2) {
360 if ($name eq 'BSD_MAKE') {
361 push @final_lines, ".if defined($2)";
362 } elsif ($name eq 'GNU_MAKE') {
363 push @final_lines, "ifdef $2";
365 } elsif ($1 eq 'IFEQ' && defined $2) {
366 if ($name eq 'BSD_MAKE') {
367 push @final_lines, ".if $tokens[0] == $tokens[1]";
368 } elsif ($name eq 'GNU_MAKE') {
369 push @final_lines, "ifeq ($tokens[0],$tokens[1])";
371 } elsif ($1 eq 'IFNEQ' && defined $2) {
372 if ($name eq 'BSD_MAKE') {
373 push @final_lines, ".if $tokens[0] != $tokens[1]";
374 } elsif ($name eq 'GNU_MAKE') {
375 push @final_lines, "ifneq ($tokens[0],$tokens[1])";
377 } elsif ($1 eq 'IFNDEF' && defined $2) {
378 if ($name eq 'BSD_MAKE') {
379 push @final_lines, ".if !defined($2)";
380 } elsif ($name eq 'GNU_MAKE') {
381 push @final_lines, "ifndef $2";
383 } elsif ($1 eq 'TARGET' && defined $2) {
384 if ($tokens[0] eq $name) {
385 push @final_lines, substr($2, length($tokens[0]) + 1);
387 } elsif ($1 !~ /[A-Z]/) {
388 # HACK: silently ignore if lower case as these are probably make commands.
389 push @final_lines, $line;
391 print_warning "unknown template command '$1' in $_!";
392 push @final_lines, $line;
397 push @final_lines, $line;
400 # Create the directory if it doesn't already exist.
401 my $directory = dirname $target;
402 unless (-e $directory) {
403 print_format "Creating <|GREEN $directory|> ...\n";
404 create_directory $directory, 0750 or print_error "unable to create $directory: $!";
407 # Write the template file.
408 print_format "Writing <|GREEN $target|> ...\n";
409 open(TARGET, '>', $target) or print_error "unable to write $target: $!";
410 foreach (@final_lines) {
415 # Set file permissions.
417 chmod $mode, $target;