libsanitizer/sanitizer_common/sanitizer_thread_registry.h

   1 //===-- sanitizer_thread_registry.h -----------------------------*- C++ -*-===//
   2 //
   3 // This file is distributed under the University of Illinois Open Source
   4 // License. See LICENSE.TXT for details.
   5 //
   6 //===----------------------------------------------------------------------===//
   7 //
   8 // This file is shared between sanitizer tools.
   9 //
  10 // General thread bookkeeping functionality.
  11 //===----------------------------------------------------------------------===//
  12
  13 #ifndef SANITIZER_THREAD_REGISTRY_H
  14 #define SANITIZER_THREAD_REGISTRY_H
  15
  16 #include "sanitizer_common.h"
  17 #include "sanitizer_list.h"
  18 #include "sanitizer_mutex.h"
  19
  20 namespace __sanitizer {
  21
  22 enum ThreadStatus {
  23   ThreadStatusInvalid,   // Non-existent thread, data is invalid.
  24   ThreadStatusCreated,   // Created but not yet running.
  25   ThreadStatusRunning,   // The thread is currently running.
  26   ThreadStatusFinished,  // Joinable thread is finished but not yet joined.
  27   ThreadStatusDead       // Joined, but some info is still available.
  28 };
  29
  30 // Generic thread context. Specific sanitizer tools may inherit from it.
  31 // If thread is dead, context may optionally be reused for a new thread.
  32 class ThreadContextBase {
  33  public:
  34   explicit ThreadContextBase(u32 tid);
  35   ~ThreadContextBase();  // Should never be called.
  36
  37   const u32 tid;  // Thread ID. Main thread should have tid = 0.
  38   u64 unique_id;  // Unique thread ID.
  39   u32 reuse_count;  // Number of times this tid was reused.
  40   uptr os_id;     // PID (used for reporting).
  41   uptr user_id;   // Some opaque user thread id (e.g. pthread_t).
  42   char name[64];  // As annotated by user.
  43
  44   ThreadStatus status;
  45   bool detached;
  46
  47   u32 parent_tid;
  48   ThreadContextBase *next;  // For storing thread contexts in a list.
  49
  50   void SetName(const char *new_name);
  51
  52   void SetDead();
  53   void SetJoined(void *arg);
  54   void SetFinished();
  55   void SetStarted(uptr _os_id, void *arg);
  56   void SetCreated(uptr _user_id, u64 _unique_id, bool _detached,
  57                   u32 _parent_tid, void *arg);
  58   void Reset();
  59
  60   // The following methods may be overriden by subclasses.
  61   // Some of them take opaque arg that may be optionally be used
  62   // by subclasses.
  63   virtual void OnDead() {}
  64   virtual void OnJoined(void *arg) {}
  65   virtual void OnFinished() {}
  66   virtual void OnStarted(void *arg) {}
  67   virtual void OnCreated(void *arg) {}
  68   virtual void OnReset() {}
  69 };
  70
  71 typedef ThreadContextBase* (*ThreadContextFactory)(u32 tid);
  72
  73 class ThreadRegistry {
  74  public:
  75   static const u32 kUnknownTid;
  76
  77   ThreadRegistry(ThreadContextFactory factory, u32 max_threads,
  78                  u32 thread_quarantine_size, u32 max_reuse = 0);
  79   void GetNumberOfThreads(uptr *total = 0, uptr *running = 0, uptr *alive = 0);
  80   uptr GetMaxAliveThreads();
  81
  82   void Lock() { mtx_.Lock(); }
  83   void CheckLocked() { mtx_.CheckLocked(); }
  84   void Unlock() { mtx_.Unlock(); }
  85
  86   // Should be guarded by ThreadRegistryLock.
  87   ThreadContextBase *GetThreadLocked(u32 tid) {
  88     DCHECK_LT(tid, n_contexts_);
  89     return threads_[tid];
  90   }
  91
  92   u32 CreateThread(uptr user_id, bool detached, u32 parent_tid, void *arg);
  93
  94   typedef void (*ThreadCallback)(ThreadContextBase *tctx, void *arg);
  95   // Invokes callback with a specified arg for each thread context.
  96   // Should be guarded by ThreadRegistryLock.
  97   void RunCallbackForEachThreadLocked(ThreadCallback cb, void *arg);
  98
  99   typedef bool (*FindThreadCallback)(ThreadContextBase *tctx, void *arg);
 100   // Finds a thread using the provided callback. Returns kUnknownTid if no
 101   // thread is found.
 102   u32 FindThread(FindThreadCallback cb, void *arg);
 103   // Should be guarded by ThreadRegistryLock. Return 0 if no thread
 104   // is found.
 105   ThreadContextBase *FindThreadContextLocked(FindThreadCallback cb,
 106                                              void *arg);
 107   ThreadContextBase *FindThreadContextByOsIDLocked(uptr os_id);
 108
 109   void SetThreadName(u32 tid, const char *name);
 110   void SetThreadNameByUserId(uptr user_id, const char *name);
 111   void DetachThread(u32 tid);
 112   void JoinThread(u32 tid, void *arg);
 113   void FinishThread(u32 tid);
 114   void StartThread(u32 tid, uptr os_id, void *arg);
 115
 116  private:
 117   const ThreadContextFactory context_factory_;
 118   const u32 max_threads_;
 119   const u32 thread_quarantine_size_;
 120   const u32 max_reuse_;
 121
 122   BlockingMutex mtx_;
 123
 124   u32 n_contexts_;      // Number of created thread contexts,
 125                         // at most max_threads_.
 126   u64 total_threads_;   // Total number of created threads. May be greater than
 127                         // max_threads_ if contexts were reused.
 128   uptr alive_threads_;  // Created or running.
 129   uptr max_alive_threads_;
 130   uptr running_threads_;
 131
 132   ThreadContextBase **threads_;  // Array of thread contexts is leaked.
 133   IntrusiveList<ThreadContextBase> dead_threads_;
 134   IntrusiveList<ThreadContextBase> invalid_threads_;
 135
 136   void QuarantinePush(ThreadContextBase *tctx);
 137   ThreadContextBase *QuarantinePop();
 138 };
 139
 140 typedef GenericScopedLock<ThreadRegistry> ThreadRegistryLock;
 141
 142 }  // namespace __sanitizer
 143
 144 #endif  // SANITIZER_THREAD_REGISTRY_H