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