1// Copyright (C) 2021 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.
14
15package java
16
17import (
18	"android/soong/android"
19	"github.com/google/blueprint"
20)
21
22// MonolithicHiddenAPIInfo contains information needed/provided by the hidden API generation of the
23// monolithic hidden API files.
24//
25// Each list of paths includes all the equivalent paths from each of the bootclasspath_fragment
26// modules that contribute to the platform-bootclasspath.
27type MonolithicHiddenAPIInfo struct {
28	// FlagsFilesByCategory maps from the flag file category to the paths containing information for
29	// that category.
30	FlagsFilesByCategory FlagFilesByCategory
31
32	// The paths to the generated annotation-flags.csv files.
33	AnnotationFlagsPaths android.Paths
34
35	// The paths to the generated metadata.csv files.
36	MetadataPaths android.Paths
37
38	// The paths to the generated index.csv files.
39	IndexPaths android.Paths
40
41	// The subsets of the monolithic hiddenapi-stubs-flags.txt file that are provided by each
42	// bootclasspath_fragment modules.
43	StubFlagSubsets SignatureCsvSubsets
44
45	// The subsets of the monolithic hiddenapi-flags.csv file that are provided by each
46	// bootclasspath_fragment modules.
47	FlagSubsets SignatureCsvSubsets
48
49	// The classes jars from the libraries on the platform bootclasspath.
50	ClassesJars android.Paths
51}
52
53// newMonolithicHiddenAPIInfo creates a new MonolithicHiddenAPIInfo from the flagFilesByCategory
54// plus information provided by each of the fragments.
55func newMonolithicHiddenAPIInfo(ctx android.ModuleContext, flagFilesByCategory FlagFilesByCategory, classpathElements ClasspathElements) MonolithicHiddenAPIInfo {
56	monolithicInfo := MonolithicHiddenAPIInfo{}
57
58	monolithicInfo.FlagsFilesByCategory = flagFilesByCategory
59
60	// Merge all the information from the classpathElements. The fragments form a DAG so it is possible that
61	// this will introduce duplicates so they will be resolved after processing all the classpathElements.
62	for _, element := range classpathElements {
63		switch e := element.(type) {
64		case *ClasspathLibraryElement:
65			classesJars := retrieveClassesJarsFromModule(e.Module())
66			monolithicInfo.ClassesJars = append(monolithicInfo.ClassesJars, classesJars...)
67
68		case *ClasspathFragmentElement:
69			fragment := e.Module()
70			if info, ok := android.OtherModuleProvider(ctx, fragment, HiddenAPIInfoProvider); ok {
71				monolithicInfo.append(ctx, fragment, &info)
72			} else {
73				ctx.ModuleErrorf("%s does not provide hidden API information", fragment)
74			}
75		}
76	}
77
78	return monolithicInfo
79}
80
81// append appends all the files from the supplied info to the corresponding files in this struct.
82func (i *MonolithicHiddenAPIInfo) append(ctx android.ModuleContext, otherModule android.Module, other *HiddenAPIInfo) {
83	i.FlagsFilesByCategory.append(other.FlagFilesByCategory)
84	i.AnnotationFlagsPaths = append(i.AnnotationFlagsPaths, other.AnnotationFlagsPath)
85	i.MetadataPaths = append(i.MetadataPaths, other.MetadataPath)
86	i.IndexPaths = append(i.IndexPaths, other.IndexPath)
87
88	apexInfo, ok := android.OtherModuleProvider(ctx, otherModule, android.ApexInfoProvider)
89	if !ok {
90		ctx.ModuleErrorf("Could not determine min_version_version of %s\n", otherModule.Name())
91		return
92	}
93	if apexInfo.MinSdkVersion.LessThanOrEqualTo(android.ApiLevelR) {
94		// Restrict verify_overlaps to R and older modules.
95		// The runtime in S does not have the same restriction that
96		// requires the hiddenapi flags to be generated in a monolithic
97		// invocation.
98		i.StubFlagSubsets = append(i.StubFlagSubsets, other.StubFlagSubset())
99		i.FlagSubsets = append(i.FlagSubsets, other.FlagSubset())
100	}
101}
102
103var MonolithicHiddenAPIInfoProvider = blueprint.NewProvider[MonolithicHiddenAPIInfo]()
104