summaryrefslogtreecommitdiffstats
path: root/xpcom/tests/gtest/TestThreadPool.cpp
blob: 0dd0f51537f7a0cc76253c76106acfac1113330b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include <stdio.h>
#include <stdlib.h>
#include "nsXPCOM.h"
#include "nsXPCOMCIDInternal.h"
#include "nsThreadPool.h"
#include "nsComponentManagerUtils.h"
#include "nsCOMPtr.h"
#include "nsIRunnable.h"
#include "nsThreadUtils.h"
#include "mozilla/Atomics.h"
#include "mozilla/Monitor.h"
#include "gtest/gtest.h"

using namespace mozilla;

class TestTask final : public Runnable {
 public:
  TestTask(int i, Atomic<int>& aCounter)
      : Runnable("TestThreadPool::Task"), mIndex(i), mCounter(aCounter) {}

  NS_IMETHOD Run() override {
    printf("###(%d) running from thread: %p\n", mIndex,
           (void*)PR_GetCurrentThread());
    int r = (int)((float)rand() * 200 / float(RAND_MAX));
    PR_Sleep(PR_MillisecondsToInterval(r));
    printf("###(%d) exiting from thread: %p\n", mIndex,
           (void*)PR_GetCurrentThread());
    ++mCounter;
    return NS_OK;
  }

 private:
  ~TestTask() = default;

  int mIndex;
  Atomic<int>& mCounter;
};

TEST(ThreadPool, Main)
{
  nsCOMPtr<nsIThreadPool> pool = new nsThreadPool();

  Atomic<int> count(0);

  for (int i = 0; i < 100; ++i) {
    nsCOMPtr<nsIRunnable> task = new TestTask(i, count);
    EXPECT_TRUE(task);

    pool->Dispatch(task, NS_DISPATCH_NORMAL);
  }

  pool->Shutdown();
  EXPECT_EQ(count, 100);
}

TEST(ThreadPool, Parallelism)
{
  nsCOMPtr<nsIThreadPool> pool = new nsThreadPool();

  // Dispatch and sleep to ensure we have an idle thread
  nsCOMPtr<nsIRunnable> r0 = new Runnable("TestRunnable");
  NS_DispatchAndSpinEventLoopUntilComplete("ThreadPool::Parallelism"_ns, pool,
                                           do_AddRef(r0));
  PR_Sleep(PR_SecondsToInterval(2));

  class Runnable1 : public Runnable {
   public:
    Runnable1(Monitor& aMonitor, bool& aDone)
        : mozilla::Runnable("Runnable1"), mMonitor(aMonitor), mDone(aDone) {}

    NS_IMETHOD Run() override {
      MonitorAutoLock mon(mMonitor);
      if (!mDone) {
        // Wait for a reasonable timeout since we don't want to block gtests
        // forever should any regression happen.
        mon.Wait(TimeDuration::FromSeconds(300));
      }
      EXPECT_TRUE(mDone);
      return NS_OK;
    }

   private:
    Monitor& mMonitor;
    bool& mDone;
  };

  class Runnable2 : public Runnable {
   public:
    Runnable2(Monitor& aMonitor, bool& aDone)
        : mozilla::Runnable("Runnable2"), mMonitor(aMonitor), mDone(aDone) {}

    NS_IMETHOD Run() override {
      MonitorAutoLock mon(mMonitor);
      mDone = true;
      mon.NotifyAll();
      return NS_OK;
    }

   private:
    Monitor& mMonitor;
    bool& mDone;
  };

  // Dispatch 2 events in a row. Since we are still within the thread limit,
  // We should wake up the idle thread and spawn a new thread so these 2 events
  // can run in parallel. We will time out if r1 and r2 run in sequence for r1
  // won't finish until r2 finishes.
  Monitor mon MOZ_UNANNOTATED("ThreadPool::Parallelism");
  bool done = false;
  nsCOMPtr<nsIRunnable> r1 = new Runnable1(mon, done);
  nsCOMPtr<nsIRunnable> r2 = new Runnable2(mon, done);
  pool->Dispatch(r1, NS_DISPATCH_NORMAL);
  pool->Dispatch(r2, NS_DISPATCH_NORMAL);

  pool->Shutdown();
}

TEST(ThreadPool, ShutdownWithTimeout)
{
  nsCOMPtr<nsIThreadPool> pool = new nsThreadPool();

  Atomic<int> allThreadsCount(0);
  for (int i = 0; i < 4; ++i) {
    nsCOMPtr<nsIRunnable> task = new TestTask(i, allThreadsCount);
    EXPECT_TRUE(task);

    pool->Dispatch(task, NS_DISPATCH_NORMAL);
  }

  // Wait for a max of 350 ms. All threads should be done by then.
  pool->ShutdownWithTimeout(350);
  EXPECT_EQ(allThreadsCount, 4);

  Atomic<int> infiniteLoopCount(0);
  Atomic<bool> shutdownInfiniteLoop(false);
  Atomic<bool> shutdownAck(false);
  pool = new nsThreadPool();
  for (int i = 0; i < 3; ++i) {
    nsCOMPtr<nsIRunnable> task = new TestTask(i, infiniteLoopCount);
    EXPECT_TRUE(task);

    pool->Dispatch(task, NS_DISPATCH_NORMAL);
  }

  pool->Dispatch(NS_NewRunnableFunction(
                     "infinite-loop",
                     [&shutdownInfiniteLoop, &shutdownAck]() {
                       printf("### running from thread that never ends: %p\n",
                              (void*)PR_GetCurrentThread());
                       while (!shutdownInfiniteLoop) {
                         PR_Sleep(PR_MillisecondsToInterval(100));
                       }
                       shutdownAck = true;
                     }),
                 NS_DISPATCH_NORMAL);

  pool->ShutdownWithTimeout(1000);
  EXPECT_EQ(infiniteLoopCount, 3);

  shutdownInfiniteLoop = true;
  while (!shutdownAck) {
    /* nothing */
  }
}

TEST(ThreadPool, ShutdownWithTimeoutThenSleep)
{
  Atomic<int> count(0);
  nsCOMPtr<nsIThreadPool> pool = new nsThreadPool();

  for (int i = 0; i < 3; ++i) {
    nsCOMPtr<nsIRunnable> task = new TestTask(i, count);
    EXPECT_TRUE(task);

    pool->Dispatch(task, NS_DISPATCH_NORMAL);
  }

  pool->Dispatch(
      NS_NewRunnableFunction(
          "sleep-for-400-ms",
          [&count]() {
            printf("### running from thread that sleeps for 400ms: %p\n",
                   (void*)PR_GetCurrentThread());
            PR_Sleep(PR_MillisecondsToInterval(400));
            ++count;
            printf("### thread awoke from long sleep: %p\n",
                   (void*)PR_GetCurrentThread());
          }),
      NS_DISPATCH_NORMAL);

  // Wait for a max of 350 ms. The thread should still be sleeping, and will
  // be leaked.
  pool->ShutdownWithTimeout(350);
  // We can't be exact here; the thread we're running on might have gotten
  // suspended and the sleeping thread, above, might have finished.
  EXPECT_GE(count, 3);

  // Sleep for a bit, and wait for the last thread to finish up.
  PR_Sleep(PR_MillisecondsToInterval(200));

  // Process events so the shutdown ack is received
  NS_ProcessPendingEvents(NS_GetCurrentThread());

  EXPECT_EQ(count, 4);
}