net/quic/quic_session_pool.h

// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef NET_QUIC_QUIC_SESSION_POOL_H_
#define NET_QUIC_QUIC_SESSION_POOL_H_

#include <stddef.h>
#include <stdint.h>

#include <map>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <vector>

#include "base/containers/lru_cache.h"
#include "base/containers/unique_ptr_adapters.h"
#include "base/gtest_prod_util.h"
#include "base/memory/memory_pressure_monitor.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/scoped_refptr.h"
#include "base/memory/weak_ptr.h"
#include "base/task/sequenced_task_runner.h"
#include "base/time/default_clock.h"
#include "base/time/default_tick_clock.h"
#include "base/time/tick_clock.h"
#include "base/time/time.h"
#include "base/values.h"
#include "net/base/address_list.h"
#include "net/base/completion_once_callback.h"
#include "net/base/connection_endpoint_metadata.h"
#include "net/base/host_port_pair.h"
#include "net/base/http_user_agent_settings.h"
#include "net/base/ip_endpoint.h"
#include "net/base/net_export.h"
#include "net/base/network_change_notifier.h"
#include "net/base/network_handle.h"
#include "net/base/proxy_chain.h"
#include "net/base/proxy_server.h"
#include "net/base/reconnect_notifier.h"
#include "net/base/session_usage.h"
#include "net/cert/cert_database.h"
#include "net/dns/public/secure_dns_policy.h"
#include "net/http/http_server_properties.h"
#include "net/http/http_stream_factory.h"
#include "net/log/net_log_with_source.h"
#include "net/quic/network_connection.h"
#include "net/quic/quic_chromium_client_session.h"
#include "net/quic/quic_clock_skew_detector.h"
#include "net/quic/quic_connectivity_monitor.h"
#include "net/quic/quic_context.h"
#include "net/quic/quic_crypto_client_config_handle.h"
#include "net/quic/quic_proxy_datagram_client_socket.h"
#include "net/quic/quic_session_alias_key.h"
#include "net/quic/quic_session_attempt.h"
#include "net/quic/quic_session_key.h"
#include "net/socket/client_socket_pool.h"
#include "net/spdy/multiplexed_session_creation_initiator.h"
#include "net/ssl/ssl_config_service.h"
#include "net/third_party/quiche/src/quiche/quic/core/crypto/quic_client_session_cache.h"
#include "net/third_party/quiche/src/quiche/quic/core/deterministic_connection_id_generator.h"
#include "net/third_party/quiche/src/quiche/quic/core/quic_config.h"
#include "net/third_party/quiche/src/quiche/quic/core/quic_connection_id.h"
#include "net/third_party/quiche/src/quiche/quic/core/quic_crypto_stream.h"
#include "net/third_party/quiche/src/quiche/quic/core/quic_packets.h"
#include "net/third_party/quiche/src/quiche/quic/core/quic_server_id.h"
#include "net/third_party/quiche/src/quiche/quic/core/quic_versions.h"
#include "url/scheme_host_port.h"

namespace base {
class Value;
}  // namespace base

namespace quic {
class QuicAlarmFactory;
class QuicClock;
}  // namespace quic

namespace quiche {
class QuicRandom;
}  // namespace quiche

namespace net {

class CertVerifier;
class ClientSocketFactory;
class HostResolver;
class HttpServerProperties;
class NetLog;
class NetworkAnonymizationKey;
struct NetworkTrafficAnnotationTag;
class ProxyDelegate;
class QuicChromiumConnectionHelper;
class QuicCryptoClientStreamFactory;
class QuicServerInfo;
class QuicSessionPool;
class QuicContext;
class SCTAuditingDelegate;
class SocketPerformanceWatcherFactory;
class SocketTag;
class TransportSecurityState;

namespace test {
class QuicSessionPoolPeer;
}  // namespace test

// Maximum number of not currently in use QuicCryptoClientConfig that can be
// stored in |recent_crypto_config_map_|.
//
// TODO(mmenke): Should figure out a reasonable value of this, using field
// trials. The optimal value may increase over time, as QUIC becomes more
// prevalent. Whether or not NetworkAnonymizationKeys end up including subframe
// URLs will also influence the ideal value.
const int kMaxRecentCryptoConfigs = 100;

enum QuicPlatformNotification {
  NETWORK_CONNECTED,
  NETWORK_MADE_DEFAULT,
  NETWORK_DISCONNECTED,
  NETWORK_SOON_TO_DISCONNECT,
  NETWORK_IP_ADDRESS_CHANGED,
  NETWORK_NOTIFICATION_MAX
};

enum AllActiveSessionsGoingAwayReason {
  kClockSkewDetected,
  kIPAddressChanged,
  kCertDBChanged,
  kCertVerifierChanged
};

enum CreateSessionFailure {
  CREATION_ERROR_CONNECTING_SOCKET,
  CREATION_ERROR_SETTING_RECEIVE_BUFFER,
  CREATION_ERROR_SETTING_SEND_BUFFER,
  CREATION_ERROR_SETTING_DO_NOT_FRAGMENT,
  CREATION_ERROR_SETTING_RECEIVE_ECN,
  CREATION_ERROR_MAX
};

// Encapsulates a pending request for a QuicChromiumClientSession.
// If the request is still pending when it is destroyed, it will
// cancel the request with the pool.
class NET_EXPORT_PRIVATE QuicSessionRequest {
 public:
  explicit QuicSessionRequest(QuicSessionPool* pool);

