blob: 00b10cb15a83a8d426f9ba29a4384200de31d7f0 [file] [log] [blame]
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001/*==============================================================================
Laurence Lundbladed92a6162018-11-01 11:38:35 +07002 Copyright (c) 2016-2018, The Linux Foundation.
Laurence Lundbladeee851742020-01-08 08:37:05 -08003 Copyright (c) 2018-2020, Laurence Lundblade.
Laurence Lundbladed92a6162018-11-01 11:38:35 +07004 All rights reserved.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08005
Laurence Lundblade0dbc9172018-11-01 14:17:21 +07006Redistribution and use in source and binary forms, with or without
7modification, are permitted provided that the following conditions are
8met:
9 * Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11 * Redistributions in binary form must reproduce the above
12 copyright notice, this list of conditions and the following
13 disclaimer in the documentation and/or other materials provided
14 with the distribution.
15 * Neither the name of The Linux Foundation nor the names of its
16 contributors, nor the name "Laurence Lundblade" may be used to
17 endorse or promote products derived from this software without
18 specific prior written permission.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -080019
Laurence Lundblade0dbc9172018-11-01 14:17:21 +070020THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
21WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
22MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
23ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
24BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
27BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
29OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
30IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Laurence Lundbladeee851742020-01-08 08:37:05 -080031 =============================================================================*/
Laurence Lundblade624405d2018-09-18 20:10:47 -070032
Laurence Lundblade3aee3a32018-12-17 16:17:45 -080033
Laurence Lundblade844bb5c2020-03-01 17:27:25 -080034#include "qcbor/qcbor_decode.h"
Laurence Lundblade67257dc2020-07-27 03:33:37 -070035#include "qcbor/qcbor_spiffy_decode.h"
Laurence Lundbladec7114722020-08-13 05:11:40 -070036#include "ieee754.h" // Does not use math.h
37
38#ifndef QCBOR_DISABLE_FLOAT_HW_USE
39#include <math.h> // For isnan(). TODO: list
40#endif
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070041
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070042
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +053043/*
44 This casts away the const-ness of a pointer, usually so it can be
45 freed or realloced.
46 */
47#define UNCONST_POINTER(ptr) ((void *)(ptr))
48
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070049
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070050
Laurence Lundblade02625d42020-06-25 14:41:41 -070051inline static bool
52// TODO: add more tests for QCBOR_TYPE_MAP_AS_ARRAY mode in qcbor_decode_tests.c
53QCBORItem_IsMapOrArray(const QCBORItem *pMe)
54{
55 const uint8_t uDataType = pMe->uDataType;
56 return uDataType == QCBOR_TYPE_MAP ||
57 uDataType == QCBOR_TYPE_ARRAY ||
58 uDataType == QCBOR_TYPE_MAP_AS_ARRAY;
59}
60
61inline static bool
62QCBORItem_IsEmptyDefiniteLengthMapOrArray(const QCBORItem *pMe)
63{
64 if(!QCBORItem_IsMapOrArray(pMe)){
65 return false;
66 }
67
68 if(pMe->val.uCount != 0) {
69 return false;
70 }
71 return true;
72}
73
74inline static bool
75QCBORItem_IsIndefiniteLengthMapOrArray(const QCBORItem *pMe)
76{
77 if(!QCBORItem_IsMapOrArray(pMe)){
78 return false;
79 }
80
81 if(pMe->val.uCount != QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
82 return false;
83 }
84 return true;
85}
86
87
Laurence Lundbladeee851742020-01-08 08:37:05 -080088/*===========================================================================
Laurence Lundbladea8edadb2020-06-27 22:35:37 -070089 DecodeNesting -- Tracking array/map/sequence/bstr-wrapped nesting
Laurence Lundbladeee851742020-01-08 08:37:05 -080090 ===========================================================================*/
91
Laurence Lundblade9c905e82020-04-25 11:31:38 -070092/*
Laurence Lundbladea8edadb2020-06-27 22:35:37 -070093 See commecnts about and typedef of QCBORDecodeNesting in qcbor_private.h, the data structure
94 all these functions work on.
Laurence Lundblade9c905e82020-04-25 11:31:38 -070095
Laurence Lundblade9c905e82020-04-25 11:31:38 -070096
Laurence Lundblade9c905e82020-04-25 11:31:38 -070097
Laurence Lundblade9c905e82020-04-25 11:31:38 -070098 */
99
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700100
101inline static uint8_t
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700102DecodeNesting_GetCurrentLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700103{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700104 const ptrdiff_t nLevel = pNesting->pCurrent - &(pNesting->pLevels[0]);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700105 /*
106 Limit in DecodeNesting_Descend against more than
107 QCBOR_MAX_ARRAY_NESTING gaurantees cast is safe
108 */
Laurence Lundblade5e87da62020-06-07 03:24:28 -0700109 return (uint8_t)nLevel;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700110}
111
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700112
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700113inline static uint8_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700114DecodeNesting_GetBoundedModeLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700115{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700116 const ptrdiff_t nLevel = pNesting->pCurrentBounded - &(pNesting->pLevels[0]);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700117 /*
118 Limit in DecodeNesting_Descend against more than
119 QCBOR_MAX_ARRAY_NESTING gaurantees cast is safe
120 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700121 return (uint8_t)nLevel;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700122}
123
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700124
Laurence Lundblade5f4e8712020-07-25 11:44:43 -0700125static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700126DecodeNesting_GetMapOrArrayStart(const QCBORDecodeNesting *pNesting)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700127{
128 return pNesting->pCurrentBounded->u.ma.uStartOffset;
129}
130
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700131
Laurence Lundblade085d7952020-07-24 10:26:30 -0700132static inline bool
133DecodeNesting_IsBoundedEmpty(const QCBORDecodeNesting *pNesting)
134{
135 if(pNesting->pCurrentBounded->u.ma.uCountCursor == QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
136 return true;
137 } else {
138 return false;
139 }
140}
141
142
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700143inline static bool
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700144DecodeNesting_IsCurrentAtTop(const QCBORDecodeNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700145{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700146 if(pNesting->pCurrent == &(pNesting->pLevels[0])) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700147 return true;
148 } else {
149 return false;
150 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700151}
152
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700153
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700154inline static bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700155DecodeNesting_IsCurrentDefiniteLength(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700156{
157 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700158 // Not a map or array
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700159 return false;
160 }
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700161 if(pNesting->pCurrent->u.ma.uCountTotal == QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700162 // Is indefinite
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700163 return false;
164 }
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700165 // All checks passed; is a definte length map or array
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700166 return true;
167}
168
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700169
Laurence Lundblade642282a2020-06-23 12:00:33 -0700170inline static bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700171DecodeNesting_IsCurrentBstrWrapped(const QCBORDecodeNesting *pNesting)
Laurence Lundblade642282a2020-06-23 12:00:33 -0700172{
173 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700174 // is a byte string
Laurence Lundblade642282a2020-06-23 12:00:33 -0700175 return true;
176 }
177 return false;
178}
179
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700180
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700181inline static bool DecodeNesting_IsCurrentBounded(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700182{
183 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
184 return true;
185 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700186 if(pNesting->pCurrent->u.ma.uStartOffset != QCBOR_NON_BOUNDED_OFFSET) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700187 return true;
188 }
189 return false;
190}
191
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700192
Laurence Lundblade085d7952020-07-24 10:26:30 -0700193inline static void DecodeNesting_SetMapOrArrayBoundedMode(QCBORDecodeNesting *pNesting, bool bIsEmpty, size_t uStart)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700194{
195 // Should be only called on maps and arrays
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700196 /*
197 DecodeNesting_EnterBoundedMode() checks to be sure uStart is not
198 larger than DecodeNesting_EnterBoundedMode which keeps it less than
199 uin32_t so the cast is safe.
200 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700201 pNesting->pCurrent->u.ma.uStartOffset = (uint32_t)uStart;
Laurence Lundblade085d7952020-07-24 10:26:30 -0700202
203 if(bIsEmpty) {
204 pNesting->pCurrent->u.ma.uCountCursor = QCBOR_COUNT_INDICATES_ZERO_LENGTH;
205 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700206}
207
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700208
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700209inline static void DecodeNesting_ClearBoundedMode(QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700210{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700211 pNesting->pCurrent->u.ma.uStartOffset = QCBOR_NON_BOUNDED_OFFSET;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700212}
213
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700214
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700215inline static bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700216DecodeNesting_IsAtEndOfBoundedLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700217{
218 if(pNesting->pCurrentBounded == NULL) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700219 // No bounded map or array or... set up
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700220 return false;
221 }
222 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700223 // Not a map or array; end of those is by byte count */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700224 return false;
225 }
226 if(!DecodeNesting_IsCurrentBounded(pNesting)) { // TODO: pCurrent vs pCurrentBounded
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700227 // Not at a bounded level
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700228 return false;
229 }
Laurence Lundbladed0304932020-06-27 10:59:38 -0700230 // Works for both definite and indefinite length maps/arrays
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700231 if(pNesting->pCurrentBounded->u.ma.uCountCursor != 0) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700232 // Count is not zero, still unconsumed item
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700233 return false;
234 }
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700235 // All checks passed, got to the end of a map/array
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700236 return true;
237}
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700238
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700239
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700240inline static bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700241DecodeNesting_IsEndOfDefiniteLengthMapOrArray(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700242{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700243 // Must only be called on map / array
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700244 if(pNesting->pCurrent->u.ma.uCountCursor == 0) {
245 return true;
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700246 } else {
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700247 return false;
248 }
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700249}
250
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700251
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700252inline static bool
253DecodeNesting_IsCurrentTypeMap(const QCBORDecodeNesting *pNesting)
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700254{
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700255 if(pNesting->pCurrent->uLevelType == CBOR_MAJOR_TYPE_MAP) {
256 return true;
257 } else {
258 return false;
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700259 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700260}
261
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700262
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700263inline static bool
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -0700264DecodeNesting_IsBoundedType(const QCBORDecodeNesting *pNesting, uint8_t uType)
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700265{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700266 if(pNesting->pCurrentBounded == NULL) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700267 return false;
268 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700269
270 if(pNesting->pCurrentBounded->uLevelType != uType) {
271 return false;
272 }
273
274 return true;
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700275}
276
Laurence Lundblade02625d42020-06-25 14:41:41 -0700277
Laurence Lundbladed8c82c52020-06-12 22:15:52 -0700278inline static void
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700279DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(QCBORDecodeNesting *pNesting)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700280{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700281 // Only call on a defnite length array / map
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700282 pNesting->pCurrent->u.ma.uCountCursor--;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -0700283}
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700284
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700285
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700286inline static void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700287DecodeNesting_ReverseDecrement(QCBORDecodeNesting *pNesting)
288{
289 // Only call on a defnite length array / map
290 pNesting->pCurrent->u.ma.uCountCursor++;
291}
292
293
294inline static void
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700295DecodeNesting_Ascend(QCBORDecodeNesting *pNesting)
296{
297 pNesting->pCurrent--;
298}
299
Laurence Lundblade02625d42020-06-25 14:41:41 -0700300
301static QCBORError
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700302DecodeNesting_Descend(QCBORDecodeNesting *pNesting, uint8_t uType)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700303{
304 // Error out if nesting is too deep
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700305 if(pNesting->pCurrent >= &(pNesting->pLevels[QCBOR_MAX_ARRAY_NESTING])) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700306 return QCBOR_ERR_ARRAY_NESTING_TOO_DEEP;
307 }
308
309 // The actual descend
310 pNesting->pCurrent++;
311
312 pNesting->pCurrent->uLevelType = uType;
313
314 return QCBOR_SUCCESS;
315}
316
317
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700318inline static QCBORError
Laurence Lundblade085d7952020-07-24 10:26:30 -0700319DecodeNesting_EnterBoundedMapOrArray(QCBORDecodeNesting *pNesting, bool bIsEmpty, size_t uOffset)
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -0700320{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700321 /*
322 Should only be called on map/array.
323
324 Have descended into this before this is called. The job here is
325 just to mark it in bounded mode.
326 */
Laurence Lundblade287b25c2020-08-06 13:48:42 -0700327 if(uOffset >= QCBOR_NON_BOUNDED_OFFSET) {
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700328 return QCBOR_ERR_BUFFER_TOO_LARGE;
329 }
330
Laurence Lundblade0750fc42020-06-20 21:02:34 -0700331 pNesting->pCurrentBounded = pNesting->pCurrent;
Laurence Lundblade085d7952020-07-24 10:26:30 -0700332
333 DecodeNesting_SetMapOrArrayBoundedMode(pNesting, bIsEmpty, uOffset);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700334
335 return QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -0700336}
337
Laurence Lundblade64b607e2020-05-13 13:05:57 -0700338
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700339inline static QCBORError
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700340DecodeNesting_DescendMapOrArray(QCBORDecodeNesting *pNesting,
Laurence Lundblade02625d42020-06-25 14:41:41 -0700341 uint8_t uQCBORType,
342 uint64_t uCount)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700343{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700344 QCBORError uError = QCBOR_SUCCESS;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700345
346 if(uCount == 0) {
347 // Nothing to do for empty definite lenth arrays. They are just are
348 // effectively the same as an item that is not a map or array
349 goto Done;
350 // Empty indefinite length maps and arrays are handled elsewhere
351 }
352
353 // Error out if arrays is too long to handle
Laurence Lundblade02625d42020-06-25 14:41:41 -0700354 if(uCount != QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH &&
355 uCount > QCBOR_MAX_ITEMS_IN_ARRAY) {
356 uError = QCBOR_ERR_ARRAY_TOO_LONG;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700357 goto Done;
358 }
359
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700360 uError = DecodeNesting_Descend(pNesting, uQCBORType);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700361 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700362 goto Done;
363 }
364
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700365 // Fill in the new map/array level. Check above makes casts OK.
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700366 pNesting->pCurrent->u.ma.uCountCursor = (uint16_t)uCount;
367 pNesting->pCurrent->u.ma.uCountTotal = (uint16_t)uCount;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700368
369 DecodeNesting_ClearBoundedMode(pNesting);
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700370
371Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -0700372 return uError;;
373}
374
375
376static inline void
377DecodeNesting_LevelUpCurrent(QCBORDecodeNesting *pNesting)
378{
379 pNesting->pCurrent = pNesting->pCurrentBounded - 1;
380}
381
382
383static inline void
384DecodeNesting_LevelUpBounded(QCBORDecodeNesting *pNesting)
385{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700386 while(pNesting->pCurrentBounded != &(pNesting->pLevels[0])) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700387 pNesting->pCurrentBounded--;
388 if(DecodeNesting_IsCurrentBounded(pNesting)) {
389 break;
390 }
391 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700392}
393
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700394static inline void
395DecodeNesting_SetCurrentToBoundedLevel(QCBORDecodeNesting *pNesting)
396{
397 pNesting->pCurrent = pNesting->pCurrentBounded;
398}
399
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700400
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700401inline static QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -0700402DecodeNesting_DescendIntoBstrWrapped(QCBORDecodeNesting *pNesting,
Laurence Lundbladef76a2622020-08-06 19:51:03 -0700403 uint32_t uEndOffset,
404 uint32_t uEndOfBstr)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700405{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700406 QCBORError uError = QCBOR_SUCCESS;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700407
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700408 uError = DecodeNesting_Descend(pNesting, QCBOR_TYPE_BYTE_STRING);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700409 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700410 goto Done;
411 }
412
Laurence Lundblade02625d42020-06-25 14:41:41 -0700413 // Fill in the new byte string level
Laurence Lundbladef76a2622020-08-06 19:51:03 -0700414 pNesting->pCurrent->u.bs.uPreviousEndOffset = uEndOffset;
415 pNesting->pCurrent->u.bs.uEndOfBstr = uEndOfBstr;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700416
Laurence Lundblade02625d42020-06-25 14:41:41 -0700417 // Bstr wrapped levels are always bounded
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700418 pNesting->pCurrentBounded = pNesting->pCurrent;
419
420Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -0700421 return uError;;
422}
423
Laurence Lundbladed0304932020-06-27 10:59:38 -0700424
425static inline void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700426DecodeNesting_ZeroMapOrArrayCount(QCBORDecodeNesting *pNesting)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700427{
428 pNesting->pCurrent->u.ma.uCountCursor = 0;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700429}
430
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700431
Laurence Lundbladeee851742020-01-08 08:37:05 -0800432inline static void
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700433DecodeNesting_Init(QCBORDecodeNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700434{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700435 /* Assumes that *pNesting has been zero'd before this call. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700436 pNesting->pLevels[0].uLevelType = QCBOR_TYPE_BYTE_STRING;
437 pNesting->pCurrent = &(pNesting->pLevels[0]);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700438}
439
440
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700441inline static void
Laurence Lundblade02625d42020-06-25 14:41:41 -0700442DecodeNesting_PrepareForMapSearch(QCBORDecodeNesting *pNesting, QCBORDecodeNesting *pSave)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700443{
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -0700444 *pSave = *pNesting;
Laurence Lundblade0750fc42020-06-20 21:02:34 -0700445 pNesting->pCurrent = pNesting->pCurrentBounded;
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700446 pNesting->pCurrent->u.ma.uCountCursor = pNesting->pCurrent->u.ma.uCountTotal;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700447}
448
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700449
Laurence Lundblade02625d42020-06-25 14:41:41 -0700450static inline void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700451DecodeNesting_RestoreFromMapSearch(QCBORDecodeNesting *pNesting, const QCBORDecodeNesting *pSave)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700452{
453 *pNesting = *pSave;
454}
455
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700456
Laurence Lundblade02625d42020-06-25 14:41:41 -0700457static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700458DecodeNesting_GetEndOfBstr(const QCBORDecodeNesting *pMe)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700459{
460 return pMe->pCurrentBounded->u.bs.uEndOfBstr;
461}
462
463
Laurence Lundblade02625d42020-06-25 14:41:41 -0700464static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700465DecodeNesting_GetPreviousBoundedEnd(const QCBORDecodeNesting *pMe)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700466{
467 return pMe->pCurrentBounded->u.bs.uPreviousEndOffset;
468}
469
470
Laurence Lundblade02625d42020-06-25 14:41:41 -0700471#include <stdio.h>
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700472
473const char *TypeStr(uint8_t type)
474{
475 switch(type) {
476 case QCBOR_TYPE_MAP: return " map";
477 case QCBOR_TYPE_ARRAY: return "array";
478 case QCBOR_TYPE_BYTE_STRING: return " bstr";
479 default: return " --- ";
480 }
481}
482
483static char buf[20]; // Not thread safe, but that is OK
484const char *CountString(uint16_t uCount, uint16_t uTotal)
485{
486 if(uTotal == QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
487 strcpy(buf, "indefinite");
488 } else {
489 sprintf(buf, "%d/%d", uCount, uTotal);
490 }
491 return buf;
492}
493
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700494
Laurence Lundblade02625d42020-06-25 14:41:41 -0700495void DecodeNesting_Print(QCBORDecodeNesting *pNesting, UsefulInputBuf *pBuf, const char *szName)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700496{
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -0700497#if 0
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700498 printf("---%s--%d/%d--\narrow is current bounded level\n",
Laurence Lundblade02625d42020-06-25 14:41:41 -0700499 szName,
500 (uint32_t)pBuf->cursor,
501 (uint32_t)pBuf->UB.len);
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700502
503 printf("Level Type Count Offsets \n");
Laurence Lundblade02625d42020-06-25 14:41:41 -0700504 for(int i = 0; i < QCBOR_MAX_ARRAY_NESTING; i++) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700505 if(&(pNesting->pLevels[i]) > pNesting->pCurrent) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700506 break;
507 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700508
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700509 printf("%2s %2d %s ",
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700510 pNesting->pCurrentBounded == &(pNesting->pLevels[i]) ? "->": " ",
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700511 i,
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700512 TypeStr(pNesting->pLevels[i].uLevelType));
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700513
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700514 if(pNesting->pLevels[i].uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700515 printf(" %5d %5d",
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700516 pNesting->pLevels[i].u.bs.uEndOfBstr,
517 pNesting->pLevels[i].u.bs.uPreviousEndOffset);
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700518
519 } else {
520 printf("%10.10s ",
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700521 CountString(pNesting->pLevels[i].u.ma.uCountCursor,
522 pNesting->pLevels[i].u.ma.uCountTotal));
523 if(pNesting->pLevels[i].u.ma.uStartOffset != UINT32_MAX) {
524 printf("Bounded start: %u",pNesting->pLevels[i].u.ma.uStartOffset);
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700525 }
526 }
527
528 printf("\n");
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700529 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700530 printf("\n");
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -0700531#endif
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700532}
533
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700534
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700535
Laurence Lundbladeee851742020-01-08 08:37:05 -0800536/*===========================================================================
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800537 QCBORStringAllocate -- STRING ALLOCATOR INVOCATION
538
539 The following four functions are pretty wrappers for invocation of
540 the string allocator supplied by the caller.
541
Laurence Lundbladeee851742020-01-08 08:37:05 -0800542 ===========================================================================*/
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800543
Laurence Lundbladeee851742020-01-08 08:37:05 -0800544static inline void
545StringAllocator_Free(const QCORInternalAllocator *pMe, void *pMem)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800546{
547 (pMe->pfAllocator)(pMe->pAllocateCxt, pMem, 0);
548}
549
Laurence Lundbladeee851742020-01-08 08:37:05 -0800550// StringAllocator_Reallocate called with pMem NULL is
551// equal to StringAllocator_Allocate()
552static inline UsefulBuf
553StringAllocator_Reallocate(const QCORInternalAllocator *pMe,
554 void *pMem,
555 size_t uSize)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800556{
557 return (pMe->pfAllocator)(pMe->pAllocateCxt, pMem, uSize);
558}
559
Laurence Lundbladeee851742020-01-08 08:37:05 -0800560static inline UsefulBuf
561StringAllocator_Allocate(const QCORInternalAllocator *pMe, size_t uSize)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800562{
563 return (pMe->pfAllocator)(pMe->pAllocateCxt, NULL, uSize);
564}
565
Laurence Lundbladeee851742020-01-08 08:37:05 -0800566static inline void
567StringAllocator_Destruct(const QCORInternalAllocator *pMe)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800568{
569 if(pMe->pfAllocator) {
570 (pMe->pfAllocator)(pMe->pAllocateCxt, NULL, 0);
571 }
572}
573
574
575
Laurence Lundbladeee851742020-01-08 08:37:05 -0800576/*===========================================================================
577 QCBORDecode -- The main implementation of CBOR decoding
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700578
Laurence Lundblade844bb5c2020-03-01 17:27:25 -0800579 See qcbor/qcbor_decode.h for definition of the object
580 used here: QCBORDecodeContext
Laurence Lundbladeee851742020-01-08 08:37:05 -0800581 ===========================================================================*/
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700582/*
583 Public function, see header file
584 */
Laurence Lundbladeee851742020-01-08 08:37:05 -0800585void QCBORDecode_Init(QCBORDecodeContext *me,
586 UsefulBufC EncodedCBOR,
587 QCBORDecodeMode nDecodeMode)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700588{
589 memset(me, 0, sizeof(QCBORDecodeContext));
590 UsefulInputBuf_Init(&(me->InBuf), EncodedCBOR);
Laurence Lundbladeee851742020-01-08 08:37:05 -0800591 // Don't bother with error check on decode mode. If a bad value is
592 // passed it will just act as if the default normal mode of 0 was set.
Laurence Lundbladee6bcef12020-04-01 10:56:27 -0700593 me->uDecodeMode = (uint8_t)nDecodeMode;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700594 DecodeNesting_Init(&(me->nesting));
Laurence Lundblade830fbf92020-05-31 17:22:33 -0700595 for(int i = 0; i < QCBOR_NUM_MAPPED_TAGS; i++) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -0700596 me->auMappedTags[i] = CBOR_TAG_INVALID16;
Laurence Lundblade830fbf92020-05-31 17:22:33 -0700597 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700598}
599
600
601/*
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700602 Public function, see header file
603 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800604void QCBORDecode_SetUpAllocator(QCBORDecodeContext *pMe,
605 QCBORStringAllocate pfAllocateFunction,
606 void *pAllocateContext,
607 bool bAllStrings)
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700608{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800609 pMe->StringAllocator.pfAllocator = pfAllocateFunction;
610 pMe->StringAllocator.pAllocateCxt = pAllocateContext;
611 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700612}
613
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800614
615/*
616 Public function, see header file
617 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700618void QCBORDecode_SetCallerConfiguredTagList(QCBORDecodeContext *pMe,
Laurence Lundbladeee851742020-01-08 08:37:05 -0800619 const QCBORTagListIn *pTagList)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +0700620{
Laurence Lundblade830fbf92020-05-31 17:22:33 -0700621 // This does nothing now. It is retained for backwards compatibility
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700622 (void)pMe;
623 (void)pTagList;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +0700624}
625
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700626
627/*
Laurence Lundbladeee851742020-01-08 08:37:05 -0800628 This decodes the fundamental part of a CBOR data item, the type and
629 number
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800630
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700631 This is the Counterpart to InsertEncodedTypeAndNumber().
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800632
Laurence Lundbladeee851742020-01-08 08:37:05 -0800633 This does the network->host byte order conversion. The conversion
634 here also results in the conversion for floats in addition to that
635 for lengths, tags and integer values.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800636
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700637 This returns:
638 pnMajorType -- the major type for the item
Laurence Lundbladeee851742020-01-08 08:37:05 -0800639
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800640 puArgument -- the "number" which is used a the value for integers,
Laurence Lundbladeee851742020-01-08 08:37:05 -0800641 tags and floats and length for strings and arrays
642
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800643 pnAdditionalInfo -- Pass this along to know what kind of float or
Laurence Lundbladeee851742020-01-08 08:37:05 -0800644 if length is indefinite
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800645
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800646 The int type is preferred to uint8_t for some variables as this
647 avoids integer promotions, can reduce code size and makes
648 static analyzers happier.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700649 */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800650inline static QCBORError DecodeTypeAndNumber(UsefulInputBuf *pUInBuf,
651 int *pnMajorType,
652 uint64_t *puArgument,
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800653 int *pnAdditionalInfo)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700654{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700655 QCBORError nReturn;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800656
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700657 // Get the initial byte that every CBOR data item has
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800658 const int nInitialByte = (int)UsefulInputBuf_GetByte(pUInBuf);
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800659
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700660 // Break down the initial byte
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800661 const int nTmpMajorType = nInitialByte >> 5;
662 const int nAdditionalInfo = nInitialByte & 0x1f;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800663
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800664 // Where the number or argument accumulates
665 uint64_t uArgument;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800666
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800667 if(nAdditionalInfo >= LEN_IS_ONE_BYTE && nAdditionalInfo <= LEN_IS_EIGHT_BYTES) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700668 // Need to get 1,2,4 or 8 additional argument bytes. Map
669 // LEN_IS_ONE_BYTE..LEN_IS_EIGHT_BYTES to actual length
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800670 static const uint8_t aIterate[] = {1,2,4,8};
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800671
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800672 // Loop getting all the bytes in the argument
673 uArgument = 0;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800674 for(int i = aIterate[nAdditionalInfo - LEN_IS_ONE_BYTE]; i; i--) {
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800675 // This shift and add gives the endian conversion
676 uArgument = (uArgument << 8) + UsefulInputBuf_GetByte(pUInBuf);
677 }
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800678 } else if(nAdditionalInfo >= ADDINFO_RESERVED1 && nAdditionalInfo <= ADDINFO_RESERVED3) {
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800679 // The reserved and thus-far unused additional info values
680 nReturn = QCBOR_ERR_UNSUPPORTED;
681 goto Done;
682 } else {
683 // Less than 24, additional info is argument or 31, an indefinite length
684 // No more bytes to get
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800685 uArgument = (uint64_t)nAdditionalInfo;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700686 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800687
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700688 if(UsefulInputBuf_GetError(pUInBuf)) {
689 nReturn = QCBOR_ERR_HIT_END;
690 goto Done;
691 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800692
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700693 // All successful if we got here.
694 nReturn = QCBOR_SUCCESS;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800695 *pnMajorType = nTmpMajorType;
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800696 *puArgument = uArgument;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800697 *pnAdditionalInfo = nAdditionalInfo;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800698
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700699Done:
700 return nReturn;
701}
702
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800703
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700704/*
Laurence Lundbladeee851742020-01-08 08:37:05 -0800705 CBOR doesn't explicitly specify two's compliment for integers but all
706 CPUs use it these days and the test vectors in the RFC are so. All
707 integers in the CBOR structure are positive and the major type
708 indicates positive or negative. CBOR can express positive integers
709 up to 2^x - 1 where x is the number of bits and negative integers
710 down to 2^x. Note that negative numbers can be one more away from
711 zero than positive. Stdint, as far as I can tell, uses two's
712 compliment to represent negative integers.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800713
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700714 See http://www.unix.org/whitepapers/64bit.html for reasons int isn't
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800715 used carefully here, and in particular why it isn't used in the interface.
716 Also see
717 https://stackoverflow.com/questions/17489857/why-is-int-typically-32-bit-on-64-bit-compilers
718
719 Int is used for values that need less than 16-bits and would be subject
720 to integer promotion and complaining by static analyzers.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700721 */
Laurence Lundbladeee851742020-01-08 08:37:05 -0800722inline static QCBORError
723DecodeInteger(int nMajorType, uint64_t uNumber, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700724{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700725 QCBORError nReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800726
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700727 if(nMajorType == CBOR_MAJOR_TYPE_POSITIVE_INT) {
728 if (uNumber <= INT64_MAX) {
729 pDecodedItem->val.int64 = (int64_t)uNumber;
730 pDecodedItem->uDataType = QCBOR_TYPE_INT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800731
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700732 } else {
733 pDecodedItem->val.uint64 = uNumber;
734 pDecodedItem->uDataType = QCBOR_TYPE_UINT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800735
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700736 }
737 } else {
738 if(uNumber <= INT64_MAX) {
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800739 // CBOR's representation of negative numbers lines up with the
740 // two-compliment representation. A negative integer has one
741 // more in range than a positive integer. INT64_MIN is
742 // equal to (-INT64_MAX) - 1.
743 pDecodedItem->val.int64 = (-(int64_t)uNumber) - 1;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700744 pDecodedItem->uDataType = QCBOR_TYPE_INT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800745
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700746 } else {
747 // C can't represent a negative integer in this range
Laurence Lundblade21d1d812019-09-28 22:47:49 -1000748 // so it is an error.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700749 nReturn = QCBOR_ERR_INT_OVERFLOW;
750 }
751 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800752
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700753 return nReturn;
754}
755
756// Make sure #define value line up as DecodeSimple counts on this.
757#if QCBOR_TYPE_FALSE != CBOR_SIMPLEV_FALSE
758#error QCBOR_TYPE_FALSE macro value wrong
759#endif
760
761#if QCBOR_TYPE_TRUE != CBOR_SIMPLEV_TRUE
762#error QCBOR_TYPE_TRUE macro value wrong
763#endif
764
765#if QCBOR_TYPE_NULL != CBOR_SIMPLEV_NULL
766#error QCBOR_TYPE_NULL macro value wrong
767#endif
768
769#if QCBOR_TYPE_UNDEF != CBOR_SIMPLEV_UNDEF
770#error QCBOR_TYPE_UNDEF macro value wrong
771#endif
772
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700773#if QCBOR_TYPE_BREAK != CBOR_SIMPLE_BREAK
774#error QCBOR_TYPE_BREAK macro value wrong
775#endif
776
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700777#if QCBOR_TYPE_DOUBLE != DOUBLE_PREC_FLOAT
778#error QCBOR_TYPE_DOUBLE macro value wrong
779#endif
780
781#if QCBOR_TYPE_FLOAT != SINGLE_PREC_FLOAT
782#error QCBOR_TYPE_FLOAT macro value wrong
783#endif
784
785/*
786 Decode true, false, floats, break...
787 */
Laurence Lundbladeee851742020-01-08 08:37:05 -0800788inline static QCBORError
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800789DecodeSimple(int nAdditionalInfo, uint64_t uNumber, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700790{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700791 QCBORError nReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800792
Laurence Lundbladeee851742020-01-08 08:37:05 -0800793 // uAdditionalInfo is 5 bits from the initial byte compile time checks
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800794 // above make sure uAdditionalInfo values line up with uDataType values.
795 // DecodeTypeAndNumber never returns a major type > 1f so cast is safe
796 pDecodedItem->uDataType = (uint8_t)nAdditionalInfo;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800797
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800798 switch(nAdditionalInfo) {
Laurence Lundbladeee851742020-01-08 08:37:05 -0800799 // No check for ADDINFO_RESERVED1 - ADDINFO_RESERVED3 as they are
800 // caught before this is called.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800801
Laurence Lundbladecc2ed342018-09-22 17:29:55 -0700802 case HALF_PREC_FLOAT:
Laurence Lundbladeb275cdc2020-07-12 12:34:38 -0700803#ifndef QCBOR_DISABLE_PREFERRED_FLOAT
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700804 // Half-precision is returned as a double.
Laurence Lundblade3ed0bca2020-07-14 22:50:10 -0700805 // The cast to uint16_t is safe because the encoded value
Laurence Lundblade9682a532020-06-06 18:33:04 -0700806 // was 16 bits. It was widened to 64 bits to be passed in here.
Laurence Lundblade67bd5512018-11-02 21:44:06 +0700807 pDecodedItem->val.dfnum = IEEE754_HalfToDouble((uint16_t)uNumber);
808 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundblade9682a532020-06-06 18:33:04 -0700809#else
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700810 nReturn = QCBOR_ERR_HALF_PRECISION_DISABLED;
Laurence Lundblade9682a532020-06-06 18:33:04 -0700811#endif
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700812 break;
Laurence Lundbladecc2ed342018-09-22 17:29:55 -0700813 case SINGLE_PREC_FLOAT:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700814 // Single precision is normally returned as a double
815 // since double is widely supported, there is no loss of
816 // precision, it makes it easy for the caller in
817 // most cases and it can be converted back to single
818 // with no loss of precision
819 //
Laurence Lundblade3ed0bca2020-07-14 22:50:10 -0700820 // The cast to uint32_t is safe because the encoded value
Laurence Lundblade8fa7d5d2020-07-11 16:30:47 -0700821 // was 32 bits. It was widened to 64 bits to be passed in here.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700822 {
823 const float f = UsefulBufUtil_CopyUint32ToFloat((uint32_t)uNumber);
824#ifndef QCBOR_DISABLE_FLOAT_HW_USE
825 // In the normal case, use HW to convert float to double.
826 pDecodedItem->val.dfnum = (double)f;
827 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundblade9682a532020-06-06 18:33:04 -0700828#else
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700829 // Use of float HW is disabled, return as a float.
830 pDecodedItem->val.fnum = f;
831 pDecodedItem->uDataType = QCBOR_TYPE_FLOAT;
832
833 // IEEE754_FloatToDouble() could be used here to return
834 // as a double, but it adds object code and most likely
835 // anyone disabling FLOAT HW use doesn't care about
836 // floats and wants to save object code.
Laurence Lundblade9682a532020-06-06 18:33:04 -0700837#endif
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700838 }
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700839 break;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700840
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700841 case DOUBLE_PREC_FLOAT:
842 pDecodedItem->val.dfnum = UsefulBufUtil_CopyUint64ToDouble(uNumber);
Laurence Lundblade67bd5512018-11-02 21:44:06 +0700843 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700844 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800845
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700846 case CBOR_SIMPLEV_FALSE: // 20
847 case CBOR_SIMPLEV_TRUE: // 21
848 case CBOR_SIMPLEV_NULL: // 22
849 case CBOR_SIMPLEV_UNDEF: // 23
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700850 case CBOR_SIMPLE_BREAK: // 31
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700851 break; // nothing to do
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800852
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700853 case CBOR_SIMPLEV_ONEBYTE: // 24
854 if(uNumber <= CBOR_SIMPLE_BREAK) {
855 // This takes out f8 00 ... f8 1f which should be encoded as e0 … f7
Laurence Lundblade077475f2019-04-26 09:06:33 -0700856 nReturn = QCBOR_ERR_BAD_TYPE_7;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700857 goto Done;
858 }
Laurence Lundblade5e390822019-01-06 12:35:01 -0800859 /* FALLTHROUGH */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700860 // fall through intentionally
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800861
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700862 default: // 0-19
863 pDecodedItem->uDataType = QCBOR_TYPE_UKNOWN_SIMPLE;
Laurence Lundbladeee851742020-01-08 08:37:05 -0800864 /*
865 DecodeTypeAndNumber will make uNumber equal to
866 uAdditionalInfo when uAdditionalInfo is < 24 This cast is
867 safe because the 2, 4 and 8 byte lengths of uNumber are in
868 the double/float cases above
869 */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700870 pDecodedItem->val.uSimple = (uint8_t)uNumber;
871 break;
872 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800873
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700874Done:
875 return nReturn;
876}
877
878
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700879/*
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530880 Decode text and byte strings. Call the string allocator if asked to.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700881 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800882inline static QCBORError DecodeBytes(const QCORInternalAllocator *pAllocator,
883 int nMajorType,
884 uint64_t uStrLen,
885 UsefulInputBuf *pUInBuf,
886 QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700887{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700888 QCBORError nReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800889
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800890 // CBOR lengths can be 64 bits, but size_t is not 64 bits on all CPUs.
891 // This check makes the casts to size_t below safe.
892
893 // 4 bytes less than the largest sizeof() so this can be tested by
894 // putting a SIZE_MAX length in the CBOR test input (no one will
895 // care the limit on strings is 4 bytes shorter).
896 if(uStrLen > SIZE_MAX-4) {
897 nReturn = QCBOR_ERR_STRING_TOO_LONG;
898 goto Done;
899 }
900
901 const UsefulBufC Bytes = UsefulInputBuf_GetUsefulBuf(pUInBuf, (size_t)uStrLen);
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530902 if(UsefulBuf_IsNULLC(Bytes)) {
903 // Failed to get the bytes for this string item
904 nReturn = QCBOR_ERR_HIT_END;
905 goto Done;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700906 }
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530907
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800908 if(pAllocator) {
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530909 // We are asked to use string allocator to make a copy
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800910 UsefulBuf NewMem = StringAllocator_Allocate(pAllocator, (size_t)uStrLen);
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530911 if(UsefulBuf_IsNULL(NewMem)) {
Laurence Lundblade30816f22018-11-10 13:40:22 +0700912 nReturn = QCBOR_ERR_STRING_ALLOCATE;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530913 goto Done;
914 }
915 pDecodedItem->val.string = UsefulBuf_Copy(NewMem, Bytes);
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800916 pDecodedItem->uDataAlloc = 1;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530917 } else {
918 // Normal case with no string allocator
919 pDecodedItem->val.string = Bytes;
920 }
Laurence Lundbladeee851742020-01-08 08:37:05 -0800921 const bool bIsBstr = (nMajorType == CBOR_MAJOR_TYPE_BYTE_STRING);
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800922 // Cast because ternary operator causes promotion to integer
923 pDecodedItem->uDataType = (uint8_t)(bIsBstr ? QCBOR_TYPE_BYTE_STRING
924 : QCBOR_TYPE_TEXT_STRING);
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800925
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530926Done:
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700927 return nReturn;
928}
929
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700930
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800931
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700932
933
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700934
935
Laurence Lundbladeee851742020-01-08 08:37:05 -0800936// Make sure the constants align as this is assumed by
937// the GetAnItem() implementation
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700938#if QCBOR_TYPE_ARRAY != CBOR_MAJOR_TYPE_ARRAY
939#error QCBOR_TYPE_ARRAY value not lined up with major type
940#endif
941#if QCBOR_TYPE_MAP != CBOR_MAJOR_TYPE_MAP
942#error QCBOR_TYPE_MAP value not lined up with major type
943#endif
944
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700945/*
Laurence Lundbladeee851742020-01-08 08:37:05 -0800946 This gets a single data item and decodes it including preceding
947 optional tagging. This does not deal with arrays and maps and nesting
948 except to decode the data item introducing them. Arrays and maps are
949 handled at the next level up in GetNext().
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800950
Laurence Lundbladeee851742020-01-08 08:37:05 -0800951 Errors detected here include: an array that is too long to decode,
952 hit end of buffer unexpectedly, a few forms of invalid encoded CBOR
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700953 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800954static QCBORError GetNext_Item(UsefulInputBuf *pUInBuf,
955 QCBORItem *pDecodedItem,
956 const QCORInternalAllocator *pAllocator)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700957{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700958 QCBORError nReturn;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800959
Laurence Lundbladeee851742020-01-08 08:37:05 -0800960 /*
961 Get the major type and the number. Number could be length of more
962 bytes or the value depending on the major type nAdditionalInfo is
963 an encoding of the length of the uNumber and is needed to decode
964 floats and doubles
965 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800966 int nMajorType;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700967 uint64_t uNumber;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800968 int nAdditionalInfo;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800969
Laurence Lundblade4b09f632019-10-09 14:34:59 -0700970 memset(pDecodedItem, 0, sizeof(QCBORItem));
971
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800972 nReturn = DecodeTypeAndNumber(pUInBuf, &nMajorType, &uNumber, &nAdditionalInfo);
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800973
Laurence Lundbladeee851742020-01-08 08:37:05 -0800974 // Error out here if we got into trouble on the type and number. The
975 // code after this will not work if the type and number is not good.
Laurence Lundblade3a6042e2019-06-28 19:58:04 -0700976 if(nReturn) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700977 goto Done;
Laurence Lundblade3a6042e2019-06-28 19:58:04 -0700978 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800979
Laurence Lundbladeee851742020-01-08 08:37:05 -0800980 // At this point the major type and the value are valid. We've got
981 // the type and the number that starts every CBOR data item.
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800982 switch (nMajorType) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700983 case CBOR_MAJOR_TYPE_POSITIVE_INT: // Major type 0
984 case CBOR_MAJOR_TYPE_NEGATIVE_INT: // Major type 1
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800985 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
Laurence Lundblade3a6042e2019-06-28 19:58:04 -0700986 nReturn = QCBOR_ERR_BAD_INT;
987 } else {
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800988 nReturn = DecodeInteger(nMajorType, uNumber, pDecodedItem);
Laurence Lundblade3a6042e2019-06-28 19:58:04 -0700989 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700990 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800991
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700992 case CBOR_MAJOR_TYPE_BYTE_STRING: // Major type 2
993 case CBOR_MAJOR_TYPE_TEXT_STRING: // Major type 3
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800994 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
995 const bool bIsBstr = (nMajorType == CBOR_MAJOR_TYPE_BYTE_STRING);
996 pDecodedItem->uDataType = (uint8_t)(bIsBstr ? QCBOR_TYPE_BYTE_STRING
997 : QCBOR_TYPE_TEXT_STRING);
Laurence Lundbladea44d5062018-10-17 18:45:12 +0530998 pDecodedItem->val.string = (UsefulBufC){NULL, SIZE_MAX};
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700999 } else {
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001000 nReturn = DecodeBytes(pAllocator, nMajorType, uNumber, pUInBuf, pDecodedItem);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001001 }
1002 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001003
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001004 case CBOR_MAJOR_TYPE_ARRAY: // Major type 4
1005 case CBOR_MAJOR_TYPE_MAP: // Major type 5
1006 // Record the number of items in the array or map
1007 if(uNumber > QCBOR_MAX_ITEMS_IN_ARRAY) {
1008 nReturn = QCBOR_ERR_ARRAY_TOO_LONG;
1009 goto Done;
1010 }
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001011 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001012 pDecodedItem->val.uCount = QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001013 } else {
Laurence Lundbladeee851742020-01-08 08:37:05 -08001014 // type conversion OK because of check above
1015 pDecodedItem->val.uCount = (uint16_t)uNumber;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001016 }
Laurence Lundbladeee851742020-01-08 08:37:05 -08001017 // C preproc #if above makes sure constants for major types align
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001018 // DecodeTypeAndNumber never returns a major type > 7 so cast is safe
1019 pDecodedItem->uDataType = (uint8_t)nMajorType;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001020 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001021
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001022 case CBOR_MAJOR_TYPE_OPTIONAL: // Major type 6, optional prepended tags
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001023 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001024 nReturn = QCBOR_ERR_BAD_INT;
1025 } else {
1026 pDecodedItem->val.uTagV = uNumber;
1027 pDecodedItem->uDataType = QCBOR_TYPE_OPTTAG;
1028 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001029 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001030
Laurence Lundbladeee851742020-01-08 08:37:05 -08001031 case CBOR_MAJOR_TYPE_SIMPLE:
1032 // Major type 7, float, double, true, false, null...
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001033 nReturn = DecodeSimple(nAdditionalInfo, uNumber, pDecodedItem);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001034 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001035
Laurence Lundbladeee851742020-01-08 08:37:05 -08001036 default:
1037 // Never happens because DecodeTypeAndNumber() should never return > 7
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001038 nReturn = QCBOR_ERR_UNSUPPORTED;
1039 break;
1040 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001041
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001042Done:
1043 return nReturn;
1044}
1045
1046
1047
1048/*
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001049 This layer deals with indefinite length strings. It pulls all the
Laurence Lundbladeee851742020-01-08 08:37:05 -08001050 individual chunk items together into one QCBORItem using the string
1051 allocator.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001052
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301053 Code Reviewers: THIS FUNCTION DOES A LITTLE POINTER MATH
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001054 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001055static inline QCBORError
1056GetNext_FullItem(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001057{
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001058 // Stack usage; int/ptr 2 UsefulBuf 2 QCBORItem -- 96
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001059
1060 // Get pointer to string allocator. First use is to pass it to
1061 // GetNext_Item() when option is set to allocate for *every* string.
1062 // Second use here is to allocate space to coallese indefinite
1063 // length string items into one.
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001064 const QCORInternalAllocator *pAllocator = me->StringAllocator.pfAllocator ?
1065 &(me->StringAllocator) :
1066 NULL;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001067
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001068 QCBORError nReturn;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001069 nReturn = GetNext_Item(&(me->InBuf),
1070 pDecodedItem,
1071 me->bStringAllocateAll ? pAllocator: NULL);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001072 if(nReturn) {
1073 goto Done;
1074 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001075
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001076 // To reduce code size by removing support for indefinite length strings, the
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301077 // code in this function from here down can be eliminated. Run tests, except
1078 // indefinite length string tests, to be sure all is OK if this is removed.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001079
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001080 // Only do indefinite length processing on strings
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001081 const uint8_t uStringType = pDecodedItem->uDataType;
1082 if(uStringType!= QCBOR_TYPE_BYTE_STRING && uStringType != QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001083 goto Done; // no need to do any work here on non-string types
1084 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001085
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001086 // Is this a string with an indefinite length?
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301087 if(pDecodedItem->val.string.len != SIZE_MAX) {
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001088 goto Done; // length is not indefinite, so no work to do here
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001089 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001090
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301091 // Can't do indefinite length strings without a string allocator
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001092 if(pAllocator == NULL) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001093 nReturn = QCBOR_ERR_NO_STRING_ALLOCATOR;
1094 goto Done;
1095 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001096
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001097 // Loop getting chunk of indefinite string
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001098 UsefulBufC FullString = NULLUsefulBufC;
1099
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001100 for(;;) {
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001101 // Get item for next chunk
1102 QCBORItem StringChunkItem;
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001103 // NULL string allocator passed here. Do not need to allocate
1104 // chunks even if bStringAllocateAll is set.
Laurence Lundbladefae26bf2019-02-18 11:15:43 -08001105 nReturn = GetNext_Item(&(me->InBuf), &StringChunkItem, NULL);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001106 if(nReturn) {
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001107 break; // Error getting the next chunk
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001108 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001109
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301110 // See if it is a marker at end of indefinite length string
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001111 if(StringChunkItem.uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001112 // String is complete
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001113 pDecodedItem->val.string = FullString;
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301114 pDecodedItem->uDataAlloc = 1;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001115 break;
1116 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001117
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001118 // Match data type of chunk to type at beginning.
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301119 // Also catches error of other non-string types that don't belong.
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001120 // Also catches indefinite length strings inside indefinite length strings
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001121 if(StringChunkItem.uDataType != uStringType ||
1122 StringChunkItem.val.string.len == SIZE_MAX) {
Laurence Lundblade30816f22018-11-10 13:40:22 +07001123 nReturn = QCBOR_ERR_INDEFINITE_STRING_CHUNK;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001124 break;
1125 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001126
Laurence Lundblade471a3fd2018-10-18 21:27:45 +05301127 // Alloc new buffer or expand previously allocated buffer so it can fit
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001128 // The first time throurgh FullString.ptr is NULL and this is
1129 // equivalent to StringAllocator_Allocate()
1130 UsefulBuf NewMem = StringAllocator_Reallocate(pAllocator,
1131 UNCONST_POINTER(FullString.ptr),
1132 FullString.len + StringChunkItem.val.string.len);
1133
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001134 if(UsefulBuf_IsNULL(NewMem)) {
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301135 // Allocation of memory for the string failed
Laurence Lundblade30816f22018-11-10 13:40:22 +07001136 nReturn = QCBOR_ERR_STRING_ALLOCATE;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001137 break;
1138 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001139
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001140 // Copy new string chunk at the end of string so far.
1141 FullString = UsefulBuf_CopyOffset(NewMem, FullString.len, StringChunkItem.val.string);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001142 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001143
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001144 if(nReturn != QCBOR_SUCCESS && !UsefulBuf_IsNULLC(FullString)) {
1145 // Getting the item failed, clean up the allocated memory
1146 StringAllocator_Free(pAllocator, UNCONST_POINTER(FullString.ptr));
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001147 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001148
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001149Done:
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001150 return nReturn;
1151}
1152
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001153
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001154static uint64_t ConvertTag(QCBORDecodeContext *me, uint16_t uTagVal) {
1155 if(uTagVal <= QCBOR_LAST_UNMAPPED_TAG) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001156 return uTagVal;
1157 } else {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001158 int x = uTagVal - (QCBOR_LAST_UNMAPPED_TAG + 1);
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001159 return me->auMappedTags[x];
1160 }
1161}
1162
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001163/*
Laurence Lundblade59289e52019-12-30 13:44:37 -08001164 Gets all optional tag data items preceding a data item that is not an
1165 optional tag and records them as bits in the tag map.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001166 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001167static QCBORError
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001168GetNext_TaggedItem(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001169{
Laurence Lundblade30816f22018-11-10 13:40:22 +07001170 QCBORError nReturn;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001171
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001172 uint16_t auTags[QCBOR_MAX_TAGS_PER_ITEM] = {CBOR_TAG_INVALID16,
1173 CBOR_TAG_INVALID16,
1174 CBOR_TAG_INVALID16,
1175 CBOR_TAG_INVALID16};
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001176
Laurence Lundblade59289e52019-12-30 13:44:37 -08001177 // Loop fetching items until the item fetched is not a tag
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001178 for(;;) {
1179 nReturn = GetNext_FullItem(me, pDecodedItem);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001180 if(nReturn) {
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001181 goto Done; // Error out of the loop
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001182 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001183
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001184 if(pDecodedItem->uDataType != QCBOR_TYPE_OPTTAG) {
1185 // Successful exit from loop; maybe got some tags, maybe not
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001186 memcpy(pDecodedItem->uTags, auTags, sizeof(auTags));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001187 break;
1188 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001189
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001190 // Is there room for the tag in the tags list?
1191 size_t uTagIndex;
1192 for(uTagIndex = 0; uTagIndex < QCBOR_MAX_TAGS_PER_ITEM; uTagIndex++) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001193 if(auTags[uTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001194 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001195 }
1196 }
1197 if(uTagIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001198 return QCBOR_ERR_TOO_MANY_TAGS;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001199 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001200
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001201 // Is the tag > 16 bits?
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001202 if(pDecodedItem->val.uTagV > QCBOR_LAST_UNMAPPED_TAG) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001203 size_t uTagMapIndex;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001204 // Is there room in the tag map, or is it in it already?
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001205 for(uTagMapIndex = 0; uTagMapIndex < QCBOR_NUM_MAPPED_TAGS; uTagMapIndex++) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001206 if(me->auMappedTags[uTagMapIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001207 break;
1208 }
1209 if(me->auMappedTags[uTagMapIndex] == pDecodedItem->val.uTagV) {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001210 // TODO: test this
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001211 break;
1212 }
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001213 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001214 if(uTagMapIndex >= QCBOR_NUM_MAPPED_TAGS) {
1215 // No room for the tag
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001216 // Should never happen as long as QCBOR_MAX_TAGS_PER_ITEM <= QCBOR_NUM_MAPPED_TAGS
1217 return QCBOR_ERR_TOO_MANY_TAGS;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001218 }
1219
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001220 // Covers the cases where tag is new and were it is already in the map
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001221 me->auMappedTags[uTagMapIndex] = pDecodedItem->val.uTagV;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001222 auTags[uTagIndex] = (uint16_t)(uTagMapIndex + QCBOR_LAST_UNMAPPED_TAG + 1);
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001223
1224 } else {
1225 auTags[uTagIndex] = (uint16_t)pDecodedItem->val.uTagV;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001226 }
1227 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001228
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001229Done:
1230 return nReturn;
1231}
1232
1233
1234/*
Laurence Lundbladeee851742020-01-08 08:37:05 -08001235 This layer takes care of map entries. It combines the label and data
1236 items into one QCBORItem.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001237 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001238static inline QCBORError
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001239GetNext_MapEntry(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001240{
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001241 // Stack use: int/ptr 1, QCBORItem -- 56
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001242 QCBORError nReturn = GetNext_TaggedItem(me, pDecodedItem);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001243 if(nReturn)
1244 goto Done;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001245
Laurence Lundblade742df4a2018-10-13 20:07:17 +08001246 if(pDecodedItem->uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001247 // Break can't be a map entry
Laurence Lundblade742df4a2018-10-13 20:07:17 +08001248 goto Done;
1249 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001250
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001251 if(me->uDecodeMode != QCBOR_DECODE_MODE_MAP_AS_ARRAY) {
1252 // In a map and caller wants maps decoded, not treated as arrays
1253
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001254 if(DecodeNesting_IsCurrentTypeMap(&(me->nesting))) {
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001255 // If in a map and the right decoding mode, get the label
1256
Laurence Lundbladeee851742020-01-08 08:37:05 -08001257 // Save label in pDecodedItem and get the next which will
1258 // be the real data
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001259 QCBORItem LabelItem = *pDecodedItem;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001260 nReturn = GetNext_TaggedItem(me, pDecodedItem);
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001261 if(nReturn)
1262 goto Done;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001263
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301264 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001265
1266 if(LabelItem.uDataType == QCBOR_TYPE_TEXT_STRING) {
1267 // strings are always good labels
1268 pDecodedItem->label.string = LabelItem.val.string;
1269 pDecodedItem->uLabelType = QCBOR_TYPE_TEXT_STRING;
1270 } else if (QCBOR_DECODE_MODE_MAP_STRINGS_ONLY == me->uDecodeMode) {
Laurence Lundbladeee851742020-01-08 08:37:05 -08001271 // It's not a string and we only want strings
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001272 nReturn = QCBOR_ERR_MAP_LABEL_TYPE;
1273 goto Done;
1274 } else if(LabelItem.uDataType == QCBOR_TYPE_INT64) {
1275 pDecodedItem->label.int64 = LabelItem.val.int64;
1276 pDecodedItem->uLabelType = QCBOR_TYPE_INT64;
1277 } else if(LabelItem.uDataType == QCBOR_TYPE_UINT64) {
1278 pDecodedItem->label.uint64 = LabelItem.val.uint64;
1279 pDecodedItem->uLabelType = QCBOR_TYPE_UINT64;
1280 } else if(LabelItem.uDataType == QCBOR_TYPE_BYTE_STRING) {
1281 pDecodedItem->label.string = LabelItem.val.string;
1282 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
1283 pDecodedItem->uLabelType = QCBOR_TYPE_BYTE_STRING;
1284 } else {
1285 // label is not an int or a string. It is an arrray
1286 // or a float or such and this implementation doesn't handle that.
1287 // Also, tags on labels are ignored.
1288 nReturn = QCBOR_ERR_MAP_LABEL_TYPE;
1289 goto Done;
1290 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001291 }
1292 } else {
1293 if(pDecodedItem->uDataType == QCBOR_TYPE_MAP) {
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001294 if(pDecodedItem->val.uCount > QCBOR_MAX_ITEMS_IN_ARRAY/2) {
1295 nReturn = QCBOR_ERR_ARRAY_TOO_LONG;
1296 goto Done;
1297 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001298 // Decoding a map as an array
1299 pDecodedItem->uDataType = QCBOR_TYPE_MAP_AS_ARRAY;
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001300 // Cast is safe because of check against QCBOR_MAX_ITEMS_IN_ARRAY/2
1301 // Cast is needed because of integer promotion
1302 pDecodedItem->val.uCount = (uint16_t)(pDecodedItem->val.uCount * 2);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001303 }
1304 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001305
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001306Done:
1307 return nReturn;
1308}
1309
1310
Laurence Lundblade02625d42020-06-25 14:41:41 -07001311/*
1312 See if next item is a CBOR break. If it is, it is consumed,
1313 if not it is not consumed.
1314*/
Laurence Lundblade642282a2020-06-23 12:00:33 -07001315static inline QCBORError
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001316NextIsBreak(UsefulInputBuf *pUIB, bool *pbNextIsBreak)
1317{
1318 *pbNextIsBreak = false;
1319 if(UsefulInputBuf_BytesUnconsumed(pUIB) != 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001320 QCBORItem Peek;
1321 size_t uPeek = UsefulInputBuf_Tell(pUIB);
1322 QCBORError uReturn = GetNext_Item(pUIB, &Peek, NULL);
1323 if(uReturn != QCBOR_SUCCESS) {
1324 return uReturn;
1325 }
1326 if(Peek.uDataType != QCBOR_TYPE_BREAK) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001327 // It is not a break, rewind so it can be processed normally.
1328 UsefulInputBuf_Seek(pUIB, uPeek);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001329 } else {
1330 *pbNextIsBreak = true;
1331 }
1332 }
1333
1334 return QCBOR_SUCCESS;
1335}
1336
1337
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001338/*
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001339 An item was just consumed, now figure out if it was the
1340 end of an array or map that can be closed out. That
1341 may in turn close out another map or array.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001342*/
Laurence Lundbladed0304932020-06-27 10:59:38 -07001343static QCBORError NestLevelAscender(QCBORDecodeContext *pMe, bool bMarkEnd)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001344{
1345 QCBORError uReturn;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001346
Laurence Lundblade642282a2020-06-23 12:00:33 -07001347 /* This loops ascending nesting levels as long as there is ascending to do */
1348 while(!DecodeNesting_IsCurrentAtTop(&(pMe->nesting))) {
1349
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001350 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001351 /* Decrement count for definite length maps / arrays */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001352 DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(&(pMe->nesting));
1353 if(!DecodeNesting_IsEndOfDefiniteLengthMapOrArray(&(pMe->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001354 /* Didn't close out map or array, so all work here is done */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001355 break;
1356 }
Laurence Lundblade02625d42020-06-25 14:41:41 -07001357 /* All of a definite length array was consumed; fall through to ascend */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001358
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001359 } else {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001360 /* If not definite length, have to check for a CBOR break */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001361 bool bIsBreak = false;
1362 uReturn = NextIsBreak(&(pMe->InBuf), &bIsBreak);
1363 if(uReturn != QCBOR_SUCCESS) {
1364 goto Done;
1365 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001366
1367 if(!bIsBreak) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001368 /* It's not a break so nothing closes out and all work is done */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001369 break;
1370 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001371
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001372 if(DecodeNesting_IsCurrentBstrWrapped(&(pMe->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001373 /*
1374 Break occurred inside a bstr-wrapped CBOR or
1375 in the top level sequence. This is always an
1376 error because neither are an indefinte length
1377 map/array.
1378 */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001379 uReturn = QCBOR_ERR_BAD_BREAK;
1380 goto Done;
1381 }
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07001382
Laurence Lundblade02625d42020-06-25 14:41:41 -07001383 /* It was a break in an indefinite length map / array */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001384 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001385
Laurence Lundblade02625d42020-06-25 14:41:41 -07001386 /* All items in the map/array level have been consumed. */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001387
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001388 /* But ascent in bounded mode is only by explicit call to QCBORDecode_ExitBoundedMode() */
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07001389 if(DecodeNesting_IsCurrentBounded(&(pMe->nesting))) {
Laurence Lundblade642282a2020-06-23 12:00:33 -07001390 /* Set the count to zero for definite length arrays to indicate cursor is at end of bounded map / array */
Laurence Lundbladed0304932020-06-27 10:59:38 -07001391 if(bMarkEnd) {
1392 // Used for definite and indefinite to signal end
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001393 DecodeNesting_ZeroMapOrArrayCount(&(pMe->nesting));
Laurence Lundbladed0304932020-06-27 10:59:38 -07001394
Laurence Lundblade2c1faf92020-06-26 22:43:56 -07001395 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001396 break;
1397 }
1398
1399 /* Finally, actually ascend one level. */
1400 DecodeNesting_Ascend(&(pMe->nesting));
1401 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001402
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001403 uReturn = QCBOR_SUCCESS;
1404
1405Done:
1406 return uReturn;
1407}
1408
1409
1410/*
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001411 This handles the traversal descending into and asecnding out of maps,
Laurence Lundblade642282a2020-06-23 12:00:33 -07001412 arrays and bstr-wrapped CBOR. It figures out the ends of definite and
1413 indefinte length maps and arrays by looking at the item count or
1414 finding CBOR breaks. It detects the ends of the top-level sequence
1415 and of bstr-wrapped CBOR by byte count.
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001416 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001417static QCBORError
1418QCBORDecode_GetNextMapOrArray(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001419{
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001420 QCBORError uReturn;
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001421 /* ==== First: figure out if at the end of a traversal ==== */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001422
Laurence Lundblade642282a2020-06-23 12:00:33 -07001423 /*
1424 If out of bytes to consume, it is either the end of the top-level
1425 sequence of some bstr-wrapped CBOR that was entered.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07001426
Laurence Lundblade642282a2020-06-23 12:00:33 -07001427 In the case of bstr-wrapped CBOR, the length of the UsefulInputBuf
1428 was set to that of the bstr-wrapped CBOR. When the bstr-wrapped
1429 CBOR is exited, the length is set back to the top-level's length
1430 or to the next highest bstr-wrapped CBOR.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001431 */
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001432 if(UsefulInputBuf_BytesUnconsumed(&(me->InBuf)) == 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001433 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001434 goto Done;
1435 }
Laurence Lundblade937ea812020-05-08 11:38:23 -07001436
Laurence Lundblade642282a2020-06-23 12:00:33 -07001437 /*
1438 Check to see if at the end of a bounded definite length map or
Laurence Lundblade02625d42020-06-25 14:41:41 -07001439 array. The check for the end of an indefinite length array is
1440 later.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07001441 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001442 if(DecodeNesting_IsAtEndOfBoundedLevel(&(me->nesting))) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001443 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07001444 goto Done;
1445 }
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001446
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001447 /* ==== Next: not at the end so get another item ==== */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001448 uReturn = GetNext_MapEntry(me, pDecodedItem);
1449 if(uReturn) {
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001450 goto Done;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001451 }
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301452
Laurence Lundblade642282a2020-06-23 12:00:33 -07001453 /*
1454 Breaks ending arrays/maps are always processed at the end of this
1455 function. They should never show up here.
1456 */
Laurence Lundblade6de37062018-10-15 12:22:42 +05301457 if(pDecodedItem->uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001458 uReturn = QCBOR_ERR_BAD_BREAK;
Laurence Lundblade6de37062018-10-15 12:22:42 +05301459 goto Done;
Laurence Lundblade5b8c5852018-10-14 21:11:42 +05301460 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001461
Laurence Lundblade642282a2020-06-23 12:00:33 -07001462 /*
1463 Record the nesting level for this data item before processing any
1464 of decrementing and descending.
1465 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001466 pDecodedItem->uNestingLevel = DecodeNesting_GetCurrentLevel(&(me->nesting));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001467
Laurence Lundblade642282a2020-06-23 12:00:33 -07001468
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001469 /* ==== Next: Process the item for descent, ascent, decrement... ==== */
Laurence Lundblade02625d42020-06-25 14:41:41 -07001470 if(QCBORItem_IsMapOrArray(pDecodedItem)) {
Laurence Lundblade642282a2020-06-23 12:00:33 -07001471 /*
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001472 If the new item is a map or array, descend.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001473
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001474 Empty indefinite length maps and arrays are descended into, but then ascended out
Laurence Lundblade02625d42020-06-25 14:41:41 -07001475 of in the next chunk of code.
1476
1477 Maps and arrays do count as items in the map/array that
Laurence Lundblade642282a2020-06-23 12:00:33 -07001478 encloses them so a decrement needs to be done for them too, but
1479 that is done only when all the items in them have been
1480 processed, not when they are opened with the exception of an
1481 empty map or array.
1482 */
1483 uReturn = DecodeNesting_DescendMapOrArray(&(me->nesting),
1484 pDecodedItem->uDataType,
1485 pDecodedItem->val.uCount);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001486 if(uReturn != QCBOR_SUCCESS) {
1487 goto Done;
1488 }
Laurence Lundblade5e87da62020-06-07 03:24:28 -07001489 }
1490
Laurence Lundblade02625d42020-06-25 14:41:41 -07001491 if(!QCBORItem_IsMapOrArray(pDecodedItem) ||
1492 QCBORItem_IsEmptyDefiniteLengthMapOrArray(pDecodedItem) ||
1493 QCBORItem_IsIndefiniteLengthMapOrArray(pDecodedItem)) {
Laurence Lundblade642282a2020-06-23 12:00:33 -07001494 /*
1495 The following cases are handled here:
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001496 - A non-aggregate like an integer or string
1497 - An empty definite length map or array
1498 - An indefinite length map or array that might be empty or might not.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001499
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001500 NestLevelAscender() does the work of decrementing the count for an
Laurence Lundblade02625d42020-06-25 14:41:41 -07001501 definite length map/array and break detection for an indefinite
1502 length map/array. If the end of the map/array was reached, then
1503 it ascends nesting levels, possibly all the way to the top level.
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001504 */
Laurence Lundbladed0304932020-06-27 10:59:38 -07001505 uReturn = NestLevelAscender(me, true);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001506 if(uReturn) {
1507 goto Done;
Laurence Lundblade5e87da62020-06-07 03:24:28 -07001508 }
Laurence Lundblade6de37062018-10-15 12:22:42 +05301509 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001510
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001511 /* ==== Last: tell the caller the nest level of the next item ==== */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001512 /*
Laurence Lundblade02625d42020-06-25 14:41:41 -07001513 Tell the caller what level is next. This tells them what
1514 maps/arrays were closed out and makes it possible for them to
1515 reconstruct the tree with just the information returned in
1516 a QCBORItem.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001517 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001518 if(DecodeNesting_IsAtEndOfBoundedLevel(&(me->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001519 /* At end of a bounded map/array; uNextNestLevel 0 to indicate this */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07001520 pDecodedItem->uNextNestLevel = 0;
1521 } else {
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001522 pDecodedItem->uNextNestLevel = DecodeNesting_GetCurrentLevel(&(me->nesting));
Laurence Lundblade9c905e82020-04-25 11:31:38 -07001523 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001524
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001525Done:
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001526 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade642282a2020-06-23 12:00:33 -07001527 /* This sets uDataType and uLabelType to QCBOR_TYPE_NONE */
Laurence Lundbladee9482dd2019-10-11 12:58:46 -07001528 memset(pDecodedItem, 0, sizeof(QCBORItem));
1529 }
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001530 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001531}
1532
1533
Laurence Lundblade59289e52019-12-30 13:44:37 -08001534/*
1535 Mostly just assign the right data type for the date string.
1536 */
1537inline static QCBORError DecodeDateString(QCBORItem *pDecodedItem)
1538{
Laurence Lundblade59289e52019-12-30 13:44:37 -08001539 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1540 return QCBOR_ERR_BAD_OPT_TAG;
1541 }
1542
1543 const UsefulBufC Temp = pDecodedItem->val.string;
1544 pDecodedItem->val.dateString = Temp;
1545 pDecodedItem->uDataType = QCBOR_TYPE_DATE_STRING;
1546 return QCBOR_SUCCESS;
1547}
1548
1549
1550/*
Laurence Lundbladeee851742020-01-08 08:37:05 -08001551 The epoch formatted date. Turns lots of different forms of encoding
1552 date into uniform one
Laurence Lundblade59289e52019-12-30 13:44:37 -08001553 */
Laurence Lundblade06350ea2020-01-27 19:32:40 -08001554static QCBORError DecodeDateEpoch(QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08001555{
Laurence Lundbladec7114722020-08-13 05:11:40 -07001556 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001557
1558 pDecodedItem->val.epochDate.fSecondsFraction = 0;
1559
1560 switch (pDecodedItem->uDataType) {
1561
1562 case QCBOR_TYPE_INT64:
1563 pDecodedItem->val.epochDate.nSeconds = pDecodedItem->val.int64;
1564 break;
1565
1566 case QCBOR_TYPE_UINT64:
Laurence Lundbladec7114722020-08-13 05:11:40 -07001567 // This only happens for CBOR type 0 > INT64_MAX so it is
1568 // always an overflow.
1569 uReturn = QCBOR_ERR_DATE_OVERFLOW;
1570 goto Done;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001571 break;
1572
1573 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade9682a532020-06-06 18:33:04 -07001574 case QCBOR_TYPE_FLOAT:
1575#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade59289e52019-12-30 13:44:37 -08001576 {
1577 // This comparison needs to be done as a float before
Laurence Lundblade7b5a3b62020-07-22 10:17:16 -07001578 // conversion to an int64_t to be able to detect doubles that
1579 // are too large to fit into an int64_t. A double has 52
1580 // bits of preceision. An int64_t has 63. Casting INT64_MAX
1581 // to a double actually causes a round up which is bad and
1582 // wrong for the comparison because it will allow conversion
1583 // of doubles that can't fit into a uint64_t. To remedy this
1584 // INT64_MAX - 0x7ff is used as the cutoff point because if
1585 // that value rounds up in conversion to double it will still
1586 // be less than INT64_MAX. 0x7ff is picked because it has 11
1587 // bits set.
Laurence Lundblade59289e52019-12-30 13:44:37 -08001588 //
Laurence Lundblade7b5a3b62020-07-22 10:17:16 -07001589 // INT64_MAX seconds is on the order of 10 billion years, and
1590 // the earth is less than 5 billion years old, so for most
1591 // uses this conversion error won't occur even though doubles
1592 // can go much larger.
Laurence Lundblade59289e52019-12-30 13:44:37 -08001593 //
1594 // Without the 0x7ff there is a ~30 minute range of time
1595 // values 10 billion years in the past and in the future
Laurence Lundbladec7114722020-08-13 05:11:40 -07001596 // where this code would go wrong. Some compilers
1597 // will generate warnings or errors without the 0x7ff
1598 // because of the precision issue.
Laurence Lundblade3ed0bca2020-07-14 22:50:10 -07001599 const double d = pDecodedItem->uDataType == QCBOR_TYPE_DOUBLE ?
1600 pDecodedItem->val.dfnum :
1601 (double)pDecodedItem->val.fnum;
Laurence Lundbladec7114722020-08-13 05:11:40 -07001602 if(isnan(d) ||
1603 d > (double)(INT64_MAX - 0x7ff) ||
1604 d < (double)(INT64_MIN + 0x7ff)) {
1605 uReturn = QCBOR_ERR_DATE_OVERFLOW;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001606 goto Done;
1607 }
1608 pDecodedItem->val.epochDate.nSeconds = (int64_t)d;
Laurence Lundblade2feb1e12020-07-15 03:50:45 -07001609 pDecodedItem->val.epochDate.fSecondsFraction =
1610 d - (double)pDecodedItem->val.epochDate.nSeconds;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001611 }
Laurence Lundblade9682a532020-06-06 18:33:04 -07001612#else
Laurence Lundbladec7114722020-08-13 05:11:40 -07001613 /* Disabling float support causes a floating-point
1614 date to error in the default below. The above code
1615 requires floating-point conversion to integers and
1616 comparison which requires either floating-point HW
Laurence Lundblade9682a532020-06-06 18:33:04 -07001617 or a SW library. */
Laurence Lundbladec7114722020-08-13 05:11:40 -07001618 uReturn = QCBOR_ERR_FLOAT_DATE_DISABLED;
Laurence Lundblade9682a532020-06-06 18:33:04 -07001619#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade59289e52019-12-30 13:44:37 -08001620 break;
1621
1622 default:
Laurence Lundbladec7114722020-08-13 05:11:40 -07001623 uReturn = QCBOR_ERR_BAD_OPT_TAG;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001624 goto Done;
1625 }
1626 pDecodedItem->uDataType = QCBOR_TYPE_DATE_EPOCH;
1627
1628Done:
Laurence Lundbladec7114722020-08-13 05:11:40 -07001629 return uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001630}
1631
1632
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001633/*
1634 Mostly just assign the right data type for the bignum.
1635 */
1636inline static QCBORError DecodeBigNum(QCBORItem *pDecodedItem)
1637{
1638 // Stack Use: UsefulBuf 1 -- 16
1639 if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1640 return QCBOR_ERR_BAD_OPT_TAG;
1641 }
1642 const UsefulBufC Temp = pDecodedItem->val.string;
1643 pDecodedItem->val.bigNum = Temp;
1644 const bool bIsPosBigNum = (bool)(pDecodedItem->uTags[0] == CBOR_TAG_POS_BIGNUM);
1645 pDecodedItem->uDataType = (uint8_t)(bIsPosBigNum ? QCBOR_TYPE_POSBIGNUM
1646 : QCBOR_TYPE_NEGBIGNUM);
1647 return QCBOR_SUCCESS;
1648}
1649
1650
Laurence Lundblade59289e52019-12-30 13:44:37 -08001651#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
1652/*
1653 Decode decimal fractions and big floats.
1654
1655 When called pDecodedItem must be the array that is tagged as a big
1656 float or decimal fraction, the array that has the two members, the
1657 exponent and mantissa.
1658
1659 This will fetch and decode the exponent and mantissa and put the
1660 result back into pDecodedItem.
1661 */
1662inline static QCBORError
1663QCBORDecode_MantissaAndExponent(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
1664{
1665 QCBORError nReturn;
1666
1667 // --- Make sure it is an array; track nesting level of members ---
1668 if(pDecodedItem->uDataType != QCBOR_TYPE_ARRAY) {
1669 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1670 goto Done;
1671 }
1672
1673 // A check for pDecodedItem->val.uCount == 2 would work for
Laurence Lundbladeee851742020-01-08 08:37:05 -08001674 // definite length arrays, but not for indefnite. Instead remember
1675 // the nesting level the two integers must be at, which is one
1676 // deeper than that of the array.
Laurence Lundblade59289e52019-12-30 13:44:37 -08001677 const int nNestLevel = pDecodedItem->uNestingLevel + 1;
1678
1679 // --- Is it a decimal fraction or a bigfloat? ---
1680 const bool bIsTaggedDecimalFraction = QCBORDecode_IsTagged(me, pDecodedItem, CBOR_TAG_DECIMAL_FRACTION);
1681 pDecodedItem->uDataType = bIsTaggedDecimalFraction ? QCBOR_TYPE_DECIMAL_FRACTION : QCBOR_TYPE_BIGFLOAT;
1682
1683 // --- Get the exponent ---
1684 QCBORItem exponentItem;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001685 nReturn = QCBORDecode_GetNextMapOrArray(me, &exponentItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08001686 if(nReturn != QCBOR_SUCCESS) {
1687 goto Done;
1688 }
1689 if(exponentItem.uNestingLevel != nNestLevel) {
1690 // Array is empty or a map/array encountered when expecting an int
1691 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1692 goto Done;
1693 }
1694 if(exponentItem.uDataType == QCBOR_TYPE_INT64) {
1695 // Data arriving as an unsigned int < INT64_MAX has been converted
1696 // to QCBOR_TYPE_INT64 and thus handled here. This is also means
1697 // that the only data arriving here of type QCBOR_TYPE_UINT64 data
1698 // will be too large for this to handle and thus an error that will
1699 // get handled in the next else.
1700 pDecodedItem->val.expAndMantissa.nExponent = exponentItem.val.int64;
1701 } else {
1702 // Wrong type of exponent or a QCBOR_TYPE_UINT64 > INT64_MAX
1703 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1704 goto Done;
1705 }
1706
1707 // --- Get the mantissa ---
1708 QCBORItem mantissaItem;
1709 nReturn = QCBORDecode_GetNextWithTags(me, &mantissaItem, NULL);
1710 if(nReturn != QCBOR_SUCCESS) {
1711 goto Done;
1712 }
1713 if(mantissaItem.uNestingLevel != nNestLevel) {
1714 // Mantissa missing or map/array encountered when expecting number
1715 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1716 goto Done;
1717 }
1718 if(mantissaItem.uDataType == QCBOR_TYPE_INT64) {
1719 // Data arriving as an unsigned int < INT64_MAX has been converted
1720 // to QCBOR_TYPE_INT64 and thus handled here. This is also means
1721 // that the only data arriving here of type QCBOR_TYPE_UINT64 data
1722 // will be too large for this to handle and thus an error that
1723 // will get handled in an else below.
1724 pDecodedItem->val.expAndMantissa.Mantissa.nInt = mantissaItem.val.int64;
1725 } else if(mantissaItem.uDataType == QCBOR_TYPE_POSBIGNUM || mantissaItem.uDataType == QCBOR_TYPE_NEGBIGNUM) {
1726 // Got a good big num mantissa
1727 pDecodedItem->val.expAndMantissa.Mantissa.bigNum = mantissaItem.val.bigNum;
1728 // Depends on numbering of QCBOR_TYPE_XXX
Laurence Lundblade06350ea2020-01-27 19:32:40 -08001729 pDecodedItem->uDataType = (uint8_t)(pDecodedItem->uDataType +
1730 mantissaItem.uDataType - QCBOR_TYPE_POSBIGNUM +
1731 1);
Laurence Lundblade59289e52019-12-30 13:44:37 -08001732 } else {
1733 // Wrong type of mantissa or a QCBOR_TYPE_UINT64 > INT64_MAX
1734 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1735 goto Done;
1736 }
1737
1738 // --- Check that array only has the two numbers ---
1739 if(mantissaItem.uNextNestLevel == nNestLevel) {
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07001740 // Extra items in the decimal fraction / big float
Laurence Lundblade59289e52019-12-30 13:44:37 -08001741 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1742 goto Done;
1743 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07001744 pDecodedItem->uNextNestLevel = mantissaItem.uNextNestLevel; // TODO: make sure this is right
Laurence Lundblade59289e52019-12-30 13:44:37 -08001745
1746Done:
Laurence Lundblade59289e52019-12-30 13:44:37 -08001747 return nReturn;
1748}
1749#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
1750
1751
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001752inline static QCBORError DecodeURI(QCBORItem *pDecodedItem)
1753{
1754 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1755 return QCBOR_ERR_BAD_OPT_TAG;
1756 }
1757 pDecodedItem->uDataType = QCBOR_TYPE_URI;
1758 return QCBOR_SUCCESS;
1759}
1760
1761
1762inline static QCBORError DecodeB64URL(QCBORItem *pDecodedItem)
1763{
1764 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1765 return QCBOR_ERR_BAD_OPT_TAG;
1766 }
1767 pDecodedItem->uDataType = QCBOR_TYPE_BASE64URL;
1768 return QCBOR_SUCCESS;
1769}
1770
1771
1772inline static QCBORError DecodeB64(QCBORItem *pDecodedItem)
1773{
1774 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1775 return QCBOR_ERR_BAD_OPT_TAG;
1776 }
1777 pDecodedItem->uDataType = QCBOR_TYPE_BASE64;
1778 return QCBOR_SUCCESS;
1779}
1780
1781
1782inline static QCBORError DecodeRegex(QCBORItem *pDecodedItem)
1783{
1784 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1785 return QCBOR_ERR_BAD_OPT_TAG;
1786 }
1787 pDecodedItem->uDataType = QCBOR_TYPE_REGEX;
1788 return QCBOR_SUCCESS;
1789}
1790
Laurence Lundblade4a21be12020-08-05 12:48:33 -07001791
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07001792inline static QCBORError DecodeWrappedCBOR(QCBORItem *pDecodedItem)
1793{
1794 if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1795 return QCBOR_ERR_BAD_OPT_TAG;
1796 }
1797 pDecodedItem->uDataType = QBCOR_TYPE_WRAPPED_CBOR;
1798 return QCBOR_SUCCESS;
1799}
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001800
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07001801
1802inline static QCBORError DecodeWrappedCBORSequence(QCBORItem *pDecodedItem)
1803{
1804 if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1805 return QCBOR_ERR_BAD_OPT_TAG;
1806 }
1807 pDecodedItem->uDataType = QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE;
1808 return QCBOR_SUCCESS;
1809}
1810
Laurence Lundblade4a21be12020-08-05 12:48:33 -07001811
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001812inline static QCBORError DecodeMIME(QCBORItem *pDecodedItem)
1813{
1814 if(pDecodedItem->uDataType == QCBOR_TYPE_TEXT_STRING) {
1815 pDecodedItem->uDataType = QCBOR_TYPE_MIME;
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07001816 } else if(pDecodedItem->uDataType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001817 pDecodedItem->uDataType = QCBOR_TYPE_BINARY_MIME;
1818 } else {
1819 return QCBOR_ERR_BAD_OPT_TAG;
1820 }
1821 return QCBOR_SUCCESS;
1822}
1823
1824
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001825inline static QCBORError DecodeUUID(QCBORItem *pDecodedItem)
1826{
1827 if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1828 return QCBOR_ERR_BAD_OPT_TAG;
1829 }
1830 pDecodedItem->uDataType = QCBOR_TYPE_UUID;
1831 return QCBOR_SUCCESS;
1832}
1833
1834
Laurence Lundblade59289e52019-12-30 13:44:37 -08001835/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08001836 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade59289e52019-12-30 13:44:37 -08001837 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001838QCBORError
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001839QCBORDecode_GetNext(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08001840{
1841 QCBORError nReturn;
1842
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001843 nReturn = QCBORDecode_GetNextMapOrArray(me, pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08001844 if(nReturn != QCBOR_SUCCESS) {
1845 goto Done;
1846 }
1847
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001848 for(int i = 0; i < QCBOR_MAX_TAGS_PER_ITEM; i++) {
1849 switch(pDecodedItem->uTags[i] ) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08001850
Laurence Lundblade4a21be12020-08-05 12:48:33 -07001851 // Many of the functions here only just map a CBOR tag to
1852 // a QCBOR_TYPE for a string and could probably be
1853 // implemented with less object code. This implementation
1854 // of string types takes about 120 bytes of object code
1855 // (that is always linked and not removed by dead stripping).
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001856 case CBOR_TAG_DATE_STRING:
Laurence Lundblade59289e52019-12-30 13:44:37 -08001857 nReturn = DecodeDateString(pDecodedItem);
1858 break;
1859
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001860 case CBOR_TAG_DATE_EPOCH:
Laurence Lundblade59289e52019-12-30 13:44:37 -08001861 nReturn = DecodeDateEpoch(pDecodedItem);
1862 break;
1863
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001864 case CBOR_TAG_POS_BIGNUM:
1865 case CBOR_TAG_NEG_BIGNUM:
Laurence Lundblade59289e52019-12-30 13:44:37 -08001866 nReturn = DecodeBigNum(pDecodedItem);
1867 break;
1868
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001869 #ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
1870 case CBOR_TAG_DECIMAL_FRACTION:
1871 case CBOR_TAG_BIGFLOAT:
Laurence Lundblade59289e52019-12-30 13:44:37 -08001872 // For aggregate tagged types, what goes into pTags is only collected
1873 // from the surrounding data item, not the contents, so pTags is not
1874 // passed on here.
1875
1876 nReturn = QCBORDecode_MantissaAndExponent(me, pDecodedItem);
1877 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001878 #endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade59289e52019-12-30 13:44:37 -08001879
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07001880 case CBOR_TAG_CBOR:
1881 nReturn = DecodeWrappedCBOR(pDecodedItem);
1882 break;
1883
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07001884 case CBOR_TAG_CBOR_SEQUENCE:
1885 nReturn = DecodeWrappedCBORSequence(pDecodedItem);
1886 break;
1887
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001888 case CBOR_TAG_URI:
1889 nReturn = DecodeURI(pDecodedItem);
1890 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001891
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001892 case CBOR_TAG_B64URL:
1893 nReturn = DecodeB64URL(pDecodedItem);
1894 break;
1895
1896 case CBOR_TAG_B64:
1897 nReturn = DecodeB64(pDecodedItem);
1898 break;
1899
1900 case CBOR_TAG_MIME:
1901 case CBOR_TAG_BINARY_MIME:
1902 nReturn = DecodeMIME(pDecodedItem);
1903 break;
1904
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001905 case CBOR_TAG_REGEX:
1906 nReturn = DecodeRegex(pDecodedItem);
1907 break;
1908
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001909 case CBOR_TAG_BIN_UUID:
1910 nReturn = DecodeUUID(pDecodedItem);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001911 break;
1912
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001913 case CBOR_TAG_INVALID16:
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001914 // The end of the tag list or no tags
1915 // Successful exit from the loop.
1916 goto Done;
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001917
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001918 default:
1919 // A tag that is not understood
1920 // A successful exit from the loop
1921 goto Done;
1922
1923 }
1924 if(nReturn != QCBOR_SUCCESS) {
1925 goto Done;
1926 }
Laurence Lundblade59289e52019-12-30 13:44:37 -08001927 }
1928
1929Done:
1930 if(nReturn != QCBOR_SUCCESS) {
1931 pDecodedItem->uDataType = QCBOR_TYPE_NONE;
1932 pDecodedItem->uLabelType = QCBOR_TYPE_NONE;
1933 }
1934 return nReturn;
1935}
1936
1937
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001938QCBORError QCBORDecode_PeekNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
1939{
1940 const size_t uOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
1941
1942 QCBORError uErr = QCBORDecode_GetNext(pMe, pDecodedItem);
1943
1944 UsefulInputBuf_Seek(&(pMe->InBuf), uOffset);
Laurence Lundblade78f7b932020-07-28 20:02:25 -07001945 // TODO: undo the level tracking (or don't do it)
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001946
1947 return uErr;
1948}
1949
1950
Laurence Lundblade59289e52019-12-30 13:44:37 -08001951/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08001952 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade59289e52019-12-30 13:44:37 -08001953 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001954QCBORError
1955QCBORDecode_GetNextWithTags(QCBORDecodeContext *me,
1956 QCBORItem *pDecodedItem,
1957 QCBORTagListOut *pTags)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001958{
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001959 QCBORError nReturn;
1960
1961 nReturn = QCBORDecode_GetNext(me, pDecodedItem);
1962 if(nReturn != QCBOR_SUCCESS) {
1963 return nReturn;
1964 }
1965
1966 if(pTags != NULL) {
1967 pTags->uNumUsed = 0;
1968 for(int i = 0; i < QCBOR_MAX_TAGS_PER_ITEM; i++) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001969 if(pDecodedItem->uTags[i] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001970 break;
1971 }
1972 if(pTags->uNumUsed >= pTags->uNumAllocated) {
1973 return QCBOR_ERR_TOO_MANY_TAGS;
1974 }
1975 pTags->puTags[pTags->uNumUsed] = ConvertTag(me, pDecodedItem->uTags[i]);
1976 pTags->uNumUsed++;
1977 }
1978 }
1979
1980 return QCBOR_SUCCESS;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001981}
1982
1983
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001984/*
Laurence Lundblade6de37062018-10-15 12:22:42 +05301985 Decoding items is done in 5 layered functions, one calling the
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05301986 next one down. If a layer has no work to do for a particular item
1987 it returns quickly.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001988
Laurence Lundblade59289e52019-12-30 13:44:37 -08001989 - QCBORDecode_GetNext, GetNextWithTags -- The top layer processes
1990 tagged data items, turning them into the local C representation.
1991 For the most simple it is just associating a QCBOR_TYPE with the data. For
1992 the complex ones that an aggregate of data items, there is some further
1993 decoding and a little bit of recursion.
1994
1995 - QCBORDecode_GetNextMapOrArray - This manages the beginnings and
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05301996 ends of maps and arrays. It tracks descending into and ascending
Laurence Lundblade6de37062018-10-15 12:22:42 +05301997 out of maps/arrays. It processes all breaks that terminate
Laurence Lundbladebb87be22020-04-09 19:15:32 -07001998 indefinite length maps and arrays.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001999
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05302000 - GetNext_MapEntry -- This handles the combining of two
2001 items, the label and the data, that make up a map entry.
2002 It only does work on maps. It combines the label and data
2003 items into one labeled item.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002004
Laurence Lundblade59289e52019-12-30 13:44:37 -08002005 - GetNext_TaggedItem -- This decodes type 6 tagging. It turns the
2006 tags into bit flags associated with the data item. No actual decoding
2007 of the contents of the tagged item is performed here.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002008
Laurence Lundblade59289e52019-12-30 13:44:37 -08002009 - GetNext_FullItem -- This assembles the sub-items that make up
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05302010 an indefinte length string into one string item. It uses the
Laurence Lundblade6de37062018-10-15 12:22:42 +05302011 string allocater to create contiguous space for the item. It
2012 processes all breaks that are part of indefinite length strings.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002013
Laurence Lundblade59289e52019-12-30 13:44:37 -08002014 - GetNext_Item -- This decodes the atomic data items in CBOR. Each
2015 atomic data item has a "major type", an integer "argument" and optionally
2016 some content. For text and byte strings, the content is the bytes
2017 that make up the string. These are the smallest data items that are
2018 considered to be well-formed. The content may also be other data items in
2019 the case of aggregate types. They are not handled in this layer.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002020
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002021 Roughly this takes 300 bytes of stack for vars. Need to
2022 evaluate this more carefully and correctly.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002023
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05302024 */
2025
2026
2027/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002028 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002029 */
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002030bool QCBORDecode_IsTagged(QCBORDecodeContext *me,
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002031 const QCBORItem *pItem,
2032 uint64_t uTag)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002033{
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002034 for(int i = 0; i < QCBOR_MAX_TAGS_PER_ITEM; i++ ) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002035 if(pItem->uTags[i] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002036 break;
2037 }
2038 if(ConvertTag(me, pItem->uTags[i]) == uTag) {
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002039 return true;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002040 }
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002041 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002042
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002043 return false;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002044}
2045
2046
2047/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002048 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002049 */
Laurence Lundblade30816f22018-11-10 13:40:22 +07002050QCBORError QCBORDecode_Finish(QCBORDecodeContext *me)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002051{
Laurence Lundblade085d7952020-07-24 10:26:30 -07002052 QCBORError uReturn = me->uLastError;
2053
2054 if(uReturn != QCBOR_SUCCESS) {
2055 goto Done;
2056 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002057
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002058 // Error out if all the maps/arrays are not closed out
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002059 if(!DecodeNesting_IsCurrentAtTop(&(me->nesting))) {
Laurence Lundblade085d7952020-07-24 10:26:30 -07002060 uReturn = QCBOR_ERR_ARRAY_OR_MAP_STILL_OPEN;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002061 goto Done;
2062 }
2063
2064 // Error out if not all the bytes are consumed
2065 if(UsefulInputBuf_BytesUnconsumed(&(me->InBuf))) {
Laurence Lundblade085d7952020-07-24 10:26:30 -07002066 uReturn = QCBOR_ERR_EXTRA_BYTES;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002067 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002068
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002069Done:
Laurence Lundblade6de37062018-10-15 12:22:42 +05302070 // Call the destructor for the string allocator if there is one.
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002071 // Always called, even if there are errors; always have to clean up
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002072 StringAllocator_Destruct(&(me->StringAllocator));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002073
Laurence Lundblade085d7952020-07-24 10:26:30 -07002074 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002075}
2076
2077
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002078/*
2079Public function, see header qcbor/qcbor_decode.h file
2080*/
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002081uint64_t QCBORDecode_GetNthTag(QCBORDecodeContext *pMe,
2082 const QCBORItem *pItem,
2083 unsigned int uIndex)
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002084{
2085 if(uIndex > QCBOR_MAX_TAGS_PER_ITEM) {
2086 return CBOR_TAG_INVALID16;
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002087 } else {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07002088 return ConvertTag(pMe, pItem->uTags[uIndex]);
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002089 }
2090}
2091
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002092
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002093/*
2094
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002095Decoder errors handled in this file
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002096
Laurence Lundbladeee851742020-01-08 08:37:05 -08002097 - Hit end of input before it was expected while decoding type and
2098 number QCBOR_ERR_HIT_END
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002099
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002100 - negative integer that is too large for C QCBOR_ERR_INT_OVERFLOW
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002101
Laurence Lundbladeee851742020-01-08 08:37:05 -08002102 - Hit end of input while decoding a text or byte string
2103 QCBOR_ERR_HIT_END
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002104
Laurence Lundbladeee851742020-01-08 08:37:05 -08002105 - Encountered conflicting tags -- e.g., an item is tagged both a date
2106 string and an epoch date QCBOR_ERR_UNSUPPORTED
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002107
Laurence Lundbladeee851742020-01-08 08:37:05 -08002108 - Encontered an array or mapp that has too many items
2109 QCBOR_ERR_ARRAY_TOO_LONG
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002110
Laurence Lundbladeee851742020-01-08 08:37:05 -08002111 - Encountered array/map nesting that is too deep
2112 QCBOR_ERR_ARRAY_NESTING_TOO_DEEP
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002113
Laurence Lundbladeee851742020-01-08 08:37:05 -08002114 - An epoch date > INT64_MAX or < INT64_MIN was encountered
2115 QCBOR_ERR_DATE_OVERFLOW
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002116
Laurence Lundbladeee851742020-01-08 08:37:05 -08002117 - The type of a map label is not a string or int
2118 QCBOR_ERR_MAP_LABEL_TYPE
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002119
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002120 - Hit end with arrays or maps still open -- QCBOR_ERR_EXTRA_BYTES
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002121
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002122 */
2123
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002124
2125
Laurence Lundbladef6531662018-12-04 10:42:22 +09002126
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002127/* ===========================================================================
2128 MemPool -- BUILT-IN SIMPLE STRING ALLOCATOR
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002129
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002130 This implements a simple sting allocator for indefinite length
2131 strings that can be enabled by calling QCBORDecode_SetMemPool(). It
2132 implements the function type QCBORStringAllocate and allows easy
2133 use of it.
Laurence Lundbladef6531662018-12-04 10:42:22 +09002134
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002135 This particular allocator is built-in for convenience. The caller
2136 can implement their own. All of this following code will get
2137 dead-stripped if QCBORDecode_SetMemPool() is not called.
2138
2139 This is a very primitive memory allocator. It does not track
2140 individual allocations, only a high-water mark. A free or
2141 reallocation must be of the last chunk allocated.
2142
2143 The size of the pool and offset to free memory are packed into the
2144 first 8 bytes of the memory pool so we don't have to keep them in
2145 the decode context. Since the address of the pool may not be
2146 aligned, they have to be packed and unpacked as if they were
2147 serialized data of the wire or such.
2148
2149 The sizes packed in are uint32_t to be the same on all CPU types
2150 and simplify the code.
Laurence Lundbladeee851742020-01-08 08:37:05 -08002151 ========================================================================== */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002152
2153
Laurence Lundbladeee851742020-01-08 08:37:05 -08002154static inline int
2155MemPool_Unpack(const void *pMem, uint32_t *puPoolSize, uint32_t *puFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002156{
2157 // Use of UsefulInputBuf is overkill, but it is convenient.
2158 UsefulInputBuf UIB;
2159
Laurence Lundbladeee851742020-01-08 08:37:05 -08002160 // Just assume the size here. It was checked during SetUp so
2161 // the assumption is safe.
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002162 UsefulInputBuf_Init(&UIB, (UsefulBufC){pMem, QCBOR_DECODE_MIN_MEM_POOL_SIZE});
2163 *puPoolSize = UsefulInputBuf_GetUint32(&UIB);
2164 *puFreeOffset = UsefulInputBuf_GetUint32(&UIB);
2165 return UsefulInputBuf_GetError(&UIB);
2166}
2167
2168
Laurence Lundbladeee851742020-01-08 08:37:05 -08002169static inline int
2170MemPool_Pack(UsefulBuf Pool, uint32_t uFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002171{
2172 // Use of UsefulOutBuf is overkill, but convenient. The
2173 // length check performed here is useful.
2174 UsefulOutBuf UOB;
2175
2176 UsefulOutBuf_Init(&UOB, Pool);
2177 UsefulOutBuf_AppendUint32(&UOB, (uint32_t)Pool.len); // size of pool
2178 UsefulOutBuf_AppendUint32(&UOB, uFreeOffset); // first free position
2179 return UsefulOutBuf_GetError(&UOB);
2180}
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002181
2182
2183/*
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002184 Internal function for an allocation, reallocation free and destuct.
2185
2186 Having only one function rather than one each per mode saves space in
2187 QCBORDecodeContext.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002188
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002189 Code Reviewers: THIS FUNCTION DOES POINTER MATH
2190 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002191static UsefulBuf
2192MemPool_Function(void *pPool, void *pMem, size_t uNewSize)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002193{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002194 UsefulBuf ReturnValue = NULLUsefulBuf;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002195
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002196 uint32_t uPoolSize;
2197 uint32_t uFreeOffset;
2198
2199 if(uNewSize > UINT32_MAX) {
2200 // This allocator is only good up to 4GB. This check should
2201 // optimize out if sizeof(size_t) == sizeof(uint32_t)
2202 goto Done;
2203 }
2204 const uint32_t uNewSize32 = (uint32_t)uNewSize;
2205
2206 if(MemPool_Unpack(pPool, &uPoolSize, &uFreeOffset)) {
2207 goto Done;
2208 }
2209
2210 if(uNewSize) {
2211 if(pMem) {
2212 // REALLOCATION MODE
2213 // Calculate pointer to the end of the memory pool. It is
2214 // assumed that pPool + uPoolSize won't wrap around by
2215 // assuming the caller won't pass a pool buffer in that is
2216 // not in legitimate memory space.
2217 const void *pPoolEnd = (uint8_t *)pPool + uPoolSize;
2218
2219 // Check that the pointer for reallocation is in the range of the
2220 // pool. This also makes sure that pointer math further down
2221 // doesn't wrap under or over.
2222 if(pMem >= pPool && pMem < pPoolEnd) {
2223 // Offset to start of chunk for reallocation. This won't
2224 // wrap under because of check that pMem >= pPool. Cast
2225 // is safe because the pool is always less than UINT32_MAX
2226 // because of check in QCBORDecode_SetMemPool().
2227 const uint32_t uMemOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2228
2229 // Check to see if the allocation will fit. uPoolSize -
2230 // uMemOffset will not wrap under because of check that
2231 // pMem is in the range of the uPoolSize by check above.
2232 if(uNewSize <= uPoolSize - uMemOffset) {
2233 ReturnValue.ptr = pMem;
2234 ReturnValue.len = uNewSize;
2235
2236 // Addition won't wrap around over because uNewSize was
2237 // checked to be sure it is less than the pool size.
2238 uFreeOffset = uMemOffset + uNewSize32;
2239 }
2240 }
2241 } else {
2242 // ALLOCATION MODE
2243 // uPoolSize - uFreeOffset will not underflow because this
2244 // pool implementation makes sure uFreeOffset is always
2245 // smaller than uPoolSize through this check here and
2246 // reallocation case.
2247 if(uNewSize <= uPoolSize - uFreeOffset) {
2248 ReturnValue.len = uNewSize;
2249 ReturnValue.ptr = (uint8_t *)pPool + uFreeOffset;
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002250 uFreeOffset += (uint32_t)uNewSize;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002251 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002252 }
2253 } else {
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002254 if(pMem) {
2255 // FREE MODE
2256 // Cast is safe because of limit on pool size in
2257 // QCBORDecode_SetMemPool()
2258 uFreeOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2259 } else {
2260 // DESTRUCT MODE
2261 // Nothing to do for this allocator
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002262 }
2263 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002264
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002265 UsefulBuf Pool = {pPool, uPoolSize};
2266 MemPool_Pack(Pool, uFreeOffset);
2267
2268Done:
2269 return ReturnValue;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002270}
2271
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002272
Laurence Lundbladef6531662018-12-04 10:42:22 +09002273/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002274 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef6531662018-12-04 10:42:22 +09002275 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002276QCBORError QCBORDecode_SetMemPool(QCBORDecodeContext *pMe,
2277 UsefulBuf Pool,
2278 bool bAllStrings)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002279{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002280 // The pool size and free mem offset are packed into the beginning
2281 // of the pool memory. This compile time check make sure the
2282 // constant in the header is correct. This check should optimize
2283 // down to nothing.
2284 if(QCBOR_DECODE_MIN_MEM_POOL_SIZE < 2 * sizeof(uint32_t)) {
Laurence Lundblade30816f22018-11-10 13:40:22 +07002285 return QCBOR_ERR_BUFFER_TOO_SMALL;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002286 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002287
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002288 // The pool size and free offset packed in to the beginning of pool
2289 // memory are only 32-bits. This check will optimize out on 32-bit
2290 // machines.
2291 if(Pool.len > UINT32_MAX) {
2292 return QCBOR_ERR_BUFFER_TOO_LARGE;
2293 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002294
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002295 // This checks that the pool buffer given is big enough.
2296 if(MemPool_Pack(Pool, QCBOR_DECODE_MIN_MEM_POOL_SIZE)) {
2297 return QCBOR_ERR_BUFFER_TOO_SMALL;
2298 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002299
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002300 pMe->StringAllocator.pfAllocator = MemPool_Function;
2301 pMe->StringAllocator.pAllocateCxt = Pool.ptr;
2302 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002303
Laurence Lundblade30816f22018-11-10 13:40:22 +07002304 return QCBOR_SUCCESS;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002305}
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002306
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002307
2308
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002309
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002310
2311
2312/*
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002313 Consume an entire map or array (and do next to
2314 nothing for non-aggregate types).
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002315 */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07002316static inline QCBORError
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002317ConsumeItem(QCBORDecodeContext *pMe,
2318 const QCBORItem *pItemToConsume,
2319 uint_fast8_t *puNextNestLevel)
2320{
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002321 QCBORError uReturn;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002322 QCBORItem Item;
2323
Laurence Lundblade02625d42020-06-25 14:41:41 -07002324 DecodeNesting_Print(&(pMe->nesting), &(pMe->InBuf), "ConsumeItem");
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002325
Laurence Lundblade02625d42020-06-25 14:41:41 -07002326 if(QCBORItem_IsMapOrArray(pItemToConsume)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002327 /* There is only real work to do for maps and arrays */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002328
Laurence Lundblade1341c592020-04-11 14:19:05 -07002329 /* This works for definite and indefinite length
2330 * maps and arrays by using the nesting level
2331 */
2332 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002333 uReturn = QCBORDecode_GetNext(pMe, &Item);
2334 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002335 goto Done;
2336 }
2337 } while(Item.uNextNestLevel >= pItemToConsume->uNextNestLevel);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002338
Laurence Lundblade1341c592020-04-11 14:19:05 -07002339 if(puNextNestLevel != NULL) {
2340 *puNextNestLevel = Item.uNextNestLevel;
2341 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002342 uReturn = QCBOR_SUCCESS;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002343
Laurence Lundblade1341c592020-04-11 14:19:05 -07002344 } else {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002345 /* item_to_consume is not a map or array */
Laurence Lundblade1341c592020-04-11 14:19:05 -07002346 if(puNextNestLevel != NULL) {
2347 /* Just pass the nesting level through */
2348 *puNextNestLevel = pItemToConsume->uNextNestLevel;
2349 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002350 uReturn = QCBOR_SUCCESS;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002351 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002352
2353Done:
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002354 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002355}
2356
2357
Laurence Lundblade1341c592020-04-11 14:19:05 -07002358/* Return true if the labels in Item1 and Item2 are the same.
2359 Works only for integer and string labels. Returns false
2360 for any other type. */
2361static inline bool
2362MatchLabel(QCBORItem Item1, QCBORItem Item2)
2363{
2364 if(Item1.uLabelType == QCBOR_TYPE_INT64) {
2365 if(Item2.uLabelType == QCBOR_TYPE_INT64 && Item1.label.int64 == Item2.label.int64) {
2366 return true;
2367 }
2368 } else if(Item1.uLabelType == QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002369 if(Item2.uLabelType == QCBOR_TYPE_TEXT_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002370 return true;
2371 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002372 } else if(Item1.uLabelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002373 if(Item2.uLabelType == QCBOR_TYPE_BYTE_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
2374 return true;
2375 }
2376 } else if(Item1.uLabelType == QCBOR_TYPE_UINT64) {
2377 if(Item2.uLabelType == QCBOR_TYPE_UINT64 && Item1.label.uint64 == Item2.label.uint64) {
2378 return true;
2379 }
2380 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002381
Laurence Lundblade1341c592020-04-11 14:19:05 -07002382 /* Other label types are never matched */
2383 return false;
2384}
2385
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002386
2387/*
2388 Returns true if Item1 and Item2 are the same type
2389 or if either are of QCBOR_TYPE_ANY.
2390 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002391static inline bool
2392MatchType(QCBORItem Item1, QCBORItem Item2)
2393{
2394 if(Item1.uDataType == Item2.uDataType) {
2395 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002396 } else if(Item1.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002397 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002398 } else if(Item2.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002399 return true;
2400 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002401 return false;
2402}
2403
2404
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002405/**
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002406 \brief Search a map for a set of items.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002407
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002408 @param[in] pMe The decode context to search.
2409 @param[in,out] pItemArray The items to search for and the items found.
2410 @param[out] puOffset Byte offset of last item matched.
2411 @param[in] pCBContext Context for the not-found item call back.
2412 @param[in] pfCallback Function to call on items not matched in pItemArray.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002413
2414 @retval QCBOR_ERR_NOT_ENTERED Trying to search without having entered a map
2415
2416 @retval QCBOR_ERR_DUPLICATE_LABEL Duplicate items (items with the same label) were found for one of the labels being search for. This duplicate detection is only performed for items in pItemArray, not every item in the map.
2417
2418 @retval QCBOR_ERR_UNEXPECTED_TYPE The label was matched, but not the type.
2419
2420 @retval Also errors returned by QCBORDecode_GetNext().
2421
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002422 On input pItemArray contains a list of labels and data types
2423 of items to be found.
2424
2425 On output the fully retrieved items are filled in with
2426 values and such. The label was matched, so it never changes.
2427
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002428 If an item was not found, its data type is set to QCBOR_TYPE_NONE.
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002429 */
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002430static QCBORError
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002431MapSearch(QCBORDecodeContext *pMe,
2432 QCBORItem *pItemArray,
2433 size_t *puOffset,
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002434 void *pCBContext,
2435 QCBORItemCallback pfCallback)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002436{
Laurence Lundbladee6f15112020-07-23 18:44:16 -07002437 QCBORError uReturn;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002438 uint64_t uFoundItemBitMap = 0;
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002439
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002440 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002441 uReturn = pMe->uLastError;
2442 goto Done2;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002443 }
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002444
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002445 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_MAP) &&
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002446 pItemArray->uLabelType != QCBOR_TYPE_NONE) {
2447 /* QCBOR_TYPE_NONE as first item indicates just looking
2448 for the end of an array, so don't give error. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002449 uReturn = QCBOR_ERR_MAP_NOT_ENTERED;
2450 goto Done2;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002451 }
2452
Laurence Lundblade085d7952020-07-24 10:26:30 -07002453 if(DecodeNesting_IsBoundedEmpty(&(pMe->nesting))) {
2454 // It is an empty bounded array or map
2455 if(pItemArray->uLabelType == QCBOR_TYPE_NONE) {
2456 // Just trying to find the end of the map or array
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002457 pMe->uMapEndOffsetCache = DecodeNesting_GetMapOrArrayStart(&(pMe->nesting));
Laurence Lundblade085d7952020-07-24 10:26:30 -07002458 uReturn = QCBOR_SUCCESS;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002459 } else {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002460 // Nothing is ever found in an empty array or map. All items
2461 // are marked as not found below.
Laurence Lundblade085d7952020-07-24 10:26:30 -07002462 uReturn = QCBOR_SUCCESS;
2463 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002464 goto Done2;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002465 }
2466
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002467 QCBORDecodeNesting SaveNesting;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002468 DecodeNesting_PrepareForMapSearch(&(pMe->nesting), &SaveNesting);
2469
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002470 /* Reposition to search from the start of the map / array */
Laurence Lundblade02625d42020-06-25 14:41:41 -07002471 UsefulInputBuf_Seek(&(pMe->InBuf),
2472 DecodeNesting_GetMapOrArrayStart(&(pMe->nesting)));
Laurence Lundblade1341c592020-04-11 14:19:05 -07002473
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002474 /*
2475 Loop over all the items in the map. They could be
2476 deeply nested and this should handle both definite
2477 and indefinite length maps and arrays, so this
2478 adds some complexity.
2479 */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002480 const uint8_t uMapNestLevel = DecodeNesting_GetBoundedModeLevel(&(pMe->nesting));
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002481 uint_fast8_t uNextNestLevel;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002482 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002483 /* Remember offset of the item because sometimes it has to be returned */
Laurence Lundblade1341c592020-04-11 14:19:05 -07002484 const size_t uOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002485
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002486 /* Get the item */
2487 QCBORItem Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002488 uReturn = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladec7114722020-08-13 05:11:40 -07002489 if(QCBORDecode_IsNotWellFormed(uReturn)) {
2490 /* Got non-well-formed CBOR so map can't even be decoded. */
Laurence Lundblade1341c592020-04-11 14:19:05 -07002491 goto Done;
2492 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002493
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002494 /* See if item has one of the labels that are of interest */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002495 bool bMatched = false;
2496 for(int nIndex = 0; pItemArray[nIndex].uLabelType != QCBOR_TYPE_NONE; nIndex++) {
2497 if(MatchLabel(Item, pItemArray[nIndex])) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002498 /* A label match has been found */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002499 if(uFoundItemBitMap & (0x01ULL << nIndex)) {
2500 uReturn = QCBOR_ERR_DUPLICATE_LABEL;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002501 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002502 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002503 /* Also try to match its type */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002504 if(!MatchType(Item, pItemArray[nIndex])) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002505 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002506 goto Done;
2507 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002508
Laurence Lundblade1341c592020-04-11 14:19:05 -07002509 /* Successful match. Return the item. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002510 pItemArray[nIndex] = Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002511 uFoundItemBitMap |= 0x01ULL << nIndex;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002512 if(puOffset) {
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002513 *puOffset = uOffset;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002514 }
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002515 bMatched = true;
2516 }
2517 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002518
2519
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002520 if(!bMatched && pfCallback != NULL) {
2521 /*
2522 Call the callback on unmatched labels.
2523 (It is tempting to do duplicate detection here, but that would
2524 require dynamic memory allocation because the number of labels
2525 that might be encountered is unbounded.)
2526 */
2527 uReturn = (*pfCallback)(pCBContext, &Item);
2528 if(uReturn != QCBOR_SUCCESS) {
2529 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002530 }
2531 }
2532
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002533 /*
2534 Consume the item whether matched or not. This
2535 does the work of traversing maps and array and
2536 everything in them. In this loop only the
2537 items at the current nesting level are examined
2538 to match the labels.
2539 */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002540 uReturn = ConsumeItem(pMe, &Item, &uNextNestLevel);
Laurence Lundbladec7114722020-08-13 05:11:40 -07002541 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002542 goto Done;
2543 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002544
2545 } while (uNextNestLevel >= uMapNestLevel);
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002546
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002547 uReturn = QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002548
2549 const size_t uEndOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002550 /* Cast OK because encoded CBOR is limited to UINT32_MAX */
2551 pMe->uMapEndOffsetCache = (uint32_t)uEndOffset;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002552
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002553 Done:
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002554 DecodeNesting_RestoreFromMapSearch(&(pMe->nesting), &SaveNesting);
2555
2556 Done2:
Laurence Lundbladec7114722020-08-13 05:11:40 -07002557 /* For all items not found, set the data type to QCBOR_TYPE_NONE */
2558 for(int i = 0; pItemArray[i].uLabelType != 0; i++) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002559 if(!(uFoundItemBitMap & (0x01ULL << i))) {
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002560 pItemArray[i].uDataType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002561 }
2562 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002563
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002564 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002565}
2566
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002567
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002568/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002569 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002570*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002571void QCBORDecode_GetItemInMapN(QCBORDecodeContext *pMe,
2572 int64_t nLabel,
2573 uint8_t uQcborType,
2574 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002575{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002576 if(pMe->uLastError != QCBOR_SUCCESS) {
2577 return;
2578 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002579
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002580 QCBORItem OneItemSeach[2];
2581 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
2582 OneItemSeach[0].label.int64 = nLabel;
2583 OneItemSeach[0].uDataType = uQcborType;
2584 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07002585
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002586 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
2587 if(uReturn != QCBOR_SUCCESS) {
2588 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002589 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002590 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002591 uReturn = QCBOR_ERR_NOT_FOUND;
2592 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002593 }
2594
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002595 *pItem = OneItemSeach[0];
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002596
2597 Done:
2598 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002599}
2600
2601
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002602/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002603 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002604*/
Laurence Lundbladeda095972020-06-06 18:35:33 -07002605void QCBORDecode_GetItemInMapSZ(QCBORDecodeContext *pMe,
2606 const char *szLabel,
2607 uint8_t uQcborType,
2608 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002609{
Laurence Lundbladeda095972020-06-06 18:35:33 -07002610 if(pMe->uLastError != QCBOR_SUCCESS) {
2611 return;
2612 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002613
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002614 QCBORItem OneItemSeach[2];
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002615 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
2616 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
2617 OneItemSeach[0].uDataType = uQcborType;
2618 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07002619
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002620 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
2621 if(uReturn != QCBOR_SUCCESS) {
2622 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002623 }
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002624 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002625 uReturn = QCBOR_ERR_NOT_FOUND;
2626 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002627 }
2628
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002629 *pItem = OneItemSeach[0];
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002630
2631Done:
2632 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002633}
2634
2635
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002636
2637static QCBORError CheckTypeList(uint8_t uDataType, const uint8_t puTypeList[QCBOR_TAGSPEC_NUM_TYPES])
2638{
2639 for(size_t i = 0; i < QCBOR_TAGSPEC_NUM_TYPES; i++) {
2640 if(uDataType == puTypeList[i]) {
2641 return QCBOR_SUCCESS;
2642 }
2643 }
2644 return QCBOR_ERR_UNEXPECTED_TYPE;
2645}
2646
Laurence Lundblade67257dc2020-07-27 03:33:37 -07002647
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002648/**
2649 @param[in] TagSpec Specification for matching tags.
2650 @param[in] uDataType A QCBOR data type
2651
2652 @retval QCBOR_SUCCESS \c uDataType is allowed by @c TagSpec
2653 @retval QCBOR_ERR_UNEXPECTED_TYPE \c uDataType is not allowed by @c TagSpec
2654
2655 The data type must be one of the QCBOR_TYPEs, not the IETF CBOR Registered tag value.
2656 */
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002657static QCBORError CheckTagRequirement(const TagSpecification TagSpec, uint8_t uDataType)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002658{
Laurence Lundbladef9175a92020-07-30 21:35:45 -07002659 if(TagSpec.uTagRequirement == QCBOR_TAG_REQUIREMENT_MATCH_TAG) {
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002660 // Must match the tag and only the tag
2661 return CheckTypeList(uDataType, TagSpec.uTaggedTypes);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002662 }
2663
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002664 QCBORError uReturn = CheckTypeList(uDataType, TagSpec.uAllowedContentTypes);
2665 if(uReturn == QCBOR_SUCCESS) {
2666 return QCBOR_SUCCESS;
2667 }
2668
Laurence Lundbladef9175a92020-07-30 21:35:45 -07002669 if(TagSpec.uTagRequirement == QCBOR_TAG_REQUIREMENT_NO_TAG) {
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002670 /* Must match the content type and only the content type.
2671 There was no match just above so it is a fail. */
2672 return QCBOR_ERR_UNEXPECTED_TYPE;
2673 }
2674
2675 /* If here it can match either the tag or the content
2676 and it hasn't matched the content, so the end
2677 result is whether it matches the tag. This is
2678 also the case that the CBOR standard discourages. */
2679
2680 return CheckTypeList(uDataType, TagSpec.uTaggedTypes);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002681}
2682
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002683
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002684// Semi-private
2685// TODO: inline or collapse with QCBORDecode_GetTaggedStringInMapN?
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002686void QCBORDecode_GetTaggedItemInMapN(QCBORDecodeContext *pMe,
2687 int64_t nLabel,
2688 TagSpecification TagSpec,
2689 QCBORItem *pItem)
2690{
2691 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
2692 if(pMe->uLastError != QCBOR_SUCCESS) {
2693 return;
2694 }
2695
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07002696 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem->uDataType);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002697}
2698
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002699// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002700void QCBORDecode_GetTaggedItemInMapSZ(QCBORDecodeContext *pMe,
2701 const char *szLabel,
2702 TagSpecification TagSpec,
2703 QCBORItem *pItem)
2704{
2705 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
2706 if(pMe->uLastError != QCBOR_SUCCESS) {
2707 return;
2708 }
2709
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07002710 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem->uDataType);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002711}
2712
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002713// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002714void QCBORDecode_GetTaggedStringInMapN(QCBORDecodeContext *pMe,
2715 int64_t nLabel,
2716 TagSpecification TagSpec,
2717 UsefulBufC *pString)
2718{
2719 QCBORItem Item;
2720 QCBORDecode_GetTaggedItemInMapN(pMe, nLabel, TagSpec, &Item);
2721 if(pMe->uLastError == QCBOR_SUCCESS) {
2722 *pString = Item.val.string;
2723 }
2724}
2725
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002726// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002727void QCBORDecode_GetTaggedStringInMapSZ(QCBORDecodeContext *pMe,
2728 const char * szLabel,
2729 TagSpecification TagSpec,
2730 UsefulBufC *pString)
2731{
2732 QCBORItem Item;
2733 QCBORDecode_GetTaggedItemInMapSZ(pMe, szLabel, TagSpec, &Item);
2734 if(pMe->uLastError == QCBOR_SUCCESS) {
2735 *pString = Item.val.string;
2736 }
2737}
Laurence Lundblade1341c592020-04-11 14:19:05 -07002738
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002739/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002740 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002741*/
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002742QCBORError QCBORDecode_GetItemsInMap(QCBORDecodeContext *pCtx, QCBORItem *pItemList)
2743{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002744 return MapSearch(pCtx, pItemList, NULL, NULL, NULL);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002745}
2746
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002747/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002748 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002749*/
2750QCBORError QCBORDecode_GetItemsInMapWithCallback(QCBORDecodeContext *pCtx,
2751 QCBORItem *pItemList,
2752 void *pCallbackCtx,
2753 QCBORItemCallback pfCB)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002754{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002755 return MapSearch(pCtx, pItemList, NULL, pCallbackCtx, pfCB);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002756}
2757
2758
Laurence Lundblade34691b92020-05-18 22:25:25 -07002759static void SearchAndEnter(QCBORDecodeContext *pMe, QCBORItem pSearch[])
Laurence Lundblade1341c592020-04-11 14:19:05 -07002760{
Laurence Lundblade085d7952020-07-24 10:26:30 -07002761 // TODO: check that only one item is in pSearch?
Laurence Lundblade34691b92020-05-18 22:25:25 -07002762 if(pMe->uLastError != QCBOR_SUCCESS) {
2763 // Already in error state; do nothing.
2764 return;
2765 }
2766
2767 size_t uOffset;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002768 pMe->uLastError = (uint8_t)MapSearch(pMe, pSearch, &uOffset, NULL, NULL);
Laurence Lundblade34691b92020-05-18 22:25:25 -07002769 if(pMe->uLastError != QCBOR_SUCCESS) {
2770 return;
2771 }
2772
Laurence Lundblade085d7952020-07-24 10:26:30 -07002773 if(pSearch->uDataType == QCBOR_TYPE_NONE) {
2774 pMe->uLastError = QCBOR_ERR_NOT_FOUND;
2775 return;
2776 }
2777
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002778 /* Need to get the current pre-order nesting level and cursor to be
Laurence Lundblade2c1faf92020-06-26 22:43:56 -07002779 at the map/array about to be entered.
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002780
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002781 Also need the current map nesting level and start cursor to
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002782 be at the right place.
2783
2784 The UsefulInBuf offset could be anywhere, so no assumption is
2785 made about it.
2786
2787 No assumption is made about the pre-order nesting level either.
2788
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002789 However the bounded mode nesting level is assumed to be one above
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002790 the map level that is being entered.
2791 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002792 /* Seek to the data item that is the map or array */
2793 UsefulInputBuf_Seek(&(pMe->InBuf), uOffset);
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002794
2795 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002796
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002797 QCBORDecode_EnterBoundedMapOrArray(pMe, pSearch->uDataType);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002798}
2799
2800
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002801/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07002802 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002803*/
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002804void QCBORDecode_EnterMapFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002805{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002806 QCBORItem OneItemSeach[2];
2807 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
2808 OneItemSeach[0].label.int64 = nLabel;
2809 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
2810 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002811
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002812 /* The map to enter was found, now finish of entering it. */
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002813 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002814}
2815
2816
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002817/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07002818 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002819*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07002820void QCBORDecode_EnterMapFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002821{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002822 QCBORItem OneItemSeach[2];
2823 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
2824 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
2825 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
2826 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002827
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002828 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002829}
2830
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002831/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07002832 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002833*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07002834void QCBORDecode_EnterArrayFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundblade1341c592020-04-11 14:19:05 -07002835{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002836 QCBORItem OneItemSeach[2];
2837 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
2838 OneItemSeach[0].label.int64 = nLabel;
2839 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
2840 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002841
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002842 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade34691b92020-05-18 22:25:25 -07002843}
2844
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002845/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07002846 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002847*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07002848void QCBORDecode_EnterArrayFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
2849{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002850 QCBORItem OneItemSeach[2];
2851 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
2852 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
2853 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
2854 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002855
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002856 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade1341c592020-04-11 14:19:05 -07002857}
2858
2859
Laurence Lundblade02625d42020-06-25 14:41:41 -07002860// Semi-private function
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002861void QCBORDecode_EnterBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002862{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002863 QCBORError uErr;
2864
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002865 /* Must only be called on maps and arrays. */
Laurence Lundblade34691b92020-05-18 22:25:25 -07002866 if(pMe->uLastError != QCBOR_SUCCESS) {
2867 // Already in error state; do nothing.
2868 return;
2869 }
Laurence Lundblade1341c592020-04-11 14:19:05 -07002870
2871 /* Get the data item that is the map that is being searched */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002872 QCBORItem Item;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002873 uErr = QCBORDecode_GetNext(pMe, &Item);
2874 if(uErr != QCBOR_SUCCESS) {
2875 goto Done;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07002876 }
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002877 if(Item.uDataType != uType) {
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002878 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
2879 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002880 }
2881
Laurence Lundbladef0499502020-08-01 11:55:57 -07002882 const bool bIsEmpty = (Item.uNextNestLevel <= Item.uNestingLevel);
Laurence Lundblade085d7952020-07-24 10:26:30 -07002883 if(bIsEmpty) {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002884 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
2885 // Undo decrement done by QCBORDecode_GetNext() so the the
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002886 // the decrement when exiting the map/array works correctly
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002887 pMe->nesting.pCurrent->u.ma.uCountCursor++;
2888 }
Laurence Lundbladee6f15112020-07-23 18:44:16 -07002889 // Special case to increment nesting level for zero-length maps and arrays entered in bounded mode.
2890 DecodeNesting_Descend(&(pMe->nesting), uType);
2891 }
2892
Laurence Lundblade02625d42020-06-25 14:41:41 -07002893 pMe->uMapEndOffsetCache = MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002894
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002895 uErr = DecodeNesting_EnterBoundedMapOrArray(&(pMe->nesting), bIsEmpty,
2896 UsefulInputBuf_Tell(&(pMe->InBuf)));
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002897
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002898Done:
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002899 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002900}
2901
Laurence Lundblade02625d42020-06-25 14:41:41 -07002902
2903/*
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002904 This is the common work for exiting a level that is a bounded map, array or bstr
2905 wrapped CBOR.
Laurence Lundblade02625d42020-06-25 14:41:41 -07002906
2907 One chunk of work is to set up the pre-order traversal so it is at
2908 the item just after the bounded map, array or bstr that is being
2909 exited. This is somewhat complex.
2910
2911 The other work is to level-up the bounded mode to next higest bounded
2912 mode or the top level if there isn't one.
2913 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002914static QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -07002915ExitBoundedLevel(QCBORDecodeContext *pMe, uint32_t uEndOffset)
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002916{
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002917 QCBORError uErr;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002918
Laurence Lundblade02625d42020-06-25 14:41:41 -07002919 /*
2920 First the pre-order-traversal byte offset is positioned to the
2921 item just after the bounded mode item that was just consumed.
2922 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002923 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOffset);
2924
Laurence Lundblade02625d42020-06-25 14:41:41 -07002925 /*
2926 Next, set the current nesting level to one above the bounded level
2927 that was just exited.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002928
Laurence Lundblade02625d42020-06-25 14:41:41 -07002929 DecodeNesting_CheckBoundedType() is always called before this and
2930 makes sure pCurrentBounded is valid.
2931 */
2932 DecodeNesting_LevelUpCurrent(&(pMe->nesting));
2933
2934 /*
2935 This does the complex work of leveling up the pre-order traversal
2936 when the end of a map or array or another bounded level is
2937 reached. It may do nothing, or ascend all the way to the top
2938 level.
2939 */
Laurence Lundbladed0304932020-06-27 10:59:38 -07002940 uErr = NestLevelAscender(pMe, false);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002941 if(uErr != QCBOR_SUCCESS) {
2942 goto Done;
2943 }
2944
Laurence Lundblade02625d42020-06-25 14:41:41 -07002945 /*
2946 This makes the next highest bounded level the current bounded
2947 level. If there is no next highest level, then no bounded mode is
2948 in effect.
2949 */
2950 DecodeNesting_LevelUpBounded(&(pMe->nesting));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002951
Laurence Lundblade02625d42020-06-25 14:41:41 -07002952 pMe->uMapEndOffsetCache = MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002953
2954Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -07002955 DecodeNesting_Print(&(pMe->nesting), &(pMe->InBuf), "ExitBoundedLevel");
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002956 return uErr;
2957}
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002958
Laurence Lundblade02625d42020-06-25 14:41:41 -07002959
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002960// Semi-private function
Laurence Lundblade02625d42020-06-25 14:41:41 -07002961void QCBORDecode_ExitBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002962{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002963 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07002964 /* Already in error state; do nothing. */
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002965 return;
2966 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002967
Laurence Lundblade02625d42020-06-25 14:41:41 -07002968 QCBORError uErr;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002969
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002970 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), uType)) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002971 uErr = QCBOR_ERR_CLOSE_MISMATCH;
2972 goto Done;
2973 }
2974
Laurence Lundblade02625d42020-06-25 14:41:41 -07002975 /*
2976 Have to set the offset to the end of the map/array
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002977 that is being exited. If there is no cached value,
Laurence Lundblade02625d42020-06-25 14:41:41 -07002978 from previous map search, then do a dummy search.
2979 */
2980 if(pMe->uMapEndOffsetCache == MAP_OFFSET_CACHE_INVALID) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002981 QCBORItem Dummy;
2982 Dummy.uLabelType = QCBOR_TYPE_NONE;
2983 uErr = MapSearch(pMe, &Dummy, NULL, NULL, NULL);
2984 if(uErr != QCBOR_SUCCESS) {
2985 goto Done;
2986 }
2987 }
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002988
Laurence Lundblade02625d42020-06-25 14:41:41 -07002989 uErr = ExitBoundedLevel(pMe, pMe->uMapEndOffsetCache);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002990
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002991Done:
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002992 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002993}
2994
2995
Laurence Lundblade1341c592020-04-11 14:19:05 -07002996
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002997static QCBORError InternalEnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07002998 const QCBORItem *pItem,
2999 uint8_t uTagRequirement,
3000 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003001{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003002 if(pBstr) {
3003 *pBstr = NULLUsefulBufC;
3004 }
3005
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003006 if(pMe->uLastError != QCBOR_SUCCESS) {
3007 // Already in error state; do nothing.
3008 return pMe->uLastError;
3009 }
3010
3011 QCBORError uError = QCBOR_SUCCESS;
3012
3013 if(pItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
3014 uError = QCBOR_ERR_UNEXPECTED_TYPE;
3015 goto Done;;
3016 }
3017
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003018 const TagSpecification TagSpec =
3019 {
3020 uTagRequirement,
3021 {QBCOR_TYPE_WRAPPED_CBOR, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE, QCBOR_TYPE_NONE},
3022 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3023 };
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003024
3025 uError = CheckTagRequirement(TagSpec, pItem->uDataType);
3026 if(uError != QCBOR_SUCCESS) {
3027 goto Done;
3028 }
3029
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003030 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07003031 /* Reverse the decrement done by GetNext() for the bstr as
Laurence Lundblade410c7e02020-06-25 23:35:29 -07003032 so the increment in NestLevelAscender called by ExitBoundedLevel()
3033 will work right. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003034 DecodeNesting_ReverseDecrement(&(pMe->nesting));
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07003035 }
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003036
3037 if(pBstr) {
3038 *pBstr = pItem->val.string;
3039 }
3040
3041 const size_t uPreviousLength = UsefulInputBuf_GetLength(&(pMe->InBuf));
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003042
3043 // Need to move UIB input cursor to the right place
Laurence Lundbladef76a2622020-08-06 19:51:03 -07003044 // Most of these calls are simple inline accessors so this doesn't
3045 // amount to much code. There is a range check in the seek.
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003046 const size_t uEndOfBstr = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladef76a2622020-08-06 19:51:03 -07003047 if(uEndOfBstr >= UINT32_MAX || uPreviousLength >= UINT32_MAX) {
3048 // TODO: test this error condition
3049 uError = QCBOR_ERR_BUFFER_TOO_LARGE;
3050 goto Done;
3051 }
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003052 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOfBstr - pItem->val.string.len);
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003053 UsefulInputBuf_SetBufferLen(&(pMe->InBuf), uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003054
Laurence Lundbladef76a2622020-08-06 19:51:03 -07003055 // Casts are OK because of the checks above.
Laurence Lundblade02625d42020-06-25 14:41:41 -07003056 uError = DecodeNesting_DescendIntoBstrWrapped(&(pMe->nesting),
Laurence Lundbladef76a2622020-08-06 19:51:03 -07003057 (uint32_t)uPreviousLength,
3058 (uint32_t)uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003059Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -07003060 DecodeNesting_Print(&(pMe->nesting), &(pMe->InBuf), "Entered Bstr");
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003061
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003062 return uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003063}
3064
3065
Laurence Lundblade02625d42020-06-25 14:41:41 -07003066/*
3067 Public function, see header qcbor/qcbor_decode.h file
3068 */
3069void QCBORDecode_EnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003070 uint8_t uTagRequirement,
3071 UsefulBufC *pBstr)
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003072{
3073 if(pMe->uLastError != QCBOR_SUCCESS) {
3074 // Already in error state; do nothing.
3075 return;
3076 }
3077
3078 /* Get the data item that is the map that is being searched */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003079 QCBORItem Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003080 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3081 if(pMe->uLastError != QCBOR_SUCCESS) {
3082 return;
3083 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003084
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003085 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003086 &Item,
3087 uTagRequirement,
3088 pBstr);
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003089}
3090
3091
Laurence Lundblade02625d42020-06-25 14:41:41 -07003092/*
3093 Public function, see header qcbor/qcbor_decode.h file
3094 */
3095void QCBORDecode_EnterBstrWrappedFromMapN(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003096 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003097 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003098 UsefulBufC *pBstr)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003099{
3100 QCBORItem Item;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003101 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003102
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003103 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe, &Item, uTagRequirement, pBstr);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003104}
3105
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003106
Laurence Lundblade02625d42020-06-25 14:41:41 -07003107/*
3108 Public function, see header qcbor/qcbor_decode.h file
3109 */
3110void QCBORDecode_EnterBstrWrappedFromMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003111 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003112 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003113 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003114{
3115 QCBORItem Item;
3116 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3117
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003118 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe, &Item, uTagRequirement, pBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003119}
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003120
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003121
Laurence Lundblade02625d42020-06-25 14:41:41 -07003122/*
3123 Public function, see header qcbor/qcbor_decode.h file
3124 */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003125void QCBORDecode_ExitBstrWrapped(QCBORDecodeContext *pMe)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003126{
Laurence Lundblade02625d42020-06-25 14:41:41 -07003127 if(pMe->uLastError != QCBOR_SUCCESS) {
3128 // Already in error state; do nothing.
3129 return;
3130 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003131
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003132 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07003133 pMe->uLastError = QCBOR_ERR_CLOSE_MISMATCH;
3134 return;
3135 }
3136
3137 /*
3138 Reset the length of the UsefulInputBuf to what it was before
3139 the bstr wrapped CBOR was entered.
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003140 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003141 UsefulInputBuf_SetBufferLen(&(pMe->InBuf),
3142 DecodeNesting_GetPreviousBoundedEnd(&(pMe->nesting)));
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003143
3144
Laurence Lundblade02625d42020-06-25 14:41:41 -07003145 QCBORError uErr = ExitBoundedLevel(pMe, DecodeNesting_GetEndOfBstr(&(pMe->nesting)));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003146 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003147}
3148
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003149
Laurence Lundbladee6430642020-03-14 21:15:44 -07003150
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003151
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003152
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003153
Laurence Lundblade11a064e2020-05-07 13:13:42 -07003154
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003155
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003156static QCBORError InterpretBool(const QCBORItem *pItem, bool *pBool)
3157{
3158 switch(pItem->uDataType) {
3159 case QCBOR_TYPE_TRUE:
3160 *pBool = true;
3161 return QCBOR_SUCCESS;
3162 break;
3163
3164 case QCBOR_TYPE_FALSE:
3165 *pBool = false;
3166 return QCBOR_SUCCESS;
3167 break;
3168
3169 default:
3170 return QCBOR_ERR_UNEXPECTED_TYPE;
3171 break;
3172 }
3173}
Laurence Lundbladee6430642020-03-14 21:15:44 -07003174
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003175
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003176/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003177 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003178*/
Laurence Lundbladec4537442020-04-14 18:53:22 -07003179void QCBORDecode_GetBool(QCBORDecodeContext *pMe, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003180{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003181 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003182 // Already in error state, do nothing
Laurence Lundbladee6430642020-03-14 21:15:44 -07003183 return;
3184 }
3185
Laurence Lundbladec4537442020-04-14 18:53:22 -07003186 QCBORError nError;
3187 QCBORItem Item;
3188
3189 nError = QCBORDecode_GetNext(pMe, &Item);
3190 if(nError != QCBOR_SUCCESS) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003191 pMe->uLastError = (uint8_t)nError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003192 return;
3193 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003194 pMe->uLastError = (uint8_t)InterpretBool(&Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003195}
3196
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003197
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003198/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003199 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003200*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003201void QCBORDecode_GetBoolInMapN(QCBORDecodeContext *pMe, int64_t nLabel, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003202{
3203 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003204 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003205
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003206 pMe->uLastError = (uint8_t)InterpretBool(&Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003207}
3208
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003209
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003210/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003211 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003212*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003213void QCBORDecode_GetBoolInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, bool *pValue)
3214{
3215 QCBORItem Item;
3216 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3217
3218 pMe->uLastError = (uint8_t)InterpretBool(&Item, pValue);
3219}
3220
3221
3222
Laurence Lundbladec7114722020-08-13 05:11:40 -07003223
3224
3225static void ProcessEpochDate(QCBORDecodeContext *pMe,
3226 QCBORItem *pItem,
3227 uint8_t uTagRequirement,
3228 int64_t *pnTime)
3229{
3230 if(pMe->uLastError != QCBOR_SUCCESS) {
3231 // Already in error state, do nothing
3232 return;
3233 }
3234
3235 QCBORError uErr;
3236
3237 const TagSpecification TagSpec =
3238 {
3239 uTagRequirement,
3240 {QCBOR_TYPE_DATE_EPOCH, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3241 {QCBOR_TYPE_INT64, QCBOR_TYPE_DOUBLE, QCBOR_TYPE_FLOAT}
3242 };
3243
3244 // TODO: this will give a unexpected type error instead of
3245 // overflow error for QCBOR_TYPE_UINT64 because TagSpec
3246 // only has three target types.
3247 uErr = CheckTagRequirement(TagSpec, pItem->uDataType);
3248 if(uErr != QCBOR_SUCCESS) {
3249 goto Done;
3250 }
3251
3252 if(pItem->uDataType != QCBOR_TYPE_DATE_EPOCH) {
3253 uErr = DecodeDateEpoch(pItem);
3254 if(uErr != QCBOR_SUCCESS) {
3255 goto Done;
3256 }
3257 }
3258
3259 *pnTime = pItem->val.epochDate.nSeconds;
3260
3261Done:
3262 pMe->uLastError = (uint8_t)uErr;
3263}
3264
3265
3266void QCBORDecode_GetEpochDate(QCBORDecodeContext *pMe,
3267 uint8_t uTagRequirement,
3268 int64_t *pnTime)
3269{
3270 if(pMe->uLastError != QCBOR_SUCCESS) {
3271 // Already in error state, do nothing
3272 return;
3273 }
3274
3275 QCBORItem Item;
3276 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3277
3278 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3279}
3280
3281
3282void
3283QCBORDecode_GetEpochDateInMapN(QCBORDecodeContext *pMe,
3284 int64_t nLabel,
3285 uint8_t uTagRequirement,
3286 int64_t *pnTime)
3287{
3288 QCBORItem Item;
3289 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
3290 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3291}
3292
3293
3294void
3295QCBORDecode_GetEpochDateInMapSZ(QCBORDecodeContext *pMe,
3296 const char *szLabel,
3297 uint8_t uTagRequirement,
3298 int64_t *pnTime)
3299{
3300 QCBORItem Item;
3301 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3302 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3303}
3304
3305
3306
3307
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003308void QCBORDecode_GetTaggedStringInternal(QCBORDecodeContext *pMe,
3309 TagSpecification TagSpec,
3310 UsefulBufC *pBstr)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003311{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003312 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003313 // Already in error state, do nothing
3314 return;
3315 }
3316
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003317 QCBORError uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003318 QCBORItem Item;
3319
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003320 uError = QCBORDecode_GetNext(pMe, &Item);
3321 if(uError != QCBOR_SUCCESS) {
3322 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003323 return;
3324 }
3325
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003326 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, Item.uDataType);
3327
3328 if(pMe->uLastError == QCBOR_SUCCESS) {
3329 *pBstr = Item.val.string;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003330 }
3331}
3332
Laurence Lundbladec4537442020-04-14 18:53:22 -07003333
3334
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003335
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003336static QCBORError ProcessBigNum(uint8_t uTagRequirement,
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003337 const QCBORItem *pItem,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003338 UsefulBufC *pValue,
3339 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003340{
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003341 const TagSpecification TagSpec =
3342 {
3343 uTagRequirement,
3344 {QCBOR_TYPE_POSBIGNUM, QCBOR_TYPE_NEGBIGNUM, QCBOR_TYPE_NONE},
3345 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3346 };
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003347
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003348 QCBORError uErr = CheckTagRequirement(TagSpec, pItem->uDataType);
3349 if(uErr != QCBOR_SUCCESS) {
3350 return uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003351 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003352
3353 *pValue = pItem->val.string;
3354
3355 if(pItem->uDataType == QCBOR_TYPE_POSBIGNUM) {
3356 *pbIsNegative = false;
3357 } else if(pItem->uDataType == QCBOR_TYPE_NEGBIGNUM) {
3358 *pbIsNegative = true;
3359 }
3360
3361 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003362}
3363
3364
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003365/*
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003366 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003367 */
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003368void QCBORDecode_GetBignum(QCBORDecodeContext *pMe,
3369 uint8_t uTagRequirement,
3370 UsefulBufC *pValue,
3371 bool *pbIsNegative)
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003372{
3373 if(pMe->uLastError != QCBOR_SUCCESS) {
3374 // Already in error state, do nothing
3375 return;
3376 }
3377
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003378 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003379 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
3380 if(uError != QCBOR_SUCCESS) {
3381 pMe->uLastError = (uint8_t)uError;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003382 return;
3383 }
3384
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003385 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003386}
3387
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003388
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003389/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003390 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003391*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003392void QCBORDecode_GetBignumInMapN(QCBORDecodeContext *pMe,
3393 int64_t nLabel,
3394 uint8_t uTagRequirement,
3395 UsefulBufC *pValue,
3396 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003397{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003398 QCBORItem Item;
3399 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003400 if(pMe->uLastError != QCBOR_SUCCESS) {
3401 return;
3402 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003403
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003404 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundbladec4537442020-04-14 18:53:22 -07003405}
3406
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003407
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003408/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003409 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003410*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003411void QCBORDecode_GetBignumInMapSZ(QCBORDecodeContext *pMe,
3412 const char *szLabel,
3413 uint8_t uTagRequirement,
3414 UsefulBufC *pValue,
3415 bool *pbIsNegative)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003416{
3417 QCBORItem Item;
3418 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003419 if(pMe->uLastError != QCBOR_SUCCESS) {
3420 return;
3421 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003422
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003423 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003424}
3425
3426
3427
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003428
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003429// Semi private
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003430QCBORError QCBORDecode_GetMIMEInternal(uint8_t uTagRequirement,
3431 const QCBORItem *pItem,
3432 UsefulBufC *pMessage,
3433 bool *pbIsNot7Bit)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003434{
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003435 const TagSpecification TagSpecText =
3436 {
3437 uTagRequirement,
3438 {QCBOR_TYPE_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3439 {QCBOR_TYPE_TEXT_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3440 };
3441 const TagSpecification TagSpecBinary =
3442 {
3443 uTagRequirement,
3444 {QCBOR_TYPE_BINARY_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3445 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3446 };
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003447
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003448 QCBORError uReturn;
3449
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003450 if(CheckTagRequirement(TagSpecText, pItem->uDataType) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003451 *pMessage = pItem->val.string;
3452 if(pbIsNot7Bit != NULL) {
3453 *pbIsNot7Bit = false;
3454 }
3455 uReturn = QCBOR_SUCCESS;
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003456 } else if(CheckTagRequirement(TagSpecBinary, pItem->uDataType) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003457 *pMessage = pItem->val.string;
3458 if(pbIsNot7Bit != NULL) {
3459 *pbIsNot7Bit = true;
3460 }
3461 uReturn = QCBOR_SUCCESS;
3462
3463 } else {
3464 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
3465 }
3466
3467 return uReturn;
3468}
3469
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003470// Improvement: add methods for wrapped CBOR, a simple alternate to EnterBstrWrapped
3471
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003472
3473
3474
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07003475#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladee6430642020-03-14 21:15:44 -07003476
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003477typedef QCBORError (*fExponentiator)(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003478
3479
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003480// The exponentiator that works on only positive numbers
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003481static QCBORError Exponentitate10(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003482{
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003483 uint64_t uResult = uMantissa;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003484
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003485 if(uResult != 0) {
3486 /* This loop will run a maximum of 19 times because
3487 * UINT64_MAX < 10 ^^ 19. More than that will cause
3488 * exit with the overflow error
3489 */
3490 for(; nExponent > 0; nExponent--) {
3491 if(uResult > UINT64_MAX / 10) {
3492 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
3493 }
3494 uResult = uResult * 10;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003495 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003496
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003497 for(; nExponent < 0; nExponent++) {
3498 uResult = uResult / 10;
3499 if(uResult == 0) {
3500 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
3501 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003502 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003503 }
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003504 /* else, mantissa is zero so this returns zero */
Laurence Lundbladec4537442020-04-14 18:53:22 -07003505
3506 *puResult = uResult;
3507
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003508 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003509}
3510
3511
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003512// The exponentiator that works on only positive numbers
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003513static QCBORError Exponentitate2(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003514{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003515 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003516
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003517 uResult = uMantissa;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003518
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003519 /* This loop will run a maximum of 64 times because
Laurence Lundbladee6430642020-03-14 21:15:44 -07003520 * INT64_MAX < 2^31. More than that will cause
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003521 * exit with the overflow error
Laurence Lundbladee6430642020-03-14 21:15:44 -07003522 */
3523 while(nExponent > 0) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003524 if(uResult > UINT64_MAX >> 1) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003525 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
Laurence Lundbladee6430642020-03-14 21:15:44 -07003526 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003527 uResult = uResult << 1;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003528 nExponent--;
3529 }
3530
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003531 while(nExponent < 0 ) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003532 if(uResult == 0) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003533 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
3534 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003535 uResult = uResult >> 1;
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003536 nExponent++;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003537 }
3538
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003539 *puResult = uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003540
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003541 return QCBOR_SUCCESS;
3542}
3543
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003544
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003545/*
3546 Compute value with signed mantissa and signed result. Works with exponent of 2 or 10 based on exponentiator.
3547 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003548static inline QCBORError ExponentiateNN(int64_t nMantissa,
3549 int64_t nExponent,
3550 int64_t *pnResult,
3551 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003552{
3553 uint64_t uResult;
3554
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003555 // Take the absolute value of the mantissa and convert to unsigned.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07003556 // Improvement: this should be possible in one instruction
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003557 uint64_t uMantissa = nMantissa > 0 ? (uint64_t)nMantissa : (uint64_t)-nMantissa;
3558
3559 // Do the exponentiation of the positive mantissa
3560 QCBORError uReturn = (*pfExp)(uMantissa, nExponent, &uResult);
3561 if(uReturn) {
3562 return uReturn;
3563 }
3564
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003565
Laurence Lundblade983500d2020-05-14 11:49:34 -07003566 /* (uint64_t)INT64_MAX+1 is used to represent the absolute value
3567 of INT64_MIN. This assumes two's compliment representation where
3568 INT64_MIN is one increment farther from 0 than INT64_MAX.
3569 Trying to write -INT64_MIN doesn't work to get this because the
3570 compiler tries to work with an int64_t which can't represent
3571 -INT64_MIN.
3572 */
3573 uint64_t uMax = nMantissa > 0 ? INT64_MAX : (uint64_t)INT64_MAX+1;
3574
3575 // Error out if too large
3576 if(uResult > uMax) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003577 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3578 }
3579
3580 // Casts are safe because of checks above
3581 *pnResult = nMantissa > 0 ? (int64_t)uResult : -(int64_t)uResult;
3582
3583 return QCBOR_SUCCESS;
3584}
3585
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003586
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003587/*
3588 Compute value with signed mantissa and unsigned result. Works with exponent of 2 or 10 based on exponentiator.
3589 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003590static inline QCBORError ExponentitateNU(int64_t nMantissa,
3591 int64_t nExponent,
3592 uint64_t *puResult,
3593 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003594{
3595 if(nMantissa < 0) {
3596 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
3597 }
3598
3599 // Cast to unsigned is OK because of check for negative
3600 // Cast to unsigned is OK because UINT64_MAX > INT64_MAX
3601 // Exponentiation is straight forward
3602 return (*pfExp)((uint64_t)nMantissa, nExponent, puResult);
3603}
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003604
3605
3606/*
3607 Compute value with signed mantissa and unsigned result. Works with exponent of 2 or 10 based on exponentiator.
3608 */
3609static inline QCBORError ExponentitateUU(uint64_t uMantissa,
3610 int64_t nExponent,
3611 uint64_t *puResult,
3612 fExponentiator pfExp)
3613{
3614 return (*pfExp)(uMantissa, nExponent, puResult);
3615}
3616
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07003617#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
3618
3619
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003620
3621
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003622
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003623static QCBORError ConvertBigNumToUnsigned(const UsefulBufC BigNum, uint64_t uMax, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003624{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003625 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003626
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003627 uResult = 0;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003628 const uint8_t *pByte = BigNum.ptr;
3629 size_t uLen = BigNum.len;
3630 while(uLen--) {
Laurence Lundblade313b2862020-05-16 01:23:06 -07003631 if(uResult > (uMax >> 8)) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003632 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003633 }
Laurence Lundblade313b2862020-05-16 01:23:06 -07003634 uResult = (uResult << 8) + *pByte++;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003635 }
3636
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003637 *pResult = uResult;
3638 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003639}
3640
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003641
Laurence Lundblade887add82020-05-17 05:50:34 -07003642static inline QCBORError ConvertPositiveBigNumToUnsigned(const UsefulBufC BigNum, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003643{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003644 return ConvertBigNumToUnsigned(BigNum, UINT64_MAX, pResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003645}
3646
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003647
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003648static inline QCBORError ConvertPositiveBigNumToSigned(const UsefulBufC BigNum, int64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003649{
3650 uint64_t uResult;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003651 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
3652 if(uError) {
3653 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003654 }
3655 /* Cast is safe because ConvertBigNum is told to limit to INT64_MAX */
3656 *pResult = (int64_t)uResult;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003657 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003658}
3659
3660
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003661static inline QCBORError ConvertNegativeBigNumToSigned(const UsefulBufC BigNum, int64_t *pnResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003662{
3663 uint64_t uResult;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003664 /* The negative integer furthest from zero for a C int64_t is
3665 INT64_MIN which is expressed as -INT64_MAX - 1. The value of a
3666 negative number in CBOR is computed as -n - 1 where n is the
3667 encoded integer, where n is what is in the variable BigNum. When
3668 converting BigNum to a uint64_t, the maximum value is thus
3669 INT64_MAX, so that when it -n - 1 is applied to it the result will
3670 never be further from 0 than INT64_MIN.
Laurence Lundbladeda095972020-06-06 18:35:33 -07003671
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003672 -n - 1 <= INT64_MIN.
3673 -n - 1 <= -INT64_MAX - 1
3674 n <= INT64_MAX.
3675 */
Laurence Lundbladeda095972020-06-06 18:35:33 -07003676 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003677 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003678 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003679 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003680
3681 /// Now apply -n - 1. The cast is safe because
3682 // ConvertBigNumToUnsigned() is limited to INT64_MAX which does fit
3683 // is the largest positive integer that an int64_t can
3684 // represent. */
3685 *pnResult = -(int64_t)uResult - 1;
3686
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003687 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003688}
3689
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07003690
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07003691
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07003692
Laurence Lundbladef6c86662020-05-12 02:08:00 -07003693#include "fenv.h"
Laurence Lundbladec4537442020-04-14 18:53:22 -07003694
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003695
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003696/*
3697Convert a integers and floats to an int64_t.
3698
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003699\param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003700
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003701\retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003702
3703\retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
3704
3705\retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large or too small.
3706
3707*/
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003708static QCBORError ConvertInt64(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003709{
3710 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07003711 case QCBOR_TYPE_FLOAT:
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003712 case QCBOR_TYPE_DOUBLE:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07003713#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003714 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003715 // TODO: what about under/overflow here?
3716 // Invokes the floating-point HW and/or compiler-added libraries
3717 feclearexcept(FE_ALL_EXCEPT);
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07003718 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
3719 *pnValue = llround(pItem->val.dfnum);
3720 } else {
3721 *pnValue = lroundf(pItem->val.fnum);
3722 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003723 if(fetestexcept(FE_INVALID)) {
3724 // TODO: better error code
3725 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3726 }
3727 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003728 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003729 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07003730#else
3731 return QCBOR_ERR_HW_FLOAT_DISABLED;
3732#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003733 break;
3734
3735 case QCBOR_TYPE_INT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003736 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003737 *pnValue = pItem->val.int64;
3738 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003739 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003740 }
3741 break;
3742
3743 case QCBOR_TYPE_UINT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003744 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003745 if(pItem->val.uint64 < INT64_MAX) {
3746 *pnValue = pItem->val.int64;
3747 } else {
3748 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3749 }
3750 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003751 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003752 }
3753 break;
3754
3755 default:
3756 return QCBOR_ERR_UNEXPECTED_TYPE;
3757 }
3758 return QCBOR_SUCCESS;
3759}
3760
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003761
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003762void QCBORDecode_GetInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003763 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003764 int64_t *pnValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003765 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003766{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003767 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003768 return;
3769 }
3770
Laurence Lundbladee6430642020-03-14 21:15:44 -07003771 QCBORItem Item;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003772 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
3773 if(uError) {
3774 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003775 return;
3776 }
3777
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003778 if(pItem) {
3779 *pItem = Item;
3780 }
3781
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003782 pMe->uLastError = (uint8_t)ConvertInt64(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003783}
3784
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003785
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003786void QCBORDecode_GetInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
3787 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003788 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003789 int64_t *pnValue,
3790 QCBORItem *pItem)
3791{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003792 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003793 if(pMe->uLastError != QCBOR_SUCCESS) {
3794 return;
3795 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003796
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003797 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003798}
3799
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003800
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003801void QCBORDecode_GetInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
3802 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003803 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003804 int64_t *pnValue,
3805 QCBORItem *pItem)
3806{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003807 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003808 if(pMe->uLastError != QCBOR_SUCCESS) {
3809 return;
3810 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003811
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003812 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003813}
3814
3815
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003816/*
3817 Convert a large variety of integer types to an int64_t.
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003818
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003819 \param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003820
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003821 \retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003822
3823 \retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
3824
3825 \retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large or too small.
3826
3827 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003828static QCBORError Int64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003829{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003830 switch(pItem->uDataType) {
3831
3832 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003833 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003834 return ConvertPositiveBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003835 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003836 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003837 }
3838 break;
3839
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003840 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003841 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003842 return ConvertNegativeBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003843 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003844 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003845 }
3846 break;
3847
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003848#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
3849 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003850 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003851 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003852 pItem->val.expAndMantissa.nExponent,
3853 pnValue,
3854 &Exponentitate10);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003855 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003856 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003857 }
3858 break;
3859
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003860 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003861 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003862 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003863 pItem->val.expAndMantissa.nExponent,
3864 pnValue,
3865 Exponentitate2);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003866 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003867 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003868 }
3869 break;
3870
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003871 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003872 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07003873 int64_t nMantissa;
3874 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003875 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
3876 if(uErr) {
3877 return uErr;
3878 }
3879 return ExponentiateNN(nMantissa,
3880 pItem->val.expAndMantissa.nExponent,
3881 pnValue,
3882 Exponentitate10);
3883 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003884 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003885 }
3886 break;
3887
3888 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003889 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07003890 int64_t nMantissa;
3891 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003892 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
3893 if(uErr) {
3894 return uErr;
3895 }
3896 return ExponentiateNN(nMantissa,
3897 pItem->val.expAndMantissa.nExponent,
3898 pnValue,
3899 Exponentitate10);
3900 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003901 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003902 }
3903 break;
3904
3905 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003906 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07003907 int64_t nMantissa;
3908 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003909 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
3910 if(uErr) {
3911 return uErr;
3912 }
3913 return ExponentiateNN(nMantissa,
3914 pItem->val.expAndMantissa.nExponent,
3915 pnValue,
3916 Exponentitate2);
3917 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003918 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003919 }
3920 break;
3921
3922 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003923 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07003924 int64_t nMantissa;
3925 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003926 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
3927 if(uErr) {
3928 return uErr;
3929 }
3930 return ExponentiateNN(nMantissa,
3931 pItem->val.expAndMantissa.nExponent,
3932 pnValue,
3933 Exponentitate2);
3934 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003935 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003936 }
3937 break;
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07003938#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
3939
Laurence Lundbladee6430642020-03-14 21:15:44 -07003940
Laurence Lundbladec4537442020-04-14 18:53:22 -07003941 default:
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07003942 return QCBOR_ERR_UNEXPECTED_TYPE; }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003943}
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003944
3945
Laurence Lundbladec4537442020-04-14 18:53:22 -07003946/*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003947 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003948 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003949void QCBORDecode_GetInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003950{
3951 QCBORItem Item;
3952
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003953 QCBORDecode_GetInt64ConvertInternal(pMe, uConvertTypes, pnValue, &Item);
Laurence Lundbladec4537442020-04-14 18:53:22 -07003954
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003955 if(pMe->uLastError == QCBOR_SUCCESS) {
3956 // The above conversion succeeded
3957 return;
3958 }
3959
Laurence Lundbladef6c86662020-05-12 02:08:00 -07003960 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003961 // The above conversion failed in a way that code below can't correct
Laurence Lundbladec4537442020-04-14 18:53:22 -07003962 return;
3963 }
3964
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003965 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003966}
3967
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003968
3969/*
3970Public function, see header qcbor/qcbor_decode.h file
3971*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003972void QCBORDecode_GetInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
3973 int64_t nLabel,
3974 uint32_t uConvertTypes,
3975 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003976{
3977 QCBORItem Item;
3978
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003979 QCBORDecode_GetInt64ConvertInternalInMapN(pMe, nLabel, uConvertTypes, pnValue, &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003980
3981 if(pMe->uLastError == QCBOR_SUCCESS) {
3982 // The above conversion succeeded
3983 return;
3984 }
3985
3986 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
3987 // The above conversion failed in a way that code below can't correct
3988 return;
3989 }
3990
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003991 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003992}
3993
3994
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003995/*
3996Public function, see header qcbor/qcbor_decode.h file
3997*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003998void QCBORDecode_GetInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
3999 const char *szLabel,
4000 uint32_t uConvertTypes,
4001 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004002{
4003 QCBORItem Item;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004004 QCBORDecode_GetInt64ConvertInternalInMapSZ(pMe, szLabel, uConvertTypes, pnValue, &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004005
4006 if(pMe->uLastError == QCBOR_SUCCESS) {
4007 // The above conversion succeeded
4008 return;
4009 }
4010
4011 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4012 // The above conversion failed in a way that code below can't correct
4013 return;
4014 }
4015
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004016 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004017}
4018
4019
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004020static QCBORError ConvertUint64(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004021{
4022 switch(pItem->uDataType) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004023 case QCBOR_TYPE_DOUBLE:
4024 case QCBOR_TYPE_FLOAT:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004025#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004026 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
4027 // TODO: this code needs work
4028 feclearexcept(FE_ALL_EXCEPT);
4029 double dRounded = round(pItem->val.dfnum);
4030 // TODO: over/underflow
4031 if(fetestexcept(FE_INVALID)) {
4032 // TODO: better error code
4033 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4034 } else if(isnan(dRounded)) {
4035 // TODO: better error code
4036 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4037 } else if(dRounded >= 0) {
4038 *puValue = (uint64_t)dRounded;
4039 } else {
4040 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4041 }
4042 } else {
4043 return QCBOR_ERR_UNEXPECTED_TYPE;
4044 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004045#else
4046 return QCBOR_ERR_HW_FLOAT_DISABLED;
4047#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004048 break;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004049
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004050 case QCBOR_TYPE_INT64:
4051 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4052 if(pItem->val.int64 >= 0) {
4053 *puValue = (uint64_t)pItem->val.int64;
4054 } else {
4055 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4056 }
4057 } else {
4058 return QCBOR_ERR_UNEXPECTED_TYPE;
4059 }
4060 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004061
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004062 case QCBOR_TYPE_UINT64:
4063 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4064 *puValue = pItem->val.uint64;
4065 } else {
4066 return QCBOR_ERR_UNEXPECTED_TYPE;
4067 }
4068 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004069
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004070 default:
4071 return QCBOR_ERR_UNEXPECTED_TYPE;
4072 }
4073
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004074 return QCBOR_SUCCESS;
4075}
Laurence Lundbladec4537442020-04-14 18:53:22 -07004076
4077
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004078void QCBORDecode_GetUInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004079 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004080 uint64_t *puValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004081 QCBORItem *pItem)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004082{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004083 if(pMe->uLastError != QCBOR_SUCCESS) {
4084 return;
4085 }
4086
Laurence Lundbladec4537442020-04-14 18:53:22 -07004087 QCBORItem Item;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004088
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004089 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4090 if(uError) {
4091 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004092 return;
4093 }
4094
Laurence Lundbladea826c502020-05-10 21:07:00 -07004095 if(pItem) {
4096 *pItem = Item;
4097 }
4098
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004099 pMe->uLastError = (uint8_t)ConvertUint64(&Item, uConvertTypes, puValue);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004100}
4101
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004102
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004103void QCBORDecode_GetUint64ConvertInternalInMapN(QCBORDecodeContext *pMe,
4104 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004105 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004106 uint64_t *puValue,
4107 QCBORItem *pItem)
4108{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004109 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004110 if(pMe->uLastError != QCBOR_SUCCESS) {
4111 return;
4112 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004113
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004114 pMe->uLastError = (uint8_t)ConvertUint64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004115}
4116
4117
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004118void QCBORDecode_GetUInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004119 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004120 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004121 uint64_t *puValue,
4122 QCBORItem *pItem)
4123{
4124 if(pMe->uLastError != QCBOR_SUCCESS) {
4125 return;
4126 }
4127
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004128 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004129 if(pMe->uLastError != QCBOR_SUCCESS) {
4130 return;
4131 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004132
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004133 pMe->uLastError = (uint8_t)ConvertUint64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004134}
4135
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004136
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004137/*
4138 Public function, see header qcbor/qcbor_decode.h file
4139*/
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004140static QCBORError Uint64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004141{
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004142 switch(pItem->uDataType) {
4143
4144 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004145 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004146 return ConvertPositiveBigNumToUnsigned(pItem->val.bigNum, puValue);
4147 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004148 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004149 }
4150 break;
4151
4152 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004153 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004154 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4155 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004156 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004157 }
4158 break;
4159
4160#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
4161
4162 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004163 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004164 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004165 pItem->val.expAndMantissa.nExponent,
4166 puValue,
4167 Exponentitate10);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004168 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004169 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004170 }
4171 break;
4172
4173 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004174 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004175 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
4176 pItem->val.expAndMantissa.nExponent,
4177 puValue,
4178 Exponentitate2);
4179 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004180 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004181 }
4182 break;
4183
4184 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004185 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004186 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004187 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004188 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004189 if(uErr != QCBOR_SUCCESS) {
4190 return uErr;
4191 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004192 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004193 pItem->val.expAndMantissa.nExponent,
4194 puValue,
4195 Exponentitate10);
4196 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004197 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004198 }
4199 break;
4200
4201 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004202 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004203 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4204 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004205 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004206 }
4207 break;
4208
4209 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004210 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004211 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004212 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004213 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004214 if(uErr != QCBOR_SUCCESS) {
4215 return uErr;
4216 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004217 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004218 pItem->val.expAndMantissa.nExponent,
4219 puValue,
4220 Exponentitate2);
4221 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004222 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004223 }
4224 break;
4225
4226 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004227 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004228 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4229 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004230 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004231 }
4232 break;
4233#endif
4234 default:
4235 return QCBOR_ERR_UNEXPECTED_TYPE;
4236 }
4237}
4238
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004239
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004240/*
4241 Public function, see header qcbor/qcbor_decode.h file
4242*/
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004243void QCBORDecode_GetUInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004244{
4245 QCBORItem Item;
4246
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004247 QCBORDecode_GetUInt64ConvertInternal(pMe, uConvertTypes, puValue, &Item);
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004248
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004249 if(pMe->uLastError == QCBOR_SUCCESS) {
4250 // The above conversion succeeded
4251 return;
4252 }
4253
4254 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4255 // The above conversion failed in a way that code below can't correct
Laurence Lundbladee6430642020-03-14 21:15:44 -07004256 return;
4257 }
4258
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004259 pMe->uLastError = (uint8_t)Uint64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004260}
4261
Laurence Lundbladec4537442020-04-14 18:53:22 -07004262
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004263/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004264 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004265*/
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004266void QCBORDecode_GetUint64ConvertAllInMapN(QCBORDecodeContext *pMe, int64_t nLabel, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004267{
4268 QCBORItem Item;
4269
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004270 QCBORDecode_GetUint64ConvertInternalInMapN(pMe, nLabel, uConvertTypes, puValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004271
4272 if(pMe->uLastError == QCBOR_SUCCESS) {
4273 // The above conversion succeeded
4274 return;
4275 }
4276
4277 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4278 // The above conversion failed in a way that code below can't correct
4279 return;
4280 }
4281
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004282 pMe->uLastError = (uint8_t)Uint64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004283}
4284
4285
4286/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004287 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004288*/
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004289void QCBORDecode_GetUint64ConvertAllInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004290{
4291 QCBORItem Item;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004292 QCBORDecode_GetUInt64ConvertInternalInMapSZ(pMe, szLabel, uConvertTypes, puValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004293
4294 if(pMe->uLastError == QCBOR_SUCCESS) {
4295 // The above conversion succeeded
4296 return;
4297 }
4298
4299 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4300 // The above conversion failed in a way that code below can't correct
4301 return;
4302 }
4303
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004304 pMe->uLastError = (uint8_t)Uint64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004305}
4306
4307
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004308static QCBORError ConvertDouble(const QCBORItem *pItem, uint32_t uConvertTypes, double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004309{
4310 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004311 case QCBOR_TYPE_FLOAT:
4312#ifndef QCBOR_DISABLE_FLOAT_HW_USE
4313 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
4314 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
4315 *pdValue = (double)pItem->val.fnum;
4316 } else {
4317 return QCBOR_ERR_UNEXPECTED_TYPE;
4318 }
4319 }
4320#else
4321 return QCBOR_ERR_HW_FLOAT_DISABLED;
4322#endif
4323 break;
4324
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004325 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004326 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
4327 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004328 *pdValue = pItem->val.dfnum;
4329 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004330 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004331 }
4332 }
4333 break;
4334
4335 case QCBOR_TYPE_INT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004336#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004337 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004338 // TODO: how does this work?
4339 *pdValue = (double)pItem->val.int64;
4340
4341 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004342 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004343 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004344#else
4345 return QCBOR_ERR_HW_FLOAT_DISABLED;
4346#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004347 break;
4348
4349 case QCBOR_TYPE_UINT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004350#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004351 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004352 *pdValue = (double)pItem->val.uint64;
4353 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004354 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004355 }
4356 break;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004357#else
4358 return QCBOR_ERR_HW_FLOAT_DISABLED;
4359#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004360
4361 default:
4362 return QCBOR_ERR_UNEXPECTED_TYPE;
4363 }
4364
4365 return QCBOR_SUCCESS;
4366}
4367
4368
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004369void QCBORDecode_GetDoubleConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004370 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004371 double *pdValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004372 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004373{
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004374 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004375 return;
4376 }
4377
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004378 QCBORItem Item;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004379
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004380 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004381 if(uError) {
4382 pMe->uLastError = (uint8_t)uError;
4383 return;
4384 }
4385
4386 if(pItem) {
4387 *pItem = Item;
4388 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004389
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004390 pMe->uLastError = (uint8_t)ConvertDouble(&Item, uConvertTypes, pdValue);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004391}
Laurence Lundbladec4537442020-04-14 18:53:22 -07004392
Laurence Lundbladec4537442020-04-14 18:53:22 -07004393
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004394void QCBORDecode_GetDoubleConvertInternalInMapN(QCBORDecodeContext *pMe,
4395 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004396 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004397 double *pdValue,
4398 QCBORItem *pItem)
4399{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004400 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004401 if(pMe->uLastError != QCBOR_SUCCESS) {
4402 return;
4403 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004404
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004405 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004406}
4407
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004408
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004409void QCBORDecode_GetDoubleConvertInternalInMapSZ(QCBORDecodeContext *pMe,
4410 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004411 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004412 double *pdValue,
4413 QCBORItem *pItem)
4414{
4415 if(pMe->uLastError != QCBOR_SUCCESS) {
4416 return;
4417 }
4418
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004419 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004420 if(pMe->uLastError != QCBOR_SUCCESS) {
4421 return;
4422 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004423
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004424 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004425}
4426
4427
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004428#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004429static double ConvertBigNumToDouble(const UsefulBufC BigNum)
4430{
4431 double dResult;
4432
4433 dResult = 0.0;
4434 const uint8_t *pByte = BigNum.ptr;
4435 size_t uLen = BigNum.len;
4436 /* This will overflow and become the float value INFINITY if the number
4437 is too large to fit. No error will be logged.
4438 TODO: should an error be logged? */
4439 while(uLen--) {
4440 dResult = (dResult * 256.0) + (double)*pByte++;
4441 }
4442
4443 return dResult;
4444}
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004445#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
4446
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004447
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004448static QCBORError DoubleConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, double *pdValue)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004449{
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004450#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004451 /*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004452 https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html
4453
4454 */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004455 switch(pItem->uDataType) {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004456
4457#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004458 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004459 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004460 // TODO: rounding and overflow errors
4461 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
4462 pow(10.0, (double)pItem->val.expAndMantissa.nExponent);
4463 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004464 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004465 }
4466 break;
4467
4468 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004469 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT ) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004470 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
4471 exp2((double)pItem->val.expAndMantissa.nExponent);
4472 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004473 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004474 }
4475 break;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004476#endif /* ndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004477
4478 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004479 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004480 *pdValue = ConvertBigNumToDouble(pItem->val.bigNum);
4481 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004482 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004483 }
4484 break;
4485
4486 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004487 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07004488 *pdValue = -1-ConvertBigNumToDouble(pItem->val.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004489 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004490 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004491 }
4492 break;
4493
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004494#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004495 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004496 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004497 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
4498 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
4499 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004500 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004501 }
4502 break;
4503
4504 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004505 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004506 double dMantissa = -ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
4507 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
4508 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004509 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004510 }
4511 break;
4512
4513 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004514 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004515 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
4516 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
4517 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004518 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004519 }
4520 break;
4521
4522 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004523 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07004524 double dMantissa = -1-ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004525 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
4526 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004527 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004528 }
4529 break;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004530#endif /* ndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
4531
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004532
4533 default:
4534 return QCBOR_ERR_UNEXPECTED_TYPE;
4535 }
4536
4537 return QCBOR_SUCCESS;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004538
4539#else
4540 (void)pItem;
4541 (void)uConvertTypes;
4542 (void)pdValue;
4543 return QCBOR_ERR_HW_FLOAT_DISABLED;
4544#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
4545
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004546}
4547
4548
4549/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004550 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004551*/
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004552void QCBORDecode_GetDoubleConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004553{
4554
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004555 QCBORItem Item;
4556
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004557 QCBORDecode_GetDoubleConvertInternal(pMe, uConvertTypes, pdValue, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004558
4559 if(pMe->uLastError == QCBOR_SUCCESS) {
4560 // The above conversion succeeded
4561 return;
4562 }
4563
4564 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4565 // The above conversion failed in a way that code below can't correct
4566 return;
4567 }
4568
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004569 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004570}
4571
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004572
4573/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004574 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004575*/
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004576void QCBORDecode_GetDoubleConvertAllInMapN(QCBORDecodeContext *pMe, int64_t nLabel, uint32_t uConvertTypes, double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004577{
4578 QCBORItem Item;
4579
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004580 QCBORDecode_GetDoubleConvertInternalInMapN(pMe, nLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004581
4582 if(pMe->uLastError == QCBOR_SUCCESS) {
4583 // The above conversion succeeded
4584 return;
4585 }
4586
4587 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4588 // The above conversion failed in a way that code below can't correct
4589 return;
4590 }
4591
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004592 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004593}
4594
4595
4596/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004597 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004598*/
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004599void QCBORDecode_GetDoubleConvertAllInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, uint32_t uConvertTypes, double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004600{
4601 QCBORItem Item;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004602 QCBORDecode_GetDoubleConvertInternalInMapSZ(pMe, szLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004603
4604 if(pMe->uLastError == QCBOR_SUCCESS) {
4605 // The above conversion succeeded
4606 return;
4607 }
4608
4609 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4610 // The above conversion failed in a way that code below can't correct
4611 return;
4612 }
4613
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004614 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004615}
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004616
4617
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004618
4619
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004620#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004621static inline UsefulBufC ConvertIntToBigNum(uint64_t uInt, UsefulBuf Buffer)
4622{
4623 while((uInt & 0xff00000000000000UL) == 0) {
4624 uInt = uInt << 8;
4625 };
4626
4627 UsefulOutBuf UOB;
4628
4629 UsefulOutBuf_Init(&UOB, Buffer);
4630
4631 while(uInt) {
4632 const uint64_t xx = uInt & 0xff00000000000000UL;
4633 UsefulOutBuf_AppendByte(&UOB, (uint8_t)((uInt & 0xff00000000000000UL) >> 56));
4634 uInt = uInt << 8;
4635 (void)xx;
4636 }
4637
4638 return UsefulOutBuf_OutUBuf(&UOB);
4639}
4640
4641
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004642static QCBORError MantissaAndExponentTypeHandler(QCBORDecodeContext *pMe,
4643 TagSpecification TagSpec,
4644 QCBORItem *pItem)
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004645{
4646 QCBORError uErr;
4647 // Loops runs at most 1.5 times. Making it a loop saves object code.
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004648 while(1) {
4649 uErr = CheckTagRequirement(TagSpec, pItem->uDataType);
4650 if(uErr != QCBOR_SUCCESS) {
4651 goto Done;
4652 }
4653
4654 if(pItem->uDataType != QCBOR_TYPE_ARRAY) {
4655 break; // Successful exit. Moving on to finish decoding.
4656 }
4657
4658 // The item is an array, which means an undecoded
4659 // mantissa and exponent, so decode it. It will then
4660 // have a different type and exit the loop if.
4661 uErr = QCBORDecode_MantissaAndExponent(pMe, pItem);
4662 if(uErr != QCBOR_SUCCESS) {
4663 goto Done;
4664 }
4665
4666 // Second time around, the type must match.
4667 TagSpec.uTagRequirement = QCBOR_TAG_REQUIREMENT_MATCH_TAG;
4668 }
4669Done:
4670 return uErr;
4671}
4672
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004673
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004674static void ProcessMantissaAndExponent(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004675 TagSpecification TagSpec,
4676 QCBORItem *pItem,
4677 int64_t *pnMantissa,
4678 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004679{
4680 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004681
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004682 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004683 if(uErr != QCBOR_SUCCESS) {
4684 goto Done;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004685 }
4686
4687 switch (pItem->uDataType) {
4688
4689 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004690 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004691 *pnMantissa = pItem->val.expAndMantissa.Mantissa.nInt;
4692 *pnExponent = pItem->val.expAndMantissa.nExponent;
4693 break;
4694
4695 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004696 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004697 *pnExponent = pItem->val.expAndMantissa.nExponent;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004698 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004699 break;
4700
4701 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004702 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004703 *pnExponent = pItem->val.expAndMantissa.nExponent;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004704 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004705 break;
4706
4707 default:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004708 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004709 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004710
4711 Done:
4712 pMe->uLastError = (uint8_t)uErr;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004713}
4714
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004715
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004716static void ProcessMantissaAndExponentBig(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004717 TagSpecification TagSpec,
4718 QCBORItem *pItem,
4719 UsefulBuf BufferForMantissa,
4720 UsefulBufC *pMantissa,
4721 bool *pbIsNegative,
4722 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004723{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004724 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004725
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004726 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004727 if(uErr != QCBOR_SUCCESS) {
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004728 goto Done;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004729 }
4730
4731 uint64_t uMantissa;
4732
4733 switch (pItem->uDataType) {
4734
4735 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004736 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004737 if(pItem->val.expAndMantissa.Mantissa.nInt >= 0) {
4738 uMantissa = (uint64_t)pItem->val.expAndMantissa.Mantissa.nInt;
4739 *pbIsNegative = false;
4740 } else {
4741 uMantissa = (uint64_t)-pItem->val.expAndMantissa.Mantissa.nInt;
4742 *pbIsNegative = true;
4743 }
4744 *pMantissa = ConvertIntToBigNum(uMantissa, BufferForMantissa);
4745 *pnExponent = pItem->val.expAndMantissa.nExponent;
4746 break;
4747
4748 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004749 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004750 *pnExponent = pItem->val.expAndMantissa.nExponent;
4751 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
4752 *pbIsNegative = false;
4753 break;
4754
4755 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004756 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004757 *pnExponent = pItem->val.expAndMantissa.nExponent;
4758 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
4759 *pbIsNegative = true;
4760 break;
4761
4762 default:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004763 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004764 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004765
4766Done:
4767 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004768}
4769
4770
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004771/*
4772 Public function, see header qcbor/qcbor_decode.h file
4773*/
4774void QCBORDecode_GetDecimalFraction(QCBORDecodeContext *pMe,
4775 uint8_t uTagRequirement,
4776 int64_t *pnMantissa,
4777 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004778{
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004779 if(pMe->uLastError != QCBOR_SUCCESS) {
4780 return;
4781 }
4782
4783 QCBORItem Item;
4784 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4785 if(uError) {
4786 pMe->uLastError = (uint8_t)uError;
4787 return;
4788 }
4789
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004790 const TagSpecification TagSpec =
4791 {
4792 uTagRequirement,
4793 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
4794 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
4795 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004796
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004797 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004798}
4799
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004800
4801/*
4802 Public function, see header qcbor/qcbor_decode.h file
4803*/
4804void QCBORDecode_GetDecimalFractionInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004805 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004806 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004807 int64_t *pnMantissa,
4808 int64_t *pnExponent)
4809{
4810 if(pMe->uLastError != QCBOR_SUCCESS) {
4811 return;
4812 }
4813
4814 QCBORItem Item;
4815 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
4816
4817 const TagSpecification TagSpec =
4818 {
4819 uTagRequirement,
4820 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
4821 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
4822 };
4823
4824 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
4825}
4826
4827
4828/*
4829 Public function, see header qcbor/qcbor_decode.h file
4830*/
4831void QCBORDecode_GetDecimalFractionInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004832 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004833 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004834 int64_t *pnMantissa,
4835 int64_t *pnExponent)
4836{
4837 if(pMe->uLastError != QCBOR_SUCCESS) {
4838 return;
4839 }
4840
4841 QCBORItem Item;
4842 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
4843
4844 const TagSpecification TagSpec =
4845 {
4846 uTagRequirement,
4847 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
4848 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
4849 };
4850
4851 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
4852}
4853
4854
4855/*
4856 Public function, see header qcbor/qcbor_decode.h file
4857*/
4858void QCBORDecode_GetDecimalFractionBig(QCBORDecodeContext *pMe,
4859 uint8_t uTagRequirement,
4860 UsefulBuf MantissaBuffer,
4861 UsefulBufC *pMantissa,
4862 bool *pbMantissaIsNegative,
4863 int64_t *pnExponent)
4864{
4865 if(pMe->uLastError != QCBOR_SUCCESS) {
4866 return;
4867 }
4868
4869 QCBORItem Item;
4870 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4871 if(uError) {
4872 pMe->uLastError = (uint8_t)uError;
4873 return;
4874 }
4875
4876 const TagSpecification TagSpec =
4877 {
4878 uTagRequirement,
4879 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
4880 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
4881 };
4882
4883 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, MantissaBuffer, pMantissa, pbMantissaIsNegative, pnExponent);
4884}
4885
4886
4887/*
4888 Public function, see header qcbor/qcbor_decode.h file
4889*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004890void QCBORDecode_GetDecimalFractionBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004891 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004892 uint8_t uTagRequirement,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004893 UsefulBuf BufferForMantissa,
4894 UsefulBufC *pMantissa,
4895 bool *pbIsNegative,
4896 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004897{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004898 if(pMe->uLastError != QCBOR_SUCCESS) {
4899 return;
4900 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004901
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004902 QCBORItem Item;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004903 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004904 if(pMe->uLastError != QCBOR_SUCCESS) {
4905 return;
4906 }
4907
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004908 const TagSpecification TagSpec =
4909 {
4910 uTagRequirement,
4911 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
4912 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
4913 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004914
4915 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004916}
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004917
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004918
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004919/*
4920 Public function, see header qcbor/qcbor_decode.h file
4921*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004922void QCBORDecode_GetDecimalFractionBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004923 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004924 uint8_t uTagRequirement,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004925 UsefulBuf BufferForMantissa,
4926 UsefulBufC *pMantissa,
4927 bool *pbIsNegative,
4928 int64_t *pnExponent)
4929{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004930 if(pMe->uLastError != QCBOR_SUCCESS) {
4931 return;
4932 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004933
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004934 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004935 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
4936 if(pMe->uLastError != QCBOR_SUCCESS) {
4937 return;
4938 }
4939
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004940 const TagSpecification TagSpec =
4941 {
4942 uTagRequirement,
4943 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
4944 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
4945 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004946
4947 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
4948}
4949
4950
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004951/*
4952 Public function, see header qcbor/qcbor_decode.h file
4953*/
4954void QCBORDecode_GetBigFloat(QCBORDecodeContext *pMe,
4955 uint8_t uTagRequirement,
4956 int64_t *pnMantissa,
4957 int64_t *pnExponent)
4958{
4959 if(pMe->uLastError != QCBOR_SUCCESS) {
4960 return;
4961 }
4962
4963 QCBORItem Item;
4964 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4965 if(uError) {
4966 pMe->uLastError = (uint8_t)uError;
4967 return;
4968 }
4969 const TagSpecification TagSpec =
4970 {
4971 uTagRequirement,
4972 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM, QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM},
4973 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
4974 };
4975
4976 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
4977}
4978
4979
4980/*
4981 Public function, see header qcbor/qcbor_decode.h file
4982*/
4983void QCBORDecode_GetBigFloatInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004984 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004985 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004986 int64_t *pnMantissa,
4987 int64_t *pnExponent)
4988{
4989 if(pMe->uLastError != QCBOR_SUCCESS) {
4990 return;
4991 }
4992
4993 QCBORItem Item;
4994 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
4995 if(pMe->uLastError != QCBOR_SUCCESS) {
4996 return;
4997 }
4998
4999 const TagSpecification TagSpec =
5000 {
5001 uTagRequirement,
5002 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM, QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM},
5003 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5004 };
5005
5006 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5007}
5008
5009
5010/*
5011 Public function, see header qcbor/qcbor_decode.h file
5012*/
5013void QCBORDecode_GetBigFloatInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005014 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005015 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005016 int64_t *pnMantissa,
5017 int64_t *pnExponent)
5018{
5019 if(pMe->uLastError != QCBOR_SUCCESS) {
5020 return;
5021 }
5022
5023 QCBORItem Item;
5024 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5025 if(pMe->uLastError != QCBOR_SUCCESS) {
5026 return;
5027 }
5028
5029 const TagSpecification TagSpec =
5030 {
5031 uTagRequirement,
5032 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM, QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM},
5033 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5034 };
5035
5036 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5037}
5038
5039
5040/*
5041 Public function, see header qcbor/qcbor_decode.h file
5042*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005043void QCBORDecode_GetBigFloatBig(QCBORDecodeContext *pMe,
5044 uint8_t uTagRequirement,
5045 UsefulBuf MantissaBuffer,
5046 UsefulBufC *pMantissa,
5047 bool *pbMantissaIsNegative,
5048 int64_t *pnExponent)
5049{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005050 if(pMe->uLastError != QCBOR_SUCCESS) {
5051 return;
5052 }
5053
5054 QCBORItem Item;
5055 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5056 if(uError) {
5057 pMe->uLastError = (uint8_t)uError;
5058 return;
5059 }
5060
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005061 const TagSpecification TagSpec =
5062 {
5063 uTagRequirement,
5064 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM, QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM},
5065 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5066 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005067
5068 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, MantissaBuffer, pMantissa, pbMantissaIsNegative, pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005069}
5070
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005071
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005072/*
5073 Public function, see header qcbor/qcbor_decode.h file
5074*/
5075void QCBORDecode_GetBigFloatBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005076 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005077 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005078 UsefulBuf BufferForMantissa,
5079 UsefulBufC *pMantissa,
5080 bool *pbIsNegative,
5081 int64_t *pnExponent)
5082{
5083 if(pMe->uLastError != QCBOR_SUCCESS) {
5084 return;
5085 }
5086
5087 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005088 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5089 if(pMe->uLastError != QCBOR_SUCCESS) {
5090 return;
5091 }
5092
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005093 const TagSpecification TagSpec =
5094 {
5095 uTagRequirement,
5096 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM, QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM},
5097 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5098 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005099
5100 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
5101}
5102
5103
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005104/*
5105 Public function, see header qcbor/qcbor_decode.h file
5106*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005107void QCBORDecode_GetBigFloatBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005108 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005109 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005110 UsefulBuf BufferForMantissa,
5111 UsefulBufC *pMantissa,
5112 bool *pbIsNegative,
5113 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005114{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005115 if(pMe->uLastError != QCBOR_SUCCESS) {
5116 return;
5117 }
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005118
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005119 QCBORItem Item;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005120 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5121 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005122 return;
5123 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005124
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005125 const TagSpecification TagSpec =
5126 {
5127 uTagRequirement,
5128 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM, QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM},
5129 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5130 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005131
5132 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005133}
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005134
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005135#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */