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

    35

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

    36

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

    37

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

    38

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

    39

    40

#include "../stage4.hh"

    41

    42

//#define DEBUG

    43

#ifdef DEBUG

    44

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

    45

#else

    46

#define TRACE(classname)

    47

#endif

    48

    49

#define ERROR error_exit(__FILE__,__LINE__)

    50

/* function defined in main.cc */

    51

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

    52

    53

    54

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

    55

    56

    63

    64

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

    65

    66

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

    67

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

    68

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

    69

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

    70

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

    71

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

    72

 * default variable.

    73

 *

    74

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

    75

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

    76

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

    77

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

    78

 * constant.

    79

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

    80

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

    81

 * in IL and ST.

    82

 *

    83

 * e.g.:  FUNTION_BLOCK TEST

    84

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

    85

 */

    86

    87

#define FB_FUNCTION_SUFFIX "_body__"

    88

    89

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

    90

#define FB_INIT_SUFFIX "_init__"

    91

    92

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

    93

#define FB_RUN_SUFFIX "_run__"

    94

    95

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

    96

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

    97

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

    98

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

    99

 * in IL and ST.

   100

 *

   101

 * e.g.: the body of FUNTION_BLOCK TEST

   102

 * is mapped onto the C function

   103

 *  TEST_body__(TEST *data__)

   104

 */

   105

   106

#define FB_FUNCTION_PARAM "data__"

   107

   108

   109

#define SFC_STEP_ACTION_PREFIX "__SFC_"

   110

   111

   112

/* Variable declaration symbol for accessor macros */

   113

#define DECLARE_VAR "__DECLARE_VAR"

   114

#define DECLARE_GLOBAL "__DECLARE_GLOBAL"

   115

#define DECLARE_GLOBAL_LOCATION "__DECLARE_GLOBAL_LOCATION"

   116

#define DECLARE_GLOBAL_LOCATED "__DECLARE_GLOBAL_LOCATED"

   117

#define DECLARE_EXTERNAL "__DECLARE_EXTERNAL"

   118

#define DECLARE_LOCATED "__DECLARE_LOCATED"

   119

#define DECLARE_GLOBAL_PROTOTYPE "__DECLARE_GLOBAL_PROTOTYPE"

   120

   121

/* Variable declaration symbol for accessor macros */

   122

#define INIT_VAR "__INIT_VAR"

   123

#define INIT_GLOBAL "__INIT_GLOBAL"

   124

#define INIT_GLOBAL_LOCATED "__INIT_GLOBAL_LOCATED"

   125

#define INIT_EXTERNAL "__INIT_EXTERNAL"

   126

#define INIT_LOCATED "__INIT_LOCATED"

   127

#define INIT_LOCATED_VALUE "__INIT_LOCATED_VALUE"

   128

   129

/* Variable getter symbol for accessor macros */

   130

#define GET_VAR "__GET_VAR"

   131

#define GET_EXTERNAL "__GET_EXTERNAL"

   132

#define GET_LOCATED "__GET_LOCATED"

   133

#define GET_VAR_BY_REF "__GET_VAR_BY_REF"

   134

#define GET_EXTERNAL_BY_REF "__GET_EXTERNAL_BY_REF"

   135

#define GET_LOCATED_BY_REF "__GET_LOCATED_BY_REF"

   136

   137

/* Variable setter symbol for accessor macros */

   138

#define SET_VAR "__SET_VAR"

   139

#define SET_EXTERNAL "__SET_EXTERNAL"

   140

#define SET_LOCATED "__SET_LOCATED"

   141

   142

/* Variable initial value symbol for accessor macros */

   143

#define INITIAL_VALUE "__INITIAL_VALUE"

   144

   145

/* Generate a name for a temporary variable.

   146

 * Each new name generated is appended a different number,

   147

 * starting off from 0.

   148

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

   149

 */

   150

#define VAR_LEADER "__"

   151

#define TEMP_VAR VAR_LEADER "TMP_"

   152

