File: unroll-loops.cpp

package info (click to toggle)
llvm-toolchain-17 1%3A17.0.6-22
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,799,624 kB
  • sloc: cpp: 6,428,607; ansic: 1,383,196; asm: 793,408; python: 223,504; objc: 75,364; f90: 60,502; lisp: 33,869; pascal: 15,282; sh: 9,684; perl: 7,453; ml: 4,937; awk: 3,523; makefile: 2,889; javascript: 2,149; xml: 888; fortran: 619; cs: 573
file content (516 lines) | stat: -rw-r--r-- 15,949 bytes parent folder | download | duplicates (11)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
// RUN: %check_clang_tidy %s altera-unroll-loops %t -- -config="{CheckOptions: [{key: "altera-unroll-loops.MaxLoopIterations", value: 50}]}" -header-filter=.*
// RUN: %check_clang_tidy -check-suffix=MULT %s altera-unroll-loops %t -- -config="{CheckOptions: [{key: "altera-unroll-loops.MaxLoopIterations", value: 5}]}" -header-filter=.* "--" -DMULT

#ifdef MULT
// For loops with *= and /= increments.
void for_loop_mult_div_increments(int *A) {
// *=
#pragma unroll
  for (int i = 2; i <= 32; i *= 2)
    A[i]++; // OK

#pragma unroll
  for (int i = 2; i <= 64; i *= 2)
    // CHECK-MESSAGES-MULT: :[[@LINE-1]]:3: warning: loop likely has a large number of iterations and thus cannot be fully unrolled; to partially unroll this loop, use the '#pragma unroll <num>' directive [altera-unroll-loops]
    A[i]++; // Not OK

// /=
#pragma unroll
  for (int i = 32; i >= 2; i /= 2)
    A[i]++; // OK

#pragma unroll
  for (int i = 64; i >= 2; i /= 2)
    // CHECK-MESSAGES-MULT: :[[@LINE-1]]:3: warning: loop likely has a large number of iterations and thus cannot be fully unrolled; to partially unroll this loop, use the '#pragma unroll <num>' directive [altera-unroll-loops]
    A[i]++; // Not OK
}
#else
// Cannot determine loop bounds for while loops.
void while_loops(int *A) {
  // Recommend unrolling loops that aren't already unrolled.
  int j = 0;
  while (j < 2000) {
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: kernel performance could be improved by unrolling this loop with a '#pragma unroll' directive [altera-unroll-loops]
    A[1] += j;
    j++;
  }

  do {
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: kernel performance could be improved by unrolling this loop with a '#pragma unroll' directive [altera-unroll-loops]
    A[2] += j;
    j++;
  } while (j < 2000);

// If a while loop is fully unrolled, add a note recommending partial
// unrolling.
#pragma unroll
  while (j < 2000) {
    // CHECK-MESSAGES: :[[@LINE-1]]:3: note: full unrolling requested, but loop bounds may not be known; to partially unroll this loop, use the '#pragma unroll <num>' directive
    A[j]++;
  }

#pragma unroll
  do {
    // CHECK-MESSAGES: :[[@LINE-1]]:3: note: full unrolling requested, but loop bounds may not be known; to partially unroll this loop, use the '#pragma unroll <num>' directive
    A[j]++;
  } while (j < 2000);

// While loop is partially unrolled, no action needed.
#pragma unroll 4
  while (j < 2000) {
    A[j]++;
  }

#pragma unroll 4
  do {
    A[j]++;
  } while (j < 2000);
}

// Range-based for loops.
void cxx_for_loops(int *A, int vectorSize) {
  // Loop with known array size should be unrolled.
  int a[] = {0, 1, 2, 3, 4, 5};
  for (int k : a) {
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: kernel performance could be improved by unrolling this loop with a '#pragma unroll' directive [altera-unroll-loops]
    A[k]++;
  }

// Loop with known size correctly unrolled.
#pragma unroll
  for (int k : a) {
    A[k]++;
  }

  // Loop with unknown size should be partially unrolled.
  int b[vectorSize];
#pragma unroll
  for (int k : b) {
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: full unrolling requested, but loop bounds are not known; to partially unroll this loop, use the '#pragma unroll <num>' directive [altera-unroll-loops]
    k++;
  }

// Loop with unknown size correctly unrolled.
#pragma unroll 5
  for (int k : b) {
    k++;
  }

  // Loop with large size should be partially unrolled.
  int c[51];
#pragma unroll
  for (int k : c) {
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: loop likely has a large number of iterations and thus cannot be fully unrolled; to partially unroll this loop, use the '#pragma unroll <num>' directive [altera-unroll-loops]
    A[k]++;
  }

// Loop with large size correctly unrolled.
#pragma unroll 5
  for (int k : c) {
    A[k]++;
  }
}

