blob: efe08d7609baf9f36ee85d7f92ffa414e8ab8cab [file] [log] [blame]
Dees_Troy240e4a72012-09-04 09:22:39 -04001/* 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_Troy240e4a72012-09-04 09:22:39 -040026#include <vector>
27#include <string>
Dees_Troy5bf43922012-09-07 16:07:55 -040028
29#define MAX_FSTAB_LINE_LENGTH 2048
Dees_Troy240e4a72012-09-04 09:22:39 -040030
Dees_Troy51a0e822012-09-05 15:24:24 -040031using namespace std;
32
Dees_Troya13d74f2013-03-24 08:54:55 -050033struct PartitionList {
34 std::string Display_Name;
35 std::string Mount_Point;
36 unsigned int selected;
37};
38
Dees_Troy240e4a72012-09-04 09:22:39 -040039// Partition class
40class TWPartition
41{
42public:
43 enum Backup_Method_enum {
44 NONE = 0,
45 FILES = 1,
46 DD = 2,
47 FLASH_UTILS = 3,
48 };
49
50public:
51 TWPartition();
52 virtual ~TWPartition();
53
54public:
55 virtual bool Is_Mounted(); // Checks mount to see if the partition is currently mounted
56 virtual bool Mount(bool Display_Error); // Mounts the partition if it is not mounted
57 virtual bool UnMount(bool Display_Error); // Unmounts the partition if it is mounted
Gary Peck43acadf2012-11-21 21:19:01 -080058 virtual bool Wipe(string New_File_System); // Wipes the partition
Dees_Troy240e4a72012-09-04 09:22:39 -040059 virtual bool Wipe(); // Wipes the partition
Dees_Troye58d5262012-09-21 12:27:57 -040060 virtual bool Wipe_AndSec(); // Wipes android secure
Dees_Troy240e4a72012-09-04 09:22:39 -040061 virtual bool Backup(string backup_folder); // Backs up the partition to the folder specified
Dees_Troy43d8b002012-09-17 16:00:01 -040062 virtual bool Check_MD5(string restore_folder); // Checks MD5 of a backup
Dees_Troy240e4a72012-09-04 09:22:39 -040063 virtual bool Restore(string restore_folder); // Restores the partition using the backup folder provided
Dees_Troy51127312012-09-08 13:08:49 -040064 virtual string Backup_Method_By_Name(); // Returns a string of the backup method for human readable output
Dees_Troy240e4a72012-09-04 09:22:39 -040065 virtual bool Decrypt(string Password); // Decrypts the partition, return 0 for failure and -1 for success
66 virtual bool Wipe_Encryption(); // Ignores wipe commands for /data/media devices and formats the original block device
Dees_Troy5bf43922012-09-07 16:07:55 -040067 virtual void Check_FS_Type(); // Checks the fs type using blkid, does not do anything on MTD / yaffs2 because this crashes on some devices
68 virtual bool Update_Size(bool Display_Error); // Updates size information
Dees_Troy38bd7602012-09-14 13:33:53 -040069 virtual void Recreate_Media_Folder(); // Recreates the /data/media folder
Dees_Troy240e4a72012-09-04 09:22:39 -040070
Dees_Troy7c2dec82012-09-26 09:49:14 -040071public:
72 string Current_File_System; // Current file system
73 string Actual_Block_Device; // Actual block device (one of primary, alternate, or decrypted)
Dees_Troy094207a2012-09-26 12:00:39 -040074 string MTD_Name; // Name of the partition for MTD devices
Dees_Troy7c2dec82012-09-26 09:49:14 -040075
Dees_Troya13d74f2013-03-24 08:54:55 -050076
Dees_Troy240e4a72012-09-04 09:22:39 -040077protected:
Dees_Troy5bf43922012-09-07 16:07:55 -040078 bool Process_Fstab_Line(string Line, bool Display_Error); // Processes a fstab line
Dees_Troy38bd7602012-09-14 13:33:53 -040079 void Find_Actual_Block_Device(); // Determines the correct block device and stores it in Actual_Block_Device
Dees_Troy240e4a72012-09-04 09:22:39 -040080
81protected:
82 bool Can_Be_Mounted; // Indicates that the partition can be mounted
83 bool Can_Be_Wiped; // Indicates that the partition can be wiped
Dees_Troya13d74f2013-03-24 08:54:55 -050084 bool Can_Be_Backed_Up; // Indicates that the partition will show up in the backup list
Dees_Troy51a0e822012-09-05 15:24:24 -040085 bool Wipe_During_Factory_Reset; // Indicates that this partition is wiped during a factory reset
Dees_Troy240e4a72012-09-04 09:22:39 -040086 bool Wipe_Available_in_GUI; // Inidcates that the wipe can be user initiated in the GUI system
87 bool Is_SubPartition; // Indicates that this partition is a sub-partition of another partition (e.g. datadata is a sub-partition of data)
Dees_Troy51127312012-09-08 13:08:49 -040088 bool Has_SubPartition; // Indicates that this partition has a sub-partition
Dees_Troy5bf43922012-09-07 16:07:55 -040089 string SubPartition_Of; // Indicates which partition is the parent partition of this partition (e.g. /data is the parent partition of /datadata)
Dees_Troy240e4a72012-09-04 09:22:39 -040090 string Symlink_Path; // Symlink path (e.g. /data/media)
91 string Symlink_Mount_Point; // /sdcard could be the symlink mount point for /data/media
92 string Mount_Point; // Mount point for this partition (e.g. /system or /data)
Dees_Troye58d5262012-09-21 12:27:57 -040093 string Backup_Path; // Path for backup
Dees_Troy38bd7602012-09-14 13:33:53 -040094 string Primary_Block_Device; // Block device (e.g. /dev/block/mmcblk1p1)
Dees_Troy240e4a72012-09-04 09:22:39 -040095 string Alternate_Block_Device; // Alternate block device (e.g. /dev/block/mmcblk1)
Dees_Troy38bd7602012-09-14 13:33:53 -040096 string Decrypted_Block_Device; // Decrypted block device available after decryption
Dees_Troy240e4a72012-09-04 09:22:39 -040097 bool Removable; // Indicates if this partition is removable -- affects how often we check overall size, if present, etc.
98 bool Is_Present; // Indicates if the partition is currently present as a block device
99 int Length; // Used by make_ext4fs to leave free space at the end of the partition block for things like a crypto footer
100 unsigned long long Size; // Overall size of the partition
101 unsigned long long Used; // Overall used space
102 unsigned long long Free; // Overall free space
103 unsigned long long Backup_Size; // Backup size -- may be different than used space especially when /data/media is present
104 bool Can_Be_Encrypted; // This partition might be encrypted, affects error handling, can only be true if crypto support is compiled in
105 bool Is_Encrypted; // This partition is thought to be encrypted -- it wouldn't mount for some reason, only avialble with crypto support
106 bool Is_Decrypted; // This partition has successfully been decrypted
Dees_Troy240e4a72012-09-04 09:22:39 -0400107 string Display_Name; // Display name for the GUI
108 string Backup_Name; // Backup name -- used for backup filenames
Dees_Troya13d74f2013-03-24 08:54:55 -0500109 string Backup_Display_Name; // Name displayed in the partition list for backup selection
110 string Storage_Name; // Name displayed in the partition list for storage selection
Dees_Troy63c8df72012-09-10 14:02:05 -0400111 string Backup_FileName; // Actual backup filename
Dees_Troy240e4a72012-09-04 09:22:39 -0400112 Backup_Method_enum Backup_Method; // Method used for backup
Dees_Troy83bd4832013-05-04 12:39:56 +0000113 bool Can_Encrypt_Backup; // Indicates if this item can be encrypted during backup
114 bool Use_Userdata_Encryption; // Indicates if we will use userdata encryption splitting on an encrypted backup
Dees_Troy5bf43922012-09-07 16:07:55 -0400115 bool Has_Data_Media; // Indicates presence of /data/media, may affect wiping and backup methods
Dees_Troye58d5262012-09-21 12:27:57 -0400116 bool Has_Android_Secure; // Indicates the presence of .android_secure on this partition
Dees_Troy5bf43922012-09-07 16:07:55 -0400117 bool Is_Storage; // Indicates if this partition is used for storage for backup, restore, and installing zips
Dees_Troya13d74f2013-03-24 08:54:55 -0500118 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_Troy5bf43922012-09-07 16:07:55 -0400119 string Storage_Path; // Indicates the path to the storage -- root indicates mount point, media/ indicates e.g. /data/media
Dees_Troy5bf43922012-09-07 16:07:55 -0400120 string Fstab_File_System; // File system from the recovery.fstab
121 int Format_Block_Size; // Block size for formatting
Dees_Troy68cab492012-12-12 19:29:35 +0000122 bool Ignore_Blkid; // Ignore blkid results due to superblocks lying to us on certain devices / partitions
Dees_Troy16c2b312013-01-15 16:51:18 +0000123 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_Troy85f44ed2013-01-09 18:42:36 +0000124#ifdef TW_INCLUDE_CRYPTO_SAMSUNG
125 string EcryptFS_Password; // Have to store the encryption password to remount
126#endif
Dees_Troy240e4a72012-09-04 09:22:39 -0400127
128private:
Dees_Troy51127312012-09-08 13:08:49 -0400129 bool Process_Flags(string Flags, bool Display_Error); // Process custom fstab flags
Dees_Troy5bf43922012-09-07 16:07:55 -0400130 bool Is_File_System(string File_System); // Checks to see if the file system given is considered a file system
131 bool Is_Image(string File_System); // Checks to see if the file system given is considered an image
132 void Setup_File_System(bool Display_Error); // Sets defaults for a file system partition
133 void Setup_Image(bool Display_Error); // Sets defaults for an image partition
Dees_Troye58d5262012-09-21 12:27:57 -0400134 void Setup_AndSec(void); // Sets up .android_secure settings
Dees_Troy5bf43922012-09-07 16:07:55 -0400135 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
136 bool Find_Partition_Size(); // Finds the partition size from /proc/partitions
Dees_Troy5bf43922012-09-07 16:07:55 -0400137 unsigned long long Get_Size_Via_du(string Path, bool Display_Error); // Uses du to get sizes
Gary Peck43acadf2012-11-21 21:19:01 -0800138 bool Wipe_EXT23(string File_System); // Formats as ext3 or ext2
Dees_Troy240e4a72012-09-04 09:22:39 -0400139 bool Wipe_EXT4(); // Formats using ext4, uses make_ext4fs when present
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500140 bool Wipe_FAT(); // Formats as FAT if mkdosfs exits otherwise rm -rf wipe
141 bool Wipe_EXFAT(); // Formats as EXFAT
Dees_Troye58d5262012-09-21 12:27:57 -0400142 bool Wipe_MTD(); // Formats as yaffs2 for MTD memory types
Dees_Troy240e4a72012-09-04 09:22:39 -0400143 bool Wipe_RMRF(); // Uses rm -rf to wipe
144 bool Wipe_Data_Without_Wiping_Media(); // Uses rm -rf to wipe but does not wipe /data/media
145 bool Backup_Tar(string backup_folder); // Backs up using tar for file systems
146 bool Backup_DD(string backup_folder); // Backs up using dd for emmc memory types
147 bool Backup_Dump_Image(string backup_folder); // Backs up using dump_image for MTD memory types
Gary Peck43acadf2012-11-21 21:19:01 -0800148 bool Restore_Tar(string restore_folder, string Restore_File_System); // Restore using tar for file systems
Dees_Troy240e4a72012-09-04 09:22:39 -0400149 bool Restore_DD(string restore_folder); // Restore using dd for emmc memory types
150 bool Restore_Flash_Image(string restore_folder); // Restore using flash_image for MTD memory types
Dees_Troy51127312012-09-08 13:08:49 -0400151 bool Get_Size_Via_statfs(bool Display_Error); // Get Partition size, used, and free space using statfs
152 bool Get_Size_Via_df(bool Display_Error); // Get Partition size, used, and free space using df command
Dees_Troy51127312012-09-08 13:08:49 -0400153 bool Make_Dir(string Path, bool Display_Error); // Creates a directory if it doesn't already exist
Dees_Troy38bd7602012-09-14 13:33:53 -0400154 bool Find_MTD_Block_Device(string MTD_Name); // Finds the mtd block device based on the name from the fstab
Dees_Troye58d5262012-09-21 12:27:57 -0400155 void Recreate_AndSec_Folder(void); // Recreates the .android_secure folder
Dees_Troy8e337f32012-10-13 22:07:49 -0400156 void Mount_Storage_Retry(void); // Tries multiple times with a half second delay to mount a device in case storage is slow to mount
Dees_Troy240e4a72012-09-04 09:22:39 -0400157
158friend class TWPartitionManager;
Dees_Troya13d74f2013-03-24 08:54:55 -0500159friend class DataManager;
160friend class GUIPartitionList;
Dees_Troy51a0e822012-09-05 15:24:24 -0400161};
Dees_Troy240e4a72012-09-04 09:22:39 -0400162
163class TWPartitionManager
164{
165public:
Dees_Troy5bf43922012-09-07 16:07:55 -0400166 TWPartitionManager() {}
167 virtual ~TWPartitionManager() {}
168
169public:
170 virtual int Process_Fstab(string Fstab_Filename, bool Display_Error); // Parses the fstab and populates the partitions
171 virtual int Write_Fstab(); // Creates /etc/fstab file that's used by the command line for mount commands
Dees_Troy8170a922012-09-18 15:40:25 -0400172 virtual void Output_Partition_Logging(); // Outputs partition information to the log
Dees_Troy5bf43922012-09-07 16:07:55 -0400173 virtual int Mount_By_Path(string Path, bool Display_Error); // Mounts partition based on path (e.g. /system)
174 virtual int Mount_By_Block(string Block, bool Display_Error); // Mounts partition based on block device (e.g. /dev/block/mmcblk1p1)
175 virtual int Mount_By_Name(string Name, bool Display_Error); // Mounts partition based on display name (e.g. System)
176 virtual int UnMount_By_Path(string Path, bool Display_Error); // Unmounts partition based on path
177 virtual int UnMount_By_Block(string Block, bool Display_Error); // Unmounts partition based on block device
178 virtual int UnMount_By_Name(string Name, bool Display_Error); // Unmounts partition based on display name
179 virtual int Is_Mounted_By_Path(string Path); // Checks if partition is mounted based on path
180 virtual int Is_Mounted_By_Block(string Block); // Checks if partition is mounted based on block device
181 virtual int Is_Mounted_By_Name(string Name); // Checks if partition is mounted based on display name
182 virtual int Mount_Current_Storage(bool Display_Error); // Mounts the current storage location
183 virtual int Mount_Settings_Storage(bool Display_Error); // Mounts the settings file storage location (usually internal)
184 TWPartition* Find_Partition_By_Path(string Path); // Returns a pointer to a partition based on path
185 TWPartition* Find_Partition_By_Block(string Block); // Returns a pointer to a partition based on block device
186 TWPartition* Find_Partition_By_Name(string Block); // Returns a pointer to a partition based on name
Dees_Troyc9ff7a32012-09-27 10:09:41 -0400187 virtual int Check_Backup_Name(bool Display_Error); // Checks the current backup name to ensure that it is valid
Dees_Troy43d8b002012-09-17 16:00:01 -0400188 virtual int Run_Backup(); // Initiates a backup in the current storage
Dees_Troy5bf43922012-09-07 16:07:55 -0400189 virtual int Run_Restore(string Restore_Name); // Restores a backup
190 virtual void Set_Restore_Files(string Restore_Name); // Used to gather a list of available backup partitions for the user to select for a restore
191 virtual int Wipe_By_Path(string Path); // Wipes a partition based on path
192 virtual int Wipe_By_Block(string Block); // Wipes a partition based on block device
193 virtual int Wipe_By_Name(string Name); // Wipes a partition based on display name
194 virtual int Factory_Reset(); // Performs a factory reset
Dees_Troy38bd7602012-09-14 13:33:53 -0400195 virtual int Wipe_Dalvik_Cache(); // Wipes dalvik cache
196 virtual int Wipe_Rotate_Data(); // Wipes rotation data --
197 virtual int Wipe_Battery_Stats(); // Wipe battery stats -- /data/system/batterystats.bin
Dees_Troy2ff5a8d2012-09-26 14:53:02 -0400198 virtual int Wipe_Android_Secure(); // Wipes android secure
Dees_Troy38bd7602012-09-14 13:33:53 -0400199 virtual int Format_Data(); // Really formats data on /data/media devices -- also removes encryption
200 virtual int Wipe_Media_From_Data(); // Removes and recreates the media folder on /data/media devices
Dees_Troy5bf43922012-09-07 16:07:55 -0400201 virtual void Refresh_Sizes(); // Refreshes size data of partitions
202 virtual void Update_System_Details(); // Updates fstab, file systems, sizes, etc.
203 virtual int Decrypt_Device(string Password); // Attempt to decrypt any encrypted partitions
Dees_Troy8170a922012-09-18 15:40:25 -0400204 virtual int usb_storage_enable(void); // Enable USB storage mode
205 virtual int usb_storage_disable(void); // Disable USB storage mode
Dees_Troy812660f2012-09-20 09:55:17 -0400206 virtual void Mount_All_Storage(void); // Mounts all storage locations
Dees_Troyd0384ef2012-10-12 12:15:42 -0400207 virtual void UnMount_Main_Partitions(void); // Unmounts system and data if not data/media and boot if boot is mountable
Dees_Troy9350b8d2012-09-27 12:38:38 -0400208 virtual int Partition_SDCard(void); // Repartitions the sdcard
Dees_Troy240e4a72012-09-04 09:22:39 -0400209
bigbiff bigbiffa0f8a592012-10-09 21:01:03 -0400210 virtual int Fix_Permissions();
Dees_Troya13d74f2013-03-24 08:54:55 -0500211 virtual void Get_Partition_List(string ListType, std::vector<PartitionList> *Partition_List);
212 virtual int Fstab_Processed(); // Indicates if the fstab has been processed or not
Dees_Troyd93bda52013-07-03 19:55:19 +0000213 virtual void Output_Storage_Fstab(); // Creates a /cache/recovery/storage.fstab file with a list of all potential storage locations for app use
Dees_Troya13d74f2013-03-24 08:54:55 -0500214
Dees_Troy240e4a72012-09-04 09:22:39 -0400215private:
Dees_Troy43d8b002012-09-17 16:00:01 -0400216 bool Make_MD5(bool generate_md5, string Backup_Folder, string Backup_Filename); // Generates an MD5 after a backup is made
Dees_Troy093b7642012-09-21 15:59:38 -0400217 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);
218 bool Restore_Partition(TWPartition* Part, string Restore_Name, int partition_count);
Dees_Troy8170a922012-09-18 15:40:25 -0400219 void Output_Partition(TWPartition* Part);
Dees_Troyd21618c2012-10-14 18:48:49 -0400220 int Open_Lun_File(string Partition_Path, string Lun_File);
Dees_Troy43d8b002012-09-17 16:00:01 -0400221
222private:
Dees_Troy51127312012-09-08 13:08:49 -0400223 std::vector<TWPartition*> Partitions; // Vector list of all partitions
Dees_Troy51a0e822012-09-05 15:24:24 -0400224};
Dees_Troy240e4a72012-09-04 09:22:39 -0400225
Dees_Troy5bf43922012-09-07 16:07:55 -0400226extern TWPartitionManager PartitionManager;
227
228#endif // __TWRP_Partition_Manager