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