Merge pull request #978 from trapexit/debug2

Add new debug printing routines, fix ioctl cmd type

libfuse/Makefile

@@ -34,6 +34,7 @@ AR ?= ar
 SRC   = \
 	lib/buffer.c \
 	lib/crc32b.c \
+	lib/debug.c \
 	lib/fuse.c \
 	lib/fuse_dirents.c \
 	lib/fuse_kern_chan.c \

libfuse/include/fuse.h

@@ -694,7 +694,9 @@ int fuse_main_real(int argc, char *argv[], const struct fuse_operations *op, siz
 int  fuse_start_maintenance_thread(struct fuse *fuse);
 void fuse_stop_maintenance_thread(struct fuse *fuse);
 
-void fuse_log_metrics(int enabled);
+int  fuse_log_metrics_get(void);
+void fuse_log_metrics_set(int enabled);
+
 
 /**
  * Iterate over cache removing stale entries

libfuse/lib/debug.h

@@ -0,0 +1,51 @@
+/*
+  ISC License
+
+  Copyright (c) 2021, 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_kernel.h"
+
+void debug_fuse_open_out(const uint64_t              unique,
+                         const struct fuse_open_out *arg,
+                         const uint64_t              argsize);
+void debug_fuse_init_in(const struct fuse_init_in *arg);
+void debug_fuse_init_out(const uint64_t              unique,
+                         const struct fuse_init_out *arg,
+                         const uint64_t              argsize);
+void debug_fuse_entry_out(const uint64_t               unique,
+                          const struct fuse_entry_out *arg,
+                          const uint64_t               argsize);
+void debug_fuse_attr_out(const uint64_t              unique,
+                         const struct fuse_attr_out *arg,
+                         const uint64_t              argsize);
+void debug_fuse_entry_open_out(const uint64_t               unique,
+                               const struct fuse_entry_out *earg,
+                               const struct fuse_open_out  *oarg);
+void debug_fuse_readlink(const uint64_t  unique,
+                         const char     *linkname);
+void debug_fuse_write_out(const uint64_t               unique,
+                          const struct fuse_write_out *arg);
+void debug_fuse_statfs_out(const uint64_t                unique,
+                           const struct fuse_statfs_out *arg);
+void debug_fuse_getxattr_out(const uint64_t                  unique,
+                             const struct fuse_getxattr_out *arg);
+void debug_fuse_lk_out(const uint64_t            unique,
+                       const struct fuse_lk_out *arg);
+void debug_fuse_bmap_out(const uint64_t              unique,
+                         const struct fuse_bmap_out *arg);
+void debug_fuse_in_header(const struct fuse_in_header *hdr);

libfuse/lib/fuse.c

@@ -16,12 +16,12 @@
 #include "lfmp.h"
 
 #include "config.h"
+#include "fuse_dirents.h"
 #include "fuse_i.h"
+#include "fuse_kernel.h"
 #include "fuse_lowlevel.h"
-#include "fuse_opt.h"
 #include "fuse_misc.h"
-#include "fuse_kernel.h"
-#include "fuse_dirents.h"
+#include "fuse_opt.h"
 
 #include <assert.h>
 #include <dlfcn.h>
@@ -4282,7 +4282,13 @@ fuse_config_num_threads(const struct fuse *fuse_)
 }
 
 void
-fuse_log_metrics(int log_)
+fuse_log_metrics_set(int log_)
 {
   g_LOG_METRICS = log_;
 }
+
+int
+fuse_log_metrics_get(void)
+{
+  return g_LOG_METRICS;
+}

libfuse/lib/fuse_lowlevel.c

@@ -11,6 +11,7 @@
 #include "lfmp.h"
 
 #include "config.h"
+#include "debug.h"
 #include "fuse_i.h"
 #include "fuse_kernel.h"
 #include "fuse_opt.h"
@@ -1733,7 +1734,10 @@ do_init(fuse_req_t  req,
   struct fuse_ll *f = req->f;
   size_t bufsize = fuse_chan_bufsize(req->ch);
 
-  (void) nodeid;
+  (void)nodeid;
+
+  if(f->debug)
+    debug_fuse_init_in(arg);
 
   f->conn.proto_major = arg->major;
   f->conn.proto_minor = arg->minor;
@@ -1906,6 +1910,9 @@ do_init(fuse_req_t  req,
   else
     outargsize = sizeof(outarg);
 
+  if(f->debug)
+    debug_fuse_init_out(req->unique,&outarg,outargsize);
+
   send_reply_ok(req, &outarg, outargsize);
 }
 

src/config.cpp

@@ -91,6 +91,7 @@ Config::Config()
     inodecalc("hybrid-hash"),
     link_cow(false),
     link_exdev(LinkEXDEV::ENUM::PASSTHROUGH),
+    log_metrics(false),
     mount(),
     moveonenospc(false),
     nfsopenhack(NFSOpenHack::ENUM::OFF),
@@ -155,6 +156,7 @@ Config::Config()
   _map["kernel_cache"]         = &kernel_cache;
   _map["link_cow"]             = &link_cow;
   _map["link-exdev"]           = &link_exdev;
+  _map["log.metrics"]          = &log_metrics;
   _map["minfreespace"]         = &minfreespace;
   _map["mount"]                = &mount;
   _map["moveonenospc"]         = &moveonenospc;

src/config.hpp

@@ -22,6 +22,7 @@
 #include "config_follow_symlinks.hpp"
 #include "config_inodecalc.hpp"
 #include "config_link_exdev.hpp"
+#include "config_log_metrics.hpp"
 #include "config_moveonenospc.hpp"
 #include "config_nfsopenhack.hpp"
 #include "config_readdir.hpp"
@@ -121,6 +122,7 @@ public:
   ConfigBOOL     kernel_cache;
   ConfigBOOL     link_cow;
   LinkEXDEV      link_exdev;
+  LogMetrics     log_metrics;
   ConfigSTR      mount;
   MoveOnENOSPC   moveonenospc;
   NFSOpenHack    nfsopenhack;

src/config_log_metrics.cpp

@@ -0,0 +1,53 @@
+/*
+  ISC License
+
+  Copyright (c) 2021, 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.
+*/
+
+#include "config_log_metrics.hpp"
+#include "from_string.hpp"
+#include "to_string.hpp"
+
+#include "fuse.h"
+
+LogMetrics::LogMetrics(const bool val_)
+{
+  fuse_log_metrics_set(val_);
+}
+
+std::string
+LogMetrics::to_string(void) const
+{
+  bool val;
+
+  val = fuse_log_metrics_get();
+
+  return str::to(val);
+}
+
+int
+LogMetrics::from_string(const std::string &s_)
+{
+  int rv;
+  bool val;
+
+  rv = str::from(s_,&val);
+  if(rv < 0)
+    return rv;
+
+  fuse_log_metrics_set(val);
+
+  return 0;
+}

src/config_log_metrics.hpp

@@ -0,0 +1,31 @@
+/*
+  ISC License
+
+  Copyright (c) 2021, 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 "tofrom_string.hpp"
+
+class LogMetrics : public ToFromString
+{
+public:
+  LogMetrics(const bool);
+
+public:
+  std::string to_string(void) const final;
+  int from_string(const std::string &) final;
+};

src/fuse_ioctl.cpp

@@ -27,8 +27,6 @@
 #include "str.hpp"
 #include "ugid.hpp"
 
-#include "fuse.h"
-
 #include <string>
 #include <vector>
 
@@ -43,14 +41,8 @@ using std::vector;
 #endif
 
 typedef char IOCTL_BUF[4096];
-#define IOCTL_APP_TYPE 0xDF
-#define IOCTL_FILE_INFO       _IOWR(IOCTL_APP_TYPE,0,IOCTL_BUF)
-#define IOCTL_METRICS_ENABLE  _IOWR(IOCTL_APP_TYPE,1,IOCTL_BUF)
-#define IOCTL_METRICS_DISABLE _IOWR(IOCTL_APP_TYPE,2,IOCTL_BUF)
-
-static_assert(IOCTL_FILE_INFO       == 0xD000DF00,"");
-static_assert(IOCTL_METRICS_ENABLE  == 0xD000DF01,"");
-static_assert(IOCTL_METRICS_DISABLE == 0xD000DF02,"");
+#define IOCTL_APP_TYPE  0xDF
+#define IOCTL_FILE_INFO _IOWR(IOCTL_APP_TYPE,0,IOCTL_BUF)
 
 #ifndef FS_IOC_GETFLAGS
 # define FS_IOC_GETFLAGS _IOR('f',1,long)
@@ -332,12 +324,6 @@ namespace l
       {
       case IOCTL_FILE_INFO:
         return l::file_info(ffi_,data_);
-      case IOCTL_METRICS_ENABLE:
-        fuse_log_metrics(1);
-        return 0;
-      case IOCTL_METRICS_DISABLE:
-        fuse_log_metrics(0);
-        return 0;
       }
 
     return -ENOTTY;