#

# Copyright 2005-2008 Sun Microsystems, Inc.  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.  Sun designates this

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

# by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

# CA 95054 USA or visit www.sun.com if you need additional information or

# have any questions.

#

#

# WARNING: This file is shared with other workspaces.

#

#

# Shared sanity rules for the JDK builds.

#

.SUFFIXES: .hdiffs

# All files created during sanity checking

SANITY_FILES =  $(ERROR_FILE) $(WARNING_FILE) $(MESSAGE_FILE)

# How to say "The Release Engineering people use this"

THE_OFFICIAL_USES=The official builds on $(PLATFORM) use

# How to say "You are using:"

YOU_ARE_USING=You appear to be using

# Error message

define SanityError

$(ECHO) "ERROR: $1\n" >> $(ERROR_FILE)

endef

# Warning message

define SanityWarning

$(ECHO) "WARNING: $1\n" >> $(WARNING_FILE)

endef

# Official version error message: name version required_version

define OfficialErrorMessage

$(call SanityError,\

$(THE_OFFICIAL_USES) $1 $3. Your $1 $(if $2,undefined,$2) will not work.)

endef

# Official version warning message: name version required_version

define OfficialWarningMessage

$(call SanityWarning,\

$(THE_OFFICIAL_USES) $1 $3. $(YOU_ARE_USING) $1 $2.)

endef

# Settings and rules to validate the JDK build environment.

ifeq ($(PLATFORM), solaris)

  FREE_SPACE := $(shell $(DF) -b $(OUTPUTDIR) | $(TAIL) -1 | $(NAWK) '{print $$2;}')

  TEMP_FREE_SPACE := $(shell $(DF) -b $(TEMP_DISK) | $(TAIL) -1 | $(NAWK) '{print $$2;}')

  # What kind of system we are using (Variations are Solaris and OpenSolaris)

  OS_VERSION := $(shell uname -r)

  OS_VARIANT_NAME := $(strip $(shell head -1 /etc/release | awk '{print $$1;}') )

  OS_VARIANT_VERSION := $(OS_VERSION)

  REQ_PATCH_LIST = $(JDK_TOPDIR)/make/PatchList.solaris

  ifeq ($(ARCH_FAMILY), sparc)

    PATCH_POSITION = $$4

  else

    PATCH_POSITION = $$6

  endif

  ifndef OPENJDK

    _GCC_VER :=$(shell $(GCC) -dumpversion 2>&1 )

    GCC_VER  :=$(call GetVersion,"$(_GCC_VER)")

  endif

endif

ifeq ($(PLATFORM), linux)

  FREE_SPACE := $(shell $(DF) --sync -kP $(OUTPUTDIR) | $(TAIL) -1 | $(NAWK) '{print $$4;}')

  TEMP_FREE_SPACE := $(shell $(DF) --sync -kP $(TEMP_DISK) | $(TAIL) -1 | $(NAWK) '{print $$4;}')

  # What kind of system we are using (Variation is the Linux vendor)

  OS_VERSION := $(shell uname -r)

  OS_VARIANT_NAME := $(shell \

    if [ -f /etc/fedora-release ] ; then \

      echo "Fedora"; \

    elif [ -f /etc/redhat-release ] ; then \

      echo "RedHat"; \

    elif [ -f /etc/SuSE-release ] ; then \

      echo "SuSE"; \

    else \

      echo "Unknown"; \

    fi)

  OS_VARIANT_VERSION := $(shell \

    if [ "$(OS_VARIANT_NAME)" = "Fedora" ] ; then \

      $(CAT) /etc/fedora-release | $(HEAD) -1 | $(NAWK) '{ print $$3; }' ; \

    fi)

  ALSA_INCLUDE=/usr/include/alsa/version.h

  ALSA_LIBRARY=/usr/lib/libasound.so

  _ALSA_VERSION := $(shell $(EGREP) SND_LIB_VERSION_STR $(ALSA_INCLUDE) | \

           $(SED) -e 's@.*\"\(.*\)\".*@\1@' )

  ALSA_VERSION := $(call GetVersion,$(_ALSA_VERSION))

endif

