blob: 5fa6bde5da464e8d456ea1f8418a465db0f9d31e [file] [log] [blame]
bigbiffce8f83c2015-12-12 18:30:21 -05001/*
2 TWRP is free software: you can redistribute it and/or modify
3 it under the terms of the GNU General Public License as published by
4 the Free Software Foundation, either version 3 of the License, or
5 (at your option) any later version.
6
7 TWRP 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 TWRP. If not, see <http://www.gnu.org/licenses/>.
14*/
15
16#ifndef __TWADBSTREAM_H
17#define __TWADBSTREAM_H
18
19#define TW_ADB_BACKUP "/tmp/twadbbackup" //FIFO for adb backup
20#define TW_ADB_RESTORE "/tmp/twadbrestore" //FIFO for adb restore
21#define TW_ADB_BU_CONTROL "/tmp/twadbbucontrol" //FIFO for sending control from TWRP to ADB Backup
22#define TW_ADB_TWRP_CONTROL "/tmp/twadbtwrpcontrol" //FIFO for sending control from ADB Backup to TWRP
23#define TWRP "TWRP" //Magic Value
bigbiff bigbiffb5ecaad2017-03-20 18:53:53 -040024#define ADB_BU_MAX_ERROR 20 //Max amount of errors for while loops
bigbiffce8f83c2015-12-12 18:30:21 -050025
26//ADB Backup Control Commands
27#define TWSTREAMHDR "twstreamheader" //TWRP Parititon Count Control
28#define TWFN "twfilename" //TWRP Filename Control
29#define TWIMG "twimage" //TWRP Image name Control
30#define TWEOF "tweof" //End of File for Image/File
31#define MD5TRAILER "md5trailer" //Image/File MD5 Trailer
32#define TWDATA "twdatablock" // twrp adb backup data block header
33#define TWMD5 "twverifymd5" //This command is compared to the md5trailer by ORS to verify transfer
34#define TWENDADB "twendadb" //End Protocol
35#define TWERROR "twerror" //Send error
36#define ADB_BACKUP_VERSION 1 //Backup Version
37#define DATA_MAX_CHUNK_SIZE 1048576 //Maximum size between each data header
38#define MAX_ADB_READ 512 //align with default tar size for amount to read fom adb stream
39
40/*
41structs for adb backup need to align to 512 bytes for reading 512
42bytes at a time
43Each struct contains a crc field so that when we are checking for commands
44and the crc doesn't match we still assume it's data matching the command
45struct but not really a command
46*/
47
48/* stream format:
49 | TW ADB Backup Header |
50 | TW File Stream Header |
51 | File Data |
52 | File/Image MD5 Trailer |
53 | TW File Stream Header |
54 | File Data |
55 | File/Image MD5 Trailer |
56 | etc... |
57*/
58
59//determine whether struct is 512 bytes, if not fail compilation
60#define ADBSTRUCT_STATIC_ASSERT(structure) typedef char adb_assertion[( !!(structure) )*2-1 ]
61
62//generic cmd structure to align fields for sending commands to and from adb backup
63struct AdbBackupControlType {
64 char start_of_header[8]; //stores the magic value #define TWRP
65 char type[16]; //stores the type of command, TWENDADB, TWCNT, TWEOF, TWMD5, TWDATA and TWERROR
66 uint32_t crc; //stores the zlib 32 bit crc of the AdbBackupControlType struct to allow for making sure we are processing metadata
67 char space[484]; //stores space to align the struct to 512 bytes
Ayke van Laethem05c2de42017-06-02 00:19:27 +020068
69 //return a C++ string while not reading outside the type char array
70 std::string get_type() {
71 return std::string(type, strnlen(type, sizeof(type)-1));
72 }
bigbiffce8f83c2015-12-12 18:30:21 -050073};
74
75//general info for file metadata stored in adb backup header
76struct twfilehdr {
77 char start_of_header[8]; //stores the magic value #define TWRP
78 char type[16]; //stores the type of file header, TWFN or TWIMG
79 uint64_t size; //stores the size of the file contained after this header in the backup file
80 uint64_t compressed; //stores whether the file is compressed or not. 1 == compressed and 0 == uncompressed
81 uint32_t crc; //stores the zlib 32 bit crc of the twfilehdr struct to allow for making sure we are processing metadata
82 char name[468]; //stores the filename of the file
83};
84
85//md5 for files stored as a trailer to files in the adb backup file to check
86//that they are restored correctly
87struct AdbBackupFileTrailer {
88 char start_of_trailer[8]; //stores the magic value #define TWRP
89 char type[16]; //stores the AdbBackupFileTrailer type MD5TRAILER
90 uint32_t crc; //stores the zlib 32 bit crc of the AdbBackupFileTrailer struct to allow for making sure we are processing metadata
91 uint32_t ident; //stores crc to determine if header is encapsulated in stream as data
92 char md5[40]; //stores the md5 computation of the file
93 char space[440]; //stores space to align the struct to 512 bytes
94};
95
96//info for version and number of partitions backed up
97struct AdbBackupStreamHeader {
98 char start_of_header[8]; //stores the magic value #define TWRP
99 char type[16]; //stores the AdbBackupStreamHeader value TWCNT
100 uint64_t partition_count; //stores the number of partitions to restore in the stream
101 uint64_t version; //stores the version of adb backup. increment ADB_BACKUP_VERSION each time the metadata is updated
102 uint32_t crc; //stores the zlib 32 bit crc of the AdbBackupStreamHeader struct to allow for making sure we are processing metadata
103 char space[468]; //stores space to align the struct to 512 bytes
104};
105
106#endif //__TWADBSTREAM_H