1
0
mirror of https://github.com/falk-werner/webfuse synced 2024-10-27 20:34:10 +00:00

introduce clang tidy

This commit is contained in:
Falk Werner 2023-01-06 16:50:32 +01:00
parent b0376d4a2d
commit 9555729fe9
13 changed files with 181 additions and 164 deletions

View File

@ -18,7 +18,7 @@ jobs:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- name: Install APT dependencies - name: Install APT dependencies
run: sudo apt install libfuse3-dev libwebsockets-dev libgtest-dev libgmock-dev valgrind run: sudo apt install libfuse3-dev libwebsockets-dev libgtest-dev libgmock-dev clang-tidy valgrind
- name: Configure CMake - name: Configure CMake
run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}

View File

@ -1,6 +1,9 @@
cmake_minimum_required(VERSION 3.10) cmake_minimum_required(VERSION 3.10)
project(webfuse VERSION 2.0.0) project(webfuse VERSION 2.0.0)
option(WITHOUT_TEST "Disables unit and integration tests" OFF)
option(WITHOUT_CLANG_TIDY "Disables clang tidy" OFF)
set (CMAKE_CXX_STANDARD 17) set (CMAKE_CXX_STANDARD 17)
find_package(PkgConfig REQUIRED) find_package(PkgConfig REQUIRED)
@ -33,6 +36,13 @@ add_library(webfuse_static STATIC
target_include_directories(webfuse_static PUBLIC src) target_include_directories(webfuse_static PUBLIC src)
target_link_libraries(webfuse_static PUBLIC PkgConfig::FUSE PkgConfig::LWS) target_link_libraries(webfuse_static PUBLIC PkgConfig::FUSE PkgConfig::LWS)
if(NOT(WITHOUT_CLANG_TIDY))
set_property(
TARGET webfuse_static
PROPERTY CXX_CLANG_TIDY clang-tidy -checks=-*,readability-*,-readability-identifier-length -warnings-as-errors=*)
endif()
add_executable(webfuse add_executable(webfuse
src/main.cpp) src/main.cpp)

View File

@ -10,10 +10,8 @@ int empty_filesystem::access(std::string const & path, int mode)
{ {
return 0; return 0;
} }
else
{
return -ENOENT; return -ENOENT;
}
} }
int empty_filesystem::getattr(std::string const & path, struct stat * attr) int empty_filesystem::getattr(std::string const & path, struct stat * attr)
@ -22,13 +20,11 @@ int empty_filesystem::getattr(std::string const & path, struct stat * attr)
{ {
attr->st_ino = 1; attr->st_ino = 1;
attr->st_nlink = 1; attr->st_nlink = 1;
attr->st_mode = S_IFDIR | 0555; attr->st_mode = S_IFDIR | 0555; // NOLINT(readability-magic-numbers)
return 0; return 0;
} }
else
{
return -ENOENT; return -ENOENT;
}
} }
int empty_filesystem::readlink(std::string const & path, std::string & out) int empty_filesystem::readlink(std::string const & path, std::string & out)
@ -121,10 +117,8 @@ int empty_filesystem::readdir(std::string const & path, std::vector<std::string>
{ {
return 0; return 0;
} }
else
{
return -ENOENT; return -ENOENT;
}
} }
int empty_filesystem::rmdir(std::string const & path) int empty_filesystem::rmdir(std::string const & path)

View File

@ -38,7 +38,7 @@ public:
int readdir(std::string const & path, std::vector<std::string> & entries) override; int readdir(std::string const & path, std::vector<std::string> & entries) override;
int rmdir(std::string const & path) override; int rmdir(std::string const & path) override;
int statfs(std::string const & path, struct statvfs * statistivs) override; int statfs(std::string const & path, struct statvfs * statistics) override;
}; };
} }

View File

