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

static unsigned int retain_offset = 0;

    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);

    44

void __for_each_variable_do(__for_each_variable_do_fp fp)

    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

    53

     default:

    54

      *varp = NULL;

    55

      return UNKNOWN_ENUM;

    56

    }

    57

}

    58

    59

#define __BufferDebugDataIterator_case_t(TYPENAME) \

    60

        case TYPENAME##_ENUM :\

    61

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

    62

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

    63

            break;

    64

    65

#define __BufferDebugDataIterator_case_p(TYPENAME)\

    66

        case TYPENAME##_P_ENUM :\

    67

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

    68

            if (*flags & __IEC_FORCE_FLAG)\

    69

               *ptrvalue = &((__IEC_##TYPENAME##_p *)varp)->fvalue;\

    70

            else\

    71

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

    72

            break;

    73

    74

void UnpackVar(void* varp, __IEC_types_enum vartype, void **ptrvalue, char *flags)

    75

{

    76

    /* find data to copy*/

    77

    switch(vartype){

    78

        ANY(__BufferDebugDataIterator_case_t)

    79

        ANY(__BufferDebugDataIterator_case_p)

    80

    default:

    81

        break;

    82

    }

    83

}

    84

    85

void Remind(unsigned int offset, unsigned int count, void * p);

    86

    87

void RemindIterator(void* varp, __IEC_types_enum vartype)

    88

{

    89

    void *ptrvalue = NULL;

    90

    char flags = 0;

    91

    UnpackVar(varp, vartype, &ptrvalue, &flags);

    92

    93

    if(flags & __IEC_RETAIN_FLAG){

    94

        USINT size = __get_type_enum_size(vartype);

    95

        /* compute next cursor positon*/

    96

        unsigned int next_retain_offset = retain_offset + size;

    97

        /* if buffer not full */

    98

        Remind(retain_offset, size, ptrvalue);

    99

        /* increment cursor according size*/

   100

        retain_offset = next_retain_offset;

   101

    }

   102

}

   103

   104

void __init_debug(void)

   105

{

   106

    /* init local static vars */

   107

    buffer_cursor = debug_buffer;

   108

    retain_offset = 0;

   109

    buffer_state = BUFFER_FREE;

   110

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

   111

    __for_each_variable_do(RemindIterator);

   112

    retain_offset = 0;

   113

}

   114

   115

extern void InitiateDebugTransfer(void);

   116

   117

extern unsigned long __tick;

   118

   119

void __cleanup_debug(void)

   120

{

   121

    buffer_cursor = debug_buffer;

   122

    InitiateDebugTransfer();

   123

}

   124

   125

void __retrieve_debug(void)

   126

{

   127

}

   128

   129

void DoDebug(void *ptrvalue, char flags, USINT size)

   130

{

   131

    /* compute next cursor positon*/

   132

    char* next_cursor = buffer_cursor + size;

   133

    /* if buffer not full */

   134

    if(next_cursor <= debug_buffer + BUFFER_SIZE)

   135

    {

   136

        /* copy data to the buffer */

   137

        memcpy(buffer_cursor, ptrvalue, size);

   138

        /* increment cursor according size*/

   139

        buffer_cursor = next_cursor;

   140

    }else{

   141

        /*TODO : signal overflow*/

   142

    }

   143

}

   144

   145

void Retain(unsigned int offset, unsigned int count, void * p);

   146

void DoRetain(void *ptrvalue, char flags, USINT size){

   147

    /* compute next cursor positon*/

   148

    unsigned int next_retain_offset = retain_offset + size;

   149

    /* if buffer not full */

   150

    Retain(retain_offset, size, ptrvalue);

   151

    /* increment cursor according size*/

   152

    retain_offset = next_retain_offset;

   153

}

   154

   155

void BufferDebugDataIterator(void* varp, __IEC_types_enum vartype)

   156

{

   157

    void *ptrvalue = NULL;

   158

    char flags = 0;

   159

    UnpackVar(varp, vartype, &ptrvalue, &flags);

   160

    /* For optimization purpose we do retain and debug in the same pass */

   161

    if(flags & (__IEC_DEBUG_FLAG | __IEC_RETAIN_FLAG)){

   162

        USINT size = __get_type_enum_size(vartype);

   163

        if(flags & __IEC_DEBUG_FLAG){

   164

            DoDebug(ptrvalue, flags, size);

   165

        }

   166

        if(flags & __IEC_RETAIN_FLAG){

   167

            DoRetain(ptrvalue, flags, size);

   168

        }

   169

    }

   170

}

   171

   172

void RetainIterator(void* varp, __IEC_types_enum vartype)

   173

{

   174

    void *ptrvalue = NULL;

   175

    char flags = 0;

   176

    UnpackVar(varp, vartype, &ptrvalue, &flags);

   177

   178

    if(flags & __IEC_RETAIN_FLAG){

   179

        USINT size = __get_type_enum_size(vartype);

   180

        DoRetain(ptrvalue, flags, size);

   181

    }

   182

}

   183

   184

extern int TryEnterDebugSection(void);

   185

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

   186

extern void LeaveDebugSection(void);

   187

   188

void __publish_debug(void)

   189

{

   190

    retain_offset = 0;

   191

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

   192

    if(TryEnterDebugSection()){

   193

        /* Lock buffer */

   194

        long latest_state = AtomicCompareExchange(

   195

            &buffer_state,

   196

            BUFFER_FREE,

   197

            BUFFER_BUSY);

   198

   199

        /* If buffer was free */

   200

        if(latest_state == BUFFER_FREE)

   201

        {

   202

            /* Reset buffer cursor */

   203

            buffer_cursor = debug_buffer;

   204

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

   205

            __for_each_variable_do(BufferDebugDataIterator);

   206

   207

            /* Leave debug section,

   208

             * Trigger asynchronous transmission 

   209

             * (returns immediately) */

   210

            InitiateDebugTransfer(); /* size */

   211

        }

   212

        LeaveDebugSection();

   213

    }else{

   214

        /* when not debugging, do only retain */

   215

        __for_each_variable_do(RetainIterator);

   216

    }

   217

}

   218

   219

#define __RegisterDebugVariable_case_t(TYPENAME) \

   220

        case TYPENAME##_ENUM :\

   221

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

   222

            if(force)\

   223

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

   224

            break;

   225

#define __RegisterDebugVariable_case_p(TYPENAME)\

   226

        case TYPENAME##_P_ENUM :\

   227

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

   228

            if(force)\

   229

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

   230

            break;

   231

void RegisterDebugVariable(int idx, void* force)

   232

{

   233

    void *varp = NULL;

   234

    unsigned char flags = force ? __IEC_DEBUG_FLAG | __IEC_FORCE_FLAG : __IEC_DEBUG_FLAG;

   235

    switch(__find_variable(idx, &varp)){

   236

        ANY(__RegisterDebugVariable_case_t)

   237

        ANY(__RegisterDebugVariable_case_p)

   238

    default:

   239

        break;

   240

    }

   241

}

   242

   243

#define __ResetDebugVariablesIterator_case_t(TYPENAME) \

   244

        case TYPENAME##_ENUM :\

   245

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

   246

            break;

   247

   248

#define __ResetDebugVariablesIterator_case_p(TYPENAME)\

   249

        case TYPENAME##_P_ENUM :\

   250

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

   251

            break;

   252

   253

void ResetDebugVariablesIterator(void* varp, __IEC_types_enum vartype)

   254

{

   255

    /* force debug flag to 0*/

   256

    switch(vartype){

   257

        ANY(__ResetDebugVariablesIterator_case_t)

   258

        ANY(__ResetDebugVariablesIterator_case_p)

   259

    default:

   260

        break;

   261

    }

   262

}

   263

   264

void ResetDebugVariables(void)

   265

{

   266

    __for_each_variable_do(ResetDebugVariablesIterator);

   267

}

   268

   269

void FreeDebugData(void)

   270

{

   271

    /* atomically mark buffer as free */

   272

    long latest_state;

   273

    latest_state = AtomicCompareExchange(

   274

        &buffer_state,

   275

        BUFFER_BUSY,

   276

        BUFFER_FREE);

   277

}

   278

int WaitDebugData(unsigned long *tick);

   279

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

   280

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

   281

    int wait_error = WaitDebugData(tick);

   282

    if(!wait_error){

   283

        *size = buffer_cursor - debug_buffer;

   284

        *buffer = debug_buffer;

   285

    }

   286

    return wait_error;

   287

}

   288