1

/*

     2

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

     3

 *

     4

 *  Copyright (C) 2003-2011  Mario de Sousa (msousa@fe.up.pt)

     5

 *  Copyright (C) 2007-2011  Laurent Bessard and Edouard Tisserant

     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

#include <string>

    26

#include <iostream>

    27

#include <sstream>

    28

#include <typeinfo>

    29

#include <list>

    30

#include <map>

    31

#include <sstream>

    32

#include <strings.h>

    33

    34

    35

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

    36

#include "../../util/dsymtable.hh"

    37

#include "../../absyntax/visitor.hh"

    38

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

    39

#include "../../main.hh" // required for ERROR() and ERROR_MSG() macros.

    40

    41

#include "../stage4.hh"

    42

    43

//#define DEBUG

    44

#ifdef DEBUG

    45

#define TRACE(classname) printf("\n____%s____\n",classname);

    46

#else

    47

#define TRACE(classname)

    48

#endif

    49

    50

    51

    52

#define STAGE4_ERROR(symbol1, symbol2, ...) {stage4err("while generating C code", symbol1, symbol2, __VA_ARGS__); exit(EXIT_FAILURE);}

    53

    54

    55

/* Macros to access the constant value of each expression (if it exists) from the annotation introduced to the symbol_c object by constant_folding_c in stage3! */

    56

#define VALID_CVALUE(dtype, symbol)           ((symbol)->const_value._##dtype.is_valid())

    57

#define GET_CVALUE(dtype, symbol)             ((symbol)->const_value._##dtype.get()) 

    58

    59

    60

    61

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

    62

    63

/* Unlike Programs and Configurations which get mapped onto C++ classes,

    64

 * Function Blocks are mapped onto a C structure containing the variables, and

    65

 * a C function containing the code in the FB's body. This is to allow direct allocation

    66

 * of a FB variable (which is really an instance of the C data structure) to

    67

 * a member of a union variable (note that classes with constructors cannot

    68

 * be mebers of a union), which is done in IL when loading a FB onto IL's

    69

 * default variable.

    70

 *

    71

 * So as not to clash the names of the C data structure and the C function,

    72

 * the C structure is given a name identical to that of the FB name, whereas

    73

 * the name of the function is the FB name with a constant string appended.

    74

 * The value of that constant string which is appended is defined in the following

    75

 * constant.

    76

 * In order not to clash with any variable in the IL and ST source codem the

    77

 * following constant should contain a double underscore, which is not allowed

    78

 * in IL and ST.

    79

 *

    80

 * e.g.:  FUNTION_BLOCK TEST

    81

 * is mapped onto a TEST data structure, and a TEST_body__ function.

    82

 */

    83

    84

#define FB_FUNCTION_SUFFIX "_body__"

    85

    86

/* Idem as body, but for initializer FB function */

    87

#define FB_INIT_SUFFIX "_init__"

    88

    89

/* Idem as body, but for run CONFIG and RESOURCE function */

    90

#define FB_RUN_SUFFIX "_run__"

    91

    92

/* The FB body function is passed as the only parameter a pointer to the FB data

    93

 * structure instance. The name of this parameter is given by the following constant.

    94

 * In order not to clash with any variable in the IL and ST source codem the

    95

 * following constant should contain a double underscore, which is not allowed

    96

 * in IL and ST.

    97

 *

    98

 * e.g.: the body of FUNTION_BLOCK TEST

    99

 * is mapped onto the C function

   100

 *  TEST_body__(TEST *data__)

   101

 */

   102

   103

#define FB_FUNCTION_PARAM "data__"

   104

   105

   106

#define SFC_STEP_ACTION_PREFIX "__SFC_"

   107

   108

   109

/* Variable declaration symbol for accessor macros */

   110

#define DECLARE_VAR "__DECLARE_VAR"

   111

#define DECLARE_GLOBAL "__DECLARE_GLOBAL"

   112

#define DECLARE_GLOBAL_FB "__DECLARE_GLOBAL_FB"

   113

#define DECLARE_GLOBAL_LOCATION "__DECLARE_GLOBAL_LOCATION"

   114

#define DECLARE_GLOBAL_LOCATED "__DECLARE_GLOBAL_LOCATED"

   115

#define DECLARE_EXTERNAL "__DECLARE_EXTERNAL"

   116

#define DECLARE_EXTERNAL_FB "__DECLARE_EXTERNAL_FB"

   117

