/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */

/*

 * Copyright (c) 2008,2009 IITP RAS

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License version 2 as

 * published by the Free Software Foundation;

 *

 * 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 General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 *

 * Author: Kirill Andreev <andreev@iitp.ru>

 */

#ifndef HWMP_RTABLE_H

#define HWMP_RTABLE_H

#include <map>

#include "ns3/nstime.h"

#include "ns3/mac48-address.h"

#include "ie-dot11s-perr.h"

/**

 * \ingroup dot11s

 *

 * \brief Routing table for HWMP -- 802.11s routing protocol

 */

class HwmpRtable : public Object

{

public:

  /// Means all interfaces

  const static uint32_t INTERFACE_ANY = 0xffffffff;

  /// Maximum (the best?) path metric

  const static uint32_t MAX_METRIC = 0xffffffff;

  /// Route lookup result, return type of LookupXXX methods

  struct LookupResult

  {

    Mac48Address retransmitter;

    uint32_t ifIndex;

    uint32_t metric;

    uint32_t seqnum;

    Time lifetime;

    LookupResult (Mac48Address r = Mac48Address::GetBroadcast (),

                 uint32_t i = INTERFACE_ANY,

                 uint32_t m = MAX_METRIC,

                 uint32_t s = 0,

                 Time l = Seconds (0.0))

      : retransmitter (r),

        ifIndex (i),

        metric (m),

        seqnum (s),

        lifetime (l)

    {

    }

    /// True for valid route

    bool IsValid () const;

    /// Compare route lookup results, used by tests

    bool operator==(const LookupResult & o) const;

  };

  /// Path precursor = {MAC, interface ID}

  typedef std::vector<std::pair<uint32_t, Mac48Address> > PrecursorList;

public:

  static TypeId GetTypeId ();

  HwmpRtable ();

  ~HwmpRtable ();

  void DoDispose ();

  ///\name Add/delete paths

  //\{

  void AddReactivePath (

    Mac48Address destination,

    Mac48Address retransmitter,

    uint32_t interface,

    uint32_t metric,

    Time  lifetime,

    uint32_t seqnum

  );

  void AddProactivePath (

    uint32_t metric,

    Mac48Address root,

    Mac48Address retransmitter,

    uint32_t interface,

    Time  lifetime,

    uint32_t seqnum

  );

  void AddPrecursor (Mac48Address destination, uint32_t precursorInterface, Mac48Address precursorAddress);

  PrecursorList GetPrecursors (Mac48Address destination);

  void DeleteProactivePath ();

  void DeleteProactivePath (Mac48Address root);

  void DeleteReactivePath (Mac48Address destination);

  //\}

  ///\name Lookup

  //\{

  /// Lookup path to destination

  LookupResult LookupReactive (Mac48Address destination);

  /// Return all reactive paths, including expired

  LookupResult LookupReactiveExpired (Mac48Address destination);

  /// Find proactive path to tree root. Note that calling this method has side effect of deleting expired proactive path

  LookupResult LookupProactive ();

  /// Return all proactive paths, including expired

  LookupResult LookupProactiveExpired ();

  //\}

  /// When peer link with a given MAC-address fails - it returns list of unreachable destination addresses

  std::vector<IePerr::FailedDestination> GetUnreachableDestinations (Mac48Address peerAddress);

private:

  /// Route found in reactive mode

  struct ReactiveRoute

  {

    Mac48Address retransmitter;

    uint32_t interface;

    uint32_t metric;

    Time whenExpire;

    uint32_t seqnum;

    std::vector<std::pair<uint32_t, Mac48Address> > precursors;

  };

  /// Route fond in proactive mode

  struct ProactiveRoute

  {

    Mac48Address root;

    Mac48Address retransmitter;

    uint32_t interface;

    uint32_t metric;

    Time whenExpire;

    uint32_t seqnum;

    std::vector<std::pair<uint32_t, Mac48Address> > precursors;

  };

  /// List of routes

  std::map<Mac48Address, ReactiveRoute>  m_routes;

  /// Path to proactive tree root MP

  ProactiveRoute  m_root;

};

} //namespace dot11s

} //namespace ns3

#endif