src/share/vm/adlc/adlparse.hpp

Mon, 09 Mar 2009 13:28:46 -0700

author
xdono
date
Mon, 09 Mar 2009 13:28:46 -0700
changeset 1014
0fbdb4381b99
parent 923
569b3b226089
child 1907
c18cbe5936b8
permissions
-rw-r--r--

6814575: Update copyright year
Summary: Update copyright for files that have been modified in 2009, up to 03/09
Reviewed-by: katleman, tbell, ohair

duke@435 1 /*
xdono@1014 2 * Copyright 1997-2009 Sun Microsystems, Inc. All Rights Reserved.
duke@435 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@435 4 *
duke@435 5 * This code is free software; you can redistribute it and/or modify it
duke@435 6 * under the terms of the GNU General Public License version 2 only, as
duke@435 7 * published by the Free Software Foundation.
duke@435 8 *
duke@435 9 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@435 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@435 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@435 12 * version 2 for more details (a copy is included in the LICENSE file that
duke@435 13 * accompanied this code).
duke@435 14 *
duke@435 15 * You should have received a copy of the GNU General Public License version
duke@435 16 * 2 along with this work; if not, write to the Free Software Foundation,
duke@435 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@435 18 *
duke@435 19 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@435 20 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@435 21 * have any questions.
duke@435 22 *
duke@435 23 */
duke@435 24
duke@435 25 // ADLPARSE.HPP - Definitions for Architecture Description Language Parser
duke@435 26 // Authors: Chris Vick and Mike Paleczny
duke@435 27
duke@435 28 // Class List
duke@435 29 class Form;
duke@435 30 // ***** Top Level, 1, classes *****
duke@435 31 class InstructForm;
duke@435 32 class OperandForm;
duke@435 33 class OpClassForm;
duke@435 34 class AttributeForm;
duke@435 35 class RegisterForm;
duke@435 36 class PipelineForm;
duke@435 37 class SourceForm;
duke@435 38 class Peephole;
duke@435 39 // ***** Level 2 classes *****
duke@435 40 class Component;
duke@435 41 class Predicate;
duke@435 42 class MatchRule;
duke@435 43 class Encode;
duke@435 44 class Attribute;
duke@435 45 class Effect;
duke@435 46 class ExpandRule;
duke@435 47 class RewriteRule;
duke@435 48 class Constraint;
duke@435 49 class ConstructRule;
duke@435 50 // ***** Register Section *****
duke@435 51 class RegDef;
duke@435 52 class RegClass;
duke@435 53 class AllocClass;
duke@435 54 class ResourceForm;
duke@435 55 // ***** Pipeline Section *****
duke@435 56 class PipeDesc;
duke@435 57 class PipeClass;
duke@435 58 class RegList;
duke@435 59 // ***** Peephole Section *****
duke@435 60 class PeepMatch;
duke@435 61 class PeepConstraint;
duke@435 62 class PeepReplace;
duke@435 63
duke@435 64 // class ostream; // ostream is a typedef in some systems
duke@435 65
duke@435 66 extern char *toUpper(const char *str);
duke@435 67
duke@435 68 //---------------------------ADLParser-----------------------------------------
duke@435 69 class ADLParser {
duke@435 70 protected:
duke@435 71 char *_curline; // Start of current line
duke@435 72 char *_ptr; // Pointer into current location in File Buffer
duke@435 73 char _curchar; // Current character from buffer
duke@435 74 FormDict &_globalNames; // Global names
duke@435 75
duke@435 76 enum { _preproc_limit = 20 };
duke@435 77 int _preproc_depth; // How deep are we into ifdefs?
duke@435 78 int _preproc_not_taken; // How deep in not-taken ifdefs?
duke@435 79 bool _preproc_taken[_preproc_limit]; // Are we taking this ifdef level?
duke@435 80 bool _preproc_else[_preproc_limit]; // Did this level have an else yet?
duke@435 81
duke@435 82 // ***** Level 1 Parse functions *****
duke@435 83 void instr_parse(void); // Parse instruction definitions
duke@435 84 void oper_parse(void); // Parse operand definitions
duke@435 85 void opclass_parse(void); // Parse operand class definitions
duke@435 86 void ins_attr_parse(void); // Parse instruction attrubute definitions
duke@435 87 void op_attr_parse(void); // Parse operand attrubute definitions
duke@435 88 void source_parse(void); // Parse source section
duke@435 89 void source_hpp_parse(void); // Parse source_hpp section
duke@435 90 void reg_parse(void); // Parse register section
duke@435 91 void encode_parse(void); // Parse encoding section
duke@435 92 void frame_parse(void); // Parse frame section
duke@435 93 void pipe_parse(void); // Parse pipeline section
duke@435 94 void definitions_parse(void); // Parse definitions section
duke@435 95 void peep_parse(void); // Parse peephole rule definitions
jrose@910 96 void preproc_line(void); // Parse a #line statement
duke@435 97 void preproc_define(void); // Parse a #define statement
duke@435 98 void preproc_undef(void); // Parse an #undef statement
duke@435 99
duke@435 100 // Helper functions for instr_parse().
duke@435 101 void adjust_set_rule(InstructForm *instr);
duke@435 102 void matchrule_clone_and_swap(MatchRule *rule, const char* instr_ident, int& match_rules_cnt);
duke@435 103
duke@435 104 // ***** Level 2 Parse functions *****
duke@435 105 // Parse the components of the encode section
duke@435 106 void enc_class_parse(void); // Parse encoding class definition
duke@435 107 void enc_class_parse_block(EncClass* encoding, char* ec_name);
duke@435 108
duke@435 109 // Parse the components of the frame section
duke@435 110 void stack_dir_parse(FrameForm *frame); // Parse the stack direction entry
duke@435 111 void sync_stack_slots_parse(FrameForm *frame);
duke@435 112 void frame_pointer_parse(FrameForm *frame, bool native);
duke@435 113 void interpreter_frame_pointer_parse(FrameForm *frame, bool native);
duke@435 114 void inline_cache_parse(FrameForm *frame, bool native);
duke@435 115 void interpreter_arg_ptr_parse(FrameForm *frame, bool native);
duke@435 116 void interpreter_method_oop_parse(FrameForm *frame, bool native);
duke@435 117 void cisc_spilling_operand_name_parse(FrameForm *frame, bool native);
duke@435 118 void stack_alignment_parse(FrameForm *frame);
duke@435 119 void return_addr_parse(FrameForm *frame, bool native);
duke@435 120 void preserve_stack_parse(FrameForm *frame);
duke@435 121 char *calling_convention_parse();
duke@435 122 char *return_value_parse();
duke@435 123
duke@435 124 // Parse components of the register section
duke@435 125 void reg_def_parse(void); // Parse register definition
duke@435 126 void reg_class_parse(void); // Parse register class definition
duke@435 127 void alloc_class_parse(void); // Parse allocation class definition
duke@435 128
duke@435 129 // Parse components of the definition section
duke@435 130 void int_def_parse(void); // Parse an integer definition
duke@435 131
duke@435 132 // Parse components of a pipeline rule
duke@435 133 void resource_parse(PipelineForm &pipe); // Parse resource definition
duke@435 134 void pipe_desc_parse(PipelineForm &pipe); // Parse pipeline description definition
duke@435 135 void pipe_class_parse(PipelineForm &pipe); // Parse pipeline class definition
duke@435 136
duke@435 137 // Parse components of a peephole rule
duke@435 138 void peep_match_parse(Peephole &peep); // Parse the peephole match rule
duke@435 139 void peep_constraint_parse(Peephole &peep);// Parse the peephole constraints
duke@435 140 void peep_replace_parse(Peephole &peep); // Parse peephole replacement rule
duke@435 141
duke@435 142 // Parse the peep match rule tree
duke@435 143 InstructForm *peep_match_child_parse(PeepMatch &match, int parent, int &position, int input);
duke@435 144
duke@435 145 // Parse components of an operand and/or instruction form
duke@435 146 Predicate *pred_parse(void); // Parse predicate rule
duke@435 147 // Parse match rule, and internal nodes
duke@435 148 MatchRule *match_parse(FormDict &operands);
duke@435 149 MatchNode *matchNode_parse(FormDict &operands, int &depth,
duke@435 150 int &numleaves, bool atroot);
duke@435 151 MatchNode *matchChild_parse(FormDict &operands, int &depth,
duke@435 152 int &numleaves, bool atroot);
duke@435 153
duke@435 154 Attribute *attr_parse(char *ident);// Parse instr/operand attribute rule
duke@435 155 // Parse instruction encode rule
duke@435 156 InsEncode *ins_encode_parse(InstructForm &inst);
duke@435 157 InsEncode *ins_encode_parse_block(InstructForm &inst);
duke@435 158 Opcode *opcode_parse(InstructForm *insr); // Parse instruction opcode
duke@435 159 char *size_parse(InstructForm *insr); // Parse instruction size
duke@435 160 Interface *interface_parse(); // Parse operand interface rule
duke@435 161 Interface *mem_interface_parse(); // Parse memory interface rule
duke@435 162 Interface *cond_interface_parse(); // Parse conditional interface rule
never@850 163 char *interface_field_parse(const char** format = NULL);// Parse field contents
duke@435 164
duke@435 165 FormatRule *format_parse(void); // Parse format rule
never@850 166 FormatRule *template_parse(void); // Parse format rule
duke@435 167 void effect_parse(InstructForm *instr); // Parse effect rule
duke@435 168 ExpandRule *expand_parse(InstructForm *instr); // Parse expand rule
duke@435 169 RewriteRule *rewrite_parse(void); // Parse rewrite rule
duke@435 170 Constraint *constraint_parse(void); // Parse constraint rule
duke@435 171 ConstructRule *construct_parse(void); // Parse construct rule
duke@435 172 void ins_pipe_parse(InstructForm &instr); // Parse ins_pipe rule
duke@435 173
duke@435 174 // ***** Preprocessor functions *****
duke@435 175 void begin_if_def(bool taken) {
duke@435 176 assert(_preproc_depth < _preproc_limit, "#ifdef nesting limit");
duke@435 177 int ppn = _preproc_depth++;
duke@435 178 _preproc_taken[ppn] = taken;
duke@435 179 // Invariant: _preproc_not_taken = SUM !_preproc_taken[0.._preproc_depth)
duke@435 180 if (!_preproc_taken[ppn]) _preproc_not_taken += 1;
duke@435 181 _preproc_else[ppn] = false;
duke@435 182 }
duke@435 183 void invert_if_def() {
duke@435 184 assert(_preproc_depth > 0, "#ifdef matching");
duke@435 185 int ppn = _preproc_depth - 1;
duke@435 186 assert(!_preproc_else[ppn], "multiple #else lines");
duke@435 187 _preproc_else[ppn] = true;
duke@435 188 if (!_preproc_taken[ppn]) _preproc_not_taken -= 1;
duke@435 189 _preproc_taken[ppn] = !_preproc_taken[ppn];
duke@435 190 if (!_preproc_taken[ppn]) _preproc_not_taken += 1;
duke@435 191 }
duke@435 192 void end_if_def() {
duke@435 193 assert(_preproc_depth > 0, "#ifdef matching");
duke@435 194 int ppn = --_preproc_depth;
duke@435 195 if (!_preproc_taken[ppn]) _preproc_not_taken -= 1;
duke@435 196 }
duke@435 197 bool preproc_taken() {
duke@435 198 // Return true only if there is no directive hiding this text position.
duke@435 199 return _preproc_not_taken == 0;
duke@435 200 }
duke@435 201 // Handle a '#' token. Return true if it disappeared.
duke@435 202 bool handle_preproc_token();
duke@435 203
duke@435 204 // ***** Utility Functions for ADL Parser ******
duke@435 205
duke@435 206 // Parse one string argument inside parens: '(' string ')' ';'
duke@435 207 char *parse_one_arg(const char *description);
duke@435 208
duke@435 209 // Return the next identifier given a pointer into a line of the buffer.
duke@435 210 char *get_ident() { return get_ident_common(true); }
duke@435 211 char *get_ident_no_preproc() { return get_ident_common(false); }
duke@435 212 char *get_ident_common(bool do_preproc); // Grab it from the file buffer
duke@435 213 char *get_ident_dup(void); // Grab a duplicate of the identifier
duke@435 214 char *get_ident_or_literal_constant(const char* description);
duke@435 215 // Grab unique identifier from file buffer
duke@435 216 char *get_unique_ident(FormDict &dict, const char *nameDescription);
duke@435 217 // Return the next replacement variable identifier
duke@435 218 char *get_rep_var_ident(void);
duke@435 219 // Skip first '$' and make a duplicate of the string
duke@435 220 char *get_rep_var_ident_dup(void);
duke@435 221 // Return the next token given as a signed integer.
duke@435 222 int get_int(void);
duke@435 223 // Return the next token, a relational operator { ==, !=, <=, >= }
duke@435 224 char *get_relation_dup(void);
duke@435 225
duke@435 226 void get_oplist(NameList &parameters, FormDict &operands);// Parse type-operand pairs
duke@435 227 void get_effectlist(FormDict &effects, FormDict &operands); // Parse effect-operand pairs
duke@435 228 // Return the contents of a parenthesized expression.
duke@435 229 // Requires initial '(' and consumes final ')', which is replaced by '\0'.
jrose@910 230 char *get_paren_expr(const char *description, bool include_location = false);
duke@435 231 // Return expression up to next stop-char, which terminator replaces.
duke@435 232 // Does not require initial '('. Does not consume final stop-char.
duke@435 233 // Final stop-char is left in _curchar, but is also is replaced by '\0'.
duke@435 234 char *get_expr(const char *description, const char *stop_chars);
duke@435 235 char *find_cpp_block(const char *description); // Parse a C++ code block
duke@435 236 // Issue parser error message & go to EOL
duke@435 237 void parse_err(int flag, const char *fmt, ...);
jrose@910 238 // Create a location marker for this file and line.
jrose@910 239 char *get_line_string(int linenum = 0);
jrose@910 240 // Return a location marker which tells the C preprocessor to
jrose@910 241 // forget the previous location marker. (Requires awk postprocessing.)
jrose@910 242 char *end_line_marker() { return (char*)"\n#line 999999\n"; }
duke@435 243
duke@435 244 // Return pointer to current character
duke@435 245 inline char cur_char(void);
duke@435 246 // Advance to next character, assign this to _curchar
duke@435 247 inline void next_char(void);
duke@435 248 inline void next_char_or_line(void);
duke@435 249 // Advance File Buffer to next line, updating _curline
duke@435 250 inline void next_line(void);
duke@435 251 // Issue an error if we are not at the beginning of a line (exc. whitespace).
duke@435 252 void ensure_start_of_line(void);
duke@435 253 // Issue an error if we are not at the end of a line (exc. whitespace).
duke@435 254 void ensure_end_of_line(void);
duke@435 255 // Skip whitespace, leaving ptr pointing to first non-whitespace character
duke@435 256 // Also handle preprocessor constructs like "#ifdef".
duke@435 257 void skipws() { skipws_common(true); }
duke@435 258 // Skip comments and spaces but not newlines or preprocessor constructs.
duke@435 259 void skipws_no_preproc() { skipws_common(false); }
duke@435 260 void skipws_common(bool do_preproc);
duke@435 261
duke@435 262 FileBuff &_buf; // File buffer to be parsed
duke@435 263 ArchDesc &_AD; // Architecture Description being built
duke@435 264
duke@435 265 public:
duke@435 266
duke@435 267 ADLParser(FileBuff &buf, ArchDesc &archDesc); // Create new ADLParser object
duke@435 268 ~ADLParser(); // Destroy ADLParser object
duke@435 269
duke@435 270 void parse(void); // Do the parsing & build forms lists
duke@435 271
never@850 272 int linenum() { return _buf.linenum(); }
duke@435 273
duke@435 274 static bool is_literal_constant(const char *hex_string);
duke@435 275 static bool is_hex_digit(char digit);
duke@435 276 static bool is_int_token(const char* token, int& intval);
jrose@910 277 static bool equivalent_expressions(const char* str1, const char* str2);
duke@435 278 static void trim(char* &token); // trim leading & trailing spaces
duke@435 279 };

mercurial