/*

 * Copyright (c) 2016, 2018, 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_JFR_CHECKPOINT_TYPES_TRACEID_JFRTYPEIDS_INLINE_HPP

#define SHARE_VM_JFR_CHECKPOINT_TYPES_TRACEID_JFRTYPEIDS_INLINE_HPP

#include "classfile/classLoaderData.hpp"

#include "classfile/moduleEntry.hpp"

#include "classfile/packageEntry.hpp"

#include "jfr/recorder/checkpoint/types/traceid/jfrTraceIdMacros.hpp"

#include "jfr/recorder/checkpoint/types/traceid/jfrTraceId.hpp"

#include "oops/arrayKlass.hpp"

#include "oops/klass.hpp"

#include "oops/instanceKlass.hpp"

#include "oops/method.hpp"

#include "runtime/thread.inline.hpp"

#include "utilities/debug.hpp"

template <typename T>

inline traceid set_used_and_get(const T* type, bool leakp) {

  assert(type != NULL, "invariant");

  if (leakp) {

    SET_LEAKP_USED_THIS_EPOCH(type);

    assert(LEAKP_USED_THIS_EPOCH(type), "invariant");

  }

  SET_USED_THIS_EPOCH(type);

  assert(USED_THIS_EPOCH(type), "invariant");

  return TRACE_ID_MASKED_PTR(type);

}

template <typename T>

inline traceid set_used_and_get_shifted(const T* type, bool leakp) {

  assert(type != NULL, "invariant");

  return set_used_and_get(type, leakp) >> TRACE_ID_SHIFT;

}

inline traceid JfrTraceId::get(const Klass* klass) {

  assert(klass != NULL, "invariant");

  return TRACE_ID(klass);

}

inline traceid JfrTraceId::get(const Thread* t) {

  assert(t != NULL, "invariant");

  return TRACE_ID_RAW(t->jfr_thread_local());

}

inline traceid JfrTraceId::use(const Klass* klass, bool leakp /* false */) {

  assert(klass != NULL, "invariant");

  return set_used_and_get_shifted(klass, leakp);

}

inline traceid JfrTraceId::use(const Method* method, bool leakp /* false */) {

  assert(method != NULL, "invariant");

  SET_METHOD_FLAG_USED_THIS_EPOCH(method);

  const Klass* const klass = method->method_holder();

  assert(klass != NULL, "invariant");

  if (leakp) {

    SET_LEAKP_USED_THIS_EPOCH(klass);

    assert(LEAKP_USED_THIS_EPOCH(klass), "invariant");

  }

  SET_METHOD_AND_CLASS_USED_THIS_EPOCH(klass);

  assert(METHOD_AND_CLASS_USED_THIS_EPOCH(klass), "invariant");

  return (METHOD_ID(klass, method));

}

inline traceid JfrTraceId::use(const ModuleEntry* module, bool leakp /* false */) {

  assert(module != NULL, "invariant");

  return set_used_and_get_shifted(module, leakp);

}

inline traceid JfrTraceId::use(const PackageEntry* package, bool leakp /* false */) {

  assert(package != NULL, "invariant");

  return set_used_and_get_shifted(package, leakp);

}

inline traceid JfrTraceId::use(const ClassLoaderData* cld, bool leakp /* false */) {

  assert(cld != NULL, "invariant");

}

inline bool JfrTraceId::in_visible_set(const Klass* klass) {

  assert(klass != NULL, "invariant");

  assert(((JavaThread*)Thread::current())->thread_state() == _thread_in_vm, "invariant");

  return (IS_JDK_JFR_EVENT_SUBKLASS(klass) && !klass->is_abstract()) || IS_EVENT_HOST_KLASS(klass);

}

inline bool JfrTraceId::is_jdk_jfr_event(const Klass* k) {

  assert(k != NULL, "invariant");

  return IS_JDK_JFR_EVENT_KLASS(k);

}

inline void JfrTraceId::tag_as_jdk_jfr_event(const Klass* klass) {

  assert(klass != NULL, "invariant");

  assert(IS_NOT_AN_EVENT_KLASS(klass), "invariant");

  SET_TAG(klass, JDK_JFR_EVENT_KLASS);

  assert(IS_JDK_JFR_EVENT_KLASS(klass), "invariant");

  assert(IS_NOT_AN_EVENT_SUB_KLASS(klass), "invariant");

}

inline bool JfrTraceId::is_jdk_jfr_event_sub(const Klass* k) {

  assert(k != NULL, "invariant");

  return IS_JDK_JFR_EVENT_SUBKLASS(k);

}

inline void JfrTraceId::tag_as_jdk_jfr_event_sub(const Klass* k) {

  assert(k != NULL, "invariant");

  if (IS_NOT_AN_EVENT_KLASS(k)) {

    SET_TAG(k, JDK_JFR_EVENT_SUBKLASS);

  }

  assert(IS_JDK_JFR_EVENT_SUBKLASS(k), "invariant");

}

inline bool JfrTraceId::in_jdk_jfr_event_hierarchy(const Klass* klass) {

  assert(klass != NULL, "invariant");

  if (is_jdk_jfr_event(klass)) {

    return true;

  }

  const Klass* const super = klass->super();

  return super != NULL ? IS_EVENT_KLASS(super) : false;

}

inline bool JfrTraceId::is_event_host(const Klass* k) {

  assert(k != NULL, "invariant");

  return IS_EVENT_HOST_KLASS(k);

}

inline void JfrTraceId::tag_as_event_host(const Klass* k) {

  assert(k != NULL, "invariant");

  SET_TAG(k, EVENT_HOST_KLASS);

  assert(IS_EVENT_HOST_KLASS(k), "invariant");

}

#endif // SHARE_VM_JFR_CHECKPOINT_TYPES_TRACEID_JFRTYPEIDS_INLINE_HPP