1// Copyright 2020 Google Inc. All rights reserved. 2// 3// Licensed under the Apache License, Version 2.0 (the "License"); 4// you may not use this file except in compliance with the License. 5// You may obtain a copy of the License at 6// 7// http://www.apache.org/licenses/LICENSE-2.0 8// 9// Unless required by applicable law or agreed to in writing, software 10// distributed under the License is distributed on an "AS IS" BASIS, 11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12// See the License for the specific language governing permissions and 13// limitations under the License. 14 15package cc 16 17import ( 18 "android/soong/android" 19 "android/soong/genrule" 20) 21 22// sdkMutator sets a creates a platform and an SDK variant for modules 23// that set sdk_version, and ignores sdk_version for the platform 24// variant. The SDK variant will be used for embedding in APKs 25// that may be installed on older platforms. Apexes use their own 26// variants that enforce backwards compatibility. 27func sdkMutator(ctx android.BottomUpMutatorContext) { 28 if ctx.Os() != android.Android { 29 return 30 } 31 32 switch m := ctx.Module().(type) { 33 case LinkableInterface: 34 ccModule, isCcModule := ctx.Module().(*Module) 35 if m.AlwaysSdk() { 36 if !m.UseSdk() && !m.SplitPerApiLevel() { 37 ctx.ModuleErrorf("UseSdk() must return true when AlwaysSdk is set, did the factory forget to set Sdk_version?") 38 } 39 modules := ctx.CreateVariations("sdk") 40 modules[0].(*Module).Properties.IsSdkVariant = true 41 } else if m.UseSdk() || m.SplitPerApiLevel() { 42 modules := ctx.CreateVariations("", "sdk") 43 44 // Clear the sdk_version property for the platform (non-SDK) variant so later code 45 // doesn't get confused by it. 46 modules[0].(*Module).Properties.Sdk_version = nil 47 48 // Mark the SDK variant. 49 modules[1].(*Module).Properties.IsSdkVariant = true 50 51 if ctx.Config().UnbundledBuildApps() { 52 // For an unbundled apps build, hide the platform variant from Make. 53 modules[0].(*Module).Properties.HideFromMake = true 54 modules[0].(*Module).Properties.PreventInstall = true 55 } else { 56 // For a platform build, mark the SDK variant so that it gets a ".sdk" suffix when 57 // exposed to Make. 58 modules[1].(*Module).Properties.SdkAndPlatformVariantVisibleToMake = true 59 modules[1].(*Module).Properties.PreventInstall = true 60 } 61 ctx.AliasVariation("") 62 } else if isCcModule && ccModule.isImportedApiLibrary() { 63 apiLibrary, _ := ccModule.linker.(*apiLibraryDecorator) 64 if apiLibrary.hasNDKStubs() && ccModule.canUseSdk() { 65 variations := []string{"sdk"} 66 if apiLibrary.hasApexStubs() { 67 variations = append(variations, "") 68 } 69 // Handle cc_api_library module with NDK stubs and variants only which can use SDK 70 modules := ctx.CreateVariations(variations...) 71 // Mark the SDK variant. 72 modules[0].(*Module).Properties.IsSdkVariant = true 73 if ctx.Config().UnbundledBuildApps() { 74 if apiLibrary.hasApexStubs() { 75 // For an unbundled apps build, hide the platform variant from Make. 76 modules[1].(*Module).Properties.HideFromMake = true 77 } 78 modules[1].(*Module).Properties.PreventInstall = true 79 } else { 80 // For a platform build, mark the SDK variant so that it gets a ".sdk" suffix when 81 // exposed to Make. 82 modules[0].(*Module).Properties.SdkAndPlatformVariantVisibleToMake = true 83 // SDK variant is not supposed to be installed 84 modules[0].(*Module).Properties.PreventInstall = true 85 } 86 } else { 87 ccModule.Properties.Sdk_version = nil 88 ctx.CreateVariations("") 89 ctx.AliasVariation("") 90 } 91 } else { 92 if isCcModule { 93 // Clear the sdk_version property for modules that don't have an SDK variant so 94 // later code doesn't get confused by it. 95 ccModule.Properties.Sdk_version = nil 96 } 97 ctx.CreateVariations("") 98 ctx.AliasVariation("") 99 } 100 case *genrule.Module: 101 if p, ok := m.Extra.(*GenruleExtraProperties); ok { 102 if String(p.Sdk_version) != "" { 103 ctx.CreateVariations("", "sdk") 104 } else { 105 ctx.CreateVariations("") 106 } 107 ctx.AliasVariation("") 108 } 109 case *snapshotModule: 110 ctx.CreateVariations("") 111 case *CcApiVariant: 112 ccApiVariant, _ := ctx.Module().(*CcApiVariant) 113 if String(ccApiVariant.properties.Variant) == "ndk" { 114 ctx.CreateVariations("sdk") 115 } else { 116 ctx.CreateVariations("") 117 } 118 } 119} 120