- Add MayBlock() method to stream classes which is used as a hint when determining the thread to access the stream from (issue #1187).

- In cases where MayBlock() returns true have CefStreamResourceReader perform the reads on the FILE thread (issue #1187).

git-svn-id: http://chromiumembedded.googlecode.com/svn/trunk/cef3@1582 5089003a-bbd8-11dd-ad1f-f1f9622dbc98

Author: [email protected]

cef.gyp

@@ -399,6 +399,7 @@
         'tests/cefclient/client_app.h',
         'tests/cefclient/client_switches.cpp',
         'tests/cefclient/client_switches.h',
+        'tests/cefclient/resource_util.h',
         'tests/cefclient/res/osr_test.html',
         'tests/unittests/browser_info_map_unittest.cc',
         'tests/unittests/command_line_unittest.cc',
@@ -417,12 +418,12 @@
         'tests/unittests/request_context_unittest.cc',
         'tests/unittests/request_handler_unittest.cc',
         'tests/unittests/request_unittest.cc',
-        'tests/cefclient/resource_util.h',
         'tests/unittests/routing_test_handler.cc',
         'tests/unittests/routing_test_handler.h',
         'tests/unittests/run_all_unittests.cc',
         'tests/unittests/scheme_handler_unittest.cc',
         'tests/unittests/stream_unittest.cc',
+        'tests/unittests/stream_resource_handler_unittest.cc',
         'tests/unittests/string_unittest.cc',
         'tests/unittests/client_app_delegates.cc',
         'tests/unittests/task_unittest.cc',
@@ -920,6 +921,7 @@
         'libcef/browser/download_item_impl.h',
         'libcef/browser/download_manager_delegate.cc',
         'libcef/browser/download_manager_delegate.h',
+        'libcef/browser/file_impl.cc',
         'libcef/browser/frame_host_impl.cc',
         'libcef/browser/frame_host_impl.h',
         'libcef/browser/geolocation_impl.cc',

cef_paths.gypi

@@ -28,6 +28,7 @@
       'include/cef_download_item.h',
       'include/cef_drag_data.h',
       'include/cef_drag_handler.h',
+      'include/cef_file.h',
       'include/cef_focus_handler.h',
       'include/cef_frame.h',
       'include/cef_geolocation.h',
@@ -80,6 +81,7 @@
       'include/capi/cef_download_item_capi.h',
       'include/capi/cef_drag_data_capi.h',
       'include/capi/cef_drag_handler_capi.h',
+      'include/capi/cef_file_capi.h',
       'include/capi/cef_focus_handler_capi.h',
       'include/capi/cef_frame_capi.h',
       'include/capi/cef_geolocation_capi.h',

include/capi/cef_stream_capi.h

@@ -77,6 +77,13 @@ typedef struct _cef_read_handler_t {
   // Return non-zero if at end of file.
   ///
   int (CEF_CALLBACK *eof)(struct _cef_read_handler_t* self);
+
+  ///
+  // Return true (1) if this handler performs work like accessing the file
+  // system which may block. Used as a hint for determining the thread to access
+  // the handler from.
+  ///
+  int (CEF_CALLBACK *may_block)(struct _cef_read_handler_t* self);
 } cef_read_handler_t;
 
 
@@ -112,6 +119,13 @@ typedef struct _cef_stream_reader_t {
   // Return non-zero if at end of file.
   ///
   int (CEF_CALLBACK *eof)(struct _cef_stream_reader_t* self);
+
+  ///
+  // Returns true (1) if this reader performs work like accessing the file
+  // system which may block. Used as a hint for determining the thread to access
+  // the reader from.
+  ///
+  int (CEF_CALLBACK *may_block)(struct _cef_stream_reader_t* self);
 } cef_stream_reader_t;
 
 
@@ -166,6 +180,13 @@ typedef struct _cef_write_handler_t {
   // Flush the stream.
   ///
   int (CEF_CALLBACK *flush)(struct _cef_write_handler_t* self);
+
+  ///
+  // Return true (1) if this handler performs work like accessing the file
+  // system which may block. Used as a hint for determining the thread to access
+  // the handler from.
+  ///
+  int (CEF_CALLBACK *may_block)(struct _cef_write_handler_t* self);
 } cef_write_handler_t;
 
 
@@ -201,6 +222,13 @@ typedef struct _cef_stream_writer_t {
   // Flush the stream.
   ///
   int (CEF_CALLBACK *flush)(struct _cef_stream_writer_t* self);
+
+  ///
+  // Returns true (1) if this writer performs work like accessing the file
+  // system which may block. Used as a hint for determining the thread to access
+  // the writer from.
+  ///
+  int (CEF_CALLBACK *may_block)(struct _cef_stream_writer_t* self);
 } cef_stream_writer_t;
 
 

include/cef_stream.h

@@ -71,6 +71,14 @@ class CefReadHandler : public virtual CefBase {
   ///
   /*--cef()--*/
   virtual int Eof() =0;
+
+  ///
+  // Return true if this handler performs work like accessing the file system
+  // which may block. Used as a hint for determining the thread to access the
+  // handler from.
+  ///
+  /*--cef()--*/
+  virtual bool MayBlock() =0;
 };
 
 
@@ -123,6 +131,14 @@ class CefStreamReader : public virtual CefBase {
   ///
   /*--cef()--*/
   virtual int Eof() =0;
+
+  ///
+  // Returns true if this reader performs work like accessing the file system
+  // which may block. Used as a hint for determining the thread to access the
+  // reader from.
+  ///
+  /*--cef()--*/
+  virtual bool MayBlock() =0;
 };
 
 
@@ -158,6 +174,14 @@ class CefWriteHandler : public virtual CefBase {
   ///
   /*--cef()--*/
   virtual int Flush() =0;
+
+  ///
+  // Return true if this handler performs work like accessing the file system
+  // which may block. Used as a hint for determining the thread to access the
+  // handler from.
+  ///
+  /*--cef()--*/
+  virtual bool MayBlock() =0;
 };
 
 
@@ -205,6 +229,14 @@ class CefStreamWriter : public virtual CefBase {
   ///
   /*--cef()--*/
   virtual int Flush() =0;
+
+  ///
+  // Returns true if this writer performs work like accessing the file system
+  // which may block. Used as a hint for determining the thread to access the
+  // writer from.
+  ///
+  /*--cef()--*/
+  virtual bool MayBlock() =0;
 };
 
 #endif  // CEF_INCLUDE_CEF_STREAM_H_

include/wrapper/cef_byte_read_handler.h

@@ -60,6 +60,7 @@ class CefByteReadHandler : public CefReadHandler {
   virtual int Seek(int64 offset, int whence) OVERRIDE;
   virtual int64 Tell() OVERRIDE;
   virtual int Eof() OVERRIDE;
+  virtual bool MayBlock() OVERRIDE { return false; }
 
  private:
   const unsigned char* bytes_;

include/wrapper/cef_stream_resource_handler.h

@@ -57,11 +57,14 @@ class CefStreamResourceHandler : public CefResourceHandler {
   // Create a new object with explicit response values.
   ///
   CefStreamResourceHandler(int status_code,
+                           const CefString& status_text,
                            const CefString& mime_type,
                            CefResponse::HeaderMap header_map,
                            CefRefPtr<CefStreamReader> stream);
 
-  // CefStreamResourceHandler methods.
+  virtual ~CefStreamResourceHandler();
+
+  // CefResourceHandler methods.
   virtual bool ProcessRequest(CefRefPtr<CefRequest> request,
                               CefRefPtr<CefCallback> callback) OVERRIDE;
   virtual void GetResponseHeaders(CefRefPtr<CefResponse> response,
@@ -74,10 +77,23 @@ class CefStreamResourceHandler : public CefResourceHandler {
   virtual void Cancel() OVERRIDE;
 
  private:
-  int status_code_;
-  CefString mime_type_;
-  CefResponse::HeaderMap header_map_;
-  CefRefPtr<CefStreamReader> stream_;
+  void ReadOnFileThread(int bytes_to_read,
+                        CefRefPtr<CefCallback> callback);
+
+  const int status_code_;
+  const CefString status_text_;
+  const CefString mime_type_;
+  const CefResponse::HeaderMap header_map_;
+  const CefRefPtr<CefStreamReader> stream_;
+  bool read_on_file_thread_;
+
+  class Buffer;
+  Buffer* buffer_;
+#ifndef NDEBUG
+  // Used in debug builds to verify that |buffer_| isn't being accessed on
+  // multiple threads at the same time.
+  bool buffer_owned_by_file_thread_;
+#endif
 
   IMPLEMENT_REFCOUNTING(CefStreamResourceHandler);
 };

libcef/browser/stream_impl.h

@@ -20,6 +20,7 @@ class CefFileReader : public CefStreamReader {
   virtual int Seek(int64 offset, int whence) OVERRIDE;
   virtual int64 Tell() OVERRIDE;
   virtual int Eof() OVERRIDE;
+  virtual bool MayBlock() OVERRIDE { return true; }
 
  protected:
   bool close_;
@@ -39,6 +40,7 @@ class CefFileWriter : public CefStreamWriter {
   virtual int Seek(int64 offset, int whence) OVERRIDE;
   virtual int64 Tell() OVERRIDE;
   virtual int Flush() OVERRIDE;
+  virtual bool MayBlock() OVERRIDE { return true; }
 
  protected:
   FILE* file_;
@@ -58,6 +60,7 @@ class CefBytesReader : public CefStreamReader {
   virtual int Seek(int64 offset, int whence) OVERRIDE;
   virtual int64 Tell() OVERRIDE;
   virtual int Eof() OVERRIDE;
+  virtual bool MayBlock() OVERRIDE { return false; }
 
   void SetData(void* data, int64 datasize, bool copy);
 
@@ -84,6 +87,7 @@ class CefBytesWriter : public CefStreamWriter {
   virtual int Seek(int64 offset, int whence) OVERRIDE;
   virtual int64 Tell() OVERRIDE;
   virtual int Flush() OVERRIDE;
+  virtual bool MayBlock() OVERRIDE { return false; }
 
   void* GetData() { return data_; }
   int64 GetDataSize() { return offset_; }
@@ -119,6 +123,9 @@ class CefHandlerReader : public CefStreamReader {
   virtual int Eof() OVERRIDE {
     return handler_->Eof();
   }
+  virtual bool MayBlock() OVERRIDE {
+    return handler_->MayBlock();
+  }
 
  protected:
   CefRefPtr<CefReadHandler> handler_;
@@ -144,6 +151,9 @@ class CefHandlerWriter : public CefStreamWriter {
   virtual int Flush() OVERRIDE {
     return handler_->Flush();
   }
+  virtual bool MayBlock() OVERRIDE {
+    return handler_->MayBlock();
+  }
 
  protected:
   CefRefPtr<CefWriteHandler> handler_;

libcef_dll/cef_logging.h

@@ -28,6 +28,8 @@
 #endif  // !BUILDING_CEF_SHARED
 
 #define CEF_REQUIRE_UI_THREAD()       DCHECK(CefCurrentlyOn(TID_UI));
+#define CEF_REQUIRE_IO_THREAD()       DCHECK(CefCurrentlyOn(TID_IO));
+#define CEF_REQUIRE_FILE_THREAD()     DCHECK(CefCurrentlyOn(TID_FILE));
 #define CEF_REQUIRE_RENDERER_THREAD() DCHECK(CefCurrentlyOn(TID_RENDERER));
 
 #endif  // CEF_LIBCEF_DLL_CEF_LOGGING_H_

libcef_dll/cpptoc/read_handler_cpptoc.cc

@@ -82,6 +82,20 @@ int CEF_CALLBACK read_handler_eof(struct _cef_read_handler_t* self) {
   return _retval;
 }
 
+int CEF_CALLBACK read_handler_may_block(struct _cef_read_handler_t* self) {
+  // AUTO-GENERATED CONTENT - DELETE THIS COMMENT BEFORE MODIFYING
+
+  DCHECK(self);
+  if (!self)
+    return 0;
+
+  // Execute
+  bool _retval = CefReadHandlerCppToC::Get(self)->MayBlock();
+
+  // Return type: bool
+  return _retval;
+}
+
 
 // CONSTRUCTOR - Do not edit by hand.
 
@@ -91,6 +105,7 @@ CefReadHandlerCppToC::CefReadHandlerCppToC(CefReadHandler* cls)
   struct_.struct_.seek = read_handler_seek;
   struct_.struct_.tell = read_handler_tell;
   struct_.struct_.eof = read_handler_eof;
+  struct_.struct_.may_block = read_handler_may_block;
 }
 
 #ifndef NDEBUG

libcef_dll/cpptoc/stream_reader_cpptoc.cc

@@ -138,6 +138,20 @@ int CEF_CALLBACK stream_reader_eof(struct _cef_stream_reader_t* self) {
   return _retval;
 }
 
+int CEF_CALLBACK stream_reader_may_block(struct _cef_stream_reader_t* self) {
+  // AUTO-GENERATED CONTENT - DELETE THIS COMMENT BEFORE MODIFYING
+
+  DCHECK(self);
+  if (!self)
+    return 0;
+
+  // Execute
+  bool _retval = CefStreamReaderCppToC::Get(self)->MayBlock();
+
+  // Return type: bool
+  return _retval;
+}
+
 
 // CONSTRUCTOR - Do not edit by hand.
 
@@ -148,6 +162,7 @@ CefStreamReaderCppToC::CefStreamReaderCppToC(CefStreamReader* cls)
   struct_.struct_.seek = stream_reader_seek;
   struct_.struct_.tell = stream_reader_tell;
   struct_.struct_.eof = stream_reader_eof;
+  struct_.struct_.may_block = stream_reader_may_block;
 }
 
 #ifndef NDEBUG