aboutsummaryrefslogtreecommitdiff
path: root/lldb/unittests/Process/Utility/LinuxProcMapsTest.cpp
blob: d94bb4f4db982cb6c2a57e6abe425a49815cddd9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
//===-- LinuxProcMapsTest.cpp ---------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#include "gmock/gmock.h"
#include "gtest/gtest.h"

#include "Plugins/Process/Utility/LinuxProcMaps.h"
#include "lldb/Target/MemoryRegionInfo.h"
#include "lldb/Utility/Status.h"
#include <tuple>

using namespace lldb_private;

typedef std::tuple<const char *, MemoryRegionInfos, const char *>
    LinuxProcMapsTestParams;

// Wrapper for convenience because Range is usually begin, size
static MemoryRegionInfo::RangeType make_range(lldb::addr_t begin,
                                              lldb::addr_t end) {
  MemoryRegionInfo::RangeType range(begin, 0);
  range.SetRangeEnd(end);
  return range;
}

class LinuxProcMapsTestFixture
    : public ::testing::TestWithParam<LinuxProcMapsTestParams> {
protected:
  Status error;
  std::string err_str;
  MemoryRegionInfos regions;
  LinuxMapCallback callback;

  void SetUp() override {
    callback = [this](llvm::Expected<MemoryRegionInfo> Info) {
      if (Info) {
        err_str.clear();
        regions.push_back(*Info);
        return true;
      }

      err_str = toString(Info.takeError());
      return false;
    };
  }

  void check_regions(LinuxProcMapsTestParams params) {
    EXPECT_THAT(std::get<1>(params), testing::ContainerEq(regions));
    ASSERT_EQ(std::get<2>(params), err_str);
  }
};

TEST_P(LinuxProcMapsTestFixture, ParseMapRegions) {
  auto params = GetParam();
  ParseLinuxMapRegions(std::get<0>(params), callback);
  check_regions(params);
}

