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