blob: 6b994bc0c33029f91c2a298deb7dfbddf4e66aae [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"
kaiwang@chromium.org3c57dc62012-07-14 06:48:29 +090019#include "base/metrics/statistics_recorder.h"
jbates@chromium.org5d5b2812012-06-29 07:57:30 +090020#include "base/run_loop.h"
timurrrr@chromium.org490200b2011-01-05 04:06:51 +090021#include "base/third_party/dynamic_annotations/dynamic_annotations.h"
sergeyu@chromium.org675d8882012-05-10 05:16:14 +090022#include "base/thread_task_runner_handle.h"
brettw@chromium.org63965582010-12-31 07:18:56 +090023#include "base/threading/thread_local.h"
mbelshe@chromium.orgbee85b32011-05-16 04:20:49 +090024#include "base/time.h"
ajwong@chromium.org94d2a582011-04-21 01:02:23 +090025#include "base/tracked_objects.h"
initial.commit3f4a7322008-07-27 06:49:38 +090026
mark@chromium.org059d0492008-09-24 06:08:28 +090027#if defined(OS_MACOSX)
28#include "base/message_pump_mac.h"
29#endif
dkegel@google.com9e044ae2008-09-19 03:46:26 +090030#if defined(OS_POSIX)
31#include "base/message_pump_libevent.h"
32#endif
michaelbai@google.com686190b2011-08-03 01:11:16 +090033#if defined(OS_ANDROID)
34#include "base/message_pump_android.h"
35#endif
oshima@chromium.org59a08552012-04-05 09:21:22 +090036
37#if defined(TOOLKIT_GTK)
ajwong@chromium.org94d2a582011-04-21 01:02:23 +090038#include <gdk/gdk.h>
39#include <gdk/gdkx.h>
oshima@chromium.org59a08552012-04-05 09:21:22 +090040#endif
dkegel@google.com9e044ae2008-09-19 03:46:26 +090041
jhawkins@chromium.org2af12f22011-11-16 08:36:30 +090042using base::PendingTask;
dsh@google.com0f8dd262008-10-28 05:43:33 +090043using base::TimeDelta;
jar@chromium.org9b0fb062010-11-07 07:23:29 +090044using base::TimeTicks;
dsh@google.com0f8dd262008-10-28 05:43:33 +090045
erg@chromium.orga7528522010-07-16 02:23:23 +090046namespace {
47
deanm@chromium.orgcd1ce302008-09-10 19:54:06 +090048// A lazily created thread local storage for quick access to a thread's message
49// loop, if one exists. This should be safe and free of static constructors.
joth@chromium.orgb24883c2011-11-15 22:31:49 +090050base::LazyInstance<base::ThreadLocalPointer<MessageLoop> > lazy_tls_ptr =
51 LAZY_INSTANCE_INITIALIZER;
initial.commit3f4a7322008-07-27 06:49:38 +090052
initial.commit3f4a7322008-07-27 06:49:38 +090053// Logical events for Histogram profiling. Run with -message-loop-histogrammer
54// to get an accounting of messages and actions taken on each thread.
erg@chromium.orga7528522010-07-16 02:23:23 +090055const int kTaskRunEvent = 0x1;
56const int kTimerEvent = 0x2;
initial.commit3f4a7322008-07-27 06:49:38 +090057
58// Provide range of message IDs for use in histogramming and debug display.
erg@chromium.orga7528522010-07-16 02:23:23 +090059const int kLeastNonZeroMessageId = 1;
60const int kMaxMessageId = 1099;
61const int kNumberOfDistinctMessagesDisplayed = 1100;
62
63// Provide a macro that takes an expression (such as a constant, or macro
64// constant) and creates a pair to initalize an array of pairs. In this case,
65// our pair consists of the expressions value, and the "stringized" version
66// of the expression (i.e., the exrpression put in quotes). For example, if
67// we have:
68// #define FOO 2
69// #define BAR 5
70// then the following:
71// VALUE_TO_NUMBER_AND_NAME(FOO + BAR)
72// will expand to:
73// {7, "FOO + BAR"}
74// We use the resulting array as an argument to our histogram, which reads the
75// number as a bucket identifier, and proceeds to use the corresponding name
76// in the pair (i.e., the quoted string) when printing out a histogram.
77#define VALUE_TO_NUMBER_AND_NAME(name) {name, #name},
78
brettw@chromium.org275c2ec2010-10-14 13:38:38 +090079const base::LinearHistogram::DescriptionPair event_descriptions_[] = {
erg@chromium.orga7528522010-07-16 02:23:23 +090080 // Provide some pretty print capability in our histogram for our internal
81 // messages.
82
83 // A few events we handle (kindred to messages), and used to profile actions.
84 VALUE_TO_NUMBER_AND_NAME(kTaskRunEvent)
85 VALUE_TO_NUMBER_AND_NAME(kTimerEvent)
86
87 {-1, NULL} // The list must be null terminated, per API to histogram.
88};
89
90bool enable_histogrammer_ = false;
91
michaelbai@google.com686190b2011-08-03 01:11:16 +090092MessageLoop::MessagePumpFactory* message_pump_for_ui_factory_ = NULL;
93
erg@chromium.orga7528522010-07-16 02:23:23 +090094} // namespace
initial.commit3f4a7322008-07-27 06:49:38 +090095
96//------------------------------------------------------------------------------
97
darin@google.com981f3552008-08-16 12:09:05 +090098#if defined(OS_WIN)
initial.commit3f4a7322008-07-27 06:49:38 +090099
initial.commit3f4a7322008-07-27 06:49:38 +0900100// Upon a SEH exception in this thread, it restores the original unhandled
101// exception filter.
102static int SEHFilter(LPTOP_LEVEL_EXCEPTION_FILTER old_filter) {
103 ::SetUnhandledExceptionFilter(old_filter);
104 return EXCEPTION_CONTINUE_SEARCH;
105}
106
107// Retrieves a pointer to the current unhandled exception filter. There
108// is no standalone getter method.
109static LPTOP_LEVEL_EXCEPTION_FILTER GetTopSEHFilter() {
110 LPTOP_LEVEL_EXCEPTION_FILTER top_filter = NULL;
111 top_filter = ::SetUnhandledExceptionFilter(0);
112 ::SetUnhandledExceptionFilter(top_filter);
113 return top_filter;
114}
115
darin@google.com981f3552008-08-16 12:09:05 +0900116#endif // defined(OS_WIN)
117
initial.commit3f4a7322008-07-27 06:49:38 +0900118//------------------------------------------------------------------------------
119
erg@chromium.org493f5f62010-07-16 06:03:54 +0900120MessageLoop::TaskObserver::TaskObserver() {
121}
122
123MessageLoop::TaskObserver::~TaskObserver() {
124}
125
126MessageLoop::DestructionObserver::~DestructionObserver() {
127}
128
129//------------------------------------------------------------------------------
130
darin@google.comd936b5b2008-08-26 14:53:57 +0900131MessageLoop::MessageLoop(Type type)
132 : type_(type),
darin@google.comee6fa722008-08-13 08:25:43 +0900133 nestable_tasks_allowed_(true),
darin@google.com12d40bb2008-08-20 03:36:23 +0900134 exception_restoration_(false),
jar@chromium.org34571142011-04-05 13:48:53 +0900135 message_histogram_(NULL),
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900136 run_loop_(NULL),
ananta@chromium.orgc542fec2011-03-24 12:40:28 +0900137#ifdef OS_WIN
138 os_modal_loop_(false),
139#endif // OS_WIN
darin@google.combe165ae2008-09-07 17:08:29 +0900140 next_sequence_num_(0) {
deanm@chromium.orgcd1ce302008-09-10 19:54:06 +0900141 DCHECK(!current()) << "should only have one message loop per thread";
142 lazy_tls_ptr.Pointer()->Set(this);
darin@google.comd936b5b2008-08-26 14:53:57 +0900143
nduca@chromium.orgba048612011-08-16 05:33:46 +0900144 message_loop_proxy_ = new base::MessageLoopProxyImpl();
sergeyu@chromium.org675d8882012-05-10 05:16:14 +0900145 thread_task_runner_handle_.reset(
146 new base::ThreadTaskRunnerHandle(message_loop_proxy_));
nduca@chromium.orgba048612011-08-16 05:33:46 +0900147
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900148// TODO(rvargas): Get rid of the OS guards.
darin@google.com981f3552008-08-16 12:09:05 +0900149#if defined(OS_WIN)
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900150#define MESSAGE_PUMP_UI new base::MessagePumpForUI()
151#define MESSAGE_PUMP_IO new base::MessagePumpForIO()
152#elif defined(OS_MACOSX)
153#define MESSAGE_PUMP_UI base::MessagePumpMac::Create()
154#define MESSAGE_PUMP_IO new base::MessagePumpLibevent()
abarth@chromium.org1f1c2172010-12-01 17:45:51 +0900155#elif defined(OS_NACL)
dmichael@chromium.orgb798bb42012-06-01 04:37:54 +0900156// Currently NaCl doesn't have a UI MessageLoop.
157// TODO(abarth): Figure out if we need this.
abarth@chromium.org1f1c2172010-12-01 17:45:51 +0900158#define MESSAGE_PUMP_UI NULL
dmichael@chromium.orgb798bb42012-06-01 04:37:54 +0900159// ipc_channel_nacl.cc uses a worker thread to do socket reads currently, and
160// doesn't require extra support for watching file descriptors.
161#define MESSAGE_PUMP_IO new base::MessagePumpDefault();
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900162#elif defined(OS_POSIX) // POSIX but not MACOSX.
piman@chromium.orgbfd272d2011-12-15 01:34:31 +0900163#define MESSAGE_PUMP_UI new base::MessagePumpForUI()
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900164#define MESSAGE_PUMP_IO new base::MessagePumpLibevent()
evan@chromium.org875bb6e2009-12-29 09:32:52 +0900165#else
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900166#error Not implemented
evan@chromium.org875bb6e2009-12-29 09:32:52 +0900167#endif
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900168
169 if (type_ == TYPE_UI) {
michaelbai@google.com686190b2011-08-03 01:11:16 +0900170 if (message_pump_for_ui_factory_)
171 pump_ = message_pump_for_ui_factory_();
172 else
173 pump_ = MESSAGE_PUMP_UI;
dsh@google.com119a2522008-10-04 01:52:59 +0900174 } else if (type_ == TYPE_IO) {
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900175 pump_ = MESSAGE_PUMP_IO;
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900176 } else {
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900177 DCHECK_EQ(TYPE_DEFAULT, type_);
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900178 pump_ = new base::MessagePumpDefault();
179 }
initial.commit3f4a7322008-07-27 06:49:38 +0900180}
181
182MessageLoop::~MessageLoop() {
thestig@chromium.org226880a2010-11-11 05:28:06 +0900183 DCHECK_EQ(this, current());
darin@google.com965e5342008-08-06 08:16:41 +0900184
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900185 DCHECK(!run_loop_);
darin@google.com0e500502008-09-09 14:55:35 +0900186
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900187 // Clean up any unprocessed tasks, but take care: deleting a task could
188 // result in the addition of more tasks (e.g., via DeleteSoon). We set a
189 // limit on the number of times we will allow a deleted task to generate more
190 // tasks. Normally, we should only pass through this loop once or twice. If
191 // we end up hitting the loop limit, then it is probably due to one task that
192 // is being stubborn. Inspect the queues to see who is left.
193 bool did_work;
194 for (int i = 0; i < 100; ++i) {
195 DeletePendingTasks();
196 ReloadWorkQueue();
197 // If we end up with empty queues, then break out of the loop.
198 did_work = DeletePendingTasks();
199 if (!did_work)
200 break;
darin@google.com0e500502008-09-09 14:55:35 +0900201 }
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900202 DCHECK(!did_work);
203
sanjeevr@chromium.org03b44d52010-11-30 09:25:29 +0900204 // Let interested parties have one last shot at accessing this.
205 FOR_EACH_OBSERVER(DestructionObserver, destruction_observers_,
206 WillDestroyCurrentMessageLoop());
207
sergeyu@chromium.org675d8882012-05-10 05:16:14 +0900208 thread_task_runner_handle_.reset();
209
nduca@chromium.orgba048612011-08-16 05:33:46 +0900210 // Tell the message_loop_proxy that we are dying.
211 static_cast<base::MessageLoopProxyImpl*>(message_loop_proxy_.get())->
212 WillDestroyCurrentMessageLoop();
213 message_loop_proxy_ = NULL;
214
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900215 // OK, now make it so that no one can find us.
deanm@chromium.orge4cc5922008-09-10 20:14:56 +0900216 lazy_tls_ptr.Pointer()->Set(NULL);
mbelshe@chromium.orgbee85b32011-05-16 04:20:49 +0900217
218#if defined(OS_WIN)
219 // If we left the high-resolution timer activated, deactivate it now.
220 // Doing this is not-critical, it is mainly to make sure we track
221 // the high resolution timer activations properly in our unit tests.
222 if (!high_resolution_timer_expiration_.is_null()) {
223 base::Time::ActivateHighResolutionTimer(false);
224 high_resolution_timer_expiration_ = base::TimeTicks();
225 }
226#endif
initial.commit3f4a7322008-07-27 06:49:38 +0900227}
228
erg@google.com67a25432011-01-08 05:23:43 +0900229// static
230MessageLoop* MessageLoop::current() {
231 // TODO(darin): sadly, we cannot enable this yet since people call us even
232 // when they have no intention of using us.
233 // DCHECK(loop) << "Ouch, did you forget to initialize me?";
234 return lazy_tls_ptr.Pointer()->Get();
235}
236
237// static
238void MessageLoop::EnableHistogrammer(bool enable) {
239 enable_histogrammer_ = enable;
240}
241
michaelbai@google.com686190b2011-08-03 01:11:16 +0900242// static
243void MessageLoop::InitMessagePumpForUIFactory(MessagePumpFactory* factory) {
244 DCHECK(!message_pump_for_ui_factory_);
245 message_pump_for_ui_factory_ = factory;
246}
247
sky@chromium.org18c66dc2010-09-16 07:14:36 +0900248void MessageLoop::AddDestructionObserver(
249 DestructionObserver* destruction_observer) {
thestig@chromium.org226880a2010-11-11 05:28:06 +0900250 DCHECK_EQ(this, current());
sky@chromium.org18c66dc2010-09-16 07:14:36 +0900251 destruction_observers_.AddObserver(destruction_observer);
darin@google.com965e5342008-08-06 08:16:41 +0900252}
253
sky@chromium.org18c66dc2010-09-16 07:14:36 +0900254void MessageLoop::RemoveDestructionObserver(
255 DestructionObserver* destruction_observer) {
thestig@chromium.org226880a2010-11-11 05:28:06 +0900256 DCHECK_EQ(this, current());
sky@chromium.org18c66dc2010-09-16 07:14:36 +0900257 destruction_observers_.RemoveObserver(destruction_observer);
darin@google.com965e5342008-08-06 08:16:41 +0900258}
259
darin@google.combe165ae2008-09-07 17:08:29 +0900260void MessageLoop::PostTask(
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900261 const tracked_objects::Location& from_here, const base::Closure& task) {
brettw@chromium.org5faed3c2011-10-27 06:48:00 +0900262 DCHECK(!task.is_null()) << from_here.ToString();
tedvessenes@gmail.comc9fdf902012-06-22 02:31:56 +0900263 PendingTask pending_task(
264 from_here, task, CalculateDelayedRuntime(TimeDelta()), true);
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900265 AddToIncomingQueue(&pending_task);
266}
267
268void MessageLoop::PostDelayedTask(
tedvessenes@gmail.com658a87f2011-12-30 10:04:36 +0900269 const tracked_objects::Location& from_here,
270 const base::Closure& task,
tedvessenes@gmail.comc9fdf902012-06-22 02:31:56 +0900271 TimeDelta delay) {
brettw@chromium.org5faed3c2011-10-27 06:48:00 +0900272 DCHECK(!task.is_null()) << from_here.ToString();
tedvessenes@gmail.comc9fdf902012-06-22 02:31:56 +0900273 PendingTask pending_task(
274 from_here, task, CalculateDelayedRuntime(delay), true);
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900275 AddToIncomingQueue(&pending_task);
276}
277
278void MessageLoop::PostNonNestableTask(
tedvessenes@gmail.comc9fdf902012-06-22 02:31:56 +0900279 const tracked_objects::Location& from_here,
280 const base::Closure& task) {
brettw@chromium.org5faed3c2011-10-27 06:48:00 +0900281 DCHECK(!task.is_null()) << from_here.ToString();
tedvessenes@gmail.comc9fdf902012-06-22 02:31:56 +0900282 PendingTask pending_task(
283 from_here, task, CalculateDelayedRuntime(TimeDelta()), false);
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900284 AddToIncomingQueue(&pending_task);
darin@google.combe165ae2008-09-07 17:08:29 +0900285}
286
tedvessenes@gmail.com658a87f2011-12-30 10:04:36 +0900287void MessageLoop::PostNonNestableDelayedTask(
288 const tracked_objects::Location& from_here,
289 const base::Closure& task,
tedvessenes@gmail.comc9fdf902012-06-22 02:31:56 +0900290 TimeDelta delay) {
291 DCHECK(!task.is_null()) << from_here.ToString();
292 PendingTask pending_task(
293 from_here, task, CalculateDelayedRuntime(delay), false);
294 AddToIncomingQueue(&pending_task);
tedvessenes@gmail.com658a87f2011-12-30 10:04:36 +0900295}
296
erg@google.com67a25432011-01-08 05:23:43 +0900297void MessageLoop::Run() {
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900298 base::RunLoop run_loop;
299 run_loop.Run();
erg@google.com67a25432011-01-08 05:23:43 +0900300}
darin@google.com0795f572008-08-30 09:22:48 +0900301
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900302void MessageLoop::RunUntilIdle() {
303 base::RunLoop run_loop;
304 run_loop.RunUntilIdle();
erg@google.com67a25432011-01-08 05:23:43 +0900305}
darin@google.com0795f572008-08-30 09:22:48 +0900306
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900307void MessageLoop::QuitWhenIdle() {
erg@google.com67a25432011-01-08 05:23:43 +0900308 DCHECK_EQ(this, current());
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900309 if (run_loop_) {
310 run_loop_->quit_when_idle_received_ = true;
darin@google.com0795f572008-08-30 09:22:48 +0900311 } else {
erg@google.com67a25432011-01-08 05:23:43 +0900312 NOTREACHED() << "Must be inside Run to call Quit";
darin@google.com0795f572008-08-30 09:22:48 +0900313 }
erg@google.com67a25432011-01-08 05:23:43 +0900314}
darin@google.com0795f572008-08-30 09:22:48 +0900315
erg@google.com67a25432011-01-08 05:23:43 +0900316void MessageLoop::QuitNow() {
317 DCHECK_EQ(this, current());
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900318 if (run_loop_) {
erg@google.com67a25432011-01-08 05:23:43 +0900319 pump_->Quit();
320 } else {
321 NOTREACHED() << "Must be inside Run to call Quit";
mbelshe@chromium.orgde50b7d2010-06-29 13:58:15 +0900322 }
initial.commit3f4a7322008-07-27 06:49:38 +0900323}
324
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900325static void QuitCurrentWhenIdle() {
326 MessageLoop::current()->QuitWhenIdle();
kalman@chromium.orgc89ed902011-10-21 15:21:57 +0900327}
328
jhawkins@chromium.org573d4182011-10-17 10:20:36 +0900329// static
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900330base::Closure MessageLoop::QuitWhenIdleClosure() {
331 return base::Bind(&QuitCurrentWhenIdle);
jhawkins@chromium.org573d4182011-10-17 10:20:36 +0900332}
333
initial.commit3f4a7322008-07-27 06:49:38 +0900334void MessageLoop::SetNestableTasksAllowed(bool allowed) {
mpcomplete@google.com989d5f82008-08-09 09:14:09 +0900335 if (nestable_tasks_allowed_ != allowed) {
336 nestable_tasks_allowed_ = allowed;
337 if (!nestable_tasks_allowed_)
338 return;
339 // Start the native pump if we are not already pumping.
darin@google.com981f3552008-08-16 12:09:05 +0900340 pump_->ScheduleWork();
mpcomplete@google.com989d5f82008-08-09 09:14:09 +0900341 }
initial.commit3f4a7322008-07-27 06:49:38 +0900342}
343
344bool MessageLoop::NestableTasksAllowed() const {
345 return nestable_tasks_allowed_;
346}
347
jcampan@chromium.orgeac57172009-07-02 04:53:59 +0900348bool MessageLoop::IsNested() {
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900349 return run_loop_->run_depth_ > 1;
jcampan@chromium.orgeac57172009-07-02 04:53:59 +0900350}
351
erg@google.com67a25432011-01-08 05:23:43 +0900352void MessageLoop::AddTaskObserver(TaskObserver* task_observer) {
353 DCHECK_EQ(this, current());
354 task_observers_.AddObserver(task_observer);
355}
356
357void MessageLoop::RemoveTaskObserver(TaskObserver* task_observer) {
358 DCHECK_EQ(this, current());
359 task_observers_.RemoveObserver(task_observer);
360}
361
willchan@chromium.org3a397672011-01-26 09:53:48 +0900362void MessageLoop::AssertIdle() const {
363 // We only check |incoming_queue_|, since we don't want to lock |work_queue_|.
364 base::AutoLock lock(incoming_queue_lock_);
365 DCHECK(incoming_queue_.empty());
366}
367
willchan@chromium.orgfe2201e2011-11-02 07:06:58 +0900368bool MessageLoop::is_running() const {
369 DCHECK_EQ(this, current());
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900370 return run_loop_ != NULL;
willchan@chromium.orgfe2201e2011-11-02 07:06:58 +0900371}
372
initial.commit3f4a7322008-07-27 06:49:38 +0900373//------------------------------------------------------------------------------
initial.commit3f4a7322008-07-27 06:49:38 +0900374
erg@google.com67a25432011-01-08 05:23:43 +0900375// Runs the loop in two different SEH modes:
376// enable_SEH_restoration_ = false : any unhandled exception goes to the last
377// one that calls SetUnhandledExceptionFilter().
378// enable_SEH_restoration_ = true : any unhandled exception goes to the filter
379// that was existed before the loop was run.
380void MessageLoop::RunHandler() {
381#if defined(OS_WIN)
382 if (exception_restoration_) {
383 RunInternalInSEHFrame();
384 return;
385 }
386#endif
387
388 RunInternal();
389}
390
391#if defined(OS_WIN)
392__declspec(noinline) void MessageLoop::RunInternalInSEHFrame() {
393 LPTOP_LEVEL_EXCEPTION_FILTER current_filter = GetTopSEHFilter();
394 __try {
395 RunInternal();
396 } __except(SEHFilter(current_filter)) {
397 }
398 return;
399}
400#endif
401
402void MessageLoop::RunInternal() {
403 DCHECK_EQ(this, current());
404
405 StartHistogrammer();
406
michaelbai@google.com686190b2011-08-03 01:11:16 +0900407#if !defined(OS_MACOSX) && !defined(OS_ANDROID)
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900408 if (run_loop_->dispatcher_ && type() == TYPE_UI) {
erg@google.com67a25432011-01-08 05:23:43 +0900409 static_cast<base::MessagePumpForUI*>(pump_.get())->
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900410 RunWithDispatcher(this, run_loop_->dispatcher_);
erg@google.com67a25432011-01-08 05:23:43 +0900411 return;
412 }
413#endif
414
415 pump_->Run(this);
416}
417
418bool MessageLoop::ProcessNextDelayedNonNestableTask() {
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900419 if (run_loop_->run_depth_ != 1)
erg@google.com67a25432011-01-08 05:23:43 +0900420 return false;
421
422 if (deferred_non_nestable_work_queue_.empty())
423 return false;
424
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900425 PendingTask pending_task = deferred_non_nestable_work_queue_.front();
erg@google.com67a25432011-01-08 05:23:43 +0900426 deferred_non_nestable_work_queue_.pop();
427
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900428 RunTask(pending_task);
erg@google.com67a25432011-01-08 05:23:43 +0900429 return true;
430}
431
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900432void MessageLoop::RunTask(const PendingTask& pending_task) {
jbates@chromium.org5a97c212012-02-24 04:16:35 +0900433 TRACE_EVENT2("task", "MessageLoop::RunTask",
434 "src_file", pending_task.posted_from.file_name(),
435 "src_func", pending_task.posted_from.function_name());
initial.commit3f4a7322008-07-27 06:49:38 +0900436 DCHECK(nestable_tasks_allowed_);
437 // Execute the task and assume the worst: It is probably not reentrant.
438 nestable_tasks_allowed_ = false;
darin@google.combe165ae2008-09-07 17:08:29 +0900439
apatrick@chromium.org87164042011-05-20 07:28:25 +0900440 // Before running the task, store the program counter where it was posted
441 // and deliberately alias it to ensure it is on the stack if the task
442 // crashes. Be careful not to assume that the variable itself will have the
443 // expected value when displayed by the optimizer in an optimized build.
444 // Look at a memory dump of the stack.
jbates@chromium.orgb84db522011-10-04 02:51:25 +0900445 const void* program_counter =
446 pending_task.posted_from.program_counter();
apatrick@chromium.org87164042011-05-20 07:28:25 +0900447 base::debug::Alias(&program_counter);
448
darin@google.combe165ae2008-09-07 17:08:29 +0900449 HistogramEvent(kTaskRunEvent);
jar@chromium.org79a58c32011-10-16 08:52:45 +0900450
jar@chromium.orgb536eef2011-11-14 14:24:07 +0900451 tracked_objects::TrackedTime start_time =
jar@chromium.orgb5c974b2011-12-14 10:36:48 +0900452 tracked_objects::ThreadData::NowForStartOfRun(pending_task.birth_tally);
jar@chromium.org79a58c32011-10-16 08:52:45 +0900453
willchan@chromium.orga9047632010-06-10 06:20:41 +0900454 FOR_EACH_OBSERVER(TaskObserver, task_observers_,
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900455 WillProcessTask(pending_task.time_posted));
456 pending_task.task.Run();
457 FOR_EACH_OBSERVER(TaskObserver, task_observers_,
458 DidProcessTask(pending_task.time_posted));
jar@chromium.org4be2cb02011-11-01 07:36:21 +0900459
460 tracked_objects::ThreadData::TallyRunOnNamedThreadIfTracking(pending_task,
jar@chromium.orgb536eef2011-11-14 14:24:07 +0900461 start_time, tracked_objects::ThreadData::NowForEndOfRun());
darin@google.combe165ae2008-09-07 17:08:29 +0900462
463 nestable_tasks_allowed_ = true;
initial.commit3f4a7322008-07-27 06:49:38 +0900464}
465
jar@chromium.org79a58c32011-10-16 08:52:45 +0900466bool MessageLoop::DeferOrRunPendingTask(const PendingTask& pending_task) {
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900467 if (pending_task.nestable || run_loop_->run_depth_ == 1) {
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900468 RunTask(pending_task);
darin@google.combe165ae2008-09-07 17:08:29 +0900469 // Show that we ran a task (Note: a new one might arrive as a
470 // consequence!).
471 return true;
472 }
473
474 // We couldn't run the task now because we're in a nested message loop
475 // and the task isn't nestable.
476 deferred_non_nestable_work_queue_.push(pending_task);
477 return false;
initial.commit3f4a7322008-07-27 06:49:38 +0900478}
479
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900480void MessageLoop::AddToDelayedWorkQueue(const PendingTask& pending_task) {
481 // Move to the delayed work queue. Initialize the sequence number
482 // before inserting into the delayed_work_queue_. The sequence number
483 // is used to faciliate FIFO sorting when two tasks have the same
484 // delayed_run_time value.
485 PendingTask new_pending_task(pending_task);
486 new_pending_task.sequence_num = next_sequence_num_++;
487 delayed_work_queue_.push(new_pending_task);
488}
489
initial.commit3f4a7322008-07-27 06:49:38 +0900490void MessageLoop::ReloadWorkQueue() {
491 // We can improve performance of our loading tasks from incoming_queue_ to
darin@google.com981f3552008-08-16 12:09:05 +0900492 // work_queue_ by waiting until the last minute (work_queue_ is empty) to
493 // load. That reduces the number of locks-per-task significantly when our
darin@google.combe165ae2008-09-07 17:08:29 +0900494 // queues get large.
495 if (!work_queue_.empty())
initial.commit3f4a7322008-07-27 06:49:38 +0900496 return; // Wait till we *really* need to lock and load.
497
498 // Acquire all we can from the inter-thread queue with one lock acquisition.
initial.commit3f4a7322008-07-27 06:49:38 +0900499 {
brettw@chromium.orgabe477a2011-01-21 13:55:52 +0900500 base::AutoLock lock(incoming_queue_lock_);
darin@google.combe165ae2008-09-07 17:08:29 +0900501 if (incoming_queue_.empty())
initial.commit3f4a7322008-07-27 06:49:38 +0900502 return;
darin@chromium.orgb80ef1a2009-09-03 05:05:21 +0900503 incoming_queue_.Swap(&work_queue_); // Constant time
darin@google.combe165ae2008-09-07 17:08:29 +0900504 DCHECK(incoming_queue_.empty());
initial.commit3f4a7322008-07-27 06:49:38 +0900505 }
506}
507
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900508bool MessageLoop::DeletePendingTasks() {
509 bool did_work = !work_queue_.empty();
510 while (!work_queue_.empty()) {
511 PendingTask pending_task = work_queue_.front();
512 work_queue_.pop();
513 if (!pending_task.delayed_run_time.is_null()) {
514 // We want to delete delayed tasks in the same order in which they would
515 // normally be deleted in case of any funny dependencies between delayed
516 // tasks.
517 AddToDelayedWorkQueue(pending_task);
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900518 }
initial.commit3f4a7322008-07-27 06:49:38 +0900519 }
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900520 did_work |= !deferred_non_nestable_work_queue_.empty();
521 while (!deferred_non_nestable_work_queue_.empty()) {
jar@chromium.org2fa6b4b2009-03-12 04:53:50 +0900522 deferred_non_nestable_work_queue_.pop();
initial.commit3f4a7322008-07-27 06:49:38 +0900523 }
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900524 did_work |= !delayed_work_queue_.empty();
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900525
526 // Historically, we always delete the task regardless of valgrind status. It's
527 // not completely clear why we want to leak them in the loops above. This
528 // code is replicating legacy behavior, and should not be considered
529 // absolutely "correct" behavior. See TODO above about deleting all tasks
530 // when it's safe.
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900531 while (!delayed_work_queue_.empty()) {
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900532 delayed_work_queue_.pop();
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900533 }
534 return did_work;
initial.commit3f4a7322008-07-27 06:49:38 +0900535}
536
tedvessenes@gmail.comc9fdf902012-06-22 02:31:56 +0900537TimeTicks MessageLoop::CalculateDelayedRuntime(TimeDelta delay) {
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900538 TimeTicks delayed_run_time;
tedvessenes@gmail.comc9fdf902012-06-22 02:31:56 +0900539 if (delay > TimeDelta()) {
540 delayed_run_time = TimeTicks::Now() + delay;
erg@google.com67a25432011-01-08 05:23:43 +0900541
542#if defined(OS_WIN)
543 if (high_resolution_timer_expiration_.is_null()) {
544 // Windows timers are granular to 15.6ms. If we only set high-res
545 // timers for those under 15.6ms, then a 18ms timer ticks at ~32ms,
546 // which as a percentage is pretty inaccurate. So enable high
547 // res timers for any timer which is within 2x of the granularity.
548 // This is a tradeoff between accuracy and power management.
tedvessenes@gmail.comc9fdf902012-06-22 02:31:56 +0900549 bool needs_high_res_timers = delay.InMilliseconds() <
550 (2 * base::Time::kMinLowResolutionThresholdMs);
erg@google.com67a25432011-01-08 05:23:43 +0900551 if (needs_high_res_timers) {
mbelshe@chromium.orgbee85b32011-05-16 04:20:49 +0900552 if (base::Time::ActivateHighResolutionTimer(true)) {
553 high_resolution_timer_expiration_ = TimeTicks::Now() +
554 TimeDelta::FromMilliseconds(kHighResolutionTimerModeLeaseTimeMs);
555 }
erg@google.com67a25432011-01-08 05:23:43 +0900556 }
557 }
558#endif
559 } else {
tedvessenes@gmail.comc9fdf902012-06-22 02:31:56 +0900560 DCHECK_EQ(delay.InMilliseconds(), 0) << "delay should not be negative";
erg@google.com67a25432011-01-08 05:23:43 +0900561 }
562
563#if defined(OS_WIN)
564 if (!high_resolution_timer_expiration_.is_null()) {
565 if (TimeTicks::Now() > high_resolution_timer_expiration_) {
566 base::Time::ActivateHighResolutionTimer(false);
567 high_resolution_timer_expiration_ = TimeTicks();
568 }
569 }
570#endif
571
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900572 return delayed_run_time;
573}
574
575// Possibly called on a background thread!
576void MessageLoop::AddToIncomingQueue(PendingTask* pending_task) {
erg@google.com67a25432011-01-08 05:23:43 +0900577 // Warning: Don't try to short-circuit, and handle this thread's tasks more
578 // directly, as it could starve handling of foreign threads. Put every task
579 // into this queue.
580
581 scoped_refptr<base::MessagePump> pump;
582 {
brettw@chromium.orgabe477a2011-01-21 13:55:52 +0900583 base::AutoLock locked(incoming_queue_lock_);
erg@google.com67a25432011-01-08 05:23:43 +0900584
585 bool was_empty = incoming_queue_.empty();
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900586 incoming_queue_.push(*pending_task);
587 pending_task->task.Reset();
erg@google.com67a25432011-01-08 05:23:43 +0900588 if (!was_empty)
589 return; // Someone else should have started the sub-pump.
590
591 pump = pump_;
592 }
593 // Since the incoming_queue_ may contain a task that destroys this message
594 // loop, we cannot exit incoming_queue_lock_ until we are done with |this|.
595 // We use a stack-based reference to the message pump so that we can call
596 // ScheduleWork outside of incoming_queue_lock_.
597
598 pump->ScheduleWork();
599}
600
601//------------------------------------------------------------------------------
602// Method and data for histogramming events and actions taken by each instance
603// on each thread.
604
605void MessageLoop::StartHistogrammer() {
jar@chromium.org34571142011-04-05 13:48:53 +0900606 if (enable_histogrammer_ && !message_histogram_
erg@google.com67a25432011-01-08 05:23:43 +0900607 && base::StatisticsRecorder::IsActive()) {
608 DCHECK(!thread_name_.empty());
609 message_histogram_ = base::LinearHistogram::FactoryGet(
610 "MsgLoop:" + thread_name_,
611 kLeastNonZeroMessageId, kMaxMessageId,
612 kNumberOfDistinctMessagesDisplayed,
613 message_histogram_->kHexRangePrintingFlag);
614 message_histogram_->SetRangeDescriptions(event_descriptions_);
615 }
616}
617
618void MessageLoop::HistogramEvent(int event) {
jar@chromium.org34571142011-04-05 13:48:53 +0900619 if (message_histogram_)
erg@google.com67a25432011-01-08 05:23:43 +0900620 message_histogram_->Add(event);
621}
622
darin@google.com981f3552008-08-16 12:09:05 +0900623bool MessageLoop::DoWork() {
darin@google.combe165ae2008-09-07 17:08:29 +0900624 if (!nestable_tasks_allowed_) {
625 // Task can't be executed right now.
626 return false;
627 }
628
629 for (;;) {
630 ReloadWorkQueue();
631 if (work_queue_.empty())
632 break;
633
634 // Execute oldest task.
635 do {
636 PendingTask pending_task = work_queue_.front();
637 work_queue_.pop();
638 if (!pending_task.delayed_run_time.is_null()) {
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900639 AddToDelayedWorkQueue(pending_task);
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900640 // If we changed the topmost task, then it is time to reschedule.
641 if (delayed_work_queue_.top().task.Equals(pending_task.task))
darin@google.combe165ae2008-09-07 17:08:29 +0900642 pump_->ScheduleDelayedWork(pending_task.delayed_run_time);
643 } else {
644 if (DeferOrRunPendingTask(pending_task))
645 return true;
646 }
647 } while (!work_queue_.empty());
648 }
649
650 // Nothing happened.
651 return false;
darin@google.com981f3552008-08-16 12:09:05 +0900652}
653
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900654bool MessageLoop::DoDelayedWork(TimeTicks* next_delayed_work_time) {
jar@chromium.org40355072010-10-21 15:32:33 +0900655 if (!nestable_tasks_allowed_ || delayed_work_queue_.empty()) {
jar@chromium.org9b0fb062010-11-07 07:23:29 +0900656 recent_time_ = *next_delayed_work_time = TimeTicks();
darin@google.combe165ae2008-09-07 17:08:29 +0900657 return false;
658 }
jeremy@chromium.org2ed223c2008-12-09 02:36:06 +0900659
jar@chromium.org9b0fb062010-11-07 07:23:29 +0900660 // When we "fall behind," there will be a lot of tasks in the delayed work
jar@chromium.org94f73832010-11-05 08:23:42 +0900661 // queue that are ready to run. To increase efficiency when we fall behind,
662 // we will only call Time::Now() intermittently, and then process all tasks
663 // that are ready to run before calling it again. As a result, the more we
664 // fall behind (and have a lot of ready-to-run delayed tasks), the more
665 // efficient we'll be at handling the tasks.
jar@chromium.org9b0fb062010-11-07 07:23:29 +0900666
667 TimeTicks next_run_time = delayed_work_queue_.top().delayed_run_time;
jar@chromium.org94f73832010-11-05 08:23:42 +0900668 if (next_run_time > recent_time_) {
jar@chromium.org9b0fb062010-11-07 07:23:29 +0900669 recent_time_ = TimeTicks::Now(); // Get a better view of Now();
jar@chromium.org94f73832010-11-05 08:23:42 +0900670 if (next_run_time > recent_time_) {
671 *next_delayed_work_time = next_run_time;
672 return false;
673 }
darin@google.combe165ae2008-09-07 17:08:29 +0900674 }
darin@google.com981f3552008-08-16 12:09:05 +0900675
jar@chromium.org40355072010-10-21 15:32:33 +0900676 PendingTask pending_task = delayed_work_queue_.top();
677 delayed_work_queue_.pop();
jeremy@chromium.org2ed223c2008-12-09 02:36:06 +0900678
jar@chromium.org40355072010-10-21 15:32:33 +0900679 if (!delayed_work_queue_.empty())
darin@google.combe165ae2008-09-07 17:08:29 +0900680 *next_delayed_work_time = delayed_work_queue_.top().delayed_run_time;
darin@google.com981f3552008-08-16 12:09:05 +0900681
darin@google.combe165ae2008-09-07 17:08:29 +0900682 return DeferOrRunPendingTask(pending_task);
darin@google.com981f3552008-08-16 12:09:05 +0900683}
684
685bool MessageLoop::DoIdleWork() {
686 if (ProcessNextDelayedNonNestableTask())
687 return true;
688
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900689 if (run_loop_->quit_when_idle_received_)
darin@google.com981f3552008-08-16 12:09:05 +0900690 pump_->Quit();
691
692 return false;
693}
694
dcheng@chromium.org36904742011-12-30 13:32:58 +0900695void MessageLoop::DeleteSoonInternal(const tracked_objects::Location& from_here,
696 void(*deleter)(const void*),
697 const void* object) {
698 PostNonNestableTask(from_here, base::Bind(deleter, object));
699}
700
dcheng@chromium.org2116fc92011-12-30 15:46:30 +0900701void MessageLoop::ReleaseSoonInternal(
702 const tracked_objects::Location& from_here,
703 void(*releaser)(const void*),
704 const void* object) {
705 PostNonNestableTask(from_here, base::Bind(releaser, object));
706}
707
darin@google.com981f3552008-08-16 12:09:05 +0900708//------------------------------------------------------------------------------
darin@google.comd936b5b2008-08-26 14:53:57 +0900709// MessageLoopForUI
710
711#if defined(OS_WIN)
darin@google.comd936b5b2008-08-26 14:53:57 +0900712void MessageLoopForUI::DidProcessMessage(const MSG& message) {
713 pump_win()->DidProcessMessage(message);
714}
darin@google.comd936b5b2008-08-26 14:53:57 +0900715#endif // defined(OS_WIN)
716
michaelbai@google.com686190b2011-08-03 01:11:16 +0900717#if defined(OS_ANDROID)
718void MessageLoopForUI::Start() {
719 // No Histogram support for UI message loop as it is managed by Java side
720 static_cast<base::MessagePumpForUI*>(pump_.get())->Start(this);
721}
722#endif
723
rohitrao@chromium.orgdcc49022012-07-13 20:02:57 +0900724#if defined(OS_IOS)
725void MessageLoopForUI::Attach() {
726 static_cast<base::MessagePumpUIApplication*>(pump_.get())->Attach(this);
727}
728#endif
729
michaelbai@google.com686190b2011-08-03 01:11:16 +0900730#if !defined(OS_MACOSX) && !defined(OS_NACL) && !defined(OS_ANDROID)
jcampan@chromium.org05423582009-08-01 07:53:37 +0900731void MessageLoopForUI::AddObserver(Observer* observer) {
732 pump_ui()->AddObserver(observer);
733}
734
735void MessageLoopForUI::RemoveObserver(Observer* observer) {
736 pump_ui()->RemoveObserver(observer);
737}
738
michaelbai@google.com686190b2011-08-03 01:11:16 +0900739#endif // !defined(OS_MACOSX) && !defined(OS_NACL) && !defined(OS_ANDROID)
jcampan@chromium.org05423582009-08-01 07:53:37 +0900740
darin@google.comd936b5b2008-08-26 14:53:57 +0900741//------------------------------------------------------------------------------
742// MessageLoopForIO
743
744#if defined(OS_WIN)
745
rvargas@google.com9e49aa22008-10-10 08:58:43 +0900746void MessageLoopForIO::RegisterIOHandler(HANDLE file, IOHandler* handler) {
747 pump_io()->RegisterIOHandler(file, handler);
748}
749
rvargas@google.com73887542008-11-08 06:52:15 +0900750bool MessageLoopForIO::WaitForIOCompletion(DWORD timeout, IOHandler* filter) {
751 return pump_io()->WaitForIOCompletion(timeout, filter);
rvargas@google.com9e49aa22008-10-10 08:58:43 +0900752}
753
abarth@chromium.org1f1c2172010-12-01 17:45:51 +0900754#elif defined(OS_POSIX) && !defined(OS_NACL)
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900755
jeremy@chromium.orgefc0db02008-12-16 07:02:17 +0900756bool MessageLoopForIO::WatchFileDescriptor(int fd,
757 bool persistent,
758 Mode mode,
759 FileDescriptorWatcher *controller,
760 Watcher *delegate) {
761 return pump_libevent()->WatchFileDescriptor(
762 fd,
763 persistent,
764 static_cast<base::MessagePumpLibevent::Mode>(mode),
765 controller,
766 delegate);
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900767}
768
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900769#endif