src/proxy/ProxyTransaction.cc

/** @file

  ProxyTransaction - Base class for protocol client transactions.

  @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 "proxy/http/HttpSM.h"
#include "proxy/Plugin.h"
#include "proxy/NonHttpSmLogData.h"
#include "proxy/logging/LogAccess.h"
#include "proxy/logging/TransactionLogData.h"
#include "proxy/logging/Log.h"

namespace
{
DbgCtl dbg_ctl_http_txn{"http_txn"};

} // end anonymous namespace

#define HttpTxnDebug(fmt, ...) SsnDbg(this, dbg_ctl_http_txn, fmt, __VA_ARGS__)

extern ClassAllocator<HttpSM> httpSMAllocator;

ProxyTransaction::ProxyTransaction(ProxySession *session) : VConnection(nullptr), _proxy_ssn(session)
{
  if (_proxy_ssn != nullptr && _proxy_ssn->acceptor != nullptr) {
    upstream_outbound_options = _proxy_ssn->acceptor->options();
  }
}

ProxyTransaction::~ProxyTransaction()
{
  this->_sm = nullptr;
  this->mutex.clear();
}

void
ProxyTransaction::new_transaction(bool from_early_data)
{
  ink_release_assert(_sm == nullptr);

  // Defensive programming, make sure nothing persists across
  // connection re-use

  ink_release_assert(_proxy_ssn != nullptr);
  if (_proxy_ssn->acceptor != nullptr) {
    upstream_outbound_options = _proxy_ssn->acceptor->options();
  }
  _sm = THREAD_ALLOC(httpSMAllocator, this_thread());
  _sm->init(from_early_data);
  HttpTxnDebug("[%" PRId64 "] Starting transaction %d using sm [%" PRId64 "]", _proxy_ssn->connection_id(),
               _proxy_ssn->get_transact_count(), _sm->sm_id);

  // PI tag valid only for internal requests
  if (this->get_netvc()->get_is_internal_request()) {
    PluginIdentity *pi = dynamic_cast<PluginIdentity *>(this->get_netvc());
    if (pi) {
      _sm->plugin_tag = pi->getPluginTag();
      _sm->plugin_id  = pi->getPluginId();
    }
  }

  this->increment_transactions_stat();
  _sm->attach_client_session(this);
}

bool
ProxyTransaction::attach_server_session(PoolableSession *ssession, bool transaction_done)
{
  return _proxy_ssn->attach_server_session(ssession, transaction_done);
}

void
ProxyTransaction::set_rx_error_code(ProxyError e)
{
  if (this->_sm) {
    this->_sm->t_state.client_info.rx_error_code = e;
  }
}

void
ProxyTransaction::set_tx_error_code(ProxyError e)
{
  if (this->_sm) {
    this->_sm->t_state.client_info.tx_error_code = e;
  }
}

NetVConnection *
ProxyTransaction::get_netvc() const
{
  return (_proxy_ssn) ? _proxy_ssn->get_netvc() : nullptr;
}

bool
ProxyTransaction::is_first_transaction() const
{
  return _proxy_ssn->get_transact_count() == 1;
}

void
ProxyTransaction::set_session_active()
{
  if (_proxy_ssn) {
    _proxy_ssn->set_session_active();
  }
}

void
ProxyTransaction::clear_session_active()
{
  if (_proxy_ssn) {
    _proxy_ssn->clear_session_active();
  }
}

const IpAllow::ACL &
ProxyTransaction::get_acl() const
{
  return _proxy_ssn ? _proxy_ssn->acl : IpAllow::DENY_ALL_ACL;
}

// outbound values Set via the server port definition.  Really only used for Http1 at the moment
in_port_t
ProxyTransaction::get_outbound_port() const
{
  return upstream_outbound_options.outbound_port;
}
void
ProxyTransaction::set_outbound_port(in_port_t port)
{
  upstream_outbound_options.outbound_port = port;
}

IpAddr
ProxyTransaction::get_outbound_ip4() const
{
  if (upstream_outbound_options.outbound.has_ip4()) {
    return IpAddr(upstream_outbound_options.outbound.ip4().network_order());
  }
  return IpAddr();
}

IpAddr
ProxyTransaction::get_outbound_ip6() const
{
  if (upstream_outbound_options.outbound.has_ip6()) {
    return IpAddr(upstream_outbound_options.outbound.ip6().network_order());
  }
  return IpAddr();
}

void
ProxyTransaction::set_outbound_ip(swoc::IPAddr const &addr)
{
  upstream_outbound_options.outbound = addr;
}

bool
ProxyTransaction::is_outbound_transparent() const
{
  return upstream_outbound_options.f_outbound_transparent;
}

void
ProxyTransaction::set_outbound_transparent(bool flag)
{
  upstream_outbound_options.f_outbound_transparent = flag;
}

int
ProxyTransaction::get_transaction_priority_weight() const
{
  return 0;
}

int
ProxyTransaction::get_transaction_priority_dependence() const
{
  return 0;
}

void
ProxyTransaction::transaction_done()
{
  SCOPED_MUTEX_LOCK(lock, this->mutex, this_ethread());
  this->decrement_transactions_stat();
}

// Implement VConnection interface.
VIO *
ProxyTransaction::do_io_read(Continuation *c, int64_t nbytes, MIOBuffer *buf)
{
  return _proxy_ssn->do_io_read(c, nbytes, buf);
}
VIO *
ProxyTransaction::do_io_write(Continuation *c, int64_t nbytes, IOBufferReader *buf, bool owner)
{
  return _proxy_ssn->do_io_write(c, nbytes, buf, owner);
}

void
ProxyTransaction::do_io_close(int lerrno)
{
  _proxy_ssn->do_io_close(lerrno);
  // this->destroy(); Parent owns this data structure.  No need for separate destroy.
}

void
ProxyTransaction::do_io_shutdown(ShutdownHowTo_t howto)
{
  _proxy_ssn->do_io_shutdown(howto);
}

void
ProxyTransaction::reenable(VIO *vio)
{
  _proxy_ssn->reenable(vio);
}

bool
ProxyTransaction::has_request_body(int64_t request_content_length, bool is_chunked) const
{
  return request_content_length > 0 || is_chunked;
}

void
ProxyTransaction::attach_transaction(HttpSM *attach_sm)
{
  _sm = attach_sm;
}

HTTPVersion
ProxyTransaction::get_version(HTTPHdr &hdr) const
{
  return hdr.version_get();
}

bool
ProxyTransaction::is_read_closed() const
{
  return false;
}

bool
ProxyTransaction::expect_send_trailer() const
{
  return false;
}

bool
ProxyTransaction::can_send_h2_trailer() const
{
  return false;
}

void
ProxyTransaction::set_expect_send_trailer()
{
}

bool
ProxyTransaction::expect_receive_trailer() const
{
  return false;
}

void
ProxyTransaction::set_expect_receive_trailer()
{
}

bool
ProxyTransaction::allow_half_open() const
{
  return false;
}

// Most protocols will not want to set the Connection: header
// For H2 it will initiate the drain logic.  So we make do nothing
// the default action.
void
ProxyTransaction::set_close_connection(HTTPHdr & /* hdr ATS_UNUSED */) const
{
}

