Changeset 4a24650 in OpenModelica

Timestamp:

2022-05-18T09:38:16+02:00 (2 years ago)

Author:

GitHub <noreply@…>

Branches:

maintenance/v1.20, maintenance/v1.21, maintenance/v1.22, maintenance/v1.23, master

Children:

648929c, c8f0c9e

Parents:

d632ee4a

git-author:

phannebohm <phannebohm@…> (05/18/22 09:38:16)

git-committer:

GitHub <noreply@…> (05/18/22 09:38:16)

Message:

[janitor] Refactor listPop in list.c (#8964)

• [janitor] Refactor listPop in list.c
• Add function descriptions

Location:

OMCompiler/SimulationRuntime/c

Files:

• simulation/solver/events.c (modified) (1 diff)
• simulation/solver/nonlinearValuesList.c (modified) (1 diff)
• simulation/solver/synchronous.c (modified) (2 diffs)
• util/list.c (modified) (18 diffs)
• util/list.h (modified) (2 diffs)

OMCompiler/SimulationRuntime/c/simulation/solver/events.c

@@ -355 +355 @@
   while(listLen(&tmpEventList) > 0)
   {
-    /* TODO do this directly w/o free-malloc */
     long event_id = *((long*)listFirstData(&tmpEventList));
-    listPopFront(&tmpEventList);
-    listPushFront(eventList, &event_id);
-
+    listPushFrontNodeNoCopy(eventList, listPopFrontNode(&tmpEventList));
     infoStreamPrint(LOG_ZEROCROSSINGS, 0, "Event id: %ld", event_id);
   }

OMCompiler/SimulationRuntime/c/simulation/solver/nonlinearValuesList.c

@@ -75 +75 @@
     {
       elem = (VALUE*) listFirstData(tmpList->valueList);
-      listPopFront(tmpList->valueList);
+      listRemoveFront(tmpList->valueList);
     }
     freeList(tmpList->valueList);

OMCompiler/SimulationRuntime/c/simulation/solver/synchronous.c

@@ -292 +292 @@
     type = nextTimer->type;
     activationTime = nextTimer->activationTime;
-    listPopFront(data->simulationInfo->intvlTimers);
+    listRemoveFront(data->simulationInfo->intvlTimers);
     switch(type)
     {
@@ -375 +375 @@
     type = nextTimer->type;
     activationTime = nextTimer->activationTime;
-    listPopFront(data->simulationInfo->intvlTimers);
+    listRemoveFront(data->simulationInfo->intvlTimers);
     switch(type)
     {

OMCompiler/SimulationRuntime/c/util/list.c

@@ -42 +42 @@
 
 
+/**
+ * @brief Allocates memory for a new empty list
+ *
+ * @param itemSize    Size of data
+ * @return list       Pointer to list
+ */
 LIST *allocList(unsigned int itemSize)
 {
@@ -55 +61 @@
 }
 
+/**
+ * @brief Frees list and everything inside it
+ *
+ * @param list    Pointer to list
+ */
 void freeList(LIST *list)
 {
@@ -64 +75 @@
 }
 
+/**
+ * @brief Frees node and data inside node
+ *
+ * @param node    Pointer to node
+ */
 void freeNode(LIST_NODE *node)
 {
@@ -70 +86 @@
 }
 
+/**
+ * @brief Copies data into new tmpNode and pushes tmpNode to the front of list
+ *
+ * @param list    Pointer to list
+ * @param data    Pointer to data (copied)
+ */
 void listPushFront(LIST *list, const void *data)
 {
@@ -90 +112 @@
 }
 
+/**
+ * @brief Pushes node to the front of list
+ *
+ * @param list    Pointer to list
+ * @param node    Pointer to node (not copied)
+ */
+void listPushFrontNodeNoCopy(LIST *list, LIST_NODE *node)
+{
+  assertStreamPrint(NULL, 0 != list, "invalid list-pointer");
+  assertStreamPrint(NULL, 0 != node, "invalid list-node");
+
+  node->next = list->first;
+  ++(list->length);
+  list->first = node;
+  if(!list->last)
+    list->last = list->first;
+}
+
+/**
+ * @brief Copies data into new tmpNode and pushes tmpNode to the back of list
+ *
+ * @param list    Pointer to list
+ * @param data    Pointer to data (copied)
+ */
 void listPushBack(LIST *list, const void *data)
 {
@@ -114 +160 @@
 }
 
+/**
+ * @brief Copies data into new tmpNode and inserts tmpNode into list after prevNode
+ *
+ * @param list       Pointer to list
+ * @param prevNode   Pointer to previous node
+ * @param data       Pointer to data (copied)
+ */
 void listInsert(LIST *list, LIST_NODE* prevNode, const void *data)
 {
@@ -131 +184 @@
 }
 
+/**
+ * @brief Returns the length of list
+ *
+ * @param list    Pointer to list
+ * @return        length of list
+ */
 int listLen(LIST *list)
 {
@@ -137 +196 @@
 }
 
+/**
+ * @brief Returns data of first node in list
+ *
+ * @param list    Pointer to list
+ * @return        Pointer to data of first node in list
+ */
 void *listFirstData(LIST *list)
 {
@@ -144 +209 @@
 }
 
+/**
+ * @brief Returns data of last node in list
+ *
+ * @param list    Pointer to list
+ * @return        Pointer to data of last node in list
+ */
 void *listLastData(LIST *list)
 {
@@ -151 +222 @@
 }
 
-void listPopFront(LIST *list)
-{
-  if(list)
+/**
+ * @brief Returns first node and pops node from list
+ *
+ * @param list    Pointer to list
+ * @return node   Pointer to node (must be freed by caller)
+ */
+LIST_NODE *listPopFrontNode(LIST *list)
+{
+  assertStreamPrint(NULL, 0 != list, "invalid list-pointer");
+  assertStreamPrint(NULL, 0 != list->first, "empty list");
+
+  LIST_NODE *node = list->first;
+  list->first = node->next;
+  //node->next = NULL;
+  --(list->length);
+  if(!list->first)
+    list->last = list->first;
+  return node;
+}
+
+/**
+ * @brief Removes and frees first node from list
+ *
+ * @param list    Pointer to list
+ */
+void listRemoveFront(LIST *list)
+{
+  assertStreamPrint(NULL, 0 != list, "invalid list-pointer");
+  if(list->first)
   {
-    if(list->first)
-    {
-      LIST_NODE *tmpNode = list->first->next;
-      freeNode(list->first);
-
-      list->first = tmpNode;
-      --(list->length);
-      if(!list->first)
-        list->last = list->first;
-    }
+    LIST_NODE *tmpNode = list->first->next;
+    freeNode(list->first);
+
+    list->first = tmpNode;
+    --(list->length);
+    if(!list->first)
+      list->last = list->first;
   }
 }
 
+/**
+ * @brief Frees all nodes and their data in list
+ *
+ * @param list    Pointer to list
+ */
 void listClear(LIST *list)
 {
@@ -188 +287 @@
 }
 
+/**
+ * @brief Removes and frees nodes from list starting from node
+ *
+ * used only in simulation/solver/nonlinearValuesList
+ *
+ * @param list    Pointer to list
+ * @param node    Pointer to node
+ */
 void removeNodes(LIST* list, LIST_NODE *node)
 {
@@ -199 +306 @@
 }
 
+/**
+ * @brief Retruns first node of list
+ *
+ * @param list    Pointer to list
+ * @return        Pointer to first node
+ */
 LIST_NODE *listFirstNode(LIST *list)
 {
@@ -206 +319 @@
 }
 
+/**
+ * @brief Returns next node after node (used for iterating over list)
+ *
+ * @param node    Pointer to node
+ * @return        Pointer to next node
+ */
 LIST_NODE *listNextNode(LIST_NODE *node)
 {
@@ -214 +333 @@
 }
 
+/**
+ * @brief Returns node data
+ *
+ * @param node    Pointer to node
+ * @return        Pointer to data
+ */
 void *listNodeData(LIST_NODE *node)
 {
@@ -221 +346 @@
 }
 
+/* not sure about this, looks dangerous */
 void updateNodeData(LIST *list, LIST_NODE *node, const void *data)
 {
@@ -230 +356 @@
 }
 
+/* not sure about this, looks dangerous */
 LIST_NODE* updateNodeNext(LIST *list, LIST_NODE *node, LIST_NODE *newNext)
 {
@@ -240 +367 @@
 }
 
+/* not sure about this, looks dangerous */
 void updatelistFirst(LIST* list, LIST_NODE *node)
 {
@@ -247 +375 @@
 }
 
+/* not sure about this, looks dangerous */
 void updatelistLength(LIST* list, unsigned int newLength)
 {

OMCompiler/SimulationRuntime/c/util/list.h

@@ -61 +61 @@
 
   void listPushFront(LIST *list, const void *data);
+  void listPushFrontNodeNoCopy(LIST *list, LIST_NODE *node);
   void listPushBack(LIST *list, const void *data);
   void listInsert(LIST *list, LIST_NODE* prevNode, const void *data);
@@ -69 +70 @@
   void *listLastData(LIST *list);
 
-  void listPopFront(LIST *list);
+  LIST_NODE *listPopFrontNode(LIST *list);
+  void listRemoveFront(LIST *list);
 
   void listClear(LIST *list);