1 //===-- X86InstComments.cpp - Generate verbose-asm comments for instrs ----===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This defines functionality used to emit comments about X86 instructions to
11 // an output stream for -fverbose-asm.
13 //===----------------------------------------------------------------------===//
15 #include "X86InstComments.h"
16 #include "MCTargetDesc/X86MCTargetDesc.h"
17 #include "Utils/X86ShuffleDecode.h"
18 #include "llvm/MC/MCInst.h"
19 #include "llvm/CodeGen/ValueTypes.h"
20 #include "llvm/Support/raw_ostream.h"
24 //===----------------------------------------------------------------------===//
25 // Top Level Entrypoint
26 //===----------------------------------------------------------------------===//
28 /// EmitAnyX86InstComments - This function decodes x86 instructions and prints
29 /// newline terminated strings to the specified string if desired. This
30 /// information is shown in disassembly dumps when verbose assembly is enabled.
31 void llvm::EmitAnyX86InstComments(const MCInst *MI, raw_ostream &OS,
32 const char *(*getRegName)(unsigned)) {
33 // If this is a shuffle operation, the switch should fill in this state.
34 SmallVector<int, 8> ShuffleMask;
35 const char *DestName = 0, *Src1Name = 0, *Src2Name = 0;
37 switch (MI->getOpcode()) {
39 case X86::VINSERTPSrr:
40 DestName = getRegName(MI->getOperand(0).getReg());
41 Src1Name = getRegName(MI->getOperand(1).getReg());
42 Src2Name = getRegName(MI->getOperand(2).getReg());
43 if(MI->getOperand(3).isImm())
44 DecodeINSERTPSMask(MI->getOperand(3).getImm(), ShuffleMask);
49 Src2Name = getRegName(MI->getOperand(2).getReg());
50 Src1Name = getRegName(MI->getOperand(1).getReg());
51 DestName = getRegName(MI->getOperand(0).getReg());
52 DecodeMOVLHPSMask(2, ShuffleMask);
57 Src2Name = getRegName(MI->getOperand(2).getReg());
58 Src1Name = getRegName(MI->getOperand(1).getReg());
59 DestName = getRegName(MI->getOperand(0).getReg());
60 DecodeMOVHLPSMask(2, ShuffleMask);
63 case X86::PALIGNR128rr:
64 case X86::VPALIGNR128rr:
65 Src1Name = getRegName(MI->getOperand(2).getReg());
67 case X86::PALIGNR128rm:
68 case X86::VPALIGNR128rm:
69 Src2Name = getRegName(MI->getOperand(1).getReg());
70 DestName = getRegName(MI->getOperand(0).getReg());
71 if(MI->getOperand(MI->getNumOperands()-1).isImm())
72 DecodePALIGNRMask(MVT::v16i8,
73 MI->getOperand(MI->getNumOperands()-1).getImm(),
76 case X86::VPALIGNR256rr:
77 Src1Name = getRegName(MI->getOperand(2).getReg());
79 case X86::VPALIGNR256rm:
80 Src2Name = getRegName(MI->getOperand(1).getReg());
81 DestName = getRegName(MI->getOperand(0).getReg());
82 if(MI->getOperand(MI->getNumOperands()-1).isImm())
83 DecodePALIGNRMask(MVT::v32i8,
84 MI->getOperand(MI->getNumOperands()-1).getImm(),
90 Src1Name = getRegName(MI->getOperand(1).getReg());
94 DestName = getRegName(MI->getOperand(0).getReg());
95 if(MI->getOperand(MI->getNumOperands()-1).isImm())
96 DecodePSHUFMask(MVT::v4i32,
97 MI->getOperand(MI->getNumOperands()-1).getImm(),
100 case X86::VPSHUFDYri:
101 Src1Name = getRegName(MI->getOperand(1).getReg());
103 case X86::VPSHUFDYmi:
104 DestName = getRegName(MI->getOperand(0).getReg());
105 if(MI->getOperand(MI->getNumOperands()-1).isImm())
106 DecodePSHUFMask(MVT::v8i32,
107 MI->getOperand(MI->getNumOperands()-1).getImm(),
113 case X86::VPSHUFHWri:
114 Src1Name = getRegName(MI->getOperand(1).getReg());
117 case X86::VPSHUFHWmi:
118 DestName = getRegName(MI->getOperand(0).getReg());
119 if(MI->getOperand(MI->getNumOperands()-1).isImm())
120 DecodePSHUFHWMask(MVT::v8i16,
121 MI->getOperand(MI->getNumOperands()-1).getImm(),
124 case X86::VPSHUFHWYri:
125 Src1Name = getRegName(MI->getOperand(1).getReg());
127 case X86::VPSHUFHWYmi:
128 DestName = getRegName(MI->getOperand(0).getReg());
129 if(MI->getOperand(MI->getNumOperands()-1).isImm())
130 DecodePSHUFHWMask(MVT::v16i16,
131 MI->getOperand(MI->getNumOperands()-1).getImm(),
135 case X86::VPSHUFLWri:
136 Src1Name = getRegName(MI->getOperand(1).getReg());
139 case X86::VPSHUFLWmi:
140 DestName = getRegName(MI->getOperand(0).getReg());
141 if(MI->getOperand(MI->getNumOperands()-1).isImm())
142 DecodePSHUFLWMask(MVT::v8i16,
143 MI->getOperand(MI->getNumOperands()-1).getImm(),
146 case X86::VPSHUFLWYri:
147 Src1Name = getRegName(MI->getOperand(1).getReg());
149 case X86::VPSHUFLWYmi:
150 DestName = getRegName(MI->getOperand(0).getReg());
151 if(MI->getOperand(MI->getNumOperands()-1).isImm())
152 DecodePSHUFLWMask(MVT::v16i16,
153 MI->getOperand(MI->getNumOperands()-1).getImm(),
157 case X86::PUNPCKHBWrr:
158 case X86::VPUNPCKHBWrr:
159 Src2Name = getRegName(MI->getOperand(2).getReg());
161 case X86::PUNPCKHBWrm:
162 case X86::VPUNPCKHBWrm:
163 Src1Name = getRegName(MI->getOperand(1).getReg());
164 DestName = getRegName(MI->getOperand(0).getReg());
165 DecodeUNPCKHMask(MVT::v16i8, ShuffleMask);
167 case X86::VPUNPCKHBWYrr:
168 Src2Name = getRegName(MI->getOperand(2).getReg());
170 case X86::VPUNPCKHBWYrm:
171 Src1Name = getRegName(MI->getOperand(1).getReg());
172 DestName = getRegName(MI->getOperand(0).getReg());
173 DecodeUNPCKHMask(MVT::v32i8, ShuffleMask);
175 case X86::PUNPCKHWDrr:
176 case X86::VPUNPCKHWDrr:
177 Src2Name = getRegName(MI->getOperand(2).getReg());
179 case X86::PUNPCKHWDrm:
180 case X86::VPUNPCKHWDrm:
181 Src1Name = getRegName(MI->getOperand(1).getReg());
182 DestName = getRegName(MI->getOperand(0).getReg());
183 DecodeUNPCKHMask(MVT::v8i16, ShuffleMask);
185 case X86::VPUNPCKHWDYrr:
186 Src2Name = getRegName(MI->getOperand(2).getReg());
188 case X86::VPUNPCKHWDYrm:
189 Src1Name = getRegName(MI->getOperand(1).getReg());
190 DestName = getRegName(MI->getOperand(0).getReg());
191 DecodeUNPCKHMask(MVT::v16i16, ShuffleMask);
193 case X86::PUNPCKHDQrr:
194 case X86::VPUNPCKHDQrr:
195 Src2Name = getRegName(MI->getOperand(2).getReg());
197 case X86::PUNPCKHDQrm:
198 case X86::VPUNPCKHDQrm:
199 Src1Name = getRegName(MI->getOperand(1).getReg());
200 DestName = getRegName(MI->getOperand(0).getReg());
201 DecodeUNPCKHMask(MVT::v4i32, ShuffleMask);
203 case X86::VPUNPCKHDQYrr:
204 Src2Name = getRegName(MI->getOperand(2).getReg());
206 case X86::VPUNPCKHDQYrm:
207 Src1Name = getRegName(MI->getOperand(1).getReg());
208 DestName = getRegName(MI->getOperand(0).getReg());
209 DecodeUNPCKHMask(MVT::v8i32, ShuffleMask);
211 case X86::PUNPCKHQDQrr:
212 case X86::VPUNPCKHQDQrr:
213 Src2Name = getRegName(MI->getOperand(2).getReg());
215 case X86::PUNPCKHQDQrm:
216 case X86::VPUNPCKHQDQrm:
217 Src1Name = getRegName(MI->getOperand(1).getReg());
218 DestName = getRegName(MI->getOperand(0).getReg());
219 DecodeUNPCKHMask(MVT::v2i64, ShuffleMask);
221 case X86::VPUNPCKHQDQYrr:
222 Src2Name = getRegName(MI->getOperand(2).getReg());
224 case X86::VPUNPCKHQDQYrm:
225 Src1Name = getRegName(MI->getOperand(1).getReg());
226 DestName = getRegName(MI->getOperand(0).getReg());
227 DecodeUNPCKHMask(MVT::v4i64, ShuffleMask);
230 case X86::PUNPCKLBWrr:
231 case X86::VPUNPCKLBWrr:
232 Src2Name = getRegName(MI->getOperand(2).getReg());
234 case X86::PUNPCKLBWrm:
235 case X86::VPUNPCKLBWrm:
236 Src1Name = getRegName(MI->getOperand(1).getReg());
237 DestName = getRegName(MI->getOperand(0).getReg());
238 DecodeUNPCKLMask(MVT::v16i8, ShuffleMask);
240 case X86::VPUNPCKLBWYrr:
241 Src2Name = getRegName(MI->getOperand(2).getReg());
243 case X86::VPUNPCKLBWYrm:
244 Src1Name = getRegName(MI->getOperand(1).getReg());
245 DestName = getRegName(MI->getOperand(0).getReg());
246 DecodeUNPCKLMask(MVT::v32i8, ShuffleMask);
248 case X86::PUNPCKLWDrr:
249 case X86::VPUNPCKLWDrr:
250 Src2Name = getRegName(MI->getOperand(2).getReg());
252 case X86::PUNPCKLWDrm:
253 case X86::VPUNPCKLWDrm:
254 Src1Name = getRegName(MI->getOperand(1).getReg());
255 DestName = getRegName(MI->getOperand(0).getReg());
256 DecodeUNPCKLMask(MVT::v8i16, ShuffleMask);
258 case X86::VPUNPCKLWDYrr:
259 Src2Name = getRegName(MI->getOperand(2).getReg());
261 case X86::VPUNPCKLWDYrm:
262 Src1Name = getRegName(MI->getOperand(1).getReg());
263 DestName = getRegName(MI->getOperand(0).getReg());
264 DecodeUNPCKLMask(MVT::v16i16, ShuffleMask);
266 case X86::PUNPCKLDQrr:
267 case X86::VPUNPCKLDQrr:
268 Src2Name = getRegName(MI->getOperand(2).getReg());
270 case X86::PUNPCKLDQrm:
271 case X86::VPUNPCKLDQrm:
272 Src1Name = getRegName(MI->getOperand(1).getReg());
273 DestName = getRegName(MI->getOperand(0).getReg());
274 DecodeUNPCKLMask(MVT::v4i32, ShuffleMask);
276 case X86::VPUNPCKLDQYrr:
277 Src2Name = getRegName(MI->getOperand(2).getReg());
279 case X86::VPUNPCKLDQYrm:
280 Src1Name = getRegName(MI->getOperand(1).getReg());
281 DestName = getRegName(MI->getOperand(0).getReg());
282 DecodeUNPCKLMask(MVT::v8i32, ShuffleMask);
284 case X86::PUNPCKLQDQrr:
285 case X86::VPUNPCKLQDQrr:
286 Src2Name = getRegName(MI->getOperand(2).getReg());
288 case X86::PUNPCKLQDQrm:
289 case X86::VPUNPCKLQDQrm:
290 Src1Name = getRegName(MI->getOperand(1).getReg());
291 DestName = getRegName(MI->getOperand(0).getReg());
292 DecodeUNPCKLMask(MVT::v2i64, ShuffleMask);
294 case X86::VPUNPCKLQDQYrr:
295 Src2Name = getRegName(MI->getOperand(2).getReg());
297 case X86::VPUNPCKLQDQYrm:
298 Src1Name = getRegName(MI->getOperand(1).getReg());
299 DestName = getRegName(MI->getOperand(0).getReg());
300 DecodeUNPCKLMask(MVT::v4i64, ShuffleMask);
304 case X86::VSHUFPDrri:
305 Src2Name = getRegName(MI->getOperand(2).getReg());
308 case X86::VSHUFPDrmi:
309 if(MI->getOperand(MI->getNumOperands()-1).isImm())
310 DecodeSHUFPMask(MVT::v2f64,
311 MI->getOperand(MI->getNumOperands()-1).getImm(),
313 Src1Name = getRegName(MI->getOperand(1).getReg());
314 DestName = getRegName(MI->getOperand(0).getReg());
316 case X86::VSHUFPDYrri:
317 Src2Name = getRegName(MI->getOperand(2).getReg());
319 case X86::VSHUFPDYrmi:
320 if(MI->getOperand(MI->getNumOperands()-1).isImm())
321 DecodeSHUFPMask(MVT::v4f64,
322 MI->getOperand(MI->getNumOperands()-1).getImm(),
324 Src1Name = getRegName(MI->getOperand(1).getReg());
325 DestName = getRegName(MI->getOperand(0).getReg());
329 case X86::VSHUFPSrri:
330 Src2Name = getRegName(MI->getOperand(2).getReg());
333 case X86::VSHUFPSrmi:
334 if(MI->getOperand(MI->getNumOperands()-1).isImm())
335 DecodeSHUFPMask(MVT::v4f32,
336 MI->getOperand(MI->getNumOperands()-1).getImm(),
338 Src1Name = getRegName(MI->getOperand(1).getReg());
339 DestName = getRegName(MI->getOperand(0).getReg());
341 case X86::VSHUFPSYrri:
342 Src2Name = getRegName(MI->getOperand(2).getReg());
344 case X86::VSHUFPSYrmi:
345 if(MI->getOperand(MI->getNumOperands()-1).isImm())
346 DecodeSHUFPMask(MVT::v8f32,
347 MI->getOperand(MI->getNumOperands()-1).getImm(),
349 Src1Name = getRegName(MI->getOperand(1).getReg());
350 DestName = getRegName(MI->getOperand(0).getReg());
353 case X86::UNPCKLPDrr:
354 case X86::VUNPCKLPDrr:
355 Src2Name = getRegName(MI->getOperand(2).getReg());
357 case X86::UNPCKLPDrm:
358 case X86::VUNPCKLPDrm:
359 DecodeUNPCKLMask(MVT::v2f64, ShuffleMask);
360 Src1Name = getRegName(MI->getOperand(1).getReg());
361 DestName = getRegName(MI->getOperand(0).getReg());
363 case X86::VUNPCKLPDYrr:
364 Src2Name = getRegName(MI->getOperand(2).getReg());
366 case X86::VUNPCKLPDYrm:
367 DecodeUNPCKLMask(MVT::v4f64, ShuffleMask);
368 Src1Name = getRegName(MI->getOperand(1).getReg());
369 DestName = getRegName(MI->getOperand(0).getReg());
371 case X86::UNPCKLPSrr:
372 case X86::VUNPCKLPSrr:
373 Src2Name = getRegName(MI->getOperand(2).getReg());
375 case X86::UNPCKLPSrm:
376 case X86::VUNPCKLPSrm:
377 DecodeUNPCKLMask(MVT::v4f32, ShuffleMask);
378 Src1Name = getRegName(MI->getOperand(1).getReg());
379 DestName = getRegName(MI->getOperand(0).getReg());
381 case X86::VUNPCKLPSYrr:
382 Src2Name = getRegName(MI->getOperand(2).getReg());
384 case X86::VUNPCKLPSYrm:
385 DecodeUNPCKLMask(MVT::v8f32, ShuffleMask);
386 Src1Name = getRegName(MI->getOperand(1).getReg());
387 DestName = getRegName(MI->getOperand(0).getReg());
389 case X86::UNPCKHPDrr:
390 case X86::VUNPCKHPDrr:
391 Src2Name = getRegName(MI->getOperand(2).getReg());
393 case X86::UNPCKHPDrm:
394 case X86::VUNPCKHPDrm:
395 DecodeUNPCKHMask(MVT::v2f64, ShuffleMask);
396 Src1Name = getRegName(MI->getOperand(1).getReg());
397 DestName = getRegName(MI->getOperand(0).getReg());
399 case X86::VUNPCKHPDYrr:
400 Src2Name = getRegName(MI->getOperand(2).getReg());
402 case X86::VUNPCKHPDYrm:
403 DecodeUNPCKHMask(MVT::v4f64, ShuffleMask);
404 Src1Name = getRegName(MI->getOperand(1).getReg());
405 DestName = getRegName(MI->getOperand(0).getReg());
407 case X86::UNPCKHPSrr:
408 case X86::VUNPCKHPSrr:
409 Src2Name = getRegName(MI->getOperand(2).getReg());
411 case X86::UNPCKHPSrm:
412 case X86::VUNPCKHPSrm:
413 DecodeUNPCKHMask(MVT::v4f32, ShuffleMask);
414 Src1Name = getRegName(MI->getOperand(1).getReg());
415 DestName = getRegName(MI->getOperand(0).getReg());
417 case X86::VUNPCKHPSYrr:
418 Src2Name = getRegName(MI->getOperand(2).getReg());
420 case X86::VUNPCKHPSYrm:
421 DecodeUNPCKHMask(MVT::v8f32, ShuffleMask);
422 Src1Name = getRegName(MI->getOperand(1).getReg());
423 DestName = getRegName(MI->getOperand(0).getReg());
425 case X86::VPERMILPSri:
426 Src1Name = getRegName(MI->getOperand(1).getReg());
428 case X86::VPERMILPSmi:
429 if(MI->getOperand(MI->getNumOperands()-1).isImm())
430 DecodePSHUFMask(MVT::v4f32,
431 MI->getOperand(MI->getNumOperands()-1).getImm(),
433 DestName = getRegName(MI->getOperand(0).getReg());
435 case X86::VPERMILPSYri:
436 Src1Name = getRegName(MI->getOperand(1).getReg());
438 case X86::VPERMILPSYmi:
439 if(MI->getOperand(MI->getNumOperands()-1).isImm())
440 DecodePSHUFMask(MVT::v8f32,
441 MI->getOperand(MI->getNumOperands()-1).getImm(),
443 DestName = getRegName(MI->getOperand(0).getReg());
445 case X86::VPERMILPDri:
446 Src1Name = getRegName(MI->getOperand(1).getReg());
448 case X86::VPERMILPDmi:
449 if(MI->getOperand(MI->getNumOperands()-1).isImm())
450 DecodePSHUFMask(MVT::v2f64,
451 MI->getOperand(MI->getNumOperands()-1).getImm(),
453 DestName = getRegName(MI->getOperand(0).getReg());
455 case X86::VPERMILPDYri:
456 Src1Name = getRegName(MI->getOperand(1).getReg());
458 case X86::VPERMILPDYmi:
459 if(MI->getOperand(MI->getNumOperands()-1).isImm())
460 DecodePSHUFMask(MVT::v4f64,
461 MI->getOperand(MI->getNumOperands()-1).getImm(),
463 DestName = getRegName(MI->getOperand(0).getReg());
465 case X86::VPERM2F128rr:
466 case X86::VPERM2I128rr:
467 Src2Name = getRegName(MI->getOperand(2).getReg());
469 case X86::VPERM2F128rm:
470 case X86::VPERM2I128rm:
471 // For instruction comments purpose, assume the 256-bit vector is v4i64.
472 if(MI->getOperand(MI->getNumOperands()-1).isImm())
473 DecodeVPERM2X128Mask(MVT::v4i64,
474 MI->getOperand(MI->getNumOperands()-1).getImm(),
476 Src1Name = getRegName(MI->getOperand(1).getReg());
477 DestName = getRegName(MI->getOperand(0).getReg());
480 case X86::VPERMPDYri:
481 Src1Name = getRegName(MI->getOperand(1).getReg());
484 case X86::VPERMPDYmi:
485 if(MI->getOperand(MI->getNumOperands()-1).isImm())
486 DecodeVPERMMask(MI->getOperand(MI->getNumOperands()-1).getImm(),
488 DestName = getRegName(MI->getOperand(0).getReg());
493 // If this was a shuffle operation, print the shuffle mask.
494 if (!ShuffleMask.empty()) {
495 if (DestName == 0) DestName = Src1Name;
496 OS << (DestName ? DestName : "mem") << " = ";
498 // If the two sources are the same, canonicalize the input elements to be
499 // from the first src so that we get larger element spans.
500 if (Src1Name == Src2Name) {
501 for (unsigned i = 0, e = ShuffleMask.size(); i != e; ++i) {
502 if ((int)ShuffleMask[i] >= 0 && // Not sentinel.
503 ShuffleMask[i] >= (int)e) // From second mask.
508 // The shuffle mask specifies which elements of the src1/src2 fill in the
509 // destination, with a few sentinel values. Loop through and print them
511 for (unsigned i = 0, e = ShuffleMask.size(); i != e; ++i) {
514 if (ShuffleMask[i] == SM_SentinelZero) {
519 // Otherwise, it must come from src1 or src2. Print the span of elements
520 // that comes from this src.
521 bool isSrc1 = ShuffleMask[i] < (int)ShuffleMask.size();
522 const char *SrcName = isSrc1 ? Src1Name : Src2Name;
523 OS << (SrcName ? SrcName : "mem") << '[';
526 (int)ShuffleMask[i] >= 0 &&
527 (ShuffleMask[i] < (int)ShuffleMask.size()) == isSrc1) {
532 OS << ShuffleMask[i] % ShuffleMask.size();
536 --i; // For loop increments element #.