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

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

    48

    49

    50

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

    51

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

    52

    53

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

    54

  if (current_display_error_level >= error_level) {                                                                         \

    55

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

    56

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

    57

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

    58

    fprintf(stderr, __VA_ARGS__);                                                                                           \

    59

    fprintf(stderr, "\n");                                                                                                  \

    60

    error_count++;                                                                                                     \

    61

  }                                                                                                                         \

    62

}

    63

    64

    65

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

    66

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

    67

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

    68

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

    69

    fprintf(stderr, __VA_ARGS__);                                                                                           \

    70

    fprintf(stderr, "\n");                                                                                                  \

    71

    warning_found = true;                                                                                                   \

    72

}

    73

    74

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

    75

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

    76

    77

    78

    79

array_range_check_c::array_range_check_c(symbol_c *ignore) {

    80

	error_count = 0;

    81

	current_display_error_level = 0;

    82

}

    83

    84

    85

    86

array_range_check_c::~array_range_check_c(void) {

    87

}

    88

    89

    90

    91

int array_range_check_c::get_error_count() {

    92

	return error_count;

    93

}

    94

    95

    96

    97

void array_range_check_c::check_dimension_count(array_variable_c *symbol) {

    98

	int dimension_count;

    99

	symbol_c *var_decl;

   100

   101

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

   102

	array_dimension_iterator_c array_dimension_iterator(var_decl);

   103

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

   104

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

   105

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

   106

}

   107

   108

   109

   110

void array_range_check_c::check_bounds(array_variable_c *symbol) {

   111

  list_c *l; /* the subscript_list */

   112

  symbol_c *var_decl;

   113

   114

  l = (list_c *)symbol->subscript_list;

   115

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

   116

  array_dimension_iterator_c array_dimension_iterator(var_decl);

   117

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

   118

    subrange_c *dimension = array_dimension_iterator.next();

   119

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

   120

    if (NULL == dimension) 

   121

      return;

   122

   123

    /* Check lower limit */

   124

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

   125

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

   126

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

   127

   128

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

   129

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

   130

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

   131

   132

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

   133

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

   134

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

   135

   136

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

   137

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

   138

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

   139

   140

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

   141

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

   142

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

   143

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

   144

   145

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

   146

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

   147

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

   148

   149

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

   150

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

   151

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

   152

   153

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

   154

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

   155

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

   156

   157

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

   158

  }

   159

}

   160

   161

   162

   163

   164

   165

   166

   167

   168

   169

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

   170

/* B.1 - Common elements */

   171

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

   172

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

   173

/* B.1.3 - Data types */

   174

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

   175

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

   176

/* B 1.3.3 - Derived data types */

   177

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

   178

   179

/*  signed_integer DOTDOT signed_integer */

   180

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

   181

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

   182

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

   183

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

   184

   185

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

   186

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

   187

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

   188

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

   189

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

   190

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

   191

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

   192

		} else {

   193

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

   194

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

   195

		}

   196

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

   197

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

   198

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

   199

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

   200

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

   201

		} else {

   202

			unsigned long long int lower_ull;

   203

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

   204

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

   205

			if (dimension < lower_ull)

   206

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

   207

		}

   208

	} else ERROR;

   209

   210

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

   211

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

   212

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

   213

	 */

   214

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

   215

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

   216

   217

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

   218

	dimension++; 

   219

   220

	symbol->dimension = dimension;

   221

	return NULL;

   222

}

   223

   224

   225

   226

   227

   228

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

   229

/* array_initial_element may be NULL ! */

   230

// SYM_REF2(array_initial_elements_c, integer, array_initial_element)

   231

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

   232

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

   233

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

   234

   235

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

   236

   237

	return NULL;

   238

}

   239

   240

   241

   242

   243

   244

   245

   246

   247

   248

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

   249

/* B 1.4 - Variables */

   250

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

   251

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

   252

/* B 1.4.2 - Multi-element variables */

   253

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

   254

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

   255

	check_dimension_count(symbol);

   256

	check_bounds(symbol);

   257

	return NULL;

   258

}

   259

   260

   261

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

   262

/* B 1.5 - Program organisation units */

   263

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

   264

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

   265

/* B 1.5.1 - Functions */

   266

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

   267

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

   268

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

   269

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

   270

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   271

	// search_var_instance_decl = new search_var_instance_decl_c(symbol);

   272

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

   273

	delete search_varfb_instance_type;

   274

	// delete search_var_instance_decl;

   275

	search_varfb_instance_type = NULL;

   276

	// search_var_instance_decl = NULL;

   277

	return NULL;

   278

}

   279

   280

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

   281

/* B 1.5.2 - Function blocks */

   282

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

   283

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

   284

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

   285

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

   286

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   287

	// search_var_instance_decl = new search_var_instance_decl_c(symbol);

   288

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

   289

	delete search_varfb_instance_type;

   290

	// delete search_var_instance_decl;

   291

	search_varfb_instance_type = NULL;

   292

	// search_var_instance_decl = NULL;

   293

	return NULL;

   294

}

   295

   296

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

   297

/* B 1.5.3 - Programs */

   298

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

   299

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

   300

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

   301

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

   302

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   303

	// search_var_instance_decl = new search_var_instance_decl_c(symbol);

   304

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

   305

	delete search_varfb_instance_type;

   306

	// delete search_var_instance_decl;

   307

	search_varfb_instance_type = NULL;

   308

	// search_var_instance_decl = NULL;

   309

	return NULL;

   310

}

   311

   312

   313