1 //******************************************************************
3 // Copyright 2015 Intel Mobile Communications GmbH All Rights Reserved.
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
7 // Licensed under the Apache License, Version 2.0 (the "License");
8 // you may not use this file except in compliance with the License.
9 // You may obtain a copy of the License at
11 // http://www.apache.org/licenses/LICENSE-2.0
13 // Unless required by applicable law or agreed to in writing, software
14 // distributed under the License is distributed on an "AS IS" BASIS,
15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 // See the License for the specific language governing permissions and
17 // limitations under the License.
19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
21 #ifndef PAYLOAD_LOGGING_H_
22 #define PAYLOAD_LOGGING_H_
29 #ifndef __STDC_FORMAT_MACROS
30 #define __STDC_FORMAT_MACROS
32 #ifndef __STDC_LIMIT_MACROS
33 #define __STDC_LIMIT_MACROS
36 #include "rdpayload.h"
37 #include "oic_malloc.h"
44 // PL_TAG is made as generic predefined tag because of build problems in arduino for using logging
45 #define PL_TAG "PayloadLog"
48 #define OIC_LOG_PAYLOAD(level, payload) OCPayloadLog((level),(payload))
49 #define UUID_SIZE (16)
50 OC_EXPORT const char *convertTriggerEnumToString(OCPresenceTrigger trigger);
51 OC_EXPORT OCPresenceTrigger convertTriggerStringToEnum(const char * triggerStr);
53 #if defined(RD_CLIENT) || defined(RD_SERVER)
54 INLINE_API void OCTagsLog(const LogLevel level, const OCTagsPayload *tags)
58 if (tags->n.deviceName)
60 OIC_LOG_V(level, PL_TAG, " Device Name : %s ", tags->n.deviceName);
64 OIC_LOG_V(level, PL_TAG, " Device ID : %s ", tags->di.id);
66 OIC_LOG_V(level, PL_TAG, " lt : %lld ",tags->ttl);
74 INLINE_API void OCLinksLog(const LogLevel level, const OCLinksPayload *links)
85 OIC_LOG_V(level, PL_TAG, " href: %s ",links->href);
87 OIC_LOG(level, PL_TAG, " RT: ");
88 OCStringLL *rt = links->rt;
93 OIC_LOG_V(level, PL_TAG, " %s", rt->value);
97 OIC_LOG(level, PL_TAG, " IF: ");
98 OCStringLL *itf = links->itf;
103 OIC_LOG_V(level, PL_TAG, " %s", itf->value);
107 OIC_LOG(level, PL_TAG, " MT: ");
108 OCStringLL *mt = links->type;
113 OIC_LOG_V(level, PL_TAG, " %s", mt->value);
119 OIC_LOG_V(level, PL_TAG, " %s", links->type);
121 OIC_LOG_V(level, PL_TAG, " INS: %d", links->ins);
122 OIC_LOG_V(level, PL_TAG, " TTL: %d", links->ttl);
123 OIC_LOG_V(level, PL_TAG, " P: %d", links->p);
126 OIC_LOG_V(level, PL_TAG, " REL: %s", links->rel);
130 OIC_LOG_V(level, PL_TAG, " TITLE: %s", links->title);
134 OIC_LOG_V(level, PL_TAG, " URI: %s", links->anchor);
140 INLINE_API void OCPayloadLogRep(LogLevel level, OCRepPayload* payload)
142 OIC_LOG(level, (PL_TAG), "Payload Type: Representation");
143 OCRepPayload* rep = payload;
147 OIC_LOG_V(level, PL_TAG, "\tResource #%d", i);
148 OIC_LOG_V(level, PL_TAG, "\tURI:%s", rep->uri);
149 OIC_LOG(level, PL_TAG, "\tResource Types:");
150 OCStringLL* strll = rep->types;
153 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
156 OIC_LOG(level, PL_TAG, "\tInterfaces:");
157 strll = rep->interfaces;
160 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
164 // TODO Finish Logging: Values
165 OCRepPayloadValue* val = rep->values;
167 OIC_LOG(level, PL_TAG, "\tValues:");
173 case OCREP_PROP_NULL:
174 OIC_LOG_V(level, PL_TAG, "\t\t%s: NULL", val->name);
177 OIC_LOG_V(level, PL_TAG, "\t\t%s(int):%zd", val->name, val->i);
179 case OCREP_PROP_DOUBLE:
180 OIC_LOG_V(level, PL_TAG, "\t\t%s(double):%f", val->name, val->d);
182 case OCREP_PROP_BOOL:
183 OIC_LOG_V(level, PL_TAG, "\t\t%s(bool):%s", val->name, val->b ? "true" : "false");
185 case OCREP_PROP_STRING:
186 OIC_LOG_V(level, PL_TAG, "\t\t%s(string):%s", val->name, val->str);
188 case OCREP_PROP_BYTE_STRING:
189 OIC_LOG_V(level, PL_TAG, "\t\t%s(binary):", val->name);
190 OIC_LOG_BUFFER(level, PL_TAG, val->ocByteStr.bytes, val->ocByteStr.len);
192 case OCREP_PROP_OBJECT:
193 // Note: Only prints the URI (if available), to print further, you'll
194 // need to dig into the object better!
195 OIC_LOG_V(level, PL_TAG, "\t\t%s(OCRep):%s", val->name, val->obj->uri);
197 case OCREP_PROP_ARRAY:
198 switch(val->arr.type)
201 OIC_LOG_V(level, PL_TAG, "\t\t%s(int array):%zu x %zu x %zu",
203 val->arr.dimensions[0], val->arr.dimensions[1],
204 val->arr.dimensions[2]);
206 case OCREP_PROP_DOUBLE:
207 OIC_LOG_V(level, PL_TAG, "\t\t%s(double array):%zu x %zu x %zu",
209 val->arr.dimensions[0], val->arr.dimensions[1],
210 val->arr.dimensions[2]);
212 case OCREP_PROP_BOOL:
213 OIC_LOG_V(level, PL_TAG, "\t\t%s(bool array):%zu x %zu x %zu",
215 val->arr.dimensions[0], val->arr.dimensions[1],
216 val->arr.dimensions[2]);
218 case OCREP_PROP_STRING:
219 OIC_LOG_V(level, PL_TAG, "\t\t%s(string array):%zu x %zu x %zu",
221 val->arr.dimensions[0], val->arr.dimensions[1],
222 val->arr.dimensions[2]);
224 case OCREP_PROP_BYTE_STRING:
225 OIC_LOG_V(level, PL_TAG, "\t\t%s(byte array):%zu x %zu x %zu",
227 val->arr.dimensions[0], val->arr.dimensions[1],
228 val->arr.dimensions[2]);
230 case OCREP_PROP_OBJECT:
231 OIC_LOG_V(level, PL_TAG, "\t\t%s(OCRep array):%zu x %zu x %zu",
233 val->arr.dimensions[0], val->arr.dimensions[1],
234 val->arr.dimensions[2]);
237 OIC_LOG_V(ERROR, PL_TAG, "\t\t%s <-- Unknown/unsupported array type!",
243 OIC_LOG_V(ERROR, PL_TAG, "\t\t%s <-- Unknown type!", val->name);
255 INLINE_API void OCPayloadLogDiscovery(LogLevel level, OCDiscoveryPayload* payload)
257 OIC_LOG(level, PL_TAG, "Payload Type: Discovery");
259 while(payload && payload->resources)
261 OIC_LOG_V(level, PL_TAG, "\tSID: %s", payload->sid);
262 if (payload->baseURI)
264 OIC_LOG_V(level, PL_TAG, "\tBase URI:%s", payload->baseURI);
268 OIC_LOG_V(level, PL_TAG, "\tNAME: %s", payload->name);
272 OIC_LOG_V(level, PL_TAG, "\tURI: %s", payload->uri);
276 for (OCStringLL *strll = payload->type; strll; strll = strll->next)
278 OIC_LOG_V(level, PL_TAG, "\tResource Type: %s", strll->value);
281 OIC_LOG(level, PL_TAG, "\tInterface:");
282 for (OCStringLL *itf = payload->iface; itf; itf = itf->next)
284 OIC_LOG_V(level, PL_TAG, "\t\t%s", itf->value);
287 OCResourcePayload* res = payload->resources;
292 OIC_LOG_V(level, PL_TAG, "\tResource #%d", i);
293 OIC_LOG_V(level, PL_TAG, "\tURI:%s", res->uri);
294 OIC_LOG(level, PL_TAG, "\tResource Types:");
295 OCStringLL* strll = res->types;
298 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
301 OIC_LOG(level, PL_TAG, "\tInterfaces:");
302 strll = res->interfaces;
305 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
309 OIC_LOG_V(level, PL_TAG, "\tBitmap: %u", res->bitmap);
310 OIC_LOG_V(level, PL_TAG, "\tSecure?: %s", res->secure ? "true" : "false");
311 OIC_LOG_V(level, PL_TAG, "\tPort: %u", res->port);
312 OIC_LOG(level, PL_TAG, "");
316 payload = payload->next;
320 INLINE_API void OCPayloadLogDevice(LogLevel level, OCDevicePayload* payload)
322 OIC_LOG(level, PL_TAG, "Payload Type: Device");
323 OIC_LOG_V(level, PL_TAG, "\tSID:%s", payload->sid);
324 OIC_LOG_V(level, PL_TAG, "\tDevice Name:%s", payload->deviceName);
325 OIC_LOG_V(level, PL_TAG, "\tSpec Version:%s", payload->specVersion);
326 if (payload->dataModelVersions)
328 OIC_LOG(level, PL_TAG, "\tData Model Version:");
329 for (OCStringLL *strll = payload->dataModelVersions; strll; strll = strll->next)
331 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
336 OIC_LOG(level, PL_TAG, "\tResource Type:");
337 for (OCStringLL *strll = payload->types; strll; strll = strll->next)
339 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
342 if (payload->interfaces)
344 OIC_LOG(level, PL_TAG, "\tInterface:");
345 for (OCStringLL *strll = payload->interfaces; strll; strll = strll->next)
347 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
352 INLINE_API void OCPayloadLogPlatform(LogLevel level, OCPlatformPayload* payload)
354 OIC_LOG(level, PL_TAG, "Payload Type: Platform");
355 OIC_LOG_V(level, PL_TAG, "\tURI:%s", payload->uri);
356 OIC_LOG_V(level, PL_TAG, "\tPlatform ID:%s", payload->info.platformID);
357 OIC_LOG_V(level, PL_TAG, "\tMfg Name:%s", payload->info.manufacturerName);
358 OIC_LOG_V(level, PL_TAG, "\tMfg URL:%s", payload->info.manufacturerUrl);
359 OIC_LOG_V(level, PL_TAG, "\tModel Number:%s", payload->info.modelNumber);
360 OIC_LOG_V(level, PL_TAG, "\tDate of Mfg:%s", payload->info.dateOfManufacture);
361 OIC_LOG_V(level, PL_TAG, "\tPlatform Version:%s", payload->info.platformVersion);
362 OIC_LOG_V(level, PL_TAG, "\tOS Version:%s", payload->info.operatingSystemVersion);
363 OIC_LOG_V(level, PL_TAG, "\tHardware Version:%s", payload->info.hardwareVersion);
364 OIC_LOG_V(level, PL_TAG, "\tFirmware Version:%s", payload->info.firmwareVersion);
365 OIC_LOG_V(level, PL_TAG, "\tSupport URL:%s", payload->info.supportUrl);
366 OIC_LOG_V(level, PL_TAG, "\tSystem Time:%s", payload->info.systemTime);
370 OIC_LOG(level, PL_TAG, "\tResource Types:");
371 for (OCStringLL *strll = payload->rt; strll; strll = strll->next)
373 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
376 if (payload->interfaces)
378 OIC_LOG(level, PL_TAG, "\tResource Interfaces:");
379 for (OCStringLL *strll = payload->interfaces; strll; strll = strll->next)
381 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
386 INLINE_API void OCPayloadLogPresence(LogLevel level, OCPresencePayload* payload)
388 OIC_LOG(level, PL_TAG, "Payload Type: Presence");
389 OIC_LOG_V(level, PL_TAG, "\tSequence Number:%u", payload->sequenceNumber);
390 OIC_LOG_V(level, PL_TAG, "\tMax Age:%d", payload->maxAge);
391 OIC_LOG_V(level, PL_TAG, "\tTrigger:%s", convertTriggerEnumToString(payload->trigger));
392 OIC_LOG_V(level, PL_TAG, "\tResource Type:%s", payload->resourceType);
395 INLINE_API void OCPayloadLogSecurity(LogLevel level, OCSecurityPayload* payload)
397 size_t payloadSize = payload->payloadSize;
398 OIC_LOG(level, PL_TAG, "Payload Type: Security");
402 // Add a zero-character string terminator.
403 char *securityData = (char *)OICMalloc(payloadSize + 1);
407 memcpy(securityData, payload->securityData, payloadSize);
408 assert(securityData[payloadSize - 1] != '\0');
409 securityData[payloadSize] = '\0';
410 OIC_LOG_V(level, PL_TAG, "\tSecurity Data: %s", securityData);
411 OICFree(securityData);
416 #if defined(RD_CLIENT) || defined(RD_SERVER)
417 INLINE_API void OCRDPayloadLog(const LogLevel level, const OCRDPayload *payload)
424 if (payload->rdDiscovery)
426 OIC_LOG(level, PL_TAG, "RD Discovery");
427 OIC_LOG_V(level, PL_TAG, " Device Name : %s", payload->rdDiscovery->n.deviceName);
428 OIC_LOG_V(level, PL_TAG, " Device Identity : %s", payload->rdDiscovery->di.id);
429 OIC_LOG_V(level, PL_TAG, " Bias: %d", payload->rdDiscovery->sel);
431 if (payload->rdPublish)
433 OIC_LOG(level, PL_TAG, "RD Publish");
434 OCResourceCollectionPayload *rdPublish = payload->rdPublish;
435 OCTagsLog(level, rdPublish->tags);
436 OCLinksLog(level, rdPublish->setLinks);
440 INLINE_API void OCPayloadLog(LogLevel level, OCPayload* payload)
444 OIC_LOG(level, PL_TAG, "NULL Payload");
447 switch(payload->type)
449 case PAYLOAD_TYPE_REPRESENTATION:
450 OCPayloadLogRep(level, (OCRepPayload*)payload);
452 case PAYLOAD_TYPE_DISCOVERY:
453 OCPayloadLogDiscovery(level, (OCDiscoveryPayload*)payload);
455 case PAYLOAD_TYPE_DEVICE:
456 OCPayloadLogDevice(level, (OCDevicePayload*)payload);
458 case PAYLOAD_TYPE_PLATFORM:
459 OCPayloadLogPlatform(level, (OCPlatformPayload*)payload);
461 case PAYLOAD_TYPE_PRESENCE:
462 OCPayloadLogPresence(level, (OCPresencePayload*)payload);
464 case PAYLOAD_TYPE_SECURITY:
465 OCPayloadLogSecurity(level, (OCSecurityPayload*)payload);
467 #if defined(RD_CLIENT) || defined(RD_SERVER)
468 case PAYLOAD_TYPE_RD:
469 OCRDPayloadLog(level, (OCRDPayload*)payload);
473 OIC_LOG_V(level, PL_TAG, "Unknown Payload Type: %d", payload->type);
478 #define OIC_LOG_PAYLOAD(level, payload)