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 <strings.h>

    31

    32

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

    33

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

    34

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

    35

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

    36

    37

#include "../stage4.hh"

    38

    39

//#define DEBUG

    40

#ifdef DEBUG

    41

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

    42

#else

    43

#define TRACE(classname)

    44

#endif

    45

    46

#define ERROR error_exit(__FILE__,__LINE__)

    47

/* function defined in main.cc */

    48

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

    49

    50

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

    51

    52

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

    53

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

    54

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

    55

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

    56

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

    57

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

    58

 * default variable.

    59

 *

    60

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

    61

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

    62

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

    63

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

    64

 * constant.

    65

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

    66

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

    67

 * in IL and ST.

    68

 *

    69

 * e.g.:  FUNTION_BLOCK TEST

    70

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

    71

 */

    72

    73

#define FB_FUNCTION_SUFFIX "_body__"

    74

    75

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

    76

#define FB_INIT_SUFFIX "_init__"

    77

    78

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

    79

#define FB_RUN_SUFFIX "_run__"

    80

    81

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

    82

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

    83

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

    84

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

    85

 * in IL and ST.

    86

 *

    87

 * e.g.: the body of FUNTION_BLOCK TEST

    88

 * is mapped onto the C function

    89

 *  TEST_body__(TEST *data__)

    90

 */

    91

    92

#define FB_FUNCTION_PARAM "data__"

    93

    94

    95

#define SFC_STEP_ACTION_PREFIX "__SFC_"

    96

    97

    98

/* Variable declaration symbol for accessor macros */

    99

#define DECLARE_VAR "__DECLARE_VAR"

   100

#define DECLARE_GLOBAL "__DECLARE_GLOBAL"

   101

#define DECLARE_GLOBAL_LOCATION "__DECLARE_GLOBAL_LOCATION"

   102

#define DECLARE_GLOBAL_LOCATED "__DECLARE_GLOBAL_LOCATED"

   103

#define DECLARE_EXTERNAL "__DECLARE_EXTERNAL"

   104

#define DECLARE_LOCATED "__DECLARE_LOCATED"

   105

   106

/* Variable declaration symbol for accessor macros */

   107

#define INIT_VAR "__INIT_VAR"

   108

#define INIT_GLOBAL "__INIT_GLOBAL"

   109

#define INIT_GLOBAL_LOCATED "__INIT_GLOBAL_LOCATED"

   110

#define INIT_EXTERNAL "__INIT_EXTERNAL"

   111

#define INIT_LOCATED "__INIT_LOCATED"

   112

#define INIT_LOCATED_VALUE "__INIT_LOCATED_VALUE"

   113

   114

   115

/* Variable getter symbol for accessor macros */

   116

#define GET_VAR "__GET_VAR"

   117

#define GET_EXTERNAL "__GET_EXTERNAL"

   118

#define GET_LOCATED "__GET_LOCATED"

   119

#define GET_VAR_BY_REF "__GET_VAR_BY_REF"

   120

#define GET_EXTERNAL_BY_REF "__GET_EXTERNAL_BY_REF"

   121

#define GET_LOCATED_BY_REF "__GET_LOCATED_BY_REF"

   122

   123

/* Variable setter symbol for accessor macros */

   124

#define SET_VAR "__SET_VAR"

   125

#define SET_EXTERNAL "__SET_EXTERNAL"

   126

#define SET_COMPLEX_EXTERNAL "__SET_COMPLEX_EXTERNAL"

   127

#define SET_LOCATED "__SET_LOCATED"

   128

   129

   130

/* Generate a name for a temporary variable.

   131

 * Each new name generated is appended a different number,

   132

 * starting off from 0.

   133

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

   134

 */

   135

#define VAR_LEADER "__"

   136

#define TEMP_VAR VAR_LEADER "TMP_"

   137

#define SOURCE_VAR VAR_LEADER "SRC_"

   138

   139

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

   140

#define END_LABEL VAR_LEADER "end"

   141

   142

   143

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

   144

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

   145

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

   146

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

   147

   148

#include "generate_c_base.cc"

   149

#include "generate_c_typedecl.cc"

   150

