Base class for resources that use a temporary directory. More...

#include <resource_internal.hpp>

Detailed Description

Handles cleanup of temporary directory and lock file upon destruction.

Extra doc: https://github.com/casadi/casadi/wiki/L_2js

Definition at line 99 of file resource_internal.hpp.

Inheritance diagram for casadi::TemporaryDirResource:

[legend]

Collaboration diagram for casadi::TemporaryDirResource:

[legend]

Public Types
using	weak_ref_type = WeakRefInternal

Public Member Functions
	TemporaryDirResource (const std::string &base_name, const std::string &suffix="")
	Create with a base name - sets up lock file and directory. More...

	~TemporaryDirResource () override

const std::string &	path () const override
	Get path for a consumer. More...

std::string	class_name () const override
	Get type name. More...

void	disp (std::ostream &stream, bool more) const override
	Print description. More...

void	serialize (SerializingStream &s) const

virtual void	serialize_type (SerializingStream &s) const

virtual void	serialize_body (SerializingStream &s) const

void	change_option (const std::string &option_name, const GenericType &option_value)

casadi_int	getCount () const
	Get the reference count. More...

std::string	debug_repr (const SharedObjectInternal *) const

GenericWeakRef< SharedObject, SharedObjectInternal > *	weak ()
	Get a weak reference to the object. More...

Static Public Member Functions
static ResourceInternal *	deserialize (DeserializingStream &s)

Protected Member Functions
	TemporaryDirResource ()

	TemporaryDirResource (DeserializingStream &s)

void	setup_temp_dir (const std::string &base_name, const std::string &suffix="")
	Set up lock file and directory paths from a base name. More...

void	initSingleton ()

void	destroySingleton ()

B	shared_from_this ()
	Get a shared object from the current internal object. More...

const B	shared_from_this () const
	Get a shared object from the current internal object. More...

Protected Attributes
std::string	lock_file_

std::string	dir_

std::string	serialize_mode_

Member Typedef Documentation

◆ weak_ref_type

using casadi::SharedObjectInternal::weak_ref_type = WeakRefInternal

inherited

Definition at line 152 of file shared_object.hpp.

Constructor & Destructor Documentation

◆ TemporaryDirResource() [1/3]

casadi::TemporaryDirResource::TemporaryDirResource	(	const std::string &	base_name,
		const std::string &	suffix = `""`
	)

Definition at line 127 of file resource_internal.cpp.

     : ResourceInternal() {
   setup_temp_dir(base_name, suffix);
 }

References setup_temp_dir().

◆ ~TemporaryDirResource()

casadi::TemporaryDirResource::~TemporaryDirResource ( )

override

Definition at line 136 of file resource_internal.cpp.

                                             {
   try {
     casadi_assert_dev(Filesystem::remove_all(dir_));
   } catch (...) {
     casadi_warning("Error: Cannot remove temporary directory: " + dir_);
   }
   try {
     casadi_assert_dev(Filesystem::remove(lock_file_));
   } catch (...) {
     casadi_warning("Error: Cannot remove lock file: " + lock_file_);
   }
 }

References dir_, lock_file_, casadi::Filesystem::remove(), and casadi::Filesystem::remove_all().

◆ TemporaryDirResource() [2/3]

casadi::TemporaryDirResource::TemporaryDirResource ( )

inlineexplicitprotected

Definition at line 115 of file resource_internal.hpp.

115 : ResourceInternal() {}

◆ TemporaryDirResource() [3/3]

casadi::TemporaryDirResource::TemporaryDirResource ( DeserializingStream & s )

inlineexplicitprotected

Definition at line 116 of file resource_internal.hpp.

116 : ResourceInternal(s) {}

Member Function Documentation

◆ change_option()

void casadi::ResourceInternal::change_option	(	const std::string &	option_name,
		const GenericType &	option_value
	)

inherited

Definition at line 53 of file resource_internal.cpp.

                                      {
   if (option_name=="serialize_mode") {
     serialize_mode_ = option_value.to_string();
     casadi_assert(serialize_mode_=="embed" || serialize_mode_=="link",
       "Invalid serialization mode: " + serialize_mode_ + ". Pick 'link' or 'embed'.");
   } else {
     casadi_error("Option '" + option_name + "' does not exist");
   }
 }

References casadi::ResourceInternal::serialize_mode_, and casadi::GenericType::to_string().

◆ class_name()

std::string casadi::TemporaryDirResource::class_name ( ) const

inlineoverridevirtual

Extra doc: https://github.com/casadi/casadi/wiki/L_2jt

Implements casadi::SharedObjectInternal.

Reimplemented in casadi::ZipMemResource, and casadi::ZipResource.

Definition at line 110 of file resource_internal.hpp.

110 {return "TemporaryDirResource";}

