2 * Copyright (C) 2014 The Android Open Source Project
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless requied by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 * These file system recovery tests ensure the ability to recover from
20 * filesystem crashes in key blocks (e.g. superblock).
26 #include <gtest/gtest.h>
27 #include <logwrap/logwrap.h>
28 #include <sys/types.h>
31 #include "cutils/properties.h"
32 #include <ext4_utils/ext4.h>
33 #include <ext4_utils/ext4_utils.h>
35 #define LOG_TAG "fsRecoveryTest"
36 #include <utils/Log.h>
39 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
40 #define SB_OFFSET 1024
41 static char UMOUNT_BIN[] = "/system/bin/umount";
42 static char VDC_BIN[] = "/system/bin/vdc";
44 enum Fs_Type { FS_UNKNOWN, FS_EXT4, FS_F2FS };
48 class DataFileVerifier {
50 explicit DataFileVerifier(const char* file_name) {
51 strncpy(test_file_, file_name, FILENAME_MAX);
55 int write_fd = open(test_file_, O_CREAT | O_WRONLY, 0666);
56 ASSERT_TRUE(write_fd);
57 ASSERT_EQ(write(write_fd, "TEST", 4), 4);
63 int read_fd = open(test_file_, O_RDONLY);
65 ASSERT_EQ(read(read_fd, read_buff, sizeof(read_buff)), 4);
66 ASSERT_FALSE(strncmp(read_buff, "TEST", 4));
75 char test_file_[FILENAME_MAX];
79 bool getSuperBlock(const int blk_fd, struct ext4_super_block* sb) {
80 if (lseek(blk_fd, SB_OFFSET, SEEK_SET) == -1) {
81 testPrintE("Cannot lseek to ext4 superblock to read");
85 if (read(blk_fd, sb, sizeof(*sb)) != sizeof(*sb)) {
86 testPrintE("Cannot read ext4 superblock");
90 if (sb->s_magic != 0xEF53) {
91 testPrintE("Invalid ext4 superblock magic");
98 bool setSbErrorBit(const int blk_fd) {
100 struct ext4_super_block sb;
101 if (!getSuperBlock(blk_fd, &sb)) {
105 // Check that the detected errors bit is not set.
106 if (sb.s_state & 0x2) {
107 testPrintE("Ext4 superblock already corrupted");
111 // Set the detected errors bit.
115 if (lseek(blk_fd, SB_OFFSET, SEEK_SET) == -1) {
116 testPrintE("Cannot lseek to superblock to write\n");
120 if (write(blk_fd, &sb, sizeof(sb)) != sizeof(sb)) {
121 testPrintE("Cannot write superblock\n");
128 bool corruptGdtFreeBlock(const int blk_fd) {
130 struct ext4_super_block sb;
131 if (!getSuperBlock(blk_fd, &sb)) {
134 // Make sure the block size is 2K or 4K.
135 if ((sb.s_log_block_size != 1) && (sb.s_log_block_size != 2)) {
136 testPrintE("Ext4 block size not 2K or 4K\n");
139 int block_size = 1 << (10 + sb.s_log_block_size);
140 int num_bgs = DIV_ROUND_UP(sb.s_blocks_count_lo, sb.s_blocks_per_group);
142 if (sb.s_desc_size != sizeof(struct ext2_group_desc)) {
143 testPrintE("Can't handle ext4 block group descriptor size of %d",
148 // Read first block group descriptor, decrement free block count, and
149 // write it back out.
150 if (lseek(blk_fd, block_size, SEEK_SET) == -1) {
151 testPrintE("Cannot lseek to ext4 block group descriptor table to read");
155 // Read in block group descriptors till we read one that has at least one free
157 struct ext2_group_desc gd;
158 for (int i = 0; i < num_bgs; i++) {
159 if (read(blk_fd, &gd, sizeof(gd)) != sizeof(gd)) {
160 testPrintE("Cannot read ext4 group descriptor %d", i);
163 if (gd.bg_free_blocks_count) {
168 gd.bg_free_blocks_count--;
170 if (lseek(blk_fd, -sizeof(gd), SEEK_CUR) == -1) {
171 testPrintE("Cannot lseek to ext4 block group descriptor table to write");
175 if (write(blk_fd, &gd, sizeof(gd)) != sizeof(gd)) {
176 testPrintE("Cannot write modified ext4 group descriptor");
184 class FsRecoveryTest : public ::testing::Test {
186 FsRecoveryTest() : fs_type(FS_UNKNOWN), blk_fd_(-1) {}
188 bool setCacheInfoFromFstab() {
189 fs_type = FS_UNKNOWN;
191 struct fstab *fstab = fs_mgr_read_fstab_default();
193 testPrintE("failed to open default fstab\n");
195 // Loop through entries looking for cache.
196 for (int i = 0; i < fstab->num_entries; ++i) {
197 if (!strcmp(fstab->recs[i].mount_point, "/cache")) {
198 strcpy(blk_path_, fstab->recs[i].blk_device);
199 if (!strcmp(fstab->recs[i].fs_type, "ext4")) {
202 } else if (!strcmp(fstab->recs[i].fs_type, "f2fs")) {
208 fs_mgr_free_fstab(fstab);
210 return fs_type != FS_UNKNOWN;
213 bool unmountCache() {
214 char cache_str[] = "/cache";
215 char *umount_argv[] = {
220 return android_fork_execvp_ext(ARRAY_SIZE(umount_argv), umount_argv,
221 NULL, true, LOG_KLOG, false, NULL,
226 char storage_str[] = "storage";
227 char mountall_str[] = "mountall";
228 char *mountall_argv[] = {
234 return android_fork_execvp_ext(ARRAY_SIZE(mountall_argv), mountall_argv,
235 NULL, true, LOG_KLOG, false, NULL,
239 int getCacheBlkFd() {
241 blk_fd_ = open(blk_path_, O_RDWR);
246 void closeCacheBlkFd() {
253 void assertCacheHealthy() {
254 const char* test_file = "/cache/FsRecoveryTestGarbage.txt";
255 DataFileVerifier file_verify(test_file);
256 file_verify.verify_write();
257 file_verify.verify_read();
260 virtual void SetUp() {
261 assertCacheHealthy();
262 ASSERT_TRUE(setCacheInfoFromFstab());
265 virtual void TearDown() {
266 // Ensure /cache partition is accessible, mounted and healthy for other
269 ASSERT_TRUE(mountAll());
270 assertCacheHealthy();
276 char blk_path_[FILENAME_MAX];
280 TEST_F(FsRecoveryTest, EXT4_CorruptGdt) {
281 if (fs_type != FS_EXT4) {
284 // Setup test file in /cache.
285 const char* test_file = "/cache/CorruptGdtGarbage.txt";
286 DataFileVerifier file_verify(test_file);
287 file_verify.verify_write();
288 // Unmount and corrupt /cache gdt.
289 ASSERT_TRUE(unmountCache());
290 ASSERT_TRUE(ext4::corruptGdtFreeBlock(getCacheBlkFd()));
292 ASSERT_TRUE(mountAll());
295 file_verify.verify_read();
298 TEST_F(FsRecoveryTest, EXT4_SetErrorBit) {
299 if (fs_type != FS_EXT4) {
302 // Setup test file in /cache.
303 const char* test_file = "/cache/ErrorBitGarbagetxt";
304 DataFileVerifier file_verify(test_file);
305 file_verify.verify_write();
307 // Unmount and set /cache super block error bit.
308 ASSERT_TRUE(unmountCache());
309 ASSERT_TRUE(ext4::setSbErrorBit(getCacheBlkFd()));
311 ASSERT_TRUE(mountAll());
314 file_verify.verify_read();
315 struct ext4_super_block sb;
316 ASSERT_TRUE(ext4::getSuperBlock(getCacheBlkFd(), &sb));
317 // Verify e2fsck has recovered the error bit of sb.
318 ASSERT_FALSE(sb.s_state & 0x2);
320 } // namespace android