mem_trace functions

Typedefs
typedef void(*	mbed_mem_trace_cb_t) (uint8_t op, void *res, void *caller,...)
	Type of the callback used by the memory tracer. More...

Functions
void	mbed_mem_trace_set_callback (mbed_mem_trace_cb_t cb)
	Set the callback used by the memory tracer (use NULL for disable tracing). More...
void	mbed_mem_trace_disable ()
	Disable the memory trace output by disabling the callback function. More...
void	mbed_mem_trace_enable ()
	Re-enable the memory trace output with the cb in use when disable was called. More...
void	mbed_mem_trace_lock ()
	Trace lock. More...
void	mbed_mem_trace_unlock ()
	Trace unlock. More...
void *	mbed_mem_trace_malloc (void *res, size_t size, void *caller)
	Trace a call to 'malloc'. More...
void *	mbed_mem_trace_realloc (void *res, void *ptr, size_t size, void *caller)
	Trace a call to 'realloc'. More...
void *	mbed_mem_trace_calloc (void *res, size_t num, size_t size, void *caller)
	Trace a call to 'calloc'. More...
void	mbed_mem_trace_free (void *ptr, void *caller)
	Trace a call to 'free'. More...
void	mbed_mem_trace_default_callback (uint8_t op, void *res, void *caller,...)
	Default memory trace callback. More...

Detailed Description

Typedef Documentation

mbed_mem_trace_cb_t

typedef void(* mbed_mem_trace_cb_t) (uint8_t op, void *res, void *caller,...)

Type of the callback used by the memory tracer.

This callback is called when a memory allocation operation (malloc, realloc, calloc, free) is called and tracing is enabled for that memory allocation function.

Parameters

op	the ID of the operation (MBED_MEM_TRACE_MALLOC, MBED_MEM_TRACE_REALLOC, MBED_MEM_TRACE_CALLOC or MBED_MEM_TRACE_FREE).
res	the result that the memory operation returned (NULL for 'free').
caller	the caller of the memory operation. Note that the value of 'caller' might be unreliable.

The rest of the parameters passed 'mbed_mem_trace_cb_t' are the same as the memory operations that triggered its call (see 'man malloc' for details):

• for malloc: cb(MBED_MEM_TRACE_MALLOC, res, caller, size).
• for realloc: cb(MBED_MEM_TRACE_REALLOC, res, caller, ptr, size).
• for calloc: cb(MBED_MEM_TRACE_CALLOC, res, caller, nmemb, size).
• for free: cb(MBED_MEM_TRACE_FREE, NULL, caller, ptr).

Definition at line 68 of file mbed_mem_trace.h.

Function Documentation

mbed_mem_trace_set_callback()

void mbed_mem_trace_set_callback

(

mbed_mem_trace_cb_t

cb

)

Set the callback used by the memory tracer (use NULL for disable tracing).

Parameters

cb	the callback to call on each memory operation.

mbed_mem_trace_disable()

void mbed_mem_trace_disable

(

)

Disable the memory trace output by disabling the callback function.

mbed_mem_trace_enable()

void mbed_mem_trace_enable

(

)

Re-enable the memory trace output with the cb in use when disable was called.

mbed_mem_trace_lock()

void mbed_mem_trace_lock

(

)

Trace lock.

Note

Locking prevent recursive tracing of malloc/free inside realloc/calloc

mbed_mem_trace_unlock()

void mbed_mem_trace_unlock

(

)

Trace unlock.

mbed_mem_trace_malloc()

void * mbed_mem_trace_malloc	(	void *	res,
		size_t	size,
		void *	caller
	)

Trace a call to 'malloc'.

Parameters

res	the result of running 'malloc'.
size	the 'size' argument given to 'malloc'.
caller	the caller of the memory operation.

Returns

'res' (the first argument).

mbed_mem_trace_realloc()

void * mbed_mem_trace_realloc	(	void *	res,
		void *	ptr,
		size_t	size,
		void *	caller
	)

Trace a call to 'realloc'.

Parameters

res	the result of running 'realloc'.
ptr	the 'ptr' argument given to 'realloc'.
size	the 'size' argument given to 'realloc'.
caller	the caller of the memory operation.

Returns

'res' (the first argument).

mbed_mem_trace_calloc()

void * mbed_mem_trace_calloc	(	void *	res,
		size_t	num,
		size_t	size,
		void *	caller
	)

Trace a call to 'calloc'.

Parameters

res	the result of running 'calloc'.
num	the 'nmemb' argument given to 'calloc'.
size	the 'size' argument given to 'calloc'.
caller	the caller of the memory operation.

Returns

'res' (the first argument).

mbed_mem_trace_free()

void mbed_mem_trace_free	(	void *	ptr,
		void *	caller
	)

Trace a call to 'free'.

Parameters

ptr	the 'ptr' argument given to 'free'.
caller	the caller of the memory operation.

mbed_mem_trace_default_callback()

void mbed_mem_trace_default_callback	(	uint8_t	op,
		void *	res,
		void *	caller,
			...
	)

Default memory trace callback.

DO NOT CALL DIRECTLY. It is meant to be used as the second argument of 'mbed_mem_trace_setup'.

The default callback outputs trace data using 'printf', in a format that's easily parsable by an external tool. For each memory operation, the callback outputs a line that begins with "#<op>:<0xresult>;<0xcaller>-":

Parameters

op	identifies the memory operation ('m' for 'malloc', 'r' for 'realloc', 'c' for 'calloc' and 'f' for 'free').
res	(base 16) is the result of the memory operation. This is always NULL for 'free', since 'free' doesn't return anything.
caller	(base 16) is the caller of the memory operation. Note that the value of 'caller' might be unreliable.

The rest of the output depends on the operation being traced:

• for 'malloc': 'size', where 'size' is the original argument to 'malloc'.
• for 'realloc': '0xptr;size', where 'ptr' (base 16) and 'size' are the original arguments to 'realloc'.
• for 'calloc': 'nmemb;size', where 'nmemb' and 'size' are the original arguments to 'calloc'.
• for 'free': '0xptr', where 'ptr' (base 16) is the original argument to 'free'.

Examples:

• "#m:0x20003240;0x600d-50" encodes a 'malloc' that returned 0x20003240, was called by the instruction at 0x600D with a the 'size' argument equal to 50.
• "#f:0x0;0x602f-0x20003240" encodes a 'free' that was called by the instruction at 0x602f with the 'ptr' argument equal to 0x20003240.