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"
48 #define TAG "OIC_CA_BWT"
50 #define BLOCKWISE_OPTION_BUFFER (sizeof(unsigned int))
51 #define BLOCK_NUMBER_IDX 4
52 #define BLOCK_M_BIT_IDX 3
55 #define BLOCK_SIZE(arg) (1 << ((arg) + 4))
57 #define BLOCK_DATA_TIMEOUT_SECONDS (60 * 1) // 1 minutes.
58 static const uint64_t USECS_PER_SEC = 1000000;
60 // context for block-wise transfer
61 static CABlockWiseContext_t g_context = { .sendThreadFunc = NULL,
62 .receivedThreadFunc = NULL,
65 static bool CACheckPayloadLength(const CAData_t *sendData)
67 size_t payloadLen = 0;
68 CAGetPayloadInfo(sendData, &payloadLen);
70 // check if message has to be transfered to a block
71 size_t maxBlockSize = BLOCK_SIZE(CA_DEFAULT_BLOCK_SIZE);
72 OIC_LOG_V(DEBUG, TAG, "payloadLen=%zu, maxBlockSize=%zu", payloadLen, maxBlockSize);
74 if (payloadLen <= maxBlockSize)
82 CAResult_t CAInitializeBlockWiseTransfer(CASendThreadFunc sendThreadFunc,
83 CAReceiveThreadFunc receivedThreadFunc)
85 OIC_LOG(DEBUG, TAG, "CAInitializeBlockWiseTransfer");
87 // set block-wise transfer context
88 if (!g_context.sendThreadFunc)
90 g_context.sendThreadFunc = sendThreadFunc;
93 if (!g_context.receivedThreadFunc)
95 g_context.receivedThreadFunc = receivedThreadFunc;
98 if (!g_context.dataList)
100 g_context.dataList = u_arraylist_create();
103 CAResult_t res = CAInitBlockWiseMutexVariables();
104 if (CA_STATUS_OK != res)
106 u_arraylist_free(&g_context.dataList);
107 g_context.dataList = NULL;
108 OIC_LOG(ERROR, TAG, "init has failed");
114 CAResult_t CATerminateBlockWiseTransfer()
116 OIC_LOG(DEBUG, TAG, "CATerminateBlockWiseTransfer");
118 if (g_context.dataList)
120 CARemoveAllBlockDataFromList();
121 u_arraylist_free(&g_context.dataList);
124 CATerminateBlockWiseMutexVariables();
129 CAResult_t CAInitBlockWiseMutexVariables()
131 if (!g_context.blockDataListMutex)
133 g_context.blockDataListMutex = oc_mutex_new();
134 if (!g_context.blockDataListMutex)
136 OIC_LOG(ERROR, TAG, "oc_mutex_new has failed");
137 return CA_STATUS_FAILED;
141 if (!g_context.blockDataSenderMutex)
143 g_context.blockDataSenderMutex = oc_mutex_new();
144 if (!g_context.blockDataSenderMutex)
146 OIC_LOG(ERROR, TAG, "oc_mutex_new has failed");
147 CATerminateBlockWiseMutexVariables();
148 return CA_STATUS_FAILED;
155 void CATerminateBlockWiseMutexVariables()
157 if (g_context.blockDataListMutex)
159 oc_mutex_free(g_context.blockDataListMutex);
160 g_context.blockDataListMutex = NULL;
163 if (g_context.blockDataSenderMutex)
165 oc_mutex_free(g_context.blockDataSenderMutex);
166 g_context.blockDataSenderMutex = NULL;
170 CAResult_t CASendBlockWiseData(const CAData_t *sendData)
172 VERIFY_NON_NULL(sendData, TAG, "sendData");
174 // check if message type is CA_MSG_RESET
175 if (sendData->requestInfo)
177 if (CA_MSG_RESET == sendData->requestInfo->info.type)
179 OIC_LOG(DEBUG, TAG, "reset message can't be sent to the block");
180 return CA_NOT_SUPPORTED;
184 * Other uses of the Block options in conjunction with multicast
185 * messages are for further study.
187 if (sendData->requestInfo->isMulticast)
189 OIC_LOG(DEBUG, TAG, "multicast message can't be sent to the block");
190 return CA_NOT_SUPPORTED;
193 else if (sendData->responseInfo)
195 if (CA_MSG_RESET == sendData->responseInfo->info.type)
197 OIC_LOG(DEBUG, TAG, "reset message can't be sent to the block");
198 return CA_NOT_SUPPORTED;
200 if (sendData->responseInfo->isMulticast)
202 OIC_LOG(DEBUG, TAG, "multicast message can't be sent to the block");
203 return CA_NOT_SUPPORTED;
207 // #1. check if it is already included in block data list
208 CABlockData_t *currData = NULL;
209 CAResult_t res = CACheckBlockDataValidation(sendData, &currData);
210 if (CA_STATUS_OK != res)
212 // #2. if it is not included, add the data into list
215 OIC_LOG(DEBUG, TAG, "There is no block data");
217 bool isBlock = CACheckPayloadLength(sendData);
220 if (sendData->requestInfo)
222 currData = CACreateNewBlockData(sendData);
225 OIC_LOG(ERROR, TAG, "failed to create block data");
226 return CA_MEMORY_ALLOC_FAILED;
229 return CA_NOT_SUPPORTED;
231 currData = CACreateNewBlockData(sendData);
234 OIC_LOG(ERROR, TAG, "failed to create block data");
235 return CA_MEMORY_ALLOC_FAILED;
240 // #3. check request/response block option type and payload length
241 res = CACheckBlockOptionType(currData);
242 if (CA_STATUS_OK == res)
244 // #4. send block message
245 OIC_LOG(DEBUG, TAG, "send first block msg");
246 res = CAAddSendThreadQueue(currData->sentData,
247 (const CABlockDataID_t *) &currData->blockDataId);
248 if (CA_STATUS_OK != res)
250 OIC_LOG(ERROR, TAG, "add has failed");
258 CAResult_t CAAddSendThreadQueue(const CAData_t *sendData, const CABlockDataID_t *blockID)
260 VERIFY_NON_NULL(sendData, TAG, "sendData");
261 VERIFY_NON_NULL(blockID, TAG, "blockID");
263 CAData_t *cloneData = CACloneCAData(sendData);
266 OIC_LOG(ERROR, TAG, "clone has failed");
267 CARemoveBlockDataFromList(blockID);
268 return CA_STATUS_FAILED;
271 if (g_context.sendThreadFunc)
273 oc_mutex_lock(g_context.blockDataSenderMutex);
274 g_context.sendThreadFunc(cloneData);
275 oc_mutex_unlock(g_context.blockDataSenderMutex);
279 CADestroyDataSet(cloneData);
284 CAResult_t CACheckBlockOptionType(CABlockData_t *currData)
286 VERIFY_NON_NULL(currData, TAG, "currData");
287 VERIFY_NON_NULL(currData->sentData, TAG, "currData->sentData");
289 bool isBlock = CACheckPayloadLength(currData->sentData);
292 return CA_NOT_SUPPORTED;
295 // set block option (COAP_OPTION_BLOCK2 or COAP_OPTION_BLOCK1)
296 if (currData->sentData->requestInfo) // request message
298 currData->type = COAP_OPTION_BLOCK1;
300 else // response message
302 currData->type = COAP_OPTION_BLOCK2;
308 // TODO make pdu const after libcoap is updated to support that.
309 CAResult_t CAReceiveBlockWiseData(coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
310 const CAData_t *receivedData, size_t dataLen)
312 OIC_LOG(DEBUG, TAG, "CAReceiveBlockWiseData");
313 VERIFY_NON_NULL(pdu, TAG, "pdu");
314 VERIFY_NON_NULL(pdu->transport_hdr, TAG, "pdu->transport_hdr");
315 VERIFY_NON_NULL(endpoint, TAG, "endpoint");
316 VERIFY_NON_NULL(receivedData, TAG, "receivedData");
318 // check if received message type is CA_MSG_RESET
319 if (CA_EMPTY == pdu->transport_hdr->udp.code)
321 OIC_LOG(DEBUG, TAG, "code is CA_EMPTY..");
323 if (!receivedData->responseInfo->info.token)
325 // get token from block-wise transfer list when CA_EMPTY(RST/ACK) is received
326 CAResult_t res = CAGetTokenFromBlockDataList(pdu, endpoint,
327 receivedData->responseInfo);
328 if (CA_STATUS_OK != res)
330 OIC_LOG(ERROR, TAG, "fail to get token");
335 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(
336 receivedData->responseInfo->info.token,
337 receivedData->responseInfo->info.tokenLength,
339 if (NULL == blockDataID || blockDataID->idLength < 1)
341 // if retransmission is timeout, callback msg will be send without token.
342 if (NULL == blockDataID && !receivedData->responseInfo->info.token)
344 OIC_LOG(INFO, TAG, "retransmission was stopped");
345 return CA_REQUEST_TIMEOUT;
348 OIC_LOG(ERROR, TAG, "blockId is null");
349 CADestroyBlockID(blockDataID);
350 return CA_STATUS_FAILED;
353 // If we didn't send the last block message and received EMPTY message,
354 // we have to remain the block data from list.
355 CABlockData_t *data = CAGetBlockDataFromBlockDataList(blockDataID);
356 if (data && (data->block1.m || data->block2.m))
358 OIC_LOG(DEBUG, TAG, "this is normal EMPTY message for blockwise-transfer.");
359 CADestroyBlockID(blockDataID);
363 CARemoveBlockDataFromList(blockDataID);
364 CADestroyBlockID(blockDataID);
365 return CA_NOT_SUPPORTED;
368 // check if block option is set and get block data
369 coap_block_t block = { 0, 0, 0 };
372 int isBlock1 = coap_get_block(pdu, COAP_OPTION_BLOCK1, &block);
375 CAResult_t res = CASetNextBlockOption1(pdu, endpoint, receivedData, block, dataLen);
376 if (CA_STATUS_OK != res)
378 OIC_LOG(ERROR, TAG, "setting has failed");
384 int isBlock2 = coap_get_block(pdu, COAP_OPTION_BLOCK2, &block);
387 CAResult_t res = CASetNextBlockOption2(pdu, endpoint, receivedData, block, dataLen);
388 if (CA_STATUS_OK != res)
390 OIC_LOG(ERROR, TAG, "setting has failed");
395 // if there is no block option in pdu, check if there is error code.
396 if (!isBlock1 && !isBlock2)
398 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(
399 (CAToken_t)pdu->transport_hdr->udp.token,
400 pdu->transport_hdr->udp.token_length,
402 if (NULL == blockDataID || blockDataID->idLength < 1)
404 OIC_LOG(ERROR, TAG, "blockId is null");
405 CADestroyBlockID(blockDataID);
406 return CA_STATUS_FAILED;
409 uint32_t code = CA_RESPONSE_CODE(pdu->transport_hdr->udp.code);
410 if (CA_REQUEST_ENTITY_INCOMPLETE == code)
412 CABlockData_t *data = CAGetBlockDataFromBlockDataList(blockDataID);
415 OIC_LOG(ERROR, TAG, "getting has failed");
416 CADestroyBlockID(blockDataID);
417 return CA_STATUS_FAILED;
420 coap_block_t *block = CAGetBlockOption(blockDataID, data->type);
423 OIC_LOG(ERROR, TAG, "block is null");
424 CADestroyBlockID(blockDataID);
425 return CA_STATUS_FAILED;
428 CAResult_t res = CA_STATUS_OK;
429 if (COAP_OPTION_BLOCK2 == data->type)
431 res = CASetNextBlockOption2(pdu, endpoint, receivedData, *block, dataLen);
432 if (CA_STATUS_OK != res)
434 OIC_LOG(ERROR, TAG, "setting has failed");
435 CADestroyBlockID(blockDataID);
436 return CA_STATUS_FAILED;
439 else if (COAP_OPTION_BLOCK1 == data->type)
441 res = CASetNextBlockOption1(pdu, endpoint, receivedData, *block, dataLen);
442 if (CA_STATUS_OK != res)
444 OIC_LOG(ERROR, TAG, "setting has failed");
445 CADestroyBlockID(blockDataID);
449 CADestroyBlockID(blockDataID);
454 OIC_LOG(DEBUG, TAG, "it's normal pdu");
456 // if received data is response message
457 // and sent data remain in block data list, remove block data
458 if (receivedData->responseInfo)
460 CARemoveBlockDataFromList(blockDataID);
462 CADestroyBlockID(blockDataID);
463 return CA_NOT_SUPPORTED;
469 CAResult_t CAProcessNextStep(const coap_pdu_t *pdu, const CAData_t *receivedData,
470 uint8_t blockWiseStatus, const CABlockDataID_t *blockID)
472 VERIFY_NON_NULL(pdu, TAG, "pdu");
473 VERIFY_NON_NULL(pdu->hdr, TAG, "pdu->hdr");
474 VERIFY_NON_NULL(blockID, TAG, "blockID");
476 CAResult_t res = CA_STATUS_OK;
477 CAData_t *data = NULL;
479 // process blockWiseStatus
480 switch (blockWiseStatus)
482 case CA_OPTION2_FIRST_BLOCK:
483 res = CAAddSendThreadQueue(receivedData, blockID);
484 if (CA_STATUS_OK != res)
486 OIC_LOG(ERROR, TAG, "add has failed");
491 case CA_OPTION2_REQUEST:
492 // add data to send thread
493 data = CAGetDataSetFromBlockDataList(blockID);
496 OIC_LOG(ERROR, TAG, "it's unavailable");
497 return CA_STATUS_FAILED;
500 if (data->responseInfo)
502 data->responseInfo->info.type =
503 (pdu->transport_hdr->udp.type == CA_MSG_CONFIRM) ?
504 CA_MSG_ACKNOWLEDGE : CA_MSG_NONCONFIRM;
505 data->responseInfo->info.messageId = pdu->transport_hdr->udp.id;
507 res = CAAddSendThreadQueue(data, blockID);
508 if (CA_STATUS_OK != res)
510 OIC_LOG(ERROR, TAG, "add has failed");
516 case CA_OPTION1_RESPONSE:
517 case CA_OPTION2_RESPONSE:
518 case CA_OPTION1_REQUEST_BLOCK:
519 res = CASendBlockMessage(pdu, pdu->transport_hdr->udp.type, blockID);
520 if (CA_STATUS_OK != res)
522 OIC_LOG(ERROR, TAG, "send has failed");
527 case CA_OPTION2_LAST_BLOCK:
528 // process last block and send upper layer
529 res = CAReceiveLastBlock(blockID, receivedData);
530 if (CA_STATUS_OK != res)
532 OIC_LOG(ERROR, TAG, "receive has failed");
536 // remove data from list
537 res = CARemoveBlockDataFromList(blockID);
538 if (CA_STATUS_OK != res)
540 OIC_LOG(ERROR, TAG, "remove has failed");
545 case CA_OPTION1_REQUEST_LAST_BLOCK:
546 // process last block and send upper layer
547 res = CAReceiveLastBlock(blockID, receivedData);
548 if (CA_STATUS_OK != res)
550 OIC_LOG(ERROR, TAG, "receive has failed");
555 case CA_BLOCK_INCOMPLETE:
556 // add data to send thread
557 res = CASendErrorMessage(pdu, blockWiseStatus, CA_REQUEST_ENTITY_INCOMPLETE, blockID);
558 if (CA_STATUS_OK != res)
560 OIC_LOG(ERROR, TAG, "send has failed");
565 case CA_BLOCK_TOO_LARGE:
566 if (receivedData->requestInfo)
568 res = CASendErrorMessage(pdu, blockWiseStatus, CA_REQUEST_ENTITY_TOO_LARGE,
570 if (CA_STATUS_OK != res)
572 OIC_LOG(ERROR, TAG, "send has failed");
576 else if (receivedData->responseInfo)
578 res = CASendBlockMessage(pdu, pdu->transport_hdr->udp.type, blockID);
579 if (CA_STATUS_OK != res)
581 OIC_LOG(ERROR, TAG, "send has failed");
587 OIC_LOG_V(ERROR, TAG, "no logic [%d]", blockWiseStatus);
592 static CAResult_t CASendDirectEmptyResponse(const CAEndpoint_t *endpoint, uint16_t messageId)
594 OIC_LOG(DEBUG, TAG, "Entering CASendDirectEmptyResponse");
595 CAResponseInfo_t respInfo = {
598 respInfo.info.type = CA_MSG_ACKNOWLEDGE;
599 respInfo.info.messageId = messageId;
600 respInfo.info.dataType = CA_RESPONSE_DATA;
602 CAResult_t caResult = CASendResponse(endpoint, &respInfo);
604 OIC_LOG(DEBUG, TAG, "Exit CASendDirectEmptyResponse");
608 CAResult_t CASendBlockMessage(const coap_pdu_t *pdu, CAMessageType_t msgType,
609 const CABlockDataID_t *blockID)
611 VERIFY_NON_NULL(pdu, TAG, "pdu");
612 VERIFY_NON_NULL(pdu->transport_hdr, TAG, "pdu->transport_hdr");
613 VERIFY_NON_NULL(blockID, TAG, "blockID");
615 CAData_t *data = CAGetDataSetFromBlockDataList(blockID);
618 OIC_LOG(ERROR, TAG, "CAData is unavailable");
619 return CA_STATUS_FAILED;
622 CAMessageType_t sentMsgType = CA_MSG_NONCONFIRM;
626 sentMsgType = CA_MSG_ACKNOWLEDGE;
628 case CA_MSG_ACKNOWLEDGE:
629 sentMsgType = CA_MSG_CONFIRM;
632 sentMsgType = CA_MSG_NONCONFIRM;
636 uint32_t code = pdu->transport_hdr->udp.code;
637 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
639 if (data->responseInfo)
641 OIC_LOG(DEBUG, TAG, "set response info");
642 data->responseInfo->info.messageId = pdu->transport_hdr->udp.id;
643 data->responseInfo->info.type = sentMsgType;
644 data->responseInfo->result = CA_CONTINUE;
649 if (data->requestInfo)
651 // if the received response message type is CON, send empty message.
652 // and then, send next block request message with new messagId.
653 if (msgType == CA_MSG_CONFIRM)
655 CASendDirectEmptyResponse(data->remoteEndpoint,
656 data->requestInfo->info.messageId);
657 sentMsgType = CA_MSG_CONFIRM;
660 OIC_LOG(DEBUG, TAG, "need new msgID");
661 data->requestInfo->info.messageId = 0;
662 data->requestInfo->info.type = sentMsgType;
664 else if (data->responseInfo)
666 data->responseInfo->info.messageId = pdu->transport_hdr->udp.id;
667 data->responseInfo->info.type = sentMsgType;
671 // add data to send thread
672 CAResult_t res = CAAddSendThreadQueue(data, blockID);
673 if (CA_STATUS_OK != res)
675 OIC_LOG(ERROR, TAG, "add has failed");
681 CAResult_t CASendErrorMessage(const coap_pdu_t *pdu, uint8_t status,
682 CAResponseResult_t responseResult, const CABlockDataID_t *blockID)
684 VERIFY_NON_NULL(pdu, TAG, "pdu");
685 VERIFY_NON_NULL(pdu->transport_hdr, TAG, "pdu->transport_hdr");
686 VERIFY_NON_NULL(blockID, TAG, "blockID");
688 // create error responseInfo
689 CABlockData_t *data = CAGetBlockDataFromBlockDataList(blockID);
692 OIC_LOG(ERROR, TAG, "data is unavailable");
693 return CA_STATUS_FAILED;
698 OIC_LOG(ERROR, TAG, "data has no sent-data");
699 return CA_STATUS_FAILED;
702 CAData_t *cloneData = CACloneCAData(data->sentData);
705 OIC_LOG(ERROR, TAG, "clone has failed");
706 return CA_MEMORY_ALLOC_FAILED;
709 CAMessageType_t sentMsgType = CA_MSG_NONCONFIRM;
710 switch (pdu->transport_hdr->udp.type)
713 sentMsgType = CA_MSG_ACKNOWLEDGE;
715 case CA_MSG_ACKNOWLEDGE:
716 sentMsgType = CA_MSG_CONFIRM;
719 sentMsgType = CA_MSG_NONCONFIRM;
722 if (cloneData->responseInfo)
724 cloneData->responseInfo->info.messageId = pdu->transport_hdr->udp.id;
725 cloneData->responseInfo->info.type = sentMsgType;
726 cloneData->responseInfo->result = responseResult;
730 CAInfo_t responseData = { .tokenLength = pdu->transport_hdr->udp.token_length };
731 responseData.token = (CAToken_t) OICMalloc(responseData.tokenLength);
732 if (!responseData.token)
734 OIC_LOG(ERROR, TAG, "out of memory");
735 CADestroyDataSet(cloneData);
736 return CA_MEMORY_ALLOC_FAILED;
738 memcpy(responseData.token, pdu->transport_hdr->udp.token, responseData.tokenLength);
740 cloneData->responseInfo = (CAResponseInfo_t*) OICCalloc(1, sizeof(CAResponseInfo_t));
741 if (!cloneData->responseInfo)
743 OIC_LOG(ERROR, TAG, "out of memory");
744 CADestroyDataSet(cloneData);
745 OICFree(responseData.token);
746 return CA_MEMORY_ALLOC_FAILED;
749 cloneData->responseInfo->info = responseData;
750 cloneData->responseInfo->info.type = sentMsgType;
751 cloneData->responseInfo->result = responseResult;
754 OIC_LOG(DEBUG, TAG, "set response message to send error code");
756 // if there is a requestInfo, remove it to send response message
757 if (cloneData->requestInfo)
759 CADestroyRequestInfoInternal(cloneData->requestInfo);
760 cloneData->requestInfo = NULL;
763 // add data to send thread
764 if (g_context.sendThreadFunc)
766 oc_mutex_lock(g_context.blockDataSenderMutex);
767 g_context.sendThreadFunc(cloneData);
768 oc_mutex_unlock(g_context.blockDataSenderMutex);
772 CADestroyDataSet(cloneData);
775 // if error code is 4.08, remove the stored payload and initialize block number
776 if (CA_BLOCK_INCOMPLETE == status)
778 OICFree(data->payload);
779 data->payload = NULL;
780 data->payloadLength = 0;
781 data->receivedPayloadLen = 0;
782 data->block1.num = 0;
783 data->block2.num = 0;
789 CAResult_t CAReceiveLastBlock(const CABlockDataID_t *blockID, const CAData_t *receivedData)
791 VERIFY_NON_NULL(blockID, TAG, "blockID");
792 VERIFY_NON_NULL(receivedData, TAG, "receivedData");
794 // total block data have to notify to Application
795 CAData_t *cloneData = CACloneCAData(receivedData);
798 OIC_LOG(ERROR, TAG, "clone has failed");
799 return CA_MEMORY_ALLOC_FAILED;
803 size_t fullPayloadLen = 0;
804 CAPayload_t fullPayload = CAGetPayloadFromBlockDataList(blockID, &fullPayloadLen);
807 CAResult_t res = CAUpdatePayloadToCAData(cloneData, fullPayload, fullPayloadLen);
808 if (CA_STATUS_OK != res)
810 OIC_LOG(ERROR, TAG, "update has failed");
811 CADestroyDataSet(cloneData);
816 if (g_context.receivedThreadFunc)
818 g_context.receivedThreadFunc(cloneData);
822 CADestroyDataSet(cloneData);
828 static CABlockData_t* CACheckTheExistOfBlockData(const CABlockDataID_t* blockDataID,
829 coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
832 // Get BlockData data. If does not exist, create a new data
833 CABlockData_t *data = CAGetBlockDataFromBlockDataList(blockDataID);
836 OIC_LOG(DEBUG, TAG, "block data doesn't exist in list. create new one");
838 CAData_t *cadata = CACreateNewDataSet(pdu, endpoint);
841 OIC_LOG(ERROR, TAG, "data is null");
845 data = CACreateNewBlockData(cadata);
848 OIC_LOG(ERROR, TAG, "failed to create a new block data");
849 CADestroyDataSet(cadata);
852 CADestroyDataSet(cadata);
855 // update BLOCK OPTION type
856 CAResult_t res = CAUpdateBlockOptionType(blockDataID, blockType);
857 if (CA_STATUS_OK != res)
859 OIC_LOG(ERROR, TAG, "update has failed");
866 // TODO make pdu const after libcoap is updated to support that.
867 CAResult_t CASetNextBlockOption1(coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
868 const CAData_t *receivedData, coap_block_t block,
871 OIC_LOG(INFO, TAG, "CASetNextBlockOption1");
872 VERIFY_NON_NULL(pdu, TAG, "pdu");
873 VERIFY_NON_NULL(pdu->transport_hdr, TAG, "pdu->transport_hdr");
874 VERIFY_NON_NULL(endpoint, TAG, "endpoint");
875 VERIFY_NON_NULL(receivedData, TAG, "receivedData");
877 OIC_LOG_V(INFO, TAG, "num:%d, M:%d, sze:%d", block.num, block.m, block.szx);
879 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(
880 (CAToken_t)pdu->transport_hdr->udp.token,
881 pdu->transport_hdr->udp.token_length,
883 if (NULL == blockDataID || blockDataID->idLength < 1)
885 OIC_LOG(ERROR, TAG, "blockId is null");
886 CADestroyBlockID(blockDataID);
887 return CA_STATUS_FAILED;
890 CAResult_t res = CA_STATUS_OK;
891 CABlockData_t *data = CACheckTheExistOfBlockData(blockDataID, pdu, endpoint,
895 OIC_LOG(ERROR, TAG, "Failed to create or get block data");
896 res = CA_STATUS_FAILED;
900 uint8_t blockWiseStatus = CA_BLOCK_UNKNOWN;
901 uint32_t code = pdu->transport_hdr->udp.code;
902 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
904 // received message type is request
905 OIC_LOG_V(INFO, TAG, "num:%d, M:%d", block.num, block.m);
907 // check the size option
908 bool isSizeOption = CAIsPayloadLengthInPduWithBlockSizeOption(pdu, COAP_OPTION_SIZE1,
909 &(data->payloadLength));
911 blockWiseStatus = CACheckBlockErrorType(data, &block, receivedData,
912 COAP_OPTION_BLOCK1, dataLen);
914 if (CA_BLOCK_RECEIVED_ALREADY != blockWiseStatus)
916 // store the received payload and merge
917 res = CAUpdatePayloadData(data, receivedData, blockWiseStatus,
918 isSizeOption, COAP_OPTION_BLOCK1);
919 if (CA_STATUS_OK != res)
921 OIC_LOG(ERROR, TAG, "update has failed");
925 res = CAUpdateBlockOptionItems(data, pdu, &block, COAP_OPTION_BLOCK1,
927 if (CA_STATUS_OK != res)
929 OIC_LOG(ERROR, TAG, "update has failed");
934 res = CAUpdateBlockData(data, block, COAP_OPTION_BLOCK1);
935 if (CA_STATUS_OK != res)
937 OIC_LOG(ERROR, TAG, "update has failed");
942 // check the blcok-wise transfer status for next step
943 if (CA_BLOCK_UNKNOWN == blockWiseStatus || CA_BLOCK_RECEIVED_ALREADY == blockWiseStatus)
945 OIC_LOG_V(DEBUG, TAG, "M bit is %d", block.m);
947 blockWiseStatus = (0 == block.m) ?
948 CA_OPTION1_REQUEST_LAST_BLOCK : CA_OPTION1_REQUEST_BLOCK;
953 // received message type is response
954 uint32_t code = CA_RESPONSE_CODE(pdu->transport_hdr->udp.code);
955 if (0 == block.m && (CA_REQUEST_ENTITY_INCOMPLETE != code
956 && CA_REQUEST_ENTITY_TOO_LARGE != code))
958 int isBlock2 = coap_get_block(pdu, COAP_OPTION_BLOCK2, &block);
961 OIC_LOG(INFO, TAG, "received data is combining block1 and block2");
962 // initialize block number for response message
963 data->block1.num = 0;
964 CADestroyBlockID(blockDataID);
969 OIC_LOG(INFO, TAG, "received data is not bulk data");
970 CAReceiveLastBlock(blockDataID, receivedData);
976 blockWiseStatus = CA_OPTION1_RESPONSE;
977 res = CAUpdateBlockOptionItems(data, pdu, &block, COAP_OPTION_BLOCK1, blockWiseStatus);
978 if (CA_STATUS_OK != res)
980 OIC_LOG(ERROR, TAG, "update has failed");
981 CADestroyBlockID(blockDataID);
985 res = CAUpdateBlockData(data, block, COAP_OPTION_BLOCK1);
986 if (CA_STATUS_OK != res)
988 OIC_LOG(ERROR, TAG, "update has failed");
993 res = CAProcessNextStep(pdu, receivedData, blockWiseStatus, blockDataID);
994 if (CA_STATUS_OK != res)
996 OIC_LOG(ERROR, TAG, "setting has failed");
1000 CADestroyBlockID(blockDataID);
1004 CARemoveBlockDataFromList(blockDataID);
1005 CADestroyBlockID(blockDataID);
1009 // TODO make pdu const after libcoap is updated to support that.
1010 CAResult_t CASetNextBlockOption2(coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
1011 const CAData_t *receivedData, coap_block_t block,
1014 OIC_LOG(DEBUG, TAG, "CASetNextBlockOption2");
1015 OIC_LOG_V(INFO, TAG, "num:%d, M:%d, sze:%d", block.num, block.m, block.szx);
1017 VERIFY_NON_NULL(pdu, TAG, "pdu");
1018 VERIFY_NON_NULL(pdu->transport_hdr, TAG, "pdu->transport_hdr");
1019 VERIFY_NON_NULL(endpoint, TAG, "endpoint");
1020 VERIFY_NON_NULL(receivedData, TAG, "receivedData");
1022 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(
1023 (CAToken_t)pdu->transport_hdr->udp.token,
1024 pdu->transport_hdr->udp.token_length,
1026 if (NULL == blockDataID || blockDataID->idLength < 1)
1028 OIC_LOG(ERROR, TAG, "blockId is null");
1029 CADestroyBlockID(blockDataID);
1030 return CA_STATUS_FAILED;
1033 CAResult_t res = CA_STATUS_OK;
1034 CABlockData_t *data = CACheckTheExistOfBlockData(blockDataID, pdu, endpoint,
1035 COAP_OPTION_BLOCK2);
1038 OIC_LOG(ERROR, TAG, "Failed to create or get block data");
1039 res = CA_STATUS_FAILED;
1043 uint8_t blockWiseStatus = CA_BLOCK_UNKNOWN;
1044 if (0 == block.num && CA_GET == pdu->transport_hdr->udp.code && 0 == block.m)
1046 OIC_LOG(INFO, TAG, "first block number");
1048 res = CAUpdateBlockOptionItems(data, pdu, &block, COAP_OPTION_BLOCK2, blockWiseStatus);
1049 if (CA_STATUS_OK != res)
1051 OIC_LOG(ERROR, TAG, "update has failed");
1055 // first block data have to notify to Application
1056 res = CAUpdateBlockData(data, block, COAP_OPTION_BLOCK2);
1057 if (CA_STATUS_OK != res)
1059 OIC_LOG(ERROR, TAG, "update has failed");
1062 blockWiseStatus = CA_OPTION2_FIRST_BLOCK;
1066 uint32_t code = pdu->transport_hdr->udp.code;
1067 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
1069 // received message type is request
1070 OIC_LOG_V(INFO, TAG, "num:%d, M:%d", block.num, block.m);
1072 blockWiseStatus = CA_OPTION2_REQUEST;
1074 res = CAUpdateBlockOptionItems(data, pdu, &block, COAP_OPTION_BLOCK2, blockWiseStatus);
1075 if (CA_STATUS_OK != res)
1077 OIC_LOG(ERROR, TAG, "update has failed");
1081 res = CAUpdateBlockData(data, block, COAP_OPTION_BLOCK2);
1082 if (CA_STATUS_OK != res)
1084 OIC_LOG(ERROR, TAG, "update has failed");
1090 // received message type is response
1091 OIC_LOG(DEBUG, TAG, "received response message with block option2");
1093 // check the size option
1094 bool isSizeOption = CAIsPayloadLengthInPduWithBlockSizeOption(pdu,
1096 &(data->payloadLength));
1098 uint32_t code = CA_RESPONSE_CODE(pdu->transport_hdr->udp.code);
1099 if (CA_REQUEST_ENTITY_INCOMPLETE != code && CA_REQUEST_ENTITY_TOO_LARGE != code)
1101 // check if received payload is exact
1102 blockWiseStatus = CACheckBlockErrorType(data, &block, receivedData,
1103 COAP_OPTION_BLOCK2, dataLen);
1106 if (CA_BLOCK_RECEIVED_ALREADY != blockWiseStatus)
1108 // store the received payload and merge
1109 res = CAUpdatePayloadData(data, receivedData, blockWiseStatus,
1110 isSizeOption, COAP_OPTION_BLOCK2);
1111 if (CA_STATUS_OK != res)
1113 OIC_LOG(ERROR, TAG, "update has failed");
1118 if (0 == block.m && CA_BLOCK_UNKNOWN == blockWiseStatus) // Last block is received
1120 OIC_LOG(DEBUG, TAG, "M bit is 0");
1121 blockWiseStatus = CA_OPTION2_LAST_BLOCK;
1123 else if(CA_BLOCK_RECEIVED_ALREADY == blockWiseStatus)// If already received no need to update block option items.
1125 OIC_LOG(DEBUG, TAG, "Already Received : M bit is 1");
1126 blockWiseStatus = CA_OPTION2_RESPONSE;
1130 if (CA_BLOCK_UNKNOWN == blockWiseStatus)
1132 OIC_LOG(DEBUG, TAG, "M bit is 1");
1133 blockWiseStatus = CA_OPTION2_RESPONSE;
1136 res = CAUpdateBlockOptionItems(data, pdu, &block, COAP_OPTION_BLOCK2,
1138 if (CA_STATUS_OK != res)
1140 OIC_LOG(ERROR, TAG, "update has failed");
1144 res = CAUpdateBlockData(data, block, COAP_OPTION_BLOCK2);
1145 if (CA_STATUS_OK != res)
1147 OIC_LOG(ERROR, TAG, "update has failed");
1154 res = CAProcessNextStep(pdu, receivedData, blockWiseStatus, blockDataID);
1155 if (CA_STATUS_OK != res)
1157 OIC_LOG(ERROR, TAG, "setting has failed");
1161 CADestroyBlockID(blockDataID);
1162 return CA_STATUS_OK;
1165 CARemoveBlockDataFromList(blockDataID);
1166 CADestroyBlockID(blockDataID);
1170 CAResult_t CAUpdateBlockOptionItems(CABlockData_t *currData, const coap_pdu_t *pdu,
1171 coap_block_t *block, uint16_t blockType,
1174 VERIFY_NON_NULL(currData, TAG, "currData");
1175 VERIFY_NON_NULL(pdu, TAG, "pdu");
1176 VERIFY_NON_NULL(pdu->transport_hdr, TAG, "pdu->transport_hdr");
1177 VERIFY_NON_NULL(block, TAG, "block");
1179 // update block data
1180 CAResult_t res = CA_STATUS_OK;
1181 uint32_t code = CA_RESPONSE_CODE(pdu->transport_hdr->udp.code);
1183 if (CA_REQUEST_ENTITY_INCOMPLETE == code || CA_REQUEST_ENTITY_TOO_LARGE == code)
1185 // response error code of the received block message
1186 res = CAHandleBlockErrorResponse(block, blockType, code);
1187 if (CA_STATUS_OK != res)
1189 OIC_LOG(ERROR, TAG, "error handle has failed");
1195 // update block option items
1198 case CA_OPTION1_RESPONSE:
1199 if (currData->block1.num > block->num)
1201 OIC_LOG(ERROR, TAG, "received incorrect block num");
1202 return CA_STATUS_FAILED;
1206 case CA_OPTION2_REQUEST:
1209 case CA_OPTION2_RESPONSE:
1210 if (currData->block2.num > block->num)
1212 OIC_LOG(ERROR, TAG, "received incorrect block num");
1213 return CA_STATUS_FAILED;
1218 case CA_BLOCK_TOO_LARGE:
1219 // if state of received block message is CA_BLOCK_TOO_LARGE or CA_BLOCK_INCOMPLETE
1220 // we set the response error code appropriately and send
1221 if (COAP_OPTION_BLOCK2 == blockType)
1225 block->szx = currData->block2.szx;
1229 block->szx = currData->block1.szx;
1233 OIC_LOG_V(ERROR, TAG, "no logic [%d]", status);
1236 if (CA_BLOCK_INCOMPLETE != status && CA_BLOCK_TOO_LARGE != status)
1238 // negotiate block size
1239 res = CANegotiateBlockSize(currData, block, pdu, blockType);
1240 if (CA_STATUS_OK != res)
1242 OIC_LOG(ERROR, TAG, "negotiation has failed");
1250 CAResult_t CASetMoreBitFromBlock(size_t payloadLen, coap_block_t *block)
1252 VERIFY_NON_NULL(block, TAG, "block");
1254 if ((size_t) ((block->num + 1) << (block->szx + BLOCK_NUMBER_IDX)) < payloadLen)
1256 OIC_LOG(DEBUG, TAG, "Set the M-bit(1)");
1261 OIC_LOG(DEBUG, TAG, "Set the M-bit(0)");
1265 return CA_STATUS_OK;
1268 CAResult_t CANegotiateBlockSize(CABlockData_t *currData, coap_block_t *block,
1269 const coap_pdu_t *pdu, uint16_t blockType)
1271 OIC_LOG(DEBUG, TAG, "IN-NegotiateBlockSize");
1273 VERIFY_NON_NULL(currData, TAG, "currData");
1274 VERIFY_NON_NULL(block, TAG, "block");
1275 VERIFY_NON_NULL(pdu, TAG, "pdu");
1276 VERIFY_NON_NULL(pdu->transport_hdr, TAG, "pdu->transport_hdr");
1278 bool isReqMsg = false;
1279 uint32_t code = pdu->transport_hdr->udp.code;
1280 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
1285 // #1. check the block option type
1286 if (COAP_OPTION_BLOCK2 == blockType)
1288 // #2. check the message type
1291 if (block->szx > currData->block2.szx)
1293 OIC_LOG(DEBUG, TAG, "sze is big");
1295 // #3. calculate new block number from block size
1296 unsigned int blockNum = BLOCK_SIZE(block->szx) /
1297 BLOCK_SIZE(currData->block2.szx) - 1;
1298 OIC_LOG(DEBUG, TAG, "num is set as Negotiation");
1299 block->num += blockNum;
1300 block->szx = currData->block2.szx;
1301 OIC_LOG_V(DEBUG, TAG, "updated block num: %d", block->num);
1306 if (block->szx > currData->block2.szx)
1308 OIC_LOG(DEBUG, TAG, "sze is big");
1309 block->szx = currData->block2.szx;
1313 else if (COAP_OPTION_BLOCK1 == blockType)
1317 if (block->szx < currData->block1.szx)
1319 OIC_LOG(DEBUG, TAG, "sze is small");
1321 unsigned int blockNum = BLOCK_SIZE(currData->block1.szx) /
1322 BLOCK_SIZE(block->szx) - 1;
1323 block->num += blockNum;
1324 OIC_LOG_V(DEBUG, TAG, "updated block num: %d", block->num);
1329 if (block->szx > currData->block1.szx)
1331 OIC_LOG(DEBUG, TAG, "sze is big");
1332 block->szx = currData->block1.szx;
1338 OIC_LOG(DEBUG, TAG, "Invalid block option");
1339 return CA_STATUS_FAILED;
1342 OIC_LOG(DEBUG, TAG, "OUT-NegotiateBlockSize");
1344 return CA_STATUS_OK;
1347 CAResult_t CAUpdateBlockData(CABlockData_t *currData, coap_block_t block,
1350 VERIFY_NON_NULL(currData, TAG, "currData");
1352 // check if block size is bigger than CABlockSize_t
1353 if (block.szx > CA_BLOCK_SIZE_1024_BYTE)
1355 OIC_LOG(DEBUG, TAG, "invalid block szx");
1356 return CA_STATUS_FAILED;
1359 // update block option
1360 if (COAP_OPTION_BLOCK2 == blockType)
1362 currData->block2 = block;
1366 currData->block1 = block;
1369 OIC_LOG(DEBUG, TAG, "data has updated");
1370 return CA_STATUS_OK;
1373 CAResult_t CAUpdateMessageId(coap_pdu_t *pdu, const CABlockDataID_t *blockID)
1375 VERIFY_NON_NULL(pdu, TAG, "pdu");
1376 VERIFY_NON_NULL(pdu->transport_hdr, TAG, "pdu->transport_hdr");
1377 VERIFY_NON_NULL(blockID, TAG, "blockID");
1379 // if message is sent, update messageId in block-wise transfer list
1380 CAData_t * cadata = CAGetDataSetFromBlockDataList(blockID);
1383 OIC_LOG(ERROR, TAG, "CAData is unavailable");
1384 return CA_STATUS_FAILED;
1387 if (cadata->requestInfo)
1389 cadata->requestInfo->info.messageId = pdu->transport_hdr->udp.id;
1392 return CA_STATUS_OK;
1395 CAResult_t CAAddBlockOption(coap_pdu_t **pdu, const CAInfo_t *info,
1396 const CAEndpoint_t *endpoint, coap_list_t **options)
1398 OIC_LOG(DEBUG, TAG, "IN-AddBlockOption");
1399 VERIFY_NON_NULL(pdu, TAG, "pdu");
1400 VERIFY_NON_NULL((*pdu), TAG, "(*pdu)");
1401 VERIFY_NON_NULL((*pdu)->transport_hdr, TAG, "(*pdu)->transport_hdr");
1402 VERIFY_NON_NULL(info, TAG, "info");
1403 VERIFY_NON_NULL(endpoint, TAG, "endpoint");
1404 VERIFY_NON_NULL(options, TAG, "options");
1406 CAResult_t res = CA_STATUS_OK;
1407 size_t dataLength = 0;
1410 dataLength = info->payloadSize;
1411 OIC_LOG_V(DEBUG, TAG, "dataLength - %zu", dataLength);
1414 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(
1415 (CAToken_t)(*pdu)->transport_hdr->udp.token,
1416 (*pdu)->transport_hdr->udp.token_length,
1418 if (NULL == blockDataID || blockDataID->idLength < 1)
1420 OIC_LOG(ERROR, TAG, "blockId is null");
1421 res = CA_STATUS_FAILED;
1425 uint32_t repCode = CA_RESPONSE_CODE((*pdu)->transport_hdr->udp.code);
1426 if (CA_REQUEST_ENTITY_INCOMPLETE == repCode)
1428 OIC_LOG(INFO, TAG, "don't use option");
1433 uint8_t blockType = CAGetBlockOptionType(blockDataID);
1434 if (COAP_OPTION_BLOCK2 == blockType)
1436 res = CAAddBlockOption2(pdu, info, dataLength, blockDataID, options);
1437 if (CA_STATUS_OK != res)
1439 OIC_LOG(ERROR, TAG, "add has failed");
1443 else if (COAP_OPTION_BLOCK1 == blockType)
1445 res = CAAddBlockOption1(pdu, info, dataLength, blockDataID, options);
1446 if (CA_STATUS_OK != res)
1448 OIC_LOG(ERROR, TAG, "add has failed");
1454 OIC_LOG(DEBUG, TAG, "no BLOCK option");
1456 // in case it is not large data, add option list to pdu.
1459 for (coap_list_t *opt = *options; opt; opt = opt->next)
1461 OIC_LOG_V(DEBUG, TAG, "[%s] opt will be added.",
1462 COAP_OPTION_DATA(*(coap_option *) opt->data));
1463 OIC_LOG_V(DEBUG, TAG, "[%d] pdu length", (*pdu)->length);
1465 if (0 == coap_add_option(*pdu, COAP_OPTION_KEY(*(coap_option *) opt->data),
1466 COAP_OPTION_LENGTH(*(coap_option *) opt->data),
1467 COAP_OPTION_DATA(*(coap_option *) opt->data)))
1469 OIC_LOG(ERROR, TAG, "coap_add_option has failed");
1470 res = CA_STATUS_FAILED;
1475 OIC_LOG_V(DEBUG, TAG, "[%d] pdu length after option", (*pdu)->length);
1477 // if response data is so large. it have to send as block transfer
1478 if (!coap_add_data(*pdu, dataLength, (const unsigned char *) info->payload))
1480 OIC_LOG(INFO, TAG, "it has to use block");
1481 res = CA_STATUS_FAILED;
1486 OIC_LOG(INFO, TAG, "not Blockwise Transfer");
1490 uint32_t code = (*pdu)->transport_hdr->udp.code;
1491 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
1493 // if received message type is RESET from remote device,
1494 // we have to use the updated message id of request message to find token.
1495 CABlockData_t *blockData = CAGetBlockDataFromBlockDataList(blockDataID);
1498 res = CAUpdateMessageId(*pdu, blockDataID);
1499 if (CA_STATUS_OK != res)
1501 OIC_LOG(ERROR, TAG, "fail to update message id");
1507 CAResetBlockDataTTL(blockDataID);
1509 CADestroyBlockID(blockDataID);
1510 OIC_LOG(DEBUG, TAG, "OUT-AddBlockOption");
1514 CAResult_t CAAddBlockOption2(coap_pdu_t **pdu, const CAInfo_t *info, size_t dataLength,
1515 const CABlockDataID_t *blockID, coap_list_t **options)
1517 OIC_LOG(DEBUG, TAG, "IN-AddBlockOption2");
1518 VERIFY_NON_NULL(pdu, TAG, "pdu");
1519 VERIFY_NON_NULL((*pdu), TAG, "(*pdu)");
1520 VERIFY_NON_NULL((*pdu)->transport_hdr, TAG, "(*pdu)->transport_hdr");
1521 VERIFY_NON_NULL(info, TAG, "info");
1522 VERIFY_NON_NULL(blockID, TAG, "blockID");
1523 VERIFY_NON_NULL(options, TAG, "options");
1525 // get set block data from CABlock list-set.
1526 coap_block_t *block1 = CAGetBlockOption(blockID, COAP_OPTION_BLOCK1);
1527 coap_block_t *block2 = CAGetBlockOption(blockID, COAP_OPTION_BLOCK2);
1528 if (!block1 || !block2)
1530 OIC_LOG(ERROR, TAG, "getting has failed");
1531 return CA_STATUS_FAILED;
1534 CAResult_t res = CA_STATUS_OK;
1535 uint32_t code = (*pdu)->transport_hdr->udp.code;
1536 if (CA_GET != code && CA_POST != code && CA_PUT != code && CA_DELETE != code)
1538 CASetMoreBitFromBlock(dataLength, block2);
1540 // if block number is 0, add size2 option
1541 if (0 == block2->num)
1543 res = CAAddBlockSizeOption(*pdu, COAP_OPTION_SIZE2, dataLength, options);
1544 if (CA_STATUS_OK != res)
1546 OIC_LOG(ERROR, TAG, "add has failed");
1551 res = CAAddBlockOptionImpl(block2, COAP_OPTION_BLOCK2, options);
1552 if (CA_STATUS_OK != res)
1554 OIC_LOG(ERROR, TAG, "add has failed");
1560 OIC_LOG(DEBUG, TAG, "combining block1 and block2");
1561 res = CAAddBlockOptionImpl(block1, COAP_OPTION_BLOCK1, options);
1562 if (CA_STATUS_OK != res)
1564 OIC_LOG(ERROR, TAG, "add has failed");
1567 // initialize block number
1571 res = CAAddOptionToPDU(*pdu, options);
1572 if (CA_STATUS_OK != res)
1574 OIC_LOG(ERROR, TAG, "add has failed");
1578 if (!coap_add_block(*pdu, dataLength, (const unsigned char *) info->payload,
1579 block2->num, block2->szx))
1581 OIC_LOG(ERROR, TAG, "Data length is smaller than the start index");
1582 return CA_STATUS_FAILED;
1585 CALogBlockInfo(block2);
1589 // if sent message is last response block message, remove data
1590 CARemoveBlockDataFromList(blockID);
1595 OIC_LOG(DEBUG, TAG, "option2, not response msg");
1596 res = CAAddBlockOptionImpl(block2, COAP_OPTION_BLOCK2, options);
1597 if (CA_STATUS_OK != res)
1599 OIC_LOG(ERROR, TAG, "add has failed");
1603 res = CAAddOptionToPDU(*pdu, options);
1604 if (CA_STATUS_OK != res)
1606 OIC_LOG(ERROR, TAG, "add has failed");
1609 CALogBlockInfo(block2);
1612 return CA_STATUS_OK;
1615 CARemoveBlockDataFromList(blockID);
1619 CAResult_t CAAddBlockOption1(coap_pdu_t **pdu, const CAInfo_t *info, size_t dataLength,
1620 const CABlockDataID_t *blockID, coap_list_t **options)
1622 OIC_LOG(DEBUG, TAG, "IN-AddBlockOption1");
1623 VERIFY_NON_NULL(pdu, TAG, "pdu");
1624 VERIFY_NON_NULL((*pdu), TAG, "(*pdu)");
1625 VERIFY_NON_NULL((*pdu)->transport_hdr, TAG, "(*pdu)->transport_hdr");
1626 VERIFY_NON_NULL(info, TAG, "info");
1627 VERIFY_NON_NULL(blockID, TAG, "blockID");
1628 VERIFY_NON_NULL(options, TAG, "options");
1630 // get set block data from CABlock list-set.
1631 coap_block_t *block1 = CAGetBlockOption(blockID, COAP_OPTION_BLOCK1);
1634 OIC_LOG(ERROR, TAG, "getting has failed");
1635 return CA_STATUS_FAILED;
1638 CAResult_t res = CA_STATUS_OK;
1639 uint32_t code = (*pdu)->transport_hdr->udp.code;
1640 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
1642 CASetMoreBitFromBlock(dataLength, block1);
1644 // if block number is 0, add size1 option
1645 if (0 == block1->num)
1647 res = CAAddBlockSizeOption(*pdu, COAP_OPTION_SIZE1, dataLength, options);
1648 if (CA_STATUS_OK != res)
1650 OIC_LOG(ERROR, TAG, "add has failed");
1655 // add block option to option list.
1656 res = CAAddBlockOptionImpl(block1, COAP_OPTION_BLOCK1, options);
1657 if (CA_STATUS_OK != res)
1659 OIC_LOG(ERROR, TAG, "add has failed");
1663 // add option list to pdu.
1664 res = CAAddOptionToPDU(*pdu, options);
1665 if (CA_STATUS_OK != res)
1667 OIC_LOG(ERROR, TAG, "add has failed");
1671 // add the payload data as the block size.
1672 if (!coap_add_block(*pdu, dataLength, (const unsigned char *) info->payload, block1->num,
1675 OIC_LOG(ERROR, TAG, "Data length is smaller than the start index");
1676 return CA_STATUS_FAILED;
1681 OIC_LOG(DEBUG, TAG, "received response message with block option1");
1683 // add block option to option list.
1684 res = CAAddBlockOptionImpl(block1, COAP_OPTION_BLOCK1, options);
1685 if (CA_STATUS_OK != res)
1687 OIC_LOG(ERROR, TAG, "add has failed");
1691 // add option list to pdu.
1692 res = CAAddOptionToPDU(*pdu, options);
1693 if (CA_STATUS_OK != res)
1695 OIC_LOG(ERROR, TAG, "add has failed");
1699 // add the payload data as the block size.
1700 if (!coap_add_data(*pdu, dataLength, (const unsigned char *) info->payload))
1702 OIC_LOG(ERROR, TAG, "failed to add payload");
1703 return CA_STATUS_FAILED;
1706 // if it is last block message, remove block data from list.
1709 // remove data from list
1710 res = CARemoveBlockDataFromList(blockID);
1711 if (CA_STATUS_OK != res)
1713 OIC_LOG(ERROR, TAG, "remove has failed");
1719 CALogBlockInfo(block1);
1721 OIC_LOG(DEBUG, TAG, "OUT-AddBlockOption1");
1723 return CA_STATUS_OK;
1726 CARemoveBlockDataFromList(blockID);
1730 CAResult_t CAAddBlockOptionImpl(coap_block_t *block, uint8_t blockType,
1731 coap_list_t **options)
1733 OIC_LOG(DEBUG, TAG, "IN-AddBlockOptionImpl");
1734 VERIFY_NON_NULL(block, TAG, "block");
1735 VERIFY_NON_NULL(options, TAG, "options");
1737 unsigned char buf[BLOCKWISE_OPTION_BUFFER] = { 0 };
1738 unsigned int optionLength = coap_encode_var_bytes(buf,
1739 ((block->num << BLOCK_NUMBER_IDX)
1740 | (block->m << BLOCK_M_BIT_IDX)
1743 int ret = coap_insert(options,
1744 CACreateNewOptionNode(blockType, optionLength, (char *) buf),
1748 return CA_STATUS_INVALID_PARAM;
1751 OIC_LOG(DEBUG, TAG, "OUT-AddBlockOptionImpl");
1752 return CA_STATUS_OK;
1755 CAResult_t CAAddOptionToPDU(coap_pdu_t *pdu, coap_list_t **options)
1757 // after adding the block option to option list, add option list to pdu.
1760 for (coap_list_t *opt = *options; opt; opt = opt->next)
1762 OIC_LOG_V(DEBUG, TAG, "[%s] opt will be added.",
1763 COAP_OPTION_DATA(*(coap_option *) opt->data));
1765 OIC_LOG_V(DEBUG, TAG, "[%d] pdu length", pdu->length);
1766 int ret = coap_add_option(pdu, COAP_OPTION_KEY(*(coap_option *) opt->data),
1767 COAP_OPTION_LENGTH(*(coap_option *) opt->data),
1768 COAP_OPTION_DATA(*(coap_option *) opt->data));
1771 return CA_STATUS_FAILED;
1776 OIC_LOG_V(DEBUG, TAG, "[%d] pdu length after option", pdu->length);
1778 return CA_STATUS_OK;
1781 CAResult_t CAAddBlockSizeOption(coap_pdu_t *pdu, uint16_t sizeType, size_t dataLength,
1782 coap_list_t **options)
1784 OIC_LOG(DEBUG, TAG, "IN-CAAddBlockSizeOption");
1785 VERIFY_NON_NULL(pdu, TAG, "pdu");
1786 VERIFY_NON_NULL(options, TAG, "options");
1788 if (sizeType != COAP_OPTION_SIZE1 && sizeType != COAP_OPTION_SIZE2)
1790 OIC_LOG(ERROR, TAG, "unknown option type");
1791 return CA_STATUS_FAILED;
1794 unsigned char value[BLOCKWISE_OPTION_BUFFER] = { 0 };
1795 unsigned int optionLength = coap_encode_var_bytes(value, dataLength);
1797 int ret = coap_insert(options,
1798 CACreateNewOptionNode(sizeType, optionLength, (char *) value),
1802 return CA_STATUS_INVALID_PARAM;
1805 OIC_LOG(DEBUG, TAG, "OUT-CAAddBlockSizeOption");
1807 return CA_STATUS_OK;
1810 // TODO make pdu const after libcoap is updated to support that.
1811 bool CAIsPayloadLengthInPduWithBlockSizeOption(coap_pdu_t *pdu,
1813 size_t *totalPayloadLen)
1815 OIC_LOG(DEBUG, TAG, "IN-CAIsPayloadLengthInPduWithBlockSizeOption");
1816 VERIFY_NON_NULL(pdu, TAG, "pdu");
1817 VERIFY_NON_NULL(totalPayloadLen, TAG, "totalPayloadLen");
1819 if (sizeType != COAP_OPTION_SIZE1 && sizeType != COAP_OPTION_SIZE2)
1821 OIC_LOG(ERROR, TAG, "unknown option type");
1822 return CA_STATUS_FAILED;
1825 coap_opt_iterator_t opt_iter;
1826 coap_opt_t *option = coap_check_option(pdu, sizeType, &opt_iter);
1829 OIC_LOG(DEBUG, TAG, "get size option from pdu");
1830 *totalPayloadLen = coap_decode_var_bytes(COAP_OPT_VALUE(option),
1831 COAP_OPT_LENGTH(option));
1833 OIC_LOG_V(DEBUG, TAG, "the total payload length to be received is [%zu]bytes",
1839 OIC_LOG(DEBUG, TAG, "OUT-CAIsPayloadLengthInPduWithBlockSizeOption");
1844 uint8_t CACheckBlockErrorType(CABlockData_t *currData, coap_block_t *receivedBlock,
1845 const CAData_t *receivedData, uint16_t blockType,
1848 OIC_LOG(DEBUG, TAG, "IN-CheckBlockError");
1850 VERIFY_NON_NULL(currData, TAG, "currData is NULL");
1851 VERIFY_NON_NULL(receivedBlock, TAG, "receivedBlock is NULL");
1852 VERIFY_NON_NULL(receivedData, TAG, "receivedData is NULL");
1854 // #1. check the received payload length
1855 size_t blockPayloadLen = 0;
1856 CAGetPayloadInfo(receivedData, &blockPayloadLen);
1858 // #2. check if the block sequence is right
1859 if (COAP_OPTION_BLOCK1 == blockType)
1861 size_t prePayloadLen = currData->receivedPayloadLen;
1862 if (prePayloadLen != (size_t) BLOCK_SIZE(receivedBlock->szx) * receivedBlock->num)
1864 if (receivedBlock->num > currData->block1.num + 1)
1866 // 408 Error handling of block loss
1867 OIC_LOG(ERROR, TAG, "option1: error 4.08");
1868 OIC_LOG(ERROR, TAG, "it didn't order");
1869 return CA_BLOCK_INCOMPLETE;
1871 return CA_BLOCK_RECEIVED_ALREADY;
1874 else if (COAP_OPTION_BLOCK2 == blockType)
1876 if (receivedBlock->num != currData->block2.num)
1878 if (receivedBlock->num > currData->block2.num)
1880 // 408 Error handling of block loss
1881 OIC_LOG(ERROR, TAG, "option2: error 4.08");
1882 OIC_LOG(ERROR, TAG, "it didn't order");
1883 return CA_BLOCK_INCOMPLETE;
1887 OIC_LOG(ERROR, TAG, "already received this block");
1888 return CA_BLOCK_RECEIVED_ALREADY;
1893 // #3. check if error check logic is required
1894 size_t optionLen = dataLen - blockPayloadLen;
1895 if (receivedBlock->m && blockPayloadLen != (size_t) BLOCK_SIZE(receivedBlock->szx))
1897 // 413 Error handling of too large entity
1898 if (COAP_MAX_PDU_SIZE < BLOCK_SIZE(receivedBlock->szx) + optionLen)
1900 // buffer size is smaller than received block size
1901 OIC_LOG(ERROR, TAG, "error type 4.13");
1902 OIC_LOG(ERROR, TAG, "too large size");
1904 // set the block size to be smaller than COAP_MAX_PDU_SIZE
1905 for (int32_t size = CA_DEFAULT_BLOCK_SIZE; size >= 0; size--)
1907 if (COAP_MAX_PDU_SIZE >= BLOCK_SIZE(size) + optionLen)
1909 OIC_LOG_V(ERROR, TAG, "replace sze with %d", size);
1910 currData->block2.szx = size;
1911 currData->block1.szx = size;
1915 return CA_BLOCK_TOO_LARGE;
1919 // 408 Error handling of payload loss
1920 OIC_LOG(ERROR, TAG, "error type 4.08");
1921 OIC_LOG(ERROR, TAG, "payload len != block sze");
1922 return CA_BLOCK_INCOMPLETE;
1925 else if (0 == receivedBlock->m && 0 != currData->payloadLength)
1927 // if the received block is last block, check the total payload length
1928 size_t receivedPayloadLen = currData->receivedPayloadLen;
1929 receivedPayloadLen += blockPayloadLen;
1931 if (receivedPayloadLen != currData->payloadLength)
1933 OIC_LOG(ERROR, TAG, "error type 4.08");
1934 OIC_LOG(ERROR, TAG, "total payload length is wrong");
1935 return CA_BLOCK_INCOMPLETE;
1939 OIC_LOG(DEBUG, TAG, "received all data normally");
1941 OIC_LOG(DEBUG, TAG, "OUT-CheckBlockError");
1943 return CA_BLOCK_UNKNOWN;
1946 CAResult_t CAUpdatePayloadData(CABlockData_t *currData, const CAData_t *receivedData,
1947 uint8_t status, bool isSizeOption, uint16_t blockType)
1949 OIC_LOG(DEBUG, TAG, "IN-UpdatePayloadData");
1951 VERIFY_NON_NULL(currData, TAG, "currData");
1952 VERIFY_NON_NULL(receivedData, TAG, "receivedData");
1954 // if error code is 4.08, do not update payload
1955 if (CA_BLOCK_INCOMPLETE == status)
1957 OIC_LOG(ERROR, TAG, "no require to update");
1958 return CA_STATUS_OK;
1961 size_t blockPayloadLen = 0;
1962 CAPayload_t blockPayload = CAGetPayloadInfo(receivedData, &blockPayloadLen);
1964 if (CA_BLOCK_TOO_LARGE == status)
1966 blockPayloadLen = (COAP_OPTION_BLOCK2 == blockType) ?
1967 BLOCK_SIZE(currData->block2.szx) : BLOCK_SIZE(currData->block1.szx);
1970 // memory allocation for the received block payload
1971 size_t prePayloadLen = currData->receivedPayloadLen;
1974 if (currData->payloadLength)
1976 // in case the block message has the size option
1977 // allocate the memory for the total payload
1980 CAPayload_t prePayload = currData->payload;
1982 OIC_LOG(DEBUG, TAG, "allocate memory for the total payload");
1983 currData->payload = (CAPayload_t) OICCalloc(1, currData->payloadLength);
1984 if (NULL == currData->payload)
1986 OIC_LOG(ERROR, TAG, "out of memory");
1987 return CA_MEMORY_ALLOC_FAILED;
1989 memcpy(currData->payload, prePayload, prePayloadLen);
1990 OICFree(prePayload);
1993 // update the total payload
1994 memcpy(currData->payload + prePayloadLen, blockPayload, blockPayloadLen);
1998 OIC_LOG(DEBUG, TAG, "allocate memory for the received block payload");
2000 size_t totalPayloadLen = prePayloadLen + blockPayloadLen;
2001 CAPayload_t newPayload = OICRealloc(currData->payload, totalPayloadLen);
2002 if (NULL == newPayload)
2004 OIC_LOG(ERROR, TAG, "out of memory");
2005 return CA_MEMORY_ALLOC_FAILED;
2008 // update the total payload
2009 memset(newPayload + prePayloadLen, 0, blockPayloadLen);
2010 currData->payload = newPayload;
2011 memcpy(currData->payload + prePayloadLen, blockPayload, blockPayloadLen);
2014 // update received payload length
2015 currData->receivedPayloadLen += blockPayloadLen;
2017 OIC_LOG_V(DEBUG, TAG, "updated payload: %s, len: %zu", currData->payload,
2018 currData->receivedPayloadLen);
2021 OIC_LOG(DEBUG, TAG, "OUT-UpdatePayloadData");
2022 return CA_STATUS_OK;
2025 CAData_t* CACreateNewDataSet(const coap_pdu_t *pdu, const CAEndpoint_t *endpoint)
2027 VERIFY_NON_NULL_RET(pdu, TAG, "pdu", NULL);
2028 VERIFY_NON_NULL_RET(pdu->transport_hdr, TAG, "pdu->transport_hdr", NULL);
2029 VERIFY_NON_NULL_RET(endpoint, TAG, "endpoint", NULL);
2031 CARequestInfo_t* requestInfo = NULL;
2032 CAResponseInfo_t* responseInfo = NULL;
2034 uint32_t code = pdu->transport_hdr->udp.code;
2035 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
2037 CAInfo_t responseData = { .tokenLength = pdu->transport_hdr->udp.token_length };
2038 responseData.token = (CAToken_t) OICMalloc(responseData.tokenLength);
2039 if (!responseData.token)
2041 OIC_LOG(ERROR, TAG, "out of memory");
2044 memcpy(responseData.token, pdu->transport_hdr->udp.token, responseData.tokenLength);
2046 responseInfo = (CAResponseInfo_t*) OICCalloc(1, sizeof(CAResponseInfo_t));
2049 OIC_LOG(ERROR, TAG, "out of memory");
2050 OICFree(responseData.token);
2053 responseInfo->info = responseData;
2057 CAInfo_t requestData = { .tokenLength = pdu->transport_hdr->udp.token_length };
2058 requestData.token = (CAToken_t) OICMalloc(requestData.tokenLength);
2059 if (!requestData.token)
2061 OIC_LOG(ERROR, TAG, "out of memory");
2064 memcpy(requestData.token, pdu->transport_hdr->udp.token, requestData.tokenLength);
2066 requestInfo = (CARequestInfo_t*) OICCalloc(1, sizeof(CARequestInfo_t));
2069 OIC_LOG(ERROR, TAG, "out of memory");
2070 OICFree(requestData.token);
2073 requestInfo->info = requestData;
2075 // get resource uri information from received response message
2076 // to send next request message to remote device
2077 CAResponseInfo_t* resInfo = (CAResponseInfo_t*)OICCalloc(1, sizeof(*resInfo));
2080 OIC_LOG(ERROR, TAG, "memory allocation failed");
2081 OICFree(requestData.token);
2082 OICFree(requestInfo);
2086 CAGetResponseInfoFromPDU(pdu, resInfo, endpoint);
2087 requestInfo->method = CA_GET;
2088 requestInfo->info.messageId = CAGetMessageIdFromPduBinaryData(pdu->transport_hdr,
2090 requestInfo->info.resourceUri = OICStrdup(resInfo->info.resourceUri);
2092 // after copying the resource uri, destroy response info.
2093 CADestroyResponseInfoInternal(resInfo);
2096 CAData_t *data = (CAData_t *) OICCalloc(1, sizeof(CAData_t));
2099 OIC_LOG(ERROR, TAG, "out of memory");
2100 if (NULL != requestInfo)
2102 OICFree(requestInfo->info.resourceUri);
2103 OICFree(requestInfo->info.token);
2104 OICFree(requestInfo);
2106 if (NULL != responseInfo)
2108 OICFree(responseInfo->info.token);
2109 OICFree(responseInfo);
2114 data->requestInfo = requestInfo;
2115 data->responseInfo = responseInfo;
2116 data->remoteEndpoint = CACloneEndpoint(endpoint);
2117 data->type = SEND_TYPE_UNICAST;
2122 CAData_t *CACloneCAData(const CAData_t *data)
2124 VERIFY_NON_NULL_RET(data, TAG, "data", NULL);
2126 CAData_t *clone = (CAData_t *) OICCalloc(1, sizeof(CAData_t));
2129 OIC_LOG(ERROR, TAG, "out of memory");
2134 if (data->requestInfo)
2136 clone->requestInfo = CACloneRequestInfo(data->requestInfo);
2138 else if (data->responseInfo)
2140 clone->responseInfo = CACloneResponseInfo(data->responseInfo);
2143 if (data->remoteEndpoint)
2145 clone->remoteEndpoint = CACloneEndpoint(data->remoteEndpoint);
2151 CAResult_t CAUpdatePayloadToCAData(CAData_t *data, const CAPayload_t payload,
2154 OIC_LOG(DEBUG, TAG, "IN-UpdatePayload");
2156 VERIFY_NON_NULL(data, TAG, "data is NULL");
2157 VERIFY_NON_NULL(payload, TAG, "payload is NULL");
2159 CAPayload_t newPayload = NULL;
2160 switch (data->dataType)
2162 case CA_REQUEST_DATA:
2163 if (!data->requestInfo)
2165 OIC_LOG(ERROR, TAG, "request info is null");
2166 return CA_STATUS_FAILED;
2168 // allocate payload field
2169 newPayload = OICRealloc(data->requestInfo->info.payload, payloadLen);
2172 OIC_LOG(ERROR, TAG, "out of memory");
2173 return CA_STATUS_FAILED;
2175 data->requestInfo->info.payload = newPayload;
2176 memcpy(data->requestInfo->info.payload, payload, payloadLen);
2177 data->requestInfo->info.payloadSize = payloadLen;
2180 case CA_RESPONSE_DATA:
2181 if (!data->responseInfo)
2183 OIC_LOG(ERROR, TAG, "response info is null");
2184 return CA_STATUS_FAILED;
2186 // allocate payload field
2187 newPayload = OICRealloc(data->responseInfo->info.payload, payloadLen);
2190 OIC_LOG(ERROR, TAG, "out of memory");
2191 return CA_STATUS_FAILED;
2193 data->responseInfo->info.payload = newPayload;
2194 memcpy(data->responseInfo->info.payload, payload, payloadLen);
2195 data->responseInfo->info.payloadSize = payloadLen;
2199 // does not occur case
2200 OIC_LOG(ERROR, TAG, "not supported data type");
2201 return CA_NOT_SUPPORTED;
2204 OIC_LOG(DEBUG, TAG, "OUT-UpdatePayload");
2206 return CA_STATUS_OK;
2209 CAPayload_t CAGetPayloadInfo(const CAData_t *data, size_t *payloadLen)
2211 VERIFY_NON_NULL_RET(data, TAG, "data", NULL);
2212 VERIFY_NON_NULL_RET(payloadLen, TAG, "payloadLen", NULL);
2214 if (data->requestInfo)
2216 if (data->requestInfo->info.payload)
2218 *payloadLen = data->requestInfo->info.payloadSize;
2219 return data->requestInfo->info.payload;
2222 else if (data->responseInfo)
2224 if (data->responseInfo->info.payload)
2226 *payloadLen = data->responseInfo->info.payloadSize;
2227 return data->responseInfo->info.payload;
2234 CAResult_t CAHandleBlockErrorResponse(coap_block_t *block, uint16_t blockType,
2235 uint32_t responseResult)
2237 OIC_LOG(DEBUG, TAG, "IN-HandleBlockErrorRes");
2238 VERIFY_NON_NULL(block, TAG, "block is NULL");
2240 // update block data
2241 switch (responseResult)
2243 case CA_REQUEST_ENTITY_INCOMPLETE:
2246 case CA_REQUEST_ENTITY_TOO_LARGE:
2247 if (COAP_OPTION_BLOCK1 == blockType)
2254 OIC_LOG_V(ERROR, TAG, "there is no Error Code of BWT[%d]", responseResult);
2255 return CA_STATUS_FAILED;
2258 OIC_LOG(DEBUG, TAG, "OUT-HandleBlockErrorRes");
2259 return CA_STATUS_OK;
2262 CAResult_t CAUpdateBlockOptionType(const CABlockDataID_t *blockID, uint8_t blockType)
2264 OIC_LOG(DEBUG, TAG, "IN-UpdateBlockOptionType");
2265 VERIFY_NON_NULL(blockID, TAG, "blockID");
2267 oc_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 currData->type = blockType;
2276 oc_mutex_unlock(g_context.blockDataListMutex);
2277 OIC_LOG(DEBUG, TAG, "OUT-UpdateBlockOptionType");
2278 return CA_STATUS_OK;
2281 oc_mutex_unlock(g_context.blockDataListMutex);
2283 OIC_LOG(DEBUG, TAG, "OUT-UpdateBlockOptionType");
2284 return CA_STATUS_FAILED;
2287 uint8_t CAGetBlockOptionType(const CABlockDataID_t *blockID)
2289 OIC_LOG(DEBUG, TAG, "IN-GetBlockOptionType");
2290 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", 0);
2292 oc_mutex_lock(g_context.blockDataListMutex);
2294 size_t len = u_arraylist_length(g_context.dataList);
2295 for (size_t i = 0; i < len; i++)
2297 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2298 if (CABlockidMatches(currData, blockID))
2300 oc_mutex_unlock(g_context.blockDataListMutex);
2301 OIC_LOG(DEBUG, TAG, "OUT-GetBlockOptionType");
2302 return currData->type;
2305 oc_mutex_unlock(g_context.blockDataListMutex);
2307 OIC_LOG(DEBUG, TAG, "OUT-GetBlockOptionType");
2311 CAData_t *CAGetDataSetFromBlockDataList(const CABlockDataID_t *blockID)
2313 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", NULL);
2315 oc_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 (CABlockidMatches(currData, blockID))
2323 oc_mutex_unlock(g_context.blockDataListMutex);
2324 return currData->sentData;
2327 oc_mutex_unlock(g_context.blockDataListMutex);
2332 CABlockData_t *CAUpdateDataSetFromBlockDataList(const CABlockDataID_t *blockID,
2333 const CAData_t *sendData)
2335 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", NULL);
2336 VERIFY_NON_NULL_RET(sendData, TAG, "sendData", NULL);
2338 oc_mutex_lock(g_context.blockDataListMutex);
2340 size_t len = u_arraylist_length(g_context.dataList);
2341 for (size_t i = 0; i < len; i++)
2343 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2344 if (CABlockidMatches(currData, blockID))
2346 CADestroyDataSet(currData->sentData);
2347 currData->sentData = CACloneCAData(sendData);
2348 oc_mutex_unlock(g_context.blockDataListMutex);
2352 oc_mutex_unlock(g_context.blockDataListMutex);
2357 CAResult_t CAGetTokenFromBlockDataList(const coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
2358 CAResponseInfo_t *responseInfo)
2360 OIC_LOG(DEBUG, TAG, "IN-CAGetTokenFromBlockDataList");
2361 VERIFY_NON_NULL(pdu, TAG, "pdu");
2362 VERIFY_NON_NULL(endpoint, TAG, "endpoint");
2363 VERIFY_NON_NULL(responseInfo, TAG, "responseInfo");
2365 oc_mutex_lock(g_context.blockDataListMutex);
2367 size_t len = u_arraylist_length(g_context.dataList);
2368 for (size_t i = 0; i < len; i++)
2370 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2371 if (NULL == currData)
2376 if (NULL != currData->sentData && NULL != currData->sentData->requestInfo)
2378 if (pdu->transport_hdr->udp.id == currData->sentData->requestInfo->info.messageId &&
2379 endpoint->adapter == currData->sentData->remoteEndpoint->adapter)
2381 if (NULL != currData->sentData->requestInfo->info.token)
2383 uint8_t length = currData->sentData->requestInfo->info.tokenLength;
2384 responseInfo->info.tokenLength = length;
2385 responseInfo->info.token = (char *) OICMalloc(length);
2386 if (NULL == responseInfo->info.token)
2388 OIC_LOG(ERROR, TAG, "out of memory");
2389 oc_mutex_unlock(g_context.blockDataListMutex);
2390 return CA_MEMORY_ALLOC_FAILED;
2392 memcpy(responseInfo->info.token, currData->sentData->requestInfo->info.token,
2393 responseInfo->info.tokenLength);
2395 oc_mutex_unlock(g_context.blockDataListMutex);
2396 OIC_LOG(DEBUG, TAG, "OUT-CAGetTokenFromBlockDataList");
2397 return CA_STATUS_OK;
2403 oc_mutex_unlock(g_context.blockDataListMutex);
2405 OIC_LOG(DEBUG, TAG, "OUT-CAGetTokenFromBlockDataList");
2406 return CA_STATUS_FAILED;
2409 CAResult_t CACheckBlockDataValidation(const CAData_t *sendData, CABlockData_t **blockData)
2411 VERIFY_NON_NULL(sendData, TAG, "sendData");
2412 VERIFY_NON_NULL(blockData, TAG, "blockData");
2414 if (sendData->responseInfo)
2416 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(
2417 (CAToken_t)sendData->responseInfo->info.token,
2418 sendData->responseInfo->info.tokenLength,
2419 sendData->remoteEndpoint->port);
2420 if (NULL == blockDataID || blockDataID->idLength < 1)
2422 OIC_LOG(ERROR, TAG, "blockId is null");
2423 CADestroyBlockID(blockDataID);
2424 return CA_STATUS_FAILED;
2427 CABlockData_t *updatedData = CAUpdateDataSetFromBlockDataList(blockDataID, sendData);
2430 OIC_LOG(DEBUG, TAG, "Send response about the received block request.");
2431 *blockData = updatedData;
2432 CADestroyBlockID(blockDataID);
2433 return CA_STATUS_OK;
2435 CADestroyBlockID(blockDataID);
2438 return CA_STATUS_FAILED;
2441 CABlockData_t *CAGetBlockDataFromBlockDataList(const CABlockDataID_t *blockID)
2443 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", NULL);
2445 oc_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 oc_mutex_unlock(g_context.blockDataListMutex);
2457 oc_mutex_unlock(g_context.blockDataListMutex);
2462 coap_block_t *CAGetBlockOption(const CABlockDataID_t *blockID, uint16_t blockType)
2464 OIC_LOG(DEBUG, TAG, "IN-GetBlockOption");
2465 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", NULL);
2467 oc_mutex_lock(g_context.blockDataListMutex);
2469 size_t len = u_arraylist_length(g_context.dataList);
2470 for (size_t i = 0; i < len; i++)
2472 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2473 if (CABlockidMatches(currData, blockID))
2475 oc_mutex_unlock(g_context.blockDataListMutex);
2476 OIC_LOG(DEBUG, TAG, "OUT-GetBlockOption");
2477 if (COAP_OPTION_BLOCK2 == blockType)
2479 return &currData->block2;
2481 else if (COAP_OPTION_BLOCK1 == blockType)
2483 return &currData->block1;
2487 oc_mutex_unlock(g_context.blockDataListMutex);
2489 OIC_LOG(DEBUG, TAG, "OUT-GetBlockOption");
2493 CAPayload_t CAGetPayloadFromBlockDataList(const CABlockDataID_t *blockID,
2494 size_t *fullPayloadLen)
2496 OIC_LOG(DEBUG, TAG, "IN-GetFullPayload");
2497 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", NULL);
2498 VERIFY_NON_NULL_RET(fullPayloadLen, TAG, "fullPayloadLen", NULL);
2500 oc_mutex_lock(g_context.blockDataListMutex);
2502 size_t len = u_arraylist_length(g_context.dataList);
2503 for (size_t i = 0; i < len; i++)
2505 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2506 if (CABlockidMatches(currData, blockID))
2508 oc_mutex_unlock(g_context.blockDataListMutex);
2509 *fullPayloadLen = currData->receivedPayloadLen;
2510 OIC_LOG(DEBUG, TAG, "OUT-GetFullPayload");
2511 return currData->payload;
2514 oc_mutex_unlock(g_context.blockDataListMutex);
2516 OIC_LOG(DEBUG, TAG, "OUT-GetFullPayload");
2520 CABlockData_t *CACreateNewBlockData(const CAData_t *sendData)
2522 OIC_LOG(DEBUG, TAG, "IN-CACreateNewBlockData");
2523 VERIFY_NON_NULL_RET(sendData, TAG, "sendData", NULL);
2525 // create block data
2526 CABlockData_t *data = (CABlockData_t *) OICCalloc(1, sizeof(CABlockData_t));
2529 OIC_LOG(ERROR, TAG, "memory alloc has failed");
2533 data->block1.szx = CA_DEFAULT_BLOCK_SIZE;
2534 data->block2.szx = CA_DEFAULT_BLOCK_SIZE;
2535 data->sentData = CACloneCAData(sendData);
2536 if (!data->sentData)
2538 OIC_LOG(ERROR, TAG, PCF("memory alloc has failed"));
2543 CAToken_t token = NULL;
2544 uint8_t tokenLength = 0;
2545 if (data->sentData->requestInfo)
2547 // update token info
2548 tokenLength = data->sentData->requestInfo->info.tokenLength;
2549 token = data->sentData->requestInfo->info.token;
2551 else if (data->sentData->responseInfo)
2553 tokenLength = data->sentData->responseInfo->info.tokenLength;
2554 token = data->sentData->responseInfo->info.token;
2557 if (!data->sentData->remoteEndpoint)
2559 OIC_LOG(ERROR, TAG, "remoteEndpoint is null");
2560 CADestroyDataSet(data->sentData);
2565 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(token, tokenLength,
2566 data->sentData->remoteEndpoint->port);
2567 if (NULL == blockDataID || blockDataID->idLength < 1)
2569 OIC_LOG(ERROR, TAG, "blockId is null");
2570 CADestroyBlockID(blockDataID);
2571 CADestroyDataSet(data->sentData);
2575 data->blockDataId = blockDataID;
2576 uint64_t now = OICGetCurrentTime(TIME_IN_US);
2577 data->ttl = now + (BLOCK_DATA_TIMEOUT_SECONDS * USECS_PER_SEC);
2579 oc_mutex_lock(g_context.blockDataListMutex);
2581 bool res = u_arraylist_add(g_context.dataList, (void *) data);
2584 OIC_LOG(ERROR, TAG, "add has failed");
2585 CADestroyBlockID(data->blockDataId);
2586 CADestroyDataSet(data->sentData);
2588 oc_mutex_unlock(g_context.blockDataListMutex);
2591 oc_mutex_unlock(g_context.blockDataListMutex);
2593 OIC_LOG(DEBUG, TAG, "OUT-CreateBlockData");
2597 CAResult_t CARemoveBlockDataFromList(const CABlockDataID_t *blockID)
2599 OIC_LOG_V(DEBUG, TAG, "In %s", __func__);
2600 VERIFY_NON_NULL(blockID, TAG, "blockID");
2602 oc_mutex_lock(g_context.blockDataListMutex);
2604 size_t len = u_arraylist_length(g_context.dataList);
2605 for (size_t i = 0; i < len; i++)
2607 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2608 if (CABlockidMatches(currData, blockID))
2610 CABlockData_t *removedData = u_arraylist_remove(g_context.dataList, i);
2613 OIC_LOG(ERROR, TAG, "data is NULL");
2614 oc_mutex_unlock(g_context.blockDataListMutex);
2615 return CA_STATUS_FAILED;
2618 OIC_LOG(DEBUG, TAG, "Removed BlockID is ");
2619 OIC_LOG_BUFFER(DEBUG, TAG, (const uint8_t *) removedData->blockDataId->id,
2620 removedData->blockDataId->idLength);
2623 CADestroyDataSet(removedData->sentData);
2624 CADestroyBlockID(removedData->blockDataId);
2625 OICFree(removedData->payload);
2626 OICFree(removedData);
2627 oc_mutex_unlock(g_context.blockDataListMutex);
2628 return CA_STATUS_OK;
2631 oc_mutex_unlock(g_context.blockDataListMutex);
2632 OIC_LOG_V(DEBUG, TAG, "Out %s", __func__);
2633 return CA_STATUS_OK;
2636 CAResult_t CARemoveAllBlockDataFromList()
2638 OIC_LOG(DEBUG, TAG, "CARemoveAllBlockDataFromList");
2640 oc_mutex_lock(g_context.blockDataListMutex);
2642 size_t len = u_arraylist_length(g_context.dataList);
2643 for (size_t i = len; i > 0; i--)
2645 CABlockData_t *removedData = u_arraylist_remove(g_context.dataList, i - 1);
2649 if (removedData->sentData)
2651 CADestroyDataSet(removedData->sentData);
2653 CADestroyBlockID(removedData->blockDataId);
2654 OICFree(removedData->payload);
2655 OICFree(removedData);
2658 oc_mutex_unlock(g_context.blockDataListMutex);
2660 return CA_STATUS_OK;
2663 void CADestroyDataSet(CAData_t* data)
2665 VERIFY_NON_NULL_VOID(data, TAG, "data");
2667 if (data->remoteEndpoint)
2669 CAFreeEndpoint(data->remoteEndpoint);
2670 data->remoteEndpoint = NULL;
2672 if (data->requestInfo)
2674 CADestroyRequestInfoInternal(data->requestInfo);
2675 data->requestInfo = NULL;
2677 if (data->responseInfo)
2679 CADestroyResponseInfoInternal(data->responseInfo);
2680 data->responseInfo = NULL;
2685 CABlockDataID_t* CACreateBlockDatablockId(const CAToken_t token, uint8_t tokenLength,
2686 uint16_t portNumber)
2688 char port[PORT_LENGTH] = { 0, };
2689 port[0] = (char) ((portNumber >> 8) & 0xFF);
2690 port[1] = (char) (portNumber & 0xFF);
2692 CABlockDataID_t* blockDataID = (CABlockDataID_t *) OICMalloc(sizeof(CABlockDataID_t));
2695 OIC_LOG(ERROR, TAG, "memory alloc has failed");
2698 blockDataID->idLength = tokenLength + sizeof(port);
2699 blockDataID->id = (uint8_t *) OICMalloc(blockDataID->idLength);
2700 if (!blockDataID->id)
2702 OIC_LOG(ERROR, TAG, "memory alloc has failed");
2703 OICFree(blockDataID);
2709 memcpy(blockDataID->id, token, tokenLength);
2712 memcpy(blockDataID->id + tokenLength, port, sizeof(port));
2714 OIC_LOG(DEBUG, TAG, "BlockID is ");
2715 OIC_LOG_BUFFER(DEBUG, TAG, (const uint8_t *)blockDataID->id, blockDataID->idLength);
2720 void CADestroyBlockID(CABlockDataID_t *blockID)
2722 VERIFY_NON_NULL_VOID(blockID, TAG, "blockID");
2723 OICFree(blockID->id);
2727 bool CABlockidMatches(const CABlockData_t *currData, const CABlockDataID_t *blockID)
2729 VERIFY_NON_NULL_RET(currData, TAG, "currData", false);
2730 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", false);
2731 VERIFY_NON_NULL_RET(blockID->id, TAG, "blockID->id", false);
2733 if ((currData->blockDataId)
2734 && (currData->blockDataId->id)
2735 && (currData->blockDataId->idLength == blockID->idLength)
2736 && !memcmp(currData->blockDataId->id, blockID->id, currData->blockDataId->idLength))
2743 void CALogBlockInfo(coap_block_t *block)
2745 VERIFY_NON_NULL_VOID(block, TAG, "block");
2747 OIC_LOG(DEBUG, TAG, "block option info");
2749 OIC_LOG_V(DEBUG, TAG, "block option-num : %d", block->num);
2751 OIC_LOG_V(DEBUG, TAG, "block option-m : %d", block->m);
2753 OIC_LOG_V(DEBUG, TAG, "block option-szx : %d", block->szx);
2756 CAResult_t CARemoveBlockDataFromListWithSeed(const CAToken_t token, uint8_t tokenLength,
2757 uint16_t portNumber)
2759 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(token, tokenLength, portNumber);
2760 if (NULL == blockDataID || blockDataID->idLength < 1)
2762 OIC_LOG(ERROR, TAG, "blockId is null");
2763 CADestroyBlockID(blockDataID);
2764 return CA_STATUS_FAILED;
2767 CAResult_t res = CARemoveBlockDataFromList(blockDataID);
2768 if (CA_STATUS_OK != res)
2770 OIC_LOG(ERROR, TAG, "CARemoveBlockDataFromList failed");
2773 CADestroyBlockID(blockDataID);
2777 void CAResetBlockDataTTL(const CABlockDataID_t *blockID)
2779 OIC_LOG_V(DEBUG, TAG, "In %s", __func__);
2781 oc_mutex_lock(g_context.blockDataListMutex);
2782 size_t len = u_arraylist_length(g_context.dataList);
2783 for (size_t i = 0; i < len; i++)
2785 CABlockData_t *blockData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2786 if (blockData && CABlockidMatches(blockData, blockID))
2788 uint64_t now = OICGetCurrentTime(TIME_IN_US);
2789 blockData->ttl = now + (BLOCK_DATA_TIMEOUT_SECONDS * USECS_PER_SEC);
2790 oc_mutex_unlock(g_context.blockDataListMutex);
2791 OIC_LOG_V(DEBUG, TAG, "Out %s", __func__);
2795 oc_mutex_unlock(g_context.blockDataListMutex);
2796 OIC_LOG_V(DEBUG, TAG, "Out %s", __func__);
2799 void CACheckAndDeleteTimedOutBlockData()
2801 OIC_LOG_V(DEBUG, TAG, "In %s", __func__);
2803 uint64_t now = OICGetCurrentTime(TIME_IN_US);
2805 oc_mutex_lock(g_context.blockDataListMutex);
2806 for (size_t i = 0; i < u_arraylist_length(g_context.dataList); i++)
2808 CABlockData_t *blockData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2809 if (blockData && blockData->ttl < now)
2811 OIC_LOG(INFO, TAG, "Deleting timed-out BlockData");
2812 OIC_LOG(DEBUG, TAG, "BlockID is ");
2813 OIC_LOG_BUFFER(DEBUG, TAG, (const uint8_t *) blockData->blockDataId->id,
2814 blockData->blockDataId->idLength);
2816 blockData = (CABlockData_t *) u_arraylist_remove(g_context.dataList, i);
2820 CADestroyDataSet(blockData->sentData);
2821 CADestroyBlockID(blockData->blockDataId);
2822 OICFree(blockData->payload);
2827 oc_mutex_unlock(g_context.blockDataListMutex);
2828 OIC_LOG_V(DEBUG, TAG, "Out %s", __func__);