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

    72

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

    73

#define VALID_CVALUE(dtype, symbol)           ((symbol)->const_value._##dtype.is_valid())

    74

    75

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

    76

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

    77

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

    78

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

    79

 *    first has a greater value.

    80

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

    81

 *    first has a lesser value.

    82

 */

    83

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

    84

  const uint64_t INT64_MAX_uvar = INT64_MAX;

    85

  if (u <= INT64_MAX_uvar)

    86

    return ((int64_t)u - s);

    87

  return -1;

    88

}

    89

    90

array_range_check_c::array_range_check_c(symbol_c *ignore) {

    91

	error_count = 0;

    92

	current_display_error_level = 0;

    93

	search_varfb_instance_type = NULL;

    94

}

    95

    96

    97

    98

array_range_check_c::~array_range_check_c(void) {

    99

}

   100

   101

   102

   103

int array_range_check_c::get_error_count() {

   104

	return error_count;

   105

}

   106

   107

   108

   109

void array_range_check_c::check_dimension_count(array_variable_c *symbol) {

   110

	int dimension_count;

   111

	symbol_c *var_decl;

   112

   113

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

   114

	array_dimension_iterator_c array_dimension_iterator(var_decl);

   115

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

   116

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

   117

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

   118

}

   119

   120

   121

   122

void array_range_check_c::check_bounds(array_variable_c *symbol) {

   123

  list_c *l; /* the subscript_list */

   124

  symbol_c *var_decl;

   125

   126

  l = (list_c *)symbol->subscript_list;

   127

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

   128

  array_dimension_iterator_c array_dimension_iterator(var_decl);

   129

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

   130

    subrange_c *dimension = array_dimension_iterator.next();

   131

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

   132

    if (NULL == dimension) 

   133

      return;

   134

   135

    /* Check lower limit */

   136

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

   137

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

   138

      {STAGE3_ERROR(0, symbol, symbol, "Array access out of bounds (using constant value of %"PRId64", should be >= %"PRId64").", GET_CVALUE( int64, l->elements[i]), GET_CVALUE( int64, dimension->lower_limit)); continue;}

   139

   140

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

   141

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

   142

      {STAGE3_ERROR(0, symbol, symbol, "Array access out of bounds (using constant value of %"PRId64", should be >= %"PRIu64").", GET_CVALUE( int64, l->elements[i]), GET_CVALUE(uint64, dimension->lower_limit)); continue;}

   143

   144

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

   145

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

   146

      {STAGE3_ERROR(0, symbol, symbol, "Array access out of bounds (using constant value of %"PRIu64", should be >= %"PRIu64").", GET_CVALUE(uint64, l->elements[i]), GET_CVALUE(uint64, dimension->lower_limit)); continue;}

   147

   148

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

   149

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

   150

      {STAGE3_ERROR(0, symbol, symbol, "Array access out of bounds (using constant value of %"PRIu64", should be >= %"PRId64").", GET_CVALUE(uint64, l->elements[i]), GET_CVALUE( int64, dimension->lower_limit)); continue;}

   151

   152

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

   153

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

   154

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

   155

      {STAGE3_ERROR(0, symbol, symbol, "Array access out of bounds (using constant value of %"PRId64", should be <= %"PRId64").", GET_CVALUE( int64, l->elements[i]), GET_CVALUE( int64, dimension->upper_limit)); continue;}

   156

   157

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

   158

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

   159

      {STAGE3_ERROR(0, symbol, symbol, "Array access out of bounds (using constant value of %"PRId64", should be <= %"PRIu64").", GET_CVALUE( int64, l->elements[i]), GET_CVALUE(uint64, dimension->upper_limit)); continue;}

   160

   161

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

   162

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

   163

      {STAGE3_ERROR(0, symbol, symbol, "Array access out of bounds (using constant value of %"PRIu64", should be <= %"PRIu64").", GET_CVALUE(uint64, l->elements[i]), GET_CVALUE(uint64, dimension->upper_limit)); continue;}

   164

   165

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

   166

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

   167

      {STAGE3_ERROR(0, symbol, symbol, "Array access out of bounds (using constant value of %"PRIu64", should be <= %"PRId64").", GET_CVALUE(uint64, l->elements[i]), GET_CVALUE( int64, dimension->upper_limit)); continue;}

   168

   169

  }

   170

}

   171

   172

   173

   174

   175

   176

   177

   178

   179

   180

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

   181

/* B.1 - Common elements */

   182

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

   183

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

   184

/* B.1.3 - Data types */

   185

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

   186

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

   187

/* B 1.3.3 - Derived data types */

   188

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

   189

   190

