ardour/livetrax
13
0
Fork 0
Code

Fix valid_port race/crash when ranaming ports

Browse Source 
PortIndex is sorted by name, and uses port-name as unique identifier.

Ports can be re-named concurrently with processing.
::set_port_name() updates the RCU in the background. The engine
may concurrently process with an old RCU reader value.

In this case valid_port() failed in the process-callback.
and ::get_buffer() returned NULL
This commit is contained in:
Robin Gareus 2022-06-18 22:49:53 +02:00
parent 4acd63b2ef
commit 32161cf154
Signed by: rgareus
GPG Key ID: A090BCE02CF57F04
2 changed files with 47 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
libs/ardour/ardour/port_engine_shared.h
View File

@ -104,10 +104,6 @@ class LIBARDOUR_API BackendPort : public ProtoPort
void update_connected_latency (bool for_playback);
bool operator< (BackendPort const& rhs) const {
return PBD::naturally_less (name ().c_str (), rhs.name ().c_str ());
}
protected:
PortEngineSharedImpl& _backend;
@ -219,17 +215,20 @@ protected:
struct SortByPortName {
bool operator() (BackendPortHandle lhs, BackendPortHandle rhs) const {
return *lhs < *rhs;
return PBD::naturally_less (lhs->name ().c_str (), rhs->name ().c_str ());
}
};
typedef std::map<std::string, BackendPortPtr> PortMap; // fast lookup in _ports
typedef std::set<BackendPortPtr, SortByPortName> PortIndex; // fast lookup in _ports
SerializedRCUManager<PortMap> _portmap;
SerializedRCUManager<PortIndex> _ports;
typedef std::map<std::string, BackendPortPtr> PortMap; // fast-lookup by name
typedef std::set<BackendPortPtr, SortByPortName> PortIndex; // name-based
typedef std::set<BackendPortPtr> PortRegistry; // std::less<>, safe during rename
SerializedRCUManager<PortMap> _portmap;
SerializedRCUManager<PortIndex> _ports;
SerializedRCUManager<PortRegistry> _portregistry;
bool valid_port (BackendPortHandle port) const {
boost::shared_ptr<PortIndex> p = _ports.reader ();
boost::shared_ptr<PortRegistry> p = _portregistry.reader ();
return p->find (port) != p->end ();
}

61
libs/ardour/port_engine_shared.cc
View File

