cpl_virtualmem.h

Go to the documentation of this file.

/**********************************************************************
 *
 * Name:     cpl_virtualmem.h
 * Project:  CPL - Common Portability Library
 * Purpose:  Virtual memory
 * Author:   Even Rouault, <even dot rouault at spatialys.com>
 *
 **********************************************************************
 * Copyright (c) 2014, Even Rouault <even dot rouault at spatialys.com>
 *
 * SPDX-License-Identifier: MIT
 ****************************************************************************/
 
#ifndef CPL_VIRTUAL_MEM_INCLUDED
#define CPL_VIRTUAL_MEM_INCLUDED
 
#include <stddef.h>
 
#include "cpl_port.h"
#include "cpl_vsi.h"
 
CPL_C_START


typedef struct CPLVirtualMem CPLVirtualMem;

typedef void (*CPLVirtualMemCachePageCbk)(CPLVirtualMem *ctxt, size_t nOffset,
                                          void *pPageToFill, size_t nToFill,
                                          void *pUserData);

typedef void (*CPLVirtualMemUnCachePageCbk)(CPLVirtualMem *ctxt, size_t nOffset,
                                            const void *pPageToBeEvicted,
                                            size_t nToBeEvicted,
                                            void *pUserData);

typedef void (*CPLVirtualMemFreeUserData)(void *pUserData);

typedef enum
{
    VIRTUALMEM_READONLY,
    VIRTUALMEM_READONLY_ENFORCED,
    VIRTUALMEM_READWRITE
} CPLVirtualMemAccessMode;

size_t CPL_DLL CPLGetPageSize(void);

 
CPLVirtualMem CPL_DLL *
CPLVirtualMemNew(size_t nSize, size_t nCacheSize, size_t nPageSizeHint,
                 int bSingleThreadUsage, CPLVirtualMemAccessMode eAccessMode,
                 CPLVirtualMemCachePageCbk pfnCachePage,
                 CPLVirtualMemUnCachePageCbk pfnUnCachePage,
                 CPLVirtualMemFreeUserData pfnFreeUserData, void *pCbkUserData);

int CPL_DLL CPLIsVirtualMemFileMapAvailable(void);

CPLVirtualMem CPL_DLL *CPLVirtualMemFileMapNew(
    VSILFILE *fp, vsi_l_offset nOffset, vsi_l_offset nLength,
    CPLVirtualMemAccessMode eAccessMode,
    CPLVirtualMemFreeUserData pfnFreeUserData, void *pCbkUserData);

CPLVirtualMem CPL_DLL *CPLVirtualMemDerivedNew(
    CPLVirtualMem *pVMemBase, vsi_l_offset nOffset, vsi_l_offset nSize,
    CPLVirtualMemFreeUserData pfnFreeUserData, void *pCbkUserData);

void CPL_DLL CPLVirtualMemFree(CPLVirtualMem *ctxt);

void CPL_DLL *CPLVirtualMemGetAddr(CPLVirtualMem *ctxt);

size_t CPL_DLL CPLVirtualMemGetSize(CPLVirtualMem *ctxt);

int CPL_DLL CPLVirtualMemIsFileMapping(CPLVirtualMem *ctxt);

CPLVirtualMemAccessMode CPL_DLL CPLVirtualMemGetAccessMode(CPLVirtualMem *ctxt);

size_t CPL_DLL CPLVirtualMemGetPageSize(CPLVirtualMem *ctxt);

int CPL_DLL CPLVirtualMemIsAccessThreadSafe(CPLVirtualMem *ctxt);

void CPL_DLL CPLVirtualMemDeclareThread(CPLVirtualMem *ctxt);

void CPL_DLL CPLVirtualMemUnDeclareThread(CPLVirtualMem *ctxt);

void CPL_DLL CPLVirtualMemPin(CPLVirtualMem *ctxt, void *pAddr, size_t nSize,
                              int bWriteOp);

void CPL_DLL CPLVirtualMemManagerTerminate(void);
 
CPL_C_END
 
#endif /* CPL_VIRTUAL_MEM_INCLUDED */