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

 * Array Range Checking:

    37

 *   - Check whether array subscript values fall within the allowed range.

    38

 *     Note that for the checking of subscript values to work correctly, we need to have constant folding working too:

    39

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

    40

 */

    41

    42

    43

#include "array_range_check.hh"

    44

#include <limits>  // required for std::numeric_limits<XXX>

    45

    46

    47

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

    48

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

    49

    50

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

    51

  if (current_display_error_level >= error_level) {                                                                         \

    52

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

    53

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

    54

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

    55

    fprintf(stderr, __VA_ARGS__);                                                                                           \

    56

    fprintf(stderr, "\n");                                                                                                  \

    57

    error_count++;                                                                                                     \

    58

  }                                                                                                                         \

    59

}

    60

    61

    62

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

    63

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

    64

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

    65

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

    66

    fprintf(stderr, __VA_ARGS__);                                                                                           \

    67

    fprintf(stderr, "\n");                                                                                                  \

    68

    warning_found = true;                                                                                                   \

    69

}

    70

    71

#define GET_CVALUE(dtype, symbol)             ((symbol)->const_value._##dtype.value)

    72

#define VALID_CVALUE(dtype, symbol)           (symbol_c::cs_const_value == (symbol)->const_value._##dtype.status)

    73

    74

    75

    76

array_range_check_c::array_range_check_c(symbol_c *ignore) {

    77

	error_count = 0;

    78

	current_display_error_level = 0;

    79

}

    80

    81

    82

    83

array_range_check_c::~array_range_check_c(void) {

    84

}

    85

    86

    87

    88

int array_range_check_c::get_error_count() {

    89

	return error_count;

    90

}

    91

    92

    93

    94

void array_range_check_c::check_dimension_count(array_variable_c *symbol) {

    95

	int dimension_count;

    96

	symbol_c *var_decl;

    97

    98

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

    99

	array_dimension_iterator_c array_dimension_iterator(var_decl);

   100

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

   101

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

   102

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

   103

}

   104

   105

   106

   107

void array_range_check_c::check_bounds(array_variable_c *symbol) {

   108

  list_c *l; /* the subscript_list */

   109

  symbol_c *var_decl;

   110

   111

  l = (list_c *)symbol->subscript_list;

   112

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

   113

  array_dimension_iterator_c array_dimension_iterator(var_decl);

   114

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

   115

    subrange_c *dimension = array_dimension_iterator.next();

   116

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

   117

    if (NULL == dimension) 

   118

      return;

   119

   120

    /* Check lower limit */

   121

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

   122

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

   123

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

   124

   125

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

   126

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

   127

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

   128

   129

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

   130

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

   131

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

   132

   133

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

   134

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

   135

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

   136

   137

    /* Repeat the same check, now for upper limit */

   138

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

   139

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

   140

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

   141

   142

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

   143

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

   144

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

   145

   146

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

   147

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

   148

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

   149

   150

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

   151

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

   152

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

   153

   154

   /* TODO: How do we make these comparisons between int and unsigned int, without the compiler complaining? */

   155

  }

   156

}

   157

   158

   159

   160

   161

   162

   163

   164

   165

   166

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

   167

/* B.1 - Common elements */

   168

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

   169

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

   170

/* B.1.3 - Data types */

   171

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

   172

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

   173

/* B 1.3.3 - Derived data types */

   174

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

   175

   176

/*  signed_integer DOTDOT signed_integer */

   177

/* dimension will be filled in during stage 3 (array_range_check_c) with the number of elements in this subrange */

   178

