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