/*
* Copyright (C) 2025 Linux Studio Plugins Project
* (C) 2025 Vladimir Sadovnikov
*
* This file is part of lsp-runtime-lib
* Created on: 25 февр. 2019 г.
*
* lsp-runtime-lib is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* any later version.
*
* lsp-runtime-lib 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with lsp-runtime-lib. If not, see .
*/
#ifndef LSP_PLUG_IN_IPC_THREAD_H_
#define LSP_PLUG_IN_IPC_THREAD_H_
#include
#include
#include
#include
#if defined(PLATFORM_WINDOWS)
#include
#else
#include
#endif /* PLATFORM_WINDOWS */
#include
#include
namespace lsp
{
namespace ipc
{
enum thread_state_t
{
TS_CREATED,
TS_PENDING,
TS_RUNNING,
TS_FINISHED
};
/**
* Thread procedure that can be launched
* @param arg additional argument passed to a thread procedure
* @return status of thread execution
*/
typedef status_t (* thread_proc_t)(void *arg);
typedef umword_t thread_id_t;
constexpr thread_id_t INVALID_THREAD_ID = 0;
/**
* Thread class
*/
class Thread: public IRunnable
{
protected:
typedef struct binding_t
{
thread_proc_t proc;
union
{
IRunnable *runnable;
void *arg;
};
} binding_t;
private:
static __thread Thread *pThis;
mutable int enState;
volatile bool bCancelled;
volatile status_t nResult;
#if defined(PLATFORM_WINDOWS)
HANDLE hThread; // Windows threads
#else
pthread_t hThread; // POSIX threads
#endif /* PLATFORM_WINDOWS */
protected:
binding_t sBinding;
private:
#if defined(PLATFORM_WINDOWS)
static DWORD WINAPI thread_launcher(_In_ LPVOID lpParameter);
#else
static void *thread_launcher(void *arg);
#endif /* PLATFORM_WINDOWS */
Thread & operator = (const Thread &src); // Deny copying
public:
explicit Thread();
explicit Thread(thread_proc_t proc);
explicit Thread(thread_proc_t proc, void *arg);
explicit Thread(IRunnable *runnable);
virtual ~Thread();
public:
/**
* The thread's main execution method
* @return status of thread execution
*/
virtual status_t run();
/**
* Launch the created thread
* @return status of operation
*/
status_t start();
/**
* Send cancel request to the thread
* @return status of operation
*/
status_t cancel();
/**
* Wait thread for completion
* @return status of operation
*/
status_t join();
/**
* Force current thread to leep for amount of milliseconds
* @param millis interval in milliseconds to perform a sleep
*/
static status_t sleep(wsize_t millis);
/**
* Causes the calling thread to yield execution to another thread that
* is ready to run on the current processor.
*/
static void yield();
/**
* Return the current thread
* @return current thread or NULL if current thread is not an instance of ipc::Thread class
*/
static inline Thread *current() { return pThis; }
/** Check that cancellation signal has been delivered to the current thread
* @return true if cancellation signal is pending
*/
static inline bool is_cancelled() { return (pThis != NULL) ? pThis->bCancelled : false; };
/** Check that cancellation signal has been delivered to the thread
* @return true if thread has been cancelled
*/
inline bool cancelled() const { return bCancelled; };
/**
* Check whether thread has finished
* @return true if thread has finished
*/
inline bool finished() const { return atomic_load(&enState) == TS_FINISHED; }
/**
* Get thread state
* @return thread state
*/
inline thread_state_t state() const { return thread_state_t(atomic_load(&enState)); };
/**
* Return the execution result of the thread
* @return execution result of the thread
*/
status_t get_result() const { return (atomic_load(&enState) == TS_FINISHED) ? nResult : STATUS_BAD_STATE; };
/**
* Return number of execution cores supported by the system
* @return number of logical CPUs in the system available for processing
*/
static inline size_t system_cores() { return system::system_cores(); }
/**
* Get current thread identifier.
* @return current thread identifier
*/
static thread_id_t current_thread_id();
};
} /* namespace ipc */
} /* namespace lsp */
#endif /* LSP_PLUG_IN_IPC_THREAD_H_ */