pthread_utils.h

Go to the documentation of this file.

/*
 * Copyright (C) 2000-2015 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2013-2014 John Emmas <john@creativepost.co.uk>
 * Copyright (C) 2017-2018 Robin Gareus <robin@gareus.org>
 *
 * 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
 * (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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#ifndef __pbd_pthread_utils__
#define __pbd_pthread_utils__
 
/* Accommodate thread setting (and testing) for both
 * 'libpthread' and 'libpthread_win32' (whose implementations
 * of 'pthread_t' are subtlely different)
 */
#ifndef PTHREAD_MACROS_DEFINED
#define PTHREAD_MACROS_DEFINED
#ifdef  PTW32_VERSION  /* pthread_win32 */
#define mark_pthread_inactive(threadID)  threadID.p=0
#define is_pthread_active(threadID)      threadID.p!=0
#else                 /* normal pthread */
#define mark_pthread_inactive(threadID)  threadID=0
#define is_pthread_active(threadID)      threadID!=0
#endif  /* PTW32_VERSION */
#endif  /* PTHREAD_MACROS_DEFINED */
 
#ifdef COMPILER_MSVC
#include <ardourext/pthread.h>
#else
#include <pthread.h>
#endif
#include <signal.h>
#include <string>
#include <stdint.h>
 
#include "pbd/libpbd_visibility.h"
#include "pbd/signals.h"
 
#define PBD_RT_STACKSIZE_PROC 0x80000 // 512kB
#define PBD_RT_STACKSIZE_HELP 0x08000 // 32kB
 
/* these are relative to sched_get_priority_max()
 * see pbd_absolute_rt_priority()
 */
# define PBD_RT_PRI_MAIN pbd_pthread_priority (THREAD_MAIN)
# define PBD_RT_PRI_MIDI pbd_pthread_priority (THREAD_MIDI)
# define PBD_RT_PRI_PROC pbd_pthread_priority (THREAD_PROC)
# define PBD_RT_PRI_CTRL pbd_pthread_priority (THREAD_CTRL)
# define PBD_RT_PRI_IOFX pbd_pthread_priority (THREAD_IOFX)
 
LIBPBD_API int  pthread_create_and_store (std::string name, pthread_t  *thread, void * (*start_routine)(void *), void * arg, uint32_t stacklimit = 0x80000 /*512kB*/);
LIBPBD_API void pthread_cancel_one (pthread_t thread);
LIBPBD_API void pthread_cancel_all ();
LIBPBD_API void pthread_kill_all (int signum);
LIBPBD_API const char* pthread_name ();
LIBPBD_API void pthread_set_name (const char* name);
 
LIBPBD_API void pbd_set_engine_rt_priority (int);
 
enum PBDThreadClass {
        THREAD_MAIN, // main audio I/O thread
        THREAD_MIDI, // MIDI I/O threads
        THREAD_PROC, // realtime worker
        THREAD_CTRL, // Automation watch, BaseUI
        THREAD_IOFX  // non-realtime I/O and regionFX
};
 
LIBPBD_API int pbd_pthread_priority (PBDThreadClass);
 
LIBPBD_API int pbd_pthread_create (
                const size_t stacksize,
                pthread_t *thread,
                void *(*start_routine) (void *),
                void *arg);
 
 
LIBPBD_API int pbd_realtime_pthread_create (
                std::string const& debug_name,
                const int policy, int priority, const size_t stacksize,
                pthread_t *thread,
                void *(*start_routine) (void *),
                void *arg);
 
LIBPBD_API int  pbd_absolute_rt_priority (int policy, int priority);
LIBPBD_API int  pbd_set_thread_priority (pthread_t, int policy, int priority);
LIBPBD_API bool pbd_mach_set_realtime_policy (pthread_t thread_id, double period_ns, bool main);
 
namespace PBD {
        LIBPBD_API extern void notify_event_loops_about_thread_creation (pthread_t, const std::string&, int requests = 256);
        LIBPBD_API extern PBD::Signal<void(pthread_t,std::string,uint32_t)> ThreadCreatedWithRequestSize;
 
        class LIBPBD_API Thread {
                public:
                static Thread* create (std::function<void ()> const&, std::string const& name);
                static Thread* self ();
                void join ();
                bool caller_is_self () const;
 
                private:
                Thread ();
                Thread (std::function<void ()> const&, std::string const& name = "");
                Thread (Thread const&); /* precent copy-construction */
 
                static void* _run (void*);
 
                pthread_t                _t;
                std::string              _name;
                std::function<void ()> _slot;
                bool                     _joinable;
        };
}
 
/* pthread-w32 does not support realtime scheduling
 * (well, windows, doesn't..) and only supports SetThreadPriority()
 *
 * pthread_setschedparam() returns ENOTSUP if the policy is not SCHED_OTHER.
 *
 * however, pthread_create() with attributes, ignores the policy and
 * only sets the priority (when PTHREAD_EXPLICIT_SCHED is used).
 */
#ifdef PLATFORM_WINDOWS
#define PBD_SCHED_FIFO SCHED_OTHER
#else
#define PBD_SCHED_FIFO SCHED_FIFO
#endif
#endif /* __pbd_pthread_utils__ */