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 CAEndpoint_t *endpoint, bool isConnected)
 179 {
 180     // Pass the changed connection status to RI Layer for keepalive.
 181     if (g_connKeepAliveCallback)
 182     {
 183         g_connKeepAliveCallback(endpoint, isConnected);
 184     }
 185
 186     // Pass the changed connection status to CAUtil.
 187     if (g_connectionChangeCallback)
 188     {
 189         g_connectionChangeCallback(endpoint, isConnected);
 190     }
 191 }
 192
 193 void CATCPSetKeepAliveCallbacks(CAKeepAliveConnectionCallback ConnHandler)
 194 {
 195     g_connKeepAliveCallback = ConnHandler;
 196 }
 197
 198 static void CAInitializeTCPGlobals()
 199 {
 200     caglobals.tcp.ipv4.fd = -1;
 201     caglobals.tcp.ipv4.port = 0;
 202     caglobals.tcp.ipv6.fd = -1;
 203     caglobals.tcp.ipv6.port = 0;
 204     caglobals.tcp.selectTimeout = CA_TCP_SELECT_TIMEOUT;
 205     caglobals.tcp.listenBacklog = CA_TCP_LISTEN_BACKLOG;
 206     caglobals.tcp.svrlist = NULL;
 207
 208     CATransportFlags_t flags = 0;
 209     if (caglobals.client)
 210     {
 211         flags |= caglobals.clientFlags;
 212     }
 213     if (caglobals.server)
 214     {
 215         flags |= caglobals.serverFlags;
 216     }
 217
 218     caglobals.tcp.ipv4tcpenabled = flags & CA_IPV4;
 219     caglobals.tcp.ipv6tcpenabled = flags & CA_IPV6;
 220 }
 221
 222 CAResult_t CAInitializeTCP(CARegisterConnectivityCallback registerCallback,
 223                            CANetworkPacketReceivedCallback networkPacketCallback,
 224                            CAAdapterChangeCallback netCallback,
 225                            CAConnectionChangeCallback connCallback,
 226                            CAErrorHandleCallback errorCallback, ca_thread_pool_t handle)
 227 {
 228     OIC_LOG(DEBUG, TAG, "IN");
 229     VERIFY_NON_NULL(registerCallback, TAG, "registerCallback");
 230     VERIFY_NON_NULL(networkPacketCallback, TAG, "networkPacketCallback");
 231     VERIFY_NON_NULL(netCallback, TAG, "netCallback");
 232     VERIFY_NON_NULL(handle, TAG, "thread pool handle");
 233
 234     g_networkChangeCallback = netCallback;
 235     g_connectionChangeCallback = connCallback;
 236     g_networkPacketCallback = networkPacketCallback;
 237     g_errorCallback = errorCallback;
 238
 239     CAInitializeTCPGlobals();
 240     caglobals.tcp.threadpool = handle;
 241
 242     CATCPSetConnectionChangedCallback(CATCPConnectionHandler);
 243     CATCPSetPacketReceiveCallback(CATCPPacketReceivedCB);
 244     CATCPSetErrorHandler(CATCPErrorHandler);
 245
 246     CAConnectivityHandler_t tcpHandler = {
 247         .startAdapter = CAStartTCP,
 248         .startListenServer = CAStartTCPListeningServer,
 249         .stopListenServer = CAStopTCPListeningServer,
 250         .startDiscoveryServer = CAStartTCPDiscoveryServer,
 251         .sendData = CASendTCPUnicastData,
 252         .sendDataToAll = CASendTCPMulticastData,
 253         .GetnetInfo = CAGetTCPInterfaceInformation,
 254         .readData = CAReadTCPData,
 255         .stopAdapter = CAStopTCP,
 256         .terminate = CATerminateTCP,
 257         .cType = CA_ADAPTER_TCP};
 258
 259     registerCallback(tcpHandler);
 260
 261     OIC_LOG(INFO, TAG, "OUT IntializeTCP is Success");
 262     return CA_STATUS_OK;
 263 }
 264
 265 CAResult_t CAStartTCP()
 266 {
 267     if (CA_STATUS_OK != CATCPInitializeQueueHandles())
 268     {
 269         OIC_LOG(ERROR, TAG, "Failed to Initialize Queue Handle");
 270         CATerminateTCP();
 271         return CA_STATUS_FAILED;
 272     }
 273
 274     // Start send queue thread
 275     if (CA_STATUS_OK != CAQueueingThreadStart(g_sendQueueHandle))
 276     {
 277         OIC_LOG(ERROR, TAG, "Failed to Start Send Data Thread");
 278         return CA_STATUS_FAILED;
 279     }
 280
 281     return CA_STATUS_OK;
 282 }
 283
 284 CAResult_t CAStartTCPListeningServer()
 285 {
 286     if (!caglobals.server)
 287     {
 288         caglobals.server = true;    // only needed to run CA tests
 289     }
 290
 291     CAResult_t ret = CATCPStartServer((const ca_thread_pool_t)caglobals.tcp.threadpool);
 292     if (CA_STATUS_OK != ret)
 293     {
 294         OIC_LOG_V(ERROR, TAG, "Failed to start listening server![%d]", ret);
 295         return ret;
 296     }
 297
 298     return CA_STATUS_OK;
 299 }
 300
 301 CAResult_t CAStopTCPListeningServer()
 302 {
 303     return CA_STATUS_OK;
 304 }
 305
 306 CAResult_t CAStartTCPDiscoveryServer()
 307 {
 308     if (!caglobals.client)
 309     {
 310         caglobals.client = true;    // only needed to run CA tests
 311     }
 312
 313     CAResult_t ret = CATCPStartServer((const ca_thread_pool_t)caglobals.tcp.threadpool);
 314     if (CA_STATUS_OK != ret)
 315     {
 316         OIC_LOG_V(ERROR, TAG, "Failed to start discovery server![%d]", ret);
 317         return ret;
 318     }
 319
 320     return CA_STATUS_OK;
 321 }
 322
 323 static size_t CAQueueTCPData(bool isMulticast, const CAEndpoint_t *endpoint,
 324                              const void *data, size_t dataLength)
 325 {
 326     VERIFY_NON_NULL_RET(endpoint, TAG, "endpoint", -1);
 327     VERIFY_NON_NULL_RET(data, TAG, "data", -1);
 328
 329     if (0 == dataLength)
 330     {
 331         OIC_LOG(ERROR, TAG, "Invalid Data Length");
 332         return -1;
 333     }
 334
 335     VERIFY_NON_NULL_RET(g_sendQueueHandle, TAG, "sendQueueHandle", -1);
 336
 337     // Create TCPData to add to queue
 338     CATCPData *tcpData = CACreateTCPData(endpoint, data, dataLength, isMulticast);
 339     if (!tcpData)
 340     {
 341         OIC_LOG(ERROR, TAG, "Failed to create ipData!");
 342         return -1;
 343     }
 344     // Add message to send queue
 345     CAQueueingThreadAddData(g_sendQueueHandle, tcpData, sizeof(CATCPData));
 346
 347     return dataLength;
 348 }
 349
 350 int32_t CASendTCPUnicastData(const CAEndpoint_t *endpoint,
 351                              const void *data, uint32_t dataLength)
 352 {
 353     return CAQueueTCPData(false, endpoint, data, dataLength);
 354 }
 355
 356 int32_t CASendTCPMulticastData(const CAEndpoint_t *endpoint,
 357                                const void *data, uint32_t dataLength)
 358 {
 359     return CAQueueTCPData(true, endpoint, data, dataLength);
 360 }
 361
 362 CAResult_t CAReadTCPData()
 363 {
 364     return CA_STATUS_OK;
 365 }
 366
 367 CAResult_t CAStopTCP()
 368 {
 369     if (g_sendQueueHandle && g_sendQueueHandle->threadMutex)
 370     {
 371         CAQueueingThreadStop(g_sendQueueHandle);
 372     }
 373
 374     CATCPStopServer();
 375
 376     //Re-initializing the Globals to start them again
 377     CAInitializeTCPGlobals();
 378
 379     return CA_STATUS_OK;
 380 }
 381
 382 void CATerminateTCP()
 383 {
 384     CATCPSetPacketReceiveCallback(NULL);
 385
 386     CATCPDeinitializeQueueHandles();
 387 }
 388
 389 void CATCPSendDataThread(void *threadData)
 390 {
 391     CATCPData *tcpData = (CATCPData *) threadData;
 392     if (!tcpData)
 393     {
 394         OIC_LOG(DEBUG, TAG, "Invalid TCP data!");
 395         return;
 396     }
 397
 398     if (tcpData->isMulticast)
 399     {
 400         //Processing for sending multicast
 401         OIC_LOG(DEBUG, TAG, "Send Multicast Data is called, not supported");
 402         return;
 403     }
 404     else
 405     {
 406         //Processing for sending unicast
 407         CATCPSendData(tcpData->remoteEndpoint, tcpData->data, tcpData->dataLen, false);
 408     }
 409 }
 410
 411 CATCPData *CACreateTCPData(const CAEndpoint_t *remoteEndpoint, const void *data,
 412                            size_t dataLength, bool isMulticast)
 413 {
 414     VERIFY_NON_NULL_RET(remoteEndpoint, TAG, "remoteEndpoint is NULL", NULL);
 415     VERIFY_NON_NULL_RET(data, TAG, "data is NULL", NULL);
 416
 417     CATCPData *tcpData = (CATCPData *) OICCalloc(1, sizeof(*tcpData));
 418     if (!tcpData)
 419     {
 420         OIC_LOG(ERROR, TAG, "Memory allocation failed!");
 421         return NULL;
 422     }
 423
 424     tcpData->remoteEndpoint = CACloneEndpoint(remoteEndpoint);
 425     tcpData->data = (void *) OICMalloc(dataLength);
 426     if (!tcpData->data)
 427     {
 428         OIC_LOG(ERROR, TAG, "Memory allocation failed!");
 429         CAFreeTCPData(tcpData);
 430         return NULL;
 431     }
 432
 433     memcpy(tcpData->data, data, dataLength);
 434     tcpData->dataLen = dataLength;
 435
 436     tcpData->isMulticast = isMulticast;
 437
 438     return tcpData;
 439 }
 440
 441 void CAFreeTCPData(CATCPData *tcpData)
 442 {
 443     VERIFY_NON_NULL_VOID(tcpData, TAG, "tcpData is NULL");
 444
 445     CAFreeEndpoint(tcpData->remoteEndpoint);
 446     OICFree(tcpData->data);
 447     OICFree(tcpData);
 448 }
 449
 450 void CADataDestroyer(void *data, uint32_t size)
 451 {
 452     if (size < sizeof(CATCPData))
 453     {
 454         OIC_LOG_V(ERROR, TAG, "Destroy data too small %p %" PRIu32, data, size);
 455     }
 456     CATCPData *TCPData = (CATCPData *) data;
 457
 458     CAFreeTCPData(TCPData);
 459 }