pana_session.cxx

Diameter协议栈

/* BEGIN_COPYRIGHT                                                        */
/*                                                                        */
/* Open Diameter: Open-source software for the Diameter and               */
/*                Diameter related protocols                              */
/*                                                                        */
/* Copyright (C) 2002-2004 Open Diameter Project                          */
/*                                                                        */
/* This library 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.1 of the   */
/* License, or (at your option) any later version.                        */
/*                                                                        */
/* This library 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 library; if not, write to the Free Software    */
/* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307    */
/* USA.                                                                   */
/*                                                                        */
/* In addition, when you copy and redistribute some or the entire part of */
/* the source code of this software with or without modification, you     */
/* MUST include this copyright notice in each copy.                       */
/*                                                                        */
/* If you make any changes that are appeared to be useful, please send    */
/* sources that include the changed part to                               */
/* [e-mail] so that we can reflect your  */
/* changes to one unified version of this software.                       */
/*                                                                        */
/* END_COPYRIGHT                                                          */

#include "ace/OS.h"
#include "pana_exceptions.h"
#include "pana_session.h"
#include "pana_memory_manager.h"

bool PANA_SessionTimerInterface::ScheduleTxRetry()
{
   /*
     9.  Retransmission Timers

        The PANA protocol provides retransmissions for the PANA-PAA-Discover
        message and all request messages, with the exception that the PANA-
        Start-Answer message is retransmitted instead of the PANA-Start-
        Request message in stateless PAA discovery.

        PANA retransmission timers are based on the model used in DHCPv6
        [RFC3315].  Variables used here are also borrowed from this
        specification.  PANA is a request response like protocol.  The
        message exchange terminates when either the request sender
        successfully receives the appropriate answer, or when the message
        exchange is considered to have failed according to the retransmission
        mechanism described below.

        The retransmission behavior is controlled and described by the
        following variables:

         RT     Retransmission timeout

         IRT    Initial retransmission time

         MRC    Maximum retransmission count

         MRT    Maximum retransmission time

         MRD    Maximum retransmission duration

         RAND   Randomization factor

        With each message transmission or retransmission, the sender sets RT
        according to the rules given below.  If RT expires before the message
        exchange terminates, the sender recomputes RT and retransmits the
        message.

        Each of the computations of a new RT include a randomization factor
        (RAND), which is a random number chosen with a uniform distribution
        between -0.1 and +0.1.  The randomization factor is included to
        minimize synchronization of messages.

        The algorithm for choosing a random number does not need to be
        cryptographically sound.  The algorithm SHOULD produce a different
        sequence of random numbers from each invocation.
        
        RT for the first message transmission is based on IRT:

            RT = IRT + RAND*IRT
   */
   unsigned int newRt = PANA_CFG_GENERAL().m_RT.m_IRT +
              int(RAND()*float(PANA_CFG_GENERAL().m_RT.m_IRT));
   if (newRt > PANA_CFG_GENERAL().m_RT.m_MRT) {
       newRt = PANA_CFG_GENERAL().m_RT.m_MRT + 
       int(RAND()*float(PANA_CFG_GENERAL().m_RT.m_MRT));
       return false;
   }
            
   m_Timeout = newRt;
   m_Duration = newRt;
   m_Count = 1;

   // schedule the timer
   Schedule(PANA_TID_RETRY, m_Timeout);
   return (true);
}

