libcamera/test/message.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

136 lines
2.5 KiB
C++

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
* Copyright (C) 2019, Google Inc.
*
* message.cpp - Messages test
*/
#include <chrono>
#include <iostream>
#include <thread>
#include "libcamera/internal/message.h"
#include "libcamera/internal/thread.h"
#include "test.h"
using namespace std;
using namespace libcamera;
class MessageReceiver : public Object
{
public:
enum Status {
NoMessage,
InvalidThread,
MessageReceived,
};
MessageReceiver()
: status_(NoMessage)
{
}
Status status() const { return status_; }
void reset() { status_ = NoMessage; }
protected:
void message(Message *msg)
{
if (msg->type() != Message::None) {
Object::message(msg);
return;
}
if (thread() != Thread::current())
status_ = InvalidThread;
else
status_ = MessageReceived;
}
private:
Status status_;
};
class SlowMessageReceiver : public Object
{
protected:
void message(Message *msg)
{
if (msg->type() != Message::None) {
Object::message(msg);
return;
}
/*
* Don't access any member of the object here (including the
* vtable) as the object will be deleted by the main thread
* while we're sleeping.
*/
this_thread::sleep_for(chrono::milliseconds(100));
}
};
class MessageTest : public Test
{
protected:
int run()
{
Message::Type msgType[2] = {
Message::registerMessageType(),
Message::registerMessageType(),
};
if (msgType[0] != Message::UserMessage ||
msgType[1] != Message::UserMessage + 1) {
cout << "Failed to register message types" << endl;
return TestFail;
}
MessageReceiver receiver;
receiver.moveToThread(&thread_);
thread_.start();
receiver.postMessage(std::make_unique<Message>(Message::None));
this_thread::sleep_for(chrono::milliseconds(100));
switch (receiver.status()) {
case MessageReceiver::NoMessage:
cout << "No message received" << endl;
return TestFail;
case MessageReceiver::InvalidThread:
cout << "Message received in incorrect thread" << endl;
return TestFail;
default:
break;
}
/*
* Test for races between message delivery and object deletion.
* Failures result in assertion errors, there is no need for
* explicit checks.
*/
SlowMessageReceiver *slowReceiver = new SlowMessageReceiver();
slowReceiver->moveToThread(&thread_);
slowReceiver->postMessage(std::make_unique<Message>(Message::None));
this_thread::sleep_for(chrono::milliseconds(10));
delete slowReceiver;
return TestPass;
}
void cleanup()
{
thread_.exit(0);
thread_.wait();
}
private:
Thread thread_;
};
TEST_REGISTER(MessageTest)