components/storage_monitor/storage_monitor_linux.cc

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 // StorageMonitorLinux implementation.
   6
   7 #include "components/storage_monitor/storage_monitor_linux.h"
   8
   9 #include <mntent.h>
  10 #include <stdio.h>
  11
  12 #include <list>
  13
  14 #include "base/basictypes.h"
  15 #include "base/bind.h"
  16 #include "base/metrics/histogram.h"
  17 #include "base/process/kill.h"
  18 #include "base/process/launch.h"
  19 #include "base/process/process.h"
  20 #include "base/stl_util.h"
  21 #include "base/strings/string_number_conversions.h"
  22 #include "base/strings/string_util.h"
  23 #include "base/strings/utf_string_conversions.h"
  24 #include "components/storage_monitor/media_storage_util.h"
  25 #include "components/storage_monitor/media_transfer_protocol_device_observer_linux.h"
  26 #include "components/storage_monitor/removable_device_constants.h"
  27 #include "components/storage_monitor/storage_info.h"
  28 #include "components/storage_monitor/udev_util_linux.h"
  29 #include "device/media_transfer_protocol/media_transfer_protocol_manager.h"
  30 #include "device/udev_linux/scoped_udev.h"
  31
  32 using content::BrowserThread;
  33
  34 namespace storage_monitor {
  35
  36 typedef MtabWatcherLinux::MountPointDeviceMap MountPointDeviceMap;
  37
  38 namespace {
  39
  40 // udev device property constants.
  41 const char kBlockSubsystemKey[] = "block";
  42 const char kDiskDeviceTypeKey[] = "disk";
  43 const char kFsUUID[] = "ID_FS_UUID";
  44 const char kLabel[] = "ID_FS_LABEL";
  45 const char kModel[] = "ID_MODEL";
  46 const char kModelID[] = "ID_MODEL_ID";
  47 const char kRemovableSysAttr[] = "removable";
  48 const char kSerialShort[] = "ID_SERIAL_SHORT";
  49 const char kSizeSysAttr[] = "size";
  50 const char kVendor[] = "ID_VENDOR";
  51 const char kVendorID[] = "ID_VENDOR_ID";
  52
  53 // Construct a device id using label or manufacturer (vendor and model) details.
  54 std::string MakeDeviceUniqueId(struct udev_device* device) {
  55   std::string uuid = device::UdevDeviceGetPropertyValue(device, kFsUUID);
  56   // Keep track of device uuid, to see how often we receive empty uuid values.
  57   UMA_HISTOGRAM_BOOLEAN(
  58       "RemovableDeviceNotificationsLinux.device_file_system_uuid_available",
  59       !uuid.empty());
  60
  61   if (!uuid.empty())
  62     return kFSUniqueIdPrefix + uuid;
  63
  64   // If one of the vendor, model, serial information is missing, its value
  65   // in the string is empty.
  66   // Format: VendorModelSerial:VendorInfo:ModelInfo:SerialShortInfo
  67   // E.g.: VendorModelSerial:Kn:DataTravel_12.10:8000000000006CB02CDB
  68   std::string vendor = device::UdevDeviceGetPropertyValue(device, kVendorID);
  69   std::string model = device::UdevDeviceGetPropertyValue(device, kModelID);
  70   std::string serial_short =
  71       device::UdevDeviceGetPropertyValue(device, kSerialShort);
  72   if (vendor.empty() && model.empty() && serial_short.empty())
  73     return std::string();
  74
  75   return kVendorModelSerialPrefix + vendor + ":" + model + ":" + serial_short;
  76 }
  77
  78 // Records GetDeviceInfo result on destruction, to see how often we fail to get
  79 // device details.
  80 class ScopedGetDeviceInfoResultRecorder {
  81  public:
  82   ScopedGetDeviceInfoResultRecorder() : result_(false) {}
  83   ~ScopedGetDeviceInfoResultRecorder() {
  84     UMA_HISTOGRAM_BOOLEAN("MediaDeviceNotification.UdevRequestSuccess",
  85                           result_);
  86   }
  87
  88   void set_result(bool result) {
  89     result_ = result;
  90   }
  91
  92  private:
  93   bool result_;
  94
  95   DISALLOW_COPY_AND_ASSIGN(ScopedGetDeviceInfoResultRecorder);
  96 };
  97
  98 // Returns the storage partition size of the device specified by |device_path|.
  99 // If the requested information is unavailable, returns 0.
 100 uint64 GetDeviceStorageSize(const base::FilePath& device_path,
 101                             struct udev_device* device) {
 102   // sysfs provides the device size in units of 512-byte blocks.
 103   const std::string partition_size =
 104       device::UdevDeviceGetSysattrValue(device, kSizeSysAttr);
 105
 106   // Keep track of device size, to see how often this information is
 107   // unavailable.
 108   UMA_HISTOGRAM_BOOLEAN(
 109       "RemovableDeviceNotificationsLinux.device_partition_size_available",
 110       !partition_size.empty());
 111
 112   uint64 total_size_in_bytes = 0;
 113   if (!base::StringToUint64(partition_size, &total_size_in_bytes))
 114     return 0;
 115   return (total_size_in_bytes <= kuint64max / 512) ?
 116       total_size_in_bytes * 512 : 0;
 117 }
 118
 119 // Gets the device information using udev library.
 120 scoped_ptr<StorageInfo> GetDeviceInfo(const base::FilePath& device_path,
 121                                       const base::FilePath& mount_point) {
 122   DCHECK_CURRENTLY_ON(BrowserThread::FILE);
 123   DCHECK(!device_path.empty());
 124
 125   scoped_ptr<StorageInfo> storage_info;
 126
 127   ScopedGetDeviceInfoResultRecorder results_recorder;
 128
 129   device::ScopedUdevPtr udev_obj(device::udev_new());
 130   if (!udev_obj.get())
 131     return storage_info.Pass();
 132
 133   struct stat device_stat;
 134   if (stat(device_path.value().c_str(), &device_stat) < 0)
 135     return storage_info.Pass();
 136
 137   char device_type;
 138   if (S_ISCHR(device_stat.st_mode))
 139     device_type = 'c';
 140   else if (S_ISBLK(device_stat.st_mode))
 141     device_type = 'b';
 142   else
 143     return storage_info.Pass();  // Not a supported type.
 144
 145   device::ScopedUdevDevicePtr device(
 146       device::udev_device_new_from_devnum(udev_obj.get(), device_type,
 147                                           device_stat.st_rdev));
 148   if (!device.get())
 149     return storage_info.Pass();
 150
 151   base::string16 volume_label = base::UTF8ToUTF16(
 152       device::UdevDeviceGetPropertyValue(device.get(), kLabel));
 153   base::string16 vendor_name = base::UTF8ToUTF16(
 154       device::UdevDeviceGetPropertyValue(device.get(), kVendor));
 155   base::string16 model_name = base::UTF8ToUTF16(
 156       device::UdevDeviceGetPropertyValue(device.get(), kModel));
 157
 158   std::string unique_id = MakeDeviceUniqueId(device.get());
 159
 160   // Keep track of device info details to see how often we get invalid values.
 161   MediaStorageUtil::RecordDeviceInfoHistogram(true, unique_id, volume_label);
 162
 163   const char* value =
 164       device::udev_device_get_sysattr_value(device.get(), kRemovableSysAttr);
 165   if (!value) {
 166     // |parent_device| is owned by |device| and does not need to be cleaned
 167     // up.
 168     struct udev_device* parent_device =
 169         device::udev_device_get_parent_with_subsystem_devtype(
 170             device.get(),
 171             kBlockSubsystemKey,
 172             kDiskDeviceTypeKey);
 173     value = device::udev_device_get_sysattr_value(parent_device,
 174                                                   kRemovableSysAttr);
 175   }
 176   const bool is_removable = (value && atoi(value) == 1);
 177
 178   StorageInfo::Type type = StorageInfo::FIXED_MASS_STORAGE;
 179   if (is_removable) {
 180     if (MediaStorageUtil::HasDcim(mount_point))
 181       type = StorageInfo::REMOVABLE_MASS_STORAGE_WITH_DCIM;
 182     else
 183       type = StorageInfo::REMOVABLE_MASS_STORAGE_NO_DCIM;
 184   }
 185
 186   results_recorder.set_result(true);
 187
 188   storage_info.reset(new StorageInfo(
 189       StorageInfo::MakeDeviceId(type, unique_id),
 190       mount_point.value(),
 191       volume_label,
 192       vendor_name,
 193       model_name,
 194       GetDeviceStorageSize(device_path, device.get())));
 195   return storage_info.Pass();
 196 }
 197
 198 MtabWatcherLinux* CreateMtabWatcherLinuxOnFileThread(
 199     const base::FilePath& mtab_path,
 200     base::WeakPtr<MtabWatcherLinux::Delegate> delegate) {
 201   DCHECK_CURRENTLY_ON(BrowserThread::FILE);
 202   // Owned by caller.
 203   return new MtabWatcherLinux(mtab_path, delegate);
 204 }
 205
 206 StorageMonitor::EjectStatus EjectPathOnFileThread(
 207     const base::FilePath& path,
 208     const base::FilePath& device) {
 209   DCHECK_CURRENTLY_ON(BrowserThread::FILE);
 210
 211   // Note: Linux LSB says umount should exist in /bin.
 212   static const char kUmountBinary[] = "/bin/umount";
 213   std::vector<std::string> command;
 214   command.push_back(kUmountBinary);
 215   command.push_back(path.value());
 216
 217   base::LaunchOptions options;
 218   base::Process process = base::LaunchProcess(command, options);
 219   if (!process.IsValid())
 220     return StorageMonitor::EJECT_FAILURE;
 221
 222   int exit_code = -1;
 223   if (!process.WaitForExitWithTimeout(base::TimeDelta::FromMilliseconds(3000),
 224                                       &exit_code)) {
 225     process.Terminate(-1, false);
 226     base::EnsureProcessTerminated(process.Pass());
 227     return StorageMonitor::EJECT_FAILURE;
 228   }
 229
 230   // TODO(gbillock): Make sure this is found in documentation
 231   // somewhere. Experimentally it seems to hold that exit code
 232   // 1 means device is in use.
 233   if (exit_code == 1)
 234     return StorageMonitor::EJECT_IN_USE;
 235   if (exit_code != 0)
 236     return StorageMonitor::EJECT_FAILURE;
 237
 238   return StorageMonitor::EJECT_OK;
 239 }
 240
 241 }  // namespace
 242
 243 StorageMonitorLinux::StorageMonitorLinux(const base::FilePath& path)
 244     : mtab_path_(path),
 245       get_device_info_callback_(base::Bind(&GetDeviceInfo)),
 246       weak_ptr_factory_(this) {
 247   DCHECK_CURRENTLY_ON(BrowserThread::UI);
 248 }
 249
 250 StorageMonitorLinux::~StorageMonitorLinux() {
 251   DCHECK_CURRENTLY_ON(BrowserThread::UI);
 252 }
 253
 254 void StorageMonitorLinux::Init() {
 255   DCHECK(!mtab_path_.empty());
 256
 257   BrowserThread::PostTaskAndReplyWithResult(
 258       BrowserThread::FILE, FROM_HERE,
 259       base::Bind(&CreateMtabWatcherLinuxOnFileThread,
 260                  mtab_path_,
 261                  weak_ptr_factory_.GetWeakPtr()),
 262       base::Bind(&StorageMonitorLinux::OnMtabWatcherCreated,
 263                  weak_ptr_factory_.GetWeakPtr()));
 264
 265   if (!media_transfer_protocol_manager_) {
 266     media_transfer_protocol_manager_.reset(
 267         device::MediaTransferProtocolManager::Initialize(
 268             BrowserThread::GetMessageLoopProxyForThread(BrowserThread::FILE)));
 269   }
 270
 271   media_transfer_protocol_device_observer_.reset(
 272       new MediaTransferProtocolDeviceObserverLinux(
 273           receiver(), media_transfer_protocol_manager_.get()));
 274 }
 275
 276 bool StorageMonitorLinux::GetStorageInfoForPath(
 277     const base::FilePath& path,
 278     StorageInfo* device_info) const {
 279   DCHECK(device_info);
 280   DCHECK_CURRENTLY_ON(BrowserThread::UI);
 281
 282   // TODO(thestig) |media_transfer_protocol_device_observer_| should always be
 283   // valid.
 284   if (media_transfer_protocol_device_observer_ &&
 285       media_transfer_protocol_device_observer_->GetStorageInfoForPath(
 286           path, device_info)) {
 287     return true;
 288   }
 289
 290   if (!path.IsAbsolute())
 291     return false;
 292
 293   base::FilePath current = path;
 294   while (!ContainsKey(mount_info_map_, current) && current != current.DirName())
 295     current = current.DirName();
 296
 297   MountMap::const_iterator mount_info = mount_info_map_.find(current);
 298   if (mount_info == mount_info_map_.end())
 299     return false;
 300   *device_info = mount_info->second.storage_info;
 301   return true;
 302 }
 303
 304 device::MediaTransferProtocolManager*
 305 StorageMonitorLinux::media_transfer_protocol_manager() {
 306   return media_transfer_protocol_manager_.get();
 307 }
 308
 309 void StorageMonitorLinux::SetGetDeviceInfoCallbackForTest(
 310     const GetDeviceInfoCallback& get_device_info_callback) {
 311   get_device_info_callback_ = get_device_info_callback;
 312 }
 313
 314 void StorageMonitorLinux::SetMediaTransferProtocolManagerForTest(
 315     device::MediaTransferProtocolManager* test_manager) {
 316   DCHECK(!media_transfer_protocol_manager_);
 317   media_transfer_protocol_manager_.reset(test_manager);
 318 }
 319
 320 void StorageMonitorLinux::EjectDevice(
 321     const std::string& device_id,
 322     base::Callback<void(EjectStatus)> callback) {
 323   StorageInfo::Type type;
 324   if (!StorageInfo::CrackDeviceId(device_id, &type, NULL)) {
 325     callback.Run(EJECT_FAILURE);
 326     return;
 327   }
 328
 329   if (type == StorageInfo::MTP_OR_PTP) {
 330     media_transfer_protocol_device_observer_->EjectDevice(device_id, callback);
 331     return;
 332   }
 333
 334   // Find the mount point for the given device ID.
 335   base::FilePath path;
 336   base::FilePath device;
 337   for (MountMap::iterator mount_info = mount_info_map_.begin();
 338        mount_info != mount_info_map_.end(); ++mount_info) {
 339     if (mount_info->second.storage_info.device_id() == device_id) {
 340       path = mount_info->first;
 341       device = mount_info->second.mount_device;
 342       mount_info_map_.erase(mount_info);
 343       break;
 344     }
 345   }
 346
 347   if (path.empty()) {
 348     callback.Run(EJECT_NO_SUCH_DEVICE);
 349     return;
 350   }
 351
 352   receiver()->ProcessDetach(device_id);
 353
 354   BrowserThread::PostTaskAndReplyWithResult(
 355       BrowserThread::FILE, FROM_HERE,
 356       base::Bind(&EjectPathOnFileThread, path, device),
 357       callback);
 358 }
 359
 360 void StorageMonitorLinux::OnMtabWatcherCreated(MtabWatcherLinux* watcher) {
 361   DCHECK_CURRENTLY_ON(BrowserThread::UI);
 362   mtab_watcher_.reset(watcher);
 363 }
 364
 365 void StorageMonitorLinux::UpdateMtab(const MountPointDeviceMap& new_mtab) {
 366   DCHECK_CURRENTLY_ON(BrowserThread::UI);
 367
 368   // Check existing mtab entries for unaccounted mount points.
 369   // These mount points must have been removed in the new mtab.
 370   std::list<base::FilePath> mount_points_to_erase;
 371   std::list<base::FilePath> multiple_mounted_devices_needing_reattachment;
 372   for (MountMap::const_iterator old_iter = mount_info_map_.begin();
 373        old_iter != mount_info_map_.end(); ++old_iter) {
 374     const base::FilePath& mount_point = old_iter->first;
 375     const base::FilePath& mount_device = old_iter->second.mount_device;
 376     MountPointDeviceMap::const_iterator new_iter = new_mtab.find(mount_point);
 377     // |mount_point| not in |new_mtab| or |mount_device| is no longer mounted at
 378     // |mount_point|.
 379     if (new_iter == new_mtab.end() || (new_iter->second != mount_device)) {
 380       MountPriorityMap::iterator priority =
 381           mount_priority_map_.find(mount_device);
 382       DCHECK(priority != mount_priority_map_.end());
 383       ReferencedMountPoint::const_iterator has_priority =
 384           priority->second.find(mount_point);
 385       if (StorageInfo::IsRemovableDevice(
 386               old_iter->second.storage_info.device_id())) {
 387         DCHECK(has_priority != priority->second.end());
 388         if (has_priority->second) {
 389           receiver()->ProcessDetach(old_iter->second.storage_info.device_id());
 390         }
 391         if (priority->second.size() > 1)
 392           multiple_mounted_devices_needing_reattachment.push_back(mount_device);
 393       }
 394       priority->second.erase(mount_point);
 395       if (priority->second.empty())
 396         mount_priority_map_.erase(mount_device);
 397       mount_points_to_erase.push_back(mount_point);
 398     }
 399   }
 400
 401   // Erase the |mount_info_map_| entries afterwards. Erasing in the loop above
 402   // using the iterator is slightly more efficient, but more tricky, since
 403   // calling std::map::erase() on an iterator invalidates it.
 404   for (std::list<base::FilePath>::const_iterator it =
 405            mount_points_to_erase.begin();
 406        it != mount_points_to_erase.end();
 407        ++it) {
 408     mount_info_map_.erase(*it);
 409   }
 410
 411   // For any multiply mounted device where the mount that we had notified
 412   // got detached, send a notification of attachment for one of the other
 413   // mount points.
 414   for (std::list<base::FilePath>::const_iterator it =
 415            multiple_mounted_devices_needing_reattachment.begin();
 416        it != multiple_mounted_devices_needing_reattachment.end();
 417        ++it) {
 418     ReferencedMountPoint::iterator first_mount_point_info =
 419         mount_priority_map_.find(*it)->second.begin();
 420     const base::FilePath& mount_point = first_mount_point_info->first;
 421     first_mount_point_info->second = true;
 422
 423     const StorageInfo& mount_info =
 424         mount_info_map_.find(mount_point)->second.storage_info;
 425     DCHECK(StorageInfo::IsRemovableDevice(mount_info.device_id()));
 426     receiver()->ProcessAttach(mount_info);
 427   }
 428
 429   // Check new mtab entries against existing ones.
 430   for (MountPointDeviceMap::const_iterator new_iter = new_mtab.begin();
 431        new_iter != new_mtab.end(); ++new_iter) {
 432     const base::FilePath& mount_point = new_iter->first;
 433     const base::FilePath& mount_device = new_iter->second;
 434     MountMap::iterator old_iter = mount_info_map_.find(mount_point);
 435     if (old_iter == mount_info_map_.end() ||
 436         old_iter->second.mount_device != mount_device) {
 437       // New mount point found or an existing mount point found with a new
 438       // device.
 439       if (IsDeviceAlreadyMounted(mount_device)) {
 440         HandleDeviceMountedMultipleTimes(mount_device, mount_point);
 441       } else {
 442         BrowserThread::PostTaskAndReplyWithResult(
 443             BrowserThread::FILE, FROM_HERE,
 444             base::Bind(get_device_info_callback_, mount_device, mount_point),
 445             base::Bind(&StorageMonitorLinux::AddNewMount,
 446                        weak_ptr_factory_.GetWeakPtr(),
 447                        mount_device));
 448       }
 449     }
 450   }
 451
 452   // Note: relies on scheduled tasks on the file thread being sequential. This
 453   // block needs to follow the for loop, so that the DoNothing call on the FILE
 454   // thread happens after the scheduled metadata retrievals, meaning that the
 455   // reply callback will then happen after all the AddNewMount calls.
 456   if (!IsInitialized()) {
 457     BrowserThread::PostTaskAndReply(
 458         BrowserThread::FILE, FROM_HERE,
 459         base::Bind(&base::DoNothing),
 460         base::Bind(&StorageMonitorLinux::MarkInitialized,
 461                    weak_ptr_factory_.GetWeakPtr()));
 462   }
 463 }
 464
 465 bool StorageMonitorLinux::IsDeviceAlreadyMounted(
 466     const base::FilePath& mount_device) const {
 467   DCHECK_CURRENTLY_ON(BrowserThread::UI);
 468   return ContainsKey(mount_priority_map_, mount_device);
 469 }
 470
 471 void StorageMonitorLinux::HandleDeviceMountedMultipleTimes(
 472     const base::FilePath& mount_device,
 473     const base::FilePath& mount_point) {
 474   DCHECK_CURRENTLY_ON(BrowserThread::UI);
 475
 476   MountPriorityMap::iterator priority = mount_priority_map_.find(mount_device);
 477   DCHECK(priority != mount_priority_map_.end());
 478   const base::FilePath& other_mount_point = priority->second.begin()->first;
 479   priority->second[mount_point] = false;
 480   mount_info_map_[mount_point] =
 481       mount_info_map_.find(other_mount_point)->second;
 482 }
 483
 484 void StorageMonitorLinux::AddNewMount(const base::FilePath& mount_device,
 485                                       scoped_ptr<StorageInfo> storage_info) {
 486   DCHECK_CURRENTLY_ON(BrowserThread::UI);
 487
 488   if (!storage_info)
 489     return;
 490
 491   DCHECK(!storage_info->device_id().empty());
 492
 493   bool removable = StorageInfo::IsRemovableDevice(storage_info->device_id());
 494   const base::FilePath mount_point(storage_info->location());
 495
 496   MountPointInfo mount_point_info;
 497   mount_point_info.mount_device = mount_device;
 498   mount_point_info.storage_info = *storage_info;
 499   mount_info_map_[mount_point] = mount_point_info;
 500   mount_priority_map_[mount_device][mount_point] = removable;
 501   receiver()->ProcessAttach(*storage_info);
 502 }
 503
 504 StorageMonitor* StorageMonitor::CreateInternal() {
 505   const base::FilePath kDefaultMtabPath("/etc/mtab");
 506   return new StorageMonitorLinux(kDefaultMtabPath);
 507 }
 508
 509 }  // namespace storage_monitor