123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848 |
- // Copyright 2016 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 "net/log/file_net_log_observer.h"
- #include <algorithm>
- #include <memory>
- #include <string>
- #include <utility>
- #include "base/bind.h"
- #include "base/containers/queue.h"
- #include "base/files/file.h"
- #include "base/files/file_util.h"
- #include "base/json/json_writer.h"
- #include "base/logging.h"
- #include "base/memory/ptr_util.h"
- #include "base/numerics/clamped_math.h"
- #include "base/strings/string_number_conversions.h"
- #include "base/synchronization/lock.h"
- #include "base/task/sequenced_task_runner.h"
- #include "base/task/thread_pool.h"
- #include "base/values.h"
- #include "net/log/net_log_capture_mode.h"
- #include "net/log/net_log_entry.h"
- #include "net/log/net_log_util.h"
- #include "net/url_request/url_request_context.h"
- namespace {
- // Number of events that can build up in |write_queue_| before a task is posted
- // to the file task runner to flush them to disk.
- const int kNumWriteQueueEvents = 15;
- // TODO(eroman): Should use something other than 10 for number of files?
- const int kDefaultNumFiles = 10;
- scoped_refptr<base::SequencedTaskRunner> CreateFileTaskRunner() {
- // The tasks posted to this sequenced task runner do synchronous File I/O for
- // the purposes of writing NetLog files.
- //
- // These intentionally block shutdown to ensure the log file has finished
- // being written.
- return base::ThreadPool::CreateSequencedTaskRunner(
- {base::MayBlock(), base::TaskPriority::USER_VISIBLE,
- base::TaskShutdownBehavior::BLOCK_SHUTDOWN});
- }
- // Truncates a file, also reseting the seek position.
- void TruncateFile(base::File* file) {
- if (!file->IsValid())
- return;
- file->Seek(base::File::FROM_BEGIN, 0);
- file->SetLength(0);
- }
- // Opens |path| in write mode.
- base::File OpenFileForWrite(const base::FilePath& path) {
- base::File result(path,
- base::File::FLAG_CREATE_ALWAYS | base::File::FLAG_WRITE);
- LOG_IF(ERROR, !result.IsValid()) << "Failed opening: " << path.value();
- return result;
- }
- // Helper that writes data to a file. |file->IsValid()| may be false,
- // in which case nothing will be written. Returns the number of bytes
- // successfully written (may be less than input data in case of errors).
- size_t WriteToFile(base::File* file,
- base::StringPiece data1,
- base::StringPiece data2 = base::StringPiece(),
- base::StringPiece data3 = base::StringPiece()) {
- size_t bytes_written = 0;
- if (file->IsValid()) {
- // Append each of data1, data2 and data3.
- if (!data1.empty())
- bytes_written +=
- std::max(0, file->WriteAtCurrentPos(data1.data(), data1.size()));
- if (!data2.empty())
- bytes_written +=
- std::max(0, file->WriteAtCurrentPos(data2.data(), data2.size()));
- if (!data3.empty())
- bytes_written +=
- std::max(0, file->WriteAtCurrentPos(data3.data(), data3.size()));
- }
- return bytes_written;
- }
- // Copies all of the data at |source_path| and appends it to |destination_file|,
- // then deletes |source_path|.
- void AppendToFileThenDelete(const base::FilePath& source_path,
- base::File* destination_file,
- char* read_buffer,
- size_t read_buffer_size) {
- base::ScopedFILE source_file(base::OpenFile(source_path, "rb"));
- if (!source_file)
- return;
- // Read |source_path|'s contents in chunks of read_buffer_size and append
- // to |destination_file|.
- size_t num_bytes_read;
- while ((num_bytes_read =
- fread(read_buffer, 1, read_buffer_size, source_file.get())) > 0) {
- WriteToFile(destination_file,
- base::StringPiece(read_buffer, num_bytes_read));
- }
- // Now that it has been copied, delete the source file.
- source_file.reset();
- base::DeleteFile(source_path);
- }
- base::FilePath SiblingInprogressDirectory(const base::FilePath& log_path) {
- return log_path.AddExtension(FILE_PATH_LITERAL(".inprogress"));
- }
- } // namespace
- namespace net {
- // Used to store events to be written to file.
- using EventQueue = base::queue<std::unique_ptr<std::string>>;
- // WriteQueue receives events from FileNetLogObserver on the main thread and
- // holds them in a queue until they are drained from the queue and written to
- // file on the file task runner.
- //
- // WriteQueue contains the resources shared between the main thread and the
- // file task runner. |lock_| must be acquired to read or write to |queue_| and
- // |memory_|.
- //
- // WriteQueue is refcounted and should be destroyed once all events on the
- // file task runner have finished executing.
- class FileNetLogObserver::WriteQueue
- : public base::RefCountedThreadSafe<WriteQueue> {
- public:
- // |memory_max| indicates the maximum amount of memory that the virtual write
- // queue can use. If |memory_| exceeds |memory_max_|, the |queue_| of events
- // is overwritten.
- explicit WriteQueue(uint64_t memory_max);
- WriteQueue(const WriteQueue&) = delete;
- WriteQueue& operator=(const WriteQueue&) = delete;
- // Adds |event| to |queue_|. Also manages the size of |memory_|; if it
- // exceeds |memory_max_|, then old events are dropped from |queue_| without
- // being written to file.
- //
- // Returns the number of events in the |queue_|.
- size_t AddEntryToQueue(std::unique_ptr<std::string> event);
- // Swaps |queue_| with |local_queue|. |local_queue| should be empty, so that
- // |queue_| is emptied. Resets |memory_| to 0.
- void SwapQueue(EventQueue* local_queue);
- private:
- friend class base::RefCountedThreadSafe<WriteQueue>;
- ~WriteQueue();
- // Queue of events to be written, shared between main thread and file task
- // runner. Main thread adds events to the queue and the file task runner
- // drains them and writes the events to file.
- //
- // |lock_| must be acquired to read or write to this.
- EventQueue queue_;
- // Tracks how much memory is being used by the virtual write queue.
- // Incremented in AddEntryToQueue() when events are added to the
- // buffer, and decremented when SwapQueue() is called and the file task
- // runner's local queue is swapped with the shared write queue.
- //
- // |lock_| must be acquired to read or write to this.
- uint64_t memory_ = 0;
- // Indicates the maximum amount of memory that the |queue_| is allowed to
- // use.
- const uint64_t memory_max_;
- // Protects access to |queue_| and |memory_|.
- //
- // A lock is necessary because |queue_| and |memory_| are shared between the
- // file task runner and the main thread. NetLog's lock protects OnAddEntry(),
- // which calls AddEntryToQueue(), but it does not protect access to the
- // observer's member variables. Thus, a race condition exists if a thread is
- // calling OnAddEntry() at the same time that the file task runner is
- // accessing |memory_| and |queue_| to write events to file. The |queue_| and
- // |memory_| counter are necessary to bound the amount of memory that is used
- // for the queue in the event that the file task runner lags significantly
- // behind the main thread in writing events to file.
- base::Lock lock_;
- };
- // FileWriter is responsible for draining events from a WriteQueue and writing
- // them to disk. FileWriter can be constructed on any thread, and
- // afterwards is only accessed on the file task runner.
- class FileNetLogObserver::FileWriter {
- public:
- // If max_event_file_size == kNoLimit, then no limit is enforced.
- FileWriter(const base::FilePath& log_path,
- const base::FilePath& inprogress_dir_path,
- absl::optional<base::File> pre_existing_log_file,
- uint64_t max_event_file_size,
- size_t total_num_event_files,
- scoped_refptr<base::SequencedTaskRunner> task_runner);
- FileWriter(const FileWriter&) = delete;
- FileWriter& operator=(const FileWriter&) = delete;
- ~FileWriter();
- // Writes |constants_value| to disk and opens the events array (closed in
- // Stop()).
- void Initialize(std::unique_ptr<base::Value> constants_value);
- // Closes the events array opened in Initialize() and writes |polled_data| to
- // disk. If |polled_data| cannot be converted to proper JSON, then it
- // is ignored.
- void Stop(std::unique_ptr<base::Value> polled_data);
- // Drains |queue_| from WriteQueue into a local file queue and writes the
- // events in the queue to disk.
- void Flush(scoped_refptr<WriteQueue> write_queue);
- // Deletes all netlog files. It is not valid to call any method of
- // FileNetLogObserver after DeleteAllFiles().
- void DeleteAllFiles();
- void FlushThenStop(scoped_refptr<WriteQueue> write_queue,
- std::unique_ptr<base::Value> polled_data);
- private:
- // Returns true if there is no file size bound to enforce.
- //
- // When operating in unbounded mode, the implementation is optimized to stream
- // writes to a single file, rather than chunking them across temporary event
- // files.
- bool IsUnbounded() const;
- bool IsBounded() const;
- // Increments |current_event_file_number_|, and updates all state relating to
- // the current event file (open file handle, num bytes written, current file
- // number).
- void IncrementCurrentEventFile();
- // Returns the path to the event file having |index|. This looks like
- // "LOGDIR/event_file_<index>.json".
- base::FilePath GetEventFilePath(size_t index) const;
- // Gets the file path where constants are saved at the start of
- // logging. This looks like "LOGDIR/constants.json".
- base::FilePath GetConstantsFilePath() const;
- // Gets the file path where the final data is written at the end of logging.
- // This looks like "LOGDIR/end_netlog.json".
- base::FilePath GetClosingFilePath() const;
- // Returns the corresponding index for |file_number|. File "numbers" are a
- // monotonically increasing identifier that start at 1 (a value of zero means
- // it is uninitialized), whereas the file "index" is a bounded value that
- // wraps and identifies the file path to use.
- //
- // Keeping track of the current number rather than index makes it a bit easier
- // to assemble a file at the end, since it is unambiguous which paths have
- // been used/re-used.
- size_t FileNumberToIndex(size_t file_number) const;
- // Writes |constants_value| to a file.
- static void WriteConstantsToFile(std::unique_ptr<base::Value> constants_value,
- base::File* file);
- // Writes |polled_data| to a file.
- static void WritePolledDataToFile(std::unique_ptr<base::Value> polled_data,
- base::File* file);
- // If any events were written (wrote_event_bytes_), rewinds |file| by 2 bytes
- // in order to overwrite the trailing ",\n" that was written by the last event
- // line.
- void RewindIfWroteEventBytes(base::File* file) const;
- // Concatenates all the log files to assemble the final
- // |final_log_file_|. This single "stitched" file is what other
- // log ingesting tools expect.
- void StitchFinalLogFile();
- // Creates the .inprogress directory used by bounded mode.
- void CreateInprogressDirectory();
- // The file the final netlog is written to. In bounded mode this is mostly
- // written to once logging is stopped, whereas in unbounded mode events will
- // be directly written to it.
- base::File final_log_file_;
- // If non-empty, this is the path to |final_log_file_| created and owned
- // by FileWriter itself (rather than passed in to Create*PreExisting
- // methods of FileNetLogObserver).
- const base::FilePath final_log_path_;
- // Path to a (temporary) directory where files are written in bounded mode.
- // When logging is stopped these files are stitched together and written
- // to the final log path.
- const base::FilePath inprogress_dir_path_;
- // Holds the numbered events file where data is currently being written to.
- // The file path of this file is GetEventFilePath(current_event_file_number_).
- // The file may be !IsValid() if an error previously occurred opening the
- // file, or logging has been stopped.
- base::File current_event_file_;
- uint64_t current_event_file_size_;
- // Indicates the total number of netlog event files allowed.
- // (The files GetConstantsFilePath() and GetClosingFilePath() do
- // not count against the total.)
- const size_t total_num_event_files_;
- // Counter for the events file currently being written into. See
- // FileNumberToIndex() for an explanation of what "number" vs "index" mean.
- size_t current_event_file_number_ = 0;
- // Indicates the maximum size of each individual events file. May be kNoLimit
- // to indicate that it can grow arbitrarily large.
- const uint64_t max_event_file_size_;
- // Whether any bytes were written for events. This is used to properly format
- // JSON (events list shouldn't end with a comma).
- bool wrote_event_bytes_ = false;
- // Task runner for doing file operations.
- const scoped_refptr<base::SequencedTaskRunner> task_runner_;
- };
- std::unique_ptr<FileNetLogObserver> FileNetLogObserver::CreateBounded(
- const base::FilePath& log_path,
- uint64_t max_total_size,
- NetLogCaptureMode capture_mode,
- std::unique_ptr<base::Value> constants) {
- return CreateInternal(log_path, SiblingInprogressDirectory(log_path),
- absl::nullopt, max_total_size, kDefaultNumFiles,
- capture_mode, std::move(constants));
- }
- std::unique_ptr<FileNetLogObserver> FileNetLogObserver::CreateUnbounded(
- const base::FilePath& log_path,
- NetLogCaptureMode capture_mode,
- std::unique_ptr<base::Value> constants) {
- return CreateInternal(log_path, base::FilePath(), absl::nullopt, kNoLimit,
- kDefaultNumFiles, capture_mode, std::move(constants));
- }
- std::unique_ptr<FileNetLogObserver>
- FileNetLogObserver::CreateBoundedPreExisting(
- const base::FilePath& inprogress_dir_path,
- base::File output_file,
- uint64_t max_total_size,
- NetLogCaptureMode capture_mode,
- std::unique_ptr<base::Value> constants) {
- return CreateInternal(base::FilePath(), inprogress_dir_path,
- absl::make_optional<base::File>(std::move(output_file)),
- max_total_size, kDefaultNumFiles, capture_mode,
- std::move(constants));
- }
- std::unique_ptr<FileNetLogObserver>
- FileNetLogObserver::CreateUnboundedPreExisting(
- base::File output_file,
- NetLogCaptureMode capture_mode,
- std::unique_ptr<base::Value> constants) {
- return CreateInternal(base::FilePath(), base::FilePath(),
- absl::make_optional<base::File>(std::move(output_file)),
- kNoLimit, kDefaultNumFiles, capture_mode,
- std::move(constants));
- }
- FileNetLogObserver::~FileNetLogObserver() {
- if (net_log()) {
- // StopObserving was not called.
- net_log()->RemoveObserver(this);
- file_task_runner_->PostTask(
- FROM_HERE,
- base::BindOnce(&FileNetLogObserver::FileWriter::DeleteAllFiles,
- base::Unretained(file_writer_.get())));
- }
- file_task_runner_->DeleteSoon(FROM_HERE, file_writer_.release());
- }
- void FileNetLogObserver::StartObserving(NetLog* net_log) {
- net_log->AddObserver(this, capture_mode_);
- }
- void FileNetLogObserver::StopObserving(std::unique_ptr<base::Value> polled_data,
- base::OnceClosure optional_callback) {
- net_log()->RemoveObserver(this);
- base::OnceClosure bound_flush_then_stop =
- base::BindOnce(&FileNetLogObserver::FileWriter::FlushThenStop,
- base::Unretained(file_writer_.get()), write_queue_,
- std::move(polled_data));
- // Note that PostTaskAndReply() requires a non-null closure.
- if (!optional_callback.is_null()) {
- file_task_runner_->PostTaskAndReply(FROM_HERE,
- std::move(bound_flush_then_stop),
- std::move(optional_callback));
- } else {
- file_task_runner_->PostTask(FROM_HERE, std::move(bound_flush_then_stop));
- }
- }
- void FileNetLogObserver::OnAddEntry(const NetLogEntry& entry) {
- auto json = std::make_unique<std::string>();
- *json = SerializeNetLogValueToJson(entry.ToValue());
- size_t queue_size = write_queue_->AddEntryToQueue(std::move(json));
- // If events build up in |write_queue_|, trigger the file task runner to drain
- // the queue. Because only 1 item is added to the queue at a time, if
- // queue_size > kNumWriteQueueEvents a task has already been posted, or will
- // be posted.
- if (queue_size == kNumWriteQueueEvents) {
- file_task_runner_->PostTask(
- FROM_HERE,
- base::BindOnce(&FileNetLogObserver::FileWriter::Flush,
- base::Unretained(file_writer_.get()), write_queue_));
- }
- }
- std::unique_ptr<FileNetLogObserver> FileNetLogObserver::CreateBoundedForTests(
- const base::FilePath& log_path,
- uint64_t max_total_size,
- size_t total_num_event_files,
- NetLogCaptureMode capture_mode,
- std::unique_ptr<base::Value> constants) {
- return CreateInternal(log_path, SiblingInprogressDirectory(log_path),
- absl::nullopt, max_total_size, total_num_event_files,
- capture_mode, std::move(constants));
- }
- std::unique_ptr<FileNetLogObserver> FileNetLogObserver::CreateInternal(
- const base::FilePath& log_path,
- const base::FilePath& inprogress_dir_path,
- absl::optional<base::File> pre_existing_log_file,
- uint64_t max_total_size,
- size_t total_num_event_files,
- NetLogCaptureMode capture_mode,
- std::unique_ptr<base::Value> constants) {
- DCHECK_GT(total_num_event_files, 0u);
- scoped_refptr<base::SequencedTaskRunner> file_task_runner =
- CreateFileTaskRunner();
- const uint64_t max_event_file_size =
- max_total_size == kNoLimit ? kNoLimit
- : max_total_size / total_num_event_files;
- // The FileWriter uses a soft limit to write events to file that allows
- // the size of the file to exceed the limit, but the WriteQueue uses a hard
- // limit which the size of |WriteQueue::queue_| cannot exceed. Thus, the
- // FileWriter may write more events to file than can be contained by
- // the WriteQueue if they have the same size limit. The maximum size of the
- // WriteQueue is doubled to allow |WriteQueue::queue_| to hold enough events
- // for the FileWriter to fill all files. As long as all events have
- // sizes <= the size of an individual event file, the discrepancy between the
- // hard limit and the soft limit will not cause an issue.
- // TODO(dconnol): Handle the case when the WriteQueue still doesn't
- // contain enough events to fill all files, because of very large events
- // relative to file size.
- auto file_writer = std::make_unique<FileWriter>(
- log_path, inprogress_dir_path, std::move(pre_existing_log_file),
- max_event_file_size, total_num_event_files, file_task_runner);
- uint64_t write_queue_memory_max =
- base::MakeClampedNum<uint64_t>(max_total_size) * 2;
- return base::WrapUnique(new FileNetLogObserver(
- file_task_runner, std::move(file_writer),
- base::MakeRefCounted<WriteQueue>(write_queue_memory_max), capture_mode,
- std::move(constants)));
- }
- FileNetLogObserver::FileNetLogObserver(
- scoped_refptr<base::SequencedTaskRunner> file_task_runner,
- std::unique_ptr<FileWriter> file_writer,
- scoped_refptr<WriteQueue> write_queue,
- NetLogCaptureMode capture_mode,
- std::unique_ptr<base::Value> constants)
- : file_task_runner_(std::move(file_task_runner)),
- write_queue_(std::move(write_queue)),
- file_writer_(std::move(file_writer)),
- capture_mode_(capture_mode) {
- if (!constants)
- constants = std::make_unique<base::Value>(GetNetConstants());
- DCHECK(constants->is_dict());
- DCHECK(!constants->GetDict().Find("logCaptureMode"));
- constants->GetDict().Set("logCaptureMode", CaptureModeToString(capture_mode));
- file_task_runner_->PostTask(
- FROM_HERE, base::BindOnce(&FileNetLogObserver::FileWriter::Initialize,
- base::Unretained(file_writer_.get()),
- std::move(constants)));
- }
- std::string FileNetLogObserver::CaptureModeToString(NetLogCaptureMode mode) {
- switch (mode) {
- case NetLogCaptureMode::kDefault:
- return "Default";
- case NetLogCaptureMode::kIncludeSensitive:
- return "IncludeSensitive";
- case NetLogCaptureMode::kEverything:
- return "Everything";
- }
- NOTREACHED();
- return "UNKNOWN";
- }
- FileNetLogObserver::WriteQueue::WriteQueue(uint64_t memory_max)
- : memory_max_(memory_max) {}
- size_t FileNetLogObserver::WriteQueue::AddEntryToQueue(
- std::unique_ptr<std::string> event) {
- base::AutoLock lock(lock_);
- memory_ += event->size();
- queue_.push(std::move(event));
- while (memory_ > memory_max_ && !queue_.empty()) {
- // Delete oldest events in the queue.
- DCHECK(queue_.front());
- memory_ -= queue_.front()->size();
- queue_.pop();
- }
- return queue_.size();
- }
- void FileNetLogObserver::WriteQueue::SwapQueue(EventQueue* local_queue) {
- DCHECK(local_queue->empty());
- base::AutoLock lock(lock_);
- queue_.swap(*local_queue);
- memory_ = 0;
- }
- FileNetLogObserver::WriteQueue::~WriteQueue() = default;
- FileNetLogObserver::FileWriter::FileWriter(
- const base::FilePath& log_path,
- const base::FilePath& inprogress_dir_path,
- absl::optional<base::File> pre_existing_log_file,
- uint64_t max_event_file_size,
- size_t total_num_event_files,
- scoped_refptr<base::SequencedTaskRunner> task_runner)
- : final_log_path_(log_path),
- inprogress_dir_path_(inprogress_dir_path),
- total_num_event_files_(total_num_event_files),
- max_event_file_size_(max_event_file_size),
- task_runner_(std::move(task_runner)) {
- DCHECK_EQ(pre_existing_log_file.has_value(), log_path.empty());
- DCHECK_EQ(IsBounded(), !inprogress_dir_path.empty());
- if (pre_existing_log_file.has_value()) {
- // pre_existing_log_file.IsValid() being false is fine.
- final_log_file_ = std::move(pre_existing_log_file.value());
- }
- }
- FileNetLogObserver::FileWriter::~FileWriter() = default;
- void FileNetLogObserver::FileWriter::Initialize(
- std::unique_ptr<base::Value> constants_value) {
- DCHECK(task_runner_->RunsTasksInCurrentSequence());
- // Open the final log file, and keep it open for the duration of logging (even
- // in bounded mode).
- if (!final_log_path_.empty())
- final_log_file_ = OpenFileForWrite(final_log_path_);
- else
- TruncateFile(&final_log_file_);
- if (IsBounded()) {
- CreateInprogressDirectory();
- base::File constants_file = OpenFileForWrite(GetConstantsFilePath());
- WriteConstantsToFile(std::move(constants_value), &constants_file);
- } else {
- WriteConstantsToFile(std::move(constants_value), &final_log_file_);
- }
- }
- void FileNetLogObserver::FileWriter::Stop(
- std::unique_ptr<base::Value> polled_data) {
- DCHECK(task_runner_->RunsTasksInCurrentSequence());
- // Write out the polled data.
- if (IsBounded()) {
- base::File closing_file = OpenFileForWrite(GetClosingFilePath());
- WritePolledDataToFile(std::move(polled_data), &closing_file);
- } else {
- RewindIfWroteEventBytes(&final_log_file_);
- WritePolledDataToFile(std::move(polled_data), &final_log_file_);
- }
- // If operating in bounded mode, the events were written to separate files
- // within |inprogress_dir_path_|. Assemble them into the final destination
- // file.
- if (IsBounded())
- StitchFinalLogFile();
- // Ensure the final log file has been flushed.
- final_log_file_.Close();
- }
- void FileNetLogObserver::FileWriter::Flush(
- scoped_refptr<FileNetLogObserver::WriteQueue> write_queue) {
- DCHECK(task_runner_->RunsTasksInCurrentSequence());
- EventQueue local_file_queue;
- write_queue->SwapQueue(&local_file_queue);
- while (!local_file_queue.empty()) {
- base::File* output_file;
- // If in bounded mode, output events to the current event file. Otherwise
- // output events to the final log path.
- if (IsBounded()) {
- if (current_event_file_number_ == 0 ||
- current_event_file_size_ >= max_event_file_size_) {
- IncrementCurrentEventFile();
- }
- output_file = ¤t_event_file_;
- } else {
- output_file = &final_log_file_;
- }
- size_t bytes_written =
- WriteToFile(output_file, *local_file_queue.front(), ",\n");
- wrote_event_bytes_ |= bytes_written > 0;
- // Keep track of the filesize for current event file when in bounded mode.
- if (IsBounded())
- current_event_file_size_ += bytes_written;
- local_file_queue.pop();
- }
- }
- void FileNetLogObserver::FileWriter::DeleteAllFiles() {
- DCHECK(task_runner_->RunsTasksInCurrentSequence());
- final_log_file_.Close();
- if (IsBounded()) {
- current_event_file_.Close();
- base::DeletePathRecursively(inprogress_dir_path_);
- }
- // Only delete |final_log_file_| if it was created internally.
- // (If it was provided as a base::File by the caller, don't try to delete it).
- if (!final_log_path_.empty())
- base::DeleteFile(final_log_path_);
- }
- void FileNetLogObserver::FileWriter::FlushThenStop(
- scoped_refptr<FileNetLogObserver::WriteQueue> write_queue,
- std::unique_ptr<base::Value> polled_data) {
- Flush(write_queue);
- Stop(std::move(polled_data));
- }
- bool FileNetLogObserver::FileWriter::IsUnbounded() const {
- return max_event_file_size_ == kNoLimit;
- }
- bool FileNetLogObserver::FileWriter::IsBounded() const {
- return !IsUnbounded();
- }
- void FileNetLogObserver::FileWriter::IncrementCurrentEventFile() {
- DCHECK(task_runner_->RunsTasksInCurrentSequence());
- DCHECK(IsBounded());
- current_event_file_number_++;
- current_event_file_ = OpenFileForWrite(
- GetEventFilePath(FileNumberToIndex(current_event_file_number_)));
- current_event_file_size_ = 0;
- }
- base::FilePath FileNetLogObserver::FileWriter::GetEventFilePath(
- size_t index) const {
- DCHECK_LT(index, total_num_event_files_);
- DCHECK(IsBounded());
- return inprogress_dir_path_.AppendASCII(
- "event_file_" + base::NumberToString(index) + ".json");
- }
- base::FilePath FileNetLogObserver::FileWriter::GetConstantsFilePath() const {
- return inprogress_dir_path_.AppendASCII("constants.json");
- }
- base::FilePath FileNetLogObserver::FileWriter::GetClosingFilePath() const {
- return inprogress_dir_path_.AppendASCII("end_netlog.json");
- }
- size_t FileNetLogObserver::FileWriter::FileNumberToIndex(
- size_t file_number) const {
- DCHECK_GT(file_number, 0u);
- // Note that "file numbers" start at 1 not 0.
- return (file_number - 1) % total_num_event_files_;
- }
- void FileNetLogObserver::FileWriter::WriteConstantsToFile(
- std::unique_ptr<base::Value> constants_value,
- base::File* file) {
- // Print constants to file and open events array.
- std::string json = SerializeNetLogValueToJson(*constants_value);
- WriteToFile(file, "{\"constants\":", json, ",\n\"events\": [\n");
- }
- void FileNetLogObserver::FileWriter::WritePolledDataToFile(
- std::unique_ptr<base::Value> polled_data,
- base::File* file) {
- // Close the events array.
- WriteToFile(file, "]");
- // Write the polled data (if any).
- if (polled_data) {
- std::string polled_data_json;
- base::JSONWriter::Write(*polled_data, &polled_data_json);
- if (!polled_data_json.empty())
- WriteToFile(file, ",\n\"polledData\": ", polled_data_json, "\n");
- }
- // Close the log.
- WriteToFile(file, "}\n");
- }
- void FileNetLogObserver::FileWriter::RewindIfWroteEventBytes(
- base::File* file) const {
- if (file->IsValid() && wrote_event_bytes_) {
- // To be valid JSON the events array should not end with a comma. If events
- // were written though, they will have been terminated with "\n," so strip
- // it before closing the events array.
- file->Seek(base::File::FROM_END, -2);
- }
- }
- void FileNetLogObserver::FileWriter::StitchFinalLogFile() {
- // Make sure all the events files are flushed (as will read them next).
- current_event_file_.Close();
- // Allocate a 64K buffer used for reading the files. At most kReadBufferSize
- // bytes will be in memory at a time.
- const size_t kReadBufferSize = 1 << 16; // 64KiB
- auto read_buffer = std::make_unique<char[]>(kReadBufferSize);
- if (final_log_file_.IsValid()) {
- // Truncate the final log file.
- TruncateFile(&final_log_file_);
- // Append the constants file.
- AppendToFileThenDelete(GetConstantsFilePath(), &final_log_file_,
- read_buffer.get(), kReadBufferSize);
- // Iterate over the events files, from oldest to most recent, and append
- // them to the final destination. Note that "file numbers" start at 1 not 0.
- size_t end_filenumber = current_event_file_number_ + 1;
- size_t begin_filenumber =
- current_event_file_number_ <= total_num_event_files_
- ? 1
- : end_filenumber - total_num_event_files_;
- for (size_t filenumber = begin_filenumber; filenumber < end_filenumber;
- ++filenumber) {
- AppendToFileThenDelete(GetEventFilePath(FileNumberToIndex(filenumber)),
- &final_log_file_, read_buffer.get(),
- kReadBufferSize);
- }
- // Account for the final event line ending in a ",\n". Strip it to form
- // valid JSON.
- RewindIfWroteEventBytes(&final_log_file_);
- // Append the polled data.
- AppendToFileThenDelete(GetClosingFilePath(), &final_log_file_,
- read_buffer.get(), kReadBufferSize);
- }
- // Delete the inprogress directory (and anything that may still be left inside
- // it).
- base::DeletePathRecursively(inprogress_dir_path_);
- }
- void FileNetLogObserver::FileWriter::CreateInprogressDirectory() {
- DCHECK(IsBounded());
- // If an output file couldn't be created, either creation of intermediate
- // files will also fail (if they're in a sibling directory), or are they are
- // hidden somewhere the user would be unlikely to find them, so there is
- // little reason to progress.
- if (!final_log_file_.IsValid())
- return;
- if (!base::CreateDirectory(inprogress_dir_path_)) {
- LOG(WARNING) << "Failed creating directory: "
- << inprogress_dir_path_.value();
- return;
- }
- // It is OK if the path is wrong due to encoding - this is really just a
- // convenience display for the user in understanding what the file means.
- std::string in_progress_path = inprogress_dir_path_.AsUTF8Unsafe();
- // Since |final_log_file_| will not be written to until the very end, leave
- // some data in it explaining that the real data is currently in the
- // .inprogress directory. This ordinarily won't be visible (overwritten when
- // stopping) however if logging does not end gracefully the comments are
- // useful for recovery.
- WriteToFile(
- &final_log_file_, "Logging is in progress writing data to:\n ",
- in_progress_path,
- "\n\n"
- "That data will be stitched into a single file (this one) once logging\n"
- "has stopped.\n"
- "\n"
- "If logging was interrupted, you can stitch a NetLog file out of the\n"
- ".inprogress directory manually using:\n"
- "\n"
- "https://chromium.googlesource.com/chromium/src/+/main/net/tools/"
- "stitch_net_log_files.py\n");
- }
- std::string SerializeNetLogValueToJson(const base::Value& value) {
- // Omit trailing ".0" when printing a DOUBLE that is representable as a 64-bit
- // integer. This makes the values returned by NetLogNumberValue() look more
- // pleasant (for representing integers between 32 and 53 bits large).
- int options = base::JSONWriter::OPTIONS_OMIT_DOUBLE_TYPE_PRESERVATION;
- std::string json;
- bool ok = base::JSONWriter::WriteWithOptions(value, options, &json);
- // Serialization shouldn't fail. However it can if a consumer has passed a
- // parameter of type BINARY, since JSON serialization can't handle that.
- DCHECK(ok);
- return json;
- }
- } // namespace net
|