xmpp_connection.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013 Juniper Networks, Inc. All rights reserved.
 */

#ifndef __XMPP_CHANNEL_H__
#define __XMPP_CHANNEL_H__

#include <boost/asio/ip/tcp.hpp>
#include <boost/scoped_ptr.hpp>
#include <tbb/atomic.h>
#include <tbb/spin_mutex.h>

#include "base/timer.h"
#include "base/lifetime.h"
#include "base/address.h"
#include "xmpp/xmpp_channel_mux.h"
#include "xmpp/xmpp_state_machine.h"
#include "xmpp/xmpp_session.h"

class LifetimeActor;
class ShowXmppConnection;
class TcpServer;
class TcpSession;
class XmppChannelConfig;
class XmppClient;
class XmppConnectionEndpoint;
class XmppServer;
class XmppSession;

class XmppConnection {
public:
    struct ProtoStats {
        ProtoStats() {
            open = 0;
            close = 0;
            keepalive = 0;
            update = 0;
        }
        tbb::atomic<uint32_t> open;
        tbb::atomic<uint32_t> close;
        tbb::atomic<uint32_t> keepalive;
        tbb::atomic<uint32_t> update;
    };

    struct ErrorStats {
        ErrorStats() {
            connect_error = 0;
            session_close = 0;
            open_fail = 0;
            stream_feature_fail = 0;
            handshake_fail = 0;
        }
        tbb::atomic<uint32_t> connect_error;
        tbb::atomic<uint32_t> session_close;
        tbb::atomic<uint32_t> open_fail;
        tbb::atomic<uint32_t> stream_feature_fail;
        tbb::atomic<uint32_t> handshake_fail;
    };

    XmppConnection(TcpServer *server, const XmppChannelConfig *config);
    virtual ~XmppConnection();

    void SetConfig(const XmppChannelConfig *);

    // Invoked from XmppServer when a session is accepted.
    virtual bool AcceptSession(XmppSession *session);
    virtual void ReceiveMsg(XmppSession *session, const std::string &);

    virtual boost::asio::ip::tcp::endpoint endpoint() const;
    virtual boost::asio::ip::tcp::endpoint local_endpoint() const;
    std::string endpoint_string() const;
    std::string local_endpoint_string() const;
    TcpServer *server() { return server_; }
    XmppSession *CreateSession();
    int GetTaskInstance() const { return GetTaskInstance(is_client_); }

    const std::string &ToUVEKey() const;
    const std::string &ToString() const;
    const std::string &FromString() const;
    void SetAdminDown(bool toggle);
    bool Send(const uint8_t *data, size_t size,
              const std::string *msg_str = NULL);

    // Xmpp connection messages
    virtual bool SendOpen(XmppSession *session);
    virtual bool SendOpenConfirm(XmppSession *session);
    virtual bool SendStreamFeatureRequest(XmppSession *session);
    virtual bool SendStartTls(XmppSession *session);
    virtual bool SendProceedTls(XmppSession *session);

    void SendKeepAlive();
    void SendClose(XmppSession *session);

    // Ssl Handshake callback response
    void ProcessSslHandShakeResponse(SslSessionPtr session,
        const boost::system::error_code& error);

    // PubSub Messages
    int ProcessXmppIqMessage(const XmppStanza::XmppMessage *);

    // chat messages
    int ProcessXmppChatMessage(const XmppStanza::XmppChatMessage *);

    void StartKeepAliveTimer();
    void StopKeepAliveTimer();
    void UpdateKeepAliveTimer(uint8_t time_out);

    void set_session(XmppSession *session);
    void clear_session();
    void SetTo(const std::string &);

    const XmppSession *session() const;
    XmppSession *session();

    bool logUVE() const { return !is_client_ && log_uve_; }
    bool IsClient() const { return is_client_; }
    virtual void ManagedDelete() = 0;
    virtual void RetryDelete() = 0;
    virtual LifetimeActor *deleter() = 0;
    virtual const LifetimeActor *deleter() const = 0;
    virtual LifetimeManager *lifetime_manager() = 0;
    xmsm::XmState GetStateMcState() const;
    xmsm::XmOpenConfirmState GetStateMcOpenConfirmState() const;

