#!/bin/sh
# genscripts.sh - generate the ld-emulation-target specific files
# Copyright (C) 2004-2015 Free Software Foundation, Inc.
#
# This file is part of the Gnu Linker.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3, or (at your option)
# any later version.
#
# This program 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 for more details.
#
# You should have received a copy of the GNU General Public License
# along with GLD; see the file COPYING.  If not, write to the Free
# Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA
# 02110-1301, USA.
#
# Usage: genscripts_extra.sh \
#          srcdir \
#          libdir \
#          prefix \
#          exec_prefix \
#          host \
#          target \
#          target_alias \
#          default_emulation \
#          native_lib_dirs \
#          use_sysroot \
#          enable_initfini_array \
#          this_emulation \
# optional:
#          tool_dir
#
# Sample usage:
#
#   genscripts_extra.sh \
#    /sources/ld \
#    /usr/local/lib \
#    /usr/local \
#    /usr/local \
#    sparc-sun-sunos4.1.3 \
#    sparc-sun-sunos4.1.3 \
#    sparc-sun-sunos4.1.3 \
#    sun4 \
#    "" \
#    no \
#    sun3 \
#    sparc-sun-sunos4.1.3 \
#    sparc.sh
#
# produces the linker scripts:
#
#   sun3.x       [default linker script]
#   sun3.xbn     [used when the linker is invoked with "-N"]
#   sun3.xn      [used when the linker is invoked with "-n"]
#   sun3.xr      [used when the linker is invoked with "-r"]
#   sun3.xu      [used when the linker is invoked with "-Ur"]
# and maybe:
#   sun3.xc      [used when the linker is invoked with "-z combreloc"]
#   sun3.xsc     [used when the linker is invoked with "--shared"]
#   sun3.xdc     [used when the linker is invoked with "-pie"]
#   sun3.xa      [used when the linker is invoked with "--enable-auto-import"]
#
# It also produced the C source file:
#
#   em_sun3.c
#
# which is then compiled into the linker.
#
# The linker scripts are created by running the shell script
# /sources/ld/emulparams/sparc.sh to set the value of ${SCRIPT_NAME}
# (and any other variables it wants to).  ${SCRIPT_NAME} is then
# invoked with a variable called ${LD_FLAG} to tell it which version
# of the linker script to create.


setglobal srcdir = $1
setglobal libdir = $2
setglobal prefix = $3
setglobal exec_prefix = $4
setglobal host = $5
setglobal target = $6
setglobal target_alias = $7
setglobal EMULATION_LIBPATH = $8
setglobal NATIVE_LIB_DIRS = $9
shift 9
setglobal use_sysroot = $1
setglobal ENABLE_INITFINI_ARRAY = $2
setglobal EMULATION_NAME = $3
setglobal TOOL_LIB = $4

# Include the emulation-specific parameters:
setglobal CUSTOMIZER_SCRIPT = ""$(srcdir)/emulparams/$(EMULATION_NAME).sh""
source ${CUSTOMIZER_SCRIPT}

if test -d ldscripts {
  true
} else {
  mkdir ldscripts
}

# Set some flags for the emultempl scripts.  USE_LIBPATH will
# be set for any libpath-using emulation; NATIVE will be set for a
# libpath-using emulation where ${host} = ${target}.  NATIVE
# may already have been set by the emulparams file, but that's OK
# (it'll just get set to "yes" twice).

match " $EMULATION_LIBPATH " {
  with *" ${EMULATION_NAME} "*
    if test "x$(host)" = "x$(target)"  {
      setglobal NATIVE = 'yes'
      setglobal USE_LIBPATH = 'yes'
    } elif test "x$(use_sysroot)" = "xyes"  {
      setglobal USE_LIBPATH = 'yes'
    }
    
}

# If the emulparams file sets NATIVE, make sure USE_LIBPATH is set also.
if test "x$NATIVE" = "xyes"  {
  setglobal USE_LIBPATH = 'yes'
}

