diff --git a/.asf.yaml b/.asf.yaml index 823d187874e..d6fa4d21130 100644 --- a/.asf.yaml +++ b/.asf.yaml @@ -33,7 +33,7 @@ github: strict: false contexts: - AuTest - - CentOS + - Rocky - Clang-Analyzer - Clang-Format - Debian diff --git a/build/hiredis.m4 b/build/hiredis.m4 index 1a9a18c0273..b2f09179be0 100644 --- a/build/hiredis.m4 +++ b/build/hiredis.m4 @@ -34,7 +34,7 @@ AC_ARG_WITH(hiredis, [AS_HELP_STRING([--with-hiredis=DIR],[use a specific hiredi case "$hiredis_base_dir" in *":"*) - hidredis_include="`echo $hiredis_base_dir |sed -e 's/:.*$//'`" + hiredis_include="`echo $hiredis_base_dir |sed -e 's/:.*$//'`" hiredis_ldflags="`echo $hiredis_base_dir |sed -e 's/^.*://'`" AC_MSG_CHECKING(for hiredis includes in $hiredis_include libs in $hiredis_ldflags ) ;; diff --git a/build/libswoc.m4 b/build/libswoc.m4 new file mode 100644 index 00000000000..e4e03b9faf6 --- /dev/null +++ b/build/libswoc.m4 @@ -0,0 +1,97 @@ +dnl -------------------------------------------------------- -*- autoconf -*- +dnl Licensed to the Apache Software Foundation (ASF) under one or more +dnl contributor license agreements. See the NOTICE file distributed with +dnl this work for additional information regarding copyright ownership. +dnl The ASF licenses this file to You under the Apache License, Version 2.0 +dnl (the "License"); you may not use this file except in compliance with +dnl the License. You may obtain a copy of the License at +dnl +dnl http://www.apache.org/licenses/LICENSE-2.0 +dnl +dnl Unless required by applicable law or agreed to in writing, software +dnl distributed under the License is distributed on an "AS IS" BASIS, +dnl WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +dnl See the License for the specific language governing permissions and +dnl limitations under the License. + +dnl +dnl libswoc.m4: Trafficserver's libswoc autoconf macros +dnl + +dnl +dnl TS_CHECK_LIBSWOC: look for libswoc libraries and headers +dnl +AC_DEFUN([TS_CHECK_LIBSWOC], [ +has_libswoc=no +AC_ARG_WITH(libswoc, [AS_HELP_STRING([--with-libswoc=DIR],[use a specific libswoc library])], +[ + if test "x$withval" != "xyes" && test "x$withval" != "x"; then + libswoc_base_dir="$withval" + if test "$withval" != "no"; then + has_libswoc=yes + case "$withval" in + *":"*) + swoc_include="`echo $withval |sed -e 's/:.*$//'`" + swoc_ldflags="`echo $withval |sed -e 's/^.*://'`" + AC_MSG_CHECKING(checking for libswoc includes in $swoc_include libs in $swoc_ldflags ) + ;; + *) + swoc_include="$withval/include" + swoc_ldflags="$withval/lib" + libswoc_base_dir="$withval" + AC_MSG_CHECKING(libswoc includes in $withval libs in $swoc_ldflags) + ;; + esac + fi + fi + + if test -d $swoc_include && test -d $swoc_ldflags && test -f $swoc_include/libswoc/yaml.h; then + AC_MSG_RESULT([ok]) + else + AC_MSG_RESULT([not found]) + fi + +if test "$has_libswoc" != "no"; then + saved_ldflags=$LDFLAGS + saved_cppflags=$CPPFLAGS + + SWOC_LIBS=-lswoc + if test "$libswoc_base_dir" != "/usr"; then + SWOC_INCLUDES=-I${swoc_include} + SWOC_LDFLAGS=-L${swoc_ldflags} + + TS_ADDTO_RPATH(${swoc_ldflags}) + fi + + if test "$swoc_include" != "0"; then + SWOC_INCLUDES=-I${swoc_include} + else + has_libswoc=no + CPPFLAGS=$saved_cppflags + LDFLAGS=$saved_ldflags + fi +fi +], +[ + has_libswoc=no + SWOC_INCLUDES=-I\${abs_top_srcdir}/lib/swoc/include + SWOC_LIBS=-lswoc + SWOC_LDFLAGS=-L\${abs_top_builddir}/lib/swoc +]) + +AC_SUBST([SWOC_INCLUDES]) +AC_SUBST([SWOC_LIBS]) +AC_SUBST([SWOC_LDFLAGS]) + +]) + +dnl TS_CHECK_SWOC: check if we want to export libswoc headers from trafficserver. default: not exported +AC_DEFUN([TS_CHECK_SWOC_HEADERS_EXPORT], [ +AC_MSG_CHECKING([whether to export libswoc headers]) +AC_ARG_ENABLE([swoc-headers], + [AS_HELP_STRING([--enable-swoc-headers],[Export libswoc headers])], + [], + [enable_swoc_headers=no] +) +AC_MSG_RESULT([$enable_swoc_headers]) +]) diff --git a/build/nuraft.m4 b/build/nuraft.m4 new file mode 100644 index 00000000000..dca9e96a9bb --- /dev/null +++ b/build/nuraft.m4 @@ -0,0 +1,85 @@ +dnl -------------------------------------------------------- -*- autoconf -*- +dnl Licensed to the Apache Software Foundation (ASF) under one or more +dnl contributor license agreements. See the NOTICE file distributed with +dnl this work for additional information regarding copyright ownership. +dnl The ASF licenses this file to You under the Apache License, Version 2.0 +dnl (the "License"); you may not use this file except in compliance with +dnl the License. You may obtain a copy of the License at +dnl +dnl http://www.apache.org/licenses/LICENSE-2.0 +dnl +dnl Unless required by applicable law or agreed to in writing, software +dnl distributed under the License is distributed on an "AS IS" BASIS, +dnl WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +dnl See the License for the specific language governing permissions and +dnl limitations under the License. + +dnl +dnl nuraft.m4: Trafficserver's nuraft autoconf macros +dnl + +dnl +dnl TS_CHECK_NURAFT: look for nuraft libraries and headers +dnl + +AC_DEFUN([TS_CHECK_NURAFT], [ +has_nuraft=no +AC_ARG_WITH(nuraft, [AC_HELP_STRING([--with-nuraft=DIR], [use a specific nuraft library])], +[ + if test "x$withval" != "xyes" && test "x$withval" != "x"; then + nuraft_base_dir="$withval" + if test "$withval" != "no"; then + has_nuraft=yes + case "$withval" in + *":"*) + nuraft_include="`echo $withval | sed -e 's/:.*$//'`" + nuraft_ldflags="`echo $withval | sed -e 's/^.*://'`" + AC_MSG_CHECKING(for nuraft includes in $nuraft_include libs in $nuraft_ldflags) + ;; + *) + nuraft_include="$withval/include" + nuraft_ldflags="$withval/lib" + nuraft_base_dir="$withval" + AC_MSG_CHECKING(for nuraft includes in $nuraft_include libs in $nuraft_ldflags) + ;; + esac + fi + fi + + if test -d $nuraft_include && test -d $nuraft_ldflags && test -f $nuraft_include/libnuraft/nuraft.hxx; then + AC_MSG_RESULT([ok]) + else + AC_MSG_RESULT([not found]) + fi + +if test "$has_nuraft" != "no"; then + saved_ldflags=$LDFLAGS + saved_cppflags=$CPPFLAGS + + NURAFT_LIBS=-lnuraft + if test "$nuraft_base_dir" != "/usr"; then + NURAFT_INCLUDES=-I${nuraft_include} + NURAFT_LDFLAGS=-L${nuraft_ldflags} + + TS_ADDTO(CPPFLAGS, [${NURAFT_INCLUDES}]) + TS_ADDTO(LDFLAGS, [${NURAFT_LDFLAGS}]) + TS_ADDTO_RPATH(${nuraft_ldflags}) + fi + + if test "$nuraft_include" != "0"; then + NURAFT_INCLUDES=-I${nuraft_include} + else + has_nuraft=no + CPPFLAGS=$saved_cppflags + LDFLAGS=$saved_ldflags + fi +fi +], +[ + has_nuraft=no +]) + +AC_SUBST([NURAFT_INCLUDES]) +AC_SUBST([NURAFT_LIBS]) +AC_SUBST([NURAFT_LDFLAGS]) +]) diff --git a/configs/body_factory/default/Makefile.am b/configs/body_factory/default/Makefile.am index a24d2e290dc..69eb6b6810f 100644 --- a/configs/body_factory/default/Makefile.am +++ b/configs/body_factory/default/Makefile.am @@ -28,6 +28,7 @@ dist_bodyfactory_DATA = \ connect\#dns_failed \ connect\#failed_connect \ connect\#hangup \ + connect\#all_dead \ default \ interception\#no_host \ README \ diff --git a/configs/body_factory/default/connect#all_dead b/configs/body_factory/default/connect#all_dead new file mode 100644 index 00000000000..7e18a62986f --- /dev/null +++ b/configs/body_factory/default/connect#all_dead @@ -0,0 +1,17 @@ + + +No Valid Host + + + +

No Valid Host

+
+ + +Description: Unable to find a valid target host. + +The server was found but all of the addresses are marked dead and so there is +no valid target address to which to connect. Please try again after a few minutes. + +
+ diff --git a/configure.ac b/configure.ac index 456aa83d52d..1745358ed5b 100644 --- a/configure.ac +++ b/configure.ac @@ -175,6 +175,13 @@ AC_ARG_ENABLE([all-asserts], ) AC_MSG_RESULT([$enable_all_asserts]) +AC_MSG_CHECKING([whether to enable event tracker]) +AC_ARG_ENABLE([event-tracker], + [AS_HELP_STRING([--enable-event-tracker],[turn on event tracker])], + [], + [enable_event_tracker=no] +) +AC_MSG_RESULT([$enable_event_tracker]) # Enable code coverage instrumentation only if requested by the user. AC_MSG_CHECKING([whether to code coverage]) @@ -856,7 +863,7 @@ case $host_os_def in common_opt="-pipe -Wall -Wextra -Wno-ignored-qualifiers -Wno-unused-parameter -Wno-format-truncation -Wno-cast-function-type -Wno-stringop-overflow" debug_opt="-ggdb3 $common_opt" release_opt="-g $common_opt $optimizing_flags -feliminate-unused-debug-symbols -fno-strict-aliasing" - cxx_opt="-Wno-invalid-offsetof -Wno-noexcept-type" + cxx_opt="-Wno-invalid-offsetof -Wno-noexcept-type -Wsuggest-override" # Special options for flex generated .c files flex_cflags="-Wno-unused-parameter" ]) @@ -897,7 +904,7 @@ case $host_os_def in common_opt="-pipe -Wall -Wextra -Wno-ignored-qualifiers -Wno-unused-parameter" debug_opt="-ggdb3 $common_opt" release_opt="-g $common_opt $optimizing_flags -feliminate-unused-debug-symbols -fno-strict-aliasing" - cxx_opt="-Wno-invalid-offsetof" + cxx_opt="-Wno-invalid-offsetof -Wsuggest-override" ]) AS_IF([test -d /usr/local/lib], [ @@ -975,10 +982,15 @@ fi if test "x${enable_mime_sanity_check}" = "xyes"; then TS_ADDTO(AM_CPPFLAGS, [-DENABLE_MIME_SANITY_CHECK]) fi + if test "x${enable_all_asserts}" = "xyes"; then TS_ADDTO(AM_CPPFLAGS, [-DENABLE_ALL_ASSERTS]) fi +if test "x${enable_event_tracker}" = "xyes"; then + TS_ADDTO(AM_CPPFLAGS, [-DENABLE_EVENT_TRACKER]) +fi + # Flags for ASAN if test "x${enable_asan}" = "xyes"; then if test "x${enable_tsan}" = "xyes" -o "x${enable_tsan}" = "xstatic"; then @@ -1446,14 +1458,23 @@ AM_CONDITIONAL([BUILD_YAML_CPP], [test x"$has_yaml_cpp" = x"no"]) TS_CHECK_YAML_HEADERS_EXPORT AM_CONDITIONAL([EXPORT_YAML_HEADERS], [test x"$enable_yaml_headers" = x"yes"]) +TS_CHECK_LIBSWOC +AM_CONDITIONAL([BUILD_SWOC], [test x"$has_libswoc" = x"no"]) + +TS_CHECK_SWOC_HEADERS_EXPORT +AM_CONDITIONAL([EXPORT_SWOC_HEADER], [test x"$enable_swoc_headers" = x"yes"]) + # Check for optional boringocsp library TS_CHECK_BORINGOCSP # Check for optional hiredis library TS_CHECK_HIREDIS - AM_CONDITIONAL([BUILD_SSL_SESSION_REUSE_PLUGIN], [test ! -z "${LIB_HIREDIS}" -a "x${has_hiredis}" = "x1" ]) +# Check for optional nuraft library +TS_CHECK_NURAFT +AM_CONDITIONAL([BUILD_STEK_SHARE_PLUGIN], [test x"$has_nuraft" = x"yes"]) + # Check for backtrace() support has_backtrace=0 AC_CHECK_HEADERS([execinfo.h], [has_backtrace=1],[]) @@ -2312,13 +2333,15 @@ AC_MSG_NOTICE([Build option summary: CXXFLAGS: $CXXFLAGS CPPFLAGS: $CPPFLAGS LDFLAGS: $LDFLAGS - AM@&t@_CFLAGS: $AM_CFLAGS - AM@&t@_CXXFLAGS: $AM_CXXFLAGS - AM@&t@_CPPFLAGS: $AM_CPPFLAGS - AM@&t@_LDFLAGS: $AM_LDFLAGS + AM@&t@_CFLAGS: $AM_CFLAGS + AM@&t@_CXXFLAGS: $AM_CXXFLAGS + AM@&t@_CPPFLAGS: $AM_CPPFLAGS + AM@&t@_LDFLAGS: $AM_LDFLAGS TS_INCLUDES: $TS_INCLUDES OPENSSL_LDFLAGS: $OPENSSL_LDFLAGS OPENSSL_INCLUDES: $OPENSSL_INCLUDES YAMLCPP_LDFLAGS: $YAMLCPP_LDFLAGS YAMLCPP_INCLUDES: $YAMLCPP_INCLUDES + NURAFT_LDFLAGS: $NURAFT_LDFLAGS + NURAFT_INCLUDES: $NURAFT_INCLUDES ]) diff --git a/doc/Pipfile b/doc/Pipfile index 42a9f5ad514..d481b2a75bc 100644 --- a/doc/Pipfile +++ b/doc/Pipfile @@ -23,15 +23,17 @@ verify_ssl = true [packages] -# The latest 4.x sphinx release, currently 4.0.2, fails `make html`. For -# details, see: https://github.com/apache/trafficserver/issues/7938 -# -# The 3.x releases build fine, however. So we currently pin to that. +# The latest 4.x sphinx release has issues with style rendering. The 3.x +# releases build and render fine, however. So we currently pin to that. # # Once that issue, either with sphinx or our docs, is resolved, then we should # unpin sphinx by setting the following to "*". sphinx = "==3.*" +# Sphinx 3.x builds break with the latest jinja2. This jinja2 pin can be +# removed when we move to Sphinx 4.x. +jinja2 = "<3.1" + sphinx-rtd-theme = "*" sphinxcontrib-plantuml = "*" # i18n diff --git a/doc/admin-guide/files/parent.config.en.rst b/doc/admin-guide/files/parent.config.en.rst index 50fa96fe737..dcb12a0c77c 100644 --- a/doc/admin-guide/files/parent.config.en.rst +++ b/doc/admin-guide/files/parent.config.en.rst @@ -222,6 +222,7 @@ The following list shows the possible actions and their allowed values. parent is marked down and a new parent is selected to retry the request. The number of retries is controlled by ``max_unavailable_server_retries`` which is set to 1 by default. - ``both`` - This enables both ``simple_retry`` and ``unavailable_server_retry`` as described above. + - If not set, by default all response codes will be considered a success, and parents will not be retried based on any HTTP response code. .. Note:: @@ -270,7 +271,7 @@ The following list shows the possible actions and their allowed values. - ``strict`` - Traffic Server machines serve requests strictly in turn. For example: machine ``proxy1`` serves the first request, ``proxy2`` serves the second request, and so on. - - ``false`` - Round robin selection does not occur. + - ``false`` - The default. Round robin selection does not occur. - ``consistent_hash`` - consistent hash of the url so that one parent is chosen for a given url. If a parent is down, the traffic that would go to the down parent is rehashed amongst the remaining parents. @@ -290,7 +291,7 @@ The following list shows the possible actions and their allowed values. ``go_direct`` One of the following values: - - ``true`` - requests bypass parent hierarchies and go directly to + - ``true`` - The default. Requests bypass parent hierarchies and go directly to the origin server. - ``false`` - requests do not bypass parent hierarchies. @@ -300,7 +301,7 @@ The following list shows the possible actions and their allowed values. ``qstring`` One of the following values: - - ``consider`` - Use the query string when finding a parent. + - ``consider`` - The default. Use the query string when finding a parent. - ``ignore`` - Do not consider the query string when finding a parent. This is especially useful when using the ``consistent_hash`` selection strategy, diff --git a/doc/admin-guide/files/records.config.en.rst b/doc/admin-guide/files/records.config.en.rst index cc0747d3adf..c311690c8c8 100644 --- a/doc/admin-guide/files/records.config.en.rst +++ b/doc/admin-guide/files/records.config.en.rst @@ -2278,10 +2278,11 @@ Cache Control :overridable: When enabled (``1``), |TS| will attempt to write (lock) the URL - to cache. This is rarely useful (at the moment), since it'll only be able - to write to cache if the origin has ignored the ``Range:`` header. For a use - case where you know the origin will respond with a full (``200``) response, - you can turn this on to allow it to be cached. + to cache for a request specifying a range. This is useful when the origin server + might ignore a range request and respond with a full (``200``) response. + Additionally, this setting will attempt to transform a 200 response from the origin + server to a partial (``206``) response, honoring the requested range, while + caching the full response. .. ts:cv:: CONFIG proxy.config.http.cache.ignore_accept_mismatch INT 2 :reloadable: @@ -4064,15 +4065,13 @@ OCSP Stapling Configuration Number of seconds before an OCSP response expires in the stapling cache. - See :ref:`admin-performance-timeouts` for more discussion on |TS| timeouts. - .. ts:cv:: CONFIG proxy.config.ssl.ocsp.request_timeout INT 10 + :units: seconds Timeout (in seconds) for queries to OCSP responders. - See :ref:`admin-performance-timeouts` for more discussion on |TS| timeouts. - .. ts:cv:: CONFIG proxy.config.ssl.ocsp.update_period INT 60 + :units: seconds Update period (in seconds) for stapling caches. @@ -4116,11 +4115,13 @@ HTTP/2 Configuration .. ts:cv:: CONFIG proxy.config.http2.initial_window_size_in INT 65535 :reloadable: + :units: bytes The initial window size for inbound connections. .. ts:cv:: CONFIG proxy.config.http2.max_frame_size INT 16384 :reloadable: + :units: bytes Indicates the size of the largest frame payload that the sender is willing to receive. @@ -4153,6 +4154,7 @@ HTTP/2 Configuration .. ts:cv:: CONFIG proxy.config.http2.active_timeout_in INT 0 :reloadable: + :units: seconds This is the active timeout of the http2 connection. It is set when the connection is opened and keeps ticking regardless of activity level. @@ -4161,6 +4163,7 @@ HTTP/2 Configuration .. ts:cv:: CONFIG proxy.config.http2.accept_no_activity_timeout INT 120 :reloadable: + :units: seconds Specifies how long |TS| keeps connections to clients open if no activity is received on the connection. Lowering this timeout can ease @@ -4169,6 +4172,7 @@ HTTP/2 Configuration .. ts:cv:: CONFIG proxy.config.http2.no_activity_timeout_in INT 120 :reloadable: + :units: seconds Specifies how long |TS| keeps connections to clients open if a transaction stalls. Lowering this timeout can ease pressure on the proxy if @@ -4249,6 +4253,7 @@ HTTP/2 Configuration .. ts:cv:: CONFIG proxy.config.http2.write_buffer_block_size INT 262144 :reloadable: + :units: bytes Specifies the size of a buffer block that is used for buffering outgoing HTTP/2 frames. The size will be rounded up based on power of 2. @@ -4642,7 +4647,7 @@ Sockets Sets the receive buffer size for connections from the client to |TS|. -.. ts:cv:: CONFIG proxy.config.net.sock_option_flag_in INT 0x5 +.. ts:cv:: CONFIG proxy.config.net.sock_option_flag_in INT 0x1 Turns different options "on" for the socket handling client connections::: diff --git a/doc/admin-guide/logging/formatting.en.rst b/doc/admin-guide/logging/formatting.en.rst index 328dfb69f90..20ae0cfb0eb 100644 --- a/doc/admin-guide/logging/formatting.en.rst +++ b/doc/admin-guide/logging/formatting.en.rst @@ -636,6 +636,9 @@ cqssu Client Request SSL Elliptic Curve used by |TS| to communicate with the cqssa Client Request ALPN Protocol ID negotiated with the client. pqssl Proxy Request Indicates whether the connection from |TS| to the origin was over SSL or not. +pqssr Proxy Request SSL session ticket reused status from |TS| to the origin; + indicates if the current request hit the SSL session ticket + and avoided a full SSL handshake. pscert Proxy Request 1 if origin requested certificate from |TS| during TLS handshake but no client certificate was defined. 2 if origin requested certificate from |TS| during TLS handshake and a diff --git a/doc/admin-guide/monitoring/statistics/core/http-connection.en.rst b/doc/admin-guide/monitoring/statistics/core/http-connection.en.rst index 0baa9dba815..e00885c294d 100644 --- a/doc/admin-guide/monitoring/statistics/core/http-connection.en.rst +++ b/doc/admin-guide/monitoring/statistics/core/http-connection.en.rst @@ -149,6 +149,16 @@ HTTP Connection Tracks the number of client requests that did not have a request sent to the origin server because the origin server was marked dead. +.. ts:stat:: global proxy.process.http.http_proxy_loop_detected integer + :type: counter + + Counts the number of times a proxy loop was detected + +.. ts:stat:: global proxy.process.http.http_proxy_mh_loop_detected integer + :type: counter + + Counts the number of times a multi-hop proxy loop was detected + HTTP/2 ------ diff --git a/doc/admin-guide/plugins/cache_range_requests.en.rst b/doc/admin-guide/plugins/cache_range_requests.en.rst index eb01960f707..e677bc528dd 100644 --- a/doc/admin-guide/plugins/cache_range_requests.en.rst +++ b/doc/admin-guide/plugins/cache_range_requests.en.rst @@ -118,6 +118,8 @@ X-Crr-Ims header support .. option:: --consider-ims .. option:: -c +.. option:: --ims-header=[header name] (default: X-Crr-Ims) +.. option:: -i To support slice plugin self healing an option to force revalidation after cache lookup complete was added. This option is triggered by a @@ -137,6 +139,11 @@ In order for this to properly work in a CDN each cache in the chain *SHOULD* also contain a remap rule with the :program:`cache_range_requests` plugin with this option set. +When used with the :program:`slice` plugin its `--crr-ims-header` +option must have the same value (or not be defined) in order to work. + +Presence of the `--ims-header` automatically sets the `--consider-ims` option. + Don't modify the Cache Key -------------------------- diff --git a/doc/admin-guide/plugins/index.en.rst b/doc/admin-guide/plugins/index.en.rst index a848475732b..12ff6ad50e5 100644 --- a/doc/admin-guide/plugins/index.en.rst +++ b/doc/admin-guide/plugins/index.en.rst @@ -172,6 +172,7 @@ directory of the |TS| source tree. Experimental plugins can be compiled by passi Slice SSL Headers SSL Session Reuse + STEK Share System Statistics Traffic Dump WebP Transform @@ -265,6 +266,9 @@ directory of the |TS| source tree. Experimental plugins can be compiled by passi :doc:`SSL Headers ` Populate request headers with SSL session information. +:doc:`STEK Share ` + Coordinates STEK (Session Ticket Encryption Key) between ATS instances running in a group. + :doc:`System Stats ` Inserts system statistics in to the stats list diff --git a/doc/admin-guide/plugins/lua.en.rst b/doc/admin-guide/plugins/lua.en.rst index 02b6421c25f..8ba07fbad81 100644 --- a/doc/admin-guide/plugins/lua.en.rst +++ b/doc/admin-guide/plugins/lua.en.rst @@ -155,7 +155,29 @@ adding a configuration option to records.config. CONFIG proxy.config.plugin.lua.max_states INT 64 -Any per plugin --states value overrides this default value but must be less than or equal to this value. This setting is not reloadable since it must be applied when all the lua states are first initialized. +Any per plugin --states value overrides this default value but must be less than or equal to this value. This setting is not +reloadable since it must be applied when all the lua states are first initialized. + +For remap instances, the LuaJIT garbage collector can be set to be called automatically whenever a remap instance is created +or deleted. This happens when the remap.config file has been modified, and the configuration has been reloaded. This does +not apply to global plugin instances since these exist for the life-time of the ATS process, i.e., they are not reloadable or +reconfigurable by modifying plugin.config while ATS is running. + +By default, the LuaJIT garbage collector will run on its own according to its own internal criteria. However, in some cases, +the garbage collector should be run in a guaranteed fashion. + +For example, in Linux, total Lua memory may be limited to 2GB depending on the LuaJIT version. It may be required to release +memory on demand in order to prevent out of memory errors when running close to the memory limit. Note that the memory usage +is doubled during configuration reloads since the ATS must hold both the current and new configurations during the +transition. If garbage collection occurs does not occur immediately, memory usage may exceed this double usage. + +On demand garbage collection can be enabled by adding the following to each remap line. A value of '1' means +enabled. The default value of '0' means disabled. + +:: + + map http://a.tbcdn.cn/ http://inner.tbcdn.cn/ @plugin=/XXX/tslua.so @pparam=--ljgc=1 + Configuration for JIT mode ========================== diff --git a/doc/admin-guide/plugins/money_trace.en.rst b/doc/admin-guide/plugins/money_trace.en.rst index 41d7406dc45..02c63e6aeb0 100644 --- a/doc/admin-guide/plugins/money_trace.en.rst +++ b/doc/admin-guide/plugins/money_trace.en.rst @@ -18,37 +18,54 @@ Money Trace Plugin -================== +****************** -This is a remap plugin that allows ATS to participate in a distributed tracing system based upon -the Comcast "Money" distributed tracing and monitoring library. The Comcast "Money" library has -its roots in Google's Dapper and Twitters Zipkin systems. A money trace header or session id, is -attached to transaction and allows an operator with the appropriate logging systems in place, -to determine where errors and/or latency may exit. +Description +=========== -Use of the library enables the tracing of a transaction through all systems that participate in -handling the request. See the documentation on this open source library at -https://github.com/Comcast/money. +This plugin allows ATS to participate in a distributed tracing system +based upon the Comcast "Money" distributed tracing and monitoring library. +The Comcast "Money" library has its roots in Google's Dapper and Twitters +Zipkin systems. A money trace header or session id, is attached to +transaction and allows an operator with the appropriate logging systems +in place, to determine where errors and/or latency may exit. + +Use of the library enables the tracing of a transaction through all +systems that participate in handling the request. See the documentation +on this open source library at https://github.com/Comcast/money. How it Works ------------- - -This plugin checks incoming requests for the "X-MoneyTrace" header. If the header is not present -no further processing takes place. However if the header is present, the plugin will check to -to see if the request has been cached. If so, the plugin will add the "X-Moneytrace" header from the -incoming request to the cached response returned to the client as required by the money_trace -protocol. If the request has not been cached, the plugin will extends the trace context by creating a new -"X-MoneyTrace" header for inclusion in the outgoing request to a parent cache or origin server. -The extended header includes the 'trace-id' from the incoming request, the incoming span-id -becomes the outgoing parent-id and the plugin generates a new random long span id for the outgoing request. -See the documentation at the link above for a complete description on the "X-MoneyTrace" header and how -to use and extend it in a distributed tracing system. +============ + +This plugin checks incoming requests for the "X-MoneyTrace" header. +If the header is not present no further processing takes place. +However if the header is present, the plugin will check to to see if the +request has been cached. If so, the plugin will add the "X-Moneytrace" +header from the incoming request to the cached response returned to the +client as required by the money_trace protocol. If the request has not +been cached, the plugin will extends the trace context by creating a new +"X-MoneyTrace" header for inclusion in the outgoing request to a parent +cache or origin server. The extended header includes the 'trace-id' +from the incoming request, the incoming span-id becomes the outgoing +parent-id and the plugin generates a new span id for the +outgoing request using the current state machine id. + +See the documentation at the link above for a complete description on +the "X-MoneyTrace" header and how to use and extend it in a distributed +tracing system. + +A sample money-trace header: + +:: + + X-MoneyTrace: trace-id=aa234a23-189e-4cc4-98ed-b5327b1ec231-3;parent-id=0;span-id=4303691729133364974 Installation ------------- +============ -The `Money Trace` plugin is a :term:`remap plugin`. Enable it by adding -``money_trace.so`` to your :file:`remap.config` file. There are no options. +The `Money Trace` plugin can be either a :term:`remap plugin` or +:term:`global plugin`. Enable it by adding ``money_trace.so`` to your +:file:`remap.config` file or :file:`plugin.config`. Here is an example remap.config entry: @@ -57,3 +74,69 @@ Here is an example remap.config entry: map http://vod.foobar.com http://origin.vod.foobar.com @plugin=money_trace.so .. _MoneyTrace: https://github.com/Comcast/money + +Configuration +============= + +The plugin supports the following options: + +* ``--create-if-none=[true|false]`` (default: ``false``) + +If no X-MoneyTrace header is found in the client request one will +be manufactured using the transaction UUID as trace-id, +the transaction state machine id as span-id and parent-id set to '0'. + +* ``--global-skip-header=[header name]`` (default: null/disable) + +This setting only applies to a :term:`global plugin` instance +and allows remap plugin instances to override :term:`global plugin` +behavior by disabling the :term:`global plugin` + +Because a :term:`global plugin` runs before any :term:`remap plugin` +in the remap phase a pregen header may still be created by the +:term:`global plugin` if configured to do so. + +The global skip check is performed during the post remap phase in order +to allow remap plugins (like `header rewrite`) to set this skip header. + +It is strongly suggested to use a private ATS header (begins with '@') +as this value. + +* ``--header=[header name]`` (default: ``X-MoneyTrace``) + +Allows the money trace header to be overridden. + +* ``--passthru=[true|false]`` (default: ``false``) + +In this mode ATS acts transparently and passes the client money trace +header through to the parent. It also returns this same header back to +the client. This option ignores the --create-if-none setting. + +* ``--pregen-header=[header name]`` (default: null/disable) + +Normally the money trace header for a transaction is only added to the +transaction server request headers. If this argument is supplied the +header will be generated earlier in the transaction and added to the +client request headers. Use this for debug or for logging the current +transaction's money trace header. It is suggested to use a private +ATS header (begins with a '@') for this value. A :file:`logging.yaml` +entry with pregen-header=@MoneyTrace might look like: + +:: + + %<{@MoneyTrace}cqh> + +Robustness +========== + +This plugin tries to be robust in its parsing. At a minimum the value +must start with `trace-id=` set to a none empty value. + +If `span-id=` is found in the header value that will be used as the +parent-id for an upstream request. Otherwise '0' will be its value. + +If the incoming money trace header is invalid, it is handled based +on the --create-if-none setting. If create-if-none is set a new +money trace header will be generated and used. Otherwise the +incoming client header value will be passed through. + diff --git a/doc/admin-guide/plugins/rate_limit.en.rst b/doc/admin-guide/plugins/rate_limit.en.rst index ef3f3246f7a..5d51ac895c5 100644 --- a/doc/admin-guide/plugins/rate_limit.en.rst +++ b/doc/admin-guide/plugins/rate_limit.en.rst @@ -30,6 +30,17 @@ The limit counters and queues are per remap rule only, i.e. there is (currently) no way to group transaction limits from different remap rules into a single rate limiter. +.. Note:: + This is still work in progress, in particularly the configuration and + the IP reputation system needs some work. In particular: + + * We need a proper YAML configuration overall, allowing us to configure + better per service controls as well as sharing resources between remap + rules or SNI. + * We need reloadable configurations. + * The IP reputation currently only works with the global plugin settings. + * There is no support for adding allow listed IPs to the IP reputation. + Remap Plugin ------------ @@ -96,7 +107,10 @@ Global Plugin ------------- As a global plugin, the rate limiting currently applies only for TLS enabled -connections, based on the SNI from the TLS handshake. The basic use is as:: +connections, based on the SNI from the TLS handshake. As a global plugin we +also have the support of an IP reputation system, see below for configurations. + +The basic use is as:: rate_limit.so SNI=www1.example.com,www2.example.com --limit=2 --queue=2 --maxage=10000 @@ -144,6 +158,37 @@ The following options are available: the plugin will use the FQDN of the SNI associated with each rate limiter instance created during plugin initialization. +.. option:: --iprep_buckets + The number of LRU buckets to use for the IP reputation. A good number here + is 10, but can be configured. The reason for the different buckets is to + account for a pseudo-sorted list of IPs on the frequency seen. Too few buckets + will not be enough to keep such a sorting, rendering the algorithm useless. To + function in our setup, the number of buckets must be less than ``100``. + +.. option:: --iprep_bucketsize + This is the size of the largest LRU bucket (the `entry bucket`), `15` is a good + value. This is a power of 2, so `15` means the largest LRU can hold `32768` entries. + Note that this option must be bigger then the `--iprep_buckets` setting, for the + bucket halfing to function. + +.. option:: --iprep_maxage + This is used for aging out entries out of the LRU, the default is `0` which means + no aging happens. Even with no aging, entries will eventually fall out of buckets + because of the LRU mechanism that kicks in. The aging is here to make sure a spike + in traffic from an IP doesn't keep the entry for too long in the LRUs. + +.. option:: --iprep_permablock_limit + The minimum number of hits an IP must reach to get moved to the permanent bucket. + In this bucket, entries will stay for 2x + +.. option:: --iprep_permablock_pressure + This option specifies from which bucket an IP is allowed to move from into the + perma block bucket. A good value here is likely `0` or `1`, which is very conservative. + +.. option:: --iprep_permablock_maxage + Similar to `--iprep_maxage` above, but only applies to the long term (`perma-block`) + bucket. Default is `0`, which means no aging to this bucket is applied. + Metrics ------- Metric names are generated either using defaults or user-supplied values. In either @@ -189,6 +234,21 @@ A user can specify their own prefixes and tags, but not types or metrics. ``resumed`` Queued connection is resumed. ============== =================================================================== +IP Reputation +------------- + +The goal of the IP reputation system is to simply try to identify IPs which are more +likely to be abusive than others. It's not a perfect system, and it relies heavily on +the notion of pressure. The Sieve LRUs are always filled, so you have to make sure that +you only start using them when the system thinks it's under pressure. + +The Sieve LRU is a chained set of (configurable) LRUs, each with smaller and smaller +capacity. This essentially adds a notion of partially sorted elements; All IPs in +LRU generally are more active than the IPs in LRU . LRU is specially marked +for longer term blocking, only the most abusive elements would end up here. + +.. figure:: /static/images/sdk/SieveLRU.png + Examples -------- diff --git a/doc/admin-guide/plugins/slice.en.rst b/doc/admin-guide/plugins/slice.en.rst index edb338906f2..8b56bbd362e 100644 --- a/doc/admin-guide/plugins/slice.en.rst +++ b/doc/admin-guide/plugins/slice.en.rst @@ -113,6 +113,26 @@ The slice plugin supports the following options:: Requires setting up an intermediate loopback remap rule. -r for short + --skip-header=
(default: X-Slicer-Info) + Header name used by the slice plugin after the loopback + to indicate that the slice plugin should be skipped. + -s for short + + --crr-ims-header=
(default: X-Crr-Ims) + Header name used by the slice plugin to tell the + `cache_range_requests` plugin that a request should + be marked as STALE. Used for self healing. + This must match the `--ims-header` option used by the + `cache_range_requests` plugin. + -i for short + + --prefetch-count= (optional) + Default is 0 + Prefetches successive 'n' slice block requests in the background + and cached. Especially for large objects, prefetching can improve + cache miss latency. + -f for short + Examples:: @plugin=slice.so @pparam=--blockbytes=1000000 @plugin=cache_range_requests.so diff --git a/doc/admin-guide/plugins/stek_share.en.rst b/doc/admin-guide/plugins/stek_share.en.rst new file mode 100644 index 00000000000..43ac28c6786 --- /dev/null +++ b/doc/admin-guide/plugins/stek_share.en.rst @@ -0,0 +1,105 @@ +.. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "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 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + + +.. include:: ../../common.defs + +.. _admin-plugins-stek_share: + + +STEK Share Plugin +***************** + +This plugin coordinates STEK (Session Ticket Encryption Key) between ATS instances running in a group. +As the ID based session resumption rate continue to decrease, this new plugin will replace the +:ref:`admin-plugins-ssl_session_reuse` plugin. + + +How It Works +============ + +This plugin implements the `Raft consensus algorithm ` to decide on a leader. The leader will +periodically create a new STEK key and share it with all other ATS boxes in the group. When the plugin starts up, it +will automatically join the cluster of all other ATS boxes in the group, which will also automatically elect a leader. +The plugin uses the `TSSslTicketKeyUpdate` call to update ATS with the latest two STEK's it has received. + +All communication are encrypted. All the ATS boxes participating in the STEK sharing must have access to the cert/key pair. + +Note that since the this plugin only updates STEK every few hours, all Raft related stuff are kept in memory, and some code is +borrowed from the examples from `NuRaft library ` that is used in this plugin. + + +Building +======== + +This plugin uses `NuRaft library ` for leader election and communication. +The NuRaft library must be installed for this plugin to build. It can be specified by the `--with-nuraft` argument to configure. + +This plugin also uses `YAML-CPP library ` for reading the configuration file. +The YAML-CPP library must be installed for this plugin to build. It can be specified by the `--with-yaml-cpp` argument to configure. + +As part of the experimental plugs, the `--enable-experimental-plugins` option must also be given to configure to build this plugin. + + +Config File +=========== + +STEK Share is a global plugin. Its configuration file uses YAML, and is given as an argument to the plugin in :file:`plugin.config`. + +:: + stek_share.so etc/trafficserver/example_server_conf.yaml + +Available options: + +* server_id - An unique ID for the server. +* address - Hostname or IP address of the server. +* port - Port number for communication. +* asio_thread_pool_size - [Optional] Thread pool size for `ASIO library `. Default size is 4. +* heart_beat_interval - [Optional] Heart beat interval of Raft leader, must be less than "election_timeout_lower_bound". Default value is 100 ms. +* election_timeout_lower_bound - [Optional] Lower bound of Raft leader election timeout. Default value is 200 ms. +* election_timeout_upper_bound - [Optional] Upper bound of Raft leader election timeout. Default value is 400 ms. +* reserved_log_items - [Optional] The maximum number of logs preserved ahead the last snapshot. Default value is 5. +* snapshot_distance - [Optional] The number of log appends for each snapshot. Default value is 5. +* client_req_timeout - [Optional] Client request timeout. Default value is 3000 ms. +* key_update_interval - The interval between STEK update. +* server_list_file - Path to a file containing information of all the servers that's supposed to be in the Raft cluster. +* root_cert_file - Path to the root ca file. +* server_cert_file - Path to the cert file. +* server_key_file - Path to the key file. +* cert_verify_str - SSL verification string, for example "/C=US/ST=IL/O=Yahoo/OU=Edge/CN=localhost" + + +Example Config File +=================== + +.. literalinclude:: ../../../plugins/experimental/stek_share/example_server_conf.yaml + + +Server List File +================ + +Server list file as mentioned above, also in YAML. + +* server_id - ID of the server. +* address - Hostname or IP address of the server. +* port - Port number of the server. + + +Example Server List File +======================== + +.. literalinclude:: ../../../plugins/experimental/stek_share/example_server_list.yaml diff --git a/doc/developer-guide/api/types/TSSslSession.en.rst b/doc/developer-guide/api/types/TSSslSession.en.rst index 4f50ead4e4e..4b8c6f4836e 100644 --- a/doc/developer-guide/api/types/TSSslSession.en.rst +++ b/doc/developer-guide/api/types/TSSslSession.en.rst @@ -28,6 +28,8 @@ Synopsis #include +.. c:macro:: TS_SSL_MAX_SSL_SESSION_ID_LENGTH + .. type:: TSSslSessionID .. member:: size_t len diff --git a/doc/developer-guide/core-architecture/HostDB-Data-Layout.svg b/doc/developer-guide/core-architecture/HostDB-Data-Layout.svg new file mode 100644 index 00000000000..9c02674a826 --- /dev/null +++ b/doc/developer-guide/core-architecture/HostDB-Data-Layout.svg @@ -0,0 +1,3 @@ + + +HostDBRecordHostDBType : record_typeunsigned: rr_offset

VLA<HostDBInfo>

HostDBInfo
.

.

.


VLA<HostDBInfo>...

SRV Names

Name
.

.

.

SRV Names...HostDB Hash TableKeyHostDBRecordRecord 1Record 2Record 3

Optional
 Optional

RR Data
 RR Data

SRV only
 SRV only
rr_offset indicates start of HostDBInfo VLA.
rr_offset indicates start o...
Each SRV record has an
offset to its name
Each SRV record has an...Viewer does not support full SVG 1.1 \ No newline at end of file diff --git a/doc/developer-guide/core-architecture/hostdb.en.rst b/doc/developer-guide/core-architecture/hostdb.en.rst new file mode 100644 index 00000000000..33eef3c253a --- /dev/null +++ b/doc/developer-guide/core-architecture/hostdb.en.rst @@ -0,0 +1,191 @@ +.. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "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 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +.. include:: ../../common.defs + +.. highlight:: cpp +.. default-domain:: cpp + +.. _developer-doc-hostdb: + +HostDB +****** + +HostDB is a cache of DNS results. It is used to increase performance by aggregating address +resolution across transactions. HostDB also stores state information for specific IP addresses. + +Operation +========= + +The primary operation for HostDB is to resolve a fully qualified domain name ("FQDN"). As noted each +FQDN is associated with a single record. Each record has an array of items. When a resolution +request is made the database is checked to see if the record is already present. If so, it is +served. Otherwise a DNS request is made. When the nameserver replies a record is created, added +to the database, and then returned to the requestor. + +Each info tracks several status values for its corresponding upstream. These are + +* HTTP version +* Last failure time + +The HTTP version is tracked from responses and provides a mechanism to make intelligent guesses +about the protocol to use to the upstream. + +The last failure time tracks when the last connection failure to the info occurred and doubles as +a flag, where a value of ``TS_TIME_ZERO`` indicates a live target and any other value indicates a +dead info. + +If an info is marked dead (has a non-zero last failure time) there is a "fail window" during which +no connections are permitted. After this time the info is considered to be a "zombie". If all infos +for a record are dead then a specific error message is generated (body factory tag +"connect#all_dead"). Otherwise if the selected info is a zombie, a request is permitted but the +zombie is immediately marked dead again, preventing any additional requests until either the fail +window has passed or the single connection succeeds. A successful connection clears the last file +time and the info becomes alive. + +Runtime Structure +================= + +DNS results are stored in a global hash table as instances of ``HostDBRecord``. Each record stores +the results of a single query. These records are not updated with new DNS results - instead a new +record instance is created and replaces the previous instance in the table. The records are +reference counted so such a replacement doesn't invalidate the old record if the latter is still +being accessed. Some specific dynamic data is migrated from the old record to the new one, such as +the failure status of the upstreams in the record. + +In each record is a variable length array of items, instances of ``HostDBInfo``, one for each +IP address in the record. This is called the "round robin" data for historical reasons. For SRV +records there is an additional storage area in the record that is used to store the SRV names. + +.. figure:: HostDB-Data-Layout.svg + +The round robin data is accessed by using an offset and count in the base record. For SRV records +each record has an offset, relative to that ``HostDBInfo`` instance, for its own name in the name +storage area. + +State information for the outbound connection has been moved to a refurbished ``DNSInfo`` class +named ``ResolveInfo``. As much as possible relevant state information has been moved from the +``HttpSM`` to this structure. This is intended for future work where the state machine deals only +with upstream transactions and not sessions. + +``ResolveInfo`` may contain a reference to a HostDB record, which preserves the record even if it is +replaced due to DNS queries in other transactions. The record is not required as the resolution +information can be supplied directly without DNS or HostDB, e.g. a plugin sets the upstream address +explicitly. The ``resolved_p`` flag indicates if the current information is valid and ready to be +used or not. A result of this is there is no longer a specific holder for API provided addresses - +the interface now puts the address in the ``ResolveInfo`` and marks it as resolved. This prevents +further DNS / HostDB lookups and the address is used as is. + +The upstream port is a bit tricky and should be cleaned up. Currently value in ``srv_port`` +determines the port if set. If not, then the port in ``addr`` is used. + +Resolution Style +---------------- + +.. cpp:enum:: OS_Addr + + Metadata about the source of the resolved address.' + + .. cpp:enumerator:: TRY_DEFAULT + + Use default resolution. This is the initial state. + + .. cpp:enumerator:: TRY_HOSTDB + + Use HostDB to resolve the target key. + + .. cpp:enumerator:: TRY_CLIENT + + Use the client supplied target address. This is used for transparent connections - the upstream + address is obtained from the inbound connection. May fail over to HostDB. + + .. cpp:enumerator:: USE_HOSTDB + + Use HostDB to resolve the target key. + + .. cpp:enumerator:: USE_CLIENT + + Use the client supplied target address. + + .. cpp:enumerator:: USE_API + + Use the address provided via the plugin API. + + The parallel values for using HostDB and the client target address are to control fail over on + connection failure. The ``TRY_`` values can fail over to another style, but the ``USE_`` values + cannot. This prevents cycles of style changes by having any ``TRY_`` value fail over to a + ``USE_`` value, at which point it can no longer change. Note there is no ``TRY_API`` - if a + plugin sets the upstream address that is locked in. + +Issues +====== + +Currently if an upstream is marked down connections are still permitted, the only change is the +number of retries. This has caused operational problems where dead systems are flooded with requests +which, despite the timeouts, accumulate in ATS until ATS runs out of memory (there were instances of +over 800K pending transactions). This also made it hard to bring the upstreams back online. With +these changes requests to dead upstreams are strongly rate limited and other transactions are +immediately terminated with a 502 response, protecting both the upstream and ATS. + +Future +====== + +There is still some work to be done in future PRs. + +* The fail window and the zombie window should be separate values. It is quite reasonable to want + to configure a very short fail window (possibly 0) with a moderately long zombie window so that + probing connections can immediately start going upstream at a low rate. + +* Failing an upstream should be more loosely connected to transactions. Currently there is a one + to one relationship where failure is defined as the failure of a specific transaction to connect. + There are situations where the number of connections attempts for mark a failure is should be + larger than the number of retries for a single transaction. For transiently busy upstreams and + low latency requests it can be reasonable to tune the per transaction timeout low with no retries + but this then risks marking down upstreams that were merely a bit slow at a given moment. + +* Parallel DNS requests should be supported. This is for both cross family requests and for split + DNS. + +* It would be nice to be able to do the probing connections to an upstream using synthetic requests + instead of burning actual user requests. What would be needed is a handoff from ATS to the probe + to indicate a particular upstream is considered down, at which point active health checks are done + until the upstream is once again alive, at which point this is handed off back to ATS. + +History +======= + +This version has several major architectural changes from the previous version. + +* The data is split into records and info, not handled as a variant of a single data type. This + provides a noticeable simplification of the code. + +* Single and multiple address results are treated identically - a singleton is simply a multiple + of size 1. This yeilds a major simplification of the implementation. + +* Connections are throttled to dead upstreams, allowing only a single connection attempt per fail + window timing until a connection succeeds. + +* Timing information is stored in ``std::chrono`` data types instead of proprietary types. + +* State information has been promoted to atomics and updates are immediate rather than scheduled. + This also means the data in the state machine is a reference to a shared object, not a local copy. + The promotion was necessary to coordinate zombie connections to dead upstreams across transactions. + +* The "resolve key" is now a separate data object from the HTTP request. This is a subtle but + major change. The effect is requests can be routed to different upstreams without changing + the request. Parent selection can be greatly simplified as it become merely a matter of setting + the resolve key, rather than having a completely different code path. diff --git a/doc/developer-guide/core-architecture/index.en.rst b/doc/developer-guide/core-architecture/index.en.rst index e88e35fb74e..97f59712d72 100644 --- a/doc/developer-guide/core-architecture/index.en.rst +++ b/doc/developer-guide/core-architecture/index.en.rst @@ -26,5 +26,6 @@ Core Architecture :maxdepth: 1 heap.en + hostdb.en rpc.en url_rewrite_architecture.en.rst diff --git a/doc/static/images/sdk/SieveLRU.png b/doc/static/images/sdk/SieveLRU.png new file mode 100644 index 00000000000..3e138e46d21 Binary files /dev/null and b/doc/static/images/sdk/SieveLRU.png differ diff --git a/doc/uml/host-resolve.plantuml b/doc/uml/host-resolve.plantuml new file mode 100644 index 00000000000..f3c6a6091e9 --- /dev/null +++ b/doc/uml/host-resolve.plantuml @@ -0,0 +1,24 @@ +' SPDX-License-Identifier: Apache-2.0 +' Licensed under the Apache License, Version 2.0 (the "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 +' Unless required by applicable law or agreed to in writing, software distributed under the License is distributed +' on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +' See the License for the specific language governing permissions and limitations under the License. + +@startuml + +hide empty description + +state HttpSM { + state do_http_server_open { + } +} + +state HandleRequest #cyan +state CallOSDNSLookup #cyan + +CallOSDNSLookup -> OSDNSLookup + +@enduml + diff --git a/example/plugins/c-api/protocol/TxnSM.c b/example/plugins/c-api/protocol/TxnSM.c index 8f6ae5416a6..cb7f00f44ec 100644 --- a/example/plugins/c-api/protocol/TxnSM.c +++ b/example/plugins/c-api/protocol/TxnSM.c @@ -477,8 +477,6 @@ int state_dns_lookup(TSCont contp, TSEvent event, TSHostLookupResult host_info) { TxnSM *txn_sm = (TxnSM *)TSContDataGet(contp); - struct sockaddr const *q_server_addr; - struct sockaddr_in ip_addr; TSDebug(PLUGIN_NAME, "enter state_dns_lookup"); @@ -489,16 +487,16 @@ state_dns_lookup(TSCont contp, TSEvent event, TSHostLookupResult host_info) txn_sm->q_pending_action = NULL; /* Get the server IP from data structure TSHostLookupResult. */ - q_server_addr = TSHostLookupResultAddrGet(host_info); + struct sockaddr const *sa = TSHostLookupResultAddrGet(host_info); /* Connect to the server using its IP. */ set_handler(txn_sm->q_current_handler, (TxnSMHandler)&state_connect_to_server); TSAssert(txn_sm->q_pending_action == NULL); - TSAssert(q_server_addr->sa_family == AF_INET); /* NO IPv6 in this plugin */ + TSAssert(sa->sa_family == AF_INET); /* NO IPv6 in this plugin */ + struct sockaddr_in *addr = (struct sockaddr_in *)(sa); - memcpy(&ip_addr, q_server_addr, sizeof(ip_addr)); - ip_addr.sin_port = txn_sm->q_server_port; - txn_sm->q_pending_action = TSNetConnect(contp, (struct sockaddr const *)&ip_addr); + addr->sin_port = txn_sm->q_server_port; + txn_sm->q_pending_action = TSNetConnect(contp, sa); return TS_SUCCESS; } diff --git a/example/plugins/cpp-api/boom/boom.cc b/example/plugins/cpp-api/boom/boom.cc index a312e7f2043..7a3a3234d66 100644 --- a/example/plugins/cpp-api/boom/boom.cc +++ b/example/plugins/cpp-api/boom/boom.cc @@ -98,13 +98,16 @@ GlobalPlugin *plugin; // Functor that decides whether the HTTP error can be rewritten or not. // Rewritable codes are: 2xx, 3xx, 4xx, 5xx and 6xx. // 1xx is NOT rewritable! -class IsRewritableCode : public std::unary_function +class IsRewritableCode { // could probably be replaced with mem_ptr_fun().. private: int current_code_; std::string current_code_string_; public: + using argument_type = std::string; + using result_type = bool; + explicit IsRewritableCode(int current_code) : current_code_(current_code) { std::ostringstream oss; diff --git a/include/ts/apidefs.h.in b/include/ts/apidefs.h.in index e3ebe46528d..ac550a95fd6 100644 --- a/include/ts/apidefs.h.in +++ b/include/ts/apidefs.h.in @@ -437,8 +437,8 @@ typedef enum { TS_LIFECYCLE_CLIENT_SSL_CTX_INITIALIZED_HOOK, TS_LIFECYCLE_MSG_HOOK, TS_LIFECYCLE_TASK_THREADS_READY_HOOK, - TS_LIFECYCLE_SSL_SECRET_HOOK, TS_LIFECYCLE_SHUTDOWN_HOOK, + TS_LIFECYCLE_SSL_SECRET_HOOK, TS_LIFECYCLE_LAST_HOOK } TSLifecycleHookID; @@ -827,7 +827,6 @@ typedef enum { TS_CONFIG_HTTP_CACHE_MAX_OPEN_WRITE_RETRIES, TS_CONFIG_HTTP_REDIRECT_USE_ORIG_CACHE_KEY, TS_CONFIG_HTTP_ATTACH_SERVER_SESSION_TO_CLIENT, - TS_CONFIG_HTTP_MAX_PROXY_CYCLES, TS_CONFIG_WEBSOCKET_NO_ACTIVITY_TIMEOUT, TS_CONFIG_WEBSOCKET_ACTIVE_TIMEOUT, TS_CONFIG_HTTP_UNCACHEABLE_REQUESTS_BYPASS_PARENT, @@ -856,6 +855,11 @@ typedef enum { TS_CONFIG_HTTP_SERVER_MIN_KEEP_ALIVE_CONNS, TS_CONFIG_HTTP_PER_SERVER_CONNECTION_MAX, TS_CONFIG_HTTP_PER_SERVER_CONNECTION_MATCH, +#if TS_VERSION_MAJOR < 10 + /* This is kept in the 9.x releases to preserve the ABI. Remove this in the + * 10 release. */ + TS_CONFIG_SSL_CLIENT_VERIFY_SERVER, +#endif TS_CONFIG_SSL_CLIENT_VERIFY_SERVER_POLICY, TS_CONFIG_SSL_CLIENT_VERIFY_SERVER_PROPERTIES, TS_CONFIG_SSL_CLIENT_SNI_POLICY, @@ -863,6 +867,7 @@ typedef enum { TS_CONFIG_SSL_CLIENT_CA_CERT_FILENAME, TS_CONFIG_HTTP_HOST_RESOLUTION_PREFERENCE, TS_CONFIG_HTTP_CONNECT_DEAD_POLICY, + TS_CONFIG_HTTP_MAX_PROXY_CYCLES, TS_CONFIG_PLUGIN_VC_DEFAULT_BUFFER_INDEX, TS_CONFIG_PLUGIN_VC_DEFAULT_BUFFER_WATER_MARK, TS_CONFIG_NET_SOCK_NOTSENT_LOWAT, diff --git a/include/ts/experimental.h b/include/ts/experimental.h index deef0ab3f6c..b2d020f4724 100644 --- a/include/ts/experimental.h +++ b/include/ts/experimental.h @@ -73,6 +73,29 @@ int64_t TSCacheHttpInfoSizeGet(TSCacheHttpInfo infop); tsapi int TSMimeHdrFieldEqual(TSMBuffer bufp, TSMLoc hdr_obj, TSMLoc field1, TSMLoc field2); tsapi TSReturnCode TSHttpTxnHookRegisteredFor(TSHttpTxn txnp, TSHttpHookID id, TSEventFunc funcp); +#if TS_VERSION_MAJOR < 10 + +/* These are kept in the 9.x releases to preserve the ABI. These should be + * removed in the ATS 10 release. */ + +/* Various HTTP "control" modes */ +typedef enum { + TS_HTTP_CNTL_GET_LOGGING_MODE, + TS_HTTP_CNTL_SET_LOGGING_MODE, + TS_HTTP_CNTL_GET_INTERCEPT_RETRY_MODE, + TS_HTTP_CNTL_SET_INTERCEPT_RETRY_MODE +} TSHttpCntlTypeExperimental; + +#define TS_HTTP_CNTL_OFF (void *)0 +#define TS_HTTP_CNTL_ON (void *)1 +/* usage: + void *onoff = 0; + TSHttpTxnCntl(.., TS_HTTP_CNTL_GET_LOGGING_MODE, &onoff); + if (onoff == TS_HTTP_CNTL_ON) .... +*/ +tsapi TSReturnCode TSHttpTxnCntl(TSHttpTxn txnp, TSHttpCntlTypeExperimental cntl, void *data); + +#endif /* Protocols APIs */ tsapi void TSVConnCacheHttpInfoSet(TSVConn connp, TSCacheHttpInfo infop); diff --git a/include/ts/ts.h b/include/ts/ts.h index dc1ac253ef7..90b2b7ef68e 100644 --- a/include/ts/ts.h +++ b/include/ts/ts.h @@ -1312,7 +1312,7 @@ tsapi TSReturnCode TSSslSecretUpdate(const char *secret_name, int secret_name_le /* Create a new SSL context based on the settings in records.config */ tsapi TSSslContext TSSslServerContextCreate(TSSslX509 cert, const char *certname, const char *rsp_file); tsapi void TSSslContextDestroy(TSSslContext ctx); -tsapi void TSSslTicketKeyUpdate(char *ticketData, int ticketDataLen); +tsapi TSReturnCode TSSslTicketKeyUpdate(char *ticketData, int ticketDataLen); TSAcceptor TSAcceptorGet(TSVConn sslp); TSAcceptor TSAcceptorGetbyID(int ID); int TSAcceptorCount(); @@ -1950,7 +1950,13 @@ tsapi TSReturnCode TSPortDescriptorAccept(TSPortDescriptor, TSCont); /* -------------------------------------------------------------------------- DNS Lookups */ tsapi TSAction TSHostLookup(TSCont contp, const char *hostname, size_t namelen); +/** Retrieve an address from the host lookup. + * + * @param lookup_result Result handle passed to event callback. + * @return A @c sockaddr with the address if successful, a @c nullptr if not. + */ tsapi struct sockaddr const *TSHostLookupResultAddrGet(TSHostLookupResult lookup_result); + /* TODO: Eventually, we might want something like this as well, but it requires support for building the HostDBInfo struct: tsapi void TSHostLookupResultSet(TSHttpTxn txnp, TSHostLookupResult result); diff --git a/include/tscore/BufferWriter.h b/include/tscore/BufferWriter.h index 34e0b6bb541..85d0a74f83f 100644 --- a/include/tscore/BufferWriter.h +++ b/include/tscore/BufferWriter.h @@ -854,10 +854,10 @@ std::string & bwprintv(std::string &s, ts::TextView fmt, std::tuple const &args) { auto len = s.size(); // remember initial size - size_t n = ts::FixedBufferWriter(const_cast(s.data()), s.size()).printv(fmt, std::move(args)).extent(); + size_t n = ts::FixedBufferWriter(const_cast(s.data()), s.size()).printv(fmt, args).extent(); s.resize(n); // always need to resize - if shorter, must clip pre-existing text. if (n > len) { // dropped data, try again. - ts::FixedBufferWriter(const_cast(s.data()), s.size()).printv(fmt, std::move(args)); + ts::FixedBufferWriter(const_cast(s.data()), s.size()).printv(fmt, args); } return s; } diff --git a/include/tscore/BufferWriterForward.h b/include/tscore/BufferWriterForward.h index 8da67c60b4c..7773486b92f 100644 --- a/include/tscore/BufferWriterForward.h +++ b/include/tscore/BufferWriterForward.h @@ -148,4 +148,11 @@ class BWFormat; class BufferWriter; +/// Storage for debug messages. +/// If @c bwprint is used with this, the storage is reused which minimizes allocations. +/// E.g. +/// @code + +inline thread_local std::string bw_dbg; + } // namespace ts diff --git a/include/tscore/CryptoHash.h b/include/tscore/CryptoHash.h index 767cb7b64fe..4c2d97e3ff6 100644 --- a/include/tscore/CryptoHash.h +++ b/include/tscore/CryptoHash.h @@ -23,6 +23,7 @@ #pragma once #include "tscore/BufferWriter.h" +#include #include /// Apache Traffic Server commons. @@ -132,6 +133,9 @@ class CryptoContextBase /// @note This is just as fast as the previous style, as a new context must be initialized /// every time this is done. bool hash_immediate(CryptoHash &hash, void const *data, int length); + +protected: + EVP_MD_CTX *_ctx = nullptr; }; inline bool @@ -159,29 +163,31 @@ class CryptoContext : public CryptoContextBase UNSPECIFIED, #if TS_ENABLE_FIPS == 0 MD5, - MMH, #endif SHA256, }; ///< What type of hash we really are. static HashType Setting; - /// Size of storage for placement @c new of hashing context. - static size_t const OBJ_SIZE = 256; + ~CryptoContext() + { + delete _base; + _base = nullptr; + } -protected: - char _obj[OBJ_SIZE]; ///< Raw storage for instantiated context. +private: + CryptoContextBase *_base = nullptr; }; inline bool CryptoContext::update(void const *data, int length) { - return reinterpret_cast(_obj)->update(data, length); + return _base->update(data, length); } inline bool CryptoContext::finalize(CryptoHash &hash) { - return reinterpret_cast(_obj)->finalize(hash); + return _base->finalize(hash); } ts::BufferWriter &bwformat(ts::BufferWriter &w, ts::BWFSpec const &spec, ats::CryptoHash const &hash); diff --git a/include/tscore/Diags.h b/include/tscore/Diags.h index 53cfd759f37..50a708efdfa 100644 --- a/include/tscore/Diags.h +++ b/include/tscore/Diags.h @@ -159,6 +159,15 @@ extern Diags *diags; } \ } while (0) +#define Debug_bw(tag, fmt, ...) \ + do { \ + if (unlikely(diags->on())) { \ + static const SourceLocation loc = MakeSourceLocation(); \ + static LogMessage log_message; \ + log_message.debug(tag, loc, "%s", ts::bwprint(ts::bw_dbg, fmt, __VA_ARGS__).c_str()); \ + } \ + } while (0) + /** Same as Debug above, but this allows a positive override of the tag * mechanism by a flag boolean. * diff --git a/include/tscore/IntrusivePtr.h b/include/tscore/IntrusivePtr.h index bfe63a3aee0..70cc671e394 100644 --- a/include/tscore/IntrusivePtr.h +++ b/include/tscore/IntrusivePtr.h @@ -330,9 +330,13 @@ template class IntrusivePtrDefaultPolicy static void finalize(T *t); /// Strict weak order for STL containers. - class Order : public std::binary_function, IntrusivePtr, bool> + class Order { public: + using first_argument_type = IntrusivePtr; + using second_argument_type = IntrusivePtr; + using result_type = bool; + /// Default constructor. Order() {} /// Compare by raw pointer. diff --git a/include/tscore/MD5.h b/include/tscore/MD5.h index 3131197dfef..8b1e5bb26f7 100644 --- a/include/tscore/MD5.h +++ b/include/tscore/MD5.h @@ -29,9 +29,6 @@ class MD5Context : public ats::CryptoContextBase { -protected: - EVP_MD_CTX *_ctx; - public: MD5Context() { diff --git a/include/tscore/PluginUserArgs.h b/include/tscore/PluginUserArgs.h index 4dd637b2158..b466829c1fb 100644 --- a/include/tscore/PluginUserArgs.h +++ b/include/tscore/PluginUserArgs.h @@ -86,7 +86,7 @@ template class PluginUserArgs : public virtual PluginUserArgsM { public: void * - get_user_arg(size_t ix) const + get_user_arg(size_t ix) const override { ink_release_assert(SanityCheckUserIndex(I, ix)); ix -= get_user_arg_offset(I); @@ -95,7 +95,7 @@ template class PluginUserArgs : public virtual PluginUserArgsM }; void - set_user_arg(size_t ix, void *arg) + set_user_arg(size_t ix, void *arg) override { ink_release_assert(SanityCheckUserIndex(I, ix)); ix -= get_user_arg_offset(I); diff --git a/include/tscore/Regression.h b/include/tscore/Regression.h index 72e65fa2c4b..6c58973817a 100644 --- a/include/tscore/Regression.h +++ b/include/tscore/Regression.h @@ -101,3 +101,5 @@ struct RegressionTest { int rprintf(RegressionTest *t, const char *format, ...); int rperf(RegressionTest *t, const char *tag, double val); const char *regression_status_string(int status); + +void tell_diags_regression_testing_is_on(); diff --git a/include/tscore/SHA256.h b/include/tscore/SHA256.h index 9b3140a028c..446ae0cb896 100644 --- a/include/tscore/SHA256.h +++ b/include/tscore/SHA256.h @@ -29,26 +29,23 @@ class SHA256Context : public ats::CryptoContextBase { -protected: - EVP_MD_CTX *ctx; - public: SHA256Context() { - ctx = EVP_MD_CTX_new(); - EVP_DigestInit_ex(ctx, EVP_sha256(), nullptr); + _ctx = EVP_MD_CTX_new(); + EVP_DigestInit_ex(_ctx, EVP_sha256(), nullptr); } - ~SHA256Context() { EVP_MD_CTX_free(ctx); } + ~SHA256Context() { EVP_MD_CTX_free(_ctx); } /// Update the hash with @a data of @a length bytes. bool update(void const *data, int length) override { - return EVP_DigestUpdate(ctx, data, length); + return EVP_DigestUpdate(_ctx, data, length); } /// Finalize and extract the @a hash. bool finalize(CryptoHash &hash) override { - return EVP_DigestFinal_ex(ctx, hash.u8, nullptr); + return EVP_DigestFinal_ex(_ctx, hash.u8, nullptr); } }; diff --git a/include/tscore/bwf_std_format.h b/include/tscore/bwf_std_format.h index e67c858fc0b..cb060edd170 100644 --- a/include/tscore/bwf_std_format.h +++ b/include/tscore/bwf_std_format.h @@ -26,6 +26,7 @@ #include #include #include +#include #include "tscpp/util/TextView.h" #include "tscore/BufferWriterForward.h" @@ -38,6 +39,20 @@ bwformat(ts::BufferWriter &w, ts::BWFSpec const &spec, atomic const &v) return ts::bwformat(w, spec, v.load()); } +template +ts::BufferWriter & +bwformat(ts::BufferWriter &w, ts::BWFSpec const &spec, chrono::duration const &d) +{ + return bwformat(w, spec, d.count()); +} + +template +ts::BufferWriter & +bwformat(ts::BufferWriter &w, ts::BWFSpec const &spec, chrono::time_point const &t) +{ + return bwformat(w, spec, t.time_since_epoch()); +} + } // end namespace std namespace ts @@ -130,5 +145,4 @@ namespace bwf BufferWriter &bwformat(BufferWriter &w, BWFSpec const &spec, bwf::Errno const &e); BufferWriter &bwformat(BufferWriter &w, BWFSpec const &spec, bwf::Date const &date); BufferWriter &bwformat(BufferWriter &w, BWFSpec const &spec, bwf::OptionalAffix const &opts); - } // namespace ts diff --git a/include/tscore/ink_base64.h b/include/tscore/ink_base64.h index a3c4d510afc..1473a312a51 100644 --- a/include/tscore/ink_base64.h +++ b/include/tscore/ink_base64.h @@ -42,5 +42,16 @@ bool ats_base64_encode(const unsigned char *inBuffer, size_t inBufferSize, char bool ats_base64_decode(const char *inBuffer, size_t inBufferSize, unsigned char *outBuffer, size_t outBufSize, size_t *length); // Little helper functions to calculate minimum required output buffer for encoding/decoding. -#define ATS_BASE64_ENCODE_DSTLEN(_length) ((_length * 8) / 6 + 4) -#define ATS_BASE64_DECODE_DSTLEN(_length) (((_length + 3) / 4) * 3) +// These sizes include one byte for null termination, because ats_base64_encode and ats_base64_decode will always write a null +// terminator. +inline constexpr size_t +ats_base64_encode_dstlen(size_t length) +{ + return ((length + 2) / 3) * 4 + 1; +} + +inline constexpr size_t +ats_base64_decode_dstlen(size_t length) +{ + return ((length + 3) / 4) * 3 + 1; +} diff --git a/include/tscore/ink_defs.h b/include/tscore/ink_defs.h index 35141368371..0202649f2ac 100644 --- a/include/tscore/ink_defs.h +++ b/include/tscore/ink_defs.h @@ -24,19 +24,15 @@ #pragma once #include "tscore/ink_config.h" + #include // NOLINT(modernize-deprecated-headers) -#include #ifdef HAVE_STDINT_H #include // NOLINT(modernize-deprecated-headers) -#else -// TODO: Add "standard" int types? #endif #ifdef HAVE_INTTYPES_H #include // NOLINT(modernize-deprecated-headers) -#else -// TODO: add PRI*64 stuff? #endif #ifndef INT64_MIN @@ -61,11 +57,6 @@ #endif #endif -#if defined(darwin) -#define RENTRENT_GETHOSTBYNAME -#define RENTRENT_GETHOSTBYADDR -#endif - #define NUL '\0' // Determine the element count for an array. @@ -100,26 +91,13 @@ countof(const T (&)[N]) #define unlikely(x) __builtin_expect(!!(x), 0) #endif -#if TS_USE_HWLOC -#include -#endif - -#if defined(MAP_NORESERVE) -#define MAP_SHARED_MAP_NORESERVE (MAP_SHARED | MAP_NORESERVE) -#else -#define MAP_SHARED_MAP_NORESERVE (MAP_SHARED) -#endif - /* Variables */ -extern int debug_level; extern int off; extern int on; /* Functions */ -int ink_sys_name_release(char *name, int namelen, char *release, int releaselen); -int ink_number_of_processors(); int ink_login_name_max(); #ifdef __cplusplus @@ -136,8 +114,3 @@ ROUNDUP(ArithmeticV value, ArithmeticM m) return value; } #endif - -#if TS_USE_HWLOC -// Get the hardware topology -hwloc_topology_t ink_get_topology(); -#endif diff --git a/include/tscore/ink_hw.h b/include/tscore/ink_hw.h new file mode 100644 index 00000000000..fc9d7a7a68a --- /dev/null +++ b/include/tscore/ink_hw.h @@ -0,0 +1,33 @@ +/** @file + + @section license License + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "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 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + */ + +#pragma once + +#include "tscore/ink_config.h" + +#if TS_USE_HWLOC +#include + +// Get the hardware topology +hwloc_topology_t ink_get_topology(); +#endif + +int ink_number_of_processors(); diff --git a/include/tscore/ink_queue.h b/include/tscore/ink_queue.h index ffddafefa16..4b8f02873e4 100644 --- a/include/tscore/ink_queue.h +++ b/include/tscore/ink_queue.h @@ -139,10 +139,10 @@ union head_p { #define SET_FREELIST_POINTER_VERSION(_x, _p, _v) \ (_x).s.pointer = _p; \ (_x).s.version = _v -#elif defined(__x86_64__) || defined(__ia64__) || defined(__powerpc64__) || defined(__aarch64__) || defined(__mips64) +#elif defined(__x86_64__) || defined(__ia64__) || defined(__powerpc64__) || defined(__mips64) /* Layout of FREELIST_POINTER * - * 0 ~ 47 bits : 48 bits, Virtual Address (47 bits for AMD64 and 48 bits for AArch64) + * 0 ~ 47 bits : 48 bits, Virtual Address * 48 ~ 62 bits : 15 bits, Freelist Version * 63 bits : 1 bits, The type of Virtual Address (0 = user space, 1 = kernel space) */ @@ -158,11 +158,30 @@ union head_p { #else /* the shift is `logical' */ #define FREELIST_POINTER(_x) \ - ((void *)((((intptr_t)(_x).data) & 0x0000FFFFFFFFFFFFLL) | (((~((((intptr_t)(_x).data) >> 63) - 1)) >> 48) << 48))) + ((void *)((((intptr_t)(_x).data) & 0x0000FFFFFFFFFFFFLL) | ((~((((intptr_t)(_x).data) >> 63) - 1)) << 48))) #endif #define FREELIST_VERSION(_x) ((((intptr_t)(_x).data) & 0x7FFF000000000000LL) >> 48) #define SET_FREELIST_POINTER_VERSION(_x, _p, _v) (_x).data = ((((intptr_t)(_p)) & 0x8000FFFFFFFFFFFFLL) | (((_v)&0x7FFFLL) << 48)) +#elif defined(__aarch64__) +/* Layout of FREELIST_POINTER + * + * 0 ~ 51 bits : 52 bits, Virtual Address + * 52 ~ 62 bits : 11 bits, Freelist Version + * 63 bits : 1 bits, The type of Virtual Address (0 = user space, 1 = kernel space) + */ +#if ((~0 >> 1) < 0) +/* the shift is `arithmetic' */ +#define FREELIST_POINTER(_x) \ + ((void *)((((intptr_t)(_x).data) & 0x000FFFFFFFFFFFFFLL) | ((((intptr_t)(_x).data) >> 63) << 52))) // sign extend +#else +/* the shift is `logical' */ +#define FREELIST_POINTER(_x) \ + ((void *)((((intptr_t)(_x).data) & 0x000FFFFFFFFFFFFFLL) | ((~((((intptr_t)(_x).data) >> 63) - 1)) << 52))) +#endif + +#define FREELIST_VERSION(_x) ((((intptr_t)(_x).data) & 0x7FF0000000000000LL) >> 52) +#define SET_FREELIST_POINTER_VERSION(_x, _p, _v) (_x).data = ((((intptr_t)(_p)) & 0x800FFFFFFFFFFFFFLL) | (((_v)&0x7FFLL) << 52)) #else #error "unsupported processor" #endif diff --git a/include/tscore/ink_stack_trace.h b/include/tscore/ink_stack_trace.h index 5d10fd03894..ff759b8b802 100644 --- a/include/tscore/ink_stack_trace.h +++ b/include/tscore/ink_stack_trace.h @@ -29,8 +29,15 @@ #ifdef __cplusplus extern "C" { #endif + /* dumps the current back trace to stderr */ void ink_stack_trace_dump(); + +/** + Get symbol of @n-th frame +*/ +const void *ink_backtrace(const int n); + #ifdef __cplusplus } #endif diff --git a/include/tscore/ts_file.h b/include/tscore/ts_file.h index c4389e948f6..8a9eff2befc 100644 --- a/include/tscore/ts_file.h +++ b/include/tscore/ts_file.h @@ -329,5 +329,12 @@ namespace file /* ------------------------------------------------------------------- */ } // namespace file + +inline BufferWriter & +bwformat(BufferWriter &w, BWFSpec const &spec, file::path const &path) +{ + return bwformat(w, spec, path.string()); +} + } // namespace ts /* ------------------------------------------------------------------- */ diff --git a/include/tscpp/api/Headers.h b/include/tscpp/api/Headers.h index 9e6daea8ef4..ffaffde81b5 100644 --- a/include/tscpp/api/Headers.h +++ b/include/tscpp/api/Headers.h @@ -109,12 +109,15 @@ class HeaderField; /** * @brief A header field value iterator iterates through all header fields. */ -class header_field_value_iterator : public std::iterator +class header_field_value_iterator { private: HeaderFieldValueIteratorState *state_; public: + using iterator_category = std::forward_iterator_tag; + using value_type = int; + /** * Constructor for header_field_value_iterator, this shouldn't need to be used directly. * @param bufp the TSMBuffer associated with the headers @@ -169,13 +172,16 @@ class header_field_value_iterator : public std::iterator +class header_field_iterator { private: HeaderFieldIteratorState *state_; header_field_iterator(void *hdr_buf, void *hdr_loc, void *field_loc); public: + using iterator_category = std::forward_iterator_tag; + using value_type = int; + ~header_field_iterator(); /** diff --git a/include/tscpp/util/Makefile.am b/include/tscpp/util/Makefile.am index 6d073e61124..a1d18fd1900 100644 --- a/include/tscpp/util/Makefile.am +++ b/include/tscpp/util/Makefile.am @@ -22,5 +22,7 @@ library_include_HEADERS = \ IntrusiveDList.h \ LocalBuffer.h \ PostScript.h \ + Strerror.h \ + string_view_util.h \ TextView.h \ TsSharedMutex.h diff --git a/include/tscpp/util/Strerror.h b/include/tscpp/util/Strerror.h new file mode 100644 index 00000000000..eb1e6731ca5 --- /dev/null +++ b/include/tscpp/util/Strerror.h @@ -0,0 +1,82 @@ +/** @file + + A convenience wrapper for the thread-safe strerror_r() function, either + GNU or XSI version. Allows the avoidance of use of the thread-unsafe + strerror() function. + + @section license License + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "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 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + */ + +#pragma once + +#include + +namespace ts +{ +// Typically this class is used to create anonymous temporaries, for example: +// +// if ((fd = open(file_path, O_RDONLY)) < 0) { +// Error("%s Can not open %s file : %s", module_name, file_path, Strerror(errno).c_str()); +// return nullptr; +// } +// +class Strerror +{ +public: + Strerror(int err_num) + { + // Handle either GNU or XSI version of strerror_r(). + // + if (!_success(strerror_r(err_num, _buf, 256))) { + _c_str = "strerror_r() call failed"; + } else { + _buf[255] = '\0'; + _c_str = _buf; + } + + // Make sure there are no unused function warnings. + // + static_cast(_success(0)); + static_cast(_success(nullptr)); + } + + char const * + c_str() const + { + return (_c_str); + } + +private: + char _buf[256]; + char const *_c_str; + + bool + _success(int retval) + { + return retval == 0; + } + + bool + _success(char *retval) + { + return retval != nullptr; + } +}; + +} // end namespace ts diff --git a/include/tscpp/util/TsSharedMutex.h b/include/tscpp/util/TsSharedMutex.h index 3ac7f2ea948..df0fd2c23ee 100644 --- a/include/tscpp/util/TsSharedMutex.h +++ b/include/tscpp/util/TsSharedMutex.h @@ -25,7 +25,7 @@ #pragma once #include -#include +#include #if __has_include() #include @@ -54,49 +54,6 @@ namespace ts { -class Strerror -{ -public: - Strerror(int err_num) - { - // Handle either GNU or XSI version of strerror_r(). - // - if (!_success(strerror_r(err_num, _buf, 256))) { - _c_str = "strerror_r() call failed"; - } else { - _buf[255] = '\0'; - _c_str = _buf; - } - - // Make sure there are no unused function warnings. - // - static_cast(_success(0)); - static_cast(_success(nullptr)); - } - - char const * - c_str() const - { - return (_c_str); - } - -private: - char _buf[256]; - char const *_c_str; - - bool - _success(int retval) - { - return retval == 0; - } - - bool - _success(char *retval) - { - return retval != nullptr; - } -}; - // A class with the same interface as std::shared_mutex, but which is not prone to writer starvation. // class shared_mutex diff --git a/iocore/aio/AIO.cc b/iocore/aio/AIO.cc index df8e27bea8f..9384ed7c6b4 100644 --- a/iocore/aio/AIO.cc +++ b/iocore/aio/AIO.cc @@ -25,7 +25,8 @@ * Async Disk IO operations. */ -#include +#include "tscore/TSSystemState.h" +#include "tscore/ink_hw.h" #include "P_AIO.h" diff --git a/iocore/aio/test_AIO.cc b/iocore/aio/test_AIO.cc index e3dccef256d..bef0a8ea3b7 100644 --- a/iocore/aio/test_AIO.cc +++ b/iocore/aio/test_AIO.cc @@ -23,6 +23,7 @@ #include "P_AIO.h" #include "InkAPIInternal.h" +#include "tscore/ink_hw.h" #include "tscore/I_Layout.h" #include "tscore/TSSystemState.h" #include "tscore/Random.h" diff --git a/iocore/cache/Cache.cc b/iocore/cache/Cache.cc index edb825a4a82..e22e5674587 100644 --- a/iocore/cache/Cache.cc +++ b/iocore/cache/Cache.cc @@ -1434,7 +1434,7 @@ Vol::handle_recover_from_data(int event, void * /* data ATS_UNUSED */) { uint32_t got_len = 0; uint32_t max_sync_serial = header->sync_serial; - char *s, *e; + char *s, *e = nullptr; if (event == EVENT_IMMEDIATE) { if (header->sync_serial == 0) { io.aiocb.aio_buf = nullptr; diff --git a/iocore/cache/CacheHosting.cc b/iocore/cache/CacheHosting.cc index 41c995742ff..60cb6890929 100644 --- a/iocore/cache/CacheHosting.cc +++ b/iocore/cache/CacheHosting.cc @@ -112,9 +112,7 @@ CacheHostMatcher::Match(const char *rdata, int rlen, CacheHostResult *result) co return; } - char *data = static_cast(ats_malloc(rlen + 1)); - memcpy(data, rdata, rlen); - *(data + rlen) = '\0'; + std::string_view data{rdata, static_cast(rlen)}; HostLookupState s; r = host_lookup->MatchFirst(data, &s, &opaque_ptr); @@ -122,11 +120,10 @@ CacheHostMatcher::Match(const char *rdata, int rlen, CacheHostResult *result) co while (r == true) { ink_assert(opaque_ptr != nullptr); data_ptr = static_cast(opaque_ptr); - data_ptr->UpdateMatch(result, data); + data_ptr->UpdateMatch(result); r = host_lookup->MatchNext(&s, &opaque_ptr); } - ats_free(data); } // @@ -490,18 +487,14 @@ CacheHostRecord::Init(matcher_line *line_info, CacheType typ) const char *errptr = "A volume number expected"; RecSignalWarning(REC_SIGNAL_CONFIG_ERROR, "%s discarding %s entry at line %d :%s", "[CacheHosting]", config_file, line_info->line_num, errptr); - if (val != nullptr) { - ats_free(val); - } + ats_free(val); return -1; } } if ((*s < '0') || (*s > '9')) { RecSignalWarning(REC_SIGNAL_CONFIG_ERROR, "%s discarding %s entry at line %d : bad token [%c]", "[CacheHosting]", config_file, line_info->line_num, *s); - if (val != nullptr) { - ats_free(val); - } + ats_free(val); return -1; } s++; @@ -537,9 +530,7 @@ CacheHostRecord::Init(matcher_line *line_info, CacheType typ) if (!is_vol_present) { RecSignalWarning(REC_SIGNAL_CONFIG_ERROR, "%s discarding %s entry at line %d : bad volume number [%d]", "[CacheHosting]", config_file, line_info->line_num, volume_number); - if (val != nullptr) { - ats_free(val); - } + ats_free(val); return -1; } if (c == '\0') { @@ -583,7 +574,7 @@ CacheHostRecord::Init(matcher_line *line_info, CacheType typ) } void -CacheHostRecord::UpdateMatch(CacheHostResult *r, char * /* rd ATS_UNUSED */) +CacheHostRecord::UpdateMatch(CacheHostResult *r) { r->record = this; } diff --git a/iocore/cache/CacheTest.cc b/iocore/cache/CacheTest.cc index 97f1301b541..f1d50fd7e48 100644 --- a/iocore/cache/CacheTest.cc +++ b/iocore/cache/CacheTest.cc @@ -334,7 +334,7 @@ EXCLUSIVE_REGRESSION_TEST(cache)(RegressionTest *t, int /* atype ATS_UNUSED */, CACHE_SM( t, replace_write_test, - { cacheProcessor.open_write(this, &key, CACHE_FRAG_TYPE_NONE, 100, CACHE_WRITE_OPT_SYNC); } int open_write_callout() { + { cacheProcessor.open_write(this, &key, CACHE_FRAG_TYPE_NONE, 100, CACHE_WRITE_OPT_SYNC); } int open_write_callout() override { header.serial = 10; cache_vc->set_header(&header, sizeof(header)); cvio = cache_vc->do_io_write(this, nbytes, buffer_reader); @@ -347,18 +347,19 @@ EXCLUSIVE_REGRESSION_TEST(cache)(RegressionTest *t, int /* atype ATS_UNUSED */, CACHE_SM( t, replace_test, - { cacheProcessor.open_write(this, &key, CACHE_FRAG_TYPE_NONE, 100, CACHE_WRITE_OPT_OVERWRITE_SYNC); } int open_write_callout() { - CacheTestHeader *h = nullptr; - int hlen = 0; - if (cache_vc->get_header((void **)&h, &hlen) < 0) - return -1; - if (h->serial != 10) - return -1; - header.serial = 11; - cache_vc->set_header(&header, sizeof(header)); - cvio = cache_vc->do_io_write(this, nbytes, buffer_reader); - return 1; - }); + { cacheProcessor.open_write(this, &key, CACHE_FRAG_TYPE_NONE, 100, CACHE_WRITE_OPT_OVERWRITE_SYNC); } int open_write_callout() + override { + CacheTestHeader *h = nullptr; + int hlen = 0; + if (cache_vc->get_header((void **)&h, &hlen) < 0) + return -1; + if (h->serial != 10) + return -1; + header.serial = 11; + cache_vc->set_header(&header, sizeof(header)); + cvio = cache_vc->do_io_write(this, nbytes, buffer_reader); + return 1; + }); replace_test.expect_initial_event = CACHE_EVENT_OPEN_WRITE; replace_test.expect_event = VC_EVENT_WRITE_COMPLETE; replace_test.nbytes = 100; @@ -366,7 +367,7 @@ EXCLUSIVE_REGRESSION_TEST(cache)(RegressionTest *t, int /* atype ATS_UNUSED */, replace_test.content_salt = 1; CACHE_SM( - t, replace_read_test, { cacheProcessor.open_read(this, &key); } int open_read_callout() { + t, replace_read_test, { cacheProcessor.open_read(this, &key); } int open_read_callout() override { CacheTestHeader *h = nullptr; int hlen = 0; if (cache_vc->get_header((void **)&h, &hlen) < 0) @@ -389,7 +390,7 @@ EXCLUSIVE_REGRESSION_TEST(cache)(RegressionTest *t, int /* atype ATS_UNUSED */, rand_CacheKey(&large_write_test.key, thread->mutex); CACHE_SM( - t, pread_test, { cacheProcessor.open_read(this, &key); } int open_read_callout() { + t, pread_test, { cacheProcessor.open_read(this, &key); } int open_read_callout() override { cvio = cache_vc->do_io_pread(this, nbytes, buffer, 7000000); return 1; }); diff --git a/iocore/cache/CacheWrite.cc b/iocore/cache/CacheWrite.cc index 605588d790f..20baeb393f8 100644 --- a/iocore/cache/CacheWrite.cc +++ b/iocore/cache/CacheWrite.cc @@ -288,6 +288,13 @@ iobufferblock_memcpy(char *p, int len, IOBufferBlock *ab, int offset) EvacuationBlock * Vol::force_evacuate_head(Dir *evac_dir, int pinned) { + auto bucket = dir_evac_bucket(evac_dir); + if (!evac_bucket_valid(bucket)) { + DDebug("cache_evac", "dir_evac_bucket out of bounds, skipping evacuate: %ld(%d), %d, %d", bucket, evacuate_size, + (int)dir_offset(evac_dir), (int)dir_phase(evac_dir)); + return nullptr; + } + // build an evacuation block for the object EvacuationBlock *b = evacuation_block_exists(evac_dir, this); // if we have already started evacuating this document, its too late @@ -300,7 +307,7 @@ Vol::force_evacuate_head(Dir *evac_dir, int pinned) b = new_EvacuationBlock(mutex->thread_holding); b->dir = *evac_dir; DDebug("cache_evac", "force: %d, %d", (int)dir_offset(evac_dir), (int)dir_phase(evac_dir)); - evacuate[dir_evac_bucket(evac_dir)].push(b); + evacuate[bucket].push(b); } b->f.pinned = pinned; b->f.evacuate_head = 1; @@ -500,7 +507,7 @@ CacheVC::evacuateDocDone(int /* event ATS_UNUSED */, Event * /* e ATS_UNUSED */) (int)dir_phase(&overwrite_dir), (int)dir_offset(&dir), (int)dir_phase(&dir)); int i = dir_evac_bucket(&overwrite_dir); // nasty beeping race condition, need to have the EvacuationBlock here - EvacuationBlock *b = vol->evacuate[i].head; + EvacuationBlock *b = vol->evac_bucket_valid(i) ? vol->evacuate[i].head : nullptr; for (; b; b = b->link.next) { if (dir_offset(&b->dir) == dir_offset(&overwrite_dir)) { // If the document is single fragment (although not tied to the vector), @@ -651,6 +658,7 @@ Vol::evacuateDocReadDone(int event, Event *e) Doc *doc = reinterpret_cast(doc_evacuator->buf->data()); CacheKey next_key; EvacuationBlock *b = nullptr; + auto bucket = dir_evac_bucket(&doc_evacuator->overwrite_dir); if (doc->magic != DOC_MAGIC) { Debug("cache_evac", "DOC magic: %X %d", (int)dir_tag(&doc_evacuator->overwrite_dir), (int)dir_offset(&doc_evacuator->overwrite_dir)); @@ -660,7 +668,9 @@ Vol::evacuateDocReadDone(int event, Event *e) DDebug("cache_evac", "evacuateDocReadDone %X offset %d", (int)doc->key.slice32(0), (int)dir_offset(&doc_evacuator->overwrite_dir)); - b = evacuate[dir_evac_bucket(&doc_evacuator->overwrite_dir)].head; + if (evac_bucket_valid(bucket)) { + b = evacuate[bucket].head; + } while (b) { if (dir_offset(&b->dir) == dir_offset(&doc_evacuator->overwrite_dir)) { break; @@ -928,7 +938,7 @@ agg_copy(char *p, CacheVC *vc) inline void Vol::evacuate_cleanup_blocks(int i) { - EvacuationBlock *b = evacuate[i].head; + EvacuationBlock *b = evac_bucket_valid(i) ? evacuate[i].head : nullptr; while (b) { if (b->f.done && ((header->phase != dir_phase(&b->dir) && header->write_pos > this->vol_offset(&b->dir)) || (header->phase == dir_phase(&b->dir) && header->write_pos <= this->vol_offset(&b->dir)))) { diff --git a/iocore/cache/Makefile.am b/iocore/cache/Makefile.am index 307f05bf7c4..c38c201718b 100644 --- a/iocore/cache/Makefile.am +++ b/iocore/cache/Makefile.am @@ -105,6 +105,7 @@ test_LDADD = \ $(top_builddir)/iocore/aio/libinkaio.a \ $(top_builddir)/src/tscore/libtscore.la \ $(top_builddir)/lib/records/librecords_p.a \ + $(top_builddir)/lib/fastlz/libfastlz.a \ $(top_builddir)/iocore/eventsystem/libinkevent.a \ @HWLOC_LIBS@ \ @LIBPCRE@ \ @@ -116,7 +117,6 @@ test_LDADD = \ @YAMLCPP_LIBS@ \ -lm -if EXPENSIVE_TESTS check_PROGRAMS = \ test_Cache \ test_RWW \ @@ -129,7 +129,6 @@ check_PROGRAMS = \ test_Update_L_to_S \ test_Update_S_to_L \ test_Update_header -endif test_main_SOURCES = \ ./test/main.cc \ diff --git a/iocore/cache/P_CacheHosting.h b/iocore/cache/P_CacheHosting.h index e6eaa764edf..ba6fecd812d 100644 --- a/iocore/cache/P_CacheHosting.h +++ b/iocore/cache/P_CacheHosting.h @@ -38,7 +38,7 @@ struct CacheHostRecord { int Init(CacheType typ); int Init(matcher_line *line_info, CacheType typ); - void UpdateMatch(CacheHostResult *r, char *rd); + void UpdateMatch(CacheHostResult *r); void Print() const; ~CacheHostRecord() diff --git a/iocore/cache/P_CacheInternal.h b/iocore/cache/P_CacheInternal.h index 756eb14deef..8630d3a064f 100644 --- a/iocore/cache/P_CacheInternal.h +++ b/iocore/cache/P_CacheInternal.h @@ -614,9 +614,9 @@ free_CacheVC(CacheVC *cont) cont->blocks.clear(); cont->writer_buf.clear(); cont->alternate_index = CACHE_ALT_INDEX_DEFAULT; - if (cont->scan_vol_map) { - ats_free(cont->scan_vol_map); - } + + ats_free(cont->scan_vol_map); + memset((char *)&cont->vio, 0, cont->size_to_init); #ifdef CACHE_STAT_PAGES ink_assert(!cont->stat_link.next && !cont->stat_link.prev); diff --git a/iocore/cache/P_CacheTest.h b/iocore/cache/P_CacheTest.h index 47f0cfd3bbe..40d797cdb18 100644 --- a/iocore/cache/P_CacheTest.h +++ b/iocore/cache/P_CacheTest.h @@ -130,7 +130,7 @@ struct CacheTestSM : public RegressionSM { #define CACHE_SM(_t, _sm, _f) \ struct CacheTestSM__##_sm : public CacheTestSM { \ void \ - make_request_internal() _f \ + make_request_internal() override _f \ \ CacheTestSM__##_sm(RegressionTest *t) \ : CacheTestSM(t, #_sm) \ @@ -139,7 +139,7 @@ struct CacheTestSM : public RegressionSM { \ CacheTestSM__##_sm(const CacheTestSM__##_sm &xsm) : CacheTestSM(xsm) {} \ RegressionSM * \ - clone() \ + clone() override \ { \ return new CacheTestSM__##_sm(*this); \ } \ diff --git a/iocore/cache/P_CacheVol.h b/iocore/cache/P_CacheVol.h index 95449289a53..b2f69b13ce2 100644 --- a/iocore/cache/P_CacheVol.h +++ b/iocore/cache/P_CacheVol.h @@ -206,6 +206,12 @@ struct Vol : public Continuation { int dir_check(bool fix); int db_check(bool fix); + bool + evac_bucket_valid(off_t bucket) + { + return (bucket >= 0 && bucket < evacuate_size); + } + int is_io_in_progress() { @@ -456,10 +462,13 @@ int vol_init(Vol *d, char *s, off_t blocks, off_t skip, bool clear); TS_INLINE EvacuationBlock * evacuation_block_exists(Dir *dir, Vol *p) { - EvacuationBlock *b = p->evacuate[dir_evac_bucket(dir)].head; - for (; b; b = b->link.next) - if (dir_offset(&b->dir) == dir_offset(dir)) - return b; + auto bucket = dir_evac_bucket(dir); + if (p->evac_bucket_valid(bucket)) { + EvacuationBlock *b = p->evacuate[bucket].head; + for (; b; b = b->link.next) + if (dir_offset(&b->dir) == dir_offset(dir)) + return b; + } return nullptr; } diff --git a/iocore/cache/test/main.cc b/iocore/cache/test/main.cc index 3585ab68bea..0e2379d3bde 100644 --- a/iocore/cache/test/main.cc +++ b/iocore/cache/test/main.cc @@ -23,10 +23,34 @@ #define CATCH_CONFIG_MAIN #include "main.h" +#include "tscore/ts_file.h" + +#include #define THREADS 1 #define DIAGS_LOG_FILE "diags.log" +// Create a new temp directory and return it +std::string +temp_prefix() +{ + char buffer[PATH_MAX]; + std::error_code err; + const char *tmpdir = getenv("TMPDIR"); + if (tmpdir == nullptr) { + tmpdir = "/tmp"; + } + snprintf(buffer, sizeof(buffer), "%s/cachetest.XXXXXX", tmpdir); + auto prefix = ts::file::path(mkdtemp(buffer)); + bool result = ts::file::create_directories(prefix / "var" / "trafficserver", err, 0755); + if (!result) { + Debug("cache test", "Failed to create directories for test: %s(%s)", prefix.c_str(), err.message().c_str()); + } + ink_assert(result); + + return prefix.string(); +} + void test_done() { @@ -48,7 +72,7 @@ struct EventProcessorListener : Catch::TestEventListenerBase { diags->show_location = SHOW_LOCATION_DEBUG; mime_init(); - Layout::create(); + Layout::create(temp_prefix()); RecProcessInit(RECM_STAND_ALONE); LibRecordsConfigInit(); ink_net_init(ts::ModuleVersion(1, 0, ts::ModuleVersion::PRIVATE)); @@ -66,8 +90,6 @@ struct EventProcessorListener : Catch::TestEventListenerBase { std::string src_dir = std::string(TS_ABS_TOP_SRCDIR) + "/iocore/cache/test"; Layout::get()->sysconfdir = src_dir; - Layout::get()->prefix = src_dir; - ::remove("./test/var/trafficserver/cache.db"); } }; CATCH_REGISTER_LISTENER(EventProcessorListener); diff --git a/iocore/cache/test/stub.cc b/iocore/cache/test/stub.cc index dcc232c1a2c..b247da1bb39 100644 --- a/iocore/cache/test/stub.cc +++ b/iocore/cache/test/stub.cc @@ -21,11 +21,17 @@ limitations under the License. */ +#include + #include "HttpSessionManager.h" #include "HttpBodyFactory.h" #include "DiagsConfig.h" #include "ts/InkAPIPrivateIOCore.h" +#include "tscore/I_Version.h" + +AppVersionInfo appVersionInfo; + void initialize_thread_for_http_sessions(EThread *, int) { @@ -70,6 +76,11 @@ HttpHookState::init(TSHttpHookID id, HttpAPIHooks const *global, HttpAPIHooks co { } +void +api_init() +{ +} + APIHook const * HttpHookState::getNext() { @@ -157,18 +168,19 @@ ts::svtoi(TextView src, TextView *out, int base) } void -HostStatus::setHostStatus(const char *name, TSHostStatus status, const unsigned int down_time, const unsigned int reason) +HostStatus::setHostStatus(const std::string_view name, const TSHostStatus status, const unsigned int down_time, + const unsigned int reason) { } HostStatRec * -HostStatus::getHostStatus(const char *name) +HostStatus::getHostStatus(const std::string_view name) { return nullptr; } void -HostStatus::createHostStat(const char *name, const char *data) +HostStatus::createHostStat(const std::string_view name, const char *data) { } diff --git a/iocore/cache/test/test_RWW.cc b/iocore/cache/test/test_RWW.cc index ee86681d58b..dab2f607195 100644 --- a/iocore/cache/test/test_RWW.cc +++ b/iocore/cache/test/test_RWW.cc @@ -275,7 +275,7 @@ class CacheRWWErrorTest : public CacheRWWTest case VC_EVENT_ERROR: case VC_EVENT_EOS: if (this->_size == LARGE_FILE) { - REQUIRE(base->vio->ndone >= 1 * 1024 * 1024 - sizeof(Doc)); + REQUIRE(base->vio->ndone >= int64_t(1 * 1024 * 1024 - sizeof(Doc))); } else { REQUIRE(base->vio->ndone == 0); } diff --git a/iocore/dns/DNS.cc b/iocore/dns/DNS.cc index e7e9ebd2bbd..9ad2ea32285 100644 --- a/iocore/dns/DNS.cc +++ b/iocore/dns/DNS.cc @@ -524,12 +524,12 @@ DNSHandler::open_con(sockaddr const *target, bool failed, int icon, bool over_tc } return false; } else { - ns_down[icon] = 0; if (cur_con.eio.start(pd, &cur_con, EVENTIO_READ) < 0) { Error("[iocore_dns] open_con: Failed to add %d server to epoll list\n", icon); } else { - cur_con.num = icon; - Debug("dns", "opening connection %s SUCCEEDED for %d", ip_text, icon); + cur_con.num = icon; + ns_down[icon] = 0; + Debug("dns", "opening connection %s on fd %d SUCCEEDED for %d", ip_text, cur_con.fd, icon); } ret = true; } @@ -729,6 +729,15 @@ void DNSHandler::failover() { Debug("dns", "failover: initiating failover attempt, current name_server=%d", name_server); + if (!ns_down[name_server]) { + ip_text_buffer buff; + // mark this nameserver as down + Debug("dns", "failover: Marking nameserver %d as down", name_server); + ns_down[name_server] = 1; + Warning("connection to DNS server %s lost, marking as down", + ats_ip_ntop(&m_res->nsaddr_list[name_server].sa, buff, sizeof(buff))); + } + // no hope, if we have only one server if (m_res->nscount > 1) { ip_text_buffer buff1, buff2; @@ -766,6 +775,8 @@ DNSHandler::failover() ip_text_buffer buff; Warning("failover: connection to DNS server %s lost, retrying", ats_ip_ntop(&ip.sa, buff, sizeof(buff))); } + // Make sure retries are done even if no more requests. + this_ethread()->schedule_in(this, DNS_PRIMARY_RETRY_PERIOD); } /** Mark one of the nameservers as down. */ @@ -779,6 +790,8 @@ DNSHandler::rr_failure(int ndx) Debug("dns", "rr_failure: Marking nameserver %d as down", ndx); ns_down[ndx] = 1; Warning("connection to DNS server %s lost, marking as down", ats_ip_ntop(&m_res->nsaddr_list[ndx].sa, buff, sizeof(buff))); + // Make sure retries are done even if no more requests. + this_ethread()->schedule_in(this, DNS_PRIMARY_RETRY_PERIOD); } int nscount = m_res->nscount; @@ -971,6 +984,11 @@ DNSHandler::check_and_reset_tcp_conn() int DNSHandler::mainEvent(int event, Event *e) { + // If this was a scheduled retry event, clear the associated flag. + if (e && e->cookie == RETRY_COOKIE) { + this->nameserver_retry_in_flight_p = false; + } + recv_dns(event, e); if (dns_ns_rr) { if (DNS_CONN_MODE::TCP_RETRY == dns_conn_mode) { @@ -1017,10 +1035,6 @@ DNSHandler::mainEvent(int event, Event *e) write_dns(this); } - if (std::any_of(ns_down, ns_down + n_con, [](int f) { return f != 0; })) { - this_ethread()->schedule_at(this, DNS_PRIMARY_RETRY_PERIOD); - } - return EVENT_CONT; } diff --git a/iocore/dns/P_DNSProcessor.h b/iocore/dns/P_DNSProcessor.h index 4c16f32f993..7d0bba98d2c 100644 --- a/iocore/dns/P_DNSProcessor.h +++ b/iocore/dns/P_DNSProcessor.h @@ -169,9 +169,16 @@ struct DNSHandler : public Continuation { DNSConnection udpcon[MAX_NAMED]; Queue entries; Queue triggered; - int in_flight = 0; - int name_server = 0; - int in_write_dns = 0; + int in_flight = 0; + int name_server = 0; + int in_write_dns = 0; + /// Rate limiter for down nameserver retries. + /// Don't schedule another if there is already one in flight. + std::atomic nameserver_retry_in_flight_p{false}; + /// Marker for event cookie to indicate it's a nameserver retry event. + /// @note Can't be @c constexpr because of the cast. + static inline void *const RETRY_COOKIE{reinterpret_cast(0x2)}; + HostEnt *hostent_cache = nullptr; int ns_down[MAX_NAMED]; @@ -212,16 +219,16 @@ struct DNSHandler : public Continuation { (ink_hrtime)HRTIME_SECONDS(dns_failover_period)); Debug("dns", "\tdelta time is %" PRId64 "", (Thread::get_hrtime() - crossed_failover_number[i])); } - return (crossed_failover_number[i] && - ((Thread::get_hrtime() - crossed_failover_number[i]) > HRTIME_SECONDS(dns_failover_period))); + return ns_down[i] || (crossed_failover_number[i] && + ((Thread::get_hrtime() - crossed_failover_number[i]) > HRTIME_SECONDS(dns_failover_period))); } bool failover_soon(int i) { - return (crossed_failover_number[i] && - ((Thread::get_hrtime() - crossed_failover_number[i]) > - (HRTIME_SECONDS(dns_failover_try_period + failover_soon_number[i] * FAILOVER_SOON_RETRY)))); + return ns_down[i] || (crossed_failover_number[i] && + ((Thread::get_hrtime() - crossed_failover_number[i]) > + (HRTIME_SECONDS(dns_failover_try_period + failover_soon_number[i] * FAILOVER_SOON_RETRY)))); } void recv_dns(int event, Event *e); diff --git a/iocore/dns/P_SplitDNSProcessor.h b/iocore/dns/P_SplitDNSProcessor.h index 5fa119e5f5a..7424ccfdc7b 100644 --- a/iocore/dns/P_SplitDNSProcessor.h +++ b/iocore/dns/P_SplitDNSProcessor.h @@ -79,7 +79,7 @@ struct SplitDNS : public ConfigInfo { SplitDNS(); ~SplitDNS() override; - void *getDNSRecord(const char *hostname); + void *getDNSRecord(ts::TextView hostname); void findServer(RequestData *rdata, SplitDNSResult *result); DNS_table *m_DNSSrvrTable = nullptr; @@ -116,46 +116,34 @@ SplitDNSConfig::isSplitDNSEnabled() class DNSRequestData : public RequestData { public: - DNSRequestData(); - - char *get_string() override; + DNSRequestData() = default; + char * + get_string() override + { + ink_release_assert(!"Do not get a writeable string from a DNS request"); + }; const char *get_host() override; sockaddr const *get_ip() override; // unused required virtual method. sockaddr const *get_client_ip() override; // unused required virtual method. - const char *m_pHost = nullptr; + ts::TextView m_pHost; }; -/* -------------------------------------------------------------- - DNSRequestData::get_string() - -------------------------------------------------------------- */ -TS_INLINE -DNSRequestData::DNSRequestData() {} - -/* -------------------------------------------------------------- - DNSRequestData::get_string() - -------------------------------------------------------------- */ -TS_INLINE char * -DNSRequestData::get_string() -{ - return ats_strdup((char *)m_pHost); -} - /* -------------------------------------------------------------- DNSRequestData::get_host() -------------------------------------------------------------- */ -TS_INLINE const char * +inline const char * DNSRequestData::get_host() { - return m_pHost; + return m_pHost.data(); } /* -------------------------------------------------------------- DNSRequestData::get_ip() -------------------------------------------------------------- */ -TS_INLINE sockaddr const * +inline sockaddr const * DNSRequestData::get_ip() { return nullptr; @@ -164,7 +152,7 @@ DNSRequestData::get_ip() /* -------------------------------------------------------------- DNSRequestData::get_client_ip() -------------------------------------------------------------- */ -TS_INLINE sockaddr const * +inline sockaddr const * DNSRequestData::get_client_ip() { return nullptr; diff --git a/iocore/dns/SRV.h b/iocore/dns/SRV.h index ff75689e74e..560223636e4 100644 --- a/iocore/dns/SRV.h +++ b/iocore/dns/SRV.h @@ -25,7 +25,6 @@ #include #include "tscore/ink_platform.h" -#include "I_HostDBProcessor.h" struct HostDBInfo; diff --git a/iocore/dns/SplitDNS.cc b/iocore/dns/SplitDNS.cc index 802e97981cd..b993f1e7f51 100644 --- a/iocore/dns/SplitDNS.cc +++ b/iocore/dns/SplitDNS.cc @@ -178,9 +178,9 @@ SplitDNSConfig::print() SplitDNS::getDNSRecord() -------------------------------------------------------------- */ void * -SplitDNS::getDNSRecord(const char *hostname) +SplitDNS::getDNSRecord(ts::TextView hostname) { - Debug("splitdns", "Called SplitDNS::getDNSRecord(%s)", hostname); + Debug("splitdns", "Called SplitDNS::getDNSRecord(%.*s)", int(hostname.size()), hostname.data()); DNSRequestData *pRD = DNSReqAllocator.alloc(); pRD->m_pHost = hostname; @@ -191,7 +191,7 @@ SplitDNS::getDNSRecord(const char *hostname) DNSReqAllocator.free(pRD); if (DNS_SRVR_SPECIFIED == res.r) { - return (void *)&(res.m_rec->m_servers); + return &(res.m_rec->m_servers); } Debug("splitdns", "Fail to match a valid splitdns rule, fallback to default dns resolver"); diff --git a/iocore/eventsystem/I_Event.h b/iocore/eventsystem/I_Event.h index 022f0adc7ec..10aad0ae518 100644 --- a/iocore/eventsystem/I_Event.h +++ b/iocore/eventsystem/I_Event.h @@ -200,6 +200,11 @@ class Event : public Action // inherited from Action::cancel // virtual void cancel(Continuation * c = nullptr); +#ifdef ENABLE_EVENT_TRACKER + void set_location(); + const void *get_location() const; +#endif + void free(); EThread *ethread = nullptr; @@ -239,6 +244,14 @@ class Event : public Action private: void *operator new(size_t size); // use the fast allocators +#ifdef ENABLE_EVENT_TRACKER + /** + Address of who scheduled this event + To get symbols, use backtrace_symbols(3) or external tools like `addr2line(1)` (Linux) or `atos(1)`(BSD). + */ + const void *_location = nullptr; +#endif + public: LINK(Event, link); diff --git a/iocore/eventsystem/I_ProxyAllocator.h b/iocore/eventsystem/I_ProxyAllocator.h index 613b08f0638..cfd16075c1e 100644 --- a/iocore/eventsystem/I_ProxyAllocator.h +++ b/iocore/eventsystem/I_ProxyAllocator.h @@ -83,10 +83,11 @@ void thread_freeup(Allocator &a, ProxyAllocator &l); #endif -#define THREAD_FREE(_p, _a, _t) \ +#define THREAD_FREE(_p, _a, _tin) \ do { \ ::_a.destroy_if_enabled(_p); \ if (!cmd_disable_pfreelist) { \ + Thread *_t = (_tin); \ *(char **)_p = (char *)_t->_a.freelist; \ _t->_a.freelist = _p; \ _t->_a.allocated++; \ diff --git a/iocore/eventsystem/Makefile.am b/iocore/eventsystem/Makefile.am index 3421eb40167..dbffb1098b5 100644 --- a/iocore/eventsystem/Makefile.am +++ b/iocore/eventsystem/Makefile.am @@ -72,7 +72,8 @@ libinkevent_a_SOURCES = \ check_PROGRAMS = test_IOBuffer \ test_EventSystem \ - test_MIOBufferWriter + test_MIOBufferWriter \ + benchmark_ProxyAllocator test_LD_FLAGS = \ @AM_LDFLAGS@ \ @@ -114,6 +115,11 @@ test_MIOBufferWriter_SOURCES = unit_tests/test_MIOBufferWriter.cc test_MIOBufferWriter_CPPFLAGS = $(test_CPP_FLAGS) test_MIOBufferWriter_LDFLAGS = $(test_LD_FLAGS) +benchmark_ProxyAllocator_SOURCES = unit_tests/benchmark_ProxyAllocator.cc +benchmark_ProxyAllocator_CPPFLAGS = $(test_CPP_FLAGS) +benchmark_ProxyAllocator_LDFLAGS = $(test_LD_FLAGS) +benchmark_ProxyAllocator_LDADD = $(test_LD_ADD) + include $(top_srcdir)/build/tidy.mk clang-tidy-local: $(DIST_SOURCES) diff --git a/iocore/eventsystem/P_UnixEThread.h b/iocore/eventsystem/P_UnixEThread.h index e4e8cb8e832..50d1885bcbc 100644 --- a/iocore/eventsystem/P_UnixEThread.h +++ b/iocore/eventsystem/P_UnixEThread.h @@ -32,6 +32,7 @@ #include "I_EThread.h" #include "I_EventProcessor.h" +#include const ink_hrtime DELAY_FOR_RETRY = HRTIME_MSECONDS(10); extern ink_thread_key ethread_key; @@ -39,7 +40,12 @@ extern ink_thread_key ethread_key; TS_INLINE Event * EThread::schedule_imm(Continuation *cont, int callback_event, void *cookie) { - Event *e = ::eventAllocator.alloc(); + Event *e = ::eventAllocator.alloc(); + +#ifdef ENABLE_EVENT_TRACKER + e->set_location(); +#endif + e->callback_event = callback_event; e->cookie = cookie; return schedule(e->init(cont, 0, 0)); @@ -48,7 +54,12 @@ EThread::schedule_imm(Continuation *cont, int callback_event, void *cookie) TS_INLINE Event * EThread::schedule_at(Continuation *cont, ink_hrtime t, int callback_event, void *cookie) { - Event *e = ::eventAllocator.alloc(); + Event *e = ::eventAllocator.alloc(); + +#ifdef ENABLE_EVENT_TRACKER + e->set_location(); +#endif + e->callback_event = callback_event; e->cookie = cookie; return schedule(e->init(cont, t, 0)); @@ -57,7 +68,12 @@ EThread::schedule_at(Continuation *cont, ink_hrtime t, int callback_event, void TS_INLINE Event * EThread::schedule_in(Continuation *cont, ink_hrtime t, int callback_event, void *cookie) { - Event *e = ::eventAllocator.alloc(); + Event *e = ::eventAllocator.alloc(); + +#ifdef ENABLE_EVENT_TRACKER + e->set_location(); +#endif + e->callback_event = callback_event; e->cookie = cookie; return schedule(e->init(cont, get_hrtime() + t, 0)); @@ -66,7 +82,12 @@ EThread::schedule_in(Continuation *cont, ink_hrtime t, int callback_event, void TS_INLINE Event * EThread::schedule_every(Continuation *cont, ink_hrtime t, int callback_event, void *cookie) { - Event *e = ::eventAllocator.alloc(); + Event *e = ::eventAllocator.alloc(); + +#ifdef ENABLE_EVENT_TRACKER + e->set_location(); +#endif + e->callback_event = callback_event; e->cookie = cookie; if (t < 0) { @@ -108,7 +129,12 @@ EThread::schedule(Event *e) TS_INLINE Event * EThread::schedule_imm_local(Continuation *cont, int callback_event, void *cookie) { - Event *e = EVENT_ALLOC(eventAllocator, this); + Event *e = EVENT_ALLOC(eventAllocator, this); + +#ifdef ENABLE_EVENT_TRACKER + e->set_location(); +#endif + e->callback_event = callback_event; e->cookie = cookie; return schedule_local(e->init(cont, 0, 0)); @@ -117,7 +143,12 @@ EThread::schedule_imm_local(Continuation *cont, int callback_event, void *cookie TS_INLINE Event * EThread::schedule_at_local(Continuation *cont, ink_hrtime t, int callback_event, void *cookie) { - Event *e = EVENT_ALLOC(eventAllocator, this); + Event *e = EVENT_ALLOC(eventAllocator, this); + +#ifdef ENABLE_EVENT_TRACKER + e->set_location(); +#endif + e->callback_event = callback_event; e->cookie = cookie; return schedule_local(e->init(cont, t, 0)); @@ -126,7 +157,12 @@ EThread::schedule_at_local(Continuation *cont, ink_hrtime t, int callback_event, TS_INLINE Event * EThread::schedule_in_local(Continuation *cont, ink_hrtime t, int callback_event, void *cookie) { - Event *e = EVENT_ALLOC(eventAllocator, this); + Event *e = EVENT_ALLOC(eventAllocator, this); + +#ifdef ENABLE_EVENT_TRACKER + e->set_location(); +#endif + e->callback_event = callback_event; e->cookie = cookie; return schedule_local(e->init(cont, get_hrtime() + t, 0)); @@ -135,7 +171,12 @@ EThread::schedule_in_local(Continuation *cont, ink_hrtime t, int callback_event, TS_INLINE Event * EThread::schedule_every_local(Continuation *cont, ink_hrtime t, int callback_event, void *cookie) { - Event *e = EVENT_ALLOC(eventAllocator, this); + Event *e = EVENT_ALLOC(eventAllocator, this); + +#ifdef ENABLE_EVENT_TRACKER + e->set_location(); +#endif + e->callback_event = callback_event; e->cookie = cookie; if (t < 0) { diff --git a/iocore/eventsystem/P_UnixEventProcessor.h b/iocore/eventsystem/P_UnixEventProcessor.h index a8ba4f475a1..9feec535b93 100644 --- a/iocore/eventsystem/P_UnixEventProcessor.h +++ b/iocore/eventsystem/P_UnixEventProcessor.h @@ -135,6 +135,11 @@ EventProcessor::schedule_imm(Continuation *cont, EventType et, int callback_even #ifdef ENABLE_TIME_TRACE e->start_time = Thread::get_hrtime(); #endif + +#ifdef ENABLE_EVENT_TRACKER + e->set_location(); +#endif + e->callback_event = callback_event; e->cookie = cookie; return schedule(e->init(cont, 0, 0), et); @@ -147,6 +152,11 @@ EventProcessor::schedule_at(Continuation *cont, ink_hrtime t, EventType et, int ink_assert(t > 0); ink_assert(et < MAX_EVENT_TYPES); + +#ifdef ENABLE_EVENT_TRACKER + e->set_location(); +#endif + e->callback_event = callback_event; e->cookie = cookie; return schedule(e->init(cont, t, 0), et); @@ -158,6 +168,11 @@ EventProcessor::schedule_in(Continuation *cont, ink_hrtime t, EventType et, int Event *e = eventAllocator.alloc(); ink_assert(et < MAX_EVENT_TYPES); + +#ifdef ENABLE_EVENT_TRACKER + e->set_location(); +#endif + e->callback_event = callback_event; e->cookie = cookie; return schedule(e->init(cont, Thread::get_hrtime() + t, 0), et); @@ -170,6 +185,11 @@ EventProcessor::schedule_every(Continuation *cont, ink_hrtime t, EventType et, i ink_assert(t != 0); ink_assert(et < MAX_EVENT_TYPES); + +#ifdef ENABLE_EVENT_TRACKER + e->set_location(); +#endif + e->callback_event = callback_event; e->cookie = cookie; if (t < 0) { diff --git a/iocore/eventsystem/UnixEvent.cc b/iocore/eventsystem/UnixEvent.cc index b5589aedd10..983cf7a2632 100644 --- a/iocore/eventsystem/UnixEvent.cc +++ b/iocore/eventsystem/UnixEvent.cc @@ -29,6 +29,8 @@ *****************************************************************************/ #include "P_EventSystem.h" +#include "tscore/ink_stack_trace.h" + ClassAllocator eventAllocator("eventAllocator", 256); void @@ -104,3 +106,19 @@ Event::schedule_every(ink_hrtime aperiod, int acallback_event) ethread->EventQueueExternal.enqueue_local(this); } } + +#ifdef ENABLE_EVENT_TRACKER + +void +Event::set_location() +{ + _location = ink_backtrace(3); +} + +const void * +Event::get_location() const +{ + return _location; +} + +#endif diff --git a/iocore/eventsystem/UnixEventProcessor.cc b/iocore/eventsystem/UnixEventProcessor.cc index c3a30fe494c..ec860943d42 100644 --- a/iocore/eventsystem/UnixEventProcessor.cc +++ b/iocore/eventsystem/UnixEventProcessor.cc @@ -30,6 +30,7 @@ #include #endif #include "tscore/ink_defs.h" +#include "tscore/ink_hw.h" #include "tscore/hugepages.h" /// Global singleton. diff --git a/iocore/eventsystem/unit_tests/benchmark_ProxyAllocator.cc b/iocore/eventsystem/unit_tests/benchmark_ProxyAllocator.cc new file mode 100644 index 00000000000..660ddcc3c71 --- /dev/null +++ b/iocore/eventsystem/unit_tests/benchmark_ProxyAllocator.cc @@ -0,0 +1,112 @@ +/** @file + +Simple benchmark for ProxyAllocator + +@section license License + +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"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 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +#define CATCH_CONFIG_ENABLE_BENCHMARKING +#define CATCH_CONFIG_MAIN +#include "catch.hpp" + +#include "I_EventSystem.h" +#include "I_Thread.h" +#include "tscore/Allocator.h" + +namespace +{ +class BThread : public Thread +{ +public: + void + set_specific() override + { + Thread::set_specific(); + } + + void + execute() override + { + } +}; + +struct BItem { + char buffer[128]; +}; + +} // namespace + +// THREAD_ALLOC/FREE requires allocators be global variables and are named after one of the defined ProxyAllocator members +ClassAllocator ioAllocator("io"); + +#define OLD_THREAD_FREE(_p, _a, _t) \ + do { \ + ::_a.destroy_if_enabled(_p); \ + if (!cmd_disable_pfreelist) { \ + *(char **)_p = (char *)_t->_a.freelist; \ + _t->_a.freelist = _p; \ + _t->_a.allocated++; \ + if (thread_freelist_high_watermark > 0 && _t->_a.allocated > thread_freelist_high_watermark) \ + thread_freeup(::_a.raw(), _t->_a); \ + } else { \ + ::_a.raw().free_void(_p); \ + } \ + } while (0) + +TEST_CASE("ProxyAllocator", "[iocore]") +{ + Thread *bench_thread = new BThread(); + bench_thread->set_specific(); + int count = 10000; + + // set higher than iteration count so the freeup doesn't run during benchmark + thread_freelist_high_watermark = count + 1; + + BENCHMARK("thread_free old") + { + auto items = std::vector(); + items.reserve(count); + for (int i = 0; i < count; i++) { + auto *item = THREAD_ALLOC(ioAllocator, this_thread()); + items.push_back(item); + } + + for (auto item : items) { + OLD_THREAD_FREE(item, ioAllocator, this_thread()); + } + return bench_thread->ioAllocator.allocated; + }; + + BENCHMARK("thread_free new") + { + auto items = std::vector(); + items.reserve(count); + for (int i = 0; i < count; i++) { + auto *item = THREAD_ALLOC(ioAllocator, this_thread()); + items.push_back(item); + } + + for (auto item : items) { + THREAD_FREE(item, ioAllocator, this_thread()); + } + return bench_thread->ioAllocator.allocated; + }; + + delete bench_thread; +} diff --git a/iocore/hostdb/HostDB.cc b/iocore/hostdb/HostDB.cc index 89968f6ca03..9a1ab5cce30 100644 --- a/iocore/hostdb/HostDB.cc +++ b/iocore/hostdb/HostDB.cc @@ -26,14 +26,18 @@ #include "P_RefCountCacheSerializer.h" #include "tscore/I_Layout.h" #include "Show.h" -#include "tscore/Tokenizer.h" +#include "tscore/ts_file.h" #include "tscore/ink_apidefs.h" +#include "tscore/bwf_std_format.h" #include #include #include #include #include +#include + +using ts::TextView; HostDBProcessor hostDBProcessor; int HostDBProcessor::hostdb_strict_round_robin = 0; @@ -50,78 +54,215 @@ unsigned int hostdb_ip_stale_interval = HOST_DB_IP_STALE; unsigned int hostdb_ip_timeout_interval = HOST_DB_IP_TIMEOUT; unsigned int hostdb_ip_fail_timeout_interval = HOST_DB_IP_FAIL_TIMEOUT; unsigned int hostdb_serve_stale_but_revalidate = 0; -unsigned int hostdb_hostfile_check_interval = 86400; // 1 day +ts_seconds hostdb_hostfile_check_interval{std::chrono::hours(24)}; // Epoch timestamp of the current hosts file check. -ink_time_t hostdb_current_interval = 0; +ts_time hostdb_current_interval{TS_TIME_ZERO}; // Epoch timestamp of the last time we actually checked for a hosts file update. -static ink_time_t hostdb_last_interval = 0; +static ts_time hostdb_last_interval{TS_TIME_ZERO}; // Epoch timestamp when we updated the hosts file last. -static ink_time_t hostdb_hostfile_update_timestamp = 0; -static char hostdb_filename[PATH_NAME_MAX] = DEFAULT_HOST_DB_FILENAME; -int hostdb_max_count = DEFAULT_HOST_DB_SIZE; -char hostdb_hostfile_path[PATH_NAME_MAX] = ""; -int hostdb_sync_frequency = 0; -int hostdb_disable_reverse_lookup = 0; -int hostdb_max_iobuf_index = BUFFER_SIZE_INDEX_32K; - -// Verify the generic storage is sufficient to cover all alternate members. -static_assert(sizeof(HostDBApplicationInfo::allotment) == sizeof(HostDBApplicationInfo), - "Generic storage for HostDBApplicationInfo is smaller than the union storage."); +static ts_time hostdb_hostfile_update_timestamp{TS_TIME_ZERO}; +static char hostdb_filename[PATH_NAME_MAX] = DEFAULT_HOST_DB_FILENAME; +int hostdb_max_count = DEFAULT_HOST_DB_SIZE; +static ts::file::path hostdb_hostfile_path; +ts_seconds hostdb_sync_frequency{0}; +int hostdb_disable_reverse_lookup = 0; +int hostdb_max_iobuf_index = BUFFER_SIZE_INDEX_32K; ClassAllocator hostDBContAllocator("hostDBContAllocator"); +namespace +{ +/** Assign raw storage to an @c IpAddr + * + * @param ip Destination. + * @param af IP family. + * @param ptr Raw data for an address of family @a af. + */ +void +ip_addr_set(IpAddr &ip, ///< Target storage. + uint8_t af, ///< Address format. + void const *ptr ///< Raw address data +) +{ + if (AF_INET6 == af) { + ip = *static_cast(ptr); + } else if (AF_INET == af) { + ip = *static_cast(ptr); + } else { + ip.invalidate(); + } +} + +unsigned int +HOSTDB_CLIENT_IP_HASH(sockaddr const *lhs, IpAddr const &rhs) +{ + unsigned int zret = ~static_cast(0); + if (lhs->sa_family == rhs.family()) { + if (rhs.isIp4()) { + in_addr_t ip1 = ats_ip4_addr_cast(lhs); + in_addr_t ip2 = rhs._addr._ip4; + zret = (ip1 >> 16) ^ ip1 ^ ip2 ^ (ip2 >> 16); + } else if (rhs.isIp6()) { + uint32_t const *ip1 = ats_ip_addr32_cast(lhs); + uint32_t const *ip2 = rhs._addr._u32; + for (int i = 0; i < 4; ++i, ++ip1, ++ip2) { + zret ^= (*ip1 >> 16) ^ *ip1 ^ *ip2 ^ (*ip2 >> 16); + } + } + } + return zret & 0xFFFF; +} + +} // namespace + +char const * +name_of(HostDBType t) +{ + switch (t) { + case HostDBType::UNSPEC: + return "*"; + case HostDBType::ADDR: + return "Address"; + case HostDBType::SRV: + return "SRV"; + case HostDBType::HOST: + return "Reverse DNS"; + } + return ""; +} + +/** Template for creating conversions and initialization for @c std::chrono based configuration variables. + * + * @tparam V The exact type of the configuration variable. + * + * The tricky template code is to enable having a class instance for each configuration variable, instead of for each _type_ of + * configuration variable. This is required because the callback interface requires functions and so the actual storage must be + * accessible from that function. * + */ +template struct ConfigDuration { + using self_type = ConfigDuration; + V *_var; ///< Pointer to the variable to control. + + /** Constructor. + * + * @param v The variable to update. + */ + ConfigDuration(V &v) : _var(&v) {} + + /// Convert to the mgmt (configuration) type. + static MgmtInt + to_mgmt(void const *data) + { + return static_cast(static_cast(data)->count()); + } + + /// Convert from the mgmt (configuration) type. + static void + from_mgmt(void *data, MgmtInt i) + { + *static_cast(data) = V{i}; + } + + /// The conversion structure, which handles @c MgmtInt. + static inline const MgmtConverter Conversions{&to_mgmt, &from_mgmt}; + + /** Process start up conversion from configuration. + * + * @param type The data type in the configuration. + * @param data The data in the configuration. + * @param var Pointer to the variable to update. + * @return @c true if @a data was successfully converted and stored, @c false if not. + * + * @note @a var is the target variable because it was explicitly set to be the value of @a _var in @c Enable. + */ + static bool + callback(char const *, RecDataT type, RecData data, void *var) + { + if (RECD_INT == type) { + (*self_type::Conversions.store_int)(var, data.rec_int); + return true; + } + return false; + } + + /** Enable. + * + * @param name Name of the configuration variable. + * + * This enables both reading from the configuration and handling the callback for dynamic + * updates of the variable. + */ + void + Enable(std::string_view name) + { + Enable_Config_Var(name, &self_type::callback, _var); + } +}; + +ConfigDuration HostDBDownServerCacheTimeVar{HttpConfig::m_master.oride.down_server_timeout}; +// Make the conversions visible to the plugin API. This allows exporting just the conversions +// without having to export the class definition. Again, the compiler doesn't allow doing this +// in one line. +extern MgmtConverter const &HostDBDownServerCacheTimeConv; +MgmtConverter const &HostDBDownServerCacheTimeConv = HostDBDownServerCacheTimeVar.Conversions; + +// Not run time configurable, therefore no support beyond this class needed. +ConfigDuration HostDBSyncFrequencyVar{hostdb_sync_frequency}; + +void +HostDB_Config_Init() +{ + HostDBDownServerCacheTimeVar.Enable("proxy.config.http.down_server.cache_time"); + HostDBSyncFrequencyVar.Enable("proxy.config.cache.hostdb.sync_frequency"); +} + // Static configuration information HostDBCache hostDB; -void ParseHostFile(const char *path, unsigned int interval); +void ParseHostFile(ts::file::path const &path, ts_seconds interval); -char * -HostDBInfo::srvname(HostDBRoundRobin *rr) const +auto +HostDBInfo::assign(sa_family_t af, void const *addr) -> self_type & { - if (!is_srv || !data.srv.srv_offset) { - return nullptr; - } - return reinterpret_cast(rr) + data.srv.srv_offset; + type = HostDBType::ADDR; + ip_addr_set(data.ip, af, addr); + return *this; } -static inline bool -is_addr_valid(uint8_t af, ///< Address family (format of data) - void *ptr ///< Raw address data (not a sockaddr variant!) -) +auto +HostDBInfo::assign(IpAddr const &addr) -> self_type & { - return (AF_INET == af && INADDR_ANY != *(reinterpret_cast(ptr))) || - (AF_INET6 == af && !IN6_IS_ADDR_UNSPECIFIED(reinterpret_cast(ptr))); + type = HostDBType::ADDR; + data.ip = addr; + return *this; } -static inline void -ip_addr_set(sockaddr *ip, ///< Target storage, sockaddr compliant. - uint8_t af, ///< Address format. - void *ptr ///< Raw address data -) +auto +HostDBInfo::assign(SRV const *srv, char const *name) -> self_type & { - if (AF_INET6 == af) { - ats_ip6_set(ip, *static_cast(ptr)); - } else if (AF_INET == af) { - ats_ip4_set(ip, *static_cast(ptr)); - } else { - ats_ip_invalidate(ip); - } + type = HostDBType::SRV; + data.srv.srv_weight = srv->weight; + data.srv.srv_priority = srv->priority; + data.srv.srv_port = srv->port; + data.srv.key = srv->key; + data.srv.srv_offset = reinterpret_cast(this) - name; + return *this; +} + +char const * +HostDBInfo::srvname() const +{ + return data.srv.srv_offset ? reinterpret_cast(this) + data.srv.srv_offset : nullptr; } -static inline void -ip_addr_set(IpAddr &ip, ///< Target storage. - uint8_t af, ///< Address format. - void *ptr ///< Raw address data +static inline bool +is_addr_valid(uint8_t af, ///< Address family (format of data) + void *ptr ///< Raw address data (not a sockaddr variant!) ) { - if (AF_INET6 == af) { - ip = *static_cast(ptr); - } else if (AF_INET == af) { - ip = *static_cast(ptr); - } else { - ip.invalidate(); - } + return (AF_INET == af && INADDR_ANY != *(reinterpret_cast(ptr))) || + (AF_INET6 == af && !IN6_IS_ADDR_UNSPECIFIED(reinterpret_cast(ptr))); } inline void @@ -169,18 +310,12 @@ string_for(HostDBMark mark) static Action *register_ShowHostDB(Continuation *c, HTTPHdr *h); HostDBHash & -HostDBHash::set_host(const char *name, int len) +HostDBHash::set_host(TextView name) { host_name = name; - host_len = len; - if (host_name && SplitDNSConfig::isSplitDNSEnabled()) { - const char *scan; - // I think this is checking for a hostname that is just an address. - for (scan = host_name; *scan != '\0' && (ParseRules::is_digit(*scan) || '.' == *scan || ':' == *scan); ++scan) { - ; - } - if ('\0' != *scan) { + if (!host_name.empty() && SplitDNSConfig::isSplitDNSEnabled()) { + if (TS_SUCCESS != ip.load(host_name)) { // config is released in the destructor, because we must make sure values we // get out of it don't evaporate while @a this is still around. if (!pSD) { @@ -206,7 +341,7 @@ HostDBHash::refresh() const char *server_line = dns_server ? dns_server->x_dns_ip_line : nullptr; uint8_t m = static_cast(db_mark); // be sure of the type. - ctx.update(host_name, host_len); + ctx.update(host_name.data(), host_name.size()); ctx.update(reinterpret_cast(&port), sizeof(port)); ctx.update(&m, sizeof(m)); if (server_line) { @@ -235,10 +370,7 @@ HostDBHash::~HostDBHash() } } -HostDBCache::HostDBCache() -{ - hosts_file_ptr = new RefCountedHostsFileMap(); -} +HostDBCache::HostDBCache() {} bool HostDBCache::is_pending_dns_for_hash(const CryptoHash &hash) @@ -252,6 +384,14 @@ HostDBCache::is_pending_dns_for_hash(const CryptoHash &hash) return false; } +std::shared_ptr +HostDBCache::acquire_host_file() +{ + std::shared_lock lock(host_file_mutex); + auto zret = host_file; + return zret; +} + HostDBCache * HostDBProcessor::cache() { @@ -259,16 +399,16 @@ HostDBProcessor::cache() } struct HostDBBackgroundTask : public Continuation { - int frequency; - ink_hrtime start_time; + ts_seconds frequency; + ts_hr_time start_time; virtual int sync_event(int event, void *edata) = 0; int wait_event(int event, void *edata); - HostDBBackgroundTask(int frequency); + HostDBBackgroundTask(ts_seconds frequency); }; -HostDBBackgroundTask::HostDBBackgroundTask(int frequency) : Continuation(new_ProxyMutex()), frequency(frequency), start_time(0) +HostDBBackgroundTask::HostDBBackgroundTask(ts_seconds frequency) : Continuation(new_ProxyMutex()), frequency(frequency) { SET_HANDLER(&HostDBBackgroundTask::sync_event); } @@ -276,11 +416,11 @@ HostDBBackgroundTask::HostDBBackgroundTask(int frequency) : Continuation(new_Pro int HostDBBackgroundTask::wait_event(int, void *) { - ink_hrtime next_sync = HRTIME_SECONDS(this->frequency) - (Thread::get_hrtime() - start_time); + auto next_sync = this->frequency - (ts_hr_clock::now() - start_time); SET_HANDLER(&HostDBBackgroundTask::sync_event); - if (next_sync > HRTIME_MSECONDS(100)) { - eventProcessor.schedule_in(this, next_sync, ET_TASK); + if (next_sync > ts_milliseconds{100}) { + eventProcessor.schedule_in(this, std::chrono::duration_cast(next_sync).count(), ET_TASK); } else { eventProcessor.schedule_imm(this, ET_TASK); } @@ -290,16 +430,16 @@ HostDBBackgroundTask::wait_event(int, void *) struct HostDBSync : public HostDBBackgroundTask { std::string storage_path; std::string full_path; - HostDBSync(int frequency, const std::string &storage_path, const std::string &full_path) + HostDBSync(ts_seconds frequency, const std::string &storage_path, const std::string &full_path) : HostDBBackgroundTask(frequency), storage_path(std::move(storage_path)), full_path(std::move(full_path)){}; int sync_event(int, void *) override { SET_HANDLER(&HostDBSync::wait_event); - start_time = Thread::get_hrtime(); + start_time = ts_hr_clock::now(); - new RefCountCacheSerializer(this, hostDBProcessor.cache()->refcountcache, this->frequency, this->storage_path, - this->full_path); + new RefCountCacheSerializer(this, hostDBProcessor.cache()->refcountcache, this->frequency.count(), + this->storage_path, this->full_path); return EVENT_DONE; } }; @@ -327,8 +467,6 @@ HostDBCache::start(int flags) REC_ReadConfigInteger(hostdb_max_size, "proxy.config.hostdb.max_size"); // number of partitions REC_ReadConfigInt32(hostdb_partitions, "proxy.config.hostdb.partitions"); - // how often to sync hostdb to disk - REC_EstablishStaticConfigInt32(hostdb_sync_frequency, "proxy.config.cache.hostdb.sync_frequency"); REC_EstablishStaticConfigInt32(hostdb_max_iobuf_index, "proxy.config.hostdb.io.max_buffer_index"); @@ -337,13 +475,13 @@ HostDBCache::start(int flags) } // Setup the ref-counted cache (this must be done regardless of syncing or not). - this->refcountcache = new RefCountCache(hostdb_partitions, hostdb_max_size, hostdb_max_count, HostDBInfo::version(), - "proxy.process.hostdb.cache."); + this->refcountcache = new RefCountCache(hostdb_partitions, hostdb_max_size, hostdb_max_count, HostDBRecord::Version, + "proxy.process.hostdb.cache."); // // Load and sync HostDB, if we've asked for it. // - if (hostdb_sync_frequency > 0) { + if (hostdb_sync_frequency.count() > 0) { // If proxy.config.hostdb.storage_path is not set, use the local state dir. If it is set to // a relative path, make it relative to the prefix. if (storage_path[0] == '\0') { @@ -366,7 +504,7 @@ HostDBCache::start(int flags) Debug("hostdb", "Opening %s, partitions=%d storage_size=%" PRIu64 " items=%d", full_path, hostdb_partitions, hostdb_max_size, hostdb_max_count); - int load_ret = LoadRefCountCacheFromPath(*this->refcountcache, full_path, HostDBInfo::unmarshall); + int load_ret = LoadRefCountCacheFromPath(*this->refcountcache, full_path, HostDBRecord::unmarshall); if (load_ret != 0) { Warning("Error loading cache from %s: %d", full_path, load_ret); } @@ -411,13 +549,12 @@ HostDBProcessor::start(int, size_t) REC_EstablishStaticConfigInt32U(hostdb_ip_stale_interval, "proxy.config.hostdb.verify_after"); REC_EstablishStaticConfigInt32U(hostdb_ip_fail_timeout_interval, "proxy.config.hostdb.fail.timeout"); REC_EstablishStaticConfigInt32U(hostdb_serve_stale_but_revalidate, "proxy.config.hostdb.serve_stale_for"); - REC_EstablishStaticConfigInt32U(hostdb_hostfile_check_interval, "proxy.config.hostdb.host_file.interval"); REC_EstablishStaticConfigInt32U(hostdb_round_robin_max_count, "proxy.config.hostdb.round_robin_max_count"); // // Set up hostdb_current_interval // - hostdb_current_interval = ink_time(); + hostdb_current_interval = ts_clock::now(); HostDBContinuation *b = hostDBContAllocator.alloc(); SET_CONTINUATION_HANDLER(b, (HostDBContHandler)&HostDBContinuation::backgroundEvent); @@ -430,18 +567,14 @@ HostDBProcessor::start(int, size_t) void HostDBContinuation::init(HostDBHash const &the_hash, Options const &opt) { - hash = the_hash; - if (hash.host_name) { + hash = the_hash; + hash.host_name = hash.host_name.prefix(static_cast(sizeof(hash_host_name_store) - 1)); + if (!hash.host_name.empty()) { // copy to backing store. - if (hash.host_len > static_cast(sizeof(hash_host_name_store) - 1)) { - hash.host_len = sizeof(hash_host_name_store) - 1; - } - memcpy(hash_host_name_store, hash.host_name, hash.host_len); - } else { - hash.host_len = 0; + memcpy(hash_host_name_store, hash.host_name); } - hash_host_name_store[hash.host_len] = 0; - hash.host_name = hash_host_name_store; + hash_host_name_store[hash.host_name.size()] = 0; + hash.host_name.assign(hash_host_name_store, hash.host_name.size()); host_res_style = opt.host_res_style; dns_lookup_timeout = opt.timeout; @@ -460,7 +593,7 @@ HostDBContinuation::refresh_hash() { Ptr old_bucket_mutex = hostDB.refcountcache->lock_for_key(hash.hash.fold()); // We're not pending DNS anymore. - remove_trigger_pending_dns(); + remove_and_trigger_pending_dns(); hash.refresh(); // Update the mutex if it's from the bucket. // Some call sites modify this after calling @c init so need to check. @@ -470,34 +603,22 @@ HostDBContinuation::refresh_hash() } static bool -reply_to_cont(Continuation *cont, HostDBInfo *r, bool is_srv = false) +reply_to_cont(Continuation *cont, HostDBRecord *r, bool is_srv = false) { - if (r == nullptr || r->is_srv != is_srv || r->is_failed()) { + if (r == nullptr || r->is_srv() != is_srv || r->is_failed()) { cont->handleEvent(is_srv ? EVENT_SRV_LOOKUP : EVENT_HOST_DB_LOOKUP, nullptr); return false; } - if (r->reverse_dns) { - if (!r->hostname()) { + if (r->record_type != HostDBType::HOST) { + if (!r->name()) { ink_assert(!"missing hostname"); cont->handleEvent(is_srv ? EVENT_SRV_LOOKUP : EVENT_HOST_DB_LOOKUP, nullptr); Warning("bogus entry deleted from HostDB: missing hostname"); hostDB.refcountcache->erase(r->key); return false; } - Debug("hostdb", "hostname = %s", r->hostname()); - } - - if (!r->is_srv && r->round_robin) { - if (!r->rr()) { - ink_assert(!"missing round-robin"); - cont->handleEvent(is_srv ? EVENT_SRV_LOOKUP : EVENT_HOST_DB_LOOKUP, nullptr); - Warning("bogus entry deleted from HostDB: missing round-robin"); - hostDB.refcountcache->erase(r->key); - return false; - } - ip_text_buffer ipb; - Debug("hostdb", "RR of %d with %d good, 1st IP = %s", r->rr()->rrcount, r->rr()->good, ats_ip_ntop(r->ip(), ipb, sizeof ipb)); + Debug("hostdb", "hostname = %s", r->name()); } cont->handleEvent(is_srv ? EVENT_SRV_LOOKUP : EVENT_HOST_DB_LOOKUP, r); @@ -541,73 +662,57 @@ db_mark_for(IpAddr const &ip) return ip.isIp6() ? HOSTDB_MARK_IPV6 : HOSTDB_MARK_IPV4; } -Ptr +HostDBRecord::Handle probe(const Ptr &mutex, HostDBHash const &hash, bool ignore_timeout) { + static const Ptr NO_RECORD; + // If hostdb is disabled, don't return anything if (!hostdb_enable) { - return Ptr(); + return NO_RECORD; } // Otherwise HostDB is enabled, so we'll do our thing ink_assert(this_ethread() == hostDB.refcountcache->lock_for_key(hash.hash.fold())->thread_holding); uint64_t folded_hash = hash.hash.fold(); - // get the item from cache - Ptr r = hostDB.refcountcache->get(folded_hash); + // get the record from cache + Ptr record = hostDB.refcountcache->get(folded_hash); // If there was nothing in the cache-- this is a miss - if (r.get() == nullptr) { - return r; + if (record.get() == nullptr) { + return record; } // If the dns response was failed, and we've hit the failed timeout, lets stop returning it - if (r->is_failed() && r->is_ip_fail_timeout()) { - return make_ptr((HostDBInfo *)nullptr); - // if we aren't ignoring timeouts, and we are past it-- then remove the item - } else if (!ignore_timeout && r->is_ip_timeout() && !r->serve_stale_but_revalidate()) { + if (record->is_failed() && record->is_ip_fail_timeout()) { + return NO_RECORD; + // if we aren't ignoring timeouts, and we are past it-- then remove the record + } else if (!ignore_timeout && record->is_ip_timeout() && !record->serve_stale_but_revalidate()) { HOSTDB_INCREMENT_DYN_STAT(hostdb_ttl_expires_stat); - return make_ptr((HostDBInfo *)nullptr); + return NO_RECORD; } // If the record is stale, but we want to revalidate-- lets start that up - if ((!ignore_timeout && r->is_ip_stale() && !r->reverse_dns) || (r->is_ip_timeout() && r->serve_stale_but_revalidate())) { + if ((!ignore_timeout && record->is_ip_stale() && record->record_type != HostDBType::HOST) || + (record->is_ip_timeout() && record->serve_stale_but_revalidate())) { if (hostDB.is_pending_dns_for_hash(hash.hash)) { - Debug("hostdb", "stale %u %u %u, using it and pending to refresh it", r->ip_interval(), r->ip_timestamp, - r->ip_timeout_interval); - return r; - } - Debug("hostdb", "stale %u %u %u, using it and refreshing it", r->ip_interval(), r->ip_timestamp, r->ip_timeout_interval); + Debug("hostdb", "%s", + ts::bwprint(ts::bw_dbg, "stale {} {} {}, using with pending refresh", record->ip_interval(), + record->ip_timestamp.time_since_epoch(), record->ip_timeout_interval) + .c_str()); + return record; + } + Debug("hostdb", "%s", + ts::bwprint(ts::bw_dbg, "stale {} {} {}, using while refresh", record->ip_interval(), + record->ip_timestamp.time_since_epoch(), record->ip_timeout_interval) + .c_str()); HostDBContinuation *c = hostDBContAllocator.alloc(); HostDBContinuation::Options copt; - copt.host_res_style = host_res_style_for(r->ip()); + copt.host_res_style = record->af_family == AF_INET6 ? HOST_RES_IPV6_ONLY : HOST_RES_IPV4_ONLY; c->init(hash, copt); c->do_dns(); } - return r; -} - -// -// Insert a HostDBInfo into the database -// A null value indicates that the block is empty. -// -HostDBInfo * -HostDBContinuation::insert(unsigned int attl) -{ - uint64_t folded_hash = hash.hash.fold(); - - ink_assert(this_ethread() == hostDB.refcountcache->lock_for_key(folded_hash)->thread_holding); - - HostDBInfo *r = HostDBInfo::alloc(); - r->key = folded_hash; - - r->ip_timestamp = hostdb_current_interval; - r->ip_timeout_interval = std::clamp(attl, 1u, HOST_DB_MAX_TTL); - - Debug("hostdb", "inserting for: %.*s: (hash: %" PRIx64 ") now: %u timeout: %u ttl: %u", hash.host_len, hash.host_name, - folded_hash, r->ip_timestamp, r->ip_timeout_interval, attl); - - hostDB.refcountcache->put(folded_hash, r, 0, r->expiry_time()); - return r; + return record; } // @@ -658,7 +763,7 @@ HostDBProcessor::getby(Continuation *cont, cb_process_result_pfn cb_process_resu MUTEX_TRY_LOCK(lock2, bucket_mutex, thread); if (lock2.is_locked()) { // If we can get the lock and a level 1 probe succeeds, return - Ptr r = probe(bucket_mutex, hash, false); + HostDBRecord::Handle r = probe(bucket_mutex, hash, false); if (r) { // fail, see if we should retry with alternate if (hash.db_mark != HOSTDB_MARK_SRV && r->is_failed() && hash.host_name) { @@ -667,10 +772,10 @@ HostDBProcessor::getby(Continuation *cont, cb_process_result_pfn cb_process_resu if (!loop) { // No retry -> final result. Return it. if (hash.db_mark == HOSTDB_MARK_SRV) { - Debug("hostdb", "immediate SRV answer for %.*s from hostdb", hash.host_len, hash.host_name); - Debug("dns_srv", "immediate SRV answer for %.*s from hostdb", hash.host_len, hash.host_name); + Debug("hostdb", "immediate SRV answer for %.*s from hostdb", int(hash.host_name.size()), hash.host_name.data()); + Debug("dns_srv", "immediate SRV answer for %.*s from hostdb", int(hash.host_name.size()), hash.host_name.data()); } else if (hash.host_name) { - Debug("hostdb", "immediate answer for %.*s", hash.host_len, hash.host_name); + Debug("hostdb", "immediate answer for %.*s", int(hash.host_name.size()), hash.host_name.data()); } else { Debug("hostdb", "immediate answer for %s", hash.ip.isValid() ? hash.ip.toString(ipb, sizeof ipb) : ""); } @@ -688,12 +793,13 @@ HostDBProcessor::getby(Continuation *cont, cb_process_result_pfn cb_process_resu } } if (hash.db_mark == HOSTDB_MARK_SRV) { - Debug("hostdb", "delaying (force=%d) SRV answer for %.*s [timeout = %d]", force_dns, hash.host_len, hash.host_name, - opt.timeout); - Debug("dns_srv", "delaying (force=%d) SRV answer for %.*s [timeout = %d]", force_dns, hash.host_len, hash.host_name, - opt.timeout); + Debug("hostdb", "delaying (force=%d) SRV answer for %.*s [timeout = %d]", force_dns, int(hash.host_name.size()), + hash.host_name.data(), opt.timeout); + Debug("dns_srv", "delaying (force=%d) SRV answer for %.*s [timeout = %d]", force_dns, int(hash.host_name.size()), + hash.host_name.data(), opt.timeout); } else if (hash.host_name) { - Debug("hostdb", "delaying (force=%d) answer for %.*s [timeout %d]", force_dns, hash.host_len, hash.host_name, opt.timeout); + Debug("hostdb", "delaying (force=%d) answer for %.*s [timeout %d]", force_dns, int(hash.host_name.size()), + hash.host_name.data(), opt.timeout); } else { Debug("hostdb", "delaying (force=%d) answer for %s [timeout %d]", force_dns, hash.ip.isValid() ? hash.ip.toString(ipb, sizeof ipb) : "", opt.timeout); @@ -726,7 +832,7 @@ HostDBProcessor::getbyname_re(Continuation *cont, const char *ahostname, int len ink_assert(nullptr != ahostname); // Load the hash data. - hash.set_host(ahostname, ahostname ? (len ? len : strlen(ahostname)) : 0); + hash.set_host({ahostname, ahostname ? (len ? len : strlen(ahostname)) : 0}); // Leave hash.ip invalid hash.port = 0; hash.db_mark = db_mark_for(opt.host_res_style); @@ -743,7 +849,7 @@ HostDBProcessor::getbynameport_re(Continuation *cont, const char *ahostname, int ink_assert(nullptr != ahostname); // Load the hash data. - hash.set_host(ahostname, ahostname ? (len ? len : strlen(ahostname)) : 0); + hash.set_host({ahostname, ahostname ? (len ? len : strlen(ahostname)) : 0}); // Leave hash.ip invalid hash.port = opt.port; hash.db_mark = db_mark_for(opt.host_res_style); @@ -782,7 +888,7 @@ HostDBProcessor::getSRVbyname_imm(Continuation *cont, cb_process_result_pfn proc ink_assert(nullptr != hostname); - hash.set_host(hostname, len ? len : strlen(hostname)); + hash.set_host({hostname, len ? len : strlen(hostname)}); // Leave hash.ip invalid hash.port = 0; hash.db_mark = HOSTDB_MARK_SRV; @@ -802,7 +908,7 @@ HostDBProcessor::getbyname_imm(Continuation *cont, cb_process_result_pfn process ink_assert(nullptr != hostname); - hash.set_host(hostname, len ? len : strlen(hostname)); + hash.set_host({hostname, len ? len : strlen(hostname)}); // Leave hash.ip invalid // TODO: May I rename the wrapper name to getbynameport_imm ? - oknet // By comparing getbyname_re and getbynameport_re, the hash.port should be 0 if only get hostinfo by name. @@ -837,150 +943,35 @@ HostDBProcessor::iterate(Continuation *cont) return &c->action; } -static void -do_setby(HostDBInfo *r, HostDBApplicationInfo *app, const char *hostname, IpAddr const &ip, bool is_srv = false) -{ - HostDBRoundRobin *rr = r->rr(); - - if (is_srv && (!r->is_srv || !rr)) { - return; - } - - if (rr) { - if (is_srv) { - uint32_t key = makeHostHash(hostname); - for (int i = 0; i < rr->rrcount; i++) { - if (key == rr->info(i).data.srv.key && !strcmp(hostname, rr->info(i).srvname(rr))) { - Debug("hostdb", "immediate setby for %s", hostname); - rr->info(i).app.allotment.application1 = app->allotment.application1; - rr->info(i).app.allotment.application2 = app->allotment.application2; - return; - } - } - } else { - for (int i = 0; i < rr->rrcount; i++) { - if (rr->info(i).ip() == ip) { - Debug("hostdb", "immediate setby for %s", hostname ? hostname : ""); - rr->info(i).app.allotment.application1 = app->allotment.application1; - rr->info(i).app.allotment.application2 = app->allotment.application2; - return; - } - } - } - } else { - if (r->reverse_dns || (!r->round_robin && ip == r->ip())) { - Debug("hostdb", "immediate setby for %s", hostname ? hostname : ""); - r->app.allotment.application1 = app->allotment.application1; - r->app.allotment.application2 = app->allotment.application2; - } - } -} - -void -HostDBProcessor::setby(const char *hostname, int len, sockaddr const *ip, HostDBApplicationInfo *app) -{ - if (!hostdb_enable) { - return; - } - - HostDBHash hash; - hash.set_host(hostname, hostname ? (len ? len : strlen(hostname)) : 0); - hash.ip.assign(ip); - hash.port = ip ? ats_ip_port_host_order(ip) : 0; - hash.db_mark = db_mark_for(ip); - hash.refresh(); - - // Attempt to find the result in-line, for level 1 hits - - Ptr mutex = hostDB.refcountcache->lock_for_key(hash.hash.fold()); - EThread *thread = this_ethread(); - MUTEX_TRY_LOCK(lock, mutex, thread); - - if (lock.is_locked()) { - Ptr r = probe(mutex, hash, false); - if (r) { - do_setby(r.get(), app, hostname, hash.ip); - } - return; - } - // Create a continuation to do a deeper probe in the background - - HostDBContinuation *c = hostDBContAllocator.alloc(); - c->init(hash); - c->app.allotment.application1 = app->allotment.application1; - c->app.allotment.application2 = app->allotment.application2; - SET_CONTINUATION_HANDLER(c, (HostDBContHandler)&HostDBContinuation::setbyEvent); - thread->schedule_in(c, MUTEX_RETRY_DELAY); -} - -void -HostDBProcessor::setby_srv(const char *hostname, int len, const char *target, HostDBApplicationInfo *app) -{ - if (!hostdb_enable || !hostname || !target) { - return; - } - - HostDBHash hash; - hash.set_host(hostname, len ? len : strlen(hostname)); - hash.port = 0; - hash.db_mark = HOSTDB_MARK_SRV; - hash.refresh(); - - // Create a continuation to do a deeper probe in the background - - HostDBContinuation *c = hostDBContAllocator.alloc(); - c->init(hash); - ink_strlcpy(c->srv_target_name, target, MAXDNAME); - c->app.allotment.application1 = app->allotment.application1; - c->app.allotment.application2 = app->allotment.application2; - SET_CONTINUATION_HANDLER(c, (HostDBContHandler)&HostDBContinuation::setbyEvent); - eventProcessor.schedule_imm(c); -} -int -HostDBContinuation::setbyEvent(int /* event ATS_UNUSED */, Event * /* e ATS_UNUSED */) -{ - Ptr r = probe(mutex, hash, false); - - if (r) { - do_setby(r.get(), &app, hash.host_name, hash.ip, is_srv()); - } - - hostdb_cont_free(this); - return EVENT_DONE; -} - // Lookup done, insert into the local table, return data to the // calling continuation. // NOTE: if "i" exists it means we already allocated the space etc, just return // -HostDBInfo * -HostDBContinuation::lookup_done(IpAddr const &ip, const char *aname, bool around_robin, unsigned int ttl_seconds, SRVHosts *srv, - HostDBInfo *r) +Ptr +HostDBContinuation::lookup_done(TextView query_name, ts_seconds answer_ttl, SRVHosts *srv, Ptr record) { ink_assert(this_ethread() == hostDB.refcountcache->lock_for_key(hash.hash.fold())->thread_holding); - if (!ip.isValid() || !aname || !aname[0]) { + ink_assert(record); + if (query_name.empty()) { if (is_byname()) { - Debug("hostdb", "lookup_done() failed for '%.*s'", hash.host_len, hash.host_name); + Debug("hostdb", "lookup_done() failed for '%.*s'", int(hash.host_name.size()), hash.host_name.data()); } else if (is_srv()) { - Debug("dns_srv", "SRV failed for '%.*s'", hash.host_len, hash.host_name); + Debug("dns_srv", "SRV failed for '%.*s'", int(hash.host_name.size()), hash.host_name.data()); } else { ip_text_buffer b; Debug("hostdb", "failed for %s", hash.ip.toString(b, sizeof b)); } - if (r == nullptr) { - r = insert(hostdb_ip_fail_timeout_interval); - } else { - r->ip_timestamp = hostdb_current_interval; - r->ip_timeout_interval = std::clamp(hostdb_ip_fail_timeout_interval, 1u, HOST_DB_MAX_TTL); - } + record->ip_timestamp = hostdb_current_interval; + record->ip_timeout_interval = ts_seconds(std::clamp(hostdb_ip_fail_timeout_interval, 1u, HOST_DB_MAX_TTL)); - r->round_robin = false; - r->round_robin_elt = false; - r->is_srv = is_srv(); - r->reverse_dns = !is_byname() && !is_srv(); + if (is_srv()) { + record->record_type = HostDBType::SRV; + } else if (!is_byname()) { + record->record_type = HostDBType::HOST; + } - r->set_failed(); - return r; + record->set_failed(); + return record; } else { switch (hostdb_ttl_mode) { @@ -989,65 +980,38 @@ HostDBContinuation::lookup_done(IpAddr const &ip, const char *aname, bool around case TTL_OBEY: break; case TTL_IGNORE: - ttl_seconds = hostdb_ip_timeout_interval; + answer_ttl = ts_seconds(hostdb_ip_timeout_interval); break; case TTL_MIN: - if (hostdb_ip_timeout_interval < ttl_seconds) { - ttl_seconds = hostdb_ip_timeout_interval; + if (ts_seconds(hostdb_ip_timeout_interval) < answer_ttl) { + answer_ttl = ts_seconds(hostdb_ip_timeout_interval); } break; case TTL_MAX: - if (hostdb_ip_timeout_interval > ttl_seconds) { - ttl_seconds = hostdb_ip_timeout_interval; + if (ts_seconds(hostdb_ip_timeout_interval) > answer_ttl) { + answer_ttl = ts_seconds(hostdb_ip_timeout_interval); } break; } - HOSTDB_SUM_DYN_STAT(hostdb_ttl_stat, ttl_seconds); + HOSTDB_SUM_DYN_STAT(hostdb_ttl_stat, answer_ttl.count()); - if (r == nullptr) { - r = insert(ttl_seconds); - } else { - // update the TTL - r->ip_timestamp = hostdb_current_interval; - r->ip_timeout_interval = std::clamp(ttl_seconds, 1u, HOST_DB_MAX_TTL); - } + // update the TTL + record->ip_timestamp = hostdb_current_interval; + record->ip_timeout_interval = std::clamp(answer_ttl, ts_seconds(1), ts_seconds(HOST_DB_MAX_TTL)); - r->round_robin_elt = false; // only true for elements explicitly added as RR elements. if (is_byname()) { - ip_text_buffer b; - Debug("hostdb", "done %s TTL %d", ip.toString(b, sizeof b), ttl_seconds); - ats_ip_set(r->ip(), ip); - r->round_robin = around_robin; - r->reverse_dns = false; - if (hash.host_name != aname) { - ink_strlcpy(hash_host_name_store, aname, sizeof(hash_host_name_store)); - } - r->is_srv = false; + Debug_bw("hostdb", "done {} TTL {}", hash.host_name, answer_ttl); } else if (is_srv()) { - ink_assert(srv && srv->hosts.size() && srv->hosts.size() <= hostdb_round_robin_max_count && around_robin); - - r->data.srv.srv_offset = srv->hosts.size(); - r->reverse_dns = false; - r->is_srv = true; - r->round_robin = around_robin; - - if (hash.host_name != aname) { - ink_strlcpy(hash_host_name_store, aname, sizeof(hash_host_name_store)); - } + ink_assert(srv && srv->hosts.size() && srv->hosts.size() <= hostdb_round_robin_max_count); + record->record_type = HostDBType::SRV; } else { - Debug("hostdb", "done '%s' TTL %d", aname, ttl_seconds); - // TODO: check that this is right, it seems that the 2 hostnames are always the same - r->data.hostname_offset = r->hostname_offset; - // TODO: consolidate into a single "item type" field? - r->round_robin = false; - r->reverse_dns = true; - r->is_srv = false; + Debug_bw("hostdb", "done {} TTL {}", hash.host_name, answer_ttl); + record->record_type = HostDBType::HOST; } } - ink_assert(!r->round_robin || !r->reverse_dns); - return r; + return record; } int @@ -1077,28 +1041,7 @@ HostDBContinuation::dnsPendingEvent(int event, Event *e) } } -// for a new HostDBInfo `r`, "inherit" from the old version of yourself if it exists in `old_rr_data` -static int -restore_info(HostDBInfo *r, HostDBInfo *old_r, HostDBInfo &old_info, HostDBRoundRobin *old_rr_data) -{ - if (old_rr_data) { - for (int j = 0; j < old_rr_data->rrcount; j++) { - if (ats_ip_addr_eq(old_rr_data->info(j).ip(), r->ip())) { - r->app = old_rr_data->info(j).app; - return true; - } - } - } else if (old_r) { - if (ats_ip_addr_eq(old_info.ip(), r->ip())) { - r->app = old_info.app; - return true; - } - } - return false; -} - // DNS lookup result state -// int HostDBContinuation::dnsEvent(int event, HostEnt *e) { @@ -1117,7 +1060,7 @@ HostDBContinuation::dnsEvent(int event, HostEnt *e) // actual DNS query. If the request rate is high enough this can cause a persistent queue where the // DNS query is never sent and all requests timeout, even if it was a transient error. // See issue #8417. - remove_trigger_pending_dns(); + remove_and_trigger_pending_dns(); } else { // "local" signal to give up, usually due this being one of those "other" queries. // That generally means @a this has already been removed from the queue, but just in case... @@ -1143,38 +1086,25 @@ HostDBContinuation::dnsEvent(int event, HostEnt *e) } else { bool failed = !e || !e->good; - bool is_rr = false; pending_action = nullptr; - if (is_srv()) { - is_rr = !failed && (e->srv_hosts.hosts.size() > 0); - } else if (!failed) { - is_rr = nullptr != e->ent.h_addr_list[1]; - } else { - } - - ttl = failed ? 0 : e->ttl / 60; - int ttl_seconds = failed ? 0 : e->ttl; // ebalsa: moving to second accuracy + ttl = ts_seconds(failed ? 0 : e->ttl); - Ptr old_r = probe(mutex, hash, false); + Ptr old_r = probe(mutex, hash, false); // If the DNS lookup failed with NXDOMAIN, remove the old record if (e && e->isNameError() && old_r) { hostDB.refcountcache->erase(old_r->key); old_r = nullptr; Debug("hostdb", "Removing the old record when the DNS lookup failed with NXDOMAIN"); } - HostDBInfo old_info; - if (old_r) { - old_info = *old_r.get(); - } - HostDBRoundRobin *old_rr_data = old_r ? old_r->rr() : nullptr; - int valid_records = 0; - void *first_record = nullptr; - uint8_t af = e ? e->ent.h_addrtype : AF_UNSPEC; // address family - // if this is an RR response, we need to find the first record, as well as the - // total number of records - if (is_rr) { - if (is_srv() && !failed) { + + int valid_records = 0; + void *first_record = nullptr; + sa_family_t af = e ? e->ent.h_addrtype : AF_UNSPEC; // address family + + // Find the first record and total number of records. + if (!failed) { + if (is_srv()) { valid_records = e->srv_hosts.hosts.size(); } else { void *ptr; // tmp for current entry. @@ -1194,160 +1124,92 @@ HostDBContinuation::dnsEvent(int event, HostEnt *e) ++valid_records; } else { - Warning("Zero address removed from round-robin list for '%s'", hash.host_name); + Warning("Invalid address removed for '%.*s'", int(hash.host_name.size()), hash.host_name.data()); } } if (!first_record) { failed = true; - is_rr = false; } } - } else if (!failed) { - first_record = e->ent.h_addr_list[0]; - } // else first is 0. - - IpAddr tip; // temp storage if needed. + } // else first is nullptr // In the event that the lookup failed (SOA response-- for example) we want to use hash.host_name, since it'll be "" - const char *aname = (failed || strlen(hash.host_name)) ? hash.host_name : e->ent.h_name; - - const size_t s_size = strlen(aname) + 1; - const size_t rrsize = is_rr ? HostDBRoundRobin::size(valid_records, e->srv_hosts.srv_hosts_length) : 0; - // where in our block of memory we are - int offset = sizeof(HostDBInfo); - - int allocSize = s_size + rrsize; // The extra space we need for the rest of the things - - HostDBInfo *r = HostDBInfo::alloc(allocSize); - Debug("hostdb", "allocating %d bytes for %s with %d RR records at [%p]", allocSize, aname, valid_records, r); - // set up the record - r->key = hash.hash.fold(); // always set the key - - r->hostname_offset = offset; - ink_strlcpy(r->perm_hostname(), aname, s_size); - offset += s_size; + TextView query_name = (failed || !hash.host_name.empty()) ? hash.host_name : TextView{e->ent.h_name, strlen(e->ent.h_name)}; + HostDBRecord::Handle r{HostDBRecord::alloc(query_name, valid_records, failed ? 0 : e->srv_hosts.srv_hosts_length)}; + r->key = hash.hash.fold(); // always set the key + r->af_family = af; + r->flags.f.failed_p = failed; // If the DNS lookup failed (errors such as SERVFAIL, etc.) but we have an old record // which is okay with being served stale-- lets continue to serve the stale record as long as // the record is willing to be served. bool serve_stale = false; if (failed && old_r && old_r->serve_stale_but_revalidate()) { - r->free(); - r = old_r.get(); + r = old_r; serve_stale = true; } else if (is_byname()) { - if (first_record) { - ip_addr_set(tip, af, first_record); - } - r = lookup_done(tip, hash.host_name, is_rr, ttl_seconds, failed ? nullptr : &e->srv_hosts, r); + lookup_done(hash.host_name, ttl, failed ? nullptr : &e->srv_hosts, r); } else if (is_srv()) { - if (!failed) { - tip._family = AF_INET; // force the tip valid, or else the srv will fail - } - r = lookup_done(tip, /* junk: FIXME: is the code in lookup_done() wrong to NEED this? */ - hash.host_name, /* hostname */ - is_rr, /* is round robin, doesnt matter for SRV since we recheck getCount() inside lookup_done() */ - ttl_seconds, /* ttl in seconds */ - failed ? nullptr : &e->srv_hosts, r); + lookup_done(hash.host_name, /* hostname */ + ttl, /* ttl in seconds */ + failed ? nullptr : &e->srv_hosts, r); } else if (failed) { - r = lookup_done(tip, hash.host_name, false, ttl_seconds, nullptr, r); + lookup_done(hash.host_name, ttl, nullptr, r); } else { - r = lookup_done(hash.ip, e->ent.h_name, false, ttl_seconds, &e->srv_hosts, r); + lookup_done(e->ent.h_name, ttl, &e->srv_hosts, r); } - // Conditionally make rr record entries - if (is_rr) { - r->app.rr.offset = offset; - // This will only be set if is_rr - HostDBRoundRobin *rr_data = static_cast(r->rr()); - ; + if (!failed) { // implies r != old_r + auto rr_info = r->rr_info(); + // Fill in record type specific data. if (is_srv()) { - int skip = 0; - char *pos = reinterpret_cast(rr_data) + sizeof(HostDBRoundRobin) + valid_records * sizeof(HostDBInfo); + char *pos = rr_info.rebind().end(); SRV *q[valid_records]; ink_assert(valid_records <= (int)hostdb_round_robin_max_count); - // sort for (int i = 0; i < valid_records; ++i) { q[i] = &e->srv_hosts.hosts[i]; } - for (int i = 0; i < valid_records; ++i) { - for (int ii = i + 1; ii < valid_records; ++ii) { - if (*q[ii] < *q[i]) { - SRV *tmp = q[i]; - q[i] = q[ii]; - q[ii] = tmp; - } - } - } - - rr_data->good = rr_data->rrcount = valid_records; - rr_data->current = 0; - for (int i = 0; i < valid_records; ++i) { - SRV *t = q[i]; - HostDBInfo &item = rr_data->info(i); - item.round_robin = 0; - item.round_robin_elt = 1; - item.reverse_dns = 0; - item.is_srv = 1; - item.data.srv.srv_weight = t->weight; - item.data.srv.srv_priority = t->priority; - item.data.srv.srv_port = t->port; - item.data.srv.key = t->key; - - ink_assert((skip + t->host_len) <= e->srv_hosts.srv_hosts_length); - - memcpy(pos + skip, t->host, t->host_len); - item.data.srv.srv_offset = (pos - reinterpret_cast(rr_data)) + skip; - - skip += t->host_len; - - item.app.allotment.application1 = 0; - item.app.allotment.application2 = 0; - Debug("dns_srv", "inserted SRV RR record [%s] into HostDB with TTL: %d seconds", t->host, ttl_seconds); - } - - // restore - if (old_rr_data) { - for (int i = 0; i < rr_data->rrcount; ++i) { - for (int ii = 0; ii < old_rr_data->rrcount; ++ii) { - if (rr_data->info(i).data.srv.key == old_rr_data->info(ii).data.srv.key) { - char *new_host = rr_data->info(i).srvname(rr_data); - char *old_host = old_rr_data->info(ii).srvname(old_rr_data); - if (!strcmp(new_host, old_host)) { - rr_data->info(i).app = old_rr_data->info(ii).app; - } + std::sort(q, q + valid_records, [](SRV *lhs, SRV *rhs) -> bool { return *lhs < *rhs; }); + + SRV **cur_srv = q; + for (auto &item : rr_info) { + auto t = *cur_srv++; // get next SRV record pointer. + memcpy(pos, t->host, t->host_len); // Append the name to the overall record. + item.assign(t, pos); + pos += t->host_len; + if (old_r) { // migrate as needed. + for (auto &old_item : old_r->rr_info()) { + if (item.data.srv.key == old_item.data.srv.key && 0 == strcmp(item.srvname(), old_item.srvname())) { + item.migrate_from(old_item); + break; } } } + // Archetypical example - "%zd" doesn't work on FreeBSD, "%ld" doesn't work on Ubuntu, "%lld" doesn't work on Fedora. + Debug_bw("dns_srv", "inserted SRV RR record [{}] into HostDB with TTL: {} seconds", t->host, ttl); } } else { // Otherwise this is a regular dns response - rr_data->good = rr_data->rrcount = valid_records; - rr_data->current = 0; - for (int i = 0; i < valid_records; ++i) { - HostDBInfo &item = rr_data->info(i); - ip_addr_set(item.ip(), af, e->ent.h_addr_list[i]); - item.round_robin = 0; - item.round_robin_elt = 1; - item.reverse_dns = 0; - item.is_srv = 0; - if (!restore_info(&item, old_r.get(), old_info, old_rr_data)) { - item.app.allotment.application1 = 0; - item.app.allotment.application2 = 0; + unsigned idx = 0; + for (auto &item : rr_info) { + item.assign(af, e->ent.h_addr_list[idx++]); + if (old_r) { // migrate as needed. + for (auto &old_item : old_r->rr_info()) { + if (item.data.ip == old_item.data.ip) { + item.migrate_from(old_item); + break; + } + } } } } } - if (!failed && !is_rr && !is_srv()) { - restore_info(r, old_r.get(), old_info, old_rr_data); - } - ink_assert(!r || !r->round_robin || !r->reverse_dns); - ink_assert(failed || !r->round_robin || r->app.rr.offset); - - if (!serve_stale) { - hostDB.refcountcache->put(hash.hash.fold(), r, allocSize, r->expiry_time()); + if (!serve_stale) { // implies r != old_r + hostDB.refcountcache->put( + r->key, r.get(), r->_record_size, + (r->ip_timestamp + r->ip_timeout_interval + ts_seconds(hostdb_serve_stale_but_revalidate)).time_since_epoch().count()); } else { - Warning("Fallback to serving stale record, skip re-update of hostdb for %s", aname); + Warning("Fallback to serving stale record, skip re-update of hostdb for %.*s", int(query_name.size()), query_name.data()); } // try to callback the user @@ -1372,7 +1234,7 @@ HostDBContinuation::dnsEvent(int event, HostEnt *e) if (action.continuation->mutex) { ink_release_assert(action.continuation->mutex == action.mutex); } - reply_to_cont(action.continuation, r, is_srv()); + reply_to_cont(action.continuation, r.get(), is_srv()); } need_to_reschedule = false; } @@ -1389,7 +1251,7 @@ HostDBContinuation::dnsEvent(int event, HostEnt *e) hostDB.pending_dns_for_hash(hash.hash).remove(this); // wake up everyone else who is waiting - remove_trigger_pending_dns(); + remove_and_trigger_pending_dns(); hostdb_cont_free(this); @@ -1432,7 +1294,7 @@ HostDBContinuation::iterateEvent(int event, Event *e) IntrusiveHashMap &partMap = hostDB.refcountcache->get_partition(current_iterate_pos).get_map(); for (const auto &it : partMap) { - HostDBInfo *r = static_cast(it.item.get()); + auto *r = static_cast(it.item.get()); if (r && !r->is_failed()) { action.continuation->handleEvent(EVENT_INTERVAL, static_cast(r)); } @@ -1498,7 +1360,7 @@ HostDBContinuation::probeEvent(int /* event ATS_UNUSED */, Event *e) if (!force_dns) { // Do the probe // - Ptr r = probe(mutex, hash, false); + Ptr r = probe(mutex, hash, false); if (r) { HOSTDB_INCREMENT_DYN_STAT(hostdb_total_hits_stat); @@ -1544,7 +1406,7 @@ HostDBContinuation::set_check_pending_dns() } void -HostDBContinuation::remove_trigger_pending_dns() +HostDBContinuation::remove_and_trigger_pending_dns() { Queue &q = hostDB.pending_dns_for_hash(hash.hash); q.remove(this); @@ -1582,31 +1444,42 @@ HostDBContinuation::do_dns() { ink_assert(!action.cancelled); if (is_byname()) { - Debug("hostdb", "DNS %s", hash.host_name); + Debug("hostdb", "DNS %.*s", int(hash.host_name.size()), hash.host_name.data()); IpAddr tip; if (0 == tip.load(hash.host_name)) { - // check 127.0.0.1 format // What the heck does that mean? - AMC + // Need to consider if this is necessary - could the record in ResolveInfo be left null and + // just the resolved address set? if (action.continuation) { - HostDBInfo *r = lookup_done(tip, hash.host_name, false, HOST_DB_MAX_TTL, nullptr); - - reply_to_cont(action.continuation, r); + HostDBRecord::Handle r{HostDBRecord::alloc(hash.host_name, 1)}; + r->af_family = tip.family(); + auto &info = r->rr_info()[0]; + info.assign(tip); + // tricksy - @a reply_to_cont must use an intrusive pointer to @a r if it needs to persist + // @a r doesn't go out of scope until after this returns. This continuation shares the mutex + // of the target continuation therefore this is always dispatched synchronously. + reply_to_cont(action.continuation, r.get()); } hostdb_cont_free(this); return; } - ts::ConstBuffer hname(hash.host_name, hash.host_len); - Ptr current_host_file_map = hostDB.hosts_file_ptr; - HostsFileMap::iterator find_result = current_host_file_map->hosts_file_map.find(hname); - if (find_result != current_host_file_map->hosts_file_map.end()) { - if (action.continuation) { - // Set the TTL based on how often we stat() the host file - HostDBInfo *r = lookup_done(IpAddr(find_result->second), hash.host_name, false, hostdb_hostfile_check_interval, nullptr); - reply_to_cont(action.continuation, r); + + // If looking for an IPv4 or IPv6 address, check the host file. + if (hash.db_mark == HOSTDB_MARK_IPV6 || hash.db_mark == HOSTDB_MARK_IPV4) { + if (auto static_hosts = hostDB.acquire_host_file(); static_hosts) { + if (auto spot = static_hosts->find(hash.host_name); spot != static_hosts->end()) { + HostDBRecord::Handle r = (hash.db_mark == HOSTDB_MARK_IPV4) ? spot->second.record_4 : spot->second.record_6; + // Set the TTL based on how often we stat() the host file + if (r && action.continuation) { + r = lookup_done(hash.host_name, hostdb_hostfile_check_interval, nullptr, r); + reply_to_cont(action.continuation, r.get()); + hostdb_cont_free(this); + return; + } + } } - hostdb_cont_free(this); - return; } } + if (hostdb_lookup_timeout) { timeout = mutex->thread_holding->schedule_in(this, HRTIME_SECONDS(hostdb_lookup_timeout)); } else { @@ -1623,7 +1496,7 @@ HostDBContinuation::do_dns() } pending_action = dnsProcessor.gethostbyname(this, hash.host_name, opt); } else if (is_srv()) { - Debug("dns_srv", "SRV lookup of %s", hash.host_name); + Debug("dns_srv", "SRV lookup of %.*s", int(hash.host_name.size()), hash.host_name.data()); pending_action = dnsProcessor.getSRVbyname(this, hash.host_name, opt); } else { ip_text_buffer ipb; @@ -1643,44 +1516,41 @@ HostDBContinuation::do_dns() int HostDBContinuation::backgroundEvent(int /* event ATS_UNUSED */, Event * /* e ATS_UNUSED */) { + std::string dbg; + // No nothing if hosts file checking is not enabled. - if (hostdb_hostfile_check_interval == 0) { + if (hostdb_hostfile_check_interval.count() == 0) { return EVENT_CONT; } - hostdb_current_interval = ink_time(); + hostdb_current_interval = ts_clock::now(); if ((hostdb_current_interval - hostdb_last_interval) > hostdb_hostfile_check_interval) { bool update_p = false; // do we need to reparse the file and update? - struct stat info; - char path[sizeof(hostdb_hostfile_path)]; + char path[PATH_NAME_MAX]; REC_ReadConfigString(path, "proxy.config.hostdb.host_file.path", sizeof(path)); - if (0 != strcasecmp(hostdb_hostfile_path, path)) { - Debug("hostdb", "Update host file '%s' -> '%s'", (*hostdb_hostfile_path ? hostdb_hostfile_path : "*-none-*"), - (*path ? path : "*-none-*")); + if (0 != strcasecmp(hostdb_hostfile_path.string(), path)) { + Debug("hostdb", "%s", + ts::bwprint(dbg, R"(Updating hosts file from "{}" to "{}")", hostdb_hostfile_path, ts::bwf::FirstOf(path, "")).c_str()); // path to hostfile changed - hostdb_hostfile_update_timestamp = 0; // never updated from this file - if ('\0' != *path) { - memcpy(hostdb_hostfile_path, path, sizeof(hostdb_hostfile_path)); - } else { - hostdb_hostfile_path[0] = 0; // mark as not there - } - update_p = true; - } else { + hostdb_hostfile_update_timestamp = TS_TIME_ZERO; // never updated from this file + hostdb_hostfile_path = path; + update_p = true; + } else if (!hostdb_hostfile_path.empty()) { hostdb_last_interval = hostdb_current_interval; - if (*hostdb_hostfile_path) { - if (0 == stat(hostdb_hostfile_path, &info)) { - if (info.st_mtime > static_cast(hostdb_hostfile_update_timestamp)) { - update_p = true; // same file but it's changed. - } - } else { - Debug("hostdb", "Failed to stat host file '%s'", hostdb_hostfile_path); + std::error_code ec; + auto stat{ts::file::status(hostdb_hostfile_path, ec)}; + if (!ec) { + if (ts_clock::from_time_t(modification_time(stat)) > hostdb_hostfile_update_timestamp) { + update_p = true; // same file but it's changed. } + } else { + Debug("hostdb", "%s", ts::bwprint(dbg, R"(Failed to stat host file "{}" - {})", hostdb_hostfile_path, ec).c_str()); } } if (update_p) { - Debug("hostdb", "Updating from host file"); + Debug("hostdb", "%s", ts::bwprint(dbg, R"(Updating from host file "{}")", hostdb_hostfile_path).c_str()); ParseHostFile(hostdb_hostfile_path, hostdb_hostfile_check_interval); } } @@ -1688,37 +1558,60 @@ HostDBContinuation::backgroundEvent(int /* event ATS_UNUSED */, Event * /* e ATS return EVENT_CONT; } -char * -HostDBInfo::hostname() const -{ - if (!reverse_dns) { - return nullptr; - } - - return (char *)this + data.hostname_offset; -} - -/* - * The perm_hostname exists for all records not just reverse dns records. - */ -char * -HostDBInfo::perm_hostname() const +HostDBInfo * +HostDBRecord::select_best_http(ts_time now, ts_seconds fail_window, sockaddr const *hash_addr) { - if (hostname_offset == 0) { - return nullptr; + ink_assert(0 < rr_count && rr_count <= hostdb_round_robin_max_count); + + // @a best_any is set to a base candidate, which may be dead. + HostDBInfo *best_any = nullptr; + // @a best_alive is set when a valid target has been selected and should be used. + HostDBInfo *best_alive = nullptr; + + auto info{this->rr_info()}; + + if (HostDBProcessor::hostdb_strict_round_robin) { + // Always select the next viable target - select failure means no valid targets at all. + best_alive = best_any = this->select_next_rr(now, fail_window); + Debug("hostdb", "Using strict round robin - index %d", this->index_of(best_alive)); + } else if (HostDBProcessor::hostdb_timed_round_robin > 0) { + auto ctime = rr_ctime.load(); // cache for atomic update. + auto ntime = ctime + ts_seconds(HostDBProcessor::hostdb_timed_round_robin); + // Check and update RR if it's time - this always yields a valid target if there is one. + if (now > ntime && rr_ctime.compare_exchange_strong(ctime, ntime)) { + best_alive = best_any = this->select_next_rr(now, fail_window); + Debug("hostdb", "Round robin timed interval expired - index %d", this->index_of(best_alive)); + } else { // pick the current index, which may be dead. + best_any = &info[this->rr_idx()]; + } + Debug("hostdb", "Using timed round robin - index %d", this->index_of(best_any)); + } else { + // Walk the entries and find the best (largest) hash. + unsigned int best_hash = 0; // any hash is better than this. + for (auto &target : info) { + unsigned int h = HOSTDB_CLIENT_IP_HASH(hash_addr, target.data.ip); + if (best_hash <= h) { + best_any = ⌖ + best_hash = h; + } + } + Debug("hostdb", "Using client affinity - index %d", this->index_of(best_any)); } - return (char *)this + hostname_offset; -} - -HostDBRoundRobin * -HostDBInfo::rr() -{ - if (!round_robin) { - return nullptr; + // If there is a base choice, search for valid target starting there. + // Otherwise there is no valid target in the record. + if (best_any && !best_alive) { + // Starting at the current target, search for a valid one. + for (unsigned short i = 0; i < rr_count; i++) { + auto target = &info[this->rr_idx(i)]; + if (target->select(now, fail_window)) { + best_alive = target; + break; + } + } } - return reinterpret_cast(reinterpret_cast(this) + this->app.rr.offset); + return best_alive; } struct ShowHostDB; @@ -1784,41 +1677,42 @@ struct ShowHostDB : public ShowCont { showAllEvent(int event, Event *e) { if (event == EVENT_INTERVAL) { - HostDBInfo *r = reinterpret_cast(e); + auto *r = reinterpret_cast(e); if (output_json && records_seen++ > 0) { CHECK_SHOW(show(",")); // we need to separate records } - showOne(r, false, event, e); - if (r->round_robin) { - HostDBRoundRobin *rr_data = r->rr(); - if (rr_data) { - if (!output_json) { - CHECK_SHOW(show("\n")); - CHECK_SHOW(show("\n", "Total", rr_data->rrcount)); - CHECK_SHOW(show("\n", "Good", rr_data->good)); - CHECK_SHOW(show("\n", "Current", rr_data->current)); - CHECK_SHOW(show("
%s%d
%s%d
%s%d
\n")); - } else { - CHECK_SHOW(show(",\"%s\":\"%d\",", "rr_total", rr_data->rrcount)); - CHECK_SHOW(show("\"%s\":\"%d\",", "rr_good", rr_data->good)); - CHECK_SHOW(show("\"%s\":\"%d\",", "rr_current", rr_data->current)); - CHECK_SHOW(show("\"rr_records\":[")); - } + auto rr_info{r->rr_info()}; + if (rr_info.count()) { + if (!output_json) { + CHECK_SHOW(show("\n")); + CHECK_SHOW(show("\n", "Total", r->rr_count)); + CHECK_SHOW(show("\n", "Current", r->_rr_idx.load())); + CHECK_SHOW(show("\n", "Stale", r->is_ip_stale() ? "Yes" : "No")); + CHECK_SHOW(show("\n", "Timed-Out", r->is_ip_timeout() ? "Yes" : "No")); + CHECK_SHOW(show("
%s%d
%s%d
%s%s
%s%s
\n")); + } else { + CHECK_SHOW(show(",\"%s\":\"%d\",", "rr_total", r->rr_count)); + CHECK_SHOW(show("\"%s\":\"%d\",", "rr_current", r->_rr_idx.load())); + CHECK_SHOW(show("\"rr_records\":[")); + } + CHECK_SHOW(show("%s%d\n", "TTL", r->ip_time_remaining())); - for (int i = 0; i < rr_data->rrcount; i++) { - showOne(&rr_data->info(i), true, event, e, rr_data); - if (output_json) { - CHECK_SHOW(show("}")); // we need to separate records - if (i < (rr_data->rrcount - 1)) - CHECK_SHOW(show(",")); + bool need_separator = false; + for (auto &item : rr_info) { + showOne(&item, r->record_type, event, e); + if (output_json) { + CHECK_SHOW(show("}")); // we need to separate records + if (need_separator) { + CHECK_SHOW(show(",")); } + need_separator = true; } + } - if (!output_json) { - CHECK_SHOW(show("
\n
\n")); - } else { - CHECK_SHOW(show("]")); - } + if (!output_json) { + CHECK_SHOW(show("
\n
\n")); + } else { + CHECK_SHOW(show("]")); } } @@ -1840,67 +1734,47 @@ struct ShowHostDB : public ShowCont { } int - showOne(HostDBInfo *r, bool rr, int event, Event *e, HostDBRoundRobin *hostdb_rr = nullptr) + showOne(HostDBInfo *info, HostDBType record_type, int event, Event *e) { ip_text_buffer b; if (!output_json) { CHECK_SHOW(show("\n")); - CHECK_SHOW(show("\n", "Type", r->round_robin ? "Round-Robin" : "", - r->reverse_dns ? "Reverse DNS" : "", r->is_srv ? "SRV" : "DNS")); + CHECK_SHOW(show("\n", "Type", name_of(record_type))); - if (r->perm_hostname()) { - CHECK_SHOW(show("\n", "Hostname", r->perm_hostname())); - } else if (rr && r->is_srv && hostdb_rr) { - CHECK_SHOW(show("\n", "Hostname", r->srvname(hostdb_rr))); + if (HostDBType::SRV == record_type) { + CHECK_SHOW(show("\n", "Hostname", info->srvname())); } // Let's display the hash. - CHECK_SHOW(show("\n", "App1", r->app.allotment.application1)); - CHECK_SHOW(show("\n", "App2", r->app.allotment.application2)); - CHECK_SHOW(show("\n", "LastFailure", r->app.http_data.last_failure)); - if (!rr) { - CHECK_SHOW(show("\n", "Stale", r->is_ip_stale() ? "Yes" : "No")); - CHECK_SHOW(show("\n", "Timed-Out", r->is_ip_timeout() ? "Yes" : "No")); - CHECK_SHOW(show("\n", "TTL", r->ip_time_remaining())); - } + CHECK_SHOW(show("\n", "LastFailure", info->last_failure.load().time_since_epoch().count())); - if (rr && r->is_srv) { - CHECK_SHOW(show("\n", "Weight", r->data.srv.srv_weight)); - CHECK_SHOW(show("\n", "Priority", r->data.srv.srv_priority)); - CHECK_SHOW(show("\n", "Port", r->data.srv.srv_port)); - CHECK_SHOW(show("\n", "Key", r->data.srv.key)); - } else if (!r->is_srv) { - CHECK_SHOW(show("\n", "IP", ats_ip_ntop(r->ip(), b, sizeof b))); + if (HostDBType::SRV == record_type) { + CHECK_SHOW(show("\n", "Weight", info->data.srv.srv_weight)); + CHECK_SHOW(show("\n", "Priority", info->data.srv.srv_priority)); + CHECK_SHOW(show("\n", "Port", info->data.srv.srv_port)); + CHECK_SHOW(show("\n", "Key", info->data.srv.key)); + } else { + CHECK_SHOW(show("\n", "IP", info->data.ip.toString(b, sizeof b))); } CHECK_SHOW(show("
%s%s%s %s
%s%s
%s%s
%s%s
%s%s
%s%u
%s%u
%s%u
%s%s
%s%s
%s%d
%s%u
%s%d
%s%d
%s%d
%s%x
%s%s
%s%d
%s%d
%s%d
%s%x
%s%s
\n")); } else { CHECK_SHOW(show("{")); - CHECK_SHOW(show("\"%s\":\"%s%s%s\",", "type", (r->round_robin && !r->is_srv) ? "roundrobin" : "", - r->reverse_dns ? "reversedns" : "", r->is_srv ? "srv" : "dns")); + CHECK_SHOW(show("\"%s\":\"%s\",", "type", name_of(record_type))); - if (r->perm_hostname()) { - CHECK_SHOW(show("\"%s\":\"%s\",", "hostname", r->perm_hostname())); - } else if (rr && r->is_srv && hostdb_rr) { - CHECK_SHOW(show("\"%s\":\"%s\",", "hostname", r->srvname(hostdb_rr))); + if (HostDBType::SRV == record_type) { + CHECK_SHOW(show("\"%s\":\"%s\",", "hostname", info->srvname())); } - CHECK_SHOW(show("\"%s\":\"%u\",", "app1", r->app.allotment.application1)); - CHECK_SHOW(show("\"%s\":\"%u\",", "app2", r->app.allotment.application2)); - CHECK_SHOW(show("\"%s\":\"%u\",", "lastfailure", r->app.http_data.last_failure)); - if (!rr) { - CHECK_SHOW(show("\"%s\":\"%s\",", "stale", r->is_ip_stale() ? "yes" : "no")); - CHECK_SHOW(show("\"%s\":\"%s\",", "timedout", r->is_ip_timeout() ? "yes" : "no")); - CHECK_SHOW(show("\"%s\":\"%d\",", "ttl", r->ip_time_remaining())); - } + CHECK_SHOW(show("\"%s\":\"%u\",", "lastfailure", info->last_failure.load().time_since_epoch().count())); - if (rr && r->is_srv) { - CHECK_SHOW(show("\"%s\":\"%d\",", "weight", r->data.srv.srv_weight)); - CHECK_SHOW(show("\"%s\":\"%d\",", "priority", r->data.srv.srv_priority)); - CHECK_SHOW(show("\"%s\":\"%d\",", "port", r->data.srv.srv_port)); - CHECK_SHOW(show("\"%s\":\"%x\",", "key", r->data.srv.key)); - } else if (!r->is_srv) { - CHECK_SHOW(show("\"%s\":\"%s\"", "ip", ats_ip_ntop(r->ip(), b, sizeof b))); + if (HostDBType::SRV == record_type) { + CHECK_SHOW(show("\"%s\":\"%d\",", "weight", info->data.srv.srv_weight)); + CHECK_SHOW(show("\"%s\":\"%d\",", "priority", info->data.srv.srv_priority)); + CHECK_SHOW(show("\"%s\":\"%d\",", "port", info->data.srv.srv_port)); + CHECK_SHOW(show("\"%s\":\"%x\",", "key", info->data.srv.key)); + } else { + CHECK_SHOW(show("\"%s\":\"%s\"", "ip", info->data.ip.toString(b, sizeof b))); } } return EVENT_CONT; @@ -1909,7 +1783,7 @@ struct ShowHostDB : public ShowCont { int showLookupDone(int event, Event *e) { - HostDBInfo *r = reinterpret_cast(e); + auto *r = reinterpret_cast(e); CHECK_SHOW(begin("HostDB Lookup")); if (name) { @@ -1918,19 +1792,15 @@ struct ShowHostDB : public ShowCont { CHECK_SHOW(show("

%u.%u.%u.%u

\n", PRINT_IP(ip))); } if (r) { - showOne(r, false, event, e); - if (r->round_robin) { - HostDBRoundRobin *rr_data = r->rr(); - if (rr_data) { - CHECK_SHOW(show("\n")); - CHECK_SHOW(show("\n", "Total", rr_data->rrcount)); - CHECK_SHOW(show("\n", "Good", rr_data->good)); - CHECK_SHOW(show("\n", "Current", rr_data->current)); - CHECK_SHOW(show("
%s%d
%s%d
%s%d
\n")); - - for (int i = 0; i < rr_data->rrcount; i++) { - showOne(&rr_data->info(i), true, event, e, rr_data); - } + auto rr_data = r->rr_info(); + if (rr_data.count()) { + CHECK_SHOW(show("\n")); + CHECK_SHOW(show("\n", "Total", r->rr_count)); + CHECK_SHOW(show("\n", "Current", r->_rr_idx.load())); + CHECK_SHOW(show("
%s%d
%s%d
\n")); + + for (auto &item : rr_data) { + showOne(&item, r->record_type, event, e); } } } else { @@ -2026,9 +1896,9 @@ struct HostDBTestReverse : public Continuation { mainEvent(int event, Event *e) { if (event == EVENT_HOST_DB_LOOKUP) { - HostDBInfo *i = reinterpret_cast(e); + auto *i = reinterpret_cast(e); if (i) { - rprintf(test, "HostDBTestReverse: reversed %s\n", i->hostname()); + rprintf(test, "HostDBTestReverse: reversed %s\n", i->name()); } outstanding--; } @@ -2145,93 +2015,110 @@ HostDBFileContinuation::destroy() // We can't allow more than one update to be // proceeding at a time in any case so we might as well make these // globals. -int HostDBFileUpdateActive = 0; +std::atomic HostDBFileUpdateActive{false}; -static void -ParseHostLine(Ptr &map, char *l) +/* Container for temporarily holding data from the host file. For each FQDN there is a vector of IPv4 + * and IPv6 addresses. These are used to generate the HostDBRecord instances that are stored persistently. + */ +using HostAddrMap = std::unordered_map, std::vector>>; + +namespace { - Tokenizer elts(" \t"); - int n_elts = elts.Initialize(l, SHARE_TOKS); +constexpr unsigned IPV4_IDX = 0; +constexpr unsigned IPV6_IDX = 1; +} // namespace +static void +ParseHostLine(TextView line, HostAddrMap &map) +{ // Elements should be the address then a list of host names. + TextView addr_text = line.take_prefix_if(&isspace); + IpAddr addr; + // Don't use RecHttpLoadIp because the address *must* be literal. - IpAddr ip; - if (n_elts > 1 && 0 == ip.load(elts[0])) { - for (int i = 1; i < n_elts; ++i) { - ts::ConstBuffer name(elts[i], strlen(elts[i])); - // If we don't have an entry already (host files only support single IPs for a given name) - if (map->hosts_file_map.find(name) == map->hosts_file_map.end()) { - map->hosts_file_map[name] = ip; - } + if (TS_SUCCESS != addr.load(addr_text)) { + return; + } + + while (!line.ltrim_if(&isspace).empty()) { + TextView name = line.take_prefix_if(&isspace); + if (addr.isIp6()) { + std::get(map[name]).push_back(addr); + } else if (addr.isIp4()) { + std::get(map[name]).push_back(addr); } } } void -ParseHostFile(const char *path, unsigned int hostdb_hostfile_check_interval_parse) +ParseHostFile(ts::file::path const &path, ts_seconds hostdb_hostfile_check_interval_parse) { - Ptr parsed_hosts_file_ptr; + std::shared_ptr map; // Test and set for update in progress. - if (0 != ink_atomic_swap(&HostDBFileUpdateActive, 1)) { + bool flag = false; + if (!HostDBFileUpdateActive.compare_exchange_strong(flag, true)) { Debug("hostdb", "Skipped load of host file because update already in progress"); return; } - Debug("hostdb", "Loading host file '%s'", path); - - if (*path) { - ats_scoped_fd fd(open(path, O_RDONLY)); - if (fd >= 0) { - struct stat info; - if (0 == fstat(fd, &info)) { - // +1 in case no terminating newline - int64_t size = info.st_size + 1; - - parsed_hosts_file_ptr = new RefCountedHostsFileMap; - parsed_hosts_file_ptr->HostFileText = static_cast(ats_malloc(size)); - if (parsed_hosts_file_ptr->HostFileText) { - char *base = parsed_hosts_file_ptr->HostFileText; - char *limit; - - size = read(fd, parsed_hosts_file_ptr->HostFileText, info.st_size); - limit = parsed_hosts_file_ptr->HostFileText + size; - *limit = 0; - - // We need to get a list of all name/addr pairs so that we can - // group names for round robin records. Also note that the - // pairs have pointer back in to the text storage for the file - // so we need to keep that until we're done with @a pairs. - while (base < limit) { - char *spot = strchr(base, '\n'); - - // terminate the line. - if (nullptr == spot) { - spot = limit; // no trailing EOL, grab remaining - } else { - *spot = 0; - } - - while (base < spot && isspace(*base)) { - ++base; // skip leading ws - } - if (*base != '#' && base < spot) { // non-empty non-comment line - ParseHostLine(parsed_hosts_file_ptr, base); - } - base = spot + 1; - } - - hostdb_hostfile_update_timestamp = hostdb_current_interval; + Debug_bw("hostdb", R"(Loading host file "{}")", path); + + if (!path.empty()) { + std::error_code ec; + std::string content = ts::file::load(path, ec); + if (!ec) { + HostAddrMap addr_map; + TextView text{content}; + while (text) { + auto line = text.take_prefix_at('\n').ltrim_if(&isspace); + if (line.empty() || '#' == *line) { + continue; } + ParseHostLine(line, addr_map); } + // @a map should be loaded with all of the data, create the records. + map = std::make_shared(); + // Common loading function for creating a record from the address vector. + auto loader = [](TextView key, std::vector const &v) -> HostDBRecord::Handle { + HostDBRecord::Handle record{HostDBRecord::alloc(key, v.size())}; + record->af_family = v.front().family(); // @a v is presumed family homogenous + auto rr_info = record->rr_info(); + auto spot = v.begin(); + for (auto &item : rr_info) { + item.assign(*spot++); + } + return record; + }; + // Walk the temporary map and create the corresponding records for the persistent map. + for (auto const &[key, value] : addr_map) { + // Bit of subtlety to be able to search records with a view and not a string - the key + // must point at stable memory for the name, which is available in the record itself. + // Therefore the lookup for adding the record must be done using a view based in the record. + // It doesn't matter if it's the IPv4 or IPv6 record that's used, both are stable and equal + // to each other. + // IPv4 + if (auto const &v = std::get(value); v.size() > 0) { + auto r = loader(key, v); + (*map)[r->name_view()].record_4 = r; + } + // IPv6 + if (auto const &v = std::get(value); v.size() > 0) { + auto r = loader(key, v); + (*map)[r->name_view()].record_6 = r; + } + } + + hostdb_hostfile_update_timestamp = hostdb_current_interval; } } // Swap the pointer - if (parsed_hosts_file_ptr != nullptr) { - hostDB.hosts_file_ptr = parsed_hosts_file_ptr; + if (map) { + std::unique_lock lock(hostDB.host_file_mutex); + hostDB.host_file = map; } // Mark this one as completed, so we can allow another update to happen - HostDBFileUpdateActive = 0; + HostDBFileUpdateActive = false; } // @@ -2254,7 +2141,7 @@ struct HostDBRegressionContinuation : public Continuation { int i; int - mainEvent(int event, HostDBInfo *r) + mainEvent(int event, HostDBRecord *r) { (void)event; @@ -2263,27 +2150,15 @@ struct HostDBRegressionContinuation : public Continuation { } if (event == EVENT_HOST_DB_LOOKUP) { --outstanding; - // since this is a lookup done, data is either hostdbInfo or nullptr if (r) { - rprintf(test, "hostdbinfo r=%x\n", r); - char const *hname = r->perm_hostname(); - if (nullptr == hname) { - hname = "(null)"; - } - rprintf(test, "hostdbinfo hostname=%s\n", hname); - rprintf(test, "hostdbinfo rr %x\n", r->rr()); + rprintf(test, "HostDBRecord r=%x\n", r); + rprintf(test, "HostDBRecord hostname=%s\n", r->name()); // If RR, print all of the enclosed records - if (r->rr()) { - rprintf(test, "hostdbinfo good=%d\n", r->rr()->good); - for (int x = 0; x < r->rr()->good; x++) { - ip_port_text_buffer ip_buf; - ats_ip_ntop(r->rr()->info(x).ip(), ip_buf, sizeof(ip_buf)); - rprintf(test, "hostdbinfo RR%d ip=%s\n", x, ip_buf); - } - } else { // Otherwise, just the one will do + auto rr_info{r->rr_info()}; + for (int x = 0; x < r->rr_count; ++x) { ip_port_text_buffer ip_buf; - ats_ip_ntop(r->ip(), ip_buf, sizeof(ip_buf)); - rprintf(test, "hostdbinfo A ip=%s\n", ip_buf); + rr_info[x].data.ip.toString(ip_buf, sizeof(ip_buf)); + rprintf(test, "hostdbinfo RR%d ip=%s\n", x, ip_buf); } ++success; } else { @@ -2323,9 +2198,9 @@ struct HostDBRegressionContinuation : public Continuation { static const char *dns_test_hosts[] = { "www.apple.com", "www.ibm.com", "www.microsoft.com", - "www.coke.com", // RR record - "4.2.2.2", // An IP-- since we don't expect resolution - "127.0.0.1", // loopback since it has some special handling + "yahoo.com", // RR record + "4.2.2.2", // An IP-- since we don't expect resolution + "127.0.0.1", // loopback since it has some special handling }; REGRESSION_TEST(HostDBProcessor)(RegressionTest *t, int atype, int *pstatus) @@ -2334,3 +2209,214 @@ REGRESSION_TEST(HostDBProcessor)(RegressionTest *t, int atype, int *pstatus) } #endif +// ----- +void +HostDBRecord::free() +{ + if (_iobuffer_index > 0) { + Debug("hostdb", "freeing %d bytes at [%p]", (1 << (7 + _iobuffer_index)), this); + ioBufAllocator[_iobuffer_index].free_void(static_cast(this)); + } +} + +HostDBRecord * +HostDBRecord::alloc(TextView query_name, unsigned int rr_count, size_t srv_name_size) +{ + const ts::Scalar<8> qn_size = ts::round_up(query_name.size() + 1); + const ts::Scalar<8> r_size = ts::round_up(sizeof(self_type) + qn_size + rr_count * sizeof(HostDBInfo) + srv_name_size); + int iobuffer_index = iobuffer_size_to_index(r_size, hostdb_max_iobuf_index); + ink_release_assert(iobuffer_index >= 0); + auto ptr = ioBufAllocator[iobuffer_index].alloc_void(); + memset(ptr, 0, r_size); + auto self = static_cast(ptr); + new (self) self_type(); + self->_iobuffer_index = iobuffer_index; + self->_record_size = r_size; + + Debug("hostdb", "allocating %ld bytes for %.*s with %d RR records at [%p]", r_size.value(), int(query_name.size()), + query_name.data(), rr_count, self); + + // where in our block of memory we are + int offset = sizeof(self_type); + memcpy(self->apply_offset(offset), query_name); + offset += qn_size; + self->rr_offset = offset; + self->rr_count = rr_count; + // Construct the info instances to a valid state. + for (auto &info : self->rr_info()) { + new (&info) std::remove_reference_t; + } + + return self; +} + +HostDBRecord::self_type * +HostDBRecord::unmarshall(char *buff, unsigned size) +{ + if (size < sizeof(self_type)) { + return nullptr; + } + auto src = reinterpret_cast(buff); + ink_release_assert(size == src->_record_size); + auto ptr = ioBufAllocator[src->_iobuffer_index].alloc_void(); + auto self = static_cast(ptr); + new (self) self_type(); + auto delta = sizeof(RefCountObj); // skip the VFTP and ref count. + memcpy(static_cast(ptr) + delta, buff + delta, size - delta); + return self; +} + +bool +HostDBRecord::serve_stale_but_revalidate() const +{ + // the option is disabled + if (hostdb_serve_stale_but_revalidate <= 0) { + return false; + } + + // ip_timeout_interval == DNS TTL + // hostdb_serve_stale_but_revalidate == number of seconds + // ip_interval() is the number of seconds between now() and when the entry was inserted + if ((ip_timeout_interval + ts_seconds(hostdb_serve_stale_but_revalidate)) > ip_interval()) { + Debug_bw("hostdb", "serving stale entry {} | {} | {} as requested by config", ip_timeout_interval, + hostdb_serve_stale_but_revalidate, ip_interval()); + return true; + } + + // otherwise, the entry is too old + return false; +} + +HostDBInfo * +HostDBRecord::select_best_srv(char *target, InkRand *rand, ts_time now, ts_seconds fail_window) +{ + ink_assert(rr_count <= 0 || static_cast(rr_count) > hostdb_round_robin_max_count); + + int i = 0; + int live_n = 0; + uint32_t weight = 0, p = INT32_MAX; + HostDBInfo *result = nullptr; + auto rr = this->rr_info(); + // Array of live targets, sized by @a live_n + HostDBInfo *live[rr.count()]; + for (auto &target : rr) { + // skip dead upstreams. + if (rr[i].is_dead(now, fail_window)) { + continue; + } + + if (target.data.srv.srv_priority <= p) { + p = target.data.srv.srv_priority; + weight += target.data.srv.srv_weight; + live[live_n++] = ⌖ + } else { + break; + } + }; + + if (live_n == 0 || weight == 0) { // no valid or weighted choice, use strict RR + result = this->select_next_rr(now, fail_window); + } else { + uint32_t xx = rand->random() % weight; + for (i = 0; i < live_n - 1 && xx >= live[i]->data.srv.srv_weight; ++i) + xx -= live[i]->data.srv.srv_weight; + + result = live[i]; + } + + if (result) { + ink_strlcpy(target, this->name(), MAXDNAME); + return result; + } + return nullptr; +} + +HostDBInfo * +HostDBRecord::select_next_rr(ts_time now, ts_seconds fail_window) +{ + auto rr_info = this->rr_info(); + for (unsigned idx = 0, limit = rr_info.count(); idx < limit; ++idx) { + auto &target = rr_info[this->next_rr()]; + if (target.select(now, fail_window)) { + return ⌖ + } + } + + return nullptr; +} + +unsigned +HostDBRecord::next_rr() +{ + auto raw_idx = ++_rr_idx; + // Modulus on an atomic is a bit tricky - need to make sure the value is always decremented by the + // modulus even if another thread incremented. Update to modulus value iff the value hasn't been + // incremented elsewhere. Eventually the "last" incrementer will do the update. + auto idx = raw_idx % rr_count; + _rr_idx.compare_exchange_weak(raw_idx, idx); + return idx; +} + +HostDBInfo * +HostDBRecord::find(sockaddr const *addr) +{ + for (auto &item : this->rr_info()) { + if (item.data.ip == addr) { + return &item; + } + } + return nullptr; +} + +bool +ResolveInfo::resolve_immediate() +{ + if (resolved_p) { + // nothing - already resolved. + } else if (IpAddr tmp; TS_SUCCESS == tmp.load(lookup_name)) { + ts::bwprint(ts::bw_dbg, "[resolve_immediate] success - FQDN '{}' is a valid IP address.", lookup_name); + Debug("hostdb", "%s", ts::bw_dbg.c_str()); + addr.assign(tmp); + resolved_p = true; + } + return resolved_p; +} + +bool +ResolveInfo::set_active(HostDBInfo *info) +{ + active = info; + if (info) { + addr.assign(active->data.ip); + resolved_p = true; + return true; + } + resolved_p = false; + return false; +} + +bool +ResolveInfo::select_next_rr() +{ + if (active) { + if (auto rr_info{this->record->rr_info()}; rr_info.count() > 1) { + unsigned limit = active - rr_info.data(), idx = (limit + 1) % rr_info.count(); + while ((idx = (idx + 1) % rr_info.count()) != limit && !rr_info[idx].is_alive()) + ; + active = &rr_info[idx]; + return idx != limit; // if the active record was actually changed. + } + } + return false; +} + +bool +ResolveInfo::set_upstream_address(IpAddr const &ip_addr) +{ + if (ip_addr.isValid()) { + addr.assign(ip_addr); + resolved_p = true; + return true; + } + return false; +} diff --git a/iocore/hostdb/I_HostDBProcessor.h b/iocore/hostdb/I_HostDBProcessor.h index 0be0a81b4a1..e08fde4fd54 100644 --- a/iocore/hostdb/I_HostDBProcessor.h +++ b/iocore/hostdb/I_HostDBProcessor.h @@ -23,10 +23,14 @@ #pragma once +#include +#include + #include "tscore/HashFNV.h" #include "tscore/ink_time.h" #include "tscore/CryptoHash.h" #include "tscore/ink_align.h" +#include "tscore/ink_inet.h" #include "tscore/ink_resolver.h" #include "tscore/HTTPVersion.h" #include "I_EventSystem.h" @@ -46,6 +50,7 @@ // Data // struct HostDBContinuation; +struct ResolveInfo; // // The host database stores host information, most notably the @@ -56,7 +61,7 @@ struct HostDBContinuation; // disk representation to decrease # of seeks. // extern int hostdb_enable; -extern ink_time_t hostdb_current_interval; +extern ts_time hostdb_current_interval; extern unsigned int hostdb_ip_stale_interval; extern unsigned int hostdb_ip_timeout_interval; extern unsigned int hostdb_ip_fail_timeout_interval; @@ -84,339 +89,415 @@ makeHostHash(const char *string) // Types // -/** Host information metadata used by various parts of HostDB. - * It is stored as generic data in the cache. - * - * As a @c union only one of the members is valid, Which one depends on context data in the - * @c HostDBInfo. This data is written literally to disk therefore if any change is made, - * the @c object_version for the cache must be updated by modifying @c HostDBInfo::version. - * - * @see HostDBInfo::version - */ -union HostDBApplicationInfo { - /// Generic storage. This is verified to be the size of the union. - struct application_data_allotment { - unsigned int application1; - unsigned int application2; - } allotment; - - ////////////////////////////////////////////////////////// - // http server attributes in the host database // - // // - // http_version - one of HTTPVersion // - // last_failure - UNIX time for the last time // - // we tried the server & failed // - // fail_count - Number of times we tried and // - // and failed to contact the host // - ////////////////////////////////////////////////////////// - struct http_server_attr { - uint32_t last_failure; - HTTPVersion http_version; - uint8_t fail_count; - http_server_attr() : http_version() {} - } http_data; - - struct application_data_rr { - unsigned int offset; - } rr; - HostDBApplicationInfo() : http_data() {} -}; - -struct HostDBRoundRobin; +class HostDBRecord; +/// Information for an SRV record. struct SRVInfo { - unsigned int srv_offset : 16; + unsigned int srv_offset : 16; ///< Memory offset from @c HostDBInfo to name. unsigned int srv_weight : 16; unsigned int srv_priority : 16; unsigned int srv_port : 16; unsigned int key; }; -struct HostDBInfo : public RefCountObj { - /** Internal IP address data. - This is at least large enough to hold an IPv6 address. - */ +/// Type of data stored. +enum class HostDBType : uint8_t { + UNSPEC, ///< No valid data. + ADDR, ///< IP address. + SRV, ///< SRV record. + HOST ///< Hostname (reverse DNS) +}; +char const *name_of(HostDBType t); - static HostDBInfo * - alloc(int size = 0) - { - size += sizeof(HostDBInfo); - int iobuffer_index = iobuffer_size_to_index(size, hostdb_max_iobuf_index); - ink_release_assert(iobuffer_index >= 0); - void *ptr = ioBufAllocator[iobuffer_index].alloc_void(); - memset(ptr, 0, size); - HostDBInfo *ret = new (ptr) HostDBInfo(); - ret->_iobuffer_index = iobuffer_index; - return ret; - } +/** Information about a single target. + */ +struct HostDBInfo { + using self_type = HostDBInfo; ///< Self reference type. - void - free() override - { - ink_release_assert(from_alloc()); - Debug("hostdb", "freeing %d bytes at [%p]", (1 << (7 + _iobuffer_index)), this); - ioBufAllocator[_iobuffer_index].free_void((void *)(this)); - } + /// Default constructor. + HostDBInfo() = default; - /// Effectively the @c object_version for cache data. - /// This is used to indicate incompatible changes in the binary layout of HostDB records. - /// It must be updated if any such change is made, even if it is functionally equivalent. - static ts::VersionNumber - version() - { - /// - 1.0 Initial version. - /// - 1.1 tweak HostDBApplicationInfo::http_data. - return ts::VersionNumber(1, 1); - } + HostDBInfo &operator=(HostDBInfo const &that); - static HostDBInfo * - unmarshall(char *buf, unsigned int size) - { - if (size < sizeof(HostDBInfo)) { - return nullptr; - } - HostDBInfo *ret = HostDBInfo::alloc(size - sizeof(HostDBInfo)); - int buf_index = ret->_iobuffer_index; - memcpy((void *)ret, buf, size); - // Reset the refcount back to 0, this is a bit ugly-- but I'm not sure we want to expose a method - // to mess with the refcount, since this is a fairly unique use case - ret = new (ret) HostDBInfo(); - ret->_iobuffer_index = buf_index; - return ret; - } + /// Absolute time of when this target failed. + /// A value of zero (@c TS_TIME_ZERO ) indicates no failure. + ts_time last_fail_time() const; - // return expiry time (in seconds since epoch) - ink_time_t - expiry_time() const - { - return ip_timestamp + ip_timeout_interval + hostdb_serve_stale_but_revalidate; - } + /// Target is alive - no known failure. + bool is_alive(); - sockaddr * - ip() - { - return &data.ip.sa; - } + /// Target has failed and is still in the blocked time window. + bool is_dead(ts_time now, ts_seconds fail_window); - sockaddr const * - ip() const - { - return &data.ip.sa; - } + /** Select this target. + * + * @param now Current time. + * @param fail_window Failure window. + * @return Status of the selection. + * + * If a zombie is selected the failure time is updated to make it look dead to other threads in a thread safe + * manner. The caller should check @c last_fail_time to see if a zombie was selected. + */ + bool select(ts_time now, ts_seconds fail_window); - char *hostname() const; - char *perm_hostname() const; - char *srvname(HostDBRoundRobin *rr) const; + /// Check if this info is valid. + bool is_valid() const; - /// Check if this entry is an element of a round robin entry. - /// If @c true then this entry is part of and was obtained from a round robin root. This is useful if the - /// address doesn't work - a retry can probably get a new address by doing another lookup and resolving to - /// a different element of the round robin. - bool - is_rr_elt() const - { - return 0 != round_robin_elt; - } + /// Mark this info as invalid. + void invalidate(); - HostDBRoundRobin *rr(); + /** Mark the entry as down. + * + * @param now Time of the failure. + * @return @c true if @a this was marked down, @c false if not. + * + * This can return @c false if the entry is already marked down, in which case the failure time is not updated. + */ + bool mark_down(ts_time now); - unsigned int - ip_interval() const - { - return (hostdb_current_interval - ip_timestamp) & 0x7FFFFFFF; - } + /** Mark the target as up / alive. + * + * @return Previous alive state of the target. + */ + bool mark_up(); - int - ip_time_remaining() const - { - return static_cast(ip_timeout_interval) - static_cast(this->ip_interval()); - } + char const *srvname() const; - bool - is_ip_stale() const - { - return ip_timeout_interval >= 2 * hostdb_ip_stale_interval && ip_interval() >= hostdb_ip_stale_interval; - } + /** Migrate data after a DNS update. + * + * @param that Source item. + * + * This moves only specific state information, it is not a generic copy. + */ + void migrate_from(self_type const &that); - bool - is_ip_timeout() const - { - return ip_interval() >= ip_timeout_interval; - } + /// A target is either an IP address or an SRV record. + /// The type should be indicated by @c flags.f.is_srv; + union { + IpAddr ip; ///< IP address / port data. + SRVInfo srv; ///< SRV record. + } data{IpAddr{}}; + + /// Data that migrates after updated DNS records are processed. + /// @see migrate_from + /// @{ + /// Last time a failure was recorded. + std::atomic last_failure{TS_TIME_ZERO}; + /// Count of connection failures + std::atomic fail_count{0}; + /// Expected HTTP version of the target based on earlier transactions. + HTTPVersion http_version = HTTP_INVALID; + /// @} + + self_type &assign(IpAddr const &addr); + +protected: + self_type &assign(sa_family_t af, void const *addr); + self_type &assign(SRV const *srv, char const *name); + + HostDBType type = HostDBType::UNSPEC; ///< Invalid data. + + friend HostDBContinuation; +}; - bool - is_ip_fail_timeout() const - { - return ip_interval() >= hostdb_ip_fail_timeout_interval; +inline HostDBInfo & +HostDBInfo::operator=(HostDBInfo const &that) +{ + if (this != &that) { + memcpy(static_cast(this), static_cast(&that), sizeof(*this)); } + return *this; +} - void - refresh_ip() - { - ip_timestamp = hostdb_current_interval; - } +inline ts_time +HostDBInfo::last_fail_time() const +{ + return last_failure; +} - bool - serve_stale_but_revalidate() const - { - // the option is disabled - if (hostdb_serve_stale_but_revalidate <= 0) { - return false; - } +inline bool +HostDBInfo::is_alive() +{ + return this->last_fail_time() == TS_TIME_ZERO; +} - // ip_timeout_interval == DNS TTL - // hostdb_serve_stale_but_revalidate == number of seconds - // ip_interval() is the number of seconds between now() and when the entry was inserted - if ((ip_timeout_interval + hostdb_serve_stale_but_revalidate) > ip_interval()) { - Debug("hostdb", "serving stale entry %d | %d | %d as requested by config", ip_timeout_interval, - hostdb_serve_stale_but_revalidate, ip_interval()); - return true; - } +inline bool +HostDBInfo::is_dead(ts_time now, ts_seconds fail_window) +{ + auto last_fail = this->last_fail_time(); + return (last_fail != TS_TIME_ZERO) && (last_fail + fail_window < now); +} + +inline bool +HostDBInfo::mark_up() +{ + auto t = last_failure.exchange(TS_TIME_ZERO); + return t != TS_TIME_ZERO; +} + +inline bool +HostDBInfo::mark_down(ts_time now) +{ + auto t0{TS_TIME_ZERO}; + return last_failure.compare_exchange_strong(t0, now); +} - // otherwise, the entry is too old - return false; +inline bool +HostDBInfo::select(ts_time now, ts_seconds fail_window) +{ + auto t0 = this->last_fail_time(); + if (t0 == TS_TIME_ZERO) { + return true; // it's alive and so is valid for selection. } + // Success means this is a zombie and this thread updated the failure time. + return (t0 + fail_window < now) && last_failure.compare_exchange_strong(t0, now); +} + +inline void +HostDBInfo::migrate_from(HostDBInfo::self_type const &that) +{ + this->last_failure = that.last_failure.load(); + this->http_version = that.http_version; +} - /* - * Given the current time `now` and the fail_window, determine if this real is alive +inline bool +HostDBInfo::is_valid() const +{ + return type != HostDBType::UNSPEC; +} + +inline void +HostDBInfo::invalidate() +{ + type = HostDBType::UNSPEC; +} + +// ---- +/** Root item for HostDB. + * This is the container for HostDB data. It is always an array of @c HostDBInfo instances plus metadata. + * All strings are C-strings and therefore don't need a distinct size. + * + */ +class HostDBRecord : public RefCountObj +{ + friend struct HostDBContinuation; + friend struct ShowHostDB; + using self_type = HostDBRecord; + + /// Size of the IO buffer block owned by @a this. + /// If negative @a this is in not allocated memory. + int _iobuffer_index{-1}; + /// Actual size of the data. + unsigned _record_size = sizeof(self_type); + +public: + HostDBRecord() = default; + HostDBRecord(self_type const &that) = delete; + + using Handle = Ptr; ///< Shared pointer type to hold an instance. + + /** Allocate an instance from the IOBuffers. + * + * @param query_name Name of the query for the record. + * @param rr_count Number of info instances. + * @param srv_name_size Storage for SRV names, if any. + * @return An instance sufficient to hold the specified data. + * + * The query name will stored and initialized, and the info instances initialized. */ - bool - is_alive(ink_time_t now, int32_t fail_window) - { - unsigned int last_failure = app.http_data.last_failure; - - if (last_failure == 0 || (unsigned int)(now - fail_window) > last_failure) { - return true; - } else { - // Entry is marked down. Make sure some nasty clock skew - // did not occur. Use the retry time to set an upper bound - // as to how far in the future we should tolerate bogus last - // failure times. This sets the upper bound that we would ever - // consider a server down to 2*down_server_timeout - if ((unsigned int)(now + fail_window) < last_failure) { - app.http_data.last_failure = 0; - return false; - } - return false; - } - } + static self_type *alloc(ts::TextView query_name, unsigned rr_count, size_t srv_name_size = 0); - bool - is_failed() const - { - return !((is_srv && data.srv.srv_offset) || (reverse_dns && data.hostname_offset) || ats_is_ip(ip())); - } + /// Type of data stored in this record. + HostDBType record_type = HostDBType::UNSPEC; - void - set_failed() - { - if (is_srv) { - data.srv.srv_offset = 0; - } else if (reverse_dns) { - data.hostname_offset = 0; - } else { - ats_ip_invalidate(ip()); - } - } + /// IP family of this record. + sa_family_t af_family = AF_UNSPEC; - uint64_t key{0}; + /// Offset from @a this to the VLA. + unsigned short rr_offset = 0; - // Application specific data. NOTE: We need an integral number of - // these per block. This structure is 32 bytes. (at 200k hosts = - // 8 Meg). Which gives us 7 bytes of application information. - HostDBApplicationInfo app; + /// Number of @c HostDBInfo instances. + unsigned short rr_count = 0; - union { - IpEndpoint ip; ///< IP address / port data. - unsigned int hostname_offset; ///< Some hostname thing. - SRVInfo srv; - } data; + /// Timing data for switch records in the RR. + std::atomic rr_ctime{TS_TIME_ZERO}; + + /// Hash key. + uint64_t key; + + /// When the data was received. + ts_time ip_timestamp; - unsigned int hostname_offset{0}; // always maintain a permanent copy of the hostname for non-rev dns records. + /// Valid duration of the data. + ts_seconds ip_timeout_interval; - unsigned int ip_timestamp{0}; + /** Atomically advance the round robin index. + * + * If multiple threads call this simultaneously each thread will get a distinct return value. + * + * @return The new round robin index. + */ + unsigned next_rr(); + + /** Pick the next round robin and update the record atomically. + * + * @note This may select a zombie server and reserve it for the caller, therefore the caller must + * attempt to connect to the selected target if possible. + * + * @param now Current time to use for aliveness calculations. + * @param fail_window Blackout time for dead servers. + * @return Status of the updated target. + * + * If the return value is @c HostDBInfo::Status::DEAD this means all targets are dead and there is + * no valid upstream. + * + * @note Concurrency - this is not done under lock and depends on the caller for correct use. + * For strict round robin, it is a feature that every call will get a distinct index. For + * timed round robin, the caller must arrange to have only one thread call this per time interval. + */ + HostDBInfo *select_next_rr(ts_time now, ts_seconds fail_window); - unsigned int ip_timeout_interval{0}; // bounded between 1 and HOST_DB_MAX_TTL (0x1FFFFF, 24 days) + /// Check if this record is of SRV targets. + bool is_srv() const; - unsigned int is_srv : 1; - unsigned int reverse_dns : 1; + /** Query name for the record. + * @return A C-string. + * If this is a @c HOST record, this is the resolved named and the query was based on the IP address. + * Otherwise this is the name used in the DNS query. + */ + char const *name() const; + + /** Query name for the record. + * @return A view. + * If this is a @c HOST record, this is the resolved named and the query was based on the IP address. + * Otherwise this is the name used in the DNS query. + * @note Although not included in the view, the name is always nul terminated and the string can + * be used as a C-string. + */ + ts::TextView name_view() const; - unsigned int round_robin : 1; // This is the root of a round robin block - unsigned int round_robin_elt : 1; // This is an address in a round robin block + /// Get the array of info instances. + ts::MemSpan rr_info(); - HostDBInfo() : _iobuffer_index{-1} {} + /** Find a host record by IP address. + * + * @param addr Address key. + * @return A pointer to the info instance if a match is found, @c nullptr if not. + */ + HostDBInfo *find(sockaddr const *addr); + + /** Select an upstream target. + * + * @param now Current time. + * @param fail_window Dead server blackout time. + * @param hash_addr Inbound remote IP address. + * @return A selected target, or @c nullptr if there are no valid targets. + * + * This accounts for the round robin setting. The default is to use "client affinity" in + * which case @a hash_addr is as a hash seed to select the target. + * + * This may select a zombie target, which can be detected by checking the target's last + * failure time. If it is not @c TS_TIME_ZERO the target is a zombie. Other transactions will + * be blocked from selecting that target until @a fail_window time has passed. + * + * In cases other than strict round robin, a base target is selected. If valid, that is returned, + * but if not then the targets in this record are searched until a valid one is found. The result + * is this can be called to select a target for failover when a previous target fails. + */ + HostDBInfo *select_best_http(ts_time now, ts_seconds fail_window, sockaddr const *hash_addr); + HostDBInfo *select_best_srv(char *target, InkRand *rand, ts_time now, ts_seconds fail_window); - HostDBInfo(HostDBInfo const &src) : RefCountObj() - { - memcpy(static_cast(this), static_cast(&src), sizeof(*this)); - _iobuffer_index = -1; - } + bool is_failed() const; - HostDBInfo & - operator=(HostDBInfo const &src) - { - if (this != &src) { - int iob_idx = _iobuffer_index; - memcpy(static_cast(this), static_cast(&src), sizeof(*this)); - _iobuffer_index = iob_idx; - } - return *this; - } + void set_failed(); - bool - from_alloc() const - { - return _iobuffer_index >= 0; - } + /// @return The time point when the item expires. + ts_time expiry_time() const; -private: - // The value of this will be -1 for objects that are not created by the alloc() static member function. - int _iobuffer_index; -}; + ts_seconds ip_interval() const; -struct HostDBRoundRobin { - /** Total number (to compute space used). */ - short rrcount = 0; + ts_seconds ip_time_remaining() const; - /** Number which have not failed a connect. */ - short good = 0; + bool is_ip_stale() const; - unsigned short current = 0; - ink_time_t timed_rr_ctime = 0; + bool is_ip_timeout() const; - // This is the equivalent of a variable length array, we can't use a VLA because - // HostDBInfo is a non-POD type-- so this is the best we can do. - HostDBInfo & - info(short n) + bool is_ip_fail_timeout() const; + + void refresh_ip(); + + bool serve_stale_but_revalidate() const; + + /// Deallocate @a this. + void free() override; + + /** The current round robin index. + * + * @return The current index. + * + * @note The internal index may be out of range due to concurrency constraints - this insures the + * returned valu is in range. + */ + unsigned short rr_idx() const; + + /** Offset from the current round robin index. + * + * @param delta Distance from the current index. + * @return The effective index. + */ + unsigned short rr_idx(unsigned short delta) const; + + /// The index of @a target in this record. + int index_of(HostDBInfo const *target) const; + + /** Allocation and initialize an instance from a serialized buffer. + * + * @param buff Serialization data. + * @param size Size of @a buff. + * @return An instance initialized from @a buff. + */ + static self_type *unmarshall(char *buff, unsigned size); + + /// Database version. + static constexpr ts::VersionNumber Version{3, 0}; + +protected: + /// Current active info. + /// @note This value may be out of range due to the difficulty of synchronization, therefore + /// must always be taken modulus @c rr_count when used. Use the @c rr_idx() method unless + /// raw access is required. + std::atomic _rr_idx = 0; + + /** Access an internal object at @a offset. + * + * @tparam T Type of object. + * @param offset Offset of object. + * @return A pointer to the object of type @a T. + * + * @a offset is applied to @a this record and the result cast to a pointer to @a T. + * + * @note @a offset based at @a this. + */ + template + T * + apply_offset(unsigned offset) { - ink_assert(n < rrcount && n >= 0); - return *((HostDBInfo *)((char *)this + sizeof(HostDBRoundRobin)) + n); + return reinterpret_cast(reinterpret_cast(this) + offset); } - // Return the allocation size of a HostDBRoundRobin struct suitable for storing - // "count" HostDBInfo records. - static unsigned - size(unsigned count, unsigned srv_len = 0) + template + T const * + apply_offset(unsigned offset) const { - ink_assert(count > 0); - return INK_ALIGN((sizeof(HostDBRoundRobin) + (count * sizeof(HostDBInfo)) + srv_len), 8); + return reinterpret_cast(reinterpret_cast(this) + offset); } - /** Find the index of @a addr in member @a info. - @return The index if found, -1 if not found. - */ - int index_of(sockaddr const *addr); - HostDBInfo *find_ip(sockaddr const *addr); - // Find the srv target - HostDBInfo *find_target(const char *target); - /** Select the next entry after @a addr. - @note If @a addr isn't an address in the round robin nothing is updated. - @return The selected entry or @c nullptr if @a addr wasn't present. - */ - HostDBInfo *select_next(sockaddr const *addr); - HostDBInfo *select_best_http(sockaddr const *client_ip, ink_time_t now, int32_t fail_window); - HostDBInfo *select_best_srv(char *target, InkRand *rand, ink_time_t now, int32_t fail_window); - HostDBRoundRobin() {} + union { + uint16_t all; + struct { + unsigned failed_p : 1; ///< DNS error. + } f; + } flags{0}; }; struct HostDBCache; @@ -424,10 +505,123 @@ struct HostDBHash; // Prototype for inline completion function or // getbyname_imm() -typedef void (Continuation::*cb_process_result_pfn)(HostDBInfo *r); +using cb_process_result_pfn = void (Continuation::*)(HostDBRecord *r); Action *iterate(Continuation *cont); +/** Information for doing host resolution for a request. + * + * This is effectively a state object for a request attempting to connect upstream. Information about its attempt + * that are local to the request are kept here, while shared data is accessed via the @c HostDBInfo pointers. + * + * A primitive version of the IP address generator concept. + */ +struct ResolveInfo { + using self_type = ResolveInfo; ///< Self reference type. + + /// Not quite sure what this is for. + enum UpstreamResolveStyle { UNDEFINED_LOOKUP, ORIGIN_SERVER, PARENT_PROXY, HOST_NONE }; + + /** Origin server address source selection. + + If config says to use CTA (client target addr) state is TRY_CLIENT, otherwise it + remains the default. If the connect fails then we switch to a USE. We go to USE_HOSTDB if (1) + the HostDB lookup is successful and (2) some address other than the CTA is available to try. + Otherwise we keep retrying on the CTA (USE_CLIENT) up to the max retry value. In essence we + try to treat the CTA as if it were another RR value in the HostDB record. + */ + enum class OS_Addr { + TRY_DEFAULT, ///< Initial state, use what config says. + TRY_HOSTDB, ///< Try HostDB data. + TRY_CLIENT, ///< Try client target addr. + USE_HOSTDB, ///< Force use of HostDB target address. + USE_CLIENT, ///< Force client target addr. + USE_API ///< Use the API provided address. + }; + + ResolveInfo() = default; + ~ResolveInfo() = default; + + /// Keep a reference to the base HostDB object, so it doesn't get GC'd. + Ptr record; + HostDBInfo *active = nullptr; ///< Active host record. + + /// Working address. The meaning / source of the value depends on other elements. + /// This is the "resolved" address if @a resolved_p is @c true. + IpEndpoint addr; + + int attempts = 0; ///< Number of connection attempts. + + char const *lookup_name = nullptr; + char srv_hostname[MAXDNAME] = {0}; + const sockaddr *inbound_remote_addr = nullptr; ///< Remote address of inbound client - used for hashing. + in_port_t srv_port = 0; ///< Port from SRV lookup or API call. + + OS_Addr os_addr_style = OS_Addr::TRY_DEFAULT; + HostResStyle host_res_style = HOST_RES_IPV4; + UpstreamResolveStyle looking_up = UNDEFINED_LOOKUP; + + HTTPVersion http_version = HTTP_INVALID; + + bool resolved_p = false; ///< If there is a valid, resolved address in @a addr. + + /// Flag for @a addr being set externally. + // bool api_addr_set_p = false; + + /*** Set to true by default. If use_client_target_address is set + * to 1, this value will be set to false if the client address is + * not in the DNS pool */ + bool cta_validated_p = true; + + bool set_active(HostDBInfo *info); + + bool set_active(sockaddr const *s); + + bool set_active(std::nullptr_t); + + /** Force a resolved address. + * + * @param sa Address to use for the upstream. + * @return @c true if successful, @c false if error. + * + * This fails if @a sa isn't a valid IP address. + */ + bool set_upstream_address(const sockaddr *sa); + + bool set_upstream_address(IpAddr const &ip_addr); + + void set_upstream_port(in_port_t port); + + /** Check and (if possible) immediately resolve the upstream address without consulting the HostDB. + * The cases where this is successful are + * - The address is already resolved (@a resolved_p is @c true). + * - The upstream was set explicitly. + * - The hostname is a valid IP address. + * + * @return @c true if the upstream address was resolved, @c false if not. + */ + bool resolve_immediate(); + + /** Mark the active target as dead. + * + * @param now Time of failure. + * @return @c true if the server was marked as dead, @c false if not. + * + */ + bool mark_active_server_dead(ts_time now); + + /** Mark the active target as alive. + * + * @return @c true if the target changed state. + */ + bool mark_active_server_alive(); + + /// Select / resolve to the next RR entry for the record. + bool select_next_rr(); + + bool is_srv() const; +}; + /** The Host Database access interface. */ struct HostDBProcessor : public Processor { friend struct HostDBSync; @@ -486,29 +680,6 @@ struct HostDBProcessor : public Processor { /** Lookup Hostinfo by addr */ Action *getbyaddr_re(Continuation *cont, sockaddr const *aip); - /** Set the application information (fire-and-forget). */ - void - setbyname_appinfo(char *hostname, int len, int port, HostDBApplicationInfo *app) - { - sockaddr_in addr; - ats_ip4_set(&addr, INADDR_ANY, port); - setby(hostname, len, ats_ip_sa_cast(&addr), app); - } - - void - setbyaddr_appinfo(sockaddr const *addr, HostDBApplicationInfo *app) - { - this->setby(nullptr, 0, addr, app); - } - - void - setbyaddr_appinfo(in_addr_t ip, HostDBApplicationInfo *app) - { - sockaddr_in addr; - ats_ip4_set(&addr, ip); - this->setby(nullptr, 0, ats_ip_sa_cast(&addr), app); - } - /** Configuration. */ static int hostdb_strict_round_robin; static int hostdb_timed_round_robin; @@ -524,21 +695,151 @@ struct HostDBProcessor : public Processor { private: Action *getby(Continuation *cont, cb_process_result_pfn cb_process_result, HostDBHash &hash, Options const &opt); +}; -public: - /** Set something. - @a aip can carry address and / or port information. If setting just - by a port value, the address should be set to INADDR_ANY which is of - type IPv4. - */ - void setby(const char *hostname, ///< Hostname. - int len, ///< Length of hostname. - sockaddr const *aip, ///< Address and/or port. - HostDBApplicationInfo *app ///< I don't know. - ); +inline bool +HostDBRecord::is_srv() const +{ + return HostDBType::SRV == record_type; +} - void setby_srv(const char *hostname, int len, const char *target, HostDBApplicationInfo *app); -}; +inline char const * +HostDBRecord::name() const +{ + return this->apply_offset(sizeof(self_type)); +} + +inline ts::TextView +HostDBRecord::name_view() const +{ + return {this->name(), ts::TextView::npos}; +} + +inline ts_time +HostDBRecord::expiry_time() const +{ + return ip_timestamp + ip_timeout_interval + ts_seconds(hostdb_serve_stale_but_revalidate); +} + +inline ts_seconds +HostDBRecord::ip_interval() const +{ + static constexpr ts_seconds ZERO{0}; + static constexpr ts_seconds MAX{0x7FFFFFFF}; + return std::clamp(std::chrono::duration_cast((hostdb_current_interval - ip_timestamp)), ZERO, MAX); +} + +inline ts_seconds +HostDBRecord::ip_time_remaining() const +{ + return ip_timeout_interval - this->ip_interval(); +} + +inline bool +HostDBRecord::is_ip_stale() const +{ + return ip_timeout_interval >= ts_seconds(2 * hostdb_ip_stale_interval) && ip_interval() >= ts_seconds(hostdb_ip_stale_interval); +} + +inline bool +HostDBRecord::is_ip_timeout() const +{ + return ip_interval() >= ip_timeout_interval; +} + +inline bool +HostDBRecord::is_ip_fail_timeout() const +{ + return ip_interval() >= ts_seconds(hostdb_ip_fail_timeout_interval); +} + +inline void +HostDBRecord::refresh_ip() +{ + ip_timestamp = hostdb_current_interval; +} + +inline ts::MemSpan +HostDBRecord::rr_info() +{ + return {this->apply_offset(rr_offset), rr_count}; +} + +inline bool +HostDBRecord::is_failed() const +{ + return flags.f.failed_p; +} + +inline void +HostDBRecord::set_failed() +{ + flags.f.failed_p = true; +} + +inline unsigned short +HostDBRecord::rr_idx() const +{ + return _rr_idx % rr_count; +} + +inline unsigned short +HostDBRecord::rr_idx(unsigned short delta) const +{ + return (_rr_idx + delta) % rr_count; +} + +inline int +HostDBRecord::index_of(HostDBInfo const *target) const +{ + return target ? target - this->apply_offset(rr_offset) : -1; +} + +// -- + +inline bool +ResolveInfo::set_active(sockaddr const *s) +{ + return this->set_active(record->find(s)); +} + +inline bool +ResolveInfo::mark_active_server_alive() +{ + return active->mark_up(); +} + +inline bool +ResolveInfo::mark_active_server_dead(ts_time now) +{ + return active != nullptr && active->mark_down(now); +} + +inline bool ResolveInfo::set_active(std::nullptr_t) +{ + active = nullptr; + resolved_p = false; + return false; +} + +inline bool +ResolveInfo::set_upstream_address(sockaddr const *sa) +{ + return resolved_p = addr.assign(sa).isValid(); +} + +inline void +ResolveInfo::set_upstream_port(in_port_t port) +{ + srv_port = port; +} + +inline bool +ResolveInfo::is_srv() const +{ + return record && record->is_srv(); +} +// --- void run_HostDBTest(); diff --git a/iocore/hostdb/P_HostDBProcessor.h b/iocore/hostdb/P_HostDBProcessor.h index 1dbe1a5799b..9b71e22ab1f 100644 --- a/iocore/hostdb/P_HostDBProcessor.h +++ b/iocore/hostdb/P_HostDBProcessor.h @@ -27,6 +27,8 @@ #pragma once +#include + #include "I_HostDBProcessor.h" #include "tscore/TsBuffer.h" @@ -51,7 +53,7 @@ extern int hostdb_ttl_mode; extern int hostdb_srv_enabled; // extern int hostdb_timestamp; -extern int hostdb_sync_frequency; +extern ts_seconds hostdb_sync_frequency; extern int hostdb_disable_reverse_lookup; // Static configuration information @@ -74,26 +76,6 @@ enum HostDBMark { */ extern const char *string_for(HostDBMark mark); -inline unsigned int -HOSTDB_CLIENT_IP_HASH(sockaddr const *lhs, sockaddr const *rhs) -{ - unsigned int zret = ~static_cast(0); - if (ats_ip_are_compatible(lhs, rhs)) { - if (ats_is_ip4(lhs)) { - in_addr_t ip1 = ats_ip4_addr_cast(lhs); - in_addr_t ip2 = ats_ip4_addr_cast(rhs); - zret = (ip1 >> 16) ^ ip1 ^ ip2 ^ (ip2 >> 16); - } else if (ats_is_ip6(lhs)) { - uint32_t const *ip1 = ats_ip_addr32_cast(lhs); - uint32_t const *ip2 = ats_ip_addr32_cast(rhs); - for (int i = 0; i < 4; ++i, ++ip1, ++ip2) { - zret ^= (*ip1 >> 16) ^ *ip1 ^ *ip2 ^ (*ip2 >> 16); - } - } - } - return zret & 0xFFFF; -} - // // Constants // @@ -169,21 +151,12 @@ extern RecRawStatBlock *hostdb_rsb; #define HOSTDB_DECREMENT_THREAD_DYN_STAT(_s, _t) RecIncrRawStatSum(hostdb_rsb, _t, (int)_s, -1); -struct CmpConstBuffferCaseInsensitive { - bool - operator()(ts::ConstBuffer a, ts::ConstBuffer b) const - { - return ptr_len_casecmp(a._ptr, a._size, b._ptr, b._size) < 0; - } +struct HostFileRecord { + HostDBRecord::Handle record_4; + HostDBRecord::Handle record_6; }; -// Our own typedef for the host file mapping -typedef std::map HostsFileMap; -// A to hold a ref-counted map -struct RefCountedHostsFileMap : public RefCountObj { - HostsFileMap hosts_file_map; - ats_scoped_str HostFileText; -}; +using HostFileMap = std::unordered_map>; // // HostDBCache (Private) @@ -191,9 +164,11 @@ struct RefCountedHostsFileMap : public RefCountObj { struct HostDBCache { int start(int flags = 0); // Map to contain all of the host file overrides, initialize it to empty - Ptr hosts_file_ptr; + std::shared_ptr host_file; + std::shared_mutex host_file_mutex; + // TODO: make ATS call a close() method or something on shutdown (it does nothing of the sort today) - RefCountCache *refcountcache = nullptr; + RefCountCache *refcountcache = nullptr; // TODO configurable number of items in the cache Queue *pending_dns = nullptr; @@ -201,189 +176,9 @@ struct HostDBCache { Queue *remoteHostDBQueue = nullptr; HostDBCache(); bool is_pending_dns_for_hash(const CryptoHash &hash); -}; - -inline int -HostDBRoundRobin::index_of(sockaddr const *ip) -{ - bool bad = (rrcount <= 0 || (unsigned int)rrcount > hostdb_round_robin_max_count || good <= 0 || - (unsigned int)good > hostdb_round_robin_max_count); - if (bad) { - ink_assert(!"bad round robin size"); - return -1; - } - - for (int i = 0; i < good; i++) { - if (ats_ip_addr_eq(ip, info(i).ip())) { - return i; - } - } - - return -1; -} - -inline HostDBInfo * -HostDBRoundRobin::find_ip(sockaddr const *ip) -{ - int idx = this->index_of(ip); - return idx < 0 ? nullptr : &info(idx); -} - -inline HostDBInfo * -HostDBRoundRobin::select_next(sockaddr const *ip) -{ - HostDBInfo *zret = nullptr; - if (good > 1) { - int idx = this->index_of(ip); - if (idx >= 0) { - idx = (idx + 1) % good; - zret = &info(idx); - } - } - return zret; -} - -inline HostDBInfo * -HostDBRoundRobin::find_target(const char *target) -{ - bool bad = (rrcount <= 0 || (unsigned int)rrcount > hostdb_round_robin_max_count || good <= 0 || - (unsigned int)good > hostdb_round_robin_max_count); - if (bad) { - ink_assert(!"bad round robin size"); - return nullptr; - } - - uint32_t key = makeHostHash(target); - for (int i = 0; i < good; i++) { - if (info(i).data.srv.key == key && !strcmp(target, info(i).srvname(this))) - return &info(i); - } - return nullptr; -} - -inline HostDBInfo * -HostDBRoundRobin::select_best_http(sockaddr const *client_ip, ink_time_t now, int32_t fail_window) -{ - bool bad = (rrcount <= 0 || (unsigned int)rrcount > hostdb_round_robin_max_count || good <= 0 || - (unsigned int)good > hostdb_round_robin_max_count); - - if (bad) { - ink_assert(!"bad round robin size"); - return nullptr; - } - - int best_any = 0; - int best_up = -1; - - // Basic round robin, increment current and mod with how many we have - if (HostDBProcessor::hostdb_strict_round_robin) { - Debug("hostdb", "Using strict round robin"); - // Check that the host we selected is alive - for (int i = 0; i < good; i++) { - best_any = current++ % good; - if (info(best_any).is_alive(now, fail_window)) { - best_up = best_any; - break; - } - } - } else if (HostDBProcessor::hostdb_timed_round_robin > 0) { - Debug("hostdb", "Using timed round-robin for HTTP"); - if ((now - timed_rr_ctime) > HostDBProcessor::hostdb_timed_round_robin) { - Debug("hostdb", "Timed interval expired.. rotating"); - ++current; - timed_rr_ctime = now; - } - for (int i = 0; i < good; i++) { - best_any = (current + i) % good; - if (info(best_any).is_alive(now, fail_window)) { - best_up = best_any; - break; - } - } - Debug("hostdb", "Using %d for best_up", best_up); - } else { - Debug("hostdb", "Using default round robin"); - unsigned int best_hash_any = 0; - unsigned int best_hash_up = 0; - for (int i = 0; i < good; i++) { - sockaddr const *ip = info(i).ip(); - unsigned int h = HOSTDB_CLIENT_IP_HASH(client_ip, ip); - if (best_hash_any <= h) { - best_any = i; - best_hash_any = h; - } - if (info(i).is_alive(now, fail_window)) { - if (best_hash_up <= h) { - best_up = i; - best_hash_up = h; - } - } - } - } - - if (best_up != -1) { - ink_assert(best_up >= 0 && best_up < good); - return &info(best_up); - } else { - ink_assert(best_any >= 0 && best_any < good); - return &info(best_any); - } -} - -inline HostDBInfo * -HostDBRoundRobin::select_best_srv(char *target, InkRand *rand, ink_time_t now, int32_t fail_window) -{ - bool bad = (rrcount <= 0 || (unsigned int)rrcount > hostdb_round_robin_max_count || good <= 0 || - (unsigned int)good > hostdb_round_robin_max_count); - - if (bad) { - ink_assert(!"bad round robin size"); - return nullptr; - } - -#ifdef DEBUG - for (int i = 1; i < good; ++i) { - ink_assert(info(i).data.srv.srv_priority >= info(i - 1).data.srv.srv_priority); - } -#endif - - int i = 0; - int len = 0; - uint32_t weight = 0, p = INT32_MAX; - HostDBInfo *result = nullptr; - HostDBInfo *infos[good]; - do { - // if the real isn't alive-- exclude it from selection - if (!info(i).is_alive(now, fail_window)) { - continue; - } - - if (info(i).data.srv.srv_priority <= p) { - p = info(i).data.srv.srv_priority; - weight += info(i).data.srv.srv_weight; - infos[len++] = &info(i); - } else - break; - } while (++i < good); - - if (len == 0) { // all failed - result = &info(current++ % good); - } else if (weight == 0) { // srv weight is 0 - result = infos[current++ % len]; - } else { - uint32_t xx = rand->random() % weight; - for (i = 0; i < len - 1 && xx >= infos[i]->data.srv.srv_weight; ++i) - xx -= infos[i]->data.srv.srv_weight; - - result = infos[i]; - } - if (result) { - ink_strlcpy(target, result->srvname(this), MAXDNAME); - return result; - } - return nullptr; -} + std::shared_ptr acquire_host_file(); +}; // // Types @@ -397,10 +192,9 @@ struct HostDBHash { CryptoHash hash; ///< The hash value. - const char *host_name = nullptr; ///< Host name. - int host_len = 0; ///< Length of @a _host_name - IpAddr ip; ///< IP address. - in_port_t port = 0; ///< IP port (host order). + ts::TextView host_name; ///< Name of the host for the query. + IpAddr ip; ///< IP address. + in_port_t port = 0; ///< IP port (host order). /// DNS server. Not strictly part of the hash data but /// it's both used by @c HostDBContinuation and provides access to /// hash data. It's just handier to store it here for both uses. @@ -417,20 +211,23 @@ struct HostDBHash { /** Assign a hostname. This updates the split DNS data as well. */ - self &set_host(const char *name, int len); + self &set_host(ts::TextView name); + self & + set_host(char const *name) + { + return this->set_host(ts::TextView{name, strlen(name)}); + } }; // // Handles a HostDB lookup request // -struct HostDBContinuation; -typedef int (HostDBContinuation::*HostDBContHandler)(int, void *); +using HostDBContHandler = int (HostDBContinuation::*)(int, void *); struct HostDBContinuation : public Continuation { Action action; HostDBHash hash; - // IpEndpoint ip; - unsigned int ttl = 0; + ts_seconds ttl{0}; // HostDBMark db_mark; ///< Target type. /// Original IP address family style. Note this will disagree with /// @a hash.db_mark when doing a retry on an alternate family. The retry @@ -439,9 +236,8 @@ struct HostDBContinuation : public Continuation { int dns_lookup_timeout = DEFAULT_OPTIONS.timeout; Event *timeout = nullptr; Continuation *from_cont = nullptr; - HostDBApplicationInfo app; - int probe_depth = 0; - size_t current_iterate_pos = 0; + int probe_depth = 0; + size_t current_iterate_pos = 0; // char name[MAXDNAME]; // int namelen; char hash_host_name_store[MAXDNAME + 1]; // used as backing store for @a hash @@ -451,7 +247,6 @@ struct HostDBContinuation : public Continuation { unsigned int missing : 1; unsigned int force_dns : 1; - unsigned int round_robin : 1; int probeEvent(int event, Event *e); int iterateEvent(int event, Event *e); @@ -474,19 +269,23 @@ struct HostDBContinuation : public Continuation { { return hash.db_mark == HOSTDB_MARK_SRV; } - HostDBInfo *lookup_done(IpAddr const &ip, const char *aname, bool round_robin, unsigned int attl, SRVHosts *s = nullptr, - HostDBInfo *r = nullptr); + + Ptr + lookup_done(const char *query_name, ts_seconds answer_ttl, SRVHosts *s = nullptr, Ptr record = Ptr{}) + { + return this->lookup_done(ts::TextView{query_name, strlen(query_name)}, answer_ttl, s, record); + } + + Ptr lookup_done(ts::TextView query_name, ts_seconds answer_ttl, SRVHosts *s = nullptr, + Ptr record = Ptr{}); + int key_partition(); - void remove_trigger_pending_dns(); + void remove_and_trigger_pending_dns(); int set_check_pending_dns(); - HostDBInfo *insert(unsigned int attl); - /** Optional values for @c init. */ struct Options { - typedef Options self; ///< Self reference type. - int timeout = 0; ///< Timeout value. Default 0 HostResStyle host_res_style = HOST_RES_NONE; ///< IP address family fallback. Default @c HOST_RES_NONE bool force_dns = false; ///< Force DNS lookup. Default @c false @@ -499,7 +298,7 @@ struct HostDBContinuation : public Continuation { int make_get_message(char *buf, int len); int make_put_message(HostDBInfo *r, Continuation *c, char *buf, int len); - HostDBContinuation() : missing(false), force_dns(DEFAULT_OPTIONS.force_dns), round_robin(false) + HostDBContinuation() : missing(false), force_dns(DEFAULT_OPTIONS.force_dns) { ink_zero(hash_host_name_store); ink_zero(hash.hash); @@ -513,12 +312,6 @@ master_hash(CryptoHash const &hash) return static_cast(hash[1] >> 32); } -inline bool -is_dotted_form_hostname(const char *c) -{ - return -1 != (int)ink_inet_addr(c); -} - inline Queue & HostDBCache::pending_dns_for_hash(const CryptoHash &hash) { diff --git a/iocore/net/ALPNSupport.cc b/iocore/net/ALPNSupport.cc index 69b8b1c24d7..1e9bc8aacbe 100644 --- a/iocore/net/ALPNSupport.cc +++ b/iocore/net/ALPNSupport.cc @@ -57,11 +57,10 @@ ALPNSupport::unbind(SSL *ssl) void ALPNSupport::clear() { - if (npn) { - ats_free(npn); - npn = nullptr; - npnsz = 0; - } + ats_free(npn); + npn = nullptr; + npnsz = 0; + npnSet = nullptr; npnEndpoint = nullptr; } diff --git a/iocore/net/Makefile.am b/iocore/net/Makefile.am index 0f8e6d28e7d..da278b8b864 100644 --- a/iocore/net/Makefile.am +++ b/iocore/net/Makefile.am @@ -154,6 +154,7 @@ libinknet_a_SOURCES = \ P_SSLUtils.h \ P_SSLClientCoordinator.h \ P_SSLClientUtils.h \ + P_TLSKeyLogger.h \ P_OCSPStapling.h \ P_UDPConnection.h \ P_UDPIOEvent.h \ @@ -189,6 +190,7 @@ libinknet_a_SOURCES = \ OCSPStapling.cc \ TLSBasicSupport.cc \ TLSEarlyDataSupport.cc \ + TLSKeyLogger.cc \ TLSSessionResumptionSupport.cc \ TLSSNISupport.cc \ TLSTunnelSupport.cc \ diff --git a/iocore/net/OCSPStapling.cc b/iocore/net/OCSPStapling.cc index 252fda1e09c..da5a8c16356 100644 --- a/iocore/net/OCSPStapling.cc +++ b/iocore/net/OCSPStapling.cc @@ -48,6 +48,7 @@ struct certinfo { OCSP_CERTID *cid; // Certificate ID for OCSP requests or nullptr if ID cannot be determined char *uri; // Responder details char *certname; + char *user_agent; ink_mutex stapling_mutex; unsigned char resp_der[MAX_STAPLING_DER]; unsigned int resp_derlen; @@ -72,14 +73,16 @@ certinfo_map_free(void * /*parent*/, void *ptr, CRYPTO_EX_DATA * /*ad*/, int /*i } for (certinfo_map::iterator iter = map->begin(); iter != map->end(); ++iter) { - if (iter->second->uri) { - OPENSSL_free(iter->second->uri); + certinfo *cinf = iter->second; + if (cinf->uri) { + OPENSSL_free(cinf->uri); } - if (iter->second->certname) { - ats_free(iter->second->certname); - } - ink_mutex_destroy(&iter->second->stapling_mutex); - OPENSSL_free(iter->second); + + ats_free(cinf->certname); + ats_free(cinf->user_agent); + + ink_mutex_destroy(&cinf->stapling_mutex); + OPENSSL_free(cinf); } delete map; } @@ -211,9 +214,12 @@ ssl_stapling_init_cert(SSL_CTX *ctx, X509 *cert, const char *certname, const cha } // Initialize certinfo - cinf->cid = nullptr; - cinf->uri = nullptr; - cinf->certname = ats_strdup(certname); + cinf->cid = nullptr; + cinf->uri = nullptr; + cinf->certname = ats_strdup(certname); + if (SSLConfigParams::ssl_ocsp_user_agent != nullptr) { + cinf->user_agent = ats_strdup(SSLConfigParams::ssl_ocsp_user_agent); + } cinf->resp_derlen = 0; ink_mutex_init(&cinf->stapling_mutex); cinf->is_prefetched = rsp_file ? true : false; @@ -287,9 +293,8 @@ ssl_stapling_init_cert(SSL_CTX *ctx, X509 *cert, const char *certname, const cha OCSP_CERTID_free(cinf->cid); } - if (cinf->certname) { - ats_free(cinf->certname); - } + ats_free(cinf->certname); + ats_free(cinf->user_agent); if (cinf) { OPENSSL_free(cinf); @@ -368,7 +373,7 @@ stapling_check_response(certinfo *cinf, OCSP_RESPONSE *rsp) } static OCSP_RESPONSE * -query_responder(BIO *b, char *host, char *path, OCSP_REQUEST *req, int req_timeout) +query_responder(BIO *b, const char *host, const char *path, const char *user_agent, OCSP_REQUEST *req, int req_timeout) { ink_hrtime start, end; OCSP_RESPONSE *resp = nullptr; @@ -380,6 +385,9 @@ query_responder(BIO *b, char *host, char *path, OCSP_REQUEST *req, int req_timeo ctx = OCSP_sendreq_new(b, path, nullptr, -1); OCSP_REQ_CTX_add1_header(ctx, "Host", host); + if (user_agent != nullptr) { + OCSP_REQ_CTX_add1_header(ctx, "User-Agent", user_agent); + } OCSP_REQ_CTX_set1_req(ctx, req); do { @@ -399,7 +407,7 @@ query_responder(BIO *b, char *host, char *path, OCSP_REQUEST *req, int req_timeo } static OCSP_RESPONSE * -process_responder(OCSP_REQUEST *req, char *host, char *path, char *port, int req_timeout) +process_responder(OCSP_REQUEST *req, const char *host, const char *path, const char *port, const char *user_agent, int req_timeout) { BIO *cbio = nullptr; OCSP_RESPONSE *resp = nullptr; @@ -416,7 +424,7 @@ process_responder(OCSP_REQUEST *req, char *host, char *path, char *port, int req Debug("ssl_ocsp", "process_responder: failed to connect to OCSP server; host=%s port=%s path=%s", host, port, path); goto end; } - resp = query_responder(cbio, host, path, req, req_timeout); + resp = query_responder(cbio, host, path, user_agent, req, req_timeout); end: if (cbio) { @@ -456,7 +464,7 @@ stapling_refresh_response(certinfo *cinf, OCSP_RESPONSE **prsp) goto err; } - *prsp = process_responder(req, host, path, port, SSLConfigParams::ssl_ocsp_request_timeout); + *prsp = process_responder(req, host, path, port, cinf->user_agent, SSLConfigParams::ssl_ocsp_request_timeout); if (*prsp == nullptr) { goto done; } diff --git a/iocore/net/P_QUICNextProtocolAccept.h b/iocore/net/P_QUICNextProtocolAccept.h index 95752dd21e0..3ca44db5506 100644 --- a/iocore/net/P_QUICNextProtocolAccept.h +++ b/iocore/net/P_QUICNextProtocolAccept.h @@ -33,7 +33,7 @@ class QUICNextProtocolAccept : public SessionAccept QUICNextProtocolAccept(); ~QUICNextProtocolAccept(); - bool accept(NetVConnection *, MIOBuffer *, IOBufferReader *); + bool accept(NetVConnection *, MIOBuffer *, IOBufferReader *) override; // Register handler as an endpoint for the specified protocol. Neither // handler nor protocol are copied, so the caller must guarantee their @@ -50,7 +50,7 @@ class QUICNextProtocolAccept : public SessionAccept QUICNextProtocolAccept &operator=(const QUICNextProtocolAccept &) = delete; // disabled private: - int mainEvent(int event, void *netvc); + int mainEvent(int event, void *netvc) override; SSLNextProtocolSet protoset; SessionProtocolSet protoenabled; diff --git a/iocore/net/P_SSLConfig.h b/iocore/net/P_SSLConfig.h index 2018c34ea95..99ebf9db77a 100644 --- a/iocore/net/P_SSLConfig.h +++ b/iocore/net/P_SSLConfig.h @@ -124,6 +124,7 @@ struct SSLConfigParams : public ConfigInfo { static int ssl_ocsp_update_period; static int ssl_handshake_timeout_in; char *ssl_ocsp_response_path_only; + static char *ssl_ocsp_user_agent; static int origin_session_cache; static size_t origin_session_cache_size; @@ -213,7 +214,7 @@ struct SSLTicketParams : public ConfigInfo { time_t load_time = 0; char *ticket_key_filename; bool LoadTicket(bool &nochange); - void LoadTicketData(char *ticket_data, int ticket_data_len); + bool LoadTicketData(char *ticket_data, int ticket_data_len); void cleanup(); ~SSLTicketParams() override { cleanup(); } diff --git a/iocore/net/P_SSLUtils.h b/iocore/net/P_SSLUtils.h index dc8c3e80c34..b8ca3b81284 100644 --- a/iocore/net/P_SSLUtils.h +++ b/iocore/net/P_SSLUtils.h @@ -35,9 +35,7 @@ #include "P_SSLCertLookup.h" #include -#include #include -#include struct SSLConfigParams; class SSLNetVConnection; @@ -64,105 +62,6 @@ struct SSLLoadingContext { explicit SSLLoadingContext(SSL_CTX *c, SSLCertContextType ctx_type) : ctx(c), ctx_type(ctx_type) {} }; -/** A class for handling TLS secrets logging. */ -class TLSKeyLogger -{ -public: - TLSKeyLogger(const TLSKeyLogger &) = delete; - TLSKeyLogger &operator=(const TLSKeyLogger &) = delete; - - ~TLSKeyLogger() - { - std::unique_lock lock{_mutex}; - close_keylog_file(); - } - - /** A callback for TLS secret key logging. - * - * This is the callback registered with OpenSSL's SSL_CTX_set_keylog_callback - * to log TLS secrets if the user enabled that feature. For more information - * about this callback, see OpenSSL's documentation of - * SSL_CTX_set_keylog_callback. - * - * @param[in] ssl The SSL object associated with the connection. - * @param[in] line The line to place in the keylog file. - */ - static void - ssl_keylog_cb(const SSL *ssl, const char *line) - { - instance().log(line); - } - - /** Return whether TLS key logging is enabled. - * - * @return True if TLS session key logging is enabled, false otherwise. - */ - static bool - is_enabled() - { - return instance()._fd >= 0; - } - - /** Enable keylogging. - * - * @param[in] keylog_file The path to the file to log TLS secrets to. - */ - static void - enable_keylogging(const char *keylog_file) - { - instance().enable_keylogging_internal(keylog_file); - } - - /** Disable TLS secrets logging. */ - static void - disable_keylogging() - { - instance().disable_keylogging_internal(); - } - -private: - TLSKeyLogger() = default; - - /** Return the TLSKeyLogger singleton. - * - * We use a getter rather than a class static singleton member so that the - * construction of the singleton delayed until after TLS configuration is - * processed. - */ - static TLSKeyLogger & - instance() - { - static TLSKeyLogger instance; - return instance; - } - - /** Close the file descriptor for the key log file. - * - * @note This assumes that a unique lock has been acquired for _mutex. - */ - void close_keylog_file(); - - /** A TLS secret line to log to the keylog file. - * - * @param[in] line A line to log to the keylog file. - */ - void log(const char *line); - - /** Enable TLS keylogging in the instance singleton. */ - void enable_keylogging_internal(const char *keylog_file); - - /** Disable TLS keylogging in the instance singleton. */ - void disable_keylogging_internal(); - -private: - /** A file descriptor for the log file receiving the TLS secrets. */ - int _fd = -1; - - /** A mutex to coordinate dynamically changing TLS logging config changes and - * logging to the TLS log file. */ - std::shared_mutex _mutex; -}; - /** @brief Load SSL certificates from ssl_multicert.config and setup SSLCertLookup for SSLCertificateConfig */ diff --git a/iocore/net/P_TLSKeyLogger.h b/iocore/net/P_TLSKeyLogger.h new file mode 100644 index 00000000000..7555061353c --- /dev/null +++ b/iocore/net/P_TLSKeyLogger.h @@ -0,0 +1,130 @@ +/** + + @section license License + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "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 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + */ + +#pragma once + +#ifndef OPENSSL_IS_BORINGSSL +#include +#endif +#include + +#include +#include +#include + +/** A class for handling TLS secrets logging. */ +class TLSKeyLogger +{ +public: + TLSKeyLogger(const TLSKeyLogger &) = delete; + TLSKeyLogger &operator=(const TLSKeyLogger &) = delete; + + ~TLSKeyLogger() + { + std::unique_lock lock{_mutex}; + close_keylog_file(); + } + + /** A callback for TLS secret key logging. + * + * This is the callback registered with OpenSSL's SSL_CTX_set_keylog_callback + * to log TLS secrets if the user enabled that feature. For more information + * about this callback, see OpenSSL's documentation of + * SSL_CTX_set_keylog_callback. + * + * @param[in] ssl The SSL object associated with the connection. + * @param[in] line The line to place in the keylog file. + */ + static void + ssl_keylog_cb(const SSL *ssl, const char *line) + { + instance().log(line); + } + + /** Return whether TLS key logging is enabled. + * + * @return True if TLS session key logging is enabled, false otherwise. + */ + static bool + is_enabled() + { + return instance()._fd >= 0; + } + + /** Enable keylogging. + * + * @param[in] keylog_file The path to the file to log TLS secrets to. + */ + static void + enable_keylogging(const char *keylog_file) + { + instance().enable_keylogging_internal(keylog_file); + } + + /** Disable TLS secrets logging. */ + static void + disable_keylogging() + { + instance().disable_keylogging_internal(); + } + +private: + TLSKeyLogger() = default; + + /** Return the TLSKeyLogger singleton. + * + * We use a getter rather than a class static singleton member so that the + * construction of the singleton delayed until after TLS configuration is + * processed. + */ + static TLSKeyLogger & + instance() + { + static TLSKeyLogger instance; + return instance; + } + + /** Close the file descriptor for the key log file. + * + * @note This assumes that a unique lock has been acquired for _mutex. + */ + void close_keylog_file(); + + /** A TLS secret line to log to the keylog file. + * + * @param[in] line A line to log to the keylog file. + */ + void log(const char *line); + + /** Enable TLS keylogging in the instance singleton. */ + void enable_keylogging_internal(const char *keylog_file); + + /** Disable TLS keylogging in the instance singleton. */ + void disable_keylogging_internal(); + +private: + /** A file descriptor for the log file receiving the TLS secrets. */ + int _fd = -1; + + /** A mutex to coordinate dynamically changing TLS logging config changes and + * logging to the TLS log file. */ + std::shared_mutex _mutex; +}; diff --git a/iocore/net/SSLClientUtils.cc b/iocore/net/SSLClientUtils.cc index 24bd22b5f37..5975584a59a 100644 --- a/iocore/net/SSLClientUtils.cc +++ b/iocore/net/SSLClientUtils.cc @@ -29,6 +29,7 @@ #include "P_SSLClientUtils.h" #include "P_SSLConfig.h" #include "P_SSLNetVConnection.h" +#include "P_TLSKeyLogger.h" #include "YamlSNIConfig.h" #include "SSLDiags.h" #include "SSLSessionCache.h" diff --git a/iocore/net/SSLConfig.cc b/iocore/net/SSLConfig.cc index a25b9f66cf1..f315c68feed 100644 --- a/iocore/net/SSLConfig.cc +++ b/iocore/net/SSLConfig.cc @@ -50,7 +50,7 @@ #include "P_SSLSNI.h" #include "P_SSLCertLookup.h" #include "P_SSLSNI.h" -#include "P_SSLUtils.h" +#include "P_TLSKeyLogger.h" #include "SSLDiags.h" #include "SSLSessionCache.h" #include "SSLSessionTicket.h" @@ -67,6 +67,7 @@ bool SSLConfigParams::ssl_ocsp_enabled = false; int SSLConfigParams::ssl_ocsp_cache_timeout = 3600; int SSLConfigParams::ssl_ocsp_request_timeout = 10; int SSLConfigParams::ssl_ocsp_update_period = 60; +char *SSLConfigParams::ssl_ocsp_user_agent = nullptr; int SSLConfigParams::ssl_handshake_timeout_in = 0; int SSLConfigParams::origin_session_cache = 1; size_t SSLConfigParams::origin_session_cache_size = 10240; @@ -363,6 +364,7 @@ SSLConfigParams::initialize() REC_ReadConfigStringAlloc(ssl_ocsp_response_path, "proxy.config.ssl.ocsp.response.path"); set_paths_helper(ssl_ocsp_response_path, nullptr, &ssl_ocsp_response_path_only, nullptr); ats_free(ssl_ocsp_response_path); + REC_ReadConfigStringAlloc(ssl_ocsp_user_agent, "proxy.config.http.request_via_str"); REC_ReadConfigInt32(ssl_handshake_timeout_in, "proxy.config.ssl.handshake_timeout_in"); @@ -655,7 +657,7 @@ SSLTicketParams::LoadTicket(bool &nochange) return true; } -void +bool SSLTicketParams::LoadTicketData(char *ticket_data, int ticket_data_len) { cleanup(); @@ -666,7 +668,12 @@ SSLTicketParams::LoadTicketData(char *ticket_data, int ticket_data_len) default_global_keyblock = ssl_create_ticket_keyblock(nullptr); } load_time = time(nullptr); + + if (default_global_keyblock == nullptr) { + return false; + } #endif + return true; } void @@ -707,7 +714,10 @@ SSLTicketKeyConfig::reconfigure_data(char *ticket_data, int ticket_data_len) { SSLTicketParams *ticketKey = new SSLTicketParams(); if (ticketKey) { - ticketKey->LoadTicketData(ticket_data, ticket_data_len); + if (ticketKey->LoadTicketData(ticket_data, ticket_data_len) == false) { + delete ticketKey; + return false; + } } configid = configProcessor.set(configid, ticketKey); return true; diff --git a/iocore/net/SSLNetVConnection.cc b/iocore/net/SSLNetVConnection.cc index 63b5c331231..25238954475 100644 --- a/iocore/net/SSLNetVConnection.cc +++ b/iocore/net/SSLNetVConnection.cc @@ -773,7 +773,7 @@ SSLNetVConnection::load_buffer_and_write(int64_t towrite, MIOBufferAccessor &buf // Dynamic TLS record sizing ink_hrtime now = 0; if (SSLConfigParams::ssl_maxrecord == -1) { - now = Thread::get_hrtime_updated(); + now = Thread::get_hrtime(); int msec_since_last_write = ink_hrtime_diff_msec(now, sslLastWriteTime); if (msec_since_last_write > SSL_DEF_TLS_RECORD_MSEC_THRESHOLD) { diff --git a/iocore/net/SSLNextProtocolSet.cc b/iocore/net/SSLNextProtocolSet.cc index 99df1f8a4db..903144e09d5 100644 --- a/iocore/net/SSLNextProtocolSet.cc +++ b/iocore/net/SSLNextProtocolSet.cc @@ -49,10 +49,8 @@ SSLNextProtocolSet::create_npn_advertisement(const SessionProtocolSet &enabled, const SSLNextProtocolSet::NextProtocolEndpoint *ep; unsigned char *advertised; - if (*npn) { - ats_free(*npn); - *npn = nullptr; - } + ats_free(*npn); + *npn = nullptr; *len = 0; for (ep = endpoints.head; ep != nullptr; ep = endpoints.next(ep)) { diff --git a/iocore/net/SSLUtils.cc b/iocore/net/SSLUtils.cc index 5e045f28ca3..50492f5c7f1 100644 --- a/iocore/net/SSLUtils.cc +++ b/iocore/net/SSLUtils.cc @@ -38,6 +38,7 @@ #include "P_OCSPStapling.h" #include "P_SSLSNI.h" #include "P_SSLConfig.h" +#include "P_TLSKeyLogger.h" #include "BoringSSLUtils.h" #include "ProxyProtocol.h" #include "SSLSessionCache.h" @@ -46,11 +47,7 @@ #include "SSLDiags.h" #include "SSLStats.h" -#include #include -#include -#include -#include #include #include #include @@ -104,74 +101,6 @@ static int ssl_vc_index = -1; static ink_mutex *mutex_buf = nullptr; static bool open_ssl_initialized = false; -// The caller of this function is responsible to acquire a unique_lock for -// _mutex. -void -TLSKeyLogger::close_keylog_file() -{ - if (_fd == -1) { - return; - } - if (close(_fd) == -1) { - Error("Could not close keylog file: %s", strerror(errno)); - } - _fd = -1; -} - -void -TLSKeyLogger::enable_keylogging_internal(const char *keylog_file) -{ -#if TS_HAS_TLS_KEYLOGGING - Debug("ssl_keylog", "Enabling TLS key logging to: %s.", keylog_file); - std::unique_lock lock{_mutex}; - if (keylog_file == nullptr) { - close_keylog_file(); - Debug("ssl_keylog", "Received a nullptr for keylog_file: disabling keylogging."); - return; - } - - _fd = open(keylog_file, O_WRONLY | O_APPEND | O_CREAT, S_IWUSR | S_IRUSR); - if (_fd == -1) { - Error("Could not open keylog file %s: %s", keylog_file, strerror(errno)); - return; - } - Note("Opened %s for TLS key logging.", keylog_file); -#else - Error("TLS keylogging is configured, but Traffic Server is not compiled with a version of OpenSSL that supports it."); - return; -#endif /* TS_HAS_TLS_KEYLOGGING */ -} - -void -TLSKeyLogger::disable_keylogging_internal() -{ - std::unique_lock lock{_mutex}; - if (is_enabled()) { - Note("Disabling TLS key logging."); - } - close_keylog_file(); - Debug("ssl_keylog", "TLS keylogging is disabled."); -} - -void -TLSKeyLogger::log(const char *line) -{ - std::shared_lock lock{_mutex}; - if (!is_enabled()) { - return; - } - - // writev() is guaranteed to be thread safe. - struct iovec vector[2]; - vector[0].iov_base = const_cast(reinterpret_cast(line)); - vector[0].iov_len = strlen(line); - vector[1].iov_base = const_cast(reinterpret_cast("\n")); - vector[1].iov_len = 1; - if (writev(_fd, vector, 2) <= 0) { - Error("Could not write TLS session key to key log file: %s", strerror(errno)); - } -} - /* Using pthread thread ID and mutex functions directly, instead of * ATS this_ethread / ProxyMutex, so that other linked libraries * may use pthreads and openssl without confusing us here. (TS-2271). @@ -1498,7 +1427,6 @@ SSLMultiCertConfigLoader::init_server_ssl_ctx(CertLoadData const &data, const SS ink_assert(ctx != nullptr); SSLMultiCertConfigLoader::clear_pw_references(ctx); SSL_CTX_free(ctx); - ret.emplace_back(SSLLoadingContext(ctx, ctx_type)); return ret; } diff --git a/iocore/net/TLSKeyLogger.cc b/iocore/net/TLSKeyLogger.cc new file mode 100644 index 00000000000..bdae514ec61 --- /dev/null +++ b/iocore/net/TLSKeyLogger.cc @@ -0,0 +1,98 @@ +/** @file + + @section license License + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "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 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + */ + +#include "P_TLSKeyLogger.h" +#include "tscore/Diags.h" + +#include +#include +#include +#include +#include +#include + +// The caller of this function is responsible to acquire a unique_lock for +// _mutex. +void +TLSKeyLogger::close_keylog_file() +{ + if (_fd == -1) { + return; + } + if (close(_fd) == -1) { + Error("Could not close keylog file: %s", strerror(errno)); + } + _fd = -1; +} + +void +TLSKeyLogger::enable_keylogging_internal(const char *keylog_file) +{ +#if TS_HAS_TLS_KEYLOGGING + Debug("ssl_keylog", "Enabling TLS key logging to: %s.", keylog_file); + std::unique_lock lock{_mutex}; + if (keylog_file == nullptr) { + close_keylog_file(); + Debug("ssl_keylog", "Received a nullptr for keylog_file: disabling keylogging."); + return; + } + + _fd = open(keylog_file, O_WRONLY | O_APPEND | O_CREAT, S_IWUSR | S_IRUSR); + if (_fd == -1) { + Error("Could not open keylog file %s: %s", keylog_file, strerror(errno)); + return; + } + Note("Opened %s for TLS key logging.", keylog_file); +#else + Error("TLS keylogging is configured, but Traffic Server is not compiled with a version of OpenSSL that supports it."); + return; +#endif /* TS_HAS_TLS_KEYLOGGING */ +} + +void +TLSKeyLogger::disable_keylogging_internal() +{ + std::unique_lock lock{_mutex}; + if (is_enabled()) { + Note("Disabling TLS key logging."); + } + close_keylog_file(); + Debug("ssl_keylog", "TLS keylogging is disabled."); +} + +void +TLSKeyLogger::log(const char *line) +{ + std::shared_lock lock{_mutex}; + if (!is_enabled()) { + return; + } + + // writev() is guaranteed to be thread safe. + struct iovec vector[2]; + vector[0].iov_base = const_cast(reinterpret_cast(line)); + vector[0].iov_len = strlen(line); + vector[1].iov_base = const_cast(reinterpret_cast("\n")); + vector[1].iov_len = 1; + if (writev(_fd, vector, 2) <= 0) { + Error("Could not write TLS session key to key log file: %s", strerror(errno)); + } +} diff --git a/iocore/net/TLSSessionResumptionSupport.cc b/iocore/net/TLSSessionResumptionSupport.cc index af22b2e8959..9984b473168 100644 --- a/iocore/net/TLSSessionResumptionSupport.cc +++ b/iocore/net/TLSSessionResumptionSupport.cc @@ -122,6 +122,12 @@ TLSSessionResumptionSupport::getSSLSessionCacheHit() const return this->_sslSessionCacheHit; } +bool +TLSSessionResumptionSupport::getSSLOriginSessionCacheHit() const +{ + return this->_sslOriginSessionCacheHit; +} + ssl_curve_id TLSSessionResumptionSupport::getSSLCurveNID() const { @@ -184,9 +190,10 @@ TLSSessionResumptionSupport::getOriginSession(SSL *ssl, const std::string &looku if (is_ssl_session_timed_out(shared_sess.get())) { SSL_INCREMENT_DYN_STAT(ssl_origin_session_cache_miss); origin_sess_cache->remove_session(lookup_key); + shared_sess.reset(); } else { SSL_INCREMENT_DYN_STAT(ssl_origin_session_cache_hit); - this->_setSSLSessionCacheHit(true); + this->_setSSLOriginSessionCacheHit(true); this->_setSSLCurveNID(curve); } } else { @@ -213,8 +220,12 @@ TLSSessionResumptionSupport::_setSessionInformation(ssl_ticket_key_block *keyblo { const ssl_ticket_key_t &most_recent_key = keyblock->keys[0]; memcpy(keyname, most_recent_key.key_name, sizeof(most_recent_key.key_name)); - RAND_bytes(iv, EVP_MAX_IV_LENGTH); - EVP_EncryptInit_ex(cipher_ctx, EVP_aes_128_cbc(), nullptr, most_recent_key.aes_key, iv); + if (RAND_bytes(iv, EVP_MAX_IV_LENGTH) != 1) { + return -1; + } + if (EVP_EncryptInit_ex(cipher_ctx, EVP_aes_128_cbc(), nullptr, most_recent_key.aes_key, iv) != 1) { + return -2; + } #ifdef HAVE_SSL_CTX_SET_TLSEXT_TICKET_KEY_EVP_CB const OSSL_PARAM params[] = { OSSL_PARAM_construct_octet_string(OSSL_MAC_PARAM_KEY, const_cast(most_recent_key.hmac_secret), @@ -222,9 +233,13 @@ TLSSessionResumptionSupport::_setSessionInformation(ssl_ticket_key_block *keyblo OSSL_PARAM_construct_utf8_string(OSSL_MAC_PARAM_DIGEST, mac_param_digest, 0), OSSL_PARAM_construct_end(), }; - EVP_MAC_CTX_set_params(hctx, params); + if (EVP_MAC_CTX_set_params(hctx, params) != 1) { + return -3; + } #else - HMAC_Init_ex(hctx, most_recent_key.hmac_secret, sizeof(most_recent_key.hmac_secret), evp_md_func, nullptr); + if (HMAC_Init_ex(hctx, most_recent_key.hmac_secret, sizeof(most_recent_key.hmac_secret), evp_md_func, nullptr) != 1) { + return -3; + } #endif Debug("ssl_session_ticket", "create ticket for a new session."); @@ -244,16 +259,22 @@ TLSSessionResumptionSupport::_getSessionInformation(ssl_ticket_key_block *keyblo { for (unsigned i = 0; i < keyblock->num_keys; ++i) { if (memcmp(keyname, keyblock->keys[i].key_name, sizeof(keyblock->keys[i].key_name)) == 0) { - EVP_DecryptInit_ex(cipher_ctx, EVP_aes_128_cbc(), nullptr, keyblock->keys[i].aes_key, iv); + if (EVP_DecryptInit_ex(cipher_ctx, EVP_aes_128_cbc(), nullptr, keyblock->keys[i].aes_key, iv) != 1) { + return -2; + } #ifdef HAVE_SSL_CTX_SET_TLSEXT_TICKET_KEY_EVP_CB const OSSL_PARAM params[] = { OSSL_PARAM_construct_octet_string(OSSL_MAC_PARAM_KEY, keyblock->keys[i].hmac_secret, sizeof(keyblock->keys[i].hmac_secret)), OSSL_PARAM_construct_utf8_string(OSSL_MAC_PARAM_DIGEST, mac_param_digest, 0), OSSL_PARAM_construct_end(), }; - EVP_MAC_CTX_set_params(hctx, params); + if (EVP_MAC_CTX_set_params(hctx, params) != 1) { + return -3; + } #else - HMAC_Init_ex(hctx, keyblock->keys[i].hmac_secret, sizeof(keyblock->keys[i].hmac_secret), evp_md_func, nullptr); + if (HMAC_Init_ex(hctx, keyblock->keys[i].hmac_secret, sizeof(keyblock->keys[i].hmac_secret), evp_md_func, nullptr) != 1) { + return -3; + } #endif Debug("ssl_session_ticket", "verify the ticket for an existing session."); @@ -289,6 +310,12 @@ TLSSessionResumptionSupport::_setSSLSessionCacheHit(bool state) this->_sslSessionCacheHit = state; } +void +TLSSessionResumptionSupport::_setSSLOriginSessionCacheHit(bool state) +{ + this->_sslOriginSessionCacheHit = state; +} + void TLSSessionResumptionSupport::_setSSLCurveNID(ssl_curve_id curve_nid) { diff --git a/iocore/net/TLSSessionResumptionSupport.h b/iocore/net/TLSSessionResumptionSupport.h index 5f1fa37a91c..fb27ed3a396 100644 --- a/iocore/net/TLSSessionResumptionSupport.h +++ b/iocore/net/TLSSessionResumptionSupport.h @@ -48,6 +48,7 @@ class TLSSessionResumptionSupport int enc); #endif bool getSSLSessionCacheHit() const; + bool getSSLOriginSessionCacheHit() const; ssl_curve_id getSSLCurveNID() const; SSL_SESSION *getSession(SSL *ssl, const unsigned char *id, int len, int *copy); @@ -60,8 +61,9 @@ class TLSSessionResumptionSupport private: static int _ex_data_index; - bool _sslSessionCacheHit = false; - int _sslCurveNID = NID_undef; + bool _sslSessionCacheHit = false; + bool _sslOriginSessionCacheHit = false; + int _sslCurveNID = NID_undef; #ifdef HAVE_SSL_CTX_SET_TLSEXT_TICKET_KEY_EVP_CB int _setSessionInformation(ssl_ticket_key_block *keyblock, SSL *ssl, unsigned char *keyname, unsigned char *iv, @@ -76,5 +78,6 @@ class TLSSessionResumptionSupport #endif void _setSSLSessionCacheHit(bool state); + void _setSSLOriginSessionCacheHit(bool state); void _setSSLCurveNID(ssl_curve_id curve_nid); }; diff --git a/iocore/net/TLSTunnelSupport.cc b/iocore/net/TLSTunnelSupport.cc index 77dbdd8dff8..b050c8c4417 100644 --- a/iocore/net/TLSTunnelSupport.cc +++ b/iocore/net/TLSTunnelSupport.cc @@ -67,10 +67,9 @@ TLSTunnelSupport::set_tunnel_destination(const std::string_view &destination, SN _tunnel_type = type; _tunnel_prewarm = prewarm; + ats_free(_tunnel_host); + auto pos = destination.find(":"); - if (nullptr != _tunnel_host) { - ats_free(_tunnel_host); - } if (pos != std::string::npos) { _tunnel_port = std::stoi(destination.substr(pos + 1).data()); _tunnel_host = ats_strndup(destination.substr(0, pos).data(), pos); diff --git a/iocore/net/UnixNetAccept.cc b/iocore/net/UnixNetAccept.cc index 1ce5923b8ff..195369584a0 100644 --- a/iocore/net/UnixNetAccept.cc +++ b/iocore/net/UnixNetAccept.cc @@ -348,6 +348,7 @@ NetAccept::do_blocking_accept(EThread *t) vc->action_ = *action_; vc->set_is_transparent(opt.f_inbound_transparent); vc->set_is_proxy_protocol(opt.f_proxy_protocol); + vc->options.sockopt_flags = opt.sockopt_flags; vc->options.packet_mark = opt.packet_mark; vc->options.packet_tos = opt.packet_tos; vc->options.packet_notsent_lowat = opt.packet_notsent_lowat; @@ -500,6 +501,7 @@ NetAccept::acceptFastEvent(int event, void *ep) vc->action_ = *action_; vc->set_is_transparent(opt.f_inbound_transparent); vc->set_is_proxy_protocol(opt.f_proxy_protocol); + vc->options.sockopt_flags = opt.sockopt_flags; vc->options.packet_mark = opt.packet_mark; vc->options.packet_tos = opt.packet_tos; vc->options.packet_notsent_lowat = opt.packet_notsent_lowat; diff --git a/iocore/net/UnixUDPNet.cc b/iocore/net/UnixUDPNet.cc index c2f5177d10c..b3141728949 100644 --- a/iocore/net/UnixUDPNet.cc +++ b/iocore/net/UnixUDPNet.cc @@ -505,7 +505,7 @@ UDPReadContinuation::readPollEvent(int event_, Event *e) * *actual_len = recvfrom(fd,addr,buf->end(),len) * if successful then * buf->fill(*actual_len); - * return ACTION_RESULT_DONE + * return ACTION_RESULT_DONE * else if nothing read * *actual_len is 0 * create "UDP read continuation" C with 'cont's lock diff --git a/iocore/net/quic/Makefile.am b/iocore/net/quic/Makefile.am index ca72382de7a..ab32d25401b 100644 --- a/iocore/net/quic/Makefile.am +++ b/iocore/net/quic/Makefile.am @@ -148,6 +148,7 @@ test_LDADD = \ $(top_builddir)/src/tscore/libtscore.la \ $(top_builddir)/src/tscpp/util/libtscpputil.la \ $(top_builddir)/proxy/ParentSelectionStrategy.o \ + $(top_builddir)/iocore/net/TLSKeyLogger.o \ @HWLOC_LIBS@ @OPENSSL_LIBS@ @LIBPCRE@ @YAMLCPP_LIBS@ test_event_main_SOURCES = \ diff --git a/iocore/net/quic/Mock.h b/iocore/net/quic/Mock.h index 3185315dc6c..17cbf40c634 100644 --- a/iocore/net/quic/Mock.h +++ b/iocore/net/quic/Mock.h @@ -46,25 +46,25 @@ std::string_view negotiated_application_name_sv = "h3-29"sv; class MockQUICLDConfig : public QUICLDConfig { uint32_t - packet_threshold() const + packet_threshold() const override { return 3; } float - time_threshold() const + time_threshold() const override { return 1.25; } ink_hrtime - granularity() const + granularity() const override { return HRTIME_MSECONDS(1); } ink_hrtime - initial_rtt() const + initial_rtt() const override { return HRTIME_MSECONDS(100); } @@ -79,25 +79,25 @@ class MockQUICCCConfig : public QUICCCConfig } uint32_t - initial_window() const + initial_window() const override { return 10; } uint32_t - minimum_window() const + minimum_window() const override { return 2; } float - loss_reduction_factor() const + loss_reduction_factor() const override { return 0.5; } uint32_t - persistent_congestion_threshold() const + persistent_congestion_threshold() const override { return 2; } @@ -108,22 +108,22 @@ class MockQUICPathManager : public QUICPathManager public: virtual ~MockQUICPathManager() {} virtual const QUICPath & - get_current_path() + get_current_path() override { return _path; } virtual const QUICPath & - get_verified_path() + get_verified_path() override { return _path; } virtual void - open_new_path(const QUICPath &path, ink_hrtime timeout_in) + open_new_path(const QUICPath &path, ink_hrtime timeout_in) override { return; } virtual void - set_trusted_path(const QUICPath &path) + set_trusted_path(const QUICPath &path) override { return; } @@ -288,58 +288,58 @@ class MockNetVConnection : public NetVConnection public: MockNetVConnection(NetVConnectionContext_t context = NET_VCONNECTION_OUT) : NetVConnection() { netvc_context = context; } VIO * - do_io_read(Continuation *c, int64_t nbytes, MIOBuffer *buf) + do_io_read(Continuation *c, int64_t nbytes, MIOBuffer *buf) override { return nullptr; }; VIO * - do_io_write(Continuation *c, int64_t nbytes, IOBufferReader *buf, bool owner = false) + do_io_write(Continuation *c, int64_t nbytes, IOBufferReader *buf, bool owner = false) override { return nullptr; }; - void do_io_close(int lerrno = -1){}; - void do_io_shutdown(ShutdownHowTo_t howto){}; - void reenable(VIO *vio){}; - void reenable_re(VIO *vio){}; - void set_active_timeout(ink_hrtime timeout_in){}; - void set_inactivity_timeout(ink_hrtime timeout_in){}; - void cancel_active_timeout(){}; - void cancel_inactivity_timeout(){}; - void add_to_keep_alive_queue(){}; - void remove_from_keep_alive_queue(){}; + void do_io_close(int lerrno = -1) override{}; + void do_io_shutdown(ShutdownHowTo_t howto) override{}; + void reenable(VIO *vio) override{}; + void reenable_re(VIO *vio) override{}; + void set_active_timeout(ink_hrtime timeout_in) override{}; + void set_inactivity_timeout(ink_hrtime timeout_in) override{}; + void cancel_active_timeout() override{}; + void cancel_inactivity_timeout() override{}; + void add_to_keep_alive_queue() override{}; + void remove_from_keep_alive_queue() override{}; bool - add_to_active_queue() + add_to_active_queue() override { return true; }; ink_hrtime - get_active_timeout() + get_active_timeout() override { return 0; } ink_hrtime - get_inactivity_timeout() + get_inactivity_timeout() override { return 0; } void - apply_options() + apply_options() override { } SOCKET - get_socket() { return 0; } + get_socket() override { return 0; } int set_tcp_init_cwnd(int init_cwnd) { return 0; } int - set_tcp_congestion_control(int side) + set_tcp_congestion_control(int side) override { return 0; } - void set_local_addr(){}; - void set_remote_addr(){}; + void set_local_addr() override{}; + void set_remote_addr() override{}; NetVConnectionContext_t get_context() const diff --git a/iocore/net/quic/QUICConfig.cc b/iocore/net/quic/QUICConfig.cc index 50e75d7b263..8e06255e427 100644 --- a/iocore/net/quic/QUICConfig.cc +++ b/iocore/net/quic/QUICConfig.cc @@ -28,7 +28,7 @@ #include #include "P_SSLConfig.h" -#include "P_SSLUtils.h" +#include "P_TLSKeyLogger.h" #include "QUICGlobals.h" #include "QUICTransportParameters.h" diff --git a/iocore/net/quic/QUICFrame.h b/iocore/net/quic/QUICFrame.h index 93cd692fc7c..a0b4af9077d 100644 --- a/iocore/net/quic/QUICFrame.h +++ b/iocore/net/quic/QUICFrame.h @@ -204,9 +204,12 @@ class QUICAckFrame : public QUICFrame class AckBlockSection { public: - class const_iterator : public std::iterator + class const_iterator { public: + using iterator_category = std::input_iterator_tag; + using value_type = QUICAckFrame::AckBlock; + const_iterator(uint8_t index, const std::vector *ack_blocks); const QUICAckFrame::AckBlock & diff --git a/iocore/net/quic/QUICVersionNegotiator.cc b/iocore/net/quic/QUICVersionNegotiator.cc index 43d2fbf5631..d26f4f88327 100644 --- a/iocore/net/quic/QUICVersionNegotiator.cc +++ b/iocore/net/quic/QUICVersionNegotiator.cc @@ -46,11 +46,9 @@ QUICVersionNegotiator::negotiate(const QUICPacket &packet) case QUICPacketType::VERSION_NEGOTIATION: { const QUICVersionNegotiationPacketR &vn_packet = static_cast(packet); uint16_t n_supported_version = vn_packet.nversions(); - uint16_t len = 0; for (int i = 0; i < n_supported_version; ++i) { QUICVersion version = vn_packet.supported_version(i); - len += sizeof(QUICVersion); if (QUICTypeUtil::is_supported_version(version)) { this->_status = QUICVersionNegotiationStatus::NEGOTIATED; diff --git a/iocore/net/test_I_Net.cc b/iocore/net/test_I_Net.cc index 9961bc00b8e..37e738adb21 100644 --- a/iocore/net/test_I_Net.cc +++ b/iocore/net/test_I_Net.cc @@ -22,6 +22,9 @@ */ #include "P_Net.h" + +#include "tscore/ink_hw.h" + #include #include "diags.i" diff --git a/lib/Makefile.am b/lib/Makefile.am index bedd005c727..101ca25d7b4 100644 --- a/lib/Makefile.am +++ b/lib/Makefile.am @@ -16,7 +16,7 @@ # See the License for the specific language governing permissions and # limitations under the License. -SUBDIRS = . records fastlz swoc +SUBDIRS = . records fastlz if BUILD_PERL_LIB SUBDIRS += perl @@ -29,6 +29,10 @@ if BUILD_YAML_CPP LOCAL += yamlcpp endif +if BUILD_SWOC +LOCAL += swoc +endif + all-local: $(LOCAL) $(MAKE) -C yamlcpp diff --git a/lib/records/RecCore.cc b/lib/records/RecCore.cc index fcb6474cbce..4fa791d1e6d 100644 --- a/lib/records/RecCore.cc +++ b/lib/records/RecCore.cc @@ -898,9 +898,9 @@ RecRegisterConfig(RecT rec_type, const char *name, RecDataT data_type, RecData d // Note: do not modify 'record->config_meta.update_required' r->config_meta.update_type = update_type; r->config_meta.check_type = check_type; - if (r->config_meta.check_expr) { - ats_free(r->config_meta.check_expr); - } + + ats_free(r->config_meta.check_expr); + r->config_meta.check_expr = ats_strdup(check_expr); r->config_meta.update_cb_list = nullptr; r->config_meta.access_type = access_type; diff --git a/lib/records/RecUtils.cc b/lib/records/RecUtils.cc index e0cdbb80a7e..94280413bf2 100644 --- a/lib/records/RecUtils.cc +++ b/lib/records/RecUtils.cc @@ -129,9 +129,7 @@ RecDataSet(RecDataT data_type, RecData *data_dst, RecData *data_src) } } else if (((data_dst->rec_string) && (strcmp(data_dst->rec_string, data_src->rec_string) != 0)) || ((data_dst->rec_string == nullptr) && (data_src->rec_string != nullptr))) { - if (data_dst->rec_string) { - ats_free(data_dst->rec_string); - } + ats_free(data_dst->rec_string); data_dst->rec_string = ats_strdup(data_src->rec_string); rec_set = true; diff --git a/lib/records/test_RecProcess.i b/lib/records/test_RecProcess.i index 963c45dc91f..e9c3c918ed9 100644 --- a/lib/records/test_RecProcess.i +++ b/lib/records/test_RecProcess.i @@ -46,7 +46,7 @@ void RecDumpRecordsHt(RecT rec_type); do { \ RecString rec_string = 0; \ if (RecGetRecordString_Xmalloc("proxy.config.parse_"name, &rec_string) != REC_ERR_FAIL) { \ - if (rec_string) ats_free(rec_string); \ + ats_free(rec_string); \ printf(" parse_"name": FAIL\n"); \ failures++; \ } else { \ diff --git a/lib/swoc/include/swoc/DiscreteRange.h b/lib/swoc/include/swoc/DiscreteRange.h index dd130d86068..503911cacab 100644 --- a/lib/swoc/include/swoc/DiscreteRange.h +++ b/lib/swoc/include/swoc/DiscreteRange.h @@ -319,7 +319,11 @@ template class DiscreteRange { The first pair of elements that are not equal determine the ordering of the overall tuples. */ - struct lexicographic_order : public std::binary_function { + struct lexicographic_order { + using first_argument_type = self_type; + using second_argument_type = self_type; + using result_type = bool; + //! Functor operator. bool operator()(self_type const &lhs, self_type const &rhs) const; }; diff --git a/lib/swoc/include/swoc/Lexicon.h b/lib/swoc/include/swoc/Lexicon.h index cd8a196d7c0..90ea861be47 100644 --- a/lib/swoc/include/swoc/Lexicon.h +++ b/lib/swoc/include/swoc/Lexicon.h @@ -18,7 +18,7 @@ #include "swoc/IntrusiveHashMap.h" #include "swoc/MemArena.h" #include "swoc/bwf_base.h" -#include "swoc/HashFNV.h" +#include "swoc/ext/HashFNV.h" namespace swoc { inline namespace SWOC_VERSION_NS { namespace detail { diff --git a/lib/swoc/include/swoc/MemSpan.h b/lib/swoc/include/swoc/MemSpan.h index 91955e0df30..f5aad675399 100644 --- a/lib/swoc/include/swoc/MemSpan.h +++ b/lib/swoc/include/swoc/MemSpan.h @@ -277,6 +277,9 @@ template <> class MemSpan { /// Copy constructor. constexpr MemSpan(self_type const &that) = default; + /// Copy assignment + constexpr self_type & operator = (self_type const& that) = default; + /** Cross type copy constructor. * * @tparam U Type for source span. @@ -361,21 +364,21 @@ template <> class MemSpan { */ template MemSpan rebind() const; - /// Set the span. - /// This is faster but equivalent to constructing a new span with the same - /// arguments and assigning it. - /// @return @c this. - self_type &assign(value_type *ptr, ///< Buffer start. - size_t n ///< # of bytes - ); + /** Update the span. + * + * @param ptr Start of span memory. + * @param n Number of elements in the span. + * @return @a this + */ + self_type &assign(value_type *ptr, size_t n); - /// Set the span. - /// This is faster but equivalent to constructing a new span with the same - /// arguments and assigning it. - /// @return @c this. - self_type &assign(value_type *first, ///< First valid element. - value_type const *last ///< First invalid element. - ); + /** Update the span. + * + * @param first First element in the span. + * @param last One past the last element in the span. + * @return @a this + */ + self_type &assign(value_type *first, value_type const *last); /// Clear the span (become an empty span). self_type &clear(); @@ -413,12 +416,13 @@ template <> class MemSpan { /** Return a sub span of @a this span. * - * @param offset Offset (index) of first element in subspan. - * @param count Number of elements in the subspan. - * @return A subspan starting at @a offset for @a count elements. + * @param offset Offset (index) of first element. + * @param count Number of elements. + * @return The span starting at @a offset for @a count elements in @a this. * - * The result is clipped by @a this - if @a offset is out of range an empty span is returned. - * Otherwise @c count is clipped by the number of elements available in @a this. + * The result is clipped by @a this - if @a offset is out of range an empty span is returned. Otherwise @c count is clipped by the + * number of elements available in @a this. In effect the intersection of the span described by ( @a offset , @a count ) and @a + * this span is returned, which may be the empty span. */ constexpr self_type subspan(size_t offset, size_t count) const; diff --git a/lib/swoc/include/swoc/TextView.h b/lib/swoc/include/swoc/TextView.h index 5e27ddf2f87..e32d8617721 100644 --- a/lib/swoc/include/swoc/TextView.h +++ b/lib/swoc/include/swoc/TextView.h @@ -79,6 +79,22 @@ class TextView : public std::string_view { */ constexpr TextView(char const *first, char const *last) noexcept; + /** Construct from any character container following STL standards. + * + * @tparam C Container type. + * @param c container + * + * The container type must have the methods @c data and @c size which must return values convertible + * to @c char @c const @c * and @c size_t respectively. + */ + template < typename C + , typename = std::enable_if_t< + std::is_convertible_v().data()), char const*> && + std::is_convertible_v().size()), size_t> + , void + > + > constexpr TextView(C const& c); + /** Construct from literal string or array. All elements of the array are included in the view unless the last element is nul, in which case it is elided. @@ -164,6 +180,24 @@ class TextView : public std::string_view { /// Explicitly set the view from a @c std::string self_type &assign(std::string const &s); + /** Assign from any character container following STL standards. + * + * @tparam C Container type. + * @param c container + * + * The container type must have the methods @c data and @c size which must return values convertible + * to @c char @c const @c * and @c size_t respectively. + */ + template < typename C + , typename = std::enable_if_t< + std::is_convertible_v().data()), char const*> && + std::is_convertible_v().size()), size_t> + , void + > + > constexpr self_type & assign(C const& c) { + return this->assign(c.data(), c.size()); + } + /** Dereference operator. @note This allows the view to be used as if it were a character iterator to a null terminated @@ -923,6 +957,7 @@ inline constexpr TextView::TextView(std::nullptr_t) noexcept : super_type(nullpt inline TextView::TextView(std::string const &str) noexcept : super_type(str) {} inline constexpr TextView::TextView(super_type const &that) noexcept : super_type(that) {} template constexpr TextView::TextView(const char (&s)[N]) noexcept : super_type(s, s[N - 1] ? N : N - 1) {} +template constexpr TextView::TextView(C const &c) : super_type(c.data(), c.size()) {} inline void TextView::init_delimiter_set(std::string_view const &delimiters, std::bitset<256> &set) { diff --git a/lib/swoc/include/swoc/ext/HashFNV.h b/lib/swoc/include/swoc/ext/HashFNV.h new file mode 100644 index 00000000000..b22d43f74c0 --- /dev/null +++ b/lib/swoc/include/swoc/ext/HashFNV.h @@ -0,0 +1,256 @@ +/** @file + + @section license License + + Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. + See the NOTICE file distributed with this work for additional information regarding copyright + ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the + "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 + + Unless required by applicable law or agreed to in writing, software distributed under the License + is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express + or implied. See the License for the specific language governing permissions and limitations under + the License. + */ + +/* + http://www.isthe.com/chongo/tech/comp/fnv/ + + Currently implemented FNV-1a 32bit and FNV-1a 64bit + */ + +#pragma once + +#include + +#include "swoc/TextView.h" + +namespace swoc { inline namespace SWOC_VERSION_NS { + +struct Hash32FNV1a { +protected: + using self_type = Hash32FNV1a; + static constexpr uint32_t INIT = 0x811c9dc5u; + +public: + using value_type = uint32_t; + + Hash32FNV1a() = default; + + /** Update the hash value. + * + * @param data Input data to hash. + * @return @a this + */ + self_type &update(std::string_view const &data); + + /** Finalize the hash value. + * + * @return @a this + * + * No more updates are valid after finalization. + */ + self_type & final(); + + /// Return the hash value. + value_type get() const; + + /// Re-initialize to default state. + self_type &clear(); + + /** Update with transformed data. + * + * @tparam X Transform functor. + * @tparam V Input data + * @param view transformed view + * @return @a this + * + * The hash is updated using the transformed data provided by @a view. + */ + template self_type &update(TransformView view); + + /** Update and finalize. + * + * @param data Input data to hash. + * @return The final hash value. + * + * Convenience method to compute a hash in one step. + */ + value_type hash_immediate(std::string_view const &data); + + /** Update and finalized with transformed data. + * + * @tparam X Transform functor. + * @tparam V Input data + * @param view transformed view + * @return @a this + * + * The hash is updated using the transformed data provided by @a view, then finalized. + */ + template value_type hash_immediate(TransformView const &view); + +private: + value_type hval{INIT}; +}; + +struct Hash64FNV1a { +protected: + using self_type = Hash64FNV1a; + static constexpr uint64_t INIT = 0xcbf29ce484222325ull; + +public: + using value_type = uint64_t; + + Hash64FNV1a() = default; + + /** Update the hash value. + * + * @param data Input data to hash. + * @return @a this + */ + self_type &update(std::string_view const &data); + + /** Finalize the hash value. + * + * @return @a this + * + * No more updates are valid after finalization. + */ + self_type & final(); + + /// Return the hash value. + value_type get() const; + + /// Re-initialize to default state. + self_type &clear(); + + /** Update with transformed data. + * + * @tparam X Transform functor. + * @tparam V Input data + * @param view transformed view + * @return @a this + * + * The hash is updated using the transformed data provided by @a view. + */ + template self_type &update(TransformView view); + + /** Update and finalize. + * + * @param data Input data to hash. + * @return The final hash value. + * + * Convenience method to compute a hash in one step. + */ + value_type hash_immediate(std::string_view const &data); + + /** Update and finalized with transformed data. + * + * @tparam X Transform functor. + * @tparam V Input data type. + * @param view transformed view + * @return @a this + * + * The hash is updated using the transformed data provided by @a view, then finalized. + */ + template value_type hash_immediate(TransformView const &view); + +private: + value_type hval{INIT}; +}; + +// ---------- +// Implementation + +// -- 32 -- + +inline auto +Hash32FNV1a::clear() -> self_type & { + hval = INIT; + return *this; +} + +template +auto +Hash32FNV1a::update(TransformView view) -> self_type & { + for (; view; ++view) { + hval ^= static_cast(*view); + hval += (hval << 1) + (hval << 4) + (hval << 7) + (hval << 8) + (hval << 24); + } + return *this; +} + +inline auto +Hash32FNV1a::update(std::string_view const &data) -> self_type & { + return this->update(transform_view_of(data)); +} + +inline auto +Hash32FNV1a::final() -> self_type & { + return *this; +} + +inline auto +Hash32FNV1a::get() const -> value_type { + return hval; +} + +template +auto +Hash32FNV1a::hash_immediate(swoc::TransformView const &view) -> value_type { + return this->update(view).get(); +} + +inline auto +Hash32FNV1a::hash_immediate(std::string_view const &data) -> value_type { + return this->update(data).final().get(); +} + +// -- 64 -- + +inline auto +Hash64FNV1a::clear() -> self_type & { + hval = INIT; + return *this; +} + +template +auto +Hash64FNV1a::update(TransformView view) -> self_type & { + for (; view; ++view) { + hval ^= static_cast(*view); + hval += (hval << 1) + (hval << 4) + (hval << 5) + (hval << 7) + (hval << 8) + (hval << 40); + } + return *this; +} + +inline auto +Hash64FNV1a::update(std::string_view const &data) -> self_type & { + return this->update(transform_view_of(data)); +} + +inline auto +Hash64FNV1a::final() -> self_type & { + return *this; +} + +inline auto +Hash64FNV1a::get() const -> value_type { + return hval; +} + +template +auto +Hash64FNV1a::hash_immediate(swoc::TransformView const &view) -> value_type { + return this->update(view).final().get(); +} + +inline auto +Hash64FNV1a::hash_immediate(std::string_view const &data) -> value_type { + return this->update(data).final().get(); +} + +}} // namespace swoc::SWOC_VERSION_NS diff --git a/lib/swoc/include/swoc/swoc_ip.h b/lib/swoc/include/swoc/swoc_ip.h index 572594f07db..430c0e2def6 100644 --- a/lib/swoc/include/swoc/swoc_ip.h +++ b/lib/swoc/include/swoc/swoc_ip.h @@ -6,8 +6,10 @@ */ #pragma once -#include +#include +#include #include +#include #include #include @@ -39,7 +41,10 @@ class IP6Net; class IPNet; using ::std::string_view; -extern void *const pseudo_nullptr; + +namespace detail { + extern void *const pseudo_nullptr; +} /** A union to hold @c sockaddr compliant IP address structures. @@ -59,18 +64,21 @@ union IPEndpoint { /// Default construct invalid instance. IPEndpoint(); - - IPEndpoint(self_type const &that); + IPEndpoint(self_type const &that); ///< Copy constructor. + ~IPEndpoint() = default; /// Construct from the @a text representation of an address. IPEndpoint(string_view const &text); - // Construct from @a IPAddr + // Construct from @c IPAddr explicit IPEndpoint(IPAddr const &addr); // Construct from @c sockaddr IPEndpoint(sockaddr const *sa); + /// Copy assignment. + self_type &operator=(self_type const &that); + /** Break a string in to IP address relevant tokens. * * @param src Source text. [in] @@ -81,6 +89,8 @@ union IPEndpoint { * * Any of the out parameters can be @c nullptr in which case they are not updated. * This parses and discards the IPv6 brackets. + * + * @note This is intended for internal use to do address parsing, but it can be useful in other contexts. */ static bool tokenize(string_view src, string_view *host = nullptr, string_view *port = nullptr, string_view *rest = nullptr); @@ -99,9 +109,6 @@ union IPEndpoint { /// Invalidate this endpoint. self_type &invalidate(); - /// Copy constructor. - self_type &operator=(self_type const &that); - /** Copy (assign) the contents of @a src to @a dst. * * The caller must ensure @a dst is large enough to hold the contents of @a src, the size of which @@ -122,7 +129,7 @@ union IPEndpoint { self_type &assign(IPAddr const &addr, in_port_t port = 0); /// Copy to @a sa. - const self_type &fill(sockaddr *addr) const; + const self_type ©_to(sockaddr *addr) const; /// Test for valid IP address. bool is_valid() const; @@ -246,7 +253,7 @@ class IP4Addr { self_type &operator|=(IPMask const &mask); /// Write this adddress and @a port to the sockaddr @a sa. - sockaddr_in *fill(sockaddr_in *sa, in_port_t port = 0) const; + sockaddr_in *copy_to(sockaddr_in *sa, in_port_t port = 0) const; /// @return The address in network order. in_addr_t network_order() const; @@ -263,33 +270,21 @@ class IP4Addr { bool load(string_view const &text); /// Standard ternary compare. - int - cmp(self_type const &that) const { - return _addr < that._addr ? -1 : _addr > that._addr ? 1 : 0; - } + int cmp(self_type const &that) const; /// Get the IP address family. /// @return @c AF_INET /// @note Useful primarily for template classes. constexpr sa_family_t family(); - /// Test for ANY address. - bool - is_any() const { - return _addr == INADDR_ANY; - } + /// @return @c true if this is the "any" address, @c false if not. + bool is_any() const; - /// Test for multicast - bool - is_multicast() const { - return IN_MULTICAST(_addr); - } + /// @return @c true if this is a multicast address, @c false if not. + bool is_multicast() const; - /// Test for loopback - bool - is_loopback() const { - return (*this)[3] == IN_LOOPBACKNET; - } + /// @return @c true if this is a loopback address, @c false if not. + bool is_loopback() const; /** Left shift. * @@ -349,7 +344,9 @@ class IP4Addr { }; /** Storage for an IPv6 address. - This should be presumed to be in network order. + Internal storage is not necessarily network ordered. + @see network_order + @see copy_to */ class IP6Addr { using self_type = IP6Addr; ///< Self reference type. @@ -358,23 +355,23 @@ class IP6Addr { friend class IPMask; public: - static constexpr size_t WIDTH = 128; ///< Number of bits in the address. - static constexpr size_t SIZE = WIDTH / std::numeric_limits::digits; ///< Size of address in bytes. - static constexpr sa_family_t AF_value = AF_INET6; ///< Address family type. + static constexpr size_t WIDTH = 128; ///< Number of bits in the address. + static constexpr size_t SIZE = WIDTH / std::numeric_limits::digits; ///< Size of address in bytes. + static constexpr sa_family_t AF_value = AF_INET6; ///< Address family type. using quad_type = uint16_t; ///< Size of one segment of an IPv6 address. static constexpr size_t N_QUADS = SIZE / sizeof(quad_type); ///< # of quads in an IPv6 address. /// Direct access type for the address. /// Equivalent to the data type for data member @c s6_addr in @c in6_addr. - using raw_type = std::array; + using raw_type = std::array; /// Direct access type for the address by quads (16 bits). /// This corresponds to the elements of the text format of the address. using quad_store_type = std::array; /// Number of bits per quad. - static constexpr size_t QUAD_WIDTH = std::numeric_limits::digits * sizeof(quad_type); + static constexpr size_t QUAD_WIDTH = std::numeric_limits::digits * sizeof(quad_type); /// A bit mask of all 1 bits the size of a quad. static constexpr quad_type QUAD_MASK = ~quad_type{0}; @@ -385,10 +382,10 @@ class IP6Addr { static constexpr size_t WORD_SIZE = sizeof(word_type); /// Number of bits per word. - static constexpr size_t WORD_WIDTH = std::numeric_limits::digits * WORD_SIZE; + static constexpr size_t WORD_WIDTH = std::numeric_limits::digits * WORD_SIZE; /// Number of words used for basic address storage. - static constexpr size_t N_STORE = SIZE / sizeof(word_type); + static constexpr size_t N_STORE = SIZE / WORD_SIZE; /// Type used to store the address. using word_store_type = std::array; @@ -452,8 +449,10 @@ class IP6Addr { /// Decrement address. self_type &operator--(); + self_type & operator = (self_type const& that) = default; + /// Assign from IPv6 raw address. - self_type &operator=(in6_addr const &ip); + self_type &operator=(in6_addr const &addr); /// Set to the address in @a addr. self_type &operator=(sockaddr_in6 const *addr); @@ -476,44 +475,60 @@ class IP6Addr { */ bool load(string_view const &str); - /// Generic compare. + /// Generic three value compare. int cmp(self_type const &that) const; - /// Get the address family. /// @return The address family. - /// @note Useful primarily for templates. constexpr sa_family_t family(); - /// Test for ANY address. - bool - is_any() const { - return _addr._store[0] == 0 && _addr._store[1] == 0; - } + /// @return @c true if this is the "any" address, @c false if not. + bool is_any() const; - /// Test for loopback - bool - is_loopback() const { - return _addr._store[0] == 0 && _addr._store[1] == 1; - } + /// @return @c true if this is a loopback address, @c false if not. + bool is_loopback() const; - /// Test for multicast - bool - is_multicast() const { - return _addr._raw[7] == 0xFF; - } + /// @return @c true if this is a multicast address, @c false if not. + bool is_multicast() const; - self_type & - clear() { - _addr._store[0] = _addr._store[1] = 0; - return *this; - } + /// @return @c true if this is an IPv4 addressed mapped to IPv6, @c false if not. + bool is_mapped_ipv4() const; + /** Reset to default constructed state. + * + * @return @a this + */ + self_type & clear(); + + /** Bitwise AND. + * + * @param that Source address. + * @return @a this. + * + * The bits in @a this are set to the bitwise AND of the corresponding bits in @a this and @a that. + */ self_type &operator&=(IPMask const &mask); + /** Bitwise OR. + * + * @param that Source address. + * @return @a this. + * + * The bits in @a this are set to the bitwise OR of the corresponding bits in @a this and @a that. + */ self_type &operator|=(IPMask const &mask); + /** Convert between network and host ordering. + * + * @param dst Destination for re-ordered address. + * @param src Original address. + */ static void reorder(in6_addr &dst, raw_type const &src); + /** Convert between network and host ordering. + * + * @param dst Destination for re-ordered address. + * @param src Original address. + */ static void reorder(raw_type &dst, in6_addr const &src); protected: @@ -542,6 +557,10 @@ class IP6Addr { /// This converts from the position in the text format to the quads in the binary format. static constexpr std::array QUAD_IDX = {3, 2, 1, 0, 7, 6, 5, 4}; + /// Convert between network and host order. + /// The conversion is symmetric. + /// @param dst Output where reordered value is placed. + /// @param src Input value to resorder. static void reorder(unsigned char dst[WORD_SIZE], unsigned char const src[WORD_SIZE]); /** Construct from two 64 bit values. @@ -556,7 +575,9 @@ class IP6Addr { friend IP6Addr operator|(IP6Addr const &addr, IPMask const &mask); }; -/** Storage for an IP address. +/** An IPv4 or IPv6 address. + * + * The family type is stored. For comparisons, invalid < IPv4 < IPv6. All invalid instances are equal. */ class IPAddr { friend class IPRange; @@ -565,6 +586,7 @@ class IPAddr { public: IPAddr() = default; ///< Default constructor - invalid result. IPAddr(self_type const &that) = default; ///< Copy constructor. + self_type & operator = (self_type const& that) = default; ///< Copy assignment. /// Construct using IPv4 @a addr. explicit IPAddr(in_addr_t addr); @@ -597,10 +619,10 @@ class IPAddr { /// Set to the address in @a addr. self_type &assign(sockaddr_in6 const *addr); - /// Set to the address in @a addr. + /// Set to IPv4 @a addr. self_type &assign(in_addr_t addr); - /// Set to address in @a addr. + /// Set to IPv6 @a addr self_type &assign(in6_addr const &addr); /// Assign from end point. @@ -610,7 +632,7 @@ class IPAddr { self_type &operator=(in_addr_t ip); /// Assign from IPv6 raw address. - self_type &operator=(in6_addr const &ip); + self_type &operator=(in6_addr const &addr); bool operator==(self_type const &that) const; @@ -696,8 +718,6 @@ class IPAddr { union raw_addr_type { IP4Addr _ip4; ///< IPv4 address (host) IP6Addr _ip6; ///< IPv6 address (host) - uint8_t _octet[IP6Addr::SIZE]; ///< IPv4 octets. - uint64_t _u64[IP6Addr::SIZE / sizeof(uint64_t)]; ///< As 64 bit chunks. constexpr raw_addr_type(); @@ -726,9 +746,15 @@ class IPMask { public: using raw_type = uint8_t; ///< Storage for mask width. - IPMask() = default; + IPMask() = default; ///< Default construct to invalid mask. - explicit IPMask(raw_type count); + /** Construct a mask of @a width. + * + * @param width Number of bits in the mask. + * + * @note Because this is a network mask, it is always left justified. + */ + explicit IPMask(raw_type width); /// @return @c true if the mask is valid, @c false if not. bool is_valid() const; @@ -742,7 +768,7 @@ class IPMask { /** Copmute a mask for the network at @a addr. * @param addr Lower bound of network. - * @return The width of the largest network starting at @a addr. + * @return A mask with the width of the largest network starting at @a addr. */ static self_type mask_for(IPAddr const &addr); @@ -758,27 +784,29 @@ class IPMask { */ static self_type mask_for(IP6Addr const &addr); - /// Force @a this to an invalid state. - self_type & - clear() { - _cidr = INVALID; - return *this; - } + /// Change to default constructed state (invalid). + self_type & clear(); /// The width of the mask. raw_type width() const; - self_type & - operator<<=(raw_type n) { - _cidr -= n; - return *this; - } + /** Extend the mask (cover more addresses). + * + * @param n Number of bits to extend. + * @return @a this + * + * Effectively shifts the mask left, bringing in 0 bits on the right. + */ + self_type & operator<<=(raw_type n); - self_type & - operator>>=(raw_type n) { - _cidr += n; - return *this; - } + /** Narrow the mask (cover fewer addresses). + * + * @param n Number of bits to narrow. + * @return @a this + * + * Effectively shift the mask right, bringing in 1 bits on the left. + */ + self_type & operator>>=(raw_type n); /** The mask as an IPv4 address. * @@ -906,7 +934,7 @@ class IP4Range::NetSource { using const_iterator = iterator; iterator begin() const; ///< First network. - iterator end() const; ///< Past last network. + static iterator end() ; ///< Past last network. /// Return @c true if there are valid networks, @c false if not. bool empty() const; @@ -947,7 +975,7 @@ class IP4Range::NetSource { void search_narrower(); - bool is_valid(IP4Addr mask); + bool is_valid(IP4Addr mask) const; }; class IP6Range : public DiscreteRange { @@ -1043,7 +1071,7 @@ class IP6Range::NetSource { iterator begin() const; ///< First network. iterator end() const; ///< Past last network. - /// Return @c true if there are valid networks, @c false if not. + /// @return @c true if there are valid networks, @c false if not. bool empty() const; /// @return The current network. @@ -1052,19 +1080,12 @@ class IP6Range::NetSource { /// Access @a this as if it were an @c IP6Net. self_type *operator->(); - /// Iterator support. /// @return The current network address. - IP6Addr const & - addr() const { - return _range.min(); - } + IP6Addr const & addr() const; /// Iterator support. /// @return The current network mask. - IPMask - mask() const { - return _mask; - } + IPMask mask() const; /// Move to next network. self_type &operator++(); @@ -1114,18 +1135,7 @@ class IPRange { /// Equality bool - operator==(self_type const &that) const { - if (_family != that._family) { - return false; - } - if (this->is_ip4()) { - return _range._ip4 == that._range._ip4; - } - if (this->is_ip6()) { - return _range._ip6 == that._range._ip6; - } - return true; - } + operator==(self_type const &that) const; /// @return @c true if this is an IPv4 range, @c false if not. bool @@ -1583,18 +1593,11 @@ template class IPSpace { template self_type &blend(IPRange const &range, U const &color, F &&blender); template - self_type & - blend(IP4Range const &range, U const &color, F &&blender) { - _ip4.blend(range, color, blender); - return *this; - } + self_type & blend(IP4Range const &range, U const &color, F &&blender); template self_type & - blend(IP6Range const &range, U const &color, F &&blender) { - _ip6.blend(range, color, blender); - return *this; - } + blend(IP6Range const &range, U const &color, F &&blender); /// @return The number of distinct ranges. size_t @@ -1690,7 +1693,7 @@ template class IPSpace { bool operator!=(self_type const &that) const; protected: - // These are stored non-const to make implementing @c iterator easier. This class provides the + // These are stored non-const to make implementing @c iterator easier. The containing class provides the // required @c const protection. This is basic a tuple of iterators - for forward iteration if // the primary (ipv4) iterator is at the end, then use the secondary (ipv6) iterator. The reverse // is done for reverse iteration. This depends on the extra support @c IntrusiveDList iterators @@ -1698,11 +1701,7 @@ template class IPSpace { typename IP4Space::iterator _iter_4; ///< IPv4 sub-space iterator. typename IP6Space::iterator _iter_6; ///< IPv6 sub-space iterator. /// Current value. - value_type _value{IPRange{}, *static_cast(pseudo_nullptr)}; - - /// Dummy payload. - /// @internal Used to initialize @c value_type for invalid iterators. - // static constexpr PAYLOAD * const null_payload = nullptr; + value_type _value{IPRange{}, *static_cast(detail::pseudo_nullptr)}; /** Internal constructor. * @@ -1905,7 +1904,7 @@ IPSpace::const_iterator::operator++() -> self_type & { return *this; } } - new (&_value) value_type{IPRange{}, *static_cast(pseudo_nullptr)}; + new (&_value) value_type{IPRange{}, *static_cast(detail::pseudo_nullptr)}; return *this; } @@ -1930,7 +1929,7 @@ IPSpace::const_iterator::operator--() -> self_type & { new (&_value) value_type{_iter_4->range(), _iter_4->payload()}; return *this; } - new (&_value) value_type{IPRange{}, *static_cast(pseudo_nullptr)}; + new (&_value) value_type{IPRange{}, *static_cast(detail::pseudo_nullptr)}; return *this; } @@ -2090,7 +2089,7 @@ IPAddr::isCompatibleWith(self_type const &that) { inline bool IPAddr::is_loopback() const { - return (AF_INET == _family && 0x7F == _addr._octet[0]) || (AF_INET6 == _family && _addr._ip6.is_loopback()); + return (AF_INET == _family && _addr._ip4.is_loopback()) || (AF_INET6 == _family && _addr._ip6.is_loopback()); } inline IPAddr & @@ -2233,7 +2232,7 @@ IPEndpoint::assign(sockaddr const *src) { } inline IPEndpoint const & -IPEndpoint::fill(sockaddr *addr) const { +IPEndpoint::copy_to(sockaddr *addr) const { self_type::assign(addr, &sa); return *this; } @@ -2281,8 +2280,8 @@ IPEndpoint::port(sockaddr *sa) { } inline in_port_t -IPEndpoint::port(sockaddr const *addr) { - return self_type::port(const_cast(addr)); +IPEndpoint::port(sockaddr const *sa) { + return self_type::port(const_cast(sa)); } inline in_port_t @@ -2396,12 +2395,32 @@ IP4Addr::operator|=(IPMask const &mask) { return *this; } +inline bool +IP4Addr::is_any() const { + return _addr == INADDR_ANY; +} + +inline bool +IP4Addr::is_loopback() const { + return (*this)[3] == IN_LOOPBACKNET; +} + +inline bool +IP4Addr::is_multicast() const { + return IN_MULTICAST(_addr); +} + +inline int +IP4Addr::cmp(IP4Addr::self_type const &that) const { + return _addr < that._addr ? -1 : _addr > that._addr ? 1 : 0; +} + constexpr in_addr_t IP4Addr::reorder(in_addr_t src) { return ((src & 0xFF) << 24) | (((src >> 8) & 0xFF) << 16) | (((src >> 16) & 0xFF) << 8) | ((src >> 24) & 0xFF); } -// --- +// +++ IP6Addr +++ inline IP6Addr::IP6Addr(in6_addr const &addr) { *this = addr; @@ -2415,18 +2434,52 @@ inline IP6Addr::IP6Addr(std::string_view const &text) { inline IP6Addr::IP6Addr(IPAddr const &addr) : _addr{addr._addr._ip6._addr} {} +inline bool +IP6Addr::is_loopback() const { + return _addr._store[0] == 0 && _addr._store[1] == 1; +} + +inline bool +IP6Addr::is_multicast() const { + return _addr._raw[7] == 0xFF; +} + +inline bool +IP6Addr::is_any() const { + return _addr._store[0] == 0 && _addr._store[1] == 0; +} + +inline bool +IP6Addr::is_mapped_ipv4() const { + return 0 == _addr._store[0] && (_addr._quad[7] == 0 && _addr._quad[6] == 0xFFFF); +} + inline in6_addr & IP6Addr::copy_to(in6_addr &addr) const { self_type::reorder(addr, _addr._raw); return addr; } +inline sockaddr * +IP6Addr::copy_to(sockaddr *sa, in_port_t port) const { + IPEndpoint addr(sa); + self_type::reorder(addr.sa6.sin6_addr, _addr._raw); + addr.network_order_port() = port; + return sa; +} + inline in6_addr IP6Addr::network_order() const { in6_addr zret; return this->copy_to(zret); } +inline auto +IP6Addr::clear() -> self_type & { + _addr._store[0] = _addr._store[1] = 0; + return *this; +} + inline auto IP6Addr::operator=(in6_addr const &addr) -> self_type & { self_type::reorder(_addr._raw, addr); @@ -2530,7 +2583,7 @@ IPAddr::operator==(self_type const &that) const { case AF_INET6: return that._family == AF_INET6 && _addr._ip6 == that._addr._ip6; default: - return false; + return ! that.is_valid(); } } @@ -2677,6 +2730,24 @@ IPMask::as_ip4() const { return IP4Addr{addr}; } +inline auto +IPMask::clear() -> self_type & { + _cidr = INVALID; + return *this; +} + +inline auto +IPMask::operator<<=(raw_type n) -> self_type & { + _cidr -= n; + return *this; +} + +inline auto +IPMask::operator>>=(IPMask::raw_type n) -> self_type & { + _cidr += n; + return *this; +} + // +++ mixed mask operators +++ inline IP4Addr @@ -2875,7 +2946,7 @@ operator==(IP6Net const &lhs, IPNet const &rhs) { // +++ Range -> Network classes +++ inline bool -IP4Range::NetSource::is_valid(swoc::IP4Addr mask) { +IP4Range::NetSource::is_valid(swoc::IP4Addr mask) const { return ((mask._addr & _range._min._addr) == _range._min._addr) && ((_range._min._addr | ~mask._addr) <= _range._max._addr); } @@ -2890,7 +2961,7 @@ IP4Range::NetSource::begin() const { } inline IP4Range::NetSource::iterator -IP4Range::NetSource::end() const { +IP4Range::NetSource::end() { return self_type{range_type{}}; } @@ -2964,6 +3035,16 @@ IP6Range::NetSource::operator!=(IP6Range::NetSource::self_type const &that) cons return !(*this == that); } +inline IP6Addr const & +IP6Range::NetSource::addr() const { + return _range.min(); +} + +inline IPMask +IP6Range::NetSource::mask() const { + return _mask; +} + inline IPRange::NetSource::NetSource(IPRange::NetSource::range_type const &range) { if (range.is_ip4()) { new (&_ip4) decltype(_ip4)(range.ip4()); @@ -3091,6 +3172,22 @@ IPSpace::blend(IPRange const &range, U const &color, F &&blender) -> se return *this; } +template +template +auto +IPSpace::blend(IP4Range const &range, U const &color, F &&blender) -> self_type & { + _ip4.blend(range, color, std::forward(blender)); + return *this; +} + +template +template +auto +IPSpace::blend(IP6Range const &range, U const &color, F &&blender) -> self_type & { + _ip6.blend(range, color, std::forward(blender)); + return *this; +} + template void IPSpace::clear() { @@ -3122,14 +3219,14 @@ template auto IPSpace::end_ip4() const -> const_iterator { auto nc_this = const_cast(this); - return iterator(nc_this->_ip4.end(), nc_this->_ip6.begin()); + return { nc_this->_ip4.end(), nc_this->_ip6.begin() }; } template auto IPSpace::begin_ip6() const -> const_iterator { auto nc_this = const_cast(this); - return iterator(nc_this->_ip4.end(), nc_this->_ip6.begin()); + return { nc_this->_ip4.end(), nc_this->_ip6.begin() }; } template diff --git a/lib/swoc/include/swoc/swoc_version.h b/lib/swoc/include/swoc/swoc_version.h index 06af531f030..a35e2d785e2 100644 --- a/lib/swoc/include/swoc/swoc_version.h +++ b/lib/swoc/include/swoc/swoc_version.h @@ -23,11 +23,11 @@ #pragma once #if !defined(SWOC_VERSION_NS) -#define SWOC_VERSION_NS _1_3_5 +#define SWOC_VERSION_NS _1_3_7 #endif namespace swoc { inline namespace SWOC_VERSION_NS { static constexpr unsigned MAJOR_VERSION = 1; static constexpr unsigned MINOR_VERSION = 3; -static constexpr unsigned POINT_VERSION = 5; +static constexpr unsigned POINT_VERSION = 7; }} // namespace swoc::SWOC_VERSION_NS diff --git a/lib/swoc/src/swoc_file.cc b/lib/swoc/src/swoc_file.cc index ef0788e2342..50bf36a46b0 100644 --- a/lib/swoc/src/swoc_file.cc +++ b/lib/swoc/src/swoc_file.cc @@ -114,37 +114,37 @@ chrono_cast(timespec const &ts) { // Under -O2 these are completely elided. template auto -a_time(S const &s) -> decltype(S::st_atim) { +a_time(S const &s, meta::CaseTag<0>) -> decltype(S::st_atim) { return s.st_atim; } template auto -a_time(S const &s) -> decltype(S::st_atimespec) { +a_time(S const &s, meta::CaseTag<1>) -> decltype(S::st_atimespec) { return s.st_atimespec; } template auto -m_time(S const &s) -> decltype(S::st_mtim) { +m_time(S const &s, meta::CaseTag<0>) -> decltype(S::st_mtim) { return s.st_mtim; } template auto -m_time(S const &s) -> decltype(S::st_mtimespec) { +m_time(S const &s, meta::CaseTag<1>) -> decltype(S::st_mtimespec) { return s.st_mtimespec; } template auto -c_time(S const &s) -> decltype(S::st_ctim) { +c_time(S const &s, meta::CaseTag<0>) -> decltype(S::st_ctim) { return s.st_ctim; } template auto -c_time(S const &s) -> decltype(S::st_ctimespec) { +c_time(S const &s, meta::CaseTag<1>) -> decltype(S::st_ctimespec) { return s.st_ctimespec; } @@ -152,17 +152,17 @@ c_time(S const &s) -> decltype(S::st_ctimespec) { std::chrono::system_clock::time_point modify_time(file_status const &fs) { - return chrono_cast(m_time(fs._stat)); + return chrono_cast(m_time(fs._stat, meta::CaseArg)); } std::chrono::system_clock::time_point access_time(file_status const &fs) { - return chrono_cast(a_time(fs._stat)); + return chrono_cast(a_time(fs._stat, meta::CaseArg)); } std::chrono::system_clock::time_point status_time(file_status const &fs) { - return chrono_cast(c_time(fs._stat)); + return chrono_cast(c_time(fs._stat, meta::CaseArg)); } bool diff --git a/lib/swoc/src/swoc_ip.cc b/lib/swoc/src/swoc_ip.cc index 7198d7bbbf6..dc39df5b6fe 100644 --- a/lib/swoc/src/swoc_ip.cc +++ b/lib/swoc/src/swoc_ip.cc @@ -43,7 +43,7 @@ IP6Addr const IP6Addr::MAX{std::numeric_limits::max(), std::numeric_li // The Intel compiler won't let me directly use @c nullptr to construct a reference, so I need // to fake it out by using this psuedo-nullptr. -void *const pseudo_nullptr = 0; +void *const detail::pseudo_nullptr = nullptr; bool IPEndpoint::assign(sockaddr *dst, sockaddr const *src) { @@ -289,7 +289,7 @@ IP4Addr::operator=(sockaddr_in const *sa) -> self_type & { } sockaddr_in * -IP4Addr::fill(sockaddr_in *sa, in_port_t port) const { +IP4Addr::copy_to(sockaddr_in *sa, in_port_t port) const { sa->sin_addr.s_addr = this->network_order(); sa->sin_port = port; return sa; @@ -491,9 +491,9 @@ IPAddr::operator<(self_type const &that) const { case AF_INET: return _addr._ip4 < that._addr._ip4; case AF_INET6: - return false; - default: return true; + default: + return false; } } else if (AF_INET6 == _family) { switch (that._family) { @@ -502,10 +502,10 @@ IPAddr::operator<(self_type const &that) const { case AF_INET6: return _addr._ip6 < that._addr._ip6; default: - return true; + return false; } } - return false; + return that.is_valid(); } int @@ -529,7 +529,7 @@ IPAddr::cmp(self_type const &that) const { return 1; } } - return 0; + return that.is_valid() ? -1 : 0; } IPAddr::self_type & @@ -552,84 +552,9 @@ IPAddr::operator|=(IPMask const &mask) { return *this; } -#if 0 -bool -operator==(IPAddr const &lhs, sockaddr const *rhs) -{ - bool zret = false; - if (lhs._family == rhs->sa_family) { - if (AF_INET == lhs._family) { - zret = lhs._addr._ip4 == ats_ip4_addr_cast(rhs); - } else if (AF_INET6 == lhs._family) { - zret = 0 == memcmp(&lhs._addr._ip6, &ats_ip6_addr_cast(rhs), sizeof(in6_addr)); - } else { // map all non-IP to the same thing. - zret = true; - } - } // else different families, not equal. - return zret; -} - -/** Compare two IP addresses. - This is useful for IPv4, IPv6, and the unspecified address type. - If the addresses are of different types they are ordered - - Non-IP < IPv4 < IPv6 - - - all non-IP addresses are the same ( including @c AF_UNSPEC ) - - IPv4 addresses are compared numerically (host order) - - IPv6 addresses are compared byte wise in network order (MSB to LSB) - - @return - - -1 if @a lhs is less than @a rhs. - - 0 if @a lhs is identical to @a rhs. - - 1 if @a lhs is greater than @a rhs. -*/ -int -IPAddr::cmp(self_type const &that) const -{ - int zret = 0; - uint16_t rtype = that._family; - uint16_t ltype = _family; - - // We lump all non-IP addresses into a single equivalence class - // that is less than an IP address. This includes AF_UNSPEC. - if (AF_INET == ltype) { - if (AF_INET == rtype) { - in_addr_t la = ntohl(_addr._ip4); - in_addr_t ra = ntohl(that._addr._ip4); - if (la < ra) { - zret = -1; - } else if (la > ra) { - zret = 1; - } else { - zret = 0; - } - } else if (AF_INET6 == rtype) { // IPv4 < IPv6 - zret = -1; - } else { // IP > not IP - zret = 1; - } - } else if (AF_INET6 == ltype) { - if (AF_INET6 == rtype) { - zret = memcmp(&_addr._ip6, &that._addr._ip6, TS_IP6_SIZE); - } else { - zret = 1; // IPv6 greater than any other type. - } - } else if (AF_INET == rtype || AF_INET6 == rtype) { - // ltype is non-IP so it's less than either IP type. - zret = -1; - } else { // Both types are non-IP so they're equal. - zret = 0; - } - - return zret; -} - -#endif - bool IPAddr::is_multicast() const { - return (AF_INET == _family && 0xe == (_addr._octet[0] >> 4)) || (AF_INET6 == _family && _addr._ip6.is_multicast()); + return (AF_INET == _family && _addr._ip4.is_multicast()) || (AF_INET6 == _family && _addr._ip6.is_multicast()); } IPEndpoint::IPEndpoint(string_view const &text) { @@ -678,7 +603,7 @@ IPMask::mask_for(IP4Addr const &addr) { raw_type cidr = 0; if (auto q = (n & IP6Addr::QUAD_MASK); q != 0) { cidr = IP6Addr::QUAD_WIDTH + self_type::mask_for_quad(q); - } else if (auto q = ((n >> IP6Addr::QUAD_WIDTH) & IP6Addr::QUAD_MASK); q != 0) { + } else if (q = ((n >> IP6Addr::QUAD_WIDTH) & IP6Addr::QUAD_MASK); q != 0) { cidr = self_type::mask_for_quad(q); } return self_type(cidr); @@ -755,15 +680,14 @@ IP6Net::load(TextView text) { bool IPNet::load(TextView text) { - auto mask_text = text.split_suffix_at('/'); - if (!mask_text.empty()) { + if ( auto mask_text = text.split_suffix_at('/') ; !mask_text.empty() ) { IPMask mask; if (mask.load(mask_text)) { - if (IP6Addr addr; addr.load(text)) { // load the address - this->assign(addr, mask); + if (IP6Addr a6; a6.load(text)) { // load the address + this->assign(a6, mask); return true; - } else if (IP4Addr addr; addr.load(text)) { - this->assign(addr, mask); + } else if (IP4Addr a4; a4.load(text)) { + this->assign(a4, mask); return true; } } @@ -856,6 +780,12 @@ IP4Range::NetSource::operator++() -> self_type & { return *this; } +auto IP4Range::NetSource::operator++(int) -> self_type { + auto zret { *this }; + ++*this; + return zret; +} + void IP4Range::NetSource::search_wider() { while (_cidr > 0) { @@ -950,8 +880,7 @@ IPRange::IPRange(IPAddr const &min, IPAddr const &max) { bool IPRange::load(std::string_view const &text) { static const string_view CHARS{".:"}; - auto idx = text.find_first_of(CHARS); - if (idx != text.npos) { + if ( auto idx = text.find_first_of(CHARS) ; idx != text.npos ) { if (text[idx] == '.') { if (_range._ip4.load(text)) { _family = AF_INET; @@ -1019,6 +948,20 @@ IPRange::network_mask() const { return {}; } +bool +IPRange::operator==(self_type const &that) const { + if (_family != that._family) { + return false; + } + if (this->is_ip4()) { + return _range._ip4 == that._range._ip4; + } + if (this->is_ip6()) { + return _range._ip6 == that._range._ip6; + } + return true; +} + IPMask IP6Range::network_mask() const { NetSource nets{*this}; diff --git a/mgmt/RecordsConfig.cc b/mgmt/RecordsConfig.cc index 21a8ff90455..091b0f4af19 100644 --- a/mgmt/RecordsConfig.cc +++ b/mgmt/RecordsConfig.cc @@ -770,7 +770,7 @@ static const RecordElement RecordsConfig[] = , {RECT_CONFIG, "proxy.config.net.sock_send_buffer_size_in", RECD_INT, "0", RECU_RESTART_TS, RR_NULL, RECC_STR, "^[0-9]+$", RECA_NULL} , - {RECT_CONFIG, "proxy.config.net.sock_option_flag_in", RECD_INT, "0x5", RECU_RESTART_TS, RR_NULL, RECC_NULL, nullptr, RECA_NULL} + {RECT_CONFIG, "proxy.config.net.sock_option_flag_in", RECD_INT, "0x1", RECU_RESTART_TS, RR_NULL, RECC_NULL, nullptr, RECA_NULL} , {RECT_CONFIG, "proxy.config.net.sock_packet_mark_in", RECD_INT, "0x0", RECU_RESTART_TS, RR_NULL, RECC_NULL, nullptr, RECA_NULL} , @@ -896,7 +896,7 @@ static const RecordElement RecordsConfig[] = //############################################################################## {RECT_CONFIG, "proxy.config.dns.lookup_timeout", RECD_INT, "20", RECU_DYNAMIC, RR_NULL, RECC_NULL, nullptr, RECA_NULL} , - {RECT_CONFIG, "proxy.config.dns.retries", RECD_INT, "5", RECU_DYNAMIC, RR_NULL, RECC_NULL, "[0-9]", RECA_NULL} + {RECT_CONFIG, "proxy.config.dns.retries", RECD_INT, "5", RECU_RESTART_TS, RR_NULL, RECC_NULL, "[0-9]", RECA_NULL} , {RECT_CONFIG, "proxy.config.dns.search_default_domains", RECD_INT, "0", RECU_DYNAMIC, RR_NULL, RECC_INT, "[0-1]", RECA_NULL} , diff --git a/plugins/Makefile.am b/plugins/Makefile.am index 75876ae3eba..fff6fdbd667 100644 --- a/plugins/Makefile.am +++ b/plugins/Makefile.am @@ -107,6 +107,10 @@ if BUILD_SSL_SESSION_REUSE_PLUGIN include experimental/ssl_session_reuse/Makefile.inc endif +if BUILD_STEK_SHARE_PLUGIN +include experimental/stek_share/Makefile.inc +endif + if HAS_KYOTOCABINET include experimental/cache_key_genid/Makefile.inc endif diff --git a/plugins/cache_range_requests/cache_range_requests.cc b/plugins/cache_range_requests/cache_range_requests.cc index 622352724de..23f458a8d4a 100644 --- a/plugins/cache_range_requests/cache_range_requests.cc +++ b/plugins/cache_range_requests/cache_range_requests.cc @@ -47,11 +47,14 @@ using parent_select_mode_t = enum parent_select_mode { PS_CACHEKEY_URL, // Set parent selection url to cache_key url }; +constexpr std::string_view DefaultImsHeader = {"X-Crr-Ims"}; + struct pluginconfig { parent_select_mode_t ps_mode{PS_DEFAULT}; bool consider_ims_header{false}; bool modify_cache_key{true}; bool verify_cacheability{false}; + std::string ims_header; }; struct txndata { @@ -61,9 +64,6 @@ struct txndata { bool verify_cacheability{false}; }; -// Header for optional revalidation -constexpr std::string_view X_IMS_HEADER = {"X-Crr-Ims"}; - // pluginconfig struct (global plugin only) pluginconfig *gPluginConfig = {nullptr}; @@ -99,9 +99,10 @@ create_pluginconfig(int argc, char *const argv[]) } static const struct option longopts[] = { - {const_cast("ps-cachekey"), no_argument, nullptr, 'p'}, {const_cast("consider-ims"), no_argument, nullptr, 'c'}, + {const_cast("ims-header"), required_argument, nullptr, 'i'}, {const_cast("no-modify-cachekey"), no_argument, nullptr, 'n'}, + {const_cast("ps-cachekey"), no_argument, nullptr, 'p'}, {const_cast("verify-cacheability"), no_argument, nullptr, 'v'}, {nullptr, 0, nullptr, 0}, }; @@ -111,24 +112,29 @@ create_pluginconfig(int argc, char *const argv[]) --argv; for (;;) { - int const opt = getopt_long(argc, argv, "", longopts, nullptr); + int const opt = getopt_long(argc, argv, "i:", longopts, nullptr); if (-1 == opt) { break; } switch (opt) { - case 'p': { - DEBUG_LOG("Plugin modifies parent selection key"); - pc->ps_mode = PS_CACHEKEY_URL; - } break; case 'c': { - DEBUG_LOG("Plugin considers the '%.*s' header", (int)X_IMS_HEADER.size(), X_IMS_HEADER.data()); + DEBUG_LOG("Plugin considers the ims header"); + pc->consider_ims_header = true; + } break; + case 'i': { + DEBUG_LOG("Plugin uses custom ims header: %s", optarg); + pc->ims_header.assign(optarg); pc->consider_ims_header = true; } break; case 'n': { DEBUG_LOG("Plugin doesn't modify cache key"); pc->modify_cache_key = false; } break; + case 'p': { + DEBUG_LOG("Plugin modifies parent selection key"); + pc->ps_mode = PS_CACHEKEY_URL; + } break; case 'v': { DEBUG_LOG("Plugin verifies whether the object in the transaction is cacheable"); pc->verify_cacheability = true; @@ -144,6 +150,11 @@ create_pluginconfig(int argc, char *const argv[]) pc->ps_mode = PS_CACHEKEY_URL; } + if (pc->consider_ims_header && pc->ims_header.empty()) { + pc->ims_header = DefaultImsHeader; + DEBUG_LOG("Plugin uses default ims header: %s", pc->ims_header.c_str()); + } + return pc; } @@ -244,12 +255,12 @@ range_header_check(TSHttpTxn txnp, pluginconfig *const pc) } } - // optionally consider an X-CRR-IMS header + // optionally consider an ims header if (pc->consider_ims_header) { - TSMLoc const imsloc = TSMimeHdrFieldFind(hdr_buf, hdr_loc, X_IMS_HEADER.data(), X_IMS_HEADER.size()); + TSMLoc const imsloc = TSMimeHdrFieldFind(hdr_buf, hdr_loc, pc->ims_header.data(), pc->ims_header.size()); if (TS_NULL_MLOC != imsloc) { time_t const itime = TSMimeHdrFieldValueDateGet(hdr_buf, hdr_loc, imsloc); - DEBUG_LOG("Servicing the '%.*s' header", (int)X_IMS_HEADER.size(), X_IMS_HEADER.data()); + DEBUG_LOG("Servicing the '%s' header", pc->ims_header.c_str()); TSHandleMLocRelease(hdr_buf, hdr_loc, imsloc); if (0 < itime) { txn_state->ims_time = itime; @@ -303,7 +314,7 @@ handle_send_origin_request(TSCont contp, TSHttpTxn txnp, txndata *const txn_stat } if (TS_SUCCESS == TSHttpTxnServerReqGet(txnp, &hdr_buf, &hdr_loc) && !rv.empty()) { - if (set_header(hdr_buf, hdr_loc, TS_MIME_FIELD_RANGE, TS_MIME_LEN_RANGE, rv.data(), rv.length())) { + if (set_header(hdr_buf, hdr_loc, TS_MIME_FIELD_RANGE, TS_MIME_LEN_RANGE, rv.data(), rv.size())) { DEBUG_LOG("Added range header: %s", rv.c_str()); TSHttpTxnHookAdd(txnp, TS_HTTP_READ_RESPONSE_HDR_HOOK, contp); } @@ -345,7 +356,7 @@ handle_client_send_response(TSHttpTxn txnp, txndata *const txn_state) TSMLoc req_loc = TS_NULL_MLOC; if (TS_SUCCESS == TSHttpTxnClientReqGet(txnp, &req_buf, &req_loc)) { DEBUG_LOG("Adding range header: %s", rv.c_str()); - if (!set_header(req_buf, req_loc, TS_MIME_FIELD_RANGE, TS_MIME_LEN_RANGE, rv.data(), rv.length())) { + if (!set_header(req_buf, req_loc, TS_MIME_FIELD_RANGE, TS_MIME_LEN_RANGE, rv.data(), rv.size())) { DEBUG_LOG("set_header() failed."); } TSHandleMLocRelease(req_buf, TS_NULL_MLOC, req_loc); diff --git a/plugins/esi/esi.cc b/plugins/esi/esi.cc index 3b29f83ce75..3eb18d2e4d3 100644 --- a/plugins/esi/esi.cc +++ b/plugins/esi/esi.cc @@ -169,13 +169,13 @@ class TSStatSystem : public StatSystem { public: void - create(int handle) + create(int handle) override { g_stat_indices[handle] = TSStatCreate(Stats::STAT_NAMES[handle], TS_RECORDDATATYPE_INT, TS_STAT_PERSISTENT, TS_STAT_SYNC_COUNT); } void - increment(int handle, int step = 1) + increment(int handle, int step = 1) override { TSStatIntIncrement(g_stat_indices[handle], step); } diff --git a/plugins/esi/test/StubIncludeHandler.h b/plugins/esi/test/StubIncludeHandler.h index 1b22e29fb30..918ee46c844 100644 --- a/plugins/esi/test/StubIncludeHandler.h +++ b/plugins/esi/test/StubIncludeHandler.h @@ -34,14 +34,14 @@ class StubIncludeHandler : public EsiLib::SpecialIncludeHandler { } - int handleInclude(const char *data, int data_len); + int handleInclude(const char *data, int data_len) override; bool parseCompleteCalled; - void handleParseComplete(); + void handleParseComplete() override; - bool getData(int include_id, const char *&data, int &data_len); + bool getData(int include_id, const char *&data, int &data_len) override; - void getFooter(const char *&footer, int &footer_len); + void getFooter(const char *&footer, int &footer_len) override; ~StubIncludeHandler(); diff --git a/plugins/esi/test/TestHttpDataFetcher.h b/plugins/esi/test/TestHttpDataFetcher.h index cd2ee590527..49f7d00e284 100644 --- a/plugins/esi/test/TestHttpDataFetcher.h +++ b/plugins/esi/test/TestHttpDataFetcher.h @@ -32,14 +32,14 @@ class TestHttpDataFetcher : public HttpDataFetcher public: TestHttpDataFetcher() {} bool - addFetchRequest(const std::string &url, FetchedDataProcessor *callback_obj = nullptr) + addFetchRequest(const std::string &url, FetchedDataProcessor *callback_obj = nullptr) override { ++_n_pending_requests; return true; } DataStatus - getRequestStatus(const std::string &url) const + getRequestStatus(const std::string &url) const override { if (_return_data) { return STATUS_DATA_AVAILABLE; @@ -49,13 +49,13 @@ class TestHttpDataFetcher : public HttpDataFetcher } int - getNumPendingRequests() const + getNumPendingRequests() const override { return _n_pending_requests; }; bool - getContent(const std::string &url, const char *&content, int &content_len) const + getContent(const std::string &url, const char *&content, int &content_len) const override { TestHttpDataFetcher &curr_obj = const_cast(*this); --curr_obj._n_pending_requests; diff --git a/plugins/experimental/access_control/unit_tests/test_utils.cc b/plugins/experimental/access_control/unit_tests/test_utils.cc index 43b1f5c49a3..5040964aa1f 100644 --- a/plugins/experimental/access_control/unit_tests/test_utils.cc +++ b/plugins/experimental/access_control/unit_tests/test_utils.cc @@ -36,7 +36,7 @@ TEST_CASE("Base64: estimate buffer size needed to encode a message", "[Base64][a /* Test with a zero decoded message length */ encodedLen = cryptoBase64EncodedSize(0); - CHECK(4 == encodedLen); + CHECK(1 == encodedLen); /* Test with a random non-zero decoded message length */ encodedLen = cryptoBase64EncodedSize(64); @@ -44,11 +44,11 @@ TEST_CASE("Base64: estimate buffer size needed to encode a message", "[Base64][a /* Test the space for padding. Size of encoding that would result in 2 x "=" padding */ encodedLen = cryptoBase64EncodedSize(strlen("176a1620e31b14782ba2b66de3edc5b3cb19630475b2ce2ee292d5fd0fe41c3abc")); - CHECK(92 == encodedLen); + CHECK(89 == encodedLen); /* Test the space for padding. Size of encoding that would result in 1 x "=" padding */ encodedLen = cryptoBase64EncodedSize(strlen("176a1620e31b14782ba2b66de3edc5b3cb19630475b2ce2ee292d5fd0fe41c3ab")); - CHECK(90 == encodedLen); + CHECK(89 == encodedLen); /* Test the space for padding. Size of encoding that would result in no padding */ encodedLen = cryptoBase64EncodedSize(strlen("176a1620e31b14782ba2b66de3edc5b3cb19630475b2ce2ee292d5fd0fe41c3a")); @@ -63,27 +63,27 @@ TEST_CASE("Base64: estimate buffer size needed to decode a message", "[Base64][a /* Padding with 2 x '=' */ encoded = "MTc2YTE2MjBlMzFiMTQ3ODJiYTJiNjZkZTNlZGM1YjNjYjE5NjMwNDc1YjJjZTJlZTI5MmQ1ZmQwZmU0MWMzYQ=="; encodedLen = cryptoBase64DecodeSize(encoded, strlen(encoded)); - CHECK(66 == encodedLen); + CHECK(67 == encodedLen); /* Padding with 1 x '=' */ encoded = "MTc2YTE2MjBlMzFiMTQ3ODJiYTJiNjZkZTNlZGM1YjNjYjE5NjMwNDc1YjJjZTJlZTI5MmQ1ZmQwZmU0MWMzYWI="; encodedLen = cryptoBase64DecodeSize(encoded, strlen(encoded)); - CHECK(66 == encodedLen); + CHECK(67 == encodedLen); /* Padding with 0 x "=" */ encoded = "MTc2YTE2MjBlMzFiMTQ3ODJiYTJiNjZkZTNlZGM1YjNjYjE5NjMwNDc1YjJjZTJlZTI5MmQ1ZmQwZmU0MWMzYWJj"; encodedLen = cryptoBase64DecodeSize(encoded, strlen(encoded)); - CHECK(66 == encodedLen); + CHECK(67 == encodedLen); /* Test empty encoded message calculation */ encoded = ""; encodedLen = cryptoBase64DecodeSize(encoded, strlen(encoded)); - CHECK(0 == encodedLen); + CHECK(1 == encodedLen); /* Test empty encoded message calculation */ encoded = nullptr; encodedLen = cryptoBase64DecodeSize(encoded, 0); - CHECK(0 == encodedLen); + CHECK(1 == encodedLen); } TEST_CASE("Base64: quick encode / decode", "[Base64][access_control][utility]") @@ -103,7 +103,7 @@ TEST_CASE("Base64: quick encode / decode", "[Base64][access_control][utility]") encodedMessageLen)); size_t decodedMessageEstimatedLen = cryptoBase64DecodeSize(encodedMessage, encodedMessageLen); - CHECK(66 == decodedMessageEstimatedLen); + CHECK(67 == decodedMessageEstimatedLen); char decodedMessage[encodedMessageEstimatedLen]; size_t decodedMessageLen = cryptoBase64Decode(encodedMessage, encodedMessageLen, decodedMessage, encodedMessageLen); diff --git a/plugins/experimental/access_control/utils.cc b/plugins/experimental/access_control/utils.cc index 53911e463b3..211716da5f0 100644 --- a/plugins/experimental/access_control/utils.cc +++ b/plugins/experimental/access_control/utils.cc @@ -296,7 +296,7 @@ cryptoMessageDigestEqual(const char *md1, size_t md1Len, const char *md2, size_t size_t cryptoBase64EncodedSize(size_t decodedSize) { - return ATS_BASE64_ENCODE_DSTLEN(decodedSize); + return ats_base64_encode_dstlen(decodedSize); } /** @@ -308,7 +308,7 @@ cryptoBase64EncodedSize(size_t decodedSize) size_t cryptoBase64DecodeSize(const char *encoded, size_t encodedLen) { - return ATS_BASE64_DECODE_DSTLEN(encodedLen); + return ats_base64_decode_dstlen(encodedLen); } /** diff --git a/plugins/experimental/memcache/tsmemcache.cc b/plugins/experimental/memcache/tsmemcache.cc index 6943b57017e..9bc11981df3 100644 --- a/plugins/experimental/memcache/tsmemcache.cc +++ b/plugins/experimental/memcache/tsmemcache.cc @@ -179,9 +179,9 @@ MC::die() if (cbuf) { free_MIOBuffer(cbuf); } - if (tbuf) { - ats_free(tbuf); - } + + ats_free(tbuf); + mutex = NULL; theMCAllocator.free(this); return EVENT_DONE; @@ -351,9 +351,9 @@ MC::read_from_client() cbuf->clear(); } ink_assert(!crvc && !cwvc); - if (tbuf) { - ats_free(tbuf); - } + + ats_free(tbuf); + return TS_SET_CALL(&MC::read_from_client_event, VC_EVENT_READ_READY, rvio); } diff --git a/plugins/experimental/metalink/metalink.cc b/plugins/experimental/metalink/metalink.cc index 9f7d201a410..b8eae9a8cb5 100644 --- a/plugins/experimental/metalink/metalink.cc +++ b/plugins/experimental/metalink/metalink.cc @@ -693,7 +693,7 @@ location_handler(TSCont contp, TSEvent event, void * /* edata ATS_UNUSED */) const char *value; int length; - char digest[33]; /* ATS_BASE64_DECODE_DSTLEN() */ + char digest[33]; /* ats_base64_decode_dstlen() */ SendData *data = static_cast(TSContDataGet(contp)); TSContDestroy(contp); diff --git a/plugins/experimental/money_trace/README b/plugins/experimental/money_trace/README index 902f860199f..5c32d01665a 100644 --- a/plugins/experimental/money_trace/README +++ b/plugins/experimental/money_trace/README @@ -1,27 +1,34 @@ Money trace plugin - This is a remap plugin that allows ATS to participate in a distributed tracing system based upon - the Comcast "Money" distributed tracing and monitoring library. The Comcast "Money" library has - its roots in Google's Dapper and Twitters Zipkin systems. A money trace header or session id, is - attached to transaction and allows an operator with the appropriate logging systems in place, - to determine where errors and/or latency may exit. + This is a remap plugin that allows ATS to participate in a distributed + tracing system based upon the Comcast "Money" distributed tracing + and monitoring library. The Comcast "Money" library has its roots in + Google's Dapper and Twitters Zipkin systems. A money trace header or + session id, is attached to transaction and allows an operator with + the appropriate logging systems in place, to determine where errors + and/or latency may exit. - Use of the library enables the tracing of a transaction through all systems that participate in - handling the request. See the documentation on this open source library at - https://github.com/Comcast/money/wiki. + Use of the library enables the tracing of a transaction through all + systems that participate in handling the request. See the documentation + on this open source library at https://github.com/Comcast/money/wiki. - This plugin checks incoming requests for the "X-MoneyTrace" header. If the header is not present - no further processing takes place. However if the header is present, the plugin will check to - to see if the request has been cached. If so, the plugin will add the "X-Moneytrace" header from the - incoming request to the cached response returned to the client as required by the money_trace - protocol. If the request has not been cached, the plugin will extends the trace context by creating a new - "X-MoneyTrace" header for inclusion in the outgoing request to a parent cache or origin server. - The extended header includes the 'trace-id' from the incoming request, the incoming span-id - becomes the outgoing parent-id and the plugin generates a new random long span id for the outgoing request. - See the documentation at the link above for a complete description on the "X-MoneyTrace" header and how - to use and extend it in a distributed tracing system. + This plugin checks incoming requests for the "X-MoneyTrace" header. + If the header is not present no further processing takes place. + However if the header is present, the plugin will check to to + see if the request has been cached. If so, the plugin will add the + "X-Moneytrace" header from the incoming request to the cached response + returned to the client as required by the money_trace protocol. + If the request has not been cached, the plugin will extends the trace + context by creating a new "X-MoneyTrace" header for inclusion in the + outgoing request to a parent cache or origin server. The extended + header includes the 'trace-id' from the incoming request, the incoming + span-id becomes the outgoing parent-id and the plugin generates a new + random long span id for the outgoing request. See the documentation + at the link above for a complete description on the "X-MoneyTrace" + header and how to use and extend it in a distributed tracing system. - To configure and use this plugin, simply add it in the remap.config file where needed. EXAMPLE: + To configure and use this plugin, simply add it in the remap.config + file where needed. EXAMPLE: map http://vod.foobar.com http://origin.vod.foobar.com @plugin=money_trace.so diff --git a/plugins/experimental/money_trace/money_trace.cc b/plugins/experimental/money_trace/money_trace.cc index d8638f316dd..69d3252685c 100644 --- a/plugins/experimental/money_trace/money_trace.cc +++ b/plugins/experimental/money_trace/money_trace.cc @@ -17,130 +17,361 @@ * under the License. */ -#include -#include -#include -#include +#include "tscore/BufferWriter.h" #include "ts/ts.h" #include "ts/remap.h" +#include +#include +#include + #include "money_trace.h" -/** - * Allocate transaction data structure. - */ -static struct txndata * -allocTransactionData() +namespace +{ +std::string_view const DefaultMimeHeader = "X-MoneyTrace"; +enum PluginType { REMAP, GLOBAL }; + +struct Config { + std::string header; // override header + std::string pregen_header; // generate request header during remap + std::string global_skip_header; // skip global plugin + bool create_if_none = false; + bool passthru = false; // transparen mode: pass any headers through +}; + +Config * +config_from_args(int const argc, char const *argv[], PluginType const ptype) { - LOG_DEBUG("allocating transaction state data."); - struct txndata *txn_data = static_cast(TSmalloc(sizeof(struct txndata))); - txn_data->client_request_mt_header = nullptr; - txn_data->new_span_mt_header = nullptr; - return txn_data; + Config *const conf = new Config; + + static const struct option longopt[] = { + {const_cast("passthru"), required_argument, nullptr, 'a'}, + {const_cast("create-if-none"), required_argument, nullptr, 'c'}, + {const_cast("global-skip-header"), required_argument, nullptr, 'g'}, + {const_cast("header"), required_argument, nullptr, 'h'}, + {const_cast("pregen-header"), required_argument, nullptr, 'p'}, + {nullptr, 0, nullptr, 0}, + }; + + // getopt assumes args start at '1' so this hack is needed + do { + int const opt = getopt_long(argc, (char *const *)argv, "a:c:h:l:p:", longopt, nullptr); + + if (-1 == opt) { + break; + } + + LOG_DEBUG("Opt: %c", opt); + + switch (opt) { + case 'a': + if ("true" == std::string_view{optarg}) { + LOG_DEBUG("Plugin acts as passthrough"); + conf->passthru = true; + } + break; + case 'c': + if ("true" == std::string_view{optarg}) { + LOG_DEBUG("Plugin will create header if missing"); + conf->create_if_none = true; + } + break; + case 'g': + LOG_DEBUG("Using global-skip-header: '%s'", optarg); + conf->global_skip_header.assign(optarg); + break; + case 'h': + LOG_DEBUG("Using custom header: '%s'", optarg); + conf->header.assign(optarg); + break; + case 'p': + LOG_DEBUG("Using pregen_header '%s'", optarg); + conf->pregen_header.assign(optarg); + break; + default: + break; + } + } while (true); + + if (conf->header.empty()) { + conf->header.assign(DefaultMimeHeader); + LOG_DEBUG("Using default header name: '%.*s'", (int)DefaultMimeHeader.length(), DefaultMimeHeader.data()); + } + + if (conf->passthru && conf->create_if_none) { + LOG_ERROR("passthru conflicts with create-if-none, disabling create-if-none!"); + conf->create_if_none = false; + } + + if (REMAP == ptype && !conf->global_skip_header.empty()) { + LOG_ERROR("--global-skip-header inappropriate for remap plugin, removing option!"); + conf->global_skip_header.clear(); + } + + return conf; } -/** - * free any previously allocated transaction data. - */ -static void -freeTransactionData(struct txndata *txn_data) +struct TxnData { + std::string client_trace; + std::string this_trace; + Config const *config = nullptr; +}; + +std::string_view const traceid{"trace-id="}; +std::string_view const parentid{"parent-id="}; +std::string_view const spanid{"span-id="}; +std::string_view const zerospan{"0"}; +char const sep{';'}; + +std::string +next_trace(std::string_view const request_hdr, TSHttpTxn const txnp) { - LOG_DEBUG("de-allocating transaction state data."); + std::string nexttrace; + + LOG_DEBUG("next_trace with '%.*s'", (int)request_hdr.length(), request_hdr.data()); + + std::string_view view = request_hdr; + + // trace-id must be first + if (0 != view.rfind(traceid, 0)) { + LOG_DEBUG("Expected to find prefix '%.*s' in '%.*s'", (int)traceid.length(), traceid.data(), (int)view.length(), view.data()); + return nexttrace; + } + + view = view.substr(traceid.length()); - if (txn_data != nullptr) { - LOG_DEBUG("freeing transaction data."); - TSfree(txn_data->client_request_mt_header); - TSfree(txn_data->new_span_mt_header); - TSfree(txn_data); + // look for separator + size_t seppos = view.find_first_of(sep); + if (0 == seppos) { + LOG_DEBUG("Trace is empty for '%.*s'", (int)request_hdr.length(), request_hdr.data()); + return nexttrace; } + + std::string_view trace = view.substr(0, seppos); + + if (std::string_view::npos == seppos) { + LOG_DEBUG("Expected to find separator '%c' in %.*s", sep, (int)request_hdr.length(), request_hdr.data()); + view = std::string_view{}; + } + + std::string_view span; + + // scan remaining tokens + while (!view.empty() && span.empty()) { + // skip any leading whitespace + while (!view.empty() && ' ' == view.front()) { + view = view.substr(1); + } + + // check for span-id field + if (0 == view.rfind(spanid, 0)) { + span = view.substr(spanid.length()); + seppos = span.find_first_of(sep); + span = span.substr(0, seppos); + + // remove any trailing white space + while (!span.empty() && ' ' == span.back()) { + span = span.substr(0, span.length() - 1); + } + } else { + LOG_DEBUG("Non '%.*s' found in '%.*s'", (int)spanid.length(), spanid.data(), (int)view.length(), view.data()); + } + + if (span.empty()) { + seppos = view.find_first_of(sep); + + // move forward past sep + if (std::string_view::npos != seppos) { + view = view.substr(seppos + 1); + LOG_DEBUG("Trimming view to '%.*s'", (int)view.length(), view.data()); + } else { + view = std::string_view{}; + } + } + } + + if (span.empty()) { + LOG_DEBUG("No span found, using default '%.*s'", (int)zerospan.length(), zerospan.data()); + span = zerospan; + } + + // span becomes new parent + ts::LocalBufferWriter<8192> bwriter; + + bwriter.write(traceid); + bwriter.write(trace); + bwriter.write(sep); + bwriter.write(parentid); + bwriter.write(span); + bwriter.write(sep); + bwriter.write(spanid); + bwriter.print("{}", TSHttpTxnIdGet(txnp)); + + nexttrace.assign(bwriter.view()); + + return nexttrace; +} + +std::string +create_trace(TSHttpTxn const txnp) +{ + std::string header; + + constexpr char new_parent{'0'}; + + TSUuid const uuid = TSUuidCreate(); + if (nullptr != uuid) { + if (TS_SUCCESS == TSUuidInitialize(uuid, TS_UUID_V4)) { + char const *const uuidstr = TSUuidStringGet(uuid); + if (nullptr != uuidstr) { + ts::LocalBufferWriter<8192> bwriter; + + bwriter.write(traceid); + bwriter.write(uuidstr); + bwriter.write(sep); + bwriter.write(parentid); + bwriter.write(new_parent); + bwriter.write(sep); + bwriter.write(spanid); + bwriter.print("{}", TSHttpTxnIdGet(txnp)); + + header.assign(bwriter.view()); + } else { + LOG_ERROR("Error getting uuid string"); + } + } else { + LOG_ERROR("Error initializing uuid"); + } + + TSUuidDestroy(uuid); + } else { + LOG_ERROR("Error calling TSUuidCreate"); + } + + return header; } /** - * The TS_EVENT_HTTP_CACHE_LOOKUP_COMPLETE event callback. - * - * If there is a cache hit only schedule a TS_HTTP_SEND_RESPONSE_HDR_HOOK - * continuation to send back the money trace header in the response to the - * client. - * - * If there is a cache miss, a new money trace header is created and a - * TS_HTTP_SEND_REQUES_HDR_HOOK continuation is scheduled to add the - * new money trace header to the parent request. + * Creates header if necessary, sets given value. */ -static void -mt_cache_lookup_check(TSCont contp, TSHttpTxn txnp, struct txndata *txn_data) +bool +set_header(TSMBuffer const bufp, TSMLoc const hdr_loc, std::string const &hdr, std::string const &val) { - MT generator; - int cache_result = 0; - char *new_mt_header; + bool isset = false; - if (TS_SUCCESS != TSHttpTxnCacheLookupStatusGet(txnp, &cache_result)) { - LOG_ERROR("Unable to get cache status."); + TSMLoc field_loc = TSMimeHdrFieldFind(bufp, hdr_loc, hdr.data(), hdr.length()); + + if (TS_NULL_MLOC == field_loc) { + // No existing header, so create one + if (TS_SUCCESS == TSMimeHdrFieldCreateNamed(bufp, hdr_loc, hdr.data(), hdr.length(), &field_loc)) { + if (TS_SUCCESS == TSMimeHdrFieldValueStringSet(bufp, hdr_loc, field_loc, -1, val.data(), val.length())) { + TSMimeHdrFieldAppend(bufp, hdr_loc, field_loc); + LOG_DEBUG("header/value added: '%s' '%s'", hdr.c_str(), val.c_str()); + isset = true; + } else { + LOG_DEBUG("unable to set: '%s' to '%s'", hdr.c_str(), val.c_str()); + } + TSHandleMLocRelease(bufp, hdr_loc, field_loc); + } else { + LOG_DEBUG("unable to create: '%s'", hdr.c_str()); + } } else { - switch (cache_result) { - case TS_CACHE_LOOKUP_MISS: - case TS_CACHE_LOOKUP_SKIPPED: - new_mt_header = const_cast(generator.moneyTraceHdr(txn_data->client_request_mt_header)); - if (new_mt_header != nullptr) { - LOG_DEBUG("cache miss, built a new money trace header: %s.", new_mt_header); - txn_data->new_span_mt_header = new_mt_header; + bool first = true; + while (field_loc) { + TSMLoc const tmp = TSMimeHdrFieldNextDup(bufp, hdr_loc, field_loc); + if (first) { + first = false; + if (TS_SUCCESS == TSMimeHdrFieldValueStringSet(bufp, hdr_loc, field_loc, -1, val.data(), val.length())) { + LOG_DEBUG("header/value set: '%s' '%s'", hdr.c_str(), val.c_str()); + isset = true; + } else { + LOG_DEBUG("unable to set: '%s' to '%s'", hdr.c_str(), val.c_str()); + } } else { - LOG_DEBUG("failed to build a new money trace header."); + TSMimeHdrFieldDestroy(bufp, hdr_loc, field_loc); } - TSHttpTxnHookAdd(txnp, TS_HTTP_SEND_REQUEST_HDR_HOOK, contp); - - // fall through to the default as we always need to send the original - // money trace header received from the client back to the client in the - // response - // fallthrough - - default: - TSHttpTxnHookAdd(txnp, TS_HTTP_SEND_RESPONSE_HDR_HOOK, contp); - break; + TSHandleMLocRelease(bufp, hdr_loc, field_loc); + field_loc = tmp; } } + + return isset; } /** - * remap entry point, called to check for the existence of a money trace - * header. If there is one, schedule the continuation to call back and - * process on TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK and TS_HTTP_TXN_CLOSE_HOOK. + * The TS_EVENT_HTTP_POST_REMAP callback. + * + * If global_skip_header is set the global plugin + * will check for it here. */ -static void -mt_check_request_header(TSHttpTxn txnp) +void +global_skip_check(TSCont const contp, TSHttpTxn const txnp, TxnData *const txn_data) { - int length = 0; - struct txndata *txn_data = nullptr; - TSMBuffer bufp; - TSMLoc hdr_loc = nullptr, field_loc = nullptr; - TSCont contp; + Config const *const conf = txn_data->config; + if (conf->global_skip_header.empty()) { + LOG_ERROR("Called in error, no global skip header defined!"); + return; + } - // check for a money trace header. If there is one, schedule appropriate continuations. + // Check for a money trace header. Route accordingly. + TSMBuffer bufp = nullptr; + TSMLoc hdr_loc = TS_NULL_MLOC; if (TS_SUCCESS == TSHttpTxnClientReqGet(txnp, &bufp, &hdr_loc)) { - field_loc = TSMimeHdrFieldFind(bufp, hdr_loc, MIME_FIELD_MONEY_TRACE, MIME_LEN_MONEY_TRACE); + TSMLoc const field_loc = TSMimeHdrFieldFind(bufp, hdr_loc, conf->global_skip_header.c_str(), conf->global_skip_header.length()); if (TS_NULL_MLOC != field_loc) { - const char *hdr_value = TSMimeHdrFieldValueStringGet(bufp, hdr_loc, field_loc, 0, &length); - if (!hdr_value || length <= 0) { - LOG_DEBUG("ignoring, corrupt money trace header."); - } else { - if (nullptr == (contp = TSContCreate(transaction_handler, nullptr))) { - LOG_ERROR("failed to create the transaction handler continuation"); - } else { - txn_data = allocTransactionData(); - txn_data->client_request_mt_header = TSstrndup(hdr_value, length); - txn_data->client_request_mt_header[length] = '\0'; // workaround for bug in core. - LOG_DEBUG("found money trace header: %s, length: %d", txn_data->client_request_mt_header, length); - TSContDataSet(contp, txn_data); - TSHttpTxnHookAdd(txnp, TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK, contp); - TSHttpTxnHookAdd(txnp, TS_HTTP_TXN_CLOSE_HOOK, contp); - } + LOG_DEBUG("global_skip_header found, disabling for the rest of this transaction"); + TSHandleMLocRelease(bufp, hdr_loc, field_loc); + } else { // schedule continuations + if (conf->create_if_none || !txn_data->client_trace.empty()) { + TSHttpTxnHookAdd(txnp, TS_HTTP_SEND_REQUEST_HDR_HOOK, contp); } + if (!txn_data->client_trace.empty()) { + TSHttpTxnHookAdd(txnp, TS_HTTP_SEND_RESPONSE_HDR_HOOK, contp); + } + } + } +} + +/** + * The TS_EVENT_HTTP_SEND_REQUEST_HDR callback. + * + * When a parent request is made, this function adds the new + * money trace header to the parent request headers. + */ +void +send_server_request(TSHttpTxn const txnp, TxnData *const txn_data) +{ + Config const *const conf = txn_data->config; + if (txn_data->this_trace.empty()) { + if (conf->passthru) { + txn_data->this_trace = txn_data->client_trace; + } else if (!txn_data->client_trace.empty()) { + txn_data->this_trace = next_trace(txn_data->client_trace, txnp); + } else if (conf->create_if_none) { + txn_data->this_trace = create_trace(txnp); + } + } + + if (txn_data->this_trace.empty()) { + if (conf->create_if_none) { + LOG_DEBUG("Unable to deal with client trace '%s', creating new", txn_data->client_trace.c_str()); + txn_data->this_trace = create_trace(txnp); } else { - LOG_DEBUG("no money trace header was found in the request."); + LOG_DEBUG("Unable to deal with client trace '%s', passing through!", txn_data->client_trace.c_str()); + txn_data->this_trace = txn_data->client_trace; + } + } + + TSMBuffer bufp = nullptr; + TSMLoc hdr_loc = TS_NULL_MLOC; + if (TS_SUCCESS == TSHttpTxnServerReqGet(txnp, &bufp, &hdr_loc)) { + if (!set_header(bufp, hdr_loc, txn_data->config->header, txn_data->this_trace)) { + LOG_ERROR("Unable to set the server request trace header '%s'", txn_data->this_trace.c_str()); } } else { - LOG_DEBUG("failed to retrieve the client request."); + LOG_ERROR("Unable to get the txn server request"); } - TSHandleMLocRelease(bufp, hdr_loc, field_loc); } /** @@ -149,73 +380,164 @@ mt_check_request_header(TSHttpTxn txnp) * Adds the money trace header received in the client request to the * client response headers. */ -static void -mt_send_client_response(TSHttpTxn txnp, struct txndata *txn_data) +void +send_client_response(TSHttpTxn const txnp, TxnData *const txn_data) { - TSMBuffer bufp; - TSMLoc hdr_loc = nullptr, field_loc = nullptr; + LOG_DEBUG("send_client_response"); - if (txn_data->client_request_mt_header == nullptr) { - LOG_DEBUG("no client request header to return."); + if (txn_data->client_trace.empty()) { + LOG_DEBUG("no client trace data to return."); return; } - // send back the money trace header received in the request - // back in the response to the client. - if (TS_SUCCESS != TSHttpTxnClientRespGet(txnp, &bufp, &hdr_loc)) { - LOG_DEBUG("could not get the server response headers."); - return; - } else { - if (TS_SUCCESS == - TSMimeHdrFieldCreateNamed(bufp, hdr_loc, MIME_FIELD_MONEY_TRACE, strlen(MIME_FIELD_MONEY_TRACE), &field_loc)) { - if (TS_SUCCESS == TSMimeHdrFieldValueStringSet(bufp, hdr_loc, field_loc, -1, txn_data->client_request_mt_header, - strlen(txn_data->client_request_mt_header))) { - LOG_DEBUG("response header added: %s: %s", MIME_FIELD_MONEY_TRACE, txn_data->client_request_mt_header); - TSMimeHdrFieldAppend(bufp, hdr_loc, field_loc); - } - } else { - LOG_DEBUG("failed to create money trace response header."); + // send back the original money trace header received in the + // client request back in the response to the client. + TSMBuffer bufp = nullptr; + TSMLoc hdr_loc = TS_NULL_MLOC; + if (TS_SUCCESS == TSHttpTxnClientRespGet(txnp, &bufp, &hdr_loc)) { + if (!set_header(bufp, hdr_loc, txn_data->config->header, txn_data->client_trace)) { + LOG_ERROR("Unable to set the client response trace header."); } + } else { + LOG_DEBUG("Unable to get the txn client response"); } - TSHandleMLocRelease(bufp, hdr_loc, field_loc); - - return; } /** - * The TS_EVENT_HTTP_SEND_REQUEST_HDR callback. - * - * When a parent request is made, this function adds the new - * money trace header to the parent request headers. + * Transaction event handler. */ -static void -mt_send_server_request(TSHttpTxn txnp, struct txndata *txn_data) +int +transaction_handler(TSCont const contp, TSEvent const event, void *const edata) { - TSMBuffer bufp; - TSMLoc hdr_loc = nullptr, field_loc = nullptr; + TSHttpTxn const txnp = static_cast(edata); + TxnData *const txn_data = static_cast(TSContDataGet(contp)); - if (txn_data->new_span_mt_header == nullptr) { - LOG_DEBUG("there is no new mt request header to send."); - return; + switch (event) { + case TS_EVENT_HTTP_POST_REMAP: + LOG_DEBUG("global plugin checking for skip header"); + global_skip_check(contp, txnp, txn_data); + break; + case TS_EVENT_HTTP_SEND_REQUEST_HDR: + LOG_DEBUG("updating send request headers."); + send_server_request(txnp, txn_data); + break; + case TS_EVENT_HTTP_SEND_RESPONSE_HDR: + LOG_DEBUG("updating send response headers."); + send_client_response(txnp, txn_data); + break; + case TS_EVENT_HTTP_TXN_CLOSE: + LOG_DEBUG("handling transaction close."); + delete txn_data; + TSContDestroy(contp); + break; + default: + TSAssert(!"Unexpected event"); + break; } + TSHttpTxnReenable(txnp, TS_EVENT_HTTP_CONTINUE); - if (TS_SUCCESS == TSHttpTxnServerReqGet(txnp, &bufp, &hdr_loc)) { - field_loc = TSMimeHdrFieldFind(bufp, hdr_loc, MIME_FIELD_MONEY_TRACE, MIME_LEN_MONEY_TRACE); + return TS_SUCCESS; +} + +/** + * Check for the existence of a money trace header. + * If there is one, schedule the continuation to call back and + * process on send request or send response. + * Global plugin may need to schedule a hook to check for skip header. + */ +void +check_request_header(TSHttpTxn const txnp, Config const *const conf, PluginType const ptype) +{ + TxnData *txn_data = nullptr; + + // Check for a money trace header. Route accordingly. + TSMBuffer bufp = nullptr; + TSMLoc hdr_loc = TS_NULL_MLOC; + if (TS_SUCCESS == TSHttpTxnClientReqGet(txnp, &bufp, &hdr_loc)) { + TSMLoc const field_loc = TSMimeHdrFieldFind(bufp, hdr_loc, conf->header.c_str(), conf->header.length()); if (TS_NULL_MLOC != field_loc) { - if (TS_SUCCESS == TSMimeHdrFieldValueStringSet(bufp, hdr_loc, field_loc, -1, txn_data->new_span_mt_header, - strlen(txn_data->new_span_mt_header))) { - LOG_DEBUG("server request header updated: %s: %s", MIME_FIELD_MONEY_TRACE, txn_data->new_span_mt_header); + int length = 0; + const char *hdr_value = TSMimeHdrFieldValueStringGet(bufp, hdr_loc, field_loc, 0, &length); + if (!hdr_value || length <= 0) { + LOG_DEBUG("ignoring, corrupt trace header."); + } else { + txn_data = new TxnData; + txn_data->config = conf; + txn_data->client_trace.assign(hdr_value, length); + LOG_DEBUG("found monetrace header: '%.*s', length: %d", length, hdr_value, length); + } + TSHandleMLocRelease(bufp, hdr_loc, field_loc); + } else if (!conf->passthru && conf->create_if_none) { + txn_data = new TxnData; + txn_data->config = conf; + txn_data->this_trace = create_trace(txnp); + LOG_DEBUG("created trace header: '%s'", txn_data->this_trace.c_str()); + } else { + LOG_DEBUG("no trace header handling for this request."); + } + + // Check for pregen_header + if (nullptr != txn_data && !conf->pregen_header.empty()) { + if (txn_data->this_trace.empty()) { + txn_data->this_trace = next_trace(txn_data->client_trace, txnp); + + if (txn_data->this_trace.empty()) { + if (conf->create_if_none) { + LOG_DEBUG("Unable to deal with client trace '%s', creating new", txn_data->client_trace.c_str()); + txn_data->this_trace = create_trace(txnp); + } else { + LOG_DEBUG("Unable to deal with client trace '%s', passing through!", txn_data->client_trace.c_str()); + txn_data->this_trace = txn_data->client_trace; + } + } + } + if (!txn_data->this_trace.empty()) { + if (!set_header(bufp, hdr_loc, conf->pregen_header, txn_data->this_trace)) { + LOG_ERROR("Unable to set the client request pregen trace header."); + } + } + } + } else { + LOG_DEBUG("unable to get the request request"); + } + + // Schedule appropriate continuations + if (nullptr != txn_data) { + TSCont const contp = TSContCreate(transaction_handler, nullptr); + if (nullptr != contp) { + TSContDataSet(contp, txn_data); + TSHttpTxnHookAdd(txnp, TS_HTTP_TXN_CLOSE_HOOK, contp); + + // global plugin may need to check for skip header + if (GLOBAL == ptype && !conf->global_skip_header.empty()) { + TSHttpTxnHookAdd(txnp, TS_HTTP_POST_REMAP_HOOK, contp); + } else { + if (conf->create_if_none || !txn_data->client_trace.empty()) { + TSHttpTxnHookAdd(txnp, TS_HTTP_SEND_REQUEST_HDR_HOOK, contp); + } + if (!txn_data->client_trace.empty()) { + TSHttpTxnHookAdd(txnp, TS_HTTP_SEND_RESPONSE_HDR_HOOK, contp); + } } } else { - LOG_DEBUG("unable to retrieve the money trace header location from the server request headers."); - return; + LOG_ERROR("failed to create the transaction handler continuation"); + delete txn_data; } } - TSHandleMLocRelease(bufp, hdr_loc, field_loc); +} - return; +int +global_request_header_hook(TSCont const contp, TSEvent const event, void *const edata) +{ + TSHttpTxn const txnp = static_cast(edata); + Config const *const conf = static_cast(TSContDataGet(contp)); + check_request_header(txnp, conf, GLOBAL); + TSHttpTxnReenable(txnp, TS_EVENT_HTTP_CONTINUE); + return 0; } +} // namespace + /** * Remap initialization. */ @@ -233,7 +555,7 @@ TSRemapInit(TSRemapInterface *api_info, char *errbuf, int errbuf_size) return TS_ERROR; } - LOG_DEBUG("cache_range_requests remap is successfully initialized."); + LOG_DEBUG("money_trace remap is successfully initialized."); return TS_SUCCESS; } @@ -244,6 +566,11 @@ TSRemapInit(TSRemapInterface *api_info, char *errbuf, int errbuf_size) TSReturnCode TSRemapNewInstance(int argc, char *argv[], void **ih, char * /*errbuf */, int /* errbuf_size */) { + // second arg poses as the program name + --argc; + ++argv; + Config *const conf = config_from_args(argc, const_cast(argv), REMAP); + *ih = static_cast(conf); return TS_SUCCESS; } @@ -253,7 +580,8 @@ TSRemapNewInstance(int argc, char *argv[], void **ih, char * /*errbuf */, int /* void TSRemapDeleteInstance(void *ih) { - LOG_DEBUG("no op"); + Config *const conf = static_cast(ih); + delete conf; } /** @@ -262,97 +590,34 @@ TSRemapDeleteInstance(void *ih) TSRemapStatus TSRemapDoRemap(void *ih, TSHttpTxn txnp, TSRemapRequestInfo * /* rri */) { - mt_check_request_header(txnp); + Config const *const conf = static_cast(ih); + check_request_header(txnp, conf, REMAP); return TSREMAP_NO_REMAP; } /** - * Transaction event handler. + * global plugin initialization */ -static int -transaction_handler(TSCont contp, TSEvent event, void *edata) -{ - TSHttpTxn txnp = static_cast(edata); - struct txndata *txn_data = static_cast(TSContDataGet(contp)); - - switch (event) { - case TS_EVENT_HTTP_CACHE_LOOKUP_COMPLETE: - LOG_DEBUG("transaction cache lookup complete."); - mt_cache_lookup_check(contp, txnp, txn_data); - break; - case TS_EVENT_HTTP_SEND_REQUEST_HDR: - LOG_DEBUG("updating send request headers."); - mt_send_server_request(txnp, txn_data); - break; - case TS_EVENT_HTTP_SEND_RESPONSE_HDR: - LOG_DEBUG("updating send response headers."); - mt_send_client_response(txnp, txn_data); - break; - case TS_EVENT_HTTP_TXN_CLOSE: - LOG_DEBUG("handling transaction close."); - freeTransactionData(txn_data); - TSContDestroy(contp); - break; - default: - TSAssert(!"Unexpected event"); - break; - } - TSHttpTxnReenable(txnp, TS_EVENT_HTTP_CONTINUE); - - return TS_SUCCESS; -} - -const char * -MT::moneyTraceHdr(const char *mt_request_hdr) +void +TSPluginInit(int argc, char const *argv[]) { - char copy[8192] = {'\0'}; - char *toks[3], *p = nullptr, *saveptr = nullptr; - std::ostringstream temp_str; - std::string mt_header_str; - int numtoks = 0; - - if (mt_request_hdr == nullptr) { - LOG_DEBUG("an empty header was passed in."); - return nullptr; - } else { - strncpy(copy, mt_request_hdr, 8191); - } + LOG_DEBUG("Starting global plugin init"); - // parse the money header. - p = strtok_r(copy, ";", &saveptr); - if (p != nullptr) { - toks[numtoks++] = p; - // copy the traceid - } else { - LOG_DEBUG("failed to parse the money_trace_header: %s", mt_request_hdr); - return nullptr; - } - do { - p = strtok_r(nullptr, ";", &saveptr); - if (p != nullptr) { - toks[numtoks++] = p; - } - } while (p != nullptr && numtoks < 3); + TSPluginRegistrationInfo info; + info.plugin_name = PLUGIN_NAME; + info.vendor_name = "Apache Software Foundation"; + info.support_email = "dev@trafficserver.apache.org"; - if (numtoks != 3 || toks[0] == nullptr || toks[1] == nullptr || toks[2] == nullptr) { - LOG_DEBUG("failed to parse the money_trace_header: %s", mt_request_hdr); - return nullptr; + if (TS_SUCCESS != TSPluginRegister(&info)) { + LOG_ERROR("Plugin registration failed"); + return; } - if (strncmp(toks[0], "trace-id", strlen("trace-id")) == 0 && strncmp(toks[2], "span-id", strlen("span-id")) == 0 && - (p = strchr(toks[2], '=')) != nullptr) { - p++; - if (strncmp("0x", p, 2) == 0) { - temp_str << toks[0] << ";parent-id=" << p << ";span-id=0x" << std::hex << spanId() << std::ends; - } else { - temp_str << toks[0] << ";parent-id=" << p << ";span-id=" << spanId() << std::ends; - } - } else { - LOG_DEBUG("invalid money_trace_header: %s", mt_request_hdr); - return nullptr; - } + Config const *const conf = config_from_args(argc, argv, GLOBAL); - mt_header_str = temp_str.str(); + TSCont const contp = TSContCreate(global_request_header_hook, nullptr); + TSContDataSet(contp, (void *)conf); - return TSstrndup(mt_header_str.c_str(), mt_header_str.length()); + // This fires before any remap hooks. + TSHttpHookAdd(TS_HTTP_READ_REQUEST_HDR_HOOK, contp); } diff --git a/plugins/experimental/money_trace/money_trace.h b/plugins/experimental/money_trace/money_trace.h index 88af66b6477..f98e7eb2549 100644 --- a/plugins/experimental/money_trace/money_trace.h +++ b/plugins/experimental/money_trace/money_trace.h @@ -19,8 +19,6 @@ #pragma once -#include -#include #include "ts/ts.h" #include "ts/remap.h" @@ -35,32 +33,3 @@ do { \ TSError("[%s:%d] %s(): " fmt, __FILE__, __LINE__, __func__, ##__VA_ARGS__); \ } while (0) - -#define MIME_FIELD_MONEY_TRACE "X-MoneyTrace" -#define MIME_LEN_MONEY_TRACE 12 - -struct MT { - std::minstd_rand0 generator; - - MT() { generator.seed(time(nullptr)); } - long - spanId() - { - long v = generator(); - return (v * v); - } - const char *moneyTraceHdr(const char *mt_request_hdr); -}; - -struct txndata { - char *client_request_mt_header; - char *new_span_mt_header; -}; - -static struct txndata *allocTransactionData(); -static void freeTransactionData(struct txndata *txn_data); -static void mt_cache_lookup_check(TSCont contp, TSHttpTxn txnp, struct txndata *txn_data); -static void mt_check_request_header(TSHttpTxn txnp); -static void mt_send_client_response(TSHttpTxn txnp, struct txndata *txn_data); -static void mt_send_server_request(TSHttpTxn txnp, struct txndata *txn_data); -static int transaction_handler(TSCont contp, TSEvent event, void *edata); diff --git a/plugins/experimental/parent_select/consistenthash.cc b/plugins/experimental/parent_select/consistenthash.cc index a32a55dc022..3eeac446113 100644 --- a/plugins/experimental/parent_select/consistenthash.cc +++ b/plugins/experimental/parent_select/consistenthash.cc @@ -549,9 +549,10 @@ PLNextHopConsistentHash::next(TSHttpTxn txnp, void *strategyTxn, const char *exc // ---------------------------------------------------------------------------------------------------- if (pRec && host_stat == TS_HOST_STATUS_UP && (pRec->available.load() || state->retry)) { - state->result = PL_NH_PARENT_SPECIFIED; - state->hostname = pRec->hostname.c_str(); - state->last_parent = pRec->host_index; + state->result = PL_NH_PARENT_SPECIFIED; + state->hostname = pRec->hostname.c_str(); + state->hostname_len = pRec->hostname.size(); + state->last_parent = pRec->host_index; state->last_lookup = state->last_group = cur_ring; switch (scheme) { case PL_NH_SCHEME_NONE: @@ -573,11 +574,12 @@ PLNextHopConsistentHash::next(TSHttpTxn txnp, void *strategyTxn, const char *exc PL_NH_Debug(PL_NH_DEBUG_TAG, "[%" PRIu64 "] state->result: %s Chosen parent: %s.%d", sm_id, PLNHParentResultStr[state->result], state->hostname, state->port); } else { - state->result = go_direct ? PL_NH_PARENT_DIRECT : PL_NH_PARENT_FAIL; - state->retry = false; - state->hostname = nullptr; - state->port = 0; - state->no_cache = false; + state->result = go_direct ? PL_NH_PARENT_DIRECT : PL_NH_PARENT_FAIL; + state->retry = false; + state->hostname = nullptr; + state->hostname_len = 0; + state->port = 0; + state->no_cache = false; PL_NH_Debug(PL_NH_DEBUG_TAG, "[%" PRIu64 "] state->result: %s set hostname null port 0 retry %d", sm_id, PLNHParentResultStr[state->result], state->retry); } diff --git a/plugins/experimental/parent_select/consistenthash_config.cc b/plugins/experimental/parent_select/consistenthash_config.cc index 2016b0438bd..825b1e15b59 100644 --- a/plugins/experimental/parent_select/consistenthash_config.cc +++ b/plugins/experimental/parent_select/consistenthash_config.cc @@ -20,6 +20,7 @@ #include "strategy.h" #include "consistenthash.h" #include "util.h" +#include "time.h" #include #include @@ -44,6 +45,19 @@ #include "consistenthash_config.h" +namespace +{ +std::mutex strategies_cache_mutex; +std::map strategies_cache; +} // namespace + +void +clearStrategiesCache(void) +{ + std::lock_guard guard(strategies_cache_mutex); + strategies_cache.clear(); +} + void loadConfigFile(const std::string &fileName, std::stringstream &doc, std::unordered_set &include_once); // createStrategy creates and initializes a Consistent Hash strategy from the given YAML node. @@ -69,7 +83,15 @@ createStrategiesFromFile(const char *file) { TSDebug(PLUGIN_NAME, "createStrategiesFromFile plugin createStrategiesFromFile file '%s'", file); - // return strategies_map(); // debug + { + std::lock_guard guard(strategies_cache_mutex); + auto it = strategies_cache.find(file); + if (it != strategies_cache.end()) { + TSDebug(PLUGIN_NAME, "createStrategiesFromFile file '%s' in cache from previous remap, using cache", file); + return it->second; + } + } + TSDebug(PLUGIN_NAME, "createStrategiesFromFile file '%s' not in cache, loading file", file); YAML::Node config; YAML::Node strategies; @@ -133,6 +155,12 @@ createStrategiesFromFile(const char *file) TSDebug(PLUGIN_NAME, "createStrategiesFromFile filename %s got strategy %s emplaced.", basename, name.c_str()); } TSDebug(PLUGIN_NAME, "createStrategiesFromFile filename %s returning strategies created.", basename); + + { + std::lock_guard guard(strategies_cache_mutex); + strategies_cache[file] = strategiesMap; + } + return strategiesMap; } catch (std::exception &ex) { TSError("[%s] creating strategies from file %s threw '%s'.", PLUGIN_NAME, file, ex.what()); diff --git a/plugins/experimental/parent_select/consistenthash_config.h b/plugins/experimental/parent_select/consistenthash_config.h index 3d26e83eb02..d8a3fc7d560 100644 --- a/plugins/experimental/parent_select/consistenthash_config.h +++ b/plugins/experimental/parent_select/consistenthash_config.h @@ -24,7 +24,8 @@ class TSNextHopSelectionStrategy; -typedef std::map, std::less<>> strategies_map; +typedef std::map, std::less<>> strategies_map; +void clearStrategiesCache(void); strategies_map createStrategiesFromFile(const char *file); TSNextHopSelectionStrategy *createStrategy(const std::string &name, const YAML::Node &node); diff --git a/plugins/experimental/parent_select/parent_select.cc b/plugins/experimental/parent_select/parent_select.cc index de07fac80c2..e3df98393f8 100644 --- a/plugins/experimental/parent_select/parent_select.cc +++ b/plugins/experimental/parent_select/parent_select.cc @@ -47,65 +47,9 @@ struct StrategyTxn { TSNextHopSelectionStrategy *strategy; void *txn; // void* because the actual type will depend on the strategy. int request_count; - const char *prev_host; // the actually tried host, used when send_request sets the response_action to be the next thing to try. - size_t prev_host_len; - in_port_t prev_port; - bool prev_is_retry; - bool prev_no_cache; + TSResponseAction prev_ra; }; -int -handle_send_request(TSHttpTxn txnp, StrategyTxn *strategyTxn) -{ - TSDebug(PLUGIN_NAME, "handle_send_request calling"); - TSDebug(PLUGIN_NAME, "handle_send_request got strategy '%s'", strategyTxn->strategy->name()); - - auto strategy = strategyTxn->strategy; - - // if (strategyTxn->retry_attempts == 0) { - // // just did a DoRemap, which means we need to set the response_action of what to do in the event of failure - // // because a failure might not call read_response (e.g. dns failure) - // strategyTxn->retry_attempts = 1; - // TSHttpTxnReenable(txnp, TS_EVENT_HTTP_CONTINUE); - // return TS_SUCCESS; - // } - - // before sending a req, we need to set what to do on failure. - // Because some failures don't call handle_response before getting to HttpTransact::HandleResponse - // (e.g. connection failures) - - TSResponseAction ra; - TSHttpTxnResponseActionGet(txnp, &ra); - - TSDebug(PLUGIN_NAME, "handle_send_request setting prev %.*s:%d", int(ra.hostname_len), ra.hostname, ra.port); - strategyTxn->prev_host = ra.hostname; - strategyTxn->prev_host_len = ra.hostname_len; - strategyTxn->prev_port = ra.port; - strategyTxn->prev_is_retry = ra.is_retry; - strategyTxn->prev_no_cache = ra.no_cache; - - strategy->next(txnp, strategyTxn->txn, ra.hostname, ra.hostname_len, ra.port, &ra.hostname, &ra.hostname_len, &ra.port, - &ra.is_retry, &ra.no_cache); - - ra.nextHopExists = strategy->nextHopExists(txnp); - ra.fail = !ra.nextHopExists; // failed is whether to fail and return to the client. failed=false means to retry the parent we set - // in the response_action - - // we don't know if it's retryable yet, because we don't have a status. So set it retryable if we have something which could be - // retried. We'll set it retryable per the status in handle_response, and os_dns (which is called on connection failures, and - // always retryable [notwithstanding num_retries]). - ra.responseIsRetryable = ra.nextHopExists; - ra.goDirect = strategy->goDirect(); - ra.parentIsProxy = strategy->parentIsProxy(); - - TSDebug(PLUGIN_NAME, "handle_send_request setting response_action hostname '%.*s' port %d direct %d proxy %d", - int(ra.hostname_len), ra.hostname, ra.port, ra.goDirect, ra.parentIsProxy); - TSHttpTxnResponseActionSet(txnp, &ra); - - TSHttpTxnReenable(txnp, TS_EVENT_HTTP_CONTINUE); - return TS_SUCCESS; -} - // mark parents up or down, on failure or successful retry. void mark_response(TSHttpTxn txnp, StrategyTxn *strategyTxn, TSHttpStatus status) @@ -118,17 +62,14 @@ mark_response(TSHttpTxn txnp, StrategyTxn *strategyTxn, TSHttpStatus status) TSResponseAction ra; // if the prev_host isn't null, then that was the actual host we tried which needs to be marked down. - if (strategyTxn->prev_host != nullptr) { - ra.hostname = strategyTxn->prev_host; - ra.hostname_len = strategyTxn->prev_host_len; - ra.port = strategyTxn->prev_port; - ra.is_retry = strategyTxn->prev_is_retry; - ra.no_cache = strategyTxn->prev_no_cache; + if (strategyTxn->prev_ra.hostname_len != 0) { + ra = strategyTxn->prev_ra; TSDebug(PLUGIN_NAME, "mark_response using prev %.*s:%d", int(ra.hostname_len), ra.hostname, ra.port); } else { TSHttpTxnResponseActionGet(txnp, &ra); TSDebug(PLUGIN_NAME, "mark_response using response_action %.*s:%d", int(ra.hostname_len), ra.hostname, ra.port); } + if (isFailure && strategy->onFailureMarkParentDown(status)) { if (ra.hostname == nullptr) { TSError( @@ -159,13 +100,6 @@ handle_read_response(TSHttpTxn txnp, StrategyTxn *strategyTxn) TSDebug(PLUGIN_NAME, "handle_read_response got strategy '%s'", strategy->name()); - // increment request count here, not send_request, because we need to consistently increase with os_dns hooks. - // if we incremented the req count in send_request and not here, that would never be called on DNS failures, but DNS successes - // would call os_dns and also send_request, resulting in dns failures incrementing the count by 1, and dns successes but http - // failures would increment by 2. And successes would increment by 2. Hence, the only consistent way to count requests is on - // read_response and os_dns, and not send_request. - ++strategyTxn->request_count; - TSMBuffer resp; TSMLoc resp_hdr; if (TS_SUCCESS != TSHttpTxnServerRespGet(txnp, &resp, &resp_hdr)) { @@ -193,18 +127,15 @@ handle_read_response(TSHttpTxn txnp, StrategyTxn *strategyTxn) // Status. TSResponseAction ra; TSHttpTxnResponseActionGet(txnp, &ra); - ra.responseIsRetryable = strategy->responseIsRetryable(strategyTxn->request_count, status); + ra.responseIsRetryable = strategy->responseIsRetryable(strategyTxn->request_count - 1, status); TSHttpTxnResponseActionSet(txnp, &ra); } // un-set the "prev" hackery. That only exists for markdown, which we just did. // The response_action is now the next thing to try, if this was a failure, // and should now be considered authoritative for everything. - strategyTxn->prev_host = nullptr; - strategyTxn->prev_host_len = 0; - strategyTxn->prev_port = 0; - strategyTxn->prev_is_retry = false; - strategyTxn->prev_no_cache = false; + + memset(&strategyTxn->prev_ra, 0, sizeof(TSResponseAction)); TSHandleMLocRelease(resp, TS_NULL_MLOC, resp_hdr); TSHttpTxnReenable(txnp, TS_EVENT_HTTP_CONTINUE); @@ -216,48 +147,37 @@ handle_os_dns(TSHttpTxn txnp, StrategyTxn *strategyTxn) { TSDebug(PLUGIN_NAME, "handle_os_dns calling"); - ++strategyTxn->request_count; // this is called after connection failures. So if we got here, we attempted a request - - // This is not called on the first attempt. - // Thus, if we got called here, we know it's because of a parent failure. - // So immediately find the next parent, and set the response_action. + ++strategyTxn->request_count; auto strategy = strategyTxn->strategy; TSDebug(PLUGIN_NAME, "handle_os_dns got strategy '%s'", strategy->name()); - mark_response(txnp, strategyTxn, STATUS_CONNECTION_FAILURE); - - // now, we need to figure out, are we the first call after send_response set the response_action as the next-thing-to-try, - // or are we a subsequent call, and need to actually set a new response_action - - if (strategyTxn->prev_host != nullptr) { - TSDebug(PLUGIN_NAME, "handle_os_dns had prev, keeping existing response_action and un-setting prev"); - // if strategyTxn->prev_host exists, this is the very first call after send_response set the response_action to the next thing - // to try. and no handle_response was called in-between (because it was a connection or dns failure) So keep that, and set - // prev_host=nullptr (so we get a new response_action the next time we're called) - strategyTxn->prev_host = nullptr; - strategyTxn->prev_port = 0; - strategyTxn->prev_is_retry = false; - strategyTxn->prev_no_cache = false; - TSHttpTxnReenable(txnp, TS_EVENT_HTTP_CONTINUE); - return TS_SUCCESS; + const TSServerState server_state = TSHttpTxnServerStateGet(txnp); + if (server_state == TS_SRVSTATE_CONNECTION_ERROR || server_state == TS_SRVSTATE_INACTIVE_TIMEOUT) { + mark_response(txnp, strategyTxn, STATUS_CONNECTION_FAILURE); } TSDebug(PLUGIN_NAME, "handle_os_dns had no prev, setting new response_action"); + { + TSResponseAction ra; + TSHttpTxnResponseActionGet(txnp, &ra); + strategyTxn->prev_ra = ra; + } + TSResponseAction ra; - memset(&ra, 0, sizeof(TSResponseAction)); // because {0} gives a C++ warning. Ugh. - const char *const exclude_host = nullptr; - const size_t exclude_host_len = 0; - const in_port_t exclude_port = 0; + memset(&ra, 0, sizeof(TSResponseAction)); + const char *const exclude_host = strategyTxn->prev_ra.hostname; + const size_t exclude_host_len = strategyTxn->prev_ra.hostname_len; + const in_port_t exclude_port = strategyTxn->prev_ra.port; strategy->next(txnp, strategyTxn->txn, exclude_host, exclude_host_len, exclude_port, &ra.hostname, &ra.hostname_len, &ra.port, &ra.is_retry, &ra.no_cache); ra.fail = ra.hostname == nullptr; // failed is whether to immediately fail and return the client a 502. In this case: whether or // not we found another parent. - ra.nextHopExists = strategy->nextHopExists(txnp); - ra.responseIsRetryable = strategy->responseIsRetryable(strategyTxn->request_count, STATUS_CONNECTION_FAILURE); + ra.nextHopExists = ra.hostname_len != 0; + ra.responseIsRetryable = strategy->responseIsRetryable(strategyTxn->request_count - 1, STATUS_CONNECTION_FAILURE); ra.goDirect = strategy->goDirect(); ra.parentIsProxy = strategy->parentIsProxy(); TSDebug(PLUGIN_NAME, "handle_os_dns setting response_action hostname '%.*s' port %d direct %d proxy %d is_retry %d exists %d", @@ -298,14 +218,8 @@ handle_hook(TSCont contp, TSEvent event, void *edata) TSDebug(PLUGIN_NAME, "handle_hook got strategy '%s'", strategyTxn->strategy->name()); switch (event) { - // case TS_EVENT_HTTP_READ_REQUEST_HDR: - // return handle_read_request(txnp, strategyTxn); - case TS_EVENT_HTTP_SEND_REQUEST_HDR: - return handle_send_request(txnp, strategyTxn); case TS_EVENT_HTTP_READ_RESPONSE_HDR: return handle_read_response(txnp, strategyTxn); - // case TS_EVENT_HTTP_SEND_RESPONSE_HDR: - // return handle_send_response(txnp, strategyTxn); case TS_EVENT_HTTP_OS_DNS: return handle_os_dns(txnp, strategyTxn); case TS_EVENT_HTTP_TXN_CLOSE: @@ -376,18 +290,8 @@ TSRemapNewInstance(int argc, char *argv[], void **ih, char *errbuff, int errbuff TSDebug(PLUGIN_NAME, "'%s' '%s' successfully created strategies in file %s num %d", remap_from, remap_to, config_file_path, int(file_strategies.size())); - std::unique_ptr new_strategy; - - for (auto &[name, strategy] : file_strategies) { - TSDebug(PLUGIN_NAME, "'%s' '%s' TSRemapNewInstance strategy file had strategy named '%s'", remap_from, remap_to, name.c_str()); - if (strncmp(strategy_name, name.c_str(), strlen(strategy_name)) != 0) { - continue; - } - TSDebug(PLUGIN_NAME, "'%s' '%s' TSRemapNewInstance using '%s'", remap_from, remap_to, name.c_str()); - new_strategy = std::move(strategy); - } - - if (new_strategy.get() == nullptr) { + auto new_strategy = file_strategies.find(strategy_name); + if (new_strategy == file_strategies.end()) { TSDebug(PLUGIN_NAME, "'%s' '%s' TSRemapNewInstance strategy '%s' not found in file '%s'", remap_from, remap_to, strategy_name, config_file_path); return TS_ERROR; @@ -395,7 +299,12 @@ TSRemapNewInstance(int argc, char *argv[], void **ih, char *errbuff, int errbuff TSDebug(PLUGIN_NAME, "'%s' '%s' TSRemapNewInstance successfully loaded strategy '%s' from '%s'.", remap_from, remap_to, strategy_name, config_file_path); - *ih = static_cast(new_strategy.release()); + + // created a raw pointer _to_ a shared_ptr, because ih needs a raw pointer. + // The raw pointer in ih will be deleted in TSRemapDeleteInstance, + // which will destruct the shared_ptr, + // destroying the strategy if this is the last remap rule using it. + *ih = static_cast(new std::shared_ptr(new_strategy->second)); // Associate our config file with remap.config to be able to initiate reloads TSMgmtString result; @@ -411,7 +320,8 @@ TSRemapDoRemap(void *ih, TSHttpTxn txnp, TSRemapRequestInfo *rri) { TSDebug(PLUGIN_NAME, "TSRemapDoRemap calling"); - auto strategy = static_cast(ih); + auto strategy_ptr = static_cast *>(ih); + auto strategy = strategy_ptr->get(); TSDebug(PLUGIN_NAME, "TSRemapDoRemap got strategy '%s'", strategy->name()); @@ -421,16 +331,10 @@ TSRemapDoRemap(void *ih, TSHttpTxn txnp, TSRemapRequestInfo *rri) strategyTxn->strategy = strategy; strategyTxn->txn = strategy->newTxn(); strategyTxn->request_count = 0; - strategyTxn->prev_host = nullptr; - strategyTxn->prev_port = 0; - strategyTxn->prev_is_retry = false; - strategyTxn->prev_no_cache = false; + memset(&strategyTxn->prev_ra, 0, sizeof(TSResponseAction)); TSContDataSet(cont, (void *)strategyTxn); - // TSHttpTxnHookAdd(txnp, TS_HTTP_READ_REQUEST_HDR_HOOK, cont); - TSHttpTxnHookAdd(txnp, TS_HTTP_SEND_REQUEST_HDR_HOOK, cont); TSHttpTxnHookAdd(txnp, TS_HTTP_READ_RESPONSE_HDR_HOOK, cont); - // TSHttpTxnHookAdd(txnp, TS_HTTP_SEND_RESPONSE_HDR_HOOK, cont); TSHttpTxnHookAdd(txnp, TS_HTTP_OS_DNS_HOOK, cont); TSHttpTxnHookAdd(txnp, TS_HTTP_TXN_CLOSE_HOOK, cont); @@ -468,6 +372,14 @@ extern "C" tsapi void TSRemapDeleteInstance(void *ih) { TSDebug(PLUGIN_NAME, "TSRemapDeleteInstance calling"); - auto strategy = static_cast(ih); - delete strategy; + auto strategy_ptr = static_cast *>(ih); + delete strategy_ptr; + TSDebug(PLUGIN_NAME, "TSRemapDeleteInstance deleted strategy pointer"); +} + +void +TSRemapPreConfigReload(void) +{ + TSDebug(PLUGIN_NAME, "TSRemapPreConfigReload clearing strategies cache"); + clearStrategiesCache(); } diff --git a/plugins/experimental/parent_select/strategy.cc b/plugins/experimental/parent_select/strategy.cc index 18009cadc02..ddefc67f3d1 100644 --- a/plugins/experimental/parent_select/strategy.cc +++ b/plugins/experimental/parent_select/strategy.cc @@ -287,8 +287,10 @@ PLNextHopSelectionStrategy::nextHopExists(TSHttpTxn txnp) for (auto &hh : host_groups[gg]) { PLHostRecord *p = hh.get(); if (p->available) { - PL_NH_Debug(PL_NH_DEBUG_TAG, "[%" PRIu64 "] found available next hop %.*s", sm_id, int(p->hostname.size()), - p->hostname.c_str()); + PL_NH_Debug(PL_NH_DEBUG_TAG, + "[%" PRIu64 "] found available next hop %.*s (this is NOT necessarily the parent which will be selected, just " + "the first available parent found)", + sm_id, int(p->hostname.size()), p->hostname.c_str()); return true; } } @@ -399,11 +401,19 @@ template <> struct convert { } else if (node["scheme"].Scalar() == "https") { nh.scheme = PL_NH_SCHEME_HTTPS; } else { - nh.scheme = PL_NH_SCHEME_NONE; + throw YAML::ParserException(node["scheme"].Mark(), "no valid scheme defined, valid schemes are http or https"); } + } else { + throw YAML::ParserException(node["scheme"].Mark(), "no scheme defined, valid schemes are http or https"); } if (node["port"]) { nh.port = node["port"].as(); + if (nh.port <= 0 || nh.port > 65535) { + throw YAML::ParserException(node["port"].Mark(), "port number must be in (inclusive) range 1 - 65,536"); + } + } else { + throw YAML::ParserException(node["port"].Mark(), + "no port is defined, a port number must be defined within (inclusive) range 1 - 65,536"); } if (node["health_check_url"]) { nh.health_check_url = node["health_check_url"].Scalar(); diff --git a/plugins/experimental/parent_select/strategy.h b/plugins/experimental/parent_select/strategy.h index d8dbcf15045..844e75a7a7f 100644 --- a/plugins/experimental/parent_select/strategy.h +++ b/plugins/experimental/parent_select/strategy.h @@ -36,7 +36,7 @@ // TODO rename, move to respective sub-plugins #define PLUGIN_NAME "pparent_select" -constexpr const char *PL_NH_DEBUG_TAG = "plugin_nexthop"; +constexpr const char *PL_NH_DEBUG_TAG = PLUGIN_NAME; // ring mode strings extern const std::string_view alternate_rings; @@ -245,24 +245,24 @@ class PLNextHopSelectionStrategy : public TSNextHopSelectionStrategy virtual ~PLNextHopSelectionStrategy(){}; bool Init(const YAML::Node &n); - virtual void next(TSHttpTxn txnp, void *strategyTxn, const char *exclude_hostname, size_t exclude_hostname_len, - in_port_t exclude_port, const char **out_hostname, size_t *out_hostname_len, in_port_t *out_port, - bool *out_retry, bool *out_no_cache, time_t now = 0) = 0; - virtual void mark(TSHttpTxn txnp, void *strategyTxn, const char *hostname, const size_t hostname_len, const in_port_t port, - const PLNHCmd status, const time_t now = 0) = 0; - virtual bool nextHopExists(TSHttpTxn txnp); - virtual bool codeIsFailure(TSHttpStatus response_code); - virtual bool responseIsRetryable(unsigned int current_retry_attempts, TSHttpStatus response_code); - virtual bool onFailureMarkParentDown(TSHttpStatus response_code); - virtual bool goDirect(); - virtual bool parentIsProxy(); - virtual const char * - name() + void next(TSHttpTxn txnp, void *strategyTxn, const char *exclude_hostname, size_t exclude_hostname_len, in_port_t exclude_port, + const char **out_hostname, size_t *out_hostname_len, in_port_t *out_port, bool *out_retry, bool *out_no_cache, + time_t now = 0) override = 0; + void mark(TSHttpTxn txnp, void *strategyTxn, const char *hostname, const size_t hostname_len, const in_port_t port, + const PLNHCmd status, const time_t now = 0) override = 0; + bool nextHopExists(TSHttpTxn txnp) override; + bool codeIsFailure(TSHttpStatus response_code) override; + bool responseIsRetryable(unsigned int current_retry_attempts, TSHttpStatus response_code) override; + bool onFailureMarkParentDown(TSHttpStatus response_code) override; + bool goDirect() override; + bool parentIsProxy() override; + const char * + name() override { return strategy_name.c_str(); }; - virtual void *newTxn() = 0; - virtual void deleteTxn(void *state) = 0; + void *newTxn() override = 0; + void deleteTxn(void *state) override = 0; protected: std::string strategy_name; diff --git a/plugins/experimental/rate_limit/Makefile.inc b/plugins/experimental/rate_limit/Makefile.inc index 72469de5c68..95ab01f43b8 100644 --- a/plugins/experimental/rate_limit/Makefile.inc +++ b/plugins/experimental/rate_limit/Makefile.inc @@ -21,4 +21,5 @@ experimental_rate_limit_rate_limit_la_SOURCES = \ experimental/rate_limit/txn_limiter.cc \ experimental/rate_limit/sni_limiter.cc \ experimental/rate_limit/sni_selector.cc \ + experimental/rate_limit/ip_reputation.cc \ experimental/rate_limit/utilities.cc diff --git a/plugins/experimental/rate_limit/ip_reputation.cc b/plugins/experimental/rate_limit/ip_reputation.cc new file mode 100644 index 00000000000..129cd9584a1 --- /dev/null +++ b/plugins/experimental/rate_limit/ip_reputation.cc @@ -0,0 +1,323 @@ +/** @file + + Implementation details for the IP reputation classes. + + @section license License + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "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 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + */ + +#include +#include + +#include "ip_reputation.h" + +namespace IpReputation +{ +// These static class members are here to calculate a uint64_t hash of an IP +uint64_t +SieveLru::hasher(const sockaddr *sock) +{ + switch (sock->sa_family) { + case AF_INET: { + const sockaddr_in *sa = reinterpret_cast(sock); + + return (0xffffffff00000000 | sa->sin_addr.s_addr); + } break; + case AF_INET6: { + const sockaddr_in6 *sa6 = reinterpret_cast(sock); + + return (*reinterpret_cast(sa6->sin6_addr.s6_addr) ^ + *reinterpret_cast(sa6->sin6_addr.s6_addr + sizeof(uint64_t))); + } break; + default: + // Clearly shouldn't happen ... + return 0; + break; + } +} + +uint64_t +SieveLru::hasher(const std::string &ip, u_short family) // Mostly a convenience function for testing +{ + switch (family) { + case AF_INET: { + sockaddr_in sa4; + + inet_pton(AF_INET, ip.c_str(), &(sa4.sin_addr)); + sa4.sin_family = AF_INET; + return hasher(reinterpret_cast(&sa4)); + } break; + case AF_INET6: { + sockaddr_in6 sa6; + + inet_pton(AF_INET6, ip.c_str(), &(sa6.sin6_addr)); + sa6.sin6_family = AF_INET6; + return hasher(reinterpret_cast(&sa6)); + } break; + default: + // Really shouldn't happen ... + return 0; + } +} +// Constructor, setting up the pre-sized LRU buckets etc. +SieveLru::SieveLru(uint32_t num_buckets, uint32_t size) : _lock(TSMutexCreate()) +{ + initialize(num_buckets, size); +} + +// Initialize the Sieve LRU object +void +SieveLru::initialize(uint32_t num_buckets, uint32_t size) +{ + TSMutexLock(_lock); + TSAssert(!_initialized); // Don't allow it to be initialized more than once! + TSReleaseAssert(size > num_buckets); // Otherwise we can't half the bucket sizes + + _initialized = true; + _num_buckets = num_buckets; + _size = size; + + uint32_t cur_size = pow(2, 1 + _size - num_buckets); + + _map.reserve(pow(2, size + 2)); // Allow for all the sieve LRUs, and extra room for the allow list + _buckets.reserve(_num_buckets + 2); // Two extra buckets, for the block list and allow list + + // Create the other buckets, in smaller and smaller sizes (power of 2) + for (uint32_t i = lastBucket(); i <= entryBucket(); ++i) { + _buckets[i] = new SieveBucket(cur_size); + cur_size *= 2; + } + + _buckets[blockBucket()] = new SieveBucket(cur_size / 2); // Block LRU, same size as entry bucket + _buckets[allowBucket()] = new SieveBucket(0); // Allow LRU, this is unlimited + TSMutexUnlock(_lock); +} + +// Increment the count for an element (will be created / added if new). +std::tuple +SieveLru::increment(KeyClass key) +{ + TSMutexLock(_lock); + TSAssert(_initialized); + + auto map_it = _map.find(key); + + if (_map.end() == map_it) { + // This is a new entry, this can only be added to the last LRU bucket + SieveBucket *lru = _buckets[entryBucket()]; + + if (lru->full()) { // The LRU is full, replace the last item with a new one + auto last = std::prev(lru->end()); + auto &[l_key, l_count, l_bucket, l_added] = *last; + + lru->moveTop(lru, last); + _map.erase(l_key); + *last = {key, 1, entryBucket(), SystemClock::now()}; + } else { + // Create a new entry, the date is not used now (unless perma blocked), but could be useful for aging out stale elements. + lru->push_front({key, 1, entryBucket(), SystemClock::now()}); + } + _map[key] = lru->begin(); + TSMutexUnlock(_lock); + + return {entryBucket(), 1}; + } else { + auto &[map_key, map_item] = *map_it; + auto &[list_key, count, bucket, added] = *map_item; + auto lru = _buckets[bucket]; + auto max_age = (bucket == blockBucket() ? _perma_max_age : _max_age); + + // Check if the entry is older than max_age (if set), if so just move it to the entry bucket and restart + // Yes, this will move likely abusive IPs but they will earn back a bad reputation; The goal here is to + // not let "spiked" entries sit in small buckets indefinitely. It also cleans up the code. We only check + // the actual system time every 10 request for an IP, if traffic is less frequent than that, the LRU will + // age it out properly. + if ((_max_age > std::chrono::seconds::zero()) && ((count % 10) == 0) && + (std::chrono::duration_cast(SystemClock::now() - added) > max_age)) { + auto last_lru = _buckets[entryBucket()]; + + count >>= 3; // Age the count by a factor of 1/8th + bucket = entryBucket(); + last_lru->moveTop(lru, map_item); + } else { + ++count; + + if (bucket > lastBucket()) { // Not in the smallest bucket, so we may promote + auto p_lru = _buckets[bucket - 1]; // Move to previous bucket + + if (!p_lru->full()) { + p_lru->moveTop(lru, map_item); + --bucket; + } else { + auto p_item = std::prev(p_lru->end()); + auto &[p_key, p_count, p_bucket, p_added] = *p_item; + + if (p_count <= count) { + // Swap places on the two elements, moving both to the top of their respective LRU buckets + p_lru->moveTop(lru, map_item); + lru->moveTop(p_lru, p_item); + --bucket; + ++p_bucket; + } + } + } else { + // Just move it to the top of the current LRU + lru->moveTop(lru, map_item); + } + } + TSMutexUnlock(_lock); + + return {bucket, count}; + } +} + +// Lookup the status of the IP in the current tables, without modifying anything +std::tuple +SieveLru::lookup(KeyClass key) const +{ + TSMutexLock(_lock); + TSAssert(_initialized); + + auto map_it = _map.find(key); + + if (_map.end() == map_it) { + TSMutexUnlock(_lock); + + return {0, entryBucket()}; // Nothing found, return 0 hits and the entry bucket # + } else { + auto &[map_key, map_item] = *map_it; + auto &[list_key, count, bucket, added] = *map_item; + + TSMutexUnlock(_lock); + + return {bucket, count}; + } +} + +// A little helper function, to properly move an IP to one of the two special buckets, +// allow-bucket and block-bucket. +int32_t +SieveLru::move_bucket(KeyClass key, uint32_t to_bucket) +{ + TSMutexLock(_lock); + TSAssert(_initialized); + + auto map_it = _map.find(key); + + if (_map.end() == map_it) { + // This is a new entry, add it directly to the special bucket + SieveBucket *lru = _buckets[to_bucket]; + + if (lru->full()) { // The LRU is full, replace the last item with a new one + auto last = std::prev(lru->end()); + auto &[l_key, l_count, l_bucket, l_added] = *last; + + lru->moveTop(lru, last); + _map.erase(l_key); + *last = {key, 1, to_bucket, SystemClock::now()}; + } else { + // Create a new entry + lru->push_front({key, 1, to_bucket, SystemClock::now()}); + } + _map[key] = lru->begin(); + } else { + auto &[map_key, map_item] = *map_it; + auto &[list_key, count, bucket, added] = *map_item; + auto lru = _buckets[bucket]; + + if (bucket != to_bucket) { // Make sure it's not already blocked + auto move_lru = _buckets[to_bucket]; + + // Free a space for a new entry, if needed + if (move_lru->size() >= move_lru->max_size()) { + auto d_entry = std::prev(move_lru->end()); + auto &[d_key, d_count, d_bucket, d_added] = *d_entry; + + move_lru->erase(d_entry); + _map.erase(d_key); + } + move_lru->moveTop(lru, map_item); // Move the LRU item to the perma-blocks + bucket = to_bucket; + added = SystemClock::now(); + } + } + TSMutexUnlock(_lock); + + return to_bucket; // Just as a convenience, return the destination bucket for this entry +} + +void +SieveLru::dump() +{ + TSMutexLock(_lock); + TSAssert(_initialized); + + for (uint32_t i = 0; i < _num_buckets + 1; ++i) { + long long cnt = 0, sum = 0; + auto lru = _buckets[i]; + + std::cout << std::endl + << "Dumping bucket " << i << " (size=" << lru->size() << ", max_size=" << lru->max_size() << ")" << std::endl; + for (auto &it : *lru) { + auto &[key, count, bucket, added] = it; + + ++cnt; + sum += count; +#if 0 + if (0 == i) { // Also dump the content of the top bucket + std::cout << "\t" << key << "; Count=" << count << ", Bucket=" << bucket << std::endl; + } +#endif + } + + std::cout << "\tAverage count=" << (cnt > 0 ? sum / cnt : 0) << std::endl; + } + TSMutexUnlock(_lock); +} + +// Debugging tools, these memory sizes are best guesses to how much memory the containers will actually use +size_t +SieveBucket::memorySize() const +{ + size_t total = sizeof(SieveBucket); + + total += size() * (2 * sizeof(void *) + sizeof(LruEntry)); // Double linked list + object + + return total; +} + +size_t +SieveLru::memoryUsed() const +{ + TSMutexLock(_lock); + TSAssert(_initialized); + + size_t total = sizeof(SieveLru); + + for (uint32_t i = 0; i <= _num_buckets + 1; ++i) { + total += _buckets[i]->memorySize(); + } + + total += _map.size() * (sizeof(void *) + sizeof(SieveBucket::iterator)); + total += _map.bucket_count() * (sizeof(size_t) + sizeof(void *)); + TSMutexUnlock(_lock); + + return total; +} + +} // namespace IpReputation diff --git a/plugins/experimental/rate_limit/ip_reputation.h b/plugins/experimental/rate_limit/ip_reputation.h new file mode 100644 index 00000000000..4abbbcaa088 --- /dev/null +++ b/plugins/experimental/rate_limit/ip_reputation.h @@ -0,0 +1,236 @@ +/** @file + + Include file for all the IP reputation classes. + + @section license License + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "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 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + */ +#pragma once + +#include +#include +#include +#include +#include +#include +#include +#include + +#include "ts/ts.h" + +namespace IpReputation +{ +using KeyClass = uint64_t; +using SystemClock = std::chrono::system_clock; + +// Key / Count / bucket # (rank, 0-) / time added +using LruEntry = std::tuple>; + +// This is a wrapper around a std::list which lets us size limit the list to a +// certain size. +class SieveBucket : public std::list +{ +public: + SieveBucket(uint32_t max_size) : _max_size(max_size) {} + + bool + full() const + { + return (_max_size > 0 ? (size() >= _max_size) : false); + } + + size_t + max_size() const + { + return _max_size; + } + + // Move an element to the top of an LRU. This *can* move it from the current LRU (bucket) + // to another, when promoted to a higher rank. + void + moveTop(SieveBucket *source_lru, SieveBucket::iterator &item) + { + splice(begin(), *source_lru, item); + } + + // Debugging tools + size_t memorySize() const; + +private: + uint32_t _max_size; +}; + +using HashMap = std::unordered_map; // The hash map for finding the entry + +// This is a concept / POC: Ranked LRU buckets +// +// Also, obviously the std::string here is not awesome, rather, we ought to save the +// hashed value from the IP as the key (just like the hashed in cache_promote). +class SieveLru +{ +public: + SieveLru() : _lock(TSMutexCreate()){}; // The unitialized version + SieveLru(uint32_t num_buckets, uint32_t size); + ~SieveLru() + { + for (uint32_t i = 0; i <= _num_buckets + 1; ++i) { // Remember to delete the two special allow/block buckets too + delete _buckets[i]; + } + } + + void initialize(uint32_t num_buckets = 10, uint32_t size = 15); + + // Return value is the bucket (0 .. num_buckets) that the IP is in, and the + // current count of "hits". The lookup version is similar, except it doesn't + // modify the status of the IP (read-only). + std::tuple increment(KeyClass key); + + std::tuple + increment(const sockaddr *sock) + { + return increment(hasher(sock)); + } + + // Move an IP to the perm-block or perma-allow LRUs. A zero (default) maxage is indefinite (no timeout). + uint32_t + block(KeyClass key) + { + return move_bucket(key, blockBucket()); + } + + uint32_t + allow(KeyClass key) + { + return move_bucket(key, allowBucket()); + } + + uint32_t + block(const sockaddr *sock) + { + return move_bucket(hasher(sock), blockBucket()); + } + + uint32_t + allow(const sockaddr *sock) + { + return move_bucket(hasher(sock), allowBucket()); + } + + // Lookup the current state of an IP + std::tuple lookup(KeyClass key) const; + + std::tuple + lookup(const sockaddr *sock) const + { + return lookup(hasher(sock)); + } + + // A helper function to hash an INET or INET6 sockaddr to a 64-bit hash. + static uint64_t hasher(const sockaddr *sock); + static uint64_t hasher(const std::string &ip, u_short family = AF_INET); + + // Identifying some of the special buckets: + // + // entryBucket == the highest bucket, where new IPs enter (also the biggest bucket) + // lastBucket == the last bucket, which is most likely to be abusive + // blockBucket == the bucket where we "permanently" block bad IPs + // allowBucket == the bucket where we "permanently" allow good IPs (can not be blocked) + uint32_t + entryBucket() const + { + return _num_buckets; + } + + constexpr uint32_t + lastBucket() const + { + return 1; + } + + constexpr uint32_t + blockBucket() const + { + return 0; + } + + uint32_t + allowBucket() const + { + return _num_buckets + 1; + } + + size_t + bucketSize(uint32_t bucket) const + { + if (bucket <= (_num_buckets + 1)) { + return _buckets[bucket]->size(); + } else { + return 0; + } + } + + bool + initialized() const + { + return _initialized; + } + + // Aging getters and setters + std::chrono::seconds + maxAge() const + { + return _max_age; + } + + std::chrono::seconds + permaMaxAge() const + { + return _perma_max_age; + } + + void + maxAge(std::chrono::seconds maxage) + { + _max_age = maxage; + } + + void + permaMaxAge(std::chrono::seconds maxage) + { + _perma_max_age = maxage; + } + + // Debugging tool, dumps some info around the buckets + void dump(); + size_t memoryUsed() const; + +protected: + int32_t move_bucket(KeyClass key, uint32_t to_bucket); + +private: + HashMap _map; + std::vector _buckets; + uint32_t _num_buckets = 10; // Leave this at 10 ... + uint32_t _size = 0; // Set this up to initialize + std::chrono::seconds _max_age = std::chrono::seconds::zero(); // Aging time in the SieveLru (default off) + std::chrono::seconds _perma_max_age = std::chrono::seconds::zero(); // Aging time in the SieveLru for perma-blocks + bool _initialized = false; // If this has been properly initialized yet + TSMutex _lock; // The lock around all data access +}; + +} // namespace IpReputation diff --git a/plugins/experimental/rate_limit/iprep_simu.cc b/plugins/experimental/rate_limit/iprep_simu.cc new file mode 100644 index 00000000000..887df68b861 --- /dev/null +++ b/plugins/experimental/rate_limit/iprep_simu.cc @@ -0,0 +1,299 @@ + +/** @file + + Simulator application, for testing the behavior of the SieveLRU. This does + not build as part of the system, but put here for future testing etc. + + @section license License + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "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 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + */ +#include + +#include +#include +#include +#include +#include +#include + +// Yeh well, sue me, boost is useful here, and this is not part of the actual core code +#include + +#include "ip_reputation.h" + +// Convenience class declarations +using IpMap = std::unordered_map>; // count / false = good, true = bad +using IpList = std::vector; + +// Holds all command line options +struct CmdConfigs { + uint32_t start_buckets, end_buckets, incr_buckets; + uint32_t start_size, end_size, incr_size; + uint32_t start_threshold, end_threshold, incr_threshold; + uint32_t start_permablock, end_permablock, incr_permablock; +}; + +/////////////////////////////////////////////////////////////////////////////// +// Command line options / parsing, returns the parsed and populate CmdConfig +// structure (from above). +// +std::tuple +splitArg(std::string str) +{ + int32_t start = 0, end = 0, incr = 1; + std::vector results; + + boost::split(results, str, [](char c) { return c == '-' || c == '/'; }); + + if (results.size() > 0) { + start = std::stoi(results[0]); + if (results.size() > 1) { + end = std::stoi(results[1]); + if (results.size() > 2) { + incr = std::stoi(results[2]); + } + } else { + end = start; + } + } else { + std::cerr << "Malformed argument: " << str << std::endl; + } + + return {start, end, incr}; +} + +CmdConfigs +parseArgs(int argc, char **argv) +{ + CmdConfigs options; + int c; + constexpr struct option long_options[] = { + {"help", no_argument, NULL, 'h'}, {"buckets", required_argument, NULL, 'b'}, {"perma", required_argument, NULL, 'p'}, + {"size", required_argument, NULL, 's'}, {"threshold", required_argument, NULL, 't'}, {NULL, 0, NULL, 0}}; + + // Make sure the optional values have been set + + options.start_permablock = 0; + options.end_permablock = 0; + options.incr_permablock = 1; + + while (1) { + int ix = 0; + + c = getopt_long(argc, argv, "b:f:p:s:t:h?", long_options, &ix); + if (c == -1) + break; + + switch (c) { + case 'h': + case '?': + std::cerr << "usage: iprep_simu -b|--buckets [-[/]]" << std::endl; + std::cerr << " -s|--size [-[/]]" << std::endl; + std::cerr << " -t|--threshold [-[/]]" << std::endl; + std::cerr << " [-p|--perma [-[/]]]" << std::endl; + std::cerr << " [-h|--help" << std::endl; + exit(0); + break; + case 'b': + std::tie(options.start_buckets, options.end_buckets, options.incr_buckets) = splitArg(optarg); + break; + case 's': + std::tie(options.start_size, options.end_size, options.incr_size) = splitArg(optarg); + break; + case 'p': + std::tie(options.start_permablock, options.end_permablock, options.incr_permablock) = splitArg(optarg); + break; + case 't': + std::tie(options.start_threshold, options.end_threshold, options.incr_threshold) = splitArg(optarg); + break; + default: + fprintf(stderr, "getopt returned weird stuff: 0%o\n", c); + exit(-1); + break; + } + } + + return options; // RVO +} + +/////////////////////////////////////////////////////////////////////////////// +// Load a configuration file, and populate the two structures with the +// list of IPs (and their status) as well as the full sequence of requests. +// +// Returns a tuple with the number of good requests and bad requests, respectively. +// +std::tuple +loadFile(std::string fname, IpMap &all_ips, IpList &ips) +{ + std::ifstream infile(fname); + + float timestamp; // The timestamp from the request(relative) + std::string ip; // The IP + bool status; // Bad (false) or Good (true) request? + + uint32_t good_ips = 0; + uint32_t bad_ips = 0; + uint32_t good_requests = 0; + uint32_t bad_requests = 0; + + // Load in the entire file, and fill the request vector as well as the IP lookup table (state) + while (infile >> timestamp >> ip >> status) { + auto ip_hash = IpReputation::SieveLru::hasher(ip, ip.find(':') != std::string::npos ? AF_INET6 : AF_INET); + auto it = all_ips.find(ip_hash); + + if (!status) { + ++good_requests; + } else { + ++bad_requests; + } + + if (all_ips.end() != it) { + auto &[key, data] = *it; + auto &[count, d_status] = data; + + ++count; + ips.push_back(it); + } else { + all_ips[ip_hash] = {0, status}; + ips.push_back(all_ips.find(ip_hash)); + if (!status) { + ++good_ips; + } else { + ++bad_ips; + } + } + } + + std::cout << std::setprecision(3); + std::cout << "Total number of requests: " << ips.size() << std::endl; + std::cout << "\tGood requests: " << good_requests << " (" << 100.0 * good_requests / ips.size() << "%)" << std::endl; + std::cout << "\tBad requests: " << bad_requests << " (" << 100.0 * bad_requests / ips.size() << "%)" << std::endl; + std::cout << "Unique IPs in set: " << all_ips.size() << std::endl; + std::cout << "\tGood IPs: " << good_ips << " (" << 100.0 * good_ips / all_ips.size() << "%)" << std::endl; + std::cout << "\tBad IPs: " << bad_ips << " (" << 100.0 * bad_ips / all_ips.size() << "%)" << std::endl; + std::cout << std::endl; + + return {good_requests, bad_requests}; +} + +int +main(int argc, char *argv[]) +{ + auto options = parseArgs(argc, argv); + + // All remaining arguments should be files, so lets process them one by one + for (int file_num = optind; file_num < argc; ++file_num) { + IpMap all_ips; + IpList ips; + + // Load the data from file + auto [good_requests, bad_requests] = loadFile(argv[file_num], all_ips, ips); + + // Here starts the actual simulation, loop through variations + for (uint32_t size = options.start_size; size <= options.end_size; size += options.incr_size) { + for (uint32_t buckets = options.start_buckets; buckets <= options.end_buckets; buckets += options.incr_buckets) { + for (uint32_t threshold = options.start_threshold; threshold <= options.end_threshold; + threshold += options.incr_threshold) { + for (uint32_t permablock = options.start_permablock; permablock <= options.end_permablock; + permablock += options.incr_permablock) { + // Setup the buckets and metrics for this loop + IpReputation::SieveLru ipt(buckets, size); + + auto start = std::chrono::system_clock::now(); + + // Some metrics + uint32_t good_blocked = 0; + uint32_t good_allowed = 0; + uint32_t bad_blocked = 0; + uint32_t bad_allowed = 0; + uint32_t good_perm_blocked = 0; + uint32_t bad_perm_blocked = 0; + + for (auto iter : ips) { + auto &[ip, data] = *iter; + auto &[count, status] = data; + auto [bucket, cur_cnt] = ipt.increment(ip); + + // Currently we only allow perma-blocking on items in bucket 1, so check for that first. + if (cur_cnt > permablock && bucket == ipt.lastBucket()) { + bucket = ipt.block(ip); + } + + if (bucket == ipt.blockBucket()) { + if (!status) { + ++good_perm_blocked; + } else { + ++bad_perm_blocked; + } + } else if (bucket <= threshold) { + if (!status) { + ++good_blocked; + } else { + ++bad_blocked; + } + } else { + if (!status) { + ++good_allowed; + } else { + ++bad_allowed; + } + } + } + + auto end = std::chrono::system_clock::now(); + + uint32_t total_blocked = bad_blocked + good_blocked; + uint32_t total_perm_blocked = bad_perm_blocked + good_perm_blocked; + uint32_t total_allowed = bad_allowed + good_allowed; + + // ipt.dump(); + + std::chrono::duration elapsed_seconds = end - start; + + std::cout << "Running with size=" << size << ", buckets=" << buckets << ", threshold=" << threshold + << ", permablock=" << permablock << std::endl; + std::cout << "Processing time: " << elapsed_seconds.count() << std::endl; + std::cout << "Denied requests: " << total_blocked + total_perm_blocked << std::endl; + std::cout << "\tGood requests denied: " << good_blocked + good_perm_blocked << " (" + << 100.0 * (good_blocked + good_perm_blocked) / good_requests << "%)" << std::endl; + std::cout << "\tBad requests denied: " << bad_blocked + bad_perm_blocked << " (" + << 100.0 * (bad_blocked + bad_perm_blocked) / bad_requests << "%)" << std::endl; + std::cout << "Allowed requests: " << total_allowed << std::endl; + std::cout << "\tGood requests allowed: " << good_allowed << " (" << 100.0 * good_allowed / good_requests << "%)" + << std::endl; + std::cout << "\tBad requests allowed: " << bad_allowed << " (" << 100.0 * bad_allowed / bad_requests << "%)" + << std::endl; + if (permablock) { + std::cout << "Permanently blocked IPs: " << ipt.bucketSize(ipt.blockBucket()) << std::endl; + std::cout << "\tGood requests permanently denied: " << good_perm_blocked << " (" + << 100.0 * good_perm_blocked / good_requests << "%)" << std::endl; + std::cout << "\tBad requests permanently denied: " << bad_perm_blocked << " (" + << 100.0 * bad_perm_blocked / bad_requests << "%)" << std::endl; + } + std::cout << "Estimated score (lower is better): " + << 100.0 * ((100.0 * good_blocked / good_requests + 100.0 * bad_allowed / bad_requests) / + (100.0 * good_allowed / good_requests + 100.0 * bad_blocked / bad_requests)) + << std::endl; + std::cout << "Memory used for IP Reputation data: " << ipt.memoryUsed() / (1024.0 * 1024.0) << "MB" << std::endl + << std::endl; + } + } + } + } + } +} diff --git a/plugins/experimental/rate_limit/sni_limiter.cc b/plugins/experimental/rate_limit/sni_limiter.cc index b63c50b1df9..fcc8fb838f4 100644 --- a/plugins/experimental/rate_limit/sni_limiter.cc +++ b/plugins/experimental/rate_limit/sni_limiter.cc @@ -43,18 +43,58 @@ sni_limit_cont(TSCont contp, TSEvent event, void *edata) int len; const char *server_name = TSVConnSslSniGet(vc, &len); std::string_view sni_name(server_name, len); + SniRateLimiter *limiter = selector->find(sni_name); - if (!sni_name.empty()) { // This should likely always succeed, but without it we can't do anything - SniRateLimiter *limiter = selector->find(sni_name); + if (limiter) { + // Check if we have an IP reputation for this SNI, and if we should block + if (limiter->iprep.initialized()) { + const sockaddr *sock = TSNetVConnRemoteAddrGet(vc); + int pressure = limiter->pressure(); + + TSDebug(PLUGIN_NAME, "CLIENT_HELLO on %.*s, pressure=%d", static_cast(sni_name.length()), sni_name.data(), pressure); + + // TSDebug(PLUGIN_NAME, "IP Reputation: pressure is currently %d", pressure); + + if (pressure >= 0) { // When pressure is < 0, we're not yet at a level of pressure to be concerned about + char client_ip[INET6_ADDRSTRLEN] = "[unknown]"; + auto [bucket, cur_cnt] = limiter->iprep.increment(sock); + + // Get the client IP string if debug is enabled + if (TSIsDebugTagSet(PLUGIN_NAME)) { + if (sock->sa_family == AF_INET) { + inet_ntop(AF_INET, &(((struct sockaddr_in *)sock)->sin_addr), client_ip, INET_ADDRSTRLEN); + } else if (sock->sa_family == AF_INET6) { + inet_ntop(AF_INET6, &(((struct sockaddr_in6 *)sock)->sin6_addr), client_ip, INET6_ADDRSTRLEN); + } + } + + if (cur_cnt > limiter->iprep_permablock_count && + bucket <= limiter->iprep_permablock_threshold) { // Mark for long-term blocking + TSDebug(PLUGIN_NAME, "Marking IP=%s for perma-blocking", client_ip); + bucket = limiter->iprep.block(sock); + } + + if (static_cast(pressure) > bucket) { // Remember the perma-block bucket is always 0, and we are >=0 already + // Block this IP from finishing the handshake + TSDebug(PLUGIN_NAME, "Rejecting connection from IP=%s, we're at pressure and IP was chosen to be blocked", client_ip); + TSUserArgSet(vc, gVCIdx, nullptr); + TSVConnReenableEx(vc, TS_EVENT_ERROR); + + return TS_ERROR; + } + } + } else { + TSDebug(PLUGIN_NAME, "CLIENT_HELLO on %.*s, no IP reputation", static_cast(sni_name.length()), sni_name.data()); + } - TSDebug(PLUGIN_NAME, "CLIENT_HELLO on %.*s", static_cast(sni_name.length()), sni_name.data()); - if (limiter && !limiter->reserve()) { + // If we passed the IP reputation filter, continue rate limiting these connections + if (!limiter->reserve()) { if (!limiter->max_queue || limiter->full()) { // We are running at limit, and the queue has reached max capacity, give back an error and be done. - TSVConnReenableEx(vc, TS_EVENT_ERROR); TSDebug(PLUGIN_NAME, "Rejecting connection, we're at capacity and queue is full"); TSUserArgSet(vc, gVCIdx, nullptr); limiter->incrementMetric(RATE_LIMITER_METRIC_REJECTED); + TSVConnReenableEx(vc, TS_EVENT_ERROR); return TS_ERROR; } else { @@ -69,11 +109,11 @@ sni_limit_cont(TSCont contp, TSEvent event, void *edata) TSVConnReenable(vc); } } else { + // No limiter for this SNI at all, clear the args etc. just in case + TSUserArgSet(vc, gVCIdx, nullptr); TSVConnReenable(vc); } - - break; - } + } break; case TS_EVENT_VCONN_CLOSE: { SniRateLimiter *limiter = static_cast(TSUserArgGet(vc, gVCIdx)); @@ -107,10 +147,19 @@ SniRateLimiter::initialize(int argc, const char *argv[]) {const_cast("maxage"), required_argument, nullptr, 'm'}, {const_cast("prefix"), required_argument, nullptr, 'p'}, {const_cast("tag"), required_argument, nullptr, 't'}, + // These are all for the IP reputation system. ToDo: These should be global rather than per SNI ? + {const_cast("iprep_maxage"), required_argument, nullptr, 'a'}, + {const_cast("iprep_buckets"), required_argument, nullptr, 'B'}, + {const_cast("iprep_bucketsize"), required_argument, nullptr, 'S'}, + {const_cast("iprep_permablock_limit"), required_argument, nullptr, 'L'}, + {const_cast("iprep_permablock_pressure"), required_argument, nullptr, 'P'}, + {const_cast("iprep_permablock_maxage"), required_argument, nullptr, 'A'}, // EOF {nullptr, no_argument, nullptr, '\0'}, }; + TSDebug(PLUGIN_NAME, "Initializing an SNI Rate Limiter"); + while (true) { int opt = getopt_long(argc, const_cast(argv), "", longopt, nullptr); @@ -130,11 +179,50 @@ SniRateLimiter::initialize(int argc, const char *argv[]) case 't': this->tag = std::string(optarg); break; + case 'a': + this->_iprep_max_age = std::chrono::seconds(strtol(optarg, nullptr, 10)); + break; + case 'B': + this->_iprep_num_buckets = strtol(optarg, nullptr, 10); + if (this->_iprep_num_buckets >= 100) { + TSError("sni_limiter: iprep_num_buckets must be in the range 1 .. 99, IP reputation disabled"); + this->_iprep_num_buckets = 0; + } + break; + case 'S': + this->_iprep_size = strtol(optarg, nullptr, 10); + break; + case 'L': + this->iprep_permablock_count = strtol(optarg, nullptr, 10); + break; + case 'P': + this->iprep_permablock_threshold = strtol(optarg, nullptr, 10); + break; + case 'A': + this->_iprep_perma_max_age = std::chrono::seconds(strtol(optarg, nullptr, 10)); + break; } if (opt == -1) { break; } } + // Enable and initialize the IP reputation if asked for + if (this->_iprep_num_buckets > 0 && this->_iprep_size > 0) { + TSDebug(PLUGIN_NAME, "Calling and _initialized is %d\n", this->iprep.initialized()); + this->iprep.initialize(this->_iprep_num_buckets, this->_iprep_size); + TSDebug(PLUGIN_NAME, "IP-reputation enabled with %u buckets, max size is 2^%u", this->_iprep_num_buckets, this->_iprep_size); + + TSDebug(PLUGIN_NAME, "Called and _initialized is %d\n", this->iprep.initialized()); + + // These settings are optional + if (this->_iprep_max_age != std::chrono::seconds::zero()) { + this->iprep.maxAge(this->_iprep_max_age); + } + if (this->_iprep_perma_max_age != std::chrono::seconds::zero()) { + this->iprep.permaMaxAge(this->_iprep_perma_max_age); + } + } + return true; } diff --git a/plugins/experimental/rate_limit/sni_limiter.h b/plugins/experimental/rate_limit/sni_limiter.h index 3889a0819f4..93b1b5558d0 100644 --- a/plugins/experimental/rate_limit/sni_limiter.h +++ b/plugins/experimental/rate_limit/sni_limiter.h @@ -18,6 +18,7 @@ #pragma once #include "limiter.h" +#include "ip_reputation.h" #include "ts/ts.h" int sni_limit_cont(TSCont contp, TSEvent event, void *edata); @@ -40,4 +41,25 @@ class SniRateLimiter : public RateLimiter } bool initialize(int argc, const char *argv[]); + + // ToDo: this ought to go into some better global IP reputation pool / settings. Waiting for YAML... + IpReputation::SieveLru iprep; + uint32_t iprep_permablock_count = 0; // "Hits" limit for blocking permanently + uint32_t iprep_permablock_threshold = 0; // Pressure threshold for permanent block + + // Calculate the pressure, which is either a negative number (ignore), or a number 0-. + // 0 == block only perma-blocks. + int32_t + pressure() const + { + return ((active() - 1) / static_cast(limit) * 100) - (99 - _iprep_num_buckets); + } + +private: + // ToDo: These should be moved to global configurations to have one shared IP Reputation. + // today the configuration of this is so klunky, that there is no easy way to make it "global". + std::chrono::seconds _iprep_max_age = std::chrono::seconds::zero(); // Max age in the SieveLRUs for regular buckets + std::chrono::seconds _iprep_perma_max_age = std::chrono::seconds::zero(); // Max age in the SieveLRUs for perma-block buckets + uint32_t _iprep_num_buckets = 10; // Number of buckets. ToDo: leave this at 10 always + uint32_t _iprep_size = 15; // Size of the biggest bucket; 15 == 2^15 == 32768 }; diff --git a/plugins/experimental/rate_limit/sni_selector.cc b/plugins/experimental/rate_limit/sni_selector.cc index d41b4df0690..e4c22d02d9d 100644 --- a/plugins/experimental/rate_limit/sni_selector.cc +++ b/plugins/experimental/rate_limit/sni_selector.cc @@ -86,6 +86,10 @@ SniSelector::insert(std::string_view sni, SniRateLimiter *limiter) SniRateLimiter * SniSelector::find(std::string_view sni) { + if (sni.empty()) { // Likely shouldn't happen, but we can shortcircuit + return nullptr; + } + auto limiter = _limiters.find(sni); if (limiter != _limiters.end()) { @@ -105,17 +109,18 @@ SniSelector::factory(const char *sni_list, int argc, const char *argv[]) char *saveptr; char *sni = strdup(sni_list); // We make a copy of the sni list, to not touch the original string char *token = strtok_r(sni, ",", &saveptr); - SniRateLimiter def_limiter; - - def_limiter.initialize(argc, argv); // Creates the template limiter - _needs_queue_cont = (def_limiter.max_queue > 0); + // Todo: We are repeating initializing here with the same configurations, but once we move this to + // YAML, and refactor this, it'll be better. And this is not particularly expensive. while (nullptr != token) { - SniRateLimiter *limiter = new SniRateLimiter(def_limiter); // Make a shallow copy + SniRateLimiter *limiter = new SniRateLimiter(); TSReleaseAssert(limiter); + limiter->initialize(argc, argv); limiter->description = token; + _needs_queue_cont = (limiter->max_queue > 0); + insert(std::string_view(limiter->description), limiter); token = strtok_r(nullptr, ",", &saveptr); } diff --git a/plugins/experimental/slice/Config.cc b/plugins/experimental/slice/Config.cc index 2cce89c1e16..5cd71d47339 100644 --- a/plugins/experimental/slice/Config.cc +++ b/plugins/experimental/slice/Config.cc @@ -26,6 +26,12 @@ #include "ts/experimental.h" +namespace +{ +constexpr std::string_view DefaultSliceSkipHeader = {"X-Slicer-Info"}; +constexpr std::string_view DefaultCrrImsHeader = {"X-Crr-Ims"}; +} // namespace + Config::~Config() { if (nullptr != m_regex_extra) { @@ -108,20 +114,23 @@ Config::fromArgs(int const argc, char const *const argv[]) // standard parsing constexpr struct option longopts[] = { {const_cast("blockbytes"), required_argument, nullptr, 'b'}, + {const_cast("crr-ims-header"), required_argument, nullptr, 'c'}, {const_cast("disable-errorlog"), no_argument, nullptr, 'd'}, {const_cast("exclude-regex"), required_argument, nullptr, 'e'}, {const_cast("include-regex"), required_argument, nullptr, 'i'}, {const_cast("ref-relative"), no_argument, nullptr, 'l'}, {const_cast("pace-errorlog"), required_argument, nullptr, 'p'}, {const_cast("remap-host"), required_argument, nullptr, 'r'}, + {const_cast("skip-header"), required_argument, nullptr, 's'}, {const_cast("blockbytes-test"), required_argument, nullptr, 't'}, + {const_cast("prefetch-count"), required_argument, nullptr, 'f'}, {nullptr, 0, nullptr, 0}, }; // getopt assumes args start at '1' so this hack is needed char *const *argvp = (const_cast(argv) - 1); for (;;) { - int const opt = getopt_long(argc + 1, argvp, "b:de:i:lp:r:t:", longopts, nullptr); + int const opt = getopt_long(argc + 1, argvp, "b:dc:e:i:lp:r:s:t:", longopts, nullptr); if (-1 == opt) { break; } @@ -138,6 +147,10 @@ Config::fromArgs(int const argc, char const *const argv[]) ERROR_LOG("Invalid blockbytes: %s", optarg); } } break; + case 'c': { + m_crr_ims_header.assign(optarg); + DEBUG_LOG("Using override crr ims header %s", optarg); + } break; case 'd': { m_paceerrsecs = -1; } break; @@ -193,6 +206,10 @@ Config::fromArgs(int const argc, char const *const argv[]) m_remaphost = optarg; DEBUG_LOG("Using loopback remap host override: %s", m_remaphost.c_str()); } break; + case 's': { + m_skip_header.assign(optarg); + DEBUG_LOG("Using slice skip header %s", optarg); + } break; case 't': { if (0 == blockbytes) { int64_t const bytesread = bytesFrom(optarg); @@ -206,6 +223,9 @@ Config::fromArgs(int const argc, char const *const argv[]) DEBUG_LOG("Skipping blockbytes-test in favor of blockbytes"); } } break; + case 'f': { + m_prefetchcount = atoi(optarg); + } break; default: break; } @@ -225,6 +245,14 @@ Config::fromArgs(int const argc, char const *const argv[]) } else { DEBUG_LOG("Block stitching error logs at most every %d sec(s)", m_paceerrsecs); } + if (m_crr_ims_header.empty()) { + m_crr_ims_header = DefaultCrrImsHeader; + DEBUG_LOG("Using default crr ims header %s", m_crr_ims_header.c_str()); + } + if (m_skip_header.empty()) { + m_skip_header = DefaultSliceSkipHeader; + DEBUG_LOG("Using default slice skip header %s", m_skip_header.c_str()); + } return true; } diff --git a/plugins/experimental/slice/Config.h b/plugins/experimental/slice/Config.h index 033ac7da671..8408ffc2076 100644 --- a/plugins/experimental/slice/Config.h +++ b/plugins/experimental/slice/Config.h @@ -41,10 +41,14 @@ struct Config { RegexType m_regex_type{None}; pcre *m_regex{nullptr}; pcre_extra *m_regex_extra{nullptr}; - int m_paceerrsecs{0}; // -1 disable logging, 0 no pacing, max 60s + int m_paceerrsecs{0}; // -1 disable logging, 0 no pacing, max 60s + int m_prefetchcount{0}; // 0 disables prefetching enum RefType { First, Relative }; RefType m_reftype{First}; // reference slice is relative to request + std::string m_skip_header; + std::string m_crr_ims_header; + // Convert optarg to bytes static int64_t bytesFrom(char const *const valstr); diff --git a/plugins/experimental/slice/Data.h b/plugins/experimental/slice/Data.h index 496ebdc3964..9cfbb2f7ead 100644 --- a/plugins/experimental/slice/Data.h +++ b/plugins/experimental/slice/Data.h @@ -25,6 +25,7 @@ #include "Stage.h" #include +#include struct Config; @@ -92,6 +93,8 @@ struct Data { Stage m_upstream; Stage m_dnstream; + std::unordered_map m_fetchstates; + HdrMgr m_req_hdrmgr; // manager for server request HdrMgr m_resp_hdrmgr; // manager for client response diff --git a/plugins/experimental/slice/HttpHeader.h b/plugins/experimental/slice/HttpHeader.h index e22b83d4bf6..15a1b158ef1 100644 --- a/plugins/experimental/slice/HttpHeader.h +++ b/plugins/experimental/slice/HttpHeader.h @@ -36,8 +36,6 @@ #include -static char const *const SLICER_MIME_FIELD_INFO = "X-Slicer-Info"; - /** Designed to be a cheap throwaway struct which allows a consumer to make various calls to manipulate headers. diff --git a/plugins/experimental/slice/Makefile.inc b/plugins/experimental/slice/Makefile.inc index be376ca1c64..f02631e204d 100644 --- a/plugins/experimental/slice/Makefile.inc +++ b/plugins/experimental/slice/Makefile.inc @@ -28,6 +28,8 @@ experimental_slice_slice_la_SOURCES = \ experimental/slice/HttpHeader.h \ experimental/slice/intercept.cc \ experimental/slice/intercept.h \ + experimental/slice/prefetch.cc \ + experimental/slice/prefetch.h \ experimental/slice/Range.cc \ experimental/slice/Range.h \ experimental/slice/response.cc \ diff --git a/plugins/experimental/slice/client.cc b/plugins/experimental/slice/client.cc index c1a9b59ef94..3d19372440a 100644 --- a/plugins/experimental/slice/client.cc +++ b/plugins/experimental/slice/client.cc @@ -57,12 +57,13 @@ handle_client_req(TSCont contp, TSEvent event, Data *const data) Range rangebe; char rangestr[1024]; - int rangelen = sizeof(rangestr); - bool const hasRange = header.valueForKey(TS_MIME_FIELD_RANGE, TS_MIME_LEN_RANGE, rangestr, &rangelen, + int rangelen = sizeof(rangestr); + bool const hasRange = header.valueForKey(TS_MIME_FIELD_RANGE, TS_MIME_LEN_RANGE, rangestr, &rangelen, 0); // <-- first range only + Config const *const conf = data->m_config; if (hasRange) { // write parsed header into slicer meta tag - header.setKeyVal(SLICER_MIME_FIELD_INFO, strlen(SLICER_MIME_FIELD_INFO), rangestr, rangelen); + header.setKeyVal(conf->m_skip_header.c_str(), conf->m_skip_header.size(), rangestr, rangelen); bool const isRangeGood = rangebe.fromStringClosed(rangestr); if (isRangeGood) { @@ -74,21 +75,21 @@ handle_client_req(TSCont contp, TSEvent event, Data *const data) data->m_statustype = TS_HTTP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE; // First block will give Content-Length - rangebe = Range(0, data->m_config->m_blockbytes); + rangebe = Range(0, conf->m_blockbytes); } } else { DEBUG_LOG("%p Full content request", data); static char const *const valstr = "-"; static size_t const vallen = strlen(valstr); - header.setKeyVal(SLICER_MIME_FIELD_INFO, strlen(SLICER_MIME_FIELD_INFO), valstr, vallen); + header.setKeyVal(conf->m_skip_header.data(), conf->m_skip_header.size(), valstr, vallen); data->m_statustype = TS_HTTP_STATUS_OK; rangebe = Range(0, Range::maxval); } - if (Config::RefType::First == data->m_config->m_reftype) { + if (Config::RefType::First == conf->m_reftype) { data->m_blocknum = 0; } else { - data->m_blocknum = rangebe.firstBlockFor(data->m_config->m_blockbytes); + data->m_blocknum = rangebe.firstBlockFor(conf->m_blockbytes); } data->m_req_range = rangebe; diff --git a/plugins/experimental/slice/prefetch.cc b/plugins/experimental/slice/prefetch.cc new file mode 100644 index 00000000000..2325db77f4b --- /dev/null +++ b/plugins/experimental/slice/prefetch.cc @@ -0,0 +1,134 @@ +/* + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "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 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +*/ + +/** + * @file prefetch.cpp + * @brief Background fetch related classes (header file). + */ + +#include "ts/ts.h" /* ATS API */ +#include "prefetch.h" + +bool +BgBlockFetch::schedule(Data *const data, int blocknum) +{ + bool ret = false; + BgBlockFetch *bg = new BgBlockFetch(blocknum); + if (bg->fetch(data)) { + ret = true; + } else { + delete bg; + } + return ret; +} + +/** + * Initialize and schedule the background fetch + */ +bool +BgBlockFetch::fetch(Data *const data) +{ + if (_bg_stream.m_read.isOpen()) { + // should never happen since the connection was just initialized + ERROR_LOG("Background block request already in flight!"); + return false; + } + + int64_t const blockbeg = (data->m_config->m_blockbytes * _blocknum); + Range blockbe(blockbeg, blockbeg + data->m_config->m_blockbytes); + + char rangestr[1024]; + int rangelen = sizeof(rangestr); + bool const rpstat = blockbe.toStringClosed(rangestr, &rangelen); + TSAssert(rpstat); + + DEBUG_LOG("Request background block: %s", rangestr); + + // reuse the incoming client header, just change the range + HttpHeader header(data->m_req_hdrmgr.m_buffer, data->m_req_hdrmgr.m_lochdr); + + // add/set sub range key and add slicer tag + bool const rangestat = header.setKeyVal(TS_MIME_FIELD_RANGE, TS_MIME_LEN_RANGE, rangestr, rangelen); + + if (!rangestat) { + ERROR_LOG("Error trying to set range request header %s", rangestr); + return false; + } + TSAssert(nullptr == _cont); + + // Setup the continuation + _cont = TSContCreate(handler, TSMutexCreate()); + TSContDataSet(_cont, static_cast(this)); + + // create virtual connection back into ATS + TSHttpConnectOptions options = TSHttpConnectOptionsGet(TS_CONNECT_PLUGIN); + options.addr = reinterpret_cast(&data->m_client_ip); + options.tag = PLUGIN_NAME; + options.id = 0; + options.buffer_index = data->m_buffer_index; + options.buffer_water_mark = data->m_buffer_water_mark; + + TSVConn const upvc = TSHttpConnectPlugin(&options); + + int const hlen = TSHttpHdrLengthGet(header.m_buffer, header.m_lochdr); + + // set up connection with the HttpConnect server + _bg_stream.setupConnection(upvc); + _bg_stream.setupVioWrite(_cont, hlen); + TSHttpHdrPrint(header.m_buffer, header.m_lochdr, _bg_stream.m_write.m_iobuf); + + if (TSIsDebugTagSet(PLUGIN_NAME)) { + std::string const headerstr(header.toString()); + DEBUG_LOG("Headers\n%s", headerstr.c_str()); + } + + data->m_fetchstates[_blocknum] = true; + return true; +} + +/** + * @brief Continuation to close background fetch after + * writing to cache is complete or error + * + */ +int +BgBlockFetch::handler(TSCont contp, TSEvent event, void * /* edata ATS_UNUSED */) +{ + BgBlockFetch *bg = static_cast(TSContDataGet(contp)); + + switch (event) { + case TS_EVENT_VCONN_WRITE_COMPLETE: + TSVConnShutdown(bg->_bg_stream.m_vc, 0, 1); + bg->_bg_stream.close(); + delete bg; + break; + default: + if (event == TS_EVENT_VCONN_INACTIVITY_TIMEOUT) { + DEBUG_LOG("encountered Inactivity Timeout"); + TSVConnAbort(bg->_bg_stream.m_vc, TS_VC_CLOSE_ABORT); + } else { + TSVConnClose(bg->_bg_stream.m_vc); + } + bg->_bg_stream.abort(); + TSContDataSet(contp, nullptr); + delete bg; + TSContDestroy(contp); + break; + } + return 0; +} diff --git a/plugins/experimental/slice/prefetch.h b/plugins/experimental/slice/prefetch.h new file mode 100644 index 00000000000..e04376bacf6 --- /dev/null +++ b/plugins/experimental/slice/prefetch.h @@ -0,0 +1,56 @@ +/* + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "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 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +*/ + +/** + * @file prefetch.h + * @brief Background fetch classes for slice plugin. + */ + +#pragma once + +#include + +#include "ts/ts.h" +#include "Data.h" +#include "Config.h" + +/** + * @brief Represents a single background fetch. + */ +struct BgBlockFetch { + static bool schedule(Data *const data, int blocknum); + + explicit BgBlockFetch(int blocknum) : _blocknum(blocknum) {} + + bool fetch(Data *const data); + static int handler(TSCont contp, TSEvent event, void * /* edata ATS_UNUSED */); + + /* This is for the actual background fetch / NetVC */ + Stage _bg_stream; + + int _blocknum; + TSCont _cont = nullptr; + + ~BgBlockFetch() + { + if (nullptr != _cont) { + TSContDestroy(_cont); + _cont = nullptr; + } + } +}; \ No newline at end of file diff --git a/plugins/experimental/slice/server.cc b/plugins/experimental/slice/server.cc index 510edab73ac..ddf0cc9ad2f 100644 --- a/plugins/experimental/slice/server.cc +++ b/plugins/experimental/slice/server.cc @@ -223,9 +223,9 @@ handleFirstServerHeader(Data *const data, TSCont const contp) void logSliceError(char const *const message, Data const *const data, HttpHeader const &header_resp) { - Config *const config = data->m_config; + Config *const conf = data->m_config; - bool const logToError = config->canLogError(); + bool const logToError = conf->canLogError(); // always write block stitch errors while in debug mode if (!logToError && !TSIsDebugTagSet(PLUGIN_NAME)) { @@ -259,7 +259,7 @@ logSliceError(char const *const message, Data const *const data, HttpHeader cons // raw range request char rangestr[1024]; int rangelen = sizeof(rangestr); - header_req.valueForKey(SLICER_MIME_FIELD_INFO, strlen(SLICER_MIME_FIELD_INFO), rangestr, &rangelen); + header_req.valueForKey(conf->m_skip_header.data(), conf->m_skip_header.size(), rangestr, &rangelen); // Normalized range request ContentRange const crange(data->m_req_range.m_beg, data->m_req_range.m_end, data->m_contentlen); @@ -268,8 +268,8 @@ logSliceError(char const *const message, Data const *const data, HttpHeader cons crange.toStringClosed(normstr, &normlen); // block range request - int64_t const blockbeg = data->m_blocknum * data->m_config->m_blockbytes; - int64_t const blockend = std::min(blockbeg + data->m_config->m_blockbytes, data->m_contentlen); + int64_t const blockbeg = data->m_blocknum * conf->m_blockbytes; + int64_t const blockend = std::min(blockbeg + conf->m_blockbytes, data->m_contentlen); // Block response data TSHttpStatus const statusgot = header_resp.status(); @@ -416,8 +416,9 @@ handleNextServerHeader(Data *const data, TSCont const contp) // add special CRR IMS header to the request HttpHeader headerreq(data->m_req_hdrmgr.m_buffer, data->m_req_hdrmgr.m_lochdr); - if (!headerreq.setKeyTime(X_CRR_IMS_HEADER.data(), X_CRR_IMS_HEADER.size(), dateims)) { - ERROR_LOG("Failed setting '%.*s'", (int)X_CRR_IMS_HEADER.size(), X_CRR_IMS_HEADER.data()); + Config const *const conf = data->m_config; + if (!headerreq.setKeyTime(conf->m_crr_ims_header.data(), conf->m_crr_ims_header.size(), dateims)) { + ERROR_LOG("Failed setting '%s'", conf->m_crr_ims_header.c_str()); return false; } @@ -438,8 +439,9 @@ handleNextServerHeader(Data *const data, TSCont const contp) // add special CRR IMS header to the request HttpHeader headerreq(data->m_req_hdrmgr.m_buffer, data->m_req_hdrmgr.m_lochdr); - if (!headerreq.setKeyTime(X_CRR_IMS_HEADER.data(), X_CRR_IMS_HEADER.size(), dateims)) { - ERROR_LOG("Failed setting '%.*s'", (int)X_CRR_IMS_HEADER.size(), X_CRR_IMS_HEADER.data()); + Config const *const conf = data->m_config; + if (!headerreq.setKeyTime(conf->m_crr_ims_header.data(), conf->m_crr_ims_header.size(), dateims)) { + ERROR_LOG("Failed setting '%s'", conf->m_crr_ims_header.c_str()); return false; } diff --git a/plugins/experimental/slice/slice.cc b/plugins/experimental/slice/slice.cc index fbcd6434854..abb1630fc1d 100644 --- a/plugins/experimental/slice/slice.cc +++ b/plugins/experimental/slice/slice.cc @@ -42,8 +42,7 @@ read_request(TSHttpTxn txnp, Config *const config) HttpHeader const header(hdrmgr.m_buffer, hdrmgr.m_lochdr); if (TS_HTTP_METHOD_GET == header.method()) { - static int const SLICER_MIME_LEN_INFO = strlen(SLICER_MIME_FIELD_INFO); - if (!header.hasKey(SLICER_MIME_FIELD_INFO, SLICER_MIME_LEN_INFO)) { + if (!header.hasKey(config->m_skip_header.data(), config->m_skip_header.size())) { // check if any previous plugin has monkeyed with the transaction status TSHttpStatus const txnstat = TSHttpTxnStatusGet(txnp); if (TS_HTTP_STATUS_NONE != txnstat) { @@ -233,9 +232,7 @@ TSReturnCode TSRemapNewInstance(int argc, char *argv[], void **ih, char * /* errbuf */, int /* errbuf_size */) { Config *const config = new Config; - if (2 < argc) { - config->fromArgs(argc - 2, argv + 2); - } + config->fromArgs(argc - 2, argv + 2); *ih = static_cast(config); return TS_SUCCESS; } @@ -274,9 +271,7 @@ TSPluginInit(int argc, char const *argv[]) return; } - if (1 < argc) { - globalConfig.fromArgs(argc - 1, argv + 1); - } + globalConfig.fromArgs(argc - 1, argv + 1); TSCont const contp(TSContCreate(global_read_request_hook, nullptr)); diff --git a/plugins/experimental/slice/slice.h b/plugins/experimental/slice/slice.h index ed86dd6771d..4f9df58a382 100644 --- a/plugins/experimental/slice/slice.h +++ b/plugins/experimental/slice/slice.h @@ -32,8 +32,6 @@ #define PLUGIN_NAME "slice" #endif -constexpr std::string_view X_CRR_IMS_HEADER = {"X-Crr-Ims"}; - #if !defined(UNITTEST) #define __FILENAME__ (strrchr(__FILE__, '/') ? strrchr(__FILE__, '/') + 1 : __FILE__) diff --git a/plugins/experimental/slice/util.cc b/plugins/experimental/slice/util.cc index 4ca86c3d1a4..7e4bc1148ec 100644 --- a/plugins/experimental/slice/util.cc +++ b/plugins/experimental/slice/util.cc @@ -17,6 +17,7 @@ */ #include "util.h" +#include "prefetch.h" #include "Config.h" #include "Data.h" @@ -110,6 +111,19 @@ request_block(TSCont contp, Data *const data) DEBUG_LOG("Headers\n%s", headerstr.c_str()); } + // if prefetch config set, schedule next block requests in background + for (int i = 0; i < data->m_config->m_prefetchcount; i++) { + int nextblocknum = data->m_blocknum + i + 1; + if (data->m_req_range.blockIsInside(data->m_config->m_blockbytes, nextblocknum) && !data->m_fetchstates[nextblocknum]) { + if (BgBlockFetch::schedule(data, nextblocknum)) { + DEBUG_LOG("Background fetch requested"); + } else { + DEBUG_LOG("Background fetch not requested"); + } + } else { + break; + } + } // get ready for data back from the server data->m_upstream.setupVioRead(contp, INT64_MAX); @@ -125,14 +139,16 @@ request_block(TSCont contp, Data *const data) case BlockState::Pending: data->m_blockstate = BlockState::Active; break; - case BlockState::PendingInt: - data->m_blockstate = BlockState::ActiveInt; - header.removeKey(X_CRR_IMS_HEADER.data(), X_CRR_IMS_HEADER.size()); - break; - case BlockState::PendingRef: - data->m_blockstate = BlockState::ActiveRef; - header.removeKey(X_CRR_IMS_HEADER.data(), X_CRR_IMS_HEADER.size()); - break; + case BlockState::PendingInt: { + data->m_blockstate = BlockState::ActiveInt; + Config const *const conf = data->m_config; + header.removeKey(conf->m_crr_ims_header.c_str(), conf->m_crr_ims_header.size()); + } break; + case BlockState::PendingRef: { + data->m_blockstate = BlockState::ActiveRef; + Config const *const conf = data->m_config; + header.removeKey(conf->m_crr_ims_header.c_str(), conf->m_crr_ims_header.size()); + } break; default: ERROR_LOG("Invalid blockstate"); return false; diff --git a/plugins/experimental/statichit/statichit.cc b/plugins/experimental/statichit/statichit.cc index 4cca0f43082..09bc6860916 100644 --- a/plugins/experimental/statichit/statichit.cc +++ b/plugins/experimental/statichit/statichit.cc @@ -55,8 +55,6 @@ constexpr char PLUGIN[] = "statichit"; VDEBUG("vio=%p vio.cont=%p, vio.cont.data=%p, vio.vc=%p " fmt, (vio), TSVIOContGet(vio), TSContDataGet(TSVIOContGet(vio)), \ TSVIOVConnGet(vio), ##__VA_ARGS__) -static TSCont TxnHook; - static int StatCountBytes = -1; static int StatCountResponses = -1; @@ -69,7 +67,7 @@ struct StaticHitConfig { { } - ~StaticHitConfig() {} + ~StaticHitConfig() { TSContDestroy(cont); } std::string filePath; std::string mimeType; @@ -79,6 +77,8 @@ struct StaticHitConfig { int maxAge = 0; bool disableExact = false; + + TSCont cont; }; struct StaticHitRequest; @@ -550,8 +550,6 @@ StaticHitTxnHook(TSCont contp, TSEvent event, void *edata) TSReturnCode TSRemapInit(TSRemapInterface * /* api_info */, char * /* errbuf */, int /* errbuf_size */) { - TxnHook = TSContCreate(StaticHitTxnHook, nullptr); - if (TSStatFindName("statichit.response_bytes", &StatCountBytes) == TS_ERROR) { StatCountBytes = TSStatCreate("statichit.response_bytes", TS_RECORDDATATYPE_COUNTER, TS_STAT_NON_PERSISTENT, TS_STAT_SYNC_SUM); } @@ -595,9 +593,8 @@ TSRemapDoRemap(void *ih, TSHttpTxn rh, TSRemapRequestInfo *rri) TSHttpTxnConfigIntSet(rh, TS_CONFIG_HTTP_CACHE_HTTP, 0); StaticHitSetupIntercept(static_cast(ih), rh); } else { - TSHttpTxnHookAdd(rh, TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK, TxnHook); + TSHttpTxnHookAdd(rh, TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK, static_cast(ih)->cont); } - TSContDataSet(TxnHook, ih); return TSREMAP_NO_REMAP; // This plugin never rewrites anything. } @@ -673,6 +670,10 @@ TSRemapNewInstance(int argc, char *argv[], void **ih, char * /* errbuf ATS_UNUSE tc->successCode = successCode; } + // Finally, create the continuation to use for this remap rule, tracking the config as cont data. + tc->cont = TSContCreate(StaticHitTxnHook, nullptr); + TSContDataSet(tc->cont, tc); + *ih = static_cast(tc); return TS_SUCCESS; diff --git a/plugins/experimental/stek_share/Makefile.inc b/plugins/experimental/stek_share/Makefile.inc new file mode 100644 index 00000000000..462916d3374 --- /dev/null +++ b/plugins/experimental/stek_share/Makefile.inc @@ -0,0 +1,36 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "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 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Only build if NURAFT_LIBS is set to a non-empty value +pkglib_LTLIBRARIES += experimental/stek_share/stek_share.la + +experimental_stek_share_stek_share_la_SOURCES = \ + experimental/stek_share/common.cc \ + experimental/stek_share/common.h \ + experimental/stek_share/log_store.cc \ + experimental/stek_share/log_store.h \ + experimental/stek_share/state_machine.h \ + experimental/stek_share/state_manager.h \ + experimental/stek_share/stek_share.cc \ + experimental/stek_share/stek_share.h \ + experimental/stek_share/stek_utils.cc \ + experimental/stek_share/stek_utils.h + +experimental_stek_share_stek_share_la_LDFLAGS = $(AM_LDFLAGS) @YAMLCPP_LDFLAGS@ + +AM_CPPFLAGS += @NURAFT_INCLUDES@ @YAMLCPP_INCLUDES@ + +experimental_stek_share_stek_share_la_LIBADD = @NURAFT_LIBS@ @YAMLCPP_LIBS@ diff --git a/plugins/experimental/stek_share/common.cc b/plugins/experimental/stek_share/common.cc new file mode 100644 index 00000000000..b9af195e701 --- /dev/null +++ b/plugins/experimental/stek_share/common.cc @@ -0,0 +1,46 @@ +/** @file + + common.cc - Some common functions everyone needs + + @section license License + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "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 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + */ + +#include +#include + +#include +#include + +#include "common.h" + +const unsigned char hex_chars[] = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'}; + +std::string +hex_str(std::string const &str) +{ + std::string hex_str; + hex_str.reserve(str.size() * 2); + for (unsigned long int i = 0; i < str.size(); ++i) { + unsigned char c = str.at(i); + hex_str[i * 2] = hex_chars[(c & 0xF0) >> 4]; + hex_str[i * 2 + 1] = hex_chars[(c & 0x0F)]; + } + return hex_str; +} diff --git a/plugins/experimental/stek_share/common.h b/plugins/experimental/stek_share/common.h new file mode 100644 index 00000000000..312ad557d0c --- /dev/null +++ b/plugins/experimental/stek_share/common.h @@ -0,0 +1,72 @@ +/** @file + + common.h - Things that need to be everywhere + + @section license License + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "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 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + */ + +#pragma once + +#include +#include +#include +#include +#include +#include +#include + +#define PLUGIN "stek_share" + +class PluginThreads +{ +public: + void + store(const pthread_t &th) + { + std::lock_guard lock(threads_mutex); + threads_queue.push_back(th); + } + + void + terminate() + { + shut_down = true; + + std::lock_guard lock(threads_mutex); + while (!threads_queue.empty()) { + pthread_t th = threads_queue.front(); + ::pthread_join(th, nullptr); + threads_queue.pop_front(); + } + } + + bool + is_shut_down() + { + return shut_down; + } + +private: + bool shut_down = false; + std::deque threads_queue; + std::mutex threads_mutex; +}; + +std::string hex_str(std::string const &str); diff --git a/plugins/experimental/stek_share/example_server_conf.yaml b/plugins/experimental/stek_share/example_server_conf.yaml new file mode 100644 index 00000000000..6b6e65fa735 --- /dev/null +++ b/plugins/experimental/stek_share/example_server_conf.yaml @@ -0,0 +1,16 @@ +server_id: 1 +address: 127.0.0.1 +port: 10001 +asio_thread_pool_size: 4 +heart_beat_interval: 100 +election_timeout_lower_bound: 200 +election_timeout_upper_bound: 400 +reserved_log_items: 5 +snapshot_distance: 5 +client_req_timeout: 3000 # this is in milliseconds +key_update_interval: 3600 # this is in seconds +server_list_file: /abs/path/to/server_list.yaml +root_cert_file: /abs/path/to/ca.pem +server_cert_file: /abs/path/to/server.pem +server_key_file: /abs/path/to/server.key +cert_verify_str: /C=US/ST=IL/O=Yahoo/OU=Edge/CN=localhost diff --git a/plugins/experimental/stek_share/example_server_list.yaml b/plugins/experimental/stek_share/example_server_list.yaml new file mode 100644 index 00000000000..77d815f0aed --- /dev/null +++ b/plugins/experimental/stek_share/example_server_list.yaml @@ -0,0 +1,15 @@ +- server_id: 1 + address: 127.0.0.1 + port: 10001 +- server_id: 2 + address: 127.0.0.1 + port: 10002 +- server_id: 3 + address: 127.0.0.1 + port: 10003 +- server_id: 4 + address: 127.0.0.1 + port: 10004 +- server_id: 5 + address: 127.0.0.1 + port: 10005 diff --git a/plugins/experimental/stek_share/log_store.cc b/plugins/experimental/stek_share/log_store.cc new file mode 100644 index 00000000000..0bd31673a1f --- /dev/null +++ b/plugins/experimental/stek_share/log_store.cc @@ -0,0 +1,263 @@ +/************************************************************************ +Copyright 2017-2019 eBay Inc. +Author/Developer(s): Jung-Sang Ahn + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://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, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +**************************************************************************/ + +// This file is based on the example code from https://github.com/eBay/NuRaft/tree/master/examples + +#include + +#include + +#include "log_store.h" + +STEKShareLogStore::STEKShareLogStore() : start_idx_(1) +{ + // Dummy entry for index 0. + nuraft::ptr buf = nuraft::buffer::alloc(sizeof(uint64_t)); + logs_[0] = nuraft::cs_new(0, buf); +} + +STEKShareLogStore::~STEKShareLogStore() {} + +nuraft::ptr +STEKShareLogStore::make_clone(const nuraft::ptr &entry) +{ + nuraft::ptr clone = + nuraft::cs_new(entry->get_term(), nuraft::buffer::clone(entry->get_buf()), entry->get_val_type()); + return clone; +} + +uint64_t +STEKShareLogStore::next_slot() const +{ + std::lock_guard l(logs_lock_); + + // Exclude the dummy entry. + return start_idx_ + logs_.size() - 1; +} + +uint64_t +STEKShareLogStore::start_index() const +{ + return start_idx_; +} + +nuraft::ptr +STEKShareLogStore::last_entry() const +{ + uint64_t next_idx = next_slot(); + std::lock_guard l(logs_lock_); + auto entry = logs_.find(next_idx - 1); + if (entry == logs_.end()) { + entry = logs_.find(0); + } + + return make_clone(entry->second); +} + +uint64_t +STEKShareLogStore::append(nuraft::ptr &entry) +{ + nuraft::ptr clone = make_clone(entry); + + std::lock_guard l(logs_lock_); + size_t idx = start_idx_ + logs_.size() - 1; + logs_[idx] = clone; + return idx; +} + +void +STEKShareLogStore::write_at(uint64_t index, nuraft::ptr &entry) +{ + nuraft::ptr clone = make_clone(entry); + + // Discard all logs equal to or greater than "index". + std::lock_guard l(logs_lock_); + auto itr = logs_.lower_bound(index); + while (itr != logs_.end()) { + itr = logs_.erase(itr); + } + logs_[index] = clone; +} + +nuraft::ptr>> +STEKShareLogStore::log_entries(uint64_t start, uint64_t end) +{ + nuraft::ptr>> ret = nuraft::cs_new>>(); + + ret->resize(end - start); + uint64_t cc = 0; + for (uint64_t i = start; i < end; ++i) { + nuraft::ptr src = nullptr; + { + std::lock_guard l(logs_lock_); + auto entry = logs_.find(i); + if (entry == logs_.end()) { + entry = logs_.find(0); + assert(0); + } + src = entry->second; + } + (*ret)[cc++] = make_clone(src); + } + return ret; +} + +nuraft::ptr>> +STEKShareLogStore::log_entries_ext(uint64_t start, uint64_t end, int64_t batch_size_hint_in_bytes) +{ + nuraft::ptr>> ret = nuraft::cs_new>>(); + + if (batch_size_hint_in_bytes < 0) { + return ret; + } + + size_t accum_size = 0; + for (uint64_t i = start; i < end; ++i) { + nuraft::ptr src = nullptr; + { + std::lock_guard l(logs_lock_); + auto entry = logs_.find(i); + if (entry == logs_.end()) { + entry = logs_.find(0); + assert(0); + } + src = entry->second; + } + ret->push_back(make_clone(src)); + accum_size += src->get_buf().size(); + if (batch_size_hint_in_bytes && accum_size >= (uint64_t)batch_size_hint_in_bytes) { + break; + } + } + return ret; +} + +nuraft::ptr +STEKShareLogStore::entry_at(uint64_t index) +{ + nuraft::ptr src = nullptr; + { + std::lock_guard l(logs_lock_); + auto entry = logs_.find(index); + if (entry == logs_.end()) { + entry = logs_.find(0); + } + src = entry->second; + } + return make_clone(src); +} + +uint64_t +STEKShareLogStore::term_at(uint64_t index) +{ + uint64_t term = 0; + { + std::lock_guard l(logs_lock_); + auto entry = logs_.find(index); + if (entry == logs_.end()) { + entry = logs_.find(0); + } + term = entry->second->get_term(); + } + return term; +} + +nuraft::ptr +STEKShareLogStore::pack(uint64_t index, int32_t cnt) +{ + std::vector> logs; + + size_t size_total = 0; + for (uint64_t i = index; i < index + cnt; ++i) { + nuraft::ptr le = nullptr; + { + std::lock_guard l(logs_lock_); + le = logs_[i]; + } + assert(le.get()); + nuraft::ptr buf = le->serialize(); + size_total += buf->size(); + logs.push_back(buf); + } + + nuraft::ptr buf_out = nuraft::buffer::alloc(sizeof(int32_t) + cnt * sizeof(int32_t) + size_total); + buf_out->pos(0); + buf_out->put((int32_t)cnt); + + for (auto &entry : logs) { + nuraft::ptr &bb = entry; + buf_out->put((int32_t)bb->size()); + buf_out->put(*bb); + } + return buf_out; +} + +void +STEKShareLogStore::apply_pack(uint64_t index, nuraft::buffer &pack) +{ + pack.pos(0); + int32_t num_logs = pack.get_int(); + + for (int32_t i = 0; i < num_logs; ++i) { + uint64_t cur_idx = index + i; + int32_t buf_size = pack.get_int(); + + nuraft::ptr buf_local = nuraft::buffer::alloc(buf_size); + pack.get(buf_local); + + nuraft::ptr le = nuraft::log_entry::deserialize(*buf_local); + { + std::lock_guard l(logs_lock_); + logs_[cur_idx] = le; + } + } + + { + std::lock_guard l(logs_lock_); + auto entry = logs_.upper_bound(0); + if (entry != logs_.end()) { + start_idx_ = entry->first; + } else { + start_idx_ = 1; + } + } +} + +bool +STEKShareLogStore::compact(uint64_t last_log_index) +{ + std::lock_guard l(logs_lock_); + for (uint64_t i = start_idx_; i <= last_log_index; ++i) { + auto entry = logs_.find(i); + if (entry != logs_.end()) { + logs_.erase(entry); + } + } + + // WARNING: + // Even though nothing has been erased, we should set "start_idx_" to new index. + if (start_idx_ <= last_log_index) { + start_idx_ = last_log_index + 1; + } + + return true; +} + +void +STEKShareLogStore::close() +{ +} diff --git a/plugins/experimental/stek_share/log_store.h b/plugins/experimental/stek_share/log_store.h new file mode 100644 index 00000000000..6f6659cdee4 --- /dev/null +++ b/plugins/experimental/stek_share/log_store.h @@ -0,0 +1,76 @@ +/************************************************************************ +Copyright 2017-2019 eBay Inc. +Author/Developer(s): Jung-Sang Ahn + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://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, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +**************************************************************************/ + +// This file is based on the example code from https://github.com/eBay/NuRaft/tree/master/examples + +#pragma once + +#include +#include +#include + +#include + +class STEKShareLogStore : public nuraft::log_store +{ +public: + STEKShareLogStore(); + + ~STEKShareLogStore(); + + __nocopy__(STEKShareLogStore); + + uint64_t next_slot() const; + + uint64_t start_index() const; + + nuraft::ptr last_entry() const; + + uint64_t append(nuraft::ptr &entry); + + void write_at(uint64_t index, nuraft::ptr &entry); + + nuraft::ptr>> log_entries(uint64_t start, uint64_t end); + + nuraft::ptr>> log_entries_ext(uint64_t start, uint64_t end, + int64_t batch_size_hint_in_bytes = 0); + + nuraft::ptr entry_at(uint64_t index); + + uint64_t term_at(uint64_t index); + + nuraft::ptr pack(uint64_t index, int32_t cnt); + + void apply_pack(uint64_t index, nuraft::buffer &pack); + + bool compact(uint64_t last_log_index); + + bool + flush() + { + return true; + } + + void close(); + +private: + static nuraft::ptr make_clone(const nuraft::ptr &entry); + + std::map> logs_; + mutable std::mutex logs_lock_; + std::atomic start_idx_; +}; diff --git a/plugins/experimental/stek_share/state_machine.h b/plugins/experimental/stek_share/state_machine.h new file mode 100644 index 00000000000..26a3995e851 --- /dev/null +++ b/plugins/experimental/stek_share/state_machine.h @@ -0,0 +1,237 @@ +/************************************************************************ +Copyright 2017-2019 eBay Inc. +Author/Developer(s): Jung-Sang Ahn + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://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, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +**************************************************************************/ + +// This file is based on the example code from https://github.com/eBay/NuRaft/tree/master/examples + +#pragma once + +#include +#include +#include +#include +#include + +#include + +#include "common.h" +#include "stek_utils.h" + +class STEKShareSM : public nuraft::state_machine +{ +public: + STEKShareSM() : last_committed_idx_(0) {} + + ~STEKShareSM() {} + + nuraft::ptr + pre_commit(const uint64_t log_idx, nuraft::buffer &data) + { + return nullptr; + } + + nuraft::ptr + commit(const uint64_t log_idx, nuraft::buffer &data) + { + // Extract bytes from "data". + size_t len = 0; + nuraft::buffer_serializer bs_data(data); + void *byte_array = bs_data.get_bytes(len); + // TSDebug(PLUGIN, "commit %lu: %s", log_idx, hex_str(std::string(reinterpret_cast(byte_array), len)).c_str()); + + assert(len == SSL_TICKET_KEY_SIZE); + + { + std::lock_guard l(stek_lock_); + std::memcpy(&stek_, byte_array, len); + received_stek_ = true; + } + + // Update last committed index number. + last_committed_idx_ = log_idx; + + nuraft::ptr ret = nuraft::buffer::alloc(sizeof(log_idx)); + nuraft::buffer_serializer bs_ret(ret); + bs_ret.put_u64(log_idx); + + return ret; + } + + bool + received_stek(ssl_ticket_key_t *curr_stek) + { + std::lock_guard l(stek_lock_); + if (!received_stek_) { + return false; + } + + received_stek_ = false; + + if (std::memcmp(curr_stek, &stek_, SSL_TICKET_KEY_SIZE != 0)) { + std::memcpy(curr_stek, &stek_, SSL_TICKET_KEY_SIZE); + return true; + } + + return false; + } + + void + commit_config(const uint64_t log_idx, nuraft::ptr &new_conf) + { + // Nothing to do with configuration change. Just update committed index. + last_committed_idx_ = log_idx; + } + + void + rollback(const uint64_t log_idx, nuraft::buffer &data) + { + // Nothing to do here since we don't have pre-commit. + } + + int + read_logical_snp_obj(nuraft::snapshot &s, void *&user_snp_ctx, uint64_t obj_id, nuraft::ptr &data_out, + bool &is_last_obj) + { + // TSDebug(PLUGIN, "read snapshot %lu term %lu object ID %lu", s.get_last_log_idx(), s.get_last_log_term(), obj_id); + + is_last_obj = true; + + { + std::lock_guard l(snapshot_lock_); + if (snapshot_ == nullptr || snapshot_->snapshot_->get_last_log_idx() != s.get_last_log_idx()) { + data_out = nullptr; + return -1; + } else { + data_out = nuraft::buffer::alloc(sizeof(int) + SSL_TICKET_KEY_SIZE); + nuraft::buffer_serializer bs(data_out); + bs.put_bytes(reinterpret_cast(&snapshot_->stek_), SSL_TICKET_KEY_SIZE); + return 0; + } + } + } + + void + save_logical_snp_obj(nuraft::snapshot &s, uint64_t &obj_id, nuraft::buffer &data, bool is_first_obj, bool is_last_obj) + { + // TSDebug(PLUGIN, "save snapshot %lu term %lu object ID %lu", s.get_last_log_idx(), s.get_last_log_term(), obj_id); + + size_t len = 0; + nuraft::buffer_serializer bs_data(data); + void *byte_array = bs_data.get_bytes(len); + + assert(len == SSL_TICKET_KEY_SIZE); + + ssl_ticket_key_t local_stek; + std::memcpy(&local_stek, byte_array, len); + + nuraft::ptr snp_buf = s.serialize(); + nuraft::ptr ss = nuraft::snapshot::deserialize(*snp_buf); + nuraft::ptr ctx = nuraft::cs_new(ss, local_stek); + + { + std::lock_guard l(snapshot_lock_); + snapshot_ = ctx; + } + + obj_id++; + } + + bool + apply_snapshot(nuraft::snapshot &s) + { + // TSDebug(PLUGIN, "apply snapshot %lu term %lu", s.get_last_log_idx(), s.get_last_log_term()); + + { + std::lock_guard l(snapshot_lock_); + if (snapshot_ != nullptr) { + std::lock_guard ll(stek_lock_); + std::memcpy(&stek_, &snapshot_->stek_, SSL_TICKET_KEY_SIZE); + received_stek_ = true; + return true; + } else { + return false; + } + } + } + + void + free_user_snp_ctx(void *&user_snp_ctx) + { + } + + nuraft::ptr + last_snapshot() + { + // Just return the latest snapshot. + std::lock_guard l(snapshot_lock_); + if (snapshot_ != nullptr) { + return snapshot_->snapshot_; + } + return nullptr; + } + + uint64_t + last_commit_index() + { + return last_committed_idx_; + } + + void + create_snapshot(nuraft::snapshot &s, nuraft::async_result::handler_type &when_done) + { + // TSDebug(PLUGIN, "create snapshot %lu term %lu", s.get_last_log_idx(), s.get_last_log_term()); + + ssl_ticket_key_t local_stek; + { + std::lock_guard l(stek_lock_); + std::memcpy(&local_stek, &stek_, SSL_TICKET_KEY_SIZE); + } + + nuraft::ptr snp_buf = s.serialize(); + nuraft::ptr ss = nuraft::snapshot::deserialize(*snp_buf); + nuraft::ptr ctx = nuraft::cs_new(ss, local_stek); + + { + std::lock_guard l(snapshot_lock_); + snapshot_ = ctx; + } + + nuraft::ptr except(nullptr); + bool ret = true; + when_done(ret, except); + } + +private: + struct snapshot_ctx { + snapshot_ctx(nuraft::ptr &s, ssl_ticket_key_t key) : snapshot_(s), stek_(key) {} + nuraft::ptr snapshot_; + ssl_ticket_key_t stek_; + }; + + // Last committed Raft log number. + std::atomic last_committed_idx_; + + nuraft::ptr snapshot_; + + // Mutex for snapshot. + std::mutex snapshot_lock_; + + bool received_stek_ = false; + + ssl_ticket_key_t stek_; + + std::mutex stek_lock_; +}; diff --git a/plugins/experimental/stek_share/state_manager.h b/plugins/experimental/stek_share/state_manager.h new file mode 100644 index 00000000000..63e16249edb --- /dev/null +++ b/plugins/experimental/stek_share/state_manager.h @@ -0,0 +1,102 @@ +/************************************************************************ +Copyright 2017-2019 eBay Inc. +Author/Developer(s): Jung-Sang Ahn + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://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, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +**************************************************************************/ + +// This file is based on the example code from https://github.com/eBay/NuRaft/tree/master/examples + +#pragma once + +#include + +#include "log_store.h" + +class STEKShareSMGR : public nuraft::state_mgr +{ +public: + STEKShareSMGR(int srv_id, const std::string &endpoint, std::map server_list) + : my_id_(srv_id), my_endpoint_(endpoint), cur_log_store_(nuraft::cs_new()) + { + my_srv_config_ = nuraft::cs_new(srv_id, endpoint); + + // Initial cluster config, read from the list loaded from the configuration file. + saved_config_ = nuraft::cs_new(); + for (auto const &s : server_list) { + int server_id = s.first; + std::string endpoint = s.second; + nuraft::ptr new_server = nuraft::cs_new(server_id, endpoint); + saved_config_->get_servers().push_back(new_server); + } + } + + ~STEKShareSMGR() {} + + nuraft::ptr + load_config() + { + return saved_config_; + } + + void + save_config(const nuraft::cluster_config &config) + { + nuraft::ptr buf = config.serialize(); + saved_config_ = nuraft::cluster_config::deserialize(*buf); + } + + void + save_state(const nuraft::srv_state &state) + { + nuraft::ptr buf = state.serialize(); + saved_state_ = nuraft::srv_state::deserialize(*buf); + } + + nuraft::ptr + read_state() + { + return saved_state_; + } + + nuraft::ptr + load_log_store() + { + return cur_log_store_; + } + + int32_t + server_id() + { + return my_id_; + } + + void + system_exit(const int exit_code) + { + } + + nuraft::ptr + get_srv_config() const + { + return my_srv_config_; + } + +private: + int my_id_; + std::string my_endpoint_; + nuraft::ptr cur_log_store_; + nuraft::ptr my_srv_config_; + nuraft::ptr saved_config_; + nuraft::ptr saved_state_; +}; diff --git a/plugins/experimental/stek_share/stek_share.cc b/plugins/experimental/stek_share/stek_share.cc new file mode 100644 index 00000000000..810c4f75ba9 --- /dev/null +++ b/plugins/experimental/stek_share/stek_share.cc @@ -0,0 +1,445 @@ +/** @file + + stek_share.cc + + @section license License + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "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 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + */ + +#include +#include +#include +#include + +#include +#include +#include +#include +#include + +#include "state_machine.h" +#include "state_manager.h" +#include "stek_share.h" +#include "stek_utils.h" +#include "common.h" + +using raft_result = nuraft::cmd_result>; + +PluginThreads plugin_threads; + +static STEKShareServer stek_share_server; +static const nuraft::raft_params::return_method_type CALL_TYPE = nuraft::raft_params::blocking; +// static const nuraft::raft_params::return_method_type CALL_TYPE = nuraft::raft_params::async_handler; + +static int +shutdown_handler(TSCont contp, TSEvent event, void *edata) +{ + if (event == TS_EVENT_LIFECYCLE_SHUTDOWN) { + plugin_threads.terminate(); + stek_share_server.launcher_.shutdown(); + } + return 0; +} + +bool +cert_verification(const std::string &sn) +{ + if (sn.compare(stek_share_server.cert_verify_str_) != 0) { + TSDebug(PLUGIN, "Cert incorrect, expecting: %s, got: %s", stek_share_server.cert_verify_str_.c_str(), sn.c_str()); + return false; + } + return true; +} + +int +init_raft(nuraft::ptr sm_instance) +{ + // State machine. + stek_share_server.smgr_ = + nuraft::cs_new(stek_share_server.server_id_, stek_share_server.endpoint_, stek_share_server.server_list_); + + // State manager. + stek_share_server.sm_ = sm_instance; + + // ASIO options. + nuraft::asio_service::options asio_opts; + asio_opts.thread_pool_size_ = stek_share_server.asio_thread_pool_size_; + asio_opts.enable_ssl_ = true; + asio_opts.verify_sn_ = cert_verification; + asio_opts.root_cert_file_ = stek_share_server.root_cert_file_; + asio_opts.server_cert_file_ = stek_share_server.server_cert_file_; + asio_opts.server_key_file_ = stek_share_server.server_key_file_; + + // Raft parameters. + nuraft::raft_params params; + params.heart_beat_interval_ = stek_share_server.heart_beat_interval_; + params.election_timeout_lower_bound_ = stek_share_server.election_timeout_lower_bound_; + params.election_timeout_upper_bound_ = stek_share_server.election_timeout_upper_bound_; + params.reserved_log_items_ = stek_share_server.reserved_log_items_; + params.snapshot_distance_ = stek_share_server.snapshot_distance_; + params.client_req_timeout_ = stek_share_server.client_req_timeout_; + + // According to this method, "append_log" function should be handled differently. + params.return_method_ = CALL_TYPE; + + // Initialize Raft server. + stek_share_server.raft_instance_ = stek_share_server.launcher_.init(stek_share_server.sm_, stek_share_server.smgr_, nullptr, + stek_share_server.port_, asio_opts, params); + + if (!stek_share_server.raft_instance_) { + TSDebug(PLUGIN, "Failed to initialize launcher."); + return -1; + } + + TSDebug(PLUGIN, "Raft instance initialization done."); + return 0; +} + +int +set_server_info(int argc, const char *argv[]) +{ + // Get server ID. + YAML::Node server_conf; + try { + server_conf = YAML::LoadFile(argv[1]); + } catch (YAML::BadFile &e) { + TSEmergency("[%s] Cannot load configuration file: %s.", PLUGIN, e.what()); + } catch (std::exception &e) { + TSEmergency("[%s] Unknown error while loading configuration file: %s.", PLUGIN, e.what()); + } + + if (server_conf["server_id"]) { + stek_share_server.server_id_ = server_conf["server_id"].as(); + if (stek_share_server.server_id_ < 1) { + TSDebug(PLUGIN, "Wrong server id (must be >= 1): %d", stek_share_server.server_id_); + return -1; + } + } else { + TSDebug(PLUGIN, "Must specify server id in the configuration file."); + return -1; + } + + // Get server address and port. + if (server_conf["address"]) { + stek_share_server.addr_ = server_conf["address"].as(); + } else { + TSDebug(PLUGIN, "Must specify server address in the configuration file."); + return -1; + } + + if (server_conf["port"]) { + stek_share_server.port_ = server_conf["port"].as(); + } else { + TSDebug(PLUGIN, "Must specify server port in the configuration file."); + return -1; + } + + stek_share_server.endpoint_ = stek_share_server.addr_ + ":" + std::to_string(stek_share_server.port_); + + if (server_conf["asio_thread_pool_size"]) { + stek_share_server.asio_thread_pool_size_ = server_conf["asio_thread_pool_size"].as(); + } + + if (server_conf["heart_beat_interval"]) { + stek_share_server.heart_beat_interval_ = server_conf["heart_beat_interval"].as(); + } + + if (server_conf["election_timeout_lower_bound"]) { + stek_share_server.election_timeout_lower_bound_ = server_conf["election_timeout_lower_bound"].as(); + } + + if (server_conf["election_timeout_upper_bound"]) { + stek_share_server.election_timeout_upper_bound_ = server_conf["election_timeout_upper_bound"].as(); + } + + if (server_conf["reserved_log_items"]) { + stek_share_server.reserved_log_items_ = server_conf["reserved_log_items"].as(); + } + + if (server_conf["snapshot_distance"]) { + stek_share_server.snapshot_distance_ = server_conf["snapshot_distance"].as(); + } + + if (server_conf["client_req_timeout"]) { + stek_share_server.client_req_timeout_ = server_conf["client_req_timeout"].as(); + } + + if (server_conf["key_update_interval"]) { + stek_share_server.key_update_interval_ = server_conf["key_update_interval"].as(); + } else { + TSDebug(PLUGIN, "Must specify server key update interval in the configuration file."); + return -1; + } + + if (server_conf["server_list_file"]) { + YAML::Node server_list; + try { + server_list = YAML::LoadFile(server_conf["server_list_file"].as()); + } catch (YAML::BadFile &e) { + TSEmergency("[%s] Cannot load server list file: %s.", PLUGIN, e.what()); + } catch (std::exception &e) { + TSEmergency("[%s] Unknown error while loading server list file: %s.", PLUGIN, e.what()); + } + + std::string cluster_list_str = ""; + cluster_list_str += "\nSTEK Share Cluster Server List:"; + for (auto it = server_list.begin(); it != server_list.end(); ++it) { + YAML::Node server_info = it->as(); + if (server_info["server_id"] && server_info["address"] && server_info["port"]) { + int server_id = server_info["server_id"].as(); + std::string address = server_info["address"].as(); + int port = server_info["port"].as(); + std::string endpoint = address + ":" + std::to_string(port); + stek_share_server.server_list_[server_id] = endpoint; + cluster_list_str += "\n " + std::to_string(server_id) + ", " + endpoint; + } else { + TSDebug(PLUGIN, "Wrong server list format."); + return -1; + } + } + TSDebug(PLUGIN, "%s", cluster_list_str.c_str()); + } else { + TSDebug(PLUGIN, "Must specify server list file in the configuration file."); + return -1; + } + + // TODO: check cert and key files exist + if (server_conf["root_cert_file"]) { + stek_share_server.root_cert_file_ = server_conf["root_cert_file"].as(); + } else { + TSDebug(PLUGIN, "Must specify root ca file in the configuration file."); + return -1; + } + + if (server_conf["server_cert_file"]) { + stek_share_server.server_cert_file_ = server_conf["server_cert_file"].as(); + } else { + TSDebug(PLUGIN, "Must specify server cert file in the configuration file."); + return -1; + } + + if (server_conf["server_key_file"]) { + stek_share_server.server_key_file_ = server_conf["server_key_file"].as(); + } else { + TSDebug(PLUGIN, "Must specify server key file in the configuration file."); + return -1; + } + + if (server_conf["cert_verify_str"]) { + stek_share_server.cert_verify_str_ = server_conf["cert_verify_str"].as(); + } else { + TSDebug(PLUGIN, "Must specify cert verify string in the configuration file."); + return -1; + } + + return 0; +} + +void +handle_result(raft_result &result, nuraft::ptr &err) +{ + if (result.get_result_code() != nuraft::cmd_result_code::OK) { + // Something went wrong. + // This means committing this log failed, but the log itself is still in the log store. + TSDebug(PLUGIN, "Replication failed: %d", result.get_result_code()); + return; + } + TSDebug(PLUGIN, "Replication succeeded."); +} + +void +append_log(const void *data, int data_len) +{ + // Create a new log which will contain 4-byte length and string data. + nuraft::ptr new_log = nuraft::buffer::alloc(sizeof(int) + data_len); + nuraft::buffer_serializer bs(new_log); + bs.put_bytes(data, data_len); + + // Do append. + nuraft::ptr ret = stek_share_server.raft_instance_->append_entries({new_log}); + + if (!ret->get_accepted()) { + // Log append rejected, usually because this node is not a leader. + TSDebug(PLUGIN, "Replication failed: %d", ret->get_result_code()); + return; + } + + // Log append accepted, but that doesn't mean the log is committed. + // Commit result can be obtained below. + if (CALL_TYPE == nuraft::raft_params::blocking) { + // Blocking mode: + // "append_entries" returns after getting a consensus, so that "ret" already has the result from state machine. + nuraft::ptr err(nullptr); + handle_result(*ret, err); + } else if (CALL_TYPE == nuraft::raft_params::async_handler) { + // Async mode: + // "append_entries" returns immediately. "handle_result" will be invoked asynchronously, after getting a consensus. + ret->when_ready(std::bind(handle_result, std::placeholders::_1, std::placeholders::_2)); + } else { + assert(0); + } +} + +void +print_status() +{ + // For debugging + nuraft::ptr ls = stek_share_server.smgr_->load_log_store(); + std::string status_str = ""; + status_str += "\n Server ID: " + std::to_string(stek_share_server.server_id_); + status_str += "\n Leader ID: " + std::to_string(stek_share_server.raft_instance_->get_leader()); + status_str += "\n Raft log range: " + std::to_string(ls->start_index()) + " - " + std::to_string((ls->next_slot() - 1)); + status_str += "\n Last committed index: " + std::to_string(stek_share_server.raft_instance_->get_committed_log_idx()); + TSDebug(PLUGIN, "%s", status_str.c_str()); +} + +static void * +stek_updater(void *arg) +{ + plugin_threads.store(::pthread_self()); + ::pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, nullptr); + ::pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, nullptr); + + ssl_ticket_key_t curr_stek; + time_t init_key_time = 0; + + // Initial key to use before syncing up. + TSDebug(PLUGIN, "Generating initial STEK..."); + if (generate_new_stek(&curr_stek, 0 /* fast start */) == 0) { + TSDebug(PLUGIN, "Generate initial STEK succeeded: %s", + hex_str(std::string(reinterpret_cast(&curr_stek), SSL_TICKET_KEY_SIZE)).c_str()); + + std::memcpy(&stek_share_server.ticket_keys_[0], &curr_stek, SSL_TICKET_KEY_SIZE); + + TSDebug(PLUGIN, "Updating SSL Ticket Key..."); + if (TSSslTicketKeyUpdate(reinterpret_cast(stek_share_server.ticket_keys_), SSL_TICKET_KEY_SIZE) == TS_ERROR) { + TSDebug(PLUGIN, "Update SSL Ticket Key failed."); + } else { + TSDebug(PLUGIN, "Update SSL Ticket Key succeeded."); + init_key_time = time(nullptr); + } + } else { + TSFatal("Generate initial STEK failed."); + } + + // Since we're using a pre-configured cluster, we need to have >= 3 nodes in the clust + // to initialize. Busy check before that. + while (!plugin_threads.is_shut_down()) { + if (!stek_share_server.raft_instance_->is_initialized()) { + std::this_thread::sleep_for(std::chrono::milliseconds(250)); + continue; + } + + if (stek_share_server.raft_instance_->is_leader()) { + // We only need to generate new STEK if this server is the leader. + // Otherwise we wake up every 10 seconds to see whether a new STEK has been received. + if (init_key_time != 0 && time(nullptr) - init_key_time < stek_share_server.key_update_interval_) { + // If we got here after starting up, that means the initial key is still valid and we can send it to everyone else. + stek_share_server.last_updated_ = init_key_time; + TSDebug(PLUGIN, "Using initial STEK: %s", + hex_str(std::string(reinterpret_cast(&curr_stek), SSL_TICKET_KEY_SIZE)).c_str()); + append_log(reinterpret_cast(&curr_stek), SSL_TICKET_KEY_SIZE); + + } else if (time(nullptr) - stek_share_server.last_updated_ >= stek_share_server.key_update_interval_) { + // Generate a new key as the last one has expired. + // Move the old key from ticket_keys_[0] to ticket_keys_[1], then put the new key in ticket_keys_[0]. + TSDebug(PLUGIN, "Generating new STEK..."); + if (generate_new_stek(&curr_stek, 1) == 0) { + TSDebug(PLUGIN, "Generate new STEK succeeded: %s", + hex_str(std::string(reinterpret_cast(&curr_stek), SSL_TICKET_KEY_SIZE)).c_str()); + + std::memcpy(&stek_share_server.ticket_keys_[1], &stek_share_server.ticket_keys_[0], SSL_TICKET_KEY_SIZE); + std::memcpy(&stek_share_server.ticket_keys_[0], &curr_stek, SSL_TICKET_KEY_SIZE); + + TSDebug(PLUGIN, "Updating SSL Ticket Key..."); + if (TSSslTicketKeyUpdate(reinterpret_cast(stek_share_server.ticket_keys_), SSL_TICKET_KEY_SIZE * 2) == TS_ERROR) { + TSDebug(PLUGIN, "Update SSL Ticket Key failed."); + } else { + stek_share_server.last_updated_ = time(nullptr); + TSDebug(PLUGIN, "Update SSL Ticket Key succeeded."); + TSDebug(PLUGIN, "Using new STEK: %s", + hex_str(std::string(reinterpret_cast(&curr_stek), SSL_TICKET_KEY_SIZE)).c_str()); + append_log(reinterpret_cast(&curr_stek), SSL_TICKET_KEY_SIZE); + } + } else { + TSFatal("Generate new STEK failed."); + } + } + init_key_time = 0; + + } else { + init_key_time = 0; + auto sm = dynamic_cast(stek_share_server.sm_.get()); + + // Check whether we received a new key. + // TODO: retry updating STEK when failed + if (sm->received_stek(&curr_stek)) { + TSDebug(PLUGIN, "Received new STEK: %s", + hex_str(std::string(reinterpret_cast(&curr_stek), SSL_TICKET_KEY_SIZE)).c_str()); + + // Move the old key from ticket_keys_[0] to ticket_keys_[1], then put the new key in ticket_keys_[0]. + std::memcpy(&stek_share_server.ticket_keys_[1], &stek_share_server.ticket_keys_[0], SSL_TICKET_KEY_SIZE); + std::memcpy(&stek_share_server.ticket_keys_[0], &curr_stek, SSL_TICKET_KEY_SIZE); + + TSDebug(PLUGIN, "Updating SSL Ticket Key..."); + if (TSSslTicketKeyUpdate(reinterpret_cast(stek_share_server.ticket_keys_), SSL_TICKET_KEY_SIZE * 2) == TS_ERROR) { + TSDebug(PLUGIN, "Update SSL Ticket Key failed."); + } else { + stek_share_server.last_updated_ = time(nullptr); + TSDebug(PLUGIN, "Update SSL Ticket Key succeeded."); + } + } + } + + // Wakeup every 10 seconds to check whether there is a new key to use. + // We do this because if a server is lagging behind, either by losing connection or joining late, + // that server might receive multiple keys (the ones it missed) when it reconnects. Since we only need the + // most recent one, and to save time, we check back every 10 seconds in hope that the barrage of incoming + // keys has finished, and if not the second time around it'll definitely has. + std::this_thread::sleep_for(std::chrono::seconds(10)); + } + + return nullptr; +} + +void +TSPluginInit(int argc, const char *argv[]) +{ + TSPluginRegistrationInfo info; + + info.plugin_name = (char *)("stek_share"); + info.vendor_name = (char *)("ats"); + info.support_email = (char *)("ats-devel@yahooinc.com"); + + TSLifecycleHookAdd(TS_LIFECYCLE_SHUTDOWN_HOOK, TSContCreate(shutdown_handler, nullptr)); + + if (TSPluginRegister(&info) != TS_SUCCESS) { + TSError("Plugin registration failed."); + return; + } + + if (argc < 2) { + TSError("Must specify config file."); + } else if (set_server_info(argc, argv) == 0 && init_raft(nuraft::cs_new()) == 0) { + TSDebug(PLUGIN, "Server ID: %d, Endpoint: %s", stek_share_server.server_id_, stek_share_server.endpoint_.c_str()); + TSThreadCreate(stek_updater, nullptr); + } else { + TSError("Raft initialization failed."); + } +} diff --git a/plugins/experimental/stek_share/stek_share.h b/plugins/experimental/stek_share/stek_share.h new file mode 100644 index 00000000000..14a8579bb46 --- /dev/null +++ b/plugins/experimental/stek_share/stek_share.h @@ -0,0 +1,123 @@ +/************************************************************************ +Copyright 2017-2019 eBay Inc. +Author/Developer(s): Jung-Sang Ahn + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://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, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +**************************************************************************/ + +// This file is based on the example code from https://github.com/eBay/NuRaft/tree/master/examples + +#pragma once + +#include +#include +#include + +#include + +#include "stek_utils.h" + +class STEKShareServer +{ +public: + STEKShareServer() : server_id_(1), addr_("localhost"), port_(25000), sm_(nullptr), smgr_(nullptr), raft_instance_(nullptr) + { + last_updated_ = 0; + current_log_idx_ = 0; + + // Default ASIO thread pool size: 4. + asio_thread_pool_size_ = 4; + + // Default heart beat interval: 100 ms. + heart_beat_interval_ = 100; + + // Default election timeout: 200~400 ms. + election_timeout_lower_bound_ = 200; + election_timeout_upper_bound_ = 400; + + // Up to 5 logs will be preserved ahead the last snapshot. + reserved_log_items_ = 5; + + // Snapshot will be created for every 5 log appends. + snapshot_distance_ = 5; + + // Client timeout: 3000 ms. + client_req_timeout_ = 3000; + + std::memset(ticket_keys_, 0, SSL_TICKET_KEY_SIZE * 2); + } + + void + reset() + { + sm_.reset(); + smgr_.reset(); + raft_instance_.reset(); + } + + // Server ID. + int server_id_; + + // Server address. + std::string addr_; + + // Server port. + int port_; + + // Endpoint: ":". + std::string endpoint_; + + // State machine. + nuraft::ptr sm_; + + // State manager. + nuraft::ptr smgr_; + + // Raft launcher. + nuraft::raft_launcher launcher_; + + // Raft server instance. + nuraft::ptr raft_instance_; + + // List of servers to auto add. + std::map server_list_; + + // STEK update interval. + int key_update_interval_; + + // When was STEK last updated. + time_t last_updated_; + + uint64_t current_log_idx_; + + size_t asio_thread_pool_size_; + + int heart_beat_interval_; + + int election_timeout_lower_bound_; + int election_timeout_upper_bound_; + + int reserved_log_items_; + + int snapshot_distance_; + + int client_req_timeout_; + + // TLS related stuff. + std::string root_cert_file_; + std::string server_cert_file_; + std::string server_key_file_; + std::string cert_verify_str_; + + ssl_ticket_key_t ticket_keys_[2]; +}; diff --git a/plugins/experimental/stek_share/stek_utils.cc b/plugins/experimental/stek_share/stek_utils.cc new file mode 100644 index 00000000000..89a3884b766 --- /dev/null +++ b/plugins/experimental/stek_share/stek_utils.cc @@ -0,0 +1,82 @@ +/** @file + + stek_utils.cc - Deal with STEK + + @section license License + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "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 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + */ + +#include +#include +#include +#include +#include +#include + +#include +#include +#include + +#include "stek_utils.h" +#include "common.h" + +int +get_good_random(char *buffer, int size, int need_good_entropy) +{ + FILE *fp; + int numread = 0; + char *rand_file_name; + + /* /dev/random blocks until good entropy and can take up to 2 seconds per byte on idle machines */ + /* /dev/urandom does not have entropy check, and is very quick. + * Caller decides quality needed */ + rand_file_name = const_cast((need_good_entropy) ? /* Good & slow */ "/dev/random" : /*Fast*/ "/dev/urandom"); + + if (nullptr == (fp = fopen(rand_file_name, "r"))) { + return -1; /* failure */ + } + numread = static_cast(fread(buffer, 1, size, fp)); + fclose(fp); + + return ((numread == size) ? 0 /* success*/ : -1 /*failure*/); +} + +int +generate_new_stek(ssl_ticket_key_t *return_stek, int entropy_ensured) +{ + /* Generate a new Session-Ticket-Encryption-Key and places it into buffer + * provided return -1 on failure, 0 on success. + * if boolean global_key is set (inidcating it's the global key space), + will get global key lock before setting */ + + ssl_ticket_key_t new_key; // tmp local buffer + + /* We create key in local buff to minimize lock time on global, + * because entropy ensuring can take a very long time e.g. 2 seconds per byte of entropy*/ + if ((get_good_random(reinterpret_cast(&(new_key.aes_key)), SSL_KEY_LEN, (entropy_ensured) ? 1 : 0) != 0) || + (get_good_random(reinterpret_cast(&(new_key.hmac_secret)), SSL_KEY_LEN, (entropy_ensured) ? 1 : 0) != 0) || + (get_good_random(reinterpret_cast(&(new_key.key_name)), SSL_KEY_LEN, 0) != 0)) { + return -1; /* couldn't generate new STEK */ + } + + std::memcpy(return_stek, &new_key, SSL_TICKET_KEY_SIZE); + std::memset(&new_key, 0, SSL_TICKET_KEY_SIZE); // keep our stack clean + + return 0; /* success */ +} diff --git a/plugins/experimental/stek_share/stek_utils.h b/plugins/experimental/stek_share/stek_utils.h new file mode 100644 index 00000000000..c51a73bbbd8 --- /dev/null +++ b/plugins/experimental/stek_share/stek_utils.h @@ -0,0 +1,43 @@ +/** @file + + stek_utils.h + + @section license License + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "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 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + */ + +#pragma once + +/* STEK - Session Ticket Encryption Key stuff */ +#define STEK_MAX_LIFETIME 86400 // 24 hours max - should rotate STEK +#define STEK_NOT_CHANGED_WARNING_INTERVAL (2 * STEK_MAX_LIFETIME) // warn on non-stek rotate every X secs. +#define STEK_MAX_ENC_SIZE 512 + +#define SSL_KEY_LEN 16 + +typedef struct ssl_ticket_key // an STEK +{ + unsigned char key_name[SSL_KEY_LEN]; // tickets use this name to identify who encrypted + unsigned char hmac_secret[SSL_KEY_LEN]; + unsigned char aes_key[SSL_KEY_LEN]; +} ssl_ticket_key_t; + +#define SSL_TICKET_KEY_SIZE sizeof(ssl_ticket_key_t) + +int generate_new_stek(ssl_ticket_key_t *return_stek, int entropy_ensured); diff --git a/plugins/experimental/webp_transform/ImageTransform.cc b/plugins/experimental/webp_transform/ImageTransform.cc index 0ade23e3d88..c7497071832 100644 --- a/plugins/experimental/webp_transform/ImageTransform.cc +++ b/plugins/experimental/webp_transform/ImageTransform.cc @@ -25,7 +25,14 @@ #include "tscpp/api/Logger.h" #include "tscpp/api/Stat.h" +#if defined(__GNUC__) && !defined(__clang__) +#pragma GCC diagnostic push +#pragma GCC diagnostic ignored "-Wsuggest-override" +#endif #include +#if defined(__GNUC__) && !defined(__clang__) +#pragma GCC diagnostic pop +#endif using namespace Magick; using namespace atscppapi; diff --git a/plugins/lua/ts_lua.c b/plugins/lua/ts_lua.c index 62fa893654c..430e73505ee 100644 --- a/plugins/lua/ts_lua.c +++ b/plugins/lua/ts_lua.c @@ -73,8 +73,8 @@ static char const *const ts_lua_g_stat_strs[] = { typedef struct { ts_lua_main_ctx *main_ctx_array; - int gc_kb; // last collected gc in kb - int threads; // last collected number active threads + TSMgmtInt gc_kb; // last collected gc in kb + TSMgmtInt threads; // last collected number active threads int stat_inds[TS_LUA_IND_SIZE]; // stats indices @@ -184,8 +184,8 @@ collectStats(ts_lua_plugin_stats *const plugin_stats) ts_lua_ctx_stats *const stats = main_ctx->stats; TSMutexLock(stats->mutexp); - gc_kb_total += (TSMgmtInt)stats->gc_kb; - threads_total += (TSMgmtInt)stats->threads; + gc_kb_total += stats->gc_kb; + threads_total += stats->threads; TSMutexUnlock(stats->mutexp); } } @@ -343,9 +343,11 @@ TSRemapNewInstance(int argc, char *argv[], void **ih, char *errbuf, int errbuf_s char *inline_script = ""; int fn = 0; int states = ts_lua_max_state_count; + int ljgc = 0; static const struct option longopt[] = { {"states", required_argument, 0, 's'}, {"inline", required_argument, 0, 'i'}, + {"ljgc", required_argument, 0, 'g'}, {0, 0, 0, 0}, }; @@ -364,6 +366,10 @@ TSRemapNewInstance(int argc, char *argv[], void **ih, char *errbuf, int errbuf_s break; case 'i': inline_script = optarg; + break; + case 'g': + ljgc = atoi(optarg); + break; } if (opt == -1) { @@ -424,6 +430,10 @@ TSRemapNewInstance(int argc, char *argv[], void **ih, char *errbuf, int errbuf_s conf->states = states; conf->remap = 1; conf->init_func = 0; + conf->ref_count = 1; + conf->ljgc = ljgc; + + TSDebug(TS_LUA_DEBUG_TAG, "Reference Count = %d , creating new instance...", conf->ref_count); if (fn) { snprintf(conf->script, TS_LUA_MAX_SCRIPT_FNAME_LENGTH, "%s", script); @@ -446,6 +456,9 @@ TSRemapNewInstance(int argc, char *argv[], void **ih, char *errbuf, int errbuf_s ts_lua_script_register(ts_lua_main_ctx_array[0].lua, conf->script, conf); TSMutexUnlock(ts_lua_main_ctx_array[0].mutexp); } + } else { + conf->ref_count++; + TSDebug(TS_LUA_DEBUG_TAG, "Reference Count = %d , reference existing instance...", conf->ref_count); } *ih = conf; @@ -459,9 +472,13 @@ TSRemapDeleteInstance(void *ih) int states = ((ts_lua_instance_conf *)ih)->states; ts_lua_del_module((ts_lua_instance_conf *)ih, ts_lua_main_ctx_array, states); ts_lua_del_instance(ih); - // because we now reuse ts_lua_instance_conf / ih for remap rules sharing the same lua script - // we cannot safely free it in this function during the configuration reloads - // we therefore are leaking memory on configuration reloads + ((ts_lua_instance_conf *)ih)->ref_count--; + if (((ts_lua_instance_conf *)ih)->ref_count == 0) { + TSDebug(TS_LUA_DEBUG_TAG, "Reference Count = %d , freeing...", ((ts_lua_instance_conf *)ih)->ref_count); + TSfree(ih); + } else { + TSDebug(TS_LUA_DEBUG_TAG, "Reference Count = %d , not freeing...", ((ts_lua_instance_conf *)ih)->ref_count); + } return; } @@ -840,7 +857,7 @@ TSPluginInit(int argc, const char *argv[]) if (ret != 0) { TSError(errbuf, NULL); - TSError("[ts_lua][%s] ts_lua_add_module failed", __FUNCTION__); + TSEmergency("[ts_lua][%s] ts_lua_add_module failed", __FUNCTION__); return; } diff --git a/plugins/lua/ts_lua_common.h b/plugins/lua/ts_lua_common.h index d076ae13db5..c39d03990a2 100644 --- a/plugins/lua/ts_lua_common.h +++ b/plugins/lua/ts_lua_common.h @@ -96,6 +96,8 @@ typedef struct { int remap; int states; + int ljgc; + int ref_count; int init_func; } ts_lua_instance_conf; diff --git a/plugins/lua/ts_lua_http_config.c b/plugins/lua/ts_lua_http_config.c index 9d5463a70ae..5bcc583dd69 100644 --- a/plugins/lua/ts_lua_http_config.c +++ b/plugins/lua/ts_lua_http_config.c @@ -133,19 +133,22 @@ typedef enum { TS_LUA_CONFIG_HTTP_ALLOW_MULTI_RANGE = TS_CONFIG_HTTP_ALLOW_MULTI_RANGE, TS_LUA_CONFIG_HTTP_REQUEST_BUFFER_ENABLED = TS_CONFIG_HTTP_REQUEST_BUFFER_ENABLED, TS_LUA_CONFIG_HTTP_ALLOW_HALF_OPEN = TS_CONFIG_HTTP_ALLOW_HALF_OPEN, - TS_LUA_CONFIG_SSL_CLIENT_VERIFY_SERVER_POLICY = TS_CONFIG_SSL_CLIENT_VERIFY_SERVER_POLICY, - TS_LUA_CONFIG_SSL_CLIENT_VERIFY_SERVER_PROPERTIES = TS_CONFIG_SSL_CLIENT_VERIFY_SERVER_PROPERTIES, - TS_LUA_CONFIG_SSL_CLIENT_SNI_POLICY = TS_CONFIG_SSL_CLIENT_SNI_POLICY, - TS_LUA_CONFIG_SSL_CLIENT_PRIVATE_KEY_FILENAME = TS_CONFIG_SSL_CLIENT_PRIVATE_KEY_FILENAME, - TS_LUA_CONFIG_SSL_CLIENT_CA_CERT_FILENAME = TS_CONFIG_SSL_CLIENT_CA_CERT_FILENAME, - TS_LUA_CONFIG_HTTP_HOST_RESOLUTION_PREFERENCE = TS_CONFIG_HTTP_HOST_RESOLUTION_PREFERENCE, - TS_LUA_CONFIG_PLUGIN_VC_DEFAULT_BUFFER_INDEX = TS_CONFIG_PLUGIN_VC_DEFAULT_BUFFER_INDEX, - TS_LUA_CONFIG_PLUGIN_VC_DEFAULT_BUFFER_WATER_MARK = TS_CONFIG_PLUGIN_VC_DEFAULT_BUFFER_WATER_MARK, - TS_LUA_CONFIG_NET_SOCK_NOTSENT_LOWAT = TS_CONFIG_NET_SOCK_NOTSENT_LOWAT, - TS_LUA_CONFIG_BODY_FACTORY_RESPONSE_SUPPRESSION_MODE = TS_CONFIG_BODY_FACTORY_RESPONSE_SUPPRESSION_MODE, - TS_LUA_CONFIG_ENABLE_PARENT_TIMEOUT_MARKDOWNS = TS_CONFIG_HTTP_ENABLE_PARENT_TIMEOUT_MARKDOWNS, - TS_LUA_CONFIG_DISABLE_PARENT_MARKDOWNS = TS_CONFIG_HTTP_DISABLE_PARENT_MARKDOWNS, - TS_LUA_CONFIG_LAST_ENTRY = TS_CONFIG_LAST_ENTRY, +#if TS_VERSION_MAJOR < 10 + TS_LUA_CONFIG_SSL_CLIENT_VERIFY_SERVER = TS_CONFIG_SSL_CLIENT_VERIFY_SERVER, +#endif + TS_LUA_CONFIG_SSL_CLIENT_VERIFY_SERVER_POLICY = TS_CONFIG_SSL_CLIENT_VERIFY_SERVER_POLICY, + TS_LUA_CONFIG_SSL_CLIENT_VERIFY_SERVER_PROPERTIES = TS_CONFIG_SSL_CLIENT_VERIFY_SERVER_PROPERTIES, + TS_LUA_CONFIG_SSL_CLIENT_SNI_POLICY = TS_CONFIG_SSL_CLIENT_SNI_POLICY, + TS_LUA_CONFIG_SSL_CLIENT_PRIVATE_KEY_FILENAME = TS_CONFIG_SSL_CLIENT_PRIVATE_KEY_FILENAME, + TS_LUA_CONFIG_SSL_CLIENT_CA_CERT_FILENAME = TS_CONFIG_SSL_CLIENT_CA_CERT_FILENAME, + TS_LUA_CONFIG_HTTP_HOST_RESOLUTION_PREFERENCE = TS_CONFIG_HTTP_HOST_RESOLUTION_PREFERENCE, + TS_LUA_CONFIG_PLUGIN_VC_DEFAULT_BUFFER_INDEX = TS_CONFIG_PLUGIN_VC_DEFAULT_BUFFER_INDEX, + TS_LUA_CONFIG_PLUGIN_VC_DEFAULT_BUFFER_WATER_MARK = TS_CONFIG_PLUGIN_VC_DEFAULT_BUFFER_WATER_MARK, + TS_LUA_CONFIG_NET_SOCK_NOTSENT_LOWAT = TS_CONFIG_NET_SOCK_NOTSENT_LOWAT, + TS_LUA_CONFIG_BODY_FACTORY_RESPONSE_SUPPRESSION_MODE = TS_CONFIG_BODY_FACTORY_RESPONSE_SUPPRESSION_MODE, + TS_LUA_CONFIG_ENABLE_PARENT_TIMEOUT_MARKDOWNS = TS_CONFIG_HTTP_ENABLE_PARENT_TIMEOUT_MARKDOWNS, + TS_LUA_CONFIG_DISABLE_PARENT_MARKDOWNS = TS_CONFIG_HTTP_DISABLE_PARENT_MARKDOWNS, + TS_LUA_CONFIG_LAST_ENTRY = TS_CONFIG_LAST_ENTRY, } TSLuaOverridableConfigKey; typedef enum { @@ -267,6 +270,9 @@ ts_lua_var_item ts_lua_http_config_vars[] = { TS_LUA_MAKE_VAR_ITEM(TS_LUA_CONFIG_HTTP_ALLOW_MULTI_RANGE), TS_LUA_MAKE_VAR_ITEM(TS_LUA_CONFIG_HTTP_REQUEST_BUFFER_ENABLED), TS_LUA_MAKE_VAR_ITEM(TS_LUA_CONFIG_HTTP_ALLOW_HALF_OPEN), +#if TS_VERSION_MAJOR < 10 + TS_LUA_MAKE_VAR_ITEM(TS_CONFIG_SSL_CLIENT_VERIFY_SERVER), +#endif TS_LUA_MAKE_VAR_ITEM(TS_CONFIG_SSL_CLIENT_VERIFY_SERVER_POLICY), TS_LUA_MAKE_VAR_ITEM(TS_CONFIG_SSL_CLIENT_VERIFY_SERVER_PROPERTIES), TS_LUA_MAKE_VAR_ITEM(TS_CONFIG_SSL_CLIENT_SNI_POLICY), diff --git a/plugins/lua/ts_lua_http_intercept.c b/plugins/lua/ts_lua_http_intercept.c index d03bd0cbcdb..af867229962 100644 --- a/plugins/lua/ts_lua_http_intercept.c +++ b/plugins/lua/ts_lua_http_intercept.c @@ -22,7 +22,7 @@ static int ts_lua_http_intercept(lua_State *L); static int ts_lua_http_server_intercept(lua_State *L); static int ts_lua_http_intercept_entry(TSCont contp, TSEvent event, void *edata); -static void ts_lua_http_intercept_process(ts_lua_http_intercept_ctx *ictx, TSVConn conn); +static void ts_lua_http_intercept_process(ts_lua_http_intercept_ctx *ictx, TSCont contp, TSVConn conn); static void ts_lua_http_intercept_setup_read(ts_lua_http_intercept_ctx *ictx); static void ts_lua_http_intercept_setup_write(ts_lua_http_intercept_ctx *ictx); static int ts_lua_http_intercept_handler(TSCont contp, TSEvent event, void *edata); @@ -144,7 +144,7 @@ ts_lua_http_intercept_entry(TSCont contp, TSEvent event, void *edata) break; case TS_EVENT_NET_ACCEPT: - ts_lua_http_intercept_process(ictx, (TSVConn)edata); + ts_lua_http_intercept_process(ictx, contp, (TSVConn)edata); break; default: @@ -156,10 +156,9 @@ ts_lua_http_intercept_entry(TSCont contp, TSEvent event, void *edata) } static void -ts_lua_http_intercept_process(ts_lua_http_intercept_ctx *ictx, TSVConn conn) +ts_lua_http_intercept_process(ts_lua_http_intercept_ctx *ictx, TSCont contp, TSVConn conn) { int n; - TSCont contp; lua_State *L; TSMutex mtxp; ts_lua_cont_info *ci; @@ -167,11 +166,9 @@ ts_lua_http_intercept_process(ts_lua_http_intercept_ctx *ictx, TSVConn conn) ci = &ictx->cinfo; mtxp = ictx->cinfo.routine.mctx->mutexp; - contp = TSContCreate(ts_lua_http_intercept_handler, TSMutexCreate()); - TSContDataSet(contp, ictx); - - ci->contp = contp; ci->mutex = TSContMutexGet(contp); + ci->contp = TSContCreate(ts_lua_http_intercept_handler, TSContMutexGet(contp)); + TSContDataSet(ci->contp, ictx); ictx->net_vc = conn; diff --git a/plugins/lua/ts_lua_misc.c b/plugins/lua/ts_lua_misc.c index 8859a17bad5..ca7fa5dc96c 100644 --- a/plugins/lua/ts_lua_misc.c +++ b/plugins/lua/ts_lua_misc.c @@ -520,9 +520,11 @@ ts_lua_host_lookup_handler(TSCont contp, TSEvent event, void *edata) TSHostLookupResult result = (TSHostLookupResult)edata; struct sockaddr const *addr = TSHostLookupResultAddrGet(result); if (addr->sa_family == AF_INET) { - inet_ntop(AF_INET, (const void *)&((struct sockaddr_in *)addr)->sin_addr, cip, sizeof(cip)); + inet_ntop(AF_INET, &((struct sockaddr_in const *)addr)->sin_addr, cip, sizeof(cip)); + } else if (addr->sa_family == AF_INET6) { + inet_ntop(AF_INET6, &((struct sockaddr_in6 const *)addr)->sin6_addr, cip, sizeof(cip)); } else { - inet_ntop(AF_INET6, (const void *)&((struct sockaddr_in6 *)addr)->sin6_addr, cip, sizeof(cip)); + cip[0] = 0; } lua_pushstring(L, cip); } diff --git a/plugins/lua/ts_lua_util.c b/plugins/lua/ts_lua_util.c index 3d03aeeac4e..e2cb68b89f8 100644 --- a/plugins/lua/ts_lua_util.c +++ b/plugins/lua/ts_lua_util.c @@ -367,6 +367,13 @@ ts_lua_add_module(ts_lua_instance_conf *conf, ts_lua_main_ctx *arr, int n, int a lua_newtable(L); lua_replace(L, LUA_GLOBALSINDEX); /* L[GLOBAL] = EMPTY */ + if (conf->ljgc > 0) { + TSDebug(TS_LUA_DEBUG_TAG, "ljgc = %d, running LuaJIT Garbage Collector...", conf->ljgc); + lua_gc(L, LUA_GCCOLLECT, 0); + } else { + TSDebug(TS_LUA_DEBUG_TAG, "ljgc = %d, NOT running LuaJIT Garbage Collector...", conf->ljgc); + } + TSMutexUnlock(arr[i].mutexp); } @@ -401,12 +408,27 @@ ts_lua_del_module(ts_lua_instance_conf *conf, ts_lua_main_ctx *arr, int n) } lua_pushlightuserdata(L, conf); - lua_pushvalue(L, LUA_GLOBALSINDEX); - lua_rawset(L, LUA_REGISTRYINDEX); /* L[REG][conf] = L[GLOBAL] */ + + if (conf->ref_count > 1) { + TSDebug(TS_LUA_DEBUG_TAG, "Reference Count = %d , NOT clearing registry...", conf->ref_count); + lua_pushvalue(L, LUA_GLOBALSINDEX); + lua_rawset(L, LUA_REGISTRYINDEX); /* L[REG][conf] = L[GLOBAL] */ + } else { + TSDebug(TS_LUA_DEBUG_TAG, "Reference Count = %d , clearing registry...", conf->ref_count); + lua_pushnil(L); + lua_rawset(L, LUA_REGISTRYINDEX); /* L[REG][conf] = nil */ + } lua_newtable(L); lua_replace(L, LUA_GLOBALSINDEX); /* L[GLOBAL] = EMPTY */ + if (conf->ljgc > 0) { + TSDebug(TS_LUA_DEBUG_TAG, "ljgc = %d, running LuaJIT Garbage Collector...", conf->ljgc); + lua_gc(L, LUA_GCCOLLECT, 0); + } else { + TSDebug(TS_LUA_DEBUG_TAG, "ljgc = %d, NOT running LuaJIT Garbage Collector...", conf->ljgc); + } + TSMutexUnlock(arr[i].mutexp); } @@ -468,6 +490,13 @@ ts_lua_reload_module(ts_lua_instance_conf *conf, ts_lua_main_ctx *arr, int n) lua_newtable(L); lua_replace(L, LUA_GLOBALSINDEX); /* L[GLOBAL] = EMPTY */ + if (conf->ljgc > 0) { + TSDebug(TS_LUA_DEBUG_TAG, "ljgc = %d, running LuaJIT Garbage Collector...", conf->ljgc); + lua_gc(L, LUA_GCCOLLECT, 0); + } else { + TSDebug(TS_LUA_DEBUG_TAG, "ljgc = %d, NOT running LuaJIT Garbage Collector...", conf->ljgc); + } + TSMutexUnlock(arr[i].mutexp); } diff --git a/plugins/s3_auth/unit_tests/test_aws_auth_v4.h b/plugins/s3_auth/unit_tests/test_aws_auth_v4.h index 42f41571633..86dc566bab5 100644 --- a/plugins/s3_auth/unit_tests/test_aws_auth_v4.h +++ b/plugins/s3_auth/unit_tests/test_aws_auth_v4.h @@ -77,36 +77,36 @@ class MockTsInterface : public TsInterface { public: const char * - getMethod(int *length) + getMethod(int *length) override { *length = _method.length(); return _method.c_str(); } const char * - getHost(int *length) + getHost(int *length) override { *length = _host.length(); return _host.c_str(); } const char * - getPath(int *length) + getPath(int *length) override { *length = _path.length(); return _path.c_str(); } const char * - getQuery(int *length) + getQuery(int *length) override { *length = _query.length(); return _query.c_str(); } HeaderIterator - headerBegin() + headerBegin() override { return HeaderIterator(_headers.begin()); } HeaderIterator - headerEnd() + headerEnd() override { return HeaderIterator(_headers.end()); } diff --git a/proxy/ControlMatcher.h b/proxy/ControlMatcher.h index 1e578ca32be..f008d18246a 100644 --- a/proxy/ControlMatcher.h +++ b/proxy/ControlMatcher.h @@ -144,10 +144,10 @@ class HttpRequestData : public RequestData ink_zero(dest_ip); } - HTTPHdr *hdr = nullptr; - char *hostname_str = nullptr; - HttpApiInfo *api_info = nullptr; - time_t xact_start = 0; + HTTPHdr *hdr = nullptr; + char const *hostname_str = nullptr; + HttpApiInfo *api_info = nullptr; + time_t xact_start = 0; IpEndpoint src_ip; IpEndpoint dest_ip; uint16_t incoming_port = 0; diff --git a/proxy/ParentSelection.cc b/proxy/ParentSelection.cc index 8c0b54e0723..dc12c8c6518 100644 --- a/proxy/ParentSelection.cc +++ b/proxy/ParentSelection.cc @@ -1068,21 +1068,21 @@ EXCLUSIVE_REGRESSION_TEST(PARENTSELECTION)(RegressionTest * /* t ATS_UNUSED */, params = new ParentConfigParams(ParentTable); \ } while (0) -#define REINIT \ - do { \ - if (request != NULL) { \ - delete request->hdr; \ - ats_free(request->hostname_str); \ - delete request->api_info; \ - } \ - delete request; \ - delete result; \ - request = new HttpRequestData(); \ - result = new ParentResult(); \ - if (!result || !request) { \ - (void)printf("Allocation failed\n"); \ - return; \ - } \ +#define REINIT \ + do { \ + if (request != nullptr) { \ + delete request->hdr; \ + /* ats_free(request->hostname_str); */ \ + delete request->api_info; \ + } \ + delete request; \ + delete result; \ + request = new HttpRequestData(); \ + result = new ParentResult(); \ + if (!result || !request) { \ + (void)printf("Allocation failed\n"); \ + return; \ + } \ } while (0) #define ST(x) \ diff --git a/proxy/http/HttpConfig.cc b/proxy/http/HttpConfig.cc index c1d8c4618bc..7c60fb41ed8 100644 --- a/proxy/http/HttpConfig.cc +++ b/proxy/http/HttpConfig.cc @@ -35,6 +35,8 @@ #include #include "HttpSessionManager.h" +extern void HostDB_Config_Init(); + #define HttpEstablishStaticConfigStringAlloc(_ix, _n) \ REC_EstablishStaticConfigStringAlloc(_ix, _n); \ REC_RegisterConfigUpdateFunc(_n, http_config_cb, NULL) @@ -495,6 +497,12 @@ register_stat_callbacks() RecRegisterRawStat(http_rsb, RECT_PROCESS, "proxy.process.http.extension_method_requests", RECD_COUNTER, RECP_PERSISTENT, (int)http_extension_method_requests_stat, RecRawStatSyncCount); + RecRegisterRawStat(http_rsb, RECT_PROCESS, "proxy.process.http.http_proxy_loop_detected", RECD_COUNTER, RECP_PERSISTENT, + (int)http_proxy_loop_detected_stat, RecRawStatSyncCount); + + RecRegisterRawStat(http_rsb, RECT_PROCESS, "proxy.process.http.http_proxy_mh_loop_detected", RECD_COUNTER, RECP_PERSISTENT, + (int)http_proxy_mh_loop_detected_stat, RecRawStatSyncCount); + RecRegisterRawStat(http_rsb, RECT_PROCESS, "proxy.process.http.broken_server_connections", RECD_COUNTER, RECP_PERSISTENT, (int)http_broken_server_connections_stat, RecRawStatSyncCount); @@ -1364,7 +1372,7 @@ HttpConfig::startup() HttpEstablishStaticConfigByte(c.referer_filter_enabled, "proxy.config.http.referer_filter"); HttpEstablishStaticConfigByte(c.referer_format_redirect, "proxy.config.http.referer_format_redirect"); - HttpEstablishStaticConfigLongLong(c.oride.down_server_timeout, "proxy.config.http.down_server.cache_time"); + HostDB_Config_Init(); // Negative caching and revalidation HttpEstablishStaticConfigByte(c.oride.negative_caching_enabled, "proxy.config.http.negative_caching_enabled"); diff --git a/proxy/http/HttpConfig.h b/proxy/http/HttpConfig.h index 145fffe10fd..08e0d02e2fb 100644 --- a/proxy/http/HttpConfig.h +++ b/proxy/http/HttpConfig.h @@ -40,6 +40,8 @@ #include #include +#include + #include "tscore/ink_platform.h" #include "tscore/ink_inet.h" #include "tscore/ink_resolver.h" @@ -112,6 +114,8 @@ enum { http_purge_requests_stat, http_connect_requests_stat, http_extension_method_requests_stat, + http_proxy_loop_detected_stat, + http_proxy_mh_loop_detected_stat, http_completed_requests_stat, http_broken_server_connections_stat, @@ -686,7 +690,7 @@ struct OverridableHttpConfigParams { MgmtByte enable_parent_timeout_markdowns = 0; MgmtByte disable_parent_markdowns = 0; - MgmtInt down_server_timeout = 300; + ts_seconds down_server_timeout{300}; MgmtInt client_abort_threshold = 1000; // open read failure retries. diff --git a/proxy/http/HttpConnectionCount.cc b/proxy/http/HttpConnectionCount.cc index cd64e8d38d5..009ea8f3390 100644 --- a/proxy/http/HttpConnectionCount.cc +++ b/proxy/http/HttpConnectionCount.cc @@ -31,7 +31,7 @@ using namespace std::literals; -extern int http_config_cb(const char *, RecDataT, RecData, void *); +extern void Enable_Config_Var(std::string_view const &name, bool (*cb)(const char *, RecDataT, RecData, void *), void *cookie); OutboundConnTrack::Imp OutboundConnTrack::_imp; diff --git a/proxy/http/HttpSM.cc b/proxy/http/HttpSM.cc index 1a1236bbce5..d79181d7fc7 100644 --- a/proxy/http/HttpSM.cc +++ b/proxy/http/HttpSM.cc @@ -1868,7 +1868,7 @@ HttpSM::state_http_server_open(int event, void *data) NetVConnection *netvc = static_cast(data); UnixNetVConnection *vc = static_cast(data); PoolableSession *new_session = this->create_server_session(netvc); - if (t_state.current.request_to == HttpTransact::PARENT_PROXY) { + if (t_state.current.request_to == ResolveInfo::PARENT_PROXY) { new_session->to_parent_proxy = true; HTTP_INCREMENT_DYN_STAT(http_current_parent_proxy_connections_stat); HTTP_INCREMENT_DYN_STAT(http_total_parent_proxy_connections_stat); @@ -2231,34 +2231,28 @@ HttpSM::state_send_server_request_header(int event, void *data) } void -HttpSM::process_srv_info(HostDBInfo *r) +HttpSM::process_srv_info(HostDBRecord *record) { SMDebug("dns_srv", "beginning process_srv_info"); - t_state.hostdb_entry = Ptr(r); + t_state.dns_info.record = record; /* we didn't get any SRV records, continue w normal lookup */ - if (!r || !r->is_srv || !r->round_robin) { - t_state.dns_info.srv_hostname[0] = '\0'; - t_state.dns_info.srv_lookup_success = false; - t_state.my_txn_conf().srv_enabled = false; + if (!record || !record->is_srv()) { + t_state.dns_info.srv_hostname[0] = '\0'; + t_state.dns_info.resolved_p = false; + t_state.my_txn_conf().srv_enabled = false; SMDebug("dns_srv", "No SRV records were available, continuing to lookup %s", t_state.dns_info.lookup_name); } else { - HostDBRoundRobin *rr = r->rr(); - HostDBInfo *srv = nullptr; - if (rr) { - srv = rr->select_best_srv(t_state.dns_info.srv_hostname, &mutex->thread_holding->generator, ink_local_time(), - static_cast(t_state.txn_conf->down_server_timeout)); - } + HostDBInfo *srv = record->select_best_srv(t_state.dns_info.srv_hostname, &mutex->thread_holding->generator, ts_clock::now(), + t_state.txn_conf->down_server_timeout); if (!srv) { - t_state.dns_info.srv_lookup_success = false; - t_state.dns_info.srv_hostname[0] = '\0'; - t_state.my_txn_conf().srv_enabled = false; + // t_state.dns_info.srv_lookup_success = false; + t_state.dns_info.srv_hostname[0] = '\0'; + t_state.my_txn_conf().srv_enabled = false; SMDebug("dns_srv", "SRV records empty for %s", t_state.dns_info.lookup_name); } else { - t_state.dns_info.srv_lookup_success = true; - t_state.dns_info.srv_port = srv->data.srv.srv_port; - t_state.dns_info.srv_app = srv->app; - // t_state.dns_info.single_srv = (rr->good == 1); + t_state.dns_info.resolved_p = false; + t_state.dns_info.srv_port = srv->data.srv.srv_port; ink_assert(srv->data.srv.key == makeHostHash(t_state.dns_info.srv_hostname)); SMDebug("dns_srv", "select SRV records %s", t_state.dns_info.srv_hostname); } @@ -2267,87 +2261,43 @@ HttpSM::process_srv_info(HostDBInfo *r) } void -HttpSM::process_hostdb_info(HostDBInfo *r) +HttpSM::process_hostdb_info(HostDBRecord *record) { - // Increment the refcount to our item, since we are pointing at it - t_state.hostdb_entry = Ptr(r); + t_state.dns_info.record = record; // protect record. + + bool use_client_addr = t_state.http_config_param->use_client_target_addr == 1 && t_state.client_info.is_transparent && + t_state.dns_info.os_addr_style == ResolveInfo::OS_Addr::TRY_DEFAULT; + + t_state.dns_info.set_active(nullptr); - sockaddr const *client_addr = nullptr; - bool use_client_addr = t_state.http_config_param->use_client_target_addr == 1 && t_state.client_info.is_transparent && - t_state.dns_info.os_addr_style == HttpTransact::DNSLookupInfo::OS_Addr::OS_ADDR_TRY_DEFAULT; if (use_client_addr) { NetVConnection *vc = ua_txn ? ua_txn->get_netvc() : nullptr; if (vc) { - client_addr = vc->get_local_addr(); - // Regardless of whether the client address matches the DNS record or not, - // we want to use that address. Therefore, we copy over the client address - // info and skip the assignment from the DNS cache - ats_ip_copy(t_state.host_db_info.ip(), client_addr); - t_state.dns_info.os_addr_style = HttpTransact::DNSLookupInfo::OS_Addr::OS_ADDR_TRY_CLIENT; - t_state.dns_info.lookup_success = true; - // Leave ret unassigned, so we don't overwrite the host_db_info - } else { - use_client_addr = false; + t_state.dns_info.set_upstream_address(vc->get_local_addr()); + t_state.dns_info.os_addr_style = ResolveInfo::OS_Addr::TRY_CLIENT; } } - if (r && !r->is_failed()) { - ink_time_t now = ink_local_time(); - HostDBInfo *ret = nullptr; - t_state.dns_info.lookup_success = true; - t_state.dns_info.lookup_validated = true; - - HostDBRoundRobin *rr = r->round_robin ? r->rr() : nullptr; - if (rr) { + if (record && !record->is_failed()) { + t_state.dns_info.inbound_remote_addr = &t_state.client_info.src_addr.sa; + if (!use_client_addr) { + t_state.dns_info.set_active( + record->select_best_http(ts_clock::now(), t_state.txn_conf->down_server_timeout, t_state.dns_info.inbound_remote_addr)); + } else { // if use_client_target_addr is set, make sure the client addr is in the results pool - if (use_client_addr && rr->find_ip(client_addr) == nullptr) { + t_state.dns_info.cta_validated_p = true; + t_state.dns_info.record = record; // Cache this but do not make it active. + if (record->find(t_state.dns_info.addr) == nullptr) { SMDebug("http", "use_client_target_addr == 1. Client specified address is not in the pool, not validated."); - t_state.dns_info.lookup_validated = false; - } else { - // Since the time elapsed between current time and client_request_time - // may be very large, we cannot use client_request_time to approximate - // current time when calling select_best_http(). - ret = rr->select_best_http(&t_state.client_info.src_addr.sa, now, static_cast(t_state.txn_conf->down_server_timeout)); - // set the srv target`s last_failure - if (t_state.dns_info.srv_lookup_success) { - uint32_t last_failure = 0xFFFFFFFF; - for (int i = 0; i < rr->rrcount && last_failure != 0; ++i) { - if (last_failure > rr->info(i).app.http_data.last_failure) { - last_failure = rr->info(i).app.http_data.last_failure; - } - } - - if (last_failure != 0 && static_cast(now - t_state.txn_conf->down_server_timeout) < last_failure) { - HostDBApplicationInfo app; - app.allotment.application1 = 0; - app.allotment.application2 = 0; - app.http_data.last_failure = last_failure; - hostDBProcessor.setby_srv(t_state.dns_info.lookup_name, 0, t_state.dns_info.srv_hostname, &app); - } - } - } - } else { - if (use_client_addr && !ats_ip_addr_eq(client_addr, &r->data.ip.sa)) { - SMDebug("http", "use_client_target_addr == 1. Comparing single addresses failed, not validated."); - t_state.dns_info.lookup_validated = false; - } else { - ret = r; + t_state.dns_info.cta_validated_p = false; } } - if (ret) { - t_state.host_db_info = *ret; - ink_release_assert(!t_state.host_db_info.reverse_dns); - ink_release_assert(ats_is_ip(t_state.host_db_info.ip())); - } } else { SMDebug("http", "[%" PRId64 "] DNS lookup failed for '%s'", sm_id, t_state.dns_info.lookup_name); + } - if (!use_client_addr) { - t_state.dns_info.lookup_success = false; - } - t_state.host_db_info.app.allotment.application1 = 0; - t_state.host_db_info.app.allotment.application2 = 0; - ink_assert(!t_state.host_db_info.round_robin); + if (!t_state.dns_info.resolved_p) { + SMDebug("http", "[%" PRId64 "] resolution failed for '%s'", sm_id, t_state.dns_info.lookup_name); } milestones[TS_MILESTONE_DNS_LOOKUP_END] = Thread::get_hrtime(); @@ -2360,6 +2310,13 @@ HttpSM::process_hostdb_info(HostDBInfo *r) } } +int +HttpSM::state_pre_resolve(int event, void *data) +{ + STATE_ENTER(&HttpSM::state_hostdb_lookup, event); + return 0; +} + ////////////////////////////////////////////////////////////////////////////// // // HttpSM::state_hostdb_lookup() @@ -2378,16 +2335,16 @@ HttpSM::state_hostdb_lookup(int event, void *data) switch (event) { case EVENT_HOST_DB_LOOKUP: pending_action = nullptr; - process_hostdb_info(static_cast(data)); + process_hostdb_info(static_cast(data)); call_transact_and_set_next_state(nullptr); break; case EVENT_SRV_LOOKUP: { pending_action = nullptr; - process_srv_info(static_cast(data)); + process_srv_info(static_cast(data)); - char *host_name = t_state.dns_info.srv_lookup_success ? t_state.dns_info.srv_hostname : t_state.dns_info.lookup_name; + char const *host_name = t_state.dns_info.is_srv() ? t_state.dns_info.record->name() : t_state.dns_info.lookup_name; HostDBProcessor::Options opt; - opt.port = t_state.dns_info.srv_lookup_success ? t_state.dns_info.srv_port : t_state.server_info.dst_addr.host_order_port(); + opt.port = t_state.dns_info.is_srv() ? t_state.dns_info.srv_port : t_state.server_info.dst_addr.host_order_port(); opt.flags = (t_state.cache_info.directives.does_client_permit_dns_storing) ? HostDBProcessor::HOSTDB_DO_NOT_FORCE_DNS : HostDBProcessor::HOSTDB_FORCE_DNS_RELOAD; opt.timeout = (t_state.api_txn_dns_timeout_value != -1) ? t_state.api_txn_dns_timeout_value : 0; @@ -2422,7 +2379,7 @@ HttpSM::state_hostdb_reverse_lookup(int event, void *data) case EVENT_HOST_DB_LOOKUP: pending_action = nullptr; if (data) { - t_state.request_data.hostname_str = (static_cast(data))->hostname(); + t_state.request_data.hostname_str = (static_cast(data))->name(); } else { SMDebug("http", "[%" PRId64 "] reverse DNS lookup failed for '%s'", sm_id, t_state.dns_info.lookup_name); } @@ -2444,27 +2401,15 @@ int HttpSM::state_mark_os_down(int event, void *data) { STATE_ENTER(&HttpSM::state_mark_os_down, event); - HostDBInfo *mark_down = nullptr; if (event == EVENT_HOST_DB_LOOKUP && data) { - HostDBInfo *r = static_cast(data); - - if (r->round_robin) { - // Look for the entry we need mark down in the round robin - ink_assert(t_state.current.server != nullptr); - ink_assert(t_state.current.request_to == HttpTransact::ORIGIN_SERVER); - if (t_state.current.server) { - mark_down = r->rr()->find_ip(&t_state.current.server->dst_addr.sa); - } - } else { - // No longer a round robin, check to see if our address is the same - if (ats_ip_addr_eq(t_state.host_db_info.ip(), r->ip())) { - mark_down = r; - } - } + auto r = static_cast(data); - if (mark_down) { - mark_host_failure(mark_down, t_state.request_sent_time); + // Look for the entry we need mark down in the round robin + ink_assert(t_state.current.server != nullptr); + ink_assert(t_state.dns_info.looking_up == ResolveInfo::ORIGIN_SERVER); + if (auto *info = r->find(&t_state.dns_info.addr.sa); info != nullptr) { + info->mark_down(ts_clock::now()); } } // We either found our entry or we did not. Either way find @@ -4275,8 +4220,8 @@ HttpSM::do_hostdb_lookup() } pending_action = hostDBProcessor.getSRVbyname_imm(this, (cb_process_result_pfn)&HttpSM::process_srv_info, d, 0, opt); if (pending_action.empty()) { - char *host_name = t_state.dns_info.srv_lookup_success ? t_state.dns_info.srv_hostname : t_state.dns_info.lookup_name; - opt.port = t_state.dns_info.srv_lookup_success ? + char const *host_name = t_state.dns_info.resolved_p ? t_state.dns_info.srv_hostname : t_state.dns_info.lookup_name; + opt.port = t_state.dns_info.resolved_p ? t_state.dns_info.srv_port : t_state.server_info.dst_addr.isValid() ? t_state.server_info.dst_addr.host_order_port() : t_state.hdr_info.client_request.port_get(); @@ -4362,18 +4307,10 @@ HttpSM::track_connect_fail() const void HttpSM::do_hostdb_update_if_necessary() { - int issue_update = 0; - - if (t_state.current.server == nullptr || plugin_tunnel_type != HTTP_NO_PLUGIN_TUNNEL) { + if (t_state.current.server == nullptr || plugin_tunnel_type != HTTP_NO_PLUGIN_TUNNEL || t_state.dns_info.active == nullptr) { // No server, so update is not necessary return; } - // If we failed back over to the origin server, we don't have our - // hostdb information anymore which means we shouldn't update the hostdb - if (!ats_ip_addr_eq(&t_state.current.server->dst_addr.sa, t_state.host_db_info.ip())) { - SMDebug("http", "[%" PRId64 "] skipping hostdb update due to server failover", sm_id); - return; - } if (t_state.updated_server_version != HTTP_INVALID) { // we may have incorrectly assumed that the hostdb had the wrong version of @@ -4383,39 +4320,25 @@ HttpSM::do_hostdb_update_if_necessary() // // This test therefore just issues the update only if the hostdb version is // in fact different from the version we want the value to be updated to. - if (t_state.host_db_info.app.http_data.http_version != t_state.updated_server_version) { - t_state.host_db_info.app.http_data.http_version = t_state.updated_server_version; - issue_update |= 1; - } - - t_state.updated_server_version = HTTP_INVALID; + t_state.updated_server_version = HTTP_INVALID; + t_state.dns_info.active->http_version = t_state.updated_server_version; } + // Check to see if we need to report or clear a connection failure if (track_connect_fail()) { - issue_update |= 1; - mark_host_failure(&t_state.host_db_info, t_state.client_request_time); + this->mark_host_failure(&t_state.dns_info, ts_clock::from_time_t(t_state.client_request_time)); } else { - if (t_state.host_db_info.app.http_data.last_failure != 0) { - t_state.host_db_info.app.http_data.last_failure = 0; - t_state.host_db_info.app.http_data.fail_count = 0; - issue_update |= 1; - char addrbuf[INET6_ADDRPORTSTRLEN]; - SMDebug("http", "[%" PRId64 "] hostdb update marking IP: %s as up", sm_id, - ats_ip_nptop(&t_state.current.server->dst_addr.sa, addrbuf, sizeof(addrbuf))); - } - - if (t_state.dns_info.srv_lookup_success && t_state.dns_info.srv_app.http_data.last_failure != 0) { - t_state.dns_info.srv_app.http_data.last_failure = 0; - hostDBProcessor.setby_srv(t_state.dns_info.lookup_name, 0, t_state.dns_info.srv_hostname, &t_state.dns_info.srv_app); - SMDebug("http", "[%" PRId64 "] hostdb update marking SRV: %s as up", sm_id, t_state.dns_info.srv_hostname); + if (t_state.dns_info.mark_active_server_alive()) { + if (t_state.dns_info.record->is_srv()) { + SMDebug("http", "[%" PRId64 "] hostdb update marking SRV: %s as up", sm_id, t_state.dns_info.record->name()); + } else { + char addrbuf[INET6_ADDRPORTSTRLEN]; + SMDebug("http", "[%" PRId64 "] hostdb update marking IP: %s as up", sm_id, + ats_ip_nptop(&t_state.current.server->dst_addr.sa, addrbuf, sizeof(addrbuf))); + } } } - if (issue_update) { - hostDBProcessor.setby(t_state.current.server->name, strlen(t_state.current.server->name), &t_state.current.server->dst_addr.sa, - &t_state.host_db_info.app); - } - char addrbuf[INET6_ADDRPORTSTRLEN]; SMDebug("http", "server info = %s", ats_ip_nptop(&t_state.current.server->dst_addr.sa, addrbuf, sizeof(addrbuf))); return; @@ -4594,15 +4517,19 @@ HttpSM::parse_range_and_compare(MIMEField *field, int64_t content_length) ranges[nr]._end = end; ++nr; - if (!cache_sm.cache_read_vc->is_pread_capable() && cache_config_read_while_writer == 2) { - // write in progress, check if request range not in cache yet - HTTPInfo::FragOffset *frag_offset_tbl = t_state.cache_info.object_read->get_frag_table(); - int frag_offset_cnt = t_state.cache_info.object_read->get_frag_offset_count(); + if (cache_sm.cache_read_vc) { + if (!cache_sm.cache_read_vc->is_pread_capable() && cache_config_read_while_writer == 2) { + // write in progress, check if request range not in cache yet + HTTPInfo::FragOffset *frag_offset_tbl = t_state.cache_info.object_read->get_frag_table(); + int frag_offset_cnt = t_state.cache_info.object_read->get_frag_offset_count(); - if (!frag_offset_tbl || !frag_offset_cnt || (frag_offset_tbl[frag_offset_cnt - 1] < static_cast(end))) { - Debug("http_range", "request range in cache, end %" PRId64 ", frg_offset_cnt %d" PRId64, end, frag_offset_cnt); - t_state.range_in_cache = false; + if (!frag_offset_tbl || !frag_offset_cnt || (frag_offset_tbl[frag_offset_cnt - 1] < static_cast(end))) { + Debug("http_range", "request range in cache, end %" PRId64 ", frg_offset_cnt %d" PRId64, end, frag_offset_cnt); + t_state.range_in_cache = false; + } } + } else { + t_state.range_in_cache = false; } } @@ -4656,10 +4583,16 @@ HttpSM::calculate_output_cl(int64_t num_chars_for_ct, int64_t num_chars_for_cl) void HttpSM::do_range_parse(MIMEField *range_field) { - int num_chars_for_ct = 0; - t_state.cache_info.object_read->response_get()->value_get(MIME_FIELD_CONTENT_TYPE, MIME_LEN_CONTENT_TYPE, &num_chars_for_ct); + int num_chars_for_ct = 0; + int64_t content_length = 0; - int64_t content_length = t_state.cache_info.object_read->object_size_get(); + if (t_state.cache_info.object_read != nullptr) { + t_state.cache_info.object_read->response_get()->value_get(MIME_FIELD_CONTENT_TYPE, MIME_LEN_CONTENT_TYPE, &num_chars_for_ct); + content_length = t_state.cache_info.object_read->object_size_get(); + } else { + content_length = t_state.hdr_info.server_response.get_content_length(); + t_state.hdr_info.server_response.value_get(MIME_FIELD_CONTENT_TYPE, MIME_LEN_CONTENT_TYPE, &num_chars_for_ct); + } int64_t num_chars_for_cl = num_chars_for_int(content_length); parse_range_and_compare(range_field, content_length); @@ -4674,8 +4607,6 @@ HttpSM::do_range_setup_if_necessary() { MIMEField *field; - ink_assert(t_state.cache_info.object_read != nullptr); - field = t_state.hdr_info.client_request.field_find(MIME_FIELD_RANGE, MIME_LEN_RANGE); ink_assert(field != nullptr); @@ -4687,7 +4618,7 @@ HttpSM::do_range_setup_if_necessary() if (t_state.range_setup == HttpTransact::RANGE_REQUESTED) { bool do_transform = false; - if (!t_state.range_in_cache) { + if (!t_state.range_in_cache && t_state.cache_info.object_read) { Debug("http_range", "range can't be satisfied from cache, force origin request"); t_state.cache_lookup_result = HttpTransact::CACHE_LOOKUP_MISS; return; @@ -4705,7 +4636,12 @@ HttpSM::do_range_setup_if_necessary() t_state.range_setup = HttpTransact::RANGE_NOT_SATISFIABLE; } } else { - if (cache_sm.cache_read_vc->is_pread_capable()) { + // if revalidating and cache is stale we want to transform + if (t_state.cache_info.action == HttpTransact::CACHE_DO_REPLACE && + t_state.hdr_info.server_response.status_get() == HTTP_STATUS_OK) { + Debug("http_range", "Serving transform after stale cache re-serve"); + do_transform = true; + } else if (cache_sm.cache_read_vc && cache_sm.cache_read_vc->is_pread_capable()) { // If only one range entry and pread is capable, no need transform range t_state.range_setup = HttpTransact::RANGE_NOT_TRANSFORM_REQUESTED; } else { @@ -4717,15 +4653,34 @@ HttpSM::do_range_setup_if_necessary() if (do_transform) { if (api_hooks.get(TS_HTTP_RESPONSE_TRANSFORM_HOOK) == nullptr) { int field_content_type_len = -1; - const char *content_type = t_state.cache_info.object_read->response_get()->value_get( - MIME_FIELD_CONTENT_TYPE, MIME_LEN_CONTENT_TYPE, &field_content_type_len); + const char *content_type = nullptr; + int64_t content_length = 0; + + if (t_state.cache_info.object_read && t_state.cache_info.action != HttpTransact::CACHE_DO_REPLACE) { + content_type = t_state.cache_info.object_read->response_get()->value_get(MIME_FIELD_CONTENT_TYPE, MIME_LEN_CONTENT_TYPE, + &field_content_type_len); + content_length = t_state.cache_info.object_read->object_size_get(); + } else { + // We don't want to transform a range request if the server response has a content encoding. + if (t_state.hdr_info.server_response.presence(MIME_PRESENCE_CONTENT_ENCODING)) { + Debug("http_trans", "Cannot setup range transform for server response with content encoding"); + t_state.range_setup = HttpTransact::RANGE_NONE; + return; + } + + // Since we are transforming the range from the server, we want to cache the original response + t_state.api_info.cache_untransformed = true; + content_type = + t_state.hdr_info.server_response.value_get(MIME_FIELD_CONTENT_TYPE, MIME_LEN_CONTENT_TYPE, &field_content_type_len); + content_length = t_state.hdr_info.server_response.get_content_length(); + } Debug("http_trans", "Unable to accelerate range request, fallback to transform"); // create a Range: transform processor for requests of type Range: bytes=1-2,4-5,10-100 (eg. multiple ranges) - INKVConnInternal *range_trans = transformProcessor.range_transform( - mutex.get(), t_state.ranges, t_state.num_range_fields, &t_state.hdr_info.transform_response, content_type, - field_content_type_len, t_state.cache_info.object_read->object_size_get()); + INKVConnInternal *range_trans = transformProcessor.range_transform(mutex.get(), t_state.ranges, t_state.num_range_fields, + &t_state.hdr_info.transform_response, content_type, + field_content_type_len, content_length); api_hooks.append(TS_HTTP_RESPONSE_TRANSFORM_HOOK, range_trans); } else { // ToDo: Do we do something here? The theory is that multiple transforms do not behave well with @@ -4883,7 +4838,7 @@ HttpSM::send_origin_throttled_response() // if the request is to a parent proxy, do not reset // t_state.current.attempts so that another parent or // NextHop may be tried. - if (t_state.current.request_to != HttpTransact::PARENT_PROXY) { + if (t_state.dns_info.looking_up != ResolveInfo::PARENT_PROXY) { t_state.current.attempts = t_state.txn_conf->connect_attempts_max_retries; } t_state.current.state = HttpTransact::OUTBOUND_CONGESTION; @@ -5522,46 +5477,48 @@ HttpSM::do_transform_open() } void -HttpSM::mark_host_failure(HostDBInfo *info, time_t time_down) +HttpSM::mark_host_failure(ResolveInfo *info, ts_time time_down) { char addrbuf[INET6_ADDRPORTSTRLEN]; - if (time_down) { - // Increment the fail_count - ++info->app.http_data.fail_count; - if (info->app.http_data.fail_count >= t_state.txn_conf->connect_attempts_rr_retries) { - if (info->app.http_data.last_failure == 0) { - char *url_str = t_state.hdr_info.client_request.url_string_get(&t_state.arena, nullptr); - int host_len; - const char *host_name_ptr = t_state.unmapped_url.host_get(&host_len); - std::string_view host_name{host_name_ptr, size_t(host_len)}; - Log::error("%s", lbw() - .clip(1) - .print("CONNECT: {::s} connecting to {} for host='{}' url='{}' marking down", - ts::bwf::Errno(t_state.current.server->connect_result), t_state.current.server->dst_addr, - host_name, ts::bwf::FirstOf(url_str, "")) - .extend(1) - .write('\0') - .data()); - - if (url_str) { - t_state.arena.str_free(url_str); + if (info->active) { + if (time_down != TS_TIME_ZERO) { + // Increment the fail_count + if (++info->active->fail_count >= t_state.txn_conf->connect_attempts_rr_retries) { + if (info->active) { + if (info->active->last_failure.load() == TS_TIME_ZERO) { + char *url_str = t_state.hdr_info.client_request.url_string_get(&t_state.arena, nullptr); + int host_len; + const char *host_name_ptr = t_state.unmapped_url.host_get(&host_len); + std::string_view host_name{host_name_ptr, size_t(host_len)}; + Log::error("%s", lbw() + .clip(1) + .print("CONNECT : {::s} connecting to {} for host='{}' url='{}' marking down", + ts::bwf::Errno(t_state.current.server->connect_result), t_state.current.server->dst_addr, + host_name, ts::bwf::FirstOf(url_str, "")) + .extend(1) + .write('\0') + .data()); + + if (url_str) { + t_state.arena.str_free(url_str); + } + } + info->active->last_failure = time_down; + SMDebug("http", "[%" PRId64 "] hostdb update marking IP: %s as down", sm_id, + ats_ip_nptop(&t_state.current.server->dst_addr.sa, addrbuf, sizeof(addrbuf))); + } else { + SMDebug("http", "[%" PRId64 "] hostdb increment IP failcount %s to %d", sm_id, + ats_ip_nptop(&t_state.current.server->dst_addr.sa, addrbuf, sizeof(addrbuf)), info->active->fail_count.load()); } + } else { // Clear the failure + info->active->fail_count = 0; + info->active->last_failure = time_down; } - info->app.http_data.last_failure = time_down; - SMDebug("http", "[%" PRId64 "] hostdb update marking IP: %s as down", sm_id, - ats_ip_nptop(&t_state.current.server->dst_addr.sa, addrbuf, sizeof(addrbuf))); - } else { - SMDebug("http", "[%" PRId64 "] hostdb increment IP failcount %s to %d", sm_id, - ats_ip_nptop(&t_state.current.server->dst_addr.sa, addrbuf, sizeof(addrbuf)), info->app.http_data.fail_count); } - } else { // Clear the failure - info->app.http_data.fail_count = 0; - info->app.http_data.last_failure = time_down; } - #ifdef DEBUG - ink_assert(ink_local_time() + t_state.txn_conf->down_server_timeout > time_down); + ink_assert(std::chrono::system_clock::now() + t_state.txn_conf->down_server_timeout > time_down); #endif } @@ -5748,8 +5705,8 @@ HttpSM::handle_http_server_open() vc->apply_options(); } } + server_txn->set_inactivity_timeout(get_server_inactivity_timeout()); } - server_txn->set_inactivity_timeout(get_server_inactivity_timeout()); int method = t_state.hdr_info.server_request.method_get_wksidx(); if (method != HTTP_WKSIDX_TRACE && @@ -5831,6 +5788,7 @@ HttpSM::handle_server_setup_error(int event, void *data) } } + [[maybe_unused]] UnixNetVConnection *dbg_vc = nullptr; switch (event) { case VC_EVENT_EOS: t_state.current.state = HttpTransact::CONNECTION_CLOSED; @@ -6080,7 +6038,8 @@ HttpSM::perform_transform_cache_write_action() HttpDebugNames::get_cache_action_name(t_state.cache_info.action)); if (t_state.range_setup) { - return; + SMDebug("http", "[%" PRId64 "] perform_transform_cache_write_action %s (with range setup)", sm_id, + HttpDebugNames::get_cache_action_name(t_state.cache_info.action)); } switch (t_state.cache_info.transform_action) { @@ -6091,10 +6050,12 @@ HttpSM::perform_transform_cache_write_action() } case HttpTransact::CACHE_DO_WRITE: { - transform_cache_sm.close_read(); - t_state.cache_info.transform_write_status = HttpTransact::CACHE_WRITE_IN_PROGRESS; - setup_cache_write_transfer(&transform_cache_sm, transform_info.entry->vc, &t_state.cache_info.transform_store, - client_response_hdr_bytes, "cache write t"); + if (t_state.api_info.cache_untransformed == false) { + transform_cache_sm.close_read(); + t_state.cache_info.transform_write_status = HttpTransact::CACHE_WRITE_IN_PROGRESS; + setup_cache_write_transfer(&transform_cache_sm, transform_info.entry->vc, &t_state.cache_info.transform_store, + client_response_hdr_bytes, "cache write t"); + } break; } @@ -6267,6 +6228,10 @@ HttpSM::attach_server_session() server_connection_is_ssl = true; } + if (auto tsrs = dynamic_cast(server_vc)) { + server_ssl_reused = tsrs->getSSLOriginSessionCacheHit(); + } + server_protocol = server_txn->get_protocol_string(); // Initiate a read on the session so that the SM and not @@ -7249,11 +7214,9 @@ HttpSM::kill_this() HTTP_SM_SET_DEFAULT_HANDLER(nullptr); - if (redirect_url != nullptr) { - ats_free((void *)redirect_url); - redirect_url = nullptr; - redirect_url_len = 0; - } + ats_free(redirect_url); + redirect_url = nullptr; + redirect_url_len = 0; #ifdef USE_HTTP_DEBUG_LISTS ink_mutex_acquire(&debug_sm_list_mutex); @@ -7577,65 +7540,48 @@ HttpSM::set_next_state() } case HttpTransact::SM_ACTION_DNS_LOOKUP: { - sockaddr const *addr; - - if (t_state.api_server_addr_set) { - /* If the API has set the server address before the OS DNS lookup - * then we can skip the lookup - */ - ip_text_buffer ipb; - SMDebug("dns", "[HttpTransact::HandleRequest] Skipping DNS lookup for API supplied target %s.", - ats_ip_ntop(&t_state.server_info.dst_addr, ipb, sizeof(ipb))); - // this seems wasteful as we will just copy it right back - ats_ip_copy(t_state.host_db_info.ip(), &t_state.server_info.dst_addr); - t_state.dns_info.lookup_success = true; - call_transact_and_set_next_state(nullptr); - break; - } else if (0 == ats_ip_pton(t_state.dns_info.lookup_name, t_state.host_db_info.ip()) && - ats_is_ip_loopback(t_state.host_db_info.ip())) { - // If it's 127.0.0.1 or ::1 don't bother with hostdb - SMDebug("dns", "[HttpTransact::HandleRequest] Skipping DNS lookup for %s because it's loopback", - t_state.dns_info.lookup_name); - t_state.dns_info.lookup_success = true; - call_transact_and_set_next_state(nullptr); - break; - } else if (t_state.http_config_param->use_client_target_addr == 2 && !t_state.url_remap_success && - t_state.parent_result.result != PARENT_SPECIFIED && t_state.client_info.is_transparent && - t_state.dns_info.os_addr_style == HttpTransact::DNSLookupInfo::OS_Addr::OS_ADDR_TRY_DEFAULT && - ats_is_ip(addr = ua_txn->get_netvc()->get_local_addr())) { - /* If the connection is client side transparent and the URL - * was not remapped/directed to parent proxy, we can use the - * client destination IP address instead of doing a DNS - * lookup. This is controlled by the 'use_client_target_addr' - * configuration parameter. + if (sockaddr const *addr; t_state.http_config_param->use_client_target_addr == 2 && // no CTA verification + !t_state.url_remap_success && // wasn't remapped + t_state.parent_result.result != PARENT_SPECIFIED && // no parent. + t_state.client_info.is_transparent && // inbound transparent + t_state.dns_info.os_addr_style == ResolveInfo::OS_Addr::TRY_DEFAULT && // haven't tried anything yet. + ats_is_ip(addr = ua_txn->get_netvc()->get_local_addr())) // valid inbound remote address + { + /* If the connection is client side transparent and the URL was not remapped/directed to + * parent proxy, we can use the client destination IP address instead of doing a DNS lookup. + * This is controlled by the 'use_client_target_addr' configuration parameter. */ if (is_debug_tag_set("dns")) { ip_text_buffer ipb; SMDebug("dns", "[HttpTransact::HandleRequest] Skipping DNS lookup for client supplied target %s.", ats_ip_ntop(addr, ipb, sizeof(ipb))); } - ats_ip_copy(t_state.host_db_info.ip(), addr); - t_state.host_db_info.app.http_data.http_version = t_state.hdr_info.client_request.version_get(); - t_state.dns_info.lookup_success = true; - // cache this result so we don't have to unreliably duplicate the - // logic later if the connect fails. - t_state.dns_info.os_addr_style = HttpTransact::DNSLookupInfo::OS_Addr::OS_ADDR_TRY_CLIENT; + t_state.dns_info.set_upstream_address(addr); + + // Make a note the CTA is being used - don't do this case again. + t_state.dns_info.os_addr_style = ResolveInfo::OS_Addr::TRY_CLIENT; + + if (t_state.hdr_info.client_request.version_get() == HTTPVersion(0, 9)) { + t_state.dns_info.http_version = HTTP_0_9; + } else if (t_state.hdr_info.client_request.version_get() == HTTPVersion(1, 0)) { + t_state.dns_info.http_version = HTTP_1_0; + } else { + t_state.dns_info.http_version = HTTP_1_1; + } + call_transact_and_set_next_state(nullptr); break; - } else if (t_state.parent_result.result == PARENT_UNDEFINED && t_state.dns_info.lookup_success) { - // Already set, and we don't have a parent proxy to lookup - ink_assert(ats_is_ip(t_state.host_db_info.ip())); - SMDebug("dns", "[HttpTransact::HandleRequest] Skipping DNS lookup, provided by plugin"); + } else if (t_state.dns_info.looking_up == ResolveInfo::ORIGIN_SERVER && t_state.http_config_param->no_dns_forward_to_parent && + t_state.parent_result.result != PARENT_UNDEFINED) { + t_state.dns_info.resolved_p = true; // seems dangerous - where's the IP address? call_transact_and_set_next_state(nullptr); break; - } else if (t_state.dns_info.looking_up == HttpTransact::ORIGIN_SERVER && t_state.http_config_param->no_dns_forward_to_parent && - t_state.parent_result.result != PARENT_UNDEFINED) { - t_state.dns_info.lookup_success = true; + } else if (t_state.dns_info.resolve_immediate()) { call_transact_and_set_next_state(nullptr); break; } - + // else have to do DNS. HTTP_SM_SET_DEFAULT_HANDLER(&HttpSM::state_hostdb_lookup); // We need to close the previous attempt @@ -7663,7 +7609,7 @@ HttpSM::set_next_state() } } - ink_assert(t_state.dns_info.looking_up != HttpTransact::UNDEFINED_LOOKUP); + ink_assert(t_state.dns_info.looking_up != ResolveInfo::UNDEFINED_LOOKUP); do_hostdb_lookup(); break; } @@ -7848,7 +7794,7 @@ HttpSM::set_next_state() case HttpTransact::SM_ACTION_ORIGIN_SERVER_RR_MARK_DOWN: { HTTP_SM_SET_DEFAULT_HANDLER(&HttpSM::state_mark_os_down); - ink_assert(t_state.dns_info.looking_up == HttpTransact::ORIGIN_SERVER); + ink_assert(t_state.dns_info.looking_up == ResolveInfo::ORIGIN_SERVER); // TODO: This might not be optimal (or perhaps even correct), but it will // effectively mark the host as down. What's odd is that state_mark_os_down @@ -8116,13 +8062,13 @@ HttpSM::redirect_request(const char *arg_redirect_url, const int arg_redirect_le t_state.response_received_time = 0; t_state.next_action = HttpTransact::SM_ACTION_REDIRECT_READ; // we have a new OS and need to have DNS lookup the new OS - t_state.dns_info.lookup_success = false; - t_state.force_dns = false; + t_state.dns_info.resolved_p = false; + t_state.force_dns = false; t_state.server_info.clear(); t_state.parent_info.clear(); // Must reset whether the InkAPI has set the destination address - t_state.api_server_addr_set = false; + // t_state.dns_info.api_addr_set_p = false; if (t_state.txn_conf->cache_http) { t_state.cache_info.object_read = nullptr; diff --git a/proxy/http/HttpSM.h b/proxy/http/HttpSM.h index 340df6e4bd5..5726f4130b9 100644 --- a/proxy/http/HttpSM.h +++ b/proxy/http/HttpSM.h @@ -261,8 +261,8 @@ class HttpSM : public Continuation, public PluginUserArgs // Handles the setting of all state necessary before // calling transact to process the hostdb lookup // A NULL 'r' argument indicates the hostdb lookup failed - void process_hostdb_info(HostDBInfo *r); - void process_srv_info(HostDBInfo *r); + void process_hostdb_info(HostDBRecord *record); + void process_srv_info(HostDBRecord *record); // Called by transact. Synchronous. VConnection *do_transform_open(); @@ -405,6 +405,7 @@ class HttpSM : public Continuation, public PluginUserArgs int state_read_client_request_header(int event, void *data); int state_watch_for_client_abort(int event, void *data); int state_read_push_response_header(int event, void *data); + int state_pre_resolve(int event, void *data); int state_hostdb_lookup(int event, void *data); int state_hostdb_reverse_lookup(int event, void *data); int state_mark_os_down(int event, void *data); @@ -472,7 +473,7 @@ class HttpSM : public Continuation, public PluginUserArgs void handle_server_setup_error(int event, void *data); void handle_http_server_open(); void handle_post_failure(); - void mark_host_failure(HostDBInfo *info, time_t time_down); + void mark_host_failure(ResolveInfo *info, ts_time time_down); void release_server_session(bool serve_from_cache = false); void set_ua_abort(HttpTransact::AbortState_t ua_abort, int event); int write_header_into_buffer(HTTPHdr *h, MIOBuffer *b); @@ -546,6 +547,7 @@ class HttpSM : public Continuation, public PluginUserArgs bool client_ssl_reused = false; bool client_connection_is_ssl = false; bool is_internal = false; + bool server_ssl_reused = false; bool server_connection_is_ssl = false; bool is_waiting_for_full_body = false; bool is_using_post_buffer = false; diff --git a/proxy/http/HttpTransact.cc b/proxy/http/HttpTransact.cc index 68a9242a793..9e8b23d5c44 100644 --- a/proxy/http/HttpTransact.cc +++ b/proxy/http/HttpTransact.cc @@ -369,7 +369,7 @@ HttpTransact::is_response_valid(State *s, HTTPHdr *incoming_response) inline static ParentRetry_t response_is_retryable(HttpTransact::State *s, HTTPStatus response_code) { - if (!HttpTransact::is_response_valid(s, &s->hdr_info.server_response) || s->current.request_to != HttpTransact::PARENT_PROXY) { + if (!HttpTransact::is_response_valid(s, &s->hdr_info.server_response) || s->current.request_to != ResolveInfo::PARENT_PROXY) { return PARENT_RETRY_NONE; } if (s->response_action.handled) { @@ -488,8 +488,8 @@ update_cache_control_information_from_config(HttpTransact::State *s) bool HttpTransact::is_server_negative_cached(State *s) { - if (s->host_db_info.app.http_data.last_failure != 0 && - s->host_db_info.app.http_data.last_failure + s->txn_conf->down_server_timeout > s->client_request_time) { + if (s->dns_info.active && s->dns_info.active->last_fail_time() != TS_TIME_ZERO && + s->dns_info.active->last_fail_time() + s->txn_conf->down_server_timeout > ts_clock::from_time_t(s->client_request_time)) { return true; } else { // Make sure some nasty clock skew has not happened @@ -497,9 +497,10 @@ HttpTransact::is_server_negative_cached(State *s) // future we should tolerate bogus last failure times. This sets // the upper bound to the time that we would ever consider a server // down to 2*down_server_timeout - if (s->client_request_time + s->txn_conf->down_server_timeout < s->host_db_info.app.http_data.last_failure) { - s->host_db_info.app.http_data.last_failure = 0; - s->host_db_info.app.http_data.fail_count = 0; + if (s->dns_info.active && + ts_clock::from_time_t(s->client_request_time) + s->txn_conf->down_server_timeout < s->dns_info.active->last_fail_time()) { + s->dns_info.active->last_failure = TS_TIME_ZERO; + s->dns_info.active->fail_count = 0; ink_assert(!"extreme clock skew"); return true; } @@ -508,8 +509,8 @@ HttpTransact::is_server_negative_cached(State *s) } inline static void -update_current_info(HttpTransact::CurrentInfo *into, HttpTransact::ConnectionAttributes *from, HttpTransact::LookingUp_t who, - int attempts) +update_current_info(HttpTransact::CurrentInfo *into, HttpTransact::ConnectionAttributes *from, + ResolveInfo::UpstreamResolveStyle who, int attempts) { into->request_to = who; into->server = from; @@ -517,7 +518,7 @@ update_current_info(HttpTransact::CurrentInfo *into, HttpTransact::ConnectionAtt } inline static void -update_dns_info(HttpTransact::DNSLookupInfo *dns, HttpTransact::CurrentInfo *from) +update_dns_info(ResolveInfo *dns, HttpTransact::CurrentInfo *from) { dns->looking_up = from->request_to; dns->lookup_name = from->server->name; @@ -559,7 +560,7 @@ is_negative_caching_appropriate(HttpTransact::State *s) } } -inline static HttpTransact::LookingUp_t +inline static ResolveInfo::UpstreamResolveStyle find_server_and_update_current_info(HttpTransact::State *s) { int host_len; @@ -640,16 +641,16 @@ find_server_and_update_current_info(HttpTransact::State *s) switch (s->parent_result.result) { case PARENT_SPECIFIED: s->parent_info.name = s->arena.str_store(s->parent_result.hostname, strlen(s->parent_result.hostname)); - update_current_info(&s->current, &s->parent_info, HttpTransact::PARENT_PROXY, (s->current.attempts)++); + update_current_info(&s->current, &s->parent_info, ResolveInfo::PARENT_PROXY, (s->current.attempts)++); update_dns_info(&s->dns_info, &s->current); - ink_assert(s->dns_info.looking_up == HttpTransact::PARENT_PROXY); + ink_assert(s->dns_info.looking_up == ResolveInfo::PARENT_PROXY); s->next_hop_scheme = URL_WKSIDX_HTTP; - return HttpTransact::PARENT_PROXY; + return ResolveInfo::PARENT_PROXY; case PARENT_FAIL: // No more parents - need to return an error message - s->current.request_to = HttpTransact::HOST_NONE; - return HttpTransact::HOST_NONE; + s->current.request_to = ResolveInfo::HOST_NONE; + return ResolveInfo::HOST_NONE; case PARENT_DIRECT: // if the configuration does not allow the origin to be dns'd @@ -657,15 +658,15 @@ find_server_and_update_current_info(HttpTransact::State *s) if (s->http_config_param->no_dns_forward_to_parent) { Warning("no available parents and the config proxy.config.http.no_dns_just_forward_to_parent, prevents origin lookups."); s->parent_result.result = PARENT_FAIL; - return HttpTransact::HOST_NONE; + return ResolveInfo::HOST_NONE; } /* fall through */ default: - update_current_info(&s->current, &s->server_info, HttpTransact::ORIGIN_SERVER, (s->current.attempts)++); + update_current_info(&s->current, &s->server_info, ResolveInfo::ORIGIN_SERVER, (s->current.attempts)++); update_dns_info(&s->dns_info, &s->current); - ink_assert(s->dns_info.looking_up == HttpTransact::ORIGIN_SERVER); + ink_assert(s->dns_info.looking_up == ResolveInfo::ORIGIN_SERVER); s->next_hop_scheme = s->scheme; - return HttpTransact::ORIGIN_SERVER; + return ResolveInfo::ORIGIN_SERVER; } } @@ -765,7 +766,7 @@ does_method_effect_cache(int method) inline static HttpTransact::StateMachineAction_t how_to_open_connection(HttpTransact::State *s) { - ink_assert((s->pending_work == nullptr) || (s->current.request_to == HttpTransact::PARENT_PROXY)); + ink_assert((s->pending_work == nullptr) || (s->current.request_to == ResolveInfo::PARENT_PROXY)); // Originally we returned which type of server to open // Now, however, we may want to issue a cache @@ -1687,13 +1688,13 @@ HttpTransact::setup_plugin_request_intercept(State *s) s->scheme = s->next_hop_scheme = URL_WKSIDX_HTTP; // Set up a "fake" server server entry - update_current_info(&s->current, &s->server_info, HttpTransact::ORIGIN_SERVER, 0); + update_current_info(&s->current, &s->server_info, ResolveInfo::ORIGIN_SERVER, 0); // Also "fake" the info we'd normally get from // hostDB - s->server_info.http_version = HTTP_1_0; - s->server_info.keep_alive = HTTP_NO_KEEPALIVE; - s->host_db_info.app.http_data.http_version = HTTP_1_0; + s->server_info.http_version = HTTP_1_0; + s->server_info.keep_alive = HTTP_NO_KEEPALIVE; + s->server_info.http_version = HTTP_1_0; s->server_info.dst_addr.setToAnyAddr(AF_INET); // must set an address or we can't set the port. s->server_info.dst_addr.network_order_port() = htons(s->hdr_info.client_request.port_get()); // this is the info that matters. @@ -1753,11 +1754,21 @@ HttpTransact::HandleApiErrorJump(State *s) return; } -// PPDNSLookupAPICall does an API callout, then calls PPDNSLookup +// PPDNSLookupAPICall does an API callout if a plugin set the response_action, +// then calls PPDNSLookup. +// This is to preserve plugin hook calling behavior pre-9, which didn't call +// the TS_HTTP_OS_DNS_HOOK on PPDNSLookup. +// Since response_action is new in 9, only new plugins intentionally setting +// it will have the new behavior of TS_HTTP_OS_DNS_HOOK firing on PPDNSLookup. void HttpTransact::PPDNSLookupAPICall(State *s) { - TRANSACT_RETURN(SM_ACTION_API_OS_DNS, PPDNSLookup); + TxnDebug("http_trans", "[HttpTransact::PPDNSLookupAPICall] response_action.handled %d", s->response_action.handled); + if (!s->response_action.handled) { + TRANSACT_RETURN(SM_ACTION_DNS_LOOKUP, PPDNSLookup); + } else { + TRANSACT_RETURN(SM_ACTION_API_OS_DNS, PPDNSLookup); + } } /////////////////////////////////////////////////////////////////////////////// @@ -1785,40 +1796,36 @@ HttpTransact::PPDNSLookup(State *s) { TxnDebug("http_trans", "[HttpTransact::PPDNSLookup]"); - ink_assert(s->dns_info.looking_up == PARENT_PROXY); - if (!s->dns_info.lookup_success) { + ink_assert(s->dns_info.looking_up == ResolveInfo::PARENT_PROXY); + if (!s->dns_info.resolved_p) { // Mark parent as down due to resolving failure markParentDown(s); // DNS lookup of parent failed, find next parent or o.s. - if (find_server_and_update_current_info(s) == HttpTransact::HOST_NONE) { - ink_assert(s->current.request_to == HOST_NONE); + if (find_server_and_update_current_info(s) == ResolveInfo::HOST_NONE) { + ink_assert(s->current.request_to == ResolveInfo::HOST_NONE); handle_parent_died(s); return; } if (!s->current.server->dst_addr.isValid()) { - if (s->current.request_to == PARENT_PROXY) { - if (!s->response_action.handled) { - TRANSACT_RETURN(SM_ACTION_DNS_LOOKUP, PPDNSLookup); - } else { - TRANSACT_RETURN(SM_ACTION_DNS_LOOKUP, PPDNSLookupAPICall); - } + if (s->current.request_to == ResolveInfo::PARENT_PROXY) { + TRANSACT_RETURN(SM_ACTION_DNS_LOOKUP, PPDNSLookupAPICall); } else if (s->parent_result.result == PARENT_DIRECT && s->http_config_param->no_dns_forward_to_parent != 1) { // We ran out of parents but parent configuration allows us to go to Origin Server directly CallOSDNSLookup(s); return; } else { // We could be out of parents here if all the parents failed DNS lookup - ink_assert(s->current.request_to == HOST_NONE); + ink_assert(s->current.request_to == ResolveInfo::HOST_NONE); handle_parent_died(s); } return; } } else { // lookup succeeded, open connection to p.p. - ats_ip_copy(&s->parent_info.dst_addr, s->host_db_info.ip()); + ats_ip_copy(&s->parent_info.dst_addr, s->dns_info.addr); s->parent_info.dst_addr.network_order_port() = htons(s->parent_result.port); - get_ka_info_from_host_db(s, &s->parent_info, &s->client_info, &s->host_db_info); + get_ka_info_from_host_db(s, &s->parent_info, &s->client_info, s->dns_info.active); char addrbuf[INET6_ADDRSTRLEN]; TxnDebug("http_trans", "[PPDNSLookup] DNS lookup for sm_id[%" PRId64 "] successful IP: %s", s->state_machine->sm_id, @@ -1842,65 +1849,6 @@ HttpTransact::PPDNSLookup(State *s) s->next_action = how_to_open_connection(s); } -/////////////////////////////////////////////////////////////////////////////// -// -// Name : ReDNSRoundRobin -// Description: Called after we fail to contact part of a round-robin -// robin server set and we found a another ip address. -// -// Details : -// -// -// -// Possible Next States From Here: -// - HttpTransact::ORIGIN_SERVER_RAW_OPEN; -// - HttpTransact::ORIGIN_SERVER_OPEN; -// - HttpTransact::PROXY_INTERNAL_CACHE_NOOP; -// -/////////////////////////////////////////////////////////////////////////////// -void -HttpTransact::ReDNSRoundRobin(State *s) -{ - ink_assert(s->current.server == &s->server_info); - ink_assert(s->current.server->had_connect_fail()); - - if (s->dns_info.lookup_success) { - // We using a new server now so clear the connection - // failure mark - s->current.server->clear_connect_fail(); - - // Our ReDNS of the server succeeded so update the necessary - // information and try again. Need to preserve the current port value if possible. - in_port_t server_port = s->current.server->dst_addr.host_order_port(); - // Temporary check to make sure the port preservation can be depended upon. That should be the case - // because we get here only after trying a connection. Remove for 6.2. - ink_assert(s->current.server->dst_addr.isValid() && 0 != server_port); - - ats_ip_copy(&s->server_info.dst_addr, s->host_db_info.ip()); - s->server_info.dst_addr.network_order_port() = htons(server_port); - ats_ip_copy(&s->request_data.dest_ip, &s->server_info.dst_addr); - get_ka_info_from_host_db(s, &s->server_info, &s->client_info, &s->host_db_info); - - char addrbuf[INET6_ADDRSTRLEN]; - TxnDebug("http_trans", "[ReDNSRoundRobin] DNS lookup for O.S. successful IP: %s", - ats_ip_ntop(&s->server_info.dst_addr.sa, addrbuf, sizeof(addrbuf))); - - s->next_action = how_to_open_connection(s); - } else { - // Our ReDNS failed so output the DNS failure error message - // Set to internal server error so later logging will pick up SQUID_LOG_ERR_DNS_FAIL - build_error_response(s, HTTP_STATUS_INTERNAL_SERVER_ERROR, "Cannot find server.", Dns_error_body); - s->cache_info.action = CACHE_DO_NO_ACTION; - s->next_action = SM_ACTION_SEND_ERROR_CACHE_NOOP; - // s->next_action = PROXY_INTERNAL_CACHE_NOOP; - char *url_str = s->hdr_info.client_request.url_string_get(&s->arena, nullptr); - Log::error("%s", - lbw().clip(1).print("DNS Error: looking up {}", ts::bwf::FirstOf(url_str, "")).extend(1).write('\0').data()); - } - - return; -} - /////////////////////////////////////////////////////////////////////////////// // Name : OSDNSLookup // Description: called after the DNS lookup of origin server name @@ -1930,29 +1878,22 @@ HttpTransact::ReDNSRoundRobin(State *s) void HttpTransact::OSDNSLookup(State *s) { - ink_assert(s->dns_info.looking_up == ORIGIN_SERVER); + ink_assert(s->dns_info.looking_up == ResolveInfo::UpstreamResolveStyle::ORIGIN_SERVER); TxnDebug("http_trans", "[HttpTransact::OSDNSLookup]"); - // It's never valid to connect *to* INADDR_ANY, so let's reject the request now. - if (ats_is_ip_any(s->host_db_info.ip())) { - TxnDebug("http_trans", "[OSDNSLookup] Invalid request IP: INADDR_ANY"); - build_error_response(s, HTTP_STATUS_BAD_REQUEST, "Bad Destination Address", "request#syntax_error"); - SET_VIA_STRING(VIA_DETAIL_TUNNEL, VIA_DETAIL_TUNNEL_NO_FORWARD); - TRANSACT_RETURN(SM_ACTION_SEND_ERROR_CACHE_NOOP, nullptr); - } - - if (!s->dns_info.lookup_success) { - if (DNSLookupInfo::OS_Addr::OS_ADDR_TRY_HOSTDB == s->dns_info.os_addr_style) { - /* - * Transparent case: We tried to connect to client target address, failed and tried to use a different addr - * No HostDB data, just keep on with the CTA. + if (!s->dns_info.resolved_p) { + if (ResolveInfo::OS_Addr::TRY_HOSTDB == s->dns_info.os_addr_style) { + /* Transparent case: We tried to connect to client target address, failed and tried to use a different addr + * but that failed to resolve therefore keep on with the CTA. */ - s->dns_info.lookup_success = true; - s->dns_info.os_addr_style = DNSLookupInfo::OS_Addr::OS_ADDR_USE_CLIENT; + s->dns_info.addr.assign(s->state_machine->ua_txn->get_netvc()->get_local_addr()); // fetch CTA + s->dns_info.resolved_p = true; + s->dns_info.os_addr_style = ResolveInfo::OS_Addr::USE_CLIENT; TxnDebug("http_seq", "[HttpTransact::OSDNSLookup] DNS lookup unsuccessful, using client target address"); } else { TxnDebug("http_seq", "[HttpTransact::OSDNSLookup] DNS Lookup unsuccessful"); + char const *log_msg; // Even with unsuccessful DNS lookup, return stale object from cache if applicable if (is_cache_hit(s->cache_lookup_result) && is_stale_cache_response_returnable(s)) { @@ -1963,11 +1904,17 @@ HttpTransact::OSDNSLookup(State *s) } // output the DNS failure error message SET_VIA_STRING(VIA_DETAIL_TUNNEL, VIA_DETAIL_TUNNEL_NO_FORWARD); - // Set to internal server error so later logging will pick up SQUID_LOG_ERR_DNS_FAIL - build_error_response(s, HTTP_STATUS_INTERNAL_SERVER_ERROR, "Cannot find server.", "connect#dns_failed"); + if (!s->dns_info.record || s->dns_info.record->is_failed()) { + // Set to internal server error so later logging will pick up SQUID_LOG_ERR_DNS_FAIL + build_error_response(s, HTTP_STATUS_INTERNAL_SERVER_ERROR, "Cannot find server.", "connect#dns_failed"); + log_msg = "looking up"; + } else { + build_error_response(s, HTTP_STATUS_INTERNAL_SERVER_ERROR, "No valid server.", "connect#all_dead"); + log_msg = "no valid server"; + } char *url_str = s->hdr_info.client_request.url_string_get(&s->arena, nullptr); - Log::error("%s", - lbw().clip(1).print("DNS Error: looking up {}", ts::bwf::FirstOf(url_str, "")).extend(1).write('\0').data()); + Log::error( + "%s", lbw().clip(1).print("DNS Error: {} {}", log_msg, ts::bwf::FirstOf(url_str, "")).extend(1).write('\0').data()); // s->cache_info.action = CACHE_DO_NO_ACTION; TRANSACT_RETURN(SM_ACTION_SEND_ERROR_CACHE_NOOP, nullptr); } @@ -1975,43 +1922,43 @@ HttpTransact::OSDNSLookup(State *s) } // The dns lookup succeeded - ink_assert(s->dns_info.lookup_success); + ink_assert(s->dns_info.resolved_p); TxnDebug("http_seq", "[HttpTransact::OSDNSLookup] DNS Lookup successful"); + // It's never valid to connect *to* INADDR_ANY, so let's reject the request now. + if (ats_is_ip_any(s->dns_info.addr)) { + TxnDebug("http_trans", "[OSDNSLookup] Invalid request IP: INADDR_ANY"); + build_error_response(s, HTTP_STATUS_BAD_REQUEST, "Bad Destination Address", "request#syntax_error"); + SET_VIA_STRING(VIA_DETAIL_TUNNEL, VIA_DETAIL_TUNNEL_NO_FORWARD); + TRANSACT_RETURN(SM_ACTION_SEND_ERROR_CACHE_NOOP, nullptr); + } + // For the transparent case, nail down the kind of address we are really using - if (DNSLookupInfo::OS_Addr::OS_ADDR_TRY_HOSTDB == s->dns_info.os_addr_style) { + if (ResolveInfo::OS_Addr::TRY_HOSTDB == s->dns_info.os_addr_style) { // We've backed off from a client supplied address and found some // HostDB addresses. We use those if they're different from the CTA. // In all cases we now commit to client or HostDB for our source. - if (s->host_db_info.round_robin) { - HostDBInfo *cta = s->host_db_info.rr()->select_next(&s->current.server->dst_addr.sa); - if (cta) { - // found another addr, lock in host DB. - s->host_db_info = *cta; - s->dns_info.os_addr_style = DNSLookupInfo::OS_Addr::OS_ADDR_USE_HOSTDB; - } else { - // nothing else there, continue with CTA. - s->dns_info.os_addr_style = DNSLookupInfo::OS_Addr::OS_ADDR_USE_CLIENT; - } - } else if (ats_ip_addr_eq(s->host_db_info.ip(), &s->server_info.dst_addr.sa)) { - s->dns_info.os_addr_style = DNSLookupInfo::OS_Addr::OS_ADDR_USE_CLIENT; + if (s->dns_info.set_active(&s->current.server->dst_addr.sa) && s->dns_info.select_next_rr()) { + s->dns_info.os_addr_style = ResolveInfo::OS_Addr::USE_HOSTDB; } else { - s->dns_info.os_addr_style = DNSLookupInfo::OS_Addr::OS_ADDR_USE_HOSTDB; + // nothing else there, continue with CTA. + s->dns_info.set_active(nullptr); + s->dns_info.set_upstream_address(&s->current.server->dst_addr.sa); + s->dns_info.os_addr_style = ResolveInfo::OS_Addr::USE_CLIENT; } } - // Check to see if can fullfill expect requests based on the cached - // update some state variables with hostdb information that has - // been provided. - ats_ip_copy(&s->server_info.dst_addr, s->host_db_info.ip()); + s->server_info.dst_addr.assign(s->dns_info.addr); // If the SRV response has a port number, we should honor it. Otherwise we do the port defined in remap - if (s->dns_info.srv_lookup_success) { + if (s->dns_info.resolved_p && s->dns_info.srv_port) { s->server_info.dst_addr.network_order_port() = htons(s->dns_info.srv_port); - } else if (!s->api_server_addr_set) { + } else if (s->dns_info.os_addr_style == ResolveInfo::OS_Addr::USE_API && 0 != ats_ip_port_cast(s->dns_info.addr)) { + // Nothing - port set via API and already copied over. + } else { s->server_info.dst_addr.network_order_port() = htons(s->hdr_info.client_request.port_get()); // now we can set the port. } ats_ip_copy(&s->request_data.dest_ip, &s->server_info.dst_addr); - get_ka_info_from_host_db(s, &s->server_info, &s->client_info, &s->host_db_info); + get_ka_info_from_host_db(s, &s->server_info, &s->client_info, s->dns_info.active); char addrbuf[INET6_ADDRSTRLEN]; TxnDebug("http_trans", @@ -2022,14 +1969,17 @@ HttpTransact::OSDNSLookup(State *s) if (s->redirect_info.redirect_in_process) { // If dns lookup was not successful, the code below will handle the error. RedirectEnabled::Action action = RedirectEnabled::Action::INVALID; - if (true == Machine::instance()->is_self(s->host_db_info.ip())) { + if (true == Machine::instance()->is_self(&s->dns_info.addr.sa)) { action = s->http_config_param->redirect_actions_self_action; + TxnDebug("http_trans", "[OSDNSLookup] Self action - %d.", int(action)); } else { // Make sure the return value from contains is big enough for a void*. intptr_t x{intptr_t(RedirectEnabled::Action::INVALID)}; ink_release_assert(s->http_config_param->redirect_actions_map != nullptr); - ink_release_assert(s->http_config_param->redirect_actions_map->contains(s->host_db_info.ip(), reinterpret_cast(&x))); + ink_release_assert(s->http_config_param->redirect_actions_map->contains(s->dns_info.addr, reinterpret_cast(&x))); action = static_cast(x); + TxnDebug("http_trans", "[OSDNSLookup] Mapped action - %d for family %d.", int(action), + int(s->dns_info.active->data.ip.family())); } if (action == RedirectEnabled::Action::FOLLOW) { @@ -2064,10 +2014,11 @@ HttpTransact::OSDNSLookup(State *s) // After SM_ACTION_DNS_LOOKUP, goto the saved action/state ORIGIN_SERVER_(RAW_)OPEN. // Should we skip the StartAccessControl()? why? - if (DNSLookupInfo::OS_Addr::OS_ADDR_USE_CLIENT == s->dns_info.os_addr_style || - DNSLookupInfo::OS_Addr::OS_ADDR_USE_HOSTDB == s->dns_info.os_addr_style) { - // we've come back after already trying the server to get a better address - // and finished with all backtracking - return to trying the server. + if (ResolveInfo::OS_Addr::USE_CLIENT == s->dns_info.os_addr_style || + ResolveInfo::OS_Addr::USE_HOSTDB == s->dns_info.os_addr_style) { + // we've come back after already trying the server to get a better address, + // or we're locked on a plugin supplied address. + // therefore no more backtracking - return to trying the server. TRANSACT_RETURN(how_to_open_connection(s), HttpTransact::HandleResponse); } else if (s->dns_info.lookup_name[0] <= '9' && s->dns_info.lookup_name[0] >= '0' && s->parent_params->parent_table->hostMatch && !s->http_config_param->no_dns_forward_to_parent) { @@ -2242,14 +2193,14 @@ HttpTransact::LookupSkipOpenServer(State *s) // to a parent proxy or to the origin server. find_server_and_update_current_info(s); - if (s->current.request_to == PARENT_PROXY) { - TRANSACT_RETURN(SM_ACTION_DNS_LOOKUP, PPDNSLookup); + if (s->current.request_to == ResolveInfo::PARENT_PROXY) { + TRANSACT_RETURN(SM_ACTION_DNS_LOOKUP, PPDNSLookupAPICall); } else if (s->parent_result.result == PARENT_FAIL) { handle_parent_died(s); return; } - ink_assert(s->current.request_to == ORIGIN_SERVER); + ink_assert(s->current.request_to == ResolveInfo::ORIGIN_SERVER); // ink_assert(s->current.server->ip != 0); build_request(s, &s->hdr_info.client_request, &s->hdr_info.server_request, s->current.server->http_version); @@ -2910,18 +2861,18 @@ HttpTransact::HandleCacheOpenReadHit(State *s) // scheme & 2) If we skip down parents, every page // we serve is potentially stale // - if (s->current.request_to == ORIGIN_SERVER && is_server_negative_cached(s) && response_returnable == true && + if (s->current.request_to == ResolveInfo::ORIGIN_SERVER && is_server_negative_cached(s) && response_returnable == true && is_stale_cache_response_returnable(s) == true) { server_up = false; - update_current_info(&s->current, nullptr, UNDEFINED_LOOKUP, 0); + update_current_info(&s->current, nullptr, ResolveInfo::UNDEFINED_LOOKUP, 0); TxnDebug("http_trans", "CacheOpenReadHit - server_down, returning stale document"); } // a parent lookup could come back as PARENT_FAIL if in parent.config, go_direct == false and // there are no available parents (all down). - else if (s->current.request_to == HOST_NONE && s->parent_result.result == PARENT_FAIL) { + else if (s->current.request_to == ResolveInfo::HOST_NONE && s->parent_result.result == PARENT_FAIL) { if (response_returnable == true && is_stale_cache_response_returnable(s) == true) { server_up = false; - update_current_info(&s->current, nullptr, UNDEFINED_LOOKUP, 0); + update_current_info(&s->current, nullptr, ResolveInfo::UNDEFINED_LOOKUP, 0); TxnDebug("http_trans", "CacheOpenReadHit - server_down, returning stale document"); } else { handle_parent_died(s); @@ -2944,14 +2895,14 @@ HttpTransact::HandleCacheOpenReadHit(State *s) // through. The request will fail because of the // missing ip but we won't take down the system // - if (s->current.request_to == PARENT_PROXY) { + if (s->current.request_to == ResolveInfo::PARENT_PROXY) { // Set ourselves up to handle pending revalidate issues // after the PP DNS lookup ink_assert(s->pending_work == nullptr); s->pending_work = issue_revalidate; - TRANSACT_RETURN(SM_ACTION_DNS_LOOKUP, PPDNSLookup); - } else if (s->current.request_to == ORIGIN_SERVER) { + TRANSACT_RETURN(SM_ACTION_DNS_LOOKUP, PPDNSLookupAPICall); + } else if (s->current.request_to == ResolveInfo::ORIGIN_SERVER) { return CallOSDNSLookup(s); } else { handle_parent_died(s); @@ -3371,13 +3322,13 @@ HttpTransact::HandleCacheOpenReadMiss(State *s) return; } if (!s->current.server->dst_addr.isValid()) { - ink_release_assert(s->parent_result.result == PARENT_DIRECT || s->current.request_to == PARENT_PROXY || + ink_release_assert(s->parent_result.result == PARENT_DIRECT || s->current.request_to == ResolveInfo::PARENT_PROXY || s->http_config_param->no_dns_forward_to_parent != 0); if (s->parent_result.result == PARENT_DIRECT && s->http_config_param->no_dns_forward_to_parent != 1) { return CallOSDNSLookup(s); } - if (s->current.request_to == PARENT_PROXY) { - TRANSACT_RETURN(SM_ACTION_DNS_LOOKUP, HttpTransact::PPDNSLookup); + if (s->current.request_to == ResolveInfo::PARENT_PROXY) { + TRANSACT_RETURN(SM_ACTION_DNS_LOOKUP, HttpTransact::PPDNSLookupAPICall); } else { handle_parent_died(s); return; @@ -3485,7 +3436,7 @@ HttpTransact::HandleResponse(State *s) HTTP_INCREMENT_DYN_STAT(http_incoming_responses_stat); - ink_release_assert(s->current.request_to != UNDEFINED_LOOKUP); + ink_release_assert(s->current.request_to != ResolveInfo::UNDEFINED_LOOKUP); if (s->cache_info.action != CACHE_DO_WRITE) { ink_release_assert(s->cache_info.action != CACHE_DO_LOOKUP); ink_release_assert(s->cache_info.action != CACHE_DO_SERVE); @@ -3502,10 +3453,10 @@ HttpTransact::HandleResponse(State *s) } switch (s->current.request_to) { - case PARENT_PROXY: + case ResolveInfo::PARENT_PROXY: handle_response_from_parent(s); break; - case ORIGIN_SERVER: + case ResolveInfo::ORIGIN_SERVER: handle_response_from_server(s); break; default: @@ -3629,7 +3580,7 @@ HttpTransact::HandleStatPage(State *s) void HttpTransact::handle_response_from_parent(State *s) { - LookingUp_t next_lookup = UNDEFINED_LOOKUP; + auto next_lookup = ResolveInfo::UNDEFINED_LOOKUP; TxnDebug("http_trans", "[handle_response_from_parent] (hrfp)"); HTTP_RELEASE_ASSERT(s->current.server == &s->parent_info); @@ -3736,7 +3687,7 @@ HttpTransact::handle_response_from_parent(State *s) markParentDown(s); } s->parent_result.result = PARENT_FAIL; - next_lookup = HOST_NONE; + next_lookup = ResolveInfo::HOST_NONE; } break; } @@ -3744,17 +3695,17 @@ HttpTransact::handle_response_from_parent(State *s) // We have either tried to find a new parent or failed over to the // origin server switch (next_lookup) { - case PARENT_PROXY: - ink_assert(s->current.request_to == PARENT_PROXY); - TRANSACT_RETURN(SM_ACTION_DNS_LOOKUP, PPDNSLookup); + case ResolveInfo::PARENT_PROXY: + ink_assert(s->current.request_to == ResolveInfo::PARENT_PROXY); + TRANSACT_RETURN(SM_ACTION_DNS_LOOKUP, PPDNSLookupAPICall); break; - case ORIGIN_SERVER: + case ResolveInfo::ORIGIN_SERVER: // Next lookup is Origin Server, try DNS for Origin Server return CallOSDNSLookup(s); break; - case HOST_NONE: + case ResolveInfo::HOST_NONE: // Check if content can be served from cache - s->current.request_to = PARENT_PROXY; + s->current.request_to = ResolveInfo::PARENT_PROXY; handle_server_connection_not_open(s); break; default: @@ -3828,38 +3779,25 @@ HttpTransact::handle_response_from_server(State *s) if (is_request_retryable(s) && s->current.attempts < max_connect_retries) { // If this is a round robin DNS entry & we're tried configured // number of times, we should try another node - if (DNSLookupInfo::OS_Addr::OS_ADDR_TRY_CLIENT == s->dns_info.os_addr_style) { - // attempt was based on client supplied server address. Try again - // using HostDB. + if (ResolveInfo::OS_Addr::TRY_CLIENT == s->dns_info.os_addr_style) { + // attempt was based on client supplied server address. Try again using HostDB. // Allow DNS attempt - s->dns_info.lookup_success = false; + s->dns_info.resolved_p = false; // See if we can get data from HostDB for this. - s->dns_info.os_addr_style = DNSLookupInfo::OS_Addr::OS_ADDR_TRY_HOSTDB; + s->dns_info.os_addr_style = ResolveInfo::OS_Addr::TRY_HOSTDB; // Force host resolution to have the same family as the client. // Because this is a transparent connection, we can't switch address // families - that is locked in by the client source address. ats_force_order_by_family(&s->current.server->dst_addr.sa, s->my_txn_conf().host_res_data.order); return CallOSDNSLookup(s); - } else if ((s->dns_info.srv_lookup_success || s->host_db_info.is_rr_elt()) && - (s->txn_conf->connect_attempts_rr_retries > 0) && - ((s->current.attempts + 1) % s->txn_conf->connect_attempts_rr_retries == 0)) { - delete_server_rr_entry(s, max_connect_retries); - return; } else { + if ((s->txn_conf->connect_attempts_rr_retries > 0) && + ((s->current.attempts + 1) % s->txn_conf->connect_attempts_rr_retries == 0)) { + s->dns_info.select_next_rr(); + } retry_server_connection_not_open(s, s->current.state, max_connect_retries); TxnDebug("http_trans", "[handle_response_from_server] Error. Retrying..."); s->next_action = how_to_open_connection(s); - - if (s->api_server_addr_set) { - // If the plugin set a server address, back up to the OS_DNS hook - // to let it try another one. Force OS_ADDR_USE_CLIENT so that - // in OSDNSLoopkup, we back up to how_to_open_connections which - // will tell HttpSM to connect the origin server. - - s->dns_info.os_addr_style = DNSLookupInfo::OS_Addr::OS_ADDR_USE_CLIENT; - TRANSACT_RETURN(SM_ACTION_API_OS_DNS, OSDNSLookup); - } - return; } } else { error_log_connection_failure(s, s->current.state); @@ -3882,36 +3820,6 @@ HttpTransact::handle_response_from_server(State *s) return; } -/////////////////////////////////////////////////////////////////////////////// -// Name : delete_server_rr_entry -// Description: -// -// Details : -// -// connection to server failed mark down the server round robin entry -// -// -// Possible Next States From Here: -// -/////////////////////////////////////////////////////////////////////////////// -void -HttpTransact::delete_server_rr_entry(State *s, int max_retries) -{ - char addrbuf[INET6_ADDRSTRLEN]; - - TxnDebug("http_trans", "[%d] failed to connect to %s", s->current.attempts, - ats_ip_ntop(&s->current.server->dst_addr.sa, addrbuf, sizeof(addrbuf))); - TxnDebug("http_trans", "[delete_server_rr_entry] marking rr entry " - "down and finding next one"); - ink_assert(s->current.server->had_connect_fail()); - ink_assert(s->current.request_to == ORIGIN_SERVER); - ink_assert(s->current.server == &s->server_info); - update_dns_info(&s->dns_info, &s->current); - s->current.attempts++; - TxnDebug("http_trans", "[delete_server_rr_entry] attempts now: %d, max: %d", s->current.attempts, max_retries); - TRANSACT_RETURN(SM_ACTION_ORIGIN_SERVER_RR_MARK_DOWN, ReDNSRoundRobin); -} - void HttpTransact::error_log_connection_failure(State *s, ServerState_t conn_state) { @@ -4045,10 +3953,10 @@ HttpTransact::handle_server_connection_not_open(State *s) build_response_from_cache(s, HTTP_WARNING_CODE_REVALIDATION_FAILED); } else { switch (s->current.request_to) { - case PARENT_PROXY: + case ResolveInfo::PARENT_PROXY: handle_parent_died(s); break; - case ORIGIN_SERVER: + case ResolveInfo::ORIGIN_SERVER: handle_server_died(s); break; default: @@ -4084,7 +3992,7 @@ HttpTransact::handle_forward_server_connection_open(State *s) ink_release_assert(s->current.state == CONNECTION_ALIVE); HTTPVersion real_version = s->state_machine->get_server_version(s->hdr_info.server_response); - if (real_version != s->host_db_info.app.http_data.http_version) { + if (real_version != s->dns_info.http_version) { // Need to update the hostdb s->updated_server_version = real_version; TxnDebug("http_trans", "Update hostdb history of server HTTP version 0x%x", s->updated_server_version.get_flat_version()); @@ -4552,6 +4460,10 @@ HttpTransact::handle_cache_operation_on_forward_server_response(State *s) } else { ink_assert(s->cache_info.object_read != nullptr); s->cache_info.action = CACHE_DO_REPLACE; + + if (s->hdr_info.client_request.presence(MIME_PRESENCE_RANGE)) { + s->state_machine->do_range_setup_if_necessary(); + } } } else if (s->cache_info.action == CACHE_DO_WRITE) { @@ -4561,6 +4473,9 @@ HttpTransact::handle_cache_operation_on_forward_server_response(State *s) s->cache_info.action = CACHE_DO_NO_ACTION; } else { s->cache_info.action = CACHE_DO_WRITE; + if (s->hdr_info.client_request.presence(MIME_PRESENCE_RANGE)) { + s->state_machine->do_range_setup_if_necessary(); + } } } else if (s->cache_info.action == CACHE_DO_DELETE) { @@ -5308,22 +5223,22 @@ HttpTransact::get_ka_info_from_host_db(State *s, ConnectionAttributes *server_in break; } - if (force_http11 == true || (http11_if_hostdb == true && host_db_info->app.http_data.http_version == HTTP_1_1)) { + if (force_http11 == true || (http11_if_hostdb == true && host_db_info->http_version == HTTP_1_1)) { server_info->http_version = HTTP_1_1; server_info->keep_alive = HTTP_KEEPALIVE; - } else if (host_db_info->app.http_data.http_version == HTTP_1_0) { + } else if (host_db_info->http_version == HTTP_1_0) { server_info->http_version = HTTP_1_0; server_info->keep_alive = HTTP_KEEPALIVE; - } else if (host_db_info->app.http_data.http_version == HTTP_0_9) { + } else if (host_db_info->http_version == HTTP_0_9) { server_info->http_version = HTTP_0_9; server_info->keep_alive = HTTP_NO_KEEPALIVE; } else { ////////////////////////////////////////////// // not set yet for this host. set defaults. // ////////////////////////////////////////////// - server_info->http_version = HTTP_1_0; - server_info->keep_alive = HTTP_KEEPALIVE; - host_db_info->app.http_data.http_version = HTTP_1_0; + server_info->http_version = HTTP_1_0; + server_info->keep_alive = HTTP_KEEPALIVE; + host_db_info->http_version = HTTP_1_0; } ///////////////////////////// @@ -5872,7 +5787,7 @@ HttpTransact::initialize_state_variables_from_request(State *s, HTTPHdr *obsolet // the expanded host for cache lookup, and // // the host ip for reverse proxy. // ///////////////////////////////////////////// - s->dns_info.looking_up = ORIGIN_SERVER; + s->dns_info.looking_up = ResolveInfo::ORIGIN_SERVER; s->dns_info.lookup_name = s->server_info.name; } @@ -6274,7 +6189,7 @@ HttpTransact::is_response_cacheable(State *s, HTTPHdr *request, HTTPHdr *respons // host addresses, do not allow cache. This may cause DNS cache poisoning // of other trafficserver clients. The flag is set in the // process_host_db_info method - if (!s->dns_info.lookup_validated && s->client_info.is_transparent) { + if (!s->dns_info.cta_validated_p && s->client_info.is_transparent) { TxnDebug("http_trans", "[is_response_cacheable] " "Lookup not validated. Possible DNS cache poison. Don't cache"); return false; @@ -6676,7 +6591,7 @@ HttpTransact::will_this_request_self_loop(State *s) //////////////////////////////////////// // check if we are about to self loop // //////////////////////////////////////// - if (s->dns_info.lookup_success) { + if (s->dns_info.active) { TxnDebug("http_transact", "max_proxy_cycles = %d", max_proxy_cycles); if (max_proxy_cycles == 0) { in_port_t dst_port = s->hdr_info.client_request.url_get()->port_get(); // going to this port. @@ -6684,13 +6599,13 @@ HttpTransact::will_this_request_self_loop(State *s) // It's a loop if connecting to the same port as it already connected to the proxy and // it's a proxy address or the same address it already connected to. TxnDebug("http_transact", "dst_port = %d local_port = %d", dst_port, local_port); - if (dst_port == local_port && (ats_ip_addr_eq(s->host_db_info.ip(), &Machine::instance()->ip.sa) || - ats_ip_addr_eq(s->host_db_info.ip(), s->client_info.dst_addr))) { + if (dst_port == local_port && ((s->dns_info.active->data.ip == &Machine::instance()->ip.sa) || + (s->dns_info.active->data.ip == s->client_info.dst_addr))) { switch (s->dns_info.looking_up) { - case ORIGIN_SERVER: + case ResolveInfo::ORIGIN_SERVER: TxnDebug("http_transact", "host ip and port same as local ip and port - bailing"); break; - case PARENT_PROXY: + case ResolveInfo::PARENT_PROXY: TxnDebug("http_transact", "parent proxy ip and port same as local ip and port - bailing"); break; default: @@ -6698,6 +6613,7 @@ HttpTransact::will_this_request_self_loop(State *s) break; } SET_VIA_STRING(VIA_ERROR_TYPE, VIA_ERROR_LOOP_DETECTED); + HTTP_INCREMENT_DYN_STAT(http_proxy_loop_detected_stat); build_error_response(s, HTTP_STATUS_BAD_REQUEST, "Cycle Detected", "request#cycle_detected"); return true; } @@ -6731,6 +6647,7 @@ HttpTransact::will_this_request_self_loop(State *s) if (count > max_proxy_cycles) { TxnDebug("http_transact", "count = %d > max_proxy_cycles = %d : detected loop", count, max_proxy_cycles); SET_VIA_STRING(VIA_ERROR_TYPE, VIA_ERROR_LOOP_DETECTED); + HTTP_INCREMENT_DYN_STAT(http_proxy_mh_loop_detected_stat); build_error_response(s, HTTP_STATUS_BAD_REQUEST, "Multi-Hop Cycle Detected", "request#cycle_detected"); return true; } else { @@ -6919,7 +6836,7 @@ HttpTransact::handle_request_keep_alive_headers(State *s, HTTPVersion ver, HTTPH case KA_CONNECTION: ink_assert(s->current.server->keep_alive != HTTP_NO_KEEPALIVE); if (ver == HTTP_1_0) { - if (s->current.request_to == PARENT_PROXY && parent_is_proxy(s)) { + if (s->current.request_to == ResolveInfo::PARENT_PROXY && parent_is_proxy(s)) { heads->value_set(MIME_FIELD_PROXY_CONNECTION, MIME_LEN_PROXY_CONNECTION, "keep-alive", 10); } else { heads->value_set(MIME_FIELD_CONNECTION, MIME_LEN_CONNECTION, "keep-alive", 10); @@ -6933,7 +6850,7 @@ HttpTransact::handle_request_keep_alive_headers(State *s, HTTPVersion ver, HTTPH if (s->current.server->keep_alive != HTTP_NO_KEEPALIVE || (ver == HTTP_1_1)) { /* Had keep-alive */ s->current.server->keep_alive = HTTP_NO_KEEPALIVE; - if (s->current.request_to == PARENT_PROXY && parent_is_proxy(s)) { + if (s->current.request_to == ResolveInfo::PARENT_PROXY && parent_is_proxy(s)) { heads->value_set(MIME_FIELD_PROXY_CONNECTION, MIME_LEN_PROXY_CONNECTION, "close", 5); } else { ProxyTransaction *svr = s->state_machine->get_server_txn(); @@ -7861,7 +7778,7 @@ HttpTransact::build_request(State *s, HTTPHdr *base_request, HTTPHdr *outgoing_r if (outgoing_request->method_get_wksidx() == HTTP_WKSIDX_CONNECT) { // CONNECT method requires a target in the URL, so always force it from the Host header. outgoing_request->set_url_target_from_host_field(); - } else if (s->current.request_to == PARENT_PROXY && parent_is_proxy(s)) { + } else if (s->current.request_to == ResolveInfo::PARENT_PROXY && parent_is_proxy(s)) { // If we have a parent proxy set the URL target field. if (!outgoing_request->is_target_in_url()) { TxnDebug("http_trans", "[build_request] adding target to URL for parent proxy"); @@ -8891,7 +8808,7 @@ HttpTransact::update_size_and_time_stats(State *s, ink_hrtime total_time, ink_hr HTTP_SUM_DYN_STAT(http_user_agent_response_document_total_size_stat, user_agent_response_body_size); // proxy stats - if (s->current.request_to == HttpTransact::PARENT_PROXY) { + if (s->current.request_to == ResolveInfo::PARENT_PROXY) { HTTP_SUM_DYN_STAT(http_parent_proxy_request_total_bytes_stat, origin_server_request_header_size + origin_server_request_body_size); HTTP_SUM_DYN_STAT(http_parent_proxy_response_total_bytes_stat, diff --git a/proxy/http/HttpTransact.h b/proxy/http/HttpTransact.h index 2ec1e45af6a..11dab38df87 100644 --- a/proxy/http/HttpTransact.h +++ b/proxy/http/HttpTransact.h @@ -282,14 +282,6 @@ class HttpTransact HTTP_TRANSACT_MAGIC_SEPARATOR = 0x12345678 }; - enum LookingUp_t { - ORIGIN_SERVER, - UNDEFINED_LOOKUP, - PARENT_PROXY, - INCOMING_ROUTER, - HOST_NONE, - }; - enum ProxyMode_t { UNDEFINED_MODE, GENERIC_PROXY, @@ -574,57 +566,19 @@ class HttpTransact }; typedef struct _CurrentInfo { - ProxyMode_t mode = UNDEFINED_MODE; - LookingUp_t request_to = UNDEFINED_LOOKUP; - ConnectionAttributes *server = nullptr; - ink_time_t now = 0; - ServerState_t state = STATE_UNDEFINED; - unsigned attempts = 0; - unsigned simple_retry_attempts = 0; - unsigned unavailable_server_retry_attempts = 0; - ParentRetry_t retry_type = PARENT_RETRY_NONE; + ProxyMode_t mode = UNDEFINED_MODE; + ResolveInfo::UpstreamResolveStyle request_to = ResolveInfo::UNDEFINED_LOOKUP; + ConnectionAttributes *server = nullptr; + ink_time_t now = 0; + ServerState_t state = STATE_UNDEFINED; + unsigned attempts = 0; + unsigned simple_retry_attempts = 0; + unsigned unavailable_server_retry_attempts = 0; + ParentRetry_t retry_type = PARENT_RETRY_NONE; _CurrentInfo() {} } CurrentInfo; - typedef struct _DNSLookupInfo { - /** Origin server address source selection. - - If config says to use CTA (client target addr) state is - OS_ADDR_TRY_CLIENT, otherwise it remains the default. If the - connect fails then we switch to a USE. We go to USE_HOSTDB if - (1) the HostDB lookup is successful and (2) some address other - than the CTA is available to try. Otherwise we keep retrying - on the CTA (USE_CLIENT) up to the max retry value. In essence - we try to treat the CTA as if it were another RR value in the - HostDB record. - */ - enum class OS_Addr { - OS_ADDR_TRY_DEFAULT, ///< Initial state, use what config says. - OS_ADDR_TRY_HOSTDB, ///< Try HostDB data. - OS_ADDR_TRY_CLIENT, ///< Try client target addr. - OS_ADDR_USE_HOSTDB, ///< Force use of HostDB target address. - OS_ADDR_USE_CLIENT ///< Use client target addr, no fallback. - }; - - OS_Addr os_addr_style = OS_Addr::OS_ADDR_TRY_DEFAULT; - - bool lookup_success = false; - char *lookup_name = nullptr; - char srv_hostname[MAXDNAME] = {0}; - LookingUp_t looking_up = UNDEFINED_LOOKUP; - bool srv_lookup_success = false; - short srv_port = 0; - HostDBApplicationInfo srv_app; - - /*** Set to true by default. If use_client_target_address is set - * to 1, this value will be set to false if the client address is - * not in the DNS pool */ - bool lookup_validated = true; - - _DNSLookupInfo() {} - } DNSLookupInfo; - // Conversion handling for DNS host resolution type. static const MgmtConverter HOST_RES_CONV; @@ -672,7 +626,7 @@ class HttpTransact HttpConfigParams *http_config_param = nullptr; CacheLookupInfo cache_info; - DNSLookupInfo dns_info; + ResolveInfo dns_info; RedirectInfo redirect_info; OutboundConnTrack::TxnState outbound_conn_track_state; HTTPVersion updated_server_version = HTTP_INVALID; @@ -724,8 +678,6 @@ class HttpTransact int orig_scheme = scheme; // pre-mapped scheme int method = 0; int cause_of_death_errno = -UNKNOWN_INTERNAL_ERROR; // in - Ptr hostdb_entry; // Pointer to the entry we are referencing in hostdb-- to keep our ref - HostDBInfo host_db_info; // in ink_time_t client_request_time = UNDEFINED_TIME; // internal ink_time_t request_sent_time = UNDEFINED_TIME; // internal @@ -774,7 +726,6 @@ class HttpTransact bool api_server_request_body_set = false; bool api_req_cacheable = false; bool api_resp_cacheable = false; - bool api_server_addr_set = false; UpdateCachedObject_t api_update_cached_object = UPDATE_CACHED_OBJECT_NONE; StateMachineAction_t saved_update_next_action = SM_ACTION_UNDEFINED; CacheAction_t saved_update_cache_action = CACHE_DO_UNDEFINED; @@ -822,6 +773,7 @@ class HttpTransact init() { parent_params = ParentConfig::acquire(); + new (&dns_info) decltype(dns_info); // reset to default state. } // Constructor @@ -848,7 +800,8 @@ class HttpTransact via_string[VIA_DETAIL_SERVER_DESCRIPTOR] = VIA_DETAIL_SERVER_DESCRIPTOR_STRING; via_string[MAX_VIA_INDICES] = '\0'; - memset((void *)&host_db_info, 0, sizeof(host_db_info)); + // memset(user_args, 0, sizeof(user_args)); + // memset((void *)&host_db_info, 0, sizeof(host_db_info)); } void @@ -878,7 +831,7 @@ class HttpTransact url_map.clear(); arena.reset(); unmapped_url.clear(); - hostdb_entry.clear(); + dns_info.~ResolveInfo(); outbound_conn_track_state.clear(); delete[] ranges; @@ -922,6 +875,7 @@ class HttpTransact if (e != EIO) { this->cause_of_death_errno = e; } + Debug("http", "Setting upstream connection failure %d to %d", e, this->current.server->connect_result); } private: @@ -953,7 +907,6 @@ class HttpTransact static void CallOSDNSLookup(State *s); static void OSDNSLookup(State *s); - static void ReDNSRoundRobin(State *s); static void PPDNSLookup(State *s); static void PPDNSLookupAPICall(State *s); static void OriginServerRawOpen(State *s); diff --git a/proxy/http/PreWarmManager.cc b/proxy/http/PreWarmManager.cc index 50427a83e0a..f8d1ec5accd 100644 --- a/proxy/http/PreWarmManager.cc +++ b/proxy/http/PreWarmManager.cc @@ -27,6 +27,7 @@ #include "HttpConfig.h" #include "P_SSLSNI.h" +#include "tscore/ink_time.h" #include "tscpp/util/PostScript.h" #include @@ -41,8 +42,8 @@ namespace { using namespace std::literals; -constexpr int DOWN_SERVER_TIMEOUT = 300; -constexpr size_t STAT_NAME_BUF_LEN = 1024; +constexpr ts_seconds DOWN_SERVER_TIMEOUT = 300s; +constexpr size_t STAT_NAME_BUF_LEN = 1024; constexpr std::string_view SRV_TUNNEL_TCP = "_tunnel._tcp."sv; constexpr std::string_view CLIENT_SNI_POLICY_SERVER_NAME = "server_name"sv; @@ -265,22 +266,29 @@ PreWarmSM::state_init(int event, void *data) int PreWarmSM::state_dns_lookup(int event, void *data) { - HostDBInfo *info = static_cast(data); + HostDBRecord *record = static_cast(data); switch (event) { case EVENT_HOST_DB_LOOKUP: { _pending_action = nullptr; - if (info == nullptr || info->is_failed()) { + if (record == nullptr || record->is_failed()) { PreWarmSMVDebug("hostdb lookup is failed"); retry(); return EVENT_DONE; } + HostDBInfo *info = record->select_next_rr(ts_clock::now(), DOWN_SERVER_TIMEOUT); + + if (info == nullptr) { + PreWarmSMVDebug("hostdb lookup found no entry"); + retry(); + return EVENT_DONE; + } IpEndpoint addr; + addr.assign(info->data.ip); - ats_ip_copy(addr, info->ip()); addr.network_order_port() = htons(_dst->port); if (is_debug_tag_set("v_prewarm_sm")) { @@ -302,23 +310,19 @@ PreWarmSM::state_dns_lookup(int event, void *data) _pending_action = nullptr; std::string_view hostname; - if (info == nullptr || !info->is_srv || !info->round_robin) { + if (record == nullptr || !record->is_srv()) { // no SRV record, fallback to default lookup hostname = _dst->host; } else { - HostDBRoundRobin *rr = info->rr(); - HostDBInfo *srv = nullptr; - if (rr) { - char srv_hostname[MAXDNAME] = {0}; - - ink_hrtime now = Thread::get_hrtime(); - srv = rr->select_best_srv(srv_hostname, &mutex->thread_holding->generator, ink_hrtime_to_sec(now), DOWN_SERVER_TIMEOUT); - hostname = std::string_view(srv_hostname); - - if (srv == nullptr) { - // lookup SRV record failed, fallback to default lookup - hostname = _dst->host; - } + char srv_hostname[MAXDNAME] = {0}; + + hostname = std::string_view(srv_hostname); + + HostDBInfo *info = + record->select_best_srv(srv_hostname, &mutex->thread_holding->generator, ts_clock::now(), DOWN_SERVER_TIMEOUT); + if (info == nullptr) { + // lookup SRV record failed, fallback to default lookup + hostname = _dst->host; } } @@ -508,7 +512,7 @@ PreWarmSM::is_inactive_timeout_expired(ink_hrtime now) } void -PreWarmSM::process_hostdb_info(HostDBInfo *r) +PreWarmSM::process_hostdb_info(HostDBRecord *r) { ink_release_assert(this->handler == &PreWarmSM::state_dns_lookup); @@ -516,7 +520,7 @@ PreWarmSM::process_hostdb_info(HostDBInfo *r) } void -PreWarmSM::process_srv_info(HostDBInfo *r) +PreWarmSM::process_srv_info(HostDBRecord *r) { ink_release_assert(this->handler == &PreWarmSM::state_dns_lookup); diff --git a/proxy/http/PreWarmManager.h b/proxy/http/PreWarmManager.h index e7da819c267..ea350636571 100644 --- a/proxy/http/PreWarmManager.h +++ b/proxy/http/PreWarmManager.h @@ -192,8 +192,8 @@ class PreWarmSM : public Continuation bool is_inactive_timeout_expired(ink_hrtime now); // HostDB inline completion functions - void process_hostdb_info(HostDBInfo *r); - void process_srv_info(HostDBInfo *r); + void process_hostdb_info(HostDBRecord *r); + void process_srv_info(HostDBRecord *r); private: enum class Milestone { diff --git a/proxy/http/remap/NextHopSelectionStrategy.cc b/proxy/http/remap/NextHopSelectionStrategy.cc index 6a39028a3ea..b0cb853144f 100644 --- a/proxy/http/remap/NextHopSelectionStrategy.cc +++ b/proxy/http/remap/NextHopSelectionStrategy.cc @@ -278,7 +278,10 @@ NextHopSelectionStrategy::nextHopExists(TSHttpTxn txnp, void *ih) for (auto &hh : host_groups[gg]) { HostRecord *p = hh.get(); if (p->available.load()) { - NH_Debug(NH_DEBUG_TAG, "[%" PRIu64 "] found available next hop %s", sm_id, p->hostname.c_str()); + NH_Debug(NH_DEBUG_TAG, + "[%" PRIu64 "] found available next hop %s (this is NOT necessarily the parent which will be selected, just the " + "first available parent found)", + sm_id, p->hostname.c_str()); return true; } } @@ -390,13 +393,19 @@ template <> struct convert { } else if (map["scheme"].Scalar() == "https") { nh.scheme = NH_SCHEME_HTTPS; } else { - nh.scheme = NH_SCHEME_NONE; + throw YAML::ParserException(map["scheme"].Mark(), "no valid scheme defined, valid schemes are http or https"); } + } else { + throw YAML::ParserException(map["scheme"].Mark(), "no scheme defined, valid schemes are http or https"); } if (map["port"]) { nh.port = map["port"].as(); - if ((nh.port <= 0) || (nh.port > 65535)) { - throw YAML::ParserException(map["port"].Mark(), "port number must be in (inclusive) range 0 - 65,536"); + if (nh.port <= 0 || nh.port > 65535) { + throw YAML::ParserException(map["port"].Mark(), "port number must be in (inclusive) range 1 - 65,536"); + } + } else { + if (nh.port == 0) { + throw YAML::ParserException(map["port"].Mark(), "no port defined must be in (inclusive) range 1 - 65,536"); } } if (map["health_check_url"]) { diff --git a/proxy/http/remap/PluginDso.h b/proxy/http/remap/PluginDso.h index 9e6df2d1a74..96e9dd8bbc7 100644 --- a/proxy/http/remap/PluginDso.h +++ b/proxy/http/remap/PluginDso.h @@ -87,8 +87,8 @@ class PluginDso : public PluginThreadContext virtual bool init(std::string &error) = 0; virtual void done() = 0; - void acquire(); - void release(); + void acquire() override; + void release() override; void incInstanceCount(); void decInstanceCount(); diff --git a/proxy/http/remap/RemapConfig.cc b/proxy/http/remap/RemapConfig.cc index 2089fb4bd79..61afbd70221 100644 --- a/proxy/http/remap/RemapConfig.cc +++ b/proxy/http/remap/RemapConfig.cc @@ -899,11 +899,10 @@ process_regex_mapping_config(const char *from_host_lower, url_mapping *new_mappi return true; lFail: - if (reg_map->to_url_host_template) { - ats_free(reg_map->to_url_host_template); - reg_map->to_url_host_template = nullptr; - reg_map->to_url_host_template_len = 0; - } + ats_free(reg_map->to_url_host_template); + reg_map->to_url_host_template = nullptr; + reg_map->to_url_host_template_len = 0; + return false; } diff --git a/proxy/http/remap/UrlMapping.h b/proxy/http/remap/UrlMapping.h index c826c4acebe..bb25e36ad75 100644 --- a/proxy/http/remap/UrlMapping.h +++ b/proxy/http/remap/UrlMapping.h @@ -64,10 +64,8 @@ class redirect_tag_str ~redirect_tag_str() { type = 0; - if (chunk_str) { - ats_free(chunk_str); - chunk_str = nullptr; - } + ats_free(chunk_str); + chunk_str = nullptr; } redirect_tag_str *next = nullptr; diff --git a/proxy/http/remap/UrlRewrite.cc b/proxy/http/remap/UrlRewrite.cc index 85dd19f5fdc..96de22b3a14 100644 --- a/proxy/http/remap/UrlRewrite.cc +++ b/proxy/http/remap/UrlRewrite.cc @@ -957,9 +957,7 @@ UrlRewrite::_destroyList(RegexMappingList &mappings) RegexMapping *list_iter; while ((list_iter = mappings.pop()) != nullptr) { delete list_iter->url_map; - if (list_iter->to_url_host_template) { - ats_free(list_iter->to_url_host_template); - } + ats_free(list_iter->to_url_host_template); delete list_iter; } mappings.clear(); diff --git a/proxy/http/remap/unit-tests/nexthop_test_stubs.cc b/proxy/http/remap/unit-tests/nexthop_test_stubs.cc index 5213eb9367f..9056512617a 100644 --- a/proxy/http/remap/unit-tests/nexthop_test_stubs.cc +++ b/proxy/http/remap/unit-tests/nexthop_test_stubs.cc @@ -86,7 +86,6 @@ br_destroy(HttpSM &sm) } delete h->hdr; delete h->api_info; - ats_free(h->hostname_str); } void @@ -102,10 +101,7 @@ build_request(int64_t sm_id, HttpSM *sm, sockaddr_in *ip, const char *os_hostnam } sm->t_state.request_data.hdr = new HTTPHdr(); sm->t_state.request_data.hdr->create(HTTP_TYPE_REQUEST, myHeap); - if (sm->t_state.request_data.hostname_str != nullptr) { - ats_free(sm->t_state.request_data.hostname_str); - } - sm->t_state.request_data.hostname_str = ats_strdup(os_hostname); + sm->t_state.request_data.hostname_str = sm->t_state.arena.str_store(os_hostname, strlen(os_hostname)); sm->t_state.request_data.xact_start = time(nullptr); ink_zero(sm->t_state.request_data.src_ip); ink_zero(sm->t_state.request_data.dest_ip); diff --git a/proxy/http/remap/unit-tests/test_PluginDso.cc b/proxy/http/remap/unit-tests/test_PluginDso.cc index 2db5d1c43fe..5939b70a733 100644 --- a/proxy/http/remap/unit-tests/test_PluginDso.cc +++ b/proxy/http/remap/unit-tests/test_PluginDso.cc @@ -69,20 +69,20 @@ class PluginDsoUnitTest : public PluginDso } virtual void - indicatePreReload() + indicatePreReload() override { } virtual void - indicatePostReload(TSRemapReloadStatus reloadStatus) + indicatePostReload(TSRemapReloadStatus reloadStatus) override { } virtual bool - init(std::string &error) + init(std::string &error) override { return true; } virtual void - done() + done() override { } }; diff --git a/proxy/http/remap/unit-tests/test_PluginFactory.cc b/proxy/http/remap/unit-tests/test_PluginFactory.cc index 4cd3c25ff8a..0c0d3c96f62 100644 --- a/proxy/http/remap/unit-tests/test_PluginFactory.cc +++ b/proxy/http/remap/unit-tests/test_PluginFactory.cc @@ -78,7 +78,7 @@ class PluginFactoryUnitTest : public PluginFactory protected: const char * - getUuid() + getUuid() override { return _tempComponent.c_str(); } diff --git a/proxy/http2/HTTP2.cc b/proxy/http2/HTTP2.cc index f44a317a114..6959e7d222a 100644 --- a/proxy/http2/HTTP2.cc +++ b/proxy/http2/HTTP2.cc @@ -606,7 +606,7 @@ http2_convert_header_from_1_1_to_2(HTTPHdr *headers) // :path if (MIMEField *field = headers->field_find(HTTP2_VALUE_PATH, HTTP2_LEN_PATH); field != nullptr) { - int value_len; + int value_len = 0; const char *value = headers->path_get(&value_len); ts::LocalBuffer buf(value_len + 1); diff --git a/proxy/http2/Http2Stream.cc b/proxy/http2/Http2Stream.cc index a453c237790..a2bb06f3230 100644 --- a/proxy/http2/Http2Stream.cc +++ b/proxy/http2/Http2Stream.cc @@ -130,9 +130,8 @@ Http2Stream::~Http2Stream() read_vio.mutex.clear(); write_vio.mutex.clear(); - if (header_blocks) { - ats_free(header_blocks); - } + ats_free(header_blocks); + _clear_timers(); clear_io_events(); http_parser_clear(&http_parser); diff --git a/proxy/http3/Http3SessionAccept.h b/proxy/http3/Http3SessionAccept.h index 5c872261a37..d45331dda7e 100644 --- a/proxy/http3/Http3SessionAccept.h +++ b/proxy/http3/Http3SessionAccept.h @@ -43,8 +43,8 @@ class Http3SessionAccept : public SessionAccept explicit Http3SessionAccept(const HttpSessionAccept::Options &); ~Http3SessionAccept(); - bool accept(NetVConnection *, MIOBuffer *, IOBufferReader *); - int mainEvent(int event, void *netvc); + bool accept(NetVConnection *, MIOBuffer *, IOBufferReader *) override; + int mainEvent(int event, void *netvc) override; private: Http3SessionAccept(const Http3SessionAccept &); diff --git a/proxy/http3/Makefile.am b/proxy/http3/Makefile.am index 979f3a656e9..7a0ea023a81 100644 --- a/proxy/http3/Makefile.am +++ b/proxy/http3/Makefile.am @@ -71,6 +71,7 @@ test_CPPFLAGS = \ test_LDADD = \ $(top_builddir)/iocore/net/quic/libquic.a \ + $(top_builddir)/iocore/net/TLSKeyLogger.o \ $(top_builddir)/iocore/eventsystem/libinkevent.a \ $(top_builddir)/lib/records/librecords_p.a \ $(top_builddir)/mgmt/libmgmt_p.la \ diff --git a/proxy/http3/QPACK.cc b/proxy/http3/QPACK.cc index ca937f751d7..6aec8f86614 100644 --- a/proxy/http3/QPACK.cc +++ b/proxy/http3/QPACK.cc @@ -1823,10 +1823,8 @@ QPACK::DynamicTableStorage::DynamicTableStorage(uint16_t size) : _head(size * 2 QPACK::DynamicTableStorage::~DynamicTableStorage() { - if (this->_data) { - ats_free(this->_data); - this->_data = nullptr; - } + ats_free(this->_data); + this->_data = nullptr; } void diff --git a/proxy/logging/Log.cc b/proxy/logging/Log.cc index c20859353f8..6c5d34b8992 100644 --- a/proxy/logging/Log.cc +++ b/proxy/logging/Log.cc @@ -747,6 +747,11 @@ Log::init_fields() global_field_list.add(field, false); field_symbol_hash.emplace("pqssl", field); + field = new LogField("proxy_req_ssl_reused", "pqssr", LogField::dINT, &LogAccess::marshal_proxy_req_ssl_reused, + &LogAccess::unmarshal_int_to_str); + global_field_list.add(field, false); + field_symbol_hash.emplace("pqssr", field); + field = new LogField("proxy_request_all_header_fields", "pqah", LogField::STRING, &LogAccess::marshal_proxy_req_all_header_fields, &LogUtils::unmarshalMimeHdr); global_field_list.add(field, false); diff --git a/proxy/logging/LogAccess.cc b/proxy/logging/LogAccess.cc index f5c1a388317..7fe9a9a9ff3 100644 --- a/proxy/logging/LogAccess.cc +++ b/proxy/logging/LogAccess.cc @@ -2312,6 +2312,15 @@ LogAccess::marshal_proxy_req_is_ssl(char *buf) return INK_MIN_ALIGN; } +int +LogAccess::marshal_proxy_req_ssl_reused(char *buf) +{ + if (buf) { + marshal_int(buf, m_http_sm->server_ssl_reused ? 1 : 0); + } + return INK_MIN_ALIGN; +} + /*------------------------------------------------------------------------- -------------------------------------------------------------------------*/ diff --git a/proxy/logging/LogAccess.h b/proxy/logging/LogAccess.h index 5dba8d8085e..049cd61d890 100644 --- a/proxy/logging/LogAccess.h +++ b/proxy/logging/LogAccess.h @@ -189,6 +189,7 @@ class LogAccess int marshal_proxy_host_name(char *); // STR int marshal_proxy_host_ip(char *); // STR int marshal_proxy_req_is_ssl(char *); // INT + int marshal_proxy_req_ssl_reused(char *); // INT int marshal_proxy_req_all_header_fields(char *); // STR // diff --git a/proxy/logging/LogFormat.cc b/proxy/logging/LogFormat.cc index 330bc190576..c1f1901892d 100644 --- a/proxy/logging/LogFormat.cc +++ b/proxy/logging/LogFormat.cc @@ -142,21 +142,19 @@ LogFormat::init_variables(const char *name, const char *fieldlist_str, const cha m_agg_marshal_space = static_cast(ats_malloc(m_field_count * INK_MIN_ALIGN)); } - if (m_name_str) { - ats_free(m_name_str); - m_name_str = nullptr; - m_name_id = 0; - } + ats_free(m_name_str); + m_name_str = nullptr; + m_name_id = 0; + if (name) { m_name_str = ats_strdup(name); m_name_id = id_from_name(m_name_str); } - if (m_fieldlist_str) { - ats_free(m_fieldlist_str); - m_fieldlist_str = nullptr; - m_fieldlist_id = 0; - } + ats_free(m_fieldlist_str); + m_fieldlist_str = nullptr; + m_fieldlist_id = 0; + if (fieldlist_str) { m_fieldlist_str = ats_strdup(fieldlist_str); m_fieldlist_id = id_from_name(m_fieldlist_str); diff --git a/src/traffic_layout/info.cc b/src/traffic_layout/info.cc index 68a39c9c751..a54a1b10f49 100644 --- a/src/traffic_layout/info.cc +++ b/src/traffic_layout/info.cc @@ -30,6 +30,10 @@ #include "RecordsConfig.h" #include "info.h" +#if TS_USE_HWLOC +#include +#endif + #if HAVE_ZLIB_H #include #endif diff --git a/src/traffic_server/InkAPI.cc b/src/traffic_server/InkAPI.cc index 4db07a10c51..7fb028f72b1 100644 --- a/src/traffic_server/InkAPI.cc +++ b/src/traffic_server/InkAPI.cc @@ -850,12 +850,10 @@ FileImpl::fclose() m_mode = CLOSED; } - if (m_buf) { - ats_free(m_buf); - m_buf = nullptr; - m_bufsize = 0; - m_bufpos = 0; - } + ats_free(m_buf); + m_buf = nullptr; + m_bufsize = 0; + m_bufpos = 0; } ssize_t @@ -5897,12 +5895,11 @@ TSHttpTxnServerAddrSet(TSHttpTxn txnp, struct sockaddr const *addr) sdk_assert(sdk_sanity_check_txn(txnp) == TS_SUCCESS); HttpSM *sm = reinterpret_cast(txnp); - if (ats_ip_copy(&sm->t_state.server_info.dst_addr.sa, addr)) { - sm->t_state.api_server_addr_set = true; + if (sm->t_state.dns_info.set_upstream_address(addr)) { + sm->t_state.dns_info.os_addr_style = ResolveInfo::OS_Addr::USE_API; return TS_SUCCESS; - } else { - return TS_ERROR; } + return TS_ERROR; } void @@ -6536,6 +6533,72 @@ TSHttpTxnStatusGet(TSHttpTxn txnp) return static_cast(sm->t_state.http_return_code); } +#if TS_VERSION_MAJOR < 10 +/* control channel for HTTP */ +TSReturnCode +TSHttpTxnCntl(TSHttpTxn txnp, TSHttpCntlTypeExperimental cntl, void *data) +{ + sdk_assert(sdk_sanity_check_txn(txnp) == TS_SUCCESS); + + HttpSM *sm = (HttpSM *)txnp; + + switch (cntl) { + case TS_HTTP_CNTL_GET_LOGGING_MODE: { + if (data == nullptr) { + return TS_ERROR; + } + + intptr_t *rptr = static_cast(data); + + if (sm->t_state.api_info.logging_enabled) { + *rptr = (intptr_t)TS_HTTP_CNTL_ON; + } else { + *rptr = (intptr_t)TS_HTTP_CNTL_OFF; + } + + return TS_SUCCESS; + } + + case TS_HTTP_CNTL_SET_LOGGING_MODE: + if (data != TS_HTTP_CNTL_ON && data != TS_HTTP_CNTL_OFF) { + return TS_ERROR; + } else { + sm->t_state.api_info.logging_enabled = (bool)data; + return TS_SUCCESS; + } + break; + + case TS_HTTP_CNTL_GET_INTERCEPT_RETRY_MODE: { + if (data == nullptr) { + return TS_ERROR; + } + + intptr_t *rptr = static_cast(data); + + if (sm->t_state.api_info.retry_intercept_failures) { + *rptr = (intptr_t)TS_HTTP_CNTL_ON; + } else { + *rptr = (intptr_t)TS_HTTP_CNTL_OFF; + } + + return TS_SUCCESS; + } + + case TS_HTTP_CNTL_SET_INTERCEPT_RETRY_MODE: + if (data != TS_HTTP_CNTL_ON && data != TS_HTTP_CNTL_OFF) { + return TS_ERROR; + } else { + sm->t_state.api_info.retry_intercept_failures = (bool)data; + return TS_SUCCESS; + } + default: + return TS_ERROR; + } + + return TS_ERROR; +} + +#endif TSReturnCode TSHttpTxnCntlSet(TSHttpTxn txnp, TSHttpCntlType cntl, bool data) { @@ -7533,6 +7596,30 @@ TSNetAcceptNamedProtocol(TSCont contp, const char *protocol) } /* DNS Lookups */ +/// Context structure for the lookup callback to the plugin. +struct TSResolveInfo { + IpEndpoint addr; ///< Lookup result. + HostDBRecord *record = nullptr; ///< Record for the FQDN. +}; + +int +TSHostLookupTrampoline(TSCont contp, TSEvent ev, void *data) +{ + auto c = reinterpret_cast(contp); + // Set up the local context. + TSResolveInfo ri; + ri.record = static_cast(data); + if (ri.record) { + ri.record->rr_info()[0].data.ip.toSockAddr(ri.addr); + } + auto *target = reinterpret_cast(c->mdata); + // Deliver the message. + target->handleEvent(ev, &ri); + // Cleanup. + c->destroy(); + return TS_SUCCESS; +}; + TSAction TSHostLookup(TSCont contp, const char *hostname, size_t namelen) { @@ -7542,16 +7629,23 @@ TSHostLookup(TSCont contp, const char *hostname, size_t namelen) FORCE_PLUGIN_SCOPED_MUTEX(contp); - INKContInternal *i = (INKContInternal *)contp; - return (TSAction)hostDBProcessor.getbyname_re(i, hostname, namelen); + // There is no place to store the actual sockaddr to which a pointer should be returned. + // therefore an intermediate continuation is created to intercept the reply from HostDB. + // Its handler can create the required sockaddr context on the stack and then forward + // the event to the plugin continuation. The sockaddr cannot be placed in the HostDB + // record because that is a shared object. + auto bouncer = INKContAllocator.alloc(); + bouncer->init(&TSHostLookupTrampoline, reinterpret_cast(reinterpret_cast(contp)->mutex.get())); + bouncer->mdata = contp; + return (TSAction)hostDBProcessor.getbyname_re(bouncer, hostname, namelen); } sockaddr const * TSHostLookupResultAddrGet(TSHostLookupResult lookup_result) { sdk_assert(sdk_sanity_check_hostlookup_structure(lookup_result) == TS_SUCCESS); - HostDBInfo *di = reinterpret_cast(lookup_result); - return di->ip(); + auto ri{reinterpret_cast(lookup_result)}; + return ri->addr.isValid() ? &ri->addr.sa : nullptr; } /* @@ -8124,11 +8218,9 @@ TSHttpTxnRedirectUrlSet(TSHttpTxn txnp, const char *url, const int url_len) HttpSM *sm = (HttpSM *)txnp; - if (sm->redirect_url != nullptr) { - ats_free(sm->redirect_url); - sm->redirect_url = nullptr; - sm->redirect_url_len = 0; - } + ats_free(sm->redirect_url); + sm->redirect_url = nullptr; + sm->redirect_url_len = 0; sm->redirect_url = (char *)url; sm->redirect_url_len = url_len; @@ -8592,6 +8684,9 @@ _memberp_to_generic(MgmtFloat *ptr, MgmtConverter const *&conv) -> typename std: static void * _conf_to_memberp(TSOverridableConfigKey conf, OverridableHttpConfigParams *overridableHttpConfig, MgmtConverter const *&conv) { + // External converters. + extern MgmtConverter const &HostDBDownServerCacheTimeConv; + void *ret = nullptr; conv = nullptr; @@ -8750,7 +8845,8 @@ _conf_to_memberp(TSOverridableConfigKey conf, OverridableHttpConfigParams *overr ret = _memberp_to_generic(&overridableHttpConfig->post_connect_attempts_timeout, conv); break; case TS_CONFIG_HTTP_DOWN_SERVER_CACHE_TIME: - ret = _memberp_to_generic(&overridableHttpConfig->down_server_timeout, conv); + conv = &HostDBDownServerCacheTimeConv; + ret = &overridableHttpConfig->down_server_timeout; break; case TS_CONFIG_HTTP_DOWN_SERVER_ABORT_THRESHOLD: ret = _memberp_to_generic(&overridableHttpConfig->client_abort_threshold, conv); @@ -8970,6 +9066,12 @@ _conf_to_memberp(TSOverridableConfigKey conf, OverridableHttpConfigParams *overr // This helps avoiding compiler warnings, yet detect unhandled enum members. case TS_CONFIG_NULL: case TS_CONFIG_LAST_ENTRY: +#if TS_VERSION_MAJOR < 10 + + // The following is not used in 9.2.x, but preserved for ABI compatibility. + case TS_CONFIG_SSL_CLIENT_VERIFY_SERVER: + +#endif break; } @@ -9831,10 +9933,10 @@ TSSslServerCertUpdate(const char *cert_path, const char *key_path) return TS_ERROR; } -tsapi void +tsapi TSReturnCode TSSslTicketKeyUpdate(char *ticketData, int ticketDataLen) { - SSLTicketKeyConfig::reconfigure_data(ticketData, ticketDataLen); + return SSLTicketKeyConfig::reconfigure_data(ticketData, ticketDataLen) ? TS_SUCCESS : TS_ERROR; } TSReturnCode diff --git a/src/traffic_server/InkAPITest.cc b/src/traffic_server/InkAPITest.cc index 62d452033de..ebf06c798da 100644 --- a/src/traffic_server/InkAPITest.cc +++ b/src/traffic_server/InkAPITest.cc @@ -83,6 +83,8 @@ #define ERROR_BODY "TESTING ERROR PAGE" #define TRANSFORM_APPEND_STRING "This is a transformed response" +extern int dns_failover_period; + ////////////////////////////////////////////////////////////////////////////// // STRUCTURES ////////////////////////////////////////////////////////////////////////////// @@ -8510,14 +8512,14 @@ EXCLUSIVE_REGRESSION_TEST(SDK_API_TSHttpConnectIntercept)(RegressionTest *test, /* ip and log do not matter as it is used for logging only */ sockaddr_in addr; ats_ip4_set(&addr, 1, 1); - data->vc = TSHttpConnect(ats_ip_sa_cast(&addr)); + data->vc = TSHttpConnectWithPluginId(ats_ip_sa_cast(&addr), "TSHttpConnectIntercept", 1); if (TSVConnClosedGet(data->vc)) { SDK_RPRINT(data->test, "TSHttpConnect", "TestCase 1", TC_FAIL, "Connect reported as closed immediately after open"); } synclient_txn_send_request_to_vc(data->browser, data->request, data->vc); /* Wait until transaction is done */ - TSContScheduleOnPool(cont_test, 25, TS_THREAD_POOL_NET); + TSContScheduleOnPool(cont_test, 100, TS_THREAD_POOL_NET); return; } @@ -8525,6 +8527,11 @@ EXCLUSIVE_REGRESSION_TEST(SDK_API_TSHttpConnectIntercept)(RegressionTest *test, EXCLUSIVE_REGRESSION_TEST(SDK_API_TSHttpConnectServerIntercept)(RegressionTest *test, int /* atype ATS_UNUSED */, int *pstatus) { *pstatus = REGRESSION_TEST_INPROGRESS; + // These tests don't actually require DNS resolution, but if there are issues + // connecting to the DNS server then the test will fail due to error events + // from the communication arising. We avoid this by simply extending the DNS + // failover period to a very large value. + dns_failover_period = 1000; TSDebug(UTDBG_TAG, "Starting test TSHttpConnectServerIntercept"); @@ -8551,12 +8558,12 @@ EXCLUSIVE_REGRESSION_TEST(SDK_API_TSHttpConnectServerIntercept)(RegressionTest * /* ip and log do not matter as it is used for logging only */ sockaddr_in addr; ats_ip4_set(&addr, 2, 2); - data->vc = TSHttpConnect(ats_ip_sa_cast(&addr)); + data->vc = TSHttpConnectWithPluginId(ats_ip_sa_cast(&addr), "TSHttpConnectServerIntercept", 1); synclient_txn_send_request_to_vc(data->browser, data->request, data->vc); /* Wait until transaction is done */ - TSContScheduleOnPool(cont_test, 25, TS_THREAD_POOL_NET); + TSContScheduleOnPool(cont_test, 100, TS_THREAD_POOL_NET); return; } @@ -8660,7 +8667,6 @@ std::array SDK_Overridable_Configs = { "proxy.config.http.cache.max_open_write_retries", "proxy.config.http.redirect_use_orig_cache_key", "proxy.config.http.attach_server_session_to_client", - "proxy.config.http.max_proxy_cycles", "proxy.config.websocket.no_activity_timeout", "proxy.config.websocket.active_timeout", "proxy.config.http.uncacheable_requests_bypass_parent", @@ -8688,6 +8694,9 @@ std::array SDK_Overridable_Configs = { OutboundConnTrack::CONFIG_VAR_MIN, OutboundConnTrack::CONFIG_VAR_MAX, OutboundConnTrack::CONFIG_VAR_MATCH, +#if TS_VERSION_MAJOR < 10 + "proxy.config.ssl.client.verify.server", +#endif "proxy.config.ssl.client.verify.server.policy", "proxy.config.ssl.client.verify.server.properties", "proxy.config.ssl.client.sni_policy", @@ -8695,6 +8704,7 @@ std::array SDK_Overridable_Configs = { "proxy.config.ssl.client.CA.cert.filename", "proxy.config.hostdb.ip_resolve", "proxy.config.http.connect.dead.policy", + "proxy.config.http.max_proxy_cycles", "proxy.config.plugin.vc.default_buffer_index", "proxy.config.plugin.vc.default_buffer_water_mark", "proxy.config.net.sock_notsent_lowat", @@ -8723,6 +8733,14 @@ REGRESSION_TEST(SDK_API_OVERRIDABLE_CONFIGS)(RegressionTest *test, int /* atype *pstatus = REGRESSION_TEST_INPROGRESS; for (int i = 0; i < static_cast(SDK_Overridable_Configs.size()); ++i) { std::string_view conf{SDK_Overridable_Configs[i]}; +#if TS_VERSION_MAJOR < 10 + if (conf == "proxy.config.ssl.client.verify.server") { + // TODO: remove this in 10.x. Kept here because we keep the + // `TS_CONFIG_SSL_CLIENT_VERIFY_SERVER` in 9.x to preserve ABI + // compatibility in the 9.x releases. + continue; + } +#endif if (TS_SUCCESS == TSHttpTxnConfigFind(conf.data(), -1, &key, &type)) { if (key != i) { diff --git a/src/traffic_server/Makefile.inc b/src/traffic_server/Makefile.inc index 1472ede40f0..b908fea376a 100644 --- a/src/traffic_server/Makefile.inc +++ b/src/traffic_server/Makefile.inc @@ -100,5 +100,6 @@ endif if ENABLE_QUIC traffic_server_traffic_server_LDADD += \ $(top_builddir)/proxy/http3/libhttp3.a \ - $(top_builddir)/iocore/net/quic/libquic.a + $(top_builddir)/iocore/net/quic/libquic.a \ + $(top_builddir)/iocore/eventsystem/libinkevent.a endif diff --git a/src/traffic_server/traffic_server.cc b/src/traffic_server/traffic_server.cc index c9520300f7d..efc7dc4be16 100644 --- a/src/traffic_server/traffic_server.cc +++ b/src/traffic_server/traffic_server.cc @@ -33,6 +33,7 @@ #include "tscore/ink_platform.h" #include "tscore/ink_sys_control.h" #include "tscore/ink_args.h" +#include "tscore/ink_hw.h" #include "tscore/ink_lockfile.h" #include "tscore/ink_stack_trace.h" #include "tscore/ink_syslog.h" @@ -767,18 +768,6 @@ CB_After_Cache_Init() start = ink_atomic_swap(&delay_listen_for_cache, -1); emit_fully_initialized_message(); -#if TS_ENABLE_FIPS == 0 - // Check for cache BC after the cache is initialized and before listen, if possible. - if (cacheProcessor.min_stripe_version._major < CACHE_DB_MAJOR_VERSION) { - // Versions before 23 need the MMH hash. - if (cacheProcessor.min_stripe_version._major < 23) { - Debug("cache_bc", "Pre 4.0 stripe (cache version %d.%d) found, forcing MMH hash for cache URLs", - cacheProcessor.min_stripe_version._major, cacheProcessor.min_stripe_version._minor); - URLHashContext::Setting = URLHashContext::MMH; - } - } -#endif - if (1 == start) { // The delay_listen_for_cache value was 1, therefore the main function // delayed the call to start_HttpProxyServer until we got here. We must @@ -1570,6 +1559,9 @@ static void run_RegressionTest() { if (regression_level) { + // Call this so that Diags.cc will send diagnostic output to stderr. + tell_diags_regression_testing_is_on(); + eventProcessor.schedule_every(new RegressionCont(), HRTIME_SECONDS(1)); } } diff --git a/src/tscore/CryptoHash.cc b/src/tscore/CryptoHash.cc index 07bf2b68702..35fcbef3a65 100644 --- a/src/tscore/CryptoHash.cc +++ b/src/tscore/CryptoHash.cc @@ -45,25 +45,16 @@ CryptoContext::CryptoContext() case UNSPECIFIED: #if TS_ENABLE_FIPS == 0 case MD5: - new (_obj) MD5Context; - break; - case MMH: - new (_obj) MMHContext; + _base = new MD5Context; break; #else case SHA256: - new (_obj) SHA256Context; + _base = new SHA256Context; break; #endif default: ink_release_assert(!"Invalid global URL hash context"); }; -#if TS_ENABLE_FIPS == 0 - static_assert(CryptoContext::OBJ_SIZE >= sizeof(MD5Context), "bad OBJ_SIZE"); - static_assert(CryptoContext::OBJ_SIZE >= sizeof(MMHContext), "bad OBJ_SIZE"); -#else - static_assert(CryptoContext::OBJ_SIZE >= sizeof(SHA256Context), "bad OBJ_SIZE"); -#endif } /** diff --git a/src/tscore/Diags.cc b/src/tscore/Diags.cc index 20d22ec7a5f..ef0ac93da19 100644 --- a/src/tscore/Diags.cc +++ b/src/tscore/Diags.cc @@ -44,7 +44,7 @@ #include "tscore/ink_time.h" #include "tscore/ink_hrtime.h" #include "tscore/ink_thread.h" -#include "tscore/BufferWriter.h" +#include "tscore/Regression.h" #include "tscore/Diags.h" int diags_on_for_plugins = 0; @@ -53,6 +53,14 @@ int DiagsConfigState::enabled[2] = {0, 0}; // Global, used for all diagnostics Diags *diags = nullptr; +static bool regression_testing_on = false; + +void +tell_diags_regression_testing_is_on() +{ + regression_testing_on = true; +} + static bool location(const SourceLocation *loc, DiagsShowLocation show, DiagsLevel level) { @@ -266,7 +274,7 @@ Diags::print_va(const char *debug_tag, DiagsLevel diags_level, const SourceLocat } } - if (config.outputs[diags_level].to_stderr) { + if (config.outputs[diags_level].to_stderr || regression_testing_on) { if (stderr_log && stderr_log->m_fp) { va_list tmp; va_copy(tmp, ap); diff --git a/src/tscore/HostLookup.cc b/src/tscore/HostLookup.cc index b695e0f47d1..440474e9456 100644 --- a/src/tscore/HostLookup.cc +++ b/src/tscore/HostLookup.cc @@ -231,7 +231,11 @@ struct CharIndexBlock { class CharIndex { public: - struct iterator : public std::iterator { + struct iterator { + using iterator_category = std::forward_iterator_tag; + using value_type = HostBranch; + using difference_type = int; + using self_type = iterator; struct State { diff --git a/src/tscore/Makefile.am b/src/tscore/Makefile.am index 8b02bc17192..e5b6ed6eb3e 100644 --- a/src/tscore/Makefile.am +++ b/src/tscore/Makefile.am @@ -79,6 +79,7 @@ libtscore_la_SOURCES = \ ink_error.cc \ ink_file.cc \ ink_hrtime.cc \ + ink_hw.cc \ ink_inet.cc \ ink_memory.cc \ ink_mutex.cc \ @@ -169,6 +170,7 @@ test_tscore_SOURCES = \ unit_tests/test_ArgParser.cc \ unit_tests/test_BufferWriter.cc \ unit_tests/test_BufferWriterFormat.cc \ + unit_tests/test_CryptoHash.cc \ unit_tests/test_Extendible.cc \ unit_tests/test_History.cc \ unit_tests/test_ink_inet.cc \ diff --git a/src/tscore/ink_base64.cc b/src/tscore/ink_base64.cc index a1da352f36e..bc68758bc94 100644 --- a/src/tscore/ink_base64.cc +++ b/src/tscore/ink_base64.cc @@ -28,8 +28,6 @@ * authentication scheme does not require them. This implementation is * intended for web-related use, and line breaks are not implemented. * - * These routines return char*'s to malloc-ed strings. The caller is - * responsible for freeing the strings. */ #include "tscore/ink_platform.h" #include "tscore/ink_base64.h" @@ -44,7 +42,7 @@ ats_base64_encode(const unsigned char *inBuffer, size_t inBufferSize, char *outB char *obuf = outBuffer; char in_tail[4]; - if (outBufSize < ATS_BASE64_ENCODE_DSTLEN(inBufferSize)) { + if (outBufSize < ats_base64_encode_dstlen(inBufferSize)) { return false; } @@ -130,7 +128,7 @@ ats_base64_decode(const char *inBuffer, size_t inBufferSize, unsigned char *outB int inputBytesDecoded = 0; // Make sure there is sufficient space in the output buffer - if (outBufSize < ATS_BASE64_DECODE_DSTLEN(inBufferSize)) { + if (outBufSize < ats_base64_decode_dstlen(inBufferSize)) { return false; } diff --git a/src/tscore/ink_defs.cc b/src/tscore/ink_defs.cc index b28ed35bcf0..52345222191 100644 --- a/src/tscore/ink_defs.cc +++ b/src/tscore/ink_defs.cc @@ -30,115 +30,11 @@ #include "tscore/ink_platform.h" -#if defined(linux) || defined(freebsd) || defined(darwin) -#include -#include -#endif -#if defined(linux) -#include -#endif +#include int off = 0; int on = 1; -#if TS_USE_HWLOC - -#include - -// Little helper to initialize the hwloc topology, once. -static hwloc_topology_t -setup_hwloc() -{ - hwloc_topology_t topology; - - hwloc_topology_init(&topology); - hwloc_topology_load(topology); - - return topology; -} - -// Get the topology -hwloc_topology_t -ink_get_topology() -{ - static hwloc_topology_t topology = setup_hwloc(); - return topology; -} - -#endif - -int -ink_sys_name_release(char *name, int namelen, char *release, int releaselen) -{ - *name = 0; - *release = 0; -#if defined(freebsd) || defined(darwin) - int mib[2]; - size_t len = namelen; - mib[0] = CTL_KERN; - mib[1] = KERN_OSTYPE; - - if (sysctl(mib, 2, name, &len, nullptr, 0) == -1) - return -1; - - len = releaselen; - mib[0] = CTL_KERN; - mib[1] = KERN_OSRELEASE; - - if (sysctl(mib, 2, release, &len, nullptr, 0) == -1) - return -1; - - return 0; -#elif defined(linux) - struct utsname buf; - int n; - - if (uname(&buf)) { - return -1; - } - - n = strlen(buf.sysname); - if (namelen <= n) { - n = namelen - 1; - } - memcpy(name, buf.sysname, n); - name[n] = 0; - - n = strlen(buf.release); - if (releaselen <= n) { - n = releaselen - 1; - } - memcpy(release, buf.release, n); - release[n] = 0; - - return 0; -#else - return -1; -#endif -} - -int -ink_number_of_processors() -{ -#if TS_USE_HWLOC -#if HAVE_HWLOC_OBJ_PU - return hwloc_get_nbobjs_by_type(ink_get_topology(), HWLOC_OBJ_PU); -#else - return hwloc_get_nbobjs_by_type(ink_get_topology(), HWLOC_OBJ_CORE); -#endif -#elif defined(freebsd) - int mib[2], n; - mib[0] = CTL_HW; - mib[1] = HW_NCPU; - size_t len = sizeof(n); - if (sysctl(mib, 2, &n, &len, nullptr, 0) == -1) - return 1; - return n; -#else - return sysconf(_SC_NPROCESSORS_ONLN); // number of processing units (includes Hyper Threading) -#endif -} - int ink_login_name_max() { diff --git a/src/tscore/ink_hw.cc b/src/tscore/ink_hw.cc new file mode 100644 index 00000000000..d166ea68777 --- /dev/null +++ b/src/tscore/ink_hw.cc @@ -0,0 +1,70 @@ +/** @file + + @section license License + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "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 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + */ + +#include "tscore/ink_hw.h" +#include "tscore/ink_platform.h" + +#if TS_USE_HWLOC + +#include + +// Little helper to initialize the hwloc topology, once. +static hwloc_topology_t +setup_hwloc() +{ + hwloc_topology_t topology; + + hwloc_topology_init(&topology); + hwloc_topology_load(topology); + + return topology; +} + +// Get the topology +hwloc_topology_t +ink_get_topology() +{ + static hwloc_topology_t topology = setup_hwloc(); + return topology; +} +#endif + +int +ink_number_of_processors() +{ +#if TS_USE_HWLOC +#if HAVE_HWLOC_OBJ_PU + return hwloc_get_nbobjs_by_type(ink_get_topology(), HWLOC_OBJ_PU); +#else + return hwloc_get_nbobjs_by_type(ink_get_topology(), HWLOC_OBJ_CORE); +#endif +#elif defined(freebsd) + int mib[2], n; + mib[0] = CTL_HW; + mib[1] = HW_NCPU; + size_t len = sizeof(n); + if (sysctl(mib, 2, &n, &len, nullptr, 0) == -1) + return 1; + return n; +#else + return sysconf(_SC_NPROCESSORS_ONLN); // number of processing units (includes Hyper Threading) +#endif +} diff --git a/src/tscore/ink_stack_trace.cc b/src/tscore/ink_stack_trace.cc index 568cc0dab7b..ace71496b6f 100644 --- a/src/tscore/ink_stack_trace.cc +++ b/src/tscore/ink_stack_trace.cc @@ -66,6 +66,25 @@ ink_stack_trace_dump() } } +const void * +ink_backtrace(const int n) +{ + if (INK_STACK_TRACE_MAX_LEVELS < n + 1) { + return nullptr; + } + + const int m = n + 1; + void *callstack[m]; + int frames = backtrace(callstack, m); + + const void *symbol = nullptr; + if (frames == m && callstack[n] != nullptr) { + symbol = callstack[n]; + } + + return symbol; +} + #else /* !TS_HAS_BACKTRACE */ void @@ -76,4 +95,10 @@ ink_stack_trace_dump() return; } +const void * +ink_backtrace(const int /* n */) +{ + return nullptr; +} + #endif /* TS_HAS_BACKTRACE */ diff --git a/src/tscore/unit_tests/freelist_benchmark.cc b/src/tscore/unit_tests/freelist_benchmark.cc index d4e87004c82..161f89a2f61 100644 --- a/src/tscore/unit_tests/freelist_benchmark.cc +++ b/src/tscore/unit_tests/freelist_benchmark.cc @@ -24,6 +24,7 @@ #include "catch.hpp" +#include "tscore/ink_hw.h" #include "tscore/ink_thread.h" #include "tscore/ink_memory.h" #include "tscore/ink_queue.h" diff --git a/src/tscore/unit_tests/test_BufferWriterFormat.cc b/src/tscore/unit_tests/test_BufferWriterFormat.cc index 66004f97db7..76d97080e3d 100644 --- a/src/tscore/unit_tests/test_BufferWriterFormat.cc +++ b/src/tscore/unit_tests/test_BufferWriterFormat.cc @@ -284,9 +284,11 @@ TEST_CASE("bwstring", "[bwprint][bwstring]") ts::bwprint(s, fmt, 99999, text); REQUIRE(s == "99999 -- e99a18c428cb38d5f260853678922e03"); + REQUIRE(strlen(s.c_str()) == text.size() + 9); ts::bwprint(s, "{} .. |{:,20}|", 32767, text); REQUIRE(s == "32767 .. |e99a18c428cb38d5f260|"); + REQUIRE(strlen(s.c_str()) == 31); ts::LocalBufferWriter<128> bw; char buff[128]; diff --git a/src/tscore/unit_tests/test_CryptoHash.cc b/src/tscore/unit_tests/test_CryptoHash.cc new file mode 100644 index 00000000000..1544cd1f4ef --- /dev/null +++ b/src/tscore/unit_tests/test_CryptoHash.cc @@ -0,0 +1,55 @@ +/** + @file Test for CryptoHash + + @section license License + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "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 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +*/ + +#include +#include + +#include "tscore/ink_assert.h" +#include "tscore/ink_defs.h" +#include "tscore/CryptoHash.h" +#include "catch.hpp" + +TEST_CASE("CrypoHash", "[libts][CrypoHash]") +{ + CryptoHash hash; + ats::CryptoContext ctx; + std::string_view test = "asdfsfsdfljhasdfkjasdkfuy239874kasjdf"; + std::string_view sha256 = "2602CBA2CC0331EB7C455E9F36030B32CE9BB432A90759075F5A702772BE123B"; + std::string_view md5 = "480AEF8C24AA94B80DC6214ECEC8CD1A"; + + // Hash the test data + ctx.update(test.data(), test.size()); + ctx.finalize(hash); + + // Write the output to a string + char buffer[(CRYPTO_HASH_SIZE * 2) + 1]; + hash.toHexStr(buffer); + + // Compair to a known hash value + if (CryptoContext::Setting == CryptoContext::SHA256) { + REQUIRE(strlen(buffer) == sha256.size()); + REQUIRE(memcmp(sha256.data(), buffer, sha256.size()) == 0); + } else { + REQUIRE(strlen(buffer) == md5.size()); + REQUIRE(memcmp(md5.data(), buffer, md5.size()) == 0); + } +} diff --git a/src/tscore/unit_tests/test_History.cc b/src/tscore/unit_tests/test_History.cc index 3e699139da0..7505f10aa4c 100644 --- a/src/tscore/unit_tests/test_History.cc +++ b/src/tscore/unit_tests/test_History.cc @@ -59,10 +59,10 @@ TEST_CASE("History", "[libts][History]") REQUIRE(history[2].reentrancy == static_cast(NO_REENTRANT)); history[0].location.str(buf, sizeof(buf)); - REQUIRE(string_view{buf} == "test_History.cc:48 (____C_A_T_C_H____T_E_S_T____0)"); + REQUIRE(string_view{buf} == "test_History.cc:48 (C_A_T_C_H_T_E_S_T_0)"); history[1].location.str(buf, sizeof(buf)); - REQUIRE(string_view{buf} == "test_History.cc:49 (____C_A_T_C_H____T_E_S_T____0)"); + REQUIRE(string_view{buf} == "test_History.cc:49 (C_A_T_C_H_T_E_S_T_0)"); ts::LocalBufferWriter<128> w; SM *sm = new SM; @@ -71,10 +71,10 @@ TEST_CASE("History", "[libts][History]") SM_REMEMBER(sm, 3, NO_REENTRANT); w.print("{}", sm->history[0].location); - REQUIRE(w.view() == "test_History.cc:69 (____C_A_T_C_H____T_E_S_T____0)"); + REQUIRE(w.view() == "test_History.cc:69 (C_A_T_C_H_T_E_S_T_0)"); w.reset().print("{}", sm->history[1].location); - REQUIRE(w.view() == "test_History.cc:70 (____C_A_T_C_H____T_E_S_T____0)"); + REQUIRE(w.view() == "test_History.cc:70 (C_A_T_C_H_T_E_S_T_0)"); REQUIRE(sm->history[0].event == 1); REQUIRE(sm->history[0].reentrancy == 1); @@ -106,10 +106,10 @@ TEST_CASE("History", "[libts][History]") REQUIRE(sm2->history.overflowed() == true); w.reset().print("{}", sm2->history[0].location); - REQUIRE(w.view() == "test_History.cc:103 (____C_A_T_C_H____T_E_S_T____0)"); + REQUIRE(w.view() == "test_History.cc:103 (C_A_T_C_H_T_E_S_T_0)"); w.reset().print("{}", sm2->history[1].location); - REQUIRE(w.view() == "test_History.cc:98 (____C_A_T_C_H____T_E_S_T____0)"); + REQUIRE(w.view() == "test_History.cc:98 (C_A_T_C_H_T_E_S_T_0)"); sm2->history.clear(); REQUIRE(sm2->history.size() == 0); diff --git a/src/wccp/WccpLocal.h b/src/wccp/WccpLocal.h index 7e173ab7c6d..937cab68146 100644 --- a/src/wccp/WccpLocal.h +++ b/src/wccp/WccpLocal.h @@ -1700,13 +1700,13 @@ class AltHashAssignComp : public AltAssignComp /// Force virtual destructor. virtual ~AltHashAssignComp() {} /// Fill out the component from an @c Assignment. - virtual self &fill(MsgBuffer &buffer, ///< Target storage. - detail::Assignment const &assign ///< Assignment data. - ); + self &fill(MsgBuffer &buffer, ///< Target storage. + detail::Assignment const &assign ///< Assignment data. + ) override; /// Validate an existing structure. /// @return Parse result. - virtual int parse(MsgBuffer &buffer); + int parse(MsgBuffer &buffer) override; /// Compute the total size of the component. static size_t calcSize(int n_routers, ///< Number of routers in view. @@ -1733,13 +1733,13 @@ class AltMaskAssignComp : public AltAssignComp /// Force virtual destructor. virtual ~AltMaskAssignComp() {} /// Fill out the component from an @c Assignment. - virtual self &fill(MsgBuffer &buffer, ///< Target storage. - detail::Assignment const &assign ///< Assignment data. - ); + self &fill(MsgBuffer &buffer, ///< Target storage. + detail::Assignment const &assign ///< Assignment data. + ) override; /// Validate an existing structure. /// @return Parse result. - virtual int parse(MsgBuffer &buffer); + int parse(MsgBuffer &buffer) override; protected: MaskAssignElt *m_mask_elt; ///< Address of the mask assign element. @@ -2485,18 +2485,17 @@ class CacheImpl : public Impl ts::Errata loadServicesFromFile(const char *path ///< Path to file. ); - /// Override. - int open(uint32_t addr); + int open(uint32_t addr) override; /// Time until next scheduled event. time_t waitTime() const; /// Check for configuration. - bool isConfigured() const; + bool isConfigured() const override; /// Perform all scheduled housekeeping functions. /// @return 0 for success, -errno on error. - virtual int housekeeping(); + int housekeeping() override; /** Check cache assignment reported by a router against internal assign. @return @c true if they are the same, @c false otherwise. @@ -2520,13 +2519,13 @@ class CacheImpl : public Impl GroupData &group ///< Group with data for message. ); /// Process HERE_I_AM message. - virtual ts::Errata handleISeeYou(IpHeader const &header, ///< IP packet data. - ts::Buffer const &data ///< Buffer with message data. - ); + ts::Errata handleISeeYou(IpHeader const &header, ///< IP packet data. + ts::Buffer const &data ///< Buffer with message data. + ) override; /// Process REMOVAL_QUERY message. - virtual ts::Errata handleRemovalQuery(IpHeader const &header, ///< IP packet data. - ts::Buffer const &data ///< Message data. - ); + ts::Errata handleRemovalQuery(IpHeader const &header, ///< IP packet data. + ts::Buffer const &data ///< Message data. + ) override; /// Map Service Group ID to Service Group Data. typedef std::map GroupMap; @@ -2632,15 +2631,15 @@ class RouterImpl : public Impl typedef detail::router::RouterBag RouterBag; /// Process HERE_I_AM message. - virtual ts::Errata handleHereIAm(IpHeader const &header, ///< IP packet data. - ts::Buffer const &data ///< Buffer with message data. - ); + ts::Errata handleHereIAm(IpHeader const &header, ///< IP packet data. + ts::Buffer const &data ///< Buffer with message data. + ) override; /// Perform all scheduled housekeeping functions. - int housekeeping(); + int housekeeping() override; /// Send pending I_SEE_YOU messages. int xmitISeeYou(); /// Check for configuration. - bool isConfigured() const; + bool isConfigured() const override; protected: /** Find or create a service group record. diff --git a/src/wccp/WccpMeta.h b/src/wccp/WccpMeta.h index 464e8bafcea..11a9b09cf44 100644 --- a/src/wccp/WccpMeta.h +++ b/src/wccp/WccpMeta.h @@ -54,7 +54,11 @@ template struct TEST_IF_TRUE : public TEST_RESULT> }; // Helper for assigning a value to all instances in a container. -template struct TsAssignMember : public std::binary_function { +template struct TsAssignMember { + using first_argument_type = T; + using second_argument_type = A1; + using result_type = R; + R T::*_m; A1 _arg1; TsAssignMember(R T::*m, A1 const &arg1) : _m(m), _arg1(arg1) {} diff --git a/tests/Pipfile b/tests/Pipfile index 4c810ba1fc8..ac989909ec4 100644 --- a/tests/Pipfile +++ b/tests/Pipfile @@ -26,7 +26,7 @@ pyflakes = "*" [packages] # Keep init.cli.ext updated with this required autest version. -autest = "==1.10.0" +autest = "==1.10.1" traffic-replay = "*" # this should install TRLib, MicroServer, MicroDNS, Traffic-Replay hyper = "*" @@ -43,5 +43,11 @@ microserver = ">=1.0.6" jsonschema = "*" python-jose = "*" +# The latest version of Werkzeug (2.1.0) breaks httpbin because it removes +# deprecated function `BaseResponse` that httpbin directly or indirectly +# depends upon. Pinning Wekrzeug for now until httpbin or its dependencies is +# updated for the changed API. +Werkzeug = "==2.0.3" + [requires] python_version = "3" diff --git a/tests/gold_tests/autest-site/ordered_set_queue.py b/tests/gold_tests/autest-site/ordered_set_queue.py index 5001cf7ade1..789301da3aa 100644 --- a/tests/gold_tests/autest-site/ordered_set_queue.py +++ b/tests/gold_tests/autest-site/ordered_set_queue.py @@ -19,6 +19,11 @@ import collections +try: + collectionsAbc = collections.abc +except AttributeError: + collectionsAbc = collections + try: import queue as Queue except ImportError: @@ -30,7 +35,7 @@ # https://code.activestate.com/recipes/576694/ # -class OrderedSet(collections.MutableSet): +class OrderedSet(collectionsAbc.MutableSet): def __init__(self, iterable=None): self.end = end = [] diff --git a/tests/gold_tests/cache/cache-range-response.test.py b/tests/gold_tests/cache/cache-range-response.test.py new file mode 100644 index 00000000000..4175bb5d9a6 --- /dev/null +++ b/tests/gold_tests/cache/cache-range-response.test.py @@ -0,0 +1,40 @@ +''' +Verify that caching a range request when origin returns full response works. +''' +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "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 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +Test.Summary = ''' +Verify correct caching behavior for range requests. +''' + +ts = Test.MakeATSProcess("ts") +replay_file = "replay/cache-range-response.replay.yaml" +server = Test.MakeVerifierServerProcess("server0", replay_file) +ts.Disk.records_config.update({ + 'proxy.config.diags.debug.enabled': 1, + 'proxy.config.diags.debug.tags': 'http.*|cache.*', + 'proxy.config.http.cache.range.write': 1, + 'proxy.config.http.cache.when_to_revalidate': 4, + 'proxy.config.http.insert_response_via_str': 3, +}) +ts.Disk.remap_config.AddLine( + f'map / http://127.0.0.1:{server.Variables.http_port}' +) +tr = Test.AddTestRun("Verify range request is transformed from a 200 response") +tr.Processes.Default.StartBefore(server) +tr.Processes.Default.StartBefore(ts) +tr.AddVerifierClientProcess("client0", replay_file, http_ports=[ts.Variables.port]) diff --git a/tests/gold_tests/cache/replay/cache-range-response.replay.yaml b/tests/gold_tests/cache/replay/cache-range-response.replay.yaml new file mode 100644 index 00000000000..768f0ddd187 --- /dev/null +++ b/tests/gold_tests/cache/replay/cache-range-response.replay.yaml @@ -0,0 +1,113 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "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 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +--- +meta: + version: "1.0" + +sessions: + - transactions: + # Populate the cache with a response to a GET request. + - client-request: + method: "GET" + version: "1.1" + url: /some/path + headers: + fields: + - [ Host, example.com ] + - [ uuid, 1 ] + - [ Range, bytes=0-10 ] + server-response: + status: 200 + reason: OK + headers: + fields: + - [ Content-Length, 16 ] + - [ Cache-Control, max-age=300 ] + - [ X-Response, first_get_response ] + proxy-response: + status: 206 + headers: + fields: + - [ X-Response, { value: first_get_response, as: equal} ] + - [ Content-Range, { value: "bytes 0-10/16", as: equal}] + # Subsequent range request served from cache + - client-request: + method: "GET" + version: "1.1" + url: /some/path + headers: + fields: + - [ Host, example.com ] + - [ uuid, 2 ] + - [ Range, bytes=0-5 ] + server-response: + status: 500 + reason: OK + headers: + fields: + - [ X-Response, internal_server_error ] + proxy-response: + status: 206 + headers: + fields: + - [ X-Response, { value: first_get_response, as: equal} ] + - [ Content-Range, { value: "bytes 0-5/16", as: equal}] + # Should get full response from cache without a range header + - client-request: + method: "GET" + version: "1.1" + url: /some/path + headers: + fields: + - [ Host, example.com ] + - [ uuid, 3 ] + server-response: + status: 500 + reason: OK + headers: + fields: + - [ X-Response, internal_server_error ] + proxy-response: + status: 200 + headers: + fields: + - [ X-Response, { value: first_get_response, as: equal} ] + - [ Content-Length, { value: "16", as: equal}] + # Revalidate and replace cache still returns 206 + - client-request: + method: "GET" + version: "1.1" + url: /some/path + headers: + fields: + - [ Host, example.com ] + - [ uuid, 4 ] + - [ Range, bytes=0-10 ] + - [ If-Modified-Since, "Wed, 16 Mar 2022 22:52:09 GMT"] + server-response: + status: 200 + reason: OK + headers: + fields: + - [ Content-Length, 100 ] + - [ Cache-Control, max-age=300 ] + proxy-response: + status: 206 + headers: + fields: + - [ Content-Range, { value: "bytes 0-10/100", as: equal}] + - [ Via, { value: "uIcSsSfUpSeN:t cCSp sS", as: contains }] diff --git a/tests/gold_tests/cache/replay/post_with_post_caching_enabled.replay.yaml b/tests/gold_tests/cache/replay/post_with_post_caching_enabled.replay.yaml index 7af82979cb9..5f102d23cd9 100644 --- a/tests/gold_tests/cache/replay/post_with_post_caching_enabled.replay.yaml +++ b/tests/gold_tests/cache/replay/post_with_post_caching_enabled.replay.yaml @@ -128,7 +128,7 @@ sessions: # Add a delay so ATS has time to finish any caching IO for the previous # transaction. - delay: 100ms + delay: 500ms # The request should be served out of cache, so this 403 should not be # received. diff --git a/tests/gold_tests/chunked_encoding/smuggle-client.c b/tests/gold_tests/chunked_encoding/smuggle-client.c index db1101140fc..7b9584ac1fa 100644 --- a/tests/gold_tests/chunked_encoding/smuggle-client.c +++ b/tests/gold_tests/chunked_encoding/smuggle-client.c @@ -48,7 +48,7 @@ main(int argc, char *argv[]) { struct addrinfo hints; struct addrinfo *result, *rp; - int sfd, s; + int sfd = -1, s; if (argc < 3) { fprintf(stderr, "Usage: %s \n", argv[0]); diff --git a/tests/gold_tests/next_hop/strategies_ch2/strategies_ch2.test.py b/tests/gold_tests/next_hop/strategies_ch2/strategies_ch2.test.py index e451d42f981..436b07a12ba 100644 --- a/tests/gold_tests/next_hop/strategies_ch2/strategies_ch2.test.py +++ b/tests/gold_tests/next_hop/strategies_ch2/strategies_ch2.test.py @@ -74,6 +74,7 @@ 'proxy.config.http.uncacheable_requests_bypass_parent': 0, 'proxy.config.http.no_dns_just_forward_to_parent': 1, 'proxy.config.http.parent_proxy.mark_down_hostdb': 0, + 'proxy.config.http.down_server.cache_time': 1, 'proxy.config.http.parent_proxy.self_detect': 0, }) @@ -90,6 +91,7 @@ # The health check URL does not seem to be used currently. # s.AddLine(f" health_check_url: http://next_hop{i}:{ts_nh[i].Variables.port}") s.AddLine(f" weight: 1.0") + s.AddLines([ "strategies:", " - strategy: the-strategy", diff --git a/tests/gold_tests/pluginTest/cache_range_requests/cache_range_requests_ims.test.py b/tests/gold_tests/pluginTest/cache_range_requests/cache_range_requests_ims.test.py index 22f795839ab..eb96261e78c 100644 --- a/tests/gold_tests/pluginTest/cache_range_requests/cache_range_requests_ims.test.py +++ b/tests/gold_tests/pluginTest/cache_range_requests/cache_range_requests_ims.test.py @@ -88,10 +88,13 @@ server.addResponse("sessionlog.json", req_full, res_full) # cache range requests plugin remap -ts.Disk.remap_config.AddLine( - 'map http://www.example.com http://127.0.0.1:{}'.format(server.Variables.Port) + +ts.Disk.remap_config.AddLines([ + f'map http://ims http://127.0.0.1:{server.Variables.Port}' + ' @plugin=cache_range_requests.so @pparam=--consider-ims', -) + f'map http://imsheader http://127.0.0.1:{server.Variables.Port}' + + ' @plugin=cache_range_requests.so @pparam=--consider-ims' + + ' @pparam=--ims-header=CrrIms', +]) # cache debug ts.Disk.plugin_config.AddLine('xdebug.so') @@ -109,29 +112,40 @@ ps = tr.Processes.Default ps.StartBefore(server, ready=When.PortOpen(server.Variables.Port)) ps.StartBefore(Test.Processes.ts) -ps.Command = curl_and_args + ' http://www.example.com/path -r 0-' +ps.Command = curl_and_args + ' http://ims/path -r 0-' ps.ReturnCode = 0 ps.Streams.stdout.Content = Testers.ContainsExpression("X-Cache: miss", "expected cache miss for load") tr.StillRunningAfter = ts -# set up the IMS date field (go in the future) RFC 2616 -futuretime = time.time() + 100 # seconds -futurestr = time.strftime("%a, %d %b %Y %H:%M:%S GMT", time.gmtime(futuretime)) - # test inner range # 1 Test - Fetch range into cache tr = Test.AddTestRun("0- cache hit check") ps = tr.Processes.Default -ps.Command = curl_and_args + ' http://www.example.com/path -r 0-'.format(futurestr) +ps.Command = curl_and_args + ' http://ims/path -r 0-' ps.ReturnCode = 0 ps.Streams.stdout.Content = Testers.ContainsExpression("X-Cache: hit", "expected cache hit") tr.StillRunningAfter = ts +# set up the IMS date field (go in the future) RFC 2616 +futuretime = time.time() + 100 # seconds +futurestr = time.strftime("%a, %d %b %Y %H:%M:%S GMT", time.gmtime(futuretime)) + # 2 Test - Ensure X-CRR-IMS header results in hit-stale tr = Test.AddTestRun("0- range X-CRR-IMS check") ps = tr.Processes.Default -ps.Command = curl_and_args + ' http://www.example.com/path -r 0- -H "X-CRR-IMS: {}"'.format(futurestr) +ps.Command = curl_and_args + ' http://ims/path -r 0- -H "X-CRR-IMS: {}"'.format(futurestr) +ps.ReturnCode = 0 +ps.Streams.stdout.Content = Testers.ContainsExpression("X-Cache: hit-stale", "expected cache hit-stale") +tr.StillRunningAfter = ts + +futuretime += 10 # seconds +futurestr = time.strftime("%a, %d %b %Y %H:%M:%S GMT", time.gmtime(futuretime)) + +# 3 Test - Ensure CrrIms header results in hit-stale +tr = Test.AddTestRun("0- range CrrIms check, override header") +ps = tr.Processes.Default +ps.Command = curl_and_args + ' http://imsheader/path -r 0- -H "CrrIms: {}"'.format(futurestr) ps.ReturnCode = 0 ps.Streams.stdout.Content = Testers.ContainsExpression("X-Cache: hit-stale", "expected cache hit-stale") tr.StillRunningAfter = ts diff --git a/tests/gold_tests/pluginTest/money_trace/gold/global-log.gold b/tests/gold_tests/pluginTest/money_trace/gold/global-log.gold new file mode 100644 index 00000000000..486db70ddb2 --- /dev/null +++ b/tests/gold_tests/pluginTest/money_trace/gold/global-log.gold @@ -0,0 +1,3 @@ +cqh: trace-id=foo;parent-id=bar;span-id=baz trace-id=foo;parent-id=baz;span-id=0 pqh: trace-id=foo;parent-id=baz;span-id=0 psh: trace-id=foo;parent-id=bar;span-id=baz +cqh: - ``;parent-id=0;span-id=1 pqh: - psh: - +cqh: - trace-id=``;parent-id=0;span-id=2 pqh: trace-id=``;parent-id=0;span-id=2 psh: - diff --git a/tests/gold_tests/pluginTest/money_trace/gold/remap-log.gold b/tests/gold_tests/pluginTest/money_trace/gold/remap-log.gold new file mode 100644 index 00000000000..c8c98b53c76 --- /dev/null +++ b/tests/gold_tests/pluginTest/money_trace/gold/remap-log.gold @@ -0,0 +1,23 @@ +cqh: - - - pqh: - - psh: - - +cqh: - - - pqh: - - psh: - - +cqh: trace-id=basic;parent-id=foo;span-id=bar - - pqh: trace-id=basic;parent-id=bar;span-id=2 - psh: trace-id=basic;parent-id=foo;span-id=bar - +cqh: - trace-id=header;parent-id=foo;span-id=bar - pqh: - trace-id=header;parent-id=bar;span-id=3 psh: - trace-id=header;parent-id=foo;span-id=bar +cqh: - - - pqh: - - psh: - - +cqh: trace-id=pregen;parent-id=foo;span-id=bar - trace-id=pregen;parent-id=bar;span-id=5 pqh: trace-id=pregen;parent-id=bar;span-id=5 - psh: trace-id=pregen;parent-id=foo;span-id=bar - +cqh: - trace-id=pgh;parent-id=foo;span-id=bar trace-id=pgh;parent-id=bar;span-id=6 pqh: - trace-id=pgh;parent-id=bar;span-id=6 psh: - trace-id=pgh;parent-id=foo;span-id=bar +cqh: - - - pqh: trace-id=``;parent-id=0;span-id=7 - psh: - - +cqh: - - - pqh: - trace-id=``;parent-id=0;span-id=8 psh: - - +cqh: - - trace-id=``;parent-id=0;span-id=9 pqh: trace-id=``;parent-id=0;span-id=9 - psh: - - +cqh: trace-id=passthru;parent-id=foo;span-id=bar - - pqh: trace-id=passthru;parent-id=foo;span-id=bar - psh: trace-id=passthru;parent-id=foo;span-id=bar - +cqh: trace-id=spaces; parent-id=foo; span-id=bar - trace-id=spaces;parent-id=bar;span-id=11 pqh: trace-id=spaces;parent-id=bar;span-id=11 - psh: trace-id=spaces; parent-id=foo; span-id=bar - +cqh: trace-id=noparent;span-id=8215111;span-name=this is some description - trace-id=noparent;parent-id=8215111;span-id=12 pqh: trace-id=noparent;parent-id=8215111;span-id=12 - psh: trace-id=noparent;span-id=8215111;span-name=this is some description - +cqh: trace-id=badspan;span-id= - trace-id=badspan;parent-id=0;span-id=13 pqh: trace-id=badspan;parent-id=0;span-id=13 - psh: trace-id=badspan;span-id= - +cqh: trace-id=traceonly - trace-id=traceonly;parent-id=0;span-id=14 pqh: trace-id=traceonly;parent-id=0;span-id=14 - psh: trace-id=traceonly - +cqh: trace-id=traceonlysemi; - trace-id=traceonlysemi;parent-id=0;span-id=15 pqh: trace-id=traceonlysemi;parent-id=0;span-id=15 - psh: trace-id=traceonlysemi; - +cqh: not a trace header - not a trace header pqh: not a trace header - psh: not a trace header - +cqh: trace-id=spaces; parent-id=foo; span-id=bar - trace-id=spaces;parent-id=bar;span-id=17 pqh: trace-id=spaces;parent-id=bar;span-id=17 - psh: trace-id=spaces; parent-id=foo; span-id=bar - +cqh: trace-id=noparent;span-id=8215111;span-name=this is some description - trace-id=noparent;parent-id=8215111;span-id=18 pqh: trace-id=noparent;parent-id=8215111;span-id=18 - psh: trace-id=noparent;span-id=8215111;span-name=this is some description - +cqh: trace-id=badspan;span-id= - trace-id=badspan;parent-id=0;span-id=19 pqh: trace-id=badspan;parent-id=0;span-id=19 - psh: trace-id=badspan;span-id= - +cqh: trace-id=traceonly - trace-id=traceonly;parent-id=0;span-id=20 pqh: trace-id=traceonly;parent-id=0;span-id=20 - psh: trace-id=traceonly - +cqh: trace-id=traceonlysemi; - trace-id=traceonlysemi;parent-id=0;span-id=21 pqh: trace-id=traceonlysemi;parent-id=0;span-id=21 - psh: trace-id=traceonlysemi; - +cqh: not a trace header - trace-id=``;parent-id=0;span-id=22 pqh: trace-id=``;parent-id=0;span-id=22 - psh: not a trace header - diff --git a/tests/gold_tests/pluginTest/money_trace/money_trace.test.py b/tests/gold_tests/pluginTest/money_trace/money_trace.test.py new file mode 100644 index 00000000000..5b35c14210a --- /dev/null +++ b/tests/gold_tests/pluginTest/money_trace/money_trace.test.py @@ -0,0 +1,225 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "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 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +import os +Test.Summary = ''' +Test money_trace remap +''' + +# Test description: + +Test.SkipUnless( + Condition.PluginExists('money_trace.so'), +) +Test.ContinueOnFail = False +Test.testName = "money_trace remap" + +# Define ATS and configure +ts = Test.MakeATSProcess("ts", command="traffic_server", enable_cache=False) + +# configure origin server +server = Test.MakeOriginServer("server") + +req_chk = {"headers": + "GET / HTTP/1.1\r\n" + "Host: origin\r\n" + "\r\n", + "timestamp": "1469733493.993", + "body": "" + } +res_chk = {"headers": + "HTTP/1.1 200 OK\r\n" + "Connection: close\r\n" + "\r\n", + "timestamp": "1469733493.993", + "body": "" + } +server.addResponse("sessionlog.json", req_chk, res_chk) + +req_hdr = {"headers": + "GET /path HTTP/1.1\r\n" + "Host: www.example.com\r\n" + "\r\n", + "timestamp": "1469733493.993", + "body": "" + } +res_hdr = {"headers": + "HTTP/1.1 200 OK\r\n" + "Connection: close\r\n" + "\r\n", + "timestamp": "1469733493.993", + "body": "" + } +server.addResponse("sessionlog.json", req_hdr, res_hdr) + +ts.Disk.remap_config.AddLines([ + f"map http://none/ http://127.0.0.1:{server.Variables.Port}", + f"map http://basic/ http://127.0.0.1:{server.Variables.Port} @plugin=money_trace.so", + f"map http://header/ http://127.0.0.1:{server.Variables.Port} @plugin=money_trace.so @pparam=--header=mt", + f"map http://pregen/ http://127.0.0.1:{server.Variables.Port} @plugin=money_trace.so @pparam=--pregen-header=@pregen", + f"map http://pgh/ http://127.0.0.1:{server.Variables.Port} @plugin=money_trace.so @pparam=--header=mt @pparam=--pregen-header=@pregen", + f"map http://create/ http://127.0.0.1:{server.Variables.Port} @plugin=money_trace.so @pparam=--create-if-none=true", + f"map http://cheader/ http://127.0.0.1:{server.Variables.Port} @plugin=money_trace.so @pparam=--create-if-none=true @pparam=--header=mt", + f"map http://cpregen/ http://127.0.0.1:{server.Variables.Port} @plugin=money_trace.so @pparam=--create-if-none=true @pparam=--pregen-header=@pregen", + f"map http://passthru/ http://127.0.0.1:{server.Variables.Port} @plugin=money_trace.so @pparam=--passthru=true", +]) + +# minimal configuration +ts.Disk.records_config.update({ + 'proxy.config.diags.debug.enabled': 0, + 'proxy.config.diags.debug.tags': 'money_trace', +}) + +ts.Disk.logging_yaml.AddLines( + ''' +logging: + formats: + - name: custom + format: 'cqh: %<{X-MoneyTrace}cqh> %<{mt}cqh> %<{@pregen}cqh> pqh: %<{X-MoneyTrace}pqh> %<{mt}pqh> psh: %<{X-MoneyTrace}psh> %<{mt}psh>' + logs: + - filename: remap + format: custom +'''.split("\n") +) + +Test.Disk.File(os.path.join(ts.Variables.LOGDIR, 'remap.log'), + exists=True, content='gold/remap-log.gold') + +curl_and_args = f"curl -s -D /dev/stdout -o /dev/stderr -x 127.0.0.1:{ts.Variables.port}" + +# 0 Test +tr = Test.AddTestRun("no plugin test") +ps = tr.Processes.Default +ps.StartBefore(server) +ps.StartBefore(Test.Processes.ts) +ps.Command = curl_and_args + " http://none/path" +ps.ReturnCode = 0 +tr.StillRunningAfter = ts +tr.StillRunningAfter = server + +# 1 Test +tr = Test.AddTestRun("basic config, no money trace client header") +ps = tr.Processes.Default +ps.Command = curl_and_args + " http://basic/path" +ps.ReturnCode = 0 +tr.StillRunningAfter = ts +tr.StillRunningAfter = server + + +def maketrace(name): + return f'trace-id={name};parent-id=foo;span-id=bar' + + +# 2 Test +tr = Test.AddTestRun("basic config, money trace client header") +ps = tr.Processes.Default +ps.Command = curl_and_args + ' http://basic/path -H "X-MoneyTrace: ' + maketrace("basic") + '"' +ps.ReturnCode = 0 +tr.StillRunningAfter = ts +tr.StillRunningAfter = server + +# 3 Test +tr = Test.AddTestRun("header config, mt client header") +ps = tr.Processes.Default +ps.Command = curl_and_args + ' http://header/path -H "mt: ' + maketrace("header") + '"' +ps.ReturnCode = 0 +tr.StillRunningAfter = ts +tr.StillRunningAfter = server + +# 4 Test +tr = Test.AddTestRun("pregen config, but no header passed in") +ps = tr.Processes.Default +ps.Command = curl_and_args + ' http://pregen/path' +ps.ReturnCode = 0 +tr.StillRunningAfter = ts +tr.StillRunningAfter = server + +# 5 Test +tr = Test.AddTestRun("pregen config, money trace client header") +ps = tr.Processes.Default +ps.Command = curl_and_args + ' http://pregen/path -H "X-MoneyTrace: ' + maketrace("pregen") + '"' +ps.ReturnCode = 0 +tr.StillRunningAfter = ts +tr.StillRunningAfter = server + +# 6 Test +tr = Test.AddTestRun("pregen config, mt client header") +ps = tr.Processes.Default +ps.Command = curl_and_args + ' http://pgh/path -H "mt: ' + maketrace("pgh") + '"' +ps.ReturnCode = 0 +tr.StillRunningAfter = ts +tr.StillRunningAfter = server + +# 7 Test +tr = Test.AddTestRun("create config, money trace client header") +ps = tr.Processes.Default +ps.Command = curl_and_args + ' http://create/path' +ps.ReturnCode = 0 +tr.StillRunningAfter = ts +tr.StillRunningAfter = server + +# 8 Test +tr = Test.AddTestRun("create config, mt client header") +ps = tr.Processes.Default +ps.Command = curl_and_args + ' http://cheader/path' +ps.ReturnCode = 0 +tr.StillRunningAfter = ts +tr.StillRunningAfter = server + +# 9 Test +tr = Test.AddTestRun("create config, pregen client header") +ps = tr.Processes.Default +ps.Command = curl_and_args + ' http://cpregen/path' +ps.ReturnCode = 0 +tr.StillRunningAfter = ts +tr.StillRunningAfter = server + +# 10 Test +tr = Test.AddTestRun("passthru mode") +ps = tr.Processes.Default +ps.Command = curl_and_args + ' http://passthru/path -H "X-MoneyTrace: ' + maketrace("passthru") + '"' +ps.ReturnCode = 0 +tr.StillRunningAfter = ts +tr.StillRunningAfter = server + +# Parsing robustness + +trace_strings = [ + "trace-id=spaces; parent-id=foo; span-id=bar", + "trace-id=noparent;span-id=8215111;span-name=this is some description", + "trace-id=badspan;span-id=", + "trace-id=traceonly", + "trace-id=traceonlysemi;", + "not a trace header", +] + +# 11 Test +for trace in trace_strings: + tr = Test.AddTestRun(trace) + ps = tr.Processes.Default + ps.Command = curl_and_args + ' http://pregen/path -H "X-MoneyTrace: ' + trace + '"' + ps.ReturnCode = 0 + tr.StillRunningAfter = ts + tr.StillRunningAfter = server + +# 11 Test +for trace in trace_strings: + tr = Test.AddTestRun(trace) + ps = tr.Processes.Default + ps.Command = curl_and_args + ' http://cpregen/path -H "X-MoneyTrace: ' + trace + '"' + ps.ReturnCode = 0 + tr.StillRunningAfter = ts + tr.StillRunningAfter = server + +# Wait for log file to appear, then wait one extra second to make sure TS is done writing it. +# 11 Test +tr = Test.AddTestRun() +ps = tr.Processes.Default +ps.Command = ( + os.path.join(Test.Variables.AtsTestToolsDir, 'condwait') + ' 60 1 -f ' + + os.path.join(ts.Variables.LOGDIR, 'remap.log') +) diff --git a/tests/gold_tests/pluginTest/money_trace/money_trace_global.test.py b/tests/gold_tests/pluginTest/money_trace/money_trace_global.test.py new file mode 100644 index 00000000000..d7092d85ee5 --- /dev/null +++ b/tests/gold_tests/pluginTest/money_trace/money_trace_global.test.py @@ -0,0 +1,126 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "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 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import os +Test.Summary = ''' +Test money_trace global +''' + +# Test description: + +Test.SkipUnless( + # Condition.PluginExists('xdebug.so'), + Condition.PluginExists('money_trace.so'), +) +Test.ContinueOnFail = False +Test.testName = "money_trace global" + +# Define ATS and configure +ts = Test.MakeATSProcess("ts", command="traffic_server", enable_cache=False) + +# configure origin server +server = Test.MakeOriginServer("server") + +req_chk = {"headers": + "GET / HTTP/1.1\r\n" + "Host: origin\r\n" + "\r\n", + "timestamp": "1469733493.993", + "body": "" + } +res_chk = {"headers": + "HTTP/1.1 200 OK\r\n" + "Connection: close\r\n" + "\r\n", + "timestamp": "1469733493.993", + "body": "" + } +server.addResponse("sessionlog.json", req_chk, res_chk) + +req_hdr = {"headers": + "GET /path HTTP/1.1\r\n" + "Host: www.example.com\r\n" + "\r\n", + "timestamp": "1469733493.993", + "body": "" + } +res_hdr = {"headers": + "HTTP/1.1 200 OK\r\n" + "Connection: close\r\n" + "\r\n", + "timestamp": "1469733493.993", + "body": "" + } +server.addResponse("sessionlog.json", req_hdr, res_hdr) + +ts.Disk.remap_config.AddLines([ + f"map http://ats http://127.0.0.1:{server.Variables.Port}", +]) + +ts.Disk.plugin_config.AddLine( + "money_trace.so --pregen-header=@pregen --header=MoneyTrace --create-if-none=true --global-skip-header=Skip-Global-MoneyTrace") + +# minimal configuration +ts.Disk.records_config.update({ + 'proxy.config.diags.debug.enabled': 0, + 'proxy.config.diags.debug.tags': 'money_trace', +}) + +ts.Disk.logging_yaml.AddLines( + ''' +logging: + formats: + - name: custom + format: 'cqh: %<{MoneyTrace}cqh> %<{@pregen}cqh> pqh: %<{MoneyTrace}pqh> psh: %<{MoneyTrace}psh>' + logs: + - filename: global + format: custom +'''.split("\n") +) + +Test.Disk.File(os.path.join(ts.Variables.LOGDIR, 'global.log'), + exists=True, content='gold/global-log.gold') + +curl_and_args = f"curl -s -D /dev/stdout -o /dev/stderr -x 127.0.0.1:{ts.Variables.port}" # -H 'X-Debug: Probe' " + +clientvalue = "trace-id=foo;parent-id=bar;span-id=baz" + +# 0 Test +tr = Test.AddTestRun("normal header test") +ps = tr.Processes.Default +ps.StartBefore(server, ready=When.PortOpen(server.Variables.Port)) +ps.StartBefore(Test.Processes.ts) +ps.Command = curl_and_args + ' http://ats/path -H "MoneyTrace: ' + clientvalue + '"' +ps.ReturnCode = 0 +tr.StillRunningAfter = ts +tr.StillRunningAfter = server + +# 1 Test +tr = Test.AddTestRun("skip plugin test - pregen will still be set") +ps = tr.Processes.Default +ps.Command = curl_and_args + ' http://ats/path -H "Skip-Global-MoneyTrace: true"' +ps.ReturnCode = 0 +tr.StillRunningAfter = ts +tr.StillRunningAfter = server + +# 2 Test +tr = Test.AddTestRun("create header test") +ps = tr.Processes.Default +ps.Command = curl_and_args + ' http://ats/path' +ps.ReturnCode = 0 +tr.StillRunningAfter = ts +tr.StillRunningAfter = server + +# Wait for log file to appear, then wait one extra second to make sure TS is done writing it. +tr = Test.AddTestRun() +ps = tr.Processes.Default +ps.Command = ( + os.path.join(Test.Variables.AtsTestToolsDir, 'condwait') + ' 60 1 -f ' + + os.path.join(ts.Variables.LOGDIR, 'global.log') +) +#ps.ReturnCode = 0 diff --git a/tests/gold_tests/pluginTest/parent_select/parent_select_peer.test.py b/tests/gold_tests/pluginTest/parent_select/parent_select_peer.test.py index f28b9c8a0a0..989cd0f5b52 100644 --- a/tests/gold_tests/pluginTest/parent_select/parent_select_peer.test.py +++ b/tests/gold_tests/pluginTest/parent_select/parent_select_peer.test.py @@ -80,7 +80,7 @@ ts.Disk.records_config.update({ 'proxy.config.diags.debug.enabled': 1, - 'proxy.config.diags.debug.tags': 'http|dns|parent|next_hop|host_statuses|hostdb|cachekey|plugin_nexthop', + 'proxy.config.diags.debug.tags': 'http|dns|parent|next_hop|host_statuses|hostdb|cachekey|pparent_select', 'proxy.config.dns.nameservers': f"127.0.0.1:{dns.Variables.Port}", # Only nameservers if resolv_conf NULL. 'proxy.config.dns.resolv_conf': "NULL", # This defaults to /etc/resvolv.conf (OS namesevers) if not NULL. 'proxy.config.http.cache.http': 1, @@ -171,7 +171,7 @@ tr = Test.AddTestRun() tr.Processes.Default.Command = ( "grep -e '^+++' -e '^[A-Z].*TTP/' -e '^.alts. --' -e 'PARENT_SPECIFIED' trace_peer*.log" - " | sed 's/^.*(plugin_nexthop) [^ ]* //' | sed 's/[.][0-9]*$$//'" + " | sed 's/^.*(pparent_select) [^ ]* //' | sed 's/[.][0-9]*$$//'" ) tr.Processes.Default.Streams.stdout = "peer.trace.gold" tr.Processes.Default.ReturnCode = 0 diff --git a/tests/gold_tests/pluginTest/parent_select/parent_select_peer2.test.py b/tests/gold_tests/pluginTest/parent_select/parent_select_peer2.test.py index e611c94614b..1f25447f91e 100644 --- a/tests/gold_tests/pluginTest/parent_select/parent_select_peer2.test.py +++ b/tests/gold_tests/pluginTest/parent_select/parent_select_peer2.test.py @@ -80,7 +80,7 @@ ts.Disk.records_config.update({ 'proxy.config.diags.debug.enabled': 1, - 'proxy.config.diags.debug.tags': 'http|dns|parent|next_hop|host_statuses|hostdb|plugin_nexthop', + 'proxy.config.diags.debug.tags': 'http|dns|parent|next_hop|host_statuses|hostdb|pparent_select', 'proxy.config.dns.nameservers': f"127.0.0.1:{dns.Variables.Port}", # Only nameservers if resolv_conf NULL. 'proxy.config.dns.resolv_conf': "NULL", # This defaults to /etc/resvolv.conf (OS namesevers) if not NULL. 'proxy.config.http.cache.http': 1, @@ -166,7 +166,7 @@ tr = Test.AddTestRun() tr.Processes.Default.Command = ( "grep -e '^+++' -e '^[A-Z].*TTP/' -e '^.alts. --' -e 'PARENT_SPECIFIED' trace_peer*.log" - " | sed 's/^.*(plugin_nexthop) [^ ]* //' | sed 's/[.][0-9]*$$//' " + normalize_ports + " | sed 's/^.*(pparent_select) [^ ]* //' | sed 's/[.][0-9]*$$//' " + normalize_ports ) tr.Processes.Default.Streams.stdout = "peer2.trace.gold" tr.Processes.Default.ReturnCode = 0 diff --git a/tests/gold_tests/pluginTest/parent_select/peer.trace.gold b/tests/gold_tests/pluginTest/parent_select/peer.trace.gold index 4c1810eebf3..85da7695933 100644 --- a/tests/gold_tests/pluginTest/parent_select/peer.trace.gold +++ b/tests/gold_tests/pluginTest/parent_select/peer.trace.gold @@ -1,10 +1,10 @@ trace_peer0.log:+++++++++ Incoming Request +++++++++ trace_peer0.log:GET http://dummy.com/obj0 HTTP/1.1 [0] state->result: PARENT_SPECIFIED Chosen parent: ts_peer3 -trace_peer0.log:+++++++++ Proxy's Request +++++++++ -trace_peer0.log:GET http://not_used/obj0 HTTP/1.1 [0] not firstcall, line_number: 0, result: PARENT_SPECIFIED [0] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream2 +trace_peer0.log:+++++++++ Proxy's Request +++++++++ +trace_peer0.log:GET http://not_used/obj0 HTTP/1.1 trace_peer0.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer0.log:GET http://not_used/obj0 HTTP/1.1 trace_peer0.log:+++++++++ Incoming O.S. Response +++++++++ @@ -18,10 +18,10 @@ trace_peer0.log:HTTP/1.1 200 OK trace_peer0.log:+++++++++ Incoming Request +++++++++ trace_peer0.log:GET http://not_used/obj7 HTTP/1.1 [1] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream5 -trace_peer0.log:+++++++++ Proxy's Request +++++++++ -trace_peer0.log:GET http://also_not_used/obj7 HTTP/1.1 [1] not firstcall, line_number: 0, result: PARENT_SPECIFIED [1] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream0 +trace_peer0.log:+++++++++ Proxy's Request +++++++++ +trace_peer0.log:GET http://also_not_used/obj7 HTTP/1.1 trace_peer0.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer0.log:GET http://also_not_used/obj7 HTTP/1.1 trace_peer0.log:+++++++++ Incoming O.S. Response +++++++++ @@ -35,10 +35,10 @@ trace_peer0.log:HTTP/1.1 200 OK trace_peer0.log:+++++++++ Incoming Request +++++++++ trace_peer0.log:GET http://dummy.com/obj8 HTTP/1.1 [2] state->result: PARENT_SPECIFIED Chosen parent: ts_peer6 -trace_peer0.log:+++++++++ Proxy's Request +++++++++ -trace_peer0.log:GET http://not_used/obj8 HTTP/1.1 [2] not firstcall, line_number: 0, result: PARENT_SPECIFIED [2] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream0 +trace_peer0.log:+++++++++ Proxy's Request +++++++++ +trace_peer0.log:GET http://not_used/obj8 HTTP/1.1 trace_peer0.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer0.log:GET http://not_used/obj8 HTTP/1.1 trace_peer0.log:+++++++++ Incoming O.S. Response +++++++++ @@ -82,10 +82,10 @@ trace_peer0.log:HTTP/1.1 200 OK trace_peer1.log:+++++++++ Incoming Request +++++++++ trace_peer1.log:GET http://dummy.com/obj1 HTTP/1.1 [0] state->result: PARENT_SPECIFIED Chosen parent: ts_peer5 -trace_peer1.log:+++++++++ Proxy's Request +++++++++ -trace_peer1.log:GET http://not_used/obj1 HTTP/1.1 [0] not firstcall, line_number: 0, result: PARENT_SPECIFIED [0] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream5 +trace_peer1.log:+++++++++ Proxy's Request +++++++++ +trace_peer1.log:GET http://not_used/obj1 HTTP/1.1 trace_peer1.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer1.log:GET http://not_used/obj1 HTTP/1.1 trace_peer1.log:+++++++++ Incoming O.S. Response +++++++++ @@ -99,10 +99,10 @@ trace_peer1.log:HTTP/1.1 200 OK trace_peer1.log:+++++++++ Incoming Request +++++++++ trace_peer1.log:GET http://dummy.com/obj9 HTTP/1.1 [1] state->result: PARENT_SPECIFIED Chosen parent: ts_peer7 -trace_peer1.log:+++++++++ Proxy's Request +++++++++ -trace_peer1.log:GET http://not_used/obj9 HTTP/1.1 [1] not firstcall, line_number: 0, result: PARENT_SPECIFIED [1] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream0 +trace_peer1.log:+++++++++ Proxy's Request +++++++++ +trace_peer1.log:GET http://not_used/obj9 HTTP/1.1 trace_peer1.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer1.log:GET http://not_used/obj9 HTTP/1.1 trace_peer1.log:+++++++++ Incoming O.S. Response +++++++++ @@ -116,10 +116,10 @@ trace_peer1.log:HTTP/1.1 200 OK trace_peer1.log:+++++++++ Incoming Request +++++++++ trace_peer1.log:GET http://not_used/obj10 HTTP/1.1 [2] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream4 -trace_peer1.log:+++++++++ Proxy's Request +++++++++ -trace_peer1.log:GET http://also_not_used/obj10 HTTP/1.1 [2] not firstcall, line_number: 0, result: PARENT_SPECIFIED [2] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream2 +trace_peer1.log:+++++++++ Proxy's Request +++++++++ +trace_peer1.log:GET http://also_not_used/obj10 HTTP/1.1 trace_peer1.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer1.log:GET http://also_not_used/obj10 HTTP/1.1 trace_peer1.log:+++++++++ Incoming O.S. Response +++++++++ @@ -133,10 +133,10 @@ trace_peer1.log:HTTP/1.1 200 OK trace_peer1.log:+++++++++ Incoming Request +++++++++ trace_peer1.log:GET http://dummy.com/obj3 HTTP/1.1 [3] state->result: PARENT_SPECIFIED Chosen parent: ts_peer2 -trace_peer1.log:+++++++++ Proxy's Request +++++++++ -trace_peer1.log:GET http://not_used/obj3 HTTP/1.1 [3] not firstcall, line_number: 0, result: PARENT_SPECIFIED [3] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream0 +trace_peer1.log:+++++++++ Proxy's Request +++++++++ +trace_peer1.log:GET http://not_used/obj3 HTTP/1.1 trace_peer1.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer1.log:GET http://not_used/obj3 HTTP/1.1 trace_peer1.log:+++++++++ Incoming O.S. Response +++++++++ @@ -160,10 +160,10 @@ trace_peer1.log:HTTP/1.1 200 OK trace_peer1.log:+++++++++ Incoming Request +++++++++ trace_peer1.log:GET http://dummy.com/obj11 HTTP/1.1 [5] state->result: PARENT_SPECIFIED Chosen parent: ts_peer7 -trace_peer1.log:+++++++++ Proxy's Request +++++++++ -trace_peer1.log:GET http://not_used/obj11 HTTP/1.1 [5] not firstcall, line_number: 0, result: PARENT_SPECIFIED [5] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream2 +trace_peer1.log:+++++++++ Proxy's Request +++++++++ +trace_peer1.log:GET http://not_used/obj11 HTTP/1.1 trace_peer1.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer1.log:GET http://not_used/obj11 HTTP/1.1 trace_peer1.log:+++++++++ Incoming O.S. Response +++++++++ @@ -177,10 +177,10 @@ trace_peer1.log:HTTP/1.1 200 OK trace_peer2.log:+++++++++ Incoming Request +++++++++ trace_peer2.log:GET http://dummy.com/obj2 HTTP/1.1 [0] state->result: PARENT_SPECIFIED Chosen parent: ts_peer7 -trace_peer2.log:+++++++++ Proxy's Request +++++++++ -trace_peer2.log:GET http://not_used/obj2 HTTP/1.1 [0] not firstcall, line_number: 0, result: PARENT_SPECIFIED [0] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream5 +trace_peer2.log:+++++++++ Proxy's Request +++++++++ +trace_peer2.log:GET http://not_used/obj2 HTTP/1.1 trace_peer2.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer2.log:GET http://not_used/obj2 HTTP/1.1 trace_peer2.log:+++++++++ Incoming O.S. Response +++++++++ @@ -194,10 +194,10 @@ trace_peer2.log:HTTP/1.1 200 OK trace_peer2.log:+++++++++ Incoming Request +++++++++ trace_peer2.log:GET http://not_used/obj3 HTTP/1.1 [1] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream0 -trace_peer2.log:+++++++++ Proxy's Request +++++++++ -trace_peer2.log:GET http://also_not_used/obj3 HTTP/1.1 [1] not firstcall, line_number: 0, result: PARENT_SPECIFIED [1] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream5 +trace_peer2.log:+++++++++ Proxy's Request +++++++++ +trace_peer2.log:GET http://also_not_used/obj3 HTTP/1.1 trace_peer2.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer2.log:GET http://also_not_used/obj3 HTTP/1.1 trace_peer2.log:+++++++++ Incoming O.S. Response +++++++++ @@ -211,10 +211,10 @@ trace_peer2.log:HTTP/1.1 200 OK trace_peer2.log:+++++++++ Incoming Request +++++++++ trace_peer2.log:GET http://not_used/obj4 HTTP/1.1 [2] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream0 -trace_peer2.log:+++++++++ Proxy's Request +++++++++ -trace_peer2.log:GET http://also_not_used/obj4 HTTP/1.1 [2] not firstcall, line_number: 0, result: PARENT_SPECIFIED [2] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream2 +trace_peer2.log:+++++++++ Proxy's Request +++++++++ +trace_peer2.log:GET http://also_not_used/obj4 HTTP/1.1 trace_peer2.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer2.log:GET http://also_not_used/obj4 HTTP/1.1 trace_peer2.log:+++++++++ Incoming O.S. Response +++++++++ @@ -228,10 +228,10 @@ trace_peer2.log:HTTP/1.1 200 OK trace_peer2.log:+++++++++ Incoming Request +++++++++ trace_peer2.log:GET http://not_used/obj5 HTTP/1.1 [3] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream5 -trace_peer2.log:+++++++++ Proxy's Request +++++++++ -trace_peer2.log:GET http://also_not_used/obj5 HTTP/1.1 [3] not firstcall, line_number: 0, result: PARENT_SPECIFIED [3] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream0 +trace_peer2.log:+++++++++ Proxy's Request +++++++++ +trace_peer2.log:GET http://also_not_used/obj5 HTTP/1.1 trace_peer2.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer2.log:GET http://also_not_used/obj5 HTTP/1.1 trace_peer2.log:+++++++++ Incoming O.S. Response +++++++++ @@ -245,10 +245,10 @@ trace_peer2.log:HTTP/1.1 200 OK trace_peer2.log:+++++++++ Incoming Request +++++++++ trace_peer2.log:GET http://not_used/obj6 HTTP/1.1 [4] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream5 -trace_peer2.log:+++++++++ Proxy's Request +++++++++ -trace_peer2.log:GET http://also_not_used/obj6 HTTP/1.1 [4] not firstcall, line_number: 0, result: PARENT_SPECIFIED [4] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream0 +trace_peer2.log:+++++++++ Proxy's Request +++++++++ +trace_peer2.log:GET http://also_not_used/obj6 HTTP/1.1 trace_peer2.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer2.log:GET http://also_not_used/obj6 HTTP/1.1 trace_peer2.log:+++++++++ Incoming O.S. Response +++++++++ @@ -262,10 +262,10 @@ trace_peer2.log:HTTP/1.1 200 OK trace_peer2.log:+++++++++ Incoming Request +++++++++ trace_peer2.log:GET http://dummy.com/obj10 HTTP/1.1 [5] state->result: PARENT_SPECIFIED Chosen parent: ts_peer1 -trace_peer2.log:+++++++++ Proxy's Request +++++++++ -trace_peer2.log:GET http://not_used/obj10 HTTP/1.1 [5] not firstcall, line_number: 0, result: PARENT_SPECIFIED [5] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream4 +trace_peer2.log:+++++++++ Proxy's Request +++++++++ +trace_peer2.log:GET http://not_used/obj10 HTTP/1.1 trace_peer2.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer2.log:GET http://not_used/obj10 HTTP/1.1 trace_peer2.log:+++++++++ Incoming O.S. Response +++++++++ @@ -279,10 +279,10 @@ trace_peer2.log:HTTP/1.1 200 OK trace_peer2.log:+++++++++ Incoming Request +++++++++ trace_peer2.log:GET http://not_used/obj12 HTTP/1.1 [6] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream0 -trace_peer2.log:+++++++++ Proxy's Request +++++++++ -trace_peer2.log:GET http://also_not_used/obj12 HTTP/1.1 [6] not firstcall, line_number: 0, result: PARENT_SPECIFIED [6] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream4 +trace_peer2.log:+++++++++ Proxy's Request +++++++++ +trace_peer2.log:GET http://also_not_used/obj12 HTTP/1.1 trace_peer2.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer2.log:GET http://also_not_used/obj12 HTTP/1.1 trace_peer2.log:+++++++++ Incoming O.S. Response +++++++++ @@ -316,10 +316,10 @@ trace_peer2.log:HTTP/1.1 200 OK trace_peer2.log:+++++++++ Incoming Request +++++++++ trace_peer2.log:GET http://dummy.com/obj6 HTTP/1.1 [9] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream5 -trace_peer2.log:+++++++++ Proxy's Request +++++++++ -trace_peer2.log:GET http://not_used/obj6 HTTP/1.1 [9] not firstcall, line_number: 0, result: PARENT_SPECIFIED [9] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream0 +trace_peer2.log:+++++++++ Proxy's Request +++++++++ +trace_peer2.log:GET http://not_used/obj6 HTTP/1.1 trace_peer2.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer2.log:GET http://not_used/obj6 HTTP/1.1 trace_peer2.log:+++++++++ Incoming O.S. Response +++++++++ @@ -333,10 +333,10 @@ trace_peer2.log:HTTP/1.1 200 OK trace_peer2.log:+++++++++ Incoming Request +++++++++ trace_peer2.log:GET http://dummy.com/obj14 HTTP/1.1 [10] state->result: PARENT_SPECIFIED Chosen parent: ts_peer5 -trace_peer2.log:+++++++++ Proxy's Request +++++++++ -trace_peer2.log:GET http://not_used/obj14 HTTP/1.1 [10] not firstcall, line_number: 0, result: PARENT_SPECIFIED [10] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream0 +trace_peer2.log:+++++++++ Proxy's Request +++++++++ +trace_peer2.log:GET http://not_used/obj14 HTTP/1.1 trace_peer2.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer2.log:GET http://not_used/obj14 HTTP/1.1 trace_peer2.log:+++++++++ Incoming O.S. Response +++++++++ @@ -350,10 +350,10 @@ trace_peer2.log:HTTP/1.1 200 OK trace_peer3.log:+++++++++ Incoming Request +++++++++ trace_peer3.log:GET http://not_used/obj0 HTTP/1.1 [0] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream2 -trace_peer3.log:+++++++++ Proxy's Request +++++++++ -trace_peer3.log:GET http://also_not_used/obj0 HTTP/1.1 [0] not firstcall, line_number: 0, result: PARENT_SPECIFIED [0] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream4 +trace_peer3.log:+++++++++ Proxy's Request +++++++++ +trace_peer3.log:GET http://also_not_used/obj0 HTTP/1.1 trace_peer3.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer3.log:GET http://also_not_used/obj0 HTTP/1.1 trace_peer3.log:+++++++++ Incoming O.S. Response +++++++++ @@ -367,10 +367,10 @@ trace_peer3.log:HTTP/1.1 200 OK trace_peer3.log:+++++++++ Incoming Request +++++++++ trace_peer3.log:GET http://dummy.com/obj3 HTTP/1.1 [1] state->result: PARENT_SPECIFIED Chosen parent: ts_peer2 -trace_peer3.log:+++++++++ Proxy's Request +++++++++ -trace_peer3.log:GET http://not_used/obj3 HTTP/1.1 [1] not firstcall, line_number: 0, result: PARENT_SPECIFIED [1] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream0 +trace_peer3.log:+++++++++ Proxy's Request +++++++++ +trace_peer3.log:GET http://not_used/obj3 HTTP/1.1 trace_peer3.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer3.log:GET http://not_used/obj3 HTTP/1.1 trace_peer3.log:+++++++++ Incoming O.S. Response +++++++++ @@ -384,10 +384,10 @@ trace_peer3.log:HTTP/1.1 200 OK trace_peer3.log:+++++++++ Incoming Request +++++++++ trace_peer3.log:GET http://dummy.com/obj11 HTTP/1.1 [2] state->result: PARENT_SPECIFIED Chosen parent: ts_peer7 -trace_peer3.log:+++++++++ Proxy's Request +++++++++ -trace_peer3.log:GET http://not_used/obj11 HTTP/1.1 [2] not firstcall, line_number: 0, result: PARENT_SPECIFIED [2] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream2 +trace_peer3.log:+++++++++ Proxy's Request +++++++++ +trace_peer3.log:GET http://not_used/obj11 HTTP/1.1 trace_peer3.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer3.log:GET http://not_used/obj11 HTTP/1.1 trace_peer3.log:+++++++++ Incoming O.S. Response +++++++++ @@ -401,10 +401,10 @@ trace_peer3.log:HTTP/1.1 200 OK trace_peer3.log:+++++++++ Incoming Request +++++++++ trace_peer3.log:GET http://not_used/obj13 HTTP/1.1 [3] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream2 -trace_peer3.log:+++++++++ Proxy's Request +++++++++ -trace_peer3.log:GET http://also_not_used/obj13 HTTP/1.1 [3] not firstcall, line_number: 0, result: PARENT_SPECIFIED [3] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream4 +trace_peer3.log:+++++++++ Proxy's Request +++++++++ +trace_peer3.log:GET http://also_not_used/obj13 HTTP/1.1 trace_peer3.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer3.log:GET http://also_not_used/obj13 HTTP/1.1 trace_peer3.log:+++++++++ Incoming O.S. Response +++++++++ @@ -418,10 +418,10 @@ trace_peer3.log:HTTP/1.1 200 OK trace_peer3.log:+++++++++ Incoming Request +++++++++ trace_peer3.log:GET http://not_used/obj15 HTTP/1.1 [4] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream4 -trace_peer3.log:+++++++++ Proxy's Request +++++++++ -trace_peer3.log:GET http://also_not_used/obj15 HTTP/1.1 [4] not firstcall, line_number: 0, result: PARENT_SPECIFIED [4] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream1 +trace_peer3.log:+++++++++ Proxy's Request +++++++++ +trace_peer3.log:GET http://also_not_used/obj15 HTTP/1.1 trace_peer3.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer3.log:GET http://also_not_used/obj15 HTTP/1.1 trace_peer3.log:+++++++++ Incoming O.S. Response +++++++++ @@ -435,10 +435,10 @@ trace_peer3.log:HTTP/1.1 200 OK trace_peer3.log:+++++++++ Incoming Request +++++++++ trace_peer3.log:GET http://dummy.com/obj1 HTTP/1.1 [5] state->result: PARENT_SPECIFIED Chosen parent: ts_peer5 -trace_peer3.log:+++++++++ Proxy's Request +++++++++ -trace_peer3.log:GET http://not_used/obj1 HTTP/1.1 [5] not firstcall, line_number: 0, result: PARENT_SPECIFIED [5] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream5 +trace_peer3.log:+++++++++ Proxy's Request +++++++++ +trace_peer3.log:GET http://not_used/obj1 HTTP/1.1 trace_peer3.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer3.log:GET http://not_used/obj1 HTTP/1.1 trace_peer3.log:+++++++++ Incoming O.S. Response +++++++++ @@ -452,10 +452,10 @@ trace_peer3.log:HTTP/1.1 200 OK trace_peer3.log:+++++++++ Incoming Request +++++++++ trace_peer3.log:GET http://dummy.com/obj9 HTTP/1.1 [6] state->result: PARENT_SPECIFIED Chosen parent: ts_peer7 -trace_peer3.log:+++++++++ Proxy's Request +++++++++ -trace_peer3.log:GET http://not_used/obj9 HTTP/1.1 [6] not firstcall, line_number: 0, result: PARENT_SPECIFIED [6] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream0 +trace_peer3.log:+++++++++ Proxy's Request +++++++++ +trace_peer3.log:GET http://not_used/obj9 HTTP/1.1 trace_peer3.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer3.log:GET http://not_used/obj9 HTTP/1.1 trace_peer3.log:+++++++++ Incoming O.S. Response +++++++++ @@ -489,10 +489,10 @@ trace_peer3.log:HTTP/1.1 200 OK trace_peer4.log:+++++++++ Incoming Request +++++++++ trace_peer4.log:GET http://dummy.com/obj4 HTTP/1.1 [0] state->result: PARENT_SPECIFIED Chosen parent: ts_peer2 -trace_peer4.log:+++++++++ Proxy's Request +++++++++ -trace_peer4.log:GET http://not_used/obj4 HTTP/1.1 [0] not firstcall, line_number: 0, result: PARENT_SPECIFIED [0] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream0 +trace_peer4.log:+++++++++ Proxy's Request +++++++++ +trace_peer4.log:GET http://not_used/obj4 HTTP/1.1 trace_peer4.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer4.log:GET http://not_used/obj4 HTTP/1.1 trace_peer4.log:+++++++++ Incoming O.S. Response +++++++++ @@ -506,10 +506,10 @@ trace_peer4.log:HTTP/1.1 200 OK trace_peer4.log:+++++++++ Incoming Request +++++++++ trace_peer4.log:GET http://dummy.com/obj12 HTTP/1.1 [1] state->result: PARENT_SPECIFIED Chosen parent: ts_peer2 -trace_peer4.log:+++++++++ Proxy's Request +++++++++ -trace_peer4.log:GET http://not_used/obj12 HTTP/1.1 [1] not firstcall, line_number: 0, result: PARENT_SPECIFIED [1] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream0 +trace_peer4.log:+++++++++ Proxy's Request +++++++++ +trace_peer4.log:GET http://not_used/obj12 HTTP/1.1 trace_peer4.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer4.log:GET http://not_used/obj12 HTTP/1.1 trace_peer4.log:+++++++++ Incoming O.S. Response +++++++++ @@ -543,10 +543,10 @@ trace_peer4.log:HTTP/1.1 200 OK trace_peer5.log:+++++++++ Incoming Request +++++++++ trace_peer5.log:GET http://not_used/obj1 HTTP/1.1 [0] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream5 -trace_peer5.log:+++++++++ Proxy's Request +++++++++ -trace_peer5.log:GET http://also_not_used/obj1 HTTP/1.1 [0] not firstcall, line_number: 0, result: PARENT_SPECIFIED [0] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream4 +trace_peer5.log:+++++++++ Proxy's Request +++++++++ +trace_peer5.log:GET http://also_not_used/obj1 HTTP/1.1 trace_peer5.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer5.log:GET http://also_not_used/obj1 HTTP/1.1 trace_peer5.log:+++++++++ Incoming O.S. Response +++++++++ @@ -560,10 +560,10 @@ trace_peer5.log:HTTP/1.1 200 OK trace_peer5.log:+++++++++ Incoming Request +++++++++ trace_peer5.log:GET http://dummy.com/obj5 HTTP/1.1 [1] state->result: PARENT_SPECIFIED Chosen parent: ts_peer2 -trace_peer5.log:+++++++++ Proxy's Request +++++++++ -trace_peer5.log:GET http://not_used/obj5 HTTP/1.1 [1] not firstcall, line_number: 0, result: PARENT_SPECIFIED [1] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream5 +trace_peer5.log:+++++++++ Proxy's Request +++++++++ +trace_peer5.log:GET http://not_used/obj5 HTTP/1.1 trace_peer5.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer5.log:GET http://not_used/obj5 HTTP/1.1 trace_peer5.log:+++++++++ Incoming O.S. Response +++++++++ @@ -577,10 +577,10 @@ trace_peer5.log:HTTP/1.1 200 OK trace_peer5.log:+++++++++ Incoming Request +++++++++ trace_peer5.log:GET http://dummy.com/obj13 HTTP/1.1 [2] state->result: PARENT_SPECIFIED Chosen parent: ts_peer3 -trace_peer5.log:+++++++++ Proxy's Request +++++++++ -trace_peer5.log:GET http://not_used/obj13 HTTP/1.1 [2] not firstcall, line_number: 0, result: PARENT_SPECIFIED [2] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream2 +trace_peer5.log:+++++++++ Proxy's Request +++++++++ +trace_peer5.log:GET http://not_used/obj13 HTTP/1.1 trace_peer5.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer5.log:GET http://not_used/obj13 HTTP/1.1 trace_peer5.log:+++++++++ Incoming O.S. Response +++++++++ @@ -594,10 +594,10 @@ trace_peer5.log:HTTP/1.1 200 OK trace_peer5.log:+++++++++ Incoming Request +++++++++ trace_peer5.log:GET http://not_used/obj14 HTTP/1.1 [3] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream0 -trace_peer5.log:+++++++++ Proxy's Request +++++++++ -trace_peer5.log:GET http://also_not_used/obj14 HTTP/1.1 [3] not firstcall, line_number: 0, result: PARENT_SPECIFIED [3] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream1 +trace_peer5.log:+++++++++ Proxy's Request +++++++++ +trace_peer5.log:GET http://also_not_used/obj14 HTTP/1.1 trace_peer5.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer5.log:GET http://also_not_used/obj14 HTTP/1.1 trace_peer5.log:+++++++++ Incoming O.S. Response +++++++++ @@ -621,10 +621,10 @@ trace_peer5.log:HTTP/1.1 200 OK trace_peer5.log:+++++++++ Incoming Request +++++++++ trace_peer5.log:GET http://dummy.com/obj7 HTTP/1.1 [5] state->result: PARENT_SPECIFIED Chosen parent: ts_peer0 -trace_peer5.log:+++++++++ Proxy's Request +++++++++ -trace_peer5.log:GET http://not_used/obj7 HTTP/1.1 [5] not firstcall, line_number: 0, result: PARENT_SPECIFIED [5] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream5 +trace_peer5.log:+++++++++ Proxy's Request +++++++++ +trace_peer5.log:GET http://not_used/obj7 HTTP/1.1 trace_peer5.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer5.log:GET http://not_used/obj7 HTTP/1.1 trace_peer5.log:+++++++++ Incoming O.S. Response +++++++++ @@ -648,10 +648,10 @@ trace_peer5.log:HTTP/1.1 200 OK trace_peer5.log:+++++++++ Incoming Request +++++++++ trace_peer5.log:GET http://dummy.com/obj15 HTTP/1.1 [7] state->result: PARENT_SPECIFIED Chosen parent: ts_peer3 -trace_peer5.log:+++++++++ Proxy's Request +++++++++ -trace_peer5.log:GET http://not_used/obj15 HTTP/1.1 [7] not firstcall, line_number: 0, result: PARENT_SPECIFIED [7] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream4 +trace_peer5.log:+++++++++ Proxy's Request +++++++++ +trace_peer5.log:GET http://not_used/obj15 HTTP/1.1 trace_peer5.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer5.log:GET http://not_used/obj15 HTTP/1.1 trace_peer5.log:+++++++++ Incoming O.S. Response +++++++++ @@ -665,10 +665,10 @@ trace_peer5.log:HTTP/1.1 200 OK trace_peer6.log:+++++++++ Incoming Request +++++++++ trace_peer6.log:GET http://dummy.com/obj6 HTTP/1.1 [0] state->result: PARENT_SPECIFIED Chosen parent: ts_peer2 -trace_peer6.log:+++++++++ Proxy's Request +++++++++ -trace_peer6.log:GET http://not_used/obj6 HTTP/1.1 [0] not firstcall, line_number: 0, result: PARENT_SPECIFIED [0] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream5 +trace_peer6.log:+++++++++ Proxy's Request +++++++++ +trace_peer6.log:GET http://not_used/obj6 HTTP/1.1 trace_peer6.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer6.log:GET http://not_used/obj6 HTTP/1.1 trace_peer6.log:+++++++++ Incoming O.S. Response +++++++++ @@ -682,10 +682,10 @@ trace_peer6.log:HTTP/1.1 200 OK trace_peer6.log:+++++++++ Incoming Request +++++++++ trace_peer6.log:GET http://not_used/obj8 HTTP/1.1 [1] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream0 -trace_peer6.log:+++++++++ Proxy's Request +++++++++ -trace_peer6.log:GET http://also_not_used/obj8 HTTP/1.1 [1] not firstcall, line_number: 0, result: PARENT_SPECIFIED [1] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream3 +trace_peer6.log:+++++++++ Proxy's Request +++++++++ +trace_peer6.log:GET http://also_not_used/obj8 HTTP/1.1 trace_peer6.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer6.log:GET http://also_not_used/obj8 HTTP/1.1 trace_peer6.log:+++++++++ Incoming O.S. Response +++++++++ @@ -699,10 +699,10 @@ trace_peer6.log:HTTP/1.1 200 OK trace_peer6.log:+++++++++ Incoming Request +++++++++ trace_peer6.log:GET http://dummy.com/obj14 HTTP/1.1 [2] state->result: PARENT_SPECIFIED Chosen parent: ts_peer5 -trace_peer6.log:+++++++++ Proxy's Request +++++++++ -trace_peer6.log:GET http://not_used/obj14 HTTP/1.1 [2] not firstcall, line_number: 0, result: PARENT_SPECIFIED [2] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream0 +trace_peer6.log:+++++++++ Proxy's Request +++++++++ +trace_peer6.log:GET http://not_used/obj14 HTTP/1.1 trace_peer6.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer6.log:GET http://not_used/obj14 HTTP/1.1 trace_peer6.log:+++++++++ Incoming O.S. Response +++++++++ @@ -716,10 +716,10 @@ trace_peer6.log:HTTP/1.1 200 OK trace_peer6.log:+++++++++ Incoming Request +++++++++ trace_peer6.log:GET http://dummy.com/obj2 HTTP/1.1 [3] state->result: PARENT_SPECIFIED Chosen parent: ts_peer7 -trace_peer6.log:+++++++++ Proxy's Request +++++++++ -trace_peer6.log:GET http://not_used/obj2 HTTP/1.1 [3] not firstcall, line_number: 0, result: PARENT_SPECIFIED [3] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream5 +trace_peer6.log:+++++++++ Proxy's Request +++++++++ +trace_peer6.log:GET http://not_used/obj2 HTTP/1.1 trace_peer6.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer6.log:GET http://not_used/obj2 HTTP/1.1 trace_peer6.log:+++++++++ Incoming O.S. Response +++++++++ @@ -733,10 +733,10 @@ trace_peer6.log:HTTP/1.1 200 OK trace_peer6.log:+++++++++ Incoming Request +++++++++ trace_peer6.log:GET http://dummy.com/obj10 HTTP/1.1 [4] state->result: PARENT_SPECIFIED Chosen parent: ts_peer1 -trace_peer6.log:+++++++++ Proxy's Request +++++++++ -trace_peer6.log:GET http://not_used/obj10 HTTP/1.1 [4] not firstcall, line_number: 0, result: PARENT_SPECIFIED [4] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream4 +trace_peer6.log:+++++++++ Proxy's Request +++++++++ +trace_peer6.log:GET http://not_used/obj10 HTTP/1.1 trace_peer6.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer6.log:GET http://not_used/obj10 HTTP/1.1 trace_peer6.log:+++++++++ Incoming O.S. Response +++++++++ @@ -750,10 +750,10 @@ trace_peer6.log:HTTP/1.1 200 OK trace_peer7.log:+++++++++ Incoming Request +++++++++ trace_peer7.log:GET http://not_used/obj2 HTTP/1.1 [0] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream5 -trace_peer7.log:+++++++++ Proxy's Request +++++++++ -trace_peer7.log:GET http://also_not_used/obj2 HTTP/1.1 [0] not firstcall, line_number: 0, result: PARENT_SPECIFIED [0] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream2 +trace_peer7.log:+++++++++ Proxy's Request +++++++++ +trace_peer7.log:GET http://also_not_used/obj2 HTTP/1.1 trace_peer7.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer7.log:GET http://also_not_used/obj2 HTTP/1.1 trace_peer7.log:+++++++++ Incoming O.S. Response +++++++++ @@ -767,10 +767,10 @@ trace_peer7.log:HTTP/1.1 200 OK trace_peer7.log:+++++++++ Incoming Request +++++++++ trace_peer7.log:GET http://dummy.com/obj7 HTTP/1.1 [1] state->result: PARENT_SPECIFIED Chosen parent: ts_peer0 -trace_peer7.log:+++++++++ Proxy's Request +++++++++ -trace_peer7.log:GET http://not_used/obj7 HTTP/1.1 [1] not firstcall, line_number: 0, result: PARENT_SPECIFIED [1] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream5 +trace_peer7.log:+++++++++ Proxy's Request +++++++++ +trace_peer7.log:GET http://not_used/obj7 HTTP/1.1 trace_peer7.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer7.log:GET http://not_used/obj7 HTTP/1.1 trace_peer7.log:+++++++++ Incoming O.S. Response +++++++++ @@ -784,10 +784,10 @@ trace_peer7.log:HTTP/1.1 200 OK trace_peer7.log:+++++++++ Incoming Request +++++++++ trace_peer7.log:GET http://not_used/obj9 HTTP/1.1 [2] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream0 -trace_peer7.log:+++++++++ Proxy's Request +++++++++ -trace_peer7.log:GET http://also_not_used/obj9 HTTP/1.1 [2] not firstcall, line_number: 0, result: PARENT_SPECIFIED [2] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream2 +trace_peer7.log:+++++++++ Proxy's Request +++++++++ +trace_peer7.log:GET http://also_not_used/obj9 HTTP/1.1 trace_peer7.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer7.log:GET http://also_not_used/obj9 HTTP/1.1 trace_peer7.log:+++++++++ Incoming O.S. Response +++++++++ @@ -801,10 +801,10 @@ trace_peer7.log:HTTP/1.1 200 OK trace_peer7.log:+++++++++ Incoming Request +++++++++ trace_peer7.log:GET http://not_used/obj11 HTTP/1.1 [3] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream2 -trace_peer7.log:+++++++++ Proxy's Request +++++++++ -trace_peer7.log:GET http://also_not_used/obj11 HTTP/1.1 [3] not firstcall, line_number: 0, result: PARENT_SPECIFIED [3] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream5 +trace_peer7.log:+++++++++ Proxy's Request +++++++++ +trace_peer7.log:GET http://also_not_used/obj11 HTTP/1.1 trace_peer7.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer7.log:GET http://also_not_used/obj11 HTTP/1.1 trace_peer7.log:+++++++++ Incoming O.S. Response +++++++++ @@ -818,10 +818,10 @@ trace_peer7.log:HTTP/1.1 200 OK trace_peer7.log:+++++++++ Incoming Request +++++++++ trace_peer7.log:GET http://dummy.com/obj15 HTTP/1.1 [4] state->result: PARENT_SPECIFIED Chosen parent: ts_peer3 -trace_peer7.log:+++++++++ Proxy's Request +++++++++ -trace_peer7.log:GET http://not_used/obj15 HTTP/1.1 [4] not firstcall, line_number: 0, result: PARENT_SPECIFIED [4] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream4 +trace_peer7.log:+++++++++ Proxy's Request +++++++++ +trace_peer7.log:GET http://not_used/obj15 HTTP/1.1 trace_peer7.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer7.log:GET http://not_used/obj15 HTTP/1.1 trace_peer7.log:+++++++++ Incoming O.S. Response +++++++++ @@ -845,10 +845,10 @@ trace_peer7.log:HTTP/1.1 200 OK trace_peer7.log:+++++++++ Incoming Request +++++++++ trace_peer7.log:GET http://dummy.com/obj5 HTTP/1.1 [6] state->result: PARENT_SPECIFIED Chosen parent: ts_peer2 -trace_peer7.log:+++++++++ Proxy's Request +++++++++ -trace_peer7.log:GET http://not_used/obj5 HTTP/1.1 [6] not firstcall, line_number: 0, result: PARENT_SPECIFIED [6] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream5 +trace_peer7.log:+++++++++ Proxy's Request +++++++++ +trace_peer7.log:GET http://not_used/obj5 HTTP/1.1 trace_peer7.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer7.log:GET http://not_used/obj5 HTTP/1.1 trace_peer7.log:+++++++++ Incoming O.S. Response +++++++++ @@ -882,10 +882,10 @@ trace_peer7.log:HTTP/1.1 200 OK trace_peer7.log:+++++++++ Incoming Request +++++++++ trace_peer7.log:GET http://dummy.com/obj13 HTTP/1.1 [9] state->result: PARENT_SPECIFIED Chosen parent: ts_peer3 -trace_peer7.log:+++++++++ Proxy's Request +++++++++ -trace_peer7.log:GET http://not_used/obj13 HTTP/1.1 [9] not firstcall, line_number: 0, result: PARENT_SPECIFIED [9] state->result: PARENT_SPECIFIED Chosen parent: ts_upstream2 +trace_peer7.log:+++++++++ Proxy's Request +++++++++ +trace_peer7.log:GET http://not_used/obj13 HTTP/1.1 trace_peer7.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer7.log:GET http://not_used/obj13 HTTP/1.1 trace_peer7.log:+++++++++ Incoming O.S. Response +++++++++ diff --git a/tests/gold_tests/pluginTest/parent_select/peer2.trace.gold b/tests/gold_tests/pluginTest/parent_select/peer2.trace.gold index 47eee1d8356..784cf5ed7d9 100644 --- a/tests/gold_tests/pluginTest/parent_select/peer2.trace.gold +++ b/tests/gold_tests/pluginTest/parent_select/peer2.trace.gold @@ -1,9 +1,9 @@ trace_peer0.log:+++++++++ Incoming Request +++++++++ trace_peer0.log:GET http://ts_upstream0:UP_PORT0/obj0 HTTP/1.1 [0] state->result: PARENT_SPECIFIED Chosen parent: ts_peer3 +[0] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer0.log:+++++++++ Proxy's Request +++++++++ trace_peer0.log:GET http://ts_upstream0:UP_PORT0/obj0 HTTP/1.1 -[0] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer0.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer0.log:GET http://ts_upstream0:UP_PORT0/obj0 HTTP/1.1 trace_peer0.log:+++++++++ Incoming O.S. Response +++++++++ @@ -31,9 +31,9 @@ trace_peer0.log:HTTP/1.1 200 OK trace_peer0.log:+++++++++ Incoming Request +++++++++ trace_peer0.log:GET http://ts_upstream0:UP_PORT0/obj8 HTTP/1.1 [2] state->result: PARENT_SPECIFIED Chosen parent: ts_peer6 +[2] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer0.log:+++++++++ Proxy's Request +++++++++ trace_peer0.log:GET http://ts_upstream0:UP_PORT0/obj8 HTTP/1.1 -[2] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer0.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer0.log:GET http://ts_upstream0:UP_PORT0/obj8 HTTP/1.1 trace_peer0.log:+++++++++ Incoming O.S. Response +++++++++ @@ -76,9 +76,9 @@ trace_peer0.log:HTTP/1.1 200 OK trace_peer1.log:+++++++++ Incoming Request +++++++++ trace_peer1.log:GET http://ts_upstream0:UP_PORT0/obj1 HTTP/1.1 [0] state->result: PARENT_SPECIFIED Chosen parent: ts_peer5 +[0] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer1.log:+++++++++ Proxy's Request +++++++++ trace_peer1.log:GET http://ts_upstream0:UP_PORT0/obj1 HTTP/1.1 -[0] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer1.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer1.log:GET http://ts_upstream0:UP_PORT0/obj1 HTTP/1.1 trace_peer1.log:+++++++++ Incoming O.S. Response +++++++++ @@ -92,9 +92,9 @@ trace_peer1.log:HTTP/1.1 200 OK trace_peer1.log:+++++++++ Incoming Request +++++++++ trace_peer1.log:GET http://ts_upstream0:UP_PORT0/obj9 HTTP/1.1 [1] state->result: PARENT_SPECIFIED Chosen parent: ts_peer7 +[1] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer1.log:+++++++++ Proxy's Request +++++++++ trace_peer1.log:GET http://ts_upstream0:UP_PORT0/obj9 HTTP/1.1 -[1] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer1.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer1.log:GET http://ts_upstream0:UP_PORT0/obj9 HTTP/1.1 trace_peer1.log:+++++++++ Incoming O.S. Response +++++++++ @@ -122,9 +122,9 @@ trace_peer1.log:HTTP/1.1 200 OK trace_peer1.log:+++++++++ Incoming Request +++++++++ trace_peer1.log:GET http://ts_upstream0:UP_PORT0/obj3 HTTP/1.1 [3] state->result: PARENT_SPECIFIED Chosen parent: ts_peer2 +[3] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer1.log:+++++++++ Proxy's Request +++++++++ trace_peer1.log:GET http://ts_upstream0:UP_PORT0/obj3 HTTP/1.1 -[3] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer1.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer1.log:GET http://ts_upstream0:UP_PORT0/obj3 HTTP/1.1 trace_peer1.log:+++++++++ Incoming O.S. Response +++++++++ @@ -147,9 +147,9 @@ trace_peer1.log:HTTP/1.1 200 OK trace_peer1.log:+++++++++ Incoming Request +++++++++ trace_peer1.log:GET http://ts_upstream0:UP_PORT0/obj11 HTTP/1.1 [5] state->result: PARENT_SPECIFIED Chosen parent: ts_peer7 +[5] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer1.log:+++++++++ Proxy's Request +++++++++ trace_peer1.log:GET http://ts_upstream0:UP_PORT0/obj11 HTTP/1.1 -[5] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer1.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer1.log:GET http://ts_upstream0:UP_PORT0/obj11 HTTP/1.1 trace_peer1.log:+++++++++ Incoming O.S. Response +++++++++ @@ -163,9 +163,9 @@ trace_peer1.log:HTTP/1.1 200 OK trace_peer2.log:+++++++++ Incoming Request +++++++++ trace_peer2.log:GET http://ts_upstream0:UP_PORT0/obj2 HTTP/1.1 [0] state->result: PARENT_SPECIFIED Chosen parent: ts_peer7 +[0] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer2.log:+++++++++ Proxy's Request +++++++++ trace_peer2.log:GET http://ts_upstream0:UP_PORT0/obj2 HTTP/1.1 -[0] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer2.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer2.log:GET http://ts_upstream0:UP_PORT0/obj2 HTTP/1.1 trace_peer2.log:+++++++++ Incoming O.S. Response +++++++++ @@ -235,9 +235,9 @@ trace_peer2.log:HTTP/1.1 200 OK trace_peer2.log:+++++++++ Incoming Request +++++++++ trace_peer2.log:GET http://ts_upstream0:UP_PORT0/obj10 HTTP/1.1 [5] state->result: PARENT_SPECIFIED Chosen parent: ts_peer1 +[5] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer2.log:+++++++++ Proxy's Request +++++++++ trace_peer2.log:GET http://ts_upstream0:UP_PORT0/obj10 HTTP/1.1 -[5] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer2.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer2.log:GET http://ts_upstream0:UP_PORT0/obj10 HTTP/1.1 trace_peer2.log:+++++++++ Incoming O.S. Response +++++++++ @@ -292,9 +292,9 @@ trace_peer2.log:HTTP/1.1 200 OK trace_peer2.log:+++++++++ Incoming Request +++++++++ trace_peer2.log:GET http://ts_upstream0:UP_PORT0/obj14 HTTP/1.1 [10] state->result: PARENT_SPECIFIED Chosen parent: ts_peer5 +[10] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer2.log:+++++++++ Proxy's Request +++++++++ trace_peer2.log:GET http://ts_upstream0:UP_PORT0/obj14 HTTP/1.1 -[10] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer2.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer2.log:GET http://ts_upstream0:UP_PORT0/obj14 HTTP/1.1 trace_peer2.log:+++++++++ Incoming O.S. Response +++++++++ @@ -322,9 +322,9 @@ trace_peer3.log:HTTP/1.1 200 OK trace_peer3.log:+++++++++ Incoming Request +++++++++ trace_peer3.log:GET http://ts_upstream0:UP_PORT0/obj3 HTTP/1.1 [1] state->result: PARENT_SPECIFIED Chosen parent: ts_peer2 +[1] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer3.log:+++++++++ Proxy's Request +++++++++ trace_peer3.log:GET http://ts_upstream0:UP_PORT0/obj3 HTTP/1.1 -[1] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer3.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer3.log:GET http://ts_upstream0:UP_PORT0/obj3 HTTP/1.1 trace_peer3.log:+++++++++ Incoming O.S. Response +++++++++ @@ -338,9 +338,9 @@ trace_peer3.log:HTTP/1.1 200 OK trace_peer3.log:+++++++++ Incoming Request +++++++++ trace_peer3.log:GET http://ts_upstream0:UP_PORT0/obj11 HTTP/1.1 [2] state->result: PARENT_SPECIFIED Chosen parent: ts_peer7 +[2] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer3.log:+++++++++ Proxy's Request +++++++++ trace_peer3.log:GET http://ts_upstream0:UP_PORT0/obj11 HTTP/1.1 -[2] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer3.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer3.log:GET http://ts_upstream0:UP_PORT0/obj11 HTTP/1.1 trace_peer3.log:+++++++++ Incoming O.S. Response +++++++++ @@ -382,9 +382,9 @@ trace_peer3.log:HTTP/1.1 200 OK trace_peer3.log:+++++++++ Incoming Request +++++++++ trace_peer3.log:GET http://ts_upstream0:UP_PORT0/obj1 HTTP/1.1 [5] state->result: PARENT_SPECIFIED Chosen parent: ts_peer5 +[5] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer3.log:+++++++++ Proxy's Request +++++++++ trace_peer3.log:GET http://ts_upstream0:UP_PORT0/obj1 HTTP/1.1 -[5] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer3.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer3.log:GET http://ts_upstream0:UP_PORT0/obj1 HTTP/1.1 trace_peer3.log:+++++++++ Incoming O.S. Response +++++++++ @@ -398,9 +398,9 @@ trace_peer3.log:HTTP/1.1 200 OK trace_peer3.log:+++++++++ Incoming Request +++++++++ trace_peer3.log:GET http://ts_upstream0:UP_PORT0/obj9 HTTP/1.1 [6] state->result: PARENT_SPECIFIED Chosen parent: ts_peer7 +[6] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer3.log:+++++++++ Proxy's Request +++++++++ trace_peer3.log:GET http://ts_upstream0:UP_PORT0/obj9 HTTP/1.1 -[6] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer3.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer3.log:GET http://ts_upstream0:UP_PORT0/obj9 HTTP/1.1 trace_peer3.log:+++++++++ Incoming O.S. Response +++++++++ @@ -432,9 +432,9 @@ trace_peer3.log:HTTP/1.1 200 OK trace_peer4.log:+++++++++ Incoming Request +++++++++ trace_peer4.log:GET http://ts_upstream0:UP_PORT0/obj4 HTTP/1.1 [0] state->result: PARENT_SPECIFIED Chosen parent: ts_peer2 +[0] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer4.log:+++++++++ Proxy's Request +++++++++ trace_peer4.log:GET http://ts_upstream0:UP_PORT0/obj4 HTTP/1.1 -[0] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer4.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer4.log:GET http://ts_upstream0:UP_PORT0/obj4 HTTP/1.1 trace_peer4.log:+++++++++ Incoming O.S. Response +++++++++ @@ -448,9 +448,9 @@ trace_peer4.log:HTTP/1.1 200 OK trace_peer4.log:+++++++++ Incoming Request +++++++++ trace_peer4.log:GET http://ts_upstream0:UP_PORT0/obj12 HTTP/1.1 [1] state->result: PARENT_SPECIFIED Chosen parent: ts_peer2 +[1] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer4.log:+++++++++ Proxy's Request +++++++++ trace_peer4.log:GET http://ts_upstream0:UP_PORT0/obj12 HTTP/1.1 -[1] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer4.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer4.log:GET http://ts_upstream0:UP_PORT0/obj12 HTTP/1.1 trace_peer4.log:+++++++++ Incoming O.S. Response +++++++++ @@ -498,9 +498,9 @@ trace_peer5.log:HTTP/1.1 200 OK trace_peer5.log:+++++++++ Incoming Request +++++++++ trace_peer5.log:GET http://ts_upstream0:UP_PORT0/obj5 HTTP/1.1 [1] state->result: PARENT_SPECIFIED Chosen parent: ts_peer2 +[1] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer5.log:+++++++++ Proxy's Request +++++++++ trace_peer5.log:GET http://ts_upstream0:UP_PORT0/obj5 HTTP/1.1 -[1] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer5.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer5.log:GET http://ts_upstream0:UP_PORT0/obj5 HTTP/1.1 trace_peer5.log:+++++++++ Incoming O.S. Response +++++++++ @@ -514,9 +514,9 @@ trace_peer5.log:HTTP/1.1 200 OK trace_peer5.log:+++++++++ Incoming Request +++++++++ trace_peer5.log:GET http://ts_upstream0:UP_PORT0/obj13 HTTP/1.1 [2] state->result: PARENT_SPECIFIED Chosen parent: ts_peer3 +[2] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer5.log:+++++++++ Proxy's Request +++++++++ trace_peer5.log:GET http://ts_upstream0:UP_PORT0/obj13 HTTP/1.1 -[2] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer5.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer5.log:GET http://ts_upstream0:UP_PORT0/obj13 HTTP/1.1 trace_peer5.log:+++++++++ Incoming O.S. Response +++++++++ @@ -553,9 +553,9 @@ trace_peer5.log:HTTP/1.1 200 OK trace_peer5.log:+++++++++ Incoming Request +++++++++ trace_peer5.log:GET http://ts_upstream0:UP_PORT0/obj7 HTTP/1.1 [5] state->result: PARENT_SPECIFIED Chosen parent: ts_peer0 +[5] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer5.log:+++++++++ Proxy's Request +++++++++ trace_peer5.log:GET http://ts_upstream0:UP_PORT0/obj7 HTTP/1.1 -[5] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer5.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer5.log:GET http://ts_upstream0:UP_PORT0/obj7 HTTP/1.1 trace_peer5.log:+++++++++ Incoming O.S. Response +++++++++ @@ -578,9 +578,9 @@ trace_peer5.log:HTTP/1.1 200 OK trace_peer5.log:+++++++++ Incoming Request +++++++++ trace_peer5.log:GET http://ts_upstream0:UP_PORT0/obj15 HTTP/1.1 [7] state->result: PARENT_SPECIFIED Chosen parent: ts_peer3 +[7] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer5.log:+++++++++ Proxy's Request +++++++++ trace_peer5.log:GET http://ts_upstream0:UP_PORT0/obj15 HTTP/1.1 -[7] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer5.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer5.log:GET http://ts_upstream0:UP_PORT0/obj15 HTTP/1.1 trace_peer5.log:+++++++++ Incoming O.S. Response +++++++++ @@ -594,9 +594,9 @@ trace_peer5.log:HTTP/1.1 200 OK trace_peer6.log:+++++++++ Incoming Request +++++++++ trace_peer6.log:GET http://ts_upstream0:UP_PORT0/obj6 HTTP/1.1 [0] state->result: PARENT_SPECIFIED Chosen parent: ts_peer2 +[0] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer6.log:+++++++++ Proxy's Request +++++++++ trace_peer6.log:GET http://ts_upstream0:UP_PORT0/obj6 HTTP/1.1 -[0] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer6.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer6.log:GET http://ts_upstream0:UP_PORT0/obj6 HTTP/1.1 trace_peer6.log:+++++++++ Incoming O.S. Response +++++++++ @@ -624,9 +624,9 @@ trace_peer6.log:HTTP/1.1 200 OK trace_peer6.log:+++++++++ Incoming Request +++++++++ trace_peer6.log:GET http://ts_upstream0:UP_PORT0/obj14 HTTP/1.1 [2] state->result: PARENT_SPECIFIED Chosen parent: ts_peer5 +[2] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer6.log:+++++++++ Proxy's Request +++++++++ trace_peer6.log:GET http://ts_upstream0:UP_PORT0/obj14 HTTP/1.1 -[2] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer6.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer6.log:GET http://ts_upstream0:UP_PORT0/obj14 HTTP/1.1 trace_peer6.log:+++++++++ Incoming O.S. Response +++++++++ @@ -640,9 +640,9 @@ trace_peer6.log:HTTP/1.1 200 OK trace_peer6.log:+++++++++ Incoming Request +++++++++ trace_peer6.log:GET http://ts_upstream0:UP_PORT0/obj2 HTTP/1.1 [3] state->result: PARENT_SPECIFIED Chosen parent: ts_peer7 +[3] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer6.log:+++++++++ Proxy's Request +++++++++ trace_peer6.log:GET http://ts_upstream0:UP_PORT0/obj2 HTTP/1.1 -[3] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer6.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer6.log:GET http://ts_upstream0:UP_PORT0/obj2 HTTP/1.1 trace_peer6.log:+++++++++ Incoming O.S. Response +++++++++ @@ -656,9 +656,9 @@ trace_peer6.log:HTTP/1.1 200 OK trace_peer6.log:+++++++++ Incoming Request +++++++++ trace_peer6.log:GET http://ts_upstream0:UP_PORT0/obj10 HTTP/1.1 [4] state->result: PARENT_SPECIFIED Chosen parent: ts_peer1 +[4] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer6.log:+++++++++ Proxy's Request +++++++++ trace_peer6.log:GET http://ts_upstream0:UP_PORT0/obj10 HTTP/1.1 -[4] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer6.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer6.log:GET http://ts_upstream0:UP_PORT0/obj10 HTTP/1.1 trace_peer6.log:+++++++++ Incoming O.S. Response +++++++++ @@ -686,9 +686,9 @@ trace_peer7.log:HTTP/1.1 200 OK trace_peer7.log:+++++++++ Incoming Request +++++++++ trace_peer7.log:GET http://ts_upstream0:UP_PORT0/obj7 HTTP/1.1 [1] state->result: PARENT_SPECIFIED Chosen parent: ts_peer0 +[1] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer7.log:+++++++++ Proxy's Request +++++++++ trace_peer7.log:GET http://ts_upstream0:UP_PORT0/obj7 HTTP/1.1 -[1] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer7.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer7.log:GET http://ts_upstream0:UP_PORT0/obj7 HTTP/1.1 trace_peer7.log:+++++++++ Incoming O.S. Response +++++++++ @@ -730,9 +730,9 @@ trace_peer7.log:HTTP/1.1 200 OK trace_peer7.log:+++++++++ Incoming Request +++++++++ trace_peer7.log:GET http://ts_upstream0:UP_PORT0/obj15 HTTP/1.1 [4] state->result: PARENT_SPECIFIED Chosen parent: ts_peer3 +[4] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer7.log:+++++++++ Proxy's Request +++++++++ trace_peer7.log:GET http://ts_upstream0:UP_PORT0/obj15 HTTP/1.1 -[4] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer7.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer7.log:GET http://ts_upstream0:UP_PORT0/obj15 HTTP/1.1 trace_peer7.log:+++++++++ Incoming O.S. Response +++++++++ @@ -755,9 +755,9 @@ trace_peer7.log:HTTP/1.1 200 OK trace_peer7.log:+++++++++ Incoming Request +++++++++ trace_peer7.log:GET http://ts_upstream0:UP_PORT0/obj5 HTTP/1.1 [6] state->result: PARENT_SPECIFIED Chosen parent: ts_peer2 +[6] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer7.log:+++++++++ Proxy's Request +++++++++ trace_peer7.log:GET http://ts_upstream0:UP_PORT0/obj5 HTTP/1.1 -[6] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer7.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer7.log:GET http://ts_upstream0:UP_PORT0/obj5 HTTP/1.1 trace_peer7.log:+++++++++ Incoming O.S. Response +++++++++ @@ -789,9 +789,9 @@ trace_peer7.log:HTTP/1.1 200 OK trace_peer7.log:+++++++++ Incoming Request +++++++++ trace_peer7.log:GET http://ts_upstream0:UP_PORT0/obj13 HTTP/1.1 [9] state->result: PARENT_SPECIFIED Chosen parent: ts_peer3 +[9] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer7.log:+++++++++ Proxy's Request +++++++++ trace_peer7.log:GET http://ts_upstream0:UP_PORT0/obj13 HTTP/1.1 -[9] not firstcall, line_number: 0, result: PARENT_SPECIFIED trace_peer7.log:+++++++++ Proxy's Request after hooks +++++++++ trace_peer7.log:GET http://ts_upstream0:UP_PORT0/obj13 HTTP/1.1 trace_peer7.log:+++++++++ Incoming O.S. Response +++++++++ diff --git a/tests/gold_tests/pluginTest/slice/slice.test.py b/tests/gold_tests/pluginTest/slice/slice.test.py index 7dfadbfe294..d3e09c4fda3 100644 --- a/tests/gold_tests/pluginTest/slice/slice.test.py +++ b/tests/gold_tests/pluginTest/slice/slice.test.py @@ -82,9 +82,13 @@ # set up whole asset fetch into cache ts.Disk.remap_config.AddLines([ - 'map http://preload/ http://127.0.0.1:{}'.format(server.Variables.Port), - 'map http://slice/ http://127.0.0.1:{}'.format(server.Variables.Port) + - ' @plugin=slice.so @pparam=--blockbytes-test={}'.format(block_bytes) + f'map http://preload/ http://127.0.0.1:{server.Variables.Port}', + f'map http://slice_only/ http://127.0.0.1:{server.Variables.Port}', + f'map http://slice/ http://127.0.0.1:{server.Variables.Port}' + + f' @plugin=slice.so @pparam=--blockbytes-test={block_bytes}', + f'map http://slicehdr/ http://127.0.0.1:{server.Variables.Port}' + + f' @plugin=slice.so @pparam=--blockbytes-test={block_bytes}' + + ' @pparam=--skip-header=SkipSlice', ]) ts.Disk.records_config.update({ @@ -180,3 +184,14 @@ ps.Command = curl_and_args + ' http://slice/path' + ' -r {}-{}'.format(beg, end) ps.Streams.stdout.Content = Testers.ContainsExpression("416 Requested Range Not Satisfiable", "expected 416 response") tr.StillRunningAfter = ts + +# 9 Test - First complete slice using override header +# if this fails it will infinite loop +tr = Test.AddTestRun("Fetch first slice range") +ps = tr.Processes.Default +ps.Command = curl_and_args + ' http://slicehdr/path' + ' -r 0-6' +ps.ReturnCode = 0 +ps.Streams.stderr = "gold/slice_first.stderr.gold" +ps.Streams.stdout.Content = Testers.ContainsExpression("206 Partial Content", "expected 206 response") +ps.Streams.stdout.Content += Testers.ContainsExpression("Content-Range: bytes 0-6/18", "mismatch byte content response") +tr.StillRunningAfter = ts diff --git a/tests/gold_tests/pluginTest/slice/slice_prefetch.test.py b/tests/gold_tests/pluginTest/slice/slice_prefetch.test.py new file mode 100644 index 00000000000..5dc6aed134c --- /dev/null +++ b/tests/gold_tests/pluginTest/slice/slice_prefetch.test.py @@ -0,0 +1,178 @@ +''' +''' +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "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 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +Test.Summary = ''' +slice plugin prefetch feature test +''' + +# Test description: +# Fill origin server with range requests +# Request content through slice plugin with varied prefetch counts + +Test.SkipUnless( + Condition.PluginExists('slice.so'), + Condition.PluginExists('cache_range_requests.so'), +) +Test.ContinueOnFail = False + +# configure origin server, lookup by Range header +server = Test.MakeOriginServer("server", lookup_key="{%Range}") + +# Define ATS and configure +ts = Test.MakeATSProcess("ts", command="traffic_server") + +block_bytes_1 = 7 +block_bytes_2 = 5 +body = "lets go surfin now" +bodylen = len(body) + +request_header = {"headers": + "GET /path HTTP/1.1\r\n" + + "Host: origin\r\n" + + "\r\n", + "timestamp": "1469733493.993", + "body": "", + } + +response_header = {"headers": + "HTTP/1.1 200 OK\r\n" + + "Connection: close\r\n" + + "Cache-Control: public, max-age=500\r\n" + + "\r\n", + "timestamp": "1469733493.993", + "body": body, + } + +server.addResponse("sessionlog.json", request_header, response_header) + +# Autest OS doesn't support range request, must manually add requests/responses +for block_bytes in [block_bytes_1, block_bytes_2]: + for i in range(bodylen // block_bytes + 1): + b0 = i * block_bytes + b1 = b0 + block_bytes - 1 + req_header = {"headers": + "GET /path HTTP/1.1\r\n" + + "Host: *\r\n" + + "Accept: */*\r\n" + + f"Range: bytes={b0}-{b1}\r\n" + + "\r\n", + "timestamp": "1469733493.993", + "body": "" + } + if (b1 > bodylen - 1): + b1 = bodylen - 1 + resp_header = {"headers": + "HTTP/1.1 206 Partial Content\r\n" + + "Accept-Ranges: bytes\r\n" + + "Cache-Control: public, max-age=500\r\n" + + f"Content-Range: bytes {b0}-{b1}/{bodylen}\r\n" + + "Connection: close\r\n" + + "\r\n", + "timestamp": "1469733493.993", + "body": body[b0:b1 + 1] + } + server.addResponse("sessionlog.json", req_header, resp_header) + +curl_and_args = 'curl -s -D /dev/stdout -o /dev/stderr -x http://127.0.0.1:{}'.format(ts.Variables.port) + +ts.Disk.remap_config.AddLines([ + f'map http://sliceprefetch1bytes1/ http://127.0.0.1:{server.Variables.Port}' + + f' @plugin=slice.so @pparam=--blockbytes-test={block_bytes_1} @pparam=--prefetch-count=1' + + ' @plugin=cache_range_requests.so', + f'map http://sliceprefetch2bytes1/ http://127.0.0.1:{server.Variables.Port}' + + f' @plugin=slice.so @pparam=--blockbytes-test={block_bytes_1} @pparam=--prefetch-count=2' + + ' @plugin=cache_range_requests.so', + f'map http://sliceprefetch1bytes2/ http://127.0.0.1:{server.Variables.Port}' + + f' @plugin=slice.so @pparam=--blockbytes-test={block_bytes_2} @pparam=--prefetch-count=1' + + ' @plugin=cache_range_requests.so', + f'map http://sliceprefetch2bytes2/ http://127.0.0.1:{server.Variables.Port}' + + f' @plugin=slice.so @pparam=--blockbytes-test={block_bytes_2} @pparam=--prefetch-count=2' + + ' @plugin=cache_range_requests.so', +]) + +ts.Disk.records_config.update({ + 'proxy.config.diags.debug.enabled': 1, + 'proxy.config.diags.debug.tags': 'slice|cache_range_requests|pvc', +}) + +# 0 Test - Full object slice with only next block prefetched in background, block bytes= 7 +tr = Test.AddTestRun("Full object slice with only next block prefetched in background, block bytes= 7") +ps = tr.Processes.Default +ps.StartBefore(server, ready=When.PortOpen(server.Variables.Port)) +ps.StartBefore(Test.Processes.ts) +ps.Command = curl_and_args + ' http://sliceprefetch1bytes1/path' +ps.ReturnCode = 0 +ps.Streams.stderr = "gold/slice_200.stderr.gold" +ps.Streams.stdout.Content = Testers.ContainsExpression("200 OK", "expected 200 OK response") +tr.StillRunningAfter = ts + +# 1 Test - Full object slice with nest 2 blocks prefetched in background, block bytes= 7 +tr = Test.AddTestRun("Test - Full object slice with nest 2 blocks prefetched in background, block bytes= 7") +ps = tr.Processes.Default +ps.Command = curl_and_args + ' http://sliceprefetch2bytes1/path' +ps.ReturnCode = 0 +ps.Streams.stderr = "gold/slice_200.stderr.gold" +ps.Streams.stdout.Content = Testers.ContainsExpression("200 OK", "expected 200 OK response") +tr.StillRunningAfter = ts + +# 2 Test - Full object slice with only next block prefetched in background, block bytes= 5 +tr = Test.AddTestRun("Full object slice with only next block prefetched in background, block bytes= 5") +ps = tr.Processes.Default +ps.Command = curl_and_args + ' http://sliceprefetch1bytes2/path' +ps.ReturnCode = 0 +ps.Streams.stderr = "gold/slice_200.stderr.gold" +ps.Streams.stdout.Content = Testers.ContainsExpression("200 OK", "expected 200 OK response") +tr.StillRunningAfter = ts + +# 3 Test - Full object slice with nest 2 blocks prefetched in background, block bytes= 5 +tr = Test.AddTestRun("Full object slice with nest 2 blocks prefetched in background, block bytes= 5") +ps = tr.Processes.Default +ps.Command = curl_and_args + ' http://sliceprefetch2bytes2/path' +ps.ReturnCode = 0 +ps.Streams.stderr = "gold/slice_200.stderr.gold" +ps.Streams.stdout.Content = Testers.ContainsExpression("200 OK", "expected 200 OK response") +tr.StillRunningAfter = ts + +# 4 Test - Whole asset via range +tr = Test.AddTestRun("Whole asset via range") +ps = tr.Processes.Default +ps.Command = curl_and_args + ' http://sliceprefetch1bytes1/path' + ' -r 0-' +ps.ReturnCode = 0 +ps.Streams.stderr = "gold/slice_206.stderr.gold" +ps.Streams.stdout.Content = Testers.ContainsExpression("206 Partial Content", "expected 206 response") +ps.Streams.stdout.Content += Testers.ContainsExpression("Content-Range: bytes 0-17/18", "mismatch byte content response") +tr.StillRunningAfter = ts + +# 5 Test - Non aligned slice request +tr = Test.AddTestRun("Non aligned slice request") +ps = tr.Processes.Default +ps.Command = curl_and_args + ' http://sliceprefetch1bytes1/path' + ' -r 5-16' +ps.ReturnCode = 0 +ps.Streams.stderr = "gold/slice_mid.stderr.gold" +ps.Streams.stdout.Content = Testers.ContainsExpression("206 Partial Content", "expected 206 response") +ps.Streams.stdout.Content += Testers.ContainsExpression("Content-Range: bytes 5-16/18", "mismatch byte content response") +tr.StillRunningAfter = ts + +# 6 Test - special case, begin inside last slice block but outside asset len +tr = Test.AddTestRun("Invalid end range request, 416") +beg = len(body) + 1 +end = beg + block_bytes +ps = tr.Processes.Default +ps.Command = curl_and_args + f' http://sliceprefetch1bytes1/path -r {beg}-{end}' +ps.Streams.stdout.Content = Testers.ContainsExpression("416 Requested Range Not Satisfiable", "expected 416 response") +tr.StillRunningAfter = ts diff --git a/tests/gold_tests/pluginTest/slice/slice_selfhealing.test.py b/tests/gold_tests/pluginTest/slice/slice_selfhealing.test.py index 9d3ca27682e..2a3af17be0e 100644 --- a/tests/gold_tests/pluginTest/slice/slice_selfhealing.test.py +++ b/tests/gold_tests/pluginTest/slice/slice_selfhealing.test.py @@ -15,16 +15,27 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. +import time +import datetime Test.Summary = ''' Slice selfhealing test ''' + +def to_httpdate(dt): + # string representation of a date according to RFC 1123 (HTTP/1.1). + weekday = ["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"][dt.weekday()] + month = ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"][dt.month - 1] + return "%s, %02d %s %04d %02d:%02d:%02d GMT" % (weekday, dt.day, month, + dt.year, dt.hour, dt.minute, dt.second) + # Test description: # Preload the cache with the entire asset to be range requested. # Reload remap rule with slice plugin # Request content through the slice plugin + Test.SkipUnless( Condition.PluginExists('slice.so'), Condition.PluginExists('cache_range_requests.so'), @@ -60,10 +71,15 @@ # set up slice plugin with remap host into cache_range_requests ts.Disk.remap_config.AddLines([ - 'map http://slice/ http://127.0.0.1:{}/'.format(server.Variables.Port) + - ' @plugin=slice.so @pparam=--blockbytes-test=3 @pparam=--remap-host=cache_range_requests', - 'map http://cache_range_requests/ http://127.0.0.1:{}/'.format(server.Variables.Port) + + f'map http://slice/ http://127.0.0.1:{server.Variables.Port}/' + + ' @plugin=slice.so @pparam=--blockbytes-test=3 @pparam=--remap-host=crr', + f'map http://crr/ http://127.0.0.1:{server.Variables.Port}/' + ' @plugin=cache_range_requests.so @pparam=--consider-ims', + f'map http://slicehdr/ http://127.0.0.1:{server.Variables.Port}/' + + ' @plugin=slice.so @pparam=--blockbytes-test=3' + + ' @pparam=--remap-host=crrhdr @pparam=--crr-ims-header=crr-foo', + f'map http://crrhdr/ http://127.0.0.1:{server.Variables.Port}/' + ' @plugin=cache_range_requests.so @pparam=--ims-header=crr-foo', ]) ts.Disk.plugin_config.AddLine('xdebug.so') @@ -154,16 +170,16 @@ ps = tr.Processes.Default ps.StartBefore(server, ready=When.PortOpen(server.Variables.Port)) ps.StartBefore(Test.Processes.ts) -ps.Command = curl_and_args + ' http://cache_range_requests/second -r 0-2 -H "uuid: etagnew-0"' +ps.Command = curl_and_args + ' http://crr/second -r 0-2 -H "uuid: etagnew-0"' ps.ReturnCode = 0 ps.Streams.stderr = "gold/bbb.gold" ps.Streams.stdout.Content = Testers.ContainsExpression("etagnew", "expected etagnew") tr.StillRunningAfter = ts -# 1 Test - Preload reference etagold-1 +# 1 Test - Preload slice etagold-1 tr = Test.AddTestRun("Preload slice etagold-1") ps = tr.Processes.Default -ps.Command = curl_and_args + ' http://cache_range_requests/second -r 3-5 -H "uuid: etagold-1"' +ps.Command = curl_and_args + ' http://crr/second -r 3-5 -H "uuid: etagold-1"' ps.ReturnCode = 0 ps.Streams.stderr = "gold/aa.gold" ps.Streams.stdout.Content = Testers.ContainsExpression("etagold", "expected etagold") @@ -264,7 +280,7 @@ # 4 Test - Preload reference etagold-0 tr = Test.AddTestRun("Preload reference etagold-0") ps = tr.Processes.Default -ps.Command = curl_and_args + ' http://cache_range_requests/reference -r 0-2 -H "uuid: etagold-0"' +ps.Command = curl_and_args + ' http://crr/reference -r 0-2 -H "uuid: etagold-0"' ps.ReturnCode = 0 ps.Streams.stderr = "gold/aaa.gold" ps.Streams.stdout.Content = Testers.ContainsExpression("etagold", "expected etagold") @@ -273,7 +289,7 @@ # 5 Test - Preload reference etagnew-1 tr = Test.AddTestRun("Preload slice etagnew-1") ps = tr.Processes.Default -ps.Command = curl_and_args + ' http://cache_range_requests/reference -r 3-5 -H "uuid: etagnew-1"' +ps.Command = curl_and_args + ' http://crr/reference -r 3-5 -H "uuid: etagnew-1"' ps.ReturnCode = 0 ps.Streams.stderr = "gold/bb.gold" ps.Streams.stdout.Content = Testers.ContainsExpression("etagnew", "expected etagnew") @@ -386,5 +402,28 @@ ps.Streams.stdout.Content = Testers.ContainsExpression("404 Not Found", "Expected 404") tr.StillRunningAfter = ts +# custom headers + +edt = datetime.datetime.fromtimestamp(time.time() + 100) +edate = to_httpdate(edt) + +# 12 Test - Preload reference etagold-1 +tr = Test.AddTestRun("Preload slice etagold-1") +ps = tr.Processes.Default +ps.Command = curl_and_args + f' http://crrhdr/second -r 3-5 -H "uuid: etagold-1" -H "crr-foo: {edate}"' +ps.ReturnCode = 0 +ps.Streams.stderr = "gold/aa.gold" +ps.Streams.stdout.Content = Testers.ContainsExpression("etagold", "expected etagold") +tr.StillRunningAfter = ts + +# 13 Test - Request second slice via slice plugin, with instructions to fetch new 2nd slice +tr = Test.AddTestRun("Request 2nd slice (expect refetch)") +ps = tr.Processes.Default +ps.Command = curl_and_args + ' http://slicehdr/second -r 3- -H "uuid: etagnew-1"' +ps.ReturnCode = 0 +ps.Streams.stderr = "gold/bb.gold" +ps.Streams.stdout.Content = Testers.ContainsExpression("etagnew", "expected etagnew") +tr.StillRunningAfter = ts + # Over riding the built in ERROR check since we expect to see logSliceErrors ts.Disk.diags_log.Content = Testers.ContainsExpression("logSliceError", "logSliceErrors generated") diff --git a/tests/gold_tests/pluginTest/stek_share/server_list.yaml b/tests/gold_tests/pluginTest/stek_share/server_list.yaml new file mode 100644 index 00000000000..77d815f0aed --- /dev/null +++ b/tests/gold_tests/pluginTest/stek_share/server_list.yaml @@ -0,0 +1,15 @@ +- server_id: 1 + address: 127.0.0.1 + port: 10001 +- server_id: 2 + address: 127.0.0.1 + port: 10002 +- server_id: 3 + address: 127.0.0.1 + port: 10003 +- server_id: 4 + address: 127.0.0.1 + port: 10004 +- server_id: 5 + address: 127.0.0.1 + port: 10005 diff --git a/tests/gold_tests/pluginTest/stek_share/ssl/self_signed.crt b/tests/gold_tests/pluginTest/stek_share/ssl/self_signed.crt new file mode 100644 index 00000000000..e90438c777a --- /dev/null +++ b/tests/gold_tests/pluginTest/stek_share/ssl/self_signed.crt @@ -0,0 +1,32 @@ +-----BEGIN CERTIFICATE----- +MIIFfTCCA2WgAwIBAgIUEH/jBPLg2k3sO2+PKgnU+Rht2y4wDQYJKoZIhvcNAQEL +BQAwTjELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAklMMQ4wDAYDVQQKDAVZYWhvbzEN +MAsGA1UECwwERWRnZTETMBEGA1UEAwwKc3Rlay1zaGFyZTAeFw0yMjAyMTAxNjIy +MTdaFw0zMjAyMDgxNjIyMTdaME4xCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJJTDEO +MAwGA1UECgwFWWFob28xDTALBgNVBAsMBEVkZ2UxEzARBgNVBAMMCnN0ZWstc2hh +cmUwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDOJLcQ0P6yNQoYANlU +231rpXK7tgiL0QXOv3vw7AosShkZj7NRPEIFRSFrzyAqJLfmeYBz0JPVjOraJ3CV +8D9/2BUNdrbPGTgESEiDzyB4D3DSi8RHy11dwRozwi1YzDzcNoSii3xmE70bt0sT +tzQ1L2lns+B1NoNBNP0F9VhYf0tvNsy5rRtgxFjZDpSiLXeqkf3IYEs0pEK+uk6+ +eXQ0uSTiAkfkQabw65NoFXaN9OxLyWDu4c+lxq7LKPRQ9O9lI05YaScA3d79ob/k +qb0v4khS7cuYi19h7D5b0QZo1T/EA0HykMYvxfHHH3HviqQItxBYPnVxbwo2D6mF +WS3Uupoh57QkR2HkX3MReZcHwgBDd7IciAyKB6a0VoKqlyLN82Mod4svHo8LGX1d +zWWeOV89pa3txZ5gzilpMtoCwgGVaKn0u1mqEBx4azY8bJkm7OtSYC8GXtDbB7fo +tptcXn3JWGgvtUAmZlaaSzlNocjORmjUIXr85kiaWNLmJpHNS5w3Ncf9Y7swxfwn +BQmNiU0TdXsMHDDlGXoy+0Osw+GJmQijOIF2pQGnKsSozVtBIP4/ESKgAxh8+5Q1 +d0D0yG0OC/pcnam9Yx/qFRwvSUZ5X+hSam8ljwT1NzC74ATMvt9DU6AFSGK56Qqe +/Y/QQShsUg1uIqa9L2hvamIOfwIDAQABo1MwUTAdBgNVHQ4EFgQU0G+dbyjOmCbn +ay+x1u/lM9OY/fAwHwYDVR0jBBgwFoAU0G+dbyjOmCbnay+x1u/lM9OY/fAwDwYD +VR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAgEAq9zQnurNYUCsDjRXNU+h +72i2zZCnWu5oKe6lCGn9hW3nGmRFAjfKb+fE3sNJxikRF7Cas+3mx1g7Z6riHjq9 +WMPKfg6H+ONXaxlfBbHCVrAkrflU1EVyPCXHVkapq4+h1HQAfEVpA13CXFnztTXu +/tldQf2qDsloRdh9CNp/rNAzee2ouzy7SaDdTeA5DgNWhLwUQ4qCj+llD8me10lu +YqyBWWdRG28Tt7GyeK3mJH9vwHsIA/hadOiDJ6ReS5Rm+MyxoRQY8QnnNS3h5UjZ +wR0o3DrweyX0gWf4CI3Ycj5+gZvjI9kPd3deqCAh5YUj9yEYLZI1++Aud0zUSjPK +R/Z9fLyjmADN0FV71aP3g6e/A9doyQYpNVg+spxCQnTCDGRuRhJv8Ubvehy9bCuw +d+iMZXybqii8xsEdTZp/2L8ZarAe888gC/JEQw3JKo/NTaW0P6FS7LYAMLmya2ez +5I4rT9BTTdwoxKSVbEro3f36U4hChS4YMYIsZ1sLjNljAQiUAAJeoJnVS/vCDw44 +YAQtgAIaIeMLqFgikf0U688r+78lZYIxhAuB2hWSUt7JDHGEq6+GZqh/3GLmSZmi +Pqk/jV/esxEBBmxyP6hiwDKanfEQfpk6n5kxyftIRLGSg5EMtD00AA3Ono9uyr7e +znK//SeO390xcNVQsi+8Ppw= +-----END CERTIFICATE----- diff --git a/tests/gold_tests/pluginTest/stek_share/ssl/self_signed.key b/tests/gold_tests/pluginTest/stek_share/ssl/self_signed.key new file mode 100644 index 00000000000..bbd6bbb746d --- /dev/null +++ b/tests/gold_tests/pluginTest/stek_share/ssl/self_signed.key @@ -0,0 +1,52 @@ +-----BEGIN PRIVATE KEY----- +MIIJQwIBADANBgkqhkiG9w0BAQEFAASCCS0wggkpAgEAAoICAQDOJLcQ0P6yNQoY +ANlU231rpXK7tgiL0QXOv3vw7AosShkZj7NRPEIFRSFrzyAqJLfmeYBz0JPVjOra +J3CV8D9/2BUNdrbPGTgESEiDzyB4D3DSi8RHy11dwRozwi1YzDzcNoSii3xmE70b +t0sTtzQ1L2lns+B1NoNBNP0F9VhYf0tvNsy5rRtgxFjZDpSiLXeqkf3IYEs0pEK+ +uk6+eXQ0uSTiAkfkQabw65NoFXaN9OxLyWDu4c+lxq7LKPRQ9O9lI05YaScA3d79 +ob/kqb0v4khS7cuYi19h7D5b0QZo1T/EA0HykMYvxfHHH3HviqQItxBYPnVxbwo2 +D6mFWS3Uupoh57QkR2HkX3MReZcHwgBDd7IciAyKB6a0VoKqlyLN82Mod4svHo8L +GX1dzWWeOV89pa3txZ5gzilpMtoCwgGVaKn0u1mqEBx4azY8bJkm7OtSYC8GXtDb +B7fotptcXn3JWGgvtUAmZlaaSzlNocjORmjUIXr85kiaWNLmJpHNS5w3Ncf9Y7sw +xfwnBQmNiU0TdXsMHDDlGXoy+0Osw+GJmQijOIF2pQGnKsSozVtBIP4/ESKgAxh8 ++5Q1d0D0yG0OC/pcnam9Yx/qFRwvSUZ5X+hSam8ljwT1NzC74ATMvt9DU6AFSGK5 +6Qqe/Y/QQShsUg1uIqa9L2hvamIOfwIDAQABAoICAD5j2FAroNpYuSxYnW5UW9pH +obj0OBPw+DwBskZReia7amtVFaWBgk3MBXh2oLqAkHQd0+W5e/THCJFsHGQU6XMM ++BoyEtQNQunw4pmaB66upavjh01fXGuytPZzT3wvnD/d9Dip1MWkNbj8ualG6nMq +XVF4nHd9Py5uFiJGhi2KoU8Qm9eab83Svz06b3vCHRSvyMprcneFO3o0Mv7tDWGj +o2kP3ahUwmzqL5vx2wbN2PJ7CW5jQ5Bd2Ks+Qut5pjbK/7w8XwShIgtLeCOBx/OF +HfSTaepKTFz7vkfVtIXn/LubbMs4S/NLioiEmNwx7sGAfl7m0G67d7Cy/tCQFBFi +JsdeZ0ekLH+nH+9QJzSFQzxDUrl5oGxuvtUa8HYbRUtkfaTzrHX/W3EO0Cgscs9y +Pz6ARWunyanmttmWQEXorstjiRxOXP+QX+B3Uwjl18tDHs6dLUgpPv7Kl5nJ63KF +B30ITVOK6e3sLi9y9AGVT8EVNQ7Zd7XLtXJ9lPOKjDec1TsSFvxfdAjigVFy1gfN +nsmdyL0IeeZWi00qRQmTel0+mc9sqV4zczbxcHfDsSgrMvlDhiRxyusUyTcG1XHc +20f/wqfTKDMkWYtWHB9Ty4BxmJUJZlixioim6eAk26L9STA1dB3092kYLk0/62Iv +Fms1UjNn4DDERe/cUsaxAoIBAQDsqFbZ7R+SLBD/0HiQBWpwHbOjJ5AtTglNIrTZ +XewLWwtYEvUT0bTfQDJJ+PBybR6RE4otFxKEfuR/WXQ9szQN6SUvIabaky/vRh0I +q07NCBgpu3hFEw+qR4eXoXNFpYjSmAFyc1ViwwVfFvgqhywd45Rj46VkTv/x1UlS +dOhuCUPTwuKVsDlRtPwBqi1dLCgdR0cEyjAlqe2DNrvtBmBlXqti4oFXDFPMzln8 +Xk2dyqDBeyKLnJU3W51x0J3hOl+axeMxPF1qWKgB5hvIADEKKywverMlyYqiWT+P +QikUOocmiwna+sf2zEQrhGfa6Y8gWGMOcGy2NFRGAAyWkN/XAoIBAQDe/esmXmkq +gKWSxqOzeJfUHVF4ygmvS7mKbDNMY3GCvZgfD+hpZeZARTNOu9JrDWiUcxT8Wj+j +ZtYruQtCOxt1eiBoJOnYwaamm3d+HgvaE19+WxRGjcTGsZ6VreKzZlbgbAiCw/pd +rDAqi+Bs7bNG4dOdSb9ctuj4YkBmpM6u5TQUCEKAIrr90gIJli/B9+x0PIgrovlm +YCjlmrQlw+2DSFPrRxuqpXxNOyFyFsj992O/LFKAwYCyhtkqiUUqJbREIlyR1oL6 +X38Gbsp/jgrEUQ3N3773eV+bltz2nazEb67ps7nemjmZvjyluDjwfJdJJogWJsKK +0jGC21EGqRGZAoIBAQCZoO5Aql5EVbbzWjHpzJo8Dgv/bj96KZ6AJHeiZAZHmOLU +Wfoe05PHGbWLr77niU6+fyDEBKZQvM84nKmJJDw2i5NH9WCLo+EKQ0m1xv9wukB1 +Vu3MaYNR1v1+waBDJiKcE3FdCuHzKwbho9eWRAmvnX1HGxDS/TXJl9vxW1NHm1wc +q/bLlYqgMA0oR4ELaw7fctX3lgmLabR16aI1TF5nb/1yQ/gSuj3sRkjEO7PHKzMQ +Zw8V8qArP54FtJfJDkvh/XRvEfDSiJsIIIkIXJd5Mm2MpOqHLT6CBc3tAdYI+7Wg +n8HWFdaZsCDQ3zNMOTJgnQAw72qjHXVXu9BwLbwhAoIBAE/PUXpKEBnGMXx22+BA +KRch5yb0KMM0txNz5mhQry+769YyO1x9vAsEuXhUgNsP0X5QMhKfumchR0Ye1Ii/ +3vQM4cxkac3KgXrf6cSZvGQwytzOfFNEKklzCO9JbPoIhs+L2v/yZIliN1sC9TAH +Y0LbUIHbA0KLtJYxlBsooVC3eAwzaJmz1HlD0LbdqfoiYd64S4RSsDCT+g8zb4aU +uU1jdaWfradF01dQ8oeC4C0Ffg3OLzkmCInc+ZzfxIFxPTOlmLwZqocx5qTGwnMk +w3XADNDCY/bu2ek19Z/Ojyc/UbsTOFMTn8oG7G3joX1xGjR0NgC3nqlQ0aekFzvr +BwECggEBAKqlqm/yiPVViqHpQPrHbMWihaDEDF95L3jvvvByWS/96D7KUGGTHDJf +Vszm8slfvdIrMtqdGH9DvhP2X1HDMLwl6zMFKgSwkf1bT0+A3a7TldJ4ezcoeAOd +27YujmF5tk5yV2ufu9l0M+6bhXZuwdx1ktYo+GiR5G5lwllMT6ztQLcQA1BrSXgy +1hr7OsKBBS6DGhjBxxULbp9DgADbemp8xXOXD5EhBIhu7TIioHoPDaXesjnsClda +hRzyWycj5SDy1/kFAEYO94/wMFY5zYsmzUG3+AZ3eymdULP3mg6hkYJrht84R/hg +YAxBUEWWyJC/Uhh1KnlWUPX3fcl0VyU= +-----END PRIVATE KEY----- diff --git a/tests/gold_tests/pluginTest/stek_share/stek_share.test.py b/tests/gold_tests/pluginTest/stek_share/stek_share.test.py new file mode 100644 index 00000000000..50f2010022e --- /dev/null +++ b/tests/gold_tests/pluginTest/stek_share/stek_share.test.py @@ -0,0 +1,254 @@ +''' +''' +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "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 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import os +import re + +Test.Summary = 'Test the STEK Share plugin' +Test.testName = "stek_share" + +Test.SkipUnless(Condition.PluginExists('stek_share.so')) + +server = Test.MakeOriginServer('server') + +ts1 = Test.MakeATSProcess("ts1", select_ports=True, enable_tls=True) +ts2 = Test.MakeATSProcess("ts2", select_ports=True, enable_tls=True) +ts3 = Test.MakeATSProcess("ts3", select_ports=True, enable_tls=True) +ts4 = Test.MakeATSProcess("ts4", select_ports=True, enable_tls=True) +ts5 = Test.MakeATSProcess("ts5", select_ports=True, enable_tls=True) + +Test.Setup.Copy('ssl/self_signed.crt') +Test.Setup.Copy('ssl/self_signed.key') +Test.Setup.Copy('server_list.yaml') + +cert_path = os.path.join(Test.RunDirectory, 'self_signed.crt') +key_path = os.path.join(Test.RunDirectory, 'self_signed.key') +server_list_path = os.path.join(Test.RunDirectory, 'server_list.yaml') + +request_header1 = { + 'headers': 'GET / HTTP/1.1\r\nHost: www.example.com\r\n\r\n', + 'timestamp': '1469733493.993', + 'body': '' +} +response_header1 = { + 'headers': 'HTTP/1.1 200 OK\r\nConnection: close\r\n\r\n', + 'timestamp': '1469733493.993', + 'body': 'curl test' +} +server.addResponse('sessionlog.json', request_header1, response_header1) + +stek_share_conf_path_1 = os.path.join(ts1.Variables.CONFIGDIR, 'stek_share_conf.yaml') +stek_share_conf_path_2 = os.path.join(ts2.Variables.CONFIGDIR, 'stek_share_conf.yaml') +stek_share_conf_path_3 = os.path.join(ts3.Variables.CONFIGDIR, 'stek_share_conf.yaml') +stek_share_conf_path_4 = os.path.join(ts4.Variables.CONFIGDIR, 'stek_share_conf.yaml') +stek_share_conf_path_5 = os.path.join(ts5.Variables.CONFIGDIR, 'stek_share_conf.yaml') + +ts1.Disk.File(stek_share_conf_path_1, id="stek_share_conf_1", typename="ats:config") +ts2.Disk.File(stek_share_conf_path_2, id="stek_share_conf_2", typename="ats:config") +ts3.Disk.File(stek_share_conf_path_3, id="stek_share_conf_3", typename="ats:config") +ts4.Disk.File(stek_share_conf_path_4, id="stek_share_conf_4", typename="ats:config") +ts5.Disk.File(stek_share_conf_path_5, id="stek_share_conf_5", typename="ats:config") + +ts1.Disk.stek_share_conf_1.AddLines([ + 'server_id: 1', + 'address: 127.0.0.1', + 'port: 10001', + 'asio_thread_pool_size: 4', + 'heart_beat_interval: 100', + 'election_timeout_lower_bound: 200', + 'election_timeout_upper_bound: 400', + 'reserved_log_items: 5', + 'snapshot_distance: 5', + 'client_req_timeout: 3000', # this is in milliseconds + 'key_update_interval: 3600', # this is in seconds + 'server_list_file: {0}'.format(server_list_path), + 'root_cert_file: {0}'.format(cert_path), + 'server_cert_file: {0}'.format(cert_path), + 'server_key_file: {0}'.format(key_path), + 'cert_verify_str: /C=US/ST=IL/O=Yahoo/OU=Edge/CN=stek-share' +]) + +ts2.Disk.stek_share_conf_2.AddLines([ + 'server_id: 2', + 'address: 127.0.0.1', + 'port: 10002', + 'asio_thread_pool_size: 4', + 'heart_beat_interval: 100', + 'election_timeout_lower_bound: 200', + 'election_timeout_upper_bound: 400', + 'reserved_log_items: 5', + 'snapshot_distance: 5', + 'client_req_timeout: 3000', # this is in milliseconds + 'key_update_interval: 3600', # this is in seconds + 'server_list_file: {0}'.format(server_list_path), + 'root_cert_file: {0}'.format(cert_path), + 'server_cert_file: {0}'.format(cert_path), + 'server_key_file: {0}'.format(key_path), + 'cert_verify_str: /C=US/ST=IL/O=Yahoo/OU=Edge/CN=stek-share' +]) + +ts3.Disk.stek_share_conf_3.AddLines([ + 'server_id: 3', + 'address: 127.0.0.1', + 'port: 10003', + 'asio_thread_pool_size: 4', + 'heart_beat_interval: 100', + 'election_timeout_lower_bound: 200', + 'election_timeout_upper_bound: 400', + 'reserved_log_items: 5', + 'snapshot_distance: 5', + 'client_req_timeout: 3000', # this is in milliseconds + 'key_update_interval: 3600', # this is in seconds + 'server_list_file: {0}'.format(server_list_path), + 'root_cert_file: {0}'.format(cert_path), + 'server_cert_file: {0}'.format(cert_path), + 'server_key_file: {0}'.format(key_path), + 'cert_verify_str: /C=US/ST=IL/O=Yahoo/OU=Edge/CN=stek-share' +]) + +ts4.Disk.stek_share_conf_4.AddLines([ + 'server_id: 4', + 'address: 127.0.0.1', + 'port: 10004', + 'asio_thread_pool_size: 4', + 'heart_beat_interval: 100', + 'election_timeout_lower_bound: 200', + 'election_timeout_upper_bound: 400', + 'reserved_log_items: 5', + 'snapshot_distance: 5', + 'client_req_timeout: 3000', # this is in milliseconds + 'key_update_interval: 3600', # this is in seconds + 'server_list_file: {0}'.format(server_list_path), + 'root_cert_file: {0}'.format(cert_path), + 'server_cert_file: {0}'.format(cert_path), + 'server_key_file: {0}'.format(key_path), + 'cert_verify_str: /C=US/ST=IL/O=Yahoo/OU=Edge/CN=stek-share' +]) + +ts5.Disk.stek_share_conf_5.AddLines([ + 'server_id: 5', + 'address: 127.0.0.1', + 'port: 10005', + 'asio_thread_pool_size: 4', + 'heart_beat_interval: 100', + 'election_timeout_lower_bound: 200', + 'election_timeout_upper_bound: 400', + 'reserved_log_items: 5', + 'snapshot_distance: 5', + 'client_req_timeout: 3000', # this is in milliseconds + 'key_update_interval: 3600', # this is in seconds + 'server_list_file: {0}'.format(server_list_path), + 'root_cert_file: {0}'.format(cert_path), + 'server_cert_file: {0}'.format(cert_path), + 'server_key_file: {0}'.format(key_path), + 'cert_verify_str: /C=US/ST=IL/O=Yahoo/OU=Edge/CN=stek-share' +]) + +ts1.Disk.records_config.update({'proxy.config.diags.debug.enabled': 1, 'proxy.config.diags.debug.tags': 'stek_share', 'proxy.config.exec_thread.autoconfig': 0, 'proxy.config.exec_thread.limit': 4, 'proxy.config.ssl.server.cert.path': '{0}'.format(Test.RunDirectory), 'proxy.config.ssl.server.private_key.path': '{0}'.format(Test.RunDirectory), 'proxy.config.ssl.session_cache': 2, 'proxy.config.ssl.session_cache.size': 1024, 'proxy.config.ssl.session_cache.timeout': 7200, 'proxy.config.ssl.session_cache.num_buckets': 16, 'proxy.config.ssl.server.session_ticket.enable': 1, 'proxy.config.ssl.server.cipher_suite': + 'ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:DHE-DSS-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-DSS-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES256-SHA256:DHE-DSS-AES256-SHA256:DHE-RSA-AES128-SHA256:DHE-DSS-AES128-SHA256:DHE-RSA-AES256-SHA:DHE-DSS-AES256-SHA:DHE-RSA-AES128-SHA:DHE-DSS-AES128-SHA:!aNULL:!eNULL:!EXPORT:!DES:!RC4:!MD5:!PSK:!aECDH:!EDH-DSS-DES-CBC3-SHA:!EDH-RSA-DES-CBC3-SHA:!KRB5-DES-CBC3-SHA'}) +ts1.Disk.plugin_config.AddLine('stek_share.so {0}'.format(stek_share_conf_path_1)) +ts1.Disk.ssl_multicert_config.AddLine('dest_ip=* ssl_cert_name=self_signed.crt ssl_key_name=self_signed.key') +ts1.Disk.remap_config.AddLine('map / http://127.0.0.1:{0}'.format(server.Variables.Port)) + +ts2.Disk.records_config.update({'proxy.config.diags.debug.enabled': 1, 'proxy.config.diags.debug.tags': 'stek_share', 'proxy.config.exec_thread.autoconfig': 0, 'proxy.config.exec_thread.limit': 4, 'proxy.config.ssl.server.cert.path': '{0}'.format(Test.RunDirectory), 'proxy.config.ssl.server.private_key.path': '{0}'.format(Test.RunDirectory), 'proxy.config.ssl.session_cache': 2, 'proxy.config.ssl.session_cache.size': 1024, 'proxy.config.ssl.session_cache.timeout': 7200, 'proxy.config.ssl.session_cache.num_buckets': 16, 'proxy.config.ssl.server.session_ticket.enable': 1, 'proxy.config.ssl.server.cipher_suite': + 'ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:DHE-DSS-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-DSS-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES256-SHA256:DHE-DSS-AES256-SHA256:DHE-RSA-AES128-SHA256:DHE-DSS-AES128-SHA256:DHE-RSA-AES256-SHA:DHE-DSS-AES256-SHA:DHE-RSA-AES128-SHA:DHE-DSS-AES128-SHA:!aNULL:!eNULL:!EXPORT:!DES:!RC4:!MD5:!PSK:!aECDH:!EDH-DSS-DES-CBC3-SHA:!EDH-RSA-DES-CBC3-SHA:!KRB5-DES-CBC3-SHA'}) +ts2.Disk.plugin_config.AddLine('stek_share.so {0}'.format(stek_share_conf_path_2)) +ts2.Disk.ssl_multicert_config.AddLine('dest_ip=* ssl_cert_name=self_signed.crt ssl_key_name=self_signed.key') +ts2.Disk.remap_config.AddLine('map / http://127.0.0.1:{0}'.format(server.Variables.Port)) + +ts3.Disk.records_config.update({'proxy.config.diags.debug.enabled': 1, 'proxy.config.diags.debug.tags': 'stek_share', 'proxy.config.exec_thread.autoconfig': 0, 'proxy.config.exec_thread.limit': 4, 'proxy.config.ssl.server.cert.path': '{0}'.format(Test.RunDirectory), 'proxy.config.ssl.server.private_key.path': '{0}'.format(Test.RunDirectory), 'proxy.config.ssl.session_cache': 2, 'proxy.config.ssl.session_cache.size': 1024, 'proxy.config.ssl.session_cache.timeout': 7200, 'proxy.config.ssl.session_cache.num_buckets': 16, 'proxy.config.ssl.server.session_ticket.enable': 1, 'proxy.config.ssl.server.cipher_suite': + 'ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:DHE-DSS-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-DSS-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES256-SHA256:DHE-DSS-AES256-SHA256:DHE-RSA-AES128-SHA256:DHE-DSS-AES128-SHA256:DHE-RSA-AES256-SHA:DHE-DSS-AES256-SHA:DHE-RSA-AES128-SHA:DHE-DSS-AES128-SHA:!aNULL:!eNULL:!EXPORT:!DES:!RC4:!MD5:!PSK:!aECDH:!EDH-DSS-DES-CBC3-SHA:!EDH-RSA-DES-CBC3-SHA:!KRB5-DES-CBC3-SHA'}) +ts3.Disk.plugin_config.AddLine('stek_share.so {0}'.format(stek_share_conf_path_3)) +ts3.Disk.ssl_multicert_config.AddLine('dest_ip=* ssl_cert_name=self_signed.crt ssl_key_name=self_signed.key') +ts3.Disk.remap_config.AddLine('map / http://127.0.0.1:{0}'.format(server.Variables.Port)) + +ts4.Disk.records_config.update({'proxy.config.diags.debug.enabled': 1, 'proxy.config.diags.debug.tags': 'stek_share', 'proxy.config.exec_thread.autoconfig': 0, 'proxy.config.exec_thread.limit': 4, 'proxy.config.ssl.server.cert.path': '{0}'.format(Test.RunDirectory), 'proxy.config.ssl.server.private_key.path': '{0}'.format(Test.RunDirectory), 'proxy.config.ssl.session_cache': 2, 'proxy.config.ssl.session_cache.size': 1024, 'proxy.config.ssl.session_cache.timeout': 7200, 'proxy.config.ssl.session_cache.num_buckets': 16, 'proxy.config.ssl.server.session_ticket.enable': 1, 'proxy.config.ssl.server.cipher_suite': + 'ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:DHE-DSS-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-DSS-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES256-SHA256:DHE-DSS-AES256-SHA256:DHE-RSA-AES128-SHA256:DHE-DSS-AES128-SHA256:DHE-RSA-AES256-SHA:DHE-DSS-AES256-SHA:DHE-RSA-AES128-SHA:DHE-DSS-AES128-SHA:!aNULL:!eNULL:!EXPORT:!DES:!RC4:!MD5:!PSK:!aECDH:!EDH-DSS-DES-CBC3-SHA:!EDH-RSA-DES-CBC3-SHA:!KRB5-DES-CBC3-SHA'}) +ts4.Disk.plugin_config.AddLine('stek_share.so {0}'.format(stek_share_conf_path_4)) +ts4.Disk.ssl_multicert_config.AddLine('dest_ip=* ssl_cert_name=self_signed.crt ssl_key_name=self_signed.key') +ts4.Disk.remap_config.AddLine('map / http://127.0.0.1:{0}'.format(server.Variables.Port)) + +ts5.Disk.records_config.update({'proxy.config.diags.debug.enabled': 1, 'proxy.config.diags.debug.tags': 'stek_share', 'proxy.config.exec_thread.autoconfig': 0, 'proxy.config.exec_thread.limit': 4, 'proxy.config.ssl.server.cert.path': '{0}'.format(Test.RunDirectory), 'proxy.config.ssl.server.private_key.path': '{0}'.format(Test.RunDirectory), 'proxy.config.ssl.session_cache': 2, 'proxy.config.ssl.session_cache.size': 1024, 'proxy.config.ssl.session_cache.timeout': 7200, 'proxy.config.ssl.session_cache.num_buckets': 16, 'proxy.config.ssl.server.session_ticket.enable': 1, 'proxy.config.ssl.server.cipher_suite': + 'ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:DHE-DSS-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-DSS-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES256-SHA256:DHE-DSS-AES256-SHA256:DHE-RSA-AES128-SHA256:DHE-DSS-AES128-SHA256:DHE-RSA-AES256-SHA:DHE-DSS-AES256-SHA:DHE-RSA-AES128-SHA:DHE-DSS-AES128-SHA:!aNULL:!eNULL:!EXPORT:!DES:!RC4:!MD5:!PSK:!aECDH:!EDH-DSS-DES-CBC3-SHA:!EDH-RSA-DES-CBC3-SHA:!KRB5-DES-CBC3-SHA'}) +ts5.Disk.plugin_config.AddLine('stek_share.so {0}'.format(stek_share_conf_path_5)) +ts5.Disk.ssl_multicert_config.AddLine('dest_ip=* ssl_cert_name=self_signed.crt ssl_key_name=self_signed.key') +ts5.Disk.remap_config.AddLine('map / http://127.0.0.1:{0}'.format(server.Variables.Port)) + + +def check_session(ev, test): + retval = False + f = open(test.GetContent(ev), 'r') + err = "Session ids match" + if not f: + err = "Failed to open {0}".format(openssl_output) + return (retval, "Check that session ids match", err) + + content = f.read() + match = re.findall('Session-ID: ([0-9A-F]+)', content) + + if match: + if all(i == j for i, j in zip(match, match[1:])): + err = "{0} reused successfully {1} times".format(match[0], len(match) - 1) + retval = True + else: + err = "Session is not being reused as expected" + else: + err = "Didn't find session id" + return (retval, "Check that session ids match", err) + + +tr1 = Test.AddTestRun('Basic Curl test, and give it enough time for all ATS to start up and sync STEK') +tr1.Processes.Default.Command = 'sleep 10 && curl https://127.0.0.1:{0} -k'.format(ts1.Variables.ssl_port) +tr1.Processes.Default.ReturnCode = 0 +tr1.Processes.Default.StartBefore(server) +tr1.Processes.Default.StartBefore(ts1) +tr1.Processes.Default.StartBefore(ts2) +tr1.Processes.Default.StartBefore(ts3) +tr1.Processes.Default.StartBefore(ts4) +tr1.Processes.Default.StartBefore(ts5) +tr1.Processes.Default.Streams.All = Testers.ContainsExpression('curl test', 'Making sure the basics still work') +ts1.Streams.All = Testers.ContainsExpression('Generate initial STEK succeeded', 'should succeed') +ts2.Streams.All = Testers.ContainsExpression('Generate initial STEK succeeded', 'should succeed') +ts3.Streams.All = Testers.ContainsExpression('Generate initial STEK succeeded', 'should succeed') +ts4.Streams.All = Testers.ContainsExpression('Generate initial STEK succeeded', 'should succeed') +ts5.Streams.All = Testers.ContainsExpression('Generate initial STEK succeeded', 'should succeed') +tr1.StillRunningAfter = server +tr1.StillRunningAfter += ts1 +tr1.StillRunningAfter += ts2 +tr1.StillRunningAfter += ts3 +tr1.StillRunningAfter += ts4 +tr1.StillRunningAfter += ts5 + +tr2 = Test.AddTestRun("TLSv1.2 Session Ticket") +tr2.Command = \ + 'echo -e "GET / HTTP/1.1\r\n" | openssl s_client -tls1_2 -connect 127.0.0.1:{0} -sess_out {5} && ' \ + 'echo -e "GET / HTTP/1.1\r\n" | openssl s_client -tls1_2 -connect 127.0.0.1:{0} -sess_in {5} && ' \ + 'echo -e "GET / HTTP/1.1\r\n" | openssl s_client -tls1_2 -connect 127.0.0.1:{1} -sess_in {5} && ' \ + 'echo -e "GET / HTTP/1.1\r\n" | openssl s_client -tls1_2 -connect 127.0.0.1:{2} -sess_in {5} && ' \ + 'echo -e "GET / HTTP/1.1\r\n" | openssl s_client -tls1_2 -connect 127.0.0.1:{3} -sess_in {5} && ' \ + 'echo -e "GET / HTTP/1.1\r\n" | openssl s_client -tls1_2 -connect 127.0.0.1:{4} -sess_in {5}' \ + .format( + ts1.Variables.ssl_port, + ts2.Variables.ssl_port, + ts3.Variables.ssl_port, + ts4.Variables.ssl_port, + ts5.Variables.ssl_port, + os.path.join(Test.RunDirectory, 'sess.dat') + ) +tr2.ReturnCode = 0 +tr2.Processes.Default.Streams.All.Content = Testers.Lambda(check_session) diff --git a/tests/gold_tests/tls/ssl-post.c b/tests/gold_tests/tls/ssl-post.c index 0df6ad82243..4af8f75073c 100644 --- a/tests/gold_tests/tls/ssl-post.c +++ b/tests/gold_tests/tls/ssl-post.c @@ -222,7 +222,7 @@ main(int argc, char *argv[]) { struct addrinfo hints; struct addrinfo *result, *rp; - int sfd, s; + int sfd = -1, s; if (argc < 4) { fprintf(stderr, "Usage: %s host thread-count header-count [port]\n", argv[0]); diff --git a/tests/gold_tests/tls/tls_verify_override_base.test.py b/tests/gold_tests/tls/tls_verify_override_base.test.py index 0495ec54b78..c6b372754c3 100644 --- a/tests/gold_tests/tls/tls_verify_override_base.test.py +++ b/tests/gold_tests/tls/tls_verify_override_base.test.py @@ -113,7 +113,8 @@ 'proxy.config.url_remap.pristine_host_hdr': 1, 'proxy.config.exec_thread.autoconfig.scale': 1.0, 'proxy.config.dns.nameservers': '127.0.0.1:{0}'.format(dns.Variables.Port), - 'proxy.config.dns.resolv_conf': 'NULL' + 'proxy.config.dns.resolv_conf': 'NULL', + 'proxy.config.http.connect.dead.policy': 1, # Don't count TLS failures for dead upstream. }) dns.addRecords(records={"foo.com.": ["127.0.0.1"]}) diff --git a/tests/include/catch.hpp b/tests/include/catch.hpp index 7e706f947af..db1fed3b981 100644 --- a/tests/include/catch.hpp +++ b/tests/include/catch.hpp @@ -1,9 +1,9 @@ /* - * Catch v2.13.7 - * Generated: 2021-07-28 20:29:27.753164 + * Catch v2.13.8 + * Generated: 2022-01-03 21:20:09.589503 * ---------------------------------------------------------- * This file has been merged from multiple headers. Please don't edit it directly - * Copyright (c) 2021 Two Blue Cubes Ltd. All rights reserved. + * Copyright (c) 2022 Two Blue Cubes Ltd. All rights reserved. * * Distributed under the Boost Software License, Version 1.0. (See accompanying * file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) @@ -15,7 +15,7 @@ #define CATCH_VERSION_MAJOR 2 #define CATCH_VERSION_MINOR 13 -#define CATCH_VERSION_PATCH 7 +#define CATCH_VERSION_PATCH 8 #ifdef __clang__ # pragma clang system_header @@ -240,9 +240,6 @@ namespace Catch { // Visual C++ #if defined(_MSC_VER) -# define CATCH_INTERNAL_START_WARNINGS_SUPPRESSION __pragma( warning(push) ) -# define CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION __pragma( warning(pop) ) - // Universal Windows platform does not support SEH // Or console colours (or console at all...) # if defined(WINAPI_FAMILY) && (WINAPI_FAMILY == WINAPI_FAMILY_APP) @@ -251,13 +248,18 @@ namespace Catch { # define CATCH_INTERNAL_CONFIG_WINDOWS_SEH # endif +# if !defined(__clang__) // Handle Clang masquerading for msvc + // MSVC traditional preprocessor needs some workaround for __VA_ARGS__ // _MSVC_TRADITIONAL == 0 means new conformant preprocessor // _MSVC_TRADITIONAL == 1 means old traditional non-conformant preprocessor -# if !defined(__clang__) // Handle Clang masquerading for msvc # if !defined(_MSVC_TRADITIONAL) || (defined(_MSVC_TRADITIONAL) && _MSVC_TRADITIONAL) # define CATCH_INTERNAL_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR # endif // MSVC_TRADITIONAL + +// Only do this if we're not using clang on Windows, which uses `diagnostic push` & `diagnostic pop` +# define CATCH_INTERNAL_START_WARNINGS_SUPPRESSION __pragma( warning(push) ) +# define CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION __pragma( warning(pop) ) # endif // __clang__ #endif // _MSC_VER @@ -1010,34 +1012,34 @@ struct AutoReg : NonCopyable { #ifndef CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR #define INTERNAL_CATCH_TEMPLATE_TEST_CASE_NO_REGISTRATION(Name, Tags, ...) \ - INTERNAL_CATCH_TEMPLATE_TEST_CASE_NO_REGISTRATION_2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____F_U_N_C____ ), Name, Tags, typename TestType, __VA_ARGS__ ) + INTERNAL_CATCH_TEMPLATE_TEST_CASE_NO_REGISTRATION_2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_F_U_N_C_ ), Name, Tags, typename TestType, __VA_ARGS__ ) #else #define INTERNAL_CATCH_TEMPLATE_TEST_CASE_NO_REGISTRATION(Name, Tags, ...) \ - INTERNAL_CATCH_EXPAND_VARGS( INTERNAL_CATCH_TEMPLATE_TEST_CASE_NO_REGISTRATION_2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____F_U_N_C____ ), Name, Tags, typename TestType, __VA_ARGS__ ) ) + INTERNAL_CATCH_EXPAND_VARGS( INTERNAL_CATCH_TEMPLATE_TEST_CASE_NO_REGISTRATION_2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_F_U_N_C_ ), Name, Tags, typename TestType, __VA_ARGS__ ) ) #endif #ifndef CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR #define INTERNAL_CATCH_TEMPLATE_TEST_CASE_SIG_NO_REGISTRATION(Name, Tags, Signature, ...) \ - INTERNAL_CATCH_TEMPLATE_TEST_CASE_NO_REGISTRATION_2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____F_U_N_C____ ), Name, Tags, Signature, __VA_ARGS__ ) + INTERNAL_CATCH_TEMPLATE_TEST_CASE_NO_REGISTRATION_2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_F_U_N_C_ ), Name, Tags, Signature, __VA_ARGS__ ) #else #define INTERNAL_CATCH_TEMPLATE_TEST_CASE_SIG_NO_REGISTRATION(Name, Tags, Signature, ...) \ - INTERNAL_CATCH_EXPAND_VARGS( INTERNAL_CATCH_TEMPLATE_TEST_CASE_NO_REGISTRATION_2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____F_U_N_C____ ), Name, Tags, Signature, __VA_ARGS__ ) ) + INTERNAL_CATCH_EXPAND_VARGS( INTERNAL_CATCH_TEMPLATE_TEST_CASE_NO_REGISTRATION_2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_F_U_N_C_ ), Name, Tags, Signature, __VA_ARGS__ ) ) #endif #ifndef CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR #define INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD_NO_REGISTRATION( ClassName, Name, Tags,... ) \ - INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD_NO_REGISTRATION_2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____C_L_A_S_S____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ) , ClassName, Name, Tags, typename T, __VA_ARGS__ ) + INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD_NO_REGISTRATION_2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_C_L_A_S_S_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ) , ClassName, Name, Tags, typename T, __VA_ARGS__ ) #else #define INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD_NO_REGISTRATION( ClassName, Name, Tags,... ) \ - INTERNAL_CATCH_EXPAND_VARGS( INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD_NO_REGISTRATION_2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____C_L_A_S_S____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ) , ClassName, Name, Tags, typename T, __VA_ARGS__ ) ) + INTERNAL_CATCH_EXPAND_VARGS( INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD_NO_REGISTRATION_2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_C_L_A_S_S_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ) , ClassName, Name, Tags, typename T, __VA_ARGS__ ) ) #endif #ifndef CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR #define INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD_SIG_NO_REGISTRATION( ClassName, Name, Tags, Signature, ... ) \ - INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD_NO_REGISTRATION_2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____C_L_A_S_S____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ) , ClassName, Name, Tags, Signature, __VA_ARGS__ ) + INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD_NO_REGISTRATION_2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_C_L_A_S_S_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ) , ClassName, Name, Tags, Signature, __VA_ARGS__ ) #else #define INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD_SIG_NO_REGISTRATION( ClassName, Name, Tags, Signature, ... ) \ - INTERNAL_CATCH_EXPAND_VARGS( INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD_NO_REGISTRATION_2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____C_L_A_S_S____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ) , ClassName, Name, Tags, Signature, __VA_ARGS__ ) ) + INTERNAL_CATCH_EXPAND_VARGS( INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD_NO_REGISTRATION_2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_C_L_A_S_S_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ) , ClassName, Name, Tags, Signature, __VA_ARGS__ ) ) #endif #endif @@ -1050,7 +1052,7 @@ struct AutoReg : NonCopyable { CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION \ static void TestName() #define INTERNAL_CATCH_TESTCASE( ... ) \ - INTERNAL_CATCH_TESTCASE2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_S_T____ ), __VA_ARGS__ ) + INTERNAL_CATCH_TESTCASE2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_S_T_ ), __VA_ARGS__ ) /////////////////////////////////////////////////////////////////////////////// #define INTERNAL_CATCH_METHOD_AS_TEST_CASE( QualifiedMethod, ... ) \ @@ -1072,7 +1074,7 @@ struct AutoReg : NonCopyable { CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION \ void TestName::test() #define INTERNAL_CATCH_TEST_CASE_METHOD( ClassName, ... ) \ - INTERNAL_CATCH_TEST_CASE_METHOD2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_S_T____ ), ClassName, __VA_ARGS__ ) + INTERNAL_CATCH_TEST_CASE_METHOD2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_S_T_ ), ClassName, __VA_ARGS__ ) /////////////////////////////////////////////////////////////////////////////// #define INTERNAL_CATCH_REGISTER_TESTCASE( Function, ... ) \ @@ -1113,18 +1115,18 @@ struct AutoReg : NonCopyable { #ifndef CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR #define INTERNAL_CATCH_TEMPLATE_TEST_CASE(Name, Tags, ...) \ - INTERNAL_CATCH_TEMPLATE_TEST_CASE_2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____F_U_N_C____ ), Name, Tags, typename TestType, __VA_ARGS__ ) + INTERNAL_CATCH_TEMPLATE_TEST_CASE_2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_F_U_N_C_ ), Name, Tags, typename TestType, __VA_ARGS__ ) #else #define INTERNAL_CATCH_TEMPLATE_TEST_CASE(Name, Tags, ...) \ - INTERNAL_CATCH_EXPAND_VARGS( INTERNAL_CATCH_TEMPLATE_TEST_CASE_2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____F_U_N_C____ ), Name, Tags, typename TestType, __VA_ARGS__ ) ) + INTERNAL_CATCH_EXPAND_VARGS( INTERNAL_CATCH_TEMPLATE_TEST_CASE_2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_F_U_N_C_ ), Name, Tags, typename TestType, __VA_ARGS__ ) ) #endif #ifndef CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR #define INTERNAL_CATCH_TEMPLATE_TEST_CASE_SIG(Name, Tags, Signature, ...) \ - INTERNAL_CATCH_TEMPLATE_TEST_CASE_2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____F_U_N_C____ ), Name, Tags, Signature, __VA_ARGS__ ) + INTERNAL_CATCH_TEMPLATE_TEST_CASE_2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_F_U_N_C_ ), Name, Tags, Signature, __VA_ARGS__ ) #else #define INTERNAL_CATCH_TEMPLATE_TEST_CASE_SIG(Name, Tags, Signature, ...) \ - INTERNAL_CATCH_EXPAND_VARGS( INTERNAL_CATCH_TEMPLATE_TEST_CASE_2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____F_U_N_C____ ), Name, Tags, Signature, __VA_ARGS__ ) ) + INTERNAL_CATCH_EXPAND_VARGS( INTERNAL_CATCH_TEMPLATE_TEST_CASE_2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_F_U_N_C_ ), Name, Tags, Signature, __VA_ARGS__ ) ) #endif #define INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE2(TestName, TestFuncName, Name, Tags, Signature, TmplTypes, TypesList) \ @@ -1162,18 +1164,18 @@ struct AutoReg : NonCopyable { #ifndef CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR #define INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE(Name, Tags, ...)\ - INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE2(INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____F_U_N_C____ ), Name, Tags, typename T,__VA_ARGS__) + INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE2(INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_F_U_N_C_ ), Name, Tags, typename T,__VA_ARGS__) #else #define INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE(Name, Tags, ...)\ - INTERNAL_CATCH_EXPAND_VARGS( INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____F_U_N_C____ ), Name, Tags, typename T, __VA_ARGS__ ) ) + INTERNAL_CATCH_EXPAND_VARGS( INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_F_U_N_C_ ), Name, Tags, typename T, __VA_ARGS__ ) ) #endif #ifndef CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR #define INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE_SIG(Name, Tags, Signature, ...)\ - INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE2(INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____F_U_N_C____ ), Name, Tags, Signature, __VA_ARGS__) + INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE2(INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_F_U_N_C_ ), Name, Tags, Signature, __VA_ARGS__) #else #define INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE_SIG(Name, Tags, Signature, ...)\ - INTERNAL_CATCH_EXPAND_VARGS( INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____F_U_N_C____ ), Name, Tags, Signature, __VA_ARGS__ ) ) + INTERNAL_CATCH_EXPAND_VARGS( INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_F_U_N_C_ ), Name, Tags, Signature, __VA_ARGS__ ) ) #endif #define INTERNAL_CATCH_TEMPLATE_LIST_TEST_CASE_2(TestName, TestFunc, Name, Tags, TmplList)\ @@ -1204,7 +1206,7 @@ struct AutoReg : NonCopyable { static void TestFunc() #define INTERNAL_CATCH_TEMPLATE_LIST_TEST_CASE(Name, Tags, TmplList) \ - INTERNAL_CATCH_TEMPLATE_LIST_TEST_CASE_2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____F_U_N_C____ ), Name, Tags, TmplList ) + INTERNAL_CATCH_TEMPLATE_LIST_TEST_CASE_2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_F_U_N_C_ ), Name, Tags, TmplList ) #define INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD_2( TestNameClass, TestName, ClassName, Name, Tags, Signature, ... ) \ CATCH_INTERNAL_START_WARNINGS_SUPPRESSION \ @@ -1237,18 +1239,18 @@ struct AutoReg : NonCopyable { #ifndef CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR #define INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD( ClassName, Name, Tags,... ) \ - INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD_2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____C_L_A_S_S____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ) , ClassName, Name, Tags, typename T, __VA_ARGS__ ) + INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD_2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_C_L_A_S_S_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ) , ClassName, Name, Tags, typename T, __VA_ARGS__ ) #else #define INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD( ClassName, Name, Tags,... ) \ - INTERNAL_CATCH_EXPAND_VARGS( INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD_2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____C_L_A_S_S____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ) , ClassName, Name, Tags, typename T, __VA_ARGS__ ) ) + INTERNAL_CATCH_EXPAND_VARGS( INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD_2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_C_L_A_S_S_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ) , ClassName, Name, Tags, typename T, __VA_ARGS__ ) ) #endif #ifndef CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR #define INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD_SIG( ClassName, Name, Tags, Signature, ... ) \ - INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD_2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____C_L_A_S_S____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ) , ClassName, Name, Tags, Signature, __VA_ARGS__ ) + INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD_2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_C_L_A_S_S_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ) , ClassName, Name, Tags, Signature, __VA_ARGS__ ) #else #define INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD_SIG( ClassName, Name, Tags, Signature, ... ) \ - INTERNAL_CATCH_EXPAND_VARGS( INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD_2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____C_L_A_S_S____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ) , ClassName, Name, Tags, Signature, __VA_ARGS__ ) ) + INTERNAL_CATCH_EXPAND_VARGS( INTERNAL_CATCH_TEMPLATE_TEST_CASE_METHOD_2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_C_L_A_S_S_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ) , ClassName, Name, Tags, Signature, __VA_ARGS__ ) ) #endif #define INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE_METHOD_2(TestNameClass, TestName, ClassName, Name, Tags, Signature, TmplTypes, TypesList)\ @@ -1289,18 +1291,18 @@ struct AutoReg : NonCopyable { #ifndef CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR #define INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE_METHOD( ClassName, Name, Tags, ... )\ - INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE_METHOD_2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____F_U_N_C____ ), ClassName, Name, Tags, typename T, __VA_ARGS__ ) + INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE_METHOD_2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_F_U_N_C_ ), ClassName, Name, Tags, typename T, __VA_ARGS__ ) #else #define INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE_METHOD( ClassName, Name, Tags, ... )\ - INTERNAL_CATCH_EXPAND_VARGS( INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE_METHOD_2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____F_U_N_C____ ), ClassName, Name, Tags, typename T,__VA_ARGS__ ) ) + INTERNAL_CATCH_EXPAND_VARGS( INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE_METHOD_2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_F_U_N_C_ ), ClassName, Name, Tags, typename T,__VA_ARGS__ ) ) #endif #ifndef CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR #define INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE_METHOD_SIG( ClassName, Name, Tags, Signature, ... )\ - INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE_METHOD_2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____F_U_N_C____ ), ClassName, Name, Tags, Signature, __VA_ARGS__ ) + INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE_METHOD_2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_F_U_N_C_ ), ClassName, Name, Tags, Signature, __VA_ARGS__ ) #else #define INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE_METHOD_SIG( ClassName, Name, Tags, Signature, ... )\ - INTERNAL_CATCH_EXPAND_VARGS( INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE_METHOD_2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____F_U_N_C____ ), ClassName, Name, Tags, Signature,__VA_ARGS__ ) ) + INTERNAL_CATCH_EXPAND_VARGS( INTERNAL_CATCH_TEMPLATE_PRODUCT_TEST_CASE_METHOD_2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_F_U_N_C_ ), ClassName, Name, Tags, Signature,__VA_ARGS__ ) ) #endif #define INTERNAL_CATCH_TEMPLATE_LIST_TEST_CASE_METHOD_2( TestNameClass, TestName, ClassName, Name, Tags, TmplList) \ @@ -1334,7 +1336,7 @@ struct AutoReg : NonCopyable { void TestName::test() #define INTERNAL_CATCH_TEMPLATE_LIST_TEST_CASE_METHOD(ClassName, Name, Tags, TmplList) \ - INTERNAL_CATCH_TEMPLATE_LIST_TEST_CASE_METHOD_2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____ ), INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_M_P_L_A_T_E____T_E_S_T____F_U_N_C____ ), ClassName, Name, Tags, TmplList ) + INTERNAL_CATCH_TEMPLATE_LIST_TEST_CASE_METHOD_2( INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_ ), INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_M_P_L_A_T_E_T_E_S_T_F_U_N_C_ ), ClassName, Name, Tags, TmplList ) // end catch_test_registry.h // start catch_capture.hpp @@ -3091,7 +3093,7 @@ namespace Detail { Approx operator-() const; template ::value>::type> - Approx operator()( T const& value ) { + Approx operator()( T const& value ) const { Approx approx( static_cast(value) ); approx.m_epsilon = m_epsilon; approx.m_margin = m_margin; @@ -4163,7 +4165,7 @@ namespace Generators { if (!m_predicate(m_generator.get())) { // It might happen that there are no values that pass the // filter. In that case we throw an exception. - auto has_initial_value = next(); + auto has_initial_value = nextImpl(); if (!has_initial_value) { Catch::throw_exception(GeneratorException("No valid value found in filtered generator")); } @@ -4175,6 +4177,11 @@ namespace Generators { } bool next() override { + return nextImpl(); + } + + private: + bool nextImpl() { bool success = m_generator.next(); if (!success) { return false; @@ -15380,7 +15387,7 @@ namespace Catch { } Version const& libraryVersion() { - static Version version( 2, 13, 7, "", 0 ); + static Version version( 2, 13, 8, "", 0 ); return version; } @@ -17648,9 +17655,9 @@ int main (int argc, char * const argv[]) { #if defined(CATCH_CONFIG_ENABLE_BENCHMARKING) #define CATCH_BENCHMARK(...) \ - INTERNAL_CATCH_BENCHMARK(INTERNAL_CATCH_UNIQUE_NAME(____C_A_T_C_H____B_E_N_C_H____), INTERNAL_CATCH_GET_1_ARG(__VA_ARGS__,,), INTERNAL_CATCH_GET_2_ARG(__VA_ARGS__,,)) + INTERNAL_CATCH_BENCHMARK(INTERNAL_CATCH_UNIQUE_NAME(C_A_T_C_H_B_E_N_C_H_), INTERNAL_CATCH_GET_1_ARG(__VA_ARGS__,,), INTERNAL_CATCH_GET_2_ARG(__VA_ARGS__,,)) #define CATCH_BENCHMARK_ADVANCED(name) \ - INTERNAL_CATCH_BENCHMARK_ADVANCED(INTERNAL_CATCH_UNIQUE_NAME(____C_A_T_C_H____B_E_N_C_H____), name) + INTERNAL_CATCH_BENCHMARK_ADVANCED(INTERNAL_CATCH_UNIQUE_NAME(C_A_T_C_H_B_E_N_C_H_), name) #endif // CATCH_CONFIG_ENABLE_BENCHMARKING // If CATCH_CONFIG_PREFIX_ALL is not defined then the CATCH_ prefix is not required @@ -17752,9 +17759,9 @@ int main (int argc, char * const argv[]) { #if defined(CATCH_CONFIG_ENABLE_BENCHMARKING) #define BENCHMARK(...) \ - INTERNAL_CATCH_BENCHMARK(INTERNAL_CATCH_UNIQUE_NAME(____C_A_T_C_H____B_E_N_C_H____), INTERNAL_CATCH_GET_1_ARG(__VA_ARGS__,,), INTERNAL_CATCH_GET_2_ARG(__VA_ARGS__,,)) + INTERNAL_CATCH_BENCHMARK(INTERNAL_CATCH_UNIQUE_NAME(C_A_T_C_H_B_E_N_C_H_), INTERNAL_CATCH_GET_1_ARG(__VA_ARGS__,,), INTERNAL_CATCH_GET_2_ARG(__VA_ARGS__,,)) #define BENCHMARK_ADVANCED(name) \ - INTERNAL_CATCH_BENCHMARK_ADVANCED(INTERNAL_CATCH_UNIQUE_NAME(____C_A_T_C_H____B_E_N_C_H____), name) + INTERNAL_CATCH_BENCHMARK_ADVANCED(INTERNAL_CATCH_UNIQUE_NAME(C_A_T_C_H_B_E_N_C_H_), name) #endif // CATCH_CONFIG_ENABLE_BENCHMARKING using Catch::Detail::Approx; @@ -17801,8 +17808,8 @@ using Catch::Detail::Approx; #define CATCH_WARN( msg ) (void)(0) #define CATCH_CAPTURE( msg ) (void)(0) -#define CATCH_TEST_CASE( ... ) INTERNAL_CATCH_TESTCASE_NO_REGISTRATION(INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_S_T____ )) -#define CATCH_TEST_CASE_METHOD( className, ... ) INTERNAL_CATCH_TESTCASE_NO_REGISTRATION(INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_S_T____ )) +#define CATCH_TEST_CASE( ... ) INTERNAL_CATCH_TESTCASE_NO_REGISTRATION(INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_S_T_ )) +#define CATCH_TEST_CASE_METHOD( className, ... ) INTERNAL_CATCH_TESTCASE_NO_REGISTRATION(INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_S_T_ )) #define CATCH_METHOD_AS_TEST_CASE( method, ... ) #define CATCH_REGISTER_TEST_CASE( Function, ... ) (void)(0) #define CATCH_SECTION( ... ) @@ -17811,7 +17818,7 @@ using Catch::Detail::Approx; #define CATCH_FAIL_CHECK( ... ) (void)(0) #define CATCH_SUCCEED( ... ) (void)(0) -#define CATCH_ANON_TEST_CASE() INTERNAL_CATCH_TESTCASE_NO_REGISTRATION(INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_S_T____ )) +#define CATCH_ANON_TEST_CASE() INTERNAL_CATCH_TESTCASE_NO_REGISTRATION(INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_S_T_ )) #ifndef CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR #define CATCH_TEMPLATE_TEST_CASE( ... ) INTERNAL_CATCH_TEMPLATE_TEST_CASE_NO_REGISTRATION(__VA_ARGS__) @@ -17834,8 +17841,8 @@ using Catch::Detail::Approx; #endif // "BDD-style" convenience wrappers -#define CATCH_SCENARIO( ... ) INTERNAL_CATCH_TESTCASE_NO_REGISTRATION(INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_S_T____ )) -#define CATCH_SCENARIO_METHOD( className, ... ) INTERNAL_CATCH_TESTCASE_METHOD_NO_REGISTRATION(INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_S_T____ ), className ) +#define CATCH_SCENARIO( ... ) INTERNAL_CATCH_TESTCASE_NO_REGISTRATION(INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_S_T_ )) +#define CATCH_SCENARIO_METHOD( className, ... ) INTERNAL_CATCH_TESTCASE_METHOD_NO_REGISTRATION(INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_S_T_ ), className ) #define CATCH_GIVEN( desc ) #define CATCH_AND_GIVEN( desc ) #define CATCH_WHEN( desc ) @@ -17885,8 +17892,8 @@ using Catch::Detail::Approx; #define WARN( msg ) (void)(0) #define CAPTURE( msg ) (void)(0) -#define TEST_CASE( ... ) INTERNAL_CATCH_TESTCASE_NO_REGISTRATION(INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_S_T____ )) -#define TEST_CASE_METHOD( className, ... ) INTERNAL_CATCH_TESTCASE_NO_REGISTRATION(INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_S_T____ )) +#define TEST_CASE( ... ) INTERNAL_CATCH_TESTCASE_NO_REGISTRATION(INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_S_T_ )) +#define TEST_CASE_METHOD( className, ... ) INTERNAL_CATCH_TESTCASE_NO_REGISTRATION(INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_S_T_ )) #define METHOD_AS_TEST_CASE( method, ... ) #define REGISTER_TEST_CASE( Function, ... ) (void)(0) #define SECTION( ... ) @@ -17894,7 +17901,7 @@ using Catch::Detail::Approx; #define FAIL( ... ) (void)(0) #define FAIL_CHECK( ... ) (void)(0) #define SUCCEED( ... ) (void)(0) -#define ANON_TEST_CASE() INTERNAL_CATCH_TESTCASE_NO_REGISTRATION(INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_S_T____ )) +#define ANON_TEST_CASE() INTERNAL_CATCH_TESTCASE_NO_REGISTRATION(INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_S_T_ )) #ifndef CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR #define TEMPLATE_TEST_CASE( ... ) INTERNAL_CATCH_TEMPLATE_TEST_CASE_NO_REGISTRATION(__VA_ARGS__) @@ -17924,8 +17931,8 @@ using Catch::Detail::Approx; #define CATCH_TRANSLATE_EXCEPTION( signature ) INTERNAL_CATCH_TRANSLATE_EXCEPTION_NO_REG( INTERNAL_CATCH_UNIQUE_NAME( catch_internal_ExceptionTranslator ), signature ) // "BDD-style" convenience wrappers -#define SCENARIO( ... ) INTERNAL_CATCH_TESTCASE_NO_REGISTRATION(INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_S_T____ ) ) -#define SCENARIO_METHOD( className, ... ) INTERNAL_CATCH_TESTCASE_METHOD_NO_REGISTRATION(INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_S_T____ ), className ) +#define SCENARIO( ... ) INTERNAL_CATCH_TESTCASE_NO_REGISTRATION(INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_S_T_ ) ) +#define SCENARIO_METHOD( className, ... ) INTERNAL_CATCH_TESTCASE_METHOD_NO_REGISTRATION(INTERNAL_CATCH_UNIQUE_NAME( C_A_T_C_H_T_E_S_T_ ), className ) #define GIVEN( desc ) #define AND_GIVEN( desc ) diff --git a/tests/prepare_proxy_verifier.sh b/tests/prepare_proxy_verifier.sh index b26c78d9287..3c75883aca3 100755 --- a/tests/prepare_proxy_verifier.sh +++ b/tests/prepare_proxy_verifier.sh @@ -27,7 +27,7 @@ pv_dir="${pv_name}-${pv_version}" pv_tar_filename="${pv_dir}.tar.gz" pv_tar="${pv_top_dir}/${pv_tar_filename}" pv_tar_url="https://ci.trafficserver.apache.org/bintray/${pv_tar_filename}" -expected_sha1="5c7b5a0e105321cc1627fcdc80b2bf16b44033af" +expected_sha1="d602c299d1f1336c4970529ab7fef7afbbb8723b" pv_client="${bin_dir}/verifier-client" pv_server="${bin_dir}/verifier-server" TAR=${TAR:-tar} diff --git a/tests/proxy-verifier-version.txt b/tests/proxy-verifier-version.txt index b1d18bc43f0..aaf7425f4a9 100644 --- a/tests/proxy-verifier-version.txt +++ b/tests/proxy-verifier-version.txt @@ -1 +1 @@ -v2.3.0 +v2.3.1 diff --git a/tools/autopep8.sh b/tools/autopep8.sh index b17e9020496..44e6f1ac1a9 100755 --- a/tools/autopep8.sh +++ b/tools/autopep8.sh @@ -93,7 +93,7 @@ function main() { --aggressive \ --aggressive \ --recursive \ - plugins/experimental/metalink/test + ${DIR}/plugins/experimental/metalink/test echo "autopep8 completed." rm -rf ${tmp_dir} deactivate