Optimize automation-event process splitting
[ardour.git] / libs / pbd / pthread_utils.cc
index 34ac6fd1afabba93e4b262da4f1b9fc60c68311d..64ac8bb5630b329bf6113f3937c9170a9546ace8 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2002 Paul Davis 
+    Copyright (C) 2002 Paul Davis
 
     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
@@ -19,8 +19,8 @@
 */
 
 #include <set>
-#include <iostream>
 #include <string>
+#include <cstring>
 #include <stdint.h>
 
 #include "pbd/pthread_utils.h"
 #include <fst.h>
 #endif
 
+#ifdef COMPILER_MSVC
+DECLARE_DEFAULT_COMPARISONS(pthread_t)  // Needed for 'DECLARE_DEFAULT_COMPARISONS'. Objects in an STL container can be
+                                        // searched and sorted. Thus, when instantiating the container, MSVC complains
+                                        // if the type of object being contained has no appropriate comparison operators
+                                        // defined (specifically, if operators '<' and '==' are undefined). This seems
+                                        // to be the case with ptw32 'pthread_t' which is a simple struct.
+#endif
+
 using namespace std;
 
-typedef std::set<pthread_t> ThreadMap;
+typedef std::list<pthread_t> ThreadMap;
 static ThreadMap all_threads;
 static pthread_mutex_t thread_map_lock = PTHREAD_MUTEX_INITIALIZER;
-static Glib::StaticPrivate<char> thread_name;
+static Glib::Threads::Private<char> thread_name (free);
 
 namespace PBD {
-       PBD::Signal4<void,std::string, pthread_t,std::string,uint32_t> ThreadCreatedWithRequestSize;
+       PBD::Signal3<void,pthread_t,std::string,uint32_t> ThreadCreatedWithRequestSize;
 }
 
 using namespace PBD;
@@ -50,18 +58,26 @@ static int thread_creator (pthread_t* thread_id, const pthread_attr_t* attr, voi
 #endif
 }
 
+
 void
-PBD::notify_gui_about_thread_creation (std::string target_gui, pthread_t thread, std::string str, int request_count)
+PBD::notify_event_loops_about_thread_creation (pthread_t thread, const std::string& emitting_thread_name, int request_count)
 {
-       ThreadCreatedWithRequestSize (target_gui, thread, str, request_count);
+       /* notify threads that may exist in the future (they may also exist
+        * already, in which case they will catch the
+        * ThreadCreatedWithRequestSize signal)
+        */
+       EventLoop::pre_register (emitting_thread_name, request_count);
+
+       /* notify all existing threads */
+       ThreadCreatedWithRequestSize (thread, emitting_thread_name, request_count);
 }
 
 struct ThreadStartWithName {
     void* (*thread_work)(void*);
     void* arg;
-    const char* name;
-    
-    ThreadStartWithName (void* (*f)(void*), void* a, const char* s)
+    std::string name;
+
+    ThreadStartWithName (void* (*f)(void*), void* a, const std::string& s)
            : thread_work (f), arg (a), name (s) {}
 };
 
@@ -72,15 +88,37 @@ fake_thread_start (void* arg)
        void* (*thread_work)(void*) = ts->thread_work;
        void* thread_arg = ts->arg;
 
-       pthread_set_name (ts->name);
+       /* name will be deleted by the default handler for GStaticPrivate, when the thread exits */
+
+       pthread_set_name (ts->name.c_str());
+
+       /* we don't need this object anymore */
 
        delete ts;
-       /* name will be deleted by the default handler for GStaticPrivate, when the thread exits */
 
-       return thread_work (thread_arg);
+       /* actually run the thread's work function */
+
+       void* ret = thread_work (thread_arg);
+
+       /* cleanup */
+
+       pthread_mutex_lock (&thread_map_lock);
+
+       for (ThreadMap::iterator i = all_threads.begin(); i != all_threads.end(); ++i) {
+               if (pthread_equal ((*i), pthread_self())) {
+                       all_threads.erase (i);
+                       break;
+               }
+       }
+
+       pthread_mutex_unlock (&thread_map_lock);
+
+       /* done */
+
+       return ret;
 }
 
