[deliverable/binutils-gdb.git] / binutils / embedspu.sh

#! /bin/sh 
# Embed an SPU ELF executable into a PowerPC object file.
#
# Copyright 2006, 2007 Free Software Foundation, Inc.
#
# This file is part of GNU Binutils.
#
# 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 of the License, 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 this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA
# 02110-1301, USA.

usage ()
{
  echo "Usage: embedspu [flags] symbol_name input_filename output_filename"
  echo
  echo "        input_filename:  SPU ELF executable to be embedded"
  echo "        output_filename: Resulting PowerPC object file"
  echo "        symbol_name:     Name of program handle struct to be defined"
  echo "        flags:           GCC flags defining PowerPC object file format"
  echo "                         (e.g. -m32 or -m64)"
  exit 1
}

program_transform_name=
mydir=`dirname "$0"`

find_prog ()
{
  prog=`echo $1 | sed "$program_transform_name"`
  prog="$mydir/$prog"
  test -x "$prog" && return 0
  prog="$mydir/$1"
  test -x "$prog" && return 0
  prog=`echo $1 | sed "$program_transform_name"`
  which $prog > /dev/null 2> /dev/null && return 0
  return 1
}

SYMBOL=
INFILE=
OUTFILE=
FLAGS=

parse_args ()
{
  while test -n "$1"; do
    case "$1" in
      -*) FLAGS="${FLAGS} $1" ;;
      *)  if test -z "$SYMBOL"; then
	    SYMBOL="$1"
	  elif test -z "$INFILE"; then
	    INFILE="$1"
	  elif test -z "$OUTFILE"; then
	    OUTFILE="$1"
	  else
	    echo "Too many arguments!"
	    usage
	  fi ;;
    esac
    shift
  done
  if test -z "$OUTFILE"; then
    usage
  fi
  if test ! -r "$INFILE"; then
    echo "${INFILE}: File not found"
    usage
  fi
}

