1

/*

     2

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

     3

 *

     4

 *  Copyright (C) 2003-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

    34

/* Declaration sequence is a source code part needed to declare variables.

    35

 * There are some checks we need to do before start with other analysis:

    36

 *

    37

 *   - Check external option redefinition.

    38

 *   - Check external data type redefinition.

    39

 *   - Check initial values consistently with the data types of the variables/data types being declared.

    40

 *   - Check whether a function block uses a CONSTANT qualifier as described in 2.5.2.1.

    41

 *

    42

 */

    43

    44

    45

#include "declaration_check.hh"

    46

#include "datatype_functions.hh"

    47

    48

#define FIRST_(symbol1, symbol2) (((symbol1)->first_order < (symbol2)->first_order)   ? (symbol1) : (symbol2))

    49

#define  LAST_(symbol1, symbol2) (((symbol1)->last_order  > (symbol2)->last_order)    ? (symbol1) : (symbol2))

    50

    51

#define STAGE3_ERROR(error_level, symbol1, symbol2, ...) {                                                                  \

    52

  if (current_display_error_level >= error_level) {                                                                         \

    53

    fprintf(stderr, "%s:%d-%d..%d-%d: error: ",                                                                             \

    54

            FIRST_(symbol1,symbol2)->first_file, FIRST_(symbol1,symbol2)->first_line, FIRST_(symbol1,symbol2)->first_column,\

    55

                                                 LAST_(symbol1,symbol2) ->last_line,  LAST_(symbol1,symbol2) ->last_column);\

    56

    fprintf(stderr, __VA_ARGS__);                                                                                           \

    57

    fprintf(stderr, "\n");                                                                                                  \

    58

    error_count++;                                                                                                     \

    59

  }                                                                                                                         \

    60

}

    61

    62

    63

#define STAGE3_WARNING(symbol1, symbol2, ...) {                                                                             \

    64

    fprintf(stderr, "%s:%d-%d..%d-%d: warning: ",                                                                           \

    65

            FIRST_(symbol1,symbol2)->first_file, FIRST_(symbol1,symbol2)->first_line, FIRST_(symbol1,symbol2)->first_column,\

    66

                                                 LAST_(symbol1,symbol2) ->last_line,  LAST_(symbol1,symbol2) ->last_column);\

    67

    fprintf(stderr, __VA_ARGS__);                                                                                           \

    68

    fprintf(stderr, "\n");                                                                                                  \

    69

    warning_found = true;                                                                                                   \

    70

}

    71

    72

    73

declaration_check_c::declaration_check_c(symbol_c *ignore) {

    74

  current_display_error_level = 0;

    75

  current_pou_decl = NULL;

    76

  current_resource_decl = NULL;

    77

  error_count = 0;

    78

}

    79

    80

declaration_check_c::~declaration_check_c(void) {

    81

    82

}

    83

    84

int declaration_check_c::get_error_count() {

    85

  return error_count;

    86

}

    87

    88

void declaration_check_c::check_global_decl(symbol_c *p_decl) {

    89

  if (NULL == current_pou_decl) ERROR;

    90

    91

  search_var_instance_decl_c search_var_instance_pou_glo_decl(current_pou_decl);

    92

  search_var_instance_decl_c search_var_instance_res_glo_decl(current_resource_decl);

    93

  search_var_instance_decl_c search_var_instance_ext_decl(p_decl);

    94

  function_param_iterator_c  fpi(p_decl);

    95

    96

  symbol_c *var_name;

    97

  while((var_name = fpi.next()) != NULL) {

    98

    if (fpi.param_direction() == function_param_iterator_c::direction_extref) {

    99

      /* found an external reference parameter. */

   100

      symbol_c *ext_decl = search_var_instance_ext_decl.get_decl(var_name);

   101

   102

      // NOTE: Must check the POU first, and RESOURCE second!

   103

      symbol_c                                       *glo_decl =  search_var_instance_res_glo_decl.get_decl(var_name);           

   104

      search_var_instance_decl_c *search_var_instance_glo_decl = &search_var_instance_res_glo_decl;

   105

      if (NULL == glo_decl) {

   106

        glo_decl                     =  search_var_instance_pou_glo_decl.get_decl(var_name);

   107

        search_var_instance_glo_decl = &search_var_instance_pou_glo_decl;

   108

      }

   109

   110

      if (NULL == glo_decl) {

   111

        STAGE3_ERROR(0, ext_decl, ext_decl, "Declaration error. The external variable does not match with any global variable.");

   112

        continue;

   113

      }

   114

   115

      /* Check whether variable's constness (CONSTANT) is compatible.

   116

       *        VAR_GLOBAL is contant     => VAR_EXTERNAL must also be CONSTANT

   117

       *        VAR_GLOBAL is not contant => VAR_EXTERNAL may be CONSTANT, or not!

   118

       */

   119

      search_var_instance_decl_c::opt_t ext_opt = search_var_instance_ext_decl. get_option(var_name);

   120

      search_var_instance_decl_c::opt_t glo_opt = search_var_instance_glo_decl->get_option(var_name);

   121

      if ((glo_opt == search_var_instance_decl_c::constant_opt) && (ext_opt != search_var_instance_decl_c::constant_opt))

   122

        STAGE3_ERROR(0, glo_decl, glo_decl, "Declaration error. The external variable must be declared as constant, as it maps to a constant global variable.");

   123

   124

      /* TODO: Check redefinition data type.

   125

       *       We need a new class (like search_base_type class) to get type id by variable declaration.

   126

       *  symbol_c *glo_type = ????;

   127

       *  symbol_c *ext_type = fpi.param_type();

   128

       */

   129

      /* For the moment, we will just use search_base_type_c instead... */

   130

      symbol_c *glo_type = search_base_type_c::get_basetype_decl(glo_decl);

   131

      symbol_c *ext_type = search_base_type_c::get_basetype_decl(ext_decl);

   132

      if (! get_datatype_info_c::is_type_equal(glo_type, ext_type))

   133

        STAGE3_ERROR(0, ext_decl, ext_decl, "Declaration error.  Data type mismatch between external and global variable declarations.");

   134

    }

   135

  }

   136

}

   137

   138

   139

   140

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

   141

