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