bool PANA_SessionTimerInterface::ReScheduleTxRetry() 
{
   /*
      RT for each subsequent message transmission is based on the previous
      value of RT:

         RT = 2*RTprev + RAND*RTprev

      MRT specifies an upper bound on the value of RT (disregarding the
      randomization added by the use of RAND).  If MRT has a value of 0,
      there is no upper limit on the value of RT.  Otherwise:

         if (RT > MRT)
            RT = MRT + RAND*MRT

      MRC specifies an upper bound on the number of times a sender may
      retransmit a message.  Unless MRC is zero, the message exchange fails
      once the sender has transmitted the message MRC times.

      MRD specifies an upper bound on the length of time a sender may
      retransmit a message.  Unless MRD is zero, the message exchange fails
      once MRD seconds have elapsed since the client first transmitted the
      message.

      If both MRC and MRD are non-zero, the message exchange fails whenever
      either of the conditions specified in the previous two paragraphs are
      met.

      If both MRC and MRD are zero, the client continues to transmit the
      message until it receives a response.
    */
    
   // cancel any pending timers
   CancelTxRetry();
   unsigned int newRt = 2*m_Timeout + 
               int(RAND()*float(m_Timeout));

   if (newRt > PANA_CFG_GENERAL().m_RT.m_MRT) {
       newRt = PANA_CFG_GENERAL().m_RT.m_MRT + 
       int(RAND()*float(PANA_CFG_GENERAL().m_RT.m_MRT));
   }
            
   if ((PANA_CFG_GENERAL().m_RT.m_MRC > 0) &&
       (m_Count >= PANA_CFG_GENERAL().m_RT.m_MRC)) {
       return (false);
   }
            
   if ((PANA_CFG_GENERAL().m_RT.m_MRD > 0) &&
       ((m_Duration + newRt) > PANA_CFG_GENERAL().m_RT.m_MRD)) {
       return (false);
   }
            
   m_Timeout = newRt;
   m_Duration += newRt;
   m_Count ++;

   // re-schedule the timer
   Schedule(PANA_TID_RETRY, m_Timeout);
   return (true);
}

void PANA_Session::NotifyScheduleLifetime(int gracePeriod)
{
    m_Timer.ScheduleSession(SessionLifetime() + gracePeriod);
}

bool PANA_Session::IsFatalError()
{
    // TBD: Needs work ... everything is fatal for the moment
    return true;
}

void PANA_Session::TxPUR()
{
    /*
      7.18  PANA-Update-Request (PUR)

        The PANA-Update-Request (PUR) message is sent either by the PaC or
        the PAA to deliver attribute updates and notifications.  In the scope
        of this specification only the PaC IP address can be updated via this
        mechanism.

         PANA-Update-Request ::= < PANA-Header: 10, REQ >
                                 < Session-Id >
                                 [ Notification ]
                              *  [ AVP ]
                             0*1 < AUTH >
     */
    boost::shared_ptr<PANA_Message> msg(new PANA_Message);

    // Populate header
    msg->type() = PANA_MTYPE_PUR;
    msg->flags().request = true;

    // adjust serial num
    ++ LastTxSeqNum();
    msg->seq() = LastTxSeqNum().Value();

    // add session id
    AAA_Utf8AvpWidget sessionIdAvp(PANA_AVPNAME_SESSIONID);
    sessionIdAvp.Get() = SessionId();
    msg->avpList().add(sessionIdAvp());

    // add notification if any       
    AddNotification(*msg);

    // auth avp if any
    if (SecurityAssociation().IsSet()) {
        SecurityAssociation().AddAuthAvp(*msg);
    }

    ACE_DEBUG((LM_INFO, "(%P|%t) TxPUR: S-flag %d, N-flag=%d, seq=%d\n",
               msg->flags().separate, msg->flags().nap, msg->seq()));

    SendReqMsg(msg);
}

void PANA_Session::TxPUA()
{
    /*
      7.19  PANA-Update-Answer (PUA)

        The PANA-Update-Answer (PUA) message is sent by the PAA (PaC) to the
        PaC (PAA) in response to a PANA-Update-Request from the PaC (PAA).

         PANA-Update-Answer ::= < PANA-Header: 10 >
                                < Session-Id >
                                [ Notification ]
                             *  [ AVP ]
                            0*1 < AUTH >
     */
    boost::shared_ptr<PANA_Message> msg(new PANA_Message);

    // Populate header
    msg->type() = PANA_MTYPE_PUA;
    msg->seq() = LastRxSeqNum().Value();

    // add session id
    AAA_Utf8AvpWidget sessionIdAvp(PANA_AVPNAME_SESSIONID);
    sessionIdAvp.Get() = SessionId();
    msg->avpList().add(sessionIdAvp());

    // add notification if any       
    AddNotification(*msg);

    // auth avp if any
    if (SecurityAssociation().IsSet()) {
        SecurityAssociation().AddAuthAvp(*msg);
    }

    ACE_DEBUG((LM_INFO, "(%P|%t) TxPUA: S-flag %d, N-flag=%d, seq=%d\n",
               msg->flags().separate, msg->flags().nap, msg->seq()));

    SendAnsMsg(msg);
}

