File: parallel_atomic_misc.h

package info (click to toggle)
openms 2.6.0%2Bcleaned1-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye
  • size: 783,124 kB
  • sloc: cpp: 526,887; xml: 142,287; ansic: 54,252; python: 11,640; php: 2,454; sh: 1,137; ruby: 529; yacc: 403; perl: 85; lex: 74; makefile: 60
file content (168 lines) | stat: -rw-r--r-- 5,618 bytes parent folder | download | duplicates (6)
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
// ==========================================================================
//                 SeqAn - The Library for Sequence Analysis
// ==========================================================================
// Copyright (c) 2006-2013, 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>
// ==========================================================================
// Misc simple functionality built upon atomic primitives.
// ==========================================================================

// SEQAN_NO_GENERATED_FORWARDS: No forwards are generated for this file.

#ifndef SEQAN_PARALLEL_PARALLEL_ATOMIC_MISC_H_
#define SEQAN_PARALLEL_PARALLEL_ATOMIC_MISC_H_

namespace seqan {

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

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

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

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

// ----------------------------------------------------------------------------
// Function atomicMax()
// ----------------------------------------------------------------------------

/*!
 * @fn atomicMax
 * @headerfile <seqan/parallel.h>
 * @brief Lock-free implemenattion of <tt>x = max(x, y)</tt>.
 *
 * @signature void atomicMax(x, y);
 *
 * @param[in,out] x Integer to set to <tt>max(x, y)</tt>.
 * @param[in]     y Other integer.
 *
 * @section Remarks
 *
 * This is equivalent to
 *
 * @code{.cpp}
 * atomic {
 *     x = max(x, y);
 * }
 * @endcode
 */

/**
.Function.atomicMax
..summary:Lock-free implementation of $x = max(x, y)$.
..cat:Atomic Operations
..signature:atomicMax(x, y)
..param.x:Integer to set to $max(x, y)$
..param.y:Other integer.
..remarks:This is equivalent to
...code:
atomic {
    x = max(x, y);
}
...text:While lock-free, the function tries to update $x$ as long as $x < y$ in a loop and might run a long time if x is incremented continuously in another thread.
..header:seqan/parallel.h
..see:Function.atomicMin
 */

template <typename T>
inline void
atomicMax(T volatile & x, T y)
{
    T val = x;
    while (val < y) {
        T m = _max(val, y);
        val = atomicCas(x, val, m);
    }
}

// ----------------------------------------------------------------------------
// Function atomicMin()
// ----------------------------------------------------------------------------

/*!
 * @fn atomicMin
 * @headerfile <seqan/parallel.h>
 * @brief Lock-free implemenattion of <tt>x = min(x, y)</tt>.
 *
 * @signature void atomicMin(x, y);
 *
 * @param[in,out] x Integer to set to <tt>min(x, y)</tt>.
 * @param[in]     y Other integer.
 *
 * @section Remarks
 *
 * This is equivalent to
 *
 * @code{.cpp}
 * atomic {
 *     x = min(x, y);
 * }
 * @endcode
 */

/**
.Function.atomicMin
..summary:Lock-free implementation of $x = min(x, y)$.
..cat:Atomic Operations
..signature:atomicMin(x, y)
..param.x:Integer to set to min(x, y)$
..param.y:Other integer.
..remarks:This is equivalent to
...code:
atomic {
    x = min(x, y);
}
...text:While lock-free, the function tries to update $x$ as long as $x > y$ in a loop and might run a long time if x is incremented continuously in another thread.
..header:seqan/parallel.h
..see:Function.atomicMax
 */

template <typename T>
inline void
atomicMin(T volatile & x, T y)
{
    T val = x;
    while (val > y) {
        T m = _min(val, y);
        val = atomicCas(x, val, m);
    }
}

} // namespace seqan

#endif  // #define SEQAN_PARALLEL_PARALLEL_ATOMIC_MISC_H_