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

#include "lvalue_check.hh"

    36

    37

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

    38

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

    39

    40

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

    41

  if (current_display_error_level >= error_level) {                                                                         \

    42

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

    43

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

    44

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

    45

    fprintf(stderr, __VA_ARGS__);                                                                                           \

    46

    fprintf(stderr, "\n");                                                                                                  \

    47

    error_count++;                                                                                                     \

    48

  }                                                                                                                         \

    49

}

    50

    51

    52

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

    53

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

    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

    warning_found = true;                                                                                                   \

    59

}

    60

    61

    62

lvalue_check_c::lvalue_check_c(symbol_c *ignore) {

    63

	error_count = 0;

    64

	current_il_operand = NULL;

    65

}

    66

    67

lvalue_check_c::~lvalue_check_c(void) {

    68

}

    69

    70

int lvalue_check_c::get_error_count() {

    71

	return error_count;

    72

}

    73

    74

    75

#include <strings.h>

    76

/* No writing to iterator variables (used in FOR loops) inside the loop itself */

    77

void lvalue_check_c::check_assignment_to_controlvar(symbol_c *lvalue) {

    78

	for (unsigned int i = 0; i < control_variables.size(); i++) {

    79

		token_c *lvalue_name = get_var_name_c::get_name(lvalue);

    80

		if (compare_identifiers(lvalue_name, control_variables[i]) == 0) {

    81

			STAGE3_ERROR(0, lvalue, lvalue, "Assignment to FOR control variable is not allowed.");

    82

			break;

    83

		}

    84

	}

    85

}

    86

    87

    88

/* fb_instance.var := ...  is not valid if var is output variable */

    89

/* NOTE, if a fb_instance1.fb_instance2.fb_instance3.var is used, we must iteratively check that none of the 

    90

 *       FB records are declared as OUTPUT variables!!  

    91

 *       This is the reason why we have the while() loop in this function!

    92

 */

    93

void lvalue_check_c::check_assignment_to_output(symbol_c *lvalue) {

    94

	decompose_var_instance_name_c decompose_lvalue(lvalue);

    95

	search_base_type_c            search_base_type;

    96

    97

	/* Get the first element/record of the potentially structured variable symbol */

    98

	/* Note that if symbol is pointing to an expression (or simply a literal value), it will return a NULL.

    99

	 * Once we have implemented the check_assignment_to_expression() method, and abort calling the other checks (including this one)

   100

	 * when an expression is found, we may replace this check with an assertion...

   101

	 * if (NULL == struct_elem) ERROR;

   102

	 */

   103

	symbol_c *struct_elem = decompose_lvalue.next_part();

   104

	if (NULL == struct_elem) return;

   105

   106

	symbol_c *type_decl   = search_var_instance_decl->get_decl(struct_elem);

   107

	// symbol_c *type_id  = spec_init_sperator_c::get_spec(type_decl); /* this is not required! search_base_type_c can handle spec_init symbols! */

   108

	symbol_c *basetype_id = search_base_type.get_basetype_id(/*type_id*/ type_decl);

   109

	/* If we can not determine the data type of the element, then the code must have a data type semantic error.

   110

	 * This will have been caught by the data type semantic verifier, so we do not bother with this anymore!

   111

	 */

   112

	if (NULL == basetype_id) return;

   113

   114

	/* Determine if the record/structure element is of a FB type. */

   115

	/* NOTE: If the structure element is not a FB type, then we can quit this check.

   116

	 *       Remember that the standard does not allow a STRUCT data type to have elements that are FB instances!

   117

	 *       Similarly, arrays of FB instances is also not allowed.

   118

	 *       So, as soon as we find one record/structure element that is not a FB, no other record/structure element

   119

	 *       will be of FB type, which means we can quit this check!

   120

	 */

   121

	function_block_declaration_c *fb_decl = function_block_type_symtable.find_value(basetype_id);

   122

	if (function_block_type_symtable.end_value() == fb_decl) return;

   123

   124

	while (NULL != (struct_elem = decompose_lvalue.next_part())) {

   125

		search_var_instance_decl_c   fb_search_var_instance_decl(fb_decl);

   126

		if (search_var_instance_decl_c::output_vt == fb_search_var_instance_decl.get_vartype(struct_elem)) {

   127

			STAGE3_ERROR(0, struct_elem, struct_elem, "Assignment to FB output variable is not allowed.");

   128

			return; /* no need to carry on checking once the first error is found! */

   129

		}

   130

   131

		/* prepare for any possible further record/structure elements */

   132

		type_decl   = fb_search_var_instance_decl.get_decl(struct_elem);

   133

		basetype_id = search_base_type.get_basetype_id(type_decl);

   134

		if (NULL == basetype_id) return; /* same comment as above... */

   135

		fb_decl = function_block_type_symtable.find_value(basetype_id);

   136

		if (function_block_type_symtable.end_value() == fb_decl) return; /* same comment as above... */

   137

	}

   138

}

   139

   140

   141