// SYM_REF2(subrange_c, lower_limit, upper_limit, unsigned long long int dimension)

   179

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

   180

	unsigned long long int dimension = 0; // we use unsigned long long instead of uint64_t since it might just happen to be larger than uint64_t in the platform used for compiling this code!!

   181

   182

	/* Determine the size of the array... */

   183

	if        (VALID_CVALUE( int64, symbol->upper_limit) && VALID_CVALUE( int64, symbol->lower_limit)) {  

   184

		// do the sums in such a way that no overflow is possible... even during intermediate steps used by compiler!

   185

		// remember that the result (dimension) is unsigned, while the operands are signed!!

   186

		// dimension = GET_CVALUE( int64, symbol->upper_limit) - VALID_CVALUE( int64, symbol->lower_limit);

   187

		if (GET_CVALUE( int64, symbol->lower_limit) >= 0) {

   188

			dimension = GET_CVALUE( int64, symbol->upper_limit) - GET_CVALUE( int64, symbol->lower_limit);

   189

		} else {

   190

			dimension  = -GET_CVALUE( int64, symbol->lower_limit);

   191

			dimension +=  GET_CVALUE( int64, symbol->upper_limit);     

   192

		}

   193

	} else if (VALID_CVALUE(uint64, symbol->upper_limit) && VALID_CVALUE(uint64, symbol->lower_limit)) {

   194

		dimension = GET_CVALUE(uint64, symbol->upper_limit) - GET_CVALUE(uint64, symbol->lower_limit); 

   195

	} else if (VALID_CVALUE(uint64, symbol->upper_limit) && VALID_CVALUE( int64, symbol->lower_limit)) {

   196

		if (GET_CVALUE( int64, symbol->lower_limit) >= 0) {

   197

			dimension = GET_CVALUE(uint64, symbol->upper_limit) - GET_CVALUE( int64, symbol->lower_limit);

   198

		} else {

   199

			unsigned long long int lower_ull;

   200

			lower_ull  = -GET_CVALUE( int64, symbol->lower_limit);

   201

			dimension  =  GET_CVALUE(uint64, symbol->upper_limit) + lower_ull;     

   202

			if (dimension < lower_ull)

   203

				STAGE3_ERROR(0, symbol, symbol, "Number of elements in array subrange exceeds maximum number of elements (%llu).", std::numeric_limits< unsigned long long int >::max());

   204

		}

   205

	} else ERROR;

   206

   207

	/* correct value for dimension is actually ---> dimension = upper_limit - lower_limit + 1

   208

	 * Up to now, we have only determined dimension = upper_limit - lower_limit

   209

	 * We must first check whether this last increment will cause an overflow!

   210

	 */

   211

	if (dimension == std::numeric_limits< unsigned long long int >::max())

   212

		STAGE3_ERROR(0, symbol, symbol, "Number of elements in array subrange exceeds maximum number of elements (%llu).", std::numeric_limits< unsigned long long int >::max());

   213

   214

	/* correct value for dimension is actually ---> dimension = upper_limit - lower_limit + 1 */

   215

	dimension++; 

   216

   217

	symbol->dimension = dimension;

   218

	return NULL;

   219

}

   220

   221

   222

   223

   224

   225

/* integer '(' [array_initial_element] ')' */

   226

/* array_initial_element may be NULL ! */

   227

// SYM_REF2(array_initial_elements_c, integer, array_initial_element)

   228

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

   229

	if (VALID_CVALUE( int64, symbol->integer) && (GET_CVALUE( int64, symbol->integer) < 0)) 

   230

		ERROR; /* the IEC 61131-3 syntax guarantees that this value will never be negative! */

   231

   232

	/* TODO: check that the total number of 'initial values' does not exceed the size of the array! */

   233

   234

	return NULL;

   235

}

   236

   237

   238

   239

   240

   241

   242

   243

   244

   245

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

   246

/* B 1.4 - Variables */

   247

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

   248

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

   249

/* B 1.4.2 - Multi-element variables */

   250

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

   251

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

   252

	check_dimension_count(symbol);

   253

	check_bounds(symbol);

   254

	return NULL;

   255

}

   256

   257

   258

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

   259

/* B 1.5 - Program organisation units */

   260

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

   261

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

   262

/* B 1.5.1 - Functions */

   263

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

   264

// SYM_REF4(function_declaration_c, derived_function_name, type_name, var_declarations_list, function_body)

   265

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

   266

	symbol->var_declarations_list->accept(*this); // required for visiting subrange_c

   267

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   268

	// search_var_instance_decl = new search_var_instance_decl_c(symbol);

   269

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

   270

	delete search_varfb_instance_type;

   271

	// delete search_var_instance_decl;

   272

	search_varfb_instance_type = NULL;

   273

	// search_var_instance_decl = NULL;

   274

	return NULL;

   275

}

   276

   277

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

   278

/* B 1.5.2 - Function blocks */

   279

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

   280

// SYM_REF3(function_block_declaration_c, fblock_name, var_declarations, fblock_body)

   281

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

   282

	symbol->var_declarations->accept(*this); // required for visiting subrange_c

   283

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   284

	// search_var_instance_decl = new search_var_instance_decl_c(symbol);

   285

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

   286

	delete search_varfb_instance_type;

   287

	// delete search_var_instance_decl;

   288

	search_varfb_instance_type = NULL;

   289

	// search_var_instance_decl = NULL;

   290

	return NULL;

   291

}

   292

   293

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

   294

/* B 1.5.3 - Programs */

   295

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

   296

// SYM_REF3(program_declaration_c, program_type_name, var_declarations, function_block_body)

   297

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

   298

	symbol->var_declarations->accept(*this); // required for visiting subrange_c

   299

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   300

	// search_var_instance_decl = new search_var_instance_decl_c(symbol);

   301

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

   302

	delete search_varfb_instance_type;

   303

	// delete search_var_instance_decl;

   304

	search_varfb_instance_type = NULL;

   305

	// search_var_instance_decl = NULL;

   306

	return NULL;

   307

}

   308

   309

   310