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;
1125 if (CA_BLOCK_UNKNOWN == blockWiseStatus ||
1126 CA_BLOCK_RECEIVED_ALREADY == blockWiseStatus)
1128 OIC_LOG(DEBUG, TAG, "M bit is 1");
1129 blockWiseStatus = CA_OPTION2_RESPONSE;
1132 res = CAUpdateBlockOptionItems(data, pdu, &block, COAP_OPTION_BLOCK2,
1134 if (CA_STATUS_OK != res)
1136 OIC_LOG(ERROR, TAG, "update has failed");
1140 res = CAUpdateBlockData(data, block, COAP_OPTION_BLOCK2);
1141 if (CA_STATUS_OK != res)
1143 OIC_LOG(ERROR, TAG, "update has failed");
1150 res = CAProcessNextStep(pdu, receivedData, blockWiseStatus, blockDataID);
1151 if (CA_STATUS_OK != res)
1153 OIC_LOG(ERROR, TAG, "setting has failed");
1157 CADestroyBlockID(blockDataID);
1158 return CA_STATUS_OK;
1161 CARemoveBlockDataFromList(blockDataID);
1162 CADestroyBlockID(blockDataID);
1166 CAResult_t CAUpdateBlockOptionItems(CABlockData_t *currData, const coap_pdu_t *pdu,
1167 coap_block_t *block, uint16_t blockType,
1170 VERIFY_NON_NULL(currData, TAG, "currData");
1171 VERIFY_NON_NULL(pdu, TAG, "pdu");
1172 VERIFY_NON_NULL(block, TAG, "block");
1174 // update block data
1175 CAResult_t res = CA_STATUS_OK;
1176 uint32_t code = CA_RESPONSE_CODE(pdu->transport_hdr->udp.code);
1178 if (CA_REQUEST_ENTITY_INCOMPLETE == code || CA_REQUEST_ENTITY_TOO_LARGE == code)
1180 // response error code of the received block message
1181 res = CAHandleBlockErrorResponse(block, blockType, code);
1182 if (CA_STATUS_OK != res)
1184 OIC_LOG(ERROR, TAG, "error handle has failed");
1190 // update block option items
1193 case CA_OPTION1_RESPONSE:
1194 if (currData->block1.num > block->num)
1196 OIC_LOG(ERROR, TAG, "received incorrect block num");
1197 return CA_STATUS_FAILED;
1201 case CA_OPTION2_REQUEST:
1204 case CA_OPTION2_RESPONSE:
1205 if (currData->block2.num > block->num)
1207 OIC_LOG(ERROR, TAG, "received incorrect block num");
1208 return CA_STATUS_FAILED;
1213 case CA_BLOCK_TOO_LARGE:
1214 // if state of received block message is CA_BLOCK_TOO_LARGE or CA_BLOCK_INCOMPLETE
1215 // we set the response error code appropriately and send
1216 if (COAP_OPTION_BLOCK2 == blockType)
1220 block->szx = currData->block2.szx;
1224 block->szx = currData->block1.szx;
1228 OIC_LOG_V(ERROR, TAG, "no logic [%d]", status);
1231 if (CA_BLOCK_INCOMPLETE != status && CA_BLOCK_TOO_LARGE != status)
1233 // negotiate block size
1234 res = CANegotiateBlockSize(currData, block, pdu, blockType);
1235 if (CA_STATUS_OK != res)
1237 OIC_LOG(ERROR, TAG, "negotiation has failed");
1245 CAResult_t CASetMoreBitFromBlock(size_t payloadLen, coap_block_t *block)
1247 VERIFY_NON_NULL(block, TAG, "block");
1249 if ((size_t) ((block->num + 1) << (block->szx + BLOCK_NUMBER_IDX)) < payloadLen)
1251 OIC_LOG(DEBUG, TAG, "Set the M-bit(1)");
1256 OIC_LOG(DEBUG, TAG, "Set the M-bit(0)");
1260 return CA_STATUS_OK;
1263 CAResult_t CANegotiateBlockSize(CABlockData_t *currData, coap_block_t *block,
1264 const coap_pdu_t *pdu, uint16_t blockType)
1266 OIC_LOG(DEBUG, TAG, "IN-NegotiateBlockSize");
1268 VERIFY_NON_NULL(currData, TAG, "currData");
1269 VERIFY_NON_NULL(block, TAG, "block");
1270 VERIFY_NON_NULL(pdu, TAG, "pdu");
1271 VERIFY_NON_NULL(pdu->transport_hdr, TAG, "pdu->transport_hdr");
1273 bool isReqMsg = false;
1274 uint32_t code = pdu->transport_hdr->udp.code;
1275 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
1280 // #1. check the block option type
1281 if (COAP_OPTION_BLOCK2 == blockType)
1283 // #2. check the message type
1286 if (block->szx > currData->block2.szx)
1288 OIC_LOG(DEBUG, TAG, "sze is big");
1290 // #3. calculate new block number from block size
1291 unsigned int blockNum = BLOCK_SIZE(block->szx) /
1292 BLOCK_SIZE(currData->block2.szx) - 1;
1293 OIC_LOG(DEBUG, TAG, "num is set as Negotiation");
1294 block->num += blockNum;
1295 block->szx = currData->block2.szx;
1296 OIC_LOG_V(DEBUG, TAG, "updated block num: %d", block->num);
1301 if (block->szx > currData->block2.szx)
1303 OIC_LOG(DEBUG, TAG, "sze is big");
1304 block->szx = currData->block2.szx;
1308 else if (COAP_OPTION_BLOCK1 == blockType)
1312 if (block->szx < currData->block1.szx)
1314 OIC_LOG(DEBUG, TAG, "sze is small");
1316 unsigned int blockNum = BLOCK_SIZE(currData->block1.szx) /
1317 BLOCK_SIZE(block->szx) - 1;
1318 block->num += blockNum;
1319 OIC_LOG_V(DEBUG, TAG, "updated block num: %d", block->num);
1324 if (block->szx > currData->block1.szx)
1326 OIC_LOG(DEBUG, TAG, "sze is big");
1327 block->szx = currData->block1.szx;
1333 OIC_LOG(DEBUG, TAG, "Invalid block option");
1334 return CA_STATUS_FAILED;
1337 OIC_LOG(DEBUG, TAG, "OUT-NegotiateBlockSize");
1339 return CA_STATUS_OK;
1342 CAResult_t CAUpdateBlockData(CABlockData_t *currData, coap_block_t block,
1345 VERIFY_NON_NULL(currData, TAG, "currData");
1347 // check if block size is bigger than CABlockSize_t
1348 if (block.szx > CA_BLOCK_SIZE_1024_BYTE)
1350 OIC_LOG(DEBUG, TAG, "invalid block szx");
1351 return CA_STATUS_FAILED;
1354 // update block option
1355 if (COAP_OPTION_BLOCK2 == blockType)
1357 currData->block2 = block;
1361 currData->block1 = block;
1364 OIC_LOG(DEBUG, TAG, "data has updated");
1365 return CA_STATUS_OK;
1368 CAResult_t CAUpdateMessageId(coap_pdu_t *pdu, const CABlockDataID_t *blockID)
1370 VERIFY_NON_NULL(pdu, TAG, "pdu");
1371 VERIFY_NON_NULL(pdu->transport_hdr, TAG, "pdu->transport_hdr");
1372 VERIFY_NON_NULL(blockID, TAG, "blockID");
1374 // if message is sent, update messageId in block-wise transfer list
1375 CAData_t * cadata = CAGetDataSetFromBlockDataList(blockID);
1378 OIC_LOG(ERROR, TAG, "CAData is unavailable");
1379 return CA_STATUS_FAILED;
1382 if (cadata->requestInfo)
1384 cadata->requestInfo->info.messageId = pdu->transport_hdr->udp.id;
1387 return CA_STATUS_OK;
1390 CAResult_t CAAddBlockOption(coap_pdu_t **pdu, const CAInfo_t *info,
1391 const CAEndpoint_t *endpoint, coap_list_t **options)
1393 OIC_LOG(DEBUG, TAG, "IN-AddBlockOption");
1394 VERIFY_NON_NULL(pdu, TAG, "pdu");
1395 VERIFY_NON_NULL((*pdu), TAG, "(*pdu)");
1396 VERIFY_NON_NULL((*pdu)->transport_hdr, TAG, "(*pdu)->transport_hdr");
1397 VERIFY_NON_NULL(info, TAG, "info");
1398 VERIFY_NON_NULL(endpoint, TAG, "endpoint");
1399 VERIFY_NON_NULL(options, TAG, "options");
1401 CAResult_t res = CA_STATUS_OK;
1402 size_t dataLength = 0;
1405 dataLength = info->payloadSize;
1406 OIC_LOG_V(DEBUG, TAG, "dataLength - %zu", dataLength);
1409 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(
1410 (CAToken_t)(*pdu)->transport_hdr->udp.token,
1411 (*pdu)->transport_hdr->udp.token_length,
1413 if (NULL == blockDataID || blockDataID->idLength < 1)
1415 OIC_LOG(ERROR, TAG, "blockId is null");
1416 res = CA_STATUS_FAILED;
1420 uint32_t repCode = CA_RESPONSE_CODE((*pdu)->transport_hdr->udp.code);
1421 if (CA_REQUEST_ENTITY_INCOMPLETE == repCode)
1423 OIC_LOG(INFO, TAG, "don't use option");
1428 uint8_t blockType = CAGetBlockOptionType(blockDataID);
1429 if (COAP_OPTION_BLOCK2 == blockType)
1431 res = CAAddBlockOption2(pdu, info, dataLength, blockDataID, options);
1432 if (CA_STATUS_OK != res)
1434 OIC_LOG(ERROR, TAG, "add has failed");
1438 else if (COAP_OPTION_BLOCK1 == blockType)
1440 res = CAAddBlockOption1(pdu, info, dataLength, blockDataID, options);
1441 if (CA_STATUS_OK != res)
1443 OIC_LOG(ERROR, TAG, "add has failed");
1449 OIC_LOG(DEBUG, TAG, "no BLOCK option");
1451 // in case it is not large data, add option list to pdu.
1454 for (coap_list_t *opt = *options; opt; opt = opt->next)
1456 OIC_LOG_V(DEBUG, TAG, "[%s] opt will be added.",
1457 COAP_OPTION_DATA(*(coap_option *) opt->data));
1458 OIC_LOG_V(DEBUG, TAG, "[%d] pdu length", (*pdu)->length);
1460 if (0 == coap_add_option(*pdu, COAP_OPTION_KEY(*(coap_option *) opt->data),
1461 COAP_OPTION_LENGTH(*(coap_option *) opt->data),
1462 COAP_OPTION_DATA(*(coap_option *) opt->data)))
1464 OIC_LOG(ERROR, TAG, "coap_add_option has failed");
1465 res = CA_STATUS_FAILED;
1470 OIC_LOG_V(DEBUG, TAG, "[%d] pdu length after option", (*pdu)->length);
1472 // if response data is so large. it have to send as block transfer
1473 if (!coap_add_data(*pdu, dataLength, (const unsigned char *) info->payload))
1475 OIC_LOG(INFO, TAG, "it has to use block");
1476 res = CA_STATUS_FAILED;
1481 OIC_LOG(INFO, TAG, "not Blockwise Transfer");
1485 uint32_t code = (*pdu)->transport_hdr->udp.code;
1486 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
1488 // if received message type is RESET from remote device,
1489 // we have to use the updated message id of request message to find token.
1490 CABlockData_t *blockData = CAGetBlockDataFromBlockDataList(blockDataID);
1493 res = CAUpdateMessageId(*pdu, blockDataID);
1494 if (CA_STATUS_OK != res)
1496 OIC_LOG(ERROR, TAG, "fail to update message id");
1502 CAResetBlockDataTTL(blockDataID);
1504 CADestroyBlockID(blockDataID);
1505 OIC_LOG(DEBUG, TAG, "OUT-AddBlockOption");
1509 CAResult_t CAAddBlockOption2(coap_pdu_t **pdu, const CAInfo_t *info, size_t dataLength,
1510 const CABlockDataID_t *blockID, coap_list_t **options)
1512 OIC_LOG(DEBUG, TAG, "IN-AddBlockOption2");
1513 VERIFY_NON_NULL(pdu, TAG, "pdu");
1514 VERIFY_NON_NULL((*pdu), TAG, "(*pdu)");
1515 VERIFY_NON_NULL((*pdu)->transport_hdr, TAG, "(*pdu)->transport_hdr");
1516 VERIFY_NON_NULL(info, TAG, "info");
1517 VERIFY_NON_NULL(blockID, TAG, "blockID");
1518 VERIFY_NON_NULL(options, TAG, "options");
1520 // get set block data from CABlock list-set.
1521 coap_block_t *block1 = CAGetBlockOption(blockID, COAP_OPTION_BLOCK1);
1522 coap_block_t *block2 = CAGetBlockOption(blockID, COAP_OPTION_BLOCK2);
1523 if (!block1 || !block2)
1525 OIC_LOG(ERROR, TAG, "getting has failed");
1526 return CA_STATUS_FAILED;
1529 CAResult_t res = CA_STATUS_OK;
1530 uint32_t code = (*pdu)->transport_hdr->udp.code;
1531 if (CA_GET != code && CA_POST != code && CA_PUT != code && CA_DELETE != code)
1533 CASetMoreBitFromBlock(dataLength, block2);
1535 // if block number is 0, add size2 option
1536 if (0 == block2->num)
1538 res = CAAddBlockSizeOption(*pdu, COAP_OPTION_SIZE2, dataLength, options);
1539 if (CA_STATUS_OK != res)
1541 OIC_LOG(ERROR, TAG, "add has failed");
1546 res = CAAddBlockOptionImpl(block2, COAP_OPTION_BLOCK2, options);
1547 if (CA_STATUS_OK != res)
1549 OIC_LOG(ERROR, TAG, "add has failed");
1555 OIC_LOG(DEBUG, TAG, "combining block1 and block2");
1556 res = CAAddBlockOptionImpl(block1, COAP_OPTION_BLOCK1, options);
1557 if (CA_STATUS_OK != res)
1559 OIC_LOG(ERROR, TAG, "add has failed");
1562 // initialize block number
1566 res = CAAddOptionToPDU(*pdu, options);
1567 if (CA_STATUS_OK != res)
1569 OIC_LOG(ERROR, TAG, "add has failed");
1573 if (!coap_add_block(*pdu, dataLength, (const unsigned char *) info->payload,
1574 block2->num, block2->szx))
1576 OIC_LOG(ERROR, TAG, "Data length is smaller than the start index");
1577 return CA_STATUS_FAILED;
1580 CALogBlockInfo(block2);
1584 // if sent message is last response block message, remove data
1585 CARemoveBlockDataFromList(blockID);
1590 OIC_LOG(DEBUG, TAG, "option2, not response msg");
1591 res = CAAddBlockOptionImpl(block2, COAP_OPTION_BLOCK2, options);
1592 if (CA_STATUS_OK != res)
1594 OIC_LOG(ERROR, TAG, "add has failed");
1598 res = CAAddOptionToPDU(*pdu, options);
1599 if (CA_STATUS_OK != res)
1601 OIC_LOG(ERROR, TAG, "add has failed");
1604 CALogBlockInfo(block2);
1607 return CA_STATUS_OK;
1610 CARemoveBlockDataFromList(blockID);
1614 CAResult_t CAAddBlockOption1(coap_pdu_t **pdu, const CAInfo_t *info, size_t dataLength,
1615 const CABlockDataID_t *blockID, coap_list_t **options)
1617 OIC_LOG(DEBUG, TAG, "IN-AddBlockOption1");
1618 VERIFY_NON_NULL(pdu, TAG, "pdu");
1619 VERIFY_NON_NULL((*pdu), TAG, "(*pdu)");
1620 VERIFY_NON_NULL((*pdu)->transport_hdr, TAG, "(*pdu)->transport_hdr");
1621 VERIFY_NON_NULL(info, TAG, "info");
1622 VERIFY_NON_NULL(blockID, TAG, "blockID");
1623 VERIFY_NON_NULL(options, TAG, "options");
1625 // get set block data from CABlock list-set.
1626 coap_block_t *block1 = CAGetBlockOption(blockID, COAP_OPTION_BLOCK1);
1629 OIC_LOG(ERROR, TAG, "getting has failed");
1630 return CA_STATUS_FAILED;
1633 CAResult_t res = CA_STATUS_OK;
1634 uint32_t code = (*pdu)->transport_hdr->udp.code;
1635 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
1637 CASetMoreBitFromBlock(dataLength, block1);
1639 // if block number is 0, add size1 option
1640 if (0 == block1->num)
1642 res = CAAddBlockSizeOption(*pdu, COAP_OPTION_SIZE1, dataLength, options);
1643 if (CA_STATUS_OK != res)
1645 OIC_LOG(ERROR, TAG, "add has failed");
1650 // add block option to option list.
1651 res = CAAddBlockOptionImpl(block1, COAP_OPTION_BLOCK1, options);
1652 if (CA_STATUS_OK != res)
1654 OIC_LOG(ERROR, TAG, "add has failed");
1658 // add option list to pdu.
1659 res = CAAddOptionToPDU(*pdu, options);
1660 if (CA_STATUS_OK != res)
1662 OIC_LOG(ERROR, TAG, "add has failed");
1666 // add the payload data as the block size.
1667 if (!coap_add_block(*pdu, dataLength, (const unsigned char *) info->payload, block1->num,
1670 OIC_LOG(ERROR, TAG, "Data length is smaller than the start index");
1671 return CA_STATUS_FAILED;
1676 OIC_LOG(DEBUG, TAG, "received response message with block option1");
1678 // add block option to option list.
1679 res = CAAddBlockOptionImpl(block1, COAP_OPTION_BLOCK1, options);
1680 if (CA_STATUS_OK != res)
1682 OIC_LOG(ERROR, TAG, "add has failed");
1686 // add option list to pdu.
1687 res = CAAddOptionToPDU(*pdu, options);
1688 if (CA_STATUS_OK != res)
1690 OIC_LOG(ERROR, TAG, "add has failed");
1694 // add the payload data as the block size.
1695 if (!coap_add_data(*pdu, dataLength, (const unsigned char *) info->payload))
1697 OIC_LOG(ERROR, TAG, "failed to add payload");
1698 return CA_STATUS_FAILED;
1701 // if it is last block message, remove block data from list.
1704 // remove data from list
1705 res = CARemoveBlockDataFromList(blockID);
1706 if (CA_STATUS_OK != res)
1708 OIC_LOG(ERROR, TAG, "remove has failed");
1714 CALogBlockInfo(block1);
1716 OIC_LOG(DEBUG, TAG, "OUT-AddBlockOption1");
1718 return CA_STATUS_OK;
1721 CARemoveBlockDataFromList(blockID);
1725 CAResult_t CAAddBlockOptionImpl(coap_block_t *block, uint8_t blockType,
1726 coap_list_t **options)
1728 OIC_LOG(DEBUG, TAG, "IN-AddBlockOptionImpl");
1729 VERIFY_NON_NULL(block, TAG, "block");
1730 VERIFY_NON_NULL(options, TAG, "options");
1732 unsigned char buf[BLOCKWISE_OPTION_BUFFER] = { 0 };
1733 unsigned int optionLength = coap_encode_var_bytes(buf,
1734 ((block->num << BLOCK_NUMBER_IDX)
1735 | (block->m << BLOCK_M_BIT_IDX)
1738 int ret = coap_insert(options,
1739 CACreateNewOptionNode(blockType, optionLength, (char *) buf),
1743 return CA_STATUS_INVALID_PARAM;
1746 OIC_LOG(DEBUG, TAG, "OUT-AddBlockOptionImpl");
1747 return CA_STATUS_OK;
1750 CAResult_t CAAddOptionToPDU(coap_pdu_t *pdu, coap_list_t **options)
1752 // after adding the block option to option list, add option list to pdu.
1755 for (coap_list_t *opt = *options; opt; opt = opt->next)
1757 OIC_LOG_V(DEBUG, TAG, "[%s] opt will be added.",
1758 COAP_OPTION_DATA(*(coap_option *) opt->data));
1760 OIC_LOG_V(DEBUG, TAG, "[%d] pdu length", pdu->length);
1761 int ret = coap_add_option(pdu, COAP_OPTION_KEY(*(coap_option *) opt->data),
1762 COAP_OPTION_LENGTH(*(coap_option *) opt->data),
1763 COAP_OPTION_DATA(*(coap_option *) opt->data));
1766 return CA_STATUS_FAILED;
1771 OIC_LOG_V(DEBUG, TAG, "[%d] pdu length after option", pdu->length);
1773 return CA_STATUS_OK;
1776 CAResult_t CAAddBlockSizeOption(coap_pdu_t *pdu, uint16_t sizeType, size_t dataLength,
1777 coap_list_t **options)
1779 OIC_LOG(DEBUG, TAG, "IN-CAAddBlockSizeOption");
1780 VERIFY_NON_NULL(pdu, TAG, "pdu");
1781 VERIFY_NON_NULL(options, TAG, "options");
1783 if (sizeType != COAP_OPTION_SIZE1 && sizeType != COAP_OPTION_SIZE2)
1785 OIC_LOG(ERROR, TAG, "unknown option type");
1786 return CA_STATUS_FAILED;
1789 unsigned char value[BLOCKWISE_OPTION_BUFFER] = { 0 };
1790 unsigned int optionLength = coap_encode_var_bytes(value, dataLength);
1792 int ret = coap_insert(options,
1793 CACreateNewOptionNode(sizeType, optionLength, (char *) value),
1797 return CA_STATUS_INVALID_PARAM;
1800 OIC_LOG(DEBUG, TAG, "OUT-CAAddBlockSizeOption");
1802 return CA_STATUS_OK;
1805 // TODO make pdu const after libcoap is updated to support that.
1806 bool CAIsPayloadLengthInPduWithBlockSizeOption(coap_pdu_t *pdu,
1808 size_t *totalPayloadLen)
1810 OIC_LOG(DEBUG, TAG, "IN-CAIsPayloadLengthInPduWithBlockSizeOption");
1811 VERIFY_NON_NULL(pdu, TAG, "pdu");
1812 VERIFY_NON_NULL(totalPayloadLen, TAG, "totalPayloadLen");
1814 if (sizeType != COAP_OPTION_SIZE1 && sizeType != COAP_OPTION_SIZE2)
1816 OIC_LOG(ERROR, TAG, "unknown option type");
1817 return CA_STATUS_FAILED;
1820 coap_opt_iterator_t opt_iter;
1821 coap_opt_t *option = coap_check_option(pdu, sizeType, &opt_iter);
1824 OIC_LOG(DEBUG, TAG, "get size option from pdu");
1825 *totalPayloadLen = coap_decode_var_bytes(COAP_OPT_VALUE(option),
1826 COAP_OPT_LENGTH(option));
1828 OIC_LOG_V(DEBUG, TAG, "the total payload length to be received is [%zu]bytes",
1834 OIC_LOG(DEBUG, TAG, "OUT-CAIsPayloadLengthInPduWithBlockSizeOption");
1839 uint8_t CACheckBlockErrorType(CABlockData_t *currData, coap_block_t *receivedBlock,
1840 const CAData_t *receivedData, uint16_t blockType,
1843 OIC_LOG(DEBUG, TAG, "IN-CheckBlockError");
1845 VERIFY_NON_NULL(currData, TAG, "currData is NULL");
1846 VERIFY_NON_NULL(receivedBlock, TAG, "receivedBlock is NULL");
1847 VERIFY_NON_NULL(receivedData, TAG, "receivedData is NULL");
1849 // #1. check the received payload length
1850 size_t blockPayloadLen = 0;
1851 CAGetPayloadInfo(receivedData, &blockPayloadLen);
1853 // #2. check if the block sequence is right
1854 if (COAP_OPTION_BLOCK1 == blockType)
1856 size_t prePayloadLen = currData->receivedPayloadLen;
1857 if (prePayloadLen != (size_t) BLOCK_SIZE(receivedBlock->szx) * receivedBlock->num)
1859 if (receivedBlock->num > currData->block1.num + 1)
1861 // 408 Error handling of block loss
1862 OIC_LOG(ERROR, TAG, "option1: error 4.08");
1863 OIC_LOG(ERROR, TAG, "it didn't order");
1864 return CA_BLOCK_INCOMPLETE;
1866 return CA_BLOCK_RECEIVED_ALREADY;
1869 else if (COAP_OPTION_BLOCK2 == blockType)
1871 if (receivedBlock->num != currData->block2.num)
1873 if (receivedBlock->num > currData->block2.num)
1875 // 408 Error handling of block loss
1876 OIC_LOG(ERROR, TAG, "option2: error 4.08");
1877 OIC_LOG(ERROR, TAG, "it didn't order");
1878 return CA_BLOCK_INCOMPLETE;
1882 OIC_LOG(ERROR, TAG, "already received this block");
1883 return CA_BLOCK_RECEIVED_ALREADY;
1888 // #3. check if error check logic is required
1889 size_t optionLen = dataLen - blockPayloadLen;
1890 if (receivedBlock->m && blockPayloadLen != (size_t) BLOCK_SIZE(receivedBlock->szx))
1892 // 413 Error handling of too large entity
1893 if (COAP_MAX_PDU_SIZE < BLOCK_SIZE(receivedBlock->szx) + optionLen)
1895 // buffer size is smaller than received block size
1896 OIC_LOG(ERROR, TAG, "error type 4.13");
1897 OIC_LOG(ERROR, TAG, "too large size");
1899 // set the block size to be smaller than COAP_MAX_PDU_SIZE
1900 for (int32_t size = CA_DEFAULT_BLOCK_SIZE; size >= 0; size--)
1902 if (COAP_MAX_PDU_SIZE >= BLOCK_SIZE(size) + optionLen)
1904 OIC_LOG_V(ERROR, TAG, "replace sze with %d", size);
1905 currData->block2.szx = size;
1906 currData->block1.szx = size;
1910 return CA_BLOCK_TOO_LARGE;
1914 // 408 Error handling of payload loss
1915 OIC_LOG(ERROR, TAG, "error type 4.08");
1916 OIC_LOG(ERROR, TAG, "payload len != block sze");
1917 return CA_BLOCK_INCOMPLETE;
1920 else if (0 == receivedBlock->m && 0 != currData->payloadLength)
1922 // if the received block is last block, check the total payload length
1923 size_t receivedPayloadLen = currData->receivedPayloadLen;
1924 receivedPayloadLen += blockPayloadLen;
1926 if (receivedPayloadLen != currData->payloadLength)
1928 OIC_LOG(ERROR, TAG, "error type 4.08");
1929 OIC_LOG(ERROR, TAG, "total payload length is wrong");
1930 return CA_BLOCK_INCOMPLETE;
1934 OIC_LOG(DEBUG, TAG, "received all data normally");
1936 OIC_LOG(DEBUG, TAG, "OUT-CheckBlockError");
1938 return CA_BLOCK_UNKNOWN;
1941 CAResult_t CAUpdatePayloadData(CABlockData_t *currData, const CAData_t *receivedData,
1942 uint8_t status, bool isSizeOption, uint16_t blockType)
1944 OIC_LOG(DEBUG, TAG, "IN-UpdatePayloadData");
1946 VERIFY_NON_NULL(currData, TAG, "currData");
1947 VERIFY_NON_NULL(receivedData, TAG, "receivedData");
1949 // if error code is 4.08, do not update payload
1950 if (CA_BLOCK_INCOMPLETE == status)
1952 OIC_LOG(ERROR, TAG, "no require to update");
1953 return CA_STATUS_OK;
1956 size_t blockPayloadLen = 0;
1957 CAPayload_t blockPayload = CAGetPayloadInfo(receivedData, &blockPayloadLen);
1959 if (CA_BLOCK_TOO_LARGE == status)
1961 blockPayloadLen = (COAP_OPTION_BLOCK2 == blockType) ?
1962 BLOCK_SIZE(currData->block2.szx) : BLOCK_SIZE(currData->block1.szx);
1965 // memory allocation for the received block payload
1966 size_t prePayloadLen = currData->receivedPayloadLen;
1969 if (currData->payloadLength)
1971 // in case the block message has the size option
1972 // allocate the memory for the total payload
1975 CAPayload_t prePayload = currData->payload;
1977 OIC_LOG(DEBUG, TAG, "allocate memory for the total payload");
1978 currData->payload = (CAPayload_t) OICCalloc(1, currData->payloadLength);
1979 if (NULL == currData->payload)
1981 OIC_LOG(ERROR, TAG, "out of memory");
1982 return CA_MEMORY_ALLOC_FAILED;
1984 memcpy(currData->payload, prePayload, prePayloadLen);
1985 OICFree(prePayload);
1988 // update the total payload
1989 memcpy(currData->payload + prePayloadLen, blockPayload, blockPayloadLen);
1993 OIC_LOG(DEBUG, TAG, "allocate memory for the received block payload");
1995 size_t totalPayloadLen = prePayloadLen + blockPayloadLen;
1996 CAPayload_t newPayload = OICRealloc(currData->payload, totalPayloadLen);
1997 if (NULL == newPayload)
1999 OIC_LOG(ERROR, TAG, "out of memory");
2000 return CA_MEMORY_ALLOC_FAILED;
2003 // update the total payload
2004 memset(newPayload + prePayloadLen, 0, blockPayloadLen);
2005 currData->payload = newPayload;
2006 memcpy(currData->payload + prePayloadLen, blockPayload, blockPayloadLen);
2009 // update received payload length
2010 currData->receivedPayloadLen += blockPayloadLen;
2012 OIC_LOG_V(DEBUG, TAG, "updated payload: %s, len: %zu", currData->payload,
2013 currData->receivedPayloadLen);
2016 OIC_LOG(DEBUG, TAG, "OUT-UpdatePayloadData");
2017 return CA_STATUS_OK;
2020 CAData_t* CACreateNewDataSet(const coap_pdu_t *pdu, const CAEndpoint_t *endpoint)
2022 VERIFY_NON_NULL_RET(pdu, TAG, "pdu", NULL);
2023 VERIFY_NON_NULL_RET(pdu->transport_hdr, TAG, "pdu->transport_hdr", NULL);
2024 VERIFY_NON_NULL_RET(endpoint, TAG, "endpoint", NULL);
2026 CARequestInfo_t* requestInfo = NULL;
2027 CAResponseInfo_t* responseInfo = NULL;
2029 uint32_t code = pdu->transport_hdr->udp.code;
2030 if (CA_GET == code || CA_POST == code || CA_PUT == code || CA_DELETE == code)
2032 CAInfo_t responseData = { .tokenLength = pdu->transport_hdr->udp.token_length };
2033 responseData.token = (CAToken_t) OICMalloc(responseData.tokenLength);
2034 if (!responseData.token)
2036 OIC_LOG(ERROR, TAG, "out of memory");
2039 memcpy(responseData.token, pdu->transport_hdr->udp.token, responseData.tokenLength);
2041 responseInfo = (CAResponseInfo_t*) OICCalloc(1, sizeof(CAResponseInfo_t));
2044 OIC_LOG(ERROR, TAG, "out of memory");
2045 OICFree(responseData.token);
2048 responseInfo->info = responseData;
2052 CAInfo_t requestData = { .tokenLength = pdu->transport_hdr->udp.token_length };
2053 requestData.token = (CAToken_t) OICMalloc(requestData.tokenLength);
2054 if (!requestData.token)
2056 OIC_LOG(ERROR, TAG, "out of memory");
2059 memcpy(requestData.token, pdu->transport_hdr->udp.token, requestData.tokenLength);
2061 requestInfo = (CARequestInfo_t*) OICCalloc(1, sizeof(CARequestInfo_t));
2064 OIC_LOG(ERROR, TAG, "out of memory");
2065 OICFree(requestData.token);
2068 requestInfo->info = requestData;
2070 // get resource uri information from received response message
2071 // to send next request message to remote device
2072 CAResponseInfo_t* resInfo = (CAResponseInfo_t*)OICCalloc(1, sizeof(*resInfo));
2075 OIC_LOG(ERROR, TAG, "memory allocation failed");
2076 OICFree(requestData.token);
2077 OICFree(requestInfo);
2081 CAGetResponseInfoFromPDU(pdu, resInfo, endpoint);
2082 requestInfo->method = CA_GET;
2083 requestInfo->info.messageId = CAGetMessageIdFromPduBinaryData(pdu->transport_hdr,
2085 requestInfo->info.resourceUri = OICStrdup(resInfo->info.resourceUri);
2087 // after copying the resource uri, destroy response info.
2088 CADestroyResponseInfoInternal(resInfo);
2091 CAData_t *data = (CAData_t *) OICCalloc(1, sizeof(CAData_t));
2094 OIC_LOG(ERROR, TAG, "out of memory");
2095 if (NULL != requestInfo)
2097 OICFree(requestInfo->info.resourceUri);
2098 OICFree(requestInfo->info.token);
2099 OICFree(requestInfo);
2101 if (NULL != responseInfo)
2103 OICFree(responseInfo->info.token);
2104 OICFree(responseInfo);
2109 data->requestInfo = requestInfo;
2110 data->responseInfo = responseInfo;
2111 data->remoteEndpoint = CACloneEndpoint(endpoint);
2112 data->type = SEND_TYPE_UNICAST;
2117 CAData_t *CACloneCAData(const CAData_t *data)
2119 VERIFY_NON_NULL_RET(data, TAG, "data", NULL);
2121 CAData_t *clone = (CAData_t *) OICCalloc(1, sizeof(CAData_t));
2124 OIC_LOG(ERROR, TAG, "out of memory");
2129 if (data->requestInfo)
2131 clone->requestInfo = CACloneRequestInfo(data->requestInfo);
2133 else if (data->responseInfo)
2135 clone->responseInfo = CACloneResponseInfo(data->responseInfo);
2138 if (data->remoteEndpoint)
2140 clone->remoteEndpoint = CACloneEndpoint(data->remoteEndpoint);
2146 CAResult_t CAUpdatePayloadToCAData(CAData_t *data, const CAPayload_t payload,
2149 OIC_LOG(DEBUG, TAG, "IN-UpdatePayload");
2151 VERIFY_NON_NULL(data, TAG, "data is NULL");
2152 VERIFY_NON_NULL(payload, TAG, "payload is NULL");
2154 CAPayload_t newPayload = NULL;
2155 switch (data->dataType)
2157 case CA_REQUEST_DATA:
2158 if (!data->requestInfo)
2160 OIC_LOG(ERROR, TAG, "request info is null");
2161 return CA_STATUS_FAILED;
2163 // allocate payload field
2164 newPayload = OICRealloc(data->requestInfo->info.payload, payloadLen);
2167 OIC_LOG(ERROR, TAG, "out of memory");
2168 return CA_STATUS_FAILED;
2170 data->requestInfo->info.payload = newPayload;
2171 memcpy(data->requestInfo->info.payload, payload, payloadLen);
2172 data->requestInfo->info.payloadSize = payloadLen;
2175 case CA_RESPONSE_DATA:
2176 if (!data->responseInfo)
2178 OIC_LOG(ERROR, TAG, "response info is null");
2179 return CA_STATUS_FAILED;
2181 // allocate payload field
2182 newPayload = OICRealloc(data->responseInfo->info.payload, payloadLen);
2185 OIC_LOG(ERROR, TAG, "out of memory");
2186 return CA_STATUS_FAILED;
2188 data->responseInfo->info.payload = newPayload;
2189 memcpy(data->responseInfo->info.payload, payload, payloadLen);
2190 data->responseInfo->info.payloadSize = payloadLen;
2194 // does not occur case
2195 OIC_LOG(ERROR, TAG, "not supported data type");
2196 return CA_NOT_SUPPORTED;
2199 OIC_LOG(DEBUG, TAG, "OUT-UpdatePayload");
2201 return CA_STATUS_OK;
2204 CAPayload_t CAGetPayloadInfo(const CAData_t *data, size_t *payloadLen)
2206 VERIFY_NON_NULL_RET(data, TAG, "data", NULL);
2207 VERIFY_NON_NULL_RET(payloadLen, TAG, "payloadLen", NULL);
2209 if (data->requestInfo)
2211 if (data->requestInfo->info.payload)
2213 *payloadLen = data->requestInfo->info.payloadSize;
2214 return data->requestInfo->info.payload;
2217 else if (data->responseInfo)
2219 if (data->responseInfo->info.payload)
2221 *payloadLen = data->responseInfo->info.payloadSize;
2222 return data->responseInfo->info.payload;
2229 CAResult_t CAHandleBlockErrorResponse(coap_block_t *block, uint16_t blockType,
2230 uint32_t responseResult)
2232 OIC_LOG(DEBUG, TAG, "IN-HandleBlockErrorRes");
2233 VERIFY_NON_NULL(block, TAG, "block is NULL");
2235 // update block data
2236 switch (responseResult)
2238 case CA_REQUEST_ENTITY_INCOMPLETE:
2241 case CA_REQUEST_ENTITY_TOO_LARGE:
2242 if (COAP_OPTION_BLOCK1 == blockType)
2249 OIC_LOG_V(ERROR, TAG, "there is no Error Code of BWT[%d]", responseResult);
2250 return CA_STATUS_FAILED;
2253 OIC_LOG(DEBUG, TAG, "OUT-HandleBlockErrorRes");
2254 return CA_STATUS_OK;
2257 CAResult_t CAUpdateBlockOptionType(const CABlockDataID_t *blockID, uint8_t blockType)
2259 OIC_LOG(DEBUG, TAG, "IN-UpdateBlockOptionType");
2260 VERIFY_NON_NULL(blockID, TAG, "blockID");
2262 oc_mutex_lock(g_context.blockDataListMutex);
2264 size_t len = u_arraylist_length(g_context.dataList);
2265 for (size_t i = 0; i < len; i++)
2267 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2268 if (CABlockidMatches(currData, blockID))
2270 currData->type = blockType;
2271 oc_mutex_unlock(g_context.blockDataListMutex);
2272 OIC_LOG(DEBUG, TAG, "OUT-UpdateBlockOptionType");
2273 return CA_STATUS_OK;
2276 oc_mutex_unlock(g_context.blockDataListMutex);
2278 OIC_LOG(DEBUG, TAG, "OUT-UpdateBlockOptionType");
2279 return CA_STATUS_FAILED;
2282 uint8_t CAGetBlockOptionType(const CABlockDataID_t *blockID)
2284 OIC_LOG(DEBUG, TAG, "IN-GetBlockOptionType");
2285 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", 0);
2287 oc_mutex_lock(g_context.blockDataListMutex);
2289 size_t len = u_arraylist_length(g_context.dataList);
2290 for (size_t i = 0; i < len; i++)
2292 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2293 if (CABlockidMatches(currData, blockID))
2295 oc_mutex_unlock(g_context.blockDataListMutex);
2296 OIC_LOG(DEBUG, TAG, "OUT-GetBlockOptionType");
2297 return currData->type;
2300 oc_mutex_unlock(g_context.blockDataListMutex);
2302 OIC_LOG(DEBUG, TAG, "OUT-GetBlockOptionType");
2306 CAData_t *CAGetDataSetFromBlockDataList(const CABlockDataID_t *blockID)
2308 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", NULL);
2310 oc_mutex_lock(g_context.blockDataListMutex);
2312 size_t len = u_arraylist_length(g_context.dataList);
2313 for (size_t i = 0; i < len; i++)
2315 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2316 if (CABlockidMatches(currData, blockID))
2318 oc_mutex_unlock(g_context.blockDataListMutex);
2319 return currData->sentData;
2322 oc_mutex_unlock(g_context.blockDataListMutex);
2327 CABlockData_t *CAUpdateDataSetFromBlockDataList(const CABlockDataID_t *blockID,
2328 const CAData_t *sendData)
2330 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", NULL);
2331 VERIFY_NON_NULL_RET(sendData, TAG, "sendData", NULL);
2333 oc_mutex_lock(g_context.blockDataListMutex);
2335 size_t len = u_arraylist_length(g_context.dataList);
2336 for (size_t i = 0; i < len; i++)
2338 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2339 if (CABlockidMatches(currData, blockID))
2341 CADestroyDataSet(currData->sentData);
2342 currData->sentData = CACloneCAData(sendData);
2343 oc_mutex_unlock(g_context.blockDataListMutex);
2347 oc_mutex_unlock(g_context.blockDataListMutex);
2352 CAResult_t CAGetTokenFromBlockDataList(const coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
2353 CAResponseInfo_t *responseInfo)
2355 OIC_LOG(DEBUG, TAG, "IN-CAGetTokenFromBlockDataList");
2356 VERIFY_NON_NULL(pdu, TAG, "pdu");
2357 VERIFY_NON_NULL(endpoint, TAG, "endpoint");
2358 VERIFY_NON_NULL(responseInfo, TAG, "responseInfo");
2360 oc_mutex_lock(g_context.blockDataListMutex);
2362 size_t len = u_arraylist_length(g_context.dataList);
2363 for (size_t i = 0; i < len; i++)
2365 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2366 if (NULL == currData)
2371 if (NULL != currData->sentData && NULL != currData->sentData->requestInfo)
2373 if (pdu->transport_hdr->udp.id == currData->sentData->requestInfo->info.messageId &&
2374 endpoint->adapter == currData->sentData->remoteEndpoint->adapter)
2376 if (NULL != currData->sentData->requestInfo->info.token)
2378 uint8_t length = currData->sentData->requestInfo->info.tokenLength;
2379 responseInfo->info.tokenLength = length;
2380 responseInfo->info.token = (char *) OICMalloc(length);
2381 if (NULL == responseInfo->info.token)
2383 OIC_LOG(ERROR, TAG, "out of memory");
2384 oc_mutex_unlock(g_context.blockDataListMutex);
2385 return CA_MEMORY_ALLOC_FAILED;
2387 memcpy(responseInfo->info.token, currData->sentData->requestInfo->info.token,
2388 responseInfo->info.tokenLength);
2390 oc_mutex_unlock(g_context.blockDataListMutex);
2391 OIC_LOG(DEBUG, TAG, "OUT-CAGetTokenFromBlockDataList");
2392 return CA_STATUS_OK;
2398 oc_mutex_unlock(g_context.blockDataListMutex);
2400 OIC_LOG(DEBUG, TAG, "OUT-CAGetTokenFromBlockDataList");
2401 return CA_STATUS_FAILED;
2404 CAResult_t CACheckBlockDataValidation(const CAData_t *sendData, CABlockData_t **blockData)
2406 VERIFY_NON_NULL(sendData, TAG, "sendData");
2407 VERIFY_NON_NULL(blockData, TAG, "blockData");
2409 if (sendData->responseInfo)
2411 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(
2412 (CAToken_t)sendData->responseInfo->info.token,
2413 sendData->responseInfo->info.tokenLength,
2414 sendData->remoteEndpoint->port);
2415 if (NULL == blockDataID || blockDataID->idLength < 1)
2417 OIC_LOG(ERROR, TAG, "blockId is null");
2418 CADestroyBlockID(blockDataID);
2419 return CA_STATUS_FAILED;
2422 CABlockData_t *updatedData = CAUpdateDataSetFromBlockDataList(blockDataID, sendData);
2425 OIC_LOG(DEBUG, TAG, "Send response about the received block request.");
2426 *blockData = updatedData;
2427 CADestroyBlockID(blockDataID);
2428 return CA_STATUS_OK;
2430 CADestroyBlockID(blockDataID);
2433 return CA_STATUS_FAILED;
2436 CABlockData_t *CAGetBlockDataFromBlockDataList(const CABlockDataID_t *blockID)
2438 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", NULL);
2440 oc_mutex_lock(g_context.blockDataListMutex);
2442 size_t len = u_arraylist_length(g_context.dataList);
2443 for (size_t i = 0; i < len; i++)
2445 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2446 if (CABlockidMatches(currData, blockID))
2448 oc_mutex_unlock(g_context.blockDataListMutex);
2452 oc_mutex_unlock(g_context.blockDataListMutex);
2457 coap_block_t *CAGetBlockOption(const CABlockDataID_t *blockID, uint16_t blockType)
2459 OIC_LOG(DEBUG, TAG, "IN-GetBlockOption");
2460 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", NULL);
2462 oc_mutex_lock(g_context.blockDataListMutex);
2464 size_t len = u_arraylist_length(g_context.dataList);
2465 for (size_t i = 0; i < len; i++)
2467 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2468 if (CABlockidMatches(currData, blockID))
2470 oc_mutex_unlock(g_context.blockDataListMutex);
2471 OIC_LOG(DEBUG, TAG, "OUT-GetBlockOption");
2472 if (COAP_OPTION_BLOCK2 == blockType)
2474 return &currData->block2;
2476 else if (COAP_OPTION_BLOCK1 == blockType)
2478 return &currData->block1;
2482 oc_mutex_unlock(g_context.blockDataListMutex);
2484 OIC_LOG(DEBUG, TAG, "OUT-GetBlockOption");
2488 CAPayload_t CAGetPayloadFromBlockDataList(const CABlockDataID_t *blockID,
2489 size_t *fullPayloadLen)
2491 OIC_LOG(DEBUG, TAG, "IN-GetFullPayload");
2492 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", NULL);
2493 VERIFY_NON_NULL_RET(fullPayloadLen, TAG, "fullPayloadLen", NULL);
2495 oc_mutex_lock(g_context.blockDataListMutex);
2497 size_t len = u_arraylist_length(g_context.dataList);
2498 for (size_t i = 0; i < len; i++)
2500 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2501 if (CABlockidMatches(currData, blockID))
2503 oc_mutex_unlock(g_context.blockDataListMutex);
2504 *fullPayloadLen = currData->receivedPayloadLen;
2505 OIC_LOG(DEBUG, TAG, "OUT-GetFullPayload");
2506 return currData->payload;
2509 oc_mutex_unlock(g_context.blockDataListMutex);
2511 OIC_LOG(DEBUG, TAG, "OUT-GetFullPayload");
2515 CABlockData_t *CACreateNewBlockData(const CAData_t *sendData)
2517 OIC_LOG(DEBUG, TAG, "IN-CACreateNewBlockData");
2518 VERIFY_NON_NULL_RET(sendData, TAG, "sendData", NULL);
2520 // create block data
2521 CABlockData_t *data = (CABlockData_t *) OICCalloc(1, sizeof(CABlockData_t));
2524 OIC_LOG(ERROR, TAG, "memory alloc has failed");
2528 data->block1.szx = CA_DEFAULT_BLOCK_SIZE;
2529 data->block2.szx = CA_DEFAULT_BLOCK_SIZE;
2530 data->sentData = CACloneCAData(sendData);
2531 if (!data->sentData)
2533 OIC_LOG(ERROR, TAG, PCF("memory alloc has failed"));
2538 CAToken_t token = NULL;
2539 uint8_t tokenLength = 0;
2540 if (data->sentData->requestInfo)
2542 // update token info
2543 tokenLength = data->sentData->requestInfo->info.tokenLength;
2544 token = data->sentData->requestInfo->info.token;
2546 else if (data->sentData->responseInfo)
2548 tokenLength = data->sentData->responseInfo->info.tokenLength;
2549 token = data->sentData->responseInfo->info.token;
2552 if (!data->sentData->remoteEndpoint)
2554 OIC_LOG(ERROR, TAG, "remoteEndpoint is null");
2555 CADestroyDataSet(data->sentData);
2560 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(token, tokenLength,
2561 data->sentData->remoteEndpoint->port);
2562 if (NULL == blockDataID || blockDataID->idLength < 1)
2564 OIC_LOG(ERROR, TAG, "blockId is null");
2565 CADestroyBlockID(blockDataID);
2566 CADestroyDataSet(data->sentData);
2570 data->blockDataId = blockDataID;
2571 uint64_t now = OICGetCurrentTime(TIME_IN_US);
2572 data->ttl = now + (BLOCK_DATA_TIMEOUT_SECONDS * USECS_PER_SEC);
2574 oc_mutex_lock(g_context.blockDataListMutex);
2576 bool res = u_arraylist_add(g_context.dataList, (void *) data);
2579 OIC_LOG(ERROR, TAG, "add has failed");
2580 CADestroyBlockID(data->blockDataId);
2581 CADestroyDataSet(data->sentData);
2583 oc_mutex_unlock(g_context.blockDataListMutex);
2586 oc_mutex_unlock(g_context.blockDataListMutex);
2588 OIC_LOG(DEBUG, TAG, "OUT-CreateBlockData");
2592 CAResult_t CARemoveBlockDataFromList(const CABlockDataID_t *blockID)
2594 OIC_LOG_V(DEBUG, TAG, "In %s", __func__);
2595 VERIFY_NON_NULL(blockID, TAG, "blockID");
2597 oc_mutex_lock(g_context.blockDataListMutex);
2599 size_t len = u_arraylist_length(g_context.dataList);
2600 for (size_t i = 0; i < len; i++)
2602 CABlockData_t *currData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2603 if (CABlockidMatches(currData, blockID))
2605 CABlockData_t *removedData = u_arraylist_remove(g_context.dataList, i);
2608 OIC_LOG(ERROR, TAG, "data is NULL");
2609 oc_mutex_unlock(g_context.blockDataListMutex);
2610 return CA_STATUS_FAILED;
2613 OIC_LOG(DEBUG, TAG, "Removed BlockID is ");
2614 OIC_LOG_BUFFER(DEBUG, TAG, (const uint8_t *) removedData->blockDataId->id,
2615 removedData->blockDataId->idLength);
2618 CADestroyDataSet(removedData->sentData);
2619 CADestroyBlockID(removedData->blockDataId);
2620 OICFree(removedData->payload);
2621 OICFree(removedData);
2622 oc_mutex_unlock(g_context.blockDataListMutex);
2623 return CA_STATUS_OK;
2626 oc_mutex_unlock(g_context.blockDataListMutex);
2627 OIC_LOG_V(DEBUG, TAG, "Out %s", __func__);
2628 return CA_STATUS_OK;
2631 CAResult_t CARemoveAllBlockDataFromList()
2633 OIC_LOG(DEBUG, TAG, "CARemoveAllBlockDataFromList");
2635 oc_mutex_lock(g_context.blockDataListMutex);
2637 size_t len = u_arraylist_length(g_context.dataList);
2638 for (size_t i = len; i > 0; i--)
2640 CABlockData_t *removedData = u_arraylist_remove(g_context.dataList, i - 1);
2644 if (removedData->sentData)
2646 CADestroyDataSet(removedData->sentData);
2648 CADestroyBlockID(removedData->blockDataId);
2649 OICFree(removedData->payload);
2650 OICFree(removedData);
2653 oc_mutex_unlock(g_context.blockDataListMutex);
2655 return CA_STATUS_OK;
2658 void CADestroyDataSet(CAData_t* data)
2660 VERIFY_NON_NULL_VOID(data, TAG, "data");
2662 if (data->remoteEndpoint)
2664 CAFreeEndpoint(data->remoteEndpoint);
2665 data->remoteEndpoint = NULL;
2667 if (data->requestInfo)
2669 CADestroyRequestInfoInternal(data->requestInfo);
2670 data->requestInfo = NULL;
2672 if (data->responseInfo)
2674 CADestroyResponseInfoInternal(data->responseInfo);
2675 data->responseInfo = NULL;
2680 CABlockDataID_t* CACreateBlockDatablockId(const CAToken_t token, uint8_t tokenLength,
2681 uint16_t portNumber)
2683 char port[PORT_LENGTH] = { 0, };
2684 port[0] = (char) ((portNumber >> 8) & 0xFF);
2685 port[1] = (char) (portNumber & 0xFF);
2687 CABlockDataID_t* blockDataID = (CABlockDataID_t *) OICMalloc(sizeof(CABlockDataID_t));
2690 OIC_LOG(ERROR, TAG, "memory alloc has failed");
2693 blockDataID->idLength = tokenLength + sizeof(port);
2694 blockDataID->id = (uint8_t *) OICMalloc(blockDataID->idLength);
2695 if (!blockDataID->id)
2697 OIC_LOG(ERROR, TAG, "memory alloc has failed");
2698 OICFree(blockDataID);
2704 memcpy(blockDataID->id, token, tokenLength);
2707 memcpy(blockDataID->id + tokenLength, port, sizeof(port));
2709 OIC_LOG(DEBUG, TAG, "BlockID is ");
2710 OIC_LOG_BUFFER(DEBUG, TAG, (const uint8_t *)blockDataID->id, blockDataID->idLength);
2715 void CADestroyBlockID(CABlockDataID_t *blockID)
2717 VERIFY_NON_NULL_VOID(blockID, TAG, "blockID");
2718 OICFree(blockID->id);
2723 bool CABlockidMatches(const CABlockData_t *currData, const CABlockDataID_t *blockID)
2725 VERIFY_NON_NULL_RET(currData, TAG, "currData", false);
2726 VERIFY_NON_NULL_RET(blockID, TAG, "blockID", false);
2727 VERIFY_NON_NULL_RET(blockID->id, TAG, "blockID->id", false);
2729 if ((currData->blockDataId)
2730 && (currData->blockDataId->id)
2731 && (currData->blockDataId->idLength == blockID->idLength)
2732 && !memcmp(currData->blockDataId->id, blockID->id, currData->blockDataId->idLength))
2739 void CALogBlockInfo(coap_block_t *block)
2741 VERIFY_NON_NULL_VOID(block, TAG, "block");
2743 OIC_LOG(DEBUG, TAG, "block option info");
2745 OIC_LOG_V(DEBUG, TAG, "block option-num : %d", block->num);
2747 OIC_LOG_V(DEBUG, TAG, "block option-m : %d", block->m);
2749 OIC_LOG_V(DEBUG, TAG, "block option-szx : %d", block->szx);
2752 CAResult_t CARemoveBlockDataFromListWithSeed(const CAToken_t token, uint8_t tokenLength,
2753 uint16_t portNumber)
2755 CABlockDataID_t* blockDataID = CACreateBlockDatablockId(token, tokenLength, portNumber);
2756 if (NULL == blockDataID || blockDataID->idLength < 1)
2758 OIC_LOG(ERROR, TAG, "blockId is null");
2759 CADestroyBlockID(blockDataID);
2760 return CA_STATUS_FAILED;
2763 CAResult_t res = CARemoveBlockDataFromList(blockDataID);
2764 if (CA_STATUS_OK != res)
2766 OIC_LOG(ERROR, TAG, "CARemoveBlockDataFromList failed");
2769 CADestroyBlockID(blockDataID);
2773 void CAResetBlockDataTTL(const CABlockDataID_t *blockID)
2775 OIC_LOG_V(DEBUG, TAG, "In %s", __func__);
2777 oc_mutex_lock(g_context.blockDataListMutex);
2778 size_t len = u_arraylist_length(g_context.dataList);
2779 for (size_t i = 0; i < len; i++)
2781 CABlockData_t *blockData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2782 if (CABlockidMatches(blockData, blockID))
2784 uint64_t now = OICGetCurrentTime(TIME_IN_US);
2785 blockData->ttl = now + (BLOCK_DATA_TIMEOUT_SECONDS * USECS_PER_SEC);
2786 oc_mutex_unlock(g_context.blockDataListMutex);
2787 OIC_LOG_V(DEBUG, TAG, "Out %s", __func__);
2791 oc_mutex_unlock(g_context.blockDataListMutex);
2792 OIC_LOG_V(DEBUG, TAG, "Out %s", __func__);
2795 void CACheckAndDeleteTimedOutBlockData()
2797 OIC_LOG_V(DEBUG, TAG, "In %s", __func__);
2799 uint64_t now = OICGetCurrentTime(TIME_IN_US);
2801 oc_mutex_lock(g_context.blockDataListMutex);
2802 for (size_t i = 0; i < u_arraylist_length(g_context.dataList); i++)
2804 CABlockData_t *blockData = (CABlockData_t *) u_arraylist_get(g_context.dataList, i);
2805 if (blockData && blockData->ttl < now)
2807 OIC_LOG(INFO, TAG, "Deleting timed-out BlockData");
2808 OIC_LOG(DEBUG, TAG, "BlockID is ");
2809 OIC_LOG_BUFFER(DEBUG, TAG, (const uint8_t *) blockData->blockDataId->id,
2810 blockData->blockDataId->idLength);
2812 blockData = (CABlockData_t *) u_arraylist_remove(g_context.dataList, i);
2816 CADestroyDataSet(blockData->sentData);
2817 CADestroyBlockID(blockData->blockDataId);
2818 OICFree(blockData->payload);
2823 oc_mutex_unlock(g_context.blockDataListMutex);
2824 OIC_LOG_V(DEBUG, TAG, "Out %s", __func__);