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_ENVIRONMENT_H_
18 #define SIMPLE_PERF_ENVIRONMENT_H_
19 
20 #include <functional>
21 #include <string>
22 #include <vector>
23 #include "build_id.h"
24 
25 std::vector<int> GetOnlineCpus();
26 
27 static const char* DEFAULT_KERNEL_MMAP_NAME = "[kernel.kallsyms]_text";
28 
29 struct KernelMmap {
30   std::string name;
31   uint64_t start_addr;
32   uint64_t len;
33   uint64_t pgoff;
34 };
35 
36 struct ModuleMmap {
37   std::string name;
38   uint64_t start_addr;
39   uint64_t len;
40   std::string filepath;
41 };
42 
43 bool GetKernelAndModuleMmaps(KernelMmap* kernel_mmap, std::vector<ModuleMmap>* module_mmaps);
44 
45 struct ThreadComm {
46   pid_t tgid, tid;
47   std::string comm;
48   bool is_process;
49 };
50 
51 bool GetThreadComms(std::vector<ThreadComm>* thread_comms);
52 
53 static const char* DEFAULT_EXECNAME_FOR_THREAD_MMAP = "//anon";
54 
55 struct ThreadMmap {
56   uint64_t start_addr;
57   uint64_t len;
58   uint64_t pgoff;
59   std::string name;
60   bool executable;
61 };
62 
63 bool GetThreadMmapsInProcess(pid_t pid, std::vector<ThreadMmap>* thread_mmaps);
64 
65 static const char* DEFAULT_KERNEL_FILENAME_FOR_BUILD_ID = "[kernel.kallsyms]";
66 
67 bool GetKernelBuildId(BuildId* build_id);
68 bool GetModuleBuildId(const std::string& module_name, BuildId* build_id);
69 
70 // Expose the following functions for unit tests.
71 std::vector<int> GetOnlineCpusFromString(const std::string& s);
72 
73 struct KernelSymbol {
74   uint64_t addr;
75   char type;
76   const char* name;
77   const char* module;  // If nullptr, the symbol is not in a kernel module.
78 };
79 
80 bool ProcessKernelSymbols(const std::string& symbol_file,
81                           std::function<bool(const KernelSymbol&)> callback);
82 
83 #endif  // SIMPLE_PERF_ENVIRONMENT_H_
84