apache · bneradt · Sep 12, 2023 · Sep 5, 2023 · Sep 5, 2023 · Sep 5, 2023
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -404,7 +404,6 @@ configure_file(include/ts/apidefs.h.in include/ts/apidefs.h)
 
 enable_testing()
 
-add_subdirectory(src/api)
 add_subdirectory(src/tscpp/util)
 add_subdirectory(src/tscpp/api)
 add_subdirectory(src/tscore)
@@ -413,6 +412,7 @@ add_subdirectory(iocore)
 add_subdirectory(proxy)
 add_subdirectory(mgmt/config)
 add_subdirectory(mgmt/rpc)
+add_subdirectory(src/api)
 add_subdirectory(src/traffic_crashlog)
 add_subdirectory(src/traffic_server)
 add_subdirectory(src/traffic_ctl)

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 traffic_server)
+  target_link_libraries(${name} PRIVATE ts::tsapi)
   set_target_properties(${name} PROPERTIES PREFIX "")
   set_target_properties(${name} PROPERTIES SUFFIX ".so")
   install(TARGETS ${name} DESTINATION libexec/trafficserver)

diff --git a/configure.ac b/configure.ac
@@ -771,6 +771,7 @@ esac
 
 TS_ADDTO(AM_CPPFLAGS, [-D$host_os_def])
 AM_CONDITIONAL([OS_LINUX], [test "x$host_os_def" = "xlinux"])
+AM_CONDITIONAL([OS_NON_MACOS], [test "x$host_os_def" != "xdarwin"])
 
 dnl AM_PROG_AR is not always available, but it doesn't seem to be needed in older versions.
 ifdef([AM_PROG_AR],

diff --git a/doc/developer-guide/introduction/header-file-structure.en.rst b/doc/developer-guide/introduction/header-file-structure.en.rst
@@ -18,8 +18,7 @@
 Header Files
 ************
 
-There are four header directories, each containing header files for different purposes. Three of these
-are available to plugins.
+The header files are located in the ``include/`` directory. There are several sub-directories, each containing header files for different purposes. Three of these are available to plugins.
 
 "ts"
    The C Plugin API. These call functions directly embedded in ``traffic_server`` and therefore have
@@ -43,6 +42,24 @@ are available to plugins.
    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.
+
+Note that ``tsapi.so`` depends on ``tsapicore.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
+Traffic Server binary (|TS|), ensuring all symbols required by ``tsapi.so`` will
+be available in |TS|. The actual binding of these dependent symbols occurs
+dynamically at runtime when |TS| is launched.
+
 Historical
 ==========
 

diff --git a/src/traffic_server/FetchSM.h → include/api/FetchSM.h b/src/traffic_server/FetchSM.h → include/api/FetchSM.h
diff --git a/proxy/InkAPIInternal.h → include/api/InkAPIInternal.h b/proxy/InkAPIInternal.h → include/api/InkAPIInternal.h
diff --git a/iocore/aio/Makefile.am b/iocore/aio/Makefile.am
@@ -58,7 +58,7 @@ test_AIO_LDADD = \
 	$(top_builddir)/src/records/librecords_p.a \
 	$(top_builddir)/iocore/eventsystem/libinkevent.a \
 	$(top_builddir)/src/tscore/libtscore.a \
-	$(top_builddir)/src/api/libtsapi.la \
+	$(top_builddir)/src/api/libtsapicore.a \
 	$(top_builddir)/src/tscpp/util/libtscpputil.la \
 	@SWOC_LIBS@ @HWLOC_LIBS@ @YAMLCPP_LIBS@ @LIBPCRE@ @LIBCAP@
 

diff --git a/iocore/aio/test_AIO.cc b/iocore/aio/test_AIO.cc
@@ -22,7 +22,7 @@
  */
 
 #include "P_AIO.h"
-#include "InkAPIInternal.h"
+#include "api/InkAPIInternal.h"
 #include "tscore/ink_hw.h"
 #include "tscore/I_Layout.h"
 #include "tscore/TSSystemState.h"

diff --git a/iocore/cache/Cache.cc b/iocore/cache/Cache.cc
@@ -33,7 +33,7 @@
 #include "HttpTransactCache.h"
 #include "HttpSM.h"
 #include "HttpCacheSM.h"
-#include "InkAPIInternal.h"
+#include "api/InkAPIInternal.h"
 
 #include "tscore/hugepages.h"
 

diff --git a/iocore/cache/Makefile.am b/iocore/cache/Makefile.am
@@ -99,7 +99,7 @@ test_LDADD = \
 	$(top_builddir)/iocore/utils/libinkutils.a \
 	$(top_builddir)/iocore/aio/libinkaio.a \
 	$(top_builddir)/src/records/librecords_p.a \
-	$(top_builddir)/src/api/libtsapi.la \
+	$(top_builddir)/src/api/libtsapicore.a \
 	$(top_builddir)/src/tscore/libtscore.a \
 	$(top_builddir)/lib/fastlz/libfastlz.a \
 	$(top_builddir)/iocore/eventsystem/libinkevent.a \

diff --git a/iocore/cache/test/stub.cc b/iocore/cache/test/stub.cc
@@ -38,7 +38,7 @@ initialize_thread_for_http_sessions(EThread *, int)
   ink_assert(false);
 }
 
