Merge pull request 'Allow creating regular threads' (#140) from allow_creating_regular_threads into develop

Reviewed-on: #140

src/fsfw/devicehandlers/DeviceCommunicationIF.h

@@ -49,6 +49,7 @@ class DeviceCommunicationIF {
   // is this needed if there is no open/close call?
   static const ReturnValue_t NOT_ACTIVE = MAKE_RETURN_CODE(0x05);
   static const ReturnValue_t TOO_MUCH_DATA = MAKE_RETURN_CODE(0x06);
+  static constexpr ReturnValue_t BUSY = MAKE_RETURN_CODE(0x07);
 
   virtual ~DeviceCommunicationIF() {}
 

src/fsfw/osal/host/TaskFactory.cpp

@@ -20,16 +20,18 @@ TaskFactory::~TaskFactory() = default;
 
 TaskFactory* TaskFactory::instance() { return TaskFactory::factoryInstance; }
 
-PeriodicTaskIF* TaskFactory::createPeriodicTask(
-    TaskName name_, TaskPriority taskPriority_, TaskStackSize stackSize_,
-    TaskPeriod periodInSeconds_, TaskDeadlineMissedFunction deadLineMissedFunction_) {
+PeriodicTaskIF* TaskFactory::createPeriodicTask(TaskName name_, TaskPriority taskPriority_,
+                                                TaskStackSize stackSize_,
+                                                TaskPeriod periodInSeconds_,
+                                                TaskDeadlineMissedFunction deadLineMissedFunction_,
+                                                void* args) {
   return new PeriodicTask(name_, taskPriority_, stackSize_, periodInSeconds_,
                           deadLineMissedFunction_);
 }
 
 FixedTimeslotTaskIF* TaskFactory::createFixedTimeslotTask(
     TaskName name_, TaskPriority taskPriority_, TaskStackSize stackSize_,
-    TaskPeriod periodInSeconds_, TaskDeadlineMissedFunction deadLineMissedFunction_) {
+    TaskPeriod periodInSeconds_, TaskDeadlineMissedFunction deadLineMissedFunction_, void* args) {
   return new FixedTimeslotTask(name_, taskPriority_, stackSize_, periodInSeconds_,
                                deadLineMissedFunction_);
 }

src/fsfw/osal/linux/FixedTimeslotTask.cpp

@@ -7,10 +7,15 @@
 const size_t PeriodicTaskIF::MINIMUM_STACK_SIZE = PTHREAD_STACK_MIN;
 
 FixedTimeslotTask::FixedTimeslotTask(const char* name_, TaskPriority priority_, size_t stackSize_,
-                                     TaskPeriod periodSeconds_, TaskDeadlineMissedFunction dlmFunc_)
+                                     TaskPeriod periodSeconds_, TaskDeadlineMissedFunction dlmFunc_,
+                                     PosixThreadArgs* args)
     : FixedTimeslotTaskBase(periodSeconds_, dlmFunc_),
-      posixThread(name_, priority_, stackSize_),
-      started(false) {}
+      posixThread(name_, SchedulingPolicy::REGULAR, priority_, stackSize_),
+      started(false) {
+  if (args != nullptr) {
+    posixThread.setSchedPolicy(args->policy);
+  }
+}
 
 void* FixedTimeslotTask::taskEntryPoint(void* arg) {
   // The argument is re-interpreted as PollingTask.

src/fsfw/osal/linux/FixedTimeslotTask.h

@@ -23,7 +23,8 @@ class FixedTimeslotTask : public FixedTimeslotTaskBase {
    * @param deadlineMissedFunc_
    */
   FixedTimeslotTask(const char* name_, TaskPriority priority_, size_t stackSize_,
-                    TaskPeriod periodSeconds_, TaskDeadlineMissedFunction dlmFunc_);
+                    TaskPeriod periodSeconds_, TaskDeadlineMissedFunction dlmFunc_,
+                    PosixThreadArgs* args);
   ~FixedTimeslotTask() override = default;
 
   ReturnValue_t startTask() override;

src/fsfw/osal/linux/PeriodicPosixTask.cpp

@@ -4,10 +4,15 @@
 #include "fsfw/tasks/ExecutableObjectIF.h"
 
 PeriodicPosixTask::PeriodicPosixTask(const char* name_, int priority_, size_t stackSize_,
-                                     TaskPeriod period_, TaskDeadlineMissedFunction dlmFunc_)
+                                     TaskPeriod period_, TaskDeadlineMissedFunction dlmFunc_,
+                                     PosixThreadArgs* args)
     : PeriodicTaskBase(period_, dlmFunc_),
-      posixThread(name_, priority_, stackSize_),
-      started(false) {}
+      posixThread(name_, SchedulingPolicy::REGULAR, priority_, stackSize_),
+      started(false) {
+  if (args != nullptr) {
+    posixThread.setSchedPolicy(args->policy);
+  }
+}
 
 void* PeriodicPosixTask::taskEntryPoint(void* arg) {
   // The argument is re-interpreted as PollingTask.

src/fsfw/osal/linux/PeriodicPosixTask.h

@@ -24,7 +24,7 @@ class PeriodicPosixTask : public PeriodicTaskBase {
    * @param deadlineMissedFunc_
    */
   PeriodicPosixTask(const char* name_, int priority_, size_t stackSize_, TaskPeriod period_,
-                    TaskDeadlineMissedFunction dlmFunc_);
+                    TaskDeadlineMissedFunction dlmFunc_, PosixThreadArgs* args);
   ~PeriodicPosixTask() override = default;
 
   /**

src/fsfw/osal/linux/PosixThread.cpp

@@ -7,8 +7,9 @@
 #include "fsfw/osal/linux/unixUtility.h"
 #include "fsfw/serviceinterface/ServiceInterface.h"
 
-PosixThread::PosixThread(const char* name_, int priority_, size_t stackSize_)
-    : thread(0), priority(priority_), stackSize(stackSize_) {
+PosixThread::PosixThread(const char* name_, SchedulingPolicy schedPolciy, int priority_,
+                         size_t stackSize_)
+    : thread(0), schedPolicy(schedPolciy), priority(priority_), stackSize(stackSize_) {
   name[0] = '\0';
   std::strncat(name, name_, PTHREAD_MAX_NAMELEN - 1);
 }
@@ -178,20 +179,30 @@ void PosixThread::createTask(void* (*fnc_)(void*), void* arg_) {
 #ifndef FSFW_USE_REALTIME_FOR_LINUX
 #error "Please define FSFW_USE_REALTIME_FOR_LINUX with either 0 or 1"
 #endif
+  if (schedPolicy == SchedulingPolicy::RR) {
+    // RR -> This needs root privileges for the process
 #if FSFW_USE_REALTIME_FOR_LINUX == 1
-  // FIFO -> This needs root privileges for the process
-  status = pthread_attr_setschedpolicy(&attributes, SCHED_FIFO);
-  if (status != 0) {
-    utility::printUnixErrorGeneric(CLASS_NAME, "createTask", "pthread_attr_setschedpolicy");
+    status = pthread_attr_setschedpolicy(&attributes, SCHED_RR);
+    if (status != 0) {
+      utility::printUnixErrorGeneric(CLASS_NAME, "createTask", "pthread_attr_setschedpolicy");
+    }
+    sched_param scheduleParams;
+    scheduleParams.sched_priority = priority;
+    status = pthread_attr_setschedparam(&attributes, &scheduleParams);
+    if (status != 0) {
+#if FSFW_CPP_OSTREAM_ENABLED == 1
+      sif::warning << "PosixThread: Setting priority failed" << std::endl;
+#endif
+    }
+#else
+#if FSFW_CPP_OSTREAM_ENABLED == 1
+    sif::warning
+        << "Real time priorities are only allowed if FSFW_USE_REALTIME_FOR_LINUX is set to 1"
+        << std::endl;
+#endif
+#endif
   }
 
-  sched_param scheduleParams;
-  scheduleParams.__sched_priority = priority;
-  status = pthread_attr_setschedparam(&attributes, &scheduleParams);
-  if (status != 0) {
-    utility::printUnixErrorGeneric(CLASS_NAME, "createTask", "pthread_attr_setschedparam");
-  }
-#endif
   // Set Signal Mask for suspend until startTask is called
   sigset_t waitSignal;
   sigemptyset(&waitSignal);
@@ -243,3 +254,5 @@ void PosixThread::createTask(void* (*fnc_)(void*), void* arg_) {
     utility::printUnixErrorGeneric(CLASS_NAME, "createTask", "pthread_attr_destroy");
   }
 }
+
+void PosixThread::setSchedPolicy(SchedulingPolicy policy) { this->schedPolicy = policy; }

src/fsfw/osal/linux/PosixThread.h

@@ -9,10 +9,15 @@
 
 #include "../../returnvalues/returnvalue.h"
 
+enum SchedulingPolicy { REGULAR, RR };
+struct PosixThreadArgs {
+  SchedulingPolicy policy = SchedulingPolicy::REGULAR;
+};
+
 class PosixThread {
  public:
   static constexpr uint8_t PTHREAD_MAX_NAMELEN = 16;
-  PosixThread(const char* name_, int priority_, size_t stackSize_);
+  PosixThread(const char* name_, SchedulingPolicy schedPolicy, int priority_, size_t stackSize_);
   virtual ~PosixThread();
   /**
    * Set the Thread to sleep state
@@ -20,6 +25,9 @@ class PosixThread {
    * @return Returns Failed if sleep fails
    */
   static ReturnValue_t sleep(uint64_t ns);
+
+  void setSchedPolicy(SchedulingPolicy policy);
+
   /**
    * @brief Function to suspend the task until SIGUSR1 was received
    *
@@ -72,6 +80,7 @@ class PosixThread {
 
  private:
   char name[PTHREAD_MAX_NAMELEN];
+  SchedulingPolicy schedPolicy;
   int priority;
   size_t stackSize = 0;
 

src/fsfw/osal/linux/TaskFactory.cpp

@@ -12,18 +12,20 @@ TaskFactory::~TaskFactory() = default;
 
 TaskFactory* TaskFactory::instance() { return TaskFactory::factoryInstance; }
 
-PeriodicTaskIF* TaskFactory::createPeriodicTask(
-    TaskName name_, TaskPriority taskPriority_, TaskStackSize stackSize_,
-    TaskPeriod periodInSeconds_, TaskDeadlineMissedFunction deadLineMissedFunction_) {
+PeriodicTaskIF* TaskFactory::createPeriodicTask(TaskName name_, TaskPriority taskPriority_,
+                                                TaskStackSize stackSize_,
+                                                TaskPeriod periodInSeconds_,
+                                                TaskDeadlineMissedFunction deadLineMissedFunction_,
+                                                void* args) {
   return new PeriodicPosixTask(name_, taskPriority_, stackSize_, periodInSeconds_,
-                               deadLineMissedFunction_);
+                               deadLineMissedFunction_, reinterpret_cast<PosixThreadArgs*>(args));
 }
 
 FixedTimeslotTaskIF* TaskFactory::createFixedTimeslotTask(
     TaskName name_, TaskPriority taskPriority_, TaskStackSize stackSize_,
-    TaskPeriod periodInSeconds_, TaskDeadlineMissedFunction deadLineMissedFunction_) {
+    TaskPeriod periodInSeconds_, TaskDeadlineMissedFunction deadLineMissedFunction_, void* args) {
   return new FixedTimeslotTask(name_, taskPriority_, stackSize_, periodInSeconds_,
-                               deadLineMissedFunction_);
+                               deadLineMissedFunction_, reinterpret_cast<PosixThreadArgs*>(args));
 }
 
 ReturnValue_t TaskFactory::deleteTask(PeriodicTaskIF* task) {

src/fsfw/tasks/TaskFactory.h

@@ -47,7 +47,8 @@ class TaskFactory {
    */
   PeriodicTaskIF* createPeriodicTask(TaskName name_, TaskPriority taskPriority_,
                                      TaskStackSize stackSize_, TaskPeriod periodInSeconds_,
-                                     TaskDeadlineMissedFunction deadLineMissedFunction_);
+                                     TaskDeadlineMissedFunction deadLineMissedFunction_,
+                                     void* args = nullptr);
 
   /**
    * The meaning for the variables for fixed timeslot tasks is the same as for periodic tasks.
@@ -62,7 +63,8 @@ class TaskFactory {
   FixedTimeslotTaskIF* createFixedTimeslotTask(TaskName name_, TaskPriority taskPriority_,
                                                TaskStackSize stackSize_,
                                                TaskPeriod periodInSeconds_,
-                                               TaskDeadlineMissedFunction deadLineMissedFunction_);
+                                               TaskDeadlineMissedFunction deadLineMissedFunction_,
+                                               void* args = nullptr);
 
   /**
    * Function to be called to delete a task

src/fsfw_hal/linux/serial/SerialComIF.cpp

@@ -88,11 +88,11 @@ int SerialComIF::configureUartPort(SerialCookie* uartCookie) {
     return fd;
   }
 
-  uart::setParity(options, uartCookie->getParity());
+  serial::setParity(options, uartCookie->getParity());
   setStopBitOptions(&options, uartCookie);
   setDatasizeOptions(&options, uartCookie);
   setFixedOptions(&options);
-  uart::setMode(options, uartCookie->getUartMode());
+  serial::setMode(options, uartCookie->getUartMode());
   if (uartCookie->getInputShouldBeFlushed()) {
     tcflush(fd, TCIFLUSH);
   }
@@ -101,7 +101,7 @@ int SerialComIF::configureUartPort(SerialCookie* uartCookie) {
   options.c_cc[VTIME] = 0;
   options.c_cc[VMIN] = 0;
 
-  uart::setBaudrate(options, uartCookie->getBaudrate());
+  serial::setBaudrate(options, uartCookie->getBaudrate());
 
   /* Save option settings */
   if (tcsetattr(fd, TCSANOW, &options) != 0) {

src/fsfw_hal/linux/serial/helper.cpp

@@ -3,7 +3,7 @@
 
 #include "fsfw/serviceinterface.h"
 
-void uart::setMode(struct termios& options, UartModes mode) {
+void serial::setMode(struct termios& options, UartModes mode) {
   if (mode == UartModes::NON_CANONICAL) {
     /* Disable canonical mode */
     options.c_lflag &= ~ICANON;
@@ -12,7 +12,7 @@ void uart::setMode(struct termios& options, UartModes mode) {
   }
 }
 
-void uart::setBaudrate(struct termios& options, UartBaudRate baud) {
+void serial::setBaudrate(struct termios& options, UartBaudRate baud) {
   switch (baud) {
     case UartBaudRate::RATE_50:
       cfsetspeed(&options, B50);
@@ -114,7 +114,7 @@ void uart::setBaudrate(struct termios& options, UartBaudRate baud) {
   }
 }
 
-void uart::setBitsPerWord(struct termios& options, BitsPerWord bits) {
+void serial::setBitsPerWord(struct termios& options, BitsPerWord bits) {
   options.c_cflag &= ~CSIZE;  // Clear all the size bits
   if (bits == BitsPerWord::BITS_5) {
     options.c_cflag |= CS5;
@@ -127,11 +127,11 @@ void uart::setBitsPerWord(struct termios& options, BitsPerWord bits) {
   }
 }
 
-void uart::enableRead(struct termios& options) { options.c_cflag |= CREAD; }
+void serial::enableRead(struct termios& options) { options.c_cflag |= CREAD; }
 
-void uart::ignoreCtrlLines(struct termios& options) { options.c_cflag |= CLOCAL; }
+void serial::ignoreCtrlLines(struct termios& options) { options.c_cflag |= CLOCAL; }
 
-void uart::setParity(struct termios& options, Parity parity) {
+void serial::setParity(struct termios& options, Parity parity) {
   /* Clear parity bit */
   options.c_cflag &= ~PARENB;
   switch (parity) {
@@ -148,11 +148,11 @@ void uart::setParity(struct termios& options, Parity parity) {
   }
 }
 
-int uart::readCountersAndErrors(int serialPort, serial_icounter_struct& icounter) {
+int serial::readCountersAndErrors(int serialPort, serial_icounter_struct& icounter) {
   return ioctl(serialPort, TIOCGICOUNT, &icounter);
 }
 
-void uart::setStopbits(struct termios& options, StopBits bits) {
+void serial::setStopbits(struct termios& options, StopBits bits) {
   if (bits == StopBits::TWO_STOP_BITS) {
     // Use two stop bits
     options.c_cflag |= CSTOPB;
@@ -161,3 +161,7 @@ void uart::setStopbits(struct termios& options, StopBits bits) {
     options.c_cflag &= ~CSTOPB;
   }
 }
+
+void serial::flushRxBuf(int fd) { tcflush(fd, TCIFLUSH); }
+
+void serial::flushTxRxBuf(int fd) { tcflush(fd, TCIOFLUSH); }

src/fsfw_hal/linux/serial/helper.h

@@ -45,7 +45,7 @@ enum class UartBaudRate {
   RATE_4000000
 };
 
-namespace uart {
+namespace serial {
 
 void setMode(struct termios& options, UartModes mode);
 /**
@@ -64,8 +64,11 @@ void setParity(struct termios& options, Parity parity);
 
 void ignoreCtrlLines(struct termios& options);
 
+void flushRxBuf(int fd);
+void flushTxRxBuf(int fd);
+
 int readCountersAndErrors(int serialPort, serial_icounter_struct& icounter);
 
-}  // namespace uart
+}  // namespace serial
 
 #endif /* FSFW_HAL_LINUX_UART_HELPER_H_ */