// Simple for loops.
void for_loops(int *A, int size) {
  // Recommend unrolling loops that aren't already unrolled.
  for (int i = 0; i < 2000; ++i) {
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: kernel performance could be improved by unrolling this loop with a '#pragma unroll' directive [altera-unroll-loops]
    A[0] += i;
  }

// Loop with known size correctly unrolled.
#pragma unroll
  for (int i = 0; i < 50; ++i) {
    A[i]++;
  }

// Loop with unknown size should be partially unrolled.
#pragma unroll
  for (int i = 0; i < size; ++i) {
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: full unrolling requested, but loop bounds are not known; to partially unroll this loop, use the '#pragma unroll <num>' directive [altera-unroll-loops]
    A[i]++;
  }

#pragma unroll
  for (;;) {
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: full unrolling requested, but loop bounds are not known; to partially unroll this loop, use the '#pragma unroll <num>' directive [altera-unroll-loops]
    A[0]++;
  }

  int i = 0;
#pragma unroll
  for (; i < size; ++i) {
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: full unrolling requested, but loop bounds are not known; to partially unroll this loop, use the '#pragma unroll <num>' directive [altera-unroll-loops]
    A[i]++;
  }

#pragma unroll
  for (int i = 0;; ++i) {
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: full unrolling requested, but loop bounds are not known; to partially unroll this loop, use the '#pragma unroll <num>' directive [altera-unroll-loops]
    A[i]++;
  }

#pragma unroll
  for (int i = 0; i < size;) {
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: full unrolling requested, but loop bounds are not known; to partially unroll this loop, use the '#pragma unroll <num>' directive [altera-unroll-loops]
    A[i]++;
  }

#pragma unroll
  for (int i = size; i < 50; ++i) {
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: full unrolling requested, but loop bounds are not known; to partially unroll this loop, use the '#pragma unroll <num>' directive [altera-unroll-loops]
    A[i]++;
  }

#pragma unroll
  for (int i = 0; true; ++i) {
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: full unrolling requested, but loop bounds are not known; to partially unroll this loop, use the '#pragma unroll <num>' directive [altera-unroll-loops]
    A[i]++;
  }

#pragma unroll
  for (int i = 0; i == i; ++i) {
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: full unrolling requested, but loop bounds are not known; to partially unroll this loop, use the '#pragma unroll <num>' directive [altera-unroll-loops]
    A[i]++;
  }

// Loop with unknown size correctly unrolled.
#pragma unroll 5
  for (int i = 0; i < size; ++i) {
    A[i]++;
  }

// Loop with large size should be partially unrolled.
#pragma unroll
  for (int i = 0; i < 51; ++i) {
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: loop likely has a large number of iterations and thus cannot be fully unrolled; to partially unroll this loop, use the '#pragma unroll <num>' directive [altera-unroll-loops]
    A[i]++;
  }

// Loop with large size correctly unrolled.
#pragma unroll 5
  for (int i = 0; i < 51; ++i) {
    A[i]++;
  }
}

// For loops with different increments.
void for_loop_increments(int *A) {
// ++
#pragma unroll
  for (int i = 0; i < 50; ++i)
    A[i]++; // OK

#pragma unroll
  for (int i = 0; i < 51; ++i)
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: loop likely has a large number of iterations and thus cannot be fully unrolled; to partially unroll this loop, use the '#pragma unroll <num>' directive [altera-unroll-loops]
    A[i]++; // Not OK

// --
#pragma unroll
  for (int i = 50; i > 0; --i)
    A[i]++; // OK

#pragma unroll
  for (int i = 51; i > 0; --i)
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: loop likely has a large number of iterations and thus cannot be fully unrolled; to partially unroll this loop, use the '#pragma unroll <num>' directive [altera-unroll-loops]
    A[i]++; // Not OK

// +=
#pragma unroll
  for (int i = 0; i < 100; i += 2)
    A[i]++; // OK

#pragma unroll
  for (int i = 0; i < 101; i += 2)
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: loop likely has a large number of iterations and thus cannot be fully unrolled; to partially unroll this loop, use the '#pragma unroll <num>' directive [altera-unroll-loops]
    A[i]++; // Not OK

// -=
#pragma unroll
  for (int i = 100; i > 0; i -= 2)
    A[i]++; // OK

#pragma unroll
  for (int i = 101; i > 0; i -= 2)
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: loop likely has a large number of iterations and thus cannot be fully unrolled; to partially unroll this loop, use the '#pragma unroll <num>' directive [altera-unroll-loops]
    A[i]++; // Not OK
}

