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.ia32;
009
010import org.jikesrvm.Configuration;
011import org.jikesrvm.compilers.opt.ir.operand.ia32.IA32ConditionOperand;
012import org.jikesrvm.compilers.opt.ir.operand.*;
013import org.jikesrvm.compilers.opt.ir.Instruction;
014import org.jikesrvm.compilers.opt.ir.Operator;
015
016/**
017 * The MIR_CompareExchange InstructionFormat class.
018 *
019 * The header comment for {@link Instruction} contains
020 * an explanation of the role of InstructionFormats in the
021 * opt compiler's IR.
022 */
023@SuppressWarnings("unused")  // Machine generated code is never 100% clean
024public final class MIR_CompareExchange extends ArchInstructionFormat {
025  /**
026   * InstructionFormat identification method for MIR_CompareExchange.
027   * @param i an instruction
028   * @return <code>true</code> if the InstructionFormat of the argument
029   *         instruction is MIR_CompareExchange or <code>false</code>
030   *         if it is not.
031   */
032  public static boolean conforms(Instruction i) {
033    return conforms(i.operator());
034  }
035  /**
036   * InstructionFormat identification method for MIR_CompareExchange.
037   * @param o an instruction
038   * @return <code>true</code> if the InstructionFormat of the argument
039   *         operator is MIR_CompareExchange or <code>false</code>
040   *         if it is not.
041   */
042  public static boolean conforms(Operator o) {
043    return o.format == MIR_CompareExchange_format;
044  }
045
046  /**
047   * Get the operand called OldValue from the
048   * argument instruction. Note that the returned operand
049   * will still point to its containing instruction.
050   * @param i the instruction to fetch the operand from
051   * @return the operand called OldValue
052   */
053  public static RegisterOperand getOldValue(Instruction i) {
054    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_CompareExchange");
055    return (RegisterOperand) i.getOperand(0);
056  }
057  /**
058   * Get the operand called OldValue from the argument
059   * instruction clearing its instruction pointer. The returned
060   * operand will not point to any containing instruction.
061   * @param i the instruction to fetch the operand from
062   * @return the operand called OldValue
063   */
064  public static RegisterOperand getClearOldValue(Instruction i) {
065    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_CompareExchange");
066    return (RegisterOperand) i.getClearOperand(0);
067  }
068  /**
069   * Set the operand called OldValue in the argument
070   * instruction to the argument operand. The operand will
071   * now point to the argument instruction as its containing
072   * instruction.
073   * @param i the instruction in which to store the operand
074   * @param OldValue the operand to store
075   */
076  public static void setOldValue(Instruction i, RegisterOperand OldValue) {
077    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_CompareExchange");
078    i.putOperand(0, OldValue);
079  }
080  /**
081   * Return the index of the operand called OldValue
082   * in the argument instruction.
083   * @param i the instruction to access.
084   * @return the index of the operand called OldValue
085   *         in the argument instruction
086   */
087  public static int indexOfOldValue(Instruction i) {
088    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_CompareExchange");
089    return 0;
090  }
091  /**
092   * Does the argument instruction have a non-null
093   * operand named OldValue?
094   * @param i the instruction to access.
095   * @return <code>true</code> if the instruction has an non-null
096   *         operand named OldValue or <code>false</code>
097   *         if it does not.
098   */
099  public static boolean hasOldValue(Instruction i) {
100    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_CompareExchange");
101    return i.getOperand(0) != null;
102  }
103
104  /**
105   * Get the operand called MemAddr from the
106   * argument instruction. Note that the returned operand
107   * will still point to its containing instruction.
108   * @param i the instruction to fetch the operand from
109   * @return the operand called MemAddr
110   */
111  public static MemoryOperand getMemAddr(Instruction i) {
112    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_CompareExchange");
113    return (MemoryOperand) i.getOperand(1);
114  }
115  /**
116   * Get the operand called MemAddr from the argument
117   * instruction clearing its instruction pointer. The returned
118   * operand will not point to any containing instruction.
119   * @param i the instruction to fetch the operand from
120   * @return the operand called MemAddr
121   */
122  public static MemoryOperand getClearMemAddr(Instruction i) {
123    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_CompareExchange");
124    return (MemoryOperand) i.getClearOperand(1);
125  }
126  /**
127   * Set the operand called MemAddr in the argument
128   * instruction to the argument operand. The operand will
129   * now point to the argument instruction as its containing
130   * instruction.
131   * @param i the instruction in which to store the operand
132   * @param MemAddr the operand to store
133   */
134  public static void setMemAddr(Instruction i, MemoryOperand MemAddr) {
135    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_CompareExchange");
136    i.putOperand(1, MemAddr);
137  }
138  /**
139   * Return the index of the operand called MemAddr
140   * in the argument instruction.
141   * @param i the instruction to access.
142   * @return the index of the operand called MemAddr
143   *         in the argument instruction
144   */
145  public static int indexOfMemAddr(Instruction i) {
146    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_CompareExchange");
147    return 1;
148  }
149  /**
150   * Does the argument instruction have a non-null
151   * operand named MemAddr?
152   * @param i the instruction to access.
153   * @return <code>true</code> if the instruction has an non-null
154   *         operand named MemAddr or <code>false</code>
155   *         if it does not.
156   */
157  public static boolean hasMemAddr(Instruction i) {
158    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_CompareExchange");
159    return i.getOperand(1) != null;
160  }
161
162  /**
163   * Get the operand called NewValue from the
164   * argument instruction. Note that the returned operand
165   * will still point to its containing instruction.
166   * @param i the instruction to fetch the operand from
167   * @return the operand called NewValue
168   */
169  public static RegisterOperand getNewValue(Instruction i) {
170    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_CompareExchange");
171    return (RegisterOperand) i.getOperand(2);
172  }
173  /**
174   * Get the operand called NewValue from the argument
175   * instruction clearing its instruction pointer. The returned
176   * operand will not point to any containing instruction.
177   * @param i the instruction to fetch the operand from
178   * @return the operand called NewValue
179   */
180  public static RegisterOperand getClearNewValue(Instruction i) {
181    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_CompareExchange");
182    return (RegisterOperand) i.getClearOperand(2);
183  }
184  /**
185   * Set the operand called NewValue in the argument
186   * instruction to the argument operand. The operand will
187   * now point to the argument instruction as its containing
188   * instruction.
189   * @param i the instruction in which to store the operand
190   * @param NewValue the operand to store
191   */
192  public static void setNewValue(Instruction i, RegisterOperand NewValue) {
193    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_CompareExchange");
194    i.putOperand(2, NewValue);
195  }
196  /**
197   * Return the index of the operand called NewValue
198   * in the argument instruction.
199   * @param i the instruction to access.
200   * @return the index of the operand called NewValue
201   *         in the argument instruction
202   */
203  public static int indexOfNewValue(Instruction i) {
204    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_CompareExchange");
205    return 2;
206  }
207  /**
208   * Does the argument instruction have a non-null
209   * operand named NewValue?
210   * @param i the instruction to access.
211   * @return <code>true</code> if the instruction has an non-null
212   *         operand named NewValue or <code>false</code>
213   *         if it does not.
214   */
215  public static boolean hasNewValue(Instruction i) {
216    if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "MIR_CompareExchange");
217    return i.getOperand(2) != null;
218  }
219
220
221  /**
222   * Create an instruction of the MIR_CompareExchange instruction format.
223   * @param o the instruction's operator
224   * @param OldValue the instruction's OldValue operand
225   * @param MemAddr the instruction's MemAddr operand
226   * @param NewValue the instruction's NewValue operand
227   * @return the newly created MIR_CompareExchange instruction
228   */
229  public static Instruction create(Operator o
230                   , RegisterOperand OldValue
231                   , MemoryOperand MemAddr
232                   , RegisterOperand NewValue
233                )
234  {
235    if (Configuration.ExtremeAssertions && !conforms(o)) fail(o, "MIR_CompareExchange");
236    Instruction i = Instruction.create(o, 5);
237    i.putOperand(0, OldValue);
238    i.putOperand(1, MemAddr);
239    i.putOperand(2, NewValue);
240    return i;
241  }
242
243  /**
244   * Mutate the argument instruction into an instruction of the
245   * MIR_CompareExchange instruction format having the specified
246   * operator and operands.
247   * @param i the instruction to mutate
248   * @param o the instruction's operator
249   * @param OldValue the instruction's OldValue operand
250   * @param MemAddr the instruction's MemAddr operand
251   * @param NewValue the instruction's NewValue operand
252   * @return the mutated instruction
253   */
254  public static Instruction mutate(Instruction i, Operator o
255                   , RegisterOperand OldValue
256                   , MemoryOperand MemAddr
257                   , RegisterOperand NewValue
258                )
259  {
260    if (Configuration.ExtremeAssertions && !conforms(o)) fail(o, "MIR_CompareExchange");
261    i.changeOperatorTo(o);
262    i.putOperand(0, OldValue);
263    i.putOperand(1, MemAddr);
264    i.putOperand(2, NewValue);
265    return i;
266  }
267}
268