mpd/src/lib/smbclient/Context.hxx
Rosen Penev 4e0e4c00bf treewide: replace lock_guard with scoped_lock
SonarLint reports the latter to be better:

std::scoped_lock basically provides the same feature as std::lock_guard,
but is more generic: It can lock several mutexes at the same time, with a
deadlock prevention mechanism (see {rule:cpp:S5524}). The equivalent code
to perform simultaneous locking with std::lock_guard is significantly more
complex. Therefore, it is simpler to use std::scoped_lock all the time,
even when locking only one mutex (there will be no performance impact).

Signed-off-by: Rosen Penev <rosenp@gmail.com>
2021-11-11 17:13:03 -08:00

112 lines
2.9 KiB
C++

/*
* Copyright 2003-2021 The Music Player Daemon Project
* http://www.musicpd.org
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef MPD_SMBCLIENT_CONTEXT_HXX
#define MPD_SMBCLIENT_CONTEXT_HXX
#include "thread/Mutex.hxx"
#include <libsmbclient.h>
#include <utility>
/**
* Wrapper for `SMBCCTX*`.
*/
class SmbclientContext {
/**
* This mutex protects the libsmbclient functions
* smbc_new_context() and smbc_free_context() which need to be
* serialized. We need to do this because we can't use
* smbc_thread_posix(), which is not exported by libsmbclient.
*/
static Mutex global_mutex;
SMBCCTX *ctx = nullptr;
explicit SmbclientContext(SMBCCTX *_ctx) noexcept
:ctx(_ctx) {}
public:
SmbclientContext() = default;
~SmbclientContext() noexcept {
if (ctx != nullptr) {
const std::scoped_lock<Mutex> protect(global_mutex);
smbc_free_context(ctx, 1);
}
}
SmbclientContext(SmbclientContext &&src) noexcept
:ctx(std::exchange(src.ctx, nullptr)) {}
SmbclientContext &operator=(SmbclientContext &&src) noexcept {
using std::swap;
swap(ctx, src.ctx);
return *this;
}
/**
* Throws on error.
*/
static SmbclientContext New();
SMBCFILE *Open(const char *fname, int flags, mode_t mode) noexcept {
return smbc_getFunctionOpen(ctx)(ctx, fname, flags, mode);
}
SMBCFILE *OpenReadOnly(const char *fname) noexcept {
return Open(fname, O_RDONLY, 0);
}
ssize_t Read(SMBCFILE *file, void *buf, size_t count) noexcept {
return smbc_getFunctionRead(ctx)(ctx, file, buf, count);
}
off_t Seek(SMBCFILE *file, off_t offset, int whence=SEEK_SET) noexcept {
return smbc_getFunctionLseek(ctx)(ctx, file, offset, whence);
}
int Stat(const char *fname, struct stat &st) noexcept {
return smbc_getFunctionStat(ctx)(ctx, fname, &st);
}
int Stat(SMBCFILE *file, struct stat &st) noexcept {
return smbc_getFunctionFstat(ctx)(ctx, file, &st);
}
void Close(SMBCFILE *file) noexcept {
smbc_getFunctionClose(ctx)(ctx, file);
}
SMBCFILE *OpenDirectory(const char *fname) noexcept {
return smbc_getFunctionOpendir(ctx)(ctx, fname);
}
void CloseDirectory(SMBCFILE *dir) noexcept {
smbc_getFunctionClosedir(ctx)(ctx, dir);
}
const struct smbc_dirent *ReadDirectory(SMBCFILE *dir) noexcept {
return smbc_getFunctionReaddir(ctx)(ctx, dir);
}
};
#endif