/*  signed_integer DOTDOT signed_integer */

   191

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

   192

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

   193

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

   194

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

   195

   196

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

   197

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

   198

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

   199

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

   200

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

   201

		if  (GET_CVALUE( int64, symbol->lower_limit)  >   GET_CVALUE( int64, symbol->upper_limit)) {

   202

			STAGE3_ERROR(0, symbol, symbol, "Subrange has lower limit (%"PRId64") larger than upper limit (%"PRId64").", GET_CVALUE( int64, symbol->lower_limit), GET_CVALUE( int64, symbol->upper_limit));

   203

			dimension = std::numeric_limits< unsigned long long int >::max() - 1; // -1 because it will be incremented at the end of this function!! 

   204

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

   205

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

   206

		} else {

   207

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

   208

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

   209

		}

   210

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

   211

		if  (GET_CVALUE(uint64, symbol->lower_limit)  >   GET_CVALUE(uint64, symbol->upper_limit)) {

   212

			STAGE3_ERROR(0, symbol, symbol, "Subrange has lower limit (%"PRIu64") larger than upper limit (%"PRIu64").", GET_CVALUE(uint64, symbol->lower_limit), GET_CVALUE(uint64, symbol->upper_limit));

   213

			dimension = std::numeric_limits< unsigned long long int >::max() - 1; // -1 because it will be incremented at the end of this function!! 

   214

		} else

   215

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

   216

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

   217

		// No need to check whether lower_limit > upper_limit, as we only reach this point if lower_limit < 0 (and upper_limit must be >= 0!)

   218

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

   219

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

   220

		} else {

   221

			unsigned long long int lower_ull;

   222

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

   223

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

   224

			if (dimension < lower_ull)

   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

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

   228

		STAGE3_ERROR(0, symbol->upper_limit, symbol->upper_limit, "Subrange upper limit is not a constant value.");

   229

		// set dimension to largest possible value so we do not get any further related error messages.

   230

		dimension = std::numeric_limits< unsigned long long int >::max() - 1; // -1 because it will be incremented at the end of this function!! 

   231

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

   232

		STAGE3_ERROR(0, symbol->lower_limit, symbol->lower_limit, "Subrange lower limit is not a constant value.");

   233

		// set dimension to largest possible value so we do not get any further related error messages.

   234

		dimension = std::numeric_limits< unsigned long long int >::max() - 1; // -1 because it will be incremented at the end of this function!! 

   235

		/* NOTE: Note that both the "subrange *** limit is not a constant value" error messages are only necessary due to an extension

   236

		 *       that matiec supports by allowing non-literals in subrange declarations (currently only subranges in array declarations).

   237

		 *         e.g.:  array_var: ARRAY [1..max] of INT;   <--- illegal according to IEC 61131-1 due to the 'max' non literal

   238

		 *       Matiec will allow the above syntax, as long as the 'max' variable can be determined to be constant throughout

   239

		 *       the program execution at runtime (and not only constant when program initiates) - for example, a VAR CONSTANT

   240

		 *       variable.

   241

		 *       These two checks will verify if we were able to fold the variable into a constant value, or not.

   242

		 */

   243

	} else {ERROR;}

   244

   245

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

   246

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

   247

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

   248

	 */

   249

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

   250

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

   251

   252

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

   253

	dimension++; 

   254

   255

	symbol->dimension = dimension;

   256

	return NULL;

   257

}

   258

   259

   260

   261

   262

   263

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

   264

/* array_initial_element may be NULL ! */

   265

// SYM_REF2(array_initial_elements_c, integer, array_initial_element)

   266

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

   267

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

   268

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

   269

   270

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

   271

   272

	return NULL;

   273

}

   274

   275

   276

   277

   278

   279

   280

   281

   282

   283

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

   284

/* B 1.4 - Variables */

   285

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

   286

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

   287

/* B 1.4.2 - Multi-element variables */

   288

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

   289

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

   290

	check_dimension_count(symbol);

   291

	check_bounds(symbol);

   292

	return NULL;

   293

}

   294

   295

   296

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

   297

/* B 1.5 - Program organisation units */

   298

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

   299

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

   300

/* B 1.5.1 - Functions */

   301

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

   302

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

   303

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

   304

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

   305

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   306

	// search_var_instance_decl = new search_var_instance_decl_c(symbol);

   307

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

   308

	delete search_varfb_instance_type;

   309

	// delete search_var_instance_decl;

   310

	search_varfb_instance_type = NULL;

   311

	// search_var_instance_decl = NULL;

   312

	return NULL;

   313

}

   314

   315

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

   316

/* B 1.5.2 - Function blocks */

   317

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

   318

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

   319

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

   320

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

   321

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   322

	// search_var_instance_decl = new search_var_instance_decl_c(symbol);

   323

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

   324

	delete search_varfb_instance_type;

   325

	// delete search_var_instance_decl;

   326

	search_varfb_instance_type = NULL;

   327

	// search_var_instance_decl = NULL;

   328

	return NULL;

   329

}

   330

   331

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

   332

/* B 1.5.3 - Programs */

   333

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

   334

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

   335

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

   336

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

   337

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   338

	// search_var_instance_decl = new search_var_instance_decl_c(symbol);

   339

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

   340

	delete search_varfb_instance_type;

   341

	// delete search_var_instance_decl;

   342

	search_varfb_instance_type = NULL;

   343

	// search_var_instance_decl = NULL;

   344

	return NULL;

   345

}

   346

   347

   348