libs/pbd/pbd/pthread_utils.h

   1 /*
   2     Copyright (C) 2000-2007 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __pbd_pthread_utils__
  21 #define __pbd_pthread_utils__
  22
  23 /* Accommodate thread setting (and testing) for both
  24  * 'libpthread' and 'libpthread_win32' (whose implementations
  25  * of 'pthread_t' are subtlely different)
  26  */
  27 #ifndef PTHREAD_MACROS_DEFINED
  28 #define PTHREAD_MACROS_DEFINED
  29 #ifdef  PTW32_VERSION  /* pthread_win32 */
  30 #define mark_pthread_inactive(threadID)  threadID.p=0
  31 #define is_pthread_active(threadID)      threadID.p!=0
  32 #else                 /* normal pthread */
  33 #define mark_pthread_inactive(threadID)  threadID=0
  34 #define is_pthread_active(threadID)      threadID!=0
  35 #endif  /* PTW32_VERSION */
  36 #endif  /* PTHREAD_MACROS_DEFINED */
  37
  38 #ifdef COMPILER_MSVC
  39 #include <ardourext/pthread.h>
  40 #else
  41 #include <pthread.h>
  42 #endif
  43 #include <signal.h>
  44 #include <string>
  45 #include <stdint.h>
  46
  47 #include "pbd/libpbd_visibility.h"
  48 #include "pbd/signals.h"
  49
  50 LIBPBD_API int  pthread_create_and_store (std::string name, pthread_t  *thread, void * (*start_routine)(void *), void * arg);
  51 LIBPBD_API void pthread_cancel_one (pthread_t thread);
  52 LIBPBD_API void pthread_cancel_all ();
  53 LIBPBD_API void pthread_kill_all (int signum);
  54 LIBPBD_API const char* pthread_name ();
  55 LIBPBD_API void pthread_set_name (const char* name);
  56
  57 LIBPBD_API int pbd_realtime_pthread_create (
  58                 const int policy, int priority, const size_t stacksize,
  59                 pthread_t *thread,
  60                 void *(*start_routine) (void *),
  61                 void *arg);
  62
  63 LIBPBD_API int pbd_set_thread_priority (pthread_t, const int policy, int priority);
  64
  65 namespace PBD {
  66         LIBPBD_API extern void notify_event_loops_about_thread_creation (pthread_t, const std::string&, int requests = 256);
  67         LIBPBD_API extern PBD::Signal3<void,pthread_t,std::string,uint32_t> ThreadCreatedWithRequestSize;
  68 }
  69
  70 /* pthread-w32 does not support realtime scheduling
  71  * (well, windows, doesn't..) and only supports SetThreadPriority()
  72  *
  73  * pthread_setschedparam() returns ENOTSUP if the policy is not SCHED_OTHER.
  74  *
  75  * however, pthread_create() with attributes, ignores the policy and
  76  * only sets the priority (when PTHREAD_EXPLICIT_SCHED is used).
  77  */
  78 #ifdef PLATFORM_WINDOWS
  79 #define PBD_SCHED_FIFO SCHED_OTHER
  80 #else
  81 #define PBD_SCHED_FIFO SCHED_FIFO
  82 #endif
  83 #endif /* __pbd_pthread_utils__ */