X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=make%2Fconfigure.pm;h=a49ad13186f864995e2c5c36e649530b929df3cc;hb=0a329440bd1d0fa642ce2f3e14bc88125377b5bd;hp=90523383505f24d4fa6caf96bb83e710e84b64fd;hpb=f62654a6859998f9d63eb22702c572d5ebcff15c;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/make/configure.pm b/make/configure.pm index 905233835..a49ad1318 100644 --- a/make/configure.pm +++ b/make/configure.pm @@ -1,10 +1,10 @@ # # InspIRCd -- Internet Relay Chat Daemon # -# Copyright (C) 2012-2014 Peter Powell -# Copyright (C) 2008 Robin Burchell -# Copyright (C) 2007-2008 Craig Edwards -# Copyright (C) 2008 Thomas Stagner +# Copyright (C) 2020 Nicole Kleinhoff +# Copyright (C) 2013-2021 Sadie Powell +# Copyright (C) 2012 Robby +# Copyright (C) 2007-2008 Craig Edwards # Copyright (C) 2007 Dennis Friis # # This file is part of InspIRCd. InspIRCd is free software: you can @@ -21,44 +21,56 @@ # -BEGIN { - require 5.8.0; -} - package make::configure; +use v5.10.0; use strict; use warnings FATAL => qw(all); -use Cwd 'getcwd'; -use Exporter 'import'; -use File::Basename 'basename'; - -use make::utilities; - -our @EXPORT = qw(cmd_clean cmd_help cmd_update - read_configure_cache write_configure_cache - get_compiler_info find_compiler - run_test test_file test_header - dump_hash get_property parse_templates); - -sub __get_socketengines() { +use Exporter qw(import); +use File::Basename qw(basename dirname); +use File::Spec::Functions qw(abs2rel catdir catfile); + +use make::common; +use make::console; + +use constant CONFIGURE_ROOT => dirname dirname __FILE__; +use constant CONFIGURE_DIRECTORY => catdir(CONFIGURE_ROOT, '.configure'); +use constant CONFIGURE_CACHE_FILE => catfile(CONFIGURE_DIRECTORY, 'cache.cfg'); +use constant CONFIGURE_CACHE_VERSION => '1'; +use constant CONFIGURE_ERROR_PIPE => $ENV{INSPIRCD_VERBOSE} ? '' : '1>/dev/null 2>/dev/null'; + +our @EXPORT = qw(CONFIGURE_CACHE_FILE + CONFIGURE_CACHE_VERSION + CONFIGURE_DIRECTORY + cmd_clean + cmd_help + cmd_update + run_test + test_file + test_header + module_expand + module_shrink + write_configure_cache + get_compiler_info + find_compiler + parse_templates); + +sub __get_socketengines { my @socketengines; - foreach () { + for (<${\CONFIGURE_ROOT}/src/socketengines/socketengine_*.cpp>) { s/src\/socketengines\/socketengine_(\w+)\.cpp/$1/; push @socketengines, $1; } return @socketengines; } -# TODO: when buildtool is done this can be mostly removed with -# the remainder being merged into parse_templates. -sub __get_template_settings($$) { +sub __get_template_settings($$$) { # These are actually hash references - my ($config, $compiler) = @_; + my ($config, $compiler, $version) = @_; - # Start off by populating with the config + # Start off by populating with the config my %settings = %$config; # Compiler information @@ -67,368 +79,278 @@ sub __get_template_settings($$) { } # Version information - my %version = get_version(); - while (my ($key, $value) = each %version) { + while (my ($key, $value) = each %{$version}) { $settings{'VERSION_' . $key} = $value; } # Miscellaneous information + $settings{CONFIGURE_DIRECTORY} = CONFIGURE_DIRECTORY; + $settings{CONFIGURE_CACHE_FILE} = CONFIGURE_CACHE_FILE; $settings{SYSTEM_NAME} = lc $^O; - chomp($settings{SYSTEM_NAME_VERSION} = `uname -sr 2>/dev/null`); return %settings; } +sub __test_compiler($) { + my $compiler = shift; + return 0 unless run_test("`$compiler`", !system "$compiler -v ${\CONFIGURE_ERROR_PIPE}"); + return 0 unless run_test("`$compiler`", test_file($compiler, 'compiler.cpp', '-fno-rtti'), 'compatible'); + return 1; +} + sub cmd_clean { - unlink '.config.cache'; + unlink CONFIGURE_CACHE_FILE; } sub cmd_help { - my $PWD = getcwd(); my $SELIST = join ', ', __get_socketengines(); - print < <|BOLD $0 [OPTIONS|>] When no options are specified, configure runs in interactive mode and you must specify any required values manually. If one or more options are specified, non-interactive configuration is started and any omitted values are defaulted. -PATH OPTIONS +<|GREEN PATH OPTIONS|> - --system Automatically set up the installation paths - for system-wide installation. - --prefix=[dir] The root install directory. If this is set then + <|BOLD --portable|> Automatically set up the installation paths for + portable installation. + <|BOLD --system|> Automatically set up the installation paths for + system-wide installation. + <|BOLD --prefix |> The root install directory. If this is set then all subdirectories will be adjusted accordingly. - [$PWD/run] - --binary-dir=[dir] The location where the main server binary is + [${\CONFIGURE_ROOT}/run] + <|BOLD --binary-dir |> The location where the main server binary is stored. - [$PWD/run/bin] - --config-dir=[dir] The location where the configuration files and + [${\CONFIGURE_ROOT}/run/bin] + <|BOLD --config-dir |> The location where the configuration files and SSL certificates are stored. - [$PWD/run/conf] - --data-dir=[dir] The location where the data files, such as the - pid file, are stored. - [$PWD/run/data] - --log-dir=[dir] The location where the log files are stored. - [$PWD/run/logs] - --module-dir=[dir] The location where the loadable modules are + [${\CONFIGURE_ROOT}/run/conf] + <|BOLD --data-dir |> The location where the data files, such as the + xline database, are stored. + [${\CONFIGURE_ROOT}/run/data] + <|BOLD --example-dir |> The location where the example configuration + files and SQL schemas are stored. + [${\CONFIGURE_ROOT}/run/conf/examples] + <|BOLD --log-dir |> The location where the log files are stored. + [${\CONFIGURE_ROOT}/run/logs] + <|BOLD --manual-dir |> The location where the manual files are stored. + [${\CONFIGURE_ROOT}/run/manuals] + <|BOLD --module-dir |> The location where the loadable modules are stored. - [$PWD/run/modules] - --build-dir=[dir] The location to store files in while building. - - -EXTRA MODULE OPTIONS - - --enable-extras=[extras] Enables a comma separated list of extra modules. - --disable-extras=[extras] Disables a comma separated list of extra modules. - --list-extras Shows the availability status of all extra + [${\CONFIGURE_ROOT}/run/modules] + <|BOLD --runtime-dir |> The location where the runtime files, such as + the pid file, are stored. + [${\CONFIGURE_ROOT}/run/data] + <|BOLD --script-dir |> The location where the scripts, such as the + init scripts, are stored. + [${\CONFIGURE_ROOT}/run] + +<|GREEN EXTRA MODULE OPTIONS|> + + <|BOLD --enable-extras |> Enables a comma separated list of extra modules. + <|BOLD --disable-extras |> Disables a comma separated list of extra modules. + <|BOLD --list-extras|> Shows the availability status of all extra modules. -MISC OPTIONS +<|GREEN MISC OPTIONS|> - --clean Remove the configuration cache file and start + <|BOLD --clean|> Remove the configuration cache file and start the interactive configuration wizard. - --disable-interactive Disables the interactive configuration wizard. - --help Show this message and exit. - --uid=[name] Sets the user to run InspIRCd as. - --socketengine=[name] Sets the socket engine to be used. Possible + <|BOLD --disable-auto-extras|> Disables automatically enabling extra modules + for which the dependencies are available. + <|BOLD --disable-interactive|> Disables the interactive configuration wizard. + <|BOLD --distribution-label |> Sets a distribution specific version label in + the build configuration. + <|BOLD --gid |> Sets the group to run InspIRCd as. + <|BOLD --help|> Show this message and exit. + <|BOLD --socketengine |> Sets the socket engine to be used. Possible values are $SELIST. - --update Updates the build environment. - + <|BOLD --uid [ID|NAME]|> Sets the user to run InspIRCd as. + <|BOLD --update|> Updates the build environment with the settings + from the cache. -FLAGS +<|GREEN FLAGS|> - CXX=[name] Sets the C++ compiler to use when building the + <|BOLD CXX=|> Sets the C++ compiler to use when building the server. If not specified then the build system will search for c++, g++, clang++ or icpc. + <|BOLD INSPIRCD_VERBOSE=<0|1>|> Shows additional information for debugging. If you have any problems with configuring InspIRCd then visit our IRC channel -at irc.ChatSpike.net #InspIRCd. +at irc.inspircd.org #InspIRCd or create a support discussion at +https://github.com/inspircd/inspircd/discussions. +Packagers: see https://docs.inspircd.org/packaging/ for packaging advice. EOH exit 0; } sub cmd_update { - unless (-f '.config.cache') { - print "You have not run $0 before. Please do this before trying to update the build files.\n"; - exit 1; - } - print "Updating...\n"; - my %config = read_configure_cache(); + print_error "You have not run $0 before. Please do this before trying to update the generated files." unless -f CONFIGURE_CACHE_FILE; + say 'Updating...'; + my %config = read_config_file(CONFIGURE_CACHE_FILE); + $config{EXAMPLE_DIR} //= catdir $config{CONFIG_DIR}, 'examples'; + $config{RUNTIME_DIR} //= $config{DATA_DIR}; my %compiler = get_compiler_info($config{CXX}); - parse_templates(\%config, \%compiler); - print "Update complete!\n"; + my %version = get_version $config{DISTRIBUTION}; + parse_templates(\%config, \%compiler, \%version); + say 'Update complete!'; exit 0; } -sub read_configure_cache { - my %cfg = (); - open(CACHE, '.config.cache') or return %cfg; - while (my $line = ) { - next if $line =~ /^\s*($|\#)/; - my ($key, $value) = ($line =~ /^(\S+)="(.*)"$/); - $cfg{$key} = $value; - } - close(CACHE); - return %cfg; +sub run_test($$;$) { + my ($what, $result, $adjective) = @_; + $adjective //= 'available'; + print console_format "Checking whether <|GREEN $what|> is $adjective ... "; + say console_format($result ? "<|GREEN yes|>" : "<|RED no|>"); + return $result; } -sub write_configure_cache(%) { - my %cfg = @_; - open(CACHE, ">.config.cache") or return 0; - while (my ($key, $value) = each %cfg) { - $value = "" unless defined $value; - print CACHE "$key=\"$value\"\n"; - } - close(CACHE); - return 1; +sub test_file($$;$) { + my ($compiler, $file, $args) = @_; + my $status = 0; + $args //= ''; + $status ||= system "$compiler -o ${\CONFIGURE_ROOT}/__test_$file ${\CONFIGURE_ROOT}/make/test/$file $args ${\CONFIGURE_ERROR_PIPE}"; + $status ||= system "${\CONFIGURE_ROOT}/__test_$file ${\CONFIGURE_ERROR_PIPE}"; + unlink "${\CONFIGURE_ROOT}/__test_$file"; + return !$status; } -sub get_compiler_info($) { - my $binary = shift; - my $version = `$binary -v 2>&1`; - if ($version =~ /(?:clang|llvm)\sversion\s(\d+\.\d+)/i) { - return ( - NAME => 'Clang', - VERSION => $1, - UNSUPPORTED => $1 lt '3.0', - REASON => 'Clang 2.9 and older do not have adequate C++ support.' - ); - } elsif ($version =~ /gcc\sversion\s(\d+\.\d+)/i) { - return ( - NAME => 'GCC', - VERSION => $1, - UNSUPPORTED => $1 lt '4.1', - REASON => 'GCC 4.0 and older do not have adequate C++ support.' - ); - } elsif ($version =~ /(?:icc|icpc)\sversion\s(\d+\.\d+).\d+\s\(gcc\sversion\s(\d+\.\d+).\d+/i) { - return ( - NAME => 'ICC', - VERSION => $1, - UNSUPPORTED => $2 lt '4.1', - REASON => "ICC $1 (GCC $2 compatibility mode) does not have adequate C++ support." - ); - } - return ( - NAME => $binary, - VERSION => '0.0' - ); +sub test_header($$;$) { + my ($compiler, $header, $args) = @_; + $args //= ''; + open(my $fh, "| $compiler -E - $args ${\CONFIGURE_ERROR_PIPE}") or return 0; + print $fh "#include <$header>"; + close $fh; + return !$?; } -sub find_compiler { - foreach my $compiler ('c++', 'g++', 'clang++', 'icpc') { - return $compiler unless system "$compiler -v > /dev/null 2>&1"; - if ($^O eq 'Darwin') { - return $compiler unless system "xcrun $compiler -v > /dev/null 2>&1"; - } - } - return ""; +sub module_expand($) { + my $module = shift; + $module = "m_$module" unless $module =~ /^(?:m|core)_/; + $module = "$module.cpp" unless $module =~ /\.cpp$/; + return $module; } -sub run_test($$) { - my ($what, $result) = @_; - print "Checking whether $what is available... "; - print $result ? "yes\n" : "no\n"; - return $result; +sub module_shrink($) { + my $module = basename shift; + $module =~ s/(?:^m_|\.cpp$)//g; + return $module; } -sub test_file($$;$) { - my ($cc, $file, $args) = @_; - my $status = 0; - $args ||= ''; - $status ||= system "$cc -o __test_$file make/test/$file $args >/dev/null 2>&1"; - $status ||= system "./__test_$file >/dev/null 2>&1"; - unlink "./__test_$file"; - return !$status; -} +sub write_configure_cache(%) { + unless (-e CONFIGURE_DIRECTORY) { + say console_format "Creating <|GREEN ${\abs2rel CONFIGURE_DIRECTORY, CONFIGURE_ROOT}|> ..."; + create_directory CONFIGURE_DIRECTORY, 0750 or print_error "unable to create ${\CONFIGURE_DIRECTORY}: $!"; + } -sub test_header($$;$) { - my ($cc, $header, $args) = @_; - $args ||= ''; - open(CC, "| $cc -E - $args >/dev/null 2>&1") or return 0; - print CC "#include <$header>"; - close(CC); - return !$?; + say console_format "Writing <|GREEN ${\abs2rel CONFIGURE_CACHE_FILE, CONFIGURE_ROOT}|> ..."; + my %config = @_; + write_config_file CONFIGURE_CACHE_FILE, %config; } -sub get_property($$;$) -{ - my ($file, $property, $default) = @_; - open(MODULE, $file) or return $default; - while () { - if ($_ =~ /^\/\* \$(\S+): (.+) \*\/$/) { - next unless $1 eq $property; - close(MODULE); - return translate_functions($2, $file); - } +sub get_compiler_info($) { + my $binary = shift; + my %info = (NAME => 'Unknown', VERSION => '0.0'); + return %info if system "$binary -o __compiler_info ${\CONFIGURE_ROOT}/make/test/compiler_info.cpp ${\CONFIGURE_ERROR_PIPE}"; + open(my $fh, '-|', './__compiler_info 2>/dev/null'); + while (my $line = <$fh>) { + $info{$1} = $2 if $line =~ /^([A-Z]+)\s(.+)$/; } - close(MODULE); - return defined $default ? $default : ''; + close $fh; + unlink './__compiler_info'; + return %info; } -sub dump_hash() { - print "\n\e[1;32mPre-build configuration is complete!\e[0m\n\n"; - print "\e[0mBase install path:\e[1;32m\t\t$main::config{BASE_DIR}\e[0m\n"; - print "\e[0mConfig path:\e[1;32m\t\t\t$main::config{CONFIG_DIR}\e[0m\n"; - print "\e[0mData path:\e[1;32m\t\t\t$main::config{DATA_DIR}\e[0m\n"; - print "\e[0mLog path:\e[1;32m\t\t\t$main::config{LOG_DIR}\e[0m\n"; - print "\e[0mModule path:\e[1;32m\t\t\t$main::config{MODULE_DIR}\e[0m\n"; - print "\e[0mCompiler:\e[1;32m\t\t\t$main::cxx{NAME} $main::cxx{VERSION}\e[0m\n"; - print "\e[0mSocket engine:\e[1;32m\t\t\t$main::config{SOCKETENGINE}\e[0m\n"; - print "\e[0mGnuTLS support:\e[1;32m\t\t\t$main::config{USE_GNUTLS}\e[0m\n"; - print "\e[0mOpenSSL support:\e[1;32m\t\t$main::config{USE_OPENSSL}\e[0m\n"; +sub find_compiler { + my @compilers = qw(c++ g++ clang++ icpc); + for my $compiler (shift // @compilers) { + return $compiler if __test_compiler $compiler; + return "xcrun $compiler" if $^O eq 'darwin' && __test_compiler "xcrun $compiler"; + } } -sub parse_templates($$) { +sub parse_templates($$$) { # These are actually hash references - my ($config, $compiler) = @_; + my ($config, $compiler, $version) = @_; # Collect settings to be used when generating files - my %settings = __get_template_settings($config, $compiler); + my %settings = __get_template_settings($config, $compiler, $version); # Iterate through files in make/template. - foreach () { - print "Parsing $_...\n"; - open(TEMPLATE, $_); - my (@lines, $mode, @platforms, %targets); + for my $template (<${\CONFIGURE_ROOT}/make/template/*>) { + say console_format "Parsing <|GREEN ${\abs2rel $template, CONFIGURE_ROOT}|> ..."; + open(my $fh, $template) or print_error "unable to read $template: $!"; + my (@lines, $mode, @platforms, @targets); # First pass: parse template variables and directives. - while (my $line =