-#include "InkAPIInternal.h"
+#include "api/InkAPIInternal.h"
 void
 APIHooks::append(INKContInternal *cont)
 {
@@ -105,8 +105,6 @@ SslAPIHooks *ssl_hooks                 = nullptr;
 LifecycleAPIHooks *lifecycle_hooks     = nullptr;
 ConfigUpdateCbTable *global_config_cbs = nullptr;
 
-HttpBodyFactory *body_factory = nullptr;
-
 void
 HostStatus::setHostStatus(const std::string_view name, const TSHostStatus status, const unsigned int down_time,
                           const unsigned int reason)
@@ -215,7 +213,7 @@ INKVConnInternal::INKVConnInternal() : INKContInternal() {}
 
 INKVConnInternal::INKVConnInternal(TSEventFunc funcp, TSMutex mutexp) : INKContInternal(funcp, mutexp) {}
 
-#include "../src/traffic_server/FetchSM.h"
+#include "api/FetchSM.h"
 ClassAllocator<FetchSM> FetchSMAllocator("unusedFetchSMAllocator");
 void
 FetchSM::ext_launch()

diff --git a/iocore/eventsystem/Makefile.am b/iocore/eventsystem/Makefile.am
@@ -97,7 +97,7 @@ test_LD_ADD = \
 	$(top_builddir)/src/records/librecords_p.a \
 	$(top_builddir)/iocore/eventsystem/libinkevent.a \
 	$(top_builddir)/src/tscore/libtscore.a \
-	$(top_builddir)/src/api/libtsapi.la \
+	$(top_builddir)/src/api/libtsapicore.a \
 	$(top_builddir)/src/tscpp/util/libtscpputil.la \
 	@HWLOC_LIBS@ @SWOC_LIBS@ @YAMLCPP_LIBS@ @LIBPCRE@ @LIBCAP@
 

diff --git a/iocore/hostdb/Makefile.am b/iocore/hostdb/Makefile.am
@@ -67,7 +67,7 @@ test_LD_ADD = \
 	$(top_builddir)/src/records/librecords_p.a \
 	$(top_builddir)/iocore/eventsystem/libinkevent.a \
 	$(top_builddir)/src/tscore/libtscore.a \
-	$(top_builddir)/src/api/libtsapi.la \
+	$(top_builddir)/src/api/libtsapicore.a \
 	$(top_builddir)/src/tscpp/util/libtscpputil.la \
 	@SWOC_LIBS@ @HWLOC_LIBS@ @YAMLCPP_LIBS@ @OPENSSL_LIBS@ @LIBPCRE@ @LIBCAP@
 

diff --git a/iocore/net/CMakeLists.txt b/iocore/net/CMakeLists.txt
@@ -114,7 +114,7 @@ target_include_directories(inknet PUBLIC
         ${CMAKE_SOURCE_DIR}/proxy/shared
         ${CMAKE_SOURCE_DIR}/proxy/http
         ${CMAKE_SOURCE_DIR}/proxy/http/remap
-        ${CMAKE_SOURCE_DIR}/src/traffic_server
+        ${CMAKE_SOURCE_DIR}/src/api
 )
 
 target_link_libraries(inknet

diff --git a/iocore/net/Makefile.am b/iocore/net/Makefile.am
@@ -29,7 +29,6 @@ AM_CPPFLAGS += \
 	-I$(abs_top_srcdir)/proxy/shared \
 	-I$(abs_top_srcdir)/proxy/http \
 	-I$(abs_top_srcdir)/proxy/http/remap \
-	-I$(abs_top_srcdir)/src/traffic_server \
 	$(TS_INCLUDES) \
 	@OPENSSL_INCLUDES@ \
 	@YAMLCPP_INCLUDES@ \
@@ -88,7 +87,7 @@ test_UDPNet_LDADD = \
 	$(top_builddir)/proxy/hdrs/libhdrs.a \
 	$(top_builddir)/src/tscore/libtscore.a \
 	$(top_builddir)/src/tscpp/util/libtscpputil.la \
-	$(top_builddir)/src/api/libtsapi.la \
+	$(top_builddir)/src/api/libtsapicore.a \
 	$(top_builddir)/proxy/ParentSelectionStrategy.o \
 	@HWLOC_LIBS@ @OPENSSL_LIBS@ @LIBPCRE@ @YAMLCPP_LIBS@ @SWOC_LIBS@ @LIBPCRE@ @LIBCAP@
 if ENABLE_QUIC
@@ -129,7 +128,7 @@ test_libinknet_LDADD = \
 	$(top_builddir)/src/records/librecords_p.a \
 	$(top_builddir)/proxy/hdrs/libhdrs.a \
 	$(top_builddir)/src/tscore/libtscore.a \
-	$(top_builddir)/src/api/libtsapi.la \
+	$(top_builddir)/src/api/libtsapicore.a \
 	$(top_builddir)/src/tscpp/util/libtscpputil.la \
 	$(top_builddir)/proxy/ParentSelectionStrategy.o \
 	@HWLOC_LIBS@ @OPENSSL_LIBS@ @LIBPCRE@ @YAMLCPP_LIBS@ @SWOC_LIBS@ @LIBCAP@

diff --git a/iocore/net/OCSPStapling.cc b/iocore/net/OCSPStapling.cc
@@ -34,7 +34,7 @@
 #include "P_SSLConfig.h"
 #include "P_SSLUtils.h"
 #include "SSLStats.h"
-#include "FetchSM.h"
+#include "api/FetchSM.h"
 
 // Macros for ASN1 and the code in TS_OCSP_* functions were borrowed from OpenSSL 3.1.0 (a92271e03a8d0dee507b6f1e7f49512568b2c7ad),
 // and were modified to make them compilable with BoringSSL and C++ compiler.

diff --git a/iocore/net/QUICNetVConnection.cc b/iocore/net/QUICNetVConnection.cc
@@ -30,7 +30,7 @@
 #include "P_QUICNetVConnection.h"
 #include "P_QUICPacketHandler.h"
 #include "P_Net.h"
-#include "InkAPIInternal.h" // Added to include the quic_hook definitions
+#include "api/InkAPIInternal.h" // Added to include the quic_hook definitions
 
 #include "P_SSLNextProtocolSet.h"
 #include "QUICMultiCertConfigLoader.h"

diff --git a/iocore/net/SSLConfig.cc b/iocore/net/SSLConfig.cc
@@ -37,7 +37,7 @@
 #include "tscore/ink_config.h"
 #include <openssl/pem.h>
 
-#include "InkAPIInternal.h" // Added to include the ssl_hook and lifestyle_hook definitions
+#include "api/InkAPIInternal.h" // Added to include the ssl_hook and lifestyle_hook definitions
 
 #include "tscore/ink_platform.h"
 #include "tscore/I_Layout.h"

diff --git a/iocore/net/SSLNetVConnection.cc b/iocore/net/SSLNetVConnection.cc
@@ -26,7 +26,7 @@
 #include "tscore/I_Layout.h"
 #include "tscore/TSSystemState.h"
 
-#include "InkAPIInternal.h" // Added to include the ssl_hook definitions
+#include "api/InkAPIInternal.h" // Added to include the ssl_hook definitions
 #include "HttpTunnel.h"
 #include "ProxyProtocol.h"
 #include "HttpConfig.h"

diff --git a/iocore/net/SSLSecret.cc b/iocore/net/SSLSecret.cc
@@ -21,7 +21,7 @@
 
 #include "swoc/swoc_file.h"
 
-#include "InkAPIInternal.h" // Added to include the ssl_hook and lifestyle_hook definitions
+#include "api/InkAPIInternal.h" // Added to include the ssl_hook and lifestyle_hook definitions
 #include "P_SSLConfig.h"
 
 #include <utility>

diff --git a/iocore/net/SSLUtils.cc b/iocore/net/SSLUtils.cc
@@ -35,7 +35,7 @@
 #include "records/I_RecHttp.h"
 
 #include "P_Net.h"
-#include "InkAPIInternal.h"
+#include "api/InkAPIInternal.h"
 
 #include "P_OCSPStapling.h"
 #include "P_SSLConfig.h"

diff --git a/iocore/net/TLSSessionResumptionSupport.cc b/iocore/net/TLSSessionResumptionSupport.cc
@@ -33,7 +33,7 @@
 #ifdef HAVE_SSL_CTX_SET_TLSEXT_TICKET_KEY_EVP_CB
 #include <openssl/core_names.h>
 #endif
-#include "InkAPIInternal.h"
+#include "api/InkAPIInternal.h"
 #include "tscore/ink_config.h"
 
 // Remove this when drop OpenSSL 1.0.2 support

diff --git a/iocore/net/libinknet_stub.cc b/iocore/net/libinknet_stub.cc
@@ -71,7 +71,7 @@ ParentConfigParams::nextParent(HttpRequestData *, ParentResult *, unsigned int,
   ink_assert(false);
 }
 
-#include "InkAPIInternal.h"
+#include "api/InkAPIInternal.h"
 int
 APIHook::invoke(int, void *) const
 {
@@ -156,7 +156,7 @@ PreWarmManager::reconfigure()
 
 PreWarmManager prewarmManager;
 
-#include "../src/traffic_server/FetchSM.h"
+#include "api/FetchSM.h"
 ClassAllocator<FetchSM> FetchSMAllocator("unusedFetchSMAllocator");
 void
 FetchSM::ext_launch()

diff --git a/mgmt/config/FileManager.cc b/mgmt/config/FileManager.cc
@@ -25,7 +25,7 @@
 #include <vector>
 #include <algorithm>
 
-#include "InkAPIInternal.h" // TODO: this brings a lot of dependencies, double check this.
+#include "api/InkAPIInternal.h" // TODO: this brings a lot of dependencies, double check this.
 
 #include "tscore/ink_platform.h"
 #include "tscore/ink_file.h"

diff --git a/mgmt/rpc/Makefile.am b/mgmt/rpc/Makefile.am
@@ -106,7 +106,7 @@ test_jsonrpcserver_LDADD = \
 	$(top_builddir)/src/tscore/libtscore.a \
 	$(top_builddir)/iocore/eventsystem/libinkevent.a \
 	$(top_builddir)/src/records/librecords_p.a \
-	$(top_builddir)/src/api/libtsapi.la \
+	$(top_builddir)/src/api/libtsapicore.a \
 	$(top_builddir)/src/tscpp/util/libtscpputil.la \
 	$(top_builddir)/src/tscore/libtscore.a \
 	@YAMLCPP_LIBS@ @HWLOC_LIBS@  @SWOC_LIBS@ @YAMLCPP_LIBS@ @LIBPCRE@ @LIBCAP@

diff --git a/mgmt/rpc/handlers/plugins/Plugins.cc b/mgmt/rpc/handlers/plugins/Plugins.cc
@@ -21,7 +21,7 @@
 #include "Plugins.h"
 #include "rpc/handlers/common/ErrorUtils.h"
 
-#include "InkAPIInternal.h"
+#include "api/InkAPIInternal.h"
 
 namespace
 {

diff --git a/proxy/CMakeLists.txt b/proxy/CMakeLists.txt
@@ -21,6 +21,7 @@ add_library(proxy STATIC
         CacheControl.cc
         ControlBase.cc
         ControlMatcher.cc
+	    HostStatus.cc
         IPAllow.cc
         ParentConsistentHash.cc
         ParentRoundRobin.cc
@@ -55,6 +56,7 @@ set(PROXY_INCLUDE_DIRS ${PROXY_INCLUDE_DIRS} PARENT_SCOPE)
 target_include_directories(proxy PUBLIC
         ${IOCORE_INCLUDE_DIRS}
         ${PROXY_INCLUDE_DIRS}
+        ${CMAKE_SOURCE_DIR}/mgmt
         ${CMAKE_SOURCE_DIR}/lib/yamlcpp/include
         )
 

diff --git a/src/traffic_server/HostStatus.cc → proxy/HostStatus.cc b/src/traffic_server/HostStatus.cc → proxy/HostStatus.cc
diff --git a/proxy/Makefile.am b/proxy/Makefile.am
@@ -31,6 +31,7 @@ AM_CPPFLAGS += \
 	$(iocore_include_dirs) \
 	-I$(abs_top_srcdir)/include \
 	-I$(abs_top_srcdir)/lib \
+	-I$(abs_top_srcdir)/mgmt \
 	-I$(abs_srcdir)/http \
 	-I$(abs_srcdir)/http2 \
 	-I$(abs_srcdir)/http3 \
@@ -52,6 +53,8 @@ libproxy_a_SOURCES = \
 	ControlBase.h \
 	ControlMatcher.cc \
 	ControlMatcher.h \
+	HostStatus.cc \
+	HostStatus.h \
 	IPAllow.cc \
 	IPAllow.h \
 	ParentConsistentHash.cc \

diff --git a/proxy/Plugin.cc b/proxy/Plugin.cc
@@ -27,7 +27,7 @@
 #include "tscore/ParseRules.h"
 #include "records/I_RecCore.h"
 #include "tscore/I_Layout.h"
-#include "InkAPIInternal.h"
+#include "api/InkAPIInternal.h"
 #include "Plugin.h"
 #include "tscore/ink_cap.h"
 #include "tscore/Filenames.h"

diff --git a/proxy/ProxySession.h b/proxy/ProxySession.h
@@ -28,7 +28,7 @@
 #include "tscore/TSSystemState.h"
 #include <string_view>
 #include <memory>
-#include "InkAPIInternal.h"
+#include "api/InkAPIInternal.h"
 #include "http/HttpSessionAccept.h"
 #include "IPAllow.h"
 #include "private/SSLProxySession.h"

diff --git a/proxy/Transform.h b/proxy/Transform.h
@@ -25,7 +25,7 @@
 
 #include "I_EventSystem.h"
 #include "HTTP.h"
-#include "InkAPIInternal.h"
+#include "api/InkAPIInternal.h"
 
 #define TRANSFORM_READ_READY (TRANSFORM_EVENTS_START + 0)
 

diff --git a/proxy/hdrs/Makefile.am b/proxy/hdrs/Makefile.am
@@ -92,7 +92,7 @@ test_proxy_hdrs_LDADD = \
 	$(top_builddir)/src/records/librecords_p.a \
 	$(top_builddir)/src/tscore/libtscore.a \
 	$(top_builddir)/src/tscpp/util/libtscpputil.la \
-	$(top_builddir)/src/api/libtsapi.la \
+	$(top_builddir)/src/api/libtsapicore.a \
 	@SWOC_LIBS@ @YAMLCPP_LIBS@ @HWLOC_LIBS@ @LIBPCRE@ @OPENSSL_LIBS@ @LIBCAP@
 
 test_hdr_heap_CPPFLAGS = $(AM_CPPFLAGS) \
@@ -108,7 +108,7 @@ test_hdr_heap_LDADD = \
 	$(top_builddir)/src/records/librecords_p.a \
 	$(top_builddir)/src/tscore/libtscore.a \
 	$(top_builddir)/src/tscpp/util/libtscpputil.la \
-	$(top_builddir)/src/api/libtsapi.la \
+	$(top_builddir)/src/api/libtsapicore.a \
 	@SWOC_LIBS@ @HWLOC_LIBS@ \
 	@LIBPCRE@ @OPENSSL_LIBS@ @LIBCAP@
 

diff --git a/proxy/http/Http1ClientSession.h b/proxy/http/Http1ClientSession.h
@@ -31,7 +31,7 @@
 
 #pragma once
 
-#include "InkAPIInternal.h"
+#include "api/InkAPIInternal.h"
 #include "HTTP.h"
 #include "HttpConfig.h"
 #include "IPAllow.h"

diff --git a/proxy/http/HttpSM.cc b/proxy/http/HttpSM.cc
@@ -86,7 +86,7 @@
 
 extern int cache_config_read_while_writer;
 
-extern HttpBodyFactory *body_factory;
+HttpBodyFactory *body_factory = nullptr;
 
 // We have a debugging list that can use to find stuck
 //  state machines

diff --git a/proxy/http/HttpSM.h b/proxy/http/HttpSM.h
@@ -43,7 +43,7 @@
 #include "HttpVCTable.h"
 #include "UrlRewrite.h"
 #include "HttpTunnel.h"
-#include "InkAPIInternal.h"
+#include "api/InkAPIInternal.h"
 #include "../ProxyTransaction.h"
 #include "HdrUtils.h"
 #include "tscore/History.h"