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_c::cs_const_value == (symbol)->const_value._##dtype.status)

    57

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

    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_BY_REF "__GET_VAR_BY_REF"

   142

#define GET_EXTERNAL_BY_REF "__GET_EXTERNAL_BY_REF"

   143

#define GET_EXTERNAL_FB_BY_REF "__GET_EXTERNAL_FB_BY_REF"

   144

#define GET_LOCATED_BY_REF "__GET_LOCATED_BY_REF"

   145

   146

/* Variable setter symbol for accessor macros */

   147

#define SET_VAR "__SET_VAR"

   148

#define SET_EXTERNAL "__SET_EXTERNAL"

   149

#define SET_EXTERNAL_FB "__SET_EXTERNAL_FB"

   150

#define SET_LOCATED "__SET_LOCATED"

   151

   152

/* Variable initial value symbol for accessor macros */

   153

#define INITIAL_VALUE "__INITIAL_VALUE"

   154

   155

/* Generate a name for a temporary variable.

   156

 * Each new name generated is appended a different number,

   157

 * starting off from 0.

   158

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

   159

 */

   160

#define VAR_LEADER "__"

   161

#define TEMP_VAR VAR_LEADER "TMP_"

   162

#define SOURCE_VAR VAR_LEADER "SRC_"

   163

   164

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

   165

#define END_LABEL VAR_LEADER "end"

   166

   167

   168

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

   169

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

   170

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

   171

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

   172

   173

   174

static int generate_line_directives__ = 0;

   175

   176

#ifdef __unix__

   177

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

   178

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

   179

int  stage4_parse_options(char *options) {

   180

  enum {                    LINE_OPT = 0             /*, SOME_OTHER_OPT, YET_ANOTHER_OPT */};

   181

  char *const token[] = { /*[LINE_OPT]=*/(char *)"l" /*, SOME_OTHER_OPT, ...             */, NULL };

   182

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

   183

   184

  char *subopts = options;

   185

  char *value;

   186

  int opt;

   187

   188

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

   189

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

   190

      case LINE_OPT: generate_line_directives__  = 1; break;

   191

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

   192

     }

   193

  }     

   194

  return 0;

   195

}

   196

   197

   198

void stage4_print_options(void) {

   199

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

   200

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

   201

}

   202

#else /* not __unix__ */

   203

/* getsubopt isn't supported with mingw, 

   204

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

   205

void stage4_print_options(void) {}

   206

int  stage4_parse_options(char *options) {}

   207

#endif 

   208

   209

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

   210

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

   211

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

   212

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

   213

   214

#include "generate_c_base.cc"

   215

#include "generate_c_typedecl.cc"

   216

#include "generate_c_sfcdecl.cc"

   217

#include "generate_c_vardecl.cc"

   218

#include "generate_c_configbody.cc"

   219

#include "generate_location_list.cc"

   220

#include "generate_var_list.cc"

   221

   222

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

   223

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

   224

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

   225

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

   226

   227

   228

#include "generate_c.hh"

   229

   230

   231

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

   232

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

   233

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

   234

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

   235

   236

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

   237

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

   238

 * will simply print out the returned data type,

   239

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

   240

 *   for e.g.; 

   241

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

   242

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

   243

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

   244

 */

   245

class print_function_parameter_data_types_c: public generate_c_base_c {

   246

  private:

   247

    symbol_c *current_type;

   248

    bool_type_name_c tmp_bool;

   249

   250

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

   251

      if (data_type != NULL) {

   252

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

   253

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

   254

        if (list == NULL) ERROR;  

   255

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

   256

          s4o.print("__");

   257

          data_type->accept(*this);

   258

        }  