#include "generate_c_sfcdecl.cc"

   151

#include "generate_c_vardecl.cc"

   152

#include "generate_c_configbody.cc"

   153

#include "generate_location_list.cc"

   154

#include "generate_var_list.cc"

   155

   156

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

   157

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

   158

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

   159

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

   160

   161

   162

#include "generate_c.hh"

   163

   164

   165

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

   166

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

   167

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

   168

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

   169

   170

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

   171

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

   172

 * will simply print out the returned data type,

   173

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

   174

 *   for e.g.; 

   175

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

   176

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

   177

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

   178

 */

   179

class print_function_parameter_data_types_c: public generate_c_base_c {

   180

  private:

   181

    symbol_c *current_type;

   182

    bool_type_name_c tmp_bool;

   183

   184

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

   185

      if (data_type != NULL) {

   186

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

   187

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

   188

        if (list == NULL) ERROR;  

   189

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

   190

          s4o.print("__");

   191

          data_type->accept(*this);

   192

        }  

   193

      }

   194

    }

   195

   196

  public:

   197

    print_function_parameter_data_types_c(stage4out_c *s4o_ptr): 

   198

      generate_c_base_c(s4o_ptr)

   199

      {current_type = NULL;}

   200

   201

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

   202

    /* B.1.5 - Program organization units */

   203

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

   204

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

   205

    /* B 1.5.1 - Functions */

   206

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

   207

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

   208

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

   209

    void *visit(function_declaration_c *symbol) {

   210

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

   211

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

   212

      return NULL;

   213

    }

   214

   215

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

   216

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

   217

   218

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

   219

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

   223

   224

    void *visit(edge_declaration_c *symbol) {

   225

      current_type = &tmp_bool; 

   226

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

   227

      current_type = NULL; 

   228

      return NULL;

   229

    }

   230

   231

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

   232

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

   233

   234

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

   235

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

   236

   237

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

   238

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

   239

   240

    void *visit(simple_spec_init_c *symbol) {

   241

      /* return the data type */

   242

      return symbol->simple_specification; 

   243

    }

   244

   245

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

   246

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

   247

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

   248

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

   249

     */

   250

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

   251

   252

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

   253

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

   254

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

   255

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

   256

     */

   257

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

   258

   259

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

   260

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

   261

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

   262

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

   263

     */

   264

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

   265

   266

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

   267

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

   268

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

   269

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

   270

     */

   271

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

   272

   273

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

   274

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

   275

   276

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

   277

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

   278

   279

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

   280

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

   281

   282

    void *visit(fb_name_decl_c *symbol) {

   283

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

   284

      return NULL;

   285

    }

   286

   287

    void *visit(var1_init_decl_c *symbol) {

   288

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

   289

      return NULL;

   290

    }

   291

   292

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

   293

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

   294

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

   295

   296

    void *visit(structured_var_declaration_c *symbol) {

   297

      current_type = symbol->structure_type_name; 

   298

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

   299

      current_type = NULL; 

   300

      return NULL;

   301

    }

   302

   303

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

   304

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

   305

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

   306

     *   STRING [ 42 ]

   307

     */

   308

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

   309

   310

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

   311

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

   312

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

   313

     *   WSTRING [ 42 ]

   314

     */

   315

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

   316

};

   317

   318

   319

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

   320

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

   321

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

   322

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

   323

   324

   325

#include "generate_c_st.cc"

   326

#include "generate_c_il.cc"

   327

#include "generate_c_inlinefcall.cc"

   328

   329

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

   330

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

   331

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

   332

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

   333

   334

#define MILLISECOND 1000000

   335

#define SECOND 1000 * MILLISECOND

   336

   337

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

   338

class calculate_time_c: public iterator_visitor_c {

   339

  private:

   340

    unsigned long long time;

   341

    float current_value;

   342

   343

  public:

   344

    calculate_time_c(void){time = 0;};

   345

   346

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

   347

   348

    void *get_integer_value(token_c *token) {

   349

      std::string str = "";

   350

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

   351

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

   352

          str += token->value[i];

   353

      current_value = atof(str.c_str());

   354

      return NULL;

   355

    }

