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