blob: c71de292c5ade3b5103a68e692aea28f540d0246 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * logfile.c - NTFS kernel journal handling. Part of the Linux-NTFS project.
3 *
Anton Altaparmakovbfab36e2007-10-12 09:37:15 +01004 * Copyright (c) 2002-2007 Anton Altaparmakov
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
6 * This program/include file is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License as published
8 * by the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program/include file is distributed in the hope that it will be
12 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty
13 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program (in the main directory of the Linux-NTFS
18 * distribution in the file COPYING); if not, write to the Free Software
19 * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 */
21
22#ifdef NTFS_RW
23
24#include <linux/types.h>
25#include <linux/fs.h>
26#include <linux/highmem.h>
27#include <linux/buffer_head.h>
28#include <linux/bitops.h>
Robert P. J. Day02d53412009-06-16 15:33:35 -070029#include <linux/log2.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
31#include "attrib.h"
32#include "aops.h"
33#include "debug.h"
34#include "logfile.h"
35#include "malloc.h"
36#include "volume.h"
37#include "ntfs.h"
38
39/**
40 * ntfs_check_restart_page_header - check the page header for consistency
41 * @vi: $LogFile inode to which the restart page header belongs
42 * @rp: restart page header to check
43 * @pos: position in @vi at which the restart page header resides
44 *
Richard Knutssonc49c3112006-09-30 23:27:12 -070045 * Check the restart page header @rp for consistency and return 'true' if it is
46 * consistent and 'false' otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -070047 *
48 * This function only needs NTFS_BLOCK_SIZE bytes in @rp, i.e. it does not
49 * require the full restart page.
50 */
Richard Knutssonc49c3112006-09-30 23:27:12 -070051static bool ntfs_check_restart_page_header(struct inode *vi,
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 RESTART_PAGE_HEADER *rp, s64 pos)
53{
54 u32 logfile_system_page_size, logfile_log_page_size;
Anton Altaparmakov5a8c0cc2005-09-26 10:48:54 +010055 u16 ra_ofs, usa_count, usa_ofs, usa_end = 0;
Richard Knutssonc49c3112006-09-30 23:27:12 -070056 bool have_usa = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
58 ntfs_debug("Entering.");
59 /*
60 * If the system or log page sizes are smaller than the ntfs block size
61 * or either is not a power of 2 we cannot handle this log file.
62 */
63 logfile_system_page_size = le32_to_cpu(rp->system_page_size);
64 logfile_log_page_size = le32_to_cpu(rp->log_page_size);
65 if (logfile_system_page_size < NTFS_BLOCK_SIZE ||
66 logfile_log_page_size < NTFS_BLOCK_SIZE ||
67 logfile_system_page_size &
68 (logfile_system_page_size - 1) ||
Robert P. J. Day02d53412009-06-16 15:33:35 -070069 !is_power_of_2(logfile_log_page_size)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 ntfs_error(vi->i_sb, "$LogFile uses unsupported page size.");
Richard Knutssonc49c3112006-09-30 23:27:12 -070071 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 }
73 /*
74 * We must be either at !pos (1st restart page) or at pos = system page
75 * size (2nd restart page).
76 */
77 if (pos && pos != logfile_system_page_size) {
78 ntfs_error(vi->i_sb, "Found restart area in incorrect "
79 "position in $LogFile.");
Richard Knutssonc49c3112006-09-30 23:27:12 -070080 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 }
82 /* We only know how to handle version 1.1. */
83 if (sle16_to_cpu(rp->major_ver) != 1 ||
84 sle16_to_cpu(rp->minor_ver) != 1) {
85 ntfs_error(vi->i_sb, "$LogFile version %i.%i is not "
86 "supported. (This driver supports version "
87 "1.1 only.)", (int)sle16_to_cpu(rp->major_ver),
88 (int)sle16_to_cpu(rp->minor_ver));
Richard Knutssonc49c3112006-09-30 23:27:12 -070089 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 }
Anton Altaparmakov5a8c0cc2005-09-26 10:48:54 +010091 /*
92 * If chkdsk has been run the restart page may not be protected by an
93 * update sequence array.
94 */
95 if (ntfs_is_chkd_record(rp->magic) && !le16_to_cpu(rp->usa_count)) {
Richard Knutssonc49c3112006-09-30 23:27:12 -070096 have_usa = false;
Anton Altaparmakov5a8c0cc2005-09-26 10:48:54 +010097 goto skip_usa_checks;
98 }
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 /* Verify the size of the update sequence array. */
100 usa_count = 1 + (logfile_system_page_size >> NTFS_BLOCK_SIZE_BITS);
101 if (usa_count != le16_to_cpu(rp->usa_count)) {
102 ntfs_error(vi->i_sb, "$LogFile restart page specifies "
103 "inconsistent update sequence array count.");
Richard Knutssonc49c3112006-09-30 23:27:12 -0700104 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 }
106 /* Verify the position of the update sequence array. */
107 usa_ofs = le16_to_cpu(rp->usa_ofs);
108 usa_end = usa_ofs + usa_count * sizeof(u16);
109 if (usa_ofs < sizeof(RESTART_PAGE_HEADER) ||
110 usa_end > NTFS_BLOCK_SIZE - sizeof(u16)) {
111 ntfs_error(vi->i_sb, "$LogFile restart page specifies "
112 "inconsistent update sequence array offset.");
Richard Knutssonc49c3112006-09-30 23:27:12 -0700113 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 }
Anton Altaparmakov5a8c0cc2005-09-26 10:48:54 +0100115skip_usa_checks:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 /*
117 * Verify the position of the restart area. It must be:
118 * - aligned to 8-byte boundary,
119 * - after the update sequence array, and
120 * - within the system page size.
121 */
122 ra_ofs = le16_to_cpu(rp->restart_area_offset);
Anton Altaparmakov5a8c0cc2005-09-26 10:48:54 +0100123 if (ra_ofs & 7 || (have_usa ? ra_ofs < usa_end :
124 ra_ofs < sizeof(RESTART_PAGE_HEADER)) ||
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 ra_ofs > logfile_system_page_size) {
126 ntfs_error(vi->i_sb, "$LogFile restart page specifies "
127 "inconsistent restart area offset.");
Richard Knutssonc49c3112006-09-30 23:27:12 -0700128 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 }
130 /*
131 * Only restart pages modified by chkdsk are allowed to have chkdsk_lsn
132 * set.
133 */
134 if (!ntfs_is_chkd_record(rp->magic) && sle64_to_cpu(rp->chkdsk_lsn)) {
135 ntfs_error(vi->i_sb, "$LogFile restart page is not modified "
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100136 "by chkdsk but a chkdsk LSN is specified.");
Richard Knutssonc49c3112006-09-30 23:27:12 -0700137 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 }
139 ntfs_debug("Done.");
Richard Knutssonc49c3112006-09-30 23:27:12 -0700140 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141}
142
143/**
144 * ntfs_check_restart_area - check the restart area for consistency
145 * @vi: $LogFile inode to which the restart page belongs
146 * @rp: restart page whose restart area to check
147 *
148 * Check the restart area of the restart page @rp for consistency and return
Richard Knutssonc49c3112006-09-30 23:27:12 -0700149 * 'true' if it is consistent and 'false' otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 *
151 * This function assumes that the restart page header has already been
152 * consistency checked.
153 *
154 * This function only needs NTFS_BLOCK_SIZE bytes in @rp, i.e. it does not
155 * require the full restart page.
156 */
Richard Knutssonc49c3112006-09-30 23:27:12 -0700157static bool ntfs_check_restart_area(struct inode *vi, RESTART_PAGE_HEADER *rp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158{
159 u64 file_size;
160 RESTART_AREA *ra;
161 u16 ra_ofs, ra_len, ca_ofs;
162 u8 fs_bits;
163
164 ntfs_debug("Entering.");
165 ra_ofs = le16_to_cpu(rp->restart_area_offset);
166 ra = (RESTART_AREA*)((u8*)rp + ra_ofs);
167 /*
168 * Everything before ra->file_size must be before the first word
169 * protected by an update sequence number. This ensures that it is
170 * safe to access ra->client_array_offset.
171 */
172 if (ra_ofs + offsetof(RESTART_AREA, file_size) >
173 NTFS_BLOCK_SIZE - sizeof(u16)) {
174 ntfs_error(vi->i_sb, "$LogFile restart area specifies "
175 "inconsistent file offset.");
Richard Knutssonc49c3112006-09-30 23:27:12 -0700176 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 }
178 /*
179 * Now that we can access ra->client_array_offset, make sure everything
180 * up to the log client array is before the first word protected by an
181 * update sequence number. This ensures we can access all of the
182 * restart area elements safely. Also, the client array offset must be
183 * aligned to an 8-byte boundary.
184 */
185 ca_ofs = le16_to_cpu(ra->client_array_offset);
186 if (((ca_ofs + 7) & ~7) != ca_ofs ||
187 ra_ofs + ca_ofs > NTFS_BLOCK_SIZE - sizeof(u16)) {
188 ntfs_error(vi->i_sb, "$LogFile restart area specifies "
189 "inconsistent client array offset.");
Richard Knutssonc49c3112006-09-30 23:27:12 -0700190 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 }
192 /*
193 * The restart area must end within the system page size both when
194 * calculated manually and as specified by ra->restart_area_length.
195 * Also, the calculated length must not exceed the specified length.
196 */
197 ra_len = ca_ofs + le16_to_cpu(ra->log_clients) *
198 sizeof(LOG_CLIENT_RECORD);
199 if (ra_ofs + ra_len > le32_to_cpu(rp->system_page_size) ||
200 ra_ofs + le16_to_cpu(ra->restart_area_length) >
201 le32_to_cpu(rp->system_page_size) ||
202 ra_len > le16_to_cpu(ra->restart_area_length)) {
203 ntfs_error(vi->i_sb, "$LogFile restart area is out of bounds "
204 "of the system page size specified by the "
205 "restart page header and/or the specified "
206 "restart area length is inconsistent.");
Richard Knutssonc49c3112006-09-30 23:27:12 -0700207 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 }
209 /*
210 * The ra->client_free_list and ra->client_in_use_list must be either
211 * LOGFILE_NO_CLIENT or less than ra->log_clients or they are
212 * overflowing the client array.
213 */
214 if ((ra->client_free_list != LOGFILE_NO_CLIENT &&
215 le16_to_cpu(ra->client_free_list) >=
216 le16_to_cpu(ra->log_clients)) ||
217 (ra->client_in_use_list != LOGFILE_NO_CLIENT &&
218 le16_to_cpu(ra->client_in_use_list) >=
219 le16_to_cpu(ra->log_clients))) {
220 ntfs_error(vi->i_sb, "$LogFile restart area specifies "
221 "overflowing client free and/or in use lists.");
Richard Knutssonc49c3112006-09-30 23:27:12 -0700222 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 }
224 /*
225 * Check ra->seq_number_bits against ra->file_size for consistency.
226 * We cannot just use ffs() because the file size is not a power of 2.
227 */
228 file_size = (u64)sle64_to_cpu(ra->file_size);
229 fs_bits = 0;
230 while (file_size) {
231 file_size >>= 1;
232 fs_bits++;
233 }
234 if (le32_to_cpu(ra->seq_number_bits) != 67 - fs_bits) {
235 ntfs_error(vi->i_sb, "$LogFile restart area specifies "
236 "inconsistent sequence number bits.");
Richard Knutssonc49c3112006-09-30 23:27:12 -0700237 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 }
239 /* The log record header length must be a multiple of 8. */
240 if (((le16_to_cpu(ra->log_record_header_length) + 7) & ~7) !=
241 le16_to_cpu(ra->log_record_header_length)) {
242 ntfs_error(vi->i_sb, "$LogFile restart area specifies "
243 "inconsistent log record header length.");
Richard Knutssonc49c3112006-09-30 23:27:12 -0700244 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 }
246 /* Dito for the log page data offset. */
247 if (((le16_to_cpu(ra->log_page_data_offset) + 7) & ~7) !=
248 le16_to_cpu(ra->log_page_data_offset)) {
249 ntfs_error(vi->i_sb, "$LogFile restart area specifies "
250 "inconsistent log page data offset.");
Richard Knutssonc49c3112006-09-30 23:27:12 -0700251 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 }
253 ntfs_debug("Done.");
Richard Knutssonc49c3112006-09-30 23:27:12 -0700254 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255}
256
257/**
258 * ntfs_check_log_client_array - check the log client array for consistency
259 * @vi: $LogFile inode to which the restart page belongs
260 * @rp: restart page whose log client array to check
261 *
262 * Check the log client array of the restart page @rp for consistency and
Richard Knutssonc49c3112006-09-30 23:27:12 -0700263 * return 'true' if it is consistent and 'false' otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 *
265 * This function assumes that the restart page header and the restart area have
266 * already been consistency checked.
267 *
268 * Unlike ntfs_check_restart_page_header() and ntfs_check_restart_area(), this
269 * function needs @rp->system_page_size bytes in @rp, i.e. it requires the full
270 * restart page and the page must be multi sector transfer deprotected.
271 */
Richard Knutssonc49c3112006-09-30 23:27:12 -0700272static bool ntfs_check_log_client_array(struct inode *vi,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 RESTART_PAGE_HEADER *rp)
274{
275 RESTART_AREA *ra;
276 LOG_CLIENT_RECORD *ca, *cr;
277 u16 nr_clients, idx;
Richard Knutssonc49c3112006-09-30 23:27:12 -0700278 bool in_free_list, idx_is_first;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279
280 ntfs_debug("Entering.");
281 ra = (RESTART_AREA*)((u8*)rp + le16_to_cpu(rp->restart_area_offset));
282 ca = (LOG_CLIENT_RECORD*)((u8*)ra +
283 le16_to_cpu(ra->client_array_offset));
284 /*
285 * Check the ra->client_free_list first and then check the
286 * ra->client_in_use_list. Check each of the log client records in
287 * each of the lists and check that the array does not overflow the
288 * ra->log_clients value. Also keep track of the number of records
289 * visited as there cannot be more than ra->log_clients records and
290 * that way we detect eventual loops in within a list.
291 */
292 nr_clients = le16_to_cpu(ra->log_clients);
293 idx = le16_to_cpu(ra->client_free_list);
Richard Knutssonc49c3112006-09-30 23:27:12 -0700294 in_free_list = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295check_list:
Richard Knutssonc49c3112006-09-30 23:27:12 -0700296 for (idx_is_first = true; idx != LOGFILE_NO_CLIENT_CPU; nr_clients--,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 idx = le16_to_cpu(cr->next_client)) {
298 if (!nr_clients || idx >= le16_to_cpu(ra->log_clients))
299 goto err_out;
300 /* Set @cr to the current log client record. */
301 cr = ca + idx;
302 /* The first log client record must not have a prev_client. */
303 if (idx_is_first) {
304 if (cr->prev_client != LOGFILE_NO_CLIENT)
305 goto err_out;
Richard Knutssonc49c3112006-09-30 23:27:12 -0700306 idx_is_first = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 }
308 }
309 /* Switch to and check the in use list if we just did the free list. */
310 if (in_free_list) {
Richard Knutssonc49c3112006-09-30 23:27:12 -0700311 in_free_list = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312 idx = le16_to_cpu(ra->client_in_use_list);
313 goto check_list;
314 }
315 ntfs_debug("Done.");
Richard Knutssonc49c3112006-09-30 23:27:12 -0700316 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317err_out:
318 ntfs_error(vi->i_sb, "$LogFile log client array is corrupt.");
Richard Knutssonc49c3112006-09-30 23:27:12 -0700319 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320}
321
322/**
323 * ntfs_check_and_load_restart_page - check the restart page for consistency
324 * @vi: $LogFile inode to which the restart page belongs
325 * @rp: restart page to check
326 * @pos: position in @vi at which the restart page resides
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100327 * @wrp: [OUT] copy of the multi sector transfer deprotected restart page
328 * @lsn: [OUT] set to the current logfile lsn on success
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 *
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100330 * Check the restart page @rp for consistency and return 0 if it is consistent
331 * and -errno otherwise. The restart page may have been modified by chkdsk in
332 * which case its magic is CHKD instead of RSTR.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 *
334 * This function only needs NTFS_BLOCK_SIZE bytes in @rp, i.e. it does not
335 * require the full restart page.
336 *
337 * If @wrp is not NULL, on success, *@wrp will point to a buffer containing a
338 * copy of the complete multi sector transfer deprotected page. On failure,
339 * *@wrp is undefined.
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100340 *
André Goddard Rosaaf901ca2009-11-14 13:09:05 -0200341 * Simillarly, if @lsn is not NULL, on success *@lsn will be set to the current
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100342 * logfile lsn according to this restart page. On failure, *@lsn is undefined.
343 *
344 * The following error codes are defined:
345 * -EINVAL - The restart page is inconsistent.
346 * -ENOMEM - Not enough memory to load the restart page.
347 * -EIO - Failed to reading from $LogFile.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 */
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100349static int ntfs_check_and_load_restart_page(struct inode *vi,
350 RESTART_PAGE_HEADER *rp, s64 pos, RESTART_PAGE_HEADER **wrp,
351 LSN *lsn)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352{
353 RESTART_AREA *ra;
354 RESTART_PAGE_HEADER *trp;
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100355 int size, err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356
357 ntfs_debug("Entering.");
358 /* Check the restart page header for consistency. */
359 if (!ntfs_check_restart_page_header(vi, rp, pos)) {
360 /* Error output already done inside the function. */
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100361 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 }
363 /* Check the restart area for consistency. */
364 if (!ntfs_check_restart_area(vi, rp)) {
365 /* Error output already done inside the function. */
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100366 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 }
368 ra = (RESTART_AREA*)((u8*)rp + le16_to_cpu(rp->restart_area_offset));
369 /*
370 * Allocate a buffer to store the whole restart page so we can multi
371 * sector transfer deprotect it.
372 */
373 trp = ntfs_malloc_nofs(le32_to_cpu(rp->system_page_size));
374 if (!trp) {
375 ntfs_error(vi->i_sb, "Failed to allocate memory for $LogFile "
376 "restart page buffer.");
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100377 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 }
379 /*
380 * Read the whole of the restart page into the buffer. If it fits
381 * completely inside @rp, just copy it from there. Otherwise map all
382 * the required pages and copy the data from them.
383 */
384 size = PAGE_CACHE_SIZE - (pos & ~PAGE_CACHE_MASK);
385 if (size >= le32_to_cpu(rp->system_page_size)) {
386 memcpy(trp, rp, le32_to_cpu(rp->system_page_size));
387 } else {
388 pgoff_t idx;
389 struct page *page;
390 int have_read, to_read;
391
392 /* First copy what we already have in @rp. */
393 memcpy(trp, rp, size);
394 /* Copy the remaining data one page at a time. */
395 have_read = size;
396 to_read = le32_to_cpu(rp->system_page_size) - size;
397 idx = (pos + size) >> PAGE_CACHE_SHIFT;
398 BUG_ON((pos + size) & ~PAGE_CACHE_MASK);
399 do {
400 page = ntfs_map_page(vi->i_mapping, idx);
401 if (IS_ERR(page)) {
402 ntfs_error(vi->i_sb, "Error mapping $LogFile "
403 "page (index %lu).", idx);
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100404 err = PTR_ERR(page);
405 if (err != -EIO && err != -ENOMEM)
406 err = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 goto err_out;
408 }
409 size = min_t(int, to_read, PAGE_CACHE_SIZE);
410 memcpy((u8*)trp + have_read, page_address(page), size);
411 ntfs_unmap_page(page);
412 have_read += size;
413 to_read -= size;
414 idx++;
415 } while (to_read > 0);
416 }
Anton Altaparmakov5a8c0cc2005-09-26 10:48:54 +0100417 /*
418 * Perform the multi sector transfer deprotection on the buffer if the
419 * restart page is protected.
420 */
421 if ((!ntfs_is_chkd_record(trp->magic) || le16_to_cpu(trp->usa_count))
422 && post_read_mst_fixup((NTFS_RECORD*)trp,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 le32_to_cpu(rp->system_page_size))) {
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100424 /*
425 * A multi sector tranfer error was detected. We only need to
426 * abort if the restart page contents exceed the multi sector
427 * transfer fixup of the first sector.
428 */
429 if (le16_to_cpu(rp->restart_area_offset) +
430 le16_to_cpu(ra->restart_area_length) >
431 NTFS_BLOCK_SIZE - sizeof(u16)) {
432 ntfs_error(vi->i_sb, "Multi sector transfer error "
433 "detected in $LogFile restart page.");
434 err = -EINVAL;
435 goto err_out;
436 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 }
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100438 /*
439 * If the restart page is modified by chkdsk or there are no active
440 * logfile clients, the logfile is consistent. Otherwise, need to
441 * check the log client records for consistency, too.
442 */
443 err = 0;
444 if (ntfs_is_rstr_record(rp->magic) &&
445 ra->client_in_use_list != LOGFILE_NO_CLIENT) {
446 if (!ntfs_check_log_client_array(vi, trp)) {
447 err = -EINVAL;
448 goto err_out;
449 }
450 }
451 if (lsn) {
452 if (ntfs_is_rstr_record(rp->magic))
453 *lsn = sle64_to_cpu(ra->current_lsn);
454 else /* if (ntfs_is_chkd_record(rp->magic)) */
455 *lsn = sle64_to_cpu(rp->chkdsk_lsn);
456 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 ntfs_debug("Done.");
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100458 if (wrp)
459 *wrp = trp;
460 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461err_out:
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100462 ntfs_free(trp);
463 }
464 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465}
466
467/**
Anton Altaparmakov3bd1f4a2005-06-25 16:51:58 +0100468 * ntfs_check_logfile - check the journal for consistency
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 * @log_vi: struct inode of loaded journal $LogFile to check
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100470 * @rp: [OUT] on success this is a copy of the current restart page
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 *
Richard Knutssonc49c3112006-09-30 23:27:12 -0700472 * Check the $LogFile journal for consistency and return 'true' if it is
473 * consistent and 'false' if not. On success, the current restart page is
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100474 * returned in *@rp. Caller must call ntfs_free(*@rp) when finished with it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 *
476 * At present we only check the two restart pages and ignore the log record
477 * pages.
478 *
479 * Note that the MstProtected flag is not set on the $LogFile inode and hence
480 * when reading pages they are not deprotected. This is because we do not know
481 * if the $LogFile was created on a system with a different page size to ours
482 * yet and mst deprotection would fail if our page size is smaller.
483 */
Richard Knutssonc49c3112006-09-30 23:27:12 -0700484bool ntfs_check_logfile(struct inode *log_vi, RESTART_PAGE_HEADER **rp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485{
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100486 s64 size, pos;
487 LSN rstr1_lsn, rstr2_lsn;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 ntfs_volume *vol = NTFS_SB(log_vi->i_sb);
489 struct address_space *mapping = log_vi->i_mapping;
490 struct page *page = NULL;
491 u8 *kaddr = NULL;
492 RESTART_PAGE_HEADER *rstr1_ph = NULL;
493 RESTART_PAGE_HEADER *rstr2_ph = NULL;
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100494 int log_page_size, log_page_mask, err;
Richard Knutssonc49c3112006-09-30 23:27:12 -0700495 bool logfile_is_empty = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 u8 log_page_bits;
497
498 ntfs_debug("Entering.");
499 /* An empty $LogFile must have been clean before it got emptied. */
500 if (NVolLogFileEmpty(vol))
501 goto is_empty;
Anton Altaparmakov66129f82004-11-11 12:34:00 +0000502 size = i_size_read(log_vi);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 /* Make sure the file doesn't exceed the maximum allowed size. */
504 if (size > MaxLogFileSize)
505 size = MaxLogFileSize;
506 /*
507 * Truncate size to a multiple of the page cache size or the default
508 * log page size if the page cache size is between the default log page
509 * log page size if the page cache size is between the default log page
510 * size and twice that.
511 */
512 if (PAGE_CACHE_SIZE >= DefaultLogPageSize && PAGE_CACHE_SIZE <=
513 DefaultLogPageSize * 2)
514 log_page_size = DefaultLogPageSize;
515 else
516 log_page_size = PAGE_CACHE_SIZE;
517 log_page_mask = log_page_size - 1;
518 /*
Akinobu Mitab9a28382006-03-26 01:39:53 -0800519 * Use ntfs_ffs() instead of ffs() to enable the compiler to
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 * optimize log_page_size and log_page_bits into constants.
521 */
Akinobu Mitab9a28382006-03-26 01:39:53 -0800522 log_page_bits = ntfs_ffs(log_page_size) - 1;
Anton Altaparmakov3bd1f4a2005-06-25 16:51:58 +0100523 size &= ~(s64)(log_page_size - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 /*
525 * Ensure the log file is big enough to store at least the two restart
526 * pages and the minimum number of log record pages.
527 */
528 if (size < log_page_size * 2 || (size - log_page_size * 2) >>
529 log_page_bits < MinLogRecordPages) {
530 ntfs_error(vol->sb, "$LogFile is too small.");
Richard Knutssonc49c3112006-09-30 23:27:12 -0700531 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 }
533 /*
534 * Read through the file looking for a restart page. Since the restart
535 * page header is at the beginning of a page we only need to search at
536 * what could be the beginning of a page (for each page size) rather
537 * than scanning the whole file byte by byte. If all potential places
538 * contain empty and uninitialzed records, the log file can be assumed
539 * to be empty.
540 */
541 for (pos = 0; pos < size; pos <<= 1) {
542 pgoff_t idx = pos >> PAGE_CACHE_SHIFT;
543 if (!page || page->index != idx) {
544 if (page)
545 ntfs_unmap_page(page);
546 page = ntfs_map_page(mapping, idx);
547 if (IS_ERR(page)) {
548 ntfs_error(vol->sb, "Error mapping $LogFile "
549 "page (index %lu).", idx);
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100550 goto err_out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 }
552 }
553 kaddr = (u8*)page_address(page) + (pos & ~PAGE_CACHE_MASK);
554 /*
555 * A non-empty block means the logfile is not empty while an
556 * empty block after a non-empty block has been encountered
557 * means we are done.
558 */
559 if (!ntfs_is_empty_recordp((le32*)kaddr))
Richard Knutssonc49c3112006-09-30 23:27:12 -0700560 logfile_is_empty = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 else if (!logfile_is_empty)
562 break;
563 /*
564 * A log record page means there cannot be a restart page after
565 * this so no need to continue searching.
566 */
567 if (ntfs_is_rcrd_recordp((le32*)kaddr))
568 break;
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100569 /* If not a (modified by chkdsk) restart page, continue. */
570 if (!ntfs_is_rstr_recordp((le32*)kaddr) &&
571 !ntfs_is_chkd_recordp((le32*)kaddr)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 if (!pos)
573 pos = NTFS_BLOCK_SIZE >> 1;
574 continue;
575 }
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100576 /*
577 * Check the (modified by chkdsk) restart page for consistency
578 * and get a copy of the complete multi sector transfer
579 * deprotected restart page.
580 */
581 err = ntfs_check_and_load_restart_page(log_vi,
582 (RESTART_PAGE_HEADER*)kaddr, pos,
583 !rstr1_ph ? &rstr1_ph : &rstr2_ph,
584 !rstr1_ph ? &rstr1_lsn : &rstr2_lsn);
585 if (!err) {
586 /*
587 * If we have now found the first (modified by chkdsk)
588 * restart page, continue looking for the second one.
589 */
590 if (!pos) {
591 pos = NTFS_BLOCK_SIZE >> 1;
592 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 }
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100594 /*
595 * We have now found the second (modified by chkdsk)
596 * restart page, so we can stop looking.
597 */
598 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 }
600 /*
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100601 * Error output already done inside the function. Note, we do
602 * not abort if the restart page was invalid as we might still
603 * find a valid one further in the file.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 */
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100605 if (err != -EINVAL) {
606 ntfs_unmap_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 goto err_out;
608 }
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100609 /* Continue looking. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 if (!pos)
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100611 pos = NTFS_BLOCK_SIZE >> 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 }
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100613 if (page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 ntfs_unmap_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 if (logfile_is_empty) {
616 NVolSetLogFileEmpty(vol);
617is_empty:
618 ntfs_debug("Done. ($LogFile is empty.)");
Richard Knutssonc49c3112006-09-30 23:27:12 -0700619 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 }
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100621 if (!rstr1_ph) {
622 BUG_ON(rstr2_ph);
623 ntfs_error(vol->sb, "Did not find any restart pages in "
624 "$LogFile and it was not empty.");
Richard Knutssonc49c3112006-09-30 23:27:12 -0700625 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 }
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100627 /* If both restart pages were found, use the more recent one. */
628 if (rstr2_ph) {
629 /*
630 * If the second restart area is more recent, switch to it.
631 * Otherwise just throw it away.
632 */
633 if (rstr2_lsn > rstr1_lsn) {
Anton Altaparmakov5a8c0cc2005-09-26 10:48:54 +0100634 ntfs_debug("Using second restart page as it is more "
635 "recent.");
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100636 ntfs_free(rstr1_ph);
637 rstr1_ph = rstr2_ph;
638 /* rstr1_lsn = rstr2_lsn; */
Anton Altaparmakov5a8c0cc2005-09-26 10:48:54 +0100639 } else {
640 ntfs_debug("Using first restart page as it is more "
641 "recent.");
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100642 ntfs_free(rstr2_ph);
Anton Altaparmakov5a8c0cc2005-09-26 10:48:54 +0100643 }
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100644 rstr2_ph = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 /* All consistency checks passed. */
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100647 if (rp)
648 *rp = rstr1_ph;
649 else
650 ntfs_free(rstr1_ph);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 ntfs_debug("Done.");
Richard Knutssonc49c3112006-09-30 23:27:12 -0700652 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653err_out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 if (rstr1_ph)
655 ntfs_free(rstr1_ph);
Richard Knutssonc49c3112006-09-30 23:27:12 -0700656 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657}
658
659/**
660 * ntfs_is_logfile_clean - check in the journal if the volume is clean
661 * @log_vi: struct inode of loaded journal $LogFile to check
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100662 * @rp: copy of the current restart page
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 *
Richard Knutssonc49c3112006-09-30 23:27:12 -0700664 * Analyze the $LogFile journal and return 'true' if it indicates the volume was
665 * shutdown cleanly and 'false' if not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 *
667 * At present we only look at the two restart pages and ignore the log record
668 * pages. This is a little bit crude in that there will be a very small number
669 * of cases where we think that a volume is dirty when in fact it is clean.
670 * This should only affect volumes that have not been shutdown cleanly but did
671 * not have any pending, non-check-pointed i/o, i.e. they were completely idle
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300672 * at least for the five seconds preceding the unclean shutdown.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 *
674 * This function assumes that the $LogFile journal has already been consistency
675 * checked by a call to ntfs_check_logfile() and in particular if the $LogFile
676 * is empty this function requires that NVolLogFileEmpty() is true otherwise an
677 * empty volume will be reported as dirty.
678 */
Richard Knutssonc49c3112006-09-30 23:27:12 -0700679bool ntfs_is_logfile_clean(struct inode *log_vi, const RESTART_PAGE_HEADER *rp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680{
681 ntfs_volume *vol = NTFS_SB(log_vi->i_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 RESTART_AREA *ra;
683
684 ntfs_debug("Entering.");
685 /* An empty $LogFile must have been clean before it got emptied. */
686 if (NVolLogFileEmpty(vol)) {
687 ntfs_debug("Done. ($LogFile is empty.)");
Richard Knutssonc49c3112006-09-30 23:27:12 -0700688 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 }
Anton Altaparmakove7a10332005-09-08 16:12:28 +0100690 BUG_ON(!rp);
691 if (!ntfs_is_rstr_record(rp->magic) &&
692 !ntfs_is_chkd_record(rp->magic)) {
693 ntfs_error(vol->sb, "Restart page buffer is invalid. This is "
694 "probably a bug in that the $LogFile should "
695 "have been consistency checked before calling "
696 "this function.");
Richard Knutssonc49c3112006-09-30 23:27:12 -0700697 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 ra = (RESTART_AREA*)((u8*)rp + le16_to_cpu(rp->restart_area_offset));
700 /*
701 * If the $LogFile has active clients, i.e. it is open, and we do not
702 * have the RESTART_VOLUME_IS_CLEAN bit set in the restart area flags,
703 * we assume there was an unclean shutdown.
704 */
705 if (ra->client_in_use_list != LOGFILE_NO_CLIENT &&
706 !(ra->flags & RESTART_VOLUME_IS_CLEAN)) {
707 ntfs_debug("Done. $LogFile indicates a dirty shutdown.");
Richard Knutssonc49c3112006-09-30 23:27:12 -0700708 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 /* $LogFile indicates a clean shutdown. */
711 ntfs_debug("Done. $LogFile indicates a clean shutdown.");
Richard Knutssonc49c3112006-09-30 23:27:12 -0700712 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713}
714
715/**
716 * ntfs_empty_logfile - empty the contents of the $LogFile journal
717 * @log_vi: struct inode of loaded journal $LogFile to empty
718 *
Richard Knutssonc49c3112006-09-30 23:27:12 -0700719 * Empty the contents of the $LogFile journal @log_vi and return 'true' on
720 * success and 'false' on error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 *
722 * This function assumes that the $LogFile journal has already been consistency
723 * checked by a call to ntfs_check_logfile() and that ntfs_is_logfile_clean()
724 * has been used to ensure that the $LogFile is clean.
725 */
Richard Knutssonc49c3112006-09-30 23:27:12 -0700726bool ntfs_empty_logfile(struct inode *log_vi)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727{
Anton Altaparmakovbfab36e2007-10-12 09:37:15 +0100728 VCN vcn, end_vcn;
729 ntfs_inode *log_ni = NTFS_I(log_vi);
730 ntfs_volume *vol = log_ni->vol;
731 struct super_block *sb = vol->sb;
732 runlist_element *rl;
733 unsigned long flags;
734 unsigned block_size, block_size_bits;
735 int err;
736 bool should_wait = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737
738 ntfs_debug("Entering.");
Anton Altaparmakovbfab36e2007-10-12 09:37:15 +0100739 if (NVolLogFileEmpty(vol)) {
740 ntfs_debug("Done.");
741 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 }
Anton Altaparmakovbfab36e2007-10-12 09:37:15 +0100743 /*
744 * We cannot use ntfs_attr_set() because we may be still in the middle
745 * of a mount operation. Thus we do the emptying by hand by first
746 * zapping the page cache pages for the $LogFile/$DATA attribute and
747 * then emptying each of the buffers in each of the clusters specified
748 * by the runlist by hand.
749 */
750 block_size = sb->s_blocksize;
751 block_size_bits = sb->s_blocksize_bits;
752 vcn = 0;
753 read_lock_irqsave(&log_ni->size_lock, flags);
754 end_vcn = (log_ni->initialized_size + vol->cluster_size_mask) >>
755 vol->cluster_size_bits;
756 read_unlock_irqrestore(&log_ni->size_lock, flags);
757 truncate_inode_pages(log_vi->i_mapping, 0);
758 down_write(&log_ni->runlist.lock);
759 rl = log_ni->runlist.rl;
760 if (unlikely(!rl || vcn < rl->vcn || !rl->length)) {
761map_vcn:
762 err = ntfs_map_runlist_nolock(log_ni, vcn, NULL);
763 if (err) {
764 ntfs_error(sb, "Failed to map runlist fragment (error "
765 "%d).", -err);
766 goto err;
767 }
768 rl = log_ni->runlist.rl;
769 BUG_ON(!rl || vcn < rl->vcn || !rl->length);
770 }
771 /* Seek to the runlist element containing @vcn. */
772 while (rl->length && vcn >= rl[1].vcn)
773 rl++;
774 do {
775 LCN lcn;
776 sector_t block, end_block;
777 s64 len;
778
779 /*
780 * If this run is not mapped map it now and start again as the
781 * runlist will have been updated.
782 */
783 lcn = rl->lcn;
784 if (unlikely(lcn == LCN_RL_NOT_MAPPED)) {
785 vcn = rl->vcn;
786 goto map_vcn;
787 }
788 /* If this run is not valid abort with an error. */
789 if (unlikely(!rl->length || lcn < LCN_HOLE))
790 goto rl_err;
791 /* Skip holes. */
792 if (lcn == LCN_HOLE)
793 continue;
794 block = lcn << vol->cluster_size_bits >> block_size_bits;
795 len = rl->length;
796 if (rl[1].vcn > end_vcn)
797 len = end_vcn - rl->vcn;
798 end_block = (lcn + len) << vol->cluster_size_bits >>
799 block_size_bits;
800 /* Iterate over the blocks in the run and empty them. */
801 do {
802 struct buffer_head *bh;
803
804 /* Obtain the buffer, possibly not uptodate. */
805 bh = sb_getblk(sb, block);
806 BUG_ON(!bh);
807 /* Setup buffer i/o submission. */
808 lock_buffer(bh);
809 bh->b_end_io = end_buffer_write_sync;
810 get_bh(bh);
811 /* Set the entire contents of the buffer to 0xff. */
812 memset(bh->b_data, -1, block_size);
813 if (!buffer_uptodate(bh))
814 set_buffer_uptodate(bh);
815 if (buffer_dirty(bh))
816 clear_buffer_dirty(bh);
817 /*
818 * Submit the buffer and wait for i/o to complete but
819 * only for the first buffer so we do not miss really
820 * serious i/o errors. Once the first buffer has
821 * completed ignore errors afterwards as we can assume
822 * that if one buffer worked all of them will work.
823 */
824 submit_bh(WRITE, bh);
825 if (should_wait) {
826 should_wait = false;
827 wait_on_buffer(bh);
828 if (unlikely(!buffer_uptodate(bh)))
829 goto io_err;
830 }
831 brelse(bh);
832 } while (++block < end_block);
833 } while ((++rl)->vcn < end_vcn);
834 up_write(&log_ni->runlist.lock);
835 /*
836 * Zap the pages again just in case any got instantiated whilst we were
837 * emptying the blocks by hand. FIXME: We may not have completed
838 * writing to all the buffer heads yet so this may happen too early.
839 * We really should use a kernel thread to do the emptying
840 * asynchronously and then we can also set the volume dirty and output
841 * an error message if emptying should fail.
842 */
843 truncate_inode_pages(log_vi->i_mapping, 0);
844 /* Set the flag so we do not have to do it again on remount. */
845 NVolSetLogFileEmpty(vol);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 ntfs_debug("Done.");
Richard Knutssonc49c3112006-09-30 23:27:12 -0700847 return true;
Anton Altaparmakovbfab36e2007-10-12 09:37:15 +0100848io_err:
849 ntfs_error(sb, "Failed to write buffer. Unmount and run chkdsk.");
850 goto dirty_err;
851rl_err:
852 ntfs_error(sb, "Runlist is corrupt. Unmount and run chkdsk.");
853dirty_err:
854 NVolSetErrors(vol);
855 err = -EIO;
856err:
857 up_write(&log_ni->runlist.lock);
858 ntfs_error(sb, "Failed to fill $LogFile with 0xff bytes (error %d).",
859 -err);
860 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861}
862
863#endif /* NTFS_RW */