void
ProxyTransaction::mark_as_tunnel_endpoint()
{
  auto nvc = get_netvc();
  ink_assert(nvc != nullptr);
  nvc->mark_as_tunnel_endpoint();
}

namespace
{
/** Build a best-effort request target for access logging. */
std::string
synthesize_request_target(std::string_view method, std::string_view scheme, std::string_view authority, std::string_view path)
{
  if (method == static_cast<std::string_view>(HTTP_METHOD_CONNECT)) {
    if (!authority.empty()) {
      return std::string(authority);
    }
    if (!path.empty()) {
      return std::string(path);
    }
    return {};
  }

  if (!scheme.empty() && !authority.empty()) {
    std::string url;
    url.reserve(scheme.size() + authority.size() + path.size() + 4);
    url.append(scheme);
    url.append("://");
    url.append(authority);
    if (!path.empty()) {
      url.append(path);
    } else {
      url.push_back('/');
    }
    return url;
  }

  if (!path.empty()) {
    return std::string(path);
  }

  return authority.empty() ? std::string{} : std::string(authority);
}

std::string_view
get_pseudo_header_value(HTTPHdr const &hdr, std::string_view name)
{
  if (auto const *field = hdr.field_find(name); field != nullptr) {
    return field->value_get();
  }
  return {};
}
} // end anonymous namespace

