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

   108

/* Variable declaration symbol for accessor macros */

   109

#define INIT_VAR "__INIT_VAR"

   110

#define INIT_GLOBAL "__INIT_GLOBAL"

   111

#define INIT_GLOBAL_LOCATED "__INIT_GLOBAL_LOCATED"

   112

#define INIT_EXTERNAL "__INIT_EXTERNAL"

   113

#define INIT_LOCATED "__INIT_LOCATED"

   114

#define INIT_LOCATED_VALUE "__INIT_LOCATED_VALUE"

   115

   116

/* Variable getter symbol for accessor macros */

   117

#define GET_VAR "__GET_VAR"

   118

#define GET_EXTERNAL "__GET_EXTERNAL"

   119

#define GET_LOCATED "__GET_LOCATED"

   120

#define GET_VAR_BY_REF "__GET_VAR_BY_REF"

   121

#define GET_EXTERNAL_BY_REF "__GET_EXTERNAL_BY_REF"

   122

#define GET_LOCATED_BY_REF "__GET_LOCATED_BY_REF"

   123

   124

/* Variable setter symbol for accessor macros */

   125

#define SET_VAR "__SET_VAR"

   126

#define SET_EXTERNAL "__SET_EXTERNAL"

   127

#define SET_COMPLEX_EXTERNAL "__SET_COMPLEX_EXTERNAL"

   128

#define SET_LOCATED "__SET_LOCATED"

   129

   130

   131

/* Generate a name for a temporary variable.

   132

 * Each new name generated is appended a different number,

   133

 * starting off from 0.

   134

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

   135

 */

   136

#define VAR_LEADER "__"

   137

#define TEMP_VAR VAR_LEADER "TMP_"

   138

#define SOURCE_VAR VAR_LEADER "SRC_"

   139

   140

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

   141

#define END_LABEL VAR_LEADER "end"

   142

   143

   144

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

   145

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

   146

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

   147

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

   148

   149

#include "generate_c_base.cc"

   150

#include "generate_c_typedecl.cc"

   151

#include "generate_c_sfcdecl.cc"

   152

#include "generate_c_vardecl.cc"

   153

#include "generate_c_configbody.cc"

   154

#include "generate_location_list.cc"

   155

#include "generate_var_list.cc"

   156

   157

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

   158

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

   159

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

   160

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

   161

   162

   163

#include "generate_c.hh"

   164

   165

   166

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

   167

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

   168

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

   169

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

   170

   171

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

   172

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

   173

 * will simply print out the returned data type,

   174

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

   175

 *   for e.g.; 

   176

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

   177

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

   178

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

   179

 */

   180

class print_function_parameter_data_types_c: public generate_c_base_c {

   181

  private:

   182

    symbol_c *current_type;

   183

    bool_type_name_c tmp_bool;

   184

   185

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

   186

      if (data_type != NULL) {

   187

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

   188

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

   189

        if (list == NULL) ERROR;  

   190

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

   191

          s4o.print("__");

   192

          data_type->accept(*this);

   193

        }  

   194

      }

   195

    }

   196

   197

  public:

   198

    print_function_parameter_data_types_c(stage4out_c *s4o_ptr): 

   199

      generate_c_base_c(s4o_ptr)

   200

      {current_type = NULL;}

   201

   202

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

   203

    /* B.1.5 - Program organization units */

   204

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

   205

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

   206

    /* B 1.5.1 - Functions */

   207

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

   208

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

   209

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

   210

    void *visit(function_declaration_c *symbol) {

   211

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

   212

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

   213

      return NULL;

   214

    }

   215

   216

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

   217

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

   218

   219

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

   220

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

   221

   222

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

   223

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

   224

   225

    void *visit(edge_declaration_c *symbol) {

   226

      current_type = &tmp_bool; 

   227

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

   228

      current_type = NULL; 

   229

      return NULL;

   230

    }

   231

   232

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

   233

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

   234

   235

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

   236

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

   237

   238

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

   239

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

   240

   241

    void *visit(simple_spec_init_c *symbol) {

   242

      /* return the data type */

   243

      return symbol->simple_specification; 

   244

    }

   245

   246

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

   247

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

   248

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

   249

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

   250

     */

   251

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

   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_enumerated_type_name

   256

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

   257

     */

   258

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

   263

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

   264

     */

   265

    void *visit(array_var_init_decl_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_structured_type_name

   270

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

   271

     */

   272

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

   273

   274

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

   275

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

   276

   277

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

   278

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

   279

   280

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

   281

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

   282

   283

    void *visit(fb_name_decl_c *symbol) {

   284

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

   285

      return NULL;

   286

    }

   287

   288

    void *visit(var1_init_decl_c *symbol) {

   289

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

   290

      return NULL;

   291

    }

   292

   293

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

   294

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

   295

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

   296

   297

    void *visit(structured_var_declaration_c *symbol) {

   298

      current_type = symbol->structure_type_name; 

   299

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

   300

      current_type = NULL; 

   301

      return NULL;

   302

    }

   303

   304

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

   305

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

   306

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

   307

     *   STRING [ 42 ]

   308

     */

   309

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

   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

     *   WSTRING [ 42 ]

   315

     */

   316

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

   317

};

   318

   319

   320

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

   321

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

   322

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

   323

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

   324

   325

   326

