Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(413)

Side by Side Diff: base/profiler/stack_sampling_profiler.cc

Issue 2554123002: Support parallel captures from the StackSamplingProfiler. (Closed)
Patch Set: addressed review comments by wittman Created 3 years, 9 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
1 // Copyright 2015 The Chromium Authors. All rights reserved. 1 // Copyright 2015 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be 2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file. 3 // found in the LICENSE file.
4 4
5 #include "base/profiler/stack_sampling_profiler.h" 5 #include "base/profiler/stack_sampling_profiler.h"
6 6
7 #include <algorithm> 7 #include <algorithm>
8 #include <map>
8 #include <utility> 9 #include <utility>
9 10
11 #include "base/atomic_sequence_num.h"
12 #include "base/atomicops.h"
10 #include "base/bind.h" 13 #include "base/bind.h"
11 #include "base/bind_helpers.h" 14 #include "base/bind_helpers.h"
12 #include "base/callback.h" 15 #include "base/callback.h"
13 #include "base/lazy_instance.h" 16 #include "base/lazy_instance.h"
14 #include "base/location.h" 17 #include "base/location.h"
15 #include "base/macros.h" 18 #include "base/macros.h"
19 #include "base/memory/ptr_util.h"
20 #include "base/memory/singleton.h"
16 #include "base/profiler/native_stack_sampler.h" 21 #include "base/profiler/native_stack_sampler.h"
17 #include "base/synchronization/lock.h" 22 #include "base/synchronization/lock.h"
23 #include "base/threading/thread.h"
24 #include "base/threading/thread_restrictions.h"
18 #include "base/threading/thread_task_runner_handle.h" 25 #include "base/threading/thread_task_runner_handle.h"
19 #include "base/timer/elapsed_timer.h" 26 #include "base/timer/elapsed_timer.h"
20 27
21 namespace base { 28 namespace base {
22 29
23 namespace { 30 namespace {
24 31
25 // Used to ensure only one profiler is running at a time. 32 // This value is used when there is no collection in progress and thus no ID
26 LazyInstance<Lock>::Leaky concurrent_profiling_lock = LAZY_INSTANCE_INITIALIZER; 33 // for referencing the active collection to the SamplingThread.
27 34 const int NULL_COLLECTION_ID = -1;
28 // AsyncRunner ----------------------------------------------------------------
29
30 // Helper class to allow a profiler to be run completely asynchronously from the
31 // initiator, without being concerned with the profiler's lifetime.
32 class AsyncRunner {
33 public:
34 // Sets up a profiler and arranges for it to be deleted on its completed
35 // callback.
36 static void Run(PlatformThreadId thread_id,
37 const StackSamplingProfiler::SamplingParams& params,
38 const StackSamplingProfiler::CompletedCallback& callback);
39
40 private:
41 AsyncRunner();
42
43 // Runs the callback and deletes the AsyncRunner instance. |profiles| is not
44 // const& because it must be passed with std::move.
45 static void RunCallbackAndDeleteInstance(
46 std::unique_ptr<AsyncRunner> object_to_be_deleted,
47 const StackSamplingProfiler::CompletedCallback& callback,
48 scoped_refptr<SingleThreadTaskRunner> task_runner,
49 StackSamplingProfiler::CallStackProfiles profiles);
50
51 std::unique_ptr<StackSamplingProfiler> profiler_;
52
53 DISALLOW_COPY_AND_ASSIGN(AsyncRunner);
54 };
55
56 // static
57 void AsyncRunner::Run(
58 PlatformThreadId thread_id,
59 const StackSamplingProfiler::SamplingParams& params,
60 const StackSamplingProfiler::CompletedCallback &callback) {
61 std::unique_ptr<AsyncRunner> runner(new AsyncRunner);
62 AsyncRunner* temp_ptr = runner.get();
63 temp_ptr->profiler_.reset(
64 new StackSamplingProfiler(thread_id, params,
65 Bind(&AsyncRunner::RunCallbackAndDeleteInstance,
66 Passed(&runner), callback,
67 ThreadTaskRunnerHandle::Get())));
68 // The callback won't be called until after Start(), so temp_ptr will still
69 // be valid here.
70 temp_ptr->profiler_->Start();
71 }
72
73 AsyncRunner::AsyncRunner() {}
74
75 void AsyncRunner::RunCallbackAndDeleteInstance(
76 std::unique_ptr<AsyncRunner> object_to_be_deleted,
77 const StackSamplingProfiler::CompletedCallback& callback,
78 scoped_refptr<SingleThreadTaskRunner> task_runner,
79 StackSamplingProfiler::CallStackProfiles profiles) {
80 callback.Run(std::move(profiles));
81 // Delete the instance on the original calling thread.
82 task_runner->DeleteSoon(FROM_HERE, object_to_be_deleted.release());
83 }
84 35
85 void ChangeAtomicFlags(subtle::Atomic32* flags, 36 void ChangeAtomicFlags(subtle::Atomic32* flags,
86 subtle::Atomic32 set, 37 subtle::Atomic32 set,
87 subtle::Atomic32 clear) { 38 subtle::Atomic32 clear) {
88 DCHECK(set != 0 || clear != 0); 39 DCHECK(set != 0 || clear != 0);
89 DCHECK_EQ(0, set & clear); 40 DCHECK_EQ(0, set & clear);
90 41
91 subtle::Atomic32 bits = subtle::NoBarrier_Load(flags); 42 subtle::Atomic32 bits = subtle::NoBarrier_Load(flags);
92 while (true) { 43 while (true) {
93 subtle::Atomic32 existing = 44 subtle::Atomic32 existing =
(...skipping 59 matching lines...) Expand 10 before | Expand all | Expand 10 after
153 StackSamplingProfiler::CallStackProfile 104 StackSamplingProfiler::CallStackProfile
154 StackSamplingProfiler::CallStackProfile::CopyForTesting() const { 105 StackSamplingProfiler::CallStackProfile::CopyForTesting() const {
155 return CallStackProfile(*this); 106 return CallStackProfile(*this);
156 } 107 }
157 108
158 StackSamplingProfiler::CallStackProfile::CallStackProfile( 109 StackSamplingProfiler::CallStackProfile::CallStackProfile(
159 const CallStackProfile& other) = default; 110 const CallStackProfile& other) = default;
160 111
161 // StackSamplingProfiler::SamplingThread -------------------------------------- 112 // StackSamplingProfiler::SamplingThread --------------------------------------
162 113
163 StackSamplingProfiler::SamplingThread::SamplingThread( 114 class StackSamplingProfiler::SamplingThread : public Thread {
164 std::unique_ptr<NativeStackSampler> native_sampler, 115 public:
116 class TestAPI {
117 public:
118 // Disables inherent idle-shutdown behavior.
119 static void DisableIdleShutdown();
120
121 // Begins an idle shutdown as if the idle-timer had expired. Since the
122 // timer would have only been started at a time when the sampling thread
123 // actually was idle, this must be called only when it is known that
124 // there are no active sampling threads.
125 static void ShutdownAssumingIdle();
126 };
127
128 struct CollectionContext {
129 CollectionContext(PlatformThreadId target,
130 const SamplingParams& params,
131 const CompletedCallback& callback,
132 WaitableEvent* finished,
133 std::unique_ptr<NativeStackSampler> sampler)
134 : collection_id(next_collection_id_.GetNext()),
135 target(target),
136 params(params),
137 callback(callback),
138 finished(finished),
139 native_sampler(std::move(sampler)) {}
140 ~CollectionContext() {}
141
142 // An identifier for this collection, used to uniquely identify it to
143 // outside interests.
144 const int collection_id;
145
146 const PlatformThreadId target; // ID of The thread being sampled.
147 const SamplingParams params; // Information about how to sample.
148 const CompletedCallback callback; // Callback made when sampling complete.
149 WaitableEvent* const finished; // Signaled when all sampling complete.
150
151 // Platform-specific module that does the actual sampling.
152 std::unique_ptr<NativeStackSampler> native_sampler;
153
154 // The absolute time for the next sample.
155 Time next_sample_time;
156
157 // The time that a profile was started, for calculating the total duration.
158 Time profile_start_time;
159
160 // Counters that indicate the current position along the acquisition.
161 int burst = 0;
162 int sample = 0;
163
164 // The collected stack samples. The active profile is always at the back().
165 CallStackProfiles profiles;
166
167 private:
168 static StaticAtomicSequenceNumber next_collection_id_;
169 };
170
171 // Gets the single instance of this class.
172 static SamplingThread* GetInstance();
173
174 // Starts the thread.
175 void Start();
176
177 // Adds a new CollectionContext to the thread. This can be called externally
178 // from any thread. This returns an ID that can later be used to stop
179 // the sampling.
180 int Add(std::unique_ptr<CollectionContext> collection);
181
182 // Removes an active collection based on its ID, forcing it to run its
183 // callback if any data has been collected. This can be called externally
184 // from any thread.
185 void Remove(int id);
186
187 private:
188 friend class TestAPI;
189 friend struct DefaultSingletonTraits<SamplingThread>;
190
191 // The different states in which the sampling-thread can be.
192 enum ThreadExecutionState {
193 // The thread is not running because it has never been started. It will be
194 // started when a sampling request is received.
195 NOT_STARTED,
196
197 // The thread is running and processing tasks. This is the state when any
198 // sampling requests are active and during the "idle" period afterward
199 // before the thread is stopped.
200 RUNNING,
201
202 // Once all sampling requests have finished and the "idle" period has
203 // expired, the thread will be set to this state and its shutdown
204 // initiated. A call to Stop() must be made to ensure the previous thread
205 // has completely exited before calling Start() and moving back to the
206 // RUNNING state.
207 EXITING,
208 };
209
210 SamplingThread();
211 ~SamplingThread() override;
212
213 // Get task runner that is usable from the outside.
214 scoped_refptr<SingleThreadTaskRunner> GetOrCreateTaskRunnerForAdd();
215 scoped_refptr<SingleThreadTaskRunner> GetTaskRunner(
216 ThreadExecutionState* out_state);
217
218 // Get task runner that is usable from the sampling thread itself.
219 scoped_refptr<SingleThreadTaskRunner> GetTaskRunnerOnSamplingThread();
220
221 // Finishes a collection and reports collected data via callback.
222 void FinishCollection(CollectionContext* collection);
223
224 // Records a single sample of a collection.
225 void RecordSample(CollectionContext* collection);
226
227 // Check if the sampling thread is idle and begin a shutdown if so.
228 void ScheduleShutdownIfIdle();
229
230 // These methods are tasks that get posted to the internal message queue.
231 void AddCollectionTask(std::unique_ptr<CollectionContext> collection);
232 void RemoveCollectionTask(int id);
233 void PerformCollectionTask(int id);
234 void ShutdownTask(int add_events);
235
236 // Updates the |next_sample_time| time based on configured parameters.
237 bool UpdateNextSampleTime(CollectionContext* collection);
238
239 // Thread:
240 void CleanUp() override;
241
242 // The task-runner for the sampling thread and some information about it.
243 // This must always be accessed while holding the lock. The saved task-runner
244 // can be freely used by any calling thread. This lock is also used to
245 // order calls to the Thread API (Start, Stop, StopSoon, & DetachFromSequence)
246 // so that multiple threads may make those calls.
247 Lock thread_execution_state_lock_; // Protects all thread_execution_state_*
248 ThreadExecutionState thread_execution_state_ = NOT_STARTED;
249 scoped_refptr<SingleThreadTaskRunner> thread_execution_state_task_runner_;
250 bool thread_execution_state_disable_idle_shutdown_for_testing_ = false;
251
252 // A counter that notes adds of new collection requests. It is incremented
253 // when changes occur so that delayed shutdown tasks are able to detect if
254 // samething new has happened while it was waiting. Like all "execution_state"
255 // vars, this must be accessed while holding |thread_execution_state_lock_|.
256 int thread_execution_state_add_events_ = 0;
257
258 // A map of IDs to collection contexts. Because this class is a singleton
259 // that is never destroyed, context objects will never be destructed except
260 // by explicit action. Thus, it's acceptable to pass unretained pointers
261 // to these objects when posting tasks.
262 std::map<int, std::unique_ptr<CollectionContext>> active_collections_;
263
264 DISALLOW_COPY_AND_ASSIGN(SamplingThread);
265 };
266
267 void StackSamplingProfiler::SamplingThread::TestAPI::DisableIdleShutdown() {
268 SamplingThread* sampler = SamplingThread::GetInstance();
269 DCHECK(sampler);
270
271 {
272 AutoLock lock(sampler->thread_execution_state_lock_);
273 sampler->thread_execution_state_disable_idle_shutdown_for_testing_ = true;
274 }
275 }
276
277 void StackSamplingProfiler::SamplingThread::TestAPI::ShutdownAssumingIdle() {
278 SamplingThread* sampler = SamplingThread::GetInstance();
279 DCHECK(sampler);
280
281 ThreadExecutionState state;
282 scoped_refptr<SingleThreadTaskRunner> task_runner =
283 sampler->GetTaskRunner(&state);
284 DCHECK_EQ(RUNNING, state);
285 DCHECK(task_runner);
286
287 int add_events;
288 {
289 AutoLock lock(sampler->thread_execution_state_lock_);
290 add_events = sampler->thread_execution_state_add_events_;
291 }
292
293 // ShutdownTask will check if the thread is idle and skip the shutdown if not.
294 task_runner->PostTask(FROM_HERE, Bind(&SamplingThread::ShutdownTask,
295 Unretained(sampler), add_events));
296 }
297
298 StaticAtomicSequenceNumber StackSamplingProfiler::SamplingThread::
299 CollectionContext::next_collection_id_;
300
301 StackSamplingProfiler::SamplingThread::SamplingThread()
302 : Thread("Chrome_SamplingProfilerThread") {}
303
304 StackSamplingProfiler::SamplingThread::~SamplingThread() {
305 Stop();
306 }
307
308 StackSamplingProfiler::SamplingThread*
309 StackSamplingProfiler::SamplingThread::GetInstance() {
310 return Singleton<SamplingThread, LeakySingletonTraits<SamplingThread>>::get();
311 }
312
313 void StackSamplingProfiler::SamplingThread::Start() {
314 Thread::Options options;
315 // Use a higher priority for a more accurate sampling interval.
316 options.priority = ThreadPriority::DISPLAY;
317 Thread::StartWithOptions(options);
318 }
319
320 int StackSamplingProfiler::SamplingThread::Add(
321 std::unique_ptr<CollectionContext> collection) {
322 int id = collection->collection_id;
323 scoped_refptr<SingleThreadTaskRunner> task_runner =
324 GetOrCreateTaskRunnerForAdd();
325
326 task_runner->PostTask(FROM_HERE, Bind(&SamplingThread::AddCollectionTask,
327 Unretained(this), Passed(&collection)));
328
329 return id;
330 }
331
332 void StackSamplingProfiler::SamplingThread::Remove(int id) {
333 ThreadExecutionState state;
334 scoped_refptr<SingleThreadTaskRunner> task_runner = GetTaskRunner(&state);
335 DCHECK_NE(NOT_STARTED, state);
336 if (state != RUNNING)
337 return;
338 DCHECK(task_runner);
339
340 // This can fail if the thread were to exit between acquisition of the task
341 // runner above and the call below. In that case, however, everything has
342 // stopped so there's no need to try to stop it.
343 task_runner->PostTask(FROM_HERE, Bind(&SamplingThread::RemoveCollectionTask,
344 Unretained(this), id));
345 }
346
347 scoped_refptr<SingleThreadTaskRunner>
348 StackSamplingProfiler::SamplingThread::GetOrCreateTaskRunnerForAdd() {
349 AutoLock lock(thread_execution_state_lock_);
350
351 // The increment of the "add events" count is why this method is to be only
352 // called from "add".
353 ++thread_execution_state_add_events_;
354
355 if (thread_execution_state_ == RUNNING) {
356 DCHECK(thread_execution_state_task_runner_);
357 // This shouldn't be called from the sampling thread as it's inefficient.
358 // Use GetTaskRunnerOnSamplingThread() instead.
359 DCHECK_NE(GetThreadId(), PlatformThread::CurrentId());
360 return thread_execution_state_task_runner_;
361 }
362
363 if (thread_execution_state_ == EXITING) {
364 // The previous instance has only been partially cleaned up. It is necessary
365 // to call Stop() before Start().
366 Stop();
367 }
368
369 // The thread is not running. Start it and get associated runner. The task-
370 // runner has to be saved for future use because though it can be used from
371 // any thread, it can be acquired via task_runner() only on the created
372 // thread and the thread that creates it (i.e. this thread).
373 Start();
374 thread_execution_state_ = RUNNING;
375 thread_execution_state_task_runner_ = Thread::task_runner();
376
377 // Detach the sampling thread from the "sequence" (i.e. thread) that
378 // started it so that it can be self-managed or stopped by another thread.
379 DetachFromSequence();
380
381 return thread_execution_state_task_runner_;
382 }
383
384 scoped_refptr<SingleThreadTaskRunner>
385 StackSamplingProfiler::SamplingThread::GetTaskRunner(
386 ThreadExecutionState* out_state) {
387 AutoLock lock(thread_execution_state_lock_);
388 if (out_state)
389 *out_state = thread_execution_state_;
390 if (thread_execution_state_ == RUNNING) {
391 // This shouldn't be called from the sampling thread as it's inefficient.
392 // Use GetTaskRunnerOnSamplingThread() instead.
393 DCHECK_NE(GetThreadId(), PlatformThread::CurrentId());
394 DCHECK(thread_execution_state_task_runner_);
395 } else {
396 DCHECK(!thread_execution_state_task_runner_);
397 }
398
399 return thread_execution_state_task_runner_;
400 }
401
402 scoped_refptr<SingleThreadTaskRunner>
403 StackSamplingProfiler::SamplingThread::GetTaskRunnerOnSamplingThread() {
404 // This should be called only from the sampling thread as it has limited
405 // accessibility.
406 DCHECK_EQ(GetThreadId(), PlatformThread::CurrentId());
407
408 return Thread::task_runner();
409 }
410
411 void StackSamplingProfiler::SamplingThread::FinishCollection(
412 CollectionContext* collection) {
413 // If there is no duration for the final profile (because it was stopped),
414 // calculate it now.
415 if (!collection->profiles.empty() &&
416 collection->profiles.back().profile_duration == TimeDelta()) {
417 collection->profiles.back().profile_duration =
418 Time::Now() - collection->profile_start_time;
419 }
420
421 // Extract some information so callback and event-signalling can still be
422 // done after the collection has been removed from the list of "active" ones.
423 // This allows the the controlling object (and tests using it) to be confident
424 // that collection is fully finished when those things occur.
425 const CompletedCallback callback = collection->callback;
426 CallStackProfiles profiles = std::move(collection->profiles);
427 WaitableEvent* finished = collection->finished;
428
429 // Remove this collection from the map of known ones. The |collection|
430 // parameter is invalid after this point.
431 size_t count = active_collections_.erase(collection->collection_id);
432 DCHECK_EQ(1U, count);
433
434 // Run the associated callback, passing the collected profiles.
435 callback.Run(std::move(profiles));
436
437 // Signal that this collection is finished.
438 finished->Signal();
439 }
440
441 void StackSamplingProfiler::SamplingThread::RecordSample(
442 CollectionContext* collection) {
443 DCHECK(collection->native_sampler);
444
445 // If this is the first sample of a burst, a new Profile needs to be created
446 // and filled.
447 if (collection->sample == 0) {
448 collection->profiles.push_back(CallStackProfile());
449 CallStackProfile& profile = collection->profiles.back();
450 profile.sampling_period = collection->params.sampling_interval;
451 collection->profile_start_time = Time::Now();
452 collection->native_sampler->ProfileRecordingStarting(&profile.modules);
453 }
454
455 // The currently active profile being captured.
456 CallStackProfile& profile = collection->profiles.back();
457
458 // Record a single sample.
459 profile.samples.push_back(Sample());
460 collection->native_sampler->RecordStackSample(&profile.samples.back());
461
462 // If this is the last sample of a burst, record the total time.
463 if (collection->sample == collection->params.samples_per_burst - 1) {
464 profile.profile_duration = Time::Now() - collection->profile_start_time;
465 collection->native_sampler->ProfileRecordingStopped();
466 }
467 }
468
469 void StackSamplingProfiler::SamplingThread::ScheduleShutdownIfIdle() {
470 if (!active_collections_.empty())
471 return;
472
473 int add_events;
474 {
475 AutoLock lock(thread_execution_state_lock_);
476 if (thread_execution_state_disable_idle_shutdown_for_testing_)
477 return;
478 add_events = thread_execution_state_add_events_;
479 }
480
481 GetTaskRunnerOnSamplingThread()->PostDelayedTask(
482 FROM_HERE,
483 Bind(&SamplingThread::ShutdownTask, Unretained(this), add_events),
484 TimeDelta::FromSeconds(60));
485 }
486
487 void StackSamplingProfiler::SamplingThread::AddCollectionTask(
488 std::unique_ptr<CollectionContext> collection) {
489 const int collection_id = collection->collection_id;
490 const TimeDelta initial_delay = collection->params.initial_delay;
491
492 active_collections_.insert(
493 std::make_pair(collection_id, std::move(collection)));
494
495 GetTaskRunnerOnSamplingThread()->PostDelayedTask(
496 FROM_HERE,
497 Bind(&SamplingThread::PerformCollectionTask, Unretained(this),
498 collection_id),
499 initial_delay);
500
501 // Another increment of "add events" serves to invalidate any pending
502 // shutdown tasks that may have been initiated between the Add() and this
503 // task running.
504 {
505 AutoLock lock(thread_execution_state_lock_);
506 ++thread_execution_state_add_events_;
507 }
508 }
509
510 void StackSamplingProfiler::SamplingThread::RemoveCollectionTask(int id) {
511 auto found = active_collections_.find(id);
512 if (found == active_collections_.end())
513 return;
514
515 FinishCollection(found->second.get());
516 ScheduleShutdownIfIdle();
517 }
518
519 void StackSamplingProfiler::SamplingThread::PerformCollectionTask(int id) {
520 auto found = active_collections_.find(id);
521
522 // The task won't be found if it has been stopped.
523 if (found == active_collections_.end())
524 return;
525
526 CollectionContext* collection = found->second.get();
527
528 // Handle first-run with no "next time".
529 if (collection->next_sample_time == Time())
530 collection->next_sample_time = Time::Now();
531
532 // Do the collection of a single sample.
533 RecordSample(collection);
534
535 // Update the time of the next sample recording.
536 if (UpdateNextSampleTime(collection)) {
537 bool success = GetTaskRunnerOnSamplingThread()->PostDelayedTask(
538 FROM_HERE,
539 Bind(&SamplingThread::PerformCollectionTask, Unretained(this), id),
540 std::max(collection->next_sample_time - Time::Now(), TimeDelta()));
541 DCHECK(success);
542 } else {
543 // All capturing has completed so finish the collection. Let object expire.
544 // The |collection| variable will be invalid after this call.
545 FinishCollection(collection);
546 ScheduleShutdownIfIdle();
547 }
548 }
549
550 void StackSamplingProfiler::SamplingThread::ShutdownTask(int add_events) {
551 // Holding this lock ensures that any attempt to start another job will
552 // get postponed until thread_execution_state_task_runner_ is cleared, thus
553 // eliminating the race.
554 AutoLock lock(thread_execution_state_lock_);
555
556 // If the current count of creation requests doesn't match the passed count
557 // then other tasks have been created since this was posted. Abort shutdown.
558 if (thread_execution_state_add_events_ != add_events)
559 return;
560
561 // There can be no new AddCollectionTasks at this point because creating
562 // those always increments "add events". There may be other requests, like
563 // Remove, but it's okay to schedule the thread to stop once they've been
564 // executed (i.e. "soon").
565 DCHECK(active_collections_.empty());
566 StopSoon();
567
568 // StopSoon will have set the owning sequence (again) so it must be detached
569 // (again) in order for Stop/Start to be called (again) should more work
570 // come in. Holding the |thread_execution_state_lock_| ensures the necessary
571 // happens-after with regard to this detach and future Thread API calls.
572 DetachFromSequence();
573
574 // Set the thread_state variable so the thread will be restarted when new
575 // work comes in. Remove the thread_execution_state_task_runner_ to avoid
576 // confusion.
577 thread_execution_state_ = EXITING;
578 thread_execution_state_task_runner_ = nullptr;
579 }
580
581 bool StackSamplingProfiler::SamplingThread::UpdateNextSampleTime(
582 CollectionContext* collection) {
583 // This will keep a consistent average interval between samples but will
584 // result in constant series of acquisitions, thus nearly locking out the
585 // target thread, if the interval is smaller than the time it takes to
586 // actually acquire the sample. Anything sampling that quickly is going
587 // to be a problem anyway so don't worry about it.
588 if (++collection->sample < collection->params.samples_per_burst) {
589 collection->next_sample_time += collection->params.sampling_interval;
590 return true;
591 }
592
593 if (++collection->burst < collection->params.bursts) {
594 collection->sample = 0;
595 collection->next_sample_time += collection->params.burst_interval;
596 return true;
597 }
598
599 return false;
600 }
601
602 void StackSamplingProfiler::SamplingThread::CleanUp() {
603 // There should be no collections remaining when the thread stops.
604 DCHECK(active_collections_.empty());
605
606 // Let the parent clean up.
607 Thread::CleanUp();
608 }
609
610 // StackSamplingProfiler ------------------------------------------------------
611
612 // static
613 bool StackSamplingProfiler::TestAPI::IsSamplingThreadRunning() {
614 return SamplingThread::GetInstance()->IsRunning();
615 }
616
617 // static
618 void StackSamplingProfiler::TestAPI::DisableIdleShutdown() {
619 SamplingThread::TestAPI::DisableIdleShutdown();
620 }
621
622 // static
623 void StackSamplingProfiler::TestAPI::InitiateSamplingThreadIdleShutdown() {
624 SamplingThread::TestAPI::ShutdownAssumingIdle();
625 }
626
627 subtle::Atomic32 StackSamplingProfiler::process_milestones_ = 0;
628
629 StackSamplingProfiler::StackSamplingProfiler(
165 const SamplingParams& params, 630 const SamplingParams& params,
166 const CompletedCallback& completed_callback) 631 const CompletedCallback& callback,
167 : native_sampler_(std::move(native_sampler)), 632 NativeStackSamplerTestDelegate* test_delegate)
168 params_(params), 633 : StackSamplingProfiler(base::PlatformThread::CurrentId(),
169 stop_event_(WaitableEvent::ResetPolicy::AUTOMATIC, 634 params,
170 WaitableEvent::InitialState::NOT_SIGNALED), 635 callback,
171 completed_callback_(completed_callback) {} 636 test_delegate) {}
172
173 StackSamplingProfiler::SamplingThread::~SamplingThread() {}
174
175 void StackSamplingProfiler::SamplingThread::ThreadMain() {
176 PlatformThread::SetName("Chrome_SamplingProfilerThread");
177
178 // For now, just ignore any requests to profile while another profiler is
179 // working.
180 if (!concurrent_profiling_lock.Get().Try())
181 return;
182
183 CallStackProfiles profiles;
184 CollectProfiles(&profiles);
185 concurrent_profiling_lock.Get().Release();
186 completed_callback_.Run(std::move(profiles));
187 }
188
189 // Depending on how long the sampling takes and the length of the sampling
190 // interval, a burst of samples could take arbitrarily longer than
191 // samples_per_burst * sampling_interval. In this case, we (somewhat
192 // arbitrarily) honor the number of samples requested rather than strictly
193 // adhering to the sampling intervals. Once we have established users for the
194 // StackSamplingProfiler and the collected data to judge, we may go the other
195 // way or make this behavior configurable.
196 void StackSamplingProfiler::SamplingThread::CollectProfile(
197 CallStackProfile* profile,
198 TimeDelta* elapsed_time,
199 bool* was_stopped) {
200 ElapsedTimer profile_timer;
201 native_sampler_->ProfileRecordingStarting(&profile->modules);
202 profile->sampling_period = params_.sampling_interval;
203 *was_stopped = false;
204 TimeDelta previous_elapsed_sample_time;
205 for (int i = 0; i < params_.samples_per_burst; ++i) {
206 if (i != 0) {
207 // Always wait, even if for 0 seconds, so we can observe a signal on
208 // stop_event_.
209 if (stop_event_.TimedWait(
210 std::max(params_.sampling_interval - previous_elapsed_sample_time,
211 TimeDelta()))) {
212 *was_stopped = true;
213 break;
214 }
215 }
216 ElapsedTimer sample_timer;
217 profile->samples.push_back(Sample());
218 native_sampler_->RecordStackSample(&profile->samples.back());
219 previous_elapsed_sample_time = sample_timer.Elapsed();
220 }
221
222 *elapsed_time = profile_timer.Elapsed();
223 profile->profile_duration = *elapsed_time;
224 native_sampler_->ProfileRecordingStopped();
225 }
226
227 // In an analogous manner to CollectProfile() and samples exceeding the expected
228 // total sampling time, bursts may also exceed the burst_interval. We adopt the
229 // same wait-and-see approach here.
230 void StackSamplingProfiler::SamplingThread::CollectProfiles(
231 CallStackProfiles* profiles) {
232 if (stop_event_.TimedWait(params_.initial_delay))
233 return;
234
235 TimeDelta previous_elapsed_profile_time;
236 for (int i = 0; i < params_.bursts; ++i) {
237 if (i != 0) {
238 // Always wait, even if for 0 seconds, so we can observe a signal on
239 // stop_event_.
240 if (stop_event_.TimedWait(
241 std::max(params_.burst_interval - previous_elapsed_profile_time,
242 TimeDelta())))
243 return;
244 }
245
246 CallStackProfile profile;
247 bool was_stopped = false;
248 CollectProfile(&profile, &previous_elapsed_profile_time, &was_stopped);
249 if (!profile.samples.empty())
250 profiles->push_back(std::move(profile));
251
252 if (was_stopped)
253 return;
254 }
255 }
256
257 void StackSamplingProfiler::SamplingThread::Stop() {
258 stop_event_.Signal();
259 }
260
261 // StackSamplingProfiler ------------------------------------------------------
262
263 subtle::Atomic32 StackSamplingProfiler::process_milestones_ = 0;
264
265 StackSamplingProfiler::StackSamplingProfiler(
266 PlatformThreadId thread_id,
267 const SamplingParams& params,
268 const CompletedCallback& callback)
269 : StackSamplingProfiler(thread_id, params, callback, nullptr) {}
270 637
271 StackSamplingProfiler::StackSamplingProfiler( 638 StackSamplingProfiler::StackSamplingProfiler(
272 PlatformThreadId thread_id, 639 PlatformThreadId thread_id,
273 const SamplingParams& params, 640 const SamplingParams& params,
274 const CompletedCallback& callback, 641 const CompletedCallback& callback,
275 NativeStackSamplerTestDelegate* test_delegate) 642 NativeStackSamplerTestDelegate* test_delegate)
276 : thread_id_(thread_id), params_(params), completed_callback_(callback), 643 : thread_id_(thread_id),
277 test_delegate_(test_delegate) { 644 params_(params),
278 } 645 completed_callback_(callback),
646 // The event starts "signaled" so code knows it's safe to start thread.
647 profiling_inactive_(WaitableEvent::ResetPolicy::MANUAL,
648 WaitableEvent::InitialState::SIGNALED),
649 collection_id_(NULL_COLLECTION_ID),
650 test_delegate_(test_delegate) {}
279 651
280 StackSamplingProfiler::~StackSamplingProfiler() { 652 StackSamplingProfiler::~StackSamplingProfiler() {
653 // Stop is immediate but asynchronous. There is a non-zero probability that
654 // one more sample will be taken after this call returns.
281 Stop(); 655 Stop();
282 if (!sampling_thread_handle_.is_null()) 656
283 PlatformThread::Join(sampling_thread_handle_); 657 // The behavior of sampling a thread that has exited is undefined and could
284 } 658 // cause Bad Things(tm) to occur. The safety model provided by this class is
285 659 // that an instance of this object is expected to live at least as long as
286 // static 660 // the thread it is sampling. However, because the sampling is performed
287 void StackSamplingProfiler::StartAndRunAsync( 661 // asynchronously by the SamplingThread, there is no way to guarantee this
288 PlatformThreadId thread_id, 662 // is true without waiting for it to signal that it has finished.
289 const SamplingParams& params, 663 //
290 const CompletedCallback& callback) { 664 // The wait time should, at most, be only as long as it takes to collect one
291 CHECK(ThreadTaskRunnerHandle::Get()); 665 // sample (~200us) or none at all if sampling has already completed.
292 AsyncRunner::Run(thread_id, params, callback); 666 ThreadRestrictions::ScopedAllowWait allow_wait;
667 profiling_inactive_.Wait();
293 } 668 }
294 669
295 void StackSamplingProfiler::Start() { 670 void StackSamplingProfiler::Start() {
296 if (completed_callback_.is_null()) 671 if (completed_callback_.is_null())
297 return; 672 return;
298 673
299 std::unique_ptr<NativeStackSampler> native_sampler = 674 std::unique_ptr<NativeStackSampler> native_sampler =
300 NativeStackSampler::Create(thread_id_, &RecordAnnotations, 675 NativeStackSampler::Create(thread_id_, &RecordAnnotations,
301 test_delegate_); 676 test_delegate_);
677
302 if (!native_sampler) 678 if (!native_sampler)
303 return; 679 return;
304 680
305 sampling_thread_.reset(new SamplingThread(std::move(native_sampler), params_, 681 // Wait for profiling to be "inactive", then reset it for the upcoming run.
306 completed_callback_)); 682 profiling_inactive_.Wait();
307 if (!PlatformThread::Create(0, sampling_thread_.get(), 683 profiling_inactive_.Reset();
308 &sampling_thread_handle_)) 684
309 sampling_thread_.reset(); 685 DCHECK_EQ(NULL_COLLECTION_ID, collection_id_);
686 collection_id_ = SamplingThread::GetInstance()->Add(
687 MakeUnique<SamplingThread::CollectionContext>(
688 thread_id_, params_, completed_callback_, &profiling_inactive_,
689 std::move(native_sampler)));
690 DCHECK_NE(NULL_COLLECTION_ID, collection_id_);
310 } 691 }
311 692
312 void StackSamplingProfiler::Stop() { 693 void StackSamplingProfiler::Stop() {
313 if (sampling_thread_) 694 SamplingThread::GetInstance()->Remove(collection_id_);
314 sampling_thread_->Stop(); 695 collection_id_ = NULL_COLLECTION_ID;
315 } 696 }
316 697
317 // static 698 // static
318 void StackSamplingProfiler::SetProcessMilestone(int milestone) { 699 void StackSamplingProfiler::SetProcessMilestone(int milestone) {
319 DCHECK_LE(0, milestone); 700 DCHECK_LE(0, milestone);
320 DCHECK_GT(static_cast<int>(sizeof(process_milestones_) * 8), milestone); 701 DCHECK_GT(static_cast<int>(sizeof(process_milestones_) * 8), milestone);
321 DCHECK_EQ(0, subtle::NoBarrier_Load(&process_milestones_) & (1 << milestone)); 702 DCHECK_EQ(0, subtle::NoBarrier_Load(&process_milestones_) & (1 << milestone));
322 ChangeAtomicFlags(&process_milestones_, 1 << milestone, 0); 703 ChangeAtomicFlags(&process_milestones_, 1 << milestone, 0);
323 } 704 }
324 705
(...skipping 45 matching lines...) Expand 10 before | Expand all | Expand 10 after
370 } 751 }
371 752
372 bool operator<(const StackSamplingProfiler::Frame &a, 753 bool operator<(const StackSamplingProfiler::Frame &a,
373 const StackSamplingProfiler::Frame &b) { 754 const StackSamplingProfiler::Frame &b) {
374 return (a.module_index < b.module_index) || 755 return (a.module_index < b.module_index) ||
375 (a.module_index == b.module_index && 756 (a.module_index == b.module_index &&
376 a.instruction_pointer < b.instruction_pointer); 757 a.instruction_pointer < b.instruction_pointer);
377 } 758 }
378 759
379 } // namespace base 760 } // namespace base
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698