blob: 80a551a770c93b954e7a6ca7a0877751e49e58f1 [file] [log] [blame]
# Copyright (c) 2012 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.
"""Common file and os related utilities, including tempdir manipulation."""
from __future__ import print_function
import collections
import contextlib
import cStringIO
import ctypes
import ctypes.util
import datetime
import errno
import logging
import operator
import os
import pwd
import re
import shutil
import tempfile
from chromite.lib import cros_build_lib
from chromite.lib import retry_util
# Env vars that tempdir can be gotten from; minimally, this
# needs to match python's tempfile module and match normal
# unix standards.
def GetNonRootUser():
"""Returns a non-root user. Defaults to the current user.
If the current user is root, returns the username of the person who
ran the emerge command. If running using sudo, returns the username
of the person who ran the sudo command. If no non-root user is
found, returns None.
uid = os.getuid()
if uid == 0:
user = os.environ.get('PORTAGE_USERNAME', os.environ.get('SUDO_USER'))
user = pwd.getpwuid(os.getuid()).pw_name
if user == 'root':
return None
return user
def ExpandPath(path):
"""Returns path after passing through realpath and expanduser."""
return os.path.realpath(os.path.expanduser(path))
def WriteFile(path, content, mode='w', atomic=False, makedirs=False):
"""Write the given content to disk.
path: Pathway to write the content to.
content: Content to write. May be either an iterable, or a string.
mode: Optional; if binary mode is necessary, pass 'wb'. If appending is
desired, 'w+', etc.
atomic: If the updating of the file should be done atomically. Note this
option is incompatible w/ append mode.
makedirs: If True, create missing leading directories in the path.
write_path = path
if atomic:
write_path = path + '.tmp'
if makedirs:
with open(write_path, mode) as f:
if not atomic:
os.rename(write_path, path)
except EnvironmentError:
def Touch(path, makedirs=False, mode=None):
"""Simulate unix touch. Create if doesn't exist and update its timestamp.
path: a string, file name of the file to touch (creating if not present).
makedirs: If True, create missing leading directories in the path.
mode: The access permissions to set. In the style of chmod. Defaults to
using the umask.
if makedirs:
# Create the file if nonexistant.
open(path, 'a').close()
if mode is not None:
os.chmod(path, mode)
# Update timestamp to right now.
os.utime(path, None)
def ReadFile(path, mode='r'):
"""Read a given file on disk. Primarily useful for one off small files."""
with open(path, mode) as f:
def SafeUnlink(path, sudo=False):
"""Unlink a file from disk, ignoring if it doesn't exist.
True if the file existed and was removed, False if it didn't exist.
if sudo:
['rm', '--', path], print_cmd=False, redirect_stderr=True)
return True
except cros_build_lib.RunCommandError:
if os.path.exists(path):
# Technically racey, but oh well; very hard to actually hit...
return False
return True
except EnvironmentError as e:
if e.errno != errno.ENOENT:
return False
def SafeMakedirs(path, mode=0o775, sudo=False, user='root'):
"""Make parent directories if needed. Ignore if existing.
path: The path to create. Intermediate directories will be created as
mode: The access permissions in the style of chmod.
sudo: If True, create it via sudo, thus root owned.
user: If |sudo| is True, run sudo as |user|.
True if the directory had to be created, False if otherwise.
EnvironmentError: if the makedir failed and it was non sudo.
RunCommandError: If sudo mode, and the command failed for any reason.
if sudo:
if os.path.isdir(path):
return False
['mkdir', '-p', '--mode', oct(mode), path], user=user, print_cmd=False,
redirect_stderr=True, redirect_stdout=True)
return True
os.makedirs(path, mode)
return True
except EnvironmentError as e:
if e.errno != errno.EEXIST or not os.path.isdir(path):
return False
class MakingDirsAsRoot(Exception):
"""Raised when creating directories as root."""
def SafeMakedirsNonRoot(path, mode=0o775, user=None):
"""Create directories and make sure they are not owned by root.
See SafeMakedirs for the arguments and returns.
if user is None:
user = GetNonRootUser()
if user is None or user == 'root':
raise MakingDirsAsRoot('Refusing to create %s as root!' % path)
created = SafeMakedirs(path, mode=mode, user=user)
# Temporary fix: if the directory already exists and is owned by
# root, chown it. This corrects existing root-owned directories.
if not created:
stat_info = os.stat(path)
if stat_info.st_uid == 0:
cros_build_lib.SudoRunCommand(['chown', user, path],
return created
def RmDir(path, ignore_missing=False, sudo=False):
"""Recursively remove a directory.
path: Path of directory to remove.
ignore_missing: Do not error when path does not exist.
sudo: Remove directories as root.
if sudo:
['rm', '-r%s' % ('f' if ignore_missing else '',), '--', path],
redirect_stdout=True, redirect_stderr=True)
except cros_build_lib.RunCommandError as e:
if not ignore_missing or os.path.exists(path):
# If we're not ignoring the rm ENOENT equivalent, throw it;
# if the pathway still exists, something failed, thus throw it.
except EnvironmentError as e:
if not ignore_missing or e.errno != errno.ENOENT:
def Which(binary, path=None, mode=os.X_OK):
"""Return the absolute path to the specified binary.
binary: The binary to look for.
path: Search path. Defaults to os.environ['PATH'].
mode: File mode to check on the binary.
The full path to |binary| if found (with the right mode). Otherwise, None.
if path is None:
path = os.environ.get('PATH', '')
for p in path.split(os.pathsep):
p = os.path.join(p, binary)
if os.path.isfile(p) and os.access(p, mode):
return p
return None
def FindMissingBinaries(needed_tools):
"""Verifies that the required tools are present on the system.
This is especially important for scripts that are intended to run
outside the chroot.
needed_tools: an array of string specified binaries to look for.
If all tools are found, returns the empty list. Otherwise, returns the
list of missing tools.
return [binary for binary in needed_tools if Which(binary) is None]
def DirectoryIterator(base_path):
"""Iterates through the files and subdirs of a directory."""
for root, dirs, files in os.walk(base_path):
for e in [d + os.sep for d in dirs] + files:
yield os.path.join(root, e)
def IteratePathParents(start_path):
"""Generator that iterates through a directory's parents.
start_path: The path to start from.
The passed-in path, along with its parents. i.e.,
IteratePathParents('/usr/local') would yield '/usr/local', '/usr/', and '/'.
path = os.path.abspath(start_path)
yield path
while path.strip('/'):
path = os.path.dirname(path)
yield path
def FindInPathParents(path_to_find, start_path, test_func=None):
"""Look for a relative path, ascending through parent directories.
Ascend through parent directories of current path looking for a relative
path. I.e., given a directory structure like:
the call FindInPathParents('bin', '/usr/local') would return '/usr/bin', and
the call FindInPathParents('google', '/usr/local') would return
path_to_find: The relative path to look for.
start_path: The path to start the search from. If |start_path| is a
directory, it will be included in the directories that are searched.
test_func: The function to use to verify the relative path. Defaults to
os.path.exists. The function will be passed one argument - the target
path to test. A True return value will cause AscendingLookup to return
the target.
if test_func is None:
test_func = os.path.exists
for path in IteratePathParents(start_path):
target = os.path.join(path, path_to_find)
if test_func(target):
return target
return None
# pylint: disable=W0212,R0904,W0702
def SetGlobalTempDir(tempdir_value, tempdir_env=None):
"""Set the global temp directory to the specified |tempdir_value|
tempdir_value: The new location for the global temp directory.
tempdir_env: Optional. A list of key/value pairs to set in the
environment. If not provided, set all global tempdir environment
variables to point at |tempdir_value|.
Returns (old_tempdir_value, old_tempdir_env).
old_tempdir_value: The old value of the global temp directory.
old_tempdir_env: A list of the key/value pairs that control the tempdir
environment and were set prior to this function. If the environment
variable was not set, it is recorded as None.
with tempfile._once_lock:
old_tempdir_value = tempfile._get_default_tempdir()
old_tempdir_env = tuple((x, os.environ.get(x)) for x in _TEMPDIR_ENV_VARS)
# Now update TMPDIR/TEMP/TMP, and poke the python
# internals to ensure all subprocess/raw tempfile
# access goes into this location.
if tempdir_env is None:
os.environ.update((x, tempdir_value) for x in _TEMPDIR_ENV_VARS)
for key, value in tempdir_env:
if value is None:
os.environ.pop(key, None)
os.environ[key] = value
# Finally, adjust python's cached value (we know it's cached by here
# since we invoked _get_default_tempdir from above). Note this
# is necessary since we want *all* output from that point
# forward to go to this location.
tempfile.tempdir = tempdir_value
return (old_tempdir_value, old_tempdir_env)
def _TempDirSetup(self, prefix='tmp', set_global=False, base_dir=None):
"""Generate a tempdir, modifying the object, and env to use it.
Specifically, if set_global is True, then from this invocation forward,
python and all subprocesses will use this location for their tempdir.
The matching _TempDirTearDown restores the env to what it was.
# Stash the old tempdir that was used so we can
# switch it back on the way out.
self.tempdir = tempfile.mkdtemp(prefix=prefix, dir=base_dir)
os.chmod(self.tempdir, 0o700)
if set_global:
self._orig_tempdir_value, self._orig_tempdir_env = \
def _TempDirTearDown(self, force_sudo):
# Note that _TempDirSetup may have failed, resulting in these attributes
# not being set; this is why we use getattr here (and must).
tempdir = getattr(self, 'tempdir', None)
if tempdir is not None:
RmDir(tempdir, ignore_missing=True, sudo=force_sudo)
except EnvironmentError as e:
# Suppress ENOENT since we may be invoked
# in a context where parallel wipes of the tempdir
# may be occuring; primarily during hard shutdowns.
if e.errno != errno.ENOENT:
# Restore environment modification if necessary.
orig_tempdir_value = getattr(self, '_orig_tempdir_value', None)
if orig_tempdir_value is not None:
SetGlobalTempDir(orig_tempdir_value, self._orig_tempdir_env)
class TempDir(object):
"""Object that creates a temporary directory.
This object can either be used as a context manager or just as a simple
object. The temporary directory is stored as self.tempdir in the object, and
is returned as a string by a 'with' statement.
def __init__(self, **kwargs):
"""Constructor. Creates the temporary directory.
prefix: See tempfile.mkdtemp documentation.
base_dir: The directory to place the temporary directory.
set_global: Set this directory as the global temporary directory.
storage: The object that will have its 'tempdir' attribute set.
sudo_rm: Whether the temporary dir will need root privileges to remove.
self.kwargs = kwargs.copy()
self.sudo_rm = kwargs.pop('sudo_rm', False)
self.tempdir = None
_TempDirSetup(self, **kwargs)
def Cleanup(self):
"""Clean up the temporary directory."""
if self.tempdir is not None:
_TempDirTearDown(self, self.sudo_rm)
self.tempdir = None
def __enter__(self):
"""Return the temporary directory."""
return self.tempdir
def __exit__(self, exc_type, exc_value, exc_traceback):
except Exception:
if exc_type:
# If an exception from inside the context was already in progress,
# log our cleanup exception, then allow the original to resume.
cros_build_lib.Error('While exiting %s:', self, exc_info=True)
if self.tempdir:
# Log all files in tempdir at the time of the failure.
cros_build_lib.Error('Directory contents were:')
for name in os.listdir(self.tempdir):
cros_build_lib.Error(' %s', name)
except OSError:
cros_build_lib.Error(' Directory did not exist.')
# Log all mounts at the time of the failure, since that's the most
# common cause.
mount_results = cros_build_lib.RunCommand(
['mount'], redirect_stdout=True, combine_stdout_stderr=True,
cros_build_lib.Error('Mounts were:')
cros_build_lib.Error(' %s', mount_results.output)
# If there was not an exception from the context, raise ours.
def __del__(self):
# pylint: disable=W0212,R0904,W0702
def TempDirDecorator(func):
"""Populates self.tempdir with path to a temporary writeable directory."""
def f(self, *args, **kwargs):
with TempDir() as tempdir:
self.tempdir = tempdir
return func(self, *args, **kwargs)
f.__name__ = func.__name__
f.__doc__ = func.__doc__
f.__module__ = func.__module__
return f
def TempFileDecorator(func):
"""Populates self.tempfile with path to a temporary writeable file"""
def f(self, *args, **kwargs):
with tempfile.NamedTemporaryFile(dir=self.tempdir, delete=False) as f:
self.tempfile =
return func(self, *args, **kwargs)
f.__name__ = func.__name__
f.__doc__ = func.__doc__
f.__module__ = func.__module__
return TempDirDecorator(f)
# Flags synced from sys/mount.h. See mount(2) for details.
MS_BIND = 4096
MS_MOVE = 8192
MS_REC = 16384
MS_SILENT = 32768
MS_POSIXACL = 1 << 16
MS_PRIVATE = 1 << 18
MS_SLAVE = 1 << 19
MS_SHARED = 1 << 20
MS_RELATIME = 1 << 21
MS_KERNMOUNT = 1 << 22
MS_I_VERSION = 1 << 23
MS_ACTIVE = 1 << 30
MS_NOUSER = 1 << 31
def Mount(source, target, fstype, flags, data=""):
"""Call the mount(2) func; see the man page for details."""
libc = ctypes.CDLL(ctypes.util.find_library('c'), use_errno=True)
if libc.mount(source, target, fstype, ctypes.c_int(flags), data) != 0:
e = ctypes.get_errno()
raise OSError(e, os.strerror(e))
def MountDir(src_path, dst_path, fs_type=None, sudo=True, makedirs=True,
mount_opts=('nodev', 'noexec', 'nosuid'), skip_mtab=False,
"""Mount |src_path| at |dst_path|
src_path: Source of the new mount.
dst_path: Where to mount things.
fs_type: Specify the filesystem type to use. Defaults to autodetect.
sudo: Run through sudo.
makedirs: Create |dst_path| if it doesn't exist.
mount_opts: List of options to pass to `mount`.
skip_mtab: Whether to write new entries to /etc/mtab.
kwargs: Pass all other args to RunCommand.
if sudo:
runcmd = cros_build_lib.SudoRunCommand
runcmd = cros_build_lib.RunCommand
if makedirs:
SafeMakedirs(dst_path, sudo=sudo)
cmd = ['mount', src_path, dst_path]
if skip_mtab:
cmd += ['-n']
if fs_type:
cmd += ['-t', fs_type]
runcmd(cmd + ['-o', ','.join(mount_opts)], **kwargs)
def MountTmpfsDir(path, name='osutils.tmpfs', size='5G',
mount_opts=('nodev', 'noexec', 'nosuid'), **kwargs):
"""Mount a tmpfs at |path|
path: Directory to mount the tmpfs.
name: Friendly name to include in mount output.
size: Size of the temp fs.
mount_opts: List of options to pass to `mount`.
kwargs: Pass all other args to MountDir.
mount_opts = list(mount_opts) + ['size=%s' % size]
MountDir(name, path, fs_type='tmpfs', mount_opts=mount_opts, **kwargs)
def UmountDir(path, lazy=True, sudo=True, cleanup=True):
"""Unmount a previously mounted temp fs mount.
path: Directory to unmount.
lazy: Whether to do a lazy unmount.
sudo: Run through sudo.
cleanup: Whether to delete the |path| after unmounting.
Note: Does not work when |lazy| is set.
if sudo:
runcmd = cros_build_lib.SudoRunCommand
runcmd = cros_build_lib.RunCommand
cmd = ['umount', '-d', path]
if lazy:
cmd += ['-l']
if cleanup:
# We will randomly get EBUSY here even when the umount worked. Suspect
# this is due to the host distro doing stupid crap on us like autoscanning
# directories when they get mounted.
def _retry(e):
# When we're using `rm` (which is required for sudo), we can't cleanly
# detect the aforementioned failure. This is because `rm` will see the
# errno, handle itself, and then do exit(1). Which means all we see is
# that rm failed. Assume it's this issue as -rf will ignore most things.
if isinstance(e, cros_build_lib.RunCommandError):
return True
# When we aren't using sudo, we do the unlink ourselves, so the exact
# errno is bubbled up to us and we can detect it specifically without
# potentially ignoring all other possible failures.
return e.errno == errno.EBUSY
retry_util.GenericRetry(_retry, 30, RmDir, path, sudo=sudo, sleep=60)
def SetEnvironment(env):
"""Restore the environment variables to that of passed in dictionary."""
def SourceEnvironment(script, whitelist, ifs=',', env=None, multiline=False):
"""Returns the environment exported by a shell script.
Note that the script is actually executed (sourced), so do not use this on
files that have side effects (such as modify the file system). Stdout will
be sent to /dev/null, so just echoing is OK.
script: The shell script to 'source'.
whitelist: An iterable of environment variables to retrieve values for.
ifs: When showing arrays, what separator to use.
env: A dict of the initial env to pass down. You can also pass it None
(to clear the env) or True (to preserve the current env).
multiline: Allow a variable to span multiple lines.
A dictionary containing the values of the whitelisted environment
variables that are set.
dump_script = ['source "%s" >/dev/null' % script,
'IFS="%s"' % ifs]
for var in whitelist:
'[[ "${%(var)s+set}" == "set" ]] && echo %(var)s="${%(var)s[*]}"'
% {'var': var})
dump_script.append('exit 0')
if env is None:
env = {}
elif env is True:
env = None
output = cros_build_lib.RunCommand(['bash'], env=env, redirect_stdout=True,
redirect_stderr=True, print_cmd=False,
return cros_build_lib.LoadKeyValueFile(cStringIO.StringIO(output),
def ListBlockDevices(device_path=None, in_bytes=False):
"""Lists all block devices.
device_path: device path (e.g. /dev/sdc).
in_bytes: whether to display size in bytes.
A list of BlockDevice items with attributes 'NAME', 'RM', 'TYPE',
'SIZE' (RM stands for removable).
keys = ['NAME', 'RM', 'TYPE', 'SIZE']
BlockDevice = collections.namedtuple('BlockDevice', keys)
cmd = ['lsblk', '--pairs']
if in_bytes:
if device_path:
cmd += ['--output', ','.join(keys)]
output = cros_build_lib.RunCommand(
cmd, debug_level=logging.DEBUG, capture_output=True).output.strip()
devices = []
for line in output.splitlines():
d = {}
for k, v in re.findall(r'(\S+?)=\"(.+?)\"', line):
d[k] = v
return devices
def GetDeviceInfo(device, keyword='model'):
"""Get information of |device| by searching through device path.
Looks for the file named |keyword| in the path upwards from
/sys/block/|device|/device. This path is a symlink and will be fully
expanded when searching.
device: Device name (e.g. 'sdc').
keyword: The filename to look for (e.g. product, model).
The content of the |keyword| file.
device_path = os.path.join('/sys', 'block', device)
if not os.path.isdir(device_path):
raise ValueError('%s is not a valid device path.' % device_path)
path_list = ExpandPath(os.path.join(device_path, 'device')).split(os.path.sep)
while len(path_list) > 2:
target = os.path.join(os.path.sep.join(path_list), keyword)
if os.path.isfile(target):
return ReadFile(target).strip()
path_list = path_list[:-1]
def GetDeviceSize(device_path, in_bytes=False):
"""Returns the size of |device|.
device_path: Device path (e.g. '/dev/sdc').
in_bytes: If set True, returns the size in bytes.
Size of the device in human readable format unless |in_bytes| is set.
devices = ListBlockDevices(device_path=device_path, in_bytes=in_bytes)
for d in devices:
if d.TYPE == 'disk':
return int(d.SIZE) if in_bytes else d.SIZE
raise ValueError('No size info of %s is found.' % device_path)
def GetExitStatus(status):
"""Get the exit status of a child from an os.waitpid call.
status: The return value of os.waitpid(pid, 0)[1]
The exit status of the process. If the process exited with a signal,
the return value will be 128 plus the signal number.
if os.WIFSIGNALED(status):
return 128 + os.WTERMSIG(status)
assert os.WIFEXITED(status), 'Unexpected exit status %r' % status
return os.WEXITSTATUS(status)
FileInfo = collections.namedtuple(
'FileInfo', ['path', 'owner', 'size', 'atime', 'mtime'])
def StatFilesInDirectory(path, recursive=False, to_string=False):
"""Stat files in the directory |path|.
path: Path to the target directory.
recursive: Whether to recurisvely list all files in |path|.
to_string: Whether to return a string containing the metadata of the
If |to_string| is False, returns a list of FileInfo objects. Otherwise,
returns a string of metadata of the files.
path = ExpandPath(path)
def ToFileInfo(path, stat):
return FileInfo(path,
file_infos = []
for root, dirs, files in os.walk(path, topdown=True):
for filename in dirs + files:
filepath = os.path.join(root, filename)
file_infos.append(ToFileInfo(filepath, os.lstat(filepath)))
if not recursive:
# Process only the top-most directory.
if not to_string:
return file_infos
msg = 'Listing the content of %s' % path
msg_format = ('Path: {x.path}, Owner: {x.owner}, Size: {x.size} bytes, '
'Accessed: {x.atime}, Modified: {x.mtime}')
msg = '%s\n%s' % (msg,
'\n'.join([msg_format.format(x=x) for x in file_infos]))
return msg
def MountImagePartition(image_file, part_number, destination, gpt_table=None,
sudo=True, makedirs=True, mount_opts=('ro', ),
"""Mount a |partition| from |image_file| to |destination|.
If there is a GPT table (GetImageDiskPartitionInfo), it will be used for
start offset and size of the selected partition. Otherwise, the GPT will
be read again from |image_file|. The GPT table MUST have unit of "B".
The mount option will be:
-o offset=XXX,sizelimit=YYY,(*mount_opts)
image_file: A path to the image file (chromiumos_base_image.bin).
part_number: A partition number.
destination: A path to the mount point.
gpt_table: A dictionary of PartitionInfo objects. See
sudo: Same as MountDir.
makedirs: Same as MountDir.
mount_opts: Same as MountDir.
skip_mtab: Same as MountDir.
if gpt_table is None:
gpt_table = cros_build_lib.GetImageDiskPartitionInfo(image_file, 'B',
for _, part in gpt_table.items():
if part.number == part_number:
part = None
raise ValueError('Partition number %d not found in the GPT %r.' %
(part_number, gpt_table))
opts = ['loop', 'offset=%d' % part.start, 'sizelimit=%d' % part.size]
opts += mount_opts
MountDir(image_file, destination, sudo=sudo, makedirs=makedirs,
mount_opts=opts, skip_mtab=skip_mtab)
def ChdirContext(target_dir):
"""A context manager to chdir() into |target_dir| and back out on exit.
target_dir: A target directory to chdir into.
cwd = os.getcwd()
class MountImageContext(object):
"""A context manager to mount an image."""
def __init__(self, image_file, destination, part_selects=(1, 3)):
"""Construct a context manager object to actually do the job.
Specified partitions will be mounted under |destination| according to the
partition ---mount--> dir-<partition number>
Symlinks with labels "dir-<label>" will also be created in |destination| to
point to the mounted partitions. If there is a conflict in symlinks, the
first one wins.
The image is unmounted when this context manager exits.
with MountImageContext('build/images/wolf/latest', 'root_mount_point'):
# "dir-1", and "dir-3" will be mounted in root_mount_point
image_file: A path to the image file.
destination: A directory in which all mount points and symlinks will be
created. This parameter is relative to the CWD at the time __init__ is
part_selects: A list of partition numbers or labels to be mounted. If an
element is an integer, it is matched as partition number, otherwise
a partition label.
self._image_file = image_file
self._gpt_table = cros_build_lib.GetImageDiskPartitionInfo(
self._image_file, 'B', key_selector='number'
# Target dir is absolute path so that we do not have to worry about
# CWD being changed later.
self._target_dir = ExpandPath(destination)
self._part_selects = part_selects
self._mounted = set()
self._linked_labels = set()
def _GetMountPointAndSymlink(self, part):
"""Given a PartitionInfo, return a tuple of mount point and symlink.
part: A PartitionInfo object.
A tuple (mount_point, symlink).
dest_number = os.path.join(self._target_dir, 'dir-%d' % part.number)
dest_label = os.path.join(self._target_dir, 'dir-%s' %
return dest_number, dest_label
def _Mount(self, part):
"""Mount the partition and create a symlink to the mount point.
The partition is mounted as "dir-partNumber", and the symlink "dir-label".
If "dir-label" already exists, no symlink is created.
part: A PartitionInfo object.
ValueError if mount point already exists.
if part in self._mounted:
dest_number, dest_label = self._GetMountPointAndSymlink(part)
if os.path.exists(dest_number):
raise ValueError('Mount point %s already exists.' % dest_number)
MountImagePartition(self._image_file, part.number,
dest_number, self._gpt_table)
if not os.path.exists(dest_label):
os.symlink(os.path.basename(dest_number), dest_label)
def _Unmount(self, part):
"""Unmount a partition that was mounted by _Mount."""
dest_number, dest_label = self._GetMountPointAndSymlink(part)
# Due to crosbug/358933, the RmDir call might fail. So we skip the cleanup.
UmountDir(dest_number, cleanup=False)
if dest_label in self._linked_labels:
def _CleanUp(self):
"""Unmount all mounted partitions."""
to_be_rmdir = []
for part in list(self._mounted):
dest_number, _ = self._GetMountPointAndSymlink(part)
# Because _Unmount did not RmDir the mount points, we do that here.
for path in to_be_rmdir:
retry_util.RetryException(cros_build_lib.RunCommandError, 30,
RmDir, path, sudo=True, sleep=60)
def __enter__(self):
for selector in self._part_selects:
matcher = operator.attrgetter('number')
if not isinstance(selector, int):
matcher = operator.attrgetter('name')
for _, part in self._gpt_table.items():
if matcher(part) == selector:
raise ValueError('Partition %r not found in the GPT %r.' %
(selector, self._gpt_table))
return self
def __exit__(self, exc_type, exc_value, traceback):
MountInfo = collections.namedtuple('MountInfo',
'source destination filesystem options')
def IterateMountPoints(proc_file='/proc/mounts'):
"""Iterate over all mounts as reported by "/proc/mounts".
proc_file: A path to a file whose content is similar to /proc/mounts.
Default to "/proc/mounts" itself.
A generator that yields MountInfo objects.
with open(proc_file, 'rt') as f:
for line in f:
# Escape any \xxx to a char.
source, destination, filesystem, options, _, _ = [
re.sub(r'\\([0-7]{3})', lambda m: chr(int(, 8)), x)
for x in line.split()
mtab = MountInfo(source, destination, filesystem, options)
yield mtab
def ResolveSymlink(file_name, root='/'):
"""Resolve a symlink |file_name| relative to |root|.
For example:
ROOT-A/absolute_symlink --> /an/abs/path
ROOT-A/relative_symlink --> a/relative/path
absolute_symlink will be resolved to ROOT-A/an/abs/path
relative_symlink will be resolved to ROOT-A/a/relative/path
file_name: A path to the file.
root: A path to the root directory.
|file_name| if |file_name| is not a symlink. Otherwise, the ultimate path
that |file_name| points to, with links resolved relative to |root|.
count = 0
while os.path.islink(file_name):
count += 1
if count > 128:
raise ValueError('Too many link levels for %s.' % file_name)
link = os.readlink(file_name)
if link.startswith('/'):
file_name = os.path.join(root, link[1:])
file_name = os.path.join(os.path.dirname(file_name), link)
return file_name