main ()
{
  parse_args "$@"

  # Find a powerpc gcc.  Support running from a combined tree build.
  if test -x "$mydir/../gcc/xgcc"; then
    CC="$mydir/../gcc/xgcc -B$mydir/../gcc/"
  else
    find_prog gcc
    if test $? -ne 0; then
      echo "Cannot find $prog"
      exit 1
    fi
    CC="$prog"
  fi

  # Find readelf.  Any old readelf should do.
  find_prog readelf
  if test $? -ne 0; then
    if which readelf > /dev/null 2> /dev/null; then
      prog=readelf
    else
      echo "Cannot find $prog"
      exit 1
    fi
  fi
  READELF="$prog"

  # Sanity check the input file
  if ! ${READELF} -h ${INFILE} | grep 'Class:.*ELF32' >/dev/null 2>/dev/null \
     || ! ${READELF} -h ${INFILE} | grep 'Type:.*EXEC' >/dev/null 2>/dev/null \
     || ! ${READELF} -h ${INFILE} | egrep 'Machine:.*(SPU|17)' >/dev/null 2>/dev/null
  then
    echo "${INFILE}: Does not appear to be an SPU executable"
    exit 1
  fi

  toe=`${READELF} -S ${INFILE} | sed -n -e 's, *\[ *\([0-9]*\)\] *\.toe *[PROGN]*BITS *\([0-9a-f]*\).*,\1 \2,p'`
  toe_addr=`echo $toe | sed -n -e 's,.* ,,p'`
  toe=`echo $toe | sed -n -e 's, .*,,p'`
  # For loaded sections, pick off section number, address, and file offset
  sections=`${READELF} -S ${INFILE} | sed -n -e 's, *\[ *\([0-9]*\)\] *[^ ]* *PROGBITS *\([0-9a-f]*\) *\([0-9a-f]*\).*,\1 \2 \3,p'`
  sections=`echo ${sections}`
  # For relocation sections, pick off file offset and info (points to
  # section where relocs apply)
  relas=`${READELF} -S ${INFILE} | sed -n -e 's, *\[ *[0-9]*\] *[^ ]* *RELA *[0-9a-f]* *0*\([0-9a-f][0-9a-f]*\).* \([0-9a-f][0-9a-f]*\) *[0-9a-f][0-9a-f]*$,\1 \2,p'`
  relas=`echo ${relas}`

  # Build embedded SPU image.
  # 1. The whole SPU ELF file is written to .rodata.speelf
  # 2. Symbols starting with the string "_EAR_" in the SPU ELF image are
  #    special.  They allow an SPU program to access corresponding symbols
  #    (ie. minus the _EAR_ prefix), in the PowerPC program.  _EAR_ without
  #    a suffix is used to refer to the addrress of the SPU image in
  #    PowerPC address space.  _EAR_* symbols must all be defined in .toe
  #    at 16 byte intervals, or they must be defined in other non-bss
  #    sections.
  #    Find all _EAR_ symbols in .toe using readelf, sort by address, and
  #    write the address of the corresponding PowerPC symbol in a table
  #    built in .data.spetoe.  For _EAE_ symbols not in .toe, create
  #    .reloc commands to relocate their location directly.
  # 3. Look for R_SPU_PPU32 and R_SPU_PPU64 relocations in the SPU ELF image
  #    and create .reloc commands for them.
  # 4. Write a struct spe_program_handle to .data.
  # 5. Write a table of _SPUEAR_ symbols.
  ${CC} ${FLAGS} -x assembler-with-cpp -nostartfiles -nostdlib \
	-Wa,-mbig -Wl,-r -Wl,-x -o ${OUTFILE} - <<EOF
 .section .data.spetoe,"aw",@progbits
 .p2align 7
__spetoe__:
`${READELF} -s -W ${INFILE} | grep ' _EAR_' | sort -k 2 | awk \
'BEGIN { \
	addr = strtonum ("0x" "'${toe_addr-0}'"); \
	split ("'"${sections}"'", s, " "); \
	for (i = 1; i in s; i += 3) { \
	    sec_off[s[i]] = strtonum ("0x" s[i+2]) - strtonum ("0x" s[i+1]); \
	} \
} \
$7 == "'${toe}'" && strtonum ("0x" $2) != addr { \
	print "#error Symbol " $8 " not in 16 byte element toe array!"; \
} \
$7 == "'${toe}'" { \
	addr = addr + 16; \
} \
$7 == "'${toe}'" { \
	print "#ifdef _LP64"; \
	print " .quad " ($8 == "_EAR_" ? "__speelf__" : substr($8, 6)) ", 0"; \
	print "#else"; \
	print " .int 0, " ($8 == "_EAR_" ? "__speelf__" : substr($8, 6)) ", 0, 0"; \
	print "#endif"; \
} \
$7 != "'${toe}'" && $7 in sec_off { \
	print "#ifdef _LP64"; \
	print " .reloc __speelf__+" strtonum ("0x" $2) + sec_off[$7] ", R_PPC64_ADDR64, " ($8 == "_EAR_" ? "__speelf__" : substr($8, 6)); \
	print "#else"; \
	print " .reloc __speelf__+" strtonum ("0x" $2) + sec_off[$7] + 4 ", R_PPC_ADDR32, " ($8 == "_EAR_" ? "__speelf__" : substr($8, 6)); \
	print "#endif"; \
	if (!donedef) { print "#define HAS_RELOCS 1"; donedef = 1; }; \
} \
$7 != "'${toe}'" && ! $7 in sec_off { \
	print "#error Section not found for " $8; \
} \
'`
`test -z "${relas}" || ${READELF} -r -W ${INFILE} | awk \
'BEGIN { \
	split ("'"${sections}"'", s, " "); \
	for (i = 1; i in s; i += 3) { \
	    sec_off[s[i]] = strtonum ("0x" s[i+2]) - strtonum ("0x" s[i+1]); \
	} \
	split ("'"${relas}"'", s, " "); \
	for (i = 1; i in s; i += 2) { \
	    rela[s[i]] = strtonum (s[i+1]); \
	} \
} \
/^Relocation section/ { \
	sec = substr($6, 3); \
} \
$3 ~ /R_SPU_PPU/ { \
	print "#ifdef _LP64"; \
	print " .reloc __speelf__+" strtonum ("0x" $1) + sec_off[rela[sec]] ", R_PPC64_ADDR" substr($3, 10) ", " ($5 != "" ? $5 "+0x" $7 : "__speelf__ + 0x" $4); \
	print "#else"; \
	print " .reloc __speelf__+" strtonum ("0x" $1) + sec_off[rela[sec]] + (substr($3, 10) == "64" ? 4 : 0)", R_PPC_ADDR32, " ($5 != "" ? $5 "+0x" $7 : "__speelf__ + 0x" $4); \
	print "#endif"; \
	if (!donedef) { print "#define HAS_RELOCS 1"; donedef = 1; }; \
} \
$3 ~ /unrecognized:/ { \
	print "#ifdef _LP64"; \
	print " .reloc __speelf__+" strtonum ("0x" $1) + sec_off[rela[sec]] ", R_PPC64_ADDR" ($4 == "f" ? "64" : "32") ", " ($6 != "" ? $6 "+0x" $8 : "__speelf__ + 0x" $5); \
	print "#else"; \
	print " .reloc __speelf__+" strtonum ("0x" $1) + sec_off[rela[sec]] + ($4 == "f" ? 4 : 0)", R_PPC_ADDR32, " ($6 != "" ? $6 "+0x" $8 : "__speelf__ + 0x" $5); \
	print "#endif"; \
	if (!donedef) { print "#define HAS_RELOCS 1"; donedef = 1; }; \
} \
'`
#if defined (HAS_RELOCS) && (defined (__PIC__) || defined (__PIE__))
 .section .data.rel.ro.speelf,"a",@progbits
#else
 .section .rodata.speelf,"a",@progbits
#endif
 .p2align 7
__speelf__:
 .incbin "${INFILE}"

 .section .data,"aw",@progbits
 .globl ${SYMBOL}
 .type ${SYMBOL}, @object
# fill in a struct spe_program_handle
#ifdef _LP64
 .p2align 3
${SYMBOL}:
 .int 24
 .int 0
 .quad __speelf__
 .quad __spetoe__
#else
 .p2align 2
${SYMBOL}:
 .int 12
 .int __speelf__
 .int __spetoe__
#endif
 .size ${SYMBOL}, . - ${SYMBOL}

`${READELF} -s -W ${INFILE} | grep ' _SPUEAR_' | sort -k 2 | awk \
'{ \
	print " .globl '${SYMBOL}'_" substr($8, 9); \
	print " .type '${SYMBOL}'_" substr($8, 9) ", @object"; \
	print " .size '${SYMBOL}'_" substr($8, 9) ", 4"; \
	print "'${SYMBOL}'_" substr($8, 9) ":"; \
	print " .int 0x" $2; \
} \
'`
EOF
}

