mergerfs/src/branches.cpp
Antonio S. Musumeci da3cb9ae56 branches: re-link default_minfreespace pointer on copy/move; atomically publish branch mode changes
Branches using the default minfreespace held a reference to their
owning Impl's _default_minfreespace. After a copy or move the
pointer still referenced the source Impl, which could become
invalid or diverge after further configuration changes. Switch to
a pointer and re-link it to the destination Impl on copy/move.

While here, convert set_branch_mode to do an atomic_store of a
newly constructed Impl rather than mutating the shared pointer
target in place. Readers holding an atomic_load snapshot are no
longer affected by a concurrent mode change.
2026-04-18 00:45:32 -04:00

524 lines
11 KiB
C++

/*
ISC License
Copyright (c) 2026, Antonio SJ Musumeci <trapexit@spawn.link>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#include "branches.hpp"
#include "ef.hpp"
#include "errno.hpp"
#include "from_string.hpp"
#include "fs_glob.hpp"
#include "fs_is_rofs.hpp"
#include "fs_realpathize.hpp"
#include "base_types.h"
#include "num.hpp"
#include "str.hpp"
#include "syslog.hpp"
#include <string>
#include <optional>
#include <fnmatch.h>
Branches::Impl::Impl(const u64 *default_minfreespace_)
: _default_minfreespace(default_minfreespace_)
{
}
Branches::Impl&
Branches::Impl::operator=(Branches::Impl &rval_)
{
using type = std::vector<Branch>;
auto this_base = dynamic_cast<type*>(this);
auto rval_base = dynamic_cast<type*>(&rval_);
*this_base = *rval_base;
// Branches using the default minfreespace hold a pointer to their
// owning Impl's _default_minfreespace. After copy/move those
// pointers still reference the source Impl, so re-link them to this
// Impl's _default_minfreespace.
for(auto &branch : *this)
{
if(std::holds_alternative<const u64*>(branch._minfreespace))
branch._minfreespace = _default_minfreespace;
}
return *this;
}
Branches::Impl&
Branches::Impl::operator=(Branches::Impl &&rval_)
{
using type = std::vector<Branch>;
auto this_base = dynamic_cast<type*>(this);
auto rval_base = dynamic_cast<type*>(&rval_);
*this_base = std::move(*rval_base);
// Branches using the default minfreespace hold a pointer to their
// owning Impl's _default_minfreespace. After copy/move those
// pointers still reference the source Impl, so re-link them to this
// Impl's _default_minfreespace.
for(auto &branch : *this)
{
if(std::holds_alternative<const u64*>(branch._minfreespace))
branch._minfreespace = _default_minfreespace;
}
return *this;
}
const
u64&
Branches::Impl::minfreespace(void) const
{
return *_default_minfreespace;
}
namespace l
{
static
void
split(const std::string_view s_,
std::string *instr_,
std::string *values_)
{
u64 offset;
offset = s_.find_first_not_of("+<>-=");
if(offset == std::string::npos)
{
*instr_ = s_.substr(0, std::min(s_.size(), (size_t)2));
return;
}
if(offset > 1)
offset = 2;
*instr_ = s_.substr(0,offset);
*values_ = s_.substr(offset);
}
static
int
parse_mode(const std::string &str_,
Branch::Mode *mode_)
{
if(str_ == "RW")
*mode_ = Branch::Mode::RW;
ef(str_ == "RO")
*mode_ = Branch::Mode::RO;
ef(str_ == "NC")
*mode_ = Branch::Mode::NC;
else
return -EINVAL;
return 0;
}
static
int
parse_minfreespace(const std::string &str_,
std::optional<u64> *minfreespace_)
{
int rv;
u64 uint64;
rv = str::from(str_,&uint64);
if(rv < 0)
return rv;
*minfreespace_ = uint64;
return 0;
}
static
int
parse_branch(const std::string &str_,
std::string *glob_,
Branch::Mode *mode_,
std::optional<u64> *minfreespace_)
{
int rv;
std::string options;
std::vector<std::string> v;
v = str::rsplit1(str_,'=');
switch(v.size())
{
case 1:
*glob_ = v[0];
*mode_ = Branch::Mode::RW;
break;
case 2:
*glob_ = v[0];
options = v[1];
v = str::split(options,',');
switch(v.size())
{
case 2:
rv = l::parse_minfreespace(v[1],minfreespace_);
if(rv < 0)
return rv;
[[fallthrough]];
case 1:
rv = l::parse_mode(v[0],mode_);
if(rv < 0)
return rv;
break;
case 0:
return -EINVAL;
}
break;
default:
return -EINVAL;
}
return 0;
}
static
int
parse(const std::string &str_,
Branches::Impl *branches_)
{
int rv;
std::string glob;
StrVec paths;
Branch branch;
std::optional<u64> minfreespace;
branch._minfreespace = &branches_->minfreespace();
rv = l::parse_branch(str_,&glob,&branch.mode,&minfreespace);
if(rv < 0)
return rv;
if(minfreespace.has_value())
branch._minfreespace = minfreespace.value();
fs::glob(glob,&paths);
if(paths.empty())
{
SysLog::notice("branch glob `{}` found no matches,"
" adding the literal to branches",glob);
paths.push_back(glob);
}
fs::realpathize(&paths);
for(auto &path : paths)
{
std::error_code ec;
if(!std::filesystem::exists(path,ec))
{
SysLog::notice("branch `{}` does not currently exist",path);
}
else if(!std::filesystem::is_directory(path,ec))
{
SysLog::warning("branch `{}` is not a directory, skipping",path);
continue;
}
branch.path = path;
branches_->emplace_back(branch);
}
return 0;
}
static
int
set(const std::string_view str_,
Branches::Impl *branches_)
{
int rv;
StrVec paths;
Branches::Impl tmp_branches(&branches_->minfreespace());
paths = str::split(str_,':');
for(auto &path : paths)
{
rv = l::parse(path,&tmp_branches);
if(rv < 0)
return rv;
}
*branches_ = std::move(tmp_branches);
return 0;
}
static
int
add_begin(const std::string_view str_,
Branches::Impl *branches_)
{
int rv;
std::vector<std::string> paths;
Branches::Impl tmp_branches(&branches_->minfreespace());
paths = str::split(str_,':');
for(auto &path : paths)
{
rv = l::parse(path,&tmp_branches);
if(rv < 0)
return rv;
}
branches_->insert(branches_->begin(),
tmp_branches.begin(),
tmp_branches.end());
return 0;
}
static
int
add_end(const std::string_view str_,
Branches::Impl *branches_)
{
int rv;
StrVec paths;
Branches::Impl tmp_branches(&branches_->minfreespace());
paths = str::split(str_,':');
for(auto &path : paths)
{
rv = l::parse(path,&tmp_branches);
if(rv < 0)
return rv;
}
branches_->insert(branches_->end(),
tmp_branches.begin(),
tmp_branches.end());
return 0;
}
static
int
erase_begin(Branches::Impl *branches_)
{
if(branches_->empty())
return -ENOENT;
branches_->erase(branches_->begin());
return 0;
}
static
int
erase_end(Branches::Impl *branches_)
{
if(branches_->empty())
return -ENOENT;
branches_->pop_back();
return 0;
}
static
int
erase_fnmatch(const std::string_view str_,
Branches::Impl *branches_)
{
StrVec patterns;
patterns = str::split(str_,':');
for(auto i = branches_->begin(); i != branches_->end();)
{
int match = FNM_NOMATCH;
Branch &branch = *i;
for(auto pi = patterns.cbegin(); pi != patterns.cend() && match != 0; ++pi)
{
match = ::fnmatch(pi->c_str(),
branch.path.c_str(),
0);
}
i = ((match == 0) ? branches_->erase(i) : (i+1));
}
return 0;
}
}
int
Branches::Impl::from_string(const std::string_view s_)
{
std::string instr;
std::string values;
l::split(s_,&instr,&values);
if(instr == "+")
return l::add_end(values,this);
if(instr == "+<")
return l::add_begin(values,this);
if(instr == "+>")
return l::add_end(values,this);
if(instr == "-")
return l::erase_fnmatch(values,this);
if(instr == "-<")
return l::erase_begin(this);
if(instr == "->")
return l::erase_end(this);
if(instr == "=")
return l::set(values,this);
if(instr.empty())
return l::set(values,this);
return -EINVAL;
}
std::string
Branches::Impl::to_string(void) const
{
std::string tmp;
if(empty())
return tmp;
for(auto &branch : *this)
{
tmp += branch.to_string();
tmp += ':';
}
tmp.pop_back();
return tmp;
}
void
Branches::Impl::to_paths(StrVec &paths_) const
{
for(auto &branch : *this)
{
paths_.push_back(branch.path);
}
}
std::vector<fs::path>
Branches::Impl::to_paths() const
{
std::vector<fs::path> vp;
for(const auto &branch : *this)
vp.emplace_back(branch.path);
return vp;
}
int
Branches::from_string(const std::string_view str_)
{
int rv;
Branches::Ptr impl;
Branches::Ptr new_impl;
impl = std::atomic_load(&_impl);
new_impl = std::make_shared<Branches::Impl>(&minfreespace);
*new_impl = *impl;
rv = new_impl->from_string(str_);
if(rv < 0)
return rv;
std::atomic_store(&_impl,new_impl);
return 0;
}
std::string
Branches::to_string(void) const
{
return std::atomic_load(&_impl)->to_string();
}
void
Branches::find_and_set_mode_ro()
{
Branches::Ptr impl;
Branches::Ptr new_impl;
impl = std::atomic_load(&_impl);
new_impl = std::make_shared<Branches::Impl>(&minfreespace);
*new_impl = *impl;
bool changed = false;
for(auto &branch : *new_impl)
{
if(branch.mode != Branch::Mode::RW)
continue;
if(!fs::is_rofs_but_not_mounted_ro(branch.path))
continue;
SysLog::warning("branch `{}` found to be readonly - setting its mode=RO",
branch.path.string());
branch.mode = Branch::Mode::RO;
changed = true;
}
if(not changed)
return;
std::atomic_store(&_impl,new_impl);
}
SrcMounts::SrcMounts(Branches &b_)
: _branches(b_)
{
}
int
SrcMounts::from_string(const std::string_view s_)
{
// return _branches.from_string(s_);
return 0;
}
std::string
SrcMounts::to_string(void) const
{
std::string rv;
Branches::Ptr branches = _branches;
if(branches->empty())
return rv;
for(const auto &branch : *branches)
{
rv += branch.path;
rv += ':';
}
rv.pop_back();
return rv;
}