mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Ruslan Shestopalyuk
62a28e4bdb
Summary: Changelog: [Internal] This implements the C++ side logic of handling `Performance.measure` calls. Since measures may refer to earlier logged marks by name, we need to keep track of the former. I also use a fixed size (circular) buffer to prevent the marks from piling forever. Also adds implementation of clearing marks/measures, as per standard. Reviewed By: mdvacca Differential Revision: D41756928 fbshipit-source-id: 19dce28d6af4c5646274e6d5db20b41869282780
104 lines
3.1 KiB
C++
104 lines
3.1 KiB
C++
/*
|
|
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <react/bridging/Function.h>
|
|
#include <array>
|
|
#include <functional>
|
|
#include <optional>
|
|
#include <unordered_set>
|
|
#include "NativePerformanceObserver.h"
|
|
|
|
namespace facebook::react {
|
|
|
|
struct PerformanceMark {
|
|
std::string name;
|
|
double timeStamp;
|
|
};
|
|
|
|
struct PerformanceMarkHash {
|
|
size_t operator()(const PerformanceMark *mark) const {
|
|
return std::hash<std::string>()(mark->name);
|
|
}
|
|
};
|
|
|
|
struct PerformanceMarkEqual {
|
|
bool operator()(const PerformanceMark *lhs, const PerformanceMark *rhs)
|
|
const {
|
|
return lhs->name == rhs->name;
|
|
}
|
|
};
|
|
|
|
using PerformanceMarkRegistryType = std::
|
|
unordered_set<PerformanceMark *, PerformanceMarkHash, PerformanceMarkEqual>;
|
|
|
|
// Only the MARKS_BUFFER_SIZE amount of the latest marks will be kept in
|
|
// memory for the sake of the "Performance.measure" mark name lookup
|
|
constexpr size_t MARKS_BUFFER_SIZE = 1024;
|
|
|
|
enum class PerformanceEntryType {
|
|
UNDEFINED = 0,
|
|
MARK = 1,
|
|
MEASURE = 2,
|
|
_COUNT = 3,
|
|
};
|
|
|
|
class PerformanceEntryReporter {
|
|
public:
|
|
PerformanceEntryReporter(PerformanceEntryReporter const &) = delete;
|
|
void operator=(PerformanceEntryReporter const &) = delete;
|
|
|
|
// NOTE: This class is not thread safe, make sure that the calls are made from
|
|
// the same thread.
|
|
// TODO: Consider passing it as a parameter to the corresponding modules at
|
|
// creation time instead of having the singleton.
|
|
static PerformanceEntryReporter &getInstance();
|
|
|
|
void setReportingCallback(std::optional<AsyncCallback<>> callback);
|
|
void startReporting(PerformanceEntryType entryType);
|
|
void stopReporting(PerformanceEntryType entryType);
|
|
|
|
const std::vector<RawPerformanceEntry> &getPendingEntries() const;
|
|
std::vector<RawPerformanceEntry> popPendingEntries();
|
|
void clearPendingEntries();
|
|
void logEntry(const RawPerformanceEntry &entry);
|
|
|
|
bool isReportingType(PerformanceEntryType entryType) const {
|
|
return reportingType_[static_cast<int>(entryType)];
|
|
}
|
|
|
|
void mark(const std::string &name, double startTime, double duration);
|
|
void clearMarks(const std::optional<std::string> &markName);
|
|
|
|
void measure(
|
|
const std::string &name,
|
|
double startTime,
|
|
double endTime,
|
|
const std::optional<double> &duration,
|
|
const std::optional<std::string> &startMark,
|
|
const std::optional<std::string> &endMark);
|
|
void clearMeasures(const std::optional<std::string> &measureName);
|
|
|
|
private:
|
|
PerformanceEntryReporter() {}
|
|
|
|
double getMarkTime(const std::string &markName) const;
|
|
void clearEntries(std::function<bool(const RawPerformanceEntry &)> predicate);
|
|
|
|
std::optional<AsyncCallback<>> callback_;
|
|
std::vector<RawPerformanceEntry> entries_;
|
|
std::array<bool, (size_t)PerformanceEntryType::_COUNT> reportingType_{false};
|
|
|
|
// Mark registry for "measure" lookup
|
|
PerformanceMarkRegistryType marks_registry_;
|
|
std::array<PerformanceMark, MARKS_BUFFER_SIZE> marks_buffer_;
|
|
size_t marks_buffer_position_{0};
|
|
};
|
|
|
|
} // namespace facebook::react
|