1 /* ****************************************************************
3 * Copyright 2015 Samsung Electronics All Rights Reserved.
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 // Defining _BSD_SOURCE or _DEFAULT_SOURCE causes header files to expose
22 // definitions that may otherwise be skipped. Skipping can cause implicit
23 // declaration warnings and/or bugs and subtle problems in code execution.
24 // For glibc information on feature test macros,
25 // Refer http://www.gnu.org/software/libc/manual/html_node/Feature-Test-Macros.html
27 // This file requires #define use due to random()
28 // For details on compatibility and glibc support,
29 // Refer http://www.gnu.org/software/libc/manual/html_node/BSD-Random.html
30 #define _DEFAULT_SOURCE
37 #include "caadapterutils.h"
38 #include "cainterface.h"
39 #include "camessagehandler.h"
40 #include "caremotehandler.h"
41 #include "cablockwisetransfer.h"
42 #include "oic_malloc.h"
43 #include "oic_string.h"
47 #define TAG "OIC_CA_BWT"
49 #define BLOCKWISE_OPTION_BUFFER (sizeof(unsigned int))
50 #define BLOCK_NUMBER_IDX 4
51 #define BLOCK_M_BIT_IDX 3
54 #define BLOCK_SIZE(arg) (1 << ((arg) + 4))
56 // context for block-wise transfer
57 static CABlockWiseContext_t g_context = { .sendThreadFunc = NULL,
58 .receivedThreadFunc = NULL,
61 static bool CACheckPayloadLength(const CAData_t *sendData)
63 size_t payloadLen = 0;
64 CAGetPayloadInfo(sendData, &payloadLen);
66 // check if message has to be transfered to a block
67 size_t maxBlockSize = BLOCK_SIZE(CA_DEFAULT_BLOCK_SIZE);
68 OIC_LOG_V(DEBUG, TAG, "payloadLen=%zu, maxBlockSize=%zu", payloadLen, maxBlockSize);
70 if (payloadLen <= maxBlockSize)
78 CAResult_t CAInitializeBlockWiseTransfer(CASendThreadFunc sendThreadFunc,
79 CAReceiveThreadFunc receivedThreadFunc)
81 OIC_LOG(DEBUG, TAG, "CAInitializeBlockWiseTransfer");
83 // set block-wise transfer context
84 if (!g_context.sendThreadFunc)
86 g_context.sendThreadFunc = sendThreadFunc;
89 if (!g_context.receivedThreadFunc)
91 g_context.receivedThreadFunc = receivedThreadFunc;
94 if (!g_context.dataList)
96 g_context.dataList = u_arraylist_create();
99 CAResult_t res = CAInitBlockWiseMutexVariables();
100 if (CA_STATUS_OK != res)
102 u_arraylist_free(&g_context.dataList);
103 g_context.dataList = NULL;
104 OIC_LOG(ERROR, TAG, "init has failed");
110 CAResult_t CATerminateBlockWiseTransfer()
112 OIC_LOG(DEBUG, TAG, "CATerminateBlockWiseTransfer");
114 if (g_context.dataList)
116 CARemoveAllBlockDataFromList();
117 u_arraylist_free(&g_context.dataList);
120 CATerminateBlockWiseMutexVariables();
125 CAResult_t CAInitBlockWiseMutexVariables()
127 if (!g_context.blockDataListMutex)
129 g_context.blockDataListMutex = ca_mutex_new();
130 if (!g_context.blockDataListMutex)
132 OIC_LOG(ERROR, TAG, "ca_mutex_new has failed");
133 return CA_STATUS_FAILED;
137 if (!g_context.blockDataSenderMutex)
139 g_context.blockDataSenderMutex = ca_mutex_new();
140 if (!g_context.blockDataSenderMutex)
142 OIC_LOG(ERROR, TAG, "ca_mutex_new has failed");
143 CATerminateBlockWiseMutexVariables();
144 return CA_STATUS_FAILED;
151 void CATerminateBlockWiseMutexVariables()
153 if (g_context.blockDataListMutex)
155 ca_mutex_free(g_context.blockDataListMutex);
156 g_context.blockDataListMutex = NULL;
159 if (g_context.blockDataSenderMutex)
161 ca_mutex_free(g_context.blockDataSenderMutex);
162 g_context.blockDataSenderMutex = NULL;
166 CAResult_t CASendBlockWiseData(const CAData_t *sendData)
168 VERIFY_NON_NULL(sendData, TAG, "sendData");
170 // check if message type is CA_MSG_RESET
171 if (sendData->requestInfo)
173 if (CA_MSG_RESET == sendData->requestInfo->info.type)
175 OIC_LOG(DEBUG, TAG, "reset message can't be sent to the block");
176 return CA_NOT_SUPPORTED;
180 * Other uses of the Block options in conjunction with multicast
181 * messages are for further study.
183 if (sendData->requestInfo->isMulticast)
185 OIC_LOG(DEBUG, TAG, "multicast message can't be sent to the block");
186 return CA_NOT_SUPPORTED;
189 else if (sendData->responseInfo)
191 if (CA_MSG_RESET == sendData->responseInfo->info.type)
193 OIC_LOG(DEBUG, TAG, "reset message can't be sent to the block");
194 return CA_NOT_SUPPORTED;
196 if (sendData->responseInfo->isMulticast)
198 OIC_LOG(DEBUG, TAG, "multicast message can't be sent to the block");
199 return CA_NOT_SUPPORTED;
203 // #1. check if it is already included in block data list
204 CABlockData_t *currData = NULL;
205 CAResult_t res = CACheckBlockDataValidation(sendData, &currData);
206 if (CA_STATUS_OK != res)
208 // #2. if it is not included, add the data into list
211 OIC_LOG(DEBUG, TAG, "There is no block data");
213 bool isBlock = CACheckPayloadLength(sendData);
216 if (sendData->requestInfo)
218 currData = CACreateNewBlockData(sendData);
221 OIC_LOG(ERROR, TAG, "failed to create block data");
222 return CA_MEMORY_ALLOC_FAILED;
225 return CA_NOT_SUPPORTED;
227 currData = CACreateNewBlockData(sendData);
230 OIC_LOG(ERROR, TAG, "failed to create block data");
231 return CA_MEMORY_ALLOC_FAILED;
236 // #3. check request/response block option type and payload length
237 res = CACheckBlockOptionType(currData);
238 if (CA_STATUS_OK == res)
240 // #4. send block message
241 OIC_LOG(DEBUG, TAG, "send first block msg");
242 res = CAAddSendThreadQueue(currData->sentData,
243 (const CABlockDataID_t *) &currData->blockDataId);
244 if (CA_STATUS_OK != res)
246 OIC_LOG(ERROR, TAG, "add has failed");
254 CAResult_t CAAddSendThreadQueue(const CAData_t *sendData, const CABlockDataID_t *blockID)
256 VERIFY_NON_NULL(sendData, TAG, "sendData");
257 VERIFY_NON_NULL(blockID, TAG, "blockID");
259 CAData_t *cloneData = CACloneCAData(sendData);
262 OIC_LOG(ERROR, TAG, "clone has failed");
263 CARemoveBlockDataFromList(blockID);
264 return CA_STATUS_FAILED;
267 if (g_context.sendThreadFunc)
269 ca_mutex_lock(g_context.blockDataSenderMutex);
270 g_context.sendThreadFunc(cloneData);
271 ca_mutex_unlock(g_context.blockDataSenderMutex);
275 CADestroyDataSet(cloneData);
280 CAResult_t CACheckBlockOptionType(CABlockData_t *currData)
282 VERIFY_NON_NULL(currData, TAG, "currData");
283 VERIFY_NON_NULL(currData->sentData, TAG, "currData->sentData");
285 bool isBlock = CACheckPayloadLength(currData->sentData);
288 return CA_NOT_SUPPORTED;
291 // set block option (COAP_OPTION_BLOCK2 or COAP_OPTION_BLOCK1)
292 if (currData->sentData->requestInfo) // request message
294 currData->type = COAP_OPTION_BLOCK1;
296 else // response message
298 currData->type = COAP_OPTION_BLOCK2;
304 // TODO make pdu const after libcoap is updated to support that.
305 CAResult_t CAReceiveBlockWiseData(coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
306 const CAData_t *receivedData, size_t dataLen)
308 OIC_LOG(DEBUG, TAG, "CAReceiveBlockWiseData");
309 VERIFY_NON_NULL(pdu, TAG, "pdu");
310 VERIFY_NON_NULL(pdu->hdr, TAG, "pdu->hdr");
311 VERIFY_NON_NULL(endpoint, TAG, "endpoint");
312 VERIFY_NON_NULL(receivedData, TAG, "receivedData");
314 // check if received message type is CA_MSG_RESET
315 if (CA_EMPTY == pdu->hdr->coap_hdr_udp_t.code)
317 OIC_LOG(DEBUG, TAG, "code is CA_EMPTY..");
319 if (!receivedData->responseInfo->info.token)
321 // get token from block-wise transfer list when CA_EMPTY(RST/ACK) is received
322 CAResult_t res = CAGetTokenFromBlockDataList(pdu, endpoint,
323 receivedData->responseInfo);
324 if (CA_STATUS_OK != res)
326 OIC_LOG(ERROR, TAG, "fail to get token");
331 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(
332 receivedData->responseInfo->info.token,
333 receivedData->responseInfo->info.tokenLength,
335 if (NULL == blockDataID || blockDataID->idLength < 1)
337 // if retransmission is timeout, callback msg will be send without token.
338 if (NULL == blockDataID && !receivedData->responseInfo->info.token)
340 OIC_LOG(INFO, TAG, "retransmission was stopped");
341 return CA_REQUEST_TIMEOUT;
344 OIC_LOG(ERROR, TAG, "blockId is null");
345 CADestroyBlockID(blockDataID);
346 return CA_STATUS_FAILED;
349 CARemoveBlockDataFromList(blockDataID);
350 CADestroyBlockID(blockDataID);
351 return CA_NOT_SUPPORTED;
354 // check if block option is set and get block data
355 coap_block_t block = { 0, 0, 0 };
358 int isBlock1 = coap_get_block(pdu, COAP_OPTION_BLOCK1, &block);
361 CAResult_t res = CASetNextBlockOption1(pdu, endpoint, receivedData, block, dataLen);
362 if (CA_STATUS_OK != res)
364 OIC_LOG(ERROR, TAG, "setting has failed");
370 int isBlock2 = coap_get_block(pdu, COAP_OPTION_BLOCK2, &block);
373 CAResult_t res = CASetNextBlockOption2(pdu, endpoint, receivedData, block, dataLen);
374 if (CA_STATUS_OK != res)
376 OIC_LOG(ERROR, TAG, "setting has failed");
381 // if there is no block option in pdu, check if there is error code.
382 if (!isBlock1 && !isBlock2)
384 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(
385 (CAToken_t)pdu->hdr->coap_hdr_udp_t.token,
386 pdu->hdr->coap_hdr_udp_t.token_length,
388 if (NULL == blockDataID || blockDataID->idLength < 1)
390 OIC_LOG(ERROR, TAG, "blockId is null");
391 CADestroyBlockID(blockDataID);
392 return CA_STATUS_FAILED;
395 uint32_t code = CA_RESPONSE_CODE(pdu->hdr->coap_hdr_udp_t.code);
396 if (CA_REQUEST_ENTITY_INCOMPLETE == code)
398 CABlockData_t *data = CAGetBlockDataFromBlockDataList(blockDataID);
401 OIC_LOG(ERROR, TAG, "getting has failed");
402 CADestroyBlockID(blockDataID);
403 return CA_STATUS_FAILED;
406 coap_block_t *block = CAGetBlockOption(blockDataID, data->type);
409 OIC_LOG(ERROR, TAG, "block is null");
410 CADestroyBlockID(blockDataID);
411 return CA_STATUS_FAILED;
414 CAResult_t res = CA_STATUS_OK;
415 if (COAP_OPTION_BLOCK2 == data->type)
417 res = CASetNextBlockOption2(pdu, endpoint, receivedData, *block, dataLen);
418 if (CA_STATUS_OK != res)
420 OIC_LOG(ERROR, TAG, "setting has failed");
421 CADestroyBlockID(blockDataID);
422 return CA_STATUS_FAILED;
425 else if (COAP_OPTION_BLOCK1 == data->type)
427 res = CASetNextBlockOption1(pdu, endpoint, receivedData, *block, dataLen);
428 if (CA_STATUS_OK != res)
430 OIC_LOG(ERROR, TAG, "setting has failed");
431 CADestroyBlockID(blockDataID);
435 CADestroyBlockID(blockDataID);
440 OIC_LOG(DEBUG, TAG, "it's normal pdu");
442 // if received data is response message
443 // and sent data remain in block data list, remove block data
444 if (receivedData->responseInfo)
446 CARemoveBlockDataFromList(blockDataID);
448 CADestroyBlockID(blockDataID);
449 return CA_NOT_SUPPORTED;
455 CAResult_t CAProcessNextStep(const coap_pdu_t *pdu, const CAData_t *receivedData,
456 uint8_t blockWiseStatus, const CABlockDataID_t *blockID)
458 VERIFY_NON_NULL(pdu, TAG, "pdu");
459 VERIFY_NON_NULL(pdu->hdr, TAG, "pdu->hdr");
460 VERIFY_NON_NULL(blockID, TAG, "blockID");
462 CAResult_t res = CA_STATUS_OK;
463 CAData_t *data = NULL;
465 // process blockWiseStatus
466 switch (blockWiseStatus)
468 case CA_OPTION2_FIRST_BLOCK:
469 res = CAAddSendThreadQueue(receivedData, blockID);
470 if (CA_STATUS_OK != res)
472 OIC_LOG(ERROR, TAG, "add has failed");
477 case CA_OPTION2_REQUEST:
478 // add data to send thread
479 data = CAGetDataSetFromBlockDataList(blockID);
482 OIC_LOG(ERROR, TAG, "it's unavailable");
483 return CA_STATUS_FAILED;
486 if (data->requestInfo)
488 data->requestInfo->info.messageId = pdu->hdr->coap_hdr_udp_t.id;
491 if (data->responseInfo)
493 data->responseInfo->info.messageId = pdu->hdr->coap_hdr_udp_t.id;
496 res = CAAddSendThreadQueue(data, blockID);
497 if (CA_STATUS_OK != res)
499 OIC_LOG(ERROR, TAG, "add has failed");
505 case CA_OPTION1_RESPONSE:
506 case CA_OPTION2_RESPONSE:
507 case CA_OPTION1_REQUEST_BLOCK:
508 res = CASendBlockMessage(pdu, pdu->hdr->coap_hdr_udp_t.type, blockID);
509 if (CA_STATUS_OK != res)
511 OIC_LOG(ERROR, TAG, "send has failed");
516 case CA_OPTION2_LAST_BLOCK:
517 // process last block and send upper layer
518 res = CAReceiveLastBlock(blockID, receivedData);
519 if (CA_STATUS_OK != res)
521 OIC_LOG(ERROR, TAG, "receive has failed");
525 // remove data from list
526 res = CARemoveBlockDataFromList(blockID);
527 if (CA_STATUS_OK != res)
529 OIC_LOG(ERROR, TAG, "remove has failed");
534 case CA_OPTION1_REQUEST_LAST_BLOCK:
535 // process last block and send upper layer
536 res = CAReceiveLastBlock(blockID, receivedData);
537 if (CA_STATUS_OK != res)
539 OIC_LOG(ERROR, TAG, "receive has failed");
544 case CA_BLOCK_INCOMPLETE:
545 // add data to send thread
546 res = CASendErrorMessage(pdu, blockWiseStatus, CA_REQUEST_ENTITY_INCOMPLETE, blockID);
547 if (CA_STATUS_OK != res)
549 OIC_LOG(ERROR, TAG, "send has failed");
554 case CA_BLOCK_TOO_LARGE:
555 if (receivedData->requestInfo)
557 res = CASendErrorMessage(pdu, blockWiseStatus, CA_REQUEST_ENTITY_TOO_LARGE,
559 if (CA_STATUS_OK != res)
561 OIC_LOG(ERROR, TAG, "send has failed");
565 else if (receivedData->responseInfo)
567 res = CASendBlockMessage(pdu, pdu->hdr->coap_hdr_udp_t.type, blockID);
568 if (CA_STATUS_OK != res)
570 OIC_LOG(ERROR, TAG, "send has failed");
576 OIC_LOG_V(ERROR, TAG, "no logic [%d]", blockWiseStatus);
581 CAResult_t CASendBlockMessage(const coap_pdu_t *pdu, CAMessageType_t msgType,
582 const CABlockDataID_t *blockID)
584 VERIFY_NON_NULL(pdu, TAG, "pdu");
585 VERIFY_NON_NULL(pdu->hdr, TAG, "pdu->hdr");
586 VERIFY_NON_NULL(blockID, TAG, "blockID");
588 CAData_t *data = CAGetDataSetFromBlockDataList(blockID);
591 OIC_LOG(ERROR, TAG, "CAData is unavailable");
592 return CA_STATUS_FAILED;
595 CAMessageType_t sentMsgType = CA_MSG_NONCONFIRM;
599 sentMsgType = CA_MSG_ACKNOWLEDGE;
601 case CA_MSG_ACKNOWLEDGE:
602 sentMsgType = CA_MSG_CONFIRM;
605 sentMsgType = CA_MSG_NONCONFIRM;
609 uint32_t code = pdu->hdr->coap_hdr_udp_t.code;
610 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
612 if (data->responseInfo)
614 OIC_LOG(DEBUG, TAG, "set response info");
615 data->responseInfo->info.messageId = pdu->hdr->coap_hdr_udp_t.id;
616 data->responseInfo->info.type = sentMsgType;
617 data->responseInfo->result = CA_CONTINUE;
622 OIC_LOG(DEBUG, TAG, "need new msgID");
623 if (data->requestInfo)
625 data->requestInfo->info.messageId = 0;
626 data->requestInfo->info.type = sentMsgType;
630 // add data to send thread
631 CAResult_t res = CAAddSendThreadQueue(data, blockID);
632 if (CA_STATUS_OK != res)
634 OIC_LOG(ERROR, TAG, "add has failed");
640 CAResult_t CASendErrorMessage(const coap_pdu_t *pdu, uint8_t status,
641 CAResponseResult_t responseResult, const CABlockDataID_t *blockID)
643 VERIFY_NON_NULL(pdu, TAG, "pdu");
644 VERIFY_NON_NULL(pdu->hdr, TAG, "pdu->hdr");
645 VERIFY_NON_NULL(blockID, TAG, "blockID");
647 // create error responseInfo
648 CABlockData_t *data = CAGetBlockDataFromBlockDataList(blockID);
651 OIC_LOG(ERROR, TAG, "data is unavailable");
652 return CA_STATUS_FAILED;
655 CAMessageType_t sentMsgType = CA_MSG_NONCONFIRM;
656 switch (pdu->hdr->coap_hdr_udp_t.type)
659 sentMsgType = CA_MSG_ACKNOWLEDGE;
661 case CA_MSG_ACKNOWLEDGE:
662 sentMsgType = CA_MSG_CONFIRM;
666 CAData_t *cloneData = NULL;
669 cloneData = CACloneCAData(data->sentData);
672 OIC_LOG(ERROR, TAG, "clone has failed");
673 return CA_MEMORY_ALLOC_FAILED;
676 if (cloneData->responseInfo)
678 cloneData->responseInfo->info.messageId = pdu->hdr->coap_hdr_udp_t.id;
679 cloneData->responseInfo->info.type = sentMsgType;
680 cloneData->responseInfo->result = responseResult;
684 CAInfo_t responseData = { .tokenLength = pdu->hdr->coap_hdr_udp_t.token_length };
685 responseData.token = (CAToken_t) OICMalloc(responseData.tokenLength);
686 if (!responseData.token)
688 OIC_LOG(ERROR, TAG, "out of memory");
689 return CA_MEMORY_ALLOC_FAILED;
691 memcpy(responseData.token, pdu->hdr->coap_hdr_udp_t.token, responseData.tokenLength);
693 cloneData->responseInfo = (CAResponseInfo_t*) OICCalloc(1, sizeof(CAResponseInfo_t));
694 if (!cloneData->responseInfo)
696 OIC_LOG(ERROR, TAG, "out of memory");
697 OICFree(responseData.token);
698 return CA_MEMORY_ALLOC_FAILED;
701 cloneData->responseInfo->info = responseData;
702 cloneData->responseInfo->info.type = sentMsgType;
703 cloneData->responseInfo->result = responseResult;
705 OIC_LOG(DEBUG, TAG, "set response message to send error code");
709 OIC_LOG(ERROR, TAG, "data has no sent-data");
710 return CA_MEMORY_ALLOC_FAILED;
713 // if there is a requestInfo, remove it to send response message
714 if (cloneData->requestInfo)
716 CADestroyRequestInfoInternal(cloneData->requestInfo);
717 cloneData->requestInfo = NULL;
720 // add data to send thread
721 if (g_context.sendThreadFunc)
723 ca_mutex_lock(g_context.blockDataSenderMutex);
724 g_context.sendThreadFunc(cloneData);
725 ca_mutex_unlock(g_context.blockDataSenderMutex);
729 CADestroyDataSet(cloneData);
732 // if error code is 4.08, remove the stored payload and initialize block number
733 if (CA_BLOCK_INCOMPLETE == status)
735 OICFree(data->payload);
736 data->payload = NULL;
737 data->payloadLength = 0;
738 data->receivedPayloadLen = 0;
739 data->block1.num = 0;
740 data->block2.num = 0;
746 CAResult_t CAReceiveLastBlock(const CABlockDataID_t *blockID, const CAData_t *receivedData)
748 VERIFY_NON_NULL(blockID, TAG, "blockID");
749 VERIFY_NON_NULL(receivedData, TAG, "receivedData");
751 // total block data have to notify to Application
752 CAData_t *cloneData = CACloneCAData(receivedData);
755 OIC_LOG(ERROR, TAG, "clone has failed");
756 return CA_MEMORY_ALLOC_FAILED;
760 size_t fullPayloadLen = 0;
761 CAPayload_t fullPayload = CAGetPayloadFromBlockDataList(blockID, &fullPayloadLen);
764 CAResult_t res = CAUpdatePayloadToCAData(cloneData, fullPayload, fullPayloadLen);
765 if (CA_STATUS_OK != res)
767 OIC_LOG(ERROR, TAG, "update has failed");
768 CADestroyDataSet(cloneData);
773 if (g_context.receivedThreadFunc)
775 g_context.receivedThreadFunc(cloneData);
779 CADestroyDataSet(cloneData);
785 // TODO make pdu const after libcoap is updated to support that.
786 CAResult_t CASetNextBlockOption1(coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
787 const CAData_t *receivedData, coap_block_t block,
790 OIC_LOG(INFO, TAG, "CASetNextBlockOption1");
791 VERIFY_NON_NULL(pdu, TAG, "pdu");
792 VERIFY_NON_NULL(pdu->hdr, TAG, "pdu->hdr");
793 VERIFY_NON_NULL(endpoint, TAG, "endpoint");
794 VERIFY_NON_NULL(receivedData, TAG, "receivedData");
796 OIC_LOG_V(INFO, TAG, "num:%d, M:%d, sze:%d", block.num, block.m, block.szx);
798 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(
799 (CAToken_t)pdu->hdr->coap_hdr_udp_t.token,
800 pdu->hdr->coap_hdr_udp_t.token_length,
802 if (NULL == blockDataID || blockDataID->idLength < 1)
804 OIC_LOG(ERROR, TAG, "blockId is null");
805 CADestroyBlockID(blockDataID);
806 return CA_STATUS_FAILED;
809 // Get BlockData data. If does not exist, create a new data
810 CABlockData_t *data = CAGetBlockDataFromBlockDataList(blockDataID);
813 OIC_LOG(DEBUG, TAG, "block data doesn't exist in list. create new one");
815 CAData_t *cadata = CACreateNewDataSet(pdu, endpoint);
818 OIC_LOG(ERROR, TAG, "data is null");
819 CADestroyBlockID(blockDataID);
820 return CA_STATUS_FAILED;
823 data = CACreateNewBlockData(cadata);
826 OIC_LOG(ERROR, TAG, "failed to create a new block data");
827 CADestroyDataSet(cadata);
828 CADestroyBlockID(blockDataID);
829 return CA_STATUS_FAILED;
831 CADestroyDataSet(cadata);
834 // update BLOCK OPTION1 type
835 CAResult_t res = CAUpdateBlockOptionType(blockDataID, COAP_OPTION_BLOCK1);
836 if (CA_STATUS_OK != res)
838 OIC_LOG(ERROR, TAG, "update has failed");
842 uint8_t blockWiseStatus = CA_BLOCK_UNKNOWN;
843 uint32_t code = pdu->hdr->coap_hdr_udp_t.code;
844 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
846 // received message type is request
847 OIC_LOG_V(INFO, TAG, "num:%d, M:%d", block.num, block.m);
849 // check the size option
850 bool isSizeOption = CAIsPayloadLengthInPduWithBlockSizeOption(pdu, COAP_OPTION_SIZE1,
851 &(data->payloadLength));
853 blockWiseStatus = CACheckBlockErrorType(data, &block, receivedData,
854 COAP_OPTION_BLOCK1, dataLen);
856 if (CA_BLOCK_RECEIVED_ALREADY != blockWiseStatus)
858 // store the received payload and merge
859 res = CAUpdatePayloadData(data, receivedData, blockWiseStatus,
860 isSizeOption, COAP_OPTION_BLOCK1);
861 if (CA_STATUS_OK != res)
863 OIC_LOG(ERROR, TAG, "update has failed");
867 res = CAUpdateBlockOptionItems(data, pdu, &block, COAP_OPTION_BLOCK1,
869 if (CA_STATUS_OK != res)
871 OIC_LOG(ERROR, TAG, "update has failed");
876 res = CAUpdateBlockData(data, block, COAP_OPTION_BLOCK1);
877 if (CA_STATUS_OK != res)
879 OIC_LOG(ERROR, TAG, "update has failed");
884 // check the blcok-wise transfer status for next step
885 if (CA_BLOCK_UNKNOWN == blockWiseStatus || CA_BLOCK_RECEIVED_ALREADY == blockWiseStatus)
887 OIC_LOG_V(DEBUG, TAG, "M bit is %d", block.m);
891 // Last block is received
892 blockWiseStatus = CA_OPTION1_REQUEST_LAST_BLOCK;
896 blockWiseStatus = CA_OPTION1_REQUEST_BLOCK;
902 // received message type is response
903 uint32_t code = CA_RESPONSE_CODE(pdu->hdr->coap_hdr_udp_t.code);
904 if (0 == block.m && (CA_REQUEST_ENTITY_INCOMPLETE != code
905 && CA_REQUEST_ENTITY_TOO_LARGE != code))
907 int isBlock2 = coap_get_block(pdu, COAP_OPTION_BLOCK2, &block);
910 OIC_LOG(INFO, TAG, "received data is combining block1 and block2");
911 // initialize block number for response message
912 data->block1.num = 0;
913 CADestroyBlockID(blockDataID);
918 OIC_LOG(INFO, TAG, "received data is not bulk data");
919 CAReceiveLastBlock(blockDataID, receivedData);
925 blockWiseStatus = CA_OPTION1_RESPONSE;
926 res = CAUpdateBlockOptionItems(data, pdu, &block, COAP_OPTION_BLOCK1, blockWiseStatus);
927 if (CA_STATUS_OK != res)
929 OIC_LOG(ERROR, TAG, "update has failed");
930 CADestroyBlockID(blockDataID);
934 res = CAUpdateBlockData(data, block, COAP_OPTION_BLOCK1);
935 if (CA_STATUS_OK != res)
937 OIC_LOG(ERROR, TAG, "update has failed");
942 res = CAProcessNextStep(pdu, receivedData, blockWiseStatus, blockDataID);
943 if (CA_STATUS_OK != res)
945 OIC_LOG(ERROR, TAG, "setting has failed");
949 CADestroyBlockID(blockDataID);
953 CARemoveBlockDataFromList(blockDataID);
954 CADestroyBlockID(blockDataID);
958 // TODO make pdu const after libcoap is updated to support that.
959 CAResult_t CASetNextBlockOption2(coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
960 const CAData_t *receivedData, coap_block_t block,
963 OIC_LOG(DEBUG, TAG, "CASetNextBlockOption2");
964 OIC_LOG_V(INFO, TAG, "num:%d, M:%d, sze:%d", block.num, block.m, block.szx);
966 VERIFY_NON_NULL(pdu, TAG, "pdu");
967 VERIFY_NON_NULL(pdu->hdr, TAG, "pdu->hdr");
968 VERIFY_NON_NULL(endpoint, TAG, "endpoint");
969 VERIFY_NON_NULL(receivedData, TAG, "receivedData");
971 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(
972 (CAToken_t)pdu->hdr->coap_hdr_udp_t.token,
973 pdu->hdr->coap_hdr_udp_t.token_length,
975 if (NULL == blockDataID || blockDataID->idLength < 1)
977 OIC_LOG(ERROR, TAG, "blockId is null");
978 CADestroyBlockID(blockDataID);
979 return CA_STATUS_FAILED;
982 // Get BlockData data. If does not exist, create a new data
983 CABlockData_t *data = CAGetBlockDataFromBlockDataList(blockDataID);
986 OIC_LOG(DEBUG, TAG, "block data doesn't exist in list. create new one");
988 CAData_t *cadata = CACreateNewDataSet(pdu, endpoint);
991 OIC_LOG(ERROR, TAG, "data is null");
992 CADestroyBlockID(blockDataID);
993 return CA_STATUS_FAILED;
996 data = CACreateNewBlockData(cadata);
999 OIC_LOG(ERROR, TAG, "failed to create a new block data");
1000 CADestroyDataSet(cadata);
1001 CADestroyBlockID(blockDataID);
1002 return CA_STATUS_FAILED;
1004 CADestroyDataSet(cadata);
1007 // set Block Option Type
1008 CAResult_t res = CAUpdateBlockOptionType(blockDataID, COAP_OPTION_BLOCK2);
1009 if (CA_STATUS_OK != res)
1011 OIC_LOG(ERROR, TAG, "update has failed");
1015 uint8_t blockWiseStatus = CA_BLOCK_UNKNOWN;
1016 if (0 == block.num && CA_GET == pdu->hdr->coap_hdr_udp_t.code && 0 == block.m)
1018 OIC_LOG(INFO, TAG, "first block number");
1020 res = CAUpdateBlockOptionItems(data, pdu, &block, COAP_OPTION_BLOCK2, blockWiseStatus);
1021 if (CA_STATUS_OK != res)
1023 OIC_LOG(ERROR, TAG, "update has failed");
1027 // first block data have to notify to Application
1028 res = CAUpdateBlockData(data, block, COAP_OPTION_BLOCK2);
1029 if (CA_STATUS_OK != res)
1031 OIC_LOG(ERROR, TAG, "update has failed");
1034 blockWiseStatus = CA_OPTION2_FIRST_BLOCK;
1038 uint32_t code = pdu->hdr->coap_hdr_udp_t.code;
1039 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
1041 // received message type is request
1042 OIC_LOG_V(INFO, TAG, "num:%d, M:%d", block.num, block.m);
1044 blockWiseStatus = CA_OPTION2_REQUEST;
1046 res = CAUpdateBlockOptionItems(data, pdu, &block, COAP_OPTION_BLOCK2, blockWiseStatus);
1047 if (CA_STATUS_OK != res)
1049 OIC_LOG(ERROR, TAG, "update has failed");
1053 res = CAUpdateBlockData(data, block, COAP_OPTION_BLOCK2);
1054 if (CA_STATUS_OK != res)
1056 OIC_LOG(ERROR, TAG, "update has failed");
1062 // received message type is response
1063 OIC_LOG(DEBUG, TAG, "received response message with block option2");
1065 // check the size option
1066 bool isSizeOption = CAIsPayloadLengthInPduWithBlockSizeOption(pdu,
1068 &(data->payloadLength));
1070 uint32_t code = CA_RESPONSE_CODE(pdu->hdr->coap_hdr_udp_t.code);
1071 if (CA_REQUEST_ENTITY_INCOMPLETE != code && CA_REQUEST_ENTITY_TOO_LARGE != code)
1073 // check if received payload is exact
1074 blockWiseStatus = CACheckBlockErrorType(data, &block, receivedData,
1075 COAP_OPTION_BLOCK2, dataLen);
1078 if (CA_BLOCK_RECEIVED_ALREADY != blockWiseStatus)
1080 // store the received payload and merge
1081 res = CAUpdatePayloadData(data, receivedData, blockWiseStatus,
1082 isSizeOption, COAP_OPTION_BLOCK2);
1083 if (CA_STATUS_OK != res)
1085 OIC_LOG(ERROR, TAG, "update has failed");
1090 if (0 == block.m && CA_BLOCK_UNKNOWN == blockWiseStatus) // Last block is received
1092 OIC_LOG(DEBUG, TAG, "M bit is 0");
1093 blockWiseStatus = CA_OPTION2_LAST_BLOCK;
1097 if (CA_BLOCK_UNKNOWN == blockWiseStatus ||
1098 CA_BLOCK_RECEIVED_ALREADY == blockWiseStatus)
1100 OIC_LOG(DEBUG, TAG, "M bit is 1");
1101 blockWiseStatus = CA_OPTION2_RESPONSE;
1104 res = CAUpdateBlockOptionItems(data, pdu, &block, COAP_OPTION_BLOCK2,
1106 if (CA_STATUS_OK != res)
1108 OIC_LOG(ERROR, TAG, "update has failed");
1112 res = CAUpdateBlockData(data, block, COAP_OPTION_BLOCK2);
1113 if (CA_STATUS_OK != res)
1115 OIC_LOG(ERROR, TAG, "update has failed");
1122 res = CAProcessNextStep(pdu, receivedData, blockWiseStatus, blockDataID);
1123 if (CA_STATUS_OK != res)
1125 OIC_LOG(ERROR, TAG, "setting has failed");
1129 CADestroyBlockID(blockDataID);
1130 return CA_STATUS_OK;
1133 CARemoveBlockDataFromList(blockDataID);
1134 CADestroyBlockID(blockDataID);
1138 CAResult_t CAUpdateBlockOptionItems(CABlockData_t *currData, const coap_pdu_t *pdu,
1139 coap_block_t *block, uint16_t blockType,
1142 VERIFY_NON_NULL(currData, TAG, "currData");
1143 VERIFY_NON_NULL(pdu, TAG, "pdu");
1144 VERIFY_NON_NULL(block, TAG, "block");
1146 // update block data
1147 CAResult_t res = CA_STATUS_OK;
1148 uint32_t code = CA_RESPONSE_CODE(pdu->hdr->coap_hdr_udp_t.code);
1150 if (CA_REQUEST_ENTITY_INCOMPLETE == code || CA_REQUEST_ENTITY_TOO_LARGE == code)
1152 // response error code of the received block message
1153 res = CAHandleBlockErrorResponse(block, blockType, code);
1154 if (CA_STATUS_OK != res)
1156 OIC_LOG(ERROR, TAG, "error handle has failed");
1162 // update block option items
1165 case CA_OPTION1_RESPONSE:
1166 if (currData->block1.num > block->num)
1168 OIC_LOG(ERROR, TAG, "received incorrect block num");
1169 return CA_STATUS_FAILED;
1173 case CA_OPTION2_REQUEST:
1176 case CA_OPTION2_RESPONSE:
1177 if (currData->block2.num > block->num)
1179 OIC_LOG(ERROR, TAG, "received incorrect block num");
1180 return CA_STATUS_FAILED;
1185 case CA_BLOCK_TOO_LARGE:
1186 // if state of received block message is CA_BLOCK_TOO_LARGE or CA_BLOCK_INCOMPLETE
1187 // we set the response error code appropriately and send
1188 if (COAP_OPTION_BLOCK2 == blockType)
1192 block->szx = currData->block2.szx;
1196 block->szx = currData->block1.szx;
1200 OIC_LOG_V(ERROR, TAG, "no logic [%d]", status);
1203 if (CA_BLOCK_INCOMPLETE != status && CA_BLOCK_TOO_LARGE != status)
1205 // negotiate block size
1206 res = CANegotiateBlockSize(currData, block, pdu, blockType);
1207 if (CA_STATUS_OK != res)
1209 OIC_LOG(ERROR, TAG, "negotiation has failed");
1217 CAResult_t CASetMoreBitFromBlock(size_t payloadLen, coap_block_t *block)
1219 VERIFY_NON_NULL(block, TAG, "block");
1221 if ((size_t) ((block->num + 1) << (block->szx + BLOCK_NUMBER_IDX)) < payloadLen)
1223 OIC_LOG(DEBUG, TAG, "Set the M-bit(1)");
1228 OIC_LOG(DEBUG, TAG, "Set the M-bit(0)");
1232 return CA_STATUS_OK;
1235 CAResult_t CANegotiateBlockSize(CABlockData_t *currData, coap_block_t *block,
1236 const coap_pdu_t *pdu, uint16_t blockType)
1238 OIC_LOG(DEBUG, TAG, "IN-NegotiateBlockSize");
1240 VERIFY_NON_NULL(currData, TAG, "currData");
1241 VERIFY_NON_NULL(block, TAG, "block");
1242 VERIFY_NON_NULL(pdu, TAG, "pdu");
1243 VERIFY_NON_NULL(pdu->hdr, TAG, "pdu->hdr");
1245 bool isReqMsg = false;
1246 uint32_t code = pdu->hdr->coap_hdr_udp_t.code;
1247 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
1252 // #1. check the block option type
1253 if (COAP_OPTION_BLOCK2 == blockType)
1255 // #2. check the message type
1258 if (block->szx > currData->block2.szx)
1260 OIC_LOG(DEBUG, TAG, "sze is big");
1262 // #3. calculate new block number from block size
1263 unsigned int blockNum = BLOCK_SIZE(block->szx) /
1264 BLOCK_SIZE(currData->block2.szx) - 1;
1265 OIC_LOG(DEBUG, TAG, "num is set as Negotiation");
1266 block->num += blockNum;
1267 block->szx = currData->block2.szx;
1268 OIC_LOG_V(DEBUG, TAG, "updated block num: %d", block->num);
1273 if (block->szx > currData->block2.szx)
1275 OIC_LOG(DEBUG, TAG, "sze is big");
1276 block->szx = currData->block2.szx;
1280 else if (COAP_OPTION_BLOCK1 == blockType)
1284 if (block->szx < currData->block1.szx)
1286 OIC_LOG(DEBUG, TAG, "sze is small");
1288 unsigned int blockNum = BLOCK_SIZE(currData->block1.szx) /
1289 BLOCK_SIZE(block->szx) - 1;
1290 block->num += blockNum;
1291 OIC_LOG_V(DEBUG, TAG, "updated block num: %d", block->num);
1296 if (block->szx > currData->block1.szx)
1298 OIC_LOG(DEBUG, TAG, "sze is big");
1299 block->szx = currData->block1.szx;
1305 OIC_LOG(DEBUG, TAG, "Invalid block option");
1306 return CA_STATUS_FAILED;
1309 OIC_LOG(DEBUG, TAG, "OUT-NegotiateBlockSize");
1311 return CA_STATUS_OK;
1314 CAResult_t CAUpdateBlockData(CABlockData_t *currData, coap_block_t block,
1317 VERIFY_NON_NULL(currData, TAG, "currData");
1319 // check if block size is bigger than CABlockSize_t
1320 if (block.szx > CA_BLOCK_SIZE_1024_BYTE)
1322 OIC_LOG(DEBUG, TAG, "invalid block szx");
1323 return CA_STATUS_FAILED;
1326 // update block option
1327 if (COAP_OPTION_BLOCK2 == blockType)
1329 currData->block2 = block;
1333 currData->block1 = block;
1336 OIC_LOG(DEBUG, TAG, "data has updated");
1337 return CA_STATUS_OK;
1340 CAResult_t CAUpdateMessageId(coap_pdu_t *pdu, const CABlockDataID_t *blockID)
1342 VERIFY_NON_NULL(pdu, TAG, "pdu");
1343 VERIFY_NON_NULL(pdu->hdr, TAG, "pdu->hdr");
1344 VERIFY_NON_NULL(blockID, TAG, "blockID");
1346 // if message is sent, update messageId in block-wise transfer list
1347 CAData_t * cadata = CAGetDataSetFromBlockDataList(blockID);
1350 OIC_LOG(ERROR, TAG, "CAData is unavailable");
1351 return CA_STATUS_FAILED;
1354 if (cadata->requestInfo)
1356 cadata->requestInfo->info.messageId = pdu->hdr->coap_hdr_udp_t.id;
1359 return CA_STATUS_OK;
1362 CAResult_t CAAddBlockOption(coap_pdu_t **pdu, const CAInfo_t *info,
1363 const CAEndpoint_t *endpoint, coap_list_t **options)
1365 OIC_LOG(DEBUG, TAG, "IN-AddBlockOption");
1366 VERIFY_NON_NULL(pdu, TAG, "pdu");
1367 VERIFY_NON_NULL((*pdu), TAG, "(*pdu)");
1368 VERIFY_NON_NULL((*pdu)->hdr, TAG, "(*pdu)->hdr");
1369 VERIFY_NON_NULL(info, TAG, "info");
1370 VERIFY_NON_NULL(endpoint, TAG, "endpoint");
1371 VERIFY_NON_NULL(options, TAG, "options");
1373 CAResult_t res = CA_STATUS_OK;
1374 size_t dataLength = 0;
1377 dataLength = info->payloadSize;
1378 OIC_LOG_V(DEBUG, TAG, "dataLength - %zu", dataLength);
1381 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(
1382 (CAToken_t)(*pdu)->hdr->coap_hdr_udp_t.token,
1383 (*pdu)->hdr->coap_hdr_udp_t.token_length,
1385 if (NULL == blockDataID || blockDataID->idLength < 1)
1387 OIC_LOG(ERROR, TAG, "blockId is null");
1388 res = CA_STATUS_FAILED;
1392 uint32_t repCode = CA_RESPONSE_CODE((*pdu)->hdr->coap_hdr_udp_t.code);
1393 if (CA_REQUEST_ENTITY_INCOMPLETE == repCode)
1395 OIC_LOG(INFO, TAG, "don't use option");
1400 uint8_t blockType = CAGetBlockOptionType(blockDataID);
1401 if (COAP_OPTION_BLOCK2 == blockType)
1403 res = CAAddBlockOption2(pdu, info, dataLength, blockDataID, options);
1404 if (CA_STATUS_OK != res)
1406 OIC_LOG(ERROR, TAG, "add has failed");
1410 else if (COAP_OPTION_BLOCK1 == blockType)
1412 res = CAAddBlockOption1(pdu, info, dataLength, blockDataID, options);
1413 if (CA_STATUS_OK != res)
1415 OIC_LOG(ERROR, TAG, "add has failed");
1421 OIC_LOG(DEBUG, TAG, "no BLOCK option");
1423 // in case it is not large data, add option list to pdu.
1426 for (coap_list_t *opt = *options; opt; opt = opt->next)
1428 OIC_LOG_V(DEBUG, TAG, "[%s] opt will be added.",
1429 COAP_OPTION_DATA(*(coap_option *) opt->data));
1431 OIC_LOG_V(DEBUG, TAG, "[%d] pdu length", (*pdu)->length);
1432 coap_add_option(*pdu, COAP_OPTION_KEY(*(coap_option *) opt->data),
1433 COAP_OPTION_LENGTH(*(coap_option *) opt->data),
1434 COAP_OPTION_DATA(*(coap_option *) opt->data), coap_udp);
1438 OIC_LOG_V(DEBUG, TAG, "[%d] pdu length after option", (*pdu)->length);
1440 // if response data is so large. it have to send as block transfer
1441 if (!coap_add_data(*pdu, dataLength, (const unsigned char *) info->payload))
1443 OIC_LOG(INFO, TAG, "it have to use block");
1444 res = CA_STATUS_FAILED;
1449 OIC_LOG(INFO, TAG, "not Blockwise Transfer");
1453 uint32_t code = (*pdu)->hdr->coap_hdr_udp_t.code;
1454 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
1456 // if received message type is RESET from remote device,
1457 // we have to use the updated message id of request message to find token.
1458 CABlockData_t *blockData = CAGetBlockDataFromBlockDataList(blockDataID);
1461 res = CAUpdateMessageId(*pdu, blockDataID);
1462 if (CA_STATUS_OK != res)
1464 OIC_LOG(ERROR, TAG, "fail to update message id");
1471 CADestroyBlockID(blockDataID);
1472 OIC_LOG(DEBUG, TAG, "OUT-AddBlockOption");
1476 CAResult_t CAAddBlockOption2(coap_pdu_t **pdu, const CAInfo_t *info, size_t dataLength,
1477 const CABlockDataID_t *blockID, coap_list_t **options)
1479 OIC_LOG(DEBUG, TAG, "IN-AddBlockOption2");
1480 VERIFY_NON_NULL(pdu, TAG, "pdu");
1481 VERIFY_NON_NULL((*pdu), TAG, "(*pdu)");
1482 VERIFY_NON_NULL((*pdu)->hdr, TAG, "(*pdu)->hdr");
1483 VERIFY_NON_NULL(info, TAG, "info");
1484 VERIFY_NON_NULL(blockID, TAG, "blockID");
1485 VERIFY_NON_NULL(options, TAG, "options");
1487 // get set block data from CABlock list-set.
1488 coap_block_t *block1 = CAGetBlockOption(blockID, COAP_OPTION_BLOCK1);
1489 coap_block_t *block2 = CAGetBlockOption(blockID, COAP_OPTION_BLOCK2);
1490 if (!block1 || !block2)
1492 OIC_LOG(ERROR, TAG, "getting has failed");
1493 return CA_STATUS_FAILED;
1496 CAResult_t res = CA_STATUS_OK;
1497 uint32_t code = (*pdu)->hdr->coap_hdr_udp_t.code;
1498 if (CA_GET != code && CA_POST != code && CA_PUT != code && CA_DELETE != code)
1500 CASetMoreBitFromBlock(dataLength, block2);
1502 // if block number is 0, add size2 option
1503 if (0 == block2->num)
1505 res = CAAddBlockSizeOption(*pdu, COAP_OPTION_SIZE2, dataLength, options);
1506 if (CA_STATUS_OK != res)
1508 OIC_LOG(ERROR, TAG, "add has failed");
1513 res = CAAddBlockOptionImpl(block2, COAP_OPTION_BLOCK2, options);
1514 if (CA_STATUS_OK != res)
1516 OIC_LOG(ERROR, TAG, "add has failed");
1522 OIC_LOG(DEBUG, TAG, "combining block1 and block2");
1523 res = CAAddBlockOptionImpl(block1, COAP_OPTION_BLOCK1, options);
1524 if (CA_STATUS_OK != res)
1526 OIC_LOG(ERROR, TAG, "add has failed");
1529 // initialize block number
1533 res = CAAddOptionToPDU(*pdu, options);
1534 if (CA_STATUS_OK != res)
1536 OIC_LOG(ERROR, TAG, "add has failed");
1540 if (!coap_add_block(*pdu, dataLength, (const unsigned char *) info->payload,
1541 block2->num, block2->szx))
1543 OIC_LOG(ERROR, TAG, "Data length is smaller than the start index");
1544 return CA_STATUS_FAILED;
1547 CALogBlockInfo(block2);
1551 // if sent message is last response block message, remove data
1552 CARemoveBlockDataFromList(blockID);
1557 OIC_LOG(DEBUG, TAG, "option2, not response msg");
1558 res = CAAddBlockOptionImpl(block2, COAP_OPTION_BLOCK2, options);
1559 if (CA_STATUS_OK != res)
1561 OIC_LOG(ERROR, TAG, "add has failed");
1565 res = CAAddOptionToPDU(*pdu, options);
1566 if (CA_STATUS_OK != res)
1568 OIC_LOG(ERROR, TAG, "add has failed");
1571 CALogBlockInfo(block2);
1574 return CA_STATUS_OK;
1577 CARemoveBlockDataFromList(blockID);
1581 CAResult_t CAAddBlockOption1(coap_pdu_t **pdu, const CAInfo_t *info, size_t dataLength,
1582 const CABlockDataID_t *blockID, coap_list_t **options)
1584 OIC_LOG(DEBUG, TAG, "IN-AddBlockOption1");
1585 VERIFY_NON_NULL(pdu, TAG, "pdu");
1586 VERIFY_NON_NULL((*pdu), TAG, "(*pdu)");
1587 VERIFY_NON_NULL((*pdu)->hdr, TAG, "(*pdu)->hdr");
1588 VERIFY_NON_NULL(info, TAG, "info");
1589 VERIFY_NON_NULL(blockID, TAG, "blockID");
1590 VERIFY_NON_NULL(options, TAG, "options");
1592 // get set block data from CABlock list-set.
1593 coap_block_t *block1 = CAGetBlockOption(blockID, COAP_OPTION_BLOCK1);
1596 OIC_LOG(ERROR, TAG, "getting has failed");
1597 return CA_STATUS_FAILED;
1600 CAResult_t res = CA_STATUS_OK;
1601 uint32_t code = (*pdu)->hdr->coap_hdr_udp_t.code;
1602 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
1604 CASetMoreBitFromBlock(dataLength, block1);
1606 // if block number is 0, add size1 option
1607 if (0 == block1->num)
1609 res = CAAddBlockSizeOption(*pdu, COAP_OPTION_SIZE1, dataLength, options);
1610 if (CA_STATUS_OK != res)
1612 OIC_LOG(ERROR, TAG, "add has failed");
1617 // add block option to option list.
1618 res = CAAddBlockOptionImpl(block1, COAP_OPTION_BLOCK1, options);
1619 if (CA_STATUS_OK != res)
1621 OIC_LOG(ERROR, TAG, "add has failed");
1625 // add option list to pdu.
1626 res = CAAddOptionToPDU(*pdu, options);
1627 if (CA_STATUS_OK != res)
1629 OIC_LOG(ERROR, TAG, "add has failed");
1633 // add the payload data as the block size.
1634 if (!coap_add_block(*pdu, dataLength, (const unsigned char *) info->payload, block1->num,
1637 OIC_LOG(ERROR, TAG, "Data length is smaller than the start index");
1638 return CA_STATUS_FAILED;
1643 OIC_LOG(DEBUG, TAG, "received response message with block option1");
1645 // add block option to option list.
1646 res = CAAddBlockOptionImpl(block1, COAP_OPTION_BLOCK1, options);
1647 if (CA_STATUS_OK != res)
1649 OIC_LOG(ERROR, TAG, "add has failed");
1653 // add option list to pdu.
1654 res = CAAddOptionToPDU(*pdu, options);
1655 if (CA_STATUS_OK != res)
1657 OIC_LOG(ERROR, TAG, "add has failed");
1661 // add the payload data as the block size.
1662 if (!coap_add_data(*pdu, dataLength, (const unsigned char *) info->payload))
1664 OIC_LOG(ERROR, TAG, "failed to add payload");
1665 return CA_STATUS_FAILED;
1668 // if it is last block message, remove block data from list.
1671 // remove data from list
1672 res = CARemoveBlockDataFromList(blockID);
1673 if (CA_STATUS_OK != res)
1675 OIC_LOG(ERROR, TAG, "remove has failed");
1681 CALogBlockInfo(block1);
1683 OIC_LOG(DEBUG, TAG, "OUT-AddBlockOption1");
1685 return CA_STATUS_OK;
1688 CARemoveBlockDataFromList(blockID);
1692 CAResult_t CAAddBlockOptionImpl(coap_block_t *block, uint8_t blockType,
1693 coap_list_t **options)
1695 OIC_LOG(DEBUG, TAG, "IN-AddBlockOptionImpl");
1696 VERIFY_NON_NULL(block, TAG, "block");
1697 VERIFY_NON_NULL(options, TAG, "options");
1699 unsigned char buf[BLOCKWISE_OPTION_BUFFER] = { 0 };
1700 unsigned int optionLength = coap_encode_var_bytes(buf,
1701 ((block->num << BLOCK_NUMBER_IDX)
1702 | (block->m << BLOCK_M_BIT_IDX)
1705 int ret = coap_insert(options,
1706 CACreateNewOptionNode(blockType, optionLength, (char *) buf),
1710 return CA_STATUS_INVALID_PARAM;
1713 OIC_LOG(DEBUG, TAG, "OUT-AddBlockOptionImpl");
1714 return CA_STATUS_OK;
1717 CAResult_t CAAddOptionToPDU(coap_pdu_t *pdu, coap_list_t **options)
1719 // after adding the block option to option list, add option list to pdu.
1722 for (coap_list_t *opt = *options; opt; opt = opt->next)
1724 OIC_LOG_V(DEBUG, TAG, "[%s] opt will be added.",
1725 COAP_OPTION_DATA(*(coap_option *) opt->data));
1727 OIC_LOG_V(DEBUG, TAG, "[%d] pdu length", pdu->length);
1728 int ret = coap_add_option(pdu, COAP_OPTION_KEY(*(coap_option *) opt->data),
1729 COAP_OPTION_LENGTH(*(coap_option *) opt->data),
1730 COAP_OPTION_DATA(*(coap_option *) opt->data), coap_udp);
1733 return CA_STATUS_FAILED;
1738 OIC_LOG_V(DEBUG, TAG, "[%d] pdu length after option", pdu->length);
1740 return CA_STATUS_OK;
1743 CAResult_t CAAddBlockSizeOption(coap_pdu_t *pdu, uint16_t sizeType, size_t dataLength,
1744 coap_list_t **options)
1746 OIC_LOG(DEBUG, TAG, "IN-CAAddBlockSizeOption");
1747 VERIFY_NON_NULL(pdu, TAG, "pdu");
1748 VERIFY_NON_NULL(options, TAG, "options");
1750 if (sizeType != COAP_OPTION_SIZE1 && sizeType != COAP_OPTION_SIZE2)
1752 OIC_LOG(ERROR, TAG, "unknown option type");
1753 return CA_STATUS_FAILED;
1756 unsigned char value[BLOCKWISE_OPTION_BUFFER] = { 0 };
1757 unsigned int optionLength = coap_encode_var_bytes(value, dataLength);
1759 int ret = coap_insert(options,
1760 CACreateNewOptionNode(sizeType, optionLength, (char *) value),
1764 return CA_STATUS_INVALID_PARAM;
1767 OIC_LOG(DEBUG, TAG, "OUT-CAAddBlockSizeOption");
1769 return CA_STATUS_OK;
1772 // TODO make pdu const after libcoap is updated to support that.
1773 bool CAIsPayloadLengthInPduWithBlockSizeOption(coap_pdu_t *pdu,
1775 size_t *totalPayloadLen)
1777 OIC_LOG(DEBUG, TAG, "IN-CAIsPayloadLengthInPduWithBlockSizeOption");
1778 VERIFY_NON_NULL(pdu, TAG, "pdu");
1779 VERIFY_NON_NULL(totalPayloadLen, TAG, "totalPayloadLen");
1781 if (sizeType != COAP_OPTION_SIZE1 && sizeType != COAP_OPTION_SIZE2)
1783 OIC_LOG(ERROR, TAG, "unknown option type");
1784 return CA_STATUS_FAILED;
1787 coap_opt_iterator_t opt_iter;
1788 coap_opt_t *option = coap_check_option(pdu, sizeType, &opt_iter);
1791 OIC_LOG(DEBUG, TAG, "get size option from pdu");
1792 *totalPayloadLen = coap_decode_var_bytes(COAP_OPT_VALUE(option),
1793 COAP_OPT_LENGTH(option));
1795 OIC_LOG_V(DEBUG, TAG, "the total payload length to be received is [%zu]bytes",
1801 OIC_LOG(DEBUG, TAG, "OUT-CAIsPayloadLengthInPduWithBlockSizeOption");
1806 uint8_t CACheckBlockErrorType(CABlockData_t *currData, coap_block_t *receivedBlock,
1807 const CAData_t *receivedData, uint16_t blockType,
1810 OIC_LOG(DEBUG, TAG, "IN-CheckBlockError");
1812 VERIFY_NON_NULL(currData, TAG, "currData is NULL");
1813 VERIFY_NON_NULL(receivedBlock, TAG, "receivedBlock is NULL");
1814 VERIFY_NON_NULL(receivedData, TAG, "receivedData is NULL");
1816 // #1. check the received payload length
1817 size_t blockPayloadLen = 0;
1818 CAGetPayloadInfo(receivedData, &blockPayloadLen);
1820 // #2. check if the block sequence is right
1821 if (COAP_OPTION_BLOCK1 == blockType)
1823 size_t prePayloadLen = currData->receivedPayloadLen;
1824 if (prePayloadLen != (size_t) BLOCK_SIZE(receivedBlock->szx) * receivedBlock->num)
1826 if (receivedBlock->num > currData->block1.num + 1)
1828 // 408 Error handling of block loss
1829 OIC_LOG(ERROR, TAG, "option1: error 4.08");
1830 OIC_LOG(ERROR, TAG, "it didn't order");
1831 return CA_BLOCK_INCOMPLETE;
1833 return CA_BLOCK_RECEIVED_ALREADY;
1836 else if (COAP_OPTION_BLOCK2 == blockType)
1838 if (receivedBlock->num != currData->block2.num)
1840 if (receivedBlock->num > currData->block2.num)
1842 // 408 Error handling of block loss
1843 OIC_LOG(ERROR, TAG, "option2: error 4.08");
1844 OIC_LOG(ERROR, TAG, "it didn't order");
1845 return CA_BLOCK_INCOMPLETE;
1847 return CA_BLOCK_RECEIVED_ALREADY;
1851 // #3. check if error check logic is required
1852 size_t optionLen = dataLen - blockPayloadLen;
1853 if (receivedBlock->m && blockPayloadLen != (size_t) BLOCK_SIZE(receivedBlock->szx))
1855 // 413 Error handling of too large entity
1856 if (COAP_MAX_PDU_SIZE < BLOCK_SIZE(receivedBlock->szx) + optionLen)
1858 // buffer size is smaller than received block size
1859 OIC_LOG(ERROR, TAG, "error type 4.13");
1860 OIC_LOG(ERROR, TAG, "too large size");
1862 // set the block size to be smaller than COAP_MAX_PDU_SIZE
1863 for (int32_t size = CA_DEFAULT_BLOCK_SIZE; size >= 0; size--)
1865 if (COAP_MAX_PDU_SIZE >= BLOCK_SIZE(size) + optionLen)
1867 OIC_LOG_V(ERROR, TAG, "replace sze with %d", size);
1868 currData->block2.szx = size;
1869 currData->block1.szx = size;
1873 return CA_BLOCK_TOO_LARGE;
1877 // 408 Error handling of payload loss
1878 OIC_LOG(ERROR, TAG, "error type 4.08");
1879 OIC_LOG(ERROR, TAG, "payload len != block sze");
1880 return CA_BLOCK_INCOMPLETE;
1883 else if (0 == receivedBlock->m && 0 != currData->payloadLength)
1885 // if the received block is last block, check the total payload length
1886 size_t receivedPayloadLen = currData->receivedPayloadLen;
1887 receivedPayloadLen += blockPayloadLen;
1889 if (receivedPayloadLen != currData->payloadLength)
1891 OIC_LOG(ERROR, TAG, "error type 4.08");
1892 OIC_LOG(ERROR, TAG, "total payload length is wrong");
1893 return CA_BLOCK_INCOMPLETE;
1897 OIC_LOG(DEBUG, TAG, "received all data normally");
1899 OIC_LOG(DEBUG, TAG, "OUT-CheckBlockError");
1901 return CA_BLOCK_UNKNOWN;
1904 CAResult_t CAUpdatePayloadData(CABlockData_t *currData, const CAData_t *receivedData,
1905 uint8_t status, bool isSizeOption, uint16_t blockType)
1907 OIC_LOG(DEBUG, TAG, "IN-UpdatePayloadData");
1909 VERIFY_NON_NULL(currData, TAG, "currData");
1910 VERIFY_NON_NULL(receivedData, TAG, "receivedData");
1912 // if error code is 4.08, do not update payload
1913 if (CA_BLOCK_INCOMPLETE == status)
1915 OIC_LOG(ERROR, TAG, "no require to update");
1916 return CA_STATUS_OK;
1919 size_t blockPayloadLen = 0;
1920 CAPayload_t blockPayload = CAGetPayloadInfo(receivedData, &blockPayloadLen);
1922 if (CA_BLOCK_TOO_LARGE == status)
1924 blockPayloadLen = (COAP_OPTION_BLOCK2 == blockType) ?
1925 BLOCK_SIZE(currData->block2.szx) : BLOCK_SIZE(currData->block1.szx);
1928 // memory allocation for the received block payload
1929 size_t prePayloadLen = currData->receivedPayloadLen;
1932 if (currData->payloadLength)
1934 // in case the block message has the size option
1935 // allocate the memory for the total payload
1938 CAPayload_t prePayload = currData->payload;
1940 OIC_LOG(DEBUG, TAG, "allocate memory for the total payload");
1941 currData->payload = (CAPayload_t) OICCalloc(1, currData->payloadLength);
1942 if (NULL == currData->payload)
1944 OIC_LOG(ERROR, TAG, "out of memory");
1945 return CA_MEMORY_ALLOC_FAILED;
1947 memcpy(currData->payload, prePayload, prePayloadLen);
1948 OICFree(prePayload);
1951 // update the total payload
1952 memcpy(currData->payload + prePayloadLen, blockPayload, blockPayloadLen);
1956 OIC_LOG(DEBUG, TAG, "allocate memory for the received block payload");
1958 size_t totalPayloadLen = prePayloadLen + blockPayloadLen;
1959 CAPayload_t newPayload = OICRealloc(currData->payload, totalPayloadLen);
1960 if (NULL == newPayload)
1962 OIC_LOG(ERROR, TAG, "out of memory");
1963 return CA_MEMORY_ALLOC_FAILED;
1966 // update the total payload
1967 memset(newPayload + prePayloadLen, 0, blockPayloadLen);
1968 currData->payload = newPayload;
1969 memcpy(currData->payload + prePayloadLen, blockPayload, blockPayloadLen);
1972 // update received payload length
1973 currData->receivedPayloadLen += blockPayloadLen;
1975 OIC_LOG_V(DEBUG, TAG, "updated payload: %s, len: %zu", currData->payload,
1976 currData->receivedPayloadLen);
1979 OIC_LOG(DEBUG, TAG, "OUT-UpdatePayloadData");
1980 return CA_STATUS_OK;
1983 CAData_t* CACreateNewDataSet(const coap_pdu_t *pdu, const CAEndpoint_t *endpoint)
1985 VERIFY_NON_NULL_RET(pdu, TAG, "pdu", NULL);
1986 VERIFY_NON_NULL_RET(pdu->hdr, TAG, "pdu->hdr", NULL);
1987 VERIFY_NON_NULL_RET(endpoint, TAG, "endpoint", NULL);
1989 CARequestInfo_t* requestInfo = NULL;
1990 CAResponseInfo_t* responseInfo = NULL;
1992 uint32_t code = pdu->hdr->coap_hdr_udp_t.code;
1993 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
1995 CAInfo_t responseData = { .tokenLength = pdu->hdr->coap_hdr_udp_t.token_length };
1996 responseData.token = (CAToken_t) OICMalloc(responseData.tokenLength);
1997 if (!responseData.token)
1999 OIC_LOG(ERROR, TAG, "out of memory");
2002 memcpy(responseData.token, pdu->hdr->coap_hdr_udp_t.token, responseData.tokenLength);
2004 responseInfo = (CAResponseInfo_t*) OICCalloc(1, sizeof(CAResponseInfo_t));
2007 OIC_LOG(ERROR, TAG, "out of memory");
2008 OICFree(responseData.token);
2011 responseInfo->info = responseData;
2015 CAInfo_t requestData = { .tokenLength = pdu->hdr->coap_hdr_udp_t.token_length };
2016 requestData.token = (CAToken_t) OICMalloc(requestData.tokenLength);
2017 if (!requestData.token)
2019 OIC_LOG(ERROR, TAG, "out of memory");
2022 memcpy(requestData.token, pdu->hdr->coap_hdr_udp_t.token, requestData.tokenLength);
2024 requestInfo = (CARequestInfo_t*) OICCalloc(1, sizeof(CARequestInfo_t));
2027 OIC_LOG(ERROR, TAG, "out of memory");
2028 OICFree(requestData.token);
2031 requestInfo->info = requestData;
2033 // get resource uri information from received response message
2034 // to send next request message to remote device
2035 CAResponseInfo_t* resInfo = (CAResponseInfo_t*)OICCalloc(1, sizeof(*resInfo));
2038 OIC_LOG(ERROR, TAG, "memory allocation failed");
2039 OICFree(requestData.token);
2043 CAGetResponseInfoFromPDU(pdu, resInfo, endpoint);
2044 requestInfo->method = CA_GET;
2045 requestInfo->info.resourceUri = OICStrdup(resInfo->info.resourceUri);
2047 // after copying the resource uri, destroy response info.
2048 CADestroyResponseInfoInternal(resInfo);
2051 CAData_t *data = (CAData_t *) OICCalloc(1, sizeof(CAData_t));
2054 OIC_LOG(ERROR, TAG, "out of memory");
2055 OICFree(requestInfo);
2056 OICFree(responseInfo);
2060 data->requestInfo = requestInfo;
2061 data->responseInfo = responseInfo;
2062 data->remoteEndpoint = CACloneEndpoint(endpoint);
2063 data->type = SEND_TYPE_UNICAST;
2068 CAData_t *CACloneCAData(const CAData_t *data)
2070 VERIFY_NON_NULL_RET(data, TAG, "data", NULL);
2072 CAData_t *clone = (CAData_t *) OICCalloc(1, sizeof(CAData_t));
2075 OIC_LOG(ERROR, TAG, "out of memory");
2080 if (data->requestInfo)
2082 clone->requestInfo = CACloneRequestInfo(data->requestInfo);
2084 else if (data->responseInfo)
2086 clone->responseInfo = CACloneResponseInfo(data->responseInfo);
2089 if (data->remoteEndpoint)
2091 clone->remoteEndpoint = CACloneEndpoint(data->remoteEndpoint);
2097 CAResult_t CAUpdatePayloadToCAData(CAData_t *data, const CAPayload_t payload,
2100 OIC_LOG(DEBUG, TAG, "IN-UpdatePayload");
2102 VERIFY_NON_NULL(data, TAG, "data is NULL");
2103 VERIFY_NON_NULL(payload, TAG, "payload is NULL");
2105 CAPayload_t newPayload = NULL;
2106 switch (data->dataType)
2108 case CA_REQUEST_DATA:
2109 if (!data->requestInfo)
2111 OIC_LOG(ERROR, TAG, "request info is null");
2112 return CA_STATUS_FAILED;
2114 // allocate payload field
2115 newPayload = OICRealloc(data->requestInfo->info.payload, payloadLen);
2118 OIC_LOG(ERROR, TAG, "out of memory");
2119 return CA_STATUS_FAILED;
2121 data->requestInfo->info.payload = newPayload;
2122 memcpy(data->requestInfo->info.payload, payload, payloadLen);
2123 data->requestInfo->info.payloadSize = payloadLen;
2126 case CA_RESPONSE_DATA:
2127 if (!data->responseInfo)
2129 OIC_LOG(ERROR, TAG, "response info is null");
2130 return CA_STATUS_FAILED;
2132 // allocate payload field
2133 newPayload = OICRealloc(data->responseInfo->info.payload, payloadLen);
2136 OIC_LOG(ERROR, TAG, "out of memory");
2137 return CA_STATUS_FAILED;
2139 data->responseInfo->info.payload = newPayload;
2140 memcpy(data->responseInfo->info.payload, payload, payloadLen);
2141 data->responseInfo->info.payloadSize = payloadLen;
2145 // does not occur case
2146 OIC_LOG(ERROR, TAG, "not supported data type");
2147 return CA_NOT_SUPPORTED;
2150 OIC_LOG(DEBUG, TAG, "OUT-UpdatePayload");
2152 return CA_STATUS_OK;
2155 CAPayload_t CAGetPayloadInfo(const CAData_t *data, size_t *payloadLen)
2157 VERIFY_NON_NULL_RET(data, TAG, "data", NULL);
2158 VERIFY_NON_NULL_RET(payloadLen, TAG, "payloadLen", NULL);
2160 if (data->requestInfo)
2162 if (data->requestInfo->info.payload)
2164 *payloadLen = data->requestInfo->info.payloadSize;
2165 return data->requestInfo->info.payload;
2170 if (data->responseInfo->info.payload)
2172 *payloadLen = data->responseInfo->info.payloadSize;
2173 return data->responseInfo->info.payload;
2180 CAResult_t CAHandleBlockErrorResponse(coap_block_t *block, uint16_t blockType,
2181 uint32_t responseResult)
2183 OIC_LOG(DEBUG, TAG, "IN-HandleBlockErrorRes");
2184 VERIFY_NON_NULL(block, TAG, "block is NULL");
2186 // update block data
2187 switch (responseResult)
2189 case CA_REQUEST_ENTITY_INCOMPLETE:
2192 case CA_REQUEST_ENTITY_TOO_LARGE:
2193 if (COAP_OPTION_BLOCK1 == blockType)
2200 OIC_LOG_V(ERROR, TAG, "there is no Error Code of BWT[%d]", responseResult);
2201 return CA_STATUS_FAILED;
2204 OIC_LOG(DEBUG, TAG, "OUT-HandleBlockErrorRes");
2205 return CA_STATUS_OK;
2208 CAResult_t CAUpdateBlockOptionType(const CABlockDataID_t *blockID,
2211 OIC_LOG(DEBUG, TAG, "IN-UpdateBlockOptionType");
2212 VERIFY_NON_NULL(blockID, TAG, "blockID");
2214 ca_mutex_lock(g_context.blockDataListMutex);
2216 size_t len = u_arraylist_length(g_context.dataList);
2217 for (size_t i = 0; i < len; i++)
2219 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2220 if (CABlockidMatches(currData, blockID))
2222 currData->type = blockType;
2223 ca_mutex_unlock(g_context.blockDataListMutex);
2224 OIC_LOG(DEBUG, TAG, "OUT-UpdateBlockOptionType");
2225 return CA_STATUS_OK;
2228 ca_mutex_unlock(g_context.blockDataListMutex);
2230 OIC_LOG(DEBUG, TAG, "OUT-UpdateBlockOptionType");
2231 return CA_STATUS_FAILED;
2234 uint8_t CAGetBlockOptionType(const CABlockDataID_t *blockID)
2236 OIC_LOG(DEBUG, TAG, "IN-GetBlockOptionType");
2237 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", 0);
2239 ca_mutex_lock(g_context.blockDataListMutex);
2241 size_t len = u_arraylist_length(g_context.dataList);
2242 for (size_t i = 0; i < len; i++)
2244 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2245 if (CABlockidMatches(currData, blockID))
2247 ca_mutex_unlock(g_context.blockDataListMutex);
2248 OIC_LOG(DEBUG, TAG, "OUT-GetBlockOptionType");
2249 return currData->type;
2252 ca_mutex_unlock(g_context.blockDataListMutex);
2254 OIC_LOG(DEBUG, TAG, "OUT-GetBlockOptionType");
2258 CAData_t *CAGetDataSetFromBlockDataList(const CABlockDataID_t *blockID)
2260 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", NULL);
2262 ca_mutex_lock(g_context.blockDataListMutex);
2264 size_t len = u_arraylist_length(g_context.dataList);
2265 for (size_t i = 0; i < len; i++)
2267 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2268 if (CABlockidMatches(currData, blockID))
2270 ca_mutex_unlock(g_context.blockDataListMutex);
2271 return currData->sentData;
2274 ca_mutex_unlock(g_context.blockDataListMutex);
2279 CAResult_t CAGetTokenFromBlockDataList(const coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
2280 CAResponseInfo_t *responseInfo)
2282 OIC_LOG(DEBUG, TAG, "IN-CAGetTokenFromBlockDataList");
2283 VERIFY_NON_NULL(pdu, TAG, "pdu");
2284 VERIFY_NON_NULL(endpoint, TAG, "endpoint");
2285 VERIFY_NON_NULL(responseInfo, TAG, "responseInfo");
2287 ca_mutex_lock(g_context.blockDataListMutex);
2289 size_t len = u_arraylist_length(g_context.dataList);
2290 for (size_t i = 0; i < len; i++)
2292 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2293 if (NULL == currData)
2298 if (NULL != currData->sentData && NULL != currData->sentData->requestInfo)
2300 if (pdu->hdr->coap_hdr_udp_t.id == currData->sentData->requestInfo->info.messageId &&
2301 endpoint->adapter == currData->sentData->remoteEndpoint->adapter)
2303 if (NULL != currData->sentData->requestInfo->info.token)
2305 uint8_t length = currData->sentData->requestInfo->info.tokenLength;
2306 responseInfo->info.tokenLength = length;
2307 responseInfo->info.token = (char *) OICMalloc(length);
2308 if (NULL == responseInfo->info.token)
2310 OIC_LOG(ERROR, TAG, "out of memory");
2311 ca_mutex_unlock(g_context.blockDataListMutex);
2312 return CA_MEMORY_ALLOC_FAILED;
2314 memcpy(responseInfo->info.token, currData->sentData->requestInfo->info.token,
2315 responseInfo->info.tokenLength);
2317 ca_mutex_unlock(g_context.blockDataListMutex);
2318 OIC_LOG(DEBUG, TAG, "OUT-CAGetTokenFromBlockDataList");
2319 return CA_STATUS_OK;
2325 ca_mutex_unlock(g_context.blockDataListMutex);
2327 OIC_LOG(DEBUG, TAG, "OUT-CAGetTokenFromBlockDataList");
2328 return CA_STATUS_FAILED;
2331 CAResult_t CACheckBlockDataValidation(const CAData_t *sendData, CABlockData_t **blockData)
2333 VERIFY_NON_NULL(sendData, TAG, "sendData");
2334 VERIFY_NON_NULL(blockData, TAG, "blockData");
2336 CABlockDataID_t* blockDataID;
2337 if(sendData->requestInfo)
2339 blockDataID = CACreateBlockDatablockId(
2340 (CAToken_t)sendData->requestInfo->info.token,
2341 sendData->requestInfo->info.tokenLength,
2342 sendData->remoteEndpoint->port);
2344 else if(sendData->responseInfo)
2346 blockDataID = CACreateBlockDatablockId(
2347 (CAToken_t)sendData->responseInfo->info.token,
2348 sendData->responseInfo->info.tokenLength,
2349 sendData->remoteEndpoint->port);
2353 OIC_LOG(ERROR, TAG, "sendData doesn't have requestInfo or responseInfo");
2354 return CA_STATUS_FAILED;
2357 if (NULL == blockDataID || blockDataID->idLength < 1)
2359 OIC_LOG(ERROR, TAG, "blockId is null");
2360 CADestroyBlockID(blockDataID);
2361 return CA_STATUS_FAILED;
2364 ca_mutex_lock(g_context.blockDataListMutex);
2366 size_t len = u_arraylist_length(g_context.dataList);
2367 for (size_t i = 0; i < len; i++)
2369 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2375 if (sendData->requestInfo) // sendData is requestMessage
2377 OIC_LOG(DEBUG, TAG, "Send request");
2378 if (NULL != currData->blockDataId
2379 && NULL != currData->blockDataId->id
2380 && currData->blockDataId->idLength > 0
2381 && NULL != sendData->requestInfo->info.token)
2383 if (CABlockidMatches(currData, blockDataID))
2385 OIC_LOG(ERROR, TAG, "already sent");
2390 else if (sendData->responseInfo) // sendData is responseMessage
2392 OIC_LOG(DEBUG, TAG, "Send response");
2393 if (NULL != currData->blockDataId
2394 && NULL != currData->blockDataId->id
2395 && currData->blockDataId->idLength > 0
2396 && NULL != sendData->responseInfo->info.token)
2398 if (CABlockidMatches(currData, blockDataID))
2401 if (NULL != currData->sentData)
2403 OIC_LOG(DEBUG, TAG, "init block number");
2404 CADestroyDataSet(currData->sentData);
2406 currData->sentData = CACloneCAData(sendData);
2407 *blockData = currData;
2408 ca_mutex_unlock(g_context.blockDataListMutex);
2409 CADestroyBlockID(blockDataID);
2410 return CA_STATUS_OK;
2416 OIC_LOG(ERROR, TAG, "no CAInfo data");
2420 ca_mutex_unlock(g_context.blockDataListMutex);
2422 CADestroyBlockID(blockDataID);
2424 return CA_STATUS_FAILED;
2427 CABlockData_t *CAGetBlockDataFromBlockDataList(const CABlockDataID_t *blockID)
2429 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", NULL);
2431 ca_mutex_lock(g_context.blockDataListMutex);
2433 size_t len = u_arraylist_length(g_context.dataList);
2434 for (size_t i = 0; i < len; i++)
2436 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2437 if (CABlockidMatches(currData, blockID))
2439 ca_mutex_unlock(g_context.blockDataListMutex);
2443 ca_mutex_unlock(g_context.blockDataListMutex);
2448 coap_block_t *CAGetBlockOption(const CABlockDataID_t *blockID, uint16_t blockType)
2450 OIC_LOG(DEBUG, TAG, "IN-GetBlockOption");
2451 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", NULL);
2453 ca_mutex_lock(g_context.blockDataListMutex);
2455 size_t len = u_arraylist_length(g_context.dataList);
2456 for (size_t i = 0; i < len; i++)
2458 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2459 if (CABlockidMatches(currData, blockID))
2461 ca_mutex_unlock(g_context.blockDataListMutex);
2462 OIC_LOG(DEBUG, TAG, "OUT-GetBlockOption");
2463 if (COAP_OPTION_BLOCK2 == blockType)
2465 return &currData->block2;
2467 else if (COAP_OPTION_BLOCK1 == blockType)
2469 return &currData->block1;
2473 ca_mutex_unlock(g_context.blockDataListMutex);
2475 OIC_LOG(DEBUG, TAG, "OUT-GetBlockOption");
2479 CAPayload_t CAGetPayloadFromBlockDataList(const CABlockDataID_t *blockID,
2480 size_t *fullPayloadLen)
2482 OIC_LOG(DEBUG, TAG, "IN-GetFullPayload");
2483 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", NULL);
2484 VERIFY_NON_NULL_RET(fullPayloadLen, TAG, "fullPayloadLen", NULL);
2486 ca_mutex_lock(g_context.blockDataListMutex);
2488 size_t len = u_arraylist_length(g_context.dataList);
2489 for (size_t i = 0; i < len; i++)
2491 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2492 if (CABlockidMatches(currData, blockID))
2494 ca_mutex_unlock(g_context.blockDataListMutex);
2495 *fullPayloadLen = currData->receivedPayloadLen;
2496 OIC_LOG(DEBUG, TAG, "OUT-GetFullPayload");
2497 return currData->payload;
2500 ca_mutex_unlock(g_context.blockDataListMutex);
2502 OIC_LOG(DEBUG, TAG, "OUT-GetFullPayload");
2506 CABlockData_t *CACreateNewBlockData(const CAData_t *sendData)
2508 OIC_LOG(DEBUG, TAG, "IN-CACreateNewBlockData");
2509 VERIFY_NON_NULL_RET(sendData, TAG, "sendData", NULL);
2511 // create block data
2512 CABlockData_t *data = (CABlockData_t *) OICCalloc(1, sizeof(CABlockData_t));
2515 OIC_LOG(ERROR, TAG, "memory alloc has failed");
2519 data->block1.szx = CA_DEFAULT_BLOCK_SIZE;
2520 data->block2.szx = CA_DEFAULT_BLOCK_SIZE;
2521 data->sentData = CACloneCAData(sendData);
2522 if (!data->sentData)
2524 OIC_LOG(ERROR, TAG, PCF("memory alloc has failed"));
2529 CAToken_t token = NULL;
2530 uint8_t tokenLength = 0;
2531 if (data->sentData->requestInfo)
2533 // update token info
2534 tokenLength = data->sentData->requestInfo->info.tokenLength;
2535 token = data->sentData->requestInfo->info.token;
2537 else if (data->sentData->responseInfo)
2539 tokenLength = data->sentData->responseInfo->info.tokenLength;
2540 token = data->sentData->responseInfo->info.token;
2543 if (!data->sentData->remoteEndpoint)
2545 OIC_LOG(ERROR, TAG, "remoteEndpoint is null");
2546 CADestroyDataSet(data->sentData);
2551 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(token, tokenLength,
2552 data->sentData->remoteEndpoint->port);
2553 if (NULL == blockDataID || blockDataID->idLength < 1)
2555 OIC_LOG(ERROR, TAG, "blockId is null");
2556 CADestroyBlockID(blockDataID);
2557 CADestroyDataSet(data->sentData);
2561 data->blockDataId = blockDataID;
2563 ca_mutex_lock(g_context.blockDataListMutex);
2565 bool res = u_arraylist_add(g_context.dataList, (void *) data);
2568 OIC_LOG(ERROR, TAG, "add has failed");
2569 CADestroyBlockID(data->blockDataId);
2570 CADestroyDataSet(data->sentData);
2572 ca_mutex_unlock(g_context.blockDataListMutex);
2575 ca_mutex_unlock(g_context.blockDataListMutex);
2577 OIC_LOG(DEBUG, TAG, "OUT-CreateBlockData");
2581 CAResult_t CARemoveBlockDataFromList(const CABlockDataID_t *blockID)
2583 OIC_LOG(DEBUG, TAG, "CARemoveBlockData");
2584 VERIFY_NON_NULL(blockID, TAG, "blockID");
2586 ca_mutex_lock(g_context.blockDataListMutex);
2588 size_t len = u_arraylist_length(g_context.dataList);
2589 for (size_t i = 0; i < len; i++)
2591 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2592 if (CABlockidMatches(currData, blockID))
2594 CABlockData_t *removedData = u_arraylist_remove(g_context.dataList, i);
2597 OIC_LOG(ERROR, TAG, "data is NULL");
2598 ca_mutex_unlock(g_context.blockDataListMutex);
2599 return CA_STATUS_FAILED;
2603 CADestroyDataSet(currData->sentData);
2604 CADestroyBlockID(currData->blockDataId);
2605 OICFree(currData->payload);
2607 ca_mutex_unlock(g_context.blockDataListMutex);
2608 return CA_STATUS_OK;
2611 ca_mutex_unlock(g_context.blockDataListMutex);
2613 return CA_STATUS_OK;
2616 CAResult_t CARemoveAllBlockDataFromList()
2618 OIC_LOG(DEBUG, TAG, "CARemoveAllBlockDataFromList");
2620 ca_mutex_lock(g_context.blockDataListMutex);
2622 size_t len = u_arraylist_length(g_context.dataList);
2623 for (size_t i = len; i > 0; i--)
2625 CABlockData_t *removedData = u_arraylist_remove(g_context.dataList, i - 1);
2629 if (removedData->sentData)
2631 CADestroyDataSet(removedData->sentData);
2633 CADestroyBlockID(removedData->blockDataId);
2634 OICFree(removedData->payload);
2635 OICFree(removedData);
2638 ca_mutex_unlock(g_context.blockDataListMutex);
2640 return CA_STATUS_OK;
2643 void CADestroyDataSet(CAData_t* data)
2645 VERIFY_NON_NULL_VOID(data, TAG, "data");
2647 CAFreeEndpoint(data->remoteEndpoint);
2648 CADestroyRequestInfoInternal(data->requestInfo);
2649 CADestroyResponseInfoInternal(data->responseInfo);
2653 CABlockDataID_t* CACreateBlockDatablockId(const CAToken_t token, uint8_t tokenLength,
2654 uint16_t portNumber)
2656 char port[PORT_LENGTH] = { 0, };
2657 port[0] = (char) ((portNumber >> 8) & 0xFF);
2658 port[1] = (char) (portNumber & 0xFF);
2660 CABlockDataID_t* blockDataID = (CABlockDataID_t *) OICMalloc(sizeof(CABlockDataID_t));
2663 OIC_LOG(ERROR, TAG, "memory alloc has failed");
2666 blockDataID->idLength = tokenLength + sizeof(port);
2667 blockDataID->id = (uint8_t *) OICMalloc(blockDataID->idLength);
2668 if (!blockDataID->id)
2670 OIC_LOG(ERROR, TAG, "memory alloc has failed");
2671 OICFree(blockDataID);
2677 memcpy(blockDataID->id, token, tokenLength);
2680 memcpy(blockDataID->id + tokenLength, port, sizeof(port));
2682 OIC_LOG(DEBUG, TAG, "BlockID is ");
2683 OIC_LOG_BUFFER(DEBUG, TAG, (const uint8_t *)blockDataID->id, blockDataID->idLength);
2688 void CADestroyBlockID(CABlockDataID_t *blockID)
2690 VERIFY_NON_NULL_VOID(blockID, TAG, "blockID");
2691 OICFree(blockID->id);
2696 bool CABlockidMatches(const CABlockData_t *currData, const CABlockDataID_t *blockID)
2698 VERIFY_NON_NULL_RET(currData, TAG, "currData", false);
2699 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", false);
2700 VERIFY_NON_NULL_RET(blockID->id, TAG, "blockID->id", false);
2702 if ((currData->blockDataId)
2703 && (currData->blockDataId->id)
2704 && (currData->blockDataId->idLength == blockID->idLength)
2705 && !memcmp(currData->blockDataId->id, blockID->id, currData->blockDataId->idLength))
2712 void CALogBlockInfo(coap_block_t *block)
2714 VERIFY_NON_NULL_VOID(block, TAG, "block");
2716 OIC_LOG(DEBUG, TAG, "block option info");
2718 OIC_LOG_V(DEBUG, TAG, "block option-num : %d", block->num);
2720 OIC_LOG_V(DEBUG, TAG, "block option-m : %d", block->m);
2722 OIC_LOG_V(DEBUG, TAG, "block option-szx : %d", block->szx);
2725 CAResult_t CARemoveBlockDataFromListWithSeed(const CAToken_t token, uint8_t tokenLength,
2726 uint16_t portNumber)
2728 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(token, tokenLength, portNumber);
2729 if (NULL == blockDataID || blockDataID->idLength < 1)
2731 OIC_LOG(ERROR, TAG, "blockId is null");
2732 CADestroyBlockID(blockDataID);
2733 return CA_STATUS_FAILED;
2736 CAResult_t res = CA_STATUS_OK;
2738 if (NULL != CAGetBlockDataFromBlockDataList(blockDataID))
2740 res = CARemoveBlockDataFromList(blockDataID);
2741 if (CA_STATUS_OK != res)
2743 OIC_LOG(ERROR, TAG, "CARemoveBlockDataFromList failed");
2747 CADestroyBlockID(blockDataID);