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

 *

     6

 *  This program is free software: you can redistribute it and/or modify

     7

 *  it under the terms of the GNU General Public License as published by

     8

 *  the Free Software Foundation, either version 3 of the License, or

     9

 *  (at your option) any later version.

    10

 *

    11

 *  This program is distributed in the hope that it will be useful,

    12

 *  but WITHOUT ANY WARRANTY; without even the implied warranty of

    13

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    14

 *  GNU General Public License for more details.

    15

 *

    16

 *  You should have received a copy of the GNU General Public License

    17

 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.

    18

 *

    19

 *

    20

 * This code is made available on the understanding that it will not be

    21

 * used in safety-critical situations without a full and competent review.

    22

 */

    23

    24

/*

    25

 * An IEC 61131-3 compiler.

    26

 *

    27

 * Based on the

    28

 * FINAL DRAFT - IEC 61131-3, 2nd Ed. (2001-12-10)

    29

 *

    30

 */

    31

    32

    33

/*

    34

 * This is one of the versions available for the 4th stage.

    35

 *

    36

 * This 4th stage generates a c++ source program equivalent

    37

 * to the IL and ST code.

    38

 */

    39

    40

    41

    42

    43

    44

    45

// #include <stdio.h>  /* required for NULL */

    46

#include <string>

    47

#include <iostream>

    48

#include <sstream>

    49

#include <typeinfo>

    50

#include <list>

    51

#include <strings.h>

    52

    53

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

    54

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

    55

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

    56

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

    57

    58

#include "../stage4.hh"

    59

    60

    61

    62

    63

    64

    65

    66

//#define DEBUG

    67

#ifdef DEBUG

    68

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

    69

#else

    70

#define TRACE(classname)

    71

#endif

    72

    73

    74

    75

#define ERROR error_exit(__FILE__,__LINE__)

    76

/* function defined in main.cc */

    77

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

    78

    79

    80

    81

    82

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

    83

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

    84

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

    85

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

    86

    87

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

    88

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

    89

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

    90

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

    91

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

    92

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

    93

 * default variable.

    94

 *

    95

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

    96

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

    97

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

    98

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

    99

 * constant.

   100

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

   101

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

   102

 * in IL and ST.

   103

 *

   104

 * e.g.:  FUNTION_BLOCK TEST

   105

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

   106

 */

   107

   108

#define FB_FUNCTION_SUFFIX "_body__"

   109

   110

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

   111

#define FB_INIT_SUFFIX "_init__"

   112

   113

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

   114

#define FB_RUN_SUFFIX "_run__"

   115

   116

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

   117

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

   118

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

   119

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

   120

 * in IL and ST.

   121

 *

   122

 * e.g.: the body of FUNTION_BLOCK TEST

   123

 * is mapped onto the C function

   124

 *  TEST_body__(TEST *data__)

   125

 */

   126

   127

#define FB_FUNCTION_PARAM "data__"

   128

   129

   130

#define SFC_STEP_ACTION_PREFIX "__SFC_"

   131

   132

   133

/* Variable declaration symbol for accessor macros */

   134

#define DECLARE_VAR "__DECLARE_VAR"

   135

#define DECLARE_GLOBAL "__DECLARE_GLOBAL"

   136

#define DECLARE_GLOBAL_LOCATION "__DECLARE_GLOBAL_LOCATION"

   137

#define DECLARE_GLOBAL_LOCATED "__DECLARE_GLOBAL_LOCATED"

   138

#define DECLARE_EXTERNAL "__DECLARE_EXTERNAL"

   139

#define DECLARE_LOCATED "__DECLARE_LOCATED"

   140

   141

/* Variable declaration symbol for accessor macros */

   142

#define INIT_VAR "__INIT_VAR"

   143

#define INIT_GLOBAL "__INIT_GLOBAL"

   144

#define INIT_GLOBAL_LOCATED "__INIT_GLOBAL_LOCATED"

   145

