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

/*

    36

 *  Narrow class select and store a data type from candidate data types list for all symbols

    37

 */

    38

    39

#include "narrow_candidate_datatypes.hh"

    40

#include "datatype_functions.hh"

    41

#include <typeinfo>

    42

#include <list>

    43

#include <string>

    44

#include <string.h>

    45

#include <strings.h>

    46

    47

    48

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

    49

static int debug = 0;

    50

    51

narrow_candidate_datatypes_c::narrow_candidate_datatypes_c(symbol_c *ignore) {

    52

}

    53

    54

narrow_candidate_datatypes_c::~narrow_candidate_datatypes_c(void) {

    55

}

    56

    57

    58

/* Only set the symbol's desired datatype to 'datatype' if that datatype is in the candidate_datatype list */

    59

static void set_datatype(symbol_c *datatype, symbol_c *symbol) {

    60

	symbol->datatype = NULL;   

    61

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

    62

		symbol->datatype = datatype;  

    63

}

    64

    65

    66

    67

    68

bool narrow_candidate_datatypes_c::is_widening_compatible(symbol_c *left_type, symbol_c *right_type, symbol_c *result_type, const struct widen_entry widen_table[]) {

    69

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

    70

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

    71

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

    72

				&& (typeid(*result_type) == typeid(*widen_table[k].result))) {

    73

			return true;

    74

		}

    75

	}

    76

	return false;

    77

}

    78

    79

void narrow_candidate_datatypes_c::narrow_nonformal_call(symbol_c *f_call, symbol_c *f_decl, int *ext_parm_count) {

    80

	symbol_c *call_param_value,  *param_type;

    81

	identifier_c *param_name;

    82

	function_param_iterator_c       fp_iterator(f_decl);

    83

	function_call_param_iterator_c fcp_iterator(f_call);

    84

	int extensible_parameter_highest_index = -1;

    85

	unsigned int i;

    86

    87

	if (NULL != ext_parm_count) *ext_parm_count = -1;

    88

    89

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

    90

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

    91

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

    92

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

    93

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

    94

		 */

    95

		do {

    96

			param_name = fp_iterator.next();

    97

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

    98

			/* This error should have been caught in fill_candidate_datatypes_c, but may occur here again when we handle FB invocations! 

    99

			 * In this case, we carry on analysing the code in order to be able to provide relevant error messages

   100

			 * for that code too!

   101

			 */

   102

			if(param_name == NULL) break;

   103

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

   104

   105

		/* Set the desired datatype for this parameter, and call it recursively. */

   106

		/* Note that if the call has more parameters than those declared in the function/FB declaration,

   107

		 * we may be setting this to NULL!

   108

		 */

   109

		symbol_c *desired_datatype = base_type(fp_iterator.param_type());

   110

		if ((NULL != param_name) && (NULL == desired_datatype)) ERROR;

   111

		if ((NULL == param_name) && (NULL != desired_datatype)) ERROR;

   112

   113

		set_datatype(desired_datatype, call_param_value);

   114

		call_param_value->accept(*this);

   115

   116

		if (NULL != param_name) 

   117

			if (extensible_parameter_highest_index < fp_iterator.extensible_param_index())

   118

				extensible_parameter_highest_index = fp_iterator.extensible_param_index();

   119

	}

   120

	/* In the case of a call to an extensible function, we store the highest index 

   121

	 * of the extensible parameters this particular call uses, in the symbol_c object

   122

	 * of the function call itself!

   123

	 * In calls to non-extensible functions, this value will be set to -1.

   124

	 * This information is later used in stage4 to correctly generate the

   125

	 * output code.

   126

	 */

   127

	if ((NULL != ext_parm_count) && (extensible_parameter_highest_index >=0) /* if call to extensible function */)

   128

		*ext_parm_count = 1 + extensible_parameter_highest_index - fp_iterator.first_extensible_param_index();

   129

}

   130

   131

   132

   133