ifeq ($(PLATFORM), windows)

  FREE_SPACE := $(shell $(DF) -kP $(OUTPUTDIR) | $(TAIL) -1 | $(NAWK) '{print $$4;}')

  TEMP_FREE_SPACE := $(shell $(DF) -kP $(TEMP_DISK) | $(TAIL) -1 | $(NAWK) '{print $$4;}')

  # Windows 2000 is 5.0, Windows XP is 5.1, Windows 2003 is 5.2

  #    Assume 5.0 (Windows 2000) if systeminfo does not help

  WINDOWS_MAPPING-5.0 := Windows2000

  WINDOWS_MAPPING-5.1 := WindowsXP

  WINDOWS_MAPPING-5.2 := Windows2003

  # What kind of system we are using (Variation is the common name)

  _OS_VERSION := \

    $(shell systeminfo 2> $(DEV_NULL) | \

            egrep '^OS Version:' | \

            awk '{print $$3;}' )

  ifeq ($(_OS_VERSION),)

    OS_VERSION = 5.0

  else

    OS_VERSION = $(call MajorVersion,$(_OS_VERSION)).$(call MinorVersion,$(_OS_VERSION))

  endif

  OS_VARIANT_NAME := $(WINDOWS_MAPPING-$(OS_VERSION))

  OS_VARIANT_VERSION := $(OS_VERSION)

  ifdef USING_CYGWIN

    # CYGWIN version

    _CYGWIN_VER := $(SYSTEM_UNAME)

    CYGWIN_VER  :=$(call GetVersion,$(_CYGWIN_VER))

  endif

  DXSDK_VER := $(shell $(EGREP) DIRECT3D_VERSION $(DXSDK_INCLUDE_PATH)/d3d9.h 2>&1 | \

    $(EGREP) "\#define" | $(NAWK) '{print $$3}')

endif

# Get the version numbers of what we are using

_MAKE_VER  :=$(shell $(MAKE) --version 2>&1 | $(HEAD) -n 1)

_ZIP_VER   :=$(shell $(ZIPEXE) -help 2>&1 | $(HEAD) -n 4 | $(EGREP) '^Zip')

_UNZIP_VER :=$(shell $(UNZIP)  -help 2>&1 | $(HEAD) -n 4 | $(EGREP) '^UnZip')

_BOOT_VER  :=$(shell $(BOOTDIR)/bin/java -version 2>&1 | $(HEAD) -n 1)

MAKE_VER   :=$(call GetVersion,"$(_MAKE_VER)")

ZIP_VER    :=$(call GetVersion,"$(_ZIP_VER)")

UNZIP_VER  :=$(call GetVersion,"$(_UNZIP_VER)")

BOOT_VER   :=$(call GetVersion,"$(_BOOT_VER)")

_ANT_VER:=$(shell $(ANT) -version 2>&1 )

ANT_VER:=$(call GetVersion,"$(_ANT_VER)")

ifdef ALT_BINDIR

  ALT_BINDIR_VERSION := $(shell $(ALT_BINDIR)/java$(EXE_SUFFIX) -version 2>&1  | $(NAWK) -F'"' '{ print $$2 }')

  ALT_BINDIR_OK := $(shell $(ECHO) $(ALT_BINDIR_VERSION) | $(EGREP) -c '^$(JDK_MAJOR_VERSION).$(JDK_MINOR_VERSION)')

endif

INSTALL_PATCHES_FILE = $(TEMPDIR)/installed.patches

# Get ALL_SETTINGS defined

include $(JDK_MAKE_SHARED_DIR)/Sanity-Settings.gmk

.PHONY: \

	sane-copyrightyear\

	sane-settings \

	sane-insane \

	sane-build_number \

	sane-os_version \

	sane-memory_check \

	sane-windows \

	sane-locale \

	sane-linux \

	sane-cygwin \

	sane-cygwin-shell \

	sane-mks \

	sane-arch_data_model \

	sane-os_patch_level \

	sane-classpath \

	sane-java_home \

	sane-fonts \

	sane-binary-plugs \

	sane-variant \

	sane-ld_library_path \

	sane-ld_library_path_64 \

	sane-ld_options \

	sane-ld_run_path \

	sane-makeflags \

	sane-alt_outputdir \

	sane-outputdir \

	sane-alt_bootdir \

	sane-bootdir \

        sane-cups \

	sane-devtools_path \

	sane-compiler_path \

	sane-unixcommand_path \

	sane-usrbin_path \

	sane-unixccs_path \

	sane-docs_import \

	sane-math_iso \

	sane-libCrun \

	sane-odbcdir \

	sane-msdevtools_path \

	sane-hotspot_binaries \

	sane-hotspot_import \

	sane-hotspot_import_dir \

	sane-hotspot_import_include \

	sane-compiler \

	sane-link \

	sane-cacerts \

	sane-alsa-headers \

	sane-jibx \

	sane-ant_version \

	sane-zip_version \

	sane-unzip_version \

 	sane-msvcrt_path \

        sane-freetype

