#

# Copyright (c) 2011, 2013, Oracle and/or its affiliates. All rights reserved.

# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

#

# This code is free software; you can redistribute it and/or modify it

# under the terms of the GNU General Public License version 2 only, as

# published by the Free Software Foundation.  Oracle designates this

# particular file as subject to the "Classpath" exception as provided

# by Oracle in the LICENSE file that accompanied this code.

#

# This code is distributed in the hope that it will be useful, but WITHOUT

# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

# version 2 for more details (a copy is included in the LICENSE file that

# accompanied this code).

#

# You should have received a copy of the GNU General Public License version

# 2 along with this work; if not, write to the Free Software Foundation,

# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

#

# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

# or visit www.oracle.com if you need additional information or have any

# questions.

#

# Test if $1 is a valid argument to $3 (often is $JAVA passed as $3)

# If so, then append $1 to $2 \

# Also set JVM_ARG_OK to true/false depending on outcome.

AC_DEFUN([ADD_JVM_ARG_IF_OK],

[

  $ECHO "Check if jvm arg is ok: $1" >&AS_MESSAGE_LOG_FD

  $ECHO "Command: $3 $1 -version" >&AS_MESSAGE_LOG_FD

  OUTPUT=`$3 $1 -version 2>&1`

  FOUND_WARN=`$ECHO "$OUTPUT" | grep -i warn`

  FOUND_VERSION=`$ECHO $OUTPUT | grep " version \""`

  if test "x$FOUND_VERSION" != x && test "x$FOUND_WARN" = x; then

    $2="[$]$2 $1"

    JVM_ARG_OK=true

  else

    $ECHO "Arg failed:" >&AS_MESSAGE_LOG_FD

    $ECHO "$OUTPUT" >&AS_MESSAGE_LOG_FD

    JVM_ARG_OK=false

  fi

])

# Appends a string to a path variable, only adding the : when needed.

AC_DEFUN([BASIC_APPEND_TO_PATH],

[

  if test "x[$]$1" = x; then

    $1="$2"

  else

    $1="[$]$1:$2"

  fi

])

# This will make sure the given variable points to a full and proper

# path. This means:

# 1) There will be no spaces in the path. On posix platforms,

#    spaces in the path will result in an error. On Windows,

#    the path will be rewritten using short-style to be space-free.

# 2) The path will be absolute, and it will be in unix-style (on

#     cygwin).

# $1: The name of the variable to fix

AC_DEFUN([BASIC_FIXUP_PATH],

[

  if test "x$OPENJDK_BUILD_OS_ENV" = "xwindows.cygwin"; then

    BASIC_FIXUP_PATH_CYGWIN($1)

  elif test "x$OPENJDK_BUILD_OS_ENV" = "xwindows.msys"; then

    BASIC_FIXUP_PATH_MSYS($1)

  else

    # We're on a posix platform. Hooray! :)

    path="[$]$1"

    has_space=`$ECHO "$path" | $GREP " "`

    if test "x$has_space" != x; then

      AC_MSG_NOTICE([The path of $1, which resolves as "$path", is invalid.])

      AC_MSG_ERROR([Spaces are not allowed in this path.])

    fi

    # Use eval to expand a potential ~

    eval path="$path"

    if test ! -f "$path" && test ! -d "$path"; then

      AC_MSG_ERROR([The path of $1, which resolves as "$path", is not found.])

    fi

    $1="`cd "$path"; $THEPWDCMD -L`"

  fi

])

# This will make sure the given variable points to a executable

# with a full and proper path. This means:

# 1) There will be no spaces in the path. On posix platforms,

#    spaces in the path will result in an error. On Windows,

#    the path will be rewritten using short-style to be space-free.

# 2) The path will be absolute, and it will be in unix-style (on

#     cygwin).

# Any arguments given to the executable is preserved.

# If the input variable does not have a directory specification, then

# it need to be in the PATH.

# $1: The name of the variable to fix

