aboutsummaryrefslogtreecommitdiffstats
path: root/include/llvm/Support/ManagedStatic.h
blob: c1ff0fef935f9499d0c8db0c7883d621ae194fb8 (plain)
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
//===-- llvm/Support/ManagedStatic.h - Static Global wrapper ----*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file defines the ManagedStatic class and the llvm_shutdown() function.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_SUPPORT_MANAGED_STATIC_H
#define LLVM_SUPPORT_MANAGED_STATIC_H

#include "llvm/System/Atomic.h"

namespace llvm {

/// object_deleter - Helper method for ManagedStatic.
///
template<class C>
void object_deleter(void *Ptr) {
  delete (C*)Ptr;
}

/// ManagedStaticBase - Common base class for ManagedStatic instances.
class ManagedStaticBase {
protected:
  mutable sys::cas_flag InitFlag;
  
  // This should only be used as a static variable, which guarantees that this
  // will be zero initialized.
  mutable void *Ptr;
  mutable void (*DeleterFn)(void*);
  mutable const ManagedStaticBase *Next;

  void RegisterManagedStatic(void *ObjPtr, void (*deleter)(void*)) const;
public:
  /// isConstructed - Return true if this object has not been created yet.
  bool isConstructed() const { return Ptr != 0; }

  void destroy() const;
};

/// ManagedStatic - This transparently changes the behavior of global statics to
/// be lazily constructed on demand (good for reducing startup times of dynamic
/// libraries that link in LLVM components) and for making destruction be
/// explicit through the llvm_shutdown() function call.
///
template<class C>
class ManagedStatic : public ManagedStaticBase {
public:

  // Accessors.
  C &operator*() {
    sys::cas_flag OldFlag = sys::CompareAndSwap(&InitFlag, 1, 0);
    if (OldFlag == 0) {
      LazyInit();
      sys::MemoryFence();
      InitFlag = 2;
    } else if (OldFlag == 1)
      while (OldFlag == 1) ;
      
    return *static_cast<C*>(Ptr);
  }
  C *operator->() {
    sys::cas_flag OldFlag = sys::CompareAndSwap(&InitFlag, 1, 0);
    if (OldFlag == 0) {
      LazyInit();
      sys::MemoryFence();
      InitFlag = 2;
    } else if (OldFlag == 1)
      while (OldFlag == 1) ;
    
    return static_cast<C*>(Ptr);
  }
  const C &operator*() const {
    sys::cas_flag OldFlag = sys::CompareAndSwap(&InitFlag, 1, 0);
    if (OldFlag == 0) {
      LazyInit();
      sys::MemoryFence();
      InitFlag = 2;
    } else if (OldFlag == 1)
      while (InitFlag == 1) ;
    
    return *static_cast<C*>(Ptr);
  }
  const C *operator->() const {
    sys::cas_flag OldFlag = sys::CompareAndSwap(&InitFlag, 1, 0);
    if (OldFlag == 0) {
      LazyInit();
      sys::MemoryFence();
      InitFlag = 2;
    } else if (OldFlag == 1)
      while (OldFlag == 1) ;
    
    return static_cast<C*>(Ptr);
  }

public:
  void LazyInit() const {
    RegisterManagedStatic(new C(), object_deleter<C>);
  }
};

template<void (*CleanupFn)(void*)>
class ManagedCleanup : public ManagedStaticBase {
public:
  void Register() { RegisterManagedStatic(0, CleanupFn); }
};


/// llvm_shutdown - Deallocate and destroy all ManagedStatic variables.
void llvm_shutdown();


/// llvm_shutdown_obj - This is a simple helper class that calls
/// llvm_shutdown() when it is destroyed.
struct llvm_shutdown_obj {
  llvm_shutdown_obj() {}
  ~llvm_shutdown_obj() { llvm_shutdown(); }
};

}

#endif