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 <stdio.h> 20 #include <stdint.h> 21 #include <stdbool.h> 22 #include <linux/dm-ioctl.h> 23 24 #include <functional> 25 #include <string> 26 27 #include <fstab/fstab.h> 28 29 // Magic number at start of verity metadata 30 #define VERITY_METADATA_MAGIC_NUMBER 0xb001b001 31 32 // Replacement magic number at start of verity metadata to cleanly 33 // turn verity off in userdebug builds. 34 #define VERITY_METADATA_MAGIC_DISABLE 0x46464f56 // "VOFF" 35 36 // Verity modes 37 enum verity_mode { 38 VERITY_MODE_EIO = 0, 39 VERITY_MODE_LOGGING = 1, 40 VERITY_MODE_RESTART = 2, 41 VERITY_MODE_LAST = VERITY_MODE_RESTART, 42 VERITY_MODE_DEFAULT = VERITY_MODE_RESTART 43 }; 44 45 // Mount modes 46 enum mount_mode { 47 MOUNT_MODE_DEFAULT = 0, 48 MOUNT_MODE_EARLY = 1, 49 MOUNT_MODE_LATE = 2, 50 // TODO(b/135984674): remove this after refactoring fs_mgr_mount_all. 51 MOUNT_MODE_ONLY_USERDATA = 3 52 }; 53 54 #define FS_MGR_MNTALL_DEV_IS_METADATA_ENCRYPTED 7 55 #define FS_MGR_MNTALL_DEV_NEEDS_METADATA_ENCRYPTION 6 56 #define FS_MGR_MNTALL_DEV_FILE_ENCRYPTED 5 57 #define FS_MGR_MNTALL_DEV_NEEDS_RECOVERY 4 58 #define FS_MGR_MNTALL_DEV_NEEDS_ENCRYPTION 3 59 #define FS_MGR_MNTALL_DEV_MIGHT_BE_ENCRYPTED 2 60 #define FS_MGR_MNTALL_DEV_NOT_ENCRYPTED 1 61 #define FS_MGR_MNTALL_DEV_NOT_ENCRYPTABLE 0 62 #define FS_MGR_MNTALL_FAIL (-1) 63 64 struct MountAllResult { 65 // One of the FS_MGR_MNTALL_* returned code defined above. 66 int code; 67 // Whether userdata was mounted as a result of |fs_mgr_mount_all| call. 68 bool userdata_mounted; 69 }; 70 71 // fs_mgr_mount_all() updates fstab entries that reference device-mapper. 72 // Returns a |MountAllResult|. The first element is one of the FS_MNG_MNTALL_* return codes 73 // defined above, and the second element tells whether this call to fs_mgr_mount_all was responsible 74 // for mounting userdata. Later is required for init to correctly enqueue fs-related events as part 75 // of userdata remount during userspace reboot. 76 MountAllResult fs_mgr_mount_all(android::fs_mgr::Fstab* fstab, int mount_mode); 77 78 #define FS_MGR_DOMNT_FAILED (-1) 79 #define FS_MGR_DOMNT_BUSY (-2) 80 #define FS_MGR_DOMNT_SUCCESS 0 81 int fs_mgr_do_mount(android::fs_mgr::Fstab* fstab, const char* n_name, char* n_blk_device, 82 char* tmp_mount_point); 83 int fs_mgr_do_mount(android::fs_mgr::Fstab* fstab, const char* n_name, char* n_blk_device, 84 char* tmp_mount_point, bool need_cp, bool metadata_encrypted); 85 int fs_mgr_do_mount_one(const android::fs_mgr::FstabEntry& entry, 86 const std::string& mount_point = ""); 87 int fs_mgr_do_tmpfs_mount(const char *n_name); 88 bool fs_mgr_load_verity_state(int* mode); 89 // Returns true if verity is enabled on this particular FstabEntry. 90 bool fs_mgr_is_verity_enabled(const android::fs_mgr::FstabEntry& entry); 91 // Returns the hash algorithm used to build the hashtree of this particular FstabEntry. Returns an 92 // empty string if the input isn't a dm-verity entry, or if there is an error. 93 std::string fs_mgr_get_hashtree_algorithm(const android::fs_mgr::FstabEntry& entry); 94 95 bool fs_mgr_swapon_all(const android::fs_mgr::Fstab& fstab); 96 bool fs_mgr_update_logical_partition(android::fs_mgr::FstabEntry* entry); 97 98 // Returns true if the given fstab entry has verity enabled, *and* the verity 99 // device is in "check_at_most_once" mode. 100 bool fs_mgr_verity_is_check_at_most_once(const android::fs_mgr::FstabEntry& entry); 101 102 int fs_mgr_do_format(const android::fs_mgr::FstabEntry& entry, bool reserve_footer); 103 104 #define FS_MGR_SETUP_VERITY_SKIPPED (-3) 105 #define FS_MGR_SETUP_VERITY_DISABLED (-2) 106 #define FS_MGR_SETUP_VERITY_FAIL (-1) 107 #define FS_MGR_SETUP_VERITY_SUCCESS 0 108 int fs_mgr_setup_verity(android::fs_mgr::FstabEntry* fstab, bool wait_for_verity_dev); 109 110 // Return the name of the super partition if it exists. If a slot number is 111 // specified, the super partition for the corresponding metadata slot will be 112 // returned. Otherwise, it will use the current slot. 113 std::string fs_mgr_get_super_partition_name(int slot = -1); 114 115 enum FsMgrUmountStatus : int { 116 SUCCESS = 0, 117 ERROR_UNKNOWN = 1 << 0, 118 ERROR_UMOUNT = 1 << 1, 119 ERROR_VERITY = 1 << 2, 120 ERROR_DEVICE_MAPPER = 1 << 3, 121 }; 122 // fs_mgr_umount_all() is the reverse of fs_mgr_mount_all. In particular, 123 // it destroys verity devices from device mapper after the device is unmounted. 124 int fs_mgr_umount_all(android::fs_mgr::Fstab* fstab); 125 126 // Finds a entry in |fstab| that was used to mount a /data on |data_block_device|. 127 android::fs_mgr::FstabEntry* fs_mgr_get_mounted_entry_for_userdata( 128 android::fs_mgr::Fstab* fstab, const std::string& data_block_device); 129 int fs_mgr_remount_userdata_into_checkpointing(android::fs_mgr::Fstab* fstab); 130 131 // Finds the dm_bow device on which this block device is stacked, or returns 132 // empty string 133 std::string fs_mgr_find_bow_device(const std::string& block_device); 134 135 // Creates mount point if not already existed, and checks that mount point is a 136 // canonical path that doesn't contain any symbolic link or /../. 137 bool fs_mgr_create_canonical_mount_point(const std::string& mount_point); 138 139 // Like fs_mgr_do_mount_one() but for overlayfs fstab entries. 140 // Unlike fs_mgr_overlayfs, mount overlayfs without upperdir and workdir, so the 141 // filesystem cannot be remount read-write. 142 bool fs_mgr_mount_overlayfs_fstab_entry(const android::fs_mgr::FstabEntry& entry); 143