#

# Copyright (c) 1995, 2012, 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.

#

#

# Makefile to specify compiler flags for programs and libraries

# targeted to Solaris.  Should not contain any rules.

#

# WARNING: This file is shared with other workspaces. 

#          So when it includes other files, it must use JDK_TOPDIR.

#

# Warning: the following variables are overridden by Defs.gmk. Set

# values will be silently ignored:

#   CFLAGS        (set $(OTHER_CFLAGS) instead)

#   CPPFLAGS      (set $(OTHER_CPPFLAGS) instead)

#   CXXFLAGS      (set $(OTHER_CXXFLAGS) instead)

#   LDFLAGS       (set $(OTHER_LDFAGS) instead)

#   LDLIBS        (set $(EXTRA_LIBS) instead)

#   LDLIBS_COMMON (set $(EXTRA_LIBS) instead)

#   LINTFLAGS     (set $(OTHER_LINTFLAGS) instead)

#

# Note: CPPFLAGS are used in C and C++ compiles.

#

# Get shared JDK settings

include $(JDK_MAKE_SHARED_DIR)/Defs.gmk

ifndef PLATFORM_SRC

PLATFORM_SRC = $(BUILDDIR)/../src/solaris

endif # PLATFORM_SRC

# Location of the various .properties files specific to Solaris platform

ifndef PLATFORM_PROPERTIES

  PLATFORM_PROPERTIES  = $(BUILDDIR)/../src/solaris/lib

endif # PLATFORM_SRC

# Platform specific closed sources

ifndef OPENJDK

  ifndef CLOSED_PLATFORM_SRC

    CLOSED_PLATFORM_SRC = $(BUILDDIR)/../src/closed/solaris

  endif

endif

# platform specific include files

PLATFORM_INCLUDE_NAME = $(PLATFORM)

PLATFORM_INCLUDE      = $(INCLUDEDIR)/$(PLATFORM_INCLUDE_NAME)

# suffix used for make dependencies files

DEPEND_SUFFIX = d

# suffix used for lint files

LINT_SUFFIX = ln

# The suffix applied to the library name for FDLIBM

FDDLIBM_SUFFIX = a

# The suffix applied to scripts (.bat for windows, nothing for unix)

SCRIPT_SUFFIX =

# CC compiler object code output directive flag value

CC_OBJECT_OUTPUT_FLAG = -o #trailing blank required!

# The Full Debug Symbols (FDS) default for VARIANT == OPT builds is

# enabled with debug info files ZIP'ed to save space. For VARIANT !=

# OPT builds, FDS is always enabled, after all a debug build without

# debug info isn't very useful. The ZIP_DEBUGINFO_FILES option only has

# meaning when FDS is enabled.

#

# If you invoke a build with FULL_DEBUG_SYMBOLS=0, then FDS will be

# disabled for a VARIANT == OPT build.

#

# Note: Use of a different variable name for the FDS override option

# versus the FDS enabled check is intentional (FULL_DEBUG_SYMBOLS

# versus ENABLE_FULL_DEBUG_SYMBOLS). For auto build systems that pass

# in options via environment variables, use of distinct variables

# prevents strange behaviours. For example, in a VARIANT != OPT build,

# the FULL_DEBUG_SYMBOLS environment variable will be 0, but the

# ENABLE_FULL_DEBUG_SYMBOLS make variable will be 1. If the same

# variable name is used, then different values can be picked up by

# different parts of the build. Just to be clear, we only need two

# variable names because the incoming option value can be overridden

# in some situations, e.g., a VARIANT != OPT build.

ifeq ($(VARIANT), OPT)

  FULL_DEBUG_SYMBOLS ?= 1

  ENABLE_FULL_DEBUG_SYMBOLS = $(FULL_DEBUG_SYMBOLS)

else

  # debug variants always get Full Debug Symbols (if available)

  ENABLE_FULL_DEBUG_SYMBOLS = 1

endif

_JUNK_ := $(shell \

  echo >&2 "INFO: ENABLE_FULL_DEBUG_SYMBOLS=$(ENABLE_FULL_DEBUG_SYMBOLS)")

# since objcopy is optional, we set ZIP_DEBUGINFO_FILES later

