thread.h

Go to the documentation of this file.

#ifndef THREADS_HEADER_GUARD
#define THREADS_HEADER_GUARD
/*
 * thread.h : Base class for multithreading
 * 
 * (c) Copyright 2017-2024 Sampsa Riikonen
 * 
 * Authors: Sampsa Riikonen <sampsa.riikonen@iki.fi>
 * 
 * This file is part of the Valkka library.
 * 
 * Valkka 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 (at your option) 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>
 *
 */
 
#include "Python.h"
#include "framefifo.h"
 
// #define STD_THREAD 1 // keep this commented if you want to adjust processor affinity
 
struct ThreadContext
{
    int someint; // example: just an integer
};
 
enum class Signal
{
    none,
    exit
};
 
struct SignalContext
{
    Signal signal;
    ThreadContext *thread_context;
};
 
class Thread { // <pyapi>
 
public: // <pyapi>
    Thread(const char *name); // don't include into python (this class is abstract)
 
    ~Thread(); // <pyapi>
 
private:
    Thread(const Thread &); //not implemented anywhere
    void operator=(const Thread &); //not implemented anywhere
 
protected:            // common variables of all Thread subclasses
    std::string name; 
    bool has_thread;  
    bool stop_requested;
    bool thread_joined;
 
    std::mutex start_mutex;                  
    std::condition_variable start_condition; 
 
    std::mutex mutex;                  
    std::condition_variable condition; 
 
    std::mutex loop_mutex; 
 
    std::deque<SignalContext> signal_fifo; 
    bool loop;                             
 
protected: // threads, processor affinity, etc.
    int core_id;
#ifdef STD_THREAD
    std::thread internal_thread; 
#else
    pthread_attr_t thread_attr; 
    cpu_set_t cpuset;
    pthread_t internal_thread;
#endif
 
public: // not protected, cause we might need to test these separately
    virtual void run() = 0;
    virtual void preRun() = 0;
    virtual void postRun() = 0;
    virtual void preJoin();
    virtual void postJoin();
    virtual void sendSignal(SignalContext signal_ctx);
    virtual void sendSignalAndWait(SignalContext signal_ctx);
 
protected:
    void mainRun();     
    void closeThread(); 
#ifdef STD_THREAD
#else
    static void *mainRun_(void *p);
#endif
 
public: // *** API ***                                                  // <pyapi>
    void setAffinity(int i); // <pyapi>
 
    void startCall(); // <pyapi>
 
    virtual void stopCall(); // <pyapi>
 
    virtual void requestStopCall(); // <pyapi>
 
    virtual void waitStopCall(); // <pyapi>
 
    virtual void waitReady(); // <pyapi>
 
}; // <pyapi>
 
class TestProducerThread : public Thread
{
 
public:
    TestProducerThread(const char *name, FrameFifo *framefifo, int index = 0);
 
public:
    void run();
    void preRun();
    void postRun();
 
protected:
    FrameFifo *framefifo; 
 
private:
    int index;
};
 
class TestConsumerThread : public Thread
{
 
public:
    TestConsumerThread(const char *name, FrameFifo *framefifo);
 
public:
    void run();
    void preRun();
    void postRun();
 
protected:
    FrameFifo *framefifo; 
};
 
#endif