Add a ResourceScheduler to ResourceDispatcherHost.

content/browser/renderer_host/resource_scheduler.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.
+
+#ifndef CONTENT_BROWSER_RENDERER_HOST_RESOURCE_SCHEDULER_H_
+#define CONTENT_BROWSER_RENDERER_HOST_RESOURCE_SCHEDULER_H_
+
+#include <map>
+#include <set>
+#include <vector>
+
+#include "base/basictypes.h"
+#include "base/compiler_specific.h"
+#include "base/memory/linked_ptr.h"
+#include "content/common/content_export.h"
+#include "content/public/browser/global_request_id.h"
+
+namespace content {
+class ResourceLoader;
+
+// There is one ResourceScheduler, which is owned by the ResourceDispatcherHost.
+//
+// These are sources of input to the scheduler:
+// 1. Requests to load, cancel, or finish resources from the
+//    ResourceDispatcherHost.
+// 2. Notifications of renderer events from the ResourceSchedulerFilter.
+//
+// The ResourceScheduler tracks many Clients, which should correlate with tabs.
+// A client is uniquely identified by its child_id and route_id.
+//
+// Each Client may have many Requests in flight. Requests are uniquely
+// identified within a Client by their request_ids.
+//
+// The ResourceDispatcherHost should call ScheduleLoad() when it's ready to
+// load a request. The returned LoadHandle should be destroyed when the load
+// finishes or is canceled.
+//
+// The scheduling behavior mimicks WebKit's scheduler, which blocks fetching
+// low priority resources until the first paint has occurred. One exception is
+// if the client is not fetching anything else, low priority fetching begins
+// immediately.
+class CONTENT_EXPORT_PRIVATE ResourceScheduler {
+ public:
+  typedef int64 ClientId;
+
+  // A LoadHandle is returned to the ResourceDispatcherHost. When the host
+  // deletes the handle, it's automatically removed from ResourceScheduler's
+  // state.
+  class LoadHandle {
+   public:
+    virtual ~LoadHandle() {}
+    virtual linked_ptr<ResourceLoader>& loader() = 0;
+  };
+
+  ResourceScheduler();
+  ~ResourceScheduler();
+
+  // Called when the ResourceDispatcherHost is ready to load a resource.
+  // Caller should delete the returned handle when the load completes or is
+  // canceled.
+  LoadHandle* ScheduleLoad(int child_id,

[willchan no longer on Chromium, 2012/11/21 09:04:30]

Perhaps return a scoped_ptr<LoadHandle> to convey who owns this?

[James Simonsen, 2012/11/27 02:20:51]

Done.

+                           int route_id,
+                           int request_id,
+                           const linked_ptr<ResourceLoader>& loader);
+
+  // These events are triggered by ViewHostMsgs.
+
+  // Called when a new client is created.
+  void OnCreate(int child_id, int route_id);
+
+  // Called when a client navigates to a new main document.
+  void OnNavigate(int child_id, int route_id);
+
+  // Called any time a client paints.
+  void OnPaint(int child_id, int route_id);
+
+  // Called when a client is destroyed.
+  void OnDestroy(int child_id, int route_id);
+
+ private:
+  friend class ScheduledLoadHandle;
+  struct Client;
+  struct Request;
+
+  typedef std::vector<Request> RequestQueue;
+  typedef std::set<int> RequestIdSet;
+  typedef std::map<ClientId, Client*> ClientMap;
+
+  struct Request {
+    int request_id;
+    ResourceLoader* loader;
+  };
+
+  struct Client {
+    Client();
+
+    bool has_painted;
+    bool closed;
+    RequestQueue pending_requests;
+    RequestIdSet in_flight_requests;
+  };
+
+  // A load that must be managed by the ResourceScheduler.
+  class ScheduledLoadHandle : public LoadHandle {

[willchan no longer on Chromium, 2012/11/21 09:04:30]

Move these subclasses to the .cc file to keep the header file clean.

[James Simonsen, 2012/11/27 02:20:51]

Done.

+   public:
+    ScheduledLoadHandle(ClientId client_id,
+                        int request_id,
+                        const linked_ptr<ResourceLoader>& loader,
+                        ResourceScheduler* scheduler);
+    virtual ~ScheduledLoadHandle();
+
+    virtual linked_ptr<ResourceLoader>& loader() OVERRIDE { return loader_; }

[willchan no longer on Chromium, 2012/11/21 09:04:30]

no returning non-const references. probably best just to copy the linked_ptr.

[James Simonsen, 2012/11/27 02:20:51]

Done.

+
+   private:
+    ClientId client_id_;
+    int request_id_;
+    linked_ptr<ResourceLoader> loader_;
+    ResourceScheduler* scheduler_;
+  };
+
+  // A load that fires immediately and is ignored by the ResourceScheduler.

[willchan no longer on Chromium, 2012/11/21 09:04:30]

I think this class shouldn't exist and we should just use ScheduledLoadHandle. I
think in the future we may want to schedule it. For example, for mobile, there's
no reason to wake up the radio just to send this silly thing. We should enable
scheduling of "background" requests in the future. I guess it could be argued
that this should be done in the network stack proper though. Let me go to sleep
and think about it tomorrow.

[James Simonsen, 2012/11/27 02:20:51]

Good point. I prefer to handle the "background" requests here instead of the
network layer. You could imagine a user loading several windows in parallel.
ResourceScheduler is in the best position to determine that and throttle the
background requests.

+  class UnscheduledLoadHandle : public LoadHandle {
+   public:
+    UnscheduledLoadHandle(const linked_ptr<ResourceLoader>& loader);
+    virtual ~UnscheduledLoadHandle();
+
+    virtual linked_ptr<ResourceLoader>& loader() OVERRIDE { return loader_; }
+
+   private:
+    linked_ptr<ResourceLoader> loader_;
+  };
+
+  // Called when a ScheduledLoadHandle is destroyed.
+  void RemoveLoad(ClientId client_id, int request_id);
+
+  // Kicks off the loader for |request| and adds it to |client|.
+  void StartRequest(Request request, Client* client);
+
+  // Calls StartRequest on all pending requests for |client|.
+  void LoadPendingRequests(Client* client);
+
+  ClientMap client_map_;
+};
+
+}  // namespace content
+
+#endif  // CONTENT_BROWSER_RENDERER_HOST_RESOURCE_SCHEDULER_H_