void narrow_candidate_datatypes_c::narrow_formal_call(symbol_c *f_call, symbol_c *f_decl, int *ext_parm_count) {

   134

	symbol_c *call_param_value, *call_param_name, *param_type;

   135

	symbol_c *verify_duplicate_param;

   136

	identifier_c *param_name;

   137

	function_param_iterator_c       fp_iterator(f_decl);

   138

	function_call_param_iterator_c fcp_iterator(f_call);

   139

	int extensible_parameter_highest_index = -1;

   140

	identifier_c *extensible_parameter_name;

   141

	unsigned int i;

   142

   143

	if (NULL != ext_parm_count) *ext_parm_count = -1;

   144

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

   145

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

   146

   147

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

   148

		call_param_value = fcp_iterator.get_current_value();

   149

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

   150

		if (NULL == call_param_value) ERROR;

   151

   152

		/* Find the corresponding parameter in function declaration */

   153

		param_name = fp_iterator.search(call_param_name);

   154

   155

		/* Set the desired datatype for this parameter, and call it recursively. */

   156

		/* NOTE: When handling a FB call, this narrow_formal_call() may be called to analyse

   157

		 *       an invalid FB call (call with parameters that do not exist on the FB declaration).

   158

		 *       For this reason, the param_name may come out as NULL!

   159

		 */

   160

		symbol_c *desired_datatype = base_type(fp_iterator.param_type());

   161

		if ((NULL != param_name) && (NULL == desired_datatype)) ERROR;

   162

		if ((NULL == param_name) && (NULL != desired_datatype)) ERROR;

   163

   164

		set_datatype(desired_datatype, call_param_value);

   165

		call_param_value->accept(*this);

   166

   167

		if (NULL != param_name) 

   168

			if (extensible_parameter_highest_index < fp_iterator.extensible_param_index())

   169

				extensible_parameter_highest_index = fp_iterator.extensible_param_index();

   170

	}

   171

	/* call is compatible! */

   172

   173

	/* In the case of a call to an extensible function, we store the highest index 

   174

	 * of the extensible parameters this particular call uses, in the symbol_c object

   175

	 * of the function call itself!

   176

	 * In calls to non-extensible functions, this value will be set to -1.

   177

	 * This information is later used in stage4 to correctly generate the

   178

	 * output code.

   179

	 */

   180

	if ((NULL != ext_parm_count) && (extensible_parameter_highest_index >=0) /* if call to extensible function */)

   181

		*ext_parm_count = 1 + extensible_parameter_highest_index - fp_iterator.first_extensible_param_index();

   182

}

   183

   184

   185

/*

   186

typedef struct {

   187

  symbol_c *function_name,

   188

  symbol_c *nonformal_operand_list,

   189

  symbol_c *   formal_operand_list,

   190

   191

  std::vector <symbol_c *> &candidate_functions,  

   192

  symbol_c &*called_function_declaration,

   193

  int      &extensible_param_count

   194

} generic_function_call_t;

   195

*/

   196

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

   197

	/* set the called_function_declaration. */

   198

	fcall_data.called_function_declaration = NULL;

   199

   200

	/* set the called_function_declaration taking into account the datatype that we need to return */

   201

	for(unsigned int i = 0; i < fcall->candidate_datatypes.size(); i++) {

   202

		if (is_type_equal(fcall->candidate_datatypes[i], fcall->datatype)) {

   203

			fcall_data.called_function_declaration = fcall_data.candidate_functions[i];

   204

			break;

   205

		}

   206

	}

   207

   208

	/* NOTE: If we can't figure out the declaration of the function being called, this is not 

   209

	 *       necessarily an internal compiler error. It could be because the symbol->datatype is NULL

   210

	 *       (because the ST code being analysed has an error _before_ this function invocation).

   211

	 *       However, we don't just give, up, we carry on recursivly analysing the code, so as to be

   212

	 *       able to print out any error messages related to the parameters being passed in this function 

   213

	 *       invocation.

   214

	 */

   215

	/* if (NULL == symbol->called_function_declaration) ERROR; */

   216

	if (fcall->candidate_datatypes.size() == 1) {

   217

		/* If only one function declaration, then we use that (even if symbol->datatypes == NULL)

   218

		 * so we can check for errors in the expressions used to pass parameters in this

   219

		 * function invocation.

   220

		 */

   221

		fcall_data.called_function_declaration = fcall_data.candidate_functions[0];

   222

	}

   223

   224

	/* If an overloaded function is being invoked, and we cannot determine which version to use,

   225

	 * then we can not meaningfully verify the expressions used inside that function invocation.

   226

	 * We simply give up!

   227

	 */

   228

	if (NULL == fcall_data.called_function_declaration)

   229

		return;

   230

   231

	if (NULL != fcall_data.nonformal_operand_list)  narrow_nonformal_call(fcall, fcall_data.called_function_declaration, &(fcall_data.extensible_param_count));

   232

	if (NULL != fcall_data.   formal_operand_list)     narrow_formal_call(fcall, fcall_data.called_function_declaration, &(fcall_data.extensible_param_count));

   233

   234

	return;

   235

}

   236

   237

   238

   239

