bytecode.hpp

/*
 * Copyright (c) 1997, 2023, 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_INTERPRETER_BYTECODE_HPP
#defineSHARE_INTERPRETER_BYTECODE_HPP

#include"interpreter/bytecodes.hpp"
#include"memory/allocation.hpp"
#include"oops/method.hpp"
#include"utilities/align.hpp"
#include"utilities/bytes.hpp"

classciBytecodeStream;
classResolvedIndyEntry;

// The base class for different kinds of bytecode abstractions.
// Provides the primitive operations to manipulate code relative
// to the bcp.

classBytecode: publicStackObj {
protected:
const address _bcp;
const Bytecodes::Code _code;

// Address computation
 address addr_at (int offset) const { return (address)_bcp + offset; }
u_charbyte_at(int offset) const { return *addr_at(offset); }
 address aligned_addr_at (int offset) const { returnalign_up(addr_at(offset), jintSize); }

// Word access:
intget_Java_u2_at (int offset) const { returnBytes::get_Java_u2(addr_at(offset)); }
intget_Java_u4_at (int offset) const { returnBytes::get_Java_u4(addr_at(offset)); }
intget_aligned_Java_u4_at(int offset) const { returnBytes::get_Java_u4(aligned_addr_at(offset)); }
intget_native_u2_at (int offset) const { returnBytes::get_native_u2(addr_at(offset)); }
intget_native_u4_at (int offset) const { returnBytes::get_native_u4(addr_at(offset)); }

public:
Bytecode(Method* method, address bcp): _bcp(bcp), _code(Bytecodes::code_at(method, addr_at(0))) {
assert(method != nullptr, "this form requires a valid Method*");
 }
// Defined in ciStreams.hpp
inlineBytecode(const ciBytecodeStream* stream, address bcp = nullptr);

// Attributes
 address bcp() const { return _bcp; }
intinstruction_size() const { returnBytecodes::length_for_code_at(_code, bcp()); }

 Bytecodes::Code code() const { return _code; }
 Bytecodes::Code java_code() const { returnBytecodes::java_code(code()); }
 Bytecodes::Code invoke_code() const { return (code() == Bytecodes::_invokehandle) ? code() : java_code(); }

// Static functions for parsing bytecodes in place.
 u1 get_index_u1(Bytecodes::Code bc) const {
assert_same_format_as(bc); assert_index_size(1, bc);
return *(u1*)addr_at(1);
 }
 u2 get_index_u2(Bytecodes::Code bc, bool is_wide = false) const {
assert_same_format_as(bc, is_wide); assert_index_size(2, bc, is_wide);
 address p = addr_at(is_wide ? 2 : 1);
if (can_use_native_byte_order(bc, is_wide)) {
returnBytes::get_native_u2(p);
 } else {
returnBytes::get_Java_u2(p);
 }
 }
intget_index_u4(Bytecodes::Code bc) const {
assert_same_format_as(bc); assert_index_size(4, bc);
assert(can_use_native_byte_order(bc), "");
returnBytes::get_native_u4(addr_at(1));
 }
boolhas_index_u4(Bytecodes::Code bc) const {
return bc == Bytecodes::_invokedynamic;
 }

intget_offset_s2(Bytecodes::Code bc) const {
assert_same_format_as(bc); assert_offset_size(2, bc);
return (jshort) Bytes::get_Java_u2(addr_at(1));
 }
intget_offset_s4(Bytecodes::Code bc) const {
assert_same_format_as(bc); assert_offset_size(4, bc);
return (jint) Bytes::get_Java_u4(addr_at(1));
 }

intget_constant_u1(int offset, Bytecodes::Code bc) const {
assert_same_format_as(bc); assert_constant_size(1, offset, bc);
return *(jbyte*)addr_at(offset);
 }
intget_constant_u2(int offset, Bytecodes::Code bc, bool is_wide = false) const {
assert_same_format_as(bc, is_wide); assert_constant_size(2, offset, bc, is_wide);
return (jshort) Bytes::get_Java_u2(addr_at(offset));
 }

// These are used locally and also from bytecode streams.
voidassert_same_format_as(Bytecodes::Code testbc, bool is_wide = false) const NOT_DEBUG_RETURN;
staticvoidassert_index_size(int required_size, Bytecodes::Code bc, bool is_wide = false) NOT_DEBUG_RETURN;
staticvoidassert_offset_size(int required_size, Bytecodes::Code bc, bool is_wide = false) NOT_DEBUG_RETURN;
staticvoidassert_constant_size(int required_size, int where, Bytecodes::Code bc, bool is_wide = false) NOT_DEBUG_RETURN;
staticvoidassert_native_index(Bytecodes::Code bc, bool is_wide = false) NOT_DEBUG_RETURN;
staticboolcan_use_native_byte_order(Bytecodes::Code bc, bool is_wide = false) {
return (!Endian::is_Java_byte_ordering_different() || Bytecodes::native_byte_order(bc /*, is_wide*/));
 }
};