######################################################

# check for COPYRIGHT_YEAR variable

######################################################

sane-copyrightyear:

ifdef ALT_COPYRIGHT_YEAR

	@$(ECHO) "WARNING: ALT_COPYRIGHT_YEAR but not the current year\n" \

			 	 " will be used for copyright year.\n " \

		"" >>$(WARNING_FILE)

endif

######################################################

# check for INSANE variable

######################################################

sane-insane:

ifdef INSANE

	@$(ECHO) "WARNING: You are building in 'INSANE' mode. You \n" \

	   "        should not use this mode, and in fact, \n" \

	   "        it may be removed at any time. If you \n" \

	   "        have build problems as a result of using \n" \

	   "        INSANE mode, then you should not expect \n" \

	   "        assistance from anyone with the problems \n" \

	   "        or consequences you experience. \n" \

	   "" >> $(WARNING_FILE)

endif

######################################################

# check for GNU Make version

######################################################

MAKE_CHECK :=$(call CheckVersions,$(MAKE_VER),$(REQUIRED_MAKE_VER))

sane-make:

	@if [ "$(MAKE_CHECK)" != "same" -a "$(MAKE_CHECK)" != "newer" ]; then \

	  $(ECHO) "WARNING: The version of make being used is older than \n" \

	    "      the required version of '$(REQUIRED_MAKE_VER)'. \n" \

	    "      The version of make found was '$(MAKE_VER)'. \n" \

	    "" >> $(WARNING_FILE) ; \

	fi

######################################################

# Check the BUILD_NUMBER to make sure it contains bNN

######################################################

sane-build_number: 

	@if [ "`$(ECHO) $(BUILD_NUMBER) | $(SED) 's@.*b[0-9][0-9]*.*@bNN@'`" != "bNN" ] ; then \

	    $(ECHO) "WARNING: The BUILD_NUMBER needs to contain b[0-9][0-9]*. Currently BUILD_NUMBER=$(BUILD_NUMBER). \n" \

	      "        This has been known to cause build failures. \n" \

	      "" >> $(WARNING_FILE) ; \

	fi

######################################################

# Check the ARCH_DATA_MODEL setting

######################################################

sane-arch_data_model:

	@if [ "$(ARCH_DATA_MODEL)" != 32 -a "$(ARCH_DATA_MODEL)" != 64 ]; then \

	    $(ECHO) "ERROR: The setting of ARCH_DATA_MODEL must be 32 or 64.\n" \

	      "      $(YOU_ARE_USING) ARCH_DATA_MODEL=$(ARCH_DATA_MODEL). \n" \

	      "" >> $(ERROR_FILE) ; \

	fi

######################################################

# Check the OS version (windows and linus have release name checks)

#   NOTE: OPENJDK explicitly does not check for OS release information.

#         Unless we know for sure that it will not build somewhere, we cannot

#         generate a fatal sanity error, and a warning about the official

#         build platform just becomes clutter.

######################################################

ifndef OPENJDK

  OS_VERSION_CHECK := \

    $(call CheckVersions,$(OS_VERSION),$(REQUIRED_OS_VERSION))

  ifeq ($(OS_VARIANT_NAME),$(REQUIRED_OS_VARIANT_NAME))

    OS_VARIANT_VERSION_CHECK := \

      $(call CheckVersions,$(OS_VARIANT_VERSION),$(REQUIRED_OS_VARIANT_VERSION))

  endif

endif

sane-os_version:: sane-arch_data_model sane-memory_check sane-locale sane-os_patch_level

ifndef OPENJDK

  ifneq ($(OS_VARIANT_NAME),$(REQUIRED_OS_VARIANT_NAME))

    ifeq ($(OS_VERSION_CHECK),missing)

	@$(call OfficialErrorMessage,OS version,$(OS_VERSION),$(REQUIRED_OS_VERSION))

    endif

    ifneq ($(OS_VERSION_CHECK),same)

	@$(call OfficialWarningMessage,OS version,$(OS_VERSION),$(REQUIRED_OS_VERSION))

    endif

	@$(call OfficialWarningMessage,OS variant,$(OS_VARIANT_NAME),$(REQUIRED_OS_VARIANT_NAME))

  else

    ifneq ($(OS_VARIANT_VERSION_CHECK),same)

	@$(call OfficialWarningMessage,$(OS_VARIANT_NAME) version,$(OS_VARIANT_VERSION),$(REQUIRED_OS_VARIANT_VERSION))

    endif

  endif

