From patchwork Mon Dec 16 12:10:27 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Niklas_S=C3=B6derlund?= X-Patchwork-Id: 2425 Return-Path: Received: from vsp-unauthed02.binero.net (vsp-unauthed02.binero.net [195.74.38.227]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id CA622601E7 for ; Mon, 16 Dec 2019 13:10:57 +0100 (CET) X-Halon-ID: 167af101-1ffd-11ea-8e92-005056917f90 Authorized-sender: niklas@soderlund.pp.se Received: from bismarck.berto.se (p54ac5865.dip0.t-ipconnect.de [84.172.88.101]) by bin-vsp-out-02.atm.binero.net (Halon) with ESMTPA id 167af101-1ffd-11ea-8e92-005056917f90; Mon, 16 Dec 2019 13:10:51 +0100 (CET) From: =?utf-8?q?Niklas_S=C3=B6derlund?= To: libcamera-devel@lists.libcamera.org Date: Mon, 16 Dec 2019 13:10:27 +0100 Message-Id: <20191216121029.1048242-2-niklas.soderlund@ragnatech.se> X-Mailer: git-send-email 2.24.0 In-Reply-To: <20191216121029.1048242-1-niklas.soderlund@ragnatech.se> References: <20191216121029.1048242-1-niklas.soderlund@ragnatech.se> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 1/3] libcamera: utils: Add exchange() X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 16 Dec 2019 12:10:58 -0000 C++11 does not support std::exchange(), add a custom implementation in utils. Signed-off-by: Niklas Söderlund Reviewed-by: Laurent Pinchart --- src/libcamera/include/utils.h | 9 +++++++++ src/libcamera/utils.cpp | 7 +++++++ 2 files changed, 16 insertions(+) diff --git a/src/libcamera/include/utils.h b/src/libcamera/include/utils.h index a80f7d096bf725a1..32e3b009040d9efc 100644 --- a/src/libcamera/include/utils.h +++ b/src/libcamera/include/utils.h @@ -66,6 +66,15 @@ const T& clamp(const T& v, const T& lo, const T& hi) return std::max(lo, std::min(v, hi)); } +/* C++11 doesn't provide std::exchange */ +template +T exchange(T &obj, U &&new_value) +{ + T old_value = std::move(obj); + obj = std::forward(new_value); + return old_value; +} + using clock = std::chrono::steady_clock; using duration = std::chrono::steady_clock::duration; using time_point = std::chrono::steady_clock::time_point; diff --git a/src/libcamera/utils.cpp b/src/libcamera/utils.cpp index d632f6e66638038d..0e2decd966dd8d0c 100644 --- a/src/libcamera/utils.cpp +++ b/src/libcamera/utils.cpp @@ -95,6 +95,13 @@ char *secure_getenv(const char *name) * \return lo if v is less than lo, hi if v is greater than hi, otherwise v */ +/** + * \fn libcamera::utils::exchange(T &obj, U &&new_value) + * \param[in] obj object whose value to replace + * \param[in] new_value the value to assign to obj + * \return The old value of obj + */ + /** * \typedef clock * \brief The libcamera clock (monotonic) From patchwork Mon Dec 16 12:10:28 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Niklas_S=C3=B6derlund?= X-Patchwork-Id: 2426 Return-Path: Received: from bin-mail-out-05.binero.net (bin-mail-out-05.binero.net [195.74.38.228]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 801BC601E4 for ; Mon, 16 Dec 2019 13:11:04 +0100 (CET) X-Halon-ID: 1ae535e3-1ffd-11ea-8e92-005056917f90 Authorized-sender: niklas@soderlund.pp.se Received: from bismarck.berto.se (p54ac5865.dip0.t-ipconnect.de [84.172.88.101]) by bin-vsp-out-02.atm.binero.net (Halon) with ESMTPA id 1ae535e3-1ffd-11ea-8e92-005056917f90; Mon, 16 Dec 2019 13:10:58 +0100 (CET) From: =?utf-8?q?Niklas_S=C3=B6derlund?= To: libcamera-devel@lists.libcamera.org Date: Mon, 16 Dec 2019 13:10:28 +0100 Message-Id: <20191216121029.1048242-3-niklas.soderlund@ragnatech.se> X-Mailer: git-send-email 2.24.0 In-Reply-To: <20191216121029.1048242-1-niklas.soderlund@ragnatech.se> References: <20191216121029.1048242-1-niklas.soderlund@ragnatech.se> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 2/3] libcamera: Add FileDescriptor to help pass numerical fds around X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 16 Dec 2019 12:11:04 -0000 Add a helper to make it easier to pass file descriptors around. The helper class duplicates the fd which decouples it from the original fd which could be closed by its owner while the new FileDescriptor remains valid. Signed-off-by: Niklas Söderlund Reviewed-by: Laurent Pinchart --- include/libcamera/file_descriptor.h | 33 ++++++ include/libcamera/meson.build | 1 + src/libcamera/file_descriptor.cpp | 158 ++++++++++++++++++++++++++++ src/libcamera/meson.build | 1 + 4 files changed, 193 insertions(+) create mode 100644 include/libcamera/file_descriptor.h create mode 100644 src/libcamera/file_descriptor.cpp diff --git a/include/libcamera/file_descriptor.h b/include/libcamera/file_descriptor.h new file mode 100644 index 0000000000000000..e05f111d128e0ab1 --- /dev/null +++ b/include/libcamera/file_descriptor.h @@ -0,0 +1,33 @@ +/* SPDX-License-Identifier: LGPL-2.1-or-later */ +/* + * Copyright (C) 2019, Google Inc. + * + * file_descriptor.h - File descriptor wrapper + */ +#ifndef __LIBCAMERA_FILE_DESCRIPTOR_H__ +#define __LIBCAMERA_FILE_DESCRIPTOR_H__ + +namespace libcamera { + +class FileDescriptor final +{ +public: + explicit FileDescriptor(int fd = -1); + explicit FileDescriptor(const FileDescriptor &other); + explicit FileDescriptor(FileDescriptor &&other); + ~FileDescriptor(); + + FileDescriptor &operator=(const FileDescriptor &other); + FileDescriptor &operator=(FileDescriptor &&other); + + int fd() const { return fd_; } + +private: + void duplicate(int fd); + + int fd_; +}; + +} /* namespace libcamera */ + +#endif /* __LIBCAMERA_FILE_DESCRIPTOR_H__ */ diff --git a/include/libcamera/meson.build b/include/libcamera/meson.build index 99abf06099407c1f..543e6773cc5158a0 100644 --- a/include/libcamera/meson.build +++ b/include/libcamera/meson.build @@ -6,6 +6,7 @@ libcamera_api = files([ 'controls.h', 'event_dispatcher.h', 'event_notifier.h', + 'file_descriptor.h', 'geometry.h', 'logging.h', 'object.h', diff --git a/src/libcamera/file_descriptor.cpp b/src/libcamera/file_descriptor.cpp new file mode 100644 index 0000000000000000..fd87753b456fc3b7 --- /dev/null +++ b/src/libcamera/file_descriptor.cpp @@ -0,0 +1,158 @@ +/* SPDX-License-Identifier: LGPL-2.1-or-later */ +/* + * Copyright (C) 2019, Google Inc. + * + * file_descriptor.cpp - File descriptor wrapper + */ + +#include + +#include +#include +#include + +#include "log.h" + +/** + * \file file_descriptor.h + * \brief File descriptor wrapper + */ + +namespace libcamera { + +LOG_DEFINE_CATEGORY(FileDescriptor) + +/** + * \class FileDescriptor + * \brief RAII-style wrapper for file descriptors + * + * The FileDescriptor class wraps a file descriptor (expressed as a signed + * integer) to provide an RAII-style mechanism for owning the file descriptor. + * When constructed, the FileDescriptor instance duplicates a given file + * descriptor and takes ownership of the duplicate as a resource. The copy + * constructor and assignment operator duplicate the file descriptor, while the + * move version of those methods move the resource and make the original + * FileDescriptor invalid. When the FileDescriptor is deleted, it closes the + * file descriptor it owns, if any. + */ + +/** + * \brief Create a FileDescriptor wrapping a copy of a given \a fd + * \param[in] fd File descriptor + * + * Constructing a FileDescriptor from a numerical file descriptor duplicates the + * \a fd and takes ownership of the copy. The original \a fd is left untouched, + * and the caller is responsible for closing it when appropriate. The duplicated + * file descriptor will be closed automatically when the FileDescriptor instance + * is destroyed. + */ +FileDescriptor::FileDescriptor(int fd) + : fd_(-1) +{ + duplicate(fd); +} + +/** + * \brief Copy constructor, create a FileDescriptor from a copy of \a other + * \param[in] other The other FileDescriptor + * + * Constructing a FileDescriptor from another FileDescriptor duplicates the + * wrapped numerical file descriptor and takes ownership of the copy. The + * original FileDescriptor is left untouched, and the caller is responsible for + * closing it when appropriate. The duplicated file descriptor will be closed + * automatically when the FileDescriptor instance is destroyed. + */ +FileDescriptor::FileDescriptor(const FileDescriptor &other) + : FileDescriptor(other.fd_) +{ +} + +/** + * \brief Move constructor, create a FileDescriptor by taking over \a other + * \param[in] other The other FileDescriptor + * + * Constructing a FileDescriptor by taking over a wrapped numerical file + * descriptor and taking ownership of it. The \a other FileDescriptor is + * invalidated and set to -1. The taken over file descriptor will be closed + * automatically when the FileDescriptor instance is destroyed. + */ +FileDescriptor::FileDescriptor(FileDescriptor &&other) + : fd_(utils::exchange(other.fd_, -1)) +{ +} + +FileDescriptor::~FileDescriptor() +{ + if (fd_ != -1) + close(fd_); +} + +/** + * \brief Copy assignment operator, replace the wrapped file descriptor with a + * duplicate from \a other + * \param[in] other The other FileDescriptor + * + * Close the currently wrapped numerical file descriptor if any and duplicate + * the file descriptor from \a other. The original FileDescriptor is left + * untouched, and the caller is responsible for closing it when appropriate. + * The duplicated file descriptor will be closed automatically when the + * FileDescriptor instance is destroyed. + * + * \return A reference to the FileDescriptor + */ +FileDescriptor &FileDescriptor::operator=(const FileDescriptor &other) +{ + if (fd_ != -1) + close(fd_); + + duplicate(other.fd_); + + return *this; +} + +/** + * \brief Move assignment operator, replace the wrapped file descriptor by + * taking over \a other + * \param[in] other The other FileDescriptor + * + * Close the currently wrapped numerical file descriptor if any and take over + * the file descriptor from \a other. The \a other FileDescriptor is invalidated + * and set to -1. The taken over file descriptor will be closed automatically + * when the FileDescriptor instance is destroyed. + * + * \return A reference to the FileDescriptor + */ +FileDescriptor &FileDescriptor::operator=(FileDescriptor &&other) +{ + if (fd_ != -1) + close(fd_); + + fd_ = utils::exchange(other.fd_, -1); + + return *this; +} + +/** + * \fn FileDescriptor::fd() + * \brief Retrieve the numerical file descriptor + * \return The numerical file descriptor, which may be -1 if the FileDescriptor + * instance doesn't own a file descriptor + */ + +void FileDescriptor::duplicate(int fd) +{ + if (fd < 0) { + fd_ = -1; + return; + } + + /* Failing to dup() a fd should not happen and is fatal. */ + fd_ = dup(fd); + if (fd_ == -1) { + int ret = -errno; + LOG(FileDescriptor, Fatal) + << "Failed to dup() fd: " << strerror(-ret); + } +} + +} /* namespace libcamera */ diff --git a/src/libcamera/meson.build b/src/libcamera/meson.build index c4f965bd7413b37e..722c5bc15afe52ef 100644 --- a/src/libcamera/meson.build +++ b/src/libcamera/meson.build @@ -14,6 +14,7 @@ libcamera_sources = files([ 'event_dispatcher.cpp', 'event_dispatcher_poll.cpp', 'event_notifier.cpp', + 'file_descriptor.cpp', 'formats.cpp', 'geometry.cpp', 'ipa_context_wrapper.cpp', From patchwork Mon Dec 16 12:10:29 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Niklas_S=C3=B6derlund?= X-Patchwork-Id: 2427 Return-Path: Received: from bin-mail-out-06.binero.net (bin-mail-out-06.binero.net [195.74.38.229]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 5C1F8601E4 for ; Mon, 16 Dec 2019 13:11:11 +0100 (CET) X-Halon-ID: 1eea447d-1ffd-11ea-8e92-005056917f90 Authorized-sender: niklas@soderlund.pp.se Received: from bismarck.berto.se (p54ac5865.dip0.t-ipconnect.de [84.172.88.101]) by bin-vsp-out-02.atm.binero.net (Halon) with ESMTPA id 1eea447d-1ffd-11ea-8e92-005056917f90; Mon, 16 Dec 2019 13:11:05 +0100 (CET) From: =?utf-8?q?Niklas_S=C3=B6derlund?= To: libcamera-devel@lists.libcamera.org Date: Mon, 16 Dec 2019 13:10:29 +0100 Message-Id: <20191216121029.1048242-4-niklas.soderlund@ragnatech.se> X-Mailer: git-send-email 2.24.0 In-Reply-To: <20191216121029.1048242-1-niklas.soderlund@ragnatech.se> References: <20191216121029.1048242-1-niklas.soderlund@ragnatech.se> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 3/3] test: file_descriptor: Add test X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 16 Dec 2019 12:11:11 -0000 Add a test which exercises the whole FileDescriptor interface. Signed-off-by: Niklas Söderlund Reviewed-by: Laurent Pinchart --- test/file_descriptor.cpp | 152 +++++++++++++++++++++++++++++++++++++++ test/meson.build | 1 + 2 files changed, 153 insertions(+) create mode 100644 test/file_descriptor.cpp diff --git a/test/file_descriptor.cpp b/test/file_descriptor.cpp new file mode 100644 index 0000000000000000..b1d0d0e0b2807b20 --- /dev/null +++ b/test/file_descriptor.cpp @@ -0,0 +1,152 @@ +/* SPDX-License-Identifier: GPL-2.0-or-later */ +/* + * Copyright (C) 2019, Google Inc. + * + * file_descriptor.cpp - FileDescriptor test + */ + +#include +#include +#include +#include + +#include + +#include "test.h" + +using namespace std; +using namespace libcamera; + +class FileDescriptorTest : public Test +{ +protected: + int init() + { + fd_ = open("/tmp", O_TMPFILE | O_RDWR, S_IRUSR | S_IWUSR); + if (fd_ < 0) + return TestFail; + + return 0; + } + + int run() + { + FileDescriptor *desc1, *desc2; + + /* Test creating FileDescriptor from numerical file descriptor. */ + desc1 = new FileDescriptor(fd_); + if (desc1->fd() == fd_) + return TestFail; + + if (!validFD(fd_) || !validFD(desc1->fd())) + return TestFail; + + delete desc1; + + if (!validFD(fd_)) + return TestFail; + + /* Test creating FileDescriptor from other FileDescriptor. */ + desc1 = new FileDescriptor(fd_); + desc2 = new FileDescriptor(*desc1); + + if (desc1->fd() == fd_ || desc2->fd() == fd_ || desc1->fd() == desc2->fd()) + return TestFail; + + if (!validFD(fd_) || !validFD(desc1->fd()) || !validFD(desc2->fd())) + return TestFail; + + delete desc1; + + if (!validFD(fd_) || !validFD(desc2->fd())) + return TestFail; + + delete desc2; + + if (!validFD(fd_)) + return TestFail; + + /* Test creating FileDescriptor by taking over other FileDescriptor. */ + desc1 = new FileDescriptor(fd_); + desc2 = new FileDescriptor(std::move(*desc1)); + + if (desc1->fd() != -1 || desc2->fd() == fd_ || desc1->fd() == desc2->fd()) + return TestFail; + + if (!validFD(fd_) || !validFD(desc2->fd())) + return TestFail; + + delete desc1; + delete desc2; + + if (!validFD(fd_)) + return TestFail; + + /* Test creating FileDescriptor by copy assigment */ + desc1 = new FileDescriptor(); + desc2 = new FileDescriptor(fd_); + + if (desc1->fd() != -1 || desc2->fd() == fd_ || desc1->fd() == desc2->fd()) + return TestFail; + + if (!validFD(fd_) || !validFD(desc2->fd())) + return TestFail; + + *desc1 = *desc2; + + if (desc1->fd() == fd_ || desc2->fd() == fd_ || desc1->fd() == desc2->fd()) + return TestFail; + + if (!validFD(fd_) || !validFD(desc1->fd()) || !validFD(desc2->fd())) + return TestFail; + + delete desc1; + delete desc2; + + if (!validFD(fd_)) + return TestFail; + + /* Test creating FileDescriptor by move assigment */ + desc1 = new FileDescriptor(); + desc2 = new FileDescriptor(fd_); + + if (desc1->fd() != -1 || desc2->fd() == fd_ || desc1->fd() == desc2->fd()) + return TestFail; + + if (!validFD(fd_) || !validFD(desc2->fd())) + return TestFail; + + *desc1 = std::move(*desc2); + + if (desc1->fd() == fd_ || desc2->fd() != -1 || desc1->fd() == desc2->fd()) + return TestFail; + + if (!validFD(fd_) || !validFD(desc1->fd())) + return TestFail; + + delete desc1; + delete desc2; + + if (!validFD(fd_)) + return TestFail; + + return TestPass; + } + + void cleanup() + { + if (fd_ > 0) + close(fd_); + } + +private: + bool validFD(int fd) + { + struct stat s; + return fstat(fd, &s) == 0; + } + + int fd_; +}; + +TEST_REGISTER(FileDescriptorTest) diff --git a/test/meson.build b/test/meson.build index 1bb2161dc05a7b1d..9dc392df30efd956 100644 --- a/test/meson.build +++ b/test/meson.build @@ -25,6 +25,7 @@ internal_tests = [ ['event', 'event.cpp'], ['event-dispatcher', 'event-dispatcher.cpp'], ['event-thread', 'event-thread.cpp'], + ['file_descriptor', 'file_descriptor.cpp'], ['message', 'message.cpp'], ['object', 'object.cpp'], ['object-invoke', 'object-invoke.cpp'],