xref: /aosp_15_r20/system/extras/postinst/postinst.sh (revision 288bf5226967eb3dac5cce6c939ccc2a7f2b4fe5)

#!/system/bin/sh

#
# Copyright (C) 2015 The Android Open Source Project
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

# This is an example post-install script. This script will be executed by the
# update_engine right after finishing writing all the partitions, but before
# marking the new slot as active. To enable running this program, insert these
# lines in your product's .mk file (without the # at the beginning):

# AB_OTA_POSTINSTALL_CONFIG += \
#   RUN_POSTINSTALL_system=true \
#   POSTINSTALL_PATH_system=bin/postinst_example \
#   FILESYSTEM_TYPE_system=ext4 \

# This script receives no arguments. argv[0] will include the absolute path to
# the script, including the directory where the new partition was mounted.
#
# The script will run from the "postinstall" SELinux domain, from the old system
# environment (kernel, SELinux rules, etc). New rules and domains introduced by
# the new system won't be available when this script runs, instead, all the
# files in the mounted directory will have the attribute "postinstall_file". All
# the files accessed from here would need to be allowed in the old system or
# those accesses will fail. For example, the absolute path used in the first
# line of this script (/system/bin/sh) is indeed the old system's sh binary. If
# you use a compiled program, you might want to link it statically or use a
# wrapper script to use the new ldso to run your program (see the
# --generate-wrappers option in lddtree.py for an example).

# We get called with two parameters: <target_slot> <status_fd>
# * <target_slot> is the slot where the new system was just copied. This is
#   normally either 0 or 1. You can get the target suffix running
#   `bootctl get-suffix ${target_slot}`
# * <status_fd> is a file descriptor number where this script can write to to
#   report the progress of the process. See examples below.

target_slot="$1"
status_fd="$2"

my_dir=$(dirname "$0")

# We can notify the updater of the progress of our program by writing to the
# status file descriptor "global_progress <frac>\n".
print -u${status_fd} "global_progress 0"

echo "The output of this program will show up in the logs." >&2

# We are half way done, so we set 0.5.
print -u${status_fd} "global_progress 0.5"

echo "Note that this program runs from ${my_dir}"

# Actually, we were done.
print -u${status_fd} "global_progress 1.0"

# If the exit code of this program is an error code (different from 0), the
# update will fail and the new slot will not be marked as active.

exit 0