/* B 1.5.2 - Function Blocks */

   142

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

   143

/*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   144

// SYM_REF3(function_block_declaration_c, fblock_name, var_declarations, fblock_body)

   145

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

   146

  /* The following two lines of code are only valid for v3 of IEC 61131-3, that allows VAR_GLOBAL declarations inside FBs!

   147

   * current_pou_decl = symbol;  

   148

   * current_resource_decl = NULL;  

   149

   */

   150

  /* check if any FB declared as a VAR has any incompatible VAR_EXTERNAL declarations */

   151

  if (NULL != symbol->var_declarations)

   152

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

   153

  return NULL;

   154

}

   155

   156

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

   157

/* B 1.5.3 - Declaration & Initialisation */

   158

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

   159

/*  PROGRAM program_type_name program_var_declarations_list function_block_body END_PROGRAM */

   160

// SYM_REF3(program_declaration_c, program_type_name, var_declarations, function_block_body)

   161

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

   162

  /* The following two lines of code are only valid for v3 of IEC 61131-3, that allows VAR_GLOBAL declarations inside PROGRAMs!

   163

   * current_pou_decl = symbol;  

   164

   * current_resource_decl = NULL;  

   165

   */

   166

  /* check if any FB declared as a VAR has any incompatible VAR_EXTERNAL declarations */

   167

  if (NULL != symbol->var_declarations)

   168

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

   169

  return NULL;

   170

}

   171

   172

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

   173

/* B 1.7 Configuration elements */

   174

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

   175

/*

   176

 * CONFIGURATION configuration_name

   177

 *    optional_global_var_declarations

   178

 *    (resource_declaration_list | single_resource_declaration)

   179

 *    optional_access_declarations

   180

 *    optional_instance_specific_initializations

   181

 * END_CONFIGURATION

   182

 */

   183

//SYM_REF5(configuration_declaration_c, configuration_name, global_var_declarations, resource_declarations, access_declarations, instance_specific_initializations)

   184

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

   185

  current_pou_decl = symbol;

   186

  /* check if any FB declared as a VAR has any incompatible VAR_EXTERNAL declarations */

   187

  if (NULL != symbol->resource_declarations)

   188

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

   189

  current_pou_decl = NULL;

   190

  return NULL;

   191

}

   192

   193

/*

   194

RESOURCE resource_name ON resource_type_name

   195

   optional_global_var_declarations

   196

   single_resource_declaration

   197

END_RESOURCE

   198

*/

   199

/* enumvalue_symtable is filled in by enum_declaration_check_c, during stage3 semantic verification, with a list of all enumerated constants declared inside this POU */

   200

// SYM_REF4(resource_declaration_c, resource_name, resource_type_name, global_var_declarations, resource_declaration, enumvalue_symtable_t enumvalue_symtable;)

   201

void *declaration_check_c::visit(resource_declaration_c *symbol) {

   202

  current_resource_decl = symbol;

   203

  /* check if any FB declared as a VAR has any incompatible VAR_EXTERNAL declarations */

   204

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

   205

  current_resource_decl = NULL;  

   206

  return NULL;

   207

}

   208

   209

/*  PROGRAM [RETAIN | NON_RETAIN] program_name [WITH task_name] ':' program_type_name ['(' prog_conf_elements ')'] */

   210

void *declaration_check_c::visit(program_configuration_c *symbol) {

   211

  symbol_c *p_decl = program_type_symtable.find_value(symbol->program_type_name);

   212

  if (p_decl == program_type_symtable.end_value())

   213

    p_decl = function_block_type_symtable.find_value(symbol->program_type_name);

   214

  /* stage1_2 guarantees that we are sure to find a declaration in FB or Program symtable. */

   215

  if (p_decl == function_block_type_symtable.end_value())

   216

    ERROR;

   217

  check_global_decl(p_decl);

   218

  return NULL;

   219

}

   220