◆ debug_repr()

std::string casadi::GenericSharedInternal< SharedObject , SharedObjectInternal >::debug_repr ( const Internal * i ) const

inherited

Definition at line 62 of file generic_shared_internal.hpp.

                                                                                        {
     // Note: i != this because of something something multiple inheritance
     return str( (casadi_int)(i)) + "/" + static_cast<const Internal*>(this)->class_name();
   }

◆ deserialize()

ResourceInternal * casadi::ResourceInternal::deserialize ( DeserializingStream & s )

staticinherited

Definition at line 168 of file resource_internal.cpp.

                                                                       {
   s.version("ResourceInternal", 1);
   std::string class_name;
   s.unpack("ResourceInternal::type", class_name);
   if (class_name=="DirResource") {
     return DirResource::deserialize(s);
   } else if (class_name=="ZipResource") {
     return ZipResource::deserialize(s);
   } else if (class_name=="ZipMemResource") {
     return ZipMemResource::deserialize(s);
   } else  {
     casadi_error("Cannot deserialize type '" + class_name + "'");
   }
 }

References casadi::SharedObjectInternal::class_name(), casadi::DirResource::deserialize(), casadi::ZipResource::deserialize(), casadi::ZipMemResource::deserialize(), casadi::DeserializingStream::unpack(), and casadi::DeserializingStream::version().

Referenced by casadi::Resource::deserialize().

◆ destroySingleton()

void casadi::GenericSharedInternal< SharedObject , SharedObjectInternal >::destroySingleton ( )

inlineprotectedinherited

Called in the destructor of singletons

Definition at line 77 of file generic_shared_internal.hpp.

                             {
       static_cast<Internal*>(this)->count--;
     }

◆ disp()

void casadi::TemporaryDirResource::disp	(	std::ostream &	stream,
		bool	more
	)		const

overridevirtual

Implements casadi::SharedObjectInternal.

Reimplemented in casadi::ZipMemResource, and casadi::ZipResource.

Definition at line 132 of file resource_internal.cpp.

                                                                    {
   stream << "TemporaryDirResource(\"" << dir_ << "\")";
 }

References dir_.

◆ getCount()

casadi_int casadi::GenericSharedInternal< SharedObject , SharedObjectInternal >::getCount

inherited

Definition at line 60 of file generic_shared_internal.hpp.

                                                                      {
     return static_cast<const Internal*>(this)->count;
   }

◆ initSingleton()

void casadi::GenericSharedInternal< SharedObject , SharedObjectInternal >::initSingleton ( )

inlineprotectedinherited

Called in the constructor of singletons to avoid that the counter reaches zero

Definition at line 71 of file generic_shared_internal.hpp.

                          {
       casadi_assert_dev(static_cast<Internal*>(this)->count==0);
       static_cast<Internal*>(this)->count++;
     }

◆ path()

const std::string& casadi::TemporaryDirResource::path ( ) const

inlineoverridevirtual

Implements casadi::ResourceInternal.

Definition at line 105 of file resource_internal.hpp.

105 {return dir_;}

Referenced by casadi::open_resource(), and casadi::ZipResource::ZipResource().

◆ serialize()

void casadi::ResourceInternal::serialize ( SerializingStream & s ) const

inherited

Definition at line 149 of file resource_internal.cpp.

                                                            {
   s.version("ResourceInternal", 1);
   serialize_type(s);
   serialize_body(s);
 }

References casadi::ResourceInternal::serialize_body(), casadi::ResourceInternal::serialize_type(), and casadi::SerializingStream::version().

◆ serialize_body()

void casadi::ResourceInternal::serialize_body ( SerializingStream & s ) const

virtualinherited

Reimplemented in casadi::ZipMemResource, casadi::ZipResource, and casadi::DirResource.

Definition at line 159 of file resource_internal.cpp.

                                                                 {
   s.pack("ResourceInternal::serialize_mode", serialize_mode_);
 }

References casadi::SerializingStream::pack(), and casadi::ResourceInternal::serialize_mode_.

Referenced by casadi::ResourceInternal::serialize(), casadi::DirResource::serialize_body(), casadi::ZipResource::serialize_body(), and casadi::ZipMemResource::serialize_body().

◆ serialize_type()

void casadi::ResourceInternal::serialize_type ( SerializingStream & s ) const

virtualinherited

Reimplemented in casadi::ZipResource, and casadi::DirResource.

Definition at line 155 of file resource_internal.cpp.

                                                                 {
   s.pack("ResourceInternal::type", class_name());
 }

References casadi::SharedObjectInternal::class_name(), and casadi::SerializingStream::pack().

Referenced by casadi::ResourceInternal::serialize().

◆ setup_temp_dir()

