1 /*
2  * Copyright (C) 2015 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 SIMPLE_PERF_RECORD_FILE_FORMAT_H_
18 #define SIMPLE_PERF_RECORD_FILE_FORMAT_H_
19 
20 #include <string>
21 
22 #include "perf_event.h"
23 
24 /*
25 The file structure of perf.data:
26     file_header
27     id_section
28     attr section
29     data section
30     feature section
31 
32 The feature section has the following structure:
33     a section descriptor array, each element contains the section information of one add_feature.
34     data section of feature 1
35     data section of feature 2
36     ....
37 
38 file feature section:
39   file_struct files[];
40 
41   struct file_struct {
42     uint32_t size;  // size of rest fields in file_struct
43     char file_path[];
44     uint32_t file_type;
45     uint64_t min_vaddr;
46     uint32_t symbol_count;
47     struct {
48       uint64_t start_vaddr;
49       uint32_t len;
50       char symbol_name[len+1];
51     } symbol_table[symbol_count];
52 
53     uint32_t dex_file_offset_count;  // Only when file_type = DSO_DEX_FILE
54     uint64_t dex_file_offsets[dex_file_offset_count];  // Only when file_type = DSO_DEX_FILE
55     uint64_t file_offset_of_min_vaddr;  // Only when file_type = DSO_ELF_FILE
56   };
57 
58 meta_info feature section:
59   meta_info infos[];
60 
61   struct meta_info {
62     char key[];
63     char value[];
64   };
65   keys in meta_info feature section include:
66     simpleperf_version,
67 
68 */
69 
70 namespace PerfFileFormat {
71 
72 enum {
73   FEAT_RESERVED = 0,
74   FEAT_FIRST_FEATURE = 1,
75   FEAT_TRACING_DATA = 1,
76   FEAT_BUILD_ID,
77   FEAT_HOSTNAME,
78   FEAT_OSRELEASE,
79   FEAT_VERSION,
80   FEAT_ARCH,
81   FEAT_NRCPUS,
82   FEAT_CPUDESC,
83   FEAT_CPUID,
84   FEAT_TOTAL_MEM,
85   FEAT_CMDLINE,
86   FEAT_EVENT_DESC,
87   FEAT_CPU_TOPOLOGY,
88   FEAT_NUMA_TOPOLOGY,
89   FEAT_BRANCH_STACK,
90   FEAT_PMU_MAPPINGS,
91   FEAT_GROUP_DESC,
92   FEAT_AUXTRACE,
93   FEAT_LAST_FEATURE,
94 
95   FEAT_SIMPLEPERF_START = 128,
96   FEAT_FILE = FEAT_SIMPLEPERF_START,
97   FEAT_META_INFO,
98   FEAT_MAX_NUM = 256,
99 };
100 
101 std::string GetFeatureName(int feature_id);
102 int GetFeatureId(const std::string& feature_name);
103 
104 struct SectionDesc {
105   uint64_t offset;
106   uint64_t size;
107 };
108 
109 constexpr char PERF_MAGIC[] = "PERFILE2";
110 
111 struct FileHeader {
112   char magic[8];
113   uint64_t header_size;
114   uint64_t attr_size;
115   SectionDesc attrs;
116   SectionDesc data;
117   SectionDesc event_types;
118   unsigned char features[FEAT_MAX_NUM / 8];
119 };
120 
121 struct FileAttr {
122   perf_event_attr attr;
123   SectionDesc ids;
124 };
125 
126 }  // namespace PerfFileFormat
127 
128 #endif  // SIMPLE_PERF_RECORD_FILE_FORMAT_H_
129