blob: 96c87324f9f1cfdd5fc7e5e29ddf6e6c1547481f [file] [log] [blame]
// Copyright (c) 2011 The Chromium OS Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef DISK_MANAGER_H__
#define DISK_MANAGER_H__
#include <blkid/blkid.h>
#include <libudev.h>
#include <sys/types.h>
#include <iostream>
#include <map>
#include <string>
#include <vector>
namespace cros_disks {
class Disk;
// The DiskManager is responsible for reading device state from udev.
// Said changes could be the result of a udev notification or a synchronous
// call to enumerate the relevant storage devices attached to the system.
// Sample Usage:
// DiskManager manager;
// manager.EnumerateDisks();
// select(manager.udev_monitor_fd())...
// This class is designed to run within a single-threaded GMainLoop application
// and should not be considered thread safe.
class DiskManager {
virtual ~DiskManager();
// Lists the current block devices attached to the system.
virtual std::vector<Disk> EnumerateDisks() const;
// Reads the changes from udev. Must be called to clear the
// fd.
bool ProcessUdevChanges(std::string *device_path, std::string *action);
// Gets a device file from the cache mapping from sysfs path to device file.
std::string GetDeviceFileFromCache(const std::string& device_path) const;
// Gets the filesystem type of a device.
std::string GetFilesystemTypeOfDevice(const std::string& device_path);
// Gets a Disk object that corresponds to a given device file.
bool GetDiskByDevicePath(const std::string& device_path, Disk *disk) const;
// Gets the list of filesystems available on the system, except for those
// marked as nodev, by reading /proc/filesystems.
std::vector<std::string> GetFilesystems() const;
// Gets the list of filesystems available on the system, except for those
// marked as nodev, by reading a stream, which follows the same format as
// /proc/filesystems.
std::vector<std::string> GetFilesystems(std::istream& stream) const;
// Checks if a filesystem supports user ID and group ID in mount options.
bool IsMountUserAndGroupIdSupportedByFilesystem(
const std::string& filesystem_type) const;
// Gets the user ID and group ID for a given username.
bool GetUserAndGroupId(const std::string& username,
uid_t *uid, gid_t *gid) const;
// Gets the mount directory name for a disk.
std::string GetMountDirectoryName(const Disk& disk) const;
// Creates a mount directory for a given disk.
std::string CreateMountDirectory(const Disk& disk,
const std::string& target_path) const;
// Sanitizes an array of mount options based on the properties of a disk.
std::vector<std::string> SanitizeMountOptions(
const std::vector<std::string>& options, const Disk& disk) const;
// Modifies mount options for a filesystem type.
std::string ModifyMountOptionsForFilesystem(
const std::string& filesystem_type, const std::string& options) const;
// Extracts mount flags and data for Mount() from an array of options.
bool ExtractMountOptions(const std::vector<std::string>& options,
unsigned long *mount_flags, std::string *mount_data) const;
// Extracts unmount flags for Unmount() from an array of options.
bool ExtractUnmountOptions(const std::vector<std::string>& options,
int *unmount_flags) const;
// Calls the low-level mount function to mount a device file.
bool DoMount(const std::string& device_file,
const std::string& mount_path, const std::string& filesystem_type,
unsigned long mount_flags, const std::string& mount_data) const;
// Mounts a given disk.
bool Mount(const std::string& device_path,
const std::string& filesystem_type,
const std::vector<std::string>& options,
std::string *mount_path);
// Unmounts a given device path.
bool Unmount(const std::string& device_path,
const std::vector<std::string>& options);
// A file descriptor that can be select()ed or poll()ed for system changes.
int udev_monitor_fd() const { return udev_monitor_fd_; }
// The root udev object.
mutable struct udev* udev_;
// Provides access to udev changes as they occur.
struct udev_monitor* udev_monitor_;
// A file descriptor that indicates changes to the system.
int udev_monitor_fd_;
// blkid_cache object.
blkid_cache blkid_cache_;
// A cache mapping device sysfs path to device file.
std::map<std::string, std::string> device_file_map_;
} // namespace cros_disks
#endif // DISK_MANAGER_H__