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"
25 #include "pbd/pthread_utils.h"
27 #include "ardour/debug.h"
28 #include "ardour/graph.h"
29 #include "ardour/types.h"
30 #include "ardour/session.h"
31 #include "ardour/route.h"
32 #include "ardour/process_thread.h"
33 #include "ardour/audioengine.h"
37 using namespace ARDOUR;
42 static Graph* graph = 0;
48 return !graph->in_process_thread ();
54 Graph::Graph (Session & session)
55 : SessionHandleRef (session)
56 , _threads_active (false)
57 , _execution_sem ("graph_execution", 0)
58 , _callback_start_sem ("graph_start", 0)
59 , _callback_done_sem ("graph_done", 0)
60 , _cleanup_sem ("graph_cleanup", 0)
62 pthread_mutex_init( &_trigger_mutex, NULL);
64 /* XXX: rather hacky `fix' to stop _trigger_queue.push_back() allocating
65 memory in the RT thread.
67 _trigger_queue.reserve (8192);
69 _execution_tokens = 0;
77 ARDOUR::AudioEngine::instance()->Running.connect_same_thread (engine_connections, boost::bind (&Graph::reset_thread_list, this));
78 ARDOUR::AudioEngine::instance()->Stopped.connect_same_thread (engine_connections, boost::bind (&Graph::engine_stopped, this));
79 ARDOUR::AudioEngine::instance()->Halted.connect_same_thread (engine_connections, boost::bind (&Graph::engine_stopped, this));
85 pbd_alloc_allowed = &::alloc_allowed;
90 Graph::engine_stopped ()
92 if (AudioEngine::instance()->process_thread_count() != 0) {
97 /** Set up threads for running the graph */
99 Graph::reset_thread_list ()
101 uint32_t num_threads = how_many_dsp_threads ();
103 /* For now, we shouldn't be using the graph code if we only have 1 DSP thread */
104 assert (num_threads > 1);
106 /* don't bother doing anything here if we already have the right
110 if (AudioEngine::instance()->process_thread_count() == num_threads) {
114 Glib::Threads::Mutex::Lock lm (_session.engine().process_lock());
116 if (AudioEngine::instance()->process_thread_count() != 0) {
120 _threads_active = true;
122 if (AudioEngine::instance()->create_process_thread (boost::bind (&Graph::main_thread, this)) != 0) {
123 throw failed_constructor ();
126 for (uint32_t i = 1; i < num_threads; ++i) {
127 if (AudioEngine::instance()->create_process_thread (boost::bind (&Graph::helper_thread, this))) {
128 throw failed_constructor ();
134 Graph::session_going_away()
138 // now drop all references on the nodes.
139 _nodes_rt[0].clear();
140 _nodes_rt[1].clear();
141 _init_trigger_list[0].clear();
142 _init_trigger_list[1].clear();
143 _trigger_queue.clear();
147 Graph::drop_threads ()
149 Glib::Threads::Mutex::Lock ls (_swap_mutex);
150 _threads_active = false;
152 uint32_t thread_count = AudioEngine::instance()->process_thread_count ();
154 for (unsigned int i=0; i < thread_count; i++) {
155 pthread_mutex_lock (&_trigger_mutex);
156 _execution_sem.signal ();
157 pthread_mutex_unlock (&_trigger_mutex);
160 pthread_mutex_lock (&_trigger_mutex);
161 _callback_start_sem.signal ();
162 pthread_mutex_unlock (&_trigger_mutex);
164 AudioEngine::instance()->join_process_threads ();
166 _execution_tokens = 0;
170 Graph::clear_other_chain ()
172 Glib::Threads::Mutex::Lock ls (_swap_mutex);
175 if (_setup_chain != _pending_chain) {
177 for (node_list_t::iterator ni=_nodes_rt[_setup_chain].begin(); ni!=_nodes_rt[_setup_chain].end(); ni++) {
178 (*ni)->_activation_set[_setup_chain].clear();
181 _nodes_rt[_setup_chain].clear ();
182 _init_trigger_list[_setup_chain].clear ();
185 /* setup chain == pending chain - we have
186 to wait till this is no longer true.
188 _cleanup_cond.wait (_swap_mutex);
195 node_list_t::iterator i;
198 if (_swap_mutex.trylock()) {
199 // we got the swap mutex.
200 if (_current_chain != _pending_chain)
202 // printf ("chain swap ! %d -> %d\n", _current_chain, _pending_chain);
203 _setup_chain = _current_chain;
204 _current_chain = _pending_chain;
205 _cleanup_cond.signal ();
207 _swap_mutex.unlock ();
210 chain = _current_chain;
213 for (i=_nodes_rt[chain].begin(); i!=_nodes_rt[chain].end(); i++) {
215 _graph_empty = false;
217 _finished_refcount = _init_finished_refcount[chain];
219 /* Trigger the initial nodes for processing, which are the ones at the `input' end */
220 pthread_mutex_lock (&_trigger_mutex);
221 for (i=_init_trigger_list[chain].begin(); i!=_init_trigger_list[chain].end(); i++) {
222 /* don't use ::trigger here, as we have already locked the mutex */
223 _trigger_queue.push_back (i->get ());
225 pthread_mutex_unlock (&_trigger_mutex);
229 Graph::trigger (GraphNode* n)
231 pthread_mutex_lock (&_trigger_mutex);
232 _trigger_queue.push_back (n);
233 pthread_mutex_unlock (&_trigger_mutex);
236 /** Called when a node at the `output' end of the chain (ie one that has no-one to feed)
242 if (g_atomic_int_dec_and_test (const_cast<gint*> (&_finished_refcount))) {
244 /* We have run all the nodes that are at the `output' end of
245 the graph, so there is nothing more to do this time around.
253 Graph::restart_cycle()
255 // we are through. wakeup our caller.
258 _callback_done_sem.signal ();
260 /* Block until the a process callback triggers us */
261 _callback_start_sem.wait();
263 if (!_threads_active) {
269 if (_graph_empty && _threads_active) {
273 // returning will restart the cycle.
274 // starting with waking up the others.
277 /** Rechain our stuff using a list of routes (which can be in any order) and
278 * a directed graph of their interconnections, which is guaranteed to be
283 Graph::rechain (boost::shared_ptr<RouteList> routelist, GraphEdges const & edges)
285 Glib::Threads::Mutex::Lock ls (_swap_mutex);
287 int chain = _setup_chain;
288 DEBUG_TRACE (DEBUG::Graph, string_compose ("============== setup %1\n", chain));
290 /* This will become the number of nodes that do not feed any other node;
291 once we have processed this number of those nodes, we have finished.
293 _init_finished_refcount[chain] = 0;
295 /* This will become a list of nodes that are not fed by another node, ie
296 those at the `input' end.
298 _init_trigger_list[chain].clear();
300 _nodes_rt[chain].clear();
302 /* Clear things out, and make _nodes_rt[chain] a copy of routelist */
303 for (RouteList::iterator ri=routelist->begin(); ri!=routelist->end(); ri++) {
304 (*ri)->_init_refcount[chain] = 0;
305 (*ri)->_activation_set[chain].clear();
306 _nodes_rt[chain].push_back (*ri);
309 // now add refs for the connections.
311 for (node_list_t::iterator ni = _nodes_rt[chain].begin(); ni != _nodes_rt[chain].end(); ni++) {
313 boost::shared_ptr<Route> r = boost::dynamic_pointer_cast<Route> (*ni);
315 /* The routes that are directly fed by r */
316 set<GraphVertex> fed_from_r = edges.from (r);
318 /* Hence whether r has an output */
319 bool const has_output = !fed_from_r.empty ();
321 /* Set up r's activation set */
322 for (set<GraphVertex>::iterator i = fed_from_r.begin(); i != fed_from_r.end(); ++i) {
323 r->_activation_set[chain].insert (*i);
326 /* r has an input if there are some incoming edges to r in the graph */
327 bool const has_input = !edges.has_none_to (r);
329 /* Increment the refcount of any route that we directly feed */
330 for (node_set_t::iterator ai = r->_activation_set[chain].begin(); ai != r->_activation_set[chain].end(); ai++) {
331 (*ai)->_init_refcount[chain] += 1;
335 /* no input, so this node needs to be triggered initially to get things going */
336 _init_trigger_list[chain].push_back (*ni);
340 /* no output, so this is one of the nodes that we can count off to decide
343 _init_finished_refcount[chain] += 1;
347 _pending_chain = chain;
351 /** Called by both the main thread and all helpers.
352 * @return true to quit, false to carry on.
359 pthread_mutex_lock (&_trigger_mutex);
360 if (_trigger_queue.size()) {
361 to_run = _trigger_queue.back();
362 _trigger_queue.pop_back();
367 /* the number of threads that are asleep */
368 int et = _execution_tokens;
369 /* the number of nodes that need to be run */
370 int ts = _trigger_queue.size();
372 /* hence how many threads to wake up */
373 int wakeup = min (et, ts);
374 /* update the number of threads that will still be sleeping */
375 _execution_tokens -= wakeup;
377 DEBUG_TRACE(DEBUG::ProcessThreads, string_compose ("%1 signals %2\n", pthread_name(), wakeup));
379 for (int i = 0; i < wakeup; i++) {
380 _execution_sem.signal ();
383 while (to_run == 0) {
384 _execution_tokens += 1;
385 pthread_mutex_unlock (&_trigger_mutex);
386 DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("%1 goes to sleep\n", pthread_name()));
387 _execution_sem.wait ();
388 if (!_threads_active) {
391 DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("%1 is awake\n", pthread_name()));
392 pthread_mutex_lock (&_trigger_mutex);
393 if (_trigger_queue.size()) {
394 to_run = _trigger_queue.back();
395 _trigger_queue.pop_back();
398 pthread_mutex_unlock (&_trigger_mutex);
401 to_run->finish (_current_chain);
403 DEBUG_TRACE(DEBUG::ProcessThreads, string_compose ("%1 has finished run_one()\n", pthread_name()));
405 return !_threads_active;
409 Graph::helper_thread()
411 suspend_rt_malloc_checks ();
412 ProcessThread* pt = new ProcessThread ();
413 resume_rt_malloc_checks ();
427 /** Here's the main graph thread */
431 suspend_rt_malloc_checks ();
432 ProcessThread* pt = new ProcessThread ();
433 resume_rt_malloc_checks ();
438 _callback_start_sem.wait ();
440 DEBUG_TRACE(DEBUG::ProcessThreads, "main thread is awake\n");
442 if (!_threads_active) {
448 if (_graph_empty && _threads_active) {
449 _callback_done_sem.signal ();
450 DEBUG_TRACE(DEBUG::ProcessThreads, "main thread sees graph done, goes back to sleep\n");
454 /* This loop will run forever */
456 DEBUG_TRACE(DEBUG::ProcessThreads, "main thread runs one graph node\n");
467 Graph::dump (int chain)
470 node_list_t::iterator ni;
471 node_set_t::iterator ai;
473 chain = _pending_chain;
475 DEBUG_TRACE (DEBUG::Graph, "--------------------------------------------Graph dump:\n");
476 for (ni=_nodes_rt[chain].begin(); ni!=_nodes_rt[chain].end(); ni++) {
477 boost::shared_ptr<Route> rp = boost::dynamic_pointer_cast<Route>( *ni);
478 DEBUG_TRACE (DEBUG::Graph, string_compose ("GraphNode: %1 refcount: %2\n", rp->name().c_str(), (*ni)->_init_refcount[chain]));
479 for (ai=(*ni)->_activation_set[chain].begin(); ai!=(*ni)->_activation_set[chain].end(); ai++) {
480 DEBUG_TRACE (DEBUG::Graph, string_compose (" triggers: %1\n", boost::dynamic_pointer_cast<Route>(*ai)->name().c_str()));
484 DEBUG_TRACE (DEBUG::Graph, "------------- trigger list:\n");
485 for (ni=_init_trigger_list[chain].begin(); ni!=_init_trigger_list[chain].end(); ni++) {
486 DEBUG_TRACE (DEBUG::Graph, string_compose ("GraphNode: %1 refcount: %2\n", boost::dynamic_pointer_cast<Route>(*ni)->name().c_str(), (*ni)->_init_refcount[chain]));
489 DEBUG_TRACE (DEBUG::Graph, string_compose ("final activation refcount: %1\n", _init_finished_refcount[chain]));
494 Graph::silent_process_routes (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool& need_butler)
496 if (!_threads_active) return 0;
498 _process_nframes = nframes;
499 _process_start_frame = start_frame;
500 _process_end_frame = end_frame;
502 _process_silent = true;
503 _process_noroll = false;
505 _process_need_butler = false;
508 DEBUG_TRACE(DEBUG::ProcessThreads, "wake graph for silent process\n");
509 _callback_start_sem.signal ();
510 _callback_done_sem.wait ();
513 need_butler = _process_need_butler;
515 return _process_retval;
519 Graph::process_routes (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& need_butler)
521 DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("graph execution from %1 to %2 = %3\n", start_frame, end_frame, nframes));
523 if (!_threads_active) return 0;
525 _process_nframes = nframes;
526 _process_start_frame = start_frame;
527 _process_end_frame = end_frame;
528 _process_declick = declick;
530 _process_silent = false;
531 _process_noroll = false;
533 _process_need_butler = false;
535 DEBUG_TRACE(DEBUG::ProcessThreads, "wake graph for non-silent process\n");
536 _callback_start_sem.signal ();
537 _callback_done_sem.wait ();
539 DEBUG_TRACE (DEBUG::ProcessThreads, "graph execution complete\n");
541 need_butler = _process_need_butler;
543 return _process_retval;
547 Graph::routes_no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
548 bool non_rt_pending, int declick)
550 DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("no-roll graph execution from %1 to %2 = %3\n", start_frame, end_frame, nframes));
552 if (!_threads_active) return 0;
554 _process_nframes = nframes;
555 _process_start_frame = start_frame;
556 _process_end_frame = end_frame;
557 _process_declick = declick;
558 _process_non_rt_pending = non_rt_pending;
560 _process_silent = false;
561 _process_noroll = true;
563 _process_need_butler = false;
565 DEBUG_TRACE(DEBUG::ProcessThreads, "wake graph for no-roll process\n");
566 _callback_start_sem.signal ();
567 _callback_done_sem.wait ();
569 return _process_retval;
572 Graph::process_one_route (Route* route)
574 bool need_butler = false;
579 DEBUG_TRACE (DEBUG::ProcessThreads, string_compose ("%1 runs route %2\n", pthread_name(), route->name()));
581 if (_process_silent) {
582 retval = route->silent_roll (_process_nframes, _process_start_frame, _process_end_frame, need_butler);
583 } else if (_process_noroll) {
584 route->set_pending_declick (_process_declick);
585 retval = route->no_roll (_process_nframes, _process_start_frame, _process_end_frame, _process_non_rt_pending);
587 route->set_pending_declick (_process_declick);
588 retval = route->roll (_process_nframes, _process_start_frame, _process_end_frame, _process_declick, need_butler);
592 _process_retval = retval;
596 _process_need_butler = true;
601 Graph::in_process_thread () const
603 return AudioEngine::instance()->in_process_thread ();