Associate HttpSM with TSMLoc

bneradt · bneradt · commit 07e02a8d95ad · 2025-09-16T23:11:13.000Z
Avoid the user needing to include TSHttpTxn to TSHttpHdrStatusSet by
keeping track of the HttpSM per TSMLoc and using that when passed in.
diff --git a/doc/developer-guide/api/functions/TSHttpHdrStatusSet.en.rst b/doc/developer-guide/api/functions/TSHttpHdrStatusSet.en.rst
@@ -30,7 +30,7 @@ Synopsis
 
 .. function:: TSReturnCode TSHttpHdrStatusSet(TSMBuffer bufp, TSMLoc offset, TSHttpStatus status)
 
-.. function:: TSReturnCode TSHttpHdrStatusSet(TSMBuffer bufp, TSMLoc offset, TSHttpStatus status, TSHttpTxn txnp, std::string_view setter)
+.. function:: TSReturnCode TSHttpHdrStatusSet(TSMBuffer bufp, TSMLoc offset, TSHttpStatus status, std::string_view setter)
 
 Description
 ===========
@@ -45,5 +45,4 @@ Parameters
 - bufp: Marshal buffer containing the HTTP header.
 - offset: Location of the HTTP header within bufp.
 - status: The HTTP status code to set.
-- txnp: Optional transaction handle on which to record the setter label.
 - setter: Optional label identifying the component setting the status; pass empty to leave unchanged.
diff --git a/example/plugins/c-api/basic_auth/basic_auth.cc b/example/plugins/c-api/basic_auth/basic_auth.cc
@@ -174,7 +174,7 @@ handle_response(TSHttpTxn txnp)
     goto done;
   }
 
-  TSHttpHdrStatusSet(bufp, hdr_loc, TS_HTTP_STATUS_PROXY_AUTHENTICATION_REQUIRED, txnp, PLUGIN_NAME);
+  TSHttpHdrStatusSet(bufp, hdr_loc, TS_HTTP_STATUS_PROXY_AUTHENTICATION_REQUIRED, PLUGIN_NAME);
   TSHttpHdrReasonSet(bufp, hdr_loc, TSHttpHdrReasonLookup(TS_HTTP_STATUS_PROXY_AUTHENTICATION_REQUIRED),
                      strlen(TSHttpHdrReasonLookup(TS_HTTP_STATUS_PROXY_AUTHENTICATION_REQUIRED)));
 
diff --git a/example/plugins/c-api/denylist_0/denylist_0.cc b/example/plugins/c-api/denylist_0/denylist_0.cc
@@ -99,7 +99,7 @@ handle_response(TSHttpTxn txnp)
     goto done;
   }
 
-  TSHttpHdrStatusSet(bufp, hdr_loc, TS_HTTP_STATUS_FORBIDDEN, txnp, PLUGIN_NAME);
+  TSHttpHdrStatusSet(bufp, hdr_loc, TS_HTTP_STATUS_FORBIDDEN, PLUGIN_NAME);
   TSHttpHdrReasonSet(bufp, hdr_loc, TSHttpHdrReasonLookup(TS_HTTP_STATUS_FORBIDDEN),
                      strlen(TSHttpHdrReasonLookup(TS_HTTP_STATUS_FORBIDDEN)));
 
diff --git a/example/plugins/c-api/denylist_1/denylist_1.cc b/example/plugins/c-api/denylist_1/denylist_1.cc
@@ -145,7 +145,7 @@ handle_response(TSHttpTxn txnp, TSCont contp ATS_UNUSED)
     goto done;
   }
 
-  TSHttpHdrStatusSet(bufp, hdr_loc, TS_HTTP_STATUS_FORBIDDEN, txnp, PLUGIN_NAME);
+  TSHttpHdrStatusSet(bufp, hdr_loc, TS_HTTP_STATUS_FORBIDDEN, PLUGIN_NAME);
   TSHttpHdrReasonSet(bufp, hdr_loc, TSHttpHdrReasonLookup(TS_HTTP_STATUS_FORBIDDEN),
                      strlen(TSHttpHdrReasonLookup(TS_HTTP_STATUS_FORBIDDEN)));
 
diff --git a/example/plugins/c-api/redirect_1/redirect_1.cc b/example/plugins/c-api/redirect_1/redirect_1.cc
@@ -191,7 +191,7 @@ handle_response(TSHttpTxn txnp)
     goto done;
   }
 
