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 - curt@flightgear.org
   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., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22
  23
  24 #include <simgear/compiler.h>
  25
  26 #include <stdlib.h>             // atoi()
  27
  28 #include STL_STRING
  29
  30 #include <simgear/debug/logstream.hxx>
  31 #include <simgear/io/iochannel.hxx>
  32 #include <simgear/io/sg_file.hxx>
  33 #include <simgear/io/sg_serial.hxx>
  34 #include <simgear/io/sg_socket.hxx>
  35 #include <simgear/io/sg_socket_udp.hxx>
  36 #include <simgear/math/sg_types.hxx>
  37 #include <simgear/timing/timestamp.hxx>
  38 #include <simgear/misc/strutils.hxx>
  39
  40 #include <Network/protocol.hxx>
  41 #include <Network/atc610x.hxx>
  42 #include <Network/atlas.hxx>
  43 #include <Network/garmin.hxx>
  44 #include <Network/httpd.hxx>
  45 #ifdef FG_JPEG_SERVER
  46 #  include <Network/jpg-httpd.hxx>
  47 #endif
  48 #include <Network/joyclient.hxx>
  49 #include <Network/jsclient.hxx>
  50 #include <Network/native.hxx>
  51 #include <Network/native_ctrls.hxx>
  52 #include <Network/native_fdm.hxx>
  53 #include <Network/native_gui.hxx>
  54 #include <Network/opengc.hxx>
  55 #include <Network/nmea.hxx>
  56 #include <Network/props.hxx>
  57 #include <Network/pve.hxx>
  58 #include <Network/ray.hxx>
  59 #include <Network/rul.hxx>
  60 #include <Network/generic.hxx>
  61
  62 #ifdef FG_MPLAYER_AS
  63 #include <Network/multiplay.hxx>
  64 #endif
  65
  66 #include "globals.hxx"
  67 #include "fg_io.hxx"
  68
  69 SG_USING_STD(string);
  70
  71
  72 FGIO::FGIO()
  73 {
  74 }
  75
  76 #include STL_ALGORITHM
  77 SG_USING_STD(for_each);
  78
  79 static void delete_ptr( FGProtocol* p ) { delete p; }
  80
  81 FGIO::~FGIO()
  82 {
  83     shutdown_all();
  84     for_each( io_channels.begin(), io_channels.end(), delete_ptr );
  85 }
  86
  87
  88 // configure a port based on the config string
  89 FGProtocol*
  90 FGIO::parse_port_config( const string& config )
  91 {
  92     SG_LOG( SG_IO, SG_INFO, "Parse I/O channel request: " << config );
  93
  94     vector<string> tokens = simgear::strutils::split( config, "," );
  95     if (tokens.empty())
  96     {
  97         SG_LOG( SG_IO, SG_ALERT,
  98                 "Port configuration error: empty config string" );
  99         return 0;
 100     }
 101
 102     string protocol = tokens[0];
 103     SG_LOG( SG_IO, SG_INFO, "  protocol = " << protocol );
 104
 105     FGProtocol *io = 0;
 106
 107     try
 108     {
 109         if ( protocol == "atc610x" ) {
 110             FGATC610x *atc610x = new FGATC610x;
 111             atc610x->set_hz( 30 );
 112             if ( tokens.size() > 1 ) {
 113                 if ( tokens[1] == "no-rudder" ) {
 114                     atc610x->set_use_rudder( false );
 115                 }
 116             }
 117             return atc610x;
 118         } else if ( protocol == "atlas" ) {
 119             FGAtlas *atlas = new FGAtlas;
 120             io = atlas;
 121         } else if ( protocol == "opengc" ) {
 122             // char wait;
 123             // printf("Parsed opengc\n"); cin >> wait;
 124             FGOpenGC *opengc = new FGOpenGC;
 125             io = opengc;
 126         } else if ( protocol == "garmin" ) {
 127             FGGarmin *garmin = new FGGarmin;
 128             io = garmin;
 129         } else if ( protocol == "httpd" ) {
 130             // determine port
 131             string port = tokens[1];
 132             return new FGHttpd( atoi(port.c_str()) );
 133 #ifdef FG_JPEG_SERVER
 134         } else if ( protocol == "jpg-httpd" ) {
 135             // determine port
 136             string port = tokens[1];
 137             return new FGJpegHttpd( atoi(port.c_str()) );
 138 #endif
 139         } else if ( protocol == "joyclient" ) {
 140             FGJoyClient *joyclient = new FGJoyClient;
 141             io = joyclient;
 142         } else if ( protocol == "jsclient" ) {
 143             FGJsClient *jsclient = new FGJsClient;
 144             io = jsclient;
 145         } else if ( protocol == "native" ) {
 146             FGNative *native = new FGNative;
 147             io = native;
 148         } else if ( protocol == "native-ctrls" ) {
 149             FGNativeCtrls *native_ctrls = new FGNativeCtrls;
 150             io = native_ctrls;
 151         } else if ( protocol == "native-fdm" ) {
 152             FGNativeFDM *native_fdm = new FGNativeFDM;
 153             io = native_fdm;
 154         } else if ( protocol == "native-gui" ) {
 155             FGNativeGUI *net_gui = new FGNativeGUI;
 156             io = net_gui;
 157         } else if ( protocol == "nmea" ) {
 158             FGNMEA *nmea = new FGNMEA;
 159             io = nmea;
 160         } else if ( protocol == "props" || protocol == "telnet" ) {
 161             io = new FGProps( tokens );
 162             return io;
 163         } else if ( protocol == "pve" ) {
 164             FGPVE *pve = new FGPVE;
 165             io = pve;
 166         } else if ( protocol == "ray" ) {
 167             FGRAY *ray = new FGRAY;
 168             io = ray;
 169         } else if ( protocol == "rul" ) {
 170             FGRUL *rul = new FGRUL;
 171             io = rul;
 172         } else if ( protocol == "generic" ) {
 173             int n = 6;
 174             if (tokens[1] == "socket")  n++;
 175             FGGeneric *generic = new FGGeneric( tokens[n] );
 176             io = generic;
 177
 178 #ifdef FG_MPLAYER_AS
 179         } else if ( protocol == "multiplay" ) {\
 180             //Determine dir, rate, host & port
 181             string dir = tokens[1];
 182             string rate = tokens[2];
 183             string host = tokens[3];
 184             string port = tokens[4];
 185             return new FGMultiplay(dir, atoi(rate.c_str()), host, atoi(port.c_str()));
 186 #endif
 187
 188         } else {
 189             return NULL;
 190         }
 191     }
 192     catch (FGProtocolConfigError& err)
 193     {
 194         SG_LOG( SG_IO, SG_ALERT, "Port configuration error: " << err.what() );
 195         delete io;
 196         return 0;
 197     }
 198
 199     string medium = tokens[1];
 200     SG_LOG( SG_IO, SG_INFO, "  medium = " << medium );
 201
 202     string direction = tokens[2];
 203     io->set_direction( direction );
 204     SG_LOG( SG_IO, SG_INFO, "  direction = " << direction );
 205
 206     string hertz_str = tokens[3];
 207     double hertz = atof( hertz_str.c_str() );
 208     io->set_hz( hertz );
 209     SG_LOG( SG_IO, SG_INFO, "  hertz = " << hertz );
 210
 211     if ( medium == "serial" ) {
 212         // device name
 213         string device = tokens[4];
 214         SG_LOG( SG_IO, SG_INFO, "  device = " << device );
 215
 216         // baud
 217         string baud = tokens[5];
 218         SG_LOG( SG_IO, SG_INFO, "  baud = " << baud );
 219
 220         SGSerial *ch = new SGSerial( device, baud );
 221         io->set_io_channel( ch );
 222     } else if ( medium == "file" ) {
 223         // file name
 224         string file = tokens[4];
 225         SG_LOG( SG_IO, SG_INFO, "  file name = " << file );
 226
 227         SGFile *ch = new SGFile( file );
 228         io->set_io_channel( ch );
 229     } else if ( medium == "socket" ) {
 230         string hostname = tokens[4];
 231         string port = tokens[5];
 232         string style = tokens[6];
 233
 234         SG_LOG( SG_IO, SG_INFO, "  hostname = " << hostname );
 235         SG_LOG( SG_IO, SG_INFO, "  port = " << port );
 236         SG_LOG( SG_IO, SG_INFO, "  style = " << style );
 237
 238         io->set_io_channel( new SGSocket( hostname, port, style ) );
 239     }
 240
 241     return io;
 242 }
 243
 244
 245 // step through the port config streams (from fgOPTIONS) and setup
 246 // serial port channels for each
 247 void
 248 FGIO::init()
 249 {
 250     // SG_LOG( SG_IO, SG_INFO, "I/O Channel initialization, " <<
 251     //         globals->get_channel_options_list()->size() << " requests." );
 252
 253     FGProtocol *p;
 254
 255     // we could almost do this in a single step except pushing a valid
 256     // port onto the port list copies the structure and destroys the
 257     // original, which closes the port and frees up the fd ... doh!!!
 258
 259     // parse the configuration strings and store the results in the
 260     // appropriate FGIOChannel structures
 261     typedef vector<string> container;
 262     container::iterator i = globals->get_channel_options_list()->begin();
 263     container::iterator end = globals->get_channel_options_list()->end();
 264     for (; i != end; ++i )
 265     {
 266         p = parse_port_config( *i );
 267         if ( p != NULL ) {
 268             p->open();
 269             io_channels.push_back( p );
 270             if ( !p->is_enabled() ) {
 271                 SG_LOG( SG_IO, SG_ALERT, "I/O Channel config failed." );
 272                 exit(-1);
 273             }
 274         } else {
 275             SG_LOG( SG_IO, SG_INFO, "I/O Channel parse failed." );
 276         }
 277     }
 278 }
 279
 280
 281 // process any IO channel work
 282 void
 283 FGIO::update( double delta_time_sec )
 284 {
 285     // cout << "processing I/O channels" << endl;
 286     // cout << "  Elapsed time = " << delta_time_sec << endl;
 287
 288     typedef vector< FGProtocol* > container;
 289     container::iterator i = io_channels.begin();
 290     container::iterator end = io_channels.end();
 291     for (; i != end; ++i ) {
 292         FGProtocol* p = *i;
 293
 294         if ( p->is_enabled() ) {
 295             p->dec_count_down( delta_time_sec );
 296             double dt = 1 / p->get_hz();
 297             if ( p->get_count_down() < 0.33 * dt ) {
 298               p->process();
 299               p->inc_count();
 300               while ( p->get_count_down() < 0.33 * dt ) {
 301                 p->inc_count_down( dt );
 302               }
 303               // double ave = elapsed_time / p->get_count();
 304               // cout << "  ave rate = " << ave << endl;
 305             }
 306         }
 307     }
 308 }
 309
 310
 311 void
 312 FGIO::shutdown_all() {
 313     FGProtocol *p;
 314
 315     // cout << "processing I/O channels" << endl;
 316
 317     typedef vector< FGProtocol* > container;
 318     container::iterator i = io_channels.begin();
 319     container::iterator end = io_channels.end();
 320     for (; i != end; ++i )
 321     {
 322         p = *i;
 323
 324         if ( p->is_enabled() ) {
 325             p->close();
 326         }
 327     }
 328 }
 329
 330 void
 331 FGIO::bind()
 332 {
 333 }
 334
 335 void
 336 FGIO::unbind()
 337 {
 338 }
 339