1

/*

     2

 *  matiec - a compiler for the programming languages defined in IEC 61131-3

     3

 *

     4

 *  Copyright (C) 2009-2012  Mario de Sousa (msousa@fe.up.pt)

     5

 *  Copyright (C) 2012       Manuele Conti  (conti.ma@alice.it)

     6

 *

     7

 *

     8

 *  This program is free software: you can redistribute it and/or modify

     9

 *  it under the terms of the GNU General Public License as published by

    10

 *  the Free Software Foundation, either version 3 of the License, or

    11

 *  (at your option) any later version.

    12

 *

    13

 *  This program is distributed in the hope that it will be useful,

    14

 *  but WITHOUT ANY WARRANTY; without even the implied warranty of

    15

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    16

 *  GNU General Public License for more details.

    17

 *

    18

 *  You should have received a copy of the GNU General Public License

    19

 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.

    20

 *

    21

 *

    22

 * This code is made available on the understanding that it will not be

    23

 * used in safety-critical situations without a full and competent review.

    24

 */

    25

    26

/*

    27

 * An IEC 61131-3 compiler.

    28

 *

    29

 * Based on the

    30

 * FINAL DRAFT - IEC 61131-3, 2nd Ed. (2001-12-10)

    31

 *

    32

 */

    33

    34

    35

/*

    36

 * TODO:

    37

 *   - Check subscript values fall within allowed range.

    38

 *     For the checking of subscript values to work correctly, we would need to have constant folding working too:

    39

 *     array_var[8 + 99] can not be checked without constant folding.

    40

 *     However, even without constant folding range check may be usefull,

    41

 *     and later changing it to use the values coming out of constant folding should not be very difficult.

    42

 *

    43

 */

    44

    45

    46

#include "array_range_check.hh"

    47

    48

#define FIRST_(symbol1, symbol2) (((symbol1)->first_order < (symbol2)->first_order)   ? (symbol1) : (symbol2))

    49

#define  LAST_(symbol1, symbol2) (((symbol1)->last_order  > (symbol2)->last_order)    ? (symbol1) : (symbol2))

    50

    51

#define STAGE3_ERROR(error_level, symbol1, symbol2, ...) {                                                                  \

    52

  if (current_display_error_level >= error_level) {                                                                         \

    53

    fprintf(stderr, "%s:%d-%d..%d-%d: error: ",                                                                             \

    54

            FIRST_(symbol1,symbol2)->first_file, FIRST_(symbol1,symbol2)->first_line, FIRST_(symbol1,symbol2)->first_column,\

    55

                                                 LAST_(symbol1,symbol2) ->last_line,  LAST_(symbol1,symbol2) ->last_column);\

    56

    fprintf(stderr, __VA_ARGS__);                                                                                           \

    57

    fprintf(stderr, "\n");                                                                                                  \

    58

    error_count++;                                                                                                     \

    59

  }                                                                                                                         \

    60

}

    61

    62

    63

#define STAGE3_WARNING(symbol1, symbol2, ...) {                                                                             \

    64

    fprintf(stderr, "%s:%d-%d..%d-%d: warning: ",                                                                           \

    65

            FIRST_(symbol1,symbol2)->first_file, FIRST_(symbol1,symbol2)->first_line, FIRST_(symbol1,symbol2)->first_column,\

    66

                                                 LAST_(symbol1,symbol2) ->last_line,  LAST_(symbol1,symbol2) ->last_column);\

    67

    fprintf(stderr, __VA_ARGS__);                                                                                           \

    68

    fprintf(stderr, "\n");                                                                                                  \

    69

    warning_found = true;                                                                                                   \

    70

}

    71

    72

#define GET_CVALUE(dtype, symbol)             ((symbol)->const_value_##dtype->value)

    73

#define VALID_CVALUE(dtype, symbol)           ((NULL != (symbol)->const_value_##dtype) && (symbol_c::cs_const_value == (symbol)->const_value_##dtype->status))

    74

    75

    76

    77

array_range_check_c::array_range_check_c(symbol_c *ignore) {

    78

	error_count = 0;

    79

	current_display_error_level = 0;

    80

}

    81

    82

array_range_check_c::~array_range_check_c(void) {

    83

}

    84

    85

int array_range_check_c::get_error_count() {

    86

	return error_count;

    87

}

    88

    89

void array_range_check_c::check_dimension_count(array_variable_c *symbol) {

    90

	int dimension_count;

    91

	symbol_c *var_decl;

    92

    93

	var_decl = search_varfb_instance_type->get_basetype_decl(symbol->subscripted_variable);

    94

	array_dimension_iterator_c array_dimension_iterator(var_decl);

    95

	for (dimension_count = 0; NULL != array_dimension_iterator.next(); dimension_count++);

    96

	if (dimension_count != ((list_c *)symbol->subscript_list)->n)

    97

		STAGE3_ERROR(0, symbol, symbol, "Number of subscripts/indexes does not match the number of subscripts/indexes in the array's declaration (array has %d indexes)", dimension_count);

    98

}

    99

   100

void array_range_check_c::check_bounds(array_variable_c *symbol) {

   101

  list_c *l; /* the subscript_list */

   102

  symbol_c *var_decl;

   103

   104

  l = (list_c *)symbol->subscript_list;

   105

  var_decl = search_varfb_instance_type->get_basetype_decl(symbol->subscripted_variable);

   106

  array_dimension_iterator_c array_dimension_iterator(var_decl);

   107

  for (int i =  0; i < l->n; i++) {

   108

    subrange_c *dimension = array_dimension_iterator.next();

   109

    /* mismatch between number of indexes/subscripts. This error will be caught in check_dimension_count() so we ignore it. */

   110

    if (NULL == dimension) 

   111

      return;

   112

   113

    if ( VALID_CVALUE( int64, l->elements[i]) && VALID_CVALUE( int64, dimension->lower_limit))

   114

      if ( GET_CVALUE( int64, l->elements[i])   <  GET_CVALUE( int64, dimension->lower_limit))

   115

      {STAGE3_ERROR(0, symbol, symbol, "Array access out of bounds."); continue;}

   116

   117

    if ( VALID_CVALUE( int64, l->elements[i]) && VALID_CVALUE( int64, dimension->upper_limit))

   118

      if ( GET_CVALUE( int64, l->elements[i])   >  GET_CVALUE( int64, dimension->upper_limit))

   119

      {STAGE3_ERROR(0, symbol, symbol, "Array access out of bounds."); continue;}

   120

   121

    if ( VALID_CVALUE(uint64, l->elements[i]) && VALID_CVALUE(uint64, dimension->lower_limit))

   122

      if ( GET_CVALUE(uint64, l->elements[i])   <  GET_CVALUE(uint64, dimension->lower_limit))

   123

      {STAGE3_ERROR(0, symbol, symbol, "Array access out of bounds."); continue;}

   124

   125

    if ( VALID_CVALUE(uint64, l->elements[i]) && VALID_CVALUE(uint64, dimension->upper_limit))

   126

      if ( GET_CVALUE(uint64, l->elements[i])   >  GET_CVALUE(uint64, dimension->upper_limit))

   127

      {STAGE3_ERROR(0, symbol, symbol, "Array access out of bounds."); continue;}

   128

  }

   129

}

   130

   131

/*********************/

   132

/* B 1.4 - Variables */

   133

/*********************/

   134

/*************************************/

   135

/* B 1.4.2 - Multi-element variables */

   136

/*************************************/

   137

void *array_range_check_c::visit(array_variable_c *symbol) {

   138

	check_dimension_count(symbol);

   139

	check_bounds(symbol);

   140

	return NULL;

   141

}

   142

   143

   144

/**************************************/

   145

/* B 1.5 - Program organisation units */

   146

/**************************************/

   147

/***********************/

   148

/* B 1.5.1 - Functions */

   149

/***********************/

   150

void *array_range_check_c::visit(function_declaration_c *symbol) {

   151

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   152

	// search_var_instance_decl = new search_var_instance_decl_c(symbol);

   153

	symbol->function_body->accept(*this);

   154

	delete search_varfb_instance_type;

   155

	// delete search_var_instance_decl;

   156

	search_varfb_instance_type = NULL;

   157

	// search_var_instance_decl = NULL;

   158

	return NULL;

   159

}

   160

   161

/*****************************/

   162

/* B 1.5.2 - Function blocks */

   163

/*****************************/

   164

void *array_range_check_c::visit(function_block_declaration_c *symbol) {

   165

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   166

	// search_var_instance_decl = new search_var_instance_decl_c(symbol);

   167

	symbol->fblock_body->accept(*this);

   168

	delete search_varfb_instance_type;

   169

	// delete search_var_instance_decl;

   170

	search_varfb_instance_type = NULL;

   171

	// search_var_instance_decl = NULL;

   172

	return NULL;

   173

}

   174

   175

/**********************/

   176

/* B 1.5.3 - Programs */

   177

/**********************/

   178

void *array_range_check_c::visit(program_declaration_c *symbol) {

   179

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   180

	// search_var_instance_decl = new search_var_instance_decl_c(symbol);

   181

	symbol->function_block_body->accept(*this);

   182

	delete search_varfb_instance_type;

   183

	// delete search_var_instance_decl;

   184

	search_varfb_instance_type = NULL;

   185

	// search_var_instance_decl = NULL;

   186

	return NULL;

   187

}

   188

   189

   190