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