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     int i = 1;
 171
 172     if(!payload->resources)
 173     {
 174         OIC_LOG(level, PL_TAG, "\tNO Resources");
 175         return;
 176     }
 177     OIC_LOG_V(level, PL_TAG, "\tSID: %s", payload->sid);
 178     if (payload->baseURI)
 179     {
 180         OIC_LOG_V(level, PL_TAG, "\tBase URI:%s", payload->baseURI);
 181     }
 182     if (payload->name)
 183     {
 184         OIC_LOG_V(level, PL_TAG, "\tNAME: %s", payload->name);
 185     }
 186     if (payload->uri)
 187     {
 188         OIC_LOG_V(level, PL_TAG, "\tURI: %s", payload->uri);
 189     }
 190     if (payload->type)
 191     {
 192         OIC_LOG_V(level, PL_TAG, "\tResource Type: %s", payload->type);
 193     }
 194     OIC_LOG(level, PL_TAG, "\tInterface:");
 195     for (OCStringLL *itf = payload->iface; itf; itf = itf->next)
 196     {
 197         OIC_LOG_V(level, PL_TAG, "\t\t%s", itf->value);
 198     }
 199
 200     OCResourcePayload* res = payload->resources;
 201
 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 }
 229
 230 INLINE_API void OCPayloadLogDevice(LogLevel level, OCDevicePayload* payload)
 231 {
 232     OIC_LOG(level, PL_TAG, "Payload Type: Device");
 233     OIC_LOG_V(level, PL_TAG, "\tSID:%s", payload->sid);
 234     OIC_LOG_V(level, PL_TAG, "\tDevice Name:%s", payload->deviceName);
 235     OIC_LOG_V(level, PL_TAG, "\tSpec Version:%s", payload->specVersion);
 236     OIC_LOG_V(level, PL_TAG, "\tData Model Version:%s", payload->dataModelVersion);
 237     if (payload->types)
 238     {
 239         OIC_LOG(level, PL_TAG, "\tResource Type:");
 240         for (OCStringLL *strll = payload->types; strll; strll = strll->next)
 241         {
 242             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 243         }
 244     }
 245     if (payload->interfaces)
 246     {
 247         OIC_LOG(level, PL_TAG, "\tInterface:");
 248         for (OCStringLL *strll = payload->interfaces; strll; strll = strll->next)
 249         {
 250             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 251         }
 252     }
 253 }
 254
 255 INLINE_API void OCPayloadLogPlatform(LogLevel level, OCPlatformPayload* payload)
 256 {
 257     OIC_LOG(level, PL_TAG, "Payload Type: Platform");
 258     OIC_LOG_V(level, PL_TAG, "\tURI:%s", payload->uri);
 259     OIC_LOG_V(level, PL_TAG, "\tPlatform ID:%s", payload->info.platformID);
 260     OIC_LOG_V(level, PL_TAG, "\tMfg Name:%s", payload->info.manufacturerName);
 261     OIC_LOG_V(level, PL_TAG, "\tMfg URL:%s", payload->info.manufacturerUrl);
 262     OIC_LOG_V(level, PL_TAG, "\tModel Number:%s", payload->info.modelNumber);
 263     OIC_LOG_V(level, PL_TAG, "\tDate of Mfg:%s", payload->info.dateOfManufacture);
 264     OIC_LOG_V(level, PL_TAG, "\tPlatform Version:%s", payload->info.platformVersion);
 265     OIC_LOG_V(level, PL_TAG, "\tOS Version:%s", payload->info.operatingSystemVersion);
 266     OIC_LOG_V(level, PL_TAG, "\tHardware Version:%s", payload->info.hardwareVersion);
 267     OIC_LOG_V(level, PL_TAG, "\tFirmware Version:%s", payload->info.firmwareVersion);
 268     OIC_LOG_V(level, PL_TAG, "\tSupport URL:%s", payload->info.supportUrl);
 269     OIC_LOG_V(level, PL_TAG, "\tSystem Time:%s", payload->info.systemTime);
 270
 271     if (payload->rt)
 272     {
 273         OIC_LOG(level, PL_TAG, "\tResource Types:");
 274         OIC_LOG_V(level, PL_TAG, "\t\t%s", payload->rt);
 275     }
 276     if (payload->interfaces)
 277     {
 278         OIC_LOG(level, PL_TAG, "\tResource Interfaces:");
 279         for (OCStringLL *strll = payload->interfaces; strll; strll = strll->next)
 280         {
 281             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 282         }
 283     }
 284 }
 285
 286 INLINE_API void OCPayloadLogPresence(LogLevel level, OCPresencePayload* payload)
 287 {
 288     OIC_LOG(level, PL_TAG, "Payload Type: Presence");
 289     OIC_LOG_V(level, PL_TAG, "\tSequence Number:%u", payload->sequenceNumber);
 290     OIC_LOG_V(level, PL_TAG, "\tMax Age:%d", payload->maxAge);
 291     OIC_LOG_V(level, PL_TAG, "\tTrigger:%s", convertTriggerEnumToString(payload->trigger));
 292     OIC_LOG_V(level, PL_TAG, "\tResource Type:%s", payload->resourceType);
 293 }
 294
 295 INLINE_API void OCPayloadLogSecurity(LogLevel level, OCSecurityPayload* payload)
 296 {
 297     OIC_LOG(level, PL_TAG, "Payload Type: Security");
 298     OIC_LOG_V(level, PL_TAG, "\tSecurity Data: %s", payload->securityData);
 299 }
 300
 301 INLINE_API void OCRDPayloadLog(const LogLevel level, const OCRDPayload *payload)
 302 {
 303     if (!payload)
 304     {
 305         return;
 306     }
 307
 308     if (payload->rdDiscovery)
 309     {
 310         OIC_LOG(level, PL_TAG, "RD Discovery");
 311         OIC_LOG_V(level, PL_TAG, "  Device Name : %s", payload->rdDiscovery->n.deviceName);
 312         OIC_LOG_V(level, PL_TAG, "  Device Identity : %s", payload->rdDiscovery->di.id);
 313         OIC_LOG_V(level, PL_TAG, "  Bias: %d", payload->rdDiscovery->sel);
 314     }
 315     if (payload->rdPublish)
 316     {
 317         OIC_LOG(level, PL_TAG, "RD Publish");
 318         OCResourceCollectionPayload *rdPublish = payload->rdPublish;
 319         OCTagsLog(level, rdPublish->tags);
 320         OCLinksLog(level, rdPublish->setLinks);
 321     }
 322 }
 323
 324 INLINE_API void OCPayloadLog(LogLevel level, OCPayload* payload)
 325 {
 326     if(!payload)
 327     {
 328         OIC_LOG(level, PL_TAG, "NULL Payload");
 329         return;
 330     }
 331     switch(payload->type)
 332     {
 333         case PAYLOAD_TYPE_REPRESENTATION:
 334             OCPayloadLogRep(level, (OCRepPayload*)payload);
 335             break;
 336         case PAYLOAD_TYPE_DISCOVERY:
 337             OCPayloadLogDiscovery(level, (OCDiscoveryPayload*)payload);
 338             break;
 339         case PAYLOAD_TYPE_DEVICE:
 340             OCPayloadLogDevice(level, (OCDevicePayload*)payload);
 341             break;
 342         case PAYLOAD_TYPE_PLATFORM:
 343             OCPayloadLogPlatform(level, (OCPlatformPayload*)payload);
 344             break;
 345         case PAYLOAD_TYPE_PRESENCE:
 346             OCPayloadLogPresence(level, (OCPresencePayload*)payload);
 347             break;
 348         case PAYLOAD_TYPE_SECURITY:
 349             OCPayloadLogSecurity(level, (OCSecurityPayload*)payload);
 350             break;
 351         case PAYLOAD_TYPE_RD:
 352             OCRDPayloadLog(level, (OCRDPayload*)payload);
 353             break;
 354         default:
 355             OIC_LOG_V(level, PL_TAG, "Unknown Payload Type: %d", payload->type);
 356             break;
 357     }
 358 }
 359 #else
 360     #define OIC_LOG_PAYLOAD(level, payload)
 361 #endif
 362
 363 #ifdef __cplusplus
 364 }
 365 #endif
 366
 367 #endif