xref: /aosp_15_r20/build/soong/cc/stub_library.go (revision 333d2b3687b3a337dbcca9d65000bca186795e39)
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	"sort"
19	"strings"
20
21	"android/soong/android"
22)
23
24func init() {
25	// Use singleton type to gather all generated soong modules.
26	android.RegisterParallelSingletonType("stublibraries", stubLibrariesSingleton)
27}
28
29type stubLibraries struct {
30	stubLibraryMap       map[string]bool
31	stubVendorLibraryMap map[string]bool
32
33	apiListCoverageXmlPaths []string
34}
35
36// Check if the module defines stub, or itself is stub
37func IsStubTarget(m *Module) bool {
38	return m.IsStubs() || m.HasStubsVariants()
39}
40
41// Get target file name to be installed from this module
42func getInstalledFileName(ctx android.SingletonContext, m *Module) string {
43	for _, ps := range android.OtherModuleProviderOrDefault(
44		ctx, m.Module(), android.InstallFilesProvider).PackagingSpecs {
45		if name := ps.FileName(); name != "" {
46			return name
47		}
48	}
49	return ""
50}
51
52func (s *stubLibraries) GenerateBuildActions(ctx android.SingletonContext) {
53	// Visit all generated soong modules and store stub library file names.
54	ctx.VisitAllModules(func(module android.Module) {
55		if m, ok := module.(*Module); ok {
56			if IsStubTarget(m) {
57				if name := getInstalledFileName(ctx, m); name != "" {
58					s.stubLibraryMap[name] = true
59					if m.InVendor() {
60						s.stubVendorLibraryMap[name] = true
61					}
62				}
63			}
64			if m.library != nil && android.IsModulePreferred(m) {
65				if p := m.library.getAPIListCoverageXMLPath().String(); p != "" {
66					s.apiListCoverageXmlPaths = append(s.apiListCoverageXmlPaths, p)
67				}
68			}
69		}
70	})
71}
72
73func stubLibrariesSingleton() android.Singleton {
74	return &stubLibraries{
75		stubLibraryMap:       make(map[string]bool),
76		stubVendorLibraryMap: make(map[string]bool),
77	}
78}
79
80func (s *stubLibraries) MakeVars(ctx android.MakeVarsContext) {
81	// Convert stub library file names into Makefile variable.
82	ctx.Strict("STUB_LIBRARIES", strings.Join(android.SortedKeys(s.stubLibraryMap), " "))
83	ctx.Strict("SOONG_STUB_VENDOR_LIBRARIES", strings.Join(android.SortedKeys(s.stubVendorLibraryMap), " "))
84
85	// Export the list of API XML files to Make.
86	sort.Strings(s.apiListCoverageXmlPaths)
87	ctx.Strict("SOONG_CC_API_XML", strings.Join(s.apiListCoverageXmlPaths, " "))
88}
89