// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef SERVICES_TRACING_PUBLIC_CPP_STARTUP_TRACING_CONTROLLER_H_
#define SERVICES_TRACING_PUBLIC_CPP_STARTUP_TRACING_CONTROLLER_H_

#include <memory>
#include <optional>
#include <string_view>

#include "base/component_export.h"
#include "base/files/file_path.h"
#include "base/functional/callback.h"
#include "base/memory/weak_ptr.h"
#include "base/sequence_checker.h"
#include "base/synchronization/waitable_event.h"
#include "base/task/single_thread_task_runner.h"
#include "base/threading/sequence_bound.h"
#include "build/build_config.h"

namespace tracing {

// Class responsible for starting and stopping startup tracing as configured by
// StartupTracingConfig. All interactions with it are limited to UI thread, but
// the actual logic lives on a background ThreadPool sequence.
class COMPONENT_EXPORT(TRACING_CPP) StartupTracingController {
 public:
#if BUILDFLAG(IS_ANDROID)
  // Signature of the callback used to generate a path on Android.
  // The callback should return a FilePath matching the given basename.
  using AndroidPathGeneratorCallback =
      base::RepeatingCallback<base::FilePath(std::string_view)>;
#endif

  StartupTracingController(
#if BUILDFLAG(IS_ANDROID)
      AndroidPathGeneratorCallback android_path_generator_callback,
#endif
      scoped_refptr<base::SingleThreadTaskRunner> io_task_runner);
  ~StartupTracingController();

  // Stop the trace recording, write the trace to disk and block until complete.
  // Intended to be used in the situation when the browser process is going to
  // crash (e.g. DCHECK failure) and we want to avoid losing the trace data. Can
  // be called from any thread.
  // May not succeed if called from a sequence that is required to be responsive
  // during trace finalisation.
  static void EmergencyStop();

  void StartIfNeeded();

  void ShutdownAndWaitForStopIfNeeded();

  // By default, a trace is written into a temporary file which then is renamed,
  // however this can lead to data loss when the browser process crashes.
  // Embedders can disable this (especially if a name provided to
  // SetDefaultBasename makes it clear that the trace is incomplete and final
  // name will be provided via SetDefaultBasename call before calling Stop).
  enum class TempFilePolicy {
    kUseTemporaryFile,
    kWriteDirectly,
  };
  static void SetUsingTemporaryFile(TempFilePolicy temp_file_policy);

  // Set default basename for the trace output file to allow //content embedders
  // to customise it using some metadata (like test names).
  //
  // If --enable-trace-output is a directory (default value, empty, designated
  // "current directory"), then the startup trace will be written in a file with
  // the given basename in this directory. Depending on the |extension_type|,
  // an appropriate extension (.json or .proto) will be added.
  //
  // Note that embedders can call it even after tracing has started and Perfetto
  // started streaming the trace into it — in that case,
  // StartupTracingController will rename the file after finishing. However,
  // this is guaranteed to work only when tracing lasts until Stop() (not with
  // duration-based tracing).
  enum class ExtensionType {
    kAppendAppropriate,
    kNone,
  };
  static void SetDefaultBasename(std::string basename,
                                 ExtensionType extension_type);
  // As the test harness calls SetDefaultBasename, expose Override() version for
  // the tests checking the StartupTracingController logic itself.
  static void OverrideDefaultBasenameForTest(std::string basename,  // IN-TEST
                                             ExtensionType extension_type);

  bool is_finished_for_testing() const { return state_ == State::kStopped; }

 private:
  friend class TracingSessionCoordinator;
  class BackgroundTracer;
  base::SequenceBound<BackgroundTracer> StopInternal(
      base::OnceClosure on_finished_callback);
  void OnAutoStopped();
  static void SetDefaultBasenameInternal(std::string basename,
                                         ExtensionType extension_type);

  void OnStoppedOnUIThread();

  base::FilePath BasenameToPath(std::string_view basename);
  base::FilePath RebasePathIfNeeded(const base::FilePath& path);
  base::FilePath GetOutputPath();

  enum class State {
    kNotEnabled,
    kRunning,
    kStopped,
  };
  State state_ = State::kNotEnabled;

  // All actual interactions with the tracing service and the process of writing
  // files happens on a background thread.

  base::FilePath output_file_;

#if BUILDFLAG(IS_ANDROID)
  AndroidPathGeneratorCallback android_path_generator_callback_;
#endif
  scoped_refptr<base::SingleThreadTaskRunner> io_task_runner_;

  SEQUENCE_CHECKER(sequence_checker_);
};

}  // namespace tracing

#endif  // SERVICES_TRACING_PUBLIC_CPP_STARTUP_TRACING_CONTROLLER_H_