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

    61

	/* If we are trying to set to the undefined type, and the symbol's datatype has already been set to something else, 

    62

	 * we abort the compoiler as I don't think this should ever occur. 

    63

	 * NOTE: In order to handle JMPs to labels that come before the JMP itself, we run the narrow algorithm twice.

    64

	 *       This means that this situation may legally occur, so we cannot abort the compiler here!

    65

	 */

    66

// 	if ((NULL == datatype) && (NULL != symbol->datatype)) ERROR;

    67

 	if ((NULL == datatype) && (NULL != symbol->datatype)) return;

    68

	if ((NULL == datatype) && (NULL == symbol->datatype)) return;

    69

    70

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

    71

		symbol->datatype = &(search_constant_type_c::invalid_type_name);   

    72

	else {

    73

		if (NULL == symbol->datatype)   

    74

			/* not yet set to anything, so we set it to the requested data type */

    75

			symbol->datatype = datatype; 

    76

		else {

    77

			/* had already been set previously to some data type. Let's check if they are the same! */

    78

			if (!is_type_equal(symbol->datatype, datatype))

    79

				symbol->datatype = &(search_constant_type_c::invalid_type_name);

    80

// 			else 

    81

				/* we leave it unchanged, as it is the same as the requested data type! */

    82

		}

    83

	}

    84

}

    85

    86

    87

    88

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

    89

// static void set_datatype_in_prev_il_instructions(symbol_c *datatype, std::vector <symbol_c *> prev_il_instructions) {

    90

static void set_datatype_in_prev_il_instructions(symbol_c *datatype, il_instruction_c *symbol) {

    91

	if (NULL == symbol) ERROR;

    92

	for (unsigned int i = 0; i < symbol->prev_il_instruction.size(); i++)

    93

		set_datatype(datatype, symbol->prev_il_instruction[i]);

    94

}

    95

    96

    97

    99

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

   100

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

   101

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

   104

			return true;

   105

		}

   106

	}

   107

	return false;

   108

}

   109

   110

/*

   111

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

   112

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

   113

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

   114

 */

   115

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

   116

	symbol_c *call_param_value,  *param_type;

   117

	identifier_c *param_name;

   118

	function_param_iterator_c       fp_iterator(f_decl);

   119

	function_call_param_iterator_c fcp_iterator(f_call);

   120

	int extensible_parameter_highest_index = -1;

   121

	unsigned int i;

   122

   123

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

   124

   125

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

   126

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

   127

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

   128

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

   129

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

   130

		 */

   131

		do {

   132

			param_name = fp_iterator.next();

   133

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

   134

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

   135

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

   136

			 * for that code too!

   137

			 */

   138

			if(param_name == NULL) break;

   139

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

   140

   141

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

   142

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

   143

		 * we may be setting this to NULL!

   144

		 */

   145

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

   146

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

   147

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

   148

   149

		/* NOTE: When we are handling a nonformal function call made from IL, the first parameter is the 'default' or 'current'

   150

		 *       il value. However, a pointer to a copy of the prev_il_instruction is pre-pended into the operand list, so 

   151

		 *       the call 

   152

		 *       call_param_value->accept(*this);

   153

		 *       may actually be calling an object of the base symbol_c .

   154

		 */

   155

		set_datatype(desired_datatype, call_param_value);

   156

		call_param_value->accept(*this);

   157

   158

		if (NULL != param_name) 

   159

			if (extensible_parameter_highest_index < fp_iterator.extensible_param_index())

   160

				extensible_parameter_highest_index = fp_iterator.extensible_param_index();

   161

	}

   162

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

   163

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

   164

	 * of the function call itself!

   165

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

   166

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

   167

	 * output code.

   168

	 */

   169

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

   170

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

   171

}

   172

   173

   174

   175

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

   176

	symbol_c *call_param_value, *call_param_name, *param_type;

   177

	symbol_c *verify_duplicate_param;

   178

	identifier_c *param_name;

   179

	function_param_iterator_c       fp_iterator(f_decl);

   180

	function_call_param_iterator_c fcp_iterator(f_call);

   181

	int extensible_parameter_highest_index = -1;

   182

	identifier_c *extensible_parameter_name;

   183

	unsigned int i;

   184

   185

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

   186

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

   187

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

   188

   189

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

   190

		call_param_value = fcp_iterator.get_current_value();

   191

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

   192

		if (NULL == call_param_value) ERROR;

   193

   194

		/* Find the corresponding parameter in function declaration */

   195

		param_name = fp_iterator.search(call_param_name);

   196

   197

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

   198

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

   199

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

   200

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

   201

		 */

   202

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

   203

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

   204

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

   205

   206

		/* set the desired data type for this parameter */

   207

		set_datatype(desired_datatype, call_param_value);

   208

		/* And recursively call that parameter/expression, so it can propagate that info */

   209

		call_param_value->accept(*this);

   210

   211

		/* set the extensible_parameter_highest_index, which will be needed in stage 4 */

   212

		/* This value says how many extensible parameters are being passed to the standard function */

   213

		if (NULL != param_name) 

   214

			if (extensible_parameter_highest_index < fp_iterator.extensible_param_index())

   215

				extensible_parameter_highest_index = fp_iterator.extensible_param_index();

   216

	}

   217

	/* call is compatible! */

   218

   219

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

   220

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

   221

	 * of the function call itself!

   222

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

   223

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

   224

	 * output code.

   225

	 */

   226

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

   227

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

   228

}

   229

   230

   231