/* a helper function... */

   240

symbol_c *narrow_candidate_datatypes_c::base_type(symbol_c *symbol) {

   241

	/* NOTE: symbol == NULL is valid. It will occur when, for e.g., an undefined/undeclared symbolic_variable is used

   242

	 *       in the code.

   243

	 */

   244

	if (symbol == NULL) return NULL;

   245

	return (symbol_c *)symbol->accept(search_base_type);	

   246

}

   247

   248

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

   249

/* B 1.2 - Constants */

   250

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

   251

   252

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

   253

/* B 1.3 - Data types */

   254

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

   255

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

   256

/* B 1.3.3 - Derived data types */

   257

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

   258

/*  signed_integer DOTDOT signed_integer */

   259

// SYM_REF2(subrange_c, lower_limit, upper_limit)

   260

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

   261

	symbol->lower_limit->datatype = symbol->datatype;

   262

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

   263

	symbol->upper_limit->datatype = symbol->datatype;

   264

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

   265

	return NULL;

   266

}

   267

   268

   269

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

   270

/* B 1.4 - Variables */

   271

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

   272

   273

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

   274

/* B 1.4.1 - Directly Represented Variables */

   275

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

   276

   277

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

   278

/* B 1.4.2 - Multi-element variables */

   279

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

   280

/*  subscripted_variable '[' subscript_list ']' */

   281

// SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   282

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

   283

	/* we need to check the data types of the expressions used for the subscripts... */

   284

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

   285

	return NULL;

   286

}

   287

   288

   289

/* subscript_list ',' subscript */

   290

// SYM_LIST(subscript_list_c)

   291

void *narrow_candidate_datatypes_c::visit(subscript_list_c *symbol) {

   292

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

   293

		for (unsigned int k = 0; k < symbol->elements[i]->candidate_datatypes.size(); k++) {

   294

			if (is_ANY_INT_type(symbol->elements[i]->candidate_datatypes[k]))

   295

				symbol->elements[i]->datatype = symbol->elements[i]->candidate_datatypes[k];

   296

		}

   297

		symbol->elements[i]->accept(*this);

   298

	}

   299

	return NULL;  

   300

}

   301

   302

   303

   304

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

   305

/* B 1.5 Program organization units */

   306

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

   307

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

   308

/* B 1.5.1 Functions */

   309

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

   310

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

   311

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   312

	if (debug) printf("Narrowing candidate data types list in body of function %s\n", ((token_c *)(symbol->derived_function_name))->value);

   313

	prev_il_instruction = NULL;

   314

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

   315

	prev_il_instruction = NULL;

   316

	delete search_varfb_instance_type;

   317

	search_varfb_instance_type = NULL;

   318

	return NULL;

   319

}

   320

   321

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

   322

