1 : // Copyright 2012 Google Inc. All Rights Reserved.
2 : //
3 : // Licensed under the Apache License, Version 2.0 (the "License");
4 : // you may not use this file except in compliance with the License.
5 : // You may obtain a copy of the License at
6 : //
7 : // http://www.apache.org/licenses/LICENSE-2.0
8 : //
9 : // Unless required by applicable law or agreed to in writing, software
10 : // distributed under the License is distributed on an "AS IS" BASIS,
11 : // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 : // See the License for the specific language governing permissions and
13 : // limitations under the License.
14 :
15 : #include "syzygy/trace/service/service.h"
16 :
17 : #include <psapi.h>
18 : #include <userenv.h>
19 : #include <memory>
20 :
21 : #include "base/command_line.h"
22 : #include "base/environment.h"
23 : #include "base/files/file_enumerator.h"
24 : #include "base/files/file_util.h"
25 : #include "base/files/scoped_temp_dir.h"
26 : #include "base/process/kill.h"
27 : #include "base/process/launch.h"
28 : #include "base/strings/string_util.h"
29 : #include "base/strings/stringprintf.h"
30 : #include "base/strings/utf_string_conversions.h"
31 : #include "gmock/gmock.h"
32 : #include "gtest/gtest.h"
33 : #include "syzygy/common/align.h"
34 : #include "syzygy/common/rpc/helpers.h"
35 : #include "syzygy/core/unittest_util.h"
36 : #include "syzygy/trace/client/client_utils.h"
37 : #include "syzygy/trace/parse/parse_utils.h"
38 : #include "syzygy/trace/protocol/call_trace_defs.h"
39 : #include "syzygy/trace/service/service_rpc_impl.h"
40 : #include "syzygy/trace/service/session_trace_file_writer_factory.h"
41 :
42 : using ::common::rpc::InvokeRpc;
43 : using ::common::rpc::RpcStatus;
44 : using trace::client::TraceFileSegment;
45 :
46 : namespace trace {
47 : namespace service {
48 :
49 : namespace {
50 :
51 : using base::ProcessHandle;
52 : using base::TERMINATION_STATUS_STILL_RUNNING;
53 : using base::win::ScopedHandle;
54 : using ::common::AlignUp;
55 : using trace::parser::ParseEnvironmentStrings;
56 : using trace::parser::ParseTraceFileHeaderBlob;
57 :
58 : // Calculates the size of the given header on disk.
59 E : size_t RoundedSize(const TraceFileHeader& header) {
60 E : return AlignUp(header.header_size, header.block_size);
61 E : }
62 :
63 : class ScopedEnvironment {
64 : public:
65 E : ScopedEnvironment() {
66 E : env_ = ::GetEnvironmentStrings();
67 E : DCHECK(env_ != NULL);
68 E : }
69 :
70 E : ~ScopedEnvironment() {
71 E : ::FreeEnvironmentStrings(env_);
72 E : }
73 :
74 E : const wchar_t* Get() { return env_; }
75 :
76 : private:
77 : wchar_t* env_;
78 : };
79 :
80 : class CallTraceServiceTest : public testing::Test {
81 : public:
82 : typedef testing::Test Super;
83 :
84 : struct MyRecordType {
85 : enum { kTypeId = 0xBEEF };
86 : char message[128];
87 : };
88 :
89 : struct LargeRecordType {
90 : enum { kTypeId = 0xF00D };
91 : // This needs to be bigger than the default buffer size, which is
92 : // 2 MB.
93 : unsigned char binary_data[4 * 1024 * 1024];
94 : };
95 :
96 : CallTraceServiceTest()
97 E : : consumer_thread_("profiler-test-consumer-thread"),
98 E : consumer_thread_has_started_(
99 : consumer_thread_.StartWithOptions(
100 : base::Thread::Options(base::MessageLoop::TYPE_IO, 0))),
101 E : session_trace_file_writer_factory_(consumer_thread_.message_loop()),
102 E : call_trace_service_(&session_trace_file_writer_factory_),
103 E : rpc_service_instance_manager_(&call_trace_service_),
104 E : client_rpc_binding_(NULL) {
105 E : }
106 :
107 : // Sets up each test invocation.
108 E : void SetUp() override {
109 E : Super::SetUp();
110 :
111 E : ASSERT_TRUE(consumer_thread_has_started_);
112 :
113 : // Create a temporary directory for the call trace files.
114 E : ASSERT_TRUE(temp_dir_.CreateUniqueTempDir());
115 E : ASSERT_TRUE(session_trace_file_writer_factory_.SetTraceFileDirectory(
116 : temp_dir_.path()));
117 :
118 : // We give the service instance a "unique" id so that it does not interfere
119 : // with any other instances or tests that might be concurrently active.
120 E : instance_id_ = base::StringPrintf(L"%d", ::GetCurrentProcessId());
121 E : call_trace_service_.set_instance_id(instance_id_);
122 :
123 : // The instance id needs to be in the environment to be picked up by the
124 : // client library. We prefix the existing environment variable, if any.
125 E : std::unique_ptr<base::Environment> env(base::Environment::Create());
126 E : ASSERT_FALSE(env.get() == NULL);
127 E : std::string env_var;
128 E : env->GetVar(::kSyzygyRpcInstanceIdEnvVar, &env_var);
129 E : env_var.insert(0, ";");
130 E : env_var.insert(0, base::WideToUTF8(instance_id_));
131 E : ASSERT_TRUE(env->SetVar(::kSyzygyRpcInstanceIdEnvVar, env_var));
132 E : }
133 :
134 : // Cleans up after each test invocation.
135 E : void TearDown() override {
136 E : FreeMappings();
137 :
138 E : if (client_rpc_binding_) {
139 E : ASSERT_EQ(RPC_S_OK, RpcBindingFree(&client_rpc_binding_));
140 : }
141 E : EXPECT_TRUE(call_trace_service_.Stop());
142 E : EXPECT_FALSE(call_trace_service_.is_running());
143 :
144 E : Super::TearDown();
145 E : }
146 :
147 E : void BindRPC() {
148 E : RPC_WSTR string_binding = NULL;
149 E : std::wstring protocol;
150 E : std::wstring endpoint;
151 :
152 E : ::GetSyzygyCallTraceRpcProtocol(&protocol);
153 E : ::GetSyzygyCallTraceRpcEndpoint(instance_id_, &endpoint);
154 :
155 E : ASSERT_TRUE(client_rpc_binding_ == 0);
156 :
157 E : ASSERT_EQ(RPC_S_OK,
158 : ::RpcStringBindingCompose(NULL, // UUID.
159 : ::common::rpc::AsRpcWstr(&protocol[0]),
160 : NULL, // Address.
161 : ::common::rpc::AsRpcWstr(&endpoint[0]),
162 : NULL, // Options.
163 : &string_binding));
164 :
165 E : ASSERT_EQ(RPC_S_OK, ::RpcBindingFromStringBinding(string_binding,
166 : &client_rpc_binding_));
167 :
168 E : ::RpcStringFree(&string_binding);
169 :
170 E : ASSERT_TRUE(client_rpc_binding_ != 0);
171 E : }
172 :
173 E : void MapSegmentBuffer(TraceFileSegment* segment) {
174 E : ASSERT_TRUE(segment != NULL);
175 :
176 : HANDLE mem_handle =
177 E : reinterpret_cast<HANDLE>(segment->buffer_info.shared_memory_handle);
178 E : uint8_t*& base_ptr = base_ptr_map_[mem_handle];
179 E : if (base_ptr == NULL) {
180 E : base_ptr = reinterpret_cast<uint8_t*>(::MapViewOfFile(
181 : mem_handle, FILE_MAP_WRITE, 0, 0, segment->buffer_info.mapping_size));
182 : }
183 E : ASSERT_TRUE(base_ptr != NULL);
184 :
185 E : segment->header = NULL; // A real client should write/init the header here.
186 E : segment->base_ptr = base_ptr;
187 E : segment->write_ptr = base_ptr + segment->buffer_info.buffer_offset;
188 E : segment->end_ptr = segment->write_ptr + segment->buffer_info.buffer_size;
189 E : }
190 :
191 E : void FreeMappings() {
192 E : BasePtrMap::iterator it = base_ptr_map_.begin();
193 E : for (; it != base_ptr_map_.end(); ++it)
194 E : ::UnmapViewOfFile(it->second);
195 E : base_ptr_map_.clear();
196 E : }
197 :
198 : void CreateSession(SessionHandle* session_handle,
199 E : TraceFileSegment* segment) {
200 E : ASSERT_TRUE(segment != NULL);
201 E : ZeroMemory(segment, sizeof(*segment));
202 E : BindRPC();
203 :
204 E : unsigned long flags = 0;
205 E : RpcStatus status = InvokeRpc(CallTraceClient_CreateSession,
206 : client_rpc_binding_,
207 : session_handle,
208 : &segment->buffer_info,
209 : &flags);
210 :
211 E : ASSERT_FALSE(status.exception_occurred);
212 E : ASSERT_TRUE(status.result);
213 :
214 E : MapSegmentBuffer(segment);
215 E : }
216 :
217 : void AllocateBuffer(SessionHandle session_handle,
218 E : TraceFileSegment* segment) {
219 E : RpcStatus status = InvokeRpc(CallTraceClient_AllocateBuffer,
220 : session_handle,
221 : &segment->buffer_info);
222 :
223 E : ASSERT_FALSE(status.exception_occurred);
224 E : ASSERT_TRUE(status.result);
225 :
226 E : MapSegmentBuffer(segment);
227 E : }
228 :
229 : void AllocateLargeBuffer(SessionHandle session_handle,
230 : size_t minimum_size,
231 E : TraceFileSegment* segment) {
232 E : RpcStatus status = InvokeRpc(CallTraceClient_AllocateLargeBuffer,
233 : session_handle,
234 : minimum_size,
235 : &segment->buffer_info);
236 :
237 E : ASSERT_FALSE(status.exception_occurred);
238 E : ASSERT_TRUE(status.result);
239 :
240 E : MapSegmentBuffer(segment);
241 E : }
242 :
243 : void ExchangeBuffer(SessionHandle session_handle,
244 E : TraceFileSegment* segment) {
245 E : RpcStatus status = InvokeRpc(CallTraceClient_ExchangeBuffer,
246 : session_handle,
247 : &segment->buffer_info);
248 :
249 E : ASSERT_FALSE(status.exception_occurred);
250 E : ASSERT_TRUE(status.result);
251 :
252 E : MapSegmentBuffer(segment);
253 E : }
254 :
255 : void ReturnBuffer(SessionHandle session_handle,
256 E : TraceFileSegment* segment) {
257 E : RpcStatus status = InvokeRpc(CallTraceClient_ReturnBuffer,
258 : session_handle,
259 : &segment->buffer_info);
260 :
261 E : ASSERT_FALSE(status.exception_occurred);
262 E : ASSERT_TRUE(status.result);
263 :
264 : CallTraceBuffer zeroes;
265 E : ZeroMemory(&zeroes, sizeof(zeroes));
266 E : ASSERT_EQ(0, ::memcmp(&segment->buffer_info, &zeroes, sizeof(zeroes)));
267 :
268 E : segment->write_ptr = NULL;
269 E : segment->end_ptr = NULL;
270 E : segment->header = NULL;
271 E : }
272 :
273 E : void CloseSession(SessionHandle* session_handle) {
274 : // Free all outstanding mappings associated with this session.
275 E : FreeMappings();
276 :
277 E : RpcStatus status = InvokeRpc(CallTraceClient_CloseSession,
278 : session_handle);
279 :
280 E : ASSERT_FALSE(status.exception_occurred);
281 E : ASSERT_TRUE(status.result);
282 :
283 E : ASSERT_TRUE(*session_handle == NULL);
284 E : }
285 :
286 E : void ReadTraceFile(std::string* contents) {
287 E : base::FileEnumerator enumerator(temp_dir_.path(),
288 : false,
289 : base::FileEnumerator::FILES,
290 : L"trace-*.bin");
291 E : base::FilePath trace_file_name(enumerator.Next());
292 E : ASSERT_FALSE(trace_file_name.empty());
293 E : ASSERT_TRUE(enumerator.Next().empty());
294 E : ASSERT_TRUE(base::ReadFileToString(trace_file_name, contents));
295 E : }
296 :
297 E : void ValidateTraceFileHeader(const TraceFileHeader& header) {
298 E : std::wstring cmd_line(::GetCommandLineW());
299 :
300 : wchar_t module_path[MAX_PATH];
301 E : ASSERT_TRUE(::GetModuleFileName(NULL,
302 : &module_path[0],
303 : arraysize(module_path)));
304 :
305 : MODULEINFO module_info;
306 E : ASSERT_TRUE(::GetModuleInformation(::GetCurrentProcess(),
307 : ::GetModuleHandle(NULL),
308 : &module_info,
309 : sizeof(module_info)));
310 :
311 E : ScopedEnvironment env_;
312 E : TraceEnvironmentStrings env_strings;
313 E : ASSERT_TRUE(ParseEnvironmentStrings(env_.Get(), &env_strings));
314 :
315 : // Parse the blob at the end of the header, and make sure its parsable.
316 E : std::wstring blob_module_path;
317 E : std::wstring blob_command_line;
318 E : TraceEnvironmentStrings blob_env_strings;
319 E : ASSERT_TRUE(ParseTraceFileHeaderBlob(header,
320 : &blob_module_path,
321 : &blob_command_line,
322 : &blob_env_strings));
323 :
324 E : ASSERT_EQ(header.server_version.hi, TRACE_VERSION_HI);
325 E : ASSERT_EQ(header.server_version.lo, TRACE_VERSION_LO);
326 E : ASSERT_EQ(header.process_id, ::GetCurrentProcessId());
327 E : ASSERT_EQ(header.module_base_address,
328 : reinterpret_cast<uint32_t>(module_info.lpBaseOfDll));
329 E : ASSERT_EQ(header.module_size,
330 : static_cast<uint32_t>(module_info.SizeOfImage));
331 :
332 E : ASSERT_EQ(blob_module_path, std::wstring(module_path));
333 E : ASSERT_EQ(blob_command_line, cmd_line);
334 E : ASSERT_THAT(blob_env_strings, ::testing::ContainerEq(env_strings));
335 E : }
336 :
337 :
338 : // The thread on which the trace file writer will consumer buffers and a
339 : // helper variable whose initialization we use as a trigger to start the
340 : // thread (ensuring its message_loop is created). These declarations MUST
341 : // remain in this order and preceed that of trace_file_writer_factory_;
342 : base::Thread consumer_thread_;
343 : bool consumer_thread_has_started_;
344 :
345 : // The call trace service related objects. These declarations MUST be in
346 : // this order.
347 : SessionTraceFileWriterFactory session_trace_file_writer_factory_;
348 : Service call_trace_service_;
349 : RpcServiceInstanceManager rpc_service_instance_manager_;
350 :
351 : // The directory where trace file output will be written.
352 : base::ScopedTempDir temp_dir_;
353 :
354 : // We give each service instance a "unique" id so that it doesn't interfere
355 : // with any other concurrrently running instances or tests.
356 : std::wstring instance_id_;
357 :
358 : // The client rpc binding.
359 : handle_t client_rpc_binding_;
360 :
361 : // A map to track the base pointers for the buffers returned from the call
362 : // trace service.
363 : typedef std::map<HANDLE, uint8_t*> BasePtrMap;
364 : BasePtrMap base_ptr_map_;
365 : };
366 :
367 : template<typename T1, typename T2>
368 E : inline ptrdiff_t RawPtrDiff(const T1* p1, const T2* p2) {
369 E : const uint8_t* const u1 = reinterpret_cast<const uint8_t*>(p1);
370 E : const uint8_t* const u2 = reinterpret_cast<const uint8_t*>(p2);
371 E : return u1 - u2;
372 E : }
373 :
374 : void ControlExternalCallTraceService(const std::string& command,
375 : const std::wstring& instance_id_,
376 E : base::Process* process) {
377 E : ASSERT_TRUE(command == "start" || command == "stop");
378 E : ASSERT_FALSE(instance_id_.empty());
379 E : ASSERT_NE(static_cast<base::Process*>(nullptr), process);
380 :
381 E : base::CommandLine cmd_line(
382 : testing::GetExeRelativePath(L"call_trace_service.exe"));
383 E : cmd_line.AppendArg(command);
384 E : cmd_line.AppendSwitchNative("instance-id", instance_id_);
385 :
386 E : base::LaunchOptions options;
387 E : *process = base::LaunchProcess(cmd_line, options);
388 E : ASSERT_TRUE(process->IsValid());
389 E : }
390 :
391 : void StartExternalCallTraceService(const std::wstring& instance_id_,
392 E : base::Process* process) {
393 E : ControlExternalCallTraceService("start", instance_id_, process);
394 E : }
395 :
396 : void StopExternalCallTraceService(const std::wstring& instance_id_,
397 E : base::Process* process) {
398 E : ASSERT_NE(static_cast<base::Process*>(nullptr), process);
399 E : base::Process controller_process;
400 E : ControlExternalCallTraceService("stop", instance_id_, &controller_process);
401 :
402 E : static base::TimeDelta k30Seconds = base::TimeDelta::FromSeconds(30);
403 : int exit_code;
404 E : EXPECT_TRUE(
405 E : controller_process.WaitForExitWithTimeout(k30Seconds, &exit_code));
406 E : EXPECT_EQ(0, exit_code);
407 :
408 E : EXPECT_TRUE(process->WaitForExitWithTimeout(k30Seconds, &exit_code));
409 E : EXPECT_EQ(0, exit_code);
410 E : }
411 :
412 E : void CheckIsStillRunning(ProcessHandle handle) {
413 E : ::Sleep(1000);
414 :
415 E : int exit_code = 0;
416 E : base::TerminationStatus status = base::GetTerminationStatus(handle,
417 : &exit_code);
418 :
419 E : ASSERT_EQ(TERMINATION_STATUS_STILL_RUNNING, status);
420 E : ASSERT_EQ(WAIT_TIMEOUT, exit_code);
421 E : }
422 :
423 : } // namespace
424 :
425 E : TEST_F(CallTraceServiceTest, StartStop) {
426 E : EXPECT_TRUE(call_trace_service_.Start(true));
427 E : EXPECT_TRUE(call_trace_service_.Stop());
428 E : }
429 :
430 E : TEST_F(CallTraceServiceTest, StartFailsIfEventNameOccupied) {
431 E : std::wstring event_name;
432 E : ::GetSyzygyCallTraceRpcEventName(instance_id_, &event_name);
433 :
434 : // Create a mutex with the event name, to thwart the event creation.
435 E : base::win::ScopedHandle mutex(
436 : ::CreateMutex(NULL, FALSE, event_name.c_str()));
437 :
438 E : EXPECT_FALSE(call_trace_service_.Start(true));
439 E : }
440 :
441 E : TEST_F(CallTraceServiceTest, StartSetsStopResetsEvent) {
442 E : std::wstring event_name;
443 E : ::GetSyzygyCallTraceRpcEventName(instance_id_, &event_name);
444 :
445 : // Create the event and make sure it's not set.
446 E : base::win::ScopedHandle event(
447 : ::CreateEvent(NULL, FALSE, FALSE, event_name.c_str()));
448 :
449 E : EXPECT_TRUE(call_trace_service_.Start(true));
450 :
451 E : ASSERT_EQ(WAIT_OBJECT_0, ::WaitForSingleObject(event.Get(), 0));
452 :
453 E : EXPECT_TRUE(call_trace_service_.Stop());
454 :
455 E : ASSERT_EQ(WAIT_TIMEOUT, ::WaitForSingleObject(event.Get(), 0));
456 E : }
457 :
458 E : TEST_F(CallTraceServiceTest, IsSingletonPerInstanceId) {
459 : // Create a new instance id to use for this test.
460 E : std::wstring duplicate_id = instance_id_ + L"-foo";
461 :
462 : // Start an external service with the new instance id.
463 E : base::Process process;
464 E : ASSERT_NO_FATAL_FAILURE(StartExternalCallTraceService(duplicate_id,
465 E : &process));
466 E : ASSERT_NO_FATAL_FAILURE(CheckIsStillRunning(process.Handle()));
467 :
468 : // Create a new local service instance and see if it starts. We use a new
469 : // instance to pick up the new instance id and to make sure any state in
470 : // the static service instance doesn't compromise the test.
471 E : Service local_call_trace_service(&session_trace_file_writer_factory_);
472 E : local_call_trace_service.set_instance_id(duplicate_id);
473 E : EXPECT_FALSE(local_call_trace_service.Start(true));
474 E : EXPECT_TRUE(local_call_trace_service.Stop());
475 :
476 : // The external instance should still be running.
477 E : CheckIsStillRunning(process.Handle());
478 E : StopExternalCallTraceService(duplicate_id, &process);
479 E : }
480 :
481 E : TEST_F(CallTraceServiceTest, IsConcurrentWithDifferentInstanceId) {
482 : // Create new instance ids "bar-1" and "bar-2" to use for the external
483 : // and internal services in this test.
484 E : std::wstring external_id = instance_id_ + L"-bar-1";
485 E : std::wstring internal_id = instance_id_ + L"-bar-2";
486 :
487 : // Start an external service with the external instance id.
488 E : base::Process process;
489 E : ASSERT_NO_FATAL_FAILURE(StartExternalCallTraceService(external_id, &process));
490 E : ASSERT_NO_FATAL_FAILURE(CheckIsStillRunning(process.Handle()));
491 :
492 : // Create a new local service instance and see if it starts. We use a new
493 : // instance to pick up the new instance id and to make sure any state in
494 : // the static service instance doesn't compromise the test.
495 E : Service local_call_trace_service(&session_trace_file_writer_factory_);
496 E : local_call_trace_service.set_instance_id(internal_id);
497 E : EXPECT_TRUE(local_call_trace_service.Start(true));
498 E : EXPECT_TRUE(local_call_trace_service.Stop());
499 :
500 : // The external instance should still be running.
501 E : CheckIsStillRunning(process.Handle());
502 E : StopExternalCallTraceService(external_id, &process);
503 E : }
504 :
505 E : TEST_F(CallTraceServiceTest, Connect) {
506 E : SessionHandle session_handle = NULL;
507 E : TraceFileSegment segment;
508 :
509 E : ASSERT_TRUE(call_trace_service_.Start(true));
510 E : ASSERT_NO_FATAL_FAILURE(CreateSession(&session_handle, &segment));
511 E : ASSERT_TRUE(call_trace_service_.Stop());
512 :
513 E : std::string trace_file_contents;
514 E : ReadTraceFile(&trace_file_contents);
515 :
516 : TraceFileHeader* header =
517 E : reinterpret_cast<TraceFileHeader*>(&trace_file_contents[0]);
518 :
519 E : ASSERT_NO_FATAL_FAILURE(ValidateTraceFileHeader(*header));
520 E : ASSERT_EQ(trace_file_contents.length(),
521 E : RoundedSize(*header) + header->block_size);
522 E : }
523 :
524 E : TEST_F(CallTraceServiceTest, Allocate) {
525 E : SessionHandle session_handle = NULL;
526 E : TraceFileSegment segment1;
527 E : TraceFileSegment segment2;
528 :
529 E : ASSERT_TRUE(call_trace_service_.Start(true));
530 :
531 : // Simulate some work on the main thread.
532 E : ASSERT_NO_FATAL_FAILURE(CreateSession(&session_handle, &segment1));
533 E : segment1.WriteSegmentHeader(session_handle);
534 E : MyRecordType* record1 = segment1.AllocateTraceRecord<MyRecordType>();
535 E : base::strlcpy(record1->message, "Message 1", arraysize(record1->message));
536 E : size_t length1 = segment1.header->segment_length;
537 :
538 : // Simulate some work on a second thread.
539 E : ASSERT_NO_FATAL_FAILURE(AllocateBuffer(session_handle, &segment2));
540 E : segment2.WriteSegmentHeader(session_handle);
541 E : segment2.header->thread_id += 1;
542 E : MyRecordType* record2 = segment2.AllocateTraceRecord<MyRecordType>(256);
543 E : base::strlcpy(record2->message, "Message 2", arraysize(record2->message));
544 E : size_t length2 = segment2.header->segment_length;
545 :
546 : // Commit the buffers in the opposite order.
547 E : ASSERT_NO_FATAL_FAILURE(ReturnBuffer(session_handle, &segment2));
548 E : ASSERT_NO_FATAL_FAILURE(CloseSession(&session_handle));
549 :
550 : // Make sure everything is flushed.
551 E : ASSERT_TRUE(call_trace_service_.Stop());
552 :
553 E : std::string trace_file_contents;
554 E : ASSERT_NO_FATAL_FAILURE(ReadTraceFile(&trace_file_contents));
555 :
556 : TraceFileHeader* header =
557 E : reinterpret_cast<TraceFileHeader*>(&trace_file_contents[0]);
558 :
559 E : ASSERT_NO_FATAL_FAILURE(ValidateTraceFileHeader(*header));
560 E : ASSERT_EQ(trace_file_contents.length(),
561 E : RoundedSize(*header) + 3 * header->block_size);
562 :
563 : // Locate and validate the segment header prefix and segment header.
564 : // This should be segment 2.
565 E : size_t offset = AlignUp(header->header_size, header->block_size);
566 : RecordPrefix* prefix =
567 E : reinterpret_cast<RecordPrefix*>(&trace_file_contents[0] + offset);
568 E : ASSERT_EQ(prefix->type, TraceFileSegmentHeader::kTypeId);
569 E : ASSERT_EQ(prefix->size, sizeof(TraceFileSegmentHeader));
570 E : ASSERT_EQ(prefix->version.hi, TRACE_VERSION_HI);
571 E : ASSERT_EQ(prefix->version.lo, TRACE_VERSION_LO);
572 : TraceFileSegmentHeader* segment_header =
573 E : reinterpret_cast<TraceFileSegmentHeader*>(prefix + 1);
574 E : ASSERT_EQ(segment_header->segment_length, length2);
575 E : ASSERT_EQ(segment_header->thread_id, 1 + ::GetCurrentThreadId());
576 :
577 : // The segment header is followed by the message prefix and record.
578 : // This should be message 2.
579 E : prefix = reinterpret_cast<RecordPrefix*>(segment_header + 1);
580 E : ASSERT_EQ(prefix->type, MyRecordType::kTypeId);
581 E : ASSERT_EQ(prefix->size, 256);
582 E : ASSERT_EQ(prefix->version.hi, TRACE_VERSION_HI);
583 E : ASSERT_EQ(prefix->version.lo, TRACE_VERSION_LO);
584 E : MyRecordType* record = reinterpret_cast<MyRecordType*>(prefix + 1);
585 E : ASSERT_STREQ(record->message, "Message 2");
586 :
587 : // Locate and validate the next segment header prefix and segment header.
588 : // This should be segment 1.
589 :
590 E : offset = AlignUp(RawPtrDiff(record + 1, &trace_file_contents[0]),
591 : header->block_size);
592 E : prefix = reinterpret_cast<RecordPrefix*>(&trace_file_contents[0] + offset);
593 E : ASSERT_EQ(prefix->type, TraceFileSegmentHeader::kTypeId);
594 E : ASSERT_EQ(prefix->size, sizeof(TraceFileSegmentHeader));
595 E : ASSERT_EQ(prefix->version.hi, TRACE_VERSION_HI);
596 E : ASSERT_EQ(prefix->version.lo, TRACE_VERSION_LO);
597 E : segment_header = reinterpret_cast<TraceFileSegmentHeader*>(prefix + 1);
598 E : ASSERT_EQ(segment_header->segment_length, length1);
599 E : ASSERT_EQ(segment_header->thread_id, ::GetCurrentThreadId());
600 :
601 : // The segment header is followed by the message prefix and record.
602 : // This should be message 1.
603 E : prefix = reinterpret_cast<RecordPrefix*>(segment_header + 1);
604 E : ASSERT_EQ(prefix->type, MyRecordType::kTypeId);
605 E : ASSERT_EQ(prefix->size, sizeof(MyRecordType));
606 E : ASSERT_EQ(prefix->version.hi, TRACE_VERSION_HI);
607 E : ASSERT_EQ(prefix->version.lo, TRACE_VERSION_LO);
608 E : record = reinterpret_cast<MyRecordType*>(prefix + 1);
609 E : ASSERT_STREQ(record->message, "Message 1");
610 E : }
611 :
612 E : TEST_F(CallTraceServiceTest, AllocateLargeBuffer) {
613 E : SessionHandle session_handle = NULL;
614 E : TraceFileSegment segment1;
615 E : TraceFileSegment segment2;
616 :
617 E : ASSERT_TRUE(call_trace_service_.Start(true));
618 :
619 : // Simulate some work on the main thread.
620 E : ASSERT_NO_FATAL_FAILURE(CreateSession(&session_handle, &segment1));
621 E : segment1.WriteSegmentHeader(session_handle);
622 E : MyRecordType* record1 = segment1.AllocateTraceRecord<MyRecordType>();
623 E : base::strlcpy(record1->message, "Message 1", arraysize(record1->message));
624 E : size_t length1 = segment1.header->segment_length;
625 :
626 : // Allocate a large buffer.
627 E : ASSERT_NO_FATAL_FAILURE(AllocateLargeBuffer(
628 : session_handle,
629 : sizeof(LargeRecordType) + sizeof(RecordPrefix),
630 E : &segment2));
631 E : segment2.WriteSegmentHeader(session_handle);
632 E : segment2.AllocateTraceRecord<LargeRecordType>();
633 E : size_t length2 = segment2.header->segment_length;
634 :
635 : // Commit the buffers and close the session.
636 E : ASSERT_NO_FATAL_FAILURE(ReturnBuffer(session_handle, &segment1));
637 E : ASSERT_NO_FATAL_FAILURE(ReturnBuffer(session_handle, &segment2));
638 E : ASSERT_NO_FATAL_FAILURE(CloseSession(&session_handle));
639 :
640 : // Make sure everything is flushed.
641 E : ASSERT_TRUE(call_trace_service_.Stop());
642 :
643 E : std::string trace_file_contents;
644 E : ASSERT_NO_FATAL_FAILURE(ReadTraceFile(&trace_file_contents));
645 :
646 : TraceFileHeader* header =
647 E : reinterpret_cast<TraceFileHeader*>(&trace_file_contents[0]);
648 :
649 E : ASSERT_NO_FATAL_FAILURE(ValidateTraceFileHeader(*header));
650 E : ASSERT_EQ(trace_file_contents.length(),
651 : RoundedSize(*header) + 3 * header->block_size +
652 E : sizeof(LargeRecordType));
653 :
654 : // Locate and validate the segment header prefix and segment header.
655 : // This should be segment 1.
656 E : size_t offset = AlignUp(header->header_size, header->block_size);
657 : RecordPrefix* prefix =
658 E : reinterpret_cast<RecordPrefix*>(&trace_file_contents[0] + offset);
659 E : ASSERT_EQ(prefix->type, TraceFileSegmentHeader::kTypeId);
660 E : ASSERT_EQ(prefix->size, sizeof(TraceFileSegmentHeader));
661 E : ASSERT_EQ(prefix->version.hi, TRACE_VERSION_HI);
662 E : ASSERT_EQ(prefix->version.lo, TRACE_VERSION_LO);
663 : TraceFileSegmentHeader* segment_header =
664 E : reinterpret_cast<TraceFileSegmentHeader*>(prefix + 1);
665 E : ASSERT_EQ(segment_header->segment_length, length1);
666 E : ASSERT_EQ(segment_header->thread_id, ::GetCurrentThreadId());
667 :
668 : // The segment header is followed by the message prefix and record.
669 : // This should be message 1.
670 E : prefix = reinterpret_cast<RecordPrefix*>(segment_header + 1);
671 E : ASSERT_EQ(prefix->type, MyRecordType::kTypeId);
672 E : ASSERT_EQ(prefix->size, sizeof(MyRecordType));
673 E : ASSERT_EQ(prefix->version.hi, TRACE_VERSION_HI);
674 E : ASSERT_EQ(prefix->version.lo, TRACE_VERSION_LO);
675 E : MyRecordType* record = reinterpret_cast<MyRecordType*>(prefix + 1);
676 E : ASSERT_STREQ(record->message, "Message 1");
677 :
678 : // Locate and validate the next segment header prefix and segment header.
679 : // This should be segment 2.
680 :
681 E : offset = AlignUp(RawPtrDiff(record + 1, &trace_file_contents[0]),
682 : header->block_size);
683 E : prefix = reinterpret_cast<RecordPrefix*>(&trace_file_contents[0] + offset);
684 E : ASSERT_EQ(prefix->type, TraceFileSegmentHeader::kTypeId);
685 E : ASSERT_EQ(prefix->size, sizeof(TraceFileSegmentHeader));
686 E : ASSERT_EQ(prefix->version.hi, TRACE_VERSION_HI);
687 E : ASSERT_EQ(prefix->version.lo, TRACE_VERSION_LO);
688 E : segment_header = reinterpret_cast<TraceFileSegmentHeader*>(prefix + 1);
689 E : ASSERT_EQ(segment_header->segment_length, length2);
690 E : ASSERT_EQ(segment_header->thread_id, ::GetCurrentThreadId());
691 :
692 : // The segment header is followed by the message prefix and record.
693 : // This should be the large buffer contents.
694 E : prefix = reinterpret_cast<RecordPrefix*>(segment_header + 1);
695 E : ASSERT_EQ(prefix->type, LargeRecordType::kTypeId);
696 E : ASSERT_EQ(prefix->size, sizeof(LargeRecordType));
697 E : ASSERT_EQ(prefix->version.hi, TRACE_VERSION_HI);
698 E : ASSERT_EQ(prefix->version.lo, TRACE_VERSION_LO);
699 E : }
700 :
701 E : TEST_F(CallTraceServiceTest, SendBuffer) {
702 E : SessionHandle session_handle = NULL;
703 E : TraceFileSegment segment;
704 :
705 E : const size_t num_blocks = 3;
706 E : size_t segment_length[] = {0, 0, 0};
707 : const char* messages[] = {
708 E : "This is message number 1",
709 E : "The quick brown fox jumped over the lazy dog.",
710 E : "And now for something completely different ...",
711 : };
712 :
713 E : ASSERT_EQ(arraysize(segment_length), num_blocks);
714 E : ASSERT_EQ(arraysize(messages), num_blocks);
715 :
716 : // Start up the service and create a session
717 E : ASSERT_TRUE(call_trace_service_.Start(true));
718 E : ASSERT_NO_FATAL_FAILURE(CreateSession(&session_handle, &segment));
719 :
720 : // Write the initial block plus num_blocks "message" blocks. The n-th block
721 : // will have n message written to it (i.e., block will have 1 message, the 2nd
722 : // two, etc)
723 E : for (int block = 0; block < num_blocks; ++block) {
724 E : segment.WriteSegmentHeader(session_handle);
725 E : for (int i = 0; i <= block; ++i) {
726 E : MyRecordType* record = segment.AllocateTraceRecord<MyRecordType>();
727 E : base::strlcpy(record->message, messages[i], arraysize(record->message));
728 E : }
729 E : segment_length[block] = segment.header->segment_length;
730 E : ASSERT_NO_FATAL_FAILURE(ExchangeBuffer(session_handle, &segment));
731 E : }
732 E : ASSERT_NO_FATAL_FAILURE(ReturnBuffer(session_handle, &segment));
733 E : ASSERT_NO_FATAL_FAILURE(CloseSession(&session_handle));
734 E : ASSERT_TRUE(call_trace_service_.Stop());
735 E : ASSERT_FALSE(call_trace_service_.is_running());
736 :
737 : // Load the trace file contents into memory.
738 E : std::string trace_file_contents;
739 E : ASSERT_NO_FATAL_FAILURE(ReadTraceFile(&trace_file_contents));
740 :
741 : // Read and validate the trace file header. We expect to have written
742 : // the header (rounded up to a block) plus num_blocks of data,
743 : // plus 1 block containing the process ended event.
744 : TraceFileHeader* header =
745 E : reinterpret_cast<TraceFileHeader*>(&trace_file_contents[0]);
746 E : ASSERT_NO_FATAL_FAILURE(ValidateTraceFileHeader(*header));
747 E : size_t total_blocks = 1 + num_blocks;
748 E : EXPECT_EQ(trace_file_contents.length(),
749 E : RoundedSize(*header) + total_blocks * header->block_size);
750 :
751 : // Read each data block and validate its contents.
752 E : size_t segment_offset = AlignUp(header->header_size, header->block_size);
753 E : for (int block = 0; block < num_blocks; ++block) {
754 : // Locate and validate the segment header prefix.
755 : RecordPrefix* prefix = reinterpret_cast<RecordPrefix*>(
756 E : &trace_file_contents[0] + segment_offset);
757 E : ASSERT_EQ(prefix->type, TraceFileSegmentHeader::kTypeId);
758 E : ASSERT_EQ(prefix->size, sizeof(TraceFileSegmentHeader));
759 E : ASSERT_EQ(prefix->version.hi, TRACE_VERSION_HI);
760 E : ASSERT_EQ(prefix->version.lo, TRACE_VERSION_LO);
761 :
762 : // The segment header prefix is followed by the actual segment header.
763 : TraceFileSegmentHeader* segment_header =
764 E : reinterpret_cast<TraceFileSegmentHeader*>(prefix + 1);
765 E : ASSERT_EQ(segment_header->segment_length, segment_length[block]);
766 E : ASSERT_EQ(segment_header->thread_id, ::GetCurrentThreadId());
767 :
768 : // The segment header is followed by the n message records, where N
769 : // is the same as the block number we're currently on (1 based).
770 E : prefix = reinterpret_cast<RecordPrefix*>(segment_header + 1);
771 E : for (int j = 0; j <= block; ++j) {
772 E : ASSERT_EQ(prefix->type, MyRecordType::kTypeId);
773 E : ASSERT_EQ(prefix->size, sizeof(MyRecordType));
774 E : ASSERT_EQ(prefix->version.hi, TRACE_VERSION_HI);
775 E : ASSERT_EQ(prefix->version.lo, TRACE_VERSION_LO);
776 E : MyRecordType* record = reinterpret_cast<MyRecordType*>(prefix + 1);
777 E : ASSERT_STREQ(record->message, messages[j]);
778 E : prefix = reinterpret_cast<RecordPrefix*>(record + 1);
779 E : }
780 :
781 E : EXPECT_EQ(segment_header->segment_length,
782 E : RawPtrDiff(prefix, segment_header + 1));
783 :
784 E : segment_offset = AlignUp(
785 : RawPtrDiff(prefix, &trace_file_contents[0]),
786 : header->block_size);
787 E : }
788 :
789 : // Locate and validate the segment header prefix for the process ended
790 : // event block.
791 : RecordPrefix* prefix = reinterpret_cast<RecordPrefix*>(
792 E : &trace_file_contents[0] + segment_offset);
793 E : ASSERT_EQ(prefix->type, TraceFileSegmentHeader::kTypeId);
794 E : ASSERT_EQ(prefix->size, sizeof(TraceFileSegmentHeader));
795 E : ASSERT_EQ(prefix->version.hi, TRACE_VERSION_HI);
796 E : ASSERT_EQ(prefix->version.lo, TRACE_VERSION_LO);
797 :
798 : // The segment header prefix is followed by the actual segment header.
799 : TraceFileSegmentHeader* segment_header =
800 E : reinterpret_cast<TraceFileSegmentHeader*>(prefix + 1);
801 E : ASSERT_EQ(sizeof(RecordPrefix), segment_header->segment_length);
802 E : ASSERT_EQ(0, segment_header->thread_id);
803 :
804 : // Validate the process ended event.
805 E : prefix = reinterpret_cast<RecordPrefix*>(segment_header + 1);
806 E : ASSERT_EQ(TRACE_PROCESS_ENDED, prefix->type);
807 E : ASSERT_EQ(0, prefix->size);
808 E : ASSERT_EQ(TRACE_VERSION_HI, prefix->version.hi);
809 E : ASSERT_EQ(TRACE_VERSION_LO, prefix->version.lo);
810 E : EXPECT_EQ(segment_header->segment_length,
811 E : RawPtrDiff(prefix + 1, segment_header + 1));
812 E : }
813 :
814 : } // namespace service
815 : } // namespace trace
|