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_ANALYSIS_DESCRIBE_SLICE_H_
18 #define SRC_TRACE_PROCESSOR_ANALYSIS_DESCRIBE_SLICE_H_
19 
20 #include <string>
21 
22 #include "perfetto/trace_processor/status.h"
23 
24 #include "src/trace_processor/tables/slice_tables.h"
25 
26 namespace perfetto {
27 namespace trace_processor {
28 
29 struct SliceDescription {
30   std::string description;
31   std::string doc_link;
32 };
33 
34 // Provides a description and doc link (if available) for the given slice id in
35 // the slice table. For a high level overview of this function's use, see
36 // /docs/analysis.md.
37 util::Status DescribeSlice(const tables::SliceTable&,
38                            tables::SliceTable::Id,
39                            base::Optional<SliceDescription>* description);
40 
41 }  // namespace trace_processor
42 }  // namespace perfetto
43 
44 #endif  // SRC_TRACE_PROCESSOR_ANALYSIS_DESCRIBE_SLICE_H_
45