#define DECLARE_LOCATED "__DECLARE_LOCATED"

   118

#define DECLARE_GLOBAL_PROTOTYPE "__DECLARE_GLOBAL_PROTOTYPE"

   119

   120

/* Variable declaration symbol for accessor macros */

   121

#define INIT_VAR "__INIT_VAR"

   122

#define INIT_GLOBAL "__INIT_GLOBAL"

   123

#define INIT_GLOBAL_FB "__INIT_GLOBAL_FB"

   124

#define INIT_GLOBAL_LOCATED "__INIT_GLOBAL_LOCATED"

   125

#define INIT_EXTERNAL "__INIT_EXTERNAL"

   126

#define INIT_EXTERNAL_FB "__INIT_EXTERNAL_FB"

   127

#define INIT_LOCATED "__INIT_LOCATED"

   128

#define INIT_LOCATED_VALUE "__INIT_LOCATED_VALUE"

   129

   130

/* Variable getter symbol for accessor macros */

   131

#define GET_VAR "__GET_VAR"

   132

#define GET_EXTERNAL "__GET_EXTERNAL"

   133

#define GET_EXTERNAL_FB "__GET_EXTERNAL_FB"

   134

#define GET_LOCATED "__GET_LOCATED"

   135

   136

#define GET_VAR_REF "__GET_VAR_REF"

   137

#define GET_EXTERNAL_REF "__GET_EXTERNAL_REF"

   138

#define GET_EXTERNAL_FB_REF "__GET_EXTERNAL_FB_REF"

   139

#define GET_LOCATED_REF "__GET_LOCATED_REF"

   140

   141

#define GET_VAR_DREF "__GET_VAR_DREF"

   142

#define GET_EXTERNAL_DREF "__GET_EXTERNAL_DREF"

   143

#define GET_EXTERNAL_FB_DREF "__GET_EXTERNAL_FB_DREF"

   144

#define GET_LOCATED_DREF "__GET_LOCATED_DREF"

   145

   146

#define GET_VAR_BY_REF "__GET_VAR_BY_REF"

   147

#define GET_EXTERNAL_BY_REF "__GET_EXTERNAL_BY_REF"

   148

#define GET_EXTERNAL_FB_BY_REF "__GET_EXTERNAL_FB_BY_REF"

   149

#define GET_LOCATED_BY_REF "__GET_LOCATED_BY_REF"

   150

   151

/* Variable setter symbol for accessor macros */

   152

#define SET_VAR "__SET_VAR"

   153

#define SET_EXTERNAL "__SET_EXTERNAL"

   154

#define SET_EXTERNAL_FB "__SET_EXTERNAL_FB"

   155

#define SET_LOCATED "__SET_LOCATED"

   156

   157

/* Variable initial value symbol for accessor macros */

   158

#define INITIAL_VALUE "__INITIAL_VALUE"

   159

   160

/* Generate a name for a temporary variable.

   161

 * Each new name generated is appended a different number,

   162

 * starting off from 0.

   163

 * After calling reset(), the names will start off again from 0.

   164

 */

   165

#define VAR_LEADER "__"

   166

#define TEMP_VAR VAR_LEADER "TMP_"

   167

#define SOURCE_VAR VAR_LEADER "SRC_"

   168

   169

/* please see the comment before the RET_operator_c visitor for details... */

   170

#define END_LABEL VAR_LEADER "end"

   171

   172

   173

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

   174

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

   175

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

   176

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

   177

   178

   179

static int generate_line_directives__ = 0;

   180

static int generate_pou_filepairs__   = 0;

   181

static int generate_plc_state_backup_fuctions__ = 0;

   182

   183

#ifdef __unix__

   184

/* Parse command line options passed from main.c !! */

   185

#include <stdlib.h> // for getsubopt()

   186