-  TSHttpHdrStatusSet(bufp, hdr_loc, TS_HTTP_STATUS_MOVED_PERMANENTLY, txnp, PLUGIN_NAME);
+  TSHttpHdrStatusSet(bufp, hdr_loc, TS_HTTP_STATUS_MOVED_PERMANENTLY, PLUGIN_NAME);
   TSHttpHdrReasonSet(bufp, hdr_loc, TSHttpHdrReasonLookup(TS_HTTP_STATUS_MOVED_PERMANENTLY),
                      strlen(TSHttpHdrReasonLookup(TS_HTTP_STATUS_MOVED_PERMANENTLY)));
 
diff --git a/include/ts/ts.h b/include/ts/ts.h
@@ -1145,7 +1145,7 @@ TSReturnCode TSHttpHdrUrlSet(TSMBuffer bufp, TSMLoc offset, TSMLoc url);
 TSHttpStatus TSHttpHdrStatusGet(TSMBuffer bufp, TSMLoc offset);
 /** This is a candidate for deprecation in v10.0.0 in favor of the version that takes the setter. */
 TSReturnCode TSHttpHdrStatusSet(TSMBuffer bufp, TSMLoc offset, TSHttpStatus status);
-TSReturnCode TSHttpHdrStatusSet(TSMBuffer bufp, TSMLoc offset, TSHttpStatus status, TSHttpTxn txnp, std::string_view setter);
+TSReturnCode TSHttpHdrStatusSet(TSMBuffer bufp, TSMLoc offset, TSHttpStatus status, std::string_view setter);
 const char  *TSHttpHdrReasonGet(TSMBuffer bufp, TSMLoc offset, int *length);
 TSReturnCode TSHttpHdrReasonSet(TSMBuffer bufp, TSMLoc offset, const char *value, int length);
 const char  *TSHttpHdrReasonLookup(TSHttpStatus status);
diff --git a/plugins/experimental/icap/icap_plugin.cc b/plugins/experimental/icap/icap_plugin.cc
@@ -241,7 +241,7 @@ handle_invalid_icap_behavior(TSCont contp, TransformData *data, const char *msg)
     TSError("[%s] Couldn't clear client response header", PLUGIN_NAME);
     return 0;
   }
-  TSHttpHdrStatusSet(bufp, hdr_loc, TS_HTTP_STATUS_BAD_GATEWAY, data->txn, PLUGIN_NAME);
+  TSHttpHdrStatusSet(bufp, hdr_loc, TS_HTTP_STATUS_BAD_GATEWAY, PLUGIN_NAME);
   TSHttpHdrReasonSet(bufp, hdr_loc, TSHttpHdrReasonLookup(TS_HTTP_STATUS_BAD_GATEWAY),
                      strlen(TSHttpHdrReasonLookup(TS_HTTP_STATUS_BAD_GATEWAY)));
   TSHandleMLocRelease(bufp, TS_NULL_MLOC, hdr_loc);
