[llvm-profdata] Add SaturatingAdd/SaturatingMultiply Helper Functions
[oota-llvm.git] / include / llvm / Support / CrashRecoveryContext.h
index 6e975fe3a1cc6dd9cc56bc15953c71f6ab172d8c..1a1c74368761d729c8d60d76260425618388cb24 100644 (file)
 #ifndef LLVM_SUPPORT_CRASHRECOVERYCONTEXT_H
 #define LLVM_SUPPORT_CRASHRECOVERYCONTEXT_H
 
+#include "llvm/ADT/STLExtras.h"
 #include <string>
 
 namespace llvm {
-class StringRef;
-
 class CrashRecoveryContextCleanup;
-  
+
 /// \brief Crash recovery helper object.
 ///
 /// This class implements support for running operations in a safe context so
@@ -40,16 +39,14 @@ class CrashRecoveryContextCleanup;
 ///
 ///      ... no crash was detected ...
 ///    }
-///
-/// Crash recovery contexts may not be nested.
 class CrashRecoveryContext {
   void *Impl;
   CrashRecoveryContextCleanup *head;
 
 public:
-  CrashRecoveryContext() : Impl(0), head(0) {}
+  CrashRecoveryContext() : Impl(nullptr), head(nullptr) {}
   ~CrashRecoveryContext();
-  
+
   void registerCleanup(CrashRecoveryContextCleanup *cleanup);
   void unregisterCleanup(CrashRecoveryContextCleanup *cleanup);
 
@@ -63,6 +60,10 @@ public:
   /// thread which is in a protected context.
   static CrashRecoveryContext *GetCurrent();
 
+  /// \brief Return true if the current thread is recovering from a
+  /// crash.
+  static bool isRecoveringFromCrash();
+
   /// \brief Execute the provide callback function (with the given arguments) in
   /// a protected context.
   ///
@@ -71,15 +72,24 @@ public:
   /// make as little assumptions as possible about the program state when
   /// RunSafely has returned false. Clients can use getBacktrace() to retrieve
   /// the backtrace of the crash on failures.
-  bool RunSafely(void (*Fn)(void*), void *UserData);
+  bool RunSafely(function_ref<void()> Fn);
+  bool RunSafely(void (*Fn)(void*), void *UserData) {
+    return RunSafely([&]() { Fn(UserData); });
+  }
 
   /// \brief Execute the provide callback function (with the given arguments) in
   /// a protected context which is run in another thread (optionally with a
   /// requested stack size).
   ///
   /// See RunSafely() and llvm_execute_on_thread().
+  ///
+  /// On Darwin, if PRIO_DARWIN_BG is set on the calling thread, it will be
+  /// propagated to the new thread as well.
+  bool RunSafelyOnThread(function_ref<void()>, unsigned RequestedStackSize = 0);
   bool RunSafelyOnThread(void (*Fn)(void*), void *UserData,
-                         unsigned RequestedStackSize = 0);
+                         unsigned RequestedStackSize = 0) {
+    return RunSafelyOnThread([&]() { Fn(UserData); }, RequestedStackSize);
+  }
 
   /// \brief Explicitly trigger a crash recovery in the current process, and
   /// return failure from RunSafely(). This function does not return.
@@ -94,91 +104,100 @@ public:
 };
 
 class CrashRecoveryContextCleanup {
+protected:
+  CrashRecoveryContext *context;
+  CrashRecoveryContextCleanup(CrashRecoveryContext *context)
+      : context(context), cleanupFired(false) {}
+
 public:
   bool cleanupFired;
-  enum ProvidedCleanups { DeleteCleanup, DestructorCleanup };
-  
-  CrashRecoveryContextCleanup() : cleanupFired(false) {}
+
   virtual ~CrashRecoveryContextCleanup();
   virtual void recoverResources() = 0;
-  
-  template <typename T> static CrashRecoveryContextCleanup *create(T *,
-                          ProvidedCleanups cleanupKind =
-                            CrashRecoveryContextCleanup::DeleteCleanup);
-  
+
+  CrashRecoveryContext *getContext() const {
+    return context;
+  }
+
 private:
   friend class CrashRecoveryContext;
   CrashRecoveryContextCleanup *prev, *next;
 };
 