    bool IsActiveChannel() const {
        return state_machine_->IsActiveChannel();
    }
    XmppChannelMux *ChannelMux() {return mux_.get(); }
    void SetChannelMux(XmppChannelMux *channel_mux) { mux_.reset(channel_mux); }

    void Initialize() { state_machine_->Initialize(); }
    void Clear() { state_machine_->Clear(); }
    void SetAdminState(bool down) { state_machine_->SetAdminState(down); }

    void Shutdown();
    bool MayDelete() const;
    bool IsDeleted() const;

    std::string &GetComputeHostName() { return to_; }
    std::string &GetControllerHostName() { return from_; }

    std::string &GetFrom() { return from_; }
    std::string &GetTo() { return to_; }

    virtual void set_close_reason(const std::string &reason) = 0;
    virtual void increment_flap_count() = 0;
    virtual uint32_t flap_count() const = 0;
    virtual const std::string last_flap_at() const = 0;

    virtual void WriteReady();

    friend class XmppStateMachineTest;

    int GetConfiguredHoldTime() const {
        return state_machine_->GetConfiguredHoldTime();
    }

    int GetNegotiatedHoldTime() const {
        return state_machine_->hold_time();
    }

    std::string StateName() const {
        return state_machine_->StateName();
    }

    std::string LastStateName() const {
        return state_machine_->LastStateName();
    }

    std::string LastStateChangeAt() const {
        return state_machine_->LastStateChangeAt();
    }

    std::string LastEvent() const {
        return state_machine_->last_event();
    }

    uint32_t tx_open() const {
        return stats_[1].open;
    }
    uint32_t tx_keepalive() const {
        return stats_[1].keepalive;
    }
    uint32_t tx_close() const {
        return stats_[1].close;
    }
    uint32_t tx_update() const {
        return stats_[1].update;
    }

    uint32_t rx_open() const {
        return stats_[0].open;
    }
    uint32_t rx_keepalive() const {
        return stats_[0].keepalive;
    }
    uint32_t rx_close() const {
        return stats_[0].close;
    }
    uint32_t rx_update() const {
        return stats_[0].update;
    }

    void LogMsg(std::string msg);
    bool disable_read() const { return disable_read_; }
    void set_disable_read(bool disable_read) { disable_read_ = disable_read; }
    XmppStateMachine *state_machine();
    const XmppStateMachine *state_machine() const;

    void set_state_machine(XmppStateMachine *state_machine) {
        state_machine_.reset(state_machine);
    }

    void SwapXmppStateMachine(XmppConnection *other) {
        state_machine_.swap(other->state_machine_);
    }
    uint8_t dscp_value() const { return dscp_value_; }
    int SetDscpValue(uint8_t value);

    void inc_connect_error();
    void inc_session_close();
    void inc_open_fail();
    void inc_stream_feature_fail();
    void inc_handshake_failure();
    size_t get_connect_error();
    size_t get_session_close();
    size_t get_open_fail();
    size_t get_stream_feature_fail();
    size_t get_handshake_failure();
    size_t get_sm_connect_attempts();
    size_t get_sm_keepalive_count();

    static const char *kAuthTypeNil;
    static const char *kAuthTypeTls;
    std::string GetXmppAuthenticationType() const;
    void SwapContents(XmppConnection *other);
    boost::asio::ip::tcp::endpoint &endpoint() { return endpoint_; }
    const Timer *keepalive_timer() const { return keepalive_timer_; }

protected:
    TcpServer *server_;
    XmppSession *session_;
    const XmppChannelMux *channel_mux() const;

private:
    bool KeepAliveTimerExpired();
    void KeepaliveTimerErrorHanlder(std::string error_name,
                                    std::string error_message);
    XmppStanza::XmppMessage *XmppDecode(const std::string &msg);
    void LogKeepAliveSend();
    int GetTaskInstance(bool is_client) const;

