resource/csdk/connectivity/src/ip_adapter/caipadapter.c

   1 /* ****************************************************************
   2  *
   3  * Copyright 2014 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 #include "caipadapter.h"
  21
  22 #include <stdio.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25 #include <stdint.h>
  26
  27 #include "caipinterface.h"
  28 #include "caqueueingthread.h"
  29 #include "caadapterutils.h"
  30 #ifdef __WITH_DTLS__
  31 #include "caadapternetdtls.h"
  32 #endif
  33 #include "camutex.h"
  34 #include "uarraylist.h"
  35 #include "caremotehandler.h"
  36 #include "logger.h"
  37 #include "oic_malloc.h"
  38 #include "oic_string.h"
  39
  40 /**
  41  * Logging tag for module name.
  42  */
  43 #define TAG "OIC_CA_IP_ADAP"
  44
  45 #ifndef SINGLE_THREAD
  46 /**
  47  * Holds inter thread ip data information.
  48  */
  49 typedef struct
  50 {
  51     CAEndpoint_t *remoteEndpoint;
  52     void *data;
  53     uint32_t dataLen;
  54     bool isMulticast;
  55 } CAIPData_t;
  56
  57 /**
  58  * Queue handle for Send Data.
  59  */
  60 static CAQueueingThread_t *g_sendQueueHandle = NULL;
  61 #endif
  62
  63 /**
  64  * Network Packet Received Callback to CA.
  65  */
  66 static CANetworkPacketReceivedCallback g_networkPacketCallback = NULL;
  67
  68 /**
  69  * Network Changed Callback to CA.
  70  */
  71 static CAAdapterChangeCallback g_networkChangeCallback = NULL;
  72
  73 /**
  74  * error Callback to CA adapter.
  75  */
  76 static CAErrorHandleCallback g_errorCallback = NULL;
  77
  78 static void CAIPPacketReceivedCB(const CASecureEndpoint_t *endpoint,
  79                                  const void *data, uint32_t dataLength);
  80 #ifdef __WITH_DTLS__
  81 static void CAIPPacketSendCB(CAEndpoint_t *endpoint,
  82                              const void *data, uint32_t dataLength);
  83 #endif
  84
  85 #ifndef SINGLE_THREAD
  86
  87 static CAResult_t CAIPInitializeQueueHandles();
  88
  89 static void CAIPDeinitializeQueueHandles();
  90
  91 static void CAIPSendDataThread(void *threadData);
  92
  93 static CAIPData_t *CACreateIPData(const CAEndpoint_t *remoteEndpoint,
  94                                   const void *data, uint32_t dataLength,
  95                                   bool isMulticast);
  96
  97 void CAFreeIPData(CAIPData_t *ipData);
  98
  99 static void CADataDestroyer(void *data, uint32_t size);
 100
 101 CAResult_t CAIPInitializeQueueHandles()
 102 {
 103     // Check if the message queue is already initialized
 104     if (g_sendQueueHandle)
 105     {
 106         OIC_LOG(DEBUG, TAG, "send queue handle is already initialized!");
 107         return CA_STATUS_OK;
 108     }
 109
 110     // Create send message queue
 111     g_sendQueueHandle = OICMalloc(sizeof(CAQueueingThread_t));
 112     if (!g_sendQueueHandle)
 113     {
 114         OIC_LOG(ERROR, TAG, "Memory allocation failed!");
 115         return CA_MEMORY_ALLOC_FAILED;
 116     }
 117
 118     if (CA_STATUS_OK != CAQueueingThreadInitialize(g_sendQueueHandle,
 119                                 (const ca_thread_pool_t)caglobals.ip.threadpool,
 120                                 CAIPSendDataThread, CADataDestroyer))
 121     {
 122         OIC_LOG(ERROR, TAG, "Failed to Initialize send queue thread");
 123         OICFree(g_sendQueueHandle);
 124         g_sendQueueHandle = NULL;
 125         return CA_STATUS_FAILED;
 126     }
 127
 128     return CA_STATUS_OK;
 129 }
 130
 131 void CAIPDeinitializeQueueHandles()
 132 {
 133     CAQueueingThreadDestroy(g_sendQueueHandle);
 134     OICFree(g_sendQueueHandle);
 135     g_sendQueueHandle = NULL;
 136 }
 137
 138 #endif // SINGLE_THREAD
 139
 140 void CAIPConnectionStateCB(CATransportAdapter_t adapter, CANetworkStatus_t status)
 141 {
 142     if (g_networkChangeCallback)
 143     {
 144         g_networkChangeCallback(adapter, status);
 145     }
 146     else
 147     {
 148         OIC_LOG(ERROR, TAG, "g_networkChangeCallback is NULL");
 149     }
 150 }
 151
 152 #ifdef __WITH_DTLS__
 153 static void CAIPPacketSendCB(CAEndpoint_t *endpoint, const void *data, uint32_t dataLength)
 154 {
 155     VERIFY_NON_NULL_VOID(endpoint, TAG, "endpoint is NULL");
 156     VERIFY_NON_NULL_VOID(data, TAG, "data is NULL");
 157
 158     CAIPSendData(endpoint, data, dataLength, false);
 159 }
 160 #endif
 161
 162
 163 void CAIPPacketReceivedCB(const CASecureEndpoint_t *sep, const void *data,
 164                           uint32_t dataLength)
 165 {
 166     VERIFY_NON_NULL_VOID(sep, TAG, "sep is NULL");
 167     VERIFY_NON_NULL_VOID(data, TAG, "data is NULL");
 168
 169     OIC_LOG_V(DEBUG, TAG, "Address: %s, port:%d", sep->endpoint.addr, sep->endpoint.port);
 170
 171     if (g_networkPacketCallback)
 172     {
 173         g_networkPacketCallback(sep, data, dataLength);
 174     }
 175 }
 176
 177 void CAIPErrorHandler(const CAEndpoint_t *endpoint, const void *data,
 178                       uint32_t dataLength, CAResult_t result)
 179 {
 180     VERIFY_NON_NULL_VOID(endpoint, TAG, "endpoint is NULL");
 181     VERIFY_NON_NULL_VOID(data, TAG, "data is NULL");
 182
 183     if (g_errorCallback)
 184     {
 185         g_errorCallback(endpoint, data, dataLength, result);
 186     }
 187 }
 188
 189 static void CAInitializeIPGlobals()
 190 {
 191     caglobals.ip.u6.fd  = -1;
 192     caglobals.ip.u6s.fd = -1;
 193     caglobals.ip.u4.fd  = -1;
 194     caglobals.ip.u4s.fd = -1;
 195     caglobals.ip.m6.fd  = -1;
 196     caglobals.ip.m6s.fd = -1;
 197     caglobals.ip.m4.fd  = -1;
 198     caglobals.ip.m4s.fd = -1;
 199     caglobals.ip.u6.port  = 0;
 200     caglobals.ip.u6s.port = 0;
 201     caglobals.ip.u4.port  = 0;
 202     caglobals.ip.u4s.port = 0;
 203     caglobals.ip.m6.port  = CA_COAP;
 204     caglobals.ip.m6s.port = CA_SECURE_COAP;
 205     caglobals.ip.m4.port  = CA_COAP;
 206     caglobals.ip.m4s.port = CA_SECURE_COAP;
 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     caglobals.ip.ipv6enabled = flags & CA_IPV6;
 218     caglobals.ip.ipv4enabled = flags & CA_IPV4;
 219     caglobals.ip.dualstack = caglobals.ip.ipv6enabled && caglobals.ip.ipv4enabled;
 220 }
 221
 222 CAResult_t CAInitializeIP(CARegisterConnectivityCallback registerCallback,
 223                           CANetworkPacketReceivedCallback networkPacketCallback,
 224                           CAAdapterChangeCallback netCallback,
 225                           CAErrorHandleCallback errorCallback, ca_thread_pool_t handle)
 226 {
 227     OIC_LOG(DEBUG, TAG, "IN");
 228     VERIFY_NON_NULL(registerCallback, TAG, "registerCallback");
 229     VERIFY_NON_NULL(networkPacketCallback, TAG, "networkPacketCallback");
 230     VERIFY_NON_NULL(netCallback, TAG, "netCallback");
 231 #ifndef SINGLE_THREAD
 232     VERIFY_NON_NULL(handle, TAG, "thread pool handle");
 233 #endif
 234
 235     g_networkChangeCallback = netCallback;
 236     g_networkPacketCallback = networkPacketCallback;
 237     g_errorCallback = errorCallback;
 238
 239     CAInitializeIPGlobals();
 240     caglobals.ip.threadpool = handle;
 241
 242     CAIPSetErrorHandler(CAIPErrorHandler);
 243     CAIPSetPacketReceiveCallback(CAIPPacketReceivedCB);
 244 #ifndef SINGLE_THREAD
 245     CAIPSetConnectionStateChangeCallback(CAIPConnectionStateCB);
 246 #endif
 247 #ifdef __WITH_DTLS__
 248     CAAdapterNetDtlsInit();
 249
 250     CADTLSSetAdapterCallbacks(CAIPPacketReceivedCB, CAIPPacketSendCB, 0);
 251 #endif
 252
 253     static const CAConnectivityHandler_t ipHandler =
 254         {
 255             .startAdapter = CAStartIP,
 256             .stopAdapter = CAStopIP,
 257             .startListenServer = CAStartIPListeningServer,
 258             .stopListenServer = CAStopIPListeningServer,
 259             .startDiscoveryServer = CAStartIPDiscoveryServer,
 260             .sendData = CASendIPUnicastData,
 261             .sendDataToAll = CASendIPMulticastData,
 262             .GetnetInfo = CAGetIPInterfaceInformation,
 263             .readData = CAReadIPData,
 264             .terminate = CATerminateIP,
 265             .cType = CA_ADAPTER_IP
 266         };
 267     registerCallback(ipHandler);
 268
 269     OIC_LOG(INFO, TAG, "OUT IntializeIP is Success");
 270     return CA_STATUS_OK;
 271 }
 272
 273 CAResult_t CAStartIP()
 274 {
 275     // Specific the port number received from application.
 276     caglobals.ip.u6.port  = caglobals.ports.udp.u6;
 277     caglobals.ip.u6s.port = caglobals.ports.udp.u6s;
 278     caglobals.ip.u4.port  = caglobals.ports.udp.u4;
 279     caglobals.ip.u4s.port = caglobals.ports.udp.u4s;
 280
 281     CAIPStartNetworkMonitor();
 282 #ifdef SINGLE_THREAD
 283     uint16_t unicastPort = 55555;
 284     // Address is hardcoded as we are using Single Interface
 285     CAResult_t ret = CAIPStartServer();
 286     if (CA_STATUS_OK != ret)
 287     {
 288         OIC_LOG_V(DEBUG, TAG, "CAIPStartServer failed[%d]", ret);
 289         return ret;
 290     }
 291 #else
 292     if (CA_STATUS_OK != CAIPInitializeQueueHandles())
 293     {
 294         OIC_LOG(ERROR, TAG, "Failed to Initialize Queue Handle");
 295         CATerminateIP();
 296         return CA_STATUS_FAILED;
 297     }
 298
 299     // Start send queue thread
 300     if (CA_STATUS_OK != CAQueueingThreadStart(g_sendQueueHandle))
 301     {
 302         OIC_LOG(ERROR, TAG, "Failed to Start Send Data Thread");
 303         return CA_STATUS_FAILED;
 304     }
 305
 306     CAResult_t ret = CAIPStartServer((const ca_thread_pool_t)caglobals.ip.threadpool);
 307     if (CA_STATUS_OK != ret)
 308     {
 309         OIC_LOG_V(ERROR, TAG, "Failed to start server![%d]", ret);
 310         return ret;
 311     }
 312
 313 #endif
 314
 315     return CA_STATUS_OK;
 316 }
 317
 318 CAResult_t CAStartIPListeningServer()
 319 {
 320     CAResult_t ret = CAIPStartListenServer();
 321     if (CA_STATUS_OK != ret)
 322     {
 323         OIC_LOG_V(ERROR, TAG, "Failed to start listening server![%d]", ret);
 324         return ret;
 325     }
 326
 327     return CA_STATUS_OK;
 328 }
 329
 330 CAResult_t CAStopIPListeningServer()
 331 {
 332     CAResult_t ret = CAIPStopListenServer();
 333     if (CA_STATUS_OK != ret)
 334     {
 335         OIC_LOG_V(ERROR, TAG, "Failed to stop listening server![%d]", ret);
 336     }
 337
 338     return ret;
 339 }
 340
 341 CAResult_t CAStartIPDiscoveryServer()
 342 {
 343     return CAStartIPListeningServer();
 344 }
 345
 346 static int32_t CAQueueIPData(bool isMulticast, const CAEndpoint_t *endpoint,
 347                              const void *data, uint32_t dataLength)
 348 {
 349     VERIFY_NON_NULL_RET(endpoint, TAG, "remoteEndpoint", -1);
 350     VERIFY_NON_NULL_RET(data, TAG, "data", -1);
 351
 352     if (0 == dataLength)
 353     {
 354         OIC_LOG(ERROR, TAG, "Invalid Data Length");
 355         return -1;
 356     }
 357
 358 #ifdef SINGLE_THREAD
 359
 360     CAIPSendData(endpoint, data, dataLength, isMulticast);
 361     return dataLength;
 362
 363 #else
 364
 365     VERIFY_NON_NULL_RET(g_sendQueueHandle, TAG, "sendQueueHandle", -1);
 366     // Create IPData to add to queue
 367     CAIPData_t *ipData = CACreateIPData(endpoint, data, dataLength, isMulticast);
 368     if (!ipData)
 369     {
 370         OIC_LOG(ERROR, TAG, "Failed to create ipData!");
 371         return -1;
 372     }
 373     // Add message to send queue
 374     CAQueueingThreadAddData(g_sendQueueHandle, ipData, sizeof(CAIPData_t));
 375
 376 #endif // SINGLE_THREAD
 377
 378     return dataLength;
 379 }
 380
 381 int32_t CASendIPUnicastData(const CAEndpoint_t *endpoint,
 382                             const void *data, uint32_t dataLength,
 383                             CADataType_t dataType)
 384 {
 385     (void)dataType;
 386     return CAQueueIPData(false, endpoint, data, dataLength);
 387 }
 388
 389 int32_t CASendIPMulticastData(const CAEndpoint_t *endpoint, const void *data, uint32_t dataLength,
 390                               CADataType_t dataType)
 391 {
 392     (void)dataType;
 393     return CAQueueIPData(true, endpoint, data, dataLength);
 394 }
 395
 396 CAResult_t CAReadIPData()
 397 {
 398     CAIPPullData();
 399     return CA_STATUS_OK;
 400 }
 401
 402 CAResult_t CAStopIP()
 403 {
 404 #ifdef __WITH_DTLS__
 405     CAAdapterNetDtlsDeInit();
 406 #endif
 407
 408 #ifndef SINGLE_THREAD
 409     if (g_sendQueueHandle && g_sendQueueHandle->threadMutex)
 410     {
 411         CAQueueingThreadStop(g_sendQueueHandle);
 412     }
 413 #endif
 414
 415     CAIPStopNetworkMonitor();
 416     CAIPStopServer();
 417     //Re-initializing the Globals to start them again
 418     CAInitializeIPGlobals();
 419
 420     return CA_STATUS_OK;
 421 }
 422
 423 void CATerminateIP()
 424 {
 425 #ifdef __WITH_DTLS__
 426     CADTLSSetAdapterCallbacks(NULL, NULL, 0);
 427 #endif
 428
 429     CAIPSetPacketReceiveCallback(NULL);
 430
 431 #ifndef SINGLE_THREAD
 432     CADeInitializeIPGlobals();
 433     CAIPDeinitializeQueueHandles();
 434 #endif
 435 }
 436
 437 #ifndef SINGLE_THREAD
 438
 439 void CAIPSendDataThread(void *threadData)
 440 {
 441     CAIPData_t *ipData = (CAIPData_t *) threadData;
 442     if (!ipData)
 443     {
 444         OIC_LOG(DEBUG, TAG, "Invalid ip data!");
 445         return;
 446     }
 447
 448     if (ipData->isMulticast)
 449     {
 450         //Processing for sending multicast
 451         OIC_LOG(DEBUG, TAG, "Send Multicast Data is called");
 452         CAIPSendData(ipData->remoteEndpoint, ipData->data, ipData->dataLen, true);
 453     }
 454     else
 455     {
 456         //Processing for sending unicast
 457 #ifdef __WITH_DTLS__
 458         if (ipData->remoteEndpoint && ipData->remoteEndpoint->flags & CA_SECURE)
 459         {
 460             OIC_LOG(DEBUG, TAG, "CAAdapterNetDtlsEncrypt called!");
 461             CAResult_t result = CAAdapterNetDtlsEncrypt(ipData->remoteEndpoint,
 462                                                ipData->data, ipData->dataLen);
 463             if (CA_STATUS_OK != result)
 464             {
 465                 OIC_LOG(ERROR, TAG, "CAAdapterNetDtlsEncrypt failed!");
 466             }
 467             OIC_LOG_V(DEBUG, TAG,
 468                       "CAAdapterNetDtlsEncrypt returned with result[%d]", result);
 469         }
 470         else
 471         {
 472             OIC_LOG(DEBUG, TAG, "Send Unicast Data is called");
 473             CAIPSendData(ipData->remoteEndpoint, ipData->data, ipData->dataLen, false);
 474         }
 475 #else
 476         CAIPSendData(ipData->remoteEndpoint, ipData->data, ipData->dataLen, false);
 477 #endif
 478     }
 479 }
 480
 481 #endif
 482
 483 #ifndef SINGLE_THREAD
 484 CAIPData_t *CACreateIPData(const CAEndpoint_t *remoteEndpoint, const void *data,
 485                            uint32_t dataLength, bool isMulticast)
 486 {
 487     VERIFY_NON_NULL_RET(remoteEndpoint, TAG, "remoteEndpoint is NULL", NULL);
 488     VERIFY_NON_NULL_RET(data, TAG, "IPData is NULL", NULL);
 489
 490     CAIPData_t *ipData = (CAIPData_t *) OICMalloc(sizeof(*ipData));
 491     if (!ipData)
 492     {
 493         OIC_LOG(ERROR, TAG, "Memory allocation failed!");
 494         return NULL;
 495     }
 496
 497     ipData->remoteEndpoint = CACloneEndpoint(remoteEndpoint);
 498     ipData->data = (void *) OICMalloc(dataLength);
 499     if (!ipData->data)
 500     {
 501         OIC_LOG(ERROR, TAG, "Memory allocation failed!");
 502         CAFreeIPData(ipData);
 503         return NULL;
 504     }
 505
 506     memcpy(ipData->data, data, dataLength);
 507     ipData->dataLen = dataLength;
 508
 509     ipData->isMulticast = isMulticast;
 510
 511     return ipData;
 512 }
 513
 514 void CAFreeIPData(CAIPData_t *ipData)
 515 {
 516     VERIFY_NON_NULL_VOID(ipData, TAG, "ipData is NULL");
 517
 518     CAFreeEndpoint(ipData->remoteEndpoint);
 519     OICFree(ipData->data);
 520     OICFree(ipData);
 521 }
 522
 523 void CADataDestroyer(void *data, uint32_t size)
 524 {
 525     if (size < sizeof(CAIPData_t))
 526     {
 527         OIC_LOG_V(ERROR, TAG, "Destroy data too small %p %d", data, size);
 528     }
 529     CAIPData_t *etdata = (CAIPData_t *) data;
 530
 531     CAFreeIPData(etdata);
 532 }
 533
 534 #endif // SINGLE_THREAD