}
}
+template <typename RequestObject>
+AbstractUI<RequestObject>::~AbstractUI ()
+{
+ for (RequestBufferMapIterator i = request_buffers.begin(); i != request_buffers.end(); ++i) {
+ if ((*i).second->dead) {
+ EventLoop::remove_request_buffer_from_map ((*i).second);
+ delete (*i).second;
+ }
+ }
+}
+
template <typename RequestObject> void
AbstractUI<RequestObject>::register_thread (pthread_t thread_id, string thread_name, uint32_t num_requests)
{
DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("create new request buffer for %1 in %2\n", thread_name, event_loop_name()));
- b = new RequestBuffer (num_requests);
+ b = new RequestBuffer (num_requests); // XXX leaks
/* set this thread's per_thread_request_buffer to this new
queue/ringbuffer. remember that only this thread will
get this queue when it calls per_thread_request_buffer.get()
DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1: allocated per-thread request of type %2, caller %3\n", event_loop_name(), rt, pthread_name()));
vec.buf[0]->type = rt;
- vec.buf[0]->valid = true;
return vec.buf[0];
}
/* check all registered per-thread buffers first */
Glib::Threads::Mutex::Lock rbml (request_buffer_map_lock);
+ /* clean up any dead invalidation records (object was deleted) */
+ trash.sort();
+ trash.unique();
+ for (std::list<InvalidationRecord*>::iterator r = trash.begin(); r != trash.end();) {
+ if (!(*r)->in_use ()) {
+ assert (!(*r)->valid ());
+ DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1 drop invalidation trash %2\n", event_loop_name(), *r));
+ std::list<InvalidationRecord*>::iterator tmp = r;
+ ++tmp;
+ delete *r;
+ trash.erase (r);
+ r = tmp;
+ } else {
+ ++r;
+ }
+ }
+#ifndef NDEBUG
+ if (trash.size() > 0) {
+ DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1 items in trash: %2\n", event_loop_name(), trash.size()));
+ }
+#endif
+
DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1 check %2 request buffers for requests\n", event_loop_name(), request_buffers.size()));
for (i = request_buffers.begin(); i != request_buffers.end(); ++i) {
- while (true) {
+ while (!(*i).second->dead) {
/* we must process requests 1 by 1 because
* the request may run a recursive main
i->second->get_read_vector (&vec);
DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1 reading requests from RB[%2] @ %5, requests = %3 + %4\n",
- event_loop_name(), std::distance (request_buffers.begin(), i), vec.len[0], vec.len[1], i->second));
+ event_loop_name(), std::distance (request_buffers.begin(), i), vec.len[0], vec.len[1], i->second));
if (vec.len[0] == 0) {
break;
} else {
- if (vec.buf[0]->valid) {
+ if (vec.buf[0]->invalidation && !vec.buf[0]->invalidation->valid ()) {
+ DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1: skipping invalidated request\n", event_loop_name()));
+ rbml.release ();
+ } else {
+
DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1: valid request, unlocking before calling\n", event_loop_name()));
rbml.release ();
+
DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1: valid request, calling ::do_request()\n", event_loop_name()));
do_request (vec.buf[0]);
+ }
- /* if the request was CallSlot, then we need to ensure that we reset the functor in the request, in case it
- * held a shared_ptr<>. Failure to do so can lead to dangling references to objects passed to PBD::Signals.
- *
- * Note that this method (::handle_ui_requests()) is by definition called from the event loop thread, so
- * caller_is_self() is true, which means that the execution of the functor has definitely happened after
- * do_request() returns and we no longer need the functor for any reason.
- */
-
- if (vec.buf[0]->type == CallSlot) {
- vec.buf[0]->the_slot = 0;
- }
-
- rbml.acquire ();
- if (vec.buf[0]->invalidation) {
- DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1: removing invalidation record for that request\n", event_loop_name()));
- if (vec.buf[0]->invalidation->event_loop && vec.buf[0]->invalidation->event_loop != this) {
- vec.buf[0]->invalidation->event_loop->slot_invalidation_mutex().lock ();
- }
- //if (!(*i).second->dead) {
- vec.buf[0]->invalidation->requests.remove (vec.buf[0]);
- //}
- if (vec.buf[0]->invalidation->event_loop && vec.buf[0]->invalidation->event_loop != this) {
- vec.buf[0]->invalidation->event_loop->slot_invalidation_mutex().unlock ();
- }
- } else {
- DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1: no invalidation record for that request\n", event_loop_name()));
- }
- } else {
- DEBUG_TRACE (PBD::DEBUG::AbstractUI, "invalid request, ignoring\n");
+ /* if the request was CallSlot, then we need to ensure that we reset the functor in the request, in case it
+ * held a shared_ptr<>. Failure to do so can lead to dangling references to objects passed to PBD::Signals.
+ *
+ * Note that this method (::handle_ui_requests()) is by definition called from the event loop thread, so
+ * caller_is_self() is true, which means that the execution of the functor has definitely happened after
+ * do_request() returns and we no longer need the functor for any reason.
+ */
+
+ if (vec.buf[0]->type == CallSlot) {
+ vec.buf[0]->the_slot = 0;
+ }
+
+ rbml.acquire ();
+ if (vec.buf[0]->invalidation) {
+ vec.buf[0]->invalidation->unref ();
}
+ vec.buf[0]->invalidation = NULL;
i->second->increment_read_ptr (1);
}
}
}
- /* clean up any dead request buffers (their thread has exited) */
-
assert (rbml.locked ());
for (i = request_buffers.begin(); i != request_buffers.end(); ) {
if ((*i).second->dead) {
- DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1/%2 deleting dead per-thread request buffer for %3 @ %4\n",
- event_loop_name(), pthread_name(), i->second));
+ DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1/%2 deleting dead per-thread request buffer for %3 @ %4 (%5 requests)\n", event_loop_name(), pthread_name(), i->second, (*i).second->read_space()));
RequestBufferMapIterator tmp = i;
++tmp;
/* remove it from the EventLoop static map of all request buffers */
EventLoop::remove_request_buffer_from_map ((*i).second);
- /* delete it */
+ /* delete it
+ *
+ * Deleting the ringbuffer destroys all RequestObjects
+ * and thereby drops any InvalidationRecord references of
+ * requests that have not been processed.
+ */
delete (*i).second;
/* remove it from this thread's list of request buffers */
request_buffers.erase (i);
* the request as "done" before we start.
*/
- if (req->invalidation) {
- DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1/%2 remove request from its invalidation list\n", event_loop_name(), pthread_name()));
-
- Glib::Threads::Mutex::Lock li (req->invalidation->event_loop->slot_invalidation_mutex(), Glib::Threads::NOT_LOCK);
- if (req->invalidation->event_loop && req->invalidation->event_loop != this) {
- li.acquire ();
- }
-
- /* after this call, if the object referenced by the
- * invalidation record is deleted, it will no longer
- * try to mark the request as invalid.
- */
-
- req->invalidation->requests.remove (req);
-
- /* req->invalidation->requests is identical to
- * EventLoop::invalidate_request()'s ir->requests.
- *
- * However EventLoop::invalidate_request() cannot
- * run in parallel to this, because sigc slots are always
- * called in the same thread as signal emission (this event-loop).
- * So we do not need to expose "request_invalidation_lock",
- * and only provide a safeguard for modifications to the
- * container itself.
- */
- if (req->invalidation->event_loop && req->invalidation->event_loop != this) {
- li.release ();
- }
- }
-
- if (!req->valid) {
+ if (req->invalidation && !req->invalidation->valid()) {
DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1/%2 handling invalid heap request, type %3, deleting\n", event_loop_name(), pthread_name(), req->type));
delete req;
- //rbml.release ();
continue;
}
*/
if (base_instance() == 0) {
+ delete req;
return; /* XXX is this the right thing to do ? */
}
RequestBuffer* rbuf = per_thread_request_buffer.get ();
if (rbuf != 0) {
- DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1/%2 send per-thread request type %3 using ringbuffer @ %4\n", event_loop_name(), pthread_name(), req->type, rbuf));
+ DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1/%2 send per-thread request type %3 using ringbuffer @ %4 IR: %5\n", event_loop_name(), pthread_name(), req->type, rbuf, req->invalidation));
rbuf->increment_write_ptr (1);
} else {
/* no per-thread buffer, so just use a list with a lock so that it remains
- single-reader/single-writer semantics
- */
- DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1/%2 send heap request type %3\n", event_loop_name(), pthread_name(), req->type));
+ * single-reader/single-writer semantics
+ */
+ DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1/%2 send heap request type %3 IR %4\n", event_loop_name(), pthread_name(), req->type, req->invalidation));
Glib::Threads::Mutex::Lock lm (request_buffer_map_lock);
request_list.push_back (req);
}
return;
}
+ /* object destruction may race with realtime signal emission.
+ *
+ * There may be a concurrent event-loop in progress of deleting
+ * the slot-object. That's perfectly fine. But we need to mark
+ * the invalidation record itself as being used by the request.
+ *
+ * The IR needs to be kept around until the last signal using
+ * it is disconnected and then it can be deleted in the event-loop
+ * (GUI thread).
+ */
+ if (invalidation) {
+ if (!invalidation->valid()) {
+ DEBUG_TRACE (PBD::DEBUG::AbstractUI, string_compose ("%1/%2 ignoring call-slot using functor @ %3, dead invalidation %4\n", event_loop_name(), pthread_name(), &f, invalidation));
+ return;
+ }
+ invalidation->ref ();
+ invalidation->event_loop = this;
+ }
+
RequestObject *req = get_request (BaseUI::CallSlot);
if (req == 0) {
+ if (invalidation) {
+ invalidation->unref ();
+ }
return;
}
req->invalidation = invalidation;
- if (invalidation) {
- /* We're about to modify a std::list<> container, this must not
- * happen concurrently with other container modifications
- * (invalidation->requests.remove in handle_ui_requests).
- *
- * Let's take a dedicated lock that is less contended than
- * request_buffer_map_lock.
- *
- * This works because object's d'tor disconnect signals
- * (member variable) before the sigc::trackable's destroy_notify
- * runs. So there is no race between signal-emissions/call_slot()
- * and adding new requests after the object has been invalidated.
- */
- Glib::Threads::Mutex::Lock lm (request_buffer_map_lock);
- invalidation->requests.push_back (req);
- invalidation->event_loop = this;
- }
-
send_request (req);
}
template<typename RequestObject> void*
AbstractUI<RequestObject>::request_buffer_factory (uint32_t num_requests)
{
- RequestBuffer* mcr = new RequestBuffer (num_requests); // leaks
+ RequestBuffer* mcr = new RequestBuffer (num_requests); // XXX leaks
per_thread_request_buffer.set (mcr);
return mcr;
}
projects / ardour.git / blobdiff