/* B 1.5.2 Function blocks */

   323

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

   324

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

   325

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   326

	if (debug) printf("Narrowing candidate data types list in body of FB %s\n", ((token_c *)(symbol->fblock_name))->value);

   327

	prev_il_instruction = NULL;

   328

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

   329

	prev_il_instruction = NULL;

   330

	delete search_varfb_instance_type;

   331

	search_varfb_instance_type = NULL;

   332

	return NULL;

   333

}

   334

   335

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

   336

/* B 1.5.3 Programs */

   337

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

   338

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

   339

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   340

	if (debug) printf("Narrowing candidate data types list in body of program %s\n", ((token_c *)(symbol->program_type_name))->value);

   341

	prev_il_instruction = NULL;

   342

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

   343

	prev_il_instruction = NULL;

   344

	delete search_varfb_instance_type;

   345

	search_varfb_instance_type = NULL;

   346

	return NULL;

   347

}

   348

   349

   350

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

   351

/* B 1.7 Configuration elements */

   352

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

   353

void *narrow_candidate_datatypes_c::visit(configuration_declaration_c *symbol) {

   354

#if 0

   355

	// TODO !!!

   356

	/* for the moment we must return NULL so semantic analysis of remaining code is not interrupted! */

   357

#endif

   358

	return NULL;

   359

}

   360

   361

   362

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

   363

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

   364

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

   365

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

   366

/* B 2.1 Instructions and Operands */

   367

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

   368

// void *visit(instruction_list_c *symbol);

   369

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

   370

	il_operand = symbol->il_operand;

   371

	if (NULL != symbol->il_operand) {

   372

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

   373

	}

   374

	/* recursive call to see whether data types are compatible */

   375

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

   376

	il_operand = NULL;

   377

	return NULL;

   378

}

   379

   380

/* | function_name [il_operand_list] */

   381

/* NOTE: The parameters 'called_function_declaration' and 'extensible_param_count' are used to pass data between the stage 3 and stage 4. */

   382

// SYM_REF2(il_function_call_c, function_name, il_operand_list, symbol_c *called_function_declaration; int extensible_param_count;)

   383

void *narrow_candidate_datatypes_c::visit(il_function_call_c *symbol) {

   384

	generic_function_call_t fcall_param = {

   392

	};

   393

   394

	/* The first parameter of a non formal function call in IL will be the 'current value' (i.e. the prev_il_instruction)

   395

	 * In order to be able to handle this without coding special cases, we simply prepend that symbol

   396

	 * to the il_operand_list (done in fill_candidate_datatypes_c), and remove it later (in the print_datatypes_error_c).

   397

	 *

   398

	 * Since this class is executed after fill_candidate_datatypes_c, and before print_datatypes_error_c,

   399

	 * the following code is actually correct!

   400

	 */

   401

	narrow_function_invocation(symbol, fcall_param);

   402

	return NULL;

   403

}

   404

   405

/* MJS: Manuele, could you please not delete the following 2 lines of comments. They help me understand where this class is used

   406

 *     and when it is created by bison - syntax parse, and how it can show up in the abstract syntax tree.

   407

 *

   408

 *       Actually, it could be helpful if we could have all the similar comments already present in visit_expression_type_c

   409

 *       in the 3 new classes fill/narrow/print candidate datatype 

   410

 */

   411

/* | il_expr_operator '(' [il_operand] eol_list [simple_instr_list] ')' */

   412

// SYM_REF3(il_expression_c, il_expr_operator, il_operand, simple_instr_list);

   413

void *narrow_candidate_datatypes_c::visit(il_expression_c *symbol) {

   414

/* MJS: TODO... */

   415

return NULL;

   416

}

   417

   418

/*   il_call_operator prev_declared_fb_name

   419

 * | il_call_operator prev_declared_fb_name '(' ')'

   420

 * | il_call_operator prev_declared_fb_name '(' eol_list ')'

   421

 * | il_call_operator prev_declared_fb_name '(' il_operand_list ')'

   422

 * | il_call_operator prev_declared_fb_name '(' eol_list il_param_list ')'

   423

 */

   424

