Mayank Gupta / Mbed OS pelion-example-frdm

Example

Dependencies:   FXAS21002 FXOS8700Q

simple-mbed-cloud-client/mbed-cloud-client/mbed-client/source/m2mtlvserializer.cpp@0:11cc2b7889af, 2019-11-19 (annotated)

Committer:
maygup01
Date:
Tue Nov 19 09:49:38 2019 +0000
Revision:
0:11cc2b7889af
Example

Who changed what in which revision?

UserRevisionLine numberNew contents of line
maygup01 0:11cc2b7889af 1 /*
maygup01 0:11cc2b7889af 2 * Copyright (c) 2015 ARM Limited. All rights reserved.
maygup01 0:11cc2b7889af 3 * SPDX-License-Identifier: Apache-2.0
maygup01 0:11cc2b7889af 4 * Licensed under the Apache License, Version 2.0 (the License); you may
maygup01 0:11cc2b7889af 5 * not use this file except in compliance with the License.
maygup01 0:11cc2b7889af 6 * You may obtain a copy of the License at
maygup01 0:11cc2b7889af 7 *
maygup01 0:11cc2b7889af 8 * http://www.apache.org/licenses/LICENSE-2.0
maygup01 0:11cc2b7889af 9 *
maygup01 0:11cc2b7889af 10 * Unless required by applicable law or agreed to in writing, software
maygup01 0:11cc2b7889af 11 * distributed under the License is distributed on an AS IS BASIS, WITHOUT
maygup01 0:11cc2b7889af 12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
maygup01 0:11cc2b7889af 13 * See the License for the specific language governing permissions and
maygup01 0:11cc2b7889af 14 * limitations under the License.
maygup01 0:11cc2b7889af 15 */
maygup01 0:11cc2b7889af 16 #include "include/m2mtlvserializer.h"
maygup01 0:11cc2b7889af 17 #include "mbed-client/m2mconstants.h"
maygup01 0:11cc2b7889af 18
maygup01 0:11cc2b7889af 19 #include <stdlib.h>
maygup01 0:11cc2b7889af 20 #include "common_functions.h"
maygup01 0:11cc2b7889af 21
maygup01 0:11cc2b7889af 22 #define TRACE_GROUP "mClt"
maygup01 0:11cc2b7889af 23
maygup01 0:11cc2b7889af 24 #define MAX_TLV_LENGTH_SIZE 3
maygup01 0:11cc2b7889af 25 #define MAX_TLV_ID_SIZE 2
maygup01 0:11cc2b7889af 26 #define TLV_TYPE_SIZE 1
maygup01 0:11cc2b7889af 27
maygup01 0:11cc2b7889af 28 uint8_t* M2MTLVSerializer::serialize(const M2MObjectInstanceList &object_instance_list, uint32_t &size)
maygup01 0:11cc2b7889af 29 {
maygup01 0:11cc2b7889af 30 return serialize_object_instances(object_instance_list, size);
maygup01 0:11cc2b7889af 31 }
maygup01 0:11cc2b7889af 32
maygup01 0:11cc2b7889af 33 uint8_t* M2MTLVSerializer::serialize(const M2MResourceList &resource_list, uint32_t &size)
maygup01 0:11cc2b7889af 34 {
maygup01 0:11cc2b7889af 35 bool valid = true;
maygup01 0:11cc2b7889af 36 return serialize_resources(resource_list, size,valid);
maygup01 0:11cc2b7889af 37 }
maygup01 0:11cc2b7889af 38
maygup01 0:11cc2b7889af 39 uint8_t* M2MTLVSerializer::serialize(const M2MResource *resource, uint32_t &size)
maygup01 0:11cc2b7889af 40 {
maygup01 0:11cc2b7889af 41 uint8_t* data = NULL;
maygup01 0:11cc2b7889af 42 serialize(resource, data, size);
maygup01 0:11cc2b7889af 43 return data;
maygup01 0:11cc2b7889af 44 }
maygup01 0:11cc2b7889af 45
maygup01 0:11cc2b7889af 46 uint8_t* M2MTLVSerializer::serialize_object_instances(const M2MObjectInstanceList &object_instance_list, uint32_t &size)
maygup01 0:11cc2b7889af 47 {
maygup01 0:11cc2b7889af 48 uint8_t *data = NULL;
maygup01 0:11cc2b7889af 49
maygup01 0:11cc2b7889af 50 if(!object_instance_list.empty()) {
maygup01 0:11cc2b7889af 51 M2MObjectInstanceList::const_iterator it;
maygup01 0:11cc2b7889af 52 it = object_instance_list.begin();
maygup01 0:11cc2b7889af 53 for (; it!=object_instance_list.end(); it++) {
maygup01 0:11cc2b7889af 54 uint16_t id = (*it)->instance_id();
maygup01 0:11cc2b7889af 55 serialize(id, *it, data, size);
maygup01 0:11cc2b7889af 56 }
maygup01 0:11cc2b7889af 57 }
maygup01 0:11cc2b7889af 58 return data;
maygup01 0:11cc2b7889af 59 }
maygup01 0:11cc2b7889af 60
maygup01 0:11cc2b7889af 61 uint8_t* M2MTLVSerializer::serialize_resources(const M2MResourceList &resource_list, uint32_t &size, bool &valid)
maygup01 0:11cc2b7889af 62 {
maygup01 0:11cc2b7889af 63 uint8_t *data = NULL;
maygup01 0:11cc2b7889af 64
maygup01 0:11cc2b7889af 65 if(!resource_list.empty()) {
maygup01 0:11cc2b7889af 66 M2MResourceList::const_iterator it;
maygup01 0:11cc2b7889af 67 it = resource_list.begin();
maygup01 0:11cc2b7889af 68 for (; it!=resource_list.end(); it++) {
maygup01 0:11cc2b7889af 69 if((*it)->name_id() == -1) {
maygup01 0:11cc2b7889af 70 valid = false;
maygup01 0:11cc2b7889af 71 break;
maygup01 0:11cc2b7889af 72 }
maygup01 0:11cc2b7889af 73 }
maygup01 0:11cc2b7889af 74 if(valid) {
maygup01 0:11cc2b7889af 75 it = resource_list.begin();
maygup01 0:11cc2b7889af 76 for (; it!=resource_list.end(); it++) {
maygup01 0:11cc2b7889af 77 if (((*it)->operation() & M2MBase::GET_ALLOWED) == M2MBase::GET_ALLOWED) {
maygup01 0:11cc2b7889af 78 if(!serialize(*it, data, size)) {
maygup01 0:11cc2b7889af 79 /* serializing has failed */
maygup01 0:11cc2b7889af 80 /* free data so far */
maygup01 0:11cc2b7889af 81 free(data);
maygup01 0:11cc2b7889af 82 /* invalidate */
maygup01 0:11cc2b7889af 83 valid = false;
maygup01 0:11cc2b7889af 84 /* return NULL immediately */
maygup01 0:11cc2b7889af 85 return NULL;
maygup01 0:11cc2b7889af 86 }
maygup01 0:11cc2b7889af 87 }
maygup01 0:11cc2b7889af 88 }
maygup01 0:11cc2b7889af 89 }
maygup01 0:11cc2b7889af 90 }
maygup01 0:11cc2b7889af 91 return data;
maygup01 0:11cc2b7889af 92 }
maygup01 0:11cc2b7889af 93
maygup01 0:11cc2b7889af 94 bool M2MTLVSerializer::serialize(uint16_t id, const M2MObjectInstance *object_instance, uint8_t *&data, uint32_t &size)
maygup01 0:11cc2b7889af 95 {
maygup01 0:11cc2b7889af 96 uint8_t *resource_data = NULL;
maygup01 0:11cc2b7889af 97 uint32_t resource_size = 0;
maygup01 0:11cc2b7889af 98 bool success;
maygup01 0:11cc2b7889af 99
maygup01 0:11cc2b7889af 100 bool valid = true;
maygup01 0:11cc2b7889af 101 resource_data = serialize_resources(object_instance->resources(),resource_size,valid);
maygup01 0:11cc2b7889af 102 if(valid) {
maygup01 0:11cc2b7889af 103 if(serialize_TILV(TYPE_OBJECT_INSTANCE, id, resource_data, resource_size, data, size)) {
maygup01 0:11cc2b7889af 104 success = true;
maygup01 0:11cc2b7889af 105 } else {
maygup01 0:11cc2b7889af 106 /* serializing object instance failed */
maygup01 0:11cc2b7889af 107 success = false;
maygup01 0:11cc2b7889af 108 }
maygup01 0:11cc2b7889af 109 free(resource_data);
maygup01 0:11cc2b7889af 110 } else {
maygup01 0:11cc2b7889af 111 /* serializing resources failed */
maygup01 0:11cc2b7889af 112 success = false;
maygup01 0:11cc2b7889af 113 }
maygup01 0:11cc2b7889af 114 return success;
maygup01 0:11cc2b7889af 115 }
maygup01 0:11cc2b7889af 116
maygup01 0:11cc2b7889af 117 bool M2MTLVSerializer::serialize(const M2MResource *resource, uint8_t *&data, uint32_t &size)
maygup01 0:11cc2b7889af 118 {
maygup01 0:11cc2b7889af 119 bool success = false;
maygup01 0:11cc2b7889af 120 if(resource->name_id() != -1) {
maygup01 0:11cc2b7889af 121 success = resource->supports_multiple_instances() ?
maygup01 0:11cc2b7889af 122 serialize_multiple_resource(resource, data, size) :
maygup01 0:11cc2b7889af 123 serialize_resource(resource, data, size);
maygup01 0:11cc2b7889af 124 }
maygup01 0:11cc2b7889af 125 return success;
maygup01 0:11cc2b7889af 126 }
maygup01 0:11cc2b7889af 127
maygup01 0:11cc2b7889af 128 bool M2MTLVSerializer::serialize_resource(const M2MResource *resource, uint8_t *&data, uint32_t &size)
maygup01 0:11cc2b7889af 129 {
maygup01 0:11cc2b7889af 130 bool success = false;
maygup01 0:11cc2b7889af 131 if(resource->name_id() != -1) {
maygup01 0:11cc2b7889af 132 if ( (resource->resource_instance_type() == M2MResourceBase::INTEGER) ||
maygup01 0:11cc2b7889af 133 (resource->resource_instance_type() == M2MResourceBase::BOOLEAN) ||
maygup01 0:11cc2b7889af 134 (resource->resource_instance_type() == M2MResourceBase::TIME) ) {
maygup01 0:11cc2b7889af 135 success = serialize_TLV_binary_int(resource, TYPE_RESOURCE, resource->name_id(), data, size);
maygup01 0:11cc2b7889af 136 }
maygup01 0:11cc2b7889af 137 else if (resource->resource_instance_type() == M2MResourceBase::FLOAT) {
maygup01 0:11cc2b7889af 138 success = serialize_TLV_binary_float(resource, TYPE_RESOURCE, resource->name_id(), data, size);
maygup01 0:11cc2b7889af 139 }
maygup01 0:11cc2b7889af 140 else {
maygup01 0:11cc2b7889af 141 success = serialize_TILV(TYPE_RESOURCE, resource->name_id(),
maygup01 0:11cc2b7889af 142 resource->value(), resource->value_length(), data, size);
maygup01 0:11cc2b7889af 143 }
maygup01 0:11cc2b7889af 144 }
maygup01 0:11cc2b7889af 145 return success;
maygup01 0:11cc2b7889af 146 }
maygup01 0:11cc2b7889af 147
maygup01 0:11cc2b7889af 148 bool M2MTLVSerializer::serialize_multiple_resource(const M2MResource *resource, uint8_t *&data, uint32_t &size)
maygup01 0:11cc2b7889af 149 {
maygup01 0:11cc2b7889af 150 bool success = false;
maygup01 0:11cc2b7889af 151 uint8_t *nested_data = NULL;
maygup01 0:11cc2b7889af 152 uint32_t nested_data_size = 0;
maygup01 0:11cc2b7889af 153
maygup01 0:11cc2b7889af 154 const M2MResourceInstanceList &instance_list = resource->resource_instances();
maygup01 0:11cc2b7889af 155 if(!instance_list.empty()) {
maygup01 0:11cc2b7889af 156 M2MResourceInstanceList::const_iterator it;
maygup01 0:11cc2b7889af 157 it = instance_list.begin();
maygup01 0:11cc2b7889af 158 for (; it!=instance_list.end(); it++) {
maygup01 0:11cc2b7889af 159 uint16_t id = (*it)->instance_id();
maygup01 0:11cc2b7889af 160 if (((*it)->operation() & M2MBase::GET_ALLOWED) == M2MBase::GET_ALLOWED) {
maygup01 0:11cc2b7889af 161 if(!serialize_resource_instance(id, (*it), nested_data, nested_data_size)) {
maygup01 0:11cc2b7889af 162 /* serializing instance has failed */
maygup01 0:11cc2b7889af 163 /* free data so far allocated */
maygup01 0:11cc2b7889af 164 free(nested_data);
maygup01 0:11cc2b7889af 165 /* return fail immediately*/
maygup01 0:11cc2b7889af 166 success = false;
maygup01 0:11cc2b7889af 167 return success;
maygup01 0:11cc2b7889af 168 }
maygup01 0:11cc2b7889af 169 }
maygup01 0:11cc2b7889af 170 }
maygup01 0:11cc2b7889af 171 }
maygup01 0:11cc2b7889af 172 if(resource->name_id() != -1 &&
maygup01 0:11cc2b7889af 173 (resource->operation() & M2MBase::GET_ALLOWED) == M2MBase::GET_ALLOWED) {
maygup01 0:11cc2b7889af 174 success = serialize_TILV(TYPE_MULTIPLE_RESOURCE, resource->name_id(),
maygup01 0:11cc2b7889af 175 nested_data, nested_data_size, data, size);
maygup01 0:11cc2b7889af 176 }
maygup01 0:11cc2b7889af 177
maygup01 0:11cc2b7889af 178 free(nested_data);
maygup01 0:11cc2b7889af 179 return success;
maygup01 0:11cc2b7889af 180 }
maygup01 0:11cc2b7889af 181
maygup01 0:11cc2b7889af 182 bool M2MTLVSerializer::serialize_resource_instance(uint16_t id, const M2MResourceInstance *resource, uint8_t *&data, uint32_t &size)
maygup01 0:11cc2b7889af 183 {
maygup01 0:11cc2b7889af 184 bool success;
maygup01 0:11cc2b7889af 185
maygup01 0:11cc2b7889af 186 if ( (resource->resource_instance_type() == M2MResourceBase::INTEGER) ||
maygup01 0:11cc2b7889af 187 (resource->resource_instance_type() == M2MResourceBase::BOOLEAN) ||
maygup01 0:11cc2b7889af 188 (resource->resource_instance_type() == M2MResourceBase::TIME) ) {
maygup01 0:11cc2b7889af 189 success=serialize_TLV_binary_int(resource, TYPE_RESOURCE_INSTANCE, id, data, size);
maygup01 0:11cc2b7889af 190 }
maygup01 0:11cc2b7889af 191 else if (resource->resource_instance_type() == M2MResourceBase::FLOAT) {
maygup01 0:11cc2b7889af 192 success=serialize_TLV_binary_float(resource, TYPE_RESOURCE_INSTANCE, id, data, size);
maygup01 0:11cc2b7889af 193 }
maygup01 0:11cc2b7889af 194 else {
maygup01 0:11cc2b7889af 195 success=serialize_TILV(TYPE_RESOURCE_INSTANCE, id, resource->value(), resource->value_length(), data, size);
maygup01 0:11cc2b7889af 196 }
maygup01 0:11cc2b7889af 197
maygup01 0:11cc2b7889af 198 return success;
maygup01 0:11cc2b7889af 199 }
maygup01 0:11cc2b7889af 200
maygup01 0:11cc2b7889af 201 /* See, OMA-TS-LightweightM2M-V1_0-20170208-A, Appendix C,
maygup01 0:11cc2b7889af 202 * Data Types, Integer, Boolean and Time TLV Format */
maygup01 0:11cc2b7889af 203 bool M2MTLVSerializer::serialize_TLV_binary_int(const M2MResourceBase *resource, uint8_t type, uint16_t id, uint8_t *&data, uint32_t &size)
maygup01 0:11cc2b7889af 204 {
maygup01 0:11cc2b7889af 205 int64_t valueInt = resource->get_value_int();
maygup01 0:11cc2b7889af 206 uint32_t buffer_size;
maygup01 0:11cc2b7889af 207 /* max len 8 bytes */
maygup01 0:11cc2b7889af 208 uint8_t buffer[8];
maygup01 0:11cc2b7889af 209
maygup01 0:11cc2b7889af 210 if (resource->resource_instance_type() == M2MResourceBase::BOOLEAN) {
maygup01 0:11cc2b7889af 211 buffer_size = 1;
maygup01 0:11cc2b7889af 212 buffer[0] = valueInt;
maygup01 0:11cc2b7889af 213 } else {
maygup01 0:11cc2b7889af 214 buffer_size = 8;
maygup01 0:11cc2b7889af 215 common_write_64_bit(valueInt, buffer);
maygup01 0:11cc2b7889af 216 }
maygup01 0:11cc2b7889af 217
maygup01 0:11cc2b7889af 218 return serialize_TILV(type, id, buffer, buffer_size, data, size);
maygup01 0:11cc2b7889af 219 }
maygup01 0:11cc2b7889af 220
maygup01 0:11cc2b7889af 221 /* See, OMA-TS-LightweightM2M-V1_0-20170208-A, Appendix C,
maygup01 0:11cc2b7889af 222 * Data Type Float (32 bit only) TLV Format */
maygup01 0:11cc2b7889af 223 bool M2MTLVSerializer::serialize_TLV_binary_float(const M2MResourceBase *resource, uint8_t type, uint16_t id, uint8_t *&data, uint32_t &size)
maygup01 0:11cc2b7889af 224 {
maygup01 0:11cc2b7889af 225 float valueFloat = resource->get_value_float();
maygup01 0:11cc2b7889af 226 /* max len 8 bytes */
maygup01 0:11cc2b7889af 227 uint8_t buffer[4];
maygup01 0:11cc2b7889af 228
maygup01 0:11cc2b7889af 229 common_write_32_bit(*(uint32_t*)&valueFloat, buffer);
maygup01 0:11cc2b7889af 230
maygup01 0:11cc2b7889af 231 return serialize_TILV(type, id, buffer, 4, data, size);
maygup01 0:11cc2b7889af 232 }
maygup01 0:11cc2b7889af 233
maygup01 0:11cc2b7889af 234
maygup01 0:11cc2b7889af 235 bool M2MTLVSerializer::serialize_TILV(uint8_t type, uint16_t id, uint8_t *value, uint32_t value_length, uint8_t *&data, uint32_t &size)
maygup01 0:11cc2b7889af 236 {
maygup01 0:11cc2b7889af 237 uint8_t *tlv = 0;
maygup01 0:11cc2b7889af 238 const uint32_t type_length = TLV_TYPE_SIZE;
maygup01 0:11cc2b7889af 239 type += id < 256 ? 0 : ID16;
maygup01 0:11cc2b7889af 240 type += value_length < 8 ? value_length :
maygup01 0:11cc2b7889af 241 value_length < 256 ? LENGTH8 :
maygup01 0:11cc2b7889af 242 value_length < 65536 ? LENGTH16 : LENGTH24;
maygup01 0:11cc2b7889af 243 uint8_t tlv_type;
maygup01 0:11cc2b7889af 244 tlv_type = type & 0xFF;
maygup01 0:11cc2b7889af 245
maygup01 0:11cc2b7889af 246 uint32_t id_size;
maygup01 0:11cc2b7889af 247 uint8_t id_array[MAX_TLV_ID_SIZE];
maygup01 0:11cc2b7889af 248 serialize_id(id, id_size, id_array);
maygup01 0:11cc2b7889af 249
maygup01 0:11cc2b7889af 250 uint32_t length_size;
maygup01 0:11cc2b7889af 251 uint8_t length_array[MAX_TLV_LENGTH_SIZE];
maygup01 0:11cc2b7889af 252 serialize_length(value_length, length_size, length_array);
maygup01 0:11cc2b7889af 253
maygup01 0:11cc2b7889af 254 tlv = (uint8_t*)malloc(size + type_length + id_size + length_size + value_length);
maygup01 0:11cc2b7889af 255 if (!tlv) {
maygup01 0:11cc2b7889af 256 /* memory allocation has failed */
maygup01 0:11cc2b7889af 257 /* return failure immediately */
maygup01 0:11cc2b7889af 258 return false;
maygup01 0:11cc2b7889af 259 /* eventually NULL will be returned to serializer public method caller */
maygup01 0:11cc2b7889af 260 }
maygup01 0:11cc2b7889af 261 if(data) {
maygup01 0:11cc2b7889af 262 memcpy(tlv, data, size);
maygup01 0:11cc2b7889af 263 free(data);
maygup01 0:11cc2b7889af 264 }
maygup01 0:11cc2b7889af 265 memcpy(tlv+size, &tlv_type, type_length);
maygup01 0:11cc2b7889af 266 memcpy(tlv+size+type_length, id_array, id_size);
maygup01 0:11cc2b7889af 267 memcpy(tlv+size+type_length+id_size, length_array, length_size);
maygup01 0:11cc2b7889af 268 memcpy(tlv+size+type_length+id_size+length_size, value, value_length);
maygup01 0:11cc2b7889af 269
maygup01 0:11cc2b7889af 270 data = tlv;
maygup01 0:11cc2b7889af 271 size += type_length + id_size + length_size + value_length;
maygup01 0:11cc2b7889af 272 return true;
maygup01 0:11cc2b7889af 273 }
maygup01 0:11cc2b7889af 274
maygup01 0:11cc2b7889af 275 void M2MTLVSerializer::serialize_id(uint16_t id, uint32_t &size, uint8_t *id_ptr)
maygup01 0:11cc2b7889af 276 {
maygup01 0:11cc2b7889af 277 if(id > 255) {
maygup01 0:11cc2b7889af 278 size=2;
maygup01 0:11cc2b7889af 279 id_ptr[0] = (id & 0xFF00) >> 8;
maygup01 0:11cc2b7889af 280 id_ptr[1] = id & 0xFF;
maygup01 0:11cc2b7889af 281 } else {
maygup01 0:11cc2b7889af 282 size=1;
maygup01 0:11cc2b7889af 283 id_ptr[0] = id & 0xFF;
maygup01 0:11cc2b7889af 284 }
maygup01 0:11cc2b7889af 285 }
maygup01 0:11cc2b7889af 286
maygup01 0:11cc2b7889af 287 void M2MTLVSerializer::serialize_length(uint32_t length, uint32_t &size, uint8_t *length_ptr)
maygup01 0:11cc2b7889af 288 {
maygup01 0:11cc2b7889af 289 if (length > 65535) {
maygup01 0:11cc2b7889af 290 size = 3;
maygup01 0:11cc2b7889af 291 length_ptr[0] = (length & 0xFF0000) >> 16;
maygup01 0:11cc2b7889af 292 length_ptr[1] = (length & 0xFF00) >> 8;
maygup01 0:11cc2b7889af 293 length_ptr[2] = length & 0xFF;
maygup01 0:11cc2b7889af 294 } else if (length > 255) {
maygup01 0:11cc2b7889af 295 size = 2;
maygup01 0:11cc2b7889af 296 length_ptr[0] = (length & 0xFF00) >> 8;
maygup01 0:11cc2b7889af 297 length_ptr[1] = length & 0xFF;
maygup01 0:11cc2b7889af 298 } else if (length > 7) {
maygup01 0:11cc2b7889af 299 size = 1;
maygup01 0:11cc2b7889af 300 length_ptr[0] = length & 0xFF;
maygup01 0:11cc2b7889af 301 } else {
maygup01 0:11cc2b7889af 302 size=0;
maygup01 0:11cc2b7889af 303 }
maygup01 0:11cc2b7889af 304 }
maygup01 0:11cc2b7889af 305