src/share/vm/prims/jvmtiTagMap.cpp

Fri, 13 Jul 2012 20:14:27 -0400

author
jiangli
date
Fri, 13 Jul 2012 20:14:27 -0400
changeset 3921
e74da3c2b827
parent 3900
d2a62e0f25eb
child 3969
1d7922586cf6
permissions
-rw-r--r--

Merge

duke@435 1 /*
sspitsyn@3556 2 * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
duke@435 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@435 4 *
duke@435 5 * This code is free software; you can redistribute it and/or modify it
duke@435 6 * under the terms of the GNU General Public License version 2 only, as
duke@435 7 * published by the Free Software Foundation.
duke@435 8 *
duke@435 9 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@435 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@435 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@435 12 * version 2 for more details (a copy is included in the LICENSE file that
duke@435 13 * accompanied this code).
duke@435 14 *
duke@435 15 * You should have received a copy of the GNU General Public License version
duke@435 16 * 2 along with this work; if not, write to the Free Software Foundation,
duke@435 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@435 18 *
trims@1907 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
trims@1907 20 * or visit www.oracle.com if you need additional information or have any
trims@1907 21 * questions.
duke@435 22 *
duke@435 23 */
duke@435 24
stefank@2314 25 #include "precompiled.hpp"
stefank@2314 26 #include "classfile/symbolTable.hpp"
stefank@2314 27 #include "classfile/systemDictionary.hpp"
stefank@2314 28 #include "classfile/vmSymbols.hpp"
stefank@2314 29 #include "jvmtifiles/jvmtiEnv.hpp"
never@2658 30 #include "oops/instanceMirrorKlass.hpp"
stefank@2314 31 #include "oops/objArrayKlass.hpp"
stefank@2314 32 #include "oops/oop.inline2.hpp"
stefank@2314 33 #include "prims/jvmtiEventController.hpp"
stefank@2314 34 #include "prims/jvmtiEventController.inline.hpp"
stefank@2314 35 #include "prims/jvmtiExport.hpp"
stefank@2314 36 #include "prims/jvmtiImpl.hpp"
stefank@2314 37 #include "prims/jvmtiTagMap.hpp"
stefank@2314 38 #include "runtime/biasedLocking.hpp"
stefank@2314 39 #include "runtime/javaCalls.hpp"
stefank@2314 40 #include "runtime/jniHandles.hpp"
stefank@2314 41 #include "runtime/mutex.hpp"
stefank@2314 42 #include "runtime/mutexLocker.hpp"
stefank@2314 43 #include "runtime/reflectionUtils.hpp"
stefank@2314 44 #include "runtime/vframe.hpp"
stefank@2314 45 #include "runtime/vmThread.hpp"
stefank@2314 46 #include "runtime/vm_operations.hpp"
stefank@2314 47 #include "services/serviceUtil.hpp"
stefank@2314 48 #ifndef SERIALGC
stefank@2314 49 #include "gc_implementation/parallelScavenge/parallelScavengeHeap.hpp"
stefank@2314 50 #endif
duke@435 51
duke@435 52 // JvmtiTagHashmapEntry
duke@435 53 //
kamg@2445 54 // Each entry encapsulates a reference to the tagged object
duke@435 55 // and the tag value. In addition an entry includes a next pointer which
duke@435 56 // is used to chain entries together.
duke@435 57
zgu@3900 58 class JvmtiTagHashmapEntry : public CHeapObj<mtInternal> {
duke@435 59 private:
duke@435 60 friend class JvmtiTagMap;
duke@435 61
kamg@2445 62 oop _object; // tagged object
duke@435 63 jlong _tag; // the tag
duke@435 64 JvmtiTagHashmapEntry* _next; // next on the list
duke@435 65
kamg@2445 66 inline void init(oop object, jlong tag) {
duke@435 67 _object = object;
duke@435 68 _tag = tag;
duke@435 69 _next = NULL;
duke@435 70 }
duke@435 71
duke@435 72 // constructor
kamg@2445 73 JvmtiTagHashmapEntry(oop object, jlong tag) { init(object, tag); }
duke@435 74
duke@435 75 public:
duke@435 76
duke@435 77 // accessor methods
kamg@2445 78 inline oop object() const { return _object; }
kamg@2445 79 inline oop* object_addr() { return &_object; }
kamg@2445 80 inline jlong tag() const { return _tag; }
duke@435 81
duke@435 82 inline void set_tag(jlong tag) {
duke@435 83 assert(tag != 0, "can't be zero");
duke@435 84 _tag = tag;
duke@435 85 }
duke@435 86
duke@435 87 inline JvmtiTagHashmapEntry* next() const { return _next; }
duke@435 88 inline void set_next(JvmtiTagHashmapEntry* next) { _next = next; }
duke@435 89 };
duke@435 90
duke@435 91
duke@435 92 // JvmtiTagHashmap
duke@435 93 //
duke@435 94 // A hashmap is essentially a table of pointers to entries. Entries
duke@435 95 // are hashed to a location, or position in the table, and then
duke@435 96 // chained from that location. The "key" for hashing is address of
kamg@2445 97 // the object, or oop. The "value" is the tag value.
duke@435 98 //
duke@435 99 // A hashmap maintains a count of the number entries in the hashmap
duke@435 100 // and resizes if the number of entries exceeds a given threshold.
duke@435 101 // The threshold is specified as a percentage of the size - for
duke@435 102 // example a threshold of 0.75 will trigger the hashmap to resize
duke@435 103 // if the number of entries is >75% of table size.
duke@435 104 //
duke@435 105 // A hashmap provides functions for adding, removing, and finding
duke@435 106 // entries. It also provides a function to iterate over all entries
duke@435 107 // in the hashmap.
duke@435 108
zgu@3900 109 class JvmtiTagHashmap : public CHeapObj<mtInternal> {
duke@435 110 private:
duke@435 111 friend class JvmtiTagMap;
duke@435 112
duke@435 113 enum {
duke@435 114 small_trace_threshold = 10000, // threshold for tracing
duke@435 115 medium_trace_threshold = 100000,
duke@435 116 large_trace_threshold = 1000000,
duke@435 117 initial_trace_threshold = small_trace_threshold
duke@435 118 };
duke@435 119
duke@435 120 static int _sizes[]; // array of possible hashmap sizes
duke@435 121 int _size; // actual size of the table
duke@435 122 int _size_index; // index into size table
duke@435 123
duke@435 124 int _entry_count; // number of entries in the hashmap
duke@435 125
duke@435 126 float _load_factor; // load factor as a % of the size
duke@435 127 int _resize_threshold; // computed threshold to trigger resizing.
duke@435 128 bool _resizing_enabled; // indicates if hashmap can resize
duke@435 129
duke@435 130 int _trace_threshold; // threshold for trace messages
duke@435 131
duke@435 132 JvmtiTagHashmapEntry** _table; // the table of entries.
duke@435 133
duke@435 134 // private accessors
duke@435 135 int resize_threshold() const { return _resize_threshold; }
duke@435 136 int trace_threshold() const { return _trace_threshold; }
duke@435 137
duke@435 138 // initialize the hashmap
duke@435 139 void init(int size_index=0, float load_factor=4.0f) {
duke@435 140 int initial_size = _sizes[size_index];
duke@435 141 _size_index = size_index;
duke@435 142 _size = initial_size;
duke@435 143 _entry_count = 0;
duke@435 144 if (TraceJVMTIObjectTagging) {
duke@435 145 _trace_threshold = initial_trace_threshold;
duke@435 146 } else {
duke@435 147 _trace_threshold = -1;
duke@435 148 }
duke@435 149 _load_factor = load_factor;
duke@435 150 _resize_threshold = (int)(_load_factor * _size);
duke@435 151 _resizing_enabled = true;
duke@435 152 size_t s = initial_size * sizeof(JvmtiTagHashmapEntry*);
zgu@3900 153 _table = (JvmtiTagHashmapEntry**)os::malloc(s, mtInternal);
duke@435 154 if (_table == NULL) {
duke@435 155 vm_exit_out_of_memory(s, "unable to allocate initial hashtable for jvmti object tags");
duke@435 156 }
duke@435 157 for (int i=0; i<initial_size; i++) {
duke@435 158 _table[i] = NULL;
duke@435 159 }
duke@435 160 }
duke@435 161
duke@435 162 // hash a given key (oop) with the specified size
duke@435 163 static unsigned int hash(oop key, int size) {
duke@435 164 // shift right to get better distribution (as these bits will be zero
duke@435 165 // with aligned addresses)
duke@435 166 unsigned int addr = (unsigned int)((intptr_t)key);
duke@435 167 #ifdef _LP64
duke@435 168 return (addr >> 3) % size;
duke@435 169 #else
duke@435 170 return (addr >> 2) % size;
duke@435 171 #endif
duke@435 172 }
duke@435 173
duke@435 174 // hash a given key (oop)
duke@435 175 unsigned int hash(oop key) {
duke@435 176 return hash(key, _size);
duke@435 177 }
duke@435 178
duke@435 179 // resize the hashmap - allocates a large table and re-hashes
duke@435 180 // all entries into the new table.
duke@435 181 void resize() {
duke@435 182 int new_size_index = _size_index+1;
duke@435 183 int new_size = _sizes[new_size_index];
duke@435 184 if (new_size < 0) {
duke@435 185 // hashmap already at maximum capacity
duke@435 186 return;
duke@435 187 }
duke@435 188
duke@435 189 // allocate new table
duke@435 190 size_t s = new_size * sizeof(JvmtiTagHashmapEntry*);
zgu@3900 191 JvmtiTagHashmapEntry** new_table = (JvmtiTagHashmapEntry**)os::malloc(s, mtInternal);
duke@435 192 if (new_table == NULL) {
duke@435 193 warning("unable to allocate larger hashtable for jvmti object tags");
duke@435 194 set_resizing_enabled(false);
duke@435 195 return;
duke@435 196 }
duke@435 197
duke@435 198 // initialize new table
duke@435 199 int i;
duke@435 200 for (i=0; i<new_size; i++) {
duke@435 201 new_table[i] = NULL;
duke@435 202 }
duke@435 203
duke@435 204 // rehash all entries into the new table
duke@435 205 for (i=0; i<_size; i++) {
duke@435 206 JvmtiTagHashmapEntry* entry = _table[i];
duke@435 207 while (entry != NULL) {
duke@435 208 JvmtiTagHashmapEntry* next = entry->next();
kamg@2445 209 oop key = entry->object();
duke@435 210 assert(key != NULL, "jni weak reference cleared!!");
duke@435 211 unsigned int h = hash(key, new_size);
duke@435 212 JvmtiTagHashmapEntry* anchor = new_table[h];
duke@435 213 if (anchor == NULL) {
duke@435 214 new_table[h] = entry;
duke@435 215 entry->set_next(NULL);
duke@435 216 } else {
duke@435 217 entry->set_next(anchor);
duke@435 218 new_table[h] = entry;
duke@435 219 }
duke@435 220 entry = next;
duke@435 221 }
duke@435 222 }
duke@435 223
duke@435 224 // free old table and update settings.
duke@435 225 os::free((void*)_table);
duke@435 226 _table = new_table;
duke@435 227 _size_index = new_size_index;
duke@435 228 _size = new_size;
duke@435 229
duke@435 230 // compute new resize threshold
duke@435 231 _resize_threshold = (int)(_load_factor * _size);
duke@435 232 }
duke@435 233
duke@435 234
duke@435 235 // internal remove function - remove an entry at a given position in the
duke@435 236 // table.
duke@435 237 inline void remove(JvmtiTagHashmapEntry* prev, int pos, JvmtiTagHashmapEntry* entry) {
duke@435 238 assert(pos >= 0 && pos < _size, "out of range");
duke@435 239 if (prev == NULL) {
duke@435 240 _table[pos] = entry->next();
duke@435 241 } else {
duke@435 242 prev->set_next(entry->next());
duke@435 243 }
duke@435 244 assert(_entry_count > 0, "checking");
duke@435 245 _entry_count--;
duke@435 246 }
duke@435 247
duke@435 248 // resizing switch
duke@435 249 bool is_resizing_enabled() const { return _resizing_enabled; }
duke@435 250 void set_resizing_enabled(bool enable) { _resizing_enabled = enable; }
duke@435 251
duke@435 252 // debugging
duke@435 253 void print_memory_usage();
duke@435 254 void compute_next_trace_threshold();
duke@435 255
duke@435 256 public:
duke@435 257
duke@435 258 // create a JvmtiTagHashmap of a preferred size and optionally a load factor.
duke@435 259 // The preferred size is rounded down to an actual size.
duke@435 260 JvmtiTagHashmap(int size, float load_factor=0.0f) {
duke@435 261 int i=0;
duke@435 262 while (_sizes[i] < size) {
duke@435 263 if (_sizes[i] < 0) {
duke@435 264 assert(i > 0, "sanity check");
duke@435 265 i--;
duke@435 266 break;
duke@435 267 }
duke@435 268 i++;
duke@435 269 }
duke@435 270
duke@435 271 // if a load factor is specified then use it, otherwise use default
duke@435 272 if (load_factor > 0.01f) {
duke@435 273 init(i, load_factor);
duke@435 274 } else {
duke@435 275 init(i);
duke@435 276 }
duke@435 277 }
duke@435 278
duke@435 279 // create a JvmtiTagHashmap with default settings
duke@435 280 JvmtiTagHashmap() {
duke@435 281 init();
duke@435 282 }
duke@435 283
duke@435 284 // release table when JvmtiTagHashmap destroyed
duke@435 285 ~JvmtiTagHashmap() {
duke@435 286 if (_table != NULL) {
duke@435 287 os::free((void*)_table);
duke@435 288 _table = NULL;
duke@435 289 }
duke@435 290 }
duke@435 291
duke@435 292 // accessors
duke@435 293 int size() const { return _size; }
duke@435 294 JvmtiTagHashmapEntry** table() const { return _table; }
duke@435 295 int entry_count() const { return _entry_count; }
duke@435 296
duke@435 297 // find an entry in the hashmap, returns NULL if not found.
duke@435 298 inline JvmtiTagHashmapEntry* find(oop key) {
duke@435 299 unsigned int h = hash(key);
duke@435 300 JvmtiTagHashmapEntry* entry = _table[h];
duke@435 301 while (entry != NULL) {
kamg@2445 302 if (entry->object() == key) {
kamg@2445 303 return entry;
duke@435 304 }
duke@435 305 entry = entry->next();
duke@435 306 }
kamg@2445 307 return NULL;
duke@435 308 }
duke@435 309
duke@435 310
duke@435 311 // add a new entry to hashmap
duke@435 312 inline void add(oop key, JvmtiTagHashmapEntry* entry) {
duke@435 313 assert(key != NULL, "checking");
duke@435 314 assert(find(key) == NULL, "duplicate detected");
duke@435 315 unsigned int h = hash(key);
duke@435 316 JvmtiTagHashmapEntry* anchor = _table[h];
duke@435 317 if (anchor == NULL) {
duke@435 318 _table[h] = entry;
duke@435 319 entry->set_next(NULL);
duke@435 320 } else {
duke@435 321 entry->set_next(anchor);
duke@435 322 _table[h] = entry;
duke@435 323 }
duke@435 324
duke@435 325 _entry_count++;
duke@435 326 if (trace_threshold() > 0 && entry_count() >= trace_threshold()) {
duke@435 327 assert(TraceJVMTIObjectTagging, "should only get here when tracing");
duke@435 328 print_memory_usage();
duke@435 329 compute_next_trace_threshold();
duke@435 330 }
duke@435 331
duke@435 332 // if the number of entries exceed the threshold then resize
duke@435 333 if (entry_count() > resize_threshold() && is_resizing_enabled()) {
duke@435 334 resize();
duke@435 335 }
duke@435 336 }
duke@435 337
duke@435 338 // remove an entry with the given key.
duke@435 339 inline JvmtiTagHashmapEntry* remove(oop key) {
duke@435 340 unsigned int h = hash(key);
duke@435 341 JvmtiTagHashmapEntry* entry = _table[h];
duke@435 342 JvmtiTagHashmapEntry* prev = NULL;
duke@435 343 while (entry != NULL) {
kamg@2445 344 if (key == entry->object()) {
duke@435 345 break;
duke@435 346 }
duke@435 347 prev = entry;
duke@435 348 entry = entry->next();
duke@435 349 }
duke@435 350 if (entry != NULL) {
duke@435 351 remove(prev, h, entry);
duke@435 352 }
duke@435 353 return entry;
duke@435 354 }
duke@435 355
duke@435 356 // iterate over all entries in the hashmap
duke@435 357 void entry_iterate(JvmtiTagHashmapEntryClosure* closure);
duke@435 358 };
duke@435 359
duke@435 360 // possible hashmap sizes - odd primes that roughly double in size.
duke@435 361 // To avoid excessive resizing the odd primes from 4801-76831 and
duke@435 362 // 76831-307261 have been removed. The list must be terminated by -1.
duke@435 363 int JvmtiTagHashmap::_sizes[] = { 4801, 76831, 307261, 614563, 1228891,
duke@435 364 2457733, 4915219, 9830479, 19660831, 39321619, 78643219, -1 };
duke@435 365
duke@435 366
duke@435 367 // A supporting class for iterating over all entries in Hashmap
duke@435 368 class JvmtiTagHashmapEntryClosure {
duke@435 369 public:
duke@435 370 virtual void do_entry(JvmtiTagHashmapEntry* entry) = 0;
duke@435 371 };
duke@435 372
duke@435 373
duke@435 374 // iterate over all entries in the hashmap
duke@435 375 void JvmtiTagHashmap::entry_iterate(JvmtiTagHashmapEntryClosure* closure) {
duke@435 376 for (int i=0; i<_size; i++) {
duke@435 377 JvmtiTagHashmapEntry* entry = _table[i];
duke@435 378 JvmtiTagHashmapEntry* prev = NULL;
duke@435 379 while (entry != NULL) {
duke@435 380 // obtain the next entry before invoking do_entry - this is
duke@435 381 // necessary because do_entry may remove the entry from the
duke@435 382 // hashmap.
duke@435 383 JvmtiTagHashmapEntry* next = entry->next();
duke@435 384 closure->do_entry(entry);
duke@435 385 entry = next;
duke@435 386 }
duke@435 387 }
duke@435 388 }
duke@435 389
duke@435 390 // debugging
duke@435 391 void JvmtiTagHashmap::print_memory_usage() {
duke@435 392 intptr_t p = (intptr_t)this;
duke@435 393 tty->print("[JvmtiTagHashmap @ " INTPTR_FORMAT, p);
duke@435 394
duke@435 395 // table + entries in KB
duke@435 396 int hashmap_usage = (size()*sizeof(JvmtiTagHashmapEntry*) +
duke@435 397 entry_count()*sizeof(JvmtiTagHashmapEntry))/K;
duke@435 398
duke@435 399 int weak_globals_usage = (int)(JNIHandles::weak_global_handle_memory_usage()/K);
duke@435 400 tty->print_cr(", %d entries (%d KB) <JNI weak globals: %d KB>]",
duke@435 401 entry_count(), hashmap_usage, weak_globals_usage);
duke@435 402 }
duke@435 403
duke@435 404 // compute threshold for the next trace message
duke@435 405 void JvmtiTagHashmap::compute_next_trace_threshold() {
duke@435 406 if (trace_threshold() < medium_trace_threshold) {
duke@435 407 _trace_threshold += small_trace_threshold;
duke@435 408 } else {
duke@435 409 if (trace_threshold() < large_trace_threshold) {
duke@435 410 _trace_threshold += medium_trace_threshold;
duke@435 411 } else {
duke@435 412 _trace_threshold += large_trace_threshold;
duke@435 413 }
duke@435 414 }
duke@435 415 }
duke@435 416
duke@435 417 // create a JvmtiTagMap
duke@435 418 JvmtiTagMap::JvmtiTagMap(JvmtiEnv* env) :
duke@435 419 _env(env),
duke@435 420 _lock(Mutex::nonleaf+2, "JvmtiTagMap._lock", false),
duke@435 421 _free_entries(NULL),
duke@435 422 _free_entries_count(0)
duke@435 423 {
duke@435 424 assert(JvmtiThreadState_lock->is_locked(), "sanity check");
duke@435 425 assert(((JvmtiEnvBase *)env)->tag_map() == NULL, "tag map already exists for environment");
duke@435 426
kamg@2445 427 _hashmap = new JvmtiTagHashmap();
duke@435 428
duke@435 429 // finally add us to the environment
duke@435 430 ((JvmtiEnvBase *)env)->set_tag_map(this);
duke@435 431 }
duke@435 432
duke@435 433
duke@435 434 // destroy a JvmtiTagMap
duke@435 435 JvmtiTagMap::~JvmtiTagMap() {
duke@435 436
duke@435 437 // no lock acquired as we assume the enclosing environment is
duke@435 438 // also being destroryed.
duke@435 439 ((JvmtiEnvBase *)_env)->set_tag_map(NULL);
duke@435 440
kamg@2445 441 JvmtiTagHashmapEntry** table = _hashmap->table();
kamg@2445 442 for (int j = 0; j < _hashmap->size(); j++) {
kamg@2445 443 JvmtiTagHashmapEntry* entry = table[j];
kamg@2445 444 while (entry != NULL) {
kamg@2445 445 JvmtiTagHashmapEntry* next = entry->next();
kamg@2445 446 delete entry;
kamg@2445 447 entry = next;
duke@435 448 }
duke@435 449 }
duke@435 450
kamg@2445 451 // finally destroy the hashmap
kamg@2445 452 delete _hashmap;
kamg@2445 453 _hashmap = NULL;
kamg@2445 454
duke@435 455 // remove any entries on the free list
duke@435 456 JvmtiTagHashmapEntry* entry = _free_entries;
duke@435 457 while (entry != NULL) {
duke@435 458 JvmtiTagHashmapEntry* next = entry->next();
duke@435 459 delete entry;
duke@435 460 entry = next;
duke@435 461 }
kamg@2445 462 _free_entries = NULL;
duke@435 463 }
duke@435 464
duke@435 465 // create a hashmap entry
duke@435 466 // - if there's an entry on the (per-environment) free list then this
duke@435 467 // is returned. Otherwise an new entry is allocated.
kamg@2445 468 JvmtiTagHashmapEntry* JvmtiTagMap::create_entry(oop ref, jlong tag) {
duke@435 469 assert(Thread::current()->is_VM_thread() || is_locked(), "checking");
duke@435 470 JvmtiTagHashmapEntry* entry;
duke@435 471 if (_free_entries == NULL) {
duke@435 472 entry = new JvmtiTagHashmapEntry(ref, tag);
duke@435 473 } else {
duke@435 474 assert(_free_entries_count > 0, "mismatched _free_entries_count");
duke@435 475 _free_entries_count--;
duke@435 476 entry = _free_entries;
duke@435 477 _free_entries = entry->next();
duke@435 478 entry->init(ref, tag);
duke@435 479 }
duke@435 480 return entry;
duke@435 481 }
duke@435 482
duke@435 483 // destroy an entry by returning it to the free list
duke@435 484 void JvmtiTagMap::destroy_entry(JvmtiTagHashmapEntry* entry) {
duke@435 485 assert(SafepointSynchronize::is_at_safepoint() || is_locked(), "checking");
duke@435 486 // limit the size of the free list
duke@435 487 if (_free_entries_count >= max_free_entries) {
duke@435 488 delete entry;
duke@435 489 } else {
duke@435 490 entry->set_next(_free_entries);
duke@435 491 _free_entries = entry;
duke@435 492 _free_entries_count++;
duke@435 493 }
duke@435 494 }
duke@435 495
duke@435 496 // returns the tag map for the given environments. If the tag map
duke@435 497 // doesn't exist then it is created.
duke@435 498 JvmtiTagMap* JvmtiTagMap::tag_map_for(JvmtiEnv* env) {
kamg@2445 499 JvmtiTagMap* tag_map = ((JvmtiEnvBase*)env)->tag_map();
duke@435 500 if (tag_map == NULL) {
duke@435 501 MutexLocker mu(JvmtiThreadState_lock);
kamg@2445 502 tag_map = ((JvmtiEnvBase*)env)->tag_map();
duke@435 503 if (tag_map == NULL) {
duke@435 504 tag_map = new JvmtiTagMap(env);
duke@435 505 }
duke@435 506 } else {
duke@435 507 CHECK_UNHANDLED_OOPS_ONLY(Thread::current()->clear_unhandled_oops());
duke@435 508 }
duke@435 509 return tag_map;
duke@435 510 }
duke@435 511
duke@435 512 // iterate over all entries in the tag map.
duke@435 513 void JvmtiTagMap::entry_iterate(JvmtiTagHashmapEntryClosure* closure) {
kamg@2445 514 hashmap()->entry_iterate(closure);
duke@435 515 }
duke@435 516
duke@435 517 // returns true if the hashmaps are empty
duke@435 518 bool JvmtiTagMap::is_empty() {
duke@435 519 assert(SafepointSynchronize::is_at_safepoint() || is_locked(), "checking");
kamg@2445 520 return hashmap()->entry_count() == 0;
duke@435 521 }
duke@435 522
duke@435 523
duke@435 524 // Return the tag value for an object, or 0 if the object is
duke@435 525 // not tagged
duke@435 526 //
duke@435 527 static inline jlong tag_for(JvmtiTagMap* tag_map, oop o) {
kamg@2445 528 JvmtiTagHashmapEntry* entry = tag_map->hashmap()->find(o);
duke@435 529 if (entry == NULL) {
duke@435 530 return 0;
duke@435 531 } else {
duke@435 532 return entry->tag();
duke@435 533 }
duke@435 534 }
duke@435 535
duke@435 536 // If the object is a java.lang.Class then return the klassOop,
duke@435 537 // otherwise return the original object
duke@435 538 static inline oop klassOop_if_java_lang_Class(oop o) {
never@1577 539 if (o->klass() == SystemDictionary::Class_klass()) {
duke@435 540 if (!java_lang_Class::is_primitive(o)) {
duke@435 541 o = (oop)java_lang_Class::as_klassOop(o);
duke@435 542 assert(o != NULL, "class for non-primitive mirror must exist");
duke@435 543 }
duke@435 544 }
duke@435 545 return o;
duke@435 546 }
duke@435 547
duke@435 548 // A CallbackWrapper is a support class for querying and tagging an object
duke@435 549 // around a callback to a profiler. The constructor does pre-callback
duke@435 550 // work to get the tag value, klass tag value, ... and the destructor
duke@435 551 // does the post-callback work of tagging or untagging the object.
duke@435 552 //
duke@435 553 // {
duke@435 554 // CallbackWrapper wrapper(tag_map, o);
duke@435 555 //
duke@435 556 // (*callback)(wrapper.klass_tag(), wrapper.obj_size(), wrapper.obj_tag_p(), ...)
duke@435 557 //
duke@435 558 // } // wrapper goes out of scope here which results in the destructor
duke@435 559 // checking to see if the object has been tagged, untagged, or the
duke@435 560 // tag value has changed.
duke@435 561 //
duke@435 562 class CallbackWrapper : public StackObj {
duke@435 563 private:
duke@435 564 JvmtiTagMap* _tag_map;
duke@435 565 JvmtiTagHashmap* _hashmap;
duke@435 566 JvmtiTagHashmapEntry* _entry;
duke@435 567 oop _o;
duke@435 568 jlong _obj_size;
duke@435 569 jlong _obj_tag;
duke@435 570 klassOop _klass; // the object's class
duke@435 571 jlong _klass_tag;
duke@435 572
duke@435 573 protected:
duke@435 574 JvmtiTagMap* tag_map() const { return _tag_map; }
duke@435 575
duke@435 576 // invoked post-callback to tag, untag, or update the tag of an object
duke@435 577 void inline post_callback_tag_update(oop o, JvmtiTagHashmap* hashmap,
duke@435 578 JvmtiTagHashmapEntry* entry, jlong obj_tag);
duke@435 579 public:
duke@435 580 CallbackWrapper(JvmtiTagMap* tag_map, oop o) {
duke@435 581 assert(Thread::current()->is_VM_thread() || tag_map->is_locked(),
duke@435 582 "MT unsafe or must be VM thread");
duke@435 583
duke@435 584 // for Classes the klassOop is tagged
duke@435 585 _o = klassOop_if_java_lang_Class(o);
duke@435 586
duke@435 587 // object size
sla@3874 588 _obj_size = (jlong)_o->size() * wordSize;
duke@435 589
duke@435 590 // record the context
duke@435 591 _tag_map = tag_map;
kamg@2445 592 _hashmap = tag_map->hashmap();
duke@435 593 _entry = _hashmap->find(_o);
duke@435 594
duke@435 595 // get object tag
duke@435 596 _obj_tag = (_entry == NULL) ? 0 : _entry->tag();
duke@435 597
duke@435 598 // get the class and the class's tag value
duke@435 599 if (_o == o) {
duke@435 600 _klass = _o->klass();
duke@435 601 } else {
duke@435 602 // if the object represents a runtime class then use the
duke@435 603 // tag for java.lang.Class
never@1577 604 _klass = SystemDictionary::Class_klass();
duke@435 605 }
duke@435 606 _klass_tag = tag_for(tag_map, _klass);
duke@435 607 }
duke@435 608
duke@435 609 ~CallbackWrapper() {
duke@435 610 post_callback_tag_update(_o, _hashmap, _entry, _obj_tag);
duke@435 611 }
duke@435 612
duke@435 613 inline jlong* obj_tag_p() { return &_obj_tag; }
duke@435 614 inline jlong obj_size() const { return _obj_size; }
duke@435 615 inline jlong obj_tag() const { return _obj_tag; }
duke@435 616 inline klassOop klass() const { return _klass; }
duke@435 617 inline jlong klass_tag() const { return _klass_tag; }
duke@435 618 };
duke@435 619
duke@435 620
duke@435 621
duke@435 622 // callback post-callback to tag, untag, or update the tag of an object
duke@435 623 void inline CallbackWrapper::post_callback_tag_update(oop o,
duke@435 624 JvmtiTagHashmap* hashmap,
duke@435 625 JvmtiTagHashmapEntry* entry,
duke@435 626 jlong obj_tag) {
duke@435 627 if (entry == NULL) {
duke@435 628 if (obj_tag != 0) {
duke@435 629 // callback has tagged the object
duke@435 630 assert(Thread::current()->is_VM_thread(), "must be VMThread");
kamg@2445 631 entry = tag_map()->create_entry(o, obj_tag);
duke@435 632 hashmap->add(o, entry);
duke@435 633 }
duke@435 634 } else {
duke@435 635 // object was previously tagged - the callback may have untagged
duke@435 636 // the object or changed the tag value
duke@435 637 if (obj_tag == 0) {
duke@435 638
duke@435 639 JvmtiTagHashmapEntry* entry_removed = hashmap->remove(o);
duke@435 640 assert(entry_removed == entry, "checking");
duke@435 641 tag_map()->destroy_entry(entry);
duke@435 642
duke@435 643 } else {
duke@435 644 if (obj_tag != entry->tag()) {
duke@435 645 entry->set_tag(obj_tag);
duke@435 646 }
duke@435 647 }
duke@435 648 }
duke@435 649 }
duke@435 650
duke@435 651 // An extended CallbackWrapper used when reporting an object reference
duke@435 652 // to the agent.
duke@435 653 //
duke@435 654 // {
duke@435 655 // TwoOopCallbackWrapper wrapper(tag_map, referrer, o);
duke@435 656 //
duke@435 657 // (*callback)(wrapper.klass_tag(),
duke@435 658 // wrapper.obj_size(),
duke@435 659 // wrapper.obj_tag_p()
duke@435 660 // wrapper.referrer_tag_p(), ...)
duke@435 661 //
duke@435 662 // } // wrapper goes out of scope here which results in the destructor
duke@435 663 // checking to see if the referrer object has been tagged, untagged,
duke@435 664 // or the tag value has changed.
duke@435 665 //
duke@435 666 class TwoOopCallbackWrapper : public CallbackWrapper {
duke@435 667 private:
duke@435 668 bool _is_reference_to_self;
duke@435 669 JvmtiTagHashmap* _referrer_hashmap;
duke@435 670 JvmtiTagHashmapEntry* _referrer_entry;
duke@435 671 oop _referrer;
duke@435 672 jlong _referrer_obj_tag;
duke@435 673 jlong _referrer_klass_tag;
duke@435 674 jlong* _referrer_tag_p;
duke@435 675
duke@435 676 bool is_reference_to_self() const { return _is_reference_to_self; }
duke@435 677
duke@435 678 public:
duke@435 679 TwoOopCallbackWrapper(JvmtiTagMap* tag_map, oop referrer, oop o) :
duke@435 680 CallbackWrapper(tag_map, o)
duke@435 681 {
duke@435 682 // self reference needs to be handled in a special way
duke@435 683 _is_reference_to_self = (referrer == o);
duke@435 684
duke@435 685 if (_is_reference_to_self) {
duke@435 686 _referrer_klass_tag = klass_tag();
duke@435 687 _referrer_tag_p = obj_tag_p();
duke@435 688 } else {
duke@435 689 // for Classes the klassOop is tagged
duke@435 690 _referrer = klassOop_if_java_lang_Class(referrer);
duke@435 691 // record the context
kamg@2445 692 _referrer_hashmap = tag_map->hashmap();
duke@435 693 _referrer_entry = _referrer_hashmap->find(_referrer);
duke@435 694
duke@435 695 // get object tag
duke@435 696 _referrer_obj_tag = (_referrer_entry == NULL) ? 0 : _referrer_entry->tag();
duke@435 697 _referrer_tag_p = &_referrer_obj_tag;
duke@435 698
duke@435 699 // get referrer class tag.
duke@435 700 klassOop k = (_referrer == referrer) ? // Check if referrer is a class...
duke@435 701 _referrer->klass() // No, just get its class
never@1577 702 : SystemDictionary::Class_klass(); // Yes, its class is Class
duke@435 703 _referrer_klass_tag = tag_for(tag_map, k);
duke@435 704 }
duke@435 705 }
duke@435 706
duke@435 707 ~TwoOopCallbackWrapper() {
duke@435 708 if (!is_reference_to_self()){
duke@435 709 post_callback_tag_update(_referrer,
duke@435 710 _referrer_hashmap,
duke@435 711 _referrer_entry,
duke@435 712 _referrer_obj_tag);
duke@435 713 }
duke@435 714 }
duke@435 715
duke@435 716 // address of referrer tag
duke@435 717 // (for a self reference this will return the same thing as obj_tag_p())
duke@435 718 inline jlong* referrer_tag_p() { return _referrer_tag_p; }
duke@435 719
duke@435 720 // referrer's class tag
duke@435 721 inline jlong referrer_klass_tag() { return _referrer_klass_tag; }
duke@435 722 };
duke@435 723
duke@435 724 // tag an object
duke@435 725 //
duke@435 726 // This function is performance critical. If many threads attempt to tag objects
duke@435 727 // around the same time then it's possible that the Mutex associated with the
kamg@2445 728 // tag map will be a hot lock.
duke@435 729 void JvmtiTagMap::set_tag(jobject object, jlong tag) {
duke@435 730 MutexLocker ml(lock());
duke@435 731
duke@435 732 // resolve the object
duke@435 733 oop o = JNIHandles::resolve_non_null(object);
duke@435 734
duke@435 735 // for Classes we tag the klassOop
duke@435 736 o = klassOop_if_java_lang_Class(o);
duke@435 737
duke@435 738 // see if the object is already tagged
kamg@2445 739 JvmtiTagHashmap* hashmap = _hashmap;
duke@435 740 JvmtiTagHashmapEntry* entry = hashmap->find(o);
duke@435 741
duke@435 742 // if the object is not already tagged then we tag it
duke@435 743 if (entry == NULL) {
duke@435 744 if (tag != 0) {
kamg@2445 745 entry = create_entry(o, tag);
kamg@2445 746 hashmap->add(o, entry);
duke@435 747 } else {
duke@435 748 // no-op
duke@435 749 }
duke@435 750 } else {
duke@435 751 // if the object is already tagged then we either update
duke@435 752 // the tag (if a new tag value has been provided)
duke@435 753 // or remove the object if the new tag value is 0.
duke@435 754 if (tag == 0) {
duke@435 755 hashmap->remove(o);
duke@435 756 destroy_entry(entry);
duke@435 757 } else {
duke@435 758 entry->set_tag(tag);
duke@435 759 }
duke@435 760 }
duke@435 761 }
duke@435 762
duke@435 763 // get the tag for an object
duke@435 764 jlong JvmtiTagMap::get_tag(jobject object) {
duke@435 765 MutexLocker ml(lock());
duke@435 766
duke@435 767 // resolve the object
duke@435 768 oop o = JNIHandles::resolve_non_null(object);
duke@435 769
duke@435 770 // for Classes get the tag from the klassOop
duke@435 771 return tag_for(this, klassOop_if_java_lang_Class(o));
duke@435 772 }
duke@435 773
duke@435 774
duke@435 775 // Helper class used to describe the static or instance fields of a class.
duke@435 776 // For each field it holds the field index (as defined by the JVMTI specification),
duke@435 777 // the field type, and the offset.
duke@435 778
zgu@3900 779 class ClassFieldDescriptor: public CHeapObj<mtInternal> {
duke@435 780 private:
duke@435 781 int _field_index;
duke@435 782 int _field_offset;
duke@435 783 char _field_type;
duke@435 784 public:
duke@435 785 ClassFieldDescriptor(int index, char type, int offset) :
duke@435 786 _field_index(index), _field_type(type), _field_offset(offset) {
duke@435 787 }
duke@435 788 int field_index() const { return _field_index; }
duke@435 789 char field_type() const { return _field_type; }
duke@435 790 int field_offset() const { return _field_offset; }
duke@435 791 };
duke@435 792
zgu@3900 793 class ClassFieldMap: public CHeapObj<mtInternal> {
duke@435 794 private:
duke@435 795 enum {
duke@435 796 initial_field_count = 5
duke@435 797 };
duke@435 798
duke@435 799 // list of field descriptors
duke@435 800 GrowableArray<ClassFieldDescriptor*>* _fields;
duke@435 801
duke@435 802 // constructor
duke@435 803 ClassFieldMap();
duke@435 804
duke@435 805 // add a field
duke@435 806 void add(int index, char type, int offset);
duke@435 807
duke@435 808 // returns the field count for the given class
duke@435 809 static int compute_field_count(instanceKlassHandle ikh);
duke@435 810
duke@435 811 public:
duke@435 812 ~ClassFieldMap();
duke@435 813
duke@435 814 // access
duke@435 815 int field_count() { return _fields->length(); }
duke@435 816 ClassFieldDescriptor* field_at(int i) { return _fields->at(i); }
duke@435 817
duke@435 818 // functions to create maps of static or instance fields
duke@435 819 static ClassFieldMap* create_map_of_static_fields(klassOop k);
duke@435 820 static ClassFieldMap* create_map_of_instance_fields(oop obj);
duke@435 821 };
duke@435 822
duke@435 823 ClassFieldMap::ClassFieldMap() {
zgu@3900 824 _fields = new (ResourceObj::C_HEAP, mtInternal)
zgu@3900 825 GrowableArray<ClassFieldDescriptor*>(initial_field_count, true);
duke@435 826 }
duke@435 827
duke@435 828 ClassFieldMap::~ClassFieldMap() {
duke@435 829 for (int i=0; i<_fields->length(); i++) {
duke@435 830 delete _fields->at(i);
duke@435 831 }
duke@435 832 delete _fields;
duke@435 833 }
duke@435 834
duke@435 835 void ClassFieldMap::add(int index, char type, int offset) {
duke@435 836 ClassFieldDescriptor* field = new ClassFieldDescriptor(index, type, offset);
duke@435 837 _fields->append(field);
duke@435 838 }
duke@435 839
duke@435 840 // Returns a heap allocated ClassFieldMap to describe the static fields
duke@435 841 // of the given class.
duke@435 842 //
duke@435 843 ClassFieldMap* ClassFieldMap::create_map_of_static_fields(klassOop k) {
duke@435 844 HandleMark hm;
duke@435 845 instanceKlassHandle ikh = instanceKlassHandle(Thread::current(), k);
duke@435 846
duke@435 847 // create the field map
duke@435 848 ClassFieldMap* field_map = new ClassFieldMap();
duke@435 849
duke@435 850 FilteredFieldStream f(ikh, false, false);
duke@435 851 int max_field_index = f.field_count()-1;
duke@435 852
duke@435 853 int index = 0;
duke@435 854 for (FilteredFieldStream fld(ikh, true, true); !fld.eos(); fld.next(), index++) {
duke@435 855 // ignore instance fields
duke@435 856 if (!fld.access_flags().is_static()) {
duke@435 857 continue;
duke@435 858 }
duke@435 859 field_map->add(max_field_index - index, fld.signature()->byte_at(0), fld.offset());
duke@435 860 }
duke@435 861 return field_map;
duke@435 862 }
duke@435 863
duke@435 864 // Returns a heap allocated ClassFieldMap to describe the instance fields
duke@435 865 // of the given class. All instance fields are included (this means public
duke@435 866 // and private fields declared in superclasses and superinterfaces too).
duke@435 867 //
duke@435 868 ClassFieldMap* ClassFieldMap::create_map_of_instance_fields(oop obj) {
duke@435 869 HandleMark hm;
duke@435 870 instanceKlassHandle ikh = instanceKlassHandle(Thread::current(), obj->klass());
duke@435 871
duke@435 872 // create the field map
duke@435 873 ClassFieldMap* field_map = new ClassFieldMap();
duke@435 874
duke@435 875 FilteredFieldStream f(ikh, false, false);
duke@435 876
duke@435 877 int max_field_index = f.field_count()-1;
duke@435 878
duke@435 879 int index = 0;
duke@435 880 for (FilteredFieldStream fld(ikh, false, false); !fld.eos(); fld.next(), index++) {
duke@435 881 // ignore static fields
duke@435 882 if (fld.access_flags().is_static()) {
duke@435 883 continue;
duke@435 884 }
duke@435 885 field_map->add(max_field_index - index, fld.signature()->byte_at(0), fld.offset());
duke@435 886 }
duke@435 887
duke@435 888 return field_map;
duke@435 889 }
duke@435 890
duke@435 891 // Helper class used to cache a ClassFileMap for the instance fields of
duke@435 892 // a cache. A JvmtiCachedClassFieldMap can be cached by an instanceKlass during
duke@435 893 // heap iteration and avoid creating a field map for each object in the heap
duke@435 894 // (only need to create the map when the first instance of a class is encountered).
duke@435 895 //
zgu@3900 896 class JvmtiCachedClassFieldMap : public CHeapObj<mtInternal> {
duke@435 897 private:
duke@435 898 enum {
duke@435 899 initial_class_count = 200
duke@435 900 };
duke@435 901 ClassFieldMap* _field_map;
duke@435 902
duke@435 903 ClassFieldMap* field_map() const { return _field_map; }
duke@435 904
duke@435 905 JvmtiCachedClassFieldMap(ClassFieldMap* field_map);
duke@435 906 ~JvmtiCachedClassFieldMap();
duke@435 907
duke@435 908 static GrowableArray<instanceKlass*>* _class_list;
duke@435 909 static void add_to_class_list(instanceKlass* ik);
duke@435 910
duke@435 911 public:
duke@435 912 // returns the field map for a given object (returning map cached
duke@435 913 // by instanceKlass if possible
duke@435 914 static ClassFieldMap* get_map_of_instance_fields(oop obj);
duke@435 915
duke@435 916 // removes the field map from all instanceKlasses - should be
duke@435 917 // called before VM operation completes
duke@435 918 static void clear_cache();
duke@435 919
duke@435 920 // returns the number of ClassFieldMap cached by instanceKlasses
duke@435 921 static int cached_field_map_count();
duke@435 922 };
duke@435 923
duke@435 924 GrowableArray<instanceKlass*>* JvmtiCachedClassFieldMap::_class_list;
duke@435 925
duke@435 926 JvmtiCachedClassFieldMap::JvmtiCachedClassFieldMap(ClassFieldMap* field_map) {
duke@435 927 _field_map = field_map;
duke@435 928 }
duke@435 929
duke@435 930 JvmtiCachedClassFieldMap::~JvmtiCachedClassFieldMap() {
duke@435 931 if (_field_map != NULL) {
duke@435 932 delete _field_map;
duke@435 933 }
duke@435 934 }
duke@435 935
duke@435 936 // Marker class to ensure that the class file map cache is only used in a defined
duke@435 937 // scope.
duke@435 938 class ClassFieldMapCacheMark : public StackObj {
duke@435 939 private:
duke@435 940 static bool _is_active;
duke@435 941 public:
duke@435 942 ClassFieldMapCacheMark() {
duke@435 943 assert(Thread::current()->is_VM_thread(), "must be VMThread");
duke@435 944 assert(JvmtiCachedClassFieldMap::cached_field_map_count() == 0, "cache not empty");
duke@435 945 assert(!_is_active, "ClassFieldMapCacheMark cannot be nested");
duke@435 946 _is_active = true;
duke@435 947 }
duke@435 948 ~ClassFieldMapCacheMark() {
duke@435 949 JvmtiCachedClassFieldMap::clear_cache();
duke@435 950 _is_active = false;
duke@435 951 }
duke@435 952 static bool is_active() { return _is_active; }
duke@435 953 };
duke@435 954
duke@435 955 bool ClassFieldMapCacheMark::_is_active;
duke@435 956
duke@435 957
duke@435 958 // record that the given instanceKlass is caching a field map
duke@435 959 void JvmtiCachedClassFieldMap::add_to_class_list(instanceKlass* ik) {
duke@435 960 if (_class_list == NULL) {
zgu@3900 961 _class_list = new (ResourceObj::C_HEAP, mtInternal)
zgu@3900 962 GrowableArray<instanceKlass*>(initial_class_count, true);
duke@435 963 }
duke@435 964 _class_list->push(ik);
duke@435 965 }
duke@435 966
duke@435 967 // returns the instance field map for the given object
duke@435 968 // (returns field map cached by the instanceKlass if possible)
duke@435 969 ClassFieldMap* JvmtiCachedClassFieldMap::get_map_of_instance_fields(oop obj) {
duke@435 970 assert(Thread::current()->is_VM_thread(), "must be VMThread");
duke@435 971 assert(ClassFieldMapCacheMark::is_active(), "ClassFieldMapCacheMark not active");
duke@435 972
duke@435 973 klassOop k = obj->klass();
duke@435 974 instanceKlass* ik = instanceKlass::cast(k);
duke@435 975
duke@435 976 // return cached map if possible
duke@435 977 JvmtiCachedClassFieldMap* cached_map = ik->jvmti_cached_class_field_map();
duke@435 978 if (cached_map != NULL) {
duke@435 979 assert(cached_map->field_map() != NULL, "missing field list");
duke@435 980 return cached_map->field_map();
duke@435 981 } else {
duke@435 982 ClassFieldMap* field_map = ClassFieldMap::create_map_of_instance_fields(obj);
duke@435 983 cached_map = new JvmtiCachedClassFieldMap(field_map);
duke@435 984 ik->set_jvmti_cached_class_field_map(cached_map);
duke@435 985 add_to_class_list(ik);
duke@435 986 return field_map;
duke@435 987 }
duke@435 988 }
duke@435 989
duke@435 990 // remove the fields maps cached from all instanceKlasses
duke@435 991 void JvmtiCachedClassFieldMap::clear_cache() {
duke@435 992 assert(Thread::current()->is_VM_thread(), "must be VMThread");
duke@435 993 if (_class_list != NULL) {
duke@435 994 for (int i = 0; i < _class_list->length(); i++) {
duke@435 995 instanceKlass* ik = _class_list->at(i);
duke@435 996 JvmtiCachedClassFieldMap* cached_map = ik->jvmti_cached_class_field_map();
duke@435 997 assert(cached_map != NULL, "should not be NULL");
duke@435 998 ik->set_jvmti_cached_class_field_map(NULL);
duke@435 999 delete cached_map; // deletes the encapsulated field map
duke@435 1000 }
duke@435 1001 delete _class_list;
duke@435 1002 _class_list = NULL;
duke@435 1003 }
duke@435 1004 }
duke@435 1005
duke@435 1006 // returns the number of ClassFieldMap cached by instanceKlasses
duke@435 1007 int JvmtiCachedClassFieldMap::cached_field_map_count() {
duke@435 1008 return (_class_list == NULL) ? 0 : _class_list->length();
duke@435 1009 }
duke@435 1010
duke@435 1011 // helper function to indicate if an object is filtered by its tag or class tag
duke@435 1012 static inline bool is_filtered_by_heap_filter(jlong obj_tag,
duke@435 1013 jlong klass_tag,
duke@435 1014 int heap_filter) {
duke@435 1015 // apply the heap filter
duke@435 1016 if (obj_tag != 0) {
duke@435 1017 // filter out tagged objects
duke@435 1018 if (heap_filter & JVMTI_HEAP_FILTER_TAGGED) return true;
duke@435 1019 } else {
duke@435 1020 // filter out untagged objects
duke@435 1021 if (heap_filter & JVMTI_HEAP_FILTER_UNTAGGED) return true;
duke@435 1022 }
duke@435 1023 if (klass_tag != 0) {
duke@435 1024 // filter out objects with tagged classes
duke@435 1025 if (heap_filter & JVMTI_HEAP_FILTER_CLASS_TAGGED) return true;
duke@435 1026 } else {
duke@435 1027 // filter out objects with untagged classes.
duke@435 1028 if (heap_filter & JVMTI_HEAP_FILTER_CLASS_UNTAGGED) return true;
duke@435 1029 }
duke@435 1030 return false;
duke@435 1031 }
duke@435 1032
duke@435 1033 // helper function to indicate if an object is filtered by a klass filter
duke@435 1034 static inline bool is_filtered_by_klass_filter(oop obj, KlassHandle klass_filter) {
duke@435 1035 if (!klass_filter.is_null()) {
duke@435 1036 if (obj->klass() != klass_filter()) {
duke@435 1037 return true;
duke@435 1038 }
duke@435 1039 }
duke@435 1040 return false;
duke@435 1041 }
duke@435 1042
duke@435 1043 // helper function to tell if a field is a primitive field or not
duke@435 1044 static inline bool is_primitive_field_type(char type) {
duke@435 1045 return (type != 'L' && type != '[');
duke@435 1046 }
duke@435 1047
duke@435 1048 // helper function to copy the value from location addr to jvalue.
duke@435 1049 static inline void copy_to_jvalue(jvalue *v, address addr, jvmtiPrimitiveType value_type) {
duke@435 1050 switch (value_type) {
duke@435 1051 case JVMTI_PRIMITIVE_TYPE_BOOLEAN : { v->z = *(jboolean*)addr; break; }
duke@435 1052 case JVMTI_PRIMITIVE_TYPE_BYTE : { v->b = *(jbyte*)addr; break; }
duke@435 1053 case JVMTI_PRIMITIVE_TYPE_CHAR : { v->c = *(jchar*)addr; break; }
duke@435 1054 case JVMTI_PRIMITIVE_TYPE_SHORT : { v->s = *(jshort*)addr; break; }
duke@435 1055 case JVMTI_PRIMITIVE_TYPE_INT : { v->i = *(jint*)addr; break; }
duke@435 1056 case JVMTI_PRIMITIVE_TYPE_LONG : { v->j = *(jlong*)addr; break; }
duke@435 1057 case JVMTI_PRIMITIVE_TYPE_FLOAT : { v->f = *(jfloat*)addr; break; }
duke@435 1058 case JVMTI_PRIMITIVE_TYPE_DOUBLE : { v->d = *(jdouble*)addr; break; }
duke@435 1059 default: ShouldNotReachHere();
duke@435 1060 }
duke@435 1061 }
duke@435 1062
duke@435 1063 // helper function to invoke string primitive value callback
duke@435 1064 // returns visit control flags
duke@435 1065 static jint invoke_string_value_callback(jvmtiStringPrimitiveValueCallback cb,
duke@435 1066 CallbackWrapper* wrapper,
duke@435 1067 oop str,
duke@435 1068 void* user_data)
duke@435 1069 {
never@1577 1070 assert(str->klass() == SystemDictionary::String_klass(), "not a string");
duke@435 1071
duke@435 1072 // get the string value and length
duke@435 1073 // (string value may be offset from the base)
duke@435 1074 int s_len = java_lang_String::length(str);
duke@435 1075 typeArrayOop s_value = java_lang_String::value(str);
duke@435 1076 int s_offset = java_lang_String::offset(str);
duke@435 1077 jchar* value;
duke@435 1078 if (s_len > 0) {
duke@435 1079 value = s_value->char_at_addr(s_offset);
duke@435 1080 } else {
duke@435 1081 value = (jchar*) s_value->base(T_CHAR);
duke@435 1082 }
duke@435 1083
duke@435 1084 // invoke the callback
duke@435 1085 return (*cb)(wrapper->klass_tag(),
duke@435 1086 wrapper->obj_size(),
duke@435 1087 wrapper->obj_tag_p(),
duke@435 1088 value,
duke@435 1089 (jint)s_len,
duke@435 1090 user_data);
duke@435 1091 }
duke@435 1092
duke@435 1093 // helper function to invoke string primitive value callback
duke@435 1094 // returns visit control flags
duke@435 1095 static jint invoke_array_primitive_value_callback(jvmtiArrayPrimitiveValueCallback cb,
duke@435 1096 CallbackWrapper* wrapper,
duke@435 1097 oop obj,
duke@435 1098 void* user_data)
duke@435 1099 {
duke@435 1100 assert(obj->is_typeArray(), "not a primitive array");
duke@435 1101
duke@435 1102 // get base address of first element
duke@435 1103 typeArrayOop array = typeArrayOop(obj);
duke@435 1104 BasicType type = typeArrayKlass::cast(array->klass())->element_type();
duke@435 1105 void* elements = array->base(type);
duke@435 1106
duke@435 1107 // jvmtiPrimitiveType is defined so this mapping is always correct
duke@435 1108 jvmtiPrimitiveType elem_type = (jvmtiPrimitiveType)type2char(type);
duke@435 1109
duke@435 1110 return (*cb)(wrapper->klass_tag(),
duke@435 1111 wrapper->obj_size(),
duke@435 1112 wrapper->obj_tag_p(),
duke@435 1113 (jint)array->length(),
duke@435 1114 elem_type,
duke@435 1115 elements,
duke@435 1116 user_data);
duke@435 1117 }
duke@435 1118
duke@435 1119 // helper function to invoke the primitive field callback for all static fields
duke@435 1120 // of a given class
duke@435 1121 static jint invoke_primitive_field_callback_for_static_fields
duke@435 1122 (CallbackWrapper* wrapper,
duke@435 1123 oop obj,
duke@435 1124 jvmtiPrimitiveFieldCallback cb,
duke@435 1125 void* user_data)
duke@435 1126 {
duke@435 1127 // for static fields only the index will be set
duke@435 1128 static jvmtiHeapReferenceInfo reference_info = { 0 };
duke@435 1129
never@1577 1130 assert(obj->klass() == SystemDictionary::Class_klass(), "not a class");
duke@435 1131 if (java_lang_Class::is_primitive(obj)) {
duke@435 1132 return 0;
duke@435 1133 }
duke@435 1134 klassOop k = java_lang_Class::as_klassOop(obj);
duke@435 1135 Klass* klass = k->klass_part();
duke@435 1136
duke@435 1137 // ignore classes for object and type arrays
duke@435 1138 if (!klass->oop_is_instance()) {
duke@435 1139 return 0;
duke@435 1140 }
duke@435 1141
duke@435 1142 // ignore classes which aren't linked yet
duke@435 1143 instanceKlass* ik = instanceKlass::cast(k);
duke@435 1144 if (!ik->is_linked()) {
duke@435 1145 return 0;
duke@435 1146 }
duke@435 1147
duke@435 1148 // get the field map
duke@435 1149 ClassFieldMap* field_map = ClassFieldMap::create_map_of_static_fields(k);
duke@435 1150
duke@435 1151 // invoke the callback for each static primitive field
duke@435 1152 for (int i=0; i<field_map->field_count(); i++) {
duke@435 1153 ClassFieldDescriptor* field = field_map->field_at(i);
duke@435 1154
duke@435 1155 // ignore non-primitive fields
duke@435 1156 char type = field->field_type();
duke@435 1157 if (!is_primitive_field_type(type)) {
duke@435 1158 continue;
duke@435 1159 }
duke@435 1160 // one-to-one mapping
duke@435 1161 jvmtiPrimitiveType value_type = (jvmtiPrimitiveType)type;
duke@435 1162
duke@435 1163 // get offset and field value
duke@435 1164 int offset = field->field_offset();
duke@435 1165 address addr = (address)k + offset;
duke@435 1166 jvalue value;
duke@435 1167 copy_to_jvalue(&value, addr, value_type);
duke@435 1168
duke@435 1169 // field index
duke@435 1170 reference_info.field.index = field->field_index();
duke@435 1171
duke@435 1172 // invoke the callback
duke@435 1173 jint res = (*cb)(JVMTI_HEAP_REFERENCE_STATIC_FIELD,
duke@435 1174 &reference_info,
duke@435 1175 wrapper->klass_tag(),
duke@435 1176 wrapper->obj_tag_p(),
duke@435 1177 value,
duke@435 1178 value_type,
duke@435 1179 user_data);
duke@435 1180 if (res & JVMTI_VISIT_ABORT) {
duke@435 1181 delete field_map;
duke@435 1182 return res;
duke@435 1183 }
duke@435 1184 }
duke@435 1185
duke@435 1186 delete field_map;
duke@435 1187 return 0;
duke@435 1188 }
duke@435 1189
duke@435 1190 // helper function to invoke the primitive field callback for all instance fields
duke@435 1191 // of a given object
duke@435 1192 static jint invoke_primitive_field_callback_for_instance_fields(
duke@435 1193 CallbackWrapper* wrapper,
duke@435 1194 oop obj,
duke@435 1195 jvmtiPrimitiveFieldCallback cb,
duke@435 1196 void* user_data)
duke@435 1197 {
duke@435 1198 // for instance fields only the index will be set
duke@435 1199 static jvmtiHeapReferenceInfo reference_info = { 0 };
duke@435 1200
duke@435 1201 // get the map of the instance fields
duke@435 1202 ClassFieldMap* fields = JvmtiCachedClassFieldMap::get_map_of_instance_fields(obj);
duke@435 1203
duke@435 1204 // invoke the callback for each instance primitive field
duke@435 1205 for (int i=0; i<fields->field_count(); i++) {
duke@435 1206 ClassFieldDescriptor* field = fields->field_at(i);
duke@435 1207
duke@435 1208 // ignore non-primitive fields
duke@435 1209 char type = field->field_type();
duke@435 1210 if (!is_primitive_field_type(type)) {
duke@435 1211 continue;
duke@435 1212 }
duke@435 1213 // one-to-one mapping
duke@435 1214 jvmtiPrimitiveType value_type = (jvmtiPrimitiveType)type;
duke@435 1215
duke@435 1216 // get offset and field value
duke@435 1217 int offset = field->field_offset();
duke@435 1218 address addr = (address)obj + offset;
duke@435 1219 jvalue value;
duke@435 1220 copy_to_jvalue(&value, addr, value_type);
duke@435 1221
duke@435 1222 // field index
duke@435 1223 reference_info.field.index = field->field_index();
duke@435 1224
duke@435 1225 // invoke the callback
duke@435 1226 jint res = (*cb)(JVMTI_HEAP_REFERENCE_FIELD,
duke@435 1227 &reference_info,
duke@435 1228 wrapper->klass_tag(),
duke@435 1229 wrapper->obj_tag_p(),
duke@435 1230 value,
duke@435 1231 value_type,
duke@435 1232 user_data);
duke@435 1233 if (res & JVMTI_VISIT_ABORT) {
duke@435 1234 return res;
duke@435 1235 }
duke@435 1236 }
duke@435 1237 return 0;
duke@435 1238 }
duke@435 1239
duke@435 1240
duke@435 1241 // VM operation to iterate over all objects in the heap (both reachable
duke@435 1242 // and unreachable)
duke@435 1243 class VM_HeapIterateOperation: public VM_Operation {
duke@435 1244 private:
duke@435 1245 ObjectClosure* _blk;
duke@435 1246 public:
duke@435 1247 VM_HeapIterateOperation(ObjectClosure* blk) { _blk = blk; }
duke@435 1248
duke@435 1249 VMOp_Type type() const { return VMOp_HeapIterateOperation; }
duke@435 1250 void doit() {
duke@435 1251 // allows class files maps to be cached during iteration
duke@435 1252 ClassFieldMapCacheMark cm;
duke@435 1253
duke@435 1254 // make sure that heap is parsable (fills TLABs with filler objects)
duke@435 1255 Universe::heap()->ensure_parsability(false); // no need to retire TLABs
duke@435 1256
duke@435 1257 // Verify heap before iteration - if the heap gets corrupted then
duke@435 1258 // JVMTI's IterateOverHeap will crash.
duke@435 1259 if (VerifyBeforeIteration) {
duke@435 1260 Universe::verify();
duke@435 1261 }
duke@435 1262
duke@435 1263 // do the iteration
jmasa@952 1264 // If this operation encounters a bad object when using CMS,
jmasa@952 1265 // consider using safe_object_iterate() which avoids perm gen
jmasa@952 1266 // objects that may contain bad references.
duke@435 1267 Universe::heap()->object_iterate(_blk);
duke@435 1268
duke@435 1269 // when sharing is enabled we must iterate over the shared spaces
duke@435 1270 if (UseSharedSpaces) {
duke@435 1271 GenCollectedHeap* gch = GenCollectedHeap::heap();
duke@435 1272 CompactingPermGenGen* gen = (CompactingPermGenGen*)gch->perm_gen();
duke@435 1273 gen->ro_space()->object_iterate(_blk);
duke@435 1274 gen->rw_space()->object_iterate(_blk);
duke@435 1275 }
duke@435 1276 }
duke@435 1277
duke@435 1278 };
duke@435 1279
duke@435 1280
duke@435 1281 // An ObjectClosure used to support the deprecated IterateOverHeap and
duke@435 1282 // IterateOverInstancesOfClass functions
duke@435 1283 class IterateOverHeapObjectClosure: public ObjectClosure {
duke@435 1284 private:
duke@435 1285 JvmtiTagMap* _tag_map;
duke@435 1286 KlassHandle _klass;
duke@435 1287 jvmtiHeapObjectFilter _object_filter;
duke@435 1288 jvmtiHeapObjectCallback _heap_object_callback;
duke@435 1289 const void* _user_data;
duke@435 1290
duke@435 1291 // accessors
duke@435 1292 JvmtiTagMap* tag_map() const { return _tag_map; }
duke@435 1293 jvmtiHeapObjectFilter object_filter() const { return _object_filter; }
duke@435 1294 jvmtiHeapObjectCallback object_callback() const { return _heap_object_callback; }
duke@435 1295 KlassHandle klass() const { return _klass; }
duke@435 1296 const void* user_data() const { return _user_data; }
duke@435 1297
duke@435 1298 // indicates if iteration has been aborted
duke@435 1299 bool _iteration_aborted;
duke@435 1300 bool is_iteration_aborted() const { return _iteration_aborted; }
duke@435 1301 void set_iteration_aborted(bool aborted) { _iteration_aborted = aborted; }
duke@435 1302
duke@435 1303 public:
duke@435 1304 IterateOverHeapObjectClosure(JvmtiTagMap* tag_map,
duke@435 1305 KlassHandle klass,
duke@435 1306 jvmtiHeapObjectFilter object_filter,
duke@435 1307 jvmtiHeapObjectCallback heap_object_callback,
duke@435 1308 const void* user_data) :
duke@435 1309 _tag_map(tag_map),
duke@435 1310 _klass(klass),
duke@435 1311 _object_filter(object_filter),
duke@435 1312 _heap_object_callback(heap_object_callback),
duke@435 1313 _user_data(user_data),
duke@435 1314 _iteration_aborted(false)
duke@435 1315 {
duke@435 1316 }
duke@435 1317
duke@435 1318 void do_object(oop o);
duke@435 1319 };
duke@435 1320
duke@435 1321 // invoked for each object in the heap
duke@435 1322 void IterateOverHeapObjectClosure::do_object(oop o) {
duke@435 1323 // check if iteration has been halted
duke@435 1324 if (is_iteration_aborted()) return;
duke@435 1325
duke@435 1326 // ignore any objects that aren't visible to profiler
duke@435 1327 if (!ServiceUtil::visible_oop(o)) return;
duke@435 1328
duke@435 1329 // instanceof check when filtering by klass
duke@435 1330 if (!klass().is_null() && !o->is_a(klass()())) {
duke@435 1331 return;
duke@435 1332 }
duke@435 1333 // prepare for the calllback
duke@435 1334 CallbackWrapper wrapper(tag_map(), o);
duke@435 1335
duke@435 1336 // if the object is tagged and we're only interested in untagged objects
duke@435 1337 // then don't invoke the callback. Similiarly, if the object is untagged
duke@435 1338 // and we're only interested in tagged objects we skip the callback.
duke@435 1339 if (wrapper.obj_tag() != 0) {
duke@435 1340 if (object_filter() == JVMTI_HEAP_OBJECT_UNTAGGED) return;
duke@435 1341 } else {
duke@435 1342 if (object_filter() == JVMTI_HEAP_OBJECT_TAGGED) return;
duke@435 1343 }
duke@435 1344
duke@435 1345 // invoke the agent's callback
duke@435 1346 jvmtiIterationControl control = (*object_callback())(wrapper.klass_tag(),
duke@435 1347 wrapper.obj_size(),
duke@435 1348 wrapper.obj_tag_p(),
duke@435 1349 (void*)user_data());
duke@435 1350 if (control == JVMTI_ITERATION_ABORT) {
duke@435 1351 set_iteration_aborted(true);
duke@435 1352 }
duke@435 1353 }
duke@435 1354
duke@435 1355 // An ObjectClosure used to support the IterateThroughHeap function
duke@435 1356 class IterateThroughHeapObjectClosure: public ObjectClosure {
duke@435 1357 private:
duke@435 1358 JvmtiTagMap* _tag_map;
duke@435 1359 KlassHandle _klass;
duke@435 1360 int _heap_filter;
duke@435 1361 const jvmtiHeapCallbacks* _callbacks;
duke@435 1362 const void* _user_data;
duke@435 1363
duke@435 1364 // accessor functions
duke@435 1365 JvmtiTagMap* tag_map() const { return _tag_map; }
duke@435 1366 int heap_filter() const { return _heap_filter; }
duke@435 1367 const jvmtiHeapCallbacks* callbacks() const { return _callbacks; }
duke@435 1368 KlassHandle klass() const { return _klass; }
duke@435 1369 const void* user_data() const { return _user_data; }
duke@435 1370
duke@435 1371 // indicates if the iteration has been aborted
duke@435 1372 bool _iteration_aborted;
duke@435 1373 bool is_iteration_aborted() const { return _iteration_aborted; }
duke@435 1374
duke@435 1375 // used to check the visit control flags. If the abort flag is set
duke@435 1376 // then we set the iteration aborted flag so that the iteration completes
duke@435 1377 // without processing any further objects
duke@435 1378 bool check_flags_for_abort(jint flags) {
duke@435 1379 bool is_abort = (flags & JVMTI_VISIT_ABORT) != 0;
duke@435 1380 if (is_abort) {
duke@435 1381 _iteration_aborted = true;
duke@435 1382 }
duke@435 1383 return is_abort;
duke@435 1384 }
duke@435 1385
duke@435 1386 public:
duke@435 1387 IterateThroughHeapObjectClosure(JvmtiTagMap* tag_map,
duke@435 1388 KlassHandle klass,
duke@435 1389 int heap_filter,
duke@435 1390 const jvmtiHeapCallbacks* heap_callbacks,
duke@435 1391 const void* user_data) :
duke@435 1392 _tag_map(tag_map),
duke@435 1393 _klass(klass),
duke@435 1394 _heap_filter(heap_filter),
duke@435 1395 _callbacks(heap_callbacks),
duke@435 1396 _user_data(user_data),
duke@435 1397 _iteration_aborted(false)
duke@435 1398 {
duke@435 1399 }
duke@435 1400
duke@435 1401 void do_object(oop o);
duke@435 1402 };
duke@435 1403
duke@435 1404 // invoked for each object in the heap
duke@435 1405 void IterateThroughHeapObjectClosure::do_object(oop obj) {
duke@435 1406 // check if iteration has been halted
duke@435 1407 if (is_iteration_aborted()) return;
duke@435 1408
duke@435 1409 // ignore any objects that aren't visible to profiler
duke@435 1410 if (!ServiceUtil::visible_oop(obj)) return;
duke@435 1411
duke@435 1412 // apply class filter
duke@435 1413 if (is_filtered_by_klass_filter(obj, klass())) return;
duke@435 1414
duke@435 1415 // prepare for callback
duke@435 1416 CallbackWrapper wrapper(tag_map(), obj);
duke@435 1417
duke@435 1418 // check if filtered by the heap filter
duke@435 1419 if (is_filtered_by_heap_filter(wrapper.obj_tag(), wrapper.klass_tag(), heap_filter())) {
duke@435 1420 return;
duke@435 1421 }
duke@435 1422
duke@435 1423 // for arrays we need the length, otherwise -1
duke@435 1424 bool is_array = obj->is_array();
duke@435 1425 int len = is_array ? arrayOop(obj)->length() : -1;
duke@435 1426
duke@435 1427 // invoke the object callback (if callback is provided)
duke@435 1428 if (callbacks()->heap_iteration_callback != NULL) {
duke@435 1429 jvmtiHeapIterationCallback cb = callbacks()->heap_iteration_callback;
duke@435 1430 jint res = (*cb)(wrapper.klass_tag(),
duke@435 1431 wrapper.obj_size(),
duke@435 1432 wrapper.obj_tag_p(),
duke@435 1433 (jint)len,
duke@435 1434 (void*)user_data());
duke@435 1435 if (check_flags_for_abort(res)) return;
duke@435 1436 }
duke@435 1437
duke@435 1438 // for objects and classes we report primitive fields if callback provided
duke@435 1439 if (callbacks()->primitive_field_callback != NULL && obj->is_instance()) {
duke@435 1440 jint res;
duke@435 1441 jvmtiPrimitiveFieldCallback cb = callbacks()->primitive_field_callback;
never@1577 1442 if (obj->klass() == SystemDictionary::Class_klass()) {
duke@435 1443 res = invoke_primitive_field_callback_for_static_fields(&wrapper,
duke@435 1444 obj,
duke@435 1445 cb,
duke@435 1446 (void*)user_data());
duke@435 1447 } else {
duke@435 1448 res = invoke_primitive_field_callback_for_instance_fields(&wrapper,
duke@435 1449 obj,
duke@435 1450 cb,
duke@435 1451 (void*)user_data());
duke@435 1452 }
duke@435 1453 if (check_flags_for_abort(res)) return;
duke@435 1454 }
duke@435 1455
duke@435 1456 // string callback
duke@435 1457 if (!is_array &&
duke@435 1458 callbacks()->string_primitive_value_callback != NULL &&
never@1577 1459 obj->klass() == SystemDictionary::String_klass()) {
duke@435 1460 jint res = invoke_string_value_callback(
duke@435 1461 callbacks()->string_primitive_value_callback,
duke@435 1462 &wrapper,
duke@435 1463 obj,
duke@435 1464 (void*)user_data() );
duke@435 1465 if (check_flags_for_abort(res)) return;
duke@435 1466 }
duke@435 1467
duke@435 1468 // array callback
duke@435 1469 if (is_array &&
duke@435 1470 callbacks()->array_primitive_value_callback != NULL &&
duke@435 1471 obj->is_typeArray()) {
duke@435 1472 jint res = invoke_array_primitive_value_callback(
duke@435 1473 callbacks()->array_primitive_value_callback,
duke@435 1474 &wrapper,
duke@435 1475 obj,
duke@435 1476 (void*)user_data() );
duke@435 1477 if (check_flags_for_abort(res)) return;
duke@435 1478 }
duke@435 1479 };
duke@435 1480
duke@435 1481
duke@435 1482 // Deprecated function to iterate over all objects in the heap
duke@435 1483 void JvmtiTagMap::iterate_over_heap(jvmtiHeapObjectFilter object_filter,
duke@435 1484 KlassHandle klass,
duke@435 1485 jvmtiHeapObjectCallback heap_object_callback,
duke@435 1486 const void* user_data)
duke@435 1487 {
duke@435 1488 MutexLocker ml(Heap_lock);
duke@435 1489 IterateOverHeapObjectClosure blk(this,
duke@435 1490 klass,
duke@435 1491 object_filter,
duke@435 1492 heap_object_callback,
duke@435 1493 user_data);
duke@435 1494 VM_HeapIterateOperation op(&blk);
duke@435 1495 VMThread::execute(&op);
duke@435 1496 }
duke@435 1497
duke@435 1498
duke@435 1499 // Iterates over all objects in the heap
duke@435 1500 void JvmtiTagMap::iterate_through_heap(jint heap_filter,
duke@435 1501 KlassHandle klass,
duke@435 1502 const jvmtiHeapCallbacks* callbacks,
duke@435 1503 const void* user_data)
duke@435 1504 {
duke@435 1505 MutexLocker ml(Heap_lock);
duke@435 1506 IterateThroughHeapObjectClosure blk(this,
duke@435 1507 klass,
duke@435 1508 heap_filter,
duke@435 1509 callbacks,
duke@435 1510 user_data);
duke@435 1511 VM_HeapIterateOperation op(&blk);
duke@435 1512 VMThread::execute(&op);
duke@435 1513 }
duke@435 1514
duke@435 1515 // support class for get_objects_with_tags
duke@435 1516
duke@435 1517 class TagObjectCollector : public JvmtiTagHashmapEntryClosure {
duke@435 1518 private:
duke@435 1519 JvmtiEnv* _env;
duke@435 1520 jlong* _tags;
duke@435 1521 jint _tag_count;
duke@435 1522
duke@435 1523 GrowableArray<jobject>* _object_results; // collected objects (JNI weak refs)
duke@435 1524 GrowableArray<uint64_t>* _tag_results; // collected tags
duke@435 1525
duke@435 1526 public:
duke@435 1527 TagObjectCollector(JvmtiEnv* env, const jlong* tags, jint tag_count) {
duke@435 1528 _env = env;
duke@435 1529 _tags = (jlong*)tags;
duke@435 1530 _tag_count = tag_count;
zgu@3900 1531 _object_results = new (ResourceObj::C_HEAP, mtInternal) GrowableArray<jobject>(1,true);
zgu@3900 1532 _tag_results = new (ResourceObj::C_HEAP, mtInternal) GrowableArray<uint64_t>(1,true);
duke@435 1533 }
duke@435 1534
duke@435 1535 ~TagObjectCollector() {
duke@435 1536 delete _object_results;
duke@435 1537 delete _tag_results;
duke@435 1538 }
duke@435 1539
duke@435 1540 // for each tagged object check if the tag value matches
duke@435 1541 // - if it matches then we create a JNI local reference to the object
duke@435 1542 // and record the reference and tag value.
duke@435 1543 //
duke@435 1544 void do_entry(JvmtiTagHashmapEntry* entry) {
duke@435 1545 for (int i=0; i<_tag_count; i++) {
duke@435 1546 if (_tags[i] == entry->tag()) {
kamg@2445 1547 oop o = entry->object();
kamg@2445 1548 assert(o != NULL, "sanity check");
duke@435 1549
duke@435 1550 // the mirror is tagged
duke@435 1551 if (o->is_klass()) {
duke@435 1552 klassOop k = (klassOop)o;
duke@435 1553 o = Klass::cast(k)->java_mirror();
duke@435 1554 }
duke@435 1555
duke@435 1556 jobject ref = JNIHandles::make_local(JavaThread::current(), o);
duke@435 1557 _object_results->append(ref);
duke@435 1558 _tag_results->append((uint64_t)entry->tag());
duke@435 1559 }
duke@435 1560 }
duke@435 1561 }
duke@435 1562
duke@435 1563 // return the results from the collection
duke@435 1564 //
duke@435 1565 jvmtiError result(jint* count_ptr, jobject** object_result_ptr, jlong** tag_result_ptr) {
duke@435 1566 jvmtiError error;
duke@435 1567 int count = _object_results->length();
duke@435 1568 assert(count >= 0, "sanity check");
duke@435 1569
duke@435 1570 // if object_result_ptr is not NULL then allocate the result and copy
duke@435 1571 // in the object references.
duke@435 1572 if (object_result_ptr != NULL) {
duke@435 1573 error = _env->Allocate(count * sizeof(jobject), (unsigned char**)object_result_ptr);
duke@435 1574 if (error != JVMTI_ERROR_NONE) {
duke@435 1575 return error;
duke@435 1576 }
duke@435 1577 for (int i=0; i<count; i++) {
duke@435 1578 (*object_result_ptr)[i] = _object_results->at(i);
duke@435 1579 }
duke@435 1580 }
duke@435 1581
duke@435 1582 // if tag_result_ptr is not NULL then allocate the result and copy
duke@435 1583 // in the tag values.
duke@435 1584 if (tag_result_ptr != NULL) {
duke@435 1585 error = _env->Allocate(count * sizeof(jlong), (unsigned char**)tag_result_ptr);
duke@435 1586 if (error != JVMTI_ERROR_NONE) {
duke@435 1587 if (object_result_ptr != NULL) {
duke@435 1588 _env->Deallocate((unsigned char*)object_result_ptr);
duke@435 1589 }
duke@435 1590 return error;
duke@435 1591 }
duke@435 1592 for (int i=0; i<count; i++) {
duke@435 1593 (*tag_result_ptr)[i] = (jlong)_tag_results->at(i);
duke@435 1594 }
duke@435 1595 }
duke@435 1596
duke@435 1597 *count_ptr = count;
duke@435 1598 return JVMTI_ERROR_NONE;
duke@435 1599 }
duke@435 1600 };
duke@435 1601
duke@435 1602 // return the list of objects with the specified tags
duke@435 1603 jvmtiError JvmtiTagMap::get_objects_with_tags(const jlong* tags,
duke@435 1604 jint count, jint* count_ptr, jobject** object_result_ptr, jlong** tag_result_ptr) {
duke@435 1605
duke@435 1606 TagObjectCollector collector(env(), tags, count);
duke@435 1607 {
duke@435 1608 // iterate over all tagged objects
duke@435 1609 MutexLocker ml(lock());
duke@435 1610 entry_iterate(&collector);
duke@435 1611 }
duke@435 1612 return collector.result(count_ptr, object_result_ptr, tag_result_ptr);
duke@435 1613 }
duke@435 1614
duke@435 1615
duke@435 1616 // ObjectMarker is used to support the marking objects when walking the
duke@435 1617 // heap.
duke@435 1618 //
duke@435 1619 // This implementation uses the existing mark bits in an object for
duke@435 1620 // marking. Objects that are marked must later have their headers restored.
duke@435 1621 // As most objects are unlocked and don't have their identity hash computed
duke@435 1622 // we don't have to save their headers. Instead we save the headers that
duke@435 1623 // are "interesting". Later when the headers are restored this implementation
duke@435 1624 // restores all headers to their initial value and then restores the few
duke@435 1625 // objects that had interesting headers.
duke@435 1626 //
duke@435 1627 // Future work: This implementation currently uses growable arrays to save
duke@435 1628 // the oop and header of interesting objects. As an optimization we could
duke@435 1629 // use the same technique as the GC and make use of the unused area
duke@435 1630 // between top() and end().
duke@435 1631 //
duke@435 1632
duke@435 1633 // An ObjectClosure used to restore the mark bits of an object
duke@435 1634 class RestoreMarksClosure : public ObjectClosure {
duke@435 1635 public:
duke@435 1636 void do_object(oop o) {
duke@435 1637 if (o != NULL) {
duke@435 1638 markOop mark = o->mark();
duke@435 1639 if (mark->is_marked()) {
duke@435 1640 o->init_mark();
duke@435 1641 }
duke@435 1642 }
duke@435 1643 }
duke@435 1644 };
duke@435 1645
duke@435 1646 // ObjectMarker provides the mark and visited functions
duke@435 1647 class ObjectMarker : AllStatic {
duke@435 1648 private:
duke@435 1649 // saved headers
duke@435 1650 static GrowableArray<oop>* _saved_oop_stack;
duke@435 1651 static GrowableArray<markOop>* _saved_mark_stack;
dcubed@3013 1652 static bool _needs_reset; // do we need to reset mark bits?
duke@435 1653
duke@435 1654 public:
duke@435 1655 static void init(); // initialize
duke@435 1656 static void done(); // clean-up
duke@435 1657
duke@435 1658 static inline void mark(oop o); // mark an object
duke@435 1659 static inline bool visited(oop o); // check if object has been visited
dcubed@3013 1660
dcubed@3013 1661 static inline bool needs_reset() { return _needs_reset; }
dcubed@3013 1662 static inline void set_needs_reset(bool v) { _needs_reset = v; }
duke@435 1663 };
duke@435 1664
duke@435 1665 GrowableArray<oop>* ObjectMarker::_saved_oop_stack = NULL;
duke@435 1666 GrowableArray<markOop>* ObjectMarker::_saved_mark_stack = NULL;
dcubed@3013 1667 bool ObjectMarker::_needs_reset = true; // need to reset mark bits by default
duke@435 1668
duke@435 1669 // initialize ObjectMarker - prepares for object marking
duke@435 1670 void ObjectMarker::init() {
duke@435 1671 assert(Thread::current()->is_VM_thread(), "must be VMThread");
duke@435 1672
duke@435 1673 // prepare heap for iteration
duke@435 1674 Universe::heap()->ensure_parsability(false); // no need to retire TLABs
duke@435 1675
duke@435 1676 // create stacks for interesting headers
zgu@3900 1677 _saved_mark_stack = new (ResourceObj::C_HEAP, mtInternal) GrowableArray<markOop>(4000, true);
zgu@3900 1678 _saved_oop_stack = new (ResourceObj::C_HEAP, mtInternal) GrowableArray<oop>(4000, true);
duke@435 1679
duke@435 1680 if (UseBiasedLocking) {
duke@435 1681 BiasedLocking::preserve_marks();
duke@435 1682 }
duke@435 1683 }
duke@435 1684
duke@435 1685 // Object marking is done so restore object headers
duke@435 1686 void ObjectMarker::done() {
duke@435 1687 // iterate over all objects and restore the mark bits to
duke@435 1688 // their initial value
duke@435 1689 RestoreMarksClosure blk;
dcubed@3013 1690 if (needs_reset()) {
dcubed@3013 1691 Universe::heap()->object_iterate(&blk);
dcubed@3013 1692 } else {
dcubed@3013 1693 // We don't need to reset mark bits on this call, but reset the
dcubed@3013 1694 // flag to the default for the next call.
dcubed@3013 1695 set_needs_reset(true);
dcubed@3013 1696 }
duke@435 1697
duke@435 1698 // When sharing is enabled we need to restore the headers of the objects
duke@435 1699 // in the readwrite space too.
duke@435 1700 if (UseSharedSpaces) {
duke@435 1701 GenCollectedHeap* gch = GenCollectedHeap::heap();
duke@435 1702 CompactingPermGenGen* gen = (CompactingPermGenGen*)gch->perm_gen();
duke@435 1703 gen->rw_space()->object_iterate(&blk);
duke@435 1704 }
duke@435 1705
duke@435 1706 // now restore the interesting headers
duke@435 1707 for (int i = 0; i < _saved_oop_stack->length(); i++) {
duke@435 1708 oop o = _saved_oop_stack->at(i);
duke@435 1709 markOop mark = _saved_mark_stack->at(i);
duke@435 1710 o->set_mark(mark);
duke@435 1711 }
duke@435 1712
duke@435 1713 if (UseBiasedLocking) {
duke@435 1714 BiasedLocking::restore_marks();
duke@435 1715 }
duke@435 1716
duke@435 1717 // free the stacks
duke@435 1718 delete _saved_oop_stack;
duke@435 1719 delete _saved_mark_stack;
duke@435 1720 }
duke@435 1721
duke@435 1722 // mark an object
duke@435 1723 inline void ObjectMarker::mark(oop o) {
duke@435 1724 assert(Universe::heap()->is_in(o), "sanity check");
duke@435 1725 assert(!o->mark()->is_marked(), "should only mark an object once");
duke@435 1726
duke@435 1727 // object's mark word
duke@435 1728 markOop mark = o->mark();
duke@435 1729
duke@435 1730 if (mark->must_be_preserved(o)) {
duke@435 1731 _saved_mark_stack->push(mark);
duke@435 1732 _saved_oop_stack->push(o);
duke@435 1733 }
duke@435 1734
duke@435 1735 // mark the object
duke@435 1736 o->set_mark(markOopDesc::prototype()->set_marked());
duke@435 1737 }
duke@435 1738
duke@435 1739 // return true if object is marked
duke@435 1740 inline bool ObjectMarker::visited(oop o) {
duke@435 1741 return o->mark()->is_marked();
duke@435 1742 }
duke@435 1743
duke@435 1744 // Stack allocated class to help ensure that ObjectMarker is used
duke@435 1745 // correctly. Constructor initializes ObjectMarker, destructor calls
duke@435 1746 // ObjectMarker's done() function to restore object headers.
duke@435 1747 class ObjectMarkerController : public StackObj {
duke@435 1748 public:
duke@435 1749 ObjectMarkerController() {
duke@435 1750 ObjectMarker::init();
duke@435 1751 }
duke@435 1752 ~ObjectMarkerController() {
duke@435 1753 ObjectMarker::done();
duke@435 1754 }
duke@435 1755 };
duke@435 1756
duke@435 1757
duke@435 1758 // helper to map a jvmtiHeapReferenceKind to an old style jvmtiHeapRootKind
duke@435 1759 // (not performance critical as only used for roots)
duke@435 1760 static jvmtiHeapRootKind toJvmtiHeapRootKind(jvmtiHeapReferenceKind kind) {
duke@435 1761 switch (kind) {
duke@435 1762 case JVMTI_HEAP_REFERENCE_JNI_GLOBAL: return JVMTI_HEAP_ROOT_JNI_GLOBAL;
duke@435 1763 case JVMTI_HEAP_REFERENCE_SYSTEM_CLASS: return JVMTI_HEAP_ROOT_SYSTEM_CLASS;
duke@435 1764 case JVMTI_HEAP_REFERENCE_MONITOR: return JVMTI_HEAP_ROOT_MONITOR;
duke@435 1765 case JVMTI_HEAP_REFERENCE_STACK_LOCAL: return JVMTI_HEAP_ROOT_STACK_LOCAL;
duke@435 1766 case JVMTI_HEAP_REFERENCE_JNI_LOCAL: return JVMTI_HEAP_ROOT_JNI_LOCAL;
duke@435 1767 case JVMTI_HEAP_REFERENCE_THREAD: return JVMTI_HEAP_ROOT_THREAD;
duke@435 1768 case JVMTI_HEAP_REFERENCE_OTHER: return JVMTI_HEAP_ROOT_OTHER;
duke@435 1769 default: ShouldNotReachHere(); return JVMTI_HEAP_ROOT_OTHER;
duke@435 1770 }
duke@435 1771 }
duke@435 1772
duke@435 1773 // Base class for all heap walk contexts. The base class maintains a flag
duke@435 1774 // to indicate if the context is valid or not.
duke@435 1775 class HeapWalkContext VALUE_OBJ_CLASS_SPEC {
duke@435 1776 private:
duke@435 1777 bool _valid;
duke@435 1778 public:
duke@435 1779 HeapWalkContext(bool valid) { _valid = valid; }
duke@435 1780 void invalidate() { _valid = false; }
duke@435 1781 bool is_valid() const { return _valid; }
duke@435 1782 };
duke@435 1783
duke@435 1784 // A basic heap walk context for the deprecated heap walking functions.
duke@435 1785 // The context for a basic heap walk are the callbacks and fields used by
duke@435 1786 // the referrer caching scheme.
duke@435 1787 class BasicHeapWalkContext: public HeapWalkContext {
duke@435 1788 private:
duke@435 1789 jvmtiHeapRootCallback _heap_root_callback;
duke@435 1790 jvmtiStackReferenceCallback _stack_ref_callback;
duke@435 1791 jvmtiObjectReferenceCallback _object_ref_callback;
duke@435 1792
duke@435 1793 // used for caching
duke@435 1794 oop _last_referrer;
duke@435 1795 jlong _last_referrer_tag;
duke@435 1796
duke@435 1797 public:
duke@435 1798 BasicHeapWalkContext() : HeapWalkContext(false) { }
duke@435 1799
duke@435 1800 BasicHeapWalkContext(jvmtiHeapRootCallback heap_root_callback,
duke@435 1801 jvmtiStackReferenceCallback stack_ref_callback,
duke@435 1802 jvmtiObjectReferenceCallback object_ref_callback) :
duke@435 1803 HeapWalkContext(true),
duke@435 1804 _heap_root_callback(heap_root_callback),
duke@435 1805 _stack_ref_callback(stack_ref_callback),
duke@435 1806 _object_ref_callback(object_ref_callback),
duke@435 1807 _last_referrer(NULL),
duke@435 1808 _last_referrer_tag(0) {
duke@435 1809 }
duke@435 1810
duke@435 1811 // accessors
duke@435 1812 jvmtiHeapRootCallback heap_root_callback() const { return _heap_root_callback; }
duke@435 1813 jvmtiStackReferenceCallback stack_ref_callback() const { return _stack_ref_callback; }
duke@435 1814 jvmtiObjectReferenceCallback object_ref_callback() const { return _object_ref_callback; }
duke@435 1815
duke@435 1816 oop last_referrer() const { return _last_referrer; }
duke@435 1817 void set_last_referrer(oop referrer) { _last_referrer = referrer; }
duke@435 1818 jlong last_referrer_tag() const { return _last_referrer_tag; }
duke@435 1819 void set_last_referrer_tag(jlong value) { _last_referrer_tag = value; }
duke@435 1820 };
duke@435 1821
duke@435 1822 // The advanced heap walk context for the FollowReferences functions.
duke@435 1823 // The context is the callbacks, and the fields used for filtering.
duke@435 1824 class AdvancedHeapWalkContext: public HeapWalkContext {
duke@435 1825 private:
duke@435 1826 jint _heap_filter;
duke@435 1827 KlassHandle _klass_filter;
duke@435 1828 const jvmtiHeapCallbacks* _heap_callbacks;
duke@435 1829
duke@435 1830 public:
duke@435 1831 AdvancedHeapWalkContext() : HeapWalkContext(false) { }
duke@435 1832
duke@435 1833 AdvancedHeapWalkContext(jint heap_filter,
duke@435 1834 KlassHandle klass_filter,
duke@435 1835 const jvmtiHeapCallbacks* heap_callbacks) :
duke@435 1836 HeapWalkContext(true),
duke@435 1837 _heap_filter(heap_filter),
duke@435 1838 _klass_filter(klass_filter),
duke@435 1839 _heap_callbacks(heap_callbacks) {
duke@435 1840 }
duke@435 1841
duke@435 1842 // accessors
duke@435 1843 jint heap_filter() const { return _heap_filter; }
duke@435 1844 KlassHandle klass_filter() const { return _klass_filter; }
duke@435 1845
duke@435 1846 const jvmtiHeapReferenceCallback heap_reference_callback() const {
duke@435 1847 return _heap_callbacks->heap_reference_callback;
duke@435 1848 };
duke@435 1849 const jvmtiPrimitiveFieldCallback primitive_field_callback() const {
duke@435 1850 return _heap_callbacks->primitive_field_callback;
duke@435 1851 }
duke@435 1852 const jvmtiArrayPrimitiveValueCallback array_primitive_value_callback() const {
duke@435 1853 return _heap_callbacks->array_primitive_value_callback;
duke@435 1854 }
duke@435 1855 const jvmtiStringPrimitiveValueCallback string_primitive_value_callback() const {
duke@435 1856 return _heap_callbacks->string_primitive_value_callback;
duke@435 1857 }
duke@435 1858 };
duke@435 1859
duke@435 1860 // The CallbackInvoker is a class with static functions that the heap walk can call
duke@435 1861 // into to invoke callbacks. It works in one of two modes. The "basic" mode is
duke@435 1862 // used for the deprecated IterateOverReachableObjects functions. The "advanced"
duke@435 1863 // mode is for the newer FollowReferences function which supports a lot of
duke@435 1864 // additional callbacks.
duke@435 1865 class CallbackInvoker : AllStatic {
duke@435 1866 private:
duke@435 1867 // heap walk styles
duke@435 1868 enum { basic, advanced };
duke@435 1869 static int _heap_walk_type;
duke@435 1870 static bool is_basic_heap_walk() { return _heap_walk_type == basic; }
duke@435 1871 static bool is_advanced_heap_walk() { return _heap_walk_type == advanced; }
duke@435 1872
duke@435 1873 // context for basic style heap walk
duke@435 1874 static BasicHeapWalkContext _basic_context;
duke@435 1875 static BasicHeapWalkContext* basic_context() {
duke@435 1876 assert(_basic_context.is_valid(), "invalid");
duke@435 1877 return &_basic_context;
duke@435 1878 }
duke@435 1879
duke@435 1880 // context for advanced style heap walk
duke@435 1881 static AdvancedHeapWalkContext _advanced_context;
duke@435 1882 static AdvancedHeapWalkContext* advanced_context() {
duke@435 1883 assert(_advanced_context.is_valid(), "invalid");
duke@435 1884 return &_advanced_context;
duke@435 1885 }
duke@435 1886
duke@435 1887 // context needed for all heap walks
duke@435 1888 static JvmtiTagMap* _tag_map;
duke@435 1889 static const void* _user_data;
duke@435 1890 static GrowableArray<oop>* _visit_stack;
duke@435 1891
duke@435 1892 // accessors
duke@435 1893 static JvmtiTagMap* tag_map() { return _tag_map; }
duke@435 1894 static const void* user_data() { return _user_data; }
duke@435 1895 static GrowableArray<oop>* visit_stack() { return _visit_stack; }
duke@435 1896
duke@435 1897 // if the object hasn't been visited then push it onto the visit stack
duke@435 1898 // so that it will be visited later
duke@435 1899 static inline bool check_for_visit(oop obj) {
duke@435 1900 if (!ObjectMarker::visited(obj)) visit_stack()->push(obj);
duke@435 1901 return true;
duke@435 1902 }
duke@435 1903
duke@435 1904 // invoke basic style callbacks
duke@435 1905 static inline bool invoke_basic_heap_root_callback
duke@435 1906 (jvmtiHeapRootKind root_kind, oop obj);
duke@435 1907 static inline bool invoke_basic_stack_ref_callback
duke@435 1908 (jvmtiHeapRootKind root_kind, jlong thread_tag, jint depth, jmethodID method,
duke@435 1909 int slot, oop obj);
duke@435 1910 static inline bool invoke_basic_object_reference_callback
duke@435 1911 (jvmtiObjectReferenceKind ref_kind, oop referrer, oop referree, jint index);
duke@435 1912
duke@435 1913 // invoke advanced style callbacks
duke@435 1914 static inline bool invoke_advanced_heap_root_callback
duke@435 1915 (jvmtiHeapReferenceKind ref_kind, oop obj);
duke@435 1916 static inline bool invoke_advanced_stack_ref_callback
duke@435 1917 (jvmtiHeapReferenceKind ref_kind, jlong thread_tag, jlong tid, int depth,
duke@435 1918 jmethodID method, jlocation bci, jint slot, oop obj);
duke@435 1919 static inline bool invoke_advanced_object_reference_callback
duke@435 1920 (jvmtiHeapReferenceKind ref_kind, oop referrer, oop referree, jint index);
duke@435 1921
duke@435 1922 // used to report the value of primitive fields
duke@435 1923 static inline bool report_primitive_field
duke@435 1924 (jvmtiHeapReferenceKind ref_kind, oop obj, jint index, address addr, char type);
duke@435 1925
duke@435 1926 public:
duke@435 1927 // initialize for basic mode
duke@435 1928 static void initialize_for_basic_heap_walk(JvmtiTagMap* tag_map,
duke@435 1929 GrowableArray<oop>* visit_stack,
duke@435 1930 const void* user_data,
duke@435 1931 BasicHeapWalkContext context);
duke@435 1932
duke@435 1933 // initialize for advanced mode
duke@435 1934 static void initialize_for_advanced_heap_walk(JvmtiTagMap* tag_map,
duke@435 1935 GrowableArray<oop>* visit_stack,
duke@435 1936 const void* user_data,
duke@435 1937 AdvancedHeapWalkContext context);
duke@435 1938
duke@435 1939 // functions to report roots
duke@435 1940 static inline bool report_simple_root(jvmtiHeapReferenceKind kind, oop o);
duke@435 1941 static inline bool report_jni_local_root(jlong thread_tag, jlong tid, jint depth,
duke@435 1942 jmethodID m, oop o);
duke@435 1943 static inline bool report_stack_ref_root(jlong thread_tag, jlong tid, jint depth,
duke@435 1944 jmethodID method, jlocation bci, jint slot, oop o);
duke@435 1945
duke@435 1946 // functions to report references
duke@435 1947 static inline bool report_array_element_reference(oop referrer, oop referree, jint index);
duke@435 1948 static inline bool report_class_reference(oop referrer, oop referree);
duke@435 1949 static inline bool report_class_loader_reference(oop referrer, oop referree);
duke@435 1950 static inline bool report_signers_reference(oop referrer, oop referree);
duke@435 1951 static inline bool report_protection_domain_reference(oop referrer, oop referree);
duke@435 1952 static inline bool report_superclass_reference(oop referrer, oop referree);
duke@435 1953 static inline bool report_interface_reference(oop referrer, oop referree);
duke@435 1954 static inline bool report_static_field_reference(oop referrer, oop referree, jint slot);
duke@435 1955 static inline bool report_field_reference(oop referrer, oop referree, jint slot);
duke@435 1956 static inline bool report_constant_pool_reference(oop referrer, oop referree, jint index);
duke@435 1957 static inline bool report_primitive_array_values(oop array);
duke@435 1958 static inline bool report_string_value(oop str);
duke@435 1959 static inline bool report_primitive_instance_field(oop o, jint index, address value, char type);
duke@435 1960 static inline bool report_primitive_static_field(oop o, jint index, address value, char type);
duke@435 1961 };
duke@435 1962
duke@435 1963 // statics
duke@435 1964 int CallbackInvoker::_heap_walk_type;
duke@435 1965 BasicHeapWalkContext CallbackInvoker::_basic_context;
duke@435 1966 AdvancedHeapWalkContext CallbackInvoker::_advanced_context;
duke@435 1967 JvmtiTagMap* CallbackInvoker::_tag_map;
duke@435 1968 const void* CallbackInvoker::_user_data;
duke@435 1969 GrowableArray<oop>* CallbackInvoker::_visit_stack;
duke@435 1970
duke@435 1971 // initialize for basic heap walk (IterateOverReachableObjects et al)
duke@435 1972 void CallbackInvoker::initialize_for_basic_heap_walk(JvmtiTagMap* tag_map,
duke@435 1973 GrowableArray<oop>* visit_stack,
duke@435 1974 const void* user_data,
duke@435 1975 BasicHeapWalkContext context) {
duke@435 1976 _tag_map = tag_map;
duke@435 1977 _visit_stack = visit_stack;
duke@435 1978 _user_data = user_data;
duke@435 1979 _basic_context = context;
duke@435 1980 _advanced_context.invalidate(); // will trigger assertion if used
duke@435 1981 _heap_walk_type = basic;
duke@435 1982 }
duke@435 1983
duke@435 1984 // initialize for advanced heap walk (FollowReferences)
duke@435 1985 void CallbackInvoker::initialize_for_advanced_heap_walk(JvmtiTagMap* tag_map,
duke@435 1986 GrowableArray<oop>* visit_stack,
duke@435 1987 const void* user_data,
duke@435 1988 AdvancedHeapWalkContext context) {
duke@435 1989 _tag_map = tag_map;
duke@435 1990 _visit_stack = visit_stack;
duke@435 1991 _user_data = user_data;
duke@435 1992 _advanced_context = context;
duke@435 1993 _basic_context.invalidate(); // will trigger assertion if used
duke@435 1994 _heap_walk_type = advanced;
duke@435 1995 }
duke@435 1996
duke@435 1997
duke@435 1998 // invoke basic style heap root callback
duke@435 1999 inline bool CallbackInvoker::invoke_basic_heap_root_callback(jvmtiHeapRootKind root_kind, oop obj) {
duke@435 2000 assert(ServiceUtil::visible_oop(obj), "checking");
duke@435 2001
duke@435 2002 // if we heap roots should be reported
duke@435 2003 jvmtiHeapRootCallback cb = basic_context()->heap_root_callback();
duke@435 2004 if (cb == NULL) {
duke@435 2005 return check_for_visit(obj);
duke@435 2006 }
duke@435 2007
duke@435 2008 CallbackWrapper wrapper(tag_map(), obj);
duke@435 2009 jvmtiIterationControl control = (*cb)(root_kind,
duke@435 2010 wrapper.klass_tag(),
duke@435 2011 wrapper.obj_size(),
duke@435 2012 wrapper.obj_tag_p(),
duke@435 2013 (void*)user_data());
duke@435 2014 // push root to visit stack when following references
duke@435 2015 if (control == JVMTI_ITERATION_CONTINUE &&
duke@435 2016 basic_context()->object_ref_callback() != NULL) {
duke@435 2017 visit_stack()->push(obj);
duke@435 2018 }
duke@435 2019 return control != JVMTI_ITERATION_ABORT;
duke@435 2020 }
duke@435 2021
duke@435 2022 // invoke basic style stack ref callback
duke@435 2023 inline bool CallbackInvoker::invoke_basic_stack_ref_callback(jvmtiHeapRootKind root_kind,
duke@435 2024 jlong thread_tag,
duke@435 2025 jint depth,
duke@435 2026 jmethodID method,
duke@435 2027 jint slot,
duke@435 2028 oop obj) {
duke@435 2029 assert(ServiceUtil::visible_oop(obj), "checking");
duke@435 2030
duke@435 2031 // if we stack refs should be reported
duke@435 2032 jvmtiStackReferenceCallback cb = basic_context()->stack_ref_callback();
duke@435 2033 if (cb == NULL) {
duke@435 2034 return check_for_visit(obj);
duke@435 2035 }
duke@435 2036
duke@435 2037 CallbackWrapper wrapper(tag_map(), obj);
duke@435 2038 jvmtiIterationControl control = (*cb)(root_kind,
duke@435 2039 wrapper.klass_tag(),
duke@435 2040 wrapper.obj_size(),
duke@435 2041 wrapper.obj_tag_p(),
duke@435 2042 thread_tag,
duke@435 2043 depth,
duke@435 2044 method,
duke@435 2045 slot,
duke@435 2046 (void*)user_data());
duke@435 2047 // push root to visit stack when following references
duke@435 2048 if (control == JVMTI_ITERATION_CONTINUE &&
duke@435 2049 basic_context()->object_ref_callback() != NULL) {
duke@435 2050 visit_stack()->push(obj);
duke@435 2051 }
duke@435 2052 return control != JVMTI_ITERATION_ABORT;
duke@435 2053 }
duke@435 2054
duke@435 2055 // invoke basic style object reference callback
duke@435 2056 inline bool CallbackInvoker::invoke_basic_object_reference_callback(jvmtiObjectReferenceKind ref_kind,
duke@435 2057 oop referrer,
duke@435 2058 oop referree,
duke@435 2059 jint index) {
duke@435 2060
duke@435 2061 assert(ServiceUtil::visible_oop(referrer), "checking");
duke@435 2062 assert(ServiceUtil::visible_oop(referree), "checking");
duke@435 2063
duke@435 2064 BasicHeapWalkContext* context = basic_context();
duke@435 2065
duke@435 2066 // callback requires the referrer's tag. If it's the same referrer
duke@435 2067 // as the last call then we use the cached value.
duke@435 2068 jlong referrer_tag;
duke@435 2069 if (referrer == context->last_referrer()) {
duke@435 2070 referrer_tag = context->last_referrer_tag();
duke@435 2071 } else {
duke@435 2072 referrer_tag = tag_for(tag_map(), klassOop_if_java_lang_Class(referrer));
duke@435 2073 }
duke@435 2074
duke@435 2075 // do the callback
duke@435 2076 CallbackWrapper wrapper(tag_map(), referree);
duke@435 2077 jvmtiObjectReferenceCallback cb = context->object_ref_callback();
duke@435 2078 jvmtiIterationControl control = (*cb)(ref_kind,
duke@435 2079 wrapper.klass_tag(),
duke@435 2080 wrapper.obj_size(),
duke@435 2081 wrapper.obj_tag_p(),
duke@435 2082 referrer_tag,
duke@435 2083 index,
duke@435 2084 (void*)user_data());
duke@435 2085
duke@435 2086 // record referrer and referrer tag. For self-references record the
duke@435 2087 // tag value from the callback as this might differ from referrer_tag.
duke@435 2088 context->set_last_referrer(referrer);
duke@435 2089 if (referrer == referree) {
duke@435 2090 context->set_last_referrer_tag(*wrapper.obj_tag_p());
duke@435 2091 } else {
duke@435 2092 context->set_last_referrer_tag(referrer_tag);
duke@435 2093 }
duke@435 2094
duke@435 2095 if (control == JVMTI_ITERATION_CONTINUE) {
duke@435 2096 return check_for_visit(referree);
duke@435 2097 } else {
duke@435 2098 return control != JVMTI_ITERATION_ABORT;
duke@435 2099 }
duke@435 2100 }
duke@435 2101
duke@435 2102 // invoke advanced style heap root callback
duke@435 2103 inline bool CallbackInvoker::invoke_advanced_heap_root_callback(jvmtiHeapReferenceKind ref_kind,
duke@435 2104 oop obj) {
duke@435 2105 assert(ServiceUtil::visible_oop(obj), "checking");
duke@435 2106
duke@435 2107 AdvancedHeapWalkContext* context = advanced_context();
duke@435 2108
duke@435 2109 // check that callback is provided
duke@435 2110 jvmtiHeapReferenceCallback cb = context->heap_reference_callback();
duke@435 2111 if (cb == NULL) {
duke@435 2112 return check_for_visit(obj);
duke@435 2113 }
duke@435 2114
duke@435 2115 // apply class filter
duke@435 2116 if (is_filtered_by_klass_filter(obj, context->klass_filter())) {
duke@435 2117 return check_for_visit(obj);
duke@435 2118 }
duke@435 2119
duke@435 2120 // setup the callback wrapper
duke@435 2121 CallbackWrapper wrapper(tag_map(), obj);
duke@435 2122
duke@435 2123 // apply tag filter
duke@435 2124 if (is_filtered_by_heap_filter(wrapper.obj_tag(),
duke@435 2125 wrapper.klass_tag(),
duke@435 2126 context->heap_filter())) {
duke@435 2127 return check_for_visit(obj);
duke@435 2128 }
duke@435 2129
duke@435 2130 // for arrays we need the length, otherwise -1
duke@435 2131 jint len = (jint)(obj->is_array() ? arrayOop(obj)->length() : -1);
duke@435 2132
duke@435 2133 // invoke the callback
duke@435 2134 jint res = (*cb)(ref_kind,
duke@435 2135 NULL, // referrer info
duke@435 2136 wrapper.klass_tag(),
duke@435 2137 0, // referrer_class_tag is 0 for heap root
duke@435 2138 wrapper.obj_size(),
duke@435 2139 wrapper.obj_tag_p(),
duke@435 2140 NULL, // referrer_tag_p
duke@435 2141 len,
duke@435 2142 (void*)user_data());
duke@435 2143 if (res & JVMTI_VISIT_ABORT) {
duke@435 2144 return false;// referrer class tag
duke@435 2145 }
duke@435 2146 if (res & JVMTI_VISIT_OBJECTS) {
duke@435 2147 check_for_visit(obj);
duke@435 2148 }
duke@435 2149 return true;
duke@435 2150 }
duke@435 2151
duke@435 2152 // report a reference from a thread stack to an object
duke@435 2153 inline bool CallbackInvoker::invoke_advanced_stack_ref_callback(jvmtiHeapReferenceKind ref_kind,
duke@435 2154 jlong thread_tag,
duke@435 2155 jlong tid,
duke@435 2156 int depth,
duke@435 2157 jmethodID method,
duke@435 2158 jlocation bci,
duke@435 2159 jint slot,
duke@435 2160 oop obj) {
duke@435 2161 assert(ServiceUtil::visible_oop(obj), "checking");
duke@435 2162
duke@435 2163 AdvancedHeapWalkContext* context = advanced_context();
duke@435 2164
duke@435 2165 // check that callback is provider
duke@435 2166 jvmtiHeapReferenceCallback cb = context->heap_reference_callback();
duke@435 2167 if (cb == NULL) {
duke@435 2168 return check_for_visit(obj);
duke@435 2169 }
duke@435 2170
duke@435 2171 // apply class filter
duke@435 2172 if (is_filtered_by_klass_filter(obj, context->klass_filter())) {
duke@435 2173 return check_for_visit(obj);
duke@435 2174 }
duke@435 2175
duke@435 2176 // setup the callback wrapper
duke@435 2177 CallbackWrapper wrapper(tag_map(), obj);
duke@435 2178
duke@435 2179 // apply tag filter
duke@435 2180 if (is_filtered_by_heap_filter(wrapper.obj_tag(),
duke@435 2181 wrapper.klass_tag(),
duke@435 2182 context->heap_filter())) {
duke@435 2183 return check_for_visit(obj);
duke@435 2184 }
duke@435 2185
duke@435 2186 // setup the referrer info
duke@435 2187 jvmtiHeapReferenceInfo reference_info;
duke@435 2188 reference_info.stack_local.thread_tag = thread_tag;
duke@435 2189 reference_info.stack_local.thread_id = tid;
duke@435 2190 reference_info.stack_local.depth = depth;
duke@435 2191 reference_info.stack_local.method = method;
duke@435 2192 reference_info.stack_local.location = bci;
duke@435 2193 reference_info.stack_local.slot = slot;
duke@435 2194
duke@435 2195 // for arrays we need the length, otherwise -1
duke@435 2196 jint len = (jint)(obj->is_array() ? arrayOop(obj)->length() : -1);
duke@435 2197
duke@435 2198 // call into the agent
duke@435 2199 int res = (*cb)(ref_kind,
duke@435 2200 &reference_info,
duke@435 2201 wrapper.klass_tag(),
duke@435 2202 0, // referrer_class_tag is 0 for heap root (stack)
duke@435 2203 wrapper.obj_size(),
duke@435 2204 wrapper.obj_tag_p(),
duke@435 2205 NULL, // referrer_tag is 0 for root
duke@435 2206 len,
duke@435 2207 (void*)user_data());
duke@435 2208
duke@435 2209 if (res & JVMTI_VISIT_ABORT) {
duke@435 2210 return false;
duke@435 2211 }
duke@435 2212 if (res & JVMTI_VISIT_OBJECTS) {
duke@435 2213 check_for_visit(obj);
duke@435 2214 }
duke@435 2215 return true;
duke@435 2216 }
duke@435 2217
duke@435 2218 // This mask is used to pass reference_info to a jvmtiHeapReferenceCallback
duke@435 2219 // only for ref_kinds defined by the JVM TI spec. Otherwise, NULL is passed.
duke@435 2220 #define REF_INFO_MASK ((1 << JVMTI_HEAP_REFERENCE_FIELD) \
duke@435 2221 | (1 << JVMTI_HEAP_REFERENCE_STATIC_FIELD) \
duke@435 2222 | (1 << JVMTI_HEAP_REFERENCE_ARRAY_ELEMENT) \
duke@435 2223 | (1 << JVMTI_HEAP_REFERENCE_CONSTANT_POOL) \
duke@435 2224 | (1 << JVMTI_HEAP_REFERENCE_STACK_LOCAL) \
duke@435 2225 | (1 << JVMTI_HEAP_REFERENCE_JNI_LOCAL))
duke@435 2226
duke@435 2227 // invoke the object reference callback to report a reference
duke@435 2228 inline bool CallbackInvoker::invoke_advanced_object_reference_callback(jvmtiHeapReferenceKind ref_kind,
duke@435 2229 oop referrer,
duke@435 2230 oop obj,
duke@435 2231 jint index)
duke@435 2232 {
duke@435 2233 // field index is only valid field in reference_info
duke@435 2234 static jvmtiHeapReferenceInfo reference_info = { 0 };
duke@435 2235
duke@435 2236 assert(ServiceUtil::visible_oop(referrer), "checking");
duke@435 2237 assert(ServiceUtil::visible_oop(obj), "checking");
duke@435 2238
duke@435 2239 AdvancedHeapWalkContext* context = advanced_context();
duke@435 2240
duke@435 2241 // check that callback is provider
duke@435 2242 jvmtiHeapReferenceCallback cb = context->heap_reference_callback();
duke@435 2243 if (cb == NULL) {
duke@435 2244 return check_for_visit(obj);
duke@435 2245 }
duke@435 2246
duke@435 2247 // apply class filter
duke@435 2248 if (is_filtered_by_klass_filter(obj, context->klass_filter())) {
duke@435 2249 return check_for_visit(obj);
duke@435 2250 }
duke@435 2251
duke@435 2252 // setup the callback wrapper
duke@435 2253 TwoOopCallbackWrapper wrapper(tag_map(), referrer, obj);
duke@435 2254
duke@435 2255 // apply tag filter
duke@435 2256 if (is_filtered_by_heap_filter(wrapper.obj_tag(),
duke@435 2257 wrapper.klass_tag(),
duke@435 2258 context->heap_filter())) {
duke@435 2259 return check_for_visit(obj);
duke@435 2260 }
duke@435 2261
duke@435 2262 // field index is only valid field in reference_info
duke@435 2263 reference_info.field.index = index;
duke@435 2264
duke@435 2265 // for arrays we need the length, otherwise -1
duke@435 2266 jint len = (jint)(obj->is_array() ? arrayOop(obj)->length() : -1);
duke@435 2267
duke@435 2268 // invoke the callback
duke@435 2269 int res = (*cb)(ref_kind,
duke@435 2270 (REF_INFO_MASK & (1 << ref_kind)) ? &reference_info : NULL,
duke@435 2271 wrapper.klass_tag(),
duke@435 2272 wrapper.referrer_klass_tag(),
duke@435 2273 wrapper.obj_size(),
duke@435 2274 wrapper.obj_tag_p(),
duke@435 2275 wrapper.referrer_tag_p(),
duke@435 2276 len,
duke@435 2277 (void*)user_data());
duke@435 2278
duke@435 2279 if (res & JVMTI_VISIT_ABORT) {
duke@435 2280 return false;
duke@435 2281 }
duke@435 2282 if (res & JVMTI_VISIT_OBJECTS) {
duke@435 2283 check_for_visit(obj);
duke@435 2284 }
duke@435 2285 return true;
duke@435 2286 }
duke@435 2287
duke@435 2288 // report a "simple root"
duke@435 2289 inline bool CallbackInvoker::report_simple_root(jvmtiHeapReferenceKind kind, oop obj) {
duke@435 2290 assert(kind != JVMTI_HEAP_REFERENCE_STACK_LOCAL &&
duke@435 2291 kind != JVMTI_HEAP_REFERENCE_JNI_LOCAL, "not a simple root");
duke@435 2292 assert(ServiceUtil::visible_oop(obj), "checking");
duke@435 2293
duke@435 2294 if (is_basic_heap_walk()) {
duke@435 2295 // map to old style root kind
duke@435 2296 jvmtiHeapRootKind root_kind = toJvmtiHeapRootKind(kind);
duke@435 2297 return invoke_basic_heap_root_callback(root_kind, obj);
duke@435 2298 } else {
duke@435 2299 assert(is_advanced_heap_walk(), "wrong heap walk type");
duke@435 2300 return invoke_advanced_heap_root_callback(kind, obj);
duke@435 2301 }
duke@435 2302 }
duke@435 2303
duke@435 2304
duke@435 2305 // invoke the primitive array values
duke@435 2306 inline bool CallbackInvoker::report_primitive_array_values(oop obj) {
duke@435 2307 assert(obj->is_typeArray(), "not a primitive array");
duke@435 2308
duke@435 2309 AdvancedHeapWalkContext* context = advanced_context();
duke@435 2310 assert(context->array_primitive_value_callback() != NULL, "no callback");
duke@435 2311
duke@435 2312 // apply class filter
duke@435 2313 if (is_filtered_by_klass_filter(obj, context->klass_filter())) {
duke@435 2314 return true;
duke@435 2315 }
duke@435 2316
duke@435 2317 CallbackWrapper wrapper(tag_map(), obj);
duke@435 2318
duke@435 2319 // apply tag filter
duke@435 2320 if (is_filtered_by_heap_filter(wrapper.obj_tag(),
duke@435 2321 wrapper.klass_tag(),
duke@435 2322 context->heap_filter())) {
duke@435 2323 return true;
duke@435 2324 }
duke@435 2325
duke@435 2326 // invoke the callback
duke@435 2327 int res = invoke_array_primitive_value_callback(context->array_primitive_value_callback(),
duke@435 2328 &wrapper,
duke@435 2329 obj,
duke@435 2330 (void*)user_data());
duke@435 2331 return (!(res & JVMTI_VISIT_ABORT));
duke@435 2332 }
duke@435 2333
duke@435 2334 // invoke the string value callback
duke@435 2335 inline bool CallbackInvoker::report_string_value(oop str) {
never@1577 2336 assert(str->klass() == SystemDictionary::String_klass(), "not a string");
duke@435 2337
duke@435 2338 AdvancedHeapWalkContext* context = advanced_context();
duke@435 2339 assert(context->string_primitive_value_callback() != NULL, "no callback");
duke@435 2340
duke@435 2341 // apply class filter
duke@435 2342 if (is_filtered_by_klass_filter(str, context->klass_filter())) {
duke@435 2343 return true;
duke@435 2344 }
duke@435 2345
duke@435 2346 CallbackWrapper wrapper(tag_map(), str);
duke@435 2347
duke@435 2348 // apply tag filter
duke@435 2349 if (is_filtered_by_heap_filter(wrapper.obj_tag(),
duke@435 2350 wrapper.klass_tag(),
duke@435 2351 context->heap_filter())) {
duke@435 2352 return true;
duke@435 2353 }
duke@435 2354
duke@435 2355 // invoke the callback
duke@435 2356 int res = invoke_string_value_callback(context->string_primitive_value_callback(),
duke@435 2357 &wrapper,
duke@435 2358 str,
duke@435 2359 (void*)user_data());
duke@435 2360 return (!(res & JVMTI_VISIT_ABORT));
duke@435 2361 }
duke@435 2362
duke@435 2363 // invoke the primitive field callback
duke@435 2364 inline bool CallbackInvoker::report_primitive_field(jvmtiHeapReferenceKind ref_kind,
duke@435 2365 oop obj,
duke@435 2366 jint index,
duke@435 2367 address addr,
duke@435 2368 char type)
duke@435 2369 {
duke@435 2370 // for primitive fields only the index will be set
duke@435 2371 static jvmtiHeapReferenceInfo reference_info = { 0 };
duke@435 2372
duke@435 2373 AdvancedHeapWalkContext* context = advanced_context();
duke@435 2374 assert(context->primitive_field_callback() != NULL, "no callback");
duke@435 2375
duke@435 2376 // apply class filter
duke@435 2377 if (is_filtered_by_klass_filter(obj, context->klass_filter())) {
duke@435 2378 return true;
duke@435 2379 }
duke@435 2380
duke@435 2381 CallbackWrapper wrapper(tag_map(), obj);
duke@435 2382
duke@435 2383 // apply tag filter
duke@435 2384 if (is_filtered_by_heap_filter(wrapper.obj_tag(),
duke@435 2385 wrapper.klass_tag(),
duke@435 2386 context->heap_filter())) {
duke@435 2387 return true;
duke@435 2388 }
duke@435 2389
duke@435 2390 // the field index in the referrer
duke@435 2391 reference_info.field.index = index;
duke@435 2392
duke@435 2393 // map the type
duke@435 2394 jvmtiPrimitiveType value_type = (jvmtiPrimitiveType)type;
duke@435 2395
duke@435 2396 // setup the jvalue
duke@435 2397 jvalue value;
duke@435 2398 copy_to_jvalue(&value, addr, value_type);
duke@435 2399
duke@435 2400 jvmtiPrimitiveFieldCallback cb = context->primitive_field_callback();
duke@435 2401 int res = (*cb)(ref_kind,
duke@435 2402 &reference_info,
duke@435 2403 wrapper.klass_tag(),
duke@435 2404 wrapper.obj_tag_p(),
duke@435 2405 value,
duke@435 2406 value_type,
duke@435 2407 (void*)user_data());
duke@435 2408 return (!(res & JVMTI_VISIT_ABORT));
duke@435 2409 }
duke@435 2410
duke@435 2411
duke@435 2412 // instance field
duke@435 2413 inline bool CallbackInvoker::report_primitive_instance_field(oop obj,
duke@435 2414 jint index,
duke@435 2415 address value,
duke@435 2416 char type) {
duke@435 2417 return report_primitive_field(JVMTI_HEAP_REFERENCE_FIELD,
duke@435 2418 obj,
duke@435 2419 index,
duke@435 2420 value,
duke@435 2421 type);
duke@435 2422 }
duke@435 2423
duke@435 2424 // static field
duke@435 2425 inline bool CallbackInvoker::report_primitive_static_field(oop obj,
duke@435 2426 jint index,
duke@435 2427 address value,
duke@435 2428 char type) {
duke@435 2429 return report_primitive_field(JVMTI_HEAP_REFERENCE_STATIC_FIELD,
duke@435 2430 obj,
duke@435 2431 index,
duke@435 2432 value,
duke@435 2433 type);
duke@435 2434 }
duke@435 2435
duke@435 2436 // report a JNI local (root object) to the profiler
duke@435 2437 inline bool CallbackInvoker::report_jni_local_root(jlong thread_tag, jlong tid, jint depth, jmethodID m, oop obj) {
duke@435 2438 if (is_basic_heap_walk()) {
duke@435 2439 return invoke_basic_stack_ref_callback(JVMTI_HEAP_ROOT_JNI_LOCAL,
duke@435 2440 thread_tag,
duke@435 2441 depth,
duke@435 2442 m,
duke@435 2443 -1,
duke@435 2444 obj);
duke@435 2445 } else {
duke@435 2446 return invoke_advanced_stack_ref_callback(JVMTI_HEAP_REFERENCE_JNI_LOCAL,
duke@435 2447 thread_tag, tid,
duke@435 2448 depth,
duke@435 2449 m,
duke@435 2450 (jlocation)-1,
duke@435 2451 -1,
duke@435 2452 obj);
duke@435 2453 }
duke@435 2454 }
duke@435 2455
duke@435 2456
duke@435 2457 // report a local (stack reference, root object)
duke@435 2458 inline bool CallbackInvoker::report_stack_ref_root(jlong thread_tag,
duke@435 2459 jlong tid,
duke@435 2460 jint depth,
duke@435 2461 jmethodID method,
duke@435 2462 jlocation bci,
duke@435 2463 jint slot,
duke@435 2464 oop obj) {
duke@435 2465 if (is_basic_heap_walk()) {
duke@435 2466 return invoke_basic_stack_ref_callback(JVMTI_HEAP_ROOT_STACK_LOCAL,
duke@435 2467 thread_tag,
duke@435 2468 depth,
duke@435 2469 method,
duke@435 2470 slot,
duke@435 2471 obj);
duke@435 2472 } else {
duke@435 2473 return invoke_advanced_stack_ref_callback(JVMTI_HEAP_REFERENCE_STACK_LOCAL,
duke@435 2474 thread_tag,
duke@435 2475 tid,
duke@435 2476 depth,
duke@435 2477 method,
duke@435 2478 bci,
duke@435 2479 slot,
duke@435 2480 obj);
duke@435 2481 }
duke@435 2482 }
duke@435 2483
duke@435 2484 // report an object referencing a class.
duke@435 2485 inline bool CallbackInvoker::report_class_reference(oop referrer, oop referree) {
duke@435 2486 if (is_basic_heap_walk()) {
duke@435 2487 return invoke_basic_object_reference_callback(JVMTI_REFERENCE_CLASS, referrer, referree, -1);
duke@435 2488 } else {
duke@435 2489 return invoke_advanced_object_reference_callback(JVMTI_HEAP_REFERENCE_CLASS, referrer, referree, -1);
duke@435 2490 }
duke@435 2491 }
duke@435 2492
duke@435 2493 // report a class referencing its class loader.
duke@435 2494 inline bool CallbackInvoker::report_class_loader_reference(oop referrer, oop referree) {
duke@435 2495 if (is_basic_heap_walk()) {
duke@435 2496 return invoke_basic_object_reference_callback(JVMTI_REFERENCE_CLASS_LOADER, referrer, referree, -1);
duke@435 2497 } else {
duke@435 2498 return invoke_advanced_object_reference_callback(JVMTI_HEAP_REFERENCE_CLASS_LOADER, referrer, referree, -1);
duke@435 2499 }
duke@435 2500 }
duke@435 2501
duke@435 2502 // report a class referencing its signers.
duke@435 2503 inline bool CallbackInvoker::report_signers_reference(oop referrer, oop referree) {
duke@435 2504 if (is_basic_heap_walk()) {
duke@435 2505 return invoke_basic_object_reference_callback(JVMTI_REFERENCE_SIGNERS, referrer, referree, -1);
duke@435 2506 } else {
duke@435 2507 return invoke_advanced_object_reference_callback(JVMTI_HEAP_REFERENCE_SIGNERS, referrer, referree, -1);
duke@435 2508 }
duke@435 2509 }
duke@435 2510
duke@435 2511 // report a class referencing its protection domain..
duke@435 2512 inline bool CallbackInvoker::report_protection_domain_reference(oop referrer, oop referree) {
duke@435 2513 if (is_basic_heap_walk()) {
duke@435 2514 return invoke_basic_object_reference_callback(JVMTI_REFERENCE_PROTECTION_DOMAIN, referrer, referree, -1);
duke@435 2515 } else {
duke@435 2516 return invoke_advanced_object_reference_callback(JVMTI_HEAP_REFERENCE_PROTECTION_DOMAIN, referrer, referree, -1);
duke@435 2517 }
duke@435 2518 }
duke@435 2519
duke@435 2520 // report a class referencing its superclass.
duke@435 2521 inline bool CallbackInvoker::report_superclass_reference(oop referrer, oop referree) {
duke@435 2522 if (is_basic_heap_walk()) {
duke@435 2523 // Send this to be consistent with past implementation
duke@435 2524 return invoke_basic_object_reference_callback(JVMTI_REFERENCE_CLASS, referrer, referree, -1);
duke@435 2525 } else {
duke@435 2526 return invoke_advanced_object_reference_callback(JVMTI_HEAP_REFERENCE_SUPERCLASS, referrer, referree, -1);
duke@435 2527 }
duke@435 2528 }
duke@435 2529
duke@435 2530 // report a class referencing one of its interfaces.
duke@435 2531 inline bool CallbackInvoker::report_interface_reference(oop referrer, oop referree) {
duke@435 2532 if (is_basic_heap_walk()) {
duke@435 2533 return invoke_basic_object_reference_callback(JVMTI_REFERENCE_INTERFACE, referrer, referree, -1);
duke@435 2534 } else {
duke@435 2535 return invoke_advanced_object_reference_callback(JVMTI_HEAP_REFERENCE_INTERFACE, referrer, referree, -1);
duke@435 2536 }
duke@435 2537 }
duke@435 2538
duke@435 2539 // report a class referencing one of its static fields.
duke@435 2540 inline bool CallbackInvoker::report_static_field_reference(oop referrer, oop referree, jint slot) {
duke@435 2541 if (is_basic_heap_walk()) {
duke@435 2542 return invoke_basic_object_reference_callback(JVMTI_REFERENCE_STATIC_FIELD, referrer, referree, slot);
duke@435 2543 } else {
duke@435 2544 return invoke_advanced_object_reference_callback(JVMTI_HEAP_REFERENCE_STATIC_FIELD, referrer, referree, slot);
duke@435 2545 }
duke@435 2546 }
duke@435 2547
duke@435 2548 // report an array referencing an element object
duke@435 2549 inline bool CallbackInvoker::report_array_element_reference(oop referrer, oop referree, jint index) {
duke@435 2550 if (is_basic_heap_walk()) {
duke@435 2551 return invoke_basic_object_reference_callback(JVMTI_REFERENCE_ARRAY_ELEMENT, referrer, referree, index);
duke@435 2552 } else {
duke@435 2553 return invoke_advanced_object_reference_callback(JVMTI_HEAP_REFERENCE_ARRAY_ELEMENT, referrer, referree, index);
duke@435 2554 }
duke@435 2555 }
duke@435 2556
duke@435 2557 // report an object referencing an instance field object
duke@435 2558 inline bool CallbackInvoker::report_field_reference(oop referrer, oop referree, jint slot) {
duke@435 2559 if (is_basic_heap_walk()) {
duke@435 2560 return invoke_basic_object_reference_callback(JVMTI_REFERENCE_FIELD, referrer, referree, slot);
duke@435 2561 } else {
duke@435 2562 return invoke_advanced_object_reference_callback(JVMTI_HEAP_REFERENCE_FIELD, referrer, referree, slot);
duke@435 2563 }
duke@435 2564 }
duke@435 2565
duke@435 2566 // report an array referencing an element object
duke@435 2567 inline bool CallbackInvoker::report_constant_pool_reference(oop referrer, oop referree, jint index) {
duke@435 2568 if (is_basic_heap_walk()) {
duke@435 2569 return invoke_basic_object_reference_callback(JVMTI_REFERENCE_CONSTANT_POOL, referrer, referree, index);
duke@435 2570 } else {
duke@435 2571 return invoke_advanced_object_reference_callback(JVMTI_HEAP_REFERENCE_CONSTANT_POOL, referrer, referree, index);
duke@435 2572 }
duke@435 2573 }
duke@435 2574
duke@435 2575 // A supporting closure used to process simple roots
duke@435 2576 class SimpleRootsClosure : public OopClosure {
duke@435 2577 private:
duke@435 2578 jvmtiHeapReferenceKind _kind;
duke@435 2579 bool _continue;
duke@435 2580
duke@435 2581 jvmtiHeapReferenceKind root_kind() { return _kind; }
duke@435 2582
duke@435 2583 public:
duke@435 2584 void set_kind(jvmtiHeapReferenceKind kind) {
duke@435 2585 _kind = kind;
duke@435 2586 _continue = true;
duke@435 2587 }
duke@435 2588
duke@435 2589 inline bool stopped() {
duke@435 2590 return !_continue;
duke@435 2591 }
duke@435 2592
duke@435 2593 void do_oop(oop* obj_p) {
duke@435 2594 // iteration has terminated
duke@435 2595 if (stopped()) {
duke@435 2596 return;
duke@435 2597 }
duke@435 2598
duke@435 2599 // ignore null or deleted handles
duke@435 2600 oop o = *obj_p;
duke@435 2601 if (o == NULL || o == JNIHandles::deleted_handle()) {
duke@435 2602 return;
duke@435 2603 }
duke@435 2604
duke@435 2605 jvmtiHeapReferenceKind kind = root_kind();
duke@435 2606
duke@435 2607 // many roots are Klasses so we use the java mirror
duke@435 2608 if (o->is_klass()) {
duke@435 2609 klassOop k = (klassOop)o;
duke@435 2610 o = Klass::cast(k)->java_mirror();
never@2658 2611 if (o == NULL) {
never@2658 2612 // Classes without mirrors don't correspond to real Java
never@2658 2613 // classes so just ignore them.
never@2658 2614 return;
never@2658 2615 }
duke@435 2616 } else {
duke@435 2617
duke@435 2618 // SystemDictionary::always_strong_oops_do reports the application
duke@435 2619 // class loader as a root. We want this root to be reported as
duke@435 2620 // a root kind of "OTHER" rather than "SYSTEM_CLASS".
duke@435 2621 if (o->is_instance() && root_kind() == JVMTI_HEAP_REFERENCE_SYSTEM_CLASS) {
duke@435 2622 kind = JVMTI_HEAP_REFERENCE_OTHER;
duke@435 2623 }
duke@435 2624 }
duke@435 2625
duke@435 2626 // some objects are ignored - in the case of simple
coleenp@2497 2627 // roots it's mostly Symbol*s that we are skipping
duke@435 2628 // here.
duke@435 2629 if (!ServiceUtil::visible_oop(o)) {
duke@435 2630 return;
duke@435 2631 }
duke@435 2632
duke@435 2633 // invoke the callback
duke@435 2634 _continue = CallbackInvoker::report_simple_root(kind, o);
duke@435 2635
duke@435 2636 }
coleenp@548 2637 virtual void do_oop(narrowOop* obj_p) { ShouldNotReachHere(); }
duke@435 2638 };
duke@435 2639
duke@435 2640 // A supporting closure used to process JNI locals
duke@435 2641 class JNILocalRootsClosure : public OopClosure {
duke@435 2642 private:
duke@435 2643 jlong _thread_tag;
duke@435 2644 jlong _tid;
duke@435 2645 jint _depth;
duke@435 2646 jmethodID _method;
duke@435 2647 bool _continue;
duke@435 2648 public:
duke@435 2649 void set_context(jlong thread_tag, jlong tid, jint depth, jmethodID method) {
duke@435 2650 _thread_tag = thread_tag;
duke@435 2651 _tid = tid;
duke@435 2652 _depth = depth;
duke@435 2653 _method = method;
duke@435 2654 _continue = true;
duke@435 2655 }
duke@435 2656
duke@435 2657 inline bool stopped() {
duke@435 2658 return !_continue;
duke@435 2659 }
duke@435 2660
duke@435 2661 void do_oop(oop* obj_p) {
duke@435 2662 // iteration has terminated
duke@435 2663 if (stopped()) {
duke@435 2664 return;
duke@435 2665 }
duke@435 2666
duke@435 2667 // ignore null or deleted handles
duke@435 2668 oop o = *obj_p;
duke@435 2669 if (o == NULL || o == JNIHandles::deleted_handle()) {
duke@435 2670 return;
duke@435 2671 }
duke@435 2672
duke@435 2673 if (!ServiceUtil::visible_oop(o)) {
duke@435 2674 return;
duke@435 2675 }
duke@435 2676
duke@435 2677 // invoke the callback
duke@435 2678 _continue = CallbackInvoker::report_jni_local_root(_thread_tag, _tid, _depth, _method, o);
duke@435 2679 }
coleenp@548 2680 virtual void do_oop(narrowOop* obj_p) { ShouldNotReachHere(); }
duke@435 2681 };
duke@435 2682
duke@435 2683
duke@435 2684 // A VM operation to iterate over objects that are reachable from
duke@435 2685 // a set of roots or an initial object.
duke@435 2686 //
duke@435 2687 // For VM_HeapWalkOperation the set of roots used is :-
duke@435 2688 //
duke@435 2689 // - All JNI global references
duke@435 2690 // - All inflated monitors
duke@435 2691 // - All classes loaded by the boot class loader (or all classes
duke@435 2692 // in the event that class unloading is disabled)
duke@435 2693 // - All java threads
duke@435 2694 // - For each java thread then all locals and JNI local references
duke@435 2695 // on the thread's execution stack
duke@435 2696 // - All visible/explainable objects from Universes::oops_do
duke@435 2697 //
duke@435 2698 class VM_HeapWalkOperation: public VM_Operation {
duke@435 2699 private:
duke@435 2700 enum {
duke@435 2701 initial_visit_stack_size = 4000
duke@435 2702 };
duke@435 2703
duke@435 2704 bool _is_advanced_heap_walk; // indicates FollowReferences
duke@435 2705 JvmtiTagMap* _tag_map;
duke@435 2706 Handle _initial_object;
duke@435 2707 GrowableArray<oop>* _visit_stack; // the visit stack
duke@435 2708
duke@435 2709 bool _collecting_heap_roots; // are we collecting roots
duke@435 2710 bool _following_object_refs; // are we following object references
duke@435 2711
duke@435 2712 bool _reporting_primitive_fields; // optional reporting
duke@435 2713 bool _reporting_primitive_array_values;
duke@435 2714 bool _reporting_string_values;
duke@435 2715
duke@435 2716 GrowableArray<oop>* create_visit_stack() {
zgu@3900 2717 return new (ResourceObj::C_HEAP, mtInternal) GrowableArray<oop>(initial_visit_stack_size, true);
duke@435 2718 }
duke@435 2719
duke@435 2720 // accessors
duke@435 2721 bool is_advanced_heap_walk() const { return _is_advanced_heap_walk; }
duke@435 2722 JvmtiTagMap* tag_map() const { return _tag_map; }
duke@435 2723 Handle initial_object() const { return _initial_object; }
duke@435 2724
duke@435 2725 bool is_following_references() const { return _following_object_refs; }
duke@435 2726
duke@435 2727 bool is_reporting_primitive_fields() const { return _reporting_primitive_fields; }
duke@435 2728 bool is_reporting_primitive_array_values() const { return _reporting_primitive_array_values; }
duke@435 2729 bool is_reporting_string_values() const { return _reporting_string_values; }
duke@435 2730
duke@435 2731 GrowableArray<oop>* visit_stack() const { return _visit_stack; }
duke@435 2732
duke@435 2733 // iterate over the various object types
duke@435 2734 inline bool iterate_over_array(oop o);
duke@435 2735 inline bool iterate_over_type_array(oop o);
duke@435 2736 inline bool iterate_over_class(klassOop o);
duke@435 2737 inline bool iterate_over_object(oop o);
duke@435 2738
duke@435 2739 // root collection
duke@435 2740 inline bool collect_simple_roots();
duke@435 2741 inline bool collect_stack_roots();
duke@435 2742 inline bool collect_stack_roots(JavaThread* java_thread, JNILocalRootsClosure* blk);
duke@435 2743
duke@435 2744 // visit an object
duke@435 2745 inline bool visit(oop o);
duke@435 2746
duke@435 2747 public:
duke@435 2748 VM_HeapWalkOperation(JvmtiTagMap* tag_map,
duke@435 2749 Handle initial_object,
duke@435 2750 BasicHeapWalkContext callbacks,
duke@435 2751 const void* user_data);
duke@435 2752
duke@435 2753 VM_HeapWalkOperation(JvmtiTagMap* tag_map,
duke@435 2754 Handle initial_object,
duke@435 2755 AdvancedHeapWalkContext callbacks,
duke@435 2756 const void* user_data);
duke@435 2757
duke@435 2758 ~VM_HeapWalkOperation();
duke@435 2759
duke@435 2760 VMOp_Type type() const { return VMOp_HeapWalkOperation; }
duke@435 2761 void doit();
duke@435 2762 };
duke@435 2763
duke@435 2764
duke@435 2765 VM_HeapWalkOperation::VM_HeapWalkOperation(JvmtiTagMap* tag_map,
duke@435 2766 Handle initial_object,
duke@435 2767 BasicHeapWalkContext callbacks,
duke@435 2768 const void* user_data) {
duke@435 2769 _is_advanced_heap_walk = false;
duke@435 2770 _tag_map = tag_map;
duke@435 2771 _initial_object = initial_object;
duke@435 2772 _following_object_refs = (callbacks.object_ref_callback() != NULL);
duke@435 2773 _reporting_primitive_fields = false;
duke@435 2774 _reporting_primitive_array_values = false;
duke@435 2775 _reporting_string_values = false;
duke@435 2776 _visit_stack = create_visit_stack();
duke@435 2777
duke@435 2778
duke@435 2779 CallbackInvoker::initialize_for_basic_heap_walk(tag_map, _visit_stack, user_data, callbacks);
duke@435 2780 }
duke@435 2781
duke@435 2782 VM_HeapWalkOperation::VM_HeapWalkOperation(JvmtiTagMap* tag_map,
duke@435 2783 Handle initial_object,
duke@435 2784 AdvancedHeapWalkContext callbacks,
duke@435 2785 const void* user_data) {
duke@435 2786 _is_advanced_heap_walk = true;
duke@435 2787 _tag_map = tag_map;
duke@435 2788 _initial_object = initial_object;
duke@435 2789 _following_object_refs = true;
duke@435 2790 _reporting_primitive_fields = (callbacks.primitive_field_callback() != NULL);;
duke@435 2791 _reporting_primitive_array_values = (callbacks.array_primitive_value_callback() != NULL);;
duke@435 2792 _reporting_string_values = (callbacks.string_primitive_value_callback() != NULL);;
duke@435 2793 _visit_stack = create_visit_stack();
duke@435 2794
duke@435 2795 CallbackInvoker::initialize_for_advanced_heap_walk(tag_map, _visit_stack, user_data, callbacks);
duke@435 2796 }
duke@435 2797
duke@435 2798 VM_HeapWalkOperation::~VM_HeapWalkOperation() {
duke@435 2799 if (_following_object_refs) {
duke@435 2800 assert(_visit_stack != NULL, "checking");
duke@435 2801 delete _visit_stack;
duke@435 2802 _visit_stack = NULL;
duke@435 2803 }
duke@435 2804 }
duke@435 2805
duke@435 2806 // an array references its class and has a reference to
duke@435 2807 // each element in the array
duke@435 2808 inline bool VM_HeapWalkOperation::iterate_over_array(oop o) {
duke@435 2809 objArrayOop array = objArrayOop(o);
duke@435 2810 if (array->klass() == Universe::systemObjArrayKlassObj()) {
duke@435 2811 // filtered out
duke@435 2812 return true;
duke@435 2813 }
duke@435 2814
duke@435 2815 // array reference to its class
duke@435 2816 oop mirror = objArrayKlass::cast(array->klass())->java_mirror();
duke@435 2817 if (!CallbackInvoker::report_class_reference(o, mirror)) {
duke@435 2818 return false;
duke@435 2819 }
duke@435 2820
duke@435 2821 // iterate over the array and report each reference to a
duke@435 2822 // non-null element
duke@435 2823 for (int index=0; index<array->length(); index++) {
duke@435 2824 oop elem = array->obj_at(index);
duke@435 2825 if (elem == NULL) {
duke@435 2826 continue;
duke@435 2827 }
duke@435 2828
duke@435 2829 // report the array reference o[index] = elem
duke@435 2830 if (!CallbackInvoker::report_array_element_reference(o, elem, index)) {
duke@435 2831 return false;
duke@435 2832 }
duke@435 2833 }
duke@435 2834 return true;
duke@435 2835 }
duke@435 2836
duke@435 2837 // a type array references its class
duke@435 2838 inline bool VM_HeapWalkOperation::iterate_over_type_array(oop o) {
duke@435 2839 klassOop k = o->klass();
duke@435 2840 oop mirror = Klass::cast(k)->java_mirror();
duke@435 2841 if (!CallbackInvoker::report_class_reference(o, mirror)) {
duke@435 2842 return false;
duke@435 2843 }
duke@435 2844
duke@435 2845 // report the array contents if required
duke@435 2846 if (is_reporting_primitive_array_values()) {
duke@435 2847 if (!CallbackInvoker::report_primitive_array_values(o)) {
duke@435 2848 return false;
duke@435 2849 }
duke@435 2850 }
duke@435 2851 return true;
duke@435 2852 }
duke@435 2853
duke@435 2854 // verify that a static oop field is in range
coleenp@548 2855 static inline bool verify_static_oop(instanceKlass* ik,
never@2658 2856 oop mirror, int offset) {
never@2658 2857 address obj_p = (address)mirror + offset;
never@2658 2858 address start = (address)instanceMirrorKlass::start_of_static_fields(mirror);
never@2658 2859 address end = start + (java_lang_Class::static_oop_field_count(mirror) * heapOopSize);
duke@435 2860 assert(end >= start, "sanity check");
duke@435 2861
duke@435 2862 if (obj_p >= start && obj_p < end) {
duke@435 2863 return true;
duke@435 2864 } else {
duke@435 2865 return false;
duke@435 2866 }
duke@435 2867 }
duke@435 2868
duke@435 2869 // a class references its super class, interfaces, class loader, ...
duke@435 2870 // and finally its static fields
duke@435 2871 inline bool VM_HeapWalkOperation::iterate_over_class(klassOop k) {
duke@435 2872 int i;
duke@435 2873 Klass* klass = klassOop(k)->klass_part();
duke@435 2874
duke@435 2875 if (klass->oop_is_instance()) {
duke@435 2876 instanceKlass* ik = instanceKlass::cast(k);
duke@435 2877
duke@435 2878 // ignore the class if it's has been initialized yet
duke@435 2879 if (!ik->is_linked()) {
duke@435 2880 return true;
duke@435 2881 }
duke@435 2882
duke@435 2883 // get the java mirror
duke@435 2884 oop mirror = klass->java_mirror();
duke@435 2885
duke@435 2886 // super (only if something more interesting than java.lang.Object)
duke@435 2887 klassOop java_super = ik->java_super();
never@1577 2888 if (java_super != NULL && java_super != SystemDictionary::Object_klass()) {
duke@435 2889 oop super = Klass::cast(java_super)->java_mirror();
duke@435 2890 if (!CallbackInvoker::report_superclass_reference(mirror, super)) {
duke@435 2891 return false;
duke@435 2892 }
duke@435 2893 }
duke@435 2894
duke@435 2895 // class loader
duke@435 2896 oop cl = ik->class_loader();
duke@435 2897 if (cl != NULL) {
duke@435 2898 if (!CallbackInvoker::report_class_loader_reference(mirror, cl)) {
duke@435 2899 return false;
duke@435 2900 }
duke@435 2901 }
duke@435 2902
duke@435 2903 // protection domain
duke@435 2904 oop pd = ik->protection_domain();
duke@435 2905 if (pd != NULL) {
duke@435 2906 if (!CallbackInvoker::report_protection_domain_reference(mirror, pd)) {
duke@435 2907 return false;
duke@435 2908 }
duke@435 2909 }
duke@435 2910
duke@435 2911 // signers
duke@435 2912 oop signers = ik->signers();
duke@435 2913 if (signers != NULL) {
duke@435 2914 if (!CallbackInvoker::report_signers_reference(mirror, signers)) {
duke@435 2915 return false;
duke@435 2916 }
duke@435 2917 }
duke@435 2918
duke@435 2919 // references from the constant pool
duke@435 2920 {
duke@435 2921 const constantPoolOop pool = ik->constants();
duke@435 2922 for (int i = 1; i < pool->length(); i++) {
duke@435 2923 constantTag tag = pool->tag_at(i).value();
duke@435 2924 if (tag.is_string() || tag.is_klass()) {
duke@435 2925 oop entry;
duke@435 2926 if (tag.is_string()) {
duke@435 2927 entry = pool->resolved_string_at(i);
duke@435 2928 assert(java_lang_String::is_instance(entry), "must be string");
duke@435 2929 } else {
duke@435 2930 entry = Klass::cast(pool->resolved_klass_at(i))->java_mirror();
duke@435 2931 }
duke@435 2932 if (!CallbackInvoker::report_constant_pool_reference(mirror, entry, (jint)i)) {
duke@435 2933 return false;
duke@435 2934 }
duke@435 2935 }
duke@435 2936 }
duke@435 2937 }
duke@435 2938
duke@435 2939 // interfaces
duke@435 2940 // (These will already have been reported as references from the constant pool
duke@435 2941 // but are specified by IterateOverReachableObjects and must be reported).
duke@435 2942 objArrayOop interfaces = ik->local_interfaces();
duke@435 2943 for (i = 0; i < interfaces->length(); i++) {
duke@435 2944 oop interf = Klass::cast((klassOop)interfaces->obj_at(i))->java_mirror();
duke@435 2945 if (interf == NULL) {
duke@435 2946 continue;
duke@435 2947 }
duke@435 2948 if (!CallbackInvoker::report_interface_reference(mirror, interf)) {
duke@435 2949 return false;
duke@435 2950 }
duke@435 2951 }
duke@435 2952
duke@435 2953 // iterate over the static fields
duke@435 2954
duke@435 2955 ClassFieldMap* field_map = ClassFieldMap::create_map_of_static_fields(k);
duke@435 2956 for (i=0; i<field_map->field_count(); i++) {
duke@435 2957 ClassFieldDescriptor* field = field_map->field_at(i);
duke@435 2958 char type = field->field_type();
duke@435 2959 if (!is_primitive_field_type(type)) {
never@2658 2960 oop fld_o = mirror->obj_field(field->field_offset());
never@2658 2961 assert(verify_static_oop(ik, mirror, field->field_offset()), "sanity check");
duke@435 2962 if (fld_o != NULL) {
duke@435 2963 int slot = field->field_index();
duke@435 2964 if (!CallbackInvoker::report_static_field_reference(mirror, fld_o, slot)) {
duke@435 2965 delete field_map;
duke@435 2966 return false;
duke@435 2967 }
duke@435 2968 }
duke@435 2969 } else {
duke@435 2970 if (is_reporting_primitive_fields()) {
never@2659 2971 address addr = (address)mirror + field->field_offset();
duke@435 2972 int slot = field->field_index();
duke@435 2973 if (!CallbackInvoker::report_primitive_static_field(mirror, slot, addr, type)) {
duke@435 2974 delete field_map;
duke@435 2975 return false;
duke@435 2976 }
duke@435 2977 }
duke@435 2978 }
duke@435 2979 }
duke@435 2980 delete field_map;
duke@435 2981
duke@435 2982 return true;
duke@435 2983 }
duke@435 2984
duke@435 2985 return true;
duke@435 2986 }
duke@435 2987
duke@435 2988 // an object references a class and its instance fields
duke@435 2989 // (static fields are ignored here as we report these as
duke@435 2990 // references from the class).
duke@435 2991 inline bool VM_HeapWalkOperation::iterate_over_object(oop o) {
duke@435 2992 // reference to the class
duke@435 2993 if (!CallbackInvoker::report_class_reference(o, Klass::cast(o->klass())->java_mirror())) {
duke@435 2994 return false;
duke@435 2995 }
duke@435 2996
duke@435 2997 // iterate over instance fields
duke@435 2998 ClassFieldMap* field_map = JvmtiCachedClassFieldMap::get_map_of_instance_fields(o);
duke@435 2999 for (int i=0; i<field_map->field_count(); i++) {
duke@435 3000 ClassFieldDescriptor* field = field_map->field_at(i);
duke@435 3001 char type = field->field_type();
duke@435 3002 if (!is_primitive_field_type(type)) {
coleenp@548 3003 oop fld_o = o->obj_field(field->field_offset());
sspitsyn@3556 3004 // ignore any objects that aren't visible to profiler
sspitsyn@3556 3005 if (fld_o != NULL && ServiceUtil::visible_oop(fld_o)) {
duke@435 3006 // reflection code may have a reference to a klassOop.
duke@435 3007 // - see sun.reflect.UnsafeStaticFieldAccessorImpl and sun.misc.Unsafe
duke@435 3008 if (fld_o->is_klass()) {
duke@435 3009 klassOop k = (klassOop)fld_o;
duke@435 3010 fld_o = Klass::cast(k)->java_mirror();
duke@435 3011 }
duke@435 3012 int slot = field->field_index();
duke@435 3013 if (!CallbackInvoker::report_field_reference(o, fld_o, slot)) {
duke@435 3014 return false;
duke@435 3015 }
duke@435 3016 }
duke@435 3017 } else {
duke@435 3018 if (is_reporting_primitive_fields()) {
duke@435 3019 // primitive instance field
duke@435 3020 address addr = (address)o + field->field_offset();
duke@435 3021 int slot = field->field_index();
duke@435 3022 if (!CallbackInvoker::report_primitive_instance_field(o, slot, addr, type)) {
duke@435 3023 return false;
duke@435 3024 }
duke@435 3025 }
duke@435 3026 }
duke@435 3027 }
duke@435 3028
duke@435 3029 // if the object is a java.lang.String
duke@435 3030 if (is_reporting_string_values() &&
never@1577 3031 o->klass() == SystemDictionary::String_klass()) {
duke@435 3032 if (!CallbackInvoker::report_string_value(o)) {
duke@435 3033 return false;
duke@435 3034 }
duke@435 3035 }
duke@435 3036 return true;
duke@435 3037 }
duke@435 3038
duke@435 3039
dcubed@3014 3040 // Collects all simple (non-stack) roots except for threads;
dcubed@3014 3041 // threads are handled in collect_stack_roots() as an optimization.
duke@435 3042 // if there's a heap root callback provided then the callback is
duke@435 3043 // invoked for each simple root.
duke@435 3044 // if an object reference callback is provided then all simple
duke@435 3045 // roots are pushed onto the marking stack so that they can be
duke@435 3046 // processed later
duke@435 3047 //
duke@435 3048 inline bool VM_HeapWalkOperation::collect_simple_roots() {
duke@435 3049 SimpleRootsClosure blk;
duke@435 3050
duke@435 3051 // JNI globals
duke@435 3052 blk.set_kind(JVMTI_HEAP_REFERENCE_JNI_GLOBAL);
duke@435 3053 JNIHandles::oops_do(&blk);
duke@435 3054 if (blk.stopped()) {
duke@435 3055 return false;
duke@435 3056 }
duke@435 3057
duke@435 3058 // Preloaded classes and loader from the system dictionary
duke@435 3059 blk.set_kind(JVMTI_HEAP_REFERENCE_SYSTEM_CLASS);
duke@435 3060 SystemDictionary::always_strong_oops_do(&blk);
duke@435 3061 if (blk.stopped()) {
duke@435 3062 return false;
duke@435 3063 }
duke@435 3064
duke@435 3065 // Inflated monitors
duke@435 3066 blk.set_kind(JVMTI_HEAP_REFERENCE_MONITOR);
duke@435 3067 ObjectSynchronizer::oops_do(&blk);
duke@435 3068 if (blk.stopped()) {
duke@435 3069 return false;
duke@435 3070 }
duke@435 3071
dcubed@3014 3072 // threads are now handled in collect_stack_roots()
duke@435 3073
duke@435 3074 // Other kinds of roots maintained by HotSpot
duke@435 3075 // Many of these won't be visible but others (such as instances of important
duke@435 3076 // exceptions) will be visible.
duke@435 3077 blk.set_kind(JVMTI_HEAP_REFERENCE_OTHER);
duke@435 3078 Universe::oops_do(&blk);
jrose@1424 3079
jrose@1424 3080 // If there are any non-perm roots in the code cache, visit them.
jrose@1424 3081 blk.set_kind(JVMTI_HEAP_REFERENCE_OTHER);
jrose@1424 3082 CodeBlobToOopClosure look_in_blobs(&blk, false);
jrose@1424 3083 CodeCache::scavenge_root_nmethods_do(&look_in_blobs);
jrose@1424 3084
duke@435 3085 return true;
duke@435 3086 }
duke@435 3087
duke@435 3088 // Walk the stack of a given thread and find all references (locals
duke@435 3089 // and JNI calls) and report these as stack references
duke@435 3090 inline bool VM_HeapWalkOperation::collect_stack_roots(JavaThread* java_thread,
duke@435 3091 JNILocalRootsClosure* blk)
duke@435 3092 {
duke@435 3093 oop threadObj = java_thread->threadObj();
duke@435 3094 assert(threadObj != NULL, "sanity check");
duke@435 3095
duke@435 3096 // only need to get the thread's tag once per thread
duke@435 3097 jlong thread_tag = tag_for(_tag_map, threadObj);
duke@435 3098
duke@435 3099 // also need the thread id
duke@435 3100 jlong tid = java_lang_Thread::thread_id(threadObj);
duke@435 3101
duke@435 3102
duke@435 3103 if (java_thread->has_last_Java_frame()) {
duke@435 3104
duke@435 3105 // vframes are resource allocated
duke@435 3106 Thread* current_thread = Thread::current();
duke@435 3107 ResourceMark rm(current_thread);
duke@435 3108 HandleMark hm(current_thread);
duke@435 3109
duke@435 3110 RegisterMap reg_map(java_thread);
duke@435 3111 frame f = java_thread->last_frame();
duke@435 3112 vframe* vf = vframe::new_vframe(&f, &reg_map, java_thread);
duke@435 3113
duke@435 3114 bool is_top_frame = true;
duke@435 3115 int depth = 0;
duke@435 3116 frame* last_entry_frame = NULL;
duke@435 3117
duke@435 3118 while (vf != NULL) {
duke@435 3119 if (vf->is_java_frame()) {
duke@435 3120
duke@435 3121 // java frame (interpreted, compiled, ...)
duke@435 3122 javaVFrame *jvf = javaVFrame::cast(vf);
duke@435 3123
duke@435 3124 // the jmethodID
duke@435 3125 jmethodID method = jvf->method()->jmethod_id();
duke@435 3126
duke@435 3127 if (!(jvf->method()->is_native())) {
duke@435 3128 jlocation bci = (jlocation)jvf->bci();
duke@435 3129 StackValueCollection* locals = jvf->locals();
duke@435 3130 for (int slot=0; slot<locals->size(); slot++) {
duke@435 3131 if (locals->at(slot)->type() == T_OBJECT) {
duke@435 3132 oop o = locals->obj_at(slot)();
duke@435 3133 if (o == NULL) {
duke@435 3134 continue;
duke@435 3135 }
duke@435 3136
duke@435 3137 // stack reference
duke@435 3138 if (!CallbackInvoker::report_stack_ref_root(thread_tag, tid, depth, method,
duke@435 3139 bci, slot, o)) {
duke@435 3140 return false;
duke@435 3141 }
duke@435 3142 }
duke@435 3143 }
duke@435 3144 } else {
duke@435 3145 blk->set_context(thread_tag, tid, depth, method);
duke@435 3146 if (is_top_frame) {
duke@435 3147 // JNI locals for the top frame.
duke@435 3148 java_thread->active_handles()->oops_do(blk);
duke@435 3149 } else {
duke@435 3150 if (last_entry_frame != NULL) {
duke@435 3151 // JNI locals for the entry frame
duke@435 3152 assert(last_entry_frame->is_entry_frame(), "checking");
duke@435 3153 last_entry_frame->entry_frame_call_wrapper()->handles()->oops_do(blk);
duke@435 3154 }
duke@435 3155 }
duke@435 3156 }
duke@435 3157 last_entry_frame = NULL;
duke@435 3158 depth++;
duke@435 3159 } else {
duke@435 3160 // externalVFrame - for an entry frame then we report the JNI locals
duke@435 3161 // when we find the corresponding javaVFrame
duke@435 3162 frame* fr = vf->frame_pointer();
duke@435 3163 assert(fr != NULL, "sanity check");
duke@435 3164 if (fr->is_entry_frame()) {
duke@435 3165 last_entry_frame = fr;
duke@435 3166 }
never@2895 3167 if (fr->is_ricochet_frame()) {
never@2895 3168 fr->oops_ricochet_do(blk, vf->register_map());
never@2895 3169 }
duke@435 3170 }
duke@435 3171
duke@435 3172 vf = vf->sender();
duke@435 3173 is_top_frame = false;
duke@435 3174 }
duke@435 3175 } else {
duke@435 3176 // no last java frame but there may be JNI locals
duke@435 3177 blk->set_context(thread_tag, tid, 0, (jmethodID)NULL);
duke@435 3178 java_thread->active_handles()->oops_do(blk);
duke@435 3179 }
duke@435 3180 return true;
duke@435 3181 }
duke@435 3182
duke@435 3183
dcubed@3014 3184 // Collects the simple roots for all threads and collects all
dcubed@3014 3185 // stack roots - for each thread it walks the execution
duke@435 3186 // stack to find all references and local JNI refs.
duke@435 3187 inline bool VM_HeapWalkOperation::collect_stack_roots() {
duke@435 3188 JNILocalRootsClosure blk;
duke@435 3189 for (JavaThread* thread = Threads::first(); thread != NULL ; thread = thread->next()) {
duke@435 3190 oop threadObj = thread->threadObj();
duke@435 3191 if (threadObj != NULL && !thread->is_exiting() && !thread->is_hidden_from_external_view()) {
dcubed@3014 3192 // Collect the simple root for this thread before we
dcubed@3014 3193 // collect its stack roots
dcubed@3014 3194 if (!CallbackInvoker::report_simple_root(JVMTI_HEAP_REFERENCE_THREAD,
dcubed@3014 3195 threadObj)) {
dcubed@3014 3196 return false;
dcubed@3014 3197 }
duke@435 3198 if (!collect_stack_roots(thread, &blk)) {
duke@435 3199 return false;
duke@435 3200 }
duke@435 3201 }
duke@435 3202 }
duke@435 3203 return true;
duke@435 3204 }
duke@435 3205
duke@435 3206 // visit an object
duke@435 3207 // first mark the object as visited
duke@435 3208 // second get all the outbound references from this object (in other words, all
duke@435 3209 // the objects referenced by this object).
duke@435 3210 //
duke@435 3211 bool VM_HeapWalkOperation::visit(oop o) {
duke@435 3212 // mark object as visited
duke@435 3213 assert(!ObjectMarker::visited(o), "can't visit same object more than once");
duke@435 3214 ObjectMarker::mark(o);
duke@435 3215
duke@435 3216 // instance
duke@435 3217 if (o->is_instance()) {
never@1577 3218 if (o->klass() == SystemDictionary::Class_klass()) {
duke@435 3219 o = klassOop_if_java_lang_Class(o);
duke@435 3220 if (o->is_klass()) {
duke@435 3221 // a java.lang.Class
duke@435 3222 return iterate_over_class(klassOop(o));
duke@435 3223 }
duke@435 3224 } else {
duke@435 3225 return iterate_over_object(o);
duke@435 3226 }
duke@435 3227 }
duke@435 3228
duke@435 3229 // object array
duke@435 3230 if (o->is_objArray()) {
duke@435 3231 return iterate_over_array(o);
duke@435 3232 }
duke@435 3233
duke@435 3234 // type array
duke@435 3235 if (o->is_typeArray()) {
duke@435 3236 return iterate_over_type_array(o);
duke@435 3237 }
duke@435 3238
duke@435 3239 return true;
duke@435 3240 }
duke@435 3241
duke@435 3242 void VM_HeapWalkOperation::doit() {
duke@435 3243 ResourceMark rm;
duke@435 3244 ObjectMarkerController marker;
duke@435 3245 ClassFieldMapCacheMark cm;
duke@435 3246
duke@435 3247 assert(visit_stack()->is_empty(), "visit stack must be empty");
duke@435 3248
duke@435 3249 // the heap walk starts with an initial object or the heap roots
duke@435 3250 if (initial_object().is_null()) {
dcubed@3013 3251 // If either collect_stack_roots() or collect_simple_roots()
dcubed@3013 3252 // returns false at this point, then there are no mark bits
dcubed@3013 3253 // to reset.
dcubed@3013 3254 ObjectMarker::set_needs_reset(false);
dcubed@3013 3255
dcubed@3014 3256 // Calling collect_stack_roots() before collect_simple_roots()
dcubed@3014 3257 // can result in a big performance boost for an agent that is
dcubed@3014 3258 // focused on analyzing references in the thread stacks.
dcubed@3014 3259 if (!collect_stack_roots()) return;
dcubed@3014 3260
duke@435 3261 if (!collect_simple_roots()) return;
dcubed@3013 3262
dcubed@3013 3263 // no early return so enable heap traversal to reset the mark bits
dcubed@3013 3264 ObjectMarker::set_needs_reset(true);
duke@435 3265 } else {
duke@435 3266 visit_stack()->push(initial_object()());
duke@435 3267 }
duke@435 3268
duke@435 3269 // object references required
duke@435 3270 if (is_following_references()) {
duke@435 3271
duke@435 3272 // visit each object until all reachable objects have been
duke@435 3273 // visited or the callback asked to terminate the iteration.
duke@435 3274 while (!visit_stack()->is_empty()) {
duke@435 3275 oop o = visit_stack()->pop();
duke@435 3276 if (!ObjectMarker::visited(o)) {
duke@435 3277 if (!visit(o)) {
duke@435 3278 break;
duke@435 3279 }
duke@435 3280 }
duke@435 3281 }
duke@435 3282 }
duke@435 3283 }
duke@435 3284
duke@435 3285 // iterate over all objects that are reachable from a set of roots
duke@435 3286 void JvmtiTagMap::iterate_over_reachable_objects(jvmtiHeapRootCallback heap_root_callback,
duke@435 3287 jvmtiStackReferenceCallback stack_ref_callback,
duke@435 3288 jvmtiObjectReferenceCallback object_ref_callback,
duke@435 3289 const void* user_data) {
duke@435 3290 MutexLocker ml(Heap_lock);
duke@435 3291 BasicHeapWalkContext context(heap_root_callback, stack_ref_callback, object_ref_callback);
duke@435 3292 VM_HeapWalkOperation op(this, Handle(), context, user_data);
duke@435 3293 VMThread::execute(&op);
duke@435 3294 }
duke@435 3295
duke@435 3296 // iterate over all objects that are reachable from a given object
duke@435 3297 void JvmtiTagMap::iterate_over_objects_reachable_from_object(jobject object,
duke@435 3298 jvmtiObjectReferenceCallback object_ref_callback,
duke@435 3299 const void* user_data) {
duke@435 3300 oop obj = JNIHandles::resolve(object);
duke@435 3301 Handle initial_object(Thread::current(), obj);
duke@435 3302
duke@435 3303 MutexLocker ml(Heap_lock);
duke@435 3304 BasicHeapWalkContext context(NULL, NULL, object_ref_callback);
duke@435 3305 VM_HeapWalkOperation op(this, initial_object, context, user_data);
duke@435 3306 VMThread::execute(&op);
duke@435 3307 }
duke@435 3308
duke@435 3309 // follow references from an initial object or the GC roots
duke@435 3310 void JvmtiTagMap::follow_references(jint heap_filter,
duke@435 3311 KlassHandle klass,
duke@435 3312 jobject object,
duke@435 3313 const jvmtiHeapCallbacks* callbacks,
duke@435 3314 const void* user_data)
duke@435 3315 {
duke@435 3316 oop obj = JNIHandles::resolve(object);
duke@435 3317 Handle initial_object(Thread::current(), obj);
duke@435 3318
duke@435 3319 MutexLocker ml(Heap_lock);
duke@435 3320 AdvancedHeapWalkContext context(heap_filter, klass, callbacks);
duke@435 3321 VM_HeapWalkOperation op(this, initial_object, context, user_data);
duke@435 3322 VMThread::execute(&op);
duke@435 3323 }
duke@435 3324
duke@435 3325
kamg@2445 3326 void JvmtiTagMap::weak_oops_do(BoolObjectClosure* is_alive, OopClosure* f) {
dcubed@2465 3327 // No locks during VM bring-up (0 threads) and no safepoints after main
dcubed@2465 3328 // thread creation and before VMThread creation (1 thread); initial GC
dcubed@2465 3329 // verification can happen in that window which gets to here.
dcubed@2465 3330 assert(Threads::number_of_threads() <= 1 ||
dcubed@2465 3331 SafepointSynchronize::is_at_safepoint(),
kamg@2445 3332 "must be executed at a safepoint");
duke@435 3333 if (JvmtiEnv::environments_might_exist()) {
duke@435 3334 JvmtiEnvIterator it;
duke@435 3335 for (JvmtiEnvBase* env = it.first(); env != NULL; env = it.next(env)) {
duke@435 3336 JvmtiTagMap* tag_map = env->tag_map();
duke@435 3337 if (tag_map != NULL && !tag_map->is_empty()) {
kamg@2445 3338 tag_map->do_weak_oops(is_alive, f);
duke@435 3339 }
duke@435 3340 }
duke@435 3341 }
duke@435 3342 }
duke@435 3343
kamg@2445 3344 void JvmtiTagMap::do_weak_oops(BoolObjectClosure* is_alive, OopClosure* f) {
duke@435 3345
duke@435 3346 // does this environment have the OBJECT_FREE event enabled
duke@435 3347 bool post_object_free = env()->is_enabled(JVMTI_EVENT_OBJECT_FREE);
duke@435 3348
duke@435 3349 // counters used for trace message
duke@435 3350 int freed = 0;
duke@435 3351 int moved = 0;
kamg@2445 3352
kamg@2445 3353 JvmtiTagHashmap* hashmap = this->hashmap();
duke@435 3354
duke@435 3355 // reenable sizing (if disabled)
kamg@2445 3356 hashmap->set_resizing_enabled(true);
kamg@2445 3357
kamg@2445 3358 // if the hashmap is empty then we can skip it
kamg@2445 3359 if (hashmap->_entry_count == 0) {
kamg@2445 3360 return;
duke@435 3361 }
duke@435 3362
kamg@2445 3363 // now iterate through each entry in the table
kamg@2445 3364
kamg@2445 3365 JvmtiTagHashmapEntry** table = hashmap->table();
kamg@2445 3366 int size = hashmap->size();
kamg@2445 3367
kamg@2445 3368 JvmtiTagHashmapEntry* delayed_add = NULL;
kamg@2445 3369
kamg@2445 3370 for (int pos = 0; pos < size; ++pos) {
kamg@2445 3371 JvmtiTagHashmapEntry* entry = table[pos];
kamg@2445 3372 JvmtiTagHashmapEntry* prev = NULL;
kamg@2445 3373
kamg@2445 3374 while (entry != NULL) {
kamg@2445 3375 JvmtiTagHashmapEntry* next = entry->next();
kamg@2445 3376
kamg@2445 3377 oop* obj = entry->object_addr();
kamg@2445 3378
kamg@2445 3379 // has object been GC'ed
kamg@2445 3380 if (!is_alive->do_object_b(entry->object())) {
kamg@2445 3381 // grab the tag
kamg@2445 3382 jlong tag = entry->tag();
kamg@2445 3383 guarantee(tag != 0, "checking");
kamg@2445 3384
kamg@2445 3385 // remove GC'ed entry from hashmap and return the
kamg@2445 3386 // entry to the free list
kamg@2445 3387 hashmap->remove(prev, pos, entry);
kamg@2445 3388 destroy_entry(entry);
kamg@2445 3389
kamg@2445 3390 // post the event to the profiler
kamg@2445 3391 if (post_object_free) {
kamg@2445 3392 JvmtiExport::post_object_free(env(), tag);
kamg@2445 3393 }
kamg@2445 3394
kamg@2445 3395 ++freed;
kamg@2445 3396 } else {
kamg@2445 3397 f->do_oop(entry->object_addr());
kamg@2445 3398 oop new_oop = entry->object();
kamg@2445 3399
kamg@2445 3400 // if the object has moved then re-hash it and move its
kamg@2445 3401 // entry to its new location.
kamg@2445 3402 unsigned int new_pos = JvmtiTagHashmap::hash(new_oop, size);
kamg@2445 3403 if (new_pos != (unsigned int)pos) {
kamg@2445 3404 if (prev == NULL) {
kamg@2445 3405 table[pos] = next;
kamg@2445 3406 } else {
kamg@2445 3407 prev->set_next(next);
duke@435 3408 }
kamg@2445 3409 if (new_pos < (unsigned int)pos) {
duke@435 3410 entry->set_next(table[new_pos]);
duke@435 3411 table[new_pos] = entry;
duke@435 3412 } else {
kamg@2445 3413 // Delay adding this entry to it's new position as we'd end up
kamg@2445 3414 // hitting it again during this iteration.
kamg@2445 3415 entry->set_next(delayed_add);
kamg@2445 3416 delayed_add = entry;
duke@435 3417 }
kamg@2445 3418 moved++;
duke@435 3419 } else {
kamg@2445 3420 // object didn't move
kamg@2445 3421 prev = entry;
duke@435 3422 }
duke@435 3423 }
kamg@2445 3424
kamg@2445 3425 entry = next;
duke@435 3426 }
duke@435 3427 }
duke@435 3428
kamg@2445 3429 // Re-add all the entries which were kept aside
kamg@2445 3430 while (delayed_add != NULL) {
kamg@2445 3431 JvmtiTagHashmapEntry* next = delayed_add->next();
kamg@2445 3432 unsigned int pos = JvmtiTagHashmap::hash(delayed_add->object(), size);
kamg@2445 3433 delayed_add->set_next(table[pos]);
kamg@2445 3434 table[pos] = delayed_add;
kamg@2445 3435 delayed_add = next;
duke@435 3436 }
duke@435 3437
duke@435 3438 // stats
duke@435 3439 if (TraceJVMTIObjectTagging) {
kamg@2445 3440 int post_total = hashmap->_entry_count;
duke@435 3441 int pre_total = post_total + freed;
duke@435 3442
kamg@2445 3443 tty->print_cr("(%d->%d, %d freed, %d total moves)",
kamg@2445 3444 pre_total, post_total, freed, moved);
duke@435 3445 }
duke@435 3446 }

mercurial