void
ProxyTransaction::log_non_http_sm_access(HTTPHdr const *request, const char *protocol_str)
{
  if (get_sm() != nullptr) {
    return;
  }

  if (request == nullptr || !request->valid() || request->type_get() != HTTPType::REQUEST) {
    return;
  }

  ProxySession *ssn = get_proxy_ssn();
  if (ssn == nullptr) {
    return;
  }

  NonHttpSmLogData data;

  data.owned_client_request.create(HTTPType::REQUEST, request->version_get());
  data.owned_client_request.copy(request);
  data.m_client_connection_is_ssl = ssn->ssl() != nullptr;

  auto const method_sv    = get_pseudo_header_value(*request, PSEUDO_HEADER_METHOD);
  auto const scheme_sv    = get_pseudo_header_value(*request, PSEUDO_HEADER_SCHEME);
  auto const authority_sv = get_pseudo_header_value(*request, PSEUDO_HEADER_AUTHORITY);
  auto const path_sv      = get_pseudo_header_value(*request, PSEUDO_HEADER_PATH);

  if (!method_sv.empty()) {
    data.owned_method.assign(method_sv.data(), method_sv.size());
  } else {
    auto const mget = const_cast<HTTPHdr *>(request)->method_get();
    if (!mget.empty()) {
      data.owned_method.assign(mget.data(), mget.size());
    }
  }

  if (!scheme_sv.empty()) {
    data.owned_scheme.assign(scheme_sv.data(), scheme_sv.size());
  }
  if (!authority_sv.empty()) {
    data.owned_authority.assign(authority_sv.data(), authority_sv.size());
  }
  if (!path_sv.empty()) {
    data.owned_path.assign(path_sv.data(), path_sv.size());
  }
  data.owned_url = synthesize_request_target(data.owned_method, data.owned_scheme, data.owned_authority, data.owned_path);

  if (protocol_str) {
    data.owned_client_protocol_str = protocol_str;
  }

  ats_ip_copy(&data.owned_client_addr.sa, ssn->get_remote_addr());
  ats_ip_copy(&data.owned_client_src_addr.sa, ssn->get_remote_addr());
  ats_ip_copy(&data.owned_client_dst_addr.sa, ssn->get_local_addr());
  data.m_client_port = ats_ip_port_host_order(ssn->get_remote_addr());

  data.m_connection_id  = ssn->connection_id();
  data.m_transaction_id = get_transaction_id();

  data.m_log_code      = SquidLogCode::ERR_INVALID_REQ;
  data.m_hit_miss_code = SQUID_MISS_NONE;
  data.m_hier_code     = SquidHierarchyCode::NONE;

  ink_hrtime const now                                    = ink_get_hrtime();
  data.owned_milestones[TS_MILESTONE_SM_START]            = now;
  data.owned_milestones[TS_MILESTONE_UA_BEGIN]            = now;
  data.owned_milestones[TS_MILESTONE_UA_FIRST_READ]       = now;
  data.owned_milestones[TS_MILESTONE_UA_READ_HEADER_DONE] = now;
  data.owned_milestones[TS_MILESTONE_SM_FINISH]           = now;

  TransactionLogData log_data(data);
  LogAccess          access(log_data);
  Log::access(&access);
}