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 <functional> 23 #include <set> 24 #include <string> 25 #include <vector> 26 27 std::string fs_mgr_get_slot_suffix(); 28 std::string fs_mgr_get_other_slot_suffix(); 29 30 namespace android { 31 namespace fs_mgr { 32 33 struct FstabEntry { 34 std::string blk_device; 35 std::vector<std::string> user_devices; 36 std::string logical_partition_name; 37 std::string mount_point; 38 std::string fs_type; 39 unsigned long flags = 0; 40 std::string fs_options; 41 std::string fs_checkpoint_opts; 42 std::string metadata_key_dir; 43 std::string metadata_encryption_options; 44 off64_t length = 0; 45 std::string label; 46 int partnum = -1; 47 int swap_prio = -1; 48 int max_comp_streams = 0; 49 off64_t zram_size = 0; 50 off64_t reserved_size = 0; 51 off64_t readahead_size_kb = -1; 52 std::string encryption_options; 53 off64_t erase_blk_size = 0; 54 off64_t logical_blk_size = 0; 55 std::string sysfs_path; 56 std::string vbmeta_partition; 57 uint64_t zram_backingdev_size = 0; 58 std::string avb_keys; 59 std::string lowerdir; 60 std::string avb_hashtree_digest; 61 62 struct FsMgrFlags { 63 bool wait : 1; 64 bool check : 1; 65 bool crypt : 1; // Now only used to identify adoptable storage volumes 66 bool nonremovable : 1; 67 bool vold_managed : 1; 68 bool recovery_only : 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 late_mount : 1; 76 bool no_fail : 1; 77 bool quota : 1; 78 bool avb : 1; 79 bool logical : 1; 80 bool checkpoint_blk : 1; 81 bool checkpoint_fs : 1; 82 bool first_stage_mount : 1; 83 bool slot_select_other : 1; 84 bool fs_verity : 1; 85 bool ext_meta_csum : 1; 86 bool fs_compress : 1; 87 bool overlayfs_remove_missing_lowerdir : 1; 88 bool is_zoned : 1; 89 } fs_mgr_flags = {}; 90 is_encryptableFstabEntry91 bool is_encryptable() const { return fs_mgr_flags.crypt; } 92 }; 93 94 // An Fstab is a collection of FstabEntry structs. 95 // The entries must be kept in the same order as they were seen in the fstab. 96 // Unless explicitly requested, a lookup on mount point should always return the 1st one. 97 using Fstab = std::vector<FstabEntry>; 98 99 bool ReadFstabFromFile(const std::string& path, Fstab* fstab); 100 bool ReadFstabFromProcMounts(Fstab* fstab); 101 bool ReadFstabFromDt(Fstab* fstab, bool verbose = true); 102 bool ReadDefaultFstab(Fstab* fstab); 103 bool SkipMountingPartitions(Fstab* fstab, bool verbose = false); 104 105 // The Fstab can contain multiple entries for the same mount point with different configurations. 106 std::vector<FstabEntry*> GetEntriesForMountPoint(Fstab* fstab, const std::string& path); 107 108 // Like GetEntriesForMountPoint() but return only the first entry or nullptr if no entry is found. 109 FstabEntry* GetEntryForMountPoint(Fstab* fstab, const std::string& path); 110 const FstabEntry* GetEntryForMountPoint(const Fstab* fstab, const std::string& path); 111 112 FstabEntry* GetEntryForMountPoint(Fstab* fstab, const std::string_view path, 113 const std::string_view fstype); 114 115 // This method builds DSU fstab entries and transfer the fstab. 116 // 117 // fstab points to the unmodified fstab. 118 // 119 // dsu_partitions contains partition names, e.g. 120 // dsu_partitions[0] = "system_gsi" 121 // dsu_partitions[1] = "userdata_gsi" 122 // dsu_partitions[2] = ... 123 void TransformFstabForDsu(Fstab* fstab, const std::string& dsu_slot, 124 const std::vector<std::string>& dsu_partitions); 125 126 std::set<std::string> GetBootDevices(); 127 128 // Return the name of the dm-verity device for the given fstab entry. This does 129 // not check whether the device is valid or exists; it merely returns the 130 // expected name. 131 std::string GetVerityDeviceName(const FstabEntry& entry); 132 133 // Returns the Android Device Tree directory as specified in the kernel bootconfig or cmdline. 134 // If the platform does not configure a custom DT path, returns the standard one (based in procfs). 135 const std::string& GetAndroidDtDir(); 136 137 // Import the kernel bootconfig by calling the callback |fn| with each key-value pair. 138 void ImportBootconfig(const std::function<void(std::string, std::string)>& fn); 139 140 // Get the kernel bootconfig value for |key|. 141 // Returns true if |key| is found in bootconfig. 142 // Otherwise returns false and |*out| is not modified. 143 bool GetBootconfig(const std::string& key, std::string* out); 144 145 // Import the kernel cmdline by calling the callback |fn| with each key-value pair. 146 void ImportKernelCmdline(const std::function<void(std::string, std::string)>& fn); 147 148 // Get the kernel cmdline value for |key|. 149 // Returns true if |key| is found in the kernel cmdline. 150 // Otherwise returns false and |*out| is not modified. 151 bool GetKernelCmdline(const std::string& key, std::string* out); 152 153 // Return the "other" slot for the given slot suffix. 154 std::string OtherSlotSuffix(const std::string& suffix); 155 156 } // namespace fs_mgr 157 } // namespace android 158