forked from mozilla/gecko-dev
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Bug 1848766 - Add PerformanceHintManager implementation to HAL. r=sma…
…ug,emilio,geckoview-reviewers,owlish PerformanceHintManager is an Android API that allows the caller to create a PerformanceHintSession, representing a workload shared by a group of threads that should be completed within a target duration each cycle. The actual duration spent working is reported each cycle, and the system can then adjust scheduling of the threads accordingly in order to hit the target going forward. This patch adds the API to HAL along with an Android implementation (and a nop fallback implementation for other platforms). Differential Revision: https://phabricator.services.mozilla.com/D186238
- Loading branch information
1 parent
fdf073c
commit f5ac319
Showing
6 changed files
with
270 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,206 @@ | ||
/* -*- 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 https://mozilla.org/MPL/2.0/. */ | ||
|
||
#include "Hal.h" | ||
#include "HalLog.h" | ||
#include "HalTypes.h" | ||
|
||
#include "AndroidBuild.h" | ||
|
||
#include <dlfcn.h> | ||
#include <stddef.h> | ||
#include <stdint.h> | ||
#include <sys/types.h> | ||
|
||
typedef struct APerformanceHintManager APerformanceHintManager; | ||
typedef struct APerformanceHintSession APerformanceHintSession; | ||
|
||
namespace mozilla { | ||
namespace hal_impl { | ||
|
||
#define LOAD_FN(api, lib, name) \ | ||
do { \ | ||
api->m##name = reinterpret_cast<Fn##name>(dlsym(handle, #name)); \ | ||
if (!api->m##name) { \ | ||
HAL_ERR("Failed to load %s", #name); \ | ||
return nullptr; \ | ||
} \ | ||
} while (false) | ||
|
||
class PerformanceHintManagerApi final { | ||
public: | ||
static PerformanceHintManagerApi* Get() { | ||
// C++ guarantees local static variable initialization is thread safe | ||
static UniquePtr<PerformanceHintManagerApi> api = Create(); | ||
return api.get(); | ||
} | ||
|
||
APerformanceHintManager* APerformanceHint_getManager() const { | ||
return mAPerformanceHint_getManager(); | ||
} | ||
|
||
APerformanceHintSession* APerformanceHint_createSession( | ||
APerformanceHintManager* manager, const int32_t* threadIds, size_t size, | ||
int64_t initialTargetWorkDurationNanos) const { | ||
return mAPerformanceHint_createSession(manager, threadIds, size, | ||
initialTargetWorkDurationNanos); | ||
} | ||
|
||
int APerformanceHint_updateTargetWorkDuration( | ||
APerformanceHintSession* session, int64_t targetDurationNanos) const { | ||
return mAPerformanceHint_updateTargetWorkDuration(session, | ||
targetDurationNanos); | ||
} | ||
|
||
int APerformanceHint_reportActualWorkDuration( | ||
APerformanceHintSession* session, int64_t actualDurationNanos) const { | ||
return mAPerformanceHint_reportActualWorkDuration(session, | ||
actualDurationNanos); | ||
} | ||
|
||
void APerformanceHint_closeSession(APerformanceHintSession* session) const { | ||
mAPerformanceHint_closeSession(session); | ||
} | ||
|
||
private: | ||
PerformanceHintManagerApi() = default; | ||
|
||
static UniquePtr<PerformanceHintManagerApi> Create() { | ||
if (mozilla::jni::GetAPIVersion() < __ANDROID_API_T__) { | ||
return nullptr; | ||
} | ||
|
||
void* const handle = dlopen("libandroid.so", RTLD_LAZY | RTLD_LOCAL); | ||
if (!handle) { | ||
HAL_ERR("Failed to open libandroid.so"); | ||
return nullptr; | ||
} | ||
|
||
auto api = WrapUnique(new PerformanceHintManagerApi()); | ||
LOAD_FN(api, handle, APerformanceHint_getManager); | ||
LOAD_FN(api, handle, APerformanceHint_createSession); | ||
LOAD_FN(api, handle, APerformanceHint_updateTargetWorkDuration); | ||
LOAD_FN(api, handle, APerformanceHint_reportActualWorkDuration); | ||
LOAD_FN(api, handle, APerformanceHint_closeSession); | ||
|
||
return api; | ||
} | ||
|
||
using FnAPerformanceHint_getManager = APerformanceHintManager* (*)(); | ||
using FnAPerformanceHint_createSession = | ||
APerformanceHintSession* (*)(APerformanceHintManager* manager, | ||
const int32_t* threadIds, size_t size, | ||
int64_t initialTargetWorkDurationNanos); | ||
using FnAPerformanceHint_updateTargetWorkDuration = | ||
int (*)(APerformanceHintSession* session, int64_t targetDurationNanos); | ||
using FnAPerformanceHint_reportActualWorkDuration = | ||
int (*)(APerformanceHintSession* session, int64_t actualDurationNanos); | ||
using FnAPerformanceHint_closeSession = | ||
void (*)(APerformanceHintSession* session); | ||
|
||
FnAPerformanceHint_getManager mAPerformanceHint_getManager = nullptr; | ||
FnAPerformanceHint_createSession mAPerformanceHint_createSession = nullptr; | ||
FnAPerformanceHint_updateTargetWorkDuration | ||
mAPerformanceHint_updateTargetWorkDuration = nullptr; | ||
FnAPerformanceHint_reportActualWorkDuration | ||
mAPerformanceHint_reportActualWorkDuration = nullptr; | ||
FnAPerformanceHint_closeSession mAPerformanceHint_closeSession = nullptr; | ||
}; | ||
|
||
class AndroidPerformanceHintSession final : public hal::PerformanceHintSession { | ||
public: | ||
// Creates a PerformanceHintSession wrapping the provided NDK | ||
// APerformanceHintSession instance. This assumes ownership of aSession, | ||
// therefore the caller must not close the session itself. | ||
explicit AndroidPerformanceHintSession(APerformanceHintSession* aSession) | ||
: mSession(aSession) {} | ||
|
||
AndroidPerformanceHintSession(AndroidPerformanceHintSession& aOther) = delete; | ||
AndroidPerformanceHintSession(AndroidPerformanceHintSession&& aOther) { | ||
mSession = aOther.mSession; | ||
aOther.mSession = nullptr; | ||
} | ||
|
||
~AndroidPerformanceHintSession() { | ||
if (mSession) { | ||
PerformanceHintManagerApi::Get()->APerformanceHint_closeSession(mSession); | ||
} | ||
} | ||
|
||
void UpdateTargetWorkDuration(TimeDuration aDuration) override { | ||
PerformanceHintManagerApi::Get()->APerformanceHint_updateTargetWorkDuration( | ||
mSession, aDuration.ToMicroseconds() * 1000); | ||
} | ||
|
||
void ReportActualWorkDuration(TimeDuration aDuration) override { | ||
PerformanceHintManagerApi::Get()->APerformanceHint_reportActualWorkDuration( | ||
mSession, aDuration.ToMicroseconds() * 1000); | ||
} | ||
|
||
private: | ||
APerformanceHintSession* mSession; | ||
}; | ||
|
||
static APerformanceHintManager* InitManager() { | ||
const auto* api = PerformanceHintManagerApi::Get(); | ||
if (!api) { | ||
return nullptr; | ||
} | ||
|
||
// At the time of writing we are only aware of PerformanceHintManager being | ||
// implemented on Tensor devices (Pixel 6 and 7 families). On most devices | ||
// createSession() will simply return null. However, on some devices | ||
// createSession() does return a session but scheduling does not appear to be | ||
// affected in any way. Rather than pretending to the caller that | ||
// PerformanceHintManager is available on such devices, return null allowing | ||
// them to use another means of achieving the performance they require. | ||
const auto socManufacturer = java::sdk::Build::SOC_MANUFACTURER()->ToString(); | ||
if (!socManufacturer.EqualsASCII("Google")) { | ||
return nullptr; | ||
} | ||
|
||
return api->APerformanceHint_getManager(); | ||
} | ||
|
||
UniquePtr<hal::PerformanceHintSession> CreatePerformanceHintSession( | ||
const nsTArray<PlatformThreadHandle>& aThreads, | ||
mozilla::TimeDuration aTargetWorkDuration) { | ||
#if __ANDROID_API__ < __ANDROID_API_L__ | ||
// pthread_gettid_np() (used below) didn't exist prior to lollipop. Currently | ||
// 32-bit builds use an older NDK minimum version than this, meaning we cannot | ||
// use this feature. But that's okay since only the very most recent devices | ||
// support PerformanceHintManager, and users will likely be running 64 bit | ||
// builds on them. This limitation will be removed when we next update the | ||
// minimum version in bug 1820295. | ||
return nullptr; | ||
#else | ||
|
||
// C++ guarantees local static variable initialization is thread safe | ||
static APerformanceHintManager* manager = InitManager(); | ||
|
||
if (!manager) { | ||
return nullptr; | ||
} | ||
|
||
const auto* api = PerformanceHintManagerApi::Get(); | ||
|
||
nsTArray<pid_t> tids(aThreads.Length()); | ||
std::transform(aThreads.cbegin(), aThreads.cend(), MakeBackInserter(tids), | ||
[](pthread_t handle) { return pthread_gettid_np(handle); }); | ||
|
||
APerformanceHintSession* session = api->APerformanceHint_createSession( | ||
manager, tids.Elements(), tids.Length(), | ||
aTargetWorkDuration.ToMicroseconds() * 1000); | ||
if (!session) { | ||
return nullptr; | ||
} | ||
|
||
return MakeUnique<AndroidPerformanceHintSession>(session); | ||
#endif | ||
} | ||
|
||
} // namespace hal_impl | ||
} // namespace mozilla |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ | ||
/* vim: set sw=2 ts=8 et ft=cpp : */ | ||
/* 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/. */ | ||
|
||
#include "Hal.h" | ||
|
||
namespace mozilla { | ||
namespace hal_impl { | ||
|
||
UniquePtr<hal::PerformanceHintSession> CreatePerformanceHintSession( | ||
const nsTArray<PlatformThreadHandle>& aThreads, | ||
mozilla::TimeDuration aTargetWorkDuration) { | ||
return nullptr; | ||
} | ||
|
||
} // namespace hal_impl | ||
} // namespace mozilla |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters