blob: 5c3b2bf648917f7275efdd8da653d98acbb3ddf4 [file] [log] [blame]
jhawkins@chromium.orge194f3d2012-01-05 11:18:18 +09001// Copyright (c) 2012 The Chromium Authors. All rights reserved.
license.botf003cfe2008-08-24 09:55:55 +09002// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
initial.commit3f4a7322008-07-27 06:49:38 +09004
darin@google.com6ddeb842008-08-15 16:31:20 +09005#include "base/message_loop.h"
6
darin@google.com981f3552008-08-16 12:09:05 +09007#include <algorithm>
8
ajwong@chromium.org94d2a582011-04-21 01:02:23 +09009#include "base/bind.h"
mmentovai@google.comfa5f9932008-08-22 07:26:06 +090010#include "base/compiler_specific.h"
apatrick@chromium.org87164042011-05-20 07:28:25 +090011#include "base/debug/alias.h"
jbates@chromium.orgb84db522011-10-04 02:51:25 +090012#include "base/debug/trace_event.h"
deanm@chromium.orgcd1ce302008-09-10 19:54:06 +090013#include "base/lazy_instance.h"
initial.commit3f4a7322008-07-27 06:49:38 +090014#include "base/logging.h"
thestig@chromium.orgefd4aaf2011-06-15 13:14:23 +090015#include "base/memory/scoped_ptr.h"
nduca@chromium.orgba048612011-08-16 05:33:46 +090016#include "base/message_loop_proxy_impl.h"
darin@google.com12d40bb2008-08-20 03:36:23 +090017#include "base/message_pump_default.h"
brettw@chromium.org275c2ec2010-10-14 13:38:38 +090018#include "base/metrics/histogram.h"
timurrrr@chromium.org490200b2011-01-05 04:06:51 +090019#include "base/third_party/dynamic_annotations/dynamic_annotations.h"
sergeyu@chromium.org675d8882012-05-10 05:16:14 +090020#include "base/thread_task_runner_handle.h"
brettw@chromium.org63965582010-12-31 07:18:56 +090021#include "base/threading/thread_local.h"
mbelshe@chromium.orgbee85b32011-05-16 04:20:49 +090022#include "base/time.h"
ajwong@chromium.org94d2a582011-04-21 01:02:23 +090023#include "base/tracked_objects.h"
initial.commit3f4a7322008-07-27 06:49:38 +090024
mark@chromium.org059d0492008-09-24 06:08:28 +090025#if defined(OS_MACOSX)
26#include "base/message_pump_mac.h"
27#endif
dkegel@google.com9e044ae2008-09-19 03:46:26 +090028#if defined(OS_POSIX)
29#include "base/message_pump_libevent.h"
30#endif
michaelbai@google.com686190b2011-08-03 01:11:16 +090031#if defined(OS_ANDROID)
32#include "base/message_pump_android.h"
33#endif
oshima@chromium.org59a08552012-04-05 09:21:22 +090034
35#if defined(TOOLKIT_GTK)
ajwong@chromium.org94d2a582011-04-21 01:02:23 +090036#include <gdk/gdk.h>
37#include <gdk/gdkx.h>
oshima@chromium.org59a08552012-04-05 09:21:22 +090038#endif
dkegel@google.com9e044ae2008-09-19 03:46:26 +090039
jhawkins@chromium.org2af12f22011-11-16 08:36:30 +090040using base::PendingTask;
dsh@google.com0f8dd262008-10-28 05:43:33 +090041using base::TimeDelta;
jar@chromium.org9b0fb062010-11-07 07:23:29 +090042using base::TimeTicks;
dsh@google.com0f8dd262008-10-28 05:43:33 +090043
erg@chromium.orga7528522010-07-16 02:23:23 +090044namespace {
45
deanm@chromium.orgcd1ce302008-09-10 19:54:06 +090046// A lazily created thread local storage for quick access to a thread's message
47// loop, if one exists. This should be safe and free of static constructors.
joth@chromium.orgb24883c2011-11-15 22:31:49 +090048base::LazyInstance<base::ThreadLocalPointer<MessageLoop> > lazy_tls_ptr =
49 LAZY_INSTANCE_INITIALIZER;
initial.commit3f4a7322008-07-27 06:49:38 +090050
initial.commit3f4a7322008-07-27 06:49:38 +090051// Logical events for Histogram profiling. Run with -message-loop-histogrammer
52// to get an accounting of messages and actions taken on each thread.
erg@chromium.orga7528522010-07-16 02:23:23 +090053const int kTaskRunEvent = 0x1;
54const int kTimerEvent = 0x2;
initial.commit3f4a7322008-07-27 06:49:38 +090055
56// Provide range of message IDs for use in histogramming and debug display.
erg@chromium.orga7528522010-07-16 02:23:23 +090057const int kLeastNonZeroMessageId = 1;
58const int kMaxMessageId = 1099;
59const int kNumberOfDistinctMessagesDisplayed = 1100;
60
61// Provide a macro that takes an expression (such as a constant, or macro
62// constant) and creates a pair to initalize an array of pairs. In this case,
63// our pair consists of the expressions value, and the "stringized" version
64// of the expression (i.e., the exrpression put in quotes). For example, if
65// we have:
66// #define FOO 2
67// #define BAR 5
68// then the following:
69// VALUE_TO_NUMBER_AND_NAME(FOO + BAR)
70// will expand to:
71// {7, "FOO + BAR"}
72// We use the resulting array as an argument to our histogram, which reads the
73// number as a bucket identifier, and proceeds to use the corresponding name
74// in the pair (i.e., the quoted string) when printing out a histogram.
75#define VALUE_TO_NUMBER_AND_NAME(name) {name, #name},
76
brettw@chromium.org275c2ec2010-10-14 13:38:38 +090077const base::LinearHistogram::DescriptionPair event_descriptions_[] = {
erg@chromium.orga7528522010-07-16 02:23:23 +090078 // Provide some pretty print capability in our histogram for our internal
79 // messages.
80
81 // A few events we handle (kindred to messages), and used to profile actions.
82 VALUE_TO_NUMBER_AND_NAME(kTaskRunEvent)
83 VALUE_TO_NUMBER_AND_NAME(kTimerEvent)
84
85 {-1, NULL} // The list must be null terminated, per API to histogram.
86};
87
88bool enable_histogrammer_ = false;
89
michaelbai@google.com686190b2011-08-03 01:11:16 +090090MessageLoop::MessagePumpFactory* message_pump_for_ui_factory_ = NULL;
91
erg@chromium.orga7528522010-07-16 02:23:23 +090092} // namespace
initial.commit3f4a7322008-07-27 06:49:38 +090093
94//------------------------------------------------------------------------------
95
darin@google.com981f3552008-08-16 12:09:05 +090096#if defined(OS_WIN)
initial.commit3f4a7322008-07-27 06:49:38 +090097
initial.commit3f4a7322008-07-27 06:49:38 +090098// Upon a SEH exception in this thread, it restores the original unhandled
99// exception filter.
100static int SEHFilter(LPTOP_LEVEL_EXCEPTION_FILTER old_filter) {
101 ::SetUnhandledExceptionFilter(old_filter);
102 return EXCEPTION_CONTINUE_SEARCH;
103}
104
105// Retrieves a pointer to the current unhandled exception filter. There
106// is no standalone getter method.
107static LPTOP_LEVEL_EXCEPTION_FILTER GetTopSEHFilter() {
108 LPTOP_LEVEL_EXCEPTION_FILTER top_filter = NULL;
109 top_filter = ::SetUnhandledExceptionFilter(0);
110 ::SetUnhandledExceptionFilter(top_filter);
111 return top_filter;
112}
113
darin@google.com981f3552008-08-16 12:09:05 +0900114#endif // defined(OS_WIN)
115
initial.commit3f4a7322008-07-27 06:49:38 +0900116//------------------------------------------------------------------------------
117
erg@chromium.org493f5f62010-07-16 06:03:54 +0900118MessageLoop::TaskObserver::TaskObserver() {
119}
120
121MessageLoop::TaskObserver::~TaskObserver() {
122}
123
124MessageLoop::DestructionObserver::~DestructionObserver() {
125}
126
127//------------------------------------------------------------------------------
128
darin@google.comd936b5b2008-08-26 14:53:57 +0900129MessageLoop::MessageLoop(Type type)
130 : type_(type),
darin@google.comee6fa722008-08-13 08:25:43 +0900131 nestable_tasks_allowed_(true),
darin@google.com12d40bb2008-08-20 03:36:23 +0900132 exception_restoration_(false),
jar@chromium.org34571142011-04-05 13:48:53 +0900133 message_histogram_(NULL),
darin@google.combe165ae2008-09-07 17:08:29 +0900134 state_(NULL),
ananta@chromium.orgc542fec2011-03-24 12:40:28 +0900135#ifdef OS_WIN
136 os_modal_loop_(false),
137#endif // OS_WIN
darin@google.combe165ae2008-09-07 17:08:29 +0900138 next_sequence_num_(0) {
deanm@chromium.orgcd1ce302008-09-10 19:54:06 +0900139 DCHECK(!current()) << "should only have one message loop per thread";
140 lazy_tls_ptr.Pointer()->Set(this);
darin@google.comd936b5b2008-08-26 14:53:57 +0900141
nduca@chromium.orgba048612011-08-16 05:33:46 +0900142 message_loop_proxy_ = new base::MessageLoopProxyImpl();
sergeyu@chromium.org675d8882012-05-10 05:16:14 +0900143 thread_task_runner_handle_.reset(
144 new base::ThreadTaskRunnerHandle(message_loop_proxy_));
nduca@chromium.orgba048612011-08-16 05:33:46 +0900145
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900146// TODO(rvargas): Get rid of the OS guards.
darin@google.com981f3552008-08-16 12:09:05 +0900147#if defined(OS_WIN)
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900148#define MESSAGE_PUMP_UI new base::MessagePumpForUI()
149#define MESSAGE_PUMP_IO new base::MessagePumpForIO()
150#elif defined(OS_MACOSX)
151#define MESSAGE_PUMP_UI base::MessagePumpMac::Create()
152#define MESSAGE_PUMP_IO new base::MessagePumpLibevent()
abarth@chromium.org1f1c2172010-12-01 17:45:51 +0900153#elif defined(OS_NACL)
dmichael@chromium.orgb798bb42012-06-01 04:37:54 +0900154// Currently NaCl doesn't have a UI MessageLoop.
155// TODO(abarth): Figure out if we need this.
abarth@chromium.org1f1c2172010-12-01 17:45:51 +0900156#define MESSAGE_PUMP_UI NULL
dmichael@chromium.orgb798bb42012-06-01 04:37:54 +0900157// ipc_channel_nacl.cc uses a worker thread to do socket reads currently, and
158// doesn't require extra support for watching file descriptors.
159#define MESSAGE_PUMP_IO new base::MessagePumpDefault();
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900160#elif defined(OS_POSIX) // POSIX but not MACOSX.
piman@chromium.orgbfd272d2011-12-15 01:34:31 +0900161#define MESSAGE_PUMP_UI new base::MessagePumpForUI()
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900162#define MESSAGE_PUMP_IO new base::MessagePumpLibevent()
evan@chromium.org875bb6e2009-12-29 09:32:52 +0900163#else
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900164#error Not implemented
evan@chromium.org875bb6e2009-12-29 09:32:52 +0900165#endif
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900166
167 if (type_ == TYPE_UI) {
michaelbai@google.com686190b2011-08-03 01:11:16 +0900168 if (message_pump_for_ui_factory_)
169 pump_ = message_pump_for_ui_factory_();
170 else
171 pump_ = MESSAGE_PUMP_UI;
dsh@google.com119a2522008-10-04 01:52:59 +0900172 } else if (type_ == TYPE_IO) {
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900173 pump_ = MESSAGE_PUMP_IO;
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900174 } else {
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900175 DCHECK_EQ(TYPE_DEFAULT, type_);
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900176 pump_ = new base::MessagePumpDefault();
177 }
initial.commit3f4a7322008-07-27 06:49:38 +0900178}
179
180MessageLoop::~MessageLoop() {
thestig@chromium.org226880a2010-11-11 05:28:06 +0900181 DCHECK_EQ(this, current());
darin@google.com965e5342008-08-06 08:16:41 +0900182
darin@google.com0e500502008-09-09 14:55:35 +0900183 DCHECK(!state_);
184
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900185 // Clean up any unprocessed tasks, but take care: deleting a task could
186 // result in the addition of more tasks (e.g., via DeleteSoon). We set a
187 // limit on the number of times we will allow a deleted task to generate more
188 // tasks. Normally, we should only pass through this loop once or twice. If
189 // we end up hitting the loop limit, then it is probably due to one task that
190 // is being stubborn. Inspect the queues to see who is left.
191 bool did_work;
192 for (int i = 0; i < 100; ++i) {
193 DeletePendingTasks();
194 ReloadWorkQueue();
195 // If we end up with empty queues, then break out of the loop.
196 did_work = DeletePendingTasks();
197 if (!did_work)
198 break;
darin@google.com0e500502008-09-09 14:55:35 +0900199 }
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900200 DCHECK(!did_work);
201
sanjeevr@chromium.org03b44d52010-11-30 09:25:29 +0900202 // Let interested parties have one last shot at accessing this.
203 FOR_EACH_OBSERVER(DestructionObserver, destruction_observers_,
204 WillDestroyCurrentMessageLoop());
205
sergeyu@chromium.org675d8882012-05-10 05:16:14 +0900206 thread_task_runner_handle_.reset();
207
nduca@chromium.orgba048612011-08-16 05:33:46 +0900208 // Tell the message_loop_proxy that we are dying.
209 static_cast<base::MessageLoopProxyImpl*>(message_loop_proxy_.get())->
210 WillDestroyCurrentMessageLoop();
211 message_loop_proxy_ = NULL;
212
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900213 // OK, now make it so that no one can find us.
deanm@chromium.orge4cc5922008-09-10 20:14:56 +0900214 lazy_tls_ptr.Pointer()->Set(NULL);
mbelshe@chromium.orgbee85b32011-05-16 04:20:49 +0900215
216#if defined(OS_WIN)
217 // If we left the high-resolution timer activated, deactivate it now.
218 // Doing this is not-critical, it is mainly to make sure we track
219 // the high resolution timer activations properly in our unit tests.
220 if (!high_resolution_timer_expiration_.is_null()) {
221 base::Time::ActivateHighResolutionTimer(false);
222 high_resolution_timer_expiration_ = base::TimeTicks();
223 }
224#endif
initial.commit3f4a7322008-07-27 06:49:38 +0900225}
226
erg@google.com67a25432011-01-08 05:23:43 +0900227// static
228MessageLoop* MessageLoop::current() {
229 // TODO(darin): sadly, we cannot enable this yet since people call us even
230 // when they have no intention of using us.
231 // DCHECK(loop) << "Ouch, did you forget to initialize me?";
232 return lazy_tls_ptr.Pointer()->Get();
233}
234
235// static
236void MessageLoop::EnableHistogrammer(bool enable) {
237 enable_histogrammer_ = enable;
238}
239
michaelbai@google.com686190b2011-08-03 01:11:16 +0900240// static
241void MessageLoop::InitMessagePumpForUIFactory(MessagePumpFactory* factory) {
242 DCHECK(!message_pump_for_ui_factory_);
243 message_pump_for_ui_factory_ = factory;
244}
245
sky@chromium.org18c66dc2010-09-16 07:14:36 +0900246void MessageLoop::AddDestructionObserver(
247 DestructionObserver* destruction_observer) {
thestig@chromium.org226880a2010-11-11 05:28:06 +0900248 DCHECK_EQ(this, current());
sky@chromium.org18c66dc2010-09-16 07:14:36 +0900249 destruction_observers_.AddObserver(destruction_observer);
darin@google.com965e5342008-08-06 08:16:41 +0900250}
251
sky@chromium.org18c66dc2010-09-16 07:14:36 +0900252void MessageLoop::RemoveDestructionObserver(
253 DestructionObserver* destruction_observer) {
thestig@chromium.org226880a2010-11-11 05:28:06 +0900254 DCHECK_EQ(this, current());
sky@chromium.org18c66dc2010-09-16 07:14:36 +0900255 destruction_observers_.RemoveObserver(destruction_observer);
darin@google.com965e5342008-08-06 08:16:41 +0900256}
257
darin@google.combe165ae2008-09-07 17:08:29 +0900258void MessageLoop::PostTask(
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900259 const tracked_objects::Location& from_here, const base::Closure& task) {
brettw@chromium.org5faed3c2011-10-27 06:48:00 +0900260 DCHECK(!task.is_null()) << from_here.ToString();
tedvessenes@gmail.com99ed6d72012-06-02 06:33:00 +0900261 PendingTask pending_task(
262 from_here, task, CalculateDelayedRuntime(TimeDelta()), true);
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900263 AddToIncomingQueue(&pending_task);
264}
265
266void MessageLoop::PostDelayedTask(
tedvessenes@gmail.com658a87f2011-12-30 10:04:36 +0900267 const tracked_objects::Location& from_here,
268 const base::Closure& task,
tedvessenes@gmail.com99ed6d72012-06-02 06:33:00 +0900269 TimeDelta delay) {
brettw@chromium.org5faed3c2011-10-27 06:48:00 +0900270 DCHECK(!task.is_null()) << from_here.ToString();
tedvessenes@gmail.com99ed6d72012-06-02 06:33:00 +0900271 PendingTask pending_task(
272 from_here, task, CalculateDelayedRuntime(delay), true);
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900273 AddToIncomingQueue(&pending_task);
274}
275
276void MessageLoop::PostNonNestableTask(
277 const tracked_objects::Location& from_here, const base::Closure& task) {
brettw@chromium.org5faed3c2011-10-27 06:48:00 +0900278 DCHECK(!task.is_null()) << from_here.ToString();
tedvessenes@gmail.com99ed6d72012-06-02 06:33:00 +0900279 PendingTask pending_task(
280 from_here, task, CalculateDelayedRuntime(TimeDelta()), false);
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900281 AddToIncomingQueue(&pending_task);
darin@google.combe165ae2008-09-07 17:08:29 +0900282}
283
tedvessenes@gmail.com658a87f2011-12-30 10:04:36 +0900284void MessageLoop::PostNonNestableDelayedTask(
285 const tracked_objects::Location& from_here,
286 const base::Closure& task,
tedvessenes@gmail.com99ed6d72012-06-02 06:33:00 +0900287 TimeDelta delay) {
288 DCHECK(!task.is_null()) << from_here.ToString();
289 PendingTask pending_task(
290 from_here, task, CalculateDelayedRuntime(delay), false);
291 AddToIncomingQueue(&pending_task);
tedvessenes@gmail.com658a87f2011-12-30 10:04:36 +0900292}
293
erg@google.com67a25432011-01-08 05:23:43 +0900294void MessageLoop::Run() {
295 AutoRunState save_state(this);
296 RunHandler();
297}
darin@google.com0795f572008-08-30 09:22:48 +0900298
erg@google.com67a25432011-01-08 05:23:43 +0900299void MessageLoop::RunAllPending() {
300 AutoRunState save_state(this);
301 state_->quit_received = true; // Means run until we would otherwise block.
302 RunHandler();
303}
darin@google.com0795f572008-08-30 09:22:48 +0900304
erg@google.com67a25432011-01-08 05:23:43 +0900305void MessageLoop::Quit() {
306 DCHECK_EQ(this, current());
307 if (state_) {
308 state_->quit_received = true;
darin@google.com0795f572008-08-30 09:22:48 +0900309 } else {
erg@google.com67a25432011-01-08 05:23:43 +0900310 NOTREACHED() << "Must be inside Run to call Quit";
darin@google.com0795f572008-08-30 09:22:48 +0900311 }
erg@google.com67a25432011-01-08 05:23:43 +0900312}
darin@google.com0795f572008-08-30 09:22:48 +0900313
erg@google.com67a25432011-01-08 05:23:43 +0900314void MessageLoop::QuitNow() {
315 DCHECK_EQ(this, current());
316 if (state_) {
317 pump_->Quit();
318 } else {
319 NOTREACHED() << "Must be inside Run to call Quit";
mbelshe@chromium.orgde50b7d2010-06-29 13:58:15 +0900320 }
initial.commit3f4a7322008-07-27 06:49:38 +0900321}
322
kalman@chromium.orgc89ed902011-10-21 15:21:57 +0900323static void QuitCurrent() {
324 MessageLoop::current()->Quit();
325}
326
jhawkins@chromium.org573d4182011-10-17 10:20:36 +0900327// static
328base::Closure MessageLoop::QuitClosure() {
kalman@chromium.orgc89ed902011-10-21 15:21:57 +0900329 return base::Bind(&QuitCurrent);
jhawkins@chromium.org573d4182011-10-17 10:20:36 +0900330}
331
initial.commit3f4a7322008-07-27 06:49:38 +0900332void MessageLoop::SetNestableTasksAllowed(bool allowed) {
mpcomplete@google.com989d5f82008-08-09 09:14:09 +0900333 if (nestable_tasks_allowed_ != allowed) {
334 nestable_tasks_allowed_ = allowed;
335 if (!nestable_tasks_allowed_)
336 return;
337 // Start the native pump if we are not already pumping.
darin@google.com981f3552008-08-16 12:09:05 +0900338 pump_->ScheduleWork();
mpcomplete@google.com989d5f82008-08-09 09:14:09 +0900339 }
initial.commit3f4a7322008-07-27 06:49:38 +0900340}
341
342bool MessageLoop::NestableTasksAllowed() const {
343 return nestable_tasks_allowed_;
344}
345
jcampan@chromium.orgeac57172009-07-02 04:53:59 +0900346bool MessageLoop::IsNested() {
347 return state_->run_depth > 1;
348}
349
erg@google.com67a25432011-01-08 05:23:43 +0900350void MessageLoop::AddTaskObserver(TaskObserver* task_observer) {
351 DCHECK_EQ(this, current());
352 task_observers_.AddObserver(task_observer);
353}
354
355void MessageLoop::RemoveTaskObserver(TaskObserver* task_observer) {
356 DCHECK_EQ(this, current());
357 task_observers_.RemoveObserver(task_observer);
358}
359
willchan@chromium.org3a397672011-01-26 09:53:48 +0900360void MessageLoop::AssertIdle() const {
361 // We only check |incoming_queue_|, since we don't want to lock |work_queue_|.
362 base::AutoLock lock(incoming_queue_lock_);
363 DCHECK(incoming_queue_.empty());
364}
365
willchan@chromium.orgfe2201e2011-11-02 07:06:58 +0900366bool MessageLoop::is_running() const {
367 DCHECK_EQ(this, current());
368 return state_ != NULL;
369}
370
initial.commit3f4a7322008-07-27 06:49:38 +0900371//------------------------------------------------------------------------------
initial.commit3f4a7322008-07-27 06:49:38 +0900372
erg@google.com67a25432011-01-08 05:23:43 +0900373// Runs the loop in two different SEH modes:
374// enable_SEH_restoration_ = false : any unhandled exception goes to the last
375// one that calls SetUnhandledExceptionFilter().
376// enable_SEH_restoration_ = true : any unhandled exception goes to the filter
377// that was existed before the loop was run.
378void MessageLoop::RunHandler() {
379#if defined(OS_WIN)
380 if (exception_restoration_) {
381 RunInternalInSEHFrame();
382 return;
383 }
384#endif
385
386 RunInternal();
387}
388
389#if defined(OS_WIN)
390__declspec(noinline) void MessageLoop::RunInternalInSEHFrame() {
391 LPTOP_LEVEL_EXCEPTION_FILTER current_filter = GetTopSEHFilter();
392 __try {
393 RunInternal();
394 } __except(SEHFilter(current_filter)) {
395 }
396 return;
397}
398#endif
399
400void MessageLoop::RunInternal() {
401 DCHECK_EQ(this, current());
402
403 StartHistogrammer();
404
michaelbai@google.com686190b2011-08-03 01:11:16 +0900405#if !defined(OS_MACOSX) && !defined(OS_ANDROID)
erg@google.com67a25432011-01-08 05:23:43 +0900406 if (state_->dispatcher && type() == TYPE_UI) {
407 static_cast<base::MessagePumpForUI*>(pump_.get())->
408 RunWithDispatcher(this, state_->dispatcher);
409 return;
410 }
411#endif
412
413 pump_->Run(this);
414}
415
416bool MessageLoop::ProcessNextDelayedNonNestableTask() {
417 if (state_->run_depth != 1)
418 return false;
419
420 if (deferred_non_nestable_work_queue_.empty())
421 return false;
422
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900423 PendingTask pending_task = deferred_non_nestable_work_queue_.front();
erg@google.com67a25432011-01-08 05:23:43 +0900424 deferred_non_nestable_work_queue_.pop();
425
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900426 RunTask(pending_task);
erg@google.com67a25432011-01-08 05:23:43 +0900427 return true;
428}
429
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900430void MessageLoop::RunTask(const PendingTask& pending_task) {
jbates@chromium.org5a97c212012-02-24 04:16:35 +0900431 TRACE_EVENT2("task", "MessageLoop::RunTask",
432 "src_file", pending_task.posted_from.file_name(),
433 "src_func", pending_task.posted_from.function_name());
initial.commit3f4a7322008-07-27 06:49:38 +0900434 DCHECK(nestable_tasks_allowed_);
435 // Execute the task and assume the worst: It is probably not reentrant.
436 nestable_tasks_allowed_ = false;
darin@google.combe165ae2008-09-07 17:08:29 +0900437
apatrick@chromium.org87164042011-05-20 07:28:25 +0900438 // Before running the task, store the program counter where it was posted
439 // and deliberately alias it to ensure it is on the stack if the task
440 // crashes. Be careful not to assume that the variable itself will have the
441 // expected value when displayed by the optimizer in an optimized build.
442 // Look at a memory dump of the stack.
jbates@chromium.orgb84db522011-10-04 02:51:25 +0900443 const void* program_counter =
444 pending_task.posted_from.program_counter();
apatrick@chromium.org87164042011-05-20 07:28:25 +0900445 base::debug::Alias(&program_counter);
446
darin@google.combe165ae2008-09-07 17:08:29 +0900447 HistogramEvent(kTaskRunEvent);
jar@chromium.org79a58c32011-10-16 08:52:45 +0900448
jar@chromium.orgb536eef2011-11-14 14:24:07 +0900449 tracked_objects::TrackedTime start_time =
jar@chromium.orgb5c974b2011-12-14 10:36:48 +0900450 tracked_objects::ThreadData::NowForStartOfRun(pending_task.birth_tally);
jar@chromium.org79a58c32011-10-16 08:52:45 +0900451
willchan@chromium.orga9047632010-06-10 06:20:41 +0900452 FOR_EACH_OBSERVER(TaskObserver, task_observers_,
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900453 WillProcessTask(pending_task.time_posted));
454 pending_task.task.Run();
455 FOR_EACH_OBSERVER(TaskObserver, task_observers_,
456 DidProcessTask(pending_task.time_posted));
jar@chromium.org4be2cb02011-11-01 07:36:21 +0900457
458 tracked_objects::ThreadData::TallyRunOnNamedThreadIfTracking(pending_task,
jar@chromium.orgb536eef2011-11-14 14:24:07 +0900459 start_time, tracked_objects::ThreadData::NowForEndOfRun());
darin@google.combe165ae2008-09-07 17:08:29 +0900460
461 nestable_tasks_allowed_ = true;
initial.commit3f4a7322008-07-27 06:49:38 +0900462}
463
jar@chromium.org79a58c32011-10-16 08:52:45 +0900464bool MessageLoop::DeferOrRunPendingTask(const PendingTask& pending_task) {
darin@google.combe165ae2008-09-07 17:08:29 +0900465 if (pending_task.nestable || state_->run_depth == 1) {
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900466 RunTask(pending_task);
darin@google.combe165ae2008-09-07 17:08:29 +0900467 // Show that we ran a task (Note: a new one might arrive as a
468 // consequence!).
469 return true;
470 }
471
472 // We couldn't run the task now because we're in a nested message loop
473 // and the task isn't nestable.
474 deferred_non_nestable_work_queue_.push(pending_task);
475 return false;
initial.commit3f4a7322008-07-27 06:49:38 +0900476}
477
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900478void MessageLoop::AddToDelayedWorkQueue(const PendingTask& pending_task) {
479 // Move to the delayed work queue. Initialize the sequence number
480 // before inserting into the delayed_work_queue_. The sequence number
481 // is used to faciliate FIFO sorting when two tasks have the same
482 // delayed_run_time value.
483 PendingTask new_pending_task(pending_task);
484 new_pending_task.sequence_num = next_sequence_num_++;
485 delayed_work_queue_.push(new_pending_task);
486}
487
initial.commit3f4a7322008-07-27 06:49:38 +0900488void MessageLoop::ReloadWorkQueue() {
489 // We can improve performance of our loading tasks from incoming_queue_ to
darin@google.com981f3552008-08-16 12:09:05 +0900490 // work_queue_ by waiting until the last minute (work_queue_ is empty) to
491 // load. That reduces the number of locks-per-task significantly when our
darin@google.combe165ae2008-09-07 17:08:29 +0900492 // queues get large.
493 if (!work_queue_.empty())
initial.commit3f4a7322008-07-27 06:49:38 +0900494 return; // Wait till we *really* need to lock and load.
495
496 // Acquire all we can from the inter-thread queue with one lock acquisition.
initial.commit3f4a7322008-07-27 06:49:38 +0900497 {
brettw@chromium.orgabe477a2011-01-21 13:55:52 +0900498 base::AutoLock lock(incoming_queue_lock_);
darin@google.combe165ae2008-09-07 17:08:29 +0900499 if (incoming_queue_.empty())
initial.commit3f4a7322008-07-27 06:49:38 +0900500 return;
darin@chromium.orgb80ef1a2009-09-03 05:05:21 +0900501 incoming_queue_.Swap(&work_queue_); // Constant time
darin@google.combe165ae2008-09-07 17:08:29 +0900502 DCHECK(incoming_queue_.empty());
initial.commit3f4a7322008-07-27 06:49:38 +0900503 }
504}
505
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900506bool MessageLoop::DeletePendingTasks() {
507 bool did_work = !work_queue_.empty();
508 while (!work_queue_.empty()) {
509 PendingTask pending_task = work_queue_.front();
510 work_queue_.pop();
511 if (!pending_task.delayed_run_time.is_null()) {
512 // We want to delete delayed tasks in the same order in which they would
513 // normally be deleted in case of any funny dependencies between delayed
514 // tasks.
515 AddToDelayedWorkQueue(pending_task);
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900516 }
initial.commit3f4a7322008-07-27 06:49:38 +0900517 }
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900518 did_work |= !deferred_non_nestable_work_queue_.empty();
519 while (!deferred_non_nestable_work_queue_.empty()) {
jar@chromium.org2fa6b4b2009-03-12 04:53:50 +0900520 deferred_non_nestable_work_queue_.pop();
initial.commit3f4a7322008-07-27 06:49:38 +0900521 }
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900522 did_work |= !delayed_work_queue_.empty();
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900523
524 // Historically, we always delete the task regardless of valgrind status. It's
525 // not completely clear why we want to leak them in the loops above. This
526 // code is replicating legacy behavior, and should not be considered
527 // absolutely "correct" behavior. See TODO above about deleting all tasks
528 // when it's safe.
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900529 while (!delayed_work_queue_.empty()) {
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900530 delayed_work_queue_.pop();
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900531 }
532 return did_work;
initial.commit3f4a7322008-07-27 06:49:38 +0900533}
534
tedvessenes@gmail.com99ed6d72012-06-02 06:33:00 +0900535TimeTicks MessageLoop::CalculateDelayedRuntime(TimeDelta delay) {
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900536 TimeTicks delayed_run_time;
tedvessenes@gmail.com99ed6d72012-06-02 06:33:00 +0900537 if (delay > TimeDelta()) {
538 delayed_run_time = TimeTicks::Now() + delay;
erg@google.com67a25432011-01-08 05:23:43 +0900539
540#if defined(OS_WIN)
541 if (high_resolution_timer_expiration_.is_null()) {
542 // Windows timers are granular to 15.6ms. If we only set high-res
543 // timers for those under 15.6ms, then a 18ms timer ticks at ~32ms,
544 // which as a percentage is pretty inaccurate. So enable high
545 // res timers for any timer which is within 2x of the granularity.
546 // This is a tradeoff between accuracy and power management.
tedvessenes@gmail.com99ed6d72012-06-02 06:33:00 +0900547 bool needs_high_res_timers = delay.InMilliseconds() <
548 (2 * base::Time::kMinLowResolutionThresholdMs);
erg@google.com67a25432011-01-08 05:23:43 +0900549 if (needs_high_res_timers) {
mbelshe@chromium.orgbee85b32011-05-16 04:20:49 +0900550 if (base::Time::ActivateHighResolutionTimer(true)) {
551 high_resolution_timer_expiration_ = TimeTicks::Now() +
552 TimeDelta::FromMilliseconds(kHighResolutionTimerModeLeaseTimeMs);
553 }
erg@google.com67a25432011-01-08 05:23:43 +0900554 }
555 }
556#endif
557 } else {
tedvessenes@gmail.com99ed6d72012-06-02 06:33:00 +0900558 DCHECK_EQ(delay.InMilliseconds(), 0) << "delay should not be negative";
erg@google.com67a25432011-01-08 05:23:43 +0900559 }
560
561#if defined(OS_WIN)
562 if (!high_resolution_timer_expiration_.is_null()) {
563 if (TimeTicks::Now() > high_resolution_timer_expiration_) {
564 base::Time::ActivateHighResolutionTimer(false);
565 high_resolution_timer_expiration_ = TimeTicks();
566 }
567 }
568#endif
569
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900570 return delayed_run_time;
571}
572
573// Possibly called on a background thread!
574void MessageLoop::AddToIncomingQueue(PendingTask* pending_task) {
erg@google.com67a25432011-01-08 05:23:43 +0900575 // Warning: Don't try to short-circuit, and handle this thread's tasks more
576 // directly, as it could starve handling of foreign threads. Put every task
577 // into this queue.
578
579 scoped_refptr<base::MessagePump> pump;
580 {
brettw@chromium.orgabe477a2011-01-21 13:55:52 +0900581 base::AutoLock locked(incoming_queue_lock_);
erg@google.com67a25432011-01-08 05:23:43 +0900582
583 bool was_empty = incoming_queue_.empty();
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900584 incoming_queue_.push(*pending_task);
585 pending_task->task.Reset();
erg@google.com67a25432011-01-08 05:23:43 +0900586 if (!was_empty)
587 return; // Someone else should have started the sub-pump.
588
589 pump = pump_;
590 }
591 // Since the incoming_queue_ may contain a task that destroys this message
592 // loop, we cannot exit incoming_queue_lock_ until we are done with |this|.
593 // We use a stack-based reference to the message pump so that we can call
594 // ScheduleWork outside of incoming_queue_lock_.
595
596 pump->ScheduleWork();
597}
598
599//------------------------------------------------------------------------------
600// Method and data for histogramming events and actions taken by each instance
601// on each thread.
602
603void MessageLoop::StartHistogrammer() {
jar@chromium.org34571142011-04-05 13:48:53 +0900604 if (enable_histogrammer_ && !message_histogram_
erg@google.com67a25432011-01-08 05:23:43 +0900605 && base::StatisticsRecorder::IsActive()) {
606 DCHECK(!thread_name_.empty());
607 message_histogram_ = base::LinearHistogram::FactoryGet(
608 "MsgLoop:" + thread_name_,
609 kLeastNonZeroMessageId, kMaxMessageId,
610 kNumberOfDistinctMessagesDisplayed,
611 message_histogram_->kHexRangePrintingFlag);
612 message_histogram_->SetRangeDescriptions(event_descriptions_);
613 }
614}
615
616void MessageLoop::HistogramEvent(int event) {
jar@chromium.org34571142011-04-05 13:48:53 +0900617 if (message_histogram_)
erg@google.com67a25432011-01-08 05:23:43 +0900618 message_histogram_->Add(event);
619}
620
darin@google.com981f3552008-08-16 12:09:05 +0900621bool MessageLoop::DoWork() {
darin@google.combe165ae2008-09-07 17:08:29 +0900622 if (!nestable_tasks_allowed_) {
623 // Task can't be executed right now.
624 return false;
625 }
626
627 for (;;) {
628 ReloadWorkQueue();
629 if (work_queue_.empty())
630 break;
631
632 // Execute oldest task.
633 do {
634 PendingTask pending_task = work_queue_.front();
635 work_queue_.pop();
636 if (!pending_task.delayed_run_time.is_null()) {
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900637 AddToDelayedWorkQueue(pending_task);
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900638 // If we changed the topmost task, then it is time to reschedule.
639 if (delayed_work_queue_.top().task.Equals(pending_task.task))
darin@google.combe165ae2008-09-07 17:08:29 +0900640 pump_->ScheduleDelayedWork(pending_task.delayed_run_time);
641 } else {
642 if (DeferOrRunPendingTask(pending_task))
643 return true;
644 }
645 } while (!work_queue_.empty());
646 }
647
648 // Nothing happened.
649 return false;
darin@google.com981f3552008-08-16 12:09:05 +0900650}
651
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900652bool MessageLoop::DoDelayedWork(TimeTicks* next_delayed_work_time) {
jar@chromium.org40355072010-10-21 15:32:33 +0900653 if (!nestable_tasks_allowed_ || delayed_work_queue_.empty()) {
jar@chromium.org9b0fb062010-11-07 07:23:29 +0900654 recent_time_ = *next_delayed_work_time = TimeTicks();
darin@google.combe165ae2008-09-07 17:08:29 +0900655 return false;
656 }
jeremy@chromium.org2ed223c2008-12-09 02:36:06 +0900657
jar@chromium.org9b0fb062010-11-07 07:23:29 +0900658 // When we "fall behind," there will be a lot of tasks in the delayed work
jar@chromium.org94f73832010-11-05 08:23:42 +0900659 // queue that are ready to run. To increase efficiency when we fall behind,
660 // we will only call Time::Now() intermittently, and then process all tasks
661 // that are ready to run before calling it again. As a result, the more we
662 // fall behind (and have a lot of ready-to-run delayed tasks), the more
663 // efficient we'll be at handling the tasks.
jar@chromium.org9b0fb062010-11-07 07:23:29 +0900664
665 TimeTicks next_run_time = delayed_work_queue_.top().delayed_run_time;
jar@chromium.org94f73832010-11-05 08:23:42 +0900666 if (next_run_time > recent_time_) {
jar@chromium.org9b0fb062010-11-07 07:23:29 +0900667 recent_time_ = TimeTicks::Now(); // Get a better view of Now();
jar@chromium.org94f73832010-11-05 08:23:42 +0900668 if (next_run_time > recent_time_) {
669 *next_delayed_work_time = next_run_time;
670 return false;
671 }
darin@google.combe165ae2008-09-07 17:08:29 +0900672 }
darin@google.com981f3552008-08-16 12:09:05 +0900673
jar@chromium.org40355072010-10-21 15:32:33 +0900674 PendingTask pending_task = delayed_work_queue_.top();
675 delayed_work_queue_.pop();
jeremy@chromium.org2ed223c2008-12-09 02:36:06 +0900676
jar@chromium.org40355072010-10-21 15:32:33 +0900677 if (!delayed_work_queue_.empty())
darin@google.combe165ae2008-09-07 17:08:29 +0900678 *next_delayed_work_time = delayed_work_queue_.top().delayed_run_time;
darin@google.com981f3552008-08-16 12:09:05 +0900679
darin@google.combe165ae2008-09-07 17:08:29 +0900680 return DeferOrRunPendingTask(pending_task);
darin@google.com981f3552008-08-16 12:09:05 +0900681}
682
683bool MessageLoop::DoIdleWork() {
684 if (ProcessNextDelayedNonNestableTask())
685 return true;
686
687 if (state_->quit_received)
688 pump_->Quit();
689
690 return false;
691}
692
dcheng@chromium.org36904742011-12-30 13:32:58 +0900693void MessageLoop::DeleteSoonInternal(const tracked_objects::Location& from_here,
694 void(*deleter)(const void*),
695 const void* object) {
696 PostNonNestableTask(from_here, base::Bind(deleter, object));
697}
698
dcheng@chromium.org2116fc92011-12-30 15:46:30 +0900699void MessageLoop::ReleaseSoonInternal(
700 const tracked_objects::Location& from_here,
701 void(*releaser)(const void*),
702 const void* object) {
703 PostNonNestableTask(from_here, base::Bind(releaser, object));
704}
705
darin@google.com981f3552008-08-16 12:09:05 +0900706//------------------------------------------------------------------------------
707// MessageLoop::AutoRunState
708
709MessageLoop::AutoRunState::AutoRunState(MessageLoop* loop) : loop_(loop) {
710 // Make the loop reference us.
711 previous_state_ = loop_->state_;
712 if (previous_state_) {
713 run_depth = previous_state_->run_depth + 1;
darin@google.com6ddeb842008-08-15 16:31:20 +0900714 } else {
darin@google.com981f3552008-08-16 12:09:05 +0900715 run_depth = 1;
darin@google.com6ddeb842008-08-15 16:31:20 +0900716 }
darin@google.com981f3552008-08-16 12:09:05 +0900717 loop_->state_ = this;
718
719 // Initialize the other fields:
720 quit_received = false;
michaelbai@google.com686190b2011-08-03 01:11:16 +0900721#if !defined(OS_MACOSX) && !defined(OS_ANDROID)
darin@google.com981f3552008-08-16 12:09:05 +0900722 dispatcher = NULL;
723#endif
724}
725
726MessageLoop::AutoRunState::~AutoRunState() {
727 loop_->state_ = previous_state_;
darin@google.comee6fa722008-08-13 08:25:43 +0900728}
729
initial.commit3f4a7322008-07-27 06:49:38 +0900730//------------------------------------------------------------------------------
darin@google.comd936b5b2008-08-26 14:53:57 +0900731// MessageLoopForUI
732
733#if defined(OS_WIN)
darin@google.comd936b5b2008-08-26 14:53:57 +0900734void MessageLoopForUI::DidProcessMessage(const MSG& message) {
735 pump_win()->DidProcessMessage(message);
736}
darin@google.comd936b5b2008-08-26 14:53:57 +0900737#endif // defined(OS_WIN)
738
michaelbai@google.com686190b2011-08-03 01:11:16 +0900739#if defined(OS_ANDROID)
740void MessageLoopForUI::Start() {
741 // No Histogram support for UI message loop as it is managed by Java side
742 static_cast<base::MessagePumpForUI*>(pump_.get())->Start(this);
743}
744#endif
745
746#if !defined(OS_MACOSX) && !defined(OS_NACL) && !defined(OS_ANDROID)
jcampan@chromium.org05423582009-08-01 07:53:37 +0900747void MessageLoopForUI::AddObserver(Observer* observer) {
748 pump_ui()->AddObserver(observer);
749}
750
751void MessageLoopForUI::RemoveObserver(Observer* observer) {
752 pump_ui()->RemoveObserver(observer);
753}
754
oshima@google.com08ff65e2011-10-24 16:19:51 +0900755void MessageLoopForUI::RunWithDispatcher(Dispatcher* dispatcher) {
jcampan@chromium.org05423582009-08-01 07:53:37 +0900756 AutoRunState save_state(this);
757 state_->dispatcher = dispatcher;
758 RunHandler();
759}
oshima@google.comc7bc27c2011-10-07 03:19:21 +0900760
761void MessageLoopForUI::RunAllPendingWithDispatcher(Dispatcher* dispatcher) {
762 AutoRunState save_state(this);
763 state_->dispatcher = dispatcher;
764 state_->quit_received = true; // Means run until we would otherwise block.
765 RunHandler();
766}
767
michaelbai@google.com686190b2011-08-03 01:11:16 +0900768#endif // !defined(OS_MACOSX) && !defined(OS_NACL) && !defined(OS_ANDROID)
jcampan@chromium.org05423582009-08-01 07:53:37 +0900769
darin@google.comd936b5b2008-08-26 14:53:57 +0900770//------------------------------------------------------------------------------
771// MessageLoopForIO
772
773#if defined(OS_WIN)
774
rvargas@google.com9e49aa22008-10-10 08:58:43 +0900775void MessageLoopForIO::RegisterIOHandler(HANDLE file, IOHandler* handler) {
776 pump_io()->RegisterIOHandler(file, handler);
777}
778
rvargas@google.com73887542008-11-08 06:52:15 +0900779bool MessageLoopForIO::WaitForIOCompletion(DWORD timeout, IOHandler* filter) {
780 return pump_io()->WaitForIOCompletion(timeout, filter);
rvargas@google.com9e49aa22008-10-10 08:58:43 +0900781}
782
abarth@chromium.org1f1c2172010-12-01 17:45:51 +0900783#elif defined(OS_POSIX) && !defined(OS_NACL)
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900784
jeremy@chromium.orgefc0db02008-12-16 07:02:17 +0900785bool MessageLoopForIO::WatchFileDescriptor(int fd,
786 bool persistent,
787 Mode mode,
788 FileDescriptorWatcher *controller,
789 Watcher *delegate) {
790 return pump_libevent()->WatchFileDescriptor(
791 fd,
792 persistent,
793 static_cast<base::MessagePumpLibevent::Mode>(mode),
794 controller,
795 delegate);
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900796}
797
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900798#endif