  QuicSessionRequest(const QuicSessionRequest&) = delete;
  QuicSessionRequest& operator=(const QuicSessionRequest&) = delete;

  ~QuicSessionRequest();

  // `cert_verify_flags` is bitwise OR'd of CertVerifier::VerifyFlags and it is
  // passed to CertVerifier::Verify.
  // `destination` will be resolved and resulting IPEndPoint used to open a
  // quic::QuicConnection.  This can be different than
  // HostPortPair::FromURL(url).
  // When `session_usage` is `kDestination`, any DNS aliases found in host
  // resolution are stored in the `dns_aliases_by_session_key_` map.
  int Request(url::SchemeHostPort destination,
              quic::ParsedQuicVersion quic_version,
              const ProxyChain& proxy_chain,
              std::optional<NetworkTrafficAnnotationTag> proxy_annotation_tag,
              const HttpUserAgentSettings* http_user_agent_settings,
              SessionUsage session_usage,
              PrivacyMode privacy_mode,
              RequestPriority priority,
              const SocketTag& socket_tag,
              const NetworkAnonymizationKey& network_anonymization_key,
              SecureDnsPolicy secure_dns_policy,
              bool require_dns_https_alpn,
              int cert_verify_flags,
              const GURL& url,
              const NetLogWithSource& net_log,
              NetErrorDetails* net_error_details,
              MultiplexedSessionCreationInitiator session_creation_initiator,
              std::optional<ConnectionManagementConfig> management_config,
              CompletionOnceCallback failed_on_default_network_callback,
              CompletionOnceCallback callback);

  // This function must be called after Request() returns ERR_IO_PENDING.
  // Returns true if Request() requires host resolution and it hasn't completed
  // yet. If true is returned, |callback| will run when host resolution
  // completes. It will be called with the result after host resolution during
  // the connection process. For example, if host resolution returns OK and then
  // crypto handshake returns ERR_IO_PENDING, then |callback| will run with
  // ERR_IO_PENDING.
  bool WaitForHostResolution(CompletionOnceCallback callback);

  // This function must be called after Request() returns ERR_IO_PENDING.
  // Returns true if no QUIC session has been created yet. If true is returned,
  // `callback` will be run when the QUIC session has been created and will be
  // called with the result of OnCreateSessionComplete. For example, if session
  // creation returned OK but CryptoConnect returns ERR_IO_PENDING then
  // `callback` will be run with ERR_IO_PENDING.
  bool WaitForQuicSessionCreation(CompletionOnceCallback callback);

  // QuicSessionPool::Jobs may notify associated requests at two points in the
  // connection process before completion: host resolution and session creation.
  // The `Expect` methods below inform the request whether it should expect
  // these notifications.

  // Tells QuicSessionRequest that `QuicSessionPool::Job` will call
  // `OnHostResolutionComplete()` in the future. Must be called before
  // `WaitForHostResolution()`
  void ExpectOnHostResolution();

  // Will be called by the associated `QuicSessionPool::Job` when host
  // resolution completes asynchronously after Request(), if
  // `ExpectOnHostResolution()` was called. This is called after the Job can
  // make no further progress, and includes the result of that progress, perhaps
  // `ERR_IO_PENDING`.
  void OnHostResolutionComplete(int rv,
                                base::TimeTicks dns_resolution_start_time,
                                base::TimeTicks dns_resolution_end_time);

  // Tells QuicSessionRequest that `QuicSessionPool::Job` will call
  // `OnQuicSessionCreationComplete()` in the future. Must be called before
  // `WaitForQuicSessionCreation()`.
  void ExpectQuicSessionCreation();

  // Will be called by the associated `QuicSessionPool::Job` when session
  // creation completes asynchronously after Request(), if
  // `ExpectQuicSessionCreation` was called.
  void OnQuicSessionCreationComplete(int rv);

  void OnRequestComplete(int rv);

  // Called when the original connection created on the default network for
  // |this| fails and a new connection has been created on the alternate
  // network.
  void OnConnectionFailedOnDefaultNetwork();

  // Helper method that calls |pool_|'s GetTimeDelayForWaitingJob(). It
  // returns the amount of time waiting job should be delayed.
  base::TimeDelta GetTimeDelayForWaitingJob() const;

  // If host resolution is underway, changes the priority of the host resolver
  // request.
  void SetPriority(RequestPriority priority);

  // Releases the handle to the QUIC session retrieved as a result of Request().
  std::unique_ptr<QuicChromiumClientSession::Handle> ReleaseSessionHandle();

  // Sets |session_|.
  void SetSession(std::unique_ptr<QuicChromiumClientSession::Handle> session);

  NetErrorDetails* net_error_details() { return net_error_details_; }

  const QuicSessionKey& session_key() const { return session_key_; }

  const NetLogWithSource& net_log() const { return net_log_; }

  base::TimeTicks dns_resolution_start_time() const {
    return dns_resolution_start_time_;
  }
  base::TimeTicks dns_resolution_end_time() const {
    return dns_resolution_end_time_;
  }

  // Checks that the request is only added to, and removed from, a job once.
  // See https://crbug.com/404586727.
  void AddedToJob() {
    CHECK(!added_to_job_) << "Request was already added to a job once";
    added_to_job_ = true;
  }

  // Checks that the request is only added to, and removed from, a job once.
  // See https://crbug.com/404586727.
  void RemovedFromJob() {
    CHECK(added_to_job_) << "Request was never added to a job";
    CHECK(!removed_from_job_) << "Request was already removed from a job";
    removed_from_job_ = true;
  }

