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/DataStructures/ExternalArray.hpp>
#include <Fw/DataStructures/RedBlackTreeSet.hpp>
#include <Fw/Deprecate.hpp>
#include <Fw/Types/MemAllocator.hpp>

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

#define DIRECTORY_DELIMITER "/"

namespace Svc {

class DpCatalog final : public DpCatalogComponentBase {
    friend class DpCatalogTester;

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

    DpCatalog(const char* const compName  
    );

    ~DpCatalog() = default;

    void configure(const Fw::ExternalArray<Fw::FileNameString>& directories,
                   Fw::FileNameString& stateFile,
                   FwEnumStoreType memId,
                   Fw::MemAllocator& allocator);

    DEPRECATED(void configure(Fw::FileNameString directories[DP_MAX_DIRECTORIES],
                              FwSizeType numDirs,
                              Fw::FileNameString& stateFile,
                              FwEnumStoreType memId,
                              Fw::MemAllocator& allocator),
               "Use configure(const Fw::ExternalArray<Fw::FileNameString>& directories, ...) instead");

    // @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;

    void addToCat_handler(FwIndexType portNum,             
                          const Fw::StringBase& fileName,  
                          FwDpPriorityType priority,       
                          FwSizeType size                  
                          ) override;

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

    void BUILD_CATALOG_cmdHandler(FwOpcodeType opCode,  
                                  U32 cmdSeq            
                                  ) override;

    void START_XMIT_CATALOG_cmdHandler(
        FwOpcodeType opCode,   
        U32 cmdSeq,            
        const Fw::Wait& wait,  
        bool remainActive      
        ) 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;  

        static I8 compareEntries(const DpStateEntry& left, const DpStateEntry& right);

        bool operator==(const DpStateEntry& other) const;
        bool operator!=(const DpStateEntry& other) const;
        bool operator>(const DpStateEntry& other) const;
        bool operator<(const DpStateEntry& other) const;
    };

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

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

    enum class ProcessFileStatus {
        SUCCESS,  
        FAILED,   
        QUIT      
    };

    FwSizeType determineDirectory(const Fw::String& fullFile);

    ProcessFileStatus processFile(const Fw::String& fullFile, FwSizeType dir);

    bool insertEntry(DpStateEntry& entry);

    void resetCatalog();

    Fw::CmdResponse fillBinaryTree();

    void resetStateFileData();

    void getFileState(DpStateEntry& entry);

    void pruneAndWriteStateFile();

    Fw::CmdResponse loadStateFile();

    void appendFileState(const DpStateEntry& entry);

    void sendNextEntry();

    bool findNextEntry(DpStateEntry& entry);

    bool checkInit();

    Fw::CmdResponse doCatalogBuild();

    Fw::CmdResponse doCatalogXmit();

    void dispatchWaitedResponse(Fw::CmdResponse response);

    // ----------------------------------
    // Private data
    // ----------------------------------
    bool m_initialized = false;  

    Fw::RedBlackTreeSet<DpStateEntry, DP_MAX_FILES> m_dpCatalog;  
    DpStateEntry m_currentXmitEntry;                              
    bool m_hasCurrentXmit = false;                                

    FwSizeType m_numDpSlots = 0;  

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

    Fw::FileNameString m_stateFile;                
    DpDstateFileEntry* m_stateFileData = nullptr;  
    FwSizeType m_stateFileEntries = 0;             

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

    bool m_catalogBuilt = false;            
    bool m_xmitInProgress = false;          
    Fw::FileNameString m_currXmitFileName;  
    bool m_xmitCmdWait = false;             
    U64 m_xmitBytes = 0;                    
    FwOpcodeType m_xmitOpCode = 0;          
    U32 m_xmitCmdSeq = 0;                   

    U32 m_pendingFiles = 0;    
    U64 m_pendingDpBytes = 0;  

    bool m_remainActive = false;  
};

}  // namespace Svc

#endif