1 //******************************************************************
3 // Copyright 2015 Intel Mobile Communications GmbH All Rights Reserved.
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
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
11 // http://www.apache.org/licenses/LICENSE-2.0
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.
19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
21 #ifndef PAYLOAD_LOGGING_H_
22 #define PAYLOAD_LOGGING_H_
29 #ifndef __STDC_FORMAT_MACROS
30 #define __STDC_FORMAT_MACROS
32 #ifndef __STDC_LIMIT_MACROS
33 #define __STDC_LIMIT_MACROS
37 #include "oic_malloc.h"
38 #include "ocpayload.h"
46 // PL_TAG is made as generic predefined tag because of build problems in arduino for using logging
47 #define PL_TAG "PayloadLog"
50 #define OIC_LOG_PAYLOAD(level, payload) OCPayloadLog((level),(payload))
51 #define UUID_SIZE (16)
54 const char *convertTriggerEnumToString(OCPresenceTrigger trigger);
55 OCPresenceTrigger convertTriggerStringToEnum(const char * triggerStr);
58 INLINE_API void OCPayloadLogRep(LogLevel level, OCRepPayload* payload);
60 INLINE_API void OCPayloadLogRepValues(LogLevel level, OCRepPayloadValue* val)
67 OIC_LOG_V(level, PL_TAG, "\t\t%s: NULL", val->name);
70 OIC_LOG_V(level, PL_TAG, "\t\t%s(int):%" PRId64, val->name, val->i);
72 case OCREP_PROP_DOUBLE:
73 OIC_LOG_V(level, PL_TAG, "\t\t%s(double):%f", val->name, val->d);
76 OIC_LOG_V(level, PL_TAG, "\t\t%s(bool):%s", val->name, val->b ? "true" : "false");
78 case OCREP_PROP_STRING:
79 OIC_LOG_V(level, PL_TAG, "\t\t%s(string):%s", val->name, val->str);
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);
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);
91 case OCREP_PROP_ARRAY:
95 OIC_LOG_V(level, PL_TAG, "\t\t%s(int array):%zu x %zu x %zu: ",
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++)
102 OIC_LOG_V(level, PL_TAG, "\t\t\t %" PRId64, val->arr.iArray[i]);
105 case OCREP_PROP_DOUBLE:
106 OIC_LOG_V(level, PL_TAG, "\t\t%s(double array):%zu x %zu x %zu: ",
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++)
113 OIC_LOG_V(level, PL_TAG, "\t\t\t %lf", val->arr.dArray[i]);
116 case OCREP_PROP_BOOL:
117 OIC_LOG_V(level, PL_TAG, "\t\t%s(bool array):%zu x %zu x %zu: ",
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++)
124 OIC_LOG_V(level, PL_TAG, "\t\t\t %d", val->arr.bArray[i]);
127 case OCREP_PROP_STRING:
128 OIC_LOG_V(level, PL_TAG, "\t\t%s(string array):%zu x %zu x %zu: ",
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++)
135 OIC_LOG_V(level, PL_TAG, "\t\t\t %s", val->arr.strArray[i]);
138 case OCREP_PROP_BYTE_STRING:
139 OIC_LOG_V(level, PL_TAG, "\t\t%s(byte array):%zu x %zu x %zu: ",
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++)
146 OIC_LOG_BUFFER(level, PL_TAG, val->arr.ocByteStrArray[i].bytes, val->arr.ocByteStrArray[i].len);
149 case OCREP_PROP_OBJECT:
150 OIC_LOG_V(level, PL_TAG, "\t\t%s(object array):%zu x %zu x %zu: ",
152 val->arr.dimensions[0], val->arr.dimensions[1],
153 val->arr.dimensions[2]);
154 OIC_LOG(level, PL_TAG, "\t\t Values:");
156 for (size_t i = 0; i < val->arr.dimensions[0]; i++)
158 OCPayloadLogRep(level, val->arr.objArray[i]);
161 case OCREP_PROP_ARRAY: //Seems as nested arrays doesn't not supported in API
163 OIC_LOG_V(ERROR, PL_TAG, "%s <-- Unknown/unsupported array type!",
169 OIC_LOG_V(ERROR, PL_TAG, "%s <-- Unknown type!", val->name);
176 INLINE_API void OCPayloadLogRep(LogLevel level, OCRepPayload* payload)
178 OIC_LOG(level, (PL_TAG), "Payload Type: Representation");
180 for (OCRepPayload* rep = payload; rep; rep = rep->next, ++i)
182 OIC_LOG_V(level, PL_TAG, "\tResource #%d", i);
185 OIC_LOG_V(level, PL_TAG, "\tURI:%s", rep->uri);
189 OIC_LOG(level, PL_TAG, "\tResource Types:");
190 for (OCStringLL* strll = rep->types; strll; strll = strll->next)
192 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
197 OIC_LOG(level, PL_TAG, "\tInterfaces:");
198 for (OCStringLL* strll = rep->interfaces; strll; strll = strll->next)
200 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
203 OIC_LOG(level, PL_TAG, "\tValues:");
204 OCPayloadLogRepValues(level, rep->values);
208 static void OCStringLLPrint(LogLevel level, OCStringLL *type)
210 for (OCStringLL *strll = type; strll; strll = strll->next)
212 OIC_LOG_V(level, PL_TAG, "\t\t %s", strll->value);
216 INLINE_API void OCPayloadLogDiscovery(LogLevel level, OCDiscoveryPayload* payload)
218 OIC_LOG(level, PL_TAG, "Payload Type: Discovery");
220 while(payload && payload->resources)
222 OIC_LOG_V(level, PL_TAG, "\tDI: %s", payload->sid);
223 if (payload->baseURI)
225 OIC_LOG_V(level, PL_TAG, "\tBase URI:%s", payload->baseURI);
229 OIC_LOG_V(level, PL_TAG, "\tNAME: %s", payload->name);
234 OIC_LOG(level, PL_TAG, "\tResource Type:");
235 OCStringLLPrint(level, payload->type);
240 OIC_LOG(level, PL_TAG, "\tInterface:");
241 OCStringLLPrint(level, payload->iface);
244 OCResourcePayload* res = payload->resources;
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;
255 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
258 OIC_LOG(level, PL_TAG, "\tInterfaces:");
259 strll = res->interfaces;
262 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
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, "");
273 payload = payload->next;
278 INLINE_API void OCPayloadLogPresence(LogLevel level, OCPresencePayload* payload)
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);
286 #endif // WITH_PRESENCE
288 INLINE_API void OCPayloadLogSecurity(LogLevel level, OCSecurityPayload* payload)
290 size_t payloadSize = payload->payloadSize;
291 OIC_LOG(level, PL_TAG, "Payload Type: Security");
295 // Add a zero-character string terminator.
296 char *securityData = (char *)OICMalloc(payloadSize + 1);
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);
309 INLINE_API void OCPayloadLog(LogLevel level, OCPayload* payload)
313 OIC_LOG(level, PL_TAG, "NULL Payload");
316 switch(payload->type)
318 case PAYLOAD_TYPE_REPRESENTATION:
319 OCPayloadLogRep(level, (OCRepPayload*)payload);
321 case PAYLOAD_TYPE_DISCOVERY:
322 OCPayloadLogDiscovery(level, (OCDiscoveryPayload*)payload);
325 case PAYLOAD_TYPE_PRESENCE:
326 OCPayloadLogPresence(level, (OCPresencePayload*)payload);
329 case PAYLOAD_TYPE_SECURITY:
330 OCPayloadLogSecurity(level, (OCSecurityPayload*)payload);
333 OIC_LOG_V(level, PL_TAG, "Unknown Payload Type: %d", payload->type);
338 #define OIC_LOG_PAYLOAD(level, payload)