 private:
  raw_ptr<QuicSessionPool> pool_;
  QuicSessionKey session_key_;
  NetLogWithSource net_log_;
  CompletionOnceCallback callback_;
  CompletionOnceCallback failed_on_default_network_callback_;
  raw_ptr<NetErrorDetails> net_error_details_;  // Unowned.
  std::unique_ptr<QuicChromiumClientSession::Handle> session_;
  bool added_to_job_ = false;
  bool removed_from_job_ = false;

  base::TimeTicks dns_resolution_start_time_;
  base::TimeTicks dns_resolution_end_time_;

  // Set in Request(). If true, then OnHostResolutionComplete() is expected to
  // be called in the future.
  bool expect_on_host_resolution_ = false;

  bool expect_on_quic_session_creation_ = false;
  // Callback passed to WaitForHostResolution().
  CompletionOnceCallback host_resolution_callback_;

  CompletionOnceCallback create_session_callback_;
};

// Represents a single QUIC endpoint and the information necessary to attempt
// a QUIC session.
struct NET_EXPORT_PRIVATE QuicEndpoint {
  QuicEndpoint(quic::ParsedQuicVersion quic_version,
               IPEndPoint ip_endpoint,
               ConnectionEndpointMetadata metadata);
  ~QuicEndpoint();

  quic::ParsedQuicVersion quic_version = quic::ParsedQuicVersion::Unsupported();
  IPEndPoint ip_endpoint;
  ConnectionEndpointMetadata metadata;

