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