• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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		if m.AlwaysSdk() {
35			if !m.UseSdk() && !m.SplitPerApiLevel() {
36				ctx.ModuleErrorf("UseSdk() must return true when AlwaysSdk is set, did the factory forget to set Sdk_version?")
37			}
38			modules := ctx.CreateVariations("sdk")
39			modules[0].(*Module).Properties.IsSdkVariant = true
40		} else if m.UseSdk() || m.SplitPerApiLevel() {
41			modules := ctx.CreateVariations("", "sdk")
42
43			// Clear the sdk_version property for the platform (non-SDK) variant so later code
44			// doesn't get confused by it.
45			modules[0].(*Module).Properties.Sdk_version = nil
46
47			// Mark the SDK variant.
48			modules[1].(*Module).Properties.IsSdkVariant = true
49
50			if ctx.Config().UnbundledBuildApps() {
51				// For an unbundled apps build, hide the platform variant from Make.
52				modules[0].(*Module).Properties.HideFromMake = true
53				modules[0].(*Module).Properties.PreventInstall = true
54			} else {
55				// For a platform build, mark the SDK variant so that it gets a ".sdk" suffix when
56				// exposed to Make.
57				modules[1].(*Module).Properties.SdkAndPlatformVariantVisibleToMake = true
58				modules[1].(*Module).Properties.PreventInstall = true
59			}
60			ctx.AliasVariation("")
61		} else {
62			if m, ok := ctx.Module().(*Module); ok {
63				// Clear the sdk_version property for modules that don't have an SDK variant so
64				// later code doesn't get confused by it.
65				m.Properties.Sdk_version = nil
66			}
67			ctx.CreateVariations("")
68			ctx.AliasVariation("")
69		}
70	case *genrule.Module:
71		if p, ok := m.Extra.(*GenruleExtraProperties); ok {
72			if String(p.Sdk_version) != "" {
73				ctx.CreateVariations("", "sdk")
74			} else {
75				ctx.CreateVariations("")
76			}
77			ctx.AliasVariation("")
78		}
79	case *snapshotModule:
80		ctx.CreateVariations("")
81	}
82}
83