ksync_entry.h

Go to the documentation of this file.

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

#ifndef ctrlplane_ksync_entry_h
#define ctrlplane_ksync_entry_h

#include <boost/intrusive_ptr.hpp>
#include <boost/intrusive/set.hpp>
#include <tbb/atomic.h>
#include <sandesh/common/vns_constants.h>
#include <sandesh/common/vns_types.h>
#include <sandesh/sandesh_trace.h>
#include <db/db_entry.h>

#define KSYNC_ERROR(obj, ...)\
do {\
    if (LoggingDisabled()) break;\
    obj::Send(g_vns_constants.CategoryNames.find(Category::VROUTER)->second,\
              SandeshLevel::SYS_DEBUG, __FILE__, __LINE__, ##__VA_ARGS__);\
} while (false)

extern SandeshTraceBufferPtr KSyncErrorTraceBuf;
#define KSYNC_ERROR_TRACE(obj, ...)                                           \
do {                                                                          \
    KSyncError##obj::TraceMsg(KSyncErrorTraceBuf,                             \
                              __FILE__, __LINE__, __VA_ARGS__);               \
} while (false)

class KSyncObject;
class KSyncDBObject;

class KSyncEntry {
public:
    enum KSyncState {
        INIT,           // Init state. Not notified
        TEMP,           // Temporary entry created on reference
        ADD_DEFER,      // Add of entry deferred due to unmet dependencies
        CHANGE_DEFER,   // Change of entry deferred due to unmet dependencies
        IN_SYNC,        // Object in sync
        SYNC_WAIT,      // Waiting on ACK for add/change
        NEED_SYNC,      // Object changed. Needs Sync
        DEL_DEFER_SYNC, // Del pending to be sent due to sync_wait
        DEL_DEFER_REF,  // Del pending to be sent due to ref-count
        DEL_DEFER_DEL_ACK, // Del pending to be sent due to Del Ack wait
        DEL_ACK_WAIT,   // Del request sent waiting for ack
        RENEW_WAIT,     // Object renewal waiting for delete-ack
        FREE_WAIT       // Entry to be freed
    };

    enum KSyncEvent {
        ADD_CHANGE_REQ,
        ADD_ACK,
        CHANGE_ACK,
        DEL_REQ,
        DEL_ADD_REQ,
        DEL_ACK,
        RE_EVAL,
        INT_PTR_REL,
        INVALID
    };

    std::string StateString() const;
    std::string AckOperationString(KSyncEvent ack_event) const;
    std::string EventString(KSyncEvent event) const;
    // All referring KSyncEntries must use KSyncEntryPtr. The ref-count
    // maintained is optionally used to defer DELETE till refcount is 0
    typedef boost::intrusive_ptr<KSyncEntry> KSyncEntryPtr;
    static const size_t kInvalidIndex = 0xFFFFFFFF;
    static const int kDefaultMsgSize = 512;

    // Use this constructor if automatic index allocation is *not* needed
    KSyncEntry() {
        Reset();
    };
    // Use this constructor if automatic index allocation is needed
    KSyncEntry(uint32_t index) {
        Reset(index);
    };
    virtual ~KSyncEntry() { assert(refcount_ == 0);};

    void Reset() {
        index_ = kInvalidIndex;
        state_ = INIT;
        seen_ = false;
        stale_ = false;
        del_add_pending_ = false;
        refcount_ = 0;
    }
    void Reset(uint32_t index) {
        Reset();
        index_ = index;
    }

    // Comparator for boost::set containing all KSyncEntries in an KSyncObject
    bool operator<(const KSyncEntry &rhs) const {
        return IsLess(rhs);
    };
    // Comparator to manage the tree
    virtual bool IsLess(const KSyncEntry &rhs) const = 0;

    // Convert KSync to String
    virtual std::string ToString() const = 0;

    // Create handler.
    // Return true if operation is complete
    // Return false if operation asynchronously
    virtual bool Add() = 0;

    // Change handler.
    // Return true if operation is complete
    // Return false if operation asynchronously
    virtual bool Change() = 0;

    // Delete handler.
    // Return true if operation is complete
    // Return false if operation asynchronously
    virtual bool Delete() = 0;

    // KSyncObject for this entry. Used to release the index
    virtual KSyncObject *GetObject() const = 0;
    // Get an unresolved reference.
    // This entry will be added into resolveq_ of unresolved-entry
    virtual KSyncEntry *UnresolvedReference() = 0;
    virtual bool ShouldReEvalBackReference() const { return true; }

    // Returns true if entry is resolved and referring entry can be written
    bool IsResolved();

    // Returns true if the entry data is resolved
    virtual bool IsDataResolved() {return true;}

    // User define KSync Response handler
    virtual void Response() { };

