mpd/src/input/LocalOpen.cxx

// SPDX-License-Identifier: GPL-2.0-or-later
// Copyright The Music Player Daemon Project

#include "LocalOpen.hxx"
#include "InputStream.hxx"
#include "plugins/FileInputPlugin.hxx"
#include "config.h"

#include "io/uring/Features.h"
#ifdef HAVE_URING
#include "plugins/UringInputPlugin.hxx"
#endif

#ifdef ENABLE_ARCHIVE
#include "plugins/ArchiveInputPlugin.hxx"
#endif

#include "fs/Path.hxx"
#include "system/Error.hxx"

#include <cassert>

InputStreamPtr
OpenLocalInputStream(Path path, Mutex &mutex)
{
	InputStreamPtr is;

#ifdef ENABLE_ARCHIVE
	try {
#endif
#ifdef HAVE_URING
		is = OpenUringInputStream(path.c_str(), mutex);
		if (is)
			return is;
#endif

		is = OpenFileInputStream(path, mutex);
#ifdef ENABLE_ARCHIVE
	} catch (const std::system_error &e) {
		if (IsPathNotFound(e)) {
			/* ENOTDIR means this may be a path inside an archive
			   file */
			is = OpenArchiveInputStream(path, mutex);
			if (!is)
				throw;
		} else
			throw;
	}
#endif

	assert(is);
	assert(is->IsReady());

	return is;
}
use SPDX IDs, replacing the long copyright headers 2023-03-06 14:42:04 +01:00			`// SPDX-License-Identifier: GPL-2.0-or-later`
			`// Copyright The Music Player Daemon Project`
input/LocalOpen: new library for opening local files Combines the "file" and the "archive" input plugins. 2014-10-02 21:06:01 +02:00
			`#include "LocalOpen.hxx"`
			`#include "InputStream.hxx"`
			`#include "plugins/FileInputPlugin.hxx"`
check.h: remove obsolete header Since we switched from autotools to Meson in commit 94592c14062d5afc9482d11baa401648082022c0, we don't need to include `config.h` early to properly enable large file support. Meson passes the required macros on the compiler command line instead of defining them in `config.h`. This means we can include `config.h` at any time, whenever we want to check its macros, and there are no ordering constraints. 2018-11-19 12:49:45 +01:00			`#include "config.h"`
input/LocalOpen: new library for opening local files Combines the "file" and the "archive" input plugins. 2014-10-02 21:06:01 +02:00
input/uring: new input plugin using io_uring This is the final piece of the series to establish io_uring support on Linux. MPD doesn't need io_uring for its efficient bulk I/O support, but to allow file I/O to be cancelled. This is a big problem on CIFS/NFS mounts where processes sleep uninterruptable if the file server disappears, deadlocking MPD. With io_uring, a flaky NFS connection allows MPD to continue to work (even though there are still deadlocks inside MPD which need to be addressed). This plugin does not yet use cancellable `open()` using `IORING_OP_OPENAT`. This will be implemented later. Lots of other optimization opportunities for io_uring are still missing as well - for example the database update could benefit a lot, but unfortunately, io_uring doesn't have `readdir()` support just yet. 2020-05-05 15:32:41 +02:00			`#include "io/uring/Features.h"`
			`#ifdef HAVE_URING`
			`#include "plugins/UringInputPlugin.hxx"`
			`#endif`

input/LocalOpen: new library for opening local files Combines the "file" and the "archive" input plugins. 2014-10-02 21:06:01 +02:00			`#ifdef ENABLE_ARCHIVE`
			`#include "plugins/ArchiveInputPlugin.hxx"`
			`#endif`

			`#include "fs/Path.hxx"`
