When an idle socket is added back to a socket pool, check for stalled jobs in lower pools

net/socket/client_socket_pool_base.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 //
 // A ClientSocketPoolBase is used to restrict the number of sockets open at
 // a time.  It also maintains a list of idle persistent sockets for reuse.
 // Subclasses of ClientSocketPool should compose ClientSocketPoolBase to handle
 // the core logic of (1) restricting the number of active (connected or
 // connecting) sockets per "group" (generally speaking, the hostname), (2)
 // maintaining a per-group list of idle, persistent sockets for reuse, and (3)
@@ skipping 182 matching lines @@
         const Request& request,
         ConnectJob::Delegate* delegate) const = 0;
 
     virtual base::TimeDelta ConnectionTimeout() const = 0;
 
    private:
     DISALLOW_COPY_AND_ASSIGN(ConnectJobFactory);
   };
 
   ClientSocketPoolBaseHelper(
+      HigherLayeredPool* pool,
       int max_sockets,
       int max_sockets_per_group,
       base::TimeDelta unused_idle_socket_timeout,
       base::TimeDelta used_idle_socket_timeout,
       ConnectJobFactory* connect_job_factory);
 
   virtual ~ClientSocketPoolBaseHelper();
 
-  // Adds/Removes layered pools. It is expected in the destructor that no
-  // layered pools remain.
-  void AddLayeredPool(LayeredPool* pool);
-  void RemoveLayeredPool(LayeredPool* pool);
+  // Adds a lower layered pool to |this|, and adds |pool_| as a higher layered
+  // pool on top of |lower_pool|.
+  void AddLowerLayeredPool(LowerLayeredPool* lower_pool);
+
+  // See LowerLayeredPool::IsStalled for documentation on this function.
+  bool IsStalled() const;
+
+  // See LowerLayeredPool for documentation on these functions. It is expected
+  // in the destructor that no higher layer pools remain.
+  void AddHigherLayeredPool(HigherLayeredPool* higher_pool);
+  void RemoveHigherLayeredPool(HigherLayeredPool* higher_pool);
 
   // See ClientSocketPool::RequestSocket for documentation on this function.
   // ClientSocketPoolBaseHelper takes ownership of |request|, which must be
   // heap allocated.
   int RequestSocket(const std::string& group_name, const Request* request);
 
   // See ClientSocketPool::RequestSocket for documentation on this function.
   void RequestSockets(const std::string& group_name,
                       const Request& request,
                       int num_sockets);
 
   // See ClientSocketPool::CancelRequest for documentation on this function.
   void CancelRequest(const std::string& group_name,
                      ClientSocketHandle* handle);
 
   // See ClientSocketPool::ReleaseSocket for documentation on this function.
   void ReleaseSocket(const std::string& group_name,
                      StreamSocket* socket,
                      int id);
 
   // See ClientSocketPool::FlushWithError for documentation on this function.
   void FlushWithError(int error);
 
-  // See ClientSocketPool::IsStalled for documentation on this function.
-  bool IsStalled() const;
-
   // See ClientSocketPool::CloseIdleSockets for documentation on this function.
   void CloseIdleSockets();
 
   // See ClientSocketPool::IdleSocketCount() for documentation on this function.
   int idle_socket_count() const {
     return idle_socket_count_;
   }
 
   // See ClientSocketPool::IdleSocketCountInGroup() for documentation on this
   // function.
@@ skipping 36 matching lines @@
   // sockets that timed out or can't be reused.  Made public for testing.
   void CleanupIdleSockets(bool force);
 
   // Closes one idle socket.  Picks the first one encountered.
   // TODO(willchan): Consider a better algorithm for doing this.  Perhaps we
   // should keep an ordered list of idle sockets, and close them in order.
   // Requires maintaining more state.  It's not clear if it's worth it since
   // I'm not sure if we hit this situation often.
   bool CloseOneIdleSocket();
 
-  // Checks layered pools to see if they can close an idle connection.
-  bool CloseOneIdleConnectionInLayeredPool();
+  // Checks higher layered pools to see if they can close an idle connection.
+  bool CloseOneIdleConnectionInHigherLayeredPool();
 
   // See ClientSocketPool::GetInfoAsValue for documentation on this function.
   base::DictionaryValue* GetInfoAsValue(const std::string& name,
                                         const std::string& type) const;
 
   base::TimeDelta ConnectionTimeout() const {
     return connect_job_factory_->ConnectionTimeout();
   }
 
   static bool connect_backup_jobs_enabled();
@@ skipping 272 matching lines @@
   const scoped_ptr<ConnectJobFactory> connect_job_factory_;
 
   // TODO(vandebo) Remove when backup jobs move to TransportClientSocketPool
   bool connect_backup_jobs_enabled_;
 
   // A unique id for the pool.  It gets incremented every time we
   // FlushWithError() the pool.  This is so that when sockets get released back
   // to the pool, we can make sure that they are discarded rather than reused.
   int pool_generation_number_;
 
