1

/* File generated by Beremiz (PlugGenerate_C method of Modbus plugin) */

     2

     3

/*

     4

 * Copyright (c) 2016 Mario de Sousa (msousa@fe.up.pt)

     5

 *

     6

 * This file is part of the Modbus library for Beremiz and matiec.

     7

 *

     8

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

     9

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

    10

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

    11

 * (at your option) any later version.

    12

 *

    13

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

    14

 * WITHOUT ANY WARRANTY; without even the implied warranty of

    15

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 

    16

 * General Public License for more details.

    17

 *

    18

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

    19

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

    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

    26

#include <stdio.h>

    27

#include <string.h>  /* required for memcpy() */

    29

#include <time.h>

    30

#include <signal.h>

    31

#include "mb_slave_and_master.h"

    32

#include "MB_%(locstr)s.h"

    33

    34

    35

#define MAX_MODBUS_ERROR_CODE 11

    36

static const char *modbus_error_messages[MAX_MODBUS_ERROR_CODE+1] = {

    37

    /* 0 */ "",                             /* un-used -> no error! */

    38

    /* 1 */ "illegal/unsuported function",

    39

    /* 2 */ "illegal data address",

    40

    /* 3 */ "illegal data value",

    41

    /* 4 */ "slave device failure",

    42

    /* 5 */ "acknowledge -> slave intends to reply later",

    43

    /* 6 */ "slave device busy",

    44

    /* 7 */ "negative acknowledge",

    45

    /* 8 */ "memory parity error",

    46

    /* 9 */ "",                             /* undefined by Modbus */

    47

    /* 10*/ "gateway path unavalilable",

    48

    /* 11*/ "gateway target device failed to respond"

    49

};    

    50

    51

    52

/* Execute a modbus client transaction/request */

    53

