blob: c9ba6cfada3c0b082587020de0d88ee66c3acad2 [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
Mathieu Chartier5f684fd2015-07-30 11:41:04 -070031static constexpr bool kDumpStackOnNonLocalReference = false;
32
Ian Rogers719d1a32014-03-06 12:13:39 -080033template<typename T>
34class MutatorLockedDumpable {
35 public:
36 explicit MutatorLockedDumpable(T& value)
Mathieu Chartier90443472015-07-16 20:32:27 -070037 SHARED_REQUIRES(Locks::mutator_lock_) : value_(value) {
Ian Rogers719d1a32014-03-06 12:13:39 -080038 }
39
Mathieu Chartier90443472015-07-16 20:32:27 -070040 void Dump(std::ostream& os) const SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogers719d1a32014-03-06 12:13:39 -080041 value_.Dump(os);
42 }
43
44 private:
45 T& value_;
46
47 DISALLOW_COPY_AND_ASSIGN(MutatorLockedDumpable);
48};
49
50template<typename T>
51std::ostream& operator<<(std::ostream& os, const MutatorLockedDumpable<T>& rhs)
Mathieu Chartier90443472015-07-16 20:32:27 -070052// TODO: should be SHARED_REQUIRES(Locks::mutator_lock_) however annotalysis
Ian Rogers719d1a32014-03-06 12:13:39 -080053// currently fails for this.
54 NO_THREAD_SAFETY_ANALYSIS {
55 rhs.Dump(os);
56 return os;
57}
58
Mathieu Chartierc56057e2014-05-04 13:18:58 -070059void IndirectReferenceTable::AbortIfNoCheckJNI() {
Elliott Hughesa2501992011-08-26 19:39:54 -070060 // If -Xcheck:jni is on, it'll give a more detailed error before aborting.
Ian Rogers68d8b422014-07-17 11:09:10 -070061 JavaVMExt* vm = Runtime::Current()->GetJavaVM();
62 if (!vm->IsCheckJniEnabled()) {
Elliott Hughesa2501992011-08-26 19:39:54 -070063 // Otherwise, we want to abort rather than hand back a bad reference.
64 LOG(FATAL) << "JNI ERROR (app bug): see above.";
65 }
Elliott Hughes6c1a3942011-08-17 15:00:06 -070066}
67
68IndirectReferenceTable::IndirectReferenceTable(size_t initialCount,
Andreas Gampe3f5881f2015-04-08 10:26:16 -070069 size_t maxCount, IndirectRefKind desiredKind,
70 bool abort_on_error)
Mathieu Chartier4838d662014-09-25 15:27:43 -070071 : kind_(desiredKind),
72 max_entries_(maxCount) {
Elliott Hughes6c1a3942011-08-17 15:00:06 -070073 CHECK_GT(initialCount, 0U);
74 CHECK_LE(initialCount, maxCount);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -070075 CHECK_NE(desiredKind, kHandleScopeOrInvalid);
Elliott Hughes6c1a3942011-08-17 15:00:06 -070076
Mathieu Chartierc56057e2014-05-04 13:18:58 -070077 std::string error_str;
Mathieu Chartier4838d662014-09-25 15:27:43 -070078 const size_t table_bytes = maxCount * sizeof(IrtEntry);
Mathieu Chartierc56057e2014-05-04 13:18:58 -070079 table_mem_map_.reset(MemMap::MapAnonymous("indirect ref table", nullptr, table_bytes,
Vladimir Marko5c42c292015-02-25 12:02:49 +000080 PROT_READ | PROT_WRITE, false, false, &error_str));
Andreas Gampe3f5881f2015-04-08 10:26:16 -070081 if (abort_on_error) {
82 CHECK(table_mem_map_.get() != nullptr) << error_str;
83 CHECK_EQ(table_mem_map_->Size(), table_bytes);
84 CHECK(table_mem_map_->Begin() != nullptr);
85 } else if (table_mem_map_.get() == nullptr ||
86 table_mem_map_->Size() != table_bytes ||
87 table_mem_map_->Begin() == nullptr) {
88 table_mem_map_.reset();
89 LOG(ERROR) << error_str;
90 return;
91 }
Mathieu Chartier4838d662014-09-25 15:27:43 -070092 table_ = reinterpret_cast<IrtEntry*>(table_mem_map_->Begin());
Ian Rogersdc51b792011-09-22 20:41:37 -070093 segment_state_.all = IRT_FIRST_SEGMENT;
Elliott Hughes6c1a3942011-08-17 15:00:06 -070094}
95
96IndirectReferenceTable::~IndirectReferenceTable() {
Elliott Hughes6c1a3942011-08-17 15:00:06 -070097}
98
Andreas Gampe3f5881f2015-04-08 10:26:16 -070099bool IndirectReferenceTable::IsValid() const {
100 return table_mem_map_.get() != nullptr;
101}
102
Mathieu Chartier423d2a32013-09-12 17:33:56 -0700103IndirectRef IndirectReferenceTable::Add(uint32_t cookie, mirror::Object* obj) {
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700104 IRTSegmentState prevState;
105 prevState.all = cookie;
Ian Rogersdc51b792011-09-22 20:41:37 -0700106 size_t topIndex = segment_state_.parts.topIndex;
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700107
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700108 CHECK(obj != nullptr);
Mathieu Chartier6dda8982014-03-06 11:11:48 -0800109 VerifyObject(obj);
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700110 DCHECK(table_ != nullptr);
Ian Rogersdc51b792011-09-22 20:41:37 -0700111 DCHECK_GE(segment_state_.parts.numHoles, prevState.parts.numHoles);
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700112
Mathieu Chartier4838d662014-09-25 15:27:43 -0700113 if (topIndex == max_entries_) {
114 LOG(FATAL) << "JNI ERROR (app bug): " << kind_ << " table overflow "
115 << "(max=" << max_entries_ << ")\n"
116 << MutatorLockedDumpable<IndirectReferenceTable>(*this);
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700117 }
118
Elliott Hughes73e66f72012-05-09 09:34:45 -0700119 // We know there's enough room in the table. Now we just need to find
120 // the right spot. If there's a hole, find it and fill it; otherwise,
121 // add to the end of the list.
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700122 IndirectRef result;
Ian Rogersdc51b792011-09-22 20:41:37 -0700123 int numHoles = segment_state_.parts.numHoles - prevState.parts.numHoles;
Mathieu Chartier4838d662014-09-25 15:27:43 -0700124 size_t index;
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700125 if (numHoles > 0) {
126 DCHECK_GT(topIndex, 1U);
Elliott Hughes73e66f72012-05-09 09:34:45 -0700127 // Find the first hole; likely to be near the end of the list.
Mathieu Chartier4838d662014-09-25 15:27:43 -0700128 IrtEntry* pScan = &table_[topIndex - 1];
129 DCHECK(!pScan->GetReference()->IsNull());
Hiroshi Yamauchi94f7b492014-07-22 18:08:23 -0700130 --pScan;
Mathieu Chartier4838d662014-09-25 15:27:43 -0700131 while (!pScan->GetReference()->IsNull()) {
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700132 DCHECK_GE(pScan, table_ + prevState.parts.topIndex);
Hiroshi Yamauchi94f7b492014-07-22 18:08:23 -0700133 --pScan;
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700134 }
Mathieu Chartier4838d662014-09-25 15:27:43 -0700135 index = pScan - table_;
Ian Rogersdc51b792011-09-22 20:41:37 -0700136 segment_state_.parts.numHoles--;
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700137 } else {
Elliott Hughes73e66f72012-05-09 09:34:45 -0700138 // Add to the end.
Mathieu Chartier4838d662014-09-25 15:27:43 -0700139 index = topIndex++;
Ian Rogersdc51b792011-09-22 20:41:37 -0700140 segment_state_.parts.topIndex = topIndex;
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700141 }
Mathieu Chartier4838d662014-09-25 15:27:43 -0700142 table_[index].Add(obj);
143 result = ToIndirectRef(index);
Ian Rogerscf7f1912014-10-22 22:06:39 -0700144 if ((false)) {
Ian Rogers5a7a74a2011-09-26 16:32:29 -0700145 LOG(INFO) << "+++ added at " << ExtractIndex(result) << " top=" << segment_state_.parts.topIndex
146 << " holes=" << segment_state_.parts.numHoles;
147 }
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700148
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700149 DCHECK(result != nullptr);
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700150 return result;
151}
152
Elliott Hughes726079d2011-10-07 18:43:44 -0700153void IndirectReferenceTable::AssertEmpty() {
Hiroshi Yamauchi8a741172014-09-08 13:22:56 -0700154 for (size_t i = 0; i < Capacity(); ++i) {
Mathieu Chartier4838d662014-09-25 15:27:43 -0700155 if (!table_[i].GetReference()->IsNull()) {
Hiroshi Yamauchi8a741172014-09-08 13:22:56 -0700156 ScopedObjectAccess soa(Thread::Current());
157 LOG(FATAL) << "Internal Error: non-empty local reference table\n"
158 << MutatorLockedDumpable<IndirectReferenceTable>(*this);
159 }
Elliott Hughes726079d2011-10-07 18:43:44 -0700160 }
161}
162
Elliott Hughes73e66f72012-05-09 09:34:45 -0700163// Removes an object. We extract the table offset bits from "iref"
164// and zap the corresponding entry, leaving a hole if it's not at the top.
165// If the entry is not between the current top index and the bottom index
166// specified by the cookie, we don't remove anything. This is the behavior
167// required by JNI's DeleteLocalRef function.
168// This method is not called when a local frame is popped; this is only used
169// for explicit single removals.
170// Returns "false" if nothing was removed.
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700171bool IndirectReferenceTable::Remove(uint32_t cookie, IndirectRef iref) {
172 IRTSegmentState prevState;
173 prevState.all = cookie;
Ian Rogersdc51b792011-09-22 20:41:37 -0700174 int topIndex = segment_state_.parts.topIndex;
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700175 int bottomIndex = prevState.parts.topIndex;
176
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700177 DCHECK(table_ != nullptr);
Ian Rogersdc51b792011-09-22 20:41:37 -0700178 DCHECK_GE(segment_state_.parts.numHoles, prevState.parts.numHoles);
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700179
Mathieu Chartierc5adebc2015-04-29 09:57:48 -0700180 if (GetIndirectRefKind(iref) == kHandleScopeOrInvalid) {
181 auto* self = Thread::Current();
182 if (self->HandleScopeContains(reinterpret_cast<jobject>(iref))) {
183 auto* env = self->GetJniEnv();
184 DCHECK(env != nullptr);
185 if (env->check_jni) {
Mathieu Chartier22c1caa2015-06-02 13:40:12 -0700186 ScopedObjectAccess soa(self);
187 LOG(WARNING) << "Attempt to remove non-JNI local reference, dumping thread";
Mathieu Chartier5f684fd2015-07-30 11:41:04 -0700188 if (kDumpStackOnNonLocalReference) {
189 self->Dump(LOG(WARNING));
190 }
Mathieu Chartierc5adebc2015-04-29 09:57:48 -0700191 }
192 return true;
193 }
Ian Rogers5a7a74a2011-09-26 16:32:29 -0700194 }
Mathieu Chartier91c2f0c2014-11-26 11:21:15 -0800195 const int idx = ExtractIndex(iref);
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700196 if (idx < bottomIndex) {
Elliott Hughes726079d2011-10-07 18:43:44 -0700197 // Wrong segment.
198 LOG(WARNING) << "Attempt to remove index outside index area (" << idx
199 << " vs " << bottomIndex << "-" << topIndex << ")";
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700200 return false;
201 }
202 if (idx >= topIndex) {
Elliott Hughes726079d2011-10-07 18:43:44 -0700203 // Bad --- stale reference?
204 LOG(WARNING) << "Attempt to remove invalid index " << idx
205 << " (bottom=" << bottomIndex << " top=" << topIndex << ")";
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700206 return false;
207 }
208
Mathieu Chartier4838d662014-09-25 15:27:43 -0700209 if (idx == topIndex - 1) {
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700210 // Top-most entry. Scan up and consume holes.
211
Ian Rogers987560f2014-04-22 11:42:59 -0700212 if (!CheckEntry("remove", iref, idx)) {
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700213 return false;
214 }
215
Mathieu Chartier4838d662014-09-25 15:27:43 -0700216 *table_[idx].GetReference() = GcRoot<mirror::Object>(nullptr);
Ian Rogersdc51b792011-09-22 20:41:37 -0700217 int numHoles = segment_state_.parts.numHoles - prevState.parts.numHoles;
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700218 if (numHoles != 0) {
219 while (--topIndex > bottomIndex && numHoles != 0) {
Ian Rogerscf7f1912014-10-22 22:06:39 -0700220 if ((false)) {
Mathieu Chartier4838d662014-09-25 15:27:43 -0700221 LOG(INFO) << "+++ checking for hole at " << topIndex - 1
Hiroshi Yamauchi94f7b492014-07-22 18:08:23 -0700222 << " (cookie=" << cookie << ") val="
Mathieu Chartier4838d662014-09-25 15:27:43 -0700223 << table_[topIndex - 1].GetReference()->Read<kWithoutReadBarrier>();
Ian Rogers5a7a74a2011-09-26 16:32:29 -0700224 }
Mathieu Chartier4838d662014-09-25 15:27:43 -0700225 if (!table_[topIndex - 1].GetReference()->IsNull()) {
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700226 break;
227 }
Ian Rogerscf7f1912014-10-22 22:06:39 -0700228 if ((false)) {
Ian Rogers5a7a74a2011-09-26 16:32:29 -0700229 LOG(INFO) << "+++ ate hole at " << (topIndex - 1);
230 }
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700231 numHoles--;
232 }
Ian Rogersdc51b792011-09-22 20:41:37 -0700233 segment_state_.parts.numHoles = numHoles + prevState.parts.numHoles;
234 segment_state_.parts.topIndex = topIndex;
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700235 } else {
Ian Rogersdc51b792011-09-22 20:41:37 -0700236 segment_state_.parts.topIndex = topIndex-1;
Ian Rogerscf7f1912014-10-22 22:06:39 -0700237 if ((false)) {
Ian Rogers5a7a74a2011-09-26 16:32:29 -0700238 LOG(INFO) << "+++ ate last entry " << topIndex - 1;
239 }
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700240 }
241 } else {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700242 // Not the top-most entry. This creates a hole. We null out the entry to prevent somebody
243 // from deleting it twice and screwing up the hole count.
Mathieu Chartier4838d662014-09-25 15:27:43 -0700244 if (table_[idx].GetReference()->IsNull()) {
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700245 LOG(INFO) << "--- WEIRD: removing null entry " << idx;
246 return false;
247 }
Ian Rogers987560f2014-04-22 11:42:59 -0700248 if (!CheckEntry("remove", iref, idx)) {
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700249 return false;
250 }
251
Mathieu Chartier4838d662014-09-25 15:27:43 -0700252 *table_[idx].GetReference() = GcRoot<mirror::Object>(nullptr);
Ian Rogersdc51b792011-09-22 20:41:37 -0700253 segment_state_.parts.numHoles++;
Ian Rogerscf7f1912014-10-22 22:06:39 -0700254 if ((false)) {
Ian Rogers5a7a74a2011-09-26 16:32:29 -0700255 LOG(INFO) << "+++ left hole at " << idx << ", holes=" << segment_state_.parts.numHoles;
256 }
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700257 }
258
259 return true;
260}
261
Mathieu Chartier91c2f0c2014-11-26 11:21:15 -0800262void IndirectReferenceTable::Trim() {
263 const size_t top_index = Capacity();
264 auto* release_start = AlignUp(reinterpret_cast<uint8_t*>(&table_[top_index]), kPageSize);
265 uint8_t* release_end = table_mem_map_->End();
266 madvise(release_start, release_end - release_start, MADV_DONTNEED);
267}
268
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -0700269void IndirectReferenceTable::VisitRoots(RootVisitor* visitor, const RootInfo& root_info) {
Mathieu Chartier4809d0a2015-04-07 10:39:04 -0700270 BufferedRootVisitor<kDefaultBufferedRootCount> root_visitor(visitor, root_info);
Mathieu Chartier02e25112013-08-14 16:14:24 -0700271 for (auto ref : *this) {
Mathieu Chartier9086b652015-04-14 09:35:18 -0700272 if (!ref->IsNull()) {
273 root_visitor.VisitRoot(*ref);
274 DCHECK(!ref->IsNull());
275 }
Elliott Hughes410c0c82011-09-01 17:58:25 -0700276 }
277}
278
Elliott Hughes73e66f72012-05-09 09:34:45 -0700279void IndirectReferenceTable::Dump(std::ostream& os) const {
280 os << kind_ << " table dump:\n";
Hiroshi Yamauchi196851b2014-05-29 12:16:04 -0700281 ReferenceTable::Table entries;
282 for (size_t i = 0; i < Capacity(); ++i) {
Mathieu Chartier4838d662014-09-25 15:27:43 -0700283 mirror::Object* obj = table_[i].GetReference()->Read<kWithoutReadBarrier>();
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700284 if (obj != nullptr) {
Mathieu Chartier4838d662014-09-25 15:27:43 -0700285 obj = table_[i].GetReference()->Read();
Hiroshi Yamauchi94f7b492014-07-22 18:08:23 -0700286 entries.push_back(GcRoot<mirror::Object>(obj));
Ian Rogers63818dc2012-09-26 12:23:04 -0700287 }
288 }
Elliott Hughes73e66f72012-05-09 09:34:45 -0700289 ReferenceTable::Dump(os, entries);
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700290}
291
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700292} // namespace art