Change TSDbgCtl from a struct to a class.

TSDbgCtlCreate() and TSDbgCtlDestroy() are eliminated.

tsapi::c_support::TSDbgCtlUniqPtr is eliminated.

Author: ywkaras

example/plugins/c-api/cache_scan/cache_scan.cc

@@ -36,7 +36,7 @@
 
 #define PLUGIN_NAME "cache_scan"
 
-static const TSDbgCtl *const dbg_ctl = TSDbgCtlCreate(PLUGIN_NAME);
+static TSDbgCtl dbg_ctl{PLUGIN_NAME};
 
 static TSCont global_contp;
 

include/tscore/DbgCtl.h include/ts/DbgCtl.hinclude/tscore/DbgCtl.h renamed to include/ts/DbgCtl.h

@@ -23,9 +23,9 @@
 
 #pragma once
 
-#include <ts/ts.h>
+class DiagsConfigState;
 
-// For use with TSDbg().
+// For use with TSDbg() or Dbg().
 //
 class DbgCtl
 {
@@ -37,26 +37,45 @@ class DbgCtl
 
   ~DbgCtl() { _rm_reference(); }
 
-  TSDbgCtl const *
-  ptr() const
+  bool
+  on() const
   {
-    return _ptr;
+    return _ptr->on != 0;
   }
 
-  // Call this when the compiled regex to enable tags may have changed.
+  char const *
+  tag() const
+  {
+    return _ptr->tag;
+  }
+
+  static bool
+  global_on()
+  {
+    return _global_on;
+  }
+
+  // Call this when the compiled regex to enable tags may have changed.  Should not be called in plugins.
   //
   static void update();
 
+  // For use in Dbg() macro only.
+  //
+  static void print(const char *tag, const char *format_str, ...);
+
 private:
-  TSDbgCtl const *const _ptr;
+  struct _Data {
+    char volatile on; // Flag
+    char const *tag;
+  };
 
-  static const TSDbgCtl *_new_reference(char const *tag);
+  Data const *const _ptr;
 
-  static void _rm_reference();
+  static const Data *_new_reference(char const *tag);
 
-  class _RegistryAccessor;
+  static void _rm_reference();
 
-  friend TSDbgCtl const *tsapi::c::TSDbgCtlCreate(char const *tag);
+  static bool _global_on;
 
-  friend void tsapi::c::TSDbgCtlDestroy(TSDbgCtl const *dbg_ctl);
+  class _RegistryAccessor;
 };

include/ts/apidefs.h.in

@@ -1114,11 +1114,6 @@ char const TS_VERSION_STRING[] = "@TS_VERSION_STRING@";
     TSIOBufferWaterMark buffer_water_mark;
   };
 
-  struct TSDbgCtl {
-    char volatile on; // Flag
-    char const *tag;
-  };
-
   /* --------------------------------------------------------------------------
      URL schemes */
   extern const char *TS_URL_SCHEME_FILE;

include/ts/ts.h

@@ -12,7 +12,7 @@
   "License"); you may not use this file except in compliance
   with the License.  You may obtain a copy of the License at
 
-      http://www.apache.org/licenses/LICENSE-2.0
+  http://www.apache.org/licenses/LICENSE-2.0
 
   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
@@ -25,7 +25,7 @@
   Developers, when adding a new element to an enum, append it. DO NOT
   insert it.  Otherwise, binary compatibility of plugins will be broken!
 
- */
+*/
 
 #pragma once
 

include/tscpp/api/Cleanup.h

@@ -100,17 +100,6 @@ struct TSIOBufferReaderDeleter {
 };
 using TSIOBufferReaderUniqPtr = std::unique_ptr<std::remove_pointer_t<TSIOBufferReader>, TSIOBufferReaderDeleter>;
 
-// Deleter and unique pointer for TSDbgCtl const.
-//
-struct TSDbgCtlDeleter {
-  void
-  operator()(TSDbgCtl const *ptr)
-  {
-    TSDbgCtlDestroy(ptr);
-  }
-};
-using TSDbgCtlUniqPtr = std::unique_ptr<TSDbgCtl const, TSDbgCtlDeleter>;
-
 class TxnAuxDataMgrBase
 {
 protected:

plugins/experimental/webp_transform/ImageTransform.cc

@@ -49,7 +49,7 @@ namespace
 {
 GlobalPlugin *plugin;
 
-auto webp_dbg_ctl = TSDbgCtlCreate(TAG);
+TSDbgCtl webp_dbg_ctl{TAG};
 
 enum class ImageEncoding { webp, jpeg, png, unknown };
 

src/traffic_server/InkAPI.cc

@@ -7435,50 +7435,6 @@ tsapi::c::TSStatFindName(const char *name, int *idp)
   }
 }
 
