diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 14:29:10 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 14:29:10 +0000 |
commit | 2aa4a82499d4becd2284cdb482213d541b8804dd (patch) | |
tree | b80bf8bf13c3766139fbacc530efd0dd9d54394c /toolkit/components/backgroundhangmonitor/HangAnnotations.h | |
parent | Initial commit. (diff) | |
download | firefox-upstream.tar.xz firefox-upstream.zip |
Adding upstream version 86.0.1.upstream/86.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'toolkit/components/backgroundhangmonitor/HangAnnotations.h')
-rw-r--r-- | toolkit/components/backgroundhangmonitor/HangAnnotations.h | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/toolkit/components/backgroundhangmonitor/HangAnnotations.h b/toolkit/components/backgroundhangmonitor/HangAnnotations.h new file mode 100644 index 0000000000..35a7be70f9 --- /dev/null +++ b/toolkit/components/backgroundhangmonitor/HangAnnotations.h @@ -0,0 +1,71 @@ +/* -*- 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_HangAnnotations_h +#define mozilla_HangAnnotations_h + +#include <set> + +#include "mozilla/HangTypes.h" +#include "mozilla/MemoryReporting.h" +#include "mozilla/Mutex.h" +#include "mozilla/Vector.h" +#include "nsString.h" +#include "nsTArray.h" +#include "mozilla/ipc/IPDLParamTraits.h" + +namespace mozilla { + +/** + * This class extends nsTArray<HangAnnotation> with some methods for adding + * annotations being reported by a registered hang Annotator. + */ +class BackgroundHangAnnotations : public nsTArray<HangAnnotation> { + public: + void AddAnnotation(const nsString& aName, const int32_t aData); + void AddAnnotation(const nsString& aName, const double aData); + void AddAnnotation(const nsString& aName, const nsString& aData); + void AddAnnotation(const nsString& aName, const nsCString& aData); + void AddAnnotation(const nsString& aName, const bool aData); +}; + +class BackgroundHangAnnotator { + public: + /** + * NB: This function is always called by the BackgroundHangMonitor thread. + * Plan accordingly. + */ + virtual void AnnotateHang(BackgroundHangAnnotations& aAnnotations) = 0; +}; + +class BackgroundHangAnnotators { + public: + BackgroundHangAnnotators(); + ~BackgroundHangAnnotators(); + + bool Register(BackgroundHangAnnotator& aAnnotator); + bool Unregister(BackgroundHangAnnotator& aAnnotator); + + BackgroundHangAnnotations GatherAnnotations(); + + private: + Mutex mMutex; + std::set<BackgroundHangAnnotator*> mAnnotators; +}; + +namespace ipc { + +template <> +struct IPDLParamTraits<mozilla::BackgroundHangAnnotations> + : public IPDLParamTraits<nsTArray<mozilla::HangAnnotation>> { + typedef mozilla::BackgroundHangAnnotations paramType; +}; + +} // namespace ipc + +} // namespace mozilla + +#endif // mozilla_HangAnnotations_h |