common: improve hobject_t fmtlib formatter performance

The new version of the code only takes about 38% of the time of the old
one.  See https://github.com/ronen-fr/hobjtostr/tree/rf-2 for the code
used to benchmark the new version.

hobject_fmt.h is folded into hobject.h, as fmtlib is now an accepted
dependency in all of Ceph.

Signed-off-by: Ronen Friedman <[email protected]>

Author: ronen-fr

src/common/hobject.h

@@ -15,6 +15,9 @@
 #ifndef __CEPH_OS_HOBJECT_H
 #define __CEPH_OS_HOBJECT_H
 
+#include <fmt/compile.h>
+#include <fmt/format.h>
+
 #if FMT_VERSION >= 90000
 #include <fmt/ostream.h>
 #endif
@@ -351,6 +354,54 @@ template<> struct hash<hobject_t> {
 };
 } // namespace std
 
+namespace fmt {
+template <>
+struct formatter<hobject_t> {
+
+  template <typename FormatContext>
+  static inline auto
+  append_sanitized(FormatContext& ctx, const std::string& in, int sep = 0)
+  {
+    for (const auto i : in) {
+      if (i == '%' || i == ':' || i == '/' || i < 32 || i >= 127) {
+	fmt::format_to(
+	    ctx.out(), FMT_COMPILE("%{:02x}"), static_cast<unsigned char>(i));
+      } else {
+	fmt::format_to(ctx.out(), FMT_COMPILE("{:c}"), i);
+      }
+    }
+    if (sep) {
+      fmt::format_to(
+	  ctx.out(), FMT_COMPILE("{:c}"), sep);
+    }
+    return ctx.out();
+  }
+
+  constexpr auto parse(format_parse_context& ctx) { return ctx.begin(); }
+
+  template <typename FormatContext>
+  auto format(const hobject_t& ho, FormatContext& ctx)
+  {
+    if (ho == hobject_t{}) {
+      return fmt::format_to(ctx.out(), "MIN");
+    }
+
+    if (ho.is_max()) {
+      return fmt::format_to(ctx.out(), "MAX");
+    }
+
+    fmt::format_to(
+	ctx.out(), FMT_COMPILE("{}:{:08x}:"), static_cast<uint64_t>(ho.pool),
+	ho.get_bitwise_key_u32());
+    append_sanitized(ctx, ho.nspace, ':');
+    append_sanitized(ctx, ho.get_key(), ':');
+    append_sanitized(ctx, ho.oid.name);
+    return fmt::format_to(ctx.out(), FMT_COMPILE(":{}"), ho.snap);
+  }
+};
+}  // namespace fmt
+
+
 std::ostream& operator<<(std::ostream& out, const hobject_t& o);
 
 template <typename T>

src/common/hobject_fmt.h

@@ -4,7 +4,7 @@
 #include <algorithm>
 #include <boost/type_index.hpp>
 #include <fmt/ranges.h>
-#include "common/hobject_fmt.h"
+#include "common/hobject.h"
 #include "crimson/osd/backfill_state.h"
 #include "osd/osd_types_fmt.h"
 

src/crimson/osd/backfill_state.cc

@@ -14,7 +14,7 @@
 #include <fmt/format.h>
 #include <fmt/ostream.h>
 
-#include "common/hobject_fmt.h"
+#include "common/hobject.h"
 
 #include "messages/MOSDOp.h"
 #include "messages/MOSDOpReply.h"

src/crimson/osd/pg.cc

@@ -18,7 +18,6 @@
 
 #include "common/fmt_common.h"
 #include "common/hobject.h"
-#include "common/hobject_fmt.h"
 #include "crimson/common/log.h"
 #include "osd/osd_types_fmt.h"
 #include "scrub_validator.h"

src/crimson/osd/scrub/scrub_machine.h

@@ -98,6 +98,15 @@ class entity_name_t {
   }
   void dump(ceph::Formatter *f) const;
 
+  template <typename FormatContext>
+  auto fmt_print_ctx(FormatContext& ctx) const {
+    if (is_new() || _num < 0) {
+      return fmt::format_to(ctx.out(), "{}.?", type_str());
+    } else {
+      return fmt::format_to(ctx.out(), "{}.{}",type_str(), _num);
+    }
+  }
+
   static void generate_test_instances(std::list<entity_name_t*>& o);
 };
 WRITE_CLASS_DENC(entity_name_t)

src/msg/msg_types.h

@@ -5,9 +5,10 @@
  * \file fmtlib formatters for some types.h classes
  */
 
-#include "common/hobject_fmt.h"
+#include "common/hobject.h"
 #include "osd/osd_types.h"
 #include <fmt/chrono.h>
+#include <fmt/ranges.h>
 #if FMT_VERSION >= 90000
 #include <fmt/ostream.h>
 #endif