static int __execute_mb_request(int request_id){

    54

	switch (client_requests[request_id].mb_function){

    55

    56

	case  1: /* read coils */

    57

		return read_output_bits(client_requests[request_id].slave_id,

    58

					client_requests[request_id].address,

    59

					client_requests[request_id].count,

    60

					client_requests[request_id].coms_buffer,

    61

					(int) client_requests[request_id].count,

    62

					client_nodes[client_requests[request_id].client_node_id].mb_nd,

    63

					client_requests[request_id].retries,

    64

					&(client_requests[request_id].error_code),

    65

					&(client_requests[request_id].resp_timeout),

    66

					&(client_requests[request_id].coms_buf_mutex));

    67

    68

	case  2: /* read discrete inputs */

    69

		return read_input_bits( client_requests[request_id].slave_id,

    70

					client_requests[request_id].address,

    71

					client_requests[request_id].count,

    72

					client_requests[request_id].coms_buffer,

    73

					(int) client_requests[request_id].count,

    74

					client_nodes[client_requests[request_id].client_node_id].mb_nd,

    75

					client_requests[request_id].retries,

    76

					&(client_requests[request_id].error_code),

    77

					&(client_requests[request_id].resp_timeout),

    78

					&(client_requests[request_id].coms_buf_mutex));

    79

    80

	case  3: /* read holding registers */

    81

		return read_output_words(client_requests[request_id].slave_id,

    82

					client_requests[request_id].address,

    83

					client_requests[request_id].count,

    84

					client_requests[request_id].coms_buffer,

    85

					(int) client_requests[request_id].count,

    86

					client_nodes[client_requests[request_id].client_node_id].mb_nd,

    87

					client_requests[request_id].retries,

    88

					&(client_requests[request_id].error_code),

    89

					&(client_requests[request_id].resp_timeout),

    90

					&(client_requests[request_id].coms_buf_mutex));

    91

    92

	case  4: /* read input registers */

    93

		return read_input_words(client_requests[request_id].slave_id,

    94

					client_requests[request_id].address,

    95

					client_requests[request_id].count,

    96

					client_requests[request_id].coms_buffer,

    97

					(int) client_requests[request_id].count,

    98

					client_nodes[client_requests[request_id].client_node_id].mb_nd,

    99

					client_requests[request_id].retries,

   100

					&(client_requests[request_id].error_code),

   101

					&(client_requests[request_id].resp_timeout),

   102

					&(client_requests[request_id].coms_buf_mutex));

   103

   104

	case  5: /* write single coil */

   105

		return write_output_bit(client_requests[request_id].slave_id,

   106

					client_requests[request_id].address,

   107

					client_requests[request_id].coms_buffer[0],

   108

					client_nodes[client_requests[request_id].client_node_id].mb_nd,

   109

					client_requests[request_id].retries,

   110

					&(client_requests[request_id].error_code),

   111

					&(client_requests[request_id].resp_timeout),

   112

					&(client_requests[request_id].coms_buf_mutex));

   113

   114

	case  6: /* write single register */

   115

		return write_output_word(client_requests[request_id].slave_id,

   116

					client_requests[request_id].address,

   117

					client_requests[request_id].coms_buffer[0],

   118

					client_nodes[client_requests[request_id].client_node_id].mb_nd,

   119

					client_requests[request_id].retries,

   120

					&(client_requests[request_id].error_code),

   121

					&(client_requests[request_id].resp_timeout),

   122

					&(client_requests[request_id].coms_buf_mutex));

   123

   124

	case  7: break; /* function not yet supported */

   125

	case  8: break; /* function not yet supported */

   126

	case  9: break; /* function not yet supported */

   127

	case 10: break; /* function not yet supported */

   128

	case 11: break; /* function not yet supported */

   129

	case 12: break; /* function not yet supported */

   130

	case 13: break; /* function not yet supported */

   131

	case 14: break; /* function not yet supported */

   132

   133

	case 15: /* write multiple coils */

   134

		return write_output_bits(client_requests[request_id].slave_id,

   135

					 client_requests[request_id].address,

   136

					 client_requests[request_id].count,

   137

					 client_requests[request_id].coms_buffer,

   138

					 client_nodes[client_requests[request_id].client_node_id].mb_nd,

   139

					 client_requests[request_id].retries,

   140

					 &(client_requests[request_id].error_code),

   141

					 &(client_requests[request_id].resp_timeout),

   142

					 &(client_requests[request_id].coms_buf_mutex));

   143

   144

	case 16: /* write multiple registers */

   145

		return write_output_words(client_requests[request_id].slave_id,

   146

					client_requests[request_id].address,

   147

					client_requests[request_id].count,

   148

					client_requests[request_id].coms_buffer,

   149

					client_nodes[client_requests[request_id].client_node_id].mb_nd,

   150

					client_requests[request_id].retries,

   151

					&(client_requests[request_id].error_code),

   152

					&(client_requests[request_id].resp_timeout),

   153

					&(client_requests[request_id].coms_buf_mutex));

   154

   155

	default: break;  /* should never occur, if file generation is correct */

   156

	}

   157

   158

	fprintf(stderr, "Modbus plugin: Modbus function %%d not supported\n", request_id); /* should never occur, if file generation is correct */

   159

	return -1;

   160

}

   161

   162

   163

   164

/* pack bits from unpacked_data to packed_data */

   165

static inline int __pack_bits(u16 *unpacked_data, u16 start_addr, u16 bit_count,  u8  *packed_data) {

   166

  u8 bit;

   167

  u16 byte, coils_processed;

   168

   169

  if ((0 == bit_count) || (65535-start_addr < bit_count-1))

   170

    return -ERR_ILLEGAL_DATA_ADDRESS; /* ERR_ILLEGAL_DATA_ADDRESS defined in mb_util.h */

   171

   172

  for( byte = 0, coils_processed = 0; coils_processed < bit_count; byte++) {

   173

    packed_data[byte] = 0;

   174

    for( bit = 0x01; (bit & 0xFF) && (coils_processed < bit_count); bit <<= 1, coils_processed++ ) {

   175

      if(unpacked_data[start_addr + coils_processed])

   176

            packed_data[byte] |=  bit; /*   set bit */

   177

      else  packed_data[byte] &= ~bit; /* reset bit */

   178

    }

   179

  }

   180

  return 0;

   181

}

   182

   183

   184