ifeq ($(ENABLE_FULL_DEBUG_SYMBOLS),1)

  # Default OBJCOPY comes from the SUNWbinutils package:

  DEF_OBJCOPY=/usr/sfw/bin/gobjcopy

  ifeq ($(PLATFORM)-$(LIBARCH), solaris-amd64)

    # On Solaris AMD64/X64, gobjcopy is not happy and fails:

    #

    # usr/sfw/bin/gobjcopy --add-gnu-debuglink=<lib>.debuginfo <lib>.so

    # BFD: stKPaiop: Not enough room for program headers, try linking with -N

    # /usr/sfw/bin/gobjcopy: stKPaiop: Bad value

    # BFD: stKPaiop: Not enough room for program headers, try linking with -N

    # /usr/sfw/bin/gobjcopy: libsaproc.debuginfo: Bad value

    # BFD: stKPaiop: Not enough room for program headers, try linking with -N

    # /usr/sfw/bin/gobjcopy: stKPaiop: Bad value

    _JUNK_ := $(shell \

      echo >&2 "INFO: $(DEF_OBJCOPY) is not working on Solaris AMD64/X64")

    OBJCOPY=

  else

    OBJCOPY=$(shell test -x $(DEF_OBJCOPY) && echo $(DEF_OBJCOPY))

    ifneq ($(ALT_OBJCOPY),)

      _JUNK_ := $(shell echo >&2 "INFO: ALT_OBJCOPY=$(ALT_OBJCOPY)")

      # disable .debuginfo support by setting ALT_OBJCOPY to a non-existent path

      OBJCOPY=$(shell test -x $(ALT_OBJCOPY) && echo $(ALT_OBJCOPY))

    endif

  endif

  # Setting ENABLE_FULL_DEBUG_SYMBOLS=1 (and OBJCOPY) above enables the

  # JDK build to import .debuginfo or .diz files from the HotSpot build.

  # However, adding FDS support to the JDK build will occur in phases

  # so a different make variable (LIBRARY_SUPPORTS_FULL_DEBUG_SYMBOLS

  # and PROGRAM_SUPPORTS_FULL_DEBUG_SYMBOLS) is used to indicate that a

  # particular library or program supports FDS.

  ifeq ($(OBJCOPY),)

    _JUNK_ := $(shell \

      echo >&2 "INFO: no objcopy cmd found so cannot create .debuginfo files.")

    ENABLE_FULL_DEBUG_SYMBOLS=0

  else

    _JUNK_ := $(shell \

      echo >&2 "INFO: $(OBJCOPY) cmd found so will create .debuginfo files.")

    # Library stripping policies for .debuginfo configs:

    #   all_strip - strips everything from the library

    #   min_strip - strips most stuff from the library; leaves minimum symbols

    #   no_strip  - does not strip the library at all

    #

    # Oracle security policy requires "all_strip". A waiver was granted on

    # 2011.09.01 that permits using "min_strip" in the Java JDK and Java JRE.

    #

    #

    # Currently, STRIP_POLICY is only used when Full Debug Symbols is enabled.

    STRIP_POLICY ?= min_strip

    _JUNK_ := $(shell \

      echo >&2 "INFO: STRIP_POLICY=$(STRIP_POLICY)")

    # HACK: disable ZIP_DEBUGINFO_FILES by default until install repo

    # changes are promoted

    ZIP_DEBUGINFO_FILES ?= 0

    _JUNK_ := $(shell \

      echo >&2 "INFO: ZIP_DEBUGINFO_FILES=$(ZIP_DEBUGINFO_FILES)")

  endif

endif

#

# Java default optimization (-x04/-O2) etc.  Applies to the VM.

#

ifndef OPTIMIZATION_LEVEL

  ifeq ($(PRODUCT), java)

    OPTIMIZATION_LEVEL = HIGHER

  else

    OPTIMIZATION_LEVEL = LOWER

  endif

endif

ifndef FASTDEBUG_OPTIMIZATION_LEVEL

  FASTDEBUG_OPTIMIZATION_LEVEL = LOWER

endif

#

# If -Xa is in CFLAGS_COMMON it will end up ahead of $(CC_OPT) for the

# optimized build, and that ordering of the flags completely freaks

# out cc.  Hence, -Xa is instead in each CFLAGS variant.

#

# The more unusual options to the Sun C compiler:

#	-v		Stricter type checking, more error checking

