This adds the ZUF filesystem-in-user_mode module
to the fs/ build system.
Also added:
* fs/zuf/Kconfig
* fs/zuf/module.c - This file contains the LICENCE of zuf code base
* fs/zuf/Makefile - Rather empty Makefile with only module.c above
I add the fs/zuf/Makefile to demonstrate that at every
patchset stage code still compiles and there are no external
references outside of the code already submitted.
Off course only at the very last patch we have a working
ZUF feeder
Signed-off-by: Boaz Harrosh <boazh@xxxxxxxxxx>
---
fs/Kconfig | 1 +
fs/Makefile | 1 +
fs/zuf/Kconfig | 23 +++++++++++++++++++
fs/zuf/Makefile | 14 ++++++++++++
fs/zuf/module.c | 51 +++++++++++++++++++++++++++++++++++++++++
fs/zuf/zus_api.h | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
6 files changed, 159 insertions(+)
create mode 100644 fs/zuf/Kconfig
create mode 100644 fs/zuf/Makefile
create mode 100644 fs/zuf/module.c
create mode 100644 fs/zuf/zus_api.h
diff --git a/fs/Kconfig b/fs/Kconfig
index 7aee6d6..c04c454 100644
--- a/fs/Kconfig
+++ b/fs/Kconfig
@@ -247,6 +247,7 @@ source "fs/romfs/Kconfig"
source "fs/pstore/Kconfig"
source "fs/sysv/Kconfig"
source "fs/ufs/Kconfig"
+source "fs/zuf/Kconfig"
source "fs/exofs/Kconfig"
endif # MISC_FILESYSTEMS
diff --git a/fs/Makefile b/fs/Makefile
index ef772f1..78c13f0 100644
--- a/fs/Makefile
+++ b/fs/Makefile
@@ -129,3 +129,4 @@ obj-y += exofs/ # Multiple modules
obj-$(CONFIG_CEPH_FS) += ceph/
obj-$(CONFIG_PSTORE) += pstore/
obj-$(CONFIG_EFIVAR_FS) += efivarfs/
+obj-$(CONFIG_ZUF) += zuf/
diff --git a/fs/zuf/Kconfig b/fs/zuf/Kconfig
new file mode 100644
index 0000000..a17d463
--- /dev/null
+++ b/fs/zuf/Kconfig
@@ -0,0 +1,23 @@
+menuconfig ZUF
+ tristate "ZUF - Zero-copy User-mode Feeder"
+ depends on BLOCK
+ depends on ZONE_DEVICE
+ select CRC16
+ select MEMCG
+ help
+ ZUFS Kernel part.
+ To enable say Y here.
+
+ To compile this as a module, choose M here: the module will be
+ called zuf.ko
+
+if ZUF
+
+config ZUF_DEBUG
+ bool "ZUF: enable debug subsystems use"
+ depends on ZUF
+ default n
+ help
+ INTERNAL QA USE ONLY!!! DO NOT USE!!!
+
+endif
diff --git a/fs/zuf/Makefile b/fs/zuf/Makefile
new file mode 100644
index 0000000..7e4e51f
--- /dev/null
+++ b/fs/zuf/Makefile
@@ -0,0 +1,14 @@
+#
+# ZUF: Zero-copy User-mode Feeder
+#
+# Copyright (c) 2018 NetApp Inc. All rights reserved.
+#
+# ZUFS-License: GPL-2.0 OR BSD-3-Clause. See module.c for LICENSE details.
+#
+# Makefile for the Linux zufs Kernel Feeder.
+#
+
+obj-$(CONFIG_ZUF) += zuf.o
+
+# Main FS
+zuf-y += module.o
diff --git a/fs/zuf/module.c b/fs/zuf/module.c
new file mode 100644
index 0000000..ebf51d7
--- /dev/null
+++ b/fs/zuf/module.c
@@ -0,0 +1,51 @@
+/* ZUFS-License-Identifier: (GPL-2.0 OR BSD-3-Clause) */
+/*
+ * zuf - Zero-copy User-mode Feeder
+ *
+ * Copyright (c) 2018 NetApp Inc. All rights reserved.
+ *
+ * This program is free software; you may redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 2 of the License.
+ *
+ * Alternatively you can redistribute this file under the terms of the
+ * BSD license as stated below:
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include <linux/module.h>
+
+#include "zus_api.h"
+
+MODULE_AUTHOR("Boaz Harrosh <boazh@xxxxxxxxxx>");
+MODULE_AUTHOR("Sagi Manole <sagim@xxxxxxxxxx>");
+MODULE_DESCRIPTION("Zero-copy User-mode Feeder");
+MODULE_LICENSE("GPL");
+MODULE_VERSION(__stringify(ZUFS_MAJOR_VERSION) "."
+ __stringify(ZUFS_MINOR_VERSION));
diff --git a/fs/zuf/zus_api.h b/fs/zuf/zus_api.h
new file mode 100644
index 0000000..d6ccc85
--- /dev/null
+++ b/fs/zuf/zus_api.h
@@ -0,0 +1,69 @@
+/*
+ * zufs_api.h:
+ * ZUFS (Zero-copy User-mode File System) is:
+ * zuf (Zero-copy User-mode Feeder (Kernel)) +
+ * zus (Zero-copy User-mode Server (daemon))
+ *
+ * Copyright (c) 2018 NetApp Inc. All rights reserved.
+ *
+ * ZUFS-License: GPL-2.0 OR BSD-3-Clause. See module.c for LICENSE details.
+ *
+ * Authors:
+ * Boaz Harrosh <boazh@xxxxxxxxxx>
+ * Sagi Manole <sagim@xxxxxxxxxx>"
+ */
+#ifndef _LINUX_ZUFS_API_H
+#define _LINUX_ZUFS_API_H
+
+#include <linux/types.h>
+#include <linux/uuid.h>
+#include <stddef.h>
+#include <asm/statfs.h>
+
+/*
+ * Version rules:
+ * This is the zus-to-zuf API version. And not the Filesystem
+ * on disk structures versions. These are left to the FS-plugging
+ * to supply and check.
+ * Specifically any of the API structures and constants found in this
+ * file.
+ * If the changes are made in a way backward compatible with old
+ * user-space, MINOR is incremented. Else MAJOR is incremented.
+ *
+ * We believe that the zus Server application comes with the
+ * Distro and should be dependent on the Kernel package.
+ * The more stable ABI is between the zus Server and its FS plugins.
+ * Because of the intimate relationships in the zuf-core behavior
+ * We would also like zus Server to be signed by the running Kernel's
+ * make crypto key and checked before load because of the Security
+ * nature of an FS provider.
+ */
+#define ZUFS_MINORS_PER_MAJOR 1024
+#define ZUFS_MAJOR_VERSION 1
+#define ZUFS_MINOR_VERSION 0
+
+/* User space compatibility definitions */
+#ifndef __KERNEL__
+
+#include <stdint.h>
+#include <stdbool.h>
+
+#define u8 uint8_t
+#define umode_t uint16_t
+
+#define le16_to_cpu le16toh
+#define le64_to_cpu le64toh
+
+#define PAGE_SHIFT 12
+#define PAGE_SIZE (1 << PAGE_SHIFT)
+
+#ifndef __packed
+# define __packed __attribute__((packed))
+#endif
+
+#define ALIGN(x, a) ALIGN_MASK(x, (typeof(x))(a) - 1)
+#define ALIGN_MASK(x, mask) (((x) + (mask)) & ~(mask))
+
+#endif /* ndef __KERNEL__ */
+
+#endif /* _LINUX_ZUFS_API_H */
--
2.5.5
