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

 *  Data type analysis of IL code may leave some IL instructions with an undefined datatype.

    35

 *  This visitor will set the datatype for all these symbols, so that all symbols have a well 

    36

 *  defined datatype when we reach stage4.

    37

 *

    38

 *  Example:

    39

 * =========

    40

 *

    41

 *  VAR 

    42

 *     N   : INT := 99 ;    

    43

 *     tonv: TON;

    44

 *     byte_var: BYTE;

    45

 *     tonv : TON;

    46

 *     a : BYTE;

    47

 *     t : time;

    48

 *     tod1: tod;

    49

 *  END_VAR

    50

 *  

    51

 * (0) --> Data type before executing forced_narrow_candidate_datatypes_c

    52

 * (1) --> Data type after executing 1st pass of forced_narrow_candidate_datatypes_c

    53

 * (2) --> Data type after executing 2nd pass of forced_narrow_candidate_datatypes_c

    54

 * 

    55

 * --- --> NULL (undefined datatype)

    56

 * *** --> invalid_type_name_c (invalid datatype)

    57

 *

    58

 * (0)   PASS1   (1)    PASS2   (2)

    59

 *      

    60

 * ---     (e)   ***            ***       CAL tonv (                          

    61

 *                                               PT := T#1s                   

    62

 *                                            )                               

    63

 * ---     (e)   ***            ***       JMP l4                              

    64

 *

    65

 * ---     (e)   sint           sint  l0: LD  1                               

    66

 * ---     (e)   sint           sint      ADD 2                               

    67

 * ---  (c)      sint           sint      CAL tonv (                          

    68

 *                                            PT := T#1s                      

    69

 *                                            )                               

    70

 *                                                                            

    71

 * ---     (e)   sint           sint      LD  45                              

    72

 * ---  (c)      sint           sint      ADD 45                              

    73

 *

    74

 *

    75

 * ---     (e)   sint           sint      LD  3                               

    76

 * ---     (e)   sint           sint  l1:                                     

    77

 * ---  (c)      sint           sint  l2: ADD 4                               

    78

 * int           int            int       LD  5                               

    79

 * int           int            int       ST  n                               

    80

 * int           int            int       JMP l3                              

    81

 *                                                                            

    82

 * ---  (d)      ---      (e)   sint      LD  5                               

    83

 * ---  (d)      ---      (e)   sint      SUB 6                               

    84

 * ---  (d)(e)   sint           sint      JMP l1                              

    85

 *

    86

 * ---     (e)   bool           bool      LD  FALSE                           

    87

 * ---     (e)   bool           bool      NOT                                 

    88

 * ---  (b)      bool           bool      RET                                 

    89

 *

    90

 * int           int            int   l3:                                     

    91

 * int           int            int       ST  n                               

    92

 * ---  (b)      int            int       RET                                 

    93

 *

    94

 * ---     (e)   ***            ***   l4:                                     

    95

 * ---     (e)   ***            ***       CAL tonv (                          

    96

 *                                               PT := T#1s                   

    97

 *                                            )                               

    98

 * ---  (a)      ***            ***       JMP l0                              

    99

 * ---  (b)      byte           byte      LD  88                              

   100

 *

   101

 *

   102

 *   

   103

 */

   104

   105

   106

   107

#include "forced_narrow_candidate_datatypes.hh"

   108

#include "datatype_functions.hh"

   109

   110

   111

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

   112

static int debug = 0;

   113

   114

forced_narrow_candidate_datatypes_c::forced_narrow_candidate_datatypes_c(symbol_c *ignore) 

   115

 :narrow_candidate_datatypes_c(ignore) {

   116

}

   117

   118

forced_narrow_candidate_datatypes_c::~forced_narrow_candidate_datatypes_c(void) {

   119

}

   120

   121

   122

   123

void forced_narrow_candidate_datatypes_c::set_datatype_in_prev_il_instructions(symbol_c *datatype, il_instruction_c *symbol) {

   124

	if (NULL == symbol) ERROR;

   125

	/* In the forced_narrow_candidate_datatypes algorithm, we do NOT set any datatypes to invalid_type_name_c

   126

	 * Any IL instructions that really are of an invalid_type_name_c (because the IL code is buggy?) have already

   127

	 * been set by the standard narrow_candidate_datatypes algorithm.

   128

	 * 

   129

	 * Remember too that valid IL code may also have some IL instructions correctly set to invalid_type_name_c, especially

   130

	 * in cases where the data in the accumulator will not be used in the current IL instruction

   131

	 * For example:

   132

	 *        LD   bool_var

   133

	 *        JMPC label1

   134

	 *        LD 34

   135

	 *        ST int_var

   136

	 * lable1:            <----  This IL instruction_c (with NULL symbol->il_instruction) has invalid_type_name_c datatype!!

   137

	 *        LD T#3s              And yet, the code is legal!!!

   138

	 *        ST time_var

   139

	 */ 

   140

	if (!get_datatype_info_c::is_type_valid(datatype)) return;

   141

	// Call the 'original' version of the set_datatype_in_prev_il_instructions() function, from narrow_candidate_datatypes_c

   142

	return narrow_candidate_datatypes_c::set_datatype_in_prev_il_instructions(datatype, symbol);

   143

}

   144

   145

   146

   147

