TCP.h

Go to the documentation of this file.

//
// Copyright (C) 2004 Andras Varga
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this program; if not, see <http://www.gnu.org/licenses/>.
//

#ifndef __INET_TCPMAIN_H
#define __INET_TCPMAIN_H

#include <map>
#include <set>
#include <omnetpp.h>
#include "IPvXAddress.h"


class TCPConnection;
class TCPSegment;

// macro for normal ev<< logging (Note: deliberately no parens in macro def)
#define tcpEV (ev.disable_tracing||TCP::testing)?ev:ev

// macro for more verbose ev<< logging (Note: deliberately no parens in macro def)
#define tcpEV2 (ev.disable_tracing||TCP::testing||!TCP::logverbose)?ev:ev

// testingEV writes log that automated test cases can check (*.test files)
#define testingEV (ev.disable_tracing||!TCP::testing)?ev:ev





class INET_API TCP : public cSimpleModule
{
  public:
    struct AppConnKey  // XXX this class is redundant since connId is already globally unique
    {
        int appGateIndex;
        int connId;

        inline bool operator<(const AppConnKey& b) const
        {
            if (appGateIndex!=b.appGateIndex)
                return appGateIndex<b.appGateIndex;
            else
                return connId<b.connId;
        }

    };
    struct SockPair
    {
        IPvXAddress localAddr;
        IPvXAddress remoteAddr;
        int localPort;   // -1: unspec
        int remotePort;  // -1: unspec

        inline bool operator<(const SockPair& b) const
        {
            if (remoteAddr!=b.remoteAddr)
                return remoteAddr<b.remoteAddr;
            else if (localAddr!=b.localAddr)
                return localAddr<b.localAddr;
            else if (remotePort!=b.remotePort)
                return remotePort<b.remotePort;
            else
                return localPort<b.localPort;
        }
    };

  protected:
    typedef std::map<AppConnKey,TCPConnection*> TcpAppConnMap;
    typedef std::map<SockPair,TCPConnection*> TcpConnMap;

    TcpAppConnMap tcpAppConnMap;
    TcpConnMap tcpConnMap;

    ushort lastEphemeralPort;
    std::multiset<ushort> usedEphemeralPorts;

  protected:
    virtual TCPConnection *createConnection(int appGateIndex, int connId);

    // utility methods
    virtual TCPConnection *findConnForSegment(TCPSegment *tcpseg, IPvXAddress srcAddr, IPvXAddress destAddr);
    virtual TCPConnection *findConnForApp(int appGateIndex, int connId);
    virtual void segmentArrivalWhileClosed(TCPSegment *tcpseg, IPvXAddress src, IPvXAddress dest);
    virtual void removeConnection(TCPConnection *conn);
    virtual void updateDisplayString();

  public:
    static bool testing;    // switches between tcpEV and testingEV
    static bool logverbose; // if !testing, turns on more verbose logging

    bool recordStatistics;  // output vectors on/off

  public:
    TCP() {}
    virtual ~TCP();

  protected:
    virtual void initialize();
    virtual void handleMessage(cMessage *msg);
    virtual void finish();

  public:
    virtual void addSockPair(TCPConnection *conn, IPvXAddress localAddr, IPvXAddress remoteAddr, int localPort, int remotePort);

    virtual void updateSockPair(TCPConnection *conn, IPvXAddress localAddr, IPvXAddress remoteAddr, int localPort, int remotePort);

    virtual void addForkedConnection(TCPConnection *conn, TCPConnection *newConn, IPvXAddress localAddr, IPvXAddress remoteAddr, int localPort, int remotePort);

    virtual ushort getEphemeralPort();
};

#endif