Teuchos_SharedAccessPolicy.hpp

// @HEADER
// *****************************************************************************
//                    Teuchos: Common Tools Package
//
// Copyright 2004 NTESS and the Teuchos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef TEUCHOS_SHARED_ACCESS_POLICY_HPP
#define TEUCHOS_SHARED_ACCESS_POLICY_HPP


#include "Teuchos_ConfigDefs.hpp"


//
// WARNING: This current file is just for iterating on the design of thread
// safety in Teuchos and is not working code yet!
//


namespace Teuchos {


class ThreadLock {
public:
  ThreadLock();
  ~ThreadLock();
  bool try_lock();
  void lock();
  void unlock();
};


template<class T>
class ScopedThreadLock {
public:
  explicit ScopedThreadLock(ThreadLock &lock);
  ~ScopedThreadLock();
};


class SharedAccessPolicy {
public:
  typedef ThreadLock lock_type;
  typedef ScopedThreadLock scoped_lock_type;
  typedef int atomic_integral_type;
  inline static void atomic_set( atomic_integral_type * p,
    const atomic_integral_type v );
  inline static const atomic_integral_type
  atomic_fetch( const atomic_integral_type * p );
  inline static void atomic_increment( atomic_integral_type * p );
  inline static void atomic_decrement( atomic_integral_type * p );
  // ToDo: Define some other basic fetch/increment primatives needed for
  // better performance, for example, for Teuchos::RCPNode.
};


} // namespace Teuchos


#endif /* TEUCHOS_SHARED_ACCESS_POLICY_HPP */