[NFC] Trim trailing whitespace in *.rst
[platform/upstream/llvm.git] / openmp / docs / remarks / OMP170.rst
1 .. _omp170:
2
3 OpenMP runtime call <call> deduplicated. [OMP170]
4 ====================================================================
5
6 This optimization remark indicates that a call to an OpenMP runtime call was
7 replaced with the result of an existing one. This occurs when the compiler knows
8 that the result of a runtime call is immutable. Removing duplicate calls is done
9 by replacing all calls to that function with the result of the first call. This
10 cannot be done automatically by the compiler because the implementations of the
11 OpenMP runtime calls live in a separate library the compiler cannot see.
12
13 Example
14 -------
15
16 This optimization will trigger for known OpenMP runtime calls whose return value
17 will not change.
18
19 .. code-block:: c++
20
21   void foo(int N) {
22     double *A = malloc(N * omp_get_thread_limit());
23     double *B = malloc(N * omp_get_thread_limit());
24
25   #pragma omp parallel
26     work(&A[omp_get_thread_num() * N]);
27   #pragma omp parallel
28     work(&B[omp_get_thread_num() * N]);
29   }
30
31 .. code-block:: console
32
33   $ clang -fopenmp -O2 -Rpass=openmp-opt omp170.c
34   ompi170.c:2:26: remark: OpenMP runtime call omp_get_thread_limit deduplicated. [OMP170]
35   double *A = malloc(N * omp_get_thread_limit());
36                          ^
37
38 Diagnostic Scope
39 ----------------
40
41 OpenMP optimization remark.