src/Network/generic.cxx

   1 // generic.cxx -- generic protocal class
   2 //
   3 // Written by Curtis Olson, started November 1999.
   4 //
   5 // Copyright (C) 1999  Curtis L. Olson - http://www.flightgear.org/~curt
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // 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, write to the Free Software
  19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20 //
  21 // $Id$
  22
  23 #ifdef HAVE_CONFIG_H
  24 #  include "config.h"
  25 #endif
  26
  27 #include <string.h>                // strstr()
  28 #include <stdlib.h>                // strtod(), atoi()
  29
  30 #include <simgear/debug/logstream.hxx>
  31 #include <simgear/io/iochannel.hxx>
  32 #include <simgear/structure/exception.hxx>
  33 #include <simgear/misc/sg_path.hxx>
  34 #include <simgear/misc/stdint.hxx>
  35 #include <simgear/props/props.hxx>
  36 #include <simgear/props/props_io.hxx>
  37
  38 #include <Main/globals.hxx>
  39 #include <Main/fg_props.hxx>
  40 #include <Main/util.hxx>
  41
  42 #include "generic.hxx"
  43
  44
  45
  46 FGGeneric::FGGeneric(vector<string> tokens) : exitOnError(false)
  47 {
  48     size_t configToken;
  49     if (tokens[1] == "socket") {
  50         configToken = 7;
  51     } else if (tokens[1] == "file") {
  52         configToken = 5;
  53     } else {
  54         configToken = 6;
  55     }
  56
  57     if (configToken >= tokens.size()) {
  58        SG_LOG(SG_GENERAL, SG_ALERT,
  59               "Not enough tokens passed for generic protocol");
  60        return;
  61     }
  62
  63     string config = tokens[ configToken ];
  64     string file = config+".xml";
  65
  66     SGPath path( globals->get_fg_root() );
  67     path.append("Protocol");
  68     path.append(file.c_str());
  69     SG_LOG(SG_GENERAL, SG_INFO, "Reading communication protocol from "
  70                                 << path.str());
  71
  72     SGPropertyNode root;
  73     try {
  74         readProperties(path.str(), &root);
  75     } catch (const sg_exception &) {
  76         SG_LOG(SG_GENERAL, SG_ALERT,
  77          "Unable to load the protocol configuration file");
  78          return;
  79     }
  80
  81     if (tokens[2] == "out") {
  82         SGPropertyNode *output = root.getNode("generic/output");
  83         if (output) {
  84             read_config(output, _out_message);
  85         }
  86     } else if (tokens[2] == "in") {
  87         SGPropertyNode *input = root.getNode("generic/input");
  88         if (input) {
  89             read_config(input, _in_message);
  90         }
  91     } else {
  92         SG_LOG(SG_GENERAL, SG_ALERT, "Unsuported protocol direction: "
  93                << tokens[2]);
  94     }
  95 }
  96
  97 FGGeneric::~FGGeneric() {
  98 }
  99
 100
 101 // generate the message
 102 bool FGGeneric::gen_message_binary() {
 103     string generic_sentence;
 104     length = 0;
 105
 106     double val;
 107     for (unsigned int i = 0; i < _out_message.size(); i++) {
 108
 109         switch (_out_message[i].type) {
 110         case FG_INT:
 111             val = _out_message[i].offset +
 112                   _out_message[i].prop->getIntValue() * _out_message[i].factor;
 113
 114             if (binary_byte_order == BYTE_ORDER_MATCHES_NETWORK_ORDER) {
 115                 *((int32_t*)&buf[length]) = (int32_t)val;
 116             } else {
 117                 *((uint32_t*)&buf[length]) = sg_bswap_32((uint32_t)val);
 118             }
 119             length += sizeof(int32_t);
 120             break;
 121
 122         case FG_BOOL:
 123             *((int8_t*)&buf[length])
 124                       = _out_message[i].prop->getBoolValue() ? true : false;
 125             length += 1;
 126             break;
 127
 128         case FG_FIXED:
 129         {
 130             val = _out_message[i].offset +
 131                  _out_message[i].prop->getFloatValue() * _out_message[i].factor;
 132
 133             int fixed = (int)(val * 65536.0f);
 134             if (binary_byte_order == BYTE_ORDER_MATCHES_NETWORK_ORDER) {
 135                 *((int32_t*)&buf[length]) = (int32_t)fixed;
 136             } else {
 137                 *((uint32_t*)&buf[length]) = sg_bswap_32((uint32_t)val);
 138             }
 139             length += sizeof(int32_t);
 140             break;
 141         }
 142         case FG_FLOAT:
 143             val = _out_message[i].offset +
 144                  _out_message[i].prop->getFloatValue() * _out_message[i].factor;
 145
 146             if (binary_byte_order == BYTE_ORDER_MATCHES_NETWORK_ORDER) {
 147                 *((float*)&buf[length]) = val;
 148             } else {
 149                 *((float*)&buf[length]) = sg_bswap_32(*(uint32_t*)&val);
 150             }
 151             length += sizeof(int32_t);
 152             break;
 153
 154         case FG_DOUBLE:
 155             val = _out_message[i].offset +
 156                  _out_message[i].prop->getFloatValue() * _out_message[i].factor;
 157
 158             if (binary_byte_order == BYTE_ORDER_MATCHES_NETWORK_ORDER) {
 159                 *((double*)&buf[length]) = val;
 160             } else {
 161                 *((double*)&buf[length]) = sg_bswap_64(*(uint64_t*)&val);
 162             }
 163             length += sizeof(int64_t);
 164             break;
 165
 166         default: // SG_STRING
 167             const char *strdata = _out_message[i].prop->getStringValue();
 168             int strlength = strlen(strdata);
 169
 170             if (binary_byte_order == BYTE_ORDER_NEEDS_CONVERSION) {
 171                 SG_LOG( SG_IO, SG_ALERT, "Generic protocol: "
 172                         "FG_STRING will be written in host byte order.");
 173             }
 174             /* Format for strings is
 175              * [length as int, 4 bytes][ASCII data, length bytes]
 176              */
 177             if (binary_byte_order == BYTE_ORDER_MATCHES_NETWORK_ORDER) {
 178                 *((int32_t*)&buf[length]) = strlength;
 179             } else {
 180                 *((int32_t*)&buf[length]) = sg_bswap_32(strlength);
 181             }
 182             length += sizeof(int32_t);
 183             strncpy(&buf[length], strdata, strlength);
 184             length += strlength;
 185             /* FIXME padding for alignment? Something like:
 186              * length += (strlength % 4 > 0 ? sizeof(int32_t) - strlength % 4 : 0;
 187              */
 188         }
 189     }
 190
 191     // add the footer to the packet ("line")
 192     switch (binary_footer_type) {
 193         case FOOTER_LENGTH:
 194             binary_footer_value = length;
 195             break;
 196
 197         case FOOTER_MAGIC:
 198             break;
 199     }
 200
 201     if (binary_footer_type != FOOTER_NONE) {
 202         if (binary_byte_order == BYTE_ORDER_MATCHES_NETWORK_ORDER) {
 203             *((int32_t*)&buf[length]) = binary_footer_value;
 204         } else {
 205             *((int32_t*)&buf[length]) = sg_bswap_32(binary_footer_value);
 206         }
 207         length += sizeof(int32_t);
 208     }
 209
 210     return true;
 211 }
 212
 213 bool FGGeneric::gen_message_ascii() {
 214     string generic_sentence;
 215     char tmp[255];
 216     length = 0;
 217
 218     double val;
 219     for (unsigned int i = 0; i < _out_message.size(); i++) {
 220
 221         if (i > 0) {
 222             generic_sentence += var_separator;
 223         }
 224
 225         switch (_out_message[i].type) {
 226         case FG_INT:
 227             val = _out_message[i].offset +
 228                   _out_message[i].prop->getIntValue() * _out_message[i].factor;
 229             snprintf(tmp, 255, _out_message[i].format.c_str(), (int)val);
 230             break;
 231
 232         case FG_BOOL:
 233             snprintf(tmp, 255, _out_message[i].format.c_str(),
 234                                _out_message[i].prop->getBoolValue());
 235             break;
 236
 237         case FG_FIXED:
 238             val = _out_message[i].offset +
 239                 _out_message[i].prop->getFloatValue() * _out_message[i].factor;
 240             snprintf(tmp, 255, _out_message[i].format.c_str(), (float)val);
 241             break;
 242
 243         case FG_FLOAT:
 244             val = _out_message[i].offset +
 245                 _out_message[i].prop->getFloatValue() * _out_message[i].factor;
 246             snprintf(tmp, 255, _out_message[i].format.c_str(), (float)val);
 247             break;
 248
 249         case FG_DOUBLE:
 250             val = _out_message[i].offset +
 251                 _out_message[i].prop->getFloatValue() * _out_message[i].factor;
 252             snprintf(tmp, 255, _out_message[i].format.c_str(), (float)val);
 253             break;
 254
 255         default: // SG_STRING
 256             snprintf(tmp, 255, _out_message[i].format.c_str(),
 257                                    _out_message[i].prop->getStringValue());
 258         }
 259
 260         generic_sentence += tmp;
 261     }
 262
 263     /* After each lot of variables has been added, put the line separator
 264      * char/string
 265      */
 266     generic_sentence += line_separator;
 267
 268     length =  generic_sentence.length();
 269     strncpy( buf, generic_sentence.c_str(), length );
 270
 271     return true;
 272 }
 273
 274 bool FGGeneric::gen_message() {
 275     if (binary_mode) {
 276         return gen_message_binary();
 277     } else {
 278         return gen_message_ascii();
 279     }
 280 }
 281
 282 bool FGGeneric::parse_message_binary() {
 283     char *p2, *p1 = buf;
 284     int32_t tmp32;
 285     int64_t tmp64;
 286     double val;
 287     int i = -1;
 288
 289     p2 = p1 + FG_MAX_MSG_SIZE;
 290     while ((++i < (int)_in_message.size()) && (p1  < p2)) {
 291
 292         switch (_in_message[i].type) {
 293         case FG_INT:
 294             if (binary_byte_order == BYTE_ORDER_NEEDS_CONVERSION) {
 295                 tmp32 = sg_bswap_32(*(int32_t *)p1);
 296             } else {
 297                 tmp32 = *(int32_t *)p1;
 298             }
 299
 300             val = _in_message[i].offset + (double)tmp32 * _in_message[i].factor;
 301
 302             _in_message[i].prop->setIntValue((int)val);
 303             p1 += sizeof(int32_t);
 304             break;
 305
 306         case FG_BOOL:
 307             _in_message[i].prop->setBoolValue( p1[0] != 0 );
 308             p1 += 1;
 309             break;
 310
 311         case FG_FIXED:
 312             if (binary_byte_order == BYTE_ORDER_NEEDS_CONVERSION) {
 313                 tmp32 = sg_bswap_32(*(int32_t *)p1);
 314             } else {
 315                 tmp32 = *(int32_t *)p1;
 316             }
 317
 318             val = _in_message[i].offset +
 319                   ((double)tmp32 / 65536.0f) * _in_message[i].factor;
 320
 321             _in_message[i].prop->setFloatValue(val);
 322             p1 += sizeof(int32_t);
 323             break;
 324
 325         case FG_FLOAT:
 326             if (binary_byte_order == BYTE_ORDER_NEEDS_CONVERSION) {
 327                 tmp32 = sg_bswap_32(*(int32_t *)p1);
 328             } else {
 329                 tmp32 = *(int32_t *)p1;
 330             }
 331
 332             val = _in_message[i].offset +
 333                   *(float *)&tmp32 * _in_message[i].factor;
 334
 335             _in_message[i].prop->setFloatValue(val);
 336             p1 += sizeof(int32_t);
 337             break;
 338
 339         case FG_DOUBLE:
 340             if (binary_byte_order == BYTE_ORDER_NEEDS_CONVERSION) {
 341                 tmp64 = sg_bswap_64(*(int64_t *)p1);
 342             } else {
 343                 tmp64 = *(int64_t *)p1;
 344             }
 345
 346             val = _in_message[i].offset +
 347                    *(double *)&tmp64 * _in_message[i].factor;
 348
 349             _in_message[i].prop->setDoubleValue(val);
 350             p1 += sizeof(int64_t);
 351             break;
 352
 353         default: // SG_STRING
 354             SG_LOG( SG_IO, SG_ALERT, "Generic protocol: "
 355                     "Ignoring unsupported binary input chunk type.");
 356         }
 357     }
 358
 359     return true;
 360 }
 361
 362 bool FGGeneric::parse_message_ascii() {
 363     char *p2, *p1 = buf;
 364     double val;
 365     int i = -1;
 366
 367     while ((++i < (int)_in_message.size()) &&
 368            p1 && strcmp(p1, line_separator.c_str())) {
 369
 370         p2 = strstr(p1, var_separator.c_str());
 371         if (p2) {
 372             *p2 = 0;
 373             p2 += var_separator.length();
 374         }
 375
 376         switch (_in_message[i].type) {
 377         case FG_INT:
 378             val = _in_message[i].offset + atoi(p1) * _in_message[i].factor;
 379             _in_message[i].prop->setIntValue((int)val);
 380             break;
 381
 382         case FG_BOOL:
 383             _in_message[i].prop->setBoolValue( atof(p1) != 0.0 );
 384             break;
 385
 386         case FG_FIXED:
 387         case FG_DOUBLE:
 388             val = _in_message[i].offset + strtod(p1, 0) * _in_message[i].factor;
 389             _in_message[i].prop->setFloatValue((float)val);
 390             break;
 391
 392         default: // SG_STRING
 393             _in_message[i].prop->setStringValue(p1);
 394         }
 395
 396         p1 = p2;
 397     }
 398
 399     return true;
 400 }
 401
 402 bool FGGeneric::parse_message() {
 403     if (binary_mode) {
 404         return parse_message_binary();
 405     } else {
 406         return parse_message_ascii();
 407     }
 408 }
 409
 410
 411 // open hailing frequencies
 412 bool FGGeneric::open() {
 413     if ( is_enabled() ) {
 414         SG_LOG( SG_IO, SG_ALERT, "This shouldn't happen, but the channel "
 415                 << "is already in use, ignoring" );
 416         return false;
 417     }
 418
 419     SGIOChannel *io = get_io_channel();
 420
 421     if ( ! io->open( get_direction() ) ) {
 422         SG_LOG( SG_IO, SG_ALERT, "Error opening channel communication layer." );
 423         return false;
 424     }
 425
 426     set_enabled( true );
 427
 428     if ( get_direction() == SG_IO_OUT && ! preamble.empty() ) {
 429         if ( ! io->write( preamble.c_str(), preamble.size() ) ) {
 430             SG_LOG( SG_IO, SG_WARN, "Error writing preamble." );
 431             return false;
 432         }
 433     }
 434
 435     return true;
 436 }
 437
 438
 439 // process work for this port
 440 bool FGGeneric::process() {
 441     SGIOChannel *io = get_io_channel();
 442
 443     if ( get_direction() == SG_IO_OUT ) {
 444         gen_message();
 445         if ( ! io->write( buf, length ) ) {
 446             SG_LOG( SG_IO, SG_WARN, "Error writing data." );
 447             goto error_out;
 448         }
 449     } else if ( get_direction() == SG_IO_IN ) {
 450         if ( io->get_type() == sgFileType ) {
 451             if (!binary_mode) {
 452                 length = io->readline( buf, FG_MAX_MSG_SIZE );
 453                 if ( length > 0 ) {
 454                     parse_message();
 455                 } else {
 456                     SG_LOG( SG_IO, SG_ALERT, "Error reading data." );
 457                     return false;
 458                 }
 459             } else {
 460                 length = io->read( buf, binary_record_length );
 461                 if ( length == binary_record_length ) {
 462                     parse_message();
 463                 } else {
 464                     SG_LOG( SG_IO, SG_ALERT,
 465                             "Generic protocol: Received binary "
 466                             "record of unexpected size, expected: "
 467                             << binary_record_length << " but received: "
 468                             << length);
 469                 }
 470             }
 471         } else {
 472             do {
 473                 if (!binary_mode) {
 474                     length = io->readline( buf, FG_MAX_MSG_SIZE );
 475                     if ( length > 0 ) {
 476                         parse_message();
 477                     }
 478                 } else {
 479                     length = io->read( buf, binary_record_length );
 480                     if ( length == binary_record_length ) {
 481                         parse_message();
 482                     } else if ( length > 0 ) {
 483                         SG_LOG( SG_IO, SG_ALERT,
 484                             "Generic protocol: Received binary "
 485                             "record of unexpected size, expected: "
 486                             << binary_record_length << " but received: "
 487                             << length);
 488                     }
 489                 }
 490             } while ( length == binary_record_length );
 491         }
 492     }
 493     return true;
 494 error_out:
 495     if (exitOnError) {
 496         fgExit(1);
 497         return true; // should not get there, but please the compiler
 498     } else
 499         return false;
 500 }
 501
 502
 503 // close the channel
 504 bool FGGeneric::close() {
 505     SGIOChannel *io = get_io_channel();
 506
 507     if ( get_direction() == SG_IO_OUT && ! postamble.empty() ) {
 508         if ( ! io->write( postamble.c_str(), postamble.size() ) ) {
 509             SG_LOG( SG_IO, SG_ALERT, "Error writing postamble." );
 510             return false;
 511         }
 512     }
 513
 514     set_enabled( false );
 515
 516     if ( ! io->close() ) {
 517         return false;
 518     }
 519
 520     return true;
 521 }
 522
 523
 524 void
 525 FGGeneric::read_config(SGPropertyNode *root, vector<_serial_prot> &msg)
 526 {
 527     binary_mode = root->getBoolValue("binary_mode");
 528
 529     if (!binary_mode) {
 530         /* These variables specified in the $FG_ROOT/data/Protocol/xxx.xml
 531          * file for each format
 532          *
 533          * var_sep_string  = the string/charachter to place between variables
 534          * line_sep_string = the string/charachter to place at the end of each
 535          *                   lot of variables
 536          */
 537         preamble = fgUnescape(root->getStringValue("preamble"));
 538         postamble = fgUnescape(root->getStringValue("postamble"));
 539         var_sep_string = fgUnescape(root->getStringValue("var_separator"));
 540         line_sep_string = fgUnescape(root->getStringValue("line_separator"));
 541
 542         if ( var_sep_string == "newline" ) {
 543             var_separator = '\n';
 544         } else if ( var_sep_string == "tab" ) {
 545             var_separator = '\t';
 546         } else if ( var_sep_string == "space" ) {
 547             var_separator = ' ';
 548         } else if ( var_sep_string == "formfeed" ) {
 549             var_separator = '\f';
 550         } else if ( var_sep_string == "carriagereturn" ) {
 551             var_sep_string = '\r';
 552         } else if ( var_sep_string == "verticaltab" ) {
 553             var_separator = '\v';
 554         } else {
 555             var_separator = var_sep_string;
 556         }
 557
 558         if ( line_sep_string == "newline" ) {
 559             line_separator = '\n';
 560         } else if ( line_sep_string == "tab" ) {
 561             line_separator = '\t';
 562         } else if ( line_sep_string == "space" ) {
 563             line_separator = ' ';
 564         } else if ( line_sep_string == "formfeed" ) {
 565             line_separator = '\f';
 566         } else if ( line_sep_string == "carriagereturn" ) {
 567             line_separator = '\r';
 568         } else if ( line_sep_string == "verticaltab" ) {
 569             line_separator = '\v';
 570         } else {
 571             line_separator = line_sep_string;
 572         }
 573     } else {
 574         // default values: no footer and record_length = sizeof(representation)
 575         binary_footer_type = FOOTER_NONE;
 576         binary_record_length = -1;
 577
 578         // default choice is network byte order (big endian)
 579         if (sgIsLittleEndian()) {
 580            binary_byte_order = BYTE_ORDER_NEEDS_CONVERSION;
 581         } else {
 582            binary_byte_order = BYTE_ORDER_MATCHES_NETWORK_ORDER;
 583         }
 584
 585         if ( root->hasValue("binary_footer") ) {
 586             string footer_type = root->getStringValue("binary_footer");
 587             if ( footer_type == "length" ) {
 588                 binary_footer_type = FOOTER_LENGTH;
 589             } else if ( footer_type.substr(0, 5) == "magic" ) {
 590                 binary_footer_type = FOOTER_MAGIC;
 591                 binary_footer_value = strtol(footer_type.substr(6,
 592                             footer_type.length() - 6).c_str(), (char**)0, 0);
 593             } else if ( footer_type != "none" ) {
 594                 SG_LOG(SG_IO, SG_ALERT,
 595                        "generic protocol: Unknown generic binary protocol "
 596                        "footer '" << footer_type << "', using no footer.");
 597             }
 598         }
 599
 600         if ( root->hasValue("record_length") ) {
 601             binary_record_length = root->getIntValue("record_length");
 602         }
 603
 604         if ( root->hasValue("byte_order") ) {
 605             string byte_order = root->getStringValue("byte_order");
 606             if (byte_order == "network" ) {
 607                 if ( sgIsLittleEndian() ) {
 608                     binary_byte_order = BYTE_ORDER_NEEDS_CONVERSION;
 609                 } else {
 610                     binary_byte_order = BYTE_ORDER_MATCHES_NETWORK_ORDER;
 611                 }
 612             } else if ( byte_order == "host" ) {
 613                 binary_byte_order = BYTE_ORDER_MATCHES_NETWORK_ORDER;
 614             } else {
 615                 SG_LOG(SG_IO, SG_ALERT,
 616                        "generic protocol: Undefined generic binary protocol"
 617                        "byte order, using HOST byte order.");
 618             }
 619         }
 620     }
 621
 622     int record_length = 0; // Only used for binary protocols.
 623     vector<SGPropertyNode_ptr> chunks = root->getChildren("chunk");
 624     for (unsigned int i = 0; i < chunks.size(); i++) {
 625
 626         _serial_prot chunk;
 627
 628         // chunk.name = chunks[i]->getStringValue("name");
 629         chunk.format = fgUnescape(chunks[i]->getStringValue("format", "%d"));
 630         chunk.offset = chunks[i]->getDoubleValue("offset");
 631         chunk.factor = chunks[i]->getDoubleValue("factor", 1.0);
 632
 633         string node = chunks[i]->getStringValue("node", "/null");
 634         chunk.prop = fgGetNode(node.c_str(), true);
 635
 636         string type = chunks[i]->getStringValue("type");
 637
 638         // Note: officially the type is called 'bool' but for backward
 639         //       compatibility 'boolean' will also be supported.
 640         if (type == "bool" || type == "boolean") {
 641             chunk.type = FG_BOOL;
 642             record_length += 1;
 643         } else if (type == "float") {
 644             chunk.type = FG_FLOAT;
 645             record_length += sizeof(int32_t);
 646         } else if (type == "double") {
 647             chunk.type = FG_DOUBLE;
 648             record_length += sizeof(int64_t);
 649         } else if (type == "fixed") {
 650             chunk.type = FG_FIXED;
 651             record_length += sizeof(int32_t);
 652         } else if (type == "string")
 653             chunk.type = FG_STRING;
 654         else {
 655             chunk.type = FG_INT;
 656             record_length += sizeof(int32_t);
 657         }
 658         msg.push_back(chunk);
 659
 660     }
 661
 662     if (binary_record_length == -1) {
 663         binary_record_length = record_length;
 664     } else if (binary_record_length < record_length) {
 665         SG_LOG(SG_IO, SG_ALERT,
 666                "generic protocol: Requested binary record length shorter than "
 667                " requested record representation.");
 668         binary_record_length = record_length;
 669     }
 670 }