blob: d2eafbd8489fd32c0822ebe9b740c2f560f1c3a2 [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.
brettw@chromium.org87994282013-03-31 11:29:20 +090047LazyInstance<base::ThreadLocalPointer<MessageLoop> > 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)
95 return type == MessageLoop::TYPE_UI;
96#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) {
deanm@chromium.orgcd1ce302008-09-10 19:54:06 +0900147 DCHECK(!current()) << "should only have one message loop per thread";
148 lazy_tls_ptr.Pointer()->Set(this);
darin@google.comd936b5b2008-08-26 14:53:57 +0900149
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900150 incoming_task_queue_ = new internal::IncomingTaskQueue(this);
151 message_loop_proxy_ =
152 new internal::MessageLoopProxyImpl(incoming_task_queue_);
sergeyu@chromium.org675d8882012-05-10 05:16:14 +0900153 thread_task_runner_handle_.reset(
brettw@chromium.org87994282013-03-31 11:29:20 +0900154 new ThreadTaskRunnerHandle(message_loop_proxy_));
nduca@chromium.orgba048612011-08-16 05:33:46 +0900155
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900156// TODO(rvargas): Get rid of the OS guards.
darin@google.com981f3552008-08-16 12:09:05 +0900157#if defined(OS_WIN)
brettw@chromium.org87994282013-03-31 11:29:20 +0900158#define MESSAGE_PUMP_UI new MessagePumpForUI()
159#define MESSAGE_PUMP_IO new MessagePumpForIO()
blundell@chromium.orge21b2aa2012-12-01 02:29:40 +0900160#elif defined(OS_IOS)
brettw@chromium.org87994282013-03-31 11:29:20 +0900161#define MESSAGE_PUMP_UI MessagePumpMac::Create()
162#define MESSAGE_PUMP_IO new MessagePumpIOSForIO()
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900163#elif defined(OS_MACOSX)
brettw@chromium.org87994282013-03-31 11:29:20 +0900164#define MESSAGE_PUMP_UI MessagePumpMac::Create()
165#define MESSAGE_PUMP_IO new MessagePumpLibevent()
abarth@chromium.org1f1c2172010-12-01 17:45:51 +0900166#elif defined(OS_NACL)
dmichael@chromium.orgb798bb42012-06-01 04:37:54 +0900167// Currently NaCl doesn't have a UI MessageLoop.
168// TODO(abarth): Figure out if we need this.
abarth@chromium.org1f1c2172010-12-01 17:45:51 +0900169#define MESSAGE_PUMP_UI NULL
dmichael@chromium.orgb798bb42012-06-01 04:37:54 +0900170// ipc_channel_nacl.cc uses a worker thread to do socket reads currently, and
171// doesn't require extra support for watching file descriptors.
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900172#define MESSAGE_PUMP_IO new MessagePumpDefault()
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900173#elif defined(OS_POSIX) // POSIX but not MACOSX.
brettw@chromium.org87994282013-03-31 11:29:20 +0900174#define MESSAGE_PUMP_UI new MessagePumpForUI()
175#define MESSAGE_PUMP_IO new MessagePumpLibevent()
evan@chromium.org875bb6e2009-12-29 09:32:52 +0900176#else
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900177#error Not implemented
evan@chromium.org875bb6e2009-12-29 09:32:52 +0900178#endif
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900179
180 if (type_ == TYPE_UI) {
michaelbai@google.com686190b2011-08-03 01:11:16 +0900181 if (message_pump_for_ui_factory_)
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900182 pump_.reset(message_pump_for_ui_factory_());
michaelbai@google.com686190b2011-08-03 01:11:16 +0900183 else
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900184 pump_.reset(MESSAGE_PUMP_UI);
dsh@google.com119a2522008-10-04 01:52:59 +0900185 } else if (type_ == TYPE_IO) {
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900186 pump_.reset(MESSAGE_PUMP_IO);
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900187 } else {
thestig@chromium.org7016bac2010-04-15 10:04:29 +0900188 DCHECK_EQ(TYPE_DEFAULT, type_);
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900189 pump_.reset(new MessagePumpDefault());
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900190 }
initial.commit3f4a7322008-07-27 06:49:38 +0900191}
192
193MessageLoop::~MessageLoop() {
thestig@chromium.org226880a2010-11-11 05:28:06 +0900194 DCHECK_EQ(this, current());
darin@google.com965e5342008-08-06 08:16:41 +0900195
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900196 DCHECK(!run_loop_);
darin@google.com0e500502008-09-09 14:55:35 +0900197
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900198 // Clean up any unprocessed tasks, but take care: deleting a task could
199 // result in the addition of more tasks (e.g., via DeleteSoon). We set a
200 // limit on the number of times we will allow a deleted task to generate more
201 // tasks. Normally, we should only pass through this loop once or twice. If
202 // we end up hitting the loop limit, then it is probably due to one task that
203 // is being stubborn. Inspect the queues to see who is left.
204 bool did_work;
205 for (int i = 0; i < 100; ++i) {
206 DeletePendingTasks();
207 ReloadWorkQueue();
208 // If we end up with empty queues, then break out of the loop.
209 did_work = DeletePendingTasks();
210 if (!did_work)
211 break;
darin@google.com0e500502008-09-09 14:55:35 +0900212 }
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900213 DCHECK(!did_work);
214
sanjeevr@chromium.org03b44d52010-11-30 09:25:29 +0900215 // Let interested parties have one last shot at accessing this.
216 FOR_EACH_OBSERVER(DestructionObserver, destruction_observers_,
217 WillDestroyCurrentMessageLoop());
218
sergeyu@chromium.org675d8882012-05-10 05:16:14 +0900219 thread_task_runner_handle_.reset();
220
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900221 // Tell the incoming queue that we are dying.
222 incoming_task_queue_->WillDestroyCurrentMessageLoop();
223 incoming_task_queue_ = NULL;
nduca@chromium.orgba048612011-08-16 05:33:46 +0900224 message_loop_proxy_ = NULL;
225
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900226 // OK, now make it so that no one can find us.
deanm@chromium.orge4cc5922008-09-10 20:14:56 +0900227 lazy_tls_ptr.Pointer()->Set(NULL);
initial.commit3f4a7322008-07-27 06:49:38 +0900228}
229
erg@google.com67a25432011-01-08 05:23:43 +0900230// static
231MessageLoop* MessageLoop::current() {
232 // TODO(darin): sadly, we cannot enable this yet since people call us even
233 // when they have no intention of using us.
234 // DCHECK(loop) << "Ouch, did you forget to initialize me?";
235 return lazy_tls_ptr.Pointer()->Get();
236}
237
238// static
239void MessageLoop::EnableHistogrammer(bool enable) {
240 enable_histogrammer_ = enable;
241}
242
michaelbai@google.com686190b2011-08-03 01:11:16 +0900243// static
nileshagrawal@chromium.org64f02502013-01-30 06:55:55 +0900244bool MessageLoop::InitMessagePumpForUIFactory(MessagePumpFactory* factory) {
245 if (message_pump_for_ui_factory_)
246 return false;
247
michaelbai@google.com686190b2011-08-03 01:11:16 +0900248 message_pump_for_ui_factory_ = factory;
nileshagrawal@chromium.org64f02502013-01-30 06:55:55 +0900249 return true;
michaelbai@google.com686190b2011-08-03 01:11:16 +0900250}
251
sky@chromium.org18c66dc2010-09-16 07:14:36 +0900252void MessageLoop::AddDestructionObserver(
253 DestructionObserver* destruction_observer) {
thestig@chromium.org226880a2010-11-11 05:28:06 +0900254 DCHECK_EQ(this, current());
sky@chromium.org18c66dc2010-09-16 07:14:36 +0900255 destruction_observers_.AddObserver(destruction_observer);
darin@google.com965e5342008-08-06 08:16:41 +0900256}
257
sky@chromium.org18c66dc2010-09-16 07:14:36 +0900258void MessageLoop::RemoveDestructionObserver(
259 DestructionObserver* destruction_observer) {
thestig@chromium.org226880a2010-11-11 05:28:06 +0900260 DCHECK_EQ(this, current());
sky@chromium.org18c66dc2010-09-16 07:14:36 +0900261 destruction_observers_.RemoveObserver(destruction_observer);
darin@google.com965e5342008-08-06 08:16:41 +0900262}
263
darin@google.combe165ae2008-09-07 17:08:29 +0900264void MessageLoop::PostTask(
cpu@chromium.org209e5422013-04-30 17:54:17 +0900265 const tracked_objects::Location& from_here,
266 const Closure& task) {
brettw@chromium.org5faed3c2011-10-27 06:48:00 +0900267 DCHECK(!task.is_null()) << from_here.ToString();
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900268 incoming_task_queue_->AddToIncomingQueue(from_here, task, TimeDelta(), true);
cpu@chromium.org209e5422013-04-30 17:54:17 +0900269}
270
271bool MessageLoop::TryPostTask(
272 const tracked_objects::Location& from_here,
273 const Closure& task) {
274 DCHECK(!task.is_null()) << from_here.ToString();
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900275 return incoming_task_queue_->TryAddToIncomingQueue(from_here, task);
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900276}
277
278void MessageLoop::PostDelayedTask(
tedvessenes@gmail.com658a87f2011-12-30 10:04:36 +0900279 const tracked_objects::Location& from_here,
brettw@chromium.org87994282013-03-31 11:29:20 +0900280 const Closure& task,
tedvessenes@gmail.comc9fdf902012-06-22 02:31:56 +0900281 TimeDelta delay) {
brettw@chromium.org5faed3c2011-10-27 06:48:00 +0900282 DCHECK(!task.is_null()) << from_here.ToString();
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900283 incoming_task_queue_->AddToIncomingQueue(from_here, task, delay, true);
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900284}
285
286void MessageLoop::PostNonNestableTask(
tedvessenes@gmail.comc9fdf902012-06-22 02:31:56 +0900287 const tracked_objects::Location& from_here,
brettw@chromium.org87994282013-03-31 11:29:20 +0900288 const Closure& task) {
brettw@chromium.org5faed3c2011-10-27 06:48:00 +0900289 DCHECK(!task.is_null()) << from_here.ToString();
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900290 incoming_task_queue_->AddToIncomingQueue(from_here, task, TimeDelta(), false);
darin@google.combe165ae2008-09-07 17:08:29 +0900291}
292
tedvessenes@gmail.com658a87f2011-12-30 10:04:36 +0900293void MessageLoop::PostNonNestableDelayedTask(
294 const tracked_objects::Location& from_here,
brettw@chromium.org87994282013-03-31 11:29:20 +0900295 const Closure& task,
tedvessenes@gmail.comc9fdf902012-06-22 02:31:56 +0900296 TimeDelta delay) {
297 DCHECK(!task.is_null()) << from_here.ToString();
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900298 incoming_task_queue_->AddToIncomingQueue(from_here, task, delay, false);
tedvessenes@gmail.com658a87f2011-12-30 10:04:36 +0900299}
300
erg@google.com67a25432011-01-08 05:23:43 +0900301void MessageLoop::Run() {
brettw@chromium.org87994282013-03-31 11:29:20 +0900302 RunLoop run_loop;
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900303 run_loop.Run();
erg@google.com67a25432011-01-08 05:23:43 +0900304}
darin@google.com0795f572008-08-30 09:22:48 +0900305
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900306void MessageLoop::RunUntilIdle() {
brettw@chromium.org87994282013-03-31 11:29:20 +0900307 RunLoop run_loop;
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900308 run_loop.RunUntilIdle();
erg@google.com67a25432011-01-08 05:23:43 +0900309}
darin@google.com0795f572008-08-30 09:22:48 +0900310
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900311void MessageLoop::QuitWhenIdle() {
erg@google.com67a25432011-01-08 05:23:43 +0900312 DCHECK_EQ(this, current());
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900313 if (run_loop_) {
314 run_loop_->quit_when_idle_received_ = true;
darin@google.com0795f572008-08-30 09:22:48 +0900315 } else {
erg@google.com67a25432011-01-08 05:23:43 +0900316 NOTREACHED() << "Must be inside Run to call Quit";
darin@google.com0795f572008-08-30 09:22:48 +0900317 }
erg@google.com67a25432011-01-08 05:23:43 +0900318}
darin@google.com0795f572008-08-30 09:22:48 +0900319
erg@google.com67a25432011-01-08 05:23:43 +0900320void MessageLoop::QuitNow() {
321 DCHECK_EQ(this, current());
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900322 if (run_loop_) {
erg@google.com67a25432011-01-08 05:23:43 +0900323 pump_->Quit();
324 } else {
325 NOTREACHED() << "Must be inside Run to call Quit";
mbelshe@chromium.orgde50b7d2010-06-29 13:58:15 +0900326 }
initial.commit3f4a7322008-07-27 06:49:38 +0900327}
328
smckay@chromium.orgac93be32012-07-21 09:26:32 +0900329bool MessageLoop::IsType(Type type) const {
330 return type_ == type;
331}
332
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900333static void QuitCurrentWhenIdle() {
334 MessageLoop::current()->QuitWhenIdle();
kalman@chromium.orgc89ed902011-10-21 15:21:57 +0900335}
336
jhawkins@chromium.org573d4182011-10-17 10:20:36 +0900337// static
brettw@chromium.org87994282013-03-31 11:29:20 +0900338Closure MessageLoop::QuitWhenIdleClosure() {
339 return Bind(&QuitCurrentWhenIdle);
jhawkins@chromium.org573d4182011-10-17 10:20:36 +0900340}
341
initial.commit3f4a7322008-07-27 06:49:38 +0900342void MessageLoop::SetNestableTasksAllowed(bool allowed) {
mpcomplete@google.com989d5f82008-08-09 09:14:09 +0900343 if (nestable_tasks_allowed_ != allowed) {
344 nestable_tasks_allowed_ = allowed;
345 if (!nestable_tasks_allowed_)
346 return;
347 // Start the native pump if we are not already pumping.
darin@google.com981f3552008-08-16 12:09:05 +0900348 pump_->ScheduleWork();
mpcomplete@google.com989d5f82008-08-09 09:14:09 +0900349 }
initial.commit3f4a7322008-07-27 06:49:38 +0900350}
351
352bool MessageLoop::NestableTasksAllowed() const {
353 return nestable_tasks_allowed_;
354}
355
jcampan@chromium.orgeac57172009-07-02 04:53:59 +0900356bool MessageLoop::IsNested() {
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900357 return run_loop_->run_depth_ > 1;
jcampan@chromium.orgeac57172009-07-02 04:53:59 +0900358}
359
erg@google.com67a25432011-01-08 05:23:43 +0900360void MessageLoop::AddTaskObserver(TaskObserver* task_observer) {
361 DCHECK_EQ(this, current());
362 task_observers_.AddObserver(task_observer);
363}
364
365void MessageLoop::RemoveTaskObserver(TaskObserver* task_observer) {
366 DCHECK_EQ(this, current());
367 task_observers_.RemoveObserver(task_observer);
368}
369
willchan@chromium.orgfe2201e2011-11-02 07:06:58 +0900370bool MessageLoop::is_running() const {
371 DCHECK_EQ(this, current());
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900372 return run_loop_ != NULL;
willchan@chromium.orgfe2201e2011-11-02 07:06:58 +0900373}
374
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900375bool MessageLoop::IsHighResolutionTimerEnabledForTesting() {
376 return incoming_task_queue_->IsHighResolutionTimerEnabledForTesting();
377}
378
379bool MessageLoop::IsIdleForTesting() {
380 // We only check the imcoming queue|, since we don't want to lock the work
381 // queue.
382 return incoming_task_queue_->IsIdleForTesting();
383}
384
385void MessageLoop::LockWaitUnLockForTesting(WaitableEvent* caller_wait,
386 WaitableEvent* caller_signal) {
387 incoming_task_queue_->LockWaitUnLockForTesting(caller_wait, caller_signal);
388}
389
initial.commit3f4a7322008-07-27 06:49:38 +0900390//------------------------------------------------------------------------------
initial.commit3f4a7322008-07-27 06:49:38 +0900391
erg@google.com67a25432011-01-08 05:23:43 +0900392// Runs the loop in two different SEH modes:
393// enable_SEH_restoration_ = false : any unhandled exception goes to the last
394// one that calls SetUnhandledExceptionFilter().
395// enable_SEH_restoration_ = true : any unhandled exception goes to the filter
396// that was existed before the loop was run.
397void MessageLoop::RunHandler() {
398#if defined(OS_WIN)
399 if (exception_restoration_) {
400 RunInternalInSEHFrame();
401 return;
402 }
403#endif
404
405 RunInternal();
406}
407
408#if defined(OS_WIN)
409__declspec(noinline) void MessageLoop::RunInternalInSEHFrame() {
410 LPTOP_LEVEL_EXCEPTION_FILTER current_filter = GetTopSEHFilter();
411 __try {
412 RunInternal();
413 } __except(SEHFilter(current_filter)) {
414 }
415 return;
416}
417#endif
418
419void MessageLoop::RunInternal() {
420 DCHECK_EQ(this, current());
421
422 StartHistogrammer();
423
michaelbai@google.com686190b2011-08-03 01:11:16 +0900424#if !defined(OS_MACOSX) && !defined(OS_ANDROID)
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900425 if (run_loop_->dispatcher_ && type() == TYPE_UI) {
brettw@chromium.org87994282013-03-31 11:29:20 +0900426 static_cast<MessagePumpForUI*>(pump_.get())->
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900427 RunWithDispatcher(this, run_loop_->dispatcher_);
erg@google.com67a25432011-01-08 05:23:43 +0900428 return;
429 }
430#endif
431
432 pump_->Run(this);
433}
434
435bool MessageLoop::ProcessNextDelayedNonNestableTask() {
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900436 if (run_loop_->run_depth_ != 1)
erg@google.com67a25432011-01-08 05:23:43 +0900437 return false;
438
439 if (deferred_non_nestable_work_queue_.empty())
440 return false;
441
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900442 PendingTask pending_task = deferred_non_nestable_work_queue_.front();
erg@google.com67a25432011-01-08 05:23:43 +0900443 deferred_non_nestable_work_queue_.pop();
444
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900445 RunTask(pending_task);
erg@google.com67a25432011-01-08 05:23:43 +0900446 return true;
447}
448
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900449void MessageLoop::RunTask(const PendingTask& pending_task) {
wangxianzhu@chromium.org115411e2013-07-11 02:50:22 +0900450 tracked_objects::TrackedTime start_time =
451 tracked_objects::ThreadData::NowForStartOfRun(pending_task.birth_tally);
452
453 TRACE_EVENT_FLOW_END1("task", "MessageLoop::PostTask",
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900454 TRACE_ID_MANGLE(GetTaskTraceID(pending_task)),
wangxianzhu@chromium.org115411e2013-07-11 02:50:22 +0900455 "queue_duration",
456 (start_time - pending_task.EffectiveTimePosted()).InMilliseconds());
jbates@chromium.org5a97c212012-02-24 04:16:35 +0900457 TRACE_EVENT2("task", "MessageLoop::RunTask",
458 "src_file", pending_task.posted_from.file_name(),
459 "src_func", pending_task.posted_from.function_name());
wangxianzhu@chromium.org115411e2013-07-11 02:50:22 +0900460
initial.commit3f4a7322008-07-27 06:49:38 +0900461 DCHECK(nestable_tasks_allowed_);
462 // Execute the task and assume the worst: It is probably not reentrant.
463 nestable_tasks_allowed_ = false;
darin@google.combe165ae2008-09-07 17:08:29 +0900464
apatrick@chromium.org87164042011-05-20 07:28:25 +0900465 // Before running the task, store the program counter where it was posted
466 // and deliberately alias it to ensure it is on the stack if the task
467 // crashes. Be careful not to assume that the variable itself will have the
468 // expected value when displayed by the optimizer in an optimized build.
469 // Look at a memory dump of the stack.
jbates@chromium.orgb84db522011-10-04 02:51:25 +0900470 const void* program_counter =
471 pending_task.posted_from.program_counter();
brettw@chromium.org87994282013-03-31 11:29:20 +0900472 debug::Alias(&program_counter);
apatrick@chromium.org87164042011-05-20 07:28:25 +0900473
darin@google.combe165ae2008-09-07 17:08:29 +0900474 HistogramEvent(kTaskRunEvent);
jar@chromium.org79a58c32011-10-16 08:52:45 +0900475
willchan@chromium.orga9047632010-06-10 06:20:41 +0900476 FOR_EACH_OBSERVER(TaskObserver, task_observers_,
rtenneti@chromium.org41712b02013-02-03 17:16:24 +0900477 WillProcessTask(pending_task));
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900478 pending_task.task.Run();
479 FOR_EACH_OBSERVER(TaskObserver, task_observers_,
rtenneti@chromium.org41712b02013-02-03 17:16:24 +0900480 DidProcessTask(pending_task));
jar@chromium.org4be2cb02011-11-01 07:36:21 +0900481
482 tracked_objects::ThreadData::TallyRunOnNamedThreadIfTracking(pending_task,
jar@chromium.orgb536eef2011-11-14 14:24:07 +0900483 start_time, tracked_objects::ThreadData::NowForEndOfRun());
darin@google.combe165ae2008-09-07 17:08:29 +0900484
485 nestable_tasks_allowed_ = true;
initial.commit3f4a7322008-07-27 06:49:38 +0900486}
487
jar@chromium.org79a58c32011-10-16 08:52:45 +0900488bool MessageLoop::DeferOrRunPendingTask(const PendingTask& pending_task) {
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900489 if (pending_task.nestable || run_loop_->run_depth_ == 1) {
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900490 RunTask(pending_task);
darin@google.combe165ae2008-09-07 17:08:29 +0900491 // Show that we ran a task (Note: a new one might arrive as a
492 // consequence!).
493 return true;
494 }
495
496 // We couldn't run the task now because we're in a nested message loop
497 // and the task isn't nestable.
498 deferred_non_nestable_work_queue_.push(pending_task);
499 return false;
initial.commit3f4a7322008-07-27 06:49:38 +0900500}
501
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900502void MessageLoop::AddToDelayedWorkQueue(const PendingTask& pending_task) {
jbates@chromium.org7cc80332012-09-18 12:41:29 +0900503 // Move to the delayed work queue.
504 delayed_work_queue_.push(pending_task);
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900505}
506
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900507bool MessageLoop::DeletePendingTasks() {
508 bool did_work = !work_queue_.empty();
509 while (!work_queue_.empty()) {
510 PendingTask pending_task = work_queue_.front();
511 work_queue_.pop();
512 if (!pending_task.delayed_run_time.is_null()) {
513 // We want to delete delayed tasks in the same order in which they would
514 // normally be deleted in case of any funny dependencies between delayed
515 // tasks.
516 AddToDelayedWorkQueue(pending_task);
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900517 }
initial.commit3f4a7322008-07-27 06:49:38 +0900518 }
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900519 did_work |= !deferred_non_nestable_work_queue_.empty();
520 while (!deferred_non_nestable_work_queue_.empty()) {
jar@chromium.org2fa6b4b2009-03-12 04:53:50 +0900521 deferred_non_nestable_work_queue_.pop();
initial.commit3f4a7322008-07-27 06:49:38 +0900522 }
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900523 did_work |= !delayed_work_queue_.empty();
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900524
525 // Historically, we always delete the task regardless of valgrind status. It's
526 // not completely clear why we want to leak them in the loops above. This
527 // code is replicating legacy behavior, and should not be considered
528 // absolutely "correct" behavior. See TODO above about deleting all tasks
529 // when it's safe.
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900530 while (!delayed_work_queue_.empty()) {
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900531 delayed_work_queue_.pop();
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900532 }
533 return did_work;
initial.commit3f4a7322008-07-27 06:49:38 +0900534}
535
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900536uint64 MessageLoop::GetTaskTraceID(const PendingTask& task) {
537 return (static_cast<uint64>(task.sequence_num) << 32) |
538 static_cast<uint64>(reinterpret_cast<intptr_t>(this));
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900539}
540
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900541void MessageLoop::ReloadWorkQueue() {
542 // We can improve performance of our loading tasks from the incoming queue to
543 // |*work_queue| by waiting until the last minute (|*work_queue| is empty) to
544 // load. That reduces the number of locks-per-task significantly when our
545 // queues get large.
546 if (work_queue_.empty())
547 incoming_task_queue_->ReloadWorkQueue(&work_queue_);
548}
erg@google.com67a25432011-01-08 05:23:43 +0900549
alexeypa@chromium.org40183232013-07-23 07:24:13 +0900550void MessageLoop::ScheduleWork(bool was_empty) {
551 // The Android UI message loop needs to get notified each time
552 // a task is added to the incoming queue.
553 if (was_empty || AlwaysNotifyPump(type_))
554 pump_->ScheduleWork();
erg@google.com67a25432011-01-08 05:23:43 +0900555}
556
557//------------------------------------------------------------------------------
558// Method and data for histogramming events and actions taken by each instance
559// on each thread.
560
561void MessageLoop::StartHistogrammer() {
bbudge@chromium.org5685aad2012-10-28 22:09:33 +0900562#if !defined(OS_NACL) // NaCl build has no metrics code.
jar@chromium.org34571142011-04-05 13:48:53 +0900563 if (enable_histogrammer_ && !message_histogram_
brettw@chromium.org87994282013-03-31 11:29:20 +0900564 && StatisticsRecorder::IsActive()) {
erg@google.com67a25432011-01-08 05:23:43 +0900565 DCHECK(!thread_name_.empty());
brettw@chromium.org87994282013-03-31 11:29:20 +0900566 message_histogram_ = LinearHistogram::FactoryGetWithRangeDescription(
erg@google.com67a25432011-01-08 05:23:43 +0900567 "MsgLoop:" + thread_name_,
568 kLeastNonZeroMessageId, kMaxMessageId,
569 kNumberOfDistinctMessagesDisplayed,
kaiwang@chromium.org7c950a82012-10-31 15:20:25 +0900570 message_histogram_->kHexRangePrintingFlag,
571 event_descriptions_);
erg@google.com67a25432011-01-08 05:23:43 +0900572 }
bbudge@chromium.org5685aad2012-10-28 22:09:33 +0900573#endif
erg@google.com67a25432011-01-08 05:23:43 +0900574}
575
576void MessageLoop::HistogramEvent(int event) {
bbudge@chromium.org5685aad2012-10-28 22:09:33 +0900577#if !defined(OS_NACL)
jar@chromium.org34571142011-04-05 13:48:53 +0900578 if (message_histogram_)
erg@google.com67a25432011-01-08 05:23:43 +0900579 message_histogram_->Add(event);
bbudge@chromium.org5685aad2012-10-28 22:09:33 +0900580#endif
erg@google.com67a25432011-01-08 05:23:43 +0900581}
582
darin@google.com981f3552008-08-16 12:09:05 +0900583bool MessageLoop::DoWork() {
darin@google.combe165ae2008-09-07 17:08:29 +0900584 if (!nestable_tasks_allowed_) {
585 // Task can't be executed right now.
586 return false;
587 }
588
589 for (;;) {
590 ReloadWorkQueue();
591 if (work_queue_.empty())
592 break;
593
594 // Execute oldest task.
595 do {
596 PendingTask pending_task = work_queue_.front();
597 work_queue_.pop();
598 if (!pending_task.delayed_run_time.is_null()) {
darin@chromium.orge3af17f2008-09-10 09:37:07 +0900599 AddToDelayedWorkQueue(pending_task);
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900600 // If we changed the topmost task, then it is time to reschedule.
601 if (delayed_work_queue_.top().task.Equals(pending_task.task))
darin@google.combe165ae2008-09-07 17:08:29 +0900602 pump_->ScheduleDelayedWork(pending_task.delayed_run_time);
603 } else {
604 if (DeferOrRunPendingTask(pending_task))
605 return true;
606 }
607 } while (!work_queue_.empty());
608 }
609
610 // Nothing happened.
611 return false;
darin@google.com981f3552008-08-16 12:09:05 +0900612}
613
ajwong@chromium.org94d2a582011-04-21 01:02:23 +0900614bool MessageLoop::DoDelayedWork(TimeTicks* next_delayed_work_time) {
jar@chromium.org40355072010-10-21 15:32:33 +0900615 if (!nestable_tasks_allowed_ || delayed_work_queue_.empty()) {
jar@chromium.org9b0fb062010-11-07 07:23:29 +0900616 recent_time_ = *next_delayed_work_time = TimeTicks();
darin@google.combe165ae2008-09-07 17:08:29 +0900617 return false;
618 }
jeremy@chromium.org2ed223c2008-12-09 02:36:06 +0900619
jar@chromium.org9b0fb062010-11-07 07:23:29 +0900620 // When we "fall behind," there will be a lot of tasks in the delayed work
jar@chromium.org94f73832010-11-05 08:23:42 +0900621 // queue that are ready to run. To increase efficiency when we fall behind,
622 // we will only call Time::Now() intermittently, and then process all tasks
623 // that are ready to run before calling it again. As a result, the more we
624 // fall behind (and have a lot of ready-to-run delayed tasks), the more
625 // efficient we'll be at handling the tasks.
jar@chromium.org9b0fb062010-11-07 07:23:29 +0900626
627 TimeTicks next_run_time = delayed_work_queue_.top().delayed_run_time;
jar@chromium.org94f73832010-11-05 08:23:42 +0900628 if (next_run_time > recent_time_) {
jar@chromium.org9b0fb062010-11-07 07:23:29 +0900629 recent_time_ = TimeTicks::Now(); // Get a better view of Now();
jar@chromium.org94f73832010-11-05 08:23:42 +0900630 if (next_run_time > recent_time_) {
631 *next_delayed_work_time = next_run_time;
632 return false;
633 }
darin@google.combe165ae2008-09-07 17:08:29 +0900634 }
darin@google.com981f3552008-08-16 12:09:05 +0900635
jar@chromium.org40355072010-10-21 15:32:33 +0900636 PendingTask pending_task = delayed_work_queue_.top();
637 delayed_work_queue_.pop();
jeremy@chromium.org2ed223c2008-12-09 02:36:06 +0900638
jar@chromium.org40355072010-10-21 15:32:33 +0900639 if (!delayed_work_queue_.empty())
darin@google.combe165ae2008-09-07 17:08:29 +0900640 *next_delayed_work_time = delayed_work_queue_.top().delayed_run_time;
darin@google.com981f3552008-08-16 12:09:05 +0900641
darin@google.combe165ae2008-09-07 17:08:29 +0900642 return DeferOrRunPendingTask(pending_task);
darin@google.com981f3552008-08-16 12:09:05 +0900643}
644
645bool MessageLoop::DoIdleWork() {
646 if (ProcessNextDelayedNonNestableTask())
647 return true;
648
jbates@chromium.org5d5b2812012-06-29 07:57:30 +0900649 if (run_loop_->quit_when_idle_received_)
darin@google.com981f3552008-08-16 12:09:05 +0900650 pump_->Quit();
651
652 return false;
653}
654
dcheng@chromium.org36904742011-12-30 13:32:58 +0900655void MessageLoop::DeleteSoonInternal(const tracked_objects::Location& from_here,
656 void(*deleter)(const void*),
657 const void* object) {
brettw@chromium.org87994282013-03-31 11:29:20 +0900658 PostNonNestableTask(from_here, Bind(deleter, object));
dcheng@chromium.org36904742011-12-30 13:32:58 +0900659}
660
dcheng@chromium.org2116fc92011-12-30 15:46:30 +0900661void MessageLoop::ReleaseSoonInternal(
662 const tracked_objects::Location& from_here,
663 void(*releaser)(const void*),
664 const void* object) {
brettw@chromium.org87994282013-03-31 11:29:20 +0900665 PostNonNestableTask(from_here, Bind(releaser, object));
dcheng@chromium.org2116fc92011-12-30 15:46:30 +0900666}
667
darin@google.com981f3552008-08-16 12:09:05 +0900668//------------------------------------------------------------------------------
darin@google.comd936b5b2008-08-26 14:53:57 +0900669// MessageLoopForUI
670
671#if defined(OS_WIN)
darin@google.comd936b5b2008-08-26 14:53:57 +0900672void MessageLoopForUI::DidProcessMessage(const MSG& message) {
673 pump_win()->DidProcessMessage(message);
674}
darin@google.comd936b5b2008-08-26 14:53:57 +0900675#endif // defined(OS_WIN)
676
michaelbai@google.com686190b2011-08-03 01:11:16 +0900677#if defined(OS_ANDROID)
678void MessageLoopForUI::Start() {
679 // No Histogram support for UI message loop as it is managed by Java side
brettw@chromium.org87994282013-03-31 11:29:20 +0900680 static_cast<MessagePumpForUI*>(pump_.get())->Start(this);
michaelbai@google.com686190b2011-08-03 01:11:16 +0900681}
682#endif
683
rohitrao@chromium.orgdcc49022012-07-13 20:02:57 +0900684#if defined(OS_IOS)
685void MessageLoopForUI::Attach() {
brettw@chromium.org87994282013-03-31 11:29:20 +0900686 static_cast<MessagePumpUIApplication*>(pump_.get())->Attach(this);
rohitrao@chromium.orgdcc49022012-07-13 20:02:57 +0900687}
688#endif
689
michaelbai@google.com686190b2011-08-03 01:11:16 +0900690#if !defined(OS_MACOSX) && !defined(OS_NACL) && !defined(OS_ANDROID)
jcampan@chromium.org05423582009-08-01 07:53:37 +0900691void MessageLoopForUI::AddObserver(Observer* observer) {
692 pump_ui()->AddObserver(observer);
693}
694
695void MessageLoopForUI::RemoveObserver(Observer* observer) {
696 pump_ui()->RemoveObserver(observer);
697}
698
michaelbai@google.com686190b2011-08-03 01:11:16 +0900699#endif // !defined(OS_MACOSX) && !defined(OS_NACL) && !defined(OS_ANDROID)
jcampan@chromium.org05423582009-08-01 07:53:37 +0900700
darin@google.comd936b5b2008-08-26 14:53:57 +0900701//------------------------------------------------------------------------------
702// MessageLoopForIO
703
704#if defined(OS_WIN)
705
rvargas@google.com9e49aa22008-10-10 08:58:43 +0900706void MessageLoopForIO::RegisterIOHandler(HANDLE file, IOHandler* handler) {
707 pump_io()->RegisterIOHandler(file, handler);
708}
709
alexeypa@chromium.org03c65ac2012-08-17 06:28:11 +0900710bool MessageLoopForIO::RegisterJobObject(HANDLE job, IOHandler* handler) {
711 return pump_io()->RegisterJobObject(job, handler);
712}
713
rvargas@google.com73887542008-11-08 06:52:15 +0900714bool MessageLoopForIO::WaitForIOCompletion(DWORD timeout, IOHandler* filter) {
715 return pump_io()->WaitForIOCompletion(timeout, filter);
rvargas@google.com9e49aa22008-10-10 08:58:43 +0900716}
717
blundell@chromium.orge21b2aa2012-12-01 02:29:40 +0900718#elif defined(OS_IOS)
719
720bool MessageLoopForIO::WatchFileDescriptor(int fd,
721 bool persistent,
722 Mode mode,
723 FileDescriptorWatcher *controller,
724 Watcher *delegate) {
725 return pump_io()->WatchFileDescriptor(
726 fd,
727 persistent,
728 mode,
729 controller,
730 delegate);
731}
732
abarth@chromium.org1f1c2172010-12-01 17:45:51 +0900733#elif defined(OS_POSIX) && !defined(OS_NACL)
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900734
jeremy@chromium.orgefc0db02008-12-16 07:02:17 +0900735bool MessageLoopForIO::WatchFileDescriptor(int fd,
736 bool persistent,
737 Mode mode,
738 FileDescriptorWatcher *controller,
739 Watcher *delegate) {
740 return pump_libevent()->WatchFileDescriptor(
741 fd,
742 persistent,
blundell@chromium.orge21b2aa2012-12-01 02:29:40 +0900743 mode,
jeremy@chromium.orgefc0db02008-12-16 07:02:17 +0900744 controller,
745 delegate);
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900746}
747
dkegel@google.com9e044ae2008-09-19 03:46:26 +0900748#endif
brettw@chromium.org87994282013-03-31 11:29:20 +0900749
750} // namespace base