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 INLINE_API void OCPayloadLogRep(LogLevel level, OCRepPayload* payload)
  53 {
  54     OIC_LOG(level, (PL_TAG), "Payload Type: Representation");
  55     OCRepPayload* rep = payload;
  56     int i = 1;
  57     while(rep)
  58     {
  59         OIC_LOG_V(level, PL_TAG, "\tResource #%d", i);
  60         OIC_LOG_V(level, PL_TAG, "\tURI:%s", rep->uri);
  61         OIC_LOG(level, PL_TAG, "\tResource Types:");
  62         OCStringLL* strll =  rep->types;
  63         while(strll)
  64         {
  65             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
  66             strll = strll->next;
  67         }
  68         OIC_LOG(level, PL_TAG, "\tInterfaces:");
  69         strll =  rep->interfaces;
  70         while(strll)
  71         {
  72             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
  73             strll = strll->next;
  74         }
  75
  76         // TODO Finish Logging: Values
  77         OCRepPayloadValue* val = rep->values;
  78
  79         OIC_LOG(level, PL_TAG, "\tValues:");
  80
  81         while(val)
  82         {
  83             switch(val->type)
  84             {
  85                 case OCREP_PROP_NULL:
  86                     OIC_LOG_V(level, PL_TAG, "\t\t%s: NULL", val->name);
  87                     break;
  88                 case OCREP_PROP_INT:
  89                     OIC_LOG_V(level, PL_TAG, "\t\t%s(int):%zd", val->name, val->i);
  90                     break;
  91                 case OCREP_PROP_DOUBLE:
  92                     OIC_LOG_V(level, PL_TAG, "\t\t%s(double):%f", val->name, val->d);
  93                     break;
  94                 case OCREP_PROP_BOOL:
  95                     OIC_LOG_V(level, PL_TAG, "\t\t%s(bool):%s", val->name, val->b ? "true" : "false");
  96                     break;
  97                 case OCREP_PROP_STRING:
  98                     OIC_LOG_V(level, PL_TAG, "\t\t%s(string):%s", val->name, val->str);
  99                     break;
 100                 case OCREP_PROP_BYTE_STRING:
 101                     OIC_LOG_V(level, PL_TAG, "\t\t%s(binary):", val->name);
 102                     OIC_LOG_BUFFER(level, PL_TAG, val->ocByteStr.bytes, val->ocByteStr.len);
 103                     break;
 104                 case OCREP_PROP_OBJECT:
 105                     // Note: Only prints the URI (if available), to print further, you'll
 106                     // need to dig into the object better!
 107                     OIC_LOG_V(level, PL_TAG, "\t\t%s(OCRep):%s", val->name, val->obj->uri);
 108                     break;
 109                 case OCREP_PROP_ARRAY:
 110                     switch(val->arr.type)
 111                     {
 112                         case OCREP_PROP_INT:
 113                             OIC_LOG_V(level, PL_TAG, "\t\t%s(int array):%zu x %zu x %zu",
 114                                     val->name,
 115                                     val->arr.dimensions[0], val->arr.dimensions[1],
 116                                     val->arr.dimensions[2]);
 117                             break;
 118                         case OCREP_PROP_DOUBLE:
 119                             OIC_LOG_V(level, PL_TAG, "\t\t%s(double array):%zu x %zu x %zu",
 120                                     val->name,
 121                                     val->arr.dimensions[0], val->arr.dimensions[1],
 122                                     val->arr.dimensions[2]);
 123                             break;
 124                         case OCREP_PROP_BOOL:
 125                             OIC_LOG_V(level, PL_TAG, "\t\t%s(bool array):%zu x %zu x %zu",
 126                                     val->name,
 127                                     val->arr.dimensions[0], val->arr.dimensions[1],
 128                                     val->arr.dimensions[2]);
 129                             break;
 130                         case OCREP_PROP_STRING:
 131                             OIC_LOG_V(level, PL_TAG, "\t\t%s(string array):%zu x %zu x %zu",
 132                                     val->name,
 133                                     val->arr.dimensions[0], val->arr.dimensions[1],
 134                                     val->arr.dimensions[2]);
 135                             break;
 136                         case OCREP_PROP_BYTE_STRING:
 137                             OIC_LOG_V(level, PL_TAG, "\t\t%s(byte array):%zu x %zu x %zu",
 138                                     val->name,
 139                                     val->arr.dimensions[0], val->arr.dimensions[1],
 140                                     val->arr.dimensions[2]);
 141                             break;
 142                         case OCREP_PROP_OBJECT:
 143                             OIC_LOG_V(level, PL_TAG, "\t\t%s(OCRep array):%zu x %zu x %zu",
 144                                     val->name,
 145                                     val->arr.dimensions[0], val->arr.dimensions[1],
 146                                     val->arr.dimensions[2]);
 147                             break;
 148                         default:
 149                             OIC_LOG_V(ERROR, PL_TAG, "\t\t%s <-- Unknown/unsupported array type!",
 150                                     val->name);
 151                             break;
 152                     }
 153                     break;
 154                 default:
 155                     OIC_LOG_V(ERROR, PL_TAG, "\t\t%s <-- Unknown type!", val->name);
 156                     break;
 157             }
 158             val = val -> next;
 159         }
 160
 161         ++i;
 162         rep = rep->next;
 163     }
 164
 165 }
 166
 167 INLINE_API void OCPayloadLogDiscovery(LogLevel level, OCDiscoveryPayload* payload)
 168 {
 169     OIC_LOG(level, PL_TAG, "Payload Type: Discovery");
 170
 171     while(payload && payload->resources)
 172     {
 173         OIC_LOG_V(level, PL_TAG, "\tSID: %s", payload->sid);
 174         if (payload->baseURI)
 175         {
 176             OIC_LOG_V(level, PL_TAG, "\tBase URI:%s", payload->baseURI);
 177         }
 178         if (payload->name)
 179         {
 180             OIC_LOG_V(level, PL_TAG, "\tNAME: %s", payload->name);
 181         }
 182         if (payload->uri)
 183         {
 184             OIC_LOG_V(level, PL_TAG, "\tURI: %s", payload->uri);
 185         }
 186         if (payload->type)
 187         {
 188             for (OCStringLL *strll = payload->type; strll; strll = strll->next)
 189             {
 190                 OIC_LOG_V(level, PL_TAG, "\tResource Type: %s", strll->value);
 191             }
 192         }
 193         OIC_LOG(level, PL_TAG, "\tInterface:");
 194         for (OCStringLL *itf = payload->iface; itf; itf = itf->next)
 195         {
 196             OIC_LOG_V(level, PL_TAG, "\t\t%s", itf->value);
 197         }
 198
 199         OCResourcePayload* res = payload->resources;
 200
 201         int i = 1;
 202         while(res)
 203         {
 204             OIC_LOG_V(level, PL_TAG, "\tResource #%d", i);
 205             OIC_LOG_V(level, PL_TAG, "\tURI:%s", res->uri);
 206             OIC_LOG(level, PL_TAG, "\tResource Types:");
 207             OCStringLL* strll =  res->types;
 208             while(strll)
 209             {
 210                 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 211                 strll = strll->next;
 212             }
 213             OIC_LOG(level, PL_TAG, "\tInterfaces:");
 214             strll =  res->interfaces;
 215             while(strll)
 216             {
 217                 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 218                 strll = strll->next;
 219             }
 220
 221             OIC_LOG_V(level, PL_TAG, "\tBitmap: %u", res->bitmap);
 222             OIC_LOG_V(level, PL_TAG, "\tSecure?: %s", res->secure ? "true" : "false");
 223             OIC_LOG_V(level, PL_TAG, "\tPort: %u", res->port);
 224             OIC_LOG(level, PL_TAG, "");
 225             res = res->next;
 226             ++i;
 227         }
 228         payload = payload->next;
 229     }
 230 }
 231
 232 INLINE_API void OCPayloadLogDevice(LogLevel level, OCDevicePayload* payload)
 233 {
 234     OIC_LOG(level, PL_TAG, "Payload Type: Device");
 235     OIC_LOG_V(level, PL_TAG, "\tSID:%s", payload->sid);
 236     OIC_LOG_V(level, PL_TAG, "\tDevice Name:%s", payload->deviceName);
 237     OIC_LOG_V(level, PL_TAG, "\tSpec Version:%s", payload->specVersion);
 238     if (payload->dataModelVersions)
 239     {
 240         OIC_LOG(level, PL_TAG, "\tData Model Version:");
 241         for (OCStringLL *strll = payload->dataModelVersions; strll; strll = strll->next)
 242         {
 243             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 244         }
 245     }
 246     if (payload->types)
 247     {
 248         OIC_LOG(level, PL_TAG, "\tResource Type:");
 249         for (OCStringLL *strll = payload->types; strll; strll = strll->next)
 250         {
 251             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 252         }
 253     }
 254     if (payload->interfaces)
 255     {
 256         OIC_LOG(level, PL_TAG, "\tInterface:");
 257         for (OCStringLL *strll = payload->interfaces; strll; strll = strll->next)
 258         {
 259             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 260         }
 261     }
 262 }
 263
 264 INLINE_API void OCPayloadLogPlatform(LogLevel level, OCPlatformPayload* payload)
 265 {
 266     OIC_LOG(level, PL_TAG, "Payload Type: Platform");
 267     OIC_LOG_V(level, PL_TAG, "\tURI:%s", payload->uri);
 268     OIC_LOG_V(level, PL_TAG, "\tPlatform ID:%s", payload->info.platformID);
 269     OIC_LOG_V(level, PL_TAG, "\tMfg Name:%s", payload->info.manufacturerName);
 270     OIC_LOG_V(level, PL_TAG, "\tMfg URL:%s", payload->info.manufacturerUrl);
 271     OIC_LOG_V(level, PL_TAG, "\tModel Number:%s", payload->info.modelNumber);
 272     OIC_LOG_V(level, PL_TAG, "\tDate of Mfg:%s", payload->info.dateOfManufacture);
 273     OIC_LOG_V(level, PL_TAG, "\tPlatform Version:%s", payload->info.platformVersion);
 274     OIC_LOG_V(level, PL_TAG, "\tOS Version:%s", payload->info.operatingSystemVersion);
 275     OIC_LOG_V(level, PL_TAG, "\tHardware Version:%s", payload->info.hardwareVersion);
 276     OIC_LOG_V(level, PL_TAG, "\tFirmware Version:%s", payload->info.firmwareVersion);
 277     OIC_LOG_V(level, PL_TAG, "\tSupport URL:%s", payload->info.supportUrl);
 278     OIC_LOG_V(level, PL_TAG, "\tSystem Time:%s", payload->info.systemTime);
 279
 280     if (payload->rt)
 281     {
 282         OIC_LOG(level, PL_TAG, "\tResource Types:");
 283         for (OCStringLL *strll = payload->rt; strll; strll = strll->next)
 284         {
 285             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 286         }
 287     }
 288     if (payload->interfaces)
 289     {
 290         OIC_LOG(level, PL_TAG, "\tResource Interfaces:");
 291         for (OCStringLL *strll = payload->interfaces; strll; strll = strll->next)
 292         {
 293             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 294         }
 295     }
 296 }
 297
 298 INLINE_API void OCPayloadLogPresence(LogLevel level, OCPresencePayload* payload)
 299 {
 300     OIC_LOG(level, PL_TAG, "Payload Type: Presence");
 301     OIC_LOG_V(level, PL_TAG, "\tSequence Number:%u", payload->sequenceNumber);
 302     OIC_LOG_V(level, PL_TAG, "\tMax Age:%d", payload->maxAge);
 303     OIC_LOG_V(level, PL_TAG, "\tTrigger:%s", convertTriggerEnumToString(payload->trigger));
 304     OIC_LOG_V(level, PL_TAG, "\tResource Type:%s", payload->resourceType);
 305 }
 306
 307 INLINE_API void OCPayloadLogSecurity(LogLevel level, OCSecurityPayload* payload)
 308 {
 309     OIC_LOG(level, PL_TAG, "Payload Type: Security");
 310     OIC_LOG_V(level, PL_TAG, "\tSecurity Data: %s", payload->securityData);
 311 }
 312
 313 INLINE_API void OCRDPayloadLog(const LogLevel level, const OCRDPayload *payload)
 314 {
 315     if (!payload)
 316     {
 317         return;
 318     }
 319
 320     if (payload->rdDiscovery)
 321     {
 322         OIC_LOG(level, PL_TAG, "RD Discovery");
 323         OIC_LOG_V(level, PL_TAG, "  Device Name : %s", payload->rdDiscovery->n.deviceName);
 324         OIC_LOG_V(level, PL_TAG, "  Device Identity : %s", payload->rdDiscovery->di.id);
 325         OIC_LOG_V(level, PL_TAG, "  Bias: %d", payload->rdDiscovery->sel);
 326     }
 327     if (payload->rdPublish)
 328     {
 329         OIC_LOG(level, PL_TAG, "RD Publish");
 330         OCResourceCollectionPayload *rdPublish = payload->rdPublish;
 331         OCTagsLog(level, rdPublish->tags);
 332         OCLinksLog(level, rdPublish->setLinks);
 333     }
 334 }
 335
 336 INLINE_API void OCPayloadLog(LogLevel level, OCPayload* payload)
 337 {
 338     if(!payload)
 339     {
 340         OIC_LOG(level, PL_TAG, "NULL Payload");
 341         return;
 342     }
 343     switch(payload->type)
 344     {
 345         case PAYLOAD_TYPE_REPRESENTATION:
 346             OCPayloadLogRep(level, (OCRepPayload*)payload);
 347             break;
 348         case PAYLOAD_TYPE_DISCOVERY:
 349             OCPayloadLogDiscovery(level, (OCDiscoveryPayload*)payload);
 350             break;
 351         case PAYLOAD_TYPE_DEVICE:
 352             OCPayloadLogDevice(level, (OCDevicePayload*)payload);
 353             break;
 354         case PAYLOAD_TYPE_PLATFORM:
 355             OCPayloadLogPlatform(level, (OCPlatformPayload*)payload);
 356             break;
 357         case PAYLOAD_TYPE_PRESENCE:
 358             OCPayloadLogPresence(level, (OCPresencePayload*)payload);
 359             break;
 360         case PAYLOAD_TYPE_SECURITY:
 361             OCPayloadLogSecurity(level, (OCSecurityPayload*)payload);
 362             break;
 363         case PAYLOAD_TYPE_RD:
 364             OCRDPayloadLog(level, (OCRDPayload*)payload);
 365             break;
 366         default:
 367             OIC_LOG_V(level, PL_TAG, "Unknown Payload Type: %d", payload->type);
 368             break;
 369     }
 370 }
 371 #else
 372     #define OIC_LOG_PAYLOAD(level, payload)
 373 #endif
 374
 375 #ifdef __cplusplus
 376 }
 377 #endif
 378
 379 #endif