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