Fix possible null pointer dereference.
[dcpomatic.git] / src / lib / server.cc
1 /*
2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 /** @file src/server.cc
21  *  @brief Class to describe a server to which we can send
22  *  encoding work, and a class to implement such a server.
23  */
24
25 #include "server.h"
26 #include "util.h"
27 #include "dcpomatic_socket.h"
28 #include "image.h"
29 #include "dcp_video.h"
30 #include "config.h"
31 #include "cross.h"
32 #include "player_video.h"
33 #include "data.h"
34 #include "safe_stringstream.h"
35 #include "raw_convert.h"
36 #include "compose.hpp"
37 #include "log.h"
38 #include <libcxml/cxml.h>
39 #include <libxml++/libxml++.h>
40 #include <boost/algorithm/string.hpp>
41 #include <boost/scoped_array.hpp>
42 #include <string>
43 #include <vector>
44 #include <iostream>
45
46 #include "i18n.h"
47
48 #define LOG_GENERAL(...)    _log->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
49 #define LOG_GENERAL_NC(...) _log->log (__VA_ARGS__, Log::TYPE_GENERAL);
50 #define LOG_ERROR(...)      _log->log (String::compose (__VA_ARGS__), Log::TYPE_ERROR);
51 #define LOG_ERROR_NC(...)   _log->log (__VA_ARGS__, Log::TYPE_ERROR);
52
53 using std::string;
54 using std::vector;
55 using std::list;
56 using std::cout;
57 using std::cerr;
58 using std::fixed;
59 using boost::shared_ptr;
60 using boost::thread;
61 using boost::bind;
62 using boost::scoped_array;
63 using boost::optional;
64 using dcp::Size;
65
66 Server::Server (shared_ptr<Log> log, bool verbose)
67         : _terminate (false)
68         , _log (log)
69         , _verbose (verbose)
70         , _acceptor (_io_service, boost::asio::ip::tcp::endpoint (boost::asio::ip::tcp::v4(), Config::instance()->server_port_base()))
71 {
72
73 }
74
75 Server::~Server ()
76 {
77         {
78                 boost::mutex::scoped_lock lm (_worker_mutex);
79                 _terminate = true;
80                 _empty_condition.notify_all ();
81                 _full_condition.notify_all ();
82         }
83
84         for (vector<boost::thread*>::iterator i = _worker_threads.begin(); i != _worker_threads.end(); ++i) {
85                 (*i)->join ();
86                 delete *i;
87         }
88
89         _io_service.stop ();
90
91         _broadcast.io_service.stop ();
92         if (_broadcast.thread) {
93                 _broadcast.thread->join ();
94         }
95 }
96
97 /** @param after_read Filled in with gettimeofday() after reading the input from the network.
98  *  @param after_encode Filled in with gettimeofday() after encoding the image.
99  */
100 int
101 Server::process (shared_ptr<Socket> socket, struct timeval& after_read, struct timeval& after_encode)
102 {
103         uint32_t length = socket->read_uint32 ();
104         scoped_array<char> buffer (new char[length]);
105         socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
106
107         string s (buffer.get());
108         shared_ptr<cxml::Document> xml (new cxml::Document ("EncodingRequest"));
109         xml->read_string (s);
110         /* This is a double-check; the server shouldn't even be on the candidate list
111            if it is the wrong version, but it doesn't hurt to make sure here.
112         */
113         if (xml->number_child<int> ("Version") != SERVER_LINK_VERSION) {
114                 cerr << "Mismatched server/client versions\n";
115                 LOG_ERROR_NC ("Mismatched server/client versions");
116                 return -1;
117         }
118
119         shared_ptr<PlayerVideo> pvf (new PlayerVideo (xml, socket));
120
121         DCPVideo dcp_video_frame (pvf, xml, _log);
122
123         gettimeofday (&after_read, 0);
124
125         Data encoded = dcp_video_frame.encode_locally (boost::bind (&Log::dcp_log, _log.get(), _1, _2));
126
127         gettimeofday (&after_encode, 0);
128
129         try {
130                 socket->write (encoded.size ());
131                 socket->write (encoded.data ().get (), encoded.size ());
132         } catch (std::exception& e) {
133                 cerr << "Send failed; frame " << dcp_video_frame.index() << "\n";
134                 LOG_ERROR ("Send failed; frame %1", dcp_video_frame.index());
135                 throw;
136         }
137
138         return dcp_video_frame.index ();
139 }
140
141 void
142 Server::worker_thread ()
143 {
144         while (true) {
145                 boost::mutex::scoped_lock lock (_worker_mutex);
146                 while (_queue.empty () && !_terminate) {
147                         _empty_condition.wait (lock);
148                 }
149
150                 if (_terminate) {
151                         return;
152                 }
153
154                 shared_ptr<Socket> socket = _queue.front ();
155                 _queue.pop_front ();
156
157                 lock.unlock ();
158
159                 int frame = -1;
160                 string ip;
161
162                 struct timeval start;
163                 struct timeval after_read;
164                 struct timeval after_encode;
165                 struct timeval end;
166
167                 gettimeofday (&start, 0);
168
169                 try {
170                         frame = process (socket, after_read, after_encode);
171                         ip = socket->socket().remote_endpoint().address().to_string();
172                 } catch (std::exception& e) {
173                         cerr << "Error: " << e.what() << "\n";
174                         LOG_ERROR ("Error: %1", e.what());
175                 }
176
177                 gettimeofday (&end, 0);
178
179                 socket.reset ();
180
181                 lock.lock ();
182
183                 if (frame >= 0) {
184                         struct timeval end;
185                         gettimeofday (&end, 0);
186
187                         SafeStringStream message;
188                         message.precision (2);
189                         message << fixed
190                                 << "Encoded frame " << frame << " from " << ip << ": "
191                                 << "receive " << (seconds(after_read) - seconds(start)) << "s "
192                                 << "encode " << (seconds(after_encode) - seconds(after_read)) << "s "
193                                 << "send " << (seconds(end) - seconds(after_encode)) << "s.";
194
195                         if (_verbose) {
196                                 cout << message.str() << "\n";
197                         }
198
199                         LOG_GENERAL_NC (message.str ());
200                 }
201
202                 _full_condition.notify_all ();
203         }
204 }
205
206 void
207 Server::run (int num_threads)
208 {
209         LOG_GENERAL ("Server starting with %1 threads", num_threads);
210         if (_verbose) {
211                 cout << "DCP-o-matic server starting with " << num_threads << " threads.\n";
212         }
213
214         for (int i = 0; i < num_threads; ++i) {
215                 _worker_threads.push_back (new thread (bind (&Server::worker_thread, this)));
216         }
217
218         _broadcast.thread = new thread (bind (&Server::broadcast_thread, this));
219
220         start_accept ();
221         _io_service.run ();
222 }
223
224 void
225 Server::broadcast_thread ()
226 try
227 {
228         boost::asio::ip::address address = boost::asio::ip::address_v4::any ();
229         boost::asio::ip::udp::endpoint listen_endpoint (address, Config::instance()->server_port_base() + 1);
230
231         _broadcast.socket = new boost::asio::ip::udp::socket (_broadcast.io_service);
232         _broadcast.socket->open (listen_endpoint.protocol ());
233         _broadcast.socket->bind (listen_endpoint);
234
235         _broadcast.socket->async_receive_from (
236                 boost::asio::buffer (_broadcast.buffer, sizeof (_broadcast.buffer)),
237                 _broadcast.send_endpoint,
238                 boost::bind (&Server::broadcast_received, this)
239                 );
240
241         _broadcast.io_service.run ();
242 }
243 catch (...)
244 {
245         store_current ();
246 }
247
248 void
249 Server::broadcast_received ()
250 {
251         _broadcast.buffer[sizeof(_broadcast.buffer) - 1] = '\0';
252
253         if (strcmp (_broadcast.buffer, DCPOMATIC_HELLO) == 0) {
254                 /* Reply to the client saying what we can do */
255                 xmlpp::Document doc;
256                 xmlpp::Element* root = doc.create_root_node ("ServerAvailable");
257                 root->add_child("Threads")->add_child_text (raw_convert<string> (_worker_threads.size ()));
258                 root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
259                 string xml = doc.write_to_string ("UTF-8");
260
261                 if (_verbose) {
262                         cout << "Offering services to master " << _broadcast.send_endpoint.address().to_string () << "\n";
263                 }
264                 shared_ptr<Socket> socket (new Socket);
265                 try {
266                         socket->connect (boost::asio::ip::tcp::endpoint (_broadcast.send_endpoint.address(), Config::instance()->server_port_base() + 1));
267                         socket->write (xml.length() + 1);
268                         socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
269                 } catch (...) {
270
271                 }
272         }
273
274         _broadcast.socket->async_receive_from (
275                 boost::asio::buffer (_broadcast.buffer, sizeof (_broadcast.buffer)),
276                 _broadcast.send_endpoint, boost::bind (&Server::broadcast_received, this)
277                 );
278 }
279
280 void
281 Server::start_accept ()
282 {
283         if (_terminate) {
284                 return;
285         }
286
287         shared_ptr<Socket> socket (new Socket);
288         _acceptor.async_accept (socket->socket (), boost::bind (&Server::handle_accept, this, socket, boost::asio::placeholders::error));
289 }
290
291 void
292 Server::handle_accept (shared_ptr<Socket> socket, boost::system::error_code const & error)
293 {
294         if (error) {
295                 return;
296         }
297
298         boost::mutex::scoped_lock lock (_worker_mutex);
299
300         /* Wait until the queue has gone down a bit */
301         while (_queue.size() >= _worker_threads.size() * 2 && !_terminate) {
302                 _full_condition.wait (lock);
303         }
304
305         _queue.push_back (socket);
306         _empty_condition.notify_all ();
307
308         start_accept ();
309 }