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"

   113

#define DECLARE_GLOBAL_LOCATION "__DECLARE_GLOBAL_LOCATION"

   114

#define DECLARE_GLOBAL_LOCATED "__DECLARE_GLOBAL_LOCATED"

   115

#define DECLARE_EXTERNAL "__DECLARE_EXTERNAL"

   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"

   124

#define INIT_GLOBAL_LOCATED "__INIT_GLOBAL_LOCATED"

   125

#define INIT_EXTERNAL "__INIT_EXTERNAL"

   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"

   134

#define GET_LOCATED "__GET_LOCATED"

   135

#define GET_VAR_BY_REF "__GET_VAR_BY_REF"

   136

#define GET_EXTERNAL_BY_REF "__GET_EXTERNAL_BY_REF"

   138

#define GET_LOCATED_BY_REF "__GET_LOCATED_BY_REF"

   139

   140

/* Variable setter symbol for accessor macros */

   141

#define SET_VAR "__SET_VAR"

   142

#define SET_EXTERNAL "__SET_EXTERNAL"

   144

#define SET_LOCATED "__SET_LOCATED"

   145

   146

/* Variable initial value symbol for accessor macros */

   147

#define INITIAL_VALUE "__INITIAL_VALUE"

   148

   149

/* Generate a name for a temporary variable.

   150

 * Each new name generated is appended a different number,

   151

 * starting off from 0.

   152

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

   153

 */

   154

#define VAR_LEADER "__"

   155

#define TEMP_VAR VAR_LEADER "TMP_"

   156

#define SOURCE_VAR VAR_LEADER "SRC_"

   157

   158

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

   159

#define END_LABEL VAR_LEADER "end"

   160

   161

   162

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

   163

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

   164

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

   165

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

   166

   167

#include "generate_c_base.cc"

   168

#include "generate_c_typedecl.cc"

   169

#include "generate_c_sfcdecl.cc"

   170

#include "generate_c_vardecl.cc"

   171

#include "generate_c_configbody.cc"

   172

#include "generate_location_list.cc"

   173

#include "generate_var_list.cc"

   174

   175

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

   176

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

   177

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

   178

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

   179

   180

   181

#include "generate_c.hh"

   182

   183

   184

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

   185

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

   186

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

   187

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

   188

   189

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

   190

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

   191

 * will simply print out the returned data type,

   192

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

   193

 *   for e.g.; 

   194

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

   195

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

   196

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

   197

 */

   198

class print_function_parameter_data_types_c: public generate_c_base_c {

   199

  private:

   200

    symbol_c *current_type;

   201

    bool_type_name_c tmp_bool;

   202

   203

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

   204

      if (data_type != NULL) {

   205

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

   206

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

   207

        if (list == NULL) ERROR;  

   208

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

   209

          s4o.print("__");

   210

          data_type->accept(*this);

   211

        }  

   212

      }

   213

    }

   214

   215

  public:

   216

    print_function_parameter_data_types_c(stage4out_c *s4o_ptr): 

   217

      generate_c_base_c(s4o_ptr)

   218

      {current_type = NULL;}

   219

   220

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

   221

    /* B.1.5 - Program organization units */

   222

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

   223

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

   224

    /* B 1.5.1 - Functions */

   225

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

   226

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

   227

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

   228

    void *visit(function_declaration_c *symbol) {

   229

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

   230

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

   231

      return NULL;

   232

    }

   233

   234

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

   235

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

   236

   237

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

   238

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

   239

   240

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

   241

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

   242

   243

    void *visit(edge_declaration_c *symbol) {

   244

      current_type = &tmp_bool; 

   245

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

   246

      current_type = NULL; 

   247

      return NULL;

   248

    }

   249

   250

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

   251

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

   252

   253

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

   254

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

   255

   256

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

   257

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

   258

   259

    void *visit(simple_spec_init_c *symbol) {

   260

      /* return the data type */

   261

      return symbol->simple_specification; 

   262

    }

   263

   264

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

   265

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

   266

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

   267

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

   268

     */

   269

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

   270

   271

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

   272

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

   273

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

   274

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

   275

     */

   276

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

   277

   278

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

   279

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

   280

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

   281

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

   282

     */

   283

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

   284

   285

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

   286

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

   287

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

   288

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

   289

     */

   290

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

   291

   292

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

   293

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

   294

   295

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

   296

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

   297

   298

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

   299

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

   300

   301

    void *visit(fb_name_decl_c *symbol) {

   302

      print_list(symbol->fb_name_list, symbol->function_block_type_name); 

   303

      return NULL;

   304

    }

   305

   306

    void *visit(var1_init_decl_c *symbol) {

   307

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

   308

      return NULL;

   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

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

   314

   315

    void *visit(structured_var_declaration_c *symbol) {

   316

      current_type = symbol->structure_type_name; 

   317

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

   318

      current_type = NULL; 

   319

      return NULL;

   320

    }

   321

   322

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

   323

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

   324

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

   325

     *   STRING [ 42 ]

   326

     */

   327

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

   328

   329

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

   330

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

   331

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

   332

     *   WSTRING [ 42 ]

   333

     */

   334

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

   335

};

   336

   337

   338

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

   339

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

   340

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

   341

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

   342

   343

   344