/*

   232

typedef struct {

   233

  symbol_c *function_name,

   234

  symbol_c *nonformal_operand_list,

   235

  symbol_c *   formal_operand_list,

   236

   237

  std::vector <symbol_c *> &candidate_functions,  

   238

  symbol_c &*called_function_declaration,

   239

  int      &extensible_param_count

   240

} generic_function_call_t;

   241

*/

   242

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

   243

	/* set the called_function_declaration. */

   244

	fcall_data.called_function_declaration = NULL;

   245

   246

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

   247

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

   248

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

   249

			fcall_data.called_function_declaration = fcall_data.candidate_functions[i];

   250

			break;

   251

		}

   252

	}

   253

   254

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

   255

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

   256

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

   257

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

   258

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

   259

	 *       invocation.

   260

	 */

   261

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

   262

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

   263

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

   264

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

   265

		 * function invocation.

   266

		 */

   267

		fcall_data.called_function_declaration = fcall_data.candidate_functions[0];

   268

	}

   269

   270

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

   271

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

   272

	 * We simply give up!

   273

	 */

   274

	if (NULL == fcall_data.called_function_declaration)

   275

		return;

   276

   277

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

   278

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

   279

   280

	return;

   281

}

   282

   283

   284

   285

   286

/* narrow implicit FB call in IL.

   287

 * e.g.  CLK ton_var

   288

 *        CU counter_var

   289

 *

   290

 * The algorithm will be to build a fake il_fb_call_c equivalent to the implicit IL FB call, and let 

   291

 * the visit(il_fb_call_c *) method handle it!

   292

 */

   293

void *narrow_candidate_datatypes_c::narrow_implicit_il_fb_call(symbol_c *il_instruction, const char *param_name, symbol_c *&called_fb_declaration) {

   294

   295

	/* set the datatype of the il_operand, this is, the FB being called! */

   296

	if (NULL != il_operand) {

   297

		/* only set it if it is in the candidate datatypes list! */  

   298

		set_datatype(called_fb_declaration, il_operand);

   299

		il_operand->accept(*this);

   300

	}

   301

	symbol_c *fb_decl = il_operand->datatype;

   302

   303

	if (0 == fake_prev_il_instruction->prev_il_instruction.size()) {

   304

		/* This IL implicit FB call (e.g. CLK ton_var) is not preceded by another IL instruction

   305

		 * (or list of instructions) that will set the IL current/default value.

   306

		 * We cannot proceed verifying type compatibility of something that does not exist.

   307

		 */

   308

		return NULL;

   309

	}

   310

   311

	if (NULL == fb_decl) {

   312

		/* the il_operand is a not FB instance */

   313

		/* so we simply pass on the required datatype to the prev_il_instructions */

   314

		/* The invalid FB invocation will be caught in the print_datatypes_error_c by analysing NULL value in il_operand->datatype! */

   315

		set_datatype_in_prev_il_instructions(il_instruction->datatype, fake_prev_il_instruction);

   316

		return NULL;

   317

	}

   318

   319

   320

	/* The value being passed to the 'param_name' parameter is actually the prev_il_instruction.

   321

	 * However, we do not place that object directly in the fake il_param_list_c that we will be

   322

	 * creating, since the visit(il_fb_call_c *) method will recursively call every object in that list.

   323

	 * The il_prev_intruction object will be visited once we have handled this implici IL FB call

   324

	 * (called from the instruction_list_c for() loop that works backwards). We DO NOT want to visit it twice.

   325

	 * (Anyway, if we let the visit(il_fb_call_c *) recursively visit the current prev_il_instruction, this pointer

   326

	 * would be changed to the IL instruction coming before the current prev_il_instruction! => things would get all messed up!)

   327

	 * The easiest way to work around this is to simply use a new object, and copy the relevant details to that object!

   328

	 */

   329

	symbol_c param_value = *fake_prev_il_instruction; /* copy the candidate_datatypes list ! */

   330

   331

	identifier_c variable_name(param_name);

   332

	// SYM_REF1(il_assign_operator_c, variable_name)

   333

	il_assign_operator_c il_assign_operator(&variable_name);  

   334

	// SYM_REF3(il_param_assignment_c, il_assign_operator, il_operand, simple_instr_list)

   335

	il_param_assignment_c il_param_assignment(&il_assign_operator, &param_value/*il_operand*/, NULL);

   336

	il_param_list_c il_param_list;

   337

	il_param_list.add_element(&il_param_assignment);

   338

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

   339

	CAL_operator_c CAL_operator;

   340

	il_fb_call_c il_fb_call(&CAL_operator, il_operand, NULL, &il_param_list);

   341

   342

	/* A FB call does not return any datatype, but the IL instructions that come after this

   343

	 * FB call may require a specific datatype in the il current/default variable, 

   344

	 * so we must pass this information up to the IL instruction before the FB call, since it will

   345

	 * be that IL instruction that will be required to produce the desired dtataype.

   346

	 *

   347

	 * The above will be done by the visit(il_fb_call_c *) method, so we must make sure to

   348

	 * correctly set up the il_fb_call.datatype variable!

   349

	 */

   350

	il_fb_call.called_fb_declaration = called_fb_declaration;

   351

	il_fb_call.accept(*this);

   352

   353

	/* set the required datatype of the previous IL instruction! */

   354

	/* NOTE:

   355

	 * When handling these implicit IL calls, the parameter_value being passed to the FB parameter

   356

	 * is actually the prev_il_instruction.

   357

	 * 

   358

	 * However, since the FB call does not change the value in the current/default IL variable, this value

   359

	 * must also be used ny the IL instruction coming after this FB call.

   360

	 *

   361

	 * This means that we have two consumers/users for the same value. 

   362

	 * We must therefore check whether the datatype required by the IL instructions following this FB call 

   363

	 * is the same as that required for the first parameter. If not, then we have a semantic error,

   364

	 * and we set it to invalid_type_name.

   365

	 *

   366

	 * However, we only do that if:

   367

	 *  - The IL instruction that comes after this IL FB call actually asked this FB call for a specific 

   368

	 *     datatype in the current/default vairable, once this IL FB call returns.

   369

	 *     However, sometimes, (for e.g., this FB call is the last in the IL list) the subsequent FB to not aks this

   370

	 *     FB call for any datatype. In that case, then the datatype required to pass to the first parameter of the

   371

	 *     FB call must be left unchanged!

   372

	 */

   373

	if ((NULL == il_instruction->datatype) || (is_type_equal(param_value.datatype, il_instruction->datatype))) {

   374

		set_datatype_in_prev_il_instructions(param_value.datatype, fake_prev_il_instruction);

   375

	} else {

   376

		set_datatype_in_prev_il_instructions(&search_constant_type_c::invalid_type_name, fake_prev_il_instruction);

   377

	}

   378

	return NULL;

   379

}

   380

   381

   382

