1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef BASE_FILES_FILE_TRACING_H_
#define BASE_FILES_FILE_TRACING_H_
#include <stdint.h>
#include "base/base_export.h"
#include "base/memory/raw_ptr.h"
#define FILE_TRACING_PREFIX "File"
#define SCOPED_FILE_TRACE_WITH_SIZE(name, size) \
FileTracing::ScopedTrace scoped_file_trace; \
if (FileTracing::IsCategoryEnabled()) \
scoped_file_trace.Initialize(FILE_TRACING_PREFIX "::" name, this, size)
#define SCOPED_FILE_TRACE(name) SCOPED_FILE_TRACE_WITH_SIZE(name, 0)
namespace base {
class File;
class FilePath;
class BASE_EXPORT FileTracing {
public:
// Whether the file tracing category is enabled.
static bool IsCategoryEnabled();
class Provider {
public:
virtual ~Provider() = default;
// Whether the file tracing category is currently enabled.
virtual bool FileTracingCategoryIsEnabled() const = 0;
// Enables file tracing for |id|. Must be called before recording events.
virtual void FileTracingEnable(const void* id) = 0;
// Disables file tracing for |id|.
virtual void FileTracingDisable(const void* id) = 0;
// Begins an event for |id| with |name|. |path| tells where in the directory
// structure the event is happening (and may be blank). |size| is the number
// of bytes involved in the event.
virtual void FileTracingEventBegin(const char* name,
const void* id,
const FilePath& path,
int64_t size) = 0;
// Ends an event for |id| with |name|.
virtual void FileTracingEventEnd(const char* name, const void* id) = 0;
};
// Sets a global file tracing provider to query categories and record events.
static void SetProvider(Provider* provider);
// Enables file tracing while in scope.
class ScopedEnabler {
public:
ScopedEnabler();
~ScopedEnabler();
};
class ScopedTrace {
public:
ScopedTrace() = default;
ScopedTrace(const ScopedTrace&) = delete;
ScopedTrace& operator=(const ScopedTrace&) = delete;
~ScopedTrace();
// Called only if the tracing category is enabled. |name| is the name of the
// event to trace (e.g. "Read", "Write") and must have an application
// lifetime (e.g. static or literal). |file| is the file being traced; must
// outlive this class. |size| is the size (in bytes) of this event.
void Initialize(const char* name, const File* file, int64_t size);
private:
// The ID of this trace. Based on the |file| passed to |Initialize()|. Must
// outlive this class.
raw_ptr<const void> id_ = nullptr;
// The name of the event to trace (e.g. "Read", "Write"). Prefixed with
// "File".
const char* name_;
};
FileTracing(const FileTracing&) = delete;
FileTracing& operator=(const FileTracing&) = delete;
};
} // namespace base
#endif // BASE_FILES_FILE_TRACING_H_
|
