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->transport_hdr, TAG, "pdu->transport_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->transport_hdr->udp.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->transport_hdr->udp.token,
396 pdu->transport_hdr->udp.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->transport_hdr->udp.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->transport_hdr->udp.type == CA_MSG_CONFIRM) ?
500 CA_MSG_ACKNOWLEDGE : CA_MSG_NONCONFIRM;
501 data->responseInfo->info.messageId = pdu->transport_hdr->udp.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->transport_hdr->udp.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->transport_hdr->udp.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->transport_hdr, TAG, "pdu->transport_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->transport_hdr->udp.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->transport_hdr->udp.id;
639 data->responseInfo->info.type = sentMsgType;
640 data->responseInfo->result = CA_CONTINUE;
645 if (data->requestInfo)
647 // if the received response message type is CON, send empty message.
648 // and then, send next block request message with new messagId.
649 if (msgType == CA_MSG_CONFIRM)
651 CASendDirectEmptyResponse(data->remoteEndpoint,
652 data->requestInfo->info.messageId);
653 sentMsgType = CA_MSG_CONFIRM;
656 OIC_LOG(DEBUG, TAG, "need new msgID");
657 data->requestInfo->info.messageId = 0;
658 data->requestInfo->info.type = sentMsgType;
660 else if (data->responseInfo)
662 data->responseInfo->info.messageId = pdu->transport_hdr->udp.id;
663 data->responseInfo->info.type = sentMsgType;
667 // add data to send thread
668 CAResult_t res = CAAddSendThreadQueue(data, blockID);
669 if (CA_STATUS_OK != res)
671 OIC_LOG(ERROR, TAG, "add has failed");
677 CAResult_t CASendErrorMessage(const coap_pdu_t *pdu, uint8_t status,
678 CAResponseResult_t responseResult, const CABlockDataID_t *blockID)
680 VERIFY_NON_NULL(pdu, TAG, "pdu");
681 VERIFY_NON_NULL(pdu->transport_hdr, TAG, "pdu->transport_hdr");
682 VERIFY_NON_NULL(blockID, TAG, "blockID");
684 // create error responseInfo
685 CABlockData_t *data = CAGetBlockDataFromBlockDataList(blockID);
688 OIC_LOG(ERROR, TAG, "data is unavailable");
689 return CA_STATUS_FAILED;
692 CAMessageType_t sentMsgType = CA_MSG_NONCONFIRM;
693 switch (pdu->transport_hdr->udp.type)
696 sentMsgType = CA_MSG_ACKNOWLEDGE;
698 case CA_MSG_ACKNOWLEDGE:
699 sentMsgType = CA_MSG_CONFIRM;
702 sentMsgType = CA_MSG_NONCONFIRM;
705 CAData_t *cloneData = NULL;
708 cloneData = CACloneCAData(data->sentData);
711 OIC_LOG(ERROR, TAG, "clone has failed");
712 return CA_MEMORY_ALLOC_FAILED;
715 if (cloneData->responseInfo)
717 cloneData->responseInfo->info.messageId = pdu->transport_hdr->udp.id;
718 cloneData->responseInfo->info.type = sentMsgType;
719 cloneData->responseInfo->result = responseResult;
723 CAInfo_t responseData = { .tokenLength = pdu->transport_hdr->udp.token_length };
724 responseData.token = (CAToken_t) OICMalloc(responseData.tokenLength);
725 if (!responseData.token)
727 OIC_LOG(ERROR, TAG, "out of memory");
728 return CA_MEMORY_ALLOC_FAILED;
730 memcpy(responseData.token, pdu->transport_hdr->udp.token, responseData.tokenLength);
732 cloneData->responseInfo = (CAResponseInfo_t*) OICCalloc(1, sizeof(CAResponseInfo_t));
733 if (!cloneData->responseInfo)
735 OIC_LOG(ERROR, TAG, "out of memory");
736 OICFree(responseData.token);
737 return CA_MEMORY_ALLOC_FAILED;
740 cloneData->responseInfo->info = responseData;
741 cloneData->responseInfo->info.type = sentMsgType;
742 cloneData->responseInfo->result = responseResult;
744 OIC_LOG(DEBUG, TAG, "set response message to send error code");
748 OIC_LOG(ERROR, TAG, "data has no sent-data");
749 return CA_MEMORY_ALLOC_FAILED;
752 // if there is a requestInfo, remove it to send response message
753 if (cloneData->requestInfo)
755 CADestroyRequestInfoInternal(cloneData->requestInfo);
756 cloneData->requestInfo = NULL;
759 // add data to send thread
760 if (g_context.sendThreadFunc)
762 ca_mutex_lock(g_context.blockDataSenderMutex);
763 g_context.sendThreadFunc(cloneData);
764 ca_mutex_unlock(g_context.blockDataSenderMutex);
768 CADestroyDataSet(cloneData);
771 // if error code is 4.08, remove the stored payload and initialize block number
772 if (CA_BLOCK_INCOMPLETE == status)
774 OICFree(data->payload);
775 data->payload = NULL;
776 data->payloadLength = 0;
777 data->receivedPayloadLen = 0;
778 data->block1.num = 0;
779 data->block2.num = 0;
785 CAResult_t CAReceiveLastBlock(const CABlockDataID_t *blockID, const CAData_t *receivedData)
787 VERIFY_NON_NULL(blockID, TAG, "blockID");
788 VERIFY_NON_NULL(receivedData, TAG, "receivedData");
790 // total block data have to notify to Application
791 CAData_t *cloneData = CACloneCAData(receivedData);
794 OIC_LOG(ERROR, TAG, "clone has failed");
795 return CA_MEMORY_ALLOC_FAILED;
799 size_t fullPayloadLen = 0;
800 CAPayload_t fullPayload = CAGetPayloadFromBlockDataList(blockID, &fullPayloadLen);
803 CAResult_t res = CAUpdatePayloadToCAData(cloneData, fullPayload, fullPayloadLen);
804 if (CA_STATUS_OK != res)
806 OIC_LOG(ERROR, TAG, "update has failed");
807 CADestroyDataSet(cloneData);
812 if (g_context.receivedThreadFunc)
814 g_context.receivedThreadFunc(cloneData);
818 CADestroyDataSet(cloneData);
824 static CABlockData_t* CACheckTheExistOfBlockData(const CABlockDataID_t* blockDataID,
825 coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
828 // Get BlockData data. If does not exist, create a new data
829 CABlockData_t *data = CAGetBlockDataFromBlockDataList(blockDataID);
832 OIC_LOG(DEBUG, TAG, "block data doesn't exist in list. create new one");
834 CAData_t *cadata = CACreateNewDataSet(pdu, endpoint);
837 OIC_LOG(ERROR, TAG, "data is null");
841 data = CACreateNewBlockData(cadata);
844 OIC_LOG(ERROR, TAG, "failed to create a new block data");
845 CADestroyDataSet(cadata);
848 CADestroyDataSet(cadata);
851 // update BLOCK OPTION type
852 CAResult_t res = CAUpdateBlockOptionType(blockDataID, blockType);
853 if (CA_STATUS_OK != res)
855 OIC_LOG(ERROR, TAG, "update has failed");
862 // TODO make pdu const after libcoap is updated to support that.
863 CAResult_t CASetNextBlockOption1(coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
864 const CAData_t *receivedData, coap_block_t block,
867 OIC_LOG(INFO, TAG, "CASetNextBlockOption1");
868 VERIFY_NON_NULL(pdu, TAG, "pdu");
869 VERIFY_NON_NULL(pdu->transport_hdr, TAG, "pdu->transport_hdr");
870 VERIFY_NON_NULL(endpoint, TAG, "endpoint");
871 VERIFY_NON_NULL(receivedData, TAG, "receivedData");
873 OIC_LOG_V(INFO, TAG, "num:%d, M:%d, sze:%d", block.num, block.m, block.szx);
875 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(
876 (CAToken_t)pdu->transport_hdr->udp.token,
877 pdu->transport_hdr->udp.token_length,
879 if (NULL == blockDataID || blockDataID->idLength < 1)
881 OIC_LOG(ERROR, TAG, "blockId is null");
882 CADestroyBlockID(blockDataID);
883 return CA_STATUS_FAILED;
886 CAResult_t res = CA_STATUS_OK;
887 CABlockData_t *data = CACheckTheExistOfBlockData(blockDataID, pdu, endpoint,
891 OIC_LOG(ERROR, TAG, "Failed to create or get block data");
892 res = CA_STATUS_FAILED;
896 uint8_t blockWiseStatus = CA_BLOCK_UNKNOWN;
897 uint32_t code = pdu->transport_hdr->udp.code;
898 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
900 // received message type is request
901 OIC_LOG_V(INFO, TAG, "num:%d, M:%d", block.num, block.m);
903 // check the size option
904 bool isSizeOption = CAIsPayloadLengthInPduWithBlockSizeOption(pdu, COAP_OPTION_SIZE1,
905 &(data->payloadLength));
907 blockWiseStatus = CACheckBlockErrorType(data, &block, receivedData,
908 COAP_OPTION_BLOCK1, dataLen);
910 if (CA_BLOCK_RECEIVED_ALREADY != blockWiseStatus)
912 // store the received payload and merge
913 res = CAUpdatePayloadData(data, receivedData, blockWiseStatus,
914 isSizeOption, COAP_OPTION_BLOCK1);
915 if (CA_STATUS_OK != res)
917 OIC_LOG(ERROR, TAG, "update has failed");
921 res = CAUpdateBlockOptionItems(data, pdu, &block, COAP_OPTION_BLOCK1,
923 if (CA_STATUS_OK != res)
925 OIC_LOG(ERROR, TAG, "update has failed");
930 res = CAUpdateBlockData(data, block, COAP_OPTION_BLOCK1);
931 if (CA_STATUS_OK != res)
933 OIC_LOG(ERROR, TAG, "update has failed");
938 // check the blcok-wise transfer status for next step
939 if (CA_BLOCK_UNKNOWN == blockWiseStatus || CA_BLOCK_RECEIVED_ALREADY == blockWiseStatus)
941 OIC_LOG_V(DEBUG, TAG, "M bit is %d", block.m);
943 blockWiseStatus = (0 == block.m) ?
944 CA_OPTION1_REQUEST_LAST_BLOCK : CA_OPTION1_REQUEST_BLOCK;
949 // received message type is response
950 uint32_t code = CA_RESPONSE_CODE(pdu->transport_hdr->udp.code);
951 if (0 == block.m && (CA_REQUEST_ENTITY_INCOMPLETE != code
952 && CA_REQUEST_ENTITY_TOO_LARGE != code))
954 int isBlock2 = coap_get_block(pdu, COAP_OPTION_BLOCK2, &block);
957 OIC_LOG(INFO, TAG, "received data is combining block1 and block2");
958 // initialize block number for response message
959 data->block1.num = 0;
960 CADestroyBlockID(blockDataID);
965 OIC_LOG(INFO, TAG, "received data is not bulk data");
966 CAReceiveLastBlock(blockDataID, receivedData);
972 blockWiseStatus = CA_OPTION1_RESPONSE;
973 res = CAUpdateBlockOptionItems(data, pdu, &block, COAP_OPTION_BLOCK1, blockWiseStatus);
974 if (CA_STATUS_OK != res)
976 OIC_LOG(ERROR, TAG, "update has failed");
977 CADestroyBlockID(blockDataID);
981 res = CAUpdateBlockData(data, block, COAP_OPTION_BLOCK1);
982 if (CA_STATUS_OK != res)
984 OIC_LOG(ERROR, TAG, "update has failed");
989 res = CAProcessNextStep(pdu, receivedData, blockWiseStatus, blockDataID);
990 if (CA_STATUS_OK != res)
992 OIC_LOG(ERROR, TAG, "setting has failed");
996 CADestroyBlockID(blockDataID);
1000 CARemoveBlockDataFromList(blockDataID);
1001 CADestroyBlockID(blockDataID);
1005 // TODO make pdu const after libcoap is updated to support that.
1006 CAResult_t CASetNextBlockOption2(coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
1007 const CAData_t *receivedData, coap_block_t block,
1010 OIC_LOG(DEBUG, TAG, "CASetNextBlockOption2");
1011 OIC_LOG_V(INFO, TAG, "num:%d, M:%d, sze:%d", block.num, block.m, block.szx);
1013 VERIFY_NON_NULL(pdu, TAG, "pdu");
1014 VERIFY_NON_NULL(pdu->transport_hdr, TAG, "pdu->transport_hdr");
1015 VERIFY_NON_NULL(endpoint, TAG, "endpoint");
1016 VERIFY_NON_NULL(receivedData, TAG, "receivedData");
1018 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(
1019 (CAToken_t)pdu->transport_hdr->udp.token,
1020 pdu->transport_hdr->udp.token_length,
1022 if (NULL == blockDataID || blockDataID->idLength < 1)
1024 OIC_LOG(ERROR, TAG, "blockId is null");
1025 CADestroyBlockID(blockDataID);
1026 return CA_STATUS_FAILED;
1029 CAResult_t res = CA_STATUS_OK;
1030 CABlockData_t *data = CACheckTheExistOfBlockData(blockDataID, pdu, endpoint,
1031 COAP_OPTION_BLOCK2);
1034 OIC_LOG(ERROR, TAG, "Failed to create or get block data");
1035 res = CA_STATUS_FAILED;
1039 uint8_t blockWiseStatus = CA_BLOCK_UNKNOWN;
1040 if (0 == block.num && CA_GET == pdu->transport_hdr->udp.code && 0 == block.m)
1042 OIC_LOG(INFO, TAG, "first block number");
1044 res = CAUpdateBlockOptionItems(data, pdu, &block, COAP_OPTION_BLOCK2, blockWiseStatus);
1045 if (CA_STATUS_OK != res)
1047 OIC_LOG(ERROR, TAG, "update has failed");
1051 // first block data have to notify to Application
1052 res = CAUpdateBlockData(data, block, COAP_OPTION_BLOCK2);
1053 if (CA_STATUS_OK != res)
1055 OIC_LOG(ERROR, TAG, "update has failed");
1058 blockWiseStatus = CA_OPTION2_FIRST_BLOCK;
1062 uint32_t code = pdu->transport_hdr->udp.code;
1063 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
1065 // received message type is request
1066 OIC_LOG_V(INFO, TAG, "num:%d, M:%d", block.num, block.m);
1068 blockWiseStatus = CA_OPTION2_REQUEST;
1070 res = CAUpdateBlockOptionItems(data, pdu, &block, COAP_OPTION_BLOCK2, blockWiseStatus);
1071 if (CA_STATUS_OK != res)
1073 OIC_LOG(ERROR, TAG, "update has failed");
1077 res = CAUpdateBlockData(data, block, COAP_OPTION_BLOCK2);
1078 if (CA_STATUS_OK != res)
1080 OIC_LOG(ERROR, TAG, "update has failed");
1086 // received message type is response
1087 OIC_LOG(DEBUG, TAG, "received response message with block option2");
1089 // check the size option
1090 bool isSizeOption = CAIsPayloadLengthInPduWithBlockSizeOption(pdu,
1092 &(data->payloadLength));
1094 uint32_t code = CA_RESPONSE_CODE(pdu->transport_hdr->udp.code);
1095 if (CA_REQUEST_ENTITY_INCOMPLETE != code && CA_REQUEST_ENTITY_TOO_LARGE != code)
1097 // check if received payload is exact
1098 blockWiseStatus = CACheckBlockErrorType(data, &block, receivedData,
1099 COAP_OPTION_BLOCK2, dataLen);
1102 if (CA_BLOCK_RECEIVED_ALREADY != blockWiseStatus)
1104 // store the received payload and merge
1105 res = CAUpdatePayloadData(data, receivedData, blockWiseStatus,
1106 isSizeOption, COAP_OPTION_BLOCK2);
1107 if (CA_STATUS_OK != res)
1109 OIC_LOG(ERROR, TAG, "update has failed");
1114 if (0 == block.m && CA_BLOCK_UNKNOWN == blockWiseStatus) // Last block is received
1116 OIC_LOG(DEBUG, TAG, "M bit is 0");
1117 blockWiseStatus = CA_OPTION2_LAST_BLOCK;
1121 if (CA_BLOCK_UNKNOWN == blockWiseStatus ||
1122 CA_BLOCK_RECEIVED_ALREADY == blockWiseStatus)
1124 OIC_LOG(DEBUG, TAG, "M bit is 1");
1125 blockWiseStatus = CA_OPTION2_RESPONSE;
1128 res = CAUpdateBlockOptionItems(data, pdu, &block, COAP_OPTION_BLOCK2,
1130 if (CA_STATUS_OK != res)
1132 OIC_LOG(ERROR, TAG, "update has failed");
1136 res = CAUpdateBlockData(data, block, COAP_OPTION_BLOCK2);
1137 if (CA_STATUS_OK != res)
1139 OIC_LOG(ERROR, TAG, "update has failed");
1146 res = CAProcessNextStep(pdu, receivedData, blockWiseStatus, blockDataID);
1147 if (CA_STATUS_OK != res)
1149 OIC_LOG(ERROR, TAG, "setting has failed");
1153 CADestroyBlockID(blockDataID);
1154 return CA_STATUS_OK;
1157 CARemoveBlockDataFromList(blockDataID);
1158 CADestroyBlockID(blockDataID);
1162 CAResult_t CAUpdateBlockOptionItems(CABlockData_t *currData, const coap_pdu_t *pdu,
1163 coap_block_t *block, uint16_t blockType,
1166 VERIFY_NON_NULL(currData, TAG, "currData");
1167 VERIFY_NON_NULL(pdu, TAG, "pdu");
1168 VERIFY_NON_NULL(block, TAG, "block");
1170 // update block data
1171 CAResult_t res = CA_STATUS_OK;
1172 uint32_t code = CA_RESPONSE_CODE(pdu->transport_hdr->udp.code);
1174 if (CA_REQUEST_ENTITY_INCOMPLETE == code || CA_REQUEST_ENTITY_TOO_LARGE == code)
1176 // response error code of the received block message
1177 res = CAHandleBlockErrorResponse(block, blockType, code);
1178 if (CA_STATUS_OK != res)
1180 OIC_LOG(ERROR, TAG, "error handle has failed");
1186 // update block option items
1189 case CA_OPTION1_RESPONSE:
1190 if (currData->block1.num > block->num)
1192 OIC_LOG(ERROR, TAG, "received incorrect block num");
1193 return CA_STATUS_FAILED;
1197 case CA_OPTION2_REQUEST:
1200 case CA_OPTION2_RESPONSE:
1201 if (currData->block2.num > block->num)
1203 OIC_LOG(ERROR, TAG, "received incorrect block num");
1204 return CA_STATUS_FAILED;
1209 case CA_BLOCK_TOO_LARGE:
1210 // if state of received block message is CA_BLOCK_TOO_LARGE or CA_BLOCK_INCOMPLETE
1211 // we set the response error code appropriately and send
1212 if (COAP_OPTION_BLOCK2 == blockType)
1216 block->szx = currData->block2.szx;
1220 block->szx = currData->block1.szx;
1224 OIC_LOG_V(ERROR, TAG, "no logic [%d]", status);
1227 if (CA_BLOCK_INCOMPLETE != status && CA_BLOCK_TOO_LARGE != status)
1229 // negotiate block size
1230 res = CANegotiateBlockSize(currData, block, pdu, blockType);
1231 if (CA_STATUS_OK != res)
1233 OIC_LOG(ERROR, TAG, "negotiation has failed");
1241 CAResult_t CASetMoreBitFromBlock(size_t payloadLen, coap_block_t *block)
1243 VERIFY_NON_NULL(block, TAG, "block");
1245 if ((size_t) ((block->num + 1) << (block->szx + BLOCK_NUMBER_IDX)) < payloadLen)
1247 OIC_LOG(DEBUG, TAG, "Set the M-bit(1)");
1252 OIC_LOG(DEBUG, TAG, "Set the M-bit(0)");
1256 return CA_STATUS_OK;
1259 CAResult_t CANegotiateBlockSize(CABlockData_t *currData, coap_block_t *block,
1260 const coap_pdu_t *pdu, uint16_t blockType)
1262 OIC_LOG(DEBUG, TAG, "IN-NegotiateBlockSize");
1264 VERIFY_NON_NULL(currData, TAG, "currData");
1265 VERIFY_NON_NULL(block, TAG, "block");
1266 VERIFY_NON_NULL(pdu, TAG, "pdu");
1267 VERIFY_NON_NULL(pdu->transport_hdr, TAG, "pdu->transport_hdr");
1269 bool isReqMsg = false;
1270 uint32_t code = pdu->transport_hdr->udp.code;
1271 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
1276 // #1. check the block option type
1277 if (COAP_OPTION_BLOCK2 == blockType)
1279 // #2. check the message type
1282 if (block->szx > currData->block2.szx)
1284 OIC_LOG(DEBUG, TAG, "sze is big");
1286 // #3. calculate new block number from block size
1287 unsigned int blockNum = BLOCK_SIZE(block->szx) /
1288 BLOCK_SIZE(currData->block2.szx) - 1;
1289 OIC_LOG(DEBUG, TAG, "num is set as Negotiation");
1290 block->num += blockNum;
1291 block->szx = currData->block2.szx;
1292 OIC_LOG_V(DEBUG, TAG, "updated block num: %d", block->num);
1297 if (block->szx > currData->block2.szx)
1299 OIC_LOG(DEBUG, TAG, "sze is big");
1300 block->szx = currData->block2.szx;
1304 else if (COAP_OPTION_BLOCK1 == blockType)
1308 if (block->szx < currData->block1.szx)
1310 OIC_LOG(DEBUG, TAG, "sze is small");
1312 unsigned int blockNum = BLOCK_SIZE(currData->block1.szx) /
1313 BLOCK_SIZE(block->szx) - 1;
1314 block->num += blockNum;
1315 OIC_LOG_V(DEBUG, TAG, "updated block num: %d", block->num);
1320 if (block->szx > currData->block1.szx)
1322 OIC_LOG(DEBUG, TAG, "sze is big");
1323 block->szx = currData->block1.szx;
1329 OIC_LOG(DEBUG, TAG, "Invalid block option");
1330 return CA_STATUS_FAILED;
1333 OIC_LOG(DEBUG, TAG, "OUT-NegotiateBlockSize");
1335 return CA_STATUS_OK;
1338 CAResult_t CAUpdateBlockData(CABlockData_t *currData, coap_block_t block,
1341 VERIFY_NON_NULL(currData, TAG, "currData");
1343 // check if block size is bigger than CABlockSize_t
1344 if (block.szx > CA_BLOCK_SIZE_1024_BYTE)
1346 OIC_LOG(DEBUG, TAG, "invalid block szx");
1347 return CA_STATUS_FAILED;
1350 // update block option
1351 if (COAP_OPTION_BLOCK2 == blockType)
1353 currData->block2 = block;
1357 currData->block1 = block;
1360 OIC_LOG(DEBUG, TAG, "data has updated");
1361 return CA_STATUS_OK;
1364 CAResult_t CAUpdateMessageId(coap_pdu_t *pdu, const CABlockDataID_t *blockID)
1366 VERIFY_NON_NULL(pdu, TAG, "pdu");
1367 VERIFY_NON_NULL(pdu->transport_hdr, TAG, "pdu->transport_hdr");
1368 VERIFY_NON_NULL(blockID, TAG, "blockID");
1370 // if message is sent, update messageId in block-wise transfer list
1371 CAData_t * cadata = CAGetDataSetFromBlockDataList(blockID);
1374 OIC_LOG(ERROR, TAG, "CAData is unavailable");
1375 return CA_STATUS_FAILED;
1378 if (cadata->requestInfo)
1380 cadata->requestInfo->info.messageId = pdu->transport_hdr->udp.id;
1383 return CA_STATUS_OK;
1386 CAResult_t CAAddBlockOption(coap_pdu_t **pdu, const CAInfo_t *info,
1387 const CAEndpoint_t *endpoint, coap_list_t **options)
1389 OIC_LOG(DEBUG, TAG, "IN-AddBlockOption");
1390 VERIFY_NON_NULL(pdu, TAG, "pdu");
1391 VERIFY_NON_NULL((*pdu), TAG, "(*pdu)");
1392 VERIFY_NON_NULL((*pdu)->transport_hdr, TAG, "(*pdu)->transport_hdr");
1393 VERIFY_NON_NULL(info, TAG, "info");
1394 VERIFY_NON_NULL(endpoint, TAG, "endpoint");
1395 VERIFY_NON_NULL(options, TAG, "options");
1397 CAResult_t res = CA_STATUS_OK;
1398 size_t dataLength = 0;
1401 dataLength = info->payloadSize;
1402 OIC_LOG_V(DEBUG, TAG, "dataLength - %zu", dataLength);
1405 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(
1406 (CAToken_t)(*pdu)->transport_hdr->udp.token,
1407 (*pdu)->transport_hdr->udp.token_length,
1409 if (NULL == blockDataID || blockDataID->idLength < 1)
1411 OIC_LOG(ERROR, TAG, "blockId is null");
1412 res = CA_STATUS_FAILED;
1416 uint32_t repCode = CA_RESPONSE_CODE((*pdu)->transport_hdr->udp.code);
1417 if (CA_REQUEST_ENTITY_INCOMPLETE == repCode)
1419 OIC_LOG(INFO, TAG, "don't use option");
1424 uint8_t blockType = CAGetBlockOptionType(blockDataID);
1425 if (COAP_OPTION_BLOCK2 == blockType)
1427 res = CAAddBlockOption2(pdu, info, dataLength, blockDataID, options);
1428 if (CA_STATUS_OK != res)
1430 OIC_LOG(ERROR, TAG, "add has failed");
1434 else if (COAP_OPTION_BLOCK1 == blockType)
1436 res = CAAddBlockOption1(pdu, info, dataLength, blockDataID, options);
1437 if (CA_STATUS_OK != res)
1439 OIC_LOG(ERROR, TAG, "add has failed");
1445 OIC_LOG(DEBUG, TAG, "no BLOCK option");
1447 // in case it is not large data, add option list to pdu.
1450 for (coap_list_t *opt = *options; opt; opt = opt->next)
1452 OIC_LOG_V(DEBUG, TAG, "[%s] opt will be added.",
1453 COAP_OPTION_DATA(*(coap_option *) opt->data));
1455 OIC_LOG_V(DEBUG, TAG, "[%d] pdu length", (*pdu)->length);
1456 coap_add_option(*pdu, COAP_OPTION_KEY(*(coap_option *) opt->data),
1457 COAP_OPTION_LENGTH(*(coap_option *) opt->data),
1458 COAP_OPTION_DATA(*(coap_option *) opt->data));
1462 OIC_LOG_V(DEBUG, TAG, "[%d] pdu length after option", (*pdu)->length);
1464 // if response data is so large. it have to send as block transfer
1465 if (!coap_add_data(*pdu, dataLength, (const unsigned char *) info->payload))
1467 OIC_LOG(INFO, TAG, "it have to use block");
1468 res = CA_STATUS_FAILED;
1473 OIC_LOG(INFO, TAG, "not Blockwise Transfer");
1477 uint32_t code = (*pdu)->transport_hdr->udp.code;
1478 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
1480 // if received message type is RESET from remote device,
1481 // we have to use the updated message id of request message to find token.
1482 CABlockData_t *blockData = CAGetBlockDataFromBlockDataList(blockDataID);
1485 res = CAUpdateMessageId(*pdu, blockDataID);
1486 if (CA_STATUS_OK != res)
1488 OIC_LOG(ERROR, TAG, "fail to update message id");
1495 CADestroyBlockID(blockDataID);
1496 OIC_LOG(DEBUG, TAG, "OUT-AddBlockOption");
1500 CAResult_t CAAddBlockOption2(coap_pdu_t **pdu, const CAInfo_t *info, size_t dataLength,
1501 const CABlockDataID_t *blockID, coap_list_t **options)
1503 OIC_LOG(DEBUG, TAG, "IN-AddBlockOption2");
1504 VERIFY_NON_NULL(pdu, TAG, "pdu");
1505 VERIFY_NON_NULL((*pdu), TAG, "(*pdu)");
1506 VERIFY_NON_NULL((*pdu)->transport_hdr, TAG, "(*pdu)->transport_hdr");
1507 VERIFY_NON_NULL(info, TAG, "info");
1508 VERIFY_NON_NULL(blockID, TAG, "blockID");
1509 VERIFY_NON_NULL(options, TAG, "options");
1511 // get set block data from CABlock list-set.
1512 coap_block_t *block1 = CAGetBlockOption(blockID, COAP_OPTION_BLOCK1);
1513 coap_block_t *block2 = CAGetBlockOption(blockID, COAP_OPTION_BLOCK2);
1514 if (!block1 || !block2)
1516 OIC_LOG(ERROR, TAG, "getting has failed");
1517 return CA_STATUS_FAILED;
1520 CAResult_t res = CA_STATUS_OK;
1521 uint32_t code = (*pdu)->transport_hdr->udp.code;
1522 if (CA_GET != code && CA_POST != code && CA_PUT != code && CA_DELETE != code)
1524 CASetMoreBitFromBlock(dataLength, block2);
1526 // if block number is 0, add size2 option
1527 if (0 == block2->num)
1529 res = CAAddBlockSizeOption(*pdu, COAP_OPTION_SIZE2, dataLength, options);
1530 if (CA_STATUS_OK != res)
1532 OIC_LOG(ERROR, TAG, "add has failed");
1537 res = CAAddBlockOptionImpl(block2, COAP_OPTION_BLOCK2, options);
1538 if (CA_STATUS_OK != res)
1540 OIC_LOG(ERROR, TAG, "add has failed");
1546 OIC_LOG(DEBUG, TAG, "combining block1 and block2");
1547 res = CAAddBlockOptionImpl(block1, COAP_OPTION_BLOCK1, options);
1548 if (CA_STATUS_OK != res)
1550 OIC_LOG(ERROR, TAG, "add has failed");
1553 // initialize block number
1557 res = CAAddOptionToPDU(*pdu, options);
1558 if (CA_STATUS_OK != res)
1560 OIC_LOG(ERROR, TAG, "add has failed");
1564 if (!coap_add_block(*pdu, dataLength, (const unsigned char *) info->payload,
1565 block2->num, block2->szx))
1567 OIC_LOG(ERROR, TAG, "Data length is smaller than the start index");
1568 return CA_STATUS_FAILED;
1571 CALogBlockInfo(block2);
1575 // if sent message is last response block message, remove data
1576 CARemoveBlockDataFromList(blockID);
1581 OIC_LOG(DEBUG, TAG, "option2, not response msg");
1582 res = CAAddBlockOptionImpl(block2, COAP_OPTION_BLOCK2, options);
1583 if (CA_STATUS_OK != res)
1585 OIC_LOG(ERROR, TAG, "add has failed");
1589 res = CAAddOptionToPDU(*pdu, options);
1590 if (CA_STATUS_OK != res)
1592 OIC_LOG(ERROR, TAG, "add has failed");
1595 CALogBlockInfo(block2);
1598 return CA_STATUS_OK;
1601 CARemoveBlockDataFromList(blockID);
1605 CAResult_t CAAddBlockOption1(coap_pdu_t **pdu, const CAInfo_t *info, size_t dataLength,
1606 const CABlockDataID_t *blockID, coap_list_t **options)
1608 OIC_LOG(DEBUG, TAG, "IN-AddBlockOption1");
1609 VERIFY_NON_NULL(pdu, TAG, "pdu");
1610 VERIFY_NON_NULL((*pdu), TAG, "(*pdu)");
1611 VERIFY_NON_NULL((*pdu)->transport_hdr, TAG, "(*pdu)->transport_hdr");
1612 VERIFY_NON_NULL(info, TAG, "info");
1613 VERIFY_NON_NULL(blockID, TAG, "blockID");
1614 VERIFY_NON_NULL(options, TAG, "options");
1616 // get set block data from CABlock list-set.
1617 coap_block_t *block1 = CAGetBlockOption(blockID, COAP_OPTION_BLOCK1);
1620 OIC_LOG(ERROR, TAG, "getting has failed");
1621 return CA_STATUS_FAILED;
1624 CAResult_t res = CA_STATUS_OK;
1625 uint32_t code = (*pdu)->transport_hdr->udp.code;
1626 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
1628 CASetMoreBitFromBlock(dataLength, block1);
1630 // if block number is 0, add size1 option
1631 if (0 == block1->num)
1633 res = CAAddBlockSizeOption(*pdu, COAP_OPTION_SIZE1, dataLength, options);
1634 if (CA_STATUS_OK != res)
1636 OIC_LOG(ERROR, TAG, "add has failed");
1641 // add block option to option list.
1642 res = CAAddBlockOptionImpl(block1, COAP_OPTION_BLOCK1, options);
1643 if (CA_STATUS_OK != res)
1645 OIC_LOG(ERROR, TAG, "add has failed");
1649 // add option list to pdu.
1650 res = CAAddOptionToPDU(*pdu, options);
1651 if (CA_STATUS_OK != res)
1653 OIC_LOG(ERROR, TAG, "add has failed");
1657 // add the payload data as the block size.
1658 if (!coap_add_block(*pdu, dataLength, (const unsigned char *) info->payload, block1->num,
1661 OIC_LOG(ERROR, TAG, "Data length is smaller than the start index");
1662 return CA_STATUS_FAILED;
1667 OIC_LOG(DEBUG, TAG, "received response message with block option1");
1669 // add block option to option list.
1670 res = CAAddBlockOptionImpl(block1, COAP_OPTION_BLOCK1, options);
1671 if (CA_STATUS_OK != res)
1673 OIC_LOG(ERROR, TAG, "add has failed");
1677 // add option list to pdu.
1678 res = CAAddOptionToPDU(*pdu, options);
1679 if (CA_STATUS_OK != res)
1681 OIC_LOG(ERROR, TAG, "add has failed");
1685 // add the payload data as the block size.
1686 if (!coap_add_data(*pdu, dataLength, (const unsigned char *) info->payload))
1688 OIC_LOG(ERROR, TAG, "failed to add payload");
1689 return CA_STATUS_FAILED;
1692 // if it is last block message, remove block data from list.
1695 // remove data from list
1696 res = CARemoveBlockDataFromList(blockID);
1697 if (CA_STATUS_OK != res)
1699 OIC_LOG(ERROR, TAG, "remove has failed");
1705 CALogBlockInfo(block1);
1707 OIC_LOG(DEBUG, TAG, "OUT-AddBlockOption1");
1709 return CA_STATUS_OK;
1712 CARemoveBlockDataFromList(blockID);
1716 CAResult_t CAAddBlockOptionImpl(coap_block_t *block, uint8_t blockType,
1717 coap_list_t **options)
1719 OIC_LOG(DEBUG, TAG, "IN-AddBlockOptionImpl");
1720 VERIFY_NON_NULL(block, TAG, "block");
1721 VERIFY_NON_NULL(options, TAG, "options");
1723 unsigned char buf[BLOCKWISE_OPTION_BUFFER] = { 0 };
1724 unsigned int optionLength = coap_encode_var_bytes(buf,
1725 ((block->num << BLOCK_NUMBER_IDX)
1726 | (block->m << BLOCK_M_BIT_IDX)
1729 int ret = coap_insert(options,
1730 CACreateNewOptionNode(blockType, optionLength, (char *) buf),
1734 return CA_STATUS_INVALID_PARAM;
1737 OIC_LOG(DEBUG, TAG, "OUT-AddBlockOptionImpl");
1738 return CA_STATUS_OK;
1741 CAResult_t CAAddOptionToPDU(coap_pdu_t *pdu, coap_list_t **options)
1743 // after adding the block option to option list, add option list to pdu.
1746 for (coap_list_t *opt = *options; opt; opt = opt->next)
1748 OIC_LOG_V(DEBUG, TAG, "[%s] opt will be added.",
1749 COAP_OPTION_DATA(*(coap_option *) opt->data));
1751 OIC_LOG_V(DEBUG, TAG, "[%d] pdu length", pdu->length);
1752 int ret = coap_add_option(pdu, COAP_OPTION_KEY(*(coap_option *) opt->data),
1753 COAP_OPTION_LENGTH(*(coap_option *) opt->data),
1754 COAP_OPTION_DATA(*(coap_option *) opt->data));
1757 return CA_STATUS_FAILED;
1762 OIC_LOG_V(DEBUG, TAG, "[%d] pdu length after option", pdu->length);
1764 return CA_STATUS_OK;
1767 CAResult_t CAAddBlockSizeOption(coap_pdu_t *pdu, uint16_t sizeType, size_t dataLength,
1768 coap_list_t **options)
1770 OIC_LOG(DEBUG, TAG, "IN-CAAddBlockSizeOption");
1771 VERIFY_NON_NULL(pdu, TAG, "pdu");
1772 VERIFY_NON_NULL(options, TAG, "options");
1774 if (sizeType != COAP_OPTION_SIZE1 && sizeType != COAP_OPTION_SIZE2)
1776 OIC_LOG(ERROR, TAG, "unknown option type");
1777 return CA_STATUS_FAILED;
1780 unsigned char value[BLOCKWISE_OPTION_BUFFER] = { 0 };
1781 unsigned int optionLength = coap_encode_var_bytes(value, dataLength);
1783 int ret = coap_insert(options,
1784 CACreateNewOptionNode(sizeType, optionLength, (char *) value),
1788 return CA_STATUS_INVALID_PARAM;
1791 OIC_LOG(DEBUG, TAG, "OUT-CAAddBlockSizeOption");
1793 return CA_STATUS_OK;
1796 // TODO make pdu const after libcoap is updated to support that.
1797 bool CAIsPayloadLengthInPduWithBlockSizeOption(coap_pdu_t *pdu,
1799 size_t *totalPayloadLen)
1801 OIC_LOG(DEBUG, TAG, "IN-CAIsPayloadLengthInPduWithBlockSizeOption");
1802 VERIFY_NON_NULL(pdu, TAG, "pdu");
1803 VERIFY_NON_NULL(totalPayloadLen, TAG, "totalPayloadLen");
1805 if (sizeType != COAP_OPTION_SIZE1 && sizeType != COAP_OPTION_SIZE2)
1807 OIC_LOG(ERROR, TAG, "unknown option type");
1808 return CA_STATUS_FAILED;
1811 coap_opt_iterator_t opt_iter;
1812 coap_opt_t *option = coap_check_option(pdu, sizeType, &opt_iter);
1815 OIC_LOG(DEBUG, TAG, "get size option from pdu");
1816 *totalPayloadLen = coap_decode_var_bytes(COAP_OPT_VALUE(option),
1817 COAP_OPT_LENGTH(option));
1819 OIC_LOG_V(DEBUG, TAG, "the total payload length to be received is [%zu]bytes",
1825 OIC_LOG(DEBUG, TAG, "OUT-CAIsPayloadLengthInPduWithBlockSizeOption");
1830 uint8_t CACheckBlockErrorType(CABlockData_t *currData, coap_block_t *receivedBlock,
1831 const CAData_t *receivedData, uint16_t blockType,
1834 OIC_LOG(DEBUG, TAG, "IN-CheckBlockError");
1836 VERIFY_NON_NULL(currData, TAG, "currData is NULL");
1837 VERIFY_NON_NULL(receivedBlock, TAG, "receivedBlock is NULL");
1838 VERIFY_NON_NULL(receivedData, TAG, "receivedData is NULL");
1840 // #1. check the received payload length
1841 size_t blockPayloadLen = 0;
1842 CAGetPayloadInfo(receivedData, &blockPayloadLen);
1844 // #2. check if the block sequence is right
1845 if (COAP_OPTION_BLOCK1 == blockType)
1847 size_t prePayloadLen = currData->receivedPayloadLen;
1848 if (prePayloadLen != (size_t) BLOCK_SIZE(receivedBlock->szx) * receivedBlock->num)
1850 if (receivedBlock->num > currData->block1.num + 1)
1852 // 408 Error handling of block loss
1853 OIC_LOG(ERROR, TAG, "option1: error 4.08");
1854 OIC_LOG(ERROR, TAG, "it didn't order");
1855 return CA_BLOCK_INCOMPLETE;
1857 return CA_BLOCK_RECEIVED_ALREADY;
1860 else if (COAP_OPTION_BLOCK2 == blockType)
1862 if (receivedBlock->num != currData->block2.num)
1864 if (receivedBlock->num > currData->block2.num)
1866 // 408 Error handling of block loss
1867 OIC_LOG(ERROR, TAG, "option2: error 4.08");
1868 OIC_LOG(ERROR, TAG, "it didn't order");
1869 return CA_BLOCK_INCOMPLETE;
1873 OIC_LOG(ERROR, TAG, "already received this block");
1874 return CA_BLOCK_RECEIVED_ALREADY;
1879 // #3. check if error check logic is required
1880 size_t optionLen = dataLen - blockPayloadLen;
1881 if (receivedBlock->m && blockPayloadLen != (size_t) BLOCK_SIZE(receivedBlock->szx))
1883 // 413 Error handling of too large entity
1884 if (COAP_MAX_PDU_SIZE < BLOCK_SIZE(receivedBlock->szx) + optionLen)
1886 // buffer size is smaller than received block size
1887 OIC_LOG(ERROR, TAG, "error type 4.13");
1888 OIC_LOG(ERROR, TAG, "too large size");
1890 // set the block size to be smaller than COAP_MAX_PDU_SIZE
1891 for (int32_t size = CA_DEFAULT_BLOCK_SIZE; size >= 0; size--)
1893 if (COAP_MAX_PDU_SIZE >= BLOCK_SIZE(size) + optionLen)
1895 OIC_LOG_V(ERROR, TAG, "replace sze with %d", size);
1896 currData->block2.szx = size;
1897 currData->block1.szx = size;
1901 return CA_BLOCK_TOO_LARGE;
1905 // 408 Error handling of payload loss
1906 OIC_LOG(ERROR, TAG, "error type 4.08");
1907 OIC_LOG(ERROR, TAG, "payload len != block sze");
1908 return CA_BLOCK_INCOMPLETE;
1911 else if (0 == receivedBlock->m && 0 != currData->payloadLength)
1913 // if the received block is last block, check the total payload length
1914 size_t receivedPayloadLen = currData->receivedPayloadLen;
1915 receivedPayloadLen += blockPayloadLen;
1917 if (receivedPayloadLen != currData->payloadLength)
1919 OIC_LOG(ERROR, TAG, "error type 4.08");
1920 OIC_LOG(ERROR, TAG, "total payload length is wrong");
1921 return CA_BLOCK_INCOMPLETE;
1925 OIC_LOG(DEBUG, TAG, "received all data normally");
1927 OIC_LOG(DEBUG, TAG, "OUT-CheckBlockError");
1929 return CA_BLOCK_UNKNOWN;
1932 CAResult_t CAUpdatePayloadData(CABlockData_t *currData, const CAData_t *receivedData,
1933 uint8_t status, bool isSizeOption, uint16_t blockType)
1935 OIC_LOG(DEBUG, TAG, "IN-UpdatePayloadData");
1937 VERIFY_NON_NULL(currData, TAG, "currData");
1938 VERIFY_NON_NULL(receivedData, TAG, "receivedData");
1940 // if error code is 4.08, do not update payload
1941 if (CA_BLOCK_INCOMPLETE == status)
1943 OIC_LOG(ERROR, TAG, "no require to update");
1944 return CA_STATUS_OK;
1947 size_t blockPayloadLen = 0;
1948 CAPayload_t blockPayload = CAGetPayloadInfo(receivedData, &blockPayloadLen);
1950 if (CA_BLOCK_TOO_LARGE == status)
1952 blockPayloadLen = (COAP_OPTION_BLOCK2 == blockType) ?
1953 BLOCK_SIZE(currData->block2.szx) : BLOCK_SIZE(currData->block1.szx);
1956 // memory allocation for the received block payload
1957 size_t prePayloadLen = currData->receivedPayloadLen;
1960 if (currData->payloadLength)
1962 // in case the block message has the size option
1963 // allocate the memory for the total payload
1966 CAPayload_t prePayload = currData->payload;
1968 OIC_LOG(DEBUG, TAG, "allocate memory for the total payload");
1969 currData->payload = (CAPayload_t) OICCalloc(1, currData->payloadLength);
1970 if (NULL == currData->payload)
1972 OIC_LOG(ERROR, TAG, "out of memory");
1973 return CA_MEMORY_ALLOC_FAILED;
1975 memcpy(currData->payload, prePayload, prePayloadLen);
1976 OICFree(prePayload);
1979 // update the total payload
1980 memcpy(currData->payload + prePayloadLen, blockPayload, blockPayloadLen);
1984 OIC_LOG(DEBUG, TAG, "allocate memory for the received block payload");
1986 size_t totalPayloadLen = prePayloadLen + blockPayloadLen;
1987 CAPayload_t newPayload = OICRealloc(currData->payload, totalPayloadLen);
1988 if (NULL == newPayload)
1990 OIC_LOG(ERROR, TAG, "out of memory");
1991 return CA_MEMORY_ALLOC_FAILED;
1994 // update the total payload
1995 memset(newPayload + prePayloadLen, 0, blockPayloadLen);
1996 currData->payload = newPayload;
1997 memcpy(currData->payload + prePayloadLen, blockPayload, blockPayloadLen);
2000 // update received payload length
2001 currData->receivedPayloadLen += blockPayloadLen;
2003 OIC_LOG_V(DEBUG, TAG, "updated payload: %s, len: %zu", currData->payload,
2004 currData->receivedPayloadLen);
2007 OIC_LOG(DEBUG, TAG, "OUT-UpdatePayloadData");
2008 return CA_STATUS_OK;
2011 CAData_t* CACreateNewDataSet(const coap_pdu_t *pdu, const CAEndpoint_t *endpoint)
2013 VERIFY_NON_NULL_RET(pdu, TAG, "pdu", NULL);
2014 VERIFY_NON_NULL_RET(pdu->transport_hdr, TAG, "pdu->transport_hdr", NULL);
2015 VERIFY_NON_NULL_RET(endpoint, TAG, "endpoint", NULL);
2017 CARequestInfo_t* requestInfo = NULL;
2018 CAResponseInfo_t* responseInfo = NULL;
2020 uint32_t code = pdu->transport_hdr->udp.code;
2021 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
2023 CAInfo_t responseData = { .tokenLength = pdu->transport_hdr->udp.token_length };
2024 responseData.token = (CAToken_t) OICMalloc(responseData.tokenLength);
2025 if (!responseData.token)
2027 OIC_LOG(ERROR, TAG, "out of memory");
2030 memcpy(responseData.token, pdu->transport_hdr->udp.token, responseData.tokenLength);
2032 responseInfo = (CAResponseInfo_t*) OICCalloc(1, sizeof(CAResponseInfo_t));
2035 OIC_LOG(ERROR, TAG, "out of memory");
2036 OICFree(responseData.token);
2039 responseInfo->info = responseData;
2043 CAInfo_t requestData = { .tokenLength = pdu->transport_hdr->udp.token_length };
2044 requestData.token = (CAToken_t) OICMalloc(requestData.tokenLength);
2045 if (!requestData.token)
2047 OIC_LOG(ERROR, TAG, "out of memory");
2050 memcpy(requestData.token, pdu->transport_hdr->udp.token, requestData.tokenLength);
2052 requestInfo = (CARequestInfo_t*) OICCalloc(1, sizeof(CARequestInfo_t));
2055 OIC_LOG(ERROR, TAG, "out of memory");
2056 OICFree(requestData.token);
2059 requestInfo->info = requestData;
2061 // get resource uri information from received response message
2062 // to send next request message to remote device
2063 CAResponseInfo_t* resInfo = (CAResponseInfo_t*)OICCalloc(1, sizeof(*resInfo));
2066 OIC_LOG(ERROR, TAG, "memory allocation failed");
2067 OICFree(requestData.token);
2071 CAGetResponseInfoFromPDU(pdu, resInfo, endpoint);
2072 requestInfo->method = CA_GET;
2073 requestInfo->info.messageId = CAGetMessageIdFromPduBinaryData(pdu->transport_hdr, pdu->length);
2074 requestInfo->info.resourceUri = OICStrdup(resInfo->info.resourceUri);
2076 // after copying the resource uri, destroy response info.
2077 CADestroyResponseInfoInternal(resInfo);
2080 CAData_t *data = (CAData_t *) OICCalloc(1, sizeof(CAData_t));
2083 OIC_LOG(ERROR, TAG, "out of memory");
2084 OICFree(requestInfo);
2085 OICFree(responseInfo);
2089 data->requestInfo = requestInfo;
2090 data->responseInfo = responseInfo;
2091 data->remoteEndpoint = CACloneEndpoint(endpoint);
2092 data->type = SEND_TYPE_UNICAST;
2097 CAData_t *CACloneCAData(const CAData_t *data)
2099 VERIFY_NON_NULL_RET(data, TAG, "data", NULL);
2101 CAData_t *clone = (CAData_t *) OICCalloc(1, sizeof(CAData_t));
2104 OIC_LOG(ERROR, TAG, "out of memory");
2109 if (data->requestInfo)
2111 clone->requestInfo = CACloneRequestInfo(data->requestInfo);
2113 else if (data->responseInfo)
2115 clone->responseInfo = CACloneResponseInfo(data->responseInfo);
2118 if (data->remoteEndpoint)
2120 clone->remoteEndpoint = CACloneEndpoint(data->remoteEndpoint);
2126 CAResult_t CAUpdatePayloadToCAData(CAData_t *data, const CAPayload_t payload,
2129 OIC_LOG(DEBUG, TAG, "IN-UpdatePayload");
2131 VERIFY_NON_NULL(data, TAG, "data is NULL");
2132 VERIFY_NON_NULL(payload, TAG, "payload is NULL");
2134 CAPayload_t newPayload = NULL;
2135 switch (data->dataType)
2137 case CA_REQUEST_DATA:
2138 if (!data->requestInfo)
2140 OIC_LOG(ERROR, TAG, "request info is null");
2141 return CA_STATUS_FAILED;
2143 // allocate payload field
2144 newPayload = OICRealloc(data->requestInfo->info.payload, payloadLen);
2147 OIC_LOG(ERROR, TAG, "out of memory");
2148 return CA_STATUS_FAILED;
2150 data->requestInfo->info.payload = newPayload;
2151 memcpy(data->requestInfo->info.payload, payload, payloadLen);
2152 data->requestInfo->info.payloadSize = payloadLen;
2155 case CA_RESPONSE_DATA:
2156 if (!data->responseInfo)
2158 OIC_LOG(ERROR, TAG, "response info is null");
2159 return CA_STATUS_FAILED;
2161 // allocate payload field
2162 newPayload = OICRealloc(data->responseInfo->info.payload, payloadLen);
2165 OIC_LOG(ERROR, TAG, "out of memory");
2166 return CA_STATUS_FAILED;
2168 data->responseInfo->info.payload = newPayload;
2169 memcpy(data->responseInfo->info.payload, payload, payloadLen);
2170 data->responseInfo->info.payloadSize = payloadLen;
2174 // does not occur case
2175 OIC_LOG(ERROR, TAG, "not supported data type");
2176 return CA_NOT_SUPPORTED;
2179 OIC_LOG(DEBUG, TAG, "OUT-UpdatePayload");
2181 return CA_STATUS_OK;
2184 CAPayload_t CAGetPayloadInfo(const CAData_t *data, size_t *payloadLen)
2186 VERIFY_NON_NULL_RET(data, TAG, "data", NULL);
2187 VERIFY_NON_NULL_RET(payloadLen, TAG, "payloadLen", NULL);
2189 if (data->requestInfo)
2191 if (data->requestInfo->info.payload)
2193 *payloadLen = data->requestInfo->info.payloadSize;
2194 return data->requestInfo->info.payload;
2199 if (data->responseInfo->info.payload)
2201 *payloadLen = data->responseInfo->info.payloadSize;
2202 return data->responseInfo->info.payload;
2209 CAResult_t CAHandleBlockErrorResponse(coap_block_t *block, uint16_t blockType,
2210 uint32_t responseResult)
2212 OIC_LOG(DEBUG, TAG, "IN-HandleBlockErrorRes");
2213 VERIFY_NON_NULL(block, TAG, "block is NULL");
2215 // update block data
2216 switch (responseResult)
2218 case CA_REQUEST_ENTITY_INCOMPLETE:
2221 case CA_REQUEST_ENTITY_TOO_LARGE:
2222 if (COAP_OPTION_BLOCK1 == blockType)
2229 OIC_LOG_V(ERROR, TAG, "there is no Error Code of BWT[%d]", responseResult);
2230 return CA_STATUS_FAILED;
2233 OIC_LOG(DEBUG, TAG, "OUT-HandleBlockErrorRes");
2234 return CA_STATUS_OK;
2237 CAResult_t CAUpdateBlockOptionType(const CABlockDataID_t *blockID, uint8_t blockType)
2239 OIC_LOG(DEBUG, TAG, "IN-UpdateBlockOptionType");
2240 VERIFY_NON_NULL(blockID, TAG, "blockID");
2242 ca_mutex_lock(g_context.blockDataListMutex);
2244 size_t len = u_arraylist_length(g_context.dataList);
2245 for (size_t i = 0; i < len; i++)
2247 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2248 if (CABlockidMatches(currData, blockID))
2250 currData->type = blockType;
2251 ca_mutex_unlock(g_context.blockDataListMutex);
2252 OIC_LOG(DEBUG, TAG, "OUT-UpdateBlockOptionType");
2253 return CA_STATUS_OK;
2256 ca_mutex_unlock(g_context.blockDataListMutex);
2258 OIC_LOG(DEBUG, TAG, "OUT-UpdateBlockOptionType");
2259 return CA_STATUS_FAILED;
2262 uint8_t CAGetBlockOptionType(const CABlockDataID_t *blockID)
2264 OIC_LOG(DEBUG, TAG, "IN-GetBlockOptionType");
2265 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", 0);
2267 ca_mutex_lock(g_context.blockDataListMutex);
2269 size_t len = u_arraylist_length(g_context.dataList);
2270 for (size_t i = 0; i < len; i++)
2272 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2273 if (CABlockidMatches(currData, blockID))
2275 ca_mutex_unlock(g_context.blockDataListMutex);
2276 OIC_LOG(DEBUG, TAG, "OUT-GetBlockOptionType");
2277 return currData->type;
2280 ca_mutex_unlock(g_context.blockDataListMutex);
2282 OIC_LOG(DEBUG, TAG, "OUT-GetBlockOptionType");
2286 CAData_t *CAGetDataSetFromBlockDataList(const CABlockDataID_t *blockID)
2288 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", NULL);
2290 ca_mutex_lock(g_context.blockDataListMutex);
2292 size_t len = u_arraylist_length(g_context.dataList);
2293 for (size_t i = 0; i < len; i++)
2295 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2296 if (CABlockidMatches(currData, blockID))
2298 ca_mutex_unlock(g_context.blockDataListMutex);
2299 return currData->sentData;
2302 ca_mutex_unlock(g_context.blockDataListMutex);
2307 CAResult_t CAGetTokenFromBlockDataList(const coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
2308 CAResponseInfo_t *responseInfo)
2310 OIC_LOG(DEBUG, TAG, "IN-CAGetTokenFromBlockDataList");
2311 VERIFY_NON_NULL(pdu, TAG, "pdu");
2312 VERIFY_NON_NULL(endpoint, TAG, "endpoint");
2313 VERIFY_NON_NULL(responseInfo, TAG, "responseInfo");
2315 ca_mutex_lock(g_context.blockDataListMutex);
2317 size_t len = u_arraylist_length(g_context.dataList);
2318 for (size_t i = 0; i < len; i++)
2320 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2321 if (NULL == currData)
2326 if (NULL != currData->sentData && NULL != currData->sentData->requestInfo)
2328 if (pdu->transport_hdr->udp.id == currData->sentData->requestInfo->info.messageId &&
2329 endpoint->adapter == currData->sentData->remoteEndpoint->adapter)
2331 if (NULL != currData->sentData->requestInfo->info.token)
2333 uint8_t length = currData->sentData->requestInfo->info.tokenLength;
2334 responseInfo->info.tokenLength = length;
2335 responseInfo->info.token = (char *) OICMalloc(length);
2336 if (NULL == responseInfo->info.token)
2338 OIC_LOG(ERROR, TAG, "out of memory");
2339 ca_mutex_unlock(g_context.blockDataListMutex);
2340 return CA_MEMORY_ALLOC_FAILED;
2342 memcpy(responseInfo->info.token, currData->sentData->requestInfo->info.token,
2343 responseInfo->info.tokenLength);
2345 ca_mutex_unlock(g_context.blockDataListMutex);
2346 OIC_LOG(DEBUG, TAG, "OUT-CAGetTokenFromBlockDataList");
2347 return CA_STATUS_OK;
2353 ca_mutex_unlock(g_context.blockDataListMutex);
2355 OIC_LOG(DEBUG, TAG, "OUT-CAGetTokenFromBlockDataList");
2356 return CA_STATUS_FAILED;
2359 CAResult_t CACheckBlockDataValidation(const CAData_t *sendData, CABlockData_t **blockData)
2361 VERIFY_NON_NULL(sendData, TAG, "sendData");
2362 VERIFY_NON_NULL(blockData, TAG, "blockData");
2364 if (sendData->responseInfo)
2366 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(
2367 (CAToken_t)sendData->responseInfo->info.token,
2368 sendData->responseInfo->info.tokenLength,
2369 sendData->remoteEndpoint->port);
2370 if (NULL == blockDataID || blockDataID->idLength < 1)
2372 OIC_LOG(ERROR, TAG, "blockId is null");
2373 CADestroyBlockID(blockDataID);
2374 return CA_STATUS_FAILED;
2377 CABlockData_t *storedData = CAGetBlockDataFromBlockDataList(blockDataID);
2380 OIC_LOG(DEBUG, TAG, "Send response about the received block request.");
2381 if (storedData->sentData)
2383 OIC_LOG(DEBUG, TAG, "init block number");
2384 CADestroyDataSet(storedData->sentData);
2386 storedData->sentData = CACloneCAData(sendData);
2387 *blockData = storedData;
2388 CADestroyBlockID(blockDataID);
2389 return CA_STATUS_OK;
2391 CADestroyBlockID(blockDataID);
2394 return CA_STATUS_FAILED;
2397 CABlockData_t *CAGetBlockDataFromBlockDataList(const CABlockDataID_t *blockID)
2399 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", NULL);
2401 ca_mutex_lock(g_context.blockDataListMutex);
2403 size_t len = u_arraylist_length(g_context.dataList);
2404 for (size_t i = 0; i < len; i++)
2406 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2407 if (CABlockidMatches(currData, blockID))
2409 ca_mutex_unlock(g_context.blockDataListMutex);
2413 ca_mutex_unlock(g_context.blockDataListMutex);
2418 coap_block_t *CAGetBlockOption(const CABlockDataID_t *blockID, uint16_t blockType)
2420 OIC_LOG(DEBUG, TAG, "IN-GetBlockOption");
2421 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", NULL);
2423 ca_mutex_lock(g_context.blockDataListMutex);
2425 size_t len = u_arraylist_length(g_context.dataList);
2426 for (size_t i = 0; i < len; i++)
2428 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2429 if (CABlockidMatches(currData, blockID))
2431 ca_mutex_unlock(g_context.blockDataListMutex);
2432 OIC_LOG(DEBUG, TAG, "OUT-GetBlockOption");
2433 if (COAP_OPTION_BLOCK2 == blockType)
2435 return &currData->block2;
2437 else if (COAP_OPTION_BLOCK1 == blockType)
2439 return &currData->block1;
2443 ca_mutex_unlock(g_context.blockDataListMutex);
2445 OIC_LOG(DEBUG, TAG, "OUT-GetBlockOption");
2449 CAPayload_t CAGetPayloadFromBlockDataList(const CABlockDataID_t *blockID,
2450 size_t *fullPayloadLen)
2452 OIC_LOG(DEBUG, TAG, "IN-GetFullPayload");
2453 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", NULL);
2454 VERIFY_NON_NULL_RET(fullPayloadLen, TAG, "fullPayloadLen", NULL);
2456 ca_mutex_lock(g_context.blockDataListMutex);
2458 size_t len = u_arraylist_length(g_context.dataList);
2459 for (size_t i = 0; i < len; i++)
2461 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2462 if (CABlockidMatches(currData, blockID))
2464 ca_mutex_unlock(g_context.blockDataListMutex);
2465 *fullPayloadLen = currData->receivedPayloadLen;
2466 OIC_LOG(DEBUG, TAG, "OUT-GetFullPayload");
2467 return currData->payload;
2470 ca_mutex_unlock(g_context.blockDataListMutex);
2472 OIC_LOG(DEBUG, TAG, "OUT-GetFullPayload");
2476 CABlockData_t *CACreateNewBlockData(const CAData_t *sendData)
2478 OIC_LOG(DEBUG, TAG, "IN-CACreateNewBlockData");
2479 VERIFY_NON_NULL_RET(sendData, TAG, "sendData", NULL);
2481 // create block data
2482 CABlockData_t *data = (CABlockData_t *) OICCalloc(1, sizeof(CABlockData_t));
2485 OIC_LOG(ERROR, TAG, "memory alloc has failed");
2489 data->block1.szx = CA_DEFAULT_BLOCK_SIZE;
2490 data->block2.szx = CA_DEFAULT_BLOCK_SIZE;
2491 data->sentData = CACloneCAData(sendData);
2492 if (!data->sentData)
2494 OIC_LOG(ERROR, TAG, PCF("memory alloc has failed"));
2499 CAToken_t token = NULL;
2500 uint8_t tokenLength = 0;
2501 if (data->sentData->requestInfo)
2503 // update token info
2504 tokenLength = data->sentData->requestInfo->info.tokenLength;
2505 token = data->sentData->requestInfo->info.token;
2507 else if (data->sentData->responseInfo)
2509 tokenLength = data->sentData->responseInfo->info.tokenLength;
2510 token = data->sentData->responseInfo->info.token;
2513 if (!data->sentData->remoteEndpoint)
2515 OIC_LOG(ERROR, TAG, "remoteEndpoint is null");
2516 CADestroyDataSet(data->sentData);
2521 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(token, tokenLength,
2522 data->sentData->remoteEndpoint->port);
2523 if (NULL == blockDataID || blockDataID->idLength < 1)
2525 OIC_LOG(ERROR, TAG, "blockId is null");
2526 CADestroyBlockID(blockDataID);
2527 CADestroyDataSet(data->sentData);
2531 data->blockDataId = blockDataID;
2533 ca_mutex_lock(g_context.blockDataListMutex);
2535 bool res = u_arraylist_add(g_context.dataList, (void *) data);
2538 OIC_LOG(ERROR, TAG, "add has failed");
2539 CADestroyBlockID(data->blockDataId);
2540 CADestroyDataSet(data->sentData);
2542 ca_mutex_unlock(g_context.blockDataListMutex);
2545 ca_mutex_unlock(g_context.blockDataListMutex);
2547 OIC_LOG(DEBUG, TAG, "OUT-CreateBlockData");
2551 CAResult_t CARemoveBlockDataFromList(const CABlockDataID_t *blockID)
2553 OIC_LOG(DEBUG, TAG, "CARemoveBlockData");
2554 VERIFY_NON_NULL(blockID, TAG, "blockID");
2556 ca_mutex_lock(g_context.blockDataListMutex);
2558 size_t len = u_arraylist_length(g_context.dataList);
2559 for (size_t i = 0; i < len; i++)
2561 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2562 if (CABlockidMatches(currData, blockID))
2564 CABlockData_t *removedData = u_arraylist_remove(g_context.dataList, i);
2567 OIC_LOG(ERROR, TAG, "data is NULL");
2568 ca_mutex_unlock(g_context.blockDataListMutex);
2569 return CA_STATUS_FAILED;
2573 CADestroyDataSet(currData->sentData);
2574 CADestroyBlockID(currData->blockDataId);
2575 OICFree(currData->payload);
2577 ca_mutex_unlock(g_context.blockDataListMutex);
2578 return CA_STATUS_OK;
2581 ca_mutex_unlock(g_context.blockDataListMutex);
2583 return CA_STATUS_OK;
2586 CAResult_t CARemoveAllBlockDataFromList()
2588 OIC_LOG(DEBUG, TAG, "CARemoveAllBlockDataFromList");
2590 ca_mutex_lock(g_context.blockDataListMutex);
2592 size_t len = u_arraylist_length(g_context.dataList);
2593 for (size_t i = len; i > 0; i--)
2595 CABlockData_t *removedData = u_arraylist_remove(g_context.dataList, i - 1);
2599 if (removedData->sentData)
2601 CADestroyDataSet(removedData->sentData);
2603 CADestroyBlockID(removedData->blockDataId);
2604 OICFree(removedData->payload);
2605 OICFree(removedData);
2608 ca_mutex_unlock(g_context.blockDataListMutex);
2610 return CA_STATUS_OK;
2613 void CADestroyDataSet(CAData_t* data)
2615 VERIFY_NON_NULL_VOID(data, TAG, "data");
2617 CAFreeEndpoint(data->remoteEndpoint);
2618 if (data->requestInfo)
2620 CADestroyRequestInfoInternal(data->requestInfo);
2622 if (data->responseInfo)
2624 CADestroyResponseInfoInternal(data->responseInfo);
2629 CABlockDataID_t* CACreateBlockDatablockId(const CAToken_t token, uint8_t tokenLength,
2630 uint16_t portNumber)
2632 char port[PORT_LENGTH] = { 0, };
2633 port[0] = (char) ((portNumber >> 8) & 0xFF);
2634 port[1] = (char) (portNumber & 0xFF);
2636 CABlockDataID_t* blockDataID = (CABlockDataID_t *) OICMalloc(sizeof(CABlockDataID_t));
2639 OIC_LOG(ERROR, TAG, "memory alloc has failed");
2642 blockDataID->idLength = tokenLength + sizeof(port);
2643 blockDataID->id = (uint8_t *) OICMalloc(blockDataID->idLength);
2644 if (!blockDataID->id)
2646 OIC_LOG(ERROR, TAG, "memory alloc has failed");
2647 OICFree(blockDataID);
2653 memcpy(blockDataID->id, token, tokenLength);
2656 memcpy(blockDataID->id + tokenLength, port, sizeof(port));
2658 OIC_LOG(DEBUG, TAG, "BlockID is ");
2659 OIC_LOG_BUFFER(DEBUG, TAG, (const uint8_t *)blockDataID->id, blockDataID->idLength);
2664 void CADestroyBlockID(CABlockDataID_t *blockID)
2666 VERIFY_NON_NULL_VOID(blockID, TAG, "blockID");
2667 OICFree(blockID->id);
2672 bool CABlockidMatches(const CABlockData_t *currData, const CABlockDataID_t *blockID)
2674 VERIFY_NON_NULL_RET(currData, TAG, "currData", false);
2675 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", false);
2676 VERIFY_NON_NULL_RET(blockID->id, TAG, "blockID->id", false);
2678 if ((currData->blockDataId)
2679 && (currData->blockDataId->id)
2680 && (currData->blockDataId->idLength == blockID->idLength)
2681 && !memcmp(currData->blockDataId->id, blockID->id, currData->blockDataId->idLength))
2688 void CALogBlockInfo(coap_block_t *block)
2690 VERIFY_NON_NULL_VOID(block, TAG, "block");
2692 OIC_LOG(DEBUG, TAG, "block option info");
2694 OIC_LOG_V(DEBUG, TAG, "block option-num : %d", block->num);
2696 OIC_LOG_V(DEBUG, TAG, "block option-m : %d", block->m);
2698 OIC_LOG_V(DEBUG, TAG, "block option-szx : %d", block->szx);
2701 CAResult_t CARemoveBlockDataFromListWithSeed(const CAToken_t token, uint8_t tokenLength,
2702 uint16_t portNumber)
2704 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(token, tokenLength, portNumber);
2705 if (NULL == blockDataID || blockDataID->idLength < 1)
2707 OIC_LOG(ERROR, TAG, "blockId is null");
2708 CADestroyBlockID(blockDataID);
2709 return CA_STATUS_FAILED;
2712 CAResult_t res = CA_STATUS_OK;
2714 if (NULL != CAGetBlockDataFromBlockDataList(blockDataID))
2716 res = CARemoveBlockDataFromList(blockDataID);
2717 if (CA_STATUS_OK != res)
2719 OIC_LOG(ERROR, TAG, "CARemoveBlockDataFromList failed");
2723 CADestroyBlockID(blockDataID);