-int  
+int
 pthread_create_and_store (string name, pthread_t  *thread, void * (*start_routine)(void *), void * arg)
 {
        pthread_attr_t default_attr;
@@ -90,14 +128,11 @@ pthread_create_and_store (string name, pthread_t  *thread, void * (*start_routin
        pthread_attr_init(&default_attr);
        pthread_attr_setstacksize(&default_attr, 500000);
 
-       char* cname = new char[name.length() + 1];
-       strcpy (cname, name.c_str());
-
-       ThreadStartWithName* ts = new ThreadStartWithName (start_routine, arg, cname);
+       ThreadStartWithName* ts = new ThreadStartWithName (start_routine, arg, name);
 
        if ((ret = thread_creator (thread, &default_attr, fake_thread_start, ts)) == 0) {
                pthread_mutex_lock (&thread_map_lock);
-               all_threads.insert (*thread);
+               all_threads.push_back (*thread);
                pthread_mutex_unlock (&thread_map_lock);
        }
 
@@ -109,8 +144,9 @@ pthread_create_and_store (string name, pthread_t  *thread, void * (*start_routin
 void
 pthread_set_name (const char *str)
 {
-       /* str will be deleted when this thread exits */
-       thread_name.set (const_cast<char*>(str));
+       /* copy string and delete it when exiting */
+
+       thread_name.set (strdup (str)); // leaks
 }
 
 const char *
@@ -120,16 +156,16 @@ pthread_name ()
 
        if (str) {
                return str;
-       } 
+       }
        return "unknown";
 }
 
 void
-pthread_kill_all (int signum) 
-{      
+pthread_kill_all (int signum)
+{
        pthread_mutex_lock (&thread_map_lock);
        for (ThreadMap::iterator i = all_threads.begin(); i != all_threads.end(); ++i) {
-               if ((*i) != pthread_self()) {
+               if (!pthread_equal ((*i), pthread_self())) {
                        pthread_kill ((*i), signum);
                }
        }
@@ -138,24 +174,31 @@ pthread_kill_all (int signum)
 }
 
 void
-pthread_cancel_all () 
-{      
+pthread_cancel_all ()
+{
        pthread_mutex_lock (&thread_map_lock);
-       for (ThreadMap::iterator i = all_threads.begin(); i != all_threads.end(); ++i) {
-               if ((*i) != pthread_self()) {
+
+       for (ThreadMap::iterator i = all_threads.begin(); i != all_threads.end(); ) {
+
+               ThreadMap::iterator nxt = i;
+               ++nxt;
+
+               if (!pthread_equal ((*i), pthread_self())) {
                        pthread_cancel ((*i));
                }
+
+               i = nxt;
        }
        all_threads.clear();
        pthread_mutex_unlock (&thread_map_lock);
 }
 
 void
-pthread_cancel_one (pthread_t thread) 
-{      
+pthread_cancel_one (pthread_t thread)
+{
        pthread_mutex_lock (&thread_map_lock);
        for (ThreadMap::iterator i = all_threads.begin(); i != all_threads.end(); ++i) {
-               if ((*i) == thread) {
+               if (pthread_equal ((*i), thread)) {
                        all_threads.erase (i);
                        break;
                }
@@ -165,18 +208,96 @@ pthread_cancel_one (pthread_t thread)
        pthread_mutex_unlock (&thread_map_lock);
 }
 
-void
-pthread_exit_pbd (void* status) 
-{      
-       pthread_t thread = pthread_self();
+int
+pbd_absolute_rt_priority (int policy, int priority)
+{
+       /* POSIX requires a spread of at least 32 steps between min..max */
+       const int p_min = sched_get_priority_min (policy); // Linux: 1
+       const int p_max = sched_get_priority_max (policy); // Linux: 99
+
+       if (priority == 0) {
+               /* use default. XXX this should be relative to audio (JACK) thread,
+                * internal backends use -20 (Audio), -21 (MIDI), -22 (compuation)
+                */
+               priority = 7; // BaseUI backwards compat.
+       }
 
-       pthread_mutex_lock (&thread_map_lock);
-       for (ThreadMap::iterator i = all_threads.begin(); i != all_threads.end(); ++i) {
-               if ((*i) == thread) {
-                       all_threads.erase (i);
-                       break;
-               }
+       if (priority > 0) {
+               priority += p_min;
+       } else {
+               priority += p_max;
        }
-       pthread_mutex_unlock (&thread_map_lock);
-       pthread_exit (status);
+       if (priority > p_max) priority = p_max;
+       if (priority < p_min) priority = p_min;
+       return priority;
+}
+
+
+
+int
+pbd_realtime_pthread_create (
+               const int policy, int priority, const size_t stacksize,
+               pthread_t *thread,
+               void *(*start_routine) (void *),
+               void *arg)
+{
+       int rv;
+
+       pthread_attr_t attr;
+       struct sched_param parm;
+
+       parm.sched_priority = pbd_absolute_rt_priority (policy, priority);
+
+       pthread_attr_init (&attr);
+       pthread_attr_setschedpolicy (&attr, policy);
+       pthread_attr_setschedparam (&attr, &parm);
+       pthread_attr_setscope (&attr, PTHREAD_SCOPE_SYSTEM);
+       pthread_attr_setinheritsched (&attr, PTHREAD_EXPLICIT_SCHED);
+       pthread_attr_setstacksize (&attr, stacksize);
+       rv = pthread_create (thread, &attr, start_routine, arg);
+       pthread_attr_destroy (&attr);
+       return rv;
+}
+int
+pbd_set_thread_priority (pthread_t thread, const int policy, int priority)
+{
+       struct sched_param param;
+       memset (&param, 0, sizeof (param));
+       param.sched_priority = pbd_absolute_rt_priority (policy, priority);
+
+       return pthread_setschedparam (thread, SCHED_FIFO, &param);
+}
+
+bool
+pbd_mach_set_realtime_policy (pthread_t thread_id, double period_ns)
+{
+#ifdef _APPLE_
+       thread_time_constraint_policy_data_t policy;
+#ifndef NDEBUG
+       mach_msg_type_number_t msgt = 4;
+       boolean_t dflt = false;
+       kern_return_t rv = thread_policy_get (pthread_mach_thread_np (_main_thread),
+                       THREAD_TIME_CONSTRAINT_POLICY, (thread_policy_t) &policy,
+                       &msgt, &dflt);
+       printf ("Mach Thread(%p) %d %d %d %d DFLT %d OK: %d\n", _main_thread, policy.period, policy.computation, policy.constraint, policy.preemptible, dflt, rv == KERN_SUCCESS);
+#endif
+
+       mach_timebase_info_data_t timebase_info;
+       mach_timebase_info(&timebase_info);
+       const double period_clk = period_ns * (double)timebase_info.denom / (double)timebase_info.numer;
+
+       policy.period = period_clk;
+       policy.computation = period_clk * .9;
+       policy.constraint = period_clk * .95;
+       policy.preemptible = true;
+       kern_return_t res = thread_policy_set (pthread_mach_thread_np (thread_id),
+                       THREAD_TIME_CONSTRAINT_POLICY, (thread_policy_t) &policy,
+                       THREAD_TIME_CONSTRAINT_POLICY_COUNT);
+
+#ifndef NDEBUG
+       printf ("Mach Thread(%p) %d %d %d %d OK: %d\n", thread_id, policy.period, policy.computation, policy.constraint, policy.preemptible, res == KERN_SUCCESS);
+#endif
+       return res != KERN_SUCCESS;
+#endif
+       return false; // OK
 }