install-reloc: Support multi-binary installation.
[gnulib.git] / build-aux / install-reloc
1 #!/bin/sh
2 # install-reloc - install a program including a relocating wrapper
3 # Copyright (C) 2003-2013 Free Software Foundation, Inc.
4 # Written by Bruno Haible <bruno@clisp.org>, 2003.
5 #
6 # This program is free software: you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 3 of the License, or
9 # (at your option) any later version.
10 #
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 # GNU General Public License for more details.
15 #
16 # You should have received a copy of the GNU General Public License
17 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
18
19 # Usage 1:
20 #   install-reloc -- library_path_var library_path_value prefix destdir \
21 #                    compile_command srcdir builddir config_h_dir exeext \
22 #                    strip_command \
23 #                    install_command... destprog
24 # where
25 #   - library_path_var is the platform dependent runtime library path variable
26 #   - library_path_value is a colon separated list of directories that contain
27 #     the libraries at installation time (use this instead of -rpath)
28 #   - prefix is the base directory at installation time
29 #   - destdir is a string that is prepended to all file names at installation
30 #     time; it is already prepended to destprog but not to library_path_value
31 #     and prefix
32 #   - compile_command is a C compiler compilation and linking command
33 #   - srcdir is the directory where to find relocwrapper.c and its dependencies
34 #   - builddir is the directory where to find built dependencies (namely,
35 #     alloca.h and stdbool.h)
36 #   - config_h_dir is the directory where to find config.h
37 #   - exeext is platform dependent suffix of executables
38 #   - strip_command is the command for stripping executables, or : if no
39 #     stripping is desired
40 #   - install_command is the install command line, excluding the final destprog
41 #   - destprog is the destination program name
42 # Usage 2:
43 #   env RELOC_LIBRARY_PATH_VAR=library_path_var \
44 #       RELOC_LIBRARY_PATH_VALUE=library_path_value \
45 #       RELOC_PREFIX=prefix \
46 #       RELOC_DESTDIR=destdir \
47 #       RELOC_COMPILE_COMMAND=compile_command \
48 #       RELOC_SRCDIR=srcdir \
49 #       RELOC_BUILDDIR=builddir \
50 #       RELOC_CONFIG_H_DIR=config_h_dir \
51 #       RELOC_EXEEXT=exeext \
52 #       RELOC_STRIP_PROG=strip_command \
53 #       RELOC_INSTALL_PROG=install_command... \
54 #   install-reloc prog1 ... destprog
55 #   where destprog is either the destination program name (when only one program
56 #   is specified) or the destination directory for all programs.
57 # install-reloc renames destprog to destprog.bin and installs a relocating
58 # wrapper in the place of destprog.
59
60 progname=$0
61
62 if test $# -ge 12 && test "x$1" = "x--"; then
63   # Get fixed position arguments.
64   shift
65   library_path_var=$1
66   library_path_value=$2
67   prefix=$3
68   destdir=$4
69   shift
70   shift
71   shift
72   shift
73   compile_command=$1
74   srcdir=$2
75   builddir=$3
76   config_h_dir=$4
77   exeext=$5
78   shift
79   shift
80   shift
81   shift
82   shift
83   strip_prog=$1
84   shift
85   install_prog=$1 # maybe not including the "-c" option
86   shift
87 else
88   if test $# -ge 2; then
89     # Get arguments from environment variables.
90     library_path_var=$RELOC_LIBRARY_PATH_VAR
91     library_path_value=$RELOC_LIBRARY_PATH_VALUE
92     prefix=$RELOC_PREFIX
93     destdir=$RELOC_DESTDIR
94     compile_command=$RELOC_COMPILE_COMMAND
95     srcdir=$RELOC_SRCDIR
96     builddir=$RELOC_BUILDDIR
97     config_h_dir=$RELOC_CONFIG_H_DIR
98     exeext=$RELOC_EXEEXT
99     strip_prog=$RELOC_STRIP_PROG
100     install_prog=$RELOC_INSTALL_PROG # including the "-c" option
101   else
102     echo "Usage: $0 -- library_path_var library_path_value prefix destdir" \
103          "compile_command srcdir builddir config_h_dir exeext" \
104          "strip_command" \
105          "install_command... destprog" 1>&2
106     exit 1
107   fi
108 fi
109
110 # Get destprog, last argument.
111 destprog=
112 for arg
113 do
114   destprog=$arg
115 done
116 # Determine whether destprog is a program name or a directory name.
117 if test -d "$destprog"; then
118   sed_remove_trailing_slashes='s|//*$||'
119   destprog_directory=`echo "$destprog" | sed -e "$sed_remove_trailing_slashes"`
120   if test -z "$destprog_directory"; then
121     destprog_directory='/'
122   fi
123 else
124   destprog_directory=
125 fi
126 # Prepare for remove trailing $exeext, if present.
127 if test -n "$exeext"; then
128   sed_quote='s,\.,\\.,g'
129   sed_remove_exeext='s|'`echo "$exeext" | sed -e "$sed_quote"`'$||'
130 fi
131 if test -z "$destprog_directory"; then
132   # Remove trailing $exeext, if present.
133   if test -n "$exeext"; then
134     destprog=`echo "$destprog" | sed -e "$sed_remove_exeext"`
135   fi
136 fi
137
138 # Outputs a command and runs it.
139 func_verbose ()
140 {
141   echo "$@"
142   "$@"
143 }
144
145 # Run install_command.
146 func_verbose $install_prog "$@" || exit $?
147
148 # Iterate over all destination program names.
149 # func_iterate f
150 # applies f to each destination program names, after setting destprog.
151 sed_basename_of_file='s|^.*/||'
152 func_iterate ()
153 {
154   if test -n "$destprog_directory"; then
155     prev_arg=
156     for arg
157     do
158       if test -n "prev_arg"; then
159         destprog="$destprog_directory"/`echo "$prev_arg" | sed -e "$sed_basename_of_file"`
160         $1
161       fi
162       prev_arg="$arg"
163     done
164   else
165     $1
166   fi
167 }
168
169 # Run strip_command.
170 func_strip ()
171 {
172   # Remove trailing $exeext, if present.
173   if test -n "$exeext"; then
174     destprog=`echo "$destprog" | sed -e "$sed_remove_exeext"`
175   fi
176   func_verbose "$strip_prog" "$destprog$exeext" || exit $?
177 }
178 if test "$strip_prog" != ':'; then
179   func_iterate func_strip
180 fi
181
182 # If the platform doesn't support LD_LIBRARY_PATH or similar, we cannot build
183 # a wrapper.
184 test -n "$library_path_var" || exit 0
185
186 libdirs=
187 save_IFS="$IFS"; IFS=":"
188 for dir in $library_path_value; do
189   IFS="$save_IFS"
190   if test -n "$dir"; then
191     case "$libdirs" in
192       *"\"$dir\""*) ;; # remove duplicate
193       *) libdirs="$libdirs\"$dir\"," ;;
194     esac
195   fi
196 done
197 IFS="$save_IFS"
198 # If there are no library directories to add at runtime, we don't need a
199 # wrapper.
200 test -n "$libdirs" || exit 0
201
202 # Determine installdir from destprog, removing a leading destdir if present.
203 if test -n "$destprog_directory"; then
204   installdir="$destprog_directory"
205 else
206   installdir=`echo "$destprog" | sed -e 's,/[^/]*$,,'`
207 fi
208 if test -n "$destdir"; then
209   sed_quote='s,\([|.\*^$[]\),\\\1,g'
210   sed_remove_destdir='s|^'`echo "$destdir" | sed -e "$sed_quote"`'||'
211   installdir=`echo "$installdir" | sed -e "$sed_remove_destdir"`
212 fi
213
214 # Compile and install wrapper.
215 func_create_wrapper ()
216 {
217   # Remove trailing $exeext, if present.
218   if test -n "$exeext"; then
219     destprog=`echo "$destprog" | sed -e "$sed_remove_exeext"`
220   fi
221
222   # Compile wrapper.
223   func_verbose $compile_command \
224                -I"$builddir" -I"$srcdir" -I"$config_h_dir" \
225                -DHAVE_CONFIG_H -DIN_RELOCWRAPPER -DNO_XMALLOC \
226                -D"INSTALLPREFIX=\"$prefix\"" -D"INSTALLDIR=\"$installdir\"" \
227                -D"LIBPATHVAR=\"$library_path_var\"" -D"LIBDIRS=$libdirs" \
228                -D"EXEEXT=\"$exeext\"" \
229                "$srcdir"/relocwrapper.c \
230                "$srcdir"/progname.c \
231                "$srcdir"/progreloc.c \
232                "$srcdir"/areadlink.c \
233                "$srcdir"/careadlinkat.c \
234                "$srcdir"/allocator.c \
235                "$srcdir"/readlink.c \
236                "$srcdir"/canonicalize-lgpl.c \
237                "$srcdir"/malloca.c \
238                "$srcdir"/relocatable.c \
239                "$srcdir"/setenv.c \
240                "$srcdir"/strerror.c \
241                "$srcdir"/c-ctype.c \
242                -o "$destprog.wrapper$exeext"
243   rc=$?
244   # Clean up object files left over in the current directory by the native C
245   # compilers on Solaris, HP-UX, OSF/1, IRIX.
246   rm -f relocwrapper.o \
247         progname.o \
248         progreloc.o \
249         areadlink.o \
250         careadlinkat.o \
251         allocator.o \
252         readlink.o \
253         canonicalize-lgpl.o \
254         malloca.o \
255         relocatable.o \
256         setenv.o \
257         strerror.o \
258         c-ctype.o
259   test $rc = 0 || exit $?
260   # Clean up debugging information left over by the native C compiler on MacOS X.
261   rm -rf "$destprog.wrapper$exeext.dSYM"
262   test $rc = 0 || exit $?
263
264   # Strip wrapper.
265   test "$strip_prog" = ':' || func_verbose "$strip_prog" "$destprog.wrapper$exeext" || exit $?
266
267   # Rename $destprog.wrapper -> $destprog -> $destprog.bin.
268   ln -f "$destprog$exeext" "$destprog.bin$exeext" \
269     || { rm -f "$destprog.bin$exeext" \
270          && cp -p "$destprog$exeext" "$destprog.bin$exeext"; } \
271     || exit 1
272   mv "$destprog.wrapper$exeext" "$destprog$exeext" || exit 1
273 }
274 func_iterate func_create_wrapper
275
276 exit 0