atlas_alloc.h

Go to the documentation of this file.

/*
 * (c) Copyright 2016 Hewlett Packard Enterprise Development LP
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version. This program is
 * distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 * for more details. You should have received a copy of the GNU Lesser
 * General Public License along with this program. If not, see
 * <http://www.gnu.org/licenses/>.
 */


#ifndef ATLAS_ALLOC_H
#define ATLAS_ALLOC_H

#include <stdlib.h>
#include <stdint.h>
#include <fcntl.h>

//
// Persistent region API
// These are interfaces for creating and managing persistent regions,
// entities that contain persistent data. Once a persistent region is
// created, objects can be allocated out of the region, e.g. by using
// nvm_alloc. Any data not in a persistent region is considered
// transient.
//
#ifdef __cplusplus
extern "C" {
#endif

uint32_t NVM_CreateRegion(const char *name, int flags);

uint32_t NVM_FindOrCreateRegion(const char *name, int flags, int *is_created);

uint32_t NVM_FindRegion(const char *name, int flags);

void NVM_DeleteRegion(const char *name);

void NVM_CloseRegion(uint32_t rid);

void *NVM_GetRegionRoot(uint32_t rid);

void NVM_SetRegionRoot(uint32_t rid, void *root);

int NVM_IsInRegion(void *ptr, size_t sz);
    
int isOnDifferentCacheLine(void *p1, void *p2);

int isCacheLineAligned(void *p);

void *nvm_alloc(size_t sz, uint32_t rid);

void *nvm_calloc(size_t nmemb, size_t sz, uint32_t rid);

void *nvm_realloc(void *ptr, size_t sz, uint32_t rid);

void nvm_free(void *ptr);

#ifdef __cplusplus
}
#endif

#endif