]> git.ipfire.org Git - thirdparty/zstd.git/commitdiff
[linux] Add xxhash and zstd in-kernel tests 728/head
authorNick Terrell <terrelln@fb.com>
Tue, 20 Jun 2017 02:09:41 +0000 (19:09 -0700)
committerNick Terrell <terrelln@fb.com>
Tue, 20 Jun 2017 02:09:41 +0000 (19:09 -0700)
contrib/linux-kernel/xxhash_test.c [new file with mode: 0644]
contrib/linux-kernel/zstd_compress_test.c [new file with mode: 0644]
contrib/linux-kernel/zstd_decompress_test.c [new file with mode: 0644]

diff --git a/contrib/linux-kernel/xxhash_test.c b/contrib/linux-kernel/xxhash_test.c
new file mode 100644 (file)
index 0000000..5c1101b
--- /dev/null
@@ -0,0 +1,191 @@
+/*
+ * Copyright (c) 2016-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License version 2 as published by the
+ * Free Software Foundation. This program is dual-licensed; you may select
+ * either version 2 of the GNU General Public License ("GPL") or BSD license
+ * ("BSD").
+ */
+
+/* DO_XXH should be 32 or 64 for xxh32 and xxh64 respectively */
+#define DO_XXH 0 
+/* DO_CRC should be 0 or 1 */
+#define DO_CRC 0
+/* Buffer size */
+#define BUFFER_SIZE 4096
+
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/fs.h>
+#include <linux/uaccess.h>
+
+#if DO_XXH
+#include <linux/xxhash.h>
+#endif
+
+#if DO_CRC
+#include <linux/crc32.h>
+#endif
+
+/* Device name to pass to register_chrdev(). */
+#define DEVICE_NAME "xxhash_test"
+
+/* Dynamically allocated device major number */
+static int device_major;
+
+/*
+ * We reuse the same hash state, and thus can hash only one
+ * file at a time.
+ */
+static bool device_is_open;
+
+static uint64_t total_length;
+
+
+#if (DO_XXH == 32)
+
+#define xxh_state xxh32_state
+#define xxh_reset xxh32_reset
+#define xxh_update xxh32_update
+#define xxh_digest xxh32_digest
+#define XXH_FORMAT "XXH32 = 0x%x"
+
+#elif (DO_XXH == 64)
+
+#define xxh_state xxh64_state
+#define xxh_reset xxh64_reset
+#define xxh_update xxh64_update
+#define xxh_digest xxh64_digest
+#define XXH_FORMAT "XXH64 = 0x%llx"
+
+#elif DO_XXH
+
+#error "Invalid value of DO_XXH"
+
+#endif
+
+#if DO_XXH
+
+/* XXH state */
+static struct xxh_state state;
+
+#endif /* DO_XXH */
+
+#if DO_CRC
+
+static uint32_t crc;
+
+#endif /* DO_CRC */
+
+/*
+ * Input buffer used to put data coming from userspace.
+ */
+static uint8_t buffer_in[BUFFER_SIZE];
+
+static int xxhash_test_open(struct inode *i, struct file *f)
+{
+       if (device_is_open)
+               return -EBUSY;
+
+       device_is_open = true;
+
+       total_length = 0;
+#if DO_XXH
+       xxh_reset(&state, 0);
+#endif
+#if DO_CRC
+       crc = 0xFFFFFFFF;
+#endif
+
+       printk(KERN_INFO DEVICE_NAME ": opened\n");
+       return 0;
+}
+
+static int xxhash_test_release(struct inode *i, struct file *f)
+{
+       device_is_open = false;
+
+       printk(KERN_INFO DEVICE_NAME ": total_len = %llu\n", total_length);
+#if DO_XXH
+       printk(KERN_INFO DEVICE_NAME ": " XXH_FORMAT "\n", xxh_digest(&state));
+#endif
+#if DO_CRC
+       printk(KERN_INFO DEVICE_NAME ": CRC32 = 0x%08x\n", ~crc);
+#endif
+       printk(KERN_INFO DEVICE_NAME ": closed\n");
+       return 0;
+}
+
+/*
+ * Hash the data given to us from userspace.
+ */
+static ssize_t xxhash_test_write(struct file *file, const char __user *buf,
+                                size_t size, loff_t *pos)
+{
+       size_t remaining = size;
+
+       while (remaining > 0) {
+#if DO_XXH
+               int ret;
+#endif
+               size_t const copy_size = min(remaining, sizeof(buffer_in));
+
+               if (copy_from_user(buffer_in, buf, copy_size))
+                       return -EFAULT;
+               buf += copy_size;
+               remaining -= copy_size;
+               total_length += copy_size;
+#if DO_XXH
+               if ((ret = xxh_update(&state, buffer_in, copy_size))) {
+                       printk(KERN_INFO DEVICE_NAME ": xxh failure.");
+                       return ret;
+               }
+#endif
+#if DO_CRC
+               crc = crc32(crc, buffer_in, copy_size);
+#endif
+       }
+       return size;
+}
+/* register the character device. */
+static int __init xxhash_test_init(void)
+{
+       static const struct file_operations fileops = {
+               .owner = THIS_MODULE,
+               .open = &xxhash_test_open,
+               .release = &xxhash_test_release,
+               .write = &xxhash_test_write
+       };
+
+       device_major = register_chrdev(0, DEVICE_NAME, &fileops);
+       if (device_major < 0) {
+               return device_major;
+       }
+
+       printk(KERN_INFO DEVICE_NAME ": module loaded\n");
+       printk(KERN_INFO DEVICE_NAME ": Create a device node with "
+                       "'mknod " DEVICE_NAME " c %d 0' and write data "
+                       "to it.\n", device_major);
+       return 0;
+}
+
+static void __exit xxhash_test_exit(void)
+{
+       unregister_chrdev(device_major, DEVICE_NAME);
+       printk(KERN_INFO DEVICE_NAME ": module unloaded\n");
+}
+
+module_init(xxhash_test_init);
+module_exit(xxhash_test_exit);
+
+MODULE_DESCRIPTION("XXHash tester");
+MODULE_VERSION("1.0");
+
+
+MODULE_LICENSE("Dual BSD/GPL");
diff --git a/contrib/linux-kernel/zstd_compress_test.c b/contrib/linux-kernel/zstd_compress_test.c
new file mode 100644 (file)
index 0000000..bf856b7
--- /dev/null
@@ -0,0 +1,285 @@
+/*
+ * Copyright (c) 2016-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License version 2 as published by the
+ * Free Software Foundation. This program is dual-licensed; you may select
+ * either version 2 of the GNU General Public License ("GPL") or BSD license
+ * ("BSD").
+ */
+
+/* Compression level or 0 to disable */
+#define DO_ZLIB 9
+/* Compression level or 0 to disable */
+#define DO_ZSTD 0
+/* Buffer size */
+#define BUFFER_SIZE 4096
+
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/vmalloc.h>
+#include <linux/fs.h>
+#include <linux/uaccess.h>
+
+#if DO_ZSTD
+#include <linux/zstd.h>
+#endif
+
+#if DO_ZLIB
+#include <linux/zlib.h>
+#endif
+
+/* Device name to pass to register_chrdev(). */
+#define DEVICE_NAME "zstd_compress_test"
+
+/* Dynamically allocated device major number */
+static int device_major;
+
+/*
+ * We reuse the same state, and thus can compress only one file at a time.
+ */
+static bool device_is_open;
+
+
+static void *workspace = NULL;
+
+/*
+ * Input buffer used to put data coming from userspace.
+ */
+static uint8_t buffer_in[BUFFER_SIZE];
+static uint8_t buffer_out[BUFFER_SIZE];
+
+static uint64_t uncompressed_len;
+static uint64_t compressed_len;
+
+#if DO_ZSTD
+
+static ZSTD_CStream *state;
+
+static ZSTD_inBuffer input = {
+       .src = buffer_in,
+       .size = sizeof(buffer_in),
+       .pos = sizeof(buffer_in),
+};
+
+static ZSTD_outBuffer output = {
+       .dst = buffer_out,
+       .size = sizeof(buffer_out),
+       .pos = sizeof(buffer_out),
+};
+
+#endif /* DO_ZSTD */
+
+#if DO_ZLIB
+
+static z_stream state = {
+       .next_in = buffer_in,
+       .avail_in = 0,
+       .total_in = 0,
+
+       .next_out = buffer_out,
+       .avail_out = sizeof(buffer_out),
+       .total_out = 0,
+
+       .msg = NULL,
+       .state = NULL,
+       .workspace = NULL,
+};
+
+#endif /* DO_ZLIB */
+
+static int zstd_compress_test_open(struct inode *i, struct file *f)
+{
+       if (device_is_open)
+               return -EBUSY;
+
+       device_is_open = true;
+
+       uncompressed_len = compressed_len = 0;
+
+#if DO_ZSTD
+       if (ZSTD_isError(ZSTD_resetCStream(state, 0)))
+               return -EIO;
+#endif
+
+#if DO_ZLIB
+       if (zlib_deflateReset(&state) != Z_OK)
+               return -EIO;
+#endif
+
+       printk(KERN_INFO DEVICE_NAME ": opened\n");
+       return 0;
+}
+
+static int zstd_compress_test_release(struct inode *i, struct file *f)
+{
+       device_is_open = false;
+
+#if DO_ZSTD
+       do {
+               size_t ret;
+
+               output.pos = 0;
+               ret = ZSTD_endStream(state, &output);
+               if (ZSTD_isError(ret)) {
+                       printk(KERN_INFO DEVICE_NAME ": zstd end error %u\n", ZSTD_getErrorCode(ret));
+                       return -EIO;
+               }
+               compressed_len += output.pos;
+       } while (output.pos != output.size);
+#endif
+
+#if DO_ZLIB
+       for (;;) {
+               int ret;
+
+               state.next_out = buffer_out;
+               state.avail_out = sizeof(buffer_out);
+               ret = zlib_deflate(&state, Z_FINISH);
+               compressed_len += sizeof(buffer_out) - state.avail_out;
+               if (ret == Z_STREAM_END)
+                       break;
+               if (ret != Z_OK) {
+                       printk(KERN_INFO DEVICE_NAME ": zlib end error %d: %s\n", ret, state.msg);
+                       return -EIO;
+               }
+       }
+#endif
+
+       printk(KERN_INFO DEVICE_NAME ": uncompressed_len = %llu\n", uncompressed_len);
+       printk(KERN_INFO DEVICE_NAME ": compressed_len   = %llu\n", compressed_len);
+       printk(KERN_INFO DEVICE_NAME ": closed\n");
+       return 0;
+}
+
+/*
+ * Hash the data given to us from userspace.
+ */
+static ssize_t zstd_compress_test_write(struct file *file,
+                                const char __user *buf, size_t size, loff_t *pos)
+{
+       size_t remaining = size;
+
+       while (remaining > 0) {
+               size_t const copy_size = min(remaining, sizeof(buffer_in));
+
+               if (copy_from_user(buffer_in, buf, copy_size))
+                       return -EFAULT;
+               buf += copy_size;
+               remaining -= copy_size;
+               uncompressed_len += copy_size;
+
+#if DO_ZSTD
+               input.pos = 0;
+               input.size = copy_size;
+               while (input.pos != input.size) {
+                       size_t ret;
+
+                       output.pos = 0;
+                       ret = ZSTD_compressStream(state, &output, &input);
+                       if (ZSTD_isError(ret)) {
+                               printk(KERN_INFO DEVICE_NAME ": zstd compress error %u\n", ZSTD_getErrorCode(ret));
+                               return -EIO;
+                       }
+                       compressed_len += output.pos;
+               }
+#endif
+#if DO_ZLIB
+               state.next_in = buffer_in;
+               state.avail_in = copy_size;
+               while (state.avail_in > 0) {
+                       int ret;
+
+                       state.next_out = buffer_out;
+                       state.avail_out = sizeof(buffer_out);
+                       ret = zlib_deflate(&state, Z_NO_FLUSH);
+                       compressed_len += sizeof(buffer_out) - state.avail_out;
+                       if (ret != Z_OK) {
+                               printk(KERN_INFO DEVICE_NAME ": zlib end error %d: %s\n", ret, state.msg);
+                               return -EIO;
+                       }
+               }
+#endif
+       }
+       return size;
+}
+/* register the character device. */
+static int __init zstd_compress_test_init(void)
+{
+       static const struct file_operations fileops = {
+               .owner = THIS_MODULE,
+               .open = &zstd_compress_test_open,
+               .release = &zstd_compress_test_release,
+               .write = &zstd_compress_test_write
+       };
+       size_t workspace_size = 0;
+#if DO_ZSTD
+       ZSTD_parameters params;
+#endif
+
+       device_major = register_chrdev(0, DEVICE_NAME, &fileops);
+       if (device_major < 0) {
+               return device_major;
+       }
+
+#if DO_ZSTD
+       params = ZSTD_getParams(DO_ZSTD, 0, 0);
+       workspace_size = ZSTD_CStreamWorkspaceBound(params.cParams);
+
+       if (!(workspace = vmalloc(workspace_size)))
+               goto fail;
+       if (!(state = ZSTD_initCStream(params, 0, workspace, workspace_size)))
+               goto fail;
+#endif
+
+#if DO_ZLIB
+       workspace_size = zlib_deflate_workspacesize(MAX_WBITS, MAX_MEM_LEVEL);
+
+       if (!(workspace = vmalloc(workspace_size)))
+               goto fail;
+       state.workspace = workspace;
+       if (zlib_deflateInit(&state, DO_ZLIB) != Z_OK)
+               goto fail;
+#endif
+
+       printk(KERN_INFO DEVICE_NAME ": module loaded\n");
+       printk(KERN_INFO DEVICE_NAME ": compression requires %zu bytes of memory\n", workspace_size);
+       printk(KERN_INFO DEVICE_NAME ": Create a device node with "
+                       "'mknod " DEVICE_NAME " c %d 0' and write data "
+                       "to it.\n", device_major);
+       return 0;
+
+fail:
+       printk(KERN_INFO DEVICE_NAME ": failed to load module\n");
+       if (workspace) {
+               vfree(workspace);
+               workspace = NULL;
+       }
+       return -ENOMEM;
+}
+
+static void __exit zstd_compress_test_exit(void)
+{
+       unregister_chrdev(device_major, DEVICE_NAME);
+#if DO_ZLIB
+       zlib_deflateEnd(&state);
+#endif
+       if (workspace) {
+               vfree(workspace);
+               workspace = NULL;
+       }
+       printk(KERN_INFO DEVICE_NAME ": module unloaded\n");
+}
+
+module_init(zstd_compress_test_init);
+module_exit(zstd_compress_test_exit);
+
+MODULE_DESCRIPTION("Zstd compression tester");
+MODULE_VERSION("1.0");
+
+MODULE_LICENSE("Dual BSD/GPL");
diff --git a/contrib/linux-kernel/zstd_decompress_test.c b/contrib/linux-kernel/zstd_decompress_test.c
new file mode 100644 (file)
index 0000000..4905a5a
--- /dev/null
@@ -0,0 +1,256 @@
+/*
+ * Copyright (c) 2016-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License version 2 as published by the
+ * Free Software Foundation. This program is dual-licensed; you may select
+ * either version 2 of the GNU General Public License ("GPL") or BSD license
+ * ("BSD").
+ */
+
+/* Compression level or 0 to disable */
+#define DO_ZLIB 1
+/* Compression level or 0 to disable */
+#define DO_ZSTD 0
+/* Buffer size */
+#define BUFFER_SIZE 4096
+
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/vmalloc.h>
+#include <linux/fs.h>
+#include <linux/uaccess.h>
+
+#if DO_ZSTD
+#include <linux/zstd.h>
+#endif
+
+#if DO_ZLIB
+#include <linux/zlib.h>
+#endif
+
+/* Device name to pass to register_chrdev(). */
+#define DEVICE_NAME "zstd_decompress_test"
+
+/* Dynamically allocated device major number */
+static int device_major;
+
+/*
+ * We reuse the same state, and thus can compress only one file at a time.
+ */
+static bool device_is_open;
+
+
+static void *workspace = NULL;
+
+/*
+ * Input buffer used to put data coming from userspace.
+ */
+static uint8_t buffer_in[BUFFER_SIZE];
+static uint8_t buffer_out[BUFFER_SIZE];
+
+static uint64_t uncompressed_len;
+static uint64_t compressed_len;
+
+#if DO_ZSTD
+
+static ZSTD_DStream *state;
+
+static ZSTD_inBuffer input = {
+       .src = buffer_in,
+       .size = sizeof(buffer_in),
+       .pos = sizeof(buffer_in),
+};
+
+static ZSTD_outBuffer output = {
+       .dst = buffer_out,
+       .size = sizeof(buffer_out),
+       .pos = sizeof(buffer_out),
+};
+
+#endif /* DO_ZSTD */
+
+#if DO_ZLIB
+
+static z_stream state = {
+       .next_in = buffer_in,
+       .avail_in = 0,
+       .total_in = 0,
+
+       .next_out = buffer_out,
+       .avail_out = sizeof(buffer_out),
+       .total_out = 0,
+
+       .msg = NULL,
+       .state = NULL,
+       .workspace = NULL,
+};
+
+#endif /* DO_ZLIB */
+
+static int zstd_decompress_test_open(struct inode *i, struct file *f)
+{
+       if (device_is_open)
+               return -EBUSY;
+
+       device_is_open = true;
+
+       uncompressed_len = compressed_len = 0;
+
+#if DO_ZSTD
+       if (ZSTD_isError(ZSTD_resetDStream(state)))
+               return -EIO;
+#endif
+
+#if DO_ZLIB
+       if (zlib_inflateReset(&state) != Z_OK)
+               return -EIO;
+#endif
+
+       printk(KERN_INFO DEVICE_NAME ": opened\n");
+       return 0;
+}
+
+static int zstd_decompress_test_release(struct inode *i, struct file *f)
+{
+       device_is_open = false;
+
+       printk(KERN_INFO DEVICE_NAME ": uncompressed_len = %llu\n", uncompressed_len);
+       printk(KERN_INFO DEVICE_NAME ": compressed_len   = %llu\n", compressed_len);
+       printk(KERN_INFO DEVICE_NAME ": closed\n");
+       return 0;
+}
+
+/*
+ * Hash the data given to us from userspace.
+ */
+static ssize_t zstd_decompress_test_write(struct file *file,
+                                const char __user *buf, size_t size, loff_t *pos)
+{
+       size_t remaining = size;
+
+       while (remaining > 0) {
+               size_t const copy_size = min(remaining, sizeof(buffer_in));
+
+               if (copy_from_user(buffer_in, buf, copy_size))
+                       return -EFAULT;
+               buf += copy_size;
+               remaining -= copy_size;
+               compressed_len += copy_size;
+
+#if DO_ZSTD
+               input.pos = 0;
+               input.size = copy_size;
+               while (input.pos != input.size) {
+                       size_t ret;
+
+                       output.pos = 0;
+                       ret = ZSTD_decompressStream(state, &output, &input);
+                       if (ZSTD_isError(ret)) {
+                               printk(KERN_INFO DEVICE_NAME ": zstd decompress error %u\n", ZSTD_getErrorCode(ret));
+                               return -EIO;
+                       }
+                       uncompressed_len += output.pos;
+               }
+#endif
+#if DO_ZLIB
+               state.next_in = buffer_in;
+               state.avail_in = copy_size;
+               while (state.avail_in > 0) {
+                       int ret;
+
+                       state.next_out = buffer_out;
+                       state.avail_out = sizeof(buffer_out);
+                       ret = zlib_inflate(&state, Z_NO_FLUSH);
+                       uncompressed_len += sizeof(buffer_out) - state.avail_out;
+                       if (ret != Z_OK && ret != Z_STREAM_END) {
+                               printk(KERN_INFO DEVICE_NAME ": zlib decompress error %d: %s\n", ret, state.msg);
+                               return -EIO;
+                       }
+               }
+#endif
+       }
+       return size;
+}
+/* register the character device. */
+static int __init zstd_decompress_test_init(void)
+{
+       static const struct file_operations fileops = {
+               .owner = THIS_MODULE,
+               .open = &zstd_decompress_test_open,
+               .release = &zstd_decompress_test_release,
+               .write = &zstd_decompress_test_write
+       };
+       size_t workspace_size = 0;
+#if DO_ZSTD
+       ZSTD_parameters params;
+       size_t max_window_size;
+#endif
+
+       device_major = register_chrdev(0, DEVICE_NAME, &fileops);
+       if (device_major < 0) {
+               return device_major;
+       }
+
+#if DO_ZSTD
+       params = ZSTD_getParams(DO_ZSTD, 0, 0);
+       max_window_size = (size_t)1 << params.cParams.windowLog;
+       workspace_size = ZSTD_DStreamWorkspaceBound(max_window_size);
+
+       if (!(workspace = vmalloc(workspace_size)))
+               goto fail;
+       if (!(state = ZSTD_initDStream(max_window_size, workspace, workspace_size)))
+               goto fail;
+#endif
+
+#if DO_ZLIB
+       workspace_size = zlib_inflate_workspacesize();
+
+       if (!(workspace = vmalloc(workspace_size)))
+               goto fail;
+       state.workspace = workspace;
+       if (zlib_inflateInit(&state) != Z_OK)
+               goto fail;
+#endif
+
+       printk(KERN_INFO DEVICE_NAME ": module loaded\n");
+       printk(KERN_INFO DEVICE_NAME ": decompression requires %zu bytes of memory\n", workspace_size);
+       printk(KERN_INFO DEVICE_NAME ": Create a device node with "
+                       "'mknod " DEVICE_NAME " c %d 0' and write data "
+                       "to it.\n", device_major);
+       return 0;
+
+fail:
+       printk(KERN_INFO DEVICE_NAME ": failed to load module\n");
+       if (workspace) {
+               vfree(workspace);
+               workspace = NULL;
+       }
+       return -ENOMEM;
+}
+
+static void __exit zstd_decompress_test_exit(void)
+{
+       unregister_chrdev(device_major, DEVICE_NAME);
+#if DO_ZLIB
+       zlib_deflateEnd(&state);
+#endif
+       if (workspace) {
+               vfree(workspace);
+               workspace = NULL;
+       }
+       printk(KERN_INFO DEVICE_NAME ": module unloaded\n");
+}
+
+module_init(zstd_decompress_test_init);
+module_exit(zstd_decompress_test_exit);
+
+MODULE_DESCRIPTION("Zstd decompression tester");
+MODULE_VERSION("1.0");
+
+MODULE_LICENSE("Dual BSD/GPL");