Add macOS relocation

LC_ID_DYLIB, LC_RPATH and LC_LOAD_DYLIB relocation ruels are added for macOS
to the relocation script. By default relocate under bin, lib and lib64: override
with `relocate_paths` in the recipe.

Author: Dario Berzano

alibuild_helpers/build.py

@@ -492,6 +492,8 @@ def doBuild(args, parser):
       spec["incremental_hash"] = ih.hexdigest()
     elif p in develPkgs:
       h(spec.get("devel_hash"))
+    if args.architecture.startswith("osx") and "relocate_paths" in spec:
+        h("relocate:"+" ".join(sorted(spec["relocate_paths"])))
     spec["hash"] = h.hexdigest()
     spec["deps_hash"] = dh.hexdigest()
     debug("Hash for recipe %s is %s" % (p, spec["hash"]))
@@ -910,6 +912,7 @@ def doBuild(args, parser):
       ("PKGNAME", spec["package"]),
       ("PKGREVISION", spec["revision"]),
       ("PKGVERSION", spec["version"]),
+      ("RELOCATE_PATHS", " ".join(spec.get("relocate_paths", []))),
       ("REQUIRES", " ".join(spec["requires"])),
       ("RUNTIME_REQUIRES", " ".join(spec["runtime_requires"])),
       ("WRITE_REPO", spec.get("write_repo", source)),

alibuild_helpers/build_template.sh

@@ -168,6 +168,51 @@ cat "$INSTALLROOT/.original-unrelocated" | xargs -n1 -I{} echo "sed -e \"s|/[^ ]
 if [[ ! -s "$INSTALLROOT/.original-unrelocated" && -f "$INSTALLROOT/etc/modulefiles/$PKGNAME" ]]; then
   echo "mv -f \$PP/etc/modulefiles/$PKGNAME \$PP/etc/modulefiles/${PKGNAME}.forced-relocation && sed -e \"s|[@][@]PKGREVISION[@]\$PH[@][@]|$PKGREVISION|g\" \$PP/etc/modulefiles/${PKGNAME}.forced-relocation > \$PP/etc/modulefiles/$PKGNAME" >> "$INSTALLROOT/relocate-me.sh"
 fi
+
+# Find libraries and executables needing relocation on macOS
+if [[ ${ARCHITECTURE:0:3} == "osx" ]]; then
+
+  /usr/bin/find ${RELOCATE_PATHS:-bin lib lib64} -type f | \
+  while read BIN; do
+    MACHOTYPE=$(set +o pipefail; otool -h "$PWD/$BIN" 2> /dev/null | grep filetype -A1 | tail -n1 | awk '{print $5}')
+
+    # See mach-o/loader.h from XNU sources: 2 == executable, 6 == dylib
+    if [[ $MACHOTYPE == 6 ]]; then
+      # Only dylibs: relocate LC_ID_DYLIB
+      if otool -D "$PWD/$BIN" 2> /dev/null | tail -n1 | grep -q $PKGHASH; then
+        cat <<EOF >> "$INSTALLROOT/relocate-me.sh"
+install_name_tool -id \$(otool -D "\$PP/$BIN" | tail -n1 | sed -e "s|/[^ ]*INSTALLROOT/\$PH/\$OP|\$WORK_DIR/\$PP|g") "\$PP/$BIN"
+EOF
+      fi
+    fi
+
+    if [[ $MACHOTYPE == 2 || $MACHOTYPE == 6 ]]; then
+      # Both libs and binaries: relocate LC_RPATH
+      if otool -l "$PWD/$BIN" 2> /dev/null | grep -A2 LC_RPATH | grep path | grep -q $PKGHASH; then
+        cat <<EOF >> "$INSTALLROOT/relocate-me.sh"
+OLD_RPATHS=\$(otool -l \$PP/$BIN | grep -A2 LC_RPATH | grep path | grep \$PH | sed -e 's|^.*path ||' -e 's| .*$||')
+for OLD_RPATH in \$OLD_RPATHS; do
+  NEW_RPATH=\${OLD_RPATH/#*INSTALLROOT\/\$PH\/\$OP/\$WORK_DIR/\$PP}
+  install_name_tool -rpath "\$OLD_RPATH" "\$NEW_RPATH" "\$PP/$BIN"
+done
+EOF
+      fi
+
+      # Both libs and binaries: relocate LC_LOAD_DYLIB
+      if otool -l "$PWD/$BIN" 2> /dev/null | grep -A2 LC_LOAD_DYLIB | grep name | grep -q $PKGHASH; then
+        cat <<EOF >> "$INSTALLROOT/relocate-me.sh"
+OLD_LOAD_DYLIBS=\$(otool -l \$PP/$BIN | grep -A2 LC_LOAD_DYLIB | grep name | grep \$PH | sed -e 's|^.*name ||' -e 's| .*$||')
+for OLD_LOAD_DYLIB in \$OLD_LOAD_DYLIBS; do
+  NEW_LOAD_DYLIB=\${OLD_LOAD_DYLIB/#*INSTALLROOT\/\$PH\/\$OP/\$WORK_DIR/\$PP}
+  install_name_tool -change "\$OLD_LOAD_DYLIB" "\$NEW_LOAD_DYLIB" "\$PP/$BIN"
+done
+EOF
+      fi
+    fi
+done || true
+
+fi
+
 cat "$INSTALLROOT/relocate-me.sh"
 cat "$INSTALLROOT/.original-unrelocated" | xargs -n1 -I{} cp '{}' '{}'.unrelocated
 cd "$WORK_DIR/INSTALLROOT/$PKGHASH"

docs/reference.markdown

@@ -30,7 +30,7 @@ An example recipe for `zlib` is the following:
     source: https://github.com/star-externals/zlib
     tag: v1.2.8
     ---
-    #!/bin/sh
+    #!/bin/bash -ex
     ./configure --prefix=$INSTALLROOT
     make ${JOBS+-j $JOBS}
     make install
@@ -88,7 +88,7 @@ The following entries are optional in the header:
   - `append_path`: same as `prepend_path` but paths are appended rather than
     prepended.
   - `requires`: a list of run-time and build-time dependency for the package. E.g.:
-    
+
         package: AliRoot
         requires:
           - ROOT
@@ -99,7 +99,7 @@ The following entries are optional in the header:
     the dependency name. Such a reqular expression will be matched against the
     architecture provided via `--architecture` and if it does not match it will
     not be included. For instance:
-    
+
         package: AliRoot-test
         requires:
           - "igprof:(?!osx).*"
@@ -127,6 +127,9 @@ The following entries are optional in the header:
     does not match, the check is skipped and the recipe is run. Using the switch
     `--always-prefer-system` runs the check always (even when the regular
     expression for the architecture does not match).
+  - `relocate_paths`: a list of toplevel paths scanned recursively to perform
+    relocation of executables and dynamic libraries **on macOS only**. If not
+    specified defaults to `bin`, `lib` and `lib64`.
 
 ### The body