#ifndef SHARE_VM_CLASSFILE_CLASSFILEPARSER_HPP

#define SHARE_VM_CLASSFILE_CLASSFILEPARSER_HPP

#include "classfile/classFileStream.hpp"

#include "memory/resourceArea.hpp"

#include "oops/oop.inline.hpp"

#include "oops/typeArrayOop.hpp"

#include "runtime/handles.inline.hpp"

#include "utilities/accessFlags.hpp"

#include "classfile/symbolTable.hpp"

class FieldAllocationCount;

class ClassFileParser VALUE_OBJ_CLASS_SPEC {

private:

bool _need_verify;

bool _relax_verify;

u2 _major_version;

u2 _minor_version;

Symbol* _class_name;

KlassHandle _host_klass;

GrowableArray<Handle>* _cp_patches; // overrides for CP entries

// precomputed flags

bool _has_finalizer;

bool _has_empty_finalizer;

bool _has_vanilla_constructor;

int _max_bootstrap_specifier_index; // detects BSS values

// class attributes parsed before the instance klass is created:

bool _synthetic_flag;

Symbol* _sourcefile;

Symbol* _generic_signature;

char* _sde_buffer;

int _sde_length;

typeArrayHandle _inner_classes;

typeArrayHandle _annotations;

void set_class_synthetic_flag(bool x) { _synthetic_flag = x; }

void set_class_sourcefile(Symbol* x) { _sourcefile = x; }

void set_class_generic_signature(Symbol* x) { _generic_signature = x; }

void set_class_sde_buffer(char* x, int len) { _sde_buffer = x; _sde_length = len; }

void set_class_inner_classes(typeArrayHandle x) { _inner_classes = x; }

void set_class_annotations(typeArrayHandle x) { _annotations = x; }

void init_parsed_class_attributes() {

_synthetic_flag = false;

_sourcefile = NULL;

_generic_signature = NULL;

_sde_buffer = NULL;

_sde_length = 0;

// initialize the other flags too:

_has_finalizer = _has_empty_finalizer = _has_vanilla_constructor = false;

_max_bootstrap_specifier_index = -1;

}

void apply_parsed_class_attributes(instanceKlassHandle k); // update k

class AnnotationCollector {

public:

enum Location { _in_field, _in_method, _in_class };

enum ID {

_unknown = 0,

_method_ForceInline,

_annotation_LIMIT

};

const Location _location;

int _annotations_present;

AnnotationCollector(Location location)

: _location(location), _annotations_present(0)

{

assert((int)_annotation_LIMIT <= (int)sizeof(_annotations_present) * BitsPerByte, "");

}

// If this annotation name has an ID, report it (or _none).

ID annotation_index(Symbol* name);

// Set the annotation name:

void set_annotation(ID id) {

assert((int)id >= 0 && (int)id < (int)_annotation_LIMIT, "oob");

_annotations_present |= nth_bit((int)id);

}

// Report if the annotation is present.

bool has_any_annotations() { return _annotations_present != 0; }

bool has_annotation(ID id) { return (nth_bit((int)id) & _annotations_present) != 0; }

};

class FieldAnnotationCollector: public AnnotationCollector {

public:

FieldAnnotationCollector() : AnnotationCollector(_in_field) { }

void apply_to(FieldInfo* f);

};

class MethodAnnotationCollector: public AnnotationCollector {

public:

MethodAnnotationCollector() : AnnotationCollector(_in_method) { }

void apply_to(methodHandle m);

};

class ClassAnnotationCollector: public AnnotationCollector {

public:

ClassAnnotationCollector() : AnnotationCollector(_in_class) { }

void apply_to(instanceKlassHandle k);

};

enum { fixed_buffer_size = 128 };

u_char linenumbertable_buffer[fixed_buffer_size];

ClassFileStream* _stream; // Actual input stream

enum { LegalClass, LegalField, LegalMethod }; // used to verify unqualified names

// Accessors

ClassFileStream* stream() { return _stream; }

void set_stream(ClassFileStream* st) { _stream = st; }

// Constant pool parsing

void parse_constant_pool_entries(Handle class_loader,

constantPoolHandle cp, int length, TRAPS);

constantPoolHandle parse_constant_pool(Handle class_loader, TRAPS);

// Interface parsing

objArrayHandle parse_interfaces(constantPoolHandle cp,

int length,

Handle class_loader,

Handle protection_domain,

Symbol* class_name,

TRAPS);

// Field parsing

void parse_field_attributes(constantPoolHandle cp, u2 attributes_count,

bool is_static, u2 signature_index,

u2* constantvalue_index_addr,

bool* is_synthetic_addr,

u2* generic_signature_index_addr,

typeArrayHandle* field_annotations,

FieldAnnotationCollector* parsed_annotations,

TRAPS);

typeArrayHandle parse_fields(Symbol* class_name,

constantPoolHandle cp, bool is_interface,

FieldAllocationCount *fac,

objArrayHandle* fields_annotations,

u2* java_fields_count_ptr, TRAPS);

// Method parsing

methodHandle parse_method(constantPoolHandle cp, bool is_interface,

AccessFlags* promoted_flags,

typeArrayHandle* method_annotations,

typeArrayHandle* method_parameter_annotations,

typeArrayHandle* method_default_annotations,

TRAPS);

objArrayHandle parse_methods (constantPoolHandle cp, bool is_interface,

AccessFlags* promoted_flags,

bool* has_final_method,

objArrayOop* methods_annotations_oop,

objArrayOop* methods_parameter_annotations_oop,

objArrayOop* methods_default_annotations_oop,

TRAPS);

typeArrayHandle sort_methods (objArrayHandle methods,

objArrayHandle methods_annotations,

objArrayHandle methods_parameter_annotations,

objArrayHandle methods_default_annotations,

TRAPS);

typeArrayHandle parse_exception_table(u4 code_length, u4 exception_table_length,

constantPoolHandle cp, TRAPS);

void parse_linenumber_table(

u4 code_attribute_length, u4 code_length,

CompressedLineNumberWriteStream** write_stream, TRAPS);

u2* parse_localvariable_table(u4 code_length, u2 max_locals, u4 code_attribute_length,

constantPoolHandle cp, u2* localvariable_table_length,

bool isLVTT, TRAPS);

u2* parse_checked_exceptions(u2* checked_exceptions_length, u4 method_attribute_length,

constantPoolHandle cp, TRAPS);

void parse_type_array(u2 array_length, u4 code_length, u4* u1_index, u4* u2_index,

u1* u1_array, u2* u2_array, constantPoolHandle cp, TRAPS);

typeArrayOop parse_stackmap_table(u4 code_attribute_length, TRAPS);

// Classfile attribute parsing

void parse_classfile_sourcefile_attribute(constantPoolHandle cp, TRAPS);

void parse_classfile_source_debug_extension_attribute(constantPoolHandle cp, int length, TRAPS);

u2 parse_classfile_inner_classes_attribute(u1* inner_classes_attribute_start,

bool parsed_enclosingmethod_attribute,

u2 enclosing_method_class_index,

u2 enclosing_method_method_index,

constantPoolHandle cp,

TRAPS);

void parse_classfile_attributes(constantPoolHandle cp,

ClassAnnotationCollector* parsed_annotations,

TRAPS);

void parse_classfile_synthetic_attribute(constantPoolHandle cp, TRAPS);

void parse_classfile_signature_attribute(constantPoolHandle cp, TRAPS);

void parse_classfile_bootstrap_methods_attribute(constantPoolHandle cp, u4 attribute_length, TRAPS);

// Annotations handling

typeArrayHandle assemble_annotations(u1* runtime_visible_annotations,

int runtime_visible_annotations_length,

u1* runtime_invisible_annotations,

int runtime_invisible_annotations_length, TRAPS);

int skip_annotation(u1* buffer, int limit, int index);

int skip_annotation_value(u1* buffer, int limit, int index);

void parse_annotations(u1* buffer, int limit, constantPoolHandle cp,

/* Results (currently, only one result is supported): */

AnnotationCollector* result,

TRAPS);

// Final setup

unsigned int compute_oop_map_count(instanceKlassHandle super,

unsigned int nonstatic_oop_count,

int first_nonstatic_oop_offset);

void fill_oop_maps(instanceKlassHandle k,

unsigned int nonstatic_oop_map_count,

int* nonstatic_oop_offsets,

unsigned int* nonstatic_oop_counts);

void set_precomputed_flags(instanceKlassHandle k);

objArrayHandle compute_transitive_interfaces(instanceKlassHandle super,

objArrayHandle local_ifs, TRAPS);

// Format checker methods

void classfile_parse_error(const char* msg, TRAPS);

void classfile_parse_error(const char* msg, int index, TRAPS);

void classfile_parse_error(const char* msg, const char *name, TRAPS);

void classfile_parse_error(const char* msg, int index, const char *name, TRAPS);

inline void guarantee_property(bool b, const char* msg, TRAPS) {

if (!b) { classfile_parse_error(msg, CHECK); }

}

inline void assert_property(bool b, const char* msg, TRAPS) {

#ifdef ASSERT

if (!b) { fatal(msg); }

#endif

}

inline void check_property(bool property, const char* msg, int index, TRAPS) {

if (_need_verify) {

guarantee_property(property, msg, index, CHECK);

} else {

assert_property(property, msg, CHECK);

}

}

inline void check_property(bool property, const char* msg, TRAPS) {

if (_need_verify) {

guarantee_property(property, msg, CHECK);

} else {

assert_property(property, msg, CHECK);

}

}

inline void guarantee_property(bool b, const char* msg, int index, TRAPS) {

if (!b) { classfile_parse_error(msg, index, CHECK); }

}

inline void guarantee_property(bool b, const char* msg, const char *name, TRAPS) {

if (!b) { classfile_parse_error(msg, name, CHECK); }

}

inline void guarantee_property(bool b, const char* msg, int index, const char *name, TRAPS) {

if (!b) { classfile_parse_error(msg, index, name, CHECK); }

}

void throwIllegalSignature(

const char* type, Symbol* name, Symbol* sig, TRAPS);

bool is_supported_version(u2 major, u2 minor);

bool has_illegal_visibility(jint flags);

void verify_constantvalue(int constantvalue_index, int signature_index, constantPoolHandle cp, TRAPS);

void verify_legal_utf8(const unsigned char* buffer, int length, TRAPS);

void verify_legal_class_name(Symbol* name, TRAPS);

void verify_legal_field_name(Symbol* name, TRAPS);

void verify_legal_method_name(Symbol* name, TRAPS);

void verify_legal_field_signature(Symbol* fieldname, Symbol* signature, TRAPS);

int verify_legal_method_signature(Symbol* methodname, Symbol* signature, TRAPS);

void verify_legal_class_modifiers(jint flags, TRAPS);

void verify_legal_field_modifiers(jint flags, bool is_interface, TRAPS);

void verify_legal_method_modifiers(jint flags, bool is_interface, Symbol* name, TRAPS);

bool verify_unqualified_name(char* name, unsigned int length, int type);

char* skip_over_field_name(char* name, bool slash_ok, unsigned int length);

char* skip_over_field_signature(char* signature, bool void_ok, unsigned int length, TRAPS);

bool is_anonymous() {

assert(EnableInvokeDynamic || _host_klass.is_null(), "");

return _host_klass.not_null();

}

bool has_cp_patch_at(int index) {

assert(EnableInvokeDynamic, "");

assert(index >= 0, "oob");

return (_cp_patches != NULL

&& index < _cp_patches->length()

&& _cp_patches->adr_at(index)->not_null());

}

Handle cp_patch_at(int index) {

assert(has_cp_patch_at(index), "oob");

return _cp_patches->at(index);

}

Handle clear_cp_patch_at(int index) {

Handle patch = cp_patch_at(index);

_cp_patches->at_put(index, Handle());

assert(!has_cp_patch_at(index), "");

return patch;

}

void patch_constant_pool(constantPoolHandle cp, int index, Handle patch, TRAPS);

// Wrapper for constantTag.is_klass_[or_]reference.

// In older versions of the VM, klassOops cannot sneak into early phases of

// constant pool construction, but in later versions they can.

// %%% Let's phase out the old is_klass_reference.

bool is_klass_reference(constantPoolHandle cp, int index) {

return ((LinkWellKnownClasses || EnableInvokeDynamic)

? cp->tag_at(index).is_klass_or_reference()

: cp->tag_at(index).is_klass_reference());

}

public:

// Constructor

ClassFileParser(ClassFileStream* st) { set_stream(st); }

// Parse .class file and return new klassOop. The klassOop is not hooked up

// to the system dictionary or any other structures, so a .class file can

// be loaded several times if desired.

// The system dictionary hookup is done by the caller.

//

// "parsed_name" is updated by this method, and is the name found

// while parsing the stream.

instanceKlassHandle parseClassFile(Symbol* name,

Handle class_loader,

Handle protection_domain,

TempNewSymbol& parsed_name,

bool verify,

TRAPS) {

KlassHandle no_host_klass;

return parseClassFile(name, class_loader, protection_domain, no_host_klass, NULL, parsed_name, verify, THREAD);

}

instanceKlassHandle parseClassFile(Symbol* name,

Handle class_loader,

Handle protection_domain,

KlassHandle host_klass,

GrowableArray<Handle>* cp_patches,

TempNewSymbol& parsed_name,

bool verify,

TRAPS);

// Verifier checks

static void check_super_class_access(instanceKlassHandle this_klass, TRAPS);

static void check_super_interface_access(instanceKlassHandle this_klass, TRAPS);

static void check_final_method_override(instanceKlassHandle this_klass, TRAPS);

static void check_illegal_static_method(instanceKlassHandle this_klass, TRAPS);

};

#endif // SHARE_VM_CLASSFILE_CLASSFILEPARSER_HPP