2022-07-19 18:13:25 +02:00
|
|
|
#include "fsfw/tcdistribution/PusDistributor.h"
|
2020-10-01 13:23:06 +02:00
|
|
|
|
2022-07-27 10:49:49 +02:00
|
|
|
#include "definitions.h"
|
2021-07-13 20:22:54 +02:00
|
|
|
#include "fsfw/objectmanager/ObjectManager.h"
|
|
|
|
#include "fsfw/serviceinterface/ServiceInterface.h"
|
2022-02-02 10:29:30 +01:00
|
|
|
#include "fsfw/tcdistribution/CCSDSDistributorIF.h"
|
2021-07-13 20:22:54 +02:00
|
|
|
#include "fsfw/tmtcservices/PusVerificationReport.h"
|
2016-06-15 23:48:41 +02:00
|
|
|
|
2022-07-27 17:13:42 +02:00
|
|
|
#define PUS_DISTRIBUTOR_DEBUGGING 0
|
2021-04-07 12:03:28 +02:00
|
|
|
|
2022-07-27 11:26:47 +02:00
|
|
|
PusDistributor::PusDistributor(uint16_t setApid, object_id_t setObjectId,
|
2022-07-27 14:40:51 +02:00
|
|
|
CCSDSDistributorIF* distributor, StorageManagerIF* store_)
|
2022-02-02 10:29:30 +01:00
|
|
|
: TcDistributor(setObjectId),
|
2022-07-19 18:13:25 +02:00
|
|
|
store(store_),
|
|
|
|
checker(setApid, ccsds::PacketType::TC),
|
2022-07-27 14:40:51 +02:00
|
|
|
ccsdsDistributor(distributor),
|
|
|
|
tcStatus(RETURN_FAILED) {}
|
2016-06-15 23:48:41 +02:00
|
|
|
|
2022-07-19 18:13:25 +02:00
|
|
|
PusDistributor::~PusDistributor() = default;
|
2016-06-15 23:48:41 +02:00
|
|
|
|
2022-07-19 18:13:25 +02:00
|
|
|
PusDistributor::TcMqMapIter PusDistributor::selectDestination() {
|
2021-04-07 12:03:28 +02:00
|
|
|
#if FSFW_CPP_OSTREAM_ENABLED == 1 && PUS_DISTRIBUTOR_DEBUGGING == 1
|
2022-07-27 17:00:43 +02:00
|
|
|
store_address_t storeId = currentMessage.getStorageId();
|
|
|
|
sif::debug << "PUSDistributor::handlePacket received: " << storeId.poolIndex << ", "
|
|
|
|
<< storeId.packetIndex << std::endl;
|
2021-01-03 13:58:18 +01:00
|
|
|
#endif
|
2022-07-27 17:00:43 +02:00
|
|
|
auto queueMapIt = queueMap.end();
|
|
|
|
// TODO: Need to set the data
|
|
|
|
const uint8_t* packetPtr = nullptr;
|
|
|
|
size_t packetLen = 0;
|
|
|
|
if (store->getData(currentMessage.getStorageId(), &packetPtr, &packetLen) !=
|
|
|
|
HasReturnvaluesIF::RETURN_OK) {
|
|
|
|
return queueMapIt;
|
|
|
|
}
|
|
|
|
ReturnValue_t result = reader.setReadOnlyData(packetPtr, packetLen);
|
|
|
|
if (result != HasReturnvaluesIF::RETURN_OK) {
|
|
|
|
tcStatus = PACKET_LOST;
|
|
|
|
return queueMapIt;
|
|
|
|
}
|
|
|
|
// CRC check done by checker
|
|
|
|
result = reader.parseDataWithoutCrcCheck();
|
|
|
|
if (result != HasReturnvaluesIF::RETURN_OK) {
|
|
|
|
tcStatus = PACKET_LOST;
|
|
|
|
return queueMapIt;
|
|
|
|
}
|
|
|
|
if (reader.getFullData() != nullptr) {
|
|
|
|
tcStatus = checker.checkPacket(reader, reader.getFullPacketLen());
|
|
|
|
if (tcStatus != HasReturnvaluesIF::RETURN_OK) {
|
|
|
|
checkerFailurePrinter();
|
2020-10-01 13:23:06 +02:00
|
|
|
}
|
2022-07-27 17:00:43 +02:00
|
|
|
uint32_t queue_id = reader.getService();
|
|
|
|
queueMapIt = queueMap.find(queue_id);
|
|
|
|
} else {
|
|
|
|
tcStatus = PACKET_LOST;
|
|
|
|
}
|
2016-06-15 23:48:41 +02:00
|
|
|
|
2022-07-27 17:00:43 +02:00
|
|
|
if (queueMapIt == this->queueMap.end()) {
|
|
|
|
tcStatus = DESTINATION_NOT_FOUND;
|
2021-04-07 12:03:28 +02:00
|
|
|
#if FSFW_VERBOSE_LEVEL >= 1
|
2021-01-03 14:16:52 +01:00
|
|
|
#if FSFW_CPP_OSTREAM_ENABLED == 1
|
2022-07-27 17:00:43 +02:00
|
|
|
sif::debug << "PUSDistributor::handlePacket: Destination not found" << std::endl;
|
2021-04-07 12:03:28 +02:00
|
|
|
#else
|
2022-07-27 17:00:43 +02:00
|
|
|
sif::printDebug("PUSDistributor::handlePacket: Destination not found\n");
|
2021-04-07 12:03:28 +02:00
|
|
|
#endif /* !FSFW_CPP_OSTREAM_ENABLED == 1 */
|
2020-10-01 13:23:06 +02:00
|
|
|
#endif
|
2022-07-27 17:00:43 +02:00
|
|
|
}
|
2016-06-15 23:48:41 +02:00
|
|
|
|
2022-07-27 17:00:43 +02:00
|
|
|
if (tcStatus != RETURN_OK) {
|
|
|
|
return this->queueMap.end();
|
|
|
|
} else {
|
|
|
|
return queueMapIt;
|
|
|
|
}
|
2016-06-15 23:48:41 +02:00
|
|
|
}
|
|
|
|
|
2022-07-19 18:13:25 +02:00
|
|
|
ReturnValue_t PusDistributor::registerService(AcceptsTelecommandsIF* service) {
|
2022-02-02 10:29:30 +01:00
|
|
|
uint16_t serviceId = service->getIdentifier();
|
2021-04-07 12:03:28 +02:00
|
|
|
#if PUS_DISTRIBUTOR_DEBUGGING == 1
|
2021-01-03 14:16:52 +01:00
|
|
|
#if FSFW_CPP_OSTREAM_ENABLED == 1
|
2022-02-02 10:29:30 +01:00
|
|
|
sif::info << "Service ID: " << static_cast<int>(serviceId) << std::endl;
|
2021-04-07 12:03:28 +02:00
|
|
|
#else
|
2022-02-02 10:29:30 +01:00
|
|
|
sif::printInfo("Service ID: %d\n", static_cast<int>(serviceId));
|
2021-04-07 12:03:28 +02:00
|
|
|
#endif
|
2021-01-03 13:58:18 +01:00
|
|
|
#endif
|
2022-02-02 10:29:30 +01:00
|
|
|
MessageQueueId_t queue = service->getRequestQueue();
|
|
|
|
auto returnPair = queueMap.emplace(serviceId, queue);
|
|
|
|
if (not returnPair.second) {
|
2021-04-07 12:03:28 +02:00
|
|
|
#if FSFW_VERBOSE_LEVEL >= 1
|
2021-01-03 14:16:52 +01:00
|
|
|
#if FSFW_CPP_OSTREAM_ENABLED == 1
|
2022-02-02 10:29:30 +01:00
|
|
|
sif::error << "PUSDistributor::registerService: Service ID already"
|
|
|
|
" exists in map"
|
|
|
|
<< std::endl;
|
2021-04-07 12:03:28 +02:00
|
|
|
#else
|
2022-02-02 10:29:30 +01:00
|
|
|
sif::printError("PUSDistributor::registerService: Service ID already exists in map\n");
|
2021-01-03 13:58:18 +01:00
|
|
|
#endif
|
2021-04-07 12:03:28 +02:00
|
|
|
#endif
|
2022-02-02 10:29:30 +01:00
|
|
|
return SERVICE_ID_ALREADY_EXISTS;
|
|
|
|
}
|
|
|
|
return HasReturnvaluesIF::RETURN_OK;
|
2016-06-15 23:48:41 +02:00
|
|
|
}
|
|
|
|
|
2022-07-19 18:13:25 +02:00
|
|
|
MessageQueueId_t PusDistributor::getRequestQueue() { return tcQueue->getId(); }
|
2016-06-15 23:48:41 +02:00
|
|
|
|
2022-07-19 18:13:25 +02:00
|
|
|
ReturnValue_t PusDistributor::callbackAfterSending(ReturnValue_t queueStatus) {
|
2022-02-02 10:29:30 +01:00
|
|
|
if (queueStatus != RETURN_OK) {
|
|
|
|
tcStatus = queueStatus;
|
|
|
|
}
|
|
|
|
if (tcStatus != RETURN_OK) {
|
2022-07-26 13:59:09 +02:00
|
|
|
verifyChannel->sendFailureReport(
|
|
|
|
VerifFailureParams(tcverif::ACCEPTANCE_FAILURE, reader, tcStatus));
|
2022-02-02 10:29:30 +01:00
|
|
|
// A failed packet is deleted immediately after reporting,
|
|
|
|
// otherwise it will block memory.
|
2022-07-19 18:13:25 +02:00
|
|
|
store->deleteData(currentMessage.getStorageId());
|
2022-02-02 10:29:30 +01:00
|
|
|
return RETURN_FAILED;
|
|
|
|
} else {
|
2022-07-26 13:59:09 +02:00
|
|
|
verifyChannel->sendSuccessReport(VerifSuccessParams(tcverif::ACCEPTANCE_SUCCESS, reader));
|
2022-02-02 10:29:30 +01:00
|
|
|
return RETURN_OK;
|
|
|
|
}
|
2016-06-15 23:48:41 +02:00
|
|
|
}
|
|
|
|
|
2022-07-19 18:13:25 +02:00
|
|
|
uint16_t PusDistributor::getIdentifier() { return checker.getApid(); }
|
2016-06-15 23:48:41 +02:00
|
|
|
|
2022-07-19 18:13:25 +02:00
|
|
|
ReturnValue_t PusDistributor::initialize() {
|
2022-07-27 14:40:51 +02:00
|
|
|
if (store == nullptr) {
|
|
|
|
store = ObjectManager::instance()->get<StorageManagerIF>(objects::TC_STORE);
|
|
|
|
if (store == nullptr) {
|
|
|
|
return ObjectManagerIF::CHILD_INIT_FAILED;
|
|
|
|
}
|
2022-02-02 10:29:30 +01:00
|
|
|
}
|
2022-07-27 17:00:43 +02:00
|
|
|
if (ccsdsDistributor == nullptr) {
|
2021-01-03 14:16:52 +01:00
|
|
|
#if FSFW_CPP_OSTREAM_ENABLED == 1
|
2022-02-02 10:29:30 +01:00
|
|
|
sif::error << "PUSDistributor::initialize: Packet source invalid" << std::endl;
|
|
|
|
sif::error << " Make sure it exists and implements CCSDSDistributorIF!" << std::endl;
|
2021-04-07 12:03:28 +02:00
|
|
|
#else
|
2022-07-19 18:13:25 +02:00
|
|
|
sif::printError("PusDistributor::initialize: Packet source invalid\n");
|
2022-02-02 10:29:30 +01:00
|
|
|
sif::printError("Make sure it exists and implements CCSDSDistributorIF\n");
|
2021-01-03 13:58:18 +01:00
|
|
|
#endif
|
2022-07-27 14:40:51 +02:00
|
|
|
return ObjectManagerIF::CHILD_INIT_FAILED;
|
2022-07-27 11:26:47 +02:00
|
|
|
}
|
2022-07-27 17:00:43 +02:00
|
|
|
if (verifyChannel == nullptr) {
|
|
|
|
verifyChannel = ObjectManager::instance()->get<VerificationReporterIF>(objects::TC_VERIFICATOR);
|
|
|
|
if (verifyChannel == nullptr) {
|
|
|
|
return ObjectManagerIF::CHILD_INIT_FAILED;
|
|
|
|
}
|
|
|
|
}
|
2022-02-02 10:29:30 +01:00
|
|
|
return ccsdsDistributor->registerApplication(this);
|
2016-06-15 23:48:41 +02:00
|
|
|
}
|
2022-07-27 17:00:43 +02:00
|
|
|
|
|
|
|
void PusDistributor::checkerFailurePrinter() const {
|
|
|
|
#if FSFW_VERBOSE_LEVEL >= 1
|
|
|
|
const char* keyword = "unnamed error";
|
|
|
|
if (tcStatus == tcdistrib::INCORRECT_CHECKSUM) {
|
|
|
|
keyword = "checksum";
|
|
|
|
} else if (tcStatus == tcdistrib::INCORRECT_PRIMARY_HEADER) {
|
|
|
|
keyword = "incorrect primary header";
|
|
|
|
} else if (tcStatus == tcdistrib::INVALID_APID) {
|
|
|
|
keyword = "illegal APID";
|
|
|
|
} else if (tcStatus == tcdistrib::INCORRECT_SECONDARY_HEADER) {
|
|
|
|
keyword = "incorrect secondary header";
|
|
|
|
} else if (tcStatus == tcdistrib::INCOMPLETE_PACKET) {
|
|
|
|
keyword = "incomplete packet";
|
|
|
|
}
|
|
|
|
#if FSFW_CPP_OSTREAM_ENABLED == 1
|
|
|
|
sif::warning << "PUSDistributor::handlePacket: Packet format invalid, " << keyword << " error"
|
|
|
|
<< std::endl;
|
|
|
|
#else
|
|
|
|
sif::printWarning("PUSDistributor::handlePacket: Packet format invalid, %s error\n", keyword);
|
|
|
|
#endif
|
|
|
|
#endif
|
|
|
|
}
|