xref: /aosp_15_r20/build/soong/build_kzip.bash (revision 333d2b3687b3a337dbcca9d65000bca186795e39) 
1#! /bin/bash -uv
2#
3# Build kzip files (source files for the indexing pipeline) for the given configuration,
4# merge them and place the resulting all.kzip into $DIST_DIR.
5# It is assumed that the current directory is the top of the source tree.
6# The following environment variables affect the result:
7#   BUILD_NUMBER          build number, used to generate unique ID (will use UUID if not set)
8#   SUPERPROJECT_SHA      superproject sha, used to generate unique id (will use BUILD_NUMBER if not set)
9#   SUPERPROJECT_REVISION superproject revision, used for unique id if defined as a sha
10#   KZIP_NAME             name of the output file (will use SUPERPROJECT_REVISION|SUPERPROJECT_SHA|BUILD_NUMBER|UUID if not set)
11#   DIST_DIR              where the resulting all.kzip will be placed
12#   KYTHE_KZIP_ENCODING   proto or json (proto is default)
13#   KYTHE_JAVA_SOURCE_BATCH_SIZE maximum number of the Java source files in a compilation unit
14#   OUT_DIR               output directory (out if not specified})
15#   TARGET_BUILD_VARIANT  variant, e.g., `userdebug`
16#   TARGET_PRODUCT        target device name, e.g., 'aosp_blueline'
17#   XREF_CORPUS           source code repository URI, e.g., 'android.googlesource.com/platform/superproject'
18
19# If the SUPERPROJECT_REVISION is defined as a sha, use this as the default value if no
20# SUPERPROJECT_SHA is specified.
21if [[ ${SUPERPROJECT_REVISION:-} =~ [0-9a-f]{40} ]]; then
22  : ${KZIP_NAME:=${SUPERPROJECT_REVISION:-}}
23fi
24
25: ${KZIP_NAME:=${SUPERPROJECT_SHA:-}}
26: ${KZIP_NAME:=${BUILD_NUMBER:-}}
27: ${KZIP_NAME:=$(uuidgen)}
28
29: ${KYTHE_JAVA_SOURCE_BATCH_SIZE:=500}
30: ${KYTHE_KZIP_ENCODING:=proto}
31: ${XREF_CORPUS:?should be set}
32export KYTHE_JAVA_SOURCE_BATCH_SIZE KYTHE_KZIP_ENCODING
33
34# The extraction might fail for some source files, so run with -k and then check that
35# sufficiently many files were generated.
36declare -r out="${OUT_DIR:-out}"
37
38# Build extraction files and `merge_zips` which we use later.
39kzip_targets=(
40  merge_zips
41  xref_cxx
42  xref_java
43  xref_kotlin
44  # TODO: b/286390153 - reenable rust
45  # xref_rust
46)
47
48build/soong/soong_ui.bash --build-mode --all-modules --dir=$PWD -k --skip-soong-tests --ninja_weight_source=not_used "${kzip_targets[@]}"
49
50# Build extraction file for Go the files in build/{blueprint,soong} directories.
51declare -r abspath_out=$(realpath "${out}")
52declare -r go_extractor=$(realpath prebuilts/build-tools/linux-x86/bin/go_extractor)
53declare -r go_root=$(realpath prebuilts/go/linux-x86)
54declare -r source_root=$PWD
55
56# For the Go code, we invoke the extractor directly. The two caveats are that
57# the extractor's rewrite rules are generated on the fly as they depend on the
58# value of XREF_CORPUS, and that the name of the kzip file is derived from the
59# directory name by replacing '/' with '_'.
60# Go extractor should succeed.
61declare -ar go_modules=(build/blueprint build/soong
62  build/make/tools/canoninja build/make/tools/compliance build/make/tools/rbcrun)
63set -e
64for dir in "${go_modules[@]}"; do
65  (cd "$dir";
66   outfile=$(echo "$dir" | sed -r 's|/|_|g;s|(.*)|\1.go.kzip|');
67   KYTHE_ROOT_DIRECTORY="${source_root}" "$go_extractor" --goroot="$go_root" \
68   --rules=<(printf '[{"pattern": "(.*)","vname": {"path": "@1@", "corpus":"%s"}}]' "${XREF_CORPUS}") \
69   --canonicalize_package_corpus --output "${abspath_out}/soong/$outfile" ./...
70  )
71done
72set +e
73
74declare -r kzip_count=$(find "$out" -name '*.kzip' | wc -l)
75(($kzip_count>100000)) || { >&2 printf "ERROR: Too few kzip files were generated: %d\n" $kzip_count; exit 1; }
76
77# Pack
78declare -r allkzip="$KZIP_NAME.kzip"
79"$out/host/linux-x86/bin/merge_zips" "$DIST_DIR/$allkzip" @<(find "$out" -name '*.kzip')
80
81