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

#ifdef TARGET_DEBUG_AND_RETAIN_DISABLE

    14

    15

void __init_debug    (void){}

    16

void __cleanup_debug (void){}

    17

void __retrieve_debug(void){}

    18

void __publish_debug (void){}

    19

    20

#else

    21

    22

#include "iec_types_all.h"

    23

#include "POUS.h"

    24

/*for memcpy*/

    25

#include <string.h>

    26

#include <stdio.h>

    27

    28

#ifndef TARGET_ONLINE_DEBUG_DISABLE

    29

#define BUFFER_SIZE %(buffer_size)d

    30

    31

/* Atomically accessed variable for buffer state */

    32

#define BUFFER_FREE 0

    33

#define BUFFER_BUSY 1

    34

static long buffer_state = BUFFER_FREE;

    35

    36

/* The buffer itself */

    37

char debug_buffer[BUFFER_SIZE];

    38

    39

/* Buffer's cursor*/

    40

static char* buffer_cursor = debug_buffer;

    41

#endif

    42

    43

static unsigned int retain_offset = 0;

    44

/***

    45

 * Declare programs 

    46

 **/

    47

%(programs_declarations)s

    48

    49

/***

    50

 * Declare global variables from resources and conf 

    51

 **/

    52

%(extern_variables_declarations)s

    53

    54

typedef const struct {

    55

    void *ptr;

    56

    __IEC_types_enum type;

    57

} dbgvardsc_t;

    58

    59

static dbgvardsc_t dbgvardsc[] = {

    60

%(variable_decl_array)s

    61

};

    62

    63

typedef void(*__for_each_variable_do_fp)(dbgvardsc_t*);

    64

void __for_each_variable_do(__for_each_variable_do_fp fp)

    65

{

    66

    unsigned int i;

    67

    for(i = 0; i < sizeof(dbgvardsc)/sizeof(dbgvardsc_t); i++){

    68

        dbgvardsc_t *dsc = &dbgvardsc[i];

    69

        if(dsc->type != UNKNOWN_ENUM) 

    70

            (*fp)(dsc);

    71

    }

    72

}

    73

    74

#define __Unpack_desc_type dbgvardsc_t

    75

    76

%(var_access_code)s

    77

    78

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

    79

    80

void RemindIterator(dbgvardsc_t *dsc)

    81

{

    82

    void *real_value_p = NULL;

    83

    char flags = 0;

    84

    UnpackVar(dsc, &real_value_p, &flags);

    85

    86

    if(flags & __IEC_RETAIN_FLAG){

    87

        USINT size = __get_type_enum_size(dsc->type);

    88

        /* compute next cursor positon*/

    89

        unsigned int next_retain_offset = retain_offset + size;

    90

        /* if buffer not full */

    91

        Remind(retain_offset, size, real_value_p);

    92

        /* increment cursor according size*/

    93

        retain_offset = next_retain_offset;

    94

    }

    95

}

    96

    97

extern int CheckRetainBuffer(void);

    98

extern void InitRetain(void);

    99

   100

void __init_debug(void)

   101

{

   102

    /* init local static vars */

   103

#ifndef TARGET_ONLINE_DEBUG_DISABLE

   104

    buffer_cursor = debug_buffer;

   105

    buffer_state = BUFFER_FREE;

   106

#endif

   107

   108

    retain_offset = 0;

   109

    InitRetain();

   110

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

   111

    if(CheckRetainBuffer()){

   112

        __for_each_variable_do(RemindIterator);

   113

    }else{

   114

        char mstr[] = "RETAIN memory invalid - defaults used";

   115

        LogMessage(LOG_WARNING, mstr, sizeof(mstr));

   116

    }

   117

    retain_offset = 0;

   118

}

   119

   120

extern void InitiateDebugTransfer(void);

   121

extern void CleanupRetain(void);

   122

   123

extern unsigned long __tick;

   124

   125

void __cleanup_debug(void)

   126

