src/lib/cross_osx.cc

   1 /*
   2     Copyright (C) 2012-2021 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 "cross.h"
  23 #include "compose.hpp"
  24 #include "log.h"
  25 #include "dcpomatic_log.h"
  26 #include "config.h"
  27 #include "exceptions.h"
  28 #include "warnings.h"
  29 #include <dcp/raw_convert.h>
  30 #include <glib.h>
  31 extern "C" {
  32 #include <libavformat/avio.h>
  33 }
  34 #include <boost/algorithm/string.hpp>
  35 #include <boost/regex.hpp>
  36 #if BOOST_VERSION >= 106100
  37 #include <boost/dll/runtime_symbol_info.hpp>
  38 #endif
  39 #include <ApplicationServices/ApplicationServices.h>
  40 #include <sys/sysctl.h>
  41 #include <mach-o/dyld.h>
  42 #include <IOKit/pwr_mgt/IOPMLib.h>
  43 #include <IOKit/storage/IOMedia.h>
  44 #include <DiskArbitration/DADisk.h>
  45 #include <DiskArbitration/DiskArbitration.h>
  46 #include <CoreFoundation/CFURL.h>
  47 #include <sys/types.h>
  48 #include <ifaddrs.h>
  49 #include <netinet/in.h>
  50 #include <arpa/inet.h>
  51 #include <fstream>
  52 #include <cstring>
  53
  54 #include "i18n.h"
  55
  56
  57 using std::pair;
  58 using std::list;
  59 using std::ifstream;
  60 using std::string;
  61 using std::make_pair;
  62 using std::vector;
  63 using std::cerr;
  64 using std::cout;
  65 using std::runtime_error;
  66 using std::map;
  67 using std::shared_ptr;
  68 using boost::optional;
  69 using std::function;
  70
  71
  72 /** @param s Number of seconds to sleep for */
  73 void
  74 dcpomatic_sleep_seconds (int s)
  75 {
  76         sleep (s);
  77 }
  78
  79
  80 void
  81 dcpomatic_sleep_milliseconds (int ms)
  82 {
  83         usleep (ms * 1000);
  84 }
  85
  86
  87 /** @return A string of CPU information (model name etc.) */
  88 string
  89 cpu_info ()
  90 {
  91         string info;
  92
  93         char buffer[64];
  94         size_t N = sizeof (buffer);
  95         if (sysctlbyname("machdep.cpu.brand_string", buffer, &N, 0, 0) == 0) {
  96                 info = buffer;
  97         }
  98
  99         return info;
 100 }
 101
 102
 103 boost::filesystem::path
 104 directory_containing_executable ()
 105 {
 106         return boost::filesystem::canonical(boost::dll::program_location()).parent_path();
 107 }
 108
 109
 110 boost::filesystem::path
 111 resources_path ()
 112 {
 113         return directory_containing_executable().parent_path() / "Resources";
 114 }
 115
 116
 117 boost::filesystem::path
 118 libdcp_resources_path ()
 119 {
 120         return resources_path();
 121 }
 122
 123
 124 void
 125 run_ffprobe (boost::filesystem::path content, boost::filesystem::path out)
 126 {
 127         auto path = directory_containing_executable () / "ffprobe";
 128
 129         string ffprobe = "\"" + path.string() + "\" \"" + content.string() + "\" 2> \"" + out.string() + "\"";
 130         LOG_GENERAL (N_("Probing with %1"), ffprobe);
 131         system (ffprobe.c_str ());
 132 }
 133
 134
 135
 136 list<pair<string, string>>
 137 mount_info ()
 138 {
 139         return {};
 140 }
 141
 142
 143 boost::filesystem::path
 144 openssl_path ()
 145 {
 146         return directory_containing_executable() / "openssl";
 147 }
 148
 149
 150 #ifdef DCPOMATIC_DISK
 151 /* Note: this isn't actually used at the moment as the disk writer is started as a service */
 152 boost::filesystem::path
 153 disk_writer_path ()
 154 {
 155         return directory_containing_executable() / "dcpomatic2_disk_writer";
 156 }
 157 #endif
 158
 159
 160 /* Apparently there is no way to create an ofstream using a UTF-8
 161    filename under Windows.  We are hence reduced to using fopen
 162    with this wrapper.
 163 */
 164 FILE *
 165 fopen_boost (boost::filesystem::path p, string t)
 166 {
 167         return fopen (p.c_str(), t.c_str());
 168 }
 169
 170
 171 int
 172 dcpomatic_fseek (FILE* stream, int64_t offset, int whence)
 173 {
 174         return fseek (stream, offset, whence);
 175 }
 176
 177
 178 void
 179 Waker::nudge ()
 180 {
 181
 182 }
 183
 184
 185 Waker::Waker ()
 186 {
 187         boost::mutex::scoped_lock lm (_mutex);
 188         IOPMAssertionCreateWithName (kIOPMAssertionTypeNoIdleSleep, kIOPMAssertionLevelOn, CFSTR ("Encoding DCP"), &_assertion_id);
 189 }
 190
 191
 192 Waker::~Waker ()
 193 {
 194         boost::mutex::scoped_lock lm (_mutex);
 195         IOPMAssertionRelease (_assertion_id);
 196 }
 197
 198
 199 void
 200 start_tool (string executable, string app)
 201 {
 202         auto exe_path = directory_containing_executable();
 203         exe_path = exe_path.parent_path(); // Contents
 204         exe_path = exe_path.parent_path(); // DCP-o-matic 2.app
 205         exe_path = exe_path.parent_path(); // Applications
 206         exe_path /= app;
 207         exe_path /= "Contents";
 208         exe_path /= "MacOS";
 209         exe_path /= executable;
 210
 211         pid_t pid = fork ();
 212         if (pid == 0) {
 213                 LOG_GENERAL ("start_tool %1 %2 with path %3", executable, app, exe_path.string());
 214                 int const r = system (exe_path.string().c_str());
 215                 exit (WEXITSTATUS (r));
 216         } else if (pid == -1) {
 217                 LOG_ERROR_NC("Fork failed in start_tool");
 218         }
 219 }
 220
 221
 222 void
 223 start_batch_converter ()
 224 {
 225         start_tool ("dcpomatic2_batch", "DCP-o-matic\\ 2\\ Batch\\ Converter.app");
 226 }
 227
 228
 229 void
 230 start_player ()
 231 {
 232         start_tool ("dcpomatic2_player", "DCP-o-matic\\ 2\\ Player.app");
 233 }
 234
 235
 236 uint64_t
 237 thread_id ()
 238 {
 239         return (uint64_t) pthread_self ();
 240 }
 241
 242
 243 int
 244 avio_open_boost (AVIOContext** s, boost::filesystem::path file, int flags)
 245 {
 246         return avio_open (s, file.c_str(), flags);
 247 }
 248
 249
 250 boost::filesystem::path
 251 home_directory ()
 252 {
 253         return getenv("HOME");
 254 }
 255
 256
 257 /** @return true if this process is a 32-bit one running on a 64-bit-capable OS */
 258 bool
 259 running_32_on_64 ()
 260 {
 261         /* I'm assuming nobody does this on OS X */
 262         return false;
 263 }
 264
 265
 266 static optional<string>
 267 get_vendor (CFDictionaryRef& description)
 268 {
 269         void const* str = CFDictionaryGetValue (description, kDADiskDescriptionDeviceVendorKey);
 270         if (!str) {
 271                 return {};
 272         }
 273
 274         auto c_str = CFStringGetCStringPtr ((CFStringRef) str, kCFStringEncodingUTF8);
 275         if (!c_str) {
 276                 return {};
 277         }
 278
 279         string s (c_str);
 280         boost::algorithm::trim (s);
 281         return s;
 282 }
 283
 284
 285 static optional<string>
 286 get_model (CFDictionaryRef& description)
 287 {
 288         void const* str = CFDictionaryGetValue (description, kDADiskDescriptionDeviceModelKey);
 289         if (!str) {
 290                 return {};
 291         }
 292
 293         auto c_str = CFStringGetCStringPtr ((CFStringRef) str, kCFStringEncodingUTF8);
 294         if (!c_str) {
 295                 return {};
 296         }
 297
 298         string s (c_str);
 299         boost::algorithm::trim (s);
 300         return s;
 301 }
 302
 303
 304 static optional<OSXMediaPath>
 305 analyse_media_path (CFDictionaryRef& description)
 306 {
 307         using namespace boost::algorithm;
 308
 309         void const* str = CFDictionaryGetValue (description, kDADiskDescriptionMediaPathKey);
 310         if (!str) {
 311                 LOG_DISK_NC("There is no MediaPathKey (no dictionary value)");
 312                 return {};
 313         }
 314
 315         auto path_key_cstr = CFStringGetCStringPtr((CFStringRef) str, kCFStringEncodingUTF8);
 316         if (!path_key_cstr) {
 317                 LOG_DISK_NC("There is no MediaPathKey (no cstring)");
 318                 return {};
 319         }
 320
 321         string path(path_key_cstr);
 322         LOG_DISK("MediaPathKey is %1", path);
 323         return analyse_osx_media_path (path);
 324 }
 325
 326
 327 static bool
 328 is_whole_drive (DADiskRef& disk)
 329 {
 330         io_service_t service = DADiskCopyIOMedia (disk);
 331         CFTypeRef whole_media_ref = IORegistryEntryCreateCFProperty (service, CFSTR(kIOMediaWholeKey), kCFAllocatorDefault, 0);
 332         bool whole_media = false;
 333         if (whole_media_ref) {
 334                 whole_media = CFBooleanGetValue((CFBooleanRef) whole_media_ref);
 335                 CFRelease (whole_media_ref);
 336         }
 337         IOObjectRelease (service);
 338         return whole_media;
 339 }
 340
 341
 342 static optional<boost::filesystem::path>
 343 mount_point (CFDictionaryRef& description)
 344 {
 345         auto volume_path_key = (CFURLRef) CFDictionaryGetValue (description, kDADiskDescriptionVolumePathKey);
 346         if (!volume_path_key) {
 347                 return {};
 348         }
 349
 350         char mount_path_buffer[1024];
 351         if (!CFURLGetFileSystemRepresentation(volume_path_key, false, (UInt8 *) mount_path_buffer, sizeof(mount_path_buffer))) {
 352                 return {};
 353         }
 354         return boost::filesystem::path(mount_path_buffer);
 355 }
 356
 357
 358 /* Here follows some rather intricate and (probably) fragile code to find the list of available
 359  * "real" drives on macOS that we might want to write a DCP to.
 360  *
 361  * We use the Disk Arbitration framework to give us a series of mount_points (/dev/disk0, /dev/disk1,
 362  * /dev/disk1s1 and so on) and we use the API to gather useful information about these mount_points into
 363  * a vector of Disk structs.
 364  *
 365  * Then we read the Disks that we found and try to derive a list of drives that we should offer to the
 366  * user, with details of whether those drives are currently mounted or not.
 367  *
 368  * At the basic level we find the "disk"-level mount_points, looking at whether any of their partitions are mounted.
 369  *
 370  * This is complicated enormously by recent-ish macOS versions' habit of making `synthesized' volumes which
 371  * reflect data in `real' partitions.  So, for example, we might have a real (physical) drive /dev/disk2 with
 372  * a partition /dev/disk2s2 whose content is made into a synthesized /dev/disk3, itself containing some partitions
 373  * which are mounted.  /dev/disk2s2 is not considered to be mounted, in this case.  So we need to know that
 374  * disk2s2 is related to disk3 so we can consider disk2s2 as mounted if any parts of disk3 are.  In order to do
 375  * this I am taking the first two parts of the IODeviceTree and seeing if they exist anywhere in a
 376  * IOService identifier.  If they do, I am assuming the IOService device is on the matching IODeviceTree device.
 377  *
 378  * Lots of this is guesswork and may be broken.  In my defence the documentation that I have been able to
 379  * unearth is, to put it impolitely, crap.
 380  */
 381
 382 static void
 383 disk_appeared (DADiskRef disk, void* context)
 384 {
 385         auto bsd_name = DADiskGetBSDName (disk);
 386         if (!bsd_name) {
 387                 LOG_DISK_NC("Disk with no BSDName appeared");
 388                 return;
 389         }
 390         LOG_DISK("%1 appeared", bsd_name);
 391
 392         OSXDisk this_disk;
 393
 394         this_disk.device = string("/dev/") + bsd_name;
 395         LOG_DISK("Device is %1", this_disk.device);
 396
 397         CFDictionaryRef description = DADiskCopyDescription (disk);
 398
 399         this_disk.vendor = get_vendor (description);
 400         this_disk.model = get_model (description);
 401         LOG_DISK("Vendor/model: %1 %2", this_disk.vendor.get_value_or("[none]"), this_disk.model.get_value_or("[none]"));
 402
 403         auto media_path = analyse_media_path (description);
 404         if (!media_path) {
 405                 LOG_DISK("Finding media path for %1 failed", bsd_name);
 406                 return;
 407         }
 408
 409         this_disk.media_path = *media_path;
 410         this_disk.whole = is_whole_drive (disk);
 411         auto mp = mount_point (description);
 412         if (mp) {
 413                 this_disk.mount_points.push_back (*mp);
 414         }
 415
 416         LOG_DISK(
 417                 "%1 %2 mounted at %3",
 418                  this_disk.media_path.real ? "Real" : "Synth",
 419                  this_disk.whole ? "whole" : "part",
 420                  mp ? mp->string() : "[nowhere]"
 421                 );
 422
 423         auto media_size_cstr = CFDictionaryGetValue (description, kDADiskDescriptionMediaSizeKey);
 424         if (!media_size_cstr) {
 425                 LOG_DISK_NC("Could not read media size");
 426                 return;
 427         }
 428
 429         CFNumberGetValue ((CFNumberRef) media_size_cstr, kCFNumberLongType, &this_disk.size);
 430         CFRelease (description);
 431
 432         reinterpret_cast<vector<OSXDisk>*>(context)->push_back(this_disk);
 433 }
 434
 435
 436 vector<Drive>
 437 Drive::get ()
 438 {
 439         using namespace boost::algorithm;
 440         vector<OSXDisk> disks;
 441
 442         auto session = DASessionCreate(kCFAllocatorDefault);
 443         if (!session) {
 444                 return {};
 445         }
 446
 447         DARegisterDiskAppearedCallback (session, NULL, disk_appeared, &disks);
 448         auto run_loop = CFRunLoopGetCurrent ();
 449         DASessionScheduleWithRunLoop (session, run_loop, kCFRunLoopDefaultMode);
 450         CFRunLoopStop (run_loop);
 451         CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.05, 0);
 452         DAUnregisterCallback(session, (void *) disk_appeared, &disks);
 453         CFRelease(session);
 454
 455         return osx_disks_to_drives (disks);
 456 }
 457
 458
 459 boost::filesystem::path
 460 config_path (optional<string> version)
 461 {
 462         boost::filesystem::path p;
 463         p /= g_get_home_dir ();
 464         p /= "Library";
 465         p /= "Preferences";
 466         p /= "com.dcpomatic";
 467         p /= "2";
 468         if (version) {
 469                 p /= *version;
 470         }
 471         return p;
 472 }
 473
 474
 475 void done_callback(DADiskRef, DADissenterRef dissenter, void* context)
 476 {
 477         LOG_DISK_NC("Unmount finished");
 478         bool* success = reinterpret_cast<bool*> (context);
 479         if (dissenter) {
 480                 LOG_DISK("Error: %1", DADissenterGetStatus(dissenter));
 481                 *success = false;
 482         } else {
 483                 LOG_DISK_NC("Successful");
 484                 *success = true;
 485         }
 486 }
 487
 488
 489 bool
 490 Drive::unmount ()
 491 {
 492         LOG_DISK_NC("Unmount operation started");
 493
 494         auto session = DASessionCreate(kCFAllocatorDefault);
 495         if (!session) {
 496                 return false;
 497         }
 498
 499         auto disk = DADiskCreateFromBSDName(kCFAllocatorDefault, session, _device.c_str());
 500         if (!disk) {
 501                 return false;
 502         }
 503         LOG_DISK("Requesting unmount of %1 from %2", _device, thread_id());
 504         bool success = false;
 505         DADiskUnmount(disk, kDADiskUnmountOptionWhole, &done_callback, &success);
 506         CFRelease (disk);
 507
 508         CFRunLoopRef run_loop = CFRunLoopGetCurrent ();
 509         DASessionScheduleWithRunLoop (session, run_loop, kCFRunLoopDefaultMode);
 510         CFRunLoopStop (run_loop);
 511         CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.5, 0);
 512         CFRelease(session);
 513
 514         LOG_DISK_NC("End of unmount");
 515         return success;
 516 }
 517
 518
 519 void
 520 disk_write_finished ()
 521 {
 522
 523 }
 524
 525
 526 void
 527 make_foreground_application ()
 528 {
 529         ProcessSerialNumber serial;
 530 DCPOMATIC_DISABLE_WARNINGS
 531         GetCurrentProcess (&serial);
 532 DCPOMATIC_ENABLE_WARNINGS
 533         TransformProcessType (&serial, kProcessTransformToForegroundApplication);
 534 }
 535
 536
 537 string
 538 dcpomatic::get_process_id ()
 539 {
 540         return dcp::raw_convert<string>(getpid());
 541 }
 542
 543
 544 boost::filesystem::path
 545 fix_long_path (boost::filesystem::path path)
 546 {
 547         return path;
 548 }
 549
 550
 551 bool
 552 show_in_file_manager (boost::filesystem::path, boost::filesystem::path select)
 553 {
 554         int r = system (String::compose("open -R \"%1\"", select.string()).c_str());
 555         return static_cast<bool>(WEXITSTATUS(r));
 556 }
 557