#include "generate_c_st.cc"

   345

#include "generate_c_il.cc"

   346

#include "generate_c_inlinefcall.cc"

   347

   348

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

   349

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

   350

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

   351

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

   352

   353

#define MILLISECOND 1000000

   354

#define SECOND 1000 * MILLISECOND

   355

   356

unsigned long long calculate_time(symbol_c *symbol) {

   357

  if (NULL == symbol) return 0;

   358

   359

  interval_c *interval = dynamic_cast<interval_c *>(symbol);

   360

  duration_c *duration = dynamic_cast<duration_c *>(symbol);

   361

   362

  if ((NULL == interval) && (NULL == duration))

   363

  	  {STAGE4_ERROR(symbol, symbol, "This type of interval value is not currently supported"); ERROR;}

   364

   365

  if (NULL != duration) {

   366

    /* SYM_REF2(duration_c, neg, interval) */

   367

    if (duration->neg != NULL)

   368

      {STAGE4_ERROR(duration, duration, "Negative TIME literals for interval are not currently supported"); ERROR;}

   369

    return calculate_time(duration->interval);

   370

  }

   371

   372

  if (NULL != interval) {

   373

    /* SYM_REF5(interval_c, days, hours, minutes, seconds, milliseconds) */

   374

      unsigned long long int time_ull = 0; 

   375

      long double            time_ld  = 0;

   376

      /*

   377

      const unsigned long long int MILLISECOND = 1000000;

   378

      const unsigned long long int      SECOND = 1000 * MILLISECOND

   379

      */

   380

   381

      if (NULL != interval->milliseconds) {

   382

        if      (VALID_CVALUE( int64, interval->milliseconds) &&           GET_CVALUE( int64, interval->milliseconds) < 0) ERROR; // interval elements should always be positive!

   383

        if      (VALID_CVALUE( int64, interval->milliseconds)) time_ull += GET_CVALUE( int64, interval->milliseconds) * MILLISECOND;

   384

        else if (VALID_CVALUE(uint64, interval->milliseconds)) time_ull += GET_CVALUE(uint64, interval->milliseconds) * MILLISECOND;

   385

        else if (VALID_CVALUE(real64, interval->milliseconds)) time_ld  += GET_CVALUE(real64, interval->milliseconds) * MILLISECOND;

   386

        else ERROR; // if (NULL != interval->milliseconds) is true, then it must have a valid constant value!

   387

      }

   388

   389

      if (NULL != interval->seconds     ) {

   390

        if      (VALID_CVALUE( int64, interval->seconds     ) &&           GET_CVALUE( int64, interval->seconds     ) < 0) ERROR; // interval elements should always be positive!

   391

        if      (VALID_CVALUE( int64, interval->seconds     )) time_ull += GET_CVALUE( int64, interval->seconds     ) * SECOND;

   392

        else if (VALID_CVALUE(uint64, interval->seconds     )) time_ull += GET_CVALUE(uint64, interval->seconds     ) * SECOND;

   393

        else if (VALID_CVALUE(real64, interval->seconds     )) time_ld  += GET_CVALUE(real64, interval->seconds     ) * SECOND;

   394

        else ERROR; // if (NULL != interval->seconds) is true, then it must have a valid constant value!

   395

      }

   396

   397

      if (NULL != interval->minutes     ) {

   398

        if      (VALID_CVALUE( int64, interval->minutes     ) &&           GET_CVALUE( int64, interval->minutes     ) < 0) ERROR; // interval elements should always be positive!

   399

        if      (VALID_CVALUE( int64, interval->minutes     )) time_ull += GET_CVALUE( int64, interval->minutes     ) * SECOND * 60;

   400

        else if (VALID_CVALUE(uint64, interval->minutes     )) time_ull += GET_CVALUE(uint64, interval->minutes     ) * SECOND * 60;

   401

        else if (VALID_CVALUE(real64, interval->minutes     )) time_ld  += GET_CVALUE(real64, interval->minutes     ) * SECOND * 60;

   402

        else ERROR; // if (NULL != interval->minutes) is true, then it must have a valid constant value!

   403

      }

   404

   405

      if (NULL != interval->hours       ) {

   406

        if      (VALID_CVALUE( int64, interval->hours       ) &&           GET_CVALUE( int64, interval->hours       ) < 0) ERROR; // interval elements should always be positive!

   407

        if      (VALID_CVALUE( int64, interval->hours       )) time_ull += GET_CVALUE( int64, interval->hours       ) * SECOND * 60 * 60;

   408

        else if (VALID_CVALUE(uint64, interval->hours       )) time_ull += GET_CVALUE(uint64, interval->hours       ) * SECOND * 60 * 60;

   409

        else if (VALID_CVALUE(real64, interval->hours       )) time_ld  += GET_CVALUE(real64, interval->hours       ) * SECOND * 60 * 60;

   410

        else ERROR; // if (NULL != interval->hours) is true, then it must have a valid constant value!

   411

      }

   412

   413

      if (NULL != interval->days        ) {

   414

        if      (VALID_CVALUE( int64, interval->days        ) &&           GET_CVALUE( int64, interval->days        ) < 0) ERROR; // interval elements should always be positive!

   415

        if      (VALID_CVALUE( int64, interval->days        )) time_ull += GET_CVALUE( int64, interval->days        ) * SECOND * 60 * 60 * 24;

   416

        else if (VALID_CVALUE(uint64, interval->days        )) time_ull += GET_CVALUE(uint64, interval->days        ) * SECOND * 60 * 60 * 24;

   417

        else if (VALID_CVALUE(real64, interval->days        )) time_ld  += GET_CVALUE(real64, interval->days        ) * SECOND * 60 * 60 * 24;

   418

        else ERROR; // if (NULL != interval->days) is true, then it must have a valid constant value!

   419

      }

   420

   421

      time_ull += time_ld;

   422

      return time_ull;

   423

  };

   424

  ERROR; // should never reach this point!

   425

  return 0; // humour the compiler!

   426

};

   427

   428

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

   429

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

   430

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

   431

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

   432

   433

