blob: 0ca6e81efabce6f9176f080b5ce9b3a5aa7142fd [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
brettw@chromium.org87994282013-03-31 11:29:20 +090036namespace base {
dsh@google.com0f8dd262008-10-28 05:43:33 +090037
erg@chromium.orga7528522010-07-16 02:23:23 +090038namespace {
39
deanm@chromium.orgcd1ce302008-09-10 19:54:06 +090040// A lazily created thread local storage for quick access to a thread's message
41// loop, if one exists. This should be safe and free of static constructors.
earthdok@chromium.org80d362f82013-08-28 16:51:19 +090042LazyInstance<base::ThreadLocalPointer<MessageLoop> >::Leaky lazy_tls_ptr =
joth@chromium.orgb24883c2011-11-15 22:31:49 +090043 LAZY_INSTANCE_INITIALIZER;
initial.commit3f4a7322008-07-27 06:49:38 +090044
initial.commit3f4a7322008-07-27 06:49:38 +090045// Logical events for Histogram profiling. Run with -message-loop-histogrammer
46// to get an accounting of messages and actions taken on each thread.
erg@chromium.orga7528522010-07-16 02:23:23 +090047const int kTaskRunEvent = 0x1;
mseaborn@chromium.org8c703642014-03-04 15:04:39 +090048#if !defined(OS_NACL)
erg@chromium.orga7528522010-07-16 02:23:23 +090049const int kTimerEvent = 0x2;
initial.commit3f4a7322008-07-27 06:49:38 +090050
51// Provide range of message IDs for use in histogramming and debug display.
erg@chromium.orga7528522010-07-16 02:23:23 +090052const int kLeastNonZeroMessageId = 1;
53const int kMaxMessageId = 1099;
54const int kNumberOfDistinctMessagesDisplayed = 1100;
55
56// Provide a macro that takes an expression (such as a constant, or macro
57// constant) and creates a pair to initalize an array of pairs. In this case,
58// our pair consists of the expressions value, and the "stringized" version
59// of the expression (i.e., the exrpression put in quotes). For example, if
60// we have:
61// #define FOO 2
62// #define BAR 5
63// then the following:
64// VALUE_TO_NUMBER_AND_NAME(FOO + BAR)
65// will expand to:
66// {7, "FOO + BAR"}
67// We use the resulting array as an argument to our histogram, which reads the
68// number as a bucket identifier, and proceeds to use the corresponding name
69// in the pair (i.e., the quoted string) when printing out a histogram.
70#define VALUE_TO_NUMBER_AND_NAME(name) {name, #name},
71
brettw@chromium.org87994282013-03-31 11:29:20 +090072const LinearHistogram::DescriptionPair event_descriptions_[] = {
erg@chromium.orga7528522010-07-16 02:23:23 +090073 // Provide some pretty print capability in our histogram for our internal
74 // messages.
75
76 // A few events we handle (kindred to messages), and used to profile actions.
77 VALUE_TO_NUMBER_AND_NAME(kTaskRunEvent)
78 VALUE_TO_NUMBER_AND_NAME(kTimerEvent)
79
80 {-1, NULL} // The list must be null terminated, per API to histogram.
81};
mseaborn@chromium.org8c703642014-03-04 15:04:39 +090082#endif // !defined(OS_NACL)
erg@chromium.orga7528522010-07-16 02:23:23 +090083
84bool enable_histogrammer_ = false;
85
michaelbai@google.com686190b2011-08-03 01:11:16 +090086MessageLoop::MessagePumpFactory* message_pump_for_ui_factory_ = NULL;
87
kristianm@chromium.orgd7557e82013-07-12 12:19:55 +090088// Returns true if MessagePump::ScheduleWork() must be called one
89// time for every task that is added to the MessageLoop incoming queue.
90bool AlwaysNotifyPump(MessageLoop::Type type) {
91#if defined(OS_ANDROID)
kristianm@chromium.orga78bfa92013-08-08 10:31:52 +090092 return type == MessageLoop::TYPE_UI || type == MessageLoop::TYPE_JAVA;
kristianm@chromium.orgd7557e82013-07-12 12:19:55 +090093#else
94 return false;
95#endif
96}
97
erg@chromium.orga7528522010-07-16 02:23:23 +090098} // namespace
initial.commit3f4a7322008-07-27 06:49:38 +090099
100//------------------------------------------------------------------------------
101
erg@chromium.org493f5f62010-07-16 06:03:54 +0900102MessageLoop::TaskObserver::TaskObserver() {
103}
104
105MessageLoop::TaskObserver::~TaskObserver() {
106}
107
108MessageLoop::DestructionObserver::~DestructionObserver() {
109}
110
111//------------------------------------------------------------------------------
112
darin@google.comd936b5b2008-08-26 14:53:57 +0900113MessageLoop::MessageLoop(Type type)
114 : type_(type),
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900115 nestable_tasks_allowed_(true),
dbeam@chromium.orge8888492013-03-24 04:10:54 +0900116#if defined(OS_WIN)
ananta@chromium.orgc542fec2011-03-24 12:40:28 +0900117 os_modal_loop_(false),
118#endif // OS_WIN
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900119 message_histogram_(NULL),
120 run_loop_(NULL) {
sky@chromium.orgab452802013-11-08 15:16:53 +0900121 Init();
nduca@chromium.orgba048612011-08-16 05:33:46 +0900122
suyash.s@samsung.comb5f1fc92014-03-08 02:03:54 +0900123 pump_ = CreateMessagePumpForType(type).Pass();
initial.commit3f4a7322008-07-27 06:49:38 +0900124}
125
sky@chromium.orgab452802013-11-08 15:16:53 +0900126MessageLoop::MessageLoop(scoped_ptr<MessagePump> pump)
127 : pump_(pump.Pass()),
128 type_(TYPE_CUSTOM),
sky@chromium.orgab452802013-11-08 15:16:53 +0900129 nestable_tasks_allowed_(true),
130#if defined(OS_WIN)
131 os_modal_loop_(false),
132#endif // OS_WIN
133 message_histogram_(NULL),
134 run_loop_(NULL) {
135 DCHECK(pump_.get());
136 Init();
137}
138
initial.commit3f4a7322008-07-27 06:49:38 +0900139MessageLoop::~MessageLoop() {
thestig@chromium.org226880a2010-11-11 05:28:06 +0900140 DCHECK_EQ(this, current());
darin@google.com965e5342008-08-06 08:16:41 +0900141
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900142 DCHECK(!run_loop_);
darin@google.com0e500502008-09-09 14:55:35 +0900143
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900144 // Clean up any unprocessed tasks, but take care: deleting a task could
145 // result in the addition of more tasks (e.g., via DeleteSoon). We set a
146 // limit on the number of times we will allow a deleted task to generate more
147 // tasks. Normally, we should only pass through this loop once or twice. If
148 // we end up hitting the loop limit, then it is probably due to one task that
149 // is being stubborn. Inspect the queues to see who is left.
150 bool did_work;
151 for (int i = 0; i < 100; ++i) {
152 DeletePendingTasks();
153 ReloadWorkQueue();
154 // If we end up with empty queues, then break out of the loop.
155 did_work = DeletePendingTasks();
156 if (!did_work)
157 break;
darin@google.com0e500502008-09-09 14:55:35 +0900158 }
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900159 DCHECK(!did_work);
160
sanjeevr@chromium.org03b44d52010-11-30 09:25:29 +0900161 // Let interested parties have one last shot at accessing this.
162 FOR_EACH_OBSERVER(DestructionObserver, destruction_observers_,
163 WillDestroyCurrentMessageLoop());
164
sergeyu@chromium.org675d8882012-05-10 05:16:14 +0900165 thread_task_runner_handle_.reset();
166
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900167 // Tell the incoming queue that we are dying.
168 incoming_task_queue_->WillDestroyCurrentMessageLoop();
169 incoming_task_queue_ = NULL;
nduca@chromium.orgba048612011-08-16 05:33:46 +0900170 message_loop_proxy_ = NULL;
171
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900172 // OK, now make it so that no one can find us.
deanm@chromium.orge4cc5922008-09-10 20:14:56 +0900173 lazy_tls_ptr.Pointer()->Set(NULL);
initial.commit3f4a7322008-07-27 06:49:38 +0900174}
175
erg@google.com67a25432011-01-08 05:23:43 +0900176// static
177MessageLoop* MessageLoop::current() {
178 // TODO(darin): sadly, we cannot enable this yet since people call us even
179 // when they have no intention of using us.
180 // DCHECK(loop) << "Ouch, did you forget to initialize me?";
181 return lazy_tls_ptr.Pointer()->Get();
182}
183
184// static
185void MessageLoop::EnableHistogrammer(bool enable) {
186 enable_histogrammer_ = enable;
187}
188
michaelbai@google.com686190b2011-08-03 01:11:16 +0900189// static
nileshagrawal@chromium.org64f02502013-01-30 06:55:55 +0900190bool MessageLoop::InitMessagePumpForUIFactory(MessagePumpFactory* factory) {
191 if (message_pump_for_ui_factory_)
192 return false;
193
michaelbai@google.com686190b2011-08-03 01:11:16 +0900194 message_pump_for_ui_factory_ = factory;
nileshagrawal@chromium.org64f02502013-01-30 06:55:55 +0900195 return true;
michaelbai@google.com686190b2011-08-03 01:11:16 +0900196}
197
sky@chromium.org4f426822013-11-13 01:35:02 +0900198// static
suyash.s@samsung.comb5f1fc92014-03-08 02:03:54 +0900199scoped_ptr<MessagePump> MessageLoop::CreateMessagePumpForType(Type type) {
sky@chromium.org4f426822013-11-13 01:35:02 +0900200// TODO(rvargas): Get rid of the OS guards.
201#if defined(OS_WIN)
suyash.s@samsung.comb5f1fc92014-03-08 02:03:54 +0900202#define MESSAGE_PUMP_UI scoped_ptr<MessagePump>(new MessagePumpForUI())
203#define MESSAGE_PUMP_IO scoped_ptr<MessagePump>(new MessagePumpForIO())
sky@chromium.org4f426822013-11-13 01:35:02 +0900204#elif defined(OS_IOS)
suyash.s@samsung.comb5f1fc92014-03-08 02:03:54 +0900205#define MESSAGE_PUMP_UI scoped_ptr<MessagePump>(MessagePumpMac::Create())
206#define MESSAGE_PUMP_IO scoped_ptr<MessagePump>(new MessagePumpIOSForIO())
sky@chromium.org4f426822013-11-13 01:35:02 +0900207#elif defined(OS_MACOSX)
suyash.s@samsung.comb5f1fc92014-03-08 02:03:54 +0900208#define MESSAGE_PUMP_UI scoped_ptr<MessagePump>(MessagePumpMac::Create())
209#define MESSAGE_PUMP_IO scoped_ptr<MessagePump>(new MessagePumpLibevent())
sky@chromium.org4f426822013-11-13 01:35:02 +0900210#elif defined(OS_NACL)
211// Currently NaCl doesn't have a UI MessageLoop.
212// TODO(abarth): Figure out if we need this.
suyash.s@samsung.comb5f1fc92014-03-08 02:03:54 +0900213#define MESSAGE_PUMP_UI scoped_ptr<MessagePump>()
sky@chromium.org4f426822013-11-13 01:35:02 +0900214// ipc_channel_nacl.cc uses a worker thread to do socket reads currently, and
215// doesn't require extra support for watching file descriptors.
suyash.s@samsung.comb5f1fc92014-03-08 02:03:54 +0900216#define MESSAGE_PUMP_IO scoped_ptr<MessagePump>(new MessagePumpDefault())
sadrul@chromium.org7aff5f62014-04-11 02:19:38 +0900217#elif defined(USE_OZONE)
218#define MESSAGE_PUMP_UI scoped_ptr<MessagePump>(new MessagePumpLibevent())
219#define MESSAGE_PUMP_IO scoped_ptr<MessagePump>(new MessagePumpLibevent())
sky@chromium.org4f426822013-11-13 01:35:02 +0900220#elif defined(OS_POSIX) // POSIX but not MACOSX.
suyash.s@samsung.comb5f1fc92014-03-08 02:03:54 +0900221#define MESSAGE_PUMP_UI scoped_ptr<MessagePump>(new MessagePumpForUI())
222#define MESSAGE_PUMP_IO scoped_ptr<MessagePump>(new MessagePumpLibevent())
sky@chromium.org4f426822013-11-13 01:35:02 +0900223#else
224#error Not implemented
225#endif
226
227 if (type == MessageLoop::TYPE_UI) {
228 if (message_pump_for_ui_factory_)
229 return message_pump_for_ui_factory_();
230 return MESSAGE_PUMP_UI;
231 }
232 if (type == MessageLoop::TYPE_IO)
233 return MESSAGE_PUMP_IO;
sky@chromium.org4f426822013-11-13 01:35:02 +0900234#if defined(OS_ANDROID)
235 if (type == MessageLoop::TYPE_JAVA)
236 return MESSAGE_PUMP_UI;
237#endif
238 DCHECK_EQ(MessageLoop::TYPE_DEFAULT, type);
suyash.s@samsung.comb5f1fc92014-03-08 02:03:54 +0900239 return scoped_ptr<MessagePump>(new MessagePumpDefault());
sky@chromium.org4f426822013-11-13 01:35:02 +0900240}
241
sky@chromium.org18c66dc2010-09-16 07:14:36 +0900242void MessageLoop::AddDestructionObserver(
243 DestructionObserver* destruction_observer) {
thestig@chromium.org226880a2010-11-11 05:28:06 +0900244 DCHECK_EQ(this, current());
sky@chromium.org18c66dc2010-09-16 07:14:36 +0900245 destruction_observers_.AddObserver(destruction_observer);
darin@google.com965e5342008-08-06 08:16:41 +0900246}
247
sky@chromium.org18c66dc2010-09-16 07:14:36 +0900248void MessageLoop::RemoveDestructionObserver(
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_.RemoveObserver(destruction_observer);
darin@google.com965e5342008-08-06 08:16:41 +0900252}
253
darin@google.combe165ae2008-09-07 17:08:29 +0900254void MessageLoop::PostTask(
cpu@chromium.org209e5422013-04-30 17:54:17 +0900255 const tracked_objects::Location& from_here,
256 const Closure& task) {
brettw@chromium.org5faed3c2011-10-27 06:48:00 +0900257 DCHECK(!task.is_null()) << from_here.ToString();
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900258 incoming_task_queue_->AddToIncomingQueue(from_here, task, TimeDelta(), true);
cpu@chromium.org209e5422013-04-30 17:54:17 +0900259}
260
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900261void MessageLoop::PostDelayedTask(
tedvessenes@gmail.com658a87f2011-12-30 10:04:36 +0900262 const tracked_objects::Location& from_here,
brettw@chromium.org87994282013-03-31 11:29:20 +0900263 const Closure& task,
tedvessenes@gmail.comc9fdf902012-06-22 02:31:56 +0900264 TimeDelta delay) {
brettw@chromium.org5faed3c2011-10-27 06:48:00 +0900265 DCHECK(!task.is_null()) << from_here.ToString();
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900266 incoming_task_queue_->AddToIncomingQueue(from_here, task, delay, true);
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900267}
268
269void MessageLoop::PostNonNestableTask(
tedvessenes@gmail.comc9fdf902012-06-22 02:31:56 +0900270 const tracked_objects::Location& from_here,
brettw@chromium.org87994282013-03-31 11:29:20 +0900271 const Closure& task) {
brettw@chromium.org5faed3c2011-10-27 06:48:00 +0900272 DCHECK(!task.is_null()) << from_here.ToString();
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900273 incoming_task_queue_->AddToIncomingQueue(from_here, task, TimeDelta(), false);
darin@google.combe165ae2008-09-07 17:08:29 +0900274}
275
tedvessenes@gmail.com658a87f2011-12-30 10:04:36 +0900276void MessageLoop::PostNonNestableDelayedTask(
277 const tracked_objects::Location& from_here,
brettw@chromium.org87994282013-03-31 11:29:20 +0900278 const Closure& task,
tedvessenes@gmail.comc9fdf902012-06-22 02:31:56 +0900279 TimeDelta delay) {
280 DCHECK(!task.is_null()) << from_here.ToString();
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900281 incoming_task_queue_->AddToIncomingQueue(from_here, task, delay, false);
tedvessenes@gmail.com658a87f2011-12-30 10:04:36 +0900282}
283
erg@google.com67a25432011-01-08 05:23:43 +0900284void MessageLoop::Run() {
brettw@chromium.org87994282013-03-31 11:29:20 +0900285 RunLoop run_loop;
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900286 run_loop.Run();
erg@google.com67a25432011-01-08 05:23:43 +0900287}
darin@google.com0795f572008-08-30 09:22:48 +0900288
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900289void MessageLoop::RunUntilIdle() {
brettw@chromium.org87994282013-03-31 11:29:20 +0900290 RunLoop run_loop;
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900291 run_loop.RunUntilIdle();
erg@google.com67a25432011-01-08 05:23:43 +0900292}
darin@google.com0795f572008-08-30 09:22:48 +0900293
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900294void MessageLoop::QuitWhenIdle() {
erg@google.com67a25432011-01-08 05:23:43 +0900295 DCHECK_EQ(this, current());
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900296 if (run_loop_) {
297 run_loop_->quit_when_idle_received_ = true;
darin@google.com0795f572008-08-30 09:22:48 +0900298 } else {
erg@google.com67a25432011-01-08 05:23:43 +0900299 NOTREACHED() << "Must be inside Run to call Quit";
darin@google.com0795f572008-08-30 09:22:48 +0900300 }
erg@google.com67a25432011-01-08 05:23:43 +0900301}
darin@google.com0795f572008-08-30 09:22:48 +0900302
erg@google.com67a25432011-01-08 05:23:43 +0900303void MessageLoop::QuitNow() {
304 DCHECK_EQ(this, current());
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900305 if (run_loop_) {
erg@google.com67a25432011-01-08 05:23:43 +0900306 pump_->Quit();
307 } else {
308 NOTREACHED() << "Must be inside Run to call Quit";
mbelshe@chromium.orgde50b7d2010-06-29 13:58:15 +0900309 }
initial.commit3f4a7322008-07-27 06:49:38 +0900310}
311
smckay@chromium.orgac93be32012-07-21 09:26:32 +0900312bool MessageLoop::IsType(Type type) const {
313 return type_ == type;
314}
315
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900316static void QuitCurrentWhenIdle() {
317 MessageLoop::current()->QuitWhenIdle();
kalman@chromium.orgc89ed902011-10-21 15:21:57 +0900318}
319
jhawkins@chromium.org573d4182011-10-17 10:20:36 +0900320// static
brettw@chromium.org87994282013-03-31 11:29:20 +0900321Closure MessageLoop::QuitWhenIdleClosure() {
322 return Bind(&QuitCurrentWhenIdle);
jhawkins@chromium.org573d4182011-10-17 10:20:36 +0900323}
324
initial.commit3f4a7322008-07-27 06:49:38 +0900325void MessageLoop::SetNestableTasksAllowed(bool allowed) {
jamesr@chromium.orgeba99672013-11-21 15:11:01 +0900326 if (allowed) {
327 // Kick the native pump just in case we enter a OS-driven nested message
328 // loop.
darin@google.com981f3552008-08-16 12:09:05 +0900329 pump_->ScheduleWork();
mpcomplete@google.com989d5f82008-08-09 09:14:09 +0900330 }
jamesr@chromium.orgeba99672013-11-21 15:11:01 +0900331 nestable_tasks_allowed_ = allowed;
initial.commit3f4a7322008-07-27 06:49:38 +0900332}
333
334bool MessageLoop::NestableTasksAllowed() const {
335 return nestable_tasks_allowed_;
336}
337
jcampan@chromium.orgeac57172009-07-02 04:53:59 +0900338bool MessageLoop::IsNested() {
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900339 return run_loop_->run_depth_ > 1;
jcampan@chromium.orgeac57172009-07-02 04:53:59 +0900340}
341
erg@google.com67a25432011-01-08 05:23:43 +0900342void MessageLoop::AddTaskObserver(TaskObserver* task_observer) {
343 DCHECK_EQ(this, current());
344 task_observers_.AddObserver(task_observer);
345}
346
347void MessageLoop::RemoveTaskObserver(TaskObserver* task_observer) {
348 DCHECK_EQ(this, current());
349 task_observers_.RemoveObserver(task_observer);
350}
351
willchan@chromium.orgfe2201e2011-11-02 07:06:58 +0900352bool MessageLoop::is_running() const {
353 DCHECK_EQ(this, current());
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900354 return run_loop_ != NULL;
willchan@chromium.orgfe2201e2011-11-02 07:06:58 +0900355}
356
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900357bool MessageLoop::IsHighResolutionTimerEnabledForTesting() {
358 return incoming_task_queue_->IsHighResolutionTimerEnabledForTesting();
359}
360
361bool MessageLoop::IsIdleForTesting() {
362 // We only check the imcoming queue|, since we don't want to lock the work
363 // queue.
364 return incoming_task_queue_->IsIdleForTesting();
365}
366
initial.commit3f4a7322008-07-27 06:49:38 +0900367//------------------------------------------------------------------------------
initial.commit3f4a7322008-07-27 06:49:38 +0900368
sky@chromium.orgab452802013-11-08 15:16:53 +0900369void MessageLoop::Init() {
370 DCHECK(!current()) << "should only have one message loop per thread";
371 lazy_tls_ptr.Pointer()->Set(this);
372
373 incoming_task_queue_ = new internal::IncomingTaskQueue(this);
374 message_loop_proxy_ =
375 new internal::MessageLoopProxyImpl(incoming_task_queue_);
376 thread_task_runner_handle_.reset(
377 new ThreadTaskRunnerHandle(message_loop_proxy_));
378}
379
erg@google.com67a25432011-01-08 05:23:43 +0900380void MessageLoop::RunHandler() {
erg@google.com67a25432011-01-08 05:23:43 +0900381 DCHECK_EQ(this, current());
382
383 StartHistogrammer();
384
sadrul@chromium.orgbe4515c2014-04-06 00:24:03 +0900385#if defined(OS_WIN)
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900386 if (run_loop_->dispatcher_ && type() == TYPE_UI) {
brettw@chromium.org87994282013-03-31 11:29:20 +0900387 static_cast<MessagePumpForUI*>(pump_.get())->
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900388 RunWithDispatcher(this, run_loop_->dispatcher_);
erg@google.com67a25432011-01-08 05:23:43 +0900389 return;
390 }
391#endif
392
393 pump_->Run(this);
394}
395
396bool MessageLoop::ProcessNextDelayedNonNestableTask() {
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900397 if (run_loop_->run_depth_ != 1)
erg@google.com67a25432011-01-08 05:23:43 +0900398 return false;
399
400 if (deferred_non_nestable_work_queue_.empty())
401 return false;
402
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900403 PendingTask pending_task = deferred_non_nestable_work_queue_.front();
erg@google.com67a25432011-01-08 05:23:43 +0900404 deferred_non_nestable_work_queue_.pop();
405
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900406 RunTask(pending_task);
erg@google.com67a25432011-01-08 05:23:43 +0900407 return true;
408}
409
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900410void MessageLoop::RunTask(const PendingTask& pending_task) {
wangxianzhu@chromium.org115411e2013-07-11 02:50:22 +0900411 tracked_objects::TrackedTime start_time =
412 tracked_objects::ThreadData::NowForStartOfRun(pending_task.birth_tally);
413
fmeawad@chromium.org4529a9d2014-02-07 03:28:53 +0900414 TRACE_EVENT_FLOW_END1(TRACE_DISABLED_BY_DEFAULT("toplevel.flow"),
415 "MessageLoop::PostTask", TRACE_ID_MANGLE(GetTaskTraceID(pending_task)),
wangxianzhu@chromium.org115411e2013-07-11 02:50:22 +0900416 "queue_duration",
417 (start_time - pending_task.EffectiveTimePosted()).InMilliseconds());
jamescook@chromium.org61cbab12013-08-24 12:26:42 +0900418 // When tracing memory for posted tasks it's more valuable to attribute the
419 // memory allocations to the source function than generically to "RunTask".
420 TRACE_EVENT_WITH_MEMORY_TAG2(
fmeawad@chromium.org4529a9d2014-02-07 03:28:53 +0900421 "toplevel", "MessageLoop::RunTask",
jamescook@chromium.org61cbab12013-08-24 12:26:42 +0900422 pending_task.posted_from.function_name(), // Name for memory tracking.
423 "src_file", pending_task.posted_from.file_name(),
424 "src_func", pending_task.posted_from.function_name());
wangxianzhu@chromium.org115411e2013-07-11 02:50:22 +0900425
initial.commit3f4a7322008-07-27 06:49:38 +0900426 DCHECK(nestable_tasks_allowed_);
427 // Execute the task and assume the worst: It is probably not reentrant.
428 nestable_tasks_allowed_ = false;
darin@google.combe165ae2008-09-07 17:08:29 +0900429
apatrick@chromium.org87164042011-05-20 07:28:25 +0900430 // Before running the task, store the program counter where it was posted
431 // and deliberately alias it to ensure it is on the stack if the task
432 // crashes. Be careful not to assume that the variable itself will have the
433 // expected value when displayed by the optimizer in an optimized build.
434 // Look at a memory dump of the stack.
jbates@chromium.orgb84db522011-10-04 02:51:25 +0900435 const void* program_counter =
436 pending_task.posted_from.program_counter();
brettw@chromium.org87994282013-03-31 11:29:20 +0900437 debug::Alias(&program_counter);
apatrick@chromium.org87164042011-05-20 07:28:25 +0900438
darin@google.combe165ae2008-09-07 17:08:29 +0900439 HistogramEvent(kTaskRunEvent);
jar@chromium.org79a58c32011-10-16 08:52:45 +0900440
willchan@chromium.orga9047632010-06-10 06:20:41 +0900441 FOR_EACH_OBSERVER(TaskObserver, task_observers_,
rtenneti@chromium.org41712b02013-02-03 17:16:24 +0900442 WillProcessTask(pending_task));
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900443 pending_task.task.Run();
444 FOR_EACH_OBSERVER(TaskObserver, task_observers_,
rtenneti@chromium.org41712b02013-02-03 17:16:24 +0900445 DidProcessTask(pending_task));
jar@chromium.org4be2cb02011-11-01 07:36:21 +0900446
447 tracked_objects::ThreadData::TallyRunOnNamedThreadIfTracking(pending_task,
jar@chromium.orgb536eef2011-11-14 14:24:07 +0900448 start_time, tracked_objects::ThreadData::NowForEndOfRun());
darin@google.combe165ae2008-09-07 17:08:29 +0900449
450 nestable_tasks_allowed_ = true;
initial.commit3f4a7322008-07-27 06:49:38 +0900451}
452
jar@chromium.org79a58c32011-10-16 08:52:45 +0900453bool MessageLoop::DeferOrRunPendingTask(const PendingTask& pending_task) {
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900454 if (pending_task.nestable || run_loop_->run_depth_ == 1) {
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900455 RunTask(pending_task);
darin@google.combe165ae2008-09-07 17:08:29 +0900456 // Show that we ran a task (Note: a new one might arrive as a
457 // consequence!).
458 return true;
459 }
460
461 // We couldn't run the task now because we're in a nested message loop
462 // and the task isn't nestable.
463 deferred_non_nestable_work_queue_.push(pending_task);
464 return false;
initial.commit3f4a7322008-07-27 06:49:38 +0900465}
466
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900467void MessageLoop::AddToDelayedWorkQueue(const PendingTask& pending_task) {
jbates@chromium.org7cc80332012-09-18 12:41:29 +0900468 // Move to the delayed work queue.
469 delayed_work_queue_.push(pending_task);
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900470}
471
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900472bool MessageLoop::DeletePendingTasks() {
473 bool did_work = !work_queue_.empty();
474 while (!work_queue_.empty()) {
475 PendingTask pending_task = work_queue_.front();
476 work_queue_.pop();
477 if (!pending_task.delayed_run_time.is_null()) {
478 // We want to delete delayed tasks in the same order in which they would
479 // normally be deleted in case of any funny dependencies between delayed
480 // tasks.
481 AddToDelayedWorkQueue(pending_task);
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900482 }
initial.commit3f4a7322008-07-27 06:49:38 +0900483 }
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900484 did_work |= !deferred_non_nestable_work_queue_.empty();
485 while (!deferred_non_nestable_work_queue_.empty()) {
jar@chromium.org2fa6b4b2009-03-12 04:53:50 +0900486 deferred_non_nestable_work_queue_.pop();
initial.commit3f4a7322008-07-27 06:49:38 +0900487 }
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900488 did_work |= !delayed_work_queue_.empty();
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900489
490 // Historically, we always delete the task regardless of valgrind status. It's
491 // not completely clear why we want to leak them in the loops above. This
492 // code is replicating legacy behavior, and should not be considered
493 // absolutely "correct" behavior. See TODO above about deleting all tasks
494 // when it's safe.
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900495 while (!delayed_work_queue_.empty()) {
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900496 delayed_work_queue_.pop();
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900497 }
498 return did_work;
initial.commit3f4a7322008-07-27 06:49:38 +0900499}
500
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900501uint64 MessageLoop::GetTaskTraceID(const PendingTask& task) {
502 return (static_cast<uint64>(task.sequence_num) << 32) |
dsinclair@chromium.orgf04ffb02013-08-20 10:49:35 +0900503 ((static_cast<uint64>(reinterpret_cast<intptr_t>(this)) << 32) >> 32);
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900504}
505
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900506void MessageLoop::ReloadWorkQueue() {
507 // We can improve performance of our loading tasks from the incoming queue to
508 // |*work_queue| by waiting until the last minute (|*work_queue| is empty) to
509 // load. That reduces the number of locks-per-task significantly when our
510 // queues get large.
511 if (work_queue_.empty())
512 incoming_task_queue_->ReloadWorkQueue(&work_queue_);
513}
erg@google.com67a25432011-01-08 05:23:43 +0900514
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900515void MessageLoop::ScheduleWork(bool was_empty) {
516 // The Android UI message loop needs to get notified each time
517 // a task is added to the incoming queue.
518 if (was_empty || AlwaysNotifyPump(type_))
519 pump_->ScheduleWork();
erg@google.com67a25432011-01-08 05:23:43 +0900520}
521
522//------------------------------------------------------------------------------
523// Method and data for histogramming events and actions taken by each instance
524// on each thread.
525
526void MessageLoop::StartHistogrammer() {
bbudge@chromium.org5685aad2012-10-28 22:09:33 +0900527#if !defined(OS_NACL) // NaCl build has no metrics code.
jar@chromium.org34571142011-04-05 13:48:53 +0900528 if (enable_histogrammer_ && !message_histogram_
brettw@chromium.org87994282013-03-31 11:29:20 +0900529 && StatisticsRecorder::IsActive()) {
erg@google.com67a25432011-01-08 05:23:43 +0900530 DCHECK(!thread_name_.empty());
brettw@chromium.org87994282013-03-31 11:29:20 +0900531 message_histogram_ = LinearHistogram::FactoryGetWithRangeDescription(
erg@google.com67a25432011-01-08 05:23:43 +0900532 "MsgLoop:" + thread_name_,
533 kLeastNonZeroMessageId, kMaxMessageId,
534 kNumberOfDistinctMessagesDisplayed,
kaiwang@chromium.org7c950a82012-10-31 15:20:25 +0900535 message_histogram_->kHexRangePrintingFlag,
536 event_descriptions_);
erg@google.com67a25432011-01-08 05:23:43 +0900537 }
bbudge@chromium.org5685aad2012-10-28 22:09:33 +0900538#endif
erg@google.com67a25432011-01-08 05:23:43 +0900539}
540
541void MessageLoop::HistogramEvent(int event) {
bbudge@chromium.org5685aad2012-10-28 22:09:33 +0900542#if !defined(OS_NACL)
jar@chromium.org34571142011-04-05 13:48:53 +0900543 if (message_histogram_)
erg@google.com67a25432011-01-08 05:23:43 +0900544 message_histogram_->Add(event);
bbudge@chromium.org5685aad2012-10-28 22:09:33 +0900545#endif
erg@google.com67a25432011-01-08 05:23:43 +0900546}
547
darin@google.com981f3552008-08-16 12:09:05 +0900548bool MessageLoop::DoWork() {
darin@google.combe165ae2008-09-07 17:08:29 +0900549 if (!nestable_tasks_allowed_) {
550 // Task can't be executed right now.
551 return false;
552 }
553
554 for (;;) {
555 ReloadWorkQueue();
556 if (work_queue_.empty())
557 break;
558
559 // Execute oldest task.
560 do {
561 PendingTask pending_task = work_queue_.front();
562 work_queue_.pop();
563 if (!pending_task.delayed_run_time.is_null()) {
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900564 AddToDelayedWorkQueue(pending_task);
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900565 // If we changed the topmost task, then it is time to reschedule.
566 if (delayed_work_queue_.top().task.Equals(pending_task.task))
darin@google.combe165ae2008-09-07 17:08:29 +0900567 pump_->ScheduleDelayedWork(pending_task.delayed_run_time);
568 } else {
569 if (DeferOrRunPendingTask(pending_task))
570 return true;
571 }
572 } while (!work_queue_.empty());
573 }
574
575 // Nothing happened.
576 return false;
darin@google.com981f3552008-08-16 12:09:05 +0900577}
578
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900579bool MessageLoop::DoDelayedWork(TimeTicks* next_delayed_work_time) {
jar@chromium.org40355072010-10-21 15:32:33 +0900580 if (!nestable_tasks_allowed_ || delayed_work_queue_.empty()) {
jar@chromium.org9b0fb062010-11-07 07:23:29 +0900581 recent_time_ = *next_delayed_work_time = TimeTicks();
darin@google.combe165ae2008-09-07 17:08:29 +0900582 return false;
583 }
jeremy@chromium.org2ed223c2008-12-09 02:36:06 +0900584
jar@chromium.org9b0fb062010-11-07 07:23:29 +0900585 // When we "fall behind," there will be a lot of tasks in the delayed work
jar@chromium.org94f73832010-11-05 08:23:42 +0900586 // queue that are ready to run. To increase efficiency when we fall behind,
587 // we will only call Time::Now() intermittently, and then process all tasks
588 // that are ready to run before calling it again. As a result, the more we
589 // fall behind (and have a lot of ready-to-run delayed tasks), the more
590 // efficient we'll be at handling the tasks.
jar@chromium.org9b0fb062010-11-07 07:23:29 +0900591
592 TimeTicks next_run_time = delayed_work_queue_.top().delayed_run_time;
jar@chromium.org94f73832010-11-05 08:23:42 +0900593 if (next_run_time > recent_time_) {
jar@chromium.org9b0fb062010-11-07 07:23:29 +0900594 recent_time_ = TimeTicks::Now(); // Get a better view of Now();
jar@chromium.org94f73832010-11-05 08:23:42 +0900595 if (next_run_time > recent_time_) {
596 *next_delayed_work_time = next_run_time;
597 return false;
598 }
darin@google.combe165ae2008-09-07 17:08:29 +0900599 }
darin@google.com981f3552008-08-16 12:09:05 +0900600
jar@chromium.org40355072010-10-21 15:32:33 +0900601 PendingTask pending_task = delayed_work_queue_.top();
602 delayed_work_queue_.pop();
jeremy@chromium.org2ed223c2008-12-09 02:36:06 +0900603
jar@chromium.org40355072010-10-21 15:32:33 +0900604 if (!delayed_work_queue_.empty())
darin@google.combe165ae2008-09-07 17:08:29 +0900605 *next_delayed_work_time = delayed_work_queue_.top().delayed_run_time;
darin@google.com981f3552008-08-16 12:09:05 +0900606
darin@google.combe165ae2008-09-07 17:08:29 +0900607 return DeferOrRunPendingTask(pending_task);
darin@google.com981f3552008-08-16 12:09:05 +0900608}
609
610bool MessageLoop::DoIdleWork() {
611 if (ProcessNextDelayedNonNestableTask())
612 return true;
613
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900614 if (run_loop_->quit_when_idle_received_)
darin@google.com981f3552008-08-16 12:09:05 +0900615 pump_->Quit();
616
617 return false;
618}
619
rsesek@chromium.orgee8420d2013-09-05 23:53:12 +0900620void MessageLoop::GetQueueingInformation(size_t* queue_size,
621 TimeDelta* queueing_delay) {
622 *queue_size = work_queue_.size();
623 if (*queue_size == 0) {
624 *queueing_delay = TimeDelta();
625 return;
626 }
627
628 const PendingTask& next_to_run = work_queue_.front();
629 tracked_objects::Duration duration =
630 tracked_objects::TrackedTime::Now() - next_to_run.EffectiveTimePosted();
631 *queueing_delay = TimeDelta::FromMilliseconds(duration.InMilliseconds());
632}
633
dcheng@chromium.org36904742011-12-30 13:32:58 +0900634void MessageLoop::DeleteSoonInternal(const tracked_objects::Location& from_here,
635 void(*deleter)(const void*),
636 const void* object) {
brettw@chromium.org87994282013-03-31 11:29:20 +0900637 PostNonNestableTask(from_here, Bind(deleter, object));
dcheng@chromium.org36904742011-12-30 13:32:58 +0900638}
639
dcheng@chromium.org2116fc92011-12-30 15:46:30 +0900640void MessageLoop::ReleaseSoonInternal(
641 const tracked_objects::Location& from_here,
642 void(*releaser)(const void*),
643 const void* object) {
brettw@chromium.org87994282013-03-31 11:29:20 +0900644 PostNonNestableTask(from_here, Bind(releaser, object));
dcheng@chromium.org2116fc92011-12-30 15:46:30 +0900645}
646
darin@google.com981f3552008-08-16 12:09:05 +0900647//------------------------------------------------------------------------------
darin@google.comd936b5b2008-08-26 14:53:57 +0900648// MessageLoopForUI
649
michaelbai@google.com686190b2011-08-03 01:11:16 +0900650#if defined(OS_ANDROID)
651void MessageLoopForUI::Start() {
652 // No Histogram support for UI message loop as it is managed by Java side
brettw@chromium.org87994282013-03-31 11:29:20 +0900653 static_cast<MessagePumpForUI*>(pump_.get())->Start(this);
michaelbai@google.com686190b2011-08-03 01:11:16 +0900654}
655#endif
656
rohitrao@chromium.orgdcc49022012-07-13 20:02:57 +0900657#if defined(OS_IOS)
658void MessageLoopForUI::Attach() {
brettw@chromium.org87994282013-03-31 11:29:20 +0900659 static_cast<MessagePumpUIApplication*>(pump_.get())->Attach(this);
rohitrao@chromium.orgdcc49022012-07-13 20:02:57 +0900660}
661#endif
662
sadrul@chromium.org25e9de22014-04-11 12:02:29 +0900663#if !defined(OS_NACL) && defined(OS_WIN)
jcampan@chromium.org05423582009-08-01 07:53:37 +0900664void MessageLoopForUI::AddObserver(Observer* observer) {
665 pump_ui()->AddObserver(observer);
666}
667
668void MessageLoopForUI::RemoveObserver(Observer* observer) {
669 pump_ui()->RemoveObserver(observer);
670}
sadrul@chromium.org25e9de22014-04-11 12:02:29 +0900671#endif // !defined(OS_NACL) && defined(OS_WIN)
jcampan@chromium.org05423582009-08-01 07:53:37 +0900672
sadrul@chromium.orgea5d6f72014-04-22 01:24:24 +0900673#if !defined(OS_NACL) && \
674 (defined(USE_OZONE) || (defined(OS_CHROMEOS) && !defined(USE_GLIB)))
sadrul@chromium.org7aff5f62014-04-11 02:19:38 +0900675bool MessageLoopForUI::WatchFileDescriptor(
676 int fd,
677 bool persistent,
678 MessagePumpLibevent::Mode mode,
679 MessagePumpLibevent::FileDescriptorWatcher *controller,
680 MessagePumpLibevent::Watcher *delegate) {
681 return pump_libevent()->WatchFileDescriptor(
682 fd,
683 persistent,
684 mode,
685 controller,
686 delegate);
687}
688#endif
689
darin@google.comd936b5b2008-08-26 14:53:57 +0900690//------------------------------------------------------------------------------
691// MessageLoopForIO
692
693#if defined(OS_WIN)
694
rvargas@google.com9e49aa22008-10-10 08:58:43 +0900695void MessageLoopForIO::RegisterIOHandler(HANDLE file, IOHandler* handler) {
696 pump_io()->RegisterIOHandler(file, handler);
697}
698
alexeypa@chromium.org03c65ac2012-08-17 06:28:11 +0900699bool MessageLoopForIO::RegisterJobObject(HANDLE job, IOHandler* handler) {
700 return pump_io()->RegisterJobObject(job, handler);
701}
702
rvargas@google.com73887542008-11-08 06:52:15 +0900703bool MessageLoopForIO::WaitForIOCompletion(DWORD timeout, IOHandler* filter) {
704 return pump_io()->WaitForIOCompletion(timeout, filter);
rvargas@google.com9e49aa22008-10-10 08:58:43 +0900705}
706
blundell@chromium.orge21b2aa2012-12-01 02:29:40 +0900707#elif defined(OS_IOS)
708
709bool MessageLoopForIO::WatchFileDescriptor(int fd,
710 bool persistent,
711 Mode mode,
712 FileDescriptorWatcher *controller,
713 Watcher *delegate) {
714 return pump_io()->WatchFileDescriptor(
715 fd,
716 persistent,
717 mode,
718 controller,
719 delegate);
720}
721
abarth@chromium.org1f1c2172010-12-01 17:45:51 +0900722#elif defined(OS_POSIX) && !defined(OS_NACL)
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900723
jeremy@chromium.orgefc0db02008-12-16 07:02:17 +0900724bool MessageLoopForIO::WatchFileDescriptor(int fd,
725 bool persistent,
726 Mode mode,
727 FileDescriptorWatcher *controller,
728 Watcher *delegate) {
729 return pump_libevent()->WatchFileDescriptor(
730 fd,
731 persistent,
blundell@chromium.orge21b2aa2012-12-01 02:29:40 +0900732 mode,
jeremy@chromium.orgefc0db02008-12-16 07:02:17 +0900733 controller,
734 delegate);
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900735}
736
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900737#endif
brettw@chromium.org87994282013-03-31 11:29:20 +0900738
739} // namespace base