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 (manuele.conti@sirius-es.it)

     6

 *  Copyright (C) 2012       Matteo Facchinetti (matteo.facchinetti@sirius-es.it)

     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

/* TODO - things yet not checked by this data type checker...

    36

 *

    37

 * - check variable declarations

    38

 * - check data type declarations

    39

 * - check inside configurations (variable declarations)

    40

 * - check SFC code

    41

 * - must fix S and R IL functions (includes potientialy fixing stage4 code!) 

    42

 */

    43

    44

    45

/* NOTE: The algorithm implemented here assumes that flow control analysis has already been completed!

    46

 *       BEFORE running this visitor, be sure to CALL the flow_control_analysis_c visitor!

    47

 */

    48

    49

    50

/*

    51

 *  Fill the candidate datatype list for all symbols that may legally 'have' a data type (e.g. variables, literals, function calls, expressions, etc.)

    52

 * 

    53

 *  The candidate datatype list will be filled with a list of all the data types that expression may legally take.

    54

 *  For example, the very simple literal '0' (as in foo := 0), may represent a:

    55

 *    BOOL, BYTE, WORD, DWORD, LWORD, USINT, SINT, UINT, INT, UDINT, DINT, ULINT, LINT (as well as the SAFE versions of these data tyes too!)

    56

 */

    57

    58

#include <../main.hh>         /* required for UINT64_MAX, INT64_MAX, INT64_MIN, ... */

    59

#include "fill_candidate_datatypes.hh"

    60

#include "datatype_functions.hh"

    61

#include <typeinfo>

    62

#include <list>

    63

#include <string>

    64

#include <string.h>

    65

#include <strings.h>

    66

    67

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

    68

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

    69

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

    70

    71

/* set to 1 to see debug info during execution */

    72

static int debug = 0;

    73

   185

fill_candidate_datatypes_c::fill_candidate_datatypes_c(symbol_c *ignore) {

   186

	il_operand = NULL;

   187

	prev_il_instruction = NULL;

   188

	search_varfb_instance_type = NULL;

   189

}

   190

   191

fill_candidate_datatypes_c::~fill_candidate_datatypes_c(void) {

   192

}

   193

   194

symbol_c *fill_candidate_datatypes_c::widening_conversion(symbol_c *left_type, symbol_c *right_type, const struct widen_entry widen_table[]) {

   195

	int k;

   196

	/* find a widening table entry compatible */

   197

	for (k = 0; NULL != widen_table[k].left;  k++)

   198

		if ((typeid(*left_type) == typeid(*widen_table[k].left)) && (typeid(*right_type) == typeid(*widen_table[k].right)))

   199

                      return widen_table[k].result;

   200

	return NULL;

   201

}

   202

   203

   204

/* add a data type to a candidate data type list, while guaranteeing no duplicate entries! */

   205

/* Returns true if it really did add the datatype to the list, or false if it was already present in the list! */

   206

bool fill_candidate_datatypes_c::add_datatype_to_candidate_list(symbol_c *symbol, symbol_c *datatype) {

   207

  /* If it is an invalid data type, do not insert!

   208

   * NOTE: it reduces overall code size to do this test here, instead of doing every time before calling the add_datatype_to_candidate_list() function. 

   209

   */

   210

  if (!get_datatype_info_c::is_type_valid(datatype)) /* checks for NULL and invalid_type_name_c */

   211

    return false;

   212

   213

  if (search_in_candidate_datatype_list(datatype, symbol->candidate_datatypes) >= 0) 

   214

    /* already in the list, Just return! */

   215

    return false;

   216

   217

  /* not yet in the candidate data type list, so we insert it now! */

   218

  symbol->candidate_datatypes.push_back(datatype);

   219

  return true;

   220

}

   221

   222

   223

bool fill_candidate_datatypes_c::add_2datatypes_to_candidate_list(symbol_c *symbol, symbol_c *datatype1, symbol_c *datatype2) {

   224

  add_datatype_to_candidate_list(symbol, datatype1);

   225

  add_datatype_to_candidate_list(symbol, datatype2);

   226

  return true;

   227

}

   228

   229

   230

   231

