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         OIC_LOG_V(level, PL_TAG, "\tURI:%s", rep->uri);
 149         OIC_LOG(level, PL_TAG, "\tResource Types:");
 150         OCStringLL* strll =  rep->types;
 151         while(strll)
 152         {
 153             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 154             strll = strll->next;
 155         }
 156         OIC_LOG(level, PL_TAG, "\tInterfaces:");
 157         strll =  rep->interfaces;
 158         while(strll)
 159         {
 160             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 161             strll = strll->next;
 162         }
 163
 164         // TODO Finish Logging: Values
 165         OCRepPayloadValue* val = rep->values;
 166
 167         OIC_LOG(level, PL_TAG, "\tValues:");
 168
 169         while(val)
 170         {
 171             switch(val->type)
 172             {
 173                 case OCREP_PROP_NULL:
 174                     OIC_LOG_V(level, PL_TAG, "\t\t%s: NULL", val->name);
 175                     break;
 176                 case OCREP_PROP_INT:
 177                     OIC_LOG_V(level, PL_TAG, "\t\t%s(int):%zd", val->name, val->i);
 178                     break;
 179                 case OCREP_PROP_DOUBLE:
 180                     OIC_LOG_V(level, PL_TAG, "\t\t%s(double):%f", val->name, val->d);
 181                     break;
 182                 case OCREP_PROP_BOOL:
 183                     OIC_LOG_V(level, PL_TAG, "\t\t%s(bool):%s", val->name, val->b ? "true" : "false");
 184                     break;
 185                 case OCREP_PROP_STRING:
 186                     OIC_LOG_V(level, PL_TAG, "\t\t%s(string):%s", val->name, val->str);
 187                     break;
 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);
 191                     break;
 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);
 196                     break;
 197                 case OCREP_PROP_ARRAY:
 198                     switch(val->arr.type)
 199                     {
 200                         case OCREP_PROP_INT:
 201                             OIC_LOG_V(level, PL_TAG, "\t\t%s(int array):%zu x %zu x %zu",
 202                                     val->name,
 203                                     val->arr.dimensions[0], val->arr.dimensions[1],
 204                                     val->arr.dimensions[2]);
 205                             break;
 206                         case OCREP_PROP_DOUBLE:
 207                             OIC_LOG_V(level, PL_TAG, "\t\t%s(double array):%zu x %zu x %zu",
 208                                     val->name,
 209                                     val->arr.dimensions[0], val->arr.dimensions[1],
 210                                     val->arr.dimensions[2]);
 211                             break;
 212                         case OCREP_PROP_BOOL:
 213                             OIC_LOG_V(level, PL_TAG, "\t\t%s(bool array):%zu x %zu x %zu",
 214                                     val->name,
 215                                     val->arr.dimensions[0], val->arr.dimensions[1],
 216                                     val->arr.dimensions[2]);
 217                             break;
 218                         case OCREP_PROP_STRING:
 219                             OIC_LOG_V(level, PL_TAG, "\t\t%s(string array):%zu x %zu x %zu",
 220                                     val->name,
 221                                     val->arr.dimensions[0], val->arr.dimensions[1],
 222                                     val->arr.dimensions[2]);
 223                             break;
 224                         case OCREP_PROP_BYTE_STRING:
 225                             OIC_LOG_V(level, PL_TAG, "\t\t%s(byte array):%zu x %zu x %zu",
 226                                     val->name,
 227                                     val->arr.dimensions[0], val->arr.dimensions[1],
 228                                     val->arr.dimensions[2]);
 229                             break;
 230                         case OCREP_PROP_OBJECT:
 231                             OIC_LOG_V(level, PL_TAG, "\t\t%s(OCRep array):%zu x %zu x %zu",
 232                                     val->name,
 233                                     val->arr.dimensions[0], val->arr.dimensions[1],
 234                                     val->arr.dimensions[2]);
 235                             break;
 236                         default:
 237                             OIC_LOG_V(ERROR, PL_TAG, "\t\t%s <-- Unknown/unsupported array type!",
 238                                     val->name);
 239                             break;
 240                     }
 241                     break;
 242                 default:
 243                     OIC_LOG_V(ERROR, PL_TAG, "\t\t%s <-- Unknown type!", val->name);
 244                     break;
 245             }
 246             val = val -> next;
 247         }
 248
 249         ++i;
 250         rep = rep->next;
 251     }
 252
 253 }
 254
 255 INLINE_API void OCPayloadLogDiscovery(LogLevel level, OCDiscoveryPayload* payload)
 256 {
 257     OIC_LOG(level, PL_TAG, "Payload Type: Discovery");
 258
 259     while(payload && payload->resources)
 260     {
 261         OIC_LOG_V(level, PL_TAG, "\tSID: %s", payload->sid);
 262         if (payload->baseURI)
 263         {
 264             OIC_LOG_V(level, PL_TAG, "\tBase URI:%s", payload->baseURI);
 265         }
 266         if (payload->name)
 267         {
 268             OIC_LOG_V(level, PL_TAG, "\tNAME: %s", payload->name);
 269         }
 270         if (payload->uri)
 271         {
 272             OIC_LOG_V(level, PL_TAG, "\tURI: %s", payload->uri);
 273         }
 274         if (payload->type)
 275         {
 276             for (OCStringLL *strll = payload->type; strll; strll = strll->next)
 277             {
 278                 OIC_LOG_V(level, PL_TAG, "\tResource Type: %s", strll->value);
 279             }
 280         }
 281         OIC_LOG(level, PL_TAG, "\tInterface:");
 282         for (OCStringLL *itf = payload->iface; itf; itf = itf->next)
 283         {
 284             OIC_LOG_V(level, PL_TAG, "\t\t%s", itf->value);
 285         }
 286
 287         OCResourcePayload* res = payload->resources;
 288
 289         int i = 1;
 290         while(res)
 291         {
 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;
 296             while(strll)
 297             {
 298                 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 299                 strll = strll->next;
 300             }
 301             OIC_LOG(level, PL_TAG, "\tInterfaces:");
 302             strll =  res->interfaces;
 303             while(strll)
 304             {
 305                 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 306                 strll = strll->next;
 307             }
 308
 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, "");
 313             res = res->next;
 314             ++i;
 315         }
 316         payload = payload->next;
 317     }
 318 }
 319
 320 INLINE_API void OCPayloadLogDevice(LogLevel level, OCDevicePayload* payload)
 321 {
 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)
 327     {
 328         OIC_LOG(level, PL_TAG, "\tData Model Version:");
 329         for (OCStringLL *strll = payload->dataModelVersions; strll; strll = strll->next)
 330         {
 331             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 332         }
 333     }
 334     if (payload->types)
 335     {
 336         OIC_LOG(level, PL_TAG, "\tResource Type:");
 337         for (OCStringLL *strll = payload->types; strll; strll = strll->next)
 338         {
 339             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 340         }
 341     }
 342     if (payload->interfaces)
 343     {
 344         OIC_LOG(level, PL_TAG, "\tInterface:");
 345         for (OCStringLL *strll = payload->interfaces; strll; strll = strll->next)
 346         {
 347             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 348         }
 349     }
 350 }
 351
 352 INLINE_API void OCPayloadLogPlatform(LogLevel level, OCPlatformPayload* payload)
 353 {
 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);
 367
 368     if (payload->rt)
 369     {
 370         OIC_LOG(level, PL_TAG, "\tResource Types:");
 371         for (OCStringLL *strll = payload->rt; strll; strll = strll->next)
 372         {
 373             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 374         }
 375     }
 376     if (payload->interfaces)
 377     {
 378         OIC_LOG(level, PL_TAG, "\tResource Interfaces:");
 379         for (OCStringLL *strll = payload->interfaces; strll; strll = strll->next)
 380         {
 381             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 382         }
 383     }
 384 }
 385
 386 INLINE_API void OCPayloadLogPresence(LogLevel level, OCPresencePayload* payload)
 387 {
 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);
 393 }
 394
 395 INLINE_API void OCPayloadLogSecurity(LogLevel level, OCSecurityPayload* payload)
 396 {
 397     size_t payloadSize = payload->payloadSize;
 398     OIC_LOG(level, PL_TAG, "Payload Type: Security");
 399
 400     if (payloadSize > 0)
 401     {
 402         // Add a zero-character string terminator.
 403         char *securityData = (char *)OICMalloc(payloadSize + 1);
 404
 405         if (securityData)
 406         {
 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);
 412         }
 413     }
 414 }
 415
 416 #if defined(RD_CLIENT) || defined(RD_SERVER)
 417 INLINE_API void OCRDPayloadLog(const LogLevel level, const OCRDPayload *payload)
 418 {
 419     if (!payload)
 420     {
 421         return;
 422     }
 423
 424     if (payload->rdDiscovery)
 425     {
 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);
 430     }
 431     if (payload->rdPublish)
 432     {
 433         OIC_LOG(level, PL_TAG, "RD Publish");
 434         OCResourceCollectionPayload *rdPublish = payload->rdPublish;
 435         OCTagsLog(level, rdPublish->tags);
 436         OCLinksLog(level, rdPublish->setLinks);
 437     }
 438 }
 439 #endif
 440 INLINE_API void OCPayloadLog(LogLevel level, OCPayload* payload)
 441 {
 442     if(!payload)
 443     {
 444         OIC_LOG(level, PL_TAG, "NULL Payload");
 445         return;
 446     }
 447     switch(payload->type)
 448     {
 449         case PAYLOAD_TYPE_REPRESENTATION:
 450             OCPayloadLogRep(level, (OCRepPayload*)payload);
 451             break;
 452         case PAYLOAD_TYPE_DISCOVERY:
 453             OCPayloadLogDiscovery(level, (OCDiscoveryPayload*)payload);
 454             break;
 455         case PAYLOAD_TYPE_DEVICE:
 456             OCPayloadLogDevice(level, (OCDevicePayload*)payload);
 457             break;
 458         case PAYLOAD_TYPE_PLATFORM:
 459             OCPayloadLogPlatform(level, (OCPlatformPayload*)payload);
 460             break;
 461         case PAYLOAD_TYPE_PRESENCE:
 462             OCPayloadLogPresence(level, (OCPresencePayload*)payload);
 463             break;
 464         case PAYLOAD_TYPE_SECURITY:
 465             OCPayloadLogSecurity(level, (OCSecurityPayload*)payload);
 466             break;
 467 #if defined(RD_CLIENT) || defined(RD_SERVER)
 468         case PAYLOAD_TYPE_RD:
 469             OCRDPayloadLog(level, (OCRDPayload*)payload);
 470             break;
 471 #endif
 472         default:
 473             OIC_LOG_V(level, PL_TAG, "Unknown Payload Type: %d", payload->type);
 474             break;
 475     }
 476 }
 477 #else
 478     #define OIC_LOG_PAYLOAD(level, payload)
 479 #endif
 480
 481 #ifdef __cplusplus
 482 }
 483 #endif
 484
 485 #endif