void PANA_Session::TxPPR()
{
    /*
     7.10  PANA-Ping-Request (PPR)

      The PANA-Ping-Request (PPR) message is either sent by the PaC or the
      PAA for performing liveness test.

       PANA-Ping-Request ::= < PANA-Header: 6, REQ >
                             < Session-Id >
                             [ Notification ]
                          *  [ AVP ]
                         0*1 < AUTH >
     */
    boost::shared_ptr<PANA_Message> msg(new PANA_Message);

    // Populate header
    msg->type() = PANA_MTYPE_PPR;
    msg->flags().request = true;

    // adjust serial num
    ++ LastTxSeqNum();
    msg->seq() = LastTxSeqNum().Value();

    // add session id
    AAA_Utf8AvpWidget sessionIdAvp(PANA_AVPNAME_SESSIONID);
    sessionIdAvp.Get() = SessionId();
    msg->avpList().add(sessionIdAvp());

    // add notification if any       
    AddNotification(*msg);

    // auth avp if any
    if (SecurityAssociation().IsSet()) {
        SecurityAssociation().AddAuthAvp(*msg);
    }

    ACE_DEBUG((LM_INFO, "(%P|%t) TxPPR: S-flag %d, N-flag=%d, seq=%d\n",
               msg->flags().separate, msg->flags().nap, msg->seq()));

    SendReqMsg(msg);
}

void PANA_Session::RxPUA()
{
    /*
      7.19  PANA-Update-Answer (PUA)

        The PANA-Update-Answer (PUA) message is sent by the PAA (PaC) to the
        PaC (PAA) in response to a PANA-Update-Request from the PaC (PAA).

         PANA-Update-Answer ::= < PANA-Header: 10 >
                                < Session-Id >
                                [ Notification ]
                             *  [ AVP ]
                            0*1 < AUTH >
     */
    std::auto_ptr<PANA_Message> cleanup(AuxVariables().
        RxMsgQueue().Dequeue());
    PANA_Message &msg = *cleanup;

    ACE_DEBUG((LM_INFO, "(%P|%t) RxPUA: S-flag %d, N-flag=%d, seq=%d\n",
               msg.flags().separate, msg.flags().nap, msg.seq()));

    // process notification
    ProcessNotification(msg);

    // RtxTimerStop()
    m_Timer.CancelTxRetry();
}

void PANA_Session::RxPPR()
{
    /*
     7.10  PANA-Ping-Request (PPR)

      The PANA-Ping-Request (PPR) message is either sent by the PaC or the
      PAA for performing liveness test.

       PANA-Ping-Request ::= < PANA-Header: 6, REQ >
                             < Session-Id >
                             [ Notification ]
                          *  [ AVP ]
                         0*1 < AUTH >
     */
    std::auto_ptr<PANA_Message> cleanup(AuxVariables().
        RxMsgQueue().Dequeue());
    PANA_Message &msg = *cleanup;

    ACE_DEBUG((LM_INFO, "(%P|%t) RxPPR: S-flag %d, N-flag=%d, seq=%d\n",
               msg.flags().separate, msg.flags().nap, msg.seq()));

    // process notification
    ProcessNotification(msg);

    TxPPA();
}