#define INIT_EXTERNAL "__INIT_EXTERNAL"

   146

#define INIT_LOCATED "__INIT_LOCATED"

   147

#define INIT_LOCATED_VALUE "__INIT_LOCATED_VALUE"

   148

   149

   150

/* Variable getter symbol for accessor macros */

   151

#define GET_VAR "__GET_VAR"

   152

#define GET_EXTERNAL "__GET_EXTERNAL"

   153

#define GET_LOCATED "__GET_LOCATED"

   154

#define GET_VAR_BY_REF "__GET_VAR_BY_REF"

   155

#define GET_EXTERNAL_BY_REF "__GET_EXTERNAL_BY_REF"

   156

#define GET_LOCATED_BY_REF "__GET_LOCATED_BY_REF"

   157

   158

/* Variable setter symbol for accessor macros */

   159

#define SET_VAR "__SET_VAR"

   160

#define SET_EXTERNAL "__SET_EXTERNAL"

   161

#define SET_COMPLEX_EXTERNAL "__SET_COMPLEX_EXTERNAL"

   162

#define SET_LOCATED "__SET_LOCATED"

   163

   164

   165

/* Generate a name for a temporary variable.

   166

 * Each new name generated is appended a different number,

   167

 * starting off from 0.

   168

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

   169

 */

   170

#define VAR_LEADER "__"

   171

#define TEMP_VAR VAR_LEADER "TMP_"

   172

#define SOURCE_VAR VAR_LEADER "SRC_"

   173

   174

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

   175

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

   176

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

   177

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

   178

   179

#include "generate_c_base.cc"

   180

#include "generate_c_typedecl.cc"

   181

#include "generate_c_sfcdecl.cc"

   182

#include "generate_c_vardecl.cc"

   183

#include "generate_c_configbody.cc"

   184

#include "generate_location_list.cc"

   185

#include "generate_var_list.cc"

   186

   187

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

   188

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

   189

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

   190

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

   191

   192

#include "generate_c_st.cc"

   193

#include "generate_c_il.cc"

   194

#include "generate_c_inlinefcall.cc"

   195

   196

#include "generate_c.hh"

   197

   198

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

   199

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

   200

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

   201

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

   202

   203

#define MILLISECOND 1000000

   204

#define SECOND 1000 * MILLISECOND

   205

   206

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

   207

class calculate_time_c: public iterator_visitor_c {

   208

  private:

   209

    unsigned long long time;

   210

    float current_value;

   211

   212

  public:

   213

    calculate_time_c(void){time = 0;};

   214

   215

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

   216

   217

    void *get_integer_value(token_c *token) {

   218

      std::string str = "";

   219

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

   220

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

   221

          str += token->value[i];

   222

      current_value = atof(str.c_str());

   223

      return NULL;

   224

    }

   225

   226

    void *get_float_value(token_c *token) {

   227

      current_value = atof(token->value);

   228

      return NULL;

   229

    }

   230

   231

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

   232

/* B 1.2.1 - Numeric Literals */

   233

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

   234

   235

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

   236

   237

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

   238

/* B 1.2.3.1 - Duration */

   239

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

   240

   241

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

   242

    void *visit(duration_c *symbol) {

   243

      if (symbol->neg != NULL)

   244

        ERROR;

   245

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

   246

      return NULL;

   247

    }

   248

   249

    /* SYM_TOKEN(fixed_point_c) */

   250

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

   251

   252

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

   253

    void *visit(days_c *symbol) {

   254

      if (symbol->hours)

   255

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

   256

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

   257

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

   258

      return NULL;

   259

    }

   260

   261

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

   262

    void *visit(hours_c *symbol) {

   263

      if (symbol->minutes)

   264

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

   265

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

   266

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

   267

      return NULL;

   268

    }

   269

   270

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

   271

