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

    74

    75

    76

    77

    78

#include "constant_folding.hh"

    79

    80

    81

#include <set>

    82

class check_extern_c: public iterator_visitor_c {

    83

  public:

    84

    85

  private:

    86

    int current_display_error_level;

    87

    symbol_c *current_pou_decl;

    88

    symbol_c *current_resource_decl;

    89

    static std::set<symbol_c *> checked_decl; // A set with all the declarations that have already been checked, so we don't recheck it again!

    90

    91

    92

  public:

    93

    static int error_count;

    94

    95

    check_extern_c(symbol_c *current_pou, symbol_c *current_resource) {

    96

      current_display_error_level = 0;

    97

      current_pou_decl      = current_pou;

    98

      current_resource_decl = current_resource;

    99

    }

   100

   101

    ~check_extern_c(void) {}

   102

   103

   104

   105

    void check_global_decl(symbol_c *p_decl) {

   106

      if (NULL == current_pou_decl) ERROR;

   107

   108

      if (checked_decl.find(p_decl) != checked_decl.end()) return; // has already been checked!

   109

      checked_decl.insert(p_decl);

   110

   111

      search_var_instance_decl_c search_var_instance_pou_glo_decl(current_pou_decl);

   112

      search_var_instance_decl_c search_var_instance_res_glo_decl(current_resource_decl);

   113

      search_var_instance_decl_c search_var_instance_ext_decl(p_decl);

   114

      function_param_iterator_c  fpi(p_decl);

   115

   116

      symbol_c *var_name;

   117

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

   118

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

   119

          /* found an external reference parameter. */

   120

          symbol_c *ext_decl = search_var_instance_ext_decl.get_decl(var_name);

   121

   122

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

   123

          symbol_c                                       *glo_decl =  search_var_instance_res_glo_decl.get_decl(var_name);           

   124

              search_var_instance_decl_c *search_var_instance_glo_decl = &search_var_instance_res_glo_decl;

   125

          if (NULL == glo_decl) {

   126

            glo_decl                     =  search_var_instance_pou_glo_decl.get_decl(var_name);

   127

            search_var_instance_glo_decl = &search_var_instance_pou_glo_decl;

   128

          }

   129

   130

          if (NULL == glo_decl) {

   131

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

   132

            continue;

   133

          }

   134

   135

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

   136

           *        VAR_GLOBAL is contant     => VAR_EXTERNAL must also be CONSTANT

   137

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

   138

           */

   139

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

   140

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

   141

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

   142

            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.");

   143

   144

          /* Copy the const_value from the global to the external variable.

   145

           *   This is actually part of the constant folding algorithm. It is placed here because it needs the extern<->global pairing

   146

           *   information to run correctly, which is all available right here!

   147

           */

   148

          constant_folding_c constant_folding;

   149

          constant_folding.handle_var_extern_global_pair(var_name /* extern_var */, ext_decl /* extern_decl */, NULL /* global_var */, glo_decl /* global_decl */);

   150

   151

          /* TODO: Check redefinition data type.

   152

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

   153

           *  symbol_c *glo_type = ????;

   154

           *  symbol_c *ext_type = fpi.param_type();

   155

           */

   156

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

   157

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

   158

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

   159

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

   160

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

   161

        }

