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

    54

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

    55

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

    56

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

    57

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

    58

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

    59

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

    60

 * default variable.

    61

 *

    62

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

    63

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

    64

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

    65

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

    66

 * constant.

    67

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

    68

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

    69

 * in IL and ST.

    70

 *

    71

 * e.g.:  FUNTION_BLOCK TEST

    72

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

    73

 */

    74

    75

#define FB_FUNCTION_SUFFIX "_body__"

    76

    77

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

    78

#define FB_INIT_SUFFIX "_init__"

    79

    80

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

    81

#define FB_RUN_SUFFIX "_run__"

    82

    83

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

    84

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

    85

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

    86

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

    87

 * in IL and ST.

    88

 *

    89

 * e.g.: the body of FUNTION_BLOCK TEST

    90

 * is mapped onto the C function

    91

 *  TEST_body__(TEST *data__)

    92

 */

    93

    94

#define FB_FUNCTION_PARAM "data__"

    95

    96

    97

#define SFC_STEP_ACTION_PREFIX "__SFC_"

    98

    99

   100

/* Variable declaration symbol for accessor macros */

   101

#define DECLARE_VAR "__DECLARE_VAR"

   102

#define DECLARE_GLOBAL "__DECLARE_GLOBAL"

   103

#define DECLARE_GLOBAL_LOCATION "__DECLARE_GLOBAL_LOCATION"

   104

#define DECLARE_GLOBAL_LOCATED "__DECLARE_GLOBAL_LOCATED"

   105

#define DECLARE_EXTERNAL "__DECLARE_EXTERNAL"

   106

#define DECLARE_LOCATED "__DECLARE_LOCATED"

   107

#define DECLARE_GLOBAL_PROTOTYPE "__DECLARE_GLOBAL_PROTOTYPE"

   108

   109

/* Variable declaration symbol for accessor macros */

   110

#define INIT_VAR "__INIT_VAR"

   111

#define INIT_GLOBAL "__INIT_GLOBAL"

   112

#define INIT_GLOBAL_LOCATED "__INIT_GLOBAL_LOCATED"

   113

#define INIT_EXTERNAL "__INIT_EXTERNAL"

   114

#define INIT_LOCATED "__INIT_LOCATED"

   115

#define INIT_LOCATED_VALUE "__INIT_LOCATED_VALUE"

   116

   117

/* Variable getter symbol for accessor macros */

   118

#define GET_VAR "__GET_VAR"

   119

#define GET_EXTERNAL "__GET_EXTERNAL"

   120

#define GET_LOCATED "__GET_LOCATED"

   121

#define GET_VAR_BY_REF "__GET_VAR_BY_REF"

   122

#define GET_EXTERNAL_BY_REF "__GET_EXTERNAL_BY_REF"

   123

#define GET_LOCATED_BY_REF "__GET_LOCATED_BY_REF"

   124

   125

/* Variable setter symbol for accessor macros */

   126

#define SET_VAR "__SET_VAR"

   127

#define SET_EXTERNAL "__SET_EXTERNAL"

   128

#define SET_LOCATED "__SET_LOCATED"

   129

   130

/* Variable initial value symbol for accessor macros */

   131

#define INITIAL_VALUE "__INITIAL_VALUE"

   132

   133

/* Generate a name for a temporary variable.

   134

 * Each new name generated is appended a different number,

   135

 * starting off from 0.

   136

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

   137

 */

   138

#define VAR_LEADER "__"

   139

#define TEMP_VAR VAR_LEADER "TMP_"

   140

#define SOURCE_VAR VAR_LEADER "SRC_"

   141

   142

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

   143

#define END_LABEL VAR_LEADER "end"

   144

   145

   146

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

   147

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

   148

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

   149

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

   150

   151

#include "generate_c_base.cc"

   152

#include "generate_c_typedecl.cc"

   153

#include "generate_c_sfcdecl.cc"

   154

#include "generate_c_vardecl.cc"

   155

#include "generate_c_configbody.cc"

   156

#include "generate_location_list.cc"

   157

