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