Initial version.

2023-12-20 00:11:03 +08:00
commit 416bd53733
1043 changed files with 293547 additions and 0 deletions
@@ -0,0 +1,477 @@
+/*****************************************************************************/
+/**
+ * Description: Implementations of 814 linklayer local record.
+ *
+ * Date: 2022-07-14 00:08
+ * LastEditors: Fan Hao
+ * LastEditTime: 2022-07-14 22:52
+ * Revisions: Rev 0.0
+ * History:
+ * [2022-07-14]: Initial version.
+ *
+ * Copyright(c) 2021 Beijing Institute of Technology.
+ * Lab of Communication and Networking
+ *
+ ******************************************************************************/
+
+/***************************** Include Files *********************************/
+#include <stdlib.h>
+#include <string.h>
+#include "linklayer814_types.h"
+#include "node_list.h"
+#include "../common.h"
+#include "../error.h"
+
+/***************** Macros (Inline Functions) Definitions *********************/
+inline int32_t GetNodeNum(NODE_LIST *list) {
+	ASSERT(list != NULL);
+	return list->nodeNum;
+}
+/**************************** Type Definitions *******************************/
+
+/************************** Variable Definitions *****************************/
+
+/************************** Function Prototypes ******************************/
+
+/*****************************************************************************/
+/**
+ * @brief   Initialize node list
+ *
+ * @param   list
+ *
+ * @return  SUCCESS
+ * 			ENOMEM - not enough memory.
+ *
+ ******************************************************************************/
+int32_t NodeList_Init(NODE_LIST **list) {
+	NODE_ENTRY *entry;
+	(*list) = malloc(sizeof(NODE_LIST));
+	if (*list == NULL) {
+		return ENOMEM;
+	}
+	entry = malloc(sizeof(NODE_ENTRY));
+	if(entry == NULL) {
+		free(*list);
+		return ENOMEM;
+	}
+	entry->nodeInfo.nodeId = 0;
+	entry->nextNode = entry;
+	entry->preNode = entry;
+	(*list)->head = entry;
+	(*list)->nodeNum = 0;
+	return SUCCESS;
+}
+
+void NodeList_Clear(NODE_LIST *list){
+	ASSERT(list != NULL);
+	NODE_ENTRY *nodeEntry, *deletEntry;
+	nodeEntry = list->head->nextNode;
+	while (nodeEntry != list->head) {
+		deletEntry = nodeEntry;
+		nodeEntry = nodeEntry->nextNode;
+		deletEntry->preNode->nextNode = deletEntry->nextNode;
+		deletEntry->nextNode->preNode = deletEntry->preNode;
+		DBG_INFO("Deleting node [%d].\n", deletEntry->nodeInfo.nodeId);
+		free(deletEntry);
+		list->nodeNum--;
+	}
+}
+
+void NodeList_Destroy(NODE_LIST *list){
+	if(list == NULL){
+		return;
+	}
+	NodeList_Clear(list);
+	free(list->head);
+	free(list);
+}
+/*****************************************************************************/
+/**
+ * @brief   Get node entry frome node list base on node id.
+ *
+ * @param   list
+ * @param   nodeId
+ *
+ * @return  Node entry
+ *          NULL if node dose not exist.
+ *
+ ******************************************************************************/
+NODE_ENTRY* GetNode(NODE_LIST *list, uint32_t nodeId) {
+	ASSERT(list != NULL);
+	NODE_ENTRY* nodeEntry = list->head->nextNode;
+	while (nodeEntry != list->head) {
+		if (nodeEntry->nodeInfo.nodeId == nodeId) {
+			break;
+		}
+		else {
+			nodeEntry = nodeEntry->nextNode;
+		}
+	}
+	if (nodeEntry == list->head) {
+		return NULL;
+	}
+	else {
+		return nodeEntry;
+	}
+}
+
+/*****************************************************************************/
+/**
+ * @brief   Check whether the node is already in the node list.
+ *
+ * @param   list
+ * @param   nodeId
+ *
+ * @return  true node in the list
+ *          false node not in the list
+ *
+ ******************************************************************************/
+inline bool IsNodeInList(NODE_LIST *list, uint8_t nodeId) {
+	ASSERT(list != NULL);
+	return (GetNode(list, nodeId) != NULL);
+}
+
+/*****************************************************************************/
+/**
+ * @brief   Append a new node entry to the node list
+ *
+ * @param   list
+ * @param   nodeId
+ * @param   nodeType
+ *
+ * @return  SUCCESS Node was added successfully.
+ *          Other       Error occurred.(Node already exist, memory alloc error ect.)
+ *
+ ******************************************************************************/
+int32_t AppendNode(NODE_LIST *list, uint8_t nodeId, L2_NODE_TYPE nodeType)
+{
+	ASSERT(list != NULL);
+	if(IsNodeInList(list, nodeId)){
+		DBG_WARNING("Node [%d] already exist.\n", nodeId);
+		return FAILURE;
+	}
+	DBG_INFO("Link layer appending node [%d] to node list.\n", nodeId);
+	NODE_ENTRY* nodeEntry = (NODE_ENTRY*) malloc(sizeof(NODE_ENTRY));
+	if (nodeEntry == NULL) {
+		return ENOMEM;
+	}
+	nodeEntry->nodeInfo.nodeId = nodeId;
+	nodeEntry->nodeInfo.nodeType = (uint8_t) nodeType;
+	nodeEntry->nodeInfo.pos.x = 0;
+	nodeEntry->nodeInfo.pos.y = 0;
+	nodeEntry->nodeInfo.pos.z = 0;
+	nodeEntry->nodeInfo.speed.x = 0;
+	nodeEntry->nodeInfo.speed.y = 0;
+	nodeEntry->nodeInfo.speed.z = 0;
+	nodeEntry->nodeInfo.beamNo = 0;
+	nodeEntry->ttlCnt = 0;
+
+	nodeEntry->nextNode = list->head;
+	nodeEntry->preNode = list->head->nextNode;
+	list->head->nextNode = nodeEntry;
+
+	list->nodeNum++;
+	return SUCCESS;
+}
+
+/*****************************************************************************/
+/**
+ * @brief   Delete a node in list based on node id.
+ *
+ * @param   list
+ * @param   nodeId
+ *
+ * @return  SUCCESS Node has been successfully deleted.
+ *          Other       Node not exist.
+ *
+ ******************************************************************************/
+int32_t DeletNode(NODE_LIST *list, uint8_t nodeId) {
+	ASSERT(list != NULL);
+	NODE_ENTRY* nodeEntry = GetNode(list, nodeId);
+	if(nodeEntry == NULL){
+		DBG_WARNING("Node [%d] in not in node list, skip deleting process.\n", nodeId);
+		return SUCCESS;
+	}
+	nodeEntry->preNode->nextNode = nodeEntry->nextNode;
+	nodeEntry->nextNode->preNode = nodeEntry->preNode;
+	DBG_INFO("Deleting node [%d].\n", nodeId);
+	free(nodeEntry);
+	list->nodeNum--;
+	return SUCCESS;
+}
+
+
+/*****************************************************************************/
+/**
+ * @brief   Get the distance between me and the node.
+ *
+ * @param   list
+ * @param   nodeId
+ * @param	dst     A pointer to store distance.
+ *
+ * @return  SUCCESS distance has been successfully store in dst
+ *          FAILURE Node dose not exit.
+ *
+ ******************************************************************************/
+
+int32_t GetDistance(NODE_LIST *list, COORD myCoord, uint8_t nodeId, double* dst) {
+	ASSERT(list != NULL);
+	NODE_ENTRY* nodeEntry = GetNode(list, nodeId);
+	if (nodeEntry == NULL) {
+		return FAILURE;
+	}
+	else {
+		*dst = Coord_Distance(myCoord, nodeEntry->nodeInfo.pos);
+		return SUCCESS;
+	}
+}
+
+/*****************************************************************************/
+/**
+ * @brief   Update node positions information.
+ *
+ * @param   list
+ * @param   nodeId
+ * @param   newPos A structure stores the corresponding node position info.
+ *
+ * @return  SUCCESS update successfully.
+ *          FAILURE node not exist.
+ *
+ ******************************************************************************/
+int32_t UpdateNodePos(NODE_LIST *list, uint8_t nodeId, const COORD *newPos) {
+	ASSERT(list != NULL);
+	NODE_ENTRY* nodeEntry = GetNode(list, nodeId);
+	if (nodeEntry == NULL) {
+		return FAILURE;
+	}
+	else {
+		memcpy(&(nodeEntry->nodeInfo.pos), newPos, sizeof(COORD));
+	}
+	return SUCCESS;
+}
+
+
+/*****************************************************************************/
+/**
+ * @brief   Get node positions information.
+ *
+ * @param   list
+ * @param   nodeId
+ * @param   newPos A structure stores the corresponding node position info.
+ *
+ * @return  SUCCESS update successfully.
+ *          FAILURE node not exist.
+ *
+ ******************************************************************************/
+int32_t GetNodePos(NODE_LIST *list, uint8_t nodeId, COORD *pos) {
+	ASSERT(list != NULL);
+	NODE_ENTRY* nodeEntry = GetNode(list, nodeId);
+	if (nodeEntry == NULL) {
+		return FAILURE;
+	}
+	else {
+		memcpy(pos, &(nodeEntry->nodeInfo.pos), sizeof(COORD));
+	}
+	return SUCCESS;
+}
+
+/*****************************************************************************/
+/**
+ * @brief   Update node speed information.
+ *
+ * @param   list
+ * @param   nodeId
+ * @param   newSpeed A structure stores the corresponding node speed info.
+ *
+ * @return  SUCCESS update successfully.
+ *          FAILURE node not exist.
+ *
+ ******************************************************************************/
+int32_t UpdateNodeSpeed(NODE_LIST *list, uint8_t nodeId, const COORD *newSpeed) {
+	ASSERT(list != NULL);
+	NODE_ENTRY* nodeEntry = GetNode(list, nodeId);
+	if (nodeEntry == NULL) {
+		return FAILURE;
+	}
+	else {
+		memcpy(&(nodeEntry->nodeInfo.speed), newSpeed, sizeof(COORD));
+	}
+	return SUCCESS;
+}
+
+
+/*****************************************************************************/
+/**
+ * @brief   Get node speed information.
+ *
+ * @param   list
+ * @param   nodeId
+ * @param   newSpeed A structure stores the corresponding node speed info.
+ *
+ * @return  SUCCESS update successfully.
+ *          FAILURE node not exist.
+ *
+ ******************************************************************************/
+int32_t GetNodeSpeed(NODE_LIST *list, uint8_t nodeId, COORD *speed) {
+	ASSERT(list != NULL);
+	NODE_ENTRY* nodeEntry = GetNode(list, nodeId);
+	if (nodeEntry == NULL) {
+		return FAILURE;
+	}
+	else {
+		memcpy(speed, &(nodeEntry->nodeInfo.speed), sizeof(COORD));
+	}
+	return SUCCESS;
+}
+/*****************************************************************************/
+/**
+ * @brief   Update node ACK status.
+ *
+ * @param   list
+ * @param   nodeId
+ * @param   defl
+ *
+ * @return  SUCCESS update successfully.
+ *          FAILURE Node not exist.
+ *
+ ******************************************************************************/
+int32_t UpdateNodeTimeDeviation(NODE_LIST *list, uint8_t nodeId, int32_t devi) {
+	ASSERT(list != NULL);
+	NODE_ENTRY* nodeEntry = GetNode(list, nodeId);
+	if (nodeEntry == NULL) {
+		return FAILURE;
+	}
+	else {
+		nodeEntry->timeDevi = devi;
+	}
+	return SUCCESS;
+}
+
+/*****************************************************************************/
+/**
+ * @brief   Increase TTL of specified node in the list.
+ *
+ * @param   list
+ * @param   inc		cnt of slot to add
+ * @param   nodeId
+ *
+ * @return  NONE
+ *
+ ******************************************************************************/
+int32_t IncNodeTTL(NODE_LIST *list, uint8_t nodeId, uint32_t inc) {
+	ASSERT(list != NULL);
+	NODE_ENTRY* nodeEntry = GetNode(list, nodeId);
+	if (nodeEntry == NULL) {
+		return FAILURE;
+	}
+	else {
+		nodeEntry->ttlCnt += inc;
+	}
+	return SUCCESS;
+}
+
+/*****************************************************************************/
+/**
+ * @brief   Reset node TTL based on node id.
+ *
+ * @param   list
+ * @param   nodeId
+ *
+ * @return  SUCCESS TTL has been successfully cleared.
+ *          FAILURE Node not exist.
+ *
+ ******************************************************************************/
+int32_t RstNodeTTL(NODE_LIST *list, uint8_t nodeId) {
+	ASSERT(list != NULL);
+	NODE_ENTRY* nodeEntry = GetNode(list, nodeId);
+	if (nodeEntry == NULL) {
+		return FAILURE;
+	}
+	else {
+		nodeEntry->ttlCnt = 0;
+	}
+	return SUCCESS;
+}
+
+/*****************************************************************************/
+/**
+ * @brief   Get TTL of specified node in the list.
+ *
+ * @param   list
+ * @param   nodeId
+ * @param	ttl
+ *
+ * @return  NONE
+ *
+ ******************************************************************************/
+int32_t GetNodeTTL(NODE_LIST *list, uint8_t nodeId, uint32_t *ttl) {
+	ASSERT(list != NULL);
+	NODE_ENTRY* nodeEntry = GetNode(list, nodeId);
+	if (nodeEntry == NULL) {
+		return FAILURE;
+	}
+	else {
+		*ttl = nodeEntry->ttlCnt;
+	}
+	return SUCCESS;
+}
+
+/*****************************************************************************/
+/**
+ * @brief   Implements a edit operations to each node.
+ *
+ * @param   list
+ * @param	param
+ * @param   operation  A pointer to a function handled "NODE_ENTRY*" as input
+ *                  which defines the operations need to be apply.
+ *
+ * @return SUCCESS Operations has been applied successfully to all nodes.
+ *         Other       Error occurred.
+ *
+ ******************************************************************************/
+int32_t IterEditNode(NODE_LIST *list, const void *param, int32_t (*operation)(NODE_ENTRY *, const void *)) {
+	ASSERT(list != NULL);
+	int32_t Status = SUCCESS;
+	NODE_ENTRY *nodeEntry = list->head->nextNode;
+	while (nodeEntry != list->head) {
+		Status = operation(nodeEntry, param);
+		if(Status != SUCCESS){
+			break;
+		}
+		nodeEntry = nodeEntry->nextNode;
+	}
+	return Status;
+}
+
+/*****************************************************************************/
+/**
+ * @brief   Filter all node, delete all the node not satisfied the condition.
+ *
+ * @param   list
+ * @param   condition  A pointer to a function handled "NODE_ENTRY*" as input
+ *                  which defines the condition need to be verify.
+ *
+ * @return SUCCESS
+ *
+ ******************************************************************************/
+int32_t IterDeleteNode(NODE_LIST *list, bool (*condition)(NODE_ENTRY *)) {
+	ASSERT(list != NULL);
+	NODE_ENTRY *nodeEntry, *deletEntry;
+	nodeEntry = list->head->nextNode;
+	while (nodeEntry != list->head) {
+		if (condition(nodeEntry) == false) {
+			deletEntry = nodeEntry;
+			nodeEntry = nodeEntry->nextNode;
+			deletEntry->preNode->nextNode = deletEntry->nextNode;
+			deletEntry->nextNode->preNode = deletEntry->preNode;
+			DBG_INFO("Deleting node [%d].\n", deletEntry->nodeInfo.nodeId);
+			free(deletEntry);
+			list->nodeNum--;
+		}
+		else {
+			nodeEntry = nodeEntry->nextNode;
+		}
+	}
+	return SUCCESS;
+}
+