/* a helper function... */

   383

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

   384

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

   385

	 *       in the code.

   386

	 */

   387

	if (symbol == NULL) return NULL;

   388

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

   389

}

   390

   391

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

   392

/* B 1.2 - Constants */

   393

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

   394

   395

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

   396

/* B 1.3 - Data types */

   397

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

   398

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

   399

/* B 1.3.3 - Derived data types */

   400

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

   401

/*  signed_integer DOTDOT signed_integer */

   402

// SYM_REF2(subrange_c, lower_limit, upper_limit)

   403

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

   404

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

   405

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

   406

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

   407

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

   408

	return NULL;

   409

}

   410

   411

/* simple_specification ASSIGN constant */

   412

// SYM_REF2(simple_spec_init_c, simple_specification, constant)

   413

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

   414

	symbol_c *datatype = base_type(symbol->simple_specification); 

   415

	if (NULL != symbol->constant) {

   416

		int typeoffset = search_in_candidate_datatype_list(datatype, symbol->constant->candidate_datatypes);

   417

		if (typeoffset >= 0)

   418

			symbol->constant->datatype = symbol->constant->candidate_datatypes[typeoffset];

   419

	}

   420

	return NULL;

   421

}

   422

   423

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

   424

/* B 1.4 - Variables */

   425

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

   426

   427

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

   428

/* B 1.4.1 - Directly Represented Variables */

   429

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

   430

   431

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

   432

/* B 1.4.2 - Multi-element variables */

   433

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

   434

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

   435

// SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   436

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

   437

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

   438

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

   439

	return NULL;

   440

}

   441

   442

   443

/* subscript_list ',' subscript */

   444

// SYM_LIST(subscript_list_c)

   445

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

   446

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

   447

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

   448

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

   449

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

   450

		}

   451

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

   452

	}

   453

	return NULL;  

   454

}

   455

   456

   457

   458

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

   459

/* B 1.5 Program organization units */

   460

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

   461

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

   462

/* B 1.5.1 Functions */

   463

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

   464

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

   465

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   466

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

   467

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

   468

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

   469

	delete search_varfb_instance_type;

   470

	search_varfb_instance_type = NULL;

   471

	return NULL;

   472

}

   473

   474

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

   475

/* B 1.5.2 Function blocks */

   476

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

   477

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

   478

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   479

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

   480

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

   481

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

   482

	delete search_varfb_instance_type;

   483

	search_varfb_instance_type = NULL;

   484

	return NULL;

   485

}

   486

   487

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

   488

/* B 1.5.3 Programs */

   489

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

   490

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

   491

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   492

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

   493

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

   494

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

   495

	delete search_varfb_instance_type;

   496

	search_varfb_instance_type = NULL;

   497

	return NULL;

   498

}

   499

   500

   501

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

   502

/* B 1.7 Configuration elements */

   503

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

   504

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