restructure repository

src/core/serviceinterface/CMakeLists.txt

@@ -0,0 +1,5 @@
+target_sources(${LIB_FSFW_NAME} PRIVATE 
+	ServiceInterfaceStream.cpp
+	ServiceInterfaceBuffer.cpp
+	ServiceInterfacePrinter.cpp
+)

src/core/serviceinterface/ServiceInterfaceBuffer.cpp

@@ -0,0 +1,268 @@
+#include "ServiceInterfaceBuffer.h"
+
+#if FSFW_CPP_OSTREAM_ENABLED == 1
+
+#include "../timemanager/Clock.h"
+
+#include "serviceInterfaceDefintions.h"
+#include <cstring>
+#include <inttypes.h>
+
+#if defined(WIN32) && FSFW_COLORED_OUTPUT == 1
+#include "Windows.h"
+#endif
+
+// to be implemented by bsp
+extern "C" void printChar(const char*, bool errStream);
+
+#ifndef UT699
+
+ServiceInterfaceBuffer::ServiceInterfaceBuffer(std::string setMessage,
+		bool addCrToPreamble, bool buffered , bool errStream, uint16_t port):
+		isActive(true), logMessage(setMessage),
+		addCrToPreamble(addCrToPreamble), buffered(buffered),
+		errStream(errStream) {
+	if(buffered) {
+		// Set pointers if the stream is buffered.
+		setp( buf, buf + BUF_SIZE );
+	}
+
+#if FSFW_COLORED_OUTPUT == 1
+	if(setMessage.find("DEBUG") != std::string::npos) {
+		colorPrefix = sif::ANSI_COLOR_CYAN;
+	}
+	else if(setMessage.find("INFO") != std::string::npos) {
+		colorPrefix = sif::ANSI_COLOR_GREEN;
+	}
+	else if(setMessage.find("WARNING") != std::string::npos) {
+		colorPrefix = sif::ANSI_COLOR_MAGENTA;
+	}
+	else if(setMessage.find("ERROR") != std::string::npos) {
+		colorPrefix = sif::ANSI_COLOR_RED;
+	}
+	else {
+		colorPrefix = sif::ANSI_COLOR_RESET;
+	}
+
+#ifdef WIN32
+	HANDLE hOut = GetStdHandle(STD_OUTPUT_HANDLE);
+	DWORD dwMode = 0;
+	GetConsoleMode(hOut, &dwMode);
+	dwMode |= ENABLE_VIRTUAL_TERMINAL_PROCESSING;
+	SetConsoleMode(hOut, dwMode);
+#endif
+
+#endif
+
+	preamble.reserve(MAX_PREAMBLE_SIZE);
+	preamble.resize(MAX_PREAMBLE_SIZE);
+}
+
+void ServiceInterfaceBuffer::putChars(char const* begin, char const* end) {
+	char array[BUF_SIZE];
+	uint32_t length = end - begin;
+	if (length > sizeof(array)) {
+		length = sizeof(array);
+	}
+	memcpy(array, begin, length);
+
+	for(; begin != end; begin++){
+		if(errStream) {
+			printChar(begin, true);
+		}
+		else {
+			printChar(begin, false);
+		}
+	}
+}
+
+#endif
+
+int ServiceInterfaceBuffer::overflow(int c) {
+	if(not buffered and this->isActive) {
+		if (c != Traits::eof()) {
+			if(errStream) {
+				printChar(reinterpret_cast<const char*>(&c), true);
+			}
+			else {
+				printChar(reinterpret_cast<const char*>(&c), false);
+			}
+		}
+		return 0;
+	}
+	// Handle output
+	putChars(pbase(), pptr());
+	if (c != Traits::eof()) {
+		char c2 = c;
+		// Handle the one character that didn't fit to buffer
+		putChars(&c2, &c2 + 1);
+	}
+	// This tells that buffer is empty again
+	setp(buf, buf + BUF_SIZE - 1);
+	// I'm not sure about this return value!
+	return 0;
+}
+
+int ServiceInterfaceBuffer::sync(void) {
+	if(not this->isActive and not buffered) {
+		if(not buffered) {
+			setp(buf, buf + BUF_SIZE - 1);
+		}
+		return 0;
+	}
+	if(not buffered) {
+		return 0;
+	}
+
+	size_t preambleSize  = 0;
+	std::string* preamble = getPreamble(&preambleSize);
+	// Write logMessage and time
+	this->putChars(preamble->data(), preamble->data() + preambleSize);
+	// Handle output
+	this->putChars(pbase(), pptr());
+	// This tells that buffer is empty again
+	setp(buf, buf + BUF_SIZE - 1);
+	return 0;
+}
+
+bool ServiceInterfaceBuffer::isBuffered() const {
+	return buffered;
+}
+
+std::string* ServiceInterfaceBuffer::getPreamble(size_t * preambleSize) {
+	Clock::TimeOfDay_t loggerTime;
+	Clock::getDateAndTime(&loggerTime);
+	size_t currentSize = 0;
+	char* parsePosition = &preamble[0];
+	if(addCrToPreamble) {
+		preamble[0] = '\r';
+		currentSize += 1;
+		parsePosition += 1;
+	}
+
+#if FSFW_COLORED_OUTPUT == 1
+	currentSize += sprintf(parsePosition, "%s", colorPrefix.c_str());
+	parsePosition += colorPrefix.size();
+#endif
+
+	int32_t charCount = sprintf(parsePosition,
+			"%s: | %02" SCNu32 ":%02" SCNu32 ":%02" SCNu32 ".%03" SCNu32 " | ",
+					this->logMessage.c_str(), loggerTime.hour,
+					loggerTime.minute,
+					loggerTime.second,
+					loggerTime.usecond /1000);
+	if(charCount < 0) {
+		printf("ServiceInterfaceBuffer: Failure parsing preamble\r\n");
+		return &preamble;
+	}
+	if(charCount > MAX_PREAMBLE_SIZE) {
+		printf("ServiceInterfaceBuffer: Char count too large for maximum "
+				"preamble size");
+		return &preamble;
+	}
+	currentSize += charCount;
+	if(preambleSize != nullptr) {
+		*preambleSize = currentSize;
+	}
+	return &preamble;
+}
+
+bool ServiceInterfaceBuffer::crAdditionEnabled() const {
+    return addCrToPreamble;
+}
+
+void ServiceInterfaceBuffer::setAsciiColorPrefix(std::string colorPrefix) {
+    this->colorPrefix = colorPrefix;
+}
+
+#ifdef UT699
+#include "../osal/rtems/Interrupt.h"
+
+ServiceInterfaceBuffer::ServiceInterfaceBuffer(std::string set_message,
+		uint16_t port) {
+	this->log_message = set_message;
+	this->isActive = true;
+	setp( buf, buf + BUF_SIZE );
+}
+
+void ServiceInterfaceBuffer::putChars(char const* begin, char const* end) {
+	char array[BUF_SIZE];
+	uint32_t length = end - begin;
+	if (length > sizeof(array)) {
+		length = sizeof(array);
+	}
+	memcpy(array, begin, length);
+
+	if (!Interrupt::isInterruptInProgress()) {
+		std::cout << array;
+	} else {
+		//Uncomment the following line if you need ISR debug output.
+//		printk(array);
+	}
+}
+#endif //UT699
+
+#ifdef ML505
+#include <bsp_flp/network/networkconfig.h>
+ServiceInterfaceBuffer::ServiceInterfaceBuffer(std::string set_message,
+		uint16_t port) :
+		isActive(true), log_message(set_message), udpSocket(0), remoteAddressLength(
+				sizeof(remoteAddress)) {
+	setp(buf, buf + BUF_SIZE);
+	memset((uint8_t*) &remoteAddress, 0, sizeof(remoteAddress));
+	remoteAddress.sin_family = AF_INET;
+	remoteAddress.sin_port = htons(port);
+	remoteAddress.sin_addr.s_addr = htonl(inet_addr("192.168.250.100"));
+}
+
+void ServiceInterfaceBuffer::putChars(char const* begin, char const* end) {
+
+	char array[BUF_SIZE];
+	uint32_t length = end - begin;
+	if (length > sizeof(array)) {
+		length = sizeof(array);
+	}
+	memcpy(array, begin, length);
+
+	if (udpSocket <= 0) {
+		initSocket();
+	}
+
+	if (udpSocket > 0) {
+		sendto(udpSocket, array, length, 0, (sockaddr*) &remoteAddress,
+				sizeof(remoteAddress));
+	}
+
+}
+
+void ServiceInterfaceBuffer::initSocket() {
+	sockaddr_in address;
+	memset((uint8_t*) &address, 0, sizeof(address));
+	address.sin_family = AF_INET;
+	address.sin_port = htons(0);
+	address.sin_addr.s_addr = htonl(INADDR_ANY);
+
+	udpSocket = socket(PF_INET, SOCK_DGRAM, 0);
+	if (socket < 0) {
+		printf("Error opening socket!\n");
+		return;
+	}
+	timeval timeout = { 0, 20 };
+	if (setsockopt(udpSocket, SOL_SOCKET, SO_RCVTIMEO, &timeout,
+			sizeof(timeout)) < 0) {
+		printf("Error setting SO_RCVTIMEO socket options!\n");
+		return;
+	}
+	if (setsockopt(udpSocket, SOL_SOCKET, SO_SNDTIMEO, &timeout,
+			sizeof(timeout)) < 0) {
+		printf("Error setting SO_SNDTIMEO socket options!\n");
+		return;
+	}
+	if (bind(udpSocket, (sockaddr *) &address, sizeof(address)) < 0) {
+		printf("Error binding socket!\n");
+	}
+}
+
+#endif //ML505
+
+#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */

src/core/serviceinterface/ServiceInterfacePrinter.cpp

@@ -0,0 +1,140 @@
+#include <FSFWConfig.h>
+#include "ServiceInterfacePrinter.h"
+#include "serviceInterfaceDefintions.h"
+#include "../timemanager/Clock.h"
+
+#include <cstdarg>
+#include <cstdint>
+
+static sif::PrintLevel printLevel = sif::PrintLevel::DEBUG_LEVEL;
+#if defined(WIN32) && FSFW_COLORED_OUTPUT == 1
+static bool consoleInitialized = false;
+#endif /* defined(WIN32) && FSFW_COLORED_OUTPUT == 1 */
+
+#if FSFW_DISABLE_PRINTOUT == 0
+
+static bool addCrAtEnd = false;
+
+uint8_t printBuffer[fsfwconfig::FSFW_PRINT_BUFFER_SIZE];
+
+void fsfwPrint(sif::PrintLevel printType, const char* fmt, va_list arg) {
+
+#if defined(WIN32) && FSFW_COLORED_OUTPUT == 1
+	if(not consoleInitialized) {
+		HANDLE hOut = GetStdHandle(STD_OUTPUT_HANDLE);
+		DWORD dwMode = 0;
+		GetConsoleMode(hOut, &dwMode);
+		dwMode |= ENABLE_VIRTUAL_TERMINAL_PROCESSING;
+		SetConsoleMode(hOut, dwMode);
+	}
+	consoleInitialized = true;
+#endif
+
+    size_t len = 0;
+    char* bufferPosition = reinterpret_cast<char*>(printBuffer);
+
+    /* Check logger level */
+    if(printType == sif::PrintLevel::NONE or printType > printLevel) {
+        return;
+    }
+
+    /* Log message to terminal */
+
+#if FSFW_COLORED_OUTPUT == 1
+    if(printType == sif::PrintLevel::INFO_LEVEL) {
+    	len += sprintf(bufferPosition, sif::ANSI_COLOR_GREEN);
+    }
+    else if(printType == sif::PrintLevel::DEBUG_LEVEL) {
+    	len += sprintf(bufferPosition, sif::ANSI_COLOR_CYAN);
+    }
+    else if(printType == sif::PrintLevel::WARNING_LEVEL) {
+    	len += sprintf(bufferPosition, sif::ANSI_COLOR_YELLOW);
+    }
+    else if(printType == sif::PrintLevel::ERROR_LEVEL) {
+    	len += sprintf(bufferPosition, sif::ANSI_COLOR_RED);
+    }
+#endif
+
+   if (printType == sif::PrintLevel::INFO_LEVEL) {
+       len += sprintf(bufferPosition + len, "INFO: ");
+   }
+   if(printType == sif::PrintLevel::DEBUG_LEVEL) {
+	   len += sprintf(bufferPosition + len, "DEBUG: ");
+   }
+   if(printType == sif::PrintLevel::WARNING_LEVEL) {
+	   len += sprintf(bufferPosition + len, "WARNING: ");
+   }
+
+   if(printType == sif::PrintLevel::ERROR_LEVEL) {
+	   len += sprintf(bufferPosition + len, "ERROR: ");
+   }
+
+    Clock::TimeOfDay_t now;
+    Clock::getDateAndTime(&now);
+    /*
+     * Log current time to terminal if desired.
+     */
+    len += sprintf(bufferPosition + len, "| %lu:%02lu:%02lu.%03lu | ",
+    		(unsigned long) now.hour,
+			(unsigned long) now.minute,
+			(unsigned long) now.second,
+			(unsigned long) now.usecond /1000);
+
+    len += vsnprintf(bufferPosition + len, sizeof(printBuffer) - len, fmt, arg);
+
+    if(addCrAtEnd) {
+    	len += sprintf(bufferPosition + len, "\r");
+    }
+
+    printf("%s", printBuffer);
+}
+
+
+void sif::printInfo(const char *fmt, ...) {
+    va_list args;
+    va_start(args, fmt);
+    fsfwPrint(sif::PrintLevel::INFO_LEVEL, fmt, args);
+    va_end(args);
+}
+
+void sif::printWarning(const char *fmt, ...) {
+    va_list args;
+    va_start(args, fmt);
+    fsfwPrint(sif::PrintLevel::WARNING_LEVEL, fmt, args);
+    va_end(args);
+}
+
+void sif::printDebug(const char *fmt, ...) {
+    va_list args;
+    va_start(args, fmt);
+    fsfwPrint(sif::PrintLevel::DEBUG_LEVEL, fmt, args);
+    va_end(args);
+}
+
+void sif::setToAddCrAtEnd(bool addCrAtEnd_) {
+	addCrAtEnd = addCrAtEnd_;
+}
+
+void sif::printError(const char *fmt, ...) {
+    va_list args;
+    va_start(args, fmt);
+    fsfwPrint(sif::PrintLevel::ERROR_LEVEL, fmt, args);
+    va_end(args);
+}
+
+#else
+
+void sif::printInfo(const char *fmt, ...) {}
+void sif::printWarning(const char *fmt, ...) {}
+void sif::printDebug(const char *fmt, ...) {}
+void sif::printError(const char *fmt, ...) {}
+
+#endif /* FSFW_DISABLE_PRINTOUT == 0 */
+
+void sif::setPrintLevel(PrintLevel printLevel_) {
+	printLevel = printLevel_;
+}
+
+sif::PrintLevel sif::getPrintLevel() {
+	return printLevel;
+}

src/core/serviceinterface/ServiceInterfaceStream.cpp

@@ -0,0 +1,27 @@
+#include "ServiceInterfaceStream.h"
+
+#if FSFW_CPP_OSTREAM_ENABLED == 1
+
+ServiceInterfaceStream::ServiceInterfaceStream(std::string setMessage,
+		bool addCrToPreamble, bool buffered, bool errStream, uint16_t port) :
+		std::ostream(&streambuf),
+		streambuf(setMessage, addCrToPreamble, buffered, errStream, port) {}
+
+void ServiceInterfaceStream::setActive( bool myActive) {
+	this->streambuf.isActive = myActive;
+}
+
+std::string* ServiceInterfaceStream::getPreamble() {
+	return streambuf.getPreamble();
+}
+
+bool ServiceInterfaceStream::crAdditionEnabled() const {
+    return streambuf.crAdditionEnabled();
+}
+
+void ServiceInterfaceStream::setAsciiColorPrefix(std::string asciiColorCode) {
+    streambuf.setAsciiColorPrefix(asciiColorCode);
+}
+
+#endif
+