blob: 98db8249644457716edba805534d33ef983f0e64 [file] [log] [blame]
Jiyong Parkf1691d22021-03-29 20:11:58 +09001// Copyright 2021 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 android
16
17import (
18 "fmt"
19 "strconv"
20 "strings"
21)
22
23type SdkContext interface {
24 // SdkVersion returns SdkSpec that corresponds to the sdk_version property of the current module
Jiyong Park92315372021-04-02 08:45:46 +090025 SdkVersion(ctx EarlyModuleContext) SdkSpec
Jiyong Parkf1691d22021-03-29 20:11:58 +090026 // SystemModules returns the system_modules property of the current module, or an empty string if it is not set.
27 SystemModules() string
28 // MinSdkVersion returns SdkSpec that corresponds to the min_sdk_version property of the current module,
29 // or from sdk_version if it is not set.
Jiyong Park92315372021-04-02 08:45:46 +090030 MinSdkVersion(ctx EarlyModuleContext) SdkSpec
Jiyong Parkf1691d22021-03-29 20:11:58 +090031 // TargetSdkVersion returns the SdkSpec that corresponds to the target_sdk_version property of the current module,
32 // or from sdk_version if it is not set.
Jiyong Park92315372021-04-02 08:45:46 +090033 TargetSdkVersion(ctx EarlyModuleContext) SdkSpec
Jiyong Parkf1691d22021-03-29 20:11:58 +090034}
35
36// SdkKind represents a particular category of an SDK spec like public, system, test, etc.
37type SdkKind int
38
39const (
40 SdkInvalid SdkKind = iota
41 SdkNone
42 SdkCore
43 SdkCorePlatform
44 SdkPublic
45 SdkSystem
46 SdkTest
47 SdkModule
48 SdkSystemServer
49 SdkPrivate
50)
51
52// String returns the string representation of this SdkKind
53func (k SdkKind) String() string {
54 switch k {
55 case SdkPrivate:
56 return "private"
57 case SdkNone:
58 return "none"
59 case SdkPublic:
60 return "public"
61 case SdkSystem:
62 return "system"
63 case SdkTest:
64 return "test"
65 case SdkCore:
66 return "core"
67 case SdkCorePlatform:
68 return "core_platform"
69 case SdkModule:
70 return "module-lib"
71 case SdkSystemServer:
72 return "system-server"
73 default:
74 return "invalid"
75 }
76}
77
Jiyong Parkf1691d22021-03-29 20:11:58 +090078// SdkSpec represents the kind and the version of an SDK for a module to build against
79type SdkSpec struct {
Jiyong Park54105c42021-03-31 18:17:53 +090080 Kind SdkKind
81 ApiLevel ApiLevel
82 Raw string
Jiyong Parkf1691d22021-03-29 20:11:58 +090083}
84
85func (s SdkSpec) String() string {
Jiyong Park54105c42021-03-31 18:17:53 +090086 return fmt.Sprintf("%s_%s", s.Kind, s.ApiLevel)
Jiyong Parkf1691d22021-03-29 20:11:58 +090087}
88
89// Valid checks if this SdkSpec is well-formed. Note however that true doesn't mean that the
90// specified SDK actually exists.
91func (s SdkSpec) Valid() bool {
92 return s.Kind != SdkInvalid
93}
94
95// Specified checks if this SdkSpec is well-formed and is not "".
96func (s SdkSpec) Specified() bool {
97 return s.Valid() && s.Kind != SdkPrivate
98}
99
100// whether the API surface is managed and versioned, i.e. has .txt file that
101// get frozen on SDK freeze and changes get reviewed by API council.
102func (s SdkSpec) Stable() bool {
103 if !s.Specified() {
104 return false
105 }
106 switch s.Kind {
107 case SdkNone:
108 // there is nothing to manage and version in this case; de facto stable API.
109 return true
110 case SdkCore, SdkPublic, SdkSystem, SdkModule, SdkSystemServer:
111 return true
112 case SdkCorePlatform, SdkTest, SdkPrivate:
113 return false
114 default:
115 panic(fmt.Errorf("unknown SdkKind=%v", s.Kind))
116 }
117 return false
118}
119
120// PrebuiltSdkAvailableForUnbundledBuilt tells whether this SdkSpec can have a prebuilt SDK
121// that can be used for unbundled builds.
122func (s SdkSpec) PrebuiltSdkAvailableForUnbundledBuild() bool {
123 // "", "none", and "core_platform" are not available for unbundled build
124 // as we don't/can't have prebuilt stub for the versions
125 return s.Kind != SdkPrivate && s.Kind != SdkNone && s.Kind != SdkCorePlatform
126}
127
128func (s SdkSpec) ForVendorPartition(ctx EarlyModuleContext) SdkSpec {
129 // If BOARD_CURRENT_API_LEVEL_FOR_VENDOR_MODULES has a numeric value,
130 // use it instead of "current" for the vendor partition.
131 currentSdkVersion := ctx.DeviceConfig().CurrentApiLevelForVendorModules()
132 if currentSdkVersion == "current" {
133 return s
134 }
135
136 if s.Kind == SdkPublic || s.Kind == SdkSystem {
Jiyong Park54105c42021-03-31 18:17:53 +0900137 if s.ApiLevel.IsCurrent() {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900138 if i, err := strconv.Atoi(currentSdkVersion); err == nil {
Jiyong Park54105c42021-03-31 18:17:53 +0900139 apiLevel := uncheckedFinalApiLevel(i)
140 return SdkSpec{s.Kind, apiLevel, s.Raw}
Jiyong Parkf1691d22021-03-29 20:11:58 +0900141 }
142 panic(fmt.Errorf("BOARD_CURRENT_API_LEVEL_FOR_VENDOR_MODULES must be either \"current\" or a number, but was %q", currentSdkVersion))
143 }
144 }
145 return s
146}
147
148// UsePrebuilt determines whether prebuilt SDK should be used for this SdkSpec with the given context.
149func (s SdkSpec) UsePrebuilt(ctx EarlyModuleContext) bool {
Jiyong Park54105c42021-03-31 18:17:53 +0900150 if s.ApiLevel.IsCurrent() {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900151 // "current" can be built from source and be from prebuilt SDK
152 return ctx.Config().AlwaysUsePrebuiltSdks()
Jiyong Park54105c42021-03-31 18:17:53 +0900153 } else if !s.ApiLevel.IsPreview() {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900154 // validation check
155 if s.Kind != SdkPublic && s.Kind != SdkSystem && s.Kind != SdkTest && s.Kind != SdkModule {
156 panic(fmt.Errorf("prebuilt SDK is not not available for SdkKind=%q", s.Kind))
157 return false
158 }
159 // numbered SDKs are always from prebuilt
160 return true
161 }
162 // "", "none", "core_platform" fall here
163 return false
164}
165
Jiyong Park54105c42021-03-31 18:17:53 +0900166// EffectiveVersion converts an SdkSpec into the concrete ApiLevel that the module should use. For
167// modules targeting an unreleased SDK (meaning it does not yet have a number) it returns
168// FutureApiLevel(10000).
169func (s SdkSpec) EffectiveVersion(ctx EarlyModuleContext) (ApiLevel, error) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900170 if !s.Valid() {
Jiyong Park54105c42021-03-31 18:17:53 +0900171 return s.ApiLevel, fmt.Errorf("invalid sdk version %q", s.Raw)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900172 }
173
174 if ctx.DeviceSpecific() || ctx.SocSpecific() {
175 s = s.ForVendorPartition(ctx)
176 }
Jiyong Park54105c42021-03-31 18:17:53 +0900177 if !s.ApiLevel.IsPreview() {
178 return s.ApiLevel, nil
Jiyong Parkf1691d22021-03-29 20:11:58 +0900179 }
Jiyong Park54105c42021-03-31 18:17:53 +0900180 ret := ctx.Config().DefaultAppTargetSdk(ctx)
181 if ret.IsPreview() {
182 return FutureApiLevel, nil
183 }
184 return ret, nil
Jiyong Parkf1691d22021-03-29 20:11:58 +0900185}
186
187// EffectiveVersionString converts an SdkSpec into the concrete version string that the module
188// should use. For modules targeting an unreleased SDK (meaning it does not yet have a number)
189// it returns the codename (P, Q, R, etc.)
190func (s SdkSpec) EffectiveVersionString(ctx EarlyModuleContext) (string, error) {
Jiyong Park54105c42021-03-31 18:17:53 +0900191 if !s.Valid() {
192 return s.ApiLevel.String(), fmt.Errorf("invalid sdk version %q", s.Raw)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900193 }
Jiyong Park54105c42021-03-31 18:17:53 +0900194
195 if ctx.DeviceSpecific() || ctx.SocSpecific() {
196 s = s.ForVendorPartition(ctx)
197 }
198 if !s.ApiLevel.IsPreview() {
199 return s.ApiLevel.String(), nil
200 }
201 return ctx.Config().DefaultAppTargetSdk(ctx).String(), nil
Jiyong Parkf1691d22021-03-29 20:11:58 +0900202}
203
Jiyong Park92315372021-04-02 08:45:46 +0900204var (
205 SdkSpecNone = SdkSpec{SdkNone, NoneApiLevel, "(no version)"}
206 // TODO(b/175678607) ApiLevel of SdkSpecPrivate should be FutureApiLevel
207 SdkSpecPrivate = SdkSpec{SdkPrivate, NoneApiLevel, ""}
208 // TODO(b/175678607) ApiLevel of SdkSpecCorePlatform should be FutureApiLevel
209 SdkSpecCorePlatform = SdkSpec{SdkCorePlatform, NoneApiLevel, "core_platform"}
210)
211
212func SdkSpecFrom(ctx EarlyModuleContext, str string) SdkSpec {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900213 switch str {
214 // special cases first
215 case "":
Jiyong Park92315372021-04-02 08:45:46 +0900216 return SdkSpecPrivate
Jiyong Parkf1691d22021-03-29 20:11:58 +0900217 case "none":
Jiyong Park92315372021-04-02 08:45:46 +0900218 return SdkSpecNone
Jiyong Parkf1691d22021-03-29 20:11:58 +0900219 case "core_platform":
Jiyong Park92315372021-04-02 08:45:46 +0900220 return SdkSpecCorePlatform
Jiyong Parkf1691d22021-03-29 20:11:58 +0900221 default:
222 // the syntax is [kind_]version
223 sep := strings.LastIndex(str, "_")
224
225 var kindString string
226 if sep == 0 {
Jiyong Park54105c42021-03-31 18:17:53 +0900227 return SdkSpec{SdkInvalid, NoneApiLevel, str}
Jiyong Parkf1691d22021-03-29 20:11:58 +0900228 } else if sep == -1 {
229 kindString = ""
230 } else {
231 kindString = str[0:sep]
232 }
233 versionString := str[sep+1 : len(str)]
234
235 var kind SdkKind
236 switch kindString {
237 case "":
238 kind = SdkPublic
239 case "core":
240 kind = SdkCore
241 case "system":
242 kind = SdkSystem
243 case "test":
244 kind = SdkTest
245 case "module":
246 kind = SdkModule
247 case "system_server":
248 kind = SdkSystemServer
249 default:
Jiyong Park54105c42021-03-31 18:17:53 +0900250 return SdkSpec{SdkInvalid, NoneApiLevel, str}
Jiyong Parkf1691d22021-03-29 20:11:58 +0900251 }
252
Jiyong Park92315372021-04-02 08:45:46 +0900253 apiLevel, err := ApiLevelFromUser(ctx, versionString)
254 if err != nil {
Jiyong Park54105c42021-03-31 18:17:53 +0900255 return SdkSpec{SdkInvalid, apiLevel, str}
Jiyong Parkf1691d22021-03-29 20:11:58 +0900256 }
Jiyong Park54105c42021-03-31 18:17:53 +0900257 return SdkSpec{kind, apiLevel, str}
Jiyong Parkf1691d22021-03-29 20:11:58 +0900258 }
259}
260
261func (s SdkSpec) ValidateSystemSdk(ctx EarlyModuleContext) bool {
262 // Ensures that the specified system SDK version is one of BOARD_SYSTEMSDK_VERSIONS (for vendor/product Java module)
263 // Assuming that BOARD_SYSTEMSDK_VERSIONS := 28 29,
264 // sdk_version of the modules in vendor/product that use system sdk must be either system_28, system_29 or system_current
Jiyong Park54105c42021-03-31 18:17:53 +0900265 if s.Kind != SdkSystem || s.ApiLevel.IsPreview() {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900266 return true
267 }
268 allowedVersions := ctx.DeviceConfig().PlatformSystemSdkVersions()
269 if ctx.DeviceSpecific() || ctx.SocSpecific() || (ctx.ProductSpecific() && ctx.Config().EnforceProductPartitionInterface()) {
270 systemSdkVersions := ctx.DeviceConfig().SystemSdkVersions()
271 if len(systemSdkVersions) > 0 {
272 allowedVersions = systemSdkVersions
273 }
274 }
Jiyong Park54105c42021-03-31 18:17:53 +0900275 if len(allowedVersions) > 0 && !InList(s.ApiLevel.String(), allowedVersions) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900276 ctx.PropertyErrorf("sdk_version", "incompatible sdk version %q. System SDK version should be one of %q",
277 s.Raw, allowedVersions)
278 return false
279 }
280 return true
281}