1 /* 2 * Copyright 2021 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 #pragma once 18 19 #include <android-base/thread_annotations.h> 20 #include <layerproto/LayerProtoHeader.h> 21 #include <utils/Errors.h> 22 #include <utils/StrongPointer.h> 23 #include <utils/Timers.h> 24 25 #include <memory> 26 #include <mutex> 27 28 using namespace android::surfaceflinger; 29 30 namespace android { 31 32 template <typename FileProto, typename EntryProto> 33 class RingBuffer; 34 35 class SurfaceFlinger; 36 37 /* 38 * LayerTracing records layer states during surface flinging. Manages tracing state and 39 * configuration. 40 */ 41 class LayerTracing { 42 public: 43 LayerTracing(); 44 ~LayerTracing(); 45 bool enable(); 46 bool disable(std::string filename = FILE_NAME, bool writeToFile = true); 47 void appendToStream(std::ofstream& out); 48 bool isEnabled() const; 49 status_t writeToFile(std::string filename = FILE_NAME); 50 static LayersTraceFileProto createTraceFileProto(); 51 void notify(bool visibleRegionDirty, int64_t time, int64_t vsyncId, LayersProto* layers, 52 std::string hwcDump, google::protobuf::RepeatedPtrField<DisplayProto>* displays); 53 54 enum : uint32_t { 55 TRACE_INPUT = 1 << 1, 56 TRACE_COMPOSITION = 1 << 2, 57 TRACE_EXTRA = 1 << 3, 58 TRACE_HWC = 1 << 4, 59 TRACE_BUFFERS = 1 << 5, 60 TRACE_VIRTUAL_DISPLAYS = 1 << 6, 61 TRACE_ALL = TRACE_INPUT | TRACE_COMPOSITION | TRACE_EXTRA, 62 }; 63 void setTraceFlags(uint32_t flags); 64 bool flagIsSet(uint32_t flags) const; 65 uint32_t getFlags() const; 66 void setBufferSize(size_t bufferSizeInBytes); 67 void dump(std::string&) const; 68 69 private: 70 static constexpr auto FILE_NAME = "/data/misc/wmtrace/layers_trace.winscope"; 71 uint32_t mFlags = TRACE_INPUT; 72 mutable std::mutex mTraceLock; 73 bool mEnabled GUARDED_BY(mTraceLock) = false; 74 std::unique_ptr<RingBuffer<LayersTraceFileProto, LayersTraceProto>> mBuffer 75 GUARDED_BY(mTraceLock); 76 size_t mBufferSizeInBytes GUARDED_BY(mTraceLock) = 20 * 1024 * 1024; 77 }; 78 79 } // namespace android 80