// Inner loops should be unrolled.
void nested_simple_loops(int *A) {
  for (int i = 0; i < 1000; ++i) {
    for (int j = 0; j < 2000; ++j) {
      // CHECK-MESSAGES: :[[@LINE-1]]:5: warning: kernel performance could be improved by unrolling this loop with a '#pragma unroll' directive [altera-unroll-loops]
      A[0] += i + j;
    }
  }

  for (int i = 0; i < 1000; ++i) {
    int j = 0;
    while (j < 2000) {
      // CHECK-MESSAGES: :[[@LINE-1]]:5: warning: kernel performance could be improved by unrolling this loop with a '#pragma unroll' directive [altera-unroll-loops]
      A[1] += i + j;
      j++;
    }
  }

  for (int i = 0; i < 1000; ++i) {
    int j = 0;
    do {
      // CHECK-MESSAGES: :[[@LINE-1]]:5: warning: kernel performance could be improved by unrolling this loop with a '#pragma unroll' directive [altera-unroll-loops]
      A[2] += i + j;
      j++;
    } while (j < 2000);
  }

  int i = 0;
  while (i < 1000) {
    for (int j = 0; j < 2000; ++j) {
      // CHECK-MESSAGES: :[[@LINE-1]]:5: warning: kernel performance could be improved by unrolling this loop with a '#pragma unroll' directive [altera-unroll-loops]
      A[3] += i + j;
    }
    i++;
  }

  i = 0;
  while (i < 1000) {
    int j = 0;
    while (j < 2000) {
      // CHECK-MESSAGES: :[[@LINE-1]]:5: warning: kernel performance could be improved by unrolling this loop with a '#pragma unroll' directive [altera-unroll-loops]
      A[4] += i + j;
      j++;
    }
    i++;
  }

  i = 0;
  while (i < 1000) {
    int j = 0;
    do {
      // CHECK-MESSAGES: :[[@LINE-1]]:5: warning: kernel performance could be improved by unrolling this loop with a '#pragma unroll' directive [altera-unroll-loops]
      A[5] += i + j;
      j++;
    } while (j < 2000);
    i++;
  }

  i = 0;
  do {
    for (int j = 0; j < 2000; ++j) {
      // CHECK-MESSAGES: :[[@LINE-1]]:5: warning: kernel performance could be improved by unrolling this loop with a '#pragma unroll' directive [altera-unroll-loops]
      A[6] += i + j;
    }
    i++;
  } while (i < 1000);

  i = 0;
  do {
    int j = 0;
    while (j < 2000) {
      // CHECK-MESSAGES: :[[@LINE-1]]:5: warning: kernel performance could be improved by unrolling this loop with a '#pragma unroll' directive [altera-unroll-loops]
      A[7] += i + j;
      j++;
    }
    i++;
  } while (i < 1000);

  i = 0;
  do {
    int j = 0;
    do {
      // CHECK-MESSAGES: :[[@LINE-1]]:5: warning: kernel performance could be improved by unrolling this loop with a '#pragma unroll' directive [altera-unroll-loops]
      A[8] += i + j;
      j++;
    } while (j < 2000);
    i++;
  } while (i < 1000);

  for (int i = 0; i < 100; ++i) {
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: kernel performance could be improved by unrolling this loop with a '#pragma unroll' directive [altera-unroll-loops]
    A[i]++;
  }

  i = 0;
  while (i < 100) {
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: kernel performance could be improved by unrolling this loop with a '#pragma unroll' directive [altera-unroll-loops]
    i++;
  }

  i = 0;
  do {
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: kernel performance could be improved by unrolling this loop with a '#pragma unroll' directive [altera-unroll-loops]
    i++;
  } while (i < 100);
}

