include/library/workthread.hpp

   1 #ifndef _library_workthread__hpp__included__
   2 #define _library_workthread__hpp__included__
   3
   4 #include <cstdint>
   5 #include "threadtypes.hpp"
   6
   7 #define WORKFLAG_QUIT_REQUEST 0x80000000U
   8
   9 class worker_thread_reflector;
  10
  11 /**
  12  * A worker thread.
  13  *
  14  * Note: All methods (except entrypoints) are thread-safe.
  15  */
  16 class worker_thread
  17 {
  18 public:
  19 /**
  20  * Constructor.
  21  */
  22         worker_thread();
  23 /**
  24  * Destructor.
  25  */
  26         virtual ~worker_thread();
  27 /**
  28  * Request quit. Sets quit request workflag.
  29  */
  30         void request_quit();
  31 /**
  32  * Set the busy flag.
  33  */
  34         void set_busy();
  35 /**
  36  * Clear the busy flag.
  37  */
  38         void clear_busy();
  39 /**
  40  * Wait until busy flag cleared.
  41  */
  42         void wait_busy();
  43 /**
  44  * Rethrow caught exception if any.
  45  */
  46         void rethrow();
  47 /**
  48  * Set work flag.
  49  *
  50  * Parameter flag: The flags to set.
  51  */
  52         void set_workflag(uint32_t flag);
  53 /**
  54  * Clear work flag.
  55  *
  56  * Parameter flag: Work flags to clear.
  57  * Returns: The workflags before clearing.
  58  */
  59         uint32_t clear_workflag(uint32_t flag);
  60 /**
  61  * Wait until work flags nonzero.
  62  *
  63  * Returns: Current work flags.
  64  */
  65         uint32_t wait_workflag();
  66 /**
  67  * Thread raw entrypoint.
  68  *
  69  * Note: Don't call from outside workthread code.
  70  */
  71         int operator()(int dummy);
  72 /**
  73  * Get wait counters.
  74  *
  75  * Retrns: Two-element tuple.
  76  *      - The first element is the amount of microseconds wait_busy() has waited.
  77  *      - The second element is the amount of microseconds wait_workflag() has waited.
  78  */
  79         std::pair<uint64_t, uint64_t> get_wait_count();
  80 protected:
  81 /**
  82  * Thread entrypoint.
  83  *
  84  * Notes: Exceptions thrown are catched.
  85  */
  86         virtual void entry() = 0;
  87 /**
  88  * Start actually running the thread.
  89  */
  90         void fire();
  91 private:
  92         thread_class* thread;
  93         worker_thread_reflector* reflector;
  94         cv_class condition;
  95         mutex_class mutex;
  96         volatile bool joined;
  97         volatile uint32_t workflag;
  98         volatile bool busy;
  99         volatile bool exception_caught;
 100         volatile bool exception_oom;
 101         volatile uint64_t waitamt_busy;
 102         volatile uint64_t waitamt_work;
 103         std::string exception_text;
 104 };
 105
 106 #endif