Enable build for FreeBSD (part 1/2)
[ardour.git] / libs / pbd / pthread_utils.cc
index 82742234870f27c5d072a31f8e2b05f27ff1e048..7cd25e42b86a23fd6ff1d1332ad6643c31f5282d 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
     $Id$
 */
 
-#include <map>
-#include <iostream>
+#include <set>
 #include <string>
+#include <cstring>
 #include <stdint.h>
 
 #include "pbd/pthread_utils.h"
+#ifdef WINE_THREAD_SUPPORT
+#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::map<string,pthread_t> ThreadMap;
+typedef std::list<pthread_t> ThreadMap;
 static ThreadMap all_threads;
 static pthread_mutex_t thread_map_lock = PTHREAD_MUTEX_INITIALIZER;
-static pthread_mutex_t gui_notify_lock = PTHREAD_MUTEX_INITIALIZER;
+static Glib::Threads::Private<char> thread_name (free);
 
 namespace PBD {
-   sigc::signal<void,pthread_t>             ThreadLeaving;
-   sigc::signal<void,pthread_t,std::string,uint32_t> ThreadCreatedWithRequestSize;
+       PBD::Signal3<void,pthread_t,std::string,uint32_t> ThreadCreatedWithRequestSize;
 }
 
 using namespace PBD;
 
-void
-PBD::notify_gui_about_thread_creation (pthread_t thread, std::string str, int request_count)
+static int thread_creator (pthread_t* thread_id, const pthread_attr_t* attr, void *(*function)(void*), void* arg)
 {
-       pthread_mutex_lock (&gui_notify_lock);
-       ThreadCreatedWithRequestSize (thread, str, request_count);
-       pthread_mutex_unlock (&gui_notify_lock);
+#ifdef WINE_THREAD_SUPPORT
+       return wine_pthread_create (thread_id, attr, function, arg);
+#else
+       return pthread_create (thread_id, attr, function, arg);
+#endif
 }
 
+
 void
-PBD::notify_gui_about_thread_exit (pthread_t thread)
+PBD::notify_event_loops_about_thread_creation (pthread_t thread, const std::string& emitting_thread_name, int request_count)
 {
-       pthread_mutex_lock (&gui_notify_lock);
-       ThreadLeaving (thread);
-       pthread_mutex_unlock (&gui_notify_lock);
+       /* 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);
 }
 
-int  
-pthread_create_and_store (string name, pthread_t  *thread, pthread_attr_t *attr, void * (*start_routine)(void *), void * arg)
+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) {}
+};
+
+static void*
+fake_thread_start (void* arg)
 {
-       int ret;
+       ThreadStartWithName* ts = (ThreadStartWithName*) arg;
+       void* (*thread_work)(void*) = ts->thread_work;
+       void* thread_arg = ts->arg;
 
-       pthread_attr_t default_attr;
-       bool use_default_attr = (attr == NULL);
-       
-       if (use_default_attr) {
-               // set default stack size to sensible default for memlocking
-               pthread_attr_init(&default_attr);
-               pthread_attr_setstacksize(&default_attr, 500000);
-               attr = &default_attr;
+       /* 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;
+
+       /* 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;
+               }
        }
 
-       if ((ret = pthread_create (thread, attr, start_routine, arg)) == 0) {
-               std::pair<string,pthread_t> newpair;
-               newpair.first = name;
-               newpair.second = *thread;
+       pthread_mutex_unlock (&thread_map_lock);
+
+       /* done */
 
-               pthread_mutex_lock (&thread_map_lock);
-               all_threads.insert (newpair);
+       return ret;
+}
 
+int
+pthread_create_and_store (string name, pthread_t  *thread, void * (*start_routine)(void *), void * arg)
+{
+       pthread_attr_t default_attr;
+       int ret;
+
+       // set default stack size to sensible default for memlocking
+       pthread_attr_init(&default_attr);
+       pthread_attr_setstacksize(&default_attr, 500000);
+
+       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.push_back (*thread);
                pthread_mutex_unlock (&thread_map_lock);
        }
 
-       if (use_default_attr) {
-               pthread_attr_destroy(&default_attr);
-       }
-       
+       pthread_attr_destroy(&default_attr);
+
        return ret;
 }
 
-string
+void
+pthread_set_name (const char *str)
+{
+       /* copy string and delete it when exiting */
+
+       thread_name.set (strdup (str));
+}
+
+const char *
 pthread_name ()
 {
-       pthread_t self = pthread_self();
-       string str;
+       const char* str = thread_name.get ();
 
-       pthread_mutex_lock (&thread_map_lock);
-       for (ThreadMap::iterator i = all_threads.begin(); i != all_threads.end(); ++i) {
-               if (i->second == self) {
-                       str = i->first;
-                       pthread_mutex_unlock (&thread_map_lock);
-                       return str;
-               }
+       if (str) {
+               return str;
        }
-       pthread_mutex_unlock (&thread_map_lock);
        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->second != pthread_self()) {
-                       pthread_kill (i->second, signum);
+               if (!pthread_equal ((*i), pthread_self())) {
+                       pthread_kill ((*i), signum);
                }
        }
        all_threads.clear();
@@ -120,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->second != pthread_self()) {
-                       pthread_cancel (i->second);
+
+       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->second == thread) {
+               if (pthread_equal ((*i), thread)) {
                        all_threads.erase (i);
                        break;
                }
@@ -146,19 +207,3 @@ pthread_cancel_one (pthread_t thread)
        pthread_cancel (thread);
        pthread_mutex_unlock (&thread_map_lock);
 }
-
-void
-pthread_exit_pbd (void* status) 
-{      
-       pthread_t thread = pthread_self();
-
-       pthread_mutex_lock (&thread_map_lock);
-       for (ThreadMap::iterator i = all_threads.begin(); i != all_threads.end(); ++i) {
-               if (i->second == thread) {
-                       all_threads.erase (i);
-                       break;
-               }
-       }
-       pthread_mutex_unlock (&thread_map_lock);
-       pthread_exit (status);
-}