Files
external_libcamera/src/libcamera/bound_method.cpp
Laurent Pinchart 93e72b695e libcamera: Move internal headers to include/libcamera/internal/
The libcamera internal headers are located in src/libcamera/include/.
The directory is added to the compiler headers search path with a meson
include_directories() directive, and internal headers are included with
(e.g. for the internal semaphore.h header)

  #include "semaphore.h"

All was well, until libcxx decided to implement the C++20
synchronization library. The __threading_support header gained a

  #include <semaphore.h>

to include the pthread's semaphore support. As include_directories()
adds src/libcamera/include/ to the compiler search path with -I, the
internal semaphore.h is included instead of the pthread version.
Needless to say, the compiler isn't happy.

Three options have been considered to fix this issue:

- Use -iquote instead of -I. The -iquote option instructs gcc to only
  consider the header search path for headers included with the ""
  version. Meson unfortunately doesn't support this option.

- Rename the internal semaphore.h header. This was deemed to be the
  beginning of a long whack-a-mole game, where namespace clashes with
  system libraries would appear over time (possibly dependent on
  particular system configurations) and would need to be constantly
  fixed.

- Move the internal headers to another directory to create a unique
  namespace through path components. This causes lots of churn in all
  the existing source files through the all project.

The first option would be best, but isn't available to us due to missing
support in meson. Even if -iquote support was added, we would need to
fix the problem before a new version of meson containing the required
support would be released.

The third option is thus the only practical solution available. Bite the
bullet, and do it, moving headers to include/libcamera/internal/.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Acked-by: Jacopo Mondi <jacopo@jmondi.org>
2020-05-16 03:38:11 +03:00

111 lines
3.3 KiB
C++

/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
* Copyright (C) 2019, Google Inc.
*
* bound_method.cpp - Method bind and invocation
*/
#include <libcamera/bound_method.h>
#include "libcamera/internal/message.h"
#include "libcamera/internal/semaphore.h"
#include "libcamera/internal/thread.h"
/**
* \file bound_method.h
* \brief Method bind and invocation
*/
namespace libcamera {
/**
* \enum ConnectionType
* \brief Connection type for asynchronous communication
*
* This enumeration describes the possible types of asynchronous communication
* between a sender and a receiver. It applies to Signal::emit() and
* Object::invokeMethod().
*
* \var ConnectionType::ConnectionTypeAuto
* \brief If the sender and the receiver live in the same thread,
* ConnectionTypeDirect is used. Otherwise ConnectionTypeQueued is used.
*
* \var ConnectionType::ConnectionTypeDirect
* \brief The receiver is invoked immediately and synchronously in the sender's
* thread.
*
* \var ConnectionType::ConnectionTypeQueued
* \brief The receiver is invoked asynchronously
*
* Invoke the receiver asynchronously in its thread when control returns to the
* thread's event loop. The sender proceeds without waiting for the invocation
* to complete.
*
* \var ConnectionType::ConnectionTypeBlocking
* \brief The receiver is invoked synchronously
*
* If the sender and the receiver live in the same thread, this is equivalent to
* ConnectionTypeDirect. Otherwise, the receiver is invoked asynchronously in
* its thread when control returns to the thread's event loop. The sender
* blocks until the receiver signals the completion of the invocation.
*/
/**
* \brief Invoke the bound method with packed arguments
* \param[in] pack Packed arguments
* \param[in] deleteMethod True to delete \a this bound method instance when
* method invocation completes
*
* The bound method stores its return value, if any, in the arguments \a pack.
* For direct and blocking invocations, this is performed synchronously, and
* the return value contained in the pack may be used. For queued invocations,
* the return value is stored at an undefined point of time and shall thus not
* be used by the caller.
*
* \return True if the return value contained in the \a pack may be used by the
* caller, false otherwise
*/
bool BoundMethodBase::activatePack(std::shared_ptr<BoundMethodPackBase> pack,
bool deleteMethod)
{
ConnectionType type = connectionType_;
if (type == ConnectionTypeAuto) {
if (Thread::current() == object_->thread())
type = ConnectionTypeDirect;
else
type = ConnectionTypeQueued;
} else if (type == ConnectionTypeBlocking) {
if (Thread::current() == object_->thread())
type = ConnectionTypeDirect;
}
switch (type) {
case ConnectionTypeDirect:
default:
invokePack(pack.get());
if (deleteMethod)
delete this;
return true;
case ConnectionTypeQueued: {
std::unique_ptr<Message> msg =
std::make_unique<InvokeMessage>(this, pack, nullptr, deleteMethod);
object_->postMessage(std::move(msg));
return false;
}
case ConnectionTypeBlocking: {
Semaphore semaphore;
std::unique_ptr<Message> msg =
std::make_unique<InvokeMessage>(this, pack, &semaphore, deleteMethod);
object_->postMessage(std::move(msg));
semaphore.acquire();
return true;
}
}
}
} /* namespace libcamera */