Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 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 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 17 | #ifndef SRC_TRACING_CORE_TRACING_SERVICE_IMPL_H_ |
| 18 | #define SRC_TRACING_CORE_TRACING_SERVICE_IMPL_H_ |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 19 | |
| 20 | #include <functional> |
| 21 | #include <map> |
| 22 | #include <memory> |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 23 | #include <set> |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 24 | |
Sami Kyostila | 32e0b54 | 2018-02-14 08:55:43 +0000 | [diff] [blame] | 25 | #include "gtest/gtest_prod.h" |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 26 | #include "perfetto/base/logging.h" |
Primiano Tucci | bbaa58c | 2017-12-20 13:48:20 +0100 | [diff] [blame] | 27 | #include "perfetto/base/page_allocator.h" |
Sami Kyostila | fbccb3c | 2018-03-21 14:00:47 +0000 | [diff] [blame] | 28 | #include "perfetto/base/time.h" |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 29 | #include "perfetto/base/weak_ptr.h" |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 30 | #include "perfetto/tracing/core/basic_types.h" |
Primiano Tucci | ecf9e4a | 2018-03-14 14:51:58 +0000 | [diff] [blame] | 31 | #include "perfetto/tracing/core/commit_data_request.h" |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 32 | #include "perfetto/tracing/core/data_source_descriptor.h" |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 33 | #include "perfetto/tracing/core/shared_memory_abi.h" |
Oystein Eftevaag | 1269b4a | 2018-01-10 16:29:38 -0800 | [diff] [blame] | 34 | #include "perfetto/tracing/core/trace_config.h" |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 35 | #include "perfetto/tracing/core/tracing_service.h" |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 36 | #include "src/tracing/core/id_allocator.h" |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 37 | |
| 38 | namespace perfetto { |
| 39 | |
| 40 | namespace base { |
| 41 | class TaskRunner; |
| 42 | } // namespace base |
| 43 | |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 44 | class Consumer; |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 45 | class DataSourceConfig; |
| 46 | class Producer; |
| 47 | class SharedMemory; |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 48 | class SharedMemoryArbiterImpl; |
Hector Dearman | 6214c8f | 2018-03-27 16:16:22 +0100 | [diff] [blame] | 49 | class TraceBuffer; |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 50 | class TraceConfig; |
Sami Kyostila | fbccb3c | 2018-03-21 14:00:47 +0000 | [diff] [blame] | 51 | class TracePacket; |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 52 | |
| 53 | // The tracing service business logic. |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 54 | class TracingServiceImpl : public TracingService { |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 55 | public: |
Primiano Tucci | 1a1951d | 2018-04-04 21:08:16 +0200 | [diff] [blame] | 56 | static constexpr size_t kDefaultShmSize = 256 * 1024ul; |
Primiano Tucci | e7ca7c6 | 2018-04-07 08:28:03 +0200 | [diff] [blame] | 57 | static constexpr size_t kMaxShmSize = 32 * 1024 * 1024ul; |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 58 | static constexpr uint32_t kDataSourceStopTimeoutMs = 5000; |
Primiano Tucci | 9754d0d | 2018-09-15 12:41:46 +0100 | [diff] [blame] | 59 | static constexpr uint8_t kSyncMarker[] = {0x82, 0x47, 0x7a, 0x76, 0xb2, 0x8d, |
| 60 | 0x42, 0xba, 0x81, 0xdc, 0x33, 0x32, |
| 61 | 0x6d, 0x57, 0xa0, 0x79}; |
Primiano Tucci | 1a1951d | 2018-04-04 21:08:16 +0200 | [diff] [blame] | 62 | |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 63 | // The implementation behind the service endpoint exposed to each producer. |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 64 | class ProducerEndpointImpl : public TracingService::ProducerEndpoint { |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 65 | public: |
| 66 | ProducerEndpointImpl(ProducerID, |
Sami Kyostila | 32e0b54 | 2018-02-14 08:55:43 +0000 | [diff] [blame] | 67 | uid_t uid, |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 68 | TracingServiceImpl*, |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 69 | base::TaskRunner*, |
Isabelle Taylor | 86262cb | 2018-03-27 16:00:54 +0100 | [diff] [blame] | 70 | Producer*, |
| 71 | const std::string& producer_name); |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 72 | ~ProducerEndpointImpl() override; |
| 73 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 74 | // TracingService::ProducerEndpoint implementation. |
Primiano Tucci | 9daa483 | 2018-03-28 23:28:17 +0100 | [diff] [blame] | 75 | void RegisterDataSource(const DataSourceDescriptor&) override; |
| 76 | void UnregisterDataSource(const std::string& name) override; |
Primiano Tucci | 3e69ed9 | 2018-03-14 14:52:29 +0000 | [diff] [blame] | 77 | void CommitData(const CommitDataRequest&, CommitDataCallback) override; |
Isabelle Taylor | 69faa90 | 2018-03-21 15:42:03 +0000 | [diff] [blame] | 78 | void SetSharedMemory(std::unique_ptr<SharedMemory>); |
Primiano Tucci | af429f9 | 2017-12-19 01:51:50 +0100 | [diff] [blame] | 79 | std::unique_ptr<TraceWriter> CreateTraceWriter(BufferID) override; |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 80 | void NotifyFlushComplete(FlushRequestID) override; |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 81 | void NotifyDataSourceStopped(DataSourceInstanceID) override; |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 82 | SharedMemory* shared_memory() const override; |
Isabelle Taylor | 69faa90 | 2018-03-21 15:42:03 +0000 | [diff] [blame] | 83 | size_t shared_buffer_page_size_kb() const override; |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 84 | |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 85 | void OnTracingSetup(); |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 86 | void SetupDataSource(DataSourceInstanceID, const DataSourceConfig&); |
Primiano Tucci | afb72b5 | 2018-09-25 09:37:24 +0100 | [diff] [blame] | 87 | void StartDataSource(DataSourceInstanceID, const DataSourceConfig&); |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 88 | void StopDataSource(DataSourceInstanceID); |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 89 | void Flush(FlushRequestID, const std::vector<DataSourceInstanceID>&); |
| 90 | |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 91 | private: |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 92 | friend class TracingServiceImpl; |
| 93 | friend class TracingServiceImplTest; |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 94 | ProducerEndpointImpl(const ProducerEndpointImpl&) = delete; |
| 95 | ProducerEndpointImpl& operator=(const ProducerEndpointImpl&) = delete; |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 96 | SharedMemoryArbiterImpl* GetOrCreateShmemArbiter(); |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 97 | |
| 98 | ProducerID const id_; |
Sami Kyostila | 32e0b54 | 2018-02-14 08:55:43 +0000 | [diff] [blame] | 99 | const uid_t uid_; |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 100 | TracingServiceImpl* const service_; |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 101 | base::TaskRunner* const task_runner_; |
| 102 | Producer* producer_; |
| 103 | std::unique_ptr<SharedMemory> shared_memory_; |
Isabelle Taylor | 69faa90 | 2018-03-21 15:42:03 +0000 | [diff] [blame] | 104 | size_t shared_buffer_page_size_kb_ = 0; |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 105 | SharedMemoryABI shmem_abi_; |
Primiano Tucci | 1a1951d | 2018-04-04 21:08:16 +0200 | [diff] [blame] | 106 | size_t shmem_size_hint_bytes_ = 0; |
Isabelle Taylor | 86262cb | 2018-03-27 16:00:54 +0100 | [diff] [blame] | 107 | const std::string name_; |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 108 | |
| 109 | // This is used only in in-process configurations (mostly tests). |
| 110 | std::unique_ptr<SharedMemoryArbiterImpl> inproc_shmem_arbiter_; |
Florian Mayer | cd08ec6 | 2018-01-31 17:49:25 +0000 | [diff] [blame] | 111 | PERFETTO_THREAD_CHECKER(thread_checker_) |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 112 | base::WeakPtrFactory<ProducerEndpointImpl> weak_ptr_factory_; // Keep last. |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 113 | }; |
| 114 | |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 115 | // The implementation behind the service endpoint exposed to each consumer. |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 116 | class ConsumerEndpointImpl : public TracingService::ConsumerEndpoint { |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 117 | public: |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 118 | ConsumerEndpointImpl(TracingServiceImpl*, base::TaskRunner*, Consumer*); |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 119 | ~ConsumerEndpointImpl() override; |
| 120 | |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 121 | void NotifyOnTracingDisabled(); |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 122 | base::WeakPtr<ConsumerEndpointImpl> GetWeakPtr(); |
| 123 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 124 | // TracingService::ConsumerEndpoint implementation. |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 125 | void EnableTracing(const TraceConfig&, base::ScopedFile) override; |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 126 | void StartTracing() override; |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 127 | void DisableTracing() override; |
| 128 | void ReadBuffers() override; |
| 129 | void FreeBuffers() override; |
Primiano Tucci | 3cbb10a | 2018-04-10 17:52:40 +0100 | [diff] [blame] | 130 | void Flush(uint32_t timeout_ms, FlushCallback) override; |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 131 | |
| 132 | private: |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 133 | friend class TracingServiceImpl; |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 134 | ConsumerEndpointImpl(const ConsumerEndpointImpl&) = delete; |
| 135 | ConsumerEndpointImpl& operator=(const ConsumerEndpointImpl&) = delete; |
| 136 | |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 137 | base::TaskRunner* const task_runner_; |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 138 | TracingServiceImpl* const service_; |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 139 | Consumer* const consumer_; |
Primiano Tucci | 20d441d | 2018-01-16 09:25:51 +0000 | [diff] [blame] | 140 | TracingSessionID tracing_session_id_ = 0; |
Florian Mayer | cd08ec6 | 2018-01-31 17:49:25 +0000 | [diff] [blame] | 141 | PERFETTO_THREAD_CHECKER(thread_checker_) |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 142 | base::WeakPtrFactory<ConsumerEndpointImpl> weak_ptr_factory_; // Keep last. |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 143 | }; |
| 144 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 145 | explicit TracingServiceImpl(std::unique_ptr<SharedMemory::Factory>, |
| 146 | base::TaskRunner*); |
| 147 | ~TracingServiceImpl() override; |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 148 | |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 149 | // Called by ProducerEndpointImpl. |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 150 | void DisconnectProducer(ProducerID); |
Primiano Tucci | 9daa483 | 2018-03-28 23:28:17 +0100 | [diff] [blame] | 151 | void RegisterDataSource(ProducerID, const DataSourceDescriptor&); |
| 152 | void UnregisterDataSource(ProducerID, const std::string& name); |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 153 | void CopyProducerPageIntoLogBuffer(ProducerID, |
Primiano Tucci | ecf9e4a | 2018-03-14 14:51:58 +0000 | [diff] [blame] | 154 | uid_t, |
| 155 | WriterID, |
| 156 | ChunkID, |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 157 | BufferID, |
Primiano Tucci | ecf9e4a | 2018-03-14 14:51:58 +0000 | [diff] [blame] | 158 | uint16_t num_fragments, |
| 159 | uint8_t chunk_flags, |
| 160 | const uint8_t* src, |
| 161 | size_t size); |
| 162 | void ApplyChunkPatches(ProducerID, |
| 163 | const std::vector<CommitDataRequest::ChunkToPatch>&); |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 164 | void NotifyFlushDoneForProducer(ProducerID, FlushRequestID); |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 165 | void NotifyDataSourceStopped(ProducerID, const DataSourceInstanceID); |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 166 | |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 167 | // Called by ConsumerEndpointImpl. |
| 168 | void DisconnectConsumer(ConsumerEndpointImpl*); |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 169 | bool EnableTracing(ConsumerEndpointImpl*, |
| 170 | const TraceConfig&, |
| 171 | base::ScopedFile); |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 172 | bool StartTracing(TracingSessionID); |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 173 | void DisableTracing(TracingSessionID, bool disable_immediately = false); |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 174 | void Flush(TracingSessionID tsid, |
Primiano Tucci | 3cbb10a | 2018-04-10 17:52:40 +0100 | [diff] [blame] | 175 | uint32_t timeout_ms, |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 176 | ConsumerEndpoint::FlushCallback); |
| 177 | void FlushAndDisableTracing(TracingSessionID); |
Primiano Tucci | 20d441d | 2018-01-16 09:25:51 +0000 | [diff] [blame] | 178 | void ReadBuffers(TracingSessionID, ConsumerEndpointImpl*); |
| 179 | void FreeBuffers(TracingSessionID); |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 180 | |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 181 | // Service implementation. |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 182 | std::unique_ptr<TracingService::ProducerEndpoint> ConnectProducer( |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 183 | Producer*, |
Sami Kyostila | 32e0b54 | 2018-02-14 08:55:43 +0000 | [diff] [blame] | 184 | uid_t uid, |
Isabelle Taylor | 86262cb | 2018-03-27 16:00:54 +0100 | [diff] [blame] | 185 | const std::string& producer_name, |
Isabelle Taylor | 69faa90 | 2018-03-21 15:42:03 +0000 | [diff] [blame] | 186 | size_t shared_memory_size_hint_bytes = 0) override; |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 187 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 188 | std::unique_ptr<TracingService::ConsumerEndpoint> ConnectConsumer( |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 189 | Consumer*) override; |
| 190 | |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 191 | // Exposed mainly for testing. |
| 192 | size_t num_producers() const { return producers_.size(); } |
| 193 | ProducerEndpointImpl* GetProducer(ProducerID) const; |
| 194 | |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 195 | uint32_t override_data_source_test_timeout_ms_for_testing = 0; |
| 196 | |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 197 | private: |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 198 | friend class TracingServiceImplTest; |
Primiano Tucci | 081d46a | 2018-02-28 11:09:43 +0000 | [diff] [blame] | 199 | |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 200 | struct RegisteredDataSource { |
| 201 | ProducerID producer_id; |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 202 | DataSourceDescriptor descriptor; |
| 203 | }; |
| 204 | |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 205 | // Represents an active data source for a tracing session. |
| 206 | struct DataSourceInstance { |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 207 | DataSourceInstance(const DataSourceInstance&) = delete; |
| 208 | DataSourceInstance& operator=(const DataSourceInstance&) = delete; |
| 209 | DataSourceInstance(DataSourceInstance&&) noexcept = default; |
| 210 | |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 211 | DataSourceInstanceID instance_id; |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 212 | DataSourceConfig config; |
Primiano Tucci | 9daa483 | 2018-03-28 23:28:17 +0100 | [diff] [blame] | 213 | std::string data_source_name; |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 214 | bool will_notify_on_stop; |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 215 | }; |
| 216 | |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 217 | struct PendingFlush { |
| 218 | std::set<ProducerID> producers; |
| 219 | ConsumerEndpoint::FlushCallback callback; |
| 220 | explicit PendingFlush(decltype(callback) cb) : callback(std::move(cb)) {} |
| 221 | }; |
| 222 | |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 223 | // Holds the state of a tracing session. A tracing session is uniquely bound |
| 224 | // a specific Consumer. Each Consumer can own one or more sessions. |
| 225 | struct TracingSession { |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 226 | enum State { |
| 227 | DISABLED = 0, |
| 228 | CONFIGURED, |
| 229 | STARTED, |
| 230 | DISABLING_WAITING_STOP_ACKS |
| 231 | }; |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 232 | |
| 233 | TracingSession(TracingSessionID, ConsumerEndpointImpl*, const TraceConfig&); |
Primiano Tucci | 20d441d | 2018-01-16 09:25:51 +0000 | [diff] [blame] | 234 | |
| 235 | size_t num_buffers() const { return buffers_index.size(); } |
| 236 | |
Primiano Tucci | 3cbb10a | 2018-04-10 17:52:40 +0100 | [diff] [blame] | 237 | uint32_t delay_to_next_write_period_ms() const { |
Sami Kyostila | 01c45f0 | 2018-03-29 15:43:10 +0100 | [diff] [blame] | 238 | PERFETTO_DCHECK(write_period_ms > 0); |
| 239 | return write_period_ms - |
| 240 | (base::GetWallTimeMs().count() % write_period_ms); |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 241 | } |
| 242 | |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 243 | const TracingSessionID id; |
| 244 | |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 245 | // The consumer that started the session. |
| 246 | ConsumerEndpointImpl* const consumer; |
| 247 | |
Primiano Tucci | 20d441d | 2018-01-16 09:25:51 +0000 | [diff] [blame] | 248 | // The original trace config provided by the Consumer when calling |
| 249 | // EnableTracing(). |
| 250 | const TraceConfig config; |
Oystein Eftevaag | 1269b4a | 2018-01-10 16:29:38 -0800 | [diff] [blame] | 251 | |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 252 | // List of data source instances that have been enabled on the various |
| 253 | // producers for this tracing session. |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 254 | std::multimap<ProducerID, DataSourceInstance> data_source_instances; |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 255 | |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 256 | // For each Flush(N) request, keeps track of the set of producers for which |
| 257 | // we are still awaiting a NotifyFlushComplete(N) ack. |
| 258 | std::map<FlushRequestID, PendingFlush> pending_flushes; |
| 259 | |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 260 | // After DisableTracing() is called, this contains the subset of data |
| 261 | // sources that did set the |will_notify_on_stop| flag upon registration and |
| 262 | // that have the haven't replied yet to the stop request. |
| 263 | std::set<std::pair<ProducerID, DataSourceInstanceID>> pending_stop_acks; |
| 264 | |
Primiano Tucci | 20d441d | 2018-01-16 09:25:51 +0000 | [diff] [blame] | 265 | // Maps a per-trace-session buffer index into the corresponding global |
| 266 | // BufferID (shared namespace amongst all consumers). This vector has as |
| 267 | // many entries as |config.buffers_size()|. |
| 268 | std::vector<BufferID> buffers_index; |
Sami Kyostila | fbccb3c | 2018-03-21 14:00:47 +0000 | [diff] [blame] | 269 | |
Primiano Tucci | 9754d0d | 2018-09-15 12:41:46 +0100 | [diff] [blame] | 270 | // When the last snapshots (clock, stats, sync marker) were emitted into |
| 271 | // the output stream. |
| 272 | base::TimeMillis last_snapshot_time = {}; |
Primiano Tucci | 5e33cad | 2018-04-30 14:41:25 +0100 | [diff] [blame] | 273 | |
Sami Kyostila | 200bd2e | 2018-03-26 12:24:10 +0100 | [diff] [blame] | 274 | // Whether we mirrored the trace config back to the trace output yet. |
| 275 | bool did_emit_config = false; |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 276 | |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 277 | State state = DISABLED; |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 278 | |
| 279 | // This is set when the Consumer calls sets |write_into_file| == true in the |
| 280 | // TraceConfig. In this case this represents the file we should stream the |
| 281 | // trace packets into, rather than returning it to the consumer via |
| 282 | // OnTraceData(). |
| 283 | base::ScopedFile write_into_file; |
Primiano Tucci | 3cbb10a | 2018-04-10 17:52:40 +0100 | [diff] [blame] | 284 | uint32_t write_period_ms = 0; |
| 285 | uint64_t max_file_size_bytes = 0; |
| 286 | uint64_t bytes_written_into_file = 0; |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 287 | }; |
| 288 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 289 | TracingServiceImpl(const TracingServiceImpl&) = delete; |
| 290 | TracingServiceImpl& operator=(const TracingServiceImpl&) = delete; |
Primiano Tucci | 20d441d | 2018-01-16 09:25:51 +0000 | [diff] [blame] | 291 | |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 292 | DataSourceInstance* SetupDataSource(const TraceConfig::DataSource&, |
| 293 | const TraceConfig::ProducerConfig&, |
| 294 | const RegisteredDataSource&, |
| 295 | TracingSession*); |
Oystein Eftevaag | 1269b4a | 2018-01-10 16:29:38 -0800 | [diff] [blame] | 296 | |
Primiano Tucci | 081d46a | 2018-02-28 11:09:43 +0000 | [diff] [blame] | 297 | // Returns the next available ProducerID that is not in |producers_|. |
| 298 | ProducerID GetNextProducerID(); |
| 299 | |
Primiano Tucci | 20d441d | 2018-01-16 09:25:51 +0000 | [diff] [blame] | 300 | // Returns a pointer to the |tracing_sessions_| entry or nullptr if the |
| 301 | // session doesn't exists. |
| 302 | TracingSession* GetTracingSession(TracingSessionID); |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 303 | |
Lalit Maganti | 485faff | 2018-03-06 11:51:35 +0000 | [diff] [blame] | 304 | // Update the memory guard rail by using the latest information from the |
| 305 | // shared memory and trace buffers. |
| 306 | void UpdateMemoryGuardrail(); |
| 307 | |
Primiano Tucci | 9754d0d | 2018-09-15 12:41:46 +0100 | [diff] [blame] | 308 | void SnapshotSyncMarker(std::vector<TracePacket>*); |
| 309 | void SnapshotClocks(std::vector<TracePacket>*); |
| 310 | void SnapshotStats(TracingSession*, std::vector<TracePacket>*); |
Sami Kyostila | 200bd2e | 2018-03-26 12:24:10 +0100 | [diff] [blame] | 311 | void MaybeEmitTraceConfig(TracingSession*, std::vector<TracePacket>*); |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 312 | void OnFlushTimeout(TracingSessionID, FlushRequestID); |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 313 | void OnDisableTracingTimeout(TracingSessionID); |
| 314 | void DisableTracingNotifyConsumerAndFlushFile(TracingSession*); |
Hector Dearman | 6214c8f | 2018-03-27 16:16:22 +0100 | [diff] [blame] | 315 | TraceBuffer* GetBufferByID(BufferID); |
Primiano Tucci | ecf9e4a | 2018-03-14 14:51:58 +0000 | [diff] [blame] | 316 | |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 317 | base::TaskRunner* const task_runner_; |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 318 | std::unique_ptr<SharedMemory::Factory> shm_factory_; |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 319 | ProducerID last_producer_id_ = 0; |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 320 | DataSourceInstanceID last_data_source_instance_id_ = 0; |
Primiano Tucci | 20d441d | 2018-01-16 09:25:51 +0000 | [diff] [blame] | 321 | TracingSessionID last_tracing_session_id_ = 0; |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 322 | FlushRequestID last_flush_request_id_ = 0; |
Primiano Tucci | 5e33cad | 2018-04-30 14:41:25 +0100 | [diff] [blame] | 323 | uid_t uid_ = 0; |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 324 | |
| 325 | // Buffer IDs are global across all consumers (because a Producer can produce |
| 326 | // data for more than one trace session, hence more than one consumer). |
Primiano Tucci | 20d441d | 2018-01-16 09:25:51 +0000 | [diff] [blame] | 327 | IdAllocator<BufferID> buffer_ids_; |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 328 | |
| 329 | std::multimap<std::string /*name*/, RegisteredDataSource> data_sources_; |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 330 | std::map<ProducerID, ProducerEndpointImpl*> producers_; |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 331 | std::set<ConsumerEndpointImpl*> consumers_; |
Primiano Tucci | 20d441d | 2018-01-16 09:25:51 +0000 | [diff] [blame] | 332 | std::map<TracingSessionID, TracingSession> tracing_sessions_; |
Hector Dearman | 6214c8f | 2018-03-27 16:16:22 +0100 | [diff] [blame] | 333 | std::map<BufferID, std::unique_ptr<TraceBuffer>> buffers_; |
Primiano Tucci | 20d441d | 2018-01-16 09:25:51 +0000 | [diff] [blame] | 334 | |
Florian Mayer | 61c5548 | 2018-03-06 14:43:54 +0000 | [diff] [blame] | 335 | bool lockdown_mode_ = false; |
Primiano Tucci | 9754d0d | 2018-09-15 12:41:46 +0100 | [diff] [blame] | 336 | uint32_t min_write_period_ms_ = 100; // Overridable for testing. |
| 337 | |
| 338 | uint8_t sync_marker_packet_[32]; // Lazily initialized. |
| 339 | size_t sync_marker_packet_size_ = 0; |
Florian Mayer | 61c5548 | 2018-03-06 14:43:54 +0000 | [diff] [blame] | 340 | |
Florian Mayer | cd08ec6 | 2018-01-31 17:49:25 +0000 | [diff] [blame] | 341 | PERFETTO_THREAD_CHECKER(thread_checker_) |
| 342 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 343 | base::WeakPtrFactory<TracingServiceImpl> |
| 344 | weak_ptr_factory_; // Keep at the end. |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 345 | }; |
| 346 | |
| 347 | } // namespace perfetto |
| 348 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 349 | #endif // SRC_TRACING_CORE_TRACING_SERVICE_IMPL_H_ |