196fd51d52de759be442accd4df99eb2520bdd023Aart Bik/* 296fd51d52de759be442accd4df99eb2520bdd023Aart Bik * Copyright (C) 2016 The Android Open Source Project 396fd51d52de759be442accd4df99eb2520bdd023Aart Bik * 496fd51d52de759be442accd4df99eb2520bdd023Aart Bik * Licensed under the Apache License, Version 2.0 (the "License"); 596fd51d52de759be442accd4df99eb2520bdd023Aart Bik * you may not use this file except in compliance with the License. 696fd51d52de759be442accd4df99eb2520bdd023Aart Bik * You may obtain a copy of the License at 796fd51d52de759be442accd4df99eb2520bdd023Aart Bik * 896fd51d52de759be442accd4df99eb2520bdd023Aart Bik * http://www.apache.org/licenses/LICENSE-2.0 996fd51d52de759be442accd4df99eb2520bdd023Aart Bik * 1096fd51d52de759be442accd4df99eb2520bdd023Aart Bik * Unless required by applicable law or agreed to in writing, software 1196fd51d52de759be442accd4df99eb2520bdd023Aart Bik * distributed under the License is distributed on an "AS IS" BASIS, 1296fd51d52de759be442accd4df99eb2520bdd023Aart Bik * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1396fd51d52de759be442accd4df99eb2520bdd023Aart Bik * See the License for the specific language governing permissions and 1496fd51d52de759be442accd4df99eb2520bdd023Aart Bik * limitations under the License. 1596fd51d52de759be442accd4df99eb2520bdd023Aart Bik */ 1696fd51d52de759be442accd4df99eb2520bdd023Aart Bik 1796fd51d52de759be442accd4df99eb2520bdd023Aart Bik#include "escape.h" 1896fd51d52de759be442accd4df99eb2520bdd023Aart Bik 1996fd51d52de759be442accd4df99eb2520bdd023Aart Bik#include "nodes.h" 2096fd51d52de759be442accd4df99eb2520bdd023Aart Bik 2196fd51d52de759be442accd4df99eb2520bdd023Aart Biknamespace art { 2296fd51d52de759be442accd4df99eb2520bdd023Aart Bik 2396fd51d52de759be442accd4df99eb2520bdd023Aart Bikvoid CalculateEscape(HInstruction* reference, 2496fd51d52de759be442accd4df99eb2520bdd023Aart Bik bool (*no_escape)(HInstruction*, HInstruction*), 2596fd51d52de759be442accd4df99eb2520bdd023Aart Bik /*out*/ bool* is_singleton, 2671bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik /*out*/ bool* is_singleton_and_not_returned, 2771bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik /*out*/ bool* is_singleton_and_not_deopt_visible) { 2896fd51d52de759be442accd4df99eb2520bdd023Aart Bik // For references not allocated in the method, don't assume anything. 2996fd51d52de759be442accd4df99eb2520bdd023Aart Bik if (!reference->IsNewInstance() && !reference->IsNewArray()) { 3096fd51d52de759be442accd4df99eb2520bdd023Aart Bik *is_singleton = false; 3171bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik *is_singleton_and_not_returned = false; 3271bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik *is_singleton_and_not_deopt_visible = false; 3396fd51d52de759be442accd4df99eb2520bdd023Aart Bik return; 3496fd51d52de759be442accd4df99eb2520bdd023Aart Bik } 3596fd51d52de759be442accd4df99eb2520bdd023Aart Bik // Assume the best until proven otherwise. 3696fd51d52de759be442accd4df99eb2520bdd023Aart Bik *is_singleton = true; 3771bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik *is_singleton_and_not_returned = true; 3871bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik *is_singleton_and_not_deopt_visible = true; 39025c1a69ea548f1477d160bd477364336109078aMingyao Yang 40025c1a69ea548f1477d160bd477364336109078aMingyao Yang if (reference->IsNewInstance() && reference->AsNewInstance()->IsFinalizable()) { 41025c1a69ea548f1477d160bd477364336109078aMingyao Yang // Finalizable reference is treated as being returned in the end. 42025c1a69ea548f1477d160bd477364336109078aMingyao Yang *is_singleton_and_not_returned = false; 43025c1a69ea548f1477d160bd477364336109078aMingyao Yang } 44025c1a69ea548f1477d160bd477364336109078aMingyao Yang 4596fd51d52de759be442accd4df99eb2520bdd023Aart Bik // Visit all uses to determine if this reference can escape into the heap, 4696fd51d52de759be442accd4df99eb2520bdd023Aart Bik // a method call, an alias, etc. 4796fd51d52de759be442accd4df99eb2520bdd023Aart Bik for (const HUseListNode<HInstruction*>& use : reference->GetUses()) { 4896fd51d52de759be442accd4df99eb2520bdd023Aart Bik HInstruction* user = use.GetUser(); 4996fd51d52de759be442accd4df99eb2520bdd023Aart Bik if (no_escape != nullptr && (*no_escape)(reference, user)) { 5096fd51d52de759be442accd4df99eb2520bdd023Aart Bik // Client supplied analysis says there is no escape. 5196fd51d52de759be442accd4df99eb2520bdd023Aart Bik continue; 5296fd51d52de759be442accd4df99eb2520bdd023Aart Bik } else if (user->IsBoundType() || user->IsNullCheck()) { 5396fd51d52de759be442accd4df99eb2520bdd023Aart Bik // BoundType shouldn't normally be necessary for an allocation. Just be conservative 5496fd51d52de759be442accd4df99eb2520bdd023Aart Bik // for the uncommon cases. Similarly, null checks are eventually eliminated for explicit 5596fd51d52de759be442accd4df99eb2520bdd023Aart Bik // allocations, but if we see one before it is simplified, assume an alias. 5696fd51d52de759be442accd4df99eb2520bdd023Aart Bik *is_singleton = false; 5771bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik *is_singleton_and_not_returned = false; 5871bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik *is_singleton_and_not_deopt_visible = false; 5996fd51d52de759be442accd4df99eb2520bdd023Aart Bik return; 60293f1c006cc283345630ea38266f3ee38b624d5dMingyao Yang } else if (user->IsPhi() || 61293f1c006cc283345630ea38266f3ee38b624d5dMingyao Yang user->IsSelect() || 62293f1c006cc283345630ea38266f3ee38b624d5dMingyao Yang (user->IsInvoke() && user->GetSideEffects().DoesAnyWrite()) || 6396fd51d52de759be442accd4df99eb2520bdd023Aart Bik (user->IsInstanceFieldSet() && (reference == user->InputAt(1))) || 6496fd51d52de759be442accd4df99eb2520bdd023Aart Bik (user->IsUnresolvedInstanceFieldSet() && (reference == user->InputAt(1))) || 6596fd51d52de759be442accd4df99eb2520bdd023Aart Bik (user->IsStaticFieldSet() && (reference == user->InputAt(1))) || 6696fd51d52de759be442accd4df99eb2520bdd023Aart Bik (user->IsUnresolvedStaticFieldSet() && (reference == user->InputAt(0))) || 6796fd51d52de759be442accd4df99eb2520bdd023Aart Bik (user->IsArraySet() && (reference == user->InputAt(2)))) { 6896fd51d52de759be442accd4df99eb2520bdd023Aart Bik // The reference is merged to HPhi/HSelect, passed to a callee, or stored to heap. 6996fd51d52de759be442accd4df99eb2520bdd023Aart Bik // Hence, the reference is no longer the only name that can refer to its value. 7096fd51d52de759be442accd4df99eb2520bdd023Aart Bik *is_singleton = false; 7171bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik *is_singleton_and_not_returned = false; 7271bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik *is_singleton_and_not_deopt_visible = false; 7396fd51d52de759be442accd4df99eb2520bdd023Aart Bik return; 7496fd51d52de759be442accd4df99eb2520bdd023Aart Bik } else if ((user->IsUnresolvedInstanceFieldGet() && (reference == user->InputAt(0))) || 7596fd51d52de759be442accd4df99eb2520bdd023Aart Bik (user->IsUnresolvedInstanceFieldSet() && (reference == user->InputAt(0)))) { 7696fd51d52de759be442accd4df99eb2520bdd023Aart Bik // The field is accessed in an unresolved way. We mark the object as a non-singleton. 7796fd51d52de759be442accd4df99eb2520bdd023Aart Bik // Note that we could optimize this case and still perform some optimizations until 7896fd51d52de759be442accd4df99eb2520bdd023Aart Bik // we hit the unresolved access, but the conservative assumption is the simplest. 7996fd51d52de759be442accd4df99eb2520bdd023Aart Bik *is_singleton = false; 8071bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik *is_singleton_and_not_returned = false; 8171bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik *is_singleton_and_not_deopt_visible = false; 8296fd51d52de759be442accd4df99eb2520bdd023Aart Bik return; 8396fd51d52de759be442accd4df99eb2520bdd023Aart Bik } else if (user->IsReturn()) { 8471bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik *is_singleton_and_not_returned = false; 8596fd51d52de759be442accd4df99eb2520bdd023Aart Bik } 8696fd51d52de759be442accd4df99eb2520bdd023Aart Bik } 8796fd51d52de759be442accd4df99eb2520bdd023Aart Bik 8871bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik // Look at the environment uses if it's for HDeoptimize. Other environment uses are fine, 8971bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik // as long as client optimizations that rely on this information are disabled for debuggable. 9096fd51d52de759be442accd4df99eb2520bdd023Aart Bik for (const HUseListNode<HEnvironment*>& use : reference->GetEnvUses()) { 9196fd51d52de759be442accd4df99eb2520bdd023Aart Bik HEnvironment* user = use.GetUser(); 9296fd51d52de759be442accd4df99eb2520bdd023Aart Bik if (user->GetHolder()->IsDeoptimize()) { 9371bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik *is_singleton_and_not_deopt_visible = false; 9496fd51d52de759be442accd4df99eb2520bdd023Aart Bik break; 9596fd51d52de759be442accd4df99eb2520bdd023Aart Bik } 9696fd51d52de759be442accd4df99eb2520bdd023Aart Bik } 9796fd51d52de759be442accd4df99eb2520bdd023Aart Bik} 9896fd51d52de759be442accd4df99eb2520bdd023Aart Bik 9971bf7b43380eb445973f32a7f789d9670f8cc97dAart Bikbool DoesNotEscape(HInstruction* reference, bool (*no_escape)(HInstruction*, HInstruction*)) { 10071bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik bool is_singleton = false; 10171bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik bool is_singleton_and_not_returned = false; 10271bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik bool is_singleton_and_not_deopt_visible = false; // not relevant for escape 10371bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik CalculateEscape(reference, 10471bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik no_escape, 10571bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik &is_singleton, 10671bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik &is_singleton_and_not_returned, 10771bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik &is_singleton_and_not_deopt_visible); 10871bf7b43380eb445973f32a7f789d9670f8cc97dAart Bik return is_singleton_and_not_returned; 10996fd51d52de759be442accd4df99eb2520bdd023Aart Bik} 11096fd51d52de759be442accd4df99eb2520bdd023Aart Bik 11196fd51d52de759be442accd4df99eb2520bdd023Aart Bik} // namespace art 112