# Set the library search path, for libraries named by -lfoo.
# If LIB_PATH is defined (e.g., by Makefile) and non-empty, it is used.
# Otherwise, the default is set here.
#
# The format is the usual list of colon-separated directories.
# To force a logically empty LIB_PATH, do LIBPATH=":".
#
# If we are using a sysroot, prefix library paths with "=" to indicate this.
#
# If the emulparams file set LIBPATH_SUFFIX, prepend an extra copy of
# the library path with the suffix applied.

# Paths with LIBPATH_SUFFIX
setglobal lib_path1 = ''
# Paths without LIBPATH_SUFFIX
setglobal lib_path2 = ''
if test $(LIB_PATH) != ":"  {
  setglobal lib_path2 = $(LIB_PATH)
}

# Add args to lib_path1 and lib_path2, discarding any duplicates
proc append_to_lib_path
{
  if test $Argc != 0 {
    for lib in [@Argv] {
      # The "=" is harmless if we aren't using a sysroot, but also needless.
      if test "x$(use_sysroot)" = "xyes"  {
	setglobal lib = ""=$(lib)""
      }
      setglobal skip_lib = 'no'
      if test -n $(LIBPATH_SUFFIX) {
	match $(lib) {
	  with *${LIBPATH_SUFFIX}
	    match :$(lib_path1): {
	      with *:${lib}:* 
	      with :: setglobal lib_path1 = $(lib) 
	      with * setglobal lib_path1 = "$(lib_path1):$(lib)" 
	    } 
	  with *
	    if test -n $(LIBPATH_SUFFIX_SKIP) {
	      match $(lib) {
		with *${LIBPATH_SUFFIX_SKIP} setglobal skip_lib = 'yes' 
	      }
	    }
	    if test $(skip_lib) = "no" {
	      match :$(lib_path1): {
		with *:${lib}${LIBPATH_SUFFIX}:* 
		with :: setglobal lib_path1 = "$(lib)$(LIBPATH_SUFFIX)" 
	        with * setglobal lib_path1 = "$(lib_path1):$(lib)$(LIBPATH_SUFFIX)" 
	      }
	    } 
	}
      }
      if test $(skip_lib) = "no" {
	match :$(lib_path1):$(lib_path2): {
	  with *:${lib}:* 
	  with *:: setglobal lib_path2 = $(lib) 
	  with * setglobal lib_path2 = "$(lib_path2):$(lib)" 
	}
      }
    }
  }
}

# Always search $(tooldir)/lib, aka /usr/local/TARGET/lib when native
# except when LIBPATH=":".
if test $(LIB_PATH) != ":"  {
  setglobal libs = ''
  if test "x$(TOOL_LIB)" = "x"  {
    if test "x$(NATIVE)" = "xyes"  {
      setglobal libs = ""$(exec_prefix)/$(target_alias)/lib""
    }
  } else {
    # For multilib'ed targets, ensure both ${target_alias}/lib${LIBPATH_SUFFIX}
    # and ${TOOL_LIB}/lib${LIBPATH_SUFFIX} are in the default search path,
    # because 64bit libraries may be in both places, depending on
    # cross-development setup method (e.g.: /usr/s390x-linux/lib64
    # vs. /usr/s390-linux/lib64)
    match "$(NATIVE):$(LIBPATH_SUFFIX):$(TOOL_LIB)" {
      with :* | *::* | *:*:*${LIBPATH_SUFFIX} 
      with * setglobal libs = ""$(exec_prefix)/$(target_alias)/lib$(LIBPATH_SUFFIX)"" 
    }
    setglobal libs = ""$(exec_prefix)/$(TOOL_LIB)/lib $(libs)""
  }
  append_to_lib_path $(libs)
}

if test "x$(LIB_PATH)" = "x" && test "x$(USE_LIBPATH)" = xyes  {
  setglobal libs = $(NATIVE_LIB_DIRS)
  if test "x$(NATIVE)" = "xyes"  {
    match " $(libs) " {
      with *" ${libdir} "* 
      with * setglobal libs = ""$(libdir) $(libs)"" 
    }
  }
  append_to_lib_path $(libs)
}

match :$(lib_path1):$(lib_path2): {
  with *:: | ::* setglobal LIB_PATH = "$(lib_path1)$(lib_path2)" 
  with * setglobal LIB_PATH = "$(lib_path1):$(lib_path2)" 
}

