From 3344d1a728d37f0fb3e82a6a945eee0c780eb734 Mon Sep 17 00:00:00 2001
From: Chernov Dmitriy <cd_work@mail.ru>
Date: 周三, 02 3月 2016 21:29:32 +0800
Subject: [PATCH] Fix potential memory leak. #73
---
libscpi/src/error.c | 241 +++++++++++++++++++++++++++--------------------
1 files changed, 138 insertions(+), 103 deletions(-)
diff --git a/libscpi/src/error.c b/libscpi/src/error.c
index 493b623..d1307a4 100644
--- a/libscpi/src/error.c
+++ b/libscpi/src/error.c
@@ -2,7 +2,7 @@
* Copyright (c) 2012-2013 Jan Breuer,
*
* All Rights Reserved
- *
+ *
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
@@ -11,7 +11,7 @@
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
- *
+ *
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -28,10 +28,10 @@
/**
* @file scpi_error.c
* @date Thu Nov 15 10:58:45 UTC 2012
- *
+ *
* @brief Error handling and storing routines
- *
- *
+ *
+ *
*/
#include <stdint.h>
@@ -39,20 +39,41 @@
#include "scpi/parser.h"
#include "scpi/ieee488.h"
#include "scpi/error.h"
-#include "scpi/fifo.h"
+#include "fifo_private.h"
-// basic FIFO
-static fifo_t local_error_queue;
+/**
+ * Initialize error queue
+ * @param context - scpi context
+ */
+void SCPI_ErrorInit(scpi_t * context, scpi_error_t * data, int16_t size) {
+ fifo_init(&context->error_queue, data, size);
+}
+/**
+ * Emit no error
+ * @param context scpi context
+ */
+static void SCPI_ErrorEmitEmpty(scpi_t * context) {
+ if ((SCPI_ErrorCount(context) == 0) && (SCPI_RegGet(context, SCPI_REG_STB) & STB_QMA)) {
+ SCPI_RegClearBits(context, SCPI_REG_STB, STB_QMA);
+ if (context->interface && context->interface->error) {
+ context->interface->error(context, 0);
+ }
+ }
+}
-void SCPI_ErrorInit(scpi_t * context) {
- //// FreeRTOS
- // context->error_queue = (scpi_error_queue_t)xQueueCreate(100, sizeof(int16_t));
-
- // basic FIFO
- context->error_queue = (scpi_error_queue_t)&local_error_queue;
- fifo_init((fifo_t *)context->error_queue);
+/**
+ * Emit error
+ * @param context scpi context
+ * @param err Error to emit
+ */
+static void SCPI_ErrorEmit(scpi_t * context, int16_t err) {
+ SCPI_RegSetBits(context, SCPI_REG_STB, STB_QMA);
+
+ if (context->interface && context->interface->error) {
+ context->interface->error(context, err);
+ }
}
/**
@@ -60,112 +81,120 @@
* @param context - scpi context
*/
void SCPI_ErrorClear(scpi_t * context) {
- //// FreeRTOS
- //xQueueReset((xQueueHandle)context->error_queue);
-
- // basic FIFO
- fifo_clear((fifo_t *)context->error_queue);
+#if USE_DEVICE_DEPENDENT_ERROR_INFORMATION
+ scpi_error_t error;
+ while(fifo_remove(&context->error_queue, &error)){
+ SCPIDEFINE_free(&context->error_info_heap, error.device_dependent_info, false);
+ }
+#endif
+ fifo_clear(&context->error_queue);
+
+ SCPI_ErrorEmitEmpty(context);
}
/**
* Pop error from queue
* @param context - scpi context
- * @return error number
+ * @param error
+ * @return
*/
-int16_t SCPI_ErrorPop(scpi_t * context) {
- int16_t result = 0;
-
- //// FreeRTOS
- //if (pdFALSE == xQueueReceive((xQueueHandle)context->error_queue, &result, 0)) {
- // result = 0;
- //}
-
- // basic FIFO
- fifo_remove((fifo_t *)context->error_queue, &result);
+scpi_bool_t SCPI_ErrorPop(scpi_t * context, scpi_error_t * error) {
+ if(!error || !context) return FALSE;
+ error->error_code = 0;
+ error->device_dependent_info = NULL;
+ fifo_remove(&context->error_queue, error);
- return result;
+ SCPI_ErrorEmitEmpty(context);
+
+ return TRUE;
}
/**
* Return number of errors/events in the queue
* @param context
- * @return
+ * @return
*/
int32_t SCPI_ErrorCount(scpi_t * context) {
int16_t result = 0;
-
- //// FreeRTOS
- //result = uxQueueMessagesWaiting((xQueueHandle)context->error_queue);
-
- //basic FIFO
- fifo_count((fifo_t *)context->error_queue, &result);
-
-
+
+ fifo_count(&context->error_queue, &result);
+
return result;
}
-static void SCPI_ErrorPushInternal(scpi_t * context, int16_t err) {
- //// FreeRTOS
- //xQueueSend((xQueueHandle)context->error_queue, &err, 0);
-
- // basic FIFO
- fifo_add((fifo_t *)context->error_queue, err);
+static scpi_bool_t SCPI_ErrorAddInternal(scpi_t * context, int16_t err, char * info) {
+ if (!fifo_add(&context->error_queue, err, info)) {
+ fifo_remove_last(&context->error_queue, NULL);
+ fifo_add(&context->error_queue, SCPI_ERROR_QUEUE_OVERFLOW, NULL);
+ return FALSE;
+ }
+ return TRUE;
}
+
+struct error_reg {
+ int16_t from;
+ int16_t to;
+ scpi_reg_val_t bit;
+};
+
+#define ERROR_DEFS_N 9
+
+static const struct error_reg errs[ERROR_DEFS_N] = {
+ {-100, -199, ESR_CER}, /* Command error (e.g. syntax error) ch 21.8.9 */
+ {-200, -299, ESR_EER}, /* Execution Error (e.g. range error) ch 21.8.10 */
+ {-300, -399, ESR_DER}, /* Device specific error -300, -399 ch 21.8.11 */
+ { 1, 32767, ESR_DER}, /* Device designer provided specific error 1, 32767 ch 21.8.11 */
+ {-400, -499, ESR_QER}, /* Query error -400, -499 ch 21.8.12 */
+ {-500, -599, ESR_PON}, /* Power on event -500, -599 ch 21.8.13 */
+ {-600, -699, ESR_URQ}, /* User Request Event -600, -699 ch 21.8.14 */
+ {-700, -799, ESR_REQ}, /* Request Control Event -700, -799 ch 21.8.15 */
+ {-800, -899, ESR_OPC}, /* Operation Complete Event -800, -899 ch 21.8.16 */
+};
+
+/**
+ * Push error to queue
+ * @param context - scpi context
+ * @param err - error number
+ */
+void SCPI_ErrorPushEx(scpi_t * context, int16_t err, char * info) {
+ int i;
+ char * info_ptr = NULL;
+
+#if USE_DEVICE_DEPENDENT_ERROR_INFORMATION
+ if (info){
+ info_ptr = SCPIDEFINE_strdup(&context->error_info_heap, info);
+ }
+#endif
+
+ scpi_bool_t queue_overflow = !SCPI_ErrorAddInternal(context, err, info_ptr);
+
+ for (i = 0; i < ERROR_DEFS_N; i++) {
+ if ((err <= errs[i].from) && (err >= errs[i].to)) {
+ SCPI_RegSetBits(context, SCPI_REG_ESR, errs[i].bit);
+ }
+ }
+
+ SCPI_ErrorEmit(context, err);
+ if (queue_overflow) {
+ SCPI_ErrorEmit(context, SCPI_ERROR_QUEUE_OVERFLOW);
+#if USE_DEVICE_DEPENDENT_ERROR_INFORMATION
+ SCPIDEFINE_free(&context->error_info_heap, info_ptr, true);
+#endif
+ }
+
+ if (context) {
+ context->cmd_error = TRUE;
+ }
+}
+
/**
* Push error to queue
* @param context - scpi context
* @param err - error number
*/
void SCPI_ErrorPush(scpi_t * context, int16_t err) {
- SCPI_ErrorPushInternal(context, err);
-
- // Command error (e.g. syntax error) ch 21.8.9
- if ((err < -100) && (err > -199)) {
- SCPI_RegSetBits(context, SCPI_REG_ESR, ESR_CER);
- }
-
- // Execution Error (e.g. range error) ch 21.8.10
- if ((err < -200) && (err > -299)) {
- SCPI_RegSetBits(context, SCPI_REG_ESR, ESR_EER);
- }
-
- // Device specific error -300, -399 ch 21.8.11
- if ((err < -300) && (err > -399)) {
- SCPI_RegSetBits(context, SCPI_REG_ESR, ESR_DER);
- }
-
- // Query error -400, -499 ch 21.8.12
- if ((err < -400) && (err > -499)) {
- SCPI_RegSetBits(context, SCPI_REG_ESR, ESR_QER);
- }
-
- // Power on event -500, -599 ch 21.8.13
- if ((err < -500) && (err > -599)) {
- SCPI_RegSetBits(context, SCPI_REG_ESR, ESR_PON);
- }
-
- // User Request Event -600, -699 ch 21.8.14
- if ((err < -600) && (err > -699)) {
- SCPI_RegSetBits(context, SCPI_REG_ESR, ESR_URQ);
- }
-
- // Request Control Event -700, -799 ch 21.8.15
- if ((err < -700) && (err > -799)) {
- SCPI_RegSetBits(context, SCPI_REG_ESR, ESR_REQ);
- }
-
- // Operation Complete Event -800, -899 ch 21.8.16
- if ((err < -800) && (err > -899)) {
- SCPI_RegSetBits(context, SCPI_REG_ESR, ESR_OPC);
- }
-
- if (context) {
- if (context->interface && context->interface->error) {
- context->interface->error(context, err);
- }
-
- context->cmd_error = TRUE;
- }
+ SCPI_ErrorPushEx(context, err, NULL);
+ return;
}
/**
@@ -176,13 +205,19 @@
const char * SCPI_ErrorTranslate(int16_t err) {
switch (err) {
case 0: return "No error";
- case SCPI_ERROR_SYNTAX: return "Syntax error";
- case SCPI_ERROR_INVALID_SEPARATOR: return "Invalid separator";
- case SCPI_ERROR_UNDEFINED_HEADER: return "Undefined header";
- case SCPI_ERROR_PARAMETER_NOT_ALLOWED: return "Parameter not allowed";
- case SCPI_ERROR_MISSING_PARAMETER: return "Missing parameter";
- case SCPI_ERROR_INVALID_SUFFIX: return "Invalid suffix";
- case SCPI_ERROR_SUFFIX_NOT_ALLOWED: return "Suffix not allowed";
+#define X(def, val, str) case def: return str;
+#if USE_FULL_ERROR_LIST
+#define XE X
+#else
+#define XE(def, val, str)
+#endif
+ LIST_OF_ERRORS
+
+#if USE_USER_ERROR_LIST
+ LIST_OF_USER_ERRORS
+#endif
+#undef X
+#undef XE
default: return "Unknown error";
}
}
--
Gitblit v1.9.1