src/lib/ext.cc

   1 /*
   2     Copyright (C) 2019-2020 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   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.
  10
  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.
  15
  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/>.
  18
  19 */
  20
  21
  22 #include "compose.hpp"
  23 #include "cross.h"
  24 #include "dcpomatic_log.h"
  25 #include "digester.h"
  26 #include "disk_writer_messages.h"
  27 #include "exceptions.h"
  28 #include "ext.h"
  29 #include "nanomsg.h"
  30
  31 #ifdef DCPOMATIC_LINUX
  32 #include <linux/fs.h>
  33 #include <sys/ioctl.h>
  34 extern "C" {
  35 #include <lwext4/file_dev.h>
  36 }
  37 #endif
  38
  39 #ifdef DCPOMATIC_OSX
  40 extern "C" {
  41 #include <lwext4/file_dev.h>
  42 }
  43 #endif
  44
  45 #ifdef DCPOMATIC_WINDOWS
  46 extern "C" {
  47 #include <lwext4/file_windows.h>
  48 }
  49 #endif
  50
  51 extern "C" {
  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>
  58 }
  59 #include <boost/filesystem.hpp>
  60 #include <chrono>
  61 #include <string>
  62
  63
  64 using std::exception;
  65 using std::min;
  66 using std::string;
  67 using std::vector;
  68
  69
  70 #define SHORT_TIMEOUT 100
  71 #define LONG_TIMEOUT 2000
  72
  73
  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;
  76
  77
  78 static
  79 void
  80 count (boost::filesystem::path dir, uint64_t& total_bytes)
  81 {
  82         dir = fix_long_path (dir);
  83
  84         using namespace boost::filesystem;
  85         for (auto i: directory_iterator(dir)) {
  86                 if (is_directory(i)) {
  87                         count (i, total_bytes);
  88                 } else {
  89                         total_bytes += file_size (i);
  90                 }
  91         }
  92 }
  93
  94
  95 static
  96 void
  97 set_timestamps_to_now (boost::filesystem::path path)
  98 {
  99         auto const now = std::chrono::duration_cast<std::chrono::seconds>(std::chrono::system_clock::now().time_since_epoch()).count();
 100         ext4_mtime_set (path.generic_string().c_str(), now);
 101         ext4_ctime_set (path.generic_string().c_str(), now);
 102         ext4_atime_set (path.generic_string().c_str(), now);
 103 }
 104
 105
 106 static
 107 string
 108 write (boost::filesystem::path from, boost::filesystem::path to, uint64_t& total_remaining, uint64_t total, Nanomsg* nanomsg)
 109 {
 110         ext4_file out;
 111         int r = ext4_fopen(&out, to.generic_string().c_str(), "wb");
 112         if (r != EOK) {
 113                 throw CopyError (String::compose("Failed to open file %1", to.generic_string()), r);
 114         }
 115
 116         FILE* in = fopen_boost (from, "rb");
 117         if (!in) {
 118                 ext4_fclose (&out);
 119                 throw CopyError (String::compose("Failed to open file %1", from.string()), 0);
 120         }
 121
 122         std::vector<uint8_t> buffer(block_size);
 123         Digester digester;
 124
 125         int progress_frequency = 1;
 126         int progress_count = 0;
 127         uint64_t remaining = file_size (from);
 128         while (remaining > 0) {
 129                 uint64_t const this_time = min(remaining, block_size);
 130                 size_t read = fread (buffer.data(), 1, this_time, in);
 131                 if (read != this_time) {
 132                         fclose (in);
 133                         ext4_fclose (&out);
 134                         throw CopyError (String::compose("Short read; expected %1 but read %2", this_time, read), 0);
 135                 }
 136
 137                 digester.add (buffer.data(), this_time);
 138
 139                 size_t written;
 140                 r = ext4_fwrite (&out, buffer.data(), this_time, &written);
 141                 if (r != EOK) {
 142                         fclose (in);
 143                         ext4_fclose (&out);
 144                         throw CopyError ("Write failed", r);
 145                 }
 146                 if (written != this_time) {
 147                         fclose (in);
 148                         ext4_fclose (&out);
 149                         throw CopyError (String::compose("Short write; expected %1 but wrote %2", this_time, written), 0);
 150                 }
 151                 remaining -= this_time;
 152                 total_remaining -= this_time;
 153
 154                 ++progress_count;
 155                 if ((progress_count % progress_frequency) == 0 && nanomsg) {
 156                         nanomsg->send(String::compose(DISK_WRITER_COPY_PROGRESS "\n%1\n", (1 - float(total_remaining) / total)), SHORT_TIMEOUT);
 157                 }
 158         }
 159
 160         fclose (in);
 161         ext4_fclose (&out);
 162
 163         set_timestamps_to_now (to);
 164
 165         return digester.get ();
 166 }
 167
 168
 169 static
 170 string
 171 read (boost::filesystem::path from, boost::filesystem::path to, uint64_t& total_remaining, uint64_t total, Nanomsg* nanomsg)
 172 {
 173         ext4_file in;
 174         LOG_DISK("Opening %1 for read", to.generic_string());
 175         int r = ext4_fopen(&in, to.generic_string().c_str(), "rb");
 176         if (r != EOK) {
 177                 throw VerifyError (String::compose("Failed to open file %1", to.generic_string()), r);
 178         }
 179         LOG_DISK("Opened %1 for read", to.generic_string());
 180
 181         std::vector<uint8_t> buffer(block_size);
 182         Digester digester;
 183
 184         uint64_t remaining = file_size (from);
 185         while (remaining > 0) {
 186                 uint64_t const this_time = min(remaining, block_size);
 187                 size_t read;
 188                 r = ext4_fread (&in, buffer.data(), this_time, &read);
 189                 if (read != this_time) {
 190                         ext4_fclose (&in);
 191                         throw VerifyError (String::compose("Short read; expected %1 but read %2", this_time, read), 0);
 192                 }
 193
 194                 digester.add (buffer.data(), this_time);
 195                 remaining -= this_time;
 196                 total_remaining -= this_time;
 197                 if (nanomsg) {
 198                         nanomsg->send(String::compose(DISK_WRITER_VERIFY_PROGRESS "\n%1\n", (1 - float(total_remaining) / total)), SHORT_TIMEOUT);
 199                 }
 200         }
 201
 202         ext4_fclose (&in);
 203
 204         return digester.get ();
 205 }
 206
 207
 208 class CopiedFile
 209 {
 210 public:
 211         CopiedFile (boost::filesystem::path from_, boost::filesystem::path to_, string write_digest_)
 212                 : from (from_)
 213                 , to (to_)
 214                 , write_digest (write_digest_)
 215         {}
 216
 217         boost::filesystem::path from;
 218         boost::filesystem::path to;
 219         /** digest calculated from data as it was read from the source during write */
 220         string write_digest;
 221 };
 222
 223
 224 /** @param from File to copy from.
 225  *  @param to Directory to copy to.
 226  */
 227 static
 228 void
 229 copy (boost::filesystem::path from, boost::filesystem::path to, uint64_t& total_remaining, uint64_t total, vector<CopiedFile>& copied_files, Nanomsg* nanomsg)
 230 {
 231         LOG_DISK ("Copy %1 -> %2", from.string(), to.generic_string());
 232         from = fix_long_path (from);
 233
 234         using namespace boost::filesystem;
 235
 236         path const cr = to / from.filename();
 237
 238         if (is_directory(from)) {
 239                 int r = ext4_dir_mk (cr.generic_string().c_str());
 240                 if (r != EOK) {
 241                         throw CopyError (String::compose("Failed to create directory %1", cr.generic_string()), r);
 242                 }
 243                 set_timestamps_to_now (cr);
 244
 245                 for (auto i: directory_iterator(from)) {
 246                         copy (i.path(), cr, total_remaining, total, copied_files, nanomsg);
 247                 }
 248         } else {
 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));
 252         }
 253 }
 254
 255
 256 static
 257 void
 258 verify (vector<CopiedFile> const& copied_files, uint64_t total, Nanomsg* nanomsg)
 259 {
 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);
 266                 }
 267         }
 268 }
 269
 270
 271 static
 272 void
 273 format_progress (void* context, float progress)
 274 {
 275         if (context) {
 276                 reinterpret_cast<Nanomsg*>(context)->send(String::compose(DISK_WRITER_FORMAT_PROGRESS "\n%1\n", progress), SHORT_TIMEOUT);
 277         }
 278 }
 279
 280
 281 void
 282 #ifdef DCPOMATIC_WINDOWS
 283 dcpomatic::write (boost::filesystem::path dcp_path, string device, string, Nanomsg* nanomsg)
 284 #else
 285 dcpomatic::write (boost::filesystem::path dcp_path, string device, string posix_partition, Nanomsg* nanomsg)
 286 #endif
 287 try
 288 {
 289         ext4_dmask_set (DEBUG_ALL);
 290
 291         /* We rely on static initialization for these */
 292         static struct ext4_fs fs;
 293         static struct ext4_mkfs_info info;
 294         info.block_size = 4096;
 295         info.inode_size = 128;
 296         info.journal = false;
 297
 298 #ifdef WIN32
 299         file_windows_name_set(device.c_str());
 300         struct ext4_blockdev* bd = file_windows_dev_get();
 301 #else
 302         file_dev_name_set (device.c_str());
 303         struct ext4_blockdev* bd = file_dev_get ();
 304 #endif
 305
 306         if (!bd) {
 307                 throw CopyError ("Failed to open drive", 0);
 308         }
 309         LOG_DISK_NC ("Opened drive");
 310
 311         struct ext4_mbr_parts parts;
 312         parts.division[0] = 100;
 313         parts.division[1] = 0;
 314         parts.division[2] = 0;
 315         parts.division[3] = 0;
 316
 317         /* XXX: not sure if disk_id matters */
 318         int r = ext4_mbr_write (bd, &parts, 0);
 319         if (r) {
 320                 throw CopyError ("Failed to write MBR", r);
 321         }
 322         LOG_DISK_NC ("Wrote MBR");
 323
 324         struct ext4_mbr_bdevs bdevs;
 325         r = ext4_mbr_scan (bd, &bdevs);
 326         if (r != EOK) {
 327                 throw CopyError ("Failed to read MBR", r);
 328         }
 329
 330 #ifdef DCPOMATIC_LINUX
 331         /* Re-read the partition table */
 332         int fd = open(device.c_str(), O_RDONLY);
 333         ioctl(fd, BLKRRPART, NULL);
 334         close(fd);
 335 #endif
 336
 337         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);
 338
 339 #ifdef DCPOMATIC_WINDOWS
 340         file_windows_partition_set (bdevs.partitions[0].part_offset, bdevs.partitions[0].part_size);
 341 #else
 342         file_dev_name_set (posix_partition.c_str());
 343
 344         /* On macOS (at least) if you try to write to a drive that is sleeping the ext4_mkfs call
 345          * below is liable to return EIO because it can't open the device.  Try to work around that
 346          * here by opening and closing the device, waiting 5 seconds if it fails.
 347          */
 348         int wake = open(posix_partition.c_str(), O_RDWR);
 349         if (wake == -1) {
 350                 dcpomatic_sleep_seconds (5);
 351         } else {
 352                 close(wake);
 353         }
 354
 355         bd = file_dev_get ();
 356 #endif
 357
 358         if (!bd) {
 359                 throw CopyError ("Failed to open partition", 0);
 360         }
 361         LOG_DISK_NC ("Opened partition");
 362
 363         r = ext4_mkfs(&fs, bd, &info, F_SET_EXT2, format_progress, nanomsg);
 364         if (r != EOK) {
 365                 throw CopyError ("Failed to make filesystem", r);
 366         }
 367         LOG_DISK_NC ("Made filesystem");
 368
 369         r = ext4_device_register(bd, "ext4_fs");
 370         if (r != EOK) {
 371                 throw CopyError ("Failed to register device", r);
 372         }
 373         LOG_DISK_NC ("Registered device");
 374
 375         r = ext4_mount("ext4_fs", "/mp/", false);
 376         if (r != EOK) {
 377                 throw CopyError ("Failed to mount device", r);
 378         }
 379         LOG_DISK_NC ("Mounted device");
 380
 381         uint64_t total_bytes = 0;
 382         count (dcp_path, total_bytes);
 383
 384         uint64_t total_remaining = total_bytes;
 385         vector<CopiedFile> copied_files;
 386         copy (dcp_path, "/mp", total_remaining, total_bytes, copied_files, nanomsg);
 387
 388         /* Unmount and re-mount to make sure the write has finished */
 389         r = ext4_umount("/mp/");
 390         if (r != EOK) {
 391                 throw CopyError ("Failed to unmount device", r);
 392         }
 393         r = ext4_mount("ext4_fs", "/mp/", false);
 394         if (r != EOK) {
 395                 throw CopyError ("Failed to mount device", r);
 396         }
 397         LOG_DISK_NC ("Re-mounted device");
 398
 399         verify (copied_files, total_bytes, nanomsg);
 400
 401         r = ext4_umount("/mp/");
 402         if (r != EOK) {
 403                 throw CopyError ("Failed to unmount device", r);
 404         }
 405
 406         ext4_device_unregister("ext4_fs");
 407         if (nanomsg && !nanomsg->send(DISK_WRITER_OK "\n", LONG_TIMEOUT)) {
 408                 throw CommunicationFailedError ();
 409         }
 410
 411         disk_write_finished ();
 412 } catch (CopyError& e) {
 413         LOG_DISK("CopyError (from write): %1 %2", e.message(), e.number().get_value_or(0));
 414         if (nanomsg) {
 415                 nanomsg->send(String::compose(DISK_WRITER_ERROR "\n%1\n%2\n", e.message(), e.number().get_value_or(0)), LONG_TIMEOUT);
 416         }
 417 } catch (VerifyError& e) {
 418         LOG_DISK("VerifyError (from write): %1 %2", e.message(), e.number());
 419         if (nanomsg) {
 420                 nanomsg->send(String::compose(DISK_WRITER_ERROR "\n%1\n%2\n", e.message(), e.number()), LONG_TIMEOUT);
 421         }
 422 } catch (exception& e) {
 423         LOG_DISK("Exception (from write): %1", e.what());
 424         if (nanomsg) {
 425                 nanomsg->send(String::compose(DISK_WRITER_ERROR "\n%1\n0\n", e.what()), LONG_TIMEOUT);
 426         }
 427 }
 428
 429