blob: 3c24881d7cd0e73b8f78ae14a950d8bf2cf0831e [file] [log] [blame]
Adrian Roos1e1a1282017-11-01 19:05:31 +01001/*
2 * Copyright 2017 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 <layerproto/LayerProtoHeader.h>
20#include <utils/Errors.h>
Nataniel Borges2b796da2019-02-15 13:32:18 -080021#include <utils/StrongPointer.h>
Adrian Roos1e1a1282017-11-01 19:05:31 +010022
Nataniel Borges2b796da2019-02-15 13:32:18 -080023#include <android-base/thread_annotations.h>
24#include <condition_variable>
Chia-I Wua3e7ddc2018-09-20 11:42:46 -070025#include <memory>
Adrian Roos1e1a1282017-11-01 19:05:31 +010026#include <mutex>
Yichi Chen9c696ed2018-10-01 22:32:30 +080027#include <queue>
Nataniel Borges2b796da2019-02-15 13:32:18 -080028#include <thread>
Adrian Roos1e1a1282017-11-01 19:05:31 +010029
30using namespace android::surfaceflinger;
31
32namespace android {
33
Nataniel Borges2b796da2019-02-15 13:32:18 -080034class SurfaceFlinger;
35
Yichi Chen9c696ed2018-10-01 22:32:30 +080036constexpr auto operator""_MB(unsigned long long const num) {
37 return num * 1024 * 1024;
38}
Adrian Roos1e1a1282017-11-01 19:05:31 +010039/*
40 * SurfaceTracing records layer states during surface flinging.
41 */
42class SurfaceTracing {
43public:
Dominik Laskowski9dab3432019-03-27 13:21:10 -070044 explicit SurfaceTracing(SurfaceFlinger& flinger);
Nataniel Borges2b796da2019-02-15 13:32:18 -080045 void enable();
46 bool disable();
47 status_t writeToFile();
Yichi Chen9c696ed2018-10-01 22:32:30 +080048 bool isEnabled() const;
Nataniel Borges2b796da2019-02-15 13:32:18 -080049 void notify(const char* where);
50
51 void setBufferSize(size_t bufferSizeInByte);
52 void writeToFileAsync();
Yiwei Zhang5434a782018-12-05 18:06:32 -080053 void dump(std::string& result) const;
Adrian Roos1e1a1282017-11-01 19:05:31 +010054
Vishnu Nair9245d3b2019-03-22 13:38:56 -070055 enum : uint32_t {
56 TRACE_CRITICAL = 1 << 0,
57 TRACE_INPUT = 1 << 1,
58 TRACE_EXTRA = 1 << 2,
Alec Mouri6b9e9912020-01-21 10:50:24 -080059 TRACE_HWC = 1 << 3,
Vishnu Nair9245d3b2019-03-22 13:38:56 -070060 TRACE_ALL = 0xffffffff
61 };
62 void setTraceFlags(uint32_t flags);
63
Adrian Roos1e1a1282017-11-01 19:05:31 +010064private:
Robert Delgado626670f2019-06-27 15:55:27 -070065 static constexpr auto kDefaultBufferCapInByte = 5_MB;
Yichi Chen9c696ed2018-10-01 22:32:30 +080066 static constexpr auto kDefaultFileName = "/data/misc/wmtrace/layers_trace.pb";
67
68 class LayersTraceBuffer { // ring buffer
69 public:
70 size_t size() const { return mSizeInBytes; }
71 size_t used() const { return mUsedInBytes; }
72 size_t frameCount() const { return mStorage.size(); }
73
Nataniel Borges2b796da2019-02-15 13:32:18 -080074 void setSize(size_t newSize) { mSizeInBytes = newSize; }
Yichi Chen9c696ed2018-10-01 22:32:30 +080075 void reset(size_t newSize);
76 void emplace(LayersTraceProto&& proto);
77 void flush(LayersTraceFileProto* fileProto);
78
79 private:
80 size_t mUsedInBytes = 0U;
81 size_t mSizeInBytes = 0U;
82 std::queue<LayersTraceProto> mStorage;
83 };
Adrian Roos1e1a1282017-11-01 19:05:31 +010084
Nataniel Borges2b796da2019-02-15 13:32:18 -080085 void mainLoop();
Vishnu Nair9245d3b2019-03-22 13:38:56 -070086 void addFirstEntry();
87 LayersTraceProto traceWhenNotified();
88 LayersTraceProto traceLayersLocked(const char* where) REQUIRES(mSfLock);
89
90 // Returns true if trace is enabled.
91 bool addTraceToBuffer(LayersTraceProto& entry);
Nataniel Borges2b796da2019-02-15 13:32:18 -080092 void writeProtoFileLocked() REQUIRES(mTraceLock);
Adrian Roos1e1a1282017-11-01 19:05:31 +010093
Nataniel Borges2b796da2019-02-15 13:32:18 -080094 const SurfaceFlinger& mFlinger;
Nataniel Borges2b796da2019-02-15 13:32:18 -080095 status_t mLastErr = NO_ERROR;
96 std::thread mThread;
Vishnu Nair9245d3b2019-03-22 13:38:56 -070097 std::condition_variable mCanStartTrace;
Nataniel Borges2b796da2019-02-15 13:32:18 -080098
Vishnu Nair9245d3b2019-03-22 13:38:56 -070099 std::mutex& mSfLock;
100 uint32_t mTraceFlags GUARDED_BY(mSfLock) = TRACE_ALL;
101 const char* mWhere GUARDED_BY(mSfLock) = "";
102
103 mutable std::mutex mTraceLock;
Nataniel Borges2b796da2019-02-15 13:32:18 -0800104 LayersTraceBuffer mBuffer GUARDED_BY(mTraceLock);
105 size_t mBufferSize GUARDED_BY(mTraceLock) = kDefaultBufferCapInByte;
106 bool mEnabled GUARDED_BY(mTraceLock) = false;
107 bool mWriteToFile GUARDED_BY(mTraceLock) = false;
Adrian Roos1e1a1282017-11-01 19:05:31 +0100108};
109
110} // namespace android