AC_DEFUN([BASIC_FIXUP_EXECUTABLE],

[

  if test "x$OPENJDK_BUILD_OS_ENV" = "xwindows.cygwin"; then

    BASIC_FIXUP_EXECUTABLE_CYGWIN($1)

  elif test "x$OPENJDK_BUILD_OS_ENV" = "xwindows.msys"; then

    BASIC_FIXUP_EXECUTABLE_MSYS($1)

  else

    # We're on a posix platform. Hooray! :)

    # First separate the path from the arguments. This will split at the first

    # space.

    complete="[$]$1"

    path="${complete%% *}"

    tmp="$complete EOL"

    arguments="${tmp#* }"

    # Cannot rely on the command "which" here since it doesn't always work.

    is_absolute_path=`$ECHO "$path" | $GREP ^/`

    if test -z "$is_absolute_path"; then

      # Path to executable is not absolute. Find it.

      IFS_save="$IFS"

      IFS=:

      for p in $PATH; do

        if test -f "$p/$path" && test -x "$p/$path"; then

          new_path="$p/$path"

          break

        fi

      done

      IFS="$IFS_save"

    else

      AC_MSG_NOTICE([Resolving $1 (as $path) failed, using $path directly.])

      new_path="$path"

    fi

    if test "x$new_path" = x; then

      AC_MSG_NOTICE([The path of $1, which resolves as "$complete", is not found.])

      has_space=`$ECHO "$complete" | $GREP " "`

      if test "x$has_space" != x; then

        AC_MSG_NOTICE([This might be caused by spaces in the path, which is not allowed.])

      fi

      AC_MSG_ERROR([Cannot locate the the path of $1])

    fi

  fi

  # Now join together the path and the arguments once again

  if test "x$arguments" != xEOL; then

    new_complete="$new_path ${arguments% *}"

  else

    new_complete="$new_path"

  fi

  if test "x$complete" != "x$new_complete"; then

    $1="$new_complete"

    AC_MSG_NOTICE([Rewriting $1 to "$new_complete"])

  fi

])

AC_DEFUN([BASIC_REMOVE_SYMBOLIC_LINKS],

[

  if test "x$OPENJDK_BUILD_OS" != xwindows; then

    # Follow a chain of symbolic links. Use readlink

    # where it exists, else fall back to horribly

    # complicated shell code.

    if test "x$READLINK_TESTED" != yes; then

      # On MacOSX there is a readlink tool with a different

      # purpose than the GNU readlink tool. Check the found readlink.

      ISGNU=`$READLINK --version 2>&1 | $GREP GNU`

      if test "x$ISGNU" = x; then

        # A readlink that we do not know how to use.

        # Are there other non-GNU readlinks out there?

        READLINK_TESTED=yes

        READLINK=

      fi

    fi

    if test "x$READLINK" != x; then

      $1=`$READLINK -f [$]$1`

    else

      # Save the current directory for restoring afterwards

      STARTDIR=$PWD

      COUNTER=0

      sym_link_dir=`$DIRNAME [$]$1`

      sym_link_file=`$BASENAME [$]$1`

      cd $sym_link_dir

      # Use -P flag to resolve symlinks in directories.

      cd `$THEPWDCMD -P`

      sym_link_dir=`$THEPWDCMD -P`

      # Resolve file symlinks

      while test $COUNTER -lt 20; do

        ISLINK=`$LS -l $sym_link_dir/$sym_link_file | $GREP '\->' | $SED -e 's/.*-> \(.*\)/\1/'`

        if test "x$ISLINK" == x; then

          # This is not a symbolic link! We are done!

          break

        fi

        # Again resolve directory symlinks since the target of the just found

        # link could be in a different directory

        cd `$DIRNAME $ISLINK`

        sym_link_dir=`$THEPWDCMD -P`

        sym_link_file=`$BASENAME $ISLINK`

        let COUNTER=COUNTER+1

      done

      cd $STARTDIR

      $1=$sym_link_dir/$sym_link_file

    fi

  fi

])

# Register a --with argument but mark it as deprecated

# $1: The name of the with argument to deprecate, not including --with-

AC_DEFUN([BASIC_DEPRECATED_ARG_WITH],

[

  AC_ARG_WITH($1, [AS_HELP_STRING([--with-$1],

      [Deprecated. Option is kept for backwards compatibility and is ignored])],

      [AC_MSG_WARN([Option --with-$1 is deprecated and will be ignored.])])

])

AC_DEFUN_ONCE([BASIC_INIT],

[

  # Save the original command line. This is passed to us by the wrapper configure script.

  AC_SUBST(CONFIGURE_COMMAND_LINE)

  DATE_WHEN_CONFIGURED=`LANG=C date`

  AC_SUBST(DATE_WHEN_CONFIGURED)

  AC_MSG_NOTICE([Configuration created at $DATE_WHEN_CONFIGURED.])

  AC_MSG_NOTICE([configure script generated at timestamp $DATE_WHEN_GENERATED.])

])

# Test that variable $1 denoting a program is not empty. If empty, exit with an error.

# $1: variable to check

# $2: executable name to print in warning (optional)