-  std::set<LayeredPool*> higher_layer_pools_;
+  // Used to add |this| as a higher layer pool on top of lower layer pools.  May
+  // be NULL if no lower layer pools will be added.
+  HigherLayeredPool* pool_;
+
+  // Pools that create connections through |this|.  |this| will Try to close
+  // their idle sockets when it stalls.  Must be empty on destruction.
+  std::set<HigherLayeredPool*> higher_pools_;
+
+  // Pools that this goes through.  Typically there's only one, but not always.
+  // |this| will check if they're stalled when it has a new idle socket.  |this|
+  // will remove itself from all lower layered pools on destruction.
+  std::set<LowerLayeredPool*> lower_pools_;
 
   base::WeakPtrFactory<ClientSocketPoolBaseHelper> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(ClientSocketPoolBaseHelper);
 };
 
 }  // namespace internal
 
 template <typename SocketParams>
 class ClientSocketPoolBase {
@@ skipping 33 matching lines @@
     DISALLOW_COPY_AND_ASSIGN(ConnectJobFactory);
   };
 
   // |max_sockets| is the maximum number of sockets to be maintained by this
   // ClientSocketPool.  |max_sockets_per_group| specifies the maximum number of
   // sockets a "group" can have.  |unused_idle_socket_timeout| specifies how
   // long to leave an unused idle socket open before closing it.
   // |used_idle_socket_timeout| specifies how long to leave a previously used
   // idle socket open before closing it.
   ClientSocketPoolBase(
+      HigherLayeredPool* self,
       int max_sockets,
       int max_sockets_per_group,
       ClientSocketPoolHistograms* histograms,
       base::TimeDelta unused_idle_socket_timeout,
       base::TimeDelta used_idle_socket_timeout,
       ConnectJobFactory* connect_job_factory)
       : histograms_(histograms),
-        helper_(max_sockets, max_sockets_per_group,
+        helper_(self, max_sockets, max_sockets_per_group,
                 unused_idle_socket_timeout, used_idle_socket_timeout,
                 new ConnectJobFactoryAdaptor(connect_job_factory)) {}
 
   virtual ~ClientSocketPoolBase() {}
 
   // These member functions simply forward to ClientSocketPoolBaseHelper.
-  void AddLayeredPool(LayeredPool* pool) {
-    helper_.AddLayeredPool(pool);
+  void AddLowerLayeredPool(LowerLayeredPool* lower_pool) {
+    helper_.AddLowerLayeredPool(lower_pool);
   }
 
-  void RemoveLayeredPool(LayeredPool* pool) {
-    helper_.RemoveLayeredPool(pool);
+  void AddHigherLayeredPool(HigherLayeredPool* higher_pool) {
+    helper_.AddHigherLayeredPool(higher_pool);
+  }
+
+  void RemoveHigherLayeredPool(HigherLayeredPool* higher_pool) {
+    helper_.RemoveHigherLayeredPool(higher_pool);
   }
 
   // RequestSocket bundles up the parameters into a Request and then forwards to
   // ClientSocketPoolBaseHelper::RequestSocket().
   int RequestSocket(const std::string& group_name,
                     const scoped_refptr<SocketParams>& params,
                     RequestPriority priority,
                     ClientSocketHandle* handle,
                     const CompletionCallback& callback,
                     const BoundNetLog& net_log) {
@@ skipping 83 matching lines @@
   }
 
   ClientSocketPoolHistograms* histograms() const {
     return histograms_;
   }
 
   void EnableConnectBackupJobs() { helper_.EnableConnectBackupJobs(); }
 
   bool CloseOneIdleSocket() { return helper_.CloseOneIdleSocket(); }
 
-  bool CloseOneIdleConnectionInLayeredPool() {
-    return helper_.CloseOneIdleConnectionInLayeredPool();
+  bool CloseOneIdleConnectionInHigherLayeredPool() {
+    return helper_.CloseOneIdleConnectionInHigherLayeredPool();
   }
 
  private:
   // This adaptor class exists to bridge the
   // internal::ClientSocketPoolBaseHelper::ConnectJobFactory and
   // ClientSocketPoolBase::ConnectJobFactory types, allowing clients to use the
   // typesafe ClientSocketPoolBase::ConnectJobFactory, rather than having to
   // static_cast themselves.
   class ConnectJobFactoryAdaptor
       : public internal::ClientSocketPoolBaseHelper::ConnectJobFactory {
@@ skipping 24 matching lines @@
   // Histograms for the pool
   ClientSocketPoolHistograms* const histograms_;
   internal::ClientSocketPoolBaseHelper helper_;
 
   DISALLOW_COPY_AND_ASSIGN(ClientSocketPoolBase);
 };
 
 }  // namespace net
 
 #endif  // NET_SOCKET_CLIENT_SOCKET_POOL_BASE_H_