Merge pull request ceph#62948 from MaxKellermann/cephfs_includes

cephfs: include cleanup

Reviewed-by: Venky Shankar <[email protected]>

Author: vshankar

ceph.spec.in

@@ -2559,6 +2559,9 @@ fi
 %{_includedir}/cephfs/types.h
 %dir %{_includedir}/cephfs/metrics
 %{_includedir}/cephfs/metrics/Types.h
+%{_includedir}/cephfs/dump.h
+%{_includedir}/cephfs/json.h
+%{_includedir}/cephfs/keys_and_values.h
 %{_libdir}/libcephfs.so
 %{_libdir}/libcephfs_proxy.so
 %{_libdir}/pkgconfig/cephfs.pc

debian/libcephfs-dev.install

@@ -2,6 +2,9 @@ usr/include/cephfs/ceph_ll_client.h
 usr/include/cephfs/libcephfs.h
 usr/include/cephfs/types.h
 usr/include/cephfs/metrics/Types.h
+usr/include/cephfs/dump.h
+usr/include/cephfs/json.h
+usr/include/cephfs/keys_and_values.h
 usr/lib/libcephfs.so
 usr/lib/libcephfs_proxy.so
 usr/lib/pkgconfig/cephfs.pc

src/client/Client.cc

@@ -114,6 +114,7 @@ using namespace std::literals::string_view_literals;
 #include "posix_acl.h"
 
 #include "include/ceph_assert.h"
+#include "include/cephfs/keys_and_values.h"
 #include "include/stat.h"
 
 #include "include/cephfs/ceph_ll_client.h"

src/common/ceph_fs.cc

@@ -7,7 +7,111 @@
 /*
  * Some non-inline ceph helpers
  */
