blob: bdcea55f7709c4c3a2841e780fe7e60d830ce35c [file] [log] [blame]
Dees Troy3be70a82013-10-22 14:25:12 +00001/*
bigbiffaed1bdf2021-08-03 18:21:39 -04002 Copyright 2014 to 2021 TeamWin
Dees Troy3be70a82013-10-22 14:25:12 +00003 This file is part of TWRP/TeamWin Recovery Project.
4
5 TWRP is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
9
10 TWRP is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with TWRP. If not, see <http://www.gnu.org/licenses/>.
17*/
Dees_Troy240e4a72012-09-04 09:22:39 -040018
19#ifndef __TWRP_Partition_Manager
20#define __TWRP_Partition_Manager
21
Ethan Yonker6e8c27a2016-12-22 17:55:57 -060022#include <map>
Dees_Troy240e4a72012-09-04 09:22:39 -040023#include <vector>
24#include <string>
Ethan Yonker6e8c27a2016-12-22 17:55:57 -060025#include <sys/poll.h>
Ethan Yonker3fdcda42016-11-30 12:29:37 -060026#include "exclude.hpp"
bigbiff7abc5fe2015-01-17 16:53:12 -050027#include "tw_atomic.hpp"
Ethan Yonker472f5062016-02-25 13:47:30 -060028#include "progresstracking.hpp"
bigbiffa957f072021-03-07 18:20:29 -050029#ifdef TW_INCLUDE_CRYPTO
30#include "fscrypt_policy.h"
31#endif
Mohd Faraze3948ec2020-08-14 01:40:59 +000032#include "twrpApex.hpp"
Dees_Troy5bf43922012-09-07 16:07:55 -040033
34#define MAX_FSTAB_LINE_LENGTH 2048
Dees_Troy240e4a72012-09-04 09:22:39 -040035
Ethan Yonker53796e72019-01-11 22:49:52 -060036#define REPACK_ORIG_DIR "/tmp/repackorig/"
37#define REPACK_NEW_DIR "/tmp/repacknew/"
38
Mohd Faraz446ccbf2023-01-24 19:58:24 +010039#define NOT_AVAILABLE -2
40
Dees_Troy51a0e822012-09-05 15:24:24 -040041using namespace std;
42
Ethan Yonker93382822018-11-01 15:25:31 -050043// BasePartition is used for overriding so we can run custom, device
44// specific code.
45class BasePartition {
46 public:
47 explicit BasePartition() {}
48 virtual ~BasePartition() {}
49
50 virtual bool PreWipeEncryption() {
51 return true;
52 }
53
54 virtual bool PostWipeEncryption() {
55 return true;
56 }
57};
58BasePartition* make_partition();
59
Dees_Troya13d74f2013-03-24 08:54:55 -050060struct PartitionList {
61 std::string Display_Name;
62 std::string Mount_Point;
63 unsigned int selected;
64};
65
Ethan Yonker6e8c27a2016-12-22 17:55:57 -060066struct Uevent_Block_Data {
67 std::string action;
68 std::string subsystem;
69 std::string block_device;
70 std::string type;
71 std::string sysfs_path;
72 int major;
73 int minor;
74};
75
76struct Flags_Map {
77 std::string Primary_Block_Device;
78 std::string Alternate_Block_Device;
79 std::string File_System;
80 std::string Flags;
81 char* fstab_line;
82};
83
84enum PartitionManager_Op { // PartitionManager Restore Mode for Raw_Read_Write()
bigbiffce8f83c2015-12-12 18:30:21 -050085 PM_BACKUP = 0,
86 PM_RESTORE = 1,
87};
88
89class TWPartition;
90
Ethan Yonker6e8c27a2016-12-22 17:55:57 -060091struct PartitionSettings { // Settings for backup session
Ethan Yonkere080c1f2016-09-19 13:50:25 -050092 TWPartition* Part; // Partition to pass to the partition backup loop
93 std::string Backup_Folder; // Path to restore folder
94 bool adbbackup; // tell the system we are backing up over adb
95 bool adb_compression; // 0 == uncompressed, 1 == compressed
bigbiffee7b7ff2020-03-23 15:08:27 -040096 bool generate_digest; // tell system to create digest for partitions
Ethan Yonkere080c1f2016-09-19 13:50:25 -050097 bool generate_md5; // tell system to create md5 for partitions
98 uint64_t total_restore_size; // Total size of restored backup
99 uint64_t img_bytes_remaining; // remaining img/emmc bytes to backup for progress indicator
100 uint64_t file_bytes_remaining; // remaining file bytes to backup for progress indicator
101 uint64_t img_time; // used to calculate how fast we backup images
102 uint64_t file_time; // used to calculate how fast we backup files
103 uint64_t img_bytes; // total image bytes of all emmc partitions
104 uint64_t file_bytes; // total file bytes of all file based partitions
105 int partition_count; // Number of partitions to restore
106 ProgressTracking *progress; // Keep track of progress in GUI
107 enum PartitionManager_Op PM_Method; // Current operation of backup or restore
bigbiffce8f83c2015-12-12 18:30:21 -0500108};
109
110enum Backup_Method_enum {
111 BM_NONE = 0,
112 BM_FILES = 1,
113 BM_DD = 2,
114 BM_FLASH_UTILS = 3,
115};
116
Dees_Troy240e4a72012-09-04 09:22:39 -0400117// Partition class
118class TWPartition
119{
120public:
that9e0593e2014-10-08 00:01:24 +0200121 TWPartition();
Dees_Troy240e4a72012-09-04 09:22:39 -0400122 virtual ~TWPartition();
123
124public:
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200125 bool Is_Mounted(); // Checks mount to see if the partition is currently mounted
James Christopher Adduonod6f94ac2016-02-29 04:26:04 -0500126 bool Is_File_System_Writable(); // Checks if the root directory of the file system can be written to
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200127 bool Mount(bool Display_Error); // Mounts the partition if it is not mounted
128 bool UnMount(bool Display_Error); // Unmounts the partition if it is mounted
James Christopher Adduonod6f94ac2016-02-29 04:26:04 -0500129 bool ReMount(bool Display_Error); // Remounts the partition
130 bool ReMount_RW(bool Display_Error); // Remounts the partition with read/write access
bigbiffbe4f46c2021-04-24 11:48:54 -0400131 bool Bind_Mount(bool Display_Error); // Bind mount partition if symlink mountpoint is populated
me-cafebabe76693202022-07-29 06:12:38 +0800132 bool BlkDiscard(); // Clear the partition using BLKDISCARD ioctl
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200133 bool Wipe(string New_File_System); // Wipes the partition
134 bool Wipe(); // Wipes the partition
135 bool Wipe_AndSec(); // Wipes android secure
bigbiffaed1bdf2021-08-03 18:21:39 -0400136 bool Wipe_Data_Cache(); // Wipe /data/cache with devices that have no cache partition
Ethan Yonker87c7bac2014-05-25 21:41:08 -0500137 bool Can_Repair(); // Checks to see if we have everything needed to be able to repair the current file system
Andreas Blaesius123fcd02015-11-16 01:40:36 +0200138 uint64_t Get_Max_FileSize(); // get partition maxFileSie
Ethan Yonker87c7bac2014-05-25 21:41:08 -0500139 bool Repair(); // Repairs the current file system
Ethan Yonkera2719152015-05-28 09:44:41 -0500140 bool Can_Resize(); // Checks to see if we have everything needed to be able to resize the current file system
141 bool Resize(); // Resizes the current file system
bigbiffce8f83c2015-12-12 18:30:21 -0500142 bool Backup(PartitionSettings *part_settings, pid_t *tar_fork_pid); // Backs up the partition to the folder specified
bigbiffce8f83c2015-12-12 18:30:21 -0500143 bool Restore(PartitionSettings *part_settings); // Restores the partition using the backup folder provided
Ethan Yonkere080c1f2016-09-19 13:50:25 -0500144 unsigned long long Get_Restore_Size(PartitionSettings *part_settings); // Returns the overall restore size of the backup
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200145 string Backup_Method_By_Name(); // Returns a string of the backup method for human readable output
146 bool Decrypt(string Password); // Decrypts the partition, return 0 for failure and -1 for success
147 bool Wipe_Encryption(); // Ignores wipe commands for /data/media devices and formats the original block device
148 void Check_FS_Type(); // Checks the fs type using blkid, does not do anything on MTD / yaffs2 because this crashes on some devices
149 bool Update_Size(bool Display_Error); // Updates size information
150 void Recreate_Media_Folder(); // Recreates the /data/media folder
bigbiffce8f83c2015-12-12 18:30:21 -0500151 bool Flash_Image(PartitionSettings *part_settings); // Flashes an image to the partition
Ethan Yonkereb32b1f2015-05-18 10:23:03 -0500152 void Change_Mount_Read_Only(bool new_value); // Changes Mount_Read_Only to new_value
bigbiffce8f83c2015-12-12 18:30:21 -0500153 bool Is_Read_Only(); // Check if system is read-only in TWRP
Ethan Yonkereb32b1f2015-05-18 10:23:03 -0500154 int Check_Lifetime_Writes();
Ethan Yonker66a19492015-12-10 10:19:45 -0600155 int Decrypt_Adopted();
156 void Revert_Adopted();
Matt Mower72c87ce2016-04-26 14:34:56 -0500157 void Partition_Post_Processing(bool Display_Error); // Apply partition specific settings after fstab processed
bigbiffad58e1b2020-07-06 20:24:34 -0400158 void Set_Backup_FileName(string fname); // Set backup filename for partition
159 std::string Get_Backup_FileName(); // Get the backup filename for the partition
bigbiff bigbiffb5ecaad2017-03-20 18:53:53 -0400160 string Get_Backup_Name(); // Get Backup_Name for partition
Ethan Yonker93382822018-11-01 15:25:31 -0500161 bool Decrypt_FBE_DE(); // If FBE is present, backup exclusions are set up and DE decrypt is attempted
bigbiffee7b7ff2020-03-23 15:08:27 -0400162 string Get_Mount_Point(); // Return Mount_Point or directory the current partition is mounted on
163 bool Get_Super_Status(); // Returns true if partition is a super volume mounted partitions
164 void Set_Can_Be_Backed_Up(bool val); // Update whether the partition can be backed up or not
165 void Set_Can_Be_Wiped(bool val); // Update whether the partition can be wiped or not
bigbiffad58e1b2020-07-06 20:24:34 -0400166 std::string Get_Display_Name(); // Get the display name in the gui for the partition
167 bool Is_SlotSelect(); // Return whether the partition is a slot partition or not
Dees_Troy240e4a72012-09-04 09:22:39 -0400168
Dees_Troy7c2dec82012-09-26 09:49:14 -0400169public:
170 string Current_File_System; // Current file system
171 string Actual_Block_Device; // Actual block device (one of primary, alternate, or decrypted)
bigbiffce8f83c2015-12-12 18:30:21 -0500172 string Backup_Display_Name; // Name displayed in the partition list for backup selection
Dees_Troy094207a2012-09-26 12:00:39 -0400173 string MTD_Name; // Name of the partition for MTD devices
bigbiff bigbiffc7eee6f2014-09-02 18:59:01 -0400174 bool Is_Present; // Indicates if the partition is currently present as a block device
Ethan Yonker253368a2014-11-25 15:00:52 -0600175 string Crypto_Key_Location; // Location of the crypto key used for decrypting encrypted data partitions
Ethan Yonker726a0202014-12-16 20:01:38 -0600176 unsigned int MTP_Storage_ID;
Ethan Yonker66a19492015-12-10 10:19:45 -0600177 string Adopted_GUID;
Peter Cai439d60c2019-10-17 08:49:10 +0800178 unsigned int Adopted_Mount_Delay;
Dees_Troy7c2dec82012-09-26 09:49:14 -0400179
Ethan Yonker1eff6cd2014-09-15 13:30:42 -0500180protected:
181 bool Has_Data_Media; // Indicates presence of /data/media, may affect wiping and backup methods
that9e0593e2014-10-08 00:01:24 +0200182 void Setup_Data_Media(); // Sets up a partition as a /data/media emulated storage partition
bigbiffcfa875c2021-06-20 16:20:27 -0400183 void Set_Block_Device(std::string block_device); // Allow super partition setup to change block device
Ethan Yonker1eff6cd2014-09-15 13:30:42 -0500184
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200185private:
bigbiff8da46fa2020-09-08 16:42:34 -0400186 bool Process_Fstab_Line(const char *fstab_line, bool Display_Error, std::map<string, Flags_Map> *twrp_flags); // Processes a fstab line
Matt Mower72c87ce2016-04-26 14:34:56 -0500187 void Setup_Data_Partition(bool Display_Error); // Setup data partition after fstab processed
bigbiff7ba75002020-04-11 20:47:09 -0400188 void Set_FBE_Status(); // Set FBE status of partition
Matt Mower72c87ce2016-04-26 14:34:56 -0500189 void Setup_Cache_Partition(bool Display_Error); // Setup cache partition after fstab processed
Ethan Yonker6e8c27a2016-12-22 17:55:57 -0600190 bool Find_Wildcard_Block_Devices(const string& Device); // Searches for and finds wildcard block devices
Dees_Troy38bd7602012-09-14 13:33:53 -0400191 void Find_Actual_Block_Device(); // Determines the correct block device and stores it in Actual_Block_Device
Matt Mower2416a502016-04-12 19:54:46 -0500192 void Apply_TW_Flag(const unsigned flag, const char* str, const bool val); // Apply custom twrp fstab flags
Ethan Yonker6e8c27a2016-12-22 17:55:57 -0600193 void Process_TW_Flags(char *flags, bool Display_Error, int fstab_ver); // Process custom twrp fstab flags
Matt Mower4ab42b12016-04-21 13:52:18 -0500194 void Process_FS_Flags(const char *str); // Process standard fstab fs flags
Ethan Yonker6e8c27a2016-12-22 17:55:57 -0600195 void Save_FS_Flags(const string& local_File_System, int local_Mount_Flags, const string& local_Mount_Options); // Saves fs flags to a vector in case there are multiple lines in a v2 fstab with different mount flags for different file systems
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200196 bool Is_File_System(string File_System); // Checks to see if the file system given is considered a file system
197 bool Is_Image(string File_System); // Checks to see if the file system given is considered an image
198 void Setup_File_System(bool Display_Error); // Sets defaults for a file system partition
Ethan Yonker1b190162016-12-05 15:25:19 -0600199 void Setup_Image(); // Sets defaults for an image partition
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200200 void Setup_AndSec(void); // Sets up .android_secure settings
201 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
Ethan Yonkerd18a8212015-12-14 10:17:00 -0600202 unsigned long long IOCTL_Get_Block_Size(); // Finds the partition size using ioctl
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200203 bool Find_Partition_Size(); // Finds the partition size from /proc/partitions
204 unsigned long long Get_Size_Via_du(string Path, bool Display_Error); // Uses du to get sizes
dianlujitao4879b372018-12-03 18:45:47 +0800205 bool Wipe_EXTFS(string File_System); // Create an ext2/ext3/ext4 filesystem
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200206 bool Wipe_EXT4(); // Formats using ext4, uses make_ext4fs when present
Matt Mower18794c82015-11-11 16:22:45 -0600207 bool Wipe_FAT(); // Formats as FAT if mkfs.fat exits otherwise rm -rf wipe
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200208 bool Wipe_EXFAT(); // Formats as EXFAT
209 bool Wipe_MTD(); // Formats as yaffs2 for MTD memory types
210 bool Wipe_RMRF(); // Uses rm -rf to wipe
Dees_Troye5017042013-08-29 16:38:55 +0000211 bool Wipe_F2FS(); // Uses mkfs.f2fs to wipe
Ethan Yonkerb81d9052015-07-09 13:20:53 -0500212 bool Wipe_NTFS(); // Uses mkntfs to wipe
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200213 bool Wipe_Data_Without_Wiping_Media(); // Uses rm -rf to wipe but does not wipe /data/media
Ethan Yonker66a19492015-12-10 10:19:45 -0600214 bool Wipe_Data_Without_Wiping_Media_Func(const string& parent); // Uses rm -rf to wipe but does not wipe /data/media
dianlujitao4879b372018-12-03 18:45:47 +0800215 void Wipe_Crypto_Key(); // Wipe crypto key from either footer or block device
bigbiffce8f83c2015-12-12 18:30:21 -0500216 bool Backup_Tar(PartitionSettings *part_settings, pid_t *tar_fork_pid); // Backs up using tar for file systems
217 bool Backup_Image(PartitionSettings *part_settings); // Backs up using raw read/write for emmc memory types
218 bool Raw_Read_Write(PartitionSettings *part_settings);
219 bool Backup_Dump_Image(PartitionSettings *part_settings); // Backs up using dump_image for MTD memory types
220 string Get_Restore_File_System(PartitionSettings *part_settings); // Returns the file system that was in place at the time of the backup
221 bool Restore_Tar(PartitionSettings *part_settings); // Restore using tar for file systems
222 bool Restore_Image(PartitionSettings *part_settings); // Restore using dd for images
James Christopher Adduono79ae0932016-10-25 02:18:32 -0400223 bool Check_Restore_File_MD5(const string& Filename); // Verifies MD5 matches for a file before restoration
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200224 bool Get_Size_Via_statfs(bool Display_Error); // Get Partition size, used, and free space using statfs
225 bool Get_Size_Via_df(bool Display_Error); // Get Partition size, used, and free space using df command
226 bool Make_Dir(string Path, bool Display_Error); // Creates a directory if it doesn't already exist
227 bool Find_MTD_Block_Device(string MTD_Name); // Finds the mtd block device based on the name from the fstab
228 void Recreate_AndSec_Folder(void); // Recreates the .android_secure folder
Kjell Braden3126a112016-06-19 16:58:15 +0000229 bool Mount_Storage_Retry(bool Display_Error); // Tries multiple times with a half second delay to mount a device in case storage is slow to mount
Ethan Yonker472f5062016-02-25 13:47:30 -0600230 bool Is_Sparse_Image(const string& Filename); // Determines if a file is in sparse image format
231 bool Flash_Sparse_Image(const string& Filename); // Flashes a sparse image using simg2img
232 bool Flash_Image_FI(const string& Filename, ProgressTracking *progress); // Flashes an image to the partition using flash_image for mtd nand
Ethan Yonkerbd7492d2016-12-07 13:55:01 -0600233 void ExcludeAll(const string& path); // Adds an exclusion for path to both the backup and wipe exclusion lists
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200234
235private:
Dees_Troy240e4a72012-09-04 09:22:39 -0400236 bool Can_Be_Mounted; // Indicates that the partition can be mounted
237 bool Can_Be_Wiped; // Indicates that the partition can be wiped
Dees_Troya13d74f2013-03-24 08:54:55 -0500238 bool Can_Be_Backed_Up; // Indicates that the partition will show up in the backup list
Hashcodedabfd492013-08-29 22:45:30 -0700239 bool Use_Rm_Rf; // Indicates that the partition will always be formatted w/ "rm -rf *"
Dees_Troy51a0e822012-09-05 15:24:24 -0400240 bool Wipe_During_Factory_Reset; // Indicates that this partition is wiped during a factory reset
Dees_Troy240e4a72012-09-04 09:22:39 -0400241 bool Wipe_Available_in_GUI; // Inidcates that the wipe can be user initiated in the GUI system
242 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 -0400243 bool Has_SubPartition; // Indicates that this partition has a sub-partition
Dees_Troy5bf43922012-09-07 16:07:55 -0400244 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 -0400245 string Symlink_Path; // Symlink path (e.g. /data/media)
246 string Symlink_Mount_Point; // /sdcard could be the symlink mount point for /data/media
247 string Mount_Point; // Mount point for this partition (e.g. /system or /data)
Dees_Troye58d5262012-09-21 12:27:57 -0400248 string Backup_Path; // Path for backup
Ethan Yonker6e8c27a2016-12-22 17:55:57 -0600249 bool Wildcard_Block_Device; // If the block device contains an asterisk, we set this flag
250 string Sysfs_Entry; // For v2 fstab, if the "block device" starts with /devices then it is a sysfs entry that is handled by uevents
Dees_Troy38bd7602012-09-14 13:33:53 -0400251 string Primary_Block_Device; // Block device (e.g. /dev/block/mmcblk1p1)
Dees_Troy240e4a72012-09-04 09:22:39 -0400252 string Alternate_Block_Device; // Alternate block device (e.g. /dev/block/mmcblk1)
Dees_Troy38bd7602012-09-14 13:33:53 -0400253 string Decrypted_Block_Device; // Decrypted block device available after decryption
Dees_Troy240e4a72012-09-04 09:22:39 -0400254 bool Removable; // Indicates if this partition is removable -- affects how often we check overall size, if present, etc.
Dees_Troy240e4a72012-09-04 09:22:39 -0400255 int Length; // Used by make_ext4fs to leave free space at the end of the partition block for things like a crypto footer
256 unsigned long long Size; // Overall size of the partition
257 unsigned long long Used; // Overall used space
258 unsigned long long Free; // Overall free space
259 unsigned long long Backup_Size; // Backup size -- may be different than used space especially when /data/media is present
Ethan Yonker1b7a31b2014-07-03 15:09:22 -0500260 unsigned long long Restore_Size; // Restore size of the current restore operation
Dees_Troy240e4a72012-09-04 09:22:39 -0400261 bool Can_Be_Encrypted; // This partition might be encrypted, affects error handling, can only be true if crypto support is compiled in
262 bool Is_Encrypted; // This partition is thought to be encrypted -- it wouldn't mount for some reason, only avialble with crypto support
263 bool Is_Decrypted; // This partition has successfully been decrypted
Ethan Yonkerbd7492d2016-12-07 13:55:01 -0600264 bool Is_FBE; // File Based Encryption is present
Ethan Yonker253368a2014-11-25 15:00:52 -0600265 bool Mount_To_Decrypt; // Mount this partition during decrypt (/vendor, /firmware, etc in case we need proprietary libs or firmware files)
Dees_Troy240e4a72012-09-04 09:22:39 -0400266 string Display_Name; // Display name for the GUI
267 string Backup_Name; // Backup name -- used for backup filenames
Dees_Troya13d74f2013-03-24 08:54:55 -0500268 string Storage_Name; // Name displayed in the partition list for storage selection
Dees_Troy63c8df72012-09-10 14:02:05 -0400269 string Backup_FileName; // Actual backup filename
Dees_Troy240e4a72012-09-04 09:22:39 -0400270 Backup_Method_enum Backup_Method; // Method used for backup
Dees_Troy83bd4832013-05-04 12:39:56 +0000271 bool Can_Encrypt_Backup; // Indicates if this item can be encrypted during backup
272 bool Use_Userdata_Encryption; // Indicates if we will use userdata encryption splitting on an encrypted backup
Dees_Troye58d5262012-09-21 12:27:57 -0400273 bool Has_Android_Secure; // Indicates the presence of .android_secure on this partition
Dees_Troy5bf43922012-09-07 16:07:55 -0400274 bool Is_Storage; // Indicates if this partition is used for storage for backup, restore, and installing zips
Dees_Troya13d74f2013-03-24 08:54:55 -0500275 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 -0400276 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 -0400277 string Fstab_File_System; // File system from the recovery.fstab
Hashcode62bd9e02013-11-19 21:59:42 -0800278 int Mount_Flags; // File system flags from recovery.fstab
279 string Mount_Options; // File system options from recovery.fstab
Ethan Yonkera2719152015-05-28 09:44:41 -0500280 unsigned long Format_Block_Size; // Block size for formatting
Dees_Troy68cab492012-12-12 19:29:35 +0000281 bool Ignore_Blkid; // Ignore blkid results due to superblocks lying to us on certain devices / partitions
Ethan Yonker96af84a2015-01-05 14:58:36 -0600282 bool Can_Flash_Img; // Indicates if this partition can have images flashed to it via the GUI
Ethan Yonkereb32b1f2015-05-18 10:23:03 -0500283 bool Mount_Read_Only; // Only mount this partition as read-only
Ethan Yonker66a19492015-12-10 10:19:45 -0600284 bool Is_Adopted_Storage; // Indicates that this partition is for adopted storage (android_expand)
Ethan Yonker1b190162016-12-05 15:25:19 -0600285 bool SlotSelect; // Partition has A/B slots
286 TWExclude backup_exclusions; // Exclusions for file based backups
287 TWExclude wipe_exclusions; // Exclusions for file based wipes (data/media devices only)
bigbiffee7b7ff2020-03-23 15:08:27 -0400288 string Key_Directory; // Metadata key directory needed for mounting FBE encrypted data partitions using metadata encryption
Peter Caid68e6412019-11-02 19:22:38 +0800289 string Original_Path;
290 bool Use_Original_Path;
Darth99fb13af2023-04-07 23:32:45 +0100291 bool Needs_Fs_Compress;
Peter Caid68e6412019-11-02 19:22:38 +0800292
Ethan Yonker6e8c27a2016-12-22 17:55:57 -0600293 struct partition_fs_flags_struct { // This struct is used to store mount flags and options for different file systems for the same partition
294 string File_System;
295 int Mount_Flags;
296 string Mount_Options;
297 };
298
299 std::vector<partition_fs_flags_struct> fs_flags; // This vector stores mount flags and options for different file systems for the same partition
bigbiffee7b7ff2020-03-23 15:08:27 -0400300 bool Is_Super; // States whether partition should be loaded from the super partition
Ethan Yonker6e8c27a2016-12-22 17:55:57 -0600301
Dees_Troy240e4a72012-09-04 09:22:39 -0400302friend class TWPartitionManager;
Dees_Troya13d74f2013-03-24 08:54:55 -0500303friend class DataManager;
304friend class GUIPartitionList;
Ethan Yonker87c7bac2014-05-25 21:41:08 -0500305friend class GUIAction;
Ethan Yonker74db1572015-10-28 12:44:49 -0500306friend class PageManager;
Dees_Troy51a0e822012-09-05 15:24:24 -0400307};
Dees_Troy240e4a72012-09-04 09:22:39 -0400308
Noah Jacobson81d638d2019-04-28 00:10:07 -0400309struct users_struct {
310 std::string userId;
311 std::string userName;
312 int type;
313 bool isDecrypted;
314};
315
Dees_Troy240e4a72012-09-04 09:22:39 -0400316class TWPartitionManager
317{
318public:
Andreas Blaesius123fcd02015-11-16 01:40:36 +0200319 TWPartitionManager(); // Constructor for TWRPartionManager
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200320 ~TWPartitionManager() {}
Dees_Troy5bf43922012-09-07 16:07:55 -0400321
322public:
bigbiff22851b92021-09-01 16:46:57 -0400323 int Process_Fstab(string Fstab_Filename, bool Display_Error, bool recovery_mode); // Parses the fstab files
324 void Setup_Fstab_Partitions(bool Display_Error); // Populates the partitions
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200325 int Write_Fstab(); // Creates /etc/fstab file that's used by the command line for mount commands
bigbiff7ba75002020-04-11 20:47:09 -0400326 void Decrypt_Data(); // Decrypt Data if enabled
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200327 void Output_Partition_Logging(); // Outputs partition information to the log
Ethan Yonker6e8c27a2016-12-22 17:55:57 -0600328 void Output_Partition(TWPartition* Part); // Outputs partition details to the log
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200329 int Mount_By_Path(string Path, bool Display_Error); // Mounts partition based on path (e.g. /system)
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200330 int UnMount_By_Path(string Path, bool Display_Error); // Unmounts partition based on path
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200331 int Is_Mounted_By_Path(string Path); // Checks if partition is mounted based on path
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200332 int Mount_Current_Storage(bool Display_Error); // Mounts the current storage location
333 int Mount_Settings_Storage(bool Display_Error); // Mounts the settings file storage location (usually internal)
Ethan Yonker6e8c27a2016-12-22 17:55:57 -0600334 TWPartition* Find_Partition_By_Path(const string& Path); // Returns a pointer to a partition based on path
335 TWPartition* Find_Partition_By_Block_Device(const string& Block_Device); // Returns a pointer to a partition based on block device
Ethan Yonker53796e72019-01-11 22:49:52 -0600336 int Check_Backup_Name(const std::string& Backup_Name, bool Display_Error, bool Must_Be_Unique); // Checks the current backup name to ensure that it is valid and optionally that a backup with that name doesn't already exist
bigbiffce8f83c2015-12-12 18:30:21 -0500337 int Run_Backup(bool adbbackup); // Initiates a backup in the current storage
Ethan Yonker472f5062016-02-25 13:47:30 -0600338 int Run_Restore(const string& Restore_Name); // Restores a backup
bigbiffce8f83c2015-12-12 18:30:21 -0500339 bool Write_ADB_Stream_Header(uint64_t partition_count); // Write ADB header over twrpbu FIFO
340 bool Write_ADB_Stream_Trailer(); // Write ADB trailer over twrpbu FIFO
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200341 void Set_Restore_Files(string Restore_Name); // Used to gather a list of available backup partitions for the user to select for a restore
342 int Wipe_By_Path(string Path); // Wipes a partition based on path
Ethan Yonker87c7bac2014-05-25 21:41:08 -0500343 int Wipe_By_Path(string Path, string New_File_System); // Wipes a partition based on path
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200344 int Factory_Reset(); // Performs a factory reset
345 int Wipe_Dalvik_Cache(); // Wipes dalvik cache
346 int Wipe_Rotate_Data(); // Wipes rotation data --
347 int Wipe_Battery_Stats(); // Wipe battery stats -- /data/system/batterystats.bin
348 int Wipe_Android_Secure(); // Wipes android secure
349 int Format_Data(); // Really formats data on /data/media devices -- also removes encryption
350 int Wipe_Media_From_Data(); // Removes and recreates the media folder on /data/media devices
Ethan Yonker87c7bac2014-05-25 21:41:08 -0500351 int Repair_By_Path(string Path, bool Display_Error); // Repairs a partition based on path
Ethan Yonkera2719152015-05-28 09:44:41 -0500352 int Resize_By_Path(string Path, bool Display_Error); // Resizes a partition based on path
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200353 void Update_System_Details(); // Updates fstab, file systems, sizes, etc.
Noah Jacobson81d638d2019-04-28 00:10:07 -0400354 int Decrypt_Device(string Password, int user_id = 0); // Attempt to decrypt any encrypted partitions
355 void Parse_Users(); // Parse FBE users
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200356 int usb_storage_enable(void); // Enable USB storage mode
357 int usb_storage_disable(void); // Disable USB storage mode
358 void Mount_All_Storage(void); // Mounts all storage locations
359 void UnMount_Main_Partitions(void); // Unmounts system and data if not data/media and boot if boot is mountable
360 int Partition_SDCard(void); // Repartitions the sdcard
Vojtech Bocek93cb1ef2014-05-12 15:41:52 +0200361 TWPartition *Get_Default_Storage_Partition(); // Returns a pointer to a default storage partition
Ethan Yonker472f5062016-02-25 13:47:30 -0600362 int Check_Backup_Cancel(); // Returns the value of stop_backup
bigbiff7abc5fe2015-01-17 16:53:12 -0500363 int Cancel_Backup(); // Signals partition backup to cancel
Andreas Blaesius123fcd02015-11-16 01:40:36 +0200364 void Clean_Backup_Folder(string Backup_Folder); // Clean Backup Folder on Error
Ethan Yonkerb5fab762016-01-28 14:03:33 -0600365 int Fix_Contexts();
Vojtech Bocek8b44bbd2013-07-25 20:43:29 +0200366 void Get_Partition_List(string ListType, std::vector<PartitionList> *Partition_List);
367 int Fstab_Processed(); // Indicates if the fstab has been processed or not
368 void Output_Storage_Fstab(); // Creates a /cache/recovery/storage.fstab file with a list of all potential storage locations for app use
bigbiff bigbiffc7eee6f2014-09-02 18:59:01 -0400369 bool Enable_MTP(); // Enables MTP
Ethan Yonker1b039202015-01-30 10:08:48 -0600370 void Add_All_MTP_Storage(); // Adds all storage objects for MTP
bigbiff bigbiffc7eee6f2014-09-02 18:59:01 -0400371 bool Disable_MTP(); // Disables MTP
Ethan Yonker726a0202014-12-16 20:01:38 -0600372 bool Add_MTP_Storage(string Mount_Point); // Adds or removes an MTP Storage partition
373 bool Add_MTP_Storage(unsigned int Storage_ID); // Adds or removes an MTP Storage partition
374 bool Remove_MTP_Storage(string Mount_Point); // Adds or removes an MTP Storage partition
375 bool Remove_MTP_Storage(unsigned int Storage_ID); // Adds or removes an MTP Storage partition
Ethan Yonker74db1572015-10-28 12:44:49 -0500376 void Translate_Partition(const char* path, const char* resource_name, const char* default_value);
377 void Translate_Partition(const char* path, const char* resource_name, const char* default_value, const char* storage_resource_name, const char* storage_default_value);
Ethan Yonker01f4e032017-02-03 15:30:52 -0600378 void Translate_Partition(const char* path, const char* resource_name, const char* default_value, const char* storage_resource_name, const char* storage_default_value, const char* backup_name, const char* backup_default);
Ethan Yonker74db1572015-10-28 12:44:49 -0500379 void Translate_Partition_Display_Names(); // Updates display names based on translations
Ethan Yonker6e8c27a2016-12-22 17:55:57 -0600380 bool Decrypt_Adopted(); // Attempt to identy and decrypt any adopted storage partitions
Ethan Yonkerfcf3f242016-02-16 12:30:26 -0600381 void Remove_Partition_By_Path(string Path); // Removes / erases a partition entry from the partition list
bigbiffee7b7ff2020-03-23 15:08:27 -0400382 bool Prepare_All_Super_Volumes(); // Prepare all known super volumes from super partition
Ethan Yonkere080c1f2016-09-19 13:50:25 -0500383 bool Flash_Image(string& path, string& filename); // Flashes an image to a selected partition from the partition list
384 bool Restore_Partition(struct PartitionSettings *part_settings); // Restore the partitions based on type
bigbiff7abc5fe2015-01-17 16:53:12 -0500385 TWAtomicInt stop_backup;
bigbiff74a46272021-07-31 19:02:26 -0400386 void Override_Active_Slot(const string& Slot); // Override the active slot for repacking
Ethan Yonker1b190162016-12-05 15:25:19 -0600387 void Set_Active_Slot(const string& Slot); // Sets the active slot to A or B
388 string Get_Active_Slot_Suffix(); // Returns active slot _a or _b
389 string Get_Active_Slot_Display(); // Returns active slot A or B for display purposes
Captain Throwback9d6feb52018-07-27 10:05:24 -0400390 string Get_Android_Root_Path(); // Returns path of ANDROID_ROOT environment variable
Ethan Yonker6e8c27a2016-12-22 17:55:57 -0600391 struct pollfd uevent_pfd; // Used for uevent code
392 void Remove_Uevent_Devices(const string& sysfs_path); // Removes subpartitions from the Partitions vector for a matched uevent device
393 void Handle_Uevent(const Uevent_Block_Data& uevent_data); // Handle uevent data
394 void setup_uevent(); // Opens the uevent netlink socket
395 Uevent_Block_Data get_event_block_values(char *buf, int len); // Scans the buffer from uevent data and loads the appropriate data into a Uevent_Block_Data struct for processing
396 void read_uevent(); // Reads uevent data into a buffer
397 void close_uevent(); // Closes the uevent netlink socket
398 void Add_Partition(TWPartition* Part); // Adds a new partition to the Partitions vector
bigbiffcfa875c2021-06-20 16:20:27 -0400399 std::string Get_Bare_Partition_Name(std::string Mount_Point);
bigbiffee7b7ff2020-03-23 15:08:27 -0400400 bool Prepare_Super_Volume(TWPartition* twrpPart); // Prepare logical super partition volume for mounting
401 std::string Get_Super_Partition(); // Get Super Partition block device path
402 void Setup_Super_Devices(); // Setup logical dm devices on super partition
403 bool Get_Super_Status(); // Return whether device has a super partition
bigbiff7ba75002020-04-11 20:47:09 -0400404 void Setup_Super_Partition(); // Setup the super partition for backup and restore
bigbiff25d25b92020-06-19 16:07:38 -0400405 bool Recreate_Logs_Dir(); // Recreate TWRP_AB_LOGS_DIR after wipe
Noah Jacobson81d638d2019-04-28 00:10:07 -0400406 std::vector<users_struct>* Get_Users_List(); // Returns pointer to list of users
Captain Throwback37c3aef2021-10-06 11:38:18 -0400407 void Set_Crypto_State(); // Sets encryption state for devices (ro.crypto.state)
408 int Set_Crypto_Type(const char* crypto_type); // Sets encryption type for FDE (block) and FBE (file) devices (ro.crypto.type)
bigbiff1f9e4842020-10-31 11:33:15 -0400409 void Unlock_Block_Partitions(); // Unlock all block devices after update_engine runs
bigbiffcfa875c2021-06-20 16:20:27 -0400410 bool Unmap_Super_Devices(); // Unmap super devices in TWRP
bigbiffd21252f2021-09-18 15:56:32 -0400411 bool Check_Pending_Merges(); // Check and run pending merges on data for VAB devices
bigbiff7abc5fe2015-01-17 16:53:12 -0500412
Dees_Troy240e4a72012-09-04 09:22:39 -0400413private:
Matt Mowerbf4efa32014-04-14 23:25:26 -0500414 void Setup_Settings_Storage_Partition(TWPartition* Part); // Sets up settings storage
415 void Setup_Android_Secure_Location(TWPartition* Part); // Sets up .android_secure if needed
Ethan Yonkere080c1f2016-09-19 13:50:25 -0500416 bool Backup_Partition(struct PartitionSettings *part_settings); // Backup the partitions based on type
Ethan Yonker726a0202014-12-16 20:01:38 -0600417 TWPartition* Find_Partition_By_MTP_Storage_ID(unsigned int Storage_ID); // Returns a pointer to a partition based on MTP Storage ID
Andreas Blaesius123fcd02015-11-16 01:40:36 +0200418 bool Add_Remove_MTP_Storage(TWPartition* Part, int message_type); // Adds or removes an MTP Storage partition
Ethan Yonker66a19492015-12-10 10:19:45 -0600419 TWPartition* Find_Next_Storage(string Path, bool Exclude_Data_Media);
Dees_Troyd21618c2012-10-14 18:48:49 -0400420 int Open_Lun_File(string Partition_Path, string Lun_File);
Ethan Yonkerbd7492d2016-12-07 13:55:01 -0600421 void Post_Decrypt(const string& Block_Device); // Completes various post-decrypt tasks
Ethan Yonker6e8c27a2016-12-22 17:55:57 -0600422 void Coldboot_Scan(std::vector<string> *sysfs_entries, const string& Path, int depth); // Scans subfolders to find matches to the paths stored in sysfs_entries so we can trigger the uevent system to "re-add" devices
423 void Coldboot(); // Starts the scan of the /sys/block folder
Ethan Yonker53796e72019-01-11 22:49:52 -0600424 bool Prepare_Empty_Folder(const std::string& Folder); // Creates an empty folder at Folder. If the folder already exists, the folder is deleted, then created
Ethan Yonker8dfa7772014-09-04 21:48:41 -0500425 pid_t mtppid;
bigbiff bigbiffc7eee6f2014-09-02 18:59:01 -0400426 bool mtp_was_enabled;
Ethan Yonker726a0202014-12-16 20:01:38 -0600427 int mtp_write_fd;
bigbiffce8f83c2015-12-12 18:30:21 -0500428 pid_t tar_fork_pid; // PID of twrpTar fork
429 Backup_Method_enum Backup_Method; // Method used for backup
bigbiffad58e1b2020-07-06 20:24:34 -0400430 std::string original_ramdisk_format; // Ramdisk format of boot partition
431 std::string repacked_ramdisk_format; // Ramdisk format of boot image to repack from
Noah Jacobson81d638d2019-04-28 00:10:07 -0400432 void Mark_User_Decrypted(int userID); // Marks given user ID in Users_List as decrypted
bigbiffcfa875c2021-06-20 16:20:27 -0400433 void Check_Users_Decryption_Status(); // Checks to see if all users are decrypted
Dees_Troy43d8b002012-09-17 16:00:01 -0400434
435private:
Dees_Troy51127312012-09-08 13:08:49 -0400436 std::vector<TWPartition*> Partitions; // Vector list of all partitions
Ethan Yonker1b190162016-12-05 15:25:19 -0600437 string Active_Slot_Display; // Current Active Slot (A or B) for display purposes
Noah Jacobson81d638d2019-04-28 00:10:07 -0400438 std::vector<users_struct> Users_List; // List of FBE users
bigbiff998f8392021-08-06 19:19:33 -0400439 std::vector<std::string> Super_Partition_List; // Display value for super partitions
Dees_Troy51a0e822012-09-05 15:24:24 -0400440};
Dees_Troy240e4a72012-09-04 09:22:39 -0400441
Dees_Troy5bf43922012-09-07 16:07:55 -0400442extern TWPartitionManager PartitionManager;
443
444#endif // __TWRP_Partition_Manager