From e816026faa1ae11f0e9d26d27f420a304d4ad210 Mon Sep 17 00:00:00 2001
From: Jan Breuer <jan.breuer@jaybee.cz>
Date: 周五, 16 10月 2015 06:16:45 +0800
Subject: [PATCH] Resolve #59: input buffer overrun handling
---
libscpi/src/utils.c | 348 +++++++++++++++++++++++++++++++++++++++++++--------------
1 files changed, 262 insertions(+), 86 deletions(-)
diff --git a/libscpi/src/utils.c b/libscpi/src/utils.c
index e07d0f3..f92e877 100644
--- a/libscpi/src/utils.c
+++ b/libscpi/src/utils.c
@@ -4,7 +4,7 @@
* Copyright (c) 2012 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:
@@ -13,7 +13,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
@@ -30,10 +30,10 @@
/**
* @file scpi_utils.c
* @date Thu Nov 15 10:58:45 UTC 2012
- *
+ *
* @brief Conversion routines and string manipulation routines
- *
- *
+ *
+ *
*/
#include <stdio.h>
@@ -53,7 +53,7 @@
* @param str
* @param size
* @param set
- * @return
+ * @return
*/
char * strnpbrk(const char *str, size_t size, const char *set) {
const char *scanp;
@@ -69,14 +69,15 @@
}
/**
- * Converts signed 32b integer value to string
+ * Converts signed/unsigned 32 bit integer value to string in specific base
* @param val integer value
* @param str converted textual representation
* @param len string buffer length
* @param base output base
+ * @param sign
* @return number of bytes written to str (without '\0')
*/
-size_t SCPI_LongToStr(int32_t val, char * str, size_t len, int8_t base) {
+size_t UInt32ToStrBaseSign(uint32_t val, char * str, size_t len, int8_t base, scpi_bool_t sign) {
const char digits[] = "0123456789ABCDEF";
#define ADD_CHAR(c) if (pos < len) str[pos++] = (c)
@@ -90,7 +91,7 @@
} else {
switch (base) {
- case 2:
+ case 2:
x = 0x80000000L;
break;
case 8:
@@ -99,7 +100,7 @@
case 10:
x = 1000000000L;
break;
- case 0x10:
+ case 16:
x = 0x10000000L;
break;
default:
@@ -109,7 +110,7 @@
}
// add sign for numbers in base 10
- if ((val < 0) && (base == 10)) {
+ if (sign && ((int32_t) val < 0) && (base == 10)) {
uval = -val;
ADD_CHAR('-');
}
@@ -133,7 +134,129 @@
}
/**
- * Converts double value to string
+ * Converts signed 32 bit integer value to string
+ * @param val integer value
+ * @param str converted textual representation
+ * @param len string buffer length
+ * @return number of bytes written to str (without '\0')
+ */
+size_t SCPI_Int32ToStr(int32_t val, char * str, size_t len) {
+ return UInt32ToStrBaseSign((int32_t) val, str, len, 10, TRUE);
+}
+
+/**
+ * Converts unsigned 32 bit integer value to string in specific base
+ * @param val integer value
+ * @param str converted textual representation
+ * @param len string buffer length
+ * @param base output base
+ * @return number of bytes written to str (without '\0')
+ */
+size_t SCPI_UInt32ToStrBase(uint32_t val, char * str, size_t len, int8_t base) {
+ return UInt32ToStrBaseSign(val, str, len, base, FALSE);
+}
+
+/**
+ * Converts signed/unsigned 64 bit integer value to string in specific base
+ * @param val integer value
+ * @param str converted textual representation
+ * @param len string buffer length
+ * @param base output base
+ * @param sign
+ * @return number of bytes written to str (without '\0')
+ */
+size_t UInt64ToStrBaseSign(uint64_t val, char * str, size_t len, int8_t base, scpi_bool_t sign) {
+ const char digits[] = "0123456789ABCDEF";
+
+#define ADD_CHAR(c) if (pos < len) str[pos++] = (c)
+ uint64_t x = 0;
+ int_fast8_t digit;
+ size_t pos = 0;
+ uint64_t uval = val;
+
+ if (uval == 0) {
+ ADD_CHAR('0');
+ } else {
+
+ switch (base) {
+ case 2:
+ x = 0x8000000000000000ULL;
+ break;
+ case 8:
+ x = 0x8000000000000000ULL;
+ break;
+ case 10:
+ x = 10000000000000000000ULL;
+ break;
+ case 16:
+ x = 0x1000000000000000ULL;
+ break;
+ default:
+ x = 10000000000000000000ULL;
+ base = 10;
+ break;
+ }
+
+ // add sign for numbers in base 10
+ if (sign && ((int64_t) val < 0) && (base == 10)) {
+ uval = -val;
+ ADD_CHAR('-');
+ }
+
+ // remove leading zeros
+ while ((uval / x) == 0) {
+ x /= base;
+ }
+
+ do {
+ digit = (uint8_t) (uval / x);
+ ADD_CHAR(digits[digit]);
+ uval -= digit * x;
+ x /= base;
+ } while (x && (pos < len));
+ }
+
+ if (pos < len) str[pos] = 0;
+ return pos;
+#undef ADD_CHAR
+}
+
+/**
+ * Converts signed 64 bit integer value to string
+ * @param val integer value
+ * @param str converted textual representation
+ * @param len string buffer length
+ * @return number of bytes written to str (without '\0')
+ */
+size_t SCPI_Int64ToStr(int64_t val, char * str, size_t len) {
+ return UInt64ToStrBaseSign((int64_t) val, str, len, 10, TRUE);
+}
+
+/**
+ * Converts signed/unsigned 64 bit integer value to string in specific base
+ * @param val integer value
+ * @param str converted textual representation
+ * @param len string buffer length
+ * @param base output base
+ * @return number of bytes written to str (without '\0')
+ */
+size_t SCPI_UInt64ToStrBase(uint64_t val, char * str, size_t len, int8_t base) {
+ return UInt64ToStrBaseSign(val, str, len, base, FALSE);
+}
+
+/**
+ * Converts float (32 bit) value to string
+ * @param val long value
+ * @param str converted textual representation
+ * @param len string buffer length
+ * @return number of bytes written to str (without '\0')
+ */
+size_t SCPI_FloatToStr(float val, char * str, size_t len) {
+ return SCPIDEFINE_floatToStr(val, str, len);
+}
+
+/**
+ * Converts double (64 bit) value to string
* @param val double value
* @param str converted textual representation
* @param len string buffer length
@@ -149,7 +272,7 @@
* @param val 32bit integer result
* @return number of bytes used in string
*/
-size_t strToLong(const char * str, int32_t * val, int8_t base) {
+size_t strBaseToInt32(const char * str, int32_t * val, int8_t base) {
char * endptr;
*val = strtol(str, &endptr, base);
return endptr - str;
@@ -161,15 +284,50 @@
* @param val 32bit integer result
* @return number of bytes used in string
*/
-size_t strToULong(const char * str, uint32_t * val, int8_t base) {
+size_t strBaseToUInt32(const char * str, uint32_t * val, int8_t base) {
char * endptr;
*val = strtoul(str, &endptr, base);
return endptr - str;
}
+/**
+ * Converts string to signed 64bit integer representation
+ * @param str string value
+ * @param val 64bit integer result
+ * @return number of bytes used in string
+ */
+size_t strBaseToInt64(const char * str, int64_t * val, int8_t base) {
+ char * endptr;
+ *val = strtol(str, &endptr, base);
+ return endptr - str;
+}
/**
- * Converts string to double representation
+ * Converts string to unsigned 64bit integer representation
+ * @param str string value
+ * @param val 64bit integer result
+ * @return number of bytes used in string
+ */
+size_t strBaseToUInt64(const char * str, uint64_t * val, int8_t base) {
+ char * endptr;
+ *val = strtoull(str, &endptr, base);
+ return endptr - str;
+}
+
+/**
+ * Converts string to float (32 bit) representation
+ * @param str string value
+ * @param val float result
+ * @return number of bytes used in string
+ */
+size_t strToFloat(const char * str, float * val) {
+ char * endptr;
+ *val = strtof(str, &endptr);
+ return endptr - str;
+}
+
+/**
+ * Converts string to double (64 bit) representation
* @param str string value
* @param val double result
* @return number of bytes used in string
@@ -221,10 +379,10 @@
if (num) {
if (len1 == len2) {
- *num = 1;
+ //*num = 1;
} else {
int32_t tmpNum;
- i = len1 + strToLong(str2 + len1, &tmpNum, 10);
+ i = len1 + strBaseToInt32(str2 + len1, &tmpNum, 10);
if (i != len2) {
result = FALSE;
} else {
@@ -232,7 +390,7 @@
}
}
} else {
- for (i = len1; i<len2; i++) {
+ for (i = len1; i < len2; i++) {
if (!isdigit((int) str2[i])) {
result = FALSE;
break;
@@ -317,7 +475,7 @@
* @param pattern_len
* @param str
* @param str_len
- * @return
+ * @return
*/
scpi_bool_t matchPattern(const char * pattern, size_t pattern_len, const char * str, size_t str_len, int32_t * num) {
int pattern_sep_pos_short;
@@ -345,10 +503,12 @@
* @param len - max search length
* @return TRUE if pattern matches, FALSE otherwise
*/
-scpi_bool_t matchCommand(const char * pattern, const char * cmd, size_t len, int32_t *numbers, size_t numbers_len) {
+scpi_bool_t matchCommand(const char * pattern, const char * cmd, size_t len, int32_t *numbers, size_t numbers_len, int32_t default_value) {
+#define SKIP_PATTERN(n) do {pattern_ptr += (n); pattern_len -= (n);} while(0)
+#define SKIP_CMD(n) do {cmd_ptr += (n); cmd_len -= (n);} while(0)
+
scpi_bool_t result = FALSE;
- int leftFlag = 0; // flag for '[' on left
- int rightFlag = 0; // flag for ']' on right
+ int brackets = 0;
int cmd_sep_pos = 0;
size_t numbers_idx = 0;
@@ -356,45 +516,49 @@
const char * pattern_ptr = pattern;
int pattern_len = strlen(pattern);
- const char * pattern_end = pattern + pattern_len;
const char * cmd_ptr = cmd;
size_t cmd_len = SCPIDEFINE_strnlen(cmd, len);
- const char * cmd_end = cmd + cmd_len;
+
+ /* both commands are query commands? */
+ if (pattern_ptr[pattern_len - 1] == '?') {
+ if (cmd_ptr[cmd_len - 1] == '?') {
+ cmd_len -= 1;
+ pattern_len -= 1;
+ } else {
+ return FALSE;
+ }
+ }
/* now support optional keywords in pattern style, e.g. [:MEASure]:VOLTage:DC? */
if (pattern_ptr[0] == '[') { // skip first '['
- pattern_len--;
- pattern_ptr++;
- leftFlag++;
+ SKIP_PATTERN(1);
+ brackets++;
}
if (pattern_ptr[0] == ':') { // skip first ':'
- pattern_len--;
- pattern_ptr++;
+ SKIP_PATTERN(1);
}
if (cmd_ptr[0] == ':') {
/* handle errornouse ":*IDN?" */
- if ((cmd_len >= 2) && (cmd_ptr[1] != '*')) {
- cmd_len--;
- cmd_ptr++;
+ if (cmd_len >= 2) {
+ if (cmd_ptr[1] != '*') {
+ SKIP_CMD(1);
+ } else {
+ return FALSE;
+ }
}
}
while (1) {
- int pattern_sep_pos = patternSeparatorPos(pattern_ptr, pattern_end - pattern_ptr);
+ int pattern_sep_pos = patternSeparatorPos(pattern_ptr, pattern_len);
- if ((leftFlag > 0) && (rightFlag > 0)) {
- leftFlag--;
- rightFlag--;
- } else {
- cmd_sep_pos = cmdSeparatorPos(cmd_ptr, cmd_end - cmd_ptr);
- }
+ cmd_sep_pos = cmdSeparatorPos(cmd_ptr, cmd_len);
if ((pattern_sep_pos > 0) && pattern_ptr[pattern_sep_pos - 1] == '#') {
if (numbers && (numbers_idx < numbers_len)) {
number_ptr = numbers + numbers_idx;
- *number_ptr = 1; // default value
+ *number_ptr = default_value; // default value
} else {
number_ptr = NULL;
}
@@ -404,85 +568,95 @@
}
if (matchPattern(pattern_ptr, pattern_sep_pos, cmd_ptr, cmd_sep_pos, number_ptr)) {
- pattern_ptr += pattern_sep_pos;
- pattern_len -= pattern_sep_pos;
- cmd_ptr = cmd_ptr + cmd_sep_pos;
+ SKIP_PATTERN(pattern_sep_pos);
+ SKIP_CMD(cmd_sep_pos);
result = TRUE;
/* command is complete */
- if ((pattern_ptr == pattern_end) && (cmd_ptr >= cmd_end)) {
+ if ((pattern_len == 0) && (cmd_len == 0)) {
break;
}
/* pattern complete, but command not */
- if ((pattern_ptr == pattern_end) && (cmd_ptr < cmd_end)) {
+ if ((pattern_len == 0) && (cmd_len > 0)) {
result = FALSE;
break;
}
/* command complete, but pattern not */
- if (cmd_ptr >= cmd_end) {
- if (cmd_end == cmd_ptr) {
- if (cmd_ptr[0] == pattern_ptr[pattern_end - pattern_ptr - 1]) {
- break; /* exist optional keyword, command is complete */
+ if (cmd_len == 0) {
+ // verify all subsequent pattern parts are also optional
+ while (pattern_len) {
+ pattern_sep_pos = patternSeparatorPos(pattern_ptr, pattern_len);
+ switch (pattern_ptr[pattern_sep_pos]) {
+ case '[':
+ brackets++;
+ break;
+ case ']':
+ brackets--;
+ break;
+ default:
+ break;
}
- if (']' == pattern_ptr[pattern_end - pattern_ptr - 1]) {
- break; /* exist optional keyword, command is complete */
+ SKIP_PATTERN(pattern_sep_pos + 1);
+ if (brackets == 0) {
+ if ((pattern_len > 0) && (pattern_ptr[0] == '[')) {
+ continue;
+ } else {
+ break;
+ }
}
}
- result = FALSE;
- break;
+ if (pattern_len != 0) {
+ result = FALSE;
+ }
+ break; /* exist optional keyword, command is complete */
}
/* both command and patter contains command separator at this position */
- if ((pattern_ptr[0] == cmd_ptr[0]) && ((pattern_ptr[0] == ':') || (pattern_ptr[0] == '?'))) {
- pattern_ptr += 1;
- pattern_len -= 1;
- cmd_ptr = cmd_ptr + 1;
- } else if ((pattern_len > 1) && (pattern_ptr[1] == cmd_ptr[0])
+ if ((pattern_len > 0)
+ && ((pattern_ptr[0] == cmd_ptr[0])
+ && (pattern_ptr[0] == ':'))) {
+ SKIP_PATTERN(1);
+ SKIP_CMD(1);
+ } else if ((pattern_len > 1)
+ && (pattern_ptr[1] == cmd_ptr[0])
&& (pattern_ptr[0] == '[')
&& (pattern_ptr[1] == ':')) {
- pattern_ptr += 2; // for skip '[' in "[:"
- pattern_len -= 2;
- cmd_ptr = cmd_ptr + 1;
- leftFlag++;
- } else if ((pattern_len > 1) && (pattern_ptr[1] == cmd_ptr[0])
+ SKIP_PATTERN(2); // for skip '[' in "[:"
+ SKIP_CMD(1);
+ brackets++;
+ } else if ((pattern_len > 1)
+ && (pattern_ptr[1] == cmd_ptr[0])
&& (pattern_ptr[0] == ']')
&& (pattern_ptr[1] == ':')) {
- pattern_ptr += 2; // for skip ']' in "]:"
- pattern_len -= 2;
- cmd_ptr = cmd_ptr + 1;
- } else if ((pattern_len > 2) && (pattern_ptr[2] == cmd_ptr[0])
+ SKIP_PATTERN(2); // for skip ']' in "]:"
+ SKIP_CMD(1);
+ brackets--;
+ } else if ((pattern_len > 2)
+ && (pattern_ptr[2] == cmd_ptr[0])
&& (pattern_ptr[0] == ']')
&& (pattern_ptr[1] == '[')
&& (pattern_ptr[2] == ':')) {
- pattern_ptr += 3; // for skip '][' in "][:"
- pattern_len -= 3;
- cmd_ptr = cmd_ptr + 1;
- leftFlag++;
- } else if (((pattern_ptr[0] == ']')
- || (pattern_ptr[0] == '['))
- && (*(pattern_end - 1) == '?') // last is '?'
- && (cmd_ptr[0] == '?')) {
- result = TRUE; // exist optional keyword, and they are end with '?'
- break; // command is complete OK
+ SKIP_PATTERN(3); // for skip '][' in "][:"
+ SKIP_CMD(1);
+ //brackets++;
+ //brackets--;
} else {
result = FALSE;
break;
}
} else {
- pattern_ptr += pattern_sep_pos;
- pattern_len -= pattern_sep_pos;
+ SKIP_PATTERN(pattern_sep_pos);
if ((pattern_ptr[0] == ']') && (pattern_ptr[1] == ':')) {
- pattern_ptr += 2; // for skip ']' in "]:" , pattern_ptr continue, while cmd_ptr remain unchanged
- pattern_len -= 2;
- rightFlag++;
+ SKIP_PATTERN(2); // for skip ']' in "]:" , pattern_ptr continue, while cmd_ptr remain unchanged
+ brackets--;
} else if ((pattern_len > 2) && (pattern_ptr[0] == ']')
&& (pattern_ptr[1] == '[')
&& (pattern_ptr[2] == ':')) {
- pattern_ptr += 3; // for skip ']' in "][:" , pattern_ptr continue, while cmd_ptr remain unchanged
- pattern_len -= 3;
- rightFlag++;
+ SKIP_PATTERN(3); // for skip ']' in "][:" , pattern_ptr continue, while cmd_ptr remain unchanged
+ //brackets++;
+ //brackets--;
} else {
result = FALSE;
break;
@@ -491,10 +665,12 @@
}
return result;
+#undef SKIP_PATTERN
+#undef SKIP_CMD
}
/**
- * Compose command from previsou command anc current command
+ * Compose command from previous command anc current command
*
* @param prev pointer to previous command
* @param current pointer of current command
--
Gitblit v1.9.1