AC_DEFUN([BASIC_CHECK_NONEMPTY],

[

  if test "x[$]$1" = x; then

    if test "x$2" = x; then

      PROG_NAME=translit($1,A-Z,a-z)

    else

      PROG_NAME=$2

    fi

    AC_MSG_NOTICE([Could not find $PROG_NAME!])

    AC_MSG_ERROR([Cannot continue])

  fi

])

# Does AC_PATH_PROG followed by BASIC_CHECK_NONEMPTY.

# Arguments as AC_PATH_PROG:

# $1: variable to set

# $2: executable name to look for

AC_DEFUN([BASIC_REQUIRE_PROG],

[

  AC_PATH_PROGS($1, $2)

  BASIC_CHECK_NONEMPTY($1, $2)

])

# Setup the most fundamental tools that relies on not much else to set up,

# but is used by much of the early bootstrap code.

AC_DEFUN_ONCE([BASIC_SETUP_FUNDAMENTAL_TOOLS],

[

  # Start with tools that do not need have cross compilation support

  # and can be expected to be found in the default PATH. These tools are

  # used by configure. Nor are these tools expected to be found in the

  # devkit from the builddeps server either, since they are

  # needed to download the devkit.

  # First are all the simple required tools.

  BASIC_REQUIRE_PROG(BASENAME, basename)

  BASIC_REQUIRE_PROG(BASH, bash)

  BASIC_REQUIRE_PROG(CAT, cat)

  BASIC_REQUIRE_PROG(CHMOD, chmod)

  BASIC_REQUIRE_PROG(CMP, cmp)

  BASIC_REQUIRE_PROG(COMM, comm)

  BASIC_REQUIRE_PROG(CP, cp)

  BASIC_REQUIRE_PROG(CPIO, cpio)

  BASIC_REQUIRE_PROG(CUT, cut)

  BASIC_REQUIRE_PROG(DATE, date)

  BASIC_REQUIRE_PROG(DIFF, [gdiff diff])

  BASIC_REQUIRE_PROG(DIRNAME, dirname)

  BASIC_REQUIRE_PROG(ECHO, echo)

  BASIC_REQUIRE_PROG(EXPR, expr)

  BASIC_REQUIRE_PROG(FILE, file)

  BASIC_REQUIRE_PROG(FIND, find)

  BASIC_REQUIRE_PROG(HEAD, head)

  BASIC_REQUIRE_PROG(LN, ln)

  BASIC_REQUIRE_PROG(LS, ls)

  BASIC_REQUIRE_PROG(MKDIR, mkdir)

  BASIC_REQUIRE_PROG(MKTEMP, mktemp)

  BASIC_REQUIRE_PROG(MV, mv)

  BASIC_REQUIRE_PROG(PRINTF, printf)

  BASIC_REQUIRE_PROG(RM, rm)

  BASIC_REQUIRE_PROG(SH, sh)

  BASIC_REQUIRE_PROG(SORT, sort)

  BASIC_REQUIRE_PROG(TAIL, tail)

  BASIC_REQUIRE_PROG(TAR, tar)

  BASIC_REQUIRE_PROG(TEE, tee)

  BASIC_REQUIRE_PROG(TOUCH, touch)

  BASIC_REQUIRE_PROG(TR, tr)

  BASIC_REQUIRE_PROG(UNAME, uname)

  BASIC_REQUIRE_PROG(UNIQ, uniq)

  BASIC_REQUIRE_PROG(WC, wc)

  BASIC_REQUIRE_PROG(WHICH, which)

  BASIC_REQUIRE_PROG(XARGS, xargs)

  # Then required tools that require some special treatment.

  AC_PROG_AWK

  BASIC_CHECK_NONEMPTY(AWK)

  AC_PROG_GREP

  BASIC_CHECK_NONEMPTY(GREP)

  AC_PROG_EGREP

  BASIC_CHECK_NONEMPTY(EGREP)

  AC_PROG_FGREP

  BASIC_CHECK_NONEMPTY(FGREP)

  AC_PROG_SED

  BASIC_CHECK_NONEMPTY(SED)

  AC_PATH_PROGS(NAWK, [nawk gawk awk])

  BASIC_CHECK_NONEMPTY(NAWK)

  # Always force rm.

  RM="$RM -f"

  # pwd behaves differently on various platforms and some don't support the -L flag.

  # Always use the bash builtin pwd to get uniform behavior.

  THEPWDCMD=pwd

  # These are not required on all platforms

  AC_PATH_PROG(CYGPATH, cygpath)

  AC_PATH_PROG(READLINK, readlink)

  AC_PATH_PROG(DF, df)

  AC_PATH_PROG(SETFILE, SetFile)

])

