duke@435: /* xdono@905: * Copyright 1997-2008 Sun Microsystems, Inc. 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: * duke@435: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, duke@435: * CA 95054 USA or visit www.sun.com if you need additional information or duke@435: * have any questions. duke@435: * duke@435: */ duke@435: duke@435: // ADLPARSE.HPP - Definitions for Architecture Description Language Parser duke@435: // Authors: Chris Vick and Mike Paleczny duke@435: duke@435: // Class List duke@435: class Form; duke@435: // ***** Top Level, 1, classes ***** duke@435: class InstructForm; duke@435: class OperandForm; duke@435: class OpClassForm; duke@435: class AttributeForm; duke@435: class RegisterForm; duke@435: class PipelineForm; duke@435: class SourceForm; duke@435: class Peephole; duke@435: // ***** Level 2 classes ***** duke@435: class Component; duke@435: class Predicate; duke@435: class MatchRule; duke@435: class Encode; duke@435: class Attribute; duke@435: class Effect; duke@435: class ExpandRule; duke@435: class RewriteRule; duke@435: class Constraint; duke@435: class ConstructRule; duke@435: // ***** Register Section ***** duke@435: class RegDef; duke@435: class RegClass; duke@435: class AllocClass; duke@435: class ResourceForm; duke@435: // ***** Pipeline Section ***** duke@435: class PipeDesc; duke@435: class PipeClass; duke@435: class RegList; duke@435: // ***** Peephole Section ***** duke@435: class PeepMatch; duke@435: class PeepConstraint; duke@435: class PeepReplace; duke@435: duke@435: // class ostream; // ostream is a typedef in some systems duke@435: duke@435: extern char *toUpper(const char *str); duke@435: duke@435: //---------------------------ADLParser----------------------------------------- duke@435: class ADLParser { duke@435: protected: duke@435: char *_curline; // Start of current line duke@435: char *_ptr; // Pointer into current location in File Buffer duke@435: char _curchar; // Current character from buffer duke@435: FormDict &_globalNames; // Global names duke@435: duke@435: enum { _preproc_limit = 20 }; duke@435: int _preproc_depth; // How deep are we into ifdefs? duke@435: int _preproc_not_taken; // How deep in not-taken ifdefs? duke@435: bool _preproc_taken[_preproc_limit]; // Are we taking this ifdef level? duke@435: bool _preproc_else[_preproc_limit]; // Did this level have an else yet? duke@435: duke@435: // ***** Level 1 Parse functions ***** duke@435: void instr_parse(void); // Parse instruction definitions duke@435: void oper_parse(void); // Parse operand definitions duke@435: void opclass_parse(void); // Parse operand class definitions duke@435: void ins_attr_parse(void); // Parse instruction attrubute definitions duke@435: void op_attr_parse(void); // Parse operand attrubute definitions duke@435: void source_parse(void); // Parse source section duke@435: void source_hpp_parse(void); // Parse source_hpp section duke@435: void reg_parse(void); // Parse register section duke@435: void encode_parse(void); // Parse encoding section duke@435: void frame_parse(void); // Parse frame section duke@435: void pipe_parse(void); // Parse pipeline section duke@435: void definitions_parse(void); // Parse definitions section duke@435: void peep_parse(void); // Parse peephole rule definitions jrose@910: void preproc_line(void); // Parse a #line statement duke@435: void preproc_define(void); // Parse a #define statement duke@435: void preproc_undef(void); // Parse an #undef statement duke@435: duke@435: // Helper functions for instr_parse(). duke@435: void adjust_set_rule(InstructForm *instr); duke@435: void matchrule_clone_and_swap(MatchRule *rule, const char* instr_ident, int& match_rules_cnt); duke@435: duke@435: // ***** Level 2 Parse functions ***** duke@435: // Parse the components of the encode section duke@435: void enc_class_parse(void); // Parse encoding class definition duke@435: void enc_class_parse_block(EncClass* encoding, char* ec_name); duke@435: duke@435: // Parse the components of the frame section duke@435: void stack_dir_parse(FrameForm *frame); // Parse the stack direction entry duke@435: void sync_stack_slots_parse(FrameForm *frame); duke@435: void frame_pointer_parse(FrameForm *frame, bool native); duke@435: void interpreter_frame_pointer_parse(FrameForm *frame, bool native); duke@435: void inline_cache_parse(FrameForm *frame, bool native); duke@435: void interpreter_arg_ptr_parse(FrameForm *frame, bool native); duke@435: void interpreter_method_oop_parse(FrameForm *frame, bool native); duke@435: void cisc_spilling_operand_name_parse(FrameForm *frame, bool native); duke@435: void stack_alignment_parse(FrameForm *frame); duke@435: void return_addr_parse(FrameForm *frame, bool native); duke@435: void preserve_stack_parse(FrameForm *frame); duke@435: char *calling_convention_parse(); duke@435: char *return_value_parse(); duke@435: duke@435: // Parse components of the register section duke@435: void reg_def_parse(void); // Parse register definition duke@435: void reg_class_parse(void); // Parse register class definition duke@435: void alloc_class_parse(void); // Parse allocation class definition duke@435: duke@435: // Parse components of the definition section duke@435: void int_def_parse(void); // Parse an integer definition duke@435: duke@435: // Parse components of a pipeline rule duke@435: void resource_parse(PipelineForm &pipe); // Parse resource definition duke@435: void pipe_desc_parse(PipelineForm &pipe); // Parse pipeline description definition duke@435: void pipe_class_parse(PipelineForm &pipe); // Parse pipeline class definition duke@435: duke@435: // Parse components of a peephole rule duke@435: void peep_match_parse(Peephole &peep); // Parse the peephole match rule duke@435: void peep_constraint_parse(Peephole &peep);// Parse the peephole constraints duke@435: void peep_replace_parse(Peephole &peep); // Parse peephole replacement rule duke@435: duke@435: // Parse the peep match rule tree duke@435: InstructForm *peep_match_child_parse(PeepMatch &match, int parent, int &position, int input); duke@435: duke@435: // Parse components of an operand and/or instruction form duke@435: Predicate *pred_parse(void); // Parse predicate rule duke@435: // Parse match rule, and internal nodes duke@435: MatchRule *match_parse(FormDict &operands); duke@435: MatchNode *matchNode_parse(FormDict &operands, int &depth, duke@435: int &numleaves, bool atroot); duke@435: MatchNode *matchChild_parse(FormDict &operands, int &depth, duke@435: int &numleaves, bool atroot); duke@435: duke@435: Attribute *attr_parse(char *ident);// Parse instr/operand attribute rule duke@435: // Parse instruction encode rule duke@435: InsEncode *ins_encode_parse(InstructForm &inst); duke@435: InsEncode *ins_encode_parse_block(InstructForm &inst); duke@435: Opcode *opcode_parse(InstructForm *insr); // Parse instruction opcode duke@435: char *size_parse(InstructForm *insr); // Parse instruction size duke@435: Interface *interface_parse(); // Parse operand interface rule duke@435: Interface *mem_interface_parse(); // Parse memory interface rule duke@435: Interface *cond_interface_parse(); // Parse conditional interface rule never@850: char *interface_field_parse(const char** format = NULL);// Parse field contents duke@435: duke@435: FormatRule *format_parse(void); // Parse format rule never@850: FormatRule *template_parse(void); // Parse format rule duke@435: void effect_parse(InstructForm *instr); // Parse effect rule duke@435: ExpandRule *expand_parse(InstructForm *instr); // Parse expand rule duke@435: RewriteRule *rewrite_parse(void); // Parse rewrite rule duke@435: Constraint *constraint_parse(void); // Parse constraint rule duke@435: ConstructRule *construct_parse(void); // Parse construct rule duke@435: void ins_pipe_parse(InstructForm &instr); // Parse ins_pipe rule duke@435: duke@435: // ***** Preprocessor functions ***** duke@435: void begin_if_def(bool taken) { duke@435: assert(_preproc_depth < _preproc_limit, "#ifdef nesting limit"); duke@435: int ppn = _preproc_depth++; duke@435: _preproc_taken[ppn] = taken; duke@435: // Invariant: _preproc_not_taken = SUM !_preproc_taken[0.._preproc_depth) duke@435: if (!_preproc_taken[ppn]) _preproc_not_taken += 1; duke@435: _preproc_else[ppn] = false; duke@435: } duke@435: void invert_if_def() { duke@435: assert(_preproc_depth > 0, "#ifdef matching"); duke@435: int ppn = _preproc_depth - 1; duke@435: assert(!_preproc_else[ppn], "multiple #else lines"); duke@435: _preproc_else[ppn] = true; duke@435: if (!_preproc_taken[ppn]) _preproc_not_taken -= 1; duke@435: _preproc_taken[ppn] = !_preproc_taken[ppn]; duke@435: if (!_preproc_taken[ppn]) _preproc_not_taken += 1; duke@435: } duke@435: void end_if_def() { duke@435: assert(_preproc_depth > 0, "#ifdef matching"); duke@435: int ppn = --_preproc_depth; duke@435: if (!_preproc_taken[ppn]) _preproc_not_taken -= 1; duke@435: } duke@435: bool preproc_taken() { duke@435: // Return true only if there is no directive hiding this text position. duke@435: return _preproc_not_taken == 0; duke@435: } duke@435: // Handle a '#' token. Return true if it disappeared. duke@435: bool handle_preproc_token(); duke@435: duke@435: // ***** Utility Functions for ADL Parser ****** duke@435: duke@435: // Parse one string argument inside parens: '(' string ')' ';' duke@435: char *parse_one_arg(const char *description); duke@435: duke@435: // Return the next identifier given a pointer into a line of the buffer. duke@435: char *get_ident() { return get_ident_common(true); } duke@435: char *get_ident_no_preproc() { return get_ident_common(false); } duke@435: char *get_ident_common(bool do_preproc); // Grab it from the file buffer duke@435: char *get_ident_dup(void); // Grab a duplicate of the identifier duke@435: char *get_ident_or_literal_constant(const char* description); duke@435: // Grab unique identifier from file buffer duke@435: char *get_unique_ident(FormDict &dict, const char *nameDescription); duke@435: // Return the next replacement variable identifier duke@435: char *get_rep_var_ident(void); duke@435: // Skip first '$' and make a duplicate of the string duke@435: char *get_rep_var_ident_dup(void); duke@435: // Return the next token given as a signed integer. duke@435: int get_int(void); duke@435: // Return the next token, a relational operator { ==, !=, <=, >= } duke@435: char *get_relation_dup(void); duke@435: duke@435: void get_oplist(NameList ¶meters, FormDict &operands);// Parse type-operand pairs duke@435: void get_effectlist(FormDict &effects, FormDict &operands); // Parse effect-operand pairs duke@435: // Return the contents of a parenthesized expression. duke@435: // Requires initial '(' and consumes final ')', which is replaced by '\0'. jrose@910: char *get_paren_expr(const char *description, bool include_location = false); duke@435: // Return expression up to next stop-char, which terminator replaces. duke@435: // Does not require initial '('. Does not consume final stop-char. duke@435: // Final stop-char is left in _curchar, but is also is replaced by '\0'. duke@435: char *get_expr(const char *description, const char *stop_chars); duke@435: char *find_cpp_block(const char *description); // Parse a C++ code block duke@435: // Issue parser error message & go to EOL duke@435: void parse_err(int flag, const char *fmt, ...); jrose@910: // Create a location marker for this file and line. jrose@910: char *get_line_string(int linenum = 0); jrose@910: // Return a location marker which tells the C preprocessor to jrose@910: // forget the previous location marker. (Requires awk postprocessing.) jrose@910: char *end_line_marker() { return (char*)"\n#line 999999\n"; } duke@435: duke@435: // Return pointer to current character duke@435: inline char cur_char(void); duke@435: // Advance to next character, assign this to _curchar duke@435: inline void next_char(void); duke@435: inline void next_char_or_line(void); duke@435: // Advance File Buffer to next line, updating _curline duke@435: inline void next_line(void); duke@435: // Issue an error if we are not at the beginning of a line (exc. whitespace). duke@435: void ensure_start_of_line(void); duke@435: // Issue an error if we are not at the end of a line (exc. whitespace). duke@435: void ensure_end_of_line(void); duke@435: // Skip whitespace, leaving ptr pointing to first non-whitespace character duke@435: // Also handle preprocessor constructs like "#ifdef". duke@435: void skipws() { skipws_common(true); } duke@435: // Skip comments and spaces but not newlines or preprocessor constructs. duke@435: void skipws_no_preproc() { skipws_common(false); } duke@435: void skipws_common(bool do_preproc); duke@435: duke@435: FileBuff &_buf; // File buffer to be parsed duke@435: ArchDesc &_AD; // Architecture Description being built duke@435: duke@435: public: duke@435: duke@435: ADLParser(FileBuff &buf, ArchDesc &archDesc); // Create new ADLParser object duke@435: ~ADLParser(); // Destroy ADLParser object duke@435: duke@435: void parse(void); // Do the parsing & build forms lists duke@435: never@850: int linenum() { return _buf.linenum(); } duke@435: duke@435: static bool is_literal_constant(const char *hex_string); duke@435: static bool is_hex_digit(char digit); duke@435: static bool is_int_token(const char* token, int& intval); jrose@910: static bool equivalent_expressions(const char* str1, const char* str2); duke@435: static void trim(char* &token); // trim leading & trailing spaces duke@435: };