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