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.ppc;
009
010import org.jikesrvm.Configuration;
011import org.jikesrvm.compilers.opt.ir.operand.ppc.PowerPCConditionOperand;
012import org.jikesrvm.compilers.opt.ir.operand.ppc.PowerPCTrapOperand;
013import org.jikesrvm.compilers.opt.ir.operand.*;
014import org.jikesrvm.compilers.opt.ir.Instruction;
015import org.jikesrvm.compilers.opt.ir.Operator;
016
017/**
018 * The MIR_Ternary InstructionFormat class.
019 *
020 * The header comment for {@link Instruction} contains
021 * an explanation of the role of InstructionFormats in the
022 * opt compiler's IR.
023 */
024@SuppressWarnings("unused")  // Machine generated code is never 100% clean
025public final class MIR_Ternary extends ArchInstructionFormat {
026  /**
027   * InstructionFormat identification method for MIR_Ternary.
028   * @param i an instruction
029   * @return <code>true</code> if the InstructionFormat of the argument
030   *         instruction is MIR_Ternary or <code>false</code>
031   *         if it is not.
032   */
033  public static boolean conforms(Instruction i) {
034    return conforms(i.operator());
035  }
036  /**
037   * InstructionFormat identification method for MIR_Ternary.
038   * @param o an instruction
039   * @return <code>true</code> if the InstructionFormat of the argument
040   *         operator is MIR_Ternary or <code>false</code>
041   *         if it is not.
042   */
043  public static boolean conforms(Operator o) {
044    return o.format == MIR_Ternary_format;
045  }
046
047  /**
048   * Get the operand called Result from the
049   * argument instruction. Note that the returned operand
050   * will still point to its containing instruction.
051   * @param i the instruction to fetch the operand from
052   * @return the operand called Result
053   */
054  public static RegisterOperand getResult(Instruction i) {
055    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_Ternary");
056    return (RegisterOperand) i.getOperand(0);
057  }
058  /**
059   * Get the operand called Result from the argument
060   * instruction clearing its instruction pointer. The returned
061   * operand will not point to any containing instruction.
062   * @param i the instruction to fetch the operand from
063   * @return the operand called Result
064   */
065  public static RegisterOperand getClearResult(Instruction i) {
066    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_Ternary");
067    return (RegisterOperand) i.getClearOperand(0);
068  }
069  /**
070   * Set the operand called Result in the argument
071   * instruction to the argument operand. The operand will
072   * now point to the argument instruction as its containing
073   * instruction.
074   * @param i the instruction in which to store the operand
075   * @param Result the operand to store
076   */
077  public static void setResult(Instruction i, RegisterOperand Result) {
078    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_Ternary");
079    i.putOperand(0, Result);
080  }
081  /**
082   * Return the index of the operand called Result
083   * in the argument instruction.
084   * @param i the instruction to access.
085   * @return the index of the operand called Result
086   *         in the argument instruction
087   */
088  public static int indexOfResult(Instruction i) {
089    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_Ternary");
090    return 0;
091  }
092  /**
093   * Does the argument instruction have a non-null
094   * operand named Result?
095   * @param i the instruction to access.
096   * @return <code>true</code> if the instruction has an non-null
097   *         operand named Result or <code>false</code>
098   *         if it does not.
099   */
100  public static boolean hasResult(Instruction i) {
101    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_Ternary");
102    return i.getOperand(0) != null;
103  }
104
105  /**
106   * Get the operand called Value1 from the
107   * argument instruction. Note that the returned operand
108   * will still point to its containing instruction.
109   * @param i the instruction to fetch the operand from
110   * @return the operand called Value1
111   */
112  public static RegisterOperand getValue1(Instruction i) {
113    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_Ternary");
114    return (RegisterOperand) i.getOperand(1);
115  }
116  /**
117   * Get the operand called Value1 from the argument
118   * instruction clearing its instruction pointer. The returned
119   * operand will not point to any containing instruction.
120   * @param i the instruction to fetch the operand from
121   * @return the operand called Value1
122   */
123  public static RegisterOperand getClearValue1(Instruction i) {
124    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_Ternary");
125    return (RegisterOperand) i.getClearOperand(1);
126  }
127  /**
128   * Set the operand called Value1 in the argument
129   * instruction to the argument operand. The operand will
130   * now point to the argument instruction as its containing
131   * instruction.
132   * @param i the instruction in which to store the operand
133   * @param Value1 the operand to store
134   */
135  public static void setValue1(Instruction i, RegisterOperand Value1) {
136    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_Ternary");
137    i.putOperand(1, Value1);
138  }
139  /**
140   * Return the index of the operand called Value1
141   * in the argument instruction.
142   * @param i the instruction to access.
143   * @return the index of the operand called Value1
144   *         in the argument instruction
145   */
146  public static int indexOfValue1(Instruction i) {
147    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_Ternary");
148    return 1;
149  }
150  /**
151   * Does the argument instruction have a non-null
152   * operand named Value1?
153   * @param i the instruction to access.
154   * @return <code>true</code> if the instruction has an non-null
155   *         operand named Value1 or <code>false</code>
156   *         if it does not.
157   */
158  public static boolean hasValue1(Instruction i) {
159    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_Ternary");
160    return i.getOperand(1) != null;
161  }
162
163  /**
164   * Get the operand called Value2 from the
165   * argument instruction. Note that the returned operand
166   * will still point to its containing instruction.
167   * @param i the instruction to fetch the operand from
168   * @return the operand called Value2
169   */
170  public static RegisterOperand getValue2(Instruction i) {
171    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_Ternary");
172    return (RegisterOperand) i.getOperand(2);
173  }
174  /**
175   * Get the operand called Value2 from the argument
176   * instruction clearing its instruction pointer. The returned
177   * operand will not point to any containing instruction.
178   * @param i the instruction to fetch the operand from
179   * @return the operand called Value2
180   */
181  public static RegisterOperand getClearValue2(Instruction i) {
182    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_Ternary");
183    return (RegisterOperand) i.getClearOperand(2);
184  }
185  /**
186   * Set the operand called Value2 in the argument
187   * instruction to the argument operand. The operand will
188   * now point to the argument instruction as its containing
189   * instruction.
190   * @param i the instruction in which to store the operand
191   * @param Value2 the operand to store
192   */
193  public static void setValue2(Instruction i, RegisterOperand Value2) {
194    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_Ternary");
195    i.putOperand(2, Value2);
196  }
197  /**
198   * Return the index of the operand called Value2
199   * in the argument instruction.
200   * @param i the instruction to access.
201   * @return the index of the operand called Value2
202   *         in the argument instruction
203   */
204  public static int indexOfValue2(Instruction i) {
205    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_Ternary");
206    return 2;
207  }
208  /**
209   * Does the argument instruction have a non-null
210   * operand named Value2?
211   * @param i the instruction to access.
212   * @return <code>true</code> if the instruction has an non-null
213   *         operand named Value2 or <code>false</code>
214   *         if it does not.
215   */
216  public static boolean hasValue2(Instruction i) {
217    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_Ternary");
218    return i.getOperand(2) != null;
219  }
220
221  /**
222   * Get the operand called Value3 from the
223   * argument instruction. Note that the returned operand
224   * will still point to its containing instruction.
225   * @param i the instruction to fetch the operand from
226   * @return the operand called Value3
227   */
228  public static RegisterOperand getValue3(Instruction i) {
229    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_Ternary");
230    return (RegisterOperand) i.getOperand(3);
231  }
232  /**
233   * Get the operand called Value3 from the argument
234   * instruction clearing its instruction pointer. The returned
235   * operand will not point to any containing instruction.
236   * @param i the instruction to fetch the operand from
237   * @return the operand called Value3
238   */
239  public static RegisterOperand getClearValue3(Instruction i) {
240    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_Ternary");
241    return (RegisterOperand) i.getClearOperand(3);
242  }
243  /**
244   * Set the operand called Value3 in the argument
245   * instruction to the argument operand. The operand will
246   * now point to the argument instruction as its containing
247   * instruction.
248   * @param i the instruction in which to store the operand
249   * @param Value3 the operand to store
250   */
251  public static void setValue3(Instruction i, RegisterOperand Value3) {
252    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_Ternary");
253    i.putOperand(3, Value3);
254  }
255  /**
256   * Return the index of the operand called Value3
257   * in the argument instruction.
258   * @param i the instruction to access.
259   * @return the index of the operand called Value3
260   *         in the argument instruction
261   */
262  public static int indexOfValue3(Instruction i) {
263    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_Ternary");
264    return 3;
265  }
266  /**
267   * Does the argument instruction have a non-null
268   * operand named Value3?
269   * @param i the instruction to access.
270   * @return <code>true</code> if the instruction has an non-null
271   *         operand named Value3 or <code>false</code>
272   *         if it does not.
273   */
274  public static boolean hasValue3(Instruction i) {
275    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_Ternary");
276    return i.getOperand(3) != null;
277  }
278
279
280  /**
281   * Create an instruction of the MIR_Ternary instruction format.
282   * @param o the instruction's operator
283   * @param Result the instruction's Result operand
284   * @param Value1 the instruction's Value1 operand
285   * @param Value2 the instruction's Value2 operand
286   * @param Value3 the instruction's Value3 operand
287   * @return the newly created MIR_Ternary instruction
288   */
289  public static Instruction create(Operator o
290                   , RegisterOperand Result
291                   , RegisterOperand Value1
292                   , RegisterOperand Value2
293                   , RegisterOperand Value3
294                )
295  {
296    if (Configuration.ExtremeAssertions && !conforms(o)) fail(o, "MIR_Ternary");
297    Instruction i = Instruction.create(o, 5);
298    i.putOperand(0, Result);
299    i.putOperand(1, Value1);
300    i.putOperand(2, Value2);
301    i.putOperand(3, Value3);
302    return i;
303  }
304
305  /**
306   * Mutate the argument instruction into an instruction of the
307   * MIR_Ternary instruction format having the specified
308   * operator and operands.
309   * @param i the instruction to mutate
310   * @param o the instruction's operator
311   * @param Result the instruction's Result operand
312   * @param Value1 the instruction's Value1 operand
313   * @param Value2 the instruction's Value2 operand
314   * @param Value3 the instruction's Value3 operand
315   * @return the mutated instruction
316   */
317  public static Instruction mutate(Instruction i, Operator o
318                   , RegisterOperand Result
319                   , RegisterOperand Value1
320                   , RegisterOperand Value2
321                   , RegisterOperand Value3
322                )
323  {
324    if (Configuration.ExtremeAssertions && !conforms(o)) fail(o, "MIR_Ternary");
325    i.changeOperatorTo(o);
326    i.putOperand(0, Result);
327    i.putOperand(1, Value1);
328    i.putOperand(2, Value2);
329    i.putOperand(3, Value3);
330    return i;
331  }
332}
333