    void *visit(minutes_c *symbol) {

   272

      if (symbol->seconds)

   273

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

   274

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

   275

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

   276

      return NULL;

   277

    }

   278

   279

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

   280

    void *visit(seconds_c *symbol) {

   281

      if (symbol->milliseconds)

   282

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

   283

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

   284

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

   285

      return NULL;

   286

    }

   287

   288

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

   289

    void *visit(milliseconds_c *symbol) {

   290

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

   291

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

   292

      return NULL;

   293

    }

   294

};

   295

   296

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

   297

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

   298

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

   299

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

   300

   301

class calculate_common_ticktime_c: public iterator_visitor_c {

   302

  private:

   303

    unsigned long long common_ticktime;

   304

    unsigned long long least_common_ticktime;

   305

   306

  public:

   307

    calculate_common_ticktime_c(void){

   308

      common_ticktime = 0;

   309

      least_common_ticktime = 0;

   310

    }

   311

   312

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

   313

      unsigned long long c = a % b;

   314

      if (c == 0)

   315

        return b;

   316

      else

   317

        return euclide(b, c);

   318

    }

   319

   320

    void update_ticktime(unsigned long long time) {

   321

      if (common_ticktime == 0)

   322

        common_ticktime = time;

   323

      else if (time > common_ticktime)

   324

        common_ticktime = euclide(time, common_ticktime);

   325

      else

   326

        common_ticktime = euclide(common_ticktime, time);

   327

      if (least_common_ticktime == 0)

   328

        least_common_ticktime = time;

   329

      else

   330

        least_common_ticktime = (least_common_ticktime * time) / common_ticktime;

   331

    }

   332

   333

    unsigned long long get_common_ticktime(void) {

   334

      return common_ticktime;

   335

    }

   336

   337

    unsigned long get_greatest_tick_count(void) {

   338

      unsigned long long least_common_tick = least_common_ticktime / common_ticktime;

   339

      if (least_common_tick >> 32)

   340

        ERROR;

   341

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

   342

    }

   343

   344

/*  TASK task_name task_initialization */

   345

//SYM_REF2(task_configuration_c, task_name, task_initialization)  

   346

    void *visit(task_initialization_c *symbol) {

   347

      calculate_time_c calculate_time;

   348

      unsigned long long time = 0;

   349

      if (symbol->interval_data_source != NULL) {

   350

        symbol->interval_data_source->accept(calculate_time);

   351

        time = calculate_time.get_time();

   352

      }

   353

      if (time > 0)

   354

        update_ticktime(time);

   355

      return NULL;

   356

    }

   357

};    

   358

   359

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

   360

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

   361

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

   362

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

   363

   364

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

   365

class generate_c_SFC_IL_ST_c: public null_visitor_c {

   366

  private:

   367

    stage4out_c *s4o_ptr;

   368

    symbol_c *scope;

   369

    symbol_c *fbname;

   370

    const char *variable_prefix;

   371

   372

  public:

   373

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

   374

   375

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

   376

    /* 2.1.6 - Pragmas  */

   377

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

   378

    void *visit(enable_code_generation_pragma_c * symbol)   {s4o_ptr->enable_output();  return NULL;}

   379

    void *visit(disable_code_generation_pragma_c * symbol)  {s4o_ptr->disable_output(); return NULL;} 

   380

   381

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

   382

    /* B.1.6  Sequential function chart elements */

   383

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

   384

    /*| sequential_function_chart sfc_network*/

   385

    void *visit(sequential_function_chart_c * symbol);

   386

   387

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

   388

    /* B.2 - Language IL (Instruction List) */

   389

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

   390

   391

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

   392

    /* B 2.1 Instructions and Operands */

   393

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

   394

    /*| instruction_list il_instruction */

   395

    void *visit(instruction_list_c *symbol);

   396

   397

    /* Remainder implemented in generate_c_il_c... */

   398

   399

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

   400

    /* B.3 - Language ST (Structured Text) */

