webrtc_m130/rtc_base/platform_thread_unittest.cc

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

106 lines
3.1 KiB
C++
Raw Normal View History

/*
* Copyright (c) 2012 The WebRTC project authors. All Rights Reserved.
*
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
#include "rtc_base/platform_thread.h"
#include "rtc_base/event.h"
#include "system_wrappers/include/sleep.h"
#include "test/gmock.h"
namespace rtc {
Revert "Refactor the PlatformThread API." This reverts commit c89fdd716c4c8af608017c76f75bf27e4c3d602e. Reason for revert: Causes rare compilation error on win-libfuzzer-asan trybot. See https://ci.chromium.org/p/chromium/builders/try/win-libfuzzer-asan-rel/713745? Original change's description: > Refactor the PlatformThread API. > > PlatformThread's API is using old style function pointers, causes > casting, is unintuitive and forces artificial call sequences, and > is additionally possible to misuse in release mode. > > Fix this by an API face lift: > 1. The class is turned into a handle, which can be empty. > 2. The only way of getting a non-empty PlatformThread is by calling > SpawnJoinable or SpawnDetached, clearly conveying the semantics to the > code reader. > 3. Handles can be Finalized, which works differently for joinable and > detached threads: > a) Handles for detached threads are simply closed where applicable. > b) Joinable threads are joined before handles are closed. > 4. The destructor finalizes handles. No explicit call is needed. > > Fixed: webrtc:12727 > Change-Id: Id00a0464edf4fc9e552b6a1fbb5d2e1280e88811 > Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/215075 > Commit-Queue: Markus Handell <handellm@webrtc.org> > Reviewed-by: Harald Alvestrand <hta@webrtc.org> > Reviewed-by: Mirko Bonadei <mbonadei@webrtc.org> > Reviewed-by: Tommi <tommi@webrtc.org> > Cr-Commit-Position: refs/heads/master@{#33923} # Not skipping CQ checks because original CL landed > 1 day ago. TBR=handellm@webrtc.org Bug: webrtc:12727 Change-Id: Ic0146be8866f6dd3ad9c364fb8646650b8e07419 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/217583 Reviewed-by: Guido Urdaneta <guidou@webrtc.org> Reviewed-by: Markus Handell <handellm@webrtc.org> Commit-Queue: Guido Urdaneta <guidou@webrtc.org> Cr-Commit-Position: refs/heads/master@{#33936}
2021-05-06 13:12:47 +00:00
namespace {
Revert "Refactor the PlatformThread API." This reverts commit c89fdd716c4c8af608017c76f75bf27e4c3d602e. Reason for revert: Causes rare compilation error on win-libfuzzer-asan trybot. See https://ci.chromium.org/p/chromium/builders/try/win-libfuzzer-asan-rel/713745? Original change's description: > Refactor the PlatformThread API. > > PlatformThread's API is using old style function pointers, causes > casting, is unintuitive and forces artificial call sequences, and > is additionally possible to misuse in release mode. > > Fix this by an API face lift: > 1. The class is turned into a handle, which can be empty. > 2. The only way of getting a non-empty PlatformThread is by calling > SpawnJoinable or SpawnDetached, clearly conveying the semantics to the > code reader. > 3. Handles can be Finalized, which works differently for joinable and > detached threads: > a) Handles for detached threads are simply closed where applicable. > b) Joinable threads are joined before handles are closed. > 4. The destructor finalizes handles. No explicit call is needed. > > Fixed: webrtc:12727 > Change-Id: Id00a0464edf4fc9e552b6a1fbb5d2e1280e88811 > Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/215075 > Commit-Queue: Markus Handell <handellm@webrtc.org> > Reviewed-by: Harald Alvestrand <hta@webrtc.org> > Reviewed-by: Mirko Bonadei <mbonadei@webrtc.org> > Reviewed-by: Tommi <tommi@webrtc.org> > Cr-Commit-Position: refs/heads/master@{#33923} # Not skipping CQ checks because original CL landed > 1 day ago. TBR=handellm@webrtc.org Bug: webrtc:12727 Change-Id: Ic0146be8866f6dd3ad9c364fb8646650b8e07419 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/217583 Reviewed-by: Guido Urdaneta <guidou@webrtc.org> Reviewed-by: Markus Handell <handellm@webrtc.org> Commit-Queue: Guido Urdaneta <guidou@webrtc.org> Cr-Commit-Position: refs/heads/master@{#33936}
2021-05-06 13:12:47 +00:00
void NullRunFunction(void* obj) {}
Revert "Refactor the PlatformThread API." This reverts commit c89fdd716c4c8af608017c76f75bf27e4c3d602e. Reason for revert: Causes rare compilation error on win-libfuzzer-asan trybot. See https://ci.chromium.org/p/chromium/builders/try/win-libfuzzer-asan-rel/713745? Original change's description: > Refactor the PlatformThread API. > > PlatformThread's API is using old style function pointers, causes > casting, is unintuitive and forces artificial call sequences, and > is additionally possible to misuse in release mode. > > Fix this by an API face lift: > 1. The class is turned into a handle, which can be empty. > 2. The only way of getting a non-empty PlatformThread is by calling > SpawnJoinable or SpawnDetached, clearly conveying the semantics to the > code reader. > 3. Handles can be Finalized, which works differently for joinable and > detached threads: > a) Handles for detached threads are simply closed where applicable. > b) Joinable threads are joined before handles are closed. > 4. The destructor finalizes handles. No explicit call is needed. > > Fixed: webrtc:12727 > Change-Id: Id00a0464edf4fc9e552b6a1fbb5d2e1280e88811 > Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/215075 > Commit-Queue: Markus Handell <handellm@webrtc.org> > Reviewed-by: Harald Alvestrand <hta@webrtc.org> > Reviewed-by: Mirko Bonadei <mbonadei@webrtc.org> > Reviewed-by: Tommi <tommi@webrtc.org> > Cr-Commit-Position: refs/heads/master@{#33923} # Not skipping CQ checks because original CL landed > 1 day ago. TBR=handellm@webrtc.org Bug: webrtc:12727 Change-Id: Ic0146be8866f6dd3ad9c364fb8646650b8e07419 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/217583 Reviewed-by: Guido Urdaneta <guidou@webrtc.org> Reviewed-by: Markus Handell <handellm@webrtc.org> Commit-Queue: Guido Urdaneta <guidou@webrtc.org> Cr-Commit-Position: refs/heads/master@{#33936}
2021-05-06 13:12:47 +00:00
// Function that sets a boolean.
void SetFlagRunFunction(void* obj) {
bool* obj_as_bool = static_cast<bool*>(obj);
*obj_as_bool = true;
}
Revert "Refactor the PlatformThread API." This reverts commit c89fdd716c4c8af608017c76f75bf27e4c3d602e. Reason for revert: Causes rare compilation error on win-libfuzzer-asan trybot. See https://ci.chromium.org/p/chromium/builders/try/win-libfuzzer-asan-rel/713745? Original change's description: > Refactor the PlatformThread API. > > PlatformThread's API is using old style function pointers, causes > casting, is unintuitive and forces artificial call sequences, and > is additionally possible to misuse in release mode. > > Fix this by an API face lift: > 1. The class is turned into a handle, which can be empty. > 2. The only way of getting a non-empty PlatformThread is by calling > SpawnJoinable or SpawnDetached, clearly conveying the semantics to the > code reader. > 3. Handles can be Finalized, which works differently for joinable and > detached threads: > a) Handles for detached threads are simply closed where applicable. > b) Joinable threads are joined before handles are closed. > 4. The destructor finalizes handles. No explicit call is needed. > > Fixed: webrtc:12727 > Change-Id: Id00a0464edf4fc9e552b6a1fbb5d2e1280e88811 > Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/215075 > Commit-Queue: Markus Handell <handellm@webrtc.org> > Reviewed-by: Harald Alvestrand <hta@webrtc.org> > Reviewed-by: Mirko Bonadei <mbonadei@webrtc.org> > Reviewed-by: Tommi <tommi@webrtc.org> > Cr-Commit-Position: refs/heads/master@{#33923} # Not skipping CQ checks because original CL landed > 1 day ago. TBR=handellm@webrtc.org Bug: webrtc:12727 Change-Id: Ic0146be8866f6dd3ad9c364fb8646650b8e07419 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/217583 Reviewed-by: Guido Urdaneta <guidou@webrtc.org> Reviewed-by: Markus Handell <handellm@webrtc.org> Commit-Queue: Guido Urdaneta <guidou@webrtc.org> Cr-Commit-Position: refs/heads/master@{#33936}
2021-05-06 13:12:47 +00:00
void StdFunctionRunFunction(void* obj) {
std::function<void()>* fun = static_cast<std::function<void()>*>(obj);
(*fun)();
}
Revert "Refactor the PlatformThread API." This reverts commit c89fdd716c4c8af608017c76f75bf27e4c3d602e. Reason for revert: Causes rare compilation error on win-libfuzzer-asan trybot. See https://ci.chromium.org/p/chromium/builders/try/win-libfuzzer-asan-rel/713745? Original change's description: > Refactor the PlatformThread API. > > PlatformThread's API is using old style function pointers, causes > casting, is unintuitive and forces artificial call sequences, and > is additionally possible to misuse in release mode. > > Fix this by an API face lift: > 1. The class is turned into a handle, which can be empty. > 2. The only way of getting a non-empty PlatformThread is by calling > SpawnJoinable or SpawnDetached, clearly conveying the semantics to the > code reader. > 3. Handles can be Finalized, which works differently for joinable and > detached threads: > a) Handles for detached threads are simply closed where applicable. > b) Joinable threads are joined before handles are closed. > 4. The destructor finalizes handles. No explicit call is needed. > > Fixed: webrtc:12727 > Change-Id: Id00a0464edf4fc9e552b6a1fbb5d2e1280e88811 > Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/215075 > Commit-Queue: Markus Handell <handellm@webrtc.org> > Reviewed-by: Harald Alvestrand <hta@webrtc.org> > Reviewed-by: Mirko Bonadei <mbonadei@webrtc.org> > Reviewed-by: Tommi <tommi@webrtc.org> > Cr-Commit-Position: refs/heads/master@{#33923} # Not skipping CQ checks because original CL landed > 1 day ago. TBR=handellm@webrtc.org Bug: webrtc:12727 Change-Id: Ic0146be8866f6dd3ad9c364fb8646650b8e07419 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/217583 Reviewed-by: Guido Urdaneta <guidou@webrtc.org> Reviewed-by: Markus Handell <handellm@webrtc.org> Commit-Queue: Guido Urdaneta <guidou@webrtc.org> Cr-Commit-Position: refs/heads/master@{#33936}
2021-05-06 13:12:47 +00:00
} // namespace
TEST(PlatformThreadTest, StartStop) {
PlatformThread thread(&NullRunFunction, nullptr, "PlatformThreadTest");
EXPECT_TRUE(thread.name() == "PlatformThreadTest");
EXPECT_TRUE(thread.GetThreadRef() == 0);
thread.Start();
EXPECT_TRUE(thread.GetThreadRef() != 0);
thread.Stop();
EXPECT_TRUE(thread.GetThreadRef() == 0);
}
Revert "Refactor the PlatformThread API." This reverts commit c89fdd716c4c8af608017c76f75bf27e4c3d602e. Reason for revert: Causes rare compilation error on win-libfuzzer-asan trybot. See https://ci.chromium.org/p/chromium/builders/try/win-libfuzzer-asan-rel/713745? Original change's description: > Refactor the PlatformThread API. > > PlatformThread's API is using old style function pointers, causes > casting, is unintuitive and forces artificial call sequences, and > is additionally possible to misuse in release mode. > > Fix this by an API face lift: > 1. The class is turned into a handle, which can be empty. > 2. The only way of getting a non-empty PlatformThread is by calling > SpawnJoinable or SpawnDetached, clearly conveying the semantics to the > code reader. > 3. Handles can be Finalized, which works differently for joinable and > detached threads: > a) Handles for detached threads are simply closed where applicable. > b) Joinable threads are joined before handles are closed. > 4. The destructor finalizes handles. No explicit call is needed. > > Fixed: webrtc:12727 > Change-Id: Id00a0464edf4fc9e552b6a1fbb5d2e1280e88811 > Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/215075 > Commit-Queue: Markus Handell <handellm@webrtc.org> > Reviewed-by: Harald Alvestrand <hta@webrtc.org> > Reviewed-by: Mirko Bonadei <mbonadei@webrtc.org> > Reviewed-by: Tommi <tommi@webrtc.org> > Cr-Commit-Position: refs/heads/master@{#33923} # Not skipping CQ checks because original CL landed > 1 day ago. TBR=handellm@webrtc.org Bug: webrtc:12727 Change-Id: Ic0146be8866f6dd3ad9c364fb8646650b8e07419 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/217583 Reviewed-by: Guido Urdaneta <guidou@webrtc.org> Reviewed-by: Markus Handell <handellm@webrtc.org> Commit-Queue: Guido Urdaneta <guidou@webrtc.org> Cr-Commit-Position: refs/heads/master@{#33936}
2021-05-06 13:12:47 +00:00
TEST(PlatformThreadTest, StartStop2) {
PlatformThread thread1(&NullRunFunction, nullptr, "PlatformThreadTest1");
PlatformThread thread2(&NullRunFunction, nullptr, "PlatformThreadTest2");
EXPECT_TRUE(thread1.GetThreadRef() == thread2.GetThreadRef());
thread1.Start();
thread2.Start();
EXPECT_TRUE(thread1.GetThreadRef() != thread2.GetThreadRef());
thread2.Stop();
thread1.Stop();
}
TEST(PlatformThreadTest, RunFunctionIsCalled) {
bool flag = false;
Revert "Refactor the PlatformThread API." This reverts commit c89fdd716c4c8af608017c76f75bf27e4c3d602e. Reason for revert: Causes rare compilation error on win-libfuzzer-asan trybot. See https://ci.chromium.org/p/chromium/builders/try/win-libfuzzer-asan-rel/713745? Original change's description: > Refactor the PlatformThread API. > > PlatformThread's API is using old style function pointers, causes > casting, is unintuitive and forces artificial call sequences, and > is additionally possible to misuse in release mode. > > Fix this by an API face lift: > 1. The class is turned into a handle, which can be empty. > 2. The only way of getting a non-empty PlatformThread is by calling > SpawnJoinable or SpawnDetached, clearly conveying the semantics to the > code reader. > 3. Handles can be Finalized, which works differently for joinable and > detached threads: > a) Handles for detached threads are simply closed where applicable. > b) Joinable threads are joined before handles are closed. > 4. The destructor finalizes handles. No explicit call is needed. > > Fixed: webrtc:12727 > Change-Id: Id00a0464edf4fc9e552b6a1fbb5d2e1280e88811 > Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/215075 > Commit-Queue: Markus Handell <handellm@webrtc.org> > Reviewed-by: Harald Alvestrand <hta@webrtc.org> > Reviewed-by: Mirko Bonadei <mbonadei@webrtc.org> > Reviewed-by: Tommi <tommi@webrtc.org> > Cr-Commit-Position: refs/heads/master@{#33923} # Not skipping CQ checks because original CL landed > 1 day ago. TBR=handellm@webrtc.org Bug: webrtc:12727 Change-Id: Ic0146be8866f6dd3ad9c364fb8646650b8e07419 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/217583 Reviewed-by: Guido Urdaneta <guidou@webrtc.org> Reviewed-by: Markus Handell <handellm@webrtc.org> Commit-Queue: Guido Urdaneta <guidou@webrtc.org> Cr-Commit-Position: refs/heads/master@{#33936}
2021-05-06 13:12:47 +00:00
PlatformThread thread(&SetFlagRunFunction, &flag, "RunFunctionIsCalled");
thread.Start();
// At this point, the flag may be either true or false.
thread.Stop();
// We expect the thread to have run at least once.
EXPECT_TRUE(flag);
}
TEST(PlatformThreadTest, JoinsThread) {
// This test flakes if there are problems with the join implementation.
Revert "Refactor the PlatformThread API." This reverts commit c89fdd716c4c8af608017c76f75bf27e4c3d602e. Reason for revert: Causes rare compilation error on win-libfuzzer-asan trybot. See https://ci.chromium.org/p/chromium/builders/try/win-libfuzzer-asan-rel/713745? Original change's description: > Refactor the PlatformThread API. > > PlatformThread's API is using old style function pointers, causes > casting, is unintuitive and forces artificial call sequences, and > is additionally possible to misuse in release mode. > > Fix this by an API face lift: > 1. The class is turned into a handle, which can be empty. > 2. The only way of getting a non-empty PlatformThread is by calling > SpawnJoinable or SpawnDetached, clearly conveying the semantics to the > code reader. > 3. Handles can be Finalized, which works differently for joinable and > detached threads: > a) Handles for detached threads are simply closed where applicable. > b) Joinable threads are joined before handles are closed. > 4. The destructor finalizes handles. No explicit call is needed. > > Fixed: webrtc:12727 > Change-Id: Id00a0464edf4fc9e552b6a1fbb5d2e1280e88811 > Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/215075 > Commit-Queue: Markus Handell <handellm@webrtc.org> > Reviewed-by: Harald Alvestrand <hta@webrtc.org> > Reviewed-by: Mirko Bonadei <mbonadei@webrtc.org> > Reviewed-by: Tommi <tommi@webrtc.org> > Cr-Commit-Position: refs/heads/master@{#33923} # Not skipping CQ checks because original CL landed > 1 day ago. TBR=handellm@webrtc.org Bug: webrtc:12727 Change-Id: Ic0146be8866f6dd3ad9c364fb8646650b8e07419 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/217583 Reviewed-by: Guido Urdaneta <guidou@webrtc.org> Reviewed-by: Markus Handell <handellm@webrtc.org> Commit-Queue: Guido Urdaneta <guidou@webrtc.org> Cr-Commit-Position: refs/heads/master@{#33936}
2021-05-06 13:12:47 +00:00
EXPECT_TRUE(ThreadAttributes().joinable);
rtc::Event event;
Revert "Refactor the PlatformThread API." This reverts commit c89fdd716c4c8af608017c76f75bf27e4c3d602e. Reason for revert: Causes rare compilation error on win-libfuzzer-asan trybot. See https://ci.chromium.org/p/chromium/builders/try/win-libfuzzer-asan-rel/713745? Original change's description: > Refactor the PlatformThread API. > > PlatformThread's API is using old style function pointers, causes > casting, is unintuitive and forces artificial call sequences, and > is additionally possible to misuse in release mode. > > Fix this by an API face lift: > 1. The class is turned into a handle, which can be empty. > 2. The only way of getting a non-empty PlatformThread is by calling > SpawnJoinable or SpawnDetached, clearly conveying the semantics to the > code reader. > 3. Handles can be Finalized, which works differently for joinable and > detached threads: > a) Handles for detached threads are simply closed where applicable. > b) Joinable threads are joined before handles are closed. > 4. The destructor finalizes handles. No explicit call is needed. > > Fixed: webrtc:12727 > Change-Id: Id00a0464edf4fc9e552b6a1fbb5d2e1280e88811 > Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/215075 > Commit-Queue: Markus Handell <handellm@webrtc.org> > Reviewed-by: Harald Alvestrand <hta@webrtc.org> > Reviewed-by: Mirko Bonadei <mbonadei@webrtc.org> > Reviewed-by: Tommi <tommi@webrtc.org> > Cr-Commit-Position: refs/heads/master@{#33923} # Not skipping CQ checks because original CL landed > 1 day ago. TBR=handellm@webrtc.org Bug: webrtc:12727 Change-Id: Ic0146be8866f6dd3ad9c364fb8646650b8e07419 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/217583 Reviewed-by: Guido Urdaneta <guidou@webrtc.org> Reviewed-by: Markus Handell <handellm@webrtc.org> Commit-Queue: Guido Urdaneta <guidou@webrtc.org> Cr-Commit-Position: refs/heads/master@{#33936}
2021-05-06 13:12:47 +00:00
std::function<void()> thread_function = [&] { event.Set(); };
PlatformThread thread(&StdFunctionRunFunction, &thread_function, "T");
thread.Start();
thread.Stop();
EXPECT_TRUE(event.Wait(/*give_up_after_ms=*/0));
}
TEST(PlatformThreadTest, StopsBeforeDetachedThreadExits) {
// This test flakes if there are problems with the detached thread
// implementation.
bool flag = false;
rtc::Event thread_started;
rtc::Event thread_continue;
rtc::Event thread_exiting;
Revert "Refactor the PlatformThread API." This reverts commit c89fdd716c4c8af608017c76f75bf27e4c3d602e. Reason for revert: Causes rare compilation error on win-libfuzzer-asan trybot. See https://ci.chromium.org/p/chromium/builders/try/win-libfuzzer-asan-rel/713745? Original change's description: > Refactor the PlatformThread API. > > PlatformThread's API is using old style function pointers, causes > casting, is unintuitive and forces artificial call sequences, and > is additionally possible to misuse in release mode. > > Fix this by an API face lift: > 1. The class is turned into a handle, which can be empty. > 2. The only way of getting a non-empty PlatformThread is by calling > SpawnJoinable or SpawnDetached, clearly conveying the semantics to the > code reader. > 3. Handles can be Finalized, which works differently for joinable and > detached threads: > a) Handles for detached threads are simply closed where applicable. > b) Joinable threads are joined before handles are closed. > 4. The destructor finalizes handles. No explicit call is needed. > > Fixed: webrtc:12727 > Change-Id: Id00a0464edf4fc9e552b6a1fbb5d2e1280e88811 > Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/215075 > Commit-Queue: Markus Handell <handellm@webrtc.org> > Reviewed-by: Harald Alvestrand <hta@webrtc.org> > Reviewed-by: Mirko Bonadei <mbonadei@webrtc.org> > Reviewed-by: Tommi <tommi@webrtc.org> > Cr-Commit-Position: refs/heads/master@{#33923} # Not skipping CQ checks because original CL landed > 1 day ago. TBR=handellm@webrtc.org Bug: webrtc:12727 Change-Id: Ic0146be8866f6dd3ad9c364fb8646650b8e07419 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/217583 Reviewed-by: Guido Urdaneta <guidou@webrtc.org> Reviewed-by: Markus Handell <handellm@webrtc.org> Commit-Queue: Guido Urdaneta <guidou@webrtc.org> Cr-Commit-Position: refs/heads/master@{#33936}
2021-05-06 13:12:47 +00:00
std::function<void()> thread_function = [&] {
thread_started.Set();
thread_continue.Wait(Event::kForever);
flag = true;
thread_exiting.Set();
};
{
PlatformThread thread(&StdFunctionRunFunction, &thread_function, "T",
ThreadAttributes().SetDetached());
thread.Start();
thread.Stop();
}
thread_started.Wait(Event::kForever);
EXPECT_FALSE(flag);
thread_continue.Set();
thread_exiting.Wait(Event::kForever);
EXPECT_TRUE(flag);
}
} // namespace rtc