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

/*  The cmp_unsigned_signed function compares two numbers u and s.

    75

 *  It returns an integer indicating the relationship between the numbers:

    76

 *  - A zero value indicates that both numbers are equal.

    77

 *  - A value greater than zero indicates that numbers does not match and

    78

 *    first has a greater value.

    79

 *  - A value less than zero indicates that numbers does not match and

    80

 *    first has a lesser value.

    81

 */

    82

static inline int cmp_unsigned_signed(const uint64_t u, const int64_t s) {

    83

  const uint64_t INT64_MAX_uvar = INT64_MAX;

    84

  if (u <= INT64_MAX_uvar)

    85

    return ((int64_t)u - s);

    86

  return -1;

    87

}

    88

    89

array_range_check_c::array_range_check_c(symbol_c *ignore) {

    90

	error_count = 0;

    91

	current_display_error_level = 0;

    92

	search_varfb_instance_type = NULL;

    93

}

    94

    95

    96

    97

array_range_check_c::~array_range_check_c(void) {

    98

}

    99

   100

   101

   102

int array_range_check_c::get_error_count() {

   103

	return error_count;

   104

}

   105

   106

   107

   108

void array_range_check_c::check_dimension_count(array_variable_c *symbol) {

   109

	int dimension_count;

   110

	symbol_c *var_decl;

   111

   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 (dimension_count = 0; NULL != array_dimension_iterator.next(); dimension_count++);

   115

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

   116

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

   117

}

   118

   119

   120

   121

void array_range_check_c::check_bounds(array_variable_c *symbol) {

   122

  list_c *l; /* the subscript_list */

   123

  symbol_c *var_decl;

   124

   125

  l = (list_c *)symbol->subscript_list;

   126

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

   127

  array_dimension_iterator_c array_dimension_iterator(var_decl);

   128

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

   129

    subrange_c *dimension = array_dimension_iterator.next();

   130

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

   131

    if (NULL == dimension) 

   132

      return;

   133

   134

    /* Check lower limit */

   135

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

   136

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

   137

      {STAGE3_ERROR(0, symbol, symbol, "Array access out of bounds (should be >= %"PRId64").", GET_CVALUE( int64, dimension->lower_limit)); continue;}

   138

   139

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

   140

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

   141

      {STAGE3_ERROR(0, symbol, symbol, "Array access out of bounds (should be >= %"PRIu64").", GET_CVALUE(uint64, dimension->lower_limit)); continue;}

   142

   143

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

   144

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

   145

      {STAGE3_ERROR(0, symbol, symbol, "Array access out of bounds (should be >= %"PRIu64").", GET_CVALUE(uint64, dimension->lower_limit)); continue;}

   146

   147

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

   148

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

   149

      {STAGE3_ERROR(0, symbol, symbol, "Array access out of bounds (should be >= %"PRId64").", GET_CVALUE( int64, dimension->lower_limit)); continue;}

   150

   151

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

   152

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

   153

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

   154

      {STAGE3_ERROR(0, symbol, symbol, "Array access out of bounds (should be <= %"PRId64").", GET_CVALUE( int64, dimension->upper_limit)); continue;}

   155

   156

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

   157

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

   158

      {STAGE3_ERROR(0, symbol, symbol, "Array access out of bounds (should be <= %"PRIu64").", GET_CVALUE(uint64, dimension->upper_limit)); continue;}

   159

   160

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

   161

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

   162

      {STAGE3_ERROR(0, symbol, symbol, "Array access out of bounds (should be <= %"PRIu64").", GET_CVALUE(uint64, dimension->upper_limit)); continue;}

   163

   164

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

   165

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

   166

      {STAGE3_ERROR(0, symbol, symbol, "Array access out of bounds (should be <= %"PRId64").", GET_CVALUE( int64, dimension->upper_limit)); continue;}

   167

   168

  }

   169

}

   170

   171

   172

   173

   174

   175

   176

   177

   178

   179

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

   180

/* B.1 - Common elements */

   181

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

   182

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

   183

/* B.1.3 - Data types */

   184

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

   185

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

   186

/* B 1.3.3 - Derived data types */

   187

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

   188

   189

/*  signed_integer DOTDOT signed_integer */

   190

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

   191

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

   192

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

   193

	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!!

   194

   195

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

   196

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

   197

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

   198

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

   199

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

   200

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

   201

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

   202

		} else {

   203

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

   204

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

   205

		}

   206

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

   207

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

   208

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

   209

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

   210

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

   211

		} else {

   212

			unsigned long long int lower_ull;

   213

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

   214

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

   215

			if (dimension < lower_ull)

   216

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

   217

		}

   218

	} else ERROR;

   219

   220

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

   221

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

   222

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

   223

	 */

   224

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

   225

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

   226

   227

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

   228

	dimension++; 

   229

   230

	symbol->dimension = dimension;

   231

	return NULL;

   232

}

   233

   234

   235

   236

   237

   238

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

   239

/* array_initial_element may be NULL ! */

   240

// SYM_REF2(array_initial_elements_c, integer, array_initial_element)

   241

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

   242

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

   243

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

   244

   245

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

   246

   247

	return NULL;

   248

}

   249

   250

   251

   252

   253

   254

   255

   256

   257

   258

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

   259

/* B 1.4 - Variables */

   260

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

   261

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

   262

/* B 1.4.2 - Multi-element variables */

   263

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

   264

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

   265

	check_dimension_count(symbol);

   266

	check_bounds(symbol);

   267

	return NULL;

   268

}

   269

   270

   271

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

   272

/* B 1.5 - Program organisation units */

   273

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

   274

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

   275

/* B 1.5.1 - Functions */

   276

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

   277

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

   278

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

   279

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

   280

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   281

	// search_var_instance_decl = new search_var_instance_decl_c(symbol);

   282

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

   283

	delete search_varfb_instance_type;

   284

	// delete search_var_instance_decl;

   285

	search_varfb_instance_type = NULL;

   286

	// search_var_instance_decl = NULL;

   287

	return NULL;

   288

}

   289

   290

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

   291

/* B 1.5.2 - Function blocks */

   292

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

   293

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

   294

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

   295

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

   296

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   297

	// search_var_instance_decl = new search_var_instance_decl_c(symbol);

   298

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

   299

	delete search_varfb_instance_type;

   300

	// delete search_var_instance_decl;

   301

	search_varfb_instance_type = NULL;

   302

	// search_var_instance_decl = NULL;

   303

	return NULL;

   304

}

   305

   306

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

   307

/* B 1.5.3 - Programs */

   308

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

   309

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

   310

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

   311

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

   312

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   313

	// search_var_instance_decl = new search_var_instance_decl_c(symbol);

   314

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

   315

	delete search_varfb_instance_type;

   316

	// delete search_var_instance_decl;

   317

	search_varfb_instance_type = NULL;

   318

	// search_var_instance_decl = NULL;

   319

	return NULL;

   320

}

   321

   322

   323