BLI_mmap.h File Reference

#include "BLI_compiler_attrs.h"
#include "BLI_utildefines.h"

Go to the source code of this file.

Typedefs
typedef struct BLI_mmap_file	BLI_mmap_file

Functions
BLI_mmap_file *	BLI_mmap_open (int fd) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT
bool	BLI_mmap_read (BLI_mmap_file *file, void *dest, size_t offset, size_t length) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
void *	BLI_mmap_get_pointer (BLI_mmap_file *file) ATTR_WARN_UNUSED_RESULT
size_t	BLI_mmap_get_length (const BLI_mmap_file *file) ATTR_WARN_UNUSED_RESULT
bool	BLI_mmap_any_io_error (const BLI_mmap_file *file) ATTR_WARN_UNUSED_RESULT
void	BLI_mmap_free (BLI_mmap_file *file) ATTR_NONNULL(1)

Typedef Documentation

BLI_mmap_file

typedef struct BLI_mmap_file BLI_mmap_file

Definition at line 18 of file BLI_mmap.h.

Function Documentation

BLI_mmap_any_io_error()

bool BLI_mmap_any_io_error

(

const BLI_mmap_file *

file

)

Definition at line 482 of file BLI_mmap.cc.

References BLI_mmap_file::io_error.

Referenced by blender::bke::id_hash::compute_file_hash_with_memory_map(), imb_load_filepath_thumbnail_webp(), and IMB_load_image_from_file_descriptor().

BLI_mmap_free()

void BLI_mmap_free

(

BLI_mmap_file *

file

)

Definition at line 487 of file BLI_mmap.cc.

References error_handler_remove(), BLI_mmap_file::handle, BLI_mmap_file::length, MEM_freeN(), and BLI_mmap_file::memory.

Referenced by blender::bke::id_hash::compute_file_hash_with_memory_map(), imb_load_filepath_thumbnail_webp(), IMB_load_image_from_file_descriptor(), memory_close_mmap(), and IMMapStream::~IMMapStream().

BLI_mmap_get_length()

size_t BLI_mmap_get_length

(

const BLI_mmap_file *

file

)

Definition at line 477 of file BLI_mmap.cc.

References BLI_mmap_file::length.

Referenced by BLI_filereader_new_mmap(), blender::bke::id_hash::compute_file_hash_with_memory_map(), imb_load_filepath_thumbnail_webp(), IMB_load_image_from_file_descriptor(), and IMMapStream::IMMapStream().

BLI_mmap_get_pointer()

void * BLI_mmap_get_pointer

(

BLI_mmap_file *

file

)

Definition at line 472 of file BLI_mmap.cc.

References BLI_mmap_file::memory.

Referenced by blender::bke::id_hash::compute_file_hash_with_memory_map(), imb_load_filepath_thumbnail_webp(), and IMB_load_image_from_file_descriptor().

BLI_mmap_open()

BLI_mmap_file * BLI_mmap_open

(

int

fd

)

Definition at line 367 of file BLI_mmap.cc.

References BLI_lseek(), ensure_mmap_initialized(), error_handler_add(), BLI_mmap_file::handle, BLI_mmap_file::id, BLI_mmap_file::length, length(), MEM_callocN(), BLI_mmap_file::memory, and UNLIKELY.

Referenced by BLI_filereader_new_mmap(), blender::bke::id_hash::compute_file_hash_with_memory_map(), imb_load_filepath_thumbnail_webp(), IMB_load_image_from_file_descriptor(), and IMMapStream::IMMapStream().

BLI_mmap_read()

bool BLI_mmap_read	(	BLI_mmap_file *	file,
		void *	dest,
		size_t	offset,
		size_t	length )

Definition at line 459 of file BLI_mmap.cc.

References BLI_mmap_file::io_error, BLI_mmap_file::length, length(), and BLI_mmap_file::memory.

Referenced by memory_read_mmap(), and IMMapStream::read().