int  stage4_parse_options(char *options) {

   187

  enum {LINE_OPT = 0,  

   188

        SEPTFILE_OPT,

   189

        BACKUP_OPT    /* option to generate function to backup and restore internal PLC state */

   190

        /*, SOME_OTHER_OPT, YET_ANOTHER_OPT */};

   191

  char *const token[] = {

   192

        /*       LINE_OPT*/(char *)"l",

   193

        /*   SEPTFILE_OPT*/(char *)"p",

   194

        /*     BACKUP_OPT*/(char *)"b",

   195

        /* SOME_OTHER_OPT, ...             */

   196

        NULL };

   197

  /* unfortunately, the above commented out syntax for array initialization is valid in C, but not in C++ */

   198

   199

  char *subopts = options;

   200

  char *value;

   201

  int opt;

   202

   203

  while (*subopts != '\0') {

   204

    switch (getsubopt(&subopts, token, &value)) {

   205

      case     LINE_OPT: generate_line_directives__            = 1; break;

   206

      case SEPTFILE_OPT: generate_pou_filepairs__              = 1; break;

   207

      case   BACKUP_OPT: generate_plc_state_backup_fuctions__  = 1; break;

   208

      default          : fprintf(stderr, "Unrecognized option: -O %s\n", value); return -1; break;

   209

     }

   210

  }     

   211

  return 0;

   212

}

   213

   214

   215

void stage4_print_options(void) {

   216

  printf("          (options must be separated by commas. Example: 'l,w,x')\n"); 

   217

  printf("      l : insert '#line' directives in generated C code.\n"); 

   218

  printf("      p : place each POU in a separate pair of files (<pou_name>.c, <pou_name>.h).\n"); 

   219

  printf("      b : generate functions to backup and restore internal PLC state.\n"); 

   220

}

   221

#else /* not __unix__ */

   222

/* getsubopt isn't supported with mingw, 

   223

 *  then stage4 options aren't available on windows*/

   224

void stage4_print_options(void) {}

   226

#endif 

   227

   228

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

   229

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

   230

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

   231

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

   232

   233

#include "generate_c_base.cc"

   234

#include "generate_c_typedecl.cc"

   235

#include "generate_c_sfcdecl.cc"

   236

#include "generate_c_vardecl.cc"

   237

#include "generate_c_configbody.cc"

   238

#include "generate_location_list.cc"

   239

#include "generate_var_list.cc"

   240

   241

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

   242

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

   243

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

   244

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

   245

   246

   247

#include "generate_c.hh"

   248

   249

   250

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

   251

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

   252

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

   253

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

   254

   255

/* A helper class that prints out the identifiers for function calls to overloaded functions */

   256

/* Given a function declaration of the function being called, it 

   257

 * will simply print out the returned data type,

   258

 * followed by the data types of all input, output, and in_out parameters.

   259

 *   for e.g.; 

   260

 *     SIN( REAL) : REAL      -> prints out ->  REAL__REAL

   261

 *     LEN( STRING) : INT     -> prints out ->  INT__STRING

   262

 *     MUL(TIME, INT) : TIME  -> prints out ->  TIME__TIME__INT

   263

 */

   264

class print_function_parameter_data_types_c: public generate_c_base_and_typeid_c {

   265

  private:

   266

    symbol_c *current_type;

   267

    bool_type_name_c tmp_bool;

   268

   269

    void print_list(symbol_c *var_list, symbol_c *data_type) { 

   270

      if (data_type != NULL) {

   271

        /* print out the data type once for every variable! */

   272

        list_c *list = dynamic_cast<list_c *>(var_list);

   273

        if (list == NULL) ERROR;  

   274

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

   275

          s4o.print("__");

   276

          data_type->accept(*this);

   277

        }  

   278

      }