#include "generate_c_st.cc"

   327

#include "generate_c_il.cc"

   328

#include "generate_c_inlinefcall.cc"

   329

   330

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

   331

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

   332

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

   333

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

   334

   335

#define MILLISECOND 1000000

   336

#define SECOND 1000 * MILLISECOND

   337

   338

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

   339

class calculate_time_c: public iterator_visitor_c {

   340

  private:

   341

    unsigned long long time;

   342

    float current_value;

   343

   344

  public:

   345

    calculate_time_c(void){time = 0;};

   346

   347

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

   348

   349

    void *get_integer_value(token_c *token) {

   350

      std::string str = "";

   351

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

   352

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

   353

          str += token->value[i];

   354

      current_value = atof(str.c_str());

   355

      return NULL;

   356

    }

   357

   358

    void *get_float_value(token_c *token) {

   359

      current_value = atof(token->value);

   360

      return NULL;

   361

    }

   362

   363

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

   364

/* B 1.2.1 - Numeric Literals */

   365

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

   366

   367

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

   368

   369

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

   370

/* B 1.2.3.1 - Duration */

   371

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

   372

   373

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

   374

    void *visit(duration_c *symbol) {

   375

      if (symbol->neg != NULL)

   376

        ERROR;

   377

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

   378

      return NULL;

   379

    }

   380

   381

    /* SYM_TOKEN(fixed_point_c) */

   382

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

   383

   384

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

   385

    void *visit(days_c *symbol) {

   386

      if (symbol->hours)

   387

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

   388

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

   389

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

   390

      return NULL;

   391

    }

   392

   393

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

   394

    void *visit(hours_c *symbol) {

   395

      if (symbol->minutes)

   396

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

   397

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

   398

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

   399

      return NULL;

   400

    }

   401

   402

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

   403

    void *visit(minutes_c *symbol) {

   404

      if (symbol->seconds)

   405

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

   406

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

   407

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

   408

      return NULL;

   409

    }

   410

   411

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

   412

    void *visit(seconds_c *symbol) {

   413

      if (symbol->milliseconds)

   414

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

   415

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

   416

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

   417

      return NULL;

   418

    }

   419

   420

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

   421

    void *visit(milliseconds_c *symbol) {

   422

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

   423

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

   424

      return NULL;

   425

    }

   426

};

   427

   428

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

   429

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

   430

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

   431

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

   432

   433

class calculate_common_ticktime_c: public iterator_visitor_c {

   434

  private:

   435

    unsigned long long common_ticktime;

   436

    unsigned long long least_common_ticktime;

   437

   438

  public:

   439

    calculate_common_ticktime_c(void){

   440

      common_ticktime = 0;

   441

      least_common_ticktime = 0;

   442

    }

   443

   444

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

   445

      unsigned long long c = a % b;

   446

      if (c == 0)

   447

        return b;

   448

      else

   449

        return euclide(b, c);

   450

    }

   451

   452

    void update_ticktime(unsigned long long time) {

   453

      if (common_ticktime == 0)

   454

        common_ticktime = time;

   455

      else if (time > common_ticktime)

   456

        common_ticktime = euclide(time, common_ticktime);

   457

      else

   458

        common_ticktime = euclide(common_ticktime, time);

   459

      if (least_common_ticktime == 0)

   460

        least_common_ticktime = time;

   461

      else

   462

        least_common_ticktime = (least_common_ticktime * time) / common_ticktime;

   463

    }

   464

   465

    unsigned long long get_common_ticktime(void) {

   466

      return common_ticktime;

   467

    }

   468

   469

    unsigned long get_greatest_tick_count(void) {

   470

      unsigned long long least_common_tick = least_common_ticktime / common_ticktime;

   471

      if (least_common_tick >> 32)

   472

        ERROR;

   473

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

   474

    }

   475

   476

/*  TASK task_name task_initialization */

   477

//SYM_REF2(task_configuration_c, task_name, task_initialization)  

   478

    void *visit(task_initialization_c *symbol) {

   479

      calculate_time_c calculate_time;

   480

      unsigned long long time = 0;

   481

      if (symbol->interval_data_source != NULL) {

   482

        symbol->interval_data_source->accept(calculate_time);

   483

        time = calculate_time.get_time();

   484

      }

   485

      if (time > 0)

   486

        update_ticktime(time);

   487

      return NULL;

   488

    }

   489

};    

   490

   491

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

   492

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

   493

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

   494

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

   495

   496

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

   497

class generate_c_SFC_IL_ST_c: public null_visitor_c {

   498

  private:

   499

    stage4out_c *s4o_ptr;

   500

    symbol_c *scope;

   501

    symbol_c *fbname;

   502

    const char *variable_prefix;

   503

   504

  public:

   505

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

   506

   507

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