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 <boost/foreach.hpp>
  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         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);
  86                 } else {
  87                         total_bytes += file_size (*i);
  88                 }
  89         }
  90 }
  91
  92 static
  93 string
  94 write (boost::filesystem::path from, boost::filesystem::path to, uint64_t& total_remaining, uint64_t total, Nanomsg* nanomsg)
  95 {
  96         ext4_file out;
  97         int r = ext4_fopen(&out, to.generic_string().c_str(), "wb");
  98         if (r != EOK) {
  99                 throw CopyError (String::compose("Failed to open file %1", to.generic_string()), r);
 100         }
 101
 102         FILE* in = fopen_boost (from, "rb");
 103         if (!in) {
 104                 ext4_fclose (&out);
 105                 throw CopyError (String::compose("Failed to open file %1", from.string()), 0);
 106         }
 107
 108         uint8_t* buffer = new uint8_t[block_size];
 109         Digester digester;
 110
 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) {
 118                         fclose (in);
 119                         ext4_fclose (&out);
 120                         delete[] buffer;
 121                         throw CopyError (String::compose("Short read; expected %1 but read %2", this_time, read), 0);
 122                 }
 123
 124                 digester.add (buffer, this_time);
 125
 126                 size_t written;
 127                 r = ext4_fwrite (&out, buffer, this_time, &written);
 128                 if (r != EOK) {
 129                         fclose (in);
 130                         ext4_fclose (&out);
 131                         delete[] buffer;
 132                         throw CopyError ("Write failed", r);
 133                 }
 134                 if (written != this_time) {
 135                         fclose (in);
 136                         ext4_fclose (&out);
 137                         delete[] buffer;
 138                         throw CopyError (String::compose("Short write; expected %1 but wrote %2", this_time, written), 0);
 139                 }
 140                 remaining -= this_time;
 141                 total_remaining -= this_time;
 142
 143                 ++progress_count;
 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);
 146                 }
 147         }
 148
 149         fclose (in);
 150         ext4_fclose (&out);
 151         delete[] buffer;
 152
 153         return digester.get ();
 154 }
 155
 156
 157 static
 158 string
 159 read (boost::filesystem::path from, boost::filesystem::path to, uint64_t& total_remaining, uint64_t total, Nanomsg* nanomsg)
 160 {
 161         ext4_file in;
 162         LOG_DISK("Opening %1 for read", to.generic_string());
 163         int r = ext4_fopen(&in, to.generic_string().c_str(), "rb");
 164         if (r != EOK) {
 165                 throw VerifyError (String::compose("Failed to open file %1", to.generic_string()), r);
 166         }
 167         LOG_DISK("Opened %1 for read", to.generic_string());
 168
 169         uint8_t* buffer = new uint8_t[block_size];
 170         Digester digester;
 171
 172         uint64_t remaining = file_size (from);
 173         while (remaining > 0) {
 174                 uint64_t const this_time = min(remaining, block_size);
 175                 size_t read;
 176                 r = ext4_fread (&in, buffer, this_time, &read);
 177                 if (read != this_time) {
 178                         ext4_fclose (&in);
 179                         delete[] buffer;
 180                         throw VerifyError (String::compose("Short read; expected %1 but read %2", this_time, read), 0);
 181                 }
 182
 183                 digester.add (buffer, this_time);
 184                 remaining -= this_time;
 185                 total_remaining -= this_time;
 186                 if (nanomsg) {
 187                         nanomsg->send(String::compose(DISK_WRITER_VERIFY_PROGRESS "\n%1\n", (1 - float(total_remaining) / total)), SHORT_TIMEOUT);
 188                 }
 189         }
 190
 191         ext4_fclose (&in);
 192         delete[] buffer;
 193
 194         return digester.get ();
 195 }
 196
 197
 198 class CopiedFile
 199 {
 200 public:
 201         CopiedFile (boost::filesystem::path from_, boost::filesystem::path to_, string write_digest_)
 202                 : from (from_)
 203                 , to (to_)
 204                 , write_digest (write_digest_)
 205         {}
 206
 207         boost::filesystem::path from;
 208         boost::filesystem::path to;
 209         /** digest calculated from data as it was read from the source during write */
 210         string write_digest;
 211 };
 212
 213
 214 /** @param from File to copy from.
 215  *  @param to Directory to copy to.
 216  */
 217 static
 218 void
 219 copy (boost::filesystem::path from, boost::filesystem::path to, uint64_t& total_remaining, uint64_t total, vector<CopiedFile>& copied_files, Nanomsg* nanomsg)
 220 {
 221         LOG_DISK ("Copy %1 -> %2", from.string(), to.generic_string());
 222
 223         using namespace boost::filesystem;
 224
 225         path const cr = to / from.filename();
 226
 227         if (is_directory(from)) {
 228                 int r = ext4_dir_mk (cr.generic_string().c_str());
 229                 if (r != EOK) {
 230                         throw CopyError (String::compose("Failed to create directory %1", cr.generic_string()), r);
 231                 }
 232
 233                 for (directory_iterator i = directory_iterator(from); i != directory_iterator(); ++i) {
 234                         copy (i->path(), cr, total_remaining, total, copied_files, nanomsg);
 235                 }
 236         } else {
 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));
 240         }
 241 }
 242
 243
 244 static
 245 void
 246 verify (vector<CopiedFile> const& copied_files, uint64_t total, Nanomsg* nanomsg)
 247 {
 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);
 254                 }
 255         }
 256 }
 257
 258
 259 void
 260 #ifdef DCPOMATIC_WINDOWS
 261 dcpomatic::write (boost::filesystem::path dcp_path, string device, string, Nanomsg* nanomsg)
 262 #else
 263 dcpomatic::write (boost::filesystem::path dcp_path, string device, string posix_partition, Nanomsg* nanomsg)
 264 #endif
 265 try
 266 {
 267         ext4_dmask_set (DEBUG_ALL);
 268
 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;
 275
 276 #ifdef WIN32
 277         file_windows_name_set(device.c_str());
 278         struct ext4_blockdev* bd = file_windows_dev_get();
 279 #else
 280         file_dev_name_set (device.c_str());
 281         struct ext4_blockdev* bd = file_dev_get ();
 282 #endif
 283
 284         if (!bd) {
 285                 throw CopyError ("Failed to open drive", 0);
 286         }
 287         LOG_DISK_NC ("Opened drive");
 288
 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;
 294
 295 #ifdef DCPOMATIC_LINUX
 296         PrivilegeEscalator e;
 297 #endif
 298
 299         /* XXX: not sure if disk_id matters */
 300         int r = ext4_mbr_write (bd, &parts, 0);
 301         if (r) {
 302                 throw CopyError ("Failed to write MBR", r);
 303         }
 304         LOG_DISK_NC ("Wrote MBR");
 305
 306         struct ext4_mbr_bdevs bdevs;
 307         r = ext4_mbr_scan (bd, &bdevs);
 308         if (r != EOK) {
 309                 throw CopyError ("Failed to read MBR", r);
 310         }
 311
 312 #ifdef DCPOMATIC_LINUX
 313         /* Re-read the partition table */
 314         int fd = open(device.c_str(), O_RDONLY);
 315         ioctl(fd, BLKRRPART, NULL);
 316         close(fd);
 317 #endif
 318
 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);
 320
 321 #ifdef DCPOMATIC_WINDOWS
 322         file_windows_partition_set (bdevs.partitions[0].part_offset, bdevs.partitions[0].part_size);
 323 #else
 324         file_dev_name_set (posix_partition.c_str());
 325         bd = file_dev_get ();
 326 #endif
 327
 328         if (!bd) {
 329                 throw CopyError ("Failed to open partition", 0);
 330         }
 331         LOG_DISK_NC ("Opened partition");
 332
 333         if (nanomsg) {
 334                 nanomsg->send(DISK_WRITER_FORMATTING "\n", SHORT_TIMEOUT);
 335         }
 336
 337         r = ext4_mkfs(&fs, bd, &info, F_SET_EXT2);
 338         if (r != EOK) {
 339                 throw CopyError ("Failed to make filesystem", r);
 340         }
 341         LOG_DISK_NC ("Made filesystem");
 342
 343         r = ext4_device_register(bd, "ext4_fs");
 344         if (r != EOK) {
 345                 throw CopyError ("Failed to register device", r);
 346         }
 347         LOG_DISK_NC ("Registered device");
 348
 349         r = ext4_mount("ext4_fs", "/mp/", false);
 350         if (r != EOK) {
 351                 throw CopyError ("Failed to mount device", r);
 352         }
 353         LOG_DISK_NC ("Mounted device");
 354
 355         uint64_t total_bytes = 0;
 356         count (dcp_path, total_bytes);
 357
 358         uint64_t total_remaining = total_bytes;
 359         vector<CopiedFile> copied_files;
 360         copy (dcp_path, "/mp", total_remaining, total_bytes, copied_files, nanomsg);
 361
 362         /* Unmount and re-mount to make sure the write has finished */
 363         r = ext4_umount("/mp/");
 364         if (r != EOK) {
 365                 throw CopyError ("Failed to unmount device", r);
 366         }
 367         r = ext4_mount("ext4_fs", "/mp/", false);
 368         if (r != EOK) {
 369                 throw CopyError ("Failed to mount device", r);
 370         }
 371         LOG_DISK_NC ("Re-mounted device");
 372
 373         verify (copied_files, total_bytes, nanomsg);
 374
 375         r = ext4_umount("/mp/");
 376         if (r != EOK) {
 377                 throw CopyError ("Failed to unmount device", r);
 378         }
 379
 380         ext4_device_unregister("ext4_fs");
 381         if (nanomsg && !nanomsg->send(DISK_WRITER_OK "\n", LONG_TIMEOUT)) {
 382                 throw CommunicationFailedError ();
 383         }
 384
 385         disk_write_finished ();
 386 } catch (CopyError& e) {
 387         LOG_DISK("CopyError (from write): %1 %2", e.message(), e.number().get_value_or(0));
 388         if (nanomsg) {
 389                 nanomsg->send(String::compose(DISK_WRITER_ERROR "\n%1\n%2\n", e.message(), e.number().get_value_or(0)), LONG_TIMEOUT);
 390         }
 391 } catch (VerifyError& e) {
 392         LOG_DISK("VerifyError (from write): %1 %2", e.message(), e.number());
 393         if (nanomsg) {
 394                 nanomsg->send(String::compose(DISK_WRITER_ERROR "\n%1\n%2\n", e.message(), e.number()), LONG_TIMEOUT);
 395         }
 396 } catch (exception& e) {
 397         LOG_DISK("Exception (from write): %1", e.what());
 398         if (nanomsg) {
 399                 nanomsg->send(String::compose(DISK_WRITER_ERROR "\n%1\n0\n", e.what()), LONG_TIMEOUT);
 400         }
 401 }
 402
 403