duke@435: /*
stefank@2314:  * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
duke@435:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@435:  *
duke@435:  * This code is free software; you can redistribute it and/or modify it
duke@435:  * under the terms of the GNU General Public License version 2 only, as
duke@435:  * published by the Free Software Foundation.
duke@435:  *
duke@435:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@435:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@435:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@435:  * version 2 for more details (a copy is included in the LICENSE file that
duke@435:  * accompanied this code).
duke@435:  *
duke@435:  * You should have received a copy of the GNU General Public License version
duke@435:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@435:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@435:  *
trims@1907:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
trims@1907:  * or visit www.oracle.com if you need additional information or have any
trims@1907:  * questions.
duke@435:  *
duke@435:  */
duke@435: 
stefank@2314: #ifndef SHARE_VM_INTERPRETER_BYTECODETRACER_HPP
stefank@2314: #define SHARE_VM_INTERPRETER_BYTECODETRACER_HPP
stefank@2314: 
stefank@2314: #include "memory/allocation.hpp"
stefank@2314: 
duke@435: // The BytecodeTracer is a helper class used by the interpreter for run-time
duke@435: // bytecode tracing. If bytecode tracing is turned on, trace() will be called
duke@435: // for each bytecode.
duke@435: //
duke@435: // By specialising the BytecodeClosure, all kinds of bytecode traces can
duke@435: // be done.
duke@435: 
duke@435: #ifndef PRODUCT
duke@435: // class BytecodeTracer is only used by TraceBytecodes option
duke@435: 
duke@435: class BytecodeClosure;
duke@435: class BytecodeTracer: AllStatic {
duke@435:  private:
duke@435:   static BytecodeClosure* _closure;
duke@435: 
duke@435:  public:
duke@435:   static BytecodeClosure* std_closure();                        // a printing closure
duke@435:   static BytecodeClosure* closure()                                                   { return _closure; }
duke@435:   static void             set_closure(BytecodeClosure* closure) { _closure = closure; }
duke@435: 
duke@435:   static void             trace(methodHandle method, address bcp, uintptr_t tos, uintptr_t tos2, outputStream* st = tty);
duke@435:   static void             trace(methodHandle method, address bcp, outputStream* st = tty);
duke@435: };
duke@435: 
duke@435: 
duke@435: // For each bytecode, a BytecodeClosure's trace() routine will be called.
duke@435: 
duke@435: class BytecodeClosure {
duke@435:  public:
duke@435:   virtual void trace(methodHandle method, address bcp, uintptr_t tos, uintptr_t tos2, outputStream* st) = 0;
duke@435:   virtual void trace(methodHandle method, address bcp, outputStream* st) = 0;
duke@435: };
duke@435: 
duke@435: #endif // !PRODUCT
stefank@2314: 
stefank@2314: #endif // SHARE_VM_INTERPRETER_BYTECODETRACER_HPP