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);
74 Src1Name = getRegName(MI->getOperand(1).getReg());
78 DestName = getRegName(MI->getOperand(0).getReg());
79 DecodePSHUFMask(MVT::v4i32, MI->getOperand(MI->getNumOperands()-1).getImm(),
83 Src1Name = getRegName(MI->getOperand(1).getReg());
86 DestName = getRegName(MI->getOperand(0).getReg());
87 DecodePSHUFMask(MVT::v8i32, MI->getOperand(MI->getNumOperands()-1).getImm(),
94 Src1Name = getRegName(MI->getOperand(1).getReg());
98 DestName = getRegName(MI->getOperand(0).getReg());
99 DecodePSHUFHWMask(MVT::v8i16,
100 MI->getOperand(MI->getNumOperands()-1).getImm(),
103 case X86::VPSHUFHWYri:
104 Src1Name = getRegName(MI->getOperand(1).getReg());
106 case X86::VPSHUFHWYmi:
107 DestName = getRegName(MI->getOperand(0).getReg());
108 DecodePSHUFHWMask(MVT::v16i16,
109 MI->getOperand(MI->getNumOperands()-1).getImm(),
113 case X86::VPSHUFLWri:
114 Src1Name = getRegName(MI->getOperand(1).getReg());
117 case X86::VPSHUFLWmi:
118 DestName = getRegName(MI->getOperand(0).getReg());
119 DecodePSHUFLWMask(MVT::v8i16,
120 MI->getOperand(MI->getNumOperands()-1).getImm(),
123 case X86::VPSHUFLWYri:
124 Src1Name = getRegName(MI->getOperand(1).getReg());
126 case X86::VPSHUFLWYmi:
127 DestName = getRegName(MI->getOperand(0).getReg());
128 DecodePSHUFLWMask(MVT::v16i16,
129 MI->getOperand(MI->getNumOperands()-1).getImm(),
133 case X86::PUNPCKHBWrr:
134 Src2Name = getRegName(MI->getOperand(2).getReg());
136 case X86::PUNPCKHBWrm:
137 Src1Name = getRegName(MI->getOperand(0).getReg());
138 DecodeUNPCKHMask(MVT::v16i8, ShuffleMask);
140 case X86::VPUNPCKHBWrr:
141 Src2Name = getRegName(MI->getOperand(2).getReg());
143 case X86::VPUNPCKHBWrm:
144 Src1Name = getRegName(MI->getOperand(1).getReg());
145 DestName = getRegName(MI->getOperand(0).getReg());
146 DecodeUNPCKHMask(MVT::v16i8, ShuffleMask);
148 case X86::VPUNPCKHBWYrr:
149 Src2Name = getRegName(MI->getOperand(2).getReg());
151 case X86::VPUNPCKHBWYrm:
152 Src1Name = getRegName(MI->getOperand(1).getReg());
153 DestName = getRegName(MI->getOperand(0).getReg());
154 DecodeUNPCKHMask(MVT::v32i8, ShuffleMask);
156 case X86::PUNPCKHWDrr:
157 Src2Name = getRegName(MI->getOperand(2).getReg());
159 case X86::PUNPCKHWDrm:
160 Src1Name = getRegName(MI->getOperand(0).getReg());
161 DecodeUNPCKHMask(MVT::v8i16, ShuffleMask);
163 case X86::VPUNPCKHWDrr:
164 Src2Name = getRegName(MI->getOperand(2).getReg());
166 case X86::VPUNPCKHWDrm:
167 Src1Name = getRegName(MI->getOperand(1).getReg());
168 DestName = getRegName(MI->getOperand(0).getReg());
169 DecodeUNPCKHMask(MVT::v8i16, ShuffleMask);
171 case X86::VPUNPCKHWDYrr:
172 Src2Name = getRegName(MI->getOperand(2).getReg());
174 case X86::VPUNPCKHWDYrm:
175 Src1Name = getRegName(MI->getOperand(1).getReg());
176 DestName = getRegName(MI->getOperand(0).getReg());
177 DecodeUNPCKHMask(MVT::v16i16, ShuffleMask);
179 case X86::PUNPCKHDQrr:
180 Src2Name = getRegName(MI->getOperand(2).getReg());
182 case X86::PUNPCKHDQrm:
183 Src1Name = getRegName(MI->getOperand(0).getReg());
184 DecodeUNPCKHMask(MVT::v4i32, ShuffleMask);
186 case X86::VPUNPCKHDQrr:
187 Src2Name = getRegName(MI->getOperand(2).getReg());
189 case X86::VPUNPCKHDQrm:
190 Src1Name = getRegName(MI->getOperand(1).getReg());
191 DestName = getRegName(MI->getOperand(0).getReg());
192 DecodeUNPCKHMask(MVT::v4i32, ShuffleMask);
194 case X86::VPUNPCKHDQYrr:
195 Src2Name = getRegName(MI->getOperand(2).getReg());
197 case X86::VPUNPCKHDQYrm:
198 Src1Name = getRegName(MI->getOperand(1).getReg());
199 DestName = getRegName(MI->getOperand(0).getReg());
200 DecodeUNPCKHMask(MVT::v8i32, ShuffleMask);
202 case X86::PUNPCKHQDQrr:
203 Src2Name = getRegName(MI->getOperand(2).getReg());
205 case X86::PUNPCKHQDQrm:
206 Src1Name = getRegName(MI->getOperand(0).getReg());
207 DecodeUNPCKHMask(MVT::v2i64, ShuffleMask);
209 case X86::VPUNPCKHQDQrr:
210 Src2Name = getRegName(MI->getOperand(2).getReg());
212 case X86::VPUNPCKHQDQrm:
213 Src1Name = getRegName(MI->getOperand(1).getReg());
214 DestName = getRegName(MI->getOperand(0).getReg());
215 DecodeUNPCKHMask(MVT::v2i64, ShuffleMask);
217 case X86::VPUNPCKHQDQYrr:
218 Src2Name = getRegName(MI->getOperand(2).getReg());
220 case X86::VPUNPCKHQDQYrm:
221 Src1Name = getRegName(MI->getOperand(1).getReg());
222 DestName = getRegName(MI->getOperand(0).getReg());
223 DecodeUNPCKHMask(MVT::v4i64, ShuffleMask);
226 case X86::PUNPCKLBWrr:
227 Src2Name = getRegName(MI->getOperand(2).getReg());
229 case X86::PUNPCKLBWrm:
230 Src1Name = getRegName(MI->getOperand(0).getReg());
231 DecodeUNPCKLMask(MVT::v16i8, ShuffleMask);
233 case X86::VPUNPCKLBWrr:
234 Src2Name = getRegName(MI->getOperand(2).getReg());
236 case X86::VPUNPCKLBWrm:
237 Src1Name = getRegName(MI->getOperand(1).getReg());
238 DestName = getRegName(MI->getOperand(0).getReg());
239 DecodeUNPCKLMask(MVT::v16i8, ShuffleMask);
241 case X86::VPUNPCKLBWYrr:
242 Src2Name = getRegName(MI->getOperand(2).getReg());
244 case X86::VPUNPCKLBWYrm:
245 Src1Name = getRegName(MI->getOperand(1).getReg());
246 DestName = getRegName(MI->getOperand(0).getReg());
247 DecodeUNPCKLMask(MVT::v32i8, ShuffleMask);
249 case X86::PUNPCKLWDrr:
250 Src2Name = getRegName(MI->getOperand(2).getReg());
252 case X86::PUNPCKLWDrm:
253 Src1Name = getRegName(MI->getOperand(0).getReg());
254 DecodeUNPCKLMask(MVT::v8i16, ShuffleMask);
256 case X86::VPUNPCKLWDrr:
257 Src2Name = getRegName(MI->getOperand(2).getReg());
259 case X86::VPUNPCKLWDrm:
260 Src1Name = getRegName(MI->getOperand(1).getReg());
261 DestName = getRegName(MI->getOperand(0).getReg());
262 DecodeUNPCKLMask(MVT::v8i16, ShuffleMask);
264 case X86::VPUNPCKLWDYrr:
265 Src2Name = getRegName(MI->getOperand(2).getReg());
267 case X86::VPUNPCKLWDYrm:
268 Src1Name = getRegName(MI->getOperand(1).getReg());
269 DestName = getRegName(MI->getOperand(0).getReg());
270 DecodeUNPCKLMask(MVT::v16i16, ShuffleMask);
272 case X86::PUNPCKLDQrr:
273 Src2Name = getRegName(MI->getOperand(2).getReg());
275 case X86::PUNPCKLDQrm:
276 Src1Name = getRegName(MI->getOperand(0).getReg());
277 DecodeUNPCKLMask(MVT::v4i32, ShuffleMask);
279 case X86::VPUNPCKLDQrr:
280 Src2Name = getRegName(MI->getOperand(2).getReg());
282 case X86::VPUNPCKLDQrm:
283 Src1Name = getRegName(MI->getOperand(1).getReg());
284 DestName = getRegName(MI->getOperand(0).getReg());
285 DecodeUNPCKLMask(MVT::v4i32, ShuffleMask);
287 case X86::VPUNPCKLDQYrr:
288 Src2Name = getRegName(MI->getOperand(2).getReg());
290 case X86::VPUNPCKLDQYrm:
291 Src1Name = getRegName(MI->getOperand(1).getReg());
292 DestName = getRegName(MI->getOperand(0).getReg());
293 DecodeUNPCKLMask(MVT::v8i32, ShuffleMask);
295 case X86::PUNPCKLQDQrr:
296 Src2Name = getRegName(MI->getOperand(2).getReg());
298 case X86::PUNPCKLQDQrm:
299 Src1Name = getRegName(MI->getOperand(0).getReg());
300 DecodeUNPCKLMask(MVT::v2i64, ShuffleMask);
302 case X86::VPUNPCKLQDQrr:
303 Src2Name = getRegName(MI->getOperand(2).getReg());
305 case X86::VPUNPCKLQDQrm:
306 Src1Name = getRegName(MI->getOperand(1).getReg());
307 DestName = getRegName(MI->getOperand(0).getReg());
308 DecodeUNPCKLMask(MVT::v2i64, ShuffleMask);
310 case X86::VPUNPCKLQDQYrr:
311 Src2Name = getRegName(MI->getOperand(2).getReg());
313 case X86::VPUNPCKLQDQYrm:
314 Src1Name = getRegName(MI->getOperand(1).getReg());
315 DestName = getRegName(MI->getOperand(0).getReg());
316 DecodeUNPCKLMask(MVT::v4i64, ShuffleMask);
320 Src2Name = getRegName(MI->getOperand(2).getReg());
323 DecodeSHUFPMask(MVT::v2f64, MI->getOperand(MI->getNumOperands()-1).getImm(),
325 Src1Name = getRegName(MI->getOperand(0).getReg());
327 case X86::VSHUFPDrri:
328 Src2Name = getRegName(MI->getOperand(2).getReg());
330 case X86::VSHUFPDrmi:
331 DecodeSHUFPMask(MVT::v2f64, MI->getOperand(MI->getNumOperands()-1).getImm(),
333 Src1Name = getRegName(MI->getOperand(1).getReg());
334 DestName = getRegName(MI->getOperand(0).getReg());
336 case X86::VSHUFPDYrri:
337 Src2Name = getRegName(MI->getOperand(2).getReg());
339 case X86::VSHUFPDYrmi:
340 DecodeSHUFPMask(MVT::v4f64, MI->getOperand(MI->getNumOperands()-1).getImm(),
342 Src1Name = getRegName(MI->getOperand(1).getReg());
343 DestName = getRegName(MI->getOperand(0).getReg());
347 Src2Name = getRegName(MI->getOperand(2).getReg());
350 DecodeSHUFPMask(MVT::v4f32, MI->getOperand(MI->getNumOperands()-1).getImm(),
352 Src1Name = getRegName(MI->getOperand(0).getReg());
354 case X86::VSHUFPSrri:
355 Src2Name = getRegName(MI->getOperand(2).getReg());
357 case X86::VSHUFPSrmi:
358 DecodeSHUFPMask(MVT::v4f32, MI->getOperand(MI->getNumOperands()-1).getImm(),
360 Src1Name = getRegName(MI->getOperand(1).getReg());
361 DestName = getRegName(MI->getOperand(0).getReg());
363 case X86::VSHUFPSYrri:
364 Src2Name = getRegName(MI->getOperand(2).getReg());
366 case X86::VSHUFPSYrmi:
367 DecodeSHUFPMask(MVT::v8f32, MI->getOperand(MI->getNumOperands()-1).getImm(),
369 Src1Name = getRegName(MI->getOperand(1).getReg());
370 DestName = getRegName(MI->getOperand(0).getReg());
373 case X86::UNPCKLPDrr:
374 Src2Name = getRegName(MI->getOperand(2).getReg());
376 case X86::UNPCKLPDrm:
377 DecodeUNPCKLMask(MVT::v2f64, ShuffleMask);
378 Src1Name = getRegName(MI->getOperand(0).getReg());
380 case X86::VUNPCKLPDrr:
381 Src2Name = getRegName(MI->getOperand(2).getReg());
383 case X86::VUNPCKLPDrm:
384 DecodeUNPCKLMask(MVT::v2f64, ShuffleMask);
385 Src1Name = getRegName(MI->getOperand(1).getReg());
386 DestName = getRegName(MI->getOperand(0).getReg());
388 case X86::VUNPCKLPDYrr:
389 Src2Name = getRegName(MI->getOperand(2).getReg());
391 case X86::VUNPCKLPDYrm:
392 DecodeUNPCKLMask(MVT::v4f64, ShuffleMask);
393 Src1Name = getRegName(MI->getOperand(1).getReg());
394 DestName = getRegName(MI->getOperand(0).getReg());
396 case X86::UNPCKLPSrr:
397 Src2Name = getRegName(MI->getOperand(2).getReg());
399 case X86::UNPCKLPSrm:
400 DecodeUNPCKLMask(MVT::v4f32, ShuffleMask);
401 Src1Name = getRegName(MI->getOperand(0).getReg());
403 case X86::VUNPCKLPSrr:
404 Src2Name = getRegName(MI->getOperand(2).getReg());
406 case X86::VUNPCKLPSrm:
407 DecodeUNPCKLMask(MVT::v4f32, ShuffleMask);
408 Src1Name = getRegName(MI->getOperand(1).getReg());
409 DestName = getRegName(MI->getOperand(0).getReg());
411 case X86::VUNPCKLPSYrr:
412 Src2Name = getRegName(MI->getOperand(2).getReg());
414 case X86::VUNPCKLPSYrm:
415 DecodeUNPCKLMask(MVT::v8f32, ShuffleMask);
416 Src1Name = getRegName(MI->getOperand(1).getReg());
417 DestName = getRegName(MI->getOperand(0).getReg());
419 case X86::UNPCKHPDrr:
420 Src2Name = getRegName(MI->getOperand(2).getReg());
422 case X86::UNPCKHPDrm:
423 DecodeUNPCKHMask(MVT::v2f64, ShuffleMask);
424 Src1Name = getRegName(MI->getOperand(0).getReg());
426 case X86::VUNPCKHPDrr:
427 Src2Name = getRegName(MI->getOperand(2).getReg());
429 case X86::VUNPCKHPDrm:
430 DecodeUNPCKHMask(MVT::v2f64, ShuffleMask);
431 Src1Name = getRegName(MI->getOperand(1).getReg());
432 DestName = getRegName(MI->getOperand(0).getReg());
434 case X86::VUNPCKHPDYrr:
435 Src2Name = getRegName(MI->getOperand(2).getReg());
437 case X86::VUNPCKHPDYrm:
438 DecodeUNPCKHMask(MVT::v4f64, ShuffleMask);
439 Src1Name = getRegName(MI->getOperand(1).getReg());
440 DestName = getRegName(MI->getOperand(0).getReg());
442 case X86::UNPCKHPSrr:
443 Src2Name = getRegName(MI->getOperand(2).getReg());
445 case X86::UNPCKHPSrm:
446 DecodeUNPCKHMask(MVT::v4f32, ShuffleMask);
447 Src1Name = getRegName(MI->getOperand(0).getReg());
449 case X86::VUNPCKHPSrr:
450 Src2Name = getRegName(MI->getOperand(2).getReg());
452 case X86::VUNPCKHPSrm:
453 DecodeUNPCKHMask(MVT::v4f32, ShuffleMask);
454 Src1Name = getRegName(MI->getOperand(1).getReg());
455 DestName = getRegName(MI->getOperand(0).getReg());
457 case X86::VUNPCKHPSYrr:
458 Src2Name = getRegName(MI->getOperand(2).getReg());
460 case X86::VUNPCKHPSYrm:
461 DecodeUNPCKHMask(MVT::v8f32, ShuffleMask);
462 Src1Name = getRegName(MI->getOperand(1).getReg());
463 DestName = getRegName(MI->getOperand(0).getReg());
465 case X86::VPERMILPSri:
466 Src1Name = getRegName(MI->getOperand(1).getReg());
468 case X86::VPERMILPSmi:
469 DecodePSHUFMask(MVT::v4f32, MI->getOperand(MI->getNumOperands()-1).getImm(),
471 DestName = getRegName(MI->getOperand(0).getReg());
473 case X86::VPERMILPSYri:
474 Src1Name = getRegName(MI->getOperand(1).getReg());
476 case X86::VPERMILPSYmi:
477 DecodePSHUFMask(MVT::v8f32, MI->getOperand(MI->getNumOperands()-1).getImm(),
479 DestName = getRegName(MI->getOperand(0).getReg());
481 case X86::VPERMILPDri:
482 Src1Name = getRegName(MI->getOperand(1).getReg());
484 case X86::VPERMILPDmi:
485 DecodePSHUFMask(MVT::v2f64, MI->getOperand(MI->getNumOperands()-1).getImm(),
487 DestName = getRegName(MI->getOperand(0).getReg());
489 case X86::VPERMILPDYri:
490 Src1Name = getRegName(MI->getOperand(1).getReg());
492 case X86::VPERMILPDYmi:
493 DecodePSHUFMask(MVT::v4f64, MI->getOperand(MI->getNumOperands()-1).getImm(),
495 DestName = getRegName(MI->getOperand(0).getReg());
497 case X86::VPERM2F128rr:
498 case X86::VPERM2I128rr:
499 Src2Name = getRegName(MI->getOperand(2).getReg());
501 case X86::VPERM2F128rm:
502 case X86::VPERM2I128rm:
503 // For instruction comments purpose, assume the 256-bit vector is v4i64.
504 DecodeVPERM2X128Mask(MVT::v4i64,
505 MI->getOperand(MI->getNumOperands()-1).getImm(),
507 Src1Name = getRegName(MI->getOperand(1).getReg());
508 DestName = getRegName(MI->getOperand(0).getReg());
513 // If this was a shuffle operation, print the shuffle mask.
514 if (!ShuffleMask.empty()) {
515 if (DestName == 0) DestName = Src1Name;
516 OS << (DestName ? DestName : "mem") << " = ";
518 // If the two sources are the same, canonicalize the input elements to be
519 // from the first src so that we get larger element spans.
520 if (Src1Name == Src2Name) {
521 for (unsigned i = 0, e = ShuffleMask.size(); i != e; ++i) {
522 if ((int)ShuffleMask[i] >= 0 && // Not sentinel.
523 ShuffleMask[i] >= (int)e) // From second mask.
528 // The shuffle mask specifies which elements of the src1/src2 fill in the
529 // destination, with a few sentinel values. Loop through and print them
531 for (unsigned i = 0, e = ShuffleMask.size(); i != e; ++i) {
534 if (ShuffleMask[i] == SM_SentinelZero) {
539 // Otherwise, it must come from src1 or src2. Print the span of elements
540 // that comes from this src.
541 bool isSrc1 = ShuffleMask[i] < (int)ShuffleMask.size();
542 const char *SrcName = isSrc1 ? Src1Name : Src2Name;
543 OS << (SrcName ? SrcName : "mem") << '[';
546 (int)ShuffleMask[i] >= 0 &&
547 (ShuffleMask[i] < (int)ShuffleMask.size()) == isSrc1) {
552 OS << ShuffleMask[i] % ShuffleMask.size();
556 --i; // For loop increments element #.