   401

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

   402

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

   403

    /* B 3.1 - Expressions */

   404

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

   405

    /* Implemented in generate_c_st_c */

   406

   407

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

   408

    /* B 3.2 Statements */

   409

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

   410

    void *visit(statement_list_c *symbol);

   411

   412

/* Remainder implemented in generate_c_st_c... */

   413

};

   414

   415

#include "generate_c_sfc.cc"

   416

   417

generate_c_SFC_IL_ST_c::generate_c_SFC_IL_ST_c(stage4out_c *s4o_ptr, symbol_c *name, symbol_c *scope, const char *variable_prefix) {

   418

  if (NULL == scope) ERROR;

   419

  this->s4o_ptr = s4o_ptr;

   420

  this->scope = scope;

   421

  this->fbname = name;

   422

  this->variable_prefix = variable_prefix;

   423

}

   424

   425

void *generate_c_SFC_IL_ST_c::visit(sequential_function_chart_c * symbol) {

   426

  generate_c_sfc_c generate_c_sfc(s4o_ptr, fbname, scope, variable_prefix);

   427

  generate_c_sfc.generate(symbol);

   428

  return NULL;

   429

}

   430

   431

void *generate_c_SFC_IL_ST_c::visit(instruction_list_c *symbol) {

   432

  generate_c_il_c generate_c_il(s4o_ptr, fbname, scope, variable_prefix);

   433

  generate_c_il.generate(symbol);

   434

  return NULL;

   435

}

   436

   437

void *generate_c_SFC_IL_ST_c::visit(statement_list_c *symbol) {

   438

  generate_c_st_c generate_c_st(s4o_ptr, fbname, scope, variable_prefix);

   439

  generate_c_st.generate(symbol);

   440

  return NULL;

   441

}

   442

   443

   444

   445

   446

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

   447

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

   448

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

   449

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

   450

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

   451

   452

   453

class generate_c_pous_c: public generate_c_typedecl_c {

   454

  private:

   455

    stage4out_c *s4o_ptr;

   456

   457

  public:

   458

    generate_c_pous_c(stage4out_c *s4o_ptr, stage4out_c *s4o_incl_ptr)

   459

      : generate_c_typedecl_c(s4o_ptr, s4o_incl_ptr) {

   460

      generate_c_pous_c::s4o_ptr = s4o_ptr;

   461

    };

   462

    virtual ~generate_c_pous_c(void) {}

   463

   464

   465

  public:

   466

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

   467

/* 2.1.6 - Pragmas  */

   468

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

   469

void *visit(enable_code_generation_pragma_c * symbol)   {s4o_ptr->enable_output();  return NULL;}

   470

void *visit(disable_code_generation_pragma_c * symbol)  {s4o_ptr->disable_output(); return NULL;} 

   471

   472

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

   473

/* B.1 - Common elements */

   474

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

   475

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

   476

/* B 1.1 - Letters, digits and identifiers */

   477

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

   478

  /* done in base class(es) */

   479

   480

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

   481

/* B 1.2 - Constants */

   482

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

   483

  /* originally empty... */

   484

   485

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

   486

/* B 1.2.1 - Numeric Literals */

   487

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

   488

  /* done in base class(es) */

   489

   490

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

   491

/* B.1.2.2   Character Strings */

   492

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

   493

  /* done in base class(es) */

   494

   495

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

   496

/* B 1.2.3 - Time Literals */

   497

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

   498

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

   499

/* B 1.2.3.1 - Duration */

   500

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

   501

  /* done in base class(es) */

   502

   503

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

   504

/* B 1.2.3.2 - Time of day and Date */

   505

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

   506

  /* done in base class(es) */

   507

   508

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

   509

/* B.1.3 - Data types */

   510

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

   511

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

   512

/* B 1.3.1 - Elementary Data Types */

   513

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

   514

  /* done in base class(es) */

   515

   516

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