void PANA_Session::RxPUR()
{
    /*
      7.18  PANA-Update-Request (PUR)

        The PANA-Update-Request (PUR) message is sent either by the PaC or
        the PAA to deliver attribute updates and notifications.  In the scope
        of this specification only the PaC IP address can be updated via this
        mechanism.

         PANA-Update-Request ::= < PANA-Header: 10, REQ >
                                 < Session-Id >
                                 [ Notification ]
                              *  [ AVP ]
                             0*1 < AUTH >
     */
    std::auto_ptr<PANA_Message> cleanup(AuxVariables().RxMsgQueue().Dequeue());
    PANA_Message &msg = *cleanup;

    ACE_DEBUG((LM_INFO, "(%P|%t) RxPUR: S-flag %d, N-flag=%d, seq=%d\n",
               msg.flags().separate, msg.flags().nap, msg.seq()));

    // process notification
    ProcessNotification(msg);

    TxPUA();
}

void PANA_Session::TxPPA()
{
    /*
      7.11  PANA-Ping-Answer (PPA)

       The PANA-Ping-Answer (PPA) message is sent in response to a PANA-
       Ping-Request.

        PANA-Ping-Answer ::= < PANA-Header: 6 >
                             < Session-Id >
                             [ Notification ]
                          *  [ AVP ]
                         0*1 < AUTH >
     */
    boost::shared_ptr<PANA_Message> msg(new PANA_Message);

    // Populate header
    msg->type() = PANA_MTYPE_PPA;
    msg->seq() = LastRxSeqNum().Value();

    // add session id
    AAA_Utf8AvpWidget sessionIdAvp(PANA_AVPNAME_SESSIONID);
    sessionIdAvp.Get() = SessionId();
    msg->avpList().add(sessionIdAvp());

    // add notification if any       
    AddNotification(*msg);

    // auth avp if any
    if (SecurityAssociation().IsSet()) {
        SecurityAssociation().AddAuthAvp(*msg);
    }

    ACE_DEBUG((LM_INFO, "(%P|%t) TxPPA: S-flag %d, N-flag=%d, seq=%d\n",
               msg->flags().separate, msg->flags().nap, msg->seq()));

    SendAnsMsg(msg);
}

void PANA_Session::RxPPA()
{
    /*
      7.11  PANA-Ping-Answer (PPA)

       The PANA-Ping-Answer (PPA) message is sent in response to a PANA-
       Ping-Request.

        PANA-Ping-Answer ::= < PANA-Header: 6 >
                             < Session-Id >
                             [ Notification ]
                          *  [ AVP ]
                         0*1 < AUTH >
     */
    std::auto_ptr<PANA_Message> cleanup(AuxVariables().
        RxMsgQueue().Dequeue());
    PANA_Message &msg = *cleanup;

    ACE_DEBUG((LM_INFO, "(%P|%t) RxPPA: S-flag %d, N-flag=%d, seq=%d\n",
               msg.flags().separate, msg.flags().nap, msg.seq()));

    // process notification
    ProcessNotification(msg);

    m_Timer.CancelTxRetry();
}

void PANA_Session::TxPTR(ACE_UINT32 cause)
{
    /*
     7.12  PANA-Termination-Request (PTR)

       The PANA-Termination-Request (PTR) message is sent either by the PaC
       or the PAA to terminate a PANA session.

       PANA-Termination-Request ::= < PANA-Header: 7, REQ >
                                    < Session-Id >
                                    < Termination-Cause >
                                    [ Notification ]
                                 *  [ AVP ]
                                0*1 < AUTH >
     */
    boost::shared_ptr<PANA_Message> msg(new PANA_Message);

    // Populate header
    msg->type() = PANA_MTYPE_PTR;
    msg->flags().request = true;

    // adjust serial num
    ++ LastTxSeqNum();
    msg->seq() = LastTxSeqNum().Value();

    // add session id
    AAA_Utf8AvpWidget sessionIdAvp(PANA_AVPNAME_SESSIONID);
    sessionIdAvp.Get() = SessionId();
    msg->avpList().add(sessionIdAvp());

    // termination cause
    AAA_UInt32AvpWidget causeAvp(PANA_AVPNAME_TERMCAUSE);
    causeAvp.Get() = ACE_HTONL(cause);