Dispatch IndexedDB IPC messages to worker threads

content/renderer/indexed_db_dispatcher.h

 // Copyright (c) 2011 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_RENDERER_INDEXED_DB_DISPATCHER_H_
 #define CONTENT_RENDERER_INDEXED_DB_DISPATCHER_H_
 #pragma once
 
 #include <map>
 #include <vector>
 
 #include "base/id_map.h"
 #include "base/nullable_string16.h"
-#include "ipc/ipc_channel.h"
+#include "base/threading/thread_local.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebExceptionCode.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebIDBCallbacks.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebIDBDatabase.h"
+#include "third_party/WebKit/Source/WebKit/chromium/public/WebIDBDatabaseCallbacks.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebIDBObjectStore.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebIDBTransactionCallbacks.h"
+#include "webkit/glue/worker_task_runner.h"
 
 class IndexedDBKey;
+struct IndexedDBMsg_CallbacksSuccessCursorContinue_Params;
+struct IndexedDBMsg_CallbacksSuccessCursorPrefetch_Params;
+struct IndexedDBMsg_CallbacksSuccessIDBCursor_Params;
 class RendererWebIDBCursorImpl;
 
+namespace IPC {
+class Message;
+}
+
 namespace WebKit {
 class WebFrame;
 class WebIDBKeyRange;
 class WebIDBTransaction;
 }
 
 namespace content {
 class SerializedScriptValue;
 }
 
 // Handle the indexed db related communication for this entire renderer.

[michaeln, 2011/12/14 02:15:53]

comment might be misleading now that there are thread-specific instances of this
class

[dgrogan, 2011/12/15 02:47:44]

Updated.

