From 3ed77e24911ab429d9d68ee2274f9bd97d6fa77e Mon Sep 17 00:00:00 2001
From: Steve Karg <steve@kargs.net>
Date: Mon, 24 May 2021 18:53:59 -0500
Subject: [PATCH] DSR-1471: fixes data race issues on ring buffer for MSTP (#9)
 (#174)

* DSR-1471: fixes data race issues on ring buffer

* DSR-1471: added missing semi-colon

Co-authored-by: Fraser Gordon <51318560+FraserG01@users.noreply.github.com>
---
 ports/linux/dlmstp.c | 35 ++++++++++++++++++++++++++++++++---
 1 file changed, 32 insertions(+), 3 deletions(-)

diff --git a/ports/linux/dlmstp.c b/ports/linux/dlmstp.c
index f6cbbc3c..308f3837 100644
--- a/ports/linux/dlmstp.c
+++ b/ports/linux/dlmstp.c
@@ -67,6 +67,11 @@ static pthread_cond_t Received_Frame_Flag;
 static pthread_mutex_t Received_Frame_Mutex;
 static pthread_cond_t Master_Done_Flag;
 static pthread_mutex_t Master_Done_Mutex;
+static pthread_mutex_t Ring_Buffer_Mutex;
+static pthread_mutex_t Thread_Mutex;
+
+static pthread_t hThread;
+static bool run_thread;
 
 /*RT_TASK Receive_Task, Fsm_Task;*/
 /* local MS/TP port data - shared with RS-485 */
@@ -184,12 +189,17 @@ static void get_abstime(struct timespec *abstime, unsigned long milliseconds)
 
 void dlmstp_cleanup(void)
 {
+    pthread_mutex_lock(&Thread_Mutex);
+    run_thread = false;
+    pthread_mutex_unlock(&Thread_Mutex);
+    pthread_join (hThread, NULL);
     pthread_cond_destroy(&Received_Frame_Flag);
     pthread_cond_destroy(&Receive_Packet_Flag);
     pthread_cond_destroy(&Master_Done_Flag);
     pthread_mutex_destroy(&Received_Frame_Mutex);
     pthread_mutex_destroy(&Receive_Packet_Mutex);
     pthread_mutex_destroy(&Master_Done_Mutex);
+    pthread_mutex_destroy (&Ring_Buffer_Mutex);
 }
 
 /* returns number of bytes sent on success, zero on failure */
@@ -201,7 +211,7 @@ int dlmstp_send_pdu(BACNET_ADDRESS *dest, /* destination address */
     int bytes_sent = 0;
     struct mstp_pdu_packet *pkt;
     unsigned i = 0;
-
+    pthread_mutex_lock (&Ring_Buffer_Mutex);
     pkt = (struct mstp_pdu_packet *)Ringbuf_Data_Peek(&PDU_Queue);
     if (pkt) {
         pkt->data_expecting_reply = npdu_data->data_expecting_reply;
@@ -219,6 +229,7 @@ int dlmstp_send_pdu(BACNET_ADDRESS *dest, /* destination address */
             bytes_sent = pdu_len;
         }
     }
+    pthread_mutex_unlock (&Ring_Buffer_Mutex);
 
     return bytes_sent;
 }
@@ -261,9 +272,11 @@ static void *dlmstp_master_fsm_task(void *pArg)
 {
     uint32_t silence = 0;
     bool run_master = false;
+    bool thread_alive = true;
+    bool run_loop;
 
     (void)pArg;
-    for (;;) {
+    while (thread_alive) {
         if (MSTP_Port.ReceivedValidFrame == false &&
             MSTP_Port.ReceivedInvalidFrame == false) {
             RS485_Check_UART_Data(&MSTP_Port);
@@ -293,13 +306,21 @@ static void *dlmstp_master_fsm_task(void *pArg)
         }
         if (run_master) {
             if (MSTP_Port.This_Station <= 127) {
-                while (MSTP_Master_Node_FSM(&MSTP_Port)) {
+                run_loop = true;
+                while (run_loop) {
                     /* do nothing while immediate transitioning */
+                    run_loop = MSTP_Master_Node_FSM(&MSTP_Port);
+                    pthread_mutex_lock (&Thread_Mutex);
+                    if (!run_thread) run_loop = false;
+                    pthread_mutex_unlock (&Thread_Mutex);
                 }
             } else if (MSTP_Port.This_Station < 255) {
                 MSTP_Slave_Node_FSM(&MSTP_Port);
             }
         }
+        pthread_mutex_lock (&Thread_Mutex);
+        thread_alive = run_thread;
+        pthread_mutex_unlock (&Thread_Mutex);
     }
 
     return NULL;
@@ -368,7 +389,9 @@ uint16_t MSTP_Get_Send(
     struct mstp_pdu_packet *pkt;
 
     (void)timeout;
+    pthread_mutex_lock (&Ring_Buffer_Mutex);
     if (Ringbuf_Empty(&PDU_Queue)) {
+        pthread_mutex_unlock (&Ring_Buffer_Mutex);
         return 0;
     }
     pkt = (struct mstp_pdu_packet *)Ringbuf_Peek(&PDU_Queue);
@@ -383,6 +406,7 @@ uint16_t MSTP_Get_Send(
             mstp_port->OutputBufferSize, frame_type, pkt->destination_mac,
             mstp_port->This_Station, (uint8_t *)&pkt->buffer[0], pkt->length);
     (void)Ringbuf_Pop(&PDU_Queue, NULL);
+    pthread_mutex_unlock (&Ring_Buffer_Mutex);
 
     return pdu_len;
 }
@@ -707,6 +731,9 @@ bool dlmstp_init(char *ifname)
         exit(1);
     }
 
+    pthread_mutex_init (&Ring_Buffer_Mutex, NULL);
+    pthread_mutex_init (&Thread_Mutex, NULL);
+
     /* initialize PDU queue */
     Ringbuf_Init(&PDU_Queue, (uint8_t *)&PDU_Buffer,
         sizeof(struct mstp_pdu_packet), MSTP_PDU_PACKET_COUNT);
@@ -752,6 +779,7 @@ bool dlmstp_init(char *ifname)
     /*    if (rv != 0) {
        fprintf(stderr, "Failed to start recive FSM task\n");
        } */
+    run_thread = true;
     rv = pthread_create(&hThread, NULL, dlmstp_master_fsm_task, NULL);
     if (rv != 0) {
         fprintf(stderr, "Failed to start Master Node FSM task\n");
@@ -797,3 +825,4 @@ int main(int argc, char *argv[])
     return 0;
 }
 #endif
+