   162

      }

   163

    }

   164

   165

   166

   167

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

   168

    /* B 1.3.3 - Derived data types */

   169

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

   170

    /*  function_block_type_name ASSIGN structure_initialization */

   171

    /* structure_initialization -> may be NULL ! */

   172

    //SYM_REF2(fb_spec_init_c, function_block_type_name, structure_initialization)

   173

    /* NOTE: This class is only used when declaring FB variables, as in:

   174

     * name_list ':' function_block_type_name ASSIGN structure_initialization

   175

     *               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

   176

     *                      fb_spec_init_c                                   

   177

     * Here, fb_spec_init_c is used whether it is an external, local, or global variable!

   178

     * Note too that we must also check the datatypes of external and global variables!! 

   179

     */

   180

    void *visit(fb_spec_init_c *symbol) {

   181

      symbol_c *fb_decl = function_block_type_symtable.find_value(symbol->function_block_type_name);

   182

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

   183

      if (fb_decl == function_block_type_symtable.end_value())

   184

        ERROR;

   185

      fb_decl->accept(*this);

   186

      return NULL;

   187

    }

   188

   189

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

   190

    /* B 1.5.2 - Function Blocks */

   191

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

   192

    /*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   193

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

   194

    void *visit(function_block_declaration_c *symbol) {

   195

      check_global_decl(symbol);

   196

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

   197

       * current_pou_decl = symbol;  

   198

       * current_resource_decl = NULL;  

   199

       */

   200

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

   201

      if (NULL != symbol->var_declarations)

   202

        symbol->var_declarations->accept(*this);  // This will eventually call the visit(fb_spec_init_c *) method, if any FB are declared here!

   203

      return NULL;

   204

    }

   205

   206

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

   207

    /* B 1.5.3 - Declaration & Initialisation */

   208

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

   209

    /*  PROGRAM program_type_name program_var_declarations_list function_block_body END_PROGRAM */

   210

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

   211

    void *visit(program_declaration_c *symbol) {

   212

      check_global_decl(symbol);

   213

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

   214

       * current_pou_decl = symbol;  

   215

       * current_resource_decl = NULL;  

   216

       */

   217

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

   218

      if (NULL != symbol->var_declarations)

   219

        symbol->var_declarations->accept(*this);  // This will eventually call the visit(fb_spec_init_c *) method, if any FB are declared here!

   220

      return NULL;

   221

    }

   222

   223

};

   224

   225

int check_extern_c::error_count = 0;

   226

std::set<symbol_c *> check_extern_c::checked_decl;

   227

   228

   229

   230

   231

   232

   233

   234

   235

   236

   237

declaration_check_c::declaration_check_c(symbol_c *ignore) {

   238

  current_display_error_level = 0;

   239

  current_pou_decl = NULL;

   240

  current_resource_decl = NULL;

   241

  error_count = 0;

   242

}

   243

   244

declaration_check_c::~declaration_check_c(void) {

   245

   246

}

   247

   248

int declaration_check_c::get_error_count() {

   249

  return check_extern_c::error_count;

   250

}

   251

   252

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

   253

/* B 1.5.2 - Function Blocks */

   254

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

   255

/*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   256

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

   257

void *declaration_check_c::visit(function_block_declaration_c *symbol)

   258

  {return NULL;} // We only check the declarations that are used to instantiate variables. This is done in the configuration!

   259

   260

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

   261

/* B 1.5.3 - Declaration & Initialisation */

   262

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

   263

/*  PROGRAM program_type_name program_var_declarations_list function_block_body END_PROGRAM */

   264

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

   265

void *declaration_check_c::visit(program_declaration_c *symbol) 

   266

  {return NULL;} // We only check the declarations that are used to instantiate variables. This is done in the configuration!

   267

   268

   269

   270

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

   271

/* B 1.7 Configuration elements */

   272

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

   273

/*

   274

 * CONFIGURATION configuration_name

   275

 *    optional_global_var_declarations

   276

 *    (resource_declaration_list | single_resource_declaration)

   277

 *    optional_access_declarations

   278

 *    optional_instance_specific_initializations

   279

 * END_CONFIGURATION

   280

 */

   281

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

   282

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

   283

  current_pou_decl = symbol;

   284

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

   285

  if (NULL != symbol->resource_declarations)

   286

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

   287

  current_pou_decl = NULL;

   288

  return NULL;

   289

}

   290

   291

/*

   292

RESOURCE resource_name ON resource_type_name

   293

   optional_global_var_declarations

   294

   single_resource_declaration

   295

END_RESOURCE

   296

*/

   297

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

   298

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

   299

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

   300

  // check if any FB instantiated inside this resource (in a VAR_GLOBAL) has any VAR_EXTERNAL declarations incompatible with the configuration's VAR_GLOBALs

   301

  check_extern_c check_extern(current_pou_decl, current_resource_decl);

   302

  symbol->global_var_declarations->accept(check_extern);   

   303

  // Now check the Programs instantiated in this resource

   304

  current_resource_decl = symbol;

   305

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

   306

  current_resource_decl = NULL;  

   307

  return NULL;

   308

}

   309

   310

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

   311

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

   312

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

   313

  if (p_decl == program_type_symtable.end_value())

   314

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

   315

  if (p_decl == function_block_type_symtable.end_value())

   316

    ERROR;  // Should never occur! stage1_2 guarantees that we are sure to find a declaration in FB or Program symtable.

   317

   318

  check_extern_c check_extern(current_pou_decl, current_resource_decl);

   319

  p_decl->accept(check_extern);

   320

  return NULL;

   321

}

   322