input/Plugin: migrate open() from class Error to C++ exceptions 2016-09-09 15:37:06 +02:00			`#include "system/Error.hxx"`
input/LocalOpen: new library for opening local files Combines the "file" and the "archive" input plugins. 2014-10-02 21:06:01 +02:00
replace assert.h with cassert The former was deprecated with C++14. According to the C++11 and C++17 standards, both files are identical. Signed-off-by: Rosen Penev <rosenp@gmail.com> 2020-03-12 23:20:59 +01:00			`#include <cassert>`
input/LocalOpen: new library for opening local files Combines the "file" and the "archive" input plugins. 2014-10-02 21:06:01 +02:00
input: wrap InputStream in std::unique_ptr 2016-02-21 08:03:32 +01:00			`InputStreamPtr`
input/Stream: remove attribute "cond", replace with handler interface This adds a bit of overhead, but also adds flexibility to the API, because arbitrary triggers may be invoked from that virtual method implementation, not just Cond::signal(). The motivation for this is to make the handlers more dynamic, for the upcoming buffering class utilizing ProxyInputStream. 2018-06-22 19:37:18 +02:00			`OpenLocalInputStream(Path path, Mutex &mutex)`
input/LocalOpen: new library for opening local files Combines the "file" and the "archive" input plugins. 2014-10-02 21:06:01 +02:00			`{`
input/Plugin: migrate open() from class Error to C++ exceptions 2016-09-09 15:37:06 +02:00			`InputStreamPtr is;`
input/LocalOpen: new library for opening local files Combines the "file" and the "archive" input plugins. 2014-10-02 21:06:01 +02:00
			`#ifdef ENABLE_ARCHIVE`
input/Plugin: migrate open() from class Error to C++ exceptions 2016-09-09 15:37:06 +02:00			`try {`
			`#endif`
input/uring: new input plugin using io_uring This is the final piece of the series to establish io_uring support on Linux. MPD doesn't need io_uring for its efficient bulk I/O support, but to allow file I/O to be cancelled. This is a big problem on CIFS/NFS mounts where processes sleep uninterruptable if the file server disappears, deadlocking MPD. With io_uring, a flaky NFS connection allows MPD to continue to work (even though there are still deadlocks inside MPD which need to be addressed). This plugin does not yet use cancellable `open()` using `IORING_OP_OPENAT`. This will be implemented later. Lots of other optimization opportunities for io_uring are still missing as well - for example the database update could benefit a lot, but unfortunately, io_uring doesn't have `readdir()` support just yet. 2020-05-05 15:32:41 +02:00			`#ifdef HAVE_URING`
			`is = OpenUringInputStream(path.c_str(), mutex);`
			`if (is)`
			`return is;`
			`#endif`

input/Stream: remove attribute "cond", replace with handler interface This adds a bit of overhead, but also adds flexibility to the API, because arbitrary triggers may be invoked from that virtual method implementation, not just Cond::signal(). The motivation for this is to make the handlers more dynamic, for the upcoming buffering class utilizing ProxyInputStream. 2018-06-22 19:37:18 +02:00			`is = OpenFileInputStream(path, mutex);`
input/Plugin: migrate open() from class Error to C++ exceptions 2016-09-09 15:37:06 +02:00			`#ifdef ENABLE_ARCHIVE`
			`} catch (const std::system_error &e) {`
			`if (IsPathNotFound(e)) {`
			`/* ENOTDIR means this may be a path inside an archive`
			`file */`
input/Stream: remove attribute "cond", replace with handler interface This adds a bit of overhead, but also adds flexibility to the API, because arbitrary triggers may be invoked from that virtual method implementation, not just Cond::signal(). The motivation for this is to make the handlers more dynamic, for the upcoming buffering class utilizing ProxyInputStream. 2018-06-22 19:37:18 +02:00			`is = OpenArchiveInputStream(path, mutex);`
input/Plugin: migrate open() from class Error to C++ exceptions 2016-09-09 15:37:06 +02:00			`if (!is)`
			`throw;`
			`} else`
			`throw;`
input/Open: use OpenLocalInputStream() Make the "open" method of plugins "file" and "archive" dummy methods that always fail. Instead, let InputStream::Open() hard-code access to these two plugins by using OpenLocalInputStream(). This allows simplifyin the algorithm for falling back to probing archive plugins. 2014-10-02 21:17:31 +02:00			`}`
input/LocalOpen: new library for opening local files Combines the "file" and the "archive" input plugins. 2014-10-02 21:06:01 +02:00			`#endif`

input/LocalOpen: make assert() more strict 2018-01-20 19:15:51 +01:00			`assert(is);`
			`assert(is->IsReady());`
input/LocalOpen: new library for opening local files Combines the "file" and the "archive" input plugins. 2014-10-02 21:06:01 +02:00
			`return is;`
			`}`