/*
 * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 *
 */

#ifndef SHARE_VM_OOPS_INSTANCEREFKLASS_INLINE_HPP
#define SHARE_VM_OOPS_INSTANCEREFKLASS_INLINE_HPP

#include "oops/instanceRefKlass.hpp"
#include "oops/oop.inline2.hpp"

PRAGMA_FORMAT_MUTE_WARNINGS_FOR_GCC

template <typename T, bool nv, typename OopClosureType>
void InstanceRefKlass::specialized_oop_iterate(oop obj,
                                               OopClosureType* closure,
                                               MemRegion* mr) {
  T* disc_addr = (T*)java_lang_ref_Reference::discovered_addr(obj);
  if (closure->apply_to_weak_ref_discovered_field()) {
    Devirtualizer<nv, OopClosureType>::do_oop(closure, disc_addr);
  }

  T* referent_addr = (T*)java_lang_ref_Reference::referent_addr(obj);
  T heap_oop = oopDesc::load_heap_oop(referent_addr);
  ReferenceProcessor* rp = closure->_ref_processor;
  if (!oopDesc::is_null(heap_oop)) {
    oop referent = oopDesc::decode_heap_oop_not_null(heap_oop);
    if (!referent->is_gc_marked() && (rp != NULL) &&
        rp->discover_reference(obj, reference_type())) {
      return;
    } else if (mr == NULL || mr->contains(referent_addr)) {
      /* treat referent as normal oop */
      Devirtualizer<nv, OopClosureType>::do_oop(closure, referent_addr);
    }
  }
  T* next_addr = (T*)java_lang_ref_Reference::next_addr(obj);
  if (ReferenceProcessor::pending_list_uses_discovered_field()) {
    T next_oop  = oopDesc::load_heap_oop(next_addr);
    /* Treat discovered as normal oop, if ref is not "active" (next non-NULL) */
    if (!oopDesc::is_null(next_oop) && (mr == NULL || mr->contains(disc_addr))) {
        /* i.e. ref is not "active" */
      debug_only(
        if(TraceReferenceGC && PrintGCDetails) {
          gclog_or_tty->print_cr("   Process discovered as normal "
                                 INTPTR_FORMAT, disc_addr);
        }
      )
      Devirtualizer<nv, OopClosureType>::do_oop(closure, disc_addr);
    }
  } else {
    /* In the case of older JDKs which do not use the discovered field for  */
    /* the pending list, an inactive ref (next != NULL) must always have a  */
    /* NULL discovered field. */
    debug_only(
      T next_oop = oopDesc::load_heap_oop(next_addr);
      T disc_oop = oopDesc::load_heap_oop(disc_addr);
      assert(oopDesc::is_null(next_oop) || oopDesc::is_null(disc_oop),
           err_msg("Found an inactive reference " PTR_FORMAT " with a non-NULL"
                   "discovered field", (oopDesc*)obj));
    )
  }
  /* treat next as normal oop */
  if (mr == NULL || mr->contains(next_addr)) {
    Devirtualizer<nv, OopClosureType>::do_oop(closure, next_addr);
  }
}

// Macro to define InstanceRefKlass::oop_oop_iterate for virtual/nonvirtual for
// all closures.  Macros calling macros above for each oop size.

template <bool nv, typename OopClosureType>
int InstanceRefKlass::
oop_oop_iterate(oop obj, OopClosureType* closure) {
  /* Get size before changing pointers */

  int size = InstanceKlass::oop_oop_iterate<nv>(obj, closure);

  if (UseCompressedOops) {
    specialized_oop_iterate<narrowOop, nv>(obj, closure, NULL);
  } else {
    specialized_oop_iterate<oop, nv>(obj, closure, NULL);
  }

  return size;
}

#ifndef SERIALGC

template <bool nv, typename OopClosureType>
int InstanceRefKlass::
oop_oop_iterate_backwards(oop obj, OopClosureType* closure) {
  /* Get size before changing pointers */

  int size = InstanceKlass::oop_oop_iterate_backwards<nv>(obj, closure);

  if (UseCompressedOops) {
    specialized_oop_iterate<narrowOop, nv>(obj, closure, NULL);
  } else {
    specialized_oop_iterate<oop, nv>(obj, closure, NULL);
  }

  return size;
}
#endif // !SERIALGC


template <bool nv, typename OopClosureType>
int InstanceRefKlass::
oop_oop_iterate_m(oop obj,
                    OopClosureType* closure,
                    MemRegion mr) {

  int size = InstanceKlass::oop_oop_iterate_m<nv>(obj, closure, mr);

  if (UseCompressedOops) {
    specialized_oop_iterate<narrowOop, nv>(obj, closure, &mr);
  } else {
    specialized_oop_iterate<oop, nv>(obj, closure, &mr);
  }

  return size;
}

#endif // SHARE_VM_OOPS_INSTANCEREFKLASS_INLINE_HPP