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 GuardedSet 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 GuardedSet extends InstructionFormat {
022  /**
023   * InstructionFormat identification method for GuardedSet.
024   * @param i an instruction
025   * @return <code>true</code> if the InstructionFormat of the argument
026   *         instruction is GuardedSet 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 GuardedSet.
034   * @param o an instruction
035   * @return <code>true</code> if the InstructionFormat of the argument
036   *         operator is GuardedSet or <code>false</code>
037   *         if it is not.
038   */
039  public static boolean conforms(Operator o) {
040    return o.format == GuardedSet_format;
041  }
042
043  /**
044   * Get the operand called Ref 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 Ref
049   */
050  public static Operand getRef(Instruction i) {
051    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GuardedSet");
052    return (Operand) i.getOperand(0);
053  }
054  /**
055   * Get the operand called Ref 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 Ref
060   */
061  public static Operand getClearRef(Instruction i) {
062    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GuardedSet");
063    return (Operand) i.getClearOperand(0);
064  }
065  /**
066   * Set the operand called Ref 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 Ref the operand to store
072   */
073  public static void setRef(Instruction i, Operand Ref) {
074    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GuardedSet");
075    i.putOperand(0, Ref);
076  }
077  /**
078   * Return the index of the operand called Ref
079   * in the argument instruction.
080   * @param i the instruction to access.
081   * @return the index of the operand called Ref
082   *         in the argument instruction
083   */
084  public static int indexOfRef(Instruction i) {
085    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GuardedSet");
086    return 0;
087  }
088  /**
089   * Does the argument instruction have a non-null
090   * operand named Ref?
091   * @param i the instruction to access.
092   * @return <code>true</code> if the instruction has an non-null
093   *         operand named Ref or <code>false</code>
094   *         if it does not.
095   */
096  public static boolean hasRef(Instruction i) {
097    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GuardedSet");
098    return i.getOperand(0) != null;
099  }
100
101  /**
102   * Get the operand called Val 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 Val
107   */
108  public static Operand getVal(Instruction i) {
109    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GuardedSet");
110    return (Operand) i.getOperand(1);
111  }
112  /**
113   * Get the operand called Val 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 Val
118   */
119  public static Operand getClearVal(Instruction i) {
120    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GuardedSet");
121    return (Operand) i.getClearOperand(1);
122  }
123  /**
124   * Set the operand called Val 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 Val the operand to store
130   */
131  public static void setVal(Instruction i, Operand Val) {
132    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GuardedSet");
133    i.putOperand(1, Val);
134  }
135  /**
136   * Return the index of the operand called Val
137   * in the argument instruction.
138   * @param i the instruction to access.
139   * @return the index of the operand called Val
140   *         in the argument instruction
141   */
142  public static int indexOfVal(Instruction i) {
143    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GuardedSet");
144    return 1;
145  }
146  /**
147   * Does the argument instruction have a non-null
148   * operand named Val?
149   * @param i the instruction to access.
150   * @return <code>true</code> if the instruction has an non-null
151   *         operand named Val or <code>false</code>
152   *         if it does not.
153   */
154  public static boolean hasVal(Instruction i) {
155    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GuardedSet");
156    return i.getOperand(1) != null;
157  }
158
159  /**
160   * Get the operand called Guard 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 Guard
165   */
166  public static Operand getGuard(Instruction i) {
167    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GuardedSet");
168    return (Operand) i.getOperand(2);
169  }
170  /**
171   * Get the operand called Guard 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 Guard
176   */
177  public static Operand getClearGuard(Instruction i) {
178    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GuardedSet");
179    return (Operand) i.getClearOperand(2);
180  }
181  /**
182   * Set the operand called Guard 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 Guard the operand to store
188   */
189  public static void setGuard(Instruction i, Operand Guard) {
190    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GuardedSet");
191    i.putOperand(2, Guard);
192  }
193  /**
194   * Return the index of the operand called Guard
195   * in the argument instruction.
196   * @param i the instruction to access.
197   * @return the index of the operand called Guard
198   *         in the argument instruction
199   */
200  public static int indexOfGuard(Instruction i) {
201    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GuardedSet");
202    return 2;
203  }
204  /**
205   * Does the argument instruction have a non-null
206   * operand named Guard?
207   * @param i the instruction to access.
208   * @return <code>true</code> if the instruction has an non-null
209   *         operand named Guard or <code>false</code>
210   *         if it does not.
211   */
212  public static boolean hasGuard(Instruction i) {
213    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GuardedSet");
214    return i.getOperand(2) != null;
215  }
216
217
218  /**
219   * Create an instruction of the GuardedSet instruction format.
220   * @param o the instruction's operator
221   * @param Ref the instruction's Ref operand
222   * @param Val the instruction's Val operand
223   * @param Guard the instruction's Guard operand
224   * @return the newly created GuardedSet instruction
225   */
226  public static Instruction create(Operator o
227                   , Operand Ref
228                   , Operand Val
229                   , Operand Guard
230                )
231  {
232    if (Configuration.ExtremeAssertions && !conforms(o)) fail(o, "GuardedSet");
233    Instruction i = Instruction.create(o, 5);
234    i.putOperand(0, Ref);
235    i.putOperand(1, Val);
236    i.putOperand(2, Guard);
237    return i;
238  }
239
240  /**
241   * Mutate the argument instruction into an instruction of the
242   * GuardedSet instruction format having the specified
243   * operator and operands.
244   * @param i the instruction to mutate
245   * @param o the instruction's operator
246   * @param Ref the instruction's Ref operand
247   * @param Val the instruction's Val operand
248   * @param Guard the instruction's Guard operand
249   * @return the mutated instruction
250   */
251  public static Instruction mutate(Instruction i, Operator o
252                   , Operand Ref
253                   , Operand Val
254                   , Operand Guard
255                )
256  {
257    if (Configuration.ExtremeAssertions && !conforms(o)) fail(o, "GuardedSet");
258    i.changeOperatorTo(o);
259    i.putOperand(0, Ref);
260    i.putOperand(1, Val);
261    i.putOperand(2, Guard);
262    return i;
263  }
264}
265