/*  No writing to CONSTANTs */

   142

void lvalue_check_c::check_assignment_to_constant(symbol_c *lvalue) {

   143

	unsigned int option = search_var_instance_decl->get_option(lvalue);

   144

	if (option == search_var_instance_decl_c::constant_opt) {

   145

		STAGE3_ERROR(0, lvalue, lvalue, "Assignment to CONSTANT variables is not be allowed.");

   146

	}

   147

}

   148

   149

   150

/*  No assigning values to expressions. */

   151

void lvalue_check_c::check_assignment_to_expression(symbol_c *lvalue) {

   152

	/* This may occur in function invocations, when passing values (possibly an expression) to one 

   153

	 * of the function's OUTPUT or IN_OUT parameters.

   154

	 */

   155

	/* This may occur in function invocations, when passing values (possibly an expression) to one

   156

	 * of the function's OUTPUT or IN_OUT parameters.

   157

	 */

   158

	if ( 

   159

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

   160

	     /* B 1.2 - Constants */

   161

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

   162

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

   163

	     /* B 1.2.1 - Numeric Literals */

   164

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

   165

	     (typeid( *lvalue ) == typeid( real_c                         )) ||

   166

	     (typeid( *lvalue ) == typeid( integer_c                      )) ||

   167

	     (typeid( *lvalue ) == typeid( binary_integer_c               )) ||

   168

	     (typeid( *lvalue ) == typeid( octal_integer_c                )) ||

   169

	     (typeid( *lvalue ) == typeid( hex_integer_c                  )) ||

   170

	     (typeid( *lvalue ) == typeid( neg_real_c                     )) ||

   171

	     (typeid( *lvalue ) == typeid( neg_integer_c                  )) ||

   172

	     (typeid( *lvalue ) == typeid( integer_literal_c              )) ||

   173

	     (typeid( *lvalue ) == typeid( real_literal_c                 )) ||

   174

	     (typeid( *lvalue ) == typeid( bit_string_literal_c           )) ||

   175

	     (typeid( *lvalue ) == typeid( boolean_literal_c              )) ||

   176

	     (typeid( *lvalue ) == typeid( boolean_true_c                 )) || /* should not really be needed */

   177

	     (typeid( *lvalue ) == typeid( boolean_false_c                )) || /* should not really be needed */

   178

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

   179

	     /* B.1.2.2   Character Strings */

   180

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

   181

	     (typeid( *lvalue ) == typeid( double_byte_character_string_c )) ||

   182

	     (typeid( *lvalue ) == typeid( single_byte_character_string_c )) ||

   183

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

   184

	     /* B 1.2.3 - Time Literals */

   185

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

   186

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

   187

	     /* B 1.2.3.1 - Duration */

   188

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

   189

	     (typeid( *lvalue ) == typeid( duration_c                     )) ||

   190

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

   191

	     /* B 1.2.3.2 - Time of day and Date */

   192

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

   193

	     (typeid( *lvalue ) == typeid( time_of_day_c                  )) ||

   194

	     (typeid( *lvalue ) == typeid( daytime_c                      )) || /* should not really be needed */

   195

	     (typeid( *lvalue ) == typeid( date_c                         )) || /* should not really be needed */

   196

	     (typeid( *lvalue ) == typeid( date_literal_c                 )) ||

   197

	     (typeid( *lvalue ) == typeid( date_and_time_c                )) ||

   198

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

   199

	     /* B.3 - Language ST (Structured Text) */

   200

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

   201

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

   202

	     /* B 3.1 - Expressions */

   203

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

   204

	     (typeid( *lvalue ) == typeid( or_expression_c                )) ||

   205

	     (typeid( *lvalue ) == typeid( xor_expression_c               )) ||

   206

	     (typeid( *lvalue ) == typeid( and_expression_c               )) ||

   207

	     (typeid( *lvalue ) == typeid( equ_expression_c               )) ||

   208

	     (typeid( *lvalue ) == typeid( notequ_expression_c            )) ||

   209

	     (typeid( *lvalue ) == typeid( lt_expression_c                )) ||

   210

	     (typeid( *lvalue ) == typeid( gt_expression_c                )) ||

   211

	     (typeid( *lvalue ) == typeid( le_expression_c                )) ||

   212

	     (typeid( *lvalue ) == typeid( ge_expression_c                )) ||

   213

	     (typeid( *lvalue ) == typeid( add_expression_c               )) ||

   214

	     (typeid( *lvalue ) == typeid( sub_expression_c               )) ||

   215

	     (typeid( *lvalue ) == typeid( mul_expression_c               )) ||

   216

	     (typeid( *lvalue ) == typeid( div_expression_c               )) ||

   217

	     (typeid( *lvalue ) == typeid( mod_expression_c               )) ||

   218

	     (typeid( *lvalue ) == typeid( power_expression_c             )) ||

   219

	     (typeid( *lvalue ) == typeid( neg_expression_c               )) ||

   220

	     (typeid( *lvalue ) == typeid( not_expression_c               )) ||

   221

	     (typeid( *lvalue ) == typeid( function_invocation_c          )))

   222

		STAGE3_ERROR(0, lvalue, lvalue, "Assigning an expression to an OUT or IN_OUT parameter is not allowed.");

   223

}                                                                  

   224

   225

   226

   227

   228

   229

   230

   231