# Setup basic configuration paths, and platform-specific stuff related to PATHs.

AC_DEFUN_ONCE([BASIC_SETUP_PATHS],

[

  # Locate the directory of this script.

  SCRIPT="[$]0"

  AUTOCONF_DIR=`cd \`$DIRNAME $SCRIPT\`; $THEPWDCMD -L`

  # Where is the source? It is located two levels above the configure script.

  CURDIR="$PWD"

  cd "$AUTOCONF_DIR/../.."

  SRC_ROOT="`$THEPWDCMD -L`"

  if test "x$OPENJDK_TARGET_OS" = "xwindows"; then

    PATH_SEP=";"

    BASIC_CHECK_PATHS_WINDOWS

  else

    PATH_SEP=":"

  fi

  AC_SUBST(SRC_ROOT)

  AC_SUBST(PATH_SEP)

  cd "$CURDIR"

  BASIC_FIXUP_PATH(SRC_ROOT)

  BASIC_FIXUP_PATH(CURDIR)

  if test "x$OPENJDK_BUILD_OS" = "xsolaris"; then

    # Add extra search paths on solaris for utilities like ar and as etc...

    PATH="$PATH:/usr/ccs/bin:/usr/sfw/bin:/opt/csw/bin"

  fi

  # You can force the sys-root if the sys-root encoded into the cross compiler tools

  # is not correct.

  AC_ARG_WITH(sys-root, [AS_HELP_STRING([--with-sys-root],

      [pass this sys-root to the compilers and tools (for cross-compiling)])])

  if test "x$with_sys_root" != x; then

    SYS_ROOT=$with_sys_root

  else

    SYS_ROOT=/

  fi

  AC_SUBST(SYS_ROOT)

  AC_ARG_WITH([tools-dir], [AS_HELP_STRING([--with-tools-dir],

      [search this directory for compilers and tools (for cross-compiling)])],

      [TOOLS_DIR=$with_tools_dir]

  )

  AC_ARG_WITH([devkit], [AS_HELP_STRING([--with-devkit],

      [use this directory as base for tools-dir and sys-root (for cross-compiling)])],

      [

        if test "x$with_sys_root" != x; then

          AC_MSG_ERROR([Cannot specify both --with-devkit and --with-sys-root at the same time])

        fi

        BASIC_FIXUP_PATH([with_devkit])

        BASIC_APPEND_TO_PATH([TOOLS_DIR],$with_devkit/bin)

        if test -d "$with_devkit/$host_alias/libc"; then

          SYS_ROOT=$with_devkit/$host_alias/libc

        elif test -d "$with_devkit/$host/sys-root"; then

          SYS_ROOT=$with_devkit/$host/sys-root

        fi

      ])

])