#			(To turn ALL warnings into fatals, use -errwarn=%all)

#	-xstrconst	Place string literals and constants in read-only area

#			(means you can't write on your string literals)

#	-xs		Force debug information (stabs) into the .so or a.out

#			(makes the library/executable debuggable without the

#			.o files needing to be around, but at a space cost)

#	-g & -O		If you add the -g option to the optimized compiles

#			you will get better stack retraces, the code is

#			still optimized. This includes a space cost too.

#       -xc99=%none     Do NOT allow for c99 extensions to be used.

#                       e.g. declarations must precede statements

#       -xCC            Allow the C++ style of comments in C: //

#                       Required with many of the source files.

#       -mt             Assume multi-threaded (important)

#

# The more unusual options to the Sun C compiler:

#       +w              Print more warnings

#       +w2             Maximum warnings

#

#

# Debug flag for C and C++ compiler

#

CFLAGS_DEBUG_OPTION    = -g $(CC_OPT/NONE)

CXXFLAGS_DEBUG_OPTION  = -g $(CXX_OPT/NONE)

# Turn off -g if we are doing tcov build

ifdef TCOV_BUILD

  CFLAGS_DEBUG_OPTION=

  CXXFLAGS_DEBUG_OPTION=

endif

# FASTDEBUG: Optimize the -g builds, gives us a faster debug java

#        If true adds -O to the debug compiles. This allows for any assert

#        tests to remain and debug checking. The resulting code is faster

#        but less debuggable.  Stack traces are still valid, although only

#        approximate line numbers are given. Printing of local variables

#        during a debugging session is not possible, but stepping and

#        printing of global or static variables should be possible.

#        Performance/size of files should be about the same, maybe smaller.

#

ifeq ($(FASTDEBUG), true)

  CFLAGS_DEBUG_OPTION    = -g  $(CC_OPT/$(FASTDEBUG_OPTIMIZATION_LEVEL))

  CXXFLAGS_DEBUG_OPTION  = -g0 $(CXX_OPT/$(FASTDEBUG_OPTIMIZATION_LEVEL))

endif

# If Full Debug Symbols is enabled, then we want the same debug and

# optimization flags as used by FASTDEBUG. We also want all the

# debug info in one place (-xs).

#

ifeq ($(ENABLE_FULL_DEBUG_SYMBOLS),1)

  ifeq ($(LIBRARY_SUPPORTS_FULL_DEBUG_SYMBOLS),1)

    ifeq ($(VARIANT), OPT)

      CC_OPT   = -g  -xs $(CC_OPT/$(FASTDEBUG_OPTIMIZATION_LEVEL))

      CXX_OPT  = -g0 -xs $(CXX_OPT/$(FASTDEBUG_OPTIMIZATION_LEVEL))

    endif

    CFLAGS_DEBUG_OPTION    += -xs

    CXXFLAGS_DEBUG_OPTION  += -xs

  endif

endif

CFLAGS_COMMON   = -L$(OBJDIR)

# Do not allow C99 language features like declarations in code etc.

CFLAGS_COMMON  += -xc99=%none

# Allow C++ comments in C code

CFLAGS_COMMON  += -xCC

# Show error message tags on errors

CFLAGS_COMMON   += -errshort=tags

CXXFLAGS_COMMON += -errtags=yes

# Optimization flags

CFLAGS_OPT      = $(CC_OPT)

# Debug version flags

CFLAGS_DBG      = $(CFLAGS_DEBUG_OPTION)

# Required C compiler flags

CFLAGS_COMMON  += -Xa $(CFLAGS_REQUIRED)

# Maximum warnings all the time

CXXFLAGS_COMMON += +w

CFLAGS_COMMON   += -v

# Assume MT behavior all the time (important)

CXXFLAGS_COMMON += -mt

CFLAGS_COMMON   += -mt

# Assume no C++ exceptions are used

CXXFLAGS_COMMON += -features=no%except -DCC_NOEX

# For C++, these options tell it to assume nothing about locating libraries

#    either at compile time, or at runtime. Use of these options will likely

#    require the use of -L and -R options to indicate where libraries will

#    be found at compile time (-L) and at runtime (-R).

#    The /usr/lib location comes for free, so no need to specify that one.

#    Note: C is much simplier and there is no need for these options. This

