csma.h

/* -*- mode:c++ -*- ********************************************************
 * file:        csma.h
 *
  * author:     Jerome Rousselot, Marcel Steine, Amre El-Hoiydi,
 *        Marc Loebbers, Yosia Hadisusanto
 *
 * copyright: (C) 2007-2009 CSEM SA
 *        (C) 2009 T.U. Eindhoven
 *        (C) 2004 Telecommunication Networks Group (TKN) at
 *              Technische Universitaet Berlin, Germany.
 *
 *              This program is free software; you can redistribute it
 *              and/or modify it under the terms of the GNU General Public
 *              License as published by the Free Software Foundation; either
 *              version 2 of the License, or (at your option) any later
 *              version.
 *              For further information see file COPYING
 *              in the top level directory
 *
 * Funding: This work was partially financed by the European Commission under the
 * Framework 6 IST Project "Wirelessly Accessible Sensor Populations"
 * (WASP) under contract IST-034963.
 ***************************************************************************
 * part of:    Modifications to the MF-2 framework by CSEM
 **************************************************************************/


#ifndef csma_H
#define csma_H


#include <string>
#include <sstream>
#include <vector>
#include <list>
#include "BaseMacLayer.h"
#include <DroppedPacket.h>
#include <MacPkt_m.h>

class  csma : public BaseMacLayer
{
  public:


  ~csma();

    virtual void initialize(int);

    virtual void finish();

    virtual void handleLowerMsg(cMessage*);

    virtual void handleUpperMsg(cMessage*);

    virtual void handleSelfMsg(cMessage*);

    virtual void handleLowerControl(cMessage *msg);

  protected:
    typedef std::list<MacPkt*> MacQueue;

  long nbTxFrames;
  long nbRxFrames;
  long nbMissedAcks;
  long nbRecvdAcks;
  long nbDroppedFrames;
  long nbTxAcks;
  long nbDuplicates;
  long nbBackoffs;
  double backoffValues;
  bool stats;
  bool trace;

    enum t_mac_states {
        IDLE_1=1,
        BACKOFF_2,
        CCA_3,
        TRANSMITFRAME_4,
        WAITACK_5,
        WAITSIFS_6,
        TRANSMITACK_7

    };

    /*************************************************************/
    /****************** TYPES ************************************/
    /*************************************************************/

    enum t_mac_timer {
      TIMER_NULL=0,
      TIMER_BACKOFF,
      TIMER_CCA,
      TIMER_SIFS,
      TIMER_RX_ACK,
    };

    cMessage * backoffTimer, * ccaTimer, * txTimer, * sifsTimer, * rxAckTimer;
    enum t_mac_event {
      EV_SEND_REQUEST=1,                   // 1, 11, 20, 21, 22
      EV_TIMER_BACKOFF,                    // 2, 7, 14, 15
      EV_FRAME_TRANSMITTED,                // 4, 19
      EV_ACK_RECEIVED,                     // 5
      EV_ACK_TIMEOUT,                      // 12
      EV_FRAME_RECEIVED,                   // 15, 26
      EV_DUPLICATE_RECEIVED,
      EV_TIMER_SIFS,                       // 17
      EV_BROADCAST_RECEIVED,       // 23, 24
      EV_TIMER_CCA
    };

    enum t_csma_frame_types {
      DATA,
      ACK
    };

    enum t_mac_carrier_sensed {
      CHANNEL_BUSY=1,
      CHANNEL_FREE
    } ;

    enum t_mac_status {
      STATUS_OK=1,
      STATUS_ERROR,
      STATUS_RX_ERROR,
      STATUS_RX_TIMEOUT,
      STATUS_FRAME_TO_PROCESS,
      STATUS_NO_FRAME_TO_PROCESS,
      STATUS_FRAME_TRANSMITTED
    };

    enum backoff_methods {
      CONSTANT = 0,
      LINEAR,
      EXPONENTIAL,
    };

    t_mac_states macState;
    t_mac_status status;

    simtime_t sifs;

    simtime_t macAckWaitDuration;

    bool transmissionAttemptInterruptedByRx;
    simtime_t ccaDetectionTime;
    simtime_t rxSetupTime;
    simtime_t aTurnaroundTime;
    int macMaxCSMABackoffs;
    unsigned int macMaxFrameRetries;
    simtime_t aUnitBackoffPeriod;
    bool useMACAcks;

    backoff_methods backoffMethod;

  int macMinBE;
  int macMaxBE;

  double initialCW;

    double txPower;

    int NB;

    MacQueue macQueue;

    unsigned int queueLength;

    unsigned int txAttempts;

    double bitrate;

    DroppedPacket droppedPacket;

    int catDroppedPacket;

    int nicId;

    int ackLength;

    //int macaddress;


protected:
  // FSM functions
  void fsmError(t_mac_event event, cMessage *msg);
  void executeMac(t_mac_event event, cMessage *msg);
  void updateStatusIdle(t_mac_event event, cMessage *msg);
  void updateStatusBackoff(t_mac_event event, cMessage *msg);
  void updateStatusCCA(t_mac_event event, cMessage *msg);
  void updateStatusTransmitFrame(t_mac_event event, cMessage *msg);
  void updateStatusWaitAck(t_mac_event event, cMessage *msg);
  void updateStatusSIFS(t_mac_event event, cMessage *msg);
  void updateStatusTransmitAck(t_mac_event event, cMessage *msg);
  void updateStatusNotIdle(cMessage *msg);
  void manageQueue();
  void updateMacState(t_mac_states newMacState);

  void attachSignal(MacPkt* mac, simtime_t startTime);
  void manageMissingAck(t_mac_event event, cMessage *msg);
  void startTimer(t_mac_timer timer);

  virtual simtime_t scheduleBackoff();

  virtual cPacket *decapsMsg(MacPkt * macPkt);
  MacPkt * ackMessage;

  //sequence number for sending, map for the general case with more senders
  //also in initialisation phase multiple potential parents
  std::map<int, unsigned long> SeqNrParent; //parent -> sequence number

  //sequence numbers for receiving
  std::map<int, unsigned long> SeqNrChild; //child -> sequence number

};

#endif