NewMadeleine documentation — Data helper functions

A collection of helper function to help manipulating nm_data. More...

Functions
static void	nm_data_traversal_apply (const struct nm_data_s p_data, nm_data_apply_t apply, void _context)
	helper function to apply iterator to data

static void	nm_data_generator_init (const struct nm_data_s p_data, struct nm_data_generator_s p_generator)
	build a new generator for the given data type

static struct nm_data_chunk_s	nm_data_generator_next (struct nm_data_generator_s *p_generator)
	get the next chunk of data

static void	nm_data_generator_destroy (struct nm_data_generator_s *p_generator)
	destroy the generator after use

void	nm_data_chunk_extractor_traversal (const struct nm_data_s p_data, nm_len_t chunk_offset, nm_len_t chunk_len, nm_data_apply_t apply, void _context)

void	nm_data_aggregator_traversal (const struct nm_data_s p_data, nm_data_apply_t apply, void _context)

static const struct nm_data_properties_s *	nm_data_properties_get (const struct nm_data_s *p_data)
	returns the properties block for the data

static nm_len_t	nm_data_size (const struct nm_data_s *p_data)
	returns the amount of data contained in the descriptor

void *	nm_data_baseptr_get (const struct nm_data_s *p_data)
	find base pointer for a data known to be contiguous

void *	nm_data_chunk_baseptr_get (const struct nm_data_s *p_data, nm_len_t chunk_offset, nm_len_t chunk_len)
	find base pointer for a data chunk known to be contiguous

void	nm_data_chunk_properties_compute (const struct nm_data_s p_data, nm_len_t chunk_offset, nm_len_t chunk_len, struct nm_data_properties_s p_props)
	compute properties of the given chunk inside the data

uint32_t	nm_data_checksum (const struct nm_data_s *p_data)
	checksum data

void	nm_data_copy_from (const struct nm_data_s p_data, nm_len_t offset, nm_len_t len, void destbuf)
	copy chunk of data from user layout to contiguous buffer

void	nm_data_copy_to (const struct nm_data_s p_data, nm_len_t offset, nm_len_t len, const void srcbuf)
	copy chunk of data from contiguous buffer to user layout

void	nm_data_copy (struct nm_data_s p_dest, struct nm_data_s p_from)
	copy from nm_data to another nm_data

Detailed Description

A collection of helper function to help manipulating nm_data.

Function Documentation

◆ nm_data_aggregator_traversal()

void nm_data_aggregator_traversal	(	const struct nm_data_s *	p_data,
		nm_data_apply_t	apply,
		void *	_context
	)

◆ nm_data_baseptr_get()

void * nm_data_baseptr_get ( const struct nm_data_s * p_data )

find base pointer for a data known to be contiguous

◆ nm_data_checksum()

uint32_t nm_data_checksum ( const struct nm_data_s * p_data )

checksum data

◆ nm_data_chunk_baseptr_get()

void * nm_data_chunk_baseptr_get	(	const struct nm_data_s *	p_data,
		nm_len_t	chunk_offset,
		nm_len_t	chunk_len
	)

find base pointer for a data chunk known to be contiguous

◆ nm_data_chunk_extractor_traversal()

void nm_data_chunk_extractor_traversal	(	const struct nm_data_s *	p_data,
		nm_len_t	chunk_offset,
		nm_len_t	chunk_len,
		nm_data_apply_t	apply,
		void *	_context
	)

◆ nm_data_chunk_properties_compute()

void nm_data_chunk_properties_compute	(	const struct nm_data_s *	p_data,
		nm_len_t	chunk_offset,
		nm_len_t	chunk_len,
		struct nm_data_properties_s *	p_props
	)