   259

      }

   260

    }

   261

   262

  public:

   263

    print_function_parameter_data_types_c(stage4out_c *s4o_ptr): 

   264

      generate_c_base_c(s4o_ptr)

   265

      {current_type = NULL;}

   266

   267

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

   268

    /* B.1.5 - Program organization units */

   269

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

   270

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

   271

    /* B 1.5.1 - Functions */

   272

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

   273

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

   274

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

   275

    void *visit(function_declaration_c *symbol) {

   276

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

   277

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

   278

      return NULL;

   279

    }

   280

   281

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

   282

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

   283

   284

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

   285

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

   286

   287

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

   288

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

   289

   290

    void *visit(edge_declaration_c *symbol) {

   291

      current_type = &tmp_bool; 

   292

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

   293

      current_type = NULL; 

   294

      return NULL;

   295

    }

   296

   297

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

   298

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

   299

   300

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

   301

    //void *visit(output_declarations_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(var_init_decl_list_c *symbol) {// iterate through list}

   305

   306

    void *visit(simple_spec_init_c *symbol) {

   307

      /* return the data type */

   308

      return symbol->simple_specification; 

   309

    }

   310

   311

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

   312

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

   313

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

   314

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

   315

     */

   316

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

   317

   318

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

   319

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

   320

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

   321

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

   322

     */

   323

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

   324

   325

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

   326

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

   327

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

   328

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

   329

     */

   330

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

   331

   332

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

   333

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

   334

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

   335

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

   336

     */

   337

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

   338

   339

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

   340

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

   341

   342

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

   343

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

   344

   345

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

   346

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

   347

   348

    void *visit(fb_name_decl_c *symbol) {

   349

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

   350

      return NULL;

   351

    }

   352

   353

    void *visit(var1_init_decl_c *symbol) {

   354

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

   355

      return NULL;

   356

    }

   357

   358

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

   359

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

   360

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

   361

   362

    void *visit(structured_var_declaration_c *symbol) {

   363

      current_type = symbol->structure_type_name; 

   364

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

   365

      current_type = NULL; 

   366

      return NULL;

   367

    }

   368

   369

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

   370

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

   371

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

   372

     *   STRING [ 42 ]

   373

     */

   374

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

   375

   376

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

   377

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

   378

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

   379

     *   WSTRING [ 42 ]

   380

     */

   381

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

   382

};

   383

   384

   385

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

   386

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

   387

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

   388

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

   389

   390

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

   391

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

   392

class analyse_variable_c: public search_visitor_c {

   393

  private:

   394

    static analyse_variable_c *singleton_;

   395

   396

  public:

   397

    analyse_variable_c(void) {};

   398

   399

    static bool is_complex_type(symbol_c *symbol) {

   400

      if (NULL == symbol) ERROR;

   401

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

   402

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

   403

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

   404

             );

   405

    }

   406

   407

   408

  private:

   409

    symbol_c *last_fb, *first_non_fb_identifier;

   410

   411

  public:  

   412

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

   413

    /* eg:

   414

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

   415

     *      fb1.fb2.struct1.real   returns struct1

   416

     *      struct1.real           returns struct1

   417

     */

   418

    static symbol_c *find_first_nonfb(symbol_c *symbol) {

   419

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

   420

      if (NULL == singleton_)       ERROR;

   421

      if (NULL == symbol)           ERROR;

   422

   423

      singleton_->last_fb                 = NULL;

   424

      singleton_->first_non_fb_identifier = NULL;

   425

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

   426

    }

   427

   428

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

   429

    /* eg:

   430

     *      fb1.fb2.fb3.real       returns FALSE

   431

     *      fb1.fb2.struct1.real   returns TRUE

   432

     *      struct1.real           returns TRUE

   433

     */

   434

    static bool contains_complex_type(symbol_c *symbol) {

   435

      if (NULL == symbol) ERROR;

   436

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

   437

   438

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

   439

      return is_complex_type(first_non_fb->datatype);

   440

    }

   441

   442

   443

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

   444

    /* eg:

   445

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

   446

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

   447

     *      struct1.real           returns datatype of struct1

   448

     */

   449

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

   450

      if (NULL == symbol) ERROR;

   451

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

   452

   453

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

   454

      if (NULL != singleton_->last_fb) {

   455

        scope = singleton_->last_fb->datatype;

   456

        symbol = singleton_->first_non_fb_identifier;

   457

      }

   458

   459

      search_var_instance_decl_c search_var_instance_decl(scope);

   460

   461

      return search_var_instance_decl.get_vartype(symbol);

   462

    }

   463

   464

   465

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

   466

    /* B 1.4 - Variables */

   467

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

   468

    void *visit(symbolic_variable_c *symbol) {

   469

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

   470

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

   471

         first_non_fb_identifier = symbol; 

   472

         return (void *)symbol;

   473

      }

   474

      last_fb = symbol;

   475

      return NULL;

   476

    }

   477

   478

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

   479

    /* B.1.4.2   Multi-element Variables */

   480

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

   481

   482

    // SYM_REF2(structured_variable_c, record_variable, field_selector)

   483

    void *visit(structured_variable_c *symbol) {

   484

      symbol_c *res = (symbol_c *)symbol->record_variable->accept(*this);

   485

      if (NULL != res) return res;

   486

   487

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

   488

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

   489

         first_non_fb_identifier = symbol->field_selector; 

   490

         return (void *)symbol;

   491

      }

   492

   493

      last_fb = symbol;      

   494

      return NULL;      

   495

    }

   496

   497

    /*  subscripted_variable '[' subscript_list ']' */