   356

   357

    void *get_float_value(token_c *token) {

   358

      current_value = atof(token->value);

   359

      return NULL;

   360

    }

   361

   362

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

   363

/* B 1.2.1 - Numeric Literals */

   364

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

   365

   366

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

   367

   368

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

   369

/* B 1.2.3.1 - Duration */

   370

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

   371

   372

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

   373

    void *visit(duration_c *symbol) {

   374

      if (symbol->neg != NULL)

   375

        ERROR;

   376

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

   377

      return NULL;

   378

    }

   379

   380

    /* SYM_TOKEN(fixed_point_c) */

   381

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

   382

   383

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

   384

    void *visit(days_c *symbol) {

   385

      if (symbol->hours)

   386

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

   387

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

   388

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

   389

      return NULL;

   390

    }

   391

   392

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

   393

    void *visit(hours_c *symbol) {

   394

      if (symbol->minutes)

   395

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

   396

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

   397

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

   398

      return NULL;

   399

    }

   400

   401

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

   402

    void *visit(minutes_c *symbol) {

   403

      if (symbol->seconds)

   404

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

   405

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

   406

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

   407

      return NULL;

   408

    }

   409

   410

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

   411

    void *visit(seconds_c *symbol) {

   412

      if (symbol->milliseconds)

   413

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

   414

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

   415

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

   416

      return NULL;

   417

    }

   418

   419

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

   420

    void *visit(milliseconds_c *symbol) {

   421

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

   422

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

   423

      return NULL;

   424

    }

   425

};

   426

   427

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

   428

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

   429

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

   430

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

   431

   432

class calculate_common_ticktime_c: public iterator_visitor_c {

   433

  private:

   434

    unsigned long long common_ticktime;

   435

    unsigned long long least_common_ticktime;

   436

   437

  public:

   438

    calculate_common_ticktime_c(void){

   439

      common_ticktime = 0;

   440

      least_common_ticktime = 0;

   441

    }

   442

   443

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

   444

      unsigned long long c = a % b;

   445

      if (c == 0)

   446

        return b;

   447

      else

   448

        return euclide(b, c);

   449

    }

   450

   451

    void update_ticktime(unsigned long long time) {

   452

      if (common_ticktime == 0)

   453

        common_ticktime = time;

   454

      else if (time > common_ticktime)

   455

        common_ticktime = euclide(time, common_ticktime);

   456

      else

   457

        common_ticktime = euclide(common_ticktime, time);

   458

      if (least_common_ticktime == 0)

   459

        least_common_ticktime = time;

   460

      else

   461

        least_common_ticktime = (least_common_ticktime * time) / common_ticktime;

   462

    }

   463

   464

    unsigned long long get_common_ticktime(void) {

   465

      return common_ticktime;

   466

    }

   467

   468

    unsigned long get_greatest_tick_count(void) {

   469

      unsigned long long least_common_tick = least_common_ticktime / common_ticktime;

   470

      if (least_common_tick >> 32)

   471

        ERROR;

   472

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

   473

    }

   474

   475

/*  TASK task_name task_initialization */

   476

//SYM_REF2(task_configuration_c, task_name, task_initialization)  

   477

    void *visit(task_initialization_c *symbol) {

   478

      calculate_time_c calculate_time;

   479

      unsigned long long time = 0;

   480

      if (symbol->interval_data_source != NULL) {

   481

        symbol->interval_data_source->accept(calculate_time);

   482

        time = calculate_time.get_time();

   483

      }

   484

      if (time > 0)

   485

        update_ticktime(time);

   486

      return NULL;

   487

    }

   488

};    

   489

   490

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

   491

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

   492

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

   493

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

   494

   495

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

   496

class generate_c_SFC_IL_ST_c: public null_visitor_c {

   497

  private:

   498

    stage4out_c *s4o_ptr;

   499

    symbol_c *scope;

   500

    symbol_c *fbname;

   501

    const char *variable_prefix;

   502

   503

  public:

   504

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

   505

   506

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

   507

    /* 2.1.6 - Pragmas  */