xref: /aosp_15_r20/art/tools/veridex/precise_hidden_api_finder.h (revision 795d594fd825385562da6b089ea9b2033f3abf5a)
1*795d594fSAndroid Build Coastguard Worker /*
2*795d594fSAndroid Build Coastguard Worker  * Copyright (C) 2018 The Android Open Source Project
3*795d594fSAndroid Build Coastguard Worker  *
4*795d594fSAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*795d594fSAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*795d594fSAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*795d594fSAndroid Build Coastguard Worker  *
8*795d594fSAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*795d594fSAndroid Build Coastguard Worker  *
10*795d594fSAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*795d594fSAndroid Build Coastguard Worker   * distributed under the License is distributed on an "AS IS" BASIS,
12*795d594fSAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*795d594fSAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*795d594fSAndroid Build Coastguard Worker  * limitations under the License.
15*795d594fSAndroid Build Coastguard Worker  */
16*795d594fSAndroid Build Coastguard Worker 
17*795d594fSAndroid Build Coastguard Worker #ifndef ART_TOOLS_VERIDEX_PRECISE_HIDDEN_API_FINDER_H_
18*795d594fSAndroid Build Coastguard Worker #define ART_TOOLS_VERIDEX_PRECISE_HIDDEN_API_FINDER_H_
19*795d594fSAndroid Build Coastguard Worker 
20*795d594fSAndroid Build Coastguard Worker #include "class_filter.h"
21*795d594fSAndroid Build Coastguard Worker #include "dex/method_reference.h"
22*795d594fSAndroid Build Coastguard Worker #include "flow_analysis.h"
23*795d594fSAndroid Build Coastguard Worker 
24*795d594fSAndroid Build Coastguard Worker #include <iostream>
25*795d594fSAndroid Build Coastguard Worker #include <map>
26*795d594fSAndroid Build Coastguard Worker #include <set>
27*795d594fSAndroid Build Coastguard Worker #include <string>
28*795d594fSAndroid Build Coastguard Worker 
29*795d594fSAndroid Build Coastguard Worker namespace art {
30*795d594fSAndroid Build Coastguard Worker 
31*795d594fSAndroid Build Coastguard Worker class HiddenApi;
32*795d594fSAndroid Build Coastguard Worker struct HiddenApiStats;
33*795d594fSAndroid Build Coastguard Worker class VeridexResolver;
34*795d594fSAndroid Build Coastguard Worker 
35*795d594fSAndroid Build Coastguard Worker /**
36*795d594fSAndroid Build Coastguard Worker  * Reports known uses of hidden APIs from reflection.
37*795d594fSAndroid Build Coastguard Worker  */
38*795d594fSAndroid Build Coastguard Worker class PreciseHiddenApiFinder {
39*795d594fSAndroid Build Coastguard Worker  public:
PreciseHiddenApiFinder(const HiddenApi & hidden_api)40*795d594fSAndroid Build Coastguard Worker   explicit PreciseHiddenApiFinder(const HiddenApi& hidden_api) : hidden_api_(hidden_api) {}
41*795d594fSAndroid Build Coastguard Worker 
42*795d594fSAndroid Build Coastguard Worker   // Iterate over the dex files associated with the passed resolvers to report
43*795d594fSAndroid Build Coastguard Worker   // hidden API uses.
44*795d594fSAndroid Build Coastguard Worker   void Run(const std::vector<std::unique_ptr<VeridexResolver>>& app_resolvers,
45*795d594fSAndroid Build Coastguard Worker            const ClassFilter& app_class_filter);
46*795d594fSAndroid Build Coastguard Worker 
47*795d594fSAndroid Build Coastguard Worker   void Dump(std::ostream& os, HiddenApiStats* stats);
48*795d594fSAndroid Build Coastguard Worker 
49*795d594fSAndroid Build Coastguard Worker  private:
50*795d594fSAndroid Build Coastguard Worker   // Run over all methods of all dex files, and call `action` on each.
51*795d594fSAndroid Build Coastguard Worker   void RunInternal(
52*795d594fSAndroid Build Coastguard Worker       const std::vector<std::unique_ptr<VeridexResolver>>& resolvers,
53*795d594fSAndroid Build Coastguard Worker       const ClassFilter& class_filter,
54*795d594fSAndroid Build Coastguard Worker       const std::function<void(VeridexResolver*, const ClassAccessor::Method&)>& action);
55*795d594fSAndroid Build Coastguard Worker 
56*795d594fSAndroid Build Coastguard Worker   // Add uses found in method `ref`.
57*795d594fSAndroid Build Coastguard Worker   void AddUsesAt(const std::vector<ReflectAccessInfo>& accesses, MethodReference ref);
58*795d594fSAndroid Build Coastguard Worker 
59*795d594fSAndroid Build Coastguard Worker   const HiddenApi& hidden_api_;
60*795d594fSAndroid Build Coastguard Worker 
61*795d594fSAndroid Build Coastguard Worker   std::map<MethodReference, std::vector<ReflectAccessInfo>> concrete_uses_;
62*795d594fSAndroid Build Coastguard Worker   std::map<MethodReference, std::vector<ReflectAccessInfo>> abstract_uses_;
63*795d594fSAndroid Build Coastguard Worker };
64*795d594fSAndroid Build Coastguard Worker 
65*795d594fSAndroid Build Coastguard Worker }  // namespace art
66*795d594fSAndroid Build Coastguard Worker 
67*795d594fSAndroid Build Coastguard Worker #endif  // ART_TOOLS_VERIDEX_PRECISE_HIDDEN_API_FINDER_H_
68