Introduce tsutil from tsapicore and tscpputil (#10928)

* move tsapicore to tsutil * Move tscpp/util to tsutil * cmake format * cleanup remaining tscore deps from tsutil * what on earth
apache · Dec 13, 2023 · f600c16 · f600c16
1 parent 986ebe9
commit f600c16
Show file tree

Hide file tree

Showing 168 changed files with 286 additions and 345 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -568,8 +568,8 @@ configure_file(configs/records.yaml.default.in configs/records.yaml.default)
 configure_file(include/tscore/ink_config.h.cmake.in include/tscore/ink_config.h)
 configure_file(include/ts/apidefs.h.in include/ts/apidefs.h)
 
-add_subdirectory(src/tscpp/util)
 add_subdirectory(src/tscpp/api)
+add_subdirectory(src/tsutil)
 add_subdirectory(src/tscore)
 add_subdirectory(src/records)
 add_subdirectory(src/iocore)

diff --git a/NOTICE b/NOTICE
@@ -99,5 +99,5 @@ https://github.com/ariya/FastLZ
 
 ~~
 
-include/tscpp/util/Bravo.h is C++ version of puzpuzpuz/xsync's RBMutex
+include/tsutil/Bravo.h is C++ version of puzpuzpuz/xsync's RBMutex
 Copyright (c) 2021 Andrey Pechkurov (MIT License)
diff --git a/cmake/add_atsplugin.cmake b/cmake/add_atsplugin.cmake
@@ -19,7 +19,7 @@ set(CMAKE_SHARED_LIBRARY_PREFIX "")
 
 function(add_atsplugin name)
   add_library(${name} MODULE ${ARGN})
-  target_link_libraries(${name} PRIVATE ts::tsapi ts::tsapicore)
+  target_link_libraries(${name} PRIVATE ts::tsapi ts::tsutil)
   set_target_properties(${name} PROPERTIES PREFIX "")
   set_target_properties(${name} PROPERTIES SUFFIX ".so")
   install(TARGETS ${name} DESTINATION ${CMAKE_INSTALL_LIBEXECDIR})

diff --git a/doc/developer-guide/internal-libraries/buffer-writer.en.rst b/doc/developer-guide/internal-libraries/buffer-writer.en.rst
@@ -29,7 +29,7 @@ Synopsis
 
 .. code-block:: cpp
 
-   #include <api/ts_bw_format.h> // Above plus Formatting support.
+   #include <tsutil/ts_bw_format.h> // Above plus Formatting support.
 
 Description
 +++++++++++

diff --git a/doc/developer-guide/introduction/header-file-structure.en.rst b/doc/developer-guide/introduction/header-file-structure.en.rst
@@ -32,11 +32,11 @@ The header files are located in the ``include/`` directory. There are several su
 
   The C++ Plugin API is deprecated in ATS 10.  It will be removed in ATS 11.
 
-"tscpp/util"
+"tsutil"
    C++ utilities. These are standalone headers (although they may depend on other headers in the
    same directory). These provide functionality that is used inside the |TS| core logic but has been
    demonstrated to be useful for plugins as well [#]_. The functions are in the library
-   ``libtscpputil.so``, although many of the utilities are header only. This library is linked in to
+   ``libtsutil.so``, although many of the utilities are header only. This library is linked in to
    the ``traffic_server`` binary and so linkage may not be needed for a plugin.
 
    This library is independent of the C++ API and can be used with or without that library.
@@ -46,17 +46,14 @@ The header files are located in the ``include/`` directory. There are several su
    data structures either directly or operationally. This is linked in to the ``traffic_server`` binary therefore
    has no explicit linkage when used in the core.
 
-"api"
-   Plugin API internal header files. These are header files for the internal ``tsapicore`` library (see below). Theses can only be used inside |TS| itself.
-
 New Plugin API layout
 =====================
 
 Previously, all plugin interfaces were built into the main |TS| binary. In an effort to enhance modularity and enable compile-time checks, these interfaces have been moved to ``src/api``. They are now isolated into a separate shared library ``tsapi.so``.
 
-In addition, a new static library ``tsapicore.a`` has been created, which contains code used by both the core and the plugins (via the plugin APIs), and is linked into the |TS| binary to keep functionalities consistent.
+In addition, a new static library ``tsutil.a`` has been created, which contains code used by both the core and the plugins (via the plugin APIs), and is linked into the |TS| binary to keep functionalities consistent.
 
-Note that ``tsapi.so`` depends on ``tsapicore.a`` and other static libraries in
+Note that ``tsapi.so`` depends on ``tsutil.a`` and other static libraries in
 the core. ``tsapi.so`` is not statically linked against these dependencies
 during its creation, but relies on them being linked into |TS|. To verify these
 dependencies, a compile-time sanity check links ``tsapi.so`` with the main
@@ -81,7 +78,7 @@ The contents of "lib/ts" were broken up and moved to different locations. The he
 "include/tscore" for core only headers, while headers to be made available to plugins were moved to
 "include/tscpp/util". The corresponding source files were moved to "src/tscore" and "src/tscpp/util"
 respectively. "libtsutil" was split in to "libtscore" for the core code and "libtscpputil" for shared
-code.
+code.  Now "libtscpputil" has been combined with "tsapicore" headers into the "tsutil" library.
 
 Appendix
 ========

diff --git a/include/iocore/cache/CacheEvacuateDocVC.h b/include/iocore/cache/CacheEvacuateDocVC.h
@@ -39,7 +39,7 @@
 #include "tscore/ink_assert.h"
 
 // ts
-#include "api/DbgCtl.h"
+#include "tsutil/DbgCtl.h"
 
 class CacheEvacuateDocVC : public CacheVC
 {

diff --git a/include/iocore/eventsystem/EThread.h b/include/iocore/eventsystem/EThread.h
@@ -32,7 +32,7 @@
 #include "iocore/eventsystem/Thread.h"
 #include "iocore/eventsystem/PriorityEventQueue.h"
 #include "iocore/eventsystem/ProtectedQueue.h"
-#include "tscpp/util/Histogram.h"
+#include "tsutil/Histogram.h"
 
 // TODO: This would be much nicer to have "run-time" configurable (or something)
 #define PER_THREAD_DATA (1024 * 1024)

diff --git a/include/iocore/net/SNIActionItem.h b/include/iocore/net/SNIActionItem.h
@@ -35,7 +35,7 @@
 #include <openssl/ssl.h>
 
 #include "tscore/ink_inet.h"
-#include "api/DbgCtl.h"
+#include "tsutil/DbgCtl.h"
 
 class ActionItem
 {

diff --git a/include/iocore/net/SSLSNIConfig.h b/include/iocore/net/SSLSNIConfig.h
@@ -45,7 +45,7 @@
 #error "Unable to locate PCRE heeader"
 #endif
 
-#include "tscpp/util/ts_ip.h"
+#include "tsutil/ts_ip.h"
 
 #include "iocore/eventsystem/ConfigProcessor.h"
 #include "iocore/net/SNIActionItem.h"

diff --git a/include/iocore/net/YamlSNIConfig.h b/include/iocore/net/YamlSNIConfig.h
@@ -31,7 +31,7 @@
 
 #include "iocore/net/SSLTypes.h"
 
-#include "tscpp/util/ts_ip.h"
+#include "tsutil/ts_ip.h"
 
 #include "tscore/Errata.h"
 

diff --git a/include/iocore/net/quic/QUICStats.h b/include/iocore/net/quic/QUICStats.h
@@ -23,7 +23,7 @@
 
 #pragma once
 
-#include "api/Metrics.h"
+#include "tsutil/Metrics.h"
 
 using ts::Metrics;
 

diff --git a/include/proxy/ControlMatcher.h b/include/proxy/ControlMatcher.h
@@ -94,7 +94,7 @@
 #include "tscore/ink_apidefs.h"
 #include "tscore/ink_defs.h"
 #include "proxy/hdrs/HTTP.h"
-#include "tscpp/util/Regex.h"
+#include "tsutil/Regex.h"
 #include "proxy/hdrs/URL.h"
 
 #if __has_include("pcre/pcre.h")

diff --git a/include/proxy/hdrs/HdrToken.h b/include/proxy/hdrs/HdrToken.h
@@ -30,7 +30,7 @@
 #include "tscore/ink_defs.h"
 #include "tscore/ink_string.h"
 #include "tscore/Allocator.h"
-#include "tscpp/util/Regex.h"
+#include "tsutil/Regex.h"
 #include "tscore/ink_apidefs.h"
 
 ////////////////////////////////////////////////////////////////////////////

diff --git a/include/proxy/http/HttpConfig.h b/include/proxy/http/HttpConfig.h
@@ -47,13 +47,13 @@
 #include "tscore/ink_platform.h"
 #include "tscore/ink_inet.h"
 #include "tscore/ink_resolver.h"
-#include "tscpp/util/Regex.h"
+#include "tsutil/Regex.h"
 #include "iocore/eventsystem/ConfigProcessor.h"
 #include "iocore/net/ConnectionTracker.h"
 #include "iocore/net/SessionSharingAPIEnums.h"
 #include "records/RecProcess.h"
-#include "tscpp/util/ts_ip.h"
-#include "api/Metrics.h"
+#include "tsutil/ts_ip.h"
+#include "tsutil/Metrics.h"
 
 using ts::Metrics;
 

diff --git a/include/proxy/http/PreWarmManager.h b/include/proxy/http/PreWarmManager.h
@@ -37,7 +37,7 @@
 #include "iocore/net/NetTimeout.h"
 #include "proxy/Milestones.h"
 
-#include "api/Metrics.h"
+#include "tsutil/Metrics.h"
 
 using ts::Metrics;
 

diff --git a/include/proxy/http/remap/UrlMapping.h b/include/proxy/http/remap/UrlMapping.h
@@ -39,7 +39,7 @@
 #include "proxy/hdrs/URL.h"
 #include "proxy/http/remap/RemapPluginInfo.h"
 #include "proxy/http/remap/PluginFactory.h"
-#include "tscpp/util/Regex.h"
+#include "tsutil/Regex.h"
 #include "tscore/List.h"
 
 class NextHopSelectionStrategy;

diff --git a/include/proxy/http/remap/UrlRewrite.h b/include/proxy/http/remap/UrlRewrite.h
@@ -28,7 +28,7 @@
 #include "proxy/http/remap/UrlMapping.h"
 #include "proxy/http/remap/UrlMappingPathIndex.h"
 #include "proxy/http/HttpTransact.h"
-#include "tscpp/util/Regex.h"
+#include "tsutil/Regex.h"
 #include "proxy/http/remap/PluginFactory.h"
 #include "proxy/http/remap/NextHopStrategyFactory.h"
 

diff --git a/include/proxy/http2/HTTP2.h b/include/proxy/http2/HTTP2.h
@@ -29,7 +29,7 @@
 #include "proxy/hdrs/MIME.h"
 #include "records/RecDefs.h"
 
-#include "api/Metrics.h"
+#include "tsutil/Metrics.h"
 
 using ts::Metrics;
 

diff --git a/include/proxy/http3/Http3.h b/include/proxy/http3/Http3.h
@@ -24,7 +24,7 @@
 #pragma once
 
 #include "tscore/ink_defs.h"
-#include "api/Metrics.h"
+#include "tsutil/Metrics.h"
 
 using ts::Metrics;
 

diff --git a/include/proxy/logging/LogConfig.h b/include/proxy/logging/LogConfig.h
@@ -32,7 +32,7 @@
 #include "proxy/logging/LogObject.h"
 #include "proxy/logging/RolledLogDeleter.h"
 #include "swoc/MemSpan.h"
-#include "api/Metrics.h"
+#include "tsutil/Metrics.h"
 
 using ts::Metrics;
 

diff --git a/include/records/RecHttp.h b/include/records/RecHttp.h
@@ -27,7 +27,7 @@
 #include "swoc/swoc_ip.h"
 
 #include "tscore/ink_inet.h"
-#include "tscpp/util/ts_ip.h"
+#include "tsutil/ts_ip.h"
 #include "tscore/ink_resolver.h"
 #include "ts/apidefs.h"
 #include "ts/apidefs.h"

diff --git a/include/records/RecYAMLDefs.h b/include/records/RecYAMLDefs.h
@@ -27,7 +27,7 @@
 #include <yaml-cpp/yaml.h>
 
 #include <swoc/BufferWriter.h>
-#include "api/ts_errata.h"
+#include "tsutil/ts_errata.h"
 
 struct CfgNode;
 

diff --git a/include/shared/rpc/RPCRequests.h b/include/shared/rpc/RPCRequests.h
@@ -21,7 +21,7 @@
 
 #include <string>
 #include <variant>
-#include "api/ts_bw_format.h"
+#include "tsutil/ts_bw_format.h"
 #include <yaml-cpp/yaml.h>
 #include <tscore/ink_uuid.h>
 

diff --git a/include/ts/ts.h b/include/ts/ts.h
@@ -35,9 +35,9 @@
 
 #include <type_traits>
 
-#include <api/DbgCtl.h>
-#include <ts/apidefs.h>
-#include <ts/parentselectdefs.h>
+#include "tsutil/DbgCtl.h"
+#include "ts/apidefs.h"
+#include "ts/parentselectdefs.h"
 
 class DiagsConfigState;
 

diff --git a/include/tscore/CryptoHash.h b/include/tscore/CryptoHash.h
@@ -22,7 +22,7 @@
 
 #pragma once
 
-#include "api/ts_bw_format.h"
+#include "tsutil/ts_bw_format.h"
 #include "tscore/ink_memory.h"
 #include <openssl/evp.h>
 #include <string_view>

diff --git a/include/tscore/Diags.h b/include/tscore/Diags.h
@@ -33,8 +33,8 @@
 
 #pragma once
 
-#include <api/DbgCtl.h>
-#include "api/SourceLocation.h"
+#include "tsutil/DbgCtl.h"
+#include "tsutil/SourceLocation.h"
 #include "tscore/DiagsTypes.h"
 #include "tscore/LogMessage.h"
 

diff --git a/include/tscore/DiagsTypes.h b/include/tscore/DiagsTypes.h
@@ -34,17 +34,15 @@
 #include <cstdarg>
 #include <string>
 #include <string_view>
-#include "api/DbgCtl.h"
+#include "tsutil/DbgCtl.h"
+#include "tsutil/SourceLocation.h"
+#include "tsutil/ts_diag_levels.h"
 #include "tscore/BaseLogFile.h"
 #include "tscore/ContFlags.h"
 #include "tscore/ink_apidefs.h"
 #include "tscore/ink_inet.h"
 #include "tscore/ink_mutex.h"
-#include "tscpp/util/Regex.h"
-#include "api/SourceLocation.h"
-
-#include "api/ts_diag_levels.h"
-#include "api/DbgCtl.h"
+#include "tsutil/Regex.h"
 
 #define DIAGS_MAGIC 0x12345678
 #define BYTES_IN_MB 1000000

diff --git a/include/tscore/History.h b/include/tscore/History.h
@@ -23,7 +23,7 @@
 
 #pragma once
 
-#include "api/SourceLocation.h"
+#include "tsutil/SourceLocation.h"
 #include "tscore/ink_memory.h"
 
 #define NO_REENTRANT         99999

diff --git a/include/tscore/LogMessage.h b/include/tscore/LogMessage.h
@@ -24,7 +24,7 @@
 #pragma once
 
 #include "tscore/DiagsTypes.h"
-#include "api/SourceLocation.h"
+#include "tsutil/SourceLocation.h"
 #include "tscore/Throttler.h"
 
 #include <atomic>

diff --git a/include/tscore/Regression.h b/include/tscore/Regression.h
@@ -24,7 +24,7 @@
 #pragma once
 
 #include "tscore/ink_platform.h"
-#include "tscpp/util/Regex.h"
+#include "tsutil/Regex.h"
 #include "tscore/Diags.h"
 
 //   Each module should provide one or more regression tests

diff --git a/include/api/Assert.h → include/tsutil/Assert.h b/include/api/Assert.h → include/tsutil/Assert.h
@@ -23,8 +23,8 @@
 
 #pragma once
 
-#include "api/SourceLocation.h"
-#include "swoc/bwf_fwd.h"
+#include "tsutil/SourceLocation.h"
+#include "tsutil/ts_bw_format.h"
 namespace ts
 {
 
@@ -54,3 +54,6 @@ void do_abort(const SourceLocation &loc, const char *expr, const char *message =
   if (!(EX)) {                                      \
     ts::do_abort(MakeSourceLocation(), #EX, (MSG)); \
   }
+
+#define fatal_error(format, ...) \
+  ts::do_abort(MakeSourceLocation(), "FATAL", swoc::bwprint(ts::bw_dbg, format, __VA_ARGS__).c_str());
diff --git a/include/tscpp/util/Bravo.h → include/tsutil/Bravo.h b/include/tscpp/util/Bravo.h → include/tsutil/Bravo.h
@@ -37,10 +37,8 @@
 
 #pragma once
 
-#include "tscpp/util/DenseThreadId.h"
-
-#include "tscore/Diags.h"
-#include "tscore/ink_assert.h"
+#include "tsutil/DenseThreadId.h"
+#include "tsutil/Assert.h"
 
 #include <array>
 #include <atomic>

diff --git a/include/tscpp/util/Convert.h → include/tsutil/Convert.h b/include/tscpp/util/Convert.h → include/tsutil/Convert.h
diff --git a/include/api/DbgCtl.h → include/tsutil/DbgCtl.h b/include/api/DbgCtl.h → include/tsutil/DbgCtl.h
@@ -23,8 +23,8 @@
 
 #pragma once
 
-#include "api/SourceLocation.h"
-#include "api/ts_diag_levels.h"
+#include "tsutil/SourceLocation.h"
+#include "tsutil/ts_diag_levels.h"
 #include "swoc/BufferWriter.h"
 #include <atomic>
 #include <utility>