/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef ProfilerChild_h
#define ProfilerChild_h

#include "mozilla/BaseProfilerDetail.h"
#include "mozilla/DataMutex.h"
#include "mozilla/PProfilerChild.h"
#include "mozilla/ProfileBufferControlledChunkManager.h"
#include "mozilla/ProgressLogger.h"
#include "mozilla/RefPtr.h"
#include "ProfileAdditionalInformation.h"

class nsIThread;
struct PRThread;

namespace mozilla {

// The ProfilerChild actor is created in all processes except for the main
// process. The corresponding ProfilerParent actor is created in the main
// process, and it will notify us about profiler state changes and request
// profiles from us.
class ProfilerChild final : public PProfilerChild,
                            public mozilla::ipc::IShmemAllocator {
  NS_INLINE_DECL_THREADSAFE_REFCOUNTING(ProfilerChild, final)

  ProfilerChild();

  // Collects and returns a profile.
  // This method can be used to grab a profile just before PProfiler is torn
  // down. The collected profile should then be sent through a different
  // message channel that is guaranteed to stay open long enough.
  ProfileAndAdditionalInformation GrabShutdownProfile();

  void Destroy();

  // This should be called regularly from outside of the profiler lock.
  static void ProcessPendingUpdate();

  static bool IsLockedOnCurrentThread();

 private:
  virtual ~ProfilerChild();

  mozilla::ipc::IPCResult RecvStart(const ProfilerInitParams& params,
                                    StartResolver&& aResolve) override;
  mozilla::ipc::IPCResult RecvEnsureStarted(
      const ProfilerInitParams& params,
      EnsureStartedResolver&& aResolve) override;
  mozilla::ipc::IPCResult RecvStop(StopResolver&& aResolve) override;
  mozilla::ipc::IPCResult RecvPause(PauseResolver&& aResolve) override;
  mozilla::ipc::IPCResult RecvResume(ResumeResolver&& aResolve) override;
  mozilla::ipc::IPCResult RecvPauseSampling(
      PauseSamplingResolver&& aResolve) override;
  mozilla::ipc::IPCResult RecvResumeSampling(
      ResumeSamplingResolver&& aResolve) override;
  mozilla::ipc::IPCResult RecvWaitOnePeriodicSampling(
      WaitOnePeriodicSamplingResolver&& aResolve) override;
  mozilla::ipc::IPCResult RecvAwaitNextChunkManagerUpdate(
      AwaitNextChunkManagerUpdateResolver&& aResolve) override;
  mozilla::ipc::IPCResult RecvDestroyReleasedChunksAtOrBefore(
      const TimeStamp& aTimeStamp) override;
  mozilla::ipc::IPCResult RecvGatherProfile(
      GatherProfileResolver&& aResolve) override;
  mozilla::ipc::IPCResult RecvGetGatherProfileProgress(
      GetGatherProfileProgressResolver&& aResolve) override;
  mozilla::ipc::IPCResult RecvClearAllPages() override;

  void ActorDestroy(ActorDestroyReason aActorDestroyReason) override;

  FORWARD_SHMEM_ALLOCATOR_TO(PProfilerChild)

  void SetupChunkManager();
  void ResetChunkManager();
  void ResolveChunkUpdate(
      PProfilerChild::AwaitNextChunkManagerUpdateResolver& aResolve);
  void ProcessChunkManagerUpdate(
      ProfileBufferControlledChunkManager::Update&& aUpdate);

  void JoinGatherProfileThread();

  static void ClearPendingUpdate();

  static void GatherProfileThreadFunction(void* already_AddRefedParameters);

  nsCOMPtr<nsIThread> mThread;
  bool mDestroyed;

  ProfileBufferControlledChunkManager* mChunkManager = nullptr;
  AwaitNextChunkManagerUpdateResolver mAwaitNextChunkManagerUpdateResolver;
  ProfileBufferControlledChunkManager::Update mChunkManagerUpdate;

  struct ProfilerChildAndUpdate {
    RefPtr<ProfilerChild> mProfilerChild;
    ProfileBufferControlledChunkManager::Update mUpdate;
  };
  static DataMutexBase<ProfilerChildAndUpdate,
                       baseprofiler::detail::BaseProfilerMutex>
      sPendingChunkManagerUpdate;

  RefPtr<ProgressLogger::SharedProgress> mGatherProfileProgress;

  // Handle to the gather profile thread so we can join it.
  PRThread* mGatherProfileThread = nullptr;
};

}  // namespace mozilla

#endif  // ProfilerChild_h