// Note: ConstString("") != ConstString(nullptr)
// When a region has no name, it will have the latter in the MemoryRegionInfo
INSTANTIATE_TEST_SUITE_P(
    ProcMapTests, LinuxProcMapsTestFixture,
    ::testing::Values(
        // Nothing in nothing out
        std::make_tuple("", MemoryRegionInfos{}, ""),
        // Various formatting error conditions
        std::make_tuple("55a4512f7000/55a451b68000 rw-p 00000000 00:00 0",
                        MemoryRegionInfos{},
                        "malformed /proc/{pid}/maps entry, missing dash "
                        "between address range"),
        std::make_tuple("0-0 rw", MemoryRegionInfos{},
                        "malformed /proc/{pid}/maps entry, missing some "
                        "portion of permissions"),
        std::make_tuple("0-0 z--p 00000000 00:00 0", MemoryRegionInfos{},
                        "unexpected /proc/{pid}/maps read permission char"),
        std::make_tuple("0-0 rz-p 00000000 00:00 0", MemoryRegionInfos{},
                        "unexpected /proc/{pid}/maps write permission char"),
        std::make_tuple("0-0 rwzp 00000000 00:00 0", MemoryRegionInfos{},
                        "unexpected /proc/{pid}/maps exec permission char"),
        // Stops at first parsing error
        std::make_tuple(
            "0-1 rw-p 00000000 00:00 0 [abc]\n"
            "0-0 rwzp 00000000 00:00 0\n"
            "2-3 r-xp 00000000 00:00 0 [def]\n",
            MemoryRegionInfos{
                MemoryRegionInfo(
                    make_range(0, 1), MemoryRegionInfo::eYes,
                    MemoryRegionInfo::eYes, MemoryRegionInfo::eNo,
                    MemoryRegionInfo::eNo, MemoryRegionInfo::eYes,
                    ConstString("[abc]"), MemoryRegionInfo::eDontKnow, 0,
                    MemoryRegionInfo::eDontKnow, MemoryRegionInfo::eDontKnow,
                    MemoryRegionInfo::eDontKnow),
            },
            "unexpected /proc/{pid}/maps exec permission char"),
        // Single entry
        std::make_tuple(
            "55a4512f7000-55a451b68000 rw-p 00000000 00:00 0    [heap]",
            MemoryRegionInfos{
                MemoryRegionInfo(
                    make_range(0x55a4512f7000, 0x55a451b68000),
                    MemoryRegionInfo::eYes, MemoryRegionInfo::eYes,
                    MemoryRegionInfo::eNo, MemoryRegionInfo::eNo,
                    MemoryRegionInfo::eYes, ConstString("[heap]"),
                    MemoryRegionInfo::eDontKnow, 0, MemoryRegionInfo::eDontKnow,
                    MemoryRegionInfo::eDontKnow, MemoryRegionInfo::eDontKnow),
            },
            ""),
        // Multiple entries
        std::make_tuple(
            "7fc090021000-7fc094000000 ---p 00000000 00:00 0\n"
            "7fc094000000-7fc094a00000 ---s 00000000 00:00 0\n"
            "ffffffffff600000-ffffffffff601000 r-xp 00000000 00:00 0 "
            "[vsyscall]",
            MemoryRegionInfos{
                MemoryRegionInfo(
                    make_range(0x7fc090021000, 0x7fc094000000),
                    MemoryRegionInfo::eNo, MemoryRegionInfo::eNo,
                    MemoryRegionInfo::eNo, MemoryRegionInfo::eNo,
                    MemoryRegionInfo::eYes, ConstString(nullptr),
                    MemoryRegionInfo::eDontKnow, 0, MemoryRegionInfo::eDontKnow,
                    MemoryRegionInfo::eDontKnow, MemoryRegionInfo::eDontKnow),
                MemoryRegionInfo(
                    make_range(0x7fc094000000, 0x7fc094a00000),
                    MemoryRegionInfo::eNo, MemoryRegionInfo::eNo,
                    MemoryRegionInfo::eNo, MemoryRegionInfo::eYes,
                    MemoryRegionInfo::eYes, ConstString(nullptr),
                    MemoryRegionInfo::eDontKnow, 0, MemoryRegionInfo::eDontKnow,
                    MemoryRegionInfo::eDontKnow, MemoryRegionInfo::eDontKnow),
                MemoryRegionInfo(
                    make_range(0xffffffffff600000, 0xffffffffff601000),
                    MemoryRegionInfo::eYes, MemoryRegionInfo::eNo,
                    MemoryRegionInfo::eYes, MemoryRegionInfo::eNo,
                    MemoryRegionInfo::eYes, ConstString("[vsyscall]"),
                    MemoryRegionInfo::eDontKnow, 0, MemoryRegionInfo::eDontKnow,
                    MemoryRegionInfo::eDontKnow, MemoryRegionInfo::eDontKnow),
            },
            "")));

class LinuxProcSMapsTestFixture : public LinuxProcMapsTestFixture {};