{

   127

#ifndef TARGET_ONLINE_DEBUG_DISABLE

   128

    buffer_cursor = debug_buffer;

   129

    InitiateDebugTransfer();

   130

#endif    

   131

   132

    CleanupRetain();

   133

}

   134

   135

void __retrieve_debug(void)

   136

{

   137

}

   138

   139

   140

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

   141

   142

static inline void BufferIterator(dbgvardsc_t *dsc, int do_debug)

   143

{

   144

    void *real_value_p = NULL;

   145

    void *visible_value_p = NULL;

   146

    char flags = 0;

   147

   148

    visible_value_p = UnpackVar(dsc, &real_value_p, &flags);

   149

   150

    if(flags & ( __IEC_DEBUG_FLAG | __IEC_RETAIN_FLAG)){

   151

        USINT size = __get_type_enum_size(dsc->type);

   152

   153

#ifndef TARGET_ONLINE_DEBUG_DISABLE

   154

        if(flags & __IEC_DEBUG_FLAG){

   155

            /* copy visible variable to buffer */;

   156

            if(do_debug){

   157

                /* compute next cursor positon.

   158

                   No need to check overflow, as BUFFER_SIZE

   159

                   is computed large enough */

   160

                if(__Is_a_string(dsc)){

   161

                    /* optimization for strings */

   162

                    size = ((STRING*)visible_value_p)->len + 1;

   163

                }

   164

                char* next_cursor = buffer_cursor + size;

   165

                /* copy data to the buffer */

   166

                memcpy(buffer_cursor, visible_value_p, size);

   167

                /* increment cursor according size*/

   168

                buffer_cursor = next_cursor;

   169

            }

   170

            /* re-force real value of outputs (M and Q)*/

   171

            if((flags & __IEC_FORCE_FLAG) && (flags & __IEC_OUTPUT_FLAG)){

   172

                memcpy(real_value_p, visible_value_p, size);

   173

            }

   174

        }

   175

#endif

   176

   177

        if(flags & __IEC_RETAIN_FLAG){

   178

            /* compute next cursor positon*/

   179

            unsigned int next_retain_offset = retain_offset + size;

   180

            /* if buffer not full */

   181

            Retain(retain_offset, size, real_value_p);

   182

            /* increment cursor according size*/

   183

            retain_offset = next_retain_offset;

   184

        }

   185

    }

   186

}

   187

   188

void DebugIterator(dbgvardsc_t *dsc){

   189

    BufferIterator(dsc, 1);

   190

}

   191

   192

void RetainIterator(dbgvardsc_t *dsc){

   193

    BufferIterator(dsc, 0);

   194

}

   195

   196

   197

unsigned int retain_size = 0;

   198

   199

/* GetRetainSizeIterator */

   200

void GetRetainSizeIterator(dbgvardsc_t *dsc)

   201

{

   202

    void *real_value_p = NULL;

   203

    char flags = 0;

   204

    UnpackVar(dsc, &real_value_p, &flags);

   205

   206

    if(flags & __IEC_RETAIN_FLAG){

   207

        USINT size = __get_type_enum_size(dsc->type);

   208

        /* Calc retain buffer size */

   209

        retain_size += size;

   210

    }

   211

}

   212

   213

/* Return size of all retain variables */

   214

unsigned int GetRetainSize(void)

   215

{

   216

    __for_each_variable_do(GetRetainSizeIterator);

   217

    return retain_size;

   218

}

   219

   220

   221

extern void PLC_GetTime(IEC_TIME*);

   222

extern int TryEnterDebugSection(void);

   223

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

   224

extern long long AtomicCompareExchange64(long long* , long long , long long);

   225

extern void LeaveDebugSection(void);

   226

extern void ValidateRetainBuffer(void);

   227

extern void InValidateRetainBuffer(void);

   228

   229

void __publish_debug(void)

   230

