Add granular file tracing.

base/files/file_win.cc

 // 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.
 
 #include "base/files/file.h"
 
 #include <io.h>
 
-#include "base/files/file_path.h"
 #include "base/logging.h"
 #include "base/metrics/sparse_histogram.h"
 #include "base/threading/thread_restrictions.h"
+#include "base/trace_event/trace_event.h"
 
 namespace base {
 
 // Make sure our Whence mappings match the system headers.
 COMPILE_ASSERT(File::FROM_BEGIN   == FILE_BEGIN &&
                File::FROM_CURRENT == FILE_CURRENT &&
                File::FROM_END     == FILE_END, whence_matches_system);
 
 bool File::IsValid() const {
   return file_.IsValid();
 }
 
 PlatformFile File::GetPlatformFile() const {
   return file_.Get();
 }
 
 PlatformFile File::TakePlatformFile() {
   return file_.Take();
 }
 
 void File::Close() {
-  if (file_.IsValid()) {
-    ThreadRestrictions::AssertIOAllowed();
-    file_.Close();
-  }
+  if (!file_.IsValid())
+    return;
+
+  ThreadRestrictions::AssertIOAllowed();
+  TRACE_EVENT_NESTABLE_ASYNC0(kTraceGroup, "base::File::Close", this);
+  file_.Close();
 }
 
 int64 File::Seek(Whence whence, int64 offset) {
   ThreadRestrictions::AssertIOAllowed();
   DCHECK(IsValid());
 
+  TRACE_EVENT_NESTABLE_ASYNC1(kTraceGroup, "base::File::Seek", this,
+      "path", unsafe_path_.AsUTF8Unsafe());
+
   LARGE_INTEGER distance, res;
   distance.QuadPart = offset;
   DWORD move_method = static_cast<DWORD>(whence);
   if (!SetFilePointerEx(file_.Get(), distance, &res, move_method))
     return -1;
   return res.QuadPart;
 }
 
 int File::Read(int64 offset, char* data, int size) {
   ThreadRestrictions::AssertIOAllowed();
   DCHECK(IsValid());
   DCHECK(!async_);
   if (size < 0)
     return -1;
 
+  TRACE_EVENT_NESTABLE_ASYNC2(kTraceGroup, "base::File::Read", this,
+      "path", unsafe_path_.AsUTF8Unsafe(), "size", size);
+
   LARGE_INTEGER offset_li;
   offset_li.QuadPart = offset;
 
   OVERLAPPED overlapped = {0};
   overlapped.Offset = offset_li.LowPart;
   overlapped.OffsetHigh = offset_li.HighPart;
 
   DWORD bytes_read;
   if (::ReadFile(file_.Get(), data, size, &bytes_read, &overlapped))
     return bytes_read;
   if (ERROR_HANDLE_EOF == GetLastError())
     return 0;
 
   return -1;
 }
 
 int File::ReadAtCurrentPos(char* data, int size) {
   ThreadRestrictions::AssertIOAllowed();
   DCHECK(IsValid());
   DCHECK(!async_);
   if (size < 0)
     return -1;
 
+  TRACE_EVENT_NESTABLE_ASYNC2(kTraceGroup, "base::File::ReadAtCurrentPos", this,
+      "path", unsafe_path_.AsUTF8Unsafe(), "size", size);
+
   DWORD bytes_read;
   if (::ReadFile(file_.Get(), data, size, &bytes_read, NULL))
     return bytes_read;
   if (ERROR_HANDLE_EOF == GetLastError())
     return 0;
 
   return -1;
 }
 
 int File::ReadNoBestEffort(int64 offset, char* data, int size) {
+  // TODO(dbeam): trace this separately?
   return Read(offset, data, size);
 }
 
 int File::ReadAtCurrentPosNoBestEffort(char* data, int size) {
+  // TODO(dbeam): trace this separately?
   return ReadAtCurrentPos(data, size);
 }
 
 int File::Write(int64 offset, const char* data, int size) {
   ThreadRestrictions::AssertIOAllowed();
   DCHECK(IsValid());
   DCHECK(!async_);
 
+  TRACE_EVENT_NESTABLE_ASYNC2(kTraceGroup, "base::File::Write", this,
+      "path", unsafe_path_.AsUTF8Unsafe(), "size", size);
+
   LARGE_INTEGER offset_li;
   offset_li.QuadPart = offset;
 
   OVERLAPPED overlapped = {0};
   overlapped.Offset = offset_li.LowPart;
   overlapped.OffsetHigh = offset_li.HighPart;
 
   DWORD bytes_written;
   if (::WriteFile(file_.Get(), data, size, &bytes_written, &overlapped))
     return bytes_written;
 
   return -1;
 }
 
 int File::WriteAtCurrentPos(const char* data, int size) {
   ThreadRestrictions::AssertIOAllowed();
   DCHECK(IsValid());
   DCHECK(!async_);
   if (size < 0)
     return -1;
 
+  TRACE_EVENT_NESTABLE_ASYNC2(
+      kTraceGroup, "base::File::WriteAtCurrentPos", this,
+      "path", unsafe_path_.AsUTF8Unsafe(), "size", size);
+
   DWORD bytes_written;
   if (::WriteFile(file_.Get(), data, size, &bytes_written, NULL))
     return bytes_written;
 
   return -1;
 }
 
 int File::WriteAtCurrentPosNoBestEffort(const char* data, int size) {
   return WriteAtCurrentPos(data, size);
 }
 
 int64 File::GetLength() {
   ThreadRestrictions::AssertIOAllowed();
   DCHECK(IsValid());
+
+  TRACE_EVENT_NESTABLE_ASYNC1(kTraceGroup, "base::File::GetLength", this,
+      "path", unsafe_path_.AsUTF8Unsafe());
+
   LARGE_INTEGER size;
   if (!::GetFileSizeEx(file_.Get(), &size))
     return -1;
 
   return static_cast<int64>(size.QuadPart);
 }
 
 bool File::SetLength(int64 length) {
   ThreadRestrictions::AssertIOAllowed();
   DCHECK(IsValid());
 
+  TRACE_EVENT_NESTABLE_ASYNC2(kTraceGroup, "base::File::SetLength", this,
+      "path", unsafe_path_.AsUTF8Unsafe(), "length", length);
+
   // Get the current file pointer.
   LARGE_INTEGER file_pointer;
   LARGE_INTEGER zero;
   zero.QuadPart = 0;
   if (!::SetFilePointerEx(file_.Get(), zero, &file_pointer, FILE_CURRENT))
     return false;
 
   LARGE_INTEGER length_li;
   length_li.QuadPart = length;
   // If length > file size, SetFilePointerEx() should extend the file
   // with zeroes on all Windows standard file systems (NTFS, FATxx).
   if (!::SetFilePointerEx(file_.Get(), length_li, NULL, FILE_BEGIN))
     return false;
 
   // Set the new file length and move the file pointer to its old position.
   // This is consistent with ftruncate()'s behavior, even when the file
   // pointer points to a location beyond the end of the file.
   // TODO(rvargas): Emulating ftruncate details seem suspicious and it is not
   // promised by the interface (nor was promised by PlatformFile). See if this
   // implementation detail can be removed.
   return ((::SetEndOfFile(file_.Get()) != FALSE) &&
           (::SetFilePointerEx(file_.Get(), file_pointer, NULL, FILE_BEGIN) !=
            FALSE));
 }
 
+bool File::Flush() {
+  ThreadRestrictions::AssertIOAllowed();
+  DCHECK(IsValid());
+
+  TRACE_EVENT_NESTABLE_ASYNC1(kTraceGroup, "base::File::Flush", this,
+      "path", unsafe_path_.AsUTF8Unsafe());
+  return ::FlushFileBuffers(file_.Get()) != FALSE;
+}
+
 bool File::SetTimes(Time last_access_time, Time last_modified_time) {
   ThreadRestrictions::AssertIOAllowed();
   DCHECK(IsValid());
 
+  TRACE_EVENT_NESTABLE_ASYNC1(kTraceGroup, "base::File::SetTimes", this,
+      "path", unsafe_path_.AsUTF8Unsafe());
+
   FILETIME last_access_filetime = last_access_time.ToFileTime();
   FILETIME last_modified_filetime = last_modified_time.ToFileTime();
   return (::SetFileTime(file_.Get(), NULL, &last_access_filetime,
                         &last_modified_filetime) != FALSE);
 }
 
 bool File::GetInfo(Info* info) {
   ThreadRestrictions::AssertIOAllowed();
   DCHECK(IsValid());
 
+  TRACE_EVENT_NESTABLE_ASYNC1(kTraceGroup, "base::File::GetInfo", this,
+      "path", unsafe_path_.AsUTF8Unsafe());
+
   BY_HANDLE_FILE_INFORMATION file_info;
   if (!GetFileInformationByHandle(file_.Get(), &file_info))
     return false;
 
   LARGE_INTEGER size;
   size.HighPart = file_info.nFileSizeHigh;
   size.LowPart = file_info.nFileSizeLow;
   info->size = size.QuadPart;
   info->is_directory =
       (file_info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) != 0;
   info->is_symbolic_link = false;  // Windows doesn't have symbolic links.
   info->last_modified = Time::FromFileTime(file_info.ftLastWriteTime);
   info->last_accessed = Time::FromFileTime(file_info.ftLastAccessTime);
   info->creation_time = Time::FromFileTime(file_info.ftCreationTime);
   return true;
 }
 
 File::Error File::Lock() {
   DCHECK(IsValid());
+
+  TRACE_EVENT_NESTABLE_ASYNC1(kTraceGroup, "base::File::Lock", this,
+      "path", unsafe_path_.AsUTF8Unsafe());
+
   BOOL result = LockFile(file_.Get(), 0, 0, MAXDWORD, MAXDWORD);
   if (!result)
     return OSErrorToFileError(GetLastError());
   return FILE_OK;
 }
 
 File::Error File::Unlock() {
   DCHECK(IsValid());
+
+  TRACE_EVENT_NESTABLE_ASYNC1(kTraceGroup, "base::File::Unlock", this,
+      "path", unsafe_path_.AsUTF8Unsafe());
+
   BOOL result = UnlockFile(file_.Get(), 0, 0, MAXDWORD, MAXDWORD);
   if (!result)
     return OSErrorToFileError(GetLastError());
   return FILE_OK;
 }
 
 File File::Duplicate() {
   if (!IsValid())
     return File();
 
+  TRACE_EVENT_NESTABLE_ASYNC1(kTraceGroup, "base::File::Duplicate", this,
+      "path", unsafe_path_.AsUTF8Unsafe());
+
   HANDLE other_handle = nullptr;
 
   if (!::DuplicateHandle(GetCurrentProcess(),  // hSourceProcessHandle
                          GetPlatformFile(),
                          GetCurrentProcess(),  // hTargetProcessHandle
                          &other_handle,
                          0,  // dwDesiredAccess ignored due to SAME_ACCESS
                          FALSE,  // !bInheritHandle
                          DUPLICATE_SAME_ACCESS)) {
     return File(OSErrorToFileError(GetLastError()));
@@ skipping 35 matching lines @@
     case ERROR_FILE_CORRUPT:
     case ERROR_DISK_CORRUPT:
       return FILE_ERROR_IO;
     default:
       UMA_HISTOGRAM_SPARSE_SLOWLY("PlatformFile.UnknownErrors.Windows",
                                   last_error);
       return FILE_ERROR_FAILED;
   }
 }
 
-void File::DoInitialize(const FilePath& name, uint32 flags) {
+void File::DoInitialize(uint32 flags) {
   ThreadRestrictions::AssertIOAllowed();
   DCHECK(!IsValid());
 
+  TRACE_EVENT_NESTABLE_ASYNC1(kTraceGroup, "base::File::Initialize", this,
+      "path", unsafe_path_.AsUTF8Unsafe());
+
   DWORD disposition = 0;
 
   if (flags & FLAG_OPEN)
     disposition = OPEN_EXISTING;
 
   if (flags & FLAG_CREATE) {
     DCHECK(!disposition);
     disposition = CREATE_NEW;
   }
 
@@ skipping 44 matching lines @@
     create_flags |= FILE_FLAG_OVERLAPPED;
   if (flags & FLAG_TEMPORARY)
     create_flags |= FILE_ATTRIBUTE_TEMPORARY;
   if (flags & FLAG_HIDDEN)
     create_flags |= FILE_ATTRIBUTE_HIDDEN;
   if (flags & FLAG_DELETE_ON_CLOSE)
     create_flags |= FILE_FLAG_DELETE_ON_CLOSE;
   if (flags & FLAG_BACKUP_SEMANTICS)
     create_flags |= FILE_FLAG_BACKUP_SEMANTICS;
 
-  file_.Set(CreateFile(name.value().c_str(), access, sharing, NULL,
+  file_.Set(CreateFile(unsafe_path_.value().c_str(), access, sharing, NULL,
                        disposition, create_flags, NULL));
 
   if (file_.IsValid()) {
     error_details_ = FILE_OK;
     async_ = ((flags & FLAG_ASYNC) == FLAG_ASYNC);
 
     if (flags & (FLAG_OPEN_ALWAYS))
       created_ = (ERROR_ALREADY_EXISTS != GetLastError());
     else if (flags & (FLAG_CREATE_ALWAYS | FLAG_CREATE))
       created_ = true;
   } else {
     error_details_ = OSErrorToFileError(GetLastError());
   }
 }
 
-bool File::DoFlush() {
-  ThreadRestrictions::AssertIOAllowed();
-  DCHECK(IsValid());
-  return ::FlushFileBuffers(file_.Get()) != FALSE;
-}
-
 void File::SetPlatformFile(PlatformFile file) {
   file_.Set(file);
 }
 
 }  // namespace base