1 /*
2  * Copyright (C) 2020 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_TRACE_PROCESSOR_DYNAMIC_ANCESTOR_GENERATOR_H_
18 #define SRC_TRACE_PROCESSOR_DYNAMIC_ANCESTOR_GENERATOR_H_
19 
20 #include "src/trace_processor/sqlite/db_sqlite_table.h"
21 
22 #include "perfetto/ext/base/optional.h"
23 #include "src/trace_processor/storage/trace_storage.h"
24 
25 namespace perfetto {
26 namespace trace_processor {
27 
28 class TraceProcessorContext;
29 
30 // Implements the following dynamic tables:
31 // * ancestor_slice
32 // * experimental_ancestor_stack_profile_callsite
33 //
34 // See docs/analysis/trace-processor for usage.
35 class AncestorGenerator : public DbSqliteTable::DynamicTableGenerator {
36  public:
37   enum class Ancestor { kSlice = 1, kStackProfileCallsite = 2 };
38 
39   AncestorGenerator(Ancestor type, TraceProcessorContext* context);
40 
41   Table::Schema CreateSchema() override;
42   std::string TableName() override;
43   uint32_t EstimateRowCount() override;
44   util::Status ValidateConstraints(const QueryConstraints&) override;
45   std::unique_ptr<Table> ComputeTable(const std::vector<Constraint>& cs,
46                                       const std::vector<Order>& ob) override;
47 
48   // Returns a RowMap of slice IDs which are ancestors of |slice_id|. Returns
49   // NULL if an invalid |slice_id| is given. This is used by
50   // ConnectedFlowGenerator to traverse flow indirectly connected flow events.
51   static base::Optional<RowMap> GetAncestorSlices(
52       const tables::SliceTable& slices,
53       SliceId slice_id);
54 
55  private:
56   Ancestor type_;
57   TraceProcessorContext* context_ = nullptr;
58 };
59 
60 }  // namespace trace_processor
61 }  // namespace perfetto
62 
63 #endif  // SRC_TRACE_PROCESSOR_DYNAMIC_ANCESTOR_GENERATOR_H_
64