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

/* NOTE: The following test is correct in the presence of a NULL pointer, as the logical evaluation will be suspended as soon as the first condition is false! */

    57

#define VALID_CVALUE(dtype, symbol)           ((NULL != (symbol)->const_value_##dtype) && (symbol_c::cs_const_value == (symbol)->const_value_##dtype->status))

    58

#define GET_CVALUE(dtype, symbol)             ((symbol)->const_value_##dtype->value) 

    59

    60

    61

    62

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

    63

    64

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

    65

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

    66

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

    67

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

    68

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

    69

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

    70

 * default variable.

    71

 *

    72

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

    73

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

    74

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

    75

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

    76

 * constant.

    77

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

    78

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

    79

 * in IL and ST.

    80

 *

    81

 * e.g.:  FUNTION_BLOCK TEST

    82

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

    83

 */

    84

    85

#define FB_FUNCTION_SUFFIX "_body__"

    86

    87

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

    88

#define FB_INIT_SUFFIX "_init__"

    89

    90

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

    91

#define FB_RUN_SUFFIX "_run__"

    92

    93

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

    94

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

    95

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

    96

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

    97

 * in IL and ST.

    98

 *

    99

 * e.g.: the body of FUNTION_BLOCK TEST

   100

 * is mapped onto the C function

   101

 *  TEST_body__(TEST *data__)

   102

 */

   103

   104

#define FB_FUNCTION_PARAM "data__"

   105

   106

   107

#define SFC_STEP_ACTION_PREFIX "__SFC_"

   108

   109

   110

/* Variable declaration symbol for accessor macros */

   111

#define DECLARE_VAR "__DECLARE_VAR"

   112

#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"

   116

#define DECLARE_LOCATED "__DECLARE_LOCATED"

   117

#define DECLARE_GLOBAL_PROTOTYPE "__DECLARE_GLOBAL_PROTOTYPE"

   118

   119

/* Variable declaration symbol for accessor macros */

   120

#define INIT_VAR "__INIT_VAR"

   121

#define INIT_GLOBAL "__INIT_GLOBAL"

   122

#define INIT_GLOBAL_LOCATED "__INIT_GLOBAL_LOCATED"

   123

#define INIT_EXTERNAL "__INIT_EXTERNAL"

   124

#define INIT_LOCATED "__INIT_LOCATED"

   125

#define INIT_LOCATED_VALUE "__INIT_LOCATED_VALUE"

   126

   127

/* Variable getter symbol for accessor macros */

   128

#define GET_VAR "__GET_VAR"

   129

#define GET_EXTERNAL "__GET_EXTERNAL"

   130

#define GET_LOCATED "__GET_LOCATED"

   131

#define GET_VAR_BY_REF "__GET_VAR_BY_REF"

   132

#define GET_EXTERNAL_BY_REF "__GET_EXTERNAL_BY_REF"

   133

#define GET_LOCATED_BY_REF "__GET_LOCATED_BY_REF"

   134

   135

/* Variable setter symbol for accessor macros */

   136

#define SET_VAR "__SET_VAR"

   137

#define SET_EXTERNAL "__SET_EXTERNAL"

   138

#define SET_LOCATED "__SET_LOCATED"

   139

   140

/* Variable initial value symbol for accessor macros */

   141

#define INITIAL_VALUE "__INITIAL_VALUE"

   142

   143

/* Generate a name for a temporary variable.

   144

 * Each new name generated is appended a different number,

   145

 * starting off from 0.

   146

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

   147

 */

   148

#define VAR_LEADER "__"

   149

#define TEMP_VAR VAR_LEADER "TMP_"

   150

#define SOURCE_VAR VAR_LEADER "SRC_"

   151

   152

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

   153

#define END_LABEL VAR_LEADER "end"

   154

   155

   156

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

   157

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

   158

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

   159

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

   160

   161

#include "generate_c_base.cc"

   162

#include "generate_c_typedecl.cc"

   163

