Adds USB writing for OS X.

chrome/utility/image_writer/image_writer_mac.cc

Index: chrome/utility/image_writer/image_writer_mac.cc
diff --git a/chrome/utility/image_writer/image_writer_mac.cc b/chrome/utility/image_writer/image_writer_mac.cc
new file mode 100644
index 0000000000000000000000000000000000000000..50071cf434002fb13a7c1c8434a29d7a58e139de
--- /dev/null
+++ b/chrome/utility/image_writer/image_writer_mac.cc
@@ -0,0 +1,272 @@
+// Copyright 2014 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#include "chrome/utility/image_writer/image_writer_mac.h"
+
+#include <sys/socket.h>
+#include <IOKit/storage/IOStorageProtocolCharacteristics.h>
+
+#include "base/message_loop/message_loop_proxy.h"
+#include "base/message_loop/message_pump_mac.h"
+#include "base/posix/eintr_wrapper.h"
+#include "chrome/utility/image_writer/error_messages.h"
+#include "chrome/utility/image_writer/image_writer.h"
+
+namespace image_writer {
+
+DiskUnmounter::DiskUnmounter(base::WeakPtr<ImageWriter> image_writer)
+    : image_writer_(image_writer),
+      original_thread_(base::MessageLoopProxy::current()),
+      cf_thread_("ImageWriterDiskArb") {
+}
+
+DiskUnmounter::~DiskUnmounter() {
+  if (disk_)
+    DADiskUnclaim(disk_);
+}
+
+void DiskUnmounter::Unmount(const std::string& device_path,
+                            const base::Closure& continuation) {
+  unmount_continuation_closure_ = continuation;
+
+  base::Thread::Options options;
+  options.message_pump_factory = base::Bind(&CreateMessagePump);
+
+  cf_thread_.StartWithOptions(options);
+
+  cf_thread_.message_loop()->PostTask(
+      FROM_HERE,
+      base::Bind(&DiskUnmounter::UnmountOnWorker, AsWeakPtr(), device_path));
+}
+
+// static
+void DiskUnmounter::DiskClaimed(DADiskRef disk,
+                                DADissenterRef dissenter,
+                                void* context) {
+  DiskUnmounter* disk_unmounter = static_cast<DiskUnmounter*>(context);
+
+  if (dissenter) {
+    LOG(ERROR) << "Unable to claim disk.";
+    disk_unmounter->Error(error::kUnmountVolumes);
+    return;
+  }
+
+  DADiskUnmount(disk,
+                kDADiskUnmountOptionForce | kDADiskUnmountOptionWhole,
+                DiskUnmounted,
+                disk_unmounter);
+}
+
+// static
+DADissenterRef DiskUnmounter::DiskClaimRevoked(DADiskRef disk, void* context) {
+  CFStringRef reason = CFSTR(

[Robert Sesek, 2014/06/05 19:49:48]

Will this message ever be shown to the user? If so, it should be a translated
string.

[Drew Haven, 2014/06/05 22:28:28]

I don't think so.  I actually just copied out what we had in
ChromeOSRecovery/AppController.mm (see internal code search) from the old tool.

The docs don't really seem to make it clear what sort of message goes into the
dissenter.  It appears to be pretty arbitrary and it's up to the other
application to figure out what to do with the string.

We could probably make it less silly, but there's no fun in that.

+      "Hi. Sorry to bother you, but I'm busy overwriting the entire disk "
+      "here. There's nothing to claim but the smoldering ruins of bytes "
+      "that were in flash memory. Trust me, it's nothing that you want. "
+      "All the best. Toodles!");
+  return DADissenterCreate(kCFAllocatorDefault, kDAReturnBusy, reason);
+}
+
+// static
+void DiskUnmounter::DiskUnmounted(DADiskRef disk,
+                                  DADissenterRef dissenter,
+                                  void* context) {
+  DiskUnmounter* disk_unmounter = static_cast<DiskUnmounter*>(context);
+
+  if (dissenter) {
+    LOG(ERROR) << "Unable to unmount disk.";
+    disk_unmounter->Error(error::kUnmountVolumes);
+    return;
+  }
+
+  disk_unmounter->original_thread_->PostTask(
+      FROM_HERE, disk_unmounter->unmount_continuation_closure_);
+}
+
+void DiskUnmounter::UnmountOnWorker(const std::string& device_path) {

[Robert Sesek, 2014/06/05 19:49:48]

DCHECK(cf_thread_.message_loop() == base::MessageLoop::current()) ? 

[Drew Haven, 2014/06/05 22:28:27]

That's reasonable.  It's a private method with a pretty obvious name though, so
unlikely to have a problem.  No harm in a check!

+  session_.reset(DASessionCreate(NULL));
+
+  DASessionScheduleWithRunLoop(
+      session_, CFRunLoopGetCurrent(), kCFRunLoopCommonModes);
+
+  disk_.reset(DADiskCreateFromBSDName(
+      kCFAllocatorDefault, session_, device_path.c_str()));
+
+  if (!disk_) {
+    LOG(ERROR) << "Unable to get disk reference.";
+    Error(error::kUnmountVolumes);
+    return;
+  }
+
+  DADiskClaim(disk_,
+              kDADiskClaimOptionDefault,
+              DiskClaimRevoked,
+              this,
+              DiskClaimed,
+              this);
+}
+
+// static
+scoped_ptr<base::MessagePump> DiskUnmounter::CreateMessagePump() {
+  return scoped_ptr<base::MessagePump>(new base::MessagePumpCFRunLoop);
+}
+
+void DiskUnmounter::Error(const std::string& message) {
+  original_thread_->PostTask(
+      FROM_HERE, base::Bind(&ImageWriter::Error, image_writer_, message));
+}
+
+bool ImageWriter::IsValidDevice() {

[Robert Sesek, 2014/06/05 19:49:48]

I've seen this function before?

[Drew Haven, 2014/06/05 22:28:27]

Yes! In fact I wanted to ask you about that.  I'm not sure where a good place to
put a common function that is platform-specific like this would be.  This
function is shared between the drive listing function
(chrome/browser/extensions) and the writing code (chrome/utility), since those
are separate API calls we need to be sure that the string actually passed to the
utility process for writing describes a valid disk.  The two can't import from
each other and I don't know what a good common location is.

[Robert Sesek, 2014/06/06 18:34:06]

//{chrome,content}/common is where files shared by multiple processes go. So how
about //chrome/common/extensions/...?

[Drew Haven, 2014/06/10 01:13:25]

I ended up adding a bunch of files over there so I could also move the
unit-test.  Let me know what you think.  I'm not sure if exposing it as just a
plain-old-function is the best way to go, but it seemed the simplest.

+  base::ScopedCFTypeRef<DASessionRef> session(DASessionCreate(NULL));
+  DADiskRef disk = DADiskCreateFromBSDName(
+      kCFAllocatorDefault, session, device_path_.value().c_str());
+
+  if (!disk)
+    return false;
+
+  base::ScopedCFTypeRef<CFDictionaryRef> dict(DADiskCopyDescription(disk));
+
+  CFBooleanRef internal = base::mac::GetValueFromDictionary<CFBooleanRef>(
+      dict, kDADiskDescriptionDeviceInternalKey);
+  CFStringRef protocol = base::mac::GetValueFromDictionary<CFStringRef>(
+      dict, kDADiskDescriptionDeviceProtocolKey);
+  CFStringRef io_reg_path = base::mac::GetValueFromDictionary<CFStringRef>(
+      dict, kDADiskDescriptionDevicePathKey);
+  CFBooleanRef ejectable = base::mac::GetValueFromDictionary<CFBooleanRef>(
+      dict, kDADiskDescriptionMediaEjectableKey);
+  CFBooleanRef removable = base::mac::GetValueFromDictionary<CFBooleanRef>(
+      dict, kDADiskDescriptionMediaRemovableKey);
+  CFBooleanRef whole = base::mac::GetValueFromDictionary<CFBooleanRef>(
+      dict, kDADiskDescriptionMediaWholeKey);
+  CFStringRef kind = base::mac::GetValueFromDictionary<CFStringRef>(
+      dict, kDADiskDescriptionMediaKindKey);
+
+  // A drive is a USB stick iff:
+  // - it is not internal
+  // - it is attached to the USB bus
+  // - it is ejectable (because it will be ejected after written to)
+  // - it is removable
+  // - it is the whole drive (although the use of
+  //   kDADiskDescriptionMatchMediaWhole should have ensured this)
+  // - it is of type IOMedia (external DVD drives and the like are IOCDMedia
+  // or
+  //   IODVDMedia)
+  bool is_usb_stick =
+      !CFBooleanGetValue(internal) &&
+      CFEqual(protocol, CFSTR(kIOPropertyPhysicalInterconnectTypeUSB)) &&
+      CFBooleanGetValue(ejectable) && CFBooleanGetValue(removable) &&
+      CFBooleanGetValue(whole) &&
+      CFStringCompare(kind, CFSTR("IOMedia"), 0) == kCFCompareEqualTo;
+
+  // A drive is an SD card iff:
+  // - it is attached to the USB bus
+  // - it is ejectable (because it will be ejected after written to)
+  // - it is removable
+  // - it is the whole drive (although the use of
+  //   kDADiskDescriptionMatchMediaWhole should have ensured this)
+  // - it is of type IOMedia (external DVD drives and the like are IOCDMedia
+  // or
+  //   IODVDMedia)
+  // - the IORegistry device path contains "AppleUSBCardReader"
+  bool is_sd_card =
+      CFEqual(protocol, CFSTR(kIOPropertyPhysicalInterconnectTypeUSB)) &&
+      CFBooleanGetValue(ejectable) && CFBooleanGetValue(removable) &&
+      CFBooleanGetValue(whole) &&
+      CFStringCompare(kind, CFSTR("IOMedia"), 0) == kCFCompareEqualTo &&
+      CFStringFind(io_reg_path, CFSTR("AppleUSBCardReader"), 0).location !=
+          kCFNotFound;
+
+  return is_usb_stick || is_sd_card;
+}
+
+void ImageWriter::UnmountVolumes(const base::Closure& continuation) {

[Robert Sesek, 2014/06/05 19:49:48]

These are for a different class…?

[Drew Haven, 2014/06/05 22:28:27]

It's like what I did for the RemovableStorageProvider class.

Basically, we have a bunch of shared logic and just a few functions that are
different.  The pattern I'd gotten used to for that was shared code in class.h
and class.cc and then implement the platform-specific functions in class_mac.cc,
class_win.cc, etc.

In this case I have a helper-class that is used only by one platform, so I
tossed it in image_writer_mac.h and image_writer_mac.cc (which also includes
image_writer.h platform-specific code).  I think perhaps I should just separate
this out into disk_unmounter_mac.h/cc.

[Robert Sesek, 2014/06/06 18:34:06]

Ah, I see. Yes, I'd not have an image_writer_mac.h and just an
image_writer_mac.cc instead, and then move the DiskUnmounter stuff to its own
file, which you did :).

[Drew Haven, 2014/06/10 01:13:25]

Done.

+  if (unmounter_ == NULL) {
+    unmounter_.reset(new DiskUnmounter(AsWeakPtr()));
+  }
+
+  unmounter_->Unmount(device_path_.value(), continuation);
+}
+
+bool ImageWriter::OpenDevice() {
+  int sockets[2];  // [parent's end, child's end]
+  int result = socketpair(AF_UNIX, SOCK_STREAM, 0, sockets);
+  if (result == -1) {
+    LOG(ERROR) << "Unable to allocate socket pair.";
+    return false;
+  }
+
+  char rdwr[10];
+  snprintf(rdwr, sizeof(rdwr), "%d", O_RDWR);
+
+  pid_t childPid = fork();
+  if (childPid == -1) {
+    LOG(ERROR) << "Fork failed.";
+    return false;
+  }
+
+  if (childPid == 0) {  // child
+    HANDLE_EINTR(dup2(sockets[1], STDOUT_FILENO));
+    close(sockets[0]);
+    close(sockets[1]);
+
+    base::FilePath real_device_path;
+    if (device_path_.IsAbsolute()) {
+      real_device_path = device_path_;
+    } else {
+      real_device_path = base::FilePath("/dev").Append(device_path_);
+    }
+
+    const char authopenPath[] = "/usr/libexec/authopen";
+    execl(authopenPath,
+          authopenPath,
+          "-stdoutpipe",
+          "-o",
+          rdwr,
+          real_device_path.value().c_str(),
+          NULL);
+    _exit(errno);
+  } else {  // parent
+    close(sockets[1]);
+    int fd = -1;
+
+    msghdr message = {0};
+    const size_t kDataBufferSize = 1024;
+    char dataBuffer[kDataBufferSize];
+    iovec ioVec[1];
+    ioVec[0].iov_base = dataBuffer;
+    ioVec[0].iov_len = kDataBufferSize;
+    message.msg_iov = ioVec;
+    message.msg_iovlen = 1;
+    const socklen_t kCmsgSocketSize = (socklen_t)CMSG_SPACE(sizeof(int));
+    char cmsgSocket[kCmsgSocketSize];
+    message.msg_control = cmsgSocket;
+    message.msg_controllen = kCmsgSocketSize;
+    ssize_t size = HANDLE_EINTR(recvmsg(sockets[0], &message, 0));
+    if (size > 0) {
+      cmsghdr* cmsgSocketHeader = CMSG_FIRSTHDR(&message);
+      // Paranoia.
+      if (cmsgSocketHeader && cmsgSocketHeader->cmsg_level == SOL_SOCKET &&
+          cmsgSocketHeader->cmsg_type == SCM_RIGHTS)
+        fd = *((int*)CMSG_DATA(cmsgSocketHeader));
+    }
+
+    int childStat;
+    result = HANDLE_EINTR(waitpid(childPid, &childStat, 0));
+    close(sockets[0]);
+
+    if (result != -1 && WIFEXITED(childStat)) {
+      int exitStatus = WEXITSTATUS(childStat);
+      if (exitStatus) {
+        LOG(ERROR) << "Child process returned failure.";
+        return false;
+      }
+    }
+
+    device_file_ = base::File(fd);
+
+    return device_file_.IsValid();
+  }
+}
+
+}  // namespace image_writer