#          is mostly needed to avoid dependencies on libraries in the

#          Compiler install area, also see LIBCXX and LIBM.

CXXFLAGS_COMMON += -norunpath -xnolib

#

# Treat compiler warnings as errors, if requested

#

ifeq ($(COMPILER_WARNINGS_FATAL),true)

  CFLAGS_COMMON += -errwarn=%all

  CXXFLAGS_COMMON += -errwarn=%all

endif

CXXFLAGS_OPT	= $(CXX_OPT)

CXXFLAGS_DBG	= $(CXXFLAGS_DEBUG_OPTION)

CXXFLAGS_COMMON += $(CFLAGS_REQUIRED)

# Add -xstrconst to the library compiles. This forces all string

#  literals into the read-only data section, which prevents them from

#  being written to and increases the runtime pages shared on the system.

#

ifdef LIBRARY

  CFLAGS_COMMON +=-xstrconst

endif

# Source browser database

#

# COMPILE_WITH_SB    

#        If defined adds -xsb to compiles and creates a

#        source browsing database during compilation.

#

ifdef COMPILE_WITH_SB

  ifeq ($(LIBRARY), java)

    CFLAGS_DBG +=   -xsb

  endif

endif

# Lint Flags:

#	-Xa			ANSI C plus K&R, favor ANSI rules

#	-fd			report on old style func defs

#	-errchk=structarg	report on 64bit struct args by value

#	-errchk=longptr64	report on 64bit to 32bit issues (ignores casts)

#	-errchk=parentheses	report on suggested use of extra parens

#	-v 			suppress unused args

#	-x			suppress unused externs

#	-u			suppress extern func/vars used/defined

#	-errfmt=simple		use one line errors with position info

#       $(LINT_XARCH_OPTION)    See Compiler-sun.gwk

LINTFLAGS_COMMON  = -Xa

LINTFLAGS_COMMON += -fd 

LINTFLAGS_COMMON += -errchk=structarg,longptr64,parentheses

LINTFLAGS_COMMON += -v

LINTFLAGS_COMMON += -x 

LINTFLAGS_COMMON += -u

LINTFLAGS_COMMON += -errfmt=simple 

LINTFLAGS_OPT   = 

LINTFLAGS_DBG   =

# The -W0,-noglobal tells the compiler to NOT generate mangled global

#    ELF data symbols for file local static data.

#    This can break fix&continue, but we'd rather do the same compilations

#    for deliverable bits as we do for non-deliverable bits

#    Tell the compilers to never generate globalized names, all the time.

CFLAGS_COMMON += -W0,-noglobal

# If we have a specific arch value to use, add it

CFLAGS_COMMON    += $(XARCH_OPTION)

CXXFLAGS_COMMON  += $(XARCH_OPTION)

ASFLAGS_COMMON   += $(AS_XARCH_OPTION)

EXTRA_LIBS       += $(XARCH_OPTION)

LINTFLAGS_COMMON += $(LINT_XARCH_OPTION)

#

# uncomment the following to build with PERTURBALOT set

#

# OTHER_CFLAGS += -DPERTURBALOT

#

CPPFLAGS_COMMON = -D__solaris__  -D$(ARCH_FAMILY)

CPPFLAGS_OPT    = -DNDEBUG

CPPFLAGS_DBG    = -DDEBUG

ifneq ($(PRODUCT), java)

  CPPFLAGS_DBG    += -DLOGGING -DDBINFO

endif

ifeq ($(ARCH_FAMILY), i586)

  # The macro _LITTLE_ENDIAN needs to be defined the same to avoid the

  #   Sun C compiler warning message: warning: macro redefined: _LITTLE_ENDIAN

  #   (The Solaris X86 system defines this in file /usr/include/sys/isa_defs.h).

  #   Note: -Dmacro         is the same as    #define macro 1

  #         -Dmacro=	    is the same as    #define macro

  #

  CPPFLAGS_COMMON +=  -DcpuIntel -D_LITTLE_ENDIAN= -D$(LIBARCH)

  # Turn off a superfluous compiler error message on Intel

  CFLAGS_COMMON += -erroff=E_BAD_PRAGMA_PACK_VALUE

endif

# Java memory management is based on memory mapping by default, but a

# system only assuming malloc/free can be built by adding -DUSE_MALLOC 

