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/>.
22 #include "compose.hpp"
24 #include "dcpomatic_log.h"
26 #include "disk_writer_messages.h"
27 #include "exceptions.h"
31 #ifdef DCPOMATIC_LINUX
33 #include <sys/ioctl.h>
35 #include <lwext4/file_dev.h>
41 #include <lwext4/file_dev.h>
45 #ifdef DCPOMATIC_WINDOWS
47 #include <lwext4/file_windows.h>
52 #include <lwext4/ext4.h>
53 #include <lwext4/ext4_debug.h>
54 #include <lwext4/ext4_errno.h>
55 #include <lwext4/ext4_fs.h>
56 #include <lwext4/ext4_mbr.h>
57 #include <lwext4/ext4_mkfs.h>
59 #include <boost/filesystem.hpp>
60 #include <boost/foreach.hpp>
70 #define SHORT_TIMEOUT 100
71 #define LONG_TIMEOUT 2000
74 /* Use quite a big block size here, as ext4's fwrite() has quite a bit of overhead */
75 static uint64_t const block_size = 4096 * 4096;
80 count (boost::filesystem::path dir, uint64_t& total_bytes)
82 using namespace boost::filesystem;
83 for (directory_iterator i = directory_iterator(dir); i != directory_iterator(); ++i) {
84 if (is_directory(*i)) {
85 count (*i, total_bytes);
87 total_bytes += file_size (*i);
94 write (boost::filesystem::path from, boost::filesystem::path to, uint64_t& total_remaining, uint64_t total, Nanomsg* nanomsg)
97 int r = ext4_fopen(&out, to.generic_string().c_str(), "wb");
99 throw CopyError (String::compose("Failed to open file %1", to.generic_string()), r);
102 FILE* in = fopen_boost (from, "rb");
105 throw CopyError (String::compose("Failed to open file %1", from.string()), 0);
108 uint8_t* buffer = new uint8_t[block_size];
111 int progress_frequency = 1;
112 int progress_count = 0;
113 uint64_t remaining = file_size (from);
114 while (remaining > 0) {
115 uint64_t const this_time = min(remaining, block_size);
116 size_t read = fread (buffer, 1, this_time, in);
117 if (read != this_time) {
121 throw CopyError (String::compose("Short read; expected %1 but read %2", this_time, read), 0);
124 digester.add (buffer, this_time);
127 r = ext4_fwrite (&out, buffer, this_time, &written);
132 throw CopyError ("Write failed", r);
134 if (written != this_time) {
138 throw CopyError (String::compose("Short write; expected %1 but wrote %2", this_time, written), 0);
140 remaining -= this_time;
141 total_remaining -= this_time;
144 if ((progress_count % progress_frequency) == 0 && nanomsg) {
145 nanomsg->send(String::compose(DISK_WRITER_COPY_PROGRESS "\n%1\n", (1 - float(total_remaining) / total)), SHORT_TIMEOUT);
153 return digester.get ();
159 read (boost::filesystem::path from, boost::filesystem::path to, uint64_t& total_remaining, uint64_t total, Nanomsg* nanomsg)
162 LOG_DISK("Opening %1 for read", to.generic_string());
163 int r = ext4_fopen(&in, to.generic_string().c_str(), "rb");
165 throw VerifyError (String::compose("Failed to open file %1", to.generic_string()), r);
167 LOG_DISK("Opened %1 for read", to.generic_string());
169 uint8_t* buffer = new uint8_t[block_size];
172 uint64_t remaining = file_size (from);
173 while (remaining > 0) {
174 uint64_t const this_time = min(remaining, block_size);
176 r = ext4_fread (&in, buffer, this_time, &read);
177 if (read != this_time) {
180 throw VerifyError (String::compose("Short read; expected %1 but read %2", this_time, read), 0);
183 digester.add (buffer, this_time);
184 remaining -= this_time;
185 total_remaining -= this_time;
187 nanomsg->send(String::compose(DISK_WRITER_VERIFY_PROGRESS "\n%1\n", (1 - float(total_remaining) / total)), SHORT_TIMEOUT);
194 return digester.get ();
201 CopiedFile (boost::filesystem::path from_, boost::filesystem::path to_, string write_digest_)
204 , write_digest (write_digest_)
207 boost::filesystem::path from;
208 boost::filesystem::path to;
209 /** digest calculated from data as it was read from the source during write */
214 /** @param from File to copy from.
215 * @param to Directory to copy to.
219 copy (boost::filesystem::path from, boost::filesystem::path to, uint64_t& total_remaining, uint64_t total, vector<CopiedFile>& copied_files, Nanomsg* nanomsg)
221 LOG_DISK ("Copy %1 -> %2", from.string(), to.generic_string());
223 using namespace boost::filesystem;
225 path const cr = to / from.filename();
227 if (is_directory(from)) {
228 int r = ext4_dir_mk (cr.generic_string().c_str());
230 throw CopyError (String::compose("Failed to create directory %1", cr.generic_string()), r);
233 for (directory_iterator i = directory_iterator(from); i != directory_iterator(); ++i) {
234 copy (i->path(), cr, total_remaining, total, copied_files, nanomsg);
237 string const write_digest = write (from, cr, total_remaining, total, nanomsg);
238 LOG_DISK ("Wrote %1 %2 with %3", from.string(), cr.generic_string(), write_digest);
239 copied_files.push_back (CopiedFile(from, cr, write_digest));
246 verify (vector<CopiedFile> const& copied_files, uint64_t total, Nanomsg* nanomsg)
248 uint64_t total_remaining = total;
249 BOOST_FOREACH (CopiedFile const& i, copied_files) {
250 string const read_digest = read (i.from, i.to, total_remaining, total, nanomsg);
251 LOG_DISK ("Read %1 %2 was %3 on write, now %4", i.from.string(), i.to.generic_string(), i.write_digest, read_digest);
252 if (read_digest != i.write_digest) {
253 throw VerifyError ("Hash of written data is incorrect", 0);
260 #ifdef DCPOMATIC_WINDOWS
261 dcpomatic::write (boost::filesystem::path dcp_path, string device, string, Nanomsg* nanomsg)
263 dcpomatic::write (boost::filesystem::path dcp_path, string device, string posix_partition, Nanomsg* nanomsg)
267 ext4_dmask_set (DEBUG_ALL);
269 /* We rely on static initialization for these */
270 static struct ext4_fs fs;
271 static struct ext4_mkfs_info info;
272 info.block_size = 4096;
273 info.inode_size = 128;
274 info.journal = false;
277 file_windows_name_set(device.c_str());
278 struct ext4_blockdev* bd = file_windows_dev_get();
280 file_dev_name_set (device.c_str());
281 struct ext4_blockdev* bd = file_dev_get ();
285 throw CopyError ("Failed to open drive", 0);
287 LOG_DISK_NC ("Opened drive");
289 struct ext4_mbr_parts parts;
290 parts.division[0] = 100;
291 parts.division[1] = 0;
292 parts.division[2] = 0;
293 parts.division[3] = 0;
295 #ifdef DCPOMATIC_LINUX
296 PrivilegeEscalator e;
299 /* XXX: not sure if disk_id matters */
300 int r = ext4_mbr_write (bd, &parts, 0);
302 throw CopyError ("Failed to write MBR", r);
304 LOG_DISK_NC ("Wrote MBR");
306 struct ext4_mbr_bdevs bdevs;
307 r = ext4_mbr_scan (bd, &bdevs);
309 throw CopyError ("Failed to read MBR", r);
312 #ifdef DCPOMATIC_LINUX
313 /* Re-read the partition table */
314 int fd = open(device.c_str(), O_RDONLY);
315 ioctl(fd, BLKRRPART, NULL);
319 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);
321 #ifdef DCPOMATIC_WINDOWS
322 file_windows_partition_set (bdevs.partitions[0].part_offset, bdevs.partitions[0].part_size);
324 file_dev_name_set (posix_partition.c_str());
325 bd = file_dev_get ();
329 throw CopyError ("Failed to open partition", 0);
331 LOG_DISK_NC ("Opened partition");
334 nanomsg->send(DISK_WRITER_FORMATTING "\n", SHORT_TIMEOUT);
337 r = ext4_mkfs(&fs, bd, &info, F_SET_EXT2);
339 throw CopyError ("Failed to make filesystem", r);
341 LOG_DISK_NC ("Made filesystem");
343 r = ext4_device_register(bd, "ext4_fs");
345 throw CopyError ("Failed to register device", r);
347 LOG_DISK_NC ("Registered device");
349 r = ext4_mount("ext4_fs", "/mp/", false);
351 throw CopyError ("Failed to mount device", r);
353 LOG_DISK_NC ("Mounted device");
355 uint64_t total_bytes = 0;
356 count (dcp_path, total_bytes);
358 uint64_t total_remaining = total_bytes;
359 vector<CopiedFile> copied_files;
360 copy (dcp_path, "/mp", total_remaining, total_bytes, copied_files, nanomsg);
362 /* Unmount and re-mount to make sure the write has finished */
363 r = ext4_umount("/mp/");
365 throw CopyError ("Failed to unmount device", r);
367 r = ext4_mount("ext4_fs", "/mp/", false);
369 throw CopyError ("Failed to mount device", r);
371 LOG_DISK_NC ("Re-mounted device");
373 verify (copied_files, total_bytes, nanomsg);
375 r = ext4_umount("/mp/");
377 throw CopyError ("Failed to unmount device", r);
380 ext4_device_unregister("ext4_fs");
381 if (nanomsg && !nanomsg->send(DISK_WRITER_OK "\n", LONG_TIMEOUT)) {
382 throw CommunicationFailedError ();
385 disk_write_finished ();
386 } catch (CopyError& e) {
387 LOG_DISK("CopyError (from write): %1 %2", e.message(), e.number().get_value_or(0));
389 nanomsg->send(String::compose(DISK_WRITER_ERROR "\n%1\n%2\n", e.message(), e.number().get_value_or(0)), LONG_TIMEOUT);
391 } catch (VerifyError& e) {
392 LOG_DISK("VerifyError (from write): %1 %2", e.message(), e.number());
394 nanomsg->send(String::compose(DISK_WRITER_ERROR "\n%1\n%2\n", e.message(), e.number()), LONG_TIMEOUT);
396 } catch (exception& e) {
397 LOG_DISK("Exception (from write): %1", e.what());
399 nanomsg->send(String::compose(DISK_WRITER_ERROR "\n%1\n0\n", e.what()), LONG_TIMEOUT);