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     uint64_t memory_offset_of_min_vaddr;  // Only when file_type = DSO_KERNEL_MODULE
57   };
58 
59 meta_info feature section:
60   meta_info infos[];
61 
62   struct meta_info {
63     char key[];
64     char value[];
65   };
66   keys in meta_info feature section include:
67     simpleperf_version,
68 
69 debug_unwind feature section:
70   message DebugUnwindSection from record_file.proto
71 
72 debug_unwind_file feature section:
73   data for file 1
74   data for file 2
75   ...
76 
77   The file list is stored in debug_unwind feature section.
78 */
79 
80 namespace simpleperf {
81 namespace PerfFileFormat {
82 
83 enum {
84   FEAT_RESERVED = 0,
85   FEAT_FIRST_FEATURE = 1,
86   FEAT_TRACING_DATA = 1,
87   FEAT_BUILD_ID,
88   FEAT_HOSTNAME,
89   FEAT_OSRELEASE,
90   FEAT_VERSION,
91   FEAT_ARCH,
92   FEAT_NRCPUS,
93   FEAT_CPUDESC,
94   FEAT_CPUID,
95   FEAT_TOTAL_MEM,
96   FEAT_CMDLINE,
97   FEAT_EVENT_DESC,
98   FEAT_CPU_TOPOLOGY,
99   FEAT_NUMA_TOPOLOGY,
100   FEAT_BRANCH_STACK,
101   FEAT_PMU_MAPPINGS,
102   FEAT_GROUP_DESC,
103   FEAT_AUXTRACE,
104   FEAT_LAST_FEATURE,
105 
106   FEAT_SIMPLEPERF_START = 128,
107   FEAT_FILE = FEAT_SIMPLEPERF_START,
108   FEAT_META_INFO,
109   FEAT_DEBUG_UNWIND,
110   FEAT_DEBUG_UNWIND_FILE,
111   FEAT_MAX_NUM = 256,
112 };
113 
114 std::string GetFeatureName(int feature_id);
115 int GetFeatureId(const std::string& feature_name);
116 
117 struct SectionDesc {
118   uint64_t offset;
119   uint64_t size;
120 };
121 
122 constexpr char PERF_MAGIC[] = "PERFILE2";
123 
124 struct FileHeader {
125   char magic[8];
126   uint64_t header_size;
127   uint64_t attr_size;
128   SectionDesc attrs;
129   SectionDesc data;
130   SectionDesc event_types;
131   unsigned char features[FEAT_MAX_NUM / 8];
132 };
133 
134 struct FileAttr {
135   perf_event_attr attr;
136   SectionDesc ids;
137 };
138 
139 }  // namespace PerfFileFormat
140 }  // namespace simpleperf
141 
142 #endif  // SIMPLE_PERF_RECORD_FILE_FORMAT_H_
143