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;
90 * Connected Callback to pass the connection information to RI.
92 static CATCPKeepAliveHandleCallback g_keepaliveCallback = NULL;
94 static CAResult_t CATCPCreateMutex();
95 static void CATCPDestroyMutex();
96 static CAResult_t CATCPCreateCond();
97 static void CATCPDestroyCond();
98 static CAResult_t CACreateAcceptSocket();
99 static void CAAcceptConnection();
100 static void CAFindReadyMessage();
101 static void CASelectReturned(fd_set *readFds, int ret);
102 static void CAReceiveMessage(int fd);
103 static void CAReceiveHandler(void *data);
104 static int CATCPCreateSocket(int family, CATCPSessionInfo_t *tcpServerInfo);
106 #define CHECKFD(FD) \
107 if (FD > caglobals.tcp.maxfd) \
108 caglobals.tcp.maxfd = FD;
110 static void CATCPDestroyMutex()
112 if (g_mutexObjectList)
114 ca_mutex_free(g_mutexObjectList);
115 g_mutexObjectList = NULL;
119 static CAResult_t CATCPCreateMutex()
121 if (!g_mutexObjectList)
123 g_mutexObjectList = ca_mutex_new();
124 if (!g_mutexObjectList)
126 OIC_LOG(ERROR, TAG, "Failed to created mutex!");
127 return CA_STATUS_FAILED;
134 static void CATCPDestroyCond()
136 if (g_condObjectList)
138 ca_cond_free(g_condObjectList);
139 g_condObjectList = NULL;
143 static CAResult_t CATCPCreateCond()
145 if (!g_condObjectList)
147 g_condObjectList = ca_cond_new();
148 if (!g_condObjectList)
150 OIC_LOG(ERROR, TAG, "Failed to created cond!");
151 return CA_STATUS_FAILED;
157 static void CAReceiveHandler(void *data)
160 OIC_LOG(DEBUG, TAG, "IN - CAReceiveHandler");
162 while (!caglobals.tcp.terminate)
164 CAFindReadyMessage();
167 ca_mutex_lock(g_mutexObjectList);
168 ca_cond_signal(g_condObjectList);
169 ca_mutex_unlock(g_mutexObjectList);
171 OIC_LOG(DEBUG, TAG, "OUT - CAReceiveHandler");
174 static void CAFindReadyMessage()
177 struct timeval timeout = { .tv_sec = caglobals.tcp.selectTimeout };
181 if (-1 != g_acceptServerFD)
183 FD_SET(g_acceptServerFD, &readFds);
185 if (-1 != caglobals.tcp.shutdownFds[0])
187 FD_SET(caglobals.tcp.shutdownFds[0], &readFds);
190 uint32_t length = u_arraylist_length(caglobals.tcp.svrlist);
191 for (size_t i = 0; i < length; i++)
193 CATCPSessionInfo_t *svritem =
194 (CATCPSessionInfo_t *) u_arraylist_get(caglobals.tcp.svrlist, i);
195 if (svritem && 0 <= svritem->fd)
197 FD_SET(svritem->fd, &readFds);
201 int ret = select(caglobals.tcp.maxfd + 1, &readFds, NULL, NULL, &timeout);
203 if (caglobals.tcp.terminate)
205 OIC_LOG_V(DEBUG, TAG, "Packet receiver Stop request received.");
212 OIC_LOG_V(FATAL, TAG, "select error %s", strerror(errno));
217 CASelectReturned(&readFds, ret);
220 static void CASelectReturned(fd_set *readFds, int ret)
224 if (g_acceptServerFD != -1 && FD_ISSET(g_acceptServerFD, readFds))
226 CAAcceptConnection();
231 uint32_t length = u_arraylist_length(caglobals.tcp.svrlist);
232 for (size_t i = 0; i < length; i++)
234 CATCPSessionInfo_t *svritem =
235 (CATCPSessionInfo_t *) u_arraylist_get(caglobals.tcp.svrlist, i);
236 if (svritem && svritem->fd >= 0)
238 if (FD_ISSET(svritem->fd, readFds))
240 CAReceiveMessage(svritem->fd);
241 FD_CLR(svritem->fd, readFds);
248 static void CAAcceptConnection()
250 struct sockaddr_storage clientaddr;
251 socklen_t clientlen = sizeof (struct sockaddr_in);
253 int sockfd = accept(g_acceptServerFD, (struct sockaddr *)&clientaddr,
257 CATCPSessionInfo_t *svritem =
258 (CATCPSessionInfo_t *) OICCalloc(1, sizeof (*svritem));
261 OIC_LOG(ERROR, TAG, "Out of memory");
266 svritem->fd = sockfd;
267 CAConvertAddrToName((struct sockaddr_storage *)&clientaddr, clientlen,
268 (char *) &svritem->sep.endpoint.addr, &svritem->sep.endpoint.port);
270 ca_mutex_lock(g_mutexObjectList);
271 bool result = u_arraylist_add(caglobals.tcp.svrlist, svritem);
274 OIC_LOG(ERROR, TAG, "u_arraylist_add failed.");
277 ca_mutex_unlock(g_mutexObjectList);
280 ca_mutex_unlock(g_mutexObjectList);
286 static void CAReceiveMessage(int fd)
288 // #1. get remote device information from file descriptor.
290 CATCPSessionInfo_t *svritem = CAGetSessionInfoFromFD(fd, &index);
293 OIC_LOG(ERROR, TAG, "there is no connection information in list");
297 // #2. get already allocated memory size.
298 size_t bufSize = (svritem->totalDataLen == 0) ? TCP_MAX_HEADER_LEN : svritem->totalDataLen;
299 if (!svritem->recvData)
301 svritem->recvData = (unsigned char *) OICCalloc(1, bufSize);
302 if (!svritem->recvData)
304 OIC_LOG(ERROR, TAG, "out of memory");
305 CADisconnectTCPSession(svritem, index);
310 // #3. receive data from remote device.
311 ssize_t recvLen = recv(fd, svritem->recvData + svritem->recvDataLen,
312 bufSize - svritem->recvDataLen, 0);
315 if(EWOULDBLOCK != errno)
317 OIC_LOG_V(ERROR, TAG, "Recvfrom failed %s", strerror(errno));
318 CADisconnectTCPSession(svritem, index);
322 svritem->recvDataLen += recvLen;
324 // #4. get actual data length from coap over tcp header.
325 if (!svritem->totalDataLen)
327 coap_transport_type transport = coap_get_tcp_header_type_from_initbyte(
328 ((unsigned char *) svritem->recvData)[0] >> 4);
330 size_t headerLen = coap_get_tcp_header_length_for_transport(transport);
331 if (svritem->recvDataLen >= headerLen)
333 svritem->totalDataLen = CAGetTotalLengthFromHeader(
334 (unsigned char *) svritem->recvData);
335 bufSize = svritem->totalDataLen;
336 unsigned char *newBuf = OICRealloc(svritem->recvData, bufSize);
339 OIC_LOG(ERROR, TAG, "out of memory");
340 CADisconnectTCPSession(svritem, index);
343 svritem->recvData = newBuf;
347 // #5. pass the received data information to upper layer.
348 if ((svritem->totalDataLen == svritem->recvDataLen) && g_packetReceivedCallback)
350 svritem->sep.endpoint.adapter = CA_ADAPTER_TCP;
351 g_packetReceivedCallback(&svritem->sep, svritem->recvData, svritem->recvDataLen);
352 OIC_LOG_V(DEBUG, TAG, "total received data len:%d", svritem->recvDataLen);
354 // initialize data info to receive next message.
355 OICFree(svritem->recvData);
356 svritem->recvData = NULL;
357 svritem->recvDataLen = 0;
358 svritem->totalDataLen = 0;
364 static int CATCPCreateSocket(int family, CATCPSessionInfo_t *svritem)
367 int fd = socket(family, SOCK_STREAM, IPPROTO_TCP);
370 OIC_LOG_V(ERROR, TAG, "create socket failed: %s", strerror(errno));
374 struct sockaddr_storage sa = { .ss_family = family };
375 CAConvertNameToAddr(svritem->sep.endpoint.addr, svritem->sep.endpoint.port, &sa);
376 socklen_t socklen = sizeof (struct sockaddr_in);
378 // connect to TCP server
379 int ret = connect(fd, (struct sockaddr *)&sa, socklen);
382 OIC_LOG(DEBUG, TAG, "connect socket success");
384 else if (EINPROGRESS == errno)
386 OIC_LOG(DEBUG, TAG, "EINPROGRESS");
388 socklen_t len = sizeof(error);
389 if (getsockopt(fd, SOL_SOCKET, SO_ERROR, &error, &len) < 0)
391 OIC_LOG(ERROR, TAG, "getsockopt() error");
397 if (ECONNREFUSED == error)
399 OIC_LOG(ERROR, TAG, "connection refused");
402 OIC_LOG(ERROR, TAG, "failed to connect socket");
405 OIC_LOG(DEBUG, TAG, "connect socket success");
409 OIC_LOG(ERROR, TAG, "failed to connect socket");
423 static CAResult_t CACreateAcceptSocket()
426 struct sockaddr_in server = { .sin_addr.s_addr = INADDR_ANY,
427 .sin_family = AF_INET,
428 .sin_port = htons(SERVER_PORT),
431 g_acceptServerFD = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
432 if (g_acceptServerFD < 0)
434 OIC_LOG(ERROR, TAG, "Failed to create socket");
438 if (-1 == setsockopt(g_acceptServerFD, SOL_SOCKET, SO_REUSEADDR, &reuse, sizeof(reuse)))
440 OIC_LOG(ERROR, TAG, "setsockopt SO_REUSEADDR");
444 int serverlen = sizeof(server);
445 if (-1 == bind(g_acceptServerFD, (struct sockaddr *)&server, serverlen))
447 OIC_LOG(ERROR, TAG, "bind() error");
451 if (listen(g_acceptServerFD, caglobals.tcp.listenBacklog) != 0)
453 OIC_LOG(ERROR, TAG, "listen() error");
457 CHECKFD(g_acceptServerFD);
462 if (g_acceptServerFD >= 0)
464 close(g_acceptServerFD);
465 g_acceptServerFD = -1;
467 return CA_STATUS_FAILED;
470 static void CAInitializePipe()
472 int ret = pipe(caglobals.tcp.shutdownFds);
475 ret = fcntl(caglobals.tcp.shutdownFds[0], F_GETFD);
478 ret = fcntl(caglobals.tcp.shutdownFds[0], F_SETFD, ret|FD_CLOEXEC);
482 ret = fcntl(caglobals.tcp.shutdownFds[1], F_GETFD);
486 ret = fcntl(caglobals.tcp.shutdownFds[1], F_SETFD, ret|FD_CLOEXEC);
490 close(caglobals.tcp.shutdownFds[1]);
491 close(caglobals.tcp.shutdownFds[0]);
493 caglobals.tcp.shutdownFds[0] = -1;
494 caglobals.tcp.shutdownFds[1] = -1;
496 OIC_LOG_V(ERROR, TAG, "pipe failed: %s", strerror(errno));
501 CAResult_t CATCPStartServer(const ca_thread_pool_t threadPool)
503 if (caglobals.tcp.started)
508 if (!caglobals.tcp.ipv4tcpenabled)
510 caglobals.tcp.ipv4tcpenabled = true; // only needed to run CA tests
513 CAResult_t res = CATCPCreateMutex();
514 if (CA_STATUS_OK == res)
516 res = CATCPCreateCond();
518 if (CA_STATUS_OK != res)
520 OIC_LOG(ERROR, TAG, "failed to create mutex/cond");
524 ca_mutex_lock(g_mutexObjectList);
525 if (!caglobals.tcp.svrlist)
527 caglobals.tcp.svrlist = u_arraylist_create();
529 ca_mutex_unlock(g_mutexObjectList);
531 res = CACreateAcceptSocket();
532 if (CA_STATUS_OK != res)
534 OIC_LOG(ERROR, TAG, "failed to create accept socket");
538 // create pipe for fast shutdown
540 CHECKFD(caglobals.tcp.shutdownFds[0]);
541 CHECKFD(caglobals.tcp.shutdownFds[1]);
543 caglobals.tcp.terminate = false;
544 res = ca_thread_pool_add_task(threadPool, CAReceiveHandler, NULL);
545 if (CA_STATUS_OK != res)
547 OIC_LOG(ERROR, TAG, "thread_pool_add_task failed");
550 OIC_LOG(DEBUG, TAG, "CAReceiveHandler thread started successfully.");
552 caglobals.tcp.started = true;
556 void CATCPStopServer()
559 ca_mutex_lock(g_mutexObjectList);
561 // set terminate flag
562 caglobals.tcp.terminate = true;
564 if (caglobals.tcp.shutdownFds[1] != -1)
566 close(caglobals.tcp.shutdownFds[1]);
567 // receive thread will stop immediately
570 if (caglobals.tcp.started)
572 ca_cond_wait(g_condObjectList, g_mutexObjectList);
574 caglobals.tcp.started = false;
577 ca_mutex_unlock(g_mutexObjectList);
579 if (-1 != g_acceptServerFD)
581 close(g_acceptServerFD);
582 g_acceptServerFD = -1;
585 CATCPDisconnectAll();
590 void CATCPSetPacketReceiveCallback(CATCPPacketReceivedCallback callback)
592 g_packetReceivedCallback = callback;
595 void CATCPSetKeepAliveCallback(CATCPKeepAliveHandleCallback keepaliveHandler)
597 g_keepaliveCallback = keepaliveHandler;
600 static size_t CACheckPayloadLength(const void *data, size_t dlen)
602 VERIFY_NON_NULL_RET(data, TAG, "data", -1);
604 coap_transport_type transport = coap_get_tcp_header_type_from_initbyte(
605 ((unsigned char *)data)[0] >> 4);
607 coap_pdu_t *pdu = coap_new_pdu(transport, dlen);
610 OIC_LOG(ERROR, TAG, "outpdu is null");
614 int ret = coap_pdu_parse((unsigned char *) data, dlen, pdu, transport);
617 OIC_LOG(ERROR, TAG, "pdu parse failed");
618 coap_delete_pdu(pdu);
622 size_t payloadLen = 0;
623 size_t headerSize = coap_get_tcp_header_length_for_transport(transport);
624 OIC_LOG_V(DEBUG, TAG, "headerSize : %d, pdu length : %d",
625 headerSize, pdu->length);
626 if (pdu->length > headerSize)
628 payloadLen = (unsigned char *) pdu->hdr + pdu->length - pdu->data;
636 static void sendData(const CAEndpoint_t *endpoint,
637 const void *data, size_t dlen)
639 // #1. get TCP Server object from list
641 CATCPSessionInfo_t *svritem = CAGetTCPSessionInfoFromEndpoint(endpoint, &index);
644 // if there is no connection info, connect to TCP Server
645 svritem = CAConnectTCPSession(endpoint);
648 OIC_LOG(ERROR, TAG, "Failed to create TCP server object");
649 g_TCPErrorHandler(endpoint, data, dlen, CA_SEND_FAILED);
654 // #2. check payload length
655 size_t payloadLen = CACheckPayloadLength(data, dlen);
656 // if payload length is zero, disconnect from TCP server
659 OIC_LOG(DEBUG, TAG, "payload length is zero, disconnect from remote device");
660 CADisconnectTCPSession(svritem, index);
664 // #3. check connection state
667 // if file descriptor value is wrong, remove TCP Server info from list
668 OIC_LOG(ERROR, TAG, "Failed to connect to TCP server");
669 CADisconnectTCPSession(svritem, index);
670 g_TCPErrorHandler(endpoint, data, dlen, CA_SEND_FAILED);
674 // #4. send data to TCP Server
675 ssize_t remainLen = dlen;
678 ssize_t len = send(svritem->fd, data, remainLen, 0);
681 if (EWOULDBLOCK != errno)
683 OIC_LOG_V(ERROR, TAG, "unicast ipv4tcp sendTo failed: %s", strerror(errno));
684 g_TCPErrorHandler(endpoint, data, dlen, CA_SEND_FAILED);
691 } while (remainLen > 0);
693 OIC_LOG_V(INFO, TAG, "unicast ipv4tcp sendTo is successful: %zu bytes", dlen);
696 void CATCPSendData(CAEndpoint_t *endpoint, const void *data, uint32_t datalen,
699 VERIFY_NON_NULL_VOID(endpoint, TAG, "endpoint is NULL");
700 VERIFY_NON_NULL_VOID(data, TAG, "data is NULL");
704 if (caglobals.tcp.ipv4tcpenabled && (endpoint->adapter & CA_ADAPTER_TCP))
706 sendData(endpoint, data, datalen);
711 CAResult_t CAGetTCPInterfaceInformation(CAEndpoint_t **info, uint32_t *size)
713 VERIFY_NON_NULL(info, TAG, "info is NULL");
714 VERIFY_NON_NULL(size, TAG, "size is NULL");
716 return CA_NOT_SUPPORTED;
719 CATCPSessionInfo_t *CAConnectTCPSession(const CAEndpoint_t *endpoint)
721 VERIFY_NON_NULL_RET(endpoint, TAG, "endpoint is NULL", NULL);
723 // #1. create TCP server object
724 CATCPSessionInfo_t *svritem = (CATCPSessionInfo_t *) OICCalloc(1, sizeof (*svritem));
727 OIC_LOG(ERROR, TAG, "Out of memory");
730 memcpy(svritem->sep.endpoint.addr, endpoint->addr, sizeof(svritem->sep.endpoint.addr));
731 svritem->sep.endpoint.port = endpoint->port;
733 // #2. create the socket and connect to TCP server
734 if (caglobals.tcp.ipv4tcpenabled)
736 int fd = CATCPCreateSocket(AF_INET, svritem);
743 // #3. add TCP connection info to list
745 ca_mutex_lock(g_mutexObjectList);
746 if (caglobals.tcp.svrlist)
748 bool res = u_arraylist_add(caglobals.tcp.svrlist, svritem);
751 OIC_LOG(ERROR, TAG, "u_arraylist_add failed.");
754 ca_mutex_unlock(g_mutexObjectList);
758 ca_mutex_unlock(g_mutexObjectList);
762 // pass the connection information to RI for keepalive.
763 if (g_keepaliveCallback)
765 g_keepaliveCallback(svritem->sep.endpoint.addr, svritem->sep.endpoint.port, true);
772 CAResult_t CADisconnectTCPSession(CATCPSessionInfo_t *svritem, size_t index)
774 VERIFY_NON_NULL(svritem, TAG, "svritem is NULL");
776 ca_mutex_lock(g_mutexObjectList);
778 // close the socket and remove TCP connection info in list
779 if (svritem->fd >= 0)
783 u_arraylist_remove(caglobals.tcp.svrlist, index);
784 OICFree(svritem->recvData);
786 ca_mutex_unlock(g_mutexObjectList);
788 // pass the connection information to RI for keepalive.
789 if (g_keepaliveCallback)
791 g_keepaliveCallback(svritem->sep.endpoint.addr, svritem->sep.endpoint.port, false);
797 void CATCPDisconnectAll()
799 ca_mutex_lock(g_mutexObjectList);
800 uint32_t length = u_arraylist_length(caglobals.tcp.svrlist);
802 CATCPSessionInfo_t *svritem = NULL;
803 for (size_t i = 0; i < length; i++)
805 svritem = (CATCPSessionInfo_t *) u_arraylist_get(caglobals.tcp.svrlist, i);
806 if (svritem && svritem->fd >= 0)
808 shutdown(svritem->fd, SHUT_RDWR);
810 OICFree(svritem->recvData);
813 u_arraylist_destroy(caglobals.tcp.svrlist);
814 ca_mutex_unlock(g_mutexObjectList);
817 CATCPSessionInfo_t *CAGetTCPSessionInfoFromEndpoint(const CAEndpoint_t *endpoint,
820 VERIFY_NON_NULL_RET(endpoint, TAG, "endpoint is NULL", NULL);
821 VERIFY_NON_NULL_RET(index, TAG, "index is NULL", NULL);
823 // get connection info from list
824 uint32_t length = u_arraylist_length(caglobals.tcp.svrlist);
825 for (size_t i = 0; i < length; i++)
827 CATCPSessionInfo_t *svritem = (CATCPSessionInfo_t *) u_arraylist_get(
828 caglobals.tcp.svrlist, i);
834 if (!strncmp(svritem->sep.endpoint.addr, endpoint->addr,
835 sizeof(svritem->sep.endpoint.addr))
836 && (svritem->sep.endpoint.port == endpoint->port))
846 CATCPSessionInfo_t *CAGetSessionInfoFromFD(int fd, size_t *index)
848 ca_mutex_lock(g_mutexObjectList);
850 // check from the last item.
851 CATCPSessionInfo_t *svritem = NULL;
852 uint32_t length = u_arraylist_length(caglobals.tcp.svrlist);
853 for (size_t i = 0; i < length; i++)
855 svritem = (CATCPSessionInfo_t *) u_arraylist_get(caglobals.tcp.svrlist, i);
857 if (svritem && svritem->fd == fd)
860 ca_mutex_unlock(g_mutexObjectList);
865 ca_mutex_unlock(g_mutexObjectList);
870 size_t CAGetTotalLengthFromHeader(const unsigned char *recvBuffer)
872 OIC_LOG(DEBUG, TAG, "IN - CAGetTotalLengthFromHeader");
874 coap_transport_type transport = coap_get_tcp_header_type_from_initbyte(
875 ((unsigned char *)recvBuffer)[0] >> 4);
876 size_t optPaylaodLen = coap_get_length_from_header((unsigned char *)recvBuffer,
878 size_t headerLen = coap_get_tcp_header_length((unsigned char *)recvBuffer);
880 OIC_LOG_V(DEBUG, TAG, "option/paylaod length [%d]", optPaylaodLen);
881 OIC_LOG_V(DEBUG, TAG, "header length [%d]", headerLen);
882 OIC_LOG_V(DEBUG, TAG, "total data length [%d]", headerLen + optPaylaodLen);
884 OIC_LOG(DEBUG, TAG, "OUT - CAGetTotalLengthFromHeader");
885 return headerLen + optPaylaodLen;
888 void CATCPSetErrorHandler(CATCPErrorHandleCallback errorHandleCallback)
890 g_TCPErrorHandler = errorHandleCallback;