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