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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
base / location.cc [blame]
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifdef UNSAFE_BUFFERS_BUILD
// TODO(crbug.com/40284755): Remove this and spanify to fix the errors.
#pragma allow_unsafe_buffers
#endif
#include "base/location.h"
#include "base/compiler_specific.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/stringprintf.h"
#include "base/trace_event/base_tracing.h"
#if defined(COMPILER_MSVC)
#include <intrin.h>
#endif
namespace base {
namespace {
// Returns the length of the given null terminated c-string.
constexpr size_t StrLen(const char* str) {
size_t str_len = 0;
for (str_len = 0; str[str_len] != '\0'; ++str_len)
;
return str_len;
}
// Finds the length of the build folder prefix from the file path.
// TODO(ssid): Strip prefixes from stored strings in the binary. This code only
// skips the prefix while reading the file name strings at runtime.
constexpr size_t StrippedFilePathPrefixLength() {
constexpr char path[] = __FILE__;
// Only keep the file path starting from the src directory.
#if defined(__clang__) && defined(_MSC_VER)
constexpr char stripped[] = "base\\location.cc";
#else
constexpr char stripped[] = "base/location.cc";
#endif
constexpr size_t path_len = StrLen(path);
constexpr size_t stripped_len = StrLen(stripped);
static_assert(path_len >= stripped_len,
"Invalid file path for base/location.cc.");
return path_len - stripped_len;
}
constexpr size_t kStrippedPrefixLength = StrippedFilePathPrefixLength();
// Returns true if the |name| string has |prefix_len| characters in the prefix
// and the suffix matches the |expected| string.
// TODO(ssid): With C++20 we can make base::EndsWith() constexpr and use it
// instead.
constexpr bool StrEndsWith(const char* name,
size_t prefix_len,
const char* expected) {
const size_t name_len = StrLen(name);
const size_t expected_len = StrLen(expected);
if (name_len != prefix_len + expected_len)
return false;
for (size_t i = 0; i < expected_len; ++i) {
if (name[i + prefix_len] != expected[i])
return false;
}
return true;
}
#if defined(__clang__) && defined(_MSC_VER)
static_assert(StrEndsWith(__FILE__, kStrippedPrefixLength, "base\\location.cc"),
"The file name does not match the expected prefix format.");
#else
static_assert(StrEndsWith(__FILE__, kStrippedPrefixLength, "base/location.cc"),
"The file name does not match the expected prefix format.");
#endif
} // namespace
Location::Location() = default;
Location::Location(const Location& other) = default;
Location::Location(Location&& other) noexcept = default;
Location& Location::operator=(const Location& other) = default;
Location::Location(const char* file_name, const void* program_counter)
: file_name_(file_name), program_counter_(program_counter) {}
Location::Location(const char* function_name,
const char* file_name,
int line_number,
const void* program_counter)
: function_name_(function_name),
file_name_(file_name),
line_number_(line_number),
program_counter_(program_counter) {
#if !BUILDFLAG(IS_NACL)
// The program counter should not be null except in a default constructed
// (empty) Location object. This value is used for identity, so if it doesn't
// uniquely identify a location, things will break.
//
// The program counter isn't supported in NaCl so location objects won't work
// properly in that context.
DCHECK(program_counter);
#endif
}
std::string Location::ToString() const {
if (has_source_info()) {
return std::string(function_name_) + "@" + file_name_ + ":" +
NumberToString(line_number_);
}
return StringPrintf("pc:%p", program_counter_);
}
void Location::WriteIntoTrace(perfetto::TracedValue context) const {
auto dict = std::move(context).WriteDictionary();
dict.Add("function_name", function_name_);
dict.Add("file_name", file_name_);
dict.Add("line_number", line_number_);
}
#if defined(COMPILER_MSVC)
#define RETURN_ADDRESS() _ReturnAddress()
#elif defined(COMPILER_GCC) && !BUILDFLAG(IS_NACL)
#define RETURN_ADDRESS() \
__builtin_extract_return_addr(__builtin_return_address(0))
#else
#define RETURN_ADDRESS() nullptr
#endif
// static
NOINLINE Location Location::Current(const char* function_name,
const char* file_name,
int line_number) {
return Location(function_name, file_name + kStrippedPrefixLength, line_number,
RETURN_ADDRESS());
}
// static
NOINLINE Location Location::CurrentWithoutFunctionName(const char* file_name,
int line_number) {
return Location(nullptr, file_name + kStrippedPrefixLength, line_number,
RETURN_ADDRESS());
}
//------------------------------------------------------------------------------
NOINLINE const void* GetProgramCounter() {
return RETURN_ADDRESS();
}
} // namespace base