/* unpack bits from packed_data to unpacked_data */

   185

static inline int __unpack_bits(u16 *unpacked_data, u16 start_addr, u16 bit_count,  u8  *packed_data) {

   186

  u8  temp, bit;

   187

  u16 byte, coils_processed;

   188

   189

  if ((0 == bit_count) || (65535-start_addr < bit_count-1))

   190

    return -ERR_ILLEGAL_DATA_ADDRESS; /* ERR_ILLEGAL_DATA_ADDRESS defined in mb_util.h */

   191

   192

  for(byte = 0, coils_processed = 0; coils_processed < bit_count; byte++) {

   193

    temp = packed_data[byte] ;

   194

    for(bit = 0x01; (bit & 0xff) && (coils_processed < bit_count); bit <<= 1, coils_processed++) {

   195

      unpacked_data[start_addr + coils_processed] = (temp & bit)?1:0;

   196

    }

   197

  }

   198

  return 0;

   199

}

   200

   201

   202

static int __read_inbits   (void *mem_map, u16 start_addr, u16 bit_count, u8  *data_bytes)

   203

  {return   __pack_bits(((server_mem_t *)mem_map)->ro_bits, start_addr, bit_count, data_bytes);}

   204

static int __read_outbits  (void *mem_map, u16 start_addr, u16 bit_count, u8  *data_bytes)

   205

  {return   __pack_bits(((server_mem_t *)mem_map)->rw_bits, start_addr, bit_count, data_bytes);}

   206

static int __write_outbits (void *mem_map, u16 start_addr, u16 bit_count, u8  *data_bytes)

   207

  {return __unpack_bits(((server_mem_t *)mem_map)->rw_bits, start_addr, bit_count, data_bytes); }

   208

   209

   210

   211

static int __read_inwords  (void *mem_map, u16 start_addr, u16 word_count, u16 *data_words) {

   212

   213

  if ((start_addr + word_count) > MEM_AREA_SIZE)

   214

    return -ERR_ILLEGAL_DATA_ADDRESS; /* ERR_ILLEGAL_DATA_ADDRESS defined in mb_util.h */

   215

   216

  /* use memcpy() because loop with pointers (u16 *) caused alignment problems */

   217

  memcpy(/* dest */ (void *)data_words,

   218

         /* src  */ (void *)&(((server_mem_t *)mem_map)->ro_words[start_addr]),

   219

         /* size */ word_count * 2);

   220

  return 0;

   221

}

   222

   223

   224

   225

static int __read_outwords (void *mem_map, u16 start_addr, u16 word_count, u16 *data_words) {

   226

   227

  if ((start_addr + word_count) > MEM_AREA_SIZE)

   228

    return -ERR_ILLEGAL_DATA_ADDRESS; /* ERR_ILLEGAL_DATA_ADDRESS defined in mb_util.h */

   229

   230

  /* use memcpy() because loop with pointers (u16 *) caused alignment problems */

   231

  memcpy(/* dest */ (void *)data_words,

   232

         /* src  */ (void *)&(((server_mem_t *)mem_map)->rw_words[start_addr]),

   233

         /* size */ word_count * 2);

   234

  return 0;

   235

}

   236

   237

   238

   239

   240

static int __write_outwords(void *mem_map, u16 start_addr, u16 word_count, u16 *data_words) {

   241

   242

  if ((start_addr + word_count) > MEM_AREA_SIZE)

   243

    return -ERR_ILLEGAL_DATA_ADDRESS; /* ERR_ILLEGAL_DATA_ADDRESS defined in mb_util.h */

   244

   245

  /* WARNING: The data returned in the data_words[] array is not guaranteed to be 16 bit aligned.

   246

   *           It is not therefore safe to cast it to an u16 data type.

   247

   *           The following code cannot be used. memcpy() is used instead.

   248

   */

   249

  /*

   250

  for (count = 0; count < word_count ; count++)

   251

    ((server_mem_t *)mem_map)->rw_words[count + start_addr] = data_words[count];

   252

  */

   253

  memcpy(/* dest */ (void *)&(((server_mem_t *)mem_map)->rw_words[start_addr]),

   254

         /* src  */ (void *)data_words,

   255

         /* size */ word_count * 2);

   256

  return 0;

   257

}

   258

   259

   260

   261

   262

