Merge pull request trapexit#720 from trapexit/readdir_plus

Readdir plus

LICENSE

@@ -1,7 +1,7 @@
 /*
   ISC License
 
-  Copyright (c) 2016, Antonio SJ Musumeci <trapexit@spawn.link>
+  Copyright (c) 2019, Antonio SJ Musumeci <trapexit@spawn.link>
 
   Permission to use, copy, modify, and/or distribute this software for any
   purpose with or without fee is hereby granted, provided that the above

libfuse/Makefile

@@ -23,6 +23,7 @@ INSTALLMAN1DIR = $(DESTDIR)$(MAN1DIR)
 SRC   = \
 	lib/buffer.c \
 	lib/cuse_lowlevel.c \
+	lib/fuse_dirents.c \
 	lib/fuse.c \
 	lib/fuse_kern_chan.c \
 	lib/fuse_loop.c \

libfuse/include/fuse.h

@@ -24,6 +24,7 @@
 #endif
 
 #include "fuse_common.h"
+#include "fuse_dirents.h"
 
 #include <fcntl.h>
 #include <time.h>
@@ -47,22 +48,6 @@ struct fuse;
 /** Structure containing a raw command */
 struct fuse_cmd;
 
-/** Function to add an entry in a readdir() operation
- *
- * @param buf the buffer passed to the readdir() operation
- * @param name the file name of the directory entry
- * @param stat file attributes, can be NULL
- * @param off offset of the next entry or zero
- * @return 1 if buffer is full, zero otherwise
- */
-typedef int (*fuse_fill_dir_t) (void *buf, const char *name,
-				const struct stat *stbuf, off_t off);
-
-/* Used by deprecated getdir() method */
-typedef struct fuse_dirhandle *fuse_dirh_t;
-typedef int (*fuse_dirfil_t) (fuse_dirh_t h, const char *name, int type,
-			      ino_t ino);
-
 /**
  * The file system operations:
  *
@@ -104,9 +89,6 @@ struct fuse_operations {
 	 */
 	int (*readlink) (const char *, char *, size_t);
 
-	/* Deprecated, use readdir() instead */
-	int (*getdir) (const char *, fuse_dirh_t, fuse_dirfil_t);
-
 	/** Create a file node
 	 *
 	 * This is called for creation of all non-directory, non-symlink
@@ -312,8 +294,12 @@ struct fuse_operations {
 	 *
 	 * Introduced in version 2.3
 	 */
-	int (*readdir) (const char *, void *, fuse_fill_dir_t, off_t,
-			struct fuse_file_info *);
+        int (*readdir)(struct fuse_file_info *,
+                       fuse_dirents_t *);
+
+        int (*readdir_plus)(struct fuse_file_info *,
+                            fuse_dirents_t *);
+
 
 	/** Release directory
 	 *
@@ -898,9 +884,9 @@ int fuse_fs_flush(struct fuse_fs *fs, const char *path,
 int fuse_fs_statfs(struct fuse_fs *fs, const char *path, struct statvfs *buf);
 int fuse_fs_opendir(struct fuse_fs *fs, const char *path,
 		    struct fuse_file_info *fi);
-int fuse_fs_readdir(struct fuse_fs *fs, const char *path, void *buf,
-		    fuse_fill_dir_t filler, off_t off,
-		    struct fuse_file_info *fi);
+int fuse_fs_readdir(struct fuse_fs        *fs,
+		    struct fuse_file_info *fi,
+                    fuse_dirents_t        *buf);
 int fuse_fs_fsyncdir(struct fuse_fs *fs, const char *path, int datasync,
 		     struct fuse_file_info *fi);
 int fuse_fs_releasedir(struct fuse_fs *fs, const char *path,

libfuse/include/fuse_attr.h

@@ -0,0 +1,24 @@
+#pragma once
+
+#include <stdint.h>
+
+typedef struct fuse_attr_s fuse_attr_t;
+struct fuse_attr_s
+{
+  uint64_t ino;
+  uint64_t size;
+  uint64_t blocks;
+  uint64_t atime;
+  uint64_t mtime;
+  uint64_t ctime;
+  uint32_t atimensec;
+  uint32_t mtimensec;
+  uint32_t ctimensec;
+  uint32_t mode;
+  uint32_t nlink;
+  uint32_t uid;
+  uint32_t gid;
+  uint32_t rdev;
+  uint32_t blksize;
+  uint32_t _padding;
+};

libfuse/include/fuse_common.h

@@ -109,24 +109,25 @@ fuse_file_info
  * FUSE_CAP_IOCTL_DIR: ioctl support on directories
  * FUSE_CAP_CACHE_SYMLINKS: cache READLINK responses
  */