class calculate_common_ticktime_c: public iterator_visitor_c {

   434

  private:

   435

    unsigned long long common_ticktime;

   436

    unsigned long long least_common_ticktime;

   437

   438

  public:

   439

    calculate_common_ticktime_c(void){

   440

      common_ticktime = 0;

   441

      least_common_ticktime = 0;

   442

    }

   443

   444

    unsigned long long euclide(unsigned long long a, unsigned long long b) {

   445

      unsigned long long c = a % b;

   446

      if (c == 0)

   447

        return b;

   448

      else

   449

        return euclide(b, c);

   450

    }

   451

   452

    void update_ticktime(unsigned long long time) {

   453

      if (common_ticktime == 0)

   454

        common_ticktime = time;

   455

      else if (time > common_ticktime)

   456

        common_ticktime = euclide(time, common_ticktime);

   457

      else

   458

        common_ticktime = euclide(common_ticktime, time);

   459

      if (least_common_ticktime == 0)

   460

        least_common_ticktime = time;

   461

      else

   462

        least_common_ticktime = (least_common_ticktime * time) / common_ticktime;

   463

    }

   464

   465

    unsigned long long get_common_ticktime(void) {

   466

      return common_ticktime;

   467

    }

   468

   469

    unsigned long get_greatest_tick_count(void) {

   470

      unsigned long long least_common_tick = least_common_ticktime / common_ticktime;

   471

      if (least_common_tick >> 32)

   472

        ERROR;

   473

      return (unsigned long)(~(((unsigned long)-1) % (unsigned long)least_common_tick) + 1);

   474

    }

   475

   476

/*  TASK task_name task_initialization */

   477

//SYM_REF2(task_configuration_c, task_name, task_initialization)  

   478

    void *visit(task_initialization_c *symbol) {

   479

      unsigned long long time = calculate_time(symbol->interval_data_source);

   480

      if (time < 0)  ERROR;

   481

      else           update_ticktime(time);

   482

      return NULL;

   483

    }

   484

};    

   485

   486

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

   487

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

   488

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

   489

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

   490

   491

/* A helper class that knows how to generate code for the SFC, IL and ST languages... */

   492

class generate_c_SFC_IL_ST_c: public null_visitor_c {

   493

  private:

   494

    stage4out_c *s4o_ptr;

   495

    symbol_c *scope;

   496

    symbol_c *fbname;

   497

    const char *variable_prefix;

   498

   499

  public:

   500

    generate_c_SFC_IL_ST_c(stage4out_c *s4o_ptr, symbol_c *name, symbol_c *scope, const char *variable_prefix = NULL);