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

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

    35

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

    36

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

    37

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

    38

    39

#include "../stage4.hh"

    40

    41

//#define DEBUG

    42

#ifdef DEBUG

    43

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

    44

#else

    45

#define TRACE(classname)

    46

#endif

    47

    48

#define ERROR error_exit(__FILE__,__LINE__)

    49

/* function defined in main.cc */

    50

extern void error_exit(const char *file_name, int line_no);

    51

    52

    53

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

    54

    55

    56

    57

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

    58

    59

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

    60

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

    61

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

    62

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

    63

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

    64

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

    65

 * default variable.

    66

 *

    67

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

    68

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

    69

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

    70

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

    71

 * constant.

    72

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

    73

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

    74

 * in IL and ST.

    75

 *

    76

 * e.g.:  FUNTION_BLOCK TEST

    77

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

    78

 */

    79

    80

#define FB_FUNCTION_SUFFIX "_body__"

    81

    82

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

    83

#define FB_INIT_SUFFIX "_init__"

    84

    85

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

    86

#define FB_RUN_SUFFIX "_run__"

    87

    88

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

    89

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

    90

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

    91

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

    92

 * in IL and ST.

    93

 *

    94

 * e.g.: the body of FUNTION_BLOCK TEST

    95

 * is mapped onto the C function

    96

 *  TEST_body__(TEST *data__)

    97

 */

    98

    99

#define FB_FUNCTION_PARAM "data__"

   100

   101

   102

#define SFC_STEP_ACTION_PREFIX "__SFC_"

   103

   104

   105

/* Variable declaration symbol for accessor macros */

   106

#define DECLARE_VAR "__DECLARE_VAR"

   107

#define DECLARE_GLOBAL "__DECLARE_GLOBAL"

   108

#define DECLARE_GLOBAL_LOCATION "__DECLARE_GLOBAL_LOCATION"

   109

#define DECLARE_GLOBAL_LOCATED "__DECLARE_GLOBAL_LOCATED"

   110

#define DECLARE_EXTERNAL "__DECLARE_EXTERNAL"

   111

#define DECLARE_LOCATED "__DECLARE_LOCATED"

   112

#define DECLARE_GLOBAL_PROTOTYPE "__DECLARE_GLOBAL_PROTOTYPE"

   113

   114

/* Variable declaration symbol for accessor macros */

   115

#define INIT_VAR "__INIT_VAR"

   116

#define INIT_GLOBAL "__INIT_GLOBAL"

   117

#define INIT_GLOBAL_LOCATED "__INIT_GLOBAL_LOCATED"

   118

#define INIT_EXTERNAL "__INIT_EXTERNAL"

   119

#define INIT_LOCATED "__INIT_LOCATED"

   120

#define INIT_LOCATED_VALUE "__INIT_LOCATED_VALUE"

   121

   122

/* Variable getter symbol for accessor macros */

   123

#define GET_VAR "__GET_VAR"

   124

#define GET_EXTERNAL "__GET_EXTERNAL"

   125

#define GET_LOCATED "__GET_LOCATED"

   126

#define GET_VAR_BY_REF "__GET_VAR_BY_REF"

   127

#define GET_EXTERNAL_BY_REF "__GET_EXTERNAL_BY_REF"

   128

#define GET_LOCATED_BY_REF "__GET_LOCATED_BY_REF"

   129

   130

/* Variable setter symbol for accessor macros */

   131

#define SET_VAR "__SET_VAR"

   132

#define SET_EXTERNAL "__SET_EXTERNAL"

   133

#define SET_LOCATED "__SET_LOCATED"

   134

   135

/* Variable initial value symbol for accessor macros */

   136

#define INITIAL_VALUE "__INITIAL_VALUE"

   137

   138

/* Generate a name for a temporary variable.

   139

 * Each new name generated is appended a different number,

   140

 * starting off from 0.

   141

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

   142

 */

   143

#define VAR_LEADER "__"

   144

#define TEMP_VAR VAR_LEADER "TMP_"

   145

#define SOURCE_VAR VAR_LEADER "SRC_"

   146

   147

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

   148

#define END_LABEL VAR_LEADER "end"

   149

   150

   151

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

   152

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

   153

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

   154

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

   155

   156

#include "generate_c_base.cc"

   157

#include "generate_c_typedecl.cc"

   158

#include "generate_c_sfcdecl.cc"

   159

#include "generate_c_vardecl.cc"

   160

#include "generate_c_configbody.cc"

   161

