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)

     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

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

   140

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

   141

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

   142

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

   143

   144

#include "generate_c_base.cc"

   145

#include "generate_c_typedecl.cc"

   146

#include "generate_c_sfcdecl.cc"

   147

#include "generate_c_vardecl.cc"

   148

#include "generate_c_configbody.cc"

   149

#include "generate_location_list.cc"

   150

#include "generate_var_list.cc"

   151

   152

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

   153

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

   154

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

   155

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

   156

   157

#include "generate_c_st.cc"

   158

#include "generate_c_il.cc"

   159

#include "generate_c_inlinefcall.cc"

   160

   161

#include "generate_c.hh"

   162

   163

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

   164

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

   165

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

   166

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

   167

   168

#define MILLISECOND 1000000

   169

#define SECOND 1000 * MILLISECOND

   170

   171

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

   172

class calculate_time_c: public iterator_visitor_c {

   173

  private:

   174

    unsigned long long time;

   175

    float current_value;

   176

   177

  public:

   178

    calculate_time_c(void){time = 0;};

   179

   180

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

   181

   182

    void *get_integer_value(token_c *token) {

   183

      std::string str = "";

   184

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

   185

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

   186

          str += token->value[i];

   187

      current_value = atof(str.c_str());

   188

      return NULL;

   189

    }

   190

   191

    void *get_float_value(token_c *token) {

   192

      current_value = atof(token->value);

   193

      return NULL;

   194

    }

   195

   196

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

   197

/* B 1.2.1 - Numeric Literals */

   198

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

   199

   200

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

   201

   202

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

   203

/* B 1.2.3.1 - Duration */

   204

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

   205

   206

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

   207

    void *visit(duration_c *symbol) {

   208

      if (symbol->neg != NULL)

   209

        ERROR;

   210

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

   211

      return NULL;

   212

    }

   213

   214

    /* SYM_TOKEN(fixed_point_c) */

   215

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

   216

   217

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

   218

    void *visit(days_c *symbol) {

   219

      if (symbol->hours)

   220

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

   221

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

   222

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

   223

      return NULL;

   224

    }

   225

   226

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

   227

    void *visit(hours_c *symbol) {

   228

      if (symbol->minutes)

   229

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

   230

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

   231

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

   232

      return NULL;

   233

    }

   234

   235

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

   236

    void *visit(minutes_c *symbol) {

   237

      if (symbol->seconds)

   238

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

   239

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

   240

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

   241

      return NULL;

   242

    }

   243

   244

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

   245

    void *visit(seconds_c *symbol) {

   246

      if (symbol->milliseconds)

   247

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

   248

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

   249

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

   250

      return NULL;

   251

    }

   252

   253

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

   254

    void *visit(milliseconds_c *symbol) {

   255

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

   256

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

   257

      return NULL;

   258

    }

   259

};

   260

   261

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

   262

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

   263

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

   264

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

   265

   266

class calculate_common_ticktime_c: public iterator_visitor_c {

   267

  private:

   268

    unsigned long long common_ticktime;

   269

    unsigned long long least_common_ticktime;

   270

   271

  public:

   272

    calculate_common_ticktime_c(void){

   273

      common_ticktime = 0;

   274

      least_common_ticktime = 0;

   275

    }

   276

   277

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

   278

      unsigned long long c = a % b;

   279

      if (c == 0)

   280

        return b;

   281

      else

   282

        return euclide(b, c);

   283

    }

   284

   285

    void update_ticktime(unsigned long long time) {

   286

      if (common_ticktime == 0)

   287

        common_ticktime = time;

   288

      else if (time > common_ticktime)

   289

        common_ticktime = euclide(time, common_ticktime);

   290

      else

   291

        common_ticktime = euclide(common_ticktime, time);

   292

      if (least_common_ticktime == 0)

   293

        least_common_ticktime = time;

   294

      else

   295

        least_common_ticktime = (least_common_ticktime * time) / common_ticktime;

   296

    }

   297

   298

    unsigned long long get_common_ticktime(void) {

   299

      return common_ticktime;

   300

    }

   301

   302

    unsigned long get_greatest_tick_count(void) {

   303

      unsigned long long least_common_tick = least_common_ticktime / common_ticktime;

   304

      if (least_common_tick >> 32)

   305

        ERROR;

   306

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

   307

    }

   308

   309

/*  TASK task_name task_initialization */

   310

//SYM_REF2(task_configuration_c, task_name, task_initialization)  

   311

    void *visit(task_initialization_c *symbol) {

   312

      calculate_time_c calculate_time;

   313

      unsigned long long time = 0;

   314

      if (symbol->interval_data_source != NULL) {

   315

        symbol->interval_data_source->accept(calculate_time);

   316

        time = calculate_time.get_time();

   317

      }

   318

      if (time > 0)

   319

        update_ticktime(time);

   320

      return NULL;

   321

    }

   322

};    

   323

   324

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

   325

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

   326

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

   327

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

   328

   329

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

   330