#include "generate_c_sfcdecl.cc"

   164

#include "generate_c_vardecl.cc"

   165

#include "generate_c_configbody.cc"

   166

#include "generate_location_list.cc"

   167

#include "generate_var_list.cc"

   168

   169

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

   170

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

   171

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

   172

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

   173

   174

   175

#include "generate_c.hh"

   176

   177

   178

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

   179

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

   180

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

   181

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

   182

   183

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

   184

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

   185

 * will simply print out the returned data type,

   186

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

   187

 *   for e.g.; 

   188

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

   189

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

   190

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

   191

 */

   192

class print_function_parameter_data_types_c: public generate_c_base_c {

   193

  private:

   194

    symbol_c *current_type;

   195

    bool_type_name_c tmp_bool;

   196

   197

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

   198

      if (data_type != NULL) {

   199

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

   200

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

   201

        if (list == NULL) ERROR;  

   202

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

   203

          s4o.print("__");

   204

          data_type->accept(*this);

   205

        }  

   206

      }

   207

    }

   208

   209

  public:

   210

    print_function_parameter_data_types_c(stage4out_c *s4o_ptr): 

   211

      generate_c_base_c(s4o_ptr)

   212

      {current_type = NULL;}

   213

   214

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

   215

    /* B.1.5 - Program organization units */

   216

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

   217

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

   218

    /* B 1.5.1 - Functions */

   219

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

   220

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

   221

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

   222

    void *visit(function_declaration_c *symbol) {

   223

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

   224

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

   225

      return NULL;

   226

    }

   227

   228

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

   229

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

   230

   231

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

   232

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

   233

   234

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

   235

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

   236

   237

    void *visit(edge_declaration_c *symbol) {

   238

      current_type = &tmp_bool; 

   239

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

   240

      current_type = NULL; 

   241

      return NULL;

   242

    }

   243

   244

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

   245

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

   246

   247

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

   248

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

   249

   250

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

   251

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

   252

   253

    void *visit(simple_spec_init_c *symbol) {

   254

      /* return the data type */

   255

      return symbol->simple_specification; 

   256

    }

   257

   258

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

   259

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

   260

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

   261

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

   262

     */

   263

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

   264

   265

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

   266

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

   267

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

   268

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

   269

     */

   270

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

   271

   272

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

   273

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

   274

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

   275

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

   276

     */

   277

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

   278

   279

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

   280

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

   281

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

   282

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

   283

     */

   284

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

   285

   286

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

   287

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

   288

   289

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

   290

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

   291

   292

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

   293

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

   294

   295

    void *visit(fb_name_decl_c *symbol) {

   296

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

   297

      return NULL;

   298

    }

   299

   300

    void *visit(var1_init_decl_c *symbol) {

   301

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

   302

      return NULL;

   303

    }

   304

   305

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

   306

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

   307

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

   308

   309

    void *visit(structured_var_declaration_c *symbol) {

   310

      current_type = symbol->structure_type_name; 

   311

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

   312

      current_type = NULL; 

   313

      return NULL;

   314

    }

   315

   316

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

   317

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

   318

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

   319

     *   STRING [ 42 ]

   320

     */

   321

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

   322

   323

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

   324

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

   325

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

   326

     *   WSTRING [ 42 ]

   327

     */

   328

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

   329

};

   330

   331

   332

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

   333

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

   334

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

   335

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

   336

   337

   338

#include "generate_c_st.cc"

   339

#include "generate_c_il.cc"

   340

#include "generate_c_inlinefcall.cc"

   341

   342

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

   343

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

   344

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

   345

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

   346

   347

#define MILLISECOND 1000000

   348

#define SECOND 1000 * MILLISECOND

   349

   350