@ -18,7 +18,7 @@ filemode::operator uint32_t() const
filemode filemode::from_mode(mode_t value) filemode filemode::from_mode(mode_t value)
{ {
uint32_t result = value & 07777; uint32_t result = value & 07777; // NOLINT(readability-magic-numbers)
if (S_ISREG(value) ) { result |= filemode::reg; } if (S_ISREG(value) ) { result |= filemode::reg; }
if (S_ISDIR(value) ) { result |= filemode::dir; } if (S_ISDIR(value) ) { result |= filemode::dir; }
@ -33,7 +33,7 @@ filemode filemode::from_mode(mode_t value)
mode_t filemode::to_mode() const mode_t filemode::to_mode() const
{ {
mode_t result = value_ & 07777; mode_t result = value_ & 07777; // NOLINT(readability-magic-numbers)
if (is_reg() ) { result |= S_IFREG; } if (is_reg() ) { result |= S_IFREG; }
if (is_dir() ) { result |= S_IFDIR; } if (is_dir() ) { result |= S_IFDIR; }

View File

@ -21,8 +21,7 @@ status status::from_fusestatus(int value)
{ {
return static_cast<int32_t>(value); return static_cast<int32_t>(value);
} }
else
{
switch(value) switch(value)
{ {
case -E2BIG: return status::bad_e2big; case -E2BIG: return status::bad_e2big;
@ -63,7 +62,6 @@ status status::from_fusestatus(int value)
case -EXDEV: return status::bad_exdev; case -EXDEV: return status::bad_exdev;
default: return static_cast<int32_t>(value); default: return static_cast<int32_t>(value);
} }
}
} }
int status::to_fusestatus() const int status::to_fusestatus() const
@ -72,8 +70,7 @@ int status::to_fusestatus() const
{ {
return static_cast<int>(value_); return static_cast<int>(value_);
} }
else
{
switch(value_) switch(value_)
{ {
case status::bad_e2big: return -E2BIG; case status::bad_e2big: return -E2BIG;
@ -114,7 +111,6 @@ int status::to_fusestatus() const
case status::bad_exdev: return -EXDEV; case status::bad_exdev: return -EXDEV;
default: return static_cast<int32_t>(value_); default: return static_cast<int32_t>(value_);
} }
}
} }
bool status::is_good() const bool status::is_good() const

View File

