1 /*
   2  * Copyright 1998-2008 Sun Microsystems, Inc.  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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  20  * CA 95054 USA or visit www.sun.com if you need additional information or
  21  * have any questions.
  22  *
  23  */
  24 
  25 // FORMS.CPP - Definitions for ADL Parser Forms Classes
  26 #include "adlc.hpp"
  27 
  28 //==============================Instructions===================================
  29 //------------------------------InstructForm-----------------------------------
  30 InstructForm::InstructForm(const char *id, bool ideal_only)
  31   : _ident(id), _ideal_only(ideal_only),
  32     _localNames(cmpstr, hashstr, Form::arena),
  33     _effects(cmpstr, hashstr, Form::arena) {
  34       _ftype = Form::INS;
  35 
  36       _matrule   = NULL;
  37       _insencode = NULL;
  38       _opcode    = NULL;
  39       _size      = NULL;
  40       _attribs   = NULL;
  41       _predicate = NULL;
  42       _exprule   = NULL;
  43       _rewrule   = NULL;
  44       _format    = NULL;
  45       _peephole  = NULL;
  46       _ins_pipe  = NULL;
  47       _uniq_idx  = NULL;
  48       _num_uniq  = 0;
  49       _cisc_spill_operand = Not_cisc_spillable;// Which operand may cisc-spill
  50       _cisc_spill_alternate = NULL;            // possible cisc replacement
  51       _cisc_reg_mask_name = NULL;
  52       _is_cisc_alternate = false;
  53       _is_short_branch = false;
  54       _short_branch_form = NULL;
  55       _alignment = 1;
  56 }
  57 
  58 InstructForm::InstructForm(const char *id, InstructForm *instr, MatchRule *rule)
  59   : _ident(id), _ideal_only(false),
  60     _localNames(instr->_localNames),
  61     _effects(instr->_effects) {
  62       _ftype = Form::INS;
  63 
  64       _matrule   = rule;
  65       _insencode = instr->_insencode;
  66       _opcode    = instr->_opcode;
  67       _size      = instr->_size;
  68       _attribs   = instr->_attribs;
  69       _predicate = instr->_predicate;
  70       _exprule   = instr->_exprule;
  71       _rewrule   = instr->_rewrule;
  72       _format    = instr->_format;
  73       _peephole  = instr->_peephole;
  74       _ins_pipe  = instr->_ins_pipe;
  75       _uniq_idx  = instr->_uniq_idx;
  76       _num_uniq  = instr->_num_uniq;
  77       _cisc_spill_operand = Not_cisc_spillable;// Which operand may cisc-spill
  78       _cisc_spill_alternate = NULL;            // possible cisc replacement
  79       _cisc_reg_mask_name = NULL;
  80       _is_cisc_alternate = false;
  81       _is_short_branch = false;
  82       _short_branch_form = NULL;
  83       _alignment = 1;
  84      // Copy parameters
  85      const char *name;
  86      instr->_parameters.reset();
  87      for (; (name = instr->_parameters.iter()) != NULL;)
  88        _parameters.addName(name);
  89 }
  90 
  91 InstructForm::~InstructForm() {
  92 }
  93 
  94 InstructForm *InstructForm::is_instruction() const {
  95   return (InstructForm*)this;
  96 }
  97 
  98 bool InstructForm::ideal_only() const {
  99   return _ideal_only;
 100 }
 101 
 102 bool InstructForm::sets_result() const {
 103   return (_matrule != NULL && _matrule->sets_result());
 104 }
 105 
 106 bool InstructForm::needs_projections() {
 107   _components.reset();
 108   for( Component *comp; (comp = _components.iter()) != NULL; ) {
 109     if (comp->isa(Component::KILL)) {
 110       return true;
 111     }
 112   }
 113   return false;
 114 }
 115 
 116 
 117 bool InstructForm::has_temps() {
 118   if (_matrule) {
 119     // Examine each component to see if it is a TEMP
 120     _components.reset();
 121     // Skip the first component, if already handled as (SET dst (...))
 122     Component *comp = NULL;
 123     if (sets_result())  comp = _components.iter();
 124     while ((comp = _components.iter()) != NULL) {
 125       if (comp->isa(Component::TEMP)) {
 126         return true;
 127       }
 128     }
 129   }
 130 
 131   return false;
 132 }
 133 
 134 uint InstructForm::num_defs_or_kills() {
 135   uint   defs_or_kills = 0;
 136 
 137   _components.reset();
 138   for( Component *comp; (comp = _components.iter()) != NULL; ) {
 139     if( comp->isa(Component::DEF) || comp->isa(Component::KILL) ) {
 140       ++defs_or_kills;
 141     }
 142   }
 143 
 144   return  defs_or_kills;
 145 }
 146 
 147 // This instruction has an expand rule?
 148 bool InstructForm::expands() const {
 149   return ( _exprule != NULL );
 150 }
 151 
 152 // This instruction has a peephole rule?
 153 Peephole *InstructForm::peepholes() const {
 154   return _peephole;
 155 }
 156 
 157 // This instruction has a peephole rule?
 158 void InstructForm::append_peephole(Peephole *peephole) {
 159   if( _peephole == NULL ) {
 160     _peephole = peephole;
 161   } else {
 162     _peephole->append_peephole(peephole);
 163   }
 164 }
 165 
 166 
 167 // ideal opcode enumeration
 168 const char *InstructForm::ideal_Opcode( FormDict &globalNames )  const {
 169   if( !_matrule ) return "Node"; // Something weird
 170   // Chain rules do not really have ideal Opcodes; use their source
 171   // operand ideal Opcode instead.
 172   if( is_simple_chain_rule(globalNames) ) {
 173     const char *src = _matrule->_rChild->_opType;
 174     OperandForm *src_op = globalNames[src]->is_operand();
 175     assert( src_op, "Not operand class of chain rule" );
 176     if( !src_op->_matrule ) return "Node";
 177     return src_op->_matrule->_opType;
 178   }
 179   // Operand chain rules do not really have ideal Opcodes
 180   if( _matrule->is_chain_rule(globalNames) )
 181     return "Node";
 182   return strcmp(_matrule->_opType,"Set")
 183     ? _matrule->_opType
 184     : _matrule->_rChild->_opType;
 185 }
 186 
 187 // Recursive check on all operands' match rules in my match rule
 188 bool InstructForm::is_pinned(FormDict &globals) {
 189   if ( ! _matrule)  return false;
 190 
 191   int  index   = 0;
 192   if (_matrule->find_type("Goto",          index)) return true;
 193   if (_matrule->find_type("If",            index)) return true;
 194   if (_matrule->find_type("CountedLoopEnd",index)) return true;
 195   if (_matrule->find_type("Return",        index)) return true;
 196   if (_matrule->find_type("Rethrow",       index)) return true;
 197   if (_matrule->find_type("TailCall",      index)) return true;
 198   if (_matrule->find_type("TailJump",      index)) return true;
 199   if (_matrule->find_type("Halt",          index)) return true;
 200   if (_matrule->find_type("Jump",          index)) return true;
 201 
 202   return is_parm(globals);
 203 }
 204 
 205 // Recursive check on all operands' match rules in my match rule
 206 bool InstructForm::is_projection(FormDict &globals) {
 207   if ( ! _matrule)  return false;
 208 
 209   int  index   = 0;
 210   if (_matrule->find_type("Goto",    index)) return true;
 211   if (_matrule->find_type("Return",  index)) return true;
 212   if (_matrule->find_type("Rethrow", index)) return true;
 213   if (_matrule->find_type("TailCall",index)) return true;
 214   if (_matrule->find_type("TailJump",index)) return true;
 215   if (_matrule->find_type("Halt",    index)) return true;
 216 
 217   return false;
 218 }
 219 
 220 // Recursive check on all operands' match rules in my match rule
 221 bool InstructForm::is_parm(FormDict &globals) {
 222   if ( ! _matrule)  return false;
 223 
 224   int  index   = 0;
 225   if (_matrule->find_type("Parm",index)) return true;
 226 
 227   return false;
 228 }
 229 
 230 
 231 // Return 'true' if this instruction matches an ideal 'Copy*' node
 232 int InstructForm::is_ideal_copy() const {
 233   return _matrule ? _matrule->is_ideal_copy() : 0;
 234 }
 235 
 236 // Return 'true' if this instruction is too complex to rematerialize.
 237 int InstructForm::is_expensive() const {
 238   // We can prove it is cheap if it has an empty encoding.
 239   // This helps with platform-specific nops like ThreadLocal and RoundFloat.
 240   if (is_empty_encoding())
 241     return 0;
 242 
 243   if (is_tls_instruction())
 244     return 1;
 245 
 246   if (_matrule == NULL)  return 0;
 247 
 248   return _matrule->is_expensive();
 249 }
 250 
 251 // Has an empty encoding if _size is a constant zero or there
 252 // are no ins_encode tokens.
 253 int InstructForm::is_empty_encoding() const {
 254   if (_insencode != NULL) {
 255     _insencode->reset();
 256     if (_insencode->encode_class_iter() == NULL) {
 257       return 1;
 258     }
 259   }
 260   if (_size != NULL && strcmp(_size, "0") == 0) {
 261     return 1;
 262   }
 263   return 0;
 264 }
 265 
 266 int InstructForm::is_tls_instruction() const {
 267   if (_ident != NULL &&
 268       ( ! strcmp( _ident,"tlsLoadP") ||
 269         ! strncmp(_ident,"tlsLoadP_",9)) ) {
 270     return 1;
 271   }
 272 
 273   if (_matrule != NULL && _insencode != NULL) {
 274     const char* opType = _matrule->_opType;
 275     if (strcmp(opType, "Set")==0)
 276       opType = _matrule->_rChild->_opType;
 277     if (strcmp(opType,"ThreadLocal")==0) {
 278       fprintf(stderr, "Warning: ThreadLocal instruction %s should be named 'tlsLoadP_*'\n",
 279               (_ident == NULL ? "NULL" : _ident));
 280       return 1;
 281     }
 282   }
 283 
 284   return 0;
 285 }
 286 
 287 
 288 // Return 'true' if this instruction matches an ideal 'Copy*' node
 289 bool InstructForm::is_ideal_unlock() const {
 290   return _matrule ? _matrule->is_ideal_unlock() : false;
 291 }
 292 
 293 bool InstructForm::is_ideal_call_leaf() const {
 294   return _matrule ? _matrule->is_ideal_call_leaf() : false;
 295 }
 296 
 297 // Return 'true' if this instruction matches an ideal 'If' node
 298 bool InstructForm::is_ideal_if() const {
 299   if( _matrule == NULL ) return false;
 300 
 301   return _matrule->is_ideal_if();
 302 }
 303 
 304 // Return 'true' if this instruction matches an ideal 'FastLock' node
 305 bool InstructForm::is_ideal_fastlock() const {
 306   if( _matrule == NULL ) return false;
 307 
 308   return _matrule->is_ideal_fastlock();
 309 }
 310 
 311 // Return 'true' if this instruction matches an ideal 'MemBarXXX' node
 312 bool InstructForm::is_ideal_membar() const {
 313   if( _matrule == NULL ) return false;
 314 
 315   return _matrule->is_ideal_membar();
 316 }
 317 
 318 // Return 'true' if this instruction matches an ideal 'LoadPC' node
 319 bool InstructForm::is_ideal_loadPC() const {
 320   if( _matrule == NULL ) return false;
 321 
 322   return _matrule->is_ideal_loadPC();
 323 }
 324 
 325 // Return 'true' if this instruction matches an ideal 'Box' node
 326 bool InstructForm::is_ideal_box() const {
 327   if( _matrule == NULL ) return false;
 328 
 329   return _matrule->is_ideal_box();
 330 }
 331 
 332 // Return 'true' if this instruction matches an ideal 'Goto' node
 333 bool InstructForm::is_ideal_goto() const {
 334   if( _matrule == NULL ) return false;
 335 
 336   return _matrule->is_ideal_goto();
 337 }
 338 
 339 // Return 'true' if this instruction matches an ideal 'Jump' node
 340 bool InstructForm::is_ideal_jump() const {
 341   if( _matrule == NULL ) return false;
 342 
 343   return _matrule->is_ideal_jump();
 344 }
 345 
 346 // Return 'true' if instruction matches ideal 'If' | 'Goto' |
 347 //                    'CountedLoopEnd' | 'Jump'
 348 bool InstructForm::is_ideal_branch() const {
 349   if( _matrule == NULL ) return false;
 350 
 351   return _matrule->is_ideal_if() || _matrule->is_ideal_goto() || _matrule->is_ideal_jump();
 352 }
 353 
 354 
 355 // Return 'true' if this instruction matches an ideal 'Return' node
 356 bool InstructForm::is_ideal_return() const {
 357   if( _matrule == NULL ) return false;
 358 
 359   // Check MatchRule to see if the first entry is the ideal "Return" node
 360   int  index   = 0;
 361   if (_matrule->find_type("Return",index)) return true;
 362   if (_matrule->find_type("Rethrow",index)) return true;
 363   if (_matrule->find_type("TailCall",index)) return true;
 364   if (_matrule->find_type("TailJump",index)) return true;
 365 
 366   return false;
 367 }
 368 
 369 // Return 'true' if this instruction matches an ideal 'Halt' node
 370 bool InstructForm::is_ideal_halt() const {
 371   int  index   = 0;
 372   return _matrule && _matrule->find_type("Halt",index);
 373 }
 374 
 375 // Return 'true' if this instruction matches an ideal 'SafePoint' node
 376 bool InstructForm::is_ideal_safepoint() const {
 377   int  index   = 0;
 378   return _matrule && _matrule->find_type("SafePoint",index);
 379 }
 380 
 381 // Return 'true' if this instruction matches an ideal 'Nop' node
 382 bool InstructForm::is_ideal_nop() const {
 383   return _ident && _ident[0] == 'N' && _ident[1] == 'o' && _ident[2] == 'p' && _ident[3] == '_';
 384 }
 385 
 386 bool InstructForm::is_ideal_control() const {
 387   if ( ! _matrule)  return false;
 388 
 389   return is_ideal_return() || is_ideal_branch() || is_ideal_halt();
 390 }
 391 
 392 // Return 'true' if this instruction matches an ideal 'Call' node
 393 Form::CallType InstructForm::is_ideal_call() const {
 394   if( _matrule == NULL ) return Form::invalid_type;
 395 
 396   // Check MatchRule to see if the first entry is the ideal "Call" node
 397   int  idx   = 0;
 398   if(_matrule->find_type("CallStaticJava",idx))   return Form::JAVA_STATIC;
 399   idx = 0;
 400   if(_matrule->find_type("Lock",idx))             return Form::JAVA_STATIC;
 401   idx = 0;
 402   if(_matrule->find_type("Unlock",idx))           return Form::JAVA_STATIC;
 403   idx = 0;
 404   if(_matrule->find_type("CallDynamicJava",idx))  return Form::JAVA_DYNAMIC;
 405   idx = 0;
 406   if(_matrule->find_type("CallRuntime",idx))      return Form::JAVA_RUNTIME;
 407   idx = 0;
 408   if(_matrule->find_type("CallLeaf",idx))         return Form::JAVA_LEAF;
 409   idx = 0;
 410   if(_matrule->find_type("CallLeafNoFP",idx))     return Form::JAVA_LEAF;
 411   idx = 0;
 412 
 413   return Form::invalid_type;
 414 }
 415 
 416 // Return 'true' if this instruction matches an ideal 'Load?' node
 417 Form::DataType InstructForm::is_ideal_load() const {
 418   if( _matrule == NULL ) return Form::none;
 419 
 420   return  _matrule->is_ideal_load();
 421 }
 422 
 423 // Return 'true' if this instruction matches an ideal 'Load?' node
 424 Form::DataType InstructForm::is_ideal_store() const {
 425   if( _matrule == NULL ) return Form::none;
 426 
 427   return  _matrule->is_ideal_store();
 428 }
 429 
 430 // Return the input register that must match the output register
 431 // If this is not required, return 0
 432 uint InstructForm::two_address(FormDict &globals) {
 433   uint  matching_input = 0;
 434   if(_components.count() == 0) return 0;
 435 
 436   _components.reset();
 437   Component *comp = _components.iter();
 438   // Check if there is a DEF
 439   if( comp->isa(Component::DEF) ) {
 440     // Check that this is a register
 441     const char  *def_type = comp->_type;
 442     const Form  *form     = globals[def_type];
 443     OperandForm *op       = form->is_operand();
 444     if( op ) {
 445       if( op->constrained_reg_class() != NULL &&
 446           op->interface_type(globals) == Form::register_interface ) {
 447         // Remember the local name for equality test later
 448         const char *def_name = comp->_name;
 449         // Check if a component has the same name and is a USE
 450         do {
 451           if( comp->isa(Component::USE) && strcmp(comp->_name,def_name)==0 ) {
 452             return operand_position_format(def_name);
 453           }
 454         } while( (comp = _components.iter()) != NULL);
 455       }
 456     }
 457   }
 458 
 459   return 0;
 460 }
 461 
 462 
 463 // when chaining a constant to an instruction, returns 'true' and sets opType
 464 Form::DataType InstructForm::is_chain_of_constant(FormDict &globals) {
 465   const char *dummy  = NULL;
 466   const char *dummy2 = NULL;
 467   return is_chain_of_constant(globals, dummy, dummy2);
 468 }
 469 Form::DataType InstructForm::is_chain_of_constant(FormDict &globals,
 470                 const char * &opTypeParam) {
 471   const char *result = NULL;
 472 
 473   return is_chain_of_constant(globals, opTypeParam, result);
 474 }
 475 
 476 Form::DataType InstructForm::is_chain_of_constant(FormDict &globals,
 477                 const char * &opTypeParam, const char * &resultParam) {
 478   Form::DataType  data_type = Form::none;
 479   if ( ! _matrule)  return data_type;
 480 
 481   // !!!!!
 482   // The source of the chain rule is 'position = 1'
 483   uint         position = 1;
 484   const char  *result   = NULL;
 485   const char  *name     = NULL;
 486   const char  *opType   = NULL;
 487   // Here base_operand is looking for an ideal type to be returned (opType).
 488   if ( _matrule->is_chain_rule(globals)
 489        && _matrule->base_operand(position, globals, result, name, opType) ) {
 490     data_type = ideal_to_const_type(opType);
 491 
 492     // if it isn't an ideal constant type, just return
 493     if ( data_type == Form::none ) return data_type;
 494 
 495     // Ideal constant types also adjust the opType parameter.
 496     resultParam = result;
 497     opTypeParam = opType;
 498     return data_type;
 499   }
 500 
 501   return data_type;
 502 }
 503 
 504 // Check if a simple chain rule
 505 bool InstructForm::is_simple_chain_rule(FormDict &globals) const {
 506   if( _matrule && _matrule->sets_result()
 507       && _matrule->_rChild->_lChild == NULL
 508       && globals[_matrule->_rChild->_opType]
 509       && globals[_matrule->_rChild->_opType]->is_opclass() ) {
 510     return true;
 511   }
 512   return false;
 513 }
 514 
 515 // check for structural rematerialization
 516 bool InstructForm::rematerialize(FormDict &globals, RegisterForm *registers ) {
 517   bool   rematerialize = false;
 518 
 519   Form::DataType data_type = is_chain_of_constant(globals);
 520   if( data_type != Form::none )
 521     rematerialize = true;
 522 
 523   // Constants
 524   if( _components.count() == 1 && _components[0]->is(Component::USE_DEF) )
 525     rematerialize = true;
 526 
 527   // Pseudo-constants (values easily available to the runtime)
 528   if (is_empty_encoding() && is_tls_instruction())
 529     rematerialize = true;
 530 
 531   // 1-input, 1-output, such as copies or increments.
 532   if( _components.count() == 2 &&
 533       _components[0]->is(Component::DEF) &&
 534       _components[1]->isa(Component::USE) )
 535     rematerialize = true;
 536 
 537   // Check for an ideal 'Load?' and eliminate rematerialize option
 538   if ( is_ideal_load() != Form::none || // Ideal load?  Do not rematerialize
 539        is_ideal_copy() != Form::none || // Ideal copy?  Do not rematerialize
 540        is_expensive()  != Form::none) { // Expensive?   Do not rematerialize
 541     rematerialize = false;
 542   }
 543 
 544   // Always rematerialize the flags.  They are more expensive to save &
 545   // restore than to recompute (and possibly spill the compare's inputs).
 546   if( _components.count() >= 1 ) {
 547     Component *c = _components[0];
 548     const Form *form = globals[c->_type];
 549     OperandForm *opform = form->is_operand();
 550     if( opform ) {
 551       // Avoid the special stack_slots register classes
 552       const char *rc_name = opform->constrained_reg_class();
 553       if( rc_name ) {
 554         if( strcmp(rc_name,"stack_slots") ) {
 555           // Check for ideal_type of RegFlags
 556           const char *type = opform->ideal_type( globals, registers );
 557           if( !strcmp(type,"RegFlags") )
 558             rematerialize = true;
 559         } else
 560           rematerialize = false; // Do not rematerialize things target stk
 561       }
 562     }
 563   }
 564 
 565   return rematerialize;
 566 }
 567 
 568 // loads from memory, so must check for anti-dependence
 569 bool InstructForm::needs_anti_dependence_check(FormDict &globals) const {
 570   // Machine independent loads must be checked for anti-dependences
 571   if( is_ideal_load() != Form::none )  return true;
 572 
 573   // !!!!! !!!!! !!!!!
 574   // TEMPORARY
 575   // if( is_simple_chain_rule(globals) )  return false;
 576 
 577 // String.(compareTo/equals/indexOf) and Arrays.equals use many memorys edges, 
 578 // but writes none
 579   if( _matrule && _matrule->_rChild &&
 580       (strcmp(_matrule->_rChild->_opType,"StrComp")==0    ||
 581        strcmp(_matrule->_rChild->_opType,"StrEquals")==0  ||
 582        strcmp(_matrule->_rChild->_opType,"StrIndexOf")==0 ||
 583        strcmp(_matrule->_rChild->_opType,"AryEq")==0)) 
 584     return true;
 585 
 586   // Check if instruction has a USE of a memory operand class, but no defs
 587   bool USE_of_memory  = false;
 588   bool DEF_of_memory  = false;
 589   Component     *comp = NULL;
 590   ComponentList &components = (ComponentList &)_components;
 591 
 592   components.reset();
 593   while( (comp = components.iter()) != NULL ) {
 594     const Form  *form = globals[comp->_type];
 595     if( !form ) continue;
 596     OpClassForm *op   = form->is_opclass();
 597     if( !op ) continue;
 598     if( form->interface_type(globals) == Form::memory_interface ) {
 599       if( comp->isa(Component::USE) ) USE_of_memory = true;
 600       if( comp->isa(Component::DEF) ) {
 601         OperandForm *oper = form->is_operand();
 602         if( oper && oper->is_user_name_for_sReg() ) {
 603           // Stack slots are unaliased memory handled by allocator
 604           oper = oper;  // debug stopping point !!!!!
 605         } else {
 606           DEF_of_memory = true;
 607         }
 608       }
 609     }
 610   }
 611   return (USE_of_memory && !DEF_of_memory);
 612 }
 613 
 614 
 615 bool InstructForm::is_wide_memory_kill(FormDict &globals) const {
 616   if( _matrule == NULL ) return false;
 617   if( !_matrule->_opType ) return false;
 618 
 619   if( strcmp(_matrule->_opType,"MemBarRelease") == 0 ) return true;
 620   if( strcmp(_matrule->_opType,"MemBarAcquire") == 0 ) return true;
 621 
 622   return false;
 623 }
 624 
 625 int InstructForm::memory_operand(FormDict &globals) const {
 626   // Machine independent loads must be checked for anti-dependences
 627   // Check if instruction has a USE of a memory operand class, or a def.
 628   int USE_of_memory  = 0;
 629   int DEF_of_memory  = 0;
 630   const char*    last_memory_DEF = NULL; // to test DEF/USE pairing in asserts
 631   Component     *unique          = NULL;
 632   Component     *comp            = NULL;
 633   ComponentList &components      = (ComponentList &)_components;
 634 
 635   components.reset();
 636   while( (comp = components.iter()) != NULL ) {
 637     const Form  *form = globals[comp->_type];
 638     if( !form ) continue;
 639     OpClassForm *op   = form->is_opclass();
 640     if( !op ) continue;
 641     if( op->stack_slots_only(globals) )  continue;
 642     if( form->interface_type(globals) == Form::memory_interface ) {
 643       if( comp->isa(Component::DEF) ) {
 644         last_memory_DEF = comp->_name;
 645         DEF_of_memory++;
 646         unique = comp;
 647       } else if( comp->isa(Component::USE) ) {
 648         if( last_memory_DEF != NULL ) {
 649           assert(0 == strcmp(last_memory_DEF, comp->_name), "every memory DEF is followed by a USE of the same name");
 650           last_memory_DEF = NULL;
 651         }
 652         USE_of_memory++;
 653         if (DEF_of_memory == 0)  // defs take precedence
 654           unique = comp;
 655       } else {
 656         assert(last_memory_DEF == NULL, "unpaired memory DEF");
 657       }
 658     }
 659   }
 660   assert(last_memory_DEF == NULL, "unpaired memory DEF");
 661   assert(USE_of_memory >= DEF_of_memory, "unpaired memory DEF");
 662   USE_of_memory -= DEF_of_memory;   // treat paired DEF/USE as one occurrence
 663   if( (USE_of_memory + DEF_of_memory) > 0 ) {
 664     if( is_simple_chain_rule(globals) ) {
 665       //fprintf(stderr, "Warning: chain rule is not really a memory user.\n");
 666       //((InstructForm*)this)->dump();
 667       // Preceding code prints nothing on sparc and these insns on intel:
 668       // leaP8 leaP32 leaPIdxOff leaPIdxScale leaPIdxScaleOff leaP8 leaP32
 669       // leaPIdxOff leaPIdxScale leaPIdxScaleOff
 670       return NO_MEMORY_OPERAND;
 671     }
 672 
 673     if( DEF_of_memory == 1 ) {
 674       assert(unique != NULL, "");
 675       if( USE_of_memory == 0 ) {
 676         // unique def, no uses
 677       } else {
 678         // // unique def, some uses
 679         // // must return bottom unless all uses match def
 680         // unique = NULL;
 681       }
 682     } else if( DEF_of_memory > 0 ) {
 683       // multiple defs, don't care about uses
 684       unique = NULL;
 685     } else if( USE_of_memory == 1) {
 686       // unique use, no defs
 687       assert(unique != NULL, "");
 688     } else if( USE_of_memory > 0 ) {
 689       // multiple uses, no defs
 690       unique = NULL;
 691     } else {
 692       assert(false, "bad case analysis");
 693     }
 694     // process the unique DEF or USE, if there is one
 695     if( unique == NULL ) {
 696       return MANY_MEMORY_OPERANDS;
 697     } else {
 698       int pos = components.operand_position(unique->_name);
 699       if( unique->isa(Component::DEF) ) {
 700         pos += 1;                // get corresponding USE from DEF
 701       }
 702       assert(pos >= 1, "I was just looking at it!");
 703       return pos;
 704     }
 705   }
 706 
 707   // missed the memory op??
 708   if( true ) {  // %%% should not be necessary
 709     if( is_ideal_store() != Form::none ) {
 710       fprintf(stderr, "Warning: cannot find memory opnd in instr.\n");
 711       ((InstructForm*)this)->dump();
 712       // pretend it has multiple defs and uses
 713       return MANY_MEMORY_OPERANDS;
 714     }
 715     if( is_ideal_load()  != Form::none ) {
 716       fprintf(stderr, "Warning: cannot find memory opnd in instr.\n");
 717       ((InstructForm*)this)->dump();
 718       // pretend it has multiple uses and no defs
 719       return MANY_MEMORY_OPERANDS;
 720     }
 721   }
 722 
 723   return NO_MEMORY_OPERAND;
 724 }
 725 
 726 
 727 // This instruction captures the machine-independent bottom_type
 728 // Expected use is for pointer vs oop determination for LoadP
 729 bool InstructForm::captures_bottom_type() const {
 730   if( _matrule && _matrule->_rChild &&
 731        (!strcmp(_matrule->_rChild->_opType,"CastPP")     ||  // new result type
 732         !strcmp(_matrule->_rChild->_opType,"CastX2P")    ||  // new result type
 733         !strcmp(_matrule->_rChild->_opType,"DecodeN")    ||
 734         !strcmp(_matrule->_rChild->_opType,"EncodeP")    ||
 735         !strcmp(_matrule->_rChild->_opType,"LoadN")      ||
 736         !strcmp(_matrule->_rChild->_opType,"LoadNKlass") ||
 737         !strcmp(_matrule->_rChild->_opType,"CreateEx")   ||  // type of exception
 738         !strcmp(_matrule->_rChild->_opType,"CheckCastPP")) ) return true;
 739   else if ( is_ideal_load() == Form::idealP )                return true;
 740   else if ( is_ideal_store() != Form::none  )                return true;
 741 
 742   return  false;
 743 }
 744 
 745 
 746 // Access instr_cost attribute or return NULL.
 747 const char* InstructForm::cost() {
 748   for (Attribute* cur = _attribs; cur != NULL; cur = (Attribute*)cur->_next) {
 749     if( strcmp(cur->_ident,AttributeForm::_ins_cost) == 0 ) {
 750       return cur->_val;
 751     }
 752   }
 753   return NULL;
 754 }
 755 
 756 // Return count of top-level operands.
 757 uint InstructForm::num_opnds() {
 758   int  num_opnds = _components.num_operands();
 759 
 760   // Need special handling for matching some ideal nodes
 761   // i.e. Matching a return node
 762   /*
 763   if( _matrule ) {
 764     if( strcmp(_matrule->_opType,"Return"   )==0 ||
 765         strcmp(_matrule->_opType,"Halt"     )==0 )
 766       return 3;
 767   }
 768     */
 769   return num_opnds;
 770 }
 771 
 772 // Return count of unmatched operands.
 773 uint InstructForm::num_post_match_opnds() {
 774   uint  num_post_match_opnds = _components.count();
 775   uint  num_match_opnds = _components.match_count();
 776   num_post_match_opnds = num_post_match_opnds - num_match_opnds;
 777 
 778   return num_post_match_opnds;
 779 }
 780 
 781 // Return the number of leaves below this complex operand
 782 uint InstructForm::num_consts(FormDict &globals) const {
 783   if ( ! _matrule) return 0;
 784 
 785   // This is a recursive invocation on all operands in the matchrule
 786   return _matrule->num_consts(globals);
 787 }
 788 
 789 // Constants in match rule with specified type
 790 uint InstructForm::num_consts(FormDict &globals, Form::DataType type) const {
 791   if ( ! _matrule) return 0;
 792 
 793   // This is a recursive invocation on all operands in the matchrule
 794   return _matrule->num_consts(globals, type);
 795 }
 796 
 797 
 798 // Return the register class associated with 'leaf'.
 799 const char *InstructForm::out_reg_class(FormDict &globals) {
 800   assert( false, "InstructForm::out_reg_class(FormDict &globals); Not Implemented");
 801 
 802   return NULL;
 803 }
 804 
 805 
 806 
 807 // Lookup the starting position of inputs we are interested in wrt. ideal nodes
 808 uint InstructForm::oper_input_base(FormDict &globals) {
 809   if( !_matrule ) return 1;     // Skip control for most nodes
 810 
 811   // Need special handling for matching some ideal nodes
 812   // i.e. Matching a return node
 813   if( strcmp(_matrule->_opType,"Return"    )==0 ||
 814       strcmp(_matrule->_opType,"Rethrow"   )==0 ||
 815       strcmp(_matrule->_opType,"TailCall"  )==0 ||
 816       strcmp(_matrule->_opType,"TailJump"  )==0 ||
 817       strcmp(_matrule->_opType,"SafePoint" )==0 ||
 818       strcmp(_matrule->_opType,"Halt"      )==0 )
 819     return AdlcVMDeps::Parms;   // Skip the machine-state edges
 820 
 821   if( _matrule->_rChild &&
 822       (strcmp(_matrule->_rChild->_opType,"StrComp")==0   ||
 823        strcmp(_matrule->_rChild->_opType,"StrEquals")==0 ||
 824        strcmp(_matrule->_rChild->_opType,"StrIndexOf")==0)) {
 825        // String.(compareTo/equals/indexOf) take 1 control and 4 memory edges.
 826     return 5;
 827   }
 828 
 829   // Check for handling of 'Memory' input/edge in the ideal world.
 830   // The AD file writer is shielded from knowledge of these edges.
 831   int base = 1;                 // Skip control
 832   base += _matrule->needs_ideal_memory_edge(globals);
 833 
 834   // Also skip the base-oop value for uses of derived oops.
 835   // The AD file writer is shielded from knowledge of these edges.
 836   base += needs_base_oop_edge(globals);
 837 
 838   return base;
 839 }
 840 
 841 // Implementation does not modify state of internal structures
 842 void InstructForm::build_components() {
 843   // Add top-level operands to the components
 844   if (_matrule)  _matrule->append_components(_localNames, _components);
 845 
 846   // Add parameters that "do not appear in match rule".
 847   bool has_temp = false;
 848   const char *name;
 849   const char *kill_name = NULL;
 850   for (_parameters.reset(); (name = _parameters.iter()) != NULL;) {
 851     OperandForm *opForm = (OperandForm*)_localNames[name];
 852 
 853     const Form *form = _effects[name];
 854     Effect     *e    = form ? form->is_effect() : NULL;
 855     if (e != NULL) {
 856       has_temp |= e->is(Component::TEMP);
 857 
 858       // KILLs must be declared after any TEMPs because TEMPs are real
 859       // uses so their operand numbering must directly follow the real
 860       // inputs from the match rule.  Fixing the numbering seems
 861       // complex so simply enforce the restriction during parse.
 862       if (kill_name != NULL &&
 863           e->isa(Component::TEMP) && !e->isa(Component::DEF)) {
 864         OperandForm* kill = (OperandForm*)_localNames[kill_name];
 865         globalAD->syntax_err(_linenum, "%s: %s %s must be at the end of the argument list\n",
 866                              _ident, kill->_ident, kill_name);
 867       } else if (e->isa(Component::KILL)) {
 868         kill_name = name;
 869       }
 870 
 871       // TEMPs are real uses and need to be among the first parameters
 872       // listed, otherwise the numbering of operands and inputs gets
 873       // screwy, so enforce this restriction during parse.
 874       if (kill_name != NULL &&
 875           e->isa(Component::TEMP) && !e->isa(Component::DEF)) {
 876         OperandForm* kill = (OperandForm*)_localNames[kill_name];
 877         globalAD->syntax_err(_linenum, "%s: %s %s must follow %s %s in the argument list\n",
 878                              _ident, kill->_ident, kill_name, opForm->_ident, name);
 879       } else if (e->isa(Component::KILL)) {
 880         kill_name = name;
 881       }
 882     }
 883 
 884     const Component *component  = _components.search(name);
 885     if ( component  == NULL ) {
 886       if (e) {
 887         _components.insert(name, opForm->_ident, e->_use_def, false);
 888         component = _components.search(name);
 889         if (component->isa(Component::USE) && !component->isa(Component::TEMP) && _matrule) {
 890           const Form *form = globalAD->globalNames()[component->_type];
 891           assert( form, "component type must be a defined form");
 892           OperandForm *op   = form->is_operand();
 893           if (op->_interface && op->_interface->is_RegInterface()) {
 894             globalAD->syntax_err(_linenum, "%s: illegal USE of non-input: %s %s\n",
 895                                  _ident, opForm->_ident, name);
 896           }
 897         }
 898       } else {
 899         // This would be a nice warning but it triggers in a few places in a benign way
 900         // if (_matrule != NULL && !expands()) {
 901         //   globalAD->syntax_err(_linenum, "%s: %s %s not mentioned in effect or match rule\n",
 902         //                        _ident, opForm->_ident, name);
 903         // }
 904         _components.insert(name, opForm->_ident, Component::INVALID, false);
 905       }
 906     }
 907     else if (e) {
 908       // Component was found in the list
 909       // Check if there is a new effect that requires an extra component.
 910       // This happens when adding 'USE' to a component that is not yet one.
 911       if ((!component->isa( Component::USE) && ((e->_use_def & Component::USE) != 0))) {
 912         if (component->isa(Component::USE) && _matrule) {
 913           const Form *form = globalAD->globalNames()[component->_type];
 914           assert( form, "component type must be a defined form");
 915           OperandForm *op   = form->is_operand();
 916           if (op->_interface && op->_interface->is_RegInterface()) {
 917             globalAD->syntax_err(_linenum, "%s: illegal USE of non-input: %s %s\n",
 918                                  _ident, opForm->_ident, name);
 919           }
 920         }
 921         _components.insert(name, opForm->_ident, e->_use_def, false);
 922       } else {
 923         Component  *comp = (Component*)component;
 924         comp->promote_use_def_info(e->_use_def);
 925       }
 926       // Component positions are zero based.
 927       int  pos  = _components.operand_position(name);
 928       assert( ! (component->isa(Component::DEF) && (pos >= 1)),
 929               "Component::DEF can only occur in the first position");
 930     }
 931   }
 932 
 933   // Resolving the interactions between expand rules and TEMPs would
 934   // be complex so simply disallow it.
 935   if (_matrule == NULL && has_temp) {
 936     globalAD->syntax_err(_linenum, "%s: TEMPs without match rule isn't supported\n", _ident);
 937   }
 938 
 939   return;
 940 }
 941 
 942 // Return zero-based position in component list;  -1 if not in list.
 943 int   InstructForm::operand_position(const char *name, int usedef) {
 944   return unique_opnds_idx(_components.operand_position(name, usedef));
 945 }
 946 
 947 int   InstructForm::operand_position_format(const char *name) {
 948   return unique_opnds_idx(_components.operand_position_format(name));
 949 }
 950 
 951 // Return zero-based position in component list; -1 if not in list.
 952 int   InstructForm::label_position() {
 953   return unique_opnds_idx(_components.label_position());
 954 }
 955 
 956 int   InstructForm::method_position() {
 957   return unique_opnds_idx(_components.method_position());
 958 }
 959 
 960 // Return number of relocation entries needed for this instruction.
 961 uint  InstructForm::reloc(FormDict &globals) {
 962   uint reloc_entries  = 0;
 963   // Check for "Call" nodes
 964   if ( is_ideal_call() )      ++reloc_entries;
 965   if ( is_ideal_return() )    ++reloc_entries;
 966   if ( is_ideal_safepoint() ) ++reloc_entries;
 967 
 968 
 969   // Check if operands MAYBE oop pointers, by checking for ConP elements
 970   // Proceed through the leaves of the match-tree and check for ConPs
 971   if ( _matrule != NULL ) {
 972     uint         position = 0;
 973     const char  *result   = NULL;
 974     const char  *name     = NULL;
 975     const char  *opType   = NULL;
 976     while (_matrule->base_operand(position, globals, result, name, opType)) {
 977       if ( strcmp(opType,"ConP") == 0 ) {
 978 #ifdef SPARC
 979         reloc_entries += 2; // 1 for sethi + 1 for setlo
 980 #else
 981         ++reloc_entries;
 982 #endif
 983       }
 984       ++position;
 985     }
 986   }
 987 
 988   // Above is only a conservative estimate
 989   // because it did not check contents of operand classes.
 990   // !!!!! !!!!!
 991   // Add 1 to reloc info for each operand class in the component list.
 992   Component  *comp;
 993   _components.reset();
 994   while ( (comp = _components.iter()) != NULL ) {
 995     const Form        *form = globals[comp->_type];
 996     assert( form, "Did not find component's type in global names");
 997     const OpClassForm *opc  = form->is_opclass();
 998     const OperandForm *oper = form->is_operand();
 999     if ( opc && (oper == NULL) ) {
1000       ++reloc_entries;
1001     } else if ( oper ) {
1002       // floats and doubles loaded out of method's constant pool require reloc info
1003       Form::DataType type = oper->is_base_constant(globals);
1004       if ( (type == Form::idealF) || (type == Form::idealD) ) {
1005         ++reloc_entries;
1006       }
1007     }
1008   }
1009 
1010   // Float and Double constants may come from the CodeBuffer table
1011   // and require relocatable addresses for access
1012   // !!!!!
1013   // Check for any component being an immediate float or double.
1014   Form::DataType data_type = is_chain_of_constant(globals);
1015   if( data_type==idealD || data_type==idealF ) {
1016 #ifdef SPARC
1017     // sparc required more relocation entries for floating constants
1018     // (expires 9/98)
1019     reloc_entries += 6;
1020 #else
1021     reloc_entries++;
1022 #endif
1023   }
1024 
1025   return reloc_entries;
1026 }
1027 
1028 // Utility function defined in archDesc.cpp
1029 extern bool is_def(int usedef);
1030 
1031 // Return the result of reducing an instruction
1032 const char *InstructForm::reduce_result() {
1033   const char* result = "Universe";  // default
1034   _components.reset();
1035   Component *comp = _components.iter();
1036   if (comp != NULL && comp->isa(Component::DEF)) {
1037     result = comp->_type;
1038     // Override this if the rule is a store operation:
1039     if (_matrule && _matrule->_rChild &&
1040         is_store_to_memory(_matrule->_rChild->_opType))
1041       result = "Universe";
1042   }
1043   return result;
1044 }
1045 
1046 // Return the name of the operand on the right hand side of the binary match
1047 // Return NULL if there is no right hand side
1048 const char *InstructForm::reduce_right(FormDict &globals)  const {
1049   if( _matrule == NULL ) return NULL;
1050   return  _matrule->reduce_right(globals);
1051 }
1052 
1053 // Similar for left
1054 const char *InstructForm::reduce_left(FormDict &globals)   const {
1055   if( _matrule == NULL ) return NULL;
1056   return  _matrule->reduce_left(globals);
1057 }
1058 
1059 
1060 // Base class for this instruction, MachNode except for calls
1061 const char *InstructForm::mach_base_class()  const {
1062   if( is_ideal_call() == Form::JAVA_STATIC ) {
1063     return "MachCallStaticJavaNode";
1064   }
1065   else if( is_ideal_call() == Form::JAVA_DYNAMIC ) {
1066     return "MachCallDynamicJavaNode";
1067   }
1068   else if( is_ideal_call() == Form::JAVA_RUNTIME ) {
1069     return "MachCallRuntimeNode";
1070   }
1071   else if( is_ideal_call() == Form::JAVA_LEAF ) {
1072     return "MachCallLeafNode";
1073   }
1074   else if (is_ideal_return()) {
1075     return "MachReturnNode";
1076   }
1077   else if (is_ideal_halt()) {
1078     return "MachHaltNode";
1079   }
1080   else if (is_ideal_safepoint()) {
1081     return "MachSafePointNode";
1082   }
1083   else if (is_ideal_if()) {
1084     return "MachIfNode";
1085   }
1086   else if (is_ideal_fastlock()) {
1087     return "MachFastLockNode";
1088   }
1089   else if (is_ideal_nop()) {
1090     return "MachNopNode";
1091   }
1092   else if (captures_bottom_type()) {
1093     return "MachTypeNode";
1094   } else {
1095     return "MachNode";
1096   }
1097   assert( false, "ShouldNotReachHere()");
1098   return NULL;
1099 }
1100 
1101 // Compare the instruction predicates for textual equality
1102 bool equivalent_predicates( const InstructForm *instr1, const InstructForm *instr2 ) {
1103   const Predicate *pred1  = instr1->_predicate;
1104   const Predicate *pred2  = instr2->_predicate;
1105   if( pred1 == NULL && pred2 == NULL ) {
1106     // no predicates means they are identical
1107     return true;
1108   }
1109   if( pred1 != NULL && pred2 != NULL ) {
1110     // compare the predicates
1111     if (ADLParser::equivalent_expressions(pred1->_pred, pred2->_pred)) {
1112       return true;
1113     }
1114   }
1115 
1116   return false;
1117 }
1118 
1119 // Check if this instruction can cisc-spill to 'alternate'
1120 bool InstructForm::cisc_spills_to(ArchDesc &AD, InstructForm *instr) {
1121   assert( _matrule != NULL && instr->_matrule != NULL, "must have match rules");
1122   // Do not replace if a cisc-version has been found.
1123   if( cisc_spill_operand() != Not_cisc_spillable ) return false;
1124 
1125   int         cisc_spill_operand = Maybe_cisc_spillable;
1126   char       *result             = NULL;
1127   char       *result2            = NULL;
1128   const char *op_name            = NULL;
1129   const char *reg_type           = NULL;
1130   FormDict   &globals            = AD.globalNames();
1131   cisc_spill_operand = _matrule->cisc_spill_match(globals, AD.get_registers(), instr->_matrule, op_name, reg_type);
1132   if( (cisc_spill_operand != Not_cisc_spillable) && (op_name != NULL) && equivalent_predicates(this, instr) ) {
1133     cisc_spill_operand = operand_position(op_name, Component::USE);
1134     int def_oper  = operand_position(op_name, Component::DEF);
1135     if( def_oper == NameList::Not_in_list && instr->num_opnds() == num_opnds()) {
1136       // Do not support cisc-spilling for destination operands and
1137       // make sure they have the same number of operands.
1138       _cisc_spill_alternate = instr;
1139       instr->set_cisc_alternate(true);
1140       if( AD._cisc_spill_debug ) {
1141         fprintf(stderr, "Instruction %s cisc-spills-to %s\n", _ident, instr->_ident);
1142         fprintf(stderr, "   using operand %s %s at index %d\n", reg_type, op_name, cisc_spill_operand);
1143       }
1144       // Record that a stack-version of the reg_mask is needed
1145       // !!!!!
1146       OperandForm *oper = (OperandForm*)(globals[reg_type]->is_operand());
1147       assert( oper != NULL, "cisc-spilling non operand");
1148       const char *reg_class_name = oper->constrained_reg_class();
1149       AD.set_stack_or_reg(reg_class_name);
1150       const char *reg_mask_name  = AD.reg_mask(*oper);
1151       set_cisc_reg_mask_name(reg_mask_name);
1152       const char *stack_or_reg_mask_name = AD.stack_or_reg_mask(*oper);
1153     } else {
1154       cisc_spill_operand = Not_cisc_spillable;
1155     }
1156   } else {
1157     cisc_spill_operand = Not_cisc_spillable;
1158   }
1159 
1160   set_cisc_spill_operand(cisc_spill_operand);
1161   return (cisc_spill_operand != Not_cisc_spillable);
1162 }
1163 
1164 // Check to see if this instruction can be replaced with the short branch
1165 // instruction `short-branch'
1166 bool InstructForm::check_branch_variant(ArchDesc &AD, InstructForm *short_branch) {
1167   if (_matrule != NULL &&
1168       this != short_branch &&   // Don't match myself
1169       !is_short_branch() &&     // Don't match another short branch variant
1170       reduce_result() != NULL &&
1171       strcmp(reduce_result(), short_branch->reduce_result()) == 0 &&
1172       _matrule->equivalent(AD.globalNames(), short_branch->_matrule)) {
1173     // The instructions are equivalent.
1174     if (AD._short_branch_debug) {
1175       fprintf(stderr, "Instruction %s has short form %s\n", _ident, short_branch->_ident);
1176     }
1177     _short_branch_form = short_branch;
1178     return true;
1179   }
1180   return false;
1181 }
1182 
1183 
1184 // --------------------------- FILE *output_routines
1185 //
1186 // Generate the format call for the replacement variable
1187 void InstructForm::rep_var_format(FILE *fp, const char *rep_var) {
1188   // Find replacement variable's type
1189   const Form *form   = _localNames[rep_var];
1190   if (form == NULL) {
1191     fprintf(stderr, "unknown replacement variable in format statement: '%s'\n", rep_var);
1192     assert(false, "ShouldNotReachHere()");
1193   }
1194   OpClassForm *opc   = form->is_opclass();
1195   assert( opc, "replacement variable was not found in local names");
1196   // Lookup the index position of the replacement variable
1197   int idx  = operand_position_format(rep_var);
1198   if ( idx == -1 ) {
1199     assert( strcmp(opc->_ident,"label")==0, "Unimplemented");
1200     assert( false, "ShouldNotReachHere()");
1201   }
1202 
1203   if (is_noninput_operand(idx)) {
1204     // This component isn't in the input array.  Print out the static
1205     // name of the register.
1206     OperandForm* oper = form->is_operand();
1207     if (oper != NULL && oper->is_bound_register()) {
1208       const RegDef* first = oper->get_RegClass()->find_first_elem();
1209       fprintf(fp, "    tty->print(\"%s\");\n", first->_regname);
1210     } else {
1211       globalAD->syntax_err(_linenum, "In %s can't find format for %s %s", _ident, opc->_ident, rep_var);
1212     }
1213   } else {
1214     // Output the format call for this operand
1215     fprintf(fp,"opnd_array(%d)->",idx);
1216     if (idx == 0)
1217       fprintf(fp,"int_format(ra, this, st); // %s\n", rep_var);
1218     else
1219       fprintf(fp,"ext_format(ra, this,idx%d, st); // %s\n", idx, rep_var );
1220   }
1221 }
1222 
1223 // Seach through operands to determine parameters unique positions.
1224 void InstructForm::set_unique_opnds() {
1225   uint* uniq_idx = NULL;
1226   uint  nopnds = num_opnds();
1227   uint  num_uniq = nopnds;
1228   uint i;
1229   if ( nopnds > 0 ) {
1230     // Allocate index array with reserve.
1231     uniq_idx = (uint*) malloc(sizeof(uint)*(nopnds + 2));
1232     for( i = 0; i < nopnds+2; i++ ) {
1233       uniq_idx[i] = i;
1234     }
1235   }
1236   // Do it only if there is a match rule and no expand rule.  With an
1237   // expand rule it is done by creating new mach node in Expand()
1238   // method.
1239   if ( nopnds > 0 && _matrule != NULL && _exprule == NULL ) {
1240     const char *name;
1241     uint count;
1242     bool has_dupl_use = false;
1243 
1244     _parameters.reset();
1245     while( (name = _parameters.iter()) != NULL ) {
1246       count = 0;
1247       uint position = 0;
1248       uint uniq_position = 0;
1249       _components.reset();
1250       Component *comp = NULL;
1251       if( sets_result() ) {
1252         comp = _components.iter();
1253         position++;
1254       }
1255       // The next code is copied from the method operand_position().
1256       for (; (comp = _components.iter()) != NULL; ++position) {
1257         // When the first component is not a DEF,
1258         // leave space for the result operand!
1259         if ( position==0 && (! comp->isa(Component::DEF)) ) {
1260           ++position;
1261         }
1262         if( strcmp(name, comp->_name)==0 ) {
1263           if( ++count > 1 ) {
1264             uniq_idx[position] = uniq_position;
1265             has_dupl_use = true;
1266           } else {
1267             uniq_position = position;
1268           }
1269         }
1270         if( comp->isa(Component::DEF)
1271             && comp->isa(Component::USE) ) {
1272           ++position;
1273           if( position != 1 )
1274             --position;   // only use two slots for the 1st USE_DEF
1275         }
1276       }
1277     }
1278     if( has_dupl_use ) {
1279       for( i = 1; i < nopnds; i++ )
1280         if( i != uniq_idx[i] )
1281           break;
1282       int  j = i;
1283       for( ; i < nopnds; i++ )
1284         if( i == uniq_idx[i] )
1285           uniq_idx[i] = j++;
1286       num_uniq = j;
1287     }
1288   }
1289   _uniq_idx = uniq_idx;
1290   _num_uniq = num_uniq;
1291 }
1292 
1293 // Generate index values needed for determing the operand position
1294 void InstructForm::index_temps(FILE *fp, FormDict &globals, const char *prefix, const char *receiver) {
1295   uint  idx = 0;                  // position of operand in match rule
1296   int   cur_num_opnds = num_opnds();
1297 
1298   // Compute the index into vector of operand pointers:
1299   // idx0=0 is used to indicate that info comes from this same node, not from input edge.
1300   // idx1 starts at oper_input_base()
1301   if ( cur_num_opnds >= 1 ) {
1302     fprintf(fp,"    // Start at oper_input_base() and count operands\n");
1303     fprintf(fp,"    unsigned %sidx0 = %d;\n", prefix, oper_input_base(globals));
1304     fprintf(fp,"    unsigned %sidx1 = %d;\n", prefix, oper_input_base(globals));
1305 
1306     // Generate starting points for other unique operands if they exist
1307     for ( idx = 2; idx < num_unique_opnds(); ++idx ) {
1308       if( *receiver == 0 ) {
1309         fprintf(fp,"    unsigned %sidx%d = %sidx%d + opnd_array(%d)->num_edges();\n",
1310                 prefix, idx, prefix, idx-1, idx-1 );
1311       } else {
1312         fprintf(fp,"    unsigned %sidx%d = %sidx%d + %s_opnds[%d]->num_edges();\n",
1313                 prefix, idx, prefix, idx-1, receiver, idx-1 );
1314       }
1315     }
1316   }
1317   if( *receiver != 0 ) {
1318     // This value is used by generate_peepreplace when copying a node.
1319     // Don't emit it in other cases since it can hide bugs with the
1320     // use invalid idx's.
1321     fprintf(fp,"    unsigned %sidx%d = %sreq(); \n", prefix, idx, receiver);
1322   }
1323 
1324 }
1325 
1326 // ---------------------------
1327 bool InstructForm::verify() {
1328   // !!!!! !!!!!
1329   // Check that a "label" operand occurs last in the operand list, if present
1330   return true;
1331 }
1332 
1333 void InstructForm::dump() {
1334   output(stderr);
1335 }
1336 
1337 void InstructForm::output(FILE *fp) {
1338   fprintf(fp,"\nInstruction: %s\n", (_ident?_ident:""));
1339   if (_matrule)   _matrule->output(fp);
1340   if (_insencode) _insencode->output(fp);
1341   if (_opcode)    _opcode->output(fp);
1342   if (_attribs)   _attribs->output(fp);
1343   if (_predicate) _predicate->output(fp);
1344   if (_effects.Size()) {
1345     fprintf(fp,"Effects\n");
1346     _effects.dump();
1347   }
1348   if (_exprule)   _exprule->output(fp);
1349   if (_rewrule)   _rewrule->output(fp);
1350   if (_format)    _format->output(fp);
1351   if (_peephole)  _peephole->output(fp);
1352 }
1353 
1354 void MachNodeForm::dump() {
1355   output(stderr);
1356 }
1357 
1358 void MachNodeForm::output(FILE *fp) {
1359   fprintf(fp,"\nMachNode: %s\n", (_ident?_ident:""));
1360 }
1361 
1362 //------------------------------build_predicate--------------------------------
1363 // Build instruction predicates.  If the user uses the same operand name
1364 // twice, we need to check that the operands are pointer-eequivalent in
1365 // the DFA during the labeling process.
1366 Predicate *InstructForm::build_predicate() {
1367   char buf[1024], *s=buf;
1368   Dict names(cmpstr,hashstr,Form::arena);       // Map Names to counts
1369 
1370   MatchNode *mnode =
1371     strcmp(_matrule->_opType, "Set") ? _matrule : _matrule->_rChild;
1372   mnode->count_instr_names(names);
1373 
1374   uint first = 1;
1375   // Start with the predicate supplied in the .ad file.
1376   if( _predicate ) {
1377     if( first ) first=0;
1378     strcpy(s,"("); s += strlen(s);
1379     strcpy(s,_predicate->_pred);
1380     s += strlen(s);
1381     strcpy(s,")"); s += strlen(s);
1382   }
1383   for( DictI i(&names); i.test(); ++i ) {
1384     uintptr_t cnt = (uintptr_t)i._value;
1385     if( cnt > 1 ) {             // Need a predicate at all?
1386       assert( cnt == 2, "Unimplemented" );
1387       // Handle many pairs
1388       if( first ) first=0;
1389       else {                    // All tests must pass, so use '&&'
1390         strcpy(s," && ");
1391         s += strlen(s);
1392       }
1393       // Add predicate to working buffer
1394       sprintf(s,"/*%s*/(",(char*)i._key);
1395       s += strlen(s);
1396       mnode->build_instr_pred(s,(char*)i._key,0);
1397       s += strlen(s);
1398       strcpy(s," == "); s += strlen(s);
1399       mnode->build_instr_pred(s,(char*)i._key,1);
1400       s += strlen(s);
1401       strcpy(s,")"); s += strlen(s);
1402     }
1403   }
1404   if( s == buf ) s = NULL;
1405   else {
1406     assert( strlen(buf) < sizeof(buf), "String buffer overflow" );
1407     s = strdup(buf);
1408   }
1409   return new Predicate(s);
1410 }
1411 
1412 //------------------------------EncodeForm-------------------------------------
1413 // Constructor
1414 EncodeForm::EncodeForm()
1415   : _encClass(cmpstr,hashstr, Form::arena) {
1416 }
1417 EncodeForm::~EncodeForm() {
1418 }
1419 
1420 // record a new register class
1421 EncClass *EncodeForm::add_EncClass(const char *className) {
1422   EncClass *encClass = new EncClass(className);
1423   _eclasses.addName(className);
1424   _encClass.Insert(className,encClass);
1425   return encClass;
1426 }
1427 
1428 // Lookup the function body for an encoding class
1429 EncClass  *EncodeForm::encClass(const char *className) {
1430   assert( className != NULL, "Must provide a defined encoding name");
1431 
1432   EncClass *encClass = (EncClass*)_encClass[className];
1433   return encClass;
1434 }
1435 
1436 // Lookup the function body for an encoding class
1437 const char *EncodeForm::encClassBody(const char *className) {
1438   if( className == NULL ) return NULL;
1439 
1440   EncClass *encClass = (EncClass*)_encClass[className];
1441   assert( encClass != NULL, "Encode Class is missing.");
1442   encClass->_code.reset();
1443   const char *code = (const char*)encClass->_code.iter();
1444   assert( code != NULL, "Found an empty encode class body.");
1445 
1446   return code;
1447 }
1448 
1449 // Lookup the function body for an encoding class
1450 const char *EncodeForm::encClassPrototype(const char *className) {
1451   assert( className != NULL, "Encode class name must be non NULL.");
1452 
1453   return className;
1454 }
1455 
1456 void EncodeForm::dump() {                  // Debug printer
1457   output(stderr);
1458 }
1459 
1460 void EncodeForm::output(FILE *fp) {          // Write info to output files
1461   const char *name;
1462   fprintf(fp,"\n");
1463   fprintf(fp,"-------------------- Dump EncodeForm --------------------\n");
1464   for (_eclasses.reset(); (name = _eclasses.iter()) != NULL;) {
1465     ((EncClass*)_encClass[name])->output(fp);
1466   }
1467   fprintf(fp,"-------------------- end  EncodeForm --------------------\n");
1468 }
1469 //------------------------------EncClass---------------------------------------
1470 EncClass::EncClass(const char *name)
1471   : _localNames(cmpstr,hashstr, Form::arena), _name(name) {
1472 }
1473 EncClass::~EncClass() {
1474 }
1475 
1476 // Add a parameter <type,name> pair
1477 void EncClass::add_parameter(const char *parameter_type, const char *parameter_name) {
1478   _parameter_type.addName( parameter_type );
1479   _parameter_name.addName( parameter_name );
1480 }
1481 
1482 // Verify operand types in parameter list
1483 bool EncClass::check_parameter_types(FormDict &globals) {
1484   // !!!!!
1485   return false;
1486 }
1487 
1488 // Add the decomposed "code" sections of an encoding's code-block
1489 void EncClass::add_code(const char *code) {
1490   _code.addName(code);
1491 }
1492 
1493 // Add the decomposed "replacement variables" of an encoding's code-block
1494 void EncClass::add_rep_var(char *replacement_var) {
1495   _code.addName(NameList::_signal);
1496   _rep_vars.addName(replacement_var);
1497 }
1498 
1499 // Lookup the function body for an encoding class
1500 int EncClass::rep_var_index(const char *rep_var) {
1501   uint        position = 0;
1502   const char *name     = NULL;
1503 
1504   _parameter_name.reset();
1505   while ( (name = _parameter_name.iter()) != NULL ) {
1506     if ( strcmp(rep_var,name) == 0 ) return position;
1507     ++position;
1508   }
1509 
1510   return -1;
1511 }
1512 
1513 // Check after parsing
1514 bool EncClass::verify() {
1515   // 1!!!!
1516   // Check that each replacement variable, '$name' in architecture description
1517   // is actually a local variable for this encode class, or a reserved name
1518   // "primary, secondary, tertiary"
1519   return true;
1520 }
1521 
1522 void EncClass::dump() {
1523   output(stderr);
1524 }
1525 
1526 // Write info to output files
1527 void EncClass::output(FILE *fp) {
1528   fprintf(fp,"EncClass: %s", (_name ? _name : ""));
1529 
1530   // Output the parameter list
1531   _parameter_type.reset();
1532   _parameter_name.reset();
1533   const char *type = _parameter_type.iter();
1534   const char *name = _parameter_name.iter();
1535   fprintf(fp, " ( ");
1536   for ( ; (type != NULL) && (name != NULL);
1537         (type = _parameter_type.iter()), (name = _parameter_name.iter()) ) {
1538     fprintf(fp, " %s %s,", type, name);
1539   }
1540   fprintf(fp, " ) ");
1541 
1542   // Output the code block
1543   _code.reset();
1544   _rep_vars.reset();
1545   const char *code;
1546   while ( (code = _code.iter()) != NULL ) {
1547     if ( _code.is_signal(code) ) {
1548       // A replacement variable
1549       const char *rep_var = _rep_vars.iter();
1550       fprintf(fp,"($%s)", rep_var);
1551     } else {
1552       // A section of code
1553       fprintf(fp,"%s", code);
1554     }
1555   }
1556 
1557 }
1558 
1559 //------------------------------Opcode-----------------------------------------
1560 Opcode::Opcode(char *primary, char *secondary, char *tertiary)
1561   : _primary(primary), _secondary(secondary), _tertiary(tertiary) {
1562 }
1563 
1564 Opcode::~Opcode() {
1565 }
1566 
1567 Opcode::opcode_type Opcode::as_opcode_type(const char *param) {
1568   if( strcmp(param,"primary") == 0 ) {
1569     return Opcode::PRIMARY;
1570   }
1571   else if( strcmp(param,"secondary") == 0 ) {
1572     return Opcode::SECONDARY;
1573   }
1574   else if( strcmp(param,"tertiary") == 0 ) {
1575     return Opcode::TERTIARY;
1576   }
1577   return Opcode::NOT_AN_OPCODE;
1578 }
1579 
1580 bool Opcode::print_opcode(FILE *fp, Opcode::opcode_type desired_opcode) {
1581   // Default values previously provided by MachNode::primary()...
1582   const char *description = NULL;
1583   const char *value       = NULL;
1584   // Check if user provided any opcode definitions
1585   if( this != NULL ) {
1586     // Update 'value' if user provided a definition in the instruction
1587     switch (desired_opcode) {
1588     case PRIMARY:
1589       description = "primary()";
1590       if( _primary   != NULL)  { value = _primary;     }
1591       break;
1592     case SECONDARY:
1593       description = "secondary()";
1594       if( _secondary != NULL ) { value = _secondary;   }
1595       break;
1596     case TERTIARY:
1597       description = "tertiary()";
1598       if( _tertiary  != NULL ) { value = _tertiary;    }
1599       break;
1600     default:
1601       assert( false, "ShouldNotReachHere();");
1602       break;
1603     }
1604   }
1605   if (value != NULL) {
1606     fprintf(fp, "(%s /*%s*/)", value, description);
1607   }
1608   return value != NULL;
1609 }
1610 
1611 void Opcode::dump() {
1612   output(stderr);
1613 }
1614 
1615 // Write info to output files
1616 void Opcode::output(FILE *fp) {
1617   if (_primary   != NULL) fprintf(fp,"Primary   opcode: %s\n", _primary);
1618   if (_secondary != NULL) fprintf(fp,"Secondary opcode: %s\n", _secondary);
1619   if (_tertiary  != NULL) fprintf(fp,"Tertiary  opcode: %s\n", _tertiary);
1620 }
1621 
1622 //------------------------------InsEncode--------------------------------------
1623 InsEncode::InsEncode() {
1624 }
1625 InsEncode::~InsEncode() {
1626 }
1627 
1628 // Add "encode class name" and its parameters
1629 NameAndList *InsEncode::add_encode(char *encoding) {
1630   assert( encoding != NULL, "Must provide name for encoding");
1631 
1632   // add_parameter(NameList::_signal);
1633   NameAndList *encode = new NameAndList(encoding);
1634   _encoding.addName((char*)encode);
1635 
1636   return encode;
1637 }
1638 
1639 // Access the list of encodings
1640 void InsEncode::reset() {
1641   _encoding.reset();
1642   // _parameter.reset();
1643 }
1644 const char* InsEncode::encode_class_iter() {
1645   NameAndList  *encode_class = (NameAndList*)_encoding.iter();
1646   return  ( encode_class != NULL ? encode_class->name() : NULL );
1647 }
1648 // Obtain parameter name from zero based index
1649 const char *InsEncode::rep_var_name(InstructForm &inst, uint param_no) {
1650   NameAndList *params = (NameAndList*)_encoding.current();
1651   assert( params != NULL, "Internal Error");
1652   const char *param = (*params)[param_no];
1653 
1654   // Remove '$' if parser placed it there.
1655   return ( param != NULL && *param == '$') ? (param+1) : param;
1656 }
1657 
1658 void InsEncode::dump() {
1659   output(stderr);
1660 }
1661 
1662 // Write info to output files
1663 void InsEncode::output(FILE *fp) {
1664   NameAndList *encoding  = NULL;
1665   const char  *parameter = NULL;
1666 
1667   fprintf(fp,"InsEncode: ");
1668   _encoding.reset();
1669 
1670   while ( (encoding = (NameAndList*)_encoding.iter()) != 0 ) {
1671     // Output the encoding being used
1672     fprintf(fp,"%s(", encoding->name() );
1673 
1674     // Output its parameter list, if any
1675     bool first_param = true;
1676     encoding->reset();
1677     while (  (parameter = encoding->iter()) != 0 ) {
1678       // Output the ',' between parameters
1679       if ( ! first_param )  fprintf(fp,", ");
1680       first_param = false;
1681       // Output the parameter
1682       fprintf(fp,"%s", parameter);
1683     } // done with parameters
1684     fprintf(fp,")  ");
1685   } // done with encodings
1686 
1687   fprintf(fp,"\n");
1688 }
1689 
1690 //------------------------------Effect-----------------------------------------
1691 static int effect_lookup(const char *name) {
1692   if(!strcmp(name, "USE")) return Component::USE;
1693   if(!strcmp(name, "DEF")) return Component::DEF;
1694   if(!strcmp(name, "USE_DEF")) return Component::USE_DEF;
1695   if(!strcmp(name, "KILL")) return Component::KILL;
1696   if(!strcmp(name, "USE_KILL")) return Component::USE_KILL;
1697   if(!strcmp(name, "TEMP")) return Component::TEMP;
1698   if(!strcmp(name, "INVALID")) return Component::INVALID;
1699   assert( false,"Invalid effect name specified\n");
1700   return Component::INVALID;
1701 }
1702 
1703 Effect::Effect(const char *name) : _name(name), _use_def(effect_lookup(name)) {
1704   _ftype = Form::EFF;
1705 }
1706 Effect::~Effect() {
1707 }
1708 
1709 // Dynamic type check
1710 Effect *Effect::is_effect() const {
1711   return (Effect*)this;
1712 }
1713 
1714 
1715 // True if this component is equal to the parameter.
1716 bool Effect::is(int use_def_kill_enum) const {
1717   return (_use_def == use_def_kill_enum ? true : false);
1718 }
1719 // True if this component is used/def'd/kill'd as the parameter suggests.
1720 bool Effect::isa(int use_def_kill_enum) const {
1721   return (_use_def & use_def_kill_enum) == use_def_kill_enum;
1722 }
1723 
1724 void Effect::dump() {
1725   output(stderr);
1726 }
1727 
1728 void Effect::output(FILE *fp) {          // Write info to output files
1729   fprintf(fp,"Effect: %s\n", (_name?_name:""));
1730 }
1731 
1732 //------------------------------ExpandRule-------------------------------------
1733 ExpandRule::ExpandRule() : _expand_instrs(),
1734                            _newopconst(cmpstr, hashstr, Form::arena) {
1735   _ftype = Form::EXP;
1736 }
1737 
1738 ExpandRule::~ExpandRule() {                  // Destructor
1739 }
1740 
1741 void ExpandRule::add_instruction(NameAndList *instruction_name_and_operand_list) {
1742   _expand_instrs.addName((char*)instruction_name_and_operand_list);
1743 }
1744 
1745 void ExpandRule::reset_instructions() {
1746   _expand_instrs.reset();
1747 }
1748 
1749 NameAndList* ExpandRule::iter_instructions() {
1750   return (NameAndList*)_expand_instrs.iter();
1751 }
1752 
1753 
1754 void ExpandRule::dump() {
1755   output(stderr);
1756 }
1757 
1758 void ExpandRule::output(FILE *fp) {         // Write info to output files
1759   NameAndList *expand_instr = NULL;
1760   const char *opid = NULL;
1761 
1762   fprintf(fp,"\nExpand Rule:\n");
1763 
1764   // Iterate over the instructions 'node' expands into
1765   for(reset_instructions(); (expand_instr = iter_instructions()) != NULL; ) {
1766     fprintf(fp,"%s(", expand_instr->name());
1767 
1768     // iterate over the operand list
1769     for( expand_instr->reset(); (opid = expand_instr->iter()) != NULL; ) {
1770       fprintf(fp,"%s ", opid);
1771     }
1772     fprintf(fp,");\n");
1773   }
1774 }
1775 
1776 //------------------------------RewriteRule------------------------------------
1777 RewriteRule::RewriteRule(char* params, char* block)
1778   : _tempParams(params), _tempBlock(block) { };  // Constructor
1779 RewriteRule::~RewriteRule() {                 // Destructor
1780 }
1781 
1782 void RewriteRule::dump() {
1783   output(stderr);
1784 }
1785 
1786 void RewriteRule::output(FILE *fp) {         // Write info to output files
1787   fprintf(fp,"\nRewrite Rule:\n%s\n%s\n",
1788           (_tempParams?_tempParams:""),
1789           (_tempBlock?_tempBlock:""));
1790 }
1791 
1792 
1793 //==============================MachNodes======================================
1794 //------------------------------MachNodeForm-----------------------------------
1795 MachNodeForm::MachNodeForm(char *id)
1796   : _ident(id) {
1797 }
1798 
1799 MachNodeForm::~MachNodeForm() {
1800 }
1801 
1802 MachNodeForm *MachNodeForm::is_machnode() const {
1803   return (MachNodeForm*)this;
1804 }
1805 
1806 //==============================Operand Classes================================
1807 //------------------------------OpClassForm------------------------------------
1808 OpClassForm::OpClassForm(const char* id) : _ident(id) {
1809   _ftype = Form::OPCLASS;
1810 }
1811 
1812 OpClassForm::~OpClassForm() {
1813 }
1814 
1815 bool OpClassForm::ideal_only() const { return 0; }
1816 
1817 OpClassForm *OpClassForm::is_opclass() const {
1818   return (OpClassForm*)this;
1819 }
1820 
1821 Form::InterfaceType OpClassForm::interface_type(FormDict &globals) const {
1822   if( _oplst.count() == 0 ) return Form::no_interface;
1823 
1824   // Check that my operands have the same interface type
1825   Form::InterfaceType  interface;
1826   bool  first = true;
1827   NameList &op_list = (NameList &)_oplst;
1828   op_list.reset();
1829   const char *op_name;
1830   while( (op_name = op_list.iter()) != NULL ) {
1831     const Form  *form    = globals[op_name];
1832     OperandForm *operand = form->is_operand();
1833     assert( operand, "Entry in operand class that is not an operand");
1834     if( first ) {
1835       first     = false;
1836       interface = operand->interface_type(globals);
1837     } else {
1838       interface = (interface == operand->interface_type(globals) ? interface : Form::no_interface);
1839     }
1840   }
1841   return interface;
1842 }
1843 
1844 bool OpClassForm::stack_slots_only(FormDict &globals) const {
1845   if( _oplst.count() == 0 ) return false;  // how?
1846 
1847   NameList &op_list = (NameList &)_oplst;
1848   op_list.reset();
1849   const char *op_name;
1850   while( (op_name = op_list.iter()) != NULL ) {
1851     const Form  *form    = globals[op_name];
1852     OperandForm *operand = form->is_operand();
1853     assert( operand, "Entry in operand class that is not an operand");
1854     if( !operand->stack_slots_only(globals) )  return false;
1855   }
1856   return true;
1857 }
1858 
1859 
1860 void OpClassForm::dump() {
1861   output(stderr);
1862 }
1863 
1864 void OpClassForm::output(FILE *fp) {
1865   const char *name;
1866   fprintf(fp,"\nOperand Class: %s\n", (_ident?_ident:""));
1867   fprintf(fp,"\nCount = %d\n", _oplst.count());
1868   for(_oplst.reset(); (name = _oplst.iter()) != NULL;) {
1869     fprintf(fp,"%s, ",name);
1870   }
1871   fprintf(fp,"\n");
1872 }
1873 
1874 
1875 //==============================Operands=======================================
1876 //------------------------------OperandForm------------------------------------
1877 OperandForm::OperandForm(const char* id)
1878   : OpClassForm(id), _ideal_only(false),
1879     _localNames(cmpstr, hashstr, Form::arena) {
1880       _ftype = Form::OPER;
1881 
1882       _matrule   = NULL;
1883       _interface = NULL;
1884       _attribs   = NULL;
1885       _predicate = NULL;
1886       _constraint= NULL;
1887       _construct = NULL;
1888       _format    = NULL;
1889 }
1890 OperandForm::OperandForm(const char* id, bool ideal_only)
1891   : OpClassForm(id), _ideal_only(ideal_only),
1892     _localNames(cmpstr, hashstr, Form::arena) {
1893       _ftype = Form::OPER;
1894 
1895       _matrule   = NULL;
1896       _interface = NULL;
1897       _attribs   = NULL;
1898       _predicate = NULL;
1899       _constraint= NULL;
1900       _construct = NULL;
1901       _format    = NULL;
1902 }
1903 OperandForm::~OperandForm() {
1904 }
1905 
1906 
1907 OperandForm *OperandForm::is_operand() const {
1908   return (OperandForm*)this;
1909 }
1910 
1911 bool OperandForm::ideal_only() const {
1912   return _ideal_only;
1913 }
1914 
1915 Form::InterfaceType OperandForm::interface_type(FormDict &globals) const {
1916   if( _interface == NULL )  return Form::no_interface;
1917 
1918   return _interface->interface_type(globals);
1919 }
1920 
1921 
1922 bool OperandForm::stack_slots_only(FormDict &globals) const {
1923   if( _constraint == NULL )  return false;
1924   return _constraint->stack_slots_only();
1925 }
1926 
1927 
1928 // Access op_cost attribute or return NULL.
1929 const char* OperandForm::cost() {
1930   for (Attribute* cur = _attribs; cur != NULL; cur = (Attribute*)cur->_next) {
1931     if( strcmp(cur->_ident,AttributeForm::_op_cost) == 0 ) {
1932       return cur->_val;
1933     }
1934   }
1935   return NULL;
1936 }
1937 
1938 // Return the number of leaves below this complex operand
1939 uint OperandForm::num_leaves() const {
1940   if ( ! _matrule) return 0;
1941 
1942   int num_leaves = _matrule->_numleaves;
1943   return num_leaves;
1944 }
1945 
1946 // Return the number of constants contained within this complex operand
1947 uint OperandForm::num_consts(FormDict &globals) const {
1948   if ( ! _matrule) return 0;
1949 
1950   // This is a recursive invocation on all operands in the matchrule
1951   return _matrule->num_consts(globals);
1952 }
1953 
1954 // Return the number of constants in match rule with specified type
1955 uint OperandForm::num_consts(FormDict &globals, Form::DataType type) const {
1956   if ( ! _matrule) return 0;
1957 
1958   // This is a recursive invocation on all operands in the matchrule
1959   return _matrule->num_consts(globals, type);
1960 }
1961 
1962 // Return the number of pointer constants contained within this complex operand
1963 uint OperandForm::num_const_ptrs(FormDict &globals) const {
1964   if ( ! _matrule) return 0;
1965 
1966   // This is a recursive invocation on all operands in the matchrule
1967   return _matrule->num_const_ptrs(globals);
1968 }
1969 
1970 uint OperandForm::num_edges(FormDict &globals) const {
1971   uint edges  = 0;
1972   uint leaves = num_leaves();
1973   uint consts = num_consts(globals);
1974 
1975   // If we are matching a constant directly, there are no leaves.
1976   edges = ( leaves > consts ) ? leaves - consts : 0;
1977 
1978   // !!!!!
1979   // Special case operands that do not have a corresponding ideal node.
1980   if( (edges == 0) && (consts == 0) ) {
1981     if( constrained_reg_class() != NULL ) {
1982       edges = 1;
1983     } else {
1984       if( _matrule
1985           && (_matrule->_lChild == NULL) && (_matrule->_rChild == NULL) ) {
1986         const Form *form = globals[_matrule->_opType];
1987         OperandForm *oper = form ? form->is_operand() : NULL;
1988         if( oper ) {
1989           return oper->num_edges(globals);
1990         }
1991       }
1992     }
1993   }
1994 
1995   return edges;
1996 }
1997 
1998 
1999 // Check if this operand is usable for cisc-spilling
2000 bool  OperandForm::is_cisc_reg(FormDict &globals) const {
2001   const char *ideal = ideal_type(globals);
2002   bool is_cisc_reg = (ideal && (ideal_to_Reg_type(ideal) != none));
2003   return is_cisc_reg;
2004 }
2005 
2006 bool  OpClassForm::is_cisc_mem(FormDict &globals) const {
2007   Form::InterfaceType my_interface = interface_type(globals);
2008   return (my_interface == memory_interface);
2009 }
2010 
2011 
2012 // node matches ideal 'Bool'
2013 bool OperandForm::is_ideal_bool() const {
2014   if( _matrule == NULL ) return false;
2015 
2016   return _matrule->is_ideal_bool();
2017 }
2018 
2019 // Require user's name for an sRegX to be stackSlotX
2020 Form::DataType OperandForm::is_user_name_for_sReg() const {
2021   DataType data_type = none;
2022   if( _ident != NULL ) {
2023     if(      strcmp(_ident,"stackSlotI") == 0 ) data_type = Form::idealI;
2024     else if( strcmp(_ident,"stackSlotP") == 0 ) data_type = Form::idealP;
2025     else if( strcmp(_ident,"stackSlotD") == 0 ) data_type = Form::idealD;
2026     else if( strcmp(_ident,"stackSlotF") == 0 ) data_type = Form::idealF;
2027     else if( strcmp(_ident,"stackSlotL") == 0 ) data_type = Form::idealL;
2028   }
2029   assert((data_type == none) || (_matrule == NULL), "No match-rule for stackSlotX");
2030 
2031   return data_type;
2032 }
2033 
2034 
2035 // Return ideal type, if there is a single ideal type for this operand
2036 const char *OperandForm::ideal_type(FormDict &globals, RegisterForm *registers) const {
2037   const char *type = NULL;
2038   if (ideal_only()) type = _ident;
2039   else if( _matrule == NULL ) {
2040     // Check for condition code register
2041     const char *rc_name = constrained_reg_class();
2042     // !!!!!
2043     if (rc_name == NULL) return NULL;
2044     // !!!!! !!!!!
2045     // Check constraints on result's register class
2046     if( registers ) {
2047       RegClass *reg_class  = registers->getRegClass(rc_name);
2048       assert( reg_class != NULL, "Register class is not defined");
2049 
2050       // Check for ideal type of entries in register class, all are the same type
2051       reg_class->reset();
2052       RegDef *reg_def = reg_class->RegDef_iter();
2053       assert( reg_def != NULL, "No entries in register class");
2054       assert( reg_def->_idealtype != NULL, "Did not define ideal type for register");
2055       // Return substring that names the register's ideal type
2056       type = reg_def->_idealtype + 3;
2057       assert( *(reg_def->_idealtype + 0) == 'O', "Expect Op_ prefix");
2058       assert( *(reg_def->_idealtype + 1) == 'p', "Expect Op_ prefix");
2059       assert( *(reg_def->_idealtype + 2) == '_', "Expect Op_ prefix");
2060     }
2061   }
2062   else if( _matrule->_lChild == NULL && _matrule->_rChild == NULL ) {
2063     // This operand matches a single type, at the top level.
2064     // Check for ideal type
2065     type = _matrule->_opType;
2066     if( strcmp(type,"Bool") == 0 )
2067       return "Bool";
2068     // transitive lookup
2069     const Form *frm = globals[type];
2070     OperandForm *op = frm->is_operand();
2071     type = op->ideal_type(globals, registers);
2072   }
2073   return type;
2074 }
2075 
2076 
2077 // If there is a single ideal type for this interface field, return it.
2078 const char *OperandForm::interface_ideal_type(FormDict &globals,
2079                                               const char *field) const {
2080   const char  *ideal_type = NULL;
2081   const char  *value      = NULL;
2082 
2083   // Check if "field" is valid for this operand's interface
2084   if ( ! is_interface_field(field, value) )   return ideal_type;
2085 
2086   // !!!!! !!!!! !!!!!
2087   // If a valid field has a constant value, identify "ConI" or "ConP" or ...
2088 
2089   // Else, lookup type of field's replacement variable
2090 
2091   return ideal_type;
2092 }
2093 
2094 
2095 RegClass* OperandForm::get_RegClass() const {
2096   if (_interface && !_interface->is_RegInterface()) return NULL;
2097   return globalAD->get_registers()->getRegClass(constrained_reg_class());
2098 }
2099 
2100 
2101 bool OperandForm::is_bound_register() const {
2102   RegClass *reg_class  = get_RegClass();
2103   if (reg_class == NULL) return false;
2104 
2105   const char * name = ideal_type(globalAD->globalNames());
2106   if (name == NULL) return false;
2107 
2108   int size = 0;
2109   if (strcmp(name,"RegFlags")==0) size =  1;
2110   if (strcmp(name,"RegI")==0) size =  1;
2111   if (strcmp(name,"RegF")==0) size =  1;
2112   if (strcmp(name,"RegD")==0) size =  2;
2113   if (strcmp(name,"RegL")==0) size =  2;
2114   if (strcmp(name,"RegN")==0) size =  1;
2115   if (strcmp(name,"RegP")==0) size =  globalAD->get_preproc_def("_LP64") ? 2 : 1;
2116   if (size == 0) return false;
2117   return size == reg_class->size();
2118 }
2119 
2120 
2121 // Check if this is a valid field for this operand,
2122 // Return 'true' if valid, and set the value to the string the user provided.
2123 bool  OperandForm::is_interface_field(const char *field,
2124                                       const char * &value) const {
2125   return false;
2126 }
2127 
2128 
2129 // Return register class name if a constraint specifies the register class.
2130 const char *OperandForm::constrained_reg_class() const {
2131   const char *reg_class  = NULL;
2132   if ( _constraint ) {
2133     // !!!!!
2134     Constraint *constraint = _constraint;
2135     if ( strcmp(_constraint->_func,"ALLOC_IN_RC") == 0 ) {
2136       reg_class = _constraint->_arg;
2137     }
2138   }
2139 
2140   return reg_class;
2141 }
2142 
2143 
2144 // Return the register class associated with 'leaf'.
2145 const char *OperandForm::in_reg_class(uint leaf, FormDict &globals) {
2146   const char *reg_class = NULL; // "RegMask::Empty";
2147 
2148   if((_matrule == NULL) || (_matrule->is_chain_rule(globals))) {
2149     reg_class = constrained_reg_class();
2150     return reg_class;
2151   }
2152   const char *result   = NULL;
2153   const char *name     = NULL;
2154   const char *type     = NULL;
2155   // iterate through all base operands
2156   // until we reach the register that corresponds to "leaf"
2157   // This function is not looking for an ideal type.  It needs the first
2158   // level user type associated with the leaf.
2159   for(uint idx = 0;_matrule->base_operand(idx,globals,result,name,type);++idx) {
2160     const Form *form = (_localNames[name] ? _localNames[name] : globals[result]);
2161     OperandForm *oper = form ? form->is_operand() : NULL;
2162     if( oper ) {
2163       reg_class = oper->constrained_reg_class();
2164       if( reg_class ) {
2165         reg_class = reg_class;
2166       } else {
2167         // ShouldNotReachHere();
2168       }
2169     } else {
2170       // ShouldNotReachHere();
2171     }
2172 
2173     // Increment our target leaf position if current leaf is not a candidate.
2174     if( reg_class == NULL)    ++leaf;
2175     // Exit the loop with the value of reg_class when at the correct index
2176     if( idx == leaf )         break;
2177     // May iterate through all base operands if reg_class for 'leaf' is NULL
2178   }
2179   return reg_class;
2180 }
2181 
2182 
2183 // Recursive call to construct list of top-level operands.
2184 // Implementation does not modify state of internal structures
2185 void OperandForm::build_components() {
2186   if (_matrule)  _matrule->append_components(_localNames, _components);
2187 
2188   // Add parameters that "do not appear in match rule".
2189   const char *name;
2190   for (_parameters.reset(); (name = _parameters.iter()) != NULL;) {
2191     OperandForm *opForm = (OperandForm*)_localNames[name];
2192 
2193     if ( _components.operand_position(name) == -1 ) {
2194       _components.insert(name, opForm->_ident, Component::INVALID, false);
2195     }
2196   }
2197 
2198   return;
2199 }
2200 
2201 int OperandForm::operand_position(const char *name, int usedef) {
2202   return _components.operand_position(name, usedef);
2203 }
2204 
2205 
2206 // Return zero-based position in component list, only counting constants;
2207 // Return -1 if not in list.
2208 int OperandForm::constant_position(FormDict &globals, const Component *last) {
2209   // Iterate through components and count constants preceeding 'constant'
2210   uint  position = 0;
2211   Component *comp;
2212   _components.reset();
2213   while( (comp = _components.iter()) != NULL  && (comp != last) ) {
2214     // Special case for operands that take a single user-defined operand
2215     // Skip the initial definition in the component list.
2216     if( strcmp(comp->_name,this->_ident) == 0 ) continue;
2217 
2218     const char *type = comp->_type;
2219     // Lookup operand form for replacement variable's type
2220     const Form *form = globals[type];
2221     assert( form != NULL, "Component's type not found");
2222     OperandForm *oper = form ? form->is_operand() : NULL;
2223     if( oper ) {
2224       if( oper->_matrule->is_base_constant(globals) != Form::none ) {
2225         ++position;
2226       }
2227     }
2228   }
2229 
2230   // Check for being passed a component that was not in the list
2231   if( comp != last )  position = -1;
2232 
2233   return position;
2234 }
2235 // Provide position of constant by "name"
2236 int OperandForm::constant_position(FormDict &globals, const char *name) {
2237   const Component *comp = _components.search(name);
2238   int idx = constant_position( globals, comp );
2239 
2240   return idx;
2241 }
2242 
2243 
2244 // Return zero-based position in component list, only counting constants;
2245 // Return -1 if not in list.
2246 int OperandForm::register_position(FormDict &globals, const char *reg_name) {
2247   // Iterate through components and count registers preceeding 'last'
2248   uint  position = 0;
2249   Component *comp;
2250   _components.reset();
2251   while( (comp = _components.iter()) != NULL
2252          && (strcmp(comp->_name,reg_name) != 0) ) {
2253     // Special case for operands that take a single user-defined operand
2254     // Skip the initial definition in the component list.
2255     if( strcmp(comp->_name,this->_ident) == 0 ) continue;
2256 
2257     const char *type = comp->_type;
2258     // Lookup operand form for component's type
2259     const Form *form = globals[type];
2260     assert( form != NULL, "Component's type not found");
2261     OperandForm *oper = form ? form->is_operand() : NULL;
2262     if( oper ) {
2263       if( oper->_matrule->is_base_register(globals) ) {
2264         ++position;
2265       }
2266     }
2267   }
2268 
2269   return position;
2270 }
2271 
2272 
2273 const char *OperandForm::reduce_result()  const {
2274   return _ident;
2275 }
2276 // Return the name of the operand on the right hand side of the binary match
2277 // Return NULL if there is no right hand side
2278 const char *OperandForm::reduce_right(FormDict &globals)  const {
2279   return  ( _matrule ? _matrule->reduce_right(globals) : NULL );
2280 }
2281 
2282 // Similar for left
2283 const char *OperandForm::reduce_left(FormDict &globals)   const {
2284   return  ( _matrule ? _matrule->reduce_left(globals) : NULL );
2285 }
2286 
2287 
2288 // --------------------------- FILE *output_routines
2289 //
2290 // Output code for disp_is_oop, if true.
2291 void OperandForm::disp_is_oop(FILE *fp, FormDict &globals) {
2292   //  Check it is a memory interface with a non-user-constant disp field
2293   if ( this->_interface == NULL ) return;
2294   MemInterface *mem_interface = this->_interface->is_MemInterface();
2295   if ( mem_interface == NULL )    return;
2296   const char   *disp  = mem_interface->_disp;
2297   if ( *disp != '$' )             return;
2298 
2299   // Lookup replacement variable in operand's component list
2300   const char   *rep_var = disp + 1;
2301   const Component *comp = this->_components.search(rep_var);
2302   assert( comp != NULL, "Replacement variable not found in components");
2303   // Lookup operand form for replacement variable's type
2304   const char      *type = comp->_type;
2305   Form            *form = (Form*)globals[type];
2306   assert( form != NULL, "Replacement variable's type not found");
2307   OperandForm     *op   = form->is_operand();
2308   assert( op, "Memory Interface 'disp' can only emit an operand form");
2309   // Check if this is a ConP, which may require relocation
2310   if ( op->is_base_constant(globals) == Form::idealP ) {
2311     // Find the constant's index:  _c0, _c1, _c2, ... , _cN
2312     uint idx  = op->constant_position( globals, rep_var);
2313     fprintf(fp,"  virtual bool disp_is_oop() const {", _ident);
2314     fprintf(fp,  "  return _c%d->isa_oop_ptr();", idx);
2315     fprintf(fp, " }\n");
2316   }
2317 }
2318 
2319 // Generate code for internal and external format methods
2320 //
2321 // internal access to reg# node->_idx
2322 // access to subsumed constant _c0, _c1,
2323 void  OperandForm::int_format(FILE *fp, FormDict &globals, uint index) {
2324   Form::DataType dtype;
2325   if (_matrule && (_matrule->is_base_register(globals) ||
2326                    strcmp(ideal_type(globalAD->globalNames()), "RegFlags") == 0)) {
2327     // !!!!! !!!!!
2328     fprintf(fp,    "{ char reg_str[128];\n");
2329     fprintf(fp,"      ra->dump_register(node,reg_str);\n");
2330     fprintf(fp,"      tty->print(\"%cs\",reg_str);\n",'%');
2331     fprintf(fp,"    }\n");
2332   } else if (_matrule && (dtype = _matrule->is_base_constant(globals)) != Form::none) {
2333     format_constant( fp, index, dtype );
2334   } else if (ideal_to_sReg_type(_ident) != Form::none) {
2335     // Special format for Stack Slot Register
2336     fprintf(fp,    "{ char reg_str[128];\n");
2337     fprintf(fp,"      ra->dump_register(node,reg_str);\n");
2338     fprintf(fp,"      tty->print(\"%cs\",reg_str);\n",'%');
2339     fprintf(fp,"    }\n");
2340   } else {
2341     fprintf(fp,"tty->print(\"No format defined for %s\n\");\n", _ident);
2342     fflush(fp);
2343     fprintf(stderr,"No format defined for %s\n", _ident);
2344     dump();
2345     assert( false,"Internal error:\n  output_internal_operand() attempting to output other than a Register or Constant");
2346   }
2347 }
2348 
2349 // Similar to "int_format" but for cases where data is external to operand
2350 // external access to reg# node->in(idx)->_idx,
2351 void  OperandForm::ext_format(FILE *fp, FormDict &globals, uint index) {
2352   Form::DataType dtype;
2353   if (_matrule && (_matrule->is_base_register(globals) ||
2354                    strcmp(ideal_type(globalAD->globalNames()), "RegFlags") == 0)) {
2355     fprintf(fp,    "{ char reg_str[128];\n");
2356     fprintf(fp,"      ra->dump_register(node->in(idx");
2357     if ( index != 0 ) fprintf(fp,                  "+%d",index);
2358     fprintf(fp,                                       "),reg_str);\n");
2359     fprintf(fp,"      tty->print(\"%cs\",reg_str);\n",'%');
2360     fprintf(fp,"    }\n");
2361   } else if (_matrule && (dtype = _matrule->is_base_constant(globals)) != Form::none) {
2362     format_constant( fp, index, dtype );
2363   } else if (ideal_to_sReg_type(_ident) != Form::none) {
2364     // Special format for Stack Slot Register
2365     fprintf(fp,    "{ char reg_str[128];\n");
2366     fprintf(fp,"      ra->dump_register(node->in(idx");
2367     if ( index != 0 ) fprintf(fp,                  "+%d",index);
2368     fprintf(fp,                                       "),reg_str);\n");
2369     fprintf(fp,"      tty->print(\"%cs\",reg_str);\n",'%');
2370     fprintf(fp,"    }\n");
2371   } else {
2372     fprintf(fp,"tty->print(\"No format defined for %s\n\");\n", _ident);
2373     assert( false,"Internal error:\n  output_external_operand() attempting to output other than a Register or Constant");
2374   }
2375 }
2376 
2377 void OperandForm::format_constant(FILE *fp, uint const_index, uint const_type) {
2378   switch(const_type) {
2379   case Form::idealI:  fprintf(fp,"st->print(\"#%%d\", _c%d);\n", const_index); break;
2380   case Form::idealP:  fprintf(fp,"_c%d->dump_on(st);\n",         const_index); break;
2381   case Form::idealN:  fprintf(fp,"_c%d->dump_on(st);\n",         const_index); break;
2382   case Form::idealL:  fprintf(fp,"st->print(\"#%%lld\", _c%d);\n", const_index); break;
2383   case Form::idealF:  fprintf(fp,"st->print(\"#%%f\", _c%d);\n", const_index); break;
2384   case Form::idealD:  fprintf(fp,"st->print(\"#%%f\", _c%d);\n", const_index); break;
2385   default:
2386     assert( false, "ShouldNotReachHere()");
2387   }
2388 }
2389 
2390 // Return the operand form corresponding to the given index, else NULL.
2391 OperandForm *OperandForm::constant_operand(FormDict &globals,
2392                                            uint      index) {
2393   // !!!!!
2394   // Check behavior on complex operands
2395   uint n_consts = num_consts(globals);
2396   if( n_consts > 0 ) {
2397     uint i = 0;
2398     const char *type;
2399     Component  *comp;
2400     _components.reset();
2401     if ((comp = _components.iter()) == NULL) {
2402       assert(n_consts == 1, "Bad component list detected.\n");
2403       // Current operand is THE operand
2404       if ( index == 0 ) {
2405         return this;
2406       }
2407     } // end if NULL
2408     else {
2409       // Skip the first component, it can not be a DEF of a constant
2410       do {
2411         type = comp->base_type(globals);
2412         // Check that "type" is a 'ConI', 'ConP', ...
2413         if ( ideal_to_const_type(type) != Form::none ) {
2414           // When at correct component, get corresponding Operand
2415           if ( index == 0 ) {
2416             return globals[comp->_type]->is_operand();
2417           }
2418           // Decrement number of constants to go
2419           --index;
2420         }
2421       } while((comp = _components.iter()) != NULL);
2422     }
2423   }
2424 
2425   // Did not find a constant for this index.
2426   return NULL;
2427 }
2428 
2429 // If this operand has a single ideal type, return its type
2430 Form::DataType OperandForm::simple_type(FormDict &globals) const {
2431   const char *type_name = ideal_type(globals);
2432   Form::DataType type   = type_name ? ideal_to_const_type( type_name )
2433                                     : Form::none;
2434   return type;
2435 }
2436 
2437 Form::DataType OperandForm::is_base_constant(FormDict &globals) const {
2438   if ( _matrule == NULL )    return Form::none;
2439 
2440   return _matrule->is_base_constant(globals);
2441 }
2442 
2443 // "true" if this operand is a simple type that is swallowed
2444 bool  OperandForm::swallowed(FormDict &globals) const {
2445   Form::DataType type   = simple_type(globals);
2446   if( type != Form::none ) {
2447     return true;
2448   }
2449 
2450   return false;
2451 }
2452 
2453 // Output code to access the value of the index'th constant
2454 void OperandForm::access_constant(FILE *fp, FormDict &globals,
2455                                   uint const_index) {
2456   OperandForm *oper = constant_operand(globals, const_index);
2457   assert( oper, "Index exceeds number of constants in operand");
2458   Form::DataType dtype = oper->is_base_constant(globals);
2459 
2460   switch(dtype) {
2461   case idealI: fprintf(fp,"_c%d",           const_index); break;
2462   case idealP: fprintf(fp,"_c%d->get_con()",const_index); break;
2463   case idealL: fprintf(fp,"_c%d",           const_index); break;
2464   case idealF: fprintf(fp,"_c%d",           const_index); break;
2465   case idealD: fprintf(fp,"_c%d",           const_index); break;
2466   default:
2467     assert( false, "ShouldNotReachHere()");
2468   }
2469 }
2470 
2471 
2472 void OperandForm::dump() {
2473   output(stderr);
2474 }
2475 
2476 void OperandForm::output(FILE *fp) {
2477   fprintf(fp,"\nOperand: %s\n", (_ident?_ident:""));
2478   if (_matrule)    _matrule->dump();
2479   if (_interface)  _interface->dump();
2480   if (_attribs)    _attribs->dump();
2481   if (_predicate)  _predicate->dump();
2482   if (_constraint) _constraint->dump();
2483   if (_construct)  _construct->dump();
2484   if (_format)     _format->dump();
2485 }
2486 
2487 //------------------------------Constraint-------------------------------------
2488 Constraint::Constraint(const char *func, const char *arg)
2489   : _func(func), _arg(arg) {
2490 }
2491 Constraint::~Constraint() { /* not owner of char* */
2492 }
2493 
2494 bool Constraint::stack_slots_only() const {
2495   return strcmp(_func, "ALLOC_IN_RC") == 0
2496       && strcmp(_arg,  "stack_slots") == 0;
2497 }
2498 
2499 void Constraint::dump() {
2500   output(stderr);
2501 }
2502 
2503 void Constraint::output(FILE *fp) {           // Write info to output files
2504   assert((_func != NULL && _arg != NULL),"missing constraint function or arg");
2505   fprintf(fp,"Constraint: %s ( %s )\n", _func, _arg);
2506 }
2507 
2508 //------------------------------Predicate--------------------------------------
2509 Predicate::Predicate(char *pr)
2510   : _pred(pr) {
2511 }
2512 Predicate::~Predicate() {
2513 }
2514 
2515 void Predicate::dump() {
2516   output(stderr);
2517 }
2518 
2519 void Predicate::output(FILE *fp) {
2520   fprintf(fp,"Predicate");  // Write to output files
2521 }
2522 //------------------------------Interface--------------------------------------
2523 Interface::Interface(const char *name) : _name(name) {
2524 }
2525 Interface::~Interface() {
2526 }
2527 
2528 Form::InterfaceType Interface::interface_type(FormDict &globals) const {
2529   Interface *thsi = (Interface*)this;
2530   if ( thsi->is_RegInterface()   ) return Form::register_interface;
2531   if ( thsi->is_MemInterface()   ) return Form::memory_interface;
2532   if ( thsi->is_ConstInterface() ) return Form::constant_interface;
2533   if ( thsi->is_CondInterface()  ) return Form::conditional_interface;
2534 
2535   return Form::no_interface;
2536 }
2537 
2538 RegInterface   *Interface::is_RegInterface() {
2539   if ( strcmp(_name,"REG_INTER") != 0 )
2540     return NULL;
2541   return (RegInterface*)this;
2542 }
2543 MemInterface   *Interface::is_MemInterface() {
2544   if ( strcmp(_name,"MEMORY_INTER") != 0 )  return NULL;
2545   return (MemInterface*)this;
2546 }
2547 ConstInterface *Interface::is_ConstInterface() {
2548   if ( strcmp(_name,"CONST_INTER") != 0 )  return NULL;
2549   return (ConstInterface*)this;
2550 }
2551 CondInterface  *Interface::is_CondInterface() {
2552   if ( strcmp(_name,"COND_INTER") != 0 )  return NULL;
2553   return (CondInterface*)this;
2554 }
2555 
2556 
2557 void Interface::dump() {
2558   output(stderr);
2559 }
2560 
2561 // Write info to output files
2562 void Interface::output(FILE *fp) {
2563   fprintf(fp,"Interface: %s\n", (_name ? _name : "") );
2564 }
2565 
2566 //------------------------------RegInterface-----------------------------------
2567 RegInterface::RegInterface() : Interface("REG_INTER") {
2568 }
2569 RegInterface::~RegInterface() {
2570 }
2571 
2572 void RegInterface::dump() {
2573   output(stderr);
2574 }
2575 
2576 // Write info to output files
2577 void RegInterface::output(FILE *fp) {
2578   Interface::output(fp);
2579 }
2580 
2581 //------------------------------ConstInterface---------------------------------
2582 ConstInterface::ConstInterface() : Interface("CONST_INTER") {
2583 }
2584 ConstInterface::~ConstInterface() {
2585 }
2586 
2587 void ConstInterface::dump() {
2588   output(stderr);
2589 }
2590 
2591 // Write info to output files
2592 void ConstInterface::output(FILE *fp) {
2593   Interface::output(fp);
2594 }
2595 
2596 //------------------------------MemInterface-----------------------------------
2597 MemInterface::MemInterface(char *base, char *index, char *scale, char *disp)
2598   : Interface("MEMORY_INTER"), _base(base), _index(index), _scale(scale), _disp(disp) {
2599 }
2600 MemInterface::~MemInterface() {
2601   // not owner of any character arrays
2602 }
2603 
2604 void MemInterface::dump() {
2605   output(stderr);
2606 }
2607 
2608 // Write info to output files
2609 void MemInterface::output(FILE *fp) {
2610   Interface::output(fp);
2611   if ( _base  != NULL ) fprintf(fp,"  base  == %s\n", _base);
2612   if ( _index != NULL ) fprintf(fp,"  index == %s\n", _index);
2613   if ( _scale != NULL ) fprintf(fp,"  scale == %s\n", _scale);
2614   if ( _disp  != NULL ) fprintf(fp,"  disp  == %s\n", _disp);
2615   // fprintf(fp,"\n");
2616 }
2617 
2618 //------------------------------CondInterface----------------------------------
2619 CondInterface::CondInterface(const char* equal,         const char* equal_format,
2620                              const char* not_equal,     const char* not_equal_format,
2621                              const char* less,          const char* less_format,
2622                              const char* greater_equal, const char* greater_equal_format,
2623                              const char* less_equal,    const char* less_equal_format,
2624                              const char* greater,       const char* greater_format)
2625   : Interface("COND_INTER"),
2626     _equal(equal),                 _equal_format(equal_format),
2627     _not_equal(not_equal),         _not_equal_format(not_equal_format),
2628     _less(less),                   _less_format(less_format),
2629     _greater_equal(greater_equal), _greater_equal_format(greater_equal_format),
2630     _less_equal(less_equal),       _less_equal_format(less_equal_format),
2631     _greater(greater),             _greater_format(greater_format) {
2632 }
2633 CondInterface::~CondInterface() {
2634   // not owner of any character arrays
2635 }
2636 
2637 void CondInterface::dump() {
2638   output(stderr);
2639 }
2640 
2641 // Write info to output files
2642 void CondInterface::output(FILE *fp) {
2643   Interface::output(fp);
2644   if ( _equal  != NULL )     fprintf(fp," equal       == %s\n", _equal);
2645   if ( _not_equal  != NULL ) fprintf(fp," not_equal   == %s\n", _not_equal);
2646   if ( _less  != NULL )      fprintf(fp," less        == %s\n", _less);
2647   if ( _greater_equal  != NULL ) fprintf(fp," greater_equal   == %s\n", _greater_equal);
2648   if ( _less_equal  != NULL ) fprintf(fp," less_equal  == %s\n", _less_equal);
2649   if ( _greater  != NULL )    fprintf(fp," greater     == %s\n", _greater);
2650   // fprintf(fp,"\n");
2651 }
2652 
2653 //------------------------------ConstructRule----------------------------------
2654 ConstructRule::ConstructRule(char *cnstr)
2655   : _construct(cnstr) {
2656 }
2657 ConstructRule::~ConstructRule() {
2658 }
2659 
2660 void ConstructRule::dump() {
2661   output(stderr);
2662 }
2663 
2664 void ConstructRule::output(FILE *fp) {
2665   fprintf(fp,"\nConstruct Rule\n");  // Write to output files
2666 }
2667 
2668 
2669 //==============================Shared Forms===================================
2670 //------------------------------AttributeForm----------------------------------
2671 int         AttributeForm::_insId   = 0;           // start counter at 0
2672 int         AttributeForm::_opId    = 0;           // start counter at 0
2673 const char* AttributeForm::_ins_cost = "ins_cost"; // required name
2674 const char* AttributeForm::_ins_pc_relative = "ins_pc_relative";
2675 const char* AttributeForm::_op_cost  = "op_cost";  // required name
2676 
2677 AttributeForm::AttributeForm(char *attr, int type, char *attrdef)
2678   : Form(Form::ATTR), _attrname(attr), _atype(type), _attrdef(attrdef) {
2679     if (type==OP_ATTR) {
2680       id = ++_opId;
2681     }
2682     else if (type==INS_ATTR) {
2683       id = ++_insId;
2684     }
2685     else assert( false,"");
2686 }
2687 AttributeForm::~AttributeForm() {
2688 }
2689 
2690 // Dynamic type check
2691 AttributeForm *AttributeForm::is_attribute() const {
2692   return (AttributeForm*)this;
2693 }
2694 
2695 
2696 // inlined  // int  AttributeForm::type() { return id;}
2697 
2698 void AttributeForm::dump() {
2699   output(stderr);
2700 }
2701 
2702 void AttributeForm::output(FILE *fp) {
2703   if( _attrname && _attrdef ) {
2704     fprintf(fp,"\n// AttributeForm \nstatic const int %s = %s;\n",
2705             _attrname, _attrdef);
2706   }
2707   else {
2708     fprintf(fp,"\n// AttributeForm missing name %s or definition %s\n",
2709             (_attrname?_attrname:""), (_attrdef?_attrdef:"") );
2710   }
2711 }
2712 
2713 //------------------------------Component--------------------------------------
2714 Component::Component(const char *name, const char *type, int usedef)
2715   : _name(name), _type(type), _usedef(usedef) {
2716     _ftype = Form::COMP;
2717 }
2718 Component::~Component() {
2719 }
2720 
2721 // True if this component is equal to the parameter.
2722 bool Component::is(int use_def_kill_enum) const {
2723   return (_usedef == use_def_kill_enum ? true : false);
2724 }
2725 // True if this component is used/def'd/kill'd as the parameter suggests.
2726 bool Component::isa(int use_def_kill_enum) const {
2727   return (_usedef & use_def_kill_enum) == use_def_kill_enum;
2728 }
2729 
2730 // Extend this component with additional use/def/kill behavior
2731 int Component::promote_use_def_info(int new_use_def) {
2732   _usedef |= new_use_def;
2733 
2734   return _usedef;
2735 }
2736 
2737 // Check the base type of this component, if it has one
2738 const char *Component::base_type(FormDict &globals) {
2739   const Form *frm = globals[_type];
2740   if (frm == NULL) return NULL;
2741   OperandForm *op = frm->is_operand();
2742   if (op == NULL) return NULL;
2743   if (op->ideal_only()) return op->_ident;
2744   return (char *)op->ideal_type(globals);
2745 }
2746 
2747 void Component::dump() {
2748   output(stderr);
2749 }
2750 
2751 void Component::output(FILE *fp) {
2752   fprintf(fp,"Component:");  // Write to output files
2753   fprintf(fp, "  name = %s", _name);
2754   fprintf(fp, ", type = %s", _type);
2755   const char * usedef = "Undefined Use/Def info";
2756   switch (_usedef) {
2757     case USE:      usedef = "USE";      break;
2758     case USE_DEF:  usedef = "USE_DEF";  break;
2759     case USE_KILL: usedef = "USE_KILL"; break;
2760     case KILL:     usedef = "KILL";     break;
2761     case TEMP:     usedef = "TEMP";     break;
2762     case DEF:      usedef = "DEF";      break;
2763     default: assert(false, "unknown effect");
2764   }
2765   fprintf(fp, ", use/def = %s\n", usedef);
2766 }
2767 
2768 
2769 //------------------------------ComponentList---------------------------------
2770 ComponentList::ComponentList() : NameList(), _matchcnt(0) {
2771 }
2772 ComponentList::~ComponentList() {
2773   // // This list may not own its elements if copied via assignment
2774   // Component *component;
2775   // for (reset(); (component = iter()) != NULL;) {
2776   //   delete component;
2777   // }
2778 }
2779 
2780 void   ComponentList::insert(Component *component, bool mflag) {
2781   NameList::addName((char *)component);
2782   if(mflag) _matchcnt++;
2783 }
2784 void   ComponentList::insert(const char *name, const char *opType, int usedef,
2785                              bool mflag) {
2786   Component * component = new Component(name, opType, usedef);
2787   insert(component, mflag);
2788 }
2789 Component *ComponentList::current() { return (Component*)NameList::current(); }
2790 Component *ComponentList::iter()    { return (Component*)NameList::iter(); }
2791 Component *ComponentList::match_iter() {
2792   if(_iter < _matchcnt) return (Component*)NameList::iter();
2793   return NULL;
2794 }
2795 Component *ComponentList::post_match_iter() {
2796   Component *comp = iter();
2797   // At end of list?
2798   if ( comp == NULL ) {
2799     return comp;
2800   }
2801   // In post-match components?
2802   if (_iter > match_count()-1) {
2803     return comp;
2804   }
2805 
2806   return post_match_iter();
2807 }
2808 
2809 void       ComponentList::reset()   { NameList::reset(); }
2810 int        ComponentList::count()   { return NameList::count(); }
2811 
2812 Component *ComponentList::operator[](int position) {
2813   // Shortcut complete iteration if there are not enough entries
2814   if (position >= count()) return NULL;
2815 
2816   int        index     = 0;
2817   Component *component = NULL;
2818   for (reset(); (component = iter()) != NULL;) {
2819     if (index == position) {
2820       return component;
2821     }
2822     ++index;
2823   }
2824 
2825   return NULL;
2826 }
2827 
2828 const Component *ComponentList::search(const char *name) {
2829   PreserveIter pi(this);
2830   reset();
2831   for( Component *comp = NULL; ((comp = iter()) != NULL); ) {
2832     if( strcmp(comp->_name,name) == 0 ) return comp;
2833   }
2834 
2835   return NULL;
2836 }
2837 
2838 // Return number of USEs + number of DEFs
2839 // When there are no components, or the first component is a USE,
2840 // then we add '1' to hold a space for the 'result' operand.
2841 int ComponentList::num_operands() {
2842   PreserveIter pi(this);
2843   uint       count = 1;           // result operand
2844   uint       position = 0;
2845 
2846   Component *component  = NULL;
2847   for( reset(); (component = iter()) != NULL; ++position ) {
2848     if( component->isa(Component::USE) ||
2849         ( position == 0 && (! component->isa(Component::DEF))) ) {
2850       ++count;
2851     }
2852   }
2853 
2854   return count;
2855 }
2856 
2857 // Return zero-based position in list;  -1 if not in list.
2858 // if parameter 'usedef' is ::USE, it will match USE, USE_DEF, ...
2859 int ComponentList::operand_position(const char *name, int usedef) {
2860   PreserveIter pi(this);
2861   int position = 0;
2862   int num_opnds = num_operands();
2863   Component *component;
2864   Component* preceding_non_use = NULL;
2865   Component* first_def = NULL;
2866   for (reset(); (component = iter()) != NULL; ++position) {
2867     // When the first component is not a DEF,
2868     // leave space for the result operand!
2869     if ( position==0 && (! component->isa(Component::DEF)) ) {
2870       ++position;
2871       ++num_opnds;
2872     }
2873     if (strcmp(name, component->_name)==0 && (component->isa(usedef))) {
2874       // When the first entry in the component list is a DEF and a USE
2875       // Treat them as being separate, a DEF first, then a USE
2876       if( position==0
2877           && usedef==Component::USE && component->isa(Component::DEF) ) {
2878         assert(position+1 < num_opnds, "advertised index in bounds");
2879         return position+1;
2880       } else {
2881         if( preceding_non_use && strcmp(component->_name, preceding_non_use->_name) ) {
2882           fprintf(stderr, "the name '%s' should not precede the name '%s'\n", preceding_non_use->_name, name);
2883         }
2884         if( position >= num_opnds ) {
2885           fprintf(stderr, "the name '%s' is too late in its name list\n", name);
2886         }
2887         assert(position < num_opnds, "advertised index in bounds");
2888         return position;
2889       }
2890     }
2891     if( component->isa(Component::DEF)
2892         && component->isa(Component::USE) ) {
2893       ++position;
2894       if( position != 1 )  --position;   // only use two slots for the 1st USE_DEF
2895     }
2896     if( component->isa(Component::DEF) && !first_def ) {
2897       first_def = component;
2898     }
2899     if( !component->isa(Component::USE) && component != first_def ) {
2900       preceding_non_use = component;
2901     } else if( preceding_non_use && !strcmp(component->_name, preceding_non_use->_name) ) {
2902       preceding_non_use = NULL;
2903     }
2904   }
2905   return Not_in_list;
2906 }
2907 
2908 // Find position for this name, regardless of use/def information
2909 int ComponentList::operand_position(const char *name) {
2910   PreserveIter pi(this);
2911   int position = 0;
2912   Component *component;
2913   for (reset(); (component = iter()) != NULL; ++position) {
2914     // When the first component is not a DEF,
2915     // leave space for the result operand!
2916     if ( position==0 && (! component->isa(Component::DEF)) ) {
2917       ++position;
2918     }
2919     if (strcmp(name, component->_name)==0) {
2920       return position;
2921     }
2922     if( component->isa(Component::DEF)
2923         && component->isa(Component::USE) ) {
2924       ++position;
2925       if( position != 1 )  --position;   // only use two slots for the 1st USE_DEF
2926     }
2927   }
2928   return Not_in_list;
2929 }
2930 
2931 int ComponentList::operand_position_format(const char *name) {
2932   PreserveIter pi(this);
2933   int  first_position = operand_position(name);
2934   int  use_position   = operand_position(name, Component::USE);
2935 
2936   return ((first_position < use_position) ? use_position : first_position);
2937 }
2938 
2939 int ComponentList::label_position() {
2940   PreserveIter pi(this);
2941   int position = 0;
2942   reset();
2943   for( Component *comp; (comp = iter()) != NULL; ++position) {
2944     // When the first component is not a DEF,
2945     // leave space for the result operand!
2946     if ( position==0 && (! comp->isa(Component::DEF)) ) {
2947       ++position;
2948     }
2949     if (strcmp(comp->_type, "label")==0) {
2950       return position;
2951     }
2952     if( comp->isa(Component::DEF)
2953         && comp->isa(Component::USE) ) {
2954       ++position;
2955       if( position != 1 )  --position;   // only use two slots for the 1st USE_DEF
2956     }
2957   }
2958 
2959   return -1;
2960 }
2961 
2962 int ComponentList::method_position() {
2963   PreserveIter pi(this);
2964   int position = 0;
2965   reset();
2966   for( Component *comp; (comp = iter()) != NULL; ++position) {
2967     // When the first component is not a DEF,
2968     // leave space for the result operand!
2969     if ( position==0 && (! comp->isa(Component::DEF)) ) {
2970       ++position;
2971     }
2972     if (strcmp(comp->_type, "method")==0) {
2973       return position;
2974     }
2975     if( comp->isa(Component::DEF)
2976         && comp->isa(Component::USE) ) {
2977       ++position;
2978       if( position != 1 )  --position;   // only use two slots for the 1st USE_DEF
2979     }
2980   }
2981 
2982   return -1;
2983 }
2984 
2985 void ComponentList::dump() { output(stderr); }
2986 
2987 void ComponentList::output(FILE *fp) {
2988   PreserveIter pi(this);
2989   fprintf(fp, "\n");
2990   Component *component;
2991   for (reset(); (component = iter()) != NULL;) {
2992     component->output(fp);
2993   }
2994   fprintf(fp, "\n");
2995 }
2996 
2997 //------------------------------MatchNode--------------------------------------
2998 MatchNode::MatchNode(ArchDesc &ad, const char *result, const char *mexpr,
2999                      const char *opType, MatchNode *lChild, MatchNode *rChild)
3000   : _AD(ad), _result(result), _name(mexpr), _opType(opType),
3001     _lChild(lChild), _rChild(rChild), _internalop(0), _numleaves(0),
3002     _commutative_id(0) {
3003   _numleaves = (lChild ? lChild->_numleaves : 0)
3004                + (rChild ? rChild->_numleaves : 0);
3005 }
3006 
3007 MatchNode::MatchNode(ArchDesc &ad, MatchNode& mnode)
3008   : _AD(ad), _result(mnode._result), _name(mnode._name),
3009     _opType(mnode._opType), _lChild(mnode._lChild), _rChild(mnode._rChild),
3010     _internalop(0), _numleaves(mnode._numleaves),
3011     _commutative_id(mnode._commutative_id) {
3012 }
3013 
3014 MatchNode::MatchNode(ArchDesc &ad, MatchNode& mnode, int clone)
3015   : _AD(ad), _result(mnode._result), _name(mnode._name),
3016     _opType(mnode._opType),
3017     _internalop(0), _numleaves(mnode._numleaves),
3018     _commutative_id(mnode._commutative_id) {
3019   if (mnode._lChild) {
3020     _lChild = new MatchNode(ad, *mnode._lChild, clone);
3021   } else {
3022     _lChild = NULL;
3023   }
3024   if (mnode._rChild) {
3025     _rChild = new MatchNode(ad, *mnode._rChild, clone);
3026   } else {
3027     _rChild = NULL;
3028   }
3029 }
3030 
3031 MatchNode::~MatchNode() {
3032   // // This node may not own its children if copied via assignment
3033   // if( _lChild ) delete _lChild;
3034   // if( _rChild ) delete _rChild;
3035 }
3036 
3037 bool  MatchNode::find_type(const char *type, int &position) const {
3038   if ( (_lChild != NULL) && (_lChild->find_type(type, position)) ) return true;
3039   if ( (_rChild != NULL) && (_rChild->find_type(type, position)) ) return true;
3040 
3041   if (strcmp(type,_opType)==0)  {
3042     return true;
3043   } else {
3044     ++position;
3045   }
3046   return false;
3047 }
3048 
3049 // Recursive call collecting info on top-level operands, not transitive.
3050 // Implementation does not modify state of internal structures.
3051 void MatchNode::append_components(FormDict &locals, ComponentList &components,
3052                                   bool deflag) const {
3053   int   usedef = deflag ? Component::DEF : Component::USE;
3054   FormDict &globals = _AD.globalNames();
3055 
3056   assert (_name != NULL, "MatchNode::build_components encountered empty node\n");
3057   // Base case
3058   if (_lChild==NULL && _rChild==NULL) {
3059     // If _opType is not an operation, do not build a component for it #####
3060     const Form *f = globals[_opType];
3061     if( f != NULL ) {
3062       // Add non-ideals that are operands, operand-classes,
3063       if( ! f->ideal_only()
3064           && (f->is_opclass() || f->is_operand()) ) {
3065         components.insert(_name, _opType, usedef, true);
3066       }
3067     }
3068     return;
3069   }
3070   // Promote results of "Set" to DEF
3071   bool def_flag = (!strcmp(_opType, "Set")) ? true : false;
3072   if (_lChild) _lChild->append_components(locals, components, def_flag);
3073   def_flag = false;   // only applies to component immediately following 'Set'
3074   if (_rChild) _rChild->append_components(locals, components, def_flag);
3075 }
3076 
3077 // Find the n'th base-operand in the match node,
3078 // recursively investigates match rules of user-defined operands.
3079 //
3080 // Implementation does not modify state of internal structures since they
3081 // can be shared.
3082 bool MatchNode::base_operand(uint &position, FormDict &globals,
3083                              const char * &result, const char * &name,
3084                              const char * &opType) const {
3085   assert (_name != NULL, "MatchNode::base_operand encountered empty node\n");
3086   // Base case
3087   if (_lChild==NULL && _rChild==NULL) {
3088     // Check for special case: "Universe", "label"
3089     if (strcmp(_opType,"Universe") == 0 || strcmp(_opType,"label")==0 ) {
3090       if (position == 0) {
3091         result = _result;
3092         name   = _name;
3093         opType = _opType;
3094         return 1;
3095       } else {
3096         -- position;
3097         return 0;
3098       }
3099     }
3100 
3101     const Form *form = globals[_opType];
3102     MatchNode *matchNode = NULL;
3103     // Check for user-defined type
3104     if (form) {
3105       // User operand or instruction?
3106       OperandForm  *opForm = form->is_operand();
3107       InstructForm *inForm = form->is_instruction();
3108       if ( opForm ) {
3109         matchNode = (MatchNode*)opForm->_matrule;
3110       } else if ( inForm ) {
3111         matchNode = (MatchNode*)inForm->_matrule;
3112       }
3113     }
3114     // if this is user-defined, recurse on match rule
3115     // User-defined operand and instruction forms have a match-rule.
3116     if (matchNode) {
3117       return (matchNode->base_operand(position,globals,result,name,opType));
3118     } else {
3119       // Either not a form, or a system-defined form (no match rule).
3120       if (position==0) {
3121         result = _result;
3122         name   = _name;
3123         opType = _opType;
3124         return 1;
3125       } else {
3126         --position;
3127         return 0;
3128       }
3129     }
3130 
3131   } else {
3132     // Examine the left child and right child as well
3133     if (_lChild) {
3134       if (_lChild->base_operand(position, globals, result, name, opType))
3135         return 1;
3136     }
3137 
3138     if (_rChild) {
3139       if (_rChild->base_operand(position, globals, result, name, opType))
3140         return 1;
3141     }
3142   }
3143 
3144   return 0;
3145 }
3146 
3147 // Recursive call on all operands' match rules in my match rule.
3148 uint  MatchNode::num_consts(FormDict &globals) const {
3149   uint        index      = 0;
3150   uint        num_consts = 0;
3151   const char *result;
3152   const char *name;
3153   const char *opType;
3154 
3155   for (uint position = index;
3156        base_operand(position,globals,result,name,opType); position = index) {
3157     ++index;
3158     if( ideal_to_const_type(opType) )        num_consts++;
3159   }
3160 
3161   return num_consts;
3162 }
3163 
3164 // Recursive call on all operands' match rules in my match rule.
3165 // Constants in match rule subtree with specified type
3166 uint  MatchNode::num_consts(FormDict &globals, Form::DataType type) const {
3167   uint        index      = 0;
3168   uint        num_consts = 0;
3169   const char *result;
3170   const char *name;
3171   const char *opType;
3172 
3173   for (uint position = index;
3174        base_operand(position,globals,result,name,opType); position = index) {
3175     ++index;
3176     if( ideal_to_const_type(opType) == type ) num_consts++;
3177   }
3178 
3179   return num_consts;
3180 }
3181 
3182 // Recursive call on all operands' match rules in my match rule.
3183 uint  MatchNode::num_const_ptrs(FormDict &globals) const {
3184   return  num_consts( globals, Form::idealP );
3185 }
3186 
3187 bool  MatchNode::sets_result() const {
3188   return   ( (strcmp(_name,"Set") == 0) ? true : false );
3189 }
3190 
3191 const char *MatchNode::reduce_right(FormDict &globals) const {
3192   // If there is no right reduction, return NULL.
3193   const char      *rightStr    = NULL;
3194 
3195   // If we are a "Set", start from the right child.
3196   const MatchNode *const mnode = sets_result() ?
3197     (const MatchNode *const)this->_rChild :
3198     (const MatchNode *const)this;
3199 
3200   // If our right child exists, it is the right reduction
3201   if ( mnode->_rChild ) {
3202     rightStr = mnode->_rChild->_internalop ? mnode->_rChild->_internalop
3203       : mnode->_rChild->_opType;
3204   }
3205   // Else, May be simple chain rule: (Set dst operand_form), rightStr=NULL;
3206   return rightStr;
3207 }
3208 
3209 const char *MatchNode::reduce_left(FormDict &globals) const {
3210   // If there is no left reduction, return NULL.
3211   const char  *leftStr  = NULL;
3212 
3213   // If we are a "Set", start from the right child.
3214   const MatchNode *const mnode = sets_result() ?
3215     (const MatchNode *const)this->_rChild :
3216     (const MatchNode *const)this;
3217 
3218   // If our left child exists, it is the left reduction
3219   if ( mnode->_lChild ) {
3220     leftStr = mnode->_lChild->_internalop ? mnode->_lChild->_internalop
3221       : mnode->_lChild->_opType;
3222   } else {
3223     // May be simple chain rule: (Set dst operand_form_source)
3224     if ( sets_result() ) {
3225       OperandForm *oper = globals[mnode->_opType]->is_operand();
3226       if( oper ) {
3227         leftStr = mnode->_opType;
3228       }
3229     }
3230   }
3231   return leftStr;
3232 }
3233 
3234 //------------------------------count_instr_names------------------------------
3235 // Count occurrences of operands names in the leaves of the instruction
3236 // match rule.
3237 void MatchNode::count_instr_names( Dict &names ) {
3238   if( !this ) return;
3239   if( _lChild ) _lChild->count_instr_names(names);
3240   if( _rChild ) _rChild->count_instr_names(names);
3241   if( !_lChild && !_rChild ) {
3242     uintptr_t cnt = (uintptr_t)names[_name];
3243     cnt++;                      // One more name found
3244     names.Insert(_name,(void*)cnt);
3245   }
3246 }
3247 
3248 //------------------------------build_instr_pred-------------------------------
3249 // Build a path to 'name' in buf.  Actually only build if cnt is zero, so we
3250 // can skip some leading instances of 'name'.
3251 int MatchNode::build_instr_pred( char *buf, const char *name, int cnt ) {
3252   if( _lChild ) {
3253     if( !cnt ) strcpy( buf, "_kids[0]->" );
3254     cnt = _lChild->build_instr_pred( buf+strlen(buf), name, cnt );
3255     if( cnt < 0 ) return cnt;   // Found it, all done
3256   }
3257   if( _rChild ) {
3258     if( !cnt ) strcpy( buf, "_kids[1]->" );
3259     cnt = _rChild->build_instr_pred( buf+strlen(buf), name, cnt );
3260     if( cnt < 0 ) return cnt;   // Found it, all done
3261   }
3262   if( !_lChild && !_rChild ) {  // Found a leaf
3263     // Wrong name?  Give up...
3264     if( strcmp(name,_name) ) return cnt;
3265     if( !cnt ) strcpy(buf,"_leaf");
3266     return cnt-1;
3267   }
3268   return cnt;
3269 }
3270 
3271 
3272 //------------------------------build_internalop-------------------------------
3273 // Build string representation of subtree
3274 void MatchNode::build_internalop( ) {
3275   char *iop, *subtree;
3276   const char *lstr, *rstr;
3277   // Build string representation of subtree
3278   // Operation lchildType rchildType
3279   int len = (int)strlen(_opType) + 4;
3280   lstr = (_lChild) ? ((_lChild->_internalop) ?
3281                        _lChild->_internalop : _lChild->_opType) : "";
3282   rstr = (_rChild) ? ((_rChild->_internalop) ?
3283                        _rChild->_internalop : _rChild->_opType) : "";
3284   len += (int)strlen(lstr) + (int)strlen(rstr);
3285   subtree = (char *)malloc(len);
3286   sprintf(subtree,"_%s_%s_%s", _opType, lstr, rstr);
3287   // Hash the subtree string in _internalOps; if a name exists, use it
3288   iop = (char *)_AD._internalOps[subtree];
3289   // Else create a unique name, and add it to the hash table
3290   if (iop == NULL) {
3291     iop = subtree;
3292     _AD._internalOps.Insert(subtree, iop);
3293     _AD._internalOpNames.addName(iop);
3294     _AD._internalMatch.Insert(iop, this);
3295   }
3296   // Add the internal operand name to the MatchNode
3297   _internalop = iop;
3298   _result = iop;
3299 }
3300 
3301 
3302 void MatchNode::dump() {
3303   output(stderr);
3304 }
3305 
3306 void MatchNode::output(FILE *fp) {
3307   if (_lChild==0 && _rChild==0) {
3308     fprintf(fp," %s",_name);    // operand
3309   }
3310   else {
3311     fprintf(fp," (%s ",_name);  // " (opcodeName "
3312     if(_lChild) _lChild->output(fp); //               left operand
3313     if(_rChild) _rChild->output(fp); //                    right operand
3314     fprintf(fp,")");                 //                                 ")"
3315   }
3316 }
3317 
3318 int MatchNode::needs_ideal_memory_edge(FormDict &globals) const {
3319   static const char *needs_ideal_memory_list[] = {
3320     "StoreI","StoreL","StoreP","StoreN","StoreD","StoreF" ,
3321     "StoreB","StoreC","Store" ,"StoreFP",
3322     "LoadI" ,"LoadL", "LoadP" ,"LoadN", "LoadD" ,"LoadF"  ,
3323     "LoadB" ,"LoadUS" ,"LoadS" ,"Load"   ,
3324     "Store4I","Store2I","Store2L","Store2D","Store4F","Store2F","Store16B",
3325     "Store8B","Store4B","Store8C","Store4C","Store2C",
3326     "Load4I" ,"Load2I" ,"Load2L" ,"Load2D" ,"Load4F" ,"Load2F" ,"Load16B" ,
3327     "Load8B" ,"Load4B" ,"Load8C" ,"Load4C" ,"Load2C" ,"Load8S", "Load4S","Load2S",
3328     "LoadRange", "LoadKlass", "LoadNKlass", "LoadL_unaligned", "LoadD_unaligned",
3329     "LoadPLocked", "LoadLLocked",
3330     "StorePConditional", "StoreIConditional", "StoreLConditional",
3331     "CompareAndSwapI", "CompareAndSwapL", "CompareAndSwapP", "CompareAndSwapN",
3332     "StoreCM",
3333     "ClearArray"
3334   };
3335   int cnt = sizeof(needs_ideal_memory_list)/sizeof(char*);
3336   if( strcmp(_opType,"PrefetchRead")==0 || strcmp(_opType,"PrefetchWrite")==0 )
3337     return 1;
3338   if( _lChild ) {
3339     const char *opType = _lChild->_opType;
3340     for( int i=0; i<cnt; i++ )
3341       if( strcmp(opType,needs_ideal_memory_list[i]) == 0 )
3342         return 1;
3343     if( _lChild->needs_ideal_memory_edge(globals) )
3344       return 1;
3345   }
3346   if( _rChild ) {
3347     const char *opType = _rChild->_opType;
3348     for( int i=0; i<cnt; i++ )
3349       if( strcmp(opType,needs_ideal_memory_list[i]) == 0 )
3350         return 1;
3351     if( _rChild->needs_ideal_memory_edge(globals) )
3352       return 1;
3353   }
3354 
3355   return 0;
3356 }
3357 
3358 // TRUE if defines a derived oop, and so needs a base oop edge present
3359 // post-matching.
3360 int MatchNode::needs_base_oop_edge() const {
3361   if( !strcmp(_opType,"AddP") ) return 1;
3362   if( strcmp(_opType,"Set") ) return 0;
3363   return !strcmp(_rChild->_opType,"AddP");
3364 }
3365 
3366 int InstructForm::needs_base_oop_edge(FormDict &globals) const {
3367   if( is_simple_chain_rule(globals) ) {
3368     const char *src = _matrule->_rChild->_opType;
3369     OperandForm *src_op = globals[src]->is_operand();
3370     assert( src_op, "Not operand class of chain rule" );
3371     return src_op->_matrule ? src_op->_matrule->needs_base_oop_edge() : 0;
3372   }                             // Else check instruction
3373 
3374   return _matrule ? _matrule->needs_base_oop_edge() : 0;
3375 }
3376 
3377 
3378 //-------------------------cisc spilling methods-------------------------------
3379 // helper routines and methods for detecting cisc-spilling instructions
3380 //-------------------------cisc_spill_merge------------------------------------
3381 int MatchNode::cisc_spill_merge(int left_spillable, int right_spillable) {
3382   int cisc_spillable  = Maybe_cisc_spillable;
3383 
3384   // Combine results of left and right checks
3385   if( (left_spillable == Maybe_cisc_spillable) && (right_spillable == Maybe_cisc_spillable) ) {
3386     // neither side is spillable, nor prevents cisc spilling
3387     cisc_spillable = Maybe_cisc_spillable;
3388   }
3389   else if( (left_spillable == Maybe_cisc_spillable) && (right_spillable > Maybe_cisc_spillable) ) {
3390     // right side is spillable
3391     cisc_spillable = right_spillable;
3392   }
3393   else if( (right_spillable == Maybe_cisc_spillable) && (left_spillable > Maybe_cisc_spillable) ) {
3394     // left side is spillable
3395     cisc_spillable = left_spillable;
3396   }
3397   else if( (left_spillable == Not_cisc_spillable) || (right_spillable == Not_cisc_spillable) ) {
3398     // left or right prevents cisc spilling this instruction
3399     cisc_spillable = Not_cisc_spillable;
3400   }
3401   else {
3402     // Only allow one to spill
3403     cisc_spillable = Not_cisc_spillable;
3404   }
3405 
3406   return cisc_spillable;
3407 }
3408 
3409 //-------------------------root_ops_match--------------------------------------
3410 bool static root_ops_match(FormDict &globals, const char *op1, const char *op2) {
3411   // Base Case: check that the current operands/operations match
3412   assert( op1, "Must have op's name");
3413   assert( op2, "Must have op's name");
3414   const Form *form1 = globals[op1];
3415   const Form *form2 = globals[op2];
3416 
3417   return (form1 == form2);
3418 }
3419 
3420 //-------------------------cisc_spill_match------------------------------------
3421 // Recursively check two MatchRules for legal conversion via cisc-spilling
3422 int  MatchNode::cisc_spill_match(FormDict &globals, RegisterForm *registers, MatchNode *mRule2, const char * &operand, const char * &reg_type) {
3423   int cisc_spillable  = Maybe_cisc_spillable;
3424   int left_spillable  = Maybe_cisc_spillable;
3425   int right_spillable = Maybe_cisc_spillable;
3426 
3427   // Check that each has same number of operands at this level
3428   if( (_lChild && !(mRule2->_lChild)) || (_rChild && !(mRule2->_rChild)) )
3429     return Not_cisc_spillable;
3430 
3431   // Base Case: check that the current operands/operations match
3432   // or are CISC spillable
3433   assert( _opType, "Must have _opType");
3434   assert( mRule2->_opType, "Must have _opType");
3435   const Form *form  = globals[_opType];
3436   const Form *form2 = globals[mRule2->_opType];
3437   if( form == form2 ) {
3438     cisc_spillable = Maybe_cisc_spillable;
3439   } else {
3440     const InstructForm *form2_inst = form2 ? form2->is_instruction() : NULL;
3441     const char *name_left  = mRule2->_lChild ? mRule2->_lChild->_opType : NULL;
3442     const char *name_right = mRule2->_rChild ? mRule2->_rChild->_opType : NULL;
3443     // Detect reg vs (loadX memory)
3444     if( form->is_cisc_reg(globals)
3445         && form2_inst
3446         && (is_load_from_memory(mRule2->_opType) != Form::none) // reg vs. (load memory)
3447         && (name_left != NULL)       // NOT (load)
3448         && (name_right == NULL) ) {  // NOT (load memory foo)
3449       const Form *form2_left = name_left ? globals[name_left] : NULL;
3450       if( form2_left && form2_left->is_cisc_mem(globals) ) {
3451         cisc_spillable = Is_cisc_spillable;
3452         operand        = _name;
3453         reg_type       = _result;
3454         return Is_cisc_spillable;
3455       } else {
3456         cisc_spillable = Not_cisc_spillable;
3457       }
3458     }
3459     // Detect reg vs memory
3460     else if( form->is_cisc_reg(globals) && form2->is_cisc_mem(globals) ) {
3461       cisc_spillable = Is_cisc_spillable;
3462       operand        = _name;
3463       reg_type       = _result;
3464       return Is_cisc_spillable;
3465     } else {
3466       cisc_spillable = Not_cisc_spillable;
3467     }
3468   }
3469 
3470   // If cisc is still possible, check rest of tree
3471   if( cisc_spillable == Maybe_cisc_spillable ) {
3472     // Check that each has same number of operands at this level
3473     if( (_lChild && !(mRule2->_lChild)) || (_rChild && !(mRule2->_rChild)) ) return Not_cisc_spillable;
3474 
3475     // Check left operands
3476     if( (_lChild == NULL) && (mRule2->_lChild == NULL) ) {
3477       left_spillable = Maybe_cisc_spillable;
3478     } else {
3479       left_spillable = _lChild->cisc_spill_match(globals, registers, mRule2->_lChild, operand, reg_type);
3480     }
3481 
3482     // Check right operands
3483     if( (_rChild == NULL) && (mRule2->_rChild == NULL) ) {
3484       right_spillable =  Maybe_cisc_spillable;
3485     } else {
3486       right_spillable = _rChild->cisc_spill_match(globals, registers, mRule2->_rChild, operand, reg_type);
3487     }
3488 
3489     // Combine results of left and right checks
3490     cisc_spillable = cisc_spill_merge(left_spillable, right_spillable);
3491   }
3492 
3493   return cisc_spillable;
3494 }
3495 
3496 //---------------------------cisc_spill_match----------------------------------
3497 // Recursively check two MatchRules for legal conversion via cisc-spilling
3498 // This method handles the root of Match tree,
3499 // general recursive checks done in MatchNode
3500 int  MatchRule::cisc_spill_match(FormDict &globals, RegisterForm *registers,
3501                                  MatchRule *mRule2, const char * &operand,
3502                                  const char * &reg_type) {
3503   int cisc_spillable  = Maybe_cisc_spillable;
3504   int left_spillable  = Maybe_cisc_spillable;
3505   int right_spillable = Maybe_cisc_spillable;
3506 
3507   // Check that each sets a result
3508   if( !(sets_result() && mRule2->sets_result()) ) return Not_cisc_spillable;
3509   // Check that each has same number of operands at this level
3510   if( (_lChild && !(mRule2->_lChild)) || (_rChild && !(mRule2->_rChild)) ) return Not_cisc_spillable;
3511 
3512   // Check left operands: at root, must be target of 'Set'
3513   if( (_lChild == NULL) || (mRule2->_lChild == NULL) ) {
3514     left_spillable = Not_cisc_spillable;
3515   } else {
3516     // Do not support cisc-spilling instruction's target location
3517     if( root_ops_match(globals, _lChild->_opType, mRule2->_lChild->_opType) ) {
3518       left_spillable = Maybe_cisc_spillable;
3519     } else {
3520       left_spillable = Not_cisc_spillable;
3521     }
3522   }
3523 
3524   // Check right operands: recursive walk to identify reg->mem operand
3525   if( (_rChild == NULL) && (mRule2->_rChild == NULL) ) {
3526     right_spillable =  Maybe_cisc_spillable;
3527   } else {
3528     right_spillable = _rChild->cisc_spill_match(globals, registers, mRule2->_rChild, operand, reg_type);
3529   }
3530 
3531   // Combine results of left and right checks
3532   cisc_spillable = cisc_spill_merge(left_spillable, right_spillable);
3533 
3534   return cisc_spillable;
3535 }
3536 
3537 //----------------------------- equivalent ------------------------------------
3538 // Recursively check to see if two match rules are equivalent.
3539 // This rule handles the root.
3540 bool MatchRule::equivalent(FormDict &globals, MatchRule *mRule2) {
3541   // Check that each sets a result
3542   if (sets_result() != mRule2->sets_result()) {
3543     return false;
3544   }
3545 
3546   // Check that the current operands/operations match
3547   assert( _opType, "Must have _opType");
3548   assert( mRule2->_opType, "Must have _opType");
3549   const Form *form  = globals[_opType];
3550   const Form *form2 = globals[mRule2->_opType];
3551   if( form != form2 ) {
3552     return false;
3553   }
3554 
3555   if (_lChild ) {
3556     if( !_lChild->equivalent(globals, mRule2->_lChild) )
3557       return false;
3558   } else if (mRule2->_lChild) {
3559     return false; // I have NULL left child, mRule2 has non-NULL left child.
3560   }
3561 
3562   if (_rChild ) {
3563     if( !_rChild->equivalent(globals, mRule2->_rChild) )
3564       return false;
3565   } else if (mRule2->_rChild) {
3566     return false; // I have NULL right child, mRule2 has non-NULL right child.
3567   }
3568 
3569   // We've made it through the gauntlet.
3570   return true;
3571 }
3572 
3573 //----------------------------- equivalent ------------------------------------
3574 // Recursively check to see if two match rules are equivalent.
3575 // This rule handles the operands.
3576 bool MatchNode::equivalent(FormDict &globals, MatchNode *mNode2) {
3577   if( !mNode2 )
3578     return false;
3579 
3580   // Check that the current operands/operations match
3581   assert( _opType, "Must have _opType");
3582   assert( mNode2->_opType, "Must have _opType");
3583   const Form *form  = globals[_opType];
3584   const Form *form2 = globals[mNode2->_opType];
3585   return (form == form2);
3586 }
3587 
3588 //-------------------------- has_commutative_op -------------------------------
3589 // Recursively check for commutative operations with subtree operands
3590 // which could be swapped.
3591 void MatchNode::count_commutative_op(int& count) {
3592   static const char *commut_op_list[] = {
3593     "AddI","AddL","AddF","AddD",
3594     "AndI","AndL",
3595     "MaxI","MinI",
3596     "MulI","MulL","MulF","MulD",
3597     "OrI" ,"OrL" ,
3598     "XorI","XorL"
3599   };
3600   int cnt = sizeof(commut_op_list)/sizeof(char*);
3601 
3602   if( _lChild && _rChild && (_lChild->_lChild || _rChild->_lChild) ) {
3603     // Don't swap if right operand is an immediate constant.
3604     bool is_const = false;
3605     if( _rChild->_lChild == NULL && _rChild->_rChild == NULL ) {
3606       FormDict &globals = _AD.globalNames();
3607       const Form *form = globals[_rChild->_opType];
3608       if ( form ) {
3609         OperandForm  *oper = form->is_operand();
3610         if( oper && oper->interface_type(globals) == Form::constant_interface )
3611           is_const = true;
3612       }
3613     }
3614     if( !is_const ) {
3615       for( int i=0; i<cnt; i++ ) {
3616         if( strcmp(_opType, commut_op_list[i]) == 0 ) {
3617           count++;
3618           _commutative_id = count; // id should be > 0
3619           break;
3620         }
3621       }
3622     }
3623   }
3624   if( _lChild )
3625     _lChild->count_commutative_op(count);
3626   if( _rChild )
3627     _rChild->count_commutative_op(count);
3628 }
3629 
3630 //-------------------------- swap_commutative_op ------------------------------
3631 // Recursively swap specified commutative operation with subtree operands.
3632 void MatchNode::swap_commutative_op(bool atroot, int id) {
3633   if( _commutative_id == id ) { // id should be > 0
3634     assert(_lChild && _rChild && (_lChild->_lChild || _rChild->_lChild ),
3635             "not swappable operation");
3636     MatchNode* tmp = _lChild;
3637     _lChild = _rChild;
3638     _rChild = tmp;
3639     // Don't exit here since we need to build internalop.
3640   }
3641 
3642   bool is_set = ( strcmp(_opType, "Set") == 0 );
3643   if( _lChild )
3644     _lChild->swap_commutative_op(is_set, id);
3645   if( _rChild )
3646     _rChild->swap_commutative_op(is_set, id);
3647 
3648   // If not the root, reduce this subtree to an internal operand
3649   if( !atroot && (_lChild || _rChild) ) {
3650     build_internalop();
3651   }
3652 }
3653 
3654 //-------------------------- swap_commutative_op ------------------------------
3655 // Recursively swap specified commutative operation with subtree operands.
3656 void MatchRule::swap_commutative_op(const char* instr_ident, int count, int& match_rules_cnt) {
3657   assert(match_rules_cnt < 100," too many match rule clones");
3658   // Clone
3659   MatchRule* clone = new MatchRule(_AD, this);
3660   // Swap operands of commutative operation
3661   ((MatchNode*)clone)->swap_commutative_op(true, count);
3662   char* buf = (char*) malloc(strlen(instr_ident) + 4);
3663   sprintf(buf, "%s_%d", instr_ident, match_rules_cnt++);
3664   clone->_result = buf;
3665 
3666   clone->_next = this->_next;
3667   this-> _next = clone;
3668   if( (--count) > 0 ) {
3669     this-> swap_commutative_op(instr_ident, count, match_rules_cnt);
3670     clone->swap_commutative_op(instr_ident, count, match_rules_cnt);
3671   }
3672 }
3673 
3674 //------------------------------MatchRule--------------------------------------
3675 MatchRule::MatchRule(ArchDesc &ad)
3676   : MatchNode(ad), _depth(0), _construct(NULL), _numchilds(0) {
3677     _next = NULL;
3678 }
3679 
3680 MatchRule::MatchRule(ArchDesc &ad, MatchRule* mRule)
3681   : MatchNode(ad, *mRule, 0), _depth(mRule->_depth),
3682     _construct(mRule->_construct), _numchilds(mRule->_numchilds) {
3683     _next = NULL;
3684 }
3685 
3686 MatchRule::MatchRule(ArchDesc &ad, MatchNode* mroot, int depth, char *cnstr,
3687                      int numleaves)
3688   : MatchNode(ad,*mroot), _depth(depth), _construct(cnstr),
3689     _numchilds(0) {
3690       _next = NULL;
3691       mroot->_lChild = NULL;
3692       mroot->_rChild = NULL;
3693       delete mroot;
3694       _numleaves = numleaves;
3695       _numchilds = (_lChild ? 1 : 0) + (_rChild ? 1 : 0);
3696 }
3697 MatchRule::~MatchRule() {
3698 }
3699 
3700 // Recursive call collecting info on top-level operands, not transitive.
3701 // Implementation does not modify state of internal structures.
3702 void MatchRule::append_components(FormDict &locals, ComponentList &components) const {
3703   assert (_name != NULL, "MatchNode::build_components encountered empty node\n");
3704 
3705   MatchNode::append_components(locals, components,
3706                                false /* not necessarily a def */);
3707 }
3708 
3709 // Recursive call on all operands' match rules in my match rule.
3710 // Implementation does not modify state of internal structures  since they
3711 // can be shared.
3712 // The MatchNode that is called first treats its
3713 bool MatchRule::base_operand(uint &position0, FormDict &globals,
3714                              const char *&result, const char * &name,
3715                              const char * &opType)const{
3716   uint position = position0;
3717 
3718   return (MatchNode::base_operand( position, globals, result, name, opType));
3719 }
3720 
3721 
3722 bool MatchRule::is_base_register(FormDict &globals) const {
3723   uint   position = 1;
3724   const char  *result   = NULL;
3725   const char  *name     = NULL;
3726   const char  *opType   = NULL;
3727   if (!base_operand(position, globals, result, name, opType)) {
3728     position = 0;
3729     if( base_operand(position, globals, result, name, opType) &&
3730         (strcmp(opType,"RegI")==0 ||
3731          strcmp(opType,"RegP")==0 ||
3732          strcmp(opType,"RegN")==0 ||
3733          strcmp(opType,"RegL")==0 ||
3734          strcmp(opType,"RegF")==0 ||
3735          strcmp(opType,"RegD")==0 ||
3736          strcmp(opType,"Reg" )==0) ) {
3737       return 1;
3738     }
3739   }
3740   return 0;
3741 }
3742 
3743 Form::DataType MatchRule::is_base_constant(FormDict &globals) const {
3744   uint         position = 1;
3745   const char  *result   = NULL;
3746   const char  *name     = NULL;
3747   const char  *opType   = NULL;
3748   if (!base_operand(position, globals, result, name, opType)) {
3749     position = 0;
3750     if (base_operand(position, globals, result, name, opType)) {
3751       return ideal_to_const_type(opType);
3752     }
3753   }
3754   return Form::none;
3755 }
3756 
3757 bool MatchRule::is_chain_rule(FormDict &globals) const {
3758 
3759   // Check for chain rule, and do not generate a match list for it
3760   if ((_lChild == NULL) && (_rChild == NULL) ) {
3761     const Form *form = globals[_opType];
3762     // If this is ideal, then it is a base match, not a chain rule.
3763     if ( form && form->is_operand() && (!form->ideal_only())) {
3764       return true;
3765     }
3766   }
3767   // Check for "Set" form of chain rule, and do not generate a match list
3768   if (_rChild) {
3769     const char *rch = _rChild->_opType;
3770     const Form *form = globals[rch];
3771     if ((!strcmp(_opType,"Set") &&
3772          ((form) && form->is_operand()))) {
3773       return true;
3774     }
3775   }
3776   return false;
3777 }
3778 
3779 int MatchRule::is_ideal_copy() const {
3780   if( _rChild ) {
3781     const char  *opType = _rChild->_opType;
3782 #if 1
3783     if( strcmp(opType,"CastIP")==0 )
3784       return 1;
3785 #else
3786     if( strcmp(opType,"CastII")==0 )
3787       return 1;
3788     // Do not treat *CastPP this way, because it
3789     // may transfer a raw pointer to an oop.
3790     // If the register allocator were to coalesce this
3791     // into a single LRG, the GC maps would be incorrect.
3792     //if( strcmp(opType,"CastPP")==0 )
3793     //  return 1;
3794     //if( strcmp(opType,"CheckCastPP")==0 )
3795     //  return 1;
3796     //
3797     // Do not treat CastX2P or CastP2X this way, because
3798     // raw pointers and int types are treated differently
3799     // when saving local & stack info for safepoints in
3800     // Output().
3801     //if( strcmp(opType,"CastX2P")==0 )
3802     //  return 1;
3803     //if( strcmp(opType,"CastP2X")==0 )
3804     //  return 1;
3805 #endif
3806   }
3807   if( is_chain_rule(_AD.globalNames()) &&
3808       _lChild && strncmp(_lChild->_opType,"stackSlot",9)==0 )
3809     return 1;
3810   return 0;
3811 }
3812 
3813 
3814 int MatchRule::is_expensive() const {
3815   if( _rChild ) {
3816     const char  *opType = _rChild->_opType;
3817     if( strcmp(opType,"AtanD")==0 ||
3818         strcmp(opType,"CosD")==0 ||
3819         strcmp(opType,"DivD")==0 ||
3820         strcmp(opType,"DivF")==0 ||
3821         strcmp(opType,"DivI")==0 ||
3822         strcmp(opType,"ExpD")==0 ||
3823         strcmp(opType,"LogD")==0 ||
3824         strcmp(opType,"Log10D")==0 ||
3825         strcmp(opType,"ModD")==0 ||
3826         strcmp(opType,"ModF")==0 ||
3827         strcmp(opType,"ModI")==0 ||
3828         strcmp(opType,"PowD")==0 ||
3829         strcmp(opType,"SinD")==0 ||
3830         strcmp(opType,"SqrtD")==0 ||
3831         strcmp(opType,"TanD")==0 ||
3832         strcmp(opType,"ConvD2F")==0 ||
3833         strcmp(opType,"ConvD2I")==0 ||
3834         strcmp(opType,"ConvD2L")==0 ||
3835         strcmp(opType,"ConvF2D")==0 ||
3836         strcmp(opType,"ConvF2I")==0 ||
3837         strcmp(opType,"ConvF2L")==0 ||
3838         strcmp(opType,"ConvI2D")==0 ||
3839         strcmp(opType,"ConvI2F")==0 ||
3840         strcmp(opType,"ConvI2L")==0 ||
3841         strcmp(opType,"ConvL2D")==0 ||
3842         strcmp(opType,"ConvL2F")==0 ||
3843         strcmp(opType,"ConvL2I")==0 ||
3844         strcmp(opType,"DecodeN")==0 ||
3845         strcmp(opType,"EncodeP")==0 ||
3846         strcmp(opType,"RoundDouble")==0 ||
3847         strcmp(opType,"RoundFloat")==0 ||
3848         strcmp(opType,"ReverseBytesI")==0 ||
3849         strcmp(opType,"ReverseBytesL")==0 ||
3850         strcmp(opType,"Replicate16B")==0 ||
3851         strcmp(opType,"Replicate8B")==0 ||
3852         strcmp(opType,"Replicate4B")==0 ||
3853         strcmp(opType,"Replicate8C")==0 ||
3854         strcmp(opType,"Replicate4C")==0 ||
3855         strcmp(opType,"Replicate8S")==0 ||
3856         strcmp(opType,"Replicate4S")==0 ||
3857         strcmp(opType,"Replicate4I")==0 ||
3858         strcmp(opType,"Replicate2I")==0 ||
3859         strcmp(opType,"Replicate2L")==0 ||
3860         strcmp(opType,"Replicate4F")==0 ||
3861         strcmp(opType,"Replicate2F")==0 ||
3862         strcmp(opType,"Replicate2D")==0 ||
3863         0 /* 0 to line up columns nicely */ )
3864       return 1;
3865   }
3866   return 0;
3867 }
3868 
3869 bool MatchRule::is_ideal_unlock() const {
3870   if( !_opType ) return false;
3871   return !strcmp(_opType,"Unlock") || !strcmp(_opType,"FastUnlock");
3872 }
3873 
3874 
3875 bool MatchRule::is_ideal_call_leaf() const {
3876   if( !_opType ) return false;
3877   return !strcmp(_opType,"CallLeaf")     ||
3878          !strcmp(_opType,"CallLeafNoFP");
3879 }
3880 
3881 
3882 bool MatchRule::is_ideal_if() const {
3883   if( !_opType ) return false;
3884   return
3885     !strcmp(_opType,"If"            ) ||
3886     !strcmp(_opType,"CountedLoopEnd");
3887 }
3888 
3889 bool MatchRule::is_ideal_fastlock() const {
3890   if ( _opType && (strcmp(_opType,"Set") == 0) && _rChild ) {
3891     return (strcmp(_rChild->_opType,"FastLock") == 0);
3892   }
3893   return false;
3894 }
3895 
3896 bool MatchRule::is_ideal_membar() const {
3897   if( !_opType ) return false;
3898   return
3899     !strcmp(_opType,"MemBarAcquire"  ) ||
3900     !strcmp(_opType,"MemBarRelease"  ) ||
3901     !strcmp(_opType,"MemBarVolatile" ) ||
3902     !strcmp(_opType,"MemBarCPUOrder" ) ;
3903 }
3904 
3905 bool MatchRule::is_ideal_loadPC() const {
3906   if ( _opType && (strcmp(_opType,"Set") == 0) && _rChild ) {
3907     return (strcmp(_rChild->_opType,"LoadPC") == 0);
3908   }
3909   return false;
3910 }
3911 
3912 bool MatchRule::is_ideal_box() const {
3913   if ( _opType && (strcmp(_opType,"Set") == 0) && _rChild ) {
3914     return (strcmp(_rChild->_opType,"Box") == 0);
3915   }
3916   return false;
3917 }
3918 
3919 bool MatchRule::is_ideal_goto() const {
3920   bool   ideal_goto = false;
3921 
3922   if( _opType && (strcmp(_opType,"Goto") == 0) ) {
3923     ideal_goto = true;
3924   }
3925   return ideal_goto;
3926 }
3927 
3928 bool MatchRule::is_ideal_jump() const {
3929   if( _opType ) {
3930     if( !strcmp(_opType,"Jump") )
3931       return true;
3932   }
3933   return false;
3934 }
3935 
3936 bool MatchRule::is_ideal_bool() const {
3937   if( _opType ) {
3938     if( !strcmp(_opType,"Bool") )
3939       return true;
3940   }
3941   return false;
3942 }
3943 
3944 
3945 Form::DataType MatchRule::is_ideal_load() const {
3946   Form::DataType ideal_load = Form::none;
3947 
3948   if ( _opType && (strcmp(_opType,"Set") == 0) && _rChild ) {
3949     const char *opType = _rChild->_opType;
3950     ideal_load = is_load_from_memory(opType);
3951   }
3952 
3953   return ideal_load;
3954 }
3955 
3956 
3957 Form::DataType MatchRule::is_ideal_store() const {
3958   Form::DataType ideal_store = Form::none;
3959 
3960   if ( _opType && (strcmp(_opType,"Set") == 0) && _rChild ) {
3961     const char *opType = _rChild->_opType;
3962     ideal_store = is_store_to_memory(opType);
3963   }
3964 
3965   return ideal_store;
3966 }
3967 
3968 
3969 void MatchRule::dump() {
3970   output(stderr);
3971 }
3972 
3973 void MatchRule::output(FILE *fp) {
3974   fprintf(fp,"MatchRule: ( %s",_name);
3975   if (_lChild) _lChild->output(fp);
3976   if (_rChild) _rChild->output(fp);
3977   fprintf(fp," )\n");
3978   fprintf(fp,"   nesting depth = %d\n", _depth);
3979   if (_result) fprintf(fp,"   Result Type = %s", _result);
3980   fprintf(fp,"\n");
3981 }
3982 
3983 //------------------------------Attribute--------------------------------------
3984 Attribute::Attribute(char *id, char* val, int type)
3985   : _ident(id), _val(val), _atype(type) {
3986 }
3987 Attribute::~Attribute() {
3988 }
3989 
3990 int Attribute::int_val(ArchDesc &ad) {
3991   // Make sure it is an integer constant:
3992   int result = 0;
3993   if (!_val || !ADLParser::is_int_token(_val, result)) {
3994     ad.syntax_err(0, "Attribute %s must have an integer value: %s",
3995                   _ident, _val ? _val : "");
3996   }
3997   return result;
3998 }
3999 
4000 void Attribute::dump() {
4001   output(stderr);
4002 } // Debug printer
4003 
4004 // Write to output files
4005 void Attribute::output(FILE *fp) {
4006   fprintf(fp,"Attribute: %s  %s\n", (_ident?_ident:""), (_val?_val:""));
4007 }
4008 
4009 //------------------------------FormatRule----------------------------------
4010 FormatRule::FormatRule(char *temp)
4011   : _temp(temp) {
4012 }
4013 FormatRule::~FormatRule() {
4014 }
4015 
4016 void FormatRule::dump() {
4017   output(stderr);
4018 }
4019 
4020 // Write to output files
4021 void FormatRule::output(FILE *fp) {
4022   fprintf(fp,"\nFormat Rule: \n%s", (_temp?_temp:""));
4023   fprintf(fp,"\n");
4024 }