-#include "include/types.h"
+
+#include "include/ceph_fs.h"
+#include "include/encoding.h"
+
+void encode(const struct ceph_mds_request_head& h, ceph::buffer::list& bl) {
+  using ceph::encode;
+  encode(h.version, bl);
+  encode(h.oldest_client_tid, bl);
+  encode(h.mdsmap_epoch, bl);
+  encode(h.flags, bl);
+
+  // For old MDS daemons
+  __u8 num_retry = __u32(h.ext_num_retry);
+  __u8 num_fwd = __u32(h.ext_num_fwd);
+  encode(num_retry, bl);
+  encode(num_fwd, bl);
+
+  encode(h.num_releases, bl);
+  encode(h.op, bl);
+  encode(h.caller_uid, bl);
+  encode(h.caller_gid, bl);
+  encode(h.ino, bl);
+  bl.append((char*)&h.args, sizeof(h.args));
+
+  if (h.version >= 2) {
+    encode(h.ext_num_retry, bl);
+    encode(h.ext_num_fwd, bl);
+  }
+
+  if (h.version >= 3) {
+    __u32 struct_len = sizeof(struct ceph_mds_request_head);
+    encode(struct_len, bl);
+    encode(h.owner_uid, bl);
+    encode(h.owner_gid, bl);
+
+    /*
+     * Please, add new fields handling here.
+     * You don't need to check h.version as we do it
+     * in decode(), because decode can properly skip
+     * all unsupported fields if h.version >= 3.
+     */
+  }
+}
+
+void decode(struct ceph_mds_request_head& h, ceph::buffer::list::const_iterator& bl) {
+  using ceph::decode;
+  unsigned struct_end = bl.get_off();
+
+  decode(h.version, bl);
+  decode(h.oldest_client_tid, bl);
+  decode(h.mdsmap_epoch, bl);
+  decode(h.flags, bl);
+  decode(h.num_retry, bl);
+  decode(h.num_fwd, bl);
+  decode(h.num_releases, bl);
+  decode(h.op, bl);
+  decode(h.caller_uid, bl);
+  decode(h.caller_gid, bl);
+  decode(h.ino, bl);
+  bl.copy(sizeof(h.args), (char*)&(h.args));
+
+  if (h.version >= 2) {
+    decode(h.ext_num_retry, bl);
+    decode(h.ext_num_fwd, bl);
+  } else {
+    h.ext_num_retry = h.num_retry;
+    h.ext_num_fwd = h.num_fwd;
+  }
+
+  if (h.version >= 3) {
+    decode(h.struct_len, bl);
+    struct_end += h.struct_len;
+
+    decode(h.owner_uid, bl);
+    decode(h.owner_gid, bl);
+  } else {
+    /*
+     * client is old: let's take caller_{u,g}id as owner_{u,g}id
+     * this is how it worked before adding of owner_{u,g}id fields.
+     */
+    h.owner_uid = h.caller_uid;
+    h.owner_gid = h.caller_gid;
+  }
+
+  /* add new fields handling here */
+
+  /*
+   * From version 3 we have struct_len field.
+   * It allows us to properly handle a case
+   * when client send struct ceph_mds_request_head
+   * bigger in size than MDS supports. In this
+   * case we just want to skip all remaining bytes
+   * at the end.
+   *
+   * See also DECODE_FINISH macro. Unfortunately,
+   * we can't start using it right now as it will be
+   * an incompatible protocol change.
+   */
+  if (h.version >= 3) {
+    if (bl.get_off() > struct_end)
+      throw ::ceph::buffer::malformed_input(DECODE_ERR_PAST(__PRETTY_FUNCTION__));
+    if (bl.get_off() < struct_end)
+      bl += struct_end - bl.get_off();
+  }
+}
 
 int ceph_flags_to_mode(int flags)
 {

src/common/fs_types.cc

@@ -7,6 +7,16 @@
 #include "common/ceph_json.h"
 #include "include/denc.h"
 
+#include <iostream>
+
+void inodeno_t::dump(ceph::Formatter *f) const {
+  f->dump_unsigned("val", val);
+}
+
+std::ostream& operator<<(std::ostream& out, const inodeno_t& ino) {
+  return out << std::hex << "0x" << ino.val << std::dec;
+}
+
 void dump(const ceph_file_layout& l, ceph::Formatter *f)
 {
   f->dump_unsigned("stripe_unit", l.fl_stripe_unit);

src/crimson/CMakeLists.txt

@@ -33,6 +33,7 @@ add_library(crimson-common STATIC
   ${PROJECT_SOURCE_DIR}/src/common/ceph_argparse.cc
   ${PROJECT_SOURCE_DIR}/src/common/ceph_context.cc
   ${PROJECT_SOURCE_DIR}/src/common/ceph_crypto.cc
+  ${PROJECT_SOURCE_DIR}/src/common/ceph_fs.cc
   ${PROJECT_SOURCE_DIR}/src/common/ceph_hash.cc
   ${PROJECT_SOURCE_DIR}/src/common/ceph_time.cc
   ${PROJECT_SOURCE_DIR}/src/common/ceph_strings.cc

src/include/ceph_fs.h

@@ -14,8 +14,7 @@
 
 #include "msgr.h"
 #include "rados.h"
-#include "include/encoding.h"
-#include "include/denc.h"
+#include "include/buffer.h" // for ceph::buffer::list
 
 /*
  * The data structures defined here are shared between Linux kernel and
@@ -686,107 +685,8 @@ struct ceph_mds_request_head {
 	__le32 owner_uid, owner_gid;   /* used for OPs which create inodes */
 } __attribute__ ((packed));
 
-void inline encode(const struct ceph_mds_request_head& h, ceph::buffer::list& bl) {
-  using ceph::encode;
-  encode(h.version, bl);
-  encode(h.oldest_client_tid, bl);
-  encode(h.mdsmap_epoch, bl);
-  encode(h.flags, bl);
-
-  // For old MDS daemons
-  __u8 num_retry = __u32(h.ext_num_retry);
-  __u8 num_fwd = __u32(h.ext_num_fwd);
-  encode(num_retry, bl);
-  encode(num_fwd, bl);
-
-  encode(h.num_releases, bl);
-  encode(h.op, bl);
-  encode(h.caller_uid, bl);
-  encode(h.caller_gid, bl);
-  encode(h.ino, bl);
-  bl.append((char*)&h.args, sizeof(h.args));
-
-  if (h.version >= 2) {
-    encode(h.ext_num_retry, bl);
-    encode(h.ext_num_fwd, bl);
-  }
-
-  if (h.version >= 3) {
-    __u32 struct_len = sizeof(struct ceph_mds_request_head);
-    encode(struct_len, bl);
-    encode(h.owner_uid, bl);
-    encode(h.owner_gid, bl);
-
-    /*
-     * Please, add new fields handling here.
-     * You don't need to check h.version as we do it
-     * in decode(), because decode can properly skip
-     * all unsupported fields if h.version >= 3.
-     */
-  }
-}
-
-void inline decode(struct ceph_mds_request_head& h, ceph::buffer::list::const_iterator& bl) {
-  using ceph::decode;
-  unsigned struct_end = bl.get_off();
-
-  decode(h.version, bl);
-  decode(h.oldest_client_tid, bl);
-  decode(h.mdsmap_epoch, bl);
-  decode(h.flags, bl);
-  decode(h.num_retry, bl);
-  decode(h.num_fwd, bl);
-  decode(h.num_releases, bl);
-  decode(h.op, bl);
-  decode(h.caller_uid, bl);
-  decode(h.caller_gid, bl);
-  decode(h.ino, bl);
-  bl.copy(sizeof(h.args), (char*)&(h.args));
-
-  if (h.version >= 2) {
-    decode(h.ext_num_retry, bl);
-    decode(h.ext_num_fwd, bl);
-  } else {
-    h.ext_num_retry = h.num_retry;
-    h.ext_num_fwd = h.num_fwd;
-  }
-
-  if (h.version >= 3) {
-    decode(h.struct_len, bl);
-    struct_end += h.struct_len;
-
-    decode(h.owner_uid, bl);
-    decode(h.owner_gid, bl);
-  } else {
-    /*
-     * client is old: let's take caller_{u,g}id as owner_{u,g}id
-     * this is how it worked before adding of owner_{u,g}id fields.
-     */
-    h.owner_uid = h.caller_uid;
-    h.owner_gid = h.caller_gid;
-  }
-
-  /* add new fields handling here */
-
-  /*
-   * From version 3 we have struct_len field.
-   * It allows us to properly handle a case
-   * when client send struct ceph_mds_request_head
-   * bigger in size than MDS supports. In this
-   * case we just want to skip all remaining bytes
-   * at the end.
-   *
-   * See also DECODE_FINISH macro. Unfortunately,
-   * we can't start using it right now as it will be
-   * an incompatible protocol change.
-   */
-  if (h.version >= 3) {
-    if (bl.get_off() > struct_end)
-      throw ::ceph::buffer::malformed_input(DECODE_ERR_PAST(__PRETTY_FUNCTION__));
-    if (bl.get_off() < struct_end)
-      bl += struct_end - bl.get_off();
-  }
-}
+void encode(const struct ceph_mds_request_head& h, ceph::buffer::list& bl);
+void decode(struct ceph_mds_request_head& h, ceph::buffer::list::const_iterator& bl);
 
 /* cap/lease release record */
 struct ceph_mds_request_release {