scripts/update_symbol_list.sh

#!/bin/bash
# SPDX-License-Identifier: GPL-2.0
#
# Update the symbol list and prepare a suitable commit message for AOSP
# submission.

readonly GKI_KERNEL_DIR="kernel-5.15"
readonly GKI_KERNEL_REMOTE="gaosp"
readonly GKI_KERNEL_BRANCH=$(. ${GKI_KERNEL_DIR}/build.config.constants && echo ${BRANCH})
readonly SYMBOL_LIST="android/abi_gki_aarch64_mtkott"
readonly SYMBOL_LIST_NAME="mtkott"
PREPARE_AOSP_SYMLIST="0"
BUG=""
COMMIT_TEXT=""
ARGS=()

function usage() {
  cat <<- EOF
    USAGE: $0 [-p|--prepare-aosp-symlist BUG_NUMBER]
    -p | --prepare-aosp-symlist BUG_NUMBER   Update the AOSP symbol list in ${GKI_KERNEL_DIR}/
                                             and create a commit with the provided BUG_NUMBER.
EOF
}

# Add a trap to remove the temporary vmlinux in case of an error occurs before
# we finish.
function cleanup_trap() {
  rm -f ${COMMIT_TEXT}
  exit $1
}
trap 'cleanup_trap' EXIT

function exit_if_error() {
  if [[ $1 -ne 0 ]]; then
    echo "ERROR: $2: retval=$1" >&2
    exit $1
  fi
}

function verify_aosp_tree {
  if [[ "${PREPARE_AOSP_SYMLIST}" = "0" ]]; then
    return
  fi

  pushd ${GKI_KERNEL_DIR} > /dev/null

  if ! git diff --quiet HEAD; then
    exit_if_error 1 \
    "Found uncommitted changes in ${GKI_KERNEL_DIR}/. Commit your changes before updating the symbol list"
  fi

  popd > /dev/null
}

function make_symbol_list_commit_text() {
  COMMIT_TEXT=$(mktemp -t symlist_commit_text.XXXXX)
  echo "ANDROID: GKI: Update symbol list for ${SYMBOL_LIST_NAME}" > ${COMMIT_TEXT}
  echo >> ${COMMIT_TEXT}
  echo "Add required symbols for mtkott." >> ${COMMIT_TEXT}
  echo >> ${COMMIT_TEXT}
  echo "Bug: ${BUG}" >> ${COMMIT_TEXT}
}

function commit_symbol_list_update() {
  make_symbol_list_commit_text

  pushd ${GKI_KERNEL_DIR} > /dev/null

  if ! git cat-file -e \
          ${GKI_KERNEL_REMOTE}/${GKI_KERNEL_BRANCH}:${SYMBOL_LIST} \
          > /dev/null 2>&1; then
    git add ${SYMBOL_LIST}
  fi

  git commit --quiet -s -F ${COMMIT_TEXT} -- android/
  rm -f ${COMMIT_TEXT}

  local curr_commit=$(git rev-parse HEAD)

  git fetch -q ${GKI_KERNEL_REMOTE} ${GKI_KERNEL_BRANCH}
  git checkout -q ${GKI_KERNEL_REMOTE}/${GKI_KERNEL_BRANCH}
  git cherry-pick ${curr_commit}

  cat <<- EOF
    ========================================================
    An ABI commit in ${GKI_KERNEL_DIR}/ was created for you on the tip of the
    development branch.

    Please verify your commit(s) before pushing. Here are the steps to perform:

    cd ${GKI_KERNEL_DIR}
    git log --oneline HEAD
    git push ${GKI_KERNEL_REMOTE} HEAD:refs/for/${GKI_KERNEL_BRANCH}

    To return the core kernel tree to the previous commit, use:
    git checkout ${curr_commit}
EOF

  popd > /dev/null
}

function update_aosp_symlist() {
  local config_parameters="--config=kirkwood_64 --config=fast"
  local build_target="//kernel_device_modules-5.15:kirkwood_64_abi_update_symbol_list"

  tools/bazel run ${config_parameters} ${build_target}

  echo "========================================================"
  echo " The symbol list has been updated locally in ${GKI_KERNEL_DIR}/."
  echo " Compiling with BUILD_GKI_KERNEL=1 is now required until"
  echo " the new symbol(s) are merged."
}

function read_args() {
  local next

  while [[ $# -gt 0 ]]; do
    next="$1"

    case ${next} in
      -p|--prepare-aosp-symlist)
        PREPARE_AOSP_SYMLIST="1"
        BUG="$2"
        if ! [[ "${BUG}" =~ ^[0-9]+$ ]]; then
          exit_if_error 1 "Bug numbers should be digits."
        fi
        shift
        ;;
      -h|--help)
        usage
        exit 0
        ;;
      *)
        ARGS+=("$1")
        ;;
    esac
    shift
  done
}

read_args "$@"

# read_args() will ensure to store any arguments that should be passed on
# to the build scripts into the $ARGS array. However, this must be done
# outside of read_args() to affect the positional arguments for the invocation
# of this script, and not just the invocation of read_args().
set -- "${ARGS[@]}"

# Verify the aosp tree is in a good state before compiling anything
verify_aosp_tree

update_aosp_symlist

if [[ "${PREPARE_AOSP_SYMLIST}" != "0" ]]; then
  commit_symbol_list_update
fi