Use FILE thread for disk operations in TraceSubscriberStdio

content/browser/trace_subscriber_stdio.cc

 // 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.
 
 #include "content/browser/trace_subscriber_stdio.h"
 
 #include "base/bind.h"
 #include "base/logging.h"
+#include "content/public/browser/browser_thread.h"
 
-TraceSubscriberStdio::TraceSubscriberStdio() : file_(0) {
-}
+namespace content {
 
-TraceSubscriberStdio::TraceSubscriberStdio(const FilePath& path) : file_(0) {
-  OpenFile(path);
+// All method calls on this class should be done on the FILE thread.

[joth, 2012/02/08 13:22:20]

FWIW the new hotness is to use SequencedWorkerPool but given this is 'debug
only' the old school way seems fine to me...

[Iain Merrick, 2012/02/08 14:11:24]

Huh, really? The new hotness needs better advertising! Maybe it should give
AdWords a try.
OK, leaving as is.

+class TraceSubscriberStdioImpl
+    : public base::RefCountedThreadSafe<TraceSubscriberStdioImpl> {
+ public:
+  explicit TraceSubscriberStdioImpl(const FilePath& path)
+      : path_(path),
+        file_(0) {}
+
+  ~TraceSubscriberStdioImpl() {
+    CloseFile();
+  }
+
+  void OnStart() {
+    DCHECK(BrowserThread::CurrentlyOn(BrowserThread::FILE));
+    DCHECK(!file_);
+    file_ = file_util::OpenFile(path_, "w+");
+    if (IsValid()) {
+      LOG(INFO) << "Logging performance trace to file: " << path_.value();
+      trace_buffer_.SetOutputCallback(
+          base::Bind(&TraceSubscriberStdioImpl::Write, this));
+      trace_buffer_.Start();
+    } else {
+      LOG(ERROR) << "Failed to open performance trace file: " << path_.value();
+    }
+  }
+
+  void OnData(const scoped_refptr<base::RefCountedString>& trace_fragment) {
+    trace_buffer_.AddFragment(trace_fragment->data());
+  }
+
+  void OnEnd() {
+    trace_buffer_.Finish();
+    CloseFile();
+  }
+
+ private:
+  bool IsValid() {
+    return file_ && (0 == ferror(file_));
+  }
+
+  void CloseFile() {
+    if (file_) {
+      fclose(file_);
+      file_ = 0;
+    }
+  }
+
+  void Write(const std::string& output_str) {
+    if (IsValid()) {
+      size_t written = fwrite(output_str.data(), 1, output_str.size(), file_);
+      if (written != output_str.size()) {
+        LOG(ERROR) << "Error " << ferror(file_) << " in fwrite() to trace file";
+        CloseFile();
+      }
+    }
+  }
+
+  FilePath path_;
+  FILE* file_;
+  base::debug::TraceResultBuffer trace_buffer_;
+};
+
+TraceSubscriberStdio::TraceSubscriberStdio(const FilePath& path)
+    : impl_(new TraceSubscriberStdioImpl(path)) {
+  BrowserThread::PostTask(BrowserThread::FILE, FROM_HERE, base::Bind(
+      &TraceSubscriberStdioImpl::OnStart, impl_.get()));
 }
 
 TraceSubscriberStdio::~TraceSubscriberStdio() {
-  CloseFile();
-}
-
-bool TraceSubscriberStdio::OpenFile(const FilePath& path) {
-  LOG(INFO) << "Logging performance trace to file: " << path.value();
-  CloseFile();
-  file_ = file_util::OpenFile(path, "w+");
-  if (IsValid()) {
-    trace_buffer_.SetOutputCallback(base::Bind(&TraceSubscriberStdio::Write,
-                                               base::Unretained(this)));
-    trace_buffer_.Start();
-    return true;
-  } else {
-    LOG(ERROR) << "Failed to open performance trace file: " << path.value();
-    return false;
-  }
-}
-
-void TraceSubscriberStdio::CloseFile() {
-  if (file_) {
-    fclose(file_);
-    file_ = 0;
-  }
-}
-
-bool TraceSubscriberStdio::IsValid() {
-  return file_ && (0 == ferror(file_));
+  // This can't be inlined because TraceSubscriberStdioImpl isn't public.

[joth, 2012/02/08 13:22:20]

no need to comment this: it is convention to *always* put d'tor in the cc file
for this amongst other reasons.

[Iain Merrick, 2012/02/08 14:11:24]

Done.

 }
 
 void TraceSubscriberStdio::OnEndTracingComplete() {
-  trace_buffer_.Finish();
-  CloseFile();
+  BrowserThread::PostTask(BrowserThread::FILE, FROM_HERE, base::Bind(

[joth, 2012/02/08 13:22:20]

I think we'd normally break line before bind and then line up its params too.
(and again below)

[Iain Merrick, 2012/02/08 14:11:24]

Done.

+      &TraceSubscriberStdioImpl::OnEnd, impl_.get()));
 }
 
 void TraceSubscriberStdio::OnTraceDataCollected(
-    const std::string& trace_fragment) {
-  trace_buffer_.AddFragment(trace_fragment);
+    const scoped_refptr<base::RefCountedString>& trace_fragment) {
+  BrowserThread::PostTask(BrowserThread::FILE, FROM_HERE, base::Bind(
+      &TraceSubscriberStdioImpl::OnData, impl_.get(), trace_fragment));
 }
 
-void TraceSubscriberStdio::Write(const std::string& output_str) {
-  if (IsValid()) {
-    size_t written = fwrite(output_str.data(), 1, output_str.size(), file_);
-    if (written != output_str.size()) {
-      LOG(ERROR) << "Error " << ferror(file_) << " when writing to trace file";
-      CloseFile();
-    }
-  }
-}
+}  // namespace content