11da177e4SLinus Torvalds /* 21da177e4SLinus Torvalds * JFFS2 -- Journalling Flash File System, Version 2. 31da177e4SLinus Torvalds * 4c00c310eSDavid Woodhouse * Copyright © 2001-2007 Red Hat, Inc. 56088c058SDavid Woodhouse * Copyright © 2004-2010 David Woodhouse <dwmw2@infradead.org> 61da177e4SLinus Torvalds * 71da177e4SLinus Torvalds * Created by David Woodhouse <dwmw2@infradead.org> 81da177e4SLinus Torvalds * 91da177e4SLinus Torvalds * For licensing information, see the file 'LICENCE' in this directory. 101da177e4SLinus Torvalds * 111da177e4SLinus Torvalds */ 121da177e4SLinus Torvalds 131da177e4SLinus Torvalds #if !defined(__KERNEL__) && !defined(__ECOS) 141da177e4SLinus Torvalds #error "The userspace support got too messy and was removed. Update your mkfs.jffs2" 151da177e4SLinus Torvalds #endif 161da177e4SLinus Torvalds 171da177e4SLinus Torvalds #include <linux/kernel.h> 181da177e4SLinus Torvalds #include <linux/zlib.h> 191da177e4SLinus Torvalds #include <linux/zutil.h> 201da177e4SLinus Torvalds #include "nodelist.h" 211da177e4SLinus Torvalds #include "compr.h" 221da177e4SLinus Torvalds 231da177e4SLinus Torvalds /* Plan: call deflate() with avail_in == *sourcelen, 241da177e4SLinus Torvalds avail_out = *dstlen - 12 and flush == Z_FINISH. 251da177e4SLinus Torvalds If it doesn't manage to finish, call it again with 261da177e4SLinus Torvalds avail_in == 0 and avail_out set to the remaining 12 271da177e4SLinus Torvalds bytes for it to clean up. 281da177e4SLinus Torvalds Q: Is 12 bytes sufficient? 291da177e4SLinus Torvalds */ 301da177e4SLinus Torvalds #define STREAM_END_SPACE 12 311da177e4SLinus Torvalds 32353ab6e9SIngo Molnar static DEFINE_MUTEX(deflate_mutex); 33353ab6e9SIngo Molnar static DEFINE_MUTEX(inflate_mutex); 341da177e4SLinus Torvalds static z_stream inf_strm, def_strm; 351da177e4SLinus Torvalds 361da177e4SLinus Torvalds #ifdef __KERNEL__ /* Linux-only */ 371da177e4SLinus Torvalds #include <linux/vmalloc.h> 381da177e4SLinus Torvalds #include <linux/init.h> 39353ab6e9SIngo Molnar #include <linux/mutex.h> 401da177e4SLinus Torvalds 411da177e4SLinus Torvalds static int __init alloc_workspaces(void) 421da177e4SLinus Torvalds { 43565d76cbSJim Keniston def_strm.workspace = vmalloc(zlib_deflate_workspacesize(MAX_WBITS, 44565d76cbSJim Keniston MAX_MEM_LEVEL)); 45045ead34SJoe Perches if (!def_strm.workspace) 461da177e4SLinus Torvalds return -ENOMEM; 47045ead34SJoe Perches 48565d76cbSJim Keniston D1(printk(KERN_DEBUG "Allocated %d bytes for deflate workspace\n", zlib_deflate_workspacesize(MAX_WBITS, MAX_MEM_LEVEL))); 491da177e4SLinus Torvalds inf_strm.workspace = vmalloc(zlib_inflate_workspacesize()); 501da177e4SLinus Torvalds if (!inf_strm.workspace) { 511da177e4SLinus Torvalds vfree(def_strm.workspace); 521da177e4SLinus Torvalds return -ENOMEM; 531da177e4SLinus Torvalds } 541da177e4SLinus Torvalds D1(printk(KERN_DEBUG "Allocated %d bytes for inflate workspace\n", zlib_inflate_workspacesize())); 551da177e4SLinus Torvalds return 0; 561da177e4SLinus Torvalds } 571da177e4SLinus Torvalds 581da177e4SLinus Torvalds static void free_workspaces(void) 591da177e4SLinus Torvalds { 601da177e4SLinus Torvalds vfree(def_strm.workspace); 611da177e4SLinus Torvalds vfree(inf_strm.workspace); 621da177e4SLinus Torvalds } 631da177e4SLinus Torvalds #else 641da177e4SLinus Torvalds #define alloc_workspaces() (0) 651da177e4SLinus Torvalds #define free_workspaces() do { } while(0) 661da177e4SLinus Torvalds #endif /* __KERNEL__ */ 671da177e4SLinus Torvalds 6875c96f85SAdrian Bunk static int jffs2_zlib_compress(unsigned char *data_in, 6975c96f85SAdrian Bunk unsigned char *cpage_out, 70088bd455SMike Frysinger uint32_t *sourcelen, uint32_t *dstlen) 711da177e4SLinus Torvalds { 721da177e4SLinus Torvalds int ret; 731da177e4SLinus Torvalds 741da177e4SLinus Torvalds if (*dstlen <= STREAM_END_SPACE) 751da177e4SLinus Torvalds return -1; 761da177e4SLinus Torvalds 77353ab6e9SIngo Molnar mutex_lock(&deflate_mutex); 781da177e4SLinus Torvalds 791da177e4SLinus Torvalds if (Z_OK != zlib_deflateInit(&def_strm, 3)) { 801da177e4SLinus Torvalds printk(KERN_WARNING "deflateInit failed\n"); 81353ab6e9SIngo Molnar mutex_unlock(&deflate_mutex); 821da177e4SLinus Torvalds return -1; 831da177e4SLinus Torvalds } 841da177e4SLinus Torvalds 851da177e4SLinus Torvalds def_strm.next_in = data_in; 861da177e4SLinus Torvalds def_strm.total_in = 0; 871da177e4SLinus Torvalds 881da177e4SLinus Torvalds def_strm.next_out = cpage_out; 891da177e4SLinus Torvalds def_strm.total_out = 0; 901da177e4SLinus Torvalds 911da177e4SLinus Torvalds while (def_strm.total_out < *dstlen - STREAM_END_SPACE && def_strm.total_in < *sourcelen) { 921da177e4SLinus Torvalds def_strm.avail_out = *dstlen - (def_strm.total_out + STREAM_END_SPACE); 931da177e4SLinus Torvalds def_strm.avail_in = min((unsigned)(*sourcelen-def_strm.total_in), def_strm.avail_out); 941da177e4SLinus Torvalds D1(printk(KERN_DEBUG "calling deflate with avail_in %d, avail_out %d\n", 951da177e4SLinus Torvalds def_strm.avail_in, def_strm.avail_out)); 961da177e4SLinus Torvalds ret = zlib_deflate(&def_strm, Z_PARTIAL_FLUSH); 971da177e4SLinus Torvalds D1(printk(KERN_DEBUG "deflate returned with avail_in %d, avail_out %d, total_in %ld, total_out %ld\n", 981da177e4SLinus Torvalds def_strm.avail_in, def_strm.avail_out, def_strm.total_in, def_strm.total_out)); 991da177e4SLinus Torvalds if (ret != Z_OK) { 1001da177e4SLinus Torvalds D1(printk(KERN_DEBUG "deflate in loop returned %d\n", ret)); 1011da177e4SLinus Torvalds zlib_deflateEnd(&def_strm); 102353ab6e9SIngo Molnar mutex_unlock(&deflate_mutex); 1031da177e4SLinus Torvalds return -1; 1041da177e4SLinus Torvalds } 1051da177e4SLinus Torvalds } 1061da177e4SLinus Torvalds def_strm.avail_out += STREAM_END_SPACE; 1071da177e4SLinus Torvalds def_strm.avail_in = 0; 1081da177e4SLinus Torvalds ret = zlib_deflate(&def_strm, Z_FINISH); 1091da177e4SLinus Torvalds zlib_deflateEnd(&def_strm); 1101da177e4SLinus Torvalds 1111da177e4SLinus Torvalds if (ret != Z_STREAM_END) { 1121da177e4SLinus Torvalds D1(printk(KERN_DEBUG "final deflate returned %d\n", ret)); 1131da177e4SLinus Torvalds ret = -1; 1141da177e4SLinus Torvalds goto out; 1151da177e4SLinus Torvalds } 1161da177e4SLinus Torvalds 1171da177e4SLinus Torvalds if (def_strm.total_out >= def_strm.total_in) { 1181da177e4SLinus Torvalds D1(printk(KERN_DEBUG "zlib compressed %ld bytes into %ld; failing\n", 1191da177e4SLinus Torvalds def_strm.total_in, def_strm.total_out)); 1201da177e4SLinus Torvalds ret = -1; 1211da177e4SLinus Torvalds goto out; 1221da177e4SLinus Torvalds } 1231da177e4SLinus Torvalds 1241da177e4SLinus Torvalds D1(printk(KERN_DEBUG "zlib compressed %ld bytes into %ld\n", 1251da177e4SLinus Torvalds def_strm.total_in, def_strm.total_out)); 1261da177e4SLinus Torvalds 1271da177e4SLinus Torvalds *dstlen = def_strm.total_out; 1281da177e4SLinus Torvalds *sourcelen = def_strm.total_in; 1291da177e4SLinus Torvalds ret = 0; 1301da177e4SLinus Torvalds out: 131353ab6e9SIngo Molnar mutex_unlock(&deflate_mutex); 1321da177e4SLinus Torvalds return ret; 1331da177e4SLinus Torvalds } 1341da177e4SLinus Torvalds 13575c96f85SAdrian Bunk static int jffs2_zlib_decompress(unsigned char *data_in, 13675c96f85SAdrian Bunk unsigned char *cpage_out, 137088bd455SMike Frysinger uint32_t srclen, uint32_t destlen) 1381da177e4SLinus Torvalds { 1391da177e4SLinus Torvalds int ret; 1401da177e4SLinus Torvalds int wbits = MAX_WBITS; 1411da177e4SLinus Torvalds 142353ab6e9SIngo Molnar mutex_lock(&inflate_mutex); 1431da177e4SLinus Torvalds 1441da177e4SLinus Torvalds inf_strm.next_in = data_in; 1451da177e4SLinus Torvalds inf_strm.avail_in = srclen; 1461da177e4SLinus Torvalds inf_strm.total_in = 0; 1471da177e4SLinus Torvalds 1481da177e4SLinus Torvalds inf_strm.next_out = cpage_out; 1491da177e4SLinus Torvalds inf_strm.avail_out = destlen; 1501da177e4SLinus Torvalds inf_strm.total_out = 0; 1511da177e4SLinus Torvalds 1521da177e4SLinus Torvalds /* If it's deflate, and it's got no preset dictionary, then 1531da177e4SLinus Torvalds we can tell zlib to skip the adler32 check. */ 1541da177e4SLinus Torvalds if (srclen > 2 && !(data_in[1] & PRESET_DICT) && 1551da177e4SLinus Torvalds ((data_in[0] & 0x0f) == Z_DEFLATED) && 1561da177e4SLinus Torvalds !(((data_in[0]<<8) + data_in[1]) % 31)) { 1571da177e4SLinus Torvalds 1581da177e4SLinus Torvalds D2(printk(KERN_DEBUG "inflate skipping adler32\n")); 1591da177e4SLinus Torvalds wbits = -((data_in[0] >> 4) + 8); 1601da177e4SLinus Torvalds inf_strm.next_in += 2; 1611da177e4SLinus Torvalds inf_strm.avail_in -= 2; 1621da177e4SLinus Torvalds } else { 1631da177e4SLinus Torvalds /* Let this remain D1 for now -- it should never happen */ 1641da177e4SLinus Torvalds D1(printk(KERN_DEBUG "inflate not skipping adler32\n")); 1651da177e4SLinus Torvalds } 1661da177e4SLinus Torvalds 1671da177e4SLinus Torvalds 1681da177e4SLinus Torvalds if (Z_OK != zlib_inflateInit2(&inf_strm, wbits)) { 1691da177e4SLinus Torvalds printk(KERN_WARNING "inflateInit failed\n"); 170353ab6e9SIngo Molnar mutex_unlock(&inflate_mutex); 1711da177e4SLinus Torvalds return 1; 1721da177e4SLinus Torvalds } 1731da177e4SLinus Torvalds 1741da177e4SLinus Torvalds while((ret = zlib_inflate(&inf_strm, Z_FINISH)) == Z_OK) 1751da177e4SLinus Torvalds ; 1761da177e4SLinus Torvalds if (ret != Z_STREAM_END) { 1771da177e4SLinus Torvalds printk(KERN_NOTICE "inflate returned %d\n", ret); 1781da177e4SLinus Torvalds } 1791da177e4SLinus Torvalds zlib_inflateEnd(&inf_strm); 180353ab6e9SIngo Molnar mutex_unlock(&inflate_mutex); 1811da177e4SLinus Torvalds return 0; 1821da177e4SLinus Torvalds } 1831da177e4SLinus Torvalds 1841da177e4SLinus Torvalds static struct jffs2_compressor jffs2_zlib_comp = { 1851da177e4SLinus Torvalds .priority = JFFS2_ZLIB_PRIORITY, 1861da177e4SLinus Torvalds .name = "zlib", 1871da177e4SLinus Torvalds .compr = JFFS2_COMPR_ZLIB, 1881da177e4SLinus Torvalds .compress = &jffs2_zlib_compress, 1891da177e4SLinus Torvalds .decompress = &jffs2_zlib_decompress, 1901da177e4SLinus Torvalds #ifdef JFFS2_ZLIB_DISABLED 1911da177e4SLinus Torvalds .disabled = 1, 1921da177e4SLinus Torvalds #else 1931da177e4SLinus Torvalds .disabled = 0, 1941da177e4SLinus Torvalds #endif 1951da177e4SLinus Torvalds }; 1961da177e4SLinus Torvalds 1971da177e4SLinus Torvalds int __init jffs2_zlib_init(void) 1981da177e4SLinus Torvalds { 1991da177e4SLinus Torvalds int ret; 2001da177e4SLinus Torvalds 2011da177e4SLinus Torvalds ret = alloc_workspaces(); 2021da177e4SLinus Torvalds if (ret) 2031da177e4SLinus Torvalds return ret; 2041da177e4SLinus Torvalds 2051da177e4SLinus Torvalds ret = jffs2_register_compressor(&jffs2_zlib_comp); 2061da177e4SLinus Torvalds if (ret) 2071da177e4SLinus Torvalds free_workspaces(); 2081da177e4SLinus Torvalds 2091da177e4SLinus Torvalds return ret; 2101da177e4SLinus Torvalds } 2111da177e4SLinus Torvalds 2121da177e4SLinus Torvalds void jffs2_zlib_exit(void) 2131da177e4SLinus Torvalds { 2141da177e4SLinus Torvalds jffs2_unregister_compressor(&jffs2_zlib_comp); 2151da177e4SLinus Torvalds free_workspaces(); 2161da177e4SLinus Torvalds } 217