#include "generate_location_list.cc"

   162

#include "generate_var_list.cc"

   163

   164

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

   165

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

   166

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

   167

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

   168

   169

   170

#include "generate_c.hh"

   171

   172

   173

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

   174

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

   175

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

   176

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

   177

   178

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

   179

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

   180

 * will simply print out the returned data type,

   181

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

   182

 *   for e.g.; 

   183

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

   184

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

   185

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

   186

 */

   187

class print_function_parameter_data_types_c: public generate_c_base_c {

   188

  private:

   189

    symbol_c *current_type;

   190

    bool_type_name_c tmp_bool;

   191

   192

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

   193

      if (data_type != NULL) {

   194

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

   195

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

   196

        if (list == NULL) ERROR;  

   197

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

   198

          s4o.print("__");

   199

          data_type->accept(*this);

   200

        }  

   201

      }

   202

    }

   203

   204

  public:

   205

    print_function_parameter_data_types_c(stage4out_c *s4o_ptr): 

   206

      generate_c_base_c(s4o_ptr)

   207

      {current_type = NULL;}

   208

   209

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

   210

    /* B.1.5 - Program organization units */

   211

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

   212

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

   213

    /* B 1.5.1 - Functions */

   214

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

   215

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

   216

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

   217

    void *visit(function_declaration_c *symbol) {

   218

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

   219

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

   220

      return NULL;

   221

    }

   222

   223

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

   224

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

   225

   226

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

   227

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

   228

   229

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

   230

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

   231

   232

    void *visit(edge_declaration_c *symbol) {

   233

      current_type = &tmp_bool; 

   234

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

   235

      current_type = NULL; 

   236

      return NULL;

   237

    }

   238

   239

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

   240

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

   241

   242

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

   243

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

   244

   245

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

   246

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

   247

   248

    void *visit(simple_spec_init_c *symbol) {

   249

      /* return the data type */

   250

      return symbol->simple_specification; 

   251

    }

   252

   253

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

   254

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

   255

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

   256

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

   257

     */

   258

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

   259

   260

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

   261

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

   262

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

   263

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

   264

     */

   265

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

   266

   267

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

   268

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

   269

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

   270

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

   271

     */

   272

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

   273

   274

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

   275

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

   276

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

   277

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

   278

     */

   279

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

   280

   281

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

   282

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

   283

   284

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

   285

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

   289

   290

    void *visit(fb_name_decl_c *symbol) {

   291

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

   292

      return NULL;

   293

    }

   294

   295

    void *visit(var1_init_decl_c *symbol) {

   296

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

   297

      return NULL;

   298

    }

   299

   300

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

   301

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

   302

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

   303

   304

    void *visit(structured_var_declaration_c *symbol) {

   305

      current_type = symbol->structure_type_name; 

   306

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

   307

      current_type = NULL; 

   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

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

   314

     *   STRING [ 42 ]

   315

     */

   316

    void *visit(single_byte_string_var_declaration_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 that this class is used for fixed length strings...

   321

     *   WSTRING [ 42 ]

   322

     */

   323

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

   324

};

   325

   326

   327

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

   328

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

   329

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

   330

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

   331

   332

   333

#include "generate_c_st.cc"

   334

#include "generate_c_il.cc"

   335

#include "generate_c_inlinefcall.cc"

   336

   337

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

   338

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

   339

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

   340

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

   341

   342

#define MILLISECOND 1000000

   343

#define SECOND 1000 * MILLISECOND

   344

   345

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

   346

class calculate_time_c: public iterator_visitor_c {

   347

  private:

   348

    unsigned long long time;

   349

    float current_value;

   350

   351

  public:

   352

    calculate_time_c(void){time = 0;};

   353

   354

    unsigned long long get_time(void) {return time;};

   355

   356

    /* NOTE: we should really remove this function, and replace it with  extract_integer_value() (in absyntax_utils.h)

   357

     *       but right now I don't want to spend time checking if this change will introduce some conversion bug

   358

     *       since it returns a long long, and not a float!

   359

     */

   360

    void *get_integer_value(token_c *token) {

   361

      std::string str = "";

   362

      for (unsigned int i = 0; i < strlen(token->value); i++)

   363

        if (token->value[i] != '_')

   364

          str += token->value[i];

   365

      current_value = atof(str.c_str());

   366

      return NULL;

   367

    }

   368

   369

    /* NOTE: this function is incomplete, as it should also be removing '_' inserted into the literal,

   370

     *       but we leave it for now.

   371

     *       In truth, we should really have an extract_real_value() in absyntax_util.h !!!

   372

     */

   373

    void *get_float_value(token_c *token) {

   374

      current_value = atof(token->value);

   375

      return NULL;

   376

    }

   377

   378

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

   379

/* B 1.2.1 - Numeric Literals */

   380

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

   381

   382

    void *visit(integer_c *symbol) {return get_integer_value(symbol);}

   383

   384

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

   385

/* B 1.2.3.1 - Duration */

   386

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

   387

   388

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

   389

    void *visit(duration_c *symbol) {

   390

      if (symbol->neg != NULL)

   391

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

   392

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

   393

      return NULL;

   394

    }

   395

   396

    /* SYM_TOKEN(fixed_point_c) */

   397

    void *visit(fixed_point_c *symbol) {return get_float_value(symbol);}

   398

   399

   400

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

   401

    void *visit(interval_c *symbol) {

   402

      current_value = 0;

   403

      if (NULL != symbol->milliseconds) symbol->milliseconds->accept(*this);

   404

      time += (unsigned long long)(current_value * MILLISECOND);

   405

   406

      current_value = 0;

   407

      if (NULL != symbol->seconds)      symbol->seconds->accept(*this);

   408

      time += (unsigned long long)(current_value * SECOND);

   409

   410

      current_value = 0;

   411

      if (NULL != symbol->minutes)      symbol->minutes->accept(*this);

   412

      time += (unsigned long long)(current_value * 60 * SECOND);

   413

   414

      current_value = 0;

   415

      if (NULL != symbol->hours)        symbol->hours->accept(*this);

   416

      time += (unsigned long long)(current_value * 60 * 60 * SECOND);

   417

   418

      current_value = 0;

   419

      if (NULL != symbol->days)         symbol->days->accept(*this);

   420

      time += (unsigned long long)(current_value * 60 * 60 * 24 * SECOND);

   421

   422

      return NULL;

   423

    }      

   424

};

   425

   426

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

   427

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

   428

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

   429

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

   430

   431

class calculate_common_ticktime_c: public iterator_visitor_c {

   432

  private:

   433

    unsigned long long common_ticktime;

   434

    unsigned long long least_common_ticktime;

   435

   436

  public:

   437

    calculate_common_ticktime_c(void){

   438

      common_ticktime = 0;

   439

      least_common_ticktime = 0;

   440

    }

   441

   442

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

   443

      unsigned long long c = a % b;

   444

      if (c == 0)

   445

        return b;

   446

      else

   447

        return euclide(b, c);

   448

    }

   449

   450

    void update_ticktime(unsigned long long time) {

   451

      if (common_ticktime == 0)

   452

        common_ticktime = time;

   453

      else if (time > common_ticktime)

   454

        common_ticktime = euclide(time, common_ticktime);

   455

      else

   456

        common_ticktime = euclide(common_ticktime, time);

   457

      if (least_common_ticktime == 0)

   458

        least_common_ticktime = time;

   459

      else

   460

        least_common_ticktime = (least_common_ticktime * time) / common_ticktime;

   461

    }

   462

   463

    unsigned long long get_common_ticktime(void) {

   464

      return common_ticktime;

   465

    }

   466

   467

    unsigned long get_greatest_tick_count(void) {

   468

      unsigned long long least_common_tick = least_common_ticktime / common_ticktime;

   469

      if (least_common_tick >> 32)

   470

        ERROR;

   471

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

   472

    }

   473

   474

/*  TASK task_name task_initialization */

   475

//SYM_REF2(task_configuration_c, task_name, task_initialization)  

   476

    void *visit(task_initialization_c *symbol) {

   477

      calculate_time_c calculate_time;

   478

      unsigned long long time = 0;

   479

      if (symbol->interval_data_source != NULL) {

   480

        symbol->interval_data_source->accept(calculate_time);

   481

        time = calculate_time.get_time();

   482

      }

   483

      if (time > 0)

   484

        update_ticktime(time);

   485

      return NULL;

   486

    }

   487

};    

   488

   489

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

   490

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

   491

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

   492

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

   493

   494

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

   495

class generate_c_SFC_IL_ST_c: public null_visitor_c {

   496

  private:

   497

    stage4out_c *s4o_ptr;

   498

    symbol_c *scope;

   499

    symbol_c *fbname;

   500

    const char *variable_prefix;

   501

   502

  public:

   503

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

   504

   505

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