// $Id: RlinkPort.cpp 492 2013-02-24 22:14:47Z mueller $
|
// $Id: RlinkPort.cpp 492 2013-02-24 22:14:47Z mueller $
|
//
|
//
|
// Copyright 2011-2013 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
|
// Copyright 2011-2013 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
|
//
|
//
|
// This program is free software; you may redistribute and/or modify it under
|
// This program is free software; you may redistribute and/or modify it under
|
// the terms of the GNU General Public License as published by the Free
|
// the terms of the GNU General Public License as published by the Free
|
// Software Foundation, either version 2, or at your option any later version.
|
// Software Foundation, either version 2, or at your option any later version.
|
//
|
//
|
// This program is distributed in the hope that it will be useful, but
|
// This program is distributed in the hope that it will be useful, but
|
// WITHOUT ANY WARRANTY, without even the implied warranty of MERCHANTABILITY
|
// WITHOUT ANY WARRANTY, without even the implied warranty of MERCHANTABILITY
|
// or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
// or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
// for complete details.
|
// for complete details.
|
//
|
//
|
// Revision History:
|
// Revision History:
|
// Date Rev Version Comment
|
// Date Rev Version Comment
|
// 2013-02-23 492 1.2 use RparseUrl
|
// 2013-02-23 492 1.2 use RparseUrl
|
// 2013-02-22 491 1.1 use new RlogFile/RlogMsg interfaces
|
// 2013-02-22 491 1.1 use new RlogFile/RlogMsg interfaces
|
// 2013-02-10 485 1.0.5 add static const defs
|
// 2013-02-10 485 1.0.5 add static const defs
|
// 2013-02-03 481 1.0.4 use Rexception
|
// 2013-02-03 481 1.0.4 use Rexception
|
// 2013-01-27 477 1.0.3 add RawRead(),RawWrite() methods
|
// 2013-01-27 477 1.0.3 add RawRead(),RawWrite() methods
|
// 2012-12-28 466 1.0.2 allow Close() even when not open
|
// 2012-12-28 466 1.0.2 allow Close() even when not open
|
// 2012-12-26 465 1.0.1 add CloseFd() method
|
// 2012-12-26 465 1.0.1 add CloseFd() method
|
// 2011-03-27 375 1.0 Initial version
|
// 2011-03-27 375 1.0 Initial version
|
// 2011-01-15 356 0.1 First draft
|
// 2011-01-15 356 0.1 First draft
|
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
|
|
/*!
|
/*!
|
\file
|
\file
|
\version $Id: RlinkPort.cpp 492 2013-02-24 22:14:47Z mueller $
|
\version $Id: RlinkPort.cpp 492 2013-02-24 22:14:47Z mueller $
|
\brief Implemenation of RlinkPort.
|
\brief Implemenation of RlinkPort.
|
*/
|
*/
|
|
|
#include <errno.h>
|
#include <errno.h>
|
#include <unistd.h>
|
#include <unistd.h>
|
#include <poll.h>
|
#include <poll.h>
|
#include <sys/time.h>
|
#include <sys/time.h>
|
|
|
#include <iostream>
|
#include <iostream>
|
|
|
#include "librtools/RosFill.hpp"
|
#include "librtools/RosFill.hpp"
|
#include "librtools/RosPrintf.hpp"
|
#include "librtools/RosPrintf.hpp"
|
#include "librtools/RosPrintBvi.hpp"
|
#include "librtools/RosPrintBvi.hpp"
|
#include "librtools/Rexception.hpp"
|
#include "librtools/Rexception.hpp"
|
#include "librtools/RlogMsg.hpp"
|
#include "librtools/RlogMsg.hpp"
|
|
|
#include "RlinkPort.hpp"
|
#include "RlinkPort.hpp"
|
|
|
using namespace std;
|
using namespace std;
|
|
|
/*!
|
/*!
|
\class Retro::RlinkPort
|
\class Retro::RlinkPort
|
\brief FIXME_docs
|
\brief FIXME_docs
|
*/
|
*/
|
|
|
// all method definitions in namespace Retro
|
// all method definitions in namespace Retro
|
namespace Retro {
|
namespace Retro {
|
|
|
//------------------------------------------+-----------------------------------
|
//------------------------------------------+-----------------------------------
|
// constants definitions
|
// constants definitions
|
|
|
const int RlinkPort::kEof;
|
const int RlinkPort::kEof;
|
const int RlinkPort::kTout;
|
const int RlinkPort::kTout;
|
const int RlinkPort::kErr;
|
const int RlinkPort::kErr;
|
|
|
//------------------------------------------+-----------------------------------
|
//------------------------------------------+-----------------------------------
|
//! Default constructor
|
//! Default constructor
|
|
|
RlinkPort::RlinkPort()
|
RlinkPort::RlinkPort()
|
: fIsOpen(false),
|
: fIsOpen(false),
|
fUrl(),
|
fUrl(),
|
fFdRead(-1),
|
fFdRead(-1),
|
fFdWrite(-1),
|
fFdWrite(-1),
|
fspLog(),
|
fspLog(),
|
fTraceLevel(0),
|
fTraceLevel(0),
|
fStats()
|
fStats()
|
{
|
{
|
fStats.Define(kStatNPortWrite, "NPortWrite", "Port::Write() calls");
|
fStats.Define(kStatNPortWrite, "NPortWrite", "Port::Write() calls");
|
fStats.Define(kStatNPortRead, "NPortRead", "Port::Read() calls");
|
fStats.Define(kStatNPortRead, "NPortRead", "Port::Read() calls");
|
fStats.Define(kStatNPortTxByt, "NPortTxByt", "Port Tx bytes send");
|
fStats.Define(kStatNPortTxByt, "NPortTxByt", "Port Tx bytes send");
|
fStats.Define(kStatNPortRxByt, "NPortRxByt", "Port Rx bytes rcvd");
|
fStats.Define(kStatNPortRxByt, "NPortRxByt", "Port Rx bytes rcvd");
|
fStats.Define(kStatNPortRawWrite, "NPortRawWrite", "Port::RawWrite() calls");
|
fStats.Define(kStatNPortRawWrite, "NPortRawWrite", "Port::RawWrite() calls");
|
fStats.Define(kStatNPortRawRead, "NPortRawRead", "Port::RawRead() calls");
|
fStats.Define(kStatNPortRawRead, "NPortRawRead", "Port::RawRead() calls");
|
}
|
}
|
|
|
//------------------------------------------+-----------------------------------
|
//------------------------------------------+-----------------------------------
|
//! Destructor
|
//! Destructor
|
|
|
RlinkPort::~RlinkPort()
|
RlinkPort::~RlinkPort()
|
{
|
{
|
if (IsOpen()) RlinkPort::Close();
|
if (IsOpen()) RlinkPort::Close();
|
}
|
}
|
|
|
//------------------------------------------+-----------------------------------
|
//------------------------------------------+-----------------------------------
|
//! FIXME_docs
|
//! FIXME_docs
|
|
|
void RlinkPort::Close()
|
void RlinkPort::Close()
|
{
|
{
|
if (!IsOpen()) return;
|
if (!IsOpen()) return;
|
|
|
if (fFdWrite == fFdRead) fFdWrite = -1;
|
if (fFdWrite == fFdRead) fFdWrite = -1;
|
CloseFd(fFdWrite);
|
CloseFd(fFdWrite);
|
CloseFd(fFdRead);
|
CloseFd(fFdRead);
|
|
|
fIsOpen = false;
|
fIsOpen = false;
|
fUrl.Clear();
|
fUrl.Clear();
|
|
|
return;
|
return;
|
}
|
}
|
|
|
//------------------------------------------+-----------------------------------
|
//------------------------------------------+-----------------------------------
|
//! FIXME_docs
|
//! FIXME_docs
|
|
|
int RlinkPort::Read(uint8_t* buf, size_t size, double timeout, RerrMsg& emsg)
|
int RlinkPort::Read(uint8_t* buf, size_t size, double timeout, RerrMsg& emsg)
|
{
|
{
|
if (!IsOpen())
|
if (!IsOpen())
|
throw Rexception("RlinkPort::Read()","Bad state: port not open");
|
throw Rexception("RlinkPort::Read()","Bad state: port not open");
|
if (buf == 0)
|
if (buf == 0)
|
throw Rexception("RlinkPort::Read()","Bad args: buf==NULL");
|
throw Rexception("RlinkPort::Read()","Bad args: buf==NULL");
|
if (size == 0)
|
if (size == 0)
|
throw Rexception("RlinkPort::Read()","Bad args: size==0");
|
throw Rexception("RlinkPort::Read()","Bad args: size==0");
|
|
|
fStats.Inc(kStatNPortRead);
|
fStats.Inc(kStatNPortRead);
|
|
|
bool rdpoll = PollRead(timeout);
|
bool rdpoll = PollRead(timeout);
|
if (!rdpoll) return kTout;
|
if (!rdpoll) return kTout;
|
|
|
int irc = -1;
|
int irc = -1;
|
while (irc < 0) {
|
while (irc < 0) {
|
irc = read(fFdRead, (void*) buf, size);
|
irc = read(fFdRead, (void*) buf, size);
|
if (irc < 0 && errno != EINTR) {
|
if (irc < 0 && errno != EINTR) {
|
emsg.InitErrno("RlinkPort::Read()", "read() failed : ", errno);
|
emsg.InitErrno("RlinkPort::Read()", "read() failed : ", errno);
|
if (fspLog && fTraceLevel>0) fspLog->Write(emsg.Message(), 'E');
|
if (fspLog && fTraceLevel>0) fspLog->Write(emsg.Message(), 'E');
|
return kErr;
|
return kErr;
|
}
|
}
|
}
|
}
|
|
|
if (fspLog && fTraceLevel>0) {
|
if (fspLog && fTraceLevel>0) {
|
RlogMsg lmsg(*fspLog, 'I');
|
RlogMsg lmsg(*fspLog, 'I');
|
lmsg << "port read nchar=" << RosPrintf(irc,"d",4);
|
lmsg << "port read nchar=" << RosPrintf(irc,"d",4);
|
if (fTraceLevel>1) {
|
if (fTraceLevel>1) {
|
size_t ncol = (80-5-6)/(2+1);
|
size_t ncol = (80-5-6)/(2+1);
|
for (int i=0; i<irc; i++) {
|
for (int i=0; i<irc; i++) {
|
if ((i%ncol)==0) lmsg << "\n " << RosPrintf(i,"d",4) << ": ";
|
if ((i%ncol)==0) lmsg << "\n " << RosPrintf(i,"d",4) << ": ";
|
lmsg << RosPrintBvi(buf[i],16) << " ";
|
lmsg << RosPrintBvi(buf[i],16) << " ";
|
}
|
}
|
}
|
}
|
}
|
}
|
|
|
fStats.Inc(kStatNPortRxByt, double(irc));
|
fStats.Inc(kStatNPortRxByt, double(irc));
|
|
|
return irc;
|
return irc;
|
}
|
}
|
|
|
//------------------------------------------+-----------------------------------
|
//------------------------------------------+-----------------------------------
|
//! FIXME_docs
|
//! FIXME_docs
|
|
|
int RlinkPort::Write(const uint8_t* buf, size_t size, RerrMsg& emsg)
|
int RlinkPort::Write(const uint8_t* buf, size_t size, RerrMsg& emsg)
|
{
|
{
|
if (!IsOpen())
|
if (!IsOpen())
|
throw Rexception("RlinkPort::Write()","Bad state: port not open");
|
throw Rexception("RlinkPort::Write()","Bad state: port not open");
|
if (buf == 0)
|
if (buf == 0)
|
throw Rexception("RlinkPort::Write()","Bad args: buf==NULL");
|
throw Rexception("RlinkPort::Write()","Bad args: buf==NULL");
|
if (size == 0)
|
if (size == 0)
|
throw Rexception("RlinkPort::Write()","Bad args: size==0");
|
throw Rexception("RlinkPort::Write()","Bad args: size==0");
|
|
|
fStats.Inc(kStatNPortWrite);
|
fStats.Inc(kStatNPortWrite);
|
|
|
if (fspLog && fTraceLevel>0) {
|
if (fspLog && fTraceLevel>0) {
|
RlogMsg lmsg(*fspLog, 'I');
|
RlogMsg lmsg(*fspLog, 'I');
|
lmsg << "port write nchar=" << RosPrintf(size,"d",4);
|
lmsg << "port write nchar=" << RosPrintf(size,"d",4);
|
if (fTraceLevel>1) {
|
if (fTraceLevel>1) {
|
size_t ncol = (80-5-6)/(2+1);
|
size_t ncol = (80-5-6)/(2+1);
|
for (size_t i=0; i<size; i++) {
|
for (size_t i=0; i<size; i++) {
|
if ((i%ncol)==0) lmsg << "\n " << RosPrintf(i,"d",4) << ": ";
|
if ((i%ncol)==0) lmsg << "\n " << RosPrintf(i,"d",4) << ": ";
|
lmsg << RosPrintBvi(buf[i],16) << " ";
|
lmsg << RosPrintBvi(buf[i],16) << " ";
|
}
|
}
|
}
|
}
|
}
|
}
|
|
|
size_t ndone = 0;
|
size_t ndone = 0;
|
while (ndone < size) {
|
while (ndone < size) {
|
int irc = -1;
|
int irc = -1;
|
while (irc < 0) {
|
while (irc < 0) {
|
irc = write(fFdWrite, (void*) (buf+ndone), size-ndone);
|
irc = write(fFdWrite, (void*) (buf+ndone), size-ndone);
|
if (irc < 0 && errno != EINTR) {
|
if (irc < 0 && errno != EINTR) {
|
emsg.InitErrno("RlinkPort::Write()", "write() failed : ", errno);
|
emsg.InitErrno("RlinkPort::Write()", "write() failed : ", errno);
|
if (fspLog && fTraceLevel>0) fspLog->Write(emsg.Message(), 'E');
|
if (fspLog && fTraceLevel>0) fspLog->Write(emsg.Message(), 'E');
|
return kErr;
|
return kErr;
|
}
|
}
|
}
|
}
|
// FIXME_code: handle eof ??
|
// FIXME_code: handle eof ??
|
ndone += irc;
|
ndone += irc;
|
}
|
}
|
|
|
fStats.Inc(kStatNPortTxByt, double(ndone));
|
fStats.Inc(kStatNPortTxByt, double(ndone));
|
|
|
return ndone;
|
return ndone;
|
}
|
}
|
|
|
//------------------------------------------+-----------------------------------
|
//------------------------------------------+-----------------------------------
|
//! FIXME_docs
|
//! FIXME_docs
|
|
|
bool RlinkPort::PollRead(double timeout)
|
bool RlinkPort::PollRead(double timeout)
|
{
|
{
|
if (! IsOpen())
|
if (! IsOpen())
|
throw Rexception("RlinkPort::PollRead()","Bad state: port not open");
|
throw Rexception("RlinkPort::PollRead()","Bad state: port not open");
|
if (timeout < 0.)
|
if (timeout < 0.)
|
throw Rexception("RlinkPort::PollRead()","Bad args: timeout < 0");
|
throw Rexception("RlinkPort::PollRead()","Bad args: timeout < 0");
|
|
|
int ito = 1000.*timeout + 0.1;
|
int ito = 1000.*timeout + 0.1;
|
|
|
struct pollfd fds[1] = {{fFdRead, // fd
|
struct pollfd fds[1] = {{fFdRead, // fd
|
POLLIN, // events
|
POLLIN, // events
|
0}}; // revents
|
0}}; // revents
|
|
|
|
|
int irc = -1;
|
int irc = -1;
|
while (irc < 0) {
|
while (irc < 0) {
|
irc = poll(fds, 1, ito);
|
irc = poll(fds, 1, ito);
|
if (irc < 0 && errno != EINTR)
|
if (irc < 0 && errno != EINTR)
|
throw Rexception("RlinkPort::PollRead()","poll() failed: rc<0: ", errno);
|
throw Rexception("RlinkPort::PollRead()","poll() failed: rc<0: ", errno);
|
}
|
}
|
|
|
if (irc == 0) return false;
|
if (irc == 0) return false;
|
|
|
if (fds[0].revents == POLLERR)
|
if (fds[0].revents == POLLERR)
|
throw Rexception("RlinkPort::PollRead()", "poll() failed: POLLERR");
|
throw Rexception("RlinkPort::PollRead()", "poll() failed: POLLERR");
|
|
|
return true;
|
return true;
|
}
|
}
|
|
|
//------------------------------------------+-----------------------------------
|
//------------------------------------------+-----------------------------------
|
//! FIXME_docs
|
//! FIXME_docs
|
int RlinkPort::RawRead(uint8_t* buf, size_t size, bool exactsize,
|
int RlinkPort::RawRead(uint8_t* buf, size_t size, bool exactsize,
|
double timeout, double& tused, RerrMsg& emsg)
|
double timeout, double& tused, RerrMsg& emsg)
|
{
|
{
|
if (timeout <= 0.)
|
if (timeout <= 0.)
|
throw Rexception("RlinkPort::RawRead()", "Bad args: timeout <= 0.");
|
throw Rexception("RlinkPort::RawRead()", "Bad args: timeout <= 0.");
|
if (size <= 0)
|
if (size <= 0)
|
throw Rexception("RlinkPort::RawRead()", "Bad args: size <= 0");
|
throw Rexception("RlinkPort::RawRead()", "Bad args: size <= 0");
|
|
|
fStats.Inc(kStatNPortRawRead);
|
fStats.Inc(kStatNPortRawRead);
|
tused = 0.;
|
tused = 0.;
|
|
|
struct timeval tval;
|
struct timeval tval;
|
gettimeofday(&tval, 0);
|
gettimeofday(&tval, 0);
|
double tbeg = double(tval.tv_sec) + 1.e-6*double(tval.tv_usec);
|
double tbeg = double(tval.tv_sec) + 1.e-6*double(tval.tv_usec);
|
double trest = timeout;
|
double trest = timeout;
|
|
|
size_t ndone = 0;
|
size_t ndone = 0;
|
while (trest>0. && ndone<size) {
|
while (trest>0. && ndone<size) {
|
int irc = Read(buf+ndone, size-ndone, trest, emsg);
|
int irc = Read(buf+ndone, size-ndone, trest, emsg);
|
gettimeofday(&tval, 0);
|
gettimeofday(&tval, 0);
|
double tend = double(tval.tv_sec) + 1.e-6*double(tval.tv_usec);
|
double tend = double(tval.tv_sec) + 1.e-6*double(tval.tv_usec);
|
tused = tend - tbeg;
|
tused = tend - tbeg;
|
if (irc <= 0) return irc;
|
if (irc <= 0) return irc;
|
if (!exactsize) break;
|
if (!exactsize) break;
|
|
|
trest -= (tend-tbeg);
|
trest -= (tend-tbeg);
|
ndone += irc;
|
ndone += irc;
|
}
|
}
|
|
|
return (int)ndone;
|
return (int)ndone;
|
}
|
}
|
|
|
//------------------------------------------+-----------------------------------
|
//------------------------------------------+-----------------------------------
|
//! FIXME_docs
|
//! FIXME_docs
|
int RlinkPort::RawWrite(const uint8_t* buf, size_t size, RerrMsg& emsg)
|
int RlinkPort::RawWrite(const uint8_t* buf, size_t size, RerrMsg& emsg)
|
{
|
{
|
fStats.Inc(kStatNPortRawWrite);
|
fStats.Inc(kStatNPortRawWrite);
|
return Write(buf, size, emsg);
|
return Write(buf, size, emsg);
|
}
|
}
|
|
|
//------------------------------------------+-----------------------------------
|
//------------------------------------------+-----------------------------------
|
//! FIXME_docs
|
//! FIXME_docs
|
|
|
void RlinkPort::Dump(std::ostream& os, int ind, const char* text) const
|
void RlinkPort::Dump(std::ostream& os, int ind, const char* text) const
|
{
|
{
|
RosFill bl(ind);
|
RosFill bl(ind);
|
os << bl << (text?text:"--") << "RlinkPort @ " << this << endl;
|
os << bl << (text?text:"--") << "RlinkPort @ " << this << endl;
|
|
|
os << bl << " fIsOpen: " << (int)fIsOpen << endl;
|
os << bl << " fIsOpen: " << (int)fIsOpen << endl;
|
fUrl.Dump(os, ind+2, "fUrl: ");
|
fUrl.Dump(os, ind+2, "fUrl: ");
|
os << bl << " fFdRead: " << fFdRead << endl;
|
os << bl << " fFdRead: " << fFdRead << endl;
|
os << bl << " fFdWrite: " << fFdWrite << endl;
|
os << bl << " fFdWrite: " << fFdWrite << endl;
|
os << bl << " fspLog: " << fspLog.get() << endl;
|
os << bl << " fspLog: " << fspLog.get() << endl;
|
os << bl << " fTraceLevel: " << fTraceLevel << endl;
|
os << bl << " fTraceLevel: " << fTraceLevel << endl;
|
fStats.Dump(os, ind+2, "fStats: ");
|
fStats.Dump(os, ind+2, "fStats: ");
|
return;
|
return;
|
}
|
}
|
|
|
//------------------------------------------+-----------------------------------
|
//------------------------------------------+-----------------------------------
|
//! FIXME_docs
|
//! FIXME_docs
|
|
|
void RlinkPort::CloseFd(int& fd)
|
void RlinkPort::CloseFd(int& fd)
|
{
|
{
|
if (fd >= 0) {
|
if (fd >= 0) {
|
close(fd);
|
close(fd);
|
fd = -1;
|
fd = -1;
|
}
|
}
|
return;
|
return;
|
}
|
}
|
|
|
} // end namespace Retro
|
} // end namespace Retro
|
|
|