SharedMemory.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2015 - 2024 Intel Corporation
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef SHAREDMEMORY_HPP_INCLUDE
#define SHAREDMEMORY_HPP_INCLUDE
 
#include <stdlib.h>
 
#include <memory>
#include <string>
 
#include "geopm_public.h"
 
#include "SharedMemoryScopedLock.hpp"
 
namespace geopm
{
    class GEOPM_PUBLIC SharedMemory
    {
        public:
            SharedMemory() = default;
            SharedMemory(const SharedMemory &other) = default;
            SharedMemory &operator=(const SharedMemory &other) = default;
            virtual ~SharedMemory() = default;
            virtual void *pointer(void) const = 0;
            virtual std::string key(void) const = 0;
            virtual size_t size(void) const = 0;
            virtual void unlink(void) = 0;
            virtual std::unique_ptr<SharedMemoryScopedLock> get_scoped_lock(void) = 0;
            static std::unique_ptr<SharedMemory> make_unique_owner(const std::string &shm_key, size_t size);
            static std::unique_ptr<SharedMemory> make_unique_owner_secure(const std::string &shm_key, size_t size);
            static std::unique_ptr<SharedMemory> make_unique_user(const std::string &shm_key, unsigned int timeout);
            //         and uid if current permissions allow for the change.
            virtual void chown(const unsigned int uid, const unsigned int gid) const = 0;
            static void cleanup_shmem(void);
    };
}
 
#endif