1

/*

     2

 *  matiec - a compiler for the programming languages defined in IEC 61131-3

     3

 *

     4

 *  Copyright (C) 2012  Mario de Sousa (msousa@fe.up.pt)

     5

 *

     6

 *  This program is free software: you can redistribute it and/or modify

     7

 *  it under the terms of the GNU General Public License as published by

     8

 *  the Free Software Foundation, either version 3 of the License, or

     9

 *  (at your option) any later version.

    10

 *

    11

 *  This program is distributed in the hope that it will be useful,

    12

 *  but WITHOUT ANY WARRANTY; without even the implied warranty of

    13

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    14

 *  GNU General Public License for more details.

    15

 *

    16

 *  You should have received a copy of the GNU General Public License

    17

 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.

    18

 *

    19

 *

    20

 * This code is made available on the understanding that it will not be

    21

 * used in safety-critical situations without a full and competent review.

    22

 */

    23

    24

/*

    25

 * An IEC 61131-3 compiler.

    26

 *

    27

 * Based on the

    28

 * FINAL DRAFT - IEC 61131-3, 2nd Ed. (2001-12-10)

    29

 *

    30

 */

    31

    32

    33

/*

    34

 *  Do flow control analysis of the IEC 61131-3 code.

    35

 *

    36

 *  We currently only do this for IL code.

    37

 *  This class will annotate the abstract syntax tree, by filling in the

    38

 *  prev_il_instruction variable in the il_instruction_c, so it points to

    39

 *  the previous il_instruction_c object in the instruction list instruction_list_c.

    40

 *

    41

 *  The result will essentially be a linked list of il_instruction_c objects, each 

    42

 *  pointing to the previous il_instruction_c object.

    43

 *

    44

 *  The reality is we will get several independent and isolated linked lists

    45

 *  (actually, once we process labels correctly, this will become a graph):

    46

 *  one for each block of IL code (e.g. inside a Function, FB or Program).

    47

 *  Additionally, when the IL code has an expression (expression_c object), we will actually

    48

 *  have one more isolated linked list for the IL code inside that expression.

    49

 *

    50

 *  e.g.

    51

 *       line_1:   LD 1

    52

 *       line_2:   ADD (42

    53

 *       line_3:        ADD B

    54

 *       line_4:        ADD C 

    55

 *       line_5:       )

    56

 *       line_6:   ADD D

    57

 *       line_7:   ST  E

    58

 * 

    59

 *     will result in two independent linked lists:

    60

 *       main list:  line_7 -> line_6 -> line2 -> line_1

    61

 *       expr list:  lin4_4 -> line_3 -> (operand of line_2, i.e. '42')

    62

 * 

    63

 * 

    64

 *     In the main list, each:

    65

 *        line_x: IL_operation IL_operand

    66

 *      is encoded as

    67

 *          il_instruction_c(label, il_incomplete_instruction)

    68

 *      these il_instruction_c objects will point back to the previous il_instruction_c object.

    69

 *

    70

 *     In the expr list, each 

    71

 *        line_x:        IL_operation IL_operand

    72

 *      is encoded as

    73

 *          il_simple_instruction_c(il_simple_instruction)

    74

 *      these il_simple_instruction_c objects will point back to the previous il_simple_instruction_c object,

    75

 *      except the for the first il_simple_instruction_c object in the list, which will point back to

    76

 *      the first il_operand (in the above example, '42'), or NULL is it does not exist.

    77

 *          

    78

 *

    79

 * label:

    80

 *   identifier_c  

    81

 *   

    82

 * il_incomplete_instruction:

    83

 *   il_simple_operation   (il_simple_operation_c, il_function_call_c)

    84

 * | il_expression         (il_expression_c)

    85

 * | il_jump_operation     (il_jump_operation_c)

    86

 * | il_fb_call            (il_fb_call_c)

    87

 * | il_formal_funct_call  (il_formal_funct_call_c)

    88

 * | il_return_operator    (RET_operator_c, RETC_operator_c, RETCN_operator_c)

    89

 *  

    90

 * 

    91

 * il_expression_c(il_expr_operator, il_operand, simple_instr_list)

    92

 * 

    93

 * il_operand:

    94

 *   variable            (symbolic_variable_c, direct_variable_c, array_variable_c, structured_variable_c)  

    95

 * | enumerated_value    (enumerated_value_c)

    96

 * | constant            (lots of literal classes _c)

    97

 * 

    98

 * simple_instr_list:

    99

 *   list of il_simple_instruction

   100

 * 

   101

 * il_simple_instruction:

   102

 *   il_simple_operation       (il_simple_operation_c, il_function_call_c)

   103

 * | il_expression             (il_expression_c)

   104

 * | il_formal_funct_call      (il_formal_funct_call_c)

   105

 * 

   106

 */

   107

   108

#include "flow_control_analysis.hh"

   109

   110

   111

   112

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

   113