  base::Value::Dict ToValue() const;
};

// Manages a pool of QuicChromiumClientSessions.
class NET_EXPORT_PRIVATE QuicSessionPool
    : public NetworkChangeNotifier::IPAddressObserver,
      public NetworkChangeNotifier::NetworkObserver,
      public CertDatabase::Observer,
      public CertVerifier::Observer {
 public:
  QuicSessionPool(
      NetLog* net_log,
      HostResolver* host_resolver,
      SSLConfigService* ssl_config_service,
      ClientSocketFactory* client_socket_factory,
      HttpServerProperties* http_server_properties,
      CertVerifier* cert_verifier,
      TransportSecurityState* transport_security_state,
      ProxyDelegate* proxy_delegate,
      SCTAuditingDelegate* sct_auditing_delegate,
      SocketPerformanceWatcherFactory* socket_performance_watcher_factory,
      QuicCryptoClientStreamFactory* quic_crypto_client_stream_factory,
      QuicContext* context);

  QuicSessionPool(const QuicSessionPool&) = delete;
  QuicSessionPool& operator=(const QuicSessionPool&) = delete;

  ~QuicSessionPool() override;

  // Returns true if there is an existing session for |session_key| or if the
  // request can be pooled to an existing session to the IP address of
  // |destination|.
  bool CanUseExistingSession(const QuicSessionKey& session_key,
                             const url::SchemeHostPort& destination) const;

  // Returns a session for `session_key` or if the request can be pooled to an
  // existing session to the IP address of `destination`.
  QuicChromiumClientSession* FindExistingSession(
      const QuicSessionKey& session_key,
      const url::SchemeHostPort& destination) const;

  // Returns a session when an existing session can be used for `destination`
  // that is resolved with `service_endpoint`.
  QuicChromiumClientSession* HasMatchingIpSessionForServiceEndpoint(
      const QuicSessionAliasKey& session_alias_key,
      const ServiceEndpoint& service_endpoint,
      const std::set<std::string>& dns_aliases,
      bool use_dns_aliases);

  // Requests a QuicChromiumClientSession to |host_port_pair|, a handle for
  // which will be owned by |request|.
  // If a matching session already exists, this method will return OK.  If no
  // matching session exists, this will return ERR_IO_PENDING and will invoke
  // OnRequestComplete asynchronously.
  // When |use_dns_aliases| is true, any DNS aliases found in host resolution
  // are stored in the |dns_aliases_by_session_key_| map. |use_dns_aliases|
  // should be false in the case of a proxy.
  // When the `proxy_chain` in the session key is not direct,
  // `proxy_annotation_tag` must be set.
  // This method is virtual to facilitate mocking for tests.
  virtual int RequestSession(
      const QuicSessionKey& session_key,
      url::SchemeHostPort destination,
      quic::ParsedQuicVersion quic_version,
      std::optional<NetworkTrafficAnnotationTag> proxy_annotation_tag,
      MultiplexedSessionCreationInitiator session_creation_initiator,
      std::optional<ConnectionManagementConfig> management_config,
      const HttpUserAgentSettings* http_user_agent_settings,
      RequestPriority priority,
      bool use_dns_aliases,
      int cert_verify_flags,
      const GURL& url,
      const NetLogWithSource& net_log,
      QuicSessionRequest* request);

  // Creates a session attempt for `session_key` with `quic_endpoint`. There
  // should be no matching session for `session_key`. This doesn't support
  // proxies.
  // *NOTE*: This method must not be used simultaneously with
  //         QuicSessionRequest for the same `session_key`.
  std::unique_ptr<QuicSessionAttempt> CreateSessionAttempt(
      QuicSessionAttempt::Delegate* delegate,
      const QuicSessionKey& session_key,
      QuicEndpoint quic_endpoint,
      int cert_verify_flags,
      base::TimeTicks dns_resolution_start_time,
      base::TimeTicks dns_resolution_end_time,
      bool use_dns_aliases,
      std::set<std::string> dns_aliases,
      MultiplexedSessionCreationInitiator session_creation_initiator,
      std::optional<ConnectionManagementConfig> connection_management_config);

  // Called by a session when it is going away and no more streams should be
  // created on it.
  void OnSessionGoingAway(QuicChromiumClientSession* session);

  // Called by a session after it shuts down.
  void OnSessionClosed(QuicChromiumClientSession* session);

  // Called by a session when it blackholes after the handshake is confirmed.
  void OnBlackholeAfterHandshakeConfirmed(QuicChromiumClientSession* session);

  // Cancels a pending request. Does nothing if the request is not active.
  // This method is virtual to facilitate mocking for tests.
  virtual void CancelRequest(QuicSessionRequest* request);

  // Sets priority of a request.
  void SetRequestPriority(QuicSessionRequest* request,
                          RequestPriority priority);

  // Closes all current sessions with specified network, QUIC error codes.
  // It sends connection close packet when closing connections.
  void CloseAllSessions(int error, quic::QuicErrorCode quic_error);

  base::Value QuicSessionPoolInfoToValue() const;

  // Delete cached state objects in |crypto_config_|. If |origin_filter| is not
  // null, only objects on matching origins will be deleted.
  void ClearCachedStatesInCryptoConfig(
      const base::RepeatingCallback<bool(const GURL&)>& origin_filter);

  // Helper method that connects a DatagramClientSocket. Socket is
  // bound to the default network if the |network| param is
  // handles::kInvalidNetworkHandle. This method calls
  // DatagramClientSocket::ConnectAsync and always completes asynchronously,
  // implicitly returning ERR_IO_PENDING.
  void ConnectAndConfigureSocket(CompletionOnceCallback callback,
                                 DatagramClientSocket* socket,
                                 IPEndPoint addr,
                                 handles::NetworkHandle network,
                                 const SocketTag& socket_tag);

  // Helper method that configures a DatagramClientSocket once
  // DatagramClientSocket::ConnectAsync completes. Posts a task to run
  // `callback` with a net_error code.
  // This method is virtual to facilitate mocking for tests.
  virtual void FinishConnectAndConfigureSocket(CompletionOnceCallback callback,
                                               DatagramClientSocket* socket,
                                               const SocketTag& socket_tag,
                                               int rv);

  void OnFinishConnectAndConfigureSocketError(CompletionOnceCallback callback,
                                              enum CreateSessionFailure error,
                                              int rv);

  void DoCallback(CompletionOnceCallback callback, int rv);

  // Helper method that configures a DatagramClientSocket. Socket is
  // bound to the default network if the |network| param is
  // handles::kInvalidNetworkHandle. This method calls
  // DatagramClientSocket::Connect and completes synchronously. Returns
  // net_error code.
  // TODO(liza): Remove this once QuicSessionPool::Job calls
  // ConnectAndConfigureSocket.
  int ConfigureSocket(DatagramClientSocket* socket,
                      IPEndPoint addr,
                      handles::NetworkHandle network,
                      const SocketTag& socket_tag);

  // Finds an alternative to |old_network| from the platform's list of connected
  // networks. Returns handles::kInvalidNetworkHandle if no
  // alternative is found.
  handles::NetworkHandle FindAlternateNetwork(
      handles::NetworkHandle old_network);

  // Creates a datagram socket. |source| is the NetLogSource for the entity
  // trying to create the socket, if it has one.
  std::unique_ptr<DatagramClientSocket> CreateSocket(
      NetLog* net_log,
      const NetLogSource& source);

  // NetworkChangeNotifier::IPAddressObserver methods:

  // Until the servers support roaming, close all connections when the local
  // IP address changes.
  void OnIPAddressChanged() override;

  // NetworkChangeNotifier::NetworkObserver methods:
  void OnNetworkConnected(handles::NetworkHandle network) override;
  void OnNetworkDisconnected(handles::NetworkHandle network) override;
  void OnNetworkSoonToDisconnect(handles::NetworkHandle network) override;
  void OnNetworkMadeDefault(handles::NetworkHandle network) override;

  // CertDatabase::Observer methods:

  // We close all sessions when certificate database is changed.
  void OnTrustStoreChanged() override;

  // CertVerifier::Observer:
  // We close all sessions when certificate verifier settings have changed.
  void OnCertVerifierChanged() override;

  bool has_quic_ever_worked_on_current_network() const {
    return has_quic_ever_worked_on_current_network_;
  }

  bool allow_server_migration() const { return params_.allow_server_migration; }

  // Returns true is gQUIC 0-RTT is disabled from quic_context.
  bool gquic_zero_rtt_disabled() const {
    return params_.disable_gquic_zero_rtt;
  }

  void set_has_quic_ever_worked_on_current_network(
      bool has_quic_ever_worked_on_current_network);

  // It returns the amount of time waiting job should be delayed.
  base::TimeDelta GetTimeDelayForWaitingJob(const QuicSessionKey& session_key);

  QuicChromiumConnectionHelper* helper() { return helper_.get(); }

  quic::QuicAlarmFactory* alarm_factory() { return alarm_factory_.get(); }

  handles::NetworkHandle default_network() const { return default_network_; }

  // Returns the stored DNS aliases for the session key.
  const std::set<std::string>& GetDnsAliasesForSessionKey(
      const QuicSessionKey& key) const;

  int CountActiveSessions() { return active_sessions_.size(); }

  // Inject a QUIC session for testing various edge cases.
  void ActivateSessionForTesting(
      std::unique_ptr<QuicChromiumClientSession> new_session);

  void DeactivateSessionForTesting(QuicChromiumClientSession* session);

  // Set a time delay for waiting job for testing.
  void SetTimeDelayForWaitingJobForTesting(base::TimeDelta delay);

  // Returns the QUIC version that would be used with an endpoint associated
  // with `metadata`, or `quic::ParsedQuicVersion::Unsupported()` if the
  // endpoint cannot be used with QUIC.
  quic::ParsedQuicVersion SelectQuicVersion(
      const quic::ParsedQuicVersion& known_quic_version,
      const ConnectionEndpointMetadata& metadata,
      bool svcb_optional) const;

  struct QuicCryptoClientConfigKey;

 private:
  class Job;
  class DirectJob;
  class ProxyJob;
  class QuicCryptoClientConfigOwner;
  class CryptoClientConfigHandle;
  friend class QuicSessionAttempt;
  friend class MockQuicSessionPool;
  friend class test::QuicSessionPoolPeer;

  using SessionMap =
      std::map<QuicSessionKey,
               raw_ptr<QuicChromiumClientSession, CtnExperimental>>;
  using SessionIdSet = std::set<std::unique_ptr<QuicChromiumClientSession>,
                                base::UniquePtrComparator>;
  using AliasSet = std::set<QuicSessionAliasKey>;
  using SessionAliasMap = std::map<QuicChromiumClientSession*, AliasSet>;
  using SessionSet =
      std::set<raw_ptr<QuicChromiumClientSession, SetExperimental>>;
  using IPAliasMap = std::map<IPEndPoint, SessionSet>;
  using SessionPeerIPMap = std::map<QuicChromiumClientSession*, IPEndPoint>;
  using JobMap = std::map<QuicSessionKey, std::unique_ptr<Job>>;
  using DnsAliasesBySessionKeyMap =
      std::map<QuicSessionKey, std::set<std::string>>;
  using QuicCryptoClientConfigMap =
      std::map<QuicCryptoClientConfigKey,
               std::unique_ptr<QuicCryptoClientConfigOwner>>;

  // Records whether an active session already exists for a given IP address
  // during connection.
  static void LogConnectionIpPooling(bool pooled);

  QuicChromiumClientSession* HasMatchingIpSession(
      const QuicSessionAliasKey& key,
      const std::vector<IPEndPoint>& ip_endpoints,
      const std::set<std::string>& aliases,
      bool use_dns_aliases);
  // Returns true if IP matching can be waived when trying to send requests to
  // |destination| on |session|.
  bool CanWaiveIpMatching(const url::SchemeHostPort& destination,
                          QuicChromiumClientSession* session) const;
  void OnJobComplete(Job* job,
                     std::optional<base::TimeTicks> proxy_connect_start_time,
                     int rv);
  bool HasActiveSession(const QuicSessionKey& session_key) const;
  bool HasActiveJob(const QuicSessionKey& session_key) const;

  // Methods to notify the ConnectionChangeObserver about connection changing
  // events. `NotifyOnNetworkEvent` will notify all of the notifiers on network
  // change events, since it affects all the connections. Otherwise, the events
  // are specific to each connection.
  void NotifyOnNetworkEvent(net::NetworkChangeEvent event);
  void NotifyOnSessionClosed(const QuicSessionKey& session_key) const;
  void NotifyOnConnectionFailure(const QuicSessionKey& session_key) const;

  // Returns whether we have an existing session to the same server id as
  // `session_key`. This is used to determine whether we have an existing
  // session to the host but with different `QuicSessionKey`.
  std::optional<QuicSessionKey> GetActiveSessionToServerId(
      const QuicSessionKey& session_key) const;

  // Returns whether we have an active job to the same server id as
  // `session_key`. This is used to determine whether we have an in-flight
  // attempt to the host but with different `QuicSessionKey`
  std::optional<QuicSessionKey> GetActiveJobToServerId(
      const QuicSessionKey& session_key) const;

  int CreateSessionSync(
      QuicSessionAliasKey key,
      quic::ParsedQuicVersion quic_version,
      int cert_verify_flags,
      bool require_confirmation,
      IPEndPoint peer_address,
      ConnectionEndpointMetadata metadata,
      base::TimeTicks dns_resolution_start_time,
      base::TimeTicks dns_resolution_end_time,
      const NetLogWithSource& net_log,
      raw_ptr<QuicChromiumClientSession>* session,
      handles::NetworkHandle* network,
      MultiplexedSessionCreationInitiator preconnet_origin,
      std::optional<ConnectionManagementConfig> connection_management_config);
  // Note: QUIC session create methods that complete asynchronously, we can't
  // pass raw pointers as parameters because we can't guarantee that these raw
  // pointers outlive `this` since we use nested callbacks in these methods. See
  // the commit description of crrev.com/c/5858326.
  using CreateSessionCallback = base::OnceCallback<void(
      base::expected<QuicSessionAttempt::CreateSessionResult, int>)>;
  int CreateSessionAsync(
      CreateSessionCallback callback,
      QuicSessionAliasKey key,
      quic::ParsedQuicVersion quic_version,
      int cert_verify_flags,
      bool require_confirmation,
      IPEndPoint peer_address,
      ConnectionEndpointMetadata metadata,
      base::TimeTicks dns_resolution_start_time,
      base::TimeTicks dns_resolution_end_time,
      const NetLogWithSource& net_log,
      handles::NetworkHandle network,
      MultiplexedSessionCreationInitiator session_creation_initiator,
      std::optional<ConnectionManagementConfig> connection_management_config);
  int CreateSessionOnProxyStream(
      CreateSessionCallback callback,
      QuicSessionAliasKey key,
      quic::ParsedQuicVersion quic_version,
      int cert_verify_flags,
      bool require_confirmation,
      IPEndPoint local_address,
      IPEndPoint proxy_peer_address,
      std::unique_ptr<QuicChromiumClientStream::Handle> proxy_stream,
      std::string user_agent,
      const NetLogWithSource& net_log,
      handles::NetworkHandle network);
  void FinishCreateSession(
      CreateSessionCallback callback,
      QuicSessionAliasKey key,
      quic::ParsedQuicVersion quic_version,
      int cert_verify_flags,
      bool require_confirmation,
      IPEndPoint peer_address,
      ConnectionEndpointMetadata metadata,
      base::TimeTicks dns_resolution_start_time,
      base::TimeTicks dns_resolution_end_time,
      quic::QuicPacketLength session_max_packet_length,
      const NetLogWithSource& net_log,
      handles::NetworkHandle network,
      std::unique_ptr<DatagramClientSocket> socket,
      MultiplexedSessionCreationInitiator session_creation_initiator,
      std::optional<ConnectionManagementConfig> connection_management_config,
      int rv);
  base::expected<QuicSessionAttempt::CreateSessionResult, int>
  CreateSessionHelper(
      QuicSessionAliasKey key,
      quic::ParsedQuicVersion quic_version,
      int cert_verify_flags,
      bool require_confirmation,
      IPEndPoint peer_address,
      ConnectionEndpointMetadata metadata,
      base::TimeTicks dns_resolution_start_time,
      base::TimeTicks dns_resolution_end_time,
      quic::QuicPacketLength session_max_packet_length,
      const NetLogWithSource& net_log,
      handles::NetworkHandle network,
      std::unique_ptr<DatagramClientSocket> socket,
      MultiplexedSessionCreationInitiator session_creation_initiator,
      std::optional<ConnectionManagementConfig> connection_management_config);

  // Called when the Job for the given key has created and confirmed a session.
  void ActivateSession(const QuicSessionAliasKey& key,
                       QuicChromiumClientSession* session,
                       std::set<std::string> dns_aliases);

  // Go away all active sessions. May disable session's connectivity monitoring
  // based on the |reason|.
  void MarkAllActiveSessionsGoingAway(AllActiveSessionsGoingAwayReason reason);

  void ConfigureInitialRttEstimate(
      const quic::QuicServerId& server_id,
      const NetworkAnonymizationKey& network_anonymization_key,
      quic::QuicConfig* config);

  // Returns |srtt| in micro seconds from ServerNetworkStats. Returns 0 if there
  // is no |http_server_properties_| or if |http_server_properties_| doesn't
  // have ServerNetworkStats for the given |server_id|.
  int64_t GetServerNetworkStatsSmoothedRttInMicroseconds(
      const quic::QuicServerId& server_id,
      const NetworkAnonymizationKey& network_anonymization_key) const;

  // Returns |srtt| from ServerNetworkStats. Returns null if there
  // is no |http_server_properties_| or if |http_server_properties_| doesn't
  // have ServerNetworkStats for the given |server_id|.
  const base::TimeDelta* GetServerNetworkStatsSmoothedRtt(
      const quic::QuicServerId& server_id,
      const NetworkAnonymizationKey& network_anonymization_key) const;

  // Helper methods.
  bool WasQuicRecentlyBroken(const QuicSessionKey& session_key) const;

  // Helper method to initialize the following migration options and check
  // pre-requisites:
  // - |params_.migrate_sessions_on_network_change_v2|
  // - |params_.migrate_sessions_early_v2|
  // - |params_.migrate_idle_sessions|
  // - |params_.retry_on_alternate_network_before_handshake|
  // If pre-requisites are not met, turn off the corresponding options.
  void InitializeMigrationOptions();

  // Initializes the cached state associated with |server_id| in
  // |crypto_config_| with the information in |server_info|.
  void InitializeCachedStateInCryptoConfig(
      const CryptoClientConfigHandle& crypto_config_handle,
      const quic::QuicServerId& server_id,
      const std::unique_ptr<QuicServerInfo>& server_info);

  void ProcessGoingAwaySession(QuicChromiumClientSession* session,
                               const quic::QuicServerId& server_id,
                               bool was_session_active);

  // Insert the session to `active_sessions_`, and insert the given alias `key`
  // in the AliasSet for the given `session` in the map `session_aliases_`, and
  // add the given `dns_aliases` for `key.session_key()` in
  // `dns_aliases_by_session_key_`.
  void ActivateAndMapSessionToAliasKey(QuicChromiumClientSession* session,
                                       QuicSessionAliasKey key,
                                       std::set<std::string> dns_aliases);

  // For all alias keys for `session` in `session_aliases_`, erase the
  // corresponding DNS aliases in `dns_aliases_by_session_key_`. Then erase
  // `session` from `session_aliases_`.
  void UnmapSessionFromSessionAliases(QuicChromiumClientSession* session);

  // Creates a CreateCryptoConfigHandle for the specified
  // NetworkAnonymizationKey. If there's already a corresponding entry in
  // |active_crypto_config_map_|, reuses it. If there's a corresponding entry in
  // |recent_crypto_config_map_|, promotes it to |active_crypto_config_map_| and
  // then reuses it. Otherwise, creates a new entry in
  // |active_crypto_config_map_|.
  std::unique_ptr<CryptoClientConfigHandle> CreateCryptoConfigHandle(
      QuicCryptoClientConfigKey key);

  // Salled when the indicated member of |active_crypto_config_map_| has no
  // outstanding references. The QuicCryptoClientConfigOwner is then moved to
  // |recent_crypto_config_map_|, an MRU cache.
  void OnAllCryptoClientRefReleased(
      QuicCryptoClientConfigMap::iterator& map_iterator);

  // Called when a network change happens.
  // Collect platform notification metrics, and if the change affects the
  // original default network interface, collect connectivity degradation
  // metrics from |connectivity_monitor_| and add to histograms.
  void CollectDataOnPlatformNotification(
      enum QuicPlatformNotification notification,
      handles::NetworkHandle affected_network) const;

  std::unique_ptr<QuicCryptoClientConfigHandle> GetCryptoConfigForTesting(
      QuicCryptoClientConfigKey key);

  bool CryptoConfigCacheIsEmptyForTesting(const quic::QuicServerId& server_id,
                                          QuicCryptoClientConfigKey key);

  const quic::ParsedQuicVersionVector& supported_versions() const {
    return params_.supported_versions;
  }

  void CheckQuicSessionKeyMismatch(const QuicSessionKey& session_key,
                                   url::SchemeHostPort destination) const;

  // Whether QUIC is known to have ever worked on current network. This is true
  // when QUIC is expected to work in general, rather than whether QUIC was
  // broken / recently broken when used with a particular server. That
  // information is stored in the broken alternative service map in
  // HttpServerProperties.
  bool has_quic_ever_worked_on_current_network_ = false;

  NetLogWithSource net_log_;
  const raw_ptr<HostResolver> host_resolver_;
  const raw_ptr<ClientSocketFactory> client_socket_factory_;
  const raw_ptr<HttpServerProperties> http_server_properties_;
  const raw_ptr<CertVerifier> cert_verifier_;
  const raw_ptr<TransportSecurityState> transport_security_state_;
  const raw_ptr<ProxyDelegate> proxy_delegate_;
  const raw_ptr<SCTAuditingDelegate> sct_auditing_delegate_;
  const raw_ptr<QuicCryptoClientStreamFactory>
      quic_crypto_client_stream_factory_;
  const raw_ptr<quic::QuicRandom> random_generator_;  // Unowned.
  const raw_ptr<const quic::QuicClock> clock_;        // Unowned.
  QuicParams params_;
  QuicClockSkewDetector clock_skew_detector_;

  // Factory which is used to create socket performance watcher. A new watcher
  // is created for every QUIC connection.
  // |socket_performance_watcher_factory_| may be null.
  const raw_ptr<SocketPerformanceWatcherFactory>
      socket_performance_watcher_factory_;

  // The helper used for all connections.
  std::unique_ptr<QuicChromiumConnectionHelper> helper_;

  // The alarm factory used for all connections.
  std::unique_ptr<quic::QuicAlarmFactory> alarm_factory_;

  // Contains owning pointers to all sessions that currently exist.
  SessionIdSet all_sessions_;
  // Contains non-owning pointers to currently active session
  // (not going away session, once they're implemented).
  SessionMap active_sessions_;
  // Map from session to set of aliases that this session is known by.
  SessionAliasMap session_aliases_;
  // Map from IP address to sessions which are connected to this address.
  IPAliasMap ip_aliases_;
  // Map from session to its original peer IP address.
  SessionPeerIPMap session_peer_ip_;

  // Origins which have gone away recently.
  AliasSet gone_away_aliases_;

  // A map of DNS alias vectors by session keys.
  DnsAliasesBySessionKeyMap dns_aliases_by_session_key_;

  // When a QuicCryptoClientConfig is in use, it has one or more live
  // CryptoClientConfigHandles, and is stored in |active_crypto_config_map_|.
  // Once all the handles are deleted, it's moved to
  // |recent_crypto_config_map_|. If reused before it is evicted from LRUCache,
  // it will be removed from the cache and return to the active config map.
  // These two maps should never both have entries with the same
  // NetworkAnonymizationKey.
  QuicCryptoClientConfigMap active_crypto_config_map_;
  base::LRUCache<QuicCryptoClientConfigKey,
                 std::unique_ptr<QuicCryptoClientConfigOwner>>
      recent_crypto_config_map_;

  const quic::QuicConfig config_;

  JobMap active_jobs_;

  // PING timeout for connections.
  quic::QuicTime::Delta ping_timeout_;
  quic::QuicTime::Delta reduced_ping_timeout_;

  // Timeout for how long the wire can have no retransmittable packets.
  quic::QuicTime::Delta retransmittable_on_wire_timeout_;

  // If more than |yield_after_packets_| packets have been read or more than
  // |yield_after_duration_| time has passed, then
  // QuicChromiumPacketReader::StartReading() yields by doing a PostTask().
  int yield_after_packets_;
  quic::QuicTime::Delta yield_after_duration_;

  // If |migrate_sessions_early_v2_| is true, tracks the current default
  // network, and is updated OnNetworkMadeDefault.
  // Otherwise, always set to NetworkChangeNotifier::kInvalidNetwork.
  handles::NetworkHandle default_network_;

  // Local address of socket that was created in CreateSession.
  IPEndPoint local_address_;
  // True if we need to check HttpServerProperties if QUIC was supported last
  // time.
  bool need_to_check_persisted_supports_quic_ = true;
  bool prefer_aes_gcm_recorded_ = false;

  NetworkConnection network_connection_;

  QuicConnectivityMonitor connectivity_monitor_;

  scoped_refptr<base::SequencedTaskRunner> task_runner_ = nullptr;

  std::map<QuicSessionKey, std::unique_ptr<ConnectionChangeNotifier>>
      connection_change_notifier_;

  // This needs to be below `task_runner_`, since in some tests, it often points
  // to a TickClock owned by the TestMockTimeTaskRunner that `task_runner_`
  // owners a reference to.
  raw_ptr<const base::TickClock> tick_clock_ = nullptr;

  const raw_ptr<SSLConfigService> ssl_config_service_;

  // Whether NetworkAnonymizationKeys should be used for
  // `active_crypto_config_map_`. If false, there will just be one config with
  // an empty NetworkAnonymizationKey. Whether QuicSessionAliasKeys all have an
  // empty NAK is based on whether socket pools are respecting NAKs, but whether
  // those NAKs are also used when accessing `active_crypto_config_map_` is also
  // gated this, which is set based on whether HttpServerProperties is
  // respecting NAKs, as that data is fed into the crypto config map using the
  // corresponding NAK.
  const bool use_network_anonymization_key_for_crypto_configs_;

  // If true, skip DNS resolution for a hostname if the ORIGIN frame received on
  // an active session encompasses that hostname.
  const bool skip_dns_with_origin_frame_;

  // If true, a request will be sent on the existing session iff the hostname
  // matches the certificate presented during the handshake.
  const bool ignore_ip_matching_when_finding_existing_sessions_;

  quic::DeterministicConnectionIdGenerator connection_id_generator_{
      quic::kQuicDefaultConnectionIdLength};

  std::optional<base::TimeDelta> time_delay_for_waiting_job_for_testing_;

  base::WeakPtrFactory<QuicSessionPool> weak_factory_{this};
};

// Refcounted class that owns quic::QuicCryptoClientConfig and tracks how many
// consumers are using it currently. When the last reference is freed, the
// QuicCryptoClientConfigHandle informs the owning QuicSessionPool, moves it
// into an MRU cache.
class QuicSessionPool::QuicCryptoClientConfigOwner {
 public:
  QuicCryptoClientConfigOwner(
      std::unique_ptr<quic::ProofVerifier> proof_verifier,
      std::unique_ptr<quic::QuicClientSessionCache> session_cache,
      QuicSessionPool* quic_session_pool);

