1 /*
2  * Copyright (C) 2012 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #pragma once
18 
19 #include <stdint.h>
20 #include <sys/types.h>
21 
22 #include <set>
23 #include <string>
24 #include <vector>
25 
26 std::string fs_mgr_get_slot_suffix();
27 std::string fs_mgr_get_other_slot_suffix();
28 
29 namespace android {
30 namespace fs_mgr {
31 
32 struct FstabEntry {
33     std::string blk_device;
34     std::string logical_partition_name;
35     std::string mount_point;
36     std::string fs_type;
37     unsigned long flags = 0;
38     std::string fs_options;
39     std::string fs_checkpoint_opts;
40     std::string key_loc;
41     std::string metadata_key_dir;
42     std::string metadata_encryption;
43     off64_t length = 0;
44     std::string label;
45     int partnum = -1;
46     int swap_prio = -1;
47     int max_comp_streams = 0;
48     off64_t zram_size = 0;
49     off64_t reserved_size = 0;
50     off64_t readahead_size_kb = -1;
51     std::string encryption_options;
52     off64_t erase_blk_size = 0;
53     off64_t logical_blk_size = 0;
54     std::string sysfs_path;
55     std::string vbmeta_partition;
56     uint64_t zram_backingdev_size = 0;
57     std::string avb_keys;
58     std::string lowerdir;
59 
60     struct FsMgrFlags {
61         bool wait : 1;
62         bool check : 1;
63         bool crypt : 1;
64         bool nonremovable : 1;
65         bool vold_managed : 1;
66         bool recovery_only : 1;
67         bool verify : 1;
68         bool force_crypt : 1;
69         bool no_emulated_sd : 1;  // No emulated sdcard daemon; sd card is the only external
70                                   // storage.
71         bool no_trim : 1;
72         bool file_encryption : 1;
73         bool formattable : 1;
74         bool slot_select : 1;
75         bool force_fde_or_fbe : 1;
76         bool late_mount : 1;
77         bool no_fail : 1;
78         bool verify_at_boot : 1;
79         bool quota : 1;
80         bool avb : 1;
81         bool logical : 1;
82         bool checkpoint_blk : 1;
83         bool checkpoint_fs : 1;
84         bool first_stage_mount : 1;
85         bool slot_select_other : 1;
86         bool fs_verity : 1;
87         bool ext_meta_csum : 1;
88         bool fs_compress : 1;
89     } fs_mgr_flags = {};
90 
is_encryptableFstabEntry91     bool is_encryptable() const {
92         return fs_mgr_flags.crypt || fs_mgr_flags.force_crypt || fs_mgr_flags.force_fde_or_fbe;
93     }
94 };
95 
96 // An Fstab is a collection of FstabEntry structs.
97 // The entries must be kept in the same order as they were seen in the fstab.
98 // Unless explicitly requested, a lookup on mount point should always return the 1st one.
99 using Fstab = std::vector<FstabEntry>;
100 
101 bool ReadFstabFromFile(const std::string& path, Fstab* fstab);
102 bool ReadFstabFromDt(Fstab* fstab, bool verbose = true);
103 bool ReadDefaultFstab(Fstab* fstab);
104 bool SkipMountingPartitions(Fstab* fstab, bool verbose = false);
105 
106 FstabEntry* GetEntryForMountPoint(Fstab* fstab, const std::string& path);
107 // The Fstab can contain multiple entries for the same mount point with different configurations.
108 std::vector<FstabEntry*> GetEntriesForMountPoint(Fstab* fstab, const std::string& path);
109 
110 // This method builds DSU fstab entries and transfer the fstab.
111 //
112 // fstab points to the unmodified fstab.
113 //
114 // dsu_partitions contains partition names, e.g.
115 //     dsu_partitions[0] = "system_gsi"
116 //     dsu_partitions[1] = "userdata_gsi"
117 //     dsu_partitions[2] = ...
118 void TransformFstabForDsu(Fstab* fstab, const std::string& dsu_slot,
119                           const std::vector<std::string>& dsu_partitions);
120 
121 std::set<std::string> GetBootDevices();
122 
123 // Return the name of the dm-verity device for the given fstab entry. This does
124 // not check whether the device is valid or exists; it merely returns the
125 // expected name.
126 std::string GetVerityDeviceName(const FstabEntry& entry);
127 
128 }  // namespace fs_mgr
129 }  // namespace android
130