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
  36 #include <inttypes.h>
  37 #include "oic_malloc.h"
  38 #include "ocpayload.h"
  39 #include "ocstack.h"
  40
  41 #ifdef __cplusplus
  42 extern "C"
  43 {
  44 #endif
  45
  46 // PL_TAG is made as generic predefined tag because of build problems in arduino for using logging
  47 #define PL_TAG "PayloadLog"
  48
  49 #ifdef TB_LOG
  50     #define OIC_LOG_PAYLOAD(level, payload) OCPayloadLog((level),(payload))
  51     #define UUID_SIZE (16)
  52
  53 #ifdef WITH_PRESENCE
  54 const char *convertTriggerEnumToString(OCPresenceTrigger trigger);
  55 OCPresenceTrigger convertTriggerStringToEnum(const char * triggerStr);
  56 #endif
  57
  58 INLINE_API void OCPayloadLogRep(LogLevel level, OCRepPayload* payload);
  59
  60 INLINE_API void OCPayloadLogRepValues(LogLevel level, OCRepPayloadValue* val)
  61 {
  62     while (val)
  63     {
  64         switch(val->type)
  65         {
  66             case OCREP_PROP_NULL:
  67                 OIC_LOG_V(level, PL_TAG, "\t\t%s: NULL", val->name);
  68                 break;
  69             case OCREP_PROP_INT:
  70                 OIC_LOG_V(level, PL_TAG, "\t\t%s(int):%zd", val->name, val->i);
  71                 break;
  72             case OCREP_PROP_DOUBLE:
  73                 OIC_LOG_V(level, PL_TAG, "\t\t%s(double):%f", val->name, val->d);
  74                 break;
  75             case OCREP_PROP_BOOL:
  76                 OIC_LOG_V(level, PL_TAG, "\t\t%s(bool):%s", val->name, val->b ? "true" : "false");
  77                 break;
  78             case OCREP_PROP_STRING:
  79                 OIC_LOG_V(level, PL_TAG, "\t\t%s(string):%s", val->name, val->str);
  80                 break;
  81             case OCREP_PROP_BYTE_STRING:
  82                 OIC_LOG_V(level, PL_TAG, "\t\t%s(binary):", val->name);
  83                 OIC_LOG_BUFFER(level, PL_TAG, val->ocByteStr.bytes, val->ocByteStr.len);
  84                 break;
  85             case OCREP_PROP_OBJECT:
  86                 // Note: Only prints the URI (if available), to print further, you'll
  87                 // need to dig into the object better!
  88                 OIC_LOG_V(level, PL_TAG, "\t\t%s(object):", val->name);
  89                 OCPayloadLogRep(level, val->obj);
  90                 break;
  91             case OCREP_PROP_ARRAY:
  92                 switch(val->arr.type)
  93                 {
  94                     case OCREP_PROP_INT:
  95                         OIC_LOG_V(level, PL_TAG, "\t\t%s(int array):%zu x %zu x %zu: ",
  96                                 val->name,
  97                                 val->arr.dimensions[0], val->arr.dimensions[1],
  98                                 val->arr.dimensions[2]);
  99                         OIC_LOG(level, PL_TAG, "\t\t Values:");
 100                         for (size_t i = 0; i < val->arr.dimensions[0]; i++)
 101                         {
 102                             OIC_LOG_V(level, PL_TAG, "\t\t\t %zd", val->arr.iArray[i]);
 103                         }
 104                         break;
 105                     case OCREP_PROP_DOUBLE:
 106                         OIC_LOG_V(level, PL_TAG, "\t\t%s(double array):%zu x %zu x %zu: ",
 107                                 val->name,
 108                                 val->arr.dimensions[0], val->arr.dimensions[1],
 109                                 val->arr.dimensions[2]);
 110                         OIC_LOG(level, PL_TAG, "\t\t Values:");
 111                         for (size_t i = 0; i < val->arr.dimensions[0]; i++)
 112                         {
 113                             OIC_LOG_V(level, PL_TAG, "\t\t\t %lf", val->arr.dArray[i]);
 114                         }
 115                         break;
 116                     case OCREP_PROP_BOOL:
 117                         OIC_LOG_V(level, PL_TAG, "\t\t%s(bool array):%zu x %zu x %zu: ",
 118                                 val->name,
 119                                 val->arr.dimensions[0], val->arr.dimensions[1],
 120                                 val->arr.dimensions[2]);
 121                         OIC_LOG(level, PL_TAG, "\t\t Values:");
 122                         for (size_t i = 0; i < val->arr.dimensions[0]; i++)
 123                         {
 124                             OIC_LOG_V(level, PL_TAG, "\t\t\t %d", val->arr.bArray[i]);
 125                         }
 126                         break;
 127                     case OCREP_PROP_STRING:
 128                         OIC_LOG_V(level, PL_TAG, "\t\t%s(string array):%zu x %zu x %zu: ",
 129                                 val->name,
 130                                 val->arr.dimensions[0], val->arr.dimensions[1],
 131                                 val->arr.dimensions[2]);
 132                         OIC_LOG(level, PL_TAG, "\t\t Values:");
 133                         for (size_t i = 0; i < val->arr.dimensions[0]; i++)
 134                         {
 135                             OIC_LOG_V(level, PL_TAG, "\t\t\t %s", val->arr.strArray[i]);
 136                         }
 137                         break;
 138                     case OCREP_PROP_BYTE_STRING:
 139                         OIC_LOG_V(level, PL_TAG, "\t\t%s(byte array):%zu x %zu x %zu: ",
 140                                 val->name,
 141                                 val->arr.dimensions[0], val->arr.dimensions[1],
 142                                 val->arr.dimensions[2]);
 143                         OIC_LOG(level, PL_TAG, "\t\t Values:");
 144                         for (size_t i = 0; i < val->arr.dimensions[0]; i++)
 145                         {
 146                             OIC_LOG_BUFFER(level, PL_TAG, val->arr.ocByteStrArray[i].bytes, val->arr.ocByteStrArray[i].len);
 147                         }
 148                         break;
 149                     case OCREP_PROP_OBJECT:
 150                         OIC_LOG_V(level, PL_TAG, "\t\t%s(object array):%zu x %zu x %zu: ",
 151                                 val->name,
 152                                 val->arr.dimensions[0], val->arr.dimensions[1],
 153                                 val->arr.dimensions[2]);
 154                         OIC_LOG(level, PL_TAG, "\t\t Values:");
 155
 156                         for (size_t i = 0; i < val->arr.dimensions[0]; i++)
 157                         {
 158                             OCPayloadLogRep(level, val->arr.objArray[i]);
 159                         }
 160                         break;
 161                     case OCREP_PROP_ARRAY: //Seems as nested arrays doesn't not supported in API
 162                     default:
 163                         OIC_LOG_V(ERROR, PL_TAG, "%s <-- Unknown/unsupported array type!",
 164                                 val->name);
 165                         break;
 166                 }
 167                 break;
 168             default:
 169                 OIC_LOG_V(ERROR, PL_TAG, "%s <-- Unknown type!", val->name);
 170                 break;
 171         }
 172         val = val -> next;
 173     }
 174 }
 175
 176 INLINE_API void OCPayloadLogRep(LogLevel level, OCRepPayload* payload)
 177 {
 178     OIC_LOG(level, (PL_TAG), "Payload Type: Representation");
 179     int i = 1;
 180     for (OCRepPayload* rep = payload; rep; rep = rep->next, ++i)
 181     {
 182         OIC_LOG_V(level, PL_TAG, "\tResource #%d", i);
 183         if (rep->uri)
 184         {
 185             OIC_LOG_V(level, PL_TAG, "\tURI:%s", rep->uri);
 186         }
 187         if (rep->types)
 188         {
 189             OIC_LOG(level, PL_TAG, "\tResource Types:");
 190             for (OCStringLL* strll = rep->types; strll; strll = strll->next)
 191             {
 192                 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 193             }
 194         }
 195         if (rep->interfaces)
 196         {
 197             OIC_LOG(level, PL_TAG, "\tInterfaces:");
 198             for (OCStringLL* strll = rep->interfaces; strll; strll = strll->next)
 199             {
 200                 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 201             }
 202         }
 203         OIC_LOG(level, PL_TAG, "\tValues:");
 204         OCPayloadLogRepValues(level, rep->values);
 205     }
 206 }
 207
 208 static void OCStringLLPrint(LogLevel level, OCStringLL *type)
 209 {
 210     for (OCStringLL *strll = type; strll; strll = strll->next)
 211     {
 212         OIC_LOG_V(level, PL_TAG, "\t\t %s", strll->value);
 213     }
 214 }
 215
 216 INLINE_API void OCPayloadLogDiscovery(LogLevel level, OCDiscoveryPayload* payload)
 217 {
 218     OIC_LOG(level, PL_TAG, "Payload Type: Discovery");
 219
 220     while(payload && payload->resources)
 221     {
 222         OIC_LOG_V(level, PL_TAG, "\tDI: %s", payload->sid);
 223         if (payload->baseURI)
 224         {
 225             OIC_LOG_V(level, PL_TAG, "\tBase URI:%s", payload->baseURI);
 226         }
 227         if (payload->name)
 228         {
 229             OIC_LOG_V(level, PL_TAG, "\tNAME: %s", payload->name);
 230         }
 231
 232         if (payload->type)
 233         {
 234             OIC_LOG(level, PL_TAG, "\tResource Type:");
 235             OCStringLLPrint(level, payload->type);
 236         }
 237
 238         if (payload->iface)
 239         {
 240             OIC_LOG(level, PL_TAG, "\tInterface:");
 241             OCStringLLPrint(level, payload->iface);
 242         }
 243
 244         OCResourcePayload* res = payload->resources;
 245
 246         int i = 1;
 247         while(res)
 248         {
 249             OIC_LOG_V(level, PL_TAG, "\tLink#%d", i);
 250             OIC_LOG_V(level, PL_TAG, "\tURI:%s", res->uri);
 251             OIC_LOG(level, PL_TAG, "\tResource Types:");
 252             OCStringLL* strll =  res->types;
 253             while(strll)
 254             {
 255                 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 256                 strll = strll->next;
 257             }
 258             OIC_LOG(level, PL_TAG, "\tInterfaces:");
 259             strll =  res->interfaces;
 260             while(strll)
 261             {
 262                 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 263                 strll = strll->next;
 264             }
 265
 266             OIC_LOG_V(level, PL_TAG, "\tBitmap: %u", res->bitmap);
 267             OIC_LOG_V(level, PL_TAG, "\tSecure?: %s", res->secure ? "true" : "false");
 268             OIC_LOG_V(level, PL_TAG, "\tPort: %u", res->port);
 269             OIC_LOG(level, PL_TAG, "");
 270             res = res->next;
 271             ++i;
 272         }
 273         payload = payload->next;
 274     }
 275 }
 276
 277 #ifdef WITH_PRESENCE
 278 INLINE_API void OCPayloadLogPresence(LogLevel level, OCPresencePayload* payload)
 279 {
 280     OIC_LOG(level, PL_TAG, "Payload Type: Presence");
 281     OIC_LOG_V(level, PL_TAG, "\tSequence Number:%u", payload->sequenceNumber);
 282     OIC_LOG_V(level, PL_TAG, "\tMax Age:%d", payload->maxAge);
 283     OIC_LOG_V(level, PL_TAG, "\tTrigger:%s", convertTriggerEnumToString(payload->trigger));
 284     OIC_LOG_V(level, PL_TAG, "\tResource Type:%s", payload->resourceType);
 285 }
 286 #endif // WITH_PRESENCE
 287
 288 INLINE_API void OCPayloadLogSecurity(LogLevel level, OCSecurityPayload* payload)
 289 {
 290     size_t payloadSize = payload->payloadSize;
 291     OIC_LOG(level, PL_TAG, "Payload Type: Security");
 292
 293     if (payloadSize > 0)
 294     {
 295         // Add a zero-character string terminator.
 296         char *securityData = (char *)OICMalloc(payloadSize + 1);
 297
 298         if (securityData)
 299         {
 300             memcpy(securityData, payload->securityData, payloadSize);
 301             // assert(securityData[payloadSize - 1] != '\0');
 302             securityData[payloadSize] = '\0';
 303             OIC_LOG_V(level, PL_TAG, "\tSecurity Data: %s", securityData);
 304             OICFree(securityData);
 305         }
 306     }
 307 }
 308
 309 INLINE_API void OCPayloadLog(LogLevel level, OCPayload* payload)
 310 {
 311     if(!payload)
 312     {
 313         OIC_LOG(level, PL_TAG, "NULL Payload");
 314         return;
 315     }
 316     switch(payload->type)
 317     {
 318         case PAYLOAD_TYPE_REPRESENTATION:
 319             OCPayloadLogRep(level, (OCRepPayload*)payload);
 320             break;
 321         case PAYLOAD_TYPE_DISCOVERY:
 322             OCPayloadLogDiscovery(level, (OCDiscoveryPayload*)payload);
 323             break;
 324 #ifdef WITH_PRESENCE
 325         case PAYLOAD_TYPE_PRESENCE:
 326             OCPayloadLogPresence(level, (OCPresencePayload*)payload);
 327             break;
 328 #endif
 329         case PAYLOAD_TYPE_SECURITY:
 330             OCPayloadLogSecurity(level, (OCSecurityPayload*)payload);
 331             break;
 332         default:
 333             OIC_LOG_V(level, PL_TAG, "Unknown Payload Type: %d", payload->type);
 334             break;
 335     }
 336 }
 337 #else
 338     #define OIC_LOG_PAYLOAD(level, payload)
 339 #endif
 340
 341 #ifdef __cplusplus
 342 }
 343 #endif
 344
 345 #endif