Clist.hpp

Go to the documentation of this file.

// ======================================================================
// \title  Clist.hpp
// \brief  CFDP circular list header file
//
// This file is a port of CFDP circular list 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_clist.h (CFDP circular list data structure 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_CLIST_HPP
#define CFDP_CLIST_HPP

#include <Fw/Types/BasicTypes.hpp>
#include <cstddef>

namespace Svc {
namespace Ccsds {
namespace Cfdp {

enum CListTraverseStatus : U8 {
    CLIST_TRAVERSE_CONTINUE = 0, 
    CLIST_TRAVERSE_EXIT = 1      
};

constexpr U8 CFDP_CLIST_CONT = CLIST_TRAVERSE_CONTINUE;

constexpr U8 CFDP_CLIST_EXIT = CLIST_TRAVERSE_EXIT;

static inline bool CfdpCListTraverseStatusIsContinue(CListTraverseStatus stat) {
    return (stat == CLIST_TRAVERSE_CONTINUE);
}

struct CListNode {
    struct CListNode* next; 
    struct CListNode* prev; 
};

template <typename Container, typename Member>
constexpr Container* container_of_cpp(Member* member_ptr, Member Container::* member) {
    // reinterpret_cast: Required for intrusive list node-to-parent pointer arithmetic (container_of idiom)
    return reinterpret_cast<Container*>(reinterpret_cast<U8*>(member_ptr) -
                                        reinterpret_cast<std::ptrdiff_t>(&(reinterpret_cast<Container*>(0)->*member)));
}

using CListFunc = CListTraverseStatus (*)(CListNode*, void*);

using CListTraverseCallback = CListTraverseStatus (*)(CListNode*, void*);

/************************************************************************/
void CfdpCListInitNode(CListNode* node);

/************************************************************************/
void CfdpCListInsertFront(CListNode** head, CListNode* node);

/************************************************************************/
void CfdpCListInsertBack(CListNode** head, CListNode* node);

/************************************************************************/
void CfdpCListRemove(CListNode** head, CListNode* node);

/************************************************************************/
CListNode* CfdpCListPop(CListNode** head);

/************************************************************************/
void CfdpCListInsertAfter(CListNode** head, CListNode* start, CListNode* after);

/************************************************************************/
void CfdpCListTraverse(CListNode* start, CListFunc fn, void* context);

/************************************************************************/
void CfdpCListTraverseR(CListNode* end, CListFunc fn, void* context);

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

#endif /* !CFDP_CLIST_HPP */