#include <pthread.h>

   263

   264

static void *__mb_server_thread(void *_server_node)  {

   265

	server_node_t *server_node = _server_node;

   266

	mb_slave_callback_t callbacks = { 

   267

			&__read_inbits,

   268

			&__read_outbits,

   269

			&__write_outbits,

   270

			&__read_inwords,

   271

			&__read_outwords,

   272

			&__write_outwords,

   273

			(void *)&(server_node->mem_area)

   274

			};  

   275

   276

	// Enable thread cancelation. Enabled is default, but set it anyway to be safe.

   277

	pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL);

   278

   279

	// mb_slave_run() should never return!

   280

	mb_slave_run(server_node->mb_nd /* nd */, callbacks, server_node->slave_id);

   281

	fprintf(stderr, "Modbus plugin: Modbus server for node %%s died unexpectedly!\n", server_node->location); /* should never occur */

   282

	return NULL;

   283

}

   284

   285

   286

#define timespec_add(ts, sec, nsec) {		\

   287

	ts.tv_sec  +=  sec;			\

   288

	ts.tv_nsec += nsec;			\

   289

	if (ts.tv_nsec >= 1000000000) {		\

   290

		ts.tv_sec  ++;			\

   291

		ts.tv_nsec -= 1000000000;	\

   292

	}					\

   293

}

   294

   295

   296

