mmap.h File Reference

Map files into memory. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
	ppCPP (extern"C"{) typedef struct ctl_mmap
	A memory mapped file (Read Only) Basically get a const pointer to a file.
const void *	ctl_mmap_open (ctl_mmap *map, const char *szPath)
	Open a memory map.
void	ctl_mmap_close (ctl_mmap *map)
	Close a memory map.

---

Detailed Description

Map files into memory.

Author:

David Mace

Definition in file mmap.h.

---

Function Documentation

void ctl_mmap_close

(

ctl_mmap *

map

)

Close a memory map.

Parameters:

map

Map instance to open

Definition at line 116 of file mmap.c.

References assertobjptr.

Referenced by ppCPP().

{
    assertobjptr(map);
    if( map->base )
        munmap( (void*)map->base, map->size );
    if( map->fd != -1 )
        close( map->fd );
    map->fd = -1;
    map->base = NULL;
    map->size = 0;
}

const void* ctl_mmap_open	(	ctl_mmap *	map,
		const char *	szPath
	)

Open a memory map.

Parameters:

	map	Map instance to open
	szPath	Path to file to map into memory

Definition at line 85 of file mmap.c.

References assertconst, and assertobjptr.

Referenced by BMI_Load(), and ppCPP().

{
    assertobjptr(map);
    assertconst(szPath,1);
    map->base = NULL;
    map->size = 0;
    map->fd = open(szPath, O_RDONLY);
    if(map->fd != -1) 
    { 
        struct stat buf;
        if ( !fstat(map->fd, &buf) )
        { 
            map->size = buf.st_size;
            map->base = mmap(0, map->size, PROT_READ, MAP_SHARED, map->fd, 0);
            if( map->base == MAP_FAILED )
            {
                map->base = NULL;
                map->size = 0;
                close(map->fd);
                map->fd = -1;
            }
            return map->base;
        }
    }
    return NULL;
}

ppCPP

(

)

A memory mapped file (Read Only) Basically get a const pointer to a file.

TODO: Make tchar templates of these

< Where the memory is

< Length of it

< File descriptor to close when finished

Definition at line 9 of file mmap.h.

References ctl_mmap_close(), ctl_mmap_open(), and ppCPP().

                 {)

typedef struct ctl_mmap
{
    void*       base;   
    size_t      size;   
#ifdef WIN32
    void*       hFile;  
    void*       hMap;   
#else /* LINUX */
    int         fd;     
#endif
} ctl_mmap;

Here is the call graph for this function: