runtime/plc_debug.c
author etisserant
Wed, 20 Aug 2008 00:11:40 +0200
changeset 203 cb9901076a21
permissions -rw-r--r--
Added concepts :
- connector class (for PLC control, debug and flashing abstraction).
- builder class (C toolchain abstraction)

Added features :
- Pyro based connector.
- ctypes loader, load PLC shared object and run it
- ctypes based debugger embryo (not tested)
- gcc builder

Broken:
- Win32 runtime
- Most tests
203
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
     1
/*
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
     2
 * DEBUGGER code
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
     3
 * 
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
     4
 * On "publish", when buffer is free, debugger stores arbitrary variables 
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
     5
 * content into, and mark this buffer as filled
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
     6
 * 
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
     7
 * 
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
     8
 * Buffer content is read asynchronously, (from non real time part), 
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
     9
 * and then buffer marked free again.
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    10
 *  
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    11
 * 
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    12
 * */
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    13
#include "iec_types_all.h"
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    14
#include "POUS.h"
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    15
/*for memcpy*/
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    16
#include <string.h>
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    17
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    18
#define BUFFER_SIZE 1024
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    19
#define MAX_SUBSCRIBTION %(subscription_table_count)d
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    20
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    21
/* Atomically accessed variable for buffer state */
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    22
#define BUFFER_FREE 0
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    23
#define BUFFER_BUSY 1
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    24
static long buffer_state = BUFFER_FREE;
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    25
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    26
/* The buffer itself */
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    27
char debug_buffer[BUFFER_SIZE];
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    28
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    29
/* Buffer's cursor*/
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    30
static char* buffer_cursor = debug_buffer;
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    31
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    32
typedef struct{
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    33
    void* ptrvalue;
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    34
    __IEC_types_enum type;
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    35
}struct_plcvar;
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    36
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    37
/***
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    38
 * Declare programs 
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    39
 **/
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    40
%(programs_declarations)s
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    41
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    42
/***
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    43
 * Declare global variables from resources and conf 
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    44
 **/
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    45
%(extern_variables_declarations)s
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    46
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    47
static int subscription_table[MAX_SUBSCRIBTION];
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    48
static int* latest_subscription = subscription_table;
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    49
static int* subscription_cursor = subscription_table;
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    50
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    51
struct_plcvar variable_table[%(variables_pointer_type_table_count)d];
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    52
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    53
void __init_debug()
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    54
{
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    55
%(variables_pointer_type_table_initializer)s
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    56
};
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    57
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    58
void __cleanup_debug()
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    59
{
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    60
}
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    61
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    62
void __retrieve_debug()
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    63
{
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    64
}
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    65
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    66
void __publish_debug()
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    67
{
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    68
    /* Lock buffer */
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    69
    long latest_state = AtomicCompareExchange(
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    70
        &buffer_state,
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    71
        BUFFER_FREE,
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    72
        BUFFER_BUSY);
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    73
        
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    74
    /* If buffer was free */
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    75
    if(latest_state == BUFFER_FREE)
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    76
    {
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    77
        int* subscription;
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    78
        
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    79
        /* Reset buffer cursor */
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    80
        buffer_cursor = debug_buffer;
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    81
        
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    82
        /* iterate over subscriptions */
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    83
        for(subscription=subscription_table;
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    84
            subscription < latest_subscription;
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    85
            subscription++)
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    86
        {
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    87
            /* get variable descriptor */
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    88
            struct_plcvar* my_var = &variable_table[*subscription];
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    89
            char* next_cursor;
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    90
            /* get variable size*/
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    91
            USINT size = __get_type_enum_size(my_var->type);
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    92
            /* compute next cursor positon*/
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    93
            next_cursor = buffer_cursor + size;
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    94
            /* if buffer not full */
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    95
            if(next_cursor < debug_buffer + BUFFER_SIZE)
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    96
            {
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    97
                /* copy data to the buffer */
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    98
                memcpy(buffer_cursor, my_var->ptrvalue, size);
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    99
                /* increment cursor according size*/
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   100
                buffer_cursor = next_cursor;
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   101
            }else{
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   102
                /*TODO : signal overflow*/
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   103
            }
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   104
        }
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   105
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   106
        /* Reset buffer cursor again (for IterDebugData)*/
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   107
        buffer_cursor = debug_buffer;
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   108
        subscription_cursor = subscription_table;
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   109
        
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   110
        /* Trigger asynchronous transmission (returns immediately) */
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   111
        InitiateDebugTransfer(); /* size */
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   112
    }
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   113
}
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   114
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   115
void RegisterDebugVariable(int idx)
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   116
{
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   117
    /*If subscription table not full */
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   118
    if(latest_subscription - subscription_table < MAX_SUBSCRIBTION)
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   119
    {
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   120
        *(latest_subscription++) = idx;
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   121
        /* TODO pre-calc buffer size and signal overflow*/
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   122
    }else{
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   123
        /*TODO : signal subscription overflow*/
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   124
    }
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   125
}
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   126
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   127
void ResetDebugVariables(void)
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   128
{
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   129
    latest_subscription = subscription_table;
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   130
}
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   131
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   132
void FreeDebugData()
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   133
{
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   134
    /* atomically mark buffer as free */
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   135
    long latest_state = AtomicCompareExchange(
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   136
        &buffer_state,
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   137
        BUFFER_BUSY,
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   138
        BUFFER_FREE);
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   139
}
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   140
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   141
void* IterDebugData(int* idx, const char **type_name)
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   142
{
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   143
    if(subscription_cursor < latest_subscription){
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   144
        *idx = *subscription_cursor;
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   145
        struct_plcvar* my_var = &variable_table[*subscription_cursor++];
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   146
        *type_name = __get_type_enum_name(my_var->type);
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   147
        return my_var->ptrvalue;
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   148
    }
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   149
    return NULL;
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   150
}
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   151