static int debug = 0;

   114

   115

flow_control_analysis_c::flow_control_analysis_c(symbol_c *ignore) {

   116

  prev_il_instruction = NULL;

   117

  curr_il_instruction = NULL;

   118

}

   119

   120

flow_control_analysis_c::~flow_control_analysis_c(void) {

   121

}

   122

   123

   124

   125

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

   126

/* B 1.5 Program organization units */

   127

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

   128

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

   129

/* B 1.5.1 Functions */

   130

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

   131

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

   132

	search_il_label = new search_il_label_c(symbol);

   133

	if (debug) printf("Doing flow control analysis in body of function %s\n", ((token_c *)(symbol->derived_function_name))->value);

   134

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

   135

	delete search_il_label;

   136

	search_il_label = NULL;

   137

	return NULL;

   138

}

   139

   140

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

   141

/* B 1.5.2 Function blocks */

   142

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

   143

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

   144

	search_il_label = new search_il_label_c(symbol);

   145

	if (debug) printf("Doing flow control analysis in body of FB %s\n", ((token_c *)(symbol->fblock_name))->value);

   146

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

   147

	delete search_il_label;

   148

	search_il_label = NULL;

   149

	return NULL;

   150

}

   151

   152

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

   153

/* B 1.5.3 Programs */

   154

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

   155

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

   156

	search_il_label = new search_il_label_c(symbol);

   157

	if (debug) printf("Doing flow control analysis in body of program %s\n", ((token_c *)(symbol->program_type_name))->value);

   158

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

   159

	delete search_il_label;

   160

	search_il_label = NULL;

   161

	return NULL;

   162

}

   163

   164

   165

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

   166

/* B 1.7 Configuration elements */

   167

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

   168

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

   169

	return NULL;

   170

}

   171

   172

   173

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

   174

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

   175

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

   176

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

   177

/* B 2.1 Instructions and Operands */

   178

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

   179

   180

/*| instruction_list il_instruction */

   181

// SYM_LIST(instruction_list_c)

   182

void *flow_control_analysis_c::visit(instruction_list_c *symbol) {

   183

	prev_il_instruction_is_JMP_or_RET = false;

   184

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

   185

		prev_il_instruction = NULL;

   186

		if (i > 0) prev_il_instruction = symbol->elements[i-1];

   187

		curr_il_instruction = symbol->elements[i];

   188

		curr_il_instruction->accept(*this);

   189

		curr_il_instruction = NULL;

   190

	}

   191

	return NULL;

   192

}

   193

   194

/* | label ':' [il_incomplete_instruction] eol_list */

   195

// SYM_REF2(il_instruction_c, label, il_instruction)

   196

// void *visit(instruction_list_c *symbol);

   197

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

   198

	if ((NULL != prev_il_instruction) && (!prev_il_instruction_is_JMP_or_RET))

   199

		symbol->prev_il_instruction.push_back(prev_il_instruction);

   200

   201

	/* check if it is an il_expression_c, a JMP[C[N]], or a RET, and if so, handle it correctly */

   202

	prev_il_instruction_is_JMP_or_RET = false;

   203

	if (NULL != symbol->il_instruction)

   204

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

   205

	return NULL;

   206

}

   207

   208

   209

   210

/* | il_simple_operator [il_operand] */

   211

// SYM_REF2(il_simple_operation_c, il_simple_operator, il_operand)

   212

// void *flow_control_analysis_c::visit(il_simple_operation_c *symbol)

   213

   214

   215

   216

/* | function_name [il_operand_list] */

   217

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

   218

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

   219

// void *flow_control_analysis_c::visit(il_function_call_c *symbol) 

   220

   221

   222

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

   223

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

   224

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

   225

	if(NULL == symbol->simple_instr_list) 

   226

		/* nothing to do... */

   227

		return NULL;

   228

   229

	symbol_c *save_prev_il_instruction = prev_il_instruction;

   230

	prev_il_instruction = symbol->il_operand;

   231

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

   232

	prev_il_instruction = save_prev_il_instruction;

   233

	return NULL;

   234

}

   235

   236

   237

/*  il_jump_operator label */

   238

// SYM_REF2(il_jump_operation_c, il_jump_operator, label)

   239

void *flow_control_analysis_c::visit(il_jump_operation_c *symbol) {

   240

  /* search for the il_instruction_c containing the label */

   241

  il_instruction_c *destination = search_il_label->find_label(symbol->label);

   242

   243

  /* give the visit(JMP_operator *) an oportunity to set the prev_il_instruction_is_JMP_or_RET flag! */

   244

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

   245

  /* add, to that il_instruction's list of prev_il_intsructions, the curr_il_instruction */

   246

  if (NULL != destination)

   247

    destination->prev_il_instruction.push_back(curr_il_instruction);

   248

  return NULL;

   249

}

   250

   251

   252