diff --git a/plugins/experimental/tls_bridge/tls_bridge.cc b/plugins/experimental/tls_bridge/tls_bridge.cc
@@ -513,7 +513,7 @@ Bridge::update_ua_response()
     // an actual upstream connection. Otherwise, let the original connection response code
     // ride.
     if (_out_response_code != TS_HTTP_STATUS_OK && _out_response_code != TS_HTTP_STATUS_NONE) {
-      TSHttpHdrStatusSet(mbuf, hdr_loc, _out_response_code, _ua_txn, PLUGIN_NAME);
+      TSHttpHdrStatusSet(mbuf, hdr_loc, _out_response_code, PLUGIN_NAME);
       if (!_out_response_reason.empty()) {
         TSHttpHdrReasonSet(mbuf, hdr_loc, _out_response_reason.data(), _out_response_reason.size());
       }
diff --git a/plugins/experimental/txn_box/plugin/src/ts_util.cc b/plugins/experimental/txn_box/plugin/src/ts_util.cc
@@ -660,7 +660,7 @@ ts::HttpHeader::field_remove(swoc::TextView name)
 bool
 ts::HttpResponse::status_set(TSHttpStatus status) const
 {
-  return TS_SUCCESS == TSHttpHdrStatusSet(_buff, _loc, status, nullptr, "");
+  return TS_SUCCESS == TSHttpHdrStatusSet(_buff, _loc, status, "");
 }
 
 TextView
diff --git a/plugins/experimental/wasm/ats_context.cc b/plugins/experimental/wasm/ats_context.cc
@@ -1412,7 +1412,7 @@ Context::setProperty(std::string_view key, std::string_view serialized_value)
 
     if (TSHttpTxnServerRespGet(txnp_, &bufp, &hdr_loc) == TS_SUCCESS) {
       int64_t *status = reinterpret_cast<int64_t *>(const_cast<char *>(serialized_value.data()));
-      TSHttpHdrStatusSet(bufp, hdr_loc, static_cast<TSHttpStatus>(*status), txnp_, WASM_DEBUG_TAG);
+      TSHttpHdrStatusSet(bufp, hdr_loc, static_cast<TSHttpStatus>(*status), WASM_DEBUG_TAG);
       TSHandleMLocRelease(bufp, TS_NULL_MLOC, hdr_loc);
     }
     return WasmResult::Ok;
diff --git a/plugins/header_rewrite/operators.cc b/plugins/header_rewrite/operators.cc
@@ -199,7 +199,7 @@ OperatorSetStatus::exec(const Resources &res) const
   case TS_HTTP_READ_RESPONSE_HDR_HOOK:
   case TS_HTTP_SEND_RESPONSE_HDR_HOOK:
     if (res.bufp && res.hdr_loc) {
-      TSHttpHdrStatusSet(res.bufp, res.hdr_loc, static_cast<TSHttpStatus>(_status.get_int_value()), res.state.txnp, PLUGIN_NAME);
+      TSHttpHdrStatusSet(res.bufp, res.hdr_loc, static_cast<TSHttpStatus>(_status.get_int_value()), PLUGIN_NAME);
       if (_reason && _reason_len > 0) {
         TSHttpHdrReasonSet(res.bufp, res.hdr_loc, _reason, _reason_len);
       }
@@ -598,7 +598,7 @@ OperatorSetRedirect::exec(const Resources &res) const
       Dbg(pi_dbg_ctl, "OperatorSetRedirect::exec() hook=%d", int(get_hook()));
       // Set the new status code and reason.
       TSHttpStatus status = static_cast<TSHttpStatus>(_status.get_int_value());
-      TSHttpHdrStatusSet(res.bufp, res.hdr_loc, status, res.state.txnp, PLUGIN_NAME);
+      TSHttpHdrStatusSet(res.bufp, res.hdr_loc, status, PLUGIN_NAME);
       EditRedirectResponse(res.state.txnp, value, status, res.bufp, res.hdr_loc);
     }
     Dbg(pi_dbg_ctl, "OperatorSetRedirect::exec() invoked with destination=%s and status code=%d", value.c_str(),
diff --git a/plugins/lua/ts_lua_client_response.cc b/plugins/lua/ts_lua_client_response.cc
@@ -403,7 +403,7 @@ ts_lua_client_response_set_status(lua_State *L)
   reason     = TSHttpHdrReasonLookup(TSHttpStatus(status));
   reason_len = strlen(reason);
 
-  TSHttpHdrStatusSet(http_ctx->client_response_bufp, http_ctx->client_response_hdrp, TSHttpStatus(status), http_ctx->txnp, "lua");
+  TSHttpHdrStatusSet(http_ctx->client_response_bufp, http_ctx->client_response_hdrp, TSHttpStatus(status), "lua");
   TSHttpHdrReasonSet(http_ctx->client_response_bufp, http_ctx->client_response_hdrp, reason, reason_len);
 
   return 0;
@@ -488,7 +488,7 @@ ts_lua_client_response_set_error_resp(lua_State *L)
   }
   reason_len = strlen(reason);
 
-  TSHttpHdrStatusSet(http_ctx->client_response_bufp, http_ctx->client_response_hdrp, TSHttpStatus(status), http_ctx->txnp, "lua");
+  TSHttpHdrStatusSet(http_ctx->client_response_bufp, http_ctx->client_response_hdrp, TSHttpStatus(status), "lua");
   TSHttpHdrReasonSet(http_ctx->client_response_bufp, http_ctx->client_response_hdrp, reason, reason_len);
 
   body_len = 0;
diff --git a/plugins/lua/ts_lua_server_response.cc b/plugins/lua/ts_lua_server_response.cc
@@ -391,7 +391,7 @@ ts_lua_server_response_set_status(lua_State *L)
     reason_len = strlen(reason);
   }
 
-  TSHttpHdrStatusSet(http_ctx->server_response_bufp, http_ctx->server_response_hdrp, TSHttpStatus(status), http_ctx->txnp, "lua");
+  TSHttpHdrStatusSet(http_ctx->server_response_bufp, http_ctx->server_response_hdrp, TSHttpStatus(status), "lua");
   TSHttpHdrReasonSet(http_ctx->server_response_bufp, http_ctx->server_response_hdrp, reason, reason_len);
 
   return 0;
