2 * Squashfs - a compressed read only filesystem for Linux
4 * Copyright (c) 2002, 2003, 2004, 2005, 2006, 2007, 2008
5 * Phillip Lougher <phillip@lougher.demon.co.uk>
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2,
10 * or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
25 * This file implements the low-level routines to read and decompress
26 * datablocks and metadata blocks.
30 #include <linux/vfs.h>
31 #include <linux/slab.h>
32 #include <linux/mutex.h>
33 #include <linux/string.h>
34 #include <linux/buffer_head.h>
35 #include <linux/zlib.h>
37 #include "squashfs_fs.h"
38 #include "squashfs_fs_sb.h"
39 #include "squashfs_fs_i.h"
43 * Read the metadata block length, this is stored in the first two
44 * bytes of the metadata block.
46 static struct buffer_head *get_block_length(struct super_block *sb,
47 u64 *cur_index, int *offset, int *length)
49 struct squashfs_sb_info *msblk = sb->s_fs_info;
50 struct buffer_head *bh;
52 bh = sb_bread(sb, *cur_index);
56 if (msblk->devblksize - *offset == 1) {
57 *length = (unsigned char) bh->b_data[*offset];
59 bh = sb_bread(sb, ++(*cur_index));
62 *length |= (unsigned char) bh->b_data[0] << 8;
65 *length = (unsigned char) bh->b_data[*offset] |
66 (unsigned char) bh->b_data[*offset + 1] << 8;
75 * Read and decompress a metadata block or datablock. Length is non-zero
76 * if a datablock is being read (the size is stored elsewhere in the
77 * filesystem), otherwise the length is obtained from the first two bytes of
78 * the metadata block. A bit in the length field indicates if the block
79 * is stored uncompressed in the filesystem (usually because compression
80 * generated a larger block - this does occasionally happen with zlib).
82 int squashfs_read_data(struct super_block *sb, void **buffer, u64 index,
83 int length, u64 *next_index, int srclength, int pages)
85 struct squashfs_sb_info *msblk = sb->s_fs_info;
86 struct buffer_head **bh;
87 int offset = index & ((1 << msblk->devblksize_log2) - 1);
88 u64 cur_index = index >> msblk->devblksize_log2;
89 int bytes, compressed, b = 0, k = 0, page = 0, avail;
92 bh = kcalloc((msblk->block_size >> msblk->devblksize_log2) + 1,
93 sizeof(*bh), GFP_KERNEL);
102 compressed = SQUASHFS_COMPRESSED_BLOCK(length);
103 length = SQUASHFS_COMPRESSED_SIZE_BLOCK(length);
105 *next_index = index + length;
107 TRACE("Block @ 0x%llx, %scompressed size %d, src size %d\n",
108 index, compressed ? "" : "un", length, srclength);
110 if (length < 0 || length > srclength ||
111 (index + length) > msblk->bytes_used)
114 for (b = 0; bytes < length; b++, cur_index++) {
115 bh[b] = sb_getblk(sb, cur_index);
118 bytes += msblk->devblksize;
120 ll_rw_block(READ, b, bh);
125 if ((index + 2) > msblk->bytes_used)
128 bh[0] = get_block_length(sb, &cur_index, &offset, &length);
133 bytes = msblk->devblksize - offset;
134 compressed = SQUASHFS_COMPRESSED(length);
135 length = SQUASHFS_COMPRESSED_SIZE(length);
137 *next_index = index + length + 2;
139 TRACE("Block @ 0x%llx, %scompressed size %d\n", index,
140 compressed ? "" : "un", length);
142 if (length < 0 || length > srclength ||
143 (index + length) > msblk->bytes_used)
146 for (; bytes < length; b++) {
147 bh[b] = sb_getblk(sb, ++cur_index);
150 bytes += msblk->devblksize;
152 ll_rw_block(READ, b - 1, bh + 1);
156 int zlib_err = 0, zlib_init = 0;
162 mutex_lock(&msblk->read_data_mutex);
164 msblk->stream.avail_out = 0;
165 msblk->stream.avail_in = 0;
169 if (msblk->stream.avail_in == 0 && k < b) {
170 avail = min(bytes, msblk->devblksize - offset);
172 wait_on_buffer(bh[k]);
173 if (!buffer_uptodate(bh[k]))
182 msblk->stream.next_in = bh[k]->b_data + offset;
183 msblk->stream.avail_in = avail;
187 if (msblk->stream.avail_out == 0) {
189 ERROR("zlib_inflate tried to "
190 "decompress too much data, "
191 "expected %d bytes. Zlib "
192 "data probably corrupt\n",
196 msblk->stream.next_out = buffer[page++];
197 msblk->stream.avail_out = PAGE_CACHE_SIZE;
201 zlib_err = zlib_inflateInit(&msblk->stream);
202 if (zlib_err != Z_OK) {
203 ERROR("zlib_inflateInit returned"
204 " unexpected result 0x%x,"
205 " srclength %d\n", zlib_err,
212 zlib_err = zlib_inflate(&msblk->stream, Z_NO_FLUSH);
214 if (msblk->stream.avail_in == 0 && k < b)
216 } while (zlib_err == Z_OK);
218 if (zlib_err != Z_STREAM_END) {
219 ERROR("zlib_inflate returned unexpected result"
220 " 0x%x, srclength %d, avail_in %d,"
221 " avail_out %d\n", zlib_err, srclength,
222 msblk->stream.avail_in,
223 msblk->stream.avail_out);
227 zlib_err = zlib_inflateEnd(&msblk->stream);
228 if (zlib_err != Z_OK) {
229 ERROR("zlib_inflateEnd returned unexpected result 0x%x,"
230 " srclength %d\n", zlib_err, srclength);
233 length = msblk->stream.total_out;
234 mutex_unlock(&msblk->read_data_mutex);
237 * Block is uncompressed.
239 int i, in, pg_offset = 0;
241 for (i = 0; i < b; i++) {
242 wait_on_buffer(bh[i]);
243 if (!buffer_uptodate(bh[i]))
247 for (bytes = length; k < b; k++) {
248 in = min(bytes, msblk->devblksize - offset);
251 if (pg_offset == PAGE_CACHE_SIZE) {
255 avail = min_t(int, in, PAGE_CACHE_SIZE -
257 memcpy(buffer[page] + pg_offset,
258 bh[k]->b_data + offset, avail);
272 mutex_unlock(&msblk->read_data_mutex);
279 ERROR("squashfs_read_data failed to read block 0x%llx\n",
280 (unsigned long long) index);