Gleb Klochkov / Mbed OS Climatcontroll_Main

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   esp8266-driver

Embed: (wiki syntax)

« Back to documentation index

mem_trace functions
Typedefs | Functions

mem_trace functions
[Platform]

Typedefs

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

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).
void mbed_mem_trace_lock ()
 Trace lock.
void mbed_mem_trace_unlock ()
 Trace unlock.
void * mbed_mem_trace_malloc (void *res, size_t size, void *caller)
 Trace a call to 'malloc'.
void * mbed_mem_trace_realloc (void *res, void *ptr, size_t size, void *caller)
 Trace a call to 'realloc'.
void * mbed_mem_trace_calloc (void *res, size_t num, size_t size, void *caller)
 Trace a call to 'calloc'.
void mbed_mem_trace_free (void *ptr, void *caller)
 Trace a call to 'free'.
void mbed_mem_trace_default_callback (uint8_t op, void *res, void *caller,...)
 Default memory trace callback.

Typedef Documentation

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:
opthe ID of the operation (MBED_MEM_TRACE_MALLOC, MBED_MEM_TRACE_REALLOC, MBED_MEM_TRACE_CALLOC or MBED_MEM_TRACE_FREE).
resthe result that the memory operation returned (NULL for 'free').
callerthe 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 66 of file mbed_mem_trace.h.

Function Documentation

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

Trace a call to 'calloc'.

Parameters:
resthe result of running 'calloc'.
numthe 'nmemb' argument given to 'calloc'.
sizethe 'size' argument given to 'calloc'.
callerthe caller of the memory operation.
Returns:
'res' (the first argument).

Definition at line 78 of file mbed_mem_trace.cpp.

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:
opidentifies the memory operation ('m' for 'malloc', 'r' for 'realloc', 'c' for 'calloc' and 'f' for 'free').
res(base 16) is the result of the memor 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.

Definition at line 95 of file mbed_mem_trace.cpp.

void mbed_mem_trace_free ( void *  ptr,
void *  caller 
)

Trace a call to 'free'.

Parameters:
ptrthe 'ptr' argument given to 'free'.
callerthe caller of the memory operation.

Definition at line 87 of file mbed_mem_trace.cpp.

void mbed_mem_trace_lock (  )

Trace lock.

Note:
Locking prevent recursive tracing of malloc/free inside relloc/calloc

Definition at line 48 of file mbed_mem_trace.cpp.

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

Trace a call to 'malloc'.

Parameters:
resthe result of running 'malloc'.
sizethe 'size' argument given to 'malloc'.
callerthe caller of the memory operation.
Returns:
'res' (the first argument).

Definition at line 60 of file mbed_mem_trace.cpp.

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

Trace a call to 'realloc'.

Parameters:
resthe result of running 'realloc'.
ptrthe 'ptr' argument given to 'realloc'.
sizethe 'size' argument given to 'realloc'.
callerthe caller of the memory operation.
Returns:
'res' (the first argument).

Definition at line 69 of file mbed_mem_trace.cpp.

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:
cbthe callback to call on each memory operation.

Definition at line 44 of file mbed_mem_trace.cpp.

void mbed_mem_trace_unlock (  )

Trace unlock.

Definition at line 54 of file mbed_mem_trace.cpp.

Generated on Tue Jul 12 2022 14:26:25 by  doxygen 1.7.2