chrome/tools/build/mac/dump_product_syms

   1 #!/bin/bash
   2
   3 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
   4 # Use of this source code is governed by a BSD-style license that can be
   5 # found in the LICENSE file.
   6
   7 # This script expects the following environment variables to be set.  Xcode
   8 # normally sets them:
   9 #
  10 # CONFIGURATION - Release or Debug; this script only operates when Release.
  11 # SRCROOT - /path/to/chrome/src/chrome
  12 # BUILT_PRODUTS_DIR - /path/to/chrome/src/xcodebuild/Release
  13 #
  14 # The script also takes a single argument defining the branding type.
  15 #
  16 # To test this script without running an entire build:
  17 #
  18 # cd /path/to/chrome/src/chrome
  19 # CONFIGURATION=Release \
  20 #     SRCROOT=$(pwd) \
  21 #     BUILT_PRODUCTS_DIR=$(pwd)/../xcodebuild/Release \
  22 #     tools/build/mac/dump_app_syms Chromium
  23
  24 # Make sure we got the header to write into passed to us
  25 if [ $# -ne 1 ]; then
  26   echo "error: missing branding as an argument" >&2
  27   exit 1
  28 fi
  29
  30 set -ex
  31
  32 # Skip out if we're aren't in Release mode, no need for dump_syms on debug runs.
  33 if [ "${CONFIGURATION}" != "Release" ] ; then
  34   exit 0
  35 fi
  36
  37 TOP="${SRCROOT}/.."
  38 BUILD_BRANDING=$1
  39
  40 BRAND_SCRIPT="${TOP}/build/branding_value.sh"
  41 SRC_APP_NAME=$("${BRAND_SCRIPT}" "${BUILD_BRANDING}" PRODUCT_FULLNAME)
  42 . "${TOP}/chrome/VERSION"
  43
  44 BREAKPAD_DUMP_SYMS="${BUILT_PRODUCTS_DIR}/dump_syms"
  45 FULL_VERSION="${MAJOR}.${MINOR}.${BUILD}.${PATCH}"
  46
  47 DSYM_TAR_PATH="${BUILT_PRODUCTS_DIR}/${SRC_APP_NAME}.dSYM.tar.bz2"
  48
  49 # Starting with an already-dumped symbol file at ${original_sym_path},
  50 # transforms the MODULE line (which must be the first line) from referring to
  51 # ${original_stem} to refer to ${variant_stem}. The transformed symbol file
  52 # is written to a symbol file at the same location that a symbol file would
  53 # be written to if ${variant_name} were in the SRC_NAMES array below.
  54 #
  55 # If the transformed symbol file already appears more recent than
  56 # ${original_sym_path}, it is left alone.
  57 redump_syms_variant() {
  58   local original_sym_path="${1}"
  59   local original_stem="${2}"
  60   local variant_stem="${3}"
  61   local variant_name="${4}"
  62   local arch="${5}"
  63
  64   local variant_sym_name="${variant_name}-${FULL_VERSION}-${arch}.breakpad"
  65   local variant_sym_path="${BUILT_PRODUCTS_DIR}/${variant_sym_name}"
  66
  67   if [[ "${original_sym_path}" -nt "${variant_sym_path}" ]]; then
  68     local pattern="\
  69 1s/^(MODULE [^ ]+ [^ ]+ [0-9a-fA-F]{33}) ${original_stem}\$/\1 ${variant_stem}/"
  70     sed -E -e "${pattern}" < "${original_sym_path}" > "${variant_sym_path}"
  71   fi
  72 }
  73
  74 declare -a DSYMS
  75
  76 # Everything in SRC_NAMES is required. It's an error for any of these files
  77 # to be missing.
  78 SRC_NAMES=(
  79     "${SRC_APP_NAME}.app"
  80     "${SRC_APP_NAME} Framework.framework"
  81     "${SRC_APP_NAME} Helper.app"
  82     "crashpad_handler"
  83     "exif.so"
  84 )
  85
  86 # PDF.plugin is optional. Only include it if present.
  87 if [[ -e "${BUILT_PRODUCTS_DIR}/PDF.plugin" ]]; then
  88   SRC_NAMES[${#SRC_NAMES[@]}]="PDF.plugin"
  89 fi
  90
  91 # libpeerconnection.so is optional. Only include it if present.
  92 if [[ -e "${BUILT_PRODUCTS_DIR}/libpeerconnection.so" ]]; then
  93   SRC_NAMES[${#SRC_NAMES[@]}]="libpeerconnection.so"
  94 fi
  95
  96 for SRC_NAME in "${SRC_NAMES[@]}"; do
  97   # SRC_STEM is the name of the file within the DWARF directory of the .dSYM
  98   # bundle, which comes from the on-disk name of an executable or dylib within
  99   # its enclosing .app, .framework or .plugin bundle.  This is the bundle name
 100   # without .app, .framework or .plugin appended.  For non-bundled types, the
 101   # stem is just the name of the singular file on disk.
 102   SRC_STEM=$(echo "${SRC_NAME}" | sed -Ee 's/\.(app|framework|plugin)$//')
 103   DSYM_NAME="${SRC_NAME}.dSYM"
 104   DSYM_PATH="${BUILT_PRODUCTS_DIR}/${DSYM_NAME}"
 105   DWARF_PATH="${DSYM_PATH}/Contents/Resources/DWARF/${SRC_STEM}"
 106
 107   # SRC_PATH is the path to the Mach-O file to which the DSYM_PATH corresponds.
 108   # If this is a directory, it is a bundle, and the path to the actual image
 109   # needs to be computed for dump_syms.
 110   SRC_PREFIX="${BUILT_PRODUCTS_DIR}/${SRC_NAME}"
 111   SRC_PATH=""
 112   if [[ -d "${SRC_PREFIX}" ]]; then
 113     BUNDLED_OPTIONS=(
 114         # Executables and plugins:
 115         "${SRC_PREFIX}/Contents/MacOS/${SRC_STEM}"
 116         # Frameworks:
 117         "${SRC_PREFIX}/Versions/Current/${SRC_STEM}"
 118     )
 119     for BUNDLED_OPTION in "${BUNDLED_OPTIONS[@]}"; do
 120       if [[ -fx "${BUNDLED_OPTION}" ]]; then
 121         SRC_PATH="${BUNDLED_OPTION}"
 122         break
 123       fi
 124     done
 125
 126     if [[ -z "${SRC_PATH}" ]]; then
 127       echo "${0}: Could not find bundled Mach-O file for ${SRC_NAME}"
 128       exit 1
 129     fi
 130   else
 131     # The Mach-O file is not a bundle.
 132     SRC_PATH="${SRC_PREFIX}"
 133   fi
 134
 135   ARCHS=$(file "${DWARF_PATH}" | sed -Ene 's/^.*(i386|x86_64)$/\1/p')
 136   if [[ -z "${ARCHS}" ]]; then
 137     echo "${0}: expected something dumpable in ${DWARF_PATH}" >& 2
 138     exit 1
 139   fi
 140
 141   for ARCH in ${ARCHS}; do
 142     BPAD_SYM_NAME="${SRC_NAME}-${FULL_VERSION}-${ARCH}.breakpad"
 143     BPAD_SYM_PATH="${BUILT_PRODUCTS_DIR}/${BPAD_SYM_NAME}"
 144
 145     # Only run dump_syms if the file has changed since the last dump. Use -g
 146     # to dump data from the dSYM and CFI data from the Mach-O library or
 147     # executable.
 148     if [ "${DWARF_PATH}" -nt "${BPAD_SYM_PATH}" -o \
 149          "${SRC_PATH}" -nt "${BPAD_SYM_PATH}" ] ; then
 150       "${BREAKPAD_DUMP_SYMS}" -a "${ARCH}" -g "${DWARF_PATH}" "${SRC_PATH}" > \
 151           "${BPAD_SYM_PATH}"
 152     fi
 153
 154     # Some executables will show up with variant names. The Breakpad symbol
 155     # server looks up modules based on a combination of the module name and
 156     # identifier (UUID). Produce symbol files for these variant names so that
 157     # the Breakpad symbol server will have something to return for stacks that
 158     # travel through these modules.
 159     case "${SRC_NAME}" in
 160       "${SRC_APP_NAME}.app")
 161         # Google Chrome Canary is produced during packaging.
 162         redump_syms_variant "${BPAD_SYM_PATH}" "${SRC_STEM}" \
 163                             "${SRC_STEM} Canary" "${SRC_STEM} Canary.app" \
 164                             "${ARCH}"
 165         ;;
 166     esac
 167   done
 168
 169   # Remove the .dSYM archive if the file has changed since the archive was
 170   # last generated.  This will cause a new .dSYM archive to be created.
 171   if [ "${DWARF_PATH}" -nt "${DSYM_TAR_PATH}" ] ; then
 172     rm -f "${DSYM_TAR_PATH}"
 173   fi
 174
 175   # Push the .dSYM bundle onto the DSYMS array so that it will be included in
 176   # the .dSYM archive if a new one is needed
 177   DSYMS[${#DSYMS[@]}]="${DSYM_NAME}"
 178 done
 179
 180 # Create the archive of .dSYM bundles.
 181 if [ ! -e "${DSYM_TAR_PATH}" ] ; then
 182   # Change directory so that absolute paths aren't included in the archive.
 183   (cd "${BUILT_PRODUCTS_DIR}" &&
 184    tar -jcf "${DSYM_TAR_PATH}" "${DSYMS[@]}")
 185 fi