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 (_thread_list.size() == num_threads) {
103 Glib::Mutex::Lock lm (_session.engine().process_lock());
106 if (!_thread_list.empty()) {
110 if (AudioEngine::instance()->create_process_thread (boost::bind (&Graph::main_thread, this), &a_thread, 100000) == 0) {
111 _thread_list.push_back (a_thread);
114 for (uint32_t i = 1; i < num_threads; ++i) {
115 if (AudioEngine::instance()->create_process_thread (boost::bind (&Graph::helper_thread, this), &a_thread, 100000) == 0) {
116 _thread_list.push_back (a_thread);
122 Graph::session_going_away()
126 // now drop all references on the nodes.
127 _nodes_rt[0].clear();
128 _nodes_rt[1].clear();
129 _init_trigger_list[0].clear();
130 _init_trigger_list[1].clear();
131 _trigger_queue.clear();
135 Graph::drop_threads ()
137 _quit_threads = true;
139 for (unsigned int i=0; i< _thread_list.size(); i++) {
140 _execution_sem.signal ();
143 _callback_start_sem.signal ();
145 for (list<pthread_t>::iterator i = _thread_list.begin(); i != _thread_list.end(); ++i) {
147 pthread_join (*i, &status);
150 _thread_list.clear ();
152 _execution_tokens = 0;
154 _quit_threads = false;
158 Graph::clear_other_chain ()
160 Glib::Mutex::Lock ls (_swap_mutex);
163 if (_setup_chain != _pending_chain) {
165 for (node_list_t::iterator ni=_nodes_rt[_setup_chain].begin(); ni!=_nodes_rt[_setup_chain].end(); ni++) {
166 (*ni)->_activation_set[_setup_chain].clear();
169 _nodes_rt[_setup_chain].clear ();
170 _init_trigger_list[_setup_chain].clear ();
173 /* setup chain == pending chain - we have
174 to wait till this is no longer true.
176 _cleanup_cond.wait (_swap_mutex);
183 node_list_t::iterator i;
186 if (_swap_mutex.trylock()) {
187 // we got the swap mutex.
188 if (_current_chain != _pending_chain)
190 // printf ("chain swap ! %d -> %d\n", _current_chain, _pending_chain);
191 _setup_chain = _current_chain;
192 _current_chain = _pending_chain;
193 _cleanup_cond.signal ();
195 _swap_mutex.unlock ();
198 chain = _current_chain;
201 for (i=_nodes_rt[chain].begin(); i!=_nodes_rt[chain].end(); i++) {
203 _graph_empty = false;
205 _finished_refcount = _init_finished_refcount[chain];
207 /* Trigger the initial nodes for processing, which are the ones at the `input' end */
208 pthread_mutex_lock (&_trigger_mutex);
209 for (i=_init_trigger_list[chain].begin(); i!=_init_trigger_list[chain].end(); i++) {
210 /* don't use ::trigger here, as we have already locked the mutex */
211 _trigger_queue.push_back (i->get ());
213 pthread_mutex_unlock (&_trigger_mutex);
217 Graph::trigger (GraphNode* n)
219 pthread_mutex_lock (&_trigger_mutex);
220 _trigger_queue.push_back (n);
221 pthread_mutex_unlock (&_trigger_mutex);
224 /** Called when a node at the `output' end of the chain (ie one that has no-one to feed)
230 if (g_atomic_int_dec_and_test (&_finished_refcount)) {
232 /* We have run all the nodes that are at the `output' end of
233 the graph, so there is nothing more to do this time around.
241 Graph::restart_cycle()
243 // we are through. wakeup our caller.
246 _callback_done_sem.signal ();
248 /* Block until the a process callback triggers us */
249 _callback_start_sem.wait();
261 // returning will restart the cycle.
262 // starting with waking up the others.
265 /** Rechain our stuff using a list of routes (which can be in any order) and
266 * a directed graph of their interconnections, which is guaranteed to be
271 Graph::rechain (boost::shared_ptr<RouteList> routelist, GraphEdges const & edges)
273 Glib::Mutex::Lock ls (_swap_mutex);
275 int chain = _setup_chain;
276 DEBUG_TRACE (DEBUG::Graph, string_compose ("============== setup %1\n", chain));
278 /* This will become the number of nodes that do not feed any other node;
279 once we have processed this number of those nodes, we have finished.
281 _init_finished_refcount[chain] = 0;
283 /* This will become a list of nodes that are not fed by another node, ie
284 those at the `input' end.
286 _init_trigger_list[chain].clear();
288 _nodes_rt[chain].clear();
290 /* Clear things out, and make _nodes_rt[chain] a copy of routelist */
291 for (RouteList::iterator ri=routelist->begin(); ri!=routelist->end(); ri++) {
292 (*ri)->_init_refcount[chain] = 0;
293 (*ri)->_activation_set[chain].clear();
294 _nodes_rt[chain].push_back (*ri);
297 // now add refs for the connections.
299 for (node_list_t::iterator ni = _nodes_rt[chain].begin(); ni != _nodes_rt[chain].end(); ni++) {
301 boost::shared_ptr<Route> r = boost::dynamic_pointer_cast<Route> (*ni);
303 /* The routes that are directly fed by r */
304 set<GraphVertex> fed_from_r = edges.from (r);
306 /* Hence whether r has an output */
307 bool const has_output = !fed_from_r.empty ();
309 /* Set up r's activation set */
310 for (set<GraphVertex>::iterator i = fed_from_r.begin(); i != fed_from_r.end(); ++i) {
311 r->_activation_set[chain].insert (*i);
314 /* r has an input if there are some incoming edges to r in the graph */
315 bool const has_input = !edges.has_none_to (r);
317 /* Increment the refcount of any route that we directly feed */
318 for (node_set_t::iterator ai = r->_activation_set[chain].begin(); ai != r->_activation_set[chain].end(); ai++) {
319 (*ai)->_init_refcount[chain] += 1;
323 /* no input, so this node needs to be triggered initially to get things going */
324 _init_trigger_list[chain].push_back (*ni);
328 /* no output, so this is one of the nodes that we can count off to decide
331 _init_finished_refcount[chain] += 1;
335 _pending_chain = chain;
339 /** Called by both the main thread and all helpers.
340 * @return true to quit, false to carry on.
347 pthread_mutex_lock (&_trigger_mutex);
348 if (_trigger_queue.size()) {
349 to_run = _trigger_queue.back();
350 _trigger_queue.pop_back();
355 /* the number of threads that are asleep */
356 int et = _execution_tokens;
357 /* the number of nodes that need to be run */
358 int ts = _trigger_queue.size();
360 /* hence how many threads to wake up */
361 int wakeup = min (et, ts);
362 /* update the number of threads that will still be sleeping */
363 _execution_tokens -= wakeup;
365 DEBUG_TRACE(DEBUG::ProcessThreads, string_compose ("%1 signals %2\n", pthread_self(), wakeup));
367 for (int i = 0; i < wakeup; i++) {
368 _execution_sem.signal ();
371 while (to_run == 0) {
372 _execution_tokens += 1;
373 pthread_mutex_unlock (&_trigger_mutex);
374 DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("%1 goes to sleep\n", pthread_self()));
375 _execution_sem.wait ();
379 DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("%1 is awake\n", pthread_self()));
380 pthread_mutex_lock (&_trigger_mutex);
381 if (_trigger_queue.size()) {
382 to_run = _trigger_queue.back();
383 _trigger_queue.pop_back();
386 pthread_mutex_unlock (&_trigger_mutex);
389 to_run->finish (_current_chain);
391 DEBUG_TRACE(DEBUG::ProcessThreads, string_compose ("%1 has finished run_one()\n", pthread_self()));
397 Graph::helper_thread()
399 suspend_rt_malloc_checks ();
400 ProcessThread* pt = new ProcessThread ();
401 resume_rt_malloc_checks ();
414 /** Here's the main graph thread */
418 suspend_rt_malloc_checks ();
419 ProcessThread* pt = new ProcessThread ();
420 resume_rt_malloc_checks ();
425 _callback_start_sem.wait ();
427 DEBUG_TRACE(DEBUG::ProcessThreads, "main thread is awake\n");
435 if (_graph_empty && !_quit_threads) {
436 _callback_done_sem.signal ();
437 DEBUG_TRACE(DEBUG::ProcessThreads, "main thread sees graph done, goes back to sleep\n");
441 /* This loop will run forever */
443 DEBUG_TRACE(DEBUG::ProcessThreads, "main thread runs one graph node\n");
453 Graph::dump (int chain)
456 node_list_t::iterator ni;
457 node_set_t::iterator ai;
459 chain = _pending_chain;
461 DEBUG_TRACE (DEBUG::Graph, "--------------------------------------------Graph dump:\n");
462 for (ni=_nodes_rt[chain].begin(); ni!=_nodes_rt[chain].end(); ni++) {
463 boost::shared_ptr<Route> rp = boost::dynamic_pointer_cast<Route>( *ni);
464 DEBUG_TRACE (DEBUG::Graph, string_compose ("GraphNode: %1 refcount: %2\n", rp->name().c_str(), (*ni)->_init_refcount[chain]));
465 for (ai=(*ni)->_activation_set[chain].begin(); ai!=(*ni)->_activation_set[chain].end(); ai++) {
466 DEBUG_TRACE (DEBUG::Graph, string_compose (" triggers: %1\n", boost::dynamic_pointer_cast<Route>(*ai)->name().c_str()));
470 DEBUG_TRACE (DEBUG::Graph, "------------- trigger list:\n");
471 for (ni=_init_trigger_list[chain].begin(); ni!=_init_trigger_list[chain].end(); ni++) {
472 DEBUG_TRACE (DEBUG::Graph, string_compose ("GraphNode: %1 refcount: %2\n", boost::dynamic_pointer_cast<Route>(*ni)->name().c_str(), (*ni)->_init_refcount[chain]));
475 DEBUG_TRACE (DEBUG::Graph, string_compose ("final activation refcount: %1\n", _init_finished_refcount[chain]));
480 Graph::silent_process_routes (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool& need_butler)
482 _process_nframes = nframes;
483 _process_start_frame = start_frame;
484 _process_end_frame = end_frame;
486 _process_silent = true;
487 _process_noroll = false;
489 _process_need_butler = false;
492 DEBUG_TRACE(DEBUG::ProcessThreads, "wake graph for silent process\n");
493 _callback_start_sem.signal ();
494 _callback_done_sem.wait ();
497 need_butler = _process_need_butler;
499 return _process_retval;
503 Graph::process_routes (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& need_butler)
505 DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("graph execution from %1 to %2 = %3\n", start_frame, end_frame, nframes));
507 _process_nframes = nframes;
508 _process_start_frame = start_frame;
509 _process_end_frame = end_frame;
510 _process_declick = declick;
512 _process_silent = false;
513 _process_noroll = false;
515 _process_need_butler = false;
517 DEBUG_TRACE(DEBUG::ProcessThreads, "wake graph for non-silent process\n");
518 _callback_start_sem.signal ();
519 _callback_done_sem.wait ();
521 DEBUG_TRACE (DEBUG::ProcessThreads, "graph execution complete\n");
523 need_butler = _process_need_butler;
525 return _process_retval;
529 Graph::routes_no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
530 bool non_rt_pending, int declick)
532 DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("no-roll graph execution from %1 to %2 = %3\n", start_frame, end_frame, nframes));
534 _process_nframes = nframes;
535 _process_start_frame = start_frame;
536 _process_end_frame = end_frame;
537 _process_declick = declick;
538 _process_non_rt_pending = non_rt_pending;
540 _process_silent = false;
541 _process_noroll = true;
543 _process_need_butler = false;
545 DEBUG_TRACE(DEBUG::ProcessThreads, "wake graph for no-roll process\n");
546 _callback_start_sem.signal ();
547 _callback_done_sem.wait ();
549 return _process_retval;
552 Graph::process_one_route (Route* route)
554 bool need_butler = false;
559 DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("%1 runs route %2\n", pthread_self(), route->name()));
561 if (_process_silent) {
562 retval = route->silent_roll (_process_nframes, _process_start_frame, _process_end_frame, need_butler);
563 } else if (_process_noroll) {
564 route->set_pending_declick (_process_declick);
565 retval = route->no_roll (_process_nframes, _process_start_frame, _process_end_frame, _process_non_rt_pending);
567 route->set_pending_declick (_process_declick);
568 retval = route->roll (_process_nframes, _process_start_frame, _process_end_frame, _process_declick, need_butler);
572 _process_retval = retval;
576 _process_need_butler = true;
581 Graph::in_process_thread () const
583 for (list<pthread_t>::const_iterator i = _thread_list.begin (); i != _thread_list.end(); ++i) {
584 if (*i == pthread_self()) {