1/*
2 * Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25#ifndef SHARE_INTERPRETER_BYTECODETRACER_HPP
26#define SHARE_INTERPRETER_BYTECODETRACER_HPP
27
28#include "memory/allocation.hpp"
29#include "utilities/ostream.hpp"
30
31// The BytecodeTracer is a helper class used by the interpreter for run-time
32// bytecode tracing. If bytecode tracing is turned on, trace() will be called
33// for each bytecode.
34//
35// By specialising the BytecodeClosure, all kinds of bytecode traces can
36// be done.
37
38// class BytecodeTracer is used by TraceBytecodes option and PrintMethodData
39
40class methodHandle;
41
42class BytecodeClosure;
43class BytecodeTracer: AllStatic {
44 private:
45 static BytecodeClosure* _closure;
46
47 public:
48 static BytecodeClosure* std_closure(); // a printing closure
49 static BytecodeClosure* closure() { return _closure; }
50 static void set_closure(BytecodeClosure* closure) { _closure = closure; }
51
52 static void trace(const methodHandle& method, address bcp, uintptr_t tos, uintptr_t tos2, outputStream* st = tty);
53 static void trace(const methodHandle& method, address bcp, outputStream* st = tty);
54};
55
56
57// For each bytecode, a BytecodeClosure's trace() routine will be called.
58
59class BytecodeClosure {
60 public:
61 virtual void trace(const methodHandle& method, address bcp, uintptr_t tos, uintptr_t tos2, outputStream* st) = 0;
62 virtual void trace(const methodHandle& method, address bcp, outputStream* st) = 0;
63};
64
65#endif // SHARE_INTERPRETER_BYTECODETRACER_HPP
66