CPPFLAGS_COMMON	+= -DTRACING -DMACRO_MEMSYS_OPS -DBREAKPTS

CPPFLAGS_OPT	+= -DTRIMMED

LDFLAGS_DEFS_OPTION  = -z defs

LDFLAGS_COMMON  += $(LDFLAGS_DEFS_OPTION)

#

# -L paths for finding and -ljava

#

LDFLAGS_COMMON += -L$(LIBDIR)/$(LIBARCH)

LDFLAGS_OPT     =

LDFLAGS_DBG     =

#

# We never really want the incremental linker, ever

#    The -xildoff option tells Sun's compilers to NOT use incremental linker

#

LDFLAGS_COMMON  += -xildoff

ifdef LIBRARY

  # Libraries need to locate other libraries at runtime, and you can tell

  #   a library where to look by way of the dynamic runpaths (RPATH or RUNPATH)

  #   buried inside the .so. The $ORIGIN says to look relative to where

  #   the library itself is and it can be followed with relative paths from

  #   that. By default we always look in $ORIGIN, optionally we add relative

  #   paths if the Makefile sets LD_RUNPATH_EXTRAS to those relative paths.

  #   The environment variable LD_LIBRARY_PATH will over-ride these runpaths.

  #   Try: 'dump -Lv lib*.so' to see these settings in a library.

  #

  LDFLAGS_COMMON += -R\$$ORIGIN

  LDFLAGS_COMMON += $(LD_RUNPATH_EXTRAS:%=-R\$$ORIGIN/%)

endif

EXTRA_LIBS += -lc

# Postprocessing is done on the images directories only

#

ifeq ($(VARIANT), OPT)

  ifeq ($(PARTIAL_GPROF), true)

    NO_STRIP = true

  endif

  ifeq ($(GPROF), true)

    NO_STRIP = true

  endif

  ifneq ($(NO_STRIP), true)

    # Debug 'strip -x' leaves local function Elf symbols (better stack traces)

    POST_STRIP_PROCESS = $(STRIP) -x

  endif

endif

POST_MCS_PROCESS=$(MCS) -d -a "JDK $(FULL_VERSION)"

#

# Sun C compiler will take -M and pass it on to ld.

# Usage: ld $(LD_MAPFILE_FLAG) mapfile *.o

#

ifeq ($(CC_VERSION),gcc)

LD_MAPFILE_FLAG = -Xlinker -M -Xlinker

else

LD_MAPFILE_FLAG = -M

endif

#

# Variables globally settable from the make command line (default

# values in brackets):

#	GPROF (false)

# Eg: 	% gnumake GPROF=true

GPROF = false

ifeq ($(GPROF), true)

    CFLAGS_COMMON += -DGPROF -xpg

    EXTRA_LIBS += -xpg

endif

# PARTIAL_GPROF is to be used ONLY during compilation - it should not

# appear during linking of libraries or programs.  It also should

# prevent linking with -z defs to allow a symbol to remain undefined.

#

PARTIAL_GPROF = false

ifeq ($(PARTIAL_GPROF), true)

  CFLAGS_GPROF += -xpg

  LDFLAGS_DEFS_OPTION  = -z nodefs

endif

#

# For a TCOV build we add in the TCOV_OPTION

#

ifdef TCOV_BUILD

  TCOV_OPTION		= -xprofile=tcov

  LDFLAGS_COMMON 	+= $(TCOV_OPTION) -Kpic

  CFLAGS_COMMON  	+= $(TCOV_OPTION)

  CXXFLAGS_COMMON 	+= $(TCOV_OPTION)

  EXTRA_LIBS 	+= $(TCOV_OPTION)

  LDNOMAP=true

endif

#

# Solaris only uses native threads. 

#

THREADS_FLAG=	native

THREADS_DIR=	threads

#

# Support for Quantify.

#

ifdef QUANTIFY

  QUANTIFY_CMD = quantify

  QUANTIFY_OPTIONS = -cache-dir=/tmp/quantify -always-use-cache-dir=yes

  LINK_PRE_CMD = $(QUANTIFY_CMD) $(QUANTIFY_OPTIONS)

  ifdef LIBRARY

    CFLAGS_COMMON += -K PIC

  endif

endif

#

# Support for Purify.

#