xref: /aosp_15_r20/external/perfetto/src/bigtrace/orchestrator/trace_address_pool.h (revision 6dbdd20afdafa5e3ca9b8809fa73465d530080dc)
1 /*
2  * Copyright (C) 2024 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 #ifndef SRC_BIGTRACE_ORCHESTRATOR_TRACE_ADDRESS_POOL_H_
18 #define SRC_BIGTRACE_ORCHESTRATOR_TRACE_ADDRESS_POOL_H_
19 
20 #include <mutex>
21 #include <optional>
22 #include <vector>
23 
24 namespace perfetto::bigtrace {
25 
26 // This pool contains all trace addresses of a given query and facilitates a
27 // thread safe way of popping traces and returning them to the pool if the query
28 // is cancelled
29 class TraceAddressPool {
30  public:
31   explicit TraceAddressPool(const std::vector<std::string>& trace_addresses);
32   std::optional<std::string> Pop();
33   void MarkCancelled(std::string trace_address);
34   uint32_t RemainingCount();
35 
36  private:
37   std::vector<std::string> trace_addresses_;
38   std::mutex trace_addresses_lock_;
39   uint32_t running_queries_ = 0;
40 };
41 
42 }  // namespace perfetto::bigtrace
43 
44 #endif  // SRC_BIGTRACE_ORCHESTRATOR_TRACE_ADDRESS_POOL_H_
45