001 002/* 003 * THIS FILE IS MACHINE_GENERATED. DO NOT EDIT. 004 * See InstructionFormats.template, InstructionFormatList.dat, 005 * OperatorList.dat, etc. 006 */ 007 008package org.jikesrvm.compilers.opt.ir; 009 010import org.jikesrvm.Configuration; 011import org.jikesrvm.compilers.opt.ir.operand.*; 012 013/** 014 * The IfCmp InstructionFormat class. 015 * 016 * The header comment for {@link Instruction} contains 017 * an explanation of the role of InstructionFormats in the 018 * opt compiler's IR. 019 */ 020@SuppressWarnings("unused") // Machine generated code is never 100% clean 021public final class IfCmp extends InstructionFormat { 022 /** 023 * InstructionFormat identification method for IfCmp. 024 * @param i an instruction 025 * @return <code>true</code> if the InstructionFormat of the argument 026 * instruction is IfCmp or <code>false</code> 027 * if it is not. 028 */ 029 public static boolean conforms(Instruction i) { 030 return conforms(i.operator()); 031 } 032 /** 033 * InstructionFormat identification method for IfCmp. 034 * @param o an instruction 035 * @return <code>true</code> if the InstructionFormat of the argument 036 * operator is IfCmp or <code>false</code> 037 * if it is not. 038 */ 039 public static boolean conforms(Operator o) { 040 return o.format == IfCmp_format; 041 } 042 043 /** 044 * Get the operand called GuardResult from the 045 * argument instruction. Note that the returned operand 046 * will still point to its containing instruction. 047 * @param i the instruction to fetch the operand from 048 * @return the operand called GuardResult 049 */ 050 public static RegisterOperand getGuardResult(Instruction i) { 051 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 052 return (RegisterOperand) i.getOperand(0); 053 } 054 /** 055 * Get the operand called GuardResult from the argument 056 * instruction clearing its instruction pointer. The returned 057 * operand will not point to any containing instruction. 058 * @param i the instruction to fetch the operand from 059 * @return the operand called GuardResult 060 */ 061 public static RegisterOperand getClearGuardResult(Instruction i) { 062 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 063 return (RegisterOperand) i.getClearOperand(0); 064 } 065 /** 066 * Set the operand called GuardResult in the argument 067 * instruction to the argument operand. The operand will 068 * now point to the argument instruction as its containing 069 * instruction. 070 * @param i the instruction in which to store the operand 071 * @param GuardResult the operand to store 072 */ 073 public static void setGuardResult(Instruction i, RegisterOperand GuardResult) { 074 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 075 i.putOperand(0, GuardResult); 076 } 077 /** 078 * Return the index of the operand called GuardResult 079 * in the argument instruction. 080 * @param i the instruction to access. 081 * @return the index of the operand called GuardResult 082 * in the argument instruction 083 */ 084 public static int indexOfGuardResult(Instruction i) { 085 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 086 return 0; 087 } 088 /** 089 * Does the argument instruction have a non-null 090 * operand named GuardResult? 091 * @param i the instruction to access. 092 * @return <code>true</code> if the instruction has an non-null 093 * operand named GuardResult or <code>false</code> 094 * if it does not. 095 */ 096 public static boolean hasGuardResult(Instruction i) { 097 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 098 return i.getOperand(0) != null; 099 } 100 101 /** 102 * Get the operand called Val1 from the 103 * argument instruction. Note that the returned operand 104 * will still point to its containing instruction. 105 * @param i the instruction to fetch the operand from 106 * @return the operand called Val1 107 */ 108 public static Operand getVal1(Instruction i) { 109 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 110 return (Operand) i.getOperand(1); 111 } 112 /** 113 * Get the operand called Val1 from the argument 114 * instruction clearing its instruction pointer. The returned 115 * operand will not point to any containing instruction. 116 * @param i the instruction to fetch the operand from 117 * @return the operand called Val1 118 */ 119 public static Operand getClearVal1(Instruction i) { 120 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 121 return (Operand) i.getClearOperand(1); 122 } 123 /** 124 * Set the operand called Val1 in the argument 125 * instruction to the argument operand. The operand will 126 * now point to the argument instruction as its containing 127 * instruction. 128 * @param i the instruction in which to store the operand 129 * @param Val1 the operand to store 130 */ 131 public static void setVal1(Instruction i, Operand Val1) { 132 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 133 i.putOperand(1, Val1); 134 } 135 /** 136 * Return the index of the operand called Val1 137 * in the argument instruction. 138 * @param i the instruction to access. 139 * @return the index of the operand called Val1 140 * in the argument instruction 141 */ 142 public static int indexOfVal1(Instruction i) { 143 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 144 return 1; 145 } 146 /** 147 * Does the argument instruction have a non-null 148 * operand named Val1? 149 * @param i the instruction to access. 150 * @return <code>true</code> if the instruction has an non-null 151 * operand named Val1 or <code>false</code> 152 * if it does not. 153 */ 154 public static boolean hasVal1(Instruction i) { 155 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 156 return i.getOperand(1) != null; 157 } 158 159 /** 160 * Get the operand called Val2 from the 161 * argument instruction. Note that the returned operand 162 * will still point to its containing instruction. 163 * @param i the instruction to fetch the operand from 164 * @return the operand called Val2 165 */ 166 public static Operand getVal2(Instruction i) { 167 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 168 return (Operand) i.getOperand(2); 169 } 170 /** 171 * Get the operand called Val2 from the argument 172 * instruction clearing its instruction pointer. The returned 173 * operand will not point to any containing instruction. 174 * @param i the instruction to fetch the operand from 175 * @return the operand called Val2 176 */ 177 public static Operand getClearVal2(Instruction i) { 178 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 179 return (Operand) i.getClearOperand(2); 180 } 181 /** 182 * Set the operand called Val2 in the argument 183 * instruction to the argument operand. The operand will 184 * now point to the argument instruction as its containing 185 * instruction. 186 * @param i the instruction in which to store the operand 187 * @param Val2 the operand to store 188 */ 189 public static void setVal2(Instruction i, Operand Val2) { 190 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 191 i.putOperand(2, Val2); 192 } 193 /** 194 * Return the index of the operand called Val2 195 * in the argument instruction. 196 * @param i the instruction to access. 197 * @return the index of the operand called Val2 198 * in the argument instruction 199 */ 200 public static int indexOfVal2(Instruction i) { 201 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 202 return 2; 203 } 204 /** 205 * Does the argument instruction have a non-null 206 * operand named Val2? 207 * @param i the instruction to access. 208 * @return <code>true</code> if the instruction has an non-null 209 * operand named Val2 or <code>false</code> 210 * if it does not. 211 */ 212 public static boolean hasVal2(Instruction i) { 213 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 214 return i.getOperand(2) != null; 215 } 216 217 /** 218 * Get the operand called Cond from the 219 * argument instruction. Note that the returned operand 220 * will still point to its containing instruction. 221 * @param i the instruction to fetch the operand from 222 * @return the operand called Cond 223 */ 224 public static ConditionOperand getCond(Instruction i) { 225 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 226 return (ConditionOperand) i.getOperand(3); 227 } 228 /** 229 * Get the operand called Cond from the argument 230 * instruction clearing its instruction pointer. The returned 231 * operand will not point to any containing instruction. 232 * @param i the instruction to fetch the operand from 233 * @return the operand called Cond 234 */ 235 public static ConditionOperand getClearCond(Instruction i) { 236 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 237 return (ConditionOperand) i.getClearOperand(3); 238 } 239 /** 240 * Set the operand called Cond in the argument 241 * instruction to the argument operand. The operand will 242 * now point to the argument instruction as its containing 243 * instruction. 244 * @param i the instruction in which to store the operand 245 * @param Cond the operand to store 246 */ 247 public static void setCond(Instruction i, ConditionOperand Cond) { 248 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 249 i.putOperand(3, Cond); 250 } 251 /** 252 * Return the index of the operand called Cond 253 * in the argument instruction. 254 * @param i the instruction to access. 255 * @return the index of the operand called Cond 256 * in the argument instruction 257 */ 258 public static int indexOfCond(Instruction i) { 259 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 260 return 3; 261 } 262 /** 263 * Does the argument instruction have a non-null 264 * operand named Cond? 265 * @param i the instruction to access. 266 * @return <code>true</code> if the instruction has an non-null 267 * operand named Cond or <code>false</code> 268 * if it does not. 269 */ 270 public static boolean hasCond(Instruction i) { 271 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 272 return i.getOperand(3) != null; 273 } 274 275 /** 276 * Get the operand called Target from the 277 * argument instruction. Note that the returned operand 278 * will still point to its containing instruction. 279 * @param i the instruction to fetch the operand from 280 * @return the operand called Target 281 */ 282 public static BranchOperand getTarget(Instruction i) { 283 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 284 return (BranchOperand) i.getOperand(4); 285 } 286 /** 287 * Get the operand called Target from the argument 288 * instruction clearing its instruction pointer. The returned 289 * operand will not point to any containing instruction. 290 * @param i the instruction to fetch the operand from 291 * @return the operand called Target 292 */ 293 public static BranchOperand getClearTarget(Instruction i) { 294 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 295 return (BranchOperand) i.getClearOperand(4); 296 } 297 /** 298 * Set the operand called Target in the argument 299 * instruction to the argument operand. The operand will 300 * now point to the argument instruction as its containing 301 * instruction. 302 * @param i the instruction in which to store the operand 303 * @param Target the operand to store 304 */ 305 public static void setTarget(Instruction i, BranchOperand Target) { 306 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 307 i.putOperand(4, Target); 308 } 309 /** 310 * Return the index of the operand called Target 311 * in the argument instruction. 312 * @param i the instruction to access. 313 * @return the index of the operand called Target 314 * in the argument instruction 315 */ 316 public static int indexOfTarget(Instruction i) { 317 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 318 return 4; 319 } 320 /** 321 * Does the argument instruction have a non-null 322 * operand named Target? 323 * @param i the instruction to access. 324 * @return <code>true</code> if the instruction has an non-null 325 * operand named Target or <code>false</code> 326 * if it does not. 327 */ 328 public static boolean hasTarget(Instruction i) { 329 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 330 return i.getOperand(4) != null; 331 } 332 333 /** 334 * Get the operand called BranchProfile from the 335 * argument instruction. Note that the returned operand 336 * will still point to its containing instruction. 337 * @param i the instruction to fetch the operand from 338 * @return the operand called BranchProfile 339 */ 340 public static BranchProfileOperand getBranchProfile(Instruction i) { 341 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 342 return (BranchProfileOperand) i.getOperand(5); 343 } 344 /** 345 * Get the operand called BranchProfile from the argument 346 * instruction clearing its instruction pointer. The returned 347 * operand will not point to any containing instruction. 348 * @param i the instruction to fetch the operand from 349 * @return the operand called BranchProfile 350 */ 351 public static BranchProfileOperand getClearBranchProfile(Instruction i) { 352 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 353 return (BranchProfileOperand) i.getClearOperand(5); 354 } 355 /** 356 * Set the operand called BranchProfile in the argument 357 * instruction to the argument operand. The operand will 358 * now point to the argument instruction as its containing 359 * instruction. 360 * @param i the instruction in which to store the operand 361 * @param BranchProfile the operand to store 362 */ 363 public static void setBranchProfile(Instruction i, BranchProfileOperand BranchProfile) { 364 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 365 i.putOperand(5, BranchProfile); 366 } 367 /** 368 * Return the index of the operand called BranchProfile 369 * in the argument instruction. 370 * @param i the instruction to access. 371 * @return the index of the operand called BranchProfile 372 * in the argument instruction 373 */ 374 public static int indexOfBranchProfile(Instruction i) { 375 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 376 return 5; 377 } 378 /** 379 * Does the argument instruction have a non-null 380 * operand named BranchProfile? 381 * @param i the instruction to access. 382 * @return <code>true</code> if the instruction has an non-null 383 * operand named BranchProfile or <code>false</code> 384 * if it does not. 385 */ 386 public static boolean hasBranchProfile(Instruction i) { 387 if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "IfCmp"); 388 return i.getOperand(5) != null; 389 } 390 391 392 /** 393 * Create an instruction of the IfCmp instruction format. 394 * @param o the instruction's operator 395 * @param GuardResult the instruction's GuardResult operand 396 * @param Val1 the instruction's Val1 operand 397 * @param Val2 the instruction's Val2 operand 398 * @param Cond the instruction's Cond operand 399 * @param Target the instruction's Target operand 400 * @param BranchProfile the instruction's BranchProfile operand 401 * @return the newly created IfCmp instruction 402 */ 403 public static Instruction create(Operator o 404 , RegisterOperand GuardResult 405 , Operand Val1 406 , Operand Val2 407 , ConditionOperand Cond 408 , BranchOperand Target 409 , BranchProfileOperand BranchProfile 410 ) 411 { 412 if (Configuration.ExtremeAssertions && !conforms(o)) fail(o, "IfCmp"); 413 Instruction i = Instruction.create(o, 6); 414 i.putOperand(0, GuardResult); 415 i.putOperand(1, Val1); 416 i.putOperand(2, Val2); 417 i.putOperand(3, Cond); 418 i.putOperand(4, Target); 419 i.putOperand(5, BranchProfile); 420 return i; 421 } 422 423 /** 424 * Mutate the argument instruction into an instruction of the 425 * IfCmp instruction format having the specified 426 * operator and operands. 427 * @param i the instruction to mutate 428 * @param o the instruction's operator 429 * @param GuardResult the instruction's GuardResult operand 430 * @param Val1 the instruction's Val1 operand 431 * @param Val2 the instruction's Val2 operand 432 * @param Cond the instruction's Cond operand 433 * @param Target the instruction's Target operand 434 * @param BranchProfile the instruction's BranchProfile operand 435 * @return the mutated instruction 436 */ 437 public static Instruction mutate(Instruction i, Operator o 438 , RegisterOperand GuardResult 439 , Operand Val1 440 , Operand Val2 441 , ConditionOperand Cond 442 , BranchOperand Target 443 , BranchProfileOperand BranchProfile 444 ) 445 { 446 if (Configuration.ExtremeAssertions && !conforms(o)) fail(o, "IfCmp"); 447 i.resizeNumberOfOperands(6); 448 449 i.changeOperatorTo(o); 450 i.putOperand(0, GuardResult); 451 i.putOperand(1, Val1); 452 i.putOperand(2, Val2); 453 i.putOperand(3, Cond); 454 i.putOperand(4, Target); 455 i.putOperand(5, BranchProfile); 456 return i; 457 } 458} 459