   279

    }

   280

   281

  public:

   282

    print_function_parameter_data_types_c(stage4out_c *s4o_ptr): 

   283

      generate_c_base_and_typeid_c(s4o_ptr)

   284

      {current_type = NULL;}

   285

   286

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

   287

    /* B.1.5 - Program organization units */

   288

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

   289

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

   290

    /* B 1.5.1 - Functions */

   291

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

   292

    /*   FUNCTION derived_function_name ':' elementary_type_name io_OR_function_var_declarations_list function_body END_FUNCTION */

   293

    /* | FUNCTION derived_function_name ':' derived_type_name io_OR_function_var_declarations_list function_body END_FUNCTION */

   294

    void *visit(function_declaration_c *symbol) {

   295

      symbol->type_name->accept(*this); /* return type */

   296

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

   297

      return NULL;

   298

    }

   299

   300

    /* already handled by iterator base class (note that generate_c_base_c inherits from iterator_c) */

   301

    //void *visit(var_declarations_list_c *symbol) {// iterate through list}

   302

   303

    /* already handled by iterator base class (note that generate_c_base_c inherits from iterator_c) */

   304

    //void *visit(input_declarations_c *symbol) {// iterate through list}

   305

   306

    /* already handled by iterator base class (note that generate_c_base_c inherits from iterator_c) */

   307

    //void *visit(input_declaration_list_c *symbol) {// iterate through list}

   308

   309

    void *visit(edge_declaration_c *symbol) {

   310

      current_type = &tmp_bool; 

   311

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

   312

      current_type = NULL; 

   313

      return NULL;

   314

    }

   315

   316

    /* We do NOT print out EN and ENO parameters! */

   317

    void *visit(en_param_declaration_c *symbol) {return NULL;}

   318

   319

    /* already handled by iterator base class (note that generate_c_base_c inherits from iterator_c) */

   320

    //void *visit(output_declarations_c *symbol) {// iterate through list}    

   321

   322

    /* already handled by iterator base class (note that generate_c_base_c inherits from iterator_c) */

   323

    //void *visit(var_init_decl_list_c *symbol) {// iterate through list}

   324

   325

    void *visit(simple_spec_init_c *symbol) {

   326

      /* return the data type */

   327

      return symbol->simple_specification; 

   328

    }

   329

   330

    /* currently we do not support data types defined in the declaration itself */

   331

    /* For now, sugest the user define a TYPE .. END_TYPE */

   332

    /* NOTE: although this class may also sometimes point to a previously_declared_subrange_type_name

   333

     * we don't need this for now, so it is easier to just skip it allocation

   334

     */

   335

    void *visit(subrange_spec_init_c *symbol) {return NULL;}

   336

   337

    /* currently we do not support data types defined in the declaration itself */

   338

    /* For now, sugest the user define a TYPE .. END_TYPE */

   339

    /* NOTE: although this class may also sometimes point to a previously_declared_enumerated_type_name

   340

     * we don't need this for now, so it is easier to just skip it allocation

   341

     */

   342

    void *visit(enumerated_spec_init_c *symbol) {return NULL;}

   343

   344

    /* currently we do not support data types defined in the declaration itself */

   345

    /* For now, sugest the user define a TYPE .. END_TYPE */

   346

    /* NOTE: although this class may also sometimes point to a previously_declared_array_type_name

   347

     * we don't need this for now, so it is easier to just skip it allocation

   348

     */

   349

    void *visit(array_var_init_decl_c *symbol) {return NULL;}

   350

   351

    /* currently we do not support data types defined in the declaration itself */

   352

    /* For now, sugest the user define a TYPE .. END_TYPE */

   353

    /* NOTE: although this class may also sometimes point to a previously_declared_structured_type_name

   354

     * we don't need this for now, so it is easier to just skip it allocation

   355

     */

   356

    void *visit(structured_var_init_decl_c *symbol) {return NULL;}

   357

   358

    /* We do NOT print out EN and ENO parameters! */

   359

    void *visit(eno_param_declaration_c *symbol) {return NULL;}

   360

   361

    /* already handled by iterator base class (note that generate_c_base_c inherits from iterator_c) */

   362

    //void *visit(input_output_declarations_c *symbol) {// iterate through list}    

   363

   364

    /* already handled by iterator base class (note that generate_c_base_c inherits from iterator_c) */

   365

    //void *visit(var_declaration_list_c *symbol) {iterate through list}

   366

   367

    void *visit(fb_name_decl_c *symbol) {

   368

      print_list(symbol->fb_name_list, spec_init_sperator_c::get_spec(symbol->fb_spec_init)); 

   369

      return NULL;

   370

    }

   371

   372

    void *visit(var1_init_decl_c *symbol) {

   373

      print_list(symbol->var1_list, (symbol_c *)symbol->spec_init->accept(*this));

   374

      return NULL;

   375

    }

   376

   377

    /* currently we do not support data types defined in the declaration itself */

   378

    /* For now, sugest the user define a TYPE .. END_TYPE */

   379

    void *visit(array_var_declaration_c *symbol) {return NULL;}

   380

   381

    void *visit(structured_var_declaration_c *symbol) {

   382

      current_type = symbol->structure_type_name; 

   383

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

   384

      current_type = NULL; 

   385

      return NULL;

   386

    }

   387

   388

    /* currently we do not support data types defined in the declaration itself */

   389

    /* For now, sugest the user define a TYPE .. END_TYPE */

   390

    /* Note that this class is used for fixed length strings...

   391

     *   STRING [ 42 ]

   392

     */

   393

    void *visit(single_byte_string_var_declaration_c *symbol) {return NULL;}

   394

   395

    /* currently we do not support data types defined in the declaration itself */

   396

    /* For now, sugest the user define a TYPE .. END_TYPE */

   397

    /* Note that this class is used for fixed length strings...

   398

     *   WSTRING [ 42 ]

   399

     */

   400

    void *visit(double_byte_string_var_declaration_c *symbol) {return NULL;}

   401

};

   402

   403

   404

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

   405

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

   406

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

   407

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

   408

   409

