Files
swift-mirror/include/swift/Basic/ThreadSafeRefCounted.h
Dan Raviv 29d76f3b68 Canonize swift header files headers and footers
- Added missing ifdef guard in PointerIntEnum header
- Consistent naming convention for ifdef guards
- Consistent 'end namespace swift'
- Consistent single EOL at end of header files
2016-03-23 09:04:12 +02:00

77 lines
2.4 KiB
C++

//===--- ThreadSafeRefCounted.h - Thread-safe Refcounting Base --*- C++ -*-===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
#ifndef SWIFT_BASIC_THREADSAFEREFCOUNTED_H
#define SWIFT_BASIC_THREADSAFEREFCOUNTED_H
#include "llvm/Support/Atomic.h"
#include <cassert>
namespace swift {
/// A thread-safe version of \c llvm::RefCountedBase.
///
/// A generic base class for objects that wish to have their lifetimes managed
/// using reference counts. Classes subclass \c ThreadSafeRefCountedBase to
/// obtain such functionality, and are typically handled with
/// \c IntrusiveRefCntPtr "smart pointers" which automatically handle the
/// management of reference counts.
/// FIXME: This should eventually move to llvm.
template <class Derived>
class ThreadSafeRefCountedBase {
mutable llvm::sys::cas_flag ref_cnt;
protected:
ThreadSafeRefCountedBase() : ref_cnt(0) {}
public:
void Retain() const {
llvm::sys::AtomicIncrement(&ref_cnt);
}
void Release() const {
int refCount = static_cast<int>(llvm::sys::AtomicDecrement(&ref_cnt));
assert(refCount >= 0 && "Reference count was already zero.");
if (refCount == 0) delete static_cast<const Derived*>(this);
}
};
/// A class that has the same function as \c ThreadSafeRefCountedBase, but with
/// a virtual destructor.
///
/// Should be used instead of \c ThreadSafeRefCountedBase for classes that
/// already have virtual methods to enforce dynamic allocation via 'new'.
/// FIXME: This should eventually move to llvm.
class ThreadSafeRefCountedBaseVPTR {
mutable llvm::sys::cas_flag ref_cnt;
virtual void anchor();
protected:
ThreadSafeRefCountedBaseVPTR() : ref_cnt(0) {}
virtual ~ThreadSafeRefCountedBaseVPTR() {}
public:
void Retain() const {
llvm::sys::AtomicIncrement(&ref_cnt);
}
void Release() const {
int refCount = static_cast<int>(llvm::sys::AtomicDecrement(&ref_cnt));
assert(refCount >= 0 && "Reference count was already zero.");
if (refCount == 0) delete this;
}
};
} // end namespace swift
#endif // SWIFT_BASIC_THREADSAFEREFCOUNTED_H