void lvalue_check_c::verify_is_lvalue(symbol_c *lvalue) {

   232

	int init_error_count = error_count;  /* stop the checks once an error has been found... */

   233

	if (error_count == init_error_count)  check_assignment_to_expression(lvalue);

   234

	if (error_count == init_error_count)  check_assignment_to_controlvar(lvalue);

   235

	if (error_count == init_error_count)  check_assignment_to_output(lvalue);

   236

	if (error_count == init_error_count)  check_assignment_to_constant(lvalue);

   237

}

   238

   239

   240

   241

   242

/* check whether all values passed to OUT or IN_OUT parameters are legal lvalues. */

   243

/*

   244

 * All parameters being passed to the called function MUST be in the parameter list to which f_call points to!

   245

 * This means that, for non formal function calls in IL, de current (default value) must be artificially added to the

   246

 * beginning of the parameter list BEFORE calling handle_function_call().

   247

 */

   248

#include <string.h> /* required for strcmp() */

   249

void lvalue_check_c::check_nonformal_call(symbol_c *f_call, symbol_c *f_decl) {

   250

	symbol_c *call_param_value;

   251

	identifier_c *param_name;

   252

	function_param_iterator_c       fp_iterator(f_decl);

   253

	function_call_param_iterator_c fcp_iterator(f_call);

   254

   255

	/* Iterating through the non-formal parameters of the function call */

   256

	while((call_param_value = fcp_iterator.next_nf()) != NULL) {

   257

		/* Iterate to the next parameter of the function being called.

   258

		 * Get the name of that parameter, and ignore if EN or ENO.

   259

		 */

   260

		do {

   261

			param_name = fp_iterator.next();

   262

			/* If there is no other parameter declared, then we are passing too many parameters... */

   263

			/* This error should have been caught in data type verification, so we simply abandon our check! */

   264

			if(param_name == NULL) return;

   265

		} while ((strcmp(param_name->value, "EN") == 0) || (strcmp(param_name->value, "ENO") == 0));

   266

   267

		/* Find the corresponding parameter in function declaration, and it's direction (IN, OUT, IN_OUT) */

   268

		function_param_iterator_c::param_direction_t param_direction = fp_iterator.param_direction();

   269

   270

		/* We only check if 'call_param_value' is a valid lvalue if the value is being passed

   271

		 * to a valid paramater of the function being called, and that parameter is either OUT or IN_OUT.

   272

		 */

   273

		if ((param_name != NULL) && ((function_param_iterator_c::direction_out == param_direction) || (function_param_iterator_c::direction_inout == param_direction))) {

   274

			verify_is_lvalue(call_param_value);

   275

		}

   276

	}

   277

}

   278

   279

   280

   281

   282

   283

   284

