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 (conti.ma@alice.it)

     6

 *

     7

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

     8

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

     9

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

    10

 *  (at your option) any later version.

    11

 *

    12

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

    13

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

    14

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    15

 *  GNU General Public License for more details.

    16

 *

    17

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

    18

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

    19

 *

    20

 *

    21

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

    22

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

    23

 */

    24

    25

/*

    26

 * An IEC 61131-3 compiler.

    27

 *

    28

 * Based on the

    29

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

    30

 *

    31

 */

    32

    33

/* Determine the value of an constant expression.

    34

 * A reference to the relevant type definition is returned.

    35

 *

    36

 * For example:

    37

 *       2 + 3       -> returns reference 

    38

 *       22.2 - 5    -> returns reference

    39

 *       etc...

    40

 */

    41

    42

#include <vector>

    43

#include "../absyntax_utils/absyntax_utils.hh"

    44

#include "../util/symtable.hh"

    45

    46

    47

    48

/* For the moment we disable constant propagation algorithm as it is not yet complete, 

    49

 * and due to this is currently brocken and producing incorrect results!

    50

 */

    51

#define DO_CONSTANT_PROPAGATION__ 0

    52

    53

    54

    55

class constant_folding_c : public iterator_visitor_c {

    56

  protected:

    57

    int error_count;

    58

    bool warning_found;

    59

    int current_display_error_level;

    60

  private:

    61

    /* Pointer to the previous IL instruction, which contains the current cvalue of the data stored in the IL stack, i.e. the default variable, a.k.a. accumulator */

    62

    symbol_c *prev_il_instruction;

    63

    /* the current IL operand being analyzed */

    64

    symbol_c *il_operand;

    65

    66

    67

    68

  public:

    69

    constant_folding_c(symbol_c *symbol = NULL);

    70

    virtual ~constant_folding_c(void);

    71

    int get_error_count();

    72

    73

  private:

    74

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

    75

    /* B 1.2 - Constants */

    76

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

    77

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

    78

    /* B 1.2.1 - Numeric Literals */

    79

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

    80

    void *visit(real_c *symbol);

    81

    void *visit(integer_c *symbol);

    82

    void *visit(neg_real_c *symbol);

    83

    void *visit(neg_integer_c *symbol);

    84

    void *visit(binary_integer_c *symbol);

    85

    void *visit(octal_integer_c *symbol);

    86

    void *visit(hex_integer_c *symbol);

    87

    void *visit(integer_literal_c *symbol);

    88

    void *visit(real_literal_c *symbol);

    89

    void *visit(bit_string_literal_c *symbol);

    90

    void *visit(boolean_literal_c *symbol);

    91

    void *visit(boolean_true_c *symbol);

    92

    void *visit(boolean_false_c *symbol);

    93

    94

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

    95

    /* B 1.2.3.1 - Duration */

    96

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

    97

    void *visit(fixed_point_c *symbol);

    98

    99

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

   100

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

   101

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

   102

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

   103

    /* B 2.1 Instructions and Operands */

   104

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

   105

    // void *visit(instruction_list_c *symbol); /* Not needed, since we inherit from iterator_visitor_c */

   106

    void *visit(il_instruction_c *symbol);

   107

    void *visit(il_simple_operation_c *symbol);

   108

    //void *visit(il_function_call_c *symbol);  /* TODO */

   109

    void *visit(il_expression_c *symbol);

   110

    void *visit(il_jump_operation_c *symbol);

   111

    void *visit(il_fb_call_c *symbol);

   112

    //void *visit(il_formal_funct_call_c *symbol);   /* TODO */

   113

    //void *visit(il_operand_list_c *symbol);  /* Not needed, since we inherit from iterator_visitor_c */

   114

    void *visit(simple_instr_list_c *symbol);

   115

    void *visit(il_simple_instruction_c *symbol);

   116

   117

   118

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

   119

    /* B 2.2 Operators */

   120

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

   121

    void *visit(   LD_operator_c *symbol);

   122

    void *visit(  LDN_operator_c *symbol);

   123

    void *visit(   ST_operator_c *symbol);

   124

    void *visit(  STN_operator_c *symbol);

   125

    void *visit(  NOT_operator_c *symbol);

   126

    void *visit(    S_operator_c *symbol);

   127

    void *visit(    R_operator_c *symbol);