#define SOURCE_VAR VAR_LEADER "SRC_"

   153

   154

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

   155

#define END_LABEL VAR_LEADER "end"

   156

   157

   158

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

   159

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

   160

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

   161

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

   162

   163

#include "generate_c_base.cc"

   164

#include "generate_c_typedecl.cc"

   165

#include "generate_c_sfcdecl.cc"

   166

#include "generate_c_vardecl.cc"

   167

#include "generate_c_configbody.cc"

   168

#include "generate_location_list.cc"

   169

#include "generate_var_list.cc"

   170

   171

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

   172

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

   173

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

   174

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

   175

   176

   177

#include "generate_c.hh"

   178

   179

   180

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

   181

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

   182

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

   183

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

   184

   185

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

   186

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

   187

 * will simply print out the returned data type,

   188

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

   189

 *   for e.g.; 

   190

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

   191

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

   192

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

   193

 */

   194

class print_function_parameter_data_types_c: public generate_c_base_c {

   195

  private:

   196

    symbol_c *current_type;

   197

    bool_type_name_c tmp_bool;

   198

   199

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

   200

      if (data_type != NULL) {

   201

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

   202

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

   203

        if (list == NULL) ERROR;  

   204

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

   205

          s4o.print("__");

   206

          data_type->accept(*this);

   207

        }  

