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

        case TYPENAME##_O_ENUM :\

    68

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

    69

            if (*flags & __IEC_FORCE_FLAG)\

    70

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

    71

            else\

    72

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

    73

            break;

    74

    75

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

    76

{

    77

    /* find data to copy*/

    78

    switch(vartype){

    79

        ANY(__BufferDebugDataIterator_case_t)

    80

        ANY(__BufferDebugDataIterator_case_p)

    81

    default:

    82

        break;

    83

    }

    84

}

    85

    86

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

    87

    88

void RemindIterator(void* varp, __IEC_types_enum vartype)

    89

{

    90

    void *ptrvalue = NULL;

    91

    char flags = 0;

    92

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

    93

    94

    if(flags & __IEC_RETAIN_FLAG){

    95

        USINT size = __get_type_enum_size(vartype);

    96

        /* compute next cursor positon*/

    97

        unsigned int next_retain_offset = retain_offset + size;

    98

        /* if buffer not full */

    99

        Remind(retain_offset, size, ptrvalue);

   100

        /* increment cursor according size*/

   101

        retain_offset = next_retain_offset;

   102

    }

   103

}

   104

   105

void __init_debug(void)

   106

{

   107

    /* init local static vars */

   108

    buffer_cursor = debug_buffer;

   109

    retain_offset = 0;

   110

    buffer_state = BUFFER_FREE;

   111

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

   112

    __for_each_variable_do(RemindIterator);

   113

    retain_offset = 0;

   114

}

   115

   116

extern void InitiateDebugTransfer(void);

   117

   118

extern unsigned long __tick;

   119

   120

void __cleanup_debug(void)

   121

{

   122

    buffer_cursor = debug_buffer;

   123

    InitiateDebugTransfer();

   124

}

   125

   126

void __retrieve_debug(void)

   127

{

   128

}

   129

   130

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

   131

{

   132

    /* compute next cursor positon*/

   133

    char* next_cursor = buffer_cursor + size;

   134

    /* if buffer not full */

   135

    if(next_cursor <= debug_buffer + BUFFER_SIZE)

   136

    {

   137

        /* copy data to the buffer */

   138

        memcpy(buffer_cursor, ptrvalue, size);

   139

        /* increment cursor according size*/

   140

        buffer_cursor = next_cursor;

   141

    }else{

   142

        /*TODO : signal overflow*/

   143

    }

   144

}

   145

   146

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

   147

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

   148

    /* compute next cursor positon*/

   149

    unsigned int next_retain_offset = retain_offset + size;

   150

    /* if buffer not full */

   151

    Retain(retain_offset, size, ptrvalue);

   152

    /* increment cursor according size*/

   153

    retain_offset = next_retain_offset;

   154

}

   155

   156

void BufferDebugDataIterator(void* varp, __IEC_types_enum vartype)

   157

{

   158

    void *ptrvalue = NULL;

   159

    char flags = 0;

   160

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

   161

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

   162

    if(flags & (__IEC_DEBUG_FLAG | __IEC_RETAIN_FLAG)){

   163

        USINT size = __get_type_enum_size(vartype);

   164

        if(flags & __IEC_DEBUG_FLAG){

   165

            DoDebug(ptrvalue, flags, size);

   166

        }

   167

        if(flags & __IEC_RETAIN_FLAG){

   168

            DoRetain(ptrvalue, flags, size);

   169

        }

   170

    }

   171

}

   172

   173

void RetainIterator(void* varp, __IEC_types_enum vartype)

   174

{

   175

    void *ptrvalue = NULL;

   176

    char flags = 0;

   177

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

   178

   179

    if(flags & __IEC_RETAIN_FLAG){

   180

        USINT size = __get_type_enum_size(vartype);

   181

        DoRetain(ptrvalue, flags, size);

   182

    }

   183

}

   184

   185

extern int TryEnterDebugSection(void);

   186

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

   187

extern void LeaveDebugSection(void);

   188

   189

void __publish_debug(void)

   190

{

   191

    retain_offset = 0;

   192

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

   193

    if(TryEnterDebugSection()){

   194

        /* Lock buffer */

   195

        long latest_state = AtomicCompareExchange(

   196

            &buffer_state,

   197

            BUFFER_FREE,

   198

            BUFFER_BUSY);

   199

   200

        /* If buffer was free */

   201

        if(latest_state == BUFFER_FREE)

   202

        {

   203

            /* Reset buffer cursor */

   204

            buffer_cursor = debug_buffer;

   205

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

   206

            __for_each_variable_do(BufferDebugDataIterator);

   207

   208

            /* Leave debug section,

   209

             * Trigger asynchronous transmission 

   210

             * (returns immediately) */

   211

            InitiateDebugTransfer(); /* size */

   212

        }

   213

        LeaveDebugSection();

   214

    }else{

   215

        /* when not debugging, do only retain */

   216

        __for_each_variable_do(RetainIterator);

   217

    }

   218

}

   219

   220

#define __RegisterDebugVariable_case_t(TYPENAME) \

   221

        case TYPENAME##_ENUM :\

   222

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

   223

            if(force)\

   224

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

   225

            break;

   226

#define __RegisterDebugVariable_case_p(TYPENAME)\

   227

        case TYPENAME##_P_ENUM :\

   228

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

   229

            if(force)\

   230

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

   231

            break;\

   232

        case TYPENAME##_O_ENUM :\

   233

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

   234

            if(force)\

   235

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

   236

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

   237

            break;

   238

void RegisterDebugVariable(int idx, void* force)

   239

{

   240

    void *varp = NULL;

   241

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

   242

    switch(__find_variable(idx, &varp)){

   243

        ANY(__RegisterDebugVariable_case_t)

   244

        ANY(__RegisterDebugVariable_case_p)

   245

    default:

   246

        break;

   247

    }

   248

}

   249

   250

#define __ResetDebugVariablesIterator_case_t(TYPENAME) \

   251

        case TYPENAME##_ENUM :\

   252

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

   253

            break;

   254

   255

#define __ResetDebugVariablesIterator_case_p(TYPENAME)\

   256

        case TYPENAME##_P_ENUM :\

   257

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

   258

            break;

   259

   260

void ResetDebugVariablesIterator(void* varp, __IEC_types_enum vartype)

   261

{

   262

    /* force debug flag to 0*/

   263

    switch(vartype){

   264

        ANY(__ResetDebugVariablesIterator_case_t)

   265

        ANY(__ResetDebugVariablesIterator_case_p)

   266

    default:

   267

        break;

   268

    }

   269

}

   270

   271

void ResetDebugVariables(void)

   272

{

   273

    __for_each_variable_do(ResetDebugVariablesIterator);

   274

}

   275

   276

void FreeDebugData(void)

   277

{

   278

    /* atomically mark buffer as free */

   279

    long latest_state;

   280

    latest_state = AtomicCompareExchange(

   281

        &buffer_state,

   282

        BUFFER_BUSY,

   283

        BUFFER_FREE);

   284

}

   285

int WaitDebugData(unsigned long *tick);

   286

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

   287

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

   288

    int wait_error = WaitDebugData(tick);

   289

    if(!wait_error){

   290

        *size = buffer_cursor - debug_buffer;

   291

        *buffer = debug_buffer;

   292

    }

   293

    return wait_error;

   294

}

   295