src/lib/encode_server.cc

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