1 /*
2  * Copyright (C) 2014 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef ART_COMPILER_OPTIMIZING_SSA_BUILDER_H_
18 #define ART_COMPILER_OPTIMIZING_SSA_BUILDER_H_
19 
20 #include "base/scoped_arena_allocator.h"
21 #include "base/scoped_arena_containers.h"
22 #include "nodes.h"
23 #include "optimization.h"
24 
25 namespace art {
26 
27 /**
28  * Transforms a graph into SSA form. The liveness guarantees of
29  * this transformation are listed below. A DEX register
30  * being killed means its value at a given position in the code
31  * will not be available to its environment uses. A merge in the
32  * following text is materialized as a `HPhi`.
33  *
34  * (a) Dex registers that do not require merging (that is, they do not
35  *     have different values at a join block) are available to all their
36  *     environment uses. Note that it does not imply the instruction will
37  *     have a physical location after register allocation. See the
38  *     SsaLivenessAnalysis phase.
39  *
40  * (b) Dex registers that require merging, and the merging gives
41  *     incompatible types, will be killed for environment uses of that merge.
42  *
43  * (c) When the `debuggable` flag is passed to the compiler, Dex registers
44  *     that require merging and have a proper type after the merge, are
45  *     available to all their environment uses. If the `debuggable` flag
46  *     is not set, values of Dex registers only used by environments
47  *     are killed.
48  */
49 class SsaBuilder : public ValueObject {
50  public:
SsaBuilder(HGraph * graph,Handle<mirror::ClassLoader> class_loader,Handle<mirror::DexCache> dex_cache,ScopedArenaAllocator * local_allocator)51   SsaBuilder(HGraph* graph,
52              Handle<mirror::ClassLoader> class_loader,
53              Handle<mirror::DexCache> dex_cache,
54              ScopedArenaAllocator* local_allocator)
55       : graph_(graph),
56         class_loader_(class_loader),
57         dex_cache_(dex_cache),
58         agets_fixed_(false),
59         local_allocator_(local_allocator),
60         ambiguous_agets_(local_allocator->Adapter(kArenaAllocGraphBuilder)),
61         ambiguous_asets_(local_allocator->Adapter(kArenaAllocGraphBuilder)),
62         uninitialized_strings_(local_allocator->Adapter(kArenaAllocGraphBuilder)),
63         uninitialized_string_phis_(local_allocator->Adapter(kArenaAllocGraphBuilder)) {
64   }
65 
66   GraphAnalysisResult BuildSsa();
67 
68   HInstruction* GetFloatOrDoubleEquivalent(HInstruction* instruction, DataType::Type type);
69   HInstruction* GetReferenceTypeEquivalent(HInstruction* instruction);
70 
MaybeAddAmbiguousArrayGet(HArrayGet * aget)71   void MaybeAddAmbiguousArrayGet(HArrayGet* aget) {
72     DataType::Type type = aget->GetType();
73     DCHECK(!DataType::IsFloatingPointType(type));
74     if (DataType::IsIntOrLongType(type)) {
75       ambiguous_agets_.push_back(aget);
76     }
77   }
78 
MaybeAddAmbiguousArraySet(HArraySet * aset)79   void MaybeAddAmbiguousArraySet(HArraySet* aset) {
80     DataType::Type type = aset->GetValue()->GetType();
81     if (DataType::IsIntOrLongType(type)) {
82       ambiguous_asets_.push_back(aset);
83     }
84   }
85 
AddUninitializedString(HNewInstance * string)86   void AddUninitializedString(HNewInstance* string) {
87     // In some rare cases (b/27847265), the same NewInstance may be seen
88     // multiple times. We should only consider it once for removal, so we
89     // ensure it is not added more than once.
90     // Note that we cannot check whether this really is a NewInstance of String
91     // before RTP. We DCHECK that in RemoveRedundantUninitializedStrings.
92     if (!ContainsElement(uninitialized_strings_, string)) {
93       uninitialized_strings_.push_back(string);
94     }
95   }
96 
AddUninitializedStringPhi(HInvoke * invoke)97   void AddUninitializedStringPhi(HInvoke* invoke) {
98     uninitialized_string_phis_.push_back(invoke);
99   }
100 
101  private:
102   void SetLoopHeaderPhiInputs();
103   void FixEnvironmentPhis();
104   void FixNullConstantType();
105   void EquivalentPhisCleanup();
106   void RunPrimitiveTypePropagation();
107 
108   // Attempts to resolve types of aget(-wide) instructions and type values passed
109   // to aput(-wide) instructions from reference type information on the array
110   // input. Returns false if the type of an array is unknown.
111   bool FixAmbiguousArrayOps();
112 
113   bool TypeInputsOfPhi(HPhi* phi, ScopedArenaVector<HPhi*>* worklist);
114   bool UpdatePrimitiveType(HPhi* phi, ScopedArenaVector<HPhi*>* worklist);
115   void ProcessPrimitiveTypePropagationWorklist(ScopedArenaVector<HPhi*>* worklist);
116 
117   HFloatConstant* GetFloatEquivalent(HIntConstant* constant);
118   HDoubleConstant* GetDoubleEquivalent(HLongConstant* constant);
119   HPhi* GetFloatDoubleOrReferenceEquivalentOfPhi(HPhi* phi, DataType::Type type);
120   HArrayGet* GetFloatOrDoubleEquivalentOfArrayGet(HArrayGet* aget);
121 
122   void RemoveRedundantUninitializedStrings();
123   bool ReplaceUninitializedStringPhis();
124   bool HasAliasInEnvironments(HInstruction* instruction);
125 
126   HGraph* const graph_;
127   Handle<mirror::ClassLoader> class_loader_;
128   Handle<mirror::DexCache> dex_cache_;
129 
130   // True if types of ambiguous ArrayGets have been resolved.
131   bool agets_fixed_;
132 
133   ScopedArenaAllocator* const local_allocator_;
134   ScopedArenaVector<HArrayGet*> ambiguous_agets_;
135   ScopedArenaVector<HArraySet*> ambiguous_asets_;
136   ScopedArenaVector<HNewInstance*> uninitialized_strings_;
137   ScopedArenaVector<HInvoke*> uninitialized_string_phis_;
138 
139   DISALLOW_COPY_AND_ASSIGN(SsaBuilder);
140 };
141 
142 }  // namespace art
143 
144 #endif  // ART_COMPILER_OPTIMIZING_SSA_BUILDER_H_
145