/*   il_call_operator prev_declared_fb_name

   253

 * | il_call_operator prev_declared_fb_name '(' ')'

   254

 * | il_call_operator prev_declared_fb_name '(' eol_list ')'

   255

 * | il_call_operator prev_declared_fb_name '(' il_operand_list ')'

   256

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

   257

 */

   258

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

   259

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

   260

// void *flow_control_analysis_c::visit(il_fb_call_c *symbol)

   261

   262

   263

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

   264

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

   265

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

   266

// void *flow_control_analysis_c::visit(il_formal_funct_call_c *symbol)

   267

   268

   269

   270

//  void *visit(il_operand_list_c *symbol);

   271

void *flow_control_analysis_c::visit(simple_instr_list_c *symbol) {

   272

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

   273

		/* The prev_il_instruction for element[0] was set in visit(il_expression_c *) */

   274

		if (i>0) prev_il_instruction = symbol->elements[i-1];

   275

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

   276

	}

   277

	return NULL;

   278

}

   279

   280

   281

// SYM_REF1(il_simple_instruction_c, il_simple_instruction, symbol_c *prev_il_instruction;)

   282

void *flow_control_analysis_c::visit(il_simple_instruction_c*symbol) {

   283

	if (NULL != prev_il_instruction)

   284

		symbol->prev_il_instruction.push_back(prev_il_instruction);

   285

	return NULL;

   286

}

   287

   288

   289

/*

   290

    void *visit(il_param_list_c *symbol);

   291

    void *visit(il_param_assignment_c *symbol);

   292

    void *visit(il_param_out_assignment_c *symbol);

   293

 */

   294

   295

   296

   297

   298

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

   299

/* B 2.2 Operators */

   300

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

   301

// void *visit(   LD_operator_c *symbol);

   302

// void *visit(  LDN_operator_c *symbol);

   303

// void *visit(   ST_operator_c *symbol);

   304

// void *visit(  STN_operator_c *symbol);

   305

// void *visit(  NOT_operator_c *symbol);

   306

// void *visit(    S_operator_c *symbol);

   307

// void *visit(    R_operator_c *symbol);

   308

// void *visit(   S1_operator_c *symbol);

   309

// void *visit(   R1_operator_c *symbol);

   310

// void *visit(  CLK_operator_c *symbol);

   311

// void *visit(   CU_operator_c *symbol);

   312

// void *visit(   CD_operator_c *symbol);

   313

// void *visit(   PV_operator_c *symbol);

   314

// void *visit(   IN_operator_c *symbol);

   315

// void *visit(   PT_operator_c *symbol);

   316

// void *visit(  AND_operator_c *symbol);

   317

// void *visit(   OR_operator_c *symbol);

   318

// void *visit(  XOR_operator_c *symbol);

   319

// void *visit( ANDN_operator_c *symbol);

   320

// void *visit(  ORN_operator_c *symbol);

   321

// void *visit( XORN_operator_c *symbol);

   322

// void *visit(  ADD_operator_c *symbol);

   323

// void *visit(  SUB_operator_c *symbol);

   324

// void *visit(  MUL_operator_c *symbol);

   325

// void *visit(  DIV_operator_c *symbol);

   326

// void *visit(  MOD_operator_c *symbol);

   327

// void *visit(   GT_operator_c *symbol);

   328

// void *visit(   GE_operator_c *symbol);

   329

// void *visit(   EQ_operator_c *symbol);

   330

// void *visit(   LT_operator_c *symbol);

   331

// void *visit(   LE_operator_c *symbol);

   332

// void *visit(   NE_operator_c *symbol);

   333

// void *visit(  CAL_operator_c *symbol);

   334

// void *visit( CALC_operator_c *symbol);

   335

// void *visit(CALCN_operator_c *symbol);

   336

   337

/* this next visit function will be called directly from visit(il_instruction_c *) */

   338

void *flow_control_analysis_c::visit(  RET_operator_c *symbol) {

   339

	prev_il_instruction_is_JMP_or_RET = true;

   340

	return NULL;

   341

}

   342

   343

// void *visit( RETC_operator_c *symbol);

   344

// void *visit(RETCN_operator_c *symbol);

   345

   346

/* this next visit function will be called from visit(il_jump_operation_c *) */

   347

void *flow_control_analysis_c::visit(  JMP_operator_c *symbol) {

   348

	prev_il_instruction_is_JMP_or_RET = true;

   349

	return NULL;

   350

}

   351

   352

// void *visit( JMPC_operator_c *symbol);

   353

// void *visit(JMPCN_operator_c *symbol);

   354

   355

/* Symbol class handled together with function call checks */

   356

// void *visit(il_assign_operator_c *symbol, variable_name);

   357

/* Symbol class handled together with function call checks */

   358

// void *visit(il_assign_operator_c *symbol, option, variable_name);

   359