Home | History | Annotate | Download | only in simpleperf
      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 <sys/types.h>
     21 
     22 #include <functional>
     23 #include <set>
     24 #include <string>
     25 #include <vector>
     26 
     27 #include "build_id.h"
     28 
     29 std::vector<int> GetOnlineCpus();
     30 std::vector<int> GetCpusFromString(const std::string& s);
     31 
     32 constexpr char DEFAULT_KERNEL_MMAP_NAME[] = "[kernel.kallsyms]_text";
     33 
     34 struct KernelMmap {
     35   std::string name;
     36   uint64_t start_addr;
     37   uint64_t len;
     38   std::string filepath;
     39 };
     40 
     41 void GetKernelAndModuleMmaps(KernelMmap* kernel_mmap, std::vector<KernelMmap>* module_mmaps);
     42 
     43 struct ThreadComm {
     44   pid_t pid, tid;
     45   std::string comm;
     46 };
     47 
     48 bool GetThreadComms(std::vector<ThreadComm>* thread_comms);
     49 
     50 constexpr char DEFAULT_EXECNAME_FOR_THREAD_MMAP[] = "//anon";
     51 
     52 struct ThreadMmap {
     53   uint64_t start_addr;
     54   uint64_t len;
     55   uint64_t pgoff;
     56   std::string name;
     57   bool executable;
     58 };
     59 
     60 bool GetThreadMmapsInProcess(pid_t pid, std::vector<ThreadMmap>* thread_mmaps);
     61 
     62 constexpr char DEFAULT_KERNEL_FILENAME_FOR_BUILD_ID[] = "[kernel.kallsyms]";
     63 
     64 bool GetKernelBuildId(BuildId* build_id);
     65 bool GetModuleBuildId(const std::string& module_name, BuildId* build_id);
     66 
     67 bool GetValidThreadsFromProcessString(const std::string& pid_str, std::set<pid_t>* tid_set);
     68 bool GetValidThreadsFromThreadString(const std::string& tid_str, std::set<pid_t>* tid_set);
     69 
     70 bool GetExecPath(std::string* exec_path);
     71 
     72 // Expose the following functions for unit tests.
     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 bool CheckPerfEventLimit();
     83 
     84 #endif  // SIMPLE_PERF_ENVIRONMENT_H_
     85