/* check whether all values passed to OUT or IN_OUT parameters are legal lvalues. */

   285

void lvalue_check_c::check_formal_call(symbol_c *f_call, symbol_c *f_decl) {

   286

	/* if data type semantic verification was unable to determine which function is being called,

   287

	 * then it does not make sense to go ahead and check for lvalues to unknown parameters.

   288

	 * We simply bug out!

   289

	 */

   290

	if (NULL == f_decl) return;

   291

   292

	symbol_c *call_param_name;

   293

	function_param_iterator_c       fp_iterator(f_decl);

   294

	function_call_param_iterator_c fcp_iterator(f_call);

   295

   296

	/* Iterating through the formal parameters of the function call */

   297

	while((call_param_name = fcp_iterator.next_f()) != NULL) {

   298

   299

		/* Obtaining the value being passed in the function call */

   300

		symbol_c *call_param_value = fcp_iterator.get_current_value();

   301

		if (NULL == call_param_value) ERROR;

   302

   303

		/* Find the corresponding parameter in function declaration, and it's direction (IN, OUT, IN_OUT) */

   304

		identifier_c *param_name = fp_iterator.search(call_param_name);

   305

		function_param_iterator_c::param_direction_t param_direction = fp_iterator.param_direction();

   306

   307

		/* We only check if 'call_param_value' is a valid lvalue if the value is being passed

   308

		 * to a valid paramater of the function being called, and that parameter is either OUT or IN_OUT.

   309

		 */

   310

		if ((param_name != NULL) && ((function_param_iterator_c::direction_out == param_direction) || (function_param_iterator_c::direction_inout == param_direction))) {

   311

			verify_is_lvalue(call_param_value);

   312

		}

   313

	}

   314

}

   315

   316

   317

   318

   319

   320

   321

   322

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

   323

/* B 1.5 - Program organisation units */

   324

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

   325

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

   326

/* B 1.5.1 - Functions */

   327

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

   328

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

   329

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   330

	search_var_instance_decl = new search_var_instance_decl_c(symbol);

   331

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

   332

	delete search_varfb_instance_type;

   333

	delete search_var_instance_decl;

   334

	search_varfb_instance_type = NULL;

   335

	search_var_instance_decl = NULL;

   336

	return NULL;

   337

}

   338

   339

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

   340

/* B 1.5.2 - Function blocks */

   341

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

   342

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

   343

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   344

	search_var_instance_decl = new search_var_instance_decl_c(symbol);

   345

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

   346

	delete search_varfb_instance_type;

   347

	delete search_var_instance_decl;

   348

	search_varfb_instance_type = NULL;

   349

	search_var_instance_decl = NULL;

   350

	return NULL;

   351

}

   352

   353

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

   354