main "$@"
Commit	Line	Data
669a9a2a AM	1	#! /bin/sh
	2	# Embed an SPU ELF executable into a PowerPC object file.
	3	#
41160f02	4	# Copyright 2006, 2007 Free Software Foundation, Inc.
669a9a2a AM	5	#
	6	# This file is part of GNU Binutils.
	7	#
	8	# This program is free software; you can redistribute it and/or modify
	9	# it under the terms of the GNU General Public License as published by
32866df7	10	# the Free Software Foundation; either version 3 of the License, or
669a9a2a AM	11	# (at your option) any later version.
	12	#
	13	# This program is distributed in the hope that it will be useful,
	14	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	# GNU General Public License for more details.
	17	#
	18	# You should have received a copy of the GNU General Public License
	19	# along with this program; if not, write to the Free Software
	20	# Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA
	21	# 02110-1301, USA.
	22
	23	usage ()
	24	{
	25	echo "Usage: embedspu [flags] symbol_name input_filename output_filename"
	26	echo
	27	echo " input_filename: SPU ELF executable to be embedded"
	28	echo " output_filename: Resulting PowerPC object file"
	29	echo " symbol_name: Name of program handle struct to be defined"
	30	echo " flags: GCC flags defining PowerPC object file format"
	31	echo " (e.g. -m32 or -m64)"
	32	exit 1
	33	}
	34
	35	program_transform_name=
	36	mydir=`dirname "$0"`
	37
	38	find_prog ()
	39	{
	40	prog=`echo $1 \| sed "$program_transform_name"`
669a9a2a AM	41	prog="$mydir/$prog"
	42	test -x "$prog" && return 0
	43	prog="$mydir/$1"
	44	test -x "$prog" && return 0
	45	prog=`echo $1 \| sed "$program_transform_name"`
ece5ef60	46	which $prog > /dev/null 2> /dev/null && return 0
669a9a2a AM	47	return 1
	48	}
	49
	50	SYMBOL=
	51	INFILE=
	52	OUTFILE=
	53	FLAGS=
	54
	55	parse_args ()
	56	{
	57	while test -n "$1"; do
	58	case "$1" in
	59	-*) FLAGS="${FLAGS} $1" ;;
	60	*) if test -z "$SYMBOL"; then
	61	SYMBOL="$1"
	62	elif test -z "$INFILE"; then
	63	INFILE="$1"
	64	elif test -z "$OUTFILE"; then
	65	OUTFILE="$1"
	66	else
	67	echo "Too many arguments!"
	68	usage
	69	fi ;;
	70	esac
	71	shift
	72	done
	73	if test -z "$OUTFILE"; then
	74	usage
	75	fi
	76	if test ! -r "$INFILE"; then
	77	echo "${INFILE}: File not found"
	78	usage
	79	fi
	80	}
	81
	82	main ()
	83	{
	84	parse_args "$@"
	85
	86	# Find a powerpc gcc. Support running from a combined tree build.
	87	if test -x "$mydir/../gcc/xgcc"; then
	88	CC="$mydir/../gcc/xgcc -B$mydir/../gcc/"
	89	else
	90	find_prog gcc
	91	if test $? -ne 0; then
	92	echo "Cannot find $prog"
	93	exit 1
	94	fi
	95	CC="$prog"
	96	fi
	97
ece5ef60	98	# Find readelf. Any old readelf should do.
669a9a2a AM	99	find_prog readelf
	100	if test $? -ne 0; then
	101	if which readelf > /dev/null 2> /dev/null; then
	102	prog=readelf
	103	else
	104	echo "Cannot find $prog"
	105	exit 1
	106	fi
	107	fi
	108	READELF="$prog"
	109
	110	# Sanity check the input file
	111	if ! ${READELF} -h ${INFILE} \| grep 'Class:.*ELF32' >/dev/null 2>/dev/null \
	112	\|\| ! ${READELF} -h ${INFILE} \| grep 'Type:.*EXEC' >/dev/null 2>/dev/null \
	113	\|\| ! ${READELF} -h ${INFILE} \| egrep 'Machine:.*(SPU\|17)' >/dev/null 2>/dev/null
	114	then
	115	echo "${INFILE}: Does not appear to be an SPU executable"
	116	exit 1
	117	fi
	118
88948ad0 AM	119	toe=`${READELF} -S ${INFILE} \| sed -n -e 's, \[ \([0-9]\)\] \.toe [PROGN]BITS \([0-9a-f]\).*,\1 \2,p'`
	120	toe_addr=`echo $toe \| sed -n -e 's,.* ,,p'`
	121	toe=`echo $toe \| sed -n -e 's, .*,,p'`
ece5ef60	122	# For loaded sections, pick off section number, address, and file offset
88948ad0 AM	123	sections=`${READELF} -S ${INFILE} \| sed -n -e 's, \[ \([0-9]\)\] [^ ]* PROGBITS \([0-9a-f]\) \([0-9a-f]\).,\1 \2 \3,p'`
88948ad0 AM	124	sections=`echo ${sections}`
ece5ef60 AM	125	# For relocation sections, pick off file offset and info (points to
ece5ef60 AM	126	# section where relocs apply)
daaf07b2	127	relas=`${READELF} -S ${INFILE} \| sed -n -e 's, \[ [0-9]\] [^ ]* RELA [0-9a-f]* 0\([0-9a-f][0-9a-f]\). \([0-9a-f][0-9a-f]\) [0-9a-f][0-9a-f]*$,\1 \2,p'`
ece5ef60	128	relas=`echo ${relas}`
88948ad0	129
669a9a2a AM	130	# Build embedded SPU image.
	131	# 1. The whole SPU ELF file is written to .rodata.speelf
	132	# 2. Symbols starting with the string "_EAR_" in the SPU ELF image are
	133	# special. They allow an SPU program to access corresponding symbols
	134	# (ie. minus the _EAR_ prefix), in the PowerPC program. _EAR_ without
	135	# a suffix is used to refer to the addrress of the SPU image in
88948ad0 AM	136	# PowerPC address space. _EAR_* symbols must all be defined in .toe
	137	# at 16 byte intervals, or they must be defined in other non-bss
	138	# sections.
	139	# Find all _EAR_ symbols in .toe using readelf, sort by address, and
	140	# write the address of the corresponding PowerPC symbol in a table
	141	# built in .data.spetoe. For _EAE_ symbols not in .toe, create
	142	# .reloc commands to relocate their location directly.
ece5ef60 AM	143	# 3. Look for R_SPU_PPU32 and R_SPU_PPU64 relocations in the SPU ELF image
	144	# and create .reloc commands for them.
	145	# 4. Write a struct spe_program_handle to .data.
	146	# 5. Write a table of _SPUEAR_ symbols.
669a9a2a AM	147	${CC} ${FLAGS} -x assembler-with-cpp -nostartfiles -nostdlib \
669a9a2a AM	148	-Wa,-mbig -Wl,-r -Wl,-x -o ${OUTFILE} - <<EOF
669a9a2a AM	149	.section .data.spetoe,"aw",@progbits
	150	.p2align 7
	151	__spetoe__:
41160f02	152	`${READELF} -s -W ${INFILE} \| grep ' _EAR_' \| sort -k 2 \| awk \
669a9a2a	153	'BEGIN { \
48d8dc64	154	addr = strtonum ("0x" "'${toe_addr-0}'"); \
88948ad0 AM	155	split ("'"${sections}"'", s, " "); \
	156	for (i = 1; i in s; i += 3) { \
	157	sec_off[s[i]] = strtonum ("0x" s[i+2]) - strtonum ("0x" s[i+1]); \
	158	} \
669a9a2a	159	} \
88948ad0 AM	160	$7 == "'${toe}'" && strtonum ("0x" $2) != addr { \
88948ad0 AM	161	print "#error Symbol " $8 " not in 16 byte element toe array!"; \
669a9a2a	162	} \
88948ad0 AM	163	$7 == "'${toe}'" { \
88948ad0 AM	164	addr = addr + 16; \
669a9a2a	165	} \
88948ad0	166	$7 == "'${toe}'" { \
669a9a2a	167	print "#ifdef _LP64"; \
88948ad0	168	print " .quad " ($8 == "_EAR_" ? "__speelf__" : substr($8, 6)) ", 0"; \
669a9a2a	169	print "#else"; \
88948ad0	170	print " .int 0, " ($8 == "_EAR_" ? "__speelf__" : substr($8, 6)) ", 0, 0"; \
669a9a2a AM	171	print "#endif"; \
669a9a2a AM	172	} \
88948ad0	173	$7 != "'${toe}'" && $7 in sec_off { \
669a9a2a	174	print "#ifdef _LP64"; \
88948ad0	175	print " .reloc __speelf__+" strtonum ("0x" $2) + sec_off[$7] ", R_PPC64_ADDR64, " ($8 == "_EAR_" ? "__speelf__" : substr($8, 6)); \
669a9a2a	176	print "#else"; \
88948ad0	177	print " .reloc __speelf__+" strtonum ("0x" $2) + sec_off[$7] + 4 ", R_PPC_ADDR32, " ($8 == "_EAR_" ? "__speelf__" : substr($8, 6)); \
669a9a2a	178	print "#endif"; \
3ba20bde	179	if (!donedef) { print "#define HAS_RELOCS 1"; donedef = 1; }; \
88948ad0 AM	180	} \
	181	$7 != "'${toe}'" && ! $7 in sec_off { \
	182	print "#error Section not found for " $8; \
	183	} \
ece5ef60 AM	184	'`
	185	`test -z "${relas}" \|\| ${READELF} -r -W ${INFILE} \| awk \
	186	'BEGIN { \
	187	split ("'"${sections}"'", s, " "); \
	188	for (i = 1; i in s; i += 3) { \
	189	sec_off[s[i]] = strtonum ("0x" s[i+2]) - strtonum ("0x" s[i+1]); \
	190	} \
	191	split ("'"${relas}"'", s, " "); \
	192	for (i = 1; i in s; i += 2) { \
	193	rela[s[i]] = strtonum (s[i+1]); \
	194	} \
	195	} \
	196	/^Relocation section/ { \
	197	sec = substr($6, 3); \
	198	} \
	199	$3 ~ /R_SPU_PPU/ { \
	200	print "#ifdef _LP64"; \
73545089	201	print " .reloc __speelf__+" strtonum ("0x" $1) + sec_off[rela[sec]] ", R_PPC64_ADDR" substr($3, 10) ", " ($5 != "" ? $5 "+0x" $7 : "__speelf__ + 0x" $4); \
ece5ef60	202	print "#else"; \
73545089	203	print " .reloc __speelf__+" strtonum ("0x" $1) + sec_off[rela[sec]] + (substr($3, 10) == "64" ? 4 : 0)", R_PPC_ADDR32, " ($5 != "" ? $5 "+0x" $7 : "__speelf__ + 0x" $4); \
ece5ef60	204	print "#endif"; \
3ba20bde	205	if (!donedef) { print "#define HAS_RELOCS 1"; donedef = 1; }; \
ece5ef60 AM	206	} \
	207	$3 ~ /unrecognized:/ { \
	208	print "#ifdef _LP64"; \
73545089	209	print " .reloc __speelf__+" strtonum ("0x" $1) + sec_off[rela[sec]] ", R_PPC64_ADDR" ($4 == "f" ? "64" : "32") ", " ($6 != "" ? $6 "+0x" $8 : "__speelf__ + 0x" $5); \
ece5ef60	210	print "#else"; \
73545089	211	print " .reloc __speelf__+" strtonum ("0x" $1) + sec_off[rela[sec]] + ($4 == "f" ? 4 : 0)", R_PPC_ADDR32, " ($6 != "" ? $6 "+0x" $8 : "__speelf__ + 0x" $5); \
ece5ef60	212	print "#endif"; \
3ba20bde	213	if (!donedef) { print "#define HAS_RELOCS 1"; donedef = 1; }; \
ece5ef60	214	} \
88948ad0	215	'`
3ba20bde AM	216	#if defined (HAS_RELOCS) && (defined (__PIC__) \|\| defined (__PIE__))
	217	.section .data.rel.ro.speelf,"a",@progbits
	218	#else
	219	.section .rodata.speelf,"a",@progbits
	220	#endif
	221	.p2align 7
	222	__speelf__:
	223	.incbin "${INFILE}"
669a9a2a AM	224
	225	.section .data,"aw",@progbits
	226	.globl ${SYMBOL}
11d5fa89	227	.type ${SYMBOL}, @object
669a9a2a AM	228	# fill in a struct spe_program_handle
	229	#ifdef _LP64
	230	.p2align 3
	231	${SYMBOL}:
	232	.int 24
	233	.int 0
	234	.quad __speelf__
	235	.quad __spetoe__
	236	#else
	237	.p2align 2
	238	${SYMBOL}:
	239	.int 12
	240	.int __speelf__
	241	.int __spetoe__
	242	#endif
11d5fa89	243	.size ${SYMBOL}, . - ${SYMBOL}
88948ad0 AM	244
	245	`${READELF} -s -W ${INFILE} \| grep ' _SPUEAR_' \| sort -k 2 \| awk \
	246	'{ \
	247	print " .globl '${SYMBOL}'_" substr($8, 9); \
	248	print " .type '${SYMBOL}'_" substr($8, 9) ", @object"; \
	249	print " .size '${SYMBOL}'_" substr($8, 9) ", 4"; \
	250	print "'${SYMBOL}'_" substr($8, 9) ":"; \
dbdca70b	251	print " .int 0x" $2; \
88948ad0 AM	252	} \
88948ad0 AM	253	'`
669a9a2a AM	254	EOF
	255	}
	256
	257	main "$@"