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 | 14219ff | 2019-02-27 12:41:05 +0100 | [diff] [blame^] | 23 | #include <mutex> |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 24 | #include <set> |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 25 | |
Eric Seckler | 57c89d9 | 2018-10-26 15:11:55 +0100 | [diff] [blame] | 26 | #include "perfetto/base/gtest_prod_util.h" |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 27 | #include "perfetto/base/logging.h" |
Eric Seckler | f3f524b | 2018-12-13 09:09:34 +0000 | [diff] [blame] | 28 | #include "perfetto/base/optional.h" |
Sami Kyostila | fbccb3c | 2018-03-21 14:00:47 +0000 | [diff] [blame] | 29 | #include "perfetto/base/time.h" |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 30 | #include "perfetto/base/weak_ptr.h" |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 31 | #include "perfetto/tracing/core/basic_types.h" |
Primiano Tucci | ecf9e4a | 2018-03-14 14:51:58 +0000 | [diff] [blame] | 32 | #include "perfetto/tracing/core/commit_data_request.h" |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 33 | #include "perfetto/tracing/core/data_source_descriptor.h" |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 34 | #include "perfetto/tracing/core/shared_memory_abi.h" |
Oystein Eftevaag | 1269b4a | 2018-01-10 16:29:38 -0800 | [diff] [blame] | 35 | #include "perfetto/tracing/core/trace_config.h" |
Eric Seckler | eaf29ed | 2019-01-23 09:53:55 +0000 | [diff] [blame] | 36 | #include "perfetto/tracing/core/trace_stats.h" |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 37 | #include "perfetto/tracing/core/tracing_service.h" |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 38 | #include "src/tracing/core/id_allocator.h" |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 39 | |
| 40 | namespace perfetto { |
| 41 | |
| 42 | namespace base { |
| 43 | class TaskRunner; |
| 44 | } // namespace base |
| 45 | |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 46 | class Consumer; |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 47 | class DataSourceConfig; |
| 48 | class Producer; |
| 49 | class SharedMemory; |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 50 | class SharedMemoryArbiterImpl; |
Hector Dearman | 6214c8f | 2018-03-27 16:16:22 +0100 | [diff] [blame] | 51 | class TraceBuffer; |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 52 | class TraceConfig; |
Sami Kyostila | fbccb3c | 2018-03-21 14:00:47 +0000 | [diff] [blame] | 53 | class TracePacket; |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 54 | |
| 55 | // The tracing service business logic. |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 56 | class TracingServiceImpl : public TracingService { |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 57 | public: |
Primiano Tucci | 1a1951d | 2018-04-04 21:08:16 +0200 | [diff] [blame] | 58 | static constexpr size_t kDefaultShmSize = 256 * 1024ul; |
Primiano Tucci | e7ca7c6 | 2018-04-07 08:28:03 +0200 | [diff] [blame] | 59 | static constexpr size_t kMaxShmSize = 32 * 1024 * 1024ul; |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 60 | static constexpr uint32_t kDataSourceStopTimeoutMs = 5000; |
Primiano Tucci | 9754d0d | 2018-09-15 12:41:46 +0100 | [diff] [blame] | 61 | static constexpr uint8_t kSyncMarker[] = {0x82, 0x47, 0x7a, 0x76, 0xb2, 0x8d, |
| 62 | 0x42, 0xba, 0x81, 0xdc, 0x33, 0x32, |
| 63 | 0x6d, 0x57, 0xa0, 0x79}; |
Primiano Tucci | 1a1951d | 2018-04-04 21:08:16 +0200 | [diff] [blame] | 64 | |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 65 | // The implementation behind the service endpoint exposed to each producer. |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 66 | class ProducerEndpointImpl : public TracingService::ProducerEndpoint { |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 67 | public: |
| 68 | ProducerEndpointImpl(ProducerID, |
Sami Kyostila | 32e0b54 | 2018-02-14 08:55:43 +0000 | [diff] [blame] | 69 | uid_t uid, |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 70 | TracingServiceImpl*, |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 71 | base::TaskRunner*, |
Isabelle Taylor | 86262cb | 2018-03-27 16:00:54 +0100 | [diff] [blame] | 72 | Producer*, |
| 73 | const std::string& producer_name); |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 74 | ~ProducerEndpointImpl() override; |
| 75 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 76 | // TracingService::ProducerEndpoint implementation. |
Primiano Tucci | 9daa483 | 2018-03-28 23:28:17 +0100 | [diff] [blame] | 77 | void RegisterDataSource(const DataSourceDescriptor&) override; |
| 78 | void UnregisterDataSource(const std::string& name) override; |
Eric Seckler | 1c4e1ac | 2018-11-29 10:23:14 +0000 | [diff] [blame] | 79 | void RegisterTraceWriter(uint32_t writer_id, |
| 80 | uint32_t target_buffer) override; |
| 81 | void UnregisterTraceWriter(uint32_t writer_id) override; |
Primiano Tucci | 3e69ed9 | 2018-03-14 14:52:29 +0000 | [diff] [blame] | 82 | void CommitData(const CommitDataRequest&, CommitDataCallback) override; |
Isabelle Taylor | 69faa90 | 2018-03-21 15:42:03 +0000 | [diff] [blame] | 83 | void SetSharedMemory(std::unique_ptr<SharedMemory>); |
Primiano Tucci | af429f9 | 2017-12-19 01:51:50 +0100 | [diff] [blame] | 84 | std::unique_ptr<TraceWriter> CreateTraceWriter(BufferID) override; |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 85 | void NotifyFlushComplete(FlushRequestID) override; |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 86 | void NotifyDataSourceStopped(DataSourceInstanceID) override; |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 87 | SharedMemory* shared_memory() const override; |
Isabelle Taylor | 69faa90 | 2018-03-21 15:42:03 +0000 | [diff] [blame] | 88 | size_t shared_buffer_page_size_kb() const override; |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 89 | |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 90 | void OnTracingSetup(); |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame] | 91 | void SetupDataSource(DataSourceInstanceID, const DataSourceConfig&); |
Primiano Tucci | afb72b5 | 2018-09-25 09:37:24 +0100 | [diff] [blame] | 92 | void StartDataSource(DataSourceInstanceID, const DataSourceConfig&); |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame] | 93 | void StopDataSource(DataSourceInstanceID); |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 94 | void Flush(FlushRequestID, const std::vector<DataSourceInstanceID>&); |
Eric Seckler | 6dc2359 | 2018-11-30 10:59:06 +0000 | [diff] [blame] | 95 | void OnFreeBuffers(const std::vector<BufferID>& target_buffers); |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 96 | |
Eric Seckler | dd0ad10 | 2018-12-06 11:32:04 +0000 | [diff] [blame] | 97 | bool is_allowed_target_buffer(BufferID buffer_id) const { |
| 98 | return allowed_target_buffers_.count(buffer_id); |
| 99 | } |
| 100 | |
Eric Seckler | f3f524b | 2018-12-13 09:09:34 +0000 | [diff] [blame] | 101 | base::Optional<BufferID> buffer_id_for_writer(WriterID writer_id) const { |
| 102 | const auto it = writers_.find(writer_id); |
| 103 | if (it != writers_.end()) |
| 104 | return it->second; |
| 105 | return base::nullopt; |
| 106 | } |
| 107 | |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 108 | private: |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 109 | friend class TracingServiceImpl; |
| 110 | friend class TracingServiceImplTest; |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 111 | ProducerEndpointImpl(const ProducerEndpointImpl&) = delete; |
| 112 | ProducerEndpointImpl& operator=(const ProducerEndpointImpl&) = delete; |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 113 | SharedMemoryArbiterImpl* GetOrCreateShmemArbiter(); |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 114 | |
| 115 | ProducerID const id_; |
Sami Kyostila | 32e0b54 | 2018-02-14 08:55:43 +0000 | [diff] [blame] | 116 | const uid_t uid_; |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 117 | TracingServiceImpl* const service_; |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 118 | base::TaskRunner* const task_runner_; |
| 119 | Producer* producer_; |
| 120 | std::unique_ptr<SharedMemory> shared_memory_; |
Isabelle Taylor | 69faa90 | 2018-03-21 15:42:03 +0000 | [diff] [blame] | 121 | size_t shared_buffer_page_size_kb_ = 0; |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 122 | SharedMemoryABI shmem_abi_; |
Primiano Tucci | 1a1951d | 2018-04-04 21:08:16 +0200 | [diff] [blame] | 123 | size_t shmem_size_hint_bytes_ = 0; |
Isabelle Taylor | 86262cb | 2018-03-27 16:00:54 +0100 | [diff] [blame] | 124 | const std::string name_; |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 125 | |
Eric Seckler | 6dc2359 | 2018-11-30 10:59:06 +0000 | [diff] [blame] | 126 | // Set of the global target_buffer IDs that the producer is configured to |
| 127 | // write into in any active tracing session. |
| 128 | std::set<BufferID> allowed_target_buffers_; |
| 129 | |
Eric Seckler | f3f524b | 2018-12-13 09:09:34 +0000 | [diff] [blame] | 130 | // Maps registered TraceWriter IDs to their target buffers as registered by |
| 131 | // the producer. Note that producers aren't required to register their |
| 132 | // writers, so we may see commits of chunks with WriterIDs that aren't |
| 133 | // contained in this map. However, if a producer does register a writer, the |
| 134 | // service will prevent the writer from writing into any other buffer than |
| 135 | // the one associated with it here. The BufferIDs stored in this map are |
| 136 | // untrusted, so need to be verified against |allowed_target_buffers_| |
| 137 | // before use. |
| 138 | std::map<WriterID, BufferID> writers_; |
| 139 | |
Primiano Tucci | 14219ff | 2019-02-27 12:41:05 +0100 | [diff] [blame^] | 140 | // This is used only in in-process configurations. The mutex protects |
| 141 | // concurrent construction of |inproc_shmem_arbiter_|. |
| 142 | // SharedMemoryArbiterImpl methods themselves are thread-safe. |
| 143 | std::mutex inproc_shmem_arbiter_mutex_; |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 144 | std::unique_ptr<SharedMemoryArbiterImpl> inproc_shmem_arbiter_; |
Primiano Tucci | 14219ff | 2019-02-27 12:41:05 +0100 | [diff] [blame^] | 145 | |
Florian Mayer | cd08ec6 | 2018-01-31 17:49:25 +0000 | [diff] [blame] | 146 | PERFETTO_THREAD_CHECKER(thread_checker_) |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 147 | base::WeakPtrFactory<ProducerEndpointImpl> weak_ptr_factory_; // Keep last. |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 148 | }; |
| 149 | |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 150 | // The implementation behind the service endpoint exposed to each consumer. |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 151 | class ConsumerEndpointImpl : public TracingService::ConsumerEndpoint { |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 152 | public: |
Primiano Tucci | 9ba1d84 | 2018-12-20 17:31:04 +0100 | [diff] [blame] | 153 | ConsumerEndpointImpl(TracingServiceImpl*, |
| 154 | base::TaskRunner*, |
| 155 | Consumer*, |
| 156 | uid_t uid); |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 157 | ~ConsumerEndpointImpl() override; |
| 158 | |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 159 | void NotifyOnTracingDisabled(); |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 160 | base::WeakPtr<ConsumerEndpointImpl> GetWeakPtr(); |
| 161 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 162 | // TracingService::ConsumerEndpoint implementation. |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 163 | void EnableTracing(const TraceConfig&, base::ScopedFile) override; |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame] | 164 | void StartTracing() override; |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 165 | void DisableTracing() override; |
| 166 | void ReadBuffers() override; |
| 167 | void FreeBuffers() override; |
Primiano Tucci | 3cbb10a | 2018-04-10 17:52:40 +0100 | [diff] [blame] | 168 | void Flush(uint32_t timeout_ms, FlushCallback) override; |
Primiano Tucci | 9ba1d84 | 2018-12-20 17:31:04 +0100 | [diff] [blame] | 169 | void Detach(const std::string& key) override; |
| 170 | void Attach(const std::string& key) override; |
Eric Seckler | eaf29ed | 2019-01-23 09:53:55 +0000 | [diff] [blame] | 171 | void GetTraceStats() override; |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 172 | |
| 173 | private: |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 174 | friend class TracingServiceImpl; |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 175 | ConsumerEndpointImpl(const ConsumerEndpointImpl&) = delete; |
| 176 | ConsumerEndpointImpl& operator=(const ConsumerEndpointImpl&) = delete; |
| 177 | |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 178 | base::TaskRunner* const task_runner_; |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 179 | TracingServiceImpl* const service_; |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 180 | Consumer* const consumer_; |
Primiano Tucci | 9ba1d84 | 2018-12-20 17:31:04 +0100 | [diff] [blame] | 181 | uid_t const uid_; |
Primiano Tucci | 20d441d | 2018-01-16 09:25:51 +0000 | [diff] [blame] | 182 | TracingSessionID tracing_session_id_ = 0; |
Florian Mayer | cd08ec6 | 2018-01-31 17:49:25 +0000 | [diff] [blame] | 183 | PERFETTO_THREAD_CHECKER(thread_checker_) |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 184 | base::WeakPtrFactory<ConsumerEndpointImpl> weak_ptr_factory_; // Keep last. |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 185 | }; |
| 186 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 187 | explicit TracingServiceImpl(std::unique_ptr<SharedMemory::Factory>, |
| 188 | base::TaskRunner*); |
| 189 | ~TracingServiceImpl() override; |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 190 | |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 191 | // Called by ProducerEndpointImpl. |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 192 | void DisconnectProducer(ProducerID); |
Primiano Tucci | 9daa483 | 2018-03-28 23:28:17 +0100 | [diff] [blame] | 193 | void RegisterDataSource(ProducerID, const DataSourceDescriptor&); |
| 194 | void UnregisterDataSource(ProducerID, const std::string& name); |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 195 | void CopyProducerPageIntoLogBuffer(ProducerID, |
Primiano Tucci | ecf9e4a | 2018-03-14 14:51:58 +0000 | [diff] [blame] | 196 | uid_t, |
| 197 | WriterID, |
| 198 | ChunkID, |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 199 | BufferID, |
Primiano Tucci | ecf9e4a | 2018-03-14 14:51:58 +0000 | [diff] [blame] | 200 | uint16_t num_fragments, |
| 201 | uint8_t chunk_flags, |
Eric Seckler | b77b27e | 2018-12-17 11:42:52 +0000 | [diff] [blame] | 202 | bool chunk_complete, |
Primiano Tucci | ecf9e4a | 2018-03-14 14:51:58 +0000 | [diff] [blame] | 203 | const uint8_t* src, |
| 204 | size_t size); |
| 205 | void ApplyChunkPatches(ProducerID, |
| 206 | const std::vector<CommitDataRequest::ChunkToPatch>&); |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 207 | void NotifyFlushDoneForProducer(ProducerID, FlushRequestID); |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 208 | void NotifyDataSourceStopped(ProducerID, const DataSourceInstanceID); |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 209 | |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 210 | // Called by ConsumerEndpointImpl. |
Primiano Tucci | 9ba1d84 | 2018-12-20 17:31:04 +0100 | [diff] [blame] | 211 | bool DetachConsumer(ConsumerEndpointImpl*, const std::string& key); |
| 212 | bool AttachConsumer(ConsumerEndpointImpl*, const std::string& key); |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 213 | void DisconnectConsumer(ConsumerEndpointImpl*); |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 214 | bool EnableTracing(ConsumerEndpointImpl*, |
| 215 | const TraceConfig&, |
| 216 | base::ScopedFile); |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame] | 217 | bool StartTracing(TracingSessionID); |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 218 | void DisableTracing(TracingSessionID, bool disable_immediately = false); |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 219 | void Flush(TracingSessionID tsid, |
Primiano Tucci | 3cbb10a | 2018-04-10 17:52:40 +0100 | [diff] [blame] | 220 | uint32_t timeout_ms, |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 221 | ConsumerEndpoint::FlushCallback); |
| 222 | void FlushAndDisableTracing(TracingSessionID); |
Primiano Tucci | 20d441d | 2018-01-16 09:25:51 +0000 | [diff] [blame] | 223 | void ReadBuffers(TracingSessionID, ConsumerEndpointImpl*); |
| 224 | void FreeBuffers(TracingSessionID); |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 225 | |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 226 | // Service implementation. |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 227 | std::unique_ptr<TracingService::ProducerEndpoint> ConnectProducer( |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 228 | Producer*, |
Sami Kyostila | 32e0b54 | 2018-02-14 08:55:43 +0000 | [diff] [blame] | 229 | uid_t uid, |
Isabelle Taylor | 86262cb | 2018-03-27 16:00:54 +0100 | [diff] [blame] | 230 | const std::string& producer_name, |
Isabelle Taylor | 69faa90 | 2018-03-21 15:42:03 +0000 | [diff] [blame] | 231 | size_t shared_memory_size_hint_bytes = 0) override; |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 232 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 233 | std::unique_ptr<TracingService::ConsumerEndpoint> ConnectConsumer( |
Primiano Tucci | 9ba1d84 | 2018-12-20 17:31:04 +0100 | [diff] [blame] | 234 | Consumer*, |
| 235 | uid_t) override; |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 236 | |
Eric Seckler | a01e28a | 2019-01-08 11:21:04 +0000 | [diff] [blame] | 237 | void SetSMBScrapingEnabled(bool enabled) override { |
| 238 | smb_scraping_enabled_ = enabled; |
| 239 | } |
| 240 | |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 241 | // Exposed mainly for testing. |
| 242 | size_t num_producers() const { return producers_.size(); } |
| 243 | ProducerEndpointImpl* GetProducer(ProducerID) const; |
| 244 | |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 245 | uint32_t override_data_source_test_timeout_ms_for_testing = 0; |
| 246 | |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 247 | private: |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 248 | friend class TracingServiceImplTest; |
Primiano Tucci | 081d46a | 2018-02-28 11:09:43 +0000 | [diff] [blame] | 249 | |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 250 | struct RegisteredDataSource { |
| 251 | ProducerID producer_id; |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 252 | DataSourceDescriptor descriptor; |
| 253 | }; |
| 254 | |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 255 | // Represents an active data source for a tracing session. |
| 256 | struct DataSourceInstance { |
Primiano Tucci | 5403e4f | 2018-11-27 10:07:03 +0000 | [diff] [blame] | 257 | DataSourceInstance(DataSourceInstanceID id, |
| 258 | const DataSourceConfig& cfg, |
| 259 | const std::string& ds_name, |
| 260 | bool notify) |
| 261 | : instance_id(id), |
| 262 | config(cfg), |
| 263 | data_source_name(ds_name), |
| 264 | will_notify_on_stop(notify) {} |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame] | 265 | DataSourceInstance(const DataSourceInstance&) = delete; |
| 266 | DataSourceInstance& operator=(const DataSourceInstance&) = delete; |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame] | 267 | |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 268 | DataSourceInstanceID instance_id; |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame] | 269 | DataSourceConfig config; |
Primiano Tucci | 9daa483 | 2018-03-28 23:28:17 +0100 | [diff] [blame] | 270 | std::string data_source_name; |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 271 | bool will_notify_on_stop; |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 272 | }; |
| 273 | |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 274 | struct PendingFlush { |
| 275 | std::set<ProducerID> producers; |
| 276 | ConsumerEndpoint::FlushCallback callback; |
| 277 | explicit PendingFlush(decltype(callback) cb) : callback(std::move(cb)) {} |
| 278 | }; |
| 279 | |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 280 | // Holds the state of a tracing session. A tracing session is uniquely bound |
| 281 | // a specific Consumer. Each Consumer can own one or more sessions. |
| 282 | struct TracingSession { |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame] | 283 | enum State { |
| 284 | DISABLED = 0, |
| 285 | CONFIGURED, |
| 286 | STARTED, |
| 287 | DISABLING_WAITING_STOP_ACKS |
| 288 | }; |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 289 | |
| 290 | TracingSession(TracingSessionID, ConsumerEndpointImpl*, const TraceConfig&); |
Primiano Tucci | 20d441d | 2018-01-16 09:25:51 +0000 | [diff] [blame] | 291 | |
| 292 | size_t num_buffers() const { return buffers_index.size(); } |
| 293 | |
Primiano Tucci | 3cbb10a | 2018-04-10 17:52:40 +0100 | [diff] [blame] | 294 | uint32_t delay_to_next_write_period_ms() const { |
Sami Kyostila | 01c45f0 | 2018-03-29 15:43:10 +0100 | [diff] [blame] | 295 | PERFETTO_DCHECK(write_period_ms > 0); |
| 296 | return write_period_ms - |
| 297 | (base::GetWallTimeMs().count() % write_period_ms); |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 298 | } |
| 299 | |
Florian Mayer | e563f66 | 2019-01-09 11:04:50 +0000 | [diff] [blame] | 300 | uint32_t flush_timeout_ms() { |
| 301 | uint32_t timeout_ms = config.flush_timeout_ms(); |
| 302 | return timeout_ms ? timeout_ms : kDefaultFlushTimeoutMs; |
| 303 | } |
| 304 | |
Eric Seckler | d0ac7ca | 2019-02-06 09:13:45 +0000 | [diff] [blame] | 305 | PacketSequenceID GetPacketSequenceID(ProducerID producer_id, |
| 306 | WriterID writer_id) { |
| 307 | auto key = std::make_pair(producer_id, writer_id); |
| 308 | auto it = packet_sequence_ids.find(key); |
| 309 | if (it != packet_sequence_ids.end()) |
| 310 | return it->second; |
| 311 | // We shouldn't run out of sequence IDs (producer ID is 16 bit, writer IDs |
| 312 | // are limited to 1024). |
| 313 | static_assert(kMaxPacketSequenceID > kMaxProducerID * kMaxWriterID, |
| 314 | "PacketSequenceID value space doesn't cover service " |
| 315 | "sequence ID and all producer/writer ID combinations!"); |
| 316 | PERFETTO_DCHECK(last_packet_sequence_id < kMaxPacketSequenceID); |
| 317 | PacketSequenceID sequence_id = ++last_packet_sequence_id; |
| 318 | packet_sequence_ids[key] = sequence_id; |
| 319 | return sequence_id; |
| 320 | } |
| 321 | |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 322 | const TracingSessionID id; |
| 323 | |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 324 | // The consumer that started the session. |
Primiano Tucci | 9ba1d84 | 2018-12-20 17:31:04 +0100 | [diff] [blame] | 325 | // Can be nullptr if the consumer detached from the session. |
| 326 | ConsumerEndpointImpl* consumer_maybe_null; |
| 327 | |
| 328 | // Unix uid of the consumer. This is valid even after the consumer detaches |
| 329 | // and does not change for the entire duration of the session. It is used to |
| 330 | // prevent that a consumer re-attaches to a session from a different uid. |
| 331 | uid_t const consumer_uid; |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 332 | |
Primiano Tucci | 20d441d | 2018-01-16 09:25:51 +0000 | [diff] [blame] | 333 | // The original trace config provided by the Consumer when calling |
| 334 | // EnableTracing(). |
| 335 | const TraceConfig config; |
Oystein Eftevaag | 1269b4a | 2018-01-10 16:29:38 -0800 | [diff] [blame] | 336 | |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 337 | // List of data source instances that have been enabled on the various |
| 338 | // producers for this tracing session. |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 339 | std::multimap<ProducerID, DataSourceInstance> data_source_instances; |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 340 | |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 341 | // For each Flush(N) request, keeps track of the set of producers for which |
| 342 | // we are still awaiting a NotifyFlushComplete(N) ack. |
| 343 | std::map<FlushRequestID, PendingFlush> pending_flushes; |
| 344 | |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 345 | // After DisableTracing() is called, this contains the subset of data |
| 346 | // sources that did set the |will_notify_on_stop| flag upon registration and |
| 347 | // that have the haven't replied yet to the stop request. |
| 348 | std::set<std::pair<ProducerID, DataSourceInstanceID>> pending_stop_acks; |
| 349 | |
Primiano Tucci | 20d441d | 2018-01-16 09:25:51 +0000 | [diff] [blame] | 350 | // Maps a per-trace-session buffer index into the corresponding global |
| 351 | // BufferID (shared namespace amongst all consumers). This vector has as |
| 352 | // many entries as |config.buffers_size()|. |
| 353 | std::vector<BufferID> buffers_index; |
Sami Kyostila | fbccb3c | 2018-03-21 14:00:47 +0000 | [diff] [blame] | 354 | |
Eric Seckler | d0ac7ca | 2019-02-06 09:13:45 +0000 | [diff] [blame] | 355 | std::map<std::pair<ProducerID, WriterID>, PacketSequenceID> |
| 356 | packet_sequence_ids; |
| 357 | PacketSequenceID last_packet_sequence_id = kServicePacketSequenceID; |
| 358 | |
Primiano Tucci | 9754d0d | 2018-09-15 12:41:46 +0100 | [diff] [blame] | 359 | // When the last snapshots (clock, stats, sync marker) were emitted into |
| 360 | // the output stream. |
| 361 | base::TimeMillis last_snapshot_time = {}; |
Primiano Tucci | 5e33cad | 2018-04-30 14:41:25 +0100 | [diff] [blame] | 362 | |
Sami Kyostila | 200bd2e | 2018-03-26 12:24:10 +0100 | [diff] [blame] | 363 | // Whether we mirrored the trace config back to the trace output yet. |
| 364 | bool did_emit_config = false; |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 365 | |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 366 | State state = DISABLED; |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 367 | |
Primiano Tucci | 9ba1d84 | 2018-12-20 17:31:04 +0100 | [diff] [blame] | 368 | // If the consumer detached the session, this variable defines the key used |
| 369 | // for identifying the session later when reattaching. |
| 370 | std::string detach_key; |
| 371 | |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 372 | // This is set when the Consumer calls sets |write_into_file| == true in the |
| 373 | // TraceConfig. In this case this represents the file we should stream the |
| 374 | // trace packets into, rather than returning it to the consumer via |
| 375 | // OnTraceData(). |
| 376 | base::ScopedFile write_into_file; |
Primiano Tucci | 3cbb10a | 2018-04-10 17:52:40 +0100 | [diff] [blame] | 377 | uint32_t write_period_ms = 0; |
| 378 | uint64_t max_file_size_bytes = 0; |
| 379 | uint64_t bytes_written_into_file = 0; |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 380 | }; |
| 381 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 382 | TracingServiceImpl(const TracingServiceImpl&) = delete; |
| 383 | TracingServiceImpl& operator=(const TracingServiceImpl&) = delete; |
Primiano Tucci | 20d441d | 2018-01-16 09:25:51 +0000 | [diff] [blame] | 384 | |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame] | 385 | DataSourceInstance* SetupDataSource(const TraceConfig::DataSource&, |
| 386 | const TraceConfig::ProducerConfig&, |
| 387 | const RegisteredDataSource&, |
| 388 | TracingSession*); |
Oystein Eftevaag | 1269b4a | 2018-01-10 16:29:38 -0800 | [diff] [blame] | 389 | |
Primiano Tucci | 081d46a | 2018-02-28 11:09:43 +0000 | [diff] [blame] | 390 | // Returns the next available ProducerID that is not in |producers_|. |
| 391 | ProducerID GetNextProducerID(); |
| 392 | |
Primiano Tucci | 20d441d | 2018-01-16 09:25:51 +0000 | [diff] [blame] | 393 | // Returns a pointer to the |tracing_sessions_| entry or nullptr if the |
| 394 | // session doesn't exists. |
| 395 | TracingSession* GetTracingSession(TracingSessionID); |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 396 | |
Primiano Tucci | 9ba1d84 | 2018-12-20 17:31:04 +0100 | [diff] [blame] | 397 | // Returns a pointer to the |tracing_sessions_| entry, matching the given |
| 398 | // uid and detach key, or nullptr if no such session exists. |
| 399 | TracingSession* GetDetachedSession(uid_t, const std::string& key); |
| 400 | |
Lalit Maganti | 485faff | 2018-03-06 11:51:35 +0000 | [diff] [blame] | 401 | // Update the memory guard rail by using the latest information from the |
| 402 | // shared memory and trace buffers. |
| 403 | void UpdateMemoryGuardrail(); |
| 404 | |
Primiano Tucci | 9754d0d | 2018-09-15 12:41:46 +0100 | [diff] [blame] | 405 | void SnapshotSyncMarker(std::vector<TracePacket>*); |
| 406 | void SnapshotClocks(std::vector<TracePacket>*); |
| 407 | void SnapshotStats(TracingSession*, std::vector<TracePacket>*); |
Eric Seckler | eaf29ed | 2019-01-23 09:53:55 +0000 | [diff] [blame] | 408 | TraceStats GetTraceStats(TracingSession* tracing_session); |
Sami Kyostila | 200bd2e | 2018-03-26 12:24:10 +0100 | [diff] [blame] | 409 | void MaybeEmitTraceConfig(TracingSession*, std::vector<TracePacket>*); |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 410 | void OnFlushTimeout(TracingSessionID, FlushRequestID); |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 411 | void OnDisableTracingTimeout(TracingSessionID); |
| 412 | void DisableTracingNotifyConsumerAndFlushFile(TracingSession*); |
Primiano Tucci | caa5780 | 2018-11-25 11:07:07 +0000 | [diff] [blame] | 413 | void PeriodicFlushTask(TracingSessionID, bool post_next_only); |
Eric Seckler | a01e28a | 2019-01-08 11:21:04 +0000 | [diff] [blame] | 414 | void CompleteFlush(TracingSessionID tsid, |
| 415 | ConsumerEndpoint::FlushCallback callback, |
| 416 | bool success); |
| 417 | void ScrapeSharedMemoryBuffers(TracingSession* tracing_session, |
| 418 | ProducerEndpointImpl* producer); |
Hector Dearman | 6214c8f | 2018-03-27 16:16:22 +0100 | [diff] [blame] | 419 | TraceBuffer* GetBufferByID(BufferID); |
Primiano Tucci | ecf9e4a | 2018-03-14 14:51:58 +0000 | [diff] [blame] | 420 | |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 421 | base::TaskRunner* const task_runner_; |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 422 | std::unique_ptr<SharedMemory::Factory> shm_factory_; |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 423 | ProducerID last_producer_id_ = 0; |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 424 | DataSourceInstanceID last_data_source_instance_id_ = 0; |
Primiano Tucci | 20d441d | 2018-01-16 09:25:51 +0000 | [diff] [blame] | 425 | TracingSessionID last_tracing_session_id_ = 0; |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 426 | FlushRequestID last_flush_request_id_ = 0; |
Primiano Tucci | 5e33cad | 2018-04-30 14:41:25 +0100 | [diff] [blame] | 427 | uid_t uid_ = 0; |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 428 | |
| 429 | // Buffer IDs are global across all consumers (because a Producer can produce |
| 430 | // data for more than one trace session, hence more than one consumer). |
Primiano Tucci | 20d441d | 2018-01-16 09:25:51 +0000 | [diff] [blame] | 431 | IdAllocator<BufferID> buffer_ids_; |
Primiano Tucci | 5358933 | 2017-12-19 11:31:13 +0100 | [diff] [blame] | 432 | |
| 433 | std::multimap<std::string /*name*/, RegisteredDataSource> data_sources_; |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 434 | std::map<ProducerID, ProducerEndpointImpl*> producers_; |
Primiano Tucci | 42e2de1 | 2017-12-07 16:46:04 +0000 | [diff] [blame] | 435 | std::set<ConsumerEndpointImpl*> consumers_; |
Primiano Tucci | 20d441d | 2018-01-16 09:25:51 +0000 | [diff] [blame] | 436 | std::map<TracingSessionID, TracingSession> tracing_sessions_; |
Hector Dearman | 6214c8f | 2018-03-27 16:16:22 +0100 | [diff] [blame] | 437 | std::map<BufferID, std::unique_ptr<TraceBuffer>> buffers_; |
Primiano Tucci | 20d441d | 2018-01-16 09:25:51 +0000 | [diff] [blame] | 438 | |
Eric Seckler | a01e28a | 2019-01-08 11:21:04 +0000 | [diff] [blame] | 439 | bool smb_scraping_enabled_ = false; |
Florian Mayer | 61c5548 | 2018-03-06 14:43:54 +0000 | [diff] [blame] | 440 | bool lockdown_mode_ = false; |
Primiano Tucci | 9754d0d | 2018-09-15 12:41:46 +0100 | [diff] [blame] | 441 | uint32_t min_write_period_ms_ = 100; // Overridable for testing. |
| 442 | |
| 443 | uint8_t sync_marker_packet_[32]; // Lazily initialized. |
| 444 | size_t sync_marker_packet_size_ = 0; |
Florian Mayer | 61c5548 | 2018-03-06 14:43:54 +0000 | [diff] [blame] | 445 | |
Eric Seckler | 2c72bd8 | 2019-02-08 15:01:34 +0000 | [diff] [blame] | 446 | // Stats. |
| 447 | uint64_t chunks_discarded_ = 0; |
| 448 | uint64_t patches_discarded_ = 0; |
| 449 | |
Florian Mayer | cd08ec6 | 2018-01-31 17:49:25 +0000 | [diff] [blame] | 450 | PERFETTO_THREAD_CHECKER(thread_checker_) |
| 451 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 452 | base::WeakPtrFactory<TracingServiceImpl> |
| 453 | weak_ptr_factory_; // Keep at the end. |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 454 | }; |
| 455 | |
| 456 | } // namespace perfetto |
| 457 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 458 | #endif // SRC_TRACING_CORE_TRACING_SERVICE_IMPL_H_ |