jhorwich@chromium.org | 3c3a813 | 2012-01-12 07:39:54 +0900 | [diff] [blame] | 1 | // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +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. |
| 4 | // |
| 5 | // Unit test for SyncChannel. |
| 6 | |
dmaclach@chromium.org | c1d3d42 | 2010-12-20 15:59:23 +0900 | [diff] [blame] | 7 | #include "ipc/ipc_sync_channel.h" |
| 8 | |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 9 | #include <string> |
| 10 | #include <vector> |
| 11 | |
| 12 | #include "base/basictypes.h" |
jhawkins@chromium.org | 9827bd1 | 2011-11-13 06:16:41 +0900 | [diff] [blame] | 13 | #include "base/bind.h" |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 14 | #include "base/logging.h" |
levin@chromium.org | 5c52868 | 2011-03-28 10:54:15 +0900 | [diff] [blame] | 15 | #include "base/memory/scoped_ptr.h" |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 16 | #include "base/message_loop.h" |
jschuh@chromium.org | a5cd076 | 2012-04-05 11:38:34 +0900 | [diff] [blame] | 17 | #include "base/process_util.h" |
dilmah@chromium.org | dc4b970 | 2011-07-20 07:13:24 +0900 | [diff] [blame] | 18 | #include "base/stl_util.h" |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 19 | #include "base/string_util.h" |
timurrrr@chromium.org | f39c3ff | 2010-05-14 17:24:42 +0900 | [diff] [blame] | 20 | #include "base/third_party/dynamic_annotations/dynamic_annotations.h" |
brettw@google.com | 7c5cc67 | 2011-01-01 11:17:08 +0900 | [diff] [blame] | 21 | #include "base/threading/platform_thread.h" |
brettw@chromium.org | 5b5f5e0 | 2011-01-01 10:01:06 +0900 | [diff] [blame] | 22 | #include "base/threading/thread.h" |
brettw@chromium.org | 5238c7d | 2011-01-02 15:05:39 +0900 | [diff] [blame] | 23 | #include "base/synchronization/waitable_event.h" |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 24 | #include "ipc/ipc_message.h" |
jabdelmalek@google.com | eb92165 | 2010-04-07 05:33:36 +0900 | [diff] [blame] | 25 | #include "ipc/ipc_sync_message_filter.h" |
jam@chromium.org | 86a8de1 | 2010-12-09 08:34:16 +0900 | [diff] [blame] | 26 | #include "ipc/ipc_sync_message_unittest.h" |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 27 | #include "testing/gtest/include/gtest/gtest.h" |
| 28 | |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 29 | using base::WaitableEvent; |
| 30 | |
kushi.p@gmail.com | 5948bf4 | 2011-05-14 07:42:41 +0900 | [diff] [blame] | 31 | namespace IPC { |
| 32 | |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 33 | namespace { |
| 34 | |
| 35 | // Base class for a "process" with listener and IPC threads. |
| 36 | class Worker : public Channel::Listener, public Message::Sender { |
| 37 | public: |
| 38 | // Will create a channel without a name. |
| 39 | Worker(Channel::Mode mode, const std::string& thread_name) |
| 40 | : done_(new WaitableEvent(false, false)), |
| 41 | channel_created_(new WaitableEvent(false, false)), |
| 42 | mode_(mode), |
| 43 | ipc_thread_((thread_name + "_ipc").c_str()), |
| 44 | listener_thread_((thread_name + "_listener").c_str()), |
| 45 | overrided_thread_(NULL), |
timurrrr@chromium.org | 03100a8 | 2009-10-27 20:28:58 +0900 | [diff] [blame] | 46 | shutdown_event_(true, false) { |
| 47 | // The data race on vfptr is real but is very hard |
| 48 | // to suppress using standard Valgrind mechanism (suppressions). |
| 49 | // We have to use ANNOTATE_BENIGN_RACE to hide the reports and |
| 50 | // make ThreadSanitizer bots green. |
| 51 | ANNOTATE_BENIGN_RACE(this, "Race on vfptr, http://crbug.com/25841"); |
| 52 | } |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 53 | |
| 54 | // Will create a named channel and use this name for the threads' name. |
| 55 | Worker(const std::string& channel_name, Channel::Mode mode) |
| 56 | : done_(new WaitableEvent(false, false)), |
| 57 | channel_created_(new WaitableEvent(false, false)), |
| 58 | channel_name_(channel_name), |
| 59 | mode_(mode), |
| 60 | ipc_thread_((channel_name + "_ipc").c_str()), |
| 61 | listener_thread_((channel_name + "_listener").c_str()), |
| 62 | overrided_thread_(NULL), |
timurrrr@chromium.org | 03100a8 | 2009-10-27 20:28:58 +0900 | [diff] [blame] | 63 | shutdown_event_(true, false) { |
| 64 | // The data race on vfptr is real but is very hard |
| 65 | // to suppress using standard Valgrind mechanism (suppressions). |
| 66 | // We have to use ANNOTATE_BENIGN_RACE to hide the reports and |
| 67 | // make ThreadSanitizer bots green. |
| 68 | ANNOTATE_BENIGN_RACE(this, "Race on vfptr, http://crbug.com/25841"); |
| 69 | } |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 70 | |
| 71 | // The IPC thread needs to outlive SyncChannel, so force the correct order of |
| 72 | // destruction. |
| 73 | virtual ~Worker() { |
| 74 | WaitableEvent listener_done(false, false), ipc_done(false, false); |
jhawkins@chromium.org | 9827bd1 | 2011-11-13 06:16:41 +0900 | [diff] [blame] | 75 | ListenerThread()->message_loop()->PostTask( |
| 76 | FROM_HERE, base::Bind(&Worker::OnListenerThreadShutdown1, this, |
| 77 | &listener_done, &ipc_done)); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 78 | listener_done.Wait(); |
| 79 | ipc_done.Wait(); |
| 80 | ipc_thread_.Stop(); |
| 81 | listener_thread_.Stop(); |
| 82 | } |
| 83 | void AddRef() { } |
| 84 | void Release() { } |
darin@chromium.org | 5cb996e | 2009-09-30 13:29:20 +0900 | [diff] [blame] | 85 | static bool ImplementsThreadSafeReferenceCounting() { return true; } |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 86 | bool Send(Message* msg) { return channel_->Send(msg); } |
| 87 | bool SendWithTimeout(Message* msg, int timeout_ms) { |
| 88 | return channel_->SendWithTimeout(msg, timeout_ms); |
| 89 | } |
| 90 | void WaitForChannelCreation() { channel_created_->Wait(); } |
| 91 | void CloseChannel() { |
| 92 | DCHECK(MessageLoop::current() == ListenerThread()->message_loop()); |
| 93 | channel_->Close(); |
| 94 | } |
| 95 | void Start() { |
| 96 | StartThread(&listener_thread_, MessageLoop::TYPE_DEFAULT); |
jhawkins@chromium.org | 9827bd1 | 2011-11-13 06:16:41 +0900 | [diff] [blame] | 97 | ListenerThread()->message_loop()->PostTask( |
| 98 | FROM_HERE, base::Bind(&Worker::OnStart, this)); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 99 | } |
| 100 | void OverrideThread(base::Thread* overrided_thread) { |
| 101 | DCHECK(overrided_thread_ == NULL); |
| 102 | overrided_thread_ = overrided_thread; |
| 103 | } |
| 104 | bool SendAnswerToLife(bool pump, int timeout, bool succeed) { |
| 105 | int answer = 0; |
| 106 | SyncMessage* msg = new SyncChannelTestMsg_AnswerToLife(&answer); |
| 107 | if (pump) |
| 108 | msg->EnableMessagePumping(); |
| 109 | bool result = SendWithTimeout(msg, timeout); |
jam@chromium.org | ebd0718 | 2009-12-01 11:34:18 +0900 | [diff] [blame] | 110 | DCHECK_EQ(result, succeed); |
| 111 | DCHECK_EQ(answer, (succeed ? 42 : 0)); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 112 | return result; |
| 113 | } |
| 114 | bool SendDouble(bool pump, bool succeed) { |
| 115 | int answer = 0; |
| 116 | SyncMessage* msg = new SyncChannelTestMsg_Double(5, &answer); |
| 117 | if (pump) |
| 118 | msg->EnableMessagePumping(); |
| 119 | bool result = Send(msg); |
jam@chromium.org | ebd0718 | 2009-12-01 11:34:18 +0900 | [diff] [blame] | 120 | DCHECK_EQ(result, succeed); |
| 121 | DCHECK_EQ(answer, (succeed ? 10 : 0)); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 122 | return result; |
| 123 | } |
kkania@chromium.org | 9ccb469 | 2011-11-16 10:06:46 +0900 | [diff] [blame] | 124 | const std::string& channel_name() { return channel_name_; } |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 125 | Channel::Mode mode() { return mode_; } |
| 126 | WaitableEvent* done_event() { return done_.get(); } |
jabdelmalek@google.com | eb92165 | 2010-04-07 05:33:36 +0900 | [diff] [blame] | 127 | WaitableEvent* shutdown_event() { return &shutdown_event_; } |
jam@chromium.org | ebd0718 | 2009-12-01 11:34:18 +0900 | [diff] [blame] | 128 | void ResetChannel() { channel_.reset(); } |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 129 | // Derived classes need to call this when they've completed their part of |
| 130 | // the test. |
| 131 | void Done() { done_->Signal(); } |
jabdelmalek@google.com | eb92165 | 2010-04-07 05:33:36 +0900 | [diff] [blame] | 132 | |
| 133 | protected: |
kushi.p@gmail.com | 5948bf4 | 2011-05-14 07:42:41 +0900 | [diff] [blame] | 134 | SyncChannel* channel() { return channel_.get(); } |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 135 | // Functions for dervied classes to implement if they wish. |
| 136 | virtual void Run() { } |
| 137 | virtual void OnAnswer(int* answer) { NOTREACHED(); } |
| 138 | virtual void OnAnswerDelay(Message* reply_msg) { |
| 139 | // The message handler map below can only take one entry for |
| 140 | // SyncChannelTestMsg_AnswerToLife, so since some classes want |
| 141 | // the normal version while other want the delayed reply, we |
| 142 | // call the normal version if the derived class didn't override |
| 143 | // this function. |
| 144 | int answer; |
| 145 | OnAnswer(&answer); |
| 146 | SyncChannelTestMsg_AnswerToLife::WriteReplyParams(reply_msg, answer); |
| 147 | Send(reply_msg); |
| 148 | } |
| 149 | virtual void OnDouble(int in, int* out) { NOTREACHED(); } |
| 150 | virtual void OnDoubleDelay(int in, Message* reply_msg) { |
| 151 | int result; |
| 152 | OnDouble(in, &result); |
| 153 | SyncChannelTestMsg_Double::WriteReplyParams(reply_msg, result); |
| 154 | Send(reply_msg); |
| 155 | } |
| 156 | |
ananta@chromium.org | 31b338f | 2009-10-15 01:22:02 +0900 | [diff] [blame] | 157 | virtual void OnNestedTestMsg(Message* reply_msg) { |
| 158 | NOTREACHED(); |
| 159 | } |
| 160 | |
kkania@chromium.org | 9ccb469 | 2011-11-16 10:06:46 +0900 | [diff] [blame] | 161 | virtual SyncChannel* CreateChannel() { |
| 162 | return new SyncChannel( |
| 163 | channel_name_, mode_, this, ipc_thread_.message_loop_proxy(), true, |
| 164 | &shutdown_event_); |
| 165 | } |
| 166 | |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 167 | base::Thread* ListenerThread() { |
| 168 | return overrided_thread_ ? overrided_thread_ : &listener_thread_; |
| 169 | } |
ananta@chromium.org | 999f297 | 2010-09-03 06:45:50 +0900 | [diff] [blame] | 170 | |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 171 | const base::Thread& ipc_thread() const { return ipc_thread_; } |
| 172 | |
ananta@chromium.org | 999f297 | 2010-09-03 06:45:50 +0900 | [diff] [blame] | 173 | private: |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 174 | // Called on the listener thread to create the sync channel. |
| 175 | void OnStart() { |
| 176 | // Link ipc_thread_, listener_thread_ and channel_ altogether. |
| 177 | StartThread(&ipc_thread_, MessageLoop::TYPE_IO); |
kkania@chromium.org | 9ccb469 | 2011-11-16 10:06:46 +0900 | [diff] [blame] | 178 | channel_.reset(CreateChannel()); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 179 | channel_created_->Signal(); |
| 180 | Run(); |
| 181 | } |
| 182 | |
| 183 | void OnListenerThreadShutdown1(WaitableEvent* listener_event, |
| 184 | WaitableEvent* ipc_event) { |
| 185 | // SyncChannel needs to be destructed on the thread that it was created on. |
| 186 | channel_.reset(); |
| 187 | |
| 188 | MessageLoop::current()->RunAllPending(); |
| 189 | |
jhawkins@chromium.org | 9827bd1 | 2011-11-13 06:16:41 +0900 | [diff] [blame] | 190 | ipc_thread_.message_loop()->PostTask( |
| 191 | FROM_HERE, base::Bind(&Worker::OnIPCThreadShutdown, this, |
| 192 | listener_event, ipc_event)); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 193 | } |
| 194 | |
| 195 | void OnIPCThreadShutdown(WaitableEvent* listener_event, |
| 196 | WaitableEvent* ipc_event) { |
| 197 | MessageLoop::current()->RunAllPending(); |
| 198 | ipc_event->Signal(); |
| 199 | |
jhawkins@chromium.org | 9827bd1 | 2011-11-13 06:16:41 +0900 | [diff] [blame] | 200 | listener_thread_.message_loop()->PostTask( |
| 201 | FROM_HERE, base::Bind(&Worker::OnListenerThreadShutdown2, this, |
| 202 | listener_event)); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 203 | } |
| 204 | |
| 205 | void OnListenerThreadShutdown2(WaitableEvent* listener_event) { |
| 206 | MessageLoop::current()->RunAllPending(); |
| 207 | listener_event->Signal(); |
| 208 | } |
| 209 | |
jam@chromium.org | 8a2c784 | 2010-12-24 15:19:28 +0900 | [diff] [blame] | 210 | bool OnMessageReceived(const Message& message) { |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 211 | IPC_BEGIN_MESSAGE_MAP(Worker, message) |
| 212 | IPC_MESSAGE_HANDLER_DELAY_REPLY(SyncChannelTestMsg_Double, OnDoubleDelay) |
| 213 | IPC_MESSAGE_HANDLER_DELAY_REPLY(SyncChannelTestMsg_AnswerToLife, |
| 214 | OnAnswerDelay) |
ananta@chromium.org | 31b338f | 2009-10-15 01:22:02 +0900 | [diff] [blame] | 215 | IPC_MESSAGE_HANDLER_DELAY_REPLY(SyncChannelNestedTestMsg_String, |
| 216 | OnNestedTestMsg) |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 217 | IPC_END_MESSAGE_MAP() |
jam@chromium.org | 8a2c784 | 2010-12-24 15:19:28 +0900 | [diff] [blame] | 218 | return true; |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 219 | } |
| 220 | |
| 221 | void StartThread(base::Thread* thread, MessageLoop::Type type) { |
| 222 | base::Thread::Options options; |
| 223 | options.message_loop_type = type; |
| 224 | thread->StartWithOptions(options); |
| 225 | } |
| 226 | |
| 227 | scoped_ptr<WaitableEvent> done_; |
| 228 | scoped_ptr<WaitableEvent> channel_created_; |
| 229 | std::string channel_name_; |
| 230 | Channel::Mode mode_; |
| 231 | scoped_ptr<SyncChannel> channel_; |
| 232 | base::Thread ipc_thread_; |
| 233 | base::Thread listener_thread_; |
| 234 | base::Thread* overrided_thread_; |
| 235 | |
| 236 | base::WaitableEvent shutdown_event_; |
| 237 | |
tfarina@chromium.org | b73eaee | 2010-06-07 11:10:18 +0900 | [diff] [blame] | 238 | DISALLOW_COPY_AND_ASSIGN(Worker); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 239 | }; |
| 240 | |
| 241 | |
| 242 | // Starts the test with the given workers. This function deletes the workers |
| 243 | // when it's done. |
| 244 | void RunTest(std::vector<Worker*> workers) { |
| 245 | // First we create the workers that are channel servers, or else the other |
| 246 | // workers' channel initialization might fail because the pipe isn't created.. |
| 247 | for (size_t i = 0; i < workers.size(); ++i) { |
dmaclach@chromium.org | f146c29 | 2011-02-04 05:35:09 +0900 | [diff] [blame] | 248 | if (workers[i]->mode() & Channel::MODE_SERVER_FLAG) { |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 249 | workers[i]->Start(); |
| 250 | workers[i]->WaitForChannelCreation(); |
| 251 | } |
| 252 | } |
| 253 | |
| 254 | // now create the clients |
| 255 | for (size_t i = 0; i < workers.size(); ++i) { |
dmaclach@chromium.org | f146c29 | 2011-02-04 05:35:09 +0900 | [diff] [blame] | 256 | if (workers[i]->mode() & Channel::MODE_CLIENT_FLAG) |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 257 | workers[i]->Start(); |
| 258 | } |
| 259 | |
| 260 | // wait for all the workers to finish |
| 261 | for (size_t i = 0; i < workers.size(); ++i) |
| 262 | workers[i]->done_event()->Wait(); |
| 263 | |
| 264 | STLDeleteContainerPointers(workers.begin(), workers.end()); |
| 265 | } |
| 266 | |
| 267 | } // namespace |
| 268 | |
| 269 | class IPCSyncChannelTest : public testing::Test { |
| 270 | private: |
| 271 | MessageLoop message_loop_; |
| 272 | }; |
| 273 | |
| 274 | //----------------------------------------------------------------------------- |
| 275 | |
| 276 | namespace { |
| 277 | |
| 278 | class SimpleServer : public Worker { |
| 279 | public: |
thestig@chromium.org | 60bd7c0 | 2010-07-23 14:23:13 +0900 | [diff] [blame] | 280 | explicit SimpleServer(bool pump_during_send) |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 281 | : Worker(Channel::MODE_SERVER, "simpler_server"), |
| 282 | pump_during_send_(pump_during_send) { } |
| 283 | void Run() { |
| 284 | SendAnswerToLife(pump_during_send_, base::kNoTimeout, true); |
| 285 | Done(); |
| 286 | } |
| 287 | |
| 288 | bool pump_during_send_; |
| 289 | }; |
| 290 | |
| 291 | class SimpleClient : public Worker { |
| 292 | public: |
| 293 | SimpleClient() : Worker(Channel::MODE_CLIENT, "simple_client") { } |
| 294 | |
| 295 | void OnAnswer(int* answer) { |
| 296 | *answer = 42; |
| 297 | Done(); |
| 298 | } |
| 299 | }; |
| 300 | |
| 301 | void Simple(bool pump_during_send) { |
| 302 | std::vector<Worker*> workers; |
| 303 | workers.push_back(new SimpleServer(pump_during_send)); |
| 304 | workers.push_back(new SimpleClient()); |
| 305 | RunTest(workers); |
| 306 | } |
| 307 | |
| 308 | } // namespace |
| 309 | |
| 310 | // Tests basic synchronous call |
| 311 | TEST_F(IPCSyncChannelTest, Simple) { |
| 312 | Simple(false); |
| 313 | Simple(true); |
| 314 | } |
| 315 | |
| 316 | //----------------------------------------------------------------------------- |
| 317 | |
| 318 | namespace { |
| 319 | |
kkania@chromium.org | 9ccb469 | 2011-11-16 10:06:46 +0900 | [diff] [blame] | 320 | // Worker classes which override how the sync channel is created to use the |
| 321 | // two-step initialization (calling the lightweight constructor and then |
| 322 | // ChannelProxy::Init separately) process. |
| 323 | class TwoStepServer : public Worker { |
| 324 | public: |
| 325 | explicit TwoStepServer(bool create_pipe_now) |
| 326 | : Worker(Channel::MODE_SERVER, "simpler_server"), |
| 327 | create_pipe_now_(create_pipe_now) { } |
| 328 | |
| 329 | void Run() { |
| 330 | SendAnswerToLife(false, base::kNoTimeout, true); |
| 331 | Done(); |
| 332 | } |
| 333 | |
| 334 | virtual SyncChannel* CreateChannel() { |
| 335 | SyncChannel* channel = new SyncChannel( |
| 336 | this, ipc_thread().message_loop_proxy(), shutdown_event()); |
| 337 | channel->Init(channel_name(), mode(), create_pipe_now_); |
| 338 | return channel; |
| 339 | } |
| 340 | |
| 341 | bool create_pipe_now_; |
| 342 | }; |
| 343 | |
| 344 | class TwoStepClient : public Worker { |
| 345 | public: |
| 346 | TwoStepClient(bool create_pipe_now) |
| 347 | : Worker(Channel::MODE_CLIENT, "simple_client"), |
| 348 | create_pipe_now_(create_pipe_now) { } |
| 349 | |
| 350 | void OnAnswer(int* answer) { |
| 351 | *answer = 42; |
| 352 | Done(); |
| 353 | } |
| 354 | |
| 355 | virtual SyncChannel* CreateChannel() { |
| 356 | SyncChannel* channel = new SyncChannel( |
| 357 | this, ipc_thread().message_loop_proxy(), shutdown_event()); |
| 358 | channel->Init(channel_name(), mode(), create_pipe_now_); |
| 359 | return channel; |
| 360 | } |
| 361 | |
| 362 | bool create_pipe_now_; |
| 363 | }; |
| 364 | |
| 365 | void TwoStep(bool create_server_pipe_now, bool create_client_pipe_now) { |
| 366 | std::vector<Worker*> workers; |
| 367 | workers.push_back(new TwoStepServer(create_server_pipe_now)); |
| 368 | workers.push_back(new TwoStepClient(create_client_pipe_now)); |
| 369 | RunTest(workers); |
| 370 | } |
| 371 | |
| 372 | } // namespace |
| 373 | |
| 374 | // Tests basic two-step initialization, where you call the lightweight |
| 375 | // constructor then Init. |
| 376 | TEST_F(IPCSyncChannelTest, TwoStepInitialization) { |
| 377 | TwoStep(false, false); |
| 378 | TwoStep(false, true); |
| 379 | TwoStep(true, false); |
| 380 | TwoStep(true, true); |
| 381 | } |
| 382 | |
| 383 | |
| 384 | //----------------------------------------------------------------------------- |
| 385 | |
| 386 | namespace { |
| 387 | |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 388 | class DelayClient : public Worker { |
| 389 | public: |
| 390 | DelayClient() : Worker(Channel::MODE_CLIENT, "delay_client") { } |
| 391 | |
| 392 | void OnAnswerDelay(Message* reply_msg) { |
| 393 | SyncChannelTestMsg_AnswerToLife::WriteReplyParams(reply_msg, 42); |
| 394 | Send(reply_msg); |
| 395 | Done(); |
| 396 | } |
| 397 | }; |
| 398 | |
| 399 | void DelayReply(bool pump_during_send) { |
| 400 | std::vector<Worker*> workers; |
| 401 | workers.push_back(new SimpleServer(pump_during_send)); |
| 402 | workers.push_back(new DelayClient()); |
| 403 | RunTest(workers); |
| 404 | } |
| 405 | |
| 406 | } // namespace |
| 407 | |
| 408 | // Tests that asynchronous replies work |
| 409 | TEST_F(IPCSyncChannelTest, DelayReply) { |
| 410 | DelayReply(false); |
| 411 | DelayReply(true); |
| 412 | } |
| 413 | |
| 414 | //----------------------------------------------------------------------------- |
| 415 | |
| 416 | namespace { |
| 417 | |
| 418 | class NoHangServer : public Worker { |
| 419 | public: |
dilmah@chromium.org | 92b4c8e | 2011-07-27 02:25:25 +0900 | [diff] [blame] | 420 | NoHangServer(WaitableEvent* got_first_reply, bool pump_during_send) |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 421 | : Worker(Channel::MODE_SERVER, "no_hang_server"), |
| 422 | got_first_reply_(got_first_reply), |
| 423 | pump_during_send_(pump_during_send) { } |
| 424 | void Run() { |
| 425 | SendAnswerToLife(pump_during_send_, base::kNoTimeout, true); |
| 426 | got_first_reply_->Signal(); |
| 427 | |
| 428 | SendAnswerToLife(pump_during_send_, base::kNoTimeout, false); |
| 429 | Done(); |
| 430 | } |
| 431 | |
| 432 | WaitableEvent* got_first_reply_; |
| 433 | bool pump_during_send_; |
| 434 | }; |
| 435 | |
| 436 | class NoHangClient : public Worker { |
| 437 | public: |
| 438 | explicit NoHangClient(WaitableEvent* got_first_reply) |
| 439 | : Worker(Channel::MODE_CLIENT, "no_hang_client"), |
| 440 | got_first_reply_(got_first_reply) { } |
| 441 | |
| 442 | virtual void OnAnswerDelay(Message* reply_msg) { |
| 443 | // Use the DELAY_REPLY macro so that we can force the reply to be sent |
| 444 | // before this function returns (when the channel will be reset). |
| 445 | SyncChannelTestMsg_AnswerToLife::WriteReplyParams(reply_msg, 42); |
| 446 | Send(reply_msg); |
| 447 | got_first_reply_->Wait(); |
| 448 | CloseChannel(); |
| 449 | Done(); |
| 450 | } |
| 451 | |
| 452 | WaitableEvent* got_first_reply_; |
| 453 | }; |
| 454 | |
| 455 | void NoHang(bool pump_during_send) { |
| 456 | WaitableEvent got_first_reply(false, false); |
| 457 | std::vector<Worker*> workers; |
| 458 | workers.push_back(new NoHangServer(&got_first_reply, pump_during_send)); |
| 459 | workers.push_back(new NoHangClient(&got_first_reply)); |
| 460 | RunTest(workers); |
| 461 | } |
| 462 | |
| 463 | } // namespace |
| 464 | |
| 465 | // Tests that caller doesn't hang if receiver dies |
| 466 | TEST_F(IPCSyncChannelTest, NoHang) { |
| 467 | NoHang(false); |
| 468 | NoHang(true); |
| 469 | } |
| 470 | |
| 471 | //----------------------------------------------------------------------------- |
| 472 | |
| 473 | namespace { |
| 474 | |
| 475 | class UnblockServer : public Worker { |
| 476 | public: |
jam@chromium.org | ebd0718 | 2009-12-01 11:34:18 +0900 | [diff] [blame] | 477 | UnblockServer(bool pump_during_send, bool delete_during_send) |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 478 | : Worker(Channel::MODE_SERVER, "unblock_server"), |
jam@chromium.org | ebd0718 | 2009-12-01 11:34:18 +0900 | [diff] [blame] | 479 | pump_during_send_(pump_during_send), |
| 480 | delete_during_send_(delete_during_send) { } |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 481 | void Run() { |
jam@chromium.org | ebd0718 | 2009-12-01 11:34:18 +0900 | [diff] [blame] | 482 | if (delete_during_send_) { |
| 483 | // Use custom code since race conditions mean the answer may or may not be |
| 484 | // available. |
| 485 | int answer = 0; |
| 486 | SyncMessage* msg = new SyncChannelTestMsg_AnswerToLife(&answer); |
| 487 | if (pump_during_send_) |
| 488 | msg->EnableMessagePumping(); |
| 489 | Send(msg); |
| 490 | } else { |
| 491 | SendAnswerToLife(pump_during_send_, base::kNoTimeout, true); |
| 492 | } |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 493 | Done(); |
| 494 | } |
| 495 | |
jam@chromium.org | ebd0718 | 2009-12-01 11:34:18 +0900 | [diff] [blame] | 496 | void OnDoubleDelay(int in, Message* reply_msg) { |
| 497 | SyncChannelTestMsg_Double::WriteReplyParams(reply_msg, in * 2); |
| 498 | Send(reply_msg); |
| 499 | if (delete_during_send_) |
| 500 | ResetChannel(); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 501 | } |
| 502 | |
| 503 | bool pump_during_send_; |
jam@chromium.org | ebd0718 | 2009-12-01 11:34:18 +0900 | [diff] [blame] | 504 | bool delete_during_send_; |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 505 | }; |
| 506 | |
| 507 | class UnblockClient : public Worker { |
| 508 | public: |
thestig@chromium.org | 60bd7c0 | 2010-07-23 14:23:13 +0900 | [diff] [blame] | 509 | explicit UnblockClient(bool pump_during_send) |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 510 | : Worker(Channel::MODE_CLIENT, "unblock_client"), |
| 511 | pump_during_send_(pump_during_send) { } |
| 512 | |
| 513 | void OnAnswer(int* answer) { |
| 514 | SendDouble(pump_during_send_, true); |
| 515 | *answer = 42; |
| 516 | Done(); |
| 517 | } |
| 518 | |
| 519 | bool pump_during_send_; |
| 520 | }; |
| 521 | |
jam@chromium.org | ebd0718 | 2009-12-01 11:34:18 +0900 | [diff] [blame] | 522 | void Unblock(bool server_pump, bool client_pump, bool delete_during_send) { |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 523 | std::vector<Worker*> workers; |
jam@chromium.org | ebd0718 | 2009-12-01 11:34:18 +0900 | [diff] [blame] | 524 | workers.push_back(new UnblockServer(server_pump, delete_during_send)); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 525 | workers.push_back(new UnblockClient(client_pump)); |
| 526 | RunTest(workers); |
| 527 | } |
| 528 | |
| 529 | } // namespace |
| 530 | |
| 531 | // Tests that the caller unblocks to answer a sync message from the receiver. |
| 532 | TEST_F(IPCSyncChannelTest, Unblock) { |
jam@chromium.org | ebd0718 | 2009-12-01 11:34:18 +0900 | [diff] [blame] | 533 | Unblock(false, false, false); |
| 534 | Unblock(false, true, false); |
| 535 | Unblock(true, false, false); |
| 536 | Unblock(true, true, false); |
| 537 | } |
| 538 | |
| 539 | //----------------------------------------------------------------------------- |
| 540 | |
kushi.p@gmail.com | 5948bf4 | 2011-05-14 07:42:41 +0900 | [diff] [blame] | 541 | // Tests that the the SyncChannel object can be deleted during a Send. |
jam@chromium.org | ebd0718 | 2009-12-01 11:34:18 +0900 | [diff] [blame] | 542 | TEST_F(IPCSyncChannelTest, ChannelDeleteDuringSend) { |
| 543 | Unblock(false, false, true); |
| 544 | Unblock(false, true, true); |
| 545 | Unblock(true, false, true); |
| 546 | Unblock(true, true, true); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 547 | } |
| 548 | |
| 549 | //----------------------------------------------------------------------------- |
| 550 | |
| 551 | namespace { |
| 552 | |
| 553 | class RecursiveServer : public Worker { |
| 554 | public: |
dilmah@chromium.org | 92b4c8e | 2011-07-27 02:25:25 +0900 | [diff] [blame] | 555 | RecursiveServer(bool expected_send_result, bool pump_first, bool pump_second) |
| 556 | : Worker(Channel::MODE_SERVER, "recursive_server"), |
| 557 | expected_send_result_(expected_send_result), |
| 558 | pump_first_(pump_first), pump_second_(pump_second) {} |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 559 | void Run() { |
| 560 | SendDouble(pump_first_, expected_send_result_); |
| 561 | Done(); |
| 562 | } |
| 563 | |
| 564 | void OnDouble(int in, int* out) { |
| 565 | *out = in * 2; |
| 566 | SendAnswerToLife(pump_second_, base::kNoTimeout, expected_send_result_); |
| 567 | } |
| 568 | |
| 569 | bool expected_send_result_, pump_first_, pump_second_; |
| 570 | }; |
| 571 | |
| 572 | class RecursiveClient : public Worker { |
| 573 | public: |
dilmah@chromium.org | 92b4c8e | 2011-07-27 02:25:25 +0900 | [diff] [blame] | 574 | RecursiveClient(bool pump_during_send, bool close_channel) |
| 575 | : Worker(Channel::MODE_CLIENT, "recursive_client"), |
| 576 | pump_during_send_(pump_during_send), close_channel_(close_channel) {} |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 577 | |
| 578 | void OnDoubleDelay(int in, Message* reply_msg) { |
| 579 | SendDouble(pump_during_send_, !close_channel_); |
| 580 | if (close_channel_) { |
| 581 | delete reply_msg; |
| 582 | } else { |
| 583 | SyncChannelTestMsg_Double::WriteReplyParams(reply_msg, in * 2); |
| 584 | Send(reply_msg); |
| 585 | } |
| 586 | Done(); |
| 587 | } |
| 588 | |
| 589 | void OnAnswerDelay(Message* reply_msg) { |
| 590 | if (close_channel_) { |
| 591 | delete reply_msg; |
| 592 | CloseChannel(); |
| 593 | } else { |
| 594 | SyncChannelTestMsg_AnswerToLife::WriteReplyParams(reply_msg, 42); |
| 595 | Send(reply_msg); |
| 596 | } |
| 597 | } |
| 598 | |
| 599 | bool pump_during_send_, close_channel_; |
| 600 | }; |
| 601 | |
| 602 | void Recursive( |
| 603 | bool server_pump_first, bool server_pump_second, bool client_pump) { |
| 604 | std::vector<Worker*> workers; |
| 605 | workers.push_back( |
| 606 | new RecursiveServer(true, server_pump_first, server_pump_second)); |
| 607 | workers.push_back(new RecursiveClient(client_pump, false)); |
| 608 | RunTest(workers); |
| 609 | } |
| 610 | |
| 611 | } // namespace |
| 612 | |
| 613 | // Tests a server calling Send while another Send is pending. |
| 614 | TEST_F(IPCSyncChannelTest, Recursive) { |
| 615 | Recursive(false, false, false); |
| 616 | Recursive(false, false, true); |
| 617 | Recursive(false, true, false); |
| 618 | Recursive(false, true, true); |
| 619 | Recursive(true, false, false); |
| 620 | Recursive(true, false, true); |
| 621 | Recursive(true, true, false); |
| 622 | Recursive(true, true, true); |
| 623 | } |
| 624 | |
| 625 | //----------------------------------------------------------------------------- |
| 626 | |
| 627 | namespace { |
| 628 | |
| 629 | void RecursiveNoHang( |
| 630 | bool server_pump_first, bool server_pump_second, bool client_pump) { |
| 631 | std::vector<Worker*> workers; |
| 632 | workers.push_back( |
| 633 | new RecursiveServer(false, server_pump_first, server_pump_second)); |
| 634 | workers.push_back(new RecursiveClient(client_pump, true)); |
| 635 | RunTest(workers); |
| 636 | } |
| 637 | |
| 638 | } // namespace |
| 639 | |
| 640 | // Tests that if a caller makes a sync call during an existing sync call and |
| 641 | // the receiver dies, neither of the Send() calls hang. |
| 642 | TEST_F(IPCSyncChannelTest, RecursiveNoHang) { |
| 643 | RecursiveNoHang(false, false, false); |
| 644 | RecursiveNoHang(false, false, true); |
| 645 | RecursiveNoHang(false, true, false); |
| 646 | RecursiveNoHang(false, true, true); |
| 647 | RecursiveNoHang(true, false, false); |
| 648 | RecursiveNoHang(true, false, true); |
| 649 | RecursiveNoHang(true, true, false); |
| 650 | RecursiveNoHang(true, true, true); |
| 651 | } |
| 652 | |
| 653 | //----------------------------------------------------------------------------- |
| 654 | |
| 655 | namespace { |
| 656 | |
| 657 | class MultipleServer1 : public Worker { |
| 658 | public: |
thestig@chromium.org | 60bd7c0 | 2010-07-23 14:23:13 +0900 | [diff] [blame] | 659 | explicit MultipleServer1(bool pump_during_send) |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 660 | : Worker("test_channel1", Channel::MODE_SERVER), |
| 661 | pump_during_send_(pump_during_send) { } |
| 662 | |
| 663 | void Run() { |
| 664 | SendDouble(pump_during_send_, true); |
| 665 | Done(); |
| 666 | } |
| 667 | |
| 668 | bool pump_during_send_; |
| 669 | }; |
| 670 | |
| 671 | class MultipleClient1 : public Worker { |
| 672 | public: |
| 673 | MultipleClient1(WaitableEvent* client1_msg_received, |
| 674 | WaitableEvent* client1_can_reply) : |
| 675 | Worker("test_channel1", Channel::MODE_CLIENT), |
| 676 | client1_msg_received_(client1_msg_received), |
| 677 | client1_can_reply_(client1_can_reply) { } |
| 678 | |
| 679 | void OnDouble(int in, int* out) { |
| 680 | client1_msg_received_->Signal(); |
| 681 | *out = in * 2; |
| 682 | client1_can_reply_->Wait(); |
| 683 | Done(); |
| 684 | } |
| 685 | |
| 686 | private: |
| 687 | WaitableEvent *client1_msg_received_, *client1_can_reply_; |
| 688 | }; |
| 689 | |
| 690 | class MultipleServer2 : public Worker { |
| 691 | public: |
| 692 | MultipleServer2() : Worker("test_channel2", Channel::MODE_SERVER) { } |
| 693 | |
| 694 | void OnAnswer(int* result) { |
| 695 | *result = 42; |
| 696 | Done(); |
| 697 | } |
| 698 | }; |
| 699 | |
| 700 | class MultipleClient2 : public Worker { |
| 701 | public: |
| 702 | MultipleClient2( |
| 703 | WaitableEvent* client1_msg_received, WaitableEvent* client1_can_reply, |
| 704 | bool pump_during_send) |
| 705 | : Worker("test_channel2", Channel::MODE_CLIENT), |
| 706 | client1_msg_received_(client1_msg_received), |
| 707 | client1_can_reply_(client1_can_reply), |
| 708 | pump_during_send_(pump_during_send) { } |
| 709 | |
| 710 | void Run() { |
| 711 | client1_msg_received_->Wait(); |
| 712 | SendAnswerToLife(pump_during_send_, base::kNoTimeout, true); |
| 713 | client1_can_reply_->Signal(); |
| 714 | Done(); |
| 715 | } |
| 716 | |
| 717 | private: |
| 718 | WaitableEvent *client1_msg_received_, *client1_can_reply_; |
| 719 | bool pump_during_send_; |
| 720 | }; |
| 721 | |
| 722 | void Multiple(bool server_pump, bool client_pump) { |
| 723 | std::vector<Worker*> workers; |
| 724 | |
| 725 | // A shared worker thread so that server1 and server2 run on one thread. |
| 726 | base::Thread worker_thread("Multiple"); |
| 727 | ASSERT_TRUE(worker_thread.Start()); |
| 728 | |
| 729 | // Server1 sends a sync msg to client1, which blocks the reply until |
| 730 | // server2 (which runs on the same worker thread as server1) responds |
| 731 | // to a sync msg from client2. |
| 732 | WaitableEvent client1_msg_received(false, false); |
| 733 | WaitableEvent client1_can_reply(false, false); |
| 734 | |
| 735 | Worker* worker; |
| 736 | |
| 737 | worker = new MultipleServer2(); |
| 738 | worker->OverrideThread(&worker_thread); |
| 739 | workers.push_back(worker); |
| 740 | |
| 741 | worker = new MultipleClient2( |
| 742 | &client1_msg_received, &client1_can_reply, client_pump); |
| 743 | workers.push_back(worker); |
| 744 | |
| 745 | worker = new MultipleServer1(server_pump); |
| 746 | worker->OverrideThread(&worker_thread); |
| 747 | workers.push_back(worker); |
| 748 | |
| 749 | worker = new MultipleClient1( |
| 750 | &client1_msg_received, &client1_can_reply); |
| 751 | workers.push_back(worker); |
| 752 | |
| 753 | RunTest(workers); |
| 754 | } |
| 755 | |
| 756 | } // namespace |
| 757 | |
| 758 | // Tests that multiple SyncObjects on the same listener thread can unblock each |
| 759 | // other. |
| 760 | TEST_F(IPCSyncChannelTest, Multiple) { |
| 761 | Multiple(false, false); |
| 762 | Multiple(false, true); |
| 763 | Multiple(true, false); |
| 764 | Multiple(true, true); |
| 765 | } |
| 766 | |
| 767 | //----------------------------------------------------------------------------- |
| 768 | |
| 769 | namespace { |
| 770 | |
ananta@chromium.org | 31b338f | 2009-10-15 01:22:02 +0900 | [diff] [blame] | 771 | // This class provides server side functionality to test the case where |
| 772 | // multiple sync channels are in use on the same thread on the client and |
| 773 | // nested calls are issued. |
| 774 | class QueuedReplyServer : public Worker { |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 775 | public: |
thestig@chromium.org | 60bd7c0 | 2010-07-23 14:23:13 +0900 | [diff] [blame] | 776 | QueuedReplyServer(base::Thread* listener_thread, |
| 777 | const std::string& channel_name, |
| 778 | const std::string& reply_text) |
ananta@chromium.org | 31b338f | 2009-10-15 01:22:02 +0900 | [diff] [blame] | 779 | : Worker(channel_name, Channel::MODE_SERVER), |
| 780 | reply_text_(reply_text) { |
| 781 | Worker::OverrideThread(listener_thread); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 782 | } |
| 783 | |
ananta@chromium.org | 31b338f | 2009-10-15 01:22:02 +0900 | [diff] [blame] | 784 | virtual void OnNestedTestMsg(Message* reply_msg) { |
pkasting@chromium.org | fcdd54b | 2010-10-20 08:50:00 +0900 | [diff] [blame] | 785 | VLOG(1) << __FUNCTION__ << " Sending reply: " << reply_text_; |
| 786 | SyncChannelNestedTestMsg_String::WriteReplyParams(reply_msg, reply_text_); |
ananta@chromium.org | 31b338f | 2009-10-15 01:22:02 +0900 | [diff] [blame] | 787 | Send(reply_msg); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 788 | Done(); |
| 789 | } |
| 790 | |
| 791 | private: |
ananta@chromium.org | 31b338f | 2009-10-15 01:22:02 +0900 | [diff] [blame] | 792 | std::string reply_text_; |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 793 | }; |
| 794 | |
ananta@chromium.org | 31b338f | 2009-10-15 01:22:02 +0900 | [diff] [blame] | 795 | // The QueuedReplyClient class provides functionality to test the case where |
| 796 | // multiple sync channels are in use on the same thread and they make nested |
| 797 | // sync calls, i.e. while the first channel waits for a response it makes a |
| 798 | // sync call on another channel. |
| 799 | // The callstack should unwind correctly, i.e. the outermost call should |
| 800 | // complete first, and so on. |
| 801 | class QueuedReplyClient : public Worker { |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 802 | public: |
ananta@chromium.org | 31b338f | 2009-10-15 01:22:02 +0900 | [diff] [blame] | 803 | QueuedReplyClient(base::Thread* listener_thread, |
| 804 | const std::string& channel_name, |
| 805 | const std::string& expected_text, |
| 806 | bool pump_during_send) |
| 807 | : Worker(channel_name, Channel::MODE_CLIENT), |
thomasvl@google.com | 9a24207 | 2010-07-23 23:18:59 +0900 | [diff] [blame] | 808 | pump_during_send_(pump_during_send), |
| 809 | expected_text_(expected_text) { |
ananta@chromium.org | 31b338f | 2009-10-15 01:22:02 +0900 | [diff] [blame] | 810 | Worker::OverrideThread(listener_thread); |
| 811 | } |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 812 | |
ananta@chromium.org | 31b338f | 2009-10-15 01:22:02 +0900 | [diff] [blame] | 813 | virtual void Run() { |
| 814 | std::string response; |
| 815 | SyncMessage* msg = new SyncChannelNestedTestMsg_String(&response); |
| 816 | if (pump_during_send_) |
| 817 | msg->EnableMessagePumping(); |
| 818 | bool result = Send(msg); |
| 819 | DCHECK(result); |
jam@chromium.org | ebd0718 | 2009-12-01 11:34:18 +0900 | [diff] [blame] | 820 | DCHECK_EQ(response, expected_text_); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 821 | |
pkasting@chromium.org | fcdd54b | 2010-10-20 08:50:00 +0900 | [diff] [blame] | 822 | VLOG(1) << __FUNCTION__ << " Received reply: " << response; |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 823 | Done(); |
| 824 | } |
| 825 | |
ananta@chromium.org | 31b338f | 2009-10-15 01:22:02 +0900 | [diff] [blame] | 826 | private: |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 827 | bool pump_during_send_; |
ananta@chromium.org | 31b338f | 2009-10-15 01:22:02 +0900 | [diff] [blame] | 828 | std::string expected_text_; |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 829 | }; |
| 830 | |
ananta@chromium.org | 31b338f | 2009-10-15 01:22:02 +0900 | [diff] [blame] | 831 | void QueuedReply(bool client_pump) { |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 832 | std::vector<Worker*> workers; |
| 833 | |
ananta@chromium.org | 31b338f | 2009-10-15 01:22:02 +0900 | [diff] [blame] | 834 | // A shared worker thread for servers |
| 835 | base::Thread server_worker_thread("QueuedReply_ServerListener"); |
| 836 | ASSERT_TRUE(server_worker_thread.Start()); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 837 | |
ananta@chromium.org | 31b338f | 2009-10-15 01:22:02 +0900 | [diff] [blame] | 838 | base::Thread client_worker_thread("QueuedReply_ClientListener"); |
| 839 | ASSERT_TRUE(client_worker_thread.Start()); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 840 | |
| 841 | Worker* worker; |
| 842 | |
ananta@chromium.org | 31b338f | 2009-10-15 01:22:02 +0900 | [diff] [blame] | 843 | worker = new QueuedReplyServer(&server_worker_thread, |
| 844 | "QueuedReply_Server1", |
| 845 | "Got first message"); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 846 | workers.push_back(worker); |
| 847 | |
ananta@chromium.org | 31b338f | 2009-10-15 01:22:02 +0900 | [diff] [blame] | 848 | worker = new QueuedReplyServer(&server_worker_thread, |
| 849 | "QueuedReply_Server2", |
| 850 | "Got second message"); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 851 | workers.push_back(worker); |
| 852 | |
ananta@chromium.org | 31b338f | 2009-10-15 01:22:02 +0900 | [diff] [blame] | 853 | worker = new QueuedReplyClient(&client_worker_thread, |
| 854 | "QueuedReply_Server1", |
| 855 | "Got first message", |
| 856 | client_pump); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 857 | workers.push_back(worker); |
| 858 | |
ananta@chromium.org | 31b338f | 2009-10-15 01:22:02 +0900 | [diff] [blame] | 859 | worker = new QueuedReplyClient(&client_worker_thread, |
| 860 | "QueuedReply_Server2", |
| 861 | "Got second message", |
| 862 | client_pump); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 863 | workers.push_back(worker); |
| 864 | |
| 865 | RunTest(workers); |
| 866 | } |
| 867 | |
| 868 | } // namespace |
| 869 | |
| 870 | // While a blocking send is in progress, the listener thread might answer other |
| 871 | // synchronous messages. This tests that if during the response to another |
| 872 | // message the reply to the original messages comes, it is queued up correctly |
| 873 | // and the original Send is unblocked later. |
ananta@chromium.org | 31b338f | 2009-10-15 01:22:02 +0900 | [diff] [blame] | 874 | // We also test that the send call stacks unwind correctly when the channel |
| 875 | // pumps messages while waiting for a response. |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 876 | TEST_F(IPCSyncChannelTest, QueuedReply) { |
ananta@chromium.org | 31b338f | 2009-10-15 01:22:02 +0900 | [diff] [blame] | 877 | QueuedReply(false); |
| 878 | QueuedReply(true); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 879 | } |
| 880 | |
| 881 | //----------------------------------------------------------------------------- |
| 882 | |
| 883 | namespace { |
| 884 | |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 885 | class ChattyClient : public Worker { |
| 886 | public: |
| 887 | ChattyClient() : |
| 888 | Worker(Channel::MODE_CLIENT, "chatty_client") { } |
| 889 | |
| 890 | void OnAnswer(int* answer) { |
| 891 | // The PostMessage limit is 10k. Send 20% more than that. |
| 892 | const int kMessageLimit = 10000; |
| 893 | const int kMessagesToSend = kMessageLimit * 120 / 100; |
| 894 | for (int i = 0; i < kMessagesToSend; ++i) { |
| 895 | if (!SendDouble(false, true)) |
| 896 | break; |
| 897 | } |
| 898 | *answer = 42; |
| 899 | Done(); |
| 900 | } |
| 901 | }; |
| 902 | |
| 903 | void ChattyServer(bool pump_during_send) { |
| 904 | std::vector<Worker*> workers; |
jam@chromium.org | ebd0718 | 2009-12-01 11:34:18 +0900 | [diff] [blame] | 905 | workers.push_back(new UnblockServer(pump_during_send, false)); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 906 | workers.push_back(new ChattyClient()); |
| 907 | RunTest(workers); |
| 908 | } |
| 909 | |
| 910 | } // namespace |
| 911 | |
| 912 | // Tests http://b/1093251 - that sending lots of sync messages while |
| 913 | // the receiver is waiting for a sync reply does not overflow the PostMessage |
| 914 | // queue. |
| 915 | TEST_F(IPCSyncChannelTest, ChattyServer) { |
| 916 | ChattyServer(false); |
| 917 | ChattyServer(true); |
| 918 | } |
| 919 | |
| 920 | //------------------------------------------------------------------------------ |
| 921 | |
| 922 | namespace { |
| 923 | |
| 924 | class TimeoutServer : public Worker { |
| 925 | public: |
thestig@chromium.org | 60bd7c0 | 2010-07-23 14:23:13 +0900 | [diff] [blame] | 926 | TimeoutServer(int timeout_ms, |
| 927 | std::vector<bool> timeout_seq, |
| 928 | bool pump_during_send) |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 929 | : Worker(Channel::MODE_SERVER, "timeout_server"), |
| 930 | timeout_ms_(timeout_ms), |
| 931 | timeout_seq_(timeout_seq), |
| 932 | pump_during_send_(pump_during_send) { |
| 933 | } |
| 934 | |
| 935 | void Run() { |
| 936 | for (std::vector<bool>::const_iterator iter = timeout_seq_.begin(); |
| 937 | iter != timeout_seq_.end(); ++iter) { |
| 938 | SendAnswerToLife(pump_during_send_, timeout_ms_, !*iter); |
| 939 | } |
| 940 | Done(); |
| 941 | } |
| 942 | |
| 943 | private: |
| 944 | int timeout_ms_; |
| 945 | std::vector<bool> timeout_seq_; |
| 946 | bool pump_during_send_; |
| 947 | }; |
| 948 | |
| 949 | class UnresponsiveClient : public Worker { |
| 950 | public: |
thestig@chromium.org | 60bd7c0 | 2010-07-23 14:23:13 +0900 | [diff] [blame] | 951 | explicit UnresponsiveClient(std::vector<bool> timeout_seq) |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 952 | : Worker(Channel::MODE_CLIENT, "unresponsive_client"), |
| 953 | timeout_seq_(timeout_seq) { |
thestig@chromium.org | 60bd7c0 | 2010-07-23 14:23:13 +0900 | [diff] [blame] | 954 | } |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 955 | |
| 956 | void OnAnswerDelay(Message* reply_msg) { |
| 957 | DCHECK(!timeout_seq_.empty()); |
| 958 | if (!timeout_seq_[0]) { |
| 959 | SyncChannelTestMsg_AnswerToLife::WriteReplyParams(reply_msg, 42); |
| 960 | Send(reply_msg); |
| 961 | } else { |
| 962 | // Don't reply. |
| 963 | delete reply_msg; |
| 964 | } |
| 965 | timeout_seq_.erase(timeout_seq_.begin()); |
| 966 | if (timeout_seq_.empty()) |
| 967 | Done(); |
| 968 | } |
| 969 | |
| 970 | private: |
| 971 | // Whether we should time-out or respond to the various messages we receive. |
| 972 | std::vector<bool> timeout_seq_; |
| 973 | }; |
| 974 | |
| 975 | void SendWithTimeoutOK(bool pump_during_send) { |
| 976 | std::vector<Worker*> workers; |
| 977 | std::vector<bool> timeout_seq; |
| 978 | timeout_seq.push_back(false); |
| 979 | timeout_seq.push_back(false); |
| 980 | timeout_seq.push_back(false); |
| 981 | workers.push_back(new TimeoutServer(5000, timeout_seq, pump_during_send)); |
| 982 | workers.push_back(new SimpleClient()); |
| 983 | RunTest(workers); |
| 984 | } |
| 985 | |
| 986 | void SendWithTimeoutTimeout(bool pump_during_send) { |
| 987 | std::vector<Worker*> workers; |
| 988 | std::vector<bool> timeout_seq; |
| 989 | timeout_seq.push_back(true); |
| 990 | timeout_seq.push_back(false); |
| 991 | timeout_seq.push_back(false); |
| 992 | workers.push_back(new TimeoutServer(100, timeout_seq, pump_during_send)); |
| 993 | workers.push_back(new UnresponsiveClient(timeout_seq)); |
| 994 | RunTest(workers); |
| 995 | } |
| 996 | |
| 997 | void SendWithTimeoutMixedOKAndTimeout(bool pump_during_send) { |
| 998 | std::vector<Worker*> workers; |
| 999 | std::vector<bool> timeout_seq; |
| 1000 | timeout_seq.push_back(true); |
| 1001 | timeout_seq.push_back(false); |
| 1002 | timeout_seq.push_back(false); |
| 1003 | timeout_seq.push_back(true); |
| 1004 | timeout_seq.push_back(false); |
| 1005 | workers.push_back(new TimeoutServer(100, timeout_seq, pump_during_send)); |
| 1006 | workers.push_back(new UnresponsiveClient(timeout_seq)); |
| 1007 | RunTest(workers); |
| 1008 | } |
| 1009 | |
| 1010 | } // namespace |
| 1011 | |
| 1012 | // Tests that SendWithTimeout does not time-out if the response comes back fast |
| 1013 | // enough. |
| 1014 | TEST_F(IPCSyncChannelTest, SendWithTimeoutOK) { |
| 1015 | SendWithTimeoutOK(false); |
| 1016 | SendWithTimeoutOK(true); |
| 1017 | } |
| 1018 | |
| 1019 | // Tests that SendWithTimeout does time-out. |
| 1020 | TEST_F(IPCSyncChannelTest, SendWithTimeoutTimeout) { |
| 1021 | SendWithTimeoutTimeout(false); |
| 1022 | SendWithTimeoutTimeout(true); |
| 1023 | } |
| 1024 | |
| 1025 | // Sends some message that time-out and some that succeed. |
phajdan.jr@chromium.org | a8e3c09 | 2011-01-19 17:11:56 +0900 | [diff] [blame] | 1026 | // Crashes flakily, http://crbug.com/70075. |
| 1027 | TEST_F(IPCSyncChannelTest, DISABLED_SendWithTimeoutMixedOKAndTimeout) { |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 1028 | SendWithTimeoutMixedOKAndTimeout(false); |
| 1029 | SendWithTimeoutMixedOKAndTimeout(true); |
| 1030 | } |
| 1031 | |
| 1032 | //------------------------------------------------------------------------------ |
| 1033 | |
| 1034 | namespace { |
| 1035 | |
jhawkins@chromium.org | dc0f37f | 2011-11-29 03:35:39 +0900 | [diff] [blame] | 1036 | void NestedCallback(Worker* server) { |
| 1037 | // Sleep a bit so that we wake up after the reply has been received. |
tedvessenes@gmail.com | 30dbbaa | 2012-01-13 09:11:01 +0900 | [diff] [blame] | 1038 | base::PlatformThread::Sleep(base::TimeDelta::FromMilliseconds(250)); |
jhawkins@chromium.org | dc0f37f | 2011-11-29 03:35:39 +0900 | [diff] [blame] | 1039 | server->SendAnswerToLife(true, base::kNoTimeout, true); |
| 1040 | } |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 1041 | |
jhawkins@chromium.org | dc0f37f | 2011-11-29 03:35:39 +0900 | [diff] [blame] | 1042 | bool timeout_occurred = false; |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 1043 | |
jhawkins@chromium.org | dc0f37f | 2011-11-29 03:35:39 +0900 | [diff] [blame] | 1044 | void TimeoutCallback() { |
| 1045 | timeout_occurred = true; |
| 1046 | } |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 1047 | |
| 1048 | class DoneEventRaceServer : public Worker { |
| 1049 | public: |
| 1050 | DoneEventRaceServer() |
| 1051 | : Worker(Channel::MODE_SERVER, "done_event_race_server") { } |
| 1052 | |
| 1053 | void Run() { |
jhawkins@chromium.org | dc0f37f | 2011-11-29 03:35:39 +0900 | [diff] [blame] | 1054 | MessageLoop::current()->PostTask(FROM_HERE, |
| 1055 | base::Bind(&NestedCallback, this)); |
| 1056 | MessageLoop::current()->PostDelayedTask( |
tedvessenes@gmail.com | 56b3370 | 2012-03-07 13:41:40 +0900 | [diff] [blame] | 1057 | FROM_HERE, |
| 1058 | base::Bind(&TimeoutCallback), |
| 1059 | base::TimeDelta::FromSeconds(9)); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 1060 | // Even though we have a timeout on the Send, it will succeed since for this |
| 1061 | // bug, the reply message comes back and is deserialized, however the done |
| 1062 | // event wasn't set. So we indirectly use the timeout task to notice if a |
| 1063 | // timeout occurred. |
| 1064 | SendAnswerToLife(true, 10000, true); |
jhawkins@chromium.org | dc0f37f | 2011-11-29 03:35:39 +0900 | [diff] [blame] | 1065 | DCHECK(!timeout_occurred); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 1066 | Done(); |
| 1067 | } |
| 1068 | }; |
| 1069 | |
| 1070 | } // namespace |
| 1071 | |
| 1072 | // Tests http://b/1474092 - that if after the done_event is set but before |
| 1073 | // OnObjectSignaled is called another message is sent out, then after its |
| 1074 | // reply comes back OnObjectSignaled will be called for the first message. |
| 1075 | TEST_F(IPCSyncChannelTest, DoneEventRace) { |
| 1076 | std::vector<Worker*> workers; |
| 1077 | workers.push_back(new DoneEventRaceServer()); |
| 1078 | workers.push_back(new SimpleClient()); |
| 1079 | RunTest(workers); |
| 1080 | } |
jabdelmalek@google.com | eb92165 | 2010-04-07 05:33:36 +0900 | [diff] [blame] | 1081 | |
| 1082 | //----------------------------------------------------------------------------- |
| 1083 | |
| 1084 | namespace { |
| 1085 | |
kushi.p@gmail.com | 5948bf4 | 2011-05-14 07:42:41 +0900 | [diff] [blame] | 1086 | class TestSyncMessageFilter : public SyncMessageFilter { |
jabdelmalek@google.com | eb92165 | 2010-04-07 05:33:36 +0900 | [diff] [blame] | 1087 | public: |
| 1088 | TestSyncMessageFilter(base::WaitableEvent* shutdown_event, Worker* worker) |
| 1089 | : SyncMessageFilter(shutdown_event), |
| 1090 | worker_(worker), |
| 1091 | thread_("helper_thread") { |
| 1092 | base::Thread::Options options; |
| 1093 | options.message_loop_type = MessageLoop::TYPE_DEFAULT; |
| 1094 | thread_.StartWithOptions(options); |
| 1095 | } |
| 1096 | |
| 1097 | virtual void OnFilterAdded(Channel* channel) { |
| 1098 | SyncMessageFilter::OnFilterAdded(channel); |
jhawkins@chromium.org | 9827bd1 | 2011-11-13 06:16:41 +0900 | [diff] [blame] | 1099 | thread_.message_loop()->PostTask( |
| 1100 | FROM_HERE, |
| 1101 | base::Bind(&TestSyncMessageFilter::SendMessageOnHelperThread, this)); |
jabdelmalek@google.com | eb92165 | 2010-04-07 05:33:36 +0900 | [diff] [blame] | 1102 | } |
| 1103 | |
| 1104 | void SendMessageOnHelperThread() { |
| 1105 | int answer = 0; |
| 1106 | bool result = Send(new SyncChannelTestMsg_AnswerToLife(&answer)); |
| 1107 | DCHECK(result); |
| 1108 | DCHECK_EQ(answer, 42); |
| 1109 | |
| 1110 | worker_->Done(); |
| 1111 | } |
| 1112 | |
rsleevi@chromium.org | 997c1d4 | 2012-04-28 11:12:00 +0900 | [diff] [blame^] | 1113 | private: |
| 1114 | virtual ~TestSyncMessageFilter() {} |
| 1115 | |
jabdelmalek@google.com | eb92165 | 2010-04-07 05:33:36 +0900 | [diff] [blame] | 1116 | Worker* worker_; |
| 1117 | base::Thread thread_; |
| 1118 | }; |
| 1119 | |
| 1120 | class SyncMessageFilterServer : public Worker { |
| 1121 | public: |
| 1122 | SyncMessageFilterServer() |
| 1123 | : Worker(Channel::MODE_SERVER, "sync_message_filter_server") { |
| 1124 | filter_ = new TestSyncMessageFilter(shutdown_event(), this); |
| 1125 | } |
| 1126 | |
| 1127 | void Run() { |
| 1128 | channel()->AddFilter(filter_.get()); |
| 1129 | } |
| 1130 | |
| 1131 | scoped_refptr<TestSyncMessageFilter> filter_; |
| 1132 | }; |
| 1133 | |
ananta@chromium.org | 999f297 | 2010-09-03 06:45:50 +0900 | [diff] [blame] | 1134 | // This class provides functionality to test the case that a Send on the sync |
| 1135 | // channel does not crash after the channel has been closed. |
| 1136 | class ServerSendAfterClose : public Worker { |
| 1137 | public: |
| 1138 | ServerSendAfterClose() |
| 1139 | : Worker(Channel::MODE_SERVER, "simpler_server"), |
| 1140 | send_result_(true) { |
| 1141 | } |
| 1142 | |
| 1143 | bool SendDummy() { |
jhawkins@chromium.org | 9827bd1 | 2011-11-13 06:16:41 +0900 | [diff] [blame] | 1144 | ListenerThread()->message_loop()->PostTask( |
ajwong@chromium.org | c1e632d | 2012-01-06 11:37:17 +0900 | [diff] [blame] | 1145 | FROM_HERE, base::Bind(base::IgnoreResult(&ServerSendAfterClose::Send), |
| 1146 | this, new SyncChannelTestMsg_NoArgs)); |
ananta@chromium.org | 999f297 | 2010-09-03 06:45:50 +0900 | [diff] [blame] | 1147 | return true; |
| 1148 | } |
| 1149 | |
| 1150 | bool send_result() const { |
| 1151 | return send_result_; |
| 1152 | } |
| 1153 | |
| 1154 | private: |
| 1155 | virtual void Run() { |
| 1156 | CloseChannel(); |
| 1157 | Done(); |
| 1158 | } |
| 1159 | |
| 1160 | bool Send(Message* msg) { |
| 1161 | send_result_ = Worker::Send(msg); |
| 1162 | Done(); |
| 1163 | return send_result_; |
| 1164 | } |
| 1165 | |
| 1166 | bool send_result_; |
| 1167 | }; |
| 1168 | |
jabdelmalek@google.com | eb92165 | 2010-04-07 05:33:36 +0900 | [diff] [blame] | 1169 | } // namespace |
| 1170 | |
| 1171 | // Tests basic synchronous call |
| 1172 | TEST_F(IPCSyncChannelTest, SyncMessageFilter) { |
| 1173 | std::vector<Worker*> workers; |
| 1174 | workers.push_back(new SyncMessageFilterServer()); |
| 1175 | workers.push_back(new SimpleClient()); |
| 1176 | RunTest(workers); |
| 1177 | } |
ananta@chromium.org | 999f297 | 2010-09-03 06:45:50 +0900 | [diff] [blame] | 1178 | |
| 1179 | // Test the case when the channel is closed and a Send is attempted after that. |
| 1180 | TEST_F(IPCSyncChannelTest, SendAfterClose) { |
| 1181 | ServerSendAfterClose server; |
| 1182 | server.Start(); |
| 1183 | |
| 1184 | server.done_event()->Wait(); |
| 1185 | server.done_event()->Reset(); |
| 1186 | |
| 1187 | server.SendDummy(); |
| 1188 | server.done_event()->Wait(); |
| 1189 | |
| 1190 | EXPECT_FALSE(server.send_result()); |
| 1191 | } |
| 1192 | |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1193 | //----------------------------------------------------------------------------- |
ananta@chromium.org | 999f297 | 2010-09-03 06:45:50 +0900 | [diff] [blame] | 1194 | |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1195 | namespace { |
| 1196 | |
| 1197 | class RestrictedDispatchServer : public Worker { |
| 1198 | public: |
piman@chromium.org | 5a00b88 | 2012-03-31 06:29:30 +0900 | [diff] [blame] | 1199 | RestrictedDispatchServer(WaitableEvent* sent_ping_event, |
| 1200 | WaitableEvent* wait_event) |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1201 | : Worker("restricted_channel", Channel::MODE_SERVER), |
piman@chromium.org | 5a00b88 | 2012-03-31 06:29:30 +0900 | [diff] [blame] | 1202 | sent_ping_event_(sent_ping_event), |
| 1203 | wait_event_(wait_event) { } |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1204 | |
| 1205 | void OnDoPing(int ping) { |
| 1206 | // Send an asynchronous message that unblocks the caller. |
kushi.p@gmail.com | 5948bf4 | 2011-05-14 07:42:41 +0900 | [diff] [blame] | 1207 | Message* msg = new SyncChannelTestMsg_Ping(ping); |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1208 | msg->set_unblock(true); |
| 1209 | Send(msg); |
| 1210 | // Signal the event after the message has been sent on the channel, on the |
| 1211 | // IPC thread. |
jhawkins@chromium.org | 9827bd1 | 2011-11-13 06:16:41 +0900 | [diff] [blame] | 1212 | ipc_thread().message_loop()->PostTask( |
| 1213 | FROM_HERE, base::Bind(&RestrictedDispatchServer::OnPingSent, this)); |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1214 | } |
| 1215 | |
piman@chromium.org | 5a00b88 | 2012-03-31 06:29:30 +0900 | [diff] [blame] | 1216 | void OnPingTTL(int ping, int* out) { |
| 1217 | *out = ping; |
| 1218 | wait_event_->Wait(); |
| 1219 | } |
| 1220 | |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1221 | base::Thread* ListenerThread() { return Worker::ListenerThread(); } |
| 1222 | |
| 1223 | private: |
| 1224 | bool OnMessageReceived(const Message& message) { |
| 1225 | IPC_BEGIN_MESSAGE_MAP(RestrictedDispatchServer, message) |
| 1226 | IPC_MESSAGE_HANDLER(SyncChannelTestMsg_NoArgs, OnNoArgs) |
piman@chromium.org | 5a00b88 | 2012-03-31 06:29:30 +0900 | [diff] [blame] | 1227 | IPC_MESSAGE_HANDLER(SyncChannelTestMsg_PingTTL, OnPingTTL) |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1228 | IPC_MESSAGE_HANDLER(SyncChannelTestMsg_Done, Done) |
| 1229 | IPC_END_MESSAGE_MAP() |
| 1230 | return true; |
| 1231 | } |
| 1232 | |
| 1233 | void OnPingSent() { |
| 1234 | sent_ping_event_->Signal(); |
| 1235 | } |
| 1236 | |
| 1237 | void OnNoArgs() { } |
| 1238 | WaitableEvent* sent_ping_event_; |
piman@chromium.org | 5a00b88 | 2012-03-31 06:29:30 +0900 | [diff] [blame] | 1239 | WaitableEvent* wait_event_; |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1240 | }; |
| 1241 | |
| 1242 | class NonRestrictedDispatchServer : public Worker { |
| 1243 | public: |
piman@chromium.org | 5a00b88 | 2012-03-31 06:29:30 +0900 | [diff] [blame] | 1244 | NonRestrictedDispatchServer(WaitableEvent* signal_event) |
| 1245 | : Worker("non_restricted_channel", Channel::MODE_SERVER), |
| 1246 | signal_event_(signal_event) {} |
| 1247 | |
| 1248 | base::Thread* ListenerThread() { return Worker::ListenerThread(); } |
| 1249 | |
| 1250 | void OnDoPingTTL(int ping) { |
| 1251 | int value = 0; |
| 1252 | Send(new SyncChannelTestMsg_PingTTL(ping, &value)); |
| 1253 | signal_event_->Signal(); |
| 1254 | } |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1255 | |
| 1256 | private: |
| 1257 | bool OnMessageReceived(const Message& message) { |
| 1258 | IPC_BEGIN_MESSAGE_MAP(NonRestrictedDispatchServer, message) |
| 1259 | IPC_MESSAGE_HANDLER(SyncChannelTestMsg_NoArgs, OnNoArgs) |
| 1260 | IPC_MESSAGE_HANDLER(SyncChannelTestMsg_Done, Done) |
| 1261 | IPC_END_MESSAGE_MAP() |
| 1262 | return true; |
| 1263 | } |
| 1264 | |
| 1265 | void OnNoArgs() { } |
piman@chromium.org | 5a00b88 | 2012-03-31 06:29:30 +0900 | [diff] [blame] | 1266 | WaitableEvent* signal_event_; |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1267 | }; |
| 1268 | |
| 1269 | class RestrictedDispatchClient : public Worker { |
| 1270 | public: |
| 1271 | RestrictedDispatchClient(WaitableEvent* sent_ping_event, |
| 1272 | RestrictedDispatchServer* server, |
piman@chromium.org | 5a00b88 | 2012-03-31 06:29:30 +0900 | [diff] [blame] | 1273 | NonRestrictedDispatchServer* server2, |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1274 | int* success) |
| 1275 | : Worker("restricted_channel", Channel::MODE_CLIENT), |
| 1276 | ping_(0), |
| 1277 | server_(server), |
piman@chromium.org | 5a00b88 | 2012-03-31 06:29:30 +0900 | [diff] [blame] | 1278 | server2_(server2), |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1279 | success_(success), |
| 1280 | sent_ping_event_(sent_ping_event) {} |
| 1281 | |
| 1282 | void Run() { |
| 1283 | // Incoming messages from our channel should only be dispatched when we |
| 1284 | // send a message on that same channel. |
piman@chromium.org | 5a00b88 | 2012-03-31 06:29:30 +0900 | [diff] [blame] | 1285 | channel()->SetRestrictDispatchChannelGroup(1); |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1286 | |
jhawkins@chromium.org | 9827bd1 | 2011-11-13 06:16:41 +0900 | [diff] [blame] | 1287 | server_->ListenerThread()->message_loop()->PostTask( |
| 1288 | FROM_HERE, base::Bind(&RestrictedDispatchServer::OnDoPing, server_, 1)); |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1289 | sent_ping_event_->Wait(); |
| 1290 | Send(new SyncChannelTestMsg_NoArgs); |
| 1291 | if (ping_ == 1) |
| 1292 | ++*success_; |
| 1293 | else |
| 1294 | LOG(ERROR) << "Send failed to dispatch incoming message on same channel"; |
| 1295 | |
piman@chromium.org | 5a00b88 | 2012-03-31 06:29:30 +0900 | [diff] [blame] | 1296 | non_restricted_channel_.reset(new SyncChannel( |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1297 | "non_restricted_channel", Channel::MODE_CLIENT, this, |
jam@chromium.org | 06d1844 | 2011-05-03 03:00:49 +0900 | [diff] [blame] | 1298 | ipc_thread().message_loop_proxy(), true, shutdown_event())); |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1299 | |
jhawkins@chromium.org | 9827bd1 | 2011-11-13 06:16:41 +0900 | [diff] [blame] | 1300 | server_->ListenerThread()->message_loop()->PostTask( |
| 1301 | FROM_HERE, base::Bind(&RestrictedDispatchServer::OnDoPing, server_, 2)); |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1302 | sent_ping_event_->Wait(); |
| 1303 | // Check that the incoming message is *not* dispatched when sending on the |
| 1304 | // non restricted channel. |
| 1305 | // TODO(piman): there is a possibility of a false positive race condition |
| 1306 | // here, if the message that was posted on the server-side end of the pipe |
| 1307 | // is not visible yet on the client side, but I don't know how to solve this |
| 1308 | // without hooking into the internals of SyncChannel. I haven't seen it in |
| 1309 | // practice (i.e. not setting SetRestrictDispatchToSameChannel does cause |
| 1310 | // the following to fail). |
piman@chromium.org | 5a00b88 | 2012-03-31 06:29:30 +0900 | [diff] [blame] | 1311 | non_restricted_channel_->Send(new SyncChannelTestMsg_NoArgs); |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1312 | if (ping_ == 1) |
| 1313 | ++*success_; |
| 1314 | else |
| 1315 | LOG(ERROR) << "Send dispatched message from restricted channel"; |
| 1316 | |
| 1317 | Send(new SyncChannelTestMsg_NoArgs); |
| 1318 | if (ping_ == 2) |
| 1319 | ++*success_; |
| 1320 | else |
| 1321 | LOG(ERROR) << "Send failed to dispatch incoming message on same channel"; |
| 1322 | |
piman@chromium.org | 5a00b88 | 2012-03-31 06:29:30 +0900 | [diff] [blame] | 1323 | // Check that the incoming message on the non-restricted channel is |
| 1324 | // dispatched when sending on the restricted channel. |
| 1325 | server2_->ListenerThread()->message_loop()->PostTask( |
| 1326 | FROM_HERE, |
| 1327 | base::Bind(&NonRestrictedDispatchServer::OnDoPingTTL, server2_, 3)); |
| 1328 | int value = 0; |
| 1329 | Send(new SyncChannelTestMsg_PingTTL(4, &value)); |
| 1330 | if (ping_ == 3 && value == 4) |
| 1331 | ++*success_; |
| 1332 | else |
| 1333 | LOG(ERROR) << "Send failed to dispatch message from unrestricted channel"; |
| 1334 | |
| 1335 | non_restricted_channel_->Send(new SyncChannelTestMsg_Done); |
| 1336 | non_restricted_channel_.reset(); |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1337 | Send(new SyncChannelTestMsg_Done); |
| 1338 | Done(); |
| 1339 | } |
| 1340 | |
| 1341 | private: |
| 1342 | bool OnMessageReceived(const Message& message) { |
| 1343 | IPC_BEGIN_MESSAGE_MAP(RestrictedDispatchClient, message) |
| 1344 | IPC_MESSAGE_HANDLER(SyncChannelTestMsg_Ping, OnPing) |
piman@chromium.org | 5a00b88 | 2012-03-31 06:29:30 +0900 | [diff] [blame] | 1345 | IPC_MESSAGE_HANDLER_DELAY_REPLY(SyncChannelTestMsg_PingTTL, OnPingTTL) |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1346 | IPC_END_MESSAGE_MAP() |
| 1347 | return true; |
| 1348 | } |
| 1349 | |
| 1350 | void OnPing(int ping) { |
| 1351 | ping_ = ping; |
| 1352 | } |
| 1353 | |
piman@chromium.org | 5a00b88 | 2012-03-31 06:29:30 +0900 | [diff] [blame] | 1354 | void OnPingTTL(int ping, IPC::Message* reply) { |
| 1355 | ping_ = ping; |
| 1356 | // This message comes from the NonRestrictedDispatchServer, we have to send |
| 1357 | // the reply back manually. |
| 1358 | SyncChannelTestMsg_PingTTL::WriteReplyParams(reply, ping); |
| 1359 | non_restricted_channel_->Send(reply); |
| 1360 | } |
| 1361 | |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1362 | int ping_; |
| 1363 | RestrictedDispatchServer* server_; |
piman@chromium.org | 5a00b88 | 2012-03-31 06:29:30 +0900 | [diff] [blame] | 1364 | NonRestrictedDispatchServer* server2_; |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1365 | int* success_; |
| 1366 | WaitableEvent* sent_ping_event_; |
piman@chromium.org | 5a00b88 | 2012-03-31 06:29:30 +0900 | [diff] [blame] | 1367 | scoped_ptr<SyncChannel> non_restricted_channel_; |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1368 | }; |
| 1369 | |
| 1370 | } // namespace |
| 1371 | |
| 1372 | TEST_F(IPCSyncChannelTest, RestrictedDispatch) { |
| 1373 | WaitableEvent sent_ping_event(false, false); |
piman@chromium.org | 5a00b88 | 2012-03-31 06:29:30 +0900 | [diff] [blame] | 1374 | WaitableEvent wait_event(false, false); |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1375 | RestrictedDispatchServer* server = |
piman@chromium.org | 5a00b88 | 2012-03-31 06:29:30 +0900 | [diff] [blame] | 1376 | new RestrictedDispatchServer(&sent_ping_event, &wait_event); |
| 1377 | NonRestrictedDispatchServer* server2 = |
| 1378 | new NonRestrictedDispatchServer(&wait_event); |
| 1379 | |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1380 | int success = 0; |
| 1381 | std::vector<Worker*> workers; |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1382 | workers.push_back(server); |
piman@chromium.org | 5a00b88 | 2012-03-31 06:29:30 +0900 | [diff] [blame] | 1383 | workers.push_back(server2); |
| 1384 | workers.push_back(new RestrictedDispatchClient( |
| 1385 | &sent_ping_event, server, server2, &success)); |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1386 | RunTest(workers); |
piman@chromium.org | 5a00b88 | 2012-03-31 06:29:30 +0900 | [diff] [blame] | 1387 | EXPECT_EQ(4, success); |
piman@google.com | 0cbefaa | 2011-04-08 12:38:21 +0900 | [diff] [blame] | 1388 | } |
kushi.p@gmail.com | 5948bf4 | 2011-05-14 07:42:41 +0900 | [diff] [blame] | 1389 | |
jhorwich@chromium.org | 3c3a813 | 2012-01-12 07:39:54 +0900 | [diff] [blame] | 1390 | //----------------------------------------------------------------------------- |
| 1391 | |
| 1392 | // This test case inspired by crbug.com/108491 |
| 1393 | // We create two servers that use the same ListenerThread but have |
| 1394 | // SetRestrictDispatchToSameChannel set to true. |
| 1395 | // We create clients, then use some specific WaitableEvent wait/signalling to |
| 1396 | // ensure that messages get dispatched in a way that causes a deadlock due to |
| 1397 | // a nested dispatch and an eligible message in a higher-level dispatch's |
| 1398 | // delayed_queue. Specifically, we start with client1 about so send an |
| 1399 | // unblocking message to server1, while the shared listener thread for the |
| 1400 | // servers server1 and server2 is about to send a non-unblocking message to |
| 1401 | // client1. At the same time, client2 will be about to send an unblocking |
| 1402 | // message to server2. Server1 will handle the client1->server1 message by |
| 1403 | // telling server2 to send a non-unblocking message to client2. |
| 1404 | // What should happen is that the send to server2 should find the pending, |
| 1405 | // same-context client2->server2 message to dispatch, causing client2 to |
| 1406 | // unblock then handle the server2->client2 message, so that the shared |
| 1407 | // servers' listener thread can then respond to the client1->server1 message. |
| 1408 | // Then client1 can handle the non-unblocking server1->client1 message. |
| 1409 | // The old code would end up in a state where the server2->client2 message is |
| 1410 | // sent, but the client2->server2 message (which is eligible for dispatch, and |
| 1411 | // which is what client2 is waiting for) is stashed in a local delayed_queue |
| 1412 | // that has server1's channel context, causing a deadlock. |
| 1413 | // WaitableEvents in the events array are used to: |
| 1414 | // event 0: indicate to client1 that server listener is in OnDoServerTask |
| 1415 | // event 1: indicate to client1 that client2 listener is in OnDoClient2Task |
| 1416 | // event 2: indicate to server1 that client2 listener is in OnDoClient2Task |
| 1417 | // event 3: indicate to client2 that server listener is in OnDoServerTask |
| 1418 | |
| 1419 | namespace { |
| 1420 | |
| 1421 | class RestrictedDispatchDeadlockServer : public Worker { |
| 1422 | public: |
| 1423 | RestrictedDispatchDeadlockServer(int server_num, |
| 1424 | WaitableEvent* server_ready_event, |
| 1425 | WaitableEvent** events, |
| 1426 | RestrictedDispatchDeadlockServer* peer) |
| 1427 | : Worker(server_num == 1 ? "channel1" : "channel2", Channel::MODE_SERVER), |
| 1428 | server_num_(server_num), |
| 1429 | server_ready_event_(server_ready_event), |
| 1430 | events_(events), |
| 1431 | peer_(peer), |
| 1432 | client_kicked_(false) { } |
| 1433 | |
| 1434 | void OnDoServerTask() { |
| 1435 | events_[3]->Signal(); |
| 1436 | events_[2]->Wait(); |
| 1437 | events_[0]->Signal(); |
| 1438 | SendMessageToClient(); |
| 1439 | } |
| 1440 | |
| 1441 | void Run() { |
piman@chromium.org | 5a00b88 | 2012-03-31 06:29:30 +0900 | [diff] [blame] | 1442 | channel()->SetRestrictDispatchChannelGroup(1); |
jhorwich@chromium.org | 3c3a813 | 2012-01-12 07:39:54 +0900 | [diff] [blame] | 1443 | server_ready_event_->Signal(); |
| 1444 | } |
| 1445 | |
| 1446 | base::Thread* ListenerThread() { return Worker::ListenerThread(); } |
| 1447 | |
| 1448 | private: |
| 1449 | bool OnMessageReceived(const Message& message) { |
| 1450 | IPC_BEGIN_MESSAGE_MAP(RestrictedDispatchDeadlockServer, message) |
| 1451 | IPC_MESSAGE_HANDLER(SyncChannelTestMsg_NoArgs, OnNoArgs) |
| 1452 | IPC_MESSAGE_HANDLER(SyncChannelTestMsg_Done, Done) |
| 1453 | IPC_END_MESSAGE_MAP() |
| 1454 | return true; |
| 1455 | } |
| 1456 | |
| 1457 | void OnNoArgs() { |
| 1458 | if (server_num_ == 1) { |
| 1459 | DCHECK(peer_ != NULL); |
| 1460 | peer_->SendMessageToClient(); |
| 1461 | } |
| 1462 | } |
| 1463 | |
| 1464 | void SendMessageToClient() { |
| 1465 | Message* msg = new SyncChannelTestMsg_NoArgs; |
| 1466 | msg->set_unblock(false); |
| 1467 | DCHECK(!msg->should_unblock()); |
| 1468 | Send(msg); |
| 1469 | } |
| 1470 | |
| 1471 | int server_num_; |
| 1472 | WaitableEvent* server_ready_event_; |
| 1473 | WaitableEvent** events_; |
| 1474 | RestrictedDispatchDeadlockServer* peer_; |
| 1475 | bool client_kicked_; |
| 1476 | }; |
| 1477 | |
| 1478 | class RestrictedDispatchDeadlockClient2 : public Worker { |
| 1479 | public: |
| 1480 | RestrictedDispatchDeadlockClient2(RestrictedDispatchDeadlockServer* server, |
| 1481 | WaitableEvent* server_ready_event, |
| 1482 | WaitableEvent** events) |
| 1483 | : Worker("channel2", Channel::MODE_CLIENT), |
| 1484 | server_(server), |
| 1485 | server_ready_event_(server_ready_event), |
| 1486 | events_(events), |
| 1487 | received_msg_(false), |
| 1488 | received_noarg_reply_(false), |
| 1489 | done_issued_(false) {} |
| 1490 | |
| 1491 | void Run() { |
| 1492 | server_ready_event_->Wait(); |
| 1493 | } |
| 1494 | |
| 1495 | void OnDoClient2Task() { |
| 1496 | events_[3]->Wait(); |
| 1497 | events_[1]->Signal(); |
| 1498 | events_[2]->Signal(); |
| 1499 | DCHECK(received_msg_ == false); |
| 1500 | |
| 1501 | Message* message = new SyncChannelTestMsg_NoArgs; |
| 1502 | message->set_unblock(true); |
| 1503 | Send(message); |
| 1504 | received_noarg_reply_ = true; |
| 1505 | } |
| 1506 | |
| 1507 | base::Thread* ListenerThread() { return Worker::ListenerThread(); } |
| 1508 | private: |
| 1509 | bool OnMessageReceived(const Message& message) { |
| 1510 | IPC_BEGIN_MESSAGE_MAP(RestrictedDispatchDeadlockClient2, message) |
| 1511 | IPC_MESSAGE_HANDLER(SyncChannelTestMsg_NoArgs, OnNoArgs) |
| 1512 | IPC_END_MESSAGE_MAP() |
| 1513 | return true; |
| 1514 | } |
| 1515 | |
| 1516 | void OnNoArgs() { |
| 1517 | received_msg_ = true; |
| 1518 | PossiblyDone(); |
| 1519 | } |
| 1520 | |
| 1521 | void PossiblyDone() { |
| 1522 | if (received_noarg_reply_ && received_msg_) { |
| 1523 | DCHECK(done_issued_ == false); |
| 1524 | done_issued_ = true; |
| 1525 | Send(new SyncChannelTestMsg_Done); |
| 1526 | Done(); |
| 1527 | } |
| 1528 | } |
| 1529 | |
| 1530 | RestrictedDispatchDeadlockServer* server_; |
| 1531 | WaitableEvent* server_ready_event_; |
| 1532 | WaitableEvent** events_; |
| 1533 | bool received_msg_; |
| 1534 | bool received_noarg_reply_; |
| 1535 | bool done_issued_; |
| 1536 | }; |
| 1537 | |
| 1538 | class RestrictedDispatchDeadlockClient1 : public Worker { |
| 1539 | public: |
| 1540 | RestrictedDispatchDeadlockClient1(RestrictedDispatchDeadlockServer* server, |
| 1541 | RestrictedDispatchDeadlockClient2* peer, |
| 1542 | WaitableEvent* server_ready_event, |
| 1543 | WaitableEvent** events) |
| 1544 | : Worker("channel1", Channel::MODE_CLIENT), |
| 1545 | server_(server), |
| 1546 | peer_(peer), |
| 1547 | server_ready_event_(server_ready_event), |
| 1548 | events_(events), |
| 1549 | received_msg_(false), |
| 1550 | received_noarg_reply_(false), |
| 1551 | done_issued_(false) {} |
| 1552 | |
| 1553 | void Run() { |
| 1554 | server_ready_event_->Wait(); |
| 1555 | server_->ListenerThread()->message_loop()->PostTask( |
| 1556 | FROM_HERE, |
| 1557 | base::Bind(&RestrictedDispatchDeadlockServer::OnDoServerTask, server_)); |
| 1558 | peer_->ListenerThread()->message_loop()->PostTask( |
| 1559 | FROM_HERE, |
| 1560 | base::Bind(&RestrictedDispatchDeadlockClient2::OnDoClient2Task, peer_)); |
| 1561 | events_[0]->Wait(); |
| 1562 | events_[1]->Wait(); |
| 1563 | DCHECK(received_msg_ == false); |
| 1564 | |
| 1565 | Message* message = new SyncChannelTestMsg_NoArgs; |
| 1566 | message->set_unblock(true); |
| 1567 | Send(message); |
| 1568 | received_noarg_reply_ = true; |
| 1569 | PossiblyDone(); |
| 1570 | } |
| 1571 | |
| 1572 | base::Thread* ListenerThread() { return Worker::ListenerThread(); } |
| 1573 | private: |
| 1574 | bool OnMessageReceived(const Message& message) { |
| 1575 | IPC_BEGIN_MESSAGE_MAP(RestrictedDispatchDeadlockClient1, message) |
| 1576 | IPC_MESSAGE_HANDLER(SyncChannelTestMsg_NoArgs, OnNoArgs) |
| 1577 | IPC_END_MESSAGE_MAP() |
| 1578 | return true; |
| 1579 | } |
| 1580 | |
| 1581 | void OnNoArgs() { |
| 1582 | received_msg_ = true; |
| 1583 | PossiblyDone(); |
| 1584 | } |
| 1585 | |
| 1586 | void PossiblyDone() { |
| 1587 | if (received_noarg_reply_ && received_msg_) { |
| 1588 | DCHECK(done_issued_ == false); |
| 1589 | done_issued_ = true; |
| 1590 | Send(new SyncChannelTestMsg_Done); |
| 1591 | Done(); |
| 1592 | } |
| 1593 | } |
| 1594 | |
| 1595 | RestrictedDispatchDeadlockServer* server_; |
| 1596 | RestrictedDispatchDeadlockClient2* peer_; |
| 1597 | WaitableEvent* server_ready_event_; |
| 1598 | WaitableEvent** events_; |
| 1599 | bool received_msg_; |
| 1600 | bool received_noarg_reply_; |
| 1601 | bool done_issued_; |
| 1602 | }; |
| 1603 | |
| 1604 | } // namespace |
| 1605 | |
| 1606 | TEST_F(IPCSyncChannelTest, RestrictedDispatchDeadlock) { |
| 1607 | std::vector<Worker*> workers; |
| 1608 | |
| 1609 | // A shared worker thread so that server1 and server2 run on one thread. |
| 1610 | base::Thread worker_thread("RestrictedDispatchDeadlock"); |
| 1611 | ASSERT_TRUE(worker_thread.Start()); |
| 1612 | |
| 1613 | WaitableEvent server1_ready(false, false); |
| 1614 | WaitableEvent server2_ready(false, false); |
| 1615 | |
| 1616 | WaitableEvent event0(false, false); |
| 1617 | WaitableEvent event1(false, false); |
| 1618 | WaitableEvent event2(false, false); |
| 1619 | WaitableEvent event3(false, false); |
| 1620 | WaitableEvent* events[4] = {&event0, &event1, &event2, &event3}; |
| 1621 | |
| 1622 | RestrictedDispatchDeadlockServer* server1; |
| 1623 | RestrictedDispatchDeadlockServer* server2; |
| 1624 | RestrictedDispatchDeadlockClient1* client1; |
| 1625 | RestrictedDispatchDeadlockClient2* client2; |
| 1626 | |
| 1627 | server2 = new RestrictedDispatchDeadlockServer(2, &server2_ready, events, |
| 1628 | NULL); |
| 1629 | server2->OverrideThread(&worker_thread); |
| 1630 | workers.push_back(server2); |
| 1631 | |
| 1632 | client2 = new RestrictedDispatchDeadlockClient2(server2, &server2_ready, |
| 1633 | events); |
| 1634 | workers.push_back(client2); |
| 1635 | |
| 1636 | server1 = new RestrictedDispatchDeadlockServer(1, &server1_ready, events, |
| 1637 | server2); |
| 1638 | server1->OverrideThread(&worker_thread); |
| 1639 | workers.push_back(server1); |
| 1640 | |
| 1641 | client1 = new RestrictedDispatchDeadlockClient1(server1, client2, |
| 1642 | &server1_ready, events); |
| 1643 | workers.push_back(client1); |
| 1644 | |
| 1645 | RunTest(workers); |
| 1646 | } |
| 1647 | |
jschuh@chromium.org | f75a4d1 | 2012-03-17 11:20:46 +0900 | [diff] [blame] | 1648 | //----------------------------------------------------------------------------- |
| 1649 | |
piman@chromium.org | 5a00b88 | 2012-03-31 06:29:30 +0900 | [diff] [blame] | 1650 | // This test case inspired by crbug.com/120530 |
| 1651 | // We create 4 workers that pipe to each other W1->W2->W3->W4->W1 then we send a |
| 1652 | // message that recurses through 3, 4 or 5 steps to make sure, say, W1 can |
| 1653 | // re-enter when called from W4 while it's sending a message to W2. |
| 1654 | // The first worker drives the whole test so it must be treated specially. |
| 1655 | namespace { |
| 1656 | |
| 1657 | class RestrictedDispatchPipeWorker : public Worker { |
| 1658 | public: |
| 1659 | RestrictedDispatchPipeWorker( |
| 1660 | const std::string &channel1, |
| 1661 | WaitableEvent* event1, |
| 1662 | const std::string &channel2, |
| 1663 | WaitableEvent* event2, |
| 1664 | int group, |
| 1665 | int* success) |
| 1666 | : Worker(channel1, Channel::MODE_SERVER), |
| 1667 | event1_(event1), |
| 1668 | event2_(event2), |
| 1669 | other_channel_name_(channel2), |
| 1670 | group_(group), |
| 1671 | success_(success) { |
| 1672 | } |
| 1673 | |
| 1674 | void OnPingTTL(int ping, int* ret) { |
| 1675 | *ret = 0; |
| 1676 | if (!ping) |
| 1677 | return; |
| 1678 | other_channel_->Send(new SyncChannelTestMsg_PingTTL(ping - 1, ret)); |
| 1679 | ++*ret; |
| 1680 | } |
| 1681 | |
| 1682 | void OnDone() { |
| 1683 | if (is_first()) |
| 1684 | return; |
| 1685 | other_channel_->Send(new SyncChannelTestMsg_Done); |
| 1686 | other_channel_.reset(); |
| 1687 | Done(); |
| 1688 | } |
| 1689 | |
| 1690 | void Run() { |
| 1691 | channel()->SetRestrictDispatchChannelGroup(group_); |
| 1692 | if (is_first()) |
| 1693 | event1_->Signal(); |
| 1694 | event2_->Wait(); |
| 1695 | other_channel_.reset(new SyncChannel( |
| 1696 | other_channel_name_, Channel::MODE_CLIENT, this, |
| 1697 | ipc_thread().message_loop_proxy(), true, shutdown_event())); |
| 1698 | other_channel_->SetRestrictDispatchChannelGroup(group_); |
| 1699 | if (!is_first()) { |
| 1700 | event1_->Signal(); |
| 1701 | return; |
| 1702 | } |
| 1703 | *success_ = 0; |
| 1704 | int value = 0; |
| 1705 | OnPingTTL(3, &value); |
| 1706 | *success_ += (value == 3); |
| 1707 | OnPingTTL(4, &value); |
| 1708 | *success_ += (value == 4); |
| 1709 | OnPingTTL(5, &value); |
| 1710 | *success_ += (value == 5); |
| 1711 | other_channel_->Send(new SyncChannelTestMsg_Done); |
| 1712 | other_channel_.reset(); |
| 1713 | Done(); |
| 1714 | } |
| 1715 | |
| 1716 | bool is_first() { return !!success_; } |
| 1717 | |
| 1718 | private: |
| 1719 | bool OnMessageReceived(const Message& message) { |
| 1720 | IPC_BEGIN_MESSAGE_MAP(RestrictedDispatchPipeWorker, message) |
| 1721 | IPC_MESSAGE_HANDLER(SyncChannelTestMsg_PingTTL, OnPingTTL) |
| 1722 | IPC_MESSAGE_HANDLER(SyncChannelTestMsg_Done, OnDone) |
| 1723 | IPC_END_MESSAGE_MAP() |
| 1724 | return true; |
| 1725 | } |
| 1726 | |
| 1727 | scoped_ptr<SyncChannel> other_channel_; |
| 1728 | WaitableEvent* event1_; |
| 1729 | WaitableEvent* event2_; |
| 1730 | std::string other_channel_name_; |
| 1731 | int group_; |
| 1732 | int* success_; |
| 1733 | }; |
| 1734 | |
| 1735 | } // namespace |
| 1736 | |
| 1737 | TEST_F(IPCSyncChannelTest, RestrictedDispatch4WayDeadlock) { |
| 1738 | int success = 0; |
| 1739 | std::vector<Worker*> workers; |
| 1740 | WaitableEvent event0(true, false); |
| 1741 | WaitableEvent event1(true, false); |
| 1742 | WaitableEvent event2(true, false); |
| 1743 | WaitableEvent event3(true, false); |
| 1744 | workers.push_back(new RestrictedDispatchPipeWorker( |
| 1745 | "channel0", &event0, "channel1", &event1, 1, &success)); |
| 1746 | workers.push_back(new RestrictedDispatchPipeWorker( |
| 1747 | "channel1", &event1, "channel2", &event2, 2, NULL)); |
| 1748 | workers.push_back(new RestrictedDispatchPipeWorker( |
| 1749 | "channel2", &event2, "channel3", &event3, 3, NULL)); |
| 1750 | workers.push_back(new RestrictedDispatchPipeWorker( |
| 1751 | "channel3", &event3, "channel0", &event0, 4, NULL)); |
| 1752 | RunTest(workers); |
| 1753 | EXPECT_EQ(3, success); |
| 1754 | } |
| 1755 | |
piman@chromium.org | de4e75e | 2012-04-11 05:07:53 +0900 | [diff] [blame] | 1756 | |
| 1757 | //----------------------------------------------------------------------------- |
| 1758 | // |
| 1759 | // This test case inspired by crbug.com/122443 |
| 1760 | // We want to make sure a reply message with the unblock flag set correctly |
| 1761 | // behaves as a reply, not a regular message. |
| 1762 | // We have 3 workers. Server1 will send a message to Server2 (which will block), |
| 1763 | // during which it will dispatch a message comming from Client, at which point |
| 1764 | // it will send another message to Server2. While sending that second message it |
| 1765 | // will receive a reply from Server1 with the unblock flag. |
| 1766 | |
| 1767 | namespace { |
| 1768 | |
| 1769 | class ReentrantReplyServer1 : public Worker { |
| 1770 | public: |
| 1771 | ReentrantReplyServer1(WaitableEvent* server_ready) |
| 1772 | : Worker("reentrant_reply1", Channel::MODE_SERVER), |
| 1773 | server_ready_(server_ready) { } |
| 1774 | |
| 1775 | void Run() { |
| 1776 | server2_channel_.reset(new SyncChannel( |
| 1777 | "reentrant_reply2", Channel::MODE_CLIENT, this, |
| 1778 | ipc_thread().message_loop_proxy(), true, shutdown_event())); |
| 1779 | server_ready_->Signal(); |
| 1780 | Message* msg = new SyncChannelTestMsg_Reentrant1(); |
| 1781 | server2_channel_->Send(msg); |
| 1782 | server2_channel_.reset(); |
| 1783 | Done(); |
| 1784 | } |
| 1785 | |
| 1786 | private: |
| 1787 | bool OnMessageReceived(const Message& message) { |
| 1788 | IPC_BEGIN_MESSAGE_MAP(ReentrantReplyServer1, message) |
| 1789 | IPC_MESSAGE_HANDLER(SyncChannelTestMsg_Reentrant2, OnReentrant2) |
| 1790 | IPC_REPLY_HANDLER(OnReply) |
| 1791 | IPC_END_MESSAGE_MAP() |
| 1792 | return true; |
| 1793 | } |
| 1794 | |
| 1795 | void OnReentrant2() { |
| 1796 | Message* msg = new SyncChannelTestMsg_Reentrant3(); |
| 1797 | server2_channel_->Send(msg); |
| 1798 | } |
| 1799 | |
| 1800 | void OnReply(const Message& message) { |
| 1801 | // If we get here, the Send() will never receive the reply (thus would |
| 1802 | // hang), so abort instead. |
| 1803 | LOG(FATAL) << "Reply message was dispatched"; |
| 1804 | } |
| 1805 | |
| 1806 | WaitableEvent* server_ready_; |
| 1807 | scoped_ptr<SyncChannel> server2_channel_; |
| 1808 | }; |
| 1809 | |
| 1810 | class ReentrantReplyServer2 : public Worker { |
| 1811 | public: |
| 1812 | ReentrantReplyServer2() |
| 1813 | : Worker("reentrant_reply2", Channel::MODE_SERVER), |
| 1814 | reply_(NULL) { } |
| 1815 | |
| 1816 | private: |
| 1817 | bool OnMessageReceived(const Message& message) { |
| 1818 | IPC_BEGIN_MESSAGE_MAP(ReentrantReplyServer2, message) |
| 1819 | IPC_MESSAGE_HANDLER_DELAY_REPLY( |
| 1820 | SyncChannelTestMsg_Reentrant1, OnReentrant1) |
| 1821 | IPC_MESSAGE_HANDLER(SyncChannelTestMsg_Reentrant3, OnReentrant3) |
| 1822 | IPC_END_MESSAGE_MAP() |
| 1823 | return true; |
| 1824 | } |
| 1825 | |
| 1826 | void OnReentrant1(Message* reply) { |
| 1827 | DCHECK(!reply_); |
| 1828 | reply_ = reply; |
| 1829 | } |
| 1830 | |
| 1831 | void OnReentrant3() { |
| 1832 | DCHECK(reply_); |
| 1833 | Message* reply = reply_; |
| 1834 | reply_ = NULL; |
| 1835 | reply->set_unblock(true); |
| 1836 | Send(reply); |
| 1837 | Done(); |
| 1838 | } |
| 1839 | |
| 1840 | Message* reply_; |
| 1841 | }; |
| 1842 | |
| 1843 | class ReentrantReplyClient : public Worker { |
| 1844 | public: |
| 1845 | ReentrantReplyClient(WaitableEvent* server_ready) |
| 1846 | : Worker("reentrant_reply1", Channel::MODE_CLIENT), |
| 1847 | server_ready_(server_ready) { } |
| 1848 | |
| 1849 | void Run() { |
| 1850 | server_ready_->Wait(); |
| 1851 | Send(new SyncChannelTestMsg_Reentrant2()); |
| 1852 | Done(); |
| 1853 | } |
| 1854 | |
| 1855 | private: |
| 1856 | WaitableEvent* server_ready_; |
| 1857 | }; |
| 1858 | |
| 1859 | } // namespace |
| 1860 | |
| 1861 | TEST_F(IPCSyncChannelTest, ReentrantReply) { |
| 1862 | std::vector<Worker*> workers; |
| 1863 | WaitableEvent server_ready(false, false); |
| 1864 | workers.push_back(new ReentrantReplyServer2()); |
| 1865 | workers.push_back(new ReentrantReplyServer1(&server_ready)); |
| 1866 | workers.push_back(new ReentrantReplyClient(&server_ready)); |
| 1867 | RunTest(workers); |
| 1868 | } |
| 1869 | |
piman@chromium.org | 5a00b88 | 2012-03-31 06:29:30 +0900 | [diff] [blame] | 1870 | //----------------------------------------------------------------------------- |
| 1871 | |
jschuh@chromium.org | f75a4d1 | 2012-03-17 11:20:46 +0900 | [diff] [blame] | 1872 | // Generate a validated channel ID using Channel::GenerateVerifiedChannelID(). |
| 1873 | namespace { |
| 1874 | |
| 1875 | class VerifiedServer : public Worker { |
| 1876 | public: |
| 1877 | VerifiedServer(base::Thread* listener_thread, |
| 1878 | const std::string& channel_name, |
| 1879 | const std::string& reply_text) |
| 1880 | : Worker(channel_name, Channel::MODE_SERVER), |
| 1881 | reply_text_(reply_text) { |
| 1882 | Worker::OverrideThread(listener_thread); |
| 1883 | } |
| 1884 | |
| 1885 | virtual void OnNestedTestMsg(Message* reply_msg) { |
| 1886 | VLOG(1) << __FUNCTION__ << " Sending reply: " << reply_text_; |
| 1887 | SyncChannelNestedTestMsg_String::WriteReplyParams(reply_msg, reply_text_); |
| 1888 | Send(reply_msg); |
jschuh@chromium.org | a5cd076 | 2012-04-05 11:38:34 +0900 | [diff] [blame] | 1889 | ASSERT_EQ(channel()->peer_pid(), base::GetCurrentProcId()); |
jschuh@chromium.org | f75a4d1 | 2012-03-17 11:20:46 +0900 | [diff] [blame] | 1890 | Done(); |
| 1891 | } |
| 1892 | |
| 1893 | private: |
| 1894 | std::string reply_text_; |
| 1895 | }; |
| 1896 | |
| 1897 | class VerifiedClient : public Worker { |
| 1898 | public: |
| 1899 | VerifiedClient(base::Thread* listener_thread, |
| 1900 | const std::string& channel_name, |
| 1901 | const std::string& expected_text) |
| 1902 | : Worker(channel_name, Channel::MODE_CLIENT), |
| 1903 | expected_text_(expected_text) { |
| 1904 | Worker::OverrideThread(listener_thread); |
| 1905 | } |
| 1906 | |
| 1907 | virtual void Run() { |
| 1908 | std::string response; |
| 1909 | SyncMessage* msg = new SyncChannelNestedTestMsg_String(&response); |
| 1910 | bool result = Send(msg); |
| 1911 | DCHECK(result); |
| 1912 | DCHECK_EQ(response, expected_text_); |
| 1913 | |
| 1914 | VLOG(1) << __FUNCTION__ << " Received reply: " << response; |
jschuh@chromium.org | a5cd076 | 2012-04-05 11:38:34 +0900 | [diff] [blame] | 1915 | ASSERT_EQ(channel()->peer_pid(), base::GetCurrentProcId()); |
jschuh@chromium.org | f75a4d1 | 2012-03-17 11:20:46 +0900 | [diff] [blame] | 1916 | Done(); |
| 1917 | } |
| 1918 | |
| 1919 | private: |
| 1920 | bool pump_during_send_; |
| 1921 | std::string expected_text_; |
| 1922 | }; |
| 1923 | |
| 1924 | void Verified() { |
| 1925 | std::vector<Worker*> workers; |
| 1926 | |
| 1927 | // A shared worker thread for servers |
| 1928 | base::Thread server_worker_thread("Verified_ServerListener"); |
| 1929 | ASSERT_TRUE(server_worker_thread.Start()); |
| 1930 | |
| 1931 | base::Thread client_worker_thread("Verified_ClientListener"); |
| 1932 | ASSERT_TRUE(client_worker_thread.Start()); |
| 1933 | |
| 1934 | std::string channel_id = Channel::GenerateVerifiedChannelID("Verified"); |
| 1935 | Worker* worker; |
| 1936 | |
| 1937 | worker = new VerifiedServer(&server_worker_thread, |
| 1938 | channel_id, |
| 1939 | "Got first message"); |
| 1940 | workers.push_back(worker); |
| 1941 | |
| 1942 | worker = new VerifiedClient(&client_worker_thread, |
| 1943 | channel_id, |
| 1944 | "Got first message"); |
| 1945 | workers.push_back(worker); |
| 1946 | |
| 1947 | RunTest(workers); |
| 1948 | |
| 1949 | #if defined(OS_WIN) |
| 1950 | #endif |
| 1951 | } |
| 1952 | |
| 1953 | } // namespace |
| 1954 | |
| 1955 | // Windows needs to send an out-of-band secret to verify the client end of the |
| 1956 | // channel. Test that we still connect correctly in that case. |
| 1957 | TEST_F(IPCSyncChannelTest, Verified) { |
| 1958 | Verified(); |
| 1959 | } |
| 1960 | |
kushi.p@gmail.com | 5948bf4 | 2011-05-14 07:42:41 +0900 | [diff] [blame] | 1961 | } // namespace IPC |