INSTANTIATE_TEST_SUITE_P(
    ProcSMapTests, LinuxProcSMapsTestFixture,
    ::testing::Values(
        // Nothing in nothing out
        std::make_tuple("", MemoryRegionInfos{}, ""),
        // Uses the same parsing for first line, so same errors but referring to
        // smaps
        std::make_tuple("0/0 rw-p 00000000 00:00 0", MemoryRegionInfos{},
                        "malformed /proc/{pid}/smaps entry, missing dash "
                        "between address range"),
        // Stop parsing at first error
        std::make_tuple(
            "1111-2222 rw-p 00000000 00:00 0 [foo]\n"
            "0/0 rw-p 00000000 00:00 0",
            MemoryRegionInfos{
                MemoryRegionInfo(
                    make_range(0x1111, 0x2222), MemoryRegionInfo::eYes,
                    MemoryRegionInfo::eYes, MemoryRegionInfo::eNo,
                    MemoryRegionInfo::eNo, MemoryRegionInfo::eYes,
                    ConstString("[foo]"), MemoryRegionInfo::eDontKnow, 0,
                    MemoryRegionInfo::eDontKnow, MemoryRegionInfo::eDontKnow,
                    MemoryRegionInfo::eDontKnow),
            },
            "malformed /proc/{pid}/smaps entry, missing dash between address "
            "range"),
        // Property line without a region is an error
        std::make_tuple("Referenced:         2188 kB\n"
                        "1111-2222 rw-p 00000000 00:00 0    [foo]\n"
                        "3333-4444 rw-p 00000000 00:00 0    [bar]\n",
                        MemoryRegionInfos{},
                        "Found a property line without a corresponding mapping "
                        "in /proc/{pid}/smaps"),
        // Single region parses, has no flags
        std::make_tuple(
            "1111-2222 rw-p 00000000 00:00 0    [foo]",
            MemoryRegionInfos{
                MemoryRegionInfo(
                    make_range(0x1111, 0x2222), MemoryRegionInfo::eYes,
                    MemoryRegionInfo::eYes, MemoryRegionInfo::eNo,
                    MemoryRegionInfo::eNo, MemoryRegionInfo::eYes,
                    ConstString("[foo]"), MemoryRegionInfo::eDontKnow, 0,
                    MemoryRegionInfo::eDontKnow, MemoryRegionInfo::eDontKnow,
                    MemoryRegionInfo::eDontKnow),
            },
            ""),
        // Single shared region parses, has no flags
        std::make_tuple(
            "1111-2222 rw-s 00000000 00:00 0    [foo]",
            MemoryRegionInfos{
                MemoryRegionInfo(
                    make_range(0x1111, 0x2222), MemoryRegionInfo::eYes,
                    MemoryRegionInfo::eYes, MemoryRegionInfo::eNo,
                    MemoryRegionInfo::eYes, MemoryRegionInfo::eYes,
                    ConstString("[foo]"), MemoryRegionInfo::eDontKnow, 0,
                    MemoryRegionInfo::eDontKnow, MemoryRegionInfo::eDontKnow,
                    MemoryRegionInfo::eDontKnow),
            },
            ""),
        // Single region with flags, other lines ignored
        std::make_tuple(
            "1111-2222 rw-p 00000000 00:00 0    [foo]\n"
            "Referenced:         2188 kB\n"
            "AnonHugePages:         0 kB\n"
            "VmFlags: mt",
            MemoryRegionInfos{
                MemoryRegionInfo(
                    make_range(0x1111, 0x2222), MemoryRegionInfo::eYes,
                    MemoryRegionInfo::eYes, MemoryRegionInfo::eNo,
                    MemoryRegionInfo::eNo, MemoryRegionInfo::eYes,
                    ConstString("[foo]"), MemoryRegionInfo::eDontKnow, 0,
                    MemoryRegionInfo::eYes, MemoryRegionInfo::eDontKnow,
                    MemoryRegionInfo::eNo),
            },
            ""),
        // Whitespace ignored
        std::make_tuple(
            "0-0 rw-p 00000000 00:00 0\n"
            "VmFlags:      mt      ",
            MemoryRegionInfos{
                MemoryRegionInfo(
                    make_range(0, 0), MemoryRegionInfo::eYes,
                    MemoryRegionInfo::eYes, MemoryRegionInfo::eNo,
                    MemoryRegionInfo::eNo, MemoryRegionInfo::eYes,
                    ConstString(nullptr), MemoryRegionInfo::eDontKnow, 0,
                    MemoryRegionInfo::eYes, MemoryRegionInfo::eDontKnow,
                    MemoryRegionInfo::eNo),
            },
            ""),
        // VmFlags line means it has flag info, but nothing is set
        std::make_tuple(
            "0-0 rw-p 00000000 00:00 0\n"
            "VmFlags:         ",
            MemoryRegionInfos{
                MemoryRegionInfo(
                    make_range(0, 0), MemoryRegionInfo::eYes,
                    MemoryRegionInfo::eYes, MemoryRegionInfo::eNo,
                    MemoryRegionInfo::eNo, MemoryRegionInfo::eYes,
                    ConstString(nullptr), MemoryRegionInfo::eDontKnow, 0,
                    MemoryRegionInfo::eNo, MemoryRegionInfo::eDontKnow,
                    MemoryRegionInfo::eNo),
            },
            ""),
        // Handle some pages not having a flags line
        std::make_tuple(
            "1111-2222 rw-p 00000000 00:00 0    [foo]\n"
            "Referenced:         2188 kB\n"
            "AnonHugePages:         0 kB\n"
            "3333-4444 r-xp 00000000 00:00 0    [bar]\n"
            "VmFlags: mt",
            MemoryRegionInfos{
                MemoryRegionInfo(
                    make_range(0x1111, 0x2222), MemoryRegionInfo::eYes,
                    MemoryRegionInfo::eYes, MemoryRegionInfo::eNo,
                    MemoryRegionInfo::eNo, MemoryRegionInfo::eYes,
                    ConstString("[foo]"), MemoryRegionInfo::eDontKnow, 0,
                    MemoryRegionInfo::eDontKnow, MemoryRegionInfo::eDontKnow,
                    MemoryRegionInfo::eDontKnow),
                MemoryRegionInfo(
                    make_range(0x3333, 0x4444), MemoryRegionInfo::eYes,
                    MemoryRegionInfo::eNo, MemoryRegionInfo::eYes,
                    MemoryRegionInfo::eNo, MemoryRegionInfo::eYes,
                    ConstString("[bar]"), MemoryRegionInfo::eDontKnow, 0,
                    MemoryRegionInfo::eYes, MemoryRegionInfo::eDontKnow,
                    MemoryRegionInfo::eNo),
            },
            ""),
        // Handle no pages having a flags line (older kernels)
        std::make_tuple(
            "1111-2222 rw-p 00000000 00:00 0\n"
            "Referenced:         2188 kB\n"
            "AnonHugePages:         0 kB\n"
            "3333-4444 r-xp 00000000 00:00 0\n"
            "KernelPageSize:        4 kB\n"
            "MMUPageSize:           4 kB\n",
            MemoryRegionInfos{
                MemoryRegionInfo(
                    make_range(0x1111, 0x2222), MemoryRegionInfo::eYes,
                    MemoryRegionInfo::eYes, MemoryRegionInfo::eNo,
                    MemoryRegionInfo::eNo, MemoryRegionInfo::eYes,
                    ConstString(nullptr), MemoryRegionInfo::eDontKnow, 0,
                    MemoryRegionInfo::eDontKnow, MemoryRegionInfo::eDontKnow,
                    MemoryRegionInfo::eDontKnow),
                MemoryRegionInfo(
                    make_range(0x3333, 0x4444), MemoryRegionInfo::eYes,
                    MemoryRegionInfo::eNo, MemoryRegionInfo::eYes,
                    MemoryRegionInfo::eNo, MemoryRegionInfo::eYes,
                    ConstString(nullptr), MemoryRegionInfo::eDontKnow, 0,
                    MemoryRegionInfo::eDontKnow, MemoryRegionInfo::eDontKnow,
                    MemoryRegionInfo::eDontKnow),
            },
            ""),
        // We must look for exact flag strings, ignoring substrings of longer
        // flag names.
        std::make_tuple(
            "0-0 rw-p 00000000 00:00 0\n"
            "VmFlags: amt mtb amtb",
            MemoryRegionInfos{
                MemoryRegionInfo(
                    make_range(0, 0), MemoryRegionInfo::eYes,
                    MemoryRegionInfo::eYes, MemoryRegionInfo::eNo,
                    MemoryRegionInfo::eNo, MemoryRegionInfo::eYes,
                    ConstString(nullptr), MemoryRegionInfo::eDontKnow, 0,
                    MemoryRegionInfo::eNo, MemoryRegionInfo::eDontKnow,
                    MemoryRegionInfo::eNo),
            },
            "")));

TEST_P(LinuxProcSMapsTestFixture, ParseSMapRegions) {
  auto params = GetParam();
  ParseLinuxSMapRegions(std::get<0>(params), callback);
  check_regions(params);
}