libs/ardour/session_butler.cc

   1 /*
   2     Copyright (C) 1999-2002 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <algorithm>
  21 #include <string>
  22 #include <cmath>
  23 #include <cerrno>
  24 #include <unistd.h>
  25 #include <fcntl.h>
  26 #include <poll.h>
  27
  28 #include <glibmm/thread.h>
  29
  30 #include <pbd/error.h>
  31 #include <pbd/pthread_utils.h>
  32 #include <pbd/stacktrace.h>
  33
  34 #include <ardour/configuration.h>
  35 #include <ardour/audioengine.h>
  36 #include <ardour/session.h>
  37 #include <ardour/audio_diskstream.h>
  38 #include <ardour/crossfade.h>
  39 #include <ardour/timestamps.h>
  40
  41 #include "i18n.h"
  42
  43 using namespace std;
  44 using namespace ARDOUR;
  45 using namespace PBD;
  46
  47 static float _read_data_rate;
  48 static float _write_data_rate;
  49
  50 /* XXX put this in the right place */
  51
  52 static inline uint32_t next_power_of_two (uint32_t n)
  53 {
  54         --n;
  55         n |= n >> 16;
  56         n |= n >> 8;
  57         n |= n >> 4;
  58         n |= n >> 2;
  59         n |= n >> 1;
  60         ++n;
  61         return n;
  62 }
  63
  64 /*---------------------------------------------------------------------------
  65  BUTLER THREAD
  66  ---------------------------------------------------------------------------*/
  67
  68 int
  69 Session::start_butler_thread ()
  70 {
  71         /* size is in Samples, not bytes */
  72
  73         dstream_buffer_size = (uint32_t) floor (Config->get_track_buffer_seconds() * (float) frame_rate());
  74
  75         Crossfade::set_buffer_size (dstream_buffer_size);
  76
  77         butler_should_run = false;
  78
  79         if (pipe (butler_request_pipe)) {
  80                 error << string_compose(_("Cannot create transport request signal pipe (%1)"), strerror (errno)) << endmsg;
  81                 return -1;
  82         }
  83
  84         if (fcntl (butler_request_pipe[0], F_SETFL, O_NONBLOCK)) {
  85                 error << string_compose(_("UI: cannot set O_NONBLOCK on butler request pipe (%1)"), strerror (errno)) << endmsg;
  86                 return -1;
  87         }
  88
  89         if (fcntl (butler_request_pipe[1], F_SETFL, O_NONBLOCK)) {
  90                 error << string_compose(_("UI: cannot set O_NONBLOCK on butler request pipe (%1)"), strerror (errno)) << endmsg;
  91                 return -1;
  92         }
  93
  94         if (pthread_create_and_store ("disk butler", &butler_thread, 0, _butler_thread_work, this)) {
  95                 error << _("Session: could not create butler thread") << endmsg;
  96                 return -1;
  97         }
  98
  99         // pthread_detach (butler_thread);
 100
 101         return 0;
 102 }
 103
 104 void
 105 Session::terminate_butler_thread ()
 106 {
 107         if (butler_thread) {
 108                 void* status;
 109                 char c = ButlerRequest::Quit;
 110                 ::write (butler_request_pipe[1], &c, 1);
 111                 pthread_join (butler_thread, &status);
 112         }
 113 }
 114
 115 void
 116 Session::schedule_butler_transport_work ()
 117 {
 118         g_atomic_int_inc (&butler_should_do_transport_work);
 119         summon_butler ();
 120 }
 121
 122 void
 123 Session::schedule_curve_reallocation ()
 124 {
 125         post_transport_work = PostTransportWork (post_transport_work | PostTransportCurveRealloc);
 126         schedule_butler_transport_work ();
 127 }
 128
 129 void
 130 Session::summon_butler ()
 131 {
 132         char c = ButlerRequest::Run;
 133         ::write (butler_request_pipe[1], &c, 1);
 134         // PBD::stacktrace (cerr);
 135 }
 136
 137 void
 138 Session::stop_butler ()
 139 {
 140         Glib::Mutex::Lock lm (butler_request_lock);
 141         char c = ButlerRequest::Pause;
 142         ::write (butler_request_pipe[1], &c, 1);
 143         butler_paused.wait(butler_request_lock);
 144 }
 145
 146 void
 147 Session::wait_till_butler_finished ()
 148 {
 149         Glib::Mutex::Lock lm (butler_request_lock);
 150         char c = ButlerRequest::Wake;
 151         ::write (butler_request_pipe[1], &c, 1);
 152         butler_paused.wait(butler_request_lock);
 153 }
 154
 155 void *
 156 Session::_butler_thread_work (void* arg)
 157 {
 158         PBD::notify_gui_about_thread_creation (pthread_self(), X_("Butler"));
 159         return ((Session *) arg)->butler_thread_work ();
 160         return 0;
 161 }
 162
 163 void *
 164 Session::butler_thread_work ()
 165 {
 166         uint32_t err = 0;
 167         int32_t bytes;
 168         bool compute_io;
 169         microseconds_t begin, end;
 170
 171         struct pollfd pfd[1];
 172         bool disk_work_outstanding = false;
 173         DiskstreamList::iterator i;
 174
 175         while (true) {
 176                 pfd[0].fd = butler_request_pipe[0];
 177                 pfd[0].events = POLLIN|POLLERR|POLLHUP;
 178
 179                 if (poll (pfd, 1, (disk_work_outstanding ? 0 : -1)) < 0) {
 180
 181                         if (errno == EINTR) {
 182                                 continue;
 183                         }
 184
 185                         error << string_compose (_("poll on butler request pipe failed (%1)"),
 186                                           strerror (errno))
 187                               << endmsg;
 188                         break;
 189                 }
 190
 191                 if (pfd[0].revents & ~POLLIN) {
 192                         error << string_compose (_("Error on butler thread request pipe: fd=%1 err=%2"), pfd[0].fd, pfd[0].revents) << endmsg;
 193                         break;
 194                 }
 195
 196                 if (pfd[0].revents & POLLIN) {
 197
 198                         char req;
 199
 200                         /* empty the pipe of all current requests */
 201
 202                         while (1) {
 203                                 size_t nread = ::read (butler_request_pipe[0], &req, sizeof (req));
 204                                 if (nread == 1) {
 205
 206                                         switch ((ButlerRequest::Type) req) {
 207
 208                                         case ButlerRequest::Wake:
 209                                                 break;
 210
 211                                         case ButlerRequest::Run:
 212                                                 butler_should_run = true;
 213                                                 break;
 214
 215                                         case ButlerRequest::Pause:
 216                                                 butler_should_run = false;
 217                                                 break;
 218
 219                                         case ButlerRequest::Quit:
 220                                                 pthread_exit_pbd (0);
 221                                                 /*NOTREACHED*/
 222                                                 break;
 223
 224                                         default:
 225                                                 break;
 226                                         }
 227
 228                                 } else if (nread == 0) {
 229                                         break;
 230                                 } else if (errno == EAGAIN) {
 231                                         break;
 232                                 } else {
 233                                         fatal << _("Error reading from butler request pipe") << endmsg;
 234                                         /*NOTREACHED*/
 235                                 }
 236                         }
 237                 }
 238
 239                 if (transport_work_requested()) {
 240                         butler_transport_work ();
 241                 }
 242
 243                 disk_work_outstanding = false;
 244                 bytes = 0;
 245                 compute_io = true;
 246
 247                 begin = get_microseconds();
 248
 249                 boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader ();
 250
 251 //              for (i = dsl->begin(); i != dsl->end(); ++i) {
 252 //                      cerr << "BEFORE " << (*i)->name() << ": pb = " << (*i)->playback_buffer_load() << " cp = " << (*i)->capture_buffer_load() << endl;
 253 //              }
 254
 255                 for (i = dsl->begin(); !transport_work_requested() && butler_should_run && i != dsl->end(); ++i) {
 256
 257                         boost::shared_ptr<Diskstream> ds = *i;
 258
 259                         /* don't read inactive tracks */
 260
 261                         IO* io = ds->io();
 262
 263                         if (io && !io->active()) {
 264                                 continue;
 265                         }
 266
 267                         switch (ds->do_refill ()) {
 268                         case 0:
 269                                 bytes += ds->read_data_count();
 270                                 break;
 271                         case 1:
 272                                 bytes += ds->read_data_count();
 273                                 disk_work_outstanding = true;
 274                                 break;
 275
 276                         default:
 277                                 compute_io = false;
 278                                 error << string_compose(_("Butler read ahead failure on dstream %1"), (*i)->name()) << endmsg;
 279                                 break;
 280                         }
 281
 282                 }
 283
 284                 if (i != dsl->end()) {
 285                         /* we didn't get to all the streams */
 286                         disk_work_outstanding = true;
 287                 }
 288
 289                 if (!err && transport_work_requested()) {
 290                         continue;
 291                 }
 292
 293                 if (compute_io) {
 294                         end = get_microseconds();
 295                         if(end-begin > 0) {
 296                         _read_data_rate = (float) bytes / (float) (end - begin);
 297                         } else { _read_data_rate = 0; // infinity better
 298                          }
 299                 }
 300
 301                 bytes = 0;
 302                 compute_io = true;
 303                 begin = get_microseconds();
 304
 305                 for (i = dsl->begin(); !transport_work_requested() && butler_should_run && i != dsl->end(); ++i) {
 306                         // cerr << "write behind for " << (*i)->name () << endl;
 307
 308                         /* note that we still try to flush diskstreams attached to inactive routes
 309                          */
 310
 311                         switch ((*i)->do_flush (Session::ButlerContext)) {
 312                         case 0:
 313                                 bytes += (*i)->write_data_count();
 314                                 break;
 315                         case 1:
 316                                 bytes += (*i)->write_data_count();
 317                                 disk_work_outstanding = true;
 318                                 break;
 319
 320                         default:
 321                                 err++;
 322                                 compute_io = false;
 323                                 error << string_compose(_("Butler write-behind failure on dstream %1"), (*i)->name()) << endmsg;
 324                                 /* don't break - try to flush all streams in case they
 325                                    are split across disks.
 326                                 */
 327                         }
 328                 }
 329
 330                 if (err && actively_recording()) {
 331                         /* stop the transport and try to catch as much possible
 332                            captured state as we can.
 333                         */
 334                         request_stop ();
 335                 }
 336
 337                 if (i != dsl->end()) {
 338                         /* we didn't get to all the streams */
 339                         disk_work_outstanding = true;
 340                 }
 341
 342                 if (!err && transport_work_requested()) {
 343                         continue;
 344                 }
 345
 346                 if (compute_io) {
 347                         // there are no apparent users for this calculation?
 348                         end = get_microseconds();
 349                         if(end-begin > 0) {
 350                         _write_data_rate = (float) bytes / (float) (end - begin);
 351                         } else {
 352                         _write_data_rate = 0; // Well, infinity would be better
 353                         }
 354                 }
 355
 356                 if (!disk_work_outstanding) {
 357                         refresh_disk_space ();
 358                 }
 359
 360
 361                 {
 362                         Glib::Mutex::Lock lm (butler_request_lock);
 363
 364                         if (butler_should_run && (disk_work_outstanding || transport_work_requested())) {
 365 //                              for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
 366 //                                      cerr << "AFTER " << (*i)->name() << ": pb = " << (*i)->playback_buffer_load() << " cp = " << (*i)->capture_buffer_load() << endl;
 367 //                              }
 368
 369                                 continue;
 370                         }
 371
 372                         butler_paused.signal();
 373                 }
 374         }
 375
 376         pthread_exit_pbd (0);
 377         /*NOTREACHED*/
 378         return (0);
 379 }
 380
 381
 382 void
 383 Session::request_overwrite_buffer (Diskstream* stream)
 384 {
 385         Event *ev = new Event (Event::Overwrite, Event::Add, Event::Immediate, 0, 0, 0.0);
 386         ev->set_ptr (stream);
 387         queue_event (ev);
 388 }
 389
 390 /** Process thread. */
 391 void
 392 Session::overwrite_some_buffers (Diskstream* ds)
 393 {
 394         if (actively_recording()) {
 395                 return;
 396         }
 397
 398         if (ds) {
 399
 400                 ds->set_pending_overwrite (true);
 401
 402         } else {
 403
 404                 boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
 405                 for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
 406                         (*i)->set_pending_overwrite (true);
 407                 }
 408         }
 409
 410         post_transport_work = PostTransportWork (post_transport_work | PostTransportOverWrite);
 411         schedule_butler_transport_work ();
 412 }
 413
 414 float
 415 Session::read_data_rate () const
 416 {
 417         /* disk i/o in excess of 10000MB/sec indicate the buffer cache
 418            in action. ignore it.
 419         */
 420         return _read_data_rate > 10485.7600000f ? 0.0f : _read_data_rate;
 421 }
 422
 423 float
 424 Session::write_data_rate () const
 425 {
 426         /* disk i/o in excess of 10000MB/sec indicate the buffer cache
 427            in action. ignore it.
 428         */
 429         return _write_data_rate > 10485.7600000f ? 0.0f : _write_data_rate;
 430 }
 431
 432 uint32_t
 433 Session::playback_load ()
 434 {
 435         return (uint32_t) g_atomic_int_get (&_playback_load);
 436 }
 437
 438 uint32_t
 439 Session::capture_load ()
 440 {
 441         return (uint32_t) g_atomic_int_get (&_capture_load);
 442 }
 443
 444 uint32_t
 445 Session::playback_load_min ()
 446 {
 447         return (uint32_t) g_atomic_int_get (&_playback_load_min);
 448 }
 449
 450 uint32_t
 451 Session::capture_load_min ()
 452 {
 453         return (uint32_t) g_atomic_int_get (&_capture_load_min);
 454 }
 455
 456 void
 457 Session::reset_capture_load_min ()
 458 {
 459         g_atomic_int_set (&_capture_load_min, 100);
 460 }
 461
 462
 463 void
 464 Session::reset_playback_load_min ()
 465 {
 466         g_atomic_int_set (&_playback_load_min, 100);
 467 }