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 #define __STDC_FORMAT_MACROS
  30 #define __STDC_LIMIT_MACROS
  31 #include <inttypes.h>
  32 #include "rdpayload.h"
  33
  34 #ifdef __cplusplus
  35 extern "C"
  36 {
  37 #endif
  38
  39 // PL_TAG is made as generic predefined tag because of build problems in arduino for using logging
  40 #define PL_TAG "PayloadLog"
  41
  42 #ifdef TB_LOG
  43     #define OIC_LOG_PAYLOAD(level, payload) OCPayloadLog((level),(payload))
  44     #define UUID_SIZE (16)
  45 const char *convertTriggerEnumToString(OCPresenceTrigger trigger);
  46 OCPresenceTrigger convertTriggerStringToEnum(const char * triggerStr);
  47
  48 static inline void OCPayloadLogRep(LogLevel level, OCRepPayload* payload)
  49 {
  50     OIC_LOG(level, (PL_TAG), "Payload Type: Representation");
  51     OCRepPayload* rep = payload;
  52     int i = 1;
  53     while(rep)
  54     {
  55         OIC_LOG_V(level, PL_TAG, "\tResource #%d", i);
  56         OIC_LOG_V(level, PL_TAG, "\tURI:%s", rep->uri);
  57         OIC_LOG(level, PL_TAG, "\tResource Types:");
  58         OCStringLL* strll =  rep->types;
  59         while(strll)
  60         {
  61             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
  62             strll = strll->next;
  63         }
  64         OIC_LOG(level, PL_TAG, "\tInterfaces:");
  65         strll =  rep->interfaces;
  66         while(strll)
  67         {
  68             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
  69             strll = strll->next;
  70         }
  71
  72         // TODO Finish Logging: Values
  73         OCRepPayloadValue* val = rep->values;
  74
  75         OIC_LOG(level, PL_TAG, "\tValues:");
  76
  77         while(val)
  78         {
  79             switch(val->type)
  80             {
  81                 case OCREP_PROP_NULL:
  82                     OIC_LOG_V(level, PL_TAG, "\t\t%s: NULL", val->name);
  83                     break;
  84                 case OCREP_PROP_INT:
  85                     OIC_LOG_V(level, PL_TAG, "\t\t%s(int):%zd", val->name, val->i);
  86                     break;
  87                 case OCREP_PROP_DOUBLE:
  88                     OIC_LOG_V(level, PL_TAG, "\t\t%s(double):%f", val->name, val->d);
  89                     break;
  90                 case OCREP_PROP_BOOL:
  91                     OIC_LOG_V(level, PL_TAG, "\t\t%s(bool):%s", val->name, val->b ? "true" : "false");
  92                     break;
  93                 case OCREP_PROP_STRING:
  94                     OIC_LOG_V(level, PL_TAG, "\t\t%s(string):%s", val->name, val->str);
  95                     break;
  96                 case OCREP_PROP_BYTE_STRING:
  97                     OIC_LOG_V(level, PL_TAG, "\t\t%s(binary):", val->name);
  98                     OIC_LOG_BUFFER(level, PL_TAG, val->ocByteStr.bytes, val->ocByteStr.len);
  99                     break;
 100                 case OCREP_PROP_OBJECT:
 101                     // Note: Only prints the URI (if available), to print further, you'll
 102                     // need to dig into the object better!
 103                     OIC_LOG_V(level, PL_TAG, "\t\t%s(OCRep):%s", val->name, val->obj->uri);
 104                     break;
 105                 case OCREP_PROP_ARRAY:
 106                     switch(val->arr.type)
 107                     {
 108                         case OCREP_PROP_INT:
 109                             OIC_LOG_V(level, PL_TAG, "\t\t%s(int array):%zu x %zu x %zu",
 110                                     val->name,
 111                                     val->arr.dimensions[0], val->arr.dimensions[1],
 112                                     val->arr.dimensions[2]);
 113                             break;
 114                         case OCREP_PROP_DOUBLE:
 115                             OIC_LOG_V(level, PL_TAG, "\t\t%s(double array):%zu x %zu x %zu",
 116                                     val->name,
 117                                     val->arr.dimensions[0], val->arr.dimensions[1],
 118                                     val->arr.dimensions[2]);
 119                             break;
 120                         case OCREP_PROP_BOOL:
 121                             OIC_LOG_V(level, PL_TAG, "\t\t%s(bool array):%zu x %zu x %zu",
 122                                     val->name,
 123                                     val->arr.dimensions[0], val->arr.dimensions[1],
 124                                     val->arr.dimensions[2]);
 125                             break;
 126                         case OCREP_PROP_STRING:
 127                             OIC_LOG_V(level, PL_TAG, "\t\t%s(string array):%zu x %zu x %zu",
 128                                     val->name,
 129                                     val->arr.dimensions[0], val->arr.dimensions[1],
 130                                     val->arr.dimensions[2]);
 131                             break;
 132                         case OCREP_PROP_BYTE_STRING:
 133                             OIC_LOG_V(level, PL_TAG, "\t\t%s(byte array):%zu x %zu x %zu",
 134                                     val->name,
 135                                     val->arr.dimensions[0], val->arr.dimensions[1],
 136                                     val->arr.dimensions[2]);
 137                             break;
 138                         case OCREP_PROP_OBJECT:
 139                             OIC_LOG_V(level, PL_TAG, "\t\t%s(OCRep array):%zu x %zu x %zu",
 140                                     val->name,
 141                                     val->arr.dimensions[0], val->arr.dimensions[1],
 142                                     val->arr.dimensions[2]);
 143                             break;
 144                         default:
 145                             OIC_LOG_V(ERROR, PL_TAG, "\t\t%s <-- Unknown/unsupported array type!",
 146                                     val->name);
 147                             break;
 148                     }
 149                     break;
 150                 default:
 151                     OIC_LOG_V(ERROR, PL_TAG, "\t\t%s <-- Unknown type!", val->name);
 152                     break;
 153             }
 154             val = val -> next;
 155         }
 156
 157         ++i;
 158         rep = rep->next;
 159     }
 160
 161 }
 162
 163 static inline void OCPayloadLogDiscovery(LogLevel level, OCDiscoveryPayload* payload)
 164 {
 165     OIC_LOG(level, PL_TAG, "Payload Type: Discovery");
 166     int i = 1;
 167
 168     if(!payload->resources)
 169     {
 170         OIC_LOG(level, PL_TAG, "\tNO Resources");
 171         return;
 172     }
 173     OIC_LOG(level, PL_TAG, "\tSID:");
 174     OIC_LOG_BUFFER(level, PL_TAG, payload->sid, UUID_SIZE);
 175     OCResourcePayload* res = payload->resources;
 176
 177     while(res)
 178     {
 179         OIC_LOG_V(level, PL_TAG, "\tResource #%d", i);
 180         OIC_LOG_V(level, PL_TAG, "\tURI:%s", res->uri);
 181         OIC_LOG(level, PL_TAG, "\tResource Types:");
 182         OCStringLL* strll =  res->types;
 183         while(strll)
 184         {
 185             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 186             strll = strll->next;
 187         }
 188         OIC_LOG(level, PL_TAG, "\tInterfaces:");
 189         strll =  res->interfaces;
 190         while(strll)
 191         {
 192             OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 193             strll = strll->next;
 194         }
 195
 196         OIC_LOG_V(level, PL_TAG, "\tBitmap: %u", res->bitmap);
 197         OIC_LOG_V(level, PL_TAG, "\tSecure?: %s", res->secure ? "true" : "false");
 198         OIC_LOG_V(level, PL_TAG, "\tPort: %u", res->port);
 199         OIC_LOG(level, PL_TAG, "");
 200         res = res->next;
 201         ++i;
 202     }
 203 }
 204
 205 static inline void OCPayloadLogDevice(LogLevel level, OCDevicePayload* payload)
 206 {
 207     OIC_LOG(level, PL_TAG, "Payload Type: Device");
 208     OIC_LOG(level, PL_TAG, "\tSID:");
 209     OIC_LOG_BUFFER(level, PL_TAG, payload->sid, UUID_SIZE);
 210     OIC_LOG_V(level, PL_TAG, "\tDevice Name:%s", payload->deviceName);
 211     OIC_LOG_V(level, PL_TAG, "\tSpec Version%s", payload->specVersion);
 212     OIC_LOG_V(level, PL_TAG, "\tData Model Version:%s", payload->dataModelVersion);
 213 }
 214
 215 static inline void OCPayloadLogPlatform(LogLevel level, OCPlatformPayload* payload)
 216 {
 217     OIC_LOG(level, PL_TAG, "Payload Type: Platform");
 218     OIC_LOG_V(level, PL_TAG, "\tURI:%s", payload->uri);
 219     OIC_LOG_V(level, PL_TAG, "\tPlatform ID:%s", payload->info.platformID);
 220     OIC_LOG_V(level, PL_TAG, "\tMfg Name:%s", payload->info.manufacturerName);
 221     OIC_LOG_V(level, PL_TAG, "\tMfg URL:%s", payload->info.manufacturerUrl);
 222     OIC_LOG_V(level, PL_TAG, "\tModel Number:%s", payload->info.modelNumber);
 223     OIC_LOG_V(level, PL_TAG, "\tDate of Mfg:%s", payload->info.dateOfManufacture);
 224     OIC_LOG_V(level, PL_TAG, "\tPlatform Version:%s", payload->info.platformVersion);
 225     OIC_LOG_V(level, PL_TAG, "\tOS Version:%s", payload->info.operatingSystemVersion);
 226     OIC_LOG_V(level, PL_TAG, "\tHardware Version:%s", payload->info.hardwareVersion);
 227     OIC_LOG_V(level, PL_TAG, "\tFirmware Version:%s", payload->info.firmwareVersion);
 228     OIC_LOG_V(level, PL_TAG, "\tSupport URL:%s", payload->info.supportUrl);
 229     OIC_LOG_V(level, PL_TAG, "\tSystem Time:%s", payload->info.systemTime);
 230 }
 231
 232 static inline void OCPayloadLogPresence(LogLevel level, OCPresencePayload* payload)
 233 {
 234     OIC_LOG(level, PL_TAG, "Payload Type: Presence");
 235     OIC_LOG_V(level, PL_TAG, "\tSequence Number:%u", payload->sequenceNumber);
 236     OIC_LOG_V(level, PL_TAG, "\tMax Age:%d", payload->maxAge);
 237     OIC_LOG_V(level, PL_TAG, "\tTrigger:%s", convertTriggerEnumToString(payload->trigger));
 238     OIC_LOG_V(level, PL_TAG, "\tResource Type:%s", payload->resourceType);
 239 }
 240
 241 static inline void OCPayloadLogSecurity(LogLevel level, OCSecurityPayload* payload)
 242 {
 243     OIC_LOG(level, PL_TAG, "Payload Type: Security");
 244     OIC_LOG_V(level, PL_TAG, "\tSecurity Data: %s", payload->securityData);
 245 }
 246
 247 static inline void OCRDPayloadLog(const LogLevel level, const OCRDPayload *payload)
 248 {
 249     if (!payload)
 250     {
 251         return;
 252     }
 253
 254     if (payload->rdDiscovery)
 255     {
 256         OIC_LOG(level, PL_TAG, "RD Discovery");
 257         OIC_LOG_V(level, PL_TAG, "  Device Name : %s", payload->rdDiscovery->n.deviceName);
 258         OIC_LOG_V(level, PL_TAG, "  Device Identity : %s", payload->rdDiscovery->di.id);
 259         OIC_LOG_V(level, PL_TAG, "  Bias: %d", payload->rdDiscovery->sel);
 260     }
 261     if (payload->rdPublish)
 262     {
 263         OIC_LOG(level, PL_TAG, "RD Publish");
 264         OCResourceCollectionPayload *rdPublish = payload->rdPublish;
 265         OCTagsLog(level, rdPublish->tags);
 266         OCLinksLog(level, rdPublish->setLinks);
 267     }
 268 }
 269
 270 static inline void OCPayloadLog(LogLevel level, OCPayload* payload)
 271 {
 272     if(!payload)
 273     {
 274         OIC_LOG(level, PL_TAG, "NULL Payload");
 275         return;
 276     }
 277     switch(payload->type)
 278     {
 279         case PAYLOAD_TYPE_REPRESENTATION:
 280             OCPayloadLogRep(level, (OCRepPayload*)payload);
 281             break;
 282         case PAYLOAD_TYPE_DISCOVERY:
 283             OCPayloadLogDiscovery(level, (OCDiscoveryPayload*)payload);
 284             break;
 285         case PAYLOAD_TYPE_DEVICE:
 286             OCPayloadLogDevice(level, (OCDevicePayload*)payload);
 287             break;
 288         case PAYLOAD_TYPE_PLATFORM:
 289             OCPayloadLogPlatform(level, (OCPlatformPayload*)payload);
 290             break;
 291         case PAYLOAD_TYPE_PRESENCE:
 292             OCPayloadLogPresence(level, (OCPresencePayload*)payload);
 293             break;
 294         case PAYLOAD_TYPE_SECURITY:
 295             OCPayloadLogSecurity(level, (OCSecurityPayload*)payload);
 296             break;
 297         case PAYLOAD_TYPE_RD:
 298             OCRDPayloadLog(level, (OCRDPayload*)payload);
 299             break;
 300         default:
 301             OIC_LOG_V(level, PL_TAG, "Unknown Payload Type: %d", payload->type);
 302             break;
 303     }
 304 }
 305 #else
 306     #define OIC_LOG_PAYLOAD(level, payload)
 307 #endif
 308
 309 #ifdef __cplusplus
 310 }
 311 #endif
 312
 313 #endif