1 /*
2  * Copyright (C) 2014 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 #include <ctype.h>
18 #include <stdint.h>
19 #include <sys/types.h>
20 #include <unistd.h>
21 
22 #include <backtrace/backtrace_constants.h>
23 #include <backtrace/BacktraceMap.h>
24 #include <log/log.h>
25 
26 #include "thread_utils.h"
27 
BacktraceMap(pid_t pid)28 BacktraceMap::BacktraceMap(pid_t pid) : pid_(pid) {
29   if (pid_ < 0) {
30     pid_ = getpid();
31   }
32 }
33 
~BacktraceMap()34 BacktraceMap::~BacktraceMap() {
35 }
36 
FillIn(uintptr_t addr,backtrace_map_t * map)37 void BacktraceMap::FillIn(uintptr_t addr, backtrace_map_t* map) {
38   for (BacktraceMap::const_iterator it = begin();
39        it != end(); ++it) {
40     if (addr >= it->start && addr < it->end) {
41       *map = *it;
42       return;
43     }
44   }
45   *map = {};
46 }
47 
ParseLine(const char * line,backtrace_map_t * map)48 bool BacktraceMap::ParseLine(const char* line, backtrace_map_t* map) {
49   unsigned long int start;
50   unsigned long int end;
51   char permissions[5];
52   int name_pos;
53 
54 #if defined(__APPLE__)
55 // Mac OS vmmap(1) output:
56 // __TEXT                 0009f000-000a1000 [    8K     8K] r-x/rwx SM=COW  /Volumes/android/dalvik-dev/out/host/darwin-x86/bin/libcorkscrew_test\n
57 // 012345678901234567890123456789012345678901234567890123456789
58 // 0         1         2         3         4         5
59   if (sscanf(line, "%*21c %lx-%lx [%*13c] %3c/%*3c SM=%*3c  %n",
60              &start, &end, permissions, &name_pos) != 3) {
61 #else
62 // Linux /proc/<pid>/maps lines:
63 // 6f000000-6f01e000 rwxp 00000000 00:0c 16389419   /system/lib/libcomposer.so\n
64 // 012345678901234567890123456789012345678901234567890123456789
65 // 0         1         2         3         4         5
66   if (sscanf(line, "%lx-%lx %4s %*x %*x:%*x %*d %n",
67              &start, &end, permissions, &name_pos) != 3) {
68 #endif
69     return false;
70   }
71 
72   map->start = start;
73   map->end = end;
74   map->flags = PROT_NONE;
75   if (permissions[0] == 'r') {
76     map->flags |= PROT_READ;
77   }
78   if (permissions[1] == 'w') {
79     map->flags |= PROT_WRITE;
80   }
81   if (permissions[2] == 'x') {
82     map->flags |= PROT_EXEC;
83   }
84 
85   map->name = line+name_pos;
86   if (!map->name.empty() && map->name[map->name.length()-1] == '\n') {
87     map->name.erase(map->name.length()-1);
88   }
89 
90   ALOGV("Parsed map: start=%p, end=%p, flags=%x, name=%s",
91         reinterpret_cast<void*>(map->start), reinterpret_cast<void*>(map->end),
92         map->flags, map->name.c_str());
93   return true;
94 }
95 
96 bool BacktraceMap::Build() {
97 #if defined(__APPLE__)
98   char cmd[sizeof(pid_t)*3 + sizeof("vmmap -w -resident -submap -allSplitLibs -interleaved ") + 1];
99 #else
100   char path[sizeof(pid_t)*3 + sizeof("/proc//maps") + 1];
101 #endif
102   char line[1024];
103 
104 #if defined(__APPLE__)
105   // cmd is guaranteed to always be big enough to hold this string.
106   snprintf(cmd, sizeof(cmd), "vmmap -w -resident -submap -allSplitLibs -interleaved %d", pid_);
107   FILE* fp = popen(cmd, "r");
108 #else
109   // path is guaranteed to always be big enough to hold this string.
110   snprintf(path, sizeof(path), "/proc/%d/maps", pid_);
111   FILE* fp = fopen(path, "r");
112 #endif
113   if (fp == nullptr) {
114     return false;
115   }
116 
117   while(fgets(line, sizeof(line), fp)) {
118     backtrace_map_t map;
119     if (ParseLine(line, &map)) {
120       maps_.push_back(map);
121     }
122   }
123 #if defined(__APPLE__)
124   pclose(fp);
125 #else
126   fclose(fp);
127 #endif
128 
129   return true;
130 }
131 
132 #if defined(__APPLE__)
133 // Corkscrew and libunwind don't compile on the mac, so create a generic
134 // map object.
135 BacktraceMap* BacktraceMap::Create(pid_t pid, bool /*uncached*/) {
136   BacktraceMap* map = new BacktraceMap(pid);
137   if (!map->Build()) {
138     delete map;
139     return nullptr;
140   }
141   return map;
142 }
143 #endif
144 
145 BacktraceMap* BacktraceMap::Create(pid_t pid, const std::vector<backtrace_map_t>& maps) {
146     BacktraceMap* backtrace_map = new BacktraceMap(pid);
147     backtrace_map->maps_.insert(backtrace_map->maps_.begin(), maps.begin(), maps.end());
148     std::sort(backtrace_map->maps_.begin(), backtrace_map->maps_.end(),
149             [](const backtrace_map_t& map1, const backtrace_map_t& map2) {
150               return map1.start < map2.start;
151             });
152     return backtrace_map;
153 }
154