Ieee80211Mac.h

Go to the documentation of this file.

//
// Copyright (C) 2006 Andras Varga and Levente M�sz�ros
//
// 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 IEEE_80211_MAC_H
#define IEEE_80211_MAC_H

// uncomment this if you do not want to log state machine transitions
#define FSM_DEBUG

#include <list>
#include "WirelessMacBase.h"
#include "IPassiveQueue.h"
#include "Ieee80211Frame_m.h"
#include "Ieee80211Consts.h"
#include "NotificationBoard.h"
#include "RadioState.h"
#include "FSMA.h"

class INET_API Ieee80211Mac : public WirelessMacBase, public INotifiable
{
  typedef std::list<Ieee80211DataOrMgmtFrame*> Ieee80211DataOrMgmtFrameList;

  struct Ieee80211ASFTuple
  {
      MACAddress address;
      int sequenceNumber;
      int fragmentNumber;
  };

  typedef std::list<Ieee80211ASFTuple*> Ieee80211ASFTupleList;

  protected:
    MACAddress address;

    double bitrate;

    double basicBitrate;

    int maxQueueSize;

    int rtsThreshold;

    int transmissionLimit;

    int cwMinData;

    int cwMinBroadcast;

    static const int fragmentationThreshold = 2346;

  public:
    // don't forget to keep synchronized the C++ enum and the runtime enum definition
    enum State {
        IDLE,
        DEFER,
        WAITDIFS,
        BACKOFF,
        WAITACK,
        WAITBROADCAST,
        WAITCTS,
        WAITSIFS,
        RECEIVE,
    };
  protected:
    cFSM fsm;

  public:
    enum Mode {
        DCF,  
        PCF,  
    };
  protected:
    Mode mode;

    int sequenceNumber;

    bool lastReceiveFailed;

    bool backoff;

    bool nav;

    simtime_t backoffPeriod;

    int retryCounter;

    RadioState::State radioState;

    Ieee80211DataOrMgmtFrameList transmissionQueue;

    Ieee80211ASFTupleList asfTuplesList;

    IPassiveQueue *queueModule;

    cMessage *pendingRadioConfigMsg;

  protected:
    cMessage *endSIFS;

    cMessage *endDIFS;

    cMessage *endBackoff;

    cMessage *endTimeout;

    cMessage *endReserve;

    cMessage *mediumStateChange;

  protected:
    long numRetry;
    long numSentWithoutRetry;
    long numGivenUp;
    long numCollision;
    long numSent;
    long numReceived;
    long numSentBroadcast;
    long numReceivedBroadcast;
    cOutVector stateVector;
    cOutVector radioStateVector;

  public:
    Ieee80211Mac();
    virtual ~Ieee80211Mac();

  protected:
    virtual int numInitStages() const {return 2;}
    virtual void initialize(int);
    virtual void registerInterface();
    virtual void initializeQueueModule();

  protected:
    virtual void receiveChangeNotification(int category, const cPolymorphic * details);

    virtual void handleCommand(cMessage *msg);

    virtual void handleSelfMsg(cMessage *msg);

    virtual void handleUpperMsg(cPacket *msg);

    virtual void handleLowerMsg(cPacket *msg);

    virtual void handleWithFSM(cMessage *msg);

  protected:
    virtual simtime_t getSIFS();
    virtual simtime_t getSlotTime();
    virtual simtime_t getDIFS();
    virtual simtime_t getEIFS();
    virtual simtime_t getPIFS();
    virtual simtime_t computeBackoffPeriod(Ieee80211Frame *msg, int r);

  protected:
    virtual void scheduleSIFSPeriod(Ieee80211Frame *frame);

    virtual void scheduleDIFSPeriod();
    virtual void cancelDIFSPeriod();

    virtual void scheduleDataTimeoutPeriod(Ieee80211DataOrMgmtFrame *frame);
    virtual void scheduleBroadcastTimeoutPeriod(Ieee80211DataOrMgmtFrame *frame);
    virtual void cancelTimeoutPeriod();

    virtual void scheduleCTSTimeoutPeriod();

    virtual void scheduleReservePeriod(Ieee80211Frame *frame);

    virtual void invalidateBackoffPeriod();
    virtual bool isInvalidBackoffPeriod();
    virtual void generateBackoffPeriod();
    virtual void decreaseBackoffPeriod();
    virtual void scheduleBackoffPeriod();
    virtual void cancelBackoffPeriod();

  protected:
    virtual void sendACKFrameOnEndSIFS();
    virtual void sendACKFrame(Ieee80211DataOrMgmtFrame *frame);
    virtual void sendRTSFrame(Ieee80211DataOrMgmtFrame *frameToSend);
    virtual void sendCTSFrameOnEndSIFS();
    virtual void sendCTSFrame(Ieee80211RTSFrame *rtsFrame);
    virtual void sendDataFrameOnEndSIFS(Ieee80211DataOrMgmtFrame *frameToSend);
    virtual void sendDataFrame(Ieee80211DataOrMgmtFrame *frameToSend);
    virtual void sendBroadcastFrame(Ieee80211DataOrMgmtFrame *frameToSend);

  protected:
    virtual Ieee80211DataOrMgmtFrame *buildDataFrame(Ieee80211DataOrMgmtFrame *frameToSend);
    virtual Ieee80211ACKFrame *buildACKFrame(Ieee80211DataOrMgmtFrame *frameToACK);
    virtual Ieee80211RTSFrame *buildRTSFrame(Ieee80211DataOrMgmtFrame *frameToSend);
    virtual Ieee80211CTSFrame *buildCTSFrame(Ieee80211RTSFrame *rtsFrame);
    virtual Ieee80211DataOrMgmtFrame *buildBroadcastFrame(Ieee80211DataOrMgmtFrame *frameToSend);

    virtual Ieee80211Frame *setBasicBitrate(Ieee80211Frame *frame);

  protected:
    virtual void finishCurrentTransmission();
    virtual void giveUpCurrentTransmission();
    virtual void retryCurrentTransmission();

    virtual void sendDownPendingRadioConfigMsg();

    virtual void setMode(Mode mode);

    virtual Ieee80211DataOrMgmtFrame *getCurrentTransmission();

    virtual void resetStateVariables();

    virtual bool isMediumStateChange(cMessage *msg);

    virtual bool isMediumFree();

    virtual bool isBroadcast(Ieee80211Frame *msg);

    virtual bool isForUs(Ieee80211Frame *msg);

    virtual bool isDataOrMgmtFrame(Ieee80211Frame *frame);

    virtual Ieee80211Frame *getFrameReceivedBeforeSIFS();

    virtual void popTransmissionQueue();

    virtual double computeFrameDuration(Ieee80211Frame *msg);
    virtual double computeFrameDuration(int bits, double bitrate);

    virtual void logState();

    const char *modeName(int mode);
};

#endif