diff --git a/plugins/prefetch/plugin.cc b/plugins/prefetch/plugin.cc
@@ -687,7 +687,7 @@ contHandleFetch(const TSCont contp, TSEvent event, void *edata)
       if (TS_SUCCESS == TSHttpTxnClientRespGet(txnp, &bufp, &hdrLoc)) {
         const char *reason    = TSHttpHdrReasonLookup(data->_status);
         int         reasonLen = strlen(reason);
-        TSHttpHdrStatusSet(bufp, hdrLoc, data->_status, txnp, PLUGIN_NAME);
+        TSHttpHdrStatusSet(bufp, hdrLoc, data->_status, PLUGIN_NAME);
         TSHttpHdrReasonSet(bufp, hdrLoc, reason, reasonLen);
         PrefetchDebug("set response: %d %.*s '%s'", data->_status, reasonLen, reason, data->_body.c_str());
 
diff --git a/plugins/remap_purge/remap_purge.cc b/plugins/remap_purge/remap_purge.cc
@@ -143,7 +143,7 @@ on_send_response_header(TSHttpTxn txnp, TSCont contp, PurgeInstance *purge)
     char response[1024];
     int  len = snprintf(response, sizeof(response), "PURGED %s\r\n\r\n", purge->id);
 
-    TSHttpHdrStatusSet(bufp, hdr_loc, TS_HTTP_STATUS_OK, txnp, PLUGIN_NAME);
+    TSHttpHdrStatusSet(bufp, hdr_loc, TS_HTTP_STATUS_OK, PLUGIN_NAME);
     TSHttpHdrReasonSet(bufp, hdr_loc, "OK", 2);
     TSHttpTxnErrorBodySet(txnp, TSstrdup(response), len >= (int)sizeof(response) ? (int)sizeof(response) - 1 : len, nullptr);
 
diff --git a/src/api/InkAPI.cc b/src/api/InkAPI.cc
diff --git a/src/cripts/Headers.cc b/src/cripts/Headers.cc

Original file line number	Diff line number	Diff line change
`@@ -174,7 +174,7 @@ handle_response(TSHttpTxn txnp)`
`174`	`174`	`goto done;`
`175`	`175`	`}`
`176`	`176`
`177`		`- TSHttpHdrStatusSet(bufp, hdr_loc, TS_HTTP_STATUS_PROXY_AUTHENTICATION_REQUIRED, txnp, PLUGIN_NAME);`
	`177`	`+ TSHttpHdrStatusSet(bufp, hdr_loc, TS_HTTP_STATUS_PROXY_AUTHENTICATION_REQUIRED, PLUGIN_NAME);`
`178`	`178`	`TSHttpHdrReasonSet(bufp, hdr_loc, TSHttpHdrReasonLookup(TS_HTTP_STATUS_PROXY_AUTHENTICATION_REQUIRED),`
`179`	`179`	`strlen(TSHttpHdrReasonLookup(TS_HTTP_STATUS_PROXY_AUTHENTICATION_REQUIRED)));`
`180`	`180`
Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@ handle_response(TSHttpTxn txnp)`
`99`	`99`	`goto done;`
`100`	`100`	`}`
`101`	`101`
`102`		`- TSHttpHdrStatusSet(bufp, hdr_loc, TS_HTTP_STATUS_FORBIDDEN, txnp, PLUGIN_NAME);`
	`102`	`+ TSHttpHdrStatusSet(bufp, hdr_loc, TS_HTTP_STATUS_FORBIDDEN, PLUGIN_NAME);`
`103`	`103`	`TSHttpHdrReasonSet(bufp, hdr_loc, TSHttpHdrReasonLookup(TS_HTTP_STATUS_FORBIDDEN),`
`104`	`104`	`strlen(TSHttpHdrReasonLookup(TS_HTTP_STATUS_FORBIDDEN)));`
`105`	`105`
Original file line number	Diff line number	Diff line change
`@@ -145,7 +145,7 @@ handle_response(TSHttpTxn txnp, TSCont contp ATS_UNUSED)`
`145`	`145`	`goto done;`
`146`	`146`	`}`
`147`	`147`
`148`		`- TSHttpHdrStatusSet(bufp, hdr_loc, TS_HTTP_STATUS_FORBIDDEN, txnp, PLUGIN_NAME);`
	`148`	`+ TSHttpHdrStatusSet(bufp, hdr_loc, TS_HTTP_STATUS_FORBIDDEN, PLUGIN_NAME);`
`149`	`149`	`TSHttpHdrReasonSet(bufp, hdr_loc, TSHttpHdrReasonLookup(TS_HTTP_STATUS_FORBIDDEN),`
`150`	`150`	`strlen(TSHttpHdrReasonLookup(TS_HTTP_STATUS_FORBIDDEN)));`
`151`	`151`
Original file line number	Diff line number	Diff line change
`@@ -191,7 +191,7 @@ handle_response(TSHttpTxn txnp)`
`191`	`191`	`goto done;`
`192`	`192`	`}`
`193`	`193`
`194`		`- TSHttpHdrStatusSet(bufp, hdr_loc, TS_HTTP_STATUS_MOVED_PERMANENTLY, txnp, PLUGIN_NAME);`
	`194`	`+ TSHttpHdrStatusSet(bufp, hdr_loc, TS_HTTP_STATUS_MOVED_PERMANENTLY, PLUGIN_NAME);`
`195`	`195`	`TSHttpHdrReasonSet(bufp, hdr_loc, TSHttpHdrReasonLookup(TS_HTTP_STATUS_MOVED_PERMANENTLY),`
`196`	`196`	`strlen(TSHttpHdrReasonLookup(TS_HTTP_STATUS_MOVED_PERMANENTLY)));`
`197`	`197`
Original file line number	Diff line number	Diff line change
`@@ -241,7 +241,7 @@ handle_invalid_icap_behavior(TSCont contp, TransformData data, const char msg)`
`241`	`241`	`TSError("[%s] Couldn't clear client response header", PLUGIN_NAME);`
`242`	`242`	`return 0;`
`243`	`243`	`}`
`244`		`- TSHttpHdrStatusSet(bufp, hdr_loc, TS_HTTP_STATUS_BAD_GATEWAY, data->txn, PLUGIN_NAME);`
	`244`	`+ TSHttpHdrStatusSet(bufp, hdr_loc, TS_HTTP_STATUS_BAD_GATEWAY, PLUGIN_NAME);`
`245`	`245`	`TSHttpHdrReasonSet(bufp, hdr_loc, TSHttpHdrReasonLookup(TS_HTTP_STATUS_BAD_GATEWAY),`
`246`	`246`	`strlen(TSHttpHdrReasonLookup(TS_HTTP_STATUS_BAD_GATEWAY)));`
`247`	`247`	`TSHandleMLocRelease(bufp, TS_NULL_MLOC, hdr_loc);`
Original file line number	Diff line number	Diff line change
`@@ -513,7 +513,7 @@ Bridge::update_ua_response()`
`513`	`513`	`// an actual upstream connection. Otherwise, let the original connection response code`
`514`	`514`	`// ride.`
`515`	`515`	`if (_out_response_code != TS_HTTP_STATUS_OK && _out_response_code != TS_HTTP_STATUS_NONE) {`
`516`		`- TSHttpHdrStatusSet(mbuf, hdr_loc, _out_response_code, _ua_txn, PLUGIN_NAME);`
	`516`	`+ TSHttpHdrStatusSet(mbuf, hdr_loc, _out_response_code, PLUGIN_NAME);`