{

   231

    retain_offset = 0;

   232

    InValidateRetainBuffer();

   233

   234

#ifndef TARGET_ONLINE_DEBUG_DISABLE 

   235

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

   236

    if(TryEnterDebugSection()){

   237

        /* Lock buffer */

   238

        long latest_state = AtomicCompareExchange(

   239

            &buffer_state,

   240

            BUFFER_FREE,

   241

            BUFFER_BUSY);

   242

   243

        /* If buffer was free */

   244

        if(latest_state == BUFFER_FREE)

   245

        {

   246

            /* Reset buffer cursor */

   247

            buffer_cursor = debug_buffer;

   248

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

   249

            __for_each_variable_do(DebugIterator);

   250

   251

            /* Leave debug section,

   252

             * Trigger asynchronous transmission 

   253

             * (returns immediately) */

   254

            InitiateDebugTransfer(); /* size */

   255

        }else{

   256

            /* when not debugging, do only retain */

   257

            __for_each_variable_do(RetainIterator);

   258

        }

   259

        LeaveDebugSection();

   260

    }else

   261

#endif

   262

    {

   263

        /* when not debugging, do only retain */

   264

        __for_each_variable_do(RetainIterator);

   265

    }

   266

    ValidateRetainBuffer();

   267

}

   268

   269

#ifndef TARGET_ONLINE_DEBUG_DISABLE

   270

#define __RegisterDebugVariable_case_t(TYPENAME) \

   271

        case TYPENAME##_ENUM :\

   272

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

   273

            if(force)\

   274

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

   275

            break;

   276

#define __RegisterDebugVariable_case_p(TYPENAME)\

   277

        case TYPENAME##_P_ENUM :\

   278

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

   279

            if(force)\

   280

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

   281

            break;\

   282

        case TYPENAME##_O_ENUM :\

   283

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

   284

            if(force){\

   285

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

   286

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

   287

            }\

   288

            break;

   289

void RegisterDebugVariable(unsigned int idx, void* force)

   290

{

   291

    if(idx  < sizeof(dbgvardsc)/sizeof(dbgvardsc_t)){

   292

        unsigned char flags = force ?

   293

            __IEC_DEBUG_FLAG | __IEC_FORCE_FLAG :

   294

            __IEC_DEBUG_FLAG;

   295

        dbgvardsc_t *dsc = &dbgvardsc[idx];

   296

        void *varp = dsc->ptr;

   297

        switch(dsc->type){

   298

            __ANY(__RegisterDebugVariable_case_t)

   299

            __ANY(__RegisterDebugVariable_case_p)

   300

        default:

   301

            break;

   302

        }

   303

    }

   304

}

   305

   306

#define __ResetDebugVariablesIterator_case_t(TYPENAME) \

   307

        case TYPENAME##_ENUM :\

   308

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

   309

            break;

   310

   311

#define __ResetDebugVariablesIterator_case_p(TYPENAME)\

   312

        case TYPENAME##_P_ENUM :\

   313

        case TYPENAME##_O_ENUM :\

   314

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

   315

            break;

   316

   317

void ResetDebugVariablesIterator(dbgvardsc_t *dsc)

   318

{

   319

    /* force debug flag to 0*/

   320

    void *varp = dsc->ptr;

   321

    switch(dsc->type){

   322

        __ANY(__ResetDebugVariablesIterator_case_t)

   323

        __ANY(__ResetDebugVariablesIterator_case_p)

   324

    default:

   325

        break;

   326

    }

   327

}

   328

   329

void ResetDebugVariables(void)

   330

{

   331

    __for_each_variable_do(ResetDebugVariablesIterator);

   332

}

   333

   334

void FreeDebugData(void)

   335

{

   336

    /* atomically mark buffer as free */

   337

    AtomicCompareExchange(

   338

        &buffer_state,

   339

        BUFFER_BUSY,

   340

        BUFFER_FREE);

   341

}

   342

int WaitDebugData(unsigned long *tick);

   343

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

   344

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

   345

    int wait_error = WaitDebugData(tick);

   346

    if(!wait_error){

   347

        *size = buffer_cursor - debug_buffer;

   348

        *buffer = debug_buffer;

   349

    }

   350

    return wait_error;

   351

}

   352

#endif

   353

#endif

   354