File: async_action.cpp

package info (click to toggle)
bpftrace 0.24.1-1.1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 10,496 kB
  • sloc: cpp: 60,982; ansic: 10,952; python: 953; yacc: 665; sh: 536; lex: 295; makefile: 22
file content (477 lines) | stat: -rw-r--r-- 15,901 bytes parent folder | download
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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
#include <regex>

#include "ast/async_event_types.h"
#include "async_action.h"
#include "attached_probe.h"
#include "bpftrace.h"
#include "location.hh"
#include "mocks.h"
#include "output/text.h"
#include "types.h"
#include "util/exceptions.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"

namespace bpftrace::test::async_action {

using namespace bpftrace::async_action;

// Used for resolving all C definitions.
static ast::CDefinitions no_c_defs;

class AsyncActionTest : public testing::Test {
public:
  AsyncActionTest()
      : bpftrace(get_mock_bpftrace()),
        output(out, out),
        handlers(*bpftrace, no_c_defs, output) {};

  std::unique_ptr<MockBPFtrace> bpftrace;
  std::stringstream out;
  output::TextOutput output;
  AsyncHandlers handlers;
};

// Process string type argument - handle const char*
template <typename T, typename... R>
void build_each_field(std::vector<Field> &fields,
                      ssize_t offset,
                      T arg,
                      R... rest)
{
  SizedType ty;
  // We only pack string and integer values.
  if constexpr (std::is_same_v<T, std::string>) {
    ty = CreateString(arg.size() + 1);
  } else if constexpr (std::is_integral_v<T>) {
    ty = CreateInt(sizeof(T) * 8);
  } else {
    static_assert(false, "unknown field type");
  }
  fields.push_back(Field{
      .name = "arg", .type = ty, .offset = offset, .bitfield = std::nullopt });
  if constexpr (sizeof...(R) != 0) {
    build_each_field(fields, offset + ty.GetSize(), rest...);
  }
}

template <typename... Ts>
std::vector<Field> build_fields(Ts... args)
{
  std::vector<Field> fields;
  if constexpr (sizeof...(Ts) != 0) {
    build_each_field(fields, 0, args...);
  }
  return fields;
}

template <AsyncAction id, typename... Args>
std::string handler_proxy(AsyncActionTest &test,
                          std::string &fmt_str,
                          [[maybe_unused]] Args... args)
{
  FormatString fmt(fmt_str);

  auto fields = build_fields(args...);
  auto arg_data = OpaqueValue::from(static_cast<uint64_t>(id));
  arg_data = (arg_data + ... + OpaqueValue::from<Args>(args));

  static_assert((id == AsyncAction::syscall || id == AsyncAction::cat ||
                 id == AsyncAction::printf) &&
                "Only support syscall, cat, and printf");
  if (id == AsyncAction::syscall) {
    test.bpftrace->resources.system_args.emplace_back(fmt, fields);
    test.handlers.syscall(arg_data);
  } else if (id == AsyncAction::cat) {
    test.bpftrace->resources.cat_args.emplace_back(fmt, fields);
    test.handlers.cat(arg_data);
  } else if (id == AsyncAction::printf) {
    test.bpftrace->resources.printf_args.emplace_back(
        fmt, fields, PrintfSeverity::NONE, SourceInfo());
    test.handlers.printf(arg_data);
  }

  auto s = test.out.str();
  test.out.str("");
  return s;
}

TEST_F(AsyncActionTest, join)
{
  bpftrace->resources.join_args.emplace_back(",");

  auto join = AsyncEvent::Join{
    .action_id = static_cast<uint64_t>(AsyncAction::join),
    .join_id = 0,
    .content = {},
  };
  auto arg = OpaqueValue::from(join) +
             OpaqueValue::string("/bin/ls", bpftrace->join_argsize_) +
             OpaqueValue::string("-la", bpftrace->join_argsize_) +
             OpaqueValue::string("/tmp", bpftrace->join_argsize_);

  handlers.join(arg);
  EXPECT_EQ("/bin/ls,-la,/tmp\n", out.str());
}

TEST_F(AsyncActionTest, time)
{
  bpftrace->resources.time_args.emplace_back("%Y-%m-%d");
  bpftrace->resources.time_args.emplace_back("%H:%M:%S");
  bpftrace->resources.time_args.emplace_back("%a, %d %b %Y");

  // The first format
  {
    AsyncEvent::Time time_event(static_cast<int>(AsyncAction::time), 0);
    handlers.time(OpaqueValue::from(time_event));

    std::regex pattern(R"(\d{4}-\d{2}-\d{2})");
    EXPECT_TRUE(std::regex_match(out.str(), pattern));
    out.str("");
  }

  // The second format
  {
    AsyncEvent::Time time_event(static_cast<int>(AsyncAction::time), 1);
    handlers.time(OpaqueValue::from(time_event));

    std::regex pattern(R"(\d{2}:\d{2}:\d{2})");
    EXPECT_TRUE(std::regex_match(out.str(), pattern));
    out.str("");
  }

  // The third format
  {
    AsyncEvent::Time time_event(static_cast<int>(AsyncAction::time), 2);
    handlers.time(OpaqueValue::from(time_event));

    std::regex pattern(R"([A-Za-z]+, \d{2} [A-Za-z]+ \d{4})");
    EXPECT_TRUE(std::regex_match(out.str(), pattern));
  }
}

TEST_F(AsyncActionTest, time_invalid_format)
{
  // invalid time format string
  std::string very_long_format(
      bpftrace::async_action::AsyncHandlers::MAX_TIME_STR_LEN, 'X');
  very_long_format = "%Y-%m-%d " + very_long_format;
  bpftrace->resources.time_args.emplace_back(very_long_format);
  AsyncEvent::Time time_event(static_cast<int>(AsyncAction::time), 0);

  testing::internal::CaptureStderr();

  handlers.time(OpaqueValue::from(time_event));
  EXPECT_TRUE(out.str().empty());

  std::string log = testing::internal::GetCapturedStderr();

  EXPECT_THAT(log, testing::HasSubstr("strftime returned 0"));
}

TEST_F(AsyncActionTest, runtime_error)
{
  struct TestCase {
    RuntimeErrorId rte_id;
    libbpf::bpf_func_id func_id;
    int return_value;
    std::string expected_substring;
    std::string filename;
    unsigned int line;
    unsigned int column;
  };

  std::vector<TestCase> test_cases = {
    // case 1: `map_update_elem` returns `-E2BIG`
    { .rte_id = RuntimeErrorId::HELPER_ERROR,
      .func_id = libbpf::BPF_FUNC_map_update_elem,
      .return_value = -E2BIG,
      .expected_substring = "WARNING: Map full; can't update element",
      .filename = std::string("test1.bt"),
      .line = 10,
      .column = 5 },
    // case 2: `map_delete_elem` returns `-ENOENT`
    { .rte_id = RuntimeErrorId::HELPER_ERROR,
      .func_id = libbpf::BPF_FUNC_map_delete_elem,
      .return_value = -ENOENT,
      .expected_substring =
          "WARNING: Can't delete map element because it does not exist",
      .filename = std::string("test2.bt"),
      .line = 15,
      .column = 8 },
    // case 3: `map_lookup_elem` failed to lookup map element
    { .rte_id = RuntimeErrorId::HELPER_ERROR,
      .func_id = libbpf::BPF_FUNC_map_lookup_elem,
      .return_value = 0,
      .expected_substring =
          "WARNING: Can't lookup map element because it does not exist",
      .filename = std::string("test3.bt"),
      .line = 20,
      .column = 3 },
    // case 4: default case - other function ID and error code
    { .rte_id = RuntimeErrorId::HELPER_ERROR,
      .func_id = libbpf::BPF_FUNC_trace_printk,
      .return_value = -EPERM,
      .expected_substring = "WARNING: " + std::string(strerror(EPERM)),
      .filename = std::string("test4.bt"),
      .line = 25,
      .column = 1 },
    // case 5: divide by zero error
    { .rte_id = RuntimeErrorId::DIVIDE_BY_ZERO,
      .func_id = libbpf::BPF_FUNC_trace_printk, // unused
      .return_value = 0,                        // unused
      .expected_substring =
          "WARNING: Divide or modulo by 0 detected. This can lead to "
          "unexpected results. 1 is being used as the result.",
      .filename = std::string("test4.bt"),
      .line = 25,
      .column = 1 }
  };

  uint64_t async_id = 1;
  for (const auto &tc : test_cases) {
    auto src_loc = ast::SourceLocation(
        location(&tc.filename, tc.line, tc.column));
    auto location_chain = std::make_shared<ast::LocationChain>(src_loc);
    RuntimeErrorInfo info(tc.rte_id, tc.func_id, location_chain);

    bpftrace->resources.runtime_error_info.emplace(async_id, std::move(info));

    AsyncEvent::RuntimeError error_event(static_cast<int64_t>(
                                             AsyncAction::runtime_error),
                                         async_id,
                                         tc.return_value);

    handlers.runtime_error(OpaqueValue::from(error_event));

    auto s = out.str();

    EXPECT_THAT(s, testing::HasSubstr(tc.expected_substring))
        << "warning substring doesn't have string";

    std::string expected_loc = std::to_string(tc.line) + ":" +
                               std::to_string(tc.column);
    EXPECT_THAT(s, testing::HasSubstr(expected_loc))
        << "Source location not found in output: " << expected_loc;

    EXPECT_THAT(s, testing::HasSubstr(std::to_string(tc.return_value)))
        << "Return value not found in output: " << tc.return_value;
    ++async_id;
  }
}

TEST_F(AsyncActionTest, syscall)
{
  struct TestCase {
    std::string cmd;
    std::optional<std::string> args;
    std::string expected_substring;
  };

  std::vector<TestCase> test_cases = {
    { .cmd = std::string("echo test"),
      .args = std::nullopt,
      .expected_substring = "test" },
    { .cmd = std::string("echo %s"),
      .args = "test",
      .expected_substring = "test" },
  };

  bpftrace->safe_mode_ = false;
  for (auto &tc : test_cases) {
    std::string out;
    if (tc.args.has_value()) {
      out = handler_proxy<AsyncAction::syscall>(*this, tc.cmd, tc.args.value());
    } else {
      out = handler_proxy<AsyncAction::syscall>(*this, tc.cmd);
    }

    EXPECT_THAT(out, testing::HasSubstr(tc.expected_substring))
        << "Syscall output should contain the result of 'echo test'";
  }
}

TEST_F(AsyncActionTest, syscall_safe_mode)
{
  auto cmd = std::string("echo test");

  std::string out;
  try {
    out = handler_proxy<AsyncAction::syscall>(*this, cmd);
    FAIL() << "Expected syscall_handler to throw an exception in safe mode";
  } catch (const util::FatalUserException &ex) {
    EXPECT_THAT(std::string(ex.what()),
                testing::HasSubstr(
                    "syscall() not allowed in safe mode. Use '--unsafe'."))
        << "Exception should indicate syscall is not allowed in safe mode";
  } catch (...) {
    FAIL() << "Expected syscall_handler to throw a FatalUserException in safe "
              "mode";
  }

  EXPECT_TRUE(out.empty()) << "No output should be generated in safe mode";
}

TEST_F(AsyncActionTest, cat)
{
  std::string test_content = "Hello, cat_handler test!\nThis is line 2.\n";
  char filename[] = "/tmp/bpftrace-test-cat-XXXXXX";
  int fd = mkstemp(filename);
  ASSERT_NE(fd, -1) << "Failed to create temporary file";
  ASSERT_EQ(write(fd, test_content.c_str(), test_content.length()),
            static_cast<ssize_t>(test_content.length()));
  close(fd);

  bpftrace->config_->max_cat_bytes = 1024;
  auto cmd = std::string("%s/%s");
  std::string basename = std::string(filename).substr(5);
  std::string out = handler_proxy<AsyncAction::cat>(
      *this, cmd, std::string("/tmp"), basename);

  EXPECT_EQ(test_content, out)
      << "cat_handler should output the file content correctly";

  std::remove(filename);
}

TEST_F(AsyncActionTest, printf)
{
  std::string format = "Multiple: %s=%d (0x%llx) char=%hhu";
  char expected_buffer[64];
  snprintf(expected_buffer,
           sizeof(expected_buffer),
           format.c_str(),
           "answer",
           42,
           0xDEADBEEFULL,
           'a');
  std::string expected(expected_buffer);

  std::string out = handler_proxy<AsyncAction::printf>(*this,
                                                       format,
                                                       std::string("answer"),
                                                       42ULL,
                                                       0xDEADBEEFULL,
                                                       static_cast<uint64_t>(
                                                           'a'));

  EXPECT_EQ(expected, out)
      << "printf_handler should format multiple arguments correctly";
}

TEST_F(AsyncActionTest, print_non_map)
{
  struct TestCase {
    SizedType type;
    OpaqueValue content;
    std::string expected_output;
  };

  std::vector<TestCase> test_cases = {
    // Integer type test
    { .type = CreateInt64(),
      .content = OpaqueValue::from<int64_t>(123456789),
      .expected_output = "123456789\n" },
    // String type test
    { .type = CreateString(12),
      .content = OpaqueValue::string("Hello world", 12),
      .expected_output = "Hello world\n" }
  };

  for (const auto &tc : test_cases) {
    bpftrace->resources.non_map_print_args.clear();
    bpftrace->resources.non_map_print_args.emplace_back(tc.type);

    auto print_event = AsyncEvent::PrintNonMap{
      .action_id = static_cast<uint64_t>(AsyncAction::print_non_map),
      .print_id = 0,
      .content = {},
    };
    handlers.print_non_map(OpaqueValue::from(print_event) + tc.content);

    EXPECT_EQ(tc.expected_output, out.str());
    out.str("");
  }
}

TEST_F(AsyncActionTest, watchpoint_attach_out_of_bound)
{
  bpftrace->procmon_ = std::make_unique<MockProcMon>(1234);
  auto invalid_index = 10;
  AsyncEvent::Watchpoint watch_event(
      static_cast<int>(AsyncAction::watchpoint_attach), invalid_index, 0x1234);

  // Combine the `EXPECT_CALL` with the `EXPECT_DEATH`
  // FYI: https://github.com/google/googletest/issues/1004
  auto watchpoint_attach_handler_op = [&] {
    EXPECT_CALL(*bpftrace, resume_tracee(testing::_)).Times(1);
    handlers.watchpoint_attach(OpaqueValue::from(watch_event));
  };

  EXPECT_DEATH(watchpoint_attach_handler_op(),
               "Invalid watchpoint probe idx=" + std::to_string(invalid_index));
}

TEST_F(AsyncActionTest, watchpoint_attach_duplicated_address)
{
  bpftrace->procmon_ = std::make_unique<MockProcMon>(1234);
  AsyncEvent::Watchpoint watch_event(
      static_cast<int>(AsyncAction::watchpoint_attach), 0, 0x1234);
  Probe probe;
  probe.type = ProbeType::watchpoint;
  probe.address = 0x1234;
  bpftrace->resources.watchpoint_probes.push_back(std::move(probe));
  EXPECT_CALL(*bpftrace, attach_probe(testing::_, testing::_)).Times(0);
  EXPECT_CALL(*bpftrace, resume_tracee(testing::_)).Times(1);
  handlers.watchpoint_attach(OpaqueValue::from(watch_event));
}

TEST_F(AsyncActionTest, watchpoint_attach_probe_error)
{
  bpftrace->procmon_ = std::make_unique<MockProcMon>(1234);
  AsyncEvent::Watchpoint watch_event(
      static_cast<int>(AsyncAction::watchpoint_attach), 0, 0x1234);
  Probe probe;
  probe.type = ProbeType::watchpoint;
  probe.address = 0x12345678;
  bpftrace->resources.watchpoint_probes.push_back(std::move(probe));
  EXPECT_CALL(*bpftrace, attach_probe(testing::_, testing::_))
      .WillOnce([]([[maybe_unused]] Probe &probe,
                   [[maybe_unused]] const BpfBytecode &bytecode) {
        return make_error<AttachError>();
      });
  EXPECT_THROW(handlers.watchpoint_attach(OpaqueValue::from(watch_event)),
               util::FatalUserException);
}

TEST_F(AsyncActionTest, watchpoint_attach_resume_tracee_failed)
{
  bpftrace->procmon_ = std::make_unique<MockProcMon>(1234);
  AsyncEvent::Watchpoint watch_event(
      static_cast<int>(AsyncAction::watchpoint_attach), 0, 0x1234);
  Probe probe;
  probe.type = ProbeType::watchpoint;
  probe.address = 0x1234;
  bpftrace->resources.watchpoint_probes.push_back(std::move(probe));
  EXPECT_CALL(*bpftrace, attach_probe(testing::_, testing::_)).Times(0);
  EXPECT_CALL(*bpftrace, resume_tracee(testing::_))
      .WillOnce(testing::Return(-1));
  EXPECT_THROW(handlers.watchpoint_attach(OpaqueValue::from(watch_event)),
               util::FatalUserException);
}

TEST_F(AsyncActionTest, asyncwatchpoint_attach_ignore_duplicated_addr)
{
  bpftrace->procmon_ = std::make_unique<MockProcMon>(1234);
  AsyncEvent::Watchpoint watch_event(
      static_cast<int>(AsyncAction::watchpoint_attach), 0, 0x1234);
  Probe probe;
  probe.type = ProbeType::watchpoint;
  probe.address = 0x1234;
  probe.async = true;
  bpftrace->resources.watchpoint_probes.push_back(std::move(probe));
  EXPECT_CALL(*bpftrace, attach_probe(testing::_, testing::_)).Times(0);
  EXPECT_CALL(*bpftrace, resume_tracee(testing::_)).Times(0);
  handlers.watchpoint_attach(OpaqueValue::from(watch_event));
}
} // namespace bpftrace::test::async_action