blob: c04f0cff9420b85a666ba4f20af15b36acc5df25 [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_Troy240e4a72012-09-04 09:22:39 -040033// Partition class
34class TWPartition
35{
36public:
37 enum Backup_Method_enum {
38 NONE = 0,
39 FILES = 1,
40 DD = 2,
41 FLASH_UTILS = 3,
42 };
43
44public:
45 TWPartition();
46 virtual ~TWPartition();
47
48public:
49 virtual bool Is_Mounted(); // Checks mount to see if the partition is currently mounted
50 virtual bool Mount(bool Display_Error); // Mounts the partition if it is not mounted
51 virtual bool UnMount(bool Display_Error); // Unmounts the partition if it is mounted
52 virtual bool Wipe(); // Wipes the partition
Dees_Troye58d5262012-09-21 12:27:57 -040053 virtual bool Wipe_AndSec(); // Wipes android secure
Dees_Troy240e4a72012-09-04 09:22:39 -040054 virtual bool Backup(string backup_folder); // Backs up the partition to the folder specified
Dees_Troy43d8b002012-09-17 16:00:01 -040055 virtual bool Check_MD5(string restore_folder); // Checks MD5 of a backup
Dees_Troy240e4a72012-09-04 09:22:39 -040056 virtual bool Restore(string restore_folder); // Restores the partition using the backup folder provided
Dees_Troy51127312012-09-08 13:08:49 -040057 virtual string Backup_Method_By_Name(); // Returns a string of the backup method for human readable output
Dees_Troy240e4a72012-09-04 09:22:39 -040058 virtual bool Decrypt(string Password); // Decrypts the partition, return 0 for failure and -1 for success
59 virtual bool Wipe_Encryption(); // Ignores wipe commands for /data/media devices and formats the original block device
Dees_Troy5bf43922012-09-07 16:07:55 -040060 virtual void Check_FS_Type(); // Checks the fs type using blkid, does not do anything on MTD / yaffs2 because this crashes on some devices
61 virtual bool Update_Size(bool Display_Error); // Updates size information
Dees_Troy38bd7602012-09-14 13:33:53 -040062 virtual void Recreate_Media_Folder(); // Recreates the /data/media folder
Dees_Troy240e4a72012-09-04 09:22:39 -040063
64protected:
Dees_Troy5bf43922012-09-07 16:07:55 -040065 bool Process_Fstab_Line(string Line, bool Display_Error); // Processes a fstab line
Dees_Troy38bd7602012-09-14 13:33:53 -040066 void Find_Actual_Block_Device(); // Determines the correct block device and stores it in Actual_Block_Device
Dees_Troy240e4a72012-09-04 09:22:39 -040067
68protected:
69 bool Can_Be_Mounted; // Indicates that the partition can be mounted
70 bool Can_Be_Wiped; // Indicates that the partition can be wiped
Dees_Troy51a0e822012-09-05 15:24:24 -040071 bool Wipe_During_Factory_Reset; // Indicates that this partition is wiped during a factory reset
Dees_Troy240e4a72012-09-04 09:22:39 -040072 bool Wipe_Available_in_GUI; // Inidcates that the wipe can be user initiated in the GUI system
73 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 -040074 bool Has_SubPartition; // Indicates that this partition has a sub-partition
Dees_Troy5bf43922012-09-07 16:07:55 -040075 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 -040076 string Symlink_Path; // Symlink path (e.g. /data/media)
77 string Symlink_Mount_Point; // /sdcard could be the symlink mount point for /data/media
78 string Mount_Point; // Mount point for this partition (e.g. /system or /data)
Dees_Troye58d5262012-09-21 12:27:57 -040079 string Backup_Path; // Path for backup
Dees_Troy38bd7602012-09-14 13:33:53 -040080 string Actual_Block_Device; // Actual block device (one of primary, alternate, or decrypted)
81 string Primary_Block_Device; // Block device (e.g. /dev/block/mmcblk1p1)
Dees_Troy240e4a72012-09-04 09:22:39 -040082 string Alternate_Block_Device; // Alternate block device (e.g. /dev/block/mmcblk1)
Dees_Troy38bd7602012-09-14 13:33:53 -040083 string Decrypted_Block_Device; // Decrypted block device available after decryption
Dees_Troy240e4a72012-09-04 09:22:39 -040084 bool Removable; // Indicates if this partition is removable -- affects how often we check overall size, if present, etc.
85 bool Is_Present; // Indicates if the partition is currently present as a block device
86 int Length; // Used by make_ext4fs to leave free space at the end of the partition block for things like a crypto footer
87 unsigned long long Size; // Overall size of the partition
88 unsigned long long Used; // Overall used space
89 unsigned long long Free; // Overall free space
90 unsigned long long Backup_Size; // Backup size -- may be different than used space especially when /data/media is present
91 bool Can_Be_Encrypted; // This partition might be encrypted, affects error handling, can only be true if crypto support is compiled in
92 bool Is_Encrypted; // This partition is thought to be encrypted -- it wouldn't mount for some reason, only avialble with crypto support
93 bool Is_Decrypted; // This partition has successfully been decrypted
Dees_Troy240e4a72012-09-04 09:22:39 -040094 string Display_Name; // Display name for the GUI
95 string Backup_Name; // Backup name -- used for backup filenames
Dees_Troy63c8df72012-09-10 14:02:05 -040096 string Backup_FileName; // Actual backup filename
Dees_Troy38bd7602012-09-14 13:33:53 -040097 string MTD_Name; // Name of the partition for MTD devices
Dees_Troy240e4a72012-09-04 09:22:39 -040098 Backup_Method_enum Backup_Method; // Method used for backup
Dees_Troy5bf43922012-09-07 16:07:55 -040099 bool Has_Data_Media; // Indicates presence of /data/media, may affect wiping and backup methods
Dees_Troye58d5262012-09-21 12:27:57 -0400100 bool Has_Android_Secure; // Indicates the presence of .android_secure on this partition
Dees_Troy5bf43922012-09-07 16:07:55 -0400101 bool Is_Storage; // Indicates if this partition is used for storage for backup, restore, and installing zips
102 string Storage_Path; // Indicates the path to the storage -- root indicates mount point, media/ indicates e.g. /data/media
103 string Current_File_System; // Current file system
104 string Fstab_File_System; // File system from the recovery.fstab
105 int Format_Block_Size; // Block size for formatting
Dees_Troy240e4a72012-09-04 09:22:39 -0400106
107private:
Dees_Troy51127312012-09-08 13:08:49 -0400108 bool Process_Flags(string Flags, bool Display_Error); // Process custom fstab flags
Dees_Troy5bf43922012-09-07 16:07:55 -0400109 bool Is_File_System(string File_System); // Checks to see if the file system given is considered a file system
110 bool Is_Image(string File_System); // Checks to see if the file system given is considered an image
111 void Setup_File_System(bool Display_Error); // Sets defaults for a file system partition
112 void Setup_Image(bool Display_Error); // Sets defaults for an image partition
Dees_Troye58d5262012-09-21 12:27:57 -0400113 void Setup_AndSec(void); // Sets up .android_secure settings
Dees_Troy5bf43922012-09-07 16:07:55 -0400114 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
115 bool Find_Partition_Size(); // Finds the partition size from /proc/partitions
Dees_Troy5bf43922012-09-07 16:07:55 -0400116 unsigned long long Get_Size_Via_du(string Path, bool Display_Error); // Uses du to get sizes
117 void Flip_Block_Device(); // Flips the Block_Device and Alternate_Block_Device
Dees_Troy240e4a72012-09-04 09:22:39 -0400118 bool Wipe_EXT23(); // Formats as ext3 or ext2
119 bool Wipe_EXT4(); // Formats using ext4, uses make_ext4fs when present
120 bool Wipe_FAT(); // Formats as FAT except that mkdosfs from busybox usually fails so oftentimes this is actually a rm -rf wipe
Dees_Troye58d5262012-09-21 12:27:57 -0400121 bool Wipe_MTD(); // Formats as yaffs2 for MTD memory types
Dees_Troy240e4a72012-09-04 09:22:39 -0400122 bool Wipe_RMRF(); // Uses rm -rf to wipe
123 bool Wipe_Data_Without_Wiping_Media(); // Uses rm -rf to wipe but does not wipe /data/media
124 bool Backup_Tar(string backup_folder); // Backs up using tar for file systems
125 bool Backup_DD(string backup_folder); // Backs up using dd for emmc memory types
126 bool Backup_Dump_Image(string backup_folder); // Backs up using dump_image for MTD memory types
127 bool Restore_Tar(string restore_folder); // Restore using tar for file systems
128 bool Restore_DD(string restore_folder); // Restore using dd for emmc memory types
129 bool Restore_Flash_Image(string restore_folder); // Restore using flash_image for MTD memory types
Dees_Troy51127312012-09-08 13:08:49 -0400130 bool Get_Size_Via_statfs(bool Display_Error); // Get Partition size, used, and free space using statfs
131 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 -0400132 bool Make_Dir(string Path, bool Display_Error); // Creates a directory if it doesn't already exist
Dees_Troy38bd7602012-09-14 13:33:53 -0400133 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 -0400134 void Recreate_AndSec_Folder(void); // Recreates the .android_secure folder
Dees_Troy240e4a72012-09-04 09:22:39 -0400135
136friend class TWPartitionManager;
Dees_Troy51a0e822012-09-05 15:24:24 -0400137};
Dees_Troy240e4a72012-09-04 09:22:39 -0400138
139class TWPartitionManager
140{
141public:
Dees_Troy5bf43922012-09-07 16:07:55 -0400142 TWPartitionManager() {}
143 virtual ~TWPartitionManager() {}
144
145public:
146 virtual int Process_Fstab(string Fstab_Filename, bool Display_Error); // Parses the fstab and populates the partitions
147 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 -0400148 virtual void Output_Partition_Logging(); // Outputs partition information to the log
Dees_Troy5bf43922012-09-07 16:07:55 -0400149 virtual int Mount_By_Path(string Path, bool Display_Error); // Mounts partition based on path (e.g. /system)
150 virtual int Mount_By_Block(string Block, bool Display_Error); // Mounts partition based on block device (e.g. /dev/block/mmcblk1p1)
151 virtual int Mount_By_Name(string Name, bool Display_Error); // Mounts partition based on display name (e.g. System)
152 virtual int UnMount_By_Path(string Path, bool Display_Error); // Unmounts partition based on path
153 virtual int UnMount_By_Block(string Block, bool Display_Error); // Unmounts partition based on block device
154 virtual int UnMount_By_Name(string Name, bool Display_Error); // Unmounts partition based on display name
155 virtual int Is_Mounted_By_Path(string Path); // Checks if partition is mounted based on path
156 virtual int Is_Mounted_By_Block(string Block); // Checks if partition is mounted based on block device
157 virtual int Is_Mounted_By_Name(string Name); // Checks if partition is mounted based on display name
158 virtual int Mount_Current_Storage(bool Display_Error); // Mounts the current storage location
159 virtual int Mount_Settings_Storage(bool Display_Error); // Mounts the settings file storage location (usually internal)
160 TWPartition* Find_Partition_By_Path(string Path); // Returns a pointer to a partition based on path
161 TWPartition* Find_Partition_By_Block(string Block); // Returns a pointer to a partition based on block device
162 TWPartition* Find_Partition_By_Name(string Block); // Returns a pointer to a partition based on name
Dees_Troy43d8b002012-09-17 16:00:01 -0400163 virtual int Run_Backup(); // Initiates a backup in the current storage
Dees_Troy5bf43922012-09-07 16:07:55 -0400164 virtual int Run_Restore(string Restore_Name); // Restores a backup
165 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
166 virtual int Wipe_By_Path(string Path); // Wipes a partition based on path
167 virtual int Wipe_By_Block(string Block); // Wipes a partition based on block device
168 virtual int Wipe_By_Name(string Name); // Wipes a partition based on display name
169 virtual int Factory_Reset(); // Performs a factory reset
Dees_Troy38bd7602012-09-14 13:33:53 -0400170 virtual int Wipe_Dalvik_Cache(); // Wipes dalvik cache
171 virtual int Wipe_Rotate_Data(); // Wipes rotation data --
172 virtual int Wipe_Battery_Stats(); // Wipe battery stats -- /data/system/batterystats.bin
173 virtual int Format_Data(); // Really formats data on /data/media devices -- also removes encryption
174 virtual int Wipe_Media_From_Data(); // Removes and recreates the media folder on /data/media devices
Dees_Troy5bf43922012-09-07 16:07:55 -0400175 virtual void Refresh_Sizes(); // Refreshes size data of partitions
176 virtual void Update_System_Details(); // Updates fstab, file systems, sizes, etc.
177 virtual int Decrypt_Device(string Password); // Attempt to decrypt any encrypted partitions
Dees_Troy38bd7602012-09-14 13:33:53 -0400178 virtual int Fix_Permissions(); // Fixes permissions in /system and /data
Dees_Troy8170a922012-09-18 15:40:25 -0400179 virtual int usb_storage_enable(void); // Enable USB storage mode
180 virtual int usb_storage_disable(void); // Disable USB storage mode
Dees_Troy812660f2012-09-20 09:55:17 -0400181 virtual void Mount_All_Storage(void); // Mounts all storage locations
Dees_Troy240e4a72012-09-04 09:22:39 -0400182
183private:
Dees_Troy43d8b002012-09-17 16:00:01 -0400184 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 -0400185 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);
186 bool Restore_Partition(TWPartition* Part, string Restore_Name, int partition_count);
Dees_Troy8170a922012-09-18 15:40:25 -0400187 void Output_Partition(TWPartition* Part);
Dees_Troy43d8b002012-09-17 16:00:01 -0400188
189private:
Dees_Troy51127312012-09-08 13:08:49 -0400190 std::vector<TWPartition*> Partitions; // Vector list of all partitions
Dees_Troy51a0e822012-09-05 15:24:24 -0400191};
Dees_Troy240e4a72012-09-04 09:22:39 -0400192
Dees_Troy5bf43922012-09-07 16:07:55 -0400193extern TWPartitionManager PartitionManager;
194
195#endif // __TWRP_Partition_Manager