blob: 20e42221bb60fa3bf89d3e65fde4176715f35995 [file] [log] [blame]
Elliott Hughes6c1a3942011-08-17 15:00:06 -07001/*
2 * Copyright (C) 2009 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
Mathieu Chartierc56057e2014-05-04 13:18:58 -070017#include "indirect_reference_table-inl.h"
18
Elliott Hughesa2501992011-08-26 19:39:54 -070019#include "jni_internal.h"
Elliott Hughes6c1a3942011-08-17 15:00:06 -070020#include "reference_table.h"
Elliott Hughesa2501992011-08-26 19:39:54 -070021#include "runtime.h"
Ian Rogers00f7d0e2012-07-19 15:28:27 -070022#include "scoped_thread_state_change.h"
Ian Rogers5a7a74a2011-09-26 16:32:29 -070023#include "thread.h"
Ian Rogerscdd1d2d2011-08-18 09:58:17 -070024#include "utils.h"
Mathieu Chartier6dda8982014-03-06 11:11:48 -080025#include "verify_object-inl.h"
Elliott Hughes6c1a3942011-08-17 15:00:06 -070026
27#include <cstdlib>
28
29namespace art {
30
Ian Rogers719d1a32014-03-06 12:13:39 -080031template<typename T>
32class MutatorLockedDumpable {
33 public:
34 explicit MutatorLockedDumpable(T& value)
35 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) : value_(value) {
36 }
37
38 void Dump(std::ostream& os) const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
39 value_.Dump(os);
40 }
41
42 private:
43 T& value_;
44
45 DISALLOW_COPY_AND_ASSIGN(MutatorLockedDumpable);
46};
47
48template<typename T>
49std::ostream& operator<<(std::ostream& os, const MutatorLockedDumpable<T>& rhs)
50// TODO: should be SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) however annotalysis
51// currently fails for this.
52 NO_THREAD_SAFETY_ANALYSIS {
53 rhs.Dump(os);
54 return os;
55}
56
Mathieu Chartierc56057e2014-05-04 13:18:58 -070057void IndirectReferenceTable::AbortIfNoCheckJNI() {
Elliott Hughesa2501992011-08-26 19:39:54 -070058 // If -Xcheck:jni is on, it'll give a more detailed error before aborting.
Ian Rogers68d8b422014-07-17 11:09:10 -070059 JavaVMExt* vm = Runtime::Current()->GetJavaVM();
60 if (!vm->IsCheckJniEnabled()) {
Elliott Hughesa2501992011-08-26 19:39:54 -070061 // Otherwise, we want to abort rather than hand back a bad reference.
62 LOG(FATAL) << "JNI ERROR (app bug): see above.";
63 }
Elliott Hughes6c1a3942011-08-17 15:00:06 -070064}
65
66IndirectReferenceTable::IndirectReferenceTable(size_t initialCount,
Andreas Gampe3f5881f2015-04-08 10:26:16 -070067 size_t maxCount, IndirectRefKind desiredKind,
68 bool abort_on_error)
Mathieu Chartier4838d662014-09-25 15:27:43 -070069 : kind_(desiredKind),
70 max_entries_(maxCount) {
Elliott Hughes6c1a3942011-08-17 15:00:06 -070071 CHECK_GT(initialCount, 0U);
72 CHECK_LE(initialCount, maxCount);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -070073 CHECK_NE(desiredKind, kHandleScopeOrInvalid);
Elliott Hughes6c1a3942011-08-17 15:00:06 -070074
Mathieu Chartierc56057e2014-05-04 13:18:58 -070075 std::string error_str;
Mathieu Chartier4838d662014-09-25 15:27:43 -070076 const size_t table_bytes = maxCount * sizeof(IrtEntry);
Mathieu Chartierc56057e2014-05-04 13:18:58 -070077 table_mem_map_.reset(MemMap::MapAnonymous("indirect ref table", nullptr, table_bytes,
Vladimir Marko5c42c292015-02-25 12:02:49 +000078 PROT_READ | PROT_WRITE, false, false, &error_str));
Andreas Gampe3f5881f2015-04-08 10:26:16 -070079 if (abort_on_error) {
80 CHECK(table_mem_map_.get() != nullptr) << error_str;
81 CHECK_EQ(table_mem_map_->Size(), table_bytes);
82 CHECK(table_mem_map_->Begin() != nullptr);
83 } else if (table_mem_map_.get() == nullptr ||
84 table_mem_map_->Size() != table_bytes ||
85 table_mem_map_->Begin() == nullptr) {
86 table_mem_map_.reset();
87 LOG(ERROR) << error_str;
88 return;
89 }
Mathieu Chartier4838d662014-09-25 15:27:43 -070090 table_ = reinterpret_cast<IrtEntry*>(table_mem_map_->Begin());
Ian Rogersdc51b792011-09-22 20:41:37 -070091 segment_state_.all = IRT_FIRST_SEGMENT;
Elliott Hughes6c1a3942011-08-17 15:00:06 -070092}
93
94IndirectReferenceTable::~IndirectReferenceTable() {
Elliott Hughes6c1a3942011-08-17 15:00:06 -070095}
96
Andreas Gampe3f5881f2015-04-08 10:26:16 -070097bool IndirectReferenceTable::IsValid() const {
98 return table_mem_map_.get() != nullptr;
99}
100
Mathieu Chartier423d2a32013-09-12 17:33:56 -0700101IndirectRef IndirectReferenceTable::Add(uint32_t cookie, mirror::Object* obj) {
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700102 IRTSegmentState prevState;
103 prevState.all = cookie;
Ian Rogersdc51b792011-09-22 20:41:37 -0700104 size_t topIndex = segment_state_.parts.topIndex;
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700105
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700106 CHECK(obj != nullptr);
Mathieu Chartier6dda8982014-03-06 11:11:48 -0800107 VerifyObject(obj);
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700108 DCHECK(table_ != nullptr);
Ian Rogersdc51b792011-09-22 20:41:37 -0700109 DCHECK_GE(segment_state_.parts.numHoles, prevState.parts.numHoles);
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700110
Mathieu Chartier4838d662014-09-25 15:27:43 -0700111 if (topIndex == max_entries_) {
112 LOG(FATAL) << "JNI ERROR (app bug): " << kind_ << " table overflow "
113 << "(max=" << max_entries_ << ")\n"
114 << MutatorLockedDumpable<IndirectReferenceTable>(*this);
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700115 }
116
Elliott Hughes73e66f72012-05-09 09:34:45 -0700117 // We know there's enough room in the table. Now we just need to find
118 // the right spot. If there's a hole, find it and fill it; otherwise,
119 // add to the end of the list.
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700120 IndirectRef result;
Ian Rogersdc51b792011-09-22 20:41:37 -0700121 int numHoles = segment_state_.parts.numHoles - prevState.parts.numHoles;
Mathieu Chartier4838d662014-09-25 15:27:43 -0700122 size_t index;
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700123 if (numHoles > 0) {
124 DCHECK_GT(topIndex, 1U);
Elliott Hughes73e66f72012-05-09 09:34:45 -0700125 // Find the first hole; likely to be near the end of the list.
Mathieu Chartier4838d662014-09-25 15:27:43 -0700126 IrtEntry* pScan = &table_[topIndex - 1];
127 DCHECK(!pScan->GetReference()->IsNull());
Hiroshi Yamauchi94f7b492014-07-22 18:08:23 -0700128 --pScan;
Mathieu Chartier4838d662014-09-25 15:27:43 -0700129 while (!pScan->GetReference()->IsNull()) {
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700130 DCHECK_GE(pScan, table_ + prevState.parts.topIndex);
Hiroshi Yamauchi94f7b492014-07-22 18:08:23 -0700131 --pScan;
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700132 }
Mathieu Chartier4838d662014-09-25 15:27:43 -0700133 index = pScan - table_;
Ian Rogersdc51b792011-09-22 20:41:37 -0700134 segment_state_.parts.numHoles--;
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700135 } else {
Elliott Hughes73e66f72012-05-09 09:34:45 -0700136 // Add to the end.
Mathieu Chartier4838d662014-09-25 15:27:43 -0700137 index = topIndex++;
Ian Rogersdc51b792011-09-22 20:41:37 -0700138 segment_state_.parts.topIndex = topIndex;
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700139 }
Mathieu Chartier4838d662014-09-25 15:27:43 -0700140 table_[index].Add(obj);
141 result = ToIndirectRef(index);
Ian Rogerscf7f1912014-10-22 22:06:39 -0700142 if ((false)) {
Ian Rogers5a7a74a2011-09-26 16:32:29 -0700143 LOG(INFO) << "+++ added at " << ExtractIndex(result) << " top=" << segment_state_.parts.topIndex
144 << " holes=" << segment_state_.parts.numHoles;
145 }
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700146
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700147 DCHECK(result != nullptr);
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700148 return result;
149}
150
Elliott Hughes726079d2011-10-07 18:43:44 -0700151void IndirectReferenceTable::AssertEmpty() {
Hiroshi Yamauchi8a741172014-09-08 13:22:56 -0700152 for (size_t i = 0; i < Capacity(); ++i) {
Mathieu Chartier4838d662014-09-25 15:27:43 -0700153 if (!table_[i].GetReference()->IsNull()) {
Hiroshi Yamauchi8a741172014-09-08 13:22:56 -0700154 ScopedObjectAccess soa(Thread::Current());
155 LOG(FATAL) << "Internal Error: non-empty local reference table\n"
156 << MutatorLockedDumpable<IndirectReferenceTable>(*this);
157 }
Elliott Hughes726079d2011-10-07 18:43:44 -0700158 }
159}
160
Elliott Hughes73e66f72012-05-09 09:34:45 -0700161// Removes an object. We extract the table offset bits from "iref"
162// and zap the corresponding entry, leaving a hole if it's not at the top.
163// If the entry is not between the current top index and the bottom index
164// specified by the cookie, we don't remove anything. This is the behavior
165// required by JNI's DeleteLocalRef function.
166// This method is not called when a local frame is popped; this is only used
167// for explicit single removals.
168// Returns "false" if nothing was removed.
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700169bool IndirectReferenceTable::Remove(uint32_t cookie, IndirectRef iref) {
170 IRTSegmentState prevState;
171 prevState.all = cookie;
Ian Rogersdc51b792011-09-22 20:41:37 -0700172 int topIndex = segment_state_.parts.topIndex;
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700173 int bottomIndex = prevState.parts.topIndex;
174
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700175 DCHECK(table_ != nullptr);
Ian Rogersdc51b792011-09-22 20:41:37 -0700176 DCHECK_GE(segment_state_.parts.numHoles, prevState.parts.numHoles);
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700177
Mathieu Chartierc5adebc2015-04-29 09:57:48 -0700178 if (GetIndirectRefKind(iref) == kHandleScopeOrInvalid) {
179 auto* self = Thread::Current();
180 if (self->HandleScopeContains(reinterpret_cast<jobject>(iref))) {
181 auto* env = self->GetJniEnv();
182 DCHECK(env != nullptr);
183 if (env->check_jni) {
Mathieu Chartier22c1caa2015-06-02 13:40:12 -0700184 ScopedObjectAccess soa(self);
185 LOG(WARNING) << "Attempt to remove non-JNI local reference, dumping thread";
186 self->Dump(LOG(WARNING));
Mathieu Chartierc5adebc2015-04-29 09:57:48 -0700187 }
188 return true;
189 }
Ian Rogers5a7a74a2011-09-26 16:32:29 -0700190 }
Mathieu Chartier91c2f0c2014-11-26 11:21:15 -0800191 const int idx = ExtractIndex(iref);
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700192 if (idx < bottomIndex) {
Elliott Hughes726079d2011-10-07 18:43:44 -0700193 // Wrong segment.
194 LOG(WARNING) << "Attempt to remove index outside index area (" << idx
195 << " vs " << bottomIndex << "-" << topIndex << ")";
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700196 return false;
197 }
198 if (idx >= topIndex) {
Elliott Hughes726079d2011-10-07 18:43:44 -0700199 // Bad --- stale reference?
200 LOG(WARNING) << "Attempt to remove invalid index " << idx
201 << " (bottom=" << bottomIndex << " top=" << topIndex << ")";
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700202 return false;
203 }
204
Mathieu Chartier4838d662014-09-25 15:27:43 -0700205 if (idx == topIndex - 1) {
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700206 // Top-most entry. Scan up and consume holes.
207
Ian Rogers987560f2014-04-22 11:42:59 -0700208 if (!CheckEntry("remove", iref, idx)) {
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700209 return false;
210 }
211
Mathieu Chartier4838d662014-09-25 15:27:43 -0700212 *table_[idx].GetReference() = GcRoot<mirror::Object>(nullptr);
Ian Rogersdc51b792011-09-22 20:41:37 -0700213 int numHoles = segment_state_.parts.numHoles - prevState.parts.numHoles;
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700214 if (numHoles != 0) {
215 while (--topIndex > bottomIndex && numHoles != 0) {
Ian Rogerscf7f1912014-10-22 22:06:39 -0700216 if ((false)) {
Mathieu Chartier4838d662014-09-25 15:27:43 -0700217 LOG(INFO) << "+++ checking for hole at " << topIndex - 1
Hiroshi Yamauchi94f7b492014-07-22 18:08:23 -0700218 << " (cookie=" << cookie << ") val="
Mathieu Chartier4838d662014-09-25 15:27:43 -0700219 << table_[topIndex - 1].GetReference()->Read<kWithoutReadBarrier>();
Ian Rogers5a7a74a2011-09-26 16:32:29 -0700220 }
Mathieu Chartier4838d662014-09-25 15:27:43 -0700221 if (!table_[topIndex - 1].GetReference()->IsNull()) {
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700222 break;
223 }
Ian Rogerscf7f1912014-10-22 22:06:39 -0700224 if ((false)) {
Ian Rogers5a7a74a2011-09-26 16:32:29 -0700225 LOG(INFO) << "+++ ate hole at " << (topIndex - 1);
226 }
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700227 numHoles--;
228 }
Ian Rogersdc51b792011-09-22 20:41:37 -0700229 segment_state_.parts.numHoles = numHoles + prevState.parts.numHoles;
230 segment_state_.parts.topIndex = topIndex;
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700231 } else {
Ian Rogersdc51b792011-09-22 20:41:37 -0700232 segment_state_.parts.topIndex = topIndex-1;
Ian Rogerscf7f1912014-10-22 22:06:39 -0700233 if ((false)) {
Ian Rogers5a7a74a2011-09-26 16:32:29 -0700234 LOG(INFO) << "+++ ate last entry " << topIndex - 1;
235 }
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700236 }
237 } else {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700238 // Not the top-most entry. This creates a hole. We null out the entry to prevent somebody
239 // from deleting it twice and screwing up the hole count.
Mathieu Chartier4838d662014-09-25 15:27:43 -0700240 if (table_[idx].GetReference()->IsNull()) {
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700241 LOG(INFO) << "--- WEIRD: removing null entry " << idx;
242 return false;
243 }
Ian Rogers987560f2014-04-22 11:42:59 -0700244 if (!CheckEntry("remove", iref, idx)) {
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700245 return false;
246 }
247
Mathieu Chartier4838d662014-09-25 15:27:43 -0700248 *table_[idx].GetReference() = GcRoot<mirror::Object>(nullptr);
Ian Rogersdc51b792011-09-22 20:41:37 -0700249 segment_state_.parts.numHoles++;
Ian Rogerscf7f1912014-10-22 22:06:39 -0700250 if ((false)) {
Ian Rogers5a7a74a2011-09-26 16:32:29 -0700251 LOG(INFO) << "+++ left hole at " << idx << ", holes=" << segment_state_.parts.numHoles;
252 }
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700253 }
254
255 return true;
256}
257
Mathieu Chartier91c2f0c2014-11-26 11:21:15 -0800258void IndirectReferenceTable::Trim() {
259 const size_t top_index = Capacity();
260 auto* release_start = AlignUp(reinterpret_cast<uint8_t*>(&table_[top_index]), kPageSize);
261 uint8_t* release_end = table_mem_map_->End();
262 madvise(release_start, release_end - release_start, MADV_DONTNEED);
263}
264
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -0700265void IndirectReferenceTable::VisitRoots(RootVisitor* visitor, const RootInfo& root_info) {
Mathieu Chartier4809d0a2015-04-07 10:39:04 -0700266 BufferedRootVisitor<kDefaultBufferedRootCount> root_visitor(visitor, root_info);
Mathieu Chartier02e25112013-08-14 16:14:24 -0700267 for (auto ref : *this) {
Mathieu Chartier9086b652015-04-14 09:35:18 -0700268 if (!ref->IsNull()) {
269 root_visitor.VisitRoot(*ref);
270 DCHECK(!ref->IsNull());
271 }
Elliott Hughes410c0c82011-09-01 17:58:25 -0700272 }
273}
274
Elliott Hughes73e66f72012-05-09 09:34:45 -0700275void IndirectReferenceTable::Dump(std::ostream& os) const {
276 os << kind_ << " table dump:\n";
Hiroshi Yamauchi196851b2014-05-29 12:16:04 -0700277 ReferenceTable::Table entries;
278 for (size_t i = 0; i < Capacity(); ++i) {
Mathieu Chartier4838d662014-09-25 15:27:43 -0700279 mirror::Object* obj = table_[i].GetReference()->Read<kWithoutReadBarrier>();
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700280 if (obj != nullptr) {
Mathieu Chartier4838d662014-09-25 15:27:43 -0700281 obj = table_[i].GetReference()->Read();
Hiroshi Yamauchi94f7b492014-07-22 18:08:23 -0700282 entries.push_back(GcRoot<mirror::Object>(obj));
Ian Rogers63818dc2012-09-26 12:23:04 -0700283 }
284 }
Elliott Hughes73e66f72012-05-09 09:34:45 -0700285 ReferenceTable::Dump(os, entries);
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700286}
287
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700288} // namespace art