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