dom/ipc/MemoryReportRequest.h
author Nathan Froyd <froydnj@mozilla.com>
Wed, 02 Jan 2019 16:18:13 -0500
changeset 509416 7b71897ff6be49225613180bac536673a03bb7c0
parent 505383 6f3709b3878117466168c40affa7bca0b60cf75b
child 519700 1b3f624ca31a091a86b9bfd045589de388354b7b
permissions -rw-r--r--
Bug 1517276 - thread callbacks through MemoryReportRequestClient; r=mccr8 The guts of MemoryReportRequestClient's supporting runnables contain switches on the particular type of process we're running. If you're bringing up a new process type, having to add extra cases for your process type here is a bit onerous. These runnables really shouldn't know anything about the process types that they're running on, either. The easiest thing to do is modify MemoryReportRequestClient::Start to take callbacks for what to do when a report is created and when reporting is finished. Then all process-specific knowledge can be pushed out to the clients themselves, leaving MemoryReportRequestClient and friends process-type agnostic. We could even, at some later date, move this code into xpcom/base/ to sit near nsMemoryReporterManager, where it belongs.

/* -*- 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 mozilla_dom_MemoryReportRequest_h_
#define mozilla_dom_MemoryReportRequest_h_

#include "mozilla/dom/MemoryReportTypes.h"
#include "mozilla/ipc/FileDescriptor.h"
#include "nsISupports.h"

#include <functional>

class nsMemoryReporterManager;

namespace mozilla {
namespace dom {

class MaybeFileDesc;
class MemoryReport;

class MemoryReportRequestHost final {
 public:
  explicit MemoryReportRequestHost(uint32_t aGeneration);
  ~MemoryReportRequestHost();

  void RecvReport(const MemoryReport& aReport);
  void Finish(uint32_t aGeneration);

 private:
  const uint32_t mGeneration;
  // Non-null if we haven't yet called EndProcessReport() on it.
  RefPtr<nsMemoryReporterManager> mReporterManager;
  bool mSuccess;
};

class MemoryReportRequestClient final : public nsIRunnable {
 public:
  using ReportCallback = std::function<void(const MemoryReport&)>;
  using FinishCallback = std::function<bool(const uint32_t&)>;

  NS_DECL_ISUPPORTS

  static void Start(uint32_t aGeneration, bool aAnonymize,
                    bool aMinimizeMemoryUsage, const MaybeFileDesc& aDMDFile,
                    const nsACString& aProcessString,
                    const ReportCallback& aReportCallback,
                    const FinishCallback& aFinishCallback);

  NS_IMETHOD Run() override;

 private:
  MemoryReportRequestClient(uint32_t aGeneration, bool aAnonymize,
                            const MaybeFileDesc& aDMDFile,
                            const nsACString& aProcessString,
                            const ReportCallback& aReportCallback,
                            const FinishCallback& aFinishCallback);

 private:
  ~MemoryReportRequestClient();

  uint32_t mGeneration;
  bool mAnonymize;
  mozilla::ipc::FileDescriptor mDMDFile;
  nsCString mProcessString;
  ReportCallback mReportCallback;
  FinishCallback mFinishCallback;
};

}  // namespace dom
}  // namespace mozilla

#endif  // mozilla_dom_MemoryReportRequest_h_