`517`	`517`	`if (!_out_response_reason.empty()) {`
`518`	`518`	`TSHttpHdrReasonSet(mbuf, hdr_loc, _out_response_reason.data(), _out_response_reason.size());`
`519`	`519`	`}`
Original file line number	Diff line number	Diff line change
`@@ -660,7 +660,7 @@ ts::HttpHeader::field_remove(swoc::TextView name)`
`660`	`660`	`bool`
`661`	`661`	`ts::HttpResponse::status_set(TSHttpStatus status) const`
`662`	`662`	`{`
`663`		`- return TS_SUCCESS == TSHttpHdrStatusSet(_buff, _loc, status, nullptr, "");`
	`663`	`+ return TS_SUCCESS == TSHttpHdrStatusSet(_buff, _loc, status, "");`
`664`	`664`	`}`
`665`	`665`
`666`	`666`	`TextView`
Original file line number	Diff line number	Diff line change
`@@ -1412,7 +1412,7 @@ Context::setProperty(std::string_view key, std::string_view serialized_value)`
`1412`	`1412`
`1413`	`1413`	`if (TSHttpTxnServerRespGet(txnp_, &bufp, &hdr_loc) == TS_SUCCESS) {`
`1414`	`1414`	`int64_t status = reinterpret_cast<int64_t >(const_cast<char *>(serialized_value.data()));`
`1415`		`- TSHttpHdrStatusSet(bufp, hdr_loc, static_cast<TSHttpStatus>(*status), txnp_, WASM_DEBUG_TAG);`
	`1415`	`+ TSHttpHdrStatusSet(bufp, hdr_loc, static_cast<TSHttpStatus>(*status), WASM_DEBUG_TAG);`
`1416`	`1416`	`TSHandleMLocRelease(bufp, TS_NULL_MLOC, hdr_loc);`
`1417`	`1417`	`}`
`1418`	`1418`	`return WasmResult::Ok;`