//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
// REQUIRES: can-create-symlinks
// UNSUPPORTED: c++03, c++11, c++14
// The string reported on errors changed, which makes those tests fail when run
// against a built library that doesn't contain 0aa637b2037d.
// XFAIL: using-built-library-before-llvm-13
// Starting in Android N (API 24), SELinux policy prevents the shell user from
// creating a hard link.
// XFAIL: LIBCXX-ANDROID-FIXME && !android-device-api={{21|22|23}}
// <filesystem>
// class directory_entry
// uintmax_t hard_link_count() const;
// uintmax_t hard_link_count(error_code const&) const noexcept;
#include <filesystem>
#include <type_traits>
#include <cassert>
#include "assert_macros.h"
#include "filesystem_test_helper.h"
#include "test_macros.h"
namespace fs = std::filesystem;
static void signatures() {
using namespace fs;
{
const directory_entry e = {};
std::error_code ec;
static_assert(std::is_same<decltype(e.hard_link_count()), std::uintmax_t>::value, "");
static_assert(std::is_same<decltype(e.hard_link_count(ec)), std::uintmax_t>::value,
"");
static_assert(noexcept(e.hard_link_count()) == false, "");
static_assert(noexcept(e.hard_link_count(ec)) == true, "");
}
}
static void basic() {
using namespace fs;
scoped_test_env env;
const path file = env.create_file("file", 42);
const path dir = env.create_dir("dir");
const path sym = env.create_symlink("file", "sym");
{
directory_entry ent(file);
std::uintmax_t expect = hard_link_count(ent);
// Remove the file to show that the results were already in the cache.
LIBCPP_ONLY(remove(file));
std::error_code ec = GetTestEC();
assert(ent.hard_link_count(ec) == expect);
assert(!ec);
}
{
directory_entry ent(dir);
std::uintmax_t expect = hard_link_count(ent);
LIBCPP_ONLY(remove(dir));
std::error_code ec = GetTestEC();
assert(ent.hard_link_count(ec) == expect);
assert(!ec);
}
env.create_file("file", 99);
env.create_hardlink("file", "hl");
{
directory_entry ent(sym);
std::error_code ec = GetTestEC();
assert(ent.hard_link_count(ec) == 2);
assert(!ec);
}
}
static void not_regular_file() {
using namespace fs;
scoped_test_env env;
const path dir = env.create_dir("dir");
const path dir2 = env.create_dir("dir/dir2");
const perms old_perms = status(dir).permissions();
auto test_path = [=](const path &p) {
std::error_code dummy_ec = GetTestEC();
directory_entry ent(p, dummy_ec);
assert(!dummy_ec);
std::uintmax_t expect = hard_link_count(p);
LIBCPP_ONLY(permissions(dir, perms::none));
std::error_code ec = GetTestEC();
assert(ent.hard_link_count(ec) == expect);
assert(!ec);
TEST_DOES_NOT_THROW(ent.hard_link_count());
permissions(dir, old_perms);
};
test_path(dir2);
#ifndef _WIN32
const path fifo = env.create_fifo("dir/fifo");
const path sym_to_fifo = env.create_symlink("dir/fifo", "dir/sym");
test_path(fifo);
test_path(sym_to_fifo);
#endif
}
static void error_reporting() {
using namespace fs;
static_test_env static_env;
scoped_test_env env;
const path dir = env.create_dir("dir");
const path file = env.create_file("dir/file", 42);
const path file_out_of_dir = env.create_file("file2", 101);
const path sym_out_of_dir = env.create_symlink("dir/file", "sym");
const path sym_in_dir = env.create_symlink("file2", "dir/sym2");
#ifndef TEST_WIN_NO_FILESYSTEM_PERMS_NONE
const perms old_perms = status(dir).permissions();
#endif
// test a file which doesn't exist
{
directory_entry ent;
std::error_code ec = GetTestEC();
ent.assign(static_env.DNE, ec);
assert(ec);
assert(ent.path() == static_env.DNE);
assert(ErrorIs(ec, std::errc::no_such_file_or_directory));
ec = GetTestEC();
assert(ent.hard_link_count(ec) == std::uintmax_t(-1));
assert(ErrorIs(ec, std::errc::no_such_file_or_directory));
ExceptionChecker Checker(static_env.DNE,
std::errc::no_such_file_or_directory,
"directory_entry::hard_link_count");
TEST_VALIDATE_EXCEPTION(filesystem_error, Checker, ent.hard_link_count());
}
// test a dead symlink
{
directory_entry ent;
std::error_code ec = GetTestEC();
std::uintmax_t expect_bad = hard_link_count(static_env.BadSymlink, ec);
assert(expect_bad == std::uintmax_t(-1));
assert(ErrorIs(ec, std::errc::no_such_file_or_directory));
ec = GetTestEC();
ent.assign(static_env.BadSymlink, ec);
assert(ent.path() == static_env.BadSymlink);
assert(!ec);
ec = GetTestEC();
assert(ent.hard_link_count(ec) == expect_bad);
assert(ErrorIs(ec, std::errc::no_such_file_or_directory));
ExceptionChecker Checker(static_env.BadSymlink,
std::errc::no_such_file_or_directory,
"directory_entry::hard_link_count");
TEST_VALIDATE_EXCEPTION(filesystem_error, Checker, ent.hard_link_count());
}
// Windows doesn't support setting perms::none to trigger failures
// reading directories.
#ifndef TEST_WIN_NO_FILESYSTEM_PERMS_NONE
// test a file w/o appropriate permissions.
{
directory_entry ent;
std::uintmax_t expect_good = hard_link_count(file);
permissions(dir, perms::none);
std::error_code ec = GetTestEC();
ent.assign(file, ec);
assert(ent.path() == file);
assert(ErrorIs(ec, std::errc::permission_denied));
ec = GetTestEC();
assert(ent.hard_link_count(ec) == std::uintmax_t(-1));
assert(ErrorIs(ec, std::errc::permission_denied));
ExceptionChecker Checker(file, std::errc::permission_denied,
"hard_link_count");
TEST_VALIDATE_EXCEPTION(filesystem_error, Checker, ent.hard_link_count());
permissions(dir, old_perms);
ec = GetTestEC();
assert(ent.hard_link_count(ec) == expect_good);
assert(!ec);
TEST_DOES_NOT_THROW(ent.hard_link_count());
}
permissions(dir, old_perms);
// test a symlink w/o appropriate permissions.
{
directory_entry ent;
std::uintmax_t expect_good = hard_link_count(sym_in_dir);
permissions(dir, perms::none);
std::error_code ec = GetTestEC();
ent.assign(sym_in_dir, ec);
assert(ent.path() == sym_in_dir);
assert(ErrorIs(ec, std::errc::permission_denied));
ec = GetTestEC();
assert(ent.hard_link_count(ec) == std::uintmax_t(-1));
assert(ErrorIs(ec, std::errc::permission_denied));
ExceptionChecker Checker(sym_in_dir, std::errc::permission_denied,
"hard_link_count");
TEST_VALIDATE_EXCEPTION(filesystem_error, Checker, ent.hard_link_count());
permissions(dir, old_perms);
ec = GetTestEC();
assert(ent.hard_link_count(ec) == expect_good);
assert(!ec);
TEST_DOES_NOT_THROW(ent.hard_link_count());
}
permissions(dir, old_perms);
// test a symlink to a file w/o appropriate permissions
{
directory_entry ent;
std::uintmax_t expect_good = hard_link_count(sym_out_of_dir);
permissions(dir, perms::none);
std::error_code ec = GetTestEC();
ent.assign(sym_out_of_dir, ec);
assert(ent.path() == sym_out_of_dir);
assert(!ec);
ec = GetTestEC();
assert(ent.hard_link_count(ec) == std::uintmax_t(-1));
assert(ErrorIs(ec, std::errc::permission_denied));
ExceptionChecker Checker(sym_out_of_dir, std::errc::permission_denied,
"hard_link_count");
TEST_VALIDATE_EXCEPTION(filesystem_error, Checker, ent.hard_link_count());
permissions(dir, old_perms);
ec = GetTestEC();
assert(ent.hard_link_count(ec) == expect_good);
assert(!ec);
TEST_DOES_NOT_THROW(ent.hard_link_count());
}
#endif
}
int main(int, char**) {
signatures();
basic();
not_regular_file();
error_reporting();
return 0;
}