DpCatalog.hpp

Go to the documentation of this file.

// ======================================================================
// \title  DpCatalog.hpp
// \author tcanham
// \brief  hpp file for DpCatalog component implementation class
// ======================================================================

#ifndef Svc_DpCatalog_HPP
#define Svc_DpCatalog_HPP

#include "Svc/DpCatalog/DpCatalogComponentAc.hpp"
#include "Svc/DpCatalog/DpRecordSerializableAc.hpp"

#include <Fw/Types/MemAllocator.hpp>

#include <Fw/Types/FileNameString.hpp>
#include <config/DpCatalogCfg.hpp>
#include <config/DpCfg.hpp>

namespace Svc {

class DpCatalog final : public DpCatalogComponentBase {
    friend class DpCatalogTester;

  public:
    // ----------------------------------------------------------------------
    // Component construction and destruction
    // ----------------------------------------------------------------------

    DpCatalog(const char* const compName  
    );

    ~DpCatalog();

    void configure(Fw::FileNameString directories[DP_MAX_DIRECTORIES],
                   FwSizeType numDirs,
                   Fw::FileNameString& stateFile,
                   FwEnumStoreType memId,
                   Fw::MemAllocator& allocator);

    // @brief clean up component.
    // Deallocates memory.
    void shutdown();

  private:
    // ----------------------------------------------------------------------
    // Handler implementations for user-defined typed input ports
    // ----------------------------------------------------------------------

    void fileDone_handler(FwIndexType portNum,  
                          const Svc::SendFileResponse& resp) override;

    void pingIn_handler(FwIndexType portNum,  
                        U32 key               
                        ) override;

  private:
    // ----------------------------------------------------------------------
    // Handler implementations for commands
    // ----------------------------------------------------------------------

    void BUILD_CATALOG_cmdHandler(FwOpcodeType opCode,  
                                  U32 cmdSeq            
                                  ) override;

    void START_XMIT_CATALOG_cmdHandler(
        FwOpcodeType opCode,  
        U32 cmdSeq,           
        Fw::Wait wait         
        ) override;

    void STOP_XMIT_CATALOG_cmdHandler(FwOpcodeType opCode,  
                                      U32 cmdSeq            
                                      ) override;

    void CLEAR_CATALOG_cmdHandler(FwOpcodeType opCode,  
                                  U32 cmdSeq            
                                  ) override;

    // ----------------------------------
    // Private data structures
    // ----------------------------------

    struct DpStateEntry {
        friend class DpCatalogTester;
        FwIndexType dir;  
        DpRecord record;  
    };

    struct DpDstateFileEntry {
        bool used;     
        bool visited;  
        DpStateEntry entry;  
    };

    struct DpBtreeNode {
        DpStateEntry entry;  
        DpBtreeNode* left;   
        DpBtreeNode* right;  
    };

    // ----------------------------------
    // Private helpers
    // ----------------------------------

    bool insertEntry(DpStateEntry& entry);

    void deleteEntry(DpStateEntry& entry);

    enum CheckStat {
        CHECK_OK,     
        CHECK_CONT,   
        CHECK_ERROR,  
    };

    CheckStat checkLeftRight(bool condition, DpBtreeNode*& node, const DpStateEntry& newEntry);

    void resetBinaryTree();

    Fw::CmdResponse fillBinaryTree();

    void resetTreeStack();

    void resetStateFileData();

    void getFileState(DpStateEntry& entry);

    void pruneAndWriteStateFile();

    Fw::CmdResponse loadStateFile();

    void appendFileState(const DpStateEntry& entry);

    bool allocateNode(DpBtreeNode*& newNode, const DpStateEntry& newEntry);

    void sendNextEntry();

    DpBtreeNode* findNextTreeNode();

    bool checkInit();

    Fw::CmdResponse doCatalogBuild();

    Fw::CmdResponse doCatalogXmit();

    // ----------------------------------
    // Private data
    // ----------------------------------
    bool m_initialized;  

    DpBtreeNode* m_dpTree;           
    DpBtreeNode* m_freeListHead;     
    DpBtreeNode* m_freeListFoot;     
    DpBtreeNode** m_traverseStack;   
    DpBtreeNode* m_currentNode;      
    DpBtreeNode* m_currentXmitNode;  

    FwSizeType m_numDpRecords;  
    FwSizeType m_numDpSlots;    

    Fw::FileNameString m_directories[DP_MAX_DIRECTORIES];  
    FwSizeType m_numDirectories;                           
    Fw::String m_fileList[DP_MAX_FILES];                   

    Fw::FileNameString m_stateFile;      
    DpDstateFileEntry* m_stateFileData;  
    FwSizeType m_stateFileEntries;       

    FwSizeType m_memSize;           
    void* m_memPtr;                 
    FwEnumStoreType m_allocatorId;  
    Fw::MemAllocator* m_allocator;  

    bool m_xmitInProgress;                  
    FwIndexType m_currStackEntry;           
    Fw::FileNameString m_currXmitFileName;  
    bool m_xmitCmdWait;                     
    U64 m_xmitBytes;                        
    FwOpcodeType m_xmitOpCode;              
    U32 m_xmitCmdSeq;                       
};

}  // namespace Svc

#endif