void fill_candidate_datatypes_c::remove_incompatible_datatypes(symbol_c *symbol) {

   232

  #ifdef __REMOVE__

   233

    #error __REMOVE__ macro already exists. Choose another name!

   234

  #endif

   235

  #define __REMOVE__(datatype)\

   236

      remove_from_candidate_datatype_list(&get_datatype_info_c::datatype,       symbol->candidate_datatypes);\

   237

      remove_from_candidate_datatype_list(&get_datatype_info_c::safe##datatype, symbol->candidate_datatypes);

   238

   239

  {/* Remove unsigned data types */

   240

    uint64_t value = 0;

   241

    if (VALID_CVALUE( uint64, symbol)) value = GET_CVALUE(uint64, symbol);

   242

    if (IS_OVERFLOW ( uint64, symbol)) value = (uint64_t)UINT32_MAX + (uint64_t)1;

   243

   244

    if (value > 1          )          {__REMOVE__(bool_type_name);}

   245

    if (value > UINT8_MAX  )          {__REMOVE__(usint_type_name);  __REMOVE__( byte_type_name);}

   246

    if (value > UINT16_MAX )          {__REMOVE__( uint_type_name);  __REMOVE__( word_type_name);}

   247

    if (value > UINT32_MAX )          {__REMOVE__(udint_type_name);  __REMOVE__(dword_type_name);}

   248

    if (IS_OVERFLOW( uint64, symbol)) {__REMOVE__(ulint_type_name);  __REMOVE__(lword_type_name);}

   249

  }

   250

   251

  {/* Remove signed data types */

   252

    int64_t value = 0;

   253

    if (VALID_CVALUE(  int64, symbol)) value = GET_CVALUE(int64, symbol);

   254

    if (IS_OVERFLOW (  int64, symbol)) value = (int64_t)INT32_MAX + (int64_t)1;

   255

   256

    if ((value <  INT8_MIN) || (value >  INT8_MAX)) {__REMOVE__(sint_type_name);}

   257

    if ((value < INT16_MIN) || (value > INT16_MAX)) {__REMOVE__( int_type_name);}

   258

    if ((value < INT32_MIN) || (value > INT32_MAX)) {__REMOVE__(dint_type_name);}

   259

    if (IS_OVERFLOW( int64, symbol))                {__REMOVE__(lint_type_name);}

   260

  }

   261

   262

  {/* Remove floating point data types */

   263

    real64_t value = 0;

   264

    if (VALID_CVALUE( real64, symbol)) value = GET_CVALUE(real64, symbol);

   265

    if (IS_OVERFLOW ( real64, symbol)) value = (real64_t)REAL32_MAX + (real64_t)1;

   266

    if (value >  REAL32_MAX )         {__REMOVE__( real_type_name);}

   267

    if (value < -REAL32_MAX )         {__REMOVE__( real_type_name);}

   268

    if (IS_OVERFLOW( real64, symbol)) {__REMOVE__(lreal_type_name);}

   269

  }

   270

  #undef __REMOVE__

   271

}

   272

   273

   274

/* returns true if compatible function/FB invocation, otherwise returns false */

   275

/* Assumes that the candidate_datatype lists of all the parameters being passed haved already been filled in */

   276

/*

   277

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

   278

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

   279

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

   280

 */

   281

bool fill_candidate_datatypes_c::match_nonformal_call(symbol_c *f_call, symbol_c *f_decl) {

   282

	symbol_c *call_param_value,  *param_datatype;

   283

	identifier_c *param_name;

   284

	function_param_iterator_c       fp_iterator(f_decl);

   285

	function_call_param_iterator_c fcp_iterator(f_call);

   286

	int extensible_parameter_highest_index = -1;

   287

	unsigned int i;

   288

   289

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

   290

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

   291

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

   292

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

   293

		 */

   294

		do {

   295

			param_name = fp_iterator.next();

   296

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

   297

			if(param_name == NULL) return false;

   298

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

   299

   300

		/* TODO: verify if it is lvalue when INOUT or OUTPUT parameters! */

   301

		/* Get the parameter type */

   302

		param_datatype = base_type(fp_iterator.param_type());

   303

   304

		/* check whether one of the candidate_data_types of the value being passed is the same as the param_type */

   305

		if (search_in_candidate_datatype_list(param_datatype, call_param_value->candidate_datatypes) < 0)

   306

			return false; /* return false if param_type not in the list! */

   307

	}

   308

	/* call is compatible! */

   309

	return true;

   310

}

   311

   312

   313

   314

/* returns true if compatible function/FB invocation, otherwise returns false */

   315

/* Assumes that the candidate_datatype lists of all the parameters being passed haved already been filled in */

   316

bool fill_candidate_datatypes_c::match_formal_call(symbol_c *f_call, symbol_c *f_decl, symbol_c **first_param_datatype) {

   317

	symbol_c *call_param_value, *call_param_name, *param_datatype;

   318

	symbol_c *verify_duplicate_param;

   319

	identifier_c *param_name;

   320

	function_param_iterator_c       fp_iterator(f_decl);

   321

	function_call_param_iterator_c fcp_iterator(f_call);

   322

	int extensible_parameter_highest_index = -1;

   323

	identifier_c *extensible_parameter_name;

   324

	unsigned int i;

   325

	bool is_first_param = true;

   326

   327

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

   328

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

   329

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

   330

		call_param_value = fcp_iterator.get_current_value();

   331

		/* the following should never occur. If it does, then we have a bug in our code... */

   332

		if (NULL == call_param_value) ERROR;

   333

   334

		/* Obtaining the assignment direction:  := (assign_in) or => (assign_out) */

   335

		function_call_param_iterator_c::assign_direction_t call_param_dir = fcp_iterator.get_assign_direction();

   336

   337

		/* Checking if there are duplicated parameter values */

   338

		verify_duplicate_param = fcp_iterator.search_f(call_param_name);

   339

		if(verify_duplicate_param != call_param_value)

   340

			return false;

   341

   342

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

   343

		std::vector <symbol_c *>&call_param_types = call_param_value->candidate_datatypes;

   344

   345

		/* Find the corresponding parameter in function declaration */

   346

		param_name = fp_iterator.search(call_param_name);

   347

		if(param_name == NULL) return false;

   348

		/* Get the parameter data type */

   349

		param_datatype = base_type(fp_iterator.param_type());

   350

		/* Get the parameter direction: IN, OUT, IN_OUT */

   351

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

   352

   353

		/* check whether direction (IN, OUT, IN_OUT) and assignment types (:= , =>) are compatible !!! */

   354

		if          (function_call_param_iterator_c::assign_in  == call_param_dir) {

   355

			if ((function_param_iterator_c::direction_in    != param_dir) &&

   356

			    (function_param_iterator_c::direction_inout != param_dir))

   357

				return false;

   358

		} else if   (function_call_param_iterator_c::assign_out == call_param_dir) {

   359

			if ((function_param_iterator_c::direction_out   != param_dir))

   360

				return false;

   361

		} else ERROR;

   362

   363

		/* check whether one of the candidate_data_types of the value being passed is the same as the param_type */

   364

		if (search_in_candidate_datatype_list(param_datatype, call_param_types) < 0)

   365

			return false; /* return false if param_type not in the list! */

   366

   367

		/* If this is the first parameter, then copy the datatype to *first_param_datatype */

   368

		if (is_first_param)

   369

			if (NULL != first_param_datatype)

   370

				*first_param_datatype = param_datatype;

   371

		is_first_param = false;

   372

	}

   373

	/* call is compatible! */

   374

	return true;

   375

}

   376

   377

   378

   379

   380

