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

 * WARNING: This visitor class starts off by building a map of all enumeration constants that are defined in the source code (i.e. a library_c symbol),

    58

 *          and this map is later used to determine the datatpe of each use of an enumeration constant. By implication, the fill_candidate_datatypes_c 

    59

 *          visitor class will only work corretly if it is asked to visit a symbol of class library_c!!

    60

 */

    61

    62

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

    63

#include "fill_candidate_datatypes.hh"

    64

#include "datatype_functions.hh"

    65

#include <typeinfo>

    66

#include <list>

    67

#include <string>

    68

#include <string.h>

    69

#include <strings.h>

    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

#define IS_OVERFLOW(dtype, symbol)            ((symbol)->const_value._##dtype.is_overflow())

    75

    76

    77

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

    78

static int debug = 0;

    79

    80

    81

    82

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

    83

/*                                                   */

    84

/*  A small helper class...                          */

    85

/*                                                   */

    86

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

    87

    88

/* Add to the global_enumerated_value_symtable the global enum value constants, i.e. the enum constants used in the enumerated

    89

 * datatypes that are defined inside a TYPE ... END_TYPE declaration.

    90

 */

    91

/* NOTE: we do not store any NULL values in this symbol table, so we can safely use NULL and the null value. */

    92

    93

typedef dsymtable_c<symbol_c *> enumerated_value_symtable_t;

    94

static enumerated_value_symtable_t global_enumerated_value_symtable;

    95

    96

    97

class populate_globalenumvalue_symtable_c: public iterator_visitor_c {

    98

  private:

    99

    symbol_c *current_enumerated_type;

   100

   101

  public:

   102

     populate_globalenumvalue_symtable_c(void) {current_enumerated_type = NULL;};

   103

    ~populate_globalenumvalue_symtable_c(void) {}

   104

   105

  public:

   106

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

   107

  /* B.1 - Common elements */

   108

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

   109

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

   110

  /* B.1.3 - Data types */

   111

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

   112

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

   113

  /* B 1.3.3 - Derived data types */

   114

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

   115

  /*  enumerated_type_name ':' enumerated_spec_init */

   116

  void *visit(enumerated_type_declaration_c *symbol) {

   117

  //current_enumerated_type = symbol->enumerated_type_name;

   118

    current_enumerated_type = symbol;

   119

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

   120

    current_enumerated_type = NULL;

   121

    return NULL;

   122

  }

   123

   124

  /* enumerated_specification ASSIGN enumerated_value */

   125

  void *visit(enumerated_spec_init_c *symbol) {

   126

    return symbol->enumerated_specification->accept(*this);

   127

  }

   128

   129

  /* [enumerated_type_name '#'] identifier */

   130

  void *visit(enumerated_value_c *symbol) {

   131

    if (current_enumerated_type == NULL) ERROR;

   132

    if (symbol->type != NULL) ERROR;

   133

   134

    enumerated_value_symtable_t::iterator lower = global_enumerated_value_symtable.lower_bound(symbol->value);

   135

    enumerated_value_symtable_t::iterator upper = global_enumerated_value_symtable.upper_bound(symbol->value);

   136

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

   137

      if (lower->second == current_enumerated_type) {

   138

        /*  The same identifier is used more than once as an enumerated value/constant inside the same enumerated datat type! */

   139

        return NULL; /* No need to insert it! It is already in the table! */

   140

      }

   141

   142

    global_enumerated_value_symtable.insert(symbol->value, current_enumerated_type);

   143

    return NULL;

   144

  }

   145

   146

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

   147

  /* B.1.5 - Program organization units */

   148

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

   149

  /* B 1.5.1 - Functions */

   150

  void *visit(function_declaration_c *symbol) {return NULL;}

   151

  /* B 1.5.2 - Function Blocks */

   152

  void *visit(function_block_declaration_c *symbol) {return NULL;}

   153

  /* B 1.5.3 - Programs */

   154

  void *visit(program_declaration_c *symbol) {return NULL;}

   155

   156

}; /* populate_globalenumvalue_symtable_c */

   157

   158

static populate_globalenumvalue_symtable_c populate_globalenumvalue_symtable;

   159

   160

   161

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

   162

/*                                                   */

   163

/*  A small helper class...                          */

   164

/*                                                   */

   165

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

   166

   167

/* Add to the local_enumerated_value_symtable the local enum value constants */

   168

