1// Copyright 2020 The Android Open Source Project 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. 14package cc 15 16// This file contains utility types and functions for VNDK / vendor snapshot. 17 18import ( 19 "android/soong/android" 20) 21 22var ( 23 HeaderExts = []string{".h", ".hh", ".hpp", ".hxx", ".h++", ".inl", ".inc", ".ipp", ".h.generic"} 24) 25 26func (m *Module) IsSnapshotLibrary() bool { 27 if _, ok := m.linker.(snapshotLibraryInterface); ok { 28 return true 29 } 30 return false 31} 32 33func (m *Module) SnapshotHeaders() android.Paths { 34 if m.IsSnapshotLibrary() { 35 return m.linker.(snapshotLibraryInterface).snapshotHeaders() 36 } 37 return android.Paths{} 38} 39 40func (m *Module) Dylib() bool { 41 return false 42} 43 44func (m *Module) Rlib() bool { 45 return false 46} 47 48func (m *Module) SnapshotRuntimeLibs() []string { 49 return m.Properties.SnapshotRuntimeLibs 50} 51 52func (m *Module) SnapshotSharedLibs() []string { 53 return m.Properties.SnapshotSharedLibs 54} 55 56func (m *Module) SnapshotStaticLibs() []string { 57 return m.Properties.SnapshotStaticLibs 58} 59 60// snapshotLibraryInterface is an interface for libraries captured to VNDK / vendor snapshots. 61type snapshotLibraryInterface interface { 62 libraryInterface 63 64 // collectHeadersForSnapshot is called in GenerateAndroidBuildActions for snapshot aware 65 // modules (See isSnapshotAware below). 66 // This function should gather all headers needed for snapshot. 67 collectHeadersForSnapshot(ctx android.ModuleContext) 68 69 // snapshotHeaders should return collected headers by collectHeadersForSnapshot. 70 // Calling snapshotHeaders before collectHeadersForSnapshot is an error. 71 snapshotHeaders() android.Paths 72} 73 74var _ snapshotLibraryInterface = (*prebuiltLibraryLinker)(nil) 75var _ snapshotLibraryInterface = (*libraryDecorator)(nil) 76 77// snapshotMap is a helper wrapper to a map from base module name to snapshot module name. 78type snapshotMap struct { 79 snapshots map[string]string 80} 81 82func newSnapshotMap() *snapshotMap { 83 return &snapshotMap{ 84 snapshots: make(map[string]string), 85 } 86} 87 88func snapshotMapKey(name string, arch android.ArchType) string { 89 return name + ":" + arch.String() 90} 91 92// Adds a snapshot name for given module name and architecture. 93// e.g. add("libbase", X86, "libbase.vndk.29.x86") 94func (s *snapshotMap) add(name string, arch android.ArchType, snapshot string) { 95 s.snapshots[snapshotMapKey(name, arch)] = snapshot 96} 97 98// Returns snapshot name for given module name and architecture, if found. 99// e.g. get("libcutils", X86) => "libcutils.vndk.29.x86", true 100func (s *snapshotMap) get(name string, arch android.ArchType) (snapshot string, found bool) { 101 snapshot, found = s.snapshots[snapshotMapKey(name, arch)] 102 return snapshot, found 103} 104 105// ShouldCollectHeadersForSnapshot determines if the module is a possible candidate for snapshot. 106// If it's true, collectHeadersForSnapshot will be called in GenerateAndroidBuildActions. 107func ShouldCollectHeadersForSnapshot(ctx android.ModuleContext, m LinkableInterface, apexInfo android.ApexInfo) bool { 108 if ctx.DeviceConfig().VndkVersion() != "current" && 109 ctx.DeviceConfig().RecoverySnapshotVersion() != "current" { 110 return false 111 } 112 if _, ok := isVndkSnapshotAware(ctx.DeviceConfig(), m, apexInfo); ok { 113 return ctx.Config().VndkSnapshotBuildArtifacts() 114 } 115 116 for _, image := range []SnapshotImage{VendorSnapshotImageSingleton, RecoverySnapshotImageSingleton} { 117 if isSnapshotAware(ctx.DeviceConfig(), m, image.IsProprietaryPath(ctx.ModuleDir(), ctx.DeviceConfig()), apexInfo, image) { 118 return true 119 } 120 } 121 return false 122} 123