unsigned long long calculate_time(symbol_c *symbol) {

   351

  if (NULL == symbol) return 0;

   352

   353

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

   354

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

   355

   356

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

   357

   358

  if (NULL != duration) {

   359

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

   360

    if (duration->neg != NULL)

   361

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

   362

    return calculate_time(duration->interval);

   363

  }

   364

   365

  if (NULL != interval) {

   366

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

   367

      unsigned long long int time_ull = 0; 

   368

      long double            time_ld  = 0;

   369

      /*

   370

      const unsigned long long int MILLISECOND = 1000000;

   371

      const unsigned long long int      SECOND = 1000 * MILLISECOND

   372

      */

   373

   374

      if (NULL != interval->milliseconds) {

   375

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

   376

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

   377

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

   378

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

   379

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

   380

      }

   381

   382

      if (NULL != interval->seconds     ) {

   383

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

   384

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

   385

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

   386

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

   387

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

   388

      }

   389

   390

      if (NULL != interval->minutes     ) {

   391

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

   392

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

   393

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

   394

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

   395

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

   396

      }

   397

   398

      if (NULL != interval->hours       ) {

   399

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

   400

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

   401

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

   402

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

   403

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

   404

      }

   405

   406

      if (NULL != interval->days        ) {

   407

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

   408

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

   409

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

   410

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

   411

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

   412

      }

   413

   414

      time_ull += time_ld;

   415

      return time_ull;

   416

  };

   417

  ERROR; // should never reach this point!

   418

  return 0; // humour the compiler!

   419

};

   420

   421

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

   422

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

   423

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

   424

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

   425

   426

class calculate_common_ticktime_c: public iterator_visitor_c {

   427

  private:

   428

    unsigned long long common_ticktime;

   429

    unsigned long long least_common_ticktime;

   430

   431

  public:

   432

    calculate_common_ticktime_c(void){

   433

      common_ticktime = 0;

   434

      least_common_ticktime = 0;

   435

    }

   436

   437

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

   438

      unsigned long long c = a % b;

   439

      if (c == 0)

   440

        return b;

   441

      else

   442

        return euclide(b, c);

   443

    }

   444

   445

    void update_ticktime(unsigned long long time) {

   446

      if (common_ticktime == 0)

   447

        common_ticktime = time;

   448

      else if (time > common_ticktime)

   449

        common_ticktime = euclide(time, common_ticktime);

   450

      else

   451

        common_ticktime = euclide(common_ticktime, time);

   452

      if (least_common_ticktime == 0)

   453

        least_common_ticktime = time;

   454

      else

   455

        least_common_ticktime = (least_common_ticktime * time) / common_ticktime;

   456

    }

   457

   458

    unsigned long long get_common_ticktime(void) {

   459

      return common_ticktime;

   460

    }

   461

   462

    unsigned long get_greatest_tick_count(void) {

   463

      unsigned long long least_common_tick = least_common_ticktime / common_ticktime;

   464

      if (least_common_tick >> 32)

   465

        ERROR;

   466

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

   467

    }

   468

   469

/*  TASK task_name task_initialization */

   470

//SYM_REF2(task_configuration_c, task_name, task_initialization)  

   471

    void *visit(task_initialization_c *symbol) {

   472

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

   473

      if (time < 0)  ERROR;

   474

      else           update_ticktime(time);

   475

      return NULL;

   476

    }

   477

};    

   478

   479

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

   480

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

   481

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

   482

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

   483

   484

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

   485

class generate_c_SFC_IL_ST_c: public null_visitor_c {

   486

  private:

   487

    stage4out_c *s4o_ptr;

   488

    symbol_c *scope;

   489

    symbol_c *fbname;

   490

    const char *variable_prefix;

   491

   492

  public:

   493

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

   494

   495

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

   496

    /* 2.1.6 - Pragmas  */

   497

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

   498

    void *visit(enable_code_generation_pragma_c * symbol)   {s4o_ptr->enable_output();  return NULL;}

   499

    void *visit(disable_code_generation_pragma_c * symbol)  {s4o_ptr->disable_output(); return NULL;} 

   500

   501

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