1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
|
/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
* Copyright (C) 2019, Google Inc.
*
* object.cpp - Base object
*/
#include <libcamera/base/object.h>
#include <algorithm>
#include <libcamera/base/log.h>
#include <libcamera/base/message.h>
#include <libcamera/base/semaphore.h>
#include <libcamera/base/signal.h>
#include <libcamera/base/thread.h>
#include <libcamera/base/utils.h>
/**
* \file base/object.h
* \brief Base object to support automatic signal disconnection
*/
namespace libcamera {
LOG_DEFINE_CATEGORY(Object)
/**
* \class Object
* \brief Base object to support automatic signal disconnection
*
* The Object class simplifies signal/slot handling for classes implementing
* slots. By inheriting from Object, an object is automatically disconnected
* from all connected signals when it gets destroyed.
*
* Object instances are bound to the thread of their parent, or the thread in
* which they're created when they have no parent. When a message is posted to
* an object, its handler will run in the object's thread. This allows
* implementing easy message passing between threads by inheriting from the
* Object class.
*
* Deleting an object from a thread other than the one the object is bound to is
* unsafe, unless the caller ensures that the object isn't processing any
* message concurrently.
*
* Object slots connected to signals will also run in the context of the
* object's thread, regardless of whether the signal is emitted in the same or
* in another thread.
*
* \sa Message, Signal, Thread
*/
/**
* \brief Construct an Object instance
* \param[in] parent The object parent
*
* The new Object instance is bound to the thread of its \a parent, or to the
* current thread if the \a parent is nullptr.
*/
Object::Object(Object *parent)
: parent_(parent), pendingMessages_(0)
{
thread_ = parent ? parent->thread() : Thread::current();
if (parent)
parent->children_.push_back(this);
}
/**
* \brief Destroy an Object instance
*
* Deleting an Object automatically disconnects all signals from the Object's
* slots. All the Object's children are made orphan, but stay bound to their
* current thread.
*
* Object instances shall be destroyed from the thread they are bound to,
* otherwise undefined behaviour may occur. If deletion of an Object needs to
* be scheduled from a different thread, deleteLater() shall be used.
*/
Object::~Object()
{
/*
* Move signals to a private list to avoid concurrent iteration and
* deletion of items from Signal::disconnect().
*/
std::list<SignalBase *> signals(std::move(signals_));
for (SignalBase *signal : signals)
signal->disconnect(this);
if (pendingMessages_)
thread()->removeMessages(this);
if (parent_) {
auto it = std::find(parent_->children_.begin(),
parent_->children_.end(), this);
ASSERT(it != parent_->children_.end());
parent_->children_.erase(it);
}
for (auto child : children_)
child->parent_ = nullptr;
}
/**
* \brief Schedule deletion of the instance in the thread it belongs to
*
* This function schedules deletion of the Object when control returns to the
* event loop that the object belongs to. This ensures the object is destroyed
* from the right context, as required by the libcamera threading model.
*
* If this function is called before the thread's event loop is started, the
* object will be deleted when the event loop starts.
*
* Deferred deletion can be used to control the destruction context with shared
* pointers. An object managed with shared pointers is deleted when the last
* reference is destroyed, which makes difficult to ensure through software
* design which context the deletion will take place in. With a custom deleter
* for the shared pointer using deleteLater(), the deletion can be guaranteed to
* happen in the thread the object is bound to.
*
* \code{.cpp}
* std::shared_ptr<MyObject> createObject()
* {
* struct Deleter : std::default_delete<MyObject> {
* void operator()(MyObject *obj)
* {
* obj->deleteLater();
* }
* };
*
* MyObject *obj = new MyObject();
*
* return std::shared_ptr<MyObject>(obj, Deleter());
* }
* \endcode
*
* \context This function is \threadsafe.
*/
void Object::deleteLater()
{
postMessage(std::make_unique<Message>(Message::DeferredDelete));
}
/**
* \brief Post a message to the object's thread
* \param[in] msg The message
*
* This method posts the message \a msg to the message queue of the object's
* thread, to be delivered to the object through the message() method in the
* context of its thread. Message ownership is passed to the thread, and the
* message will be deleted after being delivered.
*
* Messages are delivered through the thread's event loop. If the thread is not
* running its event loop the message will not be delivered until the event
* loop gets started.
*
* Due to their asynchronous nature, threads do not provide any guarantee that
* all posted messages are delivered before the thread is stopped. See
* \ref thread-stop for additional information.
*
* \context This function is \threadsafe.
*/
void Object::postMessage(std::unique_ptr<Message> msg)
{
thread()->postMessage(std::move(msg), this);
}
/**
* \brief Message handler for the object
* \param[in] msg The message
*
* This virtual method receives messages for the object. It is called in the
* context of the object's thread, and can be overridden to process custom
* messages. The parent Object::message() method shall be called for any
* message not handled by the override method.
*
* The message \a msg is valid only for the duration of the call, no reference
* to it shall be kept after this method returns.
*/
void Object::message(Message *msg)
{
switch (msg->type()) {
case Message::InvokeMessage: {
InvokeMessage *iMsg = static_cast<InvokeMessage *>(msg);
Semaphore *semaphore = iMsg->semaphore();
iMsg->invoke();
if (semaphore)
semaphore->release();
break;
}
case Message::DeferredDelete:
delete this;
break;
default:
break;
}
}
/**
* \fn R Object::invokeMethod()
* \brief Invoke a method asynchronously on an Object instance
* \param[in] func The object method to invoke
* \param[in] type Connection type for method invocation
* \param[in] args The method arguments
*
* This method invokes the member method \a func with arguments \a args, based
* on the connection \a type. Depending on the type, the method will be called
* synchronously in the same thread or asynchronously in the object's thread.
*
* Arguments \a args passed by value or reference are copied, while pointers
* are passed untouched. The caller shall ensure that any pointer argument
* remains valid until the method is invoked.
*
|
