annotate foosdk/sdk/pfc/threads.h @ 1:20d02a178406 default tip

*: check in everything else yay
author Paper <paper@tflc.us>
date Mon, 05 Jan 2026 02:15:46 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
1 #pragma once
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
2
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
3 #include <functional>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
4
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
5 #ifdef _WIN32
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
6 #include <process.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
7 #else
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
8 #include <pthread.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
9 #endif
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
10 namespace pfc {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
11 unsigned getOptimalWorkerThreadCount();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
12 unsigned getOptimalWorkerThreadCountEx(size_t taskCountLimit);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
13
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
14 //! IMPORTANT: all classes derived from thread must call waitTillDone() in their destructor, to avoid object destruction during a virtual function call!
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
15 class thread {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
16 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
17 #ifdef _WIN32
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
18 typedef HANDLE handle_t;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
19 #else
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
20 typedef pthread_t handle_t;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
21 #endif
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
22 // Returns a psuedo-handle meant only for local use, see win32 GetCurrentThread() semantics
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
23 static handle_t handleToCurrent();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
24
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
25 struct arg_t {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
26 #ifdef _WIN32
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
27 int winThreadPriority = 0; // THREAD_PRIORITY_NORMAL
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
28 #endif
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
29 #ifdef __APPLE__
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
30 // see: pthread_set_qos_class_self_np
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
31 int appleThreadQOS = 0; // QOS_CLASS_UNSPECIFIED
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
32 int appleRealtivePriority = 0; // valid only if appleThreadQOS is set
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
33 #endif
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
34 #ifndef _WIN32
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
35 int nixSchedPolicy = -1; // not set - cannot use 0 because SCHED_OTHER is 0 on Linux
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
36 sched_param nixSchedParam = {}; // valid only if nixSchedPolicy is set
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
37 #endif
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
38 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
39
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
40 static arg_t argDefault();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
41 static arg_t argCurrentThread();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
42 static arg_t argBackground();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
43 static arg_t argHighPriority();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
44 static arg_t argPlayback();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
45 static arg_t argUserInitiated();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
46 #ifdef _WIN32
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
47 static arg_t argWinPriority(int priority);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
48 #endif
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
49 #ifdef __APPLE__
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
50 static arg_t argAppleQOS(int qos);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
51 #endif
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
52 #ifndef _WIN32
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
53 static arg_t argNixPriority( int policy, int percent );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
54 #endif
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
55
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
56 //! Critical error handler function, never returns
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
57 PFC_NORETURN static void couldNotCreateThread();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
58
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
59 thread();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
60 ~thread() {PFC_ASSERT(!isActive()); waitTillDone();}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
61 void start( arg_t const & arg = argCurrentThread() );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
62 //! Valid thread object (created and not joined)?
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
63 bool isActive() const;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
64 //! Joins the thread: blocks until complete, releases resources. \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
65 //! After waitTillDone() returns, isActive() becomes false. \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
66 //! No-op if thread not started.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
67 void waitTillDone() {close();}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
68 #ifdef _WIN32
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
69 void winStart(int priority, DWORD * outThreadID);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
70 HANDLE winThreadHandle() { return m_thread; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
71 #else
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
72 pthread_t posixThreadHandle() { return m_thread; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
73 #endif
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
74 #ifdef __APPLE__
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
75 static void appleStartThreadPrologue();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
76 #endif
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
77
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
78 static void setCurrentPriority(arg_t const&);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
79 protected:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
80 virtual void threadProc() {PFC_ASSERT(!"Stub thread entry - should not get here");}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
81 private:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
82 void close();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
83 #ifdef _WIN32
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
84 static unsigned CALLBACK g_entry(void* p_instance);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
85 #else
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
86 static void * g_entry( void * arg );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
87 #endif
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
88 void entry();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
89
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
90 handle_t m_thread;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
91 #ifndef _WIN32
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
92 bool m_threadValid; // there is no invalid pthread_t, so we keep a separate 'valid' flag
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
93 #endif
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
94
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
95 PFC_CLASS_NOT_COPYABLE_EX(thread)
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
96 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
97
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
98 //! Thread class using lambda entrypoint rather than function override
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
99 class thread2 : public thread {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
100 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
101 ~thread2() { waitTillDone(); }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
102 void startHere(std::function<void()> e);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
103 void startHere(arg_t const& arg, std::function<void()> e);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
104 void setEntry(std::function<void()> e);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
105 private:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
106 void threadProc();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
107
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
108 std::function<void()> m_entryPoint;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
109 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
110
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
111 void splitThread(std::function<void() > f);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
112 void splitThread(pfc::thread::arg_t const & arg, std::function<void()> f);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
113
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
114 //! Apple specific; executes the function in a release pool scope. \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
115 //! On non Apple platforms it just invokes the function.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
116 void inAutoReleasePool(std::function<void()> f);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
117 }