Add PBD API to hard-link files
[ardour.git] / libs / pbd / pthread_utils.cc
index b8ca8fc09346274d7dd441ae68d1e0671e7c8534..e8a17792c2f56c38ebc4e4669715fde1f772aa5b 100644 (file)
@@ -1,22 +1,22 @@
 /*
-    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
-    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., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-    $Id$
-*/
+ * Copyright (C) 2002-2015 Paul Davis <paul@linuxaudiosystems.com>
+ * Copyright (C) 2007-2009 David Robillard <d@drobilla.net>
+ * Copyright (C) 2015-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.
+ */
 
 #include <set>
 #include <string>
@@ -44,7 +44,7 @@ static pthread_mutex_t thread_map_lock = PTHREAD_MUTEX_INITIALIZER;
 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;
@@ -58,17 +58,25 @@ 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;
     std::string name;
-    
+
     ThreadStartWithName (void* (*f)(void*), void* a, const std::string& s)
            : thread_work (f), arg (a), name (s) {}
 };
@@ -110,7 +118,7 @@ fake_thread_start (void* arg)
        return ret;
 }
 
-int  
+int
 pthread_create_and_store (string name, pthread_t  *thread, void * (*start_routine)(void *), void * arg)
 {
        pthread_attr_t default_attr;
@@ -137,8 +145,8 @@ void
 pthread_set_name (const char *str)
 {
        /* copy string and delete it when exiting */
-       
-       thread_name.set (strdup (str));
+
+       thread_name.set (strdup (str)); // leaks
 }
 
 const char *
@@ -148,13 +156,13 @@ 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 (!pthread_equal ((*i), pthread_self())) {
@@ -166,8 +174,8 @@ 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(); ) {
@@ -186,8 +194,8 @@ pthread_cancel_all ()
 }
 
 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 (pthread_equal ((*i), thread)) {
@@ -200,3 +208,96 @@ pthread_cancel_one (pthread_t thread)
        pthread_mutex_unlock (&thread_map_lock);
 }
 
+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.
+       }
+
+       if (priority > 0) {
+               priority += p_min;
+       } else {
+               priority += p_max;
+       }
+       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
+}