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         for (i=_init_trigger_list[chain].begin(); i!=_init_trigger_list[chain].end(); i++) {
 226                 trigger (i->get ());
 227         }
 228 }
 229
 230 void
 231 Graph::trigger (GraphNode* n)
 232 {
 233         pthread_mutex_lock (&_trigger_mutex);
 234         _trigger_queue.push_back (n);
 235         pthread_mutex_unlock (&_trigger_mutex);
 236 }
 237
 238 /** Called when a node at the `output' end of the chain (ie one that has no-one to feed)
 239  *  is finished.
 240  */
 241 void
 242 Graph::dec_ref()
 243 {
 244         if (g_atomic_int_dec_and_test (&_finished_refcount)) {
 245
 246                 /* We have run all the nodes that are at the `output' end of
 247                    the graph, so there is nothing more to do this time around.
 248                 */
 249
 250                 restart_cycle ();
 251         }
 252 }
 253
 254 void
 255 Graph::restart_cycle()
 256 {
 257         // we are through. wakeup our caller.
 258
 259   again:
 260         _callback_done_sem.signal ();
 261
 262         /* Block until the a process callback triggers us */
 263         _callback_start_sem.wait();
 264
 265         if (_quit_threads) {
 266                 return;
 267         }
 268
 269         prep ();
 270
 271         if (_graph_empty) {
 272                 goto again;
 273         }
 274
 275         // returning will restart the cycle.
 276         // starting with waking up the others.
 277 }
 278
 279 /** Rechain our stuff using a list of routes (which can be in any order) and
 280  *  a directed graph of their interconnections, which is guaranteed to be
 281  *  acyclic.
 282  */
 283
 284 void
 285 Graph::rechain (boost::shared_ptr<RouteList> routelist, GraphEdges const & edges)
 286 {
 287         Glib::Mutex::Lock ls (_swap_mutex);
 288
 289         int chain = _setup_chain;
 290         DEBUG_TRACE (DEBUG::Graph, string_compose ("============== setup %1\n", chain));
 291
 292         /* This will become the number of nodes that do not feed any other node;
 293            once we have processed this number of those nodes, we have finished.
 294         */
 295         _init_finished_refcount[chain] = 0;
 296
 297         /* This will become a list of nodes that are not fed by another node, ie
 298            those at the `input' end.
 299         */
 300         _init_trigger_list[chain].clear();
 301
 302         _nodes_rt[chain].clear();
 303
 304         /* Clear things out, and make _nodes_rt[chain] a copy of routelist */
 305         for (RouteList::iterator ri=routelist->begin(); ri!=routelist->end(); ri++) {
 306                 (*ri)->_init_refcount[chain] = 0;
 307                 (*ri)->_activation_set[chain].clear();
 308                 _nodes_rt[chain].push_back (*ri);
 309         }
 310
 311         // now add refs for the connections.
 312
 313         for (node_list_t::iterator ni = _nodes_rt[chain].begin(); ni != _nodes_rt[chain].end(); ni++) {
 314
 315                 boost::shared_ptr<Route> r = boost::dynamic_pointer_cast<Route> (*ni);
 316
 317                 /* The routes that are directly fed by r */
 318                 set<GraphVertex> fed_from_r = edges.from (r);
 319
 320                 /* Hence whether r has an output */
 321                 bool const has_output = !fed_from_r.empty ();
 322
 323                 /* Set up r's activation set */
 324                 for (set<GraphVertex>::iterator i = fed_from_r.begin(); i != fed_from_r.end(); ++i) {
 325                         r->_activation_set[chain].insert (*i);
 326                 }
 327
 328                 /* r has an input if there are some incoming edges to r in the graph */
 329                 bool const has_input = !edges.has_none_to (r);
 330
 331                 /* Increment the refcount of any route that we directly feed */
 332                 for (node_set_t::iterator ai = r->_activation_set[chain].begin(); ai != r->_activation_set[chain].end(); ai++) {
 333                         (*ai)->_init_refcount[chain] += 1;
 334                 }
 335
 336                 if (!has_input) {
 337                         /* no input, so this node needs to be triggered initially to get things going */
 338                         _init_trigger_list[chain].push_back (*ni);
 339                 }
 340
 341                 if (!has_output) {
 342                         /* no output, so this is one of the nodes that we can count off to decide
 343                            if we've finished
 344                         */
 345                         _init_finished_refcount[chain] += 1;
 346                 }
 347         }
 348
 349         _pending_chain = chain;
 350         dump(chain);
 351 }
 352
 353 /** Called by both the main thread and all helpers.
 354  *  @return true to quit, false to carry on.
 355  */
 356 bool
 357 Graph::run_one()
 358 {
 359         GraphNode* to_run;
 360
 361         pthread_mutex_lock (&_trigger_mutex);
 362         if (_trigger_queue.size()) {
 363                 to_run = _trigger_queue.back();
 364                 _trigger_queue.pop_back();
 365         } else {
 366                 to_run = 0;
 367         }
 368
 369         /* the number of threads that are asleep */
 370         int et = _execution_tokens;
 371         /* the number of nodes that need to be run */
 372         int ts = _trigger_queue.size();
 373
 374         /* hence how many threads to wake up */
 375         int wakeup = min (et, ts);
 376         /* update the number of threads that will still be sleeping */
 377         _execution_tokens -= wakeup;
 378
 379         DEBUG_TRACE(DEBUG::ProcessThreads, string_compose ("%1 signals %2\n", pthread_self(), wakeup));
 380
 381         for (int i = 0; i < wakeup; i++) {
 382                 _execution_sem.signal ();
 383         }
 384
 385         while (to_run == 0) {
 386                 _execution_tokens += 1;
 387                 pthread_mutex_unlock (&_trigger_mutex);
 388                 DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("%1 goes to sleep\n", pthread_self()));
 389                 _execution_sem.wait ();
 390                 if (_quit_threads) {
 391                         return true;
 392                 }
 393                 DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("%1 is awake\n", pthread_self()));
 394                 pthread_mutex_lock (&_trigger_mutex);
 395                 if (_trigger_queue.size()) {
 396                         to_run = _trigger_queue.back();
 397                         _trigger_queue.pop_back();
 398                 }
 399         }
 400         pthread_mutex_unlock (&_trigger_mutex);
 401
 402         to_run->process();
 403         to_run->finish (_current_chain);
 404
 405         DEBUG_TRACE(DEBUG::ProcessThreads, string_compose ("%1 has finished run_one()\n", pthread_self()));
 406
 407         return false;
 408 }
 409
 410 static void get_rt()
 411 {
 412         if (!jack_is_realtime (AudioEngine::instance()->jack())) {
 413                 return;
 414         }
 415
 416         int priority = jack_client_real_time_priority (AudioEngine::instance()->jack());
 417
 418         if (priority) {
 419                 struct sched_param rtparam;
 420
 421                 memset (&rtparam, 0, sizeof (rtparam));
 422                 rtparam.sched_priority = priority;
 423
 424                 pthread_setschedparam (pthread_self(), SCHED_FIFO, &rtparam);
 425         }
 426 }
 427
 428 void
 429 Graph::helper_thread()
 430 {
 431         suspend_rt_malloc_checks ();
 432         ProcessThread* pt = new ProcessThread ();
 433         resume_rt_malloc_checks ();
 434
 435         pt->get_buffers();
 436         get_rt();
 437
 438         while(1) {
 439                 if (run_one()) {
 440                         break;
 441                 }
 442         }
 443
 444         pt->drop_buffers();
 445 }
 446
 447 /** Here's the main graph thread */
 448 void
 449 Graph::main_thread()
 450 {
 451         suspend_rt_malloc_checks ();
 452         ProcessThread* pt = new ProcessThread ();
 453         resume_rt_malloc_checks ();
 454
 455         pt->get_buffers();
 456         get_rt();
 457
 458   again:
 459         _callback_start_sem.wait ();
 460
 461         DEBUG_TRACE(DEBUG::ProcessThreads, "main thread is awake\n");
 462
 463         if (_quit_threads) {
 464                 return;
 465         }
 466
 467         prep ();
 468
 469         if (_graph_empty && !_quit_threads) {
 470                 _callback_done_sem.signal ();
 471                 DEBUG_TRACE(DEBUG::ProcessThreads, "main thread sees graph done, goes back to sleep\n");
 472                 goto again;
 473         }
 474
 475         /* This loop will run forever */
 476         while (1) {
 477                 DEBUG_TRACE(DEBUG::ProcessThreads, "main thread runs one graph node\n");
 478                 if (run_one()) {
 479                         break;
 480                 }
 481         }
 482
 483         pt->drop_buffers();
 484 }
 485
 486 void
 487 Graph::dump (int chain)
 488 {
 489 #ifndef NDEBUG
 490         node_list_t::iterator ni;
 491         node_set_t::iterator ai;
 492
 493         chain = _pending_chain;
 494
 495         DEBUG_TRACE (DEBUG::Graph, "--------------------------------------------Graph dump:\n");
 496         for (ni=_nodes_rt[chain].begin(); ni!=_nodes_rt[chain].end(); ni++) {
 497                 boost::shared_ptr<Route> rp = boost::dynamic_pointer_cast<Route>( *ni);
 498                 DEBUG_TRACE (DEBUG::Graph, string_compose ("GraphNode: %1  refcount: %2\n", rp->name().c_str(), (*ni)->_init_refcount[chain]));
 499                 for (ai=(*ni)->_activation_set[chain].begin(); ai!=(*ni)->_activation_set[chain].end(); ai++) {
 500                         DEBUG_TRACE (DEBUG::Graph, string_compose ("  triggers: %1\n", boost::dynamic_pointer_cast<Route>(*ai)->name().c_str()));
 501                 }
 502         }
 503
 504         DEBUG_TRACE (DEBUG::Graph, "------------- trigger list:\n");
 505         for (ni=_init_trigger_list[chain].begin(); ni!=_init_trigger_list[chain].end(); ni++) {
 506                 DEBUG_TRACE (DEBUG::Graph, string_compose ("GraphNode: %1  refcount: %2\n", boost::dynamic_pointer_cast<Route>(*ni)->name().c_str(), (*ni)->_init_refcount[chain]));
 507         }
 508
 509         DEBUG_TRACE (DEBUG::Graph, string_compose ("final activation refcount: %1\n", _init_finished_refcount[chain]));
 510 #endif
 511 }
 512
 513 int
 514 Graph::silent_process_routes (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool& need_butler)
 515 {
 516         _process_nframes = nframes;
 517         _process_start_frame = start_frame;
 518         _process_end_frame = end_frame;
 519
 520         _process_silent = true;
 521         _process_noroll = false;
 522         _process_retval = 0;
 523         _process_need_butler = false;
 524
 525         if (!_graph_empty) {
 526                 DEBUG_TRACE(DEBUG::ProcessThreads, "wake graph for silent process\n");
 527                 _callback_start_sem.signal ();
 528                 _callback_done_sem.wait ();
 529         }
 530
 531         need_butler = _process_need_butler;
 532
 533         return _process_retval;
 534 }
 535
 536 int
 537 Graph::process_routes (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& need_butler)
 538 {
 539         DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("graph execution from %1 to %2 = %3\n", start_frame, end_frame, nframes));
 540
 541         _process_nframes = nframes;
 542         _process_start_frame = start_frame;
 543         _process_end_frame = end_frame;
 544         _process_declick = declick;
 545
 546         _process_silent = false;
 547         _process_noroll = false;
 548         _process_retval = 0;
 549         _process_need_butler = false;
 550
 551         DEBUG_TRACE(DEBUG::ProcessThreads, "wake graph for non-silent process\n");
 552         _callback_start_sem.signal ();
 553         _callback_done_sem.wait ();
 554
 555         DEBUG_TRACE (DEBUG::ProcessThreads, "graph execution complete\n");
 556
 557         need_butler = _process_need_butler;
 558
 559         return _process_retval;
 560 }
 561
 562 int
 563 Graph::routes_no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
 564                        bool non_rt_pending, int declick)
 565 {
 566         DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("no-roll graph execution from %1 to %2 = %3\n", start_frame, end_frame, nframes));
 567
 568         _process_nframes = nframes;
 569         _process_start_frame = start_frame;
 570         _process_end_frame = end_frame;
 571         _process_declick = declick;
 572         _process_non_rt_pending = non_rt_pending;
 573
 574         _process_silent = false;
 575         _process_noroll = true;
 576         _process_retval = 0;
 577         _process_need_butler = false;
 578
 579         DEBUG_TRACE(DEBUG::ProcessThreads, "wake graph for no-roll process\n");
 580         _callback_start_sem.signal ();
 581         _callback_done_sem.wait ();
 582
 583         return _process_retval;
 584 }
 585 void
 586 Graph::process_one_route (Route* route)
 587 {
 588         bool need_butler = false;
 589         int retval;
 590
 591         assert (route);
 592
 593         DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("%1 runs route %2\n", pthread_self(), route->name()));
 594
 595         if (_process_silent) {
 596                 retval = route->silent_roll (_process_nframes, _process_start_frame, _process_end_frame, need_butler);
 597         } else if (_process_noroll) {
 598                 route->set_pending_declick (_process_declick);
 599                 retval = route->no_roll (_process_nframes, _process_start_frame, _process_end_frame, _process_non_rt_pending);
 600         } else {
 601                 route->set_pending_declick (_process_declick);
 602                 retval = route->roll (_process_nframes, _process_start_frame, _process_end_frame, _process_declick, need_butler);
 603         }
 604
 605         if (retval) {
 606                 _process_retval = retval;
 607         }
 608
 609         if (need_butler) {
 610                 _process_need_butler = true;
 611         }
 612 }
 613
 614 bool
 615 Graph::in_process_thread () const
 616 {
 617         list<pthread_t>::const_iterator i = _thread_list.begin ();
 618         while (i != _thread_list.end() && *i != pthread_self ()) {
 619                 ++i;
 620         }
 621
 622         return i != _thread_list.end ();
 623 }