1 /*
2 * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #ifndef SHARE_VM_ADLC_ARCHDESC_HPP
26 #define SHARE_VM_ADLC_ARCHDESC_HPP
27
28 // Definitions for Error Flags
29 #define WARN 0
30 #define SYNERR 1
31 #define SEMERR 2
32 #define INTERNAL_ERR 3
33
34 // Minimal declarations for include files
35 class OutputMap;
36 class ProductionState;
37 class Expr;
38
39 // STRUCTURE FOR HANDLING INPUT AND OUTPUT FILES
40 typedef BufferedFile ADLFILE;
41
42 //---------------------------ChainList-----------------------------------------
43 class ChainList {
44 NameList _name;
45 NameList _cost;
46 NameList _rule;
47
48 public:
49 void insert(const char *name, const char *cost, const char *rule);
50 bool search(const char *name);
51
52 void reset();
53 bool iter(const char * &name, const char * &cost, const char * &rule);
54
55 void dump();
56 void output(FILE *fp);
57
58 ChainList();
59 ~ChainList();
60 };
61
62 //---------------------------MatchList-----------------------------------------
63 class MatchList {
64 private:
65 MatchList *_next;
66 Predicate *_pred; // Predicate which applies to this match rule
67 const char *_cost;
68
69 public:
70 const char *_opcode;
71 const char *_resultStr;
72 const char *_lchild;
73 const char *_rchild;
74
75 MatchList(MatchList *nxt, Predicate *prd): _next(nxt), _pred(prd), _cost(NULL){
76 _resultStr = _lchild = _rchild = _opcode = NULL; }
77
78 MatchList(MatchList *nxt, Predicate *prd, const char *cost,
79 const char *opcode, const char *resultStr, const char *lchild,
80 const char *rchild)
81 : _next(nxt), _pred(prd), _cost(cost), _opcode(opcode),
82 _resultStr(resultStr), _lchild(lchild), _rchild(rchild) { }
83
84 MatchList *get_next(void) { return _next; }
85 char *get_pred(void) { return (_pred?_pred->_pred:NULL); }
86 Predicate *get_pred_obj(void) { return _pred; }
87 const char *get_cost(void) { return _cost == NULL ? "0" :_cost; }
88 bool search(const char *opc, const char *res, const char *lch,
89 const char *rch, Predicate *pr);
90
91 void dump();
92 void output(FILE *fp);
93 };
94
95 //---------------------------ArchDesc------------------------------------------
96 class ArchDesc {
97 private:
98 FormDict _globalNames; // Global names
99 Dict _idealIndex; // Map ideal names to index in enumeration
100 ExprDict _globalDefs; // Global definitions, #defines
101 int _internalOpCounter; // Internal Operand Counter
102
103 FormList _header; // List of Source Code Forms for hpp file
104 FormList _pre_header; // ditto for the very top of the hpp file
105 FormList _source; // List of Source Code Forms for output
106 FormList _instructions; // List of Instruction Forms for output
107 FormList _machnodes; // List of Node Classes (special for pipelining)
108 FormList _operands; // List of Operand Forms for output
109 FormList _opclass; // List of Operand Class Forms for output
110 FormList _attributes; // List of Attribute Forms for parsing
111 RegisterForm *_register; // Only one Register Form allowed
112 FrameForm *_frame; // Describe stack-frame layout
113 EncodeForm *_encode; // Only one Encode Form allowed
114 PipelineForm *_pipeline; // Pipeline Form for output
115
116 bool _has_match_rule[_last_opcode]; // found AD rule for ideal node in <arch>.ad
117
118 MatchList *_mlistab[_last_opcode]; // Array of MatchLists
119
120 // The Architecture Description identifies which user-defined operand can be used
121 // to access [stack_pointer + offset]
122 OperandForm *_cisc_spill_operand;
123
124 // Methods for outputting the DFA
125 void gen_match(FILE *fp, MatchList &mlist, ProductionState &status, Dict &operands_chained_from);
126 void chain_rule(FILE *fp, const char *indent, const char *ideal,
127 const Expr *icost, const char *irule,
128 Dict &operands_chained_from, ProductionState &status);
129 void chain_rule_c(FILE *fp, char *indent, char *ideal, char *irule); // %%%%% TODO: remove this
130 void expand_opclass(FILE *fp, const char *indent, const Expr *cost,
131 const char *result_type, ProductionState &status);
132 Expr *calc_cost(FILE *fp, const char *spaces, MatchList &mList, ProductionState &status);
133 void prune_matchlist(Dict &minimize, MatchList &mlist);
134
135 // Helper function that outputs code to generate an instruction in MachNodeGenerator
136 void buildMachNode(FILE *fp_cpp, InstructForm *inst, const char *indent);
137
138 public:
139 ArchDesc();
140 ~ArchDesc();
141
142 // Option flags which control miscellaneous behaviors throughout the code
143 int _TotalLines; // Line Counter
144 int _no_output; // Flag to disable output of DFA, etc.
145 int _quiet_mode; // Do not output banner messages, etc.
146 int _disable_warnings; // Do not output warning messages
147 int _dfa_debug; // Debug Flag for generated DFA
148 int _dfa_small; // Debug Flag for generated DFA
149 int _adl_debug; // Debug Flag for ADLC
150 int _adlocation_debug; // Debug Flag to use ad file locations
151 bool _cisc_spill_debug; // Debug Flag to see cisc-spill-instructions
152 bool _short_branch_debug; // Debug Flag to see short branch instructions
153
154 // Error/Warning Counts
155 int _syntax_errs; // Count of syntax errors
156 int _semantic_errs; // Count of semantic errors
157 int _warnings; // Count warnings
158 int _internal_errs; // Count of internal errors
159
160 // Accessor for private data.
161 void has_match_rule(int opc, const bool b) { _has_match_rule[opc] = b; }
162
163 // I/O Files
164 ADLFILE _ADL_file; // Input Architecture Description File
165 // Machine dependent files, built from architecture definition
166 ADLFILE _DFA_file; // File for definition of Matcher::DFA
167 ADLFILE _HPP_file; // File for ArchNode class declarations
168 ADLFILE _CPP_file; // File for ArchNode class defintions
169 ADLFILE _CPP_CLONE_file; // File for MachNode/Oper clone defintions
170 ADLFILE _CPP_EXPAND_file; // File for MachNode expand methods
171 ADLFILE _CPP_FORMAT_file; // File for MachNode/Oper format defintions
172 ADLFILE _CPP_GEN_file; // File for MachNode/Oper generator methods
173 ADLFILE _CPP_MISC_file; // File for miscellaneous MachNode/Oper tables & methods
174 ADLFILE _CPP_PEEPHOLE_file; // File for MachNode peephole methods
175 ADLFILE _CPP_PIPELINE_file; // File for MachNode pipeline defintions
176 ADLFILE _VM_file; // File for constants needed in VM code
177 ADLFILE _bug_file; // DFA debugging file
178
179 // I/O helper methods
180 int open_file(bool required, ADLFILE & adf, const char *action);
181 void close_file(int delete_out, ADLFILE & adf);
182 int open_files(void);
183 void close_files(int delete_out);
184
185 Dict _chainRules; // Maps user operand names to ChainRules
186 Dict _internalOps; // Maps match strings to internal operand names
187 NameList _internalOpNames; // List internal operand names
188 Dict _internalMatch; // Map internal name to its MatchNode
189
190 NameList _preproc_list; // Preprocessor flag names
191 FormDict _preproc_table;// Preprocessor flag bindings
192 char* get_preproc_def(const char* flag);
193 void set_preproc_def(const char* flag, const char* def);
194
195 FormDict& globalNames() {return _globalNames;} // map global names to forms
196 void initKeywords(FormDict& globals); // Add keywords to global name table
197
198 ExprDict& globalDefs() {return _globalDefs;} // map global names to expressions
199
200 OperandForm *constructOperand(const char *ident, bool ideal_only);
201 void initBaseOpTypes(); // Import predefined base types.
202
203 void addForm(PreHeaderForm *ptr); // Add objects to pre-header list
204 void addForm(HeaderForm *ptr); // Add objects to header list
205 void addForm(SourceForm *ptr); // Add objects to source list
206 void addForm(EncodeForm *ptr); // Add objects to encode list
207 void addForm(InstructForm *ptr); // Add objects to the instruct list
208 void addForm(OperandForm *ptr); // Add objects to the operand list
209 void addForm(OpClassForm *ptr); // Add objects to the opclasss list
210 void addForm(AttributeForm *ptr); // Add objects to the attributes list
211 void addForm(RegisterForm *ptr); // Add objects to the register list
212 void addForm(FrameForm *ptr); // Add objects to the frame list
213 void addForm(PipelineForm *ptr); // Add objects to the pipeline list
214 void addForm(MachNodeForm *ptr); // Add objects to the machnode list
215
216 int operandFormCount(); // Count number of OperandForms defined
217 int opclassFormCount(); // Count number of OpClassForms defined
218 int instructFormCount(); // Count number of InstructForms defined
219
220 inline void getForm(EncodeForm **ptr) { *ptr = _encode; }
221
222 bool verify();
223 void dump();
224
225 // Helper utility that gets MatchList components from inside MatchRule
226 void check_optype(MatchRule *mrule);
227 void build_chain_rule(OperandForm *oper);
228 void add_chain_rule_entry(const char *src, const char *cost,
229 const char *result);
230 const char *getMatchListIndex(MatchRule &mrule);
231 void generateMatchLists(); // Build MatchList array and populate it
232 void inspectOperands(); // Build MatchLists for all operands
233 void inspectOpClasses(); // Build MatchLists for all operands
234 void inspectInstructions(); // Build MatchLists for all operands
235 void buildDFA(FILE *fp); // Driver for constructing the DFA
236 void gen_dfa_state_body(FILE *fp, Dict &minmize, ProductionState &status, Dict &chained, int i); // Driver for constructing the DFA state bodies
237
238 // Helper utilities to generate reduction maps for internal operands
239 const char *reduceLeft (char *internalName);
240 const char *reduceRight(char *internalName);
241
242 // Build enumerations, (1) dense operand index, (2) operands and opcodes
243 const char *machOperEnum(const char *opName); // create dense index names using static function
244 static const char *getMachOperEnum(const char *opName);// create dense index name
245 void buildMachOperEnum(FILE *fp_hpp);// dense enumeration for operands
246 void buildMachOpcodesEnum(FILE *fp_hpp);// enumeration for MachOpers & MachNodes
247
248 // Helper utilities to generate Register Masks
249 RegisterForm *get_registers() { return _register; }
250 const char *reg_mask(OperandForm &opForm);
251 const char *reg_mask(InstructForm &instForm);
252 const char *reg_class_to_reg_mask(const char *reg_class);
253 char *stack_or_reg_mask(OperandForm &opForm); // name of cisc_spillable version
254 // This register class should also generate a stack_or_reg_mask
255 void set_stack_or_reg(const char *reg_class_name); // for cisc-spillable reg classes
256 // Generate an enumeration of register mask names and the RegMask objects.
257 void declare_register_masks(FILE *fp_cpp);
258 void build_register_masks(FILE *fp_cpp);
259 // Generate enumeration of machine register numbers
260 void buildMachRegisterNumbers(FILE *fp_hpp);
261 // Generate enumeration of machine register encodings
262 void buildMachRegisterEncodes(FILE *fp_hpp);
263 // Generate Regsiter Size Array
264 void declareRegSizes(FILE *fp_hpp);
265 // Generate Pipeline Class information
266 void declare_pipe_classes(FILE *fp_hpp);
267 // Generate Pipeline definitions
268 void build_pipeline_enums(FILE *fp_cpp);
269 // Generate Pipeline Class information
270 void build_pipe_classes(FILE *fp_cpp);
271
272 // Declare and define mappings from rules to result and input types
273 void build_map(OutputMap &map);
274 void buildReduceMaps(FILE *fp_hpp, FILE *fp_cpp);
275 // build flags for signaling that our machine needs this instruction cloned
276 void buildMustCloneMap(FILE *fp_hpp, FILE *fp_cpp);
277
278 // output SUN copyright info
279 void addSunCopyright(char* legal, int size, FILE *fp);
280 // output the start of an include guard.
281 void addIncludeGuardStart(ADLFILE &adlfile, const char* guardString);
282 // output the end of an include guard.
283 void addIncludeGuardEnd(ADLFILE &adlfile, const char* guardString);
284 // output the #include line for this file.
285 void addInclude(ADLFILE &adlfile, const char* fileName);
286 void addInclude(ADLFILE &adlfile, const char* includeDir, const char* fileName);
287 // Output C preprocessor code to verify the backend compilation environment.
288 void addPreprocessorChecks(FILE *fp);
289 // Output C source and header (source_hpp) blocks.
290 void addPreHeaderBlocks(FILE *fp_hpp);
291 void addHeaderBlocks(FILE *fp_hpp);
292 void addSourceBlocks(FILE *fp_cpp);
293 void generate_adlc_verification(FILE *fp_cpp);
294
295 // output declaration of class State
296 void defineStateClass(FILE *fp);
297
298 // Generator for MachOper objects given integer type
299 void buildMachOperGenerator(FILE *fp_cpp);
300 // Generator for MachNode objects given integer type
301 void buildMachNodeGenerator(FILE *fp_cpp);
302
303 // Generator for Expand methods for instructions with expand rules
304 void defineExpand(FILE *fp, InstructForm *node);
305 // Generator for Peephole methods for instructions with peephole rules
306 void definePeephole(FILE *fp, InstructForm *node);
307 // Generator for Size methods for instructions
308 void defineSize(FILE *fp, InstructForm &node);
309 // Generator for Emit methods for instructions
310 void defineEmit(FILE *fp, InstructForm &node);
311 // Define a MachOper encode method
312 void define_oper_interface(FILE *fp, OperandForm &oper, FormDict &globals,
313 const char *name, const char *encoding);
314
315 // Methods to construct the MachNode class hierarchy
316 // Return the type signature for the ideal operation
317 const char *getIdealType(const char *idealOp);
318 // Declare and define the classes derived from MachOper and MachNode
319 void declareClasses(FILE *fp_hpp);
320 void defineClasses(FILE *fp_cpp);
321
322 // Emit an ADLC message
323 void internal_err( const char *fmt, ...);
324 void syntax_err ( int lineno, const char *fmt, ...);
325 int emit_msg(int quiet, int flag, int linenum, const char *fmt,
326 va_list args);
327
328 // Generator for has_match_rule methods
329 void buildInstructMatchCheck(FILE *fp_cpp) const;
330
331 // Generator for Frame Methods
332 void buildFrameMethods(FILE *fp_cpp);
333
334 // Generate CISC_spilling oracle and MachNode::cisc_spill() methods
335 void build_cisc_spill_instructions(FILE *fp_hpp, FILE *fp_cpp);
336 void identify_cisc_spill_instructions();
337 void identify_short_branches();
338 void identify_unique_operands();
339 void set_cisc_spill_operand(OperandForm *opForm) { _cisc_spill_operand = opForm; }
340 OperandForm *cisc_spill_operand() { return _cisc_spill_operand; }
341 bool can_cisc_spill() { return _cisc_spill_operand != NULL; }
342
343
344 protected:
345 // build MatchList from MatchRule
346 void buildMatchList(MatchRule *mrule, const char *resultStr,
347 const char *rootOp, Predicate *pred, const char *cost);
348
349 void buildMList(MatchNode *node, const char *rootOp, const char *resultOp,
350 Predicate *pred, const char *cost);
351
352 friend class ADLParser;
353
354 };
355
356
357 // -------------------------------- maps ------------------------------------
358
359 // Base class for generating a mapping from rule number to value.
360 // Used with ArchDesc::build_map() for all maps except "enum MachOperands"
361 // A derived class defines the appropriate output for a specific mapping.
362 class OutputMap {
363 protected:
364 FILE *_hpp;
365 FILE *_cpp;
366 FormDict &_globals;
367 ArchDesc &_AD;
368 public:
369 OutputMap (FILE *decl_file, FILE *def_file, FormDict &globals, ArchDesc &AD)
370 : _hpp(decl_file), _cpp(def_file), _globals(globals), _AD(AD) {};
371 // Access files used by this routine
372 FILE *decl_file() { return _hpp; }
373 FILE *def_file() { return _cpp; }
374 // Positions in iteration that derived class will be told about
375 enum position { BEGIN_OPERANDS,
376 BEGIN_OPCLASSES,
377 BEGIN_INTERNALS,
378 BEGIN_INSTRUCTIONS,
379 BEGIN_INST_CHAIN_RULES,
380 END_INST_CHAIN_RULES,
381 BEGIN_REMATERIALIZE,
382 END_REMATERIALIZE,
383 END_INSTRUCTIONS
384 };
385 // Output routines specific to the derived class
386 virtual void declaration() {}
387 virtual void definition() {}
388 virtual void closing() { fprintf(_cpp, "};\n"); }
389 virtual void map(OperandForm &oper) { }
390 virtual void map(OpClassForm &opc) { }
391 virtual void map(char *internal_name) { }
392 // Allow enum-MachOperands to turn-off instructions
393 virtual bool do_instructions() { return true; }
394 virtual void map(InstructForm &inst) { }
395 // Allow derived class to output name and position specific info
396 virtual void record_position(OutputMap::position place, int index) {}
397 };
398
399 #endif // SHARE_VM_ADLC_ARCHDESC_HPP