/* A helper class that analyses if the datatype of a variable is 'complex'. */

   410

/* 'complex' means that it is either a strcuture or an array!               */

   411

class analyse_variable_c: public search_visitor_c {

   412

  private:

   413

    static analyse_variable_c *singleton_;

   414

   415

  public:

   416

    analyse_variable_c(void) {};

   417

   418

    static bool is_complex_type(symbol_c *symbol) {

   419

      if (NULL == symbol) ERROR;

   420

      if (!get_datatype_info_c::is_type_valid     (symbol->datatype)) return false;

   421

      return (   get_datatype_info_c::is_structure(symbol->datatype) 

   422

              || get_datatype_info_c::is_array    (symbol->datatype) 

   423

             );

   424

    }

   425

   426

   427

  private:

   428

    symbol_c *last_fb, *first_non_fb_identifier;

   429

   430

  public:  

   431

    /* returns the first element (from left to right) in a structured variable that is not a FB, i.e. is either a structure or an array! */

   432

    /* eg:

   433

     *      fb1.fb2.fb3.real       returns ??????

   434

     *      fb1.fb2.struct1.real   returns struct1

   435

     *      struct1.real           returns struct1

   436

     */

   437

    static symbol_c *find_first_nonfb(symbol_c *symbol) {

   438

      if (NULL == singleton_)       singleton_ = new analyse_variable_c();

   439

      if (NULL == singleton_)       ERROR;

   440

      if (NULL == symbol)           ERROR;

   441

   442

      singleton_->last_fb                 = NULL;

   443

      singleton_->first_non_fb_identifier = NULL;

   444

      return (symbol_c *)symbol->accept(*singleton_);

   445

    }

   446

   447

    /* returns true if a strcutured variable (e.g. fb1.fb2.strcut1.real) contains a structure or array */

   448

    /* eg:

   449

     *      fb1.fb2.fb3.real       returns FALSE

   450

     *      fb1.fb2.struct1.real   returns TRUE

   451

     *      struct1.real           returns TRUE

   452

     */

   453

    static bool contains_complex_type(symbol_c *symbol) {

   454

      if (NULL == symbol) ERROR;

   455

      if (!get_datatype_info_c::is_type_valid(symbol->datatype)) ERROR;

   456

   457

      symbol_c *first_non_fb = (symbol_c *)find_first_nonfb(symbol);

   458

      return is_complex_type(first_non_fb->datatype);

   459

    }

   460

   461

   462

    /* returns the datatype of the variable returned by find_first_nonfb() */

   463

    /* eg:

   464

     *      fb1.fb2.fb3.real       returns ??????

   465

     *      fb1.fb2.struct1.real   returns datatype of struct1

   466

     *      struct1.real           returns datatype of struct1

   467

     */

   468

    static search_var_instance_decl_c::vt_t first_nonfb_vardecltype(symbol_c *symbol, symbol_c *scope) {

   469

      if (NULL == symbol) ERROR;

   470

      if (!get_datatype_info_c::is_type_valid(symbol->datatype)) ERROR;

   471

   472

      symbol_c *first_non_fb = (symbol_c *)find_first_nonfb(symbol);

   473

      if (NULL != singleton_->last_fb) {

   474

        scope = singleton_->last_fb->datatype;

   475

        symbol = singleton_->first_non_fb_identifier;

   476

      }

   477

   478

      search_var_instance_decl_c search_var_instance_decl(scope);

   479

   480

      return search_var_instance_decl.get_vartype(symbol);

   481

    }

   482

   483

   484

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

   485

    /* B 1.4 - Variables */

   486

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

   487

    void *visit(symbolic_variable_c *symbol) {

   488

      if (!get_datatype_info_c::is_type_valid    (symbol->datatype)) ERROR;

   489

      if (!get_datatype_info_c::is_function_block(symbol->datatype)) {

   490

         first_non_fb_identifier = symbol; 

   491

         return (void *)symbol;

   492

      }

   493

      last_fb = symbol;

   494

      return NULL;

   495

    }

   496