Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_SharedAccessPolicy.hpp
1 /*
2 // @HEADER
3 // ***********************************************************************
4 //
5 // Teuchos: Common Tools Package
6 // Copyright (2004) Sandia Corporation
7 //
8 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
9 // license for use of this work by or on behalf of the U.S. Government.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
39 //
40 // ***********************************************************************
41 // @HEADER
42 */
43 
44 #ifndef TEUCHOS_SHARED_ACCESS_POLICY_HPP
45 #define TEUCHOS_SHARED_ACCESS_POLICY_HPP
46 
47 
48 #include "Teuchos_ConfigDefs.hpp"
49 
50 
51 //
52 // WARNING: This current file is just for iterating on the design of thread
53 // safety in Teuchos and is not working code yet!
54 //
55 
56 
57 namespace Teuchos {
58 
59 
67 class ThreadLock {
68 public:
70  ThreadLock();
72  ~ThreadLock();
74  bool try_lock();
76  void lock();
78  void unlock();
79 };
80 
81 
90 template<class T>
92 public:
94  explicit ScopedThreadLock(ThreadLock &lock);
97 };
98 
99 
121 public:
127  typedef int atomic_integral_type;
129  inline static void atomic_set( atomic_integral_type * p,
130  const atomic_integral_type v );
132  inline static const atomic_integral_type
133  atomic_fetch( const atomic_integral_type * p );
135  inline static void atomic_increment( atomic_integral_type * p );
137  inline static void atomic_decrement( atomic_integral_type * p );
138  // ToDo: Define some other basic fetch/increment primatives needed for
139  // better performance, for example, for Teuchos::RCPNode.
140 };
141 
142 
143 } // namespace Teuchos
144 
145 
146 #endif /* TEUCHOS_SHARED_ACCESS_POLICY_HPP */
static void atomic_increment(atomic_integral_type *p)
Atomic increment of a shared integral object.
Teuchos header file which uses auto-configuration information to include necessary C++ headers...
Basic portable thread lock primative class.
int atomic_integral_type
Supported type for shared integral objects.
ScopedThreadLock(ThreadLock &lock)
static void atomic_decrement(atomic_integral_type *p)
Atomic decrement of a shared integral object.
static const atomic_integral_type atomic_fetch(const atomic_integral_type *p)
Atomic fetch a shared integral object.
Single policy class defining an approach for sharing an integral object across threads as well as a g...
static void atomic_set(atomic_integral_type *p, const atomic_integral_type v)
Atomic setting a shared integral object.
Stack-based object for locking a thread.