FileManager.hpp

Go to the documentation of this file.

// ======================================================================
// \title  FileManager.hpp
// \author bocchino
// \brief  hpp file for FileManager component implementation class
//
// \copyright
// Copyright 2009-2015, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================

#ifndef Svc_FileManager_HPP
#define Svc_FileManager_HPP

#include <atomic>
#include "Fw/Types/FileNameString.hpp"
#include "Os/File.hpp"
#include "Os/FileSystem.hpp"
#include "Svc/FileManager/FileManagerComponentAc.hpp"
#include "config/FileManagerConfig.hpp"

namespace Svc {

class FileManager final : public FileManagerComponentBase {
    friend class FileManagerTester;

  public:
    // ----------------------------------------------------------------------
    // Construction, initialization, and destruction
    // ----------------------------------------------------------------------

    FileManager(const char* const compName  
    );

    ~FileManager();

    void configure(const char* sandboxDir);

  private:
    // ----------------------------------------------------------------------
    // Command handler implementations
    // ----------------------------------------------------------------------

    void CreateDirectory_cmdHandler(const FwOpcodeType opCode,       
                                    const U32 cmdSeq,                
                                    const Fw::CmdStringArg& dirName  
                                    ) override;

    void RemoveFile_cmdHandler(const FwOpcodeType opCode,         
                               const U32 cmdSeq,                  
                               const Fw::CmdStringArg& fileName,  
                               const bool ignoreErrors            
                               ) override;

    void MoveFile_cmdHandler(const FwOpcodeType opCode,               
                             const U32 cmdSeq,                        
                             const Fw::CmdStringArg& sourceFileName,  
                             const Fw::CmdStringArg& destFileName     
                             ) override;

    void RemoveDirectory_cmdHandler(const FwOpcodeType opCode,       
                                    const U32 cmdSeq,                
                                    const Fw::CmdStringArg& dirName  
                                    ) override;

    void AppendFile_cmdHandler(const FwOpcodeType opCode,       
                               const U32 cmdSeq,                
                               const Fw::CmdStringArg& source,  
                               const Fw::CmdStringArg& target   
                               ) override;

    void FileSize_cmdHandler(const FwOpcodeType opCode,        
                             const U32 cmdSeq,                 
                             const Fw::CmdStringArg& fileName  
                             ) override;

    void ListDirectory_cmdHandler(const FwOpcodeType opCode,       
                                  const U32 cmdSeq,                
                                  const Fw::CmdStringArg& dirName  
                                  ) override;

    void CalculateCrc_cmdHandler(FwOpcodeType opCode,              
                                 U32 cmdSeq,                       
                                 const Fw::CmdStringArg& filename  
                                 ) override;

    void GenerateDp_cmdHandler(FwOpcodeType opCode,                    
                               U32 cmdSeq,                             
                               const Fw::CmdStringArg& fileName,       
                               U32 chunkSize,                          
                               U64 beginOffset,                        
                               U64 endOffset,                          
                               U32 priority,                           
                               const FileManager_GenerateDpMode& mode  
                               ) override;

    void pingIn_handler(const FwIndexType portNum, 
                        U32 key                    
                        ) override;

    void schedIn_handler(const FwIndexType portNum, 
                         U32 context                
                         ) override;

  private:
    // ----------------------------------------------------------------------
    // Helper methods
    // ----------------------------------------------------------------------

    void emitTelemetry(const Os::FileSystem::Status status  
    );

    void sendCommandResponse(const FwOpcodeType opCode,           
                             const U32 cmdSeq,                    
                             const Os::FileSystem::Status status  
    );

    bool resolveInSandbox(const Fw::CmdStringArg& path,  
                          Fw::FileNameString& resolved,  
                          const FwOpcodeType opCode,     
                          const U32 cmdSeq               
    );

  private:
    // ----------------------------------------------------------------------
    // Handler implementations for user-defined internal interfaces
    // ----------------------------------------------------------------------

    void run_internalInterfaceHandler() override;

  private:
    // ----------------------------------------------------------------------
    // Variables
    // ----------------------------------------------------------------------

    U32 commandCount;

    U32 errorCount;

    Fw::FileNameString m_sandboxDir;

    bool m_sandboxConfigured;

    // ----------------------------------------------------------------------
    // Directory listing state machine variables
    // ----------------------------------------------------------------------
    // The FileManager uses an asynchronous state machine to process
    // directory listings through Rate Group 2. This prevents event
    // flooding and ensures bounded execution time by processing
    // FILES_PER_RATE_TICK directory entries per rate tick.

    enum ListDirectoryState {
        IDLE,                
        LISTING_IN_PROGRESS  
    };

    ListDirectoryState m_listState;

    Os::Directory m_currentDir;

    Fw::String m_currentDirName;

    U32 m_totalEntries;

    FwOpcodeType m_currentOpCode;

    U32 m_currentCmdSeq;

    std::atomic<bool> m_runQueued;

    // ----------------------------------------------------------------------
    // Data product generation state machine variables
    // ----------------------------------------------------------------------
    // Files are packaged into data products one chunk at a time, paced by
    // the rate group in the same way as directory listing. This keeps the
    // work bounded per tick and lets the command succeed regardless of how
    // large the buffers allocated to data products are.

    enum GenerateDpState {
        DP_IDLE,        
        DP_IN_PROGRESS  
    };

    GenerateDpState m_dpState;

    Os::File m_dpFile;

    Fw::String m_dpFileName;

    FwSizeType m_dpFileSize;

    U64 m_dpOffset;

    U32 m_dpChunkSize;

    U64 m_dpEndOffset;

    FwDpPriorityType m_dpPriority;

    U32 m_dpChunkCount;

    FwOpcodeType m_dpOpCode;

    U32 m_dpCmdSeq;

    U8 m_dpBuffer[FileManagerConfig::GENERATE_DP_MAX_CHUNK_SIZE];

    void processDpChunks(U32 chunkLimit);

    void finishDpGeneration();
};

}  // end namespace Svc

#endif