resource/csdk/stack/include/payload_logging.h

   1 //******************************************************************
   2 //
   3 // Copyright 2015 Intel Mobile Communications GmbH All Rights Reserved.
   4 //
   5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
   6 //
   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
  10 //
  11 //      http://www.apache.org/licenses/LICENSE-2.0
  12 //
  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.
  18 //
  19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  20
  21 #ifndef PAYLOAD_LOGGING_H_
  22 #define PAYLOAD_LOGGING_H_
  23
  24 #include "logger.h"
  25 #ifdef __TIZEN__
  26 #include <dlog.h>
  27 #endif
  28
  29 #ifndef __STDC_FORMAT_MACROS
  30 #define __STDC_FORMAT_MACROS
  31 #endif
  32 #ifndef __STDC_LIMIT_MACROS
  33 #define __STDC_LIMIT_MACROS
  34 #endif
  35 #include <inttypes.h>
  36 #include "rdpayload.h"
  37 #include "oic_malloc.h"
  38
  39 #ifdef __cplusplus
  40 extern "C"
  41 {
  42 #endif
  43
  44 // PL_TAG is made as generic predefined tag because of build problems in arduino for using logging
  45 #define PL_TAG "PayloadLog"
  46
  47 #ifdef TB_LOG
  48     #define OIC_LOG_PAYLOAD(level, payload) OCPayloadLog((level),(payload))
  49     #define UUID_SIZE (16)
  50 const char *convertTriggerEnumToString(OCPresenceTrigger trigger);
  51 OCPresenceTrigger convertTriggerStringToEnum(const char * triggerStr);
  52
  53 #if defined(RD_CLIENT) || defined(RD_SERVER)
  54 INLINE_API void OCTagsLog(const LogLevel level, const OCTagsPayload *tags)
  55 {
  56     if (tags)
  57     {
  58         if (tags->n.deviceName)
  59         {
  60             OIC_LOG_V(level, PL_TAG, " Device Name : %s ", tags->n.deviceName);
  61         }
  62         if (tags->di.id)
  63         {
  64             OIC_LOG_V(level, PL_TAG, " Device ID : %s ", tags->di.id);
  65         }
  66         OIC_LOG_V(level, PL_TAG, " lt : %" PRIu64 ,tags->ttl);
  67     }
  68     else
  69     {
  70         (void) level;
  71     }
  72 }
  73
  74 INLINE_API void OCLinksLog(const LogLevel level, const OCLinksPayload *links)
  75 {
  76     if (!links)
  77     {
  78         return;
  79     }
  80
  81     while (links)
  82     {
  83         if (links->href)
  84         {
  85             OIC_LOG_V(level, PL_TAG, "   href: %s ",links->href);
  86         }
  87         OIC_LOG(level, PL_TAG, "   RT: ");
  88         OCStringLL *rt = links->rt;
  89         while (rt)
  90         {
  91             if (rt->value)
  92             {
  93                 OIC_LOG_V(level, PL_TAG, "   %s", rt->value);
  94             }
  95             rt = rt->next;
  96         }
  97         OIC_LOG(level, PL_TAG, "   IF: ");
  98         OCStringLL *itf = links->itf;
  99         while (itf)
 100         {
 101             if (itf->value)
 102             {
 103                 OIC_LOG_V(level, PL_TAG, "   %s", itf->value);
 104             }
 105             itf = itf->next;
 106         }
 107         OIC_LOG(level, PL_TAG, "   MT: ");
 108         OCStringLL *mt = links->type;
 109         while (mt)
 110         {
 111             if (mt->value)
 112             {
 113                 OIC_LOG_V(level, PL_TAG, "   %s", mt->value);
 114             }
 115             mt = mt->next;
 116         }
 117         if (links->type)
 118         {
 119             OIC_LOG_V(level, PL_TAG, "   %s", links->type->value);
 120         }
 121         OIC_LOG_V(level, PL_TAG, "   INS: %d", links->ins);
 122         OIC_LOG_V(level, PL_TAG, "   TTL: %" PRIu64 , links->ttl);
 123         OIC_LOG_V(level, PL_TAG, "   P: %d", links->p);
 124         if (links->rel)
 125         {
 126             OIC_LOG_V(level, PL_TAG, "   REL: %s", links->rel);
 127         }
 128         if (links->title)
 129         {
 130             OIC_LOG_V(level, PL_TAG, "   TITLE: %s", links->title);
 131         }
 132         if (links->anchor)
 133         {
 134             OIC_LOG_V(level, PL_TAG, "   URI: %s", links->anchor);
 135         }
 136         links = links->next;
 137     }
 138 }
 139 #endif
 140 INLINE_API void OCPayloadLogRep(LogLevel level, OCRepPayload* payload)
 141 {
 142     OIC_LOG(level, (PL_TAG), "Payload Type: Representation");
 143     OCRepPayload* rep = payload;
 144     int i = 1;
 145     while(rep)
 146     {
 147         OIC_LOG_V(level, PL_TAG, "\tResource #%d", i);
 148         if(rep->uri)
 149         {
 150             OIC_LOG_V(level, PL_TAG, "\tURI:%s", rep->uri);
 151         }
 152
 153         OCStringLL* strll =  rep->types;
 154         if(strll)
 155         {
 156             OIC_LOG(level, PL_TAG, "\tResource Types:");
 157             while(strll)
 158             {
 159                 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 160                 strll = strll->next;
 161             }
 162         }
 163
 164         strll =  rep->interfaces;
 165         if(strll)
 166         {
 167             OIC_LOG(level, PL_TAG, "\tInterfaces:");
 168             while(strll)
 169             {
 170                 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 171                 strll = strll->next;
 172             }
 173         }
 174
 175         // TODO Finish Logging: Values
 176         OCRepPayloadValue* val = rep->values;
 177         OIC_LOG(level, PL_TAG, "\tValues:");
 178         while(val)
 179         {
 180             switch(val->type)
 181             {
 182                 case OCREP_PROP_NULL:
 183                     OIC_LOG_V(level, PL_TAG, "\t\t%s: NULL", val->name);
 184                     break;
 185                 case OCREP_PROP_INT:
 186                     OIC_LOG_V(level, PL_TAG, "\t\t%s(int):%zd", val->name, val->i);
 187                     break;
 188                 case OCREP_PROP_DOUBLE:
 189                     OIC_LOG_V(level, PL_TAG, "\t\t%s(double):%f", val->name, val->d);
 190                     break;
 191                 case OCREP_PROP_BOOL:
 192                     OIC_LOG_V(level, PL_TAG, "\t\t%s(bool):%s", val->name, val->b ? "true" : "false");
 193                     break;
 194                 case OCREP_PROP_STRING:
 195                     OIC_LOG_V(level, PL_TAG, "\t\t%s(string):%s", val->name, val->str);
 196                     break;
 197                 case OCREP_PROP_BYTE_STRING:
 198                     OIC_LOG_V(level, PL_TAG, "\t\t%s(binary):", val->name);
 199                     OIC_LOG_BUFFER(level, PL_TAG, val->ocByteStr.bytes, val->ocByteStr.len);
 200                     break;
 201                 case OCREP_PROP_OBJECT:
 202                     OIC_LOG_V(level, PL_TAG, "\t\t%s(OCRep):%s", val->name, val->obj->uri);
 203                     OCPayloadLogRep(level, val->obj);
 204                     break;
 205                 case OCREP_PROP_ARRAY:
 206                     switch(val->arr.type)
 207                     {
 208                         case OCREP_PROP_INT:
 209                             OIC_LOG_V(level, PL_TAG, "\t\t%s(int array):%zu x %zu x %zu",
 210                                     val->name,
 211                                     val->arr.dimensions[0], val->arr.dimensions[1],
 212                                     val->arr.dimensions[2]);
 213                             break;
 214                         case OCREP_PROP_DOUBLE:
 215                             OIC_LOG_V(level, PL_TAG, "\t\t%s(double array):%zu x %zu x %zu",
 216                                     val->name,
 217                                     val->arr.dimensions[0], val->arr.dimensions[1],
 218                                     val->arr.dimensions[2]);
 219                             break;
 220                         case OCREP_PROP_BOOL:
 221                             OIC_LOG_V(level, PL_TAG, "\t\t%s(bool array):%zu x %zu x %zu",
 222                                     val->name,
 223                                     val->arr.dimensions[0], val->arr.dimensions[1],
 224                                     val->arr.dimensions[2]);
 225                             break;
 226                         case OCREP_PROP_STRING:
 227                             OIC_LOG_V(level, PL_TAG, "\t\t%s(string array):%zu x %zu x %zu",
 228                                     val->name,
 229                                     val->arr.dimensions[0], val->arr.dimensions[1],
 230                                     val->arr.dimensions[2]);
 231                             break;
 232                         case OCREP_PROP_BYTE_STRING:
 233                             OIC_LOG_V(level, PL_TAG, "\t\t%s(byte array):%zu x %zu x %zu",
 234                                     val->name,
 235                                     val->arr.dimensions[0], val->arr.dimensions[1],
 236                                     val->arr.dimensions[2]);
 237                             break;
 238                         case OCREP_PROP_OBJECT:
 239                         {
 240                             OIC_LOG_V(level, PL_TAG, "\t\t%s(OCRep array):%zu x %zu x %zu",
 241                                     val->name,
 242                                     val->arr.dimensions[0], val->arr.dimensions[1],
 243                                     val->arr.dimensions[2]);
 244
 245                             size_t i = 0;
 246                             if (val->arr.dimensions[0] > 0)
 247                             {
 248                                 for (i = 0 ; i < val->arr.dimensions[0] ; i++)
 249                                 {
 250                                     OCPayloadLogRep(level, val->arr.objArray[i]);
 251                                 }
 252                             }
 253                             break;
 254                         }
 255                         default:
 256                             OIC_LOG_V(ERROR, PL_TAG, "\t\t%s <-- Unknown/unsupported array type!",
 257                                     val->name);
 258                             break;
 259                     }
 260                     break;
 261                 default:
 262                     OIC_LOG_V(ERROR, PL_TAG, "\t\t%s <-- Unknown type!", val->name);
 263                     break;
 264             }
 265             val = val -> next;
 266         }
 267
 268         ++i;
 269         rep = rep->next;
 270     }
 271
 272 }
 273
 274 INLINE_API void OCPayloadLogDiscovery(LogLevel level, OCDiscoveryPayload* payload)
 275 {
 276     OIC_LOG(level, PL_TAG, "Payload Type: Discovery");
 277
 278     while(payload && payload->resources)
 279     {
 280         OIC_LOG_V(level, PL_TAG, "\tSID: %s", payload->sid);
 281         if (payload->baseURI)
 282         {
 283             OIC_LOG_V(level, PL_TAG, "\tBase URI:%s", payload->baseURI);
 284         }
 285         if (payload->name)
 286         {
 287             OIC_LOG_V(level, PL_TAG, "\tNAME: %s", payload->name);
 288         }
 289         if (payload->uri)
 290         {
 291             OIC_LOG_V(level, PL_TAG, "\tURI: %s", payload->uri);
 292         }
 293         if (payload->type)
 294         {
 295             for (OCStringLL *strll = payload->type; strll; strll = strll->next)
 296             {
 297                 OIC_LOG_V(level, PL_TAG, "\tResource Type: %s", strll->value);
 298             }
 299         }
 300         OIC_LOG(level, PL_TAG, "\tInterface:");
 301         for (OCStringLL *itf = payload->iface; itf; itf = itf->next)
 302         {
 303             OIC_LOG_V(level, PL_TAG, "\t\t%s", itf->value);
 304         }
 305
 306         OCResourcePayload* res = payload->resources;
 307
 308         int i = 1;
 309         while(res)
 310         {
 311             OIC_LOG_V(level, PL_TAG, "\tResource #%d", i);
 312             OIC_LOG_V(level, PL_TAG, "\tURI:%s", res->uri);
 313             OIC_LOG(level, PL_TAG, "\tResource Types:");
 314             OCStringLL* strll =  res->types;
 315             while(strll)
 316             {
 317                 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 318                 strll = strll->next;
 319             }
 320             OIC_LOG(level, PL_TAG, "\tInterfaces:");
 321             strll =  res->interfaces;
 322             while(strll)
 323             {
 324                 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 325                 strll = strll->next;
 326             }
 327
 328             OIC_LOG_V(level, PL_TAG, "\tBitmap: %u", res->bitmap);
 329             OIC_LOG_V(level, PL_TAG, "\tSecure?: %s", res->secure ? "true" : "false");
 330             OIC_LOG_V(level, PL_TAG, "\tPort: %u", res->port);
 331             OIC_LOG(level, PL_TAG, "");
 332             res = res->next;
 333             ++i;
 334         }
 335         payload = payload->next;
 336     }
 337 }
 338
 339 INLINE_API void OCPayloadLogDevice(LogLevel level, OCDevicePayload* payload)
 340 {
 341     OIC_LOG(level, PL_TAG, "Payload Type: Device");
 342     OIC_LOG_V(level, PL_TAG, "\tSID:%s", payload->sid);
 343     OIC_LOG_V(level, PL_TAG, "\tDevice Name:%s", payload->deviceName);
 344     OIC_LOG_V(level, PL_TAG, "\tSpec Version:%s", payload->specVersion);
 345     if (payload->dataModelVersions)
 346     {
 347         OIC_LOG(level, PL_TAG, "\tData Model Version:");
 348         for (OCStringLL *strll = payload->dataModelVersions; strll; strll = strll->next)
 349         {
 350             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 351         }
 352     }
 353     if (payload->types)
 354     {
 355         OIC_LOG(level, PL_TAG, "\tResource Type:");
 356         for (OCStringLL *strll = payload->types; strll; strll = strll->next)
 357         {
 358             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 359         }
 360     }
 361     if (payload->interfaces)
 362     {
 363         OIC_LOG(level, PL_TAG, "\tInterface:");
 364         for (OCStringLL *strll = payload->interfaces; strll; strll = strll->next)
 365         {
 366             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 367         }
 368     }
 369 }
 370
 371 INLINE_API void OCPayloadLogPlatform(LogLevel level, OCPlatformPayload* payload)
 372 {
 373     OIC_LOG(level, PL_TAG, "Payload Type: Platform");
 374     OIC_LOG_V(level, PL_TAG, "\tURI:%s", payload->uri);
 375     OIC_LOG_V(level, PL_TAG, "\tPlatform ID:%s", payload->info.platformID);
 376     OIC_LOG_V(level, PL_TAG, "\tMfg Name:%s", payload->info.manufacturerName);
 377     OIC_LOG_V(level, PL_TAG, "\tMfg URL:%s", payload->info.manufacturerUrl);
 378     OIC_LOG_V(level, PL_TAG, "\tModel Number:%s", payload->info.modelNumber);
 379     OIC_LOG_V(level, PL_TAG, "\tDate of Mfg:%s", payload->info.dateOfManufacture);
 380     OIC_LOG_V(level, PL_TAG, "\tPlatform Version:%s", payload->info.platformVersion);
 381     OIC_LOG_V(level, PL_TAG, "\tOS Version:%s", payload->info.operatingSystemVersion);
 382     OIC_LOG_V(level, PL_TAG, "\tHardware Version:%s", payload->info.hardwareVersion);
 383     OIC_LOG_V(level, PL_TAG, "\tFirmware Version:%s", payload->info.firmwareVersion);
 384     OIC_LOG_V(level, PL_TAG, "\tSupport URL:%s", payload->info.supportUrl);
 385     OIC_LOG_V(level, PL_TAG, "\tSystem Time:%s", payload->info.systemTime);
 386
 387     if (payload->rt)
 388     {
 389         OIC_LOG(level, PL_TAG, "\tResource Types:");
 390         for (OCStringLL *strll = payload->rt; strll; strll = strll->next)
 391         {
 392             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 393         }
 394     }
 395     if (payload->interfaces)
 396     {
 397         OIC_LOG(level, PL_TAG, "\tResource Interfaces:");
 398         for (OCStringLL *strll = payload->interfaces; strll; strll = strll->next)
 399         {
 400             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 401         }
 402     }
 403 }
 404
 405 INLINE_API void OCPayloadLogPresence(LogLevel level, OCPresencePayload* payload)
 406 {
 407     OIC_LOG(level, PL_TAG, "Payload Type: Presence");
 408     OIC_LOG_V(level, PL_TAG, "\tSequence Number:%u", payload->sequenceNumber);
 409     OIC_LOG_V(level, PL_TAG, "\tMax Age:%d", payload->maxAge);
 410     OIC_LOG_V(level, PL_TAG, "\tTrigger:%s", convertTriggerEnumToString(payload->trigger));
 411     OIC_LOG_V(level, PL_TAG, "\tResource Type:%s", payload->resourceType);
 412 }
 413
 414 INLINE_API void OCPayloadLogSecurity(LogLevel level, OCSecurityPayload* payload)
 415 {
 416     size_t payloadSize = payload->payloadSize;
 417     OIC_LOG(level, PL_TAG, "Payload Type: Security");
 418
 419     if (payloadSize > 0)
 420     {
 421         // Add a zero-character string terminator.
 422         char *securityData = (char *)OICMalloc(payloadSize + 1);
 423
 424         if (securityData)
 425         {
 426             memcpy(securityData, payload->securityData, payloadSize);
 427             assert(securityData[payloadSize - 1] != '\0');
 428             securityData[payloadSize] = '\0';
 429             OIC_LOG_V(level, PL_TAG, "\tSecurity Data: %s", securityData);
 430             OICFree(securityData);
 431         }
 432     }
 433 }
 434
 435 #if defined(RD_CLIENT) || defined(RD_SERVER)
 436 INLINE_API void OCRDPayloadLog(const LogLevel level, const OCRDPayload *payload)
 437 {
 438     if (!payload)
 439     {
 440         return;
 441     }
 442
 443     if (payload->rdDiscovery)
 444     {
 445         OIC_LOG(level, PL_TAG, "RD Discovery");
 446         OIC_LOG_V(level, PL_TAG, "  Device Name : %s", payload->rdDiscovery->n.deviceName);
 447         OIC_LOG_V(level, PL_TAG, "  Device Identity : %s", payload->rdDiscovery->di.id);
 448         OIC_LOG_V(level, PL_TAG, "  Bias: %d", payload->rdDiscovery->sel);
 449     }
 450     if (payload->rdPublish)
 451     {
 452         OIC_LOG(level, PL_TAG, "RD Publish");
 453         OCResourceCollectionPayload *rdPublish = payload->rdPublish;
 454         OCTagsLog(level, rdPublish->tags);
 455         OCLinksLog(level, rdPublish->setLinks);
 456     }
 457 }
 458 #endif
 459 INLINE_API void OCPayloadLog(LogLevel level, OCPayload* payload)
 460 {
 461     if(!payload)
 462     {
 463         OIC_LOG(level, PL_TAG, "NULL Payload");
 464         return;
 465     }
 466     switch(payload->type)
 467     {
 468         case PAYLOAD_TYPE_REPRESENTATION:
 469             OCPayloadLogRep(level, (OCRepPayload*)payload);
 470             break;
 471         case PAYLOAD_TYPE_DISCOVERY:
 472             OCPayloadLogDiscovery(level, (OCDiscoveryPayload*)payload);
 473             break;
 474         case PAYLOAD_TYPE_DEVICE:
 475             OCPayloadLogDevice(level, (OCDevicePayload*)payload);
 476             break;
 477         case PAYLOAD_TYPE_PLATFORM:
 478             OCPayloadLogPlatform(level, (OCPlatformPayload*)payload);
 479             break;
 480         case PAYLOAD_TYPE_PRESENCE:
 481             OCPayloadLogPresence(level, (OCPresencePayload*)payload);
 482             break;
 483         case PAYLOAD_TYPE_SECURITY:
 484             OCPayloadLogSecurity(level, (OCSecurityPayload*)payload);
 485             break;
 486 #if defined(RD_CLIENT) || defined(RD_SERVER)
 487         case PAYLOAD_TYPE_RD:
 488             OCRDPayloadLog(level, (OCRDPayload*)payload);
 489             break;
 490 #endif
 491         default:
 492             OIC_LOG_V(level, PL_TAG, "Unknown Payload Type: %d", payload->type);
 493             break;
 494     }
 495 }
 496 #else
 497     #define OIC_LOG_PAYLOAD(level, payload)
 498 #endif
 499
 500 #ifdef __cplusplus
 501 }
 502 #endif
 503
 504 #endif