pana_client_fsm.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 "pana_client_fsm.h"

PANA_ClientStateTable PANA_PacSession::m_StateTable;
typedef PANA_SessionRxStateFilter<PANA_Client, PANA_PacSession>
            PANA_ClientRxStateFilter;

PANA_ClientStateTable::PANA_ClientStateTable() 
{
    PANA_PacEventVariable ev;

    // ------------------------------
    // State: OFFLINE (Initial State)
    // ------------------------------

    /////////////////////////////////////////////////////////////////
    // Rx:PSR &&                RtxTimerStop();            WAIT_EAP_MSG_
    // PSR.exist_avp            EAP_ReStart();             IN_DISC
    // ("EAP-Payload")          TxEAP();
    //                          SEPARATE=Unset;
    //
    ev.Reset();
    ev.MsgType(PANA_EV_MTYPE_PSR);
    ev.AvpExist_EapPayload();
    AddStateTableEntry(PANA_ST_OFFLINE, ev.Get(), 
                       PANA_ST_WAIT_EAP_MSG_IN_DISC, 
                       m_PacOfflineExitActionRxPSR);

    /////////////////////////////////////////////////////////////////
    // Rx:PSR &&                RtxTimerStop();            WAIT_PAA
    // !PSR.exist_avp           if (choose_isp())
    // ("EAP-Payload") &&         PSA.insert_avp("ISP");
    // PSR.S_flag==1 &&         PSA.S_flag=1;
    // SEPARATE==Set &&         PSA.insert_avp("Cookie");
    // PSR.exist_avp            Tx:PSA();
    // ("Cookie")               RtxTimerStart();
    //                          EAP_Restart();
    //
    ev.Reset();
    ev.MsgType(PANA_EV_MTYPE_PSR);
    ev.Do_Separate(); // PSR.S_flag==1 && SEPARATE==Set
    ev.AvpExist_Cookie();
    AddStateTableEntry(PANA_ST_OFFLINE, ev.Get(), 
                        PANA_ST_WAIT_PAA, 
                        m_PacOfflineExitActionRxPSR);

    /////////////////////////////////////////////////////////////////
    // Rx:PSR &&                RtxTimerStop();            WAIT_PAA
    // !PSR.exist_avp           if (choose_isp())
    // ("EAP-Payload") &&         PSA.insert_avp("ISP");
    // PSR.S_flag==1 &&         PSA.S_flag=1;
    // SEPARATE==Set &&         Tx:PSA();
    // !PSR.exist_avp           EAP_Restart();
    // ("Cookie")
    //
    ev.Reset();
    ev.MsgType(PANA_EV_MTYPE_PSR);
    ev.Do_Separate(); // PSR.S_flag==1 && SEPARATE==Set
    AddStateTableEntry(PANA_ST_OFFLINE, ev.Get(), 
                        PANA_ST_WAIT_PAA, 
                        m_PacOfflineExitActionRxPSR);

    /////////////////////////////////////////////////////////////////
    // Rx:PSR &&                RtxTimerStop();            WAIT_PAA
    // !PSR.exist_avp           if (choose_isp())
    // ("EAP-Payload") &&         PSA.insert_avp("ISP");
    // (PSA.S_flag!=1 ||        PSA.insert_avp("Cookie");
    // SEPARATE==Unset) &&      Tx:PSA();
    // PSR.exist_avp            RtxTimerStart();
    // ("Cookie")               SEPARATE=Unset;
    //                          EAP_Restart();
    // 
    ev.Reset();
    ev.MsgType(PANA_EV_MTYPE_PSR);
    ev.AvpExist_Cookie();
    AddStateTableEntry(PANA_ST_OFFLINE, ev.Get(), 
                        PANA_ST_WAIT_PAA, 
                        m_PacOfflineExitActionRxPSR);

    /////////////////////////////////////////////////////////////////
    // Rx:PSR &&                RtxTimerStop();            WAIT_PAA
    // !PSR.exist_avp           if (choose_isp())
    // ("EAP-Payload") &&         PSA.insert_avp("ISP");
    // (PSA.S_flag!=1 ||        Tx:PSA();
    // SEPARATE==Unset) &&      SEPARATE=Unset;
    // !PSR.exist_avp           EAP_Restart();
    // ("Cookie")
    //
    ev.Reset();
    ev.MsgType(PANA_EV_MTYPE_PSR);
    AddStateTableEntry(PANA_ST_OFFLINE, ev.Get(), 
                        PANA_ST_WAIT_PAA, 
                        m_PacOfflineExitActionRxPSR);

    /////////////////////////////////////////////////////////////////
    // - - - - - - - -(Authentication trigger from application) - - -
    // AUTH_USER                Tx:PDI();                  OFFLINE
    //                          RtxTimerStart();
    //
    ev.Reset();
    ev.Event_App(PANA_EV_APP_AUTH_USER);
    AddStateTableEntry(PANA_ST_OFFLINE, ev.Get(), 
                       PANA_ST_OFFLINE, 
                       m_PacOfflineExitActionAuthUser);

    /////////////////////////////////////////////////////////////////
    // Rx:PSR &&                RtxTimerStop();            WAIT_PAA
    // !PSR.exist_avp           PSA.insert_avp
    // ("EAP-Payload") &&       ("Session-Id");
    // MOBILITY==Set &&         SEPARATE=Unset;
    // resume_pana_sa() &&      PANA_SA_RESUMED=Set;
    // PSR.exist_avp            PSA.insert_avp("Cookie");
    // ("Cookie")               PSA.insert_avp("AUTH");
    //                          Tx:PSA();
    //                          RtxTimerStart();
    //                          
    ev.Reset();
    ev.MsgType(PANA_EV_MTYPE_PSR);
    ev.Do_ResumeSession(); // ((MOBILIT==Set) && resume_pana_sa())
    ev.AvpExist_Cookie();
    AddStateTableEntry(PANA_ST_OFFLINE, ev.Get(), 
                       PANA_ST_WAIT_PAA, 
                       m_PacOfflineExitActionRxPSR);

    /////////////////////////////////////////////////////////////////
    // Rx:PSR &&                RtxTimerStop();            WAIT_PAA
    // !PSR.exist_avp           PSA.insert_avp
    // ("EAP-Payload") &&       ("Session-Id");
    // MOBILITY==Set &&         PSA.insert_avp("AUTH");
    // resume_pana_sa() &&      Tx:PSA();
    // !PSR.exist_avp           PANA_SA_RESUMED=Set;
    // ("Cookie")
    //
    ev.Reset();
    ev.MsgType(PANA_EV_MTYPE_PSR);
    ev.Do_ResumeSession(); // ((MOBILIT==Set) && resume_pana_sa())
    AddStateTableEntry(PANA_ST_OFFLINE, ev.Get(), 
                        PANA_ST_WAIT_PAA, 
                        m_PacOfflineExitActionRxPSR);

    /////////////////////////////////////////////////////////////////
    // - - - - - - - - - - (Reach maximum number of retransmission)- -
    // RTX_TIMEOUT &&           Retransmit();              (no change)
    // RTX_COUNTER<
    // RTX_MAX_NUM
    //
    ev.Reset();
    ev.Do_ReTransmission();
    AddStateTableEntry(PANA_ST_OFFLINE, ev.Get(), 
                       PANA_ST_OFFLINE, 
                       m_PacExitActionRetransmission);

    /////////////////////////////////////////////////////////////////
    // RTX_TIMEOUT &&           Disconnect();              CLOSED
    // RTX_COUNTER>=
    // RTX_MAX_NUM
    //
    ev.Reset();
    ev.Do_RetryTimeout();
    AddStateTableEntry(PANA_ST_OFFLINE, ev.Get(), 
                       PANA_ST_CLOSED, 
                       m_PacExitActionTimeout);

    /////////////////////////////////////////////////////////////////
    // - - - - - - - - - - (PANA-Error-Message-Processing)- -
    // Rx:PER &&                PEA.insert_avp("AUTH");     CLOSED
    // fatal                    Tx:PEA();
    // (PER.RESULT_CODE) &&     Disconnect();
    // PER.exist_avp("AUTH") &&
    // key_available()
    //
    ev.Reset();
    ev.MsgType(PANA_EV_MTYPE_PER);
    ev.Do_FatalError(); // fatal(PER.RESULT_CODE) &&
                        // PER.exist_avp("AUTH") &&
                        // key_available()
    AddStateTableEntry(PANA_ST_OFFLINE, ev.Get(), 
                       PANA_ST_CLOSED, 
                       m_PacExitActionTxPEA);

    /////////////////////////////////////////////////////////////////
    // Rx:PER &&                Tx:PEA();                  (no change)
    // !fatalRx
    // (PER.RESULT_CODE) ||
    // !PER.exist_avp("AUTH") ||
    // !key_available()
    //
    ev.Reset();
    ev.MsgType(PANA_EV_MTYPE_PER);
    AddStateTableEntry(PANA_ST_OFFLINE, ev.Get(), 
                       PANA_ST_OFFLINE, 
                       m_PacExitActionTxPEA);

    /////////////////////////////////////////////////////////////////
    // - - - - - - - - - - (Catch all processing)- -
    //
#if !defined(PANA_DEBUG)
    AddWildcardStateTableEntry(PANA_ST_OFFLINE, 
                               PANA_ST_OFFLINE);
#endif

    // ---------------------------
    // State: WAIT_EAP_MSG_IN_DISC
    // ---------------------------

    /////////////////////////////////////////////////////////////////
    // - - - - - - - - - - (Return PSA with EAP-Payload) - - - - - -
    // EAP_RESPONSE             PSA.insert_avp             WAIT_PAA
    //                          ("EAP-Payload"))
    //                          if (choose_isp())
    //                             PSA.insert_avp("ISP");
    //                          Tx:PSA();
    //
    ev.Reset();
    ev.Event_Eap(PANA_EV_EAP_RESPONSE);
    AddStateTableEntry(PANA_ST_WAIT_EAP_MSG_IN_DISC, ev.Get(), 
                       PANA_ST_WAIT_PAA, 
                       m_PacWaitEapMsgInExitActionTxPSA);
    // Required to deal with eap piggyback enabled flag
    ev.Reset();
    ev.Event_Eap(PANA_EV_EAP_RESPONSE);
    ev.EnableCfg_EapPiggyback();
    AddStateTableEntry(PANA_ST_WAIT_EAP_MSG_IN_DISC, ev.Get(), 
                       PANA_ST_WAIT_PAA, 
                       m_PacWaitEapMsgInExitActionTxPSA);

    /////////////////////////////////////////////////////////////////
    // EAP_INVALID_MSG          None();                    OFFLINE
    //
    ev.Reset();
    ev.Event_Eap(PANA_EV_EAP_INVALID_MSG);
    AddStateTableEntry(PANA_ST_WAIT_EAP_MSG_IN_DISC, ev.Get(), 
                       PANA_ST_OFFLINE);
                       
    /////////////////////////////////////////////////////////////////
    // EAP_RESP_TIMEOUT         None();                    OFFLINE
    //
    ev.Reset();
    ev.Event_Eap(PANA_EV_EAP_TIMEOUT);
    AddStateTableEntry(PANA_ST_WAIT_EAP_MSG_IN_DISC, ev.Get(), 
                       PANA_ST_OFFLINE);

    /////////////////////////////////////////////////////////////////
    // - - - - - - - - - - (Catch all processing)- -
    //
#if !defined(PANA_DEBUG)
    AddWildcardStateTableEntry(PANA_ST_WAIT_EAP_MSG_IN_DISC, 
                               PANA_ST_WAIT_EAP_MSG_IN_DISC);
#endif

    // ---------------
    // State: WAIT_PAA
    // ---------------

    /////////////////////////////////////////////////////////////////
    // - - - - - - - - - - - - - - -(PAR-PAN exchange) - - - - - - - 
    // Rx:PAR &&                RtxTimerStop();         WAIT_EAP_MSG
    // !eap_piggyback()         TxEAP();
    //                          PANA_SA_RESUMED=Unset;
    //                          EAP_RespTimerStart();
    //                          if (key_available())
    //                            PAN.insert_avp("AUTH");
    //                          PAN.S_flag=PAR.S_flag;
    //                          PAN.N_flag=PAR.N_flag;
    //                          Tx:PAN();
    //
    ev.Reset();
    ev.MsgType(PANA_EV_MTYPE_PAR);
    AddStateTableEntry(PANA_ST_WAIT_PAA, ev.Get(), 
                       PANA_ST_WAIT_EAP_MSG, 
                       m_PacWaitPaaExitActionRxPAR);

    /////////////////////////////////////////////////////////////////
    // Rx:PAR &&                RtxTimerStop();         WAIT_EAP_MSG
    // eap_piggyback()          TxEAP();
    //                          PANA_SA_RESUMED=Unset;
    //                          EAP_RespTimerStart();
    //
    ev.Reset();
    ev.MsgType(PANA_EV_MTYPE_PAR);
    ev.EnableCfg_EapPiggyback();
    AddStateTableEntry(PANA_ST_WAIT_PAA, ev.Get(), 
                       PANA_ST_WAIT_EAP_MSG, 
                       m_PacWaitPaaExitActionRxPAR);

    /////////////////////////////////////////////////////////////////
    // Rx:PAN                   RtxTimerStop();         WAIT_PAA
    //
    ev.Reset();
    ev.MsgType(PANA_EV_MTYPE_PAN);
    AddStateTableEntry(PANA_ST_WAIT_PAA, ev.Get(), 
                       PANA_ST_WAIT_PAA, 
                       m_PacWaitPaaExitActionRxPAN);

    /////////////////////////////////////////////////////////////////
    // - - - - - - - - - - - - - - -(1st EAP result) - - - - - - - - 
    // Rx:PFER &&               1ST_EAP=Success;           WAIT_1ST_EAP_RESULT
    // 1ST_EAP==Unset &&        TxEAP();
    // SEPARATE==Set &&
    // PFER.RESULT_CODE==
    //    PANA_SUCCESS &&