2 Copyright (C) 2010 Paul Davis
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.
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.
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.
23 #include "pbd/compose.h"
24 #include "pbd/debug_rt_alloc.h"
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"
34 #include <jack/thread.h>
38 using namespace ARDOUR;
43 static Graph* graph = 0;
49 return !graph->in_process_thread ();
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)
63 pthread_mutex_init( &_trigger_mutex, NULL);
65 /* XXX: rather hacky `fix' to stop _trigger_queue.push_back() allocating
66 memory in the RT thread.
68 _trigger_queue.reserve (8192);
70 _execution_tokens = 0;
75 _quit_threads = false;
82 pbd_alloc_allowed = &::alloc_allowed;
86 /** Set up threads for running the graph */
88 Graph::reset_thread_list ()
90 uint32_t num_threads = how_many_dsp_threads ();
92 /* For now, we shouldn't be using the graph code if we only have 1 DSP thread */
93 assert (num_threads > 1);
95 /* don't bother doing anything here if we already have the right
99 if (AudioEngine::instance()->process_thread_count() == num_threads) {
103 Glib::Threads::Mutex::Lock lm (_session.engine().process_lock());
105 if (AudioEngine::instance()->process_thread_count() != 0) {
109 if (AudioEngine::instance()->create_process_thread (boost::bind (&Graph::main_thread, this)) != 0) {
110 throw failed_constructor ();
113 for (uint32_t i = 1; i < num_threads; ++i) {
114 if (AudioEngine::instance()->create_process_thread (boost::bind (&Graph::helper_thread, this))) {
115 throw failed_constructor ();
121 Graph::session_going_away()
125 // now drop all references on the nodes.
126 _nodes_rt[0].clear();
127 _nodes_rt[1].clear();
128 _init_trigger_list[0].clear();
129 _init_trigger_list[1].clear();
130 _trigger_queue.clear();
134 Graph::drop_threads ()
136 _quit_threads = true;
138 uint32_t thread_count = AudioEngine::instance()->process_thread_count ();
140 for (unsigned int i=0; i < thread_count; i++) {
141 _execution_sem.signal ();
144 _callback_start_sem.signal ();
146 AudioEngine::instance()->join_process_threads ();
148 _execution_tokens = 0;
150 _quit_threads = false;
154 Graph::clear_other_chain ()
156 Glib::Threads::Mutex::Lock ls (_swap_mutex);
159 if (_setup_chain != _pending_chain) {
161 for (node_list_t::iterator ni=_nodes_rt[_setup_chain].begin(); ni!=_nodes_rt[_setup_chain].end(); ni++) {
162 (*ni)->_activation_set[_setup_chain].clear();
165 _nodes_rt[_setup_chain].clear ();
166 _init_trigger_list[_setup_chain].clear ();
169 /* setup chain == pending chain - we have
170 to wait till this is no longer true.
172 _cleanup_cond.wait (_swap_mutex);
179 node_list_t::iterator i;
182 if (_swap_mutex.trylock()) {
183 // we got the swap mutex.
184 if (_current_chain != _pending_chain)
186 // printf ("chain swap ! %d -> %d\n", _current_chain, _pending_chain);
187 _setup_chain = _current_chain;
188 _current_chain = _pending_chain;
189 _cleanup_cond.signal ();
191 _swap_mutex.unlock ();
194 chain = _current_chain;
197 for (i=_nodes_rt[chain].begin(); i!=_nodes_rt[chain].end(); i++) {
199 _graph_empty = false;
201 _finished_refcount = _init_finished_refcount[chain];
203 /* Trigger the initial nodes for processing, which are the ones at the `input' end */
204 pthread_mutex_lock (&_trigger_mutex);
205 for (i=_init_trigger_list[chain].begin(); i!=_init_trigger_list[chain].end(); i++) {
206 /* don't use ::trigger here, as we have already locked the mutex */
207 _trigger_queue.push_back (i->get ());
209 pthread_mutex_unlock (&_trigger_mutex);
213 Graph::trigger (GraphNode* n)
215 pthread_mutex_lock (&_trigger_mutex);
216 _trigger_queue.push_back (n);
217 pthread_mutex_unlock (&_trigger_mutex);
220 /** Called when a node at the `output' end of the chain (ie one that has no-one to feed)
226 if (g_atomic_int_dec_and_test (const_cast<gint*> (&_finished_refcount))) {
228 /* We have run all the nodes that are at the `output' end of
229 the graph, so there is nothing more to do this time around.
237 Graph::restart_cycle()
239 // we are through. wakeup our caller.
242 _callback_done_sem.signal ();
244 /* Block until the a process callback triggers us */
245 _callback_start_sem.wait();
257 // returning will restart the cycle.
258 // starting with waking up the others.
261 /** Rechain our stuff using a list of routes (which can be in any order) and
262 * a directed graph of their interconnections, which is guaranteed to be
267 Graph::rechain (boost::shared_ptr<RouteList> routelist, GraphEdges const & edges)
269 Glib::Threads::Mutex::Lock ls (_swap_mutex);
271 int chain = _setup_chain;
272 DEBUG_TRACE (DEBUG::Graph, string_compose ("============== setup %1\n", chain));
274 /* This will become the number of nodes that do not feed any other node;
275 once we have processed this number of those nodes, we have finished.
277 _init_finished_refcount[chain] = 0;
279 /* This will become a list of nodes that are not fed by another node, ie
280 those at the `input' end.
282 _init_trigger_list[chain].clear();
284 _nodes_rt[chain].clear();
286 /* Clear things out, and make _nodes_rt[chain] a copy of routelist */
287 for (RouteList::iterator ri=routelist->begin(); ri!=routelist->end(); ri++) {
288 (*ri)->_init_refcount[chain] = 0;
289 (*ri)->_activation_set[chain].clear();
290 _nodes_rt[chain].push_back (*ri);
293 // now add refs for the connections.
295 for (node_list_t::iterator ni = _nodes_rt[chain].begin(); ni != _nodes_rt[chain].end(); ni++) {
297 boost::shared_ptr<Route> r = boost::dynamic_pointer_cast<Route> (*ni);
299 /* The routes that are directly fed by r */
300 set<GraphVertex> fed_from_r = edges.from (r);
302 /* Hence whether r has an output */
303 bool const has_output = !fed_from_r.empty ();
305 /* Set up r's activation set */
306 for (set<GraphVertex>::iterator i = fed_from_r.begin(); i != fed_from_r.end(); ++i) {
307 r->_activation_set[chain].insert (*i);
310 /* r has an input if there are some incoming edges to r in the graph */
311 bool const has_input = !edges.has_none_to (r);
313 /* Increment the refcount of any route that we directly feed */
314 for (node_set_t::iterator ai = r->_activation_set[chain].begin(); ai != r->_activation_set[chain].end(); ai++) {
315 (*ai)->_init_refcount[chain] += 1;
319 /* no input, so this node needs to be triggered initially to get things going */
320 _init_trigger_list[chain].push_back (*ni);
324 /* no output, so this is one of the nodes that we can count off to decide
327 _init_finished_refcount[chain] += 1;
331 _pending_chain = chain;
335 /** Called by both the main thread and all helpers.
336 * @return true to quit, false to carry on.
343 pthread_mutex_lock (&_trigger_mutex);
344 if (_trigger_queue.size()) {
345 to_run = _trigger_queue.back();
346 _trigger_queue.pop_back();
351 /* the number of threads that are asleep */
352 int et = _execution_tokens;
353 /* the number of nodes that need to be run */
354 int ts = _trigger_queue.size();
356 /* hence how many threads to wake up */
357 int wakeup = min (et, ts);
358 /* update the number of threads that will still be sleeping */
359 _execution_tokens -= wakeup;
361 DEBUG_TRACE(DEBUG::ProcessThreads, string_compose ("%1 signals %2\n", pthread_self(), wakeup));
363 for (int i = 0; i < wakeup; i++) {
364 _execution_sem.signal ();
367 while (to_run == 0) {
368 _execution_tokens += 1;
369 pthread_mutex_unlock (&_trigger_mutex);
370 DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("%1 goes to sleep\n", pthread_self()));
371 _execution_sem.wait ();
375 DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("%1 is awake\n", pthread_self()));
376 pthread_mutex_lock (&_trigger_mutex);
377 if (_trigger_queue.size()) {
378 to_run = _trigger_queue.back();
379 _trigger_queue.pop_back();
382 pthread_mutex_unlock (&_trigger_mutex);
385 to_run->finish (_current_chain);
387 DEBUG_TRACE(DEBUG::ProcessThreads, string_compose ("%1 has finished run_one()\n", pthread_self()));
393 Graph::helper_thread()
395 suspend_rt_malloc_checks ();
396 ProcessThread* pt = new ProcessThread ();
397 resume_rt_malloc_checks ();
410 /** Here's the main graph thread */
414 suspend_rt_malloc_checks ();
415 ProcessThread* pt = new ProcessThread ();
416 resume_rt_malloc_checks ();
421 _callback_start_sem.wait ();
423 DEBUG_TRACE(DEBUG::ProcessThreads, "main thread is awake\n");
431 if (_graph_empty && !_quit_threads) {
432 _callback_done_sem.signal ();
433 DEBUG_TRACE(DEBUG::ProcessThreads, "main thread sees graph done, goes back to sleep\n");
437 /* This loop will run forever */
439 DEBUG_TRACE(DEBUG::ProcessThreads, "main thread runs one graph node\n");
449 Graph::dump (int chain)
452 node_list_t::iterator ni;
453 node_set_t::iterator ai;
455 chain = _pending_chain;
457 DEBUG_TRACE (DEBUG::Graph, "--------------------------------------------Graph dump:\n");
458 for (ni=_nodes_rt[chain].begin(); ni!=_nodes_rt[chain].end(); ni++) {
459 boost::shared_ptr<Route> rp = boost::dynamic_pointer_cast<Route>( *ni);
460 DEBUG_TRACE (DEBUG::Graph, string_compose ("GraphNode: %1 refcount: %2\n", rp->name().c_str(), (*ni)->_init_refcount[chain]));
461 for (ai=(*ni)->_activation_set[chain].begin(); ai!=(*ni)->_activation_set[chain].end(); ai++) {
462 DEBUG_TRACE (DEBUG::Graph, string_compose (" triggers: %1\n", boost::dynamic_pointer_cast<Route>(*ai)->name().c_str()));
466 DEBUG_TRACE (DEBUG::Graph, "------------- trigger list:\n");
467 for (ni=_init_trigger_list[chain].begin(); ni!=_init_trigger_list[chain].end(); ni++) {
468 DEBUG_TRACE (DEBUG::Graph, string_compose ("GraphNode: %1 refcount: %2\n", boost::dynamic_pointer_cast<Route>(*ni)->name().c_str(), (*ni)->_init_refcount[chain]));
471 DEBUG_TRACE (DEBUG::Graph, string_compose ("final activation refcount: %1\n", _init_finished_refcount[chain]));
476 Graph::silent_process_routes (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool& need_butler)
478 _process_nframes = nframes;
479 _process_start_frame = start_frame;
480 _process_end_frame = end_frame;
482 _process_silent = true;
483 _process_noroll = false;
485 _process_need_butler = false;
488 DEBUG_TRACE(DEBUG::ProcessThreads, "wake graph for silent process\n");
489 _callback_start_sem.signal ();
490 _callback_done_sem.wait ();
493 need_butler = _process_need_butler;
495 return _process_retval;
499 Graph::process_routes (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& need_butler)
501 DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("graph execution from %1 to %2 = %3\n", start_frame, end_frame, nframes));
503 _process_nframes = nframes;
504 _process_start_frame = start_frame;
505 _process_end_frame = end_frame;
506 _process_declick = declick;
508 _process_silent = false;
509 _process_noroll = false;
511 _process_need_butler = false;
513 DEBUG_TRACE(DEBUG::ProcessThreads, "wake graph for non-silent process\n");
514 _callback_start_sem.signal ();
515 _callback_done_sem.wait ();
517 DEBUG_TRACE (DEBUG::ProcessThreads, "graph execution complete\n");
519 need_butler = _process_need_butler;
521 return _process_retval;
525 Graph::routes_no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
526 bool non_rt_pending, int declick)
528 DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("no-roll graph execution from %1 to %2 = %3\n", start_frame, end_frame, nframes));
530 _process_nframes = nframes;
531 _process_start_frame = start_frame;
532 _process_end_frame = end_frame;
533 _process_declick = declick;
534 _process_non_rt_pending = non_rt_pending;
536 _process_silent = false;
537 _process_noroll = true;
539 _process_need_butler = false;
541 DEBUG_TRACE(DEBUG::ProcessThreads, "wake graph for no-roll process\n");
542 _callback_start_sem.signal ();
543 _callback_done_sem.wait ();
545 return _process_retval;
548 Graph::process_one_route (Route* route)
550 bool need_butler = false;
555 DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("%1 runs route %2\n", pthread_self(), route->name()));
557 if (_process_silent) {
558 retval = route->silent_roll (_process_nframes, _process_start_frame, _process_end_frame, need_butler);
559 } else if (_process_noroll) {
560 route->set_pending_declick (_process_declick);
561 retval = route->no_roll (_process_nframes, _process_start_frame, _process_end_frame, _process_non_rt_pending);
563 route->set_pending_declick (_process_declick);
564 retval = route->roll (_process_nframes, _process_start_frame, _process_end_frame, _process_declick, need_butler);
568 _process_retval = retval;
572 _process_need_butler = true;
577 Graph::in_process_thread () const
579 return AudioEngine::instance()->in_process_thread ();