1

/*

     2

 * DEBUGGER code

     3

 * 

     4

 * On "publish", when buffer is free, debugger stores arbitrary variables 

     5

 * content into, and mark this buffer as filled

     6

 * 

     7

 * 

     8

 * Buffer content is read asynchronously, (from non real time part), 

     9

 * and then buffer marked free again.

    10

 *  

    11

 * 

    12

 * */

    13

#include "iec_types_all.h"

    14

#include "POUS.h"

    15

/*for memcpy*/

    16

#include <string.h>

    17

#include <stdio.h>

    18

    19

#define BUFFER_SIZE %(buffer_size)d

    20

#define MAX_SUBSCRIBTION %(subscription_table_count)d

    21

    22

/* Atomically accessed variable for buffer state */

    23

#define BUFFER_FREE 0

    24

#define BUFFER_BUSY 1

    25

static long buffer_state = BUFFER_FREE;

    26

    27

/* The buffer itself */

    28

char debug_buffer[BUFFER_SIZE];

    29

    30

/* Buffer's cursor*/

    31

static char* buffer_cursor = debug_buffer;

    32

    33

/***

    34

 * Declare programs 

    35

 **/

    36

%(programs_declarations)s

    37

    38

/***

    39

 * Declare global variables from resources and conf 

    40

 **/

    41

%(extern_variables_declarations)s

    42

    43

typedef void(*__for_each_variable_do_fp)(void*, __IEC_types_enum);

    45

{

    46

%(for_each_variable_do_code)s

    47

}

    48

    49

__IEC_types_enum __find_variable(unsigned int varindex, void ** varp)

    50

{

    51

    switch(varindex){

    52

%(find_variable_case_code)s

    57

}

    58

    59

void __init_debug(void)

    60

{

    61

    buffer_state = BUFFER_FREE;

    62

}

    63

    64

void __cleanup_debug(void)

    65

{

    66

}

    67

    68

void __retrieve_debug(void)

    69

{

    70

}

    71

    72

extern int TryEnterDebugSection(void);

    73

extern void LeaveDebugSection(void);

    74

extern long AtomicCompareExchange(long*, long, long);

    75

extern void InitiateDebugTransfer(void);

    76

    77

extern unsigned long __tick;

    78

    79

#define __BufferDebugDataIterator_case_t(TYPENAME) \

    80

        case TYPENAME##_ENUM :\

    81

            flags = ((__IEC_##TYPENAME##_t *)varp)->flags;\

    82

            ptrvalue = &((__IEC_##TYPENAME##_t *)varp)->value;

    83

    84

#define __BufferDebugDataIterator_case_p(TYPENAME)\

    85

        case TYPENAME##_P_ENUM :\

    86

            flags = ((__IEC_##TYPENAME##_p *)varp)->flags;\

    87

            ptrvalue = ((__IEC_##TYPENAME##_p *)varp)->value;

    88

    89

void BufferDebugDataIterator(void* varp, __IEC_types_enum vartype)

    90

{

    91

    void *ptrvalue = NULL;

    92

    char flags = 0;

    93

    /* find data to copy*/

    94

    switch(vartype){

    95

        ANY(__BufferDebugDataIterator_case_t)

    96

        ANY(__BufferDebugDataIterator_case_p)

    99

    }

   100

    if(flags && __IEC_DEBUG_FLAG){

   101

        USINT size = __get_type_enum_size(vartype);

   102

        /* compute next cursor positon*/

   103

        char* next_cursor = buffer_cursor + size;

   104

        /* if buffer not full */

   105

        if(next_cursor <= debug_buffer + BUFFER_SIZE)

   106

        {

   107

            /* copy data to the buffer */

   108

            memcpy(buffer_cursor, ptrvalue, size);

   109

            /* increment cursor according size*/

   110

            buffer_cursor = next_cursor;

   111

        }else{

   112

            /*TODO : signal overflow*/

   113

        }

   114

    }

   115

}

   116

   117

   118

void __publish_debug(void)

   119

{

   120

    /* Check there is no running debugger re-configuration */

   121

    if(TryEnterDebugSection()){

   122

        /* Lock buffer */

   123

        long latest_state = AtomicCompareExchange(

   124

            &buffer_state,

   125

            BUFFER_FREE,

   126

            BUFFER_BUSY);

   127

   128

        /* If buffer was free */

   129

        if(latest_state == BUFFER_FREE)

   130

        {

   131

            /* Reset buffer cursor */

   132

            buffer_cursor = debug_buffer;

   133

            /* Iterate over all variables to fill debug buffer */

   134

            __for_each_variable_do(BufferDebugDataIterator);

   135

   136

            /* Leave debug section,

   137

             * Trigger asynchronous transmission 

   138

             * (returns immediately) */

   139

            InitiateDebugTransfer(); /* size */

   140

        }

   141

        LeaveDebugSection();

   142

    }

   143

}

   144

   145

#define __RegisterDebugVariable_case_t(TYPENAME) \

   146

        case TYPENAME##_ENUM :\

   147

            ((__IEC_##TYPENAME##_t *)varp)->flags |= __IEC_DEBUG_FLAG;

   148

#define __RegisterDebugVariable_case_p(TYPENAME)\

   149

        case TYPENAME##_P_ENUM :\

   150

            ((__IEC_##TYPENAME##_p *)varp)->flags |= __IEC_DEBUG_FLAG;

   151

void RegisterDebugVariable(int idx)

   152

{

   154

    switch(__find_variable(idx, varp)){

   155

        ANY(__RegisterDebugVariable_case_t)

   156

        ANY(__RegisterDebugVariable_case_p)

   159

    }

   160

}

   161

   162

#define __ResetDebugVariablesIterator_case_t(TYPENAME) \

   163

        case TYPENAME##_ENUM :\

   164

            ((__IEC_##TYPENAME##_t *)varp)->flags &= ~__IEC_DEBUG_FLAG;

   165

   166

#define __ResetDebugVariablesIterator_case_p(TYPENAME)\

   167

        case TYPENAME##_P_ENUM :\

   168

            ((__IEC_##TYPENAME##_p *)varp)->flags &= ~__IEC_DEBUG_FLAG;\

   169

   170

void ResetDebugVariablesIterator(void* varp, __IEC_types_enum vartype)

   171

{

   172

    /* force debug flag to 0*/

   173

    switch(vartype){

   174

        ANY(__ResetDebugVariablesIterator_case_t)

   175

        ANY(__ResetDebugVariablesIterator_case_p)

   178

    }

   179

}

   180

   181

void ResetDebugVariables(void)

   182

{

   183

    __for_each_variable_do(ResetDebugVariablesIterator);

   184

}

   185

   186

void FreeDebugData(void)

   187

{

   188

    /* atomically mark buffer as free */

   189

    long latest_state;

   190

    latest_state = AtomicCompareExchange(

   191

        &buffer_state,

   192

        BUFFER_BUSY,

   193

        BUFFER_FREE);

   194

}

   196

/* Wait until debug data ready and return pointer to it */

   197

int GetDebugData(unsigned long *tick, unsigned long *size, void **buffer){

   198

    int res = WaitDebugData(tick);

   199

    *size = buffer_cursor - debug_buffer;

   200

    *buffer = NULL;

   201

    return res;

   202

}

   203