libs/pbd/pbd/abstract_ui.cc

   1 /*
   2     Copyright (C) 2012 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 #include <unistd.h>
  20 #include <iostream>
  21 #include <algorithm>
  22
  23 #include "pbd/stacktrace.h"
  24 #include "pbd/abstract_ui.h"
  25 #include "pbd/pthread_utils.h"
  26 #include "pbd/failed_constructor.h"
  27 #include "pbd/debug.h"
  28
  29 #include "pbd/i18n.h"
  30
  31 #ifdef COMPILER_MSVC
  32 #include <ardourext/misc.h>  // Needed for 'DECLARE_DEFAULT_COMPARISONS'. Objects in an STL container can be
  33                              // searched and sorted. Thus, when instantiating the container, MSVC complains
  34                              // if the type of object being contained has no appropriate comparison operators
  35                              // defined (specifically, if operators '<' and '==' are undefined). This seems
  36                              // to be the case with ptw32 'pthread_t' which is a simple struct.
  37 DECLARE_DEFAULT_COMPARISONS(ptw32_handle_t)
  38 #endif
  39
  40 using namespace std;
  41
  42 template<typename RequestBuffer> void
  43 cleanup_request_buffer (void* ptr)
  44 {
  45         RequestBuffer* rb = (RequestBuffer*) ptr;
  46
  47         /* this is called when the thread for which this request buffer was
  48          * allocated dies. That could be before or after the end of the UI
  49          * event loop for which this request buffer provides communication.
  50          *
  51          * We are not modifying the UI's thread/buffer map, just marking it
  52          * dead. If the UI is currently processing the buffers and misses
  53          * this "dead" signal, it will find it the next time it receives
  54          * a request. If the UI has finished processing requests, then
  55          * we will leak this buffer object.
  56          */
  57         DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("thread \"%1\" exits: marking request buffer as dead @ %2\n", pthread_name(), rb));
  58         rb->dead = true;
  59 }
  60
  61 template<typename R>
  62 Glib::Threads::Private<typename AbstractUI<R>::RequestBuffer> AbstractUI<R>::per_thread_request_buffer (cleanup_request_buffer<AbstractUI<R>::RequestBuffer>);
  63
  64 template <typename RequestObject>
  65 AbstractUI<RequestObject>::AbstractUI (const string& name)
  66         : BaseUI (name)
  67 {
  68         void (AbstractUI<RequestObject>::*pmf)(pthread_t,string,uint32_t) = &AbstractUI<RequestObject>::register_thread;
  69
  70         /* better to make this connect a handler that runs in the UI event loop but the syntax seems hard, and
  71            register_thread() is thread safe anyway.
  72         */
  73
  74         PBD::ThreadCreatedWithRequestSize.connect_same_thread (new_thread_connection, boost::bind (pmf, this, _1, _2, _3));
  75
  76         /* find pre-registerer threads */
  77
  78         vector<EventLoop::ThreadBufferMapping> tbm = EventLoop::get_request_buffers_for_target_thread (event_loop_name());
  79
  80         {
  81                 Glib::Threads::Mutex::Lock rbml (request_buffer_map_lock);
  82                 for (vector<EventLoop::ThreadBufferMapping>::iterator t = tbm.begin(); t != tbm.end(); ++t) {
  83                         request_buffers[t->emitting_thread] = static_cast<RequestBuffer*> (t->request_buffer);
  84                 }
  85         }
  86 }
  87
  88 template <typename RequestObject> void
  89 AbstractUI<RequestObject>::register_thread (pthread_t thread_id, string thread_name, uint32_t num_requests)
  90 {
  91         /* the calling thread wants to register with the thread that runs this
  92          * UI's event loop, so that it will have its own per-thread queue of
  93          * requests. this means that when it makes a request to this UI it can
  94          * do so in a realtime-safe manner (no locks).
  95          */
  96
  97         DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("in %1 (thread name %4), %2 (%5) wants to register with UIs\n", event_loop_name(), thread_name, pthread_name(), DEBUG_THREAD_SELF));
  98
  99         /* the per_thread_request_buffer is a thread-private variable.
 100            See pthreads documentation for more on these, but the key
 101            thing is that it is a variable that as unique value for
 102            each thread, guaranteed. Note that the thread in question
 103            is the caller of this function, which is assumed to be the
 104            thread from which signals will be emitted that this UI's
 105            event loop will catch.
 106         */
 107
 108         RequestBuffer* b = per_thread_request_buffer.get();
 109
 110         if (!b) {
 111
 112                 /* create a new request queue/ringbuffer */
 113
 114                 DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("create new request buffer for %1 in %2\n", thread_name, event_loop_name()));
 115
 116                 b = new RequestBuffer (num_requests);
 117                 /* set this thread's per_thread_request_buffer to this new
 118                    queue/ringbuffer. remember that only this thread will
 119                    get this queue when it calls per_thread_request_buffer.get()
 120
 121                    the second argument is a function that will be called
 122                    when the thread exits, and ensures that the buffer is marked
 123                    dead. it will then be deleted during a call to handle_ui_requests()
 124                 */
 125
 126                 per_thread_request_buffer.set (b);
 127         } else {
 128                 DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1 : %2 is already registered\n", event_loop_name(), thread_name));
 129         }
 130
 131         {
 132                 /* add the new request queue (ringbuffer) to our map
 133                    so that we can iterate over it when the time is right.
 134                    This step is not RT-safe, but is assumed to be called
 135                    only at thread initialization time, not repeatedly,
 136                    and so this is of little consequence.
 137                 */
 138                 Glib::Threads::Mutex::Lock rbml (request_buffer_map_lock);
 139                 request_buffers[thread_id] = b;
 140         }
 141
 142 }
 143
 144 template <typename RequestObject> RequestObject*
 145 AbstractUI<RequestObject>::get_request (RequestType rt)
 146 {
 147         RequestBuffer* rbuf = per_thread_request_buffer.get ();
 148         RequestBufferVector vec;
 149
 150         /* see comments in ::register_thread() above for an explanation of
 151            the per_thread_request_buffer variable
 152         */
 153
 154         if (rbuf != 0) {
 155
 156                 /* the calling thread has registered with this UI and therefore
 157                  * we have a per-thread request queue/ringbuffer. use it. this
 158                  * "allocation" of a request is RT-safe.
 159                  */
 160
 161                 rbuf->get_write_vector (&vec);
 162
 163                 if (vec.len[0] == 0) {
 164                         DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1: no space in per thread pool for request of type %2\n", event_loop_name(), rt));
 165                         return 0;
 166                 }
 167
 168                 DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1: allocated per-thread request of type %2, caller %3\n", event_loop_name(), rt, pthread_name()));
 169
 170                 vec.buf[0]->type = rt;
 171                 return vec.buf[0];
 172         }
 173
 174         /* calling thread has not registered, so just allocate a new request on
 175          * the heap. the lack of registration implies that realtime constraints
 176          * are not at work.
 177          */
 178
 179         DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1: allocated normal heap request of type %2, caller %3\n", event_loop_name(), rt, pthread_name()));
 180
 181         RequestObject* req = new RequestObject;
 182         req->type = rt;
 183
 184         return req;
 185 }
 186
 187 template <typename RequestObject> void
 188 AbstractUI<RequestObject>::handle_ui_requests ()
 189 {
 190         RequestBufferMapIterator i;
 191         RequestBufferVector vec;
 192
 193         /* check all registered per-thread buffers first */
 194         Glib::Threads::Mutex::Lock rbml (request_buffer_map_lock);
 195
 196         /* clean up any dead invalidation records (object was deleted) */
 197         trash.sort();
 198         trash.unique();
 199         for (std::list<InvalidationRecord*>::const_iterator r = trash.begin(); r != trash.end();) {
 200                 if (!(*r)->in_use ()) {
 201                         assert (!(*r)->valid ());
 202                         DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1 drop invalidation trash %2\n", event_loop_name(), *r));
 203                         std::list<InvalidationRecord*>::const_iterator tmp = r;
 204                         ++tmp;
 205                         delete *r;
 206                         trash.erase (r);
 207                         r = tmp;
 208                 } else {
 209                         ++r;
 210                 }
 211         }
 212 #ifndef NDEBUG
 213         if (trash.size() > 0) {
 214                 DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1 items in trash: %2\n", event_loop_name(), trash.size()));
 215         }
 216 #endif
 217
 218         DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1 check %2 request buffers for requests\n", event_loop_name(), request_buffers.size()));
 219
 220         for (i = request_buffers.begin(); i != request_buffers.end(); ++i) {
 221
 222                 while (!(*i).second->dead) {
 223
 224                         /* we must process requests 1 by 1 because
 225                          * the request may run a recursive main
 226                          * event loop that will itself call
 227                          * handle_ui_requests. when we return
 228                          * from the request handler, we cannot
 229                          * expect that the state of queued requests
 230                          * is even remotely consistent with
 231                          * the condition before we called it.
 232                          */
 233
 234                         i->second->get_read_vector (&vec);
 235
 236                         DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1 reading requests from RB[%2] @ %5, requests = %3 + %4\n",
 237                                                 event_loop_name(), std::distance (request_buffers.begin(), i), vec.len[0], vec.len[1], i->second));
 238
 239                         if (vec.len[0] == 0) {
 240                                 break;
 241                         } else {
 242                                 if (vec.buf[0]->invalidation && !vec.buf[0]->invalidation->valid ()) {
 243                                         DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1: skipping invalidated request\n", event_loop_name()));
 244                                         rbml.release ();
 245                                 } else {
 246
 247                                         DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1: valid request, unlocking before calling\n", event_loop_name()));
 248                                         rbml.release ();
 249
 250                                         DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1: valid request, calling ::do_request()\n", event_loop_name()));
 251                                         do_request (vec.buf[0]);
 252                                 }
 253
 254                                 /* if the request was CallSlot, then we need to ensure that we reset the functor in the request, in case it
 255                                  * held a shared_ptr<>. Failure to do so can lead to dangling references to objects passed to PBD::Signals.
 256                                  *
 257                                  * Note that this method (::handle_ui_requests()) is by definition called from the event loop thread, so
 258                                  * caller_is_self() is true, which means that the execution of the functor has definitely happened after
 259                                  * do_request() returns and we no longer need the functor for any reason.
 260                                  */
 261
 262                                 if (vec.buf[0]->type == CallSlot) {
 263                                         vec.buf[0]->the_slot = 0;
 264                                 }
 265
 266                                 rbml.acquire ();
 267                                 if (vec.buf[0]->invalidation) {
 268                                         vec.buf[0]->invalidation->unref ();
 269                                 }
 270                                 i->second->increment_read_ptr (1);
 271                         }
 272                 }
 273         }
 274
 275         assert (rbml.locked ());
 276         for (i = request_buffers.begin(); i != request_buffers.end(); ) {
 277                 if ((*i).second->dead) {
 278                         DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1/%2 deleting dead per-thread request buffer for %3 @ %4 (%5 requests)\n", event_loop_name(), pthread_name(), i->second, (*i).second->read_space()));
 279                         RequestBufferMapIterator tmp = i;
 280                         ++tmp;
 281                         /* remove it from the EventLoop static map of all request buffers */
 282                         EventLoop::remove_request_buffer_from_map ((*i).second);
 283                         /* delete it
 284                          *
 285                          * Deleting the ringbuffer destroys all RequestObjects
 286                          * and thereby drops any InvalidationRecord references of
 287                          * requests that have not been processed.
 288                          */
 289                         delete (*i).second;
 290                         /* remove it from this thread's list of request buffers */
 291                         request_buffers.erase (i);
 292                         i = tmp;
 293                 } else {
 294                         ++i;
 295                 }
 296         }
 297
 298         /* and now, the generic request buffer. same rules as above apply */
 299
 300         while (!request_list.empty()) {
 301                 assert (rbml.locked ());
 302                 RequestObject* req = request_list.front ();
 303                 request_list.pop_front ();
 304
 305                 /* we're about to execute this request, so its
 306                  * too late for any invalidation. mark
 307                  * the request as "done" before we start.
 308                  */
 309
 310                 if (req->invalidation && !req->invalidation->valid()) {
 311                         DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1/%2 handling invalid heap request, type %3, deleting\n", event_loop_name(), pthread_name(), req->type));
 312                         delete req;
 313                         continue;
 314                 }
 315
 316                 /* at this point, an object involved in a functor could be
 317                  * deleted before we actually execute the functor. so there is
 318                  * a race condition that makes the invalidation architecture
 319                  * somewhat pointless.
 320                  *
 321                  * really, we should only allow functors containing shared_ptr
 322                  * references to objects to enter into the request queue.
 323                  */
 324
 325                 /* unlock the request lock while we execute the request, so
 326                  * that we don't needlessly block other threads (note: not RT
 327                  * threads since they have their own queue) from making requests.
 328                  */
 329
 330                 /* also the request may destroy the object itself resulting in a direct
 331                  * path to EventLoop::invalidate_request () from here
 332                  * which takes the lock */
 333
 334                 rbml.release ();
 335
 336                 DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1/%2 execute request type %3\n", event_loop_name(), pthread_name(), req->type));
 337
 338                 /* and lets do it ... this is a virtual call so that each
 339                  * specific type of UI can have its own set of requests without
 340                  * some kind of central request type registration logic
 341                  */
 342
 343                 do_request (req);
 344
 345                 DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1/%2 delete heap request type %3\n", event_loop_name(), pthread_name(), req->type));
 346                 delete req;
 347
 348                 /* re-acquire the list lock so that we check again */
 349
 350                 rbml.acquire();
 351         }
 352
 353         rbml.release ();
 354 }
 355
 356 template <typename RequestObject> void
 357 AbstractUI<RequestObject>::send_request (RequestObject *req)
 358 {
 359         /* This is called to ask a given UI to carry out a request. It may be
 360          * called from the same thread that runs the UI's event loop (see the
 361          * caller_is_self() case below), or from any other thread.
 362          */
 363
 364         if (base_instance() == 0) {
 365                 delete req;
 366                 return; /* XXX is this the right thing to do ? */
 367         }
 368
 369         if (caller_is_self ()) {
 370                 /* the thread that runs this UI's event loop is sending itself
 371                    a request: we dispatch it immediately and inline.
 372                 */
 373                 DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1/%2 direct dispatch of request type %3\n", event_loop_name(), pthread_name(), req->type));
 374                 do_request (req);
 375                 delete req;
 376         } else {
 377
 378                 /* If called from a different thread, we first check to see if
 379                  * the calling thread is registered with this UI. If so, there
 380                  * is a per-thread ringbuffer of requests that ::get_request()
 381                  * just set up a new request in. If so, all we need do here is
 382                  * to advance the write ptr in that ringbuffer so that the next
 383                  * request by this calling thread will use the next slot in
 384                  * the ringbuffer. The ringbuffer has
 385                  * single-reader/single-writer semantics because the calling
 386                  * thread is the only writer, and the UI event loop is the only
 387                  * reader.
 388                  */
 389
 390                 RequestBuffer* rbuf = per_thread_request_buffer.get ();
 391
 392                 if (rbuf != 0) {
 393                         DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1/%2 send per-thread request type %3 using ringbuffer @ %4 IR: %5\n", event_loop_name(), pthread_name(), req->type, rbuf, req->invalidation));
 394                         rbuf->increment_write_ptr (1);
 395                 } else {
 396                         /* no per-thread buffer, so just use a list with a lock so that it remains
 397                          * single-reader/single-writer semantics
 398                          */
 399                         DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1/%2 send heap request type %3 IR %4\n", event_loop_name(), pthread_name(), req->type, req->invalidation));
 400                         Glib::Threads::Mutex::Lock lm (request_buffer_map_lock);
 401                         request_list.push_back (req);
 402                 }
 403
 404                 /* send the UI event loop thread a wakeup so that it will look
 405                    at the per-thread and generic request lists.
 406                 */
 407
 408                 signal_new_request ();
 409         }
 410 }
 411
 412 template<typename RequestObject> void
 413 AbstractUI<RequestObject>::call_slot (InvalidationRecord* invalidation, const boost::function<void()>& f)
 414 {
 415         if (caller_is_self()) {
 416                 DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1/%2 direct dispatch of call slot via functor @ %3, invalidation %4\n", event_loop_name(), pthread_name(), &f, invalidation));
 417                 f ();
 418                 return;
 419         }
 420
 421         if (invalidation) {
 422                 Glib::Threads::Mutex::Lock lm (request_buffer_map_lock); //  -- remove this once signal connect/disconnect uses ir->un/ref()
 423                 if (!invalidation->valid()) {
 424                         DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1/%2 ignoring call-slot using functor @ %3, dead invalidation %4\n", event_loop_name(), pthread_name(), &f, invalidation));
 425                         return;
 426                 }
 427                 invalidation->ref ();
 428                 assert (invalidation->event_loop == this);
 429                 invalidation->event_loop = this; // XXX is this needed,  PBD::signal::connect sets it
 430         }
 431
 432         RequestObject *req = get_request (BaseUI::CallSlot);
 433
 434         if (req == 0) {
 435                 if (invalidation) {
 436                         invalidation->unref ();
 437                 }
 438                 return;
 439         }
 440
 441         DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1/%2 queue call-slot using functor @ %3, invalidation %4\n", event_loop_name(), pthread_name(), &f, invalidation));
 442
 443         /* copy semantics: copy the functor into the request object */
 444
 445         req->the_slot = f;
 446
 447         /* the invalidation record is an object which will carry out
 448          * invalidation of any requests associated with it when it is
 449          * destroyed. it can be null. if its not null, associate this
 450          * request with the invalidation record. this allows us to
 451          * "cancel" requests submitted to the UI because they involved
 452          * a functor that uses an object that is being deleted.
 453          */
 454
 455         req->invalidation = invalidation;
 456
 457         send_request (req);
 458 }
 459
 460 template<typename RequestObject> void*
 461 AbstractUI<RequestObject>::request_buffer_factory (uint32_t num_requests)
 462 {
 463         RequestBuffer*  mcr = new RequestBuffer (num_requests); // leaks
 464         per_thread_request_buffer.set (mcr);
 465         return mcr;
 466 }