bbabf3480b
* re-do "Use the Perfetto SDK instead of ATRACE" (#8701) This time we create an entirely new private header: Tracing.h which uses the perfetto SDK instead of ATRACE. The old Systrace.h is unchanged to presever backward compatibility but is essentially deprecated and no longer used within the filament repo. The new TRACING_ macros use an explicit CATEGORY parameter, which is declared in Tracing.h. Moreover, tracing can be compiled out by defining FILAMENT_TRACING_ENABLED to false before including Tracing.h iOS tracing is still supported and still controlled via FILAMENT_APPLE_SYSTRACE. There are three perfetto categories defined: - "filament/filament" - "filament/jobsystem" - "filament/gltfio" The "filament/jobsystem" category is compiled out by default. And they can be enabled in AGI / perfetto by adding: ``` data_sources { config { name: "track_event" track_event_config { disabled_categories: "*" enabled_categories: "filament/filament" enabled_categories: "filament/jobsystem" enabled_categories: "filament/gltfio" } } } ``` * Update libs/utils/include/private/utils/Tracing.h Co-authored-by: Powei Feng <powei@google.com> * Update libs/utils/src/android/Tracing.cpp Co-authored-by: Powei Feng <powei@google.com> * remove all references to SYSTRACE_TAG --------- Co-authored-by: Powei Feng <powei@google.com>
99 lines
3.0 KiB
C++
99 lines
3.0 KiB
C++
/*
|
|
* Copyright (C) 2023 The Android Open Source Project
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#include <private/utils/Tracing.h>
|
|
|
|
#ifndef FILAMENT_APPLE_SYSTRACE
|
|
# define FILAMENT_APPLE_SYSTRACE 0
|
|
#endif
|
|
|
|
#if FILAMENT_APPLE_SYSTRACE
|
|
|
|
#include <atomic>
|
|
#include <stack>
|
|
#include <stdint.h>
|
|
#include <pthread.h>
|
|
|
|
static pthread_once_t atrace_once_control = PTHREAD_ONCE_INIT;
|
|
|
|
thread_local std::stack<const char*> ___tracerSections;
|
|
|
|
namespace utils {
|
|
namespace details {
|
|
|
|
Systrace::GlobalState Systrace::sGlobalState = {};
|
|
|
|
void Systrace::init_once() noexcept {
|
|
GlobalState& s = sGlobalState;
|
|
|
|
s.systraceLog = os_log_create("com.google.filament", "tracing");
|
|
s.frameIdLog = os_log_create("com.google.filament", "frameId");
|
|
}
|
|
|
|
void Systrace::setup() noexcept {
|
|
pthread_once(&atrace_once_control, init_once);
|
|
}
|
|
|
|
void Systrace::enable(const char* category) noexcept {
|
|
uitn32_t tag = 0;
|
|
if (std::string_view{category} == FILAMENT_TRACING_CATEGORY_FILAMENT) {
|
|
tag = 0;
|
|
} else if (std::string_view{category} == FILAMENT_TRACING_CATEGORY_JOBSYSTEM) {
|
|
tag = 1;
|
|
} else if (std::string_view{category} == FILAMENT_TRACING_CATEGORY_GLTFIO) {
|
|
tag = 2;
|
|
}
|
|
setup();
|
|
uint32_t const mask = 1 << tag;
|
|
sGlobalState.isTracingEnabled.fetch_or(mask, std::memory_order_relaxed);
|
|
}
|
|
|
|
void Systrace::disable(uint32_t tag) noexcept {
|
|
uint32_t const mask = 1 << tag;
|
|
sGlobalState.isTracingEnabled.fetch_and(~mask, std::memory_order_relaxed);
|
|
}
|
|
|
|
// Unfortunately, this generates quite a bit of code because reading a global is not
|
|
// trivial. For this reason, we do not inline this method.
|
|
bool Systrace::isTracingEnabled(uint32_t tag) noexcept {
|
|
if (tag) {
|
|
setup();
|
|
uint32_t const mask = 1 << tag;
|
|
return bool(sGlobalState.isTracingEnabled.load(std::memory_order_relaxed) & mask);
|
|
}
|
|
return false;
|
|
}
|
|
|
|
// ------------------------------------------------------------------------------------------------
|
|
|
|
void Systrace::init(const char* category) noexcept {
|
|
// must be called first
|
|
uitn32_t tag = 0;
|
|
if (std::string_view{category} == FILAMENT_TRACING_CATEGORY_FILAMENT) {
|
|
tag = 0;
|
|
} else if (std::string_view{category} == FILAMENT_TRACING_CATEGORY_JOBSYSTEM) {
|
|
tag = 1;
|
|
} else if (std::string_view{category} == FILAMENT_TRACING_CATEGORY_GLTFIO) {
|
|
tag = 2;
|
|
}
|
|
mIsTracingEnabled = isTracingEnabled(tag);
|
|
}
|
|
|
|
} // namespace details
|
|
} // namespace utils
|
|
|
|
#endif // FILAMENT_APPLE_SYSTRACE
|