   208

      }

   209

    }

   210

   211

  public:

   212

    print_function_parameter_data_types_c(stage4out_c *s4o_ptr): 

   213

      generate_c_base_c(s4o_ptr)

   214

      {current_type = NULL;}

   215

   216

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

   217

    /* B.1.5 - Program organization units */

   218

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

   219

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

   220

    /* B 1.5.1 - Functions */

   221

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

   222

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

   223

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

   224

    void *visit(function_declaration_c *symbol) {

   225

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

   226

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

   227

      return NULL;

   228

    }

   229

   230

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

   231

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

   232

   233

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

   234

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

   235

   236

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

   237

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

   238

   239

    void *visit(edge_declaration_c *symbol) {

   240

      current_type = &tmp_bool; 

   241

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

   242

      current_type = NULL; 

   243

      return NULL;

   244

    }

   245

   246

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

   247

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

   248

   249

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

   250

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

   251

   252

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

   253

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

   254

   255

    void *visit(simple_spec_init_c *symbol) {

   256

      /* return the data type */

   257

      return symbol->simple_specification; 

   258

    }

   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_subrange_type_name

   263

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

   264

     */

   265

    void *visit(subrange_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_enumerated_type_name

   270

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

   271

     */

   272

    void *visit(enumerated_spec_init_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_array_type_name

   277

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

   278

     */

   279

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

   280

   281

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

   282

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

   283

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

   284

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

   285

     */

   286

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

   287

   288

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

   289

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

   290

   291

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

   292

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

   293

   294

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

   295

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

   296

   297

    void *visit(fb_name_decl_c *symbol) {

   298

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

   299

      return NULL;

   300

    }

   301

   302

    void *visit(var1_init_decl_c *symbol) {

   303

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

   304

      return NULL;

   305

    }

   306

   307

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

   308

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

   309

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

   310

   311

    void *visit(structured_var_declaration_c *symbol) {

   312

      current_type = symbol->structure_type_name; 

   313

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

   314

      current_type = NULL; 

   315

      return NULL;

   316

    }

   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

     *   STRING [ 42 ]

   322

     */

   323

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

   328

     *   WSTRING [ 42 ]

   329

     */

   330

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

   331

};

   332

   333

   334

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

   335

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

   336

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

   337

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

   338

   339

   340

#include "generate_c_st.cc"

   341

#include "generate_c_il.cc"

   342

#include "generate_c_inlinefcall.cc"

   343

   344

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

   345

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

   346

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

   347

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

   348

   349

#define MILLISECOND 1000000

   350

#define SECOND 1000 * MILLISECOND

   351

   352

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

   353

class calculate_time_c: public iterator_visitor_c {

   354

  private:

   355

    unsigned long long time;

   356

    float current_value;

   357

   358

  public:

   359

    calculate_time_c(void){time = 0;};

   360

   361

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

   362

   363

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

   364

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

   365

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

   366

     */

   367

    void *get_integer_value(token_c *token) {

   368

      std::string str = "";

   369

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

   370

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

   371

          str += token->value[i];

   372

      current_value = atof(str.c_str());

   373

      return NULL;

   374

    }

   375

   376

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

   377

     *       but we leave it for now.

   378

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

   379

     */

   380

    void *get_float_value(token_c *token) {

   381

      current_value = atof(token->value);

   382

      return NULL;

   383

    }

   384

   385

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

   386

/* B 1.2.1 - Numeric Literals */

   387

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

   388

   389

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

   390

   391

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

   392

/* B 1.2.3.1 - Duration */

   393

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

   394

   395

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

   396

    void *visit(duration_c *symbol) {

   397

      if (symbol->neg != NULL)

   398

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

   399

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

   400

      return NULL;

   401

    }

   402

   403

    /* SYM_TOKEN(fixed_point_c) */

   404

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

   405

   406

   407

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

   408

    void *visit(interval_c *symbol) {

   409

      current_value = 0;

   410

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

   411

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

   412

   413

      current_value = 0;

   414

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

   415

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

   416

   417

      current_value = 0;

   418

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

   419

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

   420

   421

      current_value = 0;

   422

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

   423

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

   424

   425

      current_value = 0;

   426

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

   427

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

   428

   429

      return NULL;

   430

    }      

   431

};

   432

   433

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

   434

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

   435

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

   436

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

   437

   438

class calculate_common_ticktime_c: public iterator_visitor_c {

   439

  private:

   440

    unsigned long long common_ticktime;

   441

    unsigned long long least_common_ticktime;

   442

   443

  public:

   444

    calculate_common_ticktime_c(void){

   445

      common_ticktime = 0;

   446

      least_common_ticktime = 0;

   447

    }

   448

   449

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

   450

      unsigned long long c = a % b;

   451

      if (c == 0)

   452

        return b;

   453

      else

   454

        return euclide(b, c);

   455

    }

   456

   457

    void update_ticktime(unsigned long long time) {

   458

      if (common_ticktime == 0)

   459

        common_ticktime = time;

   460

      else if (time > common_ticktime)

   461

        common_ticktime = euclide(time, common_ticktime);

   462

      else

   463

        common_ticktime = euclide(common_ticktime, time);

   464

      if (least_common_ticktime == 0)

   465

        least_common_ticktime = time;

   466

      else

   467

        least_common_ticktime = (least_common_ticktime * time) / common_ticktime;

   468

    }

   469

   470

    unsigned long long get_common_ticktime(void) {

   471

      return common_ticktime;

   472

    }

   473

   474

    unsigned long get_greatest_tick_count(void) {

   475

      unsigned long long least_common_tick = least_common_ticktime / common_ticktime;

   476

      if (least_common_tick >> 32)

   477

        ERROR;

   478

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

   479

    }

   480

   481

/*  TASK task_name task_initialization */

   482

//SYM_REF2(task_configuration_c, task_name, task_initialization)  

   483

    void *visit(task_initialization_c *symbol) {

   484

      calculate_time_c calculate_time;

   485

      unsigned long long time = 0;

   486

      if (symbol->interval_data_source != NULL) {

   487

        symbol->interval_data_source->accept(calculate_time);

   488

        time = calculate_time.get_time();

   489

      }

   490

      if (time > 0)

   491

        update_ticktime(time);

   492

      return NULL;

   493

    }

   494

};    

   495

   496

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

   497

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

   498

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

   499

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

   500

   501

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

   502

class generate_c_SFC_IL_ST_c: public null_visitor_c {

   503

  private:

   504

    stage4out_c *s4o_ptr;

   505