// Abstractions for lookupswitch bytecode
classLookupswitchPair {
private:
const address _bcp;

 address addr_at (int offset) const { return _bcp + offset; }
intget_Java_u4_at (int offset) const { returnBytes::get_Java_u4(addr_at(offset)); }

public:
LookupswitchPair(address bcp): _bcp(bcp) {}
intmatch() const { returnget_Java_u4_at(0 * jintSize); }
intoffset() const { returnget_Java_u4_at(1 * jintSize); }
};


classBytecode_lookupswitch: publicBytecode {
public:
Bytecode_lookupswitch(Method* method, address bcp): Bytecode(method, bcp) { verify(); }
// Defined in ciStreams.hpp
inlineBytecode_lookupswitch(const ciBytecodeStream* stream);
voidverify() const PRODUCT_RETURN;

// Attributes
intdefault_offset() const { returnget_aligned_Java_u4_at(1 + 0*jintSize); }
intnumber_of_pairs() const { returnget_aligned_Java_u4_at(1 + 1*jintSize); }
 LookupswitchPair pair_at(int i) const {
assert(0 <= i && i < number_of_pairs(), "pair index out of bounds");
returnLookupswitchPair(aligned_addr_at(1 + (1 + i)*2*jintSize));
 }
};

classBytecode_tableswitch: publicBytecode {
public:
Bytecode_tableswitch(Method* method, address bcp): Bytecode(method, bcp) { verify(); }
// Defined in ciStreams.hpp
inlineBytecode_tableswitch(const ciBytecodeStream* stream);
voidverify() const PRODUCT_RETURN;

// Attributes
intdefault_offset() const { returnget_aligned_Java_u4_at(1 + 0*jintSize); }
intlow_key() const { returnget_aligned_Java_u4_at(1 + 1*jintSize); }
inthigh_key() const { returnget_aligned_Java_u4_at(1 + 2*jintSize); }
intdest_offset_at(int i) const;
intlength() { returnhigh_key()-low_key()+1; }
};

// Common code for decoding invokes and field references.

classBytecode_member_ref: publicBytecode {
protected:
const Method* _method; // method containing the bytecode

Bytecode_member_ref(const methodHandle& method, int bci) : Bytecode(method(), method()->bcp_from(bci)), _method(method()) {}

const Method* method() const { return _method; }
 ConstantPool* constants() const { return _method->constants(); }
 ConstantPoolCache* cpcache() const { return _method->constants()->cache(); }
 ResolvedIndyEntry* resolved_indy_entry() const;
 ResolvedMethodEntry* resolved_method_entry() const;

public:
intindex() const; // cache index (loaded from instruction)
intpool_index() const; // constant pool index
 Symbol* klass() const; // returns the klass of the method or field
 Symbol* name() const; // returns the name of the method or field
 Symbol* signature() const; // returns the signature of the method or field

 BasicType result_type() const; // returns the result type of the getfield or invoke
};

// Abstraction for invoke_{virtual, static, interface, special, dynamic, handle}

classBytecode_invoke: publicBytecode_member_ref {
protected:
// Constructor that skips verification
Bytecode_invoke(const methodHandle& method, int bci, bool unused) : Bytecode_member_ref(method, bci) {}

public:
Bytecode_invoke(const methodHandle& method, int bci) : Bytecode_member_ref(method, bci) { verify(); }
voidverify() const;

// Attributes
 Method* static_target(TRAPS); // "specified" method (from constant pool)

// Testers
boolis_invokeinterface() const { returninvoke_code() == Bytecodes::_invokeinterface; }
boolis_invokevirtual() const { returninvoke_code() == Bytecodes::_invokevirtual; }
boolis_invokestatic() const { returninvoke_code() == Bytecodes::_invokestatic; }
boolis_invokespecial() const { returninvoke_code() == Bytecodes::_invokespecial; }
boolis_invokedynamic() const { returninvoke_code() == Bytecodes::_invokedynamic; }
boolis_invokehandle() const { returninvoke_code() == Bytecodes::_invokehandle; }

boolhas_receiver() const { return !is_invokestatic() && !is_invokedynamic(); }

boolis_valid() const { returnis_invokeinterface() ||
is_invokevirtual() ||
is_invokestatic() ||
is_invokespecial() ||
is_invokedynamic() ||
is_invokehandle(); }

boolhas_appendix();

boolhas_member_arg() const;

intsize_of_parameters() const;

private:
// Helper to skip verification. Used is_valid() to check if the result is really an invoke
inlinefriend Bytecode_invoke Bytecode_invoke_check(const methodHandle& method, int bci);
};

