Merge pull request 'TC Distribution convergence' (#229) from KSat/fsfw:mueller/tcDistribution into master
Reviewed-on: fsfw/fsfw#229
This commit is contained in:
commit
0b1b9c11eb
@ -1,31 +1,39 @@
|
||||
#include "../serviceinterface/ServiceInterfaceStream.h"
|
||||
#include "CCSDSDistributor.h"
|
||||
|
||||
#include "../serviceinterface/ServiceInterfaceStream.h"
|
||||
#include "../tmtcpacket/SpacePacketBase.h"
|
||||
|
||||
CCSDSDistributor::CCSDSDistributor( uint16_t setDefaultApid, object_id_t setObjectId ) :
|
||||
TcDistributor( setObjectId ), default_apid( setDefaultApid ), tcStore(NULL) {
|
||||
CCSDSDistributor::CCSDSDistributor(uint16_t setDefaultApid,
|
||||
object_id_t setObjectId):
|
||||
TcDistributor(setObjectId), defaultApid( setDefaultApid ) {
|
||||
}
|
||||
|
||||
CCSDSDistributor::~CCSDSDistributor() {
|
||||
CCSDSDistributor::~CCSDSDistributor() {}
|
||||
|
||||
}
|
||||
|
||||
iterator_t CCSDSDistributor::selectDestination() {
|
||||
// debug << "CCSDSDistributor::selectDestination received: " << this->currentMessage.getStorageId().pool_index << ", " << this->currentMessage.getStorageId().packet_index << std::endl;
|
||||
const uint8_t* p_packet = NULL;
|
||||
TcDistributor::TcMqMapIter CCSDSDistributor::selectDestination() {
|
||||
// sif::debug << "CCSDSDistributor::selectDestination received: " <<
|
||||
// this->currentMessage.getStorageId().pool_index << ", " <<
|
||||
// this->currentMessage.getStorageId().packet_index << std::endl;
|
||||
const uint8_t* packet = nullptr;
|
||||
size_t size = 0;
|
||||
//TODO check returncode?
|
||||
this->tcStore->getData( this->currentMessage.getStorageId(), &p_packet, &size );
|
||||
SpacePacketBase current_packet( p_packet );
|
||||
// info << "CCSDSDistributor::selectDestination has packet with APID " << std::hex << current_packet.getAPID() << std::dec << std::endl;
|
||||
iterator_t position = this->queueMap.find( current_packet.getAPID() );
|
||||
ReturnValue_t result = this->tcStore->getData(currentMessage.getStorageId(),
|
||||
&packet, &size );
|
||||
if(result != HasReturnvaluesIF::RETURN_OK) {
|
||||
sif::error << "CCSDSDistributor::selectDestination: Getting data from"
|
||||
" store failed!" << std::endl;
|
||||
}
|
||||
SpacePacketBase currentPacket(packet);
|
||||
|
||||
// sif:: info << "CCSDSDistributor::selectDestination has packet with APID "
|
||||
// << std::hex << currentPacket.getAPID() << std::dec << std::endl;
|
||||
TcMqMapIter position = this->queueMap.find(currentPacket.getAPID());
|
||||
if ( position != this->queueMap.end() ) {
|
||||
return position;
|
||||
} else {
|
||||
//The APID was not found. Forward packet to main SW-APID anyway to create acceptance failure report.
|
||||
return this->queueMap.find( this->default_apid );
|
||||
//The APID was not found. Forward packet to main SW-APID anyway to
|
||||
// create acceptance failure report.
|
||||
return this->queueMap.find( this->defaultApid );
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
MessageQueueId_t CCSDSDistributor::getRequestQueue() {
|
||||
@ -35,9 +43,9 @@ MessageQueueId_t CCSDSDistributor::getRequestQueue() {
|
||||
ReturnValue_t CCSDSDistributor::registerApplication(
|
||||
AcceptsTelecommandsIF* application) {
|
||||
ReturnValue_t returnValue = RETURN_OK;
|
||||
bool errorCode = true;
|
||||
errorCode = this->queueMap.insert( std::pair<uint32_t, MessageQueueId_t>( application->getIdentifier(), application->getRequestQueue() ) ).second;
|
||||
if( errorCode == false ) {
|
||||
auto insertPair = this->queueMap.emplace(application->getIdentifier(),
|
||||
application->getRequestQueue());
|
||||
if(not insertPair.second) {
|
||||
returnValue = RETURN_FAILED;
|
||||
}
|
||||
return returnValue;
|
||||
@ -46,9 +54,8 @@ ReturnValue_t CCSDSDistributor::registerApplication(
|
||||
ReturnValue_t CCSDSDistributor::registerApplication(uint16_t apid,
|
||||
MessageQueueId_t id) {
|
||||
ReturnValue_t returnValue = RETURN_OK;
|
||||
bool errorCode = true;
|
||||
errorCode = this->queueMap.insert( std::pair<uint32_t, MessageQueueId_t>( apid, id ) ).second;
|
||||
if( errorCode == false ) {
|
||||
auto insertPair = this->queueMap.emplace(apid, id);
|
||||
if(not insertPair.second) {
|
||||
returnValue = RETURN_FAILED;
|
||||
}
|
||||
return returnValue;
|
||||
@ -62,7 +69,11 @@ uint16_t CCSDSDistributor::getIdentifier() {
|
||||
ReturnValue_t CCSDSDistributor::initialize() {
|
||||
ReturnValue_t status = this->TcDistributor::initialize();
|
||||
this->tcStore = objectManager->get<StorageManagerIF>( objects::TC_STORE );
|
||||
if (this->tcStore == NULL) status = RETURN_FAILED;
|
||||
if (this->tcStore == nullptr) {
|
||||
sif::error << "CCSDSDistributor::initialize: Could not initialize"
|
||||
" TC store!" << std::endl;
|
||||
status = RETURN_FAILED;
|
||||
}
|
||||
return status;
|
||||
}
|
||||
|
||||
|
||||
@ -1,58 +1,71 @@
|
||||
#ifndef CCSDSDISTRIBUTOR_H_
|
||||
#define CCSDSDISTRIBUTOR_H_
|
||||
#ifndef FRAMEWORK_TCDISTRIBUTION_CCSDSDISTRIBUTOR_H_
|
||||
#define FRAMEWORK_TCDISTRIBUTION_CCSDSDISTRIBUTOR_H_
|
||||
|
||||
#include "../objectmanager/ObjectManagerIF.h"
|
||||
#include "../storagemanager/StorageManagerIF.h"
|
||||
#include "CCSDSDistributorIF.h"
|
||||
#include "TcDistributor.h"
|
||||
#include "../tcdistribution/CCSDSDistributorIF.h"
|
||||
#include "../tcdistribution/TcDistributor.h"
|
||||
#include "../tmtcservices/AcceptsTelecommandsIF.h"
|
||||
|
||||
/**
|
||||
* An instantiation of the CCSDSDistributorIF.
|
||||
* It receives Space Packets, and selects a destination depending on the APID of the telecommands.
|
||||
* @brief An instantiation of the CCSDSDistributorIF.
|
||||
* @details
|
||||
* It receives Space Packets, and selects a destination depending on the
|
||||
* APID of the telecommands.
|
||||
* The Secondary Header (with Service/Subservice) is ignored.
|
||||
* \ingroup tc_distribution
|
||||
* @ingroup tc_distribution
|
||||
*/
|
||||
class CCSDSDistributor : public TcDistributor, public CCSDSDistributorIF, public AcceptsTelecommandsIF {
|
||||
protected:
|
||||
/**
|
||||
* This implementation checks if an Application with fitting APID has registered and forwards the
|
||||
* packet to the according message queue.
|
||||
* If the packet is not found, it returns the queue to \c default_apid, where a Acceptance Failure
|
||||
* message should be generated.
|
||||
* @return Iterator to map entry of found APID or iterator to default APID.
|
||||
*/
|
||||
iterator_t selectDestination();
|
||||
/**
|
||||
* The default APID, where packets with unknown APID are sent to.
|
||||
*/
|
||||
uint16_t default_apid;
|
||||
/**
|
||||
* A reference to the TC storage must be maintained, as this class handles pure Space Packets and there
|
||||
* exists no SpacePacketStored class.
|
||||
*/
|
||||
StorageManagerIF* tcStore;
|
||||
/**
|
||||
* The callback here handles the generation of acceptance success/failure messages.
|
||||
*/
|
||||
ReturnValue_t callbackAfterSending( ReturnValue_t queueStatus );
|
||||
class CCSDSDistributor : public TcDistributor,
|
||||
public CCSDSDistributorIF,
|
||||
public AcceptsTelecommandsIF {
|
||||
public:
|
||||
/**
|
||||
* The constructor sets the default APID and calls the TcDistributor ctor with a certain object id.
|
||||
* \c tcStore is set in the \c initialize method.
|
||||
* @param set_default_apid The default APID, where packets with unknown destination are sent to.
|
||||
* @brief The constructor sets the default APID and calls the
|
||||
* TcDistributor ctor with a certain object id.
|
||||
* @details
|
||||
* @c tcStore is set in the @c initialize method.
|
||||
* @param setDefaultApid The default APID, where packets with unknown
|
||||
* destination are sent to.
|
||||
*/
|
||||
CCSDSDistributor( uint16_t setDefaultApid, object_id_t setObjectId );
|
||||
CCSDSDistributor(uint16_t setDefaultApid, object_id_t setObjectId);
|
||||
/**
|
||||
* The destructor is empty.
|
||||
*/
|
||||
~CCSDSDistributor();
|
||||
MessageQueueId_t getRequestQueue();
|
||||
ReturnValue_t registerApplication( uint16_t apid, MessageQueueId_t id );
|
||||
ReturnValue_t registerApplication( AcceptsTelecommandsIF* application );
|
||||
uint16_t getIdentifier();
|
||||
ReturnValue_t initialize();
|
||||
virtual ~CCSDSDistributor();
|
||||
|
||||
MessageQueueId_t getRequestQueue() override;
|
||||
ReturnValue_t registerApplication( uint16_t apid,
|
||||
MessageQueueId_t id) override;
|
||||
ReturnValue_t registerApplication(
|
||||
AcceptsTelecommandsIF* application) override;
|
||||
uint16_t getIdentifier() override;
|
||||
ReturnValue_t initialize() override;
|
||||
|
||||
protected:
|
||||
/**
|
||||
* This implementation checks if an application with fitting APID has
|
||||
* registered and forwards the packet to the according message queue.
|
||||
* If the packet is not found, it returns the queue to @c defaultApid,
|
||||
* where a Acceptance Failure message should be generated.
|
||||
* @return Iterator to map entry of found APID or iterator to default APID.
|
||||
*/
|
||||
TcMqMapIter selectDestination() override;
|
||||
/**
|
||||
* The callback here handles the generation of acceptance
|
||||
* success/failure messages.
|
||||
*/
|
||||
ReturnValue_t callbackAfterSending( ReturnValue_t queueStatus ) override;
|
||||
|
||||
/**
|
||||
* The default APID, where packets with unknown APID are sent to.
|
||||
*/
|
||||
uint16_t defaultApid;
|
||||
/**
|
||||
* A reference to the TC storage must be maintained, as this class handles
|
||||
* pure Space Packets and there exists no SpacePacketStored class.
|
||||
*/
|
||||
StorageManagerIF* tcStore = nullptr;
|
||||
|
||||
};
|
||||
|
||||
|
||||
|
||||
#endif /* CCSDSDISTRIBUTOR_H_ */
|
||||
#endif /* FRAMEWORK_TCDISTRIBUTION_CCSDSDISTRIBUTOR_H_ */
|
||||
|
||||
@ -1,34 +1,38 @@
|
||||
#ifndef CCSDSDISTRIBUTORIF_H_
|
||||
#define CCSDSDISTRIBUTORIF_H_
|
||||
#ifndef FSFW_TCDISTRIBUTION_CCSDSDISTRIBUTORIF_H_
|
||||
#define FSFW_TCDISTRIBUTION_CCSDSDISTRIBUTORIF_H_
|
||||
|
||||
#include "../tmtcservices/AcceptsTelecommandsIF.h"
|
||||
#include "../ipc/MessageQueueSenderIF.h"
|
||||
/**
|
||||
* This is the Interface to a CCSDS Distributor.
|
||||
* On a CCSDS Distributor, Applications (in terms of CCSDS) may register themselves,
|
||||
* either by passing a pointer to themselves (and implementing the CCSDSApplicationIF,
|
||||
* or by explicitly passing an APID and a MessageQueueId to route the TC's to.
|
||||
* \ingroup tc_distribution
|
||||
* On a CCSDS Distributor, Applications (in terms of CCSDS) may register
|
||||
* themselves, either by passing a pointer to themselves (and implementing the
|
||||
* CCSDSApplicationIF), or by explicitly passing an APID and a MessageQueueId
|
||||
* to route the TC's to.
|
||||
* @ingroup tc_distribution
|
||||
*/
|
||||
class CCSDSDistributorIF {
|
||||
public:
|
||||
/**
|
||||
* With this call, a class implementing the CCSDSApplicationIF can register at the
|
||||
* distributor.
|
||||
* With this call, a class implementing the CCSDSApplicationIF can register
|
||||
* at the distributor.
|
||||
* @param application A pointer to the Application to register.
|
||||
* @return - \c RETURN_OK on success,
|
||||
* - \c RETURN_FAILED on failure.
|
||||
* @return - @c RETURN_OK on success,
|
||||
* - @c RETURN_FAILED on failure.
|
||||
*/
|
||||
virtual ReturnValue_t registerApplication( AcceptsTelecommandsIF* application ) = 0;
|
||||
virtual ReturnValue_t registerApplication(
|
||||
AcceptsTelecommandsIF* application) = 0;
|
||||
/**
|
||||
* With this call, other Applications can register to the CCSDS distributor.
|
||||
* This is done by passing an APID and a MessageQueueId to the method.
|
||||
* @param apid The APID to register.
|
||||
* @param id The MessageQueueId of the message queue to send the TC Packets to.
|
||||
* @return - \c RETURN_OK on success,
|
||||
* - \c RETURN_FAILED on failure.
|
||||
* @param id The MessageQueueId of the message queue to send the
|
||||
* TC Packets to.
|
||||
* @return - @c RETURN_OK on success,
|
||||
* - @c RETURN_FAILED on failure.
|
||||
*/
|
||||
virtual ReturnValue_t registerApplication( uint16_t apid, MessageQueueId_t id ) = 0;
|
||||
virtual ReturnValue_t registerApplication( uint16_t apid,
|
||||
MessageQueueId_t id) = 0;
|
||||
/**
|
||||
* The empty virtual destructor.
|
||||
*/
|
||||
@ -37,4 +41,4 @@ public:
|
||||
};
|
||||
|
||||
|
||||
#endif /* CCSDSDISTRIBUTORIF_H_ */
|
||||
#endif /* FSFW_TCDISTRIBUTION_CCSDSDISTRIBUTORIF_H_ */
|
||||
|
||||
@ -1,61 +1,71 @@
|
||||
#include "../serviceinterface/ServiceInterfaceStream.h"
|
||||
#include "CCSDSDistributorIF.h"
|
||||
#include "PUSDistributor.h"
|
||||
|
||||
#include "../serviceinterface/ServiceInterfaceStream.h"
|
||||
#include "../tmtcpacket/pus/TcPacketStored.h"
|
||||
#include "../tmtcservices/PusVerificationReport.h"
|
||||
|
||||
PUSDistributor::PUSDistributor(uint16_t setApid, object_id_t setObjectId, object_id_t setPacketSource) :
|
||||
TcDistributor(setObjectId), checker(setApid), verifyChannel(), currentPacket(), tcStatus(
|
||||
RETURN_FAILED), packetSource(setPacketSource) {
|
||||
PUSDistributor::PUSDistributor(uint16_t setApid, object_id_t setObjectId,
|
||||
object_id_t setPacketSource) :
|
||||
TcDistributor(setObjectId), checker(setApid), verifyChannel(),
|
||||
tcStatus(RETURN_FAILED), packetSource(setPacketSource) {}
|
||||
|
||||
}
|
||||
PUSDistributor::~PUSDistributor() {}
|
||||
|
||||
PUSDistributor::~PUSDistributor() {
|
||||
|
||||
}
|
||||
|
||||
iterator_t PUSDistributor::selectDestination() {
|
||||
// debug << "PUSDistributor::handlePacket received: " << this->current_packet_id.store_index << ", " << this->current_packet_id.packet_index << std::endl;
|
||||
iterator_t queueMapIt = this->queueMap.end();
|
||||
this->currentPacket.setStoreAddress(this->currentMessage.getStorageId());
|
||||
if (currentPacket.getWholeData() != NULL) {
|
||||
tcStatus = checker.checkPacket(¤tPacket);
|
||||
// info << "PUSDistributor::handlePacket: packetCheck returned with " << (int)tc_status << std::endl;
|
||||
uint32_t queue_id = currentPacket.getService();
|
||||
PUSDistributor::TcMqMapIter PUSDistributor::selectDestination() {
|
||||
// sif:: debug << "PUSDistributor::handlePacket received: "
|
||||
// << this->current_packet_id.store_index << ", "
|
||||
// << this->current_packet_id.packet_index << std::endl;
|
||||
TcMqMapIter queueMapIt = this->queueMap.end();
|
||||
if(this->currentPacket == nullptr) {
|
||||
return queueMapIt;
|
||||
}
|
||||
this->currentPacket->setStoreAddress(this->currentMessage.getStorageId());
|
||||
if (currentPacket->getWholeData() != nullptr) {
|
||||
tcStatus = checker.checkPacket(currentPacket);
|
||||
#ifdef DEBUG
|
||||
if(tcStatus != HasReturnvaluesIF::RETURN_OK) {
|
||||
sif::debug << "PUSDistributor::handlePacket: Packet format "
|
||||
<< "invalid, code "<< static_cast<int>(tcStatus)
|
||||
<< std::endl;
|
||||
}
|
||||
#endif
|
||||
uint32_t queue_id = currentPacket->getService();
|
||||
queueMapIt = this->queueMap.find(queue_id);
|
||||
} else {
|
||||
}
|
||||
else {
|
||||
tcStatus = PACKET_LOST;
|
||||
}
|
||||
|
||||
if (queueMapIt == this->queueMap.end()) {
|
||||
tcStatus = DESTINATION_NOT_FOUND;
|
||||
#ifdef DEBUG
|
||||
sif::debug << "PUSDistributor::handlePacket: Destination not found, "
|
||||
<< "code "<< static_cast<int>(tcStatus) << std::endl;
|
||||
#endif
|
||||
}
|
||||
|
||||
if (tcStatus != RETURN_OK) {
|
||||
sif::debug << "PUSDistributor::handlePacket: error with " << (int) tcStatus
|
||||
<< std::endl;
|
||||
return this->queueMap.end();
|
||||
} else {
|
||||
}
|
||||
else {
|
||||
return queueMapIt;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
//uint16_t PUSDistributor::createDestination( uint8_t service_id, uint8_t subservice_id ) {
|
||||
// return ( service_id << 8 ) + subservice_id;
|
||||
//}
|
||||
|
||||
ReturnValue_t PUSDistributor::registerService(AcceptsTelecommandsIF* service) {
|
||||
ReturnValue_t returnValue = RETURN_OK;
|
||||
bool errorCode = true;
|
||||
uint16_t serviceId = service->getIdentifier();
|
||||
// sif::info << "Service ID: " << (int)serviceId << std::endl;
|
||||
MessageQueueId_t queue = service->getRequestQueue();
|
||||
errorCode = this->queueMap.insert(
|
||||
std::pair<uint32_t, MessageQueueId_t>(serviceId, queue)).second;
|
||||
if (errorCode == false) {
|
||||
//TODO Return Code
|
||||
returnValue = MessageQueueIF::NO_QUEUE;
|
||||
auto returnPair = queueMap.emplace(serviceId, queue);
|
||||
if (not returnPair.second) {
|
||||
sif::error << "PUSDistributor::registerService: Service ID already"
|
||||
" exists in map." << std::endl;
|
||||
return SERVICE_ID_ALREADY_EXISTS;
|
||||
}
|
||||
return returnValue;
|
||||
return HasReturnvaluesIF::RETURN_OK;
|
||||
}
|
||||
|
||||
MessageQueueId_t PUSDistributor::getRequestQueue() {
|
||||
@ -68,13 +78,14 @@ ReturnValue_t PUSDistributor::callbackAfterSending(ReturnValue_t queueStatus) {
|
||||
}
|
||||
if (tcStatus != RETURN_OK) {
|
||||
this->verifyChannel.sendFailureReport(TC_VERIFY::ACCEPTANCE_FAILURE,
|
||||
¤tPacket, tcStatus);
|
||||
//A failed packet is deleted immediately after reporting, otherwise it will block memory.
|
||||
currentPacket.deletePacket();
|
||||
currentPacket, tcStatus);
|
||||
// A failed packet is deleted immediately after reporting,
|
||||
// otherwise it will block memory.
|
||||
currentPacket->deletePacket();
|
||||
return RETURN_FAILED;
|
||||
} else {
|
||||
this->verifyChannel.sendSuccessReport(TC_VERIFY::ACCEPTANCE_SUCCESS,
|
||||
¤tPacket);
|
||||
currentPacket);
|
||||
return RETURN_OK;
|
||||
}
|
||||
}
|
||||
@ -84,11 +95,19 @@ uint16_t PUSDistributor::getIdentifier() {
|
||||
}
|
||||
|
||||
ReturnValue_t PUSDistributor::initialize() {
|
||||
currentPacket = new TcPacketStored();
|
||||
if(currentPacket == nullptr) {
|
||||
// Should not happen, memory allocation failed!
|
||||
return ObjectManagerIF::CHILD_INIT_FAILED;
|
||||
}
|
||||
|
||||
CCSDSDistributorIF* ccsdsDistributor =
|
||||
objectManager->get<CCSDSDistributorIF>(packetSource);
|
||||
if (ccsdsDistributor == NULL) {
|
||||
if (ccsdsDistributor == nullptr) {
|
||||
sif::error << "PUSDistributor::initialize: Packet source invalid."
|
||||
<< " Make sure it exists and implements CCSDSDistributorIF!"
|
||||
<< std::endl;
|
||||
return RETURN_FAILED;
|
||||
} else {
|
||||
return ccsdsDistributor->registerApplication(this);
|
||||
}
|
||||
return ccsdsDistributor->registerApplication(this);
|
||||
}
|
||||
|
||||
@ -1,67 +1,79 @@
|
||||
#ifndef PUSDISTRIBUTOR_H_
|
||||
#define PUSDISTRIBUTOR_H_
|
||||
#ifndef FSFW_TCDISTRIBUTION_PUSDISTRIBUTOR_H_
|
||||
#define FSFW_TCDISTRIBUTION_PUSDISTRIBUTOR_H_
|
||||
|
||||
#include "../returnvalues/HasReturnvaluesIF.h"
|
||||
#include "PUSDistributorIF.h"
|
||||
#include "TcDistributor.h"
|
||||
#include "TcPacketCheck.h"
|
||||
|
||||
#include "../returnvalues/HasReturnvaluesIF.h"
|
||||
#include "../tmtcservices/AcceptsTelecommandsIF.h"
|
||||
#include "../tmtcservices/VerificationReporter.h"
|
||||
|
||||
/**
|
||||
* This class accepts PUS Telecommands and forwards them to Application services.
|
||||
* In addition, the class performs a formal packet check and sends acceptance success
|
||||
* or failure messages.
|
||||
* \ingroup tc_distribution
|
||||
* This class accepts PUS Telecommands and forwards them to Application
|
||||
* services. In addition, the class performs a formal packet check and
|
||||
* sends acceptance success or failure messages.
|
||||
* @ingroup tc_distribution
|
||||
*/
|
||||
class PUSDistributor: public TcDistributor,
|
||||
public PUSDistributorIF,
|
||||
public AcceptsTelecommandsIF {
|
||||
public:
|
||||
/**
|
||||
* The ctor passes \c set_apid to the checker class and calls the TcDistribution ctor with a certain object id.
|
||||
* The ctor passes @c set_apid to the checker class and calls the
|
||||
* TcDistribution ctor with a certain object id.
|
||||
* @param setApid The APID of this receiving Application.
|
||||
* @param setObjectId Object ID of the distributor itself
|
||||
* @param setPacketSource Object ID of the source of TC packets. Must implement CCSDSDistributorIF.
|
||||
* @param setPacketSource Object ID of the source of TC packets.
|
||||
* Must implement CCSDSDistributorIF.
|
||||
*/
|
||||
PUSDistributor(uint16_t setApid, object_id_t setObjectId, object_id_t setPacketSource);
|
||||
PUSDistributor(uint16_t setApid, object_id_t setObjectId,
|
||||
object_id_t setPacketSource);
|
||||
/**
|
||||
* The destructor is empty.
|
||||
*/
|
||||
virtual ~PUSDistributor();
|
||||
ReturnValue_t registerService(AcceptsTelecommandsIF* service);
|
||||
MessageQueueId_t getRequestQueue();
|
||||
uint16_t getIdentifier();
|
||||
ReturnValue_t initialize();
|
||||
ReturnValue_t registerService(AcceptsTelecommandsIF* service) override;
|
||||
MessageQueueId_t getRequestQueue() override;
|
||||
ReturnValue_t initialize() override;
|
||||
uint16_t getIdentifier() override;
|
||||
|
||||
protected:
|
||||
/**
|
||||
* This attribute contains the class, that performs a formal packet check.
|
||||
*/
|
||||
TcPacketCheck checker;
|
||||
/**
|
||||
* With this class, verification messages are sent to the TC Verification service.
|
||||
* With this class, verification messages are sent to the
|
||||
* TC Verification service.
|
||||
*/
|
||||
VerificationReporter verifyChannel;
|
||||
/**
|
||||
* The currently handled packet is stored here.
|
||||
*/
|
||||
TcPacketStored currentPacket;
|
||||
TcPacketStored* currentPacket = nullptr;
|
||||
/**
|
||||
* With this variable, the current check status is stored to generate acceptance messages later.
|
||||
* With this variable, the current check status is stored to generate
|
||||
* acceptance messages later.
|
||||
*/
|
||||
ReturnValue_t tcStatus;
|
||||
|
||||
const object_id_t packetSource;
|
||||
|
||||
/**
|
||||
* This method reads the packet service, checks if such a service is registered and forwards the packet to the destination.
|
||||
* It also initiates the formal packet check and sending of verification messages.
|
||||
* @return Iterator to map entry of found service id or iterator to \c map.end().
|
||||
* This method reads the packet service, checks if such a service is
|
||||
* registered and forwards the packet to the destination.
|
||||
* It also initiates the formal packet check and sending of verification
|
||||
* messages.
|
||||
* @return Iterator to map entry of found service id
|
||||
* or iterator to @c map.end().
|
||||
*/
|
||||
iterator_t selectDestination();
|
||||
TcMqMapIter selectDestination() override;
|
||||
/**
|
||||
* The callback here handles the generation of acceptance success/failure messages.
|
||||
* The callback here handles the generation of acceptance
|
||||
* success/failure messages.
|
||||
*/
|
||||
ReturnValue_t callbackAfterSending(ReturnValue_t queueStatus);
|
||||
ReturnValue_t callbackAfterSending(ReturnValue_t queueStatus) override;
|
||||
};
|
||||
|
||||
#endif /* PUSDISTRIBUTOR_H_ */
|
||||
#endif /* FSFW_TCDISTRIBUTION_PUSDISTRIBUTOR_H_ */
|
||||
|
||||
@ -1,11 +1,12 @@
|
||||
#ifndef PUSDISTRIBUTORIF_H_
|
||||
#define PUSDISTRIBUTORIF_H_
|
||||
#ifndef FSFW_TCDISTRIBUTION_PUSDISTRIBUTORIF_H_
|
||||
#define FSFW_TCDISTRIBUTION_PUSDISTRIBUTORIF_H_
|
||||
|
||||
#include "../tmtcservices/AcceptsTelecommandsIF.h"
|
||||
#include "../ipc/MessageQueueSenderIF.h"
|
||||
|
||||
/**
|
||||
* This interface allows PUS Services to register themselves at a PUS Distributor.
|
||||
* \ingroup tc_distribution
|
||||
* @ingroup tc_distribution
|
||||
*/
|
||||
class PUSDistributorIF {
|
||||
public:
|
||||
@ -17,10 +18,10 @@ public:
|
||||
/**
|
||||
* With this method, Services can register themselves at the PUS Distributor.
|
||||
* @param service A pointer to the registering Service.
|
||||
* @return - \c RETURN_OK on success,
|
||||
* - \c RETURN_FAILED on failure.
|
||||
* @return - @c RETURN_OK on success,
|
||||
* - @c RETURN_FAILED on failure.
|
||||
*/
|
||||
virtual ReturnValue_t registerService( AcceptsTelecommandsIF* service ) = 0;
|
||||
};
|
||||
|
||||
#endif /* PUSDISTRIBUTORIF_H_ */
|
||||
#endif /* FSFW_TCDISTRIBUTION_PUSDISTRIBUTORIF_H_ */
|
||||
|
||||
@ -1,12 +1,13 @@
|
||||
#include "../serviceinterface/ServiceInterfaceStream.h"
|
||||
#include "../serviceinterface/ServiceInterfaceStream.h"
|
||||
#include "TcDistributor.h"
|
||||
|
||||
#include "../serviceinterface/ServiceInterfaceStream.h"
|
||||
#include "../tmtcservices/TmTcMessage.h"
|
||||
#include "../ipc/QueueFactory.h"
|
||||
|
||||
TcDistributor::TcDistributor(object_id_t set_object_id) :
|
||||
SystemObject(set_object_id), tcQueue(NULL) {
|
||||
tcQueue = QueueFactory::instance()->createMessageQueue(DISTRIBUTER_MAX_PACKETS);
|
||||
TcDistributor::TcDistributor(object_id_t objectId) :
|
||||
SystemObject(objectId) {
|
||||
tcQueue = QueueFactory::instance()->
|
||||
createMessageQueue(DISTRIBUTER_MAX_PACKETS);
|
||||
}
|
||||
|
||||
TcDistributor::~TcDistributor() {
|
||||
@ -15,7 +16,6 @@ TcDistributor::~TcDistributor() {
|
||||
|
||||
ReturnValue_t TcDistributor::performOperation(uint8_t opCode) {
|
||||
ReturnValue_t status = RETURN_OK;
|
||||
// debug << "TcDistributor: performing Operation." << std::endl;
|
||||
for (status = tcQueue->receiveMessage(¤tMessage); status == RETURN_OK;
|
||||
status = tcQueue->receiveMessage(¤tMessage)) {
|
||||
status = handlePacket();
|
||||
@ -29,7 +29,7 @@ ReturnValue_t TcDistributor::performOperation(uint8_t opCode) {
|
||||
|
||||
ReturnValue_t TcDistributor::handlePacket() {
|
||||
|
||||
iterator_t queueMapIt = this->selectDestination();
|
||||
TcMqMapIter queueMapIt = this->selectDestination();
|
||||
ReturnValue_t returnValue = RETURN_FAILED;
|
||||
if (queueMapIt != this->queueMap.end()) {
|
||||
returnValue = this->tcQueue->sendMessage(queueMapIt->second,
|
||||
@ -39,14 +39,14 @@ ReturnValue_t TcDistributor::handlePacket() {
|
||||
}
|
||||
|
||||
void TcDistributor::print() {
|
||||
sif::debug << "Distributor content is: " << std::endl << "ID\t| message queue id"
|
||||
<< std::endl;
|
||||
for (iterator_t it = this->queueMap.begin(); it != this->queueMap.end();
|
||||
it++) {
|
||||
sif::debug << it->first << "\t| 0x" << std::hex << it->second << std::dec
|
||||
sif::debug << "Distributor content is: " << std::endl
|
||||
<< "ID\t| Message Queue ID" << std::endl;
|
||||
sif::debug << std::setfill('0') << std::setw(8) << std::hex;
|
||||
for (const auto& queueMapIter: queueMap) {
|
||||
sif::debug << queueMapIter.first << "\t| 0x" << queueMapIter.second
|
||||
<< std::endl;
|
||||
}
|
||||
sif::debug << std::dec;
|
||||
sif::debug << std::setfill(' ') << std::dec;
|
||||
|
||||
}
|
||||
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
#ifndef TCDISTRIBUTOR_H_
|
||||
#define TCDISTRIBUTOR_H_
|
||||
#ifndef FSFW_TMTCSERVICES_TCDISTRIBUTOR_H_
|
||||
#define FSFW_TMTCSERVICES_TCDISTRIBUTOR_H_
|
||||
|
||||
#include "../objectmanager/ObjectManagerIF.h"
|
||||
#include "../objectmanager/SystemObject.h"
|
||||
#include "../returnvalues/HasReturnvaluesIF.h"
|
||||
@ -9,16 +10,12 @@
|
||||
#include "../ipc/MessageQueueIF.h"
|
||||
#include <map>
|
||||
|
||||
|
||||
/**
|
||||
* \defgroup tc_distribution Telecommand Distribution
|
||||
* All classes associated with Routing and Distribution of Telecommands belong to this group.
|
||||
* @defgroup tc_distribution Telecommand Distribution
|
||||
* All classes associated with Routing and Distribution of Telecommands
|
||||
* belong to this group.
|
||||
*/
|
||||
|
||||
/**
|
||||
* This typedef simplifies writing down the \c map iterator.
|
||||
*/
|
||||
typedef std::map<uint32_t, MessageQueueId_t>::iterator iterator_t;
|
||||
|
||||
/**
|
||||
* This is the base class to implement distributors for Space Packets.
|
||||
@ -28,62 +25,19 @@ typedef std::map<uint32_t, MessageQueueId_t>::iterator iterator_t;
|
||||
* message queue ids to some identifier. The process of unpacking the
|
||||
* destination information from the packet is handled by the child class
|
||||
* implementations.
|
||||
* \ingroup tc_distribution
|
||||
* @ingroup tc_distribution
|
||||
*/
|
||||
class TcDistributor : public SystemObject, public ExecutableObjectIF, public HasReturnvaluesIF {
|
||||
private:
|
||||
/**
|
||||
* This constant sets the maximum number of packets distributed per call.
|
||||
*/
|
||||
static const uint8_t DISTRIBUTER_MAX_PACKETS = 128;
|
||||
protected:
|
||||
/**
|
||||
* This is the receiving queue for incoming Telecommands.
|
||||
* The child classes must make its queue id public.
|
||||
*/
|
||||
MessageQueueIF* tcQueue;
|
||||
/**
|
||||
* The last received incoming packet information is stored in this
|
||||
* member.
|
||||
* As different child classes unpack the incoming packet differently
|
||||
* (i.e. as a CCSDS Space Packet or as a PUS Telecommand Packet), it
|
||||
* is not tried to unpack the packet information within this class.
|
||||
*/
|
||||
TmTcMessage currentMessage;
|
||||
/**
|
||||
* The map that links certain packet information to a destination.
|
||||
* The packet information may be the APID of the packet or the service
|
||||
* identifier. Filling of the map is under control of the different child
|
||||
* classes.
|
||||
*/
|
||||
std::map<uint32_t, MessageQueueId_t> queueMap;
|
||||
/**
|
||||
* This method shall unpack the routing information from the incoming
|
||||
* packet and select the map entry which represents the packet's target.
|
||||
* @return An iterator to the map element to forward to or queuMap.end().
|
||||
*/
|
||||
virtual iterator_t selectDestination() = 0;
|
||||
/**
|
||||
* The handlePacket method calls the child class's selectDestination method
|
||||
* and forwards the packet to its destination, if found.
|
||||
* @return The message queue return value or \c RETURN_FAILED, in case no
|
||||
* destination was found.
|
||||
*/
|
||||
ReturnValue_t handlePacket();
|
||||
/**
|
||||
* This method gives the child class a chance to perform some kind of operation
|
||||
* after the parent tried to forward the message.
|
||||
* A typically application would be sending success/failure messages.
|
||||
* The default implementation just returns \c RETURN_OK.
|
||||
* @param queueStatus The status of the message queue after an attempt to send the TC.
|
||||
* @return - \c RETURN_OK on success
|
||||
* - \c RETURN_FAILED on failure
|
||||
*/
|
||||
virtual ReturnValue_t callbackAfterSending( ReturnValue_t queueStatus );
|
||||
class TcDistributor : public SystemObject,
|
||||
public ExecutableObjectIF,
|
||||
public HasReturnvaluesIF {
|
||||
public:
|
||||
static const uint8_t INTERFACE_ID = CLASS_ID::PACKET_DISTRIBUTION;
|
||||
static const ReturnValue_t PACKET_LOST = MAKE_RETURN_CODE( 1 );
|
||||
static const ReturnValue_t DESTINATION_NOT_FOUND = MAKE_RETURN_CODE( 2 );
|
||||
using TcMessageQueueMap = std::map<uint32_t, MessageQueueId_t>;
|
||||
using TcMqMapIter = std::map<uint32_t, MessageQueueId_t>::iterator;
|
||||
|
||||
static constexpr uint8_t INTERFACE_ID = CLASS_ID::PACKET_DISTRIBUTION;
|
||||
static constexpr ReturnValue_t PACKET_LOST = MAKE_RETURN_CODE( 1 );
|
||||
static constexpr ReturnValue_t DESTINATION_NOT_FOUND = MAKE_RETURN_CODE( 2 );
|
||||
static constexpr ReturnValue_t SERVICE_ID_ALREADY_EXISTS = MAKE_RETURN_CODE(3);
|
||||
/**
|
||||
* Within the default constructor, the SystemObject id is set and the
|
||||
* message queue is initialized.
|
||||
@ -91,7 +45,7 @@ public:
|
||||
* @param set_object_id This id is assigned to the distributor
|
||||
* implementation.
|
||||
*/
|
||||
TcDistributor( object_id_t set_object_id );
|
||||
TcDistributor(object_id_t objectId);
|
||||
/**
|
||||
* The destructor is empty, the message queues are not in the vicinity of
|
||||
* this class.
|
||||
@ -110,7 +64,59 @@ public:
|
||||
* queueMap.
|
||||
*/
|
||||
void print();
|
||||
|
||||
protected:
|
||||
/**
|
||||
* This is the receiving queue for incoming Telecommands.
|
||||
* The child classes must make its queue id public.
|
||||
*/
|
||||
MessageQueueIF* tcQueue = nullptr;
|
||||
/**
|
||||
* The last received incoming packet information is stored in this
|
||||
* member.
|
||||
* As different child classes unpack the incoming packet differently
|
||||
* (i.e. as a CCSDS Space Packet or as a PUS Telecommand Packet), it
|
||||
* is not tried to unpack the packet information within this class.
|
||||
*/
|
||||
TmTcMessage currentMessage;
|
||||
/**
|
||||
* The map that links certain packet information to a destination.
|
||||
* The packet information may be the APID of the packet or the service
|
||||
* identifier. Filling of the map is under control of the different child
|
||||
* classes.
|
||||
*/
|
||||
TcMessageQueueMap queueMap;
|
||||
/**
|
||||
* This method shall unpack the routing information from the incoming
|
||||
* packet and select the map entry which represents the packet's target.
|
||||
* @return An iterator to the map element to forward to or queuMap.end().
|
||||
*/
|
||||
virtual TcMqMapIter selectDestination() = 0;
|
||||
/**
|
||||
* The handlePacket method calls the child class's selectDestination method
|
||||
* and forwards the packet to its destination, if found.
|
||||
* @return The message queue return value or @c RETURN_FAILED, in case no
|
||||
* destination was found.
|
||||
*/
|
||||
ReturnValue_t handlePacket();
|
||||
/**
|
||||
* This method gives the child class a chance to perform some kind of
|
||||
* operation after the parent tried to forward the message.
|
||||
* A typically application would be sending success/failure messages.
|
||||
* The default implementation just returns @c RETURN_OK.
|
||||
* @param queueStatus The status of the message queue after an attempt
|
||||
* to send the TC.
|
||||
* @return - @c RETURN_OK on success
|
||||
* - @c RETURN_FAILED on failure
|
||||
*/
|
||||
virtual ReturnValue_t callbackAfterSending( ReturnValue_t queueStatus );
|
||||
|
||||
private:
|
||||
/**
|
||||
* This constant sets the maximum number of packets distributed per call.
|
||||
*/
|
||||
static constexpr uint8_t DISTRIBUTER_MAX_PACKETS = 128;
|
||||
};
|
||||
|
||||
|
||||
#endif /* TCDISTRIBUTOR_H_ */
|
||||
#endif /* FSFW_TMTCSERVICES_TCDISTRIBUTOR_H_ */
|
||||
|
||||
@ -1,31 +1,33 @@
|
||||
#include "TcPacketCheck.h"
|
||||
|
||||
#include "../globalfunctions/CRC.h"
|
||||
#include "../serviceinterface/ServiceInterfaceStream.h"
|
||||
#include "../storagemanager/StorageManagerIF.h"
|
||||
#include "TcPacketCheck.h"
|
||||
#include "../tmtcservices/VerificationCodes.h"
|
||||
|
||||
TcPacketCheck::TcPacketCheck( uint16_t set_apid ) : apid(set_apid) {
|
||||
TcPacketCheck::TcPacketCheck( uint16_t setApid ) : apid(setApid) {
|
||||
}
|
||||
|
||||
ReturnValue_t TcPacketCheck::checkPacket( TcPacketStored* current_packet ) {
|
||||
uint16_t calculated_crc = CRC::crc16ccitt( current_packet->getWholeData(), current_packet->getFullSize() );
|
||||
ReturnValue_t TcPacketCheck::checkPacket( TcPacketStored* currentPacket ) {
|
||||
uint16_t calculated_crc = CRC::crc16ccitt( currentPacket->getWholeData(),
|
||||
currentPacket->getFullSize() );
|
||||
if ( calculated_crc != 0 ) {
|
||||
return INCORRECT_CHECKSUM;
|
||||
}
|
||||
bool condition = !(current_packet->hasSecondaryHeader()) ||
|
||||
current_packet->getPacketVersionNumber() != CCSDS_VERSION_NUMBER ||
|
||||
!(current_packet->isTelecommand());
|
||||
bool condition = (not currentPacket->hasSecondaryHeader()) or
|
||||
(currentPacket->getPacketVersionNumber() != CCSDS_VERSION_NUMBER) or
|
||||
(not currentPacket->isTelecommand());
|
||||
if ( condition ) {
|
||||
return INCORRECT_PRIMARY_HEADER;
|
||||
}
|
||||
if ( current_packet->getAPID() != this->apid )
|
||||
if ( currentPacket->getAPID() != this->apid )
|
||||
return ILLEGAL_APID;
|
||||
|
||||
if ( !current_packet->isSizeCorrect() ) {
|
||||
if ( not currentPacket->isSizeCorrect() ) {
|
||||
return INCOMPLETE_PACKET;
|
||||
}
|
||||
condition = (current_packet->getSecondaryHeaderFlag() != CCSDS_SECONDARY_HEADER_FLAG) ||
|
||||
(current_packet->getPusVersionNumber() != PUS_VERSION_NUMBER);
|
||||
condition = (currentPacket->getSecondaryHeaderFlag() != CCSDS_SECONDARY_HEADER_FLAG) ||
|
||||
(currentPacket->getPusVersionNumber() != PUS_VERSION_NUMBER);
|
||||
if ( condition ) {
|
||||
return INCORRECT_SECONDARY_HEADER;
|
||||
}
|
||||
|
||||
@ -1,28 +1,29 @@
|
||||
#ifndef TCPACKETCHECK_H_
|
||||
#define TCPACKETCHECK_H_
|
||||
#ifndef FSFW_TCDISTRIBUTION_TCPACKETCHECK_H_
|
||||
#define FSFW_TCDISTRIBUTION_TCPACKETCHECK_H_
|
||||
|
||||
#include "../returnvalues/HasReturnvaluesIF.h"
|
||||
#include "../tmtcpacket/pus/TcPacketStored.h"
|
||||
#include "../tmtcservices/PusVerificationReport.h"
|
||||
|
||||
/**
|
||||
* This class performs a formal packet check for incoming PUS Telecommand Packets.
|
||||
* Currently, it only checks if the APID and CRC are correct.
|
||||
* \ingroup tc_distribution
|
||||
* @ingroup tc_distribution
|
||||
*/
|
||||
class TcPacketCheck : public HasReturnvaluesIF {
|
||||
protected:
|
||||
/**
|
||||
* Describes the version number a packet must have to pass.
|
||||
*/
|
||||
static const uint8_t CCSDS_VERSION_NUMBER = 0;
|
||||
static constexpr uint8_t CCSDS_VERSION_NUMBER = 0;
|
||||
/**
|
||||
* Describes the secondary header a packet must have to pass.
|
||||
*/
|
||||
static const uint8_t CCSDS_SECONDARY_HEADER_FLAG = 0;
|
||||
static constexpr uint8_t CCSDS_SECONDARY_HEADER_FLAG = 0;
|
||||
/**
|
||||
* Describes the TC Packet PUS Version Number a packet must have to pass.
|
||||
*/
|
||||
static const uint8_t PUS_VERSION_NUMBER = 1;
|
||||
static constexpr uint8_t PUS_VERSION_NUMBER = 1;
|
||||
/**
|
||||
* The packet id each correct packet should have.
|
||||
* It is composed of the APID and some static fields.
|
||||
@ -41,19 +42,19 @@ public:
|
||||
* The constructor only sets the APID attribute.
|
||||
* @param set_apid The APID to set.
|
||||
*/
|
||||
TcPacketCheck( uint16_t set_apid );
|
||||
TcPacketCheck( uint16_t setApid );
|
||||
/**
|
||||
* This is the actual method to formally check a certain Telecommand Packet.
|
||||
* The packet's Application Data can not be checked here.
|
||||
* @param current_packet The packt to check
|
||||
* @return - \c RETURN_OK on success.
|
||||
* - \c INCORRECT_CHECKSUM if checksum is invalid.
|
||||
* - \c ILLEGAL_APID if APID does not match.
|
||||
* @return - @c RETURN_OK on success.
|
||||
* - @c INCORRECT_CHECKSUM if checksum is invalid.
|
||||
* - @c ILLEGAL_APID if APID does not match.
|
||||
*/
|
||||
ReturnValue_t checkPacket( TcPacketStored* current_packet );
|
||||
ReturnValue_t checkPacket( TcPacketStored* currentPacket );
|
||||
|
||||
uint16_t getApid() const;
|
||||
};
|
||||
|
||||
|
||||
#endif /* TCPACKETCHECK_H_ */
|
||||
#endif /* FSFW_TCDISTRIBUTION_TCPACKETCHECK_H_ */
|
||||
|
||||
Loading…
Reference in New Issue
Block a user