AC_DEFUN_ONCE([BASIC_SETUP_OUTPUT_DIR],

[

  AC_ARG_WITH(conf-name, [AS_HELP_STRING([--with-conf-name],

      [use this as the name of the configuration @<:@generated from important configuration options@:>@])],

      [ CONF_NAME=${with_conf_name} ])

  # Test from where we are running configure, in or outside of src root.

  if test "x$CURDIR" = "x$SRC_ROOT" || test "x$CURDIR" = "x$SRC_ROOT/common" \

      || test "x$CURDIR" = "x$SRC_ROOT/common/autoconf" \

      || test "x$CURDIR" = "x$SRC_ROOT/common/makefiles" ; then

    # We are running configure from the src root.

    # Create a default ./build/target-variant-debuglevel output root.

    if test "x${CONF_NAME}" = x; then

      CONF_NAME="${OPENJDK_TARGET_OS}-${OPENJDK_TARGET_CPU}-${JDK_VARIANT}-${ANDED_JVM_VARIANTS}-${DEBUG_LEVEL}"

    fi

    OUTPUT_ROOT="$SRC_ROOT/build/${CONF_NAME}"

    $MKDIR -p "$OUTPUT_ROOT"

    if test ! -d "$OUTPUT_ROOT"; then

      AC_MSG_ERROR([Could not create build directory $OUTPUT_ROOT])

    fi

  else

    # We are running configure from outside of the src dir.

    # Then use the current directory as output dir!

    # If configuration is situated in normal build directory, just use the build

    # directory name as configuration name, otherwise use the complete path.

    if test "x${CONF_NAME}" = x; then

      CONF_NAME=`$ECHO $CURDIR | $SED -e "s!^${SRC_ROOT}/build/!!"`

    fi

    OUTPUT_ROOT="$CURDIR"

    # WARNING: This might be a bad thing to do. You need to be sure you want to

    # have a configuration in this directory. Do some sanity checks!

    if test ! -e "$OUTPUT_ROOT/spec.gmk"; then

      # If we have a spec.gmk, we have run here before and we are OK. Otherwise, check for

      # other files

      files_present=`$LS $OUTPUT_ROOT`

      # Configure has already touched config.log and confdefs.h in the current dir when this check

      # is performed.

      filtered_files=`$ECHO "$files_present" | $SED -e 's/config.log//g' -e 's/confdefs.h//g' -e 's/ //g' \

      | $TR -d '\n'`

      if test "x$filtered_files" != x; then

        AC_MSG_NOTICE([Current directory is $CURDIR.])

        AC_MSG_NOTICE([Since this is not the source root, configure will output the configuration here])

        AC_MSG_NOTICE([(as opposed to creating a configuration in <src_root>/build/<conf-name>).])

        AC_MSG_NOTICE([However, this directory is not empty. This is not allowed, since it could])

        AC_MSG_NOTICE([seriously mess up just about everything.])

        AC_MSG_NOTICE([Try 'cd $SRC_ROOT' and restart configure])

        AC_MSG_NOTICE([(or create a new empty directory and cd to it).])

        AC_MSG_ERROR([Will not continue creating configuration in $CURDIR])

      fi

    fi

  fi

  AC_MSG_CHECKING([what configuration name to use])

  AC_MSG_RESULT([$CONF_NAME])

  BASIC_FIXUP_PATH(OUTPUT_ROOT)

  AC_SUBST(SPEC, $OUTPUT_ROOT/spec.gmk)

  AC_SUBST(CONF_NAME, $CONF_NAME)

  AC_SUBST(OUTPUT_ROOT, $OUTPUT_ROOT)

  # Most of the probed defines are put into config.h

  AC_CONFIG_HEADERS([$OUTPUT_ROOT/config.h:$AUTOCONF_DIR/config.h.in])

  # The spec.gmk file contains all variables for the make system.

  AC_CONFIG_FILES([$OUTPUT_ROOT/spec.gmk:$AUTOCONF_DIR/spec.gmk.in])

  # The hotspot-spec.gmk file contains legacy variables for the hotspot make system.

  AC_CONFIG_FILES([$OUTPUT_ROOT/hotspot-spec.gmk:$AUTOCONF_DIR/hotspot-spec.gmk.in])

  # The bootcycle-spec.gmk file contains support for boot cycle builds.

  AC_CONFIG_FILES([$OUTPUT_ROOT/bootcycle-spec.gmk:$AUTOCONF_DIR/bootcycle-spec.gmk.in])

  # The compare.sh is used to compare the build output to other builds.

  AC_CONFIG_FILES([$OUTPUT_ROOT/compare.sh:$AUTOCONF_DIR/compare.sh.in])

  # Spec.sh is currently used by compare-objects.sh

  AC_CONFIG_FILES([$OUTPUT_ROOT/spec.sh:$AUTOCONF_DIR/spec.sh.in])

  # The generated Makefile knows where the spec.gmk is and where the source is.

  # You can run make from the OUTPUT_ROOT, or from the top-level Makefile

  # which will look for generated configurations

  AC_CONFIG_FILES([$OUTPUT_ROOT/Makefile:$AUTOCONF_DIR/Makefile.in])

  # Save the arguments given to us

  echo "$CONFIGURE_COMMAND_LINE" > $OUTPUT_ROOT/configure-arguments

])

AC_DEFUN_ONCE([BASIC_SETUP_LOGGING],

[

  # Setup default logging of stdout and stderr to build.log in the output root.

  BUILD_LOG='$(OUTPUT_ROOT)/build.log'

  BUILD_LOG_PREVIOUS='$(OUTPUT_ROOT)/build.log.old'

  BUILD_LOG_WRAPPER='$(BASH) $(SRC_ROOT)/common/bin/logger.sh $(BUILD_LOG)'

  AC_SUBST(BUILD_LOG)

  AC_SUBST(BUILD_LOG_PREVIOUS)

  AC_SUBST(BUILD_LOG_WRAPPER)

])

#%%% Simple tools %%%

# Check if we have found a usable version of make

# $1: the path to a potential make binary (or empty)

# $2: the description on how we found this