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