1 /*
2 * Copyright (C) 2023 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 "src/trace_processor/importers/proto/network_trace_module.h"
18
19 #include "src/trace_processor/importers/common/args_tracker.h"
20 #include "src/trace_processor/importers/common/args_translation_table.h"
21 #include "src/trace_processor/importers/common/async_track_set_tracker.h"
22 #include "src/trace_processor/importers/common/global_args_tracker.h"
23 #include "src/trace_processor/importers/common/process_track_translation_table.h"
24 #include "src/trace_processor/importers/common/slice_tracker.h"
25 #include "src/trace_processor/importers/common/slice_translation_table.h"
26 #include "src/trace_processor/importers/common/track_tracker.h"
27 #include "src/trace_processor/importers/proto/proto_trace_parser_impl.h"
28 #include "src/trace_processor/importers/proto/proto_trace_reader.h"
29 #include "src/trace_processor/sorter/trace_sorter.h"
30 #include "src/trace_processor/types/trace_processor_context.h"
31 #include "test/gtest_and_gmock.h"
32
33 namespace perfetto {
34 namespace trace_processor {
35 namespace {
36 using ::perfetto::protos::pbzero::TrafficDirection;
37
38 class NetworkTraceModuleTest : public testing::Test {
39 public:
NetworkTraceModuleTest()40 NetworkTraceModuleTest() {
41 context_.storage.reset(new TraceStorage());
42 storage_ = context_.storage.get();
43
44 context_.track_tracker.reset(new TrackTracker(&context_));
45 context_.slice_tracker.reset(new SliceTracker(&context_));
46 context_.args_tracker.reset(new ArgsTracker(&context_));
47 context_.global_args_tracker.reset(new GlobalArgsTracker(storage_));
48 context_.slice_translation_table.reset(new SliceTranslationTable(storage_));
49 context_.process_track_translation_table.reset(
50 new ProcessTrackTranslationTable(storage_));
51 context_.args_translation_table.reset(new ArgsTranslationTable(storage_));
52 context_.async_track_set_tracker.reset(new AsyncTrackSetTracker(&context_));
53 context_.proto_trace_parser.reset(new ProtoTraceParserImpl(&context_));
54 context_.sorter.reset(
55 new TraceSorter(&context_, TraceSorter::SortingMode::kFullSort));
56 }
57
TokenizeAndParse()58 util::Status TokenizeAndParse() {
59 context_.chunk_reader.reset(new ProtoTraceReader(&context_));
60
61 trace_->Finalize();
62 std::vector<uint8_t> v = trace_.SerializeAsArray();
63 trace_.Reset();
64
65 auto status = context_.chunk_reader->Parse(
66 TraceBlobView(TraceBlob::CopyFrom(v.data(), v.size())));
67 context_.sorter->ExtractEventsForced();
68 context_.slice_tracker->FlushPendingSlices();
69 context_.args_tracker->Flush();
70 return status;
71 }
72
HasArg(ArgSetId sid,base::StringView key,Variadic value)73 bool HasArg(ArgSetId sid, base::StringView key, Variadic value) {
74 StringId key_id = storage_->InternString(key);
75 const auto& a = storage_->arg_table();
76 Query q;
77 q.constraints = {a.arg_set_id().eq(sid)};
78 for (auto it = a.FilterToIterator(q); it; ++it) {
79 if (it.key() == key_id) {
80 EXPECT_EQ(it.flat_key(), key_id);
81 if (storage_->GetArgValue(it.row_number().row_number()) == value) {
82 return true;
83 }
84 }
85 }
86 return false;
87 }
88
89 protected:
90 protozero::HeapBuffered<protos::pbzero::Trace> trace_;
91 TraceProcessorContext context_;
92 TraceStorage* storage_;
93 };
94
TEST_F(NetworkTraceModuleTest,ParseAndFormatPacket)95 TEST_F(NetworkTraceModuleTest, ParseAndFormatPacket) {
96 NetworkTraceModule module(&context_);
97
98 auto* packet = trace_->add_packet();
99 packet->set_timestamp(123);
100
101 auto* event = packet->set_network_packet();
102 event->set_direction(TrafficDirection::DIR_EGRESS);
103 event->set_length(72);
104 event->set_uid(1010);
105 event->set_tag(0x407);
106 event->set_local_port(5100);
107 event->set_remote_port(443);
108 event->set_tcp_flags(0b10010);
109 event->set_ip_proto(6);
110 event->set_interface("wlan");
111
112 ASSERT_TRUE(TokenizeAndParse().ok());
113
114 const auto& slices = storage_->slice_table();
115 ASSERT_EQ(slices.row_count(), 1u);
116 EXPECT_EQ(slices.ts()[0], 123);
117
118 EXPECT_TRUE(HasArg(1u, "packet_length", Variadic::Integer(72)));
119 EXPECT_TRUE(HasArg(1u, "socket_uid", Variadic::Integer(1010)));
120 EXPECT_TRUE(HasArg(1u, "local_port", Variadic::Integer(5100)));
121 EXPECT_TRUE(HasArg(1u, "remote_port", Variadic::Integer(443)));
122 EXPECT_TRUE(HasArg(1u, "packet_transport",
123 Variadic::String(storage_->InternString("IPPROTO_TCP"))));
124 EXPECT_TRUE(HasArg(1u, "socket_tag",
125 Variadic::String(storage_->InternString("0x407"))));
126 EXPECT_TRUE(HasArg(1u, "packet_tcp_flags",
127 Variadic::String(storage_->InternString(".s..a..."))));
128 }
129
TEST_F(NetworkTraceModuleTest,TokenizeAndParsePerPacketBundle)130 TEST_F(NetworkTraceModuleTest, TokenizeAndParsePerPacketBundle) {
131 NetworkTraceModule module(&context_);
132
133 auto* packet = trace_->add_packet();
134 packet->set_timestamp(123);
135
136 protozero::PackedVarInt timestamps;
137 timestamps.Append(0);
138 timestamps.Append(10);
139
140 protozero::PackedVarInt lengths;
141 lengths.Append(72);
142 lengths.Append(100);
143
144 auto* event = packet->set_network_packet_bundle();
145 event->set_packet_timestamps(timestamps);
146 event->set_packet_lengths(lengths);
147
148 auto* ctx = event->set_ctx();
149 ctx->set_uid(456);
150
151 ASSERT_TRUE(TokenizeAndParse().ok());
152
153 const auto& slices = storage_->slice_table();
154 ASSERT_EQ(slices.row_count(), 2u);
155 EXPECT_EQ(slices.ts()[0], 123);
156 EXPECT_EQ(slices.ts()[1], 133);
157
158 EXPECT_TRUE(HasArg(1u, "packet_length", Variadic::Integer(72)));
159 EXPECT_TRUE(HasArg(2u, "packet_length", Variadic::Integer(100)));
160 }
161
TEST_F(NetworkTraceModuleTest,TokenizeAndParseAggregateBundle)162 TEST_F(NetworkTraceModuleTest, TokenizeAndParseAggregateBundle) {
163 NetworkTraceModule module(&context_);
164
165 auto* packet = trace_->add_packet();
166 packet->set_timestamp(123);
167
168 auto* event = packet->set_network_packet_bundle();
169 event->set_total_packets(2);
170 event->set_total_duration(10);
171 event->set_total_length(172);
172
173 auto* ctx = event->set_ctx();
174 ctx->set_uid(456);
175
176 ASSERT_TRUE(TokenizeAndParse().ok());
177
178 const auto& slices = storage_->slice_table();
179 ASSERT_EQ(slices.row_count(), 1u);
180 EXPECT_EQ(slices.ts()[0], 123);
181 EXPECT_EQ(slices.dur()[0], 10);
182
183 EXPECT_TRUE(HasArg(1u, "packet_length", Variadic::Integer(172)));
184 EXPECT_TRUE(HasArg(1u, "packet_count", Variadic::Integer(2)));
185 }
186
187 } // namespace
188 } // namespace trace_processor
189 } // namespace perfetto
190