src/Main/fg_io.cxx

   1 // fg_io.cxx -- higher level I/O channel management routines
   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 <simgear/compiler.h>
  28
  29 #include <cstdlib>             // atoi()
  30
  31 #include <string>
  32 #include <algorithm>
  33
  34 #include <simgear/debug/logstream.hxx>
  35 #include <simgear/io/iochannel.hxx>
  36 #include <simgear/io/sg_file.hxx>
  37 #include <simgear/io/sg_serial.hxx>
  38 #include <simgear/io/sg_socket.hxx>
  39 #include <simgear/io/sg_socket_udp.hxx>
  40 #include <simgear/math/sg_types.hxx>
  41 #include <simgear/timing/timestamp.hxx>
  42 #include <simgear/misc/strutils.hxx>
  43
  44 #include <Network/protocol.hxx>
  45 #include <Network/ATC-Main.hxx>
  46 #include <Network/atlas.hxx>
  47 #include <Network/AV400.hxx>
  48 #include <Network/AV400Sim.hxx>
  49 #include <Network/AV400WSim.hxx>
  50 #include <Network/garmin.hxx>
  51 #include <Network/httpd.hxx>
  52 #ifdef FG_JPEG_SERVER
  53 #  include <Network/jpg-httpd.hxx>
  54 #endif
  55 #include <Network/joyclient.hxx>
  56 #include <Network/jsclient.hxx>
  57 #include <Network/native.hxx>
  58 #include <Network/native_ctrls.hxx>
  59 #include <Network/native_fdm.hxx>
  60 #include <Network/native_gui.hxx>
  61 #include <Network/opengc.hxx>
  62 #include <Network/nmea.hxx>
  63 #include <Network/props.hxx>
  64 #include <Network/pve.hxx>
  65 #include <Network/ray.hxx>
  66 #include <Network/rul.hxx>
  67 #include <Network/generic.hxx>
  68
  69 #ifdef FG_HAVE_HLA
  70 #include <Network/HLA/hla.hxx>
  71 #endif
  72
  73 #include "globals.hxx"
  74 #include "fg_io.hxx"
  75
  76 using std::atoi;
  77 using std::string;
  78
  79
  80 FGIO::FGIO()
  81 {
  82 }
  83
  84
  85 FGIO::~FGIO()
  86 {
  87
  88 }
  89
  90
  91 // configure a port based on the config string
  92 FGProtocol*
  93 FGIO::parse_port_config( const string& config )
  94 {
  95     SG_LOG( SG_IO, SG_INFO, "Parse I/O channel request: " << config );
  96
  97     string_list tokens = simgear::strutils::split( config, "," );
  98     if (tokens.empty())
  99     {
 100         SG_LOG( SG_IO, SG_ALERT,
 101                 "Port configuration error: empty config string" );
 102         return NULL;
 103     }
 104
 105     string protocol = tokens[0];
 106     SG_LOG( SG_IO, SG_INFO, "  protocol = " << protocol );
 107
 108     FGProtocol *io = NULL;
 109
 110     try
 111     {
 112         if ( protocol == "atcsim" ) {
 113             FGATCMain *atcsim = new FGATCMain;
 114             atcsim->set_hz( 30 );
 115             if ( tokens.size() != 6 ) {
 116                 SG_LOG( SG_IO, SG_ALERT, "Usage: --atcsim=[no-]pedals,"
 117                         << "input0_config,input1_config,"
 118                         << "output0_config,output1_config,file.nas" );
 119                 delete atcsim;
 120                 return NULL;
 121             }
 122             if ( tokens[1] == "no-pedals" ) {
 123                 fgSetBool( "/input/atcsim/ignore-pedal-controls", true );
 124             } else {
 125                 fgSetBool( "/input/atcsim/ignore-pedal-controls", false );
 126             }
 127             atcsim->set_path_names(tokens[2], tokens[3], tokens[4], tokens[5]);
 128             return atcsim;
 129         } else if ( protocol == "atlas" ) {
 130             FGAtlas *atlas = new FGAtlas;
 131             io = atlas;
 132         } else if ( protocol == "opengc" ) {
 133             FGOpenGC *opengc = new FGOpenGC;
 134             io = opengc;
 135         } else if ( protocol == "AV400" ) {
 136             FGAV400 *av400 = new FGAV400;
 137             io = av400;
 138         } else if ( protocol == "AV400Sim" ) {
 139             FGAV400Sim *av400sim = new FGAV400Sim;
 140             io = av400sim;
 141         } else if ( protocol == "AV400WSimA" ) {
 142             FGAV400WSimA *av400wsima = new FGAV400WSimA;
 143             io = av400wsima;
 144         } else if ( protocol == "AV400WSimB" ) {
 145             FGAV400WSimB *av400wsimb = new FGAV400WSimB;
 146             io = av400wsimb;
 147         } else if ( protocol == "garmin" ) {
 148             FGGarmin *garmin = new FGGarmin;
 149             io = garmin;
 150         } else if ( protocol == "httpd" ) {
 151             // determine port
 152             string port = tokens[1];
 153             return new FGHttpd( atoi(port.c_str()) );
 154 #ifdef FG_JPEG_SERVER
 155         } else if ( protocol == "jpg-httpd" ) {
 156             // determine port
 157             string port = tokens[1];
 158             return new FGJpegHttpd( atoi(port.c_str()) );
 159 #endif
 160         } else if ( protocol == "joyclient" ) {
 161             FGJoyClient *joyclient = new FGJoyClient;
 162             io = joyclient;
 163         } else if ( protocol == "jsclient" ) {
 164             FGJsClient *jsclient = new FGJsClient;
 165             io = jsclient;
 166         } else if ( protocol == "native" ) {
 167             FGNative *native = new FGNative;
 168             io = native;
 169         } else if ( protocol == "native-ctrls" ) {
 170             FGNativeCtrls *native_ctrls = new FGNativeCtrls;
 171             io = native_ctrls;
 172         } else if ( protocol == "native-fdm" ) {
 173             FGNativeFDM *native_fdm = new FGNativeFDM;
 174             io = native_fdm;
 175         } else if ( protocol == "native-gui" ) {
 176             FGNativeGUI *net_gui = new FGNativeGUI;
 177             io = net_gui;
 178         } else if ( protocol == "nmea" ) {
 179             FGNMEA *nmea = new FGNMEA;
 180             io = nmea;
 181         } else if ( protocol == "props" || protocol == "telnet" ) {
 182             io = new FGProps( tokens );
 183             return io;
 184         } else if ( protocol == "pve" ) {
 185             FGPVE *pve = new FGPVE;
 186             io = pve;
 187         } else if ( protocol == "ray" ) {
 188             FGRAY *ray = new FGRAY;
 189             io = ray;
 190         } else if ( protocol == "rul" ) {
 191             FGRUL *rul = new FGRUL;
 192             io = rul;
 193         } else if ( protocol == "generic" ) {
 194             FGGeneric *generic = new FGGeneric( tokens );
 195             if (!generic->getInitOk())
 196             {
 197                 // failed to initialize (i.e. invalid configuration)
 198                 delete generic;
 199                 return NULL;
 200             }
 201             io = generic;
 202         } else if ( protocol == "multiplay" ) {
 203             if ( tokens.size() != 5 ) {
 204                 SG_LOG( SG_IO, SG_ALERT, "Ignoring invalid --multiplay option "
 205                         "(4 arguments expected: --multiplay=dir,hz,hostname,port)" );
 206                 return NULL;
 207             }
 208             string dir = tokens[1];
 209             int rate = atoi(tokens[2].c_str());
 210             string host = tokens[3];
 211
 212             short port = atoi(tokens[4].c_str());
 213
 214             // multiplay used to be handled by an FGProtocol, but no longer. This code
 215             // retains compatibility with existing command-line syntax
 216             fgSetInt("/sim/multiplay/tx-rate-hz", rate);
 217             if (dir == "in") {
 218                 fgSetInt("/sim/multiplay/rxport", port);
 219                 fgSetString("/sim/multiplay/rxhost", host.c_str());
 220             } else if (dir == "out") {
 221                 fgSetInt("/sim/multiplay/txport", port);
 222                 fgSetString("/sim/multiplay/txhost", host.c_str());
 223             }
 224
 225             return NULL;
 226         }
 227 #ifdef FG_HAVE_HLA
 228         else if ( protocol == "hla" ) {
 229             return new FGHLA(tokens);
 230         }
 231         else if ( protocol == "hla-local" ) {
 232             // This is just about to bring up some defaults
 233             if (tokens.size() != 2) {
 234                 SG_LOG( SG_IO, SG_ALERT, "Ignoring invalid --hla-local option "
 235                         "(one argument expected: --hla-local=<federationname>" );
 236                 return NULL;
 237             }
 238             tokens.insert(tokens.begin(), "");
 239             tokens.insert(tokens.begin(), "60");
 240             tokens.insert(tokens.begin(), "bi");
 241             tokens.push_back("fg-local.xml");
 242             return new FGHLA(tokens);
 243         }
 244 #endif
 245         else {
 246             return NULL;
 247         }
 248     }
 249     catch (FGProtocolConfigError& err)
 250     {
 251         SG_LOG( SG_IO, SG_ALERT, "Port configuration error: " << err.what() );
 252         delete io;
 253         return NULL;
 254     }
 255
 256     if (tokens.size() < 3) {
 257         SG_LOG( SG_IO, SG_ALERT, "Incompatible number of network arguments.");
 258         delete io;
 259         return NULL;
 260     }
 261     string medium = tokens[1];
 262     SG_LOG( SG_IO, SG_INFO, "  medium = " << medium );
 263
 264     string direction = tokens[2];
 265     io->set_direction( direction );
 266     SG_LOG( SG_IO, SG_INFO, "  direction = " << direction );
 267
 268     string hertz_str = tokens[3];
 269     double hertz = atof( hertz_str.c_str() );
 270     io->set_hz( hertz );
 271     SG_LOG( SG_IO, SG_INFO, "  hertz = " << hertz );
 272
 273     if ( medium == "serial" ) {
 274         if ( tokens.size() < 5) {
 275             SG_LOG( SG_IO, SG_ALERT, "Incompatible number of arguments for serial communications.");
 276             delete io;
 277             return NULL;
 278         }
 279         // device name
 280         string device = tokens[4];
 281         SG_LOG( SG_IO, SG_INFO, "  device = " << device );
 282
 283         // baud
 284         string baud = tokens[5];
 285         SG_LOG( SG_IO, SG_INFO, "  baud = " << baud );
 286
 287
 288         SGSerial *ch = new SGSerial( device, baud );
 289         io->set_io_channel( ch );
 290
 291         if ( protocol == "AV400WSimB" ) {
 292             if ( tokens.size() < 7 ) {
 293                 SG_LOG( SG_IO, SG_ALERT, "Missing second hz for AV400WSimB.");
 294                 delete io;
 295                 return NULL;
 296             }
 297             FGAV400WSimB *fgavb = static_cast<FGAV400WSimB*>(io);
 298             string hz2_str = tokens[6];
 299             double hz2 = atof(hz2_str.c_str());
 300             fgavb->set_hz2(hz2);
 301         }
 302     } else if ( medium == "file" ) {
 303         // file name
 304         if ( tokens.size() < 4) {
 305             SG_LOG( SG_IO, SG_ALERT, "Incompatible number of arguments for file I/O.");
 306             delete io;
 307             return NULL;
 308         }
 309
 310         string file = tokens[4];
 311         SG_LOG( SG_IO, SG_INFO, "  file name = " << file );
 312         int repeat = 1;
 313         if (tokens.size() >= 7 && tokens[6] == "repeat") {
 314             if (tokens.size() >= 8) {
 315                 repeat = atoi(tokens[7].c_str());
 316                 FGGeneric* generic = dynamic_cast<FGGeneric*>(io);
 317                 if (generic)
 318                     generic->setExitOnError(true);
 319             } else {
 320                 repeat = -1;
 321             }
 322         }
 323         SGFile *ch = new SGFile( file, repeat );
 324         io->set_io_channel( ch );
 325     } else if ( medium == "socket" ) {
 326         if ( tokens.size() < 6) {
 327             SG_LOG( SG_IO, SG_ALERT, "Incompatible number of arguments for socket communications.");
 328             delete io;
 329             return NULL;
 330         }
 331         string hostname = tokens[4];
 332         string port = tokens[5];
 333         string style = tokens[6];
 334
 335         SG_LOG( SG_IO, SG_INFO, "  hostname = " << hostname );
 336         SG_LOG( SG_IO, SG_INFO, "  port = " << port );
 337         SG_LOG( SG_IO, SG_INFO, "  style = " << style );
 338
 339         io->set_io_channel( new SGSocket( hostname, port, style ) );
 340     }
 341
 342     return io;
 343 }
 344
 345
 346 // step through the port config streams (from fgOPTIONS) and setup
 347 // serial port channels for each
 348 void
 349 FGIO::init()
 350 {
 351     // SG_LOG( SG_IO, SG_INFO, "I/O Channel initialization, " <<
 352     //         globals->get_channel_options_list()->size() << " requests." );
 353
 354     _realDeltaTime = fgGetNode("/sim/time/delta-realtime-sec");
 355
 356     // we could almost do this in a single step except pushing a valid
 357     // port onto the port list copies the structure and destroys the
 358     // original, which closes the port and frees up the fd ... doh!!!
 359
 360     string_list::iterator i = globals->get_channel_options_list()->begin();
 361     string_list::iterator end = globals->get_channel_options_list()->end();
 362     for (; i != end; ++i ) {
 363         add_channel( *i );
 364     } // of channel options iteration
 365 }
 366
 367 // add another I/O channel
 368 void FGIO::add_channel(const string& config)
 369 {
 370     // parse the configuration string and store the results in the
 371     // appropriate FGIOChannel structure
 372     FGProtocol *p = parse_port_config( config );
 373     if (!p)
 374     {
 375         return;
 376     }
 377
 378     p->open();
 379     if ( !p->is_enabled() ) {
 380         SG_LOG( SG_IO, SG_ALERT, "I/O Channel config failed." );
 381         delete p;
 382         return;
 383     }
 384
 385     io_channels.push_back( p );
 386 }
 387
 388 void
 389 FGIO::reinit()
 390 {
 391 }
 392
 393 // process any IO channel work
 394 void
 395 FGIO::update( double /* delta_time_sec */ )
 396 {
 397     // use wall-clock, not simulation, delta time, so that network
 398     // protocols update when the simulation is paused
 399     // see http://code.google.com/p/flightgear-bugs/issues/detail?id=125
 400     double delta_time_sec = _realDeltaTime->getDoubleValue();
 401
 402     ProtocolVec::iterator i = io_channels.begin();
 403     ProtocolVec::iterator end = io_channels.end();
 404     for (; i != end; ++i ) {
 405         FGProtocol* p = *i;
 406         if (!p->is_enabled()) {
 407             continue;
 408         }
 409
 410         p->dec_count_down( delta_time_sec );
 411         double dt = 1 / p->get_hz();
 412         if ( p->get_count_down() < 0.33 * dt ) {
 413             p->process();
 414             p->inc_count();
 415             while ( p->get_count_down() < 0.33 * dt ) {
 416                 p->inc_count_down( dt );
 417             }
 418         } // of channel processing
 419     } // of io_channels iteration
 420 }
 421
 422 void
 423 FGIO::shutdown()
 424 {
 425     ProtocolVec::iterator i = io_channels.begin();
 426     ProtocolVec::iterator end = io_channels.end();
 427     for (; i != end; ++i )
 428     {
 429         FGProtocol *p = *i;
 430         if ( p->is_enabled() ) {
 431             p->close();
 432         }
 433
 434         delete p;
 435     }
 436
 437     io_channels.clear();
 438 }
 439
 440 void
 441 FGIO::bind()
 442 {
 443 }
 444
 445 void
 446 FGIO::unbind()
 447 {
 448 }