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 // If we didn't send the last block message and received EMPTY message,
350 // we have to remain the block data from list.
351 CABlockData_t *data = CAGetBlockDataFromBlockDataList(blockDataID);
352 if (data && (data->block1.m || data->block2.m))
354 OIC_LOG(DEBUG, TAG, "this is normal EMPTY message for blockwise-transfer.");
355 CADestroyBlockID(blockDataID);
359 CARemoveBlockDataFromList(blockDataID);
360 CADestroyBlockID(blockDataID);
361 return CA_NOT_SUPPORTED;
364 // check if block option is set and get block data
365 coap_block_t block = { 0, 0, 0 };
368 int isBlock1 = coap_get_block(pdu, COAP_OPTION_BLOCK1, &block);
371 CAResult_t res = CASetNextBlockOption1(pdu, endpoint, receivedData, block, dataLen);
372 if (CA_STATUS_OK != res)
374 OIC_LOG(ERROR, TAG, "setting has failed");
380 int isBlock2 = coap_get_block(pdu, COAP_OPTION_BLOCK2, &block);
383 CAResult_t res = CASetNextBlockOption2(pdu, endpoint, receivedData, block, dataLen);
384 if (CA_STATUS_OK != res)
386 OIC_LOG(ERROR, TAG, "setting has failed");
391 // if there is no block option in pdu, check if there is error code.
392 if (!isBlock1 && !isBlock2)
394 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(
395 (CAToken_t)pdu->hdr->coap_hdr_udp_t.token,
396 pdu->hdr->coap_hdr_udp_t.token_length,
398 if (NULL == blockDataID || blockDataID->idLength < 1)
400 OIC_LOG(ERROR, TAG, "blockId is null");
401 CADestroyBlockID(blockDataID);
402 return CA_STATUS_FAILED;
405 uint32_t code = CA_RESPONSE_CODE(pdu->hdr->coap_hdr_udp_t.code);
406 if (CA_REQUEST_ENTITY_INCOMPLETE == code)
408 CABlockData_t *data = CAGetBlockDataFromBlockDataList(blockDataID);
411 OIC_LOG(ERROR, TAG, "getting has failed");
412 CADestroyBlockID(blockDataID);
413 return CA_STATUS_FAILED;
416 coap_block_t *block = CAGetBlockOption(blockDataID, data->type);
419 OIC_LOG(ERROR, TAG, "block is null");
420 CADestroyBlockID(blockDataID);
421 return CA_STATUS_FAILED;
424 CAResult_t res = CA_STATUS_OK;
425 if (COAP_OPTION_BLOCK2 == data->type)
427 res = CASetNextBlockOption2(pdu, endpoint, receivedData, *block, dataLen);
428 if (CA_STATUS_OK != res)
430 OIC_LOG(ERROR, TAG, "setting has failed");
431 CADestroyBlockID(blockDataID);
432 return CA_STATUS_FAILED;
435 else if (COAP_OPTION_BLOCK1 == data->type)
437 res = CASetNextBlockOption1(pdu, endpoint, receivedData, *block, dataLen);
438 if (CA_STATUS_OK != res)
440 OIC_LOG(ERROR, TAG, "setting has failed");
441 CADestroyBlockID(blockDataID);
445 CADestroyBlockID(blockDataID);
450 OIC_LOG(DEBUG, TAG, "it's normal pdu");
452 // if received data is response message
453 // and sent data remain in block data list, remove block data
454 if (receivedData->responseInfo)
456 CARemoveBlockDataFromList(blockDataID);
458 CADestroyBlockID(blockDataID);
459 return CA_NOT_SUPPORTED;
465 CAResult_t CAProcessNextStep(const coap_pdu_t *pdu, const CAData_t *receivedData,
466 uint8_t blockWiseStatus, const CABlockDataID_t *blockID)
468 VERIFY_NON_NULL(pdu, TAG, "pdu");
469 VERIFY_NON_NULL(pdu->hdr, TAG, "pdu->hdr");
470 VERIFY_NON_NULL(blockID, TAG, "blockID");
472 CAResult_t res = CA_STATUS_OK;
473 CAData_t *data = NULL;
475 // process blockWiseStatus
476 switch (blockWiseStatus)
478 case CA_OPTION2_FIRST_BLOCK:
479 res = CAAddSendThreadQueue(receivedData, blockID);
480 if (CA_STATUS_OK != res)
482 OIC_LOG(ERROR, TAG, "add has failed");
487 case CA_OPTION2_REQUEST:
488 // add data to send thread
489 data = CAGetDataSetFromBlockDataList(blockID);
492 OIC_LOG(ERROR, TAG, "it's unavailable");
493 return CA_STATUS_FAILED;
496 if (data->responseInfo)
498 data->responseInfo->info.type =
499 (pdu->hdr->coap_hdr_udp_t.type == CA_MSG_CONFIRM) ?
500 CA_MSG_ACKNOWLEDGE : CA_MSG_NONCONFIRM;
501 data->responseInfo->info.messageId = pdu->hdr->coap_hdr_udp_t.id;
503 res = CAAddSendThreadQueue(data, blockID);
504 if (CA_STATUS_OK != res)
506 OIC_LOG(ERROR, TAG, "add has failed");
512 case CA_OPTION1_RESPONSE:
513 case CA_OPTION2_RESPONSE:
514 case CA_OPTION1_REQUEST_BLOCK:
515 res = CASendBlockMessage(pdu, pdu->hdr->coap_hdr_udp_t.type, blockID);
516 if (CA_STATUS_OK != res)
518 OIC_LOG(ERROR, TAG, "send has failed");
523 case CA_OPTION2_LAST_BLOCK:
524 // process last block and send upper layer
525 res = CAReceiveLastBlock(blockID, receivedData);
526 if (CA_STATUS_OK != res)
528 OIC_LOG(ERROR, TAG, "receive has failed");
532 // remove data from list
533 res = CARemoveBlockDataFromList(blockID);
534 if (CA_STATUS_OK != res)
536 OIC_LOG(ERROR, TAG, "remove has failed");
541 case CA_OPTION1_REQUEST_LAST_BLOCK:
542 // process last block and send upper layer
543 res = CAReceiveLastBlock(blockID, receivedData);
544 if (CA_STATUS_OK != res)
546 OIC_LOG(ERROR, TAG, "receive has failed");
551 case CA_BLOCK_INCOMPLETE:
552 // add data to send thread
553 res = CASendErrorMessage(pdu, blockWiseStatus, CA_REQUEST_ENTITY_INCOMPLETE, blockID);
554 if (CA_STATUS_OK != res)
556 OIC_LOG(ERROR, TAG, "send has failed");
561 case CA_BLOCK_TOO_LARGE:
562 if (receivedData->requestInfo)
564 res = CASendErrorMessage(pdu, blockWiseStatus, CA_REQUEST_ENTITY_TOO_LARGE,
566 if (CA_STATUS_OK != res)
568 OIC_LOG(ERROR, TAG, "send has failed");
572 else if (receivedData->responseInfo)
574 res = CASendBlockMessage(pdu, pdu->hdr->coap_hdr_udp_t.type, blockID);
575 if (CA_STATUS_OK != res)
577 OIC_LOG(ERROR, TAG, "send has failed");
583 OIC_LOG_V(ERROR, TAG, "no logic [%d]", blockWiseStatus);
588 static CAResult_t CASendDirectEmptyResponse(const CAEndpoint_t *endpoint, uint16_t messageId)
590 OIC_LOG(DEBUG, TAG, "Entering CASendDirectEmptyResponse");
591 CAResponseInfo_t respInfo = {
594 respInfo.info.type = CA_MSG_ACKNOWLEDGE;
595 respInfo.info.messageId = messageId;
596 respInfo.info.dataType = CA_RESPONSE_DATA;
598 CAResult_t caResult = CASendResponse(endpoint, &respInfo);
600 OIC_LOG(DEBUG, TAG, "Exit CASendDirectEmptyResponse");
604 CAResult_t CASendBlockMessage(const coap_pdu_t *pdu, CAMessageType_t msgType,
605 const CABlockDataID_t *blockID)
607 VERIFY_NON_NULL(pdu, TAG, "pdu");
608 VERIFY_NON_NULL(pdu->hdr, TAG, "pdu->hdr");
609 VERIFY_NON_NULL(blockID, TAG, "blockID");
611 CAData_t *data = CAGetDataSetFromBlockDataList(blockID);
614 OIC_LOG(ERROR, TAG, "CAData is unavailable");
615 return CA_STATUS_FAILED;
618 CAMessageType_t sentMsgType = CA_MSG_NONCONFIRM;
622 sentMsgType = CA_MSG_ACKNOWLEDGE;
624 case CA_MSG_ACKNOWLEDGE:
625 sentMsgType = CA_MSG_CONFIRM;
628 sentMsgType = CA_MSG_NONCONFIRM;
632 uint32_t code = pdu->hdr->coap_hdr_udp_t.code;
633 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
635 if (data->responseInfo)
637 OIC_LOG(DEBUG, TAG, "set response info");
638 data->responseInfo->info.messageId = pdu->hdr->coap_hdr_udp_t.id;
639 data->responseInfo->info.type = sentMsgType;
640 data->responseInfo->result = CA_CONTINUE;
645 // if the received response message type is CON, send empty message.
646 // and then, send next block request message with new messagId.
647 if (msgType == CA_MSG_CONFIRM)
649 CASendDirectEmptyResponse(data->remoteEndpoint,
650 data->requestInfo->info.messageId);
651 sentMsgType = CA_MSG_CONFIRM;
654 if (data->requestInfo)
656 OIC_LOG(DEBUG, TAG, "need new msgID");
657 data->requestInfo->info.messageId = 0;
658 data->requestInfo->info.type = sentMsgType;
662 // add data to send thread
663 CAResult_t res = CAAddSendThreadQueue(data, blockID);
664 if (CA_STATUS_OK != res)
666 OIC_LOG(ERROR, TAG, "add has failed");
672 CAResult_t CASendErrorMessage(const coap_pdu_t *pdu, uint8_t status,
673 CAResponseResult_t responseResult, const CABlockDataID_t *blockID)
675 VERIFY_NON_NULL(pdu, TAG, "pdu");
676 VERIFY_NON_NULL(pdu->hdr, TAG, "pdu->hdr");
677 VERIFY_NON_NULL(blockID, TAG, "blockID");
679 // create error responseInfo
680 CABlockData_t *data = CAGetBlockDataFromBlockDataList(blockID);
683 OIC_LOG(ERROR, TAG, "data is unavailable");
684 return CA_STATUS_FAILED;
687 CAMessageType_t sentMsgType = CA_MSG_NONCONFIRM;
688 switch (pdu->hdr->coap_hdr_udp_t.type)
691 sentMsgType = CA_MSG_ACKNOWLEDGE;
693 case CA_MSG_ACKNOWLEDGE:
694 sentMsgType = CA_MSG_CONFIRM;
698 CAData_t *cloneData = NULL;
701 cloneData = CACloneCAData(data->sentData);
704 OIC_LOG(ERROR, TAG, "clone has failed");
705 return CA_MEMORY_ALLOC_FAILED;
708 if (cloneData->responseInfo)
710 cloneData->responseInfo->info.messageId = pdu->hdr->coap_hdr_udp_t.id;
711 cloneData->responseInfo->info.type = sentMsgType;
712 cloneData->responseInfo->result = responseResult;
716 CAInfo_t responseData = { .tokenLength = pdu->hdr->coap_hdr_udp_t.token_length };
717 responseData.token = (CAToken_t) OICMalloc(responseData.tokenLength);
718 if (!responseData.token)
720 OIC_LOG(ERROR, TAG, "out of memory");
721 return CA_MEMORY_ALLOC_FAILED;
723 memcpy(responseData.token, pdu->hdr->coap_hdr_udp_t.token, responseData.tokenLength);
725 cloneData->responseInfo = (CAResponseInfo_t*) OICCalloc(1, sizeof(CAResponseInfo_t));
726 if (!cloneData->responseInfo)
728 OIC_LOG(ERROR, TAG, "out of memory");
729 OICFree(responseData.token);
730 return CA_MEMORY_ALLOC_FAILED;
733 cloneData->responseInfo->info = responseData;
734 cloneData->responseInfo->info.type = sentMsgType;
735 cloneData->responseInfo->result = responseResult;
737 OIC_LOG(DEBUG, TAG, "set response message to send error code");
741 OIC_LOG(ERROR, TAG, "data has no sent-data");
742 return CA_MEMORY_ALLOC_FAILED;
745 // if there is a requestInfo, remove it to send response message
746 if (cloneData->requestInfo)
748 CADestroyRequestInfoInternal(cloneData->requestInfo);
749 cloneData->requestInfo = NULL;
752 // add data to send thread
753 if (g_context.sendThreadFunc)
755 ca_mutex_lock(g_context.blockDataSenderMutex);
756 g_context.sendThreadFunc(cloneData);
757 ca_mutex_unlock(g_context.blockDataSenderMutex);
761 CADestroyDataSet(cloneData);
764 // if error code is 4.08, remove the stored payload and initialize block number
765 if (CA_BLOCK_INCOMPLETE == status)
767 OICFree(data->payload);
768 data->payload = NULL;
769 data->payloadLength = 0;
770 data->receivedPayloadLen = 0;
771 data->block1.num = 0;
772 data->block2.num = 0;
778 CAResult_t CAReceiveLastBlock(const CABlockDataID_t *blockID, const CAData_t *receivedData)
780 VERIFY_NON_NULL(blockID, TAG, "blockID");
781 VERIFY_NON_NULL(receivedData, TAG, "receivedData");
783 // total block data have to notify to Application
784 CAData_t *cloneData = CACloneCAData(receivedData);
787 OIC_LOG(ERROR, TAG, "clone has failed");
788 return CA_MEMORY_ALLOC_FAILED;
792 size_t fullPayloadLen = 0;
793 CAPayload_t fullPayload = CAGetPayloadFromBlockDataList(blockID, &fullPayloadLen);
796 CAResult_t res = CAUpdatePayloadToCAData(cloneData, fullPayload, fullPayloadLen);
797 if (CA_STATUS_OK != res)
799 OIC_LOG(ERROR, TAG, "update has failed");
800 CADestroyDataSet(cloneData);
805 if (g_context.receivedThreadFunc)
807 g_context.receivedThreadFunc(cloneData);
811 CADestroyDataSet(cloneData);
817 static CABlockData_t* CACheckTheExistOfBlockData(const CABlockDataID_t* blockDataID,
818 coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
821 // Get BlockData data. If does not exist, create a new data
822 CABlockData_t *data = CAGetBlockDataFromBlockDataList(blockDataID);
825 OIC_LOG(DEBUG, TAG, "block data doesn't exist in list. create new one");
827 CAData_t *cadata = CACreateNewDataSet(pdu, endpoint);
830 OIC_LOG(ERROR, TAG, "data is null");
834 data = CACreateNewBlockData(cadata);
837 OIC_LOG(ERROR, TAG, "failed to create a new block data");
838 CADestroyDataSet(cadata);
841 CADestroyDataSet(cadata);
844 // update BLOCK OPTION type
845 CAResult_t res = CAUpdateBlockOptionType(blockDataID, blockType);
846 if (CA_STATUS_OK != res)
848 OIC_LOG(ERROR, TAG, "update has failed");
855 // TODO make pdu const after libcoap is updated to support that.
856 CAResult_t CASetNextBlockOption1(coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
857 const CAData_t *receivedData, coap_block_t block,
860 OIC_LOG(INFO, TAG, "CASetNextBlockOption1");
861 VERIFY_NON_NULL(pdu, TAG, "pdu");
862 VERIFY_NON_NULL(pdu->hdr, TAG, "pdu->hdr");
863 VERIFY_NON_NULL(endpoint, TAG, "endpoint");
864 VERIFY_NON_NULL(receivedData, TAG, "receivedData");
866 OIC_LOG_V(INFO, TAG, "num:%d, M:%d, sze:%d", block.num, block.m, block.szx);
868 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(
869 (CAToken_t)pdu->hdr->coap_hdr_udp_t.token,
870 pdu->hdr->coap_hdr_udp_t.token_length,
872 if (NULL == blockDataID || blockDataID->idLength < 1)
874 OIC_LOG(ERROR, TAG, "blockId is null");
875 CADestroyBlockID(blockDataID);
876 return CA_STATUS_FAILED;
879 CAResult_t res = CA_STATUS_OK;
880 CABlockData_t *data = CACheckTheExistOfBlockData(blockDataID, pdu, endpoint,
884 OIC_LOG(ERROR, TAG, "Failed to create or get block data");
885 res = CA_STATUS_FAILED;
889 uint8_t blockWiseStatus = CA_BLOCK_UNKNOWN;
890 uint32_t code = pdu->hdr->coap_hdr_udp_t.code;
891 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
893 // received message type is request
894 OIC_LOG_V(INFO, TAG, "num:%d, M:%d", block.num, block.m);
896 // check the size option
897 bool isSizeOption = CAIsPayloadLengthInPduWithBlockSizeOption(pdu, COAP_OPTION_SIZE1,
898 &(data->payloadLength));
900 blockWiseStatus = CACheckBlockErrorType(data, &block, receivedData,
901 COAP_OPTION_BLOCK1, dataLen);
903 if (CA_BLOCK_RECEIVED_ALREADY != blockWiseStatus)
905 // store the received payload and merge
906 res = CAUpdatePayloadData(data, receivedData, blockWiseStatus,
907 isSizeOption, COAP_OPTION_BLOCK1);
908 if (CA_STATUS_OK != res)
910 OIC_LOG(ERROR, TAG, "update has failed");
914 res = CAUpdateBlockOptionItems(data, pdu, &block, COAP_OPTION_BLOCK1,
916 if (CA_STATUS_OK != res)
918 OIC_LOG(ERROR, TAG, "update has failed");
923 res = CAUpdateBlockData(data, block, COAP_OPTION_BLOCK1);
924 if (CA_STATUS_OK != res)
926 OIC_LOG(ERROR, TAG, "update has failed");
931 // check the blcok-wise transfer status for next step
932 if (CA_BLOCK_UNKNOWN == blockWiseStatus || CA_BLOCK_RECEIVED_ALREADY == blockWiseStatus)
934 OIC_LOG_V(DEBUG, TAG, "M bit is %d", block.m);
936 blockWiseStatus = (0 == block.m) ?
937 CA_OPTION1_REQUEST_LAST_BLOCK : CA_OPTION1_REQUEST_BLOCK;
942 // received message type is response
943 uint32_t code = CA_RESPONSE_CODE(pdu->hdr->coap_hdr_udp_t.code);
944 if (0 == block.m && (CA_REQUEST_ENTITY_INCOMPLETE != code
945 && CA_REQUEST_ENTITY_TOO_LARGE != code))
947 int isBlock2 = coap_get_block(pdu, COAP_OPTION_BLOCK2, &block);
950 OIC_LOG(INFO, TAG, "received data is combining block1 and block2");
951 // initialize block number for response message
952 data->block1.num = 0;
953 CADestroyBlockID(blockDataID);
958 OIC_LOG(INFO, TAG, "received data is not bulk data");
959 CAReceiveLastBlock(blockDataID, receivedData);
965 blockWiseStatus = CA_OPTION1_RESPONSE;
966 res = CAUpdateBlockOptionItems(data, pdu, &block, COAP_OPTION_BLOCK1, blockWiseStatus);
967 if (CA_STATUS_OK != res)
969 OIC_LOG(ERROR, TAG, "update has failed");
970 CADestroyBlockID(blockDataID);
974 res = CAUpdateBlockData(data, block, COAP_OPTION_BLOCK1);
975 if (CA_STATUS_OK != res)
977 OIC_LOG(ERROR, TAG, "update has failed");
982 res = CAProcessNextStep(pdu, receivedData, blockWiseStatus, blockDataID);
983 if (CA_STATUS_OK != res)
985 OIC_LOG(ERROR, TAG, "setting has failed");
989 CADestroyBlockID(blockDataID);
993 CARemoveBlockDataFromList(blockDataID);
994 CADestroyBlockID(blockDataID);
998 // TODO make pdu const after libcoap is updated to support that.
999 CAResult_t CASetNextBlockOption2(coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
1000 const CAData_t *receivedData, coap_block_t block,
1003 OIC_LOG(DEBUG, TAG, "CASetNextBlockOption2");
1004 OIC_LOG_V(INFO, TAG, "num:%d, M:%d, sze:%d", block.num, block.m, block.szx);
1006 VERIFY_NON_NULL(pdu, TAG, "pdu");
1007 VERIFY_NON_NULL(pdu->hdr, TAG, "pdu->hdr");
1008 VERIFY_NON_NULL(endpoint, TAG, "endpoint");
1009 VERIFY_NON_NULL(receivedData, TAG, "receivedData");
1011 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(
1012 (CAToken_t)pdu->hdr->coap_hdr_udp_t.token,
1013 pdu->hdr->coap_hdr_udp_t.token_length,
1015 if (NULL == blockDataID || blockDataID->idLength < 1)
1017 OIC_LOG(ERROR, TAG, "blockId is null");
1018 CADestroyBlockID(blockDataID);
1019 return CA_STATUS_FAILED;
1022 CAResult_t res = CA_STATUS_OK;
1023 CABlockData_t *data = CACheckTheExistOfBlockData(blockDataID, pdu, endpoint,
1024 COAP_OPTION_BLOCK2);
1027 OIC_LOG(ERROR, TAG, "Failed to create or get block data");
1028 res = CA_STATUS_FAILED;
1032 uint8_t blockWiseStatus = CA_BLOCK_UNKNOWN;
1033 if (0 == block.num && CA_GET == pdu->hdr->coap_hdr_udp_t.code && 0 == block.m)
1035 OIC_LOG(INFO, TAG, "first block number");
1037 res = CAUpdateBlockOptionItems(data, pdu, &block, COAP_OPTION_BLOCK2, blockWiseStatus);
1038 if (CA_STATUS_OK != res)
1040 OIC_LOG(ERROR, TAG, "update has failed");
1044 // first block data have to notify to Application
1045 res = CAUpdateBlockData(data, block, COAP_OPTION_BLOCK2);
1046 if (CA_STATUS_OK != res)
1048 OIC_LOG(ERROR, TAG, "update has failed");
1051 blockWiseStatus = CA_OPTION2_FIRST_BLOCK;
1055 uint32_t code = pdu->hdr->coap_hdr_udp_t.code;
1056 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
1058 // received message type is request
1059 OIC_LOG_V(INFO, TAG, "num:%d, M:%d", block.num, block.m);
1061 blockWiseStatus = CA_OPTION2_REQUEST;
1063 res = CAUpdateBlockOptionItems(data, pdu, &block, COAP_OPTION_BLOCK2, blockWiseStatus);
1064 if (CA_STATUS_OK != res)
1066 OIC_LOG(ERROR, TAG, "update has failed");
1070 res = CAUpdateBlockData(data, block, COAP_OPTION_BLOCK2);
1071 if (CA_STATUS_OK != res)
1073 OIC_LOG(ERROR, TAG, "update has failed");
1079 // received message type is response
1080 OIC_LOG(DEBUG, TAG, "received response message with block option2");
1082 // check the size option
1083 bool isSizeOption = CAIsPayloadLengthInPduWithBlockSizeOption(pdu,
1085 &(data->payloadLength));
1087 uint32_t code = CA_RESPONSE_CODE(pdu->hdr->coap_hdr_udp_t.code);
1088 if (CA_REQUEST_ENTITY_INCOMPLETE != code && CA_REQUEST_ENTITY_TOO_LARGE != code)
1090 // check if received payload is exact
1091 blockWiseStatus = CACheckBlockErrorType(data, &block, receivedData,
1092 COAP_OPTION_BLOCK2, dataLen);
1095 if (CA_BLOCK_RECEIVED_ALREADY != blockWiseStatus)
1097 // store the received payload and merge
1098 res = CAUpdatePayloadData(data, receivedData, blockWiseStatus,
1099 isSizeOption, COAP_OPTION_BLOCK2);
1100 if (CA_STATUS_OK != res)
1102 OIC_LOG(ERROR, TAG, "update has failed");
1107 if (0 == block.m && CA_BLOCK_UNKNOWN == blockWiseStatus) // Last block is received
1109 OIC_LOG(DEBUG, TAG, "M bit is 0");
1110 blockWiseStatus = CA_OPTION2_LAST_BLOCK;
1114 if (CA_BLOCK_UNKNOWN == blockWiseStatus ||
1115 CA_BLOCK_RECEIVED_ALREADY == blockWiseStatus)
1117 OIC_LOG(DEBUG, TAG, "M bit is 1");
1118 blockWiseStatus = CA_OPTION2_RESPONSE;
1121 res = CAUpdateBlockOptionItems(data, pdu, &block, COAP_OPTION_BLOCK2,
1123 if (CA_STATUS_OK != res)
1125 OIC_LOG(ERROR, TAG, "update has failed");
1129 res = CAUpdateBlockData(data, block, COAP_OPTION_BLOCK2);
1130 if (CA_STATUS_OK != res)
1132 OIC_LOG(ERROR, TAG, "update has failed");
1139 res = CAProcessNextStep(pdu, receivedData, blockWiseStatus, blockDataID);
1140 if (CA_STATUS_OK != res)
1142 OIC_LOG(ERROR, TAG, "setting has failed");
1146 CADestroyBlockID(blockDataID);
1147 return CA_STATUS_OK;
1150 CARemoveBlockDataFromList(blockDataID);
1151 CADestroyBlockID(blockDataID);
1155 CAResult_t CAUpdateBlockOptionItems(CABlockData_t *currData, const coap_pdu_t *pdu,
1156 coap_block_t *block, uint16_t blockType,
1159 VERIFY_NON_NULL(currData, TAG, "currData");
1160 VERIFY_NON_NULL(pdu, TAG, "pdu");
1161 VERIFY_NON_NULL(block, TAG, "block");
1163 // update block data
1164 CAResult_t res = CA_STATUS_OK;
1165 uint32_t code = CA_RESPONSE_CODE(pdu->hdr->coap_hdr_udp_t.code);
1167 if (CA_REQUEST_ENTITY_INCOMPLETE == code || CA_REQUEST_ENTITY_TOO_LARGE == code)
1169 // response error code of the received block message
1170 res = CAHandleBlockErrorResponse(block, blockType, code);
1171 if (CA_STATUS_OK != res)
1173 OIC_LOG(ERROR, TAG, "error handle has failed");
1179 // update block option items
1182 case CA_OPTION1_RESPONSE:
1183 if (currData->block1.num > block->num)
1185 OIC_LOG(ERROR, TAG, "received incorrect block num");
1186 return CA_STATUS_FAILED;
1190 case CA_OPTION2_REQUEST:
1193 case CA_OPTION2_RESPONSE:
1194 if (currData->block2.num > block->num)
1196 OIC_LOG(ERROR, TAG, "received incorrect block num");
1197 return CA_STATUS_FAILED;
1202 case CA_BLOCK_TOO_LARGE:
1203 // if state of received block message is CA_BLOCK_TOO_LARGE or CA_BLOCK_INCOMPLETE
1204 // we set the response error code appropriately and send
1205 if (COAP_OPTION_BLOCK2 == blockType)
1209 block->szx = currData->block2.szx;
1213 block->szx = currData->block1.szx;
1217 OIC_LOG_V(ERROR, TAG, "no logic [%d]", status);
1220 if (CA_BLOCK_INCOMPLETE != status && CA_BLOCK_TOO_LARGE != status)
1222 // negotiate block size
1223 res = CANegotiateBlockSize(currData, block, pdu, blockType);
1224 if (CA_STATUS_OK != res)
1226 OIC_LOG(ERROR, TAG, "negotiation has failed");
1234 CAResult_t CASetMoreBitFromBlock(size_t payloadLen, coap_block_t *block)
1236 VERIFY_NON_NULL(block, TAG, "block");
1238 if ((size_t) ((block->num + 1) << (block->szx + BLOCK_NUMBER_IDX)) < payloadLen)
1240 OIC_LOG(DEBUG, TAG, "Set the M-bit(1)");
1245 OIC_LOG(DEBUG, TAG, "Set the M-bit(0)");
1249 return CA_STATUS_OK;
1252 CAResult_t CANegotiateBlockSize(CABlockData_t *currData, coap_block_t *block,
1253 const coap_pdu_t *pdu, uint16_t blockType)
1255 OIC_LOG(DEBUG, TAG, "IN-NegotiateBlockSize");
1257 VERIFY_NON_NULL(currData, TAG, "currData");
1258 VERIFY_NON_NULL(block, TAG, "block");
1259 VERIFY_NON_NULL(pdu, TAG, "pdu");
1260 VERIFY_NON_NULL(pdu->hdr, TAG, "pdu->hdr");
1262 bool isReqMsg = false;
1263 uint32_t code = pdu->hdr->coap_hdr_udp_t.code;
1264 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
1269 // #1. check the block option type
1270 if (COAP_OPTION_BLOCK2 == blockType)
1272 // #2. check the message type
1275 if (block->szx > currData->block2.szx)
1277 OIC_LOG(DEBUG, TAG, "sze is big");
1279 // #3. calculate new block number from block size
1280 unsigned int blockNum = BLOCK_SIZE(block->szx) /
1281 BLOCK_SIZE(currData->block2.szx) - 1;
1282 OIC_LOG(DEBUG, TAG, "num is set as Negotiation");
1283 block->num += blockNum;
1284 block->szx = currData->block2.szx;
1285 OIC_LOG_V(DEBUG, TAG, "updated block num: %d", block->num);
1290 if (block->szx > currData->block2.szx)
1292 OIC_LOG(DEBUG, TAG, "sze is big");
1293 block->szx = currData->block2.szx;
1297 else if (COAP_OPTION_BLOCK1 == blockType)
1301 if (block->szx < currData->block1.szx)
1303 OIC_LOG(DEBUG, TAG, "sze is small");
1305 unsigned int blockNum = BLOCK_SIZE(currData->block1.szx) /
1306 BLOCK_SIZE(block->szx) - 1;
1307 block->num += blockNum;
1308 OIC_LOG_V(DEBUG, TAG, "updated block num: %d", block->num);
1313 if (block->szx > currData->block1.szx)
1315 OIC_LOG(DEBUG, TAG, "sze is big");
1316 block->szx = currData->block1.szx;
1322 OIC_LOG(DEBUG, TAG, "Invalid block option");
1323 return CA_STATUS_FAILED;
1326 OIC_LOG(DEBUG, TAG, "OUT-NegotiateBlockSize");
1328 return CA_STATUS_OK;
1331 CAResult_t CAUpdateBlockData(CABlockData_t *currData, coap_block_t block,
1334 VERIFY_NON_NULL(currData, TAG, "currData");
1336 // check if block size is bigger than CABlockSize_t
1337 if (block.szx > CA_BLOCK_SIZE_1024_BYTE)
1339 OIC_LOG(DEBUG, TAG, "invalid block szx");
1340 return CA_STATUS_FAILED;
1343 // update block option
1344 if (COAP_OPTION_BLOCK2 == blockType)
1346 currData->block2 = block;
1350 currData->block1 = block;
1353 OIC_LOG(DEBUG, TAG, "data has updated");
1354 return CA_STATUS_OK;
1357 CAResult_t CAUpdateMessageId(coap_pdu_t *pdu, const CABlockDataID_t *blockID)
1359 VERIFY_NON_NULL(pdu, TAG, "pdu");
1360 VERIFY_NON_NULL(pdu->hdr, TAG, "pdu->hdr");
1361 VERIFY_NON_NULL(blockID, TAG, "blockID");
1363 // if message is sent, update messageId in block-wise transfer list
1364 CAData_t * cadata = CAGetDataSetFromBlockDataList(blockID);
1367 OIC_LOG(ERROR, TAG, "CAData is unavailable");
1368 return CA_STATUS_FAILED;
1371 if (cadata->requestInfo)
1373 cadata->requestInfo->info.messageId = pdu->hdr->coap_hdr_udp_t.id;
1376 return CA_STATUS_OK;
1379 CAResult_t CAAddBlockOption(coap_pdu_t **pdu, const CAInfo_t *info,
1380 const CAEndpoint_t *endpoint, coap_list_t **options)
1382 OIC_LOG(DEBUG, TAG, "IN-AddBlockOption");
1383 VERIFY_NON_NULL(pdu, TAG, "pdu");
1384 VERIFY_NON_NULL((*pdu), TAG, "(*pdu)");
1385 VERIFY_NON_NULL((*pdu)->hdr, TAG, "(*pdu)->hdr");
1386 VERIFY_NON_NULL(info, TAG, "info");
1387 VERIFY_NON_NULL(endpoint, TAG, "endpoint");
1388 VERIFY_NON_NULL(options, TAG, "options");
1390 CAResult_t res = CA_STATUS_OK;
1391 size_t dataLength = 0;
1394 dataLength = info->payloadSize;
1395 OIC_LOG_V(DEBUG, TAG, "dataLength - %zu", dataLength);
1398 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(
1399 (CAToken_t)(*pdu)->hdr->coap_hdr_udp_t.token,
1400 (*pdu)->hdr->coap_hdr_udp_t.token_length,
1402 if (NULL == blockDataID || blockDataID->idLength < 1)
1404 OIC_LOG(ERROR, TAG, "blockId is null");
1405 res = CA_STATUS_FAILED;
1409 uint32_t repCode = CA_RESPONSE_CODE((*pdu)->hdr->coap_hdr_udp_t.code);
1410 if (CA_REQUEST_ENTITY_INCOMPLETE == repCode)
1412 OIC_LOG(INFO, TAG, "don't use option");
1417 uint8_t blockType = CAGetBlockOptionType(blockDataID);
1418 if (COAP_OPTION_BLOCK2 == blockType)
1420 res = CAAddBlockOption2(pdu, info, dataLength, blockDataID, options);
1421 if (CA_STATUS_OK != res)
1423 OIC_LOG(ERROR, TAG, "add has failed");
1427 else if (COAP_OPTION_BLOCK1 == blockType)
1429 res = CAAddBlockOption1(pdu, info, dataLength, blockDataID, options);
1430 if (CA_STATUS_OK != res)
1432 OIC_LOG(ERROR, TAG, "add has failed");
1438 OIC_LOG(DEBUG, TAG, "no BLOCK option");
1440 // in case it is not large data, add option list to pdu.
1443 for (coap_list_t *opt = *options; opt; opt = opt->next)
1445 OIC_LOG_V(DEBUG, TAG, "[%s] opt will be added.",
1446 COAP_OPTION_DATA(*(coap_option *) opt->data));
1448 OIC_LOG_V(DEBUG, TAG, "[%d] pdu length", (*pdu)->length);
1449 coap_add_option(*pdu, COAP_OPTION_KEY(*(coap_option *) opt->data),
1450 COAP_OPTION_LENGTH(*(coap_option *) opt->data),
1451 COAP_OPTION_DATA(*(coap_option *) opt->data), coap_udp);
1455 OIC_LOG_V(DEBUG, TAG, "[%d] pdu length after option", (*pdu)->length);
1457 // if response data is so large. it have to send as block transfer
1458 if (!coap_add_data(*pdu, dataLength, (const unsigned char *) info->payload))
1460 OIC_LOG(INFO, TAG, "it have to use block");
1461 res = CA_STATUS_FAILED;
1466 OIC_LOG(INFO, TAG, "not Blockwise Transfer");
1470 uint32_t code = (*pdu)->hdr->coap_hdr_udp_t.code;
1471 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
1473 // if received message type is RESET from remote device,
1474 // we have to use the updated message id of request message to find token.
1475 CABlockData_t *blockData = CAGetBlockDataFromBlockDataList(blockDataID);
1478 res = CAUpdateMessageId(*pdu, blockDataID);
1479 if (CA_STATUS_OK != res)
1481 OIC_LOG(ERROR, TAG, "fail to update message id");
1488 CADestroyBlockID(blockDataID);
1489 OIC_LOG(DEBUG, TAG, "OUT-AddBlockOption");
1493 CAResult_t CAAddBlockOption2(coap_pdu_t **pdu, const CAInfo_t *info, size_t dataLength,
1494 const CABlockDataID_t *blockID, coap_list_t **options)
1496 OIC_LOG(DEBUG, TAG, "IN-AddBlockOption2");
1497 VERIFY_NON_NULL(pdu, TAG, "pdu");
1498 VERIFY_NON_NULL((*pdu), TAG, "(*pdu)");
1499 VERIFY_NON_NULL((*pdu)->hdr, TAG, "(*pdu)->hdr");
1500 VERIFY_NON_NULL(info, TAG, "info");
1501 VERIFY_NON_NULL(blockID, TAG, "blockID");
1502 VERIFY_NON_NULL(options, TAG, "options");
1504 // get set block data from CABlock list-set.
1505 coap_block_t *block1 = CAGetBlockOption(blockID, COAP_OPTION_BLOCK1);
1506 coap_block_t *block2 = CAGetBlockOption(blockID, COAP_OPTION_BLOCK2);
1507 if (!block1 || !block2)
1509 OIC_LOG(ERROR, TAG, "getting has failed");
1510 return CA_STATUS_FAILED;
1513 CAResult_t res = CA_STATUS_OK;
1514 uint32_t code = (*pdu)->hdr->coap_hdr_udp_t.code;
1515 if (CA_GET != code && CA_POST != code && CA_PUT != code && CA_DELETE != code)
1517 CASetMoreBitFromBlock(dataLength, block2);
1519 // if block number is 0, add size2 option
1520 if (0 == block2->num)
1522 res = CAAddBlockSizeOption(*pdu, COAP_OPTION_SIZE2, dataLength, options);
1523 if (CA_STATUS_OK != res)
1525 OIC_LOG(ERROR, TAG, "add has failed");
1530 res = CAAddBlockOptionImpl(block2, COAP_OPTION_BLOCK2, options);
1531 if (CA_STATUS_OK != res)
1533 OIC_LOG(ERROR, TAG, "add has failed");
1539 OIC_LOG(DEBUG, TAG, "combining block1 and block2");
1540 res = CAAddBlockOptionImpl(block1, COAP_OPTION_BLOCK1, options);
1541 if (CA_STATUS_OK != res)
1543 OIC_LOG(ERROR, TAG, "add has failed");
1546 // initialize block number
1550 res = CAAddOptionToPDU(*pdu, options);
1551 if (CA_STATUS_OK != res)
1553 OIC_LOG(ERROR, TAG, "add has failed");
1557 if (!coap_add_block(*pdu, dataLength, (const unsigned char *) info->payload,
1558 block2->num, block2->szx))
1560 OIC_LOG(ERROR, TAG, "Data length is smaller than the start index");
1561 return CA_STATUS_FAILED;
1564 CALogBlockInfo(block2);
1568 // if sent message is last response block message, remove data
1569 CARemoveBlockDataFromList(blockID);
1574 OIC_LOG(DEBUG, TAG, "option2, not response msg");
1575 res = CAAddBlockOptionImpl(block2, COAP_OPTION_BLOCK2, options);
1576 if (CA_STATUS_OK != res)
1578 OIC_LOG(ERROR, TAG, "add has failed");
1582 res = CAAddOptionToPDU(*pdu, options);
1583 if (CA_STATUS_OK != res)
1585 OIC_LOG(ERROR, TAG, "add has failed");
1588 CALogBlockInfo(block2);
1591 return CA_STATUS_OK;
1594 CARemoveBlockDataFromList(blockID);
1598 CAResult_t CAAddBlockOption1(coap_pdu_t **pdu, const CAInfo_t *info, size_t dataLength,
1599 const CABlockDataID_t *blockID, coap_list_t **options)
1601 OIC_LOG(DEBUG, TAG, "IN-AddBlockOption1");
1602 VERIFY_NON_NULL(pdu, TAG, "pdu");
1603 VERIFY_NON_NULL((*pdu), TAG, "(*pdu)");
1604 VERIFY_NON_NULL((*pdu)->hdr, TAG, "(*pdu)->hdr");
1605 VERIFY_NON_NULL(info, TAG, "info");
1606 VERIFY_NON_NULL(blockID, TAG, "blockID");
1607 VERIFY_NON_NULL(options, TAG, "options");
1609 // get set block data from CABlock list-set.
1610 coap_block_t *block1 = CAGetBlockOption(blockID, COAP_OPTION_BLOCK1);
1613 OIC_LOG(ERROR, TAG, "getting has failed");
1614 return CA_STATUS_FAILED;
1617 CAResult_t res = CA_STATUS_OK;
1618 uint32_t code = (*pdu)->hdr->coap_hdr_udp_t.code;
1619 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
1621 CASetMoreBitFromBlock(dataLength, block1);
1623 // if block number is 0, add size1 option
1624 if (0 == block1->num)
1626 res = CAAddBlockSizeOption(*pdu, COAP_OPTION_SIZE1, dataLength, options);
1627 if (CA_STATUS_OK != res)
1629 OIC_LOG(ERROR, TAG, "add has failed");
1634 // add block option to option list.
1635 res = CAAddBlockOptionImpl(block1, COAP_OPTION_BLOCK1, options);
1636 if (CA_STATUS_OK != res)
1638 OIC_LOG(ERROR, TAG, "add has failed");
1642 // add option list to pdu.
1643 res = CAAddOptionToPDU(*pdu, options);
1644 if (CA_STATUS_OK != res)
1646 OIC_LOG(ERROR, TAG, "add has failed");
1650 // add the payload data as the block size.
1651 if (!coap_add_block(*pdu, dataLength, (const unsigned char *) info->payload, block1->num,
1654 OIC_LOG(ERROR, TAG, "Data length is smaller than the start index");
1655 return CA_STATUS_FAILED;
1660 OIC_LOG(DEBUG, TAG, "received response message with block option1");
1662 // add block option to option list.
1663 res = CAAddBlockOptionImpl(block1, COAP_OPTION_BLOCK1, options);
1664 if (CA_STATUS_OK != res)
1666 OIC_LOG(ERROR, TAG, "add has failed");
1670 // add option list to pdu.
1671 res = CAAddOptionToPDU(*pdu, options);
1672 if (CA_STATUS_OK != res)
1674 OIC_LOG(ERROR, TAG, "add has failed");
1678 // add the payload data as the block size.
1679 if (!coap_add_data(*pdu, dataLength, (const unsigned char *) info->payload))
1681 OIC_LOG(ERROR, TAG, "failed to add payload");
1682 return CA_STATUS_FAILED;
1685 // if it is last block message, remove block data from list.
1688 // remove data from list
1689 res = CARemoveBlockDataFromList(blockID);
1690 if (CA_STATUS_OK != res)
1692 OIC_LOG(ERROR, TAG, "remove has failed");
1698 CALogBlockInfo(block1);
1700 OIC_LOG(DEBUG, TAG, "OUT-AddBlockOption1");
1702 return CA_STATUS_OK;
1705 CARemoveBlockDataFromList(blockID);
1709 CAResult_t CAAddBlockOptionImpl(coap_block_t *block, uint8_t blockType,
1710 coap_list_t **options)
1712 OIC_LOG(DEBUG, TAG, "IN-AddBlockOptionImpl");
1713 VERIFY_NON_NULL(block, TAG, "block");
1714 VERIFY_NON_NULL(options, TAG, "options");
1716 unsigned char buf[BLOCKWISE_OPTION_BUFFER] = { 0 };
1717 unsigned int optionLength = coap_encode_var_bytes(buf,
1718 ((block->num << BLOCK_NUMBER_IDX)
1719 | (block->m << BLOCK_M_BIT_IDX)
1722 int ret = coap_insert(options,
1723 CACreateNewOptionNode(blockType, optionLength, (char *) buf),
1727 return CA_STATUS_INVALID_PARAM;
1730 OIC_LOG(DEBUG, TAG, "OUT-AddBlockOptionImpl");
1731 return CA_STATUS_OK;
1734 CAResult_t CAAddOptionToPDU(coap_pdu_t *pdu, coap_list_t **options)
1736 // after adding the block option to option list, add option list to pdu.
1739 for (coap_list_t *opt = *options; opt; opt = opt->next)
1741 OIC_LOG_V(DEBUG, TAG, "[%s] opt will be added.",
1742 COAP_OPTION_DATA(*(coap_option *) opt->data));
1744 OIC_LOG_V(DEBUG, TAG, "[%d] pdu length", pdu->length);
1745 int ret = coap_add_option(pdu, COAP_OPTION_KEY(*(coap_option *) opt->data),
1746 COAP_OPTION_LENGTH(*(coap_option *) opt->data),
1747 COAP_OPTION_DATA(*(coap_option *) opt->data), coap_udp);
1750 return CA_STATUS_FAILED;
1755 OIC_LOG_V(DEBUG, TAG, "[%d] pdu length after option", pdu->length);
1757 return CA_STATUS_OK;
1760 CAResult_t CAAddBlockSizeOption(coap_pdu_t *pdu, uint16_t sizeType, size_t dataLength,
1761 coap_list_t **options)
1763 OIC_LOG(DEBUG, TAG, "IN-CAAddBlockSizeOption");
1764 VERIFY_NON_NULL(pdu, TAG, "pdu");
1765 VERIFY_NON_NULL(options, TAG, "options");
1767 if (sizeType != COAP_OPTION_SIZE1 && sizeType != COAP_OPTION_SIZE2)
1769 OIC_LOG(ERROR, TAG, "unknown option type");
1770 return CA_STATUS_FAILED;
1773 unsigned char value[BLOCKWISE_OPTION_BUFFER] = { 0 };
1774 unsigned int optionLength = coap_encode_var_bytes(value, dataLength);
1776 int ret = coap_insert(options,
1777 CACreateNewOptionNode(sizeType, optionLength, (char *) value),
1781 return CA_STATUS_INVALID_PARAM;
1784 OIC_LOG(DEBUG, TAG, "OUT-CAAddBlockSizeOption");
1786 return CA_STATUS_OK;
1789 // TODO make pdu const after libcoap is updated to support that.
1790 bool CAIsPayloadLengthInPduWithBlockSizeOption(coap_pdu_t *pdu,
1792 size_t *totalPayloadLen)
1794 OIC_LOG(DEBUG, TAG, "IN-CAIsPayloadLengthInPduWithBlockSizeOption");
1795 VERIFY_NON_NULL(pdu, TAG, "pdu");
1796 VERIFY_NON_NULL(totalPayloadLen, TAG, "totalPayloadLen");
1798 if (sizeType != COAP_OPTION_SIZE1 && sizeType != COAP_OPTION_SIZE2)
1800 OIC_LOG(ERROR, TAG, "unknown option type");
1801 return CA_STATUS_FAILED;
1804 coap_opt_iterator_t opt_iter;
1805 coap_opt_t *option = coap_check_option(pdu, sizeType, &opt_iter);
1808 OIC_LOG(DEBUG, TAG, "get size option from pdu");
1809 *totalPayloadLen = coap_decode_var_bytes(COAP_OPT_VALUE(option),
1810 COAP_OPT_LENGTH(option));
1812 OIC_LOG_V(DEBUG, TAG, "the total payload length to be received is [%zu]bytes",
1818 OIC_LOG(DEBUG, TAG, "OUT-CAIsPayloadLengthInPduWithBlockSizeOption");
1823 uint8_t CACheckBlockErrorType(CABlockData_t *currData, coap_block_t *receivedBlock,
1824 const CAData_t *receivedData, uint16_t blockType,
1827 OIC_LOG(DEBUG, TAG, "IN-CheckBlockError");
1829 VERIFY_NON_NULL(currData, TAG, "currData is NULL");
1830 VERIFY_NON_NULL(receivedBlock, TAG, "receivedBlock is NULL");
1831 VERIFY_NON_NULL(receivedData, TAG, "receivedData is NULL");
1833 // #1. check the received payload length
1834 size_t blockPayloadLen = 0;
1835 CAGetPayloadInfo(receivedData, &blockPayloadLen);
1837 // #2. check if the block sequence is right
1838 if (COAP_OPTION_BLOCK1 == blockType)
1840 size_t prePayloadLen = currData->receivedPayloadLen;
1841 if (prePayloadLen != (size_t) BLOCK_SIZE(receivedBlock->szx) * receivedBlock->num)
1843 if (receivedBlock->num > currData->block1.num + 1)
1845 // 408 Error handling of block loss
1846 OIC_LOG(ERROR, TAG, "option1: error 4.08");
1847 OIC_LOG(ERROR, TAG, "it didn't order");
1848 return CA_BLOCK_INCOMPLETE;
1850 return CA_BLOCK_RECEIVED_ALREADY;
1853 else if (COAP_OPTION_BLOCK2 == blockType)
1855 if (receivedBlock->num != currData->block2.num)
1857 if (receivedBlock->num > currData->block2.num)
1859 // 408 Error handling of block loss
1860 OIC_LOG(ERROR, TAG, "option2: error 4.08");
1861 OIC_LOG(ERROR, TAG, "it didn't order");
1862 return CA_BLOCK_INCOMPLETE;
1864 return CA_BLOCK_RECEIVED_ALREADY;
1868 // #3. check if error check logic is required
1869 size_t optionLen = dataLen - blockPayloadLen;
1870 if (receivedBlock->m && blockPayloadLen != (size_t) BLOCK_SIZE(receivedBlock->szx))
1872 // 413 Error handling of too large entity
1873 if (COAP_MAX_PDU_SIZE < BLOCK_SIZE(receivedBlock->szx) + optionLen)
1875 // buffer size is smaller than received block size
1876 OIC_LOG(ERROR, TAG, "error type 4.13");
1877 OIC_LOG(ERROR, TAG, "too large size");
1879 // set the block size to be smaller than COAP_MAX_PDU_SIZE
1880 for (int32_t size = CA_DEFAULT_BLOCK_SIZE; size >= 0; size--)
1882 if (COAP_MAX_PDU_SIZE >= BLOCK_SIZE(size) + optionLen)
1884 OIC_LOG_V(ERROR, TAG, "replace sze with %d", size);
1885 currData->block2.szx = size;
1886 currData->block1.szx = size;
1890 return CA_BLOCK_TOO_LARGE;
1894 // 408 Error handling of payload loss
1895 OIC_LOG(ERROR, TAG, "error type 4.08");
1896 OIC_LOG(ERROR, TAG, "payload len != block sze");
1897 return CA_BLOCK_INCOMPLETE;
1900 else if (0 == receivedBlock->m && 0 != currData->payloadLength)
1902 // if the received block is last block, check the total payload length
1903 size_t receivedPayloadLen = currData->receivedPayloadLen;
1904 receivedPayloadLen += blockPayloadLen;
1906 if (receivedPayloadLen != currData->payloadLength)
1908 OIC_LOG(ERROR, TAG, "error type 4.08");
1909 OIC_LOG(ERROR, TAG, "total payload length is wrong");
1910 return CA_BLOCK_INCOMPLETE;
1914 OIC_LOG(DEBUG, TAG, "received all data normally");
1916 OIC_LOG(DEBUG, TAG, "OUT-CheckBlockError");
1918 return CA_BLOCK_UNKNOWN;
1921 CAResult_t CAUpdatePayloadData(CABlockData_t *currData, const CAData_t *receivedData,
1922 uint8_t status, bool isSizeOption, uint16_t blockType)
1924 OIC_LOG(DEBUG, TAG, "IN-UpdatePayloadData");
1926 VERIFY_NON_NULL(currData, TAG, "currData");
1927 VERIFY_NON_NULL(receivedData, TAG, "receivedData");
1929 // if error code is 4.08, do not update payload
1930 if (CA_BLOCK_INCOMPLETE == status)
1932 OIC_LOG(ERROR, TAG, "no require to update");
1933 return CA_STATUS_OK;
1936 size_t blockPayloadLen = 0;
1937 CAPayload_t blockPayload = CAGetPayloadInfo(receivedData, &blockPayloadLen);
1939 if (CA_BLOCK_TOO_LARGE == status)
1941 blockPayloadLen = (COAP_OPTION_BLOCK2 == blockType) ?
1942 BLOCK_SIZE(currData->block2.szx) : BLOCK_SIZE(currData->block1.szx);
1945 // memory allocation for the received block payload
1946 size_t prePayloadLen = currData->receivedPayloadLen;
1949 if (currData->payloadLength)
1951 // in case the block message has the size option
1952 // allocate the memory for the total payload
1955 CAPayload_t prePayload = currData->payload;
1957 OIC_LOG(DEBUG, TAG, "allocate memory for the total payload");
1958 currData->payload = (CAPayload_t) OICCalloc(1, currData->payloadLength);
1959 if (NULL == currData->payload)
1961 OIC_LOG(ERROR, TAG, "out of memory");
1962 return CA_MEMORY_ALLOC_FAILED;
1964 memcpy(currData->payload, prePayload, prePayloadLen);
1965 OICFree(prePayload);
1968 // update the total payload
1969 memcpy(currData->payload + prePayloadLen, blockPayload, blockPayloadLen);
1973 OIC_LOG(DEBUG, TAG, "allocate memory for the received block payload");
1975 size_t totalPayloadLen = prePayloadLen + blockPayloadLen;
1976 CAPayload_t newPayload = OICRealloc(currData->payload, totalPayloadLen);
1977 if (NULL == newPayload)
1979 OIC_LOG(ERROR, TAG, "out of memory");
1980 return CA_MEMORY_ALLOC_FAILED;
1983 // update the total payload
1984 memset(newPayload + prePayloadLen, 0, blockPayloadLen);
1985 currData->payload = newPayload;
1986 memcpy(currData->payload + prePayloadLen, blockPayload, blockPayloadLen);
1989 // update received payload length
1990 currData->receivedPayloadLen += blockPayloadLen;
1992 OIC_LOG_V(DEBUG, TAG, "updated payload: %s, len: %zu", currData->payload,
1993 currData->receivedPayloadLen);
1996 OIC_LOG(DEBUG, TAG, "OUT-UpdatePayloadData");
1997 return CA_STATUS_OK;
2000 CAData_t* CACreateNewDataSet(const coap_pdu_t *pdu, const CAEndpoint_t *endpoint)
2002 VERIFY_NON_NULL_RET(pdu, TAG, "pdu", NULL);
2003 VERIFY_NON_NULL_RET(pdu->hdr, TAG, "pdu->hdr", NULL);
2004 VERIFY_NON_NULL_RET(endpoint, TAG, "endpoint", NULL);
2006 CARequestInfo_t* requestInfo = NULL;
2007 CAResponseInfo_t* responseInfo = NULL;
2009 uint32_t code = pdu->hdr->coap_hdr_udp_t.code;
2010 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
2012 CAInfo_t responseData = { .tokenLength = pdu->hdr->coap_hdr_udp_t.token_length };
2013 responseData.token = (CAToken_t) OICMalloc(responseData.tokenLength);
2014 if (!responseData.token)
2016 OIC_LOG(ERROR, TAG, "out of memory");
2019 memcpy(responseData.token, pdu->hdr->coap_hdr_udp_t.token, responseData.tokenLength);
2021 responseInfo = (CAResponseInfo_t*) OICCalloc(1, sizeof(CAResponseInfo_t));
2024 OIC_LOG(ERROR, TAG, "out of memory");
2025 OICFree(responseData.token);
2028 responseInfo->info = responseData;
2032 CAInfo_t requestData = { .tokenLength = pdu->hdr->coap_hdr_udp_t.token_length };
2033 requestData.token = (CAToken_t) OICMalloc(requestData.tokenLength);
2034 if (!requestData.token)
2036 OIC_LOG(ERROR, TAG, "out of memory");
2039 memcpy(requestData.token, pdu->hdr->coap_hdr_udp_t.token, requestData.tokenLength);
2041 requestInfo = (CARequestInfo_t*) OICCalloc(1, sizeof(CARequestInfo_t));
2044 OIC_LOG(ERROR, TAG, "out of memory");
2045 OICFree(requestData.token);
2048 requestInfo->info = requestData;
2050 // get resource uri information from received response message
2051 // to send next request message to remote device
2052 CAResponseInfo_t* resInfo = (CAResponseInfo_t*)OICCalloc(1, sizeof(*resInfo));
2055 OIC_LOG(ERROR, TAG, "memory allocation failed");
2056 OICFree(requestData.token);
2060 CAGetResponseInfoFromPDU(pdu, resInfo, endpoint);
2061 requestInfo->method = CA_GET;
2062 requestInfo->info.messageId = CAGetMessageIdFromPduBinaryData(pdu->hdr, pdu->length);
2063 requestInfo->info.resourceUri = OICStrdup(resInfo->info.resourceUri);
2065 // after copying the resource uri, destroy response info.
2066 CADestroyResponseInfoInternal(resInfo);
2069 CAData_t *data = (CAData_t *) OICCalloc(1, sizeof(CAData_t));
2072 OIC_LOG(ERROR, TAG, "out of memory");
2073 OICFree(requestInfo);
2074 OICFree(responseInfo);
2078 data->requestInfo = requestInfo;
2079 data->responseInfo = responseInfo;
2080 data->remoteEndpoint = CACloneEndpoint(endpoint);
2081 data->type = SEND_TYPE_UNICAST;
2086 CAData_t *CACloneCAData(const CAData_t *data)
2088 VERIFY_NON_NULL_RET(data, TAG, "data", NULL);
2090 CAData_t *clone = (CAData_t *) OICCalloc(1, sizeof(CAData_t));
2093 OIC_LOG(ERROR, TAG, "out of memory");
2098 if (data->requestInfo)
2100 clone->requestInfo = CACloneRequestInfo(data->requestInfo);
2102 else if (data->responseInfo)
2104 clone->responseInfo = CACloneResponseInfo(data->responseInfo);
2107 if (data->remoteEndpoint)
2109 clone->remoteEndpoint = CACloneEndpoint(data->remoteEndpoint);
2115 CAResult_t CAUpdatePayloadToCAData(CAData_t *data, const CAPayload_t payload,
2118 OIC_LOG(DEBUG, TAG, "IN-UpdatePayload");
2120 VERIFY_NON_NULL(data, TAG, "data is NULL");
2121 VERIFY_NON_NULL(payload, TAG, "payload is NULL");
2123 CAPayload_t newPayload = NULL;
2124 switch (data->dataType)
2126 case CA_REQUEST_DATA:
2127 if (!data->requestInfo)
2129 OIC_LOG(ERROR, TAG, "request info is null");
2130 return CA_STATUS_FAILED;
2132 // allocate payload field
2133 newPayload = OICRealloc(data->requestInfo->info.payload, payloadLen);
2136 OIC_LOG(ERROR, TAG, "out of memory");
2137 return CA_STATUS_FAILED;
2139 data->requestInfo->info.payload = newPayload;
2140 memcpy(data->requestInfo->info.payload, payload, payloadLen);
2141 data->requestInfo->info.payloadSize = payloadLen;
2144 case CA_RESPONSE_DATA:
2145 if (!data->responseInfo)
2147 OIC_LOG(ERROR, TAG, "response info is null");
2148 return CA_STATUS_FAILED;
2150 // allocate payload field
2151 newPayload = OICRealloc(data->responseInfo->info.payload, payloadLen);
2154 OIC_LOG(ERROR, TAG, "out of memory");
2155 return CA_STATUS_FAILED;
2157 data->responseInfo->info.payload = newPayload;
2158 memcpy(data->responseInfo->info.payload, payload, payloadLen);
2159 data->responseInfo->info.payloadSize = payloadLen;
2163 // does not occur case
2164 OIC_LOG(ERROR, TAG, "not supported data type");
2165 return CA_NOT_SUPPORTED;
2168 OIC_LOG(DEBUG, TAG, "OUT-UpdatePayload");
2170 return CA_STATUS_OK;
2173 CAPayload_t CAGetPayloadInfo(const CAData_t *data, size_t *payloadLen)
2175 VERIFY_NON_NULL_RET(data, TAG, "data", NULL);
2176 VERIFY_NON_NULL_RET(payloadLen, TAG, "payloadLen", NULL);
2178 if (data->requestInfo)
2180 if (data->requestInfo->info.payload)
2182 *payloadLen = data->requestInfo->info.payloadSize;
2183 return data->requestInfo->info.payload;
2188 if (data->responseInfo->info.payload)
2190 *payloadLen = data->responseInfo->info.payloadSize;
2191 return data->responseInfo->info.payload;
2198 CAResult_t CAHandleBlockErrorResponse(coap_block_t *block, uint16_t blockType,
2199 uint32_t responseResult)
2201 OIC_LOG(DEBUG, TAG, "IN-HandleBlockErrorRes");
2202 VERIFY_NON_NULL(block, TAG, "block is NULL");
2204 // update block data
2205 switch (responseResult)
2207 case CA_REQUEST_ENTITY_INCOMPLETE:
2210 case CA_REQUEST_ENTITY_TOO_LARGE:
2211 if (COAP_OPTION_BLOCK1 == blockType)
2218 OIC_LOG_V(ERROR, TAG, "there is no Error Code of BWT[%d]", responseResult);
2219 return CA_STATUS_FAILED;
2222 OIC_LOG(DEBUG, TAG, "OUT-HandleBlockErrorRes");
2223 return CA_STATUS_OK;
2226 CAResult_t CAUpdateBlockOptionType(const CABlockDataID_t *blockID, uint8_t blockType)
2228 OIC_LOG(DEBUG, TAG, "IN-UpdateBlockOptionType");
2229 VERIFY_NON_NULL(blockID, TAG, "blockID");
2231 ca_mutex_lock(g_context.blockDataListMutex);
2233 size_t len = u_arraylist_length(g_context.dataList);
2234 for (size_t i = 0; i < len; i++)
2236 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2237 if (CABlockidMatches(currData, blockID))
2239 currData->type = blockType;
2240 ca_mutex_unlock(g_context.blockDataListMutex);
2241 OIC_LOG(DEBUG, TAG, "OUT-UpdateBlockOptionType");
2242 return CA_STATUS_OK;
2245 ca_mutex_unlock(g_context.blockDataListMutex);
2247 OIC_LOG(DEBUG, TAG, "OUT-UpdateBlockOptionType");
2248 return CA_STATUS_FAILED;
2251 uint8_t CAGetBlockOptionType(const CABlockDataID_t *blockID)
2253 OIC_LOG(DEBUG, TAG, "IN-GetBlockOptionType");
2254 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", 0);
2256 ca_mutex_lock(g_context.blockDataListMutex);
2258 size_t len = u_arraylist_length(g_context.dataList);
2259 for (size_t i = 0; i < len; i++)
2261 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2262 if (CABlockidMatches(currData, blockID))
2264 ca_mutex_unlock(g_context.blockDataListMutex);
2265 OIC_LOG(DEBUG, TAG, "OUT-GetBlockOptionType");
2266 return currData->type;
2269 ca_mutex_unlock(g_context.blockDataListMutex);
2271 OIC_LOG(DEBUG, TAG, "OUT-GetBlockOptionType");
2275 CAData_t *CAGetDataSetFromBlockDataList(const CABlockDataID_t *blockID)
2277 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", NULL);
2279 ca_mutex_lock(g_context.blockDataListMutex);
2281 size_t len = u_arraylist_length(g_context.dataList);
2282 for (size_t i = 0; i < len; i++)
2284 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2285 if (CABlockidMatches(currData, blockID))
2287 ca_mutex_unlock(g_context.blockDataListMutex);
2288 return currData->sentData;
2291 ca_mutex_unlock(g_context.blockDataListMutex);
2296 CAResult_t CAGetTokenFromBlockDataList(const coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
2297 CAResponseInfo_t *responseInfo)
2299 OIC_LOG(DEBUG, TAG, "IN-CAGetTokenFromBlockDataList");
2300 VERIFY_NON_NULL(pdu, TAG, "pdu");
2301 VERIFY_NON_NULL(endpoint, TAG, "endpoint");
2302 VERIFY_NON_NULL(responseInfo, TAG, "responseInfo");
2304 ca_mutex_lock(g_context.blockDataListMutex);
2306 size_t len = u_arraylist_length(g_context.dataList);
2307 for (size_t i = 0; i < len; i++)
2309 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2310 if (NULL == currData)
2315 if (NULL != currData->sentData && NULL != currData->sentData->requestInfo)
2317 if (pdu->hdr->coap_hdr_udp_t.id == currData->sentData->requestInfo->info.messageId &&
2318 endpoint->adapter == currData->sentData->remoteEndpoint->adapter)
2320 if (NULL != currData->sentData->requestInfo->info.token)
2322 uint8_t length = currData->sentData->requestInfo->info.tokenLength;
2323 responseInfo->info.tokenLength = length;
2324 responseInfo->info.token = (char *) OICMalloc(length);
2325 if (NULL == responseInfo->info.token)
2327 OIC_LOG(ERROR, TAG, "out of memory");
2328 ca_mutex_unlock(g_context.blockDataListMutex);
2329 return CA_MEMORY_ALLOC_FAILED;
2331 memcpy(responseInfo->info.token, currData->sentData->requestInfo->info.token,
2332 responseInfo->info.tokenLength);
2334 ca_mutex_unlock(g_context.blockDataListMutex);
2335 OIC_LOG(DEBUG, TAG, "OUT-CAGetTokenFromBlockDataList");
2336 return CA_STATUS_OK;
2342 ca_mutex_unlock(g_context.blockDataListMutex);
2344 OIC_LOG(DEBUG, TAG, "OUT-CAGetTokenFromBlockDataList");
2345 return CA_STATUS_FAILED;
2348 CAResult_t CACheckBlockDataValidation(const CAData_t *sendData, CABlockData_t **blockData)
2350 VERIFY_NON_NULL(sendData, TAG, "sendData");
2351 VERIFY_NON_NULL(blockData, TAG, "blockData");
2353 if (sendData->responseInfo)
2355 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(
2356 (CAToken_t)sendData->responseInfo->info.token,
2357 sendData->responseInfo->info.tokenLength,
2358 sendData->remoteEndpoint->port);
2359 if (NULL == blockDataID || blockDataID->idLength < 1)
2361 OIC_LOG(ERROR, TAG, "blockId is null");
2362 CADestroyBlockID(blockDataID);
2363 return CA_STATUS_FAILED;
2366 CABlockData_t *storedData = CAGetBlockDataFromBlockDataList(blockDataID);
2369 OIC_LOG(DEBUG, TAG, "Send response about the received block request.");
2370 if (storedData->sentData)
2372 OIC_LOG(DEBUG, TAG, "init block number");
2373 CADestroyDataSet(storedData->sentData);
2375 storedData->sentData = CACloneCAData(sendData);
2376 *blockData = storedData;
2377 CADestroyBlockID(blockDataID);
2378 return CA_STATUS_OK;
2380 CADestroyBlockID(blockDataID);
2383 return CA_STATUS_FAILED;
2386 CABlockData_t *CAGetBlockDataFromBlockDataList(const CABlockDataID_t *blockID)
2388 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", NULL);
2390 ca_mutex_lock(g_context.blockDataListMutex);
2392 size_t len = u_arraylist_length(g_context.dataList);
2393 for (size_t i = 0; i < len; i++)
2395 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2396 if (CABlockidMatches(currData, blockID))
2398 ca_mutex_unlock(g_context.blockDataListMutex);
2402 ca_mutex_unlock(g_context.blockDataListMutex);
2407 coap_block_t *CAGetBlockOption(const CABlockDataID_t *blockID, uint16_t blockType)
2409 OIC_LOG(DEBUG, TAG, "IN-GetBlockOption");
2410 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", NULL);
2412 ca_mutex_lock(g_context.blockDataListMutex);
2414 size_t len = u_arraylist_length(g_context.dataList);
2415 for (size_t i = 0; i < len; i++)
2417 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2418 if (CABlockidMatches(currData, blockID))
2420 ca_mutex_unlock(g_context.blockDataListMutex);
2421 OIC_LOG(DEBUG, TAG, "OUT-GetBlockOption");
2422 if (COAP_OPTION_BLOCK2 == blockType)
2424 return &currData->block2;
2426 else if (COAP_OPTION_BLOCK1 == blockType)
2428 return &currData->block1;
2432 ca_mutex_unlock(g_context.blockDataListMutex);
2434 OIC_LOG(DEBUG, TAG, "OUT-GetBlockOption");
2438 CAPayload_t CAGetPayloadFromBlockDataList(const CABlockDataID_t *blockID,
2439 size_t *fullPayloadLen)
2441 OIC_LOG(DEBUG, TAG, "IN-GetFullPayload");
2442 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", NULL);
2443 VERIFY_NON_NULL_RET(fullPayloadLen, TAG, "fullPayloadLen", NULL);
2445 ca_mutex_lock(g_context.blockDataListMutex);
2447 size_t len = u_arraylist_length(g_context.dataList);
2448 for (size_t i = 0; i < len; i++)
2450 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2451 if (CABlockidMatches(currData, blockID))
2453 ca_mutex_unlock(g_context.blockDataListMutex);
2454 *fullPayloadLen = currData->receivedPayloadLen;
2455 OIC_LOG(DEBUG, TAG, "OUT-GetFullPayload");
2456 return currData->payload;
2459 ca_mutex_unlock(g_context.blockDataListMutex);
2461 OIC_LOG(DEBUG, TAG, "OUT-GetFullPayload");
2465 CABlockData_t *CACreateNewBlockData(const CAData_t *sendData)
2467 OIC_LOG(DEBUG, TAG, "IN-CACreateNewBlockData");
2468 VERIFY_NON_NULL_RET(sendData, TAG, "sendData", NULL);
2470 // create block data
2471 CABlockData_t *data = (CABlockData_t *) OICCalloc(1, sizeof(CABlockData_t));
2474 OIC_LOG(ERROR, TAG, "memory alloc has failed");
2478 data->block1.szx = CA_DEFAULT_BLOCK_SIZE;
2479 data->block2.szx = CA_DEFAULT_BLOCK_SIZE;
2480 data->sentData = CACloneCAData(sendData);
2481 if (!data->sentData)
2483 OIC_LOG(ERROR, TAG, PCF("memory alloc has failed"));
2488 CAToken_t token = NULL;
2489 uint8_t tokenLength = 0;
2490 if (data->sentData->requestInfo)
2492 // update token info
2493 tokenLength = data->sentData->requestInfo->info.tokenLength;
2494 token = data->sentData->requestInfo->info.token;
2496 else if (data->sentData->responseInfo)
2498 tokenLength = data->sentData->responseInfo->info.tokenLength;
2499 token = data->sentData->responseInfo->info.token;
2502 if (!data->sentData->remoteEndpoint)
2504 OIC_LOG(ERROR, TAG, "remoteEndpoint is null");
2505 CADestroyDataSet(data->sentData);
2510 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(token, tokenLength,
2511 data->sentData->remoteEndpoint->port);
2512 if (NULL == blockDataID || blockDataID->idLength < 1)
2514 OIC_LOG(ERROR, TAG, "blockId is null");
2515 CADestroyBlockID(blockDataID);
2516 CADestroyDataSet(data->sentData);
2520 data->blockDataId = blockDataID;
2522 ca_mutex_lock(g_context.blockDataListMutex);
2524 bool res = u_arraylist_add(g_context.dataList, (void *) data);
2527 OIC_LOG(ERROR, TAG, "add has failed");
2528 CADestroyBlockID(data->blockDataId);
2529 CADestroyDataSet(data->sentData);
2531 ca_mutex_unlock(g_context.blockDataListMutex);
2534 ca_mutex_unlock(g_context.blockDataListMutex);
2536 OIC_LOG(DEBUG, TAG, "OUT-CreateBlockData");
2540 CAResult_t CARemoveBlockDataFromList(const CABlockDataID_t *blockID)
2542 OIC_LOG(DEBUG, TAG, "CARemoveBlockData");
2543 VERIFY_NON_NULL(blockID, TAG, "blockID");
2545 ca_mutex_lock(g_context.blockDataListMutex);
2547 size_t len = u_arraylist_length(g_context.dataList);
2548 for (size_t i = 0; i < len; i++)
2550 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2551 if (CABlockidMatches(currData, blockID))
2553 CABlockData_t *removedData = u_arraylist_remove(g_context.dataList, i);
2556 OIC_LOG(ERROR, TAG, "data is NULL");
2557 ca_mutex_unlock(g_context.blockDataListMutex);
2558 return CA_STATUS_FAILED;
2562 CADestroyDataSet(currData->sentData);
2563 CADestroyBlockID(currData->blockDataId);
2564 OICFree(currData->payload);
2566 ca_mutex_unlock(g_context.blockDataListMutex);
2567 return CA_STATUS_OK;
2570 ca_mutex_unlock(g_context.blockDataListMutex);
2572 return CA_STATUS_OK;
2575 CAResult_t CARemoveAllBlockDataFromList()
2577 OIC_LOG(DEBUG, TAG, "CARemoveAllBlockDataFromList");
2579 ca_mutex_lock(g_context.blockDataListMutex);
2581 size_t len = u_arraylist_length(g_context.dataList);
2582 for (size_t i = len; i > 0; i--)
2584 CABlockData_t *removedData = u_arraylist_remove(g_context.dataList, i - 1);
2588 if (removedData->sentData)
2590 CADestroyDataSet(removedData->sentData);
2592 CADestroyBlockID(removedData->blockDataId);
2593 OICFree(removedData->payload);
2594 OICFree(removedData);
2597 ca_mutex_unlock(g_context.blockDataListMutex);
2599 return CA_STATUS_OK;
2602 void CADestroyDataSet(CAData_t* data)
2604 VERIFY_NON_NULL_VOID(data, TAG, "data");
2606 CAFreeEndpoint(data->remoteEndpoint);
2607 CADestroyRequestInfoInternal(data->requestInfo);
2608 CADestroyResponseInfoInternal(data->responseInfo);
2612 CABlockDataID_t* CACreateBlockDatablockId(const CAToken_t token, uint8_t tokenLength,
2613 uint16_t portNumber)
2615 char port[PORT_LENGTH] = { 0, };
2616 port[0] = (char) ((portNumber >> 8) & 0xFF);
2617 port[1] = (char) (portNumber & 0xFF);
2619 CABlockDataID_t* blockDataID = (CABlockDataID_t *) OICMalloc(sizeof(CABlockDataID_t));
2622 OIC_LOG(ERROR, TAG, "memory alloc has failed");
2625 blockDataID->idLength = tokenLength + sizeof(port);
2626 blockDataID->id = (uint8_t *) OICMalloc(blockDataID->idLength);
2627 if (!blockDataID->id)
2629 OIC_LOG(ERROR, TAG, "memory alloc has failed");
2630 OICFree(blockDataID);
2636 memcpy(blockDataID->id, token, tokenLength);
2639 memcpy(blockDataID->id + tokenLength, port, sizeof(port));
2641 OIC_LOG(DEBUG, TAG, "BlockID is ");
2642 OIC_LOG_BUFFER(DEBUG, TAG, (const uint8_t *)blockDataID->id, blockDataID->idLength);
2647 void CADestroyBlockID(CABlockDataID_t *blockID)
2649 VERIFY_NON_NULL_VOID(blockID, TAG, "blockID");
2650 OICFree(blockID->id);
2655 bool CABlockidMatches(const CABlockData_t *currData, const CABlockDataID_t *blockID)
2657 VERIFY_NON_NULL_RET(currData, TAG, "currData", false);
2658 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", false);
2659 VERIFY_NON_NULL_RET(blockID->id, TAG, "blockID->id", false);
2661 if ((currData->blockDataId)
2662 && (currData->blockDataId->id)
2663 && (currData->blockDataId->idLength == blockID->idLength)
2664 && !memcmp(currData->blockDataId->id, blockID->id, currData->blockDataId->idLength))
2671 void CALogBlockInfo(coap_block_t *block)
2673 VERIFY_NON_NULL_VOID(block, TAG, "block");
2675 OIC_LOG(DEBUG, TAG, "block option info");
2677 OIC_LOG_V(DEBUG, TAG, "block option-num : %d", block->num);
2679 OIC_LOG_V(DEBUG, TAG, "block option-m : %d", block->m);
2681 OIC_LOG_V(DEBUG, TAG, "block option-szx : %d", block->szx);
2684 CAResult_t CARemoveBlockDataFromListWithSeed(const CAToken_t token, uint8_t tokenLength,
2685 uint16_t portNumber)
2687 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(token, tokenLength, portNumber);
2688 if (NULL == blockDataID || blockDataID->idLength < 1)
2690 OIC_LOG(ERROR, TAG, "blockId is null");
2691 CADestroyBlockID(blockDataID);
2692 return CA_STATUS_FAILED;
2695 CAResult_t res = CA_STATUS_OK;
2697 if (NULL != CAGetBlockDataFromBlockDataList(blockDataID))
2699 res = CARemoveBlockDataFromList(blockDataID);
2700 if (CA_STATUS_OK != res)
2702 OIC_LOG(ERROR, TAG, "CARemoveBlockDataFromList failed");
2706 CADestroyBlockID(blockDataID);