endif # OPENJDK

ifeq ($(PLATFORM), windows)

  sane-os_version:: sane-cygwin sane-mks sane-cygwin-shell

endif

######################################################

# Check the memory available on this machine

######################################################

sane-memory_check:

	@if [ "$(LOW_MEMORY_MACHINE)" = "true" ]; then \

	  $(ECHO) "WARNING: This machine appears to only have $(MB_OF_MEMORY)Mb of physical memory, \n" \

	    "        builds on this machine could be slow. \n" \

	    "" >> $(WARNING_FILE) ; \

        fi

######################################################

# Check the locale (value of LC_ALL, not being empty or ==C can be a problem)

######################################################

sane-locale:

ifneq ($(PLATFORM), windows)

	@if [ "$(LC_ALL)" != "" -a "$(LC_ALL)" != "C" ]; then \

	  $(ECHO) "WARNING: LC_ALL has been set to $(LC_ALL), this can cause build failures. \n" \

	    "        Try setting LC_ALL to \"C\". \n" \

	    "" >> $(WARNING_FILE) ; \

        fi

	@if [ "$(LANG)" != "" -a "$(LANG)" != "C" ]; then \

	  $(ECHO) "WARNING: LANG has been set to $(LANG), this can cause build failures. \n" \

	    "        Try setting LANG to \"C\". \n" \

	    "" >> $(WARNING_FILE) ; \

        fi

endif

######################################################

# Check the Windows cygwin version

######################################################

ifeq ($(PLATFORM), windows)

  CYGWIN_CHECK :=$(call CheckVersions,$(CYGWIN_VER),$(REQUIRED_CYGWIN_VER))

sane-cygwin:

  ifdef USING_CYGWIN

    ifeq ($(CYGWIN_CHECK),missing)

	@$(call OfficialErrorMessage,CYGWIN version,$(CYGWIN_VER),$(REQUIRED_CYGWIN_VER))

    endif

    ifeq ($(CYGWIN_CHECK),older)

	@$(call OfficialWarningMessage,CYGWIN version,$(CYGWIN_VER),$(REQUIRED_CYGWIN_VER))

    endif

  endif

endif

######################################################

# Check the cygwin shell is used, not cmd.exe

######################################################

ifeq ($(PLATFORM), windows)

sane-cygwin-shell:

  ifdef USING_CYGWIN

	@if [ "$(SHLVL)" = "" -a "$(_)" = "" ]; then \

	  $(ECHO) "ERROR: You are using an unsupported shell. \n" \

	    "      Use either sh, bash, ksh, zsh, or tcsh. \n" \

	    "      Using the cmd.exe utility is not supported. \n" \

	    "      If you still want to try your current shell, \n" \

	    "      please export SHLVL=1 when running $(MAKE).  \n" \

	    "" >> $(ERROR_FILE) ; \

	fi

  endif

endif

######################################################

# Check the Windows mks version

######################################################

ifeq ($(PLATFORM), windows)

    MKS_CHECK :=$(call CheckVersions,$(MKS_VER),$(REQUIRED_MKS_VER))

sane-mks:

  ifndef USING_CYGWIN

    ifeq ($(MKS_CHECK),missing)

	@$(call OfficialErrorMessage,MKS version,$(MKS_VER),$(REQUIRED_MKS_VER))

    endif

    ifeq ($(MKS_CHECK),older)

	@$(call OfficialErrorMessage,MKS version,$(MKS_VER),$(REQUIRED_MKS_VER))

    endif

  endif

endif

######################################################

# Get list of installed patches (this file has a particular format)

######################################################

$(INSTALL_PATCHES_FILE):

	@$(prep-target)

ifeq ($(PLATFORM), solaris)

  ifeq ($(OS_VERSION),$(REQUIRED_OS_VERSION))

	$(SHOWREV) -p > $@ 2>&1

  endif

endif

	@$(ECHO) "" >> $@

######################################################

