Dees_Troy | 240e4a7 | 2012-09-04 09:22:39 -0400 | [diff] [blame] | 1 | /* Partition Management classes for TWRP |
| 2 | * |
| 3 | * This program is free software; you can redistribute it and/or modify |
| 4 | * it under the terms of the GNU General Public License version 2 and |
| 5 | * only version 2 as published by the Free Software Foundation. |
| 6 | * |
| 7 | * This program is distributed in the hope that it will be useful, |
| 8 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 9 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 10 | * GNU General Public License for more details. |
| 11 | * |
| 12 | * You should have received a copy of the GNU General Public License |
| 13 | * along with this program; if not, write to the Free Software |
| 14 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
| 15 | * 02110-1301, USA. |
| 16 | * |
| 17 | * The code was written from scratch by Dees_Troy dees_troy at |
| 18 | * yahoo |
| 19 | * |
| 20 | * Copyright (c) 2012 |
| 21 | */ |
| 22 | |
| 23 | #ifndef __TWRP_Partition_Manager |
| 24 | #define __TWRP_Partition_Manager |
| 25 | |
Dees_Troy | 240e4a7 | 2012-09-04 09:22:39 -0400 | [diff] [blame] | 26 | #include <vector> |
| 27 | #include <string> |
Dees_Troy | 5bf4392 | 2012-09-07 16:07:55 -0400 | [diff] [blame] | 28 | |
| 29 | #define MAX_FSTAB_LINE_LENGTH 2048 |
Dees_Troy | 240e4a7 | 2012-09-04 09:22:39 -0400 | [diff] [blame] | 30 | |
Dees_Troy | 51a0e82 | 2012-09-05 15:24:24 -0400 | [diff] [blame] | 31 | using namespace std; |
| 32 | |
Dees_Troy | a13d74f | 2013-03-24 08:54:55 -0500 | [diff] [blame] | 33 | struct PartitionList { |
| 34 | std::string Display_Name; |
| 35 | std::string Mount_Point; |
| 36 | unsigned int selected; |
| 37 | }; |
| 38 | |
Dees_Troy | 240e4a7 | 2012-09-04 09:22:39 -0400 | [diff] [blame] | 39 | // Partition class |
| 40 | class TWPartition |
| 41 | { |
| 42 | public: |
| 43 | enum Backup_Method_enum { |
| 44 | NONE = 0, |
| 45 | FILES = 1, |
| 46 | DD = 2, |
| 47 | FLASH_UTILS = 3, |
| 48 | }; |
| 49 | |
| 50 | public: |
| 51 | TWPartition(); |
| 52 | virtual ~TWPartition(); |
| 53 | |
| 54 | public: |
Vojtech Bocek | 8b44bbd | 2013-07-25 20:43:29 +0200 | [diff] [blame] | 55 | bool Is_Mounted(); // Checks mount to see if the partition is currently mounted |
| 56 | bool Mount(bool Display_Error); // Mounts the partition if it is not mounted |
| 57 | bool UnMount(bool Display_Error); // Unmounts the partition if it is mounted |
| 58 | bool Wipe(string New_File_System); // Wipes the partition |
| 59 | bool Wipe(); // Wipes the partition |
| 60 | bool Wipe_AndSec(); // Wipes android secure |
| 61 | bool Backup(string backup_folder); // Backs up the partition to the folder specified |
| 62 | bool Check_MD5(string restore_folder); // Checks MD5 of a backup |
| 63 | bool Restore(string restore_folder); // Restores the partition using the backup folder provided |
| 64 | string Backup_Method_By_Name(); // Returns a string of the backup method for human readable output |
| 65 | bool Decrypt(string Password); // Decrypts the partition, return 0 for failure and -1 for success |
| 66 | bool Wipe_Encryption(); // Ignores wipe commands for /data/media devices and formats the original block device |
| 67 | void Check_FS_Type(); // Checks the fs type using blkid, does not do anything on MTD / yaffs2 because this crashes on some devices |
| 68 | bool Update_Size(bool Display_Error); // Updates size information |
| 69 | void Recreate_Media_Folder(); // Recreates the /data/media folder |
Dees_Troy | 240e4a7 | 2012-09-04 09:22:39 -0400 | [diff] [blame] | 70 | |
Dees_Troy | 7c2dec8 | 2012-09-26 09:49:14 -0400 | [diff] [blame] | 71 | public: |
| 72 | string Current_File_System; // Current file system |
| 73 | string Actual_Block_Device; // Actual block device (one of primary, alternate, or decrypted) |
Dees_Troy | 094207a | 2012-09-26 12:00:39 -0400 | [diff] [blame] | 74 | string MTD_Name; // Name of the partition for MTD devices |
Dees_Troy | 7c2dec8 | 2012-09-26 09:49:14 -0400 | [diff] [blame] | 75 | |
Vojtech Bocek | 8b44bbd | 2013-07-25 20:43:29 +0200 | [diff] [blame] | 76 | private: |
Dees_Troy | 5bf4392 | 2012-09-07 16:07:55 -0400 | [diff] [blame] | 77 | bool Process_Fstab_Line(string Line, bool Display_Error); // Processes a fstab line |
Dees_Troy | 38bd760 | 2012-09-14 13:33:53 -0400 | [diff] [blame] | 78 | void Find_Actual_Block_Device(); // Determines the correct block device and stores it in Actual_Block_Device |
Dees_Troy | 240e4a7 | 2012-09-04 09:22:39 -0400 | [diff] [blame] | 79 | |
Vojtech Bocek | 8b44bbd | 2013-07-25 20:43:29 +0200 | [diff] [blame] | 80 | bool Process_Flags(string Flags, bool Display_Error); // Process custom fstab flags |
| 81 | bool Is_File_System(string File_System); // Checks to see if the file system given is considered a file system |
| 82 | bool Is_Image(string File_System); // Checks to see if the file system given is considered an image |
| 83 | void Setup_File_System(bool Display_Error); // Sets defaults for a file system partition |
| 84 | void Setup_Image(bool Display_Error); // Sets defaults for an image partition |
| 85 | void Setup_AndSec(void); // Sets up .android_secure settings |
| 86 | void Find_Real_Block_Device(string& Block_Device, bool Display_Error); // Checks the block device given and follows symlinks until it gets to the real block device |
| 87 | bool Find_Partition_Size(); // Finds the partition size from /proc/partitions |
| 88 | unsigned long long Get_Size_Via_du(string Path, bool Display_Error); // Uses du to get sizes |
| 89 | bool Wipe_EXT23(string File_System); // Formats as ext3 or ext2 |
| 90 | bool Wipe_EXT4(); // Formats using ext4, uses make_ext4fs when present |
| 91 | bool Wipe_FAT(); // Formats as FAT if mkdosfs exits otherwise rm -rf wipe |
| 92 | bool Wipe_EXFAT(); // Formats as EXFAT |
| 93 | bool Wipe_MTD(); // Formats as yaffs2 for MTD memory types |
| 94 | bool Wipe_RMRF(); // Uses rm -rf to wipe |
Dees_Troy | e501704 | 2013-08-29 16:38:55 +0000 | [diff] [blame] | 95 | bool Wipe_F2FS(); // Uses mkfs.f2fs to wipe |
Vojtech Bocek | 8b44bbd | 2013-07-25 20:43:29 +0200 | [diff] [blame] | 96 | bool Wipe_Data_Without_Wiping_Media(); // Uses rm -rf to wipe but does not wipe /data/media |
| 97 | bool Backup_Tar(string backup_folder); // Backs up using tar for file systems |
| 98 | bool Backup_DD(string backup_folder); // Backs up using dd for emmc memory types |
| 99 | bool Backup_Dump_Image(string backup_folder); // Backs up using dump_image for MTD memory types |
| 100 | bool Restore_Tar(string restore_folder, string Restore_File_System); // Restore using tar for file systems |
| 101 | bool Restore_DD(string restore_folder); // Restore using dd for emmc memory types |
| 102 | bool Restore_Flash_Image(string restore_folder); // Restore using flash_image for MTD memory types |
| 103 | bool Get_Size_Via_statfs(bool Display_Error); // Get Partition size, used, and free space using statfs |
| 104 | bool Get_Size_Via_df(bool Display_Error); // Get Partition size, used, and free space using df command |
| 105 | bool Make_Dir(string Path, bool Display_Error); // Creates a directory if it doesn't already exist |
| 106 | bool Find_MTD_Block_Device(string MTD_Name); // Finds the mtd block device based on the name from the fstab |
| 107 | void Recreate_AndSec_Folder(void); // Recreates the .android_secure folder |
| 108 | void Mount_Storage_Retry(void); // Tries multiple times with a half second delay to mount a device in case storage is slow to mount |
| 109 | |
| 110 | private: |
Dees_Troy | 240e4a7 | 2012-09-04 09:22:39 -0400 | [diff] [blame] | 111 | bool Can_Be_Mounted; // Indicates that the partition can be mounted |
| 112 | bool Can_Be_Wiped; // Indicates that the partition can be wiped |
Dees_Troy | a13d74f | 2013-03-24 08:54:55 -0500 | [diff] [blame] | 113 | bool Can_Be_Backed_Up; // Indicates that the partition will show up in the backup list |
Dees_Troy | 51a0e82 | 2012-09-05 15:24:24 -0400 | [diff] [blame] | 114 | bool Wipe_During_Factory_Reset; // Indicates that this partition is wiped during a factory reset |
Dees_Troy | 240e4a7 | 2012-09-04 09:22:39 -0400 | [diff] [blame] | 115 | bool Wipe_Available_in_GUI; // Inidcates that the wipe can be user initiated in the GUI system |
| 116 | bool Is_SubPartition; // Indicates that this partition is a sub-partition of another partition (e.g. datadata is a sub-partition of data) |
Dees_Troy | 5112731 | 2012-09-08 13:08:49 -0400 | [diff] [blame] | 117 | bool Has_SubPartition; // Indicates that this partition has a sub-partition |
Dees_Troy | 5bf4392 | 2012-09-07 16:07:55 -0400 | [diff] [blame] | 118 | string SubPartition_Of; // Indicates which partition is the parent partition of this partition (e.g. /data is the parent partition of /datadata) |
Dees_Troy | 240e4a7 | 2012-09-04 09:22:39 -0400 | [diff] [blame] | 119 | string Symlink_Path; // Symlink path (e.g. /data/media) |
| 120 | string Symlink_Mount_Point; // /sdcard could be the symlink mount point for /data/media |
| 121 | string Mount_Point; // Mount point for this partition (e.g. /system or /data) |
Dees_Troy | e58d526 | 2012-09-21 12:27:57 -0400 | [diff] [blame] | 122 | string Backup_Path; // Path for backup |
Dees_Troy | 38bd760 | 2012-09-14 13:33:53 -0400 | [diff] [blame] | 123 | string Primary_Block_Device; // Block device (e.g. /dev/block/mmcblk1p1) |
Dees_Troy | 240e4a7 | 2012-09-04 09:22:39 -0400 | [diff] [blame] | 124 | string Alternate_Block_Device; // Alternate block device (e.g. /dev/block/mmcblk1) |
Dees_Troy | 38bd760 | 2012-09-14 13:33:53 -0400 | [diff] [blame] | 125 | string Decrypted_Block_Device; // Decrypted block device available after decryption |
Dees_Troy | 240e4a7 | 2012-09-04 09:22:39 -0400 | [diff] [blame] | 126 | bool Removable; // Indicates if this partition is removable -- affects how often we check overall size, if present, etc. |
| 127 | bool Is_Present; // Indicates if the partition is currently present as a block device |
| 128 | int Length; // Used by make_ext4fs to leave free space at the end of the partition block for things like a crypto footer |
| 129 | unsigned long long Size; // Overall size of the partition |
| 130 | unsigned long long Used; // Overall used space |
| 131 | unsigned long long Free; // Overall free space |
| 132 | unsigned long long Backup_Size; // Backup size -- may be different than used space especially when /data/media is present |
| 133 | bool Can_Be_Encrypted; // This partition might be encrypted, affects error handling, can only be true if crypto support is compiled in |
| 134 | bool Is_Encrypted; // This partition is thought to be encrypted -- it wouldn't mount for some reason, only avialble with crypto support |
| 135 | bool Is_Decrypted; // This partition has successfully been decrypted |
Dees_Troy | 240e4a7 | 2012-09-04 09:22:39 -0400 | [diff] [blame] | 136 | string Display_Name; // Display name for the GUI |
| 137 | string Backup_Name; // Backup name -- used for backup filenames |
Dees_Troy | a13d74f | 2013-03-24 08:54:55 -0500 | [diff] [blame] | 138 | string Backup_Display_Name; // Name displayed in the partition list for backup selection |
| 139 | string Storage_Name; // Name displayed in the partition list for storage selection |
Dees_Troy | 63c8df7 | 2012-09-10 14:02:05 -0400 | [diff] [blame] | 140 | string Backup_FileName; // Actual backup filename |
Dees_Troy | 240e4a7 | 2012-09-04 09:22:39 -0400 | [diff] [blame] | 141 | Backup_Method_enum Backup_Method; // Method used for backup |
Dees_Troy | 83bd483 | 2013-05-04 12:39:56 +0000 | [diff] [blame] | 142 | bool Can_Encrypt_Backup; // Indicates if this item can be encrypted during backup |
| 143 | bool Use_Userdata_Encryption; // Indicates if we will use userdata encryption splitting on an encrypted backup |
Dees_Troy | 5bf4392 | 2012-09-07 16:07:55 -0400 | [diff] [blame] | 144 | bool Has_Data_Media; // Indicates presence of /data/media, may affect wiping and backup methods |
Dees_Troy | e58d526 | 2012-09-21 12:27:57 -0400 | [diff] [blame] | 145 | bool Has_Android_Secure; // Indicates the presence of .android_secure on this partition |
Dees_Troy | 5bf4392 | 2012-09-07 16:07:55 -0400 | [diff] [blame] | 146 | bool Is_Storage; // Indicates if this partition is used for storage for backup, restore, and installing zips |
Dees_Troy | a13d74f | 2013-03-24 08:54:55 -0500 | [diff] [blame] | 147 | bool Is_Settings_Storage; // Indicates that this storage partition is the location of the .twrps settings file and the location that is used for custom themes |
Dees_Troy | 5bf4392 | 2012-09-07 16:07:55 -0400 | [diff] [blame] | 148 | string Storage_Path; // Indicates the path to the storage -- root indicates mount point, media/ indicates e.g. /data/media |
Dees_Troy | 5bf4392 | 2012-09-07 16:07:55 -0400 | [diff] [blame] | 149 | string Fstab_File_System; // File system from the recovery.fstab |
| 150 | int Format_Block_Size; // Block size for formatting |
Dees_Troy | 68cab49 | 2012-12-12 19:29:35 +0000 | [diff] [blame] | 151 | bool Ignore_Blkid; // Ignore blkid results due to superblocks lying to us on certain devices / partitions |
Dees_Troy | 16c2b31 | 2013-01-15 16:51:18 +0000 | [diff] [blame] | 152 | bool Retain_Layout_Version; // Retains the .layout_version file during a wipe (needed on devices like Sony Xperia T where /data and /data/media are separate partitions) |
Dees_Troy | 85f44ed | 2013-01-09 18:42:36 +0000 | [diff] [blame] | 153 | #ifdef TW_INCLUDE_CRYPTO_SAMSUNG |
| 154 | string EcryptFS_Password; // Have to store the encryption password to remount |
| 155 | #endif |
Dees_Troy | 240e4a7 | 2012-09-04 09:22:39 -0400 | [diff] [blame] | 156 | |
Dees_Troy | 240e4a7 | 2012-09-04 09:22:39 -0400 | [diff] [blame] | 157 | friend class TWPartitionManager; |
Dees_Troy | a13d74f | 2013-03-24 08:54:55 -0500 | [diff] [blame] | 158 | friend class DataManager; |
| 159 | friend class GUIPartitionList; |
Dees_Troy | 51a0e82 | 2012-09-05 15:24:24 -0400 | [diff] [blame] | 160 | }; |
Dees_Troy | 240e4a7 | 2012-09-04 09:22:39 -0400 | [diff] [blame] | 161 | |
| 162 | class TWPartitionManager |
| 163 | { |
| 164 | public: |
Dees_Troy | 5bf4392 | 2012-09-07 16:07:55 -0400 | [diff] [blame] | 165 | TWPartitionManager() {} |
Vojtech Bocek | 8b44bbd | 2013-07-25 20:43:29 +0200 | [diff] [blame] | 166 | ~TWPartitionManager() {} |
Dees_Troy | 5bf4392 | 2012-09-07 16:07:55 -0400 | [diff] [blame] | 167 | |
| 168 | public: |
Vojtech Bocek | 8b44bbd | 2013-07-25 20:43:29 +0200 | [diff] [blame] | 169 | int Process_Fstab(string Fstab_Filename, bool Display_Error); // Parses the fstab and populates the partitions |
| 170 | int Write_Fstab(); // Creates /etc/fstab file that's used by the command line for mount commands |
| 171 | void Output_Partition_Logging(); // Outputs partition information to the log |
| 172 | int Mount_By_Path(string Path, bool Display_Error); // Mounts partition based on path (e.g. /system) |
| 173 | int Mount_By_Block(string Block, bool Display_Error); // Mounts partition based on block device (e.g. /dev/block/mmcblk1p1) |
| 174 | int Mount_By_Name(string Name, bool Display_Error); // Mounts partition based on display name (e.g. System) |
| 175 | int UnMount_By_Path(string Path, bool Display_Error); // Unmounts partition based on path |
| 176 | int UnMount_By_Block(string Block, bool Display_Error); // Unmounts partition based on block device |
| 177 | int UnMount_By_Name(string Name, bool Display_Error); // Unmounts partition based on display name |
| 178 | int Is_Mounted_By_Path(string Path); // Checks if partition is mounted based on path |
| 179 | int Is_Mounted_By_Block(string Block); // Checks if partition is mounted based on block device |
| 180 | int Is_Mounted_By_Name(string Name); // Checks if partition is mounted based on display name |
| 181 | int Mount_Current_Storage(bool Display_Error); // Mounts the current storage location |
| 182 | int Mount_Settings_Storage(bool Display_Error); // Mounts the settings file storage location (usually internal) |
Dees_Troy | 5bf4392 | 2012-09-07 16:07:55 -0400 | [diff] [blame] | 183 | TWPartition* Find_Partition_By_Path(string Path); // Returns a pointer to a partition based on path |
| 184 | TWPartition* Find_Partition_By_Block(string Block); // Returns a pointer to a partition based on block device |
| 185 | TWPartition* Find_Partition_By_Name(string Block); // Returns a pointer to a partition based on name |
Vojtech Bocek | 8b44bbd | 2013-07-25 20:43:29 +0200 | [diff] [blame] | 186 | int Check_Backup_Name(bool Display_Error); // Checks the current backup name to ensure that it is valid |
| 187 | int Run_Backup(); // Initiates a backup in the current storage |
| 188 | int Run_Restore(string Restore_Name); // Restores a backup |
| 189 | void Set_Restore_Files(string Restore_Name); // Used to gather a list of available backup partitions for the user to select for a restore |
| 190 | int Wipe_By_Path(string Path); // Wipes a partition based on path |
| 191 | int Wipe_By_Block(string Block); // Wipes a partition based on block device |
| 192 | int Wipe_By_Name(string Name); // Wipes a partition based on display name |
| 193 | int Factory_Reset(); // Performs a factory reset |
| 194 | int Wipe_Dalvik_Cache(); // Wipes dalvik cache |
| 195 | int Wipe_Rotate_Data(); // Wipes rotation data -- |
| 196 | int Wipe_Battery_Stats(); // Wipe battery stats -- /data/system/batterystats.bin |
| 197 | int Wipe_Android_Secure(); // Wipes android secure |
| 198 | int Format_Data(); // Really formats data on /data/media devices -- also removes encryption |
| 199 | int Wipe_Media_From_Data(); // Removes and recreates the media folder on /data/media devices |
| 200 | void Refresh_Sizes(); // Refreshes size data of partitions |
| 201 | void Update_System_Details(); // Updates fstab, file systems, sizes, etc. |
| 202 | int Decrypt_Device(string Password); // Attempt to decrypt any encrypted partitions |
| 203 | int usb_storage_enable(void); // Enable USB storage mode |
| 204 | int usb_storage_disable(void); // Disable USB storage mode |
| 205 | void Mount_All_Storage(void); // Mounts all storage locations |
| 206 | void UnMount_Main_Partitions(void); // Unmounts system and data if not data/media and boot if boot is mountable |
| 207 | int Partition_SDCard(void); // Repartitions the sdcard |
Dees_Troy | 240e4a7 | 2012-09-04 09:22:39 -0400 | [diff] [blame] | 208 | |
Vojtech Bocek | 8b44bbd | 2013-07-25 20:43:29 +0200 | [diff] [blame] | 209 | int Fix_Permissions(); |
| 210 | void Get_Partition_List(string ListType, std::vector<PartitionList> *Partition_List); |
| 211 | int Fstab_Processed(); // Indicates if the fstab has been processed or not |
| 212 | void Output_Storage_Fstab(); // Creates a /cache/recovery/storage.fstab file with a list of all potential storage locations for app use |
Dees_Troy | a13d74f | 2013-03-24 08:54:55 -0500 | [diff] [blame] | 213 | |
Dees_Troy | 240e4a7 | 2012-09-04 09:22:39 -0400 | [diff] [blame] | 214 | private: |
Dees_Troy | 43d8b00 | 2012-09-17 16:00:01 -0400 | [diff] [blame] | 215 | bool Make_MD5(bool generate_md5, string Backup_Folder, string Backup_Filename); // Generates an MD5 after a backup is made |
Dees_Troy | 093b764 | 2012-09-21 15:59:38 -0400 | [diff] [blame] | 216 | bool Backup_Partition(TWPartition* Part, string Backup_Folder, bool generate_md5, unsigned long long* img_bytes_remaining, unsigned long long* file_bytes_remaining, unsigned long *img_time, unsigned long *file_time, unsigned long long *img_bytes, unsigned long long *file_bytes); |
| 217 | bool Restore_Partition(TWPartition* Part, string Restore_Name, int partition_count); |
Dees_Troy | 8170a92 | 2012-09-18 15:40:25 -0400 | [diff] [blame] | 218 | void Output_Partition(TWPartition* Part); |
Dees_Troy | d21618c | 2012-10-14 18:48:49 -0400 | [diff] [blame] | 219 | int Open_Lun_File(string Partition_Path, string Lun_File); |
Dees_Troy | 43d8b00 | 2012-09-17 16:00:01 -0400 | [diff] [blame] | 220 | |
| 221 | private: |
Dees_Troy | 5112731 | 2012-09-08 13:08:49 -0400 | [diff] [blame] | 222 | std::vector<TWPartition*> Partitions; // Vector list of all partitions |
Dees_Troy | 51a0e82 | 2012-09-05 15:24:24 -0400 | [diff] [blame] | 223 | }; |
Dees_Troy | 240e4a7 | 2012-09-04 09:22:39 -0400 | [diff] [blame] | 224 | |
Dees_Troy | 5bf4392 | 2012-09-07 16:07:55 -0400 | [diff] [blame] | 225 | extern TWPartitionManager PartitionManager; |
| 226 | |
| 227 | #endif // __TWRP_Partition_Manager |