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/version.h"
22 #include "lib/disk_writer_messages.h"
23 #include "lib/compose.hpp"
24 #include "lib/exceptions.h"
25 #include "lib/cross.h"
26 #include "lib/digester.h"
27 #include "lib/file_log.h"
28 #include "lib/dcpomatic_log.h"
29 #include "lib/nanomsg.h"
31 #include <lwext4/ext4_mbr.h>
32 #include <lwext4/ext4_fs.h>
33 #include <lwext4/ext4_mkfs.h>
34 #include <lwext4/ext4_errno.h>
35 #include <lwext4/ext4_debug.h>
36 #include <lwext4/ext4.h>
39 #ifdef DCPOMATIC_POSIX
40 #include <sys/ioctl.h>
41 #include <sys/types.h>
46 #include "lib/stdout_log.h"
49 #include <lwext4/file_dev.h>
54 #ifdef DCPOMATIC_LINUX
56 #include <polkit/polkit.h>
58 #include <lwext4/file_dev.h>
63 #ifdef DCPOMATIC_WINDOWS
65 #include <lwext4/file_windows.h>
71 #include <sys/types.h>
72 #include <boost/filesystem.hpp>
73 #include <boost/algorithm/string.hpp>
74 #include <boost/foreach.hpp>
80 using std::runtime_error;
83 using boost::optional;
85 #ifdef DCPOMATIC_LINUX
86 static PolkitAuthority* polkit_authority = 0;
88 static uint64_t const block_size = 4096;
89 static Nanomsg* nanomsg = 0;
91 #define SHORT_TIMEOUT 100
92 #define LONG_TIMEOUT 2000
96 count (boost::filesystem::path dir, uint64_t& total_bytes)
98 using namespace boost::filesystem;
99 for (directory_iterator i = directory_iterator(dir); i != directory_iterator(); ++i) {
100 if (is_directory(*i)) {
101 count (*i, total_bytes);
103 total_bytes += file_size (*i);
110 write (boost::filesystem::path from, boost::filesystem::path to, uint64_t& total_remaining, uint64_t total)
113 int r = ext4_fopen(&out, to.generic_string().c_str(), "wb");
115 throw CopyError (String::compose("Failed to open file %1", to.generic_string()), r);
118 FILE* in = fopen_boost (from, "rb");
121 throw CopyError (String::compose("Failed to open file %1", from.string()), 0);
124 uint8_t* buffer = new uint8_t[block_size];
127 int progress_frequency = 5000;
128 int progress_count = 0;
129 uint64_t remaining = file_size (from);
130 while (remaining > 0) {
131 uint64_t const this_time = min(remaining, block_size);
132 size_t read = fread (buffer, 1, this_time, in);
133 if (read != this_time) {
137 throw CopyError (String::compose("Short read; expected %1 but read %2", this_time, read), 0);
140 digester.add (buffer, this_time);
143 r = ext4_fwrite (&out, buffer, this_time, &written);
148 throw CopyError ("Write failed", r);
150 if (written != this_time) {
154 throw CopyError (String::compose("Short write; expected %1 but wrote %2", this_time, written), 0);
156 remaining -= this_time;
157 total_remaining -= this_time;
160 if ((progress_count % progress_frequency) == 0) {
161 nanomsg->send(String::compose(DISK_WRITER_COPY_PROGRESS "\n%1\n", (1 - float(total_remaining) / total)), SHORT_TIMEOUT);
169 return digester.get ();
174 read (boost::filesystem::path from, boost::filesystem::path to, uint64_t& total_remaining, uint64_t total)
177 LOG_DISK("Opening %1 for read", to.generic_string());
178 int r = ext4_fopen(&in, to.generic_string().c_str(), "rb");
180 throw VerifyError (String::compose("Failed to open file %1", to.generic_string()), r);
182 LOG_DISK("Opened %1 for read", to.generic_string());
184 uint8_t* buffer = new uint8_t[block_size];
187 uint64_t remaining = file_size (from);
188 while (remaining > 0) {
189 uint64_t const this_time = min(remaining, block_size);
191 r = ext4_fread (&in, buffer, this_time, &read);
192 if (read != this_time) {
195 throw VerifyError (String::compose("Short read; expected %1 but read %2", this_time, read), 0);
198 digester.add (buffer, this_time);
199 remaining -= this_time;
200 total_remaining -= this_time;
201 nanomsg->send(String::compose(DISK_WRITER_VERIFY_PROGRESS "\n%1\n", (1 - float(total_remaining) / total)), SHORT_TIMEOUT);
207 return digester.get ();
214 CopiedFile (boost::filesystem::path from_, boost::filesystem::path to_, string write_digest_)
217 , write_digest (write_digest_)
220 boost::filesystem::path from;
221 boost::filesystem::path to;
222 /** digest calculated from data as it was read from the source during write */
227 /** @param from File to copy from.
228 * @param to Directory to copy to.
232 copy (boost::filesystem::path from, boost::filesystem::path to, uint64_t& total_remaining, uint64_t total, vector<CopiedFile>& copied_files)
234 LOG_DISK ("Copy %1 -> %2", from.string(), to.generic_string());
236 using namespace boost::filesystem;
238 path const cr = to / from.filename();
240 if (is_directory(from)) {
241 int r = ext4_dir_mk (cr.generic_string().c_str());
243 throw CopyError (String::compose("Failed to create directory %1", cr.generic_string()), r);
246 for (directory_iterator i = directory_iterator(from); i != directory_iterator(); ++i) {
247 copy (i->path(), cr, total_remaining, total, copied_files);
250 string const write_digest = write (from, cr, total_remaining, total);
251 LOG_DISK ("Wrote %1 %2 with %3", from.string(), cr.generic_string(), write_digest);
252 copied_files.push_back (CopiedFile(from, cr, write_digest));
259 verify (vector<CopiedFile> const& copied_files, uint64_t total)
261 uint64_t total_remaining = total;
262 BOOST_FOREACH (CopiedFile const& i, copied_files) {
263 string const read_digest = read (i.from, i.to, total_remaining, total);
264 LOG_DISK ("Read %1 %2 was %3 on write, now %4", i.from.string(), i.to.generic_string(), i.write_digest, read_digest);
265 if (read_digest != i.write_digest) {
266 throw VerifyError ("Hash of written data is incorrect", 0);
274 write (boost::filesystem::path dcp_path, string device)
277 ext4_dmask_set (DEBUG_ALL);
279 /* We rely on static initialization for these */
280 static struct ext4_fs fs;
281 static struct ext4_mkfs_info info;
282 info.block_size = 4096;
283 info.inode_size = 128;
284 info.journal = false;
287 file_windows_name_set(device.c_str());
288 struct ext4_blockdev* bd = file_windows_dev_get();
290 file_dev_name_set (device.c_str());
291 struct ext4_blockdev* bd = file_dev_get ();
295 throw CopyError ("Failed to open drive", 0);
297 LOG_DISK_NC ("Opened drive");
299 struct ext4_mbr_parts parts;
300 parts.division[0] = 100;
301 parts.division[1] = 0;
302 parts.division[2] = 0;
303 parts.division[3] = 0;
305 #ifdef DCPOMATIC_LINUX
306 PrivilegeEscalator e;
309 /* XXX: not sure if disk_id matters */
310 int r = ext4_mbr_write (bd, &parts, 0);
312 throw CopyError ("Failed to write MBR", r);
314 LOG_DISK_NC ("Wrote MBR");
316 struct ext4_mbr_bdevs bdevs;
317 r = ext4_mbr_scan (bd, &bdevs);
319 throw CopyError ("Failed to read MBR", r);
322 #ifdef DCPOMATIC_WINDOWS
323 file_windows_partition_set (bdevs.partitions[0].part_offset, bdevs.partitions[0].part_size);
326 LOG_DISK ("Writing to partition at %1 size %2; bd part size is %3", bdevs.partitions[0].part_offset, bdevs.partitions[0].part_size, bd->part_size);
328 #ifdef DCPOMATIC_LINUX
329 /* Re-read the partition table */
330 int fd = open(device.c_str(), O_RDONLY);
331 ioctl(fd, BLKRRPART, NULL);
335 #ifdef DCPOMATIC_LINUX
336 string partition = device;
337 /* XXX: don't know if this logic is sensible */
338 if (partition.size() > 0 && isdigit(partition[partition.length() - 1])) {
343 file_dev_name_set (partition.c_str());
344 bd = file_dev_get ();
348 string partition = device + "s1";
349 file_dev_name_set (partition.c_str());
350 bd = file_dev_get ();
354 throw CopyError ("Failed to open partition", 0);
356 LOG_DISK_NC ("Opened partition");
358 nanomsg->send(DISK_WRITER_FORMATTING "\n", SHORT_TIMEOUT);
360 r = ext4_mkfs(&fs, bd, &info, F_SET_EXT2);
362 throw CopyError ("Failed to make filesystem", r);
364 LOG_DISK_NC ("Made filesystem");
366 r = ext4_device_register(bd, "ext4_fs");
368 throw CopyError ("Failed to register device", r);
370 LOG_DISK_NC ("Registered device");
372 r = ext4_mount("ext4_fs", "/mp/", false);
374 throw CopyError ("Failed to mount device", r);
376 LOG_DISK_NC ("Mounted device");
378 uint64_t total_bytes = 0;
379 count (dcp_path, total_bytes);
381 uint64_t total_remaining = total_bytes;
382 vector<CopiedFile> copied_files;
383 copy (dcp_path, "/mp", total_remaining, total_bytes, copied_files);
385 /* Unmount and re-mount to make sure the write has finished */
386 r = ext4_umount("/mp/");
388 throw CopyError ("Failed to unmount device", r);
390 r = ext4_mount("ext4_fs", "/mp/", false);
392 throw CopyError ("Failed to mount device", r);
394 LOG_DISK_NC ("Re-mounted device");
396 verify (copied_files, total_bytes);
398 r = ext4_umount("/mp/");
400 throw CopyError ("Failed to unmount device", r);
403 ext4_device_unregister("ext4_fs");
404 if (!nanomsg->send(DISK_WRITER_OK "\n", LONG_TIMEOUT)) {
405 throw CommunicationFailedError ();
408 disk_write_finished ();
409 } catch (CopyError& e) {
410 LOG_DISK("CopyError (from write): %1 %2", e.message(), e.number().get_value_or(0));
411 nanomsg->send(String::compose(DISK_WRITER_ERROR "\n%1\n%2\n", e.message(), e.number().get_value_or(0)), LONG_TIMEOUT);
412 } catch (VerifyError& e) {
413 LOG_DISK("VerifyError (from write): %1 %2", e.message(), e.number());
414 nanomsg->send(String::compose(DISK_WRITER_ERROR "\n%1\n%2\n", e.message(), e.number()), LONG_TIMEOUT);
415 } catch (exception& e) {
416 LOG_DISK("Exception (from write): %1", e.what());
417 nanomsg->send(String::compose(DISK_WRITER_ERROR "\n%1\n0\n", e.what()), LONG_TIMEOUT);
422 boost::filesystem::path dcp_path;
426 #ifdef DCPOMATIC_LINUX
429 polkit_callback (GObject *, GAsyncResult* res, gpointer data)
431 Parameters* parameters = reinterpret_cast<Parameters*> (data);
432 PolkitAuthorizationResult* result = polkit_authority_check_authorization_finish (polkit_authority, res, 0);
433 if (result && polkit_authorization_result_get_is_authorized(result)) {
434 write (parameters->dcp_path, parameters->device);
438 g_object_unref (result);
448 using namespace boost::algorithm;
450 optional<string> s = nanomsg->receive (0);
455 LOG_DISK("Writer receives command: %1", *s);
457 if (*s == DISK_WRITER_QUIT) {
459 } else if (*s == DISK_WRITER_UNMOUNT) {
460 /* XXX: should do Linux polkit stuff here */
461 optional<string> xml_head = nanomsg->receive (LONG_TIMEOUT);
462 optional<string> xml_body = nanomsg->receive (LONG_TIMEOUT);
463 if (!xml_head || !xml_body) {
464 LOG_DISK_NC("Failed to receive unmount request");
465 throw CommunicationFailedError ();
467 bool const success = Drive(*xml_head + *xml_body).unmount();
468 if (!nanomsg->send (success ? (DISK_WRITER_OK "\n") : (DISK_WRITER_ERROR "\n"), LONG_TIMEOUT)) {
469 LOG_DISK_NC("CommunicationFailedError in unmount_finished");
470 throw CommunicationFailedError ();
472 } else if (*s == DISK_WRITER_WRITE) {
473 optional<string> dcp_path = nanomsg->receive (LONG_TIMEOUT);
474 optional<string> device = nanomsg->receive (LONG_TIMEOUT);
475 if (!dcp_path || !device) {
476 LOG_DISK_NC("Failed to receive write request");
477 throw CommunicationFailedError();
480 /* Do some basic sanity checks; this is a bit belt-and-braces but it can't hurt... */
483 if (!starts_with(*device, "/dev/disk")) {
484 LOG_DISK ("Will not write to %1", *device);
485 nanomsg->send(DISK_WRITER_ERROR "\nRefusing to write to this drive\n1\n", LONG_TIMEOUT);
489 #ifdef DCPOMATIC_LINUX
490 if (!starts_with(*device, "/dev/sd") && !starts_with(*device, "/dev/hd")) {
491 LOG_DISK ("Will not write to %1", *device);
492 nanomsg->send(DISK_WRITER_ERROR "\nRefusing to write to this drive\n1\n", LONG_TIMEOUT);
496 #ifdef DCPOMATIC_WINDOWS
497 if (!starts_with(*device, "\\\\.\\PHYSICALDRIVE")) {
498 LOG_DISK ("Will not write to %1", *device);
499 nanomsg->send(DISK_WRITER_ERROR "\nRefusing to write to this drive\n1\n", LONG_TIMEOUT);
504 bool on_drive_list = false;
505 bool mounted = false;
506 for (auto const& i: Drive::get()) {
507 if (i.device() == *device) {
508 on_drive_list = true;
509 mounted = i.mounted();
513 if (!on_drive_list) {
514 LOG_DISK ("Will not write to %1 as it's not recognised as a drive", *device);
515 nanomsg->send(DISK_WRITER_ERROR "\nRefusing to write to this drive\n1\n", LONG_TIMEOUT);
519 LOG_DISK ("Will not write to %1 as it's mounted", *device);
520 nanomsg->send(DISK_WRITER_ERROR "\nRefusing to write to this drive\n1\n", LONG_TIMEOUT);
524 LOG_DISK ("Here we go writing %1 to %2", *dcp_path, *device);
526 #ifdef DCPOMATIC_LINUX
527 polkit_authority = polkit_authority_get_sync (0, 0);
528 PolkitSubject* subject = polkit_unix_process_new (getppid());
529 Parameters* parameters = new Parameters;
530 parameters->dcp_path = *dcp_path;
531 parameters->device = *device;
532 polkit_authority_check_authorization (
533 polkit_authority, subject, "com.dcpomatic.write-drive", 0, POLKIT_CHECK_AUTHORIZATION_FLAGS_ALLOW_USER_INTERACTION, 0, polkit_callback, parameters
536 write (*dcp_path, *device);
541 } catch (exception& e) {
542 LOG_DISK("Exception (from idle): %1", e.what());
550 /* On macOS this is running as root, so config_path() will be somewhere in root's
551 * home. Instead, just write to stdout as the macOS process control stuff will
552 * redirect this to a file in /var/log
554 dcpomatic_log.reset(new StdoutLog(LogEntry::TYPE_DISK));
555 LOG_DISK("dcpomatic_disk_writer %1 started", dcpomatic_git_commit);
557 /* XXX: this is a hack, but I expect we'll need logs and I'm not sure if there's
558 * a better place to put them.
560 dcpomatic_log.reset(new FileLog(config_path() / "disk_writer.log", LogEntry::TYPE_DISK));
561 LOG_DISK_NC("dcpomatic_disk_writer started");
565 /* I *think* this confumes the notifyd event that we used to start the process, so we only
566 * get started once per notification.
568 xpc_set_event_stream_handler("com.apple.notifyd.matching", DISPATCH_TARGET_QUEUE_DEFAULT, ^(xpc_object_t event) {});
572 nanomsg = new Nanomsg (false);
573 } catch (runtime_error& e) {
574 LOG_DISK_NC("Could not set up nanomsg socket");
578 Glib::RefPtr<Glib::MainLoop> ml = Glib::MainLoop::create ();
579 Glib::signal_timeout().connect(sigc::ptr_fun(&idle), 500);