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 "warnings.h"
  40 #include <dcp/raw_convert.h>
  41 #include <libcxml/cxml.h>
  42 DCPOMATIC_DISABLE_WARNINGS
  43 #include <libxml++/libxml++.h>
  44 DCPOMATIC_ENABLE_WARNINGS
  45 #include <boost/algorithm/string.hpp>
  46 #include <boost/scoped_array.hpp>
  47 #include <boost/foreach.hpp>
  48 #ifdef HAVE_VALGRIND_H
  49 #include <valgrind/memcheck.h>
  50 #endif
  51 #include <string>
  52 #include <vector>
  53 #include <iostream>
  54
  55 #include "i18n.h"
  56
  57 using std::string;
  58 using std::vector;
  59 using std::list;
  60 using std::cout;
  61 using std::cerr;
  62 using std::fixed;
  63 using boost::shared_ptr;
  64 using boost::thread;
  65 using boost::bind;
  66 using boost::scoped_array;
  67 using boost::optional;
  68 using dcp::ArrayData;
  69 using dcp::Size;
  70 using dcp::raw_convert;
  71
  72 EncodeServer::EncodeServer (bool verbose, int num_threads)
  73 #if !defined(RUNNING_ON_VALGRIND) || RUNNING_ON_VALGRIND == 0
  74         : Server (ENCODE_FRAME_PORT)
  75 #else
  76         : Server (ENCODE_FRAME_PORT, 2400)
  77 #endif
  78         , _verbose (verbose)
  79         , _num_threads (num_threads)
  80 {
  81
  82 }
  83
  84 EncodeServer::~EncodeServer ()
  85 {
  86         boost::this_thread::disable_interruption dis;
  87
  88         {
  89                 boost::mutex::scoped_lock lm (_mutex);
  90                 _terminate = true;
  91                 _empty_condition.notify_all ();
  92                 _full_condition.notify_all ();
  93         }
  94
  95         try {
  96                 _worker_threads.join_all ();
  97         } catch (...) {}
  98
  99         {
 100                 boost::mutex::scoped_lock lm (_broadcast.mutex);
 101                 if (_broadcast.socket) {
 102                         _broadcast.socket->close ();
 103                         delete _broadcast.socket;
 104                         _broadcast.socket = 0;
 105                 }
 106         }
 107
 108         _broadcast.io_service.stop ();
 109         try {
 110                 _broadcast.thread.join ();
 111         } catch (...) {}
 112 }
 113
 114 /** @param after_read Filled in with gettimeofday() after reading the input from the network.
 115  *  @param after_encode Filled in with gettimeofday() after encoding the image.
 116  */
 117 int
 118 EncodeServer::process (shared_ptr<Socket> socket, struct timeval& after_read, struct timeval& after_encode)
 119 {
 120         Socket::ReadDigestScope ds (socket);
 121
 122         uint32_t length = socket->read_uint32 ();
 123         scoped_array<char> buffer (new char[length]);
 124         socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
 125
 126         string s (buffer.get());
 127         shared_ptr<cxml::Document> xml (new cxml::Document ("EncodingRequest"));
 128         xml->read_string (s);
 129         /* This is a double-check; the server shouldn't even be on the candidate list
 130            if it is the wrong version, but it doesn't hurt to make sure here.
 131         */
 132         if (xml->number_child<int> ("Version") != SERVER_LINK_VERSION) {
 133                 cerr << "Mismatched server/client versions\n";
 134                 LOG_ERROR_NC ("Mismatched server/client versions");
 135                 return -1;
 136         }
 137
 138         shared_ptr<PlayerVideo> pvf (new PlayerVideo (xml, socket));
 139
 140         if (!ds.check()) {
 141                 throw NetworkError ("Checksums do not match");
 142         }
 143
 144         DCPVideo dcp_video_frame (pvf, xml);
 145
 146         gettimeofday (&after_read, 0);
 147
 148         ArrayData encoded = dcp_video_frame.encode_locally ();
 149
 150         gettimeofday (&after_encode, 0);
 151
 152         try {
 153                 Socket::WriteDigestScope ds (socket);
 154                 socket->write (encoded.size());
 155                 socket->write (encoded.data(), 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 #ifdef DCPOMATIC_LINUX
 241                 boost::thread* t = _worker_threads.create_thread (bind(&EncodeServer::worker_thread, this));
 242                 pthread_setname_np (t->native_handle(), "encode-server-worker");
 243 #else
 244                 _worker_threads.create_thread (bind(&EncodeServer::worker_thread, this));
 245 #endif
 246         }
 247
 248         _broadcast.thread = thread (bind(&EncodeServer::broadcast_thread, this));
 249 #ifdef DCPOMATIC_LINUX
 250         pthread_setname_np (_broadcast.thread.native_handle(), "encode-server-broadcast");
 251 #endif
 252
 253         Server::run ();
 254 }
 255
 256 void
 257 EncodeServer::broadcast_thread ()
 258 try
 259 {
 260         boost::asio::ip::address address = boost::asio::ip::address_v4::any ();
 261         boost::asio::ip::udp::endpoint listen_endpoint (address, HELLO_PORT);
 262
 263         _broadcast.socket = new boost::asio::ip::udp::socket (_broadcast.io_service);
 264         _broadcast.socket->open (listen_endpoint.protocol ());
 265         _broadcast.socket->bind (listen_endpoint);
 266
 267         _broadcast.socket->async_receive_from (
 268                 boost::asio::buffer (_broadcast.buffer, sizeof (_broadcast.buffer)),
 269                 _broadcast.send_endpoint,
 270                 boost::bind (&EncodeServer::broadcast_received, this)
 271                 );
 272
 273         _broadcast.io_service.run ();
 274 }
 275 catch (...)
 276 {
 277         store_current ();
 278 }
 279
 280 void
 281 EncodeServer::broadcast_received ()
 282 {
 283         _broadcast.buffer[sizeof(_broadcast.buffer) - 1] = '\0';
 284
 285         if (strcmp (_broadcast.buffer, DCPOMATIC_HELLO) == 0) {
 286                 /* Reply to the client saying what we can do */
 287                 xmlpp::Document doc;
 288                 xmlpp::Element* root = doc.create_root_node ("ServerAvailable");
 289                 root->add_child("Threads")->add_child_text (raw_convert<string> (_worker_threads.size ()));
 290                 root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
 291                 string xml = doc.write_to_string ("UTF-8");
 292
 293                 if (_verbose) {
 294                         cout << "Offering services to master " << _broadcast.send_endpoint.address().to_string () << "\n";
 295                 }
 296
 297                 try {
 298                         shared_ptr<Socket> socket (new Socket);
 299                         socket->connect (boost::asio::ip::tcp::endpoint (_broadcast.send_endpoint.address(), MAIN_SERVER_PRESENCE_PORT));
 300                         socket->write (xml.length() + 1);
 301                         socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
 302                 } catch (...) {
 303
 304                 }
 305
 306                 try {
 307                         shared_ptr<Socket> socket (new Socket);
 308                         socket->connect (boost::asio::ip::tcp::endpoint (_broadcast.send_endpoint.address(), BATCH_SERVER_PRESENCE_PORT));
 309                         socket->write (xml.length() + 1);
 310                         socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
 311                 } catch (...) {
 312
 313                 }
 314         }
 315
 316         boost::mutex::scoped_lock lm (_broadcast.mutex);
 317         if (_broadcast.socket) {
 318                 _broadcast.socket->async_receive_from (
 319                         boost::asio::buffer (_broadcast.buffer, sizeof (_broadcast.buffer)),
 320                         _broadcast.send_endpoint, boost::bind (&EncodeServer::broadcast_received, this)
 321                         );
 322         }
 323 }
 324
 325 void
 326 EncodeServer::handle (shared_ptr<Socket> socket)
 327 {
 328         boost::mutex::scoped_lock lock (_mutex);
 329
 330         Waker waker;
 331         waker.nudge ();
 332
 333         /* Wait until the queue has gone down a bit */
 334         while (_queue.size() >= _worker_threads.size() * 2 && !_terminate) {
 335                 _full_condition.wait (lock);
 336         }
 337
 338         _queue.push_back (socket);
 339         _empty_condition.notify_all ();
 340 }