resource/csdk/connectivity/src/tcp_adapter/catcpadapter.c

   1 /* ****************************************************************
   2  *
   3  * Copyright 2015 Samsung Electronics All Rights Reserved.
   4  *
   5  *
   6  *
   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
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  ******************************************************************/
  20
  21 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <stdint.h>
  25
  26 #ifndef __STDC_FORMAT_MACROS
  27 #define __STDC_FORMAT_MACROS
  28 #endif
  29 #include <inttypes.h>
  30
  31 #include "cainterface.h"
  32 #include "catcpadapter.h"
  33 #include "catcpinterface.h"
  34 #include "caqueueingthread.h"
  35 #include "caadapterutils.h"
  36 #include "camutex.h"
  37 #include "uarraylist.h"
  38 #include "caremotehandler.h"
  39 #include "logger.h"
  40 #include "oic_malloc.h"
  41 #include "oic_string.h"
  42
  43 /**
  44  * Logging tag for module name.
  45  */
  46 #define TAG "OIC_CA_TCP_ADAP"
  47
  48 /**
  49  * Holds internal thread TCP data information.
  50  */
  51 typedef struct
  52 {
  53     CAEndpoint_t *remoteEndpoint;
  54     void *data;
  55     size_t dataLen;
  56     bool isMulticast;
  57 } CATCPData;
  58
  59 #define CA_TCP_LISTEN_BACKLOG  3
  60
  61 #define CA_TCP_SELECT_TIMEOUT 10
  62
  63 /**
  64  * Queue handle for Send Data.
  65  */
  66 static CAQueueingThread_t *g_sendQueueHandle = NULL;
  67
  68 /**
  69  * Network Packet Received Callback to CA.
  70  */
  71 static CANetworkPacketReceivedCallback g_networkPacketCallback = NULL;
  72
  73 /**
  74  * Adapter Changed Callback to CA.
  75  */
  76 static CAAdapterChangeCallback g_networkChangeCallback = NULL;
  77
  78 /**
  79  * Connection Changed Callback to CA.
  80  */
  81 static CAConnectionChangeCallback g_connectionChangeCallback = NULL;
  82
  83 /**
  84  * error Callback to CA adapter.
  85  */
  86 static CAErrorHandleCallback g_errorCallback = NULL;
  87
  88 static void CATCPPacketReceivedCB(const CASecureEndpoint_t *sep,
  89                                   const void *data, uint32_t dataLength);
  90
  91 /**
  92  * KeepAlive Connected or Disconnected Callback to CA adapter.
  93  */
  94 static CAKeepAliveConnectionCallback g_connKeepAliveCallback = NULL;
  95
  96 static CAResult_t CATCPInitializeQueueHandles();
  97
  98 static void CATCPDeinitializeQueueHandles();
  99
 100 static void CATCPSendDataThread(void *threadData);
 101
 102 static CATCPData *CACreateTCPData(const CAEndpoint_t *remoteEndpoint,
 103                                   const void *data, size_t dataLength,
 104                                   bool isMulticast);
 105 void CAFreeTCPData(CATCPData *ipData);
 106
 107 static void CADataDestroyer(void *data, uint32_t size);
 108
 109 CAResult_t CATCPInitializeQueueHandles()
 110 {
 111     // Check if the message queue is already initialized
 112     if (g_sendQueueHandle)
 113     {
 114         OIC_LOG(DEBUG, TAG, "send queue handle is already initialized!");
 115         return CA_STATUS_OK;
 116     }
 117
 118     // Create send message queue
 119     g_sendQueueHandle = OICMalloc(sizeof(CAQueueingThread_t));
 120     if (!g_sendQueueHandle)
 121     {
 122         OIC_LOG(ERROR, TAG, "Memory allocation failed!");
 123         return CA_MEMORY_ALLOC_FAILED;
 124     }
 125
 126     if (CA_STATUS_OK != CAQueueingThreadInitialize(g_sendQueueHandle,
 127                                 (const ca_thread_pool_t)caglobals.tcp.threadpool,
 128                                 CATCPSendDataThread, CADataDestroyer))
 129     {
 130         OIC_LOG(ERROR, TAG, "Failed to Initialize send queue thread");
 131         OICFree(g_sendQueueHandle);
 132         g_sendQueueHandle = NULL;
 133         return CA_STATUS_FAILED;
 134     }
 135
 136     return CA_STATUS_OK;
 137 }
 138
 139 void CATCPDeinitializeQueueHandles()
 140 {
 141     CAQueueingThreadDestroy(g_sendQueueHandle);
 142     OICFree(g_sendQueueHandle);
 143     g_sendQueueHandle = NULL;
 144 }
 145
 146 void CATCPConnectionStateCB(const char *ipAddress, CANetworkStatus_t status)
 147 {
 148     (void)ipAddress;
 149     (void)status;
 150 }
 151
 152 void CATCPPacketReceivedCB(const CASecureEndpoint_t *sep, const void *data,
 153                            uint32_t dataLength)
 154 {
 155     VERIFY_NON_NULL_VOID(sep, TAG, "sep is NULL");
 156     VERIFY_NON_NULL_VOID(data, TAG, "data is NULL");
 157
 158     OIC_LOG_V(DEBUG, TAG, "Address: %s, port:%d", sep->endpoint.addr, sep->endpoint.port);
 159
 160     if (g_networkPacketCallback)
 161     {
 162         g_networkPacketCallback(sep, data, dataLength);
 163     }
 164 }
 165
 166 void CATCPErrorHandler(const CAEndpoint_t *endpoint, const void *data,
 167                        uint32_t dataLength, CAResult_t result)
 168 {
 169     VERIFY_NON_NULL_VOID(endpoint, TAG, "endpoint is NULL");
 170     VERIFY_NON_NULL_VOID(data, TAG, "data is NULL");
 171
 172     if (g_errorCallback)
 173     {
 174         g_errorCallback(endpoint, data, dataLength, result);
 175     }
 176 }
 177
 178 static void CATCPConnectionHandler(const char *addr, uint16_t port, bool isConnected)
 179 {
 180     CAEndpoint_t endpoint = { .adapter =  CA_ADAPTER_TCP,
 181                               .port = port };
 182     OICStrcpy(endpoint.addr, sizeof(endpoint.addr), addr);
 183
 184     // Pass the changed connection status to RI Layer for keepalive.
 185     if (g_connKeepAliveCallback)
 186     {
 187         g_connKeepAliveCallback(&endpoint, isConnected);
 188     }
 189
 190     // Pass the changed connection status to CAUtil.
 191     if (g_connectionChangeCallback)
 192     {
 193         g_connectionChangeCallback(&endpoint, isConnected);
 194     }
 195 }
 196
 197 void CATCPSetKeepAliveCallbacks(CAKeepAliveConnectionCallback ConnHandler)
 198 {
 199     g_connKeepAliveCallback = ConnHandler;
 200 }
 201
 202 static void CAInitializeTCPGlobals()
 203 {
 204     caglobals.tcp.ipv4.fd = -1;
 205     caglobals.tcp.ipv6.fd = -1;
 206     caglobals.tcp.selectTimeout = CA_TCP_SELECT_TIMEOUT;
 207     caglobals.tcp.listenBacklog = CA_TCP_LISTEN_BACKLOG;
 208     caglobals.tcp.svrlist = NULL;
 209
 210     CATransportFlags_t flags = 0;
 211     if (caglobals.client)
 212     {
 213         flags |= caglobals.clientFlags;
 214     }
 215     if (caglobals.server)
 216     {
 217         flags |= caglobals.serverFlags;
 218     }
 219
 220     caglobals.tcp.ipv4tcpenabled = flags & CA_IPV4;
 221     caglobals.tcp.ipv6tcpenabled = flags & CA_IPV6;
 222 }
 223
 224 CAResult_t CAInitializeTCP(CARegisterConnectivityCallback registerCallback,
 225                            CANetworkPacketReceivedCallback networkPacketCallback,
 226                            CAAdapterChangeCallback netCallback,
 227                            CAConnectionChangeCallback connCallback,
 228                            CAErrorHandleCallback errorCallback, ca_thread_pool_t handle)
 229 {
 230     OIC_LOG(DEBUG, TAG, "IN");
 231     VERIFY_NON_NULL(registerCallback, TAG, "registerCallback");
 232     VERIFY_NON_NULL(networkPacketCallback, TAG, "networkPacketCallback");
 233     VERIFY_NON_NULL(netCallback, TAG, "netCallback");
 234 #ifndef SINGLE_THREAD
 235     VERIFY_NON_NULL(handle, TAG, "thread pool handle");
 236 #endif
 237
 238     g_networkChangeCallback = netCallback;
 239     g_connectionChangeCallback = connCallback;
 240     g_networkPacketCallback = networkPacketCallback;
 241     g_errorCallback = errorCallback;
 242
 243     CAInitializeTCPGlobals();
 244 #ifndef SINGLE_THREAD
 245     caglobals.tcp.threadpool = handle;
 246 #endif
 247
 248     CATCPSetConnectionChangedCallback(CATCPConnectionHandler);
 249     CATCPSetPacketReceiveCallback(CATCPPacketReceivedCB);
 250     CATCPSetErrorHandler(CATCPErrorHandler);
 251
 252     CAConnectivityHandler_t tcpHandler = {
 253         .startAdapter = CAStartTCP,
 254         .startListenServer = CAStartTCPListeningServer,
 255         .stopListenServer = CAStopTCPListeningServer,
 256         .startDiscoveryServer = CAStartTCPDiscoveryServer,
 257         .sendData = CASendTCPUnicastData,
 258         .sendDataToAll = CASendTCPMulticastData,
 259         .GetnetInfo = CAGetTCPInterfaceInformation,
 260         .readData = CAReadTCPData,
 261         .stopAdapter = CAStopTCP,
 262         .terminate = CATerminateTCP,
 263         .cType = CA_ADAPTER_TCP};
 264
 265     registerCallback(tcpHandler);
 266
 267     OIC_LOG(INFO, TAG, "OUT IntializeTCP is Success");
 268     return CA_STATUS_OK;
 269 }
 270
 271 CAResult_t CAStartTCP()
 272 {
 273     OIC_LOG(DEBUG, TAG, "IN");
 274
 275     // Specific the port number received from application.
 276     caglobals.tcp.ipv4.port = caglobals.ports.tcp.u4;
 277     caglobals.tcp.ipv6.port = caglobals.ports.tcp.u6;
 278
 279 #ifndef SINGLE_THREAD
 280     if (CA_STATUS_OK != CATCPInitializeQueueHandles())
 281     {
 282         OIC_LOG(ERROR, TAG, "Failed to Initialize Queue Handle");
 283         CATerminateTCP();
 284         return CA_STATUS_FAILED;
 285     }
 286
 287     // Start send queue thread
 288     if (CA_STATUS_OK != CAQueueingThreadStart(g_sendQueueHandle))
 289     {
 290         OIC_LOG(ERROR, TAG, "Failed to Start Send Data Thread");
 291         return CA_STATUS_FAILED;
 292     }
 293
 294 #else
 295     CAResult_t ret = CATCPStartServer();
 296     if (CA_STATUS_OK != ret)
 297     {
 298         OIC_LOG_V(DEBUG, TAG, "CATCPStartServer failed[%d]", ret);
 299         return ret;
 300     }
 301 #endif
 302
 303     return CA_STATUS_OK;
 304 }
 305
 306 CAResult_t CAStartTCPListeningServer()
 307 {
 308 #ifndef SINGLE_THREAD
 309     if (!caglobals.server)
 310     {
 311         caglobals.server = true;    // only needed to run CA tests
 312     }
 313
 314     CAResult_t ret = CATCPStartServer((const ca_thread_pool_t)caglobals.tcp.threadpool);
 315     if (CA_STATUS_OK != ret)
 316     {
 317         OIC_LOG_V(ERROR, TAG, "Failed to start listening server![%d]", ret);
 318         return ret;
 319     }
 320 #endif
 321
 322     return CA_STATUS_OK;
 323 }
 324
 325 CAResult_t CAStopTCPListeningServer()
 326 {
 327     return CA_STATUS_OK;
 328 }
 329
 330 CAResult_t CAStartTCPDiscoveryServer()
 331 {
 332     if (!caglobals.client)
 333     {
 334         caglobals.client = true;    // only needed to run CA tests
 335     }
 336
 337     CAResult_t ret = CATCPStartServer((const ca_thread_pool_t)caglobals.tcp.threadpool);
 338     if (CA_STATUS_OK != ret)
 339     {
 340         OIC_LOG_V(ERROR, TAG, "Failed to start discovery server![%d]", ret);
 341         return ret;
 342     }
 343
 344     return CA_STATUS_OK;
 345 }
 346
 347 static size_t CAQueueTCPData(bool isMulticast, const CAEndpoint_t *endpoint,
 348                              const void *data, size_t dataLength)
 349 {
 350     VERIFY_NON_NULL_RET(endpoint, TAG, "endpoint", -1);
 351     VERIFY_NON_NULL_RET(data, TAG, "data", -1);
 352
 353     if (0 == dataLength)
 354     {
 355         OIC_LOG(ERROR, TAG, "Invalid Data Length");
 356         return -1;
 357     }
 358
 359     VERIFY_NON_NULL_RET(g_sendQueueHandle, TAG, "sendQueueHandle", -1);
 360
 361     // Create TCPData to add to queue
 362     CATCPData *tcpData = CACreateTCPData(endpoint, data, dataLength, isMulticast);
 363     if (!tcpData)
 364     {
 365         OIC_LOG(ERROR, TAG, "Failed to create ipData!");
 366         return -1;
 367     }
 368     // Add message to send queue
 369     CAQueueingThreadAddData(g_sendQueueHandle, tcpData, sizeof(CATCPData));
 370
 371     return dataLength;
 372 }
 373
 374 int32_t CASendTCPUnicastData(const CAEndpoint_t *endpoint,
 375                              const void *data, uint32_t dataLength)
 376 {
 377     OIC_LOG(DEBUG, TAG, "IN");
 378 #ifndef SINGLE_THREAD
 379     return CAQueueTCPData(false, endpoint, data, dataLength);
 380 #else
 381     CATCPSendData(endpoint, data, dataLength, false);
 382     return dataLength;
 383 #endif
 384 }
 385
 386 int32_t CASendTCPMulticastData(const CAEndpoint_t *endpoint,
 387                                const void *data, uint32_t dataLength)
 388 {
 389     return CAQueueTCPData(true, endpoint, data, dataLength);
 390 }
 391
 392 CAResult_t CAReadTCPData()
 393 {
 394     OIC_LOG(DEBUG, TAG, "IN");
 395 #ifdef SINGLE_THREAD
 396     CATCPPullData();
 397 #endif
 398     return CA_STATUS_OK;
 399 }
 400
 401 CAResult_t CAStopTCP()
 402 {
 403 #ifndef SINGLE_THREAD
 404     if (g_sendQueueHandle && g_sendQueueHandle->threadMutex)
 405     {
 406         CAQueueingThreadStop(g_sendQueueHandle);
 407     }
 408 #endif
 409
 410     CATCPStopServer();
 411
 412     //Re-initializing the Globals to start them again
 413     CAInitializeTCPGlobals();
 414
 415     return CA_STATUS_OK;
 416 }
 417
 418 void CATerminateTCP()
 419 {
 420     CATCPSetPacketReceiveCallback(NULL);
 421
 422 #ifndef SINGLE_THREAD
 423     CATCPDeinitializeQueueHandles();
 424 #endif
 425 }
 426
 427 void CATCPSendDataThread(void *threadData)
 428 {
 429     CATCPData *tcpData = (CATCPData *) threadData;
 430     if (!tcpData)
 431     {
 432         OIC_LOG(DEBUG, TAG, "Invalid TCP data!");
 433         return;
 434     }
 435
 436     if (tcpData->isMulticast)
 437     {
 438         //Processing for sending multicast
 439         OIC_LOG(DEBUG, TAG, "Send Multicast Data is called, not supported");
 440         return;
 441     }
 442     else
 443     {
 444         //Processing for sending unicast
 445         CATCPSendData(tcpData->remoteEndpoint, tcpData->data, tcpData->dataLen, false);
 446     }
 447 }
 448
 449 CATCPData *CACreateTCPData(const CAEndpoint_t *remoteEndpoint, const void *data,
 450                            size_t dataLength, bool isMulticast)
 451 {
 452     VERIFY_NON_NULL_RET(remoteEndpoint, TAG, "remoteEndpoint is NULL", NULL);
 453     VERIFY_NON_NULL_RET(data, TAG, "data is NULL", NULL);
 454
 455     CATCPData *tcpData = (CATCPData *) OICCalloc(1, sizeof(*tcpData));
 456     if (!tcpData)
 457     {
 458         OIC_LOG(ERROR, TAG, "Memory allocation failed!");
 459         return NULL;
 460     }
 461
 462     tcpData->remoteEndpoint = CACloneEndpoint(remoteEndpoint);
 463     tcpData->data = (void *) OICMalloc(dataLength);
 464     if (!tcpData->data)
 465     {
 466         OIC_LOG(ERROR, TAG, "Memory allocation failed!");
 467         CAFreeTCPData(tcpData);
 468         return NULL;
 469     }
 470
 471     memcpy(tcpData->data, data, dataLength);
 472     tcpData->dataLen = dataLength;
 473
 474     tcpData->isMulticast = isMulticast;
 475
 476     return tcpData;
 477 }
 478
 479 void CAFreeTCPData(CATCPData *tcpData)
 480 {
 481     VERIFY_NON_NULL_VOID(tcpData, TAG, "tcpData is NULL");
 482
 483     CAFreeEndpoint(tcpData->remoteEndpoint);
 484     OICFree(tcpData->data);
 485     OICFree(tcpData);
 486 }
 487
 488 void CADataDestroyer(void *data, uint32_t size)
 489 {
 490     if (size < sizeof(CATCPData))
 491     {
 492         OIC_LOG_V(ERROR, TAG, "Destroy data too small %p %" PRIu32, data, size);
 493     }
 494     CATCPData *TCPData = (CATCPData *) data;
 495
 496     CAFreeTCPData(TCPData);
 497 }
 498
 499 #ifdef SINGLE_THREAD
 500 size_t CAGetTotalLengthFromPacketHeader(const unsigned char *recvBuffer, size_t size)
 501 {
 502     OIC_LOG(DEBUG, TAG, "IN - CAGetTotalLengthFromHeader");
 503
 504     if (NULL == recvBuffer || !size)
 505     {
 506         OIC_LOG(ERROR, TAG, "recvBuffer is NULL");
 507         return 0;
 508     }
 509
 510     coap_transport_type transport = coap_get_tcp_header_type_from_initbyte(
 511             ((unsigned char *)recvBuffer)[0] >> 4);
 512     size_t optPaylaodLen = coap_get_length_from_header((unsigned char *)recvBuffer,
 513                                                         transport);
 514     size_t headerLen = coap_get_tcp_header_length((unsigned char *)recvBuffer);
 515
 516     OIC_LOG_V(DEBUG, TAG, "option/paylaod length [%d]", optPaylaodLen);
 517     OIC_LOG_V(DEBUG, TAG, "header length [%d]", headerLen);
 518     OIC_LOG_V(DEBUG, TAG, "total data length [%d]", headerLen + optPaylaodLen);
 519
 520     OIC_LOG(DEBUG, TAG, "OUT - CAGetTotalLengthFromHeader");
 521     return headerLen + optPaylaodLen;
 522 }
 523
 524 void CAGetTCPHeaderDetails(unsigned char* recvBuffer, coap_transport_type *transport,
 525                            size_t *headerlen)
 526 {
 527     if (NULL == recvBuffer)
 528     {
 529         OIC_LOG(ERROR, TAG, "recvBuffer is NULL");
 530         return;
 531     }
 532
 533     if (NULL == transport)
 534     {
 535         OIC_LOG(ERROR, TAG, "transport is NULL");
 536         return;
 537     }
 538
 539     if (NULL == headerlen)
 540     {
 541         OIC_LOG(ERROR, TAG, "headerlen is NULL");
 542         return;
 543     }
 544
 545     *transport = coap_get_tcp_header_type_from_initbyte(
 546         ((unsigned char *)recvBuffer)[0] >> 4);
 547     *headerlen = coap_get_tcp_header_length_for_transport(*transport);
 548 }
 549 #endif