static void *__mb_client_thread(void *_index)  {

   297

	int client_node_id = (char *)_index - (char *)NULL; // Use pointer arithmetic (more portable than cast)

   298

	struct timespec next_cycle;

   299

	int period_sec  =  client_nodes[client_node_id].comm_period / 1000;          /* comm_period is in ms */

   300

	int period_nsec = (client_nodes[client_node_id].comm_period %%1000)*1000000; /* comm_period is in ms */

   301

   302

	// Enable thread cancelation. Enabled is default, but set it anyway to be safe.

   303

	pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL);

   304

   305

	// configure the timer for periodic activation

   306

    {

   307

      struct itimerspec timerspec;

   308

      timerspec.it_interval.tv_sec  = period_sec;

   309

      timerspec.it_interval.tv_nsec = period_nsec;

   310

      timerspec.it_value            = timerspec.it_interval;

   311

   312

      if (timer_settime(client_nodes[client_node_id].timer_id, 0 /* flags */, &timerspec, NULL) < 0)

   313

        fprintf(stderr, "Modbus plugin: Error configuring periodic activation timer for Modbus client %%s.\n", client_nodes[client_node_id].location);          

   314

    }

   315

   316

    /* loop the communication with the client

   317

     * 

   318

         * When the client thread has difficulty communicating with remote client and/or server (network issues, for example),

   319

         * then the communications get delayed and we will fall behind in the period. 

   320

         * 

   321

         * This is OK. Note that if the condition variable were to be signaled multiple times while the client thread is inside the same

   322

         * Modbus transaction, then all those signals would be ignored.

   323

         * However, and since we keep the mutex locked during the communication cycle, it is not possible to signal the condition variable

   324

         * during that time (it is only possible while the thread is blocked during the call to pthread_cond_wait().

   325

         * 

   326

         * This means that when network issues eventually get resolved, we will NOT have a bunch of delayed activations to handle

   327

         * in quick succession (which would goble up CPU time). 

   328

         * 

   329

         * Notice that the above property is valid whether the communication cycle is run with the mutex locked, or unlocked.

   330

         * Since it makes it easier to implement the correct semantics for the other activation methods if the communication cycle

   331

         * is run with the mutex locked, then that is what we do.

   332

         * 

   333

     * Note that during all the communication cycle we will keep locked the mutex 

   334

     * (i.e. the mutex used together with the condition variable that will activate a new communication cycle)

   335

     * 

   336

     * Note that we never get to explicitly unlock this mutex. It will only be unlocked by the pthread_cond_wait()

   337

     * call at the end of the cycle.

   338

     */

   339

    pthread_mutex_lock(&(client_nodes[client_node_id].mutex));

   340

   341

	while (1) {

   342

		/*

   343

		struct timespec cur_time;

   344

		clock_gettime(CLOCK_MONOTONIC, &cur_time);

   345

		fprintf(stderr, "Modbus client thread - new cycle (%%ld:%%ld)!\n", cur_time.tv_sec, cur_time.tv_nsec);

   346

		*/

   347

		int req;

   348

		for (req=0; req < NUMBER_OF_CLIENT_REQTS; req ++){

   349

			/* just do the requests belonging to the client */

   350

			if (client_requests[req].client_node_id != client_node_id)

   351

				continue;

   352

   353

            /* only do the request if:

   354

             *   - this request was explictly asked to be executed by the client program

   355

             *  OR

   356

             *   - the client thread was activated periodically

   357

             *     (in which case we execute all the requests belonging to the client node)

   358

             */

   359

            if ((client_requests[req].flag_exec_req == 0) && (client_nodes[client_requests[req].client_node_id].periodic_act == 0))

   360

                continue;

   361

   362

            //fprintf(stderr, "Modbus plugin: RUNNING<###> of Modbus request %%d  (periodic = %%d  flag_exec_req = %%d)\n", 

   363

            //        req, client_nodes[client_requests[req].client_node_id].periodic_act, client_requests[req].flag_exec_req );

   364

   365

			int res_tmp = __execute_mb_request(req);

   366

			switch (res_tmp) {

   367

			  case PORT_FAILURE: {

   368

				if (res_tmp != client_nodes[client_node_id].prev_error)

   369

					fprintf(stderr, "Modbus plugin: Error connecting Modbus client %%s to remote server.\n", client_nodes[client_node_id].location);

   370

				client_nodes[client_node_id].prev_error = res_tmp;

   371

				break;

   372

			  }

   373

			  case INVALID_FRAME: {

   374

				if ((res_tmp != client_requests[req].prev_error) && (0 == client_nodes[client_node_id].prev_error))

   375

					fprintf(stderr, "Modbus plugin: Modbus client request configured at location %%s was unsuccesful. Server/slave returned an invalid/corrupted frame.\n", client_requests[req].location);

   376

				client_requests[req].prev_error = res_tmp;

   377

				break;

   378

			  }

   379

			  case TIMEOUT: {

   380

				if ((res_tmp != client_requests[req].prev_error) && (0 == client_nodes[client_node_id].prev_error))

   381

					fprintf(stderr, "Modbus plugin: Modbus client request configured at location %%s timed out waiting for reply from server.\n", client_requests[req].location);

   382

				client_requests[req].prev_error = res_tmp;

   383

				break;

   384

			  }

   385

			  case MODBUS_ERROR: {

   386

				if (client_requests[req].prev_error != client_requests[req].error_code) {

   387

					fprintf(stderr, "Modbus plugin: Modbus client request configured at location %%s was unsuccesful. Server/slave returned error code 0x%%2x", client_requests[req].location, client_requests[req].error_code);

   388

					if (client_requests[req].error_code <= MAX_MODBUS_ERROR_CODE ) {

   389

						fprintf(stderr, "(%%s)", modbus_error_messages[client_requests[req].error_code]);

   390

						fprintf(stderr, ".\n");

   391

					}

   392

				}

   393

				client_requests[req].prev_error = client_requests[req].error_code;

   394

				break;

   395

			  }

   396

			  default: {

   397

				if ((res_tmp >= 0) && (client_nodes[client_node_id].prev_error != 0)) {

   398

					fprintf(stderr, "Modbus plugin: Modbus client %%s has reconnected to server/slave.\n", client_nodes[client_node_id].location);

   399

				}

   400

				if ((res_tmp >= 0) && (client_requests[req]        .prev_error != 0)) {

   401

					fprintf(stderr, "Modbus plugin: Modbus client request configured at location %%s has succesfully resumed comunication.\n", client_requests[req].location);

   402

				}

   403

				client_nodes[client_node_id].prev_error = 0;

   404

				client_requests[req]        .prev_error = 0;

   405

				break;

   406

			  }

   407

			}

   408

   409

            /* We have just finished excuting a client transcation request.

   410

             * If the current cycle was activated by user request we reset the flag used to ask to run it

   411

             */

   412

            if (0 != client_requests[req].flag_exec_req) {

   413

                client_requests[req].flag_exec_req     = 0;

   414

                client_requests[req].flag_exec_started = 0;   

   415

            }

   416

   417

            //fprintf(stderr, "Modbus plugin: RUNNING<---> of Modbus request %%d  (periodic = %%d  flag_exec_req = %%d)\n", 

   418

            //        req, client_nodes[client_requests[req].client_node_id].periodic_act, client_requests[req].flag_exec_req );

   419

        }

   420

   421

        // Wait for signal (from timer or explicit request from user program) before starting the next cycle

   422

        {

   423

            // No need to lock the mutex. Is is already locked just before the while(1) loop.

   424

            // Read the comment there to understand why.

   425

            // pthread_mutex_lock(&(client_nodes[client_node_id].mutex));

   426

   427

            /* the client thread has just finished a cycle, so all the flags used to signal an activation

   428

             * and specify the activation source (periodic, user request, ...)

   429

             * get reset here, before waiting for a new activation.

   430

             */

   431

            client_nodes[client_node_id].periodic_act = 0;            

   432

            client_nodes[client_node_id].execute_req  = 0;

   433

   434

            while (client_nodes[client_node_id].execute_req == 0)

   435

                pthread_cond_wait(&(client_nodes[client_node_id].condv),

   436

                                &(client_nodes[client_node_id].mutex)); 

   437

   438

            // We run the communication cycle with the mutex locked.

   439

            // Read the comment just above the while(1) to understand why.

   440

            // pthread_mutex_unlock(&(client_nodes[client_node_id].mutex));

   441

        }

   442

	}

   443

   444

	// humour the compiler.

   445

	return NULL;

   446

}

   447

   448

   449

   450