class generate_c_SFC_IL_ST_c: public null_visitor_c {

   331

  private:

   332

    stage4out_c *s4o_ptr;

   333

    symbol_c *scope;

   334

    symbol_c *fbname;

   335

    const char *variable_prefix;

   336

   337

  public:

   338

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

   339

   340

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

   341

    /* 2.1.6 - Pragmas  */

   342

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

   343

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

   344

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

   345

   346

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

   347

    /* B.1.6  Sequential function chart elements */

   348

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

   349

    /*| sequential_function_chart sfc_network*/

   350

    void *visit(sequential_function_chart_c * symbol);

   351

   352

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

   353

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

   354

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

   355

   356

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

   357

    /* B 2.1 Instructions and Operands */

   358

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

   359

    /*| instruction_list il_instruction */

   360

    void *visit(instruction_list_c *symbol);

   361

   362

    /* Remainder implemented in generate_c_il_c... */

   363

   364

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

   365

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

   366

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

   367

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

   368

    /* B 3.1 - Expressions */

   369

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

   370

    /* Implemented in generate_c_st_c */

   371

   372

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

   373

    /* B 3.2 Statements */

   374

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

   375

    void *visit(statement_list_c *symbol);

   376

   377

/* Remainder implemented in generate_c_st_c... */

   378

};

   379

   380

#include "generate_c_sfc.cc"

   381

   382

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) {

   383

  if (NULL == scope) ERROR;

   384

  this->s4o_ptr = s4o_ptr;

   385

  this->scope = scope;

   386

  this->fbname = name;

   387

  this->variable_prefix = variable_prefix;

   388

}

   389

   390

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

   391

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

   392

  generate_c_sfc.generate(symbol);

   393

  return NULL;

   394

}

   395

   396

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

   397

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

   398

  generate_c_il.generate(symbol);

   399

  return NULL;

   400

}

   401

   402

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

   403

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

   404

  generate_c_st.generate(symbol);

   405

  return NULL;

   406

}

   407

   408

   409

   410

   411

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

   412

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

   413

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

   414

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

   415

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

   416

   417

   418

class generate_c_pous_c: public generate_c_typedecl_c {

   419

  private:

   420

    stage4out_c *s4o_ptr;

   421

   422

  public:

   423

    generate_c_pous_c(stage4out_c *s4o_ptr, stage4out_c *s4o_incl_ptr)

   424

      : generate_c_typedecl_c(s4o_ptr, s4o_incl_ptr) {

   425

      generate_c_pous_c::s4o_ptr = s4o_ptr;

   426

    };

   427

    virtual ~generate_c_pous_c(void) {}

   428

   429

   430

  public:

   431

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

   432

/* 2.1.6 - Pragmas  */

   433

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

   434

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

   435

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

   436

   437

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

   438

/* B.1 - Common elements */

   439

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

   440

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

   441

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

   442

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

   443

  /* done in base class(es) */

   444

   445

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

   446

/* B 1.2 - Constants */

   447

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

   448

  /* originally empty... */

   449

   450

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

   451

/* B 1.2.1 - Numeric Literals */

   452

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

   453

  /* done in base class(es) */

   454

   455

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

   456

/* B.1.2.2   Character Strings */

   457

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

   458

  /* done in base class(es) */

   459

   460

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

   461

/* B 1.2.3 - Time Literals */

   462

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

   463

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

   464

/* B 1.2.3.1 - Duration */

   465

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

   466

  /* done in base class(es) */

   467

   468

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

   469

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

   470

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

   471

  /* done in base class(es) */

   472

   473

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

   474

/* B.1.3 - Data types */

   475

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

   476

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

   477

/* B 1.3.1 - Elementary Data Types */

   478

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

   479

  /* done in base class(es) */

   480

   481

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

   482

/* B.1.3.2 - Generic data types */

   483

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

   484

  /* originally empty... */

   485

   486

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

   487

/* B 1.3.3 - Derived data types */

   488

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

   489

  /* done in base class(es) */

   490

   491

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

   492

/* B 1.4 - Variables */

   493

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

   494

  /* done in base class(es) */

   495

   496

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

   497

/* B.1.4.1   Directly Represented Variables */

   498

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

   499

  /* done in base class(es) */

   500

   501

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

   502

/* B.1.4.2   Multi-element Variables */

   503

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

   504

  /* done in base class(es) */

   505

   506

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

   507

/* B 1.4.3 - Declaration & Initialisation */

   508

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

   509

  /* done in base class(es) */

   510

   511

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

   512

/* B.1.5 - Program organization units */

   513

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

   514

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

   515

/* B 1.5.1 - Functions */

   516

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