/* Handle a generic function call!

   381

 * Assumes that the parameter_list containing the values being passed in this function invocation

   382

 * has already had all the candidate_datatype lists filled in!

   383

 *

   384

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

   385

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

   386

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

   387

 */

   388

/*

   389

typedef struct {

   390

  symbol_c *function_name,

   391

  symbol_c *nonformal_operand_list,

   392

  symbol_c *   formal_operand_list,

   393

   394

  std::vector <symbol_c *> &candidate_functions,  

   395

  symbol_c &*called_function_declaration,

   396

  int      &extensible_param_count

   397

} generic_function_call_t;

   398

*/

   399

/*

   400

void narrow_candidate_datatypes_c::narrow_function_invocation(symbol_c *fcall, generic_function_call_t fcall_data) {

   401

void *fill_candidate_datatypes_c::handle_function_call(symbol_c *f_call, symbol_c *function_name, invocation_type_t invocation_type,

   402

                                                       std::vector <symbol_c *> *candidate_datatypes,

   403

                                                       std::vector <symbol_c *> *candidate_functions) {

   404

  */

   405

void fill_candidate_datatypes_c::handle_function_call(symbol_c *fcall, generic_function_call_t fcall_data) {

   406

	function_declaration_c *f_decl;

   407

	list_c *parameter_list;

   408

	list_c *parameter_candidate_datatypes;

   409

	symbol_c *returned_parameter_type;

   410

   411

	if (debug) std::cout << "function()\n";

   412

   413

	function_symtable_t::iterator lower = function_symtable.lower_bound(fcall_data.function_name);

   414

	function_symtable_t::iterator upper = function_symtable.upper_bound(fcall_data.function_name);

   415

	/* If the name of the function being called is not found in the function symbol table, then this is an invalid call */

   416

	/* Since the lexical parser already checks for this, then if this occurs then we have an internal compiler error. */

   417

	if (lower == function_symtable.end()) ERROR;

   418

   419

	/* Look for all compatible function declarations, and add their return datatypes 

   420

	 * to the candidate_datatype list of this function invocation. 

   421

	 *

   422

	 * If only one function exists, we add its return datatype to the candidate_datatype list,

   423

	 * even if the parameters passed to it are invalid.

   424

	 * This guarantees that the remainder of the expression in which the function call is inserted

   425

	 * is treated as if the function call returns correctly, and therefore does not generate

   426

	 * spurious error messages.

   427

	 * Even if the parameters to the function call are invalid, doing this is still safe, as the 

   428

	 * expressions inside the function call will themselves have erros and will  guarantee that 

   429

	 * compilation is aborted in stage3 (in print_datatypes_error_c).

   430

	 */

   431

	if (function_symtable.multiplicity(fcall_data.function_name) == 1) {

   432

		f_decl = function_symtable.get_value(lower);

   433

		returned_parameter_type = base_type(f_decl->type_name);

   434

		if (add_datatype_to_candidate_list(fcall, returned_parameter_type))

   435

			/* we only add it to the function declaration list if this entry was not already present in the candidate datatype list! */

   436

			fcall_data.candidate_functions.push_back(f_decl);

   437

   438

	}

   439

	for(; lower != upper; lower++) {

   440

		bool compatible = false;

   441

   442

		f_decl = function_symtable.get_value(lower);

   443

		/* Check if function declaration in symbol_table is compatible with parameters */

   444

		if (NULL != fcall_data.nonformal_operand_list) compatible=match_nonformal_call(fcall, f_decl);

   445

		if (NULL != fcall_data.   formal_operand_list) compatible=   match_formal_call(fcall, f_decl);

   446

		if (compatible) {

   447

			/* Add the data type returned by the called functions. 

   448

			 * However, only do this if this data type is not already present in the candidate_datatypes list_c

   449

			 */

   450

			returned_parameter_type = base_type(f_decl->type_name);		

   451

			if (add_datatype_to_candidate_list(fcall, returned_parameter_type))

   452

				/* we only add it to the function declaration list if this entry was not already present in the candidate datatype list! */

   453

				fcall_data.candidate_functions.push_back(f_decl);

   454

		}

   455

	}

   456

	if (debug) std::cout << "end_function() [" << fcall->candidate_datatypes.size() << "] result.\n";

   457

	return;

   458

}

   459

   460

   461

