2 Copyright (C) 2019-2020 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
21 #include "lib/disk_writer_messages.h"
22 #include "lib/compose.hpp"
23 #include "lib/exceptions.h"
24 #include "lib/cross.h"
25 #include "lib/digester.h"
26 #include "lib/file_log.h"
27 #include "lib/dcpomatic_log.h"
28 #include "lib/nanomsg.h"
30 #include <lwext4/ext4_mbr.h>
31 #include <lwext4/ext4_fs.h>
32 #include <lwext4/ext4_mkfs.h>
33 #include <lwext4/ext4_errno.h>
34 #include <lwext4/ext4_debug.h>
35 #include <lwext4/ext4.h>
38 #ifdef DCPOMATIC_POSIX
39 #include <sys/ioctl.h>
40 #include <sys/types.h>
47 #include <lwext4/file_dev.h>
51 #ifdef DCPOMATIC_LINUX
53 #include <polkit/polkit.h>
55 #include <lwext4/file_dev.h>
60 #ifdef DCPOMATIC_WINDOWS
62 #include <lwext4/file_windows.h>
68 #include <sys/types.h>
69 #include <boost/filesystem.hpp>
70 #include <boost/algorithm/string.hpp>
76 using std::runtime_error;
78 using boost::optional;
80 #ifdef DCPOMATIC_LINUX
81 static PolkitAuthority* polkit_authority = 0;
83 static uint64_t const block_size = 4096;
84 static Nanomsg* nanomsg = 0;
86 #define SHORT_TIMEOUT 100
87 #define LONG_TIMEOUT 2000
91 count (boost::filesystem::path dir, uint64_t& total_bytes)
93 using namespace boost::filesystem;
94 for (directory_iterator i = directory_iterator(dir); i != directory_iterator(); ++i) {
95 if (is_directory(*i)) {
96 count (*i, total_bytes);
98 total_bytes += file_size (*i);
105 write (boost::filesystem::path from, boost::filesystem::path to, uint64_t& total_remaining, uint64_t total)
108 int r = ext4_fopen(&out, to.generic_string().c_str(), "wb");
110 throw CopyError (String::compose("Failed to open file %1", to.generic_string()), r);
113 FILE* in = fopen_boost (from, "rb");
116 throw CopyError (String::compose("Failed to open file %1", from.string()), 0);
119 uint8_t* buffer = new uint8_t[block_size];
122 uint64_t remaining = file_size (from);
123 while (remaining > 0) {
124 uint64_t const this_time = min(remaining, block_size);
125 size_t read = fread (buffer, 1, this_time, in);
126 if (read != this_time) {
130 throw CopyError (String::compose("Short read; expected %1 but read %2", this_time, read), 0);
133 digester.add (buffer, this_time);
136 r = ext4_fwrite (&out, buffer, this_time, &written);
141 throw CopyError ("Write failed", r);
143 if (written != this_time) {
147 throw CopyError (String::compose("Short write; expected %1 but wrote %2", this_time, written), 0);
149 remaining -= this_time;
150 total_remaining -= this_time;
151 nanomsg->send(String::compose(DISK_WRITER_PROGRESS "\n%1\n", (1 - float(total_remaining) / total)), SHORT_TIMEOUT);
158 return digester.get ();
163 read (boost::filesystem::path from, boost::filesystem::path to, uint64_t& total_remaining, uint64_t total)
166 LOG_DISK("Opening %1 for read", to.generic_string());
167 int r = ext4_fopen(&in, to.generic_string().c_str(), "rb");
169 throw VerifyError (String::compose("Failed to open file %1", to.generic_string()), r);
171 LOG_DISK("Opened %1 for read", to.generic_string());
173 uint8_t* buffer = new uint8_t[block_size];
176 uint64_t remaining = file_size (from);
177 while (remaining > 0) {
178 uint64_t const this_time = min(remaining, block_size);
180 r = ext4_fread (&in, buffer, this_time, &read);
181 if (read != this_time) {
184 throw VerifyError (String::compose("Short read; expected %1 but read %2", this_time, read), 0);
187 digester.add (buffer, this_time);
188 remaining -= this_time;
189 total_remaining -= this_time;
190 nanomsg->send(String::compose(DISK_WRITER_PROGRESS "\n%1\n", (1 - float(total_remaining) / total)), SHORT_TIMEOUT);
196 return digester.get ();
200 /** @param from File to copy from.
201 * @param to Directory to copy to.
205 copy (boost::filesystem::path from, boost::filesystem::path to, uint64_t& total_remaining, uint64_t total)
207 LOG_DISK ("Copy %1 -> %2", from.string(), to.generic_string());
209 using namespace boost::filesystem;
211 path const cr = to / from.filename();
213 if (is_directory(from)) {
214 int r = ext4_dir_mk (cr.generic_string().c_str());
216 throw CopyError (String::compose("Failed to create directory %1", cr.generic_string()), r);
219 for (directory_iterator i = directory_iterator(from); i != directory_iterator(); ++i) {
220 copy (i->path(), cr, total_remaining, total);
223 string const write_digest = write (from, cr, total_remaining, total);
224 LOG_DISK ("Wrote %1 %2 with %3", from.string(), cr.generic_string(), write_digest);
225 string const read_digest = read (from, cr, total_remaining, total);
226 LOG_DISK ("Read %1 %2 with %3", from.string(), cr.generic_string(), write_digest);
227 if (write_digest != read_digest) {
228 throw VerifyError ("Hash of written data is incorrect", 0);
236 write (boost::filesystem::path dcp_path, string device)
239 // ext4_dmask_set (DEBUG_ALL);
241 /* We rely on static initialization for these */
242 static struct ext4_fs fs;
243 static struct ext4_mkfs_info info;
244 info.block_size = 1024;
245 info.inode_size = 128;
246 info.journal = false;
249 file_windows_name_set(device.c_str());
250 struct ext4_blockdev* bd = file_windows_dev_get();
252 file_dev_name_set (device.c_str());
253 struct ext4_blockdev* bd = file_dev_get ();
257 throw CopyError ("Failed to open drive", 0);
259 LOG_DISK_NC ("Opened drive");
261 struct ext4_mbr_parts parts;
262 parts.division[0] = 100;
263 parts.division[1] = 0;
264 parts.division[2] = 0;
265 parts.division[3] = 0;
267 #ifdef DCPOMATIC_LINUX
268 PrivilegeEscalator e;
271 /* XXX: not sure if disk_id matters */
272 int r = ext4_mbr_write (bd, &parts, 0);
275 throw CopyError ("Failed to write MBR", r);
277 LOG_DISK_NC ("Wrote MBR");
279 #ifdef DCPOMATIC_WINDOWS
280 struct ext4_mbr_bdevs bdevs;
281 r = ext4_mbr_scan (bd, &bdevs);
283 throw CopyError ("Failed to read MBR", r);
286 file_windows_partition_set (bdevs.partitions[0].part_offset, bdevs.partitions[0].part_size);
289 #ifdef DCPOMATIC_LINUX
290 /* Re-read the partition table */
291 int fd = open(device.c_str(), O_RDONLY);
292 ioctl(fd, BLKRRPART, NULL);
296 #ifdef DCPOMATIC_LINUX
297 string partition = device;
298 /* XXX: don't know if this logic is sensible */
299 if (partition.size() > 0 && isdigit(partition[partition.length() - 1])) {
304 file_dev_name_set (partition.c_str());
305 bd = file_dev_get ();
309 string partition = device + "s1";
310 file_dev_name_set (partition.c_str());
311 bd = file_dev_get ();
315 throw CopyError ("Failed to open partition", 0);
317 LOG_DISK_NC ("Opened partition");
319 nanomsg->send(DISK_WRITER_FORMATTING "\n", SHORT_TIMEOUT);
321 r = ext4_mkfs(&fs, bd, &info, F_SET_EXT4);
323 throw CopyError ("Failed to make filesystem", r);
325 LOG_DISK_NC ("Made filesystem");
327 r = ext4_device_register(bd, "ext4_fs");
329 throw CopyError ("Failed to register device", r);
331 LOG_DISK_NC ("Registered device");
333 r = ext4_mount("ext4_fs", "/mp/", false);
335 throw CopyError ("Failed to mount device", r);
337 LOG_DISK_NC ("Mounted device");
339 uint64_t total_bytes = 0;
340 count (dcp_path, total_bytes);
342 /* XXX: this is a hack. We are going to "treat" every byte twice; write it, and then verify it. Double the
343 * bytes totals so that progress works itself out (assuming write is the same speed as read).
346 copy (dcp_path, "/mp", total_bytes, total_bytes);
348 r = ext4_umount("/mp/");
350 throw CopyError ("Failed to unmount device", r);
353 ext4_device_unregister("ext4_fs");
354 if (!nanomsg->send(DISK_WRITER_OK "\n", LONG_TIMEOUT)) {
355 throw CommunicationFailedError ();
357 } catch (CopyError& e) {
358 LOG_DISK("CopyError (from write): %1 %2", e.message(), e.number().get_value_or(0));
359 nanomsg->send(String::compose(DISK_WRITER_ERROR "\n%1\n%2\n", e.message(), e.number().get_value_or(0)), LONG_TIMEOUT);
360 } catch (VerifyError& e) {
361 LOG_DISK("VerifyError (from write): %1 %2", e.message(), e.number());
362 nanomsg->send(String::compose(DISK_WRITER_ERROR "\n%1\n%2\n", e.message(), e.number()), LONG_TIMEOUT);
363 } catch (exception& e) {
364 LOG_DISK("Exception (from write): %1", e.what());
365 nanomsg->send(String::compose(DISK_WRITER_ERROR "\n%1\n0\n", e.what()), LONG_TIMEOUT);
370 boost::filesystem::path dcp_path;
374 #ifdef DCPOMATIC_LINUX
377 polkit_callback (GObject *, GAsyncResult* res, gpointer data)
379 Parameters* parameters = reinterpret_cast<Parameters*> (data);
380 PolkitAuthorizationResult* result = polkit_authority_check_authorization_finish (polkit_authority, res, 0);
381 if (result && polkit_authorization_result_get_is_authorized(result)) {
382 write (parameters->dcp_path, parameters->device);
386 g_object_unref (result);
395 using namespace boost::algorithm;
397 optional<string> s = nanomsg->receive (0);
402 if (*s == DISK_WRITER_QUIT) {
404 } else if (*s == DISK_WRITER_UNMOUNT) {
405 /* XXX: should do Linux polkit stuff here */
406 optional<string> device = nanomsg->receive (LONG_TIMEOUT);
408 throw CommunicationFailedError ();
410 if (unmount_drive(*device)) {
411 if (!nanomsg->send (DISK_WRITER_OK "\n", LONG_TIMEOUT)) {
412 throw CommunicationFailedError();
415 if (!nanomsg->send (DISK_WRITER_ERROR "\n", LONG_TIMEOUT)) {
416 throw CommunicationFailedError();
420 optional<string> dcp_path = nanomsg->receive(LONG_TIMEOUT);
421 optional<string> device = nanomsg->receive(LONG_TIMEOUT);
422 if (!dcp_path || !device) {
423 throw CommunicationFailedError();
426 /* Do some basic sanity checks; this is a bit belt-and-braces but it can't hurt... */
429 if (!starts_with(*device, "/dev/disk")) {
430 LOG_DISK ("Will not write to %1", *device);
431 nanomsg->try_send(DISK_WRITER_ERROR "\nRefusing to write to this drive\n1\n", LONG_TIMEOUT);
435 #ifdef DCPOMATIC_LINUX
436 if (!starts_with(*device, "/dev/sd") && !starts_with(*device, "/dev/hd")) {
437 LOG_DISK ("Will not write to %1", *device);
438 nanomsg->send(DISK_WRITER_ERROR "\nRefusing to write to this drive\n1\n", LONG_TIMEOUT);
442 #ifdef DCPOMATIC_WINDOWS
443 if (!starts_with(*device, "\\\\.\\PHYSICALDRIVE")) {
444 LOG_DISK ("Will not write to %1", *device);
445 nanomsg->try_send(DISK_WRITER_ERROR "\nRefusing to write to this drive\n1\n", LONG_TIMEOUT);
450 bool on_drive_list = false;
451 bool mounted = false;
452 for (auto const& i: get_drives()) {
453 if (i.internal_name() == *device) {
454 on_drive_list = true;
455 mounted = i.mounted();
459 if (!on_drive_list) {
460 LOG_DISK ("Will not write to %1 as it's not recognised as a drive", *device);
461 nanomsg->send(DISK_WRITER_ERROR "\nRefusing to write to this drive\n1\n", LONG_TIMEOUT);
465 LOG_DISK ("Will not write to %1 as it's mounted", *device);
466 nanomsg->send(DISK_WRITER_ERROR "\nRefusing to write to this drive\n1\n", LONG_TIMEOUT);
470 LOG_DISK ("Here we go writing %1 to %2", *dcp_path, *device);
472 #ifdef DCPOMATIC_LINUX
473 polkit_authority = polkit_authority_get_sync (0, 0);
474 PolkitSubject* subject = polkit_unix_process_new (getppid());
475 Parameters* parameters = new Parameters;
476 parameters->dcp_path = *dcp_path;
477 parameters->device = *device;
478 polkit_authority_check_authorization (
479 polkit_authority, subject, "com.dcpomatic.write-drive", 0, POLKIT_CHECK_AUTHORIZATION_FLAGS_ALLOW_USER_INTERACTION, 0, polkit_callback, parameters
482 write (*dcp_path, *device);
487 } catch (exception& e) {
488 LOG_DISK("Exception (from idle): %1", e.what());
495 /* XXX: this is a hack, but I expect we'll need logs and I'm not sure if there's
496 * a better place to put them.
498 dcpomatic_log.reset(new FileLog(config_path() / "disk_writer.log", LogEntry::TYPE_DISK));
499 LOG_DISK_NC("dcpomatic_disk_writer started");
502 nanomsg = new Nanomsg (false);
503 } catch (runtime_error& e) {
504 LOG_DISK_NC("Could not set up nanomsg socket");
508 Glib::RefPtr<Glib::MainLoop> ml = Glib::MainLoop::create ();
509 Glib::signal_timeout().connect(sigc::ptr_fun(&idle), 500);