|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331 |
- /*
- * Carla Thread
- * Copyright (C) 2013-2019 Filipe Coelho <falktx@falktx.com>
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License as
- * published by the Free Software Foundation; either version 2 of
- * the License, or any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * For a full copy of the GNU General Public License see the doc/GPL.txt file.
- */
-
- #ifndef CARLA_THREAD_HPP_INCLUDED
- #define CARLA_THREAD_HPP_INCLUDED
-
- #include "CarlaMutex.hpp"
- #include "CarlaString.hpp"
- #include "CarlaProcessUtils.hpp"
-
- #ifdef CARLA_OS_LINUX
- # include <sys/prctl.h>
- #endif
-
- // -----------------------------------------------------------------------
- // CarlaThread class
-
- class CarlaThread
- {
- protected:
- /*
- * Constructor.
- */
- CarlaThread(const char* const threadName = nullptr) noexcept
- : fLock(),
- fSignal(),
- fName(threadName),
- #ifdef PTW32_DLLPORT
- fHandle({nullptr, 0}),
- #else
- fHandle(0),
- #endif
- fShouldExit(false) {}
-
- /*
- * Destructor.
- */
- virtual ~CarlaThread() /*noexcept*/
- {
- CARLA_SAFE_ASSERT(! isThreadRunning());
-
- stopThread(-1);
- }
-
- /*
- * Virtual function to be implemented by the subclass.
- */
- virtual void run() = 0;
-
- // -------------------------------------------------------------------
-
- public:
- /*
- * Check if the thread is running.
- */
- bool isThreadRunning() const noexcept
- {
- #ifdef PTW32_DLLPORT
- return (fHandle.p != nullptr);
- #else
- return (fHandle != 0);
- #endif
- }
-
- /*
- * Check if the thread should exit.
- */
- bool shouldThreadExit() const noexcept
- {
- return fShouldExit;
- }
-
- /*
- * Start the thread.
- */
- bool startThread(const bool withRealtimePriority = false) noexcept
- {
- // check if already running
- CARLA_SAFE_ASSERT_RETURN(! isThreadRunning(), true);
-
- pthread_t handle;
-
- pthread_attr_t attr;
- pthread_attr_init(&attr);
-
- struct sched_param sched_param;
- carla_zeroStruct(sched_param);
-
- if (withRealtimePriority)
- {
- sched_param.sched_priority = 80;
-
- #ifndef CARLA_OS_HAIKU
- if (pthread_attr_setscope(&attr, PTHREAD_SCOPE_SYSTEM) == 0 &&
- pthread_attr_setinheritsched(&attr, PTHREAD_EXPLICIT_SCHED) == 0 &&
- # ifndef CARLA_OS_WIN
- (pthread_attr_setschedpolicy(&attr, SCHED_FIFO) == 0 ||
- pthread_attr_setschedpolicy(&attr, SCHED_RR) == 0) &&
- # endif
- pthread_attr_setschedparam(&attr, &sched_param) == 0)
- {
- carla_stdout("CarlaThread setup with realtime priority successful");
- }
- else
- #endif
- {
- carla_stdout("CarlaThread setup with realtime priority failed, going with normal priority instead");
- pthread_attr_destroy(&attr);
- pthread_attr_init(&attr);
- }
- }
-
- const CarlaMutexLocker cml(fLock);
-
- fShouldExit = false;
-
- bool ok = pthread_create(&handle, &attr, _entryPoint, this) == 0;
- pthread_attr_destroy(&attr);
-
- if (withRealtimePriority && !ok)
- {
- carla_stdout("CarlaThread with realtime priority failed on creation, going with normal priority instead");
- pthread_attr_init(&attr);
- ok = pthread_create(&handle, &attr, _entryPoint, this) == 0;
- pthread_attr_destroy(&attr);
- }
-
- CARLA_SAFE_ASSERT_RETURN(ok, false);
- #ifdef PTW32_DLLPORT
- CARLA_SAFE_ASSERT_RETURN(handle.p != nullptr, false);
- #else
- CARLA_SAFE_ASSERT_RETURN(handle != 0, false);
- #endif
- pthread_detach(handle);
- _copyFrom(handle);
-
- // wait for thread to start
- fSignal.wait();
- return true;
- }
-
- /*
- * Stop the thread.
- * In the 'timeOutMilliseconds':
- * = 0 -> no wait
- * > 0 -> wait timeout value
- * < 0 -> wait forever
- */
- bool stopThread(const int timeOutMilliseconds) noexcept
- {
- const CarlaMutexLocker cml(fLock);
-
- if (isThreadRunning())
- {
- signalThreadShouldExit();
-
- if (timeOutMilliseconds != 0)
- {
- // Wait for the thread to stop
- int timeOutCheck = (timeOutMilliseconds == 1 || timeOutMilliseconds == -1) ? timeOutMilliseconds : timeOutMilliseconds/2;
-
- for (; isThreadRunning();)
- {
- carla_msleep(2);
-
- if (timeOutCheck < 0)
- continue;
-
- if (timeOutCheck > 0)
- timeOutCheck -= 1;
- else
- break;
- }
- }
-
- if (isThreadRunning())
- {
- // should never happen!
- carla_stderr2("Carla assertion failure: \"! isThreadRunning()\" in file %s, line %i", __FILE__, __LINE__);
-
- // copy thread id so we can clear our one
- pthread_t threadId;
- _copyTo(threadId);
- _init();
-
- try {
- pthread_cancel(threadId);
- } CARLA_SAFE_EXCEPTION("pthread_cancel");
-
- return false;
- }
- }
-
- return true;
- }
-
- /*
- * Tell the thread to stop as soon as possible.
- */
- void signalThreadShouldExit() noexcept
- {
- fShouldExit = true;
- }
-
- // -------------------------------------------------------------------
-
- /*
- * Returns the name of the thread.
- * This is the name that gets set in the constructor.
- */
- const CarlaString& getThreadName() const noexcept
- {
- return fName;
- }
-
- /*
- * Returns the Id/handle of the thread.
- */
- pthread_t getThreadId() const noexcept
- {
- return fHandle;
- }
-
- /*
- * Changes the name of the caller thread.
- */
- static void setCurrentThreadName(const char* const name) noexcept
- {
- CARLA_SAFE_ASSERT_RETURN(name != nullptr && name[0] != '\0',);
-
- carla_setProcessName(name);
- #if defined(__GLIBC__) && (__GLIBC__ * 1000 + __GLIBC_MINOR__) >= 2012 && !defined(CARLA_OS_GNU_HURD)
- pthread_setname_np(pthread_self(), name);
- #endif
- }
-
- // -------------------------------------------------------------------
-
- private:
- CarlaMutex fLock; // Thread lock
- CarlaSignal fSignal; // Thread start wait signal
- const CarlaString fName; // Thread name
- volatile pthread_t fHandle; // Handle for this thread
- volatile bool fShouldExit; // true if thread should exit
-
- /*
- * Init pthread type.
- */
- void _init() noexcept
- {
- #ifdef PTW32_DLLPORT
- fHandle.p = nullptr;
- fHandle.x = 0;
- #else
- fHandle = 0;
- #endif
- }
-
- /*
- * Copy our pthread type from another var.
- */
- void _copyFrom(const pthread_t& handle) noexcept
- {
- #ifdef PTW32_DLLPORT
- fHandle.p = handle.p;
- fHandle.x = handle.x;
- #else
- fHandle = handle;
- #endif
- }
-
- /*
- * Copy our pthread type to another var.
- */
- void _copyTo(volatile pthread_t& handle) const noexcept
- {
- #ifdef PTW32_DLLPORT
- handle.p = fHandle.p;
- handle.x = fHandle.x;
- #else
- handle = fHandle;
- #endif
- }
-
- /*
- * Thread entry point.
- */
- void _runEntryPoint() noexcept
- {
- setCurrentThreadName(fName);
-
- // report ready
- fSignal.signal();
-
- try {
- run();
- } catch(...) {}
-
- // done
- _init();
- }
-
- /*
- * Thread entry point.
- */
- static void* _entryPoint(void* userData) noexcept
- {
- static_cast<CarlaThread*>(userData)->_runEntryPoint();
- return nullptr;
- }
-
- CARLA_DECLARE_NON_COPY_CLASS(CarlaThread)
- };
-
- // -----------------------------------------------------------------------
-
- #endif // CARLA_THREAD_HPP_INCLUDED
|