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 #ifdef HAVE_VALGRIND_H
  48 #include <valgrind/memcheck.h>
  49 #endif
  50 #include <string>
  51 #include <vector>
  52 #include <iostream>
  53
  54 #include "i18n.h"
  55
  56 using std::string;
  57 using std::vector;
  58 using std::list;
  59 using std::cout;
  60 using std::cerr;
  61 using std::fixed;
  62 using std::shared_ptr;
  63 using boost::thread;
  64 using boost::bind;
  65 using boost::scoped_array;
  66 using boost::optional;
  67 using dcp::ArrayData;
  68 using dcp::Size;
  69 using dcp::raw_convert;
  70
  71 EncodeServer::EncodeServer (bool verbose, int num_threads)
  72 #if !defined(RUNNING_ON_VALGRIND) || RUNNING_ON_VALGRIND == 0
  73         : Server (ENCODE_FRAME_PORT)
  74 #else
  75         : Server (ENCODE_FRAME_PORT, 2400)
  76 #endif
  77         , _verbose (verbose)
  78         , _num_threads (num_threads)
  79 {
  80
  81 }
  82
  83 EncodeServer::~EncodeServer ()
  84 {
  85         boost::this_thread::disable_interruption dis;
  86
  87         {
  88                 boost::mutex::scoped_lock lm (_mutex);
  89                 _terminate = true;
  90                 _empty_condition.notify_all ();
  91                 _full_condition.notify_all ();
  92         }
  93
  94         try {
  95                 _worker_threads.join_all ();
  96         } catch (...) {}
  97
  98         {
  99                 boost::mutex::scoped_lock lm (_broadcast.mutex);
 100                 if (_broadcast.socket) {
 101                         _broadcast.socket->close ();
 102                         delete _broadcast.socket;
 103                         _broadcast.socket = 0;
 104                 }
 105         }
 106
 107         _broadcast.io_service.stop ();
 108         try {
 109                 _broadcast.thread.join ();
 110         } catch (...) {}
 111 }
 112
 113 /** @param after_read Filled in with gettimeofday() after reading the input from the network.
 114  *  @param after_encode Filled in with gettimeofday() after encoding the image.
 115  */
 116 int
 117 EncodeServer::process (shared_ptr<Socket> socket, struct timeval& after_read, struct timeval& after_encode)
 118 {
 119         Socket::ReadDigestScope ds (socket);
 120
 121         uint32_t length = socket->read_uint32 ();
 122         scoped_array<char> buffer (new char[length]);
 123         socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
 124
 125         string s (buffer.get());
 126         shared_ptr<cxml::Document> xml (new cxml::Document ("EncodingRequest"));
 127         xml->read_string (s);
 128         /* This is a double-check; the server shouldn't even be on the candidate list
 129            if it is the wrong version, but it doesn't hurt to make sure here.
 130         */
 131         if (xml->number_child<int> ("Version") != SERVER_LINK_VERSION) {
 132                 cerr << "Mismatched server/client versions\n";
 133                 LOG_ERROR_NC ("Mismatched server/client versions");
 134                 return -1;
 135         }
 136
 137         shared_ptr<PlayerVideo> pvf (new PlayerVideo (xml, socket));
 138
 139         if (!ds.check()) {
 140                 throw NetworkError ("Checksums do not match");
 141         }
 142
 143         DCPVideo dcp_video_frame (pvf, xml);
 144
 145         gettimeofday (&after_read, 0);
 146
 147         ArrayData encoded = dcp_video_frame.encode_locally ();
 148
 149         gettimeofday (&after_encode, 0);
 150
 151         try {
 152                 Socket::WriteDigestScope ds (socket);
 153                 socket->write (encoded.size());
 154                 socket->write (encoded.data(), encoded.size());
 155         } catch (std::exception& e) {
 156                 cerr << "Send failed; frame " << dcp_video_frame.index() << "\n";
 157                 LOG_ERROR ("Send failed; frame %1", dcp_video_frame.index());
 158                 throw;
 159         }
 160
 161         return dcp_video_frame.index ();
 162 }
 163
 164 void
 165 EncodeServer::worker_thread ()
 166 {
 167         while (true) {
 168                 boost::mutex::scoped_lock lock (_mutex);
 169                 while (_queue.empty () && !_terminate) {
 170                         _empty_condition.wait (lock);
 171                 }
 172
 173                 if (_terminate) {
 174                         return;
 175                 }
 176
 177                 shared_ptr<Socket> socket = _queue.front ();
 178                 _queue.pop_front ();
 179
 180                 lock.unlock ();
 181
 182                 int frame = -1;
 183                 string ip;
 184
 185                 struct timeval start;
 186                 struct timeval after_read;
 187                 struct timeval after_encode;
 188                 struct timeval end;
 189
 190                 gettimeofday (&start, 0);
 191
 192                 try {
 193                         frame = process (socket, after_read, after_encode);
 194                         ip = socket->socket().remote_endpoint().address().to_string();
 195                 } catch (std::exception& e) {
 196                         cerr << "Error: " << e.what() << "\n";
 197                         LOG_ERROR ("Error: %1", e.what());
 198                 }
 199
 200                 gettimeofday (&end, 0);
 201
 202                 socket.reset ();
 203
 204                 lock.lock ();
 205
 206                 if (frame >= 0) {
 207                         struct timeval end;
 208                         gettimeofday (&end, 0);
 209
 210                         shared_ptr<EncodedLogEntry> e (
 211                                 new EncodedLogEntry (
 212                                         frame, ip,
 213                                         seconds(after_read) - seconds(start),
 214                                         seconds(after_encode) - seconds(after_read),
 215                                         seconds(end) - seconds(after_encode)
 216                                         )
 217                                 );
 218
 219                         if (_verbose) {
 220                                 cout << e->get() << "\n";
 221                         }
 222
 223                         dcpomatic_log->log (e);
 224                 }
 225
 226                 _full_condition.notify_all ();
 227         }
 228 }
 229
 230 void
 231 EncodeServer::run ()
 232 {
 233         LOG_GENERAL ("Server %1 (%2) starting with %3 threads", dcpomatic_version, dcpomatic_git_commit, _num_threads);
 234         if (_verbose) {
 235                 cout << "DCP-o-matic server starting with " << _num_threads << " threads.\n";
 236         }
 237
 238         for (int i = 0; i < _num_threads; ++i) {
 239 #ifdef DCPOMATIC_LINUX
 240                 boost::thread* t = _worker_threads.create_thread (bind(&EncodeServer::worker_thread, this));
 241                 pthread_setname_np (t->native_handle(), "encode-server-worker");
 242 #else
 243                 _worker_threads.create_thread (bind(&EncodeServer::worker_thread, this));
 244 #endif
 245         }
 246
 247         _broadcast.thread = 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 }