Making 9.2.x backwards compatible with 9.1.x

In order to make 9.2.x backwards compatible against plugins compiled
with 9.1.x, this PR does the following:

1. Adds back exposed enum values removed in 9.2.x
2. Any added enum values are put at the end of their enumeration lists.
3. Adds back the TSHttpTxnCntl function

Author: bneradt

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,13 +855,15 @@ typedef enum {
   TS_CONFIG_HTTP_SERVER_MIN_KEEP_ALIVE_CONNS,
   TS_CONFIG_HTTP_PER_SERVER_CONNECTION_MAX,
   TS_CONFIG_HTTP_PER_SERVER_CONNECTION_MATCH,
+  TS_CONFIG_SSL_CLIENT_VERIFY_SERVER,
   TS_CONFIG_SSL_CLIENT_VERIFY_SERVER_POLICY,
   TS_CONFIG_SSL_CLIENT_VERIFY_SERVER_PROPERTIES,
   TS_CONFIG_SSL_CLIENT_SNI_POLICY,
   TS_CONFIG_SSL_CLIENT_PRIVATE_KEY_FILENAME,
   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,

include/ts/experimental.h

@@ -73,6 +73,23 @@ 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);
 
+/* 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);
+
 /* Protocols APIs */
 tsapi void TSVConnCacheHttpInfoSet(TSVConn connp, TSCacheHttpInfo infop);
 

plugins/lua/ts_lua_http_config.c

@@ -133,6 +133,7 @@ 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                      = TS_CONFIG_SSL_CLIENT_VERIFY_SERVER,
   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,
@@ -267,6 +268,7 @@ 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),
+  TS_LUA_MAKE_VAR_ITEM(TS_CONFIG_SSL_CLIENT_VERIFY_SERVER),
   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),

src/traffic_server/InkAPI.cc

@@ -6536,6 +6536,70 @@ TSHttpTxnStatusGet(TSHttpTxn txnp)
   return static_cast<TSHttpStatus>(sm->t_state.http_return_code);
 }
 
+/* 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<intptr_t *>(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<intptr_t *>(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;
+}
+
 TSReturnCode
 TSHttpTxnCntlSet(TSHttpTxn txnp, TSHttpCntlType cntl, bool data)
 {
@@ -8970,6 +9034,10 @@ _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:
+
+  // The following is not used in 9.2.x, but preserved for ABI compatibility.
+  case TS_CONFIG_SSL_CLIENT_VERIFY_SERVER:
+
     break;
   }