-/**************************   Tracing API   ****************************/
-// returns 1 or 0 to indicate whether TS is being run with a debug tag.
-int
-tsapi::c::TSIsDebugTagSet(const char *t)
-{
-  return diags()->on_for_TSDebug(t);
-}
-
-void
-tsapi::c::TSDebugSpecific(int debug_flag, const char *tag, const char *format_str, ...)
-{
-  if ((debug_flag && diags()->on_for_TSDebug()) || diags()->on_for_TSDebug(tag)) {
-    va_list ap;
-
-    va_start(ap, format_str);
-    diags()->print_va(tag, DL_Diag, nullptr, format_str, ap);
-    va_end(ap);
-  }
-}
-
-// Plugins would use TSDebug just as the TS internal uses Debug
-// e.g. TSDebug("plugin-cool", "Snoopy is a cool guy even after %d requests.", num_reqs);
-void
-tsapi::c::TSDebug(const char *tag, const char *format_str, ...)
-{
-  if (diags()->on_for_TSDebug() && diags()->tag_activated(tag)) {
-    va_list ap;
-
-    va_start(ap, format_str);
-    diags()->print_va(tag, DL_Diag, nullptr, format_str, ap);
-    va_end(ap);
-  }
-}
-
-void
-tsapi::c::_TSDbg(const char *tag, const char *format_str, ...)
-{
-  va_list ap;
-
-  va_start(ap, format_str);
-  diags()->print_va(tag, DL_Diag, nullptr, format_str, ap);
-  va_end(ap);
-}
-
 /**************************   Logging API   ****************************/
 
 TSReturnCode
@@ -10023,23 +9979,6 @@ tsapi::c::TSHttpTxnPostBufferReaderGet(TSHttpTxn txnp)
   return (TSIOBufferReader)sm->get_postbuf_clone_reader();
 }
 
-tsapi::c::TSDbgCtl const *
-tsapi::c::TSDbgCtlCreate(char const *tag)
-{
-  sdk_assert(tag != nullptr);
-  sdk_assert(*tag != '\0');
-
-  return DbgCtl::_new_reference(tag);
-}
-
-void
-tsapi::c::TSDbgCtlDestroy(TSDbgCtl const *dbg_ctl)
-{
-  sdk_assert(dbg_ctl != nullptr);
-
-  DbgCtl::_rm_reference();
-}
-
 namespace rpc
 {
 extern std::mutex g_rpcHandlingMutex;

src/tscore/DbgCtl.cc

@@ -39,14 +39,14 @@ class DbgCtl::_RegistryAccessor
 private:
   struct TagCmp {
     bool
-    operator()(TSDbgCtl const &a, TSDbgCtl const &b) const
+    operator()(Data const &a, Data const &b) const
     {
       return std::strcmp(a.tag, b.tag) < 0;
     }
   };
 
 public:
-  using Set = std::set<TSDbgCtl, TagCmp>;
+  using Set = std::set<Data, TagCmp>;
 
   class Registry
   {
@@ -121,12 +121,12 @@ class DbgCtl::_RegistryAccessor
   inline static std::atomic<Registry *> _registry_instance{nullptr};
 };
 
-TSDbgCtl const *
+Data const *
 DbgCtl::_new_reference(char const *tag)
 {
   ink_assert(tag != nullptr);
 
-  TSDbgCtl ctl;
+  Data ctl;
 
   ctl.tag = tag;
 
@@ -192,6 +192,6 @@ DbgCtl::update()
   auto &d{ra.data()};
 
   for (auto &i : d.set) {
-    const_cast<char volatile &>(i.on) = diags()->tag_activated(i.tag, DiagsTagType_Debug);
+    const_cast<bool volatile &>(i.on) = diags()->tag_activated(i.tag, DiagsTagType_Debug);
   }
 }

tests/gold_tests/pluginTest/TSVConnFd/TSVConnFd.cc

@@ -32,7 +32,6 @@
 #include <tscpp/api/Cleanup.h>
 
 using atscppapi::TSContUniqPtr;
-using atscppapi::TSDbgCtlUniqPtr;
 
 /*
 Plugin for testing TSVConnFdCreate().
@@ -446,8 +445,7 @@ Send_to_vconn::_cont_func(TSCont cont, TSEvent event, void *edata)
   return 0;
 }
 
-TSDbgCtlUniqPtr dbg_ctl_guard{TSDbgCtlCreate(PIName)};
-TSDbgCtl const *const dbg_ctl{dbg_ctl_guard.get()};
+TSDbgCtl dbg_ctl{PIName};
 
 // Delete file whose path is specified in the constructor when the instance is destroyed.
 //

tests/gold_tests/pluginTest/polite_hook_wait/polite_hook_wait.cc

@@ -40,8 +40,7 @@ namespace
 {
 char PIName[] = PINAME;
 
-atscppapi::TSDbgCtlUniqPtr dbg_ctl_guard{TSDbgCtlCreate(PIName)};
-TSDbgCtl const *const dbg_ctl{dbg_ctl_guard.get()};
+TSDbgCtl dbg_ctl{PIName};
 
 enum Test_step { BEGIN, GLOBAL_CONT_READ_HDRS, THREAD, TXN_CONT_READ_HDRS, END };