1 /*
2 * Copyright (c) 1998, 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_FORMSSEL_HPP
26 #define SHARE_VM_ADLC_FORMSSEL_HPP
27
28 // FORMSSEL.HPP - ADL Parser Instruction Selection Forms Classes
29
30 // Class List
31 class Form;
32 class InstructForm;
33 class MachNodeForm;
34 class OperandForm;
35 class OpClassForm;
36 class AttributeForm;
37 class RegisterForm;
38 class PipelineForm;
39 class SourceForm;
40 class EncodeForm;
41 class Component;
42 class Constraint;
43 class Predicate;
44 class MatchRule;
45 class Attribute;
46 class Effect;
47 class ExpandRule;
48 class RewriteRule;
49 class ConstructRule;
50 class FormatRule;
51 class Peephole;
52 class EncClass;
53 class Interface;
54 class RegInterface;
55 class ConstInterface;
56 class MemInterface;
57 class CondInterface;
58 class Opcode;
59 class InsEncode;
60 class RegDef;
61 class RegClass;
62 class AllocClass;
63 class ResourceForm;
64 class PipeDesc;
65 class PipeClass;
66 class PeepMatch;
67 class PeepConstraint;
68 class PeepReplace;
69 class MatchList;
70
71 class ArchDesc;
72
73 //==============================Instructions===================================
74 //------------------------------InstructForm-----------------------------------
75 class InstructForm : public Form {
76 private:
77 bool _ideal_only; // Not a user-defined instruction
78 // Members used for tracking CISC-spilling
79 uint _cisc_spill_operand;// Which operand may cisc-spill
80 void set_cisc_spill_operand(uint op_index) { _cisc_spill_operand = op_index; }
81 bool _is_cisc_alternate;
82 InstructForm *_cisc_spill_alternate;// cisc possible replacement
83 const char *_cisc_reg_mask_name;
84 InstructForm *_short_branch_form;
85 bool _is_short_branch;
86 bool _is_mach_constant; // true if Node is a MachConstantNode
87 uint _alignment;
88
89 public:
90 // Public Data
91 const char *_ident; // Name of this instruction
92 NameList _parameters; // Locally defined names
93 FormDict _localNames; // Table of operands & their types
94 MatchRule *_matrule; // Matching rule for this instruction
95 Opcode *_opcode; // Encoding of the opcode for instruction
96 char *_size; // Size of instruction
97 InsEncode *_insencode; // Encoding class instruction belongs to
98 InsEncode *_constant; // Encoding class constant value belongs to
99 Attribute *_attribs; // List of Attribute rules
100 Predicate *_predicate; // Predicate test for this instruction
101 FormDict _effects; // Dictionary of effect rules
102 ExpandRule *_exprule; // Expand rule for this instruction
103 RewriteRule *_rewrule; // Rewrite rule for this instruction
104 FormatRule *_format; // Format for assembly generation
105 Peephole *_peephole; // List of peephole rules for instruction
106 const char *_ins_pipe; // Instruction Scheduline description class
107
108 uint *_uniq_idx; // Indexes of unique operands
109 int _uniq_idx_length; // Length of _uniq_idx array
110 uint _num_uniq; // Number of unique operands
111 ComponentList _components; // List of Components matches MachNode's
112 // operand structure
113
114 // Public Methods
115 InstructForm(const char *id, bool ideal_only = false);
116 InstructForm(const char *id, InstructForm *instr, MatchRule *rule);
117 ~InstructForm();
118
119 // Dynamic type check
120 virtual InstructForm *is_instruction() const;
121
122 virtual bool ideal_only() const;
123
124 // This instruction sets a result
125 virtual bool sets_result() const;
126 // This instruction needs projections for additional DEFs or KILLs
127 virtual bool needs_projections();
128 // This instruction needs extra nodes for temporary inputs
129 virtual bool has_temps();
130 // This instruction defines or kills more than one object
131 virtual uint num_defs_or_kills();
132 // This instruction has an expand rule?
133 virtual bool expands() const ;
134 // Return this instruction's first peephole rule, or NULL
135 virtual Peephole *peepholes() const;
136 // Add a peephole rule to this instruction
137 virtual void append_peephole(Peephole *peep);
138
139 virtual bool is_pinned(FormDict &globals); // should be pinned inside block
140 virtual bool is_projection(FormDict &globals); // node requires projection
141 virtual bool is_parm(FormDict &globals); // node matches ideal 'Parm'
142 // ideal opcode enumeration
143 virtual const char *ideal_Opcode(FormDict &globals) const;
144 virtual int is_expensive() const; // node matches ideal 'CosD'
145 virtual int is_empty_encoding() const; // _size=0 and/or _insencode empty
146 virtual int is_tls_instruction() const; // tlsLoadP rule or ideal ThreadLocal
147 virtual int is_ideal_copy() const; // node matches ideal 'Copy*'
148 virtual bool is_ideal_if() const; // node matches ideal 'If'
149 virtual bool is_ideal_fastlock() const; // node matches 'FastLock'
150 virtual bool is_ideal_membar() const; // node matches ideal 'MemBarXXX'
151 virtual bool is_ideal_loadPC() const; // node matches ideal 'LoadPC'
152 virtual bool is_ideal_box() const; // node matches ideal 'Box'
153 virtual bool is_ideal_goto() const; // node matches ideal 'Goto'
154 virtual bool is_ideal_branch() const; // "" 'If' | 'Goto' | 'LoopEnd' | 'Jump'
155 virtual bool is_ideal_jump() const; // node matches ideal 'Jump'
156 virtual bool is_ideal_return() const; // node matches ideal 'Return'
157 virtual bool is_ideal_halt() const; // node matches ideal 'Halt'
158 virtual bool is_ideal_safepoint() const; // node matches 'SafePoint'
159 virtual bool is_ideal_nop() const; // node matches 'Nop'
160 virtual bool is_ideal_control() const; // control node
161
162 virtual Form::CallType is_ideal_call() const; // matches ideal 'Call'
163 virtual Form::DataType is_ideal_load() const; // node matches ideal 'LoadXNode'
164 // Should antidep checks be disabled for this Instruct
165 // See definition of MatchRule::skip_antidep_check
166 bool skip_antidep_check() const;
167 virtual Form::DataType is_ideal_store() const;// node matches ideal 'StoreXNode'
168 bool is_ideal_mem() const { return is_ideal_load() != Form::none || is_ideal_store() != Form::none; }
169 virtual uint two_address(FormDict &globals); // output reg must match input reg
170 // when chaining a constant to an instruction, return 'true' and set opType
171 virtual Form::DataType is_chain_of_constant(FormDict &globals);
172 virtual Form::DataType is_chain_of_constant(FormDict &globals, const char * &opType);
173 virtual Form::DataType is_chain_of_constant(FormDict &globals, const char * &opType, const char * &result_type);
174
175 // Check if a simple chain rule
176 virtual bool is_simple_chain_rule(FormDict &globals) const;
177
178 // check for structural rematerialization
179 virtual bool rematerialize(FormDict &globals, RegisterForm *registers);
180
181 // loads from memory, so must check for anti-dependence
182 virtual bool needs_anti_dependence_check(FormDict &globals) const;
183 virtual int memory_operand(FormDict &globals) const;
184 bool is_wide_memory_kill(FormDict &globals) const;
185
186 enum memory_operand_type {
187 NO_MEMORY_OPERAND = -1,
188 MANY_MEMORY_OPERANDS = 999999
189 };
190
191
192 // This instruction captures the machine-independent bottom_type
193 // Expected use is for pointer vs oop determination for LoadP
194 virtual bool captures_bottom_type(FormDict& globals) const;
195
196 virtual const char *cost(); // Access ins_cost attribute
197 virtual uint num_opnds(); // Count of num_opnds for MachNode class
198 virtual uint num_post_match_opnds();
199 virtual uint num_consts(FormDict &globals) const;// Constants in match rule
200 // Constants in match rule with specified type
201 virtual uint num_consts(FormDict &globals, Form::DataType type) const;
202
203 // Return the register class associated with 'leaf'.
204 virtual const char *out_reg_class(FormDict &globals);
205
206 // number of ideal node inputs to skip
207 virtual uint oper_input_base(FormDict &globals);
208
209 // Does this instruction need a base-oop edge?
210 int needs_base_oop_edge(FormDict &globals) const;
211
212 // Build instruction predicates. If the user uses the same operand name
213 // twice, we need to check that the operands are pointer-eequivalent in
214 // the DFA during the labeling process.
215 Predicate *build_predicate();
216
217 virtual void build_components(); // top-level operands
218 // Return zero-based position in component list; -1 if not in list.
219 virtual int operand_position(const char *name, int usedef);
220 virtual int operand_position_format(const char *name);
221
222 // Return zero-based position in component list; -1 if not in list.
223 virtual int label_position();
224 virtual int method_position();
225 // Return number of relocation entries needed for this instruction.
226 virtual uint reloc(FormDict &globals);
227
228 const char *reduce_result();
229 // Return the name of the operand on the right hand side of the binary match
230 // Return NULL if there is no right hand side
231 const char *reduce_right(FormDict &globals) const;
232 const char *reduce_left(FormDict &globals) const;
233
234 // Base class for this instruction, MachNode except for calls
235 virtual const char *mach_base_class(FormDict &globals) const;
236
237 // Check if this instruction can cisc-spill to 'alternate'
238 bool cisc_spills_to(ArchDesc &AD, InstructForm *alternate);
239 InstructForm *cisc_spill_alternate() { return _cisc_spill_alternate; }
240 uint cisc_spill_operand() const { return _cisc_spill_operand; }
241 bool is_cisc_alternate() const { return _is_cisc_alternate; }
242 void set_cisc_alternate(bool val) { _is_cisc_alternate = val; }
243 const char *cisc_reg_mask_name() const { return _cisc_reg_mask_name; }
244 void set_cisc_reg_mask_name(const char *rm_name) { _cisc_reg_mask_name = rm_name; }
245 // Output cisc-method prototypes and method bodies
246 void declare_cisc_version(ArchDesc &AD, FILE *fp_cpp);
247 bool define_cisc_version (ArchDesc &AD, FILE *fp_cpp);
248
249 bool check_branch_variant(ArchDesc &AD, InstructForm *short_branch);
250
251 bool is_short_branch() { return _is_short_branch; }
252 void set_short_branch(bool val) { _is_short_branch = val; }
253
254 bool is_mach_constant() const { return _is_mach_constant; }
255 void set_is_mach_constant(bool x) { _is_mach_constant = x; }
256
257 InstructForm *short_branch_form() { return _short_branch_form; }
258 bool has_short_branch_form() { return _short_branch_form != NULL; }
259 // Output short branch prototypes and method bodies
260 void declare_short_branch_methods(FILE *fp_cpp);
261 bool define_short_branch_methods(ArchDesc &AD, FILE *fp_cpp);
262
263 uint alignment() { return _alignment; }
264 void set_alignment(uint val) { _alignment = val; }
265
266 // Seach through operands to determine operands unique positions.
267 void set_unique_opnds();
268 uint num_unique_opnds() { return _num_uniq; }
269 uint unique_opnds_idx(int idx) {
270 if( _uniq_idx != NULL && idx > 0 ) {
271 assert(idx < _uniq_idx_length, "out of bounds");
272 return _uniq_idx[idx];
273 } else {
274 return idx;
275 }
276 }
277
278 // Operands which are only KILLs aren't part of the input array and
279 // require special handling in some cases. Their position in this
280 // operand list is higher than the number of unique operands.
281 bool is_noninput_operand(uint idx) {
282 return (idx >= num_unique_opnds());
283 }
284
285 // --------------------------- FILE *output_routines
286 //
287 // Generate the format call for the replacement variable
288 void rep_var_format(FILE *fp, const char *rep_var);
289 // Generate index values needed for determining the operand position
290 void index_temps (FILE *fp, FormDict &globals, const char *prefix = "", const char *receiver = "");
291 // ---------------------------
292
293 virtual bool verify(); // Check consistency after parsing
294
295 virtual void dump(); // Debug printer
296 virtual void output(FILE *fp); // Write to output files
297 };
298
299 //------------------------------EncodeForm-------------------------------------
300 class EncodeForm : public Form {
301 private:
302
303 public:
304 // Public Data
305 NameList _eclasses; // List of encode class names
306 Dict _encClass; // Map encode class names to EncClass objects
307
308 // Public Methods
309 EncodeForm();
310 ~EncodeForm();
311
312 EncClass *add_EncClass(const char *className);
313 EncClass *encClass(const char *className);
314
315 const char *encClassPrototype(const char *className);
316 const char *encClassBody(const char *className);
317
318 void dump(); // Debug printer
319 void output(FILE *fp); // Write info to output files
320 };
321
322 //------------------------------EncClass---------------------------------------
323 class EncClass : public Form {
324 public:
325 // NameList for parameter type and name
326 NameList _parameter_type;
327 NameList _parameter_name;
328
329 // Breakdown the encoding into strings separated by $replacement_variables
330 // There is an entry in _strings, perhaps NULL, that precedes each _rep_vars
331 NameList _code; // Strings passed through to tty->print
332 NameList _rep_vars; // replacement variables
333
334 NameList _parameters; // Locally defined names
335 FormDict _localNames; // Table of components & their types
336
337 public:
338 // Public Data
339 const char *_name; // encoding class name
340
341 // Public Methods
342 EncClass(const char *name);
343 ~EncClass();
344
345 // --------------------------- Parameters
346 // Add a parameter <type,name> pair
347 void add_parameter(const char *parameter_type, const char *parameter_name);
348 // Verify operand types in parameter list
349 bool check_parameter_types(FormDict &globals);
350 // Obtain the zero-based index corresponding to a replacement variable
351 int rep_var_index(const char *rep_var);
352 int num_args() { return _parameter_name.count(); }
353
354 // --------------------------- Code Block
355 // Add code
356 void add_code(const char *string_preceding_replacement_var);
357 // Add a replacement variable or one of its subfields
358 // Subfields are stored with a leading '$'
359 void add_rep_var(char *replacement_var);
360
361 bool verify();
362 void dump();
363 void output(FILE *fp);
364 };
365
366 //------------------------------MachNode---------------------------------------
367 class MachNodeForm: public Form {
368 private:
369
370 public:
371 char *_ident; // Name of this instruction
372 const char *_machnode_pipe; // Instruction Scheduline description class
373
374 // Public Methods
375 MachNodeForm(char *id);
376 ~MachNodeForm();
377
378 virtual MachNodeForm *is_machnode() const;
379
380 void dump(); // Debug printer
381 void output(FILE *fp); // Write info to output files
382 };
383
384 //------------------------------Opcode-----------------------------------------
385 class Opcode : public Form {
386 private:
387
388 public:
389 // Public Data
390 // Strings representing instruction opcodes, user defines placement in emit
391 char *_primary;
392 char *_secondary;
393 char *_tertiary;
394
395 enum opcode_type {
396 NOT_AN_OPCODE = -1,
397 PRIMARY = 1,
398 SECONDARY = 2,
399 TERTIARY = 3
400 };
401
402 // Public Methods
403 Opcode(char *primary, char *secondary, char *tertiary);
404 ~Opcode();
405
406 static Opcode::opcode_type as_opcode_type(const char *designator);
407
408 void dump();
409 void output(FILE *fp);
410
411 // --------------------------- FILE *output_routines
412 bool print_opcode(FILE *fp, Opcode::opcode_type desired_opcode);
413 };
414
415 //------------------------------InsEncode--------------------------------------
416 class InsEncode : public Form {
417 private:
418 // Public Data (access directly only for reads)
419 // The encodings can only have the values predefined by the ADLC:
420 // blank, RegReg, RegMem, MemReg, ...
421 NameList _encoding;
422 // NameList _parameter;
423 // The parameters for each encoding are preceeded by a NameList::_signal
424 // and follow the parameters for the previous encoding.
425
426 // char *_encode; // Type of instruction encoding
427
428 public:
429 // Public Methods
430 InsEncode();
431 ~InsEncode();
432
433 // Add "encode class name" and its parameters
434 NameAndList *add_encode(char *encode_method_name);
435 // Parameters are added to the returned "NameAndList" by the parser
436
437 // Access the list of encodings
438 void reset();
439 const char *encode_class_iter();
440
441 // Returns the number of arguments to the current encoding in the iteration
442 int current_encoding_num_args() {
443 return ((NameAndList*)_encoding.current())->count();
444 }
445
446 // --------------------------- Parameters
447 // The following call depends upon position within encode_class_iteration
448 //
449 // Obtain parameter name from zero based index
450 const char *rep_var_name(InstructForm &inst, uint param_no);
451 // ---------------------------
452
453 void dump();
454 void output(FILE *fp);
455 };
456
457 //------------------------------Effect-----------------------------------------
458 class Effect : public Form {
459 private:
460
461 public:
462 // Public Data
463 const char *_name; // Pre-defined name for effect
464 int _use_def; // Enumeration value of effect
465
466 // Public Methods
467 Effect(const char *name); // Constructor
468 ~Effect(); // Destructor
469
470 // Dynamic type check
471 virtual Effect *is_effect() const;
472
473 // Return 'true' if this use def info equals the parameter
474 bool is(int use_def_kill_enum) const;
475 // Return 'true' if this use def info is a superset of parameter
476 bool isa(int use_def_kill_enum) const;
477
478 void dump(); // Debug printer
479 void output(FILE *fp); // Write info to output files
480 };
481
482 //------------------------------ExpandRule-------------------------------------
483 class ExpandRule : public Form {
484 private:
485 NameList _expand_instrs; // ordered list of instructions and operands
486
487 public:
488 // Public Data
489 NameList _newopers; // List of newly created operands
490 Dict _newopconst; // Map new operands to their constructors
491
492 void add_instruction(NameAndList *instruction_name_and_operand_list);
493 void reset_instructions();
494 NameAndList *iter_instructions();
495
496 // Public Methods
497 ExpandRule(); // Constructor
498 ~ExpandRule(); // Destructor
499
500 void dump(); // Debug printer
501 void output(FILE *fp); // Write info to output files
502 };
503
504 //------------------------------RewriteRule------------------------------------
505 class RewriteRule : public Form {
506 private:
507
508 public:
509 // Public Data
510 SourceForm *_condition; // Rewrite condition code
511 InstructForm *_instrs; // List of instructions to expand to
512 OperandForm *_opers; // List of operands generated by expand
513 char *_tempParams; // Hold string until parser is finished.
514 char *_tempBlock; // Hold string until parser is finished.
515
516 // Public Methods
517 RewriteRule(char* params, char* block) ;
518 ~RewriteRule(); // Destructor
519 void dump(); // Debug printer
520 void output(FILE *fp); // Write info to output files
521 };
522
523
524 //==============================Operands=======================================
525 //------------------------------OpClassForm------------------------------------
526 class OpClassForm : public Form {
527 public:
528 // Public Data
529 const char *_ident; // Name of this operand
530 NameList _oplst; // List of operand forms included in class
531
532 // Public Methods
533 OpClassForm(const char *id);
534 ~OpClassForm();
535
536 // dynamic type check
537 virtual OpClassForm *is_opclass() const;
538 virtual Form::InterfaceType interface_type(FormDict &globals) const;
539 virtual bool stack_slots_only(FormDict &globals) const;
540
541 virtual bool is_cisc_mem(FormDict &globals) const;
542
543
544 // Min and Max opcodes of operands in this operand class
545 int _minCode;
546 int _maxCode;
547
548 virtual bool ideal_only() const;
549 virtual void dump(); // Debug printer
550 virtual void output(FILE *fp); // Write to output files
551 };
552
553 //------------------------------OperandForm------------------------------------
554 class OperandForm : public OpClassForm {
555 private:
556 bool _ideal_only; // Not a user-defined instruction
557
558 public:
559 // Public Data
560 NameList _parameters; // Locally defined names
561 FormDict _localNames; // Table of components & their types
562 MatchRule *_matrule; // Matching rule for this operand
563 Interface *_interface; // Encoding interface for this operand
564 Attribute *_attribs; // List of Attribute rules
565 Predicate *_predicate; // Predicate test for this operand
566 Constraint *_constraint; // Constraint Rule for this operand
567 ConstructRule *_construct; // Construction of operand data after matching
568 FormatRule *_format; // Format for assembly generation
569 NameList _classes; // List of opclasses which contain this oper
570
571 ComponentList _components; //
572
573 // Public Methods
574 OperandForm(const char *id);
575 OperandForm(const char *id, bool ideal_only);
576 ~OperandForm();
577
578 // Dynamic type check
579 virtual OperandForm *is_operand() const;
580
581 virtual bool ideal_only() const;
582 virtual Form::InterfaceType interface_type(FormDict &globals) const;
583 virtual bool stack_slots_only(FormDict &globals) const;
584
585 virtual const char *cost(); // Access ins_cost attribute
586 virtual uint num_leaves() const;// Leaves in complex operand
587 // Constants in operands' match rules
588 virtual uint num_consts(FormDict &globals) const;
589 // Constants in operand's match rule with specified type
590 virtual uint num_consts(FormDict &globals, Form::DataType type) const;
591 // Pointer Constants in operands' match rules
592 virtual uint num_const_ptrs(FormDict &globals) const;
593 // The number of input edges in the machine world == num_leaves - num_consts
594 virtual uint num_edges(FormDict &globals) const;
595
596 // Check if this operand is usable for cisc-spilling
597 virtual bool is_cisc_reg(FormDict &globals) const;
598
599 // node matches ideal 'Bool', grab condition codes from the ideal world
600 virtual bool is_ideal_bool() const;
601
602 // Has an integer constant suitable for spill offsets
603 bool has_conI(FormDict &globals) const {
604 return (num_consts(globals,idealI) == 1) && !is_ideal_bool(); }
605 bool has_conL(FormDict &globals) const {
606 return (num_consts(globals,idealL) == 1) && !is_ideal_bool(); }
607
608 // Node is user-defined operand for an sRegX
609 virtual Form::DataType is_user_name_for_sReg() const;
610
611 // Return ideal type, if there is a single ideal type for this operand
612 virtual const char *ideal_type(FormDict &globals, RegisterForm *registers = NULL) const;
613 // If there is a single ideal type for this interface field, return it.
614 virtual const char *interface_ideal_type(FormDict &globals,
615 const char *field_name) const;
616
617 // Return true if this operand represents a bound register class
618 bool is_bound_register() const;
619
620 // Return the Register class for this operand. Returns NULL if
621 // operand isn't a register form.
622 RegClass* get_RegClass() const;
623
624 virtual bool is_interface_field(const char *field_name,
625 const char * &value) const;
626
627 // If this operand has a single ideal type, return its type
628 virtual Form::DataType simple_type(FormDict &globals) const;
629 // If this operand is an ideal constant, return its type
630 virtual Form::DataType is_base_constant(FormDict &globals) const;
631
632 // "true" if this operand is a simple type that is swallowed
633 virtual bool swallowed(FormDict &globals) const;
634
635 // Return register class name if a constraint specifies the register class.
636 virtual const char *constrained_reg_class() const;
637 // Return the register class associated with 'leaf'.
638 virtual const char *in_reg_class(uint leaf, FormDict &globals);
639
640 // Build component list from MatchRule and operand's parameter list
641 virtual void build_components(); // top-level operands
642
643 // Return zero-based position in component list; -1 if not in list.
644 virtual int operand_position(const char *name, int usedef);
645
646 // Return zero-based position in component list; -1 if not in list.
647 virtual int constant_position(FormDict &globals, const Component *comp);
648 virtual int constant_position(FormDict &globals, const char *local_name);
649 // Return the operand form corresponding to the given index, else NULL.
650 virtual OperandForm *constant_operand(FormDict &globals, uint const_index);
651
652 // Return zero-based position in component list; -1 if not in list.
653 virtual int register_position(FormDict &globals, const char *regname);
654
655 const char *reduce_result() const;
656 // Return the name of the operand on the right hand side of the binary match
657 // Return NULL if there is no right hand side
658 const char *reduce_right(FormDict &globals) const;
659 const char *reduce_left(FormDict &globals) const;
660
661
662 // --------------------------- FILE *output_routines
663 //
664 // Output code for disp_is_oop, if true.
665 void disp_is_oop(FILE *fp, FormDict &globals);
666 // Generate code for internal and external format methods
667 void int_format(FILE *fp, FormDict &globals, uint index);
668 void ext_format(FILE *fp, FormDict &globals, uint index);
669 void format_constant(FILE *fp, uint con_index, uint con_type);
670 // Output code to access the value of the index'th constant
671 void access_constant(FILE *fp, FormDict &globals,
672 uint con_index);
673 // ---------------------------
674
675
676 virtual void dump(); // Debug printer
677 virtual void output(FILE *fp); // Write to output files
678 };
679
680 //------------------------------Constraint-------------------------------------
681 class Constraint : public Form {
682 private:
683
684 public:
685 const char *_func; // Constraint function
686 const char *_arg; // function's argument
687
688 // Public Methods
689 Constraint(const char *func, const char *arg); // Constructor
690 ~Constraint();
691
692 bool stack_slots_only() const;
693
694 void dump(); // Debug printer
695 void output(FILE *fp); // Write info to output files
696 };
697
698 //------------------------------Predicate--------------------------------------
699 class Predicate : public Form {
700 private:
701
702 public:
703 // Public Data
704 char *_pred; // C++ source string for predicate
705
706 // Public Methods
707 Predicate(char *pr);
708 ~Predicate();
709
710 void dump();
711 void output(FILE *fp);
712 };
713
714 //------------------------------Interface--------------------------------------
715 class Interface : public Form {
716 private:
717
718 public:
719 // Public Data
720 const char *_name; // String representing the interface name
721
722 // Public Methods
723 Interface(const char *name);
724 ~Interface();
725
726 virtual Form::InterfaceType interface_type(FormDict &globals) const;
727
728 RegInterface *is_RegInterface();
729 MemInterface *is_MemInterface();
730 ConstInterface *is_ConstInterface();
731 CondInterface *is_CondInterface();
732
733
734 void dump();
735 void output(FILE *fp);
736 };
737
738 //------------------------------RegInterface-----------------------------------
739 class RegInterface : public Interface {
740 private:
741
742 public:
743 // Public Methods
744 RegInterface();
745 ~RegInterface();
746
747 void dump();
748 void output(FILE *fp);
749 };
750
751 //------------------------------ConstInterface---------------------------------
752 class ConstInterface : public Interface {
753 private:
754
755 public:
756 // Public Methods
757 ConstInterface();
758 ~ConstInterface();
759
760 void dump();
761 void output(FILE *fp);
762 };
763
764 //------------------------------MemInterface-----------------------------------
765 class MemInterface : public Interface {
766 private:
767
768 public:
769 // Public Data
770 char *_base; // Base address
771 char *_index; // index
772 char *_scale; // scaling factor
773 char *_disp; // displacement
774
775 // Public Methods
776 MemInterface(char *base, char *index, char *scale, char *disp);
777 ~MemInterface();
778
779 void dump();
780 void output(FILE *fp);
781 };
782
783 //------------------------------CondInterface----------------------------------
784 class CondInterface : public Interface {
785 private:
786
787 public:
788 const char *_equal;
789 const char *_not_equal;
790 const char *_less;
791 const char *_greater_equal;
792 const char *_less_equal;
793 const char *_greater;
794 const char *_equal_format;
795 const char *_not_equal_format;
796 const char *_less_format;
797 const char *_greater_equal_format;
798 const char *_less_equal_format;
799 const char *_greater_format;
800
801 // Public Methods
802 CondInterface(const char* equal, const char* equal_format,
803 const char* not_equal, const char* not_equal_format,
804 const char* less, const char* less_format,
805 const char* greater_equal, const char* greater_equal_format,
806 const char* less_equal, const char* less_equal_format,
807 const char* greater, const char* greater_format);
808 ~CondInterface();
809
810 void dump();
811 void output(FILE *fp);
812 };
813
814 //------------------------------ConstructRule----------------------------------
815 class ConstructRule : public Form {
816 private:
817
818 public:
819 // Public Data
820 char *_expr; // String representing the match expression
821 char *_construct; // String representing C++ constructor code
822
823 // Public Methods
824 ConstructRule(char *cnstr);
825 ~ConstructRule();
826
827 void dump();
828 void output(FILE *fp);
829 };
830
831
832 //==============================Shared=========================================
833 //------------------------------AttributeForm----------------------------------
834 class AttributeForm : public Form {
835 private:
836 // counters for unique instruction or operand ID
837 static int _insId; // user-defined machine instruction types
838 static int _opId; // user-defined operand types
839
840 int id; // hold type for this object
841
842 public:
843 // Public Data
844 char *_attrname; // Name of attribute
845 int _atype; // Either INS_ATTR or OP_ATTR
846 char *_attrdef; // C++ source which evaluates to constant
847
848 // Public Methods
849 AttributeForm(char *attr, int type, char *attrdef);
850 ~AttributeForm();
851
852 // Dynamic type check
853 virtual AttributeForm *is_attribute() const;
854
855 int type() { return id;} // return this object's "id"
856
857 static const char* _ins_cost; // "ins_cost"
858 static const char* _op_cost; // "op_cost"
859
860 void dump(); // Debug printer
861 void output(FILE *fp); // Write output files
862 };
863
864 //------------------------------Component--------------------------------------
865 class Component : public Form {
866 private:
867
868 public:
869 // Public Data
870 const char *_name; // Name of this component
871 const char *_type; // Type of this component
872 int _usedef; // Value of component
873
874 // Public Methods
875 Component(const char *name, const char *type, int usedef);
876 ~Component();
877
878
879 // Return 'true' if this use def info equals the parameter
880 bool is(int use_def_kill_enum) const;
881 // Return 'true' if this use def info is a superset of parameter
882 bool isa(int use_def_kill_enum) const;
883 int promote_use_def_info(int new_use_def);
884 const char *base_type(FormDict &globals);
885 // Form::DataType is_base_constant(FormDict &globals);
886
887 void dump(); // Debug printer
888 void output(FILE *fp); // Write to output files
889
890 public:
891 // Implementation depends upon working bit intersection and union.
892 enum use_def_enum {
893 INVALID = 0x0,
894 USE = 0x1,
895 DEF = 0x2, USE_DEF = 0x3,
896 KILL = 0x4, USE_KILL = 0x5,
897 SYNTHETIC = 0x8,
898 TEMP = USE | SYNTHETIC
899 };
900 };
901
902
903 //------------------------------MatchNode--------------------------------------
904 class MatchNode : public Form {
905 private:
906
907 public:
908 // Public Data
909 const char *_result; // The name of the output of this node
910 const char *_name; // The name that appeared in the match rule
911 const char *_opType; // The Operation/Type matched
912 MatchNode *_lChild; // Left child in expression tree
913 MatchNode *_rChild; // Right child in expression tree
914 int _numleaves; // Sum of numleaves for all direct children
915 ArchDesc &_AD; // Reference to ArchDesc object
916 char *_internalop; // String representing internal operand
917 int _commutative_id; // id of commutative operation
918
919 // Public Methods
920 MatchNode(ArchDesc &ad, const char *result = 0, const char *expr = 0,
921 const char *opType=0, MatchNode *lChild=NULL,
922 MatchNode *rChild=NULL);
923 MatchNode(ArchDesc &ad, MatchNode& mNode); // Shallow copy constructor;
924 MatchNode(ArchDesc &ad, MatchNode& mNode, int clone); // Construct clone
925 ~MatchNode();
926
927 // return 0 if not found:
928 // return 1 if found and position is incremented by operand offset in rule
929 bool find_name(const char *str, int &position) const;
930 bool find_type(const char *str, int &position) const;
931 virtual void append_components(FormDict& locals, ComponentList& components,
932 bool def_flag = false) const;
933 bool base_operand(uint &position, FormDict &globals,
934 const char * &result, const char * &name,
935 const char * &opType) const;
936 // recursive count on operands
937 uint num_consts(FormDict &globals) const;
938 uint num_const_ptrs(FormDict &globals) const;
939 // recursive count of constants with specified type
940 uint num_consts(FormDict &globals, Form::DataType type) const;
941 // uint num_consts() const; // Local inspection only
942 int needs_ideal_memory_edge(FormDict &globals) const;
943 int needs_base_oop_edge() const;
944
945 // Help build instruction predicates. Search for operand names.
946 void count_instr_names( Dict &names );
947 int build_instr_pred( char *buf, const char *name, int cnt );
948 void build_internalop( );
949
950 // Return the name of the operands associated with reducing to this operand:
951 // The result type, plus the left and right sides of the binary match
952 // Return NULL if there is no left or right hand side
953 bool sets_result() const; // rule "Set"s result of match
954 const char *reduce_right(FormDict &globals) const;
955 const char *reduce_left (FormDict &globals) const;
956
957 // Recursive version of check in MatchRule
958 int cisc_spill_match(FormDict& globals, RegisterForm* registers,
959 MatchNode* mRule2, const char* &operand,
960 const char* ®_type);
961 int cisc_spill_merge(int left_result, int right_result);
962
963 virtual bool equivalent(FormDict& globals, MatchNode* mNode2);
964
965 void count_commutative_op(int& count);
966 void swap_commutative_op(bool atroot, int count);
967
968 void dump();
969 void output(FILE *fp);
970 };
971
972 //------------------------------MatchRule--------------------------------------
973 class MatchRule : public MatchNode {
974 private:
975
976 public:
977 // Public Data
978 const char *_machType; // Machine type index
979 int _depth; // Expression tree depth
980 char *_construct; // String representing C++ constructor code
981 int _numchilds; // Number of direct children
982 MatchRule *_next; // Pointer to next match rule
983
984 // Public Methods
985 MatchRule(ArchDesc &ad);
986 MatchRule(ArchDesc &ad, MatchRule* mRule); // Shallow copy constructor;
987 MatchRule(ArchDesc &ad, MatchNode* mroot, int depth, char* construct, int numleaves);
988 ~MatchRule();
989
990 virtual void append_components(FormDict& locals, ComponentList& components, bool def_flag = false) const;
991 // Recursive call on all operands' match rules in my match rule.
992 bool base_operand(uint &position, FormDict &globals,
993 const char * &result, const char * &name,
994 const char * &opType) const;
995
996
997 bool is_base_register(FormDict &globals) const;
998 Form::DataType is_base_constant(FormDict &globals) const;
999 bool is_chain_rule(FormDict &globals) const;
1000 int is_ideal_copy() const;
1001 int is_expensive() const; // node matches ideal 'CosD'
1002 bool is_ideal_if() const; // node matches ideal 'If'
1003 bool is_ideal_fastlock() const; // node matches ideal 'FastLock'
1004 bool is_ideal_jump() const; // node matches ideal 'Jump'
1005 bool is_ideal_membar() const; // node matches ideal 'MemBarXXX'
1006 bool is_ideal_loadPC() const; // node matches ideal 'LoadPC'
1007 bool is_ideal_box() const; // node matches ideal 'Box'
1008 bool is_ideal_goto() const; // node matches ideal 'Goto'
1009 bool is_ideal_loopEnd() const; // node matches ideal 'LoopEnd'
1010 bool is_ideal_bool() const; // node matches ideal 'Bool'
1011 Form::DataType is_ideal_load() const;// node matches ideal 'LoadXNode'
1012 // Should antidep checks be disabled for this rule
1013 // See definition of MatchRule::skip_antidep_check
1014 bool skip_antidep_check() const;
1015 Form::DataType is_ideal_store() const;// node matches ideal 'StoreXNode'
1016
1017 // Check if 'mRule2' is a cisc-spill variant of this MatchRule
1018 int matchrule_cisc_spill_match(FormDict &globals, RegisterForm* registers,
1019 MatchRule* mRule2, const char* &operand,
1020 const char* ®_type);
1021
1022 // Check if 'mRule2' is equivalent to this MatchRule
1023 virtual bool equivalent(FormDict& globals, MatchNode* mRule2);
1024
1025 void matchrule_swap_commutative_op(const char* instr_ident, int count, int& match_rules_cnt);
1026
1027 void dump();
1028 void output(FILE *fp);
1029 };
1030
1031 //------------------------------Attribute--------------------------------------
1032 class Attribute : public Form {
1033 private:
1034
1035 public:
1036 // Public Data
1037 char *_ident; // Name of predefined attribute
1038 char *_val; // C++ source which evaluates to constant
1039 int _atype; // Either INS_ATTR or OP_ATTR
1040 int int_val(ArchDesc &ad); // Return atoi(_val), ensuring syntax.
1041
1042 // Public Methods
1043 Attribute(char *id, char* val, int type);
1044 ~Attribute();
1045
1046 void dump();
1047 void output(FILE *fp);
1048 };
1049
1050 //------------------------------FormatRule-------------------------------------
1051 class FormatRule : public Form {
1052 private:
1053
1054 public:
1055 // Public Data
1056 // There is an entry in _strings, perhaps NULL, that precedes each _rep_vars
1057 NameList _strings; // Strings passed through to tty->print
1058 NameList _rep_vars; // replacement variables
1059 char *_temp; // String representing the assembly code
1060
1061 // Public Methods
1062 FormatRule(char *temp);
1063 ~FormatRule();
1064
1065 void dump();
1066 void output(FILE *fp);
1067 };
1068
1069 #endif // SHARE_VM_ADLC_FORMSSEL_HPP