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