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/Support/raw_ostream.h"
22 //===----------------------------------------------------------------------===//
23 // Top Level Entrypoint
24 //===----------------------------------------------------------------------===//
26 /// EmitAnyX86InstComments - This function decodes x86 instructions and prints
27 /// newline terminated strings to the specified string if desired. This
28 /// information is shown in disassembly dumps when verbose assembly is enabled.
29 void llvm::EmitAnyX86InstComments(const MCInst *MI, raw_ostream &OS,
30 const char *(*getRegName)(unsigned)) {
31 // If this is a shuffle operation, the switch should fill in this state.
32 SmallVector<int, 8> ShuffleMask;
33 const char *DestName = 0, *Src1Name = 0, *Src2Name = 0;
35 switch (MI->getOpcode()) {
37 Src1Name = getRegName(MI->getOperand(0).getReg());
38 Src2Name = getRegName(MI->getOperand(2).getReg());
39 DecodeINSERTPSMask(MI->getOperand(3).getImm(), ShuffleMask);
41 case X86::VINSERTPSrr:
42 DestName = getRegName(MI->getOperand(0).getReg());
43 Src1Name = getRegName(MI->getOperand(1).getReg());
44 Src2Name = getRegName(MI->getOperand(2).getReg());
45 DecodeINSERTPSMask(MI->getOperand(3).getImm(), ShuffleMask);
49 Src2Name = getRegName(MI->getOperand(2).getReg());
50 Src1Name = getRegName(MI->getOperand(0).getReg());
51 DecodeMOVLHPSMask(2, ShuffleMask);
54 Src2Name = getRegName(MI->getOperand(2).getReg());
55 Src1Name = getRegName(MI->getOperand(1).getReg());
56 DestName = getRegName(MI->getOperand(0).getReg());
57 DecodeMOVLHPSMask(2, ShuffleMask);
61 Src2Name = getRegName(MI->getOperand(2).getReg());
62 Src1Name = getRegName(MI->getOperand(0).getReg());
63 DecodeMOVHLPSMask(2, ShuffleMask);
66 Src2Name = getRegName(MI->getOperand(2).getReg());
67 Src1Name = getRegName(MI->getOperand(1).getReg());
68 DestName = getRegName(MI->getOperand(0).getReg());
69 DecodeMOVHLPSMask(2, ShuffleMask);
72 case X86::PALIGNR128rr:
73 case X86::VPALIGNR128rr:
74 Src1Name = getRegName(MI->getOperand(2).getReg());
76 case X86::PALIGNR128rm:
77 case X86::VPALIGNR128rm:
78 Src2Name = getRegName(MI->getOperand(1).getReg());
79 DestName = getRegName(MI->getOperand(0).getReg());
80 DecodePALIGNRMask(MVT::v16i8,
81 MI->getOperand(MI->getNumOperands()-1).getImm(),
84 case X86::VPALIGNR256rr:
85 Src1Name = getRegName(MI->getOperand(2).getReg());
87 case X86::VPALIGNR256rm:
88 Src2Name = getRegName(MI->getOperand(1).getReg());
89 DestName = getRegName(MI->getOperand(0).getReg());
90 DecodePALIGNRMask(MVT::v32i8,
91 MI->getOperand(MI->getNumOperands()-1).getImm(),
97 Src1Name = getRegName(MI->getOperand(1).getReg());
101 DestName = getRegName(MI->getOperand(0).getReg());
102 DecodePSHUFMask(MVT::v4i32, MI->getOperand(MI->getNumOperands()-1).getImm(),
105 case X86::VPSHUFDYri:
106 Src1Name = getRegName(MI->getOperand(1).getReg());
108 case X86::VPSHUFDYmi:
109 DestName = getRegName(MI->getOperand(0).getReg());
110 DecodePSHUFMask(MVT::v8i32, MI->getOperand(MI->getNumOperands()-1).getImm(),
116 case X86::VPSHUFHWri:
117 Src1Name = getRegName(MI->getOperand(1).getReg());
120 case X86::VPSHUFHWmi:
121 DestName = getRegName(MI->getOperand(0).getReg());
122 DecodePSHUFHWMask(MVT::v8i16,
123 MI->getOperand(MI->getNumOperands()-1).getImm(),
126 case X86::VPSHUFHWYri:
127 Src1Name = getRegName(MI->getOperand(1).getReg());
129 case X86::VPSHUFHWYmi:
130 DestName = getRegName(MI->getOperand(0).getReg());
131 DecodePSHUFHWMask(MVT::v16i16,
132 MI->getOperand(MI->getNumOperands()-1).getImm(),
136 case X86::VPSHUFLWri:
137 Src1Name = getRegName(MI->getOperand(1).getReg());
140 case X86::VPSHUFLWmi:
141 DestName = getRegName(MI->getOperand(0).getReg());
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 DecodePSHUFLWMask(MVT::v16i16,
152 MI->getOperand(MI->getNumOperands()-1).getImm(),
156 case X86::PUNPCKHBWrr:
157 Src2Name = getRegName(MI->getOperand(2).getReg());
159 case X86::PUNPCKHBWrm:
160 Src1Name = getRegName(MI->getOperand(0).getReg());
161 DecodeUNPCKHMask(MVT::v16i8, ShuffleMask);
163 case X86::VPUNPCKHBWrr:
164 Src2Name = getRegName(MI->getOperand(2).getReg());
166 case X86::VPUNPCKHBWrm:
167 Src1Name = getRegName(MI->getOperand(1).getReg());
168 DestName = getRegName(MI->getOperand(0).getReg());
169 DecodeUNPCKHMask(MVT::v16i8, ShuffleMask);
171 case X86::VPUNPCKHBWYrr:
172 Src2Name = getRegName(MI->getOperand(2).getReg());
174 case X86::VPUNPCKHBWYrm:
175 Src1Name = getRegName(MI->getOperand(1).getReg());
176 DestName = getRegName(MI->getOperand(0).getReg());
177 DecodeUNPCKHMask(MVT::v32i8, ShuffleMask);
179 case X86::PUNPCKHWDrr:
180 Src2Name = getRegName(MI->getOperand(2).getReg());
182 case X86::PUNPCKHWDrm:
183 Src1Name = getRegName(MI->getOperand(0).getReg());
184 DecodeUNPCKHMask(MVT::v8i16, ShuffleMask);
186 case X86::VPUNPCKHWDrr:
187 Src2Name = getRegName(MI->getOperand(2).getReg());
189 case X86::VPUNPCKHWDrm:
190 Src1Name = getRegName(MI->getOperand(1).getReg());
191 DestName = getRegName(MI->getOperand(0).getReg());
192 DecodeUNPCKHMask(MVT::v8i16, ShuffleMask);
194 case X86::VPUNPCKHWDYrr:
195 Src2Name = getRegName(MI->getOperand(2).getReg());
197 case X86::VPUNPCKHWDYrm:
198 Src1Name = getRegName(MI->getOperand(1).getReg());
199 DestName = getRegName(MI->getOperand(0).getReg());
200 DecodeUNPCKHMask(MVT::v16i16, ShuffleMask);
202 case X86::PUNPCKHDQrr:
203 Src2Name = getRegName(MI->getOperand(2).getReg());
205 case X86::PUNPCKHDQrm:
206 Src1Name = getRegName(MI->getOperand(0).getReg());
207 DecodeUNPCKHMask(MVT::v4i32, ShuffleMask);
209 case X86::VPUNPCKHDQrr:
210 Src2Name = getRegName(MI->getOperand(2).getReg());
212 case X86::VPUNPCKHDQrm:
213 Src1Name = getRegName(MI->getOperand(1).getReg());
214 DestName = getRegName(MI->getOperand(0).getReg());
215 DecodeUNPCKHMask(MVT::v4i32, ShuffleMask);
217 case X86::VPUNPCKHDQYrr:
218 Src2Name = getRegName(MI->getOperand(2).getReg());
220 case X86::VPUNPCKHDQYrm:
221 Src1Name = getRegName(MI->getOperand(1).getReg());
222 DestName = getRegName(MI->getOperand(0).getReg());
223 DecodeUNPCKHMask(MVT::v8i32, ShuffleMask);
225 case X86::PUNPCKHQDQrr:
226 Src2Name = getRegName(MI->getOperand(2).getReg());
228 case X86::PUNPCKHQDQrm:
229 Src1Name = getRegName(MI->getOperand(0).getReg());
230 DecodeUNPCKHMask(MVT::v2i64, ShuffleMask);
232 case X86::VPUNPCKHQDQrr:
233 Src2Name = getRegName(MI->getOperand(2).getReg());
235 case X86::VPUNPCKHQDQrm:
236 Src1Name = getRegName(MI->getOperand(1).getReg());
237 DestName = getRegName(MI->getOperand(0).getReg());
238 DecodeUNPCKHMask(MVT::v2i64, ShuffleMask);
240 case X86::VPUNPCKHQDQYrr:
241 Src2Name = getRegName(MI->getOperand(2).getReg());
243 case X86::VPUNPCKHQDQYrm:
244 Src1Name = getRegName(MI->getOperand(1).getReg());
245 DestName = getRegName(MI->getOperand(0).getReg());
246 DecodeUNPCKHMask(MVT::v4i64, ShuffleMask);
249 case X86::PUNPCKLBWrr:
250 Src2Name = getRegName(MI->getOperand(2).getReg());
252 case X86::PUNPCKLBWrm:
253 Src1Name = getRegName(MI->getOperand(0).getReg());
254 DecodeUNPCKLMask(MVT::v16i8, ShuffleMask);
256 case X86::VPUNPCKLBWrr:
257 Src2Name = getRegName(MI->getOperand(2).getReg());
259 case X86::VPUNPCKLBWrm:
260 Src1Name = getRegName(MI->getOperand(1).getReg());
261 DestName = getRegName(MI->getOperand(0).getReg());
262 DecodeUNPCKLMask(MVT::v16i8, ShuffleMask);
264 case X86::VPUNPCKLBWYrr:
265 Src2Name = getRegName(MI->getOperand(2).getReg());
267 case X86::VPUNPCKLBWYrm:
268 Src1Name = getRegName(MI->getOperand(1).getReg());
269 DestName = getRegName(MI->getOperand(0).getReg());
270 DecodeUNPCKLMask(MVT::v32i8, ShuffleMask);
272 case X86::PUNPCKLWDrr:
273 Src2Name = getRegName(MI->getOperand(2).getReg());
275 case X86::PUNPCKLWDrm:
276 Src1Name = getRegName(MI->getOperand(0).getReg());
277 DecodeUNPCKLMask(MVT::v8i16, ShuffleMask);
279 case X86::VPUNPCKLWDrr:
280 Src2Name = getRegName(MI->getOperand(2).getReg());
282 case X86::VPUNPCKLWDrm:
283 Src1Name = getRegName(MI->getOperand(1).getReg());
284 DestName = getRegName(MI->getOperand(0).getReg());
285 DecodeUNPCKLMask(MVT::v8i16, ShuffleMask);
287 case X86::VPUNPCKLWDYrr:
288 Src2Name = getRegName(MI->getOperand(2).getReg());
290 case X86::VPUNPCKLWDYrm:
291 Src1Name = getRegName(MI->getOperand(1).getReg());
292 DestName = getRegName(MI->getOperand(0).getReg());
293 DecodeUNPCKLMask(MVT::v16i16, ShuffleMask);
295 case X86::PUNPCKLDQrr:
296 Src2Name = getRegName(MI->getOperand(2).getReg());
298 case X86::PUNPCKLDQrm:
299 Src1Name = getRegName(MI->getOperand(0).getReg());
300 DecodeUNPCKLMask(MVT::v4i32, ShuffleMask);
302 case X86::VPUNPCKLDQrr:
303 Src2Name = getRegName(MI->getOperand(2).getReg());
305 case X86::VPUNPCKLDQrm:
306 Src1Name = getRegName(MI->getOperand(1).getReg());
307 DestName = getRegName(MI->getOperand(0).getReg());
308 DecodeUNPCKLMask(MVT::v4i32, ShuffleMask);
310 case X86::VPUNPCKLDQYrr:
311 Src2Name = getRegName(MI->getOperand(2).getReg());
313 case X86::VPUNPCKLDQYrm:
314 Src1Name = getRegName(MI->getOperand(1).getReg());
315 DestName = getRegName(MI->getOperand(0).getReg());
316 DecodeUNPCKLMask(MVT::v8i32, ShuffleMask);
318 case X86::PUNPCKLQDQrr:
319 Src2Name = getRegName(MI->getOperand(2).getReg());
321 case X86::PUNPCKLQDQrm:
322 Src1Name = getRegName(MI->getOperand(0).getReg());
323 DecodeUNPCKLMask(MVT::v2i64, ShuffleMask);
325 case X86::VPUNPCKLQDQrr:
326 Src2Name = getRegName(MI->getOperand(2).getReg());
328 case X86::VPUNPCKLQDQrm:
329 Src1Name = getRegName(MI->getOperand(1).getReg());
330 DestName = getRegName(MI->getOperand(0).getReg());
331 DecodeUNPCKLMask(MVT::v2i64, ShuffleMask);
333 case X86::VPUNPCKLQDQYrr:
334 Src2Name = getRegName(MI->getOperand(2).getReg());
336 case X86::VPUNPCKLQDQYrm:
337 Src1Name = getRegName(MI->getOperand(1).getReg());
338 DestName = getRegName(MI->getOperand(0).getReg());
339 DecodeUNPCKLMask(MVT::v4i64, ShuffleMask);
343 Src2Name = getRegName(MI->getOperand(2).getReg());
346 DecodeSHUFPMask(MVT::v2f64, MI->getOperand(MI->getNumOperands()-1).getImm(),
348 Src1Name = getRegName(MI->getOperand(0).getReg());
350 case X86::VSHUFPDrri:
351 Src2Name = getRegName(MI->getOperand(2).getReg());
353 case X86::VSHUFPDrmi:
354 DecodeSHUFPMask(MVT::v2f64, MI->getOperand(MI->getNumOperands()-1).getImm(),
356 Src1Name = getRegName(MI->getOperand(1).getReg());
357 DestName = getRegName(MI->getOperand(0).getReg());
359 case X86::VSHUFPDYrri:
360 Src2Name = getRegName(MI->getOperand(2).getReg());
362 case X86::VSHUFPDYrmi:
363 DecodeSHUFPMask(MVT::v4f64, MI->getOperand(MI->getNumOperands()-1).getImm(),
365 Src1Name = getRegName(MI->getOperand(1).getReg());
366 DestName = getRegName(MI->getOperand(0).getReg());
370 Src2Name = getRegName(MI->getOperand(2).getReg());
373 DecodeSHUFPMask(MVT::v4f32, MI->getOperand(MI->getNumOperands()-1).getImm(),
375 Src1Name = getRegName(MI->getOperand(0).getReg());
377 case X86::VSHUFPSrri:
378 Src2Name = getRegName(MI->getOperand(2).getReg());
380 case X86::VSHUFPSrmi:
381 DecodeSHUFPMask(MVT::v4f32, MI->getOperand(MI->getNumOperands()-1).getImm(),
383 Src1Name = getRegName(MI->getOperand(1).getReg());
384 DestName = getRegName(MI->getOperand(0).getReg());
386 case X86::VSHUFPSYrri:
387 Src2Name = getRegName(MI->getOperand(2).getReg());
389 case X86::VSHUFPSYrmi:
390 DecodeSHUFPMask(MVT::v8f32, MI->getOperand(MI->getNumOperands()-1).getImm(),
392 Src1Name = getRegName(MI->getOperand(1).getReg());
393 DestName = getRegName(MI->getOperand(0).getReg());
396 case X86::UNPCKLPDrr:
397 Src2Name = getRegName(MI->getOperand(2).getReg());
399 case X86::UNPCKLPDrm:
400 DecodeUNPCKLMask(MVT::v2f64, ShuffleMask);
401 Src1Name = getRegName(MI->getOperand(0).getReg());
403 case X86::VUNPCKLPDrr:
404 Src2Name = getRegName(MI->getOperand(2).getReg());
406 case X86::VUNPCKLPDrm:
407 DecodeUNPCKLMask(MVT::v2f64, ShuffleMask);
408 Src1Name = getRegName(MI->getOperand(1).getReg());
409 DestName = getRegName(MI->getOperand(0).getReg());
411 case X86::VUNPCKLPDYrr:
412 Src2Name = getRegName(MI->getOperand(2).getReg());
414 case X86::VUNPCKLPDYrm:
415 DecodeUNPCKLMask(MVT::v4f64, ShuffleMask);
416 Src1Name = getRegName(MI->getOperand(1).getReg());
417 DestName = getRegName(MI->getOperand(0).getReg());
419 case X86::UNPCKLPSrr:
420 Src2Name = getRegName(MI->getOperand(2).getReg());
422 case X86::UNPCKLPSrm:
423 DecodeUNPCKLMask(MVT::v4f32, ShuffleMask);
424 Src1Name = getRegName(MI->getOperand(0).getReg());
426 case X86::VUNPCKLPSrr:
427 Src2Name = getRegName(MI->getOperand(2).getReg());
429 case X86::VUNPCKLPSrm:
430 DecodeUNPCKLMask(MVT::v4f32, ShuffleMask);
431 Src1Name = getRegName(MI->getOperand(1).getReg());
432 DestName = getRegName(MI->getOperand(0).getReg());
434 case X86::VUNPCKLPSYrr:
435 Src2Name = getRegName(MI->getOperand(2).getReg());
437 case X86::VUNPCKLPSYrm:
438 DecodeUNPCKLMask(MVT::v8f32, ShuffleMask);
439 Src1Name = getRegName(MI->getOperand(1).getReg());
440 DestName = getRegName(MI->getOperand(0).getReg());
442 case X86::UNPCKHPDrr:
443 Src2Name = getRegName(MI->getOperand(2).getReg());
445 case X86::UNPCKHPDrm:
446 DecodeUNPCKHMask(MVT::v2f64, ShuffleMask);
447 Src1Name = getRegName(MI->getOperand(0).getReg());
449 case X86::VUNPCKHPDrr:
450 Src2Name = getRegName(MI->getOperand(2).getReg());
452 case X86::VUNPCKHPDrm:
453 DecodeUNPCKHMask(MVT::v2f64, ShuffleMask);
454 Src1Name = getRegName(MI->getOperand(1).getReg());
455 DestName = getRegName(MI->getOperand(0).getReg());
457 case X86::VUNPCKHPDYrr:
458 Src2Name = getRegName(MI->getOperand(2).getReg());
460 case X86::VUNPCKHPDYrm:
461 DecodeUNPCKHMask(MVT::v4f64, ShuffleMask);
462 Src1Name = getRegName(MI->getOperand(1).getReg());
463 DestName = getRegName(MI->getOperand(0).getReg());
465 case X86::UNPCKHPSrr:
466 Src2Name = getRegName(MI->getOperand(2).getReg());
468 case X86::UNPCKHPSrm:
469 DecodeUNPCKHMask(MVT::v4f32, ShuffleMask);
470 Src1Name = getRegName(MI->getOperand(0).getReg());
472 case X86::VUNPCKHPSrr:
473 Src2Name = getRegName(MI->getOperand(2).getReg());
475 case X86::VUNPCKHPSrm:
476 DecodeUNPCKHMask(MVT::v4f32, ShuffleMask);
477 Src1Name = getRegName(MI->getOperand(1).getReg());
478 DestName = getRegName(MI->getOperand(0).getReg());
480 case X86::VUNPCKHPSYrr:
481 Src2Name = getRegName(MI->getOperand(2).getReg());
483 case X86::VUNPCKHPSYrm:
484 DecodeUNPCKHMask(MVT::v8f32, ShuffleMask);
485 Src1Name = getRegName(MI->getOperand(1).getReg());
486 DestName = getRegName(MI->getOperand(0).getReg());
488 case X86::VPERMILPSri:
489 Src1Name = getRegName(MI->getOperand(1).getReg());
491 case X86::VPERMILPSmi:
492 DecodePSHUFMask(MVT::v4f32, MI->getOperand(MI->getNumOperands()-1).getImm(),
494 DestName = getRegName(MI->getOperand(0).getReg());
496 case X86::VPERMILPSYri:
497 Src1Name = getRegName(MI->getOperand(1).getReg());
499 case X86::VPERMILPSYmi:
500 DecodePSHUFMask(MVT::v8f32, MI->getOperand(MI->getNumOperands()-1).getImm(),
502 DestName = getRegName(MI->getOperand(0).getReg());
504 case X86::VPERMILPDri:
505 Src1Name = getRegName(MI->getOperand(1).getReg());
507 case X86::VPERMILPDmi:
508 DecodePSHUFMask(MVT::v2f64, MI->getOperand(MI->getNumOperands()-1).getImm(),
510 DestName = getRegName(MI->getOperand(0).getReg());
512 case X86::VPERMILPDYri:
513 Src1Name = getRegName(MI->getOperand(1).getReg());
515 case X86::VPERMILPDYmi:
516 DecodePSHUFMask(MVT::v4f64, MI->getOperand(MI->getNumOperands()-1).getImm(),
518 DestName = getRegName(MI->getOperand(0).getReg());
520 case X86::VPERM2F128rr:
521 case X86::VPERM2I128rr:
522 Src2Name = getRegName(MI->getOperand(2).getReg());
524 case X86::VPERM2F128rm:
525 case X86::VPERM2I128rm:
526 // For instruction comments purpose, assume the 256-bit vector is v4i64.
527 DecodeVPERM2X128Mask(MVT::v4i64,
528 MI->getOperand(MI->getNumOperands()-1).getImm(),
530 Src1Name = getRegName(MI->getOperand(1).getReg());
531 DestName = getRegName(MI->getOperand(0).getReg());
534 case X86::VPERMPDYri:
535 Src1Name = getRegName(MI->getOperand(1).getReg());
538 case X86::VPERMPDYmi:
539 DecodeVPERMMask(MI->getOperand(MI->getNumOperands()-1).getImm(),
541 DestName = getRegName(MI->getOperand(0).getReg());
546 // If this was a shuffle operation, print the shuffle mask.
547 if (!ShuffleMask.empty()) {
548 if (DestName == 0) DestName = Src1Name;
549 OS << (DestName ? DestName : "mem") << " = ";
551 // If the two sources are the same, canonicalize the input elements to be
552 // from the first src so that we get larger element spans.
553 if (Src1Name == Src2Name) {
554 for (unsigned i = 0, e = ShuffleMask.size(); i != e; ++i) {
555 if ((int)ShuffleMask[i] >= 0 && // Not sentinel.
556 ShuffleMask[i] >= (int)e) // From second mask.
561 // The shuffle mask specifies which elements of the src1/src2 fill in the
562 // destination, with a few sentinel values. Loop through and print them
564 for (unsigned i = 0, e = ShuffleMask.size(); i != e; ++i) {
567 if (ShuffleMask[i] == SM_SentinelZero) {
572 // Otherwise, it must come from src1 or src2. Print the span of elements
573 // that comes from this src.
574 bool isSrc1 = ShuffleMask[i] < (int)ShuffleMask.size();
575 const char *SrcName = isSrc1 ? Src1Name : Src2Name;
576 OS << (SrcName ? SrcName : "mem") << '[';
579 (int)ShuffleMask[i] >= 0 &&
580 (ShuffleMask[i] < (int)ShuffleMask.size()) == isSrc1) {
585 OS << ShuffleMask[i] % ShuffleMask.size();
589 --i; // For loop increments element #.