@ -270,6 +270,7 @@ PortEngineSharedImpl::PortEngineSharedImpl (PortManager& mgr, std::string const
: _instance_name (str)
, _portmap (new PortMap)
, _ports (new PortIndex)
, _portregistry (new PortRegistry)
{
g_atomic_int_set (&_port_change_flag, 0);
pthread_mutex_init (&_port_callback_mutex, 0);
@ -415,13 +416,16 @@ PortEngineSharedImpl::add_port (const std::string& name, ARDOUR::DataType type,
}
{
RCUWriter<PortIndex> index_writer (_ports);
RCUWriter<PortMap> map_writer (_portmap);
RCUWriter<PortIndex> index_writer (_ports);
RCUWriter<PortMap> map_writer (_portmap);
RCUWriter<PortRegistry> registry_writer (_portregistry);
boost::shared_ptr<PortIndex> ps = index_writer.get_copy ();
boost::shared_ptr<PortMap> pm = map_writer.get_copy ();
boost::shared_ptr<PortIndex> ps = index_writer.get_copy ();
boost::shared_ptr<PortMap> pm = map_writer.get_copy ();
boost::shared_ptr<PortRegistry> pr = registry_writer.get_copy ();
ps->insert (port);
pr->insert (port);
pm->insert (make_pair (name, port));
}
@ -434,11 +438,13 @@ PortEngineSharedImpl::unregister_port (PortEngine::PortHandle port_handle)
BackendPortPtr port = boost::dynamic_pointer_cast<BackendPort>(port_handle);
{
RCUWriter<PortIndex> index_writer (_ports);
RCUWriter<PortMap> map_writer (_portmap);
RCUWriter<PortIndex> index_writer (_ports);
RCUWriter<PortMap> map_writer (_portmap);
RCUWriter<PortRegistry> registry_writer (_portregistry);
boost::shared_ptr<PortIndex> ps = index_writer.get_copy ();
boost::shared_ptr<PortMap> pm = map_writer.get_copy ();
boost::shared_ptr<PortIndex> ps = index_writer.get_copy ();
boost::shared_ptr<PortMap> pm = map_writer.get_copy ();
boost::shared_ptr<PortRegistry> pr = registry_writer.get_copy ();
PortIndex::iterator i = std::find (ps->begin(), ps->end(), boost::dynamic_pointer_cast<BackendPort> (port_handle));
@ -451,10 +457,12 @@ PortEngineSharedImpl::unregister_port (PortEngine::PortHandle port_handle)
pm->erase (port->name());
ps->erase (i);
pr->erase (*i);
}
_ports.flush ();
_portmap.flush ();
_portregistry.flush ();
}
@ -467,12 +475,13 @@ PortEngineSharedImpl::unregister_ports (bool system_only)
_system_midi_out.clear();
{
RCUWriter<PortIndex> index_writer (_ports);
RCUWriter<PortMap> map_writer (_portmap);
boost::shared_ptr<PortIndex> ps = index_writer.get_copy ();
boost::shared_ptr<PortMap> pm = map_writer.get_copy ();
RCUWriter<PortIndex> index_writer (_ports);
RCUWriter<PortMap> map_writer (_portmap);
RCUWriter<PortRegistry> registry_writer (_portregistry);
boost::shared_ptr<PortIndex> ps = index_writer.get_copy ();
boost::shared_ptr<PortMap> pm = map_writer.get_copy ();
boost::shared_ptr<PortRegistry> pr = registry_writer.get_copy ();
for (PortIndex::iterator i = ps->begin (); i != ps->end ();) {
PortIndex::iterator cur = i++;
@ -481,25 +490,29 @@ PortEngineSharedImpl::unregister_ports (bool system_only)
port->disconnect_all (port);
pm->erase (port->name());
ps->erase (cur);
pr->erase (port);
}
}
}
_ports.flush ();
_portmap.flush ();
_portregistry.flush ();
}
void
PortEngineSharedImpl::clear_ports ()
{
{
RCUWriter<PortIndex> index_writer (_ports);
RCUWriter<PortMap> map_writer (_portmap);
RCUWriter<PortIndex> index_writer (_ports);
RCUWriter<PortMap> map_writer (_portmap);
RCUWriter<PortRegistry> registry_writer (_portregistry);
boost::shared_ptr<PortIndex> ps = index_writer.get_copy();
boost::shared_ptr<PortMap> pm = map_writer.get_copy ();
boost::shared_ptr<PortIndex> ps = index_writer.get_copy ();
boost::shared_ptr<PortMap> pm = map_writer.get_copy ();
boost::shared_ptr<PortRegistry> pr = registry_writer.get_copy ();
if (ps->size () || pm->size ()) {
if (ps->size () || pm->size () || pr->size ()) {
PBD::warning << _("PortEngineSharedImpl: recovering from unclean shutdown, port registry is not empty.") << endmsg;
_system_inputs.clear();
_system_outputs.clear();
@ -507,11 +520,13 @@ PortEngineSharedImpl::clear_ports ()
_system_midi_out.clear();
ps->clear();
pm->clear();
pr->clear();
}
}
_ports.flush ();
_portmap.flush ();
_portregistry.flush ();
g_atomic_int_set (&_port_change_flag, 0);
pthread_mutex_lock (&_port_callback_mutex);
@ -544,20 +559,20 @@ PortEngineSharedImpl::set_port_name (PortEngine::PortHandle port_handle, const s
const std::string old_name = port->name();
/* PortIndex std::set is sorted by name, using the name as key.
* So name-changes need to update the set
* So name-changes need to update the set.
* PortRegistry does not change
*/
RCUWriter<PortIndex> index_writer (_ports);
RCUWriter<PortMap> map_writer (_portmap);
boost::shared_ptr<PortIndex> ps = index_writer.get_copy ();
boost::shared_ptr<PortMap> pm = map_writer.get_copy ();
ps->erase (port);
int ret = port->set_name (newname);
ps->insert (port);
if (ret == 0) {
RCUWriter<PortMap> map_writer (_portmap);
boost::shared_ptr<PortMap> pm = map_writer.get_copy ();
pm->erase (old_name);
pm->insert (make_pair (newname, port));
}