1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/src/share/vm/adlc/adlparse.hpp Sat Dec 01 00:00:00 2007 +0000 1.3 @@ -0,0 +1,272 @@ 1.4 +/* 1.5 + * Copyright 1997-2007 Sun Microsystems, Inc. All Rights Reserved. 1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 1.7 + * 1.8 + * This code is free software; you can redistribute it and/or modify it 1.9 + * under the terms of the GNU General Public License version 2 only, as 1.10 + * published by the Free Software Foundation. 1.11 + * 1.12 + * This code is distributed in the hope that it will be useful, but WITHOUT 1.13 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1.14 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1.15 + * version 2 for more details (a copy is included in the LICENSE file that 1.16 + * accompanied this code). 1.17 + * 1.18 + * You should have received a copy of the GNU General Public License version 1.19 + * 2 along with this work; if not, write to the Free Software Foundation, 1.20 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 1.21 + * 1.22 + * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, 1.23 + * CA 95054 USA or visit www.sun.com if you need additional information or 1.24 + * have any questions. 1.25 + * 1.26 + */ 1.27 + 1.28 +// ADLPARSE.HPP - Definitions for Architecture Description Language Parser 1.29 +// Authors: Chris Vick and Mike Paleczny 1.30 + 1.31 +// Class List 1.32 +class Form; 1.33 +// ***** Top Level, 1, classes ***** 1.34 +class InstructForm; 1.35 +class OperandForm; 1.36 +class OpClassForm; 1.37 +class AttributeForm; 1.38 +class RegisterForm; 1.39 +class PipelineForm; 1.40 +class SourceForm; 1.41 +class Peephole; 1.42 +// ***** Level 2 classes ***** 1.43 +class Component; 1.44 +class Predicate; 1.45 +class MatchRule; 1.46 +class Encode; 1.47 +class Attribute; 1.48 +class Effect; 1.49 +class ExpandRule; 1.50 +class RewriteRule; 1.51 +class Constraint; 1.52 +class ConstructRule; 1.53 +// ***** Register Section ***** 1.54 +class RegDef; 1.55 +class RegClass; 1.56 +class AllocClass; 1.57 +class ResourceForm; 1.58 +// ***** Pipeline Section ***** 1.59 +class PipeDesc; 1.60 +class PipeClass; 1.61 +class RegList; 1.62 +// ***** Peephole Section ***** 1.63 +class PeepMatch; 1.64 +class PeepConstraint; 1.65 +class PeepReplace; 1.66 + 1.67 +// class ostream; // ostream is a typedef in some systems 1.68 + 1.69 +extern char *toUpper(const char *str); 1.70 + 1.71 +//---------------------------ADLParser----------------------------------------- 1.72 +class ADLParser { 1.73 +protected: 1.74 + char *_curline; // Start of current line 1.75 + char *_ptr; // Pointer into current location in File Buffer 1.76 + int _linenum; // Count of line numbers seen so far 1.77 + char _curchar; // Current character from buffer 1.78 + FormDict &_globalNames; // Global names 1.79 + 1.80 + enum { _preproc_limit = 20 }; 1.81 + int _preproc_depth; // How deep are we into ifdefs? 1.82 + int _preproc_not_taken; // How deep in not-taken ifdefs? 1.83 + bool _preproc_taken[_preproc_limit]; // Are we taking this ifdef level? 1.84 + bool _preproc_else[_preproc_limit]; // Did this level have an else yet? 1.85 + 1.86 + // ***** Level 1 Parse functions ***** 1.87 + void instr_parse(void); // Parse instruction definitions 1.88 + void oper_parse(void); // Parse operand definitions 1.89 + void opclass_parse(void); // Parse operand class definitions 1.90 + void ins_attr_parse(void); // Parse instruction attrubute definitions 1.91 + void op_attr_parse(void); // Parse operand attrubute definitions 1.92 + void source_parse(void); // Parse source section 1.93 + void source_hpp_parse(void); // Parse source_hpp section 1.94 + void reg_parse(void); // Parse register section 1.95 + void encode_parse(void); // Parse encoding section 1.96 + void frame_parse(void); // Parse frame section 1.97 + void pipe_parse(void); // Parse pipeline section 1.98 + void definitions_parse(void); // Parse definitions section 1.99 + void peep_parse(void); // Parse peephole rule definitions 1.100 + void preproc_define(void); // Parse a #define statement 1.101 + void preproc_undef(void); // Parse an #undef statement 1.102 + 1.103 + // Helper functions for instr_parse(). 1.104 + void adjust_set_rule(InstructForm *instr); 1.105 + void matchrule_clone_and_swap(MatchRule *rule, const char* instr_ident, int& match_rules_cnt); 1.106 + 1.107 + // ***** Level 2 Parse functions ***** 1.108 + // Parse the components of the encode section 1.109 + void enc_class_parse(void); // Parse encoding class definition 1.110 + void enc_class_parse_block(EncClass* encoding, char* ec_name); 1.111 + 1.112 + // Parse the components of the frame section 1.113 + void stack_dir_parse(FrameForm *frame); // Parse the stack direction entry 1.114 + void sync_stack_slots_parse(FrameForm *frame); 1.115 + void frame_pointer_parse(FrameForm *frame, bool native); 1.116 + void interpreter_frame_pointer_parse(FrameForm *frame, bool native); 1.117 + void inline_cache_parse(FrameForm *frame, bool native); 1.118 + void interpreter_arg_ptr_parse(FrameForm *frame, bool native); 1.119 + void interpreter_method_oop_parse(FrameForm *frame, bool native); 1.120 + void cisc_spilling_operand_name_parse(FrameForm *frame, bool native); 1.121 + void stack_alignment_parse(FrameForm *frame); 1.122 + void return_addr_parse(FrameForm *frame, bool native); 1.123 + void preserve_stack_parse(FrameForm *frame); 1.124 + char *calling_convention_parse(); 1.125 + char *return_value_parse(); 1.126 + 1.127 + // Parse components of the register section 1.128 + void reg_def_parse(void); // Parse register definition 1.129 + void reg_class_parse(void); // Parse register class definition 1.130 + void alloc_class_parse(void); // Parse allocation class definition 1.131 + 1.132 + // Parse components of the definition section 1.133 + void int_def_parse(void); // Parse an integer definition 1.134 + 1.135 + // Parse components of a pipeline rule 1.136 + void resource_parse(PipelineForm &pipe); // Parse resource definition 1.137 + void pipe_desc_parse(PipelineForm &pipe); // Parse pipeline description definition 1.138 + void pipe_class_parse(PipelineForm &pipe); // Parse pipeline class definition 1.139 + 1.140 + // Parse components of a peephole rule 1.141 + void peep_match_parse(Peephole &peep); // Parse the peephole match rule 1.142 + void peep_constraint_parse(Peephole &peep);// Parse the peephole constraints 1.143 + void peep_replace_parse(Peephole &peep); // Parse peephole replacement rule 1.144 + 1.145 + // Parse the peep match rule tree 1.146 + InstructForm *peep_match_child_parse(PeepMatch &match, int parent, int &position, int input); 1.147 + 1.148 + // Parse components of an operand and/or instruction form 1.149 + Predicate *pred_parse(void); // Parse predicate rule 1.150 + // Parse match rule, and internal nodes 1.151 + MatchRule *match_parse(FormDict &operands); 1.152 + MatchNode *matchNode_parse(FormDict &operands, int &depth, 1.153 + int &numleaves, bool atroot); 1.154 + MatchNode *matchChild_parse(FormDict &operands, int &depth, 1.155 + int &numleaves, bool atroot); 1.156 + 1.157 + Attribute *attr_parse(char *ident);// Parse instr/operand attribute rule 1.158 + // Parse instruction encode rule 1.159 + InsEncode *ins_encode_parse(InstructForm &inst); 1.160 + InsEncode *ins_encode_parse_block(InstructForm &inst); 1.161 + Opcode *opcode_parse(InstructForm *insr); // Parse instruction opcode 1.162 + char *size_parse(InstructForm *insr); // Parse instruction size 1.163 + Interface *interface_parse(); // Parse operand interface rule 1.164 + Interface *mem_interface_parse(); // Parse memory interface rule 1.165 + Interface *cond_interface_parse(); // Parse conditional interface rule 1.166 + char *interface_field_parse();// Parse field contents 1.167 + 1.168 + FormatRule *format_parse(void); // Parse format rule 1.169 + void effect_parse(InstructForm *instr); // Parse effect rule 1.170 + ExpandRule *expand_parse(InstructForm *instr); // Parse expand rule 1.171 + RewriteRule *rewrite_parse(void); // Parse rewrite rule 1.172 + Constraint *constraint_parse(void); // Parse constraint rule 1.173 + ConstructRule *construct_parse(void); // Parse construct rule 1.174 + void ins_pipe_parse(InstructForm &instr); // Parse ins_pipe rule 1.175 + 1.176 + // ***** Preprocessor functions ***** 1.177 + void begin_if_def(bool taken) { 1.178 + assert(_preproc_depth < _preproc_limit, "#ifdef nesting limit"); 1.179 + int ppn = _preproc_depth++; 1.180 + _preproc_taken[ppn] = taken; 1.181 + // Invariant: _preproc_not_taken = SUM !_preproc_taken[0.._preproc_depth) 1.182 + if (!_preproc_taken[ppn]) _preproc_not_taken += 1; 1.183 + _preproc_else[ppn] = false; 1.184 + } 1.185 + void invert_if_def() { 1.186 + assert(_preproc_depth > 0, "#ifdef matching"); 1.187 + int ppn = _preproc_depth - 1; 1.188 + assert(!_preproc_else[ppn], "multiple #else lines"); 1.189 + _preproc_else[ppn] = true; 1.190 + if (!_preproc_taken[ppn]) _preproc_not_taken -= 1; 1.191 + _preproc_taken[ppn] = !_preproc_taken[ppn]; 1.192 + if (!_preproc_taken[ppn]) _preproc_not_taken += 1; 1.193 + } 1.194 + void end_if_def() { 1.195 + assert(_preproc_depth > 0, "#ifdef matching"); 1.196 + int ppn = --_preproc_depth; 1.197 + if (!_preproc_taken[ppn]) _preproc_not_taken -= 1; 1.198 + } 1.199 + bool preproc_taken() { 1.200 + // Return true only if there is no directive hiding this text position. 1.201 + return _preproc_not_taken == 0; 1.202 + } 1.203 + // Handle a '#' token. Return true if it disappeared. 1.204 + bool handle_preproc_token(); 1.205 + 1.206 + // ***** Utility Functions for ADL Parser ****** 1.207 + 1.208 + // Parse one string argument inside parens: '(' string ')' ';' 1.209 + char *parse_one_arg(const char *description); 1.210 + 1.211 + // Return the next identifier given a pointer into a line of the buffer. 1.212 + char *get_ident() { return get_ident_common(true); } 1.213 + char *get_ident_no_preproc() { return get_ident_common(false); } 1.214 + char *get_ident_common(bool do_preproc); // Grab it from the file buffer 1.215 + char *get_ident_dup(void); // Grab a duplicate of the identifier 1.216 + char *get_ident_or_literal_constant(const char* description); 1.217 + // Grab unique identifier from file buffer 1.218 + char *get_unique_ident(FormDict &dict, const char *nameDescription); 1.219 + // Return the next replacement variable identifier 1.220 + char *get_rep_var_ident(void); 1.221 + // Skip first '$' and make a duplicate of the string 1.222 + char *get_rep_var_ident_dup(void); 1.223 + // Return the next token given as a signed integer. 1.224 + int get_int(void); 1.225 + // Return the next token, a relational operator { ==, !=, <=, >= } 1.226 + char *get_relation_dup(void); 1.227 + 1.228 + void get_oplist(NameList ¶meters, FormDict &operands);// Parse type-operand pairs 1.229 + void get_effectlist(FormDict &effects, FormDict &operands); // Parse effect-operand pairs 1.230 + // Return the contents of a parenthesized expression. 1.231 + // Requires initial '(' and consumes final ')', which is replaced by '\0'. 1.232 + char *get_paren_expr(const char *description); 1.233 + // Return expression up to next stop-char, which terminator replaces. 1.234 + // Does not require initial '('. Does not consume final stop-char. 1.235 + // Final stop-char is left in _curchar, but is also is replaced by '\0'. 1.236 + char *get_expr(const char *description, const char *stop_chars); 1.237 + char *find_cpp_block(const char *description); // Parse a C++ code block 1.238 + // Issue parser error message & go to EOL 1.239 + void parse_err(int flag, const char *fmt, ...); 1.240 + 1.241 + // Return pointer to current character 1.242 + inline char cur_char(void); 1.243 + // Advance to next character, assign this to _curchar 1.244 + inline void next_char(void); 1.245 + inline void next_char_or_line(void); 1.246 + // Advance File Buffer to next line, updating _curline 1.247 + inline void next_line(void); 1.248 + // Issue an error if we are not at the beginning of a line (exc. whitespace). 1.249 + void ensure_start_of_line(void); 1.250 + // Issue an error if we are not at the end of a line (exc. whitespace). 1.251 + void ensure_end_of_line(void); 1.252 + // Skip whitespace, leaving ptr pointing to first non-whitespace character 1.253 + // Also handle preprocessor constructs like "#ifdef". 1.254 + void skipws() { skipws_common(true); } 1.255 + // Skip comments and spaces but not newlines or preprocessor constructs. 1.256 + void skipws_no_preproc() { skipws_common(false); } 1.257 + void skipws_common(bool do_preproc); 1.258 + 1.259 + FileBuff &_buf; // File buffer to be parsed 1.260 + ArchDesc &_AD; // Architecture Description being built 1.261 + 1.262 +public: 1.263 + 1.264 + ADLParser(FileBuff &buf, ArchDesc &archDesc); // Create new ADLParser object 1.265 + ~ADLParser(); // Destroy ADLParser object 1.266 + 1.267 + void parse(void); // Do the parsing & build forms lists 1.268 + 1.269 + int getlines( ) { return _linenum; } 1.270 + 1.271 + static bool is_literal_constant(const char *hex_string); 1.272 + static bool is_hex_digit(char digit); 1.273 + static bool is_int_token(const char* token, int& intval); 1.274 + static void trim(char* &token); // trim leading & trailing spaces 1.275 +};