/* Function to activate a client node's thread */

   451

/* returns -1 if it could not send the signal */

   452

static int __signal_client_thread(int client_node_id) {

   453

    /* We TRY to signal the client thread.

   454

     * We do this because this function can be called at the end of the PLC scan cycle

   455

     * and we don't want it to block at that time.

   456

     */

   457

    if (pthread_mutex_trylock(&(client_nodes[client_node_id].mutex)) != 0)

   458

        return -1;

   459

    client_nodes[client_node_id].execute_req = 1; // tell the thread to execute

   460

    pthread_cond_signal (&(client_nodes[client_node_id].condv));

   461

    pthread_mutex_unlock(&(client_nodes[client_node_id].mutex));

   462

    return 0;

   463

}

   464

   465

   466

   467

/* Function that will be called whenever a client node's periodic timer expires. */

   468

/* The client node's thread will be waiting on a condition variable, so this function simply signals that 

   469

 * condition variable.

   470

 * 

   471

 * The same callback function is called by the timers of all client nodes. The id of the client node

   472

 * in question will be passed as a parameter to the call back function.

   473

 */

   475

    /* signal the client node's condition variable on which the client node's thread should be waiting... */

   476

    /* Since the communication cycle is run with the mutex locked, we use trylock() instead of lock() */

   478

        /* we never get to signal the thread for activation. But that is OK.

   479

         * If it still in the communication cycle (during which the mutex is kept locked)

   480

         * then that means that the communication cycle is falling behing in the periodic 

   481

         * communication cycle, and we therefore need to skip a period.

   482

         */

   483

        return;