Merge pull request #635 from openweave/feature/CheckEventWithNotifySize

Add a check to drop a large event.

Author: robszewczyk

src/lib/core/WeaveError.cpp

@@ -232,6 +232,7 @@ bool FormatWeaveError(char * buf, uint16_t bufSize, int32_t err)
     case WEAVE_ERROR_SESSION_KEY_SUSPENDED                      : desc = "Session key suspended"; break;
     case WEAVE_ERROR_UNSUPPORTED_WIRELESS_REGULATORY_DOMAIN     : desc = "Unsupported wireless regulatory domain"; break;
     case WEAVE_ERROR_UNSUPPORTED_WIRELESS_OPERATING_LOCATION    : desc = "Unsupported wireless operating location"; break;
+    case WEAVE_ERROR_WDM_EVENT_TOO_BIG                          : desc = "The WDM Event is too big to be successfully transmitted to a peer node"; break;
     }
 #endif // !WEAVE_CONFIG_SHORT_ERROR_STR
 

src/lib/core/WeaveError.h

@@ -1757,6 +1757,17 @@ typedef WEAVE_CONFIG_ERROR_TYPE WEAVE_ERROR;
  */
 #define WEAVE_ERROR_UNSUPPORTED_WIRELESS_OPERATING_LOCATION      _WEAVE_ERROR(185)
 
+/**
+ *  @def WEAVE_ERROR_WDM_EVENT_TOO_BIG
+ *
+ *  @brief
+ *    The specified event is too big to be successfully transmitted to a peer node,
+ *    e.g., it exceeds the maximum WDM Notification message size
+ *    limit.
+ *
+ */
+#define WEAVE_ERROR_WDM_EVENT_TOO_BIG                            _WEAVE_ERROR(186)
+
 
 /**
  *  @}

src/lib/profiles/data-management/Current/LoggingManagement.cpp

@@ -1314,6 +1314,8 @@ inline event_id_t LoggingManagement::LogEventPrivate(const EventSchema & inSchem
         CircularEventBuffer * buffer = mEventBuffer;
         do
         {
+            VerifyOrExit((WDM_MAX_NOTIFICATION_SIZE - WDM_NOTIFY_REQUEST_META_INFO_BYTES_MAX) >= writer.GetLengthWritten(),
+                         err = WEAVE_ERROR_WDM_EVENT_TOO_BIG);
             VerifyOrExit(buffer->mBuffer.GetQueueSize() >= writer.GetLengthWritten(), err = WEAVE_ERROR_BUFFER_TOO_SMALL);
             if (buffer->IsFinalDestinationForImportance(inSchema.mImportance))
                 break;
@@ -1329,6 +1331,7 @@ inline event_id_t LoggingManagement::LogEventPrivate(const EventSchema & inSchem
     if (err != WEAVE_NO_ERROR)
     {
         mEventBuffer->mBuffer = checkpoint;
+        WeaveLogError(EventLogging, "Failed to log event for profile id: 0x%x (err: %d)", inSchema.mProfileId, err);
     }
     else if (inSchema.mImportance <= GetCurrentImportance(inSchema.mProfileId))
     {

src/lib/profiles/data-management/Current/NotificationEngine.h

@@ -33,6 +33,13 @@
 #include <Weave/Profiles/data-management/TraitData.h>
 #include <Weave/Profiles/data-management/TraitCatalog.h>
 
+// Reserve bytes that would account for additional formulation overhead
+// of a Notify Request(beyond the event and the data lists) containing
+// meta information, e.g., SubscriptionId, etc. This is a conservative
+// estimate that should serve as a loose upper bound, and help in bounding
+// the maximum size of a WDM event.
+#define WDM_NOTIFY_REQUEST_META_INFO_BYTES_MAX  (64)
+
 namespace nl {
 namespace Weave {
 namespace Profiles {

src/test-apps/TestErrorStr.cpp

@@ -294,6 +294,7 @@ static int32_t sContext[] =
       WEAVE_ERROR_SESSION_KEY_SUSPENDED,
       WEAVE_ERROR_UNSUPPORTED_WIRELESS_REGULATORY_DOMAIN,
       WEAVE_ERROR_UNSUPPORTED_WIRELESS_OPERATING_LOCATION,
+      WEAVE_ERROR_WDM_EVENT_TOO_BIG,
 
       WEAVE_ERROR_TUNNEL_ROUTING_RESTRICTED,