# Check list of Solaris patches

######################################################

sane-os_patch_level: $(INSTALL_PATCHES_FILE)

ifeq ($(PLATFORM), solaris)

  ifeq ($(OS_VERSION),$(REQUIRED_OS_VERSION))

	@$(NAWK) 'BEGIN { \

    readingInstallPatches = 0; \

    requiredCount = 0; \

    installCount = 0; \

} \

{ \

    if (readingInstallPatches) { \

        if ($$1=="Patch:") { \

            ns = split($$2,parts,"-");  \

            installPatchNo[installCount]=parts[1]; \

            installPatchRev[installCount]=parts[2]; \

            installCount++; \

        } \

    } \

     \

    if (!readingInstallPatches) { \

        if (index($$1,"#") != 0) continue; \

        if (match($$1,"BUILD") > 0 \

        && $$2 == $(OS_VERSION) \

        && ($$7 == "REQ" || $$7 == "req") \

        && $(PATCH_POSITION) != "none" \

        && $(PATCH_POSITION) != "NONE") { \

            ns = split($(PATCH_POSITION),parts,"-");  \

            requiredPatchNo[requiredCount]=parts[1]; \

            requiredPatchRev[requiredCount]=parts[2]; \

            requiredCount++; \

       } \

    } \

} \

END { \

    errorCount=0; \

    for (i=0; i<requiredCount; i++) { \

        foundMatch = 0; \

        for (j=0; j<installCount; j++) { \

            if (installPatchNo[j] == requiredPatchNo[i] \

            && installPatchRev[j] >= requiredPatchRev[i]) { \

                foundMatch = 1; \

                break; \

            } \

        } \

        if ( foundMatch == 0) { \

            printf("WARNING: Your solaris install is missing the required patch %s-%s\n", requiredPatchNo[i], requiredPatchRev[i] ); \

            printf("         Please update your your system patches or build on a different machine.\n\n" ); \

            errorCount++; \

        } \

    } \

}' $(REQ_PATCH_LIST) readingInstallPatches=1 $(INSTALL_PATCHES_FILE) >> $(WARNING_FILE)

  endif

endif # PLATFORM

######################################################

# CLASSPATH cannot be set, unless you are insane.

######################################################

sane-classpath:

ifdef CLASSPATH

	@$(ECHO) "ERROR: Your CLASSPATH environment variable is set.  This will \n" \

	   "      most likely cause the build to fail.  Please unset it \n" \

	   "      and start your build again. \n" \

	   "" >> $(ERROR_FILE)

endif

######################################################

# JAVA_HOME cannot be set, unless you are insane.

######################################################

sane-java_home:

ifdef JAVA_HOME

	@$(ECHO) "ERROR: Your JAVA_HOME environment variable is set.  This will \n" \

	   "      most likely cause the build to fail.  Please unset it \n" \

	   "      and start your build again. \n" \

	   "" >> $(ERROR_FILE)

endif

######################################################

# Make sure the fonts are there

# Exceptions are when explicitly building OPENJDK, or

# when the entire CLOSED_SRC dir is excluded, so we are

# implicitly building OPENJDK

######################################################

FONT_FILE=$(CLOSED_SRC)/share/lib/fonts/LucidaTypewriterRegular.ttf

sane-fonts:

ifndef OPENJDK

	@if [ -d $(CLOSED_SRC) ] ; then \

	 if [ ! -f $(FONT_FILE) ] ; then \

	  $(ECHO) "ERROR: Missing $(FONT_FILE). \n" \

	   "      Verify you have downloaded and overlayed on the source area all the binary files. \n" \

	   "" >> $(ERROR_FILE); \

	fi \

	fi

endif

######################################################

# If building OPENJDK check pre-built binaries are

# available for binary plug source components.

######################################################

ifdef OPENJDK

sane-binary-plugs:

  ifeq ($(IMPORT_BINARY_PLUGS),true)

	@if [ ! -d "$(BINARY_PLUGS_PATH)" ]; then \

	  $(ECHO) "WARNING: Can't locate pre-built libraries. \n" \

	    "      Please check your access to \n" \

	    "          $(BINARY_PLUGS_PATH) \n" \

	    "      and/or check your value of ALT_BINARY_PLUGS_PATH. \n" \

	   "" >> $(WARNING_FILE); \

	fi

  endif

endif

######################################################

# VARIANT must be set to DBG or OPT