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