DeviceStore.hpp

/*
 * Copyright (C) 2021 CERN
 *
 * This software is provided 'as-is', without any express or implied
 * warranty.  In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 *
 * Created on: 2021-10-27
 *     Author: Michal Mysior <mmysior> <michal.mysior@cern.ch>
 *
 */
 
#ifndef DEVICE_STORE_HPP__
#define DEVICE_STORE_HPP__
 
#include <cstdint>
#include <list>
#include <map>
#include <memory>
#include <mutex>
#include <set>
#include <string>
#include <unordered_map>
 
#include <ccut/yml.hpp>
 
#include "DeviceBase.hpp"
#include "platform/PlatformFactory.hpp"
 
namespace smc {
namespace internal {
 
class DeviceStore
{
public:
    typedef std::shared_ptr<DeviceStore> Shared;
 
    size_t probeDevices(const PlatformBase::Shared &platform);
 
    size_t getDeviceCount() const;
 
    DeviceBase::Shared getDevice(const DeviceId &address) const;
 
    template<typename T>
    std::shared_ptr<T> getDevice(const DeviceId &address)
    {
        std::shared_ptr<T> ret{std::dynamic_pointer_cast<T>(getDevice(address))};
        if (!ret)
        {
            throw Exception(ErrorCode::InvalidArguments,
                            "no such device: " + address);
        }
        return ret;
    }
 
    std::set<DeviceId> getDeviceList() const;
 
    std::set<DeviceId> getDeviceList(DeviceType type) const;
 
    std::set<std::string> getAliasList() const;
 
    DeviceId getAlias(const std::string &alias) const;
 
    bool addAlias(const std::string &alias,
                  const DeviceId &deviceId,
                  bool override = true);
 
    void removeAlias(const std::string &alias);
 
    void loadAlias(const ccut::yml::NodeRef &aliasNode,
                   const ccut::yml::Parser *parser = nullptr);
 
protected:
    std::map<DeviceId, DeviceBase::Shared> m_devices;
    std::unordered_map<std::string, DeviceId> m_alias;
    mutable std::mutex m_devicesMutex;
};
 
} /* namespace internal */
} /* namespace smc */
 
#endif /* DEVICE_STORE_HPP__ */