blob: cc7faa359fa457e080cef72d8be1ff12ea9c0814 [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"
brettw@chromium.org63965582010-12-31 07:18:56 +090020#include "base/threading/thread_local.h"
mbelshe@chromium.orgbee85b32011-05-16 04:20:49 +090021#include "base/time.h"
ajwong@chromium.org94d2a582011-04-21 01:02:23 +090022#include "base/tracked_objects.h"
initial.commit3f4a7322008-07-27 06:49:38 +090023
mark@chromium.org059d0492008-09-24 06:08:28 +090024#if defined(OS_MACOSX)
25#include "base/message_pump_mac.h"
26#endif
dkegel@google.com9e044ae2008-09-19 03:46:26 +090027#if defined(OS_POSIX)
28#include "base/message_pump_libevent.h"
29#endif
michaelbai@google.com686190b2011-08-03 01:11:16 +090030#if defined(OS_ANDROID)
31#include "base/message_pump_android.h"
32#endif
sadrul@chromium.org847a5722011-09-21 09:17:19 +090033#if defined(TOOLKIT_USES_GTK)
ajwong@chromium.org94d2a582011-04-21 01:02:23 +090034#include <gdk/gdk.h>
35#include <gdk/gdkx.h>
sadrul@chromium.orgf7f3b262011-06-25 05:10:25 +090036#endif // defined(OS_POSIX) && !defined(OS_MACOSX)
dkegel@google.com9e044ae2008-09-19 03:46:26 +090037
jhawkins@chromium.org2af12f22011-11-16 08:36:30 +090038using base::PendingTask;
dsh@google.com0f8dd262008-10-28 05:43:33 +090039using base::TimeDelta;
jar@chromium.org9b0fb062010-11-07 07:23:29 +090040using base::TimeTicks;
dsh@google.com0f8dd262008-10-28 05:43:33 +090041
erg@chromium.orga7528522010-07-16 02:23:23 +090042namespace {
43
deanm@chromium.orgcd1ce302008-09-10 19:54:06 +090044// A lazily created thread local storage for quick access to a thread's message
45// loop, if one exists. This should be safe and free of static constructors.
joth@chromium.orgb24883c2011-11-15 22:31:49 +090046base::LazyInstance<base::ThreadLocalPointer<MessageLoop> > lazy_tls_ptr =
47 LAZY_INSTANCE_INITIALIZER;
initial.commit3f4a7322008-07-27 06:49:38 +090048
initial.commit3f4a7322008-07-27 06:49:38 +090049// Logical events for Histogram profiling. Run with -message-loop-histogrammer
50// to get an accounting of messages and actions taken on each thread.
erg@chromium.orga7528522010-07-16 02:23:23 +090051const int kTaskRunEvent = 0x1;
52const int kTimerEvent = 0x2;
initial.commit3f4a7322008-07-27 06:49:38 +090053
54// Provide range of message IDs for use in histogramming and debug display.
erg@chromium.orga7528522010-07-16 02:23:23 +090055const int kLeastNonZeroMessageId = 1;
56const int kMaxMessageId = 1099;
57const int kNumberOfDistinctMessagesDisplayed = 1100;
58
59// Provide a macro that takes an expression (such as a constant, or macro
60// constant) and creates a pair to initalize an array of pairs. In this case,
61// our pair consists of the expressions value, and the "stringized" version
62// of the expression (i.e., the exrpression put in quotes). For example, if
63// we have:
64// #define FOO 2
65// #define BAR 5
66// then the following:
67// VALUE_TO_NUMBER_AND_NAME(FOO + BAR)
68// will expand to:
69// {7, "FOO + BAR"}
70// We use the resulting array as an argument to our histogram, which reads the
71// number as a bucket identifier, and proceeds to use the corresponding name
72// in the pair (i.e., the quoted string) when printing out a histogram.
73#define VALUE_TO_NUMBER_AND_NAME(name) {name, #name},
74
brettw@chromium.org275c2ec2010-10-14 13:38:38 +090075const base::LinearHistogram::DescriptionPair event_descriptions_[] = {
erg@chromium.orga7528522010-07-16 02:23:23 +090076 // Provide some pretty print capability in our histogram for our internal
77 // messages.
78
79 // A few events we handle (kindred to messages), and used to profile actions.
80 VALUE_TO_NUMBER_AND_NAME(kTaskRunEvent)
81 VALUE_TO_NUMBER_AND_NAME(kTimerEvent)
82
83 {-1, NULL} // The list must be null terminated, per API to histogram.
84};
85
86bool enable_histogrammer_ = false;
87
michaelbai@google.com686190b2011-08-03 01:11:16 +090088MessageLoop::MessagePumpFactory* message_pump_for_ui_factory_ = NULL;
89
erg@chromium.orga7528522010-07-16 02:23:23 +090090} // namespace
initial.commit3f4a7322008-07-27 06:49:38 +090091
92//------------------------------------------------------------------------------
93
darin@google.com981f3552008-08-16 12:09:05 +090094#if defined(OS_WIN)
initial.commit3f4a7322008-07-27 06:49:38 +090095
initial.commit3f4a7322008-07-27 06:49:38 +090096// Upon a SEH exception in this thread, it restores the original unhandled
97// exception filter.
98static int SEHFilter(LPTOP_LEVEL_EXCEPTION_FILTER old_filter) {
99 ::SetUnhandledExceptionFilter(old_filter);
100 return EXCEPTION_CONTINUE_SEARCH;
101}
102
103// Retrieves a pointer to the current unhandled exception filter. There
104// is no standalone getter method.
105static LPTOP_LEVEL_EXCEPTION_FILTER GetTopSEHFilter() {
106 LPTOP_LEVEL_EXCEPTION_FILTER top_filter = NULL;
107 top_filter = ::SetUnhandledExceptionFilter(0);
108 ::SetUnhandledExceptionFilter(top_filter);
109 return top_filter;
110}
111
darin@google.com981f3552008-08-16 12:09:05 +0900112#endif // defined(OS_WIN)
113
initial.commit3f4a7322008-07-27 06:49:38 +0900114//------------------------------------------------------------------------------
115
erg@chromium.org493f5f62010-07-16 06:03:54 +0900116MessageLoop::TaskObserver::TaskObserver() {
117}
118
119MessageLoop::TaskObserver::~TaskObserver() {
120}
121
122MessageLoop::DestructionObserver::~DestructionObserver() {
123}
124
125//------------------------------------------------------------------------------
126
darin@google.comd936b5b2008-08-26 14:53:57 +0900127MessageLoop::MessageLoop(Type type)
128 : type_(type),
darin@google.comee6fa722008-08-13 08:25:43 +0900129 nestable_tasks_allowed_(true),
darin@google.com12d40bb2008-08-20 03:36:23 +0900130 exception_restoration_(false),
jar@chromium.org34571142011-04-05 13:48:53 +0900131 message_histogram_(NULL),
darin@google.combe165ae2008-09-07 17:08:29 +0900132 state_(NULL),
ananta@chromium.orgc542fec2011-03-24 12:40:28 +0900133#ifdef OS_WIN
134 os_modal_loop_(false),
135#endif // OS_WIN
darin@google.combe165ae2008-09-07 17:08:29 +0900136 next_sequence_num_(0) {
deanm@chromium.orgcd1ce302008-09-10 19:54:06 +0900137 DCHECK(!current()) << "should only have one message loop per thread";
138 lazy_tls_ptr.Pointer()->Set(this);
darin@google.comd936b5b2008-08-26 14:53:57 +0900139
nduca@chromium.orgba048612011-08-16 05:33:46 +0900140 message_loop_proxy_ = new base::MessageLoopProxyImpl();
141
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900142// TODO(rvargas): Get rid of the OS guards.
darin@google.com981f3552008-08-16 12:09:05 +0900143#if defined(OS_WIN)
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900144#define MESSAGE_PUMP_UI new base::MessagePumpForUI()
145#define MESSAGE_PUMP_IO new base::MessagePumpForIO()
146#elif defined(OS_MACOSX)
147#define MESSAGE_PUMP_UI base::MessagePumpMac::Create()
148#define MESSAGE_PUMP_IO new base::MessagePumpLibevent()
abarth@chromium.org1f1c2172010-12-01 17:45:51 +0900149#elif defined(OS_NACL)
150// Currently NaCl doesn't have a UI or an IO MessageLoop.
151// TODO(abarth): Figure out if we need these.
152#define MESSAGE_PUMP_UI NULL
153#define MESSAGE_PUMP_IO NULL
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900154#elif defined(OS_POSIX) // POSIX but not MACOSX.
piman@chromium.orgbfd272d2011-12-15 01:34:31 +0900155#define MESSAGE_PUMP_UI new base::MessagePumpForUI()
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900156#define MESSAGE_PUMP_IO new base::MessagePumpLibevent()
evan@chromium.org875bb6e2009-12-29 09:32:52 +0900157#else
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900158#error Not implemented
evan@chromium.org875bb6e2009-12-29 09:32:52 +0900159#endif
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900160
161 if (type_ == TYPE_UI) {
michaelbai@google.com686190b2011-08-03 01:11:16 +0900162 if (message_pump_for_ui_factory_)
163 pump_ = message_pump_for_ui_factory_();
164 else
165 pump_ = MESSAGE_PUMP_UI;
dsh@google.com119a2522008-10-04 01:52:59 +0900166 } else if (type_ == TYPE_IO) {
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900167 pump_ = MESSAGE_PUMP_IO;
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900168 } else {
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900169 DCHECK_EQ(TYPE_DEFAULT, type_);
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900170 pump_ = new base::MessagePumpDefault();
171 }
initial.commit3f4a7322008-07-27 06:49:38 +0900172}
173
174MessageLoop::~MessageLoop() {
thestig@chromium.org226880a2010-11-11 05:28:06 +0900175 DCHECK_EQ(this, current());
darin@google.com965e5342008-08-06 08:16:41 +0900176
darin@google.com0e500502008-09-09 14:55:35 +0900177 DCHECK(!state_);
178
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900179 // Clean up any unprocessed tasks, but take care: deleting a task could
180 // result in the addition of more tasks (e.g., via DeleteSoon). We set a
181 // limit on the number of times we will allow a deleted task to generate more
182 // tasks. Normally, we should only pass through this loop once or twice. If
183 // we end up hitting the loop limit, then it is probably due to one task that
184 // is being stubborn. Inspect the queues to see who is left.
185 bool did_work;
186 for (int i = 0; i < 100; ++i) {
187 DeletePendingTasks();
188 ReloadWorkQueue();
189 // If we end up with empty queues, then break out of the loop.
190 did_work = DeletePendingTasks();
191 if (!did_work)
192 break;
darin@google.com0e500502008-09-09 14:55:35 +0900193 }
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900194 DCHECK(!did_work);
195
sanjeevr@chromium.org03b44d52010-11-30 09:25:29 +0900196 // Let interested parties have one last shot at accessing this.
197 FOR_EACH_OBSERVER(DestructionObserver, destruction_observers_,
198 WillDestroyCurrentMessageLoop());
199
nduca@chromium.orgba048612011-08-16 05:33:46 +0900200 // Tell the message_loop_proxy that we are dying.
201 static_cast<base::MessageLoopProxyImpl*>(message_loop_proxy_.get())->
202 WillDestroyCurrentMessageLoop();
203 message_loop_proxy_ = NULL;
204
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900205 // OK, now make it so that no one can find us.
deanm@chromium.orge4cc5922008-09-10 20:14:56 +0900206 lazy_tls_ptr.Pointer()->Set(NULL);
mbelshe@chromium.orgbee85b32011-05-16 04:20:49 +0900207
208#if defined(OS_WIN)
209 // If we left the high-resolution timer activated, deactivate it now.
210 // Doing this is not-critical, it is mainly to make sure we track
211 // the high resolution timer activations properly in our unit tests.
212 if (!high_resolution_timer_expiration_.is_null()) {
213 base::Time::ActivateHighResolutionTimer(false);
214 high_resolution_timer_expiration_ = base::TimeTicks();
215 }
216#endif
initial.commit3f4a7322008-07-27 06:49:38 +0900217}
218
erg@google.com67a25432011-01-08 05:23:43 +0900219// static
220MessageLoop* MessageLoop::current() {
221 // TODO(darin): sadly, we cannot enable this yet since people call us even
222 // when they have no intention of using us.
223 // DCHECK(loop) << "Ouch, did you forget to initialize me?";
224 return lazy_tls_ptr.Pointer()->Get();
225}
226
227// static
228void MessageLoop::EnableHistogrammer(bool enable) {
229 enable_histogrammer_ = enable;
230}
231
michaelbai@google.com686190b2011-08-03 01:11:16 +0900232// static
233void MessageLoop::InitMessagePumpForUIFactory(MessagePumpFactory* factory) {
234 DCHECK(!message_pump_for_ui_factory_);
235 message_pump_for_ui_factory_ = factory;
236}
237
sky@chromium.org18c66dc2010-09-16 07:14:36 +0900238void MessageLoop::AddDestructionObserver(
239 DestructionObserver* destruction_observer) {
thestig@chromium.org226880a2010-11-11 05:28:06 +0900240 DCHECK_EQ(this, current());
sky@chromium.org18c66dc2010-09-16 07:14:36 +0900241 destruction_observers_.AddObserver(destruction_observer);
darin@google.com965e5342008-08-06 08:16:41 +0900242}
243
sky@chromium.org18c66dc2010-09-16 07:14:36 +0900244void MessageLoop::RemoveDestructionObserver(
245 DestructionObserver* destruction_observer) {
thestig@chromium.org226880a2010-11-11 05:28:06 +0900246 DCHECK_EQ(this, current());
sky@chromium.org18c66dc2010-09-16 07:14:36 +0900247 destruction_observers_.RemoveObserver(destruction_observer);
darin@google.com965e5342008-08-06 08:16:41 +0900248}
249
darin@google.combe165ae2008-09-07 17:08:29 +0900250void MessageLoop::PostTask(
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900251 const tracked_objects::Location& from_here, const base::Closure& task) {
brettw@chromium.org5faed3c2011-10-27 06:48:00 +0900252 DCHECK(!task.is_null()) << from_here.ToString();
jhawkins@chromium.org2af12f22011-11-16 08:36:30 +0900253 PendingTask pending_task(from_here, task, CalculateDelayedRuntime(0), true);
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900254 AddToIncomingQueue(&pending_task);
255}
256
257void MessageLoop::PostDelayedTask(
tedvessenes@gmail.com658a87f2011-12-30 10:04:36 +0900258 const tracked_objects::Location& from_here,
259 const base::Closure& task,
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900260 int64 delay_ms) {
brettw@chromium.org5faed3c2011-10-27 06:48:00 +0900261 DCHECK(!task.is_null()) << from_here.ToString();
jhawkins@chromium.org2af12f22011-11-16 08:36:30 +0900262 PendingTask pending_task(from_here, task,
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900263 CalculateDelayedRuntime(delay_ms), true);
264 AddToIncomingQueue(&pending_task);
265}
266
tedvessenes@gmail.com658a87f2011-12-30 10:04:36 +0900267void MessageLoop::PostDelayedTask(
268 const tracked_objects::Location& from_here,
269 const base::Closure& task,
270 base::TimeDelta delay) {
271 PostDelayedTask(from_here, task, delay.InMillisecondsRoundedUp());
272}
273
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900274void MessageLoop::PostNonNestableTask(
275 const tracked_objects::Location& from_here, const base::Closure& task) {
brettw@chromium.org5faed3c2011-10-27 06:48:00 +0900276 DCHECK(!task.is_null()) << from_here.ToString();
jhawkins@chromium.org2af12f22011-11-16 08:36:30 +0900277 PendingTask pending_task(from_here, task, CalculateDelayedRuntime(0), false);
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900278 AddToIncomingQueue(&pending_task);
279}
280
281void MessageLoop::PostNonNestableDelayedTask(
282 const tracked_objects::Location& from_here, const base::Closure& task,
283 int64 delay_ms) {
brettw@chromium.org5faed3c2011-10-27 06:48:00 +0900284 DCHECK(!task.is_null()) << from_here.ToString();
jhawkins@chromium.org2af12f22011-11-16 08:36:30 +0900285 PendingTask pending_task(from_here, task,
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900286 CalculateDelayedRuntime(delay_ms), false);
287 AddToIncomingQueue(&pending_task);
darin@google.combe165ae2008-09-07 17:08:29 +0900288}
289
tedvessenes@gmail.com658a87f2011-12-30 10:04:36 +0900290void MessageLoop::PostNonNestableDelayedTask(
291 const tracked_objects::Location& from_here,
292 const base::Closure& task,
293 base::TimeDelta delay) {
294 PostNonNestableDelayedTask(from_here, task, delay.InMillisecondsRoundedUp());
295}
296
erg@google.com67a25432011-01-08 05:23:43 +0900297void MessageLoop::Run() {
298 AutoRunState save_state(this);
299 RunHandler();
300}
darin@google.com0795f572008-08-30 09:22:48 +0900301
erg@google.com67a25432011-01-08 05:23:43 +0900302void MessageLoop::RunAllPending() {
303 AutoRunState save_state(this);
304 state_->quit_received = true; // Means run until we would otherwise block.
305 RunHandler();
306}
darin@google.com0795f572008-08-30 09:22:48 +0900307
erg@google.com67a25432011-01-08 05:23:43 +0900308void MessageLoop::Quit() {
309 DCHECK_EQ(this, current());
310 if (state_) {
311 state_->quit_received = true;
darin@google.com0795f572008-08-30 09:22:48 +0900312 } else {
erg@google.com67a25432011-01-08 05:23:43 +0900313 NOTREACHED() << "Must be inside Run to call Quit";
darin@google.com0795f572008-08-30 09:22:48 +0900314 }
erg@google.com67a25432011-01-08 05:23:43 +0900315}
darin@google.com0795f572008-08-30 09:22:48 +0900316
erg@google.com67a25432011-01-08 05:23:43 +0900317void MessageLoop::QuitNow() {
318 DCHECK_EQ(this, current());
319 if (state_) {
320 pump_->Quit();
321 } else {
322 NOTREACHED() << "Must be inside Run to call Quit";
mbelshe@chromium.orgde50b7d2010-06-29 13:58:15 +0900323 }
initial.commit3f4a7322008-07-27 06:49:38 +0900324}
325
kalman@chromium.orgc89ed902011-10-21 15:21:57 +0900326static void QuitCurrent() {
327 MessageLoop::current()->Quit();
328}
329
jhawkins@chromium.org573d4182011-10-17 10:20:36 +0900330// static
331base::Closure MessageLoop::QuitClosure() {
kalman@chromium.orgc89ed902011-10-21 15:21:57 +0900332 return base::Bind(&QuitCurrent);
jhawkins@chromium.org573d4182011-10-17 10:20:36 +0900333}
334
initial.commit3f4a7322008-07-27 06:49:38 +0900335void MessageLoop::SetNestableTasksAllowed(bool allowed) {
mpcomplete@google.com989d5f82008-08-09 09:14:09 +0900336 if (nestable_tasks_allowed_ != allowed) {
337 nestable_tasks_allowed_ = allowed;
338 if (!nestable_tasks_allowed_)
339 return;
340 // Start the native pump if we are not already pumping.
darin@google.com981f3552008-08-16 12:09:05 +0900341 pump_->ScheduleWork();
mpcomplete@google.com989d5f82008-08-09 09:14:09 +0900342 }
initial.commit3f4a7322008-07-27 06:49:38 +0900343}
344
345bool MessageLoop::NestableTasksAllowed() const {
346 return nestable_tasks_allowed_;
347}
348
jcampan@chromium.orgeac57172009-07-02 04:53:59 +0900349bool MessageLoop::IsNested() {
350 return state_->run_depth > 1;
351}
352
erg@google.com67a25432011-01-08 05:23:43 +0900353void MessageLoop::AddTaskObserver(TaskObserver* task_observer) {
354 DCHECK_EQ(this, current());
355 task_observers_.AddObserver(task_observer);
356}
357
358void MessageLoop::RemoveTaskObserver(TaskObserver* task_observer) {
359 DCHECK_EQ(this, current());
360 task_observers_.RemoveObserver(task_observer);
361}
362
willchan@chromium.org3a397672011-01-26 09:53:48 +0900363void MessageLoop::AssertIdle() const {
364 // We only check |incoming_queue_|, since we don't want to lock |work_queue_|.
365 base::AutoLock lock(incoming_queue_lock_);
366 DCHECK(incoming_queue_.empty());
367}
368
willchan@chromium.orgfe2201e2011-11-02 07:06:58 +0900369bool MessageLoop::is_running() const {
370 DCHECK_EQ(this, current());
371 return state_ != NULL;
372}
373
initial.commit3f4a7322008-07-27 06:49:38 +0900374//------------------------------------------------------------------------------
initial.commit3f4a7322008-07-27 06:49:38 +0900375
erg@google.com67a25432011-01-08 05:23:43 +0900376// Runs the loop in two different SEH modes:
377// enable_SEH_restoration_ = false : any unhandled exception goes to the last
378// one that calls SetUnhandledExceptionFilter().
379// enable_SEH_restoration_ = true : any unhandled exception goes to the filter
380// that was existed before the loop was run.
381void MessageLoop::RunHandler() {
382#if defined(OS_WIN)
383 if (exception_restoration_) {
384 RunInternalInSEHFrame();
385 return;
386 }
387#endif
388
389 RunInternal();
390}
391
392#if defined(OS_WIN)
393__declspec(noinline) void MessageLoop::RunInternalInSEHFrame() {
394 LPTOP_LEVEL_EXCEPTION_FILTER current_filter = GetTopSEHFilter();
395 __try {
396 RunInternal();
397 } __except(SEHFilter(current_filter)) {
398 }
399 return;
400}
401#endif
402
403void MessageLoop::RunInternal() {
404 DCHECK_EQ(this, current());
405
406 StartHistogrammer();
407
michaelbai@google.com686190b2011-08-03 01:11:16 +0900408#if !defined(OS_MACOSX) && !defined(OS_ANDROID)
erg@google.com67a25432011-01-08 05:23:43 +0900409 if (state_->dispatcher && type() == TYPE_UI) {
410 static_cast<base::MessagePumpForUI*>(pump_.get())->
411 RunWithDispatcher(this, state_->dispatcher);
412 return;
413 }
414#endif
415
416 pump_->Run(this);
417}
418
419bool MessageLoop::ProcessNextDelayedNonNestableTask() {
420 if (state_->run_depth != 1)
421 return false;
422
423 if (deferred_non_nestable_work_queue_.empty())
424 return false;
425
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900426 PendingTask pending_task = deferred_non_nestable_work_queue_.front();
erg@google.com67a25432011-01-08 05:23:43 +0900427 deferred_non_nestable_work_queue_.pop();
428
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900429 RunTask(pending_task);
erg@google.com67a25432011-01-08 05:23:43 +0900430 return true;
431}
432
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900433void MessageLoop::RunTask(const PendingTask& pending_task) {
jbates@chromium.org5a97c212012-02-24 04:16:35 +0900434 TRACE_EVENT2("task", "MessageLoop::RunTask",
435 "src_file", pending_task.posted_from.file_name(),
436 "src_func", pending_task.posted_from.function_name());
initial.commit3f4a7322008-07-27 06:49:38 +0900437 DCHECK(nestable_tasks_allowed_);
438 // Execute the task and assume the worst: It is probably not reentrant.
439 nestable_tasks_allowed_ = false;
darin@google.combe165ae2008-09-07 17:08:29 +0900440
apatrick@chromium.org87164042011-05-20 07:28:25 +0900441 // Before running the task, store the program counter where it was posted
442 // and deliberately alias it to ensure it is on the stack if the task
443 // crashes. Be careful not to assume that the variable itself will have the
444 // expected value when displayed by the optimizer in an optimized build.
445 // Look at a memory dump of the stack.
jbates@chromium.orgb84db522011-10-04 02:51:25 +0900446 const void* program_counter =
447 pending_task.posted_from.program_counter();
apatrick@chromium.org87164042011-05-20 07:28:25 +0900448 base::debug::Alias(&program_counter);
449
darin@google.combe165ae2008-09-07 17:08:29 +0900450 HistogramEvent(kTaskRunEvent);
jar@chromium.org79a58c32011-10-16 08:52:45 +0900451
jar@chromium.orgb536eef2011-11-14 14:24:07 +0900452 tracked_objects::TrackedTime start_time =
jar@chromium.orgb5c974b2011-12-14 10:36:48 +0900453 tracked_objects::ThreadData::NowForStartOfRun(pending_task.birth_tally);
jar@chromium.org79a58c32011-10-16 08:52:45 +0900454
willchan@chromium.orga9047632010-06-10 06:20:41 +0900455 FOR_EACH_OBSERVER(TaskObserver, task_observers_,
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900456 WillProcessTask(pending_task.time_posted));
457 pending_task.task.Run();
458 FOR_EACH_OBSERVER(TaskObserver, task_observers_,
459 DidProcessTask(pending_task.time_posted));
jar@chromium.org4be2cb02011-11-01 07:36:21 +0900460
461 tracked_objects::ThreadData::TallyRunOnNamedThreadIfTracking(pending_task,
jar@chromium.orgb536eef2011-11-14 14:24:07 +0900462 start_time, tracked_objects::ThreadData::NowForEndOfRun());
darin@google.combe165ae2008-09-07 17:08:29 +0900463
464 nestable_tasks_allowed_ = true;
initial.commit3f4a7322008-07-27 06:49:38 +0900465}
466
jar@chromium.org79a58c32011-10-16 08:52:45 +0900467bool MessageLoop::DeferOrRunPendingTask(const PendingTask& pending_task) {
darin@google.combe165ae2008-09-07 17:08:29 +0900468 if (pending_task.nestable || state_->run_depth == 1) {
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900469 RunTask(pending_task);
darin@google.combe165ae2008-09-07 17:08:29 +0900470 // Show that we ran a task (Note: a new one might arrive as a
471 // consequence!).
472 return true;
473 }
474
475 // We couldn't run the task now because we're in a nested message loop
476 // and the task isn't nestable.
477 deferred_non_nestable_work_queue_.push(pending_task);
478 return false;
initial.commit3f4a7322008-07-27 06:49:38 +0900479}
480
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900481void MessageLoop::AddToDelayedWorkQueue(const PendingTask& pending_task) {
482 // Move to the delayed work queue. Initialize the sequence number
483 // before inserting into the delayed_work_queue_. The sequence number
484 // is used to faciliate FIFO sorting when two tasks have the same
485 // delayed_run_time value.
486 PendingTask new_pending_task(pending_task);
487 new_pending_task.sequence_num = next_sequence_num_++;
488 delayed_work_queue_.push(new_pending_task);
489}
490
initial.commit3f4a7322008-07-27 06:49:38 +0900491void MessageLoop::ReloadWorkQueue() {
492 // We can improve performance of our loading tasks from incoming_queue_ to
darin@google.com981f3552008-08-16 12:09:05 +0900493 // work_queue_ by waiting until the last minute (work_queue_ is empty) to
494 // load. That reduces the number of locks-per-task significantly when our
darin@google.combe165ae2008-09-07 17:08:29 +0900495 // queues get large.
496 if (!work_queue_.empty())
initial.commit3f4a7322008-07-27 06:49:38 +0900497 return; // Wait till we *really* need to lock and load.
498
499 // Acquire all we can from the inter-thread queue with one lock acquisition.
initial.commit3f4a7322008-07-27 06:49:38 +0900500 {
brettw@chromium.orgabe477a2011-01-21 13:55:52 +0900501 base::AutoLock lock(incoming_queue_lock_);
darin@google.combe165ae2008-09-07 17:08:29 +0900502 if (incoming_queue_.empty())
initial.commit3f4a7322008-07-27 06:49:38 +0900503 return;
darin@chromium.orgb80ef1a2009-09-03 05:05:21 +0900504 incoming_queue_.Swap(&work_queue_); // Constant time
darin@google.combe165ae2008-09-07 17:08:29 +0900505 DCHECK(incoming_queue_.empty());
initial.commit3f4a7322008-07-27 06:49:38 +0900506 }
507}
508
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900509bool MessageLoop::DeletePendingTasks() {
510 bool did_work = !work_queue_.empty();
511 while (!work_queue_.empty()) {
512 PendingTask pending_task = work_queue_.front();
513 work_queue_.pop();
514 if (!pending_task.delayed_run_time.is_null()) {
515 // We want to delete delayed tasks in the same order in which they would
516 // normally be deleted in case of any funny dependencies between delayed
517 // tasks.
518 AddToDelayedWorkQueue(pending_task);
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900519 }
initial.commit3f4a7322008-07-27 06:49:38 +0900520 }
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900521 did_work |= !deferred_non_nestable_work_queue_.empty();
522 while (!deferred_non_nestable_work_queue_.empty()) {
jar@chromium.org2fa6b4b2009-03-12 04:53:50 +0900523 deferred_non_nestable_work_queue_.pop();
initial.commit3f4a7322008-07-27 06:49:38 +0900524 }
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900525 did_work |= !delayed_work_queue_.empty();
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900526
527 // Historically, we always delete the task regardless of valgrind status. It's
528 // not completely clear why we want to leak them in the loops above. This
529 // code is replicating legacy behavior, and should not be considered
530 // absolutely "correct" behavior. See TODO above about deleting all tasks
531 // when it's safe.
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900532 while (!delayed_work_queue_.empty()) {
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900533 delayed_work_queue_.pop();
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900534 }
535 return did_work;
initial.commit3f4a7322008-07-27 06:49:38 +0900536}
537
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900538TimeTicks MessageLoop::CalculateDelayedRuntime(int64 delay_ms) {
539 TimeTicks delayed_run_time;
erg@google.com67a25432011-01-08 05:23:43 +0900540 if (delay_ms > 0) {
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900541 delayed_run_time =
erg@google.com67a25432011-01-08 05:23:43 +0900542 TimeTicks::Now() + TimeDelta::FromMilliseconds(delay_ms);
543
544#if defined(OS_WIN)
545 if (high_resolution_timer_expiration_.is_null()) {
546 // Windows timers are granular to 15.6ms. If we only set high-res
547 // timers for those under 15.6ms, then a 18ms timer ticks at ~32ms,
548 // which as a percentage is pretty inaccurate. So enable high
549 // res timers for any timer which is within 2x of the granularity.
550 // This is a tradeoff between accuracy and power management.
551 bool needs_high_res_timers =
552 delay_ms < (2 * base::Time::kMinLowResolutionThresholdMs);
553 if (needs_high_res_timers) {
mbelshe@chromium.orgbee85b32011-05-16 04:20:49 +0900554 if (base::Time::ActivateHighResolutionTimer(true)) {
555 high_resolution_timer_expiration_ = TimeTicks::Now() +
556 TimeDelta::FromMilliseconds(kHighResolutionTimerModeLeaseTimeMs);
557 }
erg@google.com67a25432011-01-08 05:23:43 +0900558 }
559 }
560#endif
561 } else {
562 DCHECK_EQ(delay_ms, 0) << "delay should not be negative";
563 }
564
565#if defined(OS_WIN)
566 if (!high_resolution_timer_expiration_.is_null()) {
567 if (TimeTicks::Now() > high_resolution_timer_expiration_) {
568 base::Time::ActivateHighResolutionTimer(false);
569 high_resolution_timer_expiration_ = TimeTicks();
570 }
571 }
572#endif
573
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900574 return delayed_run_time;
575}
576
577// Possibly called on a background thread!
578void MessageLoop::AddToIncomingQueue(PendingTask* pending_task) {
erg@google.com67a25432011-01-08 05:23:43 +0900579 // Warning: Don't try to short-circuit, and handle this thread's tasks more
580 // directly, as it could starve handling of foreign threads. Put every task
581 // into this queue.
582
583 scoped_refptr<base::MessagePump> pump;
584 {
brettw@chromium.orgabe477a2011-01-21 13:55:52 +0900585 base::AutoLock locked(incoming_queue_lock_);
erg@google.com67a25432011-01-08 05:23:43 +0900586
587 bool was_empty = incoming_queue_.empty();
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900588 incoming_queue_.push(*pending_task);
589 pending_task->task.Reset();
erg@google.com67a25432011-01-08 05:23:43 +0900590 if (!was_empty)
591 return; // Someone else should have started the sub-pump.
592
593 pump = pump_;
594 }
595 // Since the incoming_queue_ may contain a task that destroys this message
596 // loop, we cannot exit incoming_queue_lock_ until we are done with |this|.
597 // We use a stack-based reference to the message pump so that we can call
598 // ScheduleWork outside of incoming_queue_lock_.
599
600 pump->ScheduleWork();
601}
602
603//------------------------------------------------------------------------------
604// Method and data for histogramming events and actions taken by each instance
605// on each thread.
606
607void MessageLoop::StartHistogrammer() {
jar@chromium.org34571142011-04-05 13:48:53 +0900608 if (enable_histogrammer_ && !message_histogram_
erg@google.com67a25432011-01-08 05:23:43 +0900609 && base::StatisticsRecorder::IsActive()) {
610 DCHECK(!thread_name_.empty());
611 message_histogram_ = base::LinearHistogram::FactoryGet(
612 "MsgLoop:" + thread_name_,
613 kLeastNonZeroMessageId, kMaxMessageId,
614 kNumberOfDistinctMessagesDisplayed,
615 message_histogram_->kHexRangePrintingFlag);
616 message_histogram_->SetRangeDescriptions(event_descriptions_);
617 }
618}
619
620void MessageLoop::HistogramEvent(int event) {
jar@chromium.org34571142011-04-05 13:48:53 +0900621 if (message_histogram_)
erg@google.com67a25432011-01-08 05:23:43 +0900622 message_histogram_->Add(event);
623}
624
darin@google.com981f3552008-08-16 12:09:05 +0900625bool MessageLoop::DoWork() {
darin@google.combe165ae2008-09-07 17:08:29 +0900626 if (!nestable_tasks_allowed_) {
627 // Task can't be executed right now.
628 return false;
629 }
630
631 for (;;) {
632 ReloadWorkQueue();
633 if (work_queue_.empty())
634 break;
635
636 // Execute oldest task.
637 do {
638 PendingTask pending_task = work_queue_.front();
639 work_queue_.pop();
640 if (!pending_task.delayed_run_time.is_null()) {
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900641 AddToDelayedWorkQueue(pending_task);
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900642 // If we changed the topmost task, then it is time to reschedule.
643 if (delayed_work_queue_.top().task.Equals(pending_task.task))
darin@google.combe165ae2008-09-07 17:08:29 +0900644 pump_->ScheduleDelayedWork(pending_task.delayed_run_time);
645 } else {
646 if (DeferOrRunPendingTask(pending_task))
647 return true;
648 }
649 } while (!work_queue_.empty());
650 }
651
652 // Nothing happened.
653 return false;
darin@google.com981f3552008-08-16 12:09:05 +0900654}
655
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900656bool MessageLoop::DoDelayedWork(TimeTicks* next_delayed_work_time) {
jar@chromium.org40355072010-10-21 15:32:33 +0900657 if (!nestable_tasks_allowed_ || delayed_work_queue_.empty()) {
jar@chromium.org9b0fb062010-11-07 07:23:29 +0900658 recent_time_ = *next_delayed_work_time = TimeTicks();
darin@google.combe165ae2008-09-07 17:08:29 +0900659 return false;
660 }
jeremy@chromium.org2ed223c2008-12-09 02:36:06 +0900661
jar@chromium.org9b0fb062010-11-07 07:23:29 +0900662 // When we "fall behind," there will be a lot of tasks in the delayed work
jar@chromium.org94f73832010-11-05 08:23:42 +0900663 // queue that are ready to run. To increase efficiency when we fall behind,
664 // we will only call Time::Now() intermittently, and then process all tasks
665 // that are ready to run before calling it again. As a result, the more we
666 // fall behind (and have a lot of ready-to-run delayed tasks), the more
667 // efficient we'll be at handling the tasks.
jar@chromium.org9b0fb062010-11-07 07:23:29 +0900668
669 TimeTicks next_run_time = delayed_work_queue_.top().delayed_run_time;
jar@chromium.org94f73832010-11-05 08:23:42 +0900670 if (next_run_time > recent_time_) {
jar@chromium.org9b0fb062010-11-07 07:23:29 +0900671 recent_time_ = TimeTicks::Now(); // Get a better view of Now();
jar@chromium.org94f73832010-11-05 08:23:42 +0900672 if (next_run_time > recent_time_) {
673 *next_delayed_work_time = next_run_time;
674 return false;
675 }
darin@google.combe165ae2008-09-07 17:08:29 +0900676 }
darin@google.com981f3552008-08-16 12:09:05 +0900677
jar@chromium.org40355072010-10-21 15:32:33 +0900678 PendingTask pending_task = delayed_work_queue_.top();
679 delayed_work_queue_.pop();
jeremy@chromium.org2ed223c2008-12-09 02:36:06 +0900680
jar@chromium.org40355072010-10-21 15:32:33 +0900681 if (!delayed_work_queue_.empty())
darin@google.combe165ae2008-09-07 17:08:29 +0900682 *next_delayed_work_time = delayed_work_queue_.top().delayed_run_time;
darin@google.com981f3552008-08-16 12:09:05 +0900683
darin@google.combe165ae2008-09-07 17:08:29 +0900684 return DeferOrRunPendingTask(pending_task);
darin@google.com981f3552008-08-16 12:09:05 +0900685}
686
687bool MessageLoop::DoIdleWork() {
688 if (ProcessNextDelayedNonNestableTask())
689 return true;
690
691 if (state_->quit_received)
692 pump_->Quit();
693
694 return false;
695}
696
dcheng@chromium.org36904742011-12-30 13:32:58 +0900697void MessageLoop::DeleteSoonInternal(const tracked_objects::Location& from_here,
698 void(*deleter)(const void*),
699 const void* object) {
700 PostNonNestableTask(from_here, base::Bind(deleter, object));
701}
702
dcheng@chromium.org2116fc92011-12-30 15:46:30 +0900703void MessageLoop::ReleaseSoonInternal(
704 const tracked_objects::Location& from_here,
705 void(*releaser)(const void*),
706 const void* object) {
707 PostNonNestableTask(from_here, base::Bind(releaser, object));
708}
709
darin@google.com981f3552008-08-16 12:09:05 +0900710//------------------------------------------------------------------------------
711// MessageLoop::AutoRunState
712
713MessageLoop::AutoRunState::AutoRunState(MessageLoop* loop) : loop_(loop) {
714 // Make the loop reference us.
715 previous_state_ = loop_->state_;
716 if (previous_state_) {
717 run_depth = previous_state_->run_depth + 1;
darin@google.com6ddeb842008-08-15 16:31:20 +0900718 } else {
darin@google.com981f3552008-08-16 12:09:05 +0900719 run_depth = 1;
darin@google.com6ddeb842008-08-15 16:31:20 +0900720 }
darin@google.com981f3552008-08-16 12:09:05 +0900721 loop_->state_ = this;
722
723 // Initialize the other fields:
724 quit_received = false;
michaelbai@google.com686190b2011-08-03 01:11:16 +0900725#if !defined(OS_MACOSX) && !defined(OS_ANDROID)
darin@google.com981f3552008-08-16 12:09:05 +0900726 dispatcher = NULL;
727#endif
728}
729
730MessageLoop::AutoRunState::~AutoRunState() {
731 loop_->state_ = previous_state_;
darin@google.comee6fa722008-08-13 08:25:43 +0900732}
733
initial.commit3f4a7322008-07-27 06:49:38 +0900734//------------------------------------------------------------------------------
darin@google.comd936b5b2008-08-26 14:53:57 +0900735// MessageLoopForUI
736
737#if defined(OS_WIN)
darin@google.comd936b5b2008-08-26 14:53:57 +0900738void MessageLoopForUI::DidProcessMessage(const MSG& message) {
739 pump_win()->DidProcessMessage(message);
740}
darin@google.comd936b5b2008-08-26 14:53:57 +0900741#endif // defined(OS_WIN)
742
michaelbai@google.com686190b2011-08-03 01:11:16 +0900743#if defined(OS_ANDROID)
744void MessageLoopForUI::Start() {
745 // No Histogram support for UI message loop as it is managed by Java side
746 static_cast<base::MessagePumpForUI*>(pump_.get())->Start(this);
747}
748#endif
749
750#if !defined(OS_MACOSX) && !defined(OS_NACL) && !defined(OS_ANDROID)
jcampan@chromium.org05423582009-08-01 07:53:37 +0900751void MessageLoopForUI::AddObserver(Observer* observer) {
752 pump_ui()->AddObserver(observer);
753}
754
755void MessageLoopForUI::RemoveObserver(Observer* observer) {
756 pump_ui()->RemoveObserver(observer);
757}
758
oshima@google.com08ff65e2011-10-24 16:19:51 +0900759void MessageLoopForUI::RunWithDispatcher(Dispatcher* dispatcher) {
jcampan@chromium.org05423582009-08-01 07:53:37 +0900760 AutoRunState save_state(this);
761 state_->dispatcher = dispatcher;
762 RunHandler();
763}
oshima@google.comc7bc27c2011-10-07 03:19:21 +0900764
765void MessageLoopForUI::RunAllPendingWithDispatcher(Dispatcher* dispatcher) {
766 AutoRunState save_state(this);
767 state_->dispatcher = dispatcher;
768 state_->quit_received = true; // Means run until we would otherwise block.
769 RunHandler();
770}
771
michaelbai@google.com686190b2011-08-03 01:11:16 +0900772#endif // !defined(OS_MACOSX) && !defined(OS_NACL) && !defined(OS_ANDROID)
jcampan@chromium.org05423582009-08-01 07:53:37 +0900773
darin@google.comd936b5b2008-08-26 14:53:57 +0900774//------------------------------------------------------------------------------
775// MessageLoopForIO
776
777#if defined(OS_WIN)
778
rvargas@google.com9e49aa22008-10-10 08:58:43 +0900779void MessageLoopForIO::RegisterIOHandler(HANDLE file, IOHandler* handler) {
780 pump_io()->RegisterIOHandler(file, handler);
781}
782
rvargas@google.com73887542008-11-08 06:52:15 +0900783bool MessageLoopForIO::WaitForIOCompletion(DWORD timeout, IOHandler* filter) {
784 return pump_io()->WaitForIOCompletion(timeout, filter);
rvargas@google.com9e49aa22008-10-10 08:58:43 +0900785}
786
abarth@chromium.org1f1c2172010-12-01 17:45:51 +0900787#elif defined(OS_POSIX) && !defined(OS_NACL)
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900788
jeremy@chromium.orgefc0db02008-12-16 07:02:17 +0900789bool MessageLoopForIO::WatchFileDescriptor(int fd,
790 bool persistent,
791 Mode mode,
792 FileDescriptorWatcher *controller,
793 Watcher *delegate) {
794 return pump_libevent()->WatchFileDescriptor(
795 fd,
796 persistent,
797 static_cast<base::MessagePumpLibevent::Mode>(mode),
798 controller,
799 delegate);
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900800}
801
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900802#endif