Files
clang-p2996/flang/unittests/Runtime/AccessTest.cpp
Tom Eccles 668a58b892 [flang][runtime] Add ACCESS library procedure (#88517)
Re-land https://github.com/llvm/llvm-project/pull/88395

Two build-bots were broken by the old version:
 - https://lab.llvm.org/buildbot/#/builders/285/builds/245
 - https://lab.llvm.org/buildbot/#/builders/21/builds/96988

The problem in both cases was that the compiler did not support
`std::filesystem` (which I use in the unit test).

I have removed the dependency upon std::filesystem because there isn't
an easy way to add the right linker options so that this is supported
correctly in all build environments [1]

[1] https://gitlab.kitware.com/cmake/cmake/-/issues/17834

---

This is a GNU extension:
https://gcc.gnu.org/onlinedocs/gfortran/ACCESS.html

Used in SALMON:
https://salmon-tddft.jp/download.html

Unfortunately the intrinsic takes a file path to operate on so there
isn't an easy way to make the test robust. The unit test expects to be
able to create, set read write and execute permissions, and delete files
called
std::filesystem::temp_directory_path() / <test_name>.<pid>

The test will fail if a file already exists with that name.

I have not implemented the intrinsic on Windows because this is wrapping
a POSIX system call and Windows doesn't support all of the permission
bits tested by the intrinsic. I don't have a Windows machine easily
available to check if Gfortran implements this intrinsic on Windows.
2024-04-16 10:25:26 +01:00

423 lines
9.4 KiB
C++

//===-- flang/unittests/Runtime/AccessTest.cpp ----------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
// TODO: ACCESS is not yet implemented on Windows
#ifndef _WIN32
#include "CrashHandlerFixture.h"
#include "gtest/gtest.h"
#include "flang/Runtime/extensions.h"
#include "llvm/ADT/Twine.h"
#include <fcntl.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>
namespace {
struct AccessTests : public CrashHandlerFixture {};
struct AccessType {
bool read{false};
bool write{false};
bool execute{false};
bool exists{false};
};
} // namespace
static std::string addPIDSuffix(const char *name) {
std::stringstream ss;
ss << name;
ss << '.';
ss << getpid();
return ss.str();
}
static bool exists(const std::string &path) {
return access(path.c_str(), F_OK) == 0;
}
// Implementation of std::filesystem::temp_directory_path adapted from libcxx
// See llvm-project/libcxx/src/filesystem/operations.cpp
// Using std::filesystem is inconvenient because the required flags are not
// consistent accross compilers and CMake doesn't have built in support to
// determine the correct flags.
static const char *temp_directory_path() {
// TODO: Windows
const char *env_paths[] = {"TMPDIR", "TMP", "TEMP", "TEMPDIR"};
const char *ret = nullptr;
for (auto &ep : env_paths) {
if ((ret = getenv(ep))) {
break;
}
}
if (ret == nullptr) {
#if defined(__ANDROID__)
ret = "/data/local/tmp";
#else
ret = "/tmp";
#endif
}
assert(exists(ret));
return ret;
}
static std::string createTemporaryFile(
const char *name, const AccessType &accessType) {
std::string path =
(llvm::Twine{temp_directory_path()} + "/" + addPIDSuffix(name)).str();
// O_CREAT | O_EXCL enforces that this file is newly created by this call.
// This feels risky. If we don't have permission to create files in the
// temporary directory or if the files already exist, the test will fail.
// But we can't use std::tmpfile() because we need a path to the file and
// to control the filesystem permissions
mode_t mode{0};
if (accessType.read) {
mode |= S_IRUSR;
}
if (accessType.write) {
mode |= S_IWUSR;
}
if (accessType.execute) {
mode |= S_IXUSR;
}
int file = open(path.c_str(), O_CREAT | O_EXCL, mode);
if (file == -1) {
return {};
}
close(file);
return path;
}
static std::int64_t callAccess(
const std::string &path, const AccessType &accessType) {
const char *cpath{path.c_str()};
std::int64_t pathlen = std::strlen(cpath);
std::string mode;
if (accessType.read) {
mode += 'r';
}
if (accessType.write) {
mode += 'w';
}
if (accessType.execute) {
mode += 'x';
}
if (accessType.exists) {
mode += ' ';
}
const char *cmode = mode.c_str();
std::int64_t modelen = std::strlen(cmode);
return FORTRAN_PROCEDURE_NAME(access)(cpath, pathlen, cmode, modelen);
}
TEST(AccessTests, TestExists) {
AccessType accessType;
accessType.exists = true;
std::string path = createTemporaryFile(__func__, accessType);
ASSERT_FALSE(path.empty());
std::int64_t res = callAccess(path, accessType);
ASSERT_EQ(unlink(path.c_str()), 0);
ASSERT_EQ(res, 0);
}
TEST(AccessTests, TestNotExists) {
std::string nonExistant{addPIDSuffix(__func__)};
ASSERT_FALSE(exists(nonExistant));
AccessType accessType;
accessType.exists = true;
std::int64_t res = callAccess(nonExistant, accessType);
ASSERT_NE(res, 0);
}
TEST(AccessTests, TestRead) {
AccessType accessType;
accessType.read = true;
std::string path = createTemporaryFile(__func__, accessType);
ASSERT_FALSE(path.empty());
std::int64_t res = callAccess(path, accessType);
ASSERT_EQ(unlink(path.c_str()), 0);
ASSERT_EQ(res, 0);
}
TEST(AccessTests, TestNotRead) {
AccessType accessType;
accessType.read = false;
std::string path = createTemporaryFile(__func__, accessType);
ASSERT_FALSE(path.empty());
accessType.read = true;
std::int64_t res = callAccess(path, accessType);
ASSERT_EQ(unlink(path.c_str()), 0);
ASSERT_NE(res, 0);
}
TEST(AccessTests, TestWrite) {
AccessType accessType;
accessType.write = true;
std::string path = createTemporaryFile(__func__, accessType);
ASSERT_FALSE(path.empty());
std::int64_t res = callAccess(path, accessType);
ASSERT_EQ(unlink(path.c_str()), 0);
ASSERT_EQ(res, 0);
}
TEST(AccessTests, TestNotWrite) {
AccessType accessType;
accessType.write = false;
std::string path = createTemporaryFile(__func__, accessType);
ASSERT_FALSE(path.empty());
accessType.write = true;
std::int64_t res = callAccess(path, accessType);
ASSERT_EQ(unlink(path.c_str()), 0);
ASSERT_NE(res, 0);
}
TEST(AccessTests, TestReadWrite) {
AccessType accessType;
accessType.read = true;
accessType.write = true;
std::string path = createTemporaryFile(__func__, accessType);
ASSERT_FALSE(path.empty());
std::int64_t res = callAccess(path, accessType);
ASSERT_EQ(unlink(path.c_str()), 0);
ASSERT_EQ(res, 0);
}
TEST(AccessTests, TestNotReadWrite0) {
AccessType accessType;
accessType.read = false;
accessType.write = false;
std::string path = createTemporaryFile(__func__, accessType);
ASSERT_FALSE(path.empty());
accessType.read = true;
accessType.write = true;
std::int64_t res = callAccess(path, accessType);
ASSERT_EQ(unlink(path.c_str()), 0);
ASSERT_NE(res, 0);
}
TEST(AccessTests, TestNotReadWrite1) {
AccessType accessType;
accessType.read = true;
accessType.write = false;
std::string path = createTemporaryFile(__func__, accessType);
ASSERT_FALSE(path.empty());
accessType.read = true;
accessType.write = true;
std::int64_t res = callAccess(path, accessType);
ASSERT_EQ(unlink(path.c_str()), 0);
ASSERT_NE(res, 0);
}
TEST(AccessTests, TestNotReadWrite2) {
AccessType accessType;
accessType.read = false;
accessType.write = true;
std::string path = createTemporaryFile(__func__, accessType);
ASSERT_FALSE(path.empty());
accessType.read = true;
accessType.write = true;
std::int64_t res = callAccess(path, accessType);
ASSERT_EQ(unlink(path.c_str()), 0);
ASSERT_NE(res, 0);
}
TEST(AccessTests, TestExecute) {
AccessType accessType;
accessType.execute = true;
std::string path = createTemporaryFile(__func__, accessType);
ASSERT_FALSE(path.empty());
std::int64_t res = callAccess(path, accessType);
ASSERT_EQ(unlink(path.c_str()), 0);
ASSERT_EQ(res, 0);
}
TEST(AccessTests, TestNotExecute) {
AccessType accessType;
accessType.execute = false;
std::string path = createTemporaryFile(__func__, accessType);
ASSERT_FALSE(path.empty());
accessType.execute = true;
std::int64_t res = callAccess(path, accessType);
ASSERT_EQ(unlink(path.c_str()), 0);
ASSERT_NE(res, 0);
}
TEST(AccessTests, TestRWX) {
AccessType accessType;
accessType.read = true;
accessType.write = true;
accessType.execute = true;
std::string path = createTemporaryFile(__func__, accessType);
ASSERT_FALSE(path.empty());
std::int64_t res = callAccess(path, accessType);
ASSERT_EQ(unlink(path.c_str()), 0);
ASSERT_EQ(res, 0);
}
TEST(AccessTests, TestNotRWX0) {
AccessType accessType;
accessType.read = false;
accessType.write = false;
accessType.execute = false;
std::string path = createTemporaryFile(__func__, accessType);
ASSERT_FALSE(path.empty());
accessType.read = true;
accessType.write = true;
accessType.execute = true;
std::int64_t res = callAccess(path, accessType);
ASSERT_EQ(unlink(path.c_str()), 0);
ASSERT_NE(res, 0);
}
TEST(AccessTests, TestNotRWX1) {
AccessType accessType;
accessType.read = true;
accessType.write = false;
accessType.execute = false;
std::string path = createTemporaryFile(__func__, accessType);
ASSERT_FALSE(path.empty());
accessType.read = true;
accessType.write = true;
accessType.execute = true;
std::int64_t res = callAccess(path, accessType);
ASSERT_EQ(unlink(path.c_str()), 0);
ASSERT_NE(res, 0);
}
TEST(AccessTests, TestNotRWX2) {
AccessType accessType;
accessType.read = true;
accessType.write = true;
accessType.execute = false;
std::string path = createTemporaryFile(__func__, accessType);
ASSERT_FALSE(path.empty());
accessType.read = true;
accessType.write = true;
accessType.execute = true;
std::int64_t res = callAccess(path, accessType);
ASSERT_EQ(unlink(path.c_str()), 0);
ASSERT_NE(res, 0);
}
TEST(AccessTests, TestNotRWX3) {
AccessType accessType;
accessType.read = true;
accessType.write = false;
accessType.execute = true;
std::string path = createTemporaryFile(__func__, accessType);
ASSERT_FALSE(path.empty());
accessType.read = true;
accessType.write = true;
accessType.execute = true;
std::int64_t res = callAccess(path, accessType);
ASSERT_EQ(unlink(path.c_str()), 0);
ASSERT_NE(res, 0);
}
TEST(AccessTests, TestNotRWX4) {
AccessType accessType;
accessType.read = false;
accessType.write = true;
accessType.execute = true;
std::string path = createTemporaryFile(__func__, accessType);
ASSERT_FALSE(path.empty());
accessType.read = true;
accessType.write = true;
accessType.execute = true;
std::int64_t res = callAccess(path, accessType);
ASSERT_EQ(unlink(path.c_str()), 0);
ASSERT_NE(res, 0);
}
#endif // !_WIN32