// These loops are all correctly unrolled.
void unrolled_nested_simple_loops(int *A) {
  for (int i = 0; i < 1000; ++i) {
#pragma unroll
    for (int j = 0; j < 50; ++j) {
      A[0] += i + j;
    }
  }

  for (int i = 0; i < 1000; ++i) {
    int j = 0;
#pragma unroll 5
    while (j < 50) {
      A[1] += i + j;
      j++;
    }
  }

  for (int i = 0; i < 1000; ++i) {
    int j = 0;
#pragma unroll 5
    do {
      A[2] += i + j;
      j++;
    } while (j < 50);
  }

  int i = 0;
  while (i < 1000) {
#pragma unroll
    for (int j = 0; j < 50; ++j) {
      A[3] += i + j;
    }
    i++;
  }

  i = 0;
  while (i < 1000) {
    int j = 0;
#pragma unroll 5
    while (50 > j) {
      A[4] += i + j;
      j++;
    }
    i++;
  }

  i = 0;
  while (1000 > i) {
    int j = 0;
#pragma unroll 5
    do {
      A[5] += i + j;
      j++;
    } while (j < 50);
    i++;
  }

  i = 0;
  do {
#pragma unroll
    for (int j = 0; j < 50; ++j) {
      A[6] += i + j;
    }
    i++;
  } while (i < 1000);

  i = 0;
  do {
    int j = 0;
#pragma unroll 5
    while (j < 50) {
      A[7] += i + j;
      j++;
    }
    i++;
  } while (i < 1000);

  i = 0;
  do {
    int j = 0;
#pragma unroll 5
    do {
      A[8] += i + j;
      j++;
    } while (j < 50);
    i++;
  } while (i < 1000);
}

// These inner loops are large and should be partially unrolled.
void unrolled_nested_simple_loops_large_num_iterations(int *A) {
  for (int i = 0; i < 1000; ++i) {
#pragma unroll
    for (int j = 0; j < 51; ++j) {
      // CHECK-MESSAGES: :[[@LINE-1]]:5: warning: loop likely has a large number of iterations and thus cannot be fully unrolled; to partially unroll this loop, use the '#pragma unroll <num>' directive [altera-unroll-loops]
      A[0] += i + j;
    }
  }

  int i = 0;
  while (i < 1000) {
#pragma unroll
    for (int j = 0; j < 51; ++j) {
      // CHECK-MESSAGES: :[[@LINE-1]]:5: warning: loop likely has a large number of iterations and thus cannot be fully unrolled; to partially unroll this loop, use the '#pragma unroll <num>' directive [altera-unroll-loops]
      A[3] += i + j;
    }
    i++;
  }

  i = 0;
  do {
#pragma unroll
    for (int j = 0; j < 51; ++j) {
      // CHECK-MESSAGES: :[[@LINE-1]]:5: warning: loop likely has a large number of iterations and thus cannot be fully unrolled; to partially unroll this loop, use the '#pragma unroll <num>' directive [altera-unroll-loops]
      A[6] += i + j;
    }
    i++;
  } while (i < 1000);

  i = 0;
  do {
    int j = 0;
#pragma unroll
    do {
      // CHECK-MESSAGES: :[[@LINE-1]]:5: note: full unrolling requested, but loop bounds may not be known; to partially unroll this loop, use the '#pragma unroll <num>' directive
      A[8] += i + j;
      j++;
    } while (j < 51);
    i++;
  } while (i < 1000);

  i = 0;
  int a[51];
  do {
#pragma unroll
    for (int k : a) {
      // CHECK-MESSAGES: :[[@LINE-1]]:5: warning: loop likely has a large number of iterations and thus cannot be fully unrolled; to partially unroll this loop, use the '#pragma unroll <num>' directive [altera-unroll-loops]
      A[k]++;
    }
  } while (i < 1000);
}

// These loops have unknown bounds and should be partially unrolled.
void fully_unrolled_unknown_bounds(int vectorSize) {
  int someVector[101];

// There is no loop condition
#pragma unroll
  for (;;) {
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: full unrolling requested, but loop bounds are not known; to partially unroll this loop, use the '#pragma unroll <num>' directive [altera-unroll-loops]
    someVector[0]++;
  }

#pragma unroll
  for (int i = 0; 1 < 5; ++i) {
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: full unrolling requested, but loop bounds are not known; to partially unroll this loop, use the '#pragma unroll <num>' directive [altera-unroll-loops]
    someVector[i]++;
  }

// Both sides are value-dependent
#pragma unroll
  for (int i = 0; i < vectorSize; ++i) {
    // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: full unrolling requested, but loop bounds are not known; to partially unroll this loop, use the '#pragma unroll <num>' directive [altera-unroll-loops]
    someVector[i]++;
  }
}
#endif
// There are no fix-its for this check