[ORC] Add std::tuple support to SimplePackedSerialization.
[llvm-project.git] / llvm / lib / Target / PowerPC / README.txt
blob492eb22af2c05bac16c49603e0fdbec46f57f0f4
1 //===- README.txt - Notes for improving PowerPC-specific code gen ---------===//
3 TODO:
4 * lmw/stmw pass a la arm load store optimizer for prolog/epilog
6 ===-------------------------------------------------------------------------===
8 This code:
10 unsigned add32carry(unsigned sum, unsigned x) {
11  unsigned z = sum + x;
12  if (sum + x < x)
13      z++;
14  return z;
17 Should compile to something like:
19         addc r3,r3,r4
20         addze r3,r3
22 instead we get:
24         add r3, r4, r3
25         cmplw cr7, r3, r4
26         mfcr r4 ; 1
27         rlwinm r4, r4, 29, 31, 31
28         add r3, r3, r4
30 Ick.
32 ===-------------------------------------------------------------------------===
34 We compile the hottest inner loop of viterbi to:
36         li r6, 0
37         b LBB1_84       ;bb432.i
38 LBB1_83:        ;bb420.i
39         lbzx r8, r5, r7
40         addi r6, r7, 1
41         stbx r8, r4, r7
42 LBB1_84:        ;bb432.i
43         mr r7, r6
44         cmplwi cr0, r7, 143
45         bne cr0, LBB1_83        ;bb420.i
47 The CBE manages to produce:
49         li r0, 143
50         mtctr r0
51 loop:
52         lbzx r2, r2, r11
53         stbx r0, r2, r9
54         addi r2, r2, 1
55         bdz later
56         b loop
58 This could be much better (bdnz instead of bdz) but it still beats us.  If we
59 produced this with bdnz, the loop would be a single dispatch group.
61 ===-------------------------------------------------------------------------===
63 Lump the constant pool for each function into ONE pic object, and reference
64 pieces of it as offsets from the start.  For functions like this (contrived
65 to have lots of constants obviously):
67 double X(double Y) { return (Y*1.23 + 4.512)*2.34 + 14.38; }
69 We generate:
71 _X:
72         lis r2, ha16(.CPI_X_0)
73         lfd f0, lo16(.CPI_X_0)(r2)
74         lis r2, ha16(.CPI_X_1)
75         lfd f2, lo16(.CPI_X_1)(r2)
76         fmadd f0, f1, f0, f2
77         lis r2, ha16(.CPI_X_2)
78         lfd f1, lo16(.CPI_X_2)(r2)
79         lis r2, ha16(.CPI_X_3)
80         lfd f2, lo16(.CPI_X_3)(r2)
81         fmadd f1, f0, f1, f2
82         blr
84 It would be better to materialize .CPI_X into a register, then use immediates
85 off of the register to avoid the lis's.  This is even more important in PIC 
86 mode.
88 Note that this (and the static variable version) is discussed here for GCC:
89 http://gcc.gnu.org/ml/gcc-patches/2006-02/msg00133.html
91 Here's another example (the sgn function):
92 double testf(double a) {
93        return a == 0.0 ? 0.0 : (a > 0.0 ? 1.0 : -1.0);
96 it produces a BB like this:
97 LBB1_1: ; cond_true
98         lis r2, ha16(LCPI1_0)
99         lfs f0, lo16(LCPI1_0)(r2)
100         lis r2, ha16(LCPI1_1)
101         lis r3, ha16(LCPI1_2)
102         lfs f2, lo16(LCPI1_2)(r3)
103         lfs f3, lo16(LCPI1_1)(r2)
104         fsub f0, f0, f1
105         fsel f1, f0, f2, f3
106         blr 
108 ===-------------------------------------------------------------------------===
110 PIC Code Gen IPO optimization:
112 Squish small scalar globals together into a single global struct, allowing the 
113 address of the struct to be CSE'd, avoiding PIC accesses (also reduces the size
114 of the GOT on targets with one).
116 Note that this is discussed here for GCC:
117 http://gcc.gnu.org/ml/gcc-patches/2006-02/msg00133.html
119 ===-------------------------------------------------------------------------===
121 Fold add and sub with constant into non-extern, non-weak addresses so this:
123 static int a;
124 void bar(int b) { a = b; }
125 void foo(unsigned char *c) {
126   *c = a;
129 So that 
131 _foo:
132         lis r2, ha16(_a)
133         la r2, lo16(_a)(r2)
134         lbz r2, 3(r2)
135         stb r2, 0(r3)
136         blr
138 Becomes
140 _foo:
141         lis r2, ha16(_a+3)
142         lbz r2, lo16(_a+3)(r2)
143         stb r2, 0(r3)
144         blr
146 ===-------------------------------------------------------------------------===
148 We should compile these two functions to the same thing:
150 #include <stdlib.h>
151 void f(int a, int b, int *P) {
152   *P = (a-b)>=0?(a-b):(b-a);
154 void g(int a, int b, int *P) {
155   *P = abs(a-b);
158 Further, they should compile to something better than:
161         subf r2, r4, r3
162         subfic r3, r2, 0
163         cmpwi cr0, r2, -1
164         bgt cr0, LBB2_2 ; entry
165 LBB2_1: ; entry
166         mr r2, r3
167 LBB2_2: ; entry
168         stw r2, 0(r5)
169         blr
171 GCC produces:
174         subf r4,r4,r3
175         srawi r2,r4,31
176         xor r0,r2,r4
177         subf r0,r2,r0
178         stw r0,0(r5)
179         blr
181 ... which is much nicer.
183 This theoretically may help improve twolf slightly (used in dimbox.c:142?).
185 ===-------------------------------------------------------------------------===
187 PR5945: This: 
188 define i32 @clamp0g(i32 %a) {
189 entry:
190         %cmp = icmp slt i32 %a, 0
191         %sel = select i1 %cmp, i32 0, i32 %a
192         ret i32 %sel
195 Is compile to this with the PowerPC (32-bit) backend:
197 _clamp0g:
198         cmpwi cr0, r3, 0
199         li r2, 0
200         blt cr0, LBB1_2
201 ; %bb.1:                                                    ; %entry
202         mr r2, r3
203 LBB1_2:                                                     ; %entry
204         mr r3, r2
205         blr
207 This could be reduced to the much simpler:
209 _clamp0g:
210         srawi r2, r3, 31
211         andc r3, r3, r2
212         blr
214 ===-------------------------------------------------------------------------===
216 int foo(int N, int ***W, int **TK, int X) {
217   int t, i;
218   
219   for (t = 0; t < N; ++t)
220     for (i = 0; i < 4; ++i)
221       W[t / X][i][t % X] = TK[i][t];
222       
223   return 5;
226 We generate relatively atrocious code for this loop compared to gcc.
228 We could also strength reduce the rem and the div:
229 http://www.lcs.mit.edu/pubs/pdf/MIT-LCS-TM-600.pdf
231 ===-------------------------------------------------------------------------===
233 We generate ugly code for this:
235 void func(unsigned int *ret, float dx, float dy, float dz, float dw) {
236   unsigned code = 0;
237   if(dx < -dw) code |= 1;
238   if(dx > dw)  code |= 2;
239   if(dy < -dw) code |= 4;
240   if(dy > dw)  code |= 8;
241   if(dz < -dw) code |= 16;
242   if(dz > dw)  code |= 32;
243   *ret = code;
246 ===-------------------------------------------------------------------------===
248 %struct.B = type { i8, [3 x i8] }
250 define void @bar(%struct.B* %b) {
251 entry:
252         %tmp = bitcast %struct.B* %b to i32*              ; <uint*> [#uses=1]
253         %tmp = load i32* %tmp          ; <uint> [#uses=1]
254         %tmp3 = bitcast %struct.B* %b to i32*             ; <uint*> [#uses=1]
255         %tmp4 = load i32* %tmp3                ; <uint> [#uses=1]
256         %tmp8 = bitcast %struct.B* %b to i32*             ; <uint*> [#uses=2]
257         %tmp9 = load i32* %tmp8                ; <uint> [#uses=1]
258         %tmp4.mask17 = shl i32 %tmp4, i8 1          ; <uint> [#uses=1]
259         %tmp1415 = and i32 %tmp4.mask17, 2147483648            ; <uint> [#uses=1]
260         %tmp.masked = and i32 %tmp, 2147483648         ; <uint> [#uses=1]
261         %tmp11 = or i32 %tmp1415, %tmp.masked          ; <uint> [#uses=1]
262         %tmp12 = and i32 %tmp9, 2147483647             ; <uint> [#uses=1]
263         %tmp13 = or i32 %tmp12, %tmp11         ; <uint> [#uses=1]
264         store i32 %tmp13, i32* %tmp8
265         ret void
268 We emit:
270 _foo:
271         lwz r2, 0(r3)
272         slwi r4, r2, 1
273         or r4, r4, r2
274         rlwimi r2, r4, 0, 0, 0
275         stw r2, 0(r3)
276         blr
278 We could collapse a bunch of those ORs and ANDs and generate the following
279 equivalent code:
281 _foo:
282         lwz r2, 0(r3)
283         rlwinm r4, r2, 1, 0, 0
284         or r2, r2, r4
285         stw r2, 0(r3)
286         blr
288 ===-------------------------------------------------------------------------===
290 Consider a function like this:
292 float foo(float X) { return X + 1234.4123f; }
294 The FP constant ends up in the constant pool, so we need to get the LR register.
295  This ends up producing code like this:
297 _foo:
298 .LBB_foo_0:     ; entry
299         mflr r11
300 ***     stw r11, 8(r1)
301         bl "L00000$pb"
302 "L00000$pb":
303         mflr r2
304         addis r2, r2, ha16(.CPI_foo_0-"L00000$pb")
305         lfs f0, lo16(.CPI_foo_0-"L00000$pb")(r2)
306         fadds f1, f1, f0
307 ***     lwz r11, 8(r1)
308         mtlr r11
309         blr
311 This is functional, but there is no reason to spill the LR register all the way
312 to the stack (the two marked instrs): spilling it to a GPR is quite enough.
314 Implementing this will require some codegen improvements.  Nate writes:
316 "So basically what we need to support the "no stack frame save and restore" is a
317 generalization of the LR optimization to "callee-save regs".
319 Currently, we have LR marked as a callee-save reg.  The register allocator sees
320 that it's callee save, and spills it directly to the stack.
322 Ideally, something like this would happen:
324 LR would be in a separate register class from the GPRs. The class of LR would be
325 marked "unspillable".  When the register allocator came across an unspillable
326 reg, it would ask "what is the best class to copy this into that I *can* spill"
327 If it gets a class back, which it will in this case (the gprs), it grabs a free
328 register of that class.  If it is then later necessary to spill that reg, so be
331 ===-------------------------------------------------------------------------===
333 We compile this:
334 int test(_Bool X) {
335   return X ? 524288 : 0;
338 to: 
339 _test:
340         cmplwi cr0, r3, 0
341         lis r2, 8
342         li r3, 0
343         beq cr0, LBB1_2 ;entry
344 LBB1_1: ;entry
345         mr r3, r2
346 LBB1_2: ;entry
347         blr 
349 instead of:
350 _test:
351         addic r2,r3,-1
352         subfe r0,r2,r3
353         slwi r3,r0,19
354         blr
356 This sort of thing occurs a lot due to globalopt.
358 ===-------------------------------------------------------------------------===
360 We compile:
362 define i32 @bar(i32 %x) nounwind readnone ssp {
363 entry:
364   %0 = icmp eq i32 %x, 0                          ; <i1> [#uses=1]
365   %neg = sext i1 %0 to i32              ; <i32> [#uses=1]
366   ret i32 %neg
371 _bar:
372         cntlzw r2, r3
373         slwi r2, r2, 26
374         srawi r3, r2, 31
375         blr 
377 it would be better to produce:
379 _bar: 
380         addic r3,r3,-1
381         subfe r3,r3,r3
382         blr
384 ===-------------------------------------------------------------------------===
386 We generate horrible ppc code for this:
388 #define N  2000000
389 double   a[N],c[N];
390 void simpleloop() {
391    int j;
392    for (j=0; j<N; j++)
393      c[j] = a[j];
396 LBB1_1: ;bb
397         lfdx f0, r3, r4
398         addi r5, r5, 1                 ;; Extra IV for the exit value compare.
399         stfdx f0, r2, r4
400         addi r4, r4, 8
402         xoris r6, r5, 30               ;; This is due to a large immediate.
403         cmplwi cr0, r6, 33920
404         bne cr0, LBB1_1
406 //===---------------------------------------------------------------------===//
408 This:
409         #include <algorithm>
410         inline std::pair<unsigned, bool> full_add(unsigned a, unsigned b)
411         { return std::make_pair(a + b, a + b < a); }
412         bool no_overflow(unsigned a, unsigned b)
413         { return !full_add(a, b).second; }
415 Should compile to:
417 __Z11no_overflowjj:
418         add r4,r3,r4
419         subfc r3,r3,r4
420         li r3,0
421         adde r3,r3,r3
422         blr
424 (or better) not:
426 __Z11no_overflowjj:
427         add r2, r4, r3
428         cmplw cr7, r2, r3
429         mfcr r2
430         rlwinm r2, r2, 29, 31, 31
431         xori r3, r2, 1
432         blr 
434 //===---------------------------------------------------------------------===//
436 We compile some FP comparisons into an mfcr with two rlwinms and an or.  For
437 example:
438 #include <math.h>
439 int test(double x, double y) { return islessequal(x, y);}
440 int test2(double x, double y) {  return islessgreater(x, y);}
441 int test3(double x, double y) {  return !islessequal(x, y);}
443 Compiles into (all three are similar, but the bits differ):
445 _test:
446         fcmpu cr7, f1, f2
447         mfcr r2
448         rlwinm r3, r2, 29, 31, 31
449         rlwinm r2, r2, 31, 31, 31
450         or r3, r2, r3
451         blr 
453 GCC compiles this into:
455  _test:
456         fcmpu cr7,f1,f2
457         cror 30,28,30
458         mfcr r3
459         rlwinm r3,r3,31,1
460         blr
461         
462 which is more efficient and can use mfocr.  See PR642 for some more context.
464 //===---------------------------------------------------------------------===//
466 void foo(float *data, float d) {
467    long i;
468    for (i = 0; i < 8000; i++)
469       data[i] = d;
471 void foo2(float *data, float d) {
472    long i;
473    data--;
474    for (i = 0; i < 8000; i++) {
475       data[1] = d;
476       data++;
477    }
480 These compile to:
482 _foo:
483         li r2, 0
484 LBB1_1: ; bb
485         addi r4, r2, 4
486         stfsx f1, r3, r2
487         cmplwi cr0, r4, 32000
488         mr r2, r4
489         bne cr0, LBB1_1 ; bb
490         blr 
491 _foo2:
492         li r2, 0
493 LBB2_1: ; bb
494         addi r4, r2, 4
495         stfsx f1, r3, r2
496         cmplwi cr0, r4, 32000
497         mr r2, r4
498         bne cr0, LBB2_1 ; bb
499         blr 
501 The 'mr' could be eliminated to folding the add into the cmp better.
503 //===---------------------------------------------------------------------===//
504 Codegen for the following (low-probability) case deteriorated considerably 
505 when the correctness fixes for unordered comparisons went in (PR 642, 58871).
506 It should be possible to recover the code quality described in the comments.
508 ; RUN: llvm-as < %s | llc -march=ppc32  | grep or | count 3
509 ; This should produce one 'or' or 'cror' instruction per function.
511 ; RUN: llvm-as < %s | llc -march=ppc32  | grep mfcr | count 3
512 ; PR2964
514 define i32 @test(double %x, double %y) nounwind  {
515 entry:
516         %tmp3 = fcmp ole double %x, %y          ; <i1> [#uses=1]
517         %tmp345 = zext i1 %tmp3 to i32          ; <i32> [#uses=1]
518         ret i32 %tmp345
521 define i32 @test2(double %x, double %y) nounwind  {
522 entry:
523         %tmp3 = fcmp one double %x, %y          ; <i1> [#uses=1]
524         %tmp345 = zext i1 %tmp3 to i32          ; <i32> [#uses=1]
525         ret i32 %tmp345
528 define i32 @test3(double %x, double %y) nounwind  {
529 entry:
530         %tmp3 = fcmp ugt double %x, %y          ; <i1> [#uses=1]
531         %tmp34 = zext i1 %tmp3 to i32           ; <i32> [#uses=1]
532         ret i32 %tmp34
535 //===---------------------------------------------------------------------===//
536 for the following code:
538 void foo (float *__restrict__ a, int *__restrict__ b, int n) {
539       a[n] = b[n]  * 2.321;
542 we load b[n] to GPR, then move it VSX register and convert it float. We should 
543 use vsx scalar integer load instructions to avoid direct moves
545 //===----------------------------------------------------------------------===//
546 ; RUN: llvm-as < %s | llc -march=ppc32 | not grep fneg
548 ; This could generate FSEL with appropriate flags (FSEL is not IEEE-safe, and 
549 ; should not be generated except with -enable-finite-only-fp-math or the like).
550 ; With the correctness fixes for PR642 (58871) LowerSELECT_CC would need to
551 ; recognize a more elaborate tree than a simple SETxx.
553 define double @test_FNEG_sel(double %A, double %B, double %C) {
554         %D = fsub double -0.000000e+00, %A               ; <double> [#uses=1]
555         %Cond = fcmp ugt double %D, -0.000000e+00               ; <i1> [#uses=1]
556         %E = select i1 %Cond, double %B, double %C              ; <double> [#uses=1]
557         ret double %E
560 //===----------------------------------------------------------------------===//
561 The save/restore sequence for CR in prolog/epilog is terrible:
562 - Each CR subreg is saved individually, rather than doing one save as a unit.
563 - On Darwin, the save is done after the decrement of SP, which means the offset
564 from SP of the save slot can be too big for a store instruction, which means we
565 need an additional register (currently hacked in 96015+96020; the solution there
566 is correct, but poor).
567 - On SVR4 the same thing can happen, and I don't think saving before the SP
568 decrement is safe on that target, as there is no red zone.  This is currently
569 broken AFAIK, although it's not a target I can exercise.
570 The following demonstrates the problem:
571 extern void bar(char *p);
572 void foo() {
573   char x[100000];
574   bar(x);
575   __asm__("" ::: "cr2");
578 //===-------------------------------------------------------------------------===
579 Naming convention for instruction formats is very haphazard.
580 We have agreed on a naming scheme as follows:
582 <INST_form>{_<OP_type><OP_len>}+
584 Where:
585 INST_form is the instruction format (X-form, etc.)
586 OP_type is the operand type - one of OPC (opcode), RD (register destination),
587                               RS (register source),
588                               RDp (destination register pair),
589                               RSp (source register pair), IM (immediate),
590                               XO (extended opcode)
591 OP_len is the length of the operand in bits
593 VSX register operands would be of length 6 (split across two fields),
594 condition register fields of length 3.
595 We would not need denote reserved fields in names of instruction formats.
597 //===----------------------------------------------------------------------===//
599 Instruction fusion was introduced in ISA 2.06 and more opportunities added in
600 ISA 2.07.  LLVM needs to add infrastructure to recognize fusion opportunities
601 and force instruction pairs to be scheduled together.
603 -----------------------------------------------------------------------------
605 More general handling of any_extend and zero_extend:
607 See https://reviews.llvm.org/D24924#555306