@ -106,7 +106,7 @@ static int fs_truncate(char const * path, off_t size, fuse_file_info * info)
static int fs_fsync(char const * path, int isdatasync, fuse_file_info * info) static int fs_fsync(char const * path, int isdatasync, fuse_file_info * info)
{ {
auto * const fs = fs_get_filesystem(); auto * const fs = fs_get_filesystem();
bool const is_datasync = (is_datasync != 0); bool const is_datasync = (isdatasync != 0);
auto const handle = fs_get_handle(info); auto const handle = fs_get_handle(info);
return fs->fsync(path, is_datasync, handle); return fs->fsync(path, is_datasync, handle);

View File

@ -6,7 +6,7 @@
namespace webfuse namespace webfuse
{ {
int app::run(int argc, char * argv[]) int app::run(int argc, char * argv[]) // NOLINT(readability-convert-member-functions-to-static)
{ {
ws_config config; ws_config config;
ws_server server(config); ws_server server(config);

View File

@ -48,7 +48,7 @@ extern "C" int webfuse_client_callback(lws * wsi, lws_callback_reasons reason, v
{ {
auto * fragment = reinterpret_cast<char*>(in); auto * fragment = reinterpret_cast<char*>(in);
context->current_message.append(fragment, length); context->current_message.append(fragment, length);
if (lws_is_final_fragment(wsi)) if (0 != lws_is_final_fragment(wsi))
{ {
try try
{ {
@ -137,7 +137,7 @@ public:
lws_client_connect_info info; lws_client_connect_info info;
memset(reinterpret_cast<void*>(&info), 0, sizeof(lws_client_connect_info)); memset(reinterpret_cast<void*>(&info), 0, sizeof(lws_client_connect_info));
info.context = context; info.context = context;
info.port = 8081; info.port = 8081; //NOLINT(readability-magic-numbers)
info.address = "localhost"; info.address = "localhost";
info.host = "localhost"; info.host = "localhost";
info.path = "/"; info.path = "/";

View File

@ -1,10 +1,17 @@
#include "webfuse/ws/config.hpp" #include "webfuse/ws/config.hpp"
namespace
{
constexpr int const default_port = 8081;
}
namespace webfuse namespace webfuse
{ {
ws_config::ws_config() ws_config::ws_config()
: port(8081) : port(default_port)
{ {
} }

View File

@ -98,14 +98,13 @@ uint8_t messagereader::read_u8()
pos++; pos++;
return value; return value;
} }
else
{
throw std::runtime_error("out of bounds"); throw std::runtime_error("out of bounds");
}
} }
uint32_t messagereader::read_u32() uint32_t messagereader::read_u32()
{ {
// NOLINTBEGIN(readability-magic-numbers)
if ((pos + 3) < data.size()) if ((pos + 3) < data.size())
{ {
uint32_t value = uint32_t value =
@ -116,14 +115,14 @@ uint32_t messagereader::read_u32()
pos += 4; pos += 4;
return value; return value;
} }
else // NOLINTEND(readability-magic-numbers)
{
throw std::runtime_error("out of bounds"); throw std::runtime_error("out of bounds");
}
} }
uint64_t messagereader::read_u64() uint64_t messagereader::read_u64()
{ {
// NOLINTBEGIN(readability-magic-numbers)
if ((pos + 7) < data.size()) if ((pos + 7) < data.size())
{ {
uint32_t value = uint32_t value =
@ -138,10 +137,9 @@ uint64_t messagereader::read_u64()
pos += 8; pos += 8;
return value; return value;
} }
else // NOLINTEND(readability-magic-numbers)
{
throw std::runtime_error("out of bounds"); throw std::runtime_error("out of bounds");
}
} }
@ -165,10 +163,8 @@ std::string messagereader::read_bytes()
pos += size; pos += size;
return std::move(value); return std::move(value);
} }
else
{
throw std::runtime_error("out of bounds"); throw std::runtime_error("out of bounds");
}
} }
void messagereader::read_strings(std::vector<std::string> &entries) void messagereader::read_strings(std::vector<std::string> &entries)

View File

@ -47,10 +47,13 @@ messagewriter& messagewriter::operator=(messagewriter && other)
void messagewriter::set_id(uint32_t value) void messagewriter::set_id(uint32_t value)
{ {
id = value; id = value;
// NOLINTBEGIN(readability-magic-numbers)
data[LWS_PRE ] = (id >> 24) & 0xff; data[LWS_PRE ] = (id >> 24) & 0xff;
data[LWS_PRE + 1] = (id >> 16) & 0xff; data[LWS_PRE + 1] = (id >> 16) & 0xff;
data[LWS_PRE + 2] = (id >> 8) & 0xff; data[LWS_PRE + 2] = (id >> 8) & 0xff;
data[LWS_PRE + 3] = id & 0xff; data[LWS_PRE + 3] = id & 0xff;
// NOLINTEND(readability-magic-numbers)
} }
uint32_t messagewriter::get_id() const uint32_t messagewriter::get_id() const
@ -81,16 +84,21 @@ void messagewriter::write_i32(int32_t value)
void messagewriter::write_u32(uint32_t value) void messagewriter::write_u32(uint32_t value)
{ {
auto const offset = data.size(); auto const offset = data.size();
// NOLINTBEGIN(readability-magic-numbers)
data.resize(offset + 4); data.resize(offset + 4);
data[offset ] = (value >> 24) & 0xff; data[offset ] = (value >> 24) & 0xff;
data[offset + 1] = (value >> 16) & 0xff; data[offset + 1] = (value >> 16) & 0xff;
data[offset + 2] = (value >> 8) & 0xff; data[offset + 2] = (value >> 8) & 0xff;
data[offset + 3] = value & 0xff; data[offset + 3] = value & 0xff;
// NOLINTEND(readability-magic-numbers)
} }
void messagewriter::write_u64(uint64_t value) void messagewriter::write_u64(uint64_t value)
{ {
auto const offset = data.size(); auto const offset = data.size();
// NOLINTBEGIN(readability-magic-numbers)
data.resize(offset + 8); data.resize(offset + 8);
data[offset ] = (value >> 56) & 0xff; data[offset ] = (value >> 56) & 0xff;
data[offset + 1] = (value >> 48) & 0xff; data[offset + 1] = (value >> 48) & 0xff;
@ -100,6 +108,7 @@ void messagewriter::write_u64(uint64_t value)
data[offset + 5] = (value >> 16) & 0xff; data[offset + 5] = (value >> 16) & 0xff;
data[offset + 6] = (value >> 8) & 0xff; data[offset + 6] = (value >> 8) & 0xff;
data[offset + 7] = value & 0xff; data[offset + 7] = value & 0xff;
// NOLINTEND(readability-magic-numbers)
} }
void messagewriter::write_str(std::string const &value) void messagewriter::write_str(std::string const &value)
@ -116,7 +125,7 @@ void messagewriter::write_data(char const * buffer, size_t size)
{ {
auto const offset = data.size(); auto const offset = data.size();
data.resize(offset + effective_size); data.resize(offset + effective_size);
void * to = reinterpret_cast<void*>(&data.data()[offset]); void * to = reinterpret_cast<void*>(&data[offset]);
void const * from = reinterpret_cast<void const *>(buffer); void const * from = reinterpret_cast<void const *>(buffer);
memcpy(to, from, effective_size); memcpy(to, from, effective_size);
} }
@ -205,7 +214,7 @@ void messagewriter::write_statistics(struct statvfs const * statistics)
unsigned char * messagewriter::get_data(size_t &size) unsigned char * messagewriter::get_data(size_t &size)
{ {
size = data.size() - LWS_PRE; size = data.size() - LWS_PRE;
void * result = reinterpret_cast<void *>(&data.data()[LWS_PRE]); void * result = reinterpret_cast<void *>(&data[LWS_PRE]);
return reinterpret_cast<unsigned char *>(result); return reinterpret_cast<unsigned char *>(result);
} }

View File

@ -21,6 +21,8 @@
namespace namespace
{ {
constexpr int64_t const timeout_secs = 10;
struct user_data struct user_data
{ {
struct lws * connection = nullptr; struct lws * connection = nullptr;
@ -32,6 +34,45 @@ struct user_data
std::unordered_map<uint32_t, std::promise<webfuse::messagereader>> pending_responses; std::unordered_map<uint32_t, std::promise<webfuse::messagereader>> pending_responses;
}; };
void do_receive(void * in, int len, lws* wsi, user_data * data)
{
auto * fragment = reinterpret_cast<char*>(in);
data->current_message.append(fragment, len);
if (0 != lws_is_final_fragment(wsi))
{
try
{
webfuse::messagereader reader(data->current_message);
uint32_t id = reader.read_u32();
uint8_t message_type = reader.read_u8();
std::lock_guard<std::mutex> lock(data->mut);
auto it = data->pending_responses.find(id);
if (it != data->pending_responses.end())
{
it->second.set_value(std::move(reader));
data->pending_responses.erase(it);
}
else
{
// ToDo: log request not found
std::cout << "warning: request not found: id=" << id << std::endl;
for(auto const & entry: data->pending_responses)
{
std::cout << "\t" << entry.first << std::endl;
}
}
}
catch(...)
{
// ToDo: log invalid message
std::cout << "warning: invalid message" << std::endl;
}
}
}
} }
extern "C" extern "C"
@ -66,43 +107,7 @@ static int ws_server_callback(struct lws *wsi, enum lws_callback_reasons reason,
} }
break; break;
case LWS_CALLBACK_RECEIVE: case LWS_CALLBACK_RECEIVE:
{ do_receive(in, len, wsi, data);
auto * fragment = reinterpret_cast<char*>(in);
data->current_message.append(fragment, len);
if (lws_is_final_fragment(wsi))
{
try
{
webfuse::messagereader reader(data->current_message);
uint32_t id = reader.read_u32();
uint8_t message_type = reader.read_u8();
std::lock_guard lock(data->mut);
auto it = data->pending_responses.find(id);
if (it != data->pending_responses.end())
{
it->second.set_value(std::move(reader));
data->pending_responses.erase(it);
}
else
{
// ToDo: log request not found
std::cout << "warning: request not found: id=" << id << std::endl;
for(auto const & entry: data->pending_responses)
{
std::cout << "\t" << entry.first << std::endl;
}
}
}
catch(...)
{
// ToDo: log invalid message
std::cout << "warning: invalid message" << std::endl;
}
}
}
break; break;
case LWS_CALLBACK_SERVER_WRITEABLE: case LWS_CALLBACK_SERVER_WRITEABLE:
{ {
@ -111,7 +116,7 @@ static int ws_server_callback(struct lws *wsi, enum lws_callback_reasons reason,
bool has_more = false; bool has_more = false;
{ {
std::lock_guard lock(data->mut); std::lock_guard<std::mutex> lock(data->mut);
has_msg = !(data->requests.empty()); has_msg = !(data->requests.empty());
if (has_msg) if (has_msg)
{ {
@ -181,7 +186,7 @@ public:
while (!shutdown_requested) while (!shutdown_requested)
{ {
{ {
std::lock_guard lock(data.mut); std::lock_guard<std::mutex> lock(data.mut);
if (!data.requests.empty()) if (!data.requests.empty())
{ {
if (nullptr != data.connection) if (nullptr != data.connection)
@ -264,7 +269,7 @@ messagereader ws_server::perform(messagewriter writer)
std::promise<messagereader> p; std::promise<messagereader> p;
f = p.get_future(); f = p.get_future();
std::lock_guard lock(d->data.mut); std::lock_guard<std::mutex> lock(d->data.mut);
uint32_t id = d->next_id(); uint32_t id = d->next_id();
writer.set_id(id); writer.set_id(id);
d->data.requests.emplace(std::move(writer)); d->data.requests.emplace(std::move(writer));
@ -272,7 +277,7 @@ messagereader ws_server::perform(messagewriter writer)
} }
lws_cancel_service(d->context); lws_cancel_service(d->context);
if(std::future_status::timeout == f.wait_for(std::chrono::seconds(10))) if(std::future_status::timeout == f.wait_for(std::chrono::seconds(timeout_secs)))
{ {
throw std::runtime_error("timeout"); throw std::runtime_error("timeout");
} }