#include "generate_var_list.cc"

   158

   159

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

   160

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

   161

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

   162

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

   163

   164

   165

#include "generate_c.hh"

   166

   167

   168

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

   169

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

   170

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

   171

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

   172

   173

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

   174

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

   175

 * will simply print out the returned data type,

   176

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

   177

 *   for e.g.; 

   178

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

   179

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

   180

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

   181

 */

   182

class print_function_parameter_data_types_c: public generate_c_base_c {

   183

  private:

   184

    symbol_c *current_type;

   185

    bool_type_name_c tmp_bool;

   186

   187

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

   188

      if (data_type != NULL) {

   189

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

   190

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

   191

        if (list == NULL) ERROR;  

   192

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

   193

          s4o.print("__");

   194

          data_type->accept(*this);

   195

        }  

   196

      }

   197

    }

   198

   199

  public:

   200

    print_function_parameter_data_types_c(stage4out_c *s4o_ptr): 

   201

      generate_c_base_c(s4o_ptr)

   202

      {current_type = NULL;}

   203

   204

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

   205

    /* B.1.5 - Program organization units */

   206

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

   207

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

   208

    /* B 1.5.1 - Functions */

   209

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

   210

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

   211

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

   212

    void *visit(function_declaration_c *symbol) {

   213

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

   214

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

   215

      return NULL;

   216

    }

   217

   218

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

   219

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

   220

   221

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

   222

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

   223

   224

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

   225

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

   226

   227

    void *visit(edge_declaration_c *symbol) {

   228

      current_type = &tmp_bool; 

   229

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

   230

      current_type = NULL; 

   231

      return NULL;

   232

    }

   233

   234

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

   235

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

   236

   237

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

   238

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

   242

   243

    void *visit(simple_spec_init_c *symbol) {

   244

      /* return the data type */

   245

      return symbol->simple_specification; 

   246

    }

   247

   248

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

   249

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

   250

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

   251

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

   252

     */

   253

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

   254

   255

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

   256

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

   257

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

   258

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

   259

     */

   260

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

   261

   262

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

   263

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

   264

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

   265

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

   266

     */

   267

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

   268

   269

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

   270

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

   271

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

   272

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

   273

     */

   274

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

   275

   276

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

   277

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

   278

   279

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

   280

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

   281

   282

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

   283

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

   284

   285

    void *visit(fb_name_decl_c *symbol) {

   286

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

   287

      return NULL;

   288

    }

   289

   290

    void *visit(var1_init_decl_c *symbol) {

   291

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

   292

      return NULL;

   293

    }

   294

   295

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

   296

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

   297

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

   298

   299

    void *visit(structured_var_declaration_c *symbol) {

   300

      current_type = symbol->structure_type_name; 

   301

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

   302

      current_type = NULL; 

   303

      return NULL;

   304

    }

   305

   306

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

   307

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

   308

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

   309

     *   STRING [ 42 ]

   310

     */

   311

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

   312

   313

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

   314

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

   315

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

   316

     *   WSTRING [ 42 ]

   317

     */

   318

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

   319

};

   320

   321

   322

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

   323

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

   324

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

   325

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

   326

   327

   328

#include "generate_c_st.cc"

   329

#include "generate_c_il.cc"

   330

#include "generate_c_inlinefcall.cc"

   331

   332

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

   333

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

   334

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

   335

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

   336

   337

#define MILLISECOND 1000000

   338

#define SECOND 1000 * MILLISECOND

   339

   340

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

   341

class calculate_time_c: public iterator_visitor_c {

   342

  private:

   343

    unsigned long long time;

   344

    float current_value;

   345

   346

  public:

   347

    calculate_time_c(void){time = 0;};

   348

   349

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

   350

   351

    void *get_integer_value(token_c *token) {

   352

      std::string str = "";

   353

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

   354

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

   355

          str += token->value[i];

   356

      current_value = atof(str.c_str());

   357

      return NULL;

   358

    }

   359

   360

    void *get_float_value(token_c *token) {

   361

      current_value = atof(token->value);

   362

      return NULL;

   363

    }

   364

   365

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

   366

/* B 1.2.1 - Numeric Literals */

