src/lib/encode_server.cc

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