/* B 1.5.3 - Programs */

   355

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

   356

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

   357

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   358

	search_var_instance_decl = new search_var_instance_decl_c(symbol);

   359

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

   360

	delete search_varfb_instance_type;

   361

	delete search_var_instance_decl;

   362

	search_varfb_instance_type = NULL;

   363

	search_var_instance_decl = NULL;

   364

	return NULL;

   365

}

   366

   367

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

   368

/* B.2 - Language IL (Instruction List) */

   369

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

   370

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

   371

/* B 2.1 Instructions and Operands */

   372

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

   373

void *lvalue_check_c::visit(il_instruction_c *symbol) {

   374

	/* il_instruction will be NULL when parsing a label with no instruction

   375

	 * e.g.:   label1:          <---- il_instruction = NULL!

   376

	 *                 LD 33

   377

	 *                 ...

   378

	 */

   379

	if (NULL != symbol->il_instruction)

   380

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

   381

	return NULL;

   382

}

   383

   384

void *lvalue_check_c::visit(il_simple_operation_c *symbol) {

   385

	/* recursive call to fill the candidate data types list */

   386

	current_il_operand = symbol->il_operand;

   387

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

   388

	current_il_operand = NULL;

   389

	return NULL;

   390

}

   391

   392

   393

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

   394

/* B 2.2 Operators */

   395

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

   396

void *lvalue_check_c::visit(ST_operator_c *symbol) {

   397

	verify_is_lvalue(current_il_operand);

   398

	return NULL;

   399

}

   400

   401

void *lvalue_check_c::visit(STN_operator_c *symbol) {

   402

	verify_is_lvalue(current_il_operand);

   403

	return NULL;

   404

}

   405

   406

void *lvalue_check_c::visit(S_operator_c *symbol) {

   407

	verify_is_lvalue(current_il_operand);

   408

	return NULL;

   409

}

   410

   411

void *lvalue_check_c::visit(R_operator_c *symbol) {

   412

	verify_is_lvalue(current_il_operand);

   413

	return NULL;

   414

}

   415

   416

   417

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

   418

/* B.3 - Language ST (Structured Text) */

   419

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

   420

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

   421

/* B 3.1 - Expressions */

   422

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

   423

// SYM_REF3(function_invocation_c, function_name, formal_param_list, nonformal_param_list, symbol_c *called_function_declaration; int extensible_param_count; std::vector <symbol_c *> candidate_functions;)

   424

void *lvalue_check_c::visit(function_invocation_c *symbol) {

   425

	if (NULL != symbol->formal_param_list   )  check_formal_call   (symbol, symbol->called_function_declaration);

   426

	if (NULL != symbol->nonformal_param_list)  check_nonformal_call(symbol, symbol->called_function_declaration);

   427

	return NULL;

   428

}

   429

   430

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

   431

/* B 3.2.1 Assignment Statements */

   432

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

   433

void *lvalue_check_c::visit(assignment_statement_c *symbol) {

   434

	verify_is_lvalue(symbol->l_exp);

   435

	/* We call visit r_exp to check function_call */

   436

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

   437

	return NULL;

   438

}

   439

   440

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

   441

/* B 3.2.2 Subprogram Control Statements */

   442

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

   443

void *lvalue_check_c::visit(fb_invocation_c *symbol) {

   444

	if (NULL != symbol->formal_param_list   )  check_formal_call   (symbol, symbol->called_fb_declaration);

   445

	if (NULL != symbol->nonformal_param_list)  check_nonformal_call(symbol, symbol->called_fb_declaration);

   446

	return NULL;

   447

}

   448

   449

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

   450

/* B 3.2.4 Iteration Statements */

   451

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

   452

void *lvalue_check_c::visit(for_statement_c *symbol) {

   453

	control_variables.push_back(get_var_name_c::get_name(symbol->control_variable));

   454

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

   455

	control_variables.pop_back();

   456

	return NULL;

   457

}

   458

   459

   460

   461

   462

   463

   464