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 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
|
// 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.
#include "net/log/net_log.h"
#include <algorithm>
#include <string_view>
#include "base/check_op.h"
#include "base/containers/contains.h"
#include "base/no_destructor.h"
#include "base/notreached.h"
#include "base/strings/string_number_conversions.h"
#include "base/values.h"
#include "net/log/net_log_heavily_redacted_allowlist.h"
#include "net/log/net_log_values.h"
#include "third_party/abseil-cpp/absl/container/flat_hash_set.h"
namespace net {
namespace {
void HeavilyRedactParams(base::Value::Dict& params) {
static const base::NoDestructor<absl::flat_hash_set<std::string_view>>
kAllowlist(kNetLogHeavilyRedactedParamAllowlist.cbegin(),
kNetLogHeavilyRedactedParamAllowlist.cend());
for (auto param = params.begin(); param != params.end();) {
if (kAllowlist->contains(param->first)) {
++param;
} else {
param = params.erase(param);
}
}
}
} // namespace
NetLog::ThreadSafeObserver::ThreadSafeObserver() = default;
NetLog::ThreadSafeObserver::~ThreadSafeObserver() {
// Make sure we aren't watching a NetLog on destruction. Because the NetLog
// may pass events to each observer on multiple threads, we cannot safely
// stop watching a NetLog automatically from a parent class.
DCHECK(!net_log_);
}
NetLogCaptureMode NetLog::ThreadSafeObserver::capture_mode() const {
DCHECK(net_log_);
return capture_mode_;
}
NetLog* NetLog::ThreadSafeObserver::net_log() const {
return net_log_;
}
NetLog::ThreadSafeCaptureModeObserver::ThreadSafeCaptureModeObserver() =
default;
NetLog::ThreadSafeCaptureModeObserver::~ThreadSafeCaptureModeObserver() =
default;
NetLogCaptureModeSet
NetLog::ThreadSafeCaptureModeObserver::GetObserverCaptureModes() const {
DCHECK(net_log_);
return net_log_->GetObserverCaptureModes();
}
void NetLog::ThreadSafeCaptureModeObserver::
AddEntryAtTimeWithMaterializedParams(NetLogEventType type,
const NetLogSource& source,
NetLogEventPhase phase,
base::TimeTicks time,
base::Value::Dict params) {
DCHECK(net_log_);
net_log_->AddEntryAtTimeWithMaterializedParams(type, source, phase, time,
std::move(params));
}
// static
NetLog* NetLog::Get() {
static base::NoDestructor<NetLog> instance{base::PassKey<NetLog>()};
return instance.get();
}
NetLog::NetLog(base::PassKey<NetLog>) {}
NetLog::NetLog(base::PassKey<NetLogWithSource>) {}
void NetLog::AddEntry(NetLogEventType type,
const NetLogSource& source,
NetLogEventPhase phase) {
AddEntry(type, source, phase, [] { return base::Value::Dict(); });
}
void NetLog::AddGlobalEntry(NetLogEventType type) {
AddEntry(type, NetLogSource(NetLogSourceType::NONE, NextID()),
NetLogEventPhase::NONE);
}
void NetLog::AddGlobalEntryWithStringParams(NetLogEventType type,
std::string_view name,
std::string_view value) {
AddGlobalEntry(type, [&] { return NetLogParamsWithString(name, value); });
}
uint32_t NetLog::NextID() {
return last_id_.fetch_add(1, std::memory_order_relaxed) + 1;
}
void NetLog::AddObserver(NetLog::ThreadSafeObserver* observer,
NetLogCaptureMode capture_mode) {
base::AutoLock lock(lock_);
DCHECK(!observer->net_log_);
DCHECK(!HasObserver(observer));
DCHECK_LT(observers_.size(), 20u); // Performance sanity check.
observers_.push_back(observer);
observer->net_log_ = this;
observer->capture_mode_ = capture_mode;
UpdateObserverCaptureModes();
}
void NetLog::RemoveObserver(NetLog::ThreadSafeObserver* observer) {
base::AutoLock lock(lock_);
DCHECK_EQ(this, observer->net_log_);
auto it = std::ranges::find(observers_, observer);
CHECK(it != observers_.end());
observers_.erase(it);
observer->net_log_ = nullptr;
observer->capture_mode_ = NetLogCaptureMode::kDefault;
UpdateObserverCaptureModes();
}
void NetLog::AddCaptureModeObserver(
NetLog::ThreadSafeCaptureModeObserver* observer) {
base::AutoLock lock(lock_);
DCHECK(!observer->net_log_);
DCHECK(!HasCaptureModeObserver(observer));
DCHECK_LT(capture_mode_observers_.size(), 20u); // Performance sanity check.
observer->net_log_ = this;
capture_mode_observers_.push_back(observer);
}
void NetLog::RemoveCaptureModeObserver(
NetLog::ThreadSafeCaptureModeObserver* observer) {
base::AutoLock lock(lock_);
DCHECK_EQ(this, observer->net_log_);
DCHECK(HasCaptureModeObserver(observer));
auto it = std::ranges::find(capture_mode_observers_, observer);
CHECK(it != capture_mode_observers_.end());
capture_mode_observers_.erase(it);
observer->net_log_ = nullptr;
}
void NetLog::UpdateObserverCaptureModes() {
lock_.AssertAcquired();
NetLogCaptureModeSet capture_mode_set = 0;
for (const net::NetLog::ThreadSafeObserver* observer : observers_) {
NetLogCaptureModeSetAdd(observer->capture_mode_, &capture_mode_set);
}
observer_capture_modes_.store(capture_mode_set, std::memory_order_relaxed);
// Notify any capture mode observers with the new |capture_mode_set|.
for (net::NetLog::ThreadSafeCaptureModeObserver* capture_mode_observer :
capture_mode_observers_) {
capture_mode_observer->OnCaptureModeUpdated(capture_mode_set);
}
}
bool NetLog::HasObserver(ThreadSafeObserver* observer) {
lock_.AssertAcquired();
return base::Contains(observers_, observer);
}
bool NetLog::HasCaptureModeObserver(ThreadSafeCaptureModeObserver* observer) {
lock_.AssertAcquired();
return base::Contains(capture_mode_observers_, observer);
}
// static
std::string NetLog::TickCountToString(const base::TimeTicks& time) {
int64_t delta_time = time.since_origin().InMilliseconds();
// TODO(crbug.com/40606676): Use NetLogNumberValue().
return base::NumberToString(delta_time);
}
// static
std::string NetLog::TimeToString(const base::Time& time) {
// Convert the base::Time to its (approximate) equivalent in base::TimeTicks.
base::TimeTicks time_ticks =
base::TimeTicks::UnixEpoch() + (time - base::Time::UnixEpoch());
return TickCountToString(time_ticks);
}
// static
base::Value NetLog::GetEventTypesAsValue() {
base::Value::Dict dict;
for (int i = 0; i < static_cast<int>(NetLogEventType::COUNT); ++i) {
dict.Set(NetLogEventTypeToString(static_cast<NetLogEventType>(i)), i);
}
return base::Value(std::move(dict));
}
// static
const char* NetLog::SourceTypeToString(NetLogSourceType source) {
switch (source) {
#define SOURCE_TYPE(label) \
case NetLogSourceType::label: \
return #label;
#include "net/log/net_log_source_type_list.h"
#undef SOURCE_TYPE
default:
NOTREACHED();
}
}
// static
base::Value NetLog::GetSourceTypesAsValue() {
base::Value::Dict dict;
for (int i = 0; i < static_cast<int>(NetLogSourceType::COUNT); ++i) {
dict.Set(SourceTypeToString(static_cast<NetLogSourceType>(i)), i);
}
return base::Value(std::move(dict));
}
// static
const char* NetLog::EventPhaseToString(NetLogEventPhase phase) {
switch (phase) {
case NetLogEventPhase::BEGIN:
return "PHASE_BEGIN";
case NetLogEventPhase::END:
return "PHASE_END";
case NetLogEventPhase::NONE:
return "PHASE_NONE";
}
NOTREACHED();
}
void NetLog::InitializeSourceIdPartition() {
int32_t old_value = last_id_.exchange(std::numeric_limits<int32_t>::min(),
std::memory_order_relaxed);
DCHECK_EQ(old_value, 0) << " NetLog::InitializeSourceIdPartition() called "
"after NextID() or called multiple times";
}
void NetLog::AddEntryInternal(
NetLogEventType type,
const NetLogSource& source,
NetLogEventPhase phase,
base::FunctionRef<base::Value::Dict(NetLogCaptureMode)> get_params) {
NetLogCaptureModeSet observer_capture_modes = GetObserverCaptureModes();
for (int i = 0; i <= static_cast<int>(NetLogCaptureMode::kLast); ++i) {
NetLogCaptureMode capture_mode = static_cast<NetLogCaptureMode>(i);
if (!NetLogCaptureModeSetContains(capture_mode, observer_capture_modes))
continue;
base::Value::Dict params = get_params(capture_mode);
if (capture_mode == NetLogCaptureMode::kHeavilyRedacted) {
HeavilyRedactParams(params);
}
NetLogEntry entry(type, source, phase, base::TimeTicks::Now(),
std::move(params));
// Notify all of the log observers with |capture_mode|.
base::AutoLock lock(lock_);
for (net::NetLog::ThreadSafeObserver* observer : observers_) {
if (observer->capture_mode() == capture_mode)
observer->OnAddEntry(entry);
}
}
}
void NetLog::AddEntryWithMaterializedParams(NetLogEventType type,
const NetLogSource& source,
NetLogEventPhase phase,
base::Value::Dict params) {
AddEntryAtTimeWithMaterializedParams(
type, source, phase, base::TimeTicks::Now(), std::move(params));
}
void NetLog::AddEntryAtTimeWithMaterializedParams(NetLogEventType type,
const NetLogSource& source,
NetLogEventPhase phase,
base::TimeTicks time,
base::Value::Dict params) {
const NetLogCaptureModeSet capture_modes = GetObserverCaptureModes();
const NetLogCaptureModeSet heavily_redacted_bit =
NetLogCaptureModeToBit(NetLogCaptureMode::kHeavilyRedacted);
const bool has_heavily_redacted_observers =
capture_modes & heavily_redacted_bit;
const bool has_non_heavily_redacted_observers =
capture_modes & ~heavily_redacted_bit;
std::optional<NetLogEntry> non_heavily_redacted_entry;
if (has_non_heavily_redacted_observers) {
non_heavily_redacted_entry = NetLogEntry(
type, source, phase, time,
has_heavily_redacted_observers ? params.Clone() : std::move(params));
}
std::optional<NetLogEntry> heavily_redacted_entry;
if (has_heavily_redacted_observers) {
HeavilyRedactParams(params);
heavily_redacted_entry =
NetLogEntry(type, source, phase, time, std::move(params));
}
// Notify all of the log observers, regardless of capture mode.
base::AutoLock lock(lock_);
for (net::NetLog::ThreadSafeObserver* observer : observers_) {
observer->OnAddEntry(observer->capture_mode() ==
NetLogCaptureMode::kHeavilyRedacted
? *heavily_redacted_entry
: *non_heavily_redacted_entry);
}
}
} // namespace net
|