The provided Python code, `make_recovery_patch.py`, is a script from the...

July 4, 2025 at 06:55 PM


  

ALERT: This file is stale. Please view the main branch for the latest version of this code.
platform/superproject
master
build/make/tools/releasetools/make_recovery_patch.py
releasetools
merge
testdata
Android.bp
OWNERS
add_img_to_target_files.py
apex_utils.py
blockimgdiff.py
build_image.py
build_super_image.py
care_map_pb2.py
check_ota_package_signature.py
check_partition_sizes.py
check_target_files_signatures.py
check_target_files_vintf.py
common.py
create_brick_ota.py
edify_generator.py
find_shareduid_violation.py
fsverity_metadata_generator.py
images.py
img_from_target_files.py
jarjar-rules.txt
make_recovery_patch.py
merge_ota.py
non_ab_ota.py
ota_from_raw_img.py
ota_from_target_files.py
ota_metadata.proto
ota_metadata_pb2.py
ota_package_parser.py
ota_signing_utils.py
ota_utils.py
payload_signer.py
pylintrc
rangelib.py
sign_apex.py
sign_target_files_apks.py
sparse_img.py
target_files_diff.py
test_add_img_to_target_files.py
test_apex_utils.py
test_blockimgdiff.py
test_build_image.py
test_check_partition_sizes.py
test_check_target_files_vintf.py
test_common.py
test_merge_ota.py
test_non_ab_ota.py
test_ota_from_target_files.py
test_ota_utils.py
test_rangelib.py
test_sign_apex.py
test_sign_target_files_apks.py
test_utils.py
test_validate_target_files.py
test_verity_utils.py
validate_target_files.py
verity_utils.py
make_recovery_patch.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
#!/usr/bin/env python
#
# Copyright (C) 2014 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.

from __future__ import print_function

import logging
import os
import sys

import common

if sys.hexversion < 0x02070000:
  print("Python 2.7 or newer is required.", file=sys.stderr)
  sys.exit(1)

logger = logging.getLogger(__name__)

OPTIONS = common.OPTIONS


def main(argv):
  args = common.ParseOptions(argv, __doc__)
  input_dir, output_dir = args

  common.InitLogging()

  OPTIONS.info_dict = common.LoadInfoDict(input_dir)

  recovery_img = common.GetBootableImage("recovery.img", "recovery.img",
                                         input_dir, "RECOVERY")
  boot_img = common.GetBootableImage("boot.img", "boot.img",
                                     input_dir, "BOOT")

  if not recovery_img or not boot_img:
    sys.exit(0)

  board_uses_vendorimage = OPTIONS.info_dict.get(
      "board_uses_vendorimage") == "true"

  if board_uses_vendorimage:
    target_files_dir = "VENDOR"
  else:
    target_files_dir = "SYSTEM"

  def output_sink(fn, data):
    with open(os.path.join(output_dir, target_files_dir,
                           *fn.split("/")), "wb") as f:
      f.write(data)

  common.MakeRecoveryPatch(input_dir, output_sink, recovery_img, boot_img)


if __name__ == '__main__':
  main(sys.argv[1:])
History

The provided Python code, make_recovery_patch.py, is a script from the Android source code that generates a recovery patch file. Here's a breakdown of what the code does:

Imports Required Modules:
- It imports standard libraries (logging, os, sys) and a custom common module likely provided within the Android build tools.
Python Version Check:
- The script ensures that Python 2.7 or newer is being used (sys.hexversion < 0x02070000), as required features might not work in older versions.
Define main Function:
- The main function is the entry point of the script. It:
  - Uses common.ParseOptions() to parse command-line arguments. These arguments include input_dir (path to the input directory containing target files) and output_dir (where the recovery patch will be saved).
  - Calls common.InitLogging() to set up logging for debugging or informational purposes.
  - Loads the OTA info_dict (metadata about the build) by calling common.LoadInfoDict(input_dir).
Retrieve Bootable Images:
- Locates the recovery.img and boot.img, which are images used by the Android OS to boot into recovery mode or normal mode respectively, from the input_dir.
Check for Necessary Files:
- If either recovery.img or boot.img is missing, the script exits without further action.
Determine Target Files Directory:
- The script checks if the board uses a vendor image (indicated by the board_uses_vendorimage flag). Based on this, it decides whether the output should be placed under the VENDOR or SYSTEM directory.
Define Output Function:
- output_sink is a helper function that writes the generated data to a file in the appropriate subdirectory of the output_dir.
Generate the Recovery Patch:
- Calls common.MakeRecoveryPatch() with the following arguments:
  - Input directory for source files.
  - The output_sink function to handle writing output files.
  - The extracted recovery_img.
  - The extracted boot_img.
Exit:
- After generating the recovery patch, the script ends.

In Summary

The script is used as part of the Android build system to generate a recovery patch from existing boot and recovery images, and it organizes the output into either the SYSTEM or VENDOR subdirectory of the specified output directory. It is an essential step in Android's ROM deployment and update (OTA) processes.

Generate your own explanations

Download our vscode extension

Read other generated explanations

Built by @thebuilderjr