1# SPDX-License-Identifier:      GPL-2.0+
2#
3# Copyright (c) 2018, Linaro Limited
4# Author: Takahiro Akashi <takahiro.akashi@linaro.org>
5
6"""Helper functions for dealing with filesystems"""
7
8import re
9import os
10from subprocess import call, check_call, check_output, CalledProcessError
11
12def mk_fs(config, fs_type, size, prefix, src_dir=None, size_gran = 0x100000):
13    """Create a file system volume
14
15    Args:
16        config (u_boot_config): U-Boot configuration
17        fs_type (str): File system type, e.g. 'ext4'
18        size (int): Size of file system in bytes
19        prefix (str): Prefix string of volume's file name
20        src_dir (str): Root directory to use, or None for none
21        size_gran (int): Size granularity of file system image in bytes
22
23    Raises:
24        CalledProcessError: if any error occurs when creating the filesystem
25    """
26    fs_img = f'{prefix}.{fs_type}.img'
27    fs_img = os.path.join(config.persistent_data_dir, fs_img)
28
29    if fs_type == 'fat12':
30        mkfs_opt = '-F 12'
31    elif fs_type == 'fat16':
32        mkfs_opt = '-F 16'
33    elif fs_type == 'fat32':
34        mkfs_opt = '-F 32'
35    else:
36        mkfs_opt = ''
37
38    if fs_type == 'exfat':
39        fs_lnxtype = 'exfat'
40    elif re.match('fat', fs_type) or fs_type == 'fs_generic':
41        fs_lnxtype = 'vfat'
42    else:
43        fs_lnxtype = fs_type
44
45    if src_dir:
46        if fs_lnxtype == 'ext4':
47            mkfs_opt = mkfs_opt + ' -d ' + src_dir
48        elif fs_lnxtype != 'vfat' and fs_lnxtype != 'exfat':
49            raise ValueError(f'src_dir not implemented for fs {fs_lnxtype}')
50
51    count = (size + size_gran - 1) // size_gran
52
53    # Some distributions do not add /sbin to the default PATH, where mkfs lives
54    if '/sbin' not in os.environ["PATH"].split(os.pathsep):
55        os.environ["PATH"] += os.pathsep + '/sbin'
56
57    try:
58        check_call(f'rm -f {fs_img}', shell=True)
59        check_call(f'truncate -s $(( {size_gran} * {count} )) {fs_img}',
60                   shell=True)
61        check_call(f'mkfs.{fs_lnxtype} {mkfs_opt} {fs_img}', shell=True)
62        if fs_type == 'ext4':
63            sb_content = check_output(f'tune2fs -l {fs_img}',
64                                      shell=True).decode()
65            if 'metadata_csum' in sb_content:
66                check_call(f'tune2fs -O ^metadata_csum {fs_img}', shell=True)
67        elif fs_lnxtype == 'vfat' and src_dir:
68            check_call(f'mcopy -i {fs_img} -vsmpQ {src_dir}/* ::/', shell=True)
69        elif fs_lnxtype == 'exfat' and src_dir:
70            check_call(f'fattools cp {src_dir}/* {fs_img}', shell=True)
71        return fs_img
72    except CalledProcessError:
73        call(f'rm -f {fs_img}', shell=True)
74        raise
75
76def setup_image(ubman, devnum, part_type, img_size=20, second_part=False,
77                basename='mmc'):
78    """Create a disk image with a single partition
79
80    Args:
81        ubman (ConsoleBase): Console to use
82        devnum (int): Device number to use, e.g. 1
83        part_type (int): Partition type, e.g. 0xc for FAT32
84        img_size (int): Image size in MiB
85        second_part (bool): True to contain a small second partition
86        basename (str): Base name to use in the filename, e.g. 'mmc'
87
88    Returns:
89        tuple:
90            str: Filename of MMC image
91            str: Directory name of scratch directory
92    """
93    fname = os.path.join(ubman.config.source_dir, f'{basename}{devnum}.img')
94    mnt = os.path.join(ubman.config.persistent_data_dir, 'scratch')
95
96    spec = f'type={part_type:x}, size={img_size - 2}M, start=1M, bootable'
97    if second_part:
98        spec += '\ntype=c'
99
100    try:
101        check_call(f'mkdir -p {mnt}', shell=True)
102        check_call(f'qemu-img create {fname} {img_size}M', shell=True)
103        check_call(f'printf "{spec}" | sfdisk {fname}', shell=True)
104    except CalledProcessError:
105        call(f'rm -f {fname}', shell=True)
106        raise
107
108    return fname, mnt
109
110# Just for trying out
111if __name__ == "__main__":
112    import collections
113
114    CNF= collections.namedtuple('config', 'persistent_data_dir')
115
116    mk_fs(CNF('.'), 'ext4', 0x1000000, 'pref')
117