Chunk.hpp

Go to the documentation of this file.

// ======================================================================
// \title  Chunk.hpp
// \brief  CFDP chunks (spare gap tracking) header file
//
// This file is a port of CFDP chunk/gap tracking from the following files
// from the NASA Core Flight System (cFS) CFDP (CF) Application, version 3.0.0,
// adapted for use within the F-Prime (F') framework:
// - cf_chunks.h (CFDP chunk and gap tracking definitions)
//
// ======================================================================
//
// NASA Docket No. GSC-18,447-1
//
// Copyright (c) 2019 United States Government as represented by the
// Administrator of the National Aeronautics and Space Administration.
// All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may
// not use this file except in compliance with the License. You may obtain
// a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ======================================================================

#ifndef CFDP_CHUNK_HPP
#define CFDP_CHUNK_HPP

#include <Fw/FPrimeBasicTypes.hpp>

#include <Svc/Ccsds/CfdpManager/Types/StatusEnumAc.hpp>
#include <config/FileSizeAliasAc.hpp>

namespace Svc {
namespace Ccsds {
namespace Cfdp {

using ChunkIdx = U16;

struct Chunk {
    FileSize offset; 
    FileSize size;   
};

static inline FileSize CfdpChunkMax(FileSize a, FileSize b) {
    if (a > b) {
        return a;
    } else {
        return b;
    }
}

using GapComputeCallback = void (*)(const Chunk* chunk, void* opaque);

class CfdpChunkList {
  public:
    // ----------------------------------------------------------------------
    // Construction and Destruction
    // ----------------------------------------------------------------------

    CfdpChunkList(ChunkIdx maxChunks, Chunk* chunkMem);

    // ----------------------------------------------------------------------
    // Public Interface
    // ----------------------------------------------------------------------

    void add(FileSize offset, FileSize size);

    void reset();

    const Chunk* getFirstChunk() const;

    void removeFromFirst(FileSize size);

    U32 computeGaps(ChunkIdx maxGaps, FileSize total, FileSize start, GapComputeCallback callback, void* opaque) const;

    ChunkIdx getCount() const { return m_count; }

    ChunkIdx getMaxChunks() const { return m_maxChunks; }

  private:
    // ----------------------------------------------------------------------
    // Private Implementation
    // ----------------------------------------------------------------------

    void insertChunk(ChunkIdx index, const Chunk* chunk);

    void eraseChunk(ChunkIdx index);

    void eraseRange(ChunkIdx start, ChunkIdx end);

    ChunkIdx findInsertPosition(const Chunk* chunk);

    bool combineNext(ChunkIdx i, const Chunk* chunk);

    bool combinePrevious(ChunkIdx i, const Chunk* chunk);

    void insert(ChunkIdx i, const Chunk* chunk);

    ChunkIdx findSmallestSize() const;

  private:
    // ----------------------------------------------------------------------
    // Private Member Variables
    // ----------------------------------------------------------------------

    ChunkIdx m_count;      
    ChunkIdx m_maxChunks;  
    Chunk* m_chunks;       
};

}  // namespace Cfdp
}  // namespace Ccsds
}  // namespace Svc

#endif /* !CFDP_CHUNK_HPP */