blob: 7de35bf297aad90d10e27744112a98f2456e388f [file] [log] [blame]
Phillip Lougher4c0f0bb2009-10-06 04:04:15 +01001/*
2 * Squashfs - a compressed read only filesystem for Linux
3 *
4 * Copyright (c) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
Phillip Lougherd7f2ff62011-05-26 10:39:56 +01005 * Phillip Lougher <phillip@squashfs.org.uk>
Phillip Lougher4c0f0bb2009-10-06 04:04:15 +01006 *
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.
11 *
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.
16 *
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.
20 *
21 * decompressor.c
22 */
23
24#include <linux/types.h>
25#include <linux/mutex.h>
Phillip Lougherb7fc0ff2011-02-28 01:45:42 +000026#include <linux/slab.h>
Adrien Schildknecht38840af2016-09-28 13:59:18 -070027#include <linux/highmem.h>
28#include <linux/fs.h>
Phillip Lougher4c0f0bb2009-10-06 04:04:15 +010029
30#include "squashfs_fs.h"
31#include "squashfs_fs_sb.h"
Phillip Lougher4c0f0bb2009-10-06 04:04:15 +010032#include "decompressor.h"
33#include "squashfs.h"
Phillip Lougher846b7302013-11-18 02:59:12 +000034#include "page_actor.h"
Phillip Lougher4c0f0bb2009-10-06 04:04:15 +010035
36/*
37 * This file (and decompressor.h) implements a decompressor framework for
38 * Squashfs, allowing multiple decompressors to be easily supported
39 */
40
Phillip Lougherdc325672009-10-14 03:58:11 +010041static const struct squashfs_decompressor squashfs_lzma_unsupported_comp_ops = {
Phillip Lougher9508c6b2013-11-13 02:56:26 +000042 NULL, NULL, NULL, NULL, LZMA_COMPRESSION, "lzma", 0
Phillip Lougherdc325672009-10-14 03:58:11 +010043};
44
Phillip Lougher62421642014-11-27 18:48:44 +000045#ifndef CONFIG_SQUASHFS_LZ4
46static const struct squashfs_decompressor squashfs_lz4_comp_ops = {
47 NULL, NULL, NULL, NULL, LZ4_COMPRESSION, "lz4", 0
48};
49#endif
50
Chan Jeong79cb8ce2010-08-05 02:29:59 +010051#ifndef CONFIG_SQUASHFS_LZO
Phillip Lougher01a678c2011-01-05 18:23:53 +000052static const struct squashfs_decompressor squashfs_lzo_comp_ops = {
Phillip Lougher9508c6b2013-11-13 02:56:26 +000053 NULL, NULL, NULL, NULL, LZO_COMPRESSION, "lzo", 0
Phillip Lougherdc325672009-10-14 03:58:11 +010054};
Chan Jeong79cb8ce2010-08-05 02:29:59 +010055#endif
Phillip Lougherdc325672009-10-14 03:58:11 +010056
Phillip Lougher7a43ae52010-12-09 02:08:31 +000057#ifndef CONFIG_SQUASHFS_XZ
58static const struct squashfs_decompressor squashfs_xz_comp_ops = {
Phillip Lougher9508c6b2013-11-13 02:56:26 +000059 NULL, NULL, NULL, NULL, XZ_COMPRESSION, "xz", 0
Phillip Lougher7a43ae52010-12-09 02:08:31 +000060};
61#endif
62
Phillip Loughercc6d3492011-07-22 03:01:28 +010063#ifndef CONFIG_SQUASHFS_ZLIB
64static const struct squashfs_decompressor squashfs_zlib_comp_ops = {
Phillip Lougher9508c6b2013-11-13 02:56:26 +000065 NULL, NULL, NULL, NULL, ZLIB_COMPRESSION, "zlib", 0
Phillip Loughercc6d3492011-07-22 03:01:28 +010066};
67#endif
68
Phillip Lougher4c0f0bb2009-10-06 04:04:15 +010069static const struct squashfs_decompressor squashfs_unknown_comp_ops = {
Phillip Lougher9508c6b2013-11-13 02:56:26 +000070 NULL, NULL, NULL, NULL, 0, "unknown", 0
Phillip Lougher4c0f0bb2009-10-06 04:04:15 +010071};
72
73static const struct squashfs_decompressor *decompressor[] = {
74 &squashfs_zlib_comp_ops,
Phillip Lougher62421642014-11-27 18:48:44 +000075 &squashfs_lz4_comp_ops,
Chan Jeong79cb8ce2010-08-05 02:29:59 +010076 &squashfs_lzo_comp_ops,
Phillip Lougher7a43ae52010-12-09 02:08:31 +000077 &squashfs_xz_comp_ops,
Phillip Lougher01a678c2011-01-05 18:23:53 +000078 &squashfs_lzma_unsupported_comp_ops,
Phillip Lougher4c0f0bb2009-10-06 04:04:15 +010079 &squashfs_unknown_comp_ops
80};
81
82
83const struct squashfs_decompressor *squashfs_lookup_decompressor(int id)
84{
85 int i;
86
87 for (i = 0; decompressor[i]->id; i++)
88 if (id == decompressor[i]->id)
89 break;
90
91 return decompressor[i];
92}
Phillip Lougherb7fc0ff2011-02-28 01:45:42 +000093
94
Phillip Lougher9508c6b2013-11-13 02:56:26 +000095static void *get_comp_opts(struct super_block *sb, unsigned short flags)
Phillip Lougherb7fc0ff2011-02-28 01:45:42 +000096{
97 struct squashfs_sb_info *msblk = sb->s_fs_info;
Adrien Schildknecht38840af2016-09-28 13:59:18 -070098 void *comp_opts, *buffer = NULL;
99 struct page *page;
Phillip Lougher846b7302013-11-18 02:59:12 +0000100 struct squashfs_page_actor *actor = NULL;
Phillip Lougherb7fc0ff2011-02-28 01:45:42 +0000101 int length = 0;
102
Adrien Schildknecht38840af2016-09-28 13:59:18 -0700103 if (!SQUASHFS_COMP_OPTS(flags))
104 return squashfs_comp_opts(msblk, buffer, length);
105
Phillip Lougherb7fc0ff2011-02-28 01:45:42 +0000106 /*
107 * Read decompressor specific options from file system if present
108 */
Phillip Lougherb7fc0ff2011-02-28 01:45:42 +0000109
Adrien Schildknecht38840af2016-09-28 13:59:18 -0700110 page = alloc_page(GFP_KERNEL);
111 if (!page)
112 return ERR_PTR(-ENOMEM);
Phillip Lougher846b7302013-11-18 02:59:12 +0000113
Adrien Schildknecht38840af2016-09-28 13:59:18 -0700114 actor = squashfs_page_actor_init(&page, 1, 0, NULL);
115 if (actor == NULL) {
116 comp_opts = ERR_PTR(-ENOMEM);
117 goto actor_error;
Phillip Lougherb7fc0ff2011-02-28 01:45:42 +0000118 }
119
Adrien Schildknecht38840af2016-09-28 13:59:18 -0700120 length = squashfs_read_data(sb,
121 sizeof(struct squashfs_super_block), 0, NULL, actor);
Phillip Lougherb7fc0ff2011-02-28 01:45:42 +0000122
Adrien Schildknecht38840af2016-09-28 13:59:18 -0700123 if (length < 0) {
124 comp_opts = ERR_PTR(length);
125 goto read_error;
126 }
127
128 buffer = kmap_atomic(page);
129 comp_opts = squashfs_comp_opts(msblk, buffer, length);
130 kunmap_atomic(buffer);
131
132read_error:
133 squashfs_page_actor_free(actor, 0);
134actor_error:
135 __free_page(page);
Phillip Lougher9508c6b2013-11-13 02:56:26 +0000136 return comp_opts;
137}
Phillip Lougherb7fc0ff2011-02-28 01:45:42 +0000138
Phillip Lougher9508c6b2013-11-13 02:56:26 +0000139
140void *squashfs_decompressor_setup(struct super_block *sb, unsigned short flags)
141{
142 struct squashfs_sb_info *msblk = sb->s_fs_info;
143 void *stream, *comp_opts = get_comp_opts(sb, flags);
144
145 if (IS_ERR(comp_opts))
146 return comp_opts;
147
148 stream = squashfs_decompressor_create(msblk, comp_opts);
149 if (IS_ERR(stream))
150 kfree(comp_opts);
151
152 return stream;
Phillip Lougherb7fc0ff2011-02-28 01:45:42 +0000153}