src/lib/encode_server.cc

   1 /*
   2     Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 /** @file src/encode_server.cc
  22  *  @brief Class to describe a server to which we can send
  23  *  encoding work, and a class to implement such a server.
  24  */
  25
  26 #include "encode_server.h"
  27 #include "util.h"
  28 #include "dcpomatic_socket.h"
  29 #include "image.h"
  30 #include "dcp_video.h"
  31 #include "config.h"
  32 #include "cross.h"
  33 #include "player_video.h"
  34 #include "compose.hpp"
  35 #include "log.h"
  36 #include "dcpomatic_log.h"
  37 #include "encoded_log_entry.h"
  38 #include "version.h"
  39 #include <dcp/raw_convert.h>
  40 #include <libcxml/cxml.h>
  41 #include <libxml++/libxml++.h>
  42 #include <boost/algorithm/string.hpp>
  43 #include <boost/scoped_array.hpp>
  44 #include <boost/foreach.hpp>
  45 #ifdef HAVE_VALGRIND_H
  46 #include <valgrind/memcheck.h>
  47 #endif
  48 #include <string>
  49 #include <vector>
  50 #include <iostream>
  51
  52 #include "i18n.h"
  53
  54 using std::string;
  55 using std::vector;
  56 using std::list;
  57 using std::cout;
  58 using std::cerr;
  59 using std::fixed;
  60 using boost::shared_ptr;
  61 using boost::thread;
  62 using boost::bind;
  63 using boost::scoped_array;
  64 using boost::optional;
  65 using dcp::Size;
  66 using dcp::Data;
  67 using dcp::raw_convert;
  68
  69 EncodeServer::EncodeServer (bool verbose, int num_threads)
  70 #if !defined(RUNNING_ON_VALGRIND) || RUNNING_ON_VALGRIND == 0
  71         : Server (ENCODE_FRAME_PORT)
  72 #else
  73         : Server (ENCODE_FRAME_PORT, 2400)
  74 #endif
  75         , _verbose (verbose)
  76         , _num_threads (num_threads)
  77 {
  78
  79 }
  80
  81 EncodeServer::~EncodeServer ()
  82 {
  83         {
  84                 boost::mutex::scoped_lock lm (_mutex);
  85                 _terminate = true;
  86                 _empty_condition.notify_all ();
  87                 _full_condition.notify_all ();
  88         }
  89
  90         BOOST_FOREACH (boost::thread* i, _worker_threads) {
  91                 /* Ideally this would be a DCPOMATIC_ASSERT(i->joinable()) but we
  92                    can't throw exceptions from a destructor.
  93                 */
  94                 if (i->joinable ()) {
  95                         i->join ();
  96                 }
  97                 delete i;
  98         }
  99
 100         {
 101                 boost::mutex::scoped_lock lm (_broadcast.mutex);
 102                 if (_broadcast.socket) {
 103                         _broadcast.socket->close ();
 104                         delete _broadcast.socket;
 105                         _broadcast.socket = 0;
 106                 }
 107         }
 108
 109         _broadcast.io_service.stop ();
 110         if (_broadcast.thread) {
 111                 /* Ideally this would be a DCPOMATIC_ASSERT(_broadcast.thread->joinable()) but we
 112                    can't throw exceptions from a destructor.
 113                 */
 114                 if (_broadcast.thread->joinable ()) {
 115                         _broadcast.thread->join ();
 116                 }
 117                 delete _broadcast.thread;
 118         }
 119 }
 120
 121 /** @param after_read Filled in with gettimeofday() after reading the input from the network.
 122  *  @param after_encode Filled in with gettimeofday() after encoding the image.
 123  */
 124 int
 125 EncodeServer::process (shared_ptr<Socket> socket, struct timeval& after_read, struct timeval& after_encode)
 126 {
 127         uint32_t length = socket->read_uint32 ();
 128         scoped_array<char> buffer (new char[length]);
 129         socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
 130
 131         string s (buffer.get());
 132         shared_ptr<cxml::Document> xml (new cxml::Document ("EncodingRequest"));
 133         xml->read_string (s);
 134         /* This is a double-check; the server shouldn't even be on the candidate list
 135            if it is the wrong version, but it doesn't hurt to make sure here.
 136         */
 137         if (xml->number_child<int> ("Version") != SERVER_LINK_VERSION) {
 138                 cerr << "Mismatched server/client versions\n";
 139                 LOG_ERROR_NC ("Mismatched server/client versions");
 140                 return -1;
 141         }
 142
 143         shared_ptr<PlayerVideo> pvf (new PlayerVideo (xml, socket));
 144
 145         DCPVideo dcp_video_frame (pvf, xml);
 146
 147         gettimeofday (&after_read, 0);
 148
 149         Data encoded = dcp_video_frame.encode_locally ();
 150
 151         gettimeofday (&after_encode, 0);
 152
 153         try {
 154                 socket->write (encoded.size());
 155                 socket->write (encoded.data().get(), encoded.size());
 156         } catch (std::exception& e) {
 157                 cerr << "Send failed; frame " << dcp_video_frame.index() << "\n";
 158                 LOG_ERROR ("Send failed; frame %1", dcp_video_frame.index());
 159                 throw;
 160         }
 161
 162         return dcp_video_frame.index ();
 163 }
 164
 165 void
 166 EncodeServer::worker_thread ()
 167 {
 168         while (true) {
 169                 boost::mutex::scoped_lock lock (_mutex);
 170                 while (_queue.empty () && !_terminate) {
 171                         _empty_condition.wait (lock);
 172                 }
 173
 174                 if (_terminate) {
 175                         return;
 176                 }
 177
 178                 shared_ptr<Socket> socket = _queue.front ();
 179                 _queue.pop_front ();
 180
 181                 lock.unlock ();
 182
 183                 int frame = -1;
 184                 string ip;
 185
 186                 struct timeval start;
 187                 struct timeval after_read;
 188                 struct timeval after_encode;
 189                 struct timeval end;
 190
 191                 gettimeofday (&start, 0);
 192
 193                 try {
 194                         frame = process (socket, after_read, after_encode);
 195                         ip = socket->socket().remote_endpoint().address().to_string();
 196                 } catch (std::exception& e) {
 197                         cerr << "Error: " << e.what() << "\n";
 198                         LOG_ERROR ("Error: %1", e.what());
 199                 }
 200
 201                 gettimeofday (&end, 0);
 202
 203                 socket.reset ();
 204
 205                 lock.lock ();
 206
 207                 if (frame >= 0) {
 208                         struct timeval end;
 209                         gettimeofday (&end, 0);
 210
 211                         shared_ptr<EncodedLogEntry> e (
 212                                 new EncodedLogEntry (
 213                                         frame, ip,
 214                                         seconds(after_read) - seconds(start),
 215                                         seconds(after_encode) - seconds(after_read),
 216                                         seconds(end) - seconds(after_encode)
 217                                         )
 218                                 );
 219
 220                         if (_verbose) {
 221                                 cout << e->get() << "\n";
 222                         }
 223
 224                         dcpomatic_log->log (e);
 225                 }
 226
 227                 _full_condition.notify_all ();
 228         }
 229 }
 230
 231 void
 232 EncodeServer::run ()
 233 {
 234         LOG_GENERAL ("Server %1 (%2) starting with %3 threads", dcpomatic_version, dcpomatic_git_commit, _num_threads);
 235         if (_verbose) {
 236                 cout << "DCP-o-matic server starting with " << _num_threads << " threads.\n";
 237         }
 238
 239         for (int i = 0; i < _num_threads; ++i) {
 240                 thread* t = new thread (bind (&EncodeServer::worker_thread, this));
 241 #ifdef DCPOMATIC_LINUX
 242                 pthread_setname_np (t->native_handle(), "encode-server-worker");
 243 #endif
 244                 _worker_threads.push_back (t);
 245         }
 246
 247         _broadcast.thread = new thread (bind (&EncodeServer::broadcast_thread, this));
 248 #ifdef DCPOMATIC_LINUX
 249         pthread_setname_np (_broadcast.thread->native_handle(), "encode-server-broadcast");
 250 #endif
 251
 252         Server::run ();
 253 }
 254
 255 void
 256 EncodeServer::broadcast_thread ()
 257 try
 258 {
 259         boost::asio::ip::address address = boost::asio::ip::address_v4::any ();
 260         boost::asio::ip::udp::endpoint listen_endpoint (address, HELLO_PORT);
 261
 262         _broadcast.socket = new boost::asio::ip::udp::socket (_broadcast.io_service);
 263         _broadcast.socket->open (listen_endpoint.protocol ());
 264         _broadcast.socket->bind (listen_endpoint);
 265
 266         _broadcast.socket->async_receive_from (
 267                 boost::asio::buffer (_broadcast.buffer, sizeof (_broadcast.buffer)),
 268                 _broadcast.send_endpoint,
 269                 boost::bind (&EncodeServer::broadcast_received, this)
 270                 );
 271
 272         _broadcast.io_service.run ();
 273 }
 274 catch (...)
 275 {
 276         store_current ();
 277 }
 278
 279 void
 280 EncodeServer::broadcast_received ()
 281 {
 282         _broadcast.buffer[sizeof(_broadcast.buffer) - 1] = '\0';
 283
 284         if (strcmp (_broadcast.buffer, DCPOMATIC_HELLO) == 0) {
 285                 /* Reply to the client saying what we can do */
 286                 xmlpp::Document doc;
 287                 xmlpp::Element* root = doc.create_root_node ("ServerAvailable");
 288                 root->add_child("Threads")->add_child_text (raw_convert<string> (_worker_threads.size ()));
 289                 root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
 290                 string xml = doc.write_to_string ("UTF-8");
 291
 292                 if (_verbose) {
 293                         cout << "Offering services to master " << _broadcast.send_endpoint.address().to_string () << "\n";
 294                 }
 295
 296                 try {
 297                         shared_ptr<Socket> socket (new Socket);
 298                         socket->connect (boost::asio::ip::tcp::endpoint (_broadcast.send_endpoint.address(), MAIN_SERVER_PRESENCE_PORT));
 299                         socket->write (xml.length() + 1);
 300                         socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
 301                 } catch (...) {
 302
 303                 }
 304
 305                 try {
 306                         shared_ptr<Socket> socket (new Socket);
 307                         socket->connect (boost::asio::ip::tcp::endpoint (_broadcast.send_endpoint.address(), BATCH_SERVER_PRESENCE_PORT));
 308                         socket->write (xml.length() + 1);
 309                         socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
 310                 } catch (...) {
 311
 312                 }
 313         }
 314
 315         boost::mutex::scoped_lock lm (_broadcast.mutex);
 316         if (_broadcast.socket) {
 317                 _broadcast.socket->async_receive_from (
 318                         boost::asio::buffer (_broadcast.buffer, sizeof (_broadcast.buffer)),
 319                         _broadcast.send_endpoint, boost::bind (&EncodeServer::broadcast_received, this)
 320                         );
 321         }
 322 }
 323
 324 void
 325 EncodeServer::handle (shared_ptr<Socket> socket)
 326 {
 327         boost::mutex::scoped_lock lock (_mutex);
 328
 329         Waker waker;
 330         waker.nudge ();
 331
 332         /* Wait until the queue has gone down a bit */
 333         while (_queue.size() >= _worker_threads.size() * 2 && !_terminate) {
 334                 _full_condition.wait (lock);
 335         }
 336
 337         _queue.push_back (socket);
 338         _empty_condition.notify_all ();
 339 }