/*

 * Copyright (c) 1997, 2016, 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_RUNTIME_VFRAME_HP_HPP

#define SHARE_VM_RUNTIME_VFRAME_HP_HPP

#include "runtime/vframe.hpp"

class compiledVFrame: public javaVFrame {

 public:

  // JVM state

  Method*                      method()             const;

  int                          bci()                const;

  bool                         should_reexecute()   const;

  StackValueCollection*        locals()             const;

  StackValueCollection*        expressions()        const;

  GrowableArray<MonitorInfo*>* monitors()           const;

  int                          vframe_id()          const { return _vframe_id; }

  void set_locals(StackValueCollection* values) const;

  // Virtuals defined in vframe

  bool is_compiled_frame() const { return true; }

  vframe* sender() const;

  bool is_top() const;

  // Casting

  static compiledVFrame* cast(vframe* vf) {

    assert(vf == NULL || vf->is_compiled_frame(), "must be compiled frame");

    return (compiledVFrame*) vf;

  }

  void update_deferred_value(BasicType type, int index, jvalue value);

 public:

  // Constructors

  compiledVFrame(const frame* fr, const RegisterMap* reg_map, JavaThread* thread, CompiledMethod* nm);

  // Update a local in a compiled frame. Update happens when deopt occurs

  void update_local(BasicType type, int index, jvalue value);

  // Update an expression stack value in a compiled frame. Update happens when deopt occurs

  void update_stack(BasicType type, int index, jvalue value);

  // Update a lock value in a compiled frame. Update happens when deopt occurs

  void update_monitor(int index, MonitorInfo* value);

  // Returns the active nmethod

  CompiledMethod*  code() const;

  // Returns the scopeDesc

  ScopeDesc* scope() const { return _scope; }

  // Returns SynchronizationEntryBCI or bci() (used for synchronization)

  int raw_bci() const;

 protected:

  ScopeDesc* _scope;

  int _vframe_id;

  //StackValue resolve(ScopeValue* sv) const;

  BasicLock* resolve_monitor_lock(Location location) const;

  StackValue *create_stack_value(ScopeValue *sv) const;

 private:

  compiledVFrame(const frame* fr, const RegisterMap* reg_map, JavaThread* thread, ScopeDesc* scope, int vframe_id);

#ifndef PRODUCT

 public:

  void verify() const;

#endif

};

// In order to implement set_locals for compiled vframes we must

// store updated locals in a data structure that contains enough

// information to recognize equality with a vframe and to store

// any updated locals.

class jvmtiDeferredLocalVariable;

class jvmtiDeferredLocalVariableSet : public CHeapObj<mtCompiler> {

  friend class compiledVFrame;

private:

  Method* _method;

  int       _bci;

  intptr_t* _id;

  int _vframe_id;

  GrowableArray<jvmtiDeferredLocalVariable*>* _locals;

  void                              update_value(StackValueCollection* locals, BasicType type, int index, jvalue value);

  void                              set_value_at(int idx, BasicType typ, jvalue val);

 public:

  // JVM state

  Method*                           method()         const  { return _method; }

  int                               bci()            const  { return _bci; }

  intptr_t*                         id()             const  { return _id; }

  int                               vframe_id()      const  { return _vframe_id; }

  void                              update_locals(StackValueCollection* locals);

  void                              update_stack(StackValueCollection* locals);

  void                              update_monitors(GrowableArray<MonitorInfo*>* monitors);

  // Does the vframe match this jvmtiDeferredLocalVariableSet

  bool                              matches(const vframe* vf);

  // GC

  void                              oops_do(OopClosure* f);

  // constructor

  jvmtiDeferredLocalVariableSet(Method* method, int bci, intptr_t* id, int vframe_id);

  // destructor

  ~jvmtiDeferredLocalVariableSet();

};

class jvmtiDeferredLocalVariable : public CHeapObj<mtCompiler> {

  public:

    jvmtiDeferredLocalVariable(int index, BasicType type, jvalue value);

    BasicType type(void)                   { return _type; }

    int index(void)                        { return _index; }

    jvalue value(void)                     { return _value; }

    // Only mutator is for value as only it can change

    void set_value(jvalue value)           { _value = value; }

    // For gc

    oop* oop_addr(void)                    { return (oop*) &_value.l; }

  private:

    BasicType         _type;

    jvalue            _value;

    int               _index;

};

#endif // SHARE_VM_RUNTIME_VFRAME_HP_HPP