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