replica
/
hanchenye-llvm-project
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

[clang][DirectoryWatcher][NFC] Swapping asserts for llvm fatal_error in create 

I also have replaced all the instances of
"auto DW = DirectoryWatcher::create" with
llvm::Expected<std::unique_ptr<DirectoryWatcher>> DW = DirectoryWatcher::create
to make it more clear that DirectoryWatcher::create is returning an Expected.

I've also allowed for logAllUnhandledErrors to consume errors in the case were
DirectoryWatcher::create produces them.

Differential Revision: https://reviews.llvm.org/D65829

llvm-svn: 368108
This commit is contained in:
Puyan Lotfi 2019-08-06 23:25:34 +00:00
parent bd0d97e1c4
commit 1dcf216f9f
4 changed files with 110 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
clang/include/clang/DirectoryWatcher/DirectoryWatcher.h
View File

@ -99,10 +99,10 @@ public:
: Kind(Kind), Filename(Filename) {}
};
/// Asserts if \param Path doesn't exist or isn't a directory.
/// llvm fatal_error if \param Path doesn't exist or isn't a directory.
/// Returns llvm::Expected Error if OS kernel API told us we can't start
/// watching. In such case it's unclear whether just retrying has any chance
/// to succeeed.
/// to succeed.
static llvm::Expected<std::unique_ptr<DirectoryWatcher>>
create(llvm::StringRef Path,
std::function<void(llvm::ArrayRef<DirectoryWatcher::Event> Events,

4
clang/lib/DirectoryWatcher/linux/DirectoryWatcher-linux.cpp
View File

@ -325,7 +325,9 @@ llvm::Expected<std::unique_ptr<DirectoryWatcher>> clang::DirectoryWatcher::creat
StringRef Path,
std::function<void(llvm::ArrayRef<DirectoryWatcher::Event>, bool)> Receiver,
bool WaitForInitialSync) {
assert(!Path.empty() && "Path.empty()");
if (Path.empty())
llvm::report_fatal_error(
"DirectoryWatcher::create can not accept an empty Path.");
const int InotifyFD = inotify_init1(IN_CLOEXEC);
if (InotifyFD == -1)

8
clang/lib/DirectoryWatcher/mac/DirectoryWatcher-mac.cpp
View File

@ -150,7 +150,8 @@ FSEventStreamRef createFSEventStream(
StringRef Path,
std::function<void(llvm::ArrayRef<DirectoryWatcher::Event>, bool)> Receiver,
dispatch_queue_t Queue) {
assert(!Path.empty() && "Path.empty()");
if (Path.empty())
return nullptr;
CFMutableArrayRef PathsToWatch = [&]() {
CFMutableArrayRef PathsToWatch =
@ -208,7 +209,10 @@ llvm::Expected<std::unique_ptr<DirectoryWatcher>> clang::DirectoryWatcher::creat
dispatch_queue_t Queue =
dispatch_queue_create("DirectoryWatcher", DISPATCH_QUEUE_SERIAL);
assert(!Path.empty() && "Path.empty()");
if (Path.empty())
llvm::report_fatal_error(
"DirectoryWatcher::create can not accept an empty Path.");
auto EventStream = createFSEventStream(Path, Receiver, Queue);
assert(EventStream && "EventStream expected to be non-null");

156
clang/unittests/DirectoryWatcher/DirectoryWatcherTest.cpp
View File

@ -277,14 +277,20 @@ TEST(DirectoryWatcherTest, InitialScanSync) {
{EventKind::Modified, "c"}}
};
auto DW = DirectoryWatcher::create(
fixture.TestWatchedDir,
[&TestConsumer](llvm::ArrayRef<DirectoryWatcher::Event> Events,
bool IsInitial) {
TestConsumer.consume(Events, IsInitial);
},
/*waitForInitialSync=*/true);
if (!DW) return;
llvm::Expected<std::unique_ptr<DirectoryWatcher>> DW =
DirectoryWatcher::create(
fixture.TestWatchedDir,
[&TestConsumer](llvm::ArrayRef<DirectoryWatcher::Event> Events,
bool IsInitial) {
TestConsumer.consume(Events, IsInitial);
},
/*waitForInitialSync=*/true);
if (!DW) {
logAllUnhandledErrors(
DW.takeError(), llvm::errs(),
"DirectoryWatcherTest Failure on DirectoryWatcher::create(): ");
exit(EXIT_FAILURE);
}
checkEventualResultWithTimeout(TestConsumer);
}
@ -309,14 +315,20 @@ TEST(DirectoryWatcherTest, InitialScanAsync) {
{EventKind::Modified, "c"}}
};
auto DW = DirectoryWatcher::create(
fixture.TestWatchedDir,
[&TestConsumer](llvm::ArrayRef<DirectoryWatcher::Event> Events,
bool IsInitial) {
TestConsumer.consume(Events, IsInitial);
},
/*waitForInitialSync=*/false);
if (!DW) return;
llvm::Expected<std::unique_ptr<DirectoryWatcher>> DW =
DirectoryWatcher::create(
fixture.TestWatchedDir,
[&TestConsumer](llvm::ArrayRef<DirectoryWatcher::Event> Events,
bool IsInitial) {
TestConsumer.consume(Events, IsInitial);
},
/*waitForInitialSync=*/false);
if (!DW) {
logAllUnhandledErrors(
DW.takeError(), llvm::errs(),
"DirectoryWatcherTest Failure on DirectoryWatcher::create(): ");
exit(EXIT_FAILURE);
}
checkEventualResultWithTimeout(TestConsumer);
}
@ -330,14 +342,20 @@ TEST(DirectoryWatcherTest, AddFiles) {
{EventKind::Modified, "b"},
{EventKind::Modified, "c"}}};
auto DW = DirectoryWatcher::create(
fixture.TestWatchedDir,
[&TestConsumer](llvm::ArrayRef<DirectoryWatcher::Event> Events,
bool IsInitial) {
TestConsumer.consume(Events, IsInitial);
},
/*waitForInitialSync=*/true);
if (!DW) return;
llvm::Expected<std::unique_ptr<DirectoryWatcher>> DW =
DirectoryWatcher::create(
fixture.TestWatchedDir,
[&TestConsumer](llvm::ArrayRef<DirectoryWatcher::Event> Events,
bool IsInitial) {
TestConsumer.consume(Events, IsInitial);
},
/*waitForInitialSync=*/true);
if (!DW) {
logAllUnhandledErrors(
DW.takeError(), llvm::errs(),
"DirectoryWatcherTest Failure on DirectoryWatcher::create(): ");
exit(EXIT_FAILURE);
}
fixture.addFile("a");
fixture.addFile("b");
@ -356,14 +374,20 @@ TEST(DirectoryWatcherTest, ModifyFile) {
{{EventKind::Modified, "a"}},
{{EventKind::Modified, "a"}}};
auto DW = DirectoryWatcher::create(
fixture.TestWatchedDir,
[&TestConsumer](llvm::ArrayRef<DirectoryWatcher::Event> Events,
bool IsInitial) {
TestConsumer.consume(Events, IsInitial);
},
/*waitForInitialSync=*/true);
if (!DW) return;
llvm::Expected<std::unique_ptr<DirectoryWatcher>> DW =
DirectoryWatcher::create(
fixture.TestWatchedDir,
[&TestConsumer](llvm::ArrayRef<DirectoryWatcher::Event> Events,
bool IsInitial) {
TestConsumer.consume(Events, IsInitial);
},
/*waitForInitialSync=*/true);
if (!DW) {
logAllUnhandledErrors(
DW.takeError(), llvm::errs(),
"DirectoryWatcherTest Failure on DirectoryWatcher::create(): ");
exit(EXIT_FAILURE);
}
// modify the file
{
@ -387,14 +411,20 @@ TEST(DirectoryWatcherTest, DeleteFile) {
{{EventKind::Removed, "a"}},
{{EventKind::Modified, "a"}, {EventKind::Removed, "a"}}};
auto DW = DirectoryWatcher::create(
fixture.TestWatchedDir,
[&TestConsumer](llvm::ArrayRef<DirectoryWatcher::Event> Events,
bool IsInitial) {
TestConsumer.consume(Events, IsInitial);
},
/*waitForInitialSync=*/true);
if (!DW) return;
llvm::Expected<std::unique_ptr<DirectoryWatcher>> DW =
DirectoryWatcher::create(
fixture.TestWatchedDir,
[&TestConsumer](llvm::ArrayRef<DirectoryWatcher::Event> Events,
bool IsInitial) {
TestConsumer.consume(Events, IsInitial);
},
/*waitForInitialSync=*/true);
if (!DW) {
logAllUnhandledErrors(
DW.takeError(), llvm::errs(),
"DirectoryWatcherTest Failure on DirectoryWatcher::create(): ");
exit(EXIT_FAILURE);
}
fixture.deleteFile("a");
@ -409,14 +439,20 @@ TEST(DirectoryWatcherTest, DeleteWatchedDir) {
{{EventKind::WatchedDirRemoved, ""},
{EventKind::WatcherGotInvalidated, ""}}};
auto DW = DirectoryWatcher::create(
fixture.TestWatchedDir,
[&TestConsumer](llvm::ArrayRef<DirectoryWatcher::Event> Events,
bool IsInitial) {
TestConsumer.consume(Events, IsInitial);
},
/*waitForInitialSync=*/true);
if (!DW) return;
llvm::Expected<std::unique_ptr<DirectoryWatcher>> DW =
DirectoryWatcher::create(
fixture.TestWatchedDir,
[&TestConsumer](llvm::ArrayRef<DirectoryWatcher::Event> Events,
bool IsInitial) {
TestConsumer.consume(Events, IsInitial);
},
/*waitForInitialSync=*/true);
if (!DW) {
logAllUnhandledErrors(
DW.takeError(), llvm::errs(),
"DirectoryWatcherTest Failure on DirectoryWatcher::create(): ");
exit(EXIT_FAILURE);
}
remove_directories(fixture.TestWatchedDir);
@ -430,15 +466,21 @@ TEST(DirectoryWatcherTest, InvalidatedWatcher) {
{}, {{EventKind::WatcherGotInvalidated, ""}}};
{
auto DW = DirectoryWatcher::create(
fixture.TestWatchedDir,
[&TestConsumer](llvm::ArrayRef<DirectoryWatcher::Event> Events,
bool IsInitial) {
TestConsumer.consume(Events, IsInitial);
},
/*waitForInitialSync=*/true);
if (!DW) return;
llvm::Expected<std::unique_ptr<DirectoryWatcher>> DW =
DirectoryWatcher::create(
fixture.TestWatchedDir,
[&TestConsumer](llvm::ArrayRef<DirectoryWatcher::Event> Events,
bool IsInitial) {
TestConsumer.consume(Events, IsInitial);
},
/*waitForInitialSync=*/true);
if (!DW) {
logAllUnhandledErrors(
DW.takeError(), llvm::errs(),
"DirectoryWatcherTest Failure on DirectoryWatcher::create(): ");
exit(EXIT_FAILURE);
}
} // DW is destructed here.
checkEventualResultWithTimeout(TestConsumer);
}
}