1 /* ****************************************************************j
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 #include <sys/types.h>
22 #include <sys/socket.h>
23 #include <sys/ioctl.h>
26 #include <sys/types.h>
28 #include <sys/select.h>
29 #include <arpa/inet.h>
30 #include <netinet/in.h>
36 #include <sys/socket.h>
37 #include <netinet/in.h>
41 #include "catcpinterface.h"
43 #include "caadapterutils.h"
45 #include "oic_malloc.h"
46 #include "oic_string.h"
49 * Logging tag for module name.
51 #define TAG "OIC_CA_TCP_SERVER"
54 * Server port number for local test.
56 #define SERVER_PORT 8000
59 * Maximum CoAP over TCP header length
60 * to know the total data length.
62 #define TCP_MAX_HEADER_LEN 6
65 * Accept server file descriptor.
67 static int g_acceptServerFD = -1;
70 * Mutex to synchronize device object list.
72 static ca_mutex g_mutexObjectList = NULL;
75 * Conditional mutex to synchronize.
77 static ca_cond g_condObjectList = NULL;
80 * Maintains the callback to be notified when data received from remote device.
82 static CATCPPacketReceivedCallback g_packetReceivedCallback;
85 * Error callback to update error in TCP.
87 static CATCPErrorHandleCallback g_TCPErrorHandler = NULL;
89 static CAResult_t CATCPCreateMutex();
90 static void CATCPDestroyMutex();
91 static CAResult_t CATCPCreateCond();
92 static void CATCPDestroyCond();
93 static CAResult_t CACreateAcceptSocket();
94 static void CAAcceptConnection();
95 static void CAFindReadyMessage();
96 static void CASelectReturned(fd_set *readFds, int ret);
97 static void CAReceiveMessage(int fd);
98 static void CAReceiveHandler(void *data);
99 static int CATCPCreateSocket(int family, CATCPSessionInfo_t *tcpServerInfo);
101 #define CHECKFD(FD) \
102 if (FD > caglobals.tcp.maxfd) \
103 caglobals.tcp.maxfd = FD;
105 static void CATCPDestroyMutex()
107 if (g_mutexObjectList)
109 ca_mutex_free(g_mutexObjectList);
110 g_mutexObjectList = NULL;
114 static CAResult_t CATCPCreateMutex()
116 if (!g_mutexObjectList)
118 g_mutexObjectList = ca_mutex_new();
119 if (!g_mutexObjectList)
121 OIC_LOG(ERROR, TAG, "Failed to created mutex!");
122 return CA_STATUS_FAILED;
129 static void CATCPDestroyCond()
131 if (g_condObjectList)
133 ca_cond_free(g_condObjectList);
134 g_condObjectList = NULL;
138 static CAResult_t CATCPCreateCond()
140 if (!g_condObjectList)
142 g_condObjectList = ca_cond_new();
143 if (!g_condObjectList)
145 OIC_LOG(ERROR, TAG, "Failed to created cond!");
146 return CA_STATUS_FAILED;
152 static void CAReceiveHandler(void *data)
155 OIC_LOG(DEBUG, TAG, "IN - CAReceiveHandler");
157 while (!caglobals.tcp.terminate)
159 CAFindReadyMessage();
162 ca_mutex_lock(g_mutexObjectList);
163 ca_cond_signal(g_condObjectList);
164 ca_mutex_unlock(g_mutexObjectList);
166 OIC_LOG(DEBUG, TAG, "OUT - CAReceiveHandler");
169 static void CAFindReadyMessage()
172 struct timeval timeout = { .tv_sec = caglobals.tcp.selectTimeout };
176 if (-1 != g_acceptServerFD)
178 FD_SET(g_acceptServerFD, &readFds);
180 if (-1 != caglobals.tcp.shutdownFds[0])
182 FD_SET(caglobals.tcp.shutdownFds[0], &readFds);
185 uint32_t length = u_arraylist_length(caglobals.tcp.svrlist);
186 for (size_t i = 0; i < length; i++)
188 CATCPSessionInfo_t *svritem =
189 (CATCPSessionInfo_t *) u_arraylist_get(caglobals.tcp.svrlist, i);
190 if (svritem && 0 <= svritem->fd)
192 FD_SET(svritem->fd, &readFds);
196 int ret = select(caglobals.tcp.maxfd + 1, &readFds, NULL, NULL, &timeout);
198 if (caglobals.tcp.terminate)
200 OIC_LOG_V(DEBUG, TAG, "Packet receiver Stop request received.");
207 OIC_LOG_V(FATAL, TAG, "select error %s", strerror(errno));
212 CASelectReturned(&readFds, ret);
215 static void CASelectReturned(fd_set *readFds, int ret)
219 if (g_acceptServerFD != -1 && FD_ISSET(g_acceptServerFD, readFds))
221 CAAcceptConnection();
226 uint32_t length = u_arraylist_length(caglobals.tcp.svrlist);
227 for (size_t i = 0; i < length; i++)
229 CATCPSessionInfo_t *svritem =
230 (CATCPSessionInfo_t *) u_arraylist_get(caglobals.tcp.svrlist, i);
231 if (svritem && svritem->fd >= 0)
233 if (FD_ISSET(svritem->fd, readFds))
235 CAReceiveMessage(svritem->fd);
236 FD_CLR(svritem->fd, readFds);
243 static void CAAcceptConnection()
245 struct sockaddr_storage clientaddr;
246 socklen_t clientlen = sizeof (struct sockaddr_in);
248 int sockfd = accept(g_acceptServerFD, (struct sockaddr *)&clientaddr,
252 CATCPSessionInfo_t *svritem =
253 (CATCPSessionInfo_t *) OICCalloc(1, sizeof (*svritem));
256 OIC_LOG(ERROR, TAG, "Out of memory");
261 svritem->fd = sockfd;
262 CAConvertAddrToName((struct sockaddr_storage *)&clientaddr, clientlen,
263 (char *) &svritem->sep.endpoint.addr, &svritem->sep.endpoint.port);
265 ca_mutex_lock(g_mutexObjectList);
266 bool result = u_arraylist_add(caglobals.tcp.svrlist, svritem);
269 OIC_LOG(ERROR, TAG, "u_arraylist_add failed.");
272 ca_mutex_unlock(g_mutexObjectList);
275 ca_mutex_unlock(g_mutexObjectList);
281 static void CAReceiveMessage(int fd)
283 // #1. get remote device information from file descriptor.
285 CATCPSessionInfo_t *svritem = CAGetSessionInfoFromFD(fd, &index);
288 OIC_LOG(ERROR, TAG, "there is no connection information in list");
292 // #2. get already allocated memory size.
293 size_t bufSize = (svritem->totalDataLen == 0) ? TCP_MAX_HEADER_LEN : svritem->totalDataLen;
294 if (!svritem->recvData)
296 svritem->recvData = (unsigned char *) OICCalloc(1, bufSize);
297 if (!svritem->recvData)
299 OIC_LOG(ERROR, TAG, "out of memory");
300 CADisconnectTCPSession(svritem, index);
305 // #3. receive data from remote device.
306 ssize_t recvLen = recv(fd, svritem->recvData + svritem->recvDataLen,
307 bufSize - svritem->recvDataLen, 0);
310 if(EWOULDBLOCK != errno)
312 OIC_LOG_V(ERROR, TAG, "Recvfrom failed %s", strerror(errno));
313 CADisconnectTCPSession(svritem, index);
317 svritem->recvDataLen += recvLen;
319 // #4. get actual data length from coap over tcp header.
320 if (!svritem->totalDataLen)
322 coap_transport_type transport = coap_get_tcp_header_type_from_initbyte(
323 ((unsigned char *) svritem->recvData)[0] >> 4);
325 size_t headerLen = coap_get_tcp_header_length_for_transport(transport);
326 if (svritem->recvDataLen >= headerLen)
328 svritem->totalDataLen = CAGetTotalLengthFromHeader(
329 (unsigned char *) svritem->recvData);
330 bufSize = svritem->totalDataLen;
331 unsigned char *newBuf = OICRealloc(svritem->recvData, bufSize);
334 OIC_LOG(ERROR, TAG, "out of memory");
335 CADisconnectTCPSession(svritem, index);
338 svritem->recvData = newBuf;
342 // #5. pass the received data information to upper layer.
343 if ((svritem->totalDataLen == svritem->recvDataLen) && g_packetReceivedCallback)
345 svritem->sep.endpoint.adapter = CA_ADAPTER_TCP;
346 g_packetReceivedCallback(&svritem->sep, svritem->recvData, svritem->recvDataLen);
347 OIC_LOG_V(DEBUG, TAG, "total received data len:%d", svritem->recvDataLen);
349 // initialize data info to receive next message.
350 OICFree(svritem->recvData);
351 svritem->recvData = NULL;
352 svritem->recvDataLen = 0;
353 svritem->totalDataLen = 0;
359 static int CATCPCreateSocket(int family, CATCPSessionInfo_t *svritem)
362 int fd = socket(family, SOCK_STREAM, IPPROTO_TCP);
365 OIC_LOG_V(ERROR, TAG, "create socket failed: %s", strerror(errno));
369 struct sockaddr_storage sa = { .ss_family = family };
370 CAConvertNameToAddr(svritem->sep.endpoint.addr, svritem->sep.endpoint.port, &sa);
371 socklen_t socklen = sizeof (struct sockaddr_in);
373 // connect to TCP server
374 int ret = connect(fd, (struct sockaddr *)&sa, socklen);
377 OIC_LOG(DEBUG, TAG, "connect socket success");
379 else if (EINPROGRESS == errno)
381 OIC_LOG(DEBUG, TAG, "EINPROGRESS");
383 socklen_t len = sizeof(error);
384 if (getsockopt(fd, SOL_SOCKET, SO_ERROR, &error, &len) < 0)
386 OIC_LOG(ERROR, TAG, "getsockopt() error");
392 if (ECONNREFUSED == error)
394 OIC_LOG(ERROR, TAG, "connection refused");
397 OIC_LOG(ERROR, TAG, "failed to connect socket");
400 OIC_LOG(DEBUG, TAG, "connect socket success");
404 OIC_LOG(ERROR, TAG, "failed to connect socket");
418 static CAResult_t CACreateAcceptSocket()
421 struct sockaddr_in server = { .sin_addr.s_addr = INADDR_ANY,
422 .sin_family = AF_INET,
423 .sin_port = htons(SERVER_PORT),
426 g_acceptServerFD = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
427 if (g_acceptServerFD < 0)
429 OIC_LOG(ERROR, TAG, "Failed to create socket");
433 if (-1 == setsockopt(g_acceptServerFD, SOL_SOCKET, SO_REUSEADDR, &reuse, sizeof(reuse)))
435 OIC_LOG(ERROR, TAG, "setsockopt SO_REUSEADDR");
439 int serverlen = sizeof(server);
440 if (-1 == bind(g_acceptServerFD, (struct sockaddr *)&server, serverlen))
442 OIC_LOG(ERROR, TAG, "bind() error");
446 if (listen(g_acceptServerFD, caglobals.tcp.listenBacklog) != 0)
448 OIC_LOG(ERROR, TAG, "listen() error");
452 CHECKFD(g_acceptServerFD);
457 if (g_acceptServerFD >= 0)
459 close(g_acceptServerFD);
460 g_acceptServerFD = -1;
462 return CA_STATUS_FAILED;
465 static void CAInitializePipe()
467 int ret = pipe(caglobals.tcp.shutdownFds);
470 ret = fcntl(caglobals.tcp.shutdownFds[0], F_GETFD);
473 ret = fcntl(caglobals.tcp.shutdownFds[0], F_SETFD, ret|FD_CLOEXEC);
477 ret = fcntl(caglobals.tcp.shutdownFds[1], F_GETFD);
481 ret = fcntl(caglobals.tcp.shutdownFds[1], F_SETFD, ret|FD_CLOEXEC);
485 close(caglobals.tcp.shutdownFds[1]);
486 close(caglobals.tcp.shutdownFds[0]);
488 caglobals.tcp.shutdownFds[0] = -1;
489 caglobals.tcp.shutdownFds[1] = -1;
491 OIC_LOG_V(ERROR, TAG, "pipe failed: %s", strerror(errno));
496 CAResult_t CATCPStartServer(const ca_thread_pool_t threadPool)
498 if (caglobals.tcp.started)
503 if (!caglobals.tcp.ipv4tcpenabled)
505 caglobals.tcp.ipv4tcpenabled = true; // only needed to run CA tests
508 CAResult_t res = CATCPCreateMutex();
509 if (CA_STATUS_OK == res)
511 res = CATCPCreateCond();
513 if (CA_STATUS_OK != res)
515 OIC_LOG(ERROR, TAG, "failed to create mutex/cond");
519 ca_mutex_lock(g_mutexObjectList);
520 if (!caglobals.tcp.svrlist)
522 caglobals.tcp.svrlist = u_arraylist_create();
524 ca_mutex_unlock(g_mutexObjectList);
526 res = CACreateAcceptSocket();
527 if (CA_STATUS_OK != res)
529 OIC_LOG(ERROR, TAG, "failed to create accept socket");
533 // create pipe for fast shutdown
535 CHECKFD(caglobals.tcp.shutdownFds[0]);
536 CHECKFD(caglobals.tcp.shutdownFds[1]);
538 caglobals.tcp.terminate = false;
539 res = ca_thread_pool_add_task(threadPool, CAReceiveHandler, NULL);
540 if (CA_STATUS_OK != res)
542 OIC_LOG(ERROR, TAG, "thread_pool_add_task failed");
545 OIC_LOG(DEBUG, TAG, "CAReceiveHandler thread started successfully.");
547 caglobals.tcp.started = true;
551 void CATCPStopServer()
554 ca_mutex_lock(g_mutexObjectList);
556 // set terminate flag
557 caglobals.tcp.terminate = true;
559 if (caglobals.tcp.shutdownFds[1] != -1)
561 close(caglobals.tcp.shutdownFds[1]);
562 // receive thread will stop immediately
565 if (caglobals.tcp.started)
567 ca_cond_wait(g_condObjectList, g_mutexObjectList);
569 caglobals.tcp.started = false;
572 ca_mutex_unlock(g_mutexObjectList);
574 if (-1 != g_acceptServerFD)
576 close(g_acceptServerFD);
577 g_acceptServerFD = -1;
580 CATCPDisconnectAll();
585 void CATCPSetPacketReceiveCallback(CATCPPacketReceivedCallback callback)
587 g_packetReceivedCallback = callback;
590 static size_t CACheckPayloadLength(const void *data, size_t dlen)
592 VERIFY_NON_NULL_RET(data, TAG, "data", -1);
594 coap_transport_type transport = coap_get_tcp_header_type_from_initbyte(
595 ((unsigned char *)data)[0] >> 4);
597 coap_pdu_t *pdu = coap_new_pdu(transport, dlen);
600 OIC_LOG(ERROR, TAG, "outpdu is null");
604 int ret = coap_pdu_parse((unsigned char *) data, dlen, pdu, transport);
607 OIC_LOG(ERROR, TAG, "pdu parse failed");
608 coap_delete_pdu(pdu);
612 size_t payloadLen = 0;
613 size_t headerSize = coap_get_tcp_header_length_for_transport(transport);
614 OIC_LOG_V(DEBUG, TAG, "headerSize : %d, pdu length : %d",
615 headerSize, pdu->length);
616 if (pdu->length > headerSize)
618 payloadLen = (unsigned char *) pdu->hdr + pdu->length - pdu->data;
626 static void sendData(const CAEndpoint_t *endpoint,
627 const void *data, size_t dlen)
629 // #1. get TCP Server object from list
631 CATCPSessionInfo_t *svritem = CAGetTCPSessionInfoFromEndpoint(endpoint, &index);
634 // if there is no connection info, connect to TCP Server
635 svritem = CAConnectTCPSession(endpoint);
638 OIC_LOG(ERROR, TAG, "Failed to create TCP server object");
639 g_TCPErrorHandler(endpoint, data, dlen, CA_SEND_FAILED);
644 // #2. check payload length
645 size_t payloadLen = CACheckPayloadLength(data, dlen);
646 // if payload length is zero, disconnect from TCP server
649 OIC_LOG(DEBUG, TAG, "payload length is zero, disconnect from remote device");
650 CADisconnectTCPSession(svritem, index);
654 // #3. check connection state
657 // if file descriptor value is wrong, remove TCP Server info from list
658 OIC_LOG(ERROR, TAG, "Failed to connect to TCP server");
659 CADisconnectTCPSession(svritem, index);
660 g_TCPErrorHandler(endpoint, data, dlen, CA_SEND_FAILED);
664 // #4. send data to TCP Server
665 ssize_t remainLen = dlen;
668 ssize_t len = send(svritem->fd, data, remainLen, 0);
671 if (EWOULDBLOCK != errno)
673 OIC_LOG_V(ERROR, TAG, "unicast ipv4tcp sendTo failed: %s", strerror(errno));
674 g_TCPErrorHandler(endpoint, data, dlen, CA_SEND_FAILED);
681 } while (remainLen > 0);
683 OIC_LOG_V(INFO, TAG, "unicast ipv4tcp sendTo is successful: %zu bytes", dlen);
686 void CATCPSendData(CAEndpoint_t *endpoint, const void *data, uint32_t datalen,
689 VERIFY_NON_NULL_VOID(endpoint, TAG, "endpoint is NULL");
690 VERIFY_NON_NULL_VOID(data, TAG, "data is NULL");
694 if (caglobals.tcp.ipv4tcpenabled && (endpoint->adapter & CA_ADAPTER_TCP))
696 sendData(endpoint, data, datalen);
701 CAResult_t CAGetTCPInterfaceInformation(CAEndpoint_t **info, uint32_t *size)
703 VERIFY_NON_NULL(info, TAG, "info is NULL");
704 VERIFY_NON_NULL(size, TAG, "size is NULL");
706 return CA_NOT_SUPPORTED;
709 CATCPSessionInfo_t *CAConnectTCPSession(const CAEndpoint_t *endpoint)
711 VERIFY_NON_NULL_RET(endpoint, TAG, "endpoint is NULL", NULL);
713 // #1. create TCP server object
714 CATCPSessionInfo_t *svritem = (CATCPSessionInfo_t *) OICCalloc(1, sizeof (*svritem));
717 OIC_LOG(ERROR, TAG, "Out of memory");
720 memcpy(svritem->sep.endpoint.addr, endpoint->addr, sizeof(svritem->sep.endpoint.addr));
721 svritem->sep.endpoint.port = endpoint->port;
723 // #2. create the socket and connect to TCP server
724 if (caglobals.tcp.ipv4tcpenabled)
726 int fd = CATCPCreateSocket(AF_INET, svritem);
733 // #3. add TCP connection info to list
735 ca_mutex_lock(g_mutexObjectList);
736 if (caglobals.tcp.svrlist)
738 bool res = u_arraylist_add(caglobals.tcp.svrlist, svritem);
741 OIC_LOG(ERROR, TAG, "u_arraylist_add failed.");
744 ca_mutex_unlock(g_mutexObjectList);
748 ca_mutex_unlock(g_mutexObjectList);
756 CAResult_t CADisconnectTCPSession(CATCPSessionInfo_t *svritem, size_t index)
758 VERIFY_NON_NULL(svritem, TAG, "svritem is NULL");
760 ca_mutex_lock(g_mutexObjectList);
762 // close the socket and remove TCP connection info in list
763 if (svritem->fd >= 0)
767 u_arraylist_remove(caglobals.tcp.svrlist, index);
768 OICFree(svritem->recvData);
770 ca_mutex_unlock(g_mutexObjectList);
775 void CATCPDisconnectAll()
777 ca_mutex_lock(g_mutexObjectList);
778 uint32_t length = u_arraylist_length(caglobals.tcp.svrlist);
780 CATCPSessionInfo_t *svritem = NULL;
781 for (size_t i = 0; i < length; i++)
783 svritem = (CATCPSessionInfo_t *) u_arraylist_get(caglobals.tcp.svrlist, i);
784 if (svritem && svritem->fd >= 0)
786 shutdown(svritem->fd, SHUT_RDWR);
788 OICFree(svritem->recvData);
791 u_arraylist_destroy(caglobals.tcp.svrlist);
792 ca_mutex_unlock(g_mutexObjectList);
795 CATCPSessionInfo_t *CAGetTCPSessionInfoFromEndpoint(const CAEndpoint_t *endpoint,
798 VERIFY_NON_NULL_RET(endpoint, TAG, "endpoint is NULL", NULL);
799 VERIFY_NON_NULL_RET(index, TAG, "index is NULL", NULL);
801 // get connection info from list
802 uint32_t length = u_arraylist_length(caglobals.tcp.svrlist);
803 for (size_t i = 0; i < length; i++)
805 CATCPSessionInfo_t *svritem = (CATCPSessionInfo_t *) u_arraylist_get(
806 caglobals.tcp.svrlist, i);
812 if (!strncmp(svritem->sep.endpoint.addr, endpoint->addr,
813 sizeof(svritem->sep.endpoint.addr))
814 && (svritem->sep.endpoint.port == endpoint->port))
824 CATCPSessionInfo_t *CAGetSessionInfoFromFD(int fd, size_t *index)
826 ca_mutex_lock(g_mutexObjectList);
828 // check from the last item.
829 CATCPSessionInfo_t *svritem = NULL;
830 uint32_t length = u_arraylist_length(caglobals.tcp.svrlist);
831 for (size_t i = 0; i < length; i++)
833 svritem = (CATCPSessionInfo_t *) u_arraylist_get(caglobals.tcp.svrlist, i);
835 if (svritem && svritem->fd == fd)
838 ca_mutex_unlock(g_mutexObjectList);
843 ca_mutex_unlock(g_mutexObjectList);
848 size_t CAGetTotalLengthFromHeader(const unsigned char *recvBuffer)
850 OIC_LOG(DEBUG, TAG, "IN - CAGetTotalLengthFromHeader");
852 coap_transport_type transport = coap_get_tcp_header_type_from_initbyte(
853 ((unsigned char *)recvBuffer)[0] >> 4);
854 size_t optPaylaodLen = coap_get_length_from_header((unsigned char *)recvBuffer,
856 size_t headerLen = coap_get_tcp_header_length((unsigned char *)recvBuffer);
858 OIC_LOG_V(DEBUG, TAG, "option/paylaod length [%d]", optPaylaodLen);
859 OIC_LOG_V(DEBUG, TAG, "header length [%d]", headerLen);
860 OIC_LOG_V(DEBUG, TAG, "total data length [%d]", headerLen + optPaylaodLen);
862 OIC_LOG(DEBUG, TAG, "OUT - CAGetTotalLengthFromHeader");
863 return headerLen + optPaylaodLen;
866 void CATCPSetErrorHandler(CATCPErrorHandleCallback errorHandleCallback)
868 g_TCPErrorHandler = errorHandleCallback;