   128

    void *visit(   S1_operator_c *symbol);

   129

    void *visit(   R1_operator_c *symbol);

   130

    void *visit(  CLK_operator_c *symbol);

   131

    void *visit(   CU_operator_c *symbol);

   132

    void *visit(   CD_operator_c *symbol);

   133

    void *visit(   PV_operator_c *symbol);

   134

    void *visit(   IN_operator_c *symbol);

   135

    void *visit(   PT_operator_c *symbol);

   136

    void *visit(  AND_operator_c *symbol);

   137

    void *visit(   OR_operator_c *symbol);

   138

    void *visit(  XOR_operator_c *symbol);

   139

    void *visit( ANDN_operator_c *symbol);

   140

    void *visit(  ORN_operator_c *symbol);

   141

    void *visit( XORN_operator_c *symbol);

   142

    void *visit(  ADD_operator_c *symbol);

   143

    void *visit(  SUB_operator_c *symbol);

   144

    void *visit(  MUL_operator_c *symbol);

   145

    void *visit(  DIV_operator_c *symbol);

   146

    void *visit(  MOD_operator_c *symbol);

   147

    void *visit(   GT_operator_c *symbol);

   148

    void *visit(   GE_operator_c *symbol);

   149

    void *visit(   EQ_operator_c *symbol);

   150

    void *visit(   LT_operator_c *symbol);

   151

    void *visit(   LE_operator_c *symbol);

   152

    void *visit(   NE_operator_c *symbol);

   153

    void *visit(  CAL_operator_c *symbol);

   154

    void *visit( CALC_operator_c *symbol);

   155

    void *visit(CALCN_operator_c *symbol);

   156

    void *visit(  RET_operator_c *symbol);

   157

    void *visit( RETC_operator_c *symbol);

   158

    void *visit(RETCN_operator_c *symbol);

   159

    void *visit(  JMP_operator_c *symbol);

   160

    void *visit( JMPC_operator_c *symbol);

   161

    void *visit(JMPCN_operator_c *symbol);

   162

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

   163

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

   164

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

   165

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

   166

   167

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

   168

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

   169

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

   170

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

   171

    /* B 3.1 - Expressions */

   172

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

   173

    void *visit(    or_expression_c *symbol);

   174

    void *visit(   xor_expression_c *symbol);

   175

    void *visit(   and_expression_c *symbol);

   176

    void *visit(   equ_expression_c *symbol);

   177

    void *visit(notequ_expression_c *symbol);

   178

    void *visit(    lt_expression_c *symbol);

   179

    void *visit(    gt_expression_c *symbol);

   180

    void *visit(    le_expression_c *symbol);

   181

    void *visit(    ge_expression_c *symbol);

   182

    void *visit(   add_expression_c *symbol);

   183

    void *visit(   sub_expression_c *symbol);

   184

    void *visit(   mul_expression_c *symbol);

   185

    void *visit(   div_expression_c *symbol);

   186

    void *visit(   mod_expression_c *symbol);

   187

    void *visit( power_expression_c *symbol);

   188

    void *visit(   neg_expression_c *symbol);

   189

    void *visit(   not_expression_c *symbol);

   190

    //void *visit(function_invocation_c *symbol); /* TODO */

   191

};

   192

   193

   194

   195

   196

   197

   198

   199

   200

   201

   202

   203

   204

#include <deque>

   205

   206

class constant_propagation_c : public constant_folding_c {

   207

  public:

   208

    constant_propagation_c(symbol_c *symbol = NULL);

   209

    virtual ~constant_propagation_c(void);

   210

    typedef symtable_c<const_value_c> map_values_t;

   211

  private:

   212

    symbol_c *current_resource;

   213

    symbol_c *current_configuration;

   214

    map_values_t *values;

   215

    map_values_t var_global_values;

   216

    /* A stack of all the FB declarations currently being recursively constant propagated */

   217

    std::deque<function_block_declaration_c *> fbs_currently_being_visited; // We use a deque instead of stack, so we can search in the stack using direct access to its elements!

   218

   219

    void *handle_var_list_decl(symbol_c *var_list, symbol_c *type_decl, bool is_global_var = false);

   220

    void *handle_var_decl     (symbol_c *var_list, bool fixed_init_value);

   221

    // Flag to indicate whether the variables in the variable declaration list will always have a fixed value when the POU is executed!