-class IndexedDBDispatcher : public IPC::Channel::Listener {
+class IndexedDBDispatcher : public webkit_glue::WorkerTaskRunner::Observer {
  public:
-  IndexedDBDispatcher();
   virtual ~IndexedDBDispatcher();
+  static void Init();
+  // This returns the dispatcher associated with the current WebWorkerRunLoop,

[michaeln, 2011/12/14 02:15:53]

The comment is a little misleading since it will also create and return the
'main' thread's instance. I see how worker instances are deleted (via the
stopped notification) but how is the main thread's instance deleted? Maybe
something (ChildThread?) should own that ptr and explicitly delete it.

[dgrogan, 2011/12/15 02:47:44]

Renaming Instance to ThreadSpecificInstance should obviate the need for the
comment.

I made RenderThreadImpl own the main thread's dispatcher.

+  // if being run from a worker.
+  static IndexedDBDispatcher* Instance();

[michaeln, 2011/12/14 02:15:53]

maybe name this as ThreadSpecificInstance() for clarity?

[dgrogan, 2011/12/15 02:47:44]

Done.

 
-  // IPC::Channel::Listener implementation.
-  virtual bool OnMessageReceived(const IPC::Message& msg) OVERRIDE;
+  // webkit_glue::WorkerTaskRunner::Observer implementation.
+  virtual void OnWorkerRunLoopStopped();
+
+  void OnMessageReceived(const IPC::Message& msg);
   void Send(IPC::Message* msg);
 
   void RequestIDBFactoryGetDatabaseNames(
       WebKit::WebIDBCallbacks* callbacks,
       const string16& origin,
       WebKit::WebFrame* web_frame);
 
   void RequestIDBFactoryOpen(
       const string16& name,
       WebKit::WebIDBCallbacks* callbacks,
@@ skipping 110 matching lines @@
 
   void RegisterWebIDBTransactionCallbacks(
       WebKit::WebIDBTransactionCallbacks* callbacks,
       int32 id);
 
   void CursorDestroyed(int32 cursor_id);
 
   static int32 TransactionId(const WebKit::WebIDBTransaction& transaction);
 
  private:
+  IndexedDBDispatcher();
   // IDBCallback message handlers.
   void OnSuccessNull(int32 response_id);
-  void OnSuccessIDBDatabase(int32 response_id, int32 object_id);
-  void OnSuccessIndexedDBKey(int32 response_id, const IndexedDBKey& key);
-  void OnSuccessIDBTransaction(int32 response_id, int32 object_id);
-  void OnSuccessOpenCursor(int32 response_id, int32 object_id,
-                           const IndexedDBKey& key,
-                           const IndexedDBKey& primary_key,
-                           const content::SerializedScriptValue& value);
-  void OnSuccessCursorContinue(int32 response_id,
-                               int32 cursor_id,
-                               const IndexedDBKey& key,
-                               const IndexedDBKey& primary_key,
-                               const content::SerializedScriptValue& value);
+  void OnSuccessIDBDatabase(int32 thread_id,
+                            int32 response_id,
+                            int32 object_id);
+  void OnSuccessIndexedDBKey(int32 thread_id,
+                             int32 response_id,
+                             const IndexedDBKey& key);
+  void OnSuccessIDBTransaction(int32 thread_id,
+                               int32 response_id,
+                               int32 object_id);
+  void OnSuccessOpenCursor(
+      const IndexedDBMsg_CallbacksSuccessIDBCursor_Params& p);
+  void OnSuccessCursorContinue(
+      const IndexedDBMsg_CallbacksSuccessCursorContinue_Params& p);
   void OnSuccessCursorPrefetch(
-      int32 response_id,
-      int32 cursor_id,
-      const std::vector<IndexedDBKey>& keys,
-      const std::vector<IndexedDBKey>& primary_keys,
-      const std::vector<content::SerializedScriptValue>& values);
-  void OnSuccessStringList(int32 response_id,
+      const IndexedDBMsg_CallbacksSuccessCursorPrefetch_Params& p);
+  void OnSuccessStringList(int32 thread_id,
+                           int32 response_id,
                            const std::vector<string16>& value);
   void OnSuccessSerializedScriptValue(
+      int32 thread_id,
       int32 response_id,
       const content::SerializedScriptValue& value);
-  void OnError(int32 response_id, int code, const string16& message);
-  void OnBlocked(int32 response_id);
-  void OnAbort(int32 transaction_id);
-  void OnComplete(int32 transaction_id);
-  void OnVersionChange(int32 database_id, const string16& newVersion);
+  void OnError(int32 thread_id,
+               int32 response_id,
+               int code,
+               const string16& message);
+  void OnBlocked(int32 thread_id, int32 response_id);
+  void OnAbort(int32 thread_id, int32 transaction_id);
+  void OnComplete(int32 thread_id, int32 transaction_id);
+  void OnVersionChange(int32 thread_id,
+                       int32 database_id,
+                       const string16& newVersion);
 
   // Reset cursor prefetch caches for all cursors except exception_cursor_id.
   void ResetCursorPrefetchCaches(int32 exception_cursor_id = -1);
 
   // Careful! WebIDBCallbacks wraps non-threadsafe data types. It must be
   // destroyed and used on the same thread it was created on.
   IDMap<WebKit::WebIDBCallbacks, IDMapOwnPointer> pending_callbacks_;
   IDMap<WebKit::WebIDBTransactionCallbacks, IDMapOwnPointer>
       pending_transaction_callbacks_;
   IDMap<WebKit::WebIDBDatabaseCallbacks, IDMapOwnPointer>
       pending_database_callbacks_;
 
   // Map from cursor id to RendererWebIDBCursorImpl.
   std::map<int32, RendererWebIDBCursorImpl*> cursors_;
 
+  static base::ThreadLocalPointer<IndexedDBDispatcher>* idb_dispatcher_tls_;
+
   DISALLOW_COPY_AND_ASSIGN(IndexedDBDispatcher);
 };
 
 #endif  // CONTENT_RENDERER_INDEXED_DB_DISPATCHER_H_