* On "publish", when buffer is free, debugger stores arbitrary variables
* content into, and mark this buffer as filled
* Buffer content is read asynchronously, (from non real time part),
* and then buffer marked free again.
#include "iec_types_all.h"
#define BUFFER_SIZE %(buffer_size)d
/* Atomically accessed variable for buffer state */
static long buffer_state = BUFFER_FREE;
char debug_buffer[BUFFER_SIZE];
static char* buffer_cursor = debug_buffer;
static unsigned int retain_offset = 0;
%(programs_declarations)s
* Declare global variables from resources and conf
%(extern_variables_declarations)s
typedef void(*__for_each_variable_do_fp)(void*, __IEC_types_enum);
void __for_each_variable_do(__for_each_variable_do_fp fp)
%(for_each_variable_do_code)s
__IEC_types_enum __find_variable(unsigned int varindex, void ** varp)
%(find_variable_case_code)s
#define __Unpack_case_t(TYPENAME) \
*flags = ((__IEC_##TYPENAME##_t *)varp)->flags;\
forced_value_p = *real_value_p = &((__IEC_##TYPENAME##_t *)varp)->value;\
#define __Unpack_case_p(TYPENAME)\
case TYPENAME##_O_ENUM :\
*flags = __IEC_OUTPUT_FLAG;\
case TYPENAME##_P_ENUM :\
*flags |= ((__IEC_##TYPENAME##_p *)varp)->flags;\
*real_value_p = ((__IEC_##TYPENAME##_p *)varp)->value;\
forced_value_p = &((__IEC_##TYPENAME##_p *)varp)->fvalue;\
void* UnpackVar(void* varp, __IEC_types_enum vartype, void **real_value_p, char *flags)
void *forced_value_p = NULL;
if (*flags & __IEC_FORCE_FLAG)
void Remind(unsigned int offset, unsigned int count, void * p);
void RemindIterator(void* varp, __IEC_types_enum vartype)
void *real_value_p = NULL;
UnpackVar(varp, vartype, &real_value_p, &flags);
if(flags & __IEC_RETAIN_FLAG){
USINT size = __get_type_enum_size(vartype);
/* compute next cursor positon*/
unsigned int next_retain_offset = retain_offset + size;
Remind(retain_offset, size, real_value_p);
/* increment cursor according size*/
retain_offset = next_retain_offset;
extern int CheckRetainBuffer(void);
/* init local static vars */
buffer_cursor = debug_buffer;
buffer_state = BUFFER_FREE;
/* Iterate over all variables to fill debug buffer */
__for_each_variable_do(RemindIterator);
extern void InitiateDebugTransfer(void);
extern unsigned long __tick;
void __cleanup_debug(void)
buffer_cursor = debug_buffer;
void __retrieve_debug(void)
void Retain(unsigned int offset, unsigned int count, void * p);
inline void BufferIterator(void* varp, __IEC_types_enum vartype, int do_debug)
void *real_value_p = NULL;
void *visible_value_p = NULL;
visible_value_p = UnpackVar(varp, vartype, &real_value_p, &flags);
if(flags & ( __IEC_DEBUG_FLAG | __IEC_RETAIN_FLAG)){
USINT size = __get_type_enum_size(vartype);
if(flags & __IEC_DEBUG_FLAG){
/* copy visible variable to buffer */;
/* compute next cursor positon.
No need to check overflow, as BUFFER_SIZE
is computed large enough */
char* next_cursor = buffer_cursor + size;
/* copy data to the buffer */
memcpy(buffer_cursor, visible_value_p, size);
/* increment cursor according size*/
buffer_cursor = next_cursor;
/* re-force real value of outputs (M and Q)*/
if((flags & __IEC_FORCE_FLAG) && (flags & __IEC_OUTPUT_FLAG)){
memcpy(real_value_p, visible_value_p, size);
if(flags & __IEC_RETAIN_FLAG){
/* compute next cursor positon*/
unsigned int next_retain_offset = retain_offset + size;
Retain(retain_offset, size, real_value_p);
/* increment cursor according size*/
retain_offset = next_retain_offset;
void DebugIterator(void* varp, __IEC_types_enum vartype){
BufferIterator(varp, vartype, 1);
void RetainIterator(void* varp, __IEC_types_enum vartype){
BufferIterator(varp, vartype, 0);
extern int TryEnterDebugSection(void);
extern long AtomicCompareExchange(long*, long, long);
extern void LeaveDebugSection(void);
extern void ValidateRetainBuffer(void);
extern void InValidateRetainBuffer(void);
void __publish_debug(void)
InValidateRetainBuffer();
/* Check there is no running debugger re-configuration */
if(TryEnterDebugSection()){
long latest_state = AtomicCompareExchange(
if(latest_state == BUFFER_FREE)
/* Reset buffer cursor */
buffer_cursor = debug_buffer;
/* Iterate over all variables to fill debug buffer */
__for_each_variable_do(DebugIterator);
* Trigger asynchronous transmission
* (returns immediately) */
InitiateDebugTransfer(); /* size */
/* when not debugging, do only retain */
__for_each_variable_do(RetainIterator);
/* when not debugging, do only retain */
__for_each_variable_do(RetainIterator);
#define __RegisterDebugVariable_case_t(TYPENAME) \
((__IEC_##TYPENAME##_t *)varp)->flags |= flags;\
((__IEC_##TYPENAME##_t *)varp)->value = *((TYPENAME *)force);\
#define __RegisterDebugVariable_case_p(TYPENAME)\
case TYPENAME##_P_ENUM :\
((__IEC_##TYPENAME##_p *)varp)->flags |= flags;\
((__IEC_##TYPENAME##_p *)varp)->fvalue = *((TYPENAME *)force);\
case TYPENAME##_O_ENUM :\
((__IEC_##TYPENAME##_p *)varp)->flags |= flags;\
((__IEC_##TYPENAME##_p *)varp)->fvalue = *((TYPENAME *)force);\
*(((__IEC_##TYPENAME##_p *)varp)->value) = *((TYPENAME *)force);\
void RegisterDebugVariable(int idx, void* force)
unsigned char flags = force ? __IEC_DEBUG_FLAG | __IEC_FORCE_FLAG : __IEC_DEBUG_FLAG;
switch(__find_variable(idx, &varp)){
__ANY(__RegisterDebugVariable_case_t)
__ANY(__RegisterDebugVariable_case_p)
#define __ResetDebugVariablesIterator_case_t(TYPENAME) \
((__IEC_##TYPENAME##_t *)varp)->flags &= ~(__IEC_DEBUG_FLAG|__IEC_FORCE_FLAG);\
#define __ResetDebugVariablesIterator_case_p(TYPENAME)\
case TYPENAME##_P_ENUM :\
case TYPENAME##_O_ENUM :\
((__IEC_##TYPENAME##_p *)varp)->flags &= ~(__IEC_DEBUG_FLAG|__IEC_FORCE_FLAG);\
void ResetDebugVariablesIterator(void* varp, __IEC_types_enum vartype)
/* force debug flag to 0*/
__ANY(__ResetDebugVariablesIterator_case_t)
__ANY(__ResetDebugVariablesIterator_case_p)
void ResetDebugVariables(void)
__for_each_variable_do(ResetDebugVariablesIterator);
/* atomically mark buffer as free */
latest_state = AtomicCompareExchange(
int WaitDebugData(unsigned long *tick);
/* Wait until debug data ready and return pointer to it */
int GetDebugData(unsigned long *tick, unsigned long *size, void **buffer){
int wait_error = WaitDebugData(tick);
*size = buffer_cursor - debug_buffer;
uint32_t LogMessageCount = 0;
int LogMessage(char* Message){
LogMessageCount = __sync_add_and_fetch(&LogMessageCount, 1);