   222

    // VAR CONSTANT ... END_VAR will always be true

   223

    // VAR          ... END_VAR will always be true for functions (who initialise local variables every time they are called), but false for FBs and PROGRAMS

   224

    bool fixed_init_value_; 

   225

    bool function_pou_;

   226

    bool is_constant(symbol_c *option);

   227

    bool is_retain  (symbol_c *option);

   228

    static map_values_t inner_left_join_values(map_values_t m1, map_values_t m2);

   229

   230

   231

  private:

   232

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

   233

    /* B 0 - Programming Model */

   234

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

   235

    void *visit(library_c *symbol);

   236

   237

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

   238

    /* B 1.4 - Variables */

   239

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

   240

    #if DO_CONSTANT_PROPAGATION__

   241

    void *visit(symbolic_variable_c *symbol);

   242

    #endif // DO_CONSTANT_PROPAGATION__

   243

    void *visit(symbolic_constant_c *symbol);

   244

   245

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

   246

    /* B 1.4.3 - Declaration & Initialisation */

   247

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

   248

    void *visit(        input_declarations_c *symbol);

   249

    void *visit(       output_declarations_c *symbol);

   250

    void *visit( input_output_declarations_c *symbol);

   251

    void *visit(          var_declarations_c *symbol);

   252

    void *visit(retentive_var_declarations_c *symbol);

   253

    void *visit( external_var_declarations_c *symbol);

   254

    void *visit(   global_var_declarations_c *symbol);

   255

    void *visit(  external_declaration_c     *symbol);

   256

    void *visit(global_var_decl_c            *symbol);

   257

    void *visit( var1_init_decl_c            *symbol);

   258

    void *visit(   fb_name_decl_c            *symbol);

   259

   260

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

   261

    /* B.1.5 - Program organization units */

   262

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

   263

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

   264

    /* B 1.5.1 - Functions */

   265

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

   266

    void *visit(function_declaration_c *symbol);

   267

    void *visit(function_var_decls_c   *symbol);

   268

   269

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

   270

    /* B 1.5.2 - Function Blocks */

   271

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

   272

    void *visit(function_block_declaration_c *symbol);

   273

    void *visit(            temp_var_decls_c *symbol);

   274

    void *visit(   non_retentive_var_decls_c *symbol);

   275

   276

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

   277

    /* B 1.5.3 - Programs */

   278

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

   279

    void *visit(       program_declaration_c *symbol);

   280

   281

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

   282

    /* B 1.7 Configuration elements */

   283

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

   284

    void *visit( configuration_declaration_c *symbol);

   285

    void *visit(      resource_declaration_c *symbol);

   286

    void *visit(     program_configuration_c *symbol);

   287

    void *visit(                   fb_task_c *symbol);

   288

   289

   290

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

   291

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

   292

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

   293

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

   294

    /* B 2.1 Instructions and Operands */

   295

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

   296

    //void *visit(il_function_call_c *symbol);  /* TODO */

   297

    // void *visit(il_fb_call_c *symbol);       /* TODO: move from constant_folding_c */

   298

    //void *visit(il_formal_funct_call_c *symbol);   /* TODO */

   299

    //void *visit(il_operand_list_c *symbol);  /* Not needed, since we inherit from iterator_visitor_c */

   300

   301

   302

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

   303

    /* B 2.2 Operators */

   304

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

   305

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

   306

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

   307

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

   308

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

   309

   310

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

   311

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

   312

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

   313

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

   314

    /* B 3.1 - Expressions */

   315

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

   316

    //void *visit(function_invocation_c *symbol); /* TODO */

   317

   318

    #if DO_CONSTANT_PROPAGATION__

   319

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

   320

    /* B 3.2.1 Assignment Statements */

   321

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

   322

    void *visit(assignment_statement_c *symbol);

   323

   324

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

   325

    /* B 3.2.3 Selection Statements */

   326

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

   327

    void *visit(if_statement_c *symbol);

   328

   329

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

   330

    /* B 3.2.4 Iteration Statements */

   331

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

   332

    void *visit(for_statement_c *symbol);

   333

    void *visit(while_statement_c *symbol);

   334

    void *visit(repeat_statement_c *symbol);

   335

    #endif // DO_CONSTANT_PROPAGATION__

   336

};

   337