    // Allow State Compression for delete.
    virtual bool AllowDeleteStateComp() {return true;}

    // User defined error handler
    virtual void ErrorHandler(int err, uint32_t seqno, KSyncEvent event) const;

    // Error message for vrouter returned errors
    virtual std::string VrouterError(uint32_t error) const;
    static std::string VrouterErrorToString(uint32_t error);

    // Every ksync operation needs an rx-buffer to read response. The rx buffer
    // are pre-allocated to minimize compuation in ksync-tx-queue
    // pre-allocation is enabled only for flows for now
    virtual bool pre_alloc_rx_buffer() const { return false; }
    // ksync-tx supports multiple queues for KSync events. Get index of queue
    // to use
    virtual uint32_t GetTableIndex() const { return 0; }
    // On stale timer expiration, notify entry for same
    virtual void StaleTimerExpired() { }

    size_t GetIndex() const {return index_;};
    KSyncState GetState() const {return state_;};
    bool del_add_pending() const {return del_add_pending_;}
    uint32_t GetRefCount() const {return refcount_;}
    bool Seen() const {return seen_;}
    bool stale() const {return stale_;}
    void SetSeen() {seen_ = true;}
    bool IsDeleted() { return (state_ == DEL_ACK_WAIT ||
                               state_ == DEL_DEFER_DEL_ACK ||
                               state_ == DEL_DEFER_SYNC ||
                               state_ == DEL_DEFER_REF); };

    // return true if an entry is actively owned some module,
    // i.e., explicit Create was triggered for this entry and it
    // is not deleted yet by the Creator.
    // this entry however may still be still in unresolved state.
    bool IsActive() { return (state_ != TEMP && !IsDeleted()); }

    void set_del_add_pending(bool pending) {del_add_pending_ = pending;}
    void RecordTransition(KSyncState from, KSyncState to, KSyncEvent event) {
        t_history_.RecordTransition(from, to, event);
    }

protected:
    void SetIndex(size_t index) {index_ = index;};
    void SetState(KSyncState state) {state_ = state;};
private:
    friend void intrusive_ptr_add_ref(KSyncEntry *p);
    friend void intrusive_ptr_release(KSyncEntry *p);
    friend class KSyncSock;
    friend class KSyncObject;

    boost::intrusive::set_member_hook<> node_;

    size_t              index_;
    KSyncState          state_;
    tbb::atomic<int>    refcount_;
    bool                seen_;

    // Stale Entry flag indicates an entry as stale, which will be
    // removed once stale entry timer cleanup gets triggered.
    bool                stale_;

    // flag to indicate a pending DelAdd operation on entry
    // this is set to true when Delete Add operation cannot go
    // through as entry is waiting of Ack for previous operation
    bool                del_add_pending_;

    struct KSyncEntryTransition {
            KSyncState from_;
            KSyncState to_;
            KSyncEvent event_;
    };
    class KSyncEntryTransHistory {
        public:
            KSyncEntryTransHistory() {
                idx_ = 0;
                for (int i = 0; i < size_; i++) {
                    history_[i].event_ = INVALID;
                }
            }

            void RecordTransition(KSyncState from, KSyncState to,
                                   KSyncEvent event) {
                history_[idx_].from_ = from;
                history_[idx_].to_ = to;
                history_[idx_].event_ = event;
                idx_ = (idx_+1) % size_;
            }
        private:
            static const int size_ = 5;
            int idx_;
            struct KSyncEntryTransition history_[size_];
    };
    KSyncEntryTransHistory t_history_;

    DISALLOW_COPY_AND_ASSIGN(KSyncEntry);
};

// Implementation of KSyncEntry with with DBTable. Must be used along
// with KSyncDBObject.
// Registers with DBTable and drives state-machine based on DBTable
// notifications
// Applications are not needed to generate any events to the state-machine
class KSyncDBEntry : public KSyncEntry, public DBState {
public:
    typedef std::list<DBEntry *> DupEntryList;

    KSyncDBEntry() : KSyncEntry(), DBState() { db_entry_ = NULL; };
    KSyncDBEntry(uint32_t index) : KSyncEntry(index), DBState() { db_entry_ = NULL; };
    virtual ~KSyncDBEntry() { assert(dup_entry_list_.empty()); }

    // Check if object is in-sync with kernel.
    // Return true if object needs sync. Else return false
    virtual bool Sync(DBEntry *entry) = 0;

    void SetDBEntry(DBEntry *db_entry) { db_entry_ = db_entry; }
    DBEntry * GetDBEntry() { return db_entry_; }

private:
    friend class KSyncDBObject;

    DBEntry *db_entry_;
    DupEntryList dup_entry_list_;
    DISALLOW_COPY_AND_ASSIGN(KSyncDBEntry);
};

#endif // ctrlplane_ksync_entry_h