void casadi::TemporaryDirResource::setup_temp_dir	(	const std::string &	base_name,
		const std::string &	suffix = `""`
	)

protected

Definition at line 116 of file resource_internal.cpp.

                                                                                              {
   // Resolve absolute path since cwd may be changed by the user
   lock_file_ = Filesystem::absolute(temporary_file(base_name + ".", ".lock"));
   dir_ = lock_file_.substr(0, lock_file_.size() - 5);
   if (!suffix.empty()) {
     dir_ += "." + suffix;
   }
   // Create the directory
   Filesystem::create_directories(dir_);
 }

References casadi::Filesystem::absolute(), casadi::Filesystem::create_directories(), dir_, lock_file_, and casadi::temporary_file().

Referenced by TemporaryDirResource(), casadi::ZipResource::unpack(), and casadi::ZipMemResource::unpack().

◆ shared_from_this() [1/2]

B casadi::GenericSharedInternal< SharedObject , SharedObjectInternal >::shared_from_this ( )

inlineprotectedinherited

Definition at line 83 of file generic_shared_internal.hpp.

                          {
       casadi_assert_dev(B::test_cast(static_cast<Internal*>(this)));
       B ret;
       ret.own(static_cast<Internal*>(this));
       return ret;
     }

◆ shared_from_this() [2/2]

const B casadi::GenericSharedInternal< SharedObject , SharedObjectInternal >::shared_from_this ( ) const

inlineprotectedinherited

Definition at line 92 of file generic_shared_internal.hpp.

                                      {
       casadi_assert_dev(B::test_cast(static_cast<const Internal*>(this)));
       B ret;
       ret.own(const_cast<Internal*>(static_cast<const Internal*>(this)));
       return ret;
     }

◆ weak()

GenericWeakRef< SharedObject , SharedObjectInternal > * casadi::GenericSharedInternal< SharedObject , SharedObjectInternal >::weak

inherited

Extra doc: https://github.com/casadi/casadi/wiki/L_1ai

Definition at line 67 of file generic_shared_internal.hpp.

                                                                                   {
 #ifdef CASADI_WITH_THREADSAFE_SYMBOLICS
     auto* w = weak_ref_.load(std::memory_order_acquire);
     if (!w) {
       auto* nw = new GenericWeakRef<Shared, Internal>(static_cast<Internal*>(this));
       GenericWeakRef<Shared, Internal>* expected = nullptr;
       if (weak_ref_.compare_exchange_strong(
             expected, nw, std::memory_order_release, std::memory_order_acquire)) {
         w = nw;
       } else {
         delete nw; // lost the race; another thread published first
         w = expected;
       }
     }
     return w;
 #else
     if (weak_ref_==nullptr) {
       weak_ref_ = new GenericWeakRef<Shared, Internal>(static_cast<Internal*>(this));
     }
     return weak_ref_;
 #endif // CASADI_WITH_THREADSAFE_SYMBOLICS
   }

Member Data Documentation

◆ dir_

std::string casadi::TemporaryDirResource::dir_

protected

Definition at line 120 of file resource_internal.hpp.

Referenced by disp(), casadi::ZipResource::disp(), casadi::ZipMemResource::disp(), setup_temp_dir(), casadi::ZipResource::unpack(), casadi::ZipMemResource::unpack(), and ~TemporaryDirResource().

◆ lock_file_

std::string casadi::TemporaryDirResource::lock_file_

protected

Definition at line 119 of file resource_internal.hpp.

Referenced by setup_temp_dir(), and ~TemporaryDirResource().

◆ serialize_mode_

std::string casadi::ResourceInternal::serialize_mode_

protectedinherited

Definition at line 63 of file resource_internal.hpp.

Referenced by casadi::ResourceInternal::change_option(), casadi::ResourceInternal::ResourceInternal(), casadi::ResourceInternal::serialize_body(), casadi::DirResource::serialize_body(), casadi::ZipResource::serialize_body(), casadi::DirResource::serialize_type(), and casadi::ZipResource::serialize_type().

The documentation for this class was generated from the following files:

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ weak_ref_type

Constructor & Destructor Documentation

◆ TemporaryDirResource() [1/3]

◆ ~TemporaryDirResource()

◆ TemporaryDirResource() [2/3]

◆ TemporaryDirResource() [3/3]

Member Function Documentation

◆ change_option()

◆ class_name()

◆ debug_repr()

◆ deserialize()

◆ destroySingleton()

◆ disp()

◆ getCount()

◆ initSingleton()

◆ path()

◆ serialize()

◆ serialize_body()

◆ serialize_type()

◆ setup_temp_dir()

◆ shared_from_this() [1/2]

◆ shared_from_this() [2/2]

◆ weak()

Member Data Documentation

◆ dir_

◆ lock_file_

◆ serialize_mode_