memfdregion.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_CORE
#include <cstddef>
#include <cstdint>
#include <promeki/namespace.h>
#include <promeki/string.h>
#include <promeki/error.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class MemfdRegion {
        public:
                static bool isSupported();
 
                MemfdRegion();
 
                explicit MemfdRegion(size_t bytes, const String &debugName = String("anonymous"));
 
                ~MemfdRegion();
 
                MemfdRegion(const MemfdRegion &)            = delete;
                MemfdRegion &operator=(const MemfdRegion &) = delete;
 
                MemfdRegion(MemfdRegion &&other) noexcept;
 
                MemfdRegion &operator=(MemfdRegion &&other) noexcept;
 
                bool isValid() const;
 
                bool isSealed() const;
 
                size_t size() const { return _size; }
 
                int fd() const { return _fd; }
 
                void *producerView();
 
                Error seal(void **outFirstClone = nullptr);
 
                void *cloneView(Error *err = nullptr);
 
                void *readOnlyView(Error *err = nullptr);
 
                Error releaseView(void *p);
 
                Error adviseProducer(int madviseFlag);
 
                Error adviseView(void *p, int madviseFlag);
 
        private:
                int    _fd;          // -1 when not held
                size_t _size;        // rounded-up
                void  *_producer;    // cached MAP_SHARED|PROT_WRITE; null pre-mmap or post-seal
                bool   _sealed;
                bool   _dead;        // permanent failure latched after a failed seal()
 
                void closeAndReset() noexcept;
};
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_CORE