   367

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

   368

   369

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

   370

   371

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

   372

/* B 1.2.3.1 - Duration */

   373

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

   374

   375

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

   376

    void *visit(duration_c *symbol) {

   377

      if (symbol->neg != NULL)

   378

        ERROR;

   379

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

   380

      return NULL;

   381

    }

   382

   383

    /* SYM_TOKEN(fixed_point_c) */

   384

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

   385

   386

    /* SYM_REF2(days_c, days, hours) */

   387

    void *visit(days_c *symbol) {

   388

      if (symbol->hours)

   389

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

   390

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

   391

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

   392

      return NULL;

   393

    }

   394

   395

    /* SYM_REF2(hours_c, hours, minutes) */

   396

    void *visit(hours_c *symbol) {

   397

      if (symbol->minutes)

   398

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

   399

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

   400

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

   401

      return NULL;

   402

    }

   403

   404

    /* SYM_REF2(minutes_c, minutes, seconds) */

   405

    void *visit(minutes_c *symbol) {

   406

      if (symbol->seconds)

   407

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

   408

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

   409

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

   410

      return NULL;

   411

    }

   412

   413

    /* SYM_REF2(seconds_c, seconds, milliseconds) */

   414

    void *visit(seconds_c *symbol) {

   415

      if (symbol->milliseconds)

   416

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

   417

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

   418

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

   419

      return NULL;

   420

    }

   421

   422

    /* SYM_REF2(milliseconds_c, milliseconds, unused) */

   423

    void *visit(milliseconds_c *symbol) {

   424

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

   425

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

   426

      return NULL;

   427

    }

   428

};

   429

   430

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

   431

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

   432

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

   433

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

   434

   435

class calculate_common_ticktime_c: public iterator_visitor_c {

   436

  private:

   437

    unsigned long long common_ticktime;

   438

    unsigned long long least_common_ticktime;

   439

   440

  public:

   441

    calculate_common_ticktime_c(void){

   442

      common_ticktime = 0;

   443

      least_common_ticktime = 0;

   444

    }

   445

   446

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

   447

      unsigned long long c = a % b;

   448

      if (c == 0)

   449

        return b;

   450

      else

   451

        return euclide(b, c);

   452

    }

   453

   454

    void update_ticktime(unsigned long long time) {

   455

      if (common_ticktime == 0)

   456

        common_ticktime = time;

   457

      else if (time > common_ticktime)

   458

        common_ticktime = euclide(time, common_ticktime);

   459

      else

   460

        common_ticktime = euclide(common_ticktime, time);

   461

      if (least_common_ticktime == 0)

   462

        least_common_ticktime = time;

   463

      else

   464

        least_common_ticktime = (least_common_ticktime * time) / common_ticktime;

   465

    }

   466

   467

    unsigned long long get_common_ticktime(void) {

   468

      return common_ticktime;

   469

    }

   470

   471

    unsigned long get_greatest_tick_count(void) {

   472

      unsigned long long least_common_tick = least_common_ticktime / common_ticktime;

   473

      if (least_common_tick >> 32)

   474

        ERROR;

   475

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

   476

    }

   477

   478

/*  TASK task_name task_initialization */

   479

//SYM_REF2(task_configuration_c, task_name, task_initialization)  

   480

    void *visit(task_initialization_c *symbol) {

   481

      calculate_time_c calculate_time;

   482

      unsigned long long time = 0;

   483

      if (symbol->interval_data_source != NULL) {

   484

        symbol->interval_data_source->accept(calculate_time);

   485

        time = calculate_time.get_time();

   486

      }

   487

      if (time > 0)

   488

        update_ticktime(time);

   489

      return NULL;

   490

    }

   491

};    

   492

   493

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

   494

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

   495

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

   496

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

   497

   498

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

   499

class generate_c_SFC_IL_ST_c: public null_visitor_c {

   500

  private:

   501

    stage4out_c *s4o_ptr;

   502

    symbol_c *scope;

   503

    symbol_c *fbname;

   504

    const char *variable_prefix;

   505

   506

  public:

   507

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