inline Bytecode_invoke Bytecode_invoke_check(const methodHandle& method, int bci) {
returnBytecode_invoke(method, bci, false);
}


// Abstraction for all field accesses (put/get field/static)
classBytecode_field: publicBytecode_member_ref {
public:
Bytecode_field(const methodHandle& method, int bci) : Bytecode_member_ref(method, bci) { verify(); }

// Testers
boolis_getfield() const { returnjava_code() == Bytecodes::_getfield; }
boolis_putfield() const { returnjava_code() == Bytecodes::_putfield; }
boolis_getstatic() const { returnjava_code() == Bytecodes::_getstatic; }
boolis_putstatic() const { returnjava_code() == Bytecodes::_putstatic; }

boolis_getter() const { returnis_getfield() || is_getstatic(); }
boolis_static() const { returnis_getstatic() || is_putstatic(); }

boolis_valid() const { returnis_getfield() ||
is_putfield() ||
is_getstatic() ||
is_putstatic(); }
voidverify() const;
};

// Abstraction for checkcast
classBytecode_checkcast: publicBytecode {
public:
Bytecode_checkcast(Method* method, address bcp): Bytecode(method, bcp) { verify(); }
voidverify() const { assert(Bytecodes::java_code(code()) == Bytecodes::_checkcast, "check checkcast"); }

// Returns index
 u2 index() const { returnget_index_u2(Bytecodes::_checkcast); };
};

// Abstraction for instanceof
classBytecode_instanceof: publicBytecode {
public:
Bytecode_instanceof(Method* method, address bcp): Bytecode(method, bcp) { verify(); }
voidverify() const { assert(code() == Bytecodes::_instanceof, "check instanceof"); }

// Returns index
 u2 index() const { returnget_index_u2(Bytecodes::_instanceof); };
};

classBytecode_new: publicBytecode {
public:
Bytecode_new(Method* method, address bcp): Bytecode(method, bcp) { verify(); }
voidverify() const { assert(java_code() == Bytecodes::_new, "check new"); }

// Returns index
 u2 index() const { returnget_index_u2(Bytecodes::_new); };
};

classBytecode_multianewarray: publicBytecode {
public:
Bytecode_multianewarray(Method* method, address bcp): Bytecode(method, bcp) { verify(); }
voidverify() const { assert(java_code() == Bytecodes::_multianewarray, "check new"); }

// Returns index
 u2 index() const { returnget_index_u2(Bytecodes::_multianewarray); };
};

classBytecode_anewarray: publicBytecode {
public:
Bytecode_anewarray(Method* method, address bcp): Bytecode(method, bcp) { verify(); }
voidverify() const { assert(java_code() == Bytecodes::_anewarray, "check anewarray"); }

// Returns index
 u2 index() const { returnget_index_u2(Bytecodes::_anewarray); };
};

// Abstraction for ldc, ldc_w and ldc2_w
classBytecode_loadconstant: publicBytecode {
private:
const Method* _method;

intraw_index() const;

public:
Bytecode_loadconstant(const methodHandle& method, int bci): Bytecode(method(), method->bcp_from(bci)), _method(method()) { verify(); }

voidverify() const {
assert(_method != nullptr, "must supply method");
 Bytecodes::Code stdc = Bytecodes::java_code(code());
assert(stdc == Bytecodes::_ldc ||
 stdc == Bytecodes::_ldc_w ||
 stdc == Bytecodes::_ldc2_w, "load constant");
 }

// Only non-standard bytecodes (fast_aldc) have reference cache indexes.
boolhas_cache_index() const { returncode() >= Bytecodes::number_of_java_codes; }

intpool_index() const; // index into constant pool
intcache_index() const { // index into reference cache (or -1 if none)
returnhas_cache_index() ? raw_index() : -1;
 }

 BasicType result_type() const; // returns the result type of the ldc

 oop resolve_constant(TRAPS) const;
};

#endif // SHARE_INTERPRETER_BYTECODE_HPP