libs/ardour/graph.cc

   1 /*
   2   Copyright (C) 2010 Paul Davis
   3   Author: Torben Hohn
   4
   5   This program is free software; you can redistribute it and/or modify
   6   it under the terms of the GNU General Public License as published by
   7   the Free Software Foundation; either version 2 of the License, or
   8   (at your option) any later version.
   9
  10   This program is distributed in the hope that it will be useful,
  11   but WITHOUT ANY WARRANTY; without even the implied warranty of
  12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13   GNU General Public License for more details.
  14
  15   You should have received a copy of the GNU General Public License
  16   along with this program; if not, write to the Free Software
  17   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20 #include <stdio.h>
  21 #include <cmath>
  22
  23 #include "pbd/compose.h"
  24 #include "pbd/debug_rt_alloc.h"
  25
  26 #include "ardour/debug.h"
  27 #include "ardour/graph.h"
  28 #include "ardour/types.h"
  29 #include "ardour/session.h"
  30 #include "ardour/route.h"
  31 #include "ardour/process_thread.h"
  32 #include "ardour/audioengine.h"
  33
  34 #include <jack/thread.h>
  35
  36 #include "i18n.h"
  37
  38 using namespace ARDOUR;
  39 using namespace PBD;
  40 using namespace std;
  41
  42 #ifdef DEBUG_RT_ALLOC
  43 static Graph* graph = 0;
  44
  45 extern "C" {
  46
  47 int alloc_allowed ()
  48 {
  49         return !graph->in_process_thread ();
  50 }
  51
  52 }
  53 #endif
  54
  55 Graph::Graph (Session & session)
  56         : SessionHandleRef (session)
  57         , _quit_threads (false)
  58         , _execution_sem ("graph_execution", 0)
  59         , _callback_start_sem ("graph_start", 0)
  60         , _callback_done_sem ("graph_done", 0)
  61         , _cleanup_sem ("graph_cleanup", 0)
  62 {
  63         pthread_mutex_init( &_trigger_mutex, NULL);
  64
  65         /* XXX: rather hacky `fix' to stop _trigger_queue.push_back() allocating
  66            memory in the RT thread.
  67         */
  68         _trigger_queue.reserve (8192);
  69
  70         _execution_tokens = 0;
  71
  72         _current_chain = 0;
  73         _pending_chain = 0;
  74         _setup_chain   = 1;
  75         _quit_threads = false;
  76         _graph_empty = true;
  77
  78         reset_thread_list ();
  79
  80         Config->ParameterChanged.connect_same_thread (processor_usage_connection, boost::bind (&Graph::parameter_changed, this, _1));
  81
  82 #ifdef DEBUG_RT_ALLOC
  83         graph = this;
  84         pbd_alloc_allowed = &::alloc_allowed;
  85 #endif
  86 }
  87
  88 void
  89 Graph::parameter_changed (std::string param)
  90 {
  91         if (param == X_("processor-usage")) {
  92                 reset_thread_list ();
  93         }
  94 }
  95
  96 /** Set up threads for running the graph */
  97 void
  98 Graph::reset_thread_list ()
  99 {
 100         uint32_t num_threads = how_many_dsp_threads ();
 101
 102         /* don't bother doing anything here if we already have the right
 103            number of threads.
 104         */
 105
 106         if (_thread_list.size() == num_threads) {
 107                 return;
 108         }
 109
 110         Glib::Mutex::Lock lm (_session.engine().process_lock());
 111         pthread_t a_thread;
 112
 113         if (!_thread_list.empty()) {
 114                 drop_threads ();
 115         }
 116
 117 #if 0
 118         /* XXX this only makes sense when we can use just the AudioEngine thread
 119            and still keep the graph current with the route list
 120         */
 121         if (num_threads <= 1) {
 122                 /* no point creating 1 thread - the AudioEngine already gives us one
 123                  */
 124                 return;
 125         }
 126 #endif
 127         if (AudioEngine::instance()->create_process_thread (boost::bind (&Graph::main_thread, this), &a_thread, 100000) == 0) {
 128                 _thread_list.push_back (a_thread);
 129         }
 130
 131         for (uint32_t i = 1; i < num_threads; ++i) {
 132                 if (AudioEngine::instance()->create_process_thread (boost::bind (&Graph::helper_thread, this), &a_thread, 100000) == 0) {
 133                         _thread_list.push_back (a_thread);
 134                 }
 135         }
 136 }
 137
 138 void
 139 Graph::session_going_away()
 140 {
 141         drop_threads ();
 142
 143         // now drop all references on the nodes.
 144         _nodes_rt[0].clear();
 145         _nodes_rt[1].clear();
 146         _init_trigger_list[0].clear();
 147         _init_trigger_list[1].clear();
 148         _trigger_queue.clear();
 149 }
 150
 151 void
 152 Graph::drop_threads ()
 153 {
 154         _quit_threads = true;
 155
 156         for (unsigned int i=0; i< _thread_list.size(); i++) {
 157                 _execution_sem.signal ();
 158         }
 159
 160         _callback_start_sem.signal ();
 161
 162         for (list<pthread_t>::iterator i = _thread_list.begin(); i != _thread_list.end(); ++i) {
 163                 void* status;
 164                 pthread_join (*i, &status);
 165         }
 166
 167         _thread_list.clear ();
 168
 169         _execution_tokens = 0;
 170
 171         _quit_threads = false;
 172 }
 173
 174 void
 175 Graph::clear_other_chain ()
 176 {
 177         Glib::Mutex::Lock ls (_swap_mutex);
 178
 179         while (1) {
 180                 if (_setup_chain != _pending_chain) {
 181
 182                         for (node_list_t::iterator ni=_nodes_rt[_setup_chain].begin(); ni!=_nodes_rt[_setup_chain].end(); ni++) {
 183                                 (*ni)->_activation_set[_setup_chain].clear();
 184                         }
 185
 186                         _nodes_rt[_setup_chain].clear ();
 187                         _init_trigger_list[_setup_chain].clear ();
 188                         break;
 189                 }
 190                 /* setup chain == pending chain - we have
 191                    to wait till this is no longer true.
 192                 */
 193                 _cleanup_cond.wait (_swap_mutex);
 194         }
 195 }
 196
 197 void
 198 Graph::prep()
 199 {
 200         node_list_t::iterator i;
 201         int chain;
 202
 203         if (_swap_mutex.trylock()) {
 204                 // we got the swap mutex.
 205                 if (_current_chain != _pending_chain)
 206                 {
 207                         // printf ("chain swap ! %d -> %d\n", _current_chain, _pending_chain);
 208                         _setup_chain = _current_chain;
 209                         _current_chain = _pending_chain;
 210                         _cleanup_cond.signal ();
 211                 }
 212                 _swap_mutex.unlock ();
 213         }
 214
 215         chain = _current_chain;
 216
 217         _graph_empty = true;
 218         for (i=_nodes_rt[chain].begin(); i!=_nodes_rt[chain].end(); i++) {
 219                 (*i)->prep( chain);
 220                 _graph_empty = false;
 221         }
 222         _finished_refcount = _init_finished_refcount[chain];
 223
 224         /* Trigger the initial nodes for processing, which are the ones at the `input' end */
 225         pthread_mutex_lock (&_trigger_mutex);
 226         for (i=_init_trigger_list[chain].begin(); i!=_init_trigger_list[chain].end(); i++) {
 227                 /* don't use ::trigger here, as we have already locked the mutex */
 228                 _trigger_queue.push_back (i->get ());
 229         }
 230         pthread_mutex_unlock (&_trigger_mutex);
 231 }
 232
 233 void
 234 Graph::trigger (GraphNode* n)
 235 {
 236         pthread_mutex_lock (&_trigger_mutex);
 237         _trigger_queue.push_back (n);
 238         pthread_mutex_unlock (&_trigger_mutex);
 239 }
 240
 241 /** Called when a node at the `output' end of the chain (ie one that has no-one to feed)
 242  *  is finished.
 243  */
 244 void
 245 Graph::dec_ref()
 246 {
 247         if (g_atomic_int_dec_and_test (&_finished_refcount)) {
 248
 249                 /* We have run all the nodes that are at the `output' end of
 250                    the graph, so there is nothing more to do this time around.
 251                 */
 252
 253                 restart_cycle ();
 254         }
 255 }
 256
 257 void
 258 Graph::restart_cycle()
 259 {
 260         // we are through. wakeup our caller.
 261
 262   again:
 263         _callback_done_sem.signal ();
 264
 265         /* Block until the a process callback triggers us */
 266         _callback_start_sem.wait();
 267
 268         if (_quit_threads) {
 269                 return;
 270         }
 271
 272         prep ();
 273
 274         if (_graph_empty) {
 275                 goto again;
 276         }
 277
 278         // returning will restart the cycle.
 279         // starting with waking up the others.
 280 }
 281
 282 /** Rechain our stuff using a list of routes (which can be in any order) and
 283  *  a directed graph of their interconnections, which is guaranteed to be
 284  *  acyclic.
 285  */
 286
 287 void
 288 Graph::rechain (boost::shared_ptr<RouteList> routelist, GraphEdges const & edges)
 289 {
 290         Glib::Mutex::Lock ls (_swap_mutex);
 291
 292         int chain = _setup_chain;
 293         DEBUG_TRACE (DEBUG::Graph, string_compose ("============== setup %1\n", chain));
 294
 295         /* This will become the number of nodes that do not feed any other node;
 296            once we have processed this number of those nodes, we have finished.
 297         */
 298         _init_finished_refcount[chain] = 0;
 299
 300         /* This will become a list of nodes that are not fed by another node, ie
 301            those at the `input' end.
 302         */
 303         _init_trigger_list[chain].clear();
 304
 305         _nodes_rt[chain].clear();
 306
 307         /* Clear things out, and make _nodes_rt[chain] a copy of routelist */
 308         for (RouteList::iterator ri=routelist->begin(); ri!=routelist->end(); ri++) {
 309                 (*ri)->_init_refcount[chain] = 0;
 310                 (*ri)->_activation_set[chain].clear();
 311                 _nodes_rt[chain].push_back (*ri);
 312         }
 313
 314         // now add refs for the connections.
 315
 316         for (node_list_t::iterator ni = _nodes_rt[chain].begin(); ni != _nodes_rt[chain].end(); ni++) {
 317
 318                 boost::shared_ptr<Route> r = boost::dynamic_pointer_cast<Route> (*ni);
 319
 320                 /* The routes that are directly fed by r */
 321                 set<GraphVertex> fed_from_r = edges.from (r);
 322
 323                 /* Hence whether r has an output */
 324                 bool const has_output = !fed_from_r.empty ();
 325
 326                 /* Set up r's activation set */
 327                 for (set<GraphVertex>::iterator i = fed_from_r.begin(); i != fed_from_r.end(); ++i) {
 328                         r->_activation_set[chain].insert (*i);
 329                 }
 330
 331                 /* r has an input if there are some incoming edges to r in the graph */
 332                 bool const has_input = !edges.has_none_to (r);
 333
 334                 /* Increment the refcount of any route that we directly feed */
 335                 for (node_set_t::iterator ai = r->_activation_set[chain].begin(); ai != r->_activation_set[chain].end(); ai++) {
 336                         (*ai)->_init_refcount[chain] += 1;
 337                 }
 338
 339                 if (!has_input) {
 340                         /* no input, so this node needs to be triggered initially to get things going */
 341                         _init_trigger_list[chain].push_back (*ni);
 342                 }
 343
 344                 if (!has_output) {
 345                         /* no output, so this is one of the nodes that we can count off to decide
 346                            if we've finished
 347                         */
 348                         _init_finished_refcount[chain] += 1;
 349                 }
 350         }
 351
 352         _pending_chain = chain;
 353         dump(chain);
 354 }
 355
 356 /** Called by both the main thread and all helpers.
 357  *  @return true to quit, false to carry on.
 358  */
 359 bool
 360 Graph::run_one()
 361 {
 362         GraphNode* to_run;
 363
 364         pthread_mutex_lock (&_trigger_mutex);
 365         if (_trigger_queue.size()) {
 366                 to_run = _trigger_queue.back();
 367                 _trigger_queue.pop_back();
 368         } else {
 369                 to_run = 0;
 370         }
 371
 372         /* the number of threads that are asleep */
 373         int et = _execution_tokens;
 374         /* the number of nodes that need to be run */
 375         int ts = _trigger_queue.size();
 376
 377         /* hence how many threads to wake up */
 378         int wakeup = min (et, ts);
 379         /* update the number of threads that will still be sleeping */
 380         _execution_tokens -= wakeup;
 381
 382         DEBUG_TRACE(DEBUG::ProcessThreads, string_compose ("%1 signals %2\n", pthread_self(), wakeup));
 383
 384         for (int i = 0; i < wakeup; i++) {
 385                 _execution_sem.signal ();
 386         }
 387
 388         while (to_run == 0) {
 389                 _execution_tokens += 1;
 390                 pthread_mutex_unlock (&_trigger_mutex);
 391                 DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("%1 goes to sleep\n", pthread_self()));
 392                 _execution_sem.wait ();
 393                 if (_quit_threads) {
 394                         return true;
 395                 }
 396                 DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("%1 is awake\n", pthread_self()));
 397                 pthread_mutex_lock (&_trigger_mutex);
 398                 if (_trigger_queue.size()) {
 399                         to_run = _trigger_queue.back();
 400                         _trigger_queue.pop_back();
 401                 }
 402         }
 403         pthread_mutex_unlock (&_trigger_mutex);
 404
 405         to_run->process();
 406         to_run->finish (_current_chain);
 407
 408         DEBUG_TRACE(DEBUG::ProcessThreads, string_compose ("%1 has finished run_one()\n", pthread_self()));
 409
 410         return false;
 411 }
 412
 413 void
 414 Graph::helper_thread()
 415 {
 416         suspend_rt_malloc_checks ();
 417         ProcessThread* pt = new ProcessThread ();
 418         resume_rt_malloc_checks ();
 419
 420         pt->get_buffers();
 421
 422         while(1) {
 423                 if (run_one()) {
 424                         break;
 425                 }
 426         }
 427
 428         pt->drop_buffers();
 429 }
 430
 431 /** Here's the main graph thread */
 432 void
 433 Graph::main_thread()
 434 {
 435         suspend_rt_malloc_checks ();
 436         ProcessThread* pt = new ProcessThread ();
 437         resume_rt_malloc_checks ();
 438
 439         pt->get_buffers();
 440
 441   again:
 442         _callback_start_sem.wait ();
 443
 444         DEBUG_TRACE(DEBUG::ProcessThreads, "main thread is awake\n");
 445
 446         if (_quit_threads) {
 447                 return;
 448         }
 449
 450         prep ();
 451
 452         if (_graph_empty && !_quit_threads) {
 453                 _callback_done_sem.signal ();
 454                 DEBUG_TRACE(DEBUG::ProcessThreads, "main thread sees graph done, goes back to sleep\n");
 455                 goto again;
 456         }
 457
 458         /* This loop will run forever */
 459         while (1) {
 460                 DEBUG_TRACE(DEBUG::ProcessThreads, "main thread runs one graph node\n");
 461                 if (run_one()) {
 462                         break;
 463                 }
 464         }
 465
 466         pt->drop_buffers();
 467 }
 468
 469 void
 470 Graph::dump (int chain)
 471 {
 472 #ifndef NDEBUG
 473         node_list_t::iterator ni;
 474         node_set_t::iterator ai;
 475
 476         chain = _pending_chain;
 477
 478         DEBUG_TRACE (DEBUG::Graph, "--------------------------------------------Graph dump:\n");
 479         for (ni=_nodes_rt[chain].begin(); ni!=_nodes_rt[chain].end(); ni++) {
 480                 boost::shared_ptr<Route> rp = boost::dynamic_pointer_cast<Route>( *ni);
 481                 DEBUG_TRACE (DEBUG::Graph, string_compose ("GraphNode: %1  refcount: %2\n", rp->name().c_str(), (*ni)->_init_refcount[chain]));
 482                 for (ai=(*ni)->_activation_set[chain].begin(); ai!=(*ni)->_activation_set[chain].end(); ai++) {
 483                         DEBUG_TRACE (DEBUG::Graph, string_compose ("  triggers: %1\n", boost::dynamic_pointer_cast<Route>(*ai)->name().c_str()));
 484                 }
 485         }
 486
 487         DEBUG_TRACE (DEBUG::Graph, "------------- trigger list:\n");
 488         for (ni=_init_trigger_list[chain].begin(); ni!=_init_trigger_list[chain].end(); ni++) {
 489                 DEBUG_TRACE (DEBUG::Graph, string_compose ("GraphNode: %1  refcount: %2\n", boost::dynamic_pointer_cast<Route>(*ni)->name().c_str(), (*ni)->_init_refcount[chain]));
 490         }
 491
 492         DEBUG_TRACE (DEBUG::Graph, string_compose ("final activation refcount: %1\n", _init_finished_refcount[chain]));
 493 #endif
 494 }
 495
 496 int
 497 Graph::silent_process_routes (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool& need_butler)
 498 {
 499         _process_nframes = nframes;
 500         _process_start_frame = start_frame;
 501         _process_end_frame = end_frame;
 502
 503         _process_silent = true;
 504         _process_noroll = false;
 505         _process_retval = 0;
 506         _process_need_butler = false;
 507
 508         if (!_graph_empty) {
 509                 DEBUG_TRACE(DEBUG::ProcessThreads, "wake graph for silent process\n");
 510                 _callback_start_sem.signal ();
 511                 _callback_done_sem.wait ();
 512         }
 513
 514         need_butler = _process_need_butler;
 515
 516         return _process_retval;
 517 }
 518
 519 int
 520 Graph::process_routes (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& need_butler)
 521 {
 522         DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("graph execution from %1 to %2 = %3\n", start_frame, end_frame, nframes));
 523
 524         _process_nframes = nframes;
 525         _process_start_frame = start_frame;
 526         _process_end_frame = end_frame;
 527         _process_declick = declick;
 528
 529         _process_silent = false;
 530         _process_noroll = false;
 531         _process_retval = 0;
 532         _process_need_butler = false;
 533
 534         DEBUG_TRACE(DEBUG::ProcessThreads, "wake graph for non-silent process\n");
 535         _callback_start_sem.signal ();
 536         _callback_done_sem.wait ();
 537
 538         DEBUG_TRACE (DEBUG::ProcessThreads, "graph execution complete\n");
 539
 540         need_butler = _process_need_butler;
 541
 542         return _process_retval;
 543 }
 544
 545 int
 546 Graph::routes_no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
 547                        bool non_rt_pending, int declick)
 548 {
 549         DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("no-roll graph execution from %1 to %2 = %3\n", start_frame, end_frame, nframes));
 550
 551         _process_nframes = nframes;
 552         _process_start_frame = start_frame;
 553         _process_end_frame = end_frame;
 554         _process_declick = declick;
 555         _process_non_rt_pending = non_rt_pending;
 556
 557         _process_silent = false;
 558         _process_noroll = true;
 559         _process_retval = 0;
 560         _process_need_butler = false;
 561
 562         DEBUG_TRACE(DEBUG::ProcessThreads, "wake graph for no-roll process\n");
 563         _callback_start_sem.signal ();
 564         _callback_done_sem.wait ();
 565
 566         return _process_retval;
 567 }
 568 void
 569 Graph::process_one_route (Route* route)
 570 {
 571         bool need_butler = false;
 572         int retval;
 573
 574         assert (route);
 575
 576         DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("%1 runs route %2\n", pthread_self(), route->name()));
 577
 578         if (_process_silent) {
 579                 retval = route->silent_roll (_process_nframes, _process_start_frame, _process_end_frame, need_butler);
 580         } else if (_process_noroll) {
 581                 route->set_pending_declick (_process_declick);
 582                 retval = route->no_roll (_process_nframes, _process_start_frame, _process_end_frame, _process_non_rt_pending);
 583         } else {
 584                 route->set_pending_declick (_process_declick);
 585                 retval = route->roll (_process_nframes, _process_start_frame, _process_end_frame, _process_declick, need_butler);
 586         }
 587
 588         if (retval) {
 589                 _process_retval = retval;
 590         }
 591
 592         if (need_butler) {
 593                 _process_need_butler = true;
 594         }
 595 }
 596
 597 bool
 598 Graph::in_process_thread () const
 599 {
 600         list<pthread_t>::const_iterator i = _thread_list.begin ();
 601         while (i != _thread_list.end() && *i != pthread_self ()) {
 602                 ++i;
 603         }
 604
 605         return i != _thread_list.end ();
 606 }