  QuicCryptoClientConfigOwner(const QuicCryptoClientConfigOwner&) = delete;
  QuicCryptoClientConfigOwner& operator=(const QuicCryptoClientConfigOwner&) =
      delete;

  ~QuicCryptoClientConfigOwner();

  quic::QuicCryptoClientConfig* config() { return &config_; }

  int num_refs() const { return num_refs_; }

  QuicSessionPool* quic_session_pool() { return quic_session_pool_; }

  void OnMemoryPressure(
      base::MemoryPressureListener::MemoryPressureLevel memory_pressure_level);

 private:
  friend class CryptoClientConfigHandle;

  // Simple ref counting. Not using scoped_refptr allows for both keeping around
  // an MRU cache of 0-reference objects, and DCHECKing that there are no
  // outstanding referenced QuicCryptoClientConfigOwner on destruction. Private
  // so that only CryptoClientConfigHandle can add and remove refs.

  void AddRef() { num_refs_++; }

  void ReleaseRef() {
    DCHECK_GT(num_refs_, 0);
    num_refs_--;
  }

  int num_refs_ = 0;
  quic::QuicCryptoClientConfig config_;
  raw_ptr<base::Clock> clock_;
  std::unique_ptr<base::MemoryPressureListener> memory_pressure_listener_;
  const raw_ptr<QuicSessionPool> quic_session_pool_;
};

// Key for QuicCryptoClienConfigOwners within a session pool.k
struct NET_EXPORT_PRIVATE QuicSessionPool::QuicCryptoClientConfigKey {
  QuicCryptoClientConfigKey() = default;
  explicit QuicCryptoClientConfigKey(const QuicSessionKey& session_key)
      : network_anonymization_key(session_key.network_anonymization_key()),
        proxy_chain(session_key.proxy_chain()),
        session_usage(session_key.session_usage()) {}
  explicit QuicCryptoClientConfigKey(const NetworkAnonymizationKey& nak)
      : network_anonymization_key(nak) {}