-template <typename T>
-class CrashRecoveryContextDestructorCleanup 
-  : public CrashRecoveryContextCleanup
-{
+template<typename DERIVED, typename T>
+class CrashRecoveryContextCleanupBase : public CrashRecoveryContextCleanup {
+protected:
   T *resource;
+  CrashRecoveryContextCleanupBase(CrashRecoveryContext *context, T *resource)
+      : CrashRecoveryContextCleanup(context), resource(resource) {}
+
 public:
-  CrashRecoveryContextDestructorCleanup(T *resource) : resource(resource) {}
-  virtual void recoverResources() {
-    resource->~T();
+  static DERIVED *create(T *x) {
+    if (x) {
+      if (CrashRecoveryContext *context = CrashRecoveryContext::GetCurrent())
+        return new DERIVED(context, x);
+    }
+    return nullptr;
   }
 };
 
 template <typename T>
-class CrashRecoveryContextDeleteCleanup
-  : public CrashRecoveryContextCleanup
-{
-  T *resource;
+class CrashRecoveryContextDestructorCleanup : public
+  CrashRecoveryContextCleanupBase<CrashRecoveryContextDestructorCleanup<T>, T> {
 public:
-  CrashRecoveryContextDeleteCleanup(T *resource) : resource(resource) {}
+  CrashRecoveryContextDestructorCleanup(CrashRecoveryContext *context,
+                                        T *resource)
+      : CrashRecoveryContextCleanupBase<
+            CrashRecoveryContextDestructorCleanup<T>, T>(context, resource) {}
+
   virtual void recoverResources() {
-    delete resource;
+    this->resource->~T();
   }
 };
 
 template <typename T>
-struct CrashRecoveryContextTrait {
-  static inline CrashRecoveryContextCleanup *
-  createCleanup(T *resource,
-                CrashRecoveryContextCleanup::ProvidedCleanups cleanup) {
-    switch (cleanup) {
-      case CrashRecoveryContextCleanup::DeleteCleanup:
-        return new CrashRecoveryContextDeleteCleanup<T>(resource);
-      case CrashRecoveryContextCleanup::DestructorCleanup:
-        return new CrashRecoveryContextDestructorCleanup<T>(resource);
-    }
-    return 0;
-  }
+class CrashRecoveryContextDeleteCleanup : public
+  CrashRecoveryContextCleanupBase<CrashRecoveryContextDeleteCleanup<T>, T> {
+public:
+  CrashRecoveryContextDeleteCleanup(CrashRecoveryContext *context, T *resource)
+    : CrashRecoveryContextCleanupBase<
+        CrashRecoveryContextDeleteCleanup<T>, T>(context, resource) {}
+
+  void recoverResources() override { delete this->resource; }
 };
 
-template<typename T>
-inline CrashRecoveryContextCleanup*
-CrashRecoveryContextCleanup::create(T *x,
-          CrashRecoveryContextCleanup::ProvidedCleanups cleanupKind) {
-  return CrashRecoveryContext::GetCurrent() ?
-          CrashRecoveryContextTrait<T>::createCleanup(x, cleanupKind) : 
-          0;
-}
+template <typename T>
+class CrashRecoveryContextReleaseRefCleanup : public
+  CrashRecoveryContextCleanupBase<CrashRecoveryContextReleaseRefCleanup<T>, T>
+{
+public:
+  CrashRecoveryContextReleaseRefCleanup(CrashRecoveryContext *context,
+                                        T *resource)
+    : CrashRecoveryContextCleanupBase<CrashRecoveryContextReleaseRefCleanup<T>,
+          T>(context, resource) {}
+
+  void recoverResources() override { this->resource->Release(); }
+};
 
+template <typename T, typename Cleanup = CrashRecoveryContextDeleteCleanup<T> >
 class CrashRecoveryContextCleanupRegistrar {
-  CrashRecoveryContext *context;
   CrashRecoveryContextCleanup *cleanup;
+
 public:
-  CrashRecoveryContextCleanupRegistrar(CrashRecoveryContextCleanup *cleanup)
-    : context(CrashRecoveryContext::GetCurrent()),
-      cleanup(cleanup) 
-  {
-    if (context && cleanup)
-      context->registerCleanup(cleanup);
+  CrashRecoveryContextCleanupRegistrar(T *x)
+    : cleanup(Cleanup::create(x)) {
+    if (cleanup)
+      cleanup->getContext()->registerCleanup(cleanup);
   }
-  ~CrashRecoveryContextCleanupRegistrar() {
-    if (cleanup && !cleanup->cleanupFired) {
-      if (context)
-        context->unregisterCleanup(cleanup);
-      else
-        delete cleanup;
-    }
+
+  ~CrashRecoveryContextCleanupRegistrar() { unregister(); }
+
+  void unregister() {
+    if (cleanup && !cleanup->cleanupFired)
+      cleanup->getContext()->unregisterCleanup(cleanup);
+    cleanup = nullptr;
   }
 };
-}
+} // end namespace llvm
 
-#endif
+#endif // LLVM_SUPPORT_CRASHRECOVERYCONTEXT_H