Orangefs: kernel client part 1
OrangeFS (formerly PVFS) is an lgpl licensed userspace networked parallel
file system. OrangeFS can be accessed through included system utilities,
user integration libraries, MPI-IO and can be used by the Hadoop
ecosystem as an alternative to the HDFS filesystem. OrangeFS is used
widely for parallel science, data analytics and engineering applications.
While applications often don't require Orangefs to be mounted into
the VFS, users do like to be able to access their files in the normal way.
The Orangefs kernel client allows Orangefs filesystems to be mounted as
a VFS. The kernel client communicates with a userspace daemon which in
turn communicates with the Orangefs server daemons that implement the
filesystem. The server daemons (there's almost always more than one)
need not be running on the same host as the kernel client.
Orangefs filesystems can also be mounted with FUSE, and we
ship code and instructions to facilitate that, but most of our users
report preferring to use our kernel module instead. Further, as an example
of a problem we can't solve with fuse, we have in the works a
not-yet-ready-for-prime-time version of a file_operations lock function
that accounts for the server daemons being distributed across more
than one running kernel.
Many people and organizations, including Clemson University,
Argonne National Laboratories and Acxiom Corporation have
helped to create what has become Orangefs over more than twenty
years. Some of the more recent contributors to the kernel client
include:
Mike Marshall
Christoph Hellwig
Randy Martin
Becky Ligon
Walt Ligon
Michael Moore
Rob Ross
Phil Carnes
Signed-off-by: Mike Marshall <hubcap@omnibond.com>
diff --git a/fs/orangefs/pvfs2-dev-proto.h b/fs/orangefs/pvfs2-dev-proto.h
new file mode 100644
index 0000000..9c82e6e
--- /dev/null
+++ b/fs/orangefs/pvfs2-dev-proto.h
@@ -0,0 +1,102 @@
+/*
+ * (C) 2001 Clemson University and The University of Chicago
+ *
+ * See COPYING in top-level directory.
+ */
+
+#ifndef _PVFS2_DEV_PROTO_H
+#define _PVFS2_DEV_PROTO_H
+
+/*
+ * types and constants shared between user space and kernel space for
+ * device interaction using a common protocol
+ */
+
+/*
+ * valid pvfs2 kernel operation types
+ */
+#define PVFS2_VFS_OP_INVALID 0xFF000000
+#define PVFS2_VFS_OP_FILE_IO 0xFF000001
+#define PVFS2_VFS_OP_LOOKUP 0xFF000002
+#define PVFS2_VFS_OP_CREATE 0xFF000003
+#define PVFS2_VFS_OP_GETATTR 0xFF000004
+#define PVFS2_VFS_OP_REMOVE 0xFF000005
+#define PVFS2_VFS_OP_MKDIR 0xFF000006
+#define PVFS2_VFS_OP_READDIR 0xFF000007
+#define PVFS2_VFS_OP_SETATTR 0xFF000008
+#define PVFS2_VFS_OP_SYMLINK 0xFF000009
+#define PVFS2_VFS_OP_RENAME 0xFF00000A
+#define PVFS2_VFS_OP_STATFS 0xFF00000B
+#define PVFS2_VFS_OP_TRUNCATE 0xFF00000C
+#define PVFS2_VFS_OP_MMAP_RA_FLUSH 0xFF00000D
+#define PVFS2_VFS_OP_FS_MOUNT 0xFF00000E
+#define PVFS2_VFS_OP_FS_UMOUNT 0xFF00000F
+#define PVFS2_VFS_OP_GETXATTR 0xFF000010
+#define PVFS2_VFS_OP_SETXATTR 0xFF000011
+#define PVFS2_VFS_OP_LISTXATTR 0xFF000012
+#define PVFS2_VFS_OP_REMOVEXATTR 0xFF000013
+#define PVFS2_VFS_OP_PARAM 0xFF000014
+#define PVFS2_VFS_OP_PERF_COUNT 0xFF000015
+#define PVFS2_VFS_OP_CANCEL 0xFF00EE00
+#define PVFS2_VFS_OP_FSYNC 0xFF00EE01
+#define PVFS2_VFS_OP_FSKEY 0xFF00EE02
+#define PVFS2_VFS_OP_READDIRPLUS 0xFF00EE03
+#define PVFS2_VFS_OP_FILE_IOX 0xFF00EE04
+
+/*
+ * Misc constants. Please retain them as multiples of 8!
+ * Otherwise 32-64 bit interactions will be messed up :)
+ */
+#define PVFS2_NAME_LEN 0x00000100
+#define PVFS2_MAX_DEBUG_STRING_LEN 0x00000400
+#define PVFS2_MAX_DEBUG_ARRAY_LEN 0x00000800
+
+/*
+ * MAX_DIRENT_COUNT cannot be larger than PVFS_REQ_LIMIT_LISTATTR.
+ * The value of PVFS_REQ_LIMIT_LISTATTR has been changed from 113 to 60
+ * to accomodate an attribute object with mirrored handles.
+ * MAX_DIRENT_COUNT is replaced by MAX_DIRENT_COUNT_READDIR and
+ * MAX_DIRENT_COUNT_READDIRPLUS, since readdir doesn't trigger a listattr
+ * but readdirplus might.
+*/
+#define MAX_DIRENT_COUNT_READDIR 0x00000060
+#define MAX_DIRENT_COUNT_READDIRPLUS 0x0000003C
+
+#include "upcall.h"
+#include "downcall.h"
+
+/*
+ * These macros differ from proto macros in that they don't do any
+ * byte-swappings and are used to ensure that kernel-clientcore interactions
+ * don't cause any unaligned accesses etc on 64 bit machines
+ */
+#ifndef roundup4
+#define roundup4(x) (((x)+3) & ~3)
+#endif
+
+#ifndef roundup8
+#define roundup8(x) (((x)+7) & ~7)
+#endif
+
+/* strings; decoding just points into existing character data */
+#define enc_string(pptr, pbuf) do { \
+ __u32 len = strlen(*pbuf); \
+ *(__u32 *) *(pptr) = (len); \
+ memcpy(*(pptr)+4, *pbuf, len+1); \
+ *(pptr) += roundup8(4 + len + 1); \
+} while (0)
+
+#define dec_string(pptr, pbuf, plen) do { \
+ __u32 len = (*(__u32 *) *(pptr)); \
+ *pbuf = *(pptr) + 4; \
+ *(pptr) += roundup8(4 + len + 1); \
+ if (plen) \
+ *plen = len;\
+} while (0)
+
+struct read_write_x {
+ __s64 off;
+ __s64 len;
+};
+
+#endif