/* Notes:

   169

 * Some enumerations are 

   170

 *   (A) declared anonymously inside a VAR ... END_VAR declaration

   171

 *       (e.g. VAR enum_var : (enumvalue1, enumvalue2); END_VAR)

   172

 *  while others are 

   173

 *   (B) declared (with a name) inside a TYPE .. END_TYPE declaration.

   174

 *

   175

 *  Values in (A) are added to the enumerated_value_symtable in absyntaxt_utils.cc.

   176

 *  Values in (B) are only in scope inside the POU with the VAR END_VAR declaration.

   177

 *

   178

 * This class will add the enum values in (B) to the local_enumerated_value_symtable.

   179

 *

   180

 * If a locally defined enum value is identical to another locally defined enum_value, a 

   181

 *  duplicate entry is created.

   182

 *  However, if a locally defined enum value is identical to another globally defined enum_value, the

   183

 *  corresponding entry in local_enumerated_value_symtable is also set to the local datatype.

   184

 *  This is because anonynous locally feined enum datatypes are anonymous, and its enum values cannot therefore

   185

 *  be disambiguated using EnumType#enum_value (since the enum type does not have a name, it is anonymous!).

   186

 *  For this reason we implement the semantics where locally defined enum values, when in scope, will 'cover'

   187

 *  the globally defined enum value with the same name/identifier.

   188

 *  For example:

   189

 *

   190

 *  TYPE  GlobalEnumT: (xxx1, xxx2, xxx3) END_TYPE

   191

 * 

   192

 *   FUNCTION_BLOCK FOO

   193

 *    VAR_INPUT

   194

 *       GlobalEnumVar: GlobalEnumT;

   195

 *      LocalEnumVar : (xxx1, yyy2, yyy3);

   196

 *     END_VAR

   197

 *     LocalEnumVar  := xxx1;   <-- We consider it OK!!!     xxx1 will reference the anonymous type used for LocalEnumVar

   198

 *     GlobalEnumVar := xxx1;   <-- We consider it an error. xxx1 will reference the anonymous type used for LocalEnumVar

   199

 *     GlobalEnumVar := GlobalEnumT#xxx1;

   200

 *     END_FUNCTION_BLOCK

   201

 */

   202

   203

static enumerated_value_symtable_t local_enumerated_value_symtable;

   204

   205

   206

class populate_localenumvalue_symtable_c: public iterator_visitor_c {

   207

  private:

   208

    symbol_c *current_enumerated_type;

   209

   210

  public:

   211

     populate_localenumvalue_symtable_c(void) {current_enumerated_type = NULL;};

   212

    ~populate_localenumvalue_symtable_c(void) {}

   213

   214

  public:

   215

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

   216

  /* B.1 - Common elements */

   217

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

   218

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

   219

  /* B.1.3 - Data types */

   220

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

   221

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

   222

  /* B 1.3.3 - Derived data types */

   223

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

   224

  /*  TYPE type_declaration_list END_TYPE */

   225

  void *visit(data_type_declaration_c *symbol) {return NULL;} // do not visit the type declarations!!

   226

   227

  /* enumerated_specification ASSIGN enumerated_value */

   228

  void *visit(enumerated_spec_init_c *symbol) {

   229

    current_enumerated_type = symbol;

   230

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

   231

    /* DO NOT visit the symbol->enumerated_value   !!! */

   232

    current_enumerated_type = NULL;

   233

    return NULL;

   234

  }

   235

   236

  /* [enumerated_type_name '#'] identifier */

   237

  void *visit(enumerated_value_c *symbol) {

   238

    /* if the enumerated_value_c is not inside a enumerated_spec_init_c (e.g. used as the inital value of a variable), we simply return */

   239

    if (current_enumerated_type == NULL) return NULL;  

   240

    /* this is really an ERROR! The initial value may use the syntax NUM_TYPE#enum_value, but in that case we should have return'd in the above statement !! */

   241

    if (symbol->type != NULL) ERROR;  

   242

   243

    enumerated_value_symtable_t::iterator lower = local_enumerated_value_symtable.lower_bound(symbol->value);

   244

    enumerated_value_symtable_t::iterator upper = local_enumerated_value_symtable.upper_bound(symbol->value);

   245

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

   246

      if (lower->second == current_enumerated_type) {

   247

        /*  The same identifier is used more than once as an enumerated value/constant inside the same enumerated datat type! */

   248

        return NULL; /* No need to insert it! It is already in the table! */

   249

      }

   250

   251

    /* add it to the local symbol table. */

   252

    local_enumerated_value_symtable.insert(symbol->value, current_enumerated_type);

   253

    return NULL;

   254

  }

   255

}; // class populate_enumvalue_symtable_c

   256

   257

static populate_localenumvalue_symtable_c populate_enumvalue_symtable;

   258

   259

   260

   261

   262

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

   263

/*                                                   */

   264

/*  Main  FILL candidate datatypes algorithm...      */

   265

/*                                                   */

   266

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

   267

   268

   269

fill_candidate_datatypes_c::fill_candidate_datatypes_c(symbol_c *ignore) {

   270

	il_operand = NULL;

   271

	prev_il_instruction = NULL;

   272

	search_var_instance_decl = NULL;

   273

	current_enumerated_spec_type = NULL;

   274

	current_scope = NULL;

   275

}

   276

   277

