1/* 2 * Copyright (C) 2020 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package apex 18 19import ( 20 "encoding/json" 21 22 "github.com/google/blueprint" 23 24 "android/soong/android" 25) 26 27func init() { 28 registerApexDepsInfoComponents(android.InitRegistrationContext) 29} 30 31func registerApexDepsInfoComponents(ctx android.RegistrationContext) { 32 ctx.RegisterParallelSingletonType("apex_depsinfo_singleton", apexDepsInfoSingletonFactory) 33} 34 35type apexDepsInfoSingleton struct { 36 allowedApexDepsInfoCheckResult android.OutputPath 37} 38 39func apexDepsInfoSingletonFactory() android.Singleton { 40 return &apexDepsInfoSingleton{} 41} 42 43var ( 44 // Generate new apex allowed_deps.txt by merging all internal dependencies. 45 generateApexDepsInfoFilesRule = pctx.AndroidStaticRule("generateApexDepsInfoFilesRule", blueprint.RuleParams{ 46 Command: "cat $out.rsp | xargs cat" + 47 // Only track non-external dependencies, i.e. those that end up in the binary 48 " | grep -v '(external)'" + 49 // Ignore comments in any of the files 50 " | grep -v '^#'" + 51 " | sort -u -f >$out", 52 Rspfile: "$out.rsp", 53 RspfileContent: "$in", 54 }) 55 56 // Diff two given lists while ignoring comments in the allowed deps file. 57 diffAllowedApexDepsInfoRule = pctx.AndroidStaticRule("diffAllowedApexDepsInfoRule", blueprint.RuleParams{ 58 Description: "Diff ${allowed_deps} and ${new_allowed_deps}", 59 Command: ` 60 if grep -v '^#' ${allowed_deps} | diff -B - ${new_allowed_deps}; then 61 touch ${out}; 62 else 63 echo -e "\n******************************"; 64 echo "ERROR: go/apex-allowed-deps-error contains more information"; 65 echo "******************************"; 66 echo "Detected changes to allowed dependencies in updatable modules."; 67 echo "To fix and update packages/modules/common/build/allowed_deps.txt, please run:"; 68 echo -e "$$ (croot && packages/modules/common/build/update-apex-allowed-deps.sh)\n"; 69 echo "When submitting the generated CL, you must include the following information"; 70 echo "in the commit message if you are adding a new dependency:"; 71 echo "Apex-Size-Increase: Expected binary size increase for affected APEXes (or the size of the .jar / .so file of the new library)"; 72 echo "Previous-Platform-Support: Are the maintainers of the new dependency committed to supporting previous platform releases?"; 73 echo "Aosp-First: Is the new dependency being developed AOSP-first or internal?"; 74 echo "Test-Info: What’s the testing strategy for the new dependency? Does it have its own tests, and are you adding integration tests? How/when are the tests run?"; 75 echo "You do not need OWNERS approval to submit the change, but mainline-modularization@"; 76 echo "will periodically review additions and may require changes."; 77 echo -e "******************************\n"; 78 exit 1; 79 fi; 80 `, 81 }, "allowed_deps", "new_allowed_deps") 82) 83 84func (s *apexDepsInfoSingleton) GenerateBuildActions(ctx android.SingletonContext) { 85 updatableFlatLists := android.Paths{} 86 ctx.VisitAllModules(func(module android.Module) { 87 if binaryInfo, ok := module.(android.ApexBundleDepsInfoIntf); ok { 88 apexInfo, _ := android.SingletonModuleProvider(ctx, module, android.ApexInfoProvider) 89 if path := binaryInfo.FlatListPath(); path != nil { 90 if binaryInfo.Updatable() || apexInfo.Updatable { 91 updatableFlatLists = append(updatableFlatLists, path) 92 } 93 } 94 } 95 }) 96 97 allowedDepsSource := android.ExistentPathForSource(ctx, "packages/modules/common/build/allowed_deps.txt") 98 newAllowedDeps := android.PathForOutput(ctx, "apex", "depsinfo", "new-allowed-deps.txt") 99 s.allowedApexDepsInfoCheckResult = android.PathForOutput(ctx, newAllowedDeps.Rel()+".check") 100 101 if !allowedDepsSource.Valid() { 102 // Unbundled projects may not have packages/modules/common/ checked out; ignore those. 103 ctx.Build(pctx, android.BuildParams{ 104 Rule: android.Touch, 105 Output: s.allowedApexDepsInfoCheckResult, 106 }) 107 } else { 108 allowedDeps := allowedDepsSource.Path() 109 110 ctx.Build(pctx, android.BuildParams{ 111 Rule: generateApexDepsInfoFilesRule, 112 Inputs: append(updatableFlatLists, allowedDeps), 113 Output: newAllowedDeps, 114 }) 115 116 ctx.Build(pctx, android.BuildParams{ 117 Rule: diffAllowedApexDepsInfoRule, 118 Input: newAllowedDeps, 119 Output: s.allowedApexDepsInfoCheckResult, 120 Args: map[string]string{ 121 "allowed_deps": allowedDeps.String(), 122 "new_allowed_deps": newAllowedDeps.String(), 123 }, 124 }) 125 } 126 127 ctx.Phony("apex-allowed-deps-check", s.allowedApexDepsInfoCheckResult) 128} 129 130func (s *apexDepsInfoSingleton) MakeVars(ctx android.MakeVarsContext) { 131 // Export check result to Make. The path is added to droidcore. 132 ctx.Strict("APEX_ALLOWED_DEPS_CHECK", s.allowedApexDepsInfoCheckResult.String()) 133} 134 135func init() { 136 registerApexPrebuiltInfoComponents(android.InitRegistrationContext) 137} 138 139func registerApexPrebuiltInfoComponents(ctx android.RegistrationContext) { 140 ctx.RegisterParallelSingletonType("apex_prebuiltinfo_singleton", apexPrebuiltInfoFactory) 141} 142 143func apexPrebuiltInfoFactory() android.Singleton { 144 return &apexPrebuiltInfo{} 145} 146 147type apexPrebuiltInfo struct { 148 out android.WritablePath 149} 150 151func (a *apexPrebuiltInfo) GenerateBuildActions(ctx android.SingletonContext) { 152 prebuiltInfos := []android.PrebuiltInfo{} 153 154 ctx.VisitAllModules(func(m android.Module) { 155 prebuiltInfo, exists := android.SingletonModuleProvider(ctx, m, android.PrebuiltInfoProvider) 156 // Use prebuiltInfoProvider to filter out non apex soong modules. 157 // Use HideFromMake to filter out the unselected variants of a specific apex. 158 if exists && !m.IsHideFromMake() { 159 prebuiltInfos = append(prebuiltInfos, prebuiltInfo) 160 } 161 }) 162 163 j, err := json.Marshal(prebuiltInfos) 164 if err != nil { 165 ctx.Errorf("Could not convert prebuilt info of apexes to json due to error: %v", err) 166 } 167 a.out = android.PathForOutput(ctx, "prebuilt_info.json") 168 android.WriteFileRule(ctx, a.out, string(j)) 169} 170 171func (a *apexPrebuiltInfo) MakeVars(ctx android.MakeVarsContext) { 172 ctx.DistForGoal("droidcore", a.out) 173} 174