File: omp_wrapper.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 (128 lines) | stat: -rw-r--r-- 4,267 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
// ==========================================================================
//                               omp_wrapper.h
// ==========================================================================
// 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>
// ==========================================================================
// Wrapper code for OpenMP things.  Currently only RAII stuff for locks.
// ==========================================================================

#ifdef _OPENMP
#include <omp.h>
#endif   // #ifdef _OPENMP

#ifndef APPS_MASON2_OMP_WRAPPER_H_
#define APPS_MASON2_OMP_WRAPPER_H_

// ============================================================================
// Forwards
// ============================================================================

// ============================================================================
// Tags, Classes, Enums
// ============================================================================

// ----------------------------------------------------------------------------
// OmpLock
// ----------------------------------------------------------------------------

// A wrapper for OpenMP locks.

class OmpLock
{
public:
    friend class OmpLockGuard;

    OmpLock()
    {
#ifdef _OPENMP
        omp_init_lock(&theLock);
#endif   // #ifdef _OPENMP
    }

    ~OmpLock()
    {
#ifdef _OPENMP
        omp_destroy_lock&(theLock);
#endif   // #ifdef _OPENMP
    }

private:
    void acquire()
    {
#ifdef _OPENMP
        omp_set_lock(&theLock);
#endif   // #ifdef _OPENMP
    }

    void release()
    {
#ifdef _OPENMP
        omp_unset_lock(&theLock);
#endif   // #ifdef _OPENMP
    }

#ifdef _OPENMP
    omp_lock_t theLock;
#endif   // #ifdef _OPENMP
};

// ----------------------------------------------------------------------------
// OmpLockGuard
// ----------------------------------------------------------------------------

// Implement RAII-style locking of OmpLock objects.

class OmpLockGuard
{
public:
    OmpLockGuard(OmpLock & lock) : lock(lock)
    {
        lock.acquire();
    }

    ~OmpLockGuard()
    {
        lock.release();
    }

private:
    OmpLock & lock;
};

// ============================================================================
// Metafunctions
// ============================================================================

// ============================================================================
// Functions
// ============================================================================

#endif  // #ifndef APPS_MASON2_OMP_WRAPPER_H_