fill_candidate_datatypes_c::~fill_candidate_datatypes_c(void) {

   278

}

   279

   280

   281

   282

   283

   284

   285

   286

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

   287

	int k;

   288

	/* find a widening table entry compatible */

   289

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

   290

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

   291

                      return widen_table[k].result;

   292

	return NULL;

   293

}

   294

   295

   296

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

   297

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

   298

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

   299

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

   300

   * 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. 

   301

   */

   302

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

   303

    return false;

   304

   305

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

   306

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

   307

    return false;

   308

   309

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

   310

  symbol->candidate_datatypes.push_back(datatype);

   311

  return true;

   312

}

   313

   314

   315

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

   316

  add_datatype_to_candidate_list(symbol, datatype1);

   317

  add_datatype_to_candidate_list(symbol, datatype2);

   318

  return true;

   319

}

   320

   321

   322

   323

void fill_candidate_datatypes_c::remove_incompatible_datatypes(symbol_c *symbol) {

   324

  #ifdef __REMOVE__

   325

    #error __REMOVE__ macro already exists. Choose another name!

   326

  #endif

   327

  #define __REMOVE__(datatype)\

   328

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

   329

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

   330

   331

  {/* Remove unsigned data types */

   332

    uint64_t value = 0;

   333

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

   334

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

   335

   336

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

   337

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

   338

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

   339

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

   340

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

   341

  }

   342

   343

  {/* Remove signed data types */

   344

    int64_t value = 0;

   345

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

   346

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

   347

   348

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

   349

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

   350

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

   351

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

   352

  }

   353

   354

  {/* Remove floating point data types */

   355

    real64_t value = 0;

   356

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

   357

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

   358

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

   359

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

   360

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

   361

  }

   362

  #undef __REMOVE__

   363

}

   364

   365

   366

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

   367

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

   368

/*

   369

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

   370

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

   371

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

   372

 */

   373

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

   374

	symbol_c *call_param_value,  *param_datatype;

   375

	identifier_c *param_name;

   376

	function_param_iterator_c       fp_iterator(f_decl);

   377

	function_call_param_iterator_c fcp_iterator(f_call);

   378

	int extensible_parameter_highest_index = -1;

   379

	unsigned int i;

   380

   381

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

   382

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

   383

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

   384

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

   385

		 */

   386

		do {

   387

			param_name = fp_iterator.next();

   388

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

   389

			if(param_name == NULL) return false;

   390

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

   391

   392

		/* Get the parameter type */

   393

		param_datatype = base_type(fp_iterator.param_type());

   394

   395

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

   396

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

   397

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

   398

	}

   399

	/* call is compatible! */

   400

	return true;

   401

}

   402

   403

   404

   405

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

   406

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

   407

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

   408

	symbol_c *call_param_value, *call_param_name, *param_datatype;

   409

	symbol_c *verify_duplicate_param;

   410

	identifier_c *param_name;

   411

	function_param_iterator_c       fp_iterator(f_decl);

   412

	function_call_param_iterator_c fcp_iterator(f_call);

   413

	int extensible_parameter_highest_index = -1;

   414

	identifier_c *extensible_parameter_name;

   415

	unsigned int i;

   416

	bool is_first_param = true;

   417

   418

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

   419

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

   420

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

   421

		call_param_value = fcp_iterator.get_current_value();

   422

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

   423

		if (NULL == call_param_value) ERROR;

   424

   425

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

   426

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

   427

   428

		/* Checking if there are duplicated parameter values */

   429

		verify_duplicate_param = fcp_iterator.search_f(call_param_name);

   430

		if(verify_duplicate_param != call_param_value)

   431

			return false;

   432

   433

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

   434

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

   435

   436

		/* Find the corresponding parameter in function declaration */

   437

		param_name = fp_iterator.search(call_param_name);

   438

		if(param_name == NULL) return false;

   439

		/* Get the parameter data type */

   440

		param_datatype = base_type(fp_iterator.param_type());

   441

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

   442

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

   443

   444

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

   445

		if          (function_call_param_iterator_c::assign_in  == call_param_dir) {

   446

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

   447

			    (function_param_iterator_c::direction_inout != param_dir))

   448

				return false;

   449

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

   450

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

   451

				return false;

   452

		} else ERROR;

   453

   454

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

   455

		if (search_in_candidate_datatype_list(param_datatype, call_param_types) < 0)

   456

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

   457

   458

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

   459

		if (is_first_param)

   460

			if (NULL != first_param_datatype)

   461

				*first_param_datatype = param_datatype;

   462

		is_first_param = false;

   463

	}

   464

	/* call is compatible! */

   465

	return true;

   466

}

   467

   468

   469

   470

   471

/* Handle a generic function call!

   472

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

   473

 * has already had all the candidate_datatype lists filled in!

   474

 *

   475

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

   476

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

   477

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

   478

 */

   479

/*

   480

typedef struct {

   481

  symbol_c *function_name,

   482

  symbol_c *nonformal_operand_list,

   483

  symbol_c *   formal_operand_list,

   484

   485

  std::vector <symbol_c *> &candidate_functions,  

   486

  symbol_c &*called_function_declaration,

   487

  int      &extensible_param_count

   488

} generic_function_call_t;

   489

*/

   490

/*

   491

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

   492

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

   493

                                                       std::vector <symbol_c *> *candidate_datatypes,

   494

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

   495

  */

   496