File: parallel_macros.h

package info (click to toggle)
seqan2 2.5.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 228,748 kB
  • sloc: cpp: 257,602; ansic: 91,967; python: 8,326; sh: 1,056; xml: 570; makefile: 229; awk: 51; javascript: 21
file content (136 lines) | stat: -rw-r--r-- 4,305 bytes parent folder | download
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
// ==========================================================================
//                 SeqAn - The Library for Sequence Analysis
// ==========================================================================
// Copyright (c) 2006-2026, Knut Reinert, FU Berlin
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//     * Neither the name of Knut Reinert or the FU Berlin nor the names of
//       its contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL KNUT REINERT OR THE FU BERLIN BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
// OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
// DAMAGE.
//
// ==========================================================================
// Author: Manuel Holtgrewe <manuel.holtgrewe@fu-berlin.de>
// Author: Enrico Siragusa <enrico.siragusa@fu-berlin.de>
// ==========================================================================
// Utility macros for parallelism.
// ==========================================================================

#ifndef SEQAN_PARALLEL_PARALLEL_MACROS_H_
#define SEQAN_PARALLEL_PARALLEL_MACROS_H_

/*!
 * @macro SEQAN_OMP_PRAGMA
 * @headerfile <seqan/parallel.h>
 * @brief Portable conditional <tt>#pragma</tt> issuing if OpenMP is enabled.
 *
 * @signature SEQAN_OMP_PRAGMA(x)
 *
 * @param x The string to issue behind <tt>#pragma omp</tt>.
 *
 * @section Remarks
 *
 * This macro uses portable pragma generation, dependent on the macro <tt>_OPENMP</tt> being defined (as by
 * the OpenMP standard).
 *
 * This is useful for disabling OpenMP pragmas on compilers that do not support OpenMP or when OpenMP is not enabled to
 * suppress warnings.
 *
 * @section Example
 *
 * Parallelize loop with OpenMP if OpenMP is enabled:
 *
 * @code{.cpp}
 * SEQAN_OMP_PRAGMA(parallel for)  // becomes: #pragma omp parallel for
 * for (int i = 0; i < x; ++i)
 * {
 *     // Do work.
 * }
 * @endcode
 *
 * Make an addition atomic if OpenMP is enabled:
 *
 * @code{.cpp}
 * SEQAN_OMP_PRAGMA(parallel atomic)  // becomes: #pragma omp parallel atomic
 * i += 1;
 * @endcode
 */

#ifdef _OPENMP

#include <omp.h>

#if defined(COMPILER_MSVC) || defined(COMPILER_WINTEL)
  // MSVC __pragma-operator
  #define SEQAN_OMP_PRAGMA(x) __pragma(omp x)
#else
  // GCC _Pragma operator
  #define SEQAN_DO_PRAGMA(x) _Pragma(# x)
  #define SEQAN_OMP_PRAGMA(x) SEQAN_DO_PRAGMA(omp x)
#endif

#else  // #ifdef _OPENMP

#define SEQAN_OMP_PRAGMA(x)

// low-level OpenMP runtime compatibility
inline void omp_set_num_threads(int)
{}

inline int omp_get_num_threads()
{
    return 1;
}

inline int omp_get_max_threads()
{
    return 1;
}

inline int omp_get_thread_num()
{
    return 0;
}

inline double omp_get_wtime()
{
    return seqan2::sysTime();
}

#endif  // #ifdef _OPENMP

// ----------------------------------------------------------------------------
// Function getThreadId()
// ----------------------------------------------------------------------------

inline unsigned getThreadId()
{
#if defined(_OPENMP)
    return omp_get_thread_num();

#else
    return 0;

#endif
}

#endif  // SEQAN_PARALLEL_PARALLEL_MACROS_H_