2 * Copyright (C) 2015 The Android Open Source Project
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #include "environment.h"
24 #include <unordered_map>
27 #include <base/file.h>
28 #include <base/logging.h>
29 #include <base/strings.h>
30 #include <base/stringprintf.h>
35 std::vector<int> GetOnlineCpus() {
36 std::vector<int> result;
37 FILE* fp = fopen("/sys/devices/system/cpu/online", "re");
39 PLOG(ERROR) << "can't open online cpu information";
43 LineReader reader(fp);
45 if ((line = reader.ReadLine()) != nullptr) {
46 result = GetOnlineCpusFromString(line);
48 CHECK(!result.empty()) << "can't get online cpu information";
52 std::vector<int> GetOnlineCpusFromString(const std::string& s) {
53 std::vector<int> result;
54 bool have_dash = false;
55 const char* p = s.c_str();
58 // Parse line like: 0,1-3, 5, 7-8
59 while ((cpu = strtol(p, &endp, 10)) != 0 || endp != p) {
60 if (have_dash && result.size() > 0) {
61 for (int t = result.back() + 1; t < cpu; ++t) {
66 result.push_back(cpu);
68 while (!isdigit(*p) && *p != '\0') {
78 bool ProcessKernelSymbols(const std::string& symbol_file,
79 std::function<bool(const KernelSymbol&)> callback) {
80 FILE* fp = fopen(symbol_file.c_str(), "re");
82 PLOG(ERROR) << "failed to open file " << symbol_file;
85 LineReader reader(fp);
87 while ((line = reader.ReadLine()) != nullptr) {
88 // Parse line like: ffffffffa005c4e4 d __warned.41698 [libsas]
89 char name[reader.MaxLineSize()];
90 char module[reader.MaxLineSize()];
94 if (sscanf(line, "%" PRIx64 " %c %s%s", &symbol.addr, &symbol.type, name, module) < 3) {
98 size_t module_len = strlen(module);
99 if (module_len > 2 && module[0] == '[' && module[module_len - 1] == ']') {
100 module[module_len - 1] = '\0';
101 symbol.module = &module[1];
103 symbol.module = nullptr;
106 if (callback(symbol)) {
113 static bool FindStartOfKernelSymbolCallback(const KernelSymbol& symbol, uint64_t* start_addr) {
114 if (symbol.module == nullptr) {
115 *start_addr = symbol.addr;
121 static bool FindStartOfKernelSymbol(const std::string& symbol_file, uint64_t* start_addr) {
122 return ProcessKernelSymbols(
123 symbol_file, std::bind(&FindStartOfKernelSymbolCallback, std::placeholders::_1, start_addr));
126 static bool FindKernelFunctionSymbolCallback(const KernelSymbol& symbol, const std::string& name,
128 if ((symbol.type == 'T' || symbol.type == 'W' || symbol.type == 'A') &&
129 symbol.module == nullptr && name == symbol.name) {
136 static bool FindKernelFunctionSymbol(const std::string& symbol_file, const std::string& name,
138 return ProcessKernelSymbols(
139 symbol_file, std::bind(&FindKernelFunctionSymbolCallback, std::placeholders::_1, name, addr));
142 std::vector<ModuleMmap> GetLoadedModules() {
143 std::vector<ModuleMmap> result;
144 FILE* fp = fopen("/proc/modules", "re");
146 // There is no /proc/modules on Android devices, so we don't print error if failed to open it.
147 PLOG(DEBUG) << "failed to open file /proc/modules";
150 LineReader reader(fp);
152 while ((line = reader.ReadLine()) != nullptr) {
153 // Parse line like: nf_defrag_ipv6 34768 1 nf_conntrack_ipv6, Live 0xffffffffa0fe5000
154 char name[reader.MaxLineSize()];
156 if (sscanf(line, "%s%*lu%*u%*s%*s 0x%" PRIx64, name, &addr) == 2) {
159 map.start_addr = addr;
160 result.push_back(map);
166 static std::string GetLinuxVersion() {
168 if (android::base::ReadFileToString("/proc/version", &content)) {
169 char s[content.size() + 1];
170 if (sscanf(content.c_str(), "Linux version %s", s) == 1) {
174 PLOG(FATAL) << "can't read linux version";
178 static void GetAllModuleFiles(const std::string& path,
179 std::unordered_map<std::string, std::string>* module_file_map) {
180 std::vector<std::string> files;
181 std::vector<std::string> subdirs;
182 GetEntriesInDir(path, &files, &subdirs);
183 for (auto& name : files) {
184 if (android::base::EndsWith(name, ".ko")) {
185 std::string module_name = name.substr(0, name.size() - 3);
186 std::replace(module_name.begin(), module_name.end(), '-', '_');
187 module_file_map->insert(std::make_pair(module_name, path + "/" + name));
190 for (auto& name : subdirs) {
191 GetAllModuleFiles(path + "/" + name, module_file_map);
195 static std::vector<ModuleMmap> GetModulesInUse() {
196 // TODO: There is no /proc/modules or /lib/modules on Android, find methods work on it.
197 std::vector<ModuleMmap> module_mmaps = GetLoadedModules();
198 std::string linux_version = GetLinuxVersion();
199 std::string module_dirpath = "/lib/modules/" + linux_version + "/kernel";
200 std::unordered_map<std::string, std::string> module_file_map;
201 GetAllModuleFiles(module_dirpath, &module_file_map);
202 for (auto& module : module_mmaps) {
203 auto it = module_file_map.find(module.name);
204 if (it != module_file_map.end()) {
205 module.filepath = it->second;
211 bool GetKernelAndModuleMmaps(KernelMmap* kernel_mmap, std::vector<ModuleMmap>* module_mmaps) {
212 if (!FindStartOfKernelSymbol("/proc/kallsyms", &kernel_mmap->start_addr)) {
213 LOG(DEBUG) << "call FindStartOfKernelSymbol() failed";
216 if (!FindKernelFunctionSymbol("/proc/kallsyms", "_text", &kernel_mmap->pgoff)) {
217 LOG(DEBUG) << "call FindKernelFunctionSymbol() failed";
220 kernel_mmap->name = DEFAULT_KERNEL_MMAP_NAME;
221 *module_mmaps = GetModulesInUse();
222 if (module_mmaps->size() == 0) {
223 kernel_mmap->len = std::numeric_limits<unsigned long long>::max() - kernel_mmap->start_addr;
226 module_mmaps->begin(), module_mmaps->end(),
227 [](const ModuleMmap& m1, const ModuleMmap& m2) { return m1.start_addr < m2.start_addr; });
228 CHECK_LE(kernel_mmap->start_addr, (*module_mmaps)[0].start_addr);
229 // When not having enough privilege, all addresses are read as 0.
230 if (kernel_mmap->start_addr == (*module_mmaps)[0].start_addr) {
231 kernel_mmap->len = 0;
233 kernel_mmap->len = (*module_mmaps)[0].start_addr - kernel_mmap->start_addr - 1;
235 for (size_t i = 0; i + 1 < module_mmaps->size(); ++i) {
236 if ((*module_mmaps)[i].start_addr == (*module_mmaps)[i + 1].start_addr) {
237 (*module_mmaps)[i].len = 0;
239 (*module_mmaps)[i].len =
240 (*module_mmaps)[i + 1].start_addr - (*module_mmaps)[i].start_addr - 1;
243 module_mmaps->back().len =
244 std::numeric_limits<unsigned long long>::max() - module_mmaps->back().start_addr;
249 static bool ReadThreadNameAndTgid(const std::string& status_file, std::string* comm, pid_t* tgid) {
250 FILE* fp = fopen(status_file.c_str(), "re");
254 bool read_comm = false;
255 bool read_tgid = false;
256 LineReader reader(fp);
258 while ((line = reader.ReadLine()) != nullptr) {
259 char s[reader.MaxLineSize()];
260 if (sscanf(line, "Name:%s", s) == 1) {
263 } else if (sscanf(line, "Tgid:%d", tgid) == 1) {
266 if (read_comm && read_tgid) {
273 static std::vector<pid_t> GetThreadsInProcess(pid_t pid) {
274 std::vector<pid_t> result;
275 std::string task_dirname = android::base::StringPrintf("/proc/%d/task", pid);
276 std::vector<std::string> subdirs;
277 GetEntriesInDir(task_dirname, nullptr, &subdirs);
278 for (auto& name : subdirs) {
280 if (!StringToPid(name, &tid)) {
283 result.push_back(tid);
288 static bool GetThreadComm(pid_t pid, std::vector<ThreadComm>* thread_comms) {
289 std::vector<pid_t> tids = GetThreadsInProcess(pid);
290 for (auto& tid : tids) {
291 std::string status_file = android::base::StringPrintf("/proc/%d/task/%d/status", pid, tid);
294 // It is possible that the process or thread exited before we can read its status.
295 if (!ReadThreadNameAndTgid(status_file, &comm, &tgid)) {
303 thread_comms->push_back(thread);
308 bool GetThreadComms(std::vector<ThreadComm>* thread_comms) {
309 thread_comms->clear();
310 std::vector<std::string> subdirs;
311 GetEntriesInDir("/proc", nullptr, &subdirs);
312 for (auto& name : subdirs) {
314 if (!StringToPid(name, &pid)) {
317 if (!GetThreadComm(pid, thread_comms)) {
324 bool GetThreadMmapsInProcess(pid_t pid, std::vector<ThreadMmap>* thread_mmaps) {
325 std::string map_file = android::base::StringPrintf("/proc/%d/maps", pid);
326 FILE* fp = fopen(map_file.c_str(), "re");
328 PLOG(DEBUG) << "can't open file " << map_file;
331 thread_mmaps->clear();
332 LineReader reader(fp);
334 while ((line = reader.ReadLine()) != nullptr) {
335 // Parse line like: 00400000-00409000 r-xp 00000000 fc:00 426998 /usr/lib/gvfs/gvfsd-http
336 uint64_t start_addr, end_addr, pgoff;
337 char type[reader.MaxLineSize()];
338 char execname[reader.MaxLineSize()];
339 strcpy(execname, "");
340 if (sscanf(line, "%" PRIx64 "-%" PRIx64 " %s %" PRIx64 " %*x:%*x %*u %s\n", &start_addr,
341 &end_addr, type, &pgoff, execname) < 4) {
344 if (strcmp(execname, "") == 0) {
345 strcpy(execname, DEFAULT_EXECNAME_FOR_THREAD_MMAP);
348 thread.start_addr = start_addr;
349 thread.len = end_addr - start_addr;
350 thread.pgoff = pgoff;
351 thread.name = execname;
352 thread.executable = (type[2] == 'x');
353 thread_mmaps->push_back(thread);
358 bool GetKernelBuildId(BuildId* build_id) {
359 return GetBuildIdFromNoteFile("/sys/kernel/notes", build_id);
362 bool GetModuleBuildId(const std::string& module_name, BuildId* build_id) {
363 std::string notefile = "/sys/module/" + module_name + "/notes/.note.gnu.build-id";
364 return GetBuildIdFromNoteFile(notefile, build_id);
367 bool GetValidThreadsFromProcessString(const std::string& pid_str, std::set<pid_t>* tid_set) {
368 std::vector<std::string> strs = android::base::Split(pid_str, ",");
369 for (auto& s : strs) {
371 if (!StringToPid(s, &pid)) {
372 LOG(ERROR) << "Invalid pid '" << s << "'";
375 std::vector<pid_t> tids = GetThreadsInProcess(pid);
377 LOG(ERROR) << "Non existing process '" << pid << "'";
380 tid_set->insert(tids.begin(), tids.end());
385 bool GetValidThreadsFromThreadString(const std::string& tid_str, std::set<pid_t>* tid_set) {
386 std::vector<std::string> strs = android::base::Split(tid_str, ",");
387 for (auto& s : strs) {
389 if (!StringToPid(s, &tid)) {
390 LOG(ERROR) << "Invalid tid '" << s << "'";
393 if (!IsDir(android::base::StringPrintf("/proc/%d", tid))) {
394 LOG(ERROR) << "Non existing thread '" << tid << "'";
397 tid_set->insert(tid);
402 bool GetExecPath(std::string* exec_path) {
404 ssize_t path_len = readlink("/proc/self/exe", path, sizeof(path));
405 if (path_len <= 0 || path_len >= static_cast<ssize_t>(sizeof(path))) {
406 PLOG(ERROR) << "readlink failed";
409 path[path_len] = '\0';