    boost::asio::ip::tcp::endpoint endpoint_;
    boost::asio::ip::tcp::endpoint local_endpoint_;
    const XmppChannelConfig *config_;

    // Protection for session_ and keepalive_timer_
    tbb::spin_mutex spin_mutex_;
    Timer *keepalive_timer_;

    bool is_client_;
    bool log_uve_;
    bool admin_down_;
    bool disable_read_;
    std::string from_; // bare jid
    std::string to_;
    bool auth_enabled_;
    uint8_t dscp_value_;
    std::string xmlns_;
    mutable std::string uve_key_str_;

    boost::scoped_ptr<XmppStateMachine> state_machine_;
    boost::scoped_ptr<XmppChannelMux> mux_;
    std::unique_ptr<XmppStanza::XmppMessage> last_msg_;

    ProtoStats stats_[2];
    void IncProtoStats(unsigned int type);
    ErrorStats error_stats_;

    DISALLOW_COPY_AND_ASSIGN(XmppConnection);
};

class XmppServerConnection : public XmppConnection {
public:
    XmppServerConnection(XmppServer *server, const XmppChannelConfig *config);
    virtual ~XmppServerConnection();

    virtual void ManagedDelete();
    virtual void RetryDelete();
    virtual LifetimeActor *deleter();
    virtual const LifetimeActor *deleter() const;
    virtual LifetimeManager *lifetime_manager();
    XmppServer *server();

    virtual void set_close_reason(const std::string &reason);
    virtual uint32_t flap_count() const;
    virtual void increment_flap_count();
    virtual const std::string last_flap_at() const;

    bool duplicate() const { return duplicate_; }
    void set_duplicate() { duplicate_ = true; }

    bool on_work_queue() const { return on_work_queue_; }
    void set_on_work_queue() { on_work_queue_ = true; }
    void clear_on_work_queue() { on_work_queue_ = false; }

    XmppConnectionEndpoint *conn_endpoint() { return conn_endpoint_; }
    void set_conn_endpoint(XmppConnectionEndpoint *conn_endpoint) {
        conn_endpoint_ = conn_endpoint;
    }
    void FillShowInfo(ShowXmppConnection *show_connection) const;

private:
    class DeleteActor;

    bool duplicate_;
    bool on_work_queue_;
    XmppConnectionEndpoint *conn_endpoint_;
    boost::scoped_ptr<DeleteActor> deleter_;
    LifetimeRef<XmppServerConnection> server_delete_ref_;
};

class XmppClientConnection : public XmppConnection {
public:
    XmppClientConnection(XmppClient *server, const XmppChannelConfig *config);
    virtual ~XmppClientConnection();

    virtual void ManagedDelete();
    virtual void RetryDelete();
    virtual LifetimeActor *deleter();
    virtual const LifetimeActor *deleter() const;
    virtual LifetimeManager *lifetime_manager();
    XmppClient *server();

    virtual void set_close_reason(const std::string &reason);
    virtual uint32_t flap_count() const;
    virtual void increment_flap_count();
    virtual const std::string last_flap_at() const;

private:
    class DeleteActor;

    std::string close_reason_;
    uint32_t flap_count_;
    uint64_t last_flap_;
    boost::scoped_ptr<DeleteActor> deleter_;
    LifetimeRef<XmppClientConnection> server_delete_ref_;
};

class XmppConnectionEndpoint {
public:
    XmppConnectionEndpoint(const std::string &client);

    void set_close_reason(const std::string &close_reason);
    uint32_t flap_count() const;
    void increment_flap_count();
    uint64_t last_flap() const;
    const std::string last_flap_at() const;
    XmppConnection *connection();
    const XmppConnection *connection() const;
    void set_connection(XmppConnection *connection);
    void reset_connection();

private:
    std::string client_;
    std::string close_reason_;
    uint32_t flap_count_;
    uint64_t last_flap_;
    XmppConnection *connection_;
};

#endif // __XMPP_CHANNEL_H__