Elliott Hughes | 2faa5f1 | 2012-01-30 14:42:07 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2011 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 | */ |
Brian Carlstrom | 7e93b50 | 2011-08-04 14:16:22 -0700 | [diff] [blame] | 16 | |
Brian Carlstrom | fc0e321 | 2013-07-17 14:40:12 -0700 | [diff] [blame] | 17 | #ifndef ART_RUNTIME_INTERN_TABLE_H_ |
| 18 | #define ART_RUNTIME_INTERN_TABLE_H_ |
Brian Carlstrom | 7e93b50 | 2011-08-04 14:16:22 -0700 | [diff] [blame] | 19 | |
Mathieu Chartier | cdfd39f | 2014-08-29 18:16:58 -0700 | [diff] [blame] | 20 | #include <unordered_set> |
Brian Carlstrom | 7e93b50 | 2011-08-04 14:16:22 -0700 | [diff] [blame] | 21 | |
Mathieu Chartier | bad0267 | 2014-08-25 13:08:22 -0700 | [diff] [blame] | 22 | #include "base/allocator.h" |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 23 | #include "base/mutex.h" |
Hiroshi Yamauchi | 94f7b49 | 2014-07-22 18:08:23 -0700 | [diff] [blame] | 24 | #include "gc_root.h" |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 25 | #include "object_callbacks.h" |
| 26 | |
Brian Carlstrom | 7e93b50 | 2011-08-04 14:16:22 -0700 | [diff] [blame] | 27 | namespace art { |
Mathieu Chartier | 893263b | 2014-03-04 11:07:42 -0800 | [diff] [blame] | 28 | |
Mathieu Chartier | eb175f7 | 2014-10-31 11:49:27 -0700 | [diff] [blame^] | 29 | namespace gc { |
| 30 | namespace space { |
| 31 | class ImageSpace; |
| 32 | } // namespace space |
| 33 | } // namespace gc |
| 34 | |
Mathieu Chartier | 893263b | 2014-03-04 11:07:42 -0800 | [diff] [blame] | 35 | enum VisitRootFlags : uint8_t; |
| 36 | |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 37 | namespace mirror { |
| 38 | class String; |
| 39 | } // namespace mirror |
Sebastien Hertz | d2fe10a | 2014-01-15 10:20:56 +0100 | [diff] [blame] | 40 | class Transaction; |
Brian Carlstrom | 7e93b50 | 2011-08-04 14:16:22 -0700 | [diff] [blame] | 41 | |
Elliott Hughes | cf4c6c4 | 2011-09-01 15:16:42 -0700 | [diff] [blame] | 42 | /** |
| 43 | * Used to intern strings. |
| 44 | * |
| 45 | * There are actually two tables: one that holds strong references to its strings, and one that |
| 46 | * holds weak references. The former is used for string literals, for which there is an effective |
| 47 | * reference from the constant pool. The latter is used for strings interned at runtime via |
| 48 | * String.intern. Some code (XML parsers being a prime example) relies on being able to intern |
| 49 | * arbitrarily many strings for the duration of a parse without permanently increasing the memory |
| 50 | * footprint. |
| 51 | */ |
Brian Carlstrom | 7e93b50 | 2011-08-04 14:16:22 -0700 | [diff] [blame] | 52 | class InternTable { |
| 53 | public: |
| 54 | InternTable(); |
Brian Carlstrom | a663ea5 | 2011-08-19 23:33:41 -0700 | [diff] [blame] | 55 | |
Elliott Hughes | cf4c6c4 | 2011-09-01 15:16:42 -0700 | [diff] [blame] | 56 | // Interns a potentially new string in the 'strong' table. (See above.) |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 57 | mirror::String* InternStrong(int32_t utf16_length, const char* utf8_data) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 58 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Brian Carlstrom | c74255f | 2011-09-11 22:47:39 -0700 | [diff] [blame] | 59 | |
| 60 | // Interns a potentially new string in the 'strong' table. (See above.) |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 61 | mirror::String* InternStrong(const char* utf8_data) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 62 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Brian Carlstrom | c74255f | 2011-09-11 22:47:39 -0700 | [diff] [blame] | 63 | |
| 64 | // Interns a potentially new string in the 'strong' table. (See above.) |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 65 | mirror::String* InternStrong(mirror::String* s) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Brian Carlstrom | a663ea5 | 2011-08-19 23:33:41 -0700 | [diff] [blame] | 66 | |
Elliott Hughes | cf4c6c4 | 2011-09-01 15:16:42 -0700 | [diff] [blame] | 67 | // Interns a potentially new string in the 'weak' table. (See above.) |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 68 | mirror::String* InternWeak(mirror::String* s) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Elliott Hughes | cf4c6c4 | 2011-09-01 15:16:42 -0700 | [diff] [blame] | 69 | |
Hiroshi Yamauchi | 94f7b49 | 2014-07-22 18:08:23 -0700 | [diff] [blame] | 70 | void SweepInternTableWeaks(IsMarkedCallback* callback, void* arg) |
| 71 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Elliott Hughes | cf4c6c4 | 2011-09-01 15:16:42 -0700 | [diff] [blame] | 72 | |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 73 | bool ContainsWeak(mirror::String* s) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Brian Carlstrom | a663ea5 | 2011-08-19 23:33:41 -0700 | [diff] [blame] | 74 | |
Mathieu Chartier | eb175f7 | 2014-10-31 11:49:27 -0700 | [diff] [blame^] | 75 | // Total number of interned strings. |
| 76 | size_t Size() const LOCKS_EXCLUDED(Locks::intern_table_lock_); |
| 77 | // Total number of weakly live interned strings. |
| 78 | size_t StrongSize() const LOCKS_EXCLUDED(Locks::intern_table_lock_); |
| 79 | // Total number of strongly live interned strings. |
| 80 | size_t WeakSize() const LOCKS_EXCLUDED(Locks::intern_table_lock_); |
Elliott Hughes | cf4c6c4 | 2011-09-01 15:16:42 -0700 | [diff] [blame] | 81 | |
Hiroshi Yamauchi | 94f7b49 | 2014-07-22 18:08:23 -0700 | [diff] [blame] | 82 | void VisitRoots(RootCallback* callback, void* arg, VisitRootFlags flags) |
| 83 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Brian Carlstrom | 7e93b50 | 2011-08-04 14:16:22 -0700 | [diff] [blame] | 84 | |
Elliott Hughes | cac6cc7 | 2011-11-03 20:31:21 -0700 | [diff] [blame] | 85 | void DumpForSigQuit(std::ostream& os) const; |
| 86 | |
Mathieu Chartier | c11d9b8 | 2013-09-19 10:01:59 -0700 | [diff] [blame] | 87 | void DisallowNewInterns() EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 88 | void AllowNewInterns() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 89 | |
Mathieu Chartier | eb175f7 | 2014-10-31 11:49:27 -0700 | [diff] [blame^] | 90 | // Adds all of the resolved image strings from the image space into the intern table. The |
| 91 | // advantage of doing this is preventing expensive DexFile::FindStringId calls. |
| 92 | void AddImageStringsToTable(gc::space::ImageSpace* image_space) |
| 93 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) LOCKS_EXCLUDED(Locks::intern_table_lock_); |
| 94 | // Copy the post zygote tables to pre zygote to save memory by preventing dirty pages. |
| 95 | void SwapPostZygoteWithPreZygote() |
| 96 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) LOCKS_EXCLUDED(Locks::intern_table_lock_); |
| 97 | |
Brian Carlstrom | 7e93b50 | 2011-08-04 14:16:22 -0700 | [diff] [blame] | 98 | private: |
Mathieu Chartier | cdfd39f | 2014-08-29 18:16:58 -0700 | [diff] [blame] | 99 | class StringHashEquals { |
| 100 | public: |
| 101 | std::size_t operator()(const GcRoot<mirror::String>& root) NO_THREAD_SAFETY_ANALYSIS; |
| 102 | bool operator()(const GcRoot<mirror::String>& a, const GcRoot<mirror::String>& b) |
| 103 | NO_THREAD_SAFETY_ANALYSIS; |
| 104 | }; |
Mathieu Chartier | eb175f7 | 2014-10-31 11:49:27 -0700 | [diff] [blame^] | 105 | |
| 106 | // Table which holds pre zygote and post zygote interned strings. There is one instance for |
| 107 | // weak interns and strong interns. |
| 108 | class Table { |
| 109 | public: |
| 110 | mirror::String* Find(mirror::String* s) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
| 111 | EXCLUSIVE_LOCKS_REQUIRED(Locks::intern_table_lock_); |
| 112 | void Insert(mirror::String* s) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
| 113 | EXCLUSIVE_LOCKS_REQUIRED(Locks::intern_table_lock_); |
| 114 | void Remove(mirror::String* s) |
| 115 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
| 116 | EXCLUSIVE_LOCKS_REQUIRED(Locks::intern_table_lock_); |
| 117 | void VisitRoots(RootCallback* callback, void* arg, VisitRootFlags flags) |
| 118 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
| 119 | EXCLUSIVE_LOCKS_REQUIRED(Locks::intern_table_lock_); |
| 120 | void SweepWeaks(IsMarkedCallback* callback, void* arg) |
| 121 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
| 122 | EXCLUSIVE_LOCKS_REQUIRED(Locks::intern_table_lock_); |
| 123 | void SwapPostZygoteWithPreZygote() EXCLUSIVE_LOCKS_REQUIRED(Locks::intern_table_lock_); |
| 124 | size_t Size() const EXCLUSIVE_LOCKS_REQUIRED(Locks::intern_table_lock_) { |
| 125 | return pre_zygote_table_.size() + post_zygote_table_.size(); |
| 126 | } |
| 127 | |
| 128 | private: |
| 129 | typedef std::unordered_set<GcRoot<mirror::String>, StringHashEquals, StringHashEquals, |
| 130 | TrackingAllocator<GcRoot<mirror::String>, kAllocatorTagInternTable>> UnorderedSet; |
| 131 | |
| 132 | void SweepWeaks(UnorderedSet* set, IsMarkedCallback* callback, void* arg) |
| 133 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
| 134 | EXCLUSIVE_LOCKS_REQUIRED(Locks::intern_table_lock_); |
| 135 | |
| 136 | // We call SwapPostZygoteWithPreZygote when we create the zygote to reduce private dirty pages |
| 137 | // caused by modifying the zygote intern table hash table. The pre zygote table are the |
| 138 | // interned strings which were interned before we created the zygote space. Post zygote is self |
| 139 | // explanatory. |
| 140 | UnorderedSet pre_zygote_table_; |
| 141 | UnorderedSet post_zygote_table_; |
| 142 | }; |
Elliott Hughes | cf4c6c4 | 2011-09-01 15:16:42 -0700 | [diff] [blame] | 143 | |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 144 | mirror::String* Insert(mirror::String* s, bool is_strong) |
Sebastien Hertz | d2fe10a | 2014-01-15 10:20:56 +0100 | [diff] [blame] | 145 | LOCKS_EXCLUDED(Locks::intern_table_lock_) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 146 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Elliott Hughes | cf4c6c4 | 2011-09-01 15:16:42 -0700 | [diff] [blame] | 147 | |
Mathieu Chartier | cdfd39f | 2014-08-29 18:16:58 -0700 | [diff] [blame] | 148 | mirror::String* LookupStrong(mirror::String* s) |
Mathieu Chartier | eb175f7 | 2014-10-31 11:49:27 -0700 | [diff] [blame^] | 149 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
| 150 | EXCLUSIVE_LOCKS_REQUIRED(Locks::intern_table_lock_); |
Mathieu Chartier | cdfd39f | 2014-08-29 18:16:58 -0700 | [diff] [blame] | 151 | mirror::String* LookupWeak(mirror::String* s) |
Mathieu Chartier | eb175f7 | 2014-10-31 11:49:27 -0700 | [diff] [blame^] | 152 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
| 153 | EXCLUSIVE_LOCKS_REQUIRED(Locks::intern_table_lock_); |
Mathieu Chartier | cdfd39f | 2014-08-29 18:16:58 -0700 | [diff] [blame] | 154 | mirror::String* InsertStrong(mirror::String* s) |
Mathieu Chartier | eb175f7 | 2014-10-31 11:49:27 -0700 | [diff] [blame^] | 155 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
Sebastien Hertz | d2fe10a | 2014-01-15 10:20:56 +0100 | [diff] [blame] | 156 | EXCLUSIVE_LOCKS_REQUIRED(Locks::intern_table_lock_); |
Mathieu Chartier | cdfd39f | 2014-08-29 18:16:58 -0700 | [diff] [blame] | 157 | mirror::String* InsertWeak(mirror::String* s) |
Mathieu Chartier | eb175f7 | 2014-10-31 11:49:27 -0700 | [diff] [blame^] | 158 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
Sebastien Hertz | d2fe10a | 2014-01-15 10:20:56 +0100 | [diff] [blame] | 159 | EXCLUSIVE_LOCKS_REQUIRED(Locks::intern_table_lock_); |
Mathieu Chartier | cdfd39f | 2014-08-29 18:16:58 -0700 | [diff] [blame] | 160 | void RemoveStrong(mirror::String* s) |
Hiroshi Yamauchi | 1bd4872 | 2014-05-23 19:58:15 -0700 | [diff] [blame] | 161 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
Sebastien Hertz | d2fe10a | 2014-01-15 10:20:56 +0100 | [diff] [blame] | 162 | EXCLUSIVE_LOCKS_REQUIRED(Locks::intern_table_lock_); |
Mathieu Chartier | cdfd39f | 2014-08-29 18:16:58 -0700 | [diff] [blame] | 163 | void RemoveWeak(mirror::String* s) |
Hiroshi Yamauchi | 1bd4872 | 2014-05-23 19:58:15 -0700 | [diff] [blame] | 164 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
| 165 | EXCLUSIVE_LOCKS_REQUIRED(Locks::intern_table_lock_); |
Elliott Hughes | cf4c6c4 | 2011-09-01 15:16:42 -0700 | [diff] [blame] | 166 | |
Sebastien Hertz | d2fe10a | 2014-01-15 10:20:56 +0100 | [diff] [blame] | 167 | // Transaction rollback access. |
Mathieu Chartier | eb175f7 | 2014-10-31 11:49:27 -0700 | [diff] [blame^] | 168 | mirror::String* LookupStringFromImage(mirror::String* s) |
| 169 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
| 170 | EXCLUSIVE_LOCKS_REQUIRED(Locks::intern_table_lock_); |
Mathieu Chartier | cdfd39f | 2014-08-29 18:16:58 -0700 | [diff] [blame] | 171 | mirror::String* InsertStrongFromTransaction(mirror::String* s) |
Mathieu Chartier | eb175f7 | 2014-10-31 11:49:27 -0700 | [diff] [blame^] | 172 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
Sebastien Hertz | d2fe10a | 2014-01-15 10:20:56 +0100 | [diff] [blame] | 173 | EXCLUSIVE_LOCKS_REQUIRED(Locks::intern_table_lock_); |
Mathieu Chartier | cdfd39f | 2014-08-29 18:16:58 -0700 | [diff] [blame] | 174 | mirror::String* InsertWeakFromTransaction(mirror::String* s) |
Mathieu Chartier | eb175f7 | 2014-10-31 11:49:27 -0700 | [diff] [blame^] | 175 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
Sebastien Hertz | d2fe10a | 2014-01-15 10:20:56 +0100 | [diff] [blame] | 176 | EXCLUSIVE_LOCKS_REQUIRED(Locks::intern_table_lock_); |
Mathieu Chartier | cdfd39f | 2014-08-29 18:16:58 -0700 | [diff] [blame] | 177 | void RemoveStrongFromTransaction(mirror::String* s) |
Hiroshi Yamauchi | 1bd4872 | 2014-05-23 19:58:15 -0700 | [diff] [blame] | 178 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
Sebastien Hertz | d2fe10a | 2014-01-15 10:20:56 +0100 | [diff] [blame] | 179 | EXCLUSIVE_LOCKS_REQUIRED(Locks::intern_table_lock_); |
Mathieu Chartier | cdfd39f | 2014-08-29 18:16:58 -0700 | [diff] [blame] | 180 | void RemoveWeakFromTransaction(mirror::String* s) |
Hiroshi Yamauchi | 1bd4872 | 2014-05-23 19:58:15 -0700 | [diff] [blame] | 181 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
Sebastien Hertz | d2fe10a | 2014-01-15 10:20:56 +0100 | [diff] [blame] | 182 | EXCLUSIVE_LOCKS_REQUIRED(Locks::intern_table_lock_); |
| 183 | friend class Transaction; |
| 184 | |
Mathieu Chartier | eb175f7 | 2014-10-31 11:49:27 -0700 | [diff] [blame^] | 185 | bool image_added_to_intern_table_ GUARDED_BY(Locks::intern_table_lock_); |
Mathieu Chartier | 893263b | 2014-03-04 11:07:42 -0800 | [diff] [blame] | 186 | bool log_new_roots_ GUARDED_BY(Locks::intern_table_lock_); |
Sebastien Hertz | d2fe10a | 2014-01-15 10:20:56 +0100 | [diff] [blame] | 187 | bool allow_new_interns_ GUARDED_BY(Locks::intern_table_lock_); |
| 188 | ConditionVariable new_intern_condition_ GUARDED_BY(Locks::intern_table_lock_); |
Hiroshi Yamauchi | a91a4bc | 2014-06-13 16:44:55 -0700 | [diff] [blame] | 189 | // Since this contains (strong) roots, they need a read barrier to |
| 190 | // enable concurrent intern table (strong) root scan. Do not |
| 191 | // directly access the strings in it. Use functions that contain |
| 192 | // read barriers. |
Sebastien Hertz | d2fe10a | 2014-01-15 10:20:56 +0100 | [diff] [blame] | 193 | Table strong_interns_ GUARDED_BY(Locks::intern_table_lock_); |
Mathieu Chartier | cdfd39f | 2014-08-29 18:16:58 -0700 | [diff] [blame] | 194 | std::vector<GcRoot<mirror::String>> new_strong_intern_roots_ |
Mathieu Chartier | 893263b | 2014-03-04 11:07:42 -0800 | [diff] [blame] | 195 | GUARDED_BY(Locks::intern_table_lock_); |
Hiroshi Yamauchi | a91a4bc | 2014-06-13 16:44:55 -0700 | [diff] [blame] | 196 | // Since this contains (weak) roots, they need a read barrier. Do |
| 197 | // not directly access the strings in it. Use functions that contain |
| 198 | // read barriers. |
Sebastien Hertz | d2fe10a | 2014-01-15 10:20:56 +0100 | [diff] [blame] | 199 | Table weak_interns_ GUARDED_BY(Locks::intern_table_lock_); |
Brian Carlstrom | 7e93b50 | 2011-08-04 14:16:22 -0700 | [diff] [blame] | 200 | }; |
| 201 | |
| 202 | } // namespace art |
| 203 | |
Brian Carlstrom | fc0e321 | 2013-07-17 14:40:12 -0700 | [diff] [blame] | 204 | #endif // ART_RUNTIME_INTERN_TABLE_H_ |