EPICS_base/pvAccess
0
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

separate ChannelProviderRegistry for client/server

Browse Source
This commit is contained in:
Michael Davidsaver
2017-06-21 14:41:24 +02:00
parent 2e7d28b87d
commit 35d2c610bf
14 changed files with 161 additions and 112 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
examples/getme.cpp
View File

@ -137,7 +137,7 @@ int main(int argc, char *argv[]) {
pva::ca::CAClientFactory::start();
std::cout<<"Use provider: "<<providerName<<"\n";
pva::ChannelProvider::shared_pointer provider(pva::getChannelProviderRegistry()->createProvider(providerName, conf));
pva::ChannelProvider::shared_pointer provider(pva::ChannelProviderRegistry::clients()->createProvider(providerName, conf));
if(!provider)
throw std::logic_error("pva provider not registered");

2
examples/monitorme.cpp
View File

@ -276,7 +276,7 @@ int main(int argc, char *argv[]) {
pva::ca::CAClientFactory::start();
std::cout<<"Use provider: "<<providerName<<"\n";
pva::ChannelProvider::shared_pointer provider(pva::getChannelProviderRegistry()->createProvider(providerName, conf));
pva::ChannelProvider::shared_pointer provider(pva::ChannelProviderRegistry::clients()->createProvider(providerName, conf));
if(!provider)
throw std::logic_error("pva provider not registered");

4
src/ca/caProvider.cpp
View File

@ -178,7 +178,7 @@ static
void ca_factory_cleanup(void*)
{
try {
getChannelProviderRegistry()->remove("ca");
ChannelProviderRegistry::clients()->remove("ca");
} catch(std::exception& e) {
LOG(logLevelWarn, "Error when unregister \"ca\" factory");
}
@ -189,7 +189,7 @@ void CAClientFactory::start()
epicsSignalInstallSigAlarmIgnore();
epicsSignalInstallSigPipeIgnore();
if(getChannelProviderRegistry()->add<CAChannelProvider>("ca", false))
if(ChannelProviderRegistry::clients()->add<CAChannelProvider>("ca", false))
epicsAtExit(&ca_factory_cleanup, NULL);
}

56
src/client/pv/pvAccess.h
View File

@ -8,6 +8,7 @@
#define PVACCESS_H
#include <vector>
#include <set>
#ifdef epicsExportSharedSymbols
# define pvAccessEpicsExportSharedSymbols
@ -1242,6 +1243,20 @@ public:
typedef std::vector<std::string> stringVector_t;
//! Create a custom registry
static ChannelProviderRegistry::shared_pointer build();
//! The global registry for "clients".
//! Register providers which will be used within this process.
//! Typically providers which access data outside of the process.
//! Associated with EPICS_PVA_PROVIDER_NAMES
static ChannelProviderRegistry::shared_pointer clients();
//! The global registry for "servers".
//! Register providers which will be used outside of this process (via ServerContext).
//! Typically providers which access data within the process.
//! Associated with EPICS_PVAS_PROVIDER_NAMES
static ChannelProviderRegistry::shared_pointer servers();
/**
* Get a shared instance of the provider with the specified name.
* @param providerName The name of the provider.
@ -1249,43 +1264,32 @@ public:
*/
ChannelProvider::shared_pointer getProvider(std::string const & providerName);
/**
* Creates a new instanceof the provider with the specified name.
* @param providerName The name of the provider.
* @return The interface for the provider or null if the provider is not known.
*/
ChannelProvider::shared_pointer createProvider(std::string const & providerName);
/**
* Creates a new instanceof the provider with the specified name.
* @param providerName The name of the provider.
* @return The interface for the provider or null if the provider is not known.
*/
ChannelProvider::shared_pointer createProvider(std::string const & providerName,
const std::tr1::shared_ptr<Configuration>& conf);
const std::tr1::shared_ptr<Configuration>& conf = std::tr1::shared_ptr<Configuration>());
/**
* Fetch provider factor with the specified name.
* @param providerName The name of the provider.
* @return The factor or null if the provider is not known.
*/
ChannelProviderFactory::shared_pointer getFactory(std::string const & providerName);
virtual ChannelProviderFactory::shared_pointer getFactory(std::string const & providerName);
/**
* Get a array of the names of all the known providers.
* @return The names. Be sure to delete vector instance.
*/
std::auto_ptr<stringVector_t> getProviderNames();
std::auto_ptr<stringVector_t> getProviderNames() EPICS_DEPRECATED;
static ChannelProviderRegistry::shared_pointer build() {
ChannelProviderRegistry::shared_pointer ret(new ChannelProviderRegistry);
return ret;
}
virtual void getProviderNames(std::set<std::string>& names);
//! Add new factory. if replace=false and name already in use, return false with no change
//! in other cases insert provided factory and return true.
bool add(const ChannelProviderFactory::shared_pointer& fact, bool replace=true);
virtual bool add(const ChannelProviderFactory::shared_pointer& fact, bool replace=true);
//! Add a new Provider which will be built using SimpleChannelProviderFactory<Provider>
template<class Provider>
@ -1304,16 +1308,16 @@ public:
ChannelProviderFactory::shared_pointer remove(const std::string& name);
//! Attempt to remove a factory. Return true if Factory was previously registered, and now removed.
bool remove(const ChannelProviderFactory::shared_pointer& factory);
virtual bool remove(const ChannelProviderFactory::shared_pointer& factory);
//! Drop all factories
void clear()
{
providers.clear();
}
virtual void clear();
private:
// ctor is hidden to ensure explict compile errors from a hypothetical sub-class
// we no longer support sub-classing by outside code
ChannelProviderRegistry() {}
friend struct CompatRegistry;
epics::pvData::Mutex mutex;
typedef std::map<std::string, ChannelProviderFactory::shared_pointer> providers_t;
@ -1323,14 +1327,16 @@ private:
/** Access to the global ChannelProviderRegistry instance.
*
* Never returns NULL
*
* @deprecated Deprecated in favor of either ChannelProviderRegistry::clients() or ChannelProviderRegistry::servers()
*/
epicsShareFunc ChannelProviderRegistry::shared_pointer getChannelProviderRegistry();
epicsShareFunc ChannelProviderRegistry::shared_pointer getChannelProviderRegistry() EPICS_DEPRECATED;
//! Shorthand for getChannelProviderRegistry()->add(channelProviderFactory);
epicsShareFunc void registerChannelProviderFactory(ChannelProviderFactory::shared_pointer const & channelProviderFactory);
epicsShareFunc void registerChannelProviderFactory(ChannelProviderFactory::shared_pointer const & channelProviderFactory) EPICS_DEPRECATED;
//! Shorthand for getChannelProviderRegistry()->remove(channelProviderFactory);
epicsShareFunc void unregisterChannelProviderFactory(ChannelProviderFactory::shared_pointer const & channelProviderFactory);
epicsShareFunc void unregisterChannelProviderFactory(ChannelProviderFactory::shared_pointer const & channelProviderFactory) EPICS_DEPRECATED;
//! Shorthand for getChannelProviderRegistry()->clear();
epicsShareFunc void unregisterAllChannelProviderFactory();
epicsShareFunc void unregisterAllChannelProviderFactory() EPICS_DEPRECATED;
/**

118
src/factory/ChannelAccessFactory.cpp
View File

@ -23,6 +23,11 @@ using std::string;
namespace epics {
namespace pvAccess {
ChannelProviderRegistry::shared_pointer ChannelProviderRegistry::build() {
ChannelProviderRegistry::shared_pointer ret(new ChannelProviderRegistry);
return ret;
}
ChannelProvider::shared_pointer ChannelProviderRegistry::getProvider(std::string const & providerName) {
ChannelProviderFactory::shared_pointer fact(getFactory(providerName));
if(fact)
@ -31,14 +36,6 @@ ChannelProvider::shared_pointer ChannelProviderRegistry::getProvider(std::string
return ChannelProvider::shared_pointer();
}
ChannelProvider::shared_pointer ChannelProviderRegistry::createProvider(std::string const & providerName) {
ChannelProviderFactory::shared_pointer fact(getFactory(providerName));
if(fact)
return fact->newInstance();
else
return ChannelProvider::shared_pointer();
}
ChannelProvider::shared_pointer ChannelProviderRegistry::createProvider(std::string const & providerName,
const std::tr1::shared_ptr<Configuration>& conf) {
ChannelProviderFactory::shared_pointer fact(getFactory(providerName));
@ -60,15 +57,28 @@ ChannelProviderFactory::shared_pointer ChannelProviderRegistry::getFactory(std::
std::auto_ptr<ChannelProviderRegistry::stringVector_t> ChannelProviderRegistry::getProviderNames()
{
Lock G(mutex);
std::auto_ptr<stringVector_t> ret(new stringVector_t);
for (providers_t::const_iterator iter = providers.begin();
iter != providers.end(); iter++)
ret->push_back(iter->first);
std::set<std::string> names;
getProviderNames(names);
std::auto_ptr<ChannelProviderRegistry::stringVector_t> ret(new ChannelProviderRegistry::stringVector_t);
ret->reserve(names.size());
for(std::set<std::string>::const_iterator it=names.begin(); it!=names.end(); ++it)
{
ret->push_back(*it);
}
return ret;
}
void ChannelProviderRegistry::getProviderNames(std::set<std::string>& names)
{
Lock G(mutex);
for (providers_t::const_iterator iter = providers.begin();
iter != providers.end(); iter++)
names.insert(iter->first);
}
bool ChannelProviderRegistry::add(const ChannelProviderFactory::shared_pointer& fact, bool replace)
{
assert(fact);
@ -121,13 +131,11 @@ ChannelProviderFactory::shared_pointer ChannelProviderRegistry::add(const std::s
ChannelProviderFactory::shared_pointer ChannelProviderRegistry::remove(const std::string& name)
{
Lock G(mutex);
ChannelProviderFactory::shared_pointer ret;
providers_t::iterator iter(providers.find(name));
if(iter!=providers.end()) {
ret = iter->second;
providers.erase(iter);
ChannelProviderFactory::shared_pointer fact(getFactory(name));
if(fact) {
remove(fact);
}
return ret;
return fact;
}
bool ChannelProviderRegistry::remove(const ChannelProviderFactory::shared_pointer& fact)
@ -142,10 +150,57 @@ bool ChannelProviderRegistry::remove(const ChannelProviderFactory::shared_pointe
return false;
}
void ChannelProviderRegistry::clear()
{
Lock G(mutex);
providers.clear();
}
struct CompatRegistry : public ChannelProviderRegistry
{
CompatRegistry() {}
virtual ~CompatRegistry() {}
virtual ChannelProviderFactory::shared_pointer getFactory(std::string const & providerName) OVERRIDE FINAL
{
ChannelProviderFactory::shared_pointer ret(clients()->getFactory(providerName));
if(!ret)
ret = servers()->getFactory(providerName);
return ret;
}
virtual void getProviderNames(std::set<std::string>& names) OVERRIDE FINAL
{
clients()->getProviderNames(names);
servers()->getProviderNames(names);
}
virtual bool add(const ChannelProviderFactory::shared_pointer& fact, bool replace=true) OVERRIDE FINAL
{
std::cerr<<"Warning: Adding provider \""<<fact->getFactoryName()<<"\" to compatibility ChannelProviderFactory is deprecated\n"
<<" Instead explicitly add to ChannelProviderFactory::clients() or ChannelProviderFactory::servers()\n";
// intentionally not using short-circuit or
return clients()->add(fact, replace) | servers()->add(fact, replace);
}
virtual bool remove(const ChannelProviderFactory::shared_pointer& factory) OVERRIDE FINAL
{
// intentionally not using short-circuit or
return clients()->remove(factory) | servers()->remove(factory);
}
virtual void clear() OVERRIDE FINAL
{
clients()->clear();
servers()->clear();
}
};
namespace {
struct providerRegGbl_t {
Mutex mutex;
ChannelProviderRegistry::shared_pointer reg;
ChannelProviderRegistry::shared_pointer clients,
servers,
compat;
providerRegGbl_t()
:clients(ChannelProviderRegistry::build())
,servers(ChannelProviderRegistry::build())
,compat(new CompatRegistry)
{}
} *providerRegGbl;
epicsThreadOnceId providerRegOnce = EPICS_THREAD_ONCE_INIT;
@ -157,16 +212,25 @@ void providerRegInit(void*)
} // namespace
ChannelProviderRegistry::shared_pointer ChannelProviderRegistry::clients()
{
epicsThreadOnce(&providerRegOnce, &providerRegInit, 0);
return providerRegGbl->clients;
}
ChannelProviderRegistry::shared_pointer ChannelProviderRegistry::servers()
{
epicsThreadOnce(&providerRegOnce, &providerRegInit, 0);
return providerRegGbl->servers;
}
ChannelProviderRegistry::shared_pointer getChannelProviderRegistry()
{
epicsThreadOnce(&providerRegOnce, &providerRegInit, 0);
Lock guard(providerRegGbl->mutex);
if(!providerRegGbl->reg) {
providerRegGbl->reg = ChannelProviderRegistry::build();
}
return providerRegGbl->reg;
return providerRegGbl->compat;
}
void registerChannelProviderFactory(ChannelProviderFactory::shared_pointer const & channelProviderFactory) {

4
src/ioc/PVAServerRegister.cpp
View File

@ -45,9 +45,9 @@ static void startitup() {
the_server = pva::ServerContext::create(pva::ServerContext::Config()
.config(pva::ConfigurationBuilder()
// default to all providers instead of just "local"
.add("EPICS_PVA_PROVIDER_NAMES", pva::PVACCESS_ALL_PROVIDERS)
.add("EPICS_PVAS_PROVIDER_NAMES", pva::PVACCESS_ALL_PROVIDERS)
.push_map()
// prefer to use EPICS_PVA_PROVIDER_NAMES or EPICS_PVAS_PROVIDER_NAMES
// prefer to use EPICS_PVAS_PROVIDER_NAMES
// from environment
.push_env()
.build()));

4
src/pva/clientFactory.cpp
View File

@ -22,7 +22,7 @@ static
void pva_factory_cleanup(void*)
{
try {
getChannelProviderRegistry()->remove("pva");
ChannelProviderRegistry::clients()->remove("pva");
} catch(std::exception& e) {
LOG(logLevelWarn, "Error when unregister \"pva\" factory");
}
@ -33,7 +33,7 @@ void ClientFactory::start()
epicsSignalInstallSigAlarmIgnore();
epicsSignalInstallSigPipeIgnore();
if(getChannelProviderRegistry()->add("pva", createClientProvider, false))
if(ChannelProviderRegistry::clients()->add("pva", createClientProvider, false))
epicsAtExit(&pva_factory_cleanup, NULL);
}

6
src/pva/pv/pvaVersion.h
View File

@ -24,6 +24,12 @@
#include "pv/pvaVersionNum.h"
#ifndef VERSION_INT
# define VERSION_INT(V,R,M,P) ( ((V)<<24) | ((R)<<16) | ((M)<<8) | (P))
#endif
#define PVACCESS_VERSION_INT VERSION_INT(EPICS_PVA_MAJOR_VERSION, EPICS_PVA_MINOR_VERSION, EPICS_PVA_MAINTENANCE_VERSION, 0)
namespace epics {
namespace pvAccess {

2
src/rpcClient/rpcClient.cpp
View File

@ -154,7 +154,7 @@ RPCClient::RPCClient(const std::string & serviceName,
: m_serviceName(serviceName), m_pvRequest(pvRequest ? pvRequest : pvd::createRequest(""))
{
ClientFactory::start();
ChannelProvider::shared_pointer provider(getChannelProviderRegistry()->getProvider("pva"));
ChannelProvider::shared_pointer provider(ChannelProviderRegistry::clients()->getProvider("pva"));
if(!provider)
throw std::logic_error("Unknown Provider");
construct(provider, serviceName, pvRequest);

2
src/server/pv/serverContext.h
View File

@ -114,7 +114,7 @@ public:
/** Start a new PVA server
*
* By default the server will select ChannelProviders using the
* EPICS_PVA_PROVIDER_NAMES or EPICS_PVAS_PROVIDER_NAMES Configuration key.
* EPICS_PVAS_PROVIDER_NAMES Configuration key.
*
* If a list of provided is given with Config::providers() then this
* overrides any Configuration.

15
src/server/serverContext.cpp
View File

@ -144,17 +144,17 @@ void ServerContextImpl::loadConfiguration()
_receiveBufferSize = config->getPropertyAsInteger("EPICS_PVAS_MAX_ARRAY_BYTES", _receiveBufferSize);
if(_channelProviders.empty()) {
std::string providers = config->getPropertyAsString("EPICS_PVA_PROVIDER_NAMES", PVACCESS_DEFAULT_PROVIDER);
providers = config->getPropertyAsString("EPICS_PVAS_PROVIDER_NAMES", providers);
std::string providers = config->getPropertyAsString("EPICS_PVAS_PROVIDER_NAMES", PVACCESS_DEFAULT_PROVIDER);
ChannelProviderRegistry::shared_pointer reg(getChannelProviderRegistry());
ChannelProviderRegistry::shared_pointer reg(ChannelProviderRegistry::servers());
if (providers == PVACCESS_ALL_PROVIDERS)
{
providers.resize(0); // VxWorks 5.5 omits clear()
std::auto_ptr<ChannelProviderRegistry::stringVector_t> names = reg->getProviderNames();
for (ChannelProviderRegistry::stringVector_t::iterator iter = names->begin(); iter != names->end(); iter++)
std::set<std::string> names;
reg->getProviderNames(names);
for (std::set<std::string>::const_iterator iter = names.begin(); iter != names.end(); iter++)
{
ChannelProvider::shared_pointer channelProvider = reg->getProvider(*iter);
if (channelProvider) {
@ -247,7 +247,6 @@ ServerContextImpl::getCurrentConfig()
SET("EPICS_PVA_MAX_ARRAY_BYTES", getReceiveBufferSize());
SET("EPICS_PVAS_PROVIDER_NAMES", providerName.str());
SET("EPICS_PVA_PROVIDER_NAMES", providerName.str());
#undef SET
@ -257,7 +256,7 @@ ServerContextImpl::getCurrentConfig()
bool ServerContextImpl::isChannelProviderNamePreconfigured()
{
Configuration::const_shared_pointer config = getConfiguration();
return config->hasProperty("EPICS_PVA_PROVIDER_NAMES") || config->hasProperty("EPICS_PVAS_PROVIDER_NAMES");
return config->hasProperty("EPICS_PVAS_PROVIDER_NAMES");
}
void ServerContextImpl::initialize()
@ -524,8 +523,6 @@ std::map<std::string, std::tr1::shared_ptr<SecurityPlugin> >& ServerContextImpl:
return SecurityPluginRegistry::instance().getServerSecurityPlugins();
}
ServerContext::shared_pointer startPVAServer(std::string const & providerNames, int timeToRun, bool runInSeparateThread, bool printInfo)
{
ServerContext::shared_pointer ret(ServerContext::create(ServerContext::Config()

2
src/utils/configuration.cpp
View File

@ -197,7 +197,7 @@ void ConfigurationProviderImpl::registerConfiguration(const string &name, Config
if(configsIter != _configs.end())
{
string msg = "configuration with name " + name + " already registered";
THROW_BASE_EXCEPTION(msg.c_str());
THROW_BASE_EXCEPTION(msg);
}
_configs[name] = configuration;
}

49
testApp/remote/channelAccessIFTest.cpp
View File

@ -50,17 +50,6 @@ std::string ChannelAccessIFTest::TEST_ARRAY_CHANNEL_NAME = "testArray1";
#define EXTRA_STRESS_TESTS 0
#endif
namespace {
struct ScopedClientFactory {
ScopedClientFactory() {
ClientFactory::start();
}
~ScopedClientFactory() {
ClientFactory::stop();
}
};
}
int ChannelAccessIFTest::runAllTest() {
testPlan(152+EXTRA_STRESS_TESTS);
@ -87,7 +76,9 @@ int ChannelAccessIFTest::runAllTest() {
.add("EPICS_PVA_BROADCAST_PORT", tstserv->getBroadcastPort())
.push_map()
.build());
ScopedClientFactory SCF;
epics::pvAccess::ClientFactory::start();
m_provider = ChannelProviderRegistry::clients()->getProvider("pva");
test_implementation();
test_providerName();
@ -2403,31 +2394,15 @@ PVStructure::shared_pointer ChannelAccessIFTest::createArrayPvRequest() {
return pvRequest;
}
class ChannelAccessIFRemoteTest: public ChannelAccessIFTest {
public:
virtual ChannelProvider::shared_pointer getChannelProvider() {
return getChannelProviderRegistry()->getProvider(
"pva");
}
virtual long getTimeoutSec() {
return 3;
}
virtual bool isLocal() {
return false;
}
};
MAIN(testChannelAccess)
{
SET_LOG_LEVEL(logLevelError);
ChannelAccessIFRemoteTest caRemoteTest;
return caRemoteTest.runAllTest();
try{
SET_LOG_LEVEL(logLevelError);
ChannelAccessIFTest caRemoteTest;
return caRemoteTest.runAllTest();
}catch(std::exception& e){
PRINT_EXCEPTION(e);
std::cerr<<"Unhandled exception: "<<e.what()<<"\n";
return 1;
}
}

7
testApp/remote/channelAccessIFTest.h
View File

@ -7,6 +7,7 @@
class ChannelAccessIFTest {
ChannelProvider::shared_pointer m_provider;
public:
int runAllTest();
@ -23,9 +24,9 @@ protected:
static std::string TEST_ARRAY_CHANNEL_NAME;
virtual ChannelProvider::shared_pointer getChannelProvider() = 0;
virtual long getTimeoutSec() = 0;
virtual bool isLocal() = 0;
ChannelProvider::shared_pointer getChannelProvider() { return m_provider; }
long getTimeoutSec() {return 3;}
bool isLocal() {return false;}
Channel::shared_pointer createChannel(std::string channelName, bool debug = false );