/** * * Copyright (c) 2020 Project CHIP Authors * Copyright (c) 2018 Google LLC. * Copyright (c) 2016-2017 Nest Labs, Inc. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * @file * This file defines EventDataIB parser and builder in CHIP interaction model * */ #include "EventDataIB.h" #include "MessageDefHelper.h" #include #include #include #include namespace chip { namespace app { #if CHIP_CONFIG_IM_PRETTY_PRINT CHIP_ERROR EventDataIB::Parser::PrettyPrint() const { CHIP_ERROR err = CHIP_NO_ERROR; TLV::TLVReader reader; PRETTY_PRINT("EventDataIB ="); PRETTY_PRINT("{"); // make a copy of the Path reader reader.Init(mReader); while (CHIP_NO_ERROR == (err = reader.Next())) { if (!TLV::IsContextTag(reader.GetTag())) { continue; } uint32_t tagNum = TLV::TagNumFromTag(reader.GetTag()); switch (tagNum) { case to_underlying(Tag::kPath): { EventPathIB::Parser path; ReturnErrorOnFailure(path.Init(reader)); PRETTY_PRINT_INCDEPTH(); ReturnErrorOnFailure(path.PrettyPrint()); PRETTY_PRINT_DECDEPTH(); } break; case to_underlying(Tag::kEventNumber): VerifyOrReturnError(TLV::kTLVType_UnsignedInteger == reader.GetType(), CHIP_ERROR_WRONG_TLV_TYPE); #if CHIP_DETAIL_LOGGING { EventNumber number; ReturnErrorOnFailure(reader.Get(number)); PRETTY_PRINT("\tEventNumber = 0x" ChipLogFormatX64 ",", ChipLogValueX64(number)); } #endif // CHIP_DETAIL_LOGGING break; case to_underlying(Tag::kPriority): VerifyOrReturnError(TLV::kTLVType_UnsignedInteger == reader.GetType(), CHIP_ERROR_WRONG_TLV_TYPE); #if CHIP_DETAIL_LOGGING { uint64_t value; ReturnErrorOnFailure(reader.Get(value)); PRETTY_PRINT("\tPriorityLevel = 0x" ChipLogFormatX64 ",", ChipLogValueX64(value)); } #endif // CHIP_DETAIL_LOGGING break; case to_underlying(Tag::kEpochTimestamp): VerifyOrReturnError(TLV::kTLVType_UnsignedInteger == reader.GetType(), CHIP_ERROR_WRONG_TLV_TYPE); #if CHIP_DETAIL_LOGGING { uint64_t value; ReturnErrorOnFailure(reader.Get(value)); PRETTY_PRINT("\tEpochTimestamp = 0x" ChipLogFormatX64 ",", ChipLogValueX64(value)); } #endif // CHIP_DETAIL_LOGGING break; case to_underlying(Tag::kSystemTimestamp): VerifyOrReturnError(TLV::kTLVType_UnsignedInteger == reader.GetType(), CHIP_ERROR_WRONG_TLV_TYPE); #if CHIP_DETAIL_LOGGING { uint64_t value; ReturnErrorOnFailure(reader.Get(value)); PRETTY_PRINT("\tSystemTimestamp = 0x" ChipLogFormatX64 ",", ChipLogValueX64(value)); } #endif // CHIP_DETAIL_LOGGING break; case to_underlying(Tag::kDeltaEpochTimestamp): VerifyOrReturnError(TLV::kTLVType_UnsignedInteger == reader.GetType(), CHIP_ERROR_WRONG_TLV_TYPE); #if CHIP_DETAIL_LOGGING { uint64_t value; ReturnErrorOnFailure(reader.Get(value)); PRETTY_PRINT("\tDeltaEpochTimestampstamp= 0x" ChipLogFormatX64 ",", ChipLogValueX64(value)); } #endif // CHIP_DETAIL_LOGGING break; case to_underlying(Tag::kDeltaSystemTimestamp): VerifyOrReturnError(TLV::kTLVType_UnsignedInteger == reader.GetType(), CHIP_ERROR_WRONG_TLV_TYPE); #if CHIP_DETAIL_LOGGING { uint64_t value; ReturnErrorOnFailure(reader.Get(value)); PRETTY_PRINT("\tDeltaSystemTimestamp = 0x" ChipLogFormatX64 ",", ChipLogValueX64(value)); } #endif // CHIP_DETAIL_LOGGING break; case to_underlying(Tag::kData): PRETTY_PRINT_INCDEPTH(); ReturnErrorOnFailure(CheckIMPayload(reader, 0, "EventData")); PRETTY_PRINT_DECDEPTH(); break; default: PRETTY_PRINT("Unknown tag num %" PRIu32, tagNum); break; } } PRETTY_PRINT("},"); PRETTY_PRINT_BLANK_LINE(); // if we have exhausted this container if (CHIP_END_OF_TLV == err) { err = CHIP_NO_ERROR; } ReturnErrorOnFailure(err); return reader.ExitContainer(mOuterContainerType); } #endif // CHIP_CONFIG_IM_PRETTY_PRINT CHIP_ERROR EventDataIB::Parser::GetPath(EventPathIB::Parser * const apPath) { TLV::TLVReader reader; ReturnErrorOnFailure(mReader.FindElementWithTag(TLV::ContextTag(Tag::kPath), reader)); ReturnErrorOnFailure(apPath->Init(reader)); return CHIP_NO_ERROR; } CHIP_ERROR EventDataIB::Parser::GetPriority(uint8_t * const apPriority) { return GetUnsignedInteger(to_underlying(Tag::kPriority), apPriority); } CHIP_ERROR EventDataIB::Parser::GetEventNumber(EventNumber * const apEventNumber) { return GetUnsignedInteger(to_underlying(Tag::kEventNumber), apEventNumber); } CHIP_ERROR EventDataIB::Parser::GetEpochTimestamp(uint64_t * const apEpochTimestamp) { return GetUnsignedInteger(to_underlying(Tag::kEpochTimestamp), apEpochTimestamp); } CHIP_ERROR EventDataIB::Parser::GetSystemTimestamp(uint64_t * const apSystemTimestamp) { return GetUnsignedInteger(to_underlying(Tag::kSystemTimestamp), apSystemTimestamp); } CHIP_ERROR EventDataIB::Parser::GetDeltaEpochTimestamp(uint64_t * const apDeltaEpochTimestampstamp) { return GetUnsignedInteger(to_underlying(Tag::kDeltaEpochTimestamp), apDeltaEpochTimestampstamp); } CHIP_ERROR EventDataIB::Parser::GetDeltaSystemTimestamp(uint64_t * const apDeltaSystemTimestamp) { return GetUnsignedInteger(to_underlying(Tag::kDeltaSystemTimestamp), apDeltaSystemTimestamp); } CHIP_ERROR EventDataIB::Parser::GetData(TLV::TLVReader * const apReader) const { return mReader.FindElementWithTag(TLV::ContextTag(Tag::kData), *apReader); } CHIP_ERROR EventDataIB::Parser::ProcessEventPath(EventPathIB::Parser & aEventPath, ConcreteEventPath & aConcreteEventPath) { // The ReportData must contain a concrete event path CHIP_ERROR err = aEventPath.GetEndpoint(&(aConcreteEventPath.mEndpointId)); VerifyOrReturnError(err == CHIP_NO_ERROR, CHIP_ERROR_IM_MALFORMED_EVENT_PATH_IB); err = aEventPath.GetCluster(&(aConcreteEventPath.mClusterId)); VerifyOrReturnError(err == CHIP_NO_ERROR, CHIP_ERROR_IM_MALFORMED_EVENT_PATH_IB); err = aEventPath.GetEvent(&(aConcreteEventPath.mEventId)); VerifyOrReturnError(err == CHIP_NO_ERROR, CHIP_ERROR_IM_MALFORMED_EVENT_PATH_IB); return CHIP_NO_ERROR; } CHIP_ERROR EventDataIB::Parser::ProcessEventTimestamp(EventHeader & aEventHeader) { CHIP_ERROR err = CHIP_NO_ERROR; uint64_t timeStampVal = 0; bool hasSystemTimestamp = false; bool hasEpochTimestamp = false; bool hasDeltaSystemTimestamp = false; bool hasDeltaEpochTimestamp = false; err = GetDeltaSystemTimestamp(&timeStampVal); if (err == CHIP_END_OF_TLV) { err = CHIP_NO_ERROR; } else if (err == CHIP_NO_ERROR) { VerifyOrReturnError(aEventHeader.mTimestamp.IsSystem(), CHIP_ERROR_IM_MALFORMED_EVENT_DATA_IB); aEventHeader.mTimestamp.mValue += timeStampVal; hasDeltaSystemTimestamp = true; } ReturnErrorOnFailure(err); err = GetDeltaEpochTimestamp(&timeStampVal); if (err == CHIP_END_OF_TLV) { err = CHIP_NO_ERROR; } else if (err == CHIP_NO_ERROR) { VerifyOrReturnError(aEventHeader.mTimestamp.IsEpoch(), CHIP_ERROR_IM_MALFORMED_EVENT_DATA_IB); aEventHeader.mTimestamp.mValue += timeStampVal; hasDeltaEpochTimestamp = true; } ReturnErrorOnFailure(err); err = GetSystemTimestamp(&timeStampVal); if (err == CHIP_END_OF_TLV) { err = CHIP_NO_ERROR; } else if (err == CHIP_NO_ERROR) { aEventHeader.mTimestamp.mType = Timestamp::Type::kSystem; aEventHeader.mTimestamp.mValue = timeStampVal; hasSystemTimestamp = true; } ReturnErrorOnFailure(err); err = GetEpochTimestamp(&timeStampVal); if (err == CHIP_END_OF_TLV) { err = CHIP_NO_ERROR; } else if (err == CHIP_NO_ERROR) { aEventHeader.mTimestamp.mType = Timestamp::Type::kEpoch; aEventHeader.mTimestamp.mValue = timeStampVal; hasEpochTimestamp = true; } if (hasSystemTimestamp + hasEpochTimestamp + hasDeltaSystemTimestamp + hasDeltaEpochTimestamp == 1) { return CHIP_NO_ERROR; } return CHIP_ERROR_IM_MALFORMED_EVENT_DATA_IB; } CHIP_ERROR EventDataIB::Parser::DecodeEventHeader(EventHeader & aEventHeader) { uint8_t priorityLevel = 0; EventPathIB::Parser path; ReturnErrorOnFailure(GetPath(&path)); ReturnErrorOnFailure(ProcessEventPath(path, aEventHeader.mPath)); ReturnErrorOnFailure(GetEventNumber(&(aEventHeader.mEventNumber))); ReturnErrorOnFailure(GetPriority(&priorityLevel)); aEventHeader.mPriorityLevel = static_cast(priorityLevel); ReturnErrorOnFailure(ProcessEventTimestamp(aEventHeader)); return CHIP_NO_ERROR; } EventPathIB::Builder & EventDataIB::Builder::CreatePath() { // skip if error has already been set if (mError == CHIP_NO_ERROR) { mError = mPath.Init(mpWriter, to_underlying(Tag::kPath)); } return mPath; } EventDataIB::Builder & EventDataIB::Builder::Priority(const uint8_t aPriority) { // skip if error has already been set if (mError == CHIP_NO_ERROR) { mError = mpWriter->Put(TLV::ContextTag(Tag::kPriority), aPriority); } return *this; } EventDataIB::Builder & EventDataIB::Builder::EventNumber(const uint64_t aEventNumber) { // skip if error has already been set if (mError == CHIP_NO_ERROR) { mError = mpWriter->Put(TLV::ContextTag(Tag::kEventNumber), aEventNumber); } return *this; } EventDataIB::Builder & EventDataIB::Builder::EpochTimestamp(const uint64_t aEpochTimestamp) { // skip if error has already been set if (mError == CHIP_NO_ERROR) { mError = mpWriter->Put(TLV::ContextTag(Tag::kEpochTimestamp), aEpochTimestamp); } return *this; } EventDataIB::Builder & EventDataIB::Builder::SystemTimestamp(const uint64_t aSystemTimestamp) { // skip if error has already been set if (mError == CHIP_NO_ERROR) { mError = mpWriter->Put(TLV::ContextTag(Tag::kSystemTimestamp), aSystemTimestamp); } return *this; } EventDataIB::Builder & EventDataIB::Builder::DeltaEpochTimestamp(const uint64_t aDeltaEpochTimestamp) { // skip if error has already been set if (mError == CHIP_NO_ERROR) { mError = mpWriter->Put(TLV::ContextTag(Tag::kDeltaEpochTimestamp), aDeltaEpochTimestamp); } return *this; } EventDataIB::Builder & EventDataIB::Builder::DeltaSystemTimestamp(const uint64_t aDeltaSystemTimestamp) { // skip if error has already been set if (mError == CHIP_NO_ERROR) { mError = mpWriter->Put(TLV::ContextTag(Tag::kDeltaSystemTimestamp), aDeltaSystemTimestamp); } return *this; } // Mark the end of this element and recover the type for outer container CHIP_ERROR EventDataIB::Builder::EndOfEventDataIB() { EndOfContainer(); return GetError(); } } // namespace app } // namespace chip