assert (joinable) before joining threads.
[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         BOOST_FOREACH (boost::thread* i, _worker_threads) {
85                 DCPOMATIC_ASSERT (i->joinable ());
86                 i->join ();
87                 delete i;
88         }
89
90         _io_service.stop ();
91
92         _broadcast.io_service.stop ();
93         if (_broadcast.thread) {
94                 DCPOMATIC_ASSERT (_broadcast.thread->join ());
95                 _broadcast.thread->join ();
96         }
97 }
98
99 /** @param after_read Filled in with gettimeofday() after reading the input from the network.
100  *  @param after_encode Filled in with gettimeofday() after encoding the image.
101  */
102 int
103 Server::process (shared_ptr<Socket> socket, struct timeval& after_read, struct timeval& after_encode)
104 {
105         uint32_t length = socket->read_uint32 ();
106         scoped_array<char> buffer (new char[length]);
107         socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
108
109         string s (buffer.get());
110         shared_ptr<cxml::Document> xml (new cxml::Document ("EncodingRequest"));
111         xml->read_string (s);
112         /* This is a double-check; the server shouldn't even be on the candidate list
113            if it is the wrong version, but it doesn't hurt to make sure here.
114         */
115         if (xml->number_child<int> ("Version") != SERVER_LINK_VERSION) {
116                 cerr << "Mismatched server/client versions\n";
117                 LOG_ERROR_NC ("Mismatched server/client versions");
118                 return -1;
119         }
120
121         shared_ptr<PlayerVideo> pvf (new PlayerVideo (xml, socket));
122
123         DCPVideo dcp_video_frame (pvf, xml, _log);
124
125         gettimeofday (&after_read, 0);
126
127         Data encoded = dcp_video_frame.encode_locally (boost::bind (&Log::dcp_log, _log.get(), _1, _2));
128
129         gettimeofday (&after_encode, 0);
130
131         try {
132                 socket->write (encoded.size ());
133                 socket->write (encoded.data ().get (), encoded.size ());
134         } catch (std::exception& e) {
135                 cerr << "Send failed; frame " << dcp_video_frame.index() << "\n";
136                 LOG_ERROR ("Send failed; frame %1", dcp_video_frame.index());
137                 throw;
138         }
139
140         return dcp_video_frame.index ();
141 }
142
143 void
144 Server::worker_thread ()
145 {
146         while (true) {
147                 boost::mutex::scoped_lock lock (_worker_mutex);
148                 while (_queue.empty () && !_terminate) {
149                         _empty_condition.wait (lock);
150                 }
151
152                 if (_terminate) {
153                         return;
154                 }
155
156                 shared_ptr<Socket> socket = _queue.front ();
157                 _queue.pop_front ();
158
159                 lock.unlock ();
160
161                 int frame = -1;
162                 string ip;
163
164                 struct timeval start;
165                 struct timeval after_read;
166                 struct timeval after_encode;
167                 struct timeval end;
168
169                 gettimeofday (&start, 0);
170
171                 try {
172                         frame = process (socket, after_read, after_encode);
173                         ip = socket->socket().remote_endpoint().address().to_string();
174                 } catch (std::exception& e) {
175                         cerr << "Error: " << e.what() << "\n";
176                         LOG_ERROR ("Error: %1", e.what());
177                 }
178
179                 gettimeofday (&end, 0);
180
181                 socket.reset ();
182
183                 lock.lock ();
184
185                 if (frame >= 0) {
186                         struct timeval end;
187                         gettimeofday (&end, 0);
188
189                         SafeStringStream message;
190                         message.precision (2);
191                         message << fixed
192                                 << "Encoded frame " << frame << " from " << ip << ": "
193                                 << "receive " << (seconds(after_read) - seconds(start)) << "s "
194                                 << "encode " << (seconds(after_encode) - seconds(after_read)) << "s "
195                                 << "send " << (seconds(end) - seconds(after_encode)) << "s.";
196
197                         if (_verbose) {
198                                 cout << message.str() << "\n";
199                         }
200
201                         LOG_GENERAL_NC (message.str ());
202                 }
203
204                 _full_condition.notify_all ();
205         }
206 }
207
208 void
209 Server::run (int num_threads)
210 {
211         LOG_GENERAL ("Server starting with %1 threads", num_threads);
212         if (_verbose) {
213                 cout << "DCP-o-matic server starting with " << num_threads << " threads.\n";
214         }
215
216         for (int i = 0; i < num_threads; ++i) {
217                 _worker_threads.push_back (new thread (bind (&Server::worker_thread, this)));
218         }
219
220         _broadcast.thread = new thread (bind (&Server::broadcast_thread, this));
221
222         start_accept ();
223         _io_service.run ();
224 }
225
226 void
227 Server::broadcast_thread ()
228 try
229 {
230         boost::asio::ip::address address = boost::asio::ip::address_v4::any ();
231         boost::asio::ip::udp::endpoint listen_endpoint (address, Config::instance()->server_port_base() + 1);
232
233         _broadcast.socket = new boost::asio::ip::udp::socket (_broadcast.io_service);
234         _broadcast.socket->open (listen_endpoint.protocol ());
235         _broadcast.socket->bind (listen_endpoint);
236
237         _broadcast.socket->async_receive_from (
238                 boost::asio::buffer (_broadcast.buffer, sizeof (_broadcast.buffer)),
239                 _broadcast.send_endpoint,
240                 boost::bind (&Server::broadcast_received, this)
241                 );
242
243         _broadcast.io_service.run ();
244 }
245 catch (...)
246 {
247         store_current ();
248 }
249
250 void
251 Server::broadcast_received ()
252 {
253         _broadcast.buffer[sizeof(_broadcast.buffer) - 1] = '\0';
254
255         if (strcmp (_broadcast.buffer, DCPOMATIC_HELLO) == 0) {
256                 /* Reply to the client saying what we can do */
257                 xmlpp::Document doc;
258                 xmlpp::Element* root = doc.create_root_node ("ServerAvailable");
259                 root->add_child("Threads")->add_child_text (raw_convert<string> (_worker_threads.size ()));
260                 root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
261                 string xml = doc.write_to_string ("UTF-8");
262
263                 if (_verbose) {
264                         cout << "Offering services to master " << _broadcast.send_endpoint.address().to_string () << "\n";
265                 }
266                 shared_ptr<Socket> socket (new Socket);
267                 try {
268                         socket->connect (boost::asio::ip::tcp::endpoint (_broadcast.send_endpoint.address(), Config::instance()->server_port_base() + 1));
269                         socket->write (xml.length() + 1);
270                         socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
271                 } catch (...) {
272
273                 }
274         }
275
276         _broadcast.socket->async_receive_from (
277                 boost::asio::buffer (_broadcast.buffer, sizeof (_broadcast.buffer)),
278                 _broadcast.send_endpoint, boost::bind (&Server::broadcast_received, this)
279                 );
280 }
281
282 void
283 Server::start_accept ()
284 {
285         if (_terminate) {
286                 return;
287         }
288
289         shared_ptr<Socket> socket (new Socket);
290         _acceptor.async_accept (socket->socket (), boost::bind (&Server::handle_accept, this, socket, boost::asio::placeholders::error));
291 }
292
293 void
294 Server::handle_accept (shared_ptr<Socket> socket, boost::system::error_code const & error)
295 {
296         if (error) {
297                 return;
298         }
299
300         boost::mutex::scoped_lock lock (_worker_mutex);
301
302         /* Wait until the queue has gone down a bit */
303         while (_queue.size() >= _worker_threads.size() * 2 && !_terminate) {
304                 _full_condition.wait (lock);
305         }
306
307         _queue.push_back (socket);
308         _empty_condition.notify_all ();
309
310         start_accept ();
311 }