blob: e03572675aa8528a04034463e9c25cb35b2a98f7 [file] [log] [blame]
brettw@chromium.org6318b392013-06-14 12:27:49 +09001// Copyright 2013 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
brettw@chromium.org6318b392013-06-14 12:27:49 +09005#include "base/message_loop/message_loop.h"
darin@google.com6ddeb842008-08-15 16:31:20 +09006
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"
brettw@chromium.org710ecb92013-06-19 05:27:52 +090016#include "base/message_loop/message_pump_default.h"
brettw@chromium.org275c2ec2010-10-14 13:38:38 +090017#include "base/metrics/histogram.h"
kaiwang@chromium.org3c57dc62012-07-14 06:48:29 +090018#include "base/metrics/statistics_recorder.h"
jbates@chromium.org5d5b2812012-06-29 07:57:30 +090019#include "base/run_loop.h"
timurrrr@chromium.org490200b2011-01-05 04:06:51 +090020#include "base/third_party/dynamic_annotations/dynamic_annotations.h"
sergeyu@chromium.org675d8882012-05-10 05:16:14 +090021#include "base/thread_task_runner_handle.h"
brettw@chromium.org63965582010-12-31 07:18:56 +090022#include "base/threading/thread_local.h"
avi@chromium.orgb039e8b2013-06-28 09:49:07 +090023#include "base/time/time.h"
ajwong@chromium.org94d2a582011-04-21 01:02:23 +090024#include "base/tracked_objects.h"
initial.commit3f4a7322008-07-27 06:49:38 +090025
mark@chromium.org059d0492008-09-24 06:08:28 +090026#if defined(OS_MACOSX)
brettw@chromium.org710ecb92013-06-19 05:27:52 +090027#include "base/message_loop/message_pump_mac.h"
mark@chromium.org059d0492008-09-24 06:08:28 +090028#endif
blundell@chromium.orge21b2aa2012-12-01 02:29:40 +090029#if defined(OS_POSIX) && !defined(OS_IOS)
brettw@chromium.org710ecb92013-06-19 05:27:52 +090030#include "base/message_loop/message_pump_libevent.h"
dkegel@google.com9e044ae2008-09-19 03:46:26 +090031#endif
michaelbai@google.com686190b2011-08-03 01:11:16 +090032#if defined(OS_ANDROID)
brettw@chromium.org710ecb92013-06-19 05:27:52 +090033#include "base/message_loop/message_pump_android.h"
michaelbai@google.com686190b2011-08-03 01:11:16 +090034#endif
oshima@chromium.org59a08552012-04-05 09:21:22 +090035
36#if defined(TOOLKIT_GTK)
ajwong@chromium.org94d2a582011-04-21 01:02:23 +090037#include <gdk/gdk.h>
38#include <gdk/gdkx.h>
oshima@chromium.org59a08552012-04-05 09:21:22 +090039#endif
dkegel@google.com9e044ae2008-09-19 03:46:26 +090040
brettw@chromium.org87994282013-03-31 11:29:20 +090041namespace base {
dsh@google.com0f8dd262008-10-28 05:43:33 +090042
erg@chromium.orga7528522010-07-16 02:23:23 +090043namespace {
44
deanm@chromium.orgcd1ce302008-09-10 19:54:06 +090045// A lazily created thread local storage for quick access to a thread's message
46// loop, if one exists. This should be safe and free of static constructors.
earthdok@chromium.org80d362f82013-08-28 16:51:19 +090047LazyInstance<base::ThreadLocalPointer<MessageLoop> >::Leaky lazy_tls_ptr =
joth@chromium.orgb24883c2011-11-15 22:31:49 +090048 LAZY_INSTANCE_INITIALIZER;
initial.commit3f4a7322008-07-27 06:49:38 +090049
initial.commit3f4a7322008-07-27 06:49:38 +090050// Logical events for Histogram profiling. Run with -message-loop-histogrammer
51// to get an accounting of messages and actions taken on each thread.
erg@chromium.orga7528522010-07-16 02:23:23 +090052const int kTaskRunEvent = 0x1;
53const int kTimerEvent = 0x2;
initial.commit3f4a7322008-07-27 06:49:38 +090054
55// Provide range of message IDs for use in histogramming and debug display.
erg@chromium.orga7528522010-07-16 02:23:23 +090056const int kLeastNonZeroMessageId = 1;
57const int kMaxMessageId = 1099;
58const int kNumberOfDistinctMessagesDisplayed = 1100;
59
60// Provide a macro that takes an expression (such as a constant, or macro
61// constant) and creates a pair to initalize an array of pairs. In this case,
62// our pair consists of the expressions value, and the "stringized" version
63// of the expression (i.e., the exrpression put in quotes). For example, if
64// we have:
65// #define FOO 2
66// #define BAR 5
67// then the following:
68// VALUE_TO_NUMBER_AND_NAME(FOO + BAR)
69// will expand to:
70// {7, "FOO + BAR"}
71// We use the resulting array as an argument to our histogram, which reads the
72// number as a bucket identifier, and proceeds to use the corresponding name
73// in the pair (i.e., the quoted string) when printing out a histogram.
74#define VALUE_TO_NUMBER_AND_NAME(name) {name, #name},
75
brettw@chromium.org87994282013-03-31 11:29:20 +090076const LinearHistogram::DescriptionPair event_descriptions_[] = {
erg@chromium.orga7528522010-07-16 02:23:23 +090077 // Provide some pretty print capability in our histogram for our internal
78 // messages.
79
80 // A few events we handle (kindred to messages), and used to profile actions.
81 VALUE_TO_NUMBER_AND_NAME(kTaskRunEvent)
82 VALUE_TO_NUMBER_AND_NAME(kTimerEvent)
83
84 {-1, NULL} // The list must be null terminated, per API to histogram.
85};
86
87bool enable_histogrammer_ = false;
88
michaelbai@google.com686190b2011-08-03 01:11:16 +090089MessageLoop::MessagePumpFactory* message_pump_for_ui_factory_ = NULL;
90
kristianm@chromium.orgd7557e82013-07-12 12:19:55 +090091// Returns true if MessagePump::ScheduleWork() must be called one
92// time for every task that is added to the MessageLoop incoming queue.
93bool AlwaysNotifyPump(MessageLoop::Type type) {
94#if defined(OS_ANDROID)
kristianm@chromium.orga78bfa92013-08-08 10:31:52 +090095 return type == MessageLoop::TYPE_UI || type == MessageLoop::TYPE_JAVA;
kristianm@chromium.orgd7557e82013-07-12 12:19:55 +090096#else
97 return false;
98#endif
99}
100
erg@chromium.orga7528522010-07-16 02:23:23 +0900101} // namespace
initial.commit3f4a7322008-07-27 06:49:38 +0900102
103//------------------------------------------------------------------------------
104
darin@google.com981f3552008-08-16 12:09:05 +0900105#if defined(OS_WIN)
initial.commit3f4a7322008-07-27 06:49:38 +0900106
initial.commit3f4a7322008-07-27 06:49:38 +0900107// Upon a SEH exception in this thread, it restores the original unhandled
108// exception filter.
109static int SEHFilter(LPTOP_LEVEL_EXCEPTION_FILTER old_filter) {
110 ::SetUnhandledExceptionFilter(old_filter);
111 return EXCEPTION_CONTINUE_SEARCH;
112}
113
114// Retrieves a pointer to the current unhandled exception filter. There
115// is no standalone getter method.
116static LPTOP_LEVEL_EXCEPTION_FILTER GetTopSEHFilter() {
117 LPTOP_LEVEL_EXCEPTION_FILTER top_filter = NULL;
118 top_filter = ::SetUnhandledExceptionFilter(0);
119 ::SetUnhandledExceptionFilter(top_filter);
120 return top_filter;
121}
122
darin@google.com981f3552008-08-16 12:09:05 +0900123#endif // defined(OS_WIN)
124
initial.commit3f4a7322008-07-27 06:49:38 +0900125//------------------------------------------------------------------------------
126
erg@chromium.org493f5f62010-07-16 06:03:54 +0900127MessageLoop::TaskObserver::TaskObserver() {
128}
129
130MessageLoop::TaskObserver::~TaskObserver() {
131}
132
133MessageLoop::DestructionObserver::~DestructionObserver() {
134}
135
136//------------------------------------------------------------------------------
137
darin@google.comd936b5b2008-08-26 14:53:57 +0900138MessageLoop::MessageLoop(Type type)
139 : type_(type),
alexeypa@google.combb819d62013-07-23 05:06:56 +0900140 exception_restoration_(false),
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900141 nestable_tasks_allowed_(true),
dbeam@chromium.orge8888492013-03-24 04:10:54 +0900142#if defined(OS_WIN)
ananta@chromium.orgc542fec2011-03-24 12:40:28 +0900143 os_modal_loop_(false),
144#endif // OS_WIN
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900145 message_histogram_(NULL),
146 run_loop_(NULL) {
sky@chromium.orgab452802013-11-08 15:16:53 +0900147 Init();
nduca@chromium.orgba048612011-08-16 05:33:46 +0900148
sky@chromium.org4f426822013-11-13 01:35:02 +0900149 pump_.reset(CreateMessagePumpForType(type));
initial.commit3f4a7322008-07-27 06:49:38 +0900150}
151
sky@chromium.orgab452802013-11-08 15:16:53 +0900152MessageLoop::MessageLoop(scoped_ptr<MessagePump> pump)
153 : pump_(pump.Pass()),
154 type_(TYPE_CUSTOM),
155 exception_restoration_(false),
156 nestable_tasks_allowed_(true),
157#if defined(OS_WIN)
158 os_modal_loop_(false),
159#endif // OS_WIN
160 message_histogram_(NULL),
161 run_loop_(NULL) {
162 DCHECK(pump_.get());
163 Init();
164}
165
initial.commit3f4a7322008-07-27 06:49:38 +0900166MessageLoop::~MessageLoop() {
thestig@chromium.org226880a2010-11-11 05:28:06 +0900167 DCHECK_EQ(this, current());
darin@google.com965e5342008-08-06 08:16:41 +0900168
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900169 DCHECK(!run_loop_);
darin@google.com0e500502008-09-09 14:55:35 +0900170
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900171 // Clean up any unprocessed tasks, but take care: deleting a task could
172 // result in the addition of more tasks (e.g., via DeleteSoon). We set a
173 // limit on the number of times we will allow a deleted task to generate more
174 // tasks. Normally, we should only pass through this loop once or twice. If
175 // we end up hitting the loop limit, then it is probably due to one task that
176 // is being stubborn. Inspect the queues to see who is left.
177 bool did_work;
178 for (int i = 0; i < 100; ++i) {
179 DeletePendingTasks();
180 ReloadWorkQueue();
181 // If we end up with empty queues, then break out of the loop.
182 did_work = DeletePendingTasks();
183 if (!did_work)
184 break;
darin@google.com0e500502008-09-09 14:55:35 +0900185 }
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900186 DCHECK(!did_work);
187
sanjeevr@chromium.org03b44d52010-11-30 09:25:29 +0900188 // Let interested parties have one last shot at accessing this.
189 FOR_EACH_OBSERVER(DestructionObserver, destruction_observers_,
190 WillDestroyCurrentMessageLoop());
191
sergeyu@chromium.org675d8882012-05-10 05:16:14 +0900192 thread_task_runner_handle_.reset();
193
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900194 // Tell the incoming queue that we are dying.
195 incoming_task_queue_->WillDestroyCurrentMessageLoop();
196 incoming_task_queue_ = NULL;
nduca@chromium.orgba048612011-08-16 05:33:46 +0900197 message_loop_proxy_ = NULL;
198
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900199 // OK, now make it so that no one can find us.
deanm@chromium.orge4cc5922008-09-10 20:14:56 +0900200 lazy_tls_ptr.Pointer()->Set(NULL);
initial.commit3f4a7322008-07-27 06:49:38 +0900201}
202
erg@google.com67a25432011-01-08 05:23:43 +0900203// static
204MessageLoop* MessageLoop::current() {
205 // TODO(darin): sadly, we cannot enable this yet since people call us even
206 // when they have no intention of using us.
207 // DCHECK(loop) << "Ouch, did you forget to initialize me?";
208 return lazy_tls_ptr.Pointer()->Get();
209}
210
211// static
212void MessageLoop::EnableHistogrammer(bool enable) {
213 enable_histogrammer_ = enable;
214}
215
michaelbai@google.com686190b2011-08-03 01:11:16 +0900216// static
nileshagrawal@chromium.org64f02502013-01-30 06:55:55 +0900217bool MessageLoop::InitMessagePumpForUIFactory(MessagePumpFactory* factory) {
218 if (message_pump_for_ui_factory_)
219 return false;
220
michaelbai@google.com686190b2011-08-03 01:11:16 +0900221 message_pump_for_ui_factory_ = factory;
nileshagrawal@chromium.org64f02502013-01-30 06:55:55 +0900222 return true;
michaelbai@google.com686190b2011-08-03 01:11:16 +0900223}
224
sky@chromium.org4f426822013-11-13 01:35:02 +0900225// static
226MessagePump* MessageLoop::CreateMessagePumpForType(Type type) {
227// TODO(rvargas): Get rid of the OS guards.
228#if defined(OS_WIN)
229#define MESSAGE_PUMP_UI new MessagePumpForUI()
230#define MESSAGE_PUMP_IO new MessagePumpForIO()
231#elif defined(OS_IOS)
232#define MESSAGE_PUMP_UI MessagePumpMac::Create()
233#define MESSAGE_PUMP_IO new MessagePumpIOSForIO()
234#elif defined(OS_MACOSX)
235#define MESSAGE_PUMP_UI MessagePumpMac::Create()
236#define MESSAGE_PUMP_IO new MessagePumpLibevent()
237#elif defined(OS_NACL)
238// Currently NaCl doesn't have a UI MessageLoop.
239// TODO(abarth): Figure out if we need this.
240#define MESSAGE_PUMP_UI NULL
241// ipc_channel_nacl.cc uses a worker thread to do socket reads currently, and
242// doesn't require extra support for watching file descriptors.
243#define MESSAGE_PUMP_IO new MessagePumpDefault()
244#elif defined(OS_POSIX) // POSIX but not MACOSX.
245#define MESSAGE_PUMP_UI new MessagePumpForUI()
246#define MESSAGE_PUMP_IO new MessagePumpLibevent()
247#else
248#error Not implemented
249#endif
250
251 if (type == MessageLoop::TYPE_UI) {
252 if (message_pump_for_ui_factory_)
253 return message_pump_for_ui_factory_();
254 return MESSAGE_PUMP_UI;
255 }
256 if (type == MessageLoop::TYPE_IO)
257 return MESSAGE_PUMP_IO;
258#if defined(TOOLKIT_GTK)
259 if (type == MessageLoop::TYPE_GPU)
260 return new MessagePumpX11();
261#endif
262#if defined(OS_ANDROID)
263 if (type == MessageLoop::TYPE_JAVA)
264 return MESSAGE_PUMP_UI;
265#endif
266 DCHECK_EQ(MessageLoop::TYPE_DEFAULT, type);
267 return new MessagePumpDefault();
268}
269
sky@chromium.org18c66dc2010-09-16 07:14:36 +0900270void MessageLoop::AddDestructionObserver(
271 DestructionObserver* destruction_observer) {
thestig@chromium.org226880a2010-11-11 05:28:06 +0900272 DCHECK_EQ(this, current());
sky@chromium.org18c66dc2010-09-16 07:14:36 +0900273 destruction_observers_.AddObserver(destruction_observer);
darin@google.com965e5342008-08-06 08:16:41 +0900274}
275
sky@chromium.org18c66dc2010-09-16 07:14:36 +0900276void MessageLoop::RemoveDestructionObserver(
277 DestructionObserver* destruction_observer) {
thestig@chromium.org226880a2010-11-11 05:28:06 +0900278 DCHECK_EQ(this, current());
sky@chromium.org18c66dc2010-09-16 07:14:36 +0900279 destruction_observers_.RemoveObserver(destruction_observer);
darin@google.com965e5342008-08-06 08:16:41 +0900280}
281
darin@google.combe165ae2008-09-07 17:08:29 +0900282void MessageLoop::PostTask(
cpu@chromium.org209e5422013-04-30 17:54:17 +0900283 const tracked_objects::Location& from_here,
284 const Closure& task) {
brettw@chromium.org5faed3c2011-10-27 06:48:00 +0900285 DCHECK(!task.is_null()) << from_here.ToString();
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900286 incoming_task_queue_->AddToIncomingQueue(from_here, task, TimeDelta(), true);
cpu@chromium.org209e5422013-04-30 17:54:17 +0900287}
288
289bool MessageLoop::TryPostTask(
290 const tracked_objects::Location& from_here,
291 const Closure& task) {
292 DCHECK(!task.is_null()) << from_here.ToString();
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900293 return incoming_task_queue_->TryAddToIncomingQueue(from_here, task);
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900294}
295
296void MessageLoop::PostDelayedTask(
tedvessenes@gmail.com658a87f2011-12-30 10:04:36 +0900297 const tracked_objects::Location& from_here,
brettw@chromium.org87994282013-03-31 11:29:20 +0900298 const Closure& task,
tedvessenes@gmail.comc9fdf902012-06-22 02:31:56 +0900299 TimeDelta delay) {
brettw@chromium.org5faed3c2011-10-27 06:48:00 +0900300 DCHECK(!task.is_null()) << from_here.ToString();
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900301 incoming_task_queue_->AddToIncomingQueue(from_here, task, delay, true);
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900302}
303
304void MessageLoop::PostNonNestableTask(
tedvessenes@gmail.comc9fdf902012-06-22 02:31:56 +0900305 const tracked_objects::Location& from_here,
brettw@chromium.org87994282013-03-31 11:29:20 +0900306 const Closure& task) {
brettw@chromium.org5faed3c2011-10-27 06:48:00 +0900307 DCHECK(!task.is_null()) << from_here.ToString();
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900308 incoming_task_queue_->AddToIncomingQueue(from_here, task, TimeDelta(), false);
darin@google.combe165ae2008-09-07 17:08:29 +0900309}
310
tedvessenes@gmail.com658a87f2011-12-30 10:04:36 +0900311void MessageLoop::PostNonNestableDelayedTask(
312 const tracked_objects::Location& from_here,
brettw@chromium.org87994282013-03-31 11:29:20 +0900313 const Closure& task,
tedvessenes@gmail.comc9fdf902012-06-22 02:31:56 +0900314 TimeDelta delay) {
315 DCHECK(!task.is_null()) << from_here.ToString();
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900316 incoming_task_queue_->AddToIncomingQueue(from_here, task, delay, false);
tedvessenes@gmail.com658a87f2011-12-30 10:04:36 +0900317}
318
erg@google.com67a25432011-01-08 05:23:43 +0900319void MessageLoop::Run() {
brettw@chromium.org87994282013-03-31 11:29:20 +0900320 RunLoop run_loop;
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900321 run_loop.Run();
erg@google.com67a25432011-01-08 05:23:43 +0900322}
darin@google.com0795f572008-08-30 09:22:48 +0900323
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900324void MessageLoop::RunUntilIdle() {
brettw@chromium.org87994282013-03-31 11:29:20 +0900325 RunLoop run_loop;
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900326 run_loop.RunUntilIdle();
erg@google.com67a25432011-01-08 05:23:43 +0900327}
darin@google.com0795f572008-08-30 09:22:48 +0900328
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900329void MessageLoop::QuitWhenIdle() {
erg@google.com67a25432011-01-08 05:23:43 +0900330 DCHECK_EQ(this, current());
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900331 if (run_loop_) {
332 run_loop_->quit_when_idle_received_ = true;
darin@google.com0795f572008-08-30 09:22:48 +0900333 } else {
erg@google.com67a25432011-01-08 05:23:43 +0900334 NOTREACHED() << "Must be inside Run to call Quit";
darin@google.com0795f572008-08-30 09:22:48 +0900335 }
erg@google.com67a25432011-01-08 05:23:43 +0900336}
darin@google.com0795f572008-08-30 09:22:48 +0900337
erg@google.com67a25432011-01-08 05:23:43 +0900338void MessageLoop::QuitNow() {
339 DCHECK_EQ(this, current());
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900340 if (run_loop_) {
erg@google.com67a25432011-01-08 05:23:43 +0900341 pump_->Quit();
342 } else {
343 NOTREACHED() << "Must be inside Run to call Quit";
mbelshe@chromium.orgde50b7d2010-06-29 13:58:15 +0900344 }
initial.commit3f4a7322008-07-27 06:49:38 +0900345}
346
smckay@chromium.orgac93be32012-07-21 09:26:32 +0900347bool MessageLoop::IsType(Type type) const {
348 return type_ == type;
349}
350
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900351static void QuitCurrentWhenIdle() {
352 MessageLoop::current()->QuitWhenIdle();
kalman@chromium.orgc89ed902011-10-21 15:21:57 +0900353}
354
jhawkins@chromium.org573d4182011-10-17 10:20:36 +0900355// static
brettw@chromium.org87994282013-03-31 11:29:20 +0900356Closure MessageLoop::QuitWhenIdleClosure() {
357 return Bind(&QuitCurrentWhenIdle);
jhawkins@chromium.org573d4182011-10-17 10:20:36 +0900358}
359
initial.commit3f4a7322008-07-27 06:49:38 +0900360void MessageLoop::SetNestableTasksAllowed(bool allowed) {
mpcomplete@google.com989d5f82008-08-09 09:14:09 +0900361 if (nestable_tasks_allowed_ != allowed) {
362 nestable_tasks_allowed_ = allowed;
363 if (!nestable_tasks_allowed_)
364 return;
365 // Start the native pump if we are not already pumping.
darin@google.com981f3552008-08-16 12:09:05 +0900366 pump_->ScheduleWork();
mpcomplete@google.com989d5f82008-08-09 09:14:09 +0900367 }
initial.commit3f4a7322008-07-27 06:49:38 +0900368}
369
370bool MessageLoop::NestableTasksAllowed() const {
371 return nestable_tasks_allowed_;
372}
373
jcampan@chromium.orgeac57172009-07-02 04:53:59 +0900374bool MessageLoop::IsNested() {
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900375 return run_loop_->run_depth_ > 1;
jcampan@chromium.orgeac57172009-07-02 04:53:59 +0900376}
377
erg@google.com67a25432011-01-08 05:23:43 +0900378void MessageLoop::AddTaskObserver(TaskObserver* task_observer) {
379 DCHECK_EQ(this, current());
380 task_observers_.AddObserver(task_observer);
381}
382
383void MessageLoop::RemoveTaskObserver(TaskObserver* task_observer) {
384 DCHECK_EQ(this, current());
385 task_observers_.RemoveObserver(task_observer);
386}
387
willchan@chromium.orgfe2201e2011-11-02 07:06:58 +0900388bool MessageLoop::is_running() const {
389 DCHECK_EQ(this, current());
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900390 return run_loop_ != NULL;
willchan@chromium.orgfe2201e2011-11-02 07:06:58 +0900391}
392
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900393bool MessageLoop::IsHighResolutionTimerEnabledForTesting() {
394 return incoming_task_queue_->IsHighResolutionTimerEnabledForTesting();
395}
396
397bool MessageLoop::IsIdleForTesting() {
398 // We only check the imcoming queue|, since we don't want to lock the work
399 // queue.
400 return incoming_task_queue_->IsIdleForTesting();
401}
402
403void MessageLoop::LockWaitUnLockForTesting(WaitableEvent* caller_wait,
404 WaitableEvent* caller_signal) {
405 incoming_task_queue_->LockWaitUnLockForTesting(caller_wait, caller_signal);
406}
407
initial.commit3f4a7322008-07-27 06:49:38 +0900408//------------------------------------------------------------------------------
initial.commit3f4a7322008-07-27 06:49:38 +0900409
sky@chromium.orgab452802013-11-08 15:16:53 +0900410void MessageLoop::Init() {
411 DCHECK(!current()) << "should only have one message loop per thread";
412 lazy_tls_ptr.Pointer()->Set(this);
413
414 incoming_task_queue_ = new internal::IncomingTaskQueue(this);
415 message_loop_proxy_ =
416 new internal::MessageLoopProxyImpl(incoming_task_queue_);
417 thread_task_runner_handle_.reset(
418 new ThreadTaskRunnerHandle(message_loop_proxy_));
419}
420
erg@google.com67a25432011-01-08 05:23:43 +0900421// Runs the loop in two different SEH modes:
422// enable_SEH_restoration_ = false : any unhandled exception goes to the last
423// one that calls SetUnhandledExceptionFilter().
424// enable_SEH_restoration_ = true : any unhandled exception goes to the filter
425// that was existed before the loop was run.
426void MessageLoop::RunHandler() {
427#if defined(OS_WIN)
428 if (exception_restoration_) {
429 RunInternalInSEHFrame();
430 return;
431 }
432#endif
433
434 RunInternal();
435}
436
437#if defined(OS_WIN)
438__declspec(noinline) void MessageLoop::RunInternalInSEHFrame() {
439 LPTOP_LEVEL_EXCEPTION_FILTER current_filter = GetTopSEHFilter();
440 __try {
441 RunInternal();
442 } __except(SEHFilter(current_filter)) {
443 }
444 return;
445}
446#endif
447
448void MessageLoop::RunInternal() {
449 DCHECK_EQ(this, current());
450
451 StartHistogrammer();
452
sadrul@chromium.orga06ba832013-09-07 10:13:39 +0900453#if !defined(OS_MACOSX) && !defined(OS_ANDROID) && \
454 !defined(USE_GTK_MESSAGE_PUMP)
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900455 if (run_loop_->dispatcher_ && type() == TYPE_UI) {
brettw@chromium.org87994282013-03-31 11:29:20 +0900456 static_cast<MessagePumpForUI*>(pump_.get())->
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900457 RunWithDispatcher(this, run_loop_->dispatcher_);
erg@google.com67a25432011-01-08 05:23:43 +0900458 return;
459 }
460#endif
461
462 pump_->Run(this);
463}
464
465bool MessageLoop::ProcessNextDelayedNonNestableTask() {
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900466 if (run_loop_->run_depth_ != 1)
erg@google.com67a25432011-01-08 05:23:43 +0900467 return false;
468
469 if (deferred_non_nestable_work_queue_.empty())
470 return false;
471
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900472 PendingTask pending_task = deferred_non_nestable_work_queue_.front();
erg@google.com67a25432011-01-08 05:23:43 +0900473 deferred_non_nestable_work_queue_.pop();
474
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900475 RunTask(pending_task);
erg@google.com67a25432011-01-08 05:23:43 +0900476 return true;
477}
478
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900479void MessageLoop::RunTask(const PendingTask& pending_task) {
wangxianzhu@chromium.org115411e2013-07-11 02:50:22 +0900480 tracked_objects::TrackedTime start_time =
481 tracked_objects::ThreadData::NowForStartOfRun(pending_task.birth_tally);
482
483 TRACE_EVENT_FLOW_END1("task", "MessageLoop::PostTask",
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900484 TRACE_ID_MANGLE(GetTaskTraceID(pending_task)),
wangxianzhu@chromium.org115411e2013-07-11 02:50:22 +0900485 "queue_duration",
486 (start_time - pending_task.EffectiveTimePosted()).InMilliseconds());
jamescook@chromium.org61cbab12013-08-24 12:26:42 +0900487 // When tracing memory for posted tasks it's more valuable to attribute the
488 // memory allocations to the source function than generically to "RunTask".
489 TRACE_EVENT_WITH_MEMORY_TAG2(
490 "task", "MessageLoop::RunTask",
491 pending_task.posted_from.function_name(), // Name for memory tracking.
492 "src_file", pending_task.posted_from.file_name(),
493 "src_func", pending_task.posted_from.function_name());
wangxianzhu@chromium.org115411e2013-07-11 02:50:22 +0900494
initial.commit3f4a7322008-07-27 06:49:38 +0900495 DCHECK(nestable_tasks_allowed_);
496 // Execute the task and assume the worst: It is probably not reentrant.
497 nestable_tasks_allowed_ = false;
darin@google.combe165ae2008-09-07 17:08:29 +0900498
apatrick@chromium.org87164042011-05-20 07:28:25 +0900499 // Before running the task, store the program counter where it was posted
500 // and deliberately alias it to ensure it is on the stack if the task
501 // crashes. Be careful not to assume that the variable itself will have the
502 // expected value when displayed by the optimizer in an optimized build.
503 // Look at a memory dump of the stack.
jbates@chromium.orgb84db522011-10-04 02:51:25 +0900504 const void* program_counter =
505 pending_task.posted_from.program_counter();
brettw@chromium.org87994282013-03-31 11:29:20 +0900506 debug::Alias(&program_counter);
apatrick@chromium.org87164042011-05-20 07:28:25 +0900507
darin@google.combe165ae2008-09-07 17:08:29 +0900508 HistogramEvent(kTaskRunEvent);
jar@chromium.org79a58c32011-10-16 08:52:45 +0900509
willchan@chromium.orga9047632010-06-10 06:20:41 +0900510 FOR_EACH_OBSERVER(TaskObserver, task_observers_,
rtenneti@chromium.org41712b02013-02-03 17:16:24 +0900511 WillProcessTask(pending_task));
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900512 pending_task.task.Run();
513 FOR_EACH_OBSERVER(TaskObserver, task_observers_,
rtenneti@chromium.org41712b02013-02-03 17:16:24 +0900514 DidProcessTask(pending_task));
jar@chromium.org4be2cb02011-11-01 07:36:21 +0900515
516 tracked_objects::ThreadData::TallyRunOnNamedThreadIfTracking(pending_task,
jar@chromium.orgb536eef2011-11-14 14:24:07 +0900517 start_time, tracked_objects::ThreadData::NowForEndOfRun());
darin@google.combe165ae2008-09-07 17:08:29 +0900518
519 nestable_tasks_allowed_ = true;
initial.commit3f4a7322008-07-27 06:49:38 +0900520}
521
jar@chromium.org79a58c32011-10-16 08:52:45 +0900522bool MessageLoop::DeferOrRunPendingTask(const PendingTask& pending_task) {
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900523 if (pending_task.nestable || run_loop_->run_depth_ == 1) {
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900524 RunTask(pending_task);
darin@google.combe165ae2008-09-07 17:08:29 +0900525 // Show that we ran a task (Note: a new one might arrive as a
526 // consequence!).
527 return true;
528 }
529
530 // We couldn't run the task now because we're in a nested message loop
531 // and the task isn't nestable.
532 deferred_non_nestable_work_queue_.push(pending_task);
533 return false;
initial.commit3f4a7322008-07-27 06:49:38 +0900534}
535
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900536void MessageLoop::AddToDelayedWorkQueue(const PendingTask& pending_task) {
jbates@chromium.org7cc80332012-09-18 12:41:29 +0900537 // Move to the delayed work queue.
538 delayed_work_queue_.push(pending_task);
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900539}
540
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900541bool MessageLoop::DeletePendingTasks() {
542 bool did_work = !work_queue_.empty();
543 while (!work_queue_.empty()) {
544 PendingTask pending_task = work_queue_.front();
545 work_queue_.pop();
546 if (!pending_task.delayed_run_time.is_null()) {
547 // We want to delete delayed tasks in the same order in which they would
548 // normally be deleted in case of any funny dependencies between delayed
549 // tasks.
550 AddToDelayedWorkQueue(pending_task);
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900551 }
initial.commit3f4a7322008-07-27 06:49:38 +0900552 }
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900553 did_work |= !deferred_non_nestable_work_queue_.empty();
554 while (!deferred_non_nestable_work_queue_.empty()) {
jar@chromium.org2fa6b4b2009-03-12 04:53:50 +0900555 deferred_non_nestable_work_queue_.pop();
initial.commit3f4a7322008-07-27 06:49:38 +0900556 }
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900557 did_work |= !delayed_work_queue_.empty();
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900558
559 // Historically, we always delete the task regardless of valgrind status. It's
560 // not completely clear why we want to leak them in the loops above. This
561 // code is replicating legacy behavior, and should not be considered
562 // absolutely "correct" behavior. See TODO above about deleting all tasks
563 // when it's safe.
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900564 while (!delayed_work_queue_.empty()) {
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900565 delayed_work_queue_.pop();
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900566 }
567 return did_work;
initial.commit3f4a7322008-07-27 06:49:38 +0900568}
569
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900570uint64 MessageLoop::GetTaskTraceID(const PendingTask& task) {
571 return (static_cast<uint64>(task.sequence_num) << 32) |
dsinclair@chromium.orgf04ffb02013-08-20 10:49:35 +0900572 ((static_cast<uint64>(reinterpret_cast<intptr_t>(this)) << 32) >> 32);
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900573}
574
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900575void MessageLoop::ReloadWorkQueue() {
576 // We can improve performance of our loading tasks from the incoming queue to
577 // |*work_queue| by waiting until the last minute (|*work_queue| is empty) to
578 // load. That reduces the number of locks-per-task significantly when our
579 // queues get large.
580 if (work_queue_.empty())
581 incoming_task_queue_->ReloadWorkQueue(&work_queue_);
582}
erg@google.com67a25432011-01-08 05:23:43 +0900583
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900584void MessageLoop::ScheduleWork(bool was_empty) {
585 // The Android UI message loop needs to get notified each time
586 // a task is added to the incoming queue.
587 if (was_empty || AlwaysNotifyPump(type_))
588 pump_->ScheduleWork();
erg@google.com67a25432011-01-08 05:23:43 +0900589}
590
591//------------------------------------------------------------------------------
592// Method and data for histogramming events and actions taken by each instance
593// on each thread.
594
595void MessageLoop::StartHistogrammer() {
bbudge@chromium.org5685aad2012-10-28 22:09:33 +0900596#if !defined(OS_NACL) // NaCl build has no metrics code.
jar@chromium.org34571142011-04-05 13:48:53 +0900597 if (enable_histogrammer_ && !message_histogram_
brettw@chromium.org87994282013-03-31 11:29:20 +0900598 && StatisticsRecorder::IsActive()) {
erg@google.com67a25432011-01-08 05:23:43 +0900599 DCHECK(!thread_name_.empty());
brettw@chromium.org87994282013-03-31 11:29:20 +0900600 message_histogram_ = LinearHistogram::FactoryGetWithRangeDescription(
erg@google.com67a25432011-01-08 05:23:43 +0900601 "MsgLoop:" + thread_name_,
602 kLeastNonZeroMessageId, kMaxMessageId,
603 kNumberOfDistinctMessagesDisplayed,
kaiwang@chromium.org7c950a82012-10-31 15:20:25 +0900604 message_histogram_->kHexRangePrintingFlag,
605 event_descriptions_);
erg@google.com67a25432011-01-08 05:23:43 +0900606 }
bbudge@chromium.org5685aad2012-10-28 22:09:33 +0900607#endif
erg@google.com67a25432011-01-08 05:23:43 +0900608}
609
610void MessageLoop::HistogramEvent(int event) {
bbudge@chromium.org5685aad2012-10-28 22:09:33 +0900611#if !defined(OS_NACL)
jar@chromium.org34571142011-04-05 13:48:53 +0900612 if (message_histogram_)
erg@google.com67a25432011-01-08 05:23:43 +0900613 message_histogram_->Add(event);
bbudge@chromium.org5685aad2012-10-28 22:09:33 +0900614#endif
erg@google.com67a25432011-01-08 05:23:43 +0900615}
616
darin@google.com981f3552008-08-16 12:09:05 +0900617bool MessageLoop::DoWork() {
darin@google.combe165ae2008-09-07 17:08:29 +0900618 if (!nestable_tasks_allowed_) {
619 // Task can't be executed right now.
620 return false;
621 }
622
623 for (;;) {
624 ReloadWorkQueue();
625 if (work_queue_.empty())
626 break;
627
628 // Execute oldest task.
629 do {
630 PendingTask pending_task = work_queue_.front();
631 work_queue_.pop();
632 if (!pending_task.delayed_run_time.is_null()) {
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900633 AddToDelayedWorkQueue(pending_task);
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900634 // If we changed the topmost task, then it is time to reschedule.
635 if (delayed_work_queue_.top().task.Equals(pending_task.task))
darin@google.combe165ae2008-09-07 17:08:29 +0900636 pump_->ScheduleDelayedWork(pending_task.delayed_run_time);
637 } else {
638 if (DeferOrRunPendingTask(pending_task))
639 return true;
640 }
641 } while (!work_queue_.empty());
642 }
643
644 // Nothing happened.
645 return false;
darin@google.com981f3552008-08-16 12:09:05 +0900646}
647
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900648bool MessageLoop::DoDelayedWork(TimeTicks* next_delayed_work_time) {
jar@chromium.org40355072010-10-21 15:32:33 +0900649 if (!nestable_tasks_allowed_ || delayed_work_queue_.empty()) {
jar@chromium.org9b0fb062010-11-07 07:23:29 +0900650 recent_time_ = *next_delayed_work_time = TimeTicks();
darin@google.combe165ae2008-09-07 17:08:29 +0900651 return false;
652 }
jeremy@chromium.org2ed223c2008-12-09 02:36:06 +0900653
jar@chromium.org9b0fb062010-11-07 07:23:29 +0900654 // When we "fall behind," there will be a lot of tasks in the delayed work
jar@chromium.org94f73832010-11-05 08:23:42 +0900655 // queue that are ready to run. To increase efficiency when we fall behind,
656 // we will only call Time::Now() intermittently, and then process all tasks
657 // that are ready to run before calling it again. As a result, the more we
658 // fall behind (and have a lot of ready-to-run delayed tasks), the more
659 // efficient we'll be at handling the tasks.
jar@chromium.org9b0fb062010-11-07 07:23:29 +0900660
661 TimeTicks next_run_time = delayed_work_queue_.top().delayed_run_time;
jar@chromium.org94f73832010-11-05 08:23:42 +0900662 if (next_run_time > recent_time_) {
jar@chromium.org9b0fb062010-11-07 07:23:29 +0900663 recent_time_ = TimeTicks::Now(); // Get a better view of Now();
jar@chromium.org94f73832010-11-05 08:23:42 +0900664 if (next_run_time > recent_time_) {
665 *next_delayed_work_time = next_run_time;
666 return false;
667 }
darin@google.combe165ae2008-09-07 17:08:29 +0900668 }
darin@google.com981f3552008-08-16 12:09:05 +0900669
jar@chromium.org40355072010-10-21 15:32:33 +0900670 PendingTask pending_task = delayed_work_queue_.top();
671 delayed_work_queue_.pop();
jeremy@chromium.org2ed223c2008-12-09 02:36:06 +0900672
jar@chromium.org40355072010-10-21 15:32:33 +0900673 if (!delayed_work_queue_.empty())
darin@google.combe165ae2008-09-07 17:08:29 +0900674 *next_delayed_work_time = delayed_work_queue_.top().delayed_run_time;
darin@google.com981f3552008-08-16 12:09:05 +0900675
darin@google.combe165ae2008-09-07 17:08:29 +0900676 return DeferOrRunPendingTask(pending_task);
darin@google.com981f3552008-08-16 12:09:05 +0900677}
678
679bool MessageLoop::DoIdleWork() {
680 if (ProcessNextDelayedNonNestableTask())
681 return true;
682
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900683 if (run_loop_->quit_when_idle_received_)
darin@google.com981f3552008-08-16 12:09:05 +0900684 pump_->Quit();
685
686 return false;
687}
688
rsesek@chromium.orgee8420d2013-09-05 23:53:12 +0900689void MessageLoop::GetQueueingInformation(size_t* queue_size,
690 TimeDelta* queueing_delay) {
691 *queue_size = work_queue_.size();
692 if (*queue_size == 0) {
693 *queueing_delay = TimeDelta();
694 return;
695 }
696
697 const PendingTask& next_to_run = work_queue_.front();
698 tracked_objects::Duration duration =
699 tracked_objects::TrackedTime::Now() - next_to_run.EffectiveTimePosted();
700 *queueing_delay = TimeDelta::FromMilliseconds(duration.InMilliseconds());
701}
702
dcheng@chromium.org36904742011-12-30 13:32:58 +0900703void MessageLoop::DeleteSoonInternal(const tracked_objects::Location& from_here,
704 void(*deleter)(const void*),
705 const void* object) {
brettw@chromium.org87994282013-03-31 11:29:20 +0900706 PostNonNestableTask(from_here, Bind(deleter, object));
dcheng@chromium.org36904742011-12-30 13:32:58 +0900707}
708
dcheng@chromium.org2116fc92011-12-30 15:46:30 +0900709void MessageLoop::ReleaseSoonInternal(
710 const tracked_objects::Location& from_here,
711 void(*releaser)(const void*),
712 const void* object) {
brettw@chromium.org87994282013-03-31 11:29:20 +0900713 PostNonNestableTask(from_here, Bind(releaser, object));
dcheng@chromium.org2116fc92011-12-30 15:46:30 +0900714}
715
darin@google.com981f3552008-08-16 12:09:05 +0900716//------------------------------------------------------------------------------
darin@google.comd936b5b2008-08-26 14:53:57 +0900717// MessageLoopForUI
718
michaelbai@google.com686190b2011-08-03 01:11:16 +0900719#if defined(OS_ANDROID)
720void MessageLoopForUI::Start() {
721 // No Histogram support for UI message loop as it is managed by Java side
brettw@chromium.org87994282013-03-31 11:29:20 +0900722 static_cast<MessagePumpForUI*>(pump_.get())->Start(this);
michaelbai@google.com686190b2011-08-03 01:11:16 +0900723}
724#endif
725
rohitrao@chromium.orgdcc49022012-07-13 20:02:57 +0900726#if defined(OS_IOS)
727void MessageLoopForUI::Attach() {
brettw@chromium.org87994282013-03-31 11:29:20 +0900728 static_cast<MessagePumpUIApplication*>(pump_.get())->Attach(this);
rohitrao@chromium.orgdcc49022012-07-13 20:02:57 +0900729}
730#endif
731
michaelbai@google.com686190b2011-08-03 01:11:16 +0900732#if !defined(OS_MACOSX) && !defined(OS_NACL) && !defined(OS_ANDROID)
jcampan@chromium.org05423582009-08-01 07:53:37 +0900733void MessageLoopForUI::AddObserver(Observer* observer) {
734 pump_ui()->AddObserver(observer);
735}
736
737void MessageLoopForUI::RemoveObserver(Observer* observer) {
738 pump_ui()->RemoveObserver(observer);
739}
740
michaelbai@google.com686190b2011-08-03 01:11:16 +0900741#endif // !defined(OS_MACOSX) && !defined(OS_NACL) && !defined(OS_ANDROID)
jcampan@chromium.org05423582009-08-01 07:53:37 +0900742
darin@google.comd936b5b2008-08-26 14:53:57 +0900743//------------------------------------------------------------------------------
744// MessageLoopForIO
745
746#if defined(OS_WIN)
747
rvargas@google.com9e49aa22008-10-10 08:58:43 +0900748void MessageLoopForIO::RegisterIOHandler(HANDLE file, IOHandler* handler) {
749 pump_io()->RegisterIOHandler(file, handler);
750}
751
alexeypa@chromium.org03c65ac2012-08-17 06:28:11 +0900752bool MessageLoopForIO::RegisterJobObject(HANDLE job, IOHandler* handler) {
753 return pump_io()->RegisterJobObject(job, handler);
754}
755
rvargas@google.com73887542008-11-08 06:52:15 +0900756bool MessageLoopForIO::WaitForIOCompletion(DWORD timeout, IOHandler* filter) {
757 return pump_io()->WaitForIOCompletion(timeout, filter);
rvargas@google.com9e49aa22008-10-10 08:58:43 +0900758}
759
blundell@chromium.orge21b2aa2012-12-01 02:29:40 +0900760#elif defined(OS_IOS)
761
762bool MessageLoopForIO::WatchFileDescriptor(int fd,
763 bool persistent,
764 Mode mode,
765 FileDescriptorWatcher *controller,
766 Watcher *delegate) {
767 return pump_io()->WatchFileDescriptor(
768 fd,
769 persistent,
770 mode,
771 controller,
772 delegate);
773}
774
abarth@chromium.org1f1c2172010-12-01 17:45:51 +0900775#elif defined(OS_POSIX) && !defined(OS_NACL)
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900776
jeremy@chromium.orgefc0db02008-12-16 07:02:17 +0900777bool MessageLoopForIO::WatchFileDescriptor(int fd,
778 bool persistent,
779 Mode mode,
780 FileDescriptorWatcher *controller,
781 Watcher *delegate) {
782 return pump_libevent()->WatchFileDescriptor(
783 fd,
784 persistent,
blundell@chromium.orge21b2aa2012-12-01 02:29:40 +0900785 mode,
jeremy@chromium.orgefc0db02008-12-16 07:02:17 +0900786 controller,
787 delegate);
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900788}
789
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900790#endif
brettw@chromium.org87994282013-03-31 11:29:20 +0900791
792} // namespace base