void forced_narrow_candidate_datatypes_c::forced_narrow_il_instruction(symbol_c *symbol, std::vector <symbol_c *> &next_il_instruction) {

   148

  if (NULL == symbol->datatype) {

   149

    if (symbol->candidate_datatypes.empty()) {

   150

      symbol->datatype = &(get_datatype_info_c::invalid_type_name); // This will occur in the situations (a) in the above example

   151

      // return NULL; // No need to return control to the visit() method of the base class... But we do so, just to be safe (called at the end of this function)!

   152

    } else {

   153

      if (next_il_instruction.empty()) {

   154

        symbol->datatype = symbol->candidate_datatypes[0]; // This will occur in the situations (b) in the above example

   155

      } else {

   156

        symbol_c *next_datatype = NULL;

   157

   158

        /* find the datatype of the following IL instructions (they should all be identical by now, but we don't have an assertion checking for this. */

   159

        for (unsigned int i=0; i < next_il_instruction.size(); i++)

   160

          if (NULL != next_il_instruction[i]->datatype)

   161

            next_datatype = next_il_instruction[i]->datatype;

   162

        if (get_datatype_info_c::is_type_valid(next_datatype)) {

   163

          //  This will occur in the situations (c) in the above example

   164

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

   165

        } else {

   166

          //  This will occur in the situations (d) in the above example

   167

          // it is not possible to determine the exact situation in the current pass, so we can't do anything just yet. Leave it for the next time around!

   168

        }

   169

      }

   170

    }

   171

  }

   172

}

   173

   174

   175

   176

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

   177

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

   178

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

   179

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

   180

/* B 2.1 Instructions and Operands */

   181

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

   182

   183

/*| instruction_list il_instruction */

   184

// SYM_LIST(instruction_list_c)

   185

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

   186

  for(int j = 0; j < 2; j++) {

   187

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

   188

      symbol->get_element(i)->accept(*this);

   189

    }

   190

  }

   191

   192

  /* Assert that this algorithm managed to remove all NULL datatypes! */

   193

  /* NOTE: The forced_narrow_candidate_datatypes_c assumes that the original IEC 61131-3 source code does not have any bugs!

   194

   *       This means we cannot run this assertion here, as the compiler will bork in the presence of bug in the code being compiled! Not good!!

   195

   */

   196

  /*

   197

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

   198

    if (NULL == symbol->get_element(i)->datatype)

   199

      ERROR;

   200

  }

   201

  */

   202

   203

  return NULL;

   204

}

   205

   206

   207

   208

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

   209

// SYM_REF2(il_instruction_c, label, il_instruction)

   210

// void *visit(instruction_list_c *symbol);

   211

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

   212

  forced_narrow_il_instruction(symbol, symbol->next_il_instruction);

   213

   214

  /* return control to the visit() method of the base class! */

   215

  return narrow_candidate_datatypes_c::visit(symbol);  //  This handles the situations (e) in the above example

   216

}

   217

   218

   219

   220

   221

   222

/* | il_simple_operator [il_operand] */

   223

// SYM_REF2(il_simple_operation_c, il_simple_operator, il_operand)

   224

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

   225

   226

/* | function_name [il_operand_list] */

   227

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

   228

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

   229

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

   230

   231

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

   232

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

   233

// void *forced_narrow_candidate_datatypes_c::visit(il_expression_c *symbol)

   234

   235

/*  il_jump_operator label */

   236

// SYM_REF2(il_jump_operation_c, il_jump_operator, label)

   237

// void *forced_narrow_candidate_datatypes_c::visit(il_jump_operation_c *symbol)

   238

   239

/*   il_call_operator prev_declared_fb_name

   240

 * | il_call_operator prev_declared_fb_name '(' ')'

   241

 * | il_call_operator prev_declared_fb_name '(' eol_list ')'

   242

 * | il_call_operator prev_declared_fb_name '(' il_operand_list ')'

   243

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

   244

 */

   245

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

   246

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

   247

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

   248

   249

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

   250

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

   251

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

   252

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

   253

   254

// void *visit(il_operand_list_c *symbol);

   255

// void *forced_narrow_candidate_datatypes_c::visit(simple_instr_list_c *symbol)

   256

   257

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

   258

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

   259

  forced_narrow_il_instruction(symbol, symbol->next_il_instruction);

   260

   261

  /* return control to the visit() method of the base class! */

   262

  return narrow_candidate_datatypes_c::visit(symbol);  //  This handle the situations (e) in the above example

   263

}

   264

   265

   266

/*

   267

    void *visit(il_param_list_c *symbol);

   268

    void *visit(il_param_assignment_c *symbol);

   269

    void *visit(il_param_out_assignment_c *symbol);

   270

 */

   271

   272

   273

   274

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

   275

/* B.3 - Language ST (Structured Text) */

   276

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

   277

// SYM_LIST(statement_list_c)

   278

/* The normal narrow_candidate_datatypes_c algorithm does not leave any symbol, in an ST code, with an undefined datatype.

   279

 * There is therefore no need to re-run the narrow algorithm here, so we overide the narrow_candidate_datatypes_c visitor,

   280

 * and simply bug out!

   281

 */

   282

void *forced_narrow_candidate_datatypes_c::visit(statement_list_c *symbol) {return NULL;}

   283