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 #include <dcp/filesystem.h>
33 #ifdef DCPOMATIC_LINUX
35 #include <sys/ioctl.h>
37 #include <lwext4/file_dev.h>
43 #include <lwext4/file_dev.h>
47 #ifdef DCPOMATIC_WINDOWS
49 #include <lwext4/file_windows.h>
54 #include <lwext4/ext4.h>
55 #include <lwext4/ext4_debug.h>
56 #include <lwext4/ext4_errno.h>
57 #include <lwext4/ext4_fs.h>
58 #include <lwext4/ext4_mbr.h>
59 #include <lwext4/ext4_mkfs.h>
61 #include <boost/filesystem.hpp>
72 #define SHORT_TIMEOUT 100
73 #define LONG_TIMEOUT 2000
76 /* Use quite a big block size here, as ext4's fwrite() has quite a bit of overhead */
77 uint64_t constexpr block_size = 4096 * 4096;
82 count (std::vector<boost::filesystem::path> dirs, uint64_t& total_bytes)
84 using namespace boost::filesystem;
86 for (auto dir: dirs) {
87 dir = dcp::filesystem::fix_long_path(dir);
88 for (auto path: directory_iterator(dir)) {
89 if (is_directory(path)) {
90 count({path}, total_bytes);
92 total_bytes += file_size(path);
101 set_timestamps_to_now (boost::filesystem::path path)
103 auto const now = std::chrono::duration_cast<std::chrono::seconds>(std::chrono::system_clock::now().time_since_epoch()).count();
104 ext4_mtime_set (path.generic_string().c_str(), now);
105 ext4_ctime_set (path.generic_string().c_str(), now);
106 ext4_atime_set (path.generic_string().c_str(), now);
112 write (boost::filesystem::path from, boost::filesystem::path to, uint64_t& total_remaining, uint64_t total, Nanomsg* nanomsg)
115 int r = ext4_fopen(&out, to.generic_string().c_str(), "wb");
117 throw CopyError(String::compose("Failed to open file %1", to.generic_string()), r, ext4_blockdev_errno);
120 dcp::File in(from, "rb");
123 throw CopyError(String::compose("Failed to open file %1", from.string()), 0);
126 std::vector<uint8_t> buffer(block_size);
129 int progress_frequency = 1;
130 int progress_count = 0;
131 uint64_t remaining = file_size (from);
132 while (remaining > 0) {
133 uint64_t const this_time = min(remaining, block_size);
134 size_t read = in.read(buffer.data(), 1, this_time);
135 if (read != this_time) {
137 throw CopyError(String::compose("Short read; expected %1 but read %2", this_time, read), 0, ext4_blockdev_errno);
140 digester.add (buffer.data(), this_time);
143 r = ext4_fwrite (&out, buffer.data(), this_time, &written);
146 throw CopyError("Write failed", r, ext4_blockdev_errno);
148 if (written != this_time) {
150 throw CopyError(String::compose("Short write; expected %1 but wrote %2", this_time, written), 0, ext4_blockdev_errno);
152 remaining -= this_time;
153 total_remaining -= this_time;
156 if ((progress_count % progress_frequency) == 0 && nanomsg) {
157 DiskWriterBackEndResponse::copy_progress(1 - float(total_remaining) / total).write_to_nanomsg(*nanomsg, SHORT_TIMEOUT);
163 set_timestamps_to_now (to);
165 return digester.get ();
171 read (boost::filesystem::path from, boost::filesystem::path to, uint64_t& total_remaining, uint64_t total, Nanomsg* nanomsg)
174 LOG_DISK("Opening %1 for read", to.generic_string());
175 int r = ext4_fopen(&in, to.generic_string().c_str(), "rb");
177 throw VerifyError (String::compose("Failed to open file %1", to.generic_string()), r);
179 LOG_DISK("Opened %1 for read", to.generic_string());
181 std::vector<uint8_t> buffer(block_size);
184 uint64_t remaining = file_size (from);
185 while (remaining > 0) {
186 uint64_t const this_time = min(remaining, block_size);
188 r = ext4_fread (&in, buffer.data(), this_time, &read);
189 if (read != this_time) {
191 throw VerifyError (String::compose("Short read; expected %1 but read %2", this_time, read), 0);
194 digester.add (buffer.data(), this_time);
195 remaining -= this_time;
196 total_remaining -= this_time;
198 DiskWriterBackEndResponse::verify_progress(1 - float(total_remaining) / total).write_to_nanomsg(*nanomsg, SHORT_TIMEOUT);
204 return digester.get ();
211 CopiedFile (boost::filesystem::path from_, boost::filesystem::path to_, string write_digest_)
214 , write_digest (write_digest_)
217 boost::filesystem::path from;
218 boost::filesystem::path to;
219 /** digest calculated from data as it was read from the source during write */
224 /** @param from File to copy from.
225 * @param to Directory to copy to.
229 copy (boost::filesystem::path from, boost::filesystem::path to, uint64_t& total_remaining, uint64_t total, vector<CopiedFile>& copied_files, Nanomsg* nanomsg)
231 LOG_DISK ("Copy %1 -> %2", from.string(), to.generic_string());
232 from = dcp::filesystem::fix_long_path(from);
234 using namespace boost::filesystem;
236 path const cr = to / from.filename();
238 if (is_directory(from)) {
239 int r = ext4_dir_mk (cr.generic_string().c_str());
241 throw CopyError(String::compose("Failed to create directory %1", cr.generic_string()), r, ext4_blockdev_errno);
243 set_timestamps_to_now (cr);
245 for (auto i: directory_iterator(from)) {
246 copy (i.path(), cr, total_remaining, total, copied_files, nanomsg);
249 string const write_digest = write (from, cr, total_remaining, total, nanomsg);
250 LOG_DISK ("Wrote %1 %2 with %3", from.string(), cr.generic_string(), write_digest);
251 copied_files.push_back (CopiedFile(from, cr, write_digest));
258 verify (vector<CopiedFile> const& copied_files, uint64_t total, Nanomsg* nanomsg)
260 uint64_t total_remaining = total;
261 for (auto const& i: copied_files) {
262 string const read_digest = read (i.from, i.to, total_remaining, total, nanomsg);
263 LOG_DISK ("Read %1 %2 was %3 on write, now %4", i.from.string(), i.to.generic_string(), i.write_digest, read_digest);
264 if (read_digest != i.write_digest) {
265 throw VerifyError ("Hash of written data is incorrect", 0);
273 format_progress (void* context, float progress)
276 DiskWriterBackEndResponse::format_progress(progress).write_to_nanomsg(*reinterpret_cast<Nanomsg*>(context), SHORT_TIMEOUT);
282 #ifdef DCPOMATIC_WINDOWS
283 dcpomatic::write (vector<boost::filesystem::path> dcp_paths, string device, string, Nanomsg* nanomsg)
285 dcpomatic::write (vector<boost::filesystem::path> dcp_paths, string device, string posix_partition, Nanomsg* nanomsg)
289 ext4_dmask_set (DEBUG_ALL);
292 fs.read_only = false;
294 fs.last_inode_bg_id = 0;
296 fs.jbd_journal = nullptr;
297 fs.curr_trans = nullptr;
298 struct ext4_mkfs_info info;
300 info.block_size = 4096;
301 info.blocks_per_group = 0;
302 info.inode_size = 128;
304 info.journal_blocks = 0;
306 for (int i = 0; i < UUID_SIZE; ++i) {
307 info.uuid[i] = rand() & 0xff;
309 info.journal = false;
310 info.label = nullptr;
313 file_windows_name_set(device.c_str());
314 struct ext4_blockdev* bd = file_windows_dev_get();
316 file_dev_name_set (device.c_str());
317 struct ext4_blockdev* bd = file_dev_get ();
321 throw CopyError("Failed to open drive", 0, ext4_blockdev_errno);
323 LOG_DISK_NC ("Opened drive");
325 struct ext4_mbr_parts parts;
326 parts.division[0] = 100;
327 parts.division[1] = 0;
328 parts.division[2] = 0;
329 parts.division[3] = 0;
331 /* XXX: not sure if disk_id matters */
332 int r = ext4_mbr_write (bd, &parts, 0);
334 throw CopyError("Failed to write MBR", r, ext4_blockdev_errno);
336 LOG_DISK_NC ("Wrote MBR");
338 struct ext4_mbr_bdevs bdevs;
339 r = ext4_mbr_scan (bd, &bdevs);
341 throw CopyError("Failed to read MBR", r, ext4_blockdev_errno);
344 #ifdef DCPOMATIC_LINUX
345 /* Re-read the partition table */
346 int fd = open(device.c_str(), O_RDONLY);
347 ioctl(fd, BLKRRPART, NULL);
351 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);
353 #ifdef DCPOMATIC_WINDOWS
354 file_windows_partition_set (bdevs.partitions[0].part_offset, bdevs.partitions[0].part_size);
356 file_dev_name_set (posix_partition.c_str());
358 /* On macOS (at least) if you try to write to a drive that is sleeping the ext4_mkfs call
359 * below is liable to return EIO because it can't open the device. Try to work around that
360 * here by opening and closing the device, waiting 5 seconds if it fails.
362 int wake = open(posix_partition.c_str(), O_RDWR);
364 dcpomatic_sleep_seconds (5);
369 bd = file_dev_get ();
373 throw CopyError("Failed to open partition", 0, ext4_blockdev_errno);
375 LOG_DISK_NC ("Opened partition");
377 r = ext4_mkfs(&fs, bd, &info, F_SET_EXT2, format_progress, nanomsg);
379 throw CopyError("Failed to make filesystem", r, ext4_blockdev_errno);
381 LOG_DISK_NC ("Made filesystem");
383 r = ext4_device_register(bd, "ext4_fs");
385 throw CopyError("Failed to register device", r, ext4_blockdev_errno);
387 LOG_DISK_NC ("Registered device");
389 r = ext4_mount("ext4_fs", "/mp/", false);
391 throw CopyError("Failed to mount device", r, ext4_blockdev_errno);
393 LOG_DISK_NC ("Mounted device");
395 uint64_t total_bytes = 0;
396 count (dcp_paths, total_bytes);
398 uint64_t total_remaining = total_bytes;
399 vector<CopiedFile> copied_files;
400 for (auto dcp_path: dcp_paths) {
401 copy (dcp_path, "/mp", total_remaining, total_bytes, copied_files, nanomsg);
404 /* Unmount and re-mount to make sure the write has finished */
405 r = ext4_umount("/mp/");
407 throw CopyError("Failed to unmount device", r, ext4_blockdev_errno);
409 r = ext4_mount("ext4_fs", "/mp/", false);
411 throw CopyError("Failed to mount device", r, ext4_blockdev_errno);
413 LOG_DISK_NC ("Re-mounted device");
415 verify (copied_files, total_bytes, nanomsg);
417 r = ext4_umount("/mp/");
419 throw CopyError("Failed to unmount device", r, ext4_blockdev_errno);
422 ext4_device_unregister("ext4_fs");
423 if (nanomsg && !DiskWriterBackEndResponse::ok().write_to_nanomsg(*nanomsg, LONG_TIMEOUT)) {
424 throw CommunicationFailedError ();
427 disk_write_finished ();
428 } catch (CopyError& e) {
429 LOG_DISK("CopyError (from write): %1 %2 %3", e.message(), e.ext4_number().get_value_or(0), e.platform_number().get_value_or(0));
431 DiskWriterBackEndResponse::error(e.message(), e.ext4_number().get_value_or(0), e.platform_number().get_value_or(0)).write_to_nanomsg(*nanomsg, LONG_TIMEOUT);
433 } catch (VerifyError& e) {
434 LOG_DISK("VerifyError (from write): %1 %2", e.message(), e.number());
436 DiskWriterBackEndResponse::error(e.message(), e.number(), 0).write_to_nanomsg(*nanomsg, LONG_TIMEOUT);
438 } catch (exception& e) {
439 LOG_DISK("Exception (from write): %1", e.what());
441 DiskWriterBackEndResponse::error(e.what(), 0, 0).write_to_nanomsg(*nanomsg, LONG_TIMEOUT);