setglobal LIB_SEARCH_DIRS = $[echo $(LIB_PATH) | sed -e 's/:/ /g' -e 's/\([^ ][^ ]*\)/SEARCH_DIR(\\"\1\\");/g]

# We need it for testsuite.
set $EMULATION_LIBPATH
if test "x$1" = "x$EMULATION_NAME" {
    test -d tmpdir || mkdir tmpdir
    rm -f tmpdir/libpath.exp
    echo "set libpath \"$(LIB_PATH)\"" | sed -e 's/:/ /g' > tmpdir/libpath.exp
}

# Generate 5 or 6 script files from a master script template in
# ${srcdir}/scripttempl/${SCRIPT_NAME}.sh.  Which one of the 5 or 6
# script files is actually used depends on command line options given
# to ld.  (SCRIPT_NAME was set in the emulparams_file.)
#
# A .x script file is the default script.
# A .xr script is for linking without relocation (-r flag).
# A .xu script is like .xr, but *do* create constructors (-Ur flag).
# A .xn script is for linking with -n flag (mix text and data on same page).
# A .xbn script is for linking with -N flag (mix text and data on same page).
# A .xs script is for generating a shared library with the --shared
#   flag; it is only generated if $GENERATE_SHLIB_SCRIPT is set by the
#   emulation parameters.
# A .xc script is for linking with -z combreloc; it is only generated if
#   $GENERATE_COMBRELOC_SCRIPT is set by the emulation parameters or
#   $SCRIPT_NAME is "elf".
# A .xsc script is for linking with --shared -z combreloc; it is generated
#   if $GENERATE_COMBRELOC_SCRIPT is set by the emulation parameters or
#   $SCRIPT_NAME is "elf" and $GENERATE_SHLIB_SCRIPT is set by the emulation
#   parameters too.

if test "x$SCRIPT_NAME" = "xelf" {
  setglobal GENERATE_COMBRELOC_SCRIPT = 'yes'
}

setglobal SEGMENT_SIZE = $(SEGMENT_SIZE-${MAXPAGESIZE-${TARGET_PAGE_SIZE}})

# Determine DATA_ALIGNMENT for the 5 variants, using
# values specified in the emulparams/<script_to_run>.sh file or default.

setglobal DATA_ALIGNMENT_ = $(DATA_ALIGNMENT_-${DATA_ALIGNMENT-ALIGN(${SEGMENT_SIZE})})
setglobal DATA_ALIGNMENT_n = $(DATA_ALIGNMENT_n-${DATA_ALIGNMENT_})
setglobal DATA_ALIGNMENT_N = $(DATA_ALIGNMENT_N-${DATA_ALIGNMENT-.})
setglobal DATA_ALIGNMENT_r = $(DATA_ALIGNMENT_r-${DATA_ALIGNMENT-})
setglobal DATA_ALIGNMENT_u = $(DATA_ALIGNMENT_u-${DATA_ALIGNMENT_r})

setglobal LD_FLAG = 'r'
setglobal DATA_ALIGNMENT = $(DATA_ALIGNMENT_r)
setglobal DEFAULT_DATA_ALIGNMENT = ""ALIGN($(SEGMENT_SIZE))""
shell { echo "/* Script for ld -r: link without relocation */"
  source ${CUSTOMIZER_SCRIPT}
  source ${srcdir}/scripttempl/${SCRIPT_NAME}.sc
} | sed -e '/^ *$/d;s/[ 	]*$//' > ldscripts/$(EMULATION_NAME).xr

setglobal LD_FLAG = 'u'
setglobal DATA_ALIGNMENT = $(DATA_ALIGNMENT_u)
setglobal CONSTRUCTING = '" '"
shell { echo "/* Script for ld -Ur: link w/out relocation, do create constructors */"
  source ${CUSTOMIZER_SCRIPT}
  source ${srcdir}/scripttempl/${SCRIPT_NAME}.sc
} | sed -e '/^ *$/d;s/[ 	]*$//' > ldscripts/$(EMULATION_NAME).xu

setglobal LD_FLAG = ''
setglobal DATA_ALIGNMENT = $(DATA_ALIGNMENT_)
setglobal RELOCATING = '" '"
shell { echo "/* Default linker script, for normal executables */"
  source ${CUSTOMIZER_SCRIPT}
  source ${srcdir}/scripttempl/${SCRIPT_NAME}.sc
} | sed -e '/^ *$/d;s/[ 	]*$//' > ldscripts/$(EMULATION_NAME).x

setglobal LD_FLAG = 'n'
setglobal DATA_ALIGNMENT = $(DATA_ALIGNMENT_n)
shell { echo "/* Script for -n: mix text and data on same page */"
  source ${CUSTOMIZER_SCRIPT}
  source ${srcdir}/scripttempl/${SCRIPT_NAME}.sc
} | sed -e '/^ *$/d;s/[ 	]*$//' > ldscripts/$(EMULATION_NAME).xn

setglobal LD_FLAG = 'N'
setglobal DATA_ALIGNMENT = $(DATA_ALIGNMENT_N)
shell { echo "/* Script for -N: mix text and data on same page; don't align data */"
  source ${CUSTOMIZER_SCRIPT}
  source ${srcdir}/scripttempl/${SCRIPT_NAME}.sc
} | sed -e '/^ *$/d;s/[ 	]*$//' > ldscripts/$(EMULATION_NAME).xbn

if test -n $GENERATE_COMBRELOC_SCRIPT {
  setglobal DATA_ALIGNMENT = $(DATA_ALIGNMENT_c-${DATA_ALIGNMENT_})
  setglobal LD_FLAG = 'c'
  setglobal COMBRELOC = "ldscripts/$(EMULATION_NAME).xc.tmp"
  shell { echo "/* Script for -z combreloc: combine and sort reloc sections */"
    source ${CUSTOMIZER_SCRIPT}
    source ${srcdir}/scripttempl/${SCRIPT_NAME}.sc
  } | sed -e '/^ *$/d;s/[ 	]*$//' > ldscripts/$(EMULATION_NAME).xc
  rm -f $(COMBRELOC)
  setglobal LD_FLAG = 'w'
  setglobal RELRO_NOW = '" '"
  setglobal COMBRELOC = "ldscripts/$(EMULATION_NAME).xw.tmp"
  shell { echo "/* Script for -z combreloc -z now -z relro: combine and sort reloc sections */"
    source ${CUSTOMIZER_SCRIPT}
    source ${srcdir}/scripttempl/${SCRIPT_NAME}.sc
  } | sed -e '/^ *$/d;s/[ 	]*$//' > ldscripts/$(EMULATION_NAME).xw
  rm -f $(COMBRELOC)
  setglobal COMBRELOC = ''
  unset RELRO_NOW
}

if test -n $GENERATE_SHLIB_SCRIPT {
  setglobal LD_FLAG = 'shared'
  setglobal DATA_ALIGNMENT = $(DATA_ALIGNMENT_s-${DATA_ALIGNMENT_})
  setglobal CREATE_SHLIB = '" '"
  shell {
    echo "/* Script for ld --shared: link shared library */"
    source ${CUSTOMIZER_SCRIPT}
    source ${srcdir}/scripttempl/${SCRIPT_NAME}.sc
  } | sed -e '/^ *$/d;s/[ 	]*$//' > ldscripts/$(EMULATION_NAME).xs
  if test -n $GENERATE_COMBRELOC_SCRIPT {
    setglobal LD_FLAG = 'cshared'
    setglobal DATA_ALIGNMENT = $(DATA_ALIGNMENT_sc-${DATA_ALIGNMENT})
    setglobal COMBRELOC = "ldscripts/$(EMULATION_NAME).xsc.tmp"
    shell { echo "/* Script for --shared -z combreloc: shared library, combine & sort relocs */"
      source ${CUSTOMIZER_SCRIPT}
      source ${srcdir}/scripttempl/${SCRIPT_NAME}.sc
    } | sed -e '/^ *$/d;s/[ 	]*$//' > ldscripts/$(EMULATION_NAME).xsc
    rm -f $(COMBRELOC)
    setglobal LD_FLAG = 'wshared'
    setglobal RELRO_NOW = '" '"
    setglobal COMBRELOC = "ldscripts/$(EMULATION_NAME).xsw.tmp"
    shell { echo "/* Script for --shared -z combreloc -z now -z relro: shared library, combine & sort relocs */"
      source ${CUSTOMIZER_SCRIPT}
      source ${srcdir}/scripttempl/${SCRIPT_NAME}.sc
    } | sed -e '/^ *$/d;s/[ 	]*$//' > ldscripts/$(EMULATION_NAME).xsw
    rm -f $(COMBRELOC)
    setglobal COMBRELOC = ''
    unset RELRO_NOW
  }
  unset CREATE_SHLIB
}

if test -n $GENERATE_PIE_SCRIPT {
  setglobal LD_FLAG = 'pie'
  setglobal DATA_ALIGNMENT = $(DATA_ALIGNMENT_s-${DATA_ALIGNMENT_})
  setglobal CREATE_PIE = '" '"
  shell {
    echo "/* Script for ld -pie: link position independent executable */"
    source ${CUSTOMIZER_SCRIPT}
    source ${srcdir}/scripttempl/${SCRIPT_NAME}.sc
  } | sed -e '/^ *$/d;s/[ 	]*$//' > ldscripts/$(EMULATION_NAME).xd
  if test -n $GENERATE_COMBRELOC_SCRIPT {
    setglobal LD_FLAG = 'cpie'
    setglobal DATA_ALIGNMENT = $(DATA_ALIGNMENT_sc-${DATA_ALIGNMENT})
    setglobal COMBRELOC = "ldscripts/$(EMULATION_NAME).xdc.tmp"
    shell { echo "/* Script for -pie -z combreloc: position independent executable, combine & sort relocs */"
      source ${CUSTOMIZER_SCRIPT}
      source ${srcdir}/scripttempl/${SCRIPT_NAME}.sc
    } | sed -e '/^ *$/d;s/[ 	]*$//' > ldscripts/$(EMULATION_NAME).xdc
    rm -f $(COMBRELOC)
    setglobal LD_FLAG = 'wpie'
    setglobal RELRO_NOW = '" '"
    setglobal COMBRELOC = "ldscripts/$(EMULATION_NAME).xdw.tmp"
    shell { echo "/* Script for -pie -z combreloc -z now -z relro: position independent executable, combine & sort relocs */"
      source ${CUSTOMIZER_SCRIPT}
      source ${srcdir}/scripttempl/${SCRIPT_NAME}.sc
    } | sed -e '/^ *$/d;s/[ 	]*$//' > ldscripts/$(EMULATION_NAME).xdw
    rm -f $(COMBRELOC)
    setglobal COMBRELOC = ''
    unset RELRO_NOW
  }
  unset CREATE_PIE
}

if test -n $GENERATE_AUTO_IMPORT_SCRIPT {
  setglobal LD_FLAG = 'auto_import'
  setglobal DATA_ALIGNMENT = $(DATA_ALIGNMENT_)
  shell {
    echo "/* Script for ld --enable-auto-import: Like the default script except read only data is placed into .data  */"
    source ${CUSTOMIZER_SCRIPT}
    source ${srcdir}/scripttempl/${SCRIPT_NAME}.sc
  } | sed -e '/^ *$/d;s/[ 	]*$//' > ldscripts/$(EMULATION_NAME).xa
}

match "$COMPILE_IN: $EMULATION_LIBPATH " {
    with :*" ${EMULATION_NAME} "* setglobal COMPILE_IN = 'yes'
}

# PR ld/5652:
# Determine if the shell has support for the variable BASH_LINENO.
# When it is the case, it is only available inside functions.
proc has_lineno
{
  test "x$BASH_LINENO" != "x"
}

# Enable accruate error source in the compiler error messages, if possible.
if has_lineno {
  source ${srcdir}/genscrba.sh
} else {
  proc source_em
  {
    source $1
  }
  proc fragment
  {
    cat >> e$(EMULATION_NAME).c
  }
}

# Generate e${EMULATION_NAME}.c.
# Start with an empty file, then the sourced .em script
# can use the "fragment" function to append.
> e$(EMULATION_NAME).c
source_em $(srcdir)/emultempl/$(TEMPLATE_NAME-generic).em