/* handle implicit FB call in IL.

   462

 * e.g.  CLK ton_var

   463

 *        CU counter_var

   464

 */

   465

void *fill_candidate_datatypes_c::handle_implicit_il_fb_call(symbol_c *il_instruction, const char *param_name, symbol_c *&called_fb_declaration) {

   466

	symbol_c *fb_type_id = search_varfb_instance_type->get_basetype_id(il_operand);

   467

  	/* Although a call to a non-declared FB is a semantic error, this is currently caught by stage 2! */

   468

	if (NULL == fb_type_id) ERROR;

   469

   470

	function_block_declaration_c *fb_decl = function_block_type_symtable.find_value(fb_type_id);

   471

	if (function_block_type_symtable.end_value() == fb_decl)

   472

		/* The il_operand is not the name of a FB instance. Most probably it is the name of a variable of some other type.

   473

		 * this is a semantic error.

   474

		 */

   475

		fb_decl = NULL;

   476

   477

	/* The narrow_candidate_datatypes_c does not rely on this called_fb_declaration pointer being == NULL to conclude that

   478

	 * we have a datatype incompatibility error, so we set it to fb_decl to allow the print_datatype_error_c to print out

   479

	 * more informative error messages!

   480

	 */

   481

	called_fb_declaration = fb_decl;

   482

   483

	/* This implicit FB call does not change the value stored in the current/default IL variable */

   484

	/* It does, however, require that the datatype be compatible with the input parameter of the FB being called. 

   485

	 * If we were to follow the filling & narrowing algorithm correctly (implemented in fill_candidate_datatypes_c

   486

	 * & narrow_candidate_datatypes_c respectively), we should be restricting the candidate_datatpes to the datatypes

   487

	 * that are compatible to the FB call. 

   488

	 * However, doing the above will often result in some very confusing error messages for the user, especially in the case

   489

	 * in which the FB call is wrong, so the resulting cadidate datatypes is an empty list. In this case, the user would see

   490

	 * many error messages related to the IL instructions that follow the FB call, even though those IL instructions may be perfectly

   491

	 * correct.

   492

	 * For now, we will simply let the narrow_candidate_datatypes_c verify if the datatypes are compatible (something that should be done

   493

	 * here).

   494

	 */

   495

	if (NULL != prev_il_instruction)

   496

		il_instruction->candidate_datatypes = prev_il_instruction->candidate_datatypes;