jhawkins@chromium.org | e194f3d | 2012-01-05 11:18:18 +0900 | [diff] [blame] | 1 | // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
license.bot | f003cfe | 2008-08-24 09:55:55 +0900 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 4 | |
darin@google.com | 6ddeb84 | 2008-08-15 16:31:20 +0900 | [diff] [blame] | 5 | #include "base/message_loop.h" |
| 6 | |
darin@google.com | 981f355 | 2008-08-16 12:09:05 +0900 | [diff] [blame] | 7 | #include <algorithm> |
| 8 | |
ajwong@chromium.org | 94d2a58 | 2011-04-21 01:02:23 +0900 | [diff] [blame] | 9 | #include "base/bind.h" |
mmentovai@google.com | fa5f993 | 2008-08-22 07:26:06 +0900 | [diff] [blame] | 10 | #include "base/compiler_specific.h" |
apatrick@chromium.org | 8716404 | 2011-05-20 07:28:25 +0900 | [diff] [blame] | 11 | #include "base/debug/alias.h" |
jbates@chromium.org | b84db52 | 2011-10-04 02:51:25 +0900 | [diff] [blame] | 12 | #include "base/debug/trace_event.h" |
deanm@chromium.org | cd1ce30 | 2008-09-10 19:54:06 +0900 | [diff] [blame] | 13 | #include "base/lazy_instance.h" |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 14 | #include "base/logging.h" |
thestig@chromium.org | efd4aaf | 2011-06-15 13:14:23 +0900 | [diff] [blame] | 15 | #include "base/memory/scoped_ptr.h" |
nduca@chromium.org | ba04861 | 2011-08-16 05:33:46 +0900 | [diff] [blame] | 16 | #include "base/message_loop_proxy_impl.h" |
darin@google.com | 12d40bb | 2008-08-20 03:36:23 +0900 | [diff] [blame] | 17 | #include "base/message_pump_default.h" |
brettw@chromium.org | 275c2ec | 2010-10-14 13:38:38 +0900 | [diff] [blame] | 18 | #include "base/metrics/histogram.h" |
kaiwang@chromium.org | 3c57dc6 | 2012-07-14 06:48:29 +0900 | [diff] [blame] | 19 | #include "base/metrics/statistics_recorder.h" |
jbates@chromium.org | 5d5b281 | 2012-06-29 07:57:30 +0900 | [diff] [blame] | 20 | #include "base/run_loop.h" |
timurrrr@chromium.org | 490200b | 2011-01-05 04:06:51 +0900 | [diff] [blame] | 21 | #include "base/third_party/dynamic_annotations/dynamic_annotations.h" |
sergeyu@chromium.org | 675d888 | 2012-05-10 05:16:14 +0900 | [diff] [blame] | 22 | #include "base/thread_task_runner_handle.h" |
brettw@chromium.org | 6396558 | 2010-12-31 07:18:56 +0900 | [diff] [blame] | 23 | #include "base/threading/thread_local.h" |
mbelshe@chromium.org | bee85b3 | 2011-05-16 04:20:49 +0900 | [diff] [blame] | 24 | #include "base/time.h" |
ajwong@chromium.org | 94d2a58 | 2011-04-21 01:02:23 +0900 | [diff] [blame] | 25 | #include "base/tracked_objects.h" |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 26 | |
mark@chromium.org | 059d049 | 2008-09-24 06:08:28 +0900 | [diff] [blame] | 27 | #if defined(OS_MACOSX) |
| 28 | #include "base/message_pump_mac.h" |
| 29 | #endif |
blundell@chromium.org | e21b2aa | 2012-12-01 02:29:40 +0900 | [diff] [blame] | 30 | #if defined(OS_POSIX) && !defined(OS_IOS) |
dkegel@google.com | 9e044ae | 2008-09-19 03:46:26 +0900 | [diff] [blame] | 31 | #include "base/message_pump_libevent.h" |
| 32 | #endif |
michaelbai@google.com | 686190b | 2011-08-03 01:11:16 +0900 | [diff] [blame] | 33 | #if defined(OS_ANDROID) |
| 34 | #include "base/message_pump_android.h" |
| 35 | #endif |
oshima@chromium.org | 59a0855 | 2012-04-05 09:21:22 +0900 | [diff] [blame] | 36 | |
| 37 | #if defined(TOOLKIT_GTK) |
ajwong@chromium.org | 94d2a58 | 2011-04-21 01:02:23 +0900 | [diff] [blame] | 38 | #include <gdk/gdk.h> |
| 39 | #include <gdk/gdkx.h> |
oshima@chromium.org | 59a0855 | 2012-04-05 09:21:22 +0900 | [diff] [blame] | 40 | #endif |
dkegel@google.com | 9e044ae | 2008-09-19 03:46:26 +0900 | [diff] [blame] | 41 | |
jhawkins@chromium.org | 2af12f2 | 2011-11-16 08:36:30 +0900 | [diff] [blame] | 42 | using base::PendingTask; |
dsh@google.com | 0f8dd26 | 2008-10-28 05:43:33 +0900 | [diff] [blame] | 43 | using base::TimeDelta; |
jar@chromium.org | 9b0fb06 | 2010-11-07 07:23:29 +0900 | [diff] [blame] | 44 | using base::TimeTicks; |
dsh@google.com | 0f8dd26 | 2008-10-28 05:43:33 +0900 | [diff] [blame] | 45 | |
erg@chromium.org | a752852 | 2010-07-16 02:23:23 +0900 | [diff] [blame] | 46 | namespace { |
| 47 | |
deanm@chromium.org | cd1ce30 | 2008-09-10 19:54:06 +0900 | [diff] [blame] | 48 | // A lazily created thread local storage for quick access to a thread's message |
| 49 | // loop, if one exists. This should be safe and free of static constructors. |
joth@chromium.org | b24883c | 2011-11-15 22:31:49 +0900 | [diff] [blame] | 50 | base::LazyInstance<base::ThreadLocalPointer<MessageLoop> > lazy_tls_ptr = |
| 51 | LAZY_INSTANCE_INITIALIZER; |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 52 | |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 53 | // Logical events for Histogram profiling. Run with -message-loop-histogrammer |
| 54 | // to get an accounting of messages and actions taken on each thread. |
erg@chromium.org | a752852 | 2010-07-16 02:23:23 +0900 | [diff] [blame] | 55 | const int kTaskRunEvent = 0x1; |
| 56 | const int kTimerEvent = 0x2; |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 57 | |
| 58 | // Provide range of message IDs for use in histogramming and debug display. |
erg@chromium.org | a752852 | 2010-07-16 02:23:23 +0900 | [diff] [blame] | 59 | const int kLeastNonZeroMessageId = 1; |
| 60 | const int kMaxMessageId = 1099; |
| 61 | const int kNumberOfDistinctMessagesDisplayed = 1100; |
| 62 | |
| 63 | // Provide a macro that takes an expression (such as a constant, or macro |
| 64 | // constant) and creates a pair to initalize an array of pairs. In this case, |
| 65 | // our pair consists of the expressions value, and the "stringized" version |
| 66 | // of the expression (i.e., the exrpression put in quotes). For example, if |
| 67 | // we have: |
| 68 | // #define FOO 2 |
| 69 | // #define BAR 5 |
| 70 | // then the following: |
| 71 | // VALUE_TO_NUMBER_AND_NAME(FOO + BAR) |
| 72 | // will expand to: |
| 73 | // {7, "FOO + BAR"} |
| 74 | // We use the resulting array as an argument to our histogram, which reads the |
| 75 | // number as a bucket identifier, and proceeds to use the corresponding name |
| 76 | // in the pair (i.e., the quoted string) when printing out a histogram. |
| 77 | #define VALUE_TO_NUMBER_AND_NAME(name) {name, #name}, |
| 78 | |
brettw@chromium.org | 275c2ec | 2010-10-14 13:38:38 +0900 | [diff] [blame] | 79 | const base::LinearHistogram::DescriptionPair event_descriptions_[] = { |
erg@chromium.org | a752852 | 2010-07-16 02:23:23 +0900 | [diff] [blame] | 80 | // Provide some pretty print capability in our histogram for our internal |
| 81 | // messages. |
| 82 | |
| 83 | // A few events we handle (kindred to messages), and used to profile actions. |
| 84 | VALUE_TO_NUMBER_AND_NAME(kTaskRunEvent) |
| 85 | VALUE_TO_NUMBER_AND_NAME(kTimerEvent) |
| 86 | |
| 87 | {-1, NULL} // The list must be null terminated, per API to histogram. |
| 88 | }; |
| 89 | |
| 90 | bool enable_histogrammer_ = false; |
| 91 | |
michaelbai@google.com | 686190b | 2011-08-03 01:11:16 +0900 | [diff] [blame] | 92 | MessageLoop::MessagePumpFactory* message_pump_for_ui_factory_ = NULL; |
| 93 | |
jbates@chromium.org | 7cc8033 | 2012-09-18 12:41:29 +0900 | [diff] [blame] | 94 | // Create a process-wide unique ID to represent this task in trace events. This |
| 95 | // will be mangled with a Process ID hash to reduce the likelyhood of colliding |
| 96 | // with MessageLoop pointers on other processes. |
| 97 | uint64 GetTaskTraceID(const PendingTask& task, MessageLoop* loop) { |
| 98 | return (static_cast<uint64>(task.sequence_num) << 32) | |
| 99 | static_cast<uint64>(reinterpret_cast<intptr_t>(loop)); |
| 100 | } |
| 101 | |
erg@chromium.org | a752852 | 2010-07-16 02:23:23 +0900 | [diff] [blame] | 102 | } // namespace |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 103 | |
| 104 | //------------------------------------------------------------------------------ |
| 105 | |
darin@google.com | 981f355 | 2008-08-16 12:09:05 +0900 | [diff] [blame] | 106 | #if defined(OS_WIN) |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 107 | |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 108 | // Upon a SEH exception in this thread, it restores the original unhandled |
| 109 | // exception filter. |
| 110 | static int SEHFilter(LPTOP_LEVEL_EXCEPTION_FILTER old_filter) { |
| 111 | ::SetUnhandledExceptionFilter(old_filter); |
| 112 | return EXCEPTION_CONTINUE_SEARCH; |
| 113 | } |
| 114 | |
| 115 | // Retrieves a pointer to the current unhandled exception filter. There |
| 116 | // is no standalone getter method. |
| 117 | static LPTOP_LEVEL_EXCEPTION_FILTER GetTopSEHFilter() { |
| 118 | LPTOP_LEVEL_EXCEPTION_FILTER top_filter = NULL; |
| 119 | top_filter = ::SetUnhandledExceptionFilter(0); |
| 120 | ::SetUnhandledExceptionFilter(top_filter); |
| 121 | return top_filter; |
| 122 | } |
| 123 | |
darin@google.com | 981f355 | 2008-08-16 12:09:05 +0900 | [diff] [blame] | 124 | #endif // defined(OS_WIN) |
| 125 | |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 126 | //------------------------------------------------------------------------------ |
| 127 | |
erg@chromium.org | 493f5f6 | 2010-07-16 06:03:54 +0900 | [diff] [blame] | 128 | MessageLoop::TaskObserver::TaskObserver() { |
| 129 | } |
| 130 | |
| 131 | MessageLoop::TaskObserver::~TaskObserver() { |
| 132 | } |
| 133 | |
| 134 | MessageLoop::DestructionObserver::~DestructionObserver() { |
| 135 | } |
| 136 | |
| 137 | //------------------------------------------------------------------------------ |
| 138 | |
darin@google.com | d936b5b | 2008-08-26 14:53:57 +0900 | [diff] [blame] | 139 | MessageLoop::MessageLoop(Type type) |
| 140 | : type_(type), |
darin@google.com | ee6fa72 | 2008-08-13 08:25:43 +0900 | [diff] [blame] | 141 | nestable_tasks_allowed_(true), |
darin@google.com | 12d40bb | 2008-08-20 03:36:23 +0900 | [diff] [blame] | 142 | exception_restoration_(false), |
jar@chromium.org | 3457114 | 2011-04-05 13:48:53 +0900 | [diff] [blame] | 143 | message_histogram_(NULL), |
jbates@chromium.org | 5d5b281 | 2012-06-29 07:57:30 +0900 | [diff] [blame] | 144 | run_loop_(NULL), |
ananta@chromium.org | c542fec | 2011-03-24 12:40:28 +0900 | [diff] [blame] | 145 | #ifdef OS_WIN |
| 146 | os_modal_loop_(false), |
| 147 | #endif // OS_WIN |
darin@google.com | be165ae | 2008-09-07 17:08:29 +0900 | [diff] [blame] | 148 | next_sequence_num_(0) { |
deanm@chromium.org | cd1ce30 | 2008-09-10 19:54:06 +0900 | [diff] [blame] | 149 | DCHECK(!current()) << "should only have one message loop per thread"; |
| 150 | lazy_tls_ptr.Pointer()->Set(this); |
darin@google.com | d936b5b | 2008-08-26 14:53:57 +0900 | [diff] [blame] | 151 | |
nduca@chromium.org | ba04861 | 2011-08-16 05:33:46 +0900 | [diff] [blame] | 152 | message_loop_proxy_ = new base::MessageLoopProxyImpl(); |
sergeyu@chromium.org | 675d888 | 2012-05-10 05:16:14 +0900 | [diff] [blame] | 153 | thread_task_runner_handle_.reset( |
| 154 | new base::ThreadTaskRunnerHandle(message_loop_proxy_)); |
nduca@chromium.org | ba04861 | 2011-08-16 05:33:46 +0900 | [diff] [blame] | 155 | |
thestig@chromium.org | 7016bac | 2010-04-15 10:04:29 +0900 | [diff] [blame] | 156 | // TODO(rvargas): Get rid of the OS guards. |
darin@google.com | 981f355 | 2008-08-16 12:09:05 +0900 | [diff] [blame] | 157 | #if defined(OS_WIN) |
thestig@chromium.org | 7016bac | 2010-04-15 10:04:29 +0900 | [diff] [blame] | 158 | #define MESSAGE_PUMP_UI new base::MessagePumpForUI() |
| 159 | #define MESSAGE_PUMP_IO new base::MessagePumpForIO() |
blundell@chromium.org | e21b2aa | 2012-12-01 02:29:40 +0900 | [diff] [blame] | 160 | #elif defined(OS_IOS) |
| 161 | #define MESSAGE_PUMP_UI base::MessagePumpMac::Create() |
| 162 | #define MESSAGE_PUMP_IO new base::MessagePumpIOSForIO() |
thestig@chromium.org | 7016bac | 2010-04-15 10:04:29 +0900 | [diff] [blame] | 163 | #elif defined(OS_MACOSX) |
| 164 | #define MESSAGE_PUMP_UI base::MessagePumpMac::Create() |
| 165 | #define MESSAGE_PUMP_IO new base::MessagePumpLibevent() |
abarth@chromium.org | 1f1c217 | 2010-12-01 17:45:51 +0900 | [diff] [blame] | 166 | #elif defined(OS_NACL) |
dmichael@chromium.org | b798bb4 | 2012-06-01 04:37:54 +0900 | [diff] [blame] | 167 | // Currently NaCl doesn't have a UI MessageLoop. |
| 168 | // TODO(abarth): Figure out if we need this. |
abarth@chromium.org | 1f1c217 | 2010-12-01 17:45:51 +0900 | [diff] [blame] | 169 | #define MESSAGE_PUMP_UI NULL |
dmichael@chromium.org | b798bb4 | 2012-06-01 04:37:54 +0900 | [diff] [blame] | 170 | // ipc_channel_nacl.cc uses a worker thread to do socket reads currently, and |
| 171 | // doesn't require extra support for watching file descriptors. |
| 172 | #define MESSAGE_PUMP_IO new base::MessagePumpDefault(); |
thestig@chromium.org | 7016bac | 2010-04-15 10:04:29 +0900 | [diff] [blame] | 173 | #elif defined(OS_POSIX) // POSIX but not MACOSX. |
piman@chromium.org | bfd272d | 2011-12-15 01:34:31 +0900 | [diff] [blame] | 174 | #define MESSAGE_PUMP_UI new base::MessagePumpForUI() |
thestig@chromium.org | 7016bac | 2010-04-15 10:04:29 +0900 | [diff] [blame] | 175 | #define MESSAGE_PUMP_IO new base::MessagePumpLibevent() |
evan@chromium.org | 875bb6e | 2009-12-29 09:32:52 +0900 | [diff] [blame] | 176 | #else |
thestig@chromium.org | 7016bac | 2010-04-15 10:04:29 +0900 | [diff] [blame] | 177 | #error Not implemented |
evan@chromium.org | 875bb6e | 2009-12-29 09:32:52 +0900 | [diff] [blame] | 178 | #endif |
thestig@chromium.org | 7016bac | 2010-04-15 10:04:29 +0900 | [diff] [blame] | 179 | |
| 180 | if (type_ == TYPE_UI) { |
michaelbai@google.com | 686190b | 2011-08-03 01:11:16 +0900 | [diff] [blame] | 181 | if (message_pump_for_ui_factory_) |
| 182 | pump_ = message_pump_for_ui_factory_(); |
| 183 | else |
| 184 | pump_ = MESSAGE_PUMP_UI; |
dsh@google.com | 119a252 | 2008-10-04 01:52:59 +0900 | [diff] [blame] | 185 | } else if (type_ == TYPE_IO) { |
thestig@chromium.org | 7016bac | 2010-04-15 10:04:29 +0900 | [diff] [blame] | 186 | pump_ = MESSAGE_PUMP_IO; |
dkegel@google.com | 9e044ae | 2008-09-19 03:46:26 +0900 | [diff] [blame] | 187 | } else { |
thestig@chromium.org | 7016bac | 2010-04-15 10:04:29 +0900 | [diff] [blame] | 188 | DCHECK_EQ(TYPE_DEFAULT, type_); |
dkegel@google.com | 9e044ae | 2008-09-19 03:46:26 +0900 | [diff] [blame] | 189 | pump_ = new base::MessagePumpDefault(); |
| 190 | } |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 191 | } |
| 192 | |
| 193 | MessageLoop::~MessageLoop() { |
thestig@chromium.org | 226880a | 2010-11-11 05:28:06 +0900 | [diff] [blame] | 194 | DCHECK_EQ(this, current()); |
darin@google.com | 965e534 | 2008-08-06 08:16:41 +0900 | [diff] [blame] | 195 | |
jbates@chromium.org | 5d5b281 | 2012-06-29 07:57:30 +0900 | [diff] [blame] | 196 | DCHECK(!run_loop_); |
darin@google.com | 0e50050 | 2008-09-09 14:55:35 +0900 | [diff] [blame] | 197 | |
darin@chromium.org | e3af17f | 2008-09-10 09:37:07 +0900 | [diff] [blame] | 198 | // 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.com | 0e50050 | 2008-09-09 14:55:35 +0900 | [diff] [blame] | 212 | } |
darin@chromium.org | e3af17f | 2008-09-10 09:37:07 +0900 | [diff] [blame] | 213 | DCHECK(!did_work); |
| 214 | |
sanjeevr@chromium.org | 03b44d5 | 2010-11-30 09:25:29 +0900 | [diff] [blame] | 215 | // Let interested parties have one last shot at accessing this. |
| 216 | FOR_EACH_OBSERVER(DestructionObserver, destruction_observers_, |
| 217 | WillDestroyCurrentMessageLoop()); |
| 218 | |
sergeyu@chromium.org | 675d888 | 2012-05-10 05:16:14 +0900 | [diff] [blame] | 219 | thread_task_runner_handle_.reset(); |
| 220 | |
nduca@chromium.org | ba04861 | 2011-08-16 05:33:46 +0900 | [diff] [blame] | 221 | // Tell the message_loop_proxy that we are dying. |
| 222 | static_cast<base::MessageLoopProxyImpl*>(message_loop_proxy_.get())-> |
| 223 | WillDestroyCurrentMessageLoop(); |
| 224 | message_loop_proxy_ = NULL; |
| 225 | |
darin@chromium.org | e3af17f | 2008-09-10 09:37:07 +0900 | [diff] [blame] | 226 | // OK, now make it so that no one can find us. |
deanm@chromium.org | e4cc592 | 2008-09-10 20:14:56 +0900 | [diff] [blame] | 227 | lazy_tls_ptr.Pointer()->Set(NULL); |
mbelshe@chromium.org | bee85b3 | 2011-05-16 04:20:49 +0900 | [diff] [blame] | 228 | |
| 229 | #if defined(OS_WIN) |
| 230 | // If we left the high-resolution timer activated, deactivate it now. |
| 231 | // Doing this is not-critical, it is mainly to make sure we track |
| 232 | // the high resolution timer activations properly in our unit tests. |
| 233 | if (!high_resolution_timer_expiration_.is_null()) { |
| 234 | base::Time::ActivateHighResolutionTimer(false); |
| 235 | high_resolution_timer_expiration_ = base::TimeTicks(); |
| 236 | } |
| 237 | #endif |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 238 | } |
| 239 | |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 240 | // static |
| 241 | MessageLoop* MessageLoop::current() { |
| 242 | // TODO(darin): sadly, we cannot enable this yet since people call us even |
| 243 | // when they have no intention of using us. |
| 244 | // DCHECK(loop) << "Ouch, did you forget to initialize me?"; |
| 245 | return lazy_tls_ptr.Pointer()->Get(); |
| 246 | } |
| 247 | |
| 248 | // static |
| 249 | void MessageLoop::EnableHistogrammer(bool enable) { |
| 250 | enable_histogrammer_ = enable; |
| 251 | } |
| 252 | |
michaelbai@google.com | 686190b | 2011-08-03 01:11:16 +0900 | [diff] [blame] | 253 | // static |
nileshagrawal@chromium.org | 64f0250 | 2013-01-30 06:55:55 +0900 | [diff] [blame] | 254 | bool MessageLoop::InitMessagePumpForUIFactory(MessagePumpFactory* factory) { |
| 255 | if (message_pump_for_ui_factory_) |
| 256 | return false; |
| 257 | |
michaelbai@google.com | 686190b | 2011-08-03 01:11:16 +0900 | [diff] [blame] | 258 | message_pump_for_ui_factory_ = factory; |
nileshagrawal@chromium.org | 64f0250 | 2013-01-30 06:55:55 +0900 | [diff] [blame] | 259 | return true; |
michaelbai@google.com | 686190b | 2011-08-03 01:11:16 +0900 | [diff] [blame] | 260 | } |
| 261 | |
sky@chromium.org | 18c66dc | 2010-09-16 07:14:36 +0900 | [diff] [blame] | 262 | void MessageLoop::AddDestructionObserver( |
| 263 | DestructionObserver* destruction_observer) { |
thestig@chromium.org | 226880a | 2010-11-11 05:28:06 +0900 | [diff] [blame] | 264 | DCHECK_EQ(this, current()); |
sky@chromium.org | 18c66dc | 2010-09-16 07:14:36 +0900 | [diff] [blame] | 265 | destruction_observers_.AddObserver(destruction_observer); |
darin@google.com | 965e534 | 2008-08-06 08:16:41 +0900 | [diff] [blame] | 266 | } |
| 267 | |
sky@chromium.org | 18c66dc | 2010-09-16 07:14:36 +0900 | [diff] [blame] | 268 | void MessageLoop::RemoveDestructionObserver( |
| 269 | DestructionObserver* destruction_observer) { |
thestig@chromium.org | 226880a | 2010-11-11 05:28:06 +0900 | [diff] [blame] | 270 | DCHECK_EQ(this, current()); |
sky@chromium.org | 18c66dc | 2010-09-16 07:14:36 +0900 | [diff] [blame] | 271 | destruction_observers_.RemoveObserver(destruction_observer); |
darin@google.com | 965e534 | 2008-08-06 08:16:41 +0900 | [diff] [blame] | 272 | } |
| 273 | |
darin@google.com | be165ae | 2008-09-07 17:08:29 +0900 | [diff] [blame] | 274 | void MessageLoop::PostTask( |
ajwong@chromium.org | 94d2a58 | 2011-04-21 01:02:23 +0900 | [diff] [blame] | 275 | const tracked_objects::Location& from_here, const base::Closure& task) { |
brettw@chromium.org | 5faed3c | 2011-10-27 06:48:00 +0900 | [diff] [blame] | 276 | DCHECK(!task.is_null()) << from_here.ToString(); |
tedvessenes@gmail.com | c9fdf90 | 2012-06-22 02:31:56 +0900 | [diff] [blame] | 277 | PendingTask pending_task( |
| 278 | from_here, task, CalculateDelayedRuntime(TimeDelta()), true); |
ajwong@chromium.org | 94d2a58 | 2011-04-21 01:02:23 +0900 | [diff] [blame] | 279 | AddToIncomingQueue(&pending_task); |
| 280 | } |
| 281 | |
| 282 | void MessageLoop::PostDelayedTask( |
tedvessenes@gmail.com | 658a87f | 2011-12-30 10:04:36 +0900 | [diff] [blame] | 283 | const tracked_objects::Location& from_here, |
| 284 | const base::Closure& task, |
tedvessenes@gmail.com | c9fdf90 | 2012-06-22 02:31:56 +0900 | [diff] [blame] | 285 | TimeDelta delay) { |
brettw@chromium.org | 5faed3c | 2011-10-27 06:48:00 +0900 | [diff] [blame] | 286 | DCHECK(!task.is_null()) << from_here.ToString(); |
tedvessenes@gmail.com | c9fdf90 | 2012-06-22 02:31:56 +0900 | [diff] [blame] | 287 | PendingTask pending_task( |
| 288 | from_here, task, CalculateDelayedRuntime(delay), true); |
ajwong@chromium.org | 94d2a58 | 2011-04-21 01:02:23 +0900 | [diff] [blame] | 289 | AddToIncomingQueue(&pending_task); |
| 290 | } |
| 291 | |
| 292 | void MessageLoop::PostNonNestableTask( |
tedvessenes@gmail.com | c9fdf90 | 2012-06-22 02:31:56 +0900 | [diff] [blame] | 293 | const tracked_objects::Location& from_here, |
| 294 | const base::Closure& task) { |
brettw@chromium.org | 5faed3c | 2011-10-27 06:48:00 +0900 | [diff] [blame] | 295 | DCHECK(!task.is_null()) << from_here.ToString(); |
tedvessenes@gmail.com | c9fdf90 | 2012-06-22 02:31:56 +0900 | [diff] [blame] | 296 | PendingTask pending_task( |
| 297 | from_here, task, CalculateDelayedRuntime(TimeDelta()), false); |
ajwong@chromium.org | 94d2a58 | 2011-04-21 01:02:23 +0900 | [diff] [blame] | 298 | AddToIncomingQueue(&pending_task); |
darin@google.com | be165ae | 2008-09-07 17:08:29 +0900 | [diff] [blame] | 299 | } |
| 300 | |
tedvessenes@gmail.com | 658a87f | 2011-12-30 10:04:36 +0900 | [diff] [blame] | 301 | void MessageLoop::PostNonNestableDelayedTask( |
| 302 | const tracked_objects::Location& from_here, |
| 303 | const base::Closure& task, |
tedvessenes@gmail.com | c9fdf90 | 2012-06-22 02:31:56 +0900 | [diff] [blame] | 304 | TimeDelta delay) { |
| 305 | DCHECK(!task.is_null()) << from_here.ToString(); |
| 306 | PendingTask pending_task( |
| 307 | from_here, task, CalculateDelayedRuntime(delay), false); |
| 308 | AddToIncomingQueue(&pending_task); |
tedvessenes@gmail.com | 658a87f | 2011-12-30 10:04:36 +0900 | [diff] [blame] | 309 | } |
| 310 | |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 311 | void MessageLoop::Run() { |
jbates@chromium.org | 5d5b281 | 2012-06-29 07:57:30 +0900 | [diff] [blame] | 312 | base::RunLoop run_loop; |
| 313 | run_loop.Run(); |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 314 | } |
darin@google.com | 0795f57 | 2008-08-30 09:22:48 +0900 | [diff] [blame] | 315 | |
jbates@chromium.org | 5d5b281 | 2012-06-29 07:57:30 +0900 | [diff] [blame] | 316 | void MessageLoop::RunUntilIdle() { |
| 317 | base::RunLoop run_loop; |
| 318 | run_loop.RunUntilIdle(); |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 319 | } |
darin@google.com | 0795f57 | 2008-08-30 09:22:48 +0900 | [diff] [blame] | 320 | |
jbates@chromium.org | 5d5b281 | 2012-06-29 07:57:30 +0900 | [diff] [blame] | 321 | void MessageLoop::QuitWhenIdle() { |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 322 | DCHECK_EQ(this, current()); |
jbates@chromium.org | 5d5b281 | 2012-06-29 07:57:30 +0900 | [diff] [blame] | 323 | if (run_loop_) { |
| 324 | run_loop_->quit_when_idle_received_ = true; |
darin@google.com | 0795f57 | 2008-08-30 09:22:48 +0900 | [diff] [blame] | 325 | } else { |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 326 | NOTREACHED() << "Must be inside Run to call Quit"; |
darin@google.com | 0795f57 | 2008-08-30 09:22:48 +0900 | [diff] [blame] | 327 | } |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 328 | } |
darin@google.com | 0795f57 | 2008-08-30 09:22:48 +0900 | [diff] [blame] | 329 | |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 330 | void MessageLoop::QuitNow() { |
| 331 | DCHECK_EQ(this, current()); |
jbates@chromium.org | 5d5b281 | 2012-06-29 07:57:30 +0900 | [diff] [blame] | 332 | if (run_loop_) { |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 333 | pump_->Quit(); |
| 334 | } else { |
| 335 | NOTREACHED() << "Must be inside Run to call Quit"; |
mbelshe@chromium.org | de50b7d | 2010-06-29 13:58:15 +0900 | [diff] [blame] | 336 | } |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 337 | } |
| 338 | |
smckay@chromium.org | ac93be3 | 2012-07-21 09:26:32 +0900 | [diff] [blame] | 339 | bool MessageLoop::IsType(Type type) const { |
| 340 | return type_ == type; |
| 341 | } |
| 342 | |
jbates@chromium.org | 5d5b281 | 2012-06-29 07:57:30 +0900 | [diff] [blame] | 343 | static void QuitCurrentWhenIdle() { |
| 344 | MessageLoop::current()->QuitWhenIdle(); |
kalman@chromium.org | c89ed90 | 2011-10-21 15:21:57 +0900 | [diff] [blame] | 345 | } |
| 346 | |
jhawkins@chromium.org | 573d418 | 2011-10-17 10:20:36 +0900 | [diff] [blame] | 347 | // static |
jbates@chromium.org | 5d5b281 | 2012-06-29 07:57:30 +0900 | [diff] [blame] | 348 | base::Closure MessageLoop::QuitWhenIdleClosure() { |
| 349 | return base::Bind(&QuitCurrentWhenIdle); |
jhawkins@chromium.org | 573d418 | 2011-10-17 10:20:36 +0900 | [diff] [blame] | 350 | } |
| 351 | |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 352 | void MessageLoop::SetNestableTasksAllowed(bool allowed) { |
mpcomplete@google.com | 989d5f8 | 2008-08-09 09:14:09 +0900 | [diff] [blame] | 353 | if (nestable_tasks_allowed_ != allowed) { |
| 354 | nestable_tasks_allowed_ = allowed; |
| 355 | if (!nestable_tasks_allowed_) |
| 356 | return; |
| 357 | // Start the native pump if we are not already pumping. |
darin@google.com | 981f355 | 2008-08-16 12:09:05 +0900 | [diff] [blame] | 358 | pump_->ScheduleWork(); |
mpcomplete@google.com | 989d5f8 | 2008-08-09 09:14:09 +0900 | [diff] [blame] | 359 | } |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 360 | } |
| 361 | |
| 362 | bool MessageLoop::NestableTasksAllowed() const { |
| 363 | return nestable_tasks_allowed_; |
| 364 | } |
| 365 | |
jcampan@chromium.org | eac5717 | 2009-07-02 04:53:59 +0900 | [diff] [blame] | 366 | bool MessageLoop::IsNested() { |
jbates@chromium.org | 5d5b281 | 2012-06-29 07:57:30 +0900 | [diff] [blame] | 367 | return run_loop_->run_depth_ > 1; |
jcampan@chromium.org | eac5717 | 2009-07-02 04:53:59 +0900 | [diff] [blame] | 368 | } |
| 369 | |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 370 | void MessageLoop::AddTaskObserver(TaskObserver* task_observer) { |
| 371 | DCHECK_EQ(this, current()); |
| 372 | task_observers_.AddObserver(task_observer); |
| 373 | } |
| 374 | |
| 375 | void MessageLoop::RemoveTaskObserver(TaskObserver* task_observer) { |
| 376 | DCHECK_EQ(this, current()); |
| 377 | task_observers_.RemoveObserver(task_observer); |
| 378 | } |
| 379 | |
willchan@chromium.org | 3a39767 | 2011-01-26 09:53:48 +0900 | [diff] [blame] | 380 | void MessageLoop::AssertIdle() const { |
| 381 | // We only check |incoming_queue_|, since we don't want to lock |work_queue_|. |
| 382 | base::AutoLock lock(incoming_queue_lock_); |
| 383 | DCHECK(incoming_queue_.empty()); |
| 384 | } |
| 385 | |
willchan@chromium.org | fe2201e | 2011-11-02 07:06:58 +0900 | [diff] [blame] | 386 | bool MessageLoop::is_running() const { |
| 387 | DCHECK_EQ(this, current()); |
jbates@chromium.org | 5d5b281 | 2012-06-29 07:57:30 +0900 | [diff] [blame] | 388 | return run_loop_ != NULL; |
willchan@chromium.org | fe2201e | 2011-11-02 07:06:58 +0900 | [diff] [blame] | 389 | } |
| 390 | |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 391 | //------------------------------------------------------------------------------ |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 392 | |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 393 | // Runs the loop in two different SEH modes: |
| 394 | // enable_SEH_restoration_ = false : any unhandled exception goes to the last |
| 395 | // one that calls SetUnhandledExceptionFilter(). |
| 396 | // enable_SEH_restoration_ = true : any unhandled exception goes to the filter |
| 397 | // that was existed before the loop was run. |
| 398 | void MessageLoop::RunHandler() { |
| 399 | #if defined(OS_WIN) |
| 400 | if (exception_restoration_) { |
| 401 | RunInternalInSEHFrame(); |
| 402 | return; |
| 403 | } |
| 404 | #endif |
| 405 | |
| 406 | RunInternal(); |
| 407 | } |
| 408 | |
| 409 | #if defined(OS_WIN) |
| 410 | __declspec(noinline) void MessageLoop::RunInternalInSEHFrame() { |
| 411 | LPTOP_LEVEL_EXCEPTION_FILTER current_filter = GetTopSEHFilter(); |
| 412 | __try { |
| 413 | RunInternal(); |
| 414 | } __except(SEHFilter(current_filter)) { |
| 415 | } |
| 416 | return; |
| 417 | } |
| 418 | #endif |
| 419 | |
| 420 | void MessageLoop::RunInternal() { |
| 421 | DCHECK_EQ(this, current()); |
| 422 | |
| 423 | StartHistogrammer(); |
| 424 | |
michaelbai@google.com | 686190b | 2011-08-03 01:11:16 +0900 | [diff] [blame] | 425 | #if !defined(OS_MACOSX) && !defined(OS_ANDROID) |
jbates@chromium.org | 5d5b281 | 2012-06-29 07:57:30 +0900 | [diff] [blame] | 426 | if (run_loop_->dispatcher_ && type() == TYPE_UI) { |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 427 | static_cast<base::MessagePumpForUI*>(pump_.get())-> |
jbates@chromium.org | 5d5b281 | 2012-06-29 07:57:30 +0900 | [diff] [blame] | 428 | RunWithDispatcher(this, run_loop_->dispatcher_); |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 429 | return; |
| 430 | } |
| 431 | #endif |
| 432 | |
| 433 | pump_->Run(this); |
| 434 | } |
| 435 | |
| 436 | bool MessageLoop::ProcessNextDelayedNonNestableTask() { |
jbates@chromium.org | 5d5b281 | 2012-06-29 07:57:30 +0900 | [diff] [blame] | 437 | if (run_loop_->run_depth_ != 1) |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 438 | return false; |
| 439 | |
| 440 | if (deferred_non_nestable_work_queue_.empty()) |
| 441 | return false; |
| 442 | |
ajwong@chromium.org | 94d2a58 | 2011-04-21 01:02:23 +0900 | [diff] [blame] | 443 | PendingTask pending_task = deferred_non_nestable_work_queue_.front(); |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 444 | deferred_non_nestable_work_queue_.pop(); |
| 445 | |
ajwong@chromium.org | 94d2a58 | 2011-04-21 01:02:23 +0900 | [diff] [blame] | 446 | RunTask(pending_task); |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 447 | return true; |
| 448 | } |
| 449 | |
ajwong@chromium.org | 94d2a58 | 2011-04-21 01:02:23 +0900 | [diff] [blame] | 450 | void MessageLoop::RunTask(const PendingTask& pending_task) { |
jbates@chromium.org | 7cc8033 | 2012-09-18 12:41:29 +0900 | [diff] [blame] | 451 | TRACE_EVENT_FLOW_END0("task", "MessageLoop::PostTask", |
| 452 | TRACE_ID_MANGLE(GetTaskTraceID(pending_task, this))); |
jbates@chromium.org | 5a97c21 | 2012-02-24 04:16:35 +0900 | [diff] [blame] | 453 | TRACE_EVENT2("task", "MessageLoop::RunTask", |
| 454 | "src_file", pending_task.posted_from.file_name(), |
| 455 | "src_func", pending_task.posted_from.function_name()); |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 456 | DCHECK(nestable_tasks_allowed_); |
| 457 | // Execute the task and assume the worst: It is probably not reentrant. |
| 458 | nestable_tasks_allowed_ = false; |
darin@google.com | be165ae | 2008-09-07 17:08:29 +0900 | [diff] [blame] | 459 | |
apatrick@chromium.org | 8716404 | 2011-05-20 07:28:25 +0900 | [diff] [blame] | 460 | // Before running the task, store the program counter where it was posted |
| 461 | // and deliberately alias it to ensure it is on the stack if the task |
| 462 | // crashes. Be careful not to assume that the variable itself will have the |
| 463 | // expected value when displayed by the optimizer in an optimized build. |
| 464 | // Look at a memory dump of the stack. |
jbates@chromium.org | b84db52 | 2011-10-04 02:51:25 +0900 | [diff] [blame] | 465 | const void* program_counter = |
| 466 | pending_task.posted_from.program_counter(); |
apatrick@chromium.org | 8716404 | 2011-05-20 07:28:25 +0900 | [diff] [blame] | 467 | base::debug::Alias(&program_counter); |
| 468 | |
darin@google.com | be165ae | 2008-09-07 17:08:29 +0900 | [diff] [blame] | 469 | HistogramEvent(kTaskRunEvent); |
jar@chromium.org | 79a58c3 | 2011-10-16 08:52:45 +0900 | [diff] [blame] | 470 | |
jar@chromium.org | b536eef | 2011-11-14 14:24:07 +0900 | [diff] [blame] | 471 | tracked_objects::TrackedTime start_time = |
jar@chromium.org | b5c974b | 2011-12-14 10:36:48 +0900 | [diff] [blame] | 472 | tracked_objects::ThreadData::NowForStartOfRun(pending_task.birth_tally); |
jar@chromium.org | 79a58c3 | 2011-10-16 08:52:45 +0900 | [diff] [blame] | 473 | |
willchan@chromium.org | a904763 | 2010-06-10 06:20:41 +0900 | [diff] [blame] | 474 | FOR_EACH_OBSERVER(TaskObserver, task_observers_, |
rtenneti@chromium.org | 41712b0 | 2013-02-03 17:16:24 +0900 | [diff] [blame^] | 475 | WillProcessTask(pending_task)); |
ajwong@chromium.org | 94d2a58 | 2011-04-21 01:02:23 +0900 | [diff] [blame] | 476 | pending_task.task.Run(); |
| 477 | FOR_EACH_OBSERVER(TaskObserver, task_observers_, |
rtenneti@chromium.org | 41712b0 | 2013-02-03 17:16:24 +0900 | [diff] [blame^] | 478 | DidProcessTask(pending_task)); |
jar@chromium.org | 4be2cb0 | 2011-11-01 07:36:21 +0900 | [diff] [blame] | 479 | |
| 480 | tracked_objects::ThreadData::TallyRunOnNamedThreadIfTracking(pending_task, |
jar@chromium.org | b536eef | 2011-11-14 14:24:07 +0900 | [diff] [blame] | 481 | start_time, tracked_objects::ThreadData::NowForEndOfRun()); |
darin@google.com | be165ae | 2008-09-07 17:08:29 +0900 | [diff] [blame] | 482 | |
| 483 | nestable_tasks_allowed_ = true; |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 484 | } |
| 485 | |
jar@chromium.org | 79a58c3 | 2011-10-16 08:52:45 +0900 | [diff] [blame] | 486 | bool MessageLoop::DeferOrRunPendingTask(const PendingTask& pending_task) { |
jbates@chromium.org | 5d5b281 | 2012-06-29 07:57:30 +0900 | [diff] [blame] | 487 | if (pending_task.nestable || run_loop_->run_depth_ == 1) { |
ajwong@chromium.org | 94d2a58 | 2011-04-21 01:02:23 +0900 | [diff] [blame] | 488 | RunTask(pending_task); |
darin@google.com | be165ae | 2008-09-07 17:08:29 +0900 | [diff] [blame] | 489 | // Show that we ran a task (Note: a new one might arrive as a |
| 490 | // consequence!). |
| 491 | return true; |
| 492 | } |
| 493 | |
| 494 | // We couldn't run the task now because we're in a nested message loop |
| 495 | // and the task isn't nestable. |
| 496 | deferred_non_nestable_work_queue_.push(pending_task); |
| 497 | return false; |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 498 | } |
| 499 | |
darin@chromium.org | e3af17f | 2008-09-10 09:37:07 +0900 | [diff] [blame] | 500 | void MessageLoop::AddToDelayedWorkQueue(const PendingTask& pending_task) { |
jbates@chromium.org | 7cc8033 | 2012-09-18 12:41:29 +0900 | [diff] [blame] | 501 | // Move to the delayed work queue. |
| 502 | delayed_work_queue_.push(pending_task); |
darin@chromium.org | e3af17f | 2008-09-10 09:37:07 +0900 | [diff] [blame] | 503 | } |
| 504 | |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 505 | void MessageLoop::ReloadWorkQueue() { |
| 506 | // We can improve performance of our loading tasks from incoming_queue_ to |
darin@google.com | 981f355 | 2008-08-16 12:09:05 +0900 | [diff] [blame] | 507 | // work_queue_ by waiting until the last minute (work_queue_ is empty) to |
| 508 | // load. That reduces the number of locks-per-task significantly when our |
darin@google.com | be165ae | 2008-09-07 17:08:29 +0900 | [diff] [blame] | 509 | // queues get large. |
| 510 | if (!work_queue_.empty()) |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 511 | return; // Wait till we *really* need to lock and load. |
| 512 | |
| 513 | // Acquire all we can from the inter-thread queue with one lock acquisition. |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 514 | { |
brettw@chromium.org | abe477a | 2011-01-21 13:55:52 +0900 | [diff] [blame] | 515 | base::AutoLock lock(incoming_queue_lock_); |
darin@google.com | be165ae | 2008-09-07 17:08:29 +0900 | [diff] [blame] | 516 | if (incoming_queue_.empty()) |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 517 | return; |
darin@chromium.org | b80ef1a | 2009-09-03 05:05:21 +0900 | [diff] [blame] | 518 | incoming_queue_.Swap(&work_queue_); // Constant time |
darin@google.com | be165ae | 2008-09-07 17:08:29 +0900 | [diff] [blame] | 519 | DCHECK(incoming_queue_.empty()); |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 520 | } |
| 521 | } |
| 522 | |
darin@chromium.org | e3af17f | 2008-09-10 09:37:07 +0900 | [diff] [blame] | 523 | bool MessageLoop::DeletePendingTasks() { |
| 524 | bool did_work = !work_queue_.empty(); |
| 525 | while (!work_queue_.empty()) { |
| 526 | PendingTask pending_task = work_queue_.front(); |
| 527 | work_queue_.pop(); |
| 528 | if (!pending_task.delayed_run_time.is_null()) { |
| 529 | // We want to delete delayed tasks in the same order in which they would |
| 530 | // normally be deleted in case of any funny dependencies between delayed |
| 531 | // tasks. |
| 532 | AddToDelayedWorkQueue(pending_task); |
darin@chromium.org | e3af17f | 2008-09-10 09:37:07 +0900 | [diff] [blame] | 533 | } |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 534 | } |
darin@chromium.org | e3af17f | 2008-09-10 09:37:07 +0900 | [diff] [blame] | 535 | did_work |= !deferred_non_nestable_work_queue_.empty(); |
| 536 | while (!deferred_non_nestable_work_queue_.empty()) { |
jar@chromium.org | 2fa6b4b | 2009-03-12 04:53:50 +0900 | [diff] [blame] | 537 | deferred_non_nestable_work_queue_.pop(); |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 538 | } |
darin@chromium.org | e3af17f | 2008-09-10 09:37:07 +0900 | [diff] [blame] | 539 | did_work |= !delayed_work_queue_.empty(); |
ajwong@chromium.org | 94d2a58 | 2011-04-21 01:02:23 +0900 | [diff] [blame] | 540 | |
| 541 | // Historically, we always delete the task regardless of valgrind status. It's |
| 542 | // not completely clear why we want to leak them in the loops above. This |
| 543 | // code is replicating legacy behavior, and should not be considered |
| 544 | // absolutely "correct" behavior. See TODO above about deleting all tasks |
| 545 | // when it's safe. |
darin@chromium.org | e3af17f | 2008-09-10 09:37:07 +0900 | [diff] [blame] | 546 | while (!delayed_work_queue_.empty()) { |
darin@chromium.org | e3af17f | 2008-09-10 09:37:07 +0900 | [diff] [blame] | 547 | delayed_work_queue_.pop(); |
darin@chromium.org | e3af17f | 2008-09-10 09:37:07 +0900 | [diff] [blame] | 548 | } |
| 549 | return did_work; |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 550 | } |
| 551 | |
tedvessenes@gmail.com | c9fdf90 | 2012-06-22 02:31:56 +0900 | [diff] [blame] | 552 | TimeTicks MessageLoop::CalculateDelayedRuntime(TimeDelta delay) { |
ajwong@chromium.org | 94d2a58 | 2011-04-21 01:02:23 +0900 | [diff] [blame] | 553 | TimeTicks delayed_run_time; |
tedvessenes@gmail.com | c9fdf90 | 2012-06-22 02:31:56 +0900 | [diff] [blame] | 554 | if (delay > TimeDelta()) { |
| 555 | delayed_run_time = TimeTicks::Now() + delay; |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 556 | |
| 557 | #if defined(OS_WIN) |
| 558 | if (high_resolution_timer_expiration_.is_null()) { |
| 559 | // Windows timers are granular to 15.6ms. If we only set high-res |
| 560 | // timers for those under 15.6ms, then a 18ms timer ticks at ~32ms, |
| 561 | // which as a percentage is pretty inaccurate. So enable high |
| 562 | // res timers for any timer which is within 2x of the granularity. |
| 563 | // This is a tradeoff between accuracy and power management. |
tedvessenes@gmail.com | c9fdf90 | 2012-06-22 02:31:56 +0900 | [diff] [blame] | 564 | bool needs_high_res_timers = delay.InMilliseconds() < |
| 565 | (2 * base::Time::kMinLowResolutionThresholdMs); |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 566 | if (needs_high_res_timers) { |
mbelshe@chromium.org | bee85b3 | 2011-05-16 04:20:49 +0900 | [diff] [blame] | 567 | if (base::Time::ActivateHighResolutionTimer(true)) { |
| 568 | high_resolution_timer_expiration_ = TimeTicks::Now() + |
| 569 | TimeDelta::FromMilliseconds(kHighResolutionTimerModeLeaseTimeMs); |
| 570 | } |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 571 | } |
| 572 | } |
| 573 | #endif |
| 574 | } else { |
tedvessenes@gmail.com | c9fdf90 | 2012-06-22 02:31:56 +0900 | [diff] [blame] | 575 | DCHECK_EQ(delay.InMilliseconds(), 0) << "delay should not be negative"; |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 576 | } |
| 577 | |
| 578 | #if defined(OS_WIN) |
| 579 | if (!high_resolution_timer_expiration_.is_null()) { |
| 580 | if (TimeTicks::Now() > high_resolution_timer_expiration_) { |
| 581 | base::Time::ActivateHighResolutionTimer(false); |
| 582 | high_resolution_timer_expiration_ = TimeTicks(); |
| 583 | } |
| 584 | } |
| 585 | #endif |
| 586 | |
ajwong@chromium.org | 94d2a58 | 2011-04-21 01:02:23 +0900 | [diff] [blame] | 587 | return delayed_run_time; |
| 588 | } |
| 589 | |
| 590 | // Possibly called on a background thread! |
| 591 | void MessageLoop::AddToIncomingQueue(PendingTask* pending_task) { |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 592 | // Warning: Don't try to short-circuit, and handle this thread's tasks more |
| 593 | // directly, as it could starve handling of foreign threads. Put every task |
| 594 | // into this queue. |
| 595 | |
| 596 | scoped_refptr<base::MessagePump> pump; |
| 597 | { |
brettw@chromium.org | abe477a | 2011-01-21 13:55:52 +0900 | [diff] [blame] | 598 | base::AutoLock locked(incoming_queue_lock_); |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 599 | |
jbates@chromium.org | 7cc8033 | 2012-09-18 12:41:29 +0900 | [diff] [blame] | 600 | // Initialize the sequence number. The sequence number is used for delayed |
| 601 | // tasks (to faciliate FIFO sorting when two tasks have the same |
| 602 | // delayed_run_time value) and for identifying the task in about:tracing. |
| 603 | pending_task->sequence_num = next_sequence_num_++; |
| 604 | |
| 605 | TRACE_EVENT_FLOW_BEGIN0("task", "MessageLoop::PostTask", |
| 606 | TRACE_ID_MANGLE(GetTaskTraceID(*pending_task, this))); |
| 607 | |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 608 | bool was_empty = incoming_queue_.empty(); |
ajwong@chromium.org | 94d2a58 | 2011-04-21 01:02:23 +0900 | [diff] [blame] | 609 | incoming_queue_.push(*pending_task); |
| 610 | pending_task->task.Reset(); |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 611 | if (!was_empty) |
| 612 | return; // Someone else should have started the sub-pump. |
| 613 | |
| 614 | pump = pump_; |
| 615 | } |
| 616 | // Since the incoming_queue_ may contain a task that destroys this message |
| 617 | // loop, we cannot exit incoming_queue_lock_ until we are done with |this|. |
| 618 | // We use a stack-based reference to the message pump so that we can call |
| 619 | // ScheduleWork outside of incoming_queue_lock_. |
| 620 | |
| 621 | pump->ScheduleWork(); |
| 622 | } |
| 623 | |
| 624 | //------------------------------------------------------------------------------ |
| 625 | // Method and data for histogramming events and actions taken by each instance |
| 626 | // on each thread. |
| 627 | |
| 628 | void MessageLoop::StartHistogrammer() { |
bbudge@chromium.org | 5685aad | 2012-10-28 22:09:33 +0900 | [diff] [blame] | 629 | #if !defined(OS_NACL) // NaCl build has no metrics code. |
jar@chromium.org | 3457114 | 2011-04-05 13:48:53 +0900 | [diff] [blame] | 630 | if (enable_histogrammer_ && !message_histogram_ |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 631 | && base::StatisticsRecorder::IsActive()) { |
| 632 | DCHECK(!thread_name_.empty()); |
kaiwang@chromium.org | 7c950a8 | 2012-10-31 15:20:25 +0900 | [diff] [blame] | 633 | message_histogram_ = base::LinearHistogram::FactoryGetWithRangeDescription( |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 634 | "MsgLoop:" + thread_name_, |
| 635 | kLeastNonZeroMessageId, kMaxMessageId, |
| 636 | kNumberOfDistinctMessagesDisplayed, |
kaiwang@chromium.org | 7c950a8 | 2012-10-31 15:20:25 +0900 | [diff] [blame] | 637 | message_histogram_->kHexRangePrintingFlag, |
| 638 | event_descriptions_); |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 639 | } |
bbudge@chromium.org | 5685aad | 2012-10-28 22:09:33 +0900 | [diff] [blame] | 640 | #endif |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 641 | } |
| 642 | |
| 643 | void MessageLoop::HistogramEvent(int event) { |
bbudge@chromium.org | 5685aad | 2012-10-28 22:09:33 +0900 | [diff] [blame] | 644 | #if !defined(OS_NACL) |
jar@chromium.org | 3457114 | 2011-04-05 13:48:53 +0900 | [diff] [blame] | 645 | if (message_histogram_) |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 646 | message_histogram_->Add(event); |
bbudge@chromium.org | 5685aad | 2012-10-28 22:09:33 +0900 | [diff] [blame] | 647 | #endif |
erg@google.com | 67a2543 | 2011-01-08 05:23:43 +0900 | [diff] [blame] | 648 | } |
| 649 | |
darin@google.com | 981f355 | 2008-08-16 12:09:05 +0900 | [diff] [blame] | 650 | bool MessageLoop::DoWork() { |
darin@google.com | be165ae | 2008-09-07 17:08:29 +0900 | [diff] [blame] | 651 | if (!nestable_tasks_allowed_) { |
| 652 | // Task can't be executed right now. |
| 653 | return false; |
| 654 | } |
| 655 | |
| 656 | for (;;) { |
| 657 | ReloadWorkQueue(); |
| 658 | if (work_queue_.empty()) |
| 659 | break; |
| 660 | |
| 661 | // Execute oldest task. |
| 662 | do { |
| 663 | PendingTask pending_task = work_queue_.front(); |
| 664 | work_queue_.pop(); |
| 665 | if (!pending_task.delayed_run_time.is_null()) { |
darin@chromium.org | e3af17f | 2008-09-10 09:37:07 +0900 | [diff] [blame] | 666 | AddToDelayedWorkQueue(pending_task); |
ajwong@chromium.org | 94d2a58 | 2011-04-21 01:02:23 +0900 | [diff] [blame] | 667 | // If we changed the topmost task, then it is time to reschedule. |
| 668 | if (delayed_work_queue_.top().task.Equals(pending_task.task)) |
darin@google.com | be165ae | 2008-09-07 17:08:29 +0900 | [diff] [blame] | 669 | pump_->ScheduleDelayedWork(pending_task.delayed_run_time); |
| 670 | } else { |
| 671 | if (DeferOrRunPendingTask(pending_task)) |
| 672 | return true; |
| 673 | } |
| 674 | } while (!work_queue_.empty()); |
| 675 | } |
| 676 | |
| 677 | // Nothing happened. |
| 678 | return false; |
darin@google.com | 981f355 | 2008-08-16 12:09:05 +0900 | [diff] [blame] | 679 | } |
| 680 | |
ajwong@chromium.org | 94d2a58 | 2011-04-21 01:02:23 +0900 | [diff] [blame] | 681 | bool MessageLoop::DoDelayedWork(TimeTicks* next_delayed_work_time) { |
jar@chromium.org | 4035507 | 2010-10-21 15:32:33 +0900 | [diff] [blame] | 682 | if (!nestable_tasks_allowed_ || delayed_work_queue_.empty()) { |
jar@chromium.org | 9b0fb06 | 2010-11-07 07:23:29 +0900 | [diff] [blame] | 683 | recent_time_ = *next_delayed_work_time = TimeTicks(); |
darin@google.com | be165ae | 2008-09-07 17:08:29 +0900 | [diff] [blame] | 684 | return false; |
| 685 | } |
jeremy@chromium.org | 2ed223c | 2008-12-09 02:36:06 +0900 | [diff] [blame] | 686 | |
jar@chromium.org | 9b0fb06 | 2010-11-07 07:23:29 +0900 | [diff] [blame] | 687 | // When we "fall behind," there will be a lot of tasks in the delayed work |
jar@chromium.org | 94f7383 | 2010-11-05 08:23:42 +0900 | [diff] [blame] | 688 | // queue that are ready to run. To increase efficiency when we fall behind, |
| 689 | // we will only call Time::Now() intermittently, and then process all tasks |
| 690 | // that are ready to run before calling it again. As a result, the more we |
| 691 | // fall behind (and have a lot of ready-to-run delayed tasks), the more |
| 692 | // efficient we'll be at handling the tasks. |
jar@chromium.org | 9b0fb06 | 2010-11-07 07:23:29 +0900 | [diff] [blame] | 693 | |
| 694 | TimeTicks next_run_time = delayed_work_queue_.top().delayed_run_time; |
jar@chromium.org | 94f7383 | 2010-11-05 08:23:42 +0900 | [diff] [blame] | 695 | if (next_run_time > recent_time_) { |
jar@chromium.org | 9b0fb06 | 2010-11-07 07:23:29 +0900 | [diff] [blame] | 696 | recent_time_ = TimeTicks::Now(); // Get a better view of Now(); |
jar@chromium.org | 94f7383 | 2010-11-05 08:23:42 +0900 | [diff] [blame] | 697 | if (next_run_time > recent_time_) { |
| 698 | *next_delayed_work_time = next_run_time; |
| 699 | return false; |
| 700 | } |
darin@google.com | be165ae | 2008-09-07 17:08:29 +0900 | [diff] [blame] | 701 | } |
darin@google.com | 981f355 | 2008-08-16 12:09:05 +0900 | [diff] [blame] | 702 | |
jar@chromium.org | 4035507 | 2010-10-21 15:32:33 +0900 | [diff] [blame] | 703 | PendingTask pending_task = delayed_work_queue_.top(); |
| 704 | delayed_work_queue_.pop(); |
jeremy@chromium.org | 2ed223c | 2008-12-09 02:36:06 +0900 | [diff] [blame] | 705 | |
jar@chromium.org | 4035507 | 2010-10-21 15:32:33 +0900 | [diff] [blame] | 706 | if (!delayed_work_queue_.empty()) |
darin@google.com | be165ae | 2008-09-07 17:08:29 +0900 | [diff] [blame] | 707 | *next_delayed_work_time = delayed_work_queue_.top().delayed_run_time; |
darin@google.com | 981f355 | 2008-08-16 12:09:05 +0900 | [diff] [blame] | 708 | |
darin@google.com | be165ae | 2008-09-07 17:08:29 +0900 | [diff] [blame] | 709 | return DeferOrRunPendingTask(pending_task); |
darin@google.com | 981f355 | 2008-08-16 12:09:05 +0900 | [diff] [blame] | 710 | } |
| 711 | |
| 712 | bool MessageLoop::DoIdleWork() { |
| 713 | if (ProcessNextDelayedNonNestableTask()) |
| 714 | return true; |
| 715 | |
jbates@chromium.org | 5d5b281 | 2012-06-29 07:57:30 +0900 | [diff] [blame] | 716 | if (run_loop_->quit_when_idle_received_) |
darin@google.com | 981f355 | 2008-08-16 12:09:05 +0900 | [diff] [blame] | 717 | pump_->Quit(); |
| 718 | |
| 719 | return false; |
| 720 | } |
| 721 | |
dcheng@chromium.org | 3690474 | 2011-12-30 13:32:58 +0900 | [diff] [blame] | 722 | void MessageLoop::DeleteSoonInternal(const tracked_objects::Location& from_here, |
| 723 | void(*deleter)(const void*), |
| 724 | const void* object) { |
| 725 | PostNonNestableTask(from_here, base::Bind(deleter, object)); |
| 726 | } |
| 727 | |
dcheng@chromium.org | 2116fc9 | 2011-12-30 15:46:30 +0900 | [diff] [blame] | 728 | void MessageLoop::ReleaseSoonInternal( |
| 729 | const tracked_objects::Location& from_here, |
| 730 | void(*releaser)(const void*), |
| 731 | const void* object) { |
| 732 | PostNonNestableTask(from_here, base::Bind(releaser, object)); |
| 733 | } |
| 734 | |
darin@google.com | 981f355 | 2008-08-16 12:09:05 +0900 | [diff] [blame] | 735 | //------------------------------------------------------------------------------ |
darin@google.com | d936b5b | 2008-08-26 14:53:57 +0900 | [diff] [blame] | 736 | // MessageLoopForUI |
| 737 | |
| 738 | #if defined(OS_WIN) |
darin@google.com | d936b5b | 2008-08-26 14:53:57 +0900 | [diff] [blame] | 739 | void MessageLoopForUI::DidProcessMessage(const MSG& message) { |
| 740 | pump_win()->DidProcessMessage(message); |
| 741 | } |
darin@google.com | d936b5b | 2008-08-26 14:53:57 +0900 | [diff] [blame] | 742 | #endif // defined(OS_WIN) |
| 743 | |
michaelbai@google.com | 686190b | 2011-08-03 01:11:16 +0900 | [diff] [blame] | 744 | #if defined(OS_ANDROID) |
| 745 | void MessageLoopForUI::Start() { |
| 746 | // No Histogram support for UI message loop as it is managed by Java side |
| 747 | static_cast<base::MessagePumpForUI*>(pump_.get())->Start(this); |
| 748 | } |
| 749 | #endif |
| 750 | |
rohitrao@chromium.org | dcc4902 | 2012-07-13 20:02:57 +0900 | [diff] [blame] | 751 | #if defined(OS_IOS) |
| 752 | void MessageLoopForUI::Attach() { |
| 753 | static_cast<base::MessagePumpUIApplication*>(pump_.get())->Attach(this); |
| 754 | } |
| 755 | #endif |
| 756 | |
michaelbai@google.com | 686190b | 2011-08-03 01:11:16 +0900 | [diff] [blame] | 757 | #if !defined(OS_MACOSX) && !defined(OS_NACL) && !defined(OS_ANDROID) |
jcampan@chromium.org | 0542358 | 2009-08-01 07:53:37 +0900 | [diff] [blame] | 758 | void MessageLoopForUI::AddObserver(Observer* observer) { |
| 759 | pump_ui()->AddObserver(observer); |
| 760 | } |
| 761 | |
| 762 | void MessageLoopForUI::RemoveObserver(Observer* observer) { |
| 763 | pump_ui()->RemoveObserver(observer); |
| 764 | } |
| 765 | |
michaelbai@google.com | 686190b | 2011-08-03 01:11:16 +0900 | [diff] [blame] | 766 | #endif // !defined(OS_MACOSX) && !defined(OS_NACL) && !defined(OS_ANDROID) |
jcampan@chromium.org | 0542358 | 2009-08-01 07:53:37 +0900 | [diff] [blame] | 767 | |
darin@google.com | d936b5b | 2008-08-26 14:53:57 +0900 | [diff] [blame] | 768 | //------------------------------------------------------------------------------ |
| 769 | // MessageLoopForIO |
| 770 | |
| 771 | #if defined(OS_WIN) |
| 772 | |
rvargas@google.com | 9e49aa2 | 2008-10-10 08:58:43 +0900 | [diff] [blame] | 773 | void MessageLoopForIO::RegisterIOHandler(HANDLE file, IOHandler* handler) { |
| 774 | pump_io()->RegisterIOHandler(file, handler); |
| 775 | } |
| 776 | |
alexeypa@chromium.org | 03c65ac | 2012-08-17 06:28:11 +0900 | [diff] [blame] | 777 | bool MessageLoopForIO::RegisterJobObject(HANDLE job, IOHandler* handler) { |
| 778 | return pump_io()->RegisterJobObject(job, handler); |
| 779 | } |
| 780 | |
rvargas@google.com | 7388754 | 2008-11-08 06:52:15 +0900 | [diff] [blame] | 781 | bool MessageLoopForIO::WaitForIOCompletion(DWORD timeout, IOHandler* filter) { |
| 782 | return pump_io()->WaitForIOCompletion(timeout, filter); |
rvargas@google.com | 9e49aa2 | 2008-10-10 08:58:43 +0900 | [diff] [blame] | 783 | } |
| 784 | |
blundell@chromium.org | e21b2aa | 2012-12-01 02:29:40 +0900 | [diff] [blame] | 785 | #elif defined(OS_IOS) |
| 786 | |
| 787 | bool MessageLoopForIO::WatchFileDescriptor(int fd, |
| 788 | bool persistent, |
| 789 | Mode mode, |
| 790 | FileDescriptorWatcher *controller, |
| 791 | Watcher *delegate) { |
| 792 | return pump_io()->WatchFileDescriptor( |
| 793 | fd, |
| 794 | persistent, |
| 795 | mode, |
| 796 | controller, |
| 797 | delegate); |
| 798 | } |
| 799 | |
abarth@chromium.org | 1f1c217 | 2010-12-01 17:45:51 +0900 | [diff] [blame] | 800 | #elif defined(OS_POSIX) && !defined(OS_NACL) |
dkegel@google.com | 9e044ae | 2008-09-19 03:46:26 +0900 | [diff] [blame] | 801 | |
jeremy@chromium.org | efc0db0 | 2008-12-16 07:02:17 +0900 | [diff] [blame] | 802 | bool MessageLoopForIO::WatchFileDescriptor(int fd, |
| 803 | bool persistent, |
| 804 | Mode mode, |
| 805 | FileDescriptorWatcher *controller, |
| 806 | Watcher *delegate) { |
| 807 | return pump_libevent()->WatchFileDescriptor( |
| 808 | fd, |
| 809 | persistent, |
blundell@chromium.org | e21b2aa | 2012-12-01 02:29:40 +0900 | [diff] [blame] | 810 | mode, |
jeremy@chromium.org | efc0db0 | 2008-12-16 07:02:17 +0900 | [diff] [blame] | 811 | controller, |
| 812 | delegate); |
dkegel@google.com | 9e044ae | 2008-09-19 03:46:26 +0900 | [diff] [blame] | 813 | } |
| 814 | |
dkegel@google.com | 9e044ae | 2008-09-19 03:46:26 +0900 | [diff] [blame] | 815 | #endif |