-#define FUSE_CAP_ASYNC_READ      (1 << 0)
-#define FUSE_CAP_POSIX_LOCKS     (1 << 1)
-#define FUSE_CAP_ATOMIC_O_TRUNC  (1 << 3)
-#define FUSE_CAP_EXPORT_SUPPORT  (1 << 4)
-#define FUSE_CAP_BIG_WRITES      (1 << 5)
-#define FUSE_CAP_DONT_MASK       (1 << 6)
-#define FUSE_CAP_SPLICE_WRITE    (1 << 7)
-#define FUSE_CAP_SPLICE_MOVE     (1 << 8)
-#define FUSE_CAP_SPLICE_READ     (1 << 9)
-#define FUSE_CAP_FLOCK_LOCKS     (1 << 10)
-#define FUSE_CAP_IOCTL_DIR       (1 << 11)
-#define FUSE_CAP_ASYNC_DIO       (1 << 15)
-#define FUSE_CAP_WRITEBACK_CACHE (1 << 16)
-#define FUSE_CAP_PARALLEL_DIROPS (1 << 18)
-#define FUSE_CAP_POSIX_ACL       (1 << 19)
-#define FUSE_CAP_CACHE_SYMLINKS  (1 << 20)
-#define FUSE_CAP_MAX_PAGES       (1 << 21)
-
+#define FUSE_CAP_ASYNC_READ        (1 << 0)
+#define FUSE_CAP_POSIX_LOCKS       (1 << 1)
+#define FUSE_CAP_ATOMIC_O_TRUNC    (1 << 3)
+#define FUSE_CAP_EXPORT_SUPPORT    (1 << 4)
+#define FUSE_CAP_BIG_WRITES        (1 << 5)
+#define FUSE_CAP_DONT_MASK         (1 << 6)
+#define FUSE_CAP_SPLICE_WRITE      (1 << 7)
+#define FUSE_CAP_SPLICE_MOVE       (1 << 8)
+#define FUSE_CAP_SPLICE_READ       (1 << 9)
+#define FUSE_CAP_FLOCK_LOCKS       (1 << 10)
+#define FUSE_CAP_IOCTL_DIR         (1 << 11)
+#define FUSE_CAP_READDIR_PLUS      (1 << 13)
+#define FUSE_CAP_READDIR_PLUS_AUTO (1 << 14)
+#define FUSE_CAP_ASYNC_DIO         (1 << 15)
+#define FUSE_CAP_WRITEBACK_CACHE   (1 << 16)
+#define FUSE_CAP_PARALLEL_DIROPS   (1 << 18)
+#define FUSE_CAP_POSIX_ACL         (1 << 19)
+#define FUSE_CAP_CACHE_SYMLINKS    (1 << 20)
+#define FUSE_CAP_MAX_PAGES         (1 << 21)
 
 /**
  * Ioctl flags

libfuse/include/fuse_compat.h

@@ -12,7 +12,6 @@
 struct fuse_operations_compat25 {
 	int (*getattr) (const char *, struct stat *);
 	int (*readlink) (const char *, char *, size_t);
-	int (*getdir) (const char *, fuse_dirh_t, fuse_dirfil_t);
 	int (*mknod) (const char *, mode_t, dev_t);
 	int (*mkdir) (const char *, mode_t);
 	int (*unlink) (const char *);
@@ -38,7 +37,7 @@ struct fuse_operations_compat25 {
 	int (*listxattr) (const char *, char *, size_t);
 	int (*removexattr) (const char *, const char *);
 	int (*opendir) (const char *, struct fuse_file_info *);
-	int (*readdir) (const char *, void *, fuse_fill_dir_t, off_t,
+	int (*readdir) (const char *, void *, off_t,
 			struct fuse_file_info *);
 	int (*releasedir) (const char *, struct fuse_file_info *);
 	int (*fsyncdir) (const char *, int, struct fuse_file_info *);
@@ -71,7 +70,6 @@ void fuse_teardown_compat22(struct fuse *fuse, int fd, char *mountpoint);
 struct fuse_operations_compat22 {
 	int (*getattr) (const char *, struct stat *);
 	int (*readlink) (const char *, char *, size_t);
-	int (*getdir) (const char *, fuse_dirh_t, fuse_dirfil_t);
 	int (*mknod) (const char *, mode_t, dev_t);
 	int (*mkdir) (const char *, mode_t);
 	int (*unlink) (const char *);
@@ -97,7 +95,7 @@ struct fuse_operations_compat22 {
 	int (*listxattr) (const char *, char *, size_t);
 	int (*removexattr) (const char *, const char *);
 	int (*opendir) (const char *, struct fuse_file_info_compat *);
-	int (*readdir) (const char *, void *, fuse_fill_dir_t, off_t,
+	int (*readdir) (const char *, void *, off_t,
 			struct fuse_file_info_compat *);
 	int (*releasedir) (const char *, struct fuse_file_info_compat *);
 	int (*fsyncdir) (const char *, int, struct fuse_file_info_compat *);
@@ -118,11 +116,9 @@ int fuse_main_real_compat22(int argc, char *argv[],
 			    const struct fuse_operations_compat22 *op,
 			    size_t op_size);
 
-typedef int (*fuse_dirfil_t_compat) (fuse_dirh_t h, const char *name, int type);
 struct fuse_operations_compat2 {
 	int (*getattr)	   (const char *, struct stat *);
 	int (*readlink)	   (const char *, char *, size_t);
-	int (*getdir)	   (const char *, fuse_dirh_t, fuse_dirfil_t_compat);
 	int (*mknod)	   (const char *, mode_t, dev_t);
 	int (*mkdir)	   (const char *, mode_t);
 	int (*unlink)	   (const char *);
@@ -170,7 +166,6 @@ struct fuse_statfs_compat1 {
 struct fuse_operations_compat1 {
 	int (*getattr)	(const char *, struct stat *);
 	int (*readlink) (const char *, char *, size_t);
-	int (*getdir)	(const char *, fuse_dirh_t, fuse_dirfil_t_compat);
 	int (*mknod)	(const char *, mode_t, dev_t);
 	int (*mkdir)	(const char *, mode_t);
 	int (*unlink)	(const char *);

libfuse/include/fuse_dirent.h

@@ -0,0 +1,31 @@
+/*
+  ISC License
+
+  Copyright (c) 2019, Antonio SJ Musumeci <trapexit@spawn.link>
+
+  Permission to use, copy, modify, and/or distribute this software for any
+  purpose with or without fee is hereby granted, provided that the above
+  copyright notice and this permission notice appear in all copies.
+
+  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+#pragma once
+
+#include <stdint.h>
+
+typedef struct fuse_dirent_s fuse_dirent_t;
+struct fuse_dirent_s
+{
+  uint64_t ino;
+  uint64_t off;
+  uint32_t namelen;
+  uint32_t type;
+  char     name[];
+};

libfuse/include/fuse_direntplus.h

@@ -0,0 +1,31 @@
+/*
+  ISC License
+
+  Copyright (c) 2019, Antonio SJ Musumeci <trapexit@spawn.link>
+
+  Permission to use, copy, modify, and/or distribute this software for any
+  purpose with or without fee is hereby granted, provided that the above
+  copyright notice and this permission notice appear in all copies.
+
+  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+#pragma once
+
+#include "fuse_attr.h"
+#include "fuse_dirent.h"
+#include "fuse_entry.h"
+
+typedef struct fuse_direntplus_s fuse_direntplus_t;
+struct fuse_direntplus_s
+{
+  fuse_entry_t  entry;
+  fuse_attr_t   attr;
+  fuse_dirent_t dirent;
+};

libfuse/include/fuse_dirents.h

@@ -0,0 +1,80 @@
+/*
+  ISC License
+
+  Copyright (c) 2019, Antonio SJ Musumeci <trapexit@spawn.link>
+
+  Permission to use, copy, modify, and/or distribute this software for any
+  purpose with or without fee is hereby granted, provided that the above
+  copyright notice and this permission notice appear in all copies.
+
+  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+#pragma once
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include "fuse_dirent.h"
+#include "fuse_direntplus.h"
+#include "fuse_entry.h"
+
+#include <dirent.h>
+#include <stdint.h>
+#include <stdio.h>
+#include <sys/stat.h>
+#include <sys/types.h>
+#include <unistd.h>
+
+enum fuse_dirents_type_e
+  {
+    UNSET = 0,
+    NORMAL,
+    PLUS
+  };
+typedef enum fuse_dirents_type_e fuse_dirents_type_t;
+
+typedef struct fuse_dirents_s fuse_dirents_t;
+struct fuse_dirents_s
+{
+  char                *buf;
+  uint64_t             buf_len;
+  uint64_t             data_len;
+  fuse_dirents_type_t  type;
+};
+
+int  fuse_dirents_init(fuse_dirents_t *d);
+void fuse_dirents_free(fuse_dirents_t *d);
+void fuse_dirents_reset(fuse_dirents_t *d);
+
+int  fuse_dirents_add(fuse_dirents_t      *d,
+                      const struct dirent *de);
+int  fuse_dirents_add_plus(fuse_dirents_t      *d,
+                           const struct dirent *de,
+                           const fuse_entry_t  *entry,
+                           const struct stat   *st);
+#ifdef __linux__
+struct linux_dirent64;
+int  fuse_dirents_add_linux(fuse_dirents_t            *d,
+                            const struct linux_dirent64 *de);
+int  fuse_dirents_add_linux_plus(fuse_dirents_t              *d,
+                                 const struct linux_dirent64 *de,
+                                 const fuse_entry_t          *entry,
+                                 const struct stat           *st);
+#endif
+
+void *fuse_dirents_find(fuse_dirents_t *d,
+                        const uint64_t  ino);
+
+int fuse_dirents_convert_plus2normal(fuse_dirents_t *d);
+
+#ifdef __cplusplus
+}
+#endif

libfuse/include/fuse_entry.h

@@ -0,0 +1,14 @@
+#pragma once
+
+#include <stdint.h>
+
+typedef struct fuse_entry_s fuse_entry_t;
+struct fuse_entry_s
+{
+  uint64_t nodeid;
+  uint64_t generation;
+  uint64_t entry_valid;
+  uint64_t attr_valid;
+  uint32_t entry_valid_nsec;
+  uint32_t attr_valid_nsec;
+};