Add compile option to disable floating point usage (#114)
This commit adds the option to disable floating point processing in
QCBOR. To disable, the USEFULBUF_DISABLE_ALL_FLOAT preprocessor macro
needs to be defined.
e.g.:
$ make CMD_LINE="-DUSEFULBUF_DISABLE_ALL_FLOAT"
This removes the capability (and the code) of decoding floating point
types. The type is still recognised, so a meaningful
QCBOR_ERR_ALL_FLOAT_DISABLED error is returned when a floating point value
is encountered in a decoded qcbor. From the encoding interface the
floating point encoding functions are removed.
Change-Id: I371769246f7d83354607de9bce1e7998b8c536a1
Signed-off-by: Mate Toth-Pal <mate.toth-pal@arm.com>
diff --git a/inc/qcbor/UsefulBuf.h b/inc/qcbor/UsefulBuf.h
index c271a31..fb3c12b 100644
--- a/inc/qcbor/UsefulBuf.h
+++ b/inc/qcbor/UsefulBuf.h
@@ -1,6 +1,7 @@
/*============================================================================
Copyright (c) 2016-2018, The Linux Foundation.
Copyright (c) 2018-2021, Laurence Lundblade.
+ Copyright (c) 2021, Arm Limited. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
@@ -138,6 +139,12 @@
* handle big and little-endian with system option.
* USEFULBUF_CONFIG_BSWAP -- With USEFULBUF_CONFIG_LITTLE_ENDIAN,
* use __builtin_bswapXX().
+ *
+ * It is possible to run this code in environments where using floating point is
+ * not allowed. Defining USEFULBUF_DISABLE_ALL_FLOAT will disable all the code
+ * that is related to handling floating point types, along with related
+ * interfaces. This makes it possible to compile the code with the compile
+ * option -mgeneral-regs-only.
*/
#if defined(USEFULBUF_CONFIG_BIG_ENDIAN) && defined(USEFULBUF_CONFIG_LITTLE_ENDIAN)
@@ -679,6 +686,7 @@
+#ifndef USEFULBUF_DISABLE_ALL_FLOAT
/**
* @brief Copy a @c float to a @c uint32_t.
*
@@ -733,6 +741,7 @@
* is a crusty corner of C.
*/
static inline double UsefulBufUtil_CopyUint64ToDouble(uint64_t u64);
+#endif /* USEFULBUF_DISABLE_ALL_FLOAT */
@@ -1032,6 +1041,7 @@
size_t uPos);
+#ifndef USEFULBUF_DISABLE_ALL_FLOAT
/**
* @brief Insert a @c float into the @ref UsefulOutBuf.
*
@@ -1064,6 +1074,7 @@
static inline void UsefulOutBuf_InsertDouble(UsefulOutBuf *pUOutBuf,
double d,
size_t uPos);
+#endif /* USEFULBUF_DISABLE_ALL_FLOAT */
/**
@@ -1162,6 +1173,7 @@
uint64_t uInteger64);
+#ifndef USEFULBUF_DISABLE_ALL_FLOAT
/**
* @brief Append a @c float to the @ref UsefulOutBuf
*
@@ -1190,6 +1202,7 @@
*/
static inline void UsefulOutBuf_AppendDouble(UsefulOutBuf *pUOutBuf,
double d);
+#endif /* USEFULBUF_DISABLE_ALL_FLOAT */
/**
@@ -1519,6 +1532,7 @@
static uint64_t UsefulInputBuf_GetUint64(UsefulInputBuf *pUInBuf);
+#ifndef USEFULBUF_DISABLE_ALL_FLOAT
/**
* @brief Get a float out of the input buffer.
*
@@ -1547,6 +1561,7 @@
* The input bytes are interpreted in network order (big endian).
*/
static double UsefulInputBuf_GetDouble(UsefulInputBuf *pUInBuf);
+#endif /* USEFULBUF_DISABLE_ALL_FLOAT */
/**
@@ -1778,6 +1793,7 @@
}
+#ifndef USEFULBUF_DISABLE_ALL_FLOAT
static inline uint32_t UsefulBufUtil_CopyFloatToUint32(float f)
{
uint32_t u32;
@@ -1805,6 +1821,7 @@
memcpy(&f, &u32, sizeof(uint32_t));
return f;
}
+#endif /* USEFULBUF_DISABLE_ALL_FLOAT */
@@ -1984,6 +2001,7 @@
}
+#ifndef USEFULBUF_DISABLE_ALL_FLOAT
static inline void UsefulOutBuf_InsertFloat(UsefulOutBuf *pMe,
float f,
size_t uPos)
@@ -1998,6 +2016,7 @@
{
UsefulOutBuf_InsertUint64(pMe, UsefulBufUtil_CopyDoubleToUint64(d), uPos);
}
+#endif /* USEFULBUF_DISABLE_ALL_FLOAT */
static inline void UsefulOutBuf_AppendUsefulBuf(UsefulOutBuf *pMe,
@@ -2055,6 +2074,7 @@
}
+#ifndef USEFULBUF_DISABLE_ALL_FLOAT
static inline void UsefulOutBuf_AppendFloat(UsefulOutBuf *pMe,
float f)
{
@@ -2067,6 +2087,7 @@
{
UsefulOutBuf_InsertDouble(pMe, d, UsefulOutBuf_GetEndPosition(pMe));
}
+#endif /* USEFULBUF_DISABLE_ALL_FLOAT */
static inline int UsefulOutBuf_GetError(UsefulOutBuf *pMe)
@@ -2325,6 +2346,7 @@
}
+#ifndef USEFULBUF_DISABLE_ALL_FLOAT
static inline float UsefulInputBuf_GetFloat(UsefulInputBuf *pMe)
{
uint32_t uResult = UsefulInputBuf_GetUint32(pMe);
@@ -2339,6 +2361,7 @@
return uResult ? UsefulBufUtil_CopyUint64ToDouble(uResult) : 0;
}
+#endif /* USEFULBUF_DISABLE_ALL_FLOAT */
static inline int UsefulInputBuf_GetError(UsefulInputBuf *pMe)