devicedriver.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/
 
#ifndef ZYPP_MEDIA_NG_WORKER_DEVICEDRIVER_H_INCLUDED
#define ZYPP_MEDIA_NG_WORKER_DEVICEDRIVER_H_INCLUDED
 
#include <zypp-media/ng/ProvideFwd>
#include <zypp-media/ng/worker/ProvideWorker>
#include <zypp-media/ng/HeaderValueMap>
#include <zypp-media/Mount>
#include <zypp-core/zyppng/base/Signals>
#include <zypp-core/zyppng/base/Base>
#include <zypp-core/zyppng/base/zyppglobal.h>
#include <zypp-core/zyppng/pipelines/Expected>
#include <any>
#include <unordered_map>
 
namespace zyppng::worker
{
 
  ZYPP_FWD_DECL_TYPE_WITH_REFS (DeviceDriver);
 
  struct Device
  {
    std::string  _name;             
    unsigned int _maj_nr    = 0;    
    unsigned int _min_nr    = 0;    
    zypp::Pathname _mountPoint = {};
    bool _ephemeral = false;        
    std::unordered_map<std::string, std::any> _properties = {};
  };
 
  struct AttachedMedia
  {
    std::shared_ptr<Device> _dev;
    zypp::Pathname _attachRoot;
  };
 
  struct AttachError
  {
    AttachError ( const MessageCodes code, const std::string &reason, const bool transient, const HeaderValueMap &extra = {} );
    AttachError ( const MessageCodes code, const bool transient, const zypp::Exception &e );
 
    MessageCodes _code;
    std::string _reason;
    bool _transient;
    HeaderValueMap _extra;
  };
 
  // either the mountpoint or an error
  using AttachResult = expected<zypp::Pathname, AttachError>;

  class DeviceDriver : public zyppng::Base
  {
    public:
 
      DeviceDriver ( WorkerCaps::WorkerType wType );

      void setProvider ( ProvideWorkerWeakRef workerRef );

      virtual AttachResult mountDevice ( const uint32_t id, const zypp::Url &mediaUrl, const std::string &attachId, const std::string &label, const HeaderValueMap &extras ) = 0;
 
 
 
      virtual zyppng::expected<WorkerCaps> initialize(const zyppng::worker::Configuration &conf);
 

      bool detachMedia ( const std::string &attachId );

      void releaseIdleDevices ();

      virtual void detectDevices();

      std::vector<std::shared_ptr<Device>> &knownDevices();

      const std::vector<std::shared_ptr<Device>> &knownDevices() const;

      std::unordered_map<std::string, AttachedMedia> &attachedMedia();

      virtual bool isVolatile () const;

      void setAttachRoot ( const zypp::Pathname &root );

      zypp::Pathname attachRoot () const;

      virtual void immediateShutdown();

      ProvideWorkerRef parentWorker () const;

      const zyppng::worker::Configuration &config() const;
 
    protected:
      virtual void unmountDevice ( Device &dev );

      zyppng::expected<void> isDesiredMedium ( const zypp::Url &deviceUrl, const zypp::Pathname &mountPoint, const zyppng::MediaDataVerifierRef &verifier, uint mediaNr = 1 );
 
 
      zypp::Pathname createAttachPoint(const zypp::Pathname &attach_root) const;
      void removeAttachPoint ( const zypp::Pathname &attach_pt ) const;
      bool checkAttached ( const zypp::Pathname &mountPoint, const std::function<bool( const zypp::media::MountEntry &)> predicate );

      static const std::function<bool( const zypp::media::MountEntry &)> devicePredicate ( unsigned int majNr,  unsigned int minNr );

      static const std::function<bool( const zypp::media::MountEntry &)> fstypePredicate ( const std::string &src, const std::vector<std::string> &fstypes );

      static const std::function<bool( const zypp::media::MountEntry &)> bindMountPredicate ( const std::string &src );
 
    private:
      WorkerCaps::WorkerType _wType;
      ProviderConfiguration _config;
      time_t  _attach_mtime = 0; //< Timestamp of the mtab we did read
      zypp::Pathname _attachRoot;
      std::vector<std::shared_ptr<Device>> _sysDevs;
      std::unordered_map<std::string, AttachedMedia> _attachedMedia;
      ProvideWorkerWeakRef _parentWorker;
  };
 
 
 
 
}
 
#endif