/* NOTE: The parameter 'called_fb_declaration'is used to pass data between stage 3 and stage4 (although currently it is not used in stage 4 */

   425

// SYM_REF4(il_fb_call_c, il_call_operator, fb_name, il_operand_list, il_param_list, symbol_c *called_fb_declaration)

   426

void *narrow_candidate_datatypes_c::visit(il_fb_call_c *symbol) {

   427

	/* Note: We do not use the symbol->called_fb_declaration value (set in fill_candidate_datatypes_c)

   428

	 *       because we try to identify any other datatype errors in the expressions used in the 

   429

	 *       parameters to the FB call. e.g.

   430

	 *          fb_var( 

   431

	 *             in1 := var1,

   432

	 *             in2 := (

   433

	 *                       LD 56

   434

	 *                       ADD 43

   435

	 *                    )

   436

	 *             )

   437

	 *       even it the call to the FB is invalid. 

   438

	 *       This makes sense because it may be errors in those expressions which are

   439

	 *       making this an invalid call, so it makes sense to point them out to the user!

   440

	 */

   441

	symbol_c *fb_decl = search_varfb_instance_type->get_basetype_decl(symbol->fb_name);

   442

   443

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

   444

	if (NULL == fb_decl) ERROR;

   445

	if (NULL != symbol->il_operand_list)  narrow_nonformal_call(symbol, fb_decl);

   446

	if (NULL != symbol->  il_param_list)     narrow_formal_call(symbol, fb_decl);

   447

   448

	return NULL;

   449

}

   450

   451

   452

/* | function_name '(' eol_list [il_param_list] ')' */

   453

/* NOTE: The parameter 'called_function_declaration' is used to pass data between the stage 3 and stage 4. */

   454

// SYM_REF2(il_formal_funct_call_c, function_name, il_param_list, symbol_c *called_function_declaration; int extensible_param_count;)

   455

void *narrow_candidate_datatypes_c::visit(il_formal_funct_call_c *symbol) {

   456

	generic_function_call_t fcall_param = {

   464

	};

   465

   466

	narrow_function_invocation(symbol, fcall_param);

   467

	return NULL;

   468

}

   469

   470

   471

/*

   472

    void *visit(il_operand_list_c *symbol);

   473

    void *visit(simple_instr_list_c *symbol);

   474

    void *visit(il_param_list_c *symbol);

   475

    void *visit(il_param_assignment_c *symbol);

   476

    void *visit(il_param_out_assignment_c *symbol);

   477

 */

   478

   479

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

   480

/* B 2.2 Operators */

   481

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

   482

void *narrow_candidate_datatypes_c::visit(LD_operator_c *symbol) {

   483

	prev_il_instruction = symbol;

   484

	return NULL;

   485

}

   486

   487

void *narrow_candidate_datatypes_c::visit(LDN_operator_c *symbol) {

   488

	if (symbol->candidate_datatypes.size() != 1)

   489

		return NULL;

   490

	symbol->datatype = symbol->candidate_datatypes[0];

   491

	il_operand->datatype = symbol->datatype;

   492

	il_operand->accept(*this);

   493

	prev_il_instruction = symbol;

   494

	return NULL;

   495

}

   496

   497

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

   498

	if (symbol->candidate_datatypes.size() != 1)

   499

		return NULL;

   500

	symbol->datatype = symbol->candidate_datatypes[0];

   501

	il_operand->datatype = symbol->datatype;

   502

	il_operand->accept(*this);

   503

	prev_il_instruction = symbol;

   504

	return NULL;

   505

}

   506

   507

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

   508

	if (symbol->candidate_datatypes.size() != 1)

   509

		return NULL;

   510

	symbol->datatype = symbol->candidate_datatypes[0];

   511

	il_operand->datatype = symbol->datatype;

   512

	il_operand->accept(*this);

   513

	prev_il_instruction = symbol;

   514