  bool operator==(const QuicCryptoClientConfigKey& other) const;
  bool operator<(const QuicCryptoClientConfigKey& other) const;

  NetworkAnonymizationKey network_anonymization_key;
  ProxyChain proxy_chain = ProxyChain::Direct();
  SessionUsage session_usage = SessionUsage::kDestination;

 private:
  std::tuple<const NetworkAnonymizationKey&,
             const ProxyChain&,
             const SessionUsage&>
  Tie() const;
};

// Class that owns a reference to a QuicCryptoClientConfigOwner. Handles
// incrementing the refcount on construction, and decrementing it on
// destruction.
class QuicSessionPool::CryptoClientConfigHandle
    : public QuicCryptoClientConfigHandle {
 public:
  explicit CryptoClientConfigHandle(
      const QuicCryptoClientConfigMap::iterator& map_iterator);

  CryptoClientConfigHandle(const CryptoClientConfigHandle& other)
      : CryptoClientConfigHandle(other.map_iterator_) {}

  CryptoClientConfigHandle& operator=(const CryptoClientConfigHandle&) = delete;

  ~CryptoClientConfigHandle() override;

  quic::QuicCryptoClientConfig* GetConfig() const override;

 private:
  QuicCryptoClientConfigMap::iterator map_iterator_;
};

}  // namespace net

#endif  // NET_QUIC_QUIC_SESSION_POOL_H_