resource/csdk/connectivity/common/src/camutex_pthreads.c

   1 //******************************************************************
   2 //
   3 // Copyright 2015 Intel Mobile Communications GmbH 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 //
  22 //*********************************************************************
  23
  24 /**
  25  * @file
  26  * This file provides APIs related to mutex and semaphores.
  27  */
  28
  29 // Defining _POSIX_C_SOURCE macro with 199309L (or greater) as value
  30 // causes header files to expose definitions
  31 // corresponding to the POSIX.1b, Real-time extensions
  32 // (IEEE Std 1003.1b-1993) specification
  33 //
  34 // For this specific file, see use of clock_gettime and PTHREAD_MUTEX_DEFAULT
  35 #ifndef _POSIX_C_SOURCE
  36 #define _POSIX_C_SOURCE 200809L
  37 #endif
  38
  39 #include <string.h>
  40 #include <pthread.h>
  41 #include <errno.h>
  42 #include <unistd.h>
  43 #include <time.h>
  44 #include <sys/time.h>
  45 #include <assert.h>
  46 #include <oic_malloc.h>
  47
  48 #include "camutex.h"
  49 #include "logger.h"
  50
  51 /**
  52  * TAG
  53  * Logging tag for module name
  54  */
  55 #define TAG PCF("UMUTEX")
  56
  57 #ifdef __ANDROID__
  58 /**
  59  * Android has pthread_condattr_setclock() only in version >= 5.0, older
  60  * version do have a function called __pthread_cond_timedwait_relative()
  61  * which waits *for* the given timespec, this function is not visible in
  62  * android version >= 5.0 anymore. This is the same way as it is handled in
  63  * QT 5.5.0 in
  64  * http://code.qt.io/cgit/qt/qtbase.git/tree/src/corelib/thread/qwaitcondition_unix.cpp?h=v5.5.0#n54
  65  */
  66 static int camutex_condattr_setclock(pthread_condattr_t *, clockid_t)
  67         __attribute__ ((weakref("pthread_condattr_setclock")));
  68
  69 static int camutex_cond_timedwait_relative(pthread_cond_t*, pthread_mutex_t*, const struct timespec*)
  70         __attribute__ ((weakref("__pthread_cond_timedwait_relative")));
  71 #endif /* __ANDROID__ */
  72
  73 static const uint64_t USECS_PER_SEC         = 1000000;
  74 static const uint64_t NANOSECS_PER_USECS    = 1000;
  75 static const uint64_t NANOSECS_PER_SEC      = 1000000000L;
  76
  77 typedef struct _tagMutexInfo_t
  78 {
  79     pthread_mutex_t mutex;
  80 } ca_mutex_internal;
  81
  82 typedef struct _tagEventInfo_t
  83 {
  84     pthread_cond_t cond;
  85     pthread_condattr_t condattr;
  86 } ca_cond_internal;
  87
  88 ca_mutex ca_mutex_new(void)
  89 {
  90     ca_mutex retVal = NULL;
  91     ca_mutex_internal *mutexInfo = (ca_mutex_internal*) OICMalloc(sizeof(ca_mutex_internal));
  92     if (NULL != mutexInfo)
  93     {
  94         // create the mutex with the attributes set
  95         int ret=pthread_mutex_init(&(mutexInfo->mutex), PTHREAD_MUTEX_DEFAULT);
  96         if (0 == ret)
  97         {
  98             retVal = (ca_mutex) mutexInfo;
  99         }
 100         else
 101         {
 102             OIC_LOG_V(ERROR, TAG, "%s Failed to initialize mutex !", __func__);
 103             OICFree(mutexInfo);
 104         }
 105     }
 106
 107     return retVal;
 108 }
 109
 110 bool ca_mutex_free(ca_mutex mutex)
 111 {
 112     bool bRet=false;
 113
 114     ca_mutex_internal *mutexInfo = (ca_mutex_internal*) mutex;
 115     if (mutexInfo)
 116     {
 117         int ret = pthread_mutex_destroy(&mutexInfo->mutex);
 118         if (0 == ret)
 119         {
 120             OICFree(mutexInfo);
 121             bRet=true;
 122         }
 123         else
 124         {
 125             OIC_LOG_V(ERROR, TAG, "%s Failed to free mutex !", __func__);
 126         }
 127     }
 128     else
 129     {
 130         OIC_LOG_V(ERROR, TAG, "%s Invalid mutex !", __func__);
 131     }
 132
 133     return bRet;
 134 }
 135
 136 void ca_mutex_lock(ca_mutex mutex)
 137 {
 138     ca_mutex_internal *mutexInfo = (ca_mutex_internal*) mutex;
 139     if (mutexInfo)
 140     {
 141         int ret = pthread_mutex_lock(&mutexInfo->mutex);
 142         if(ret != 0)
 143         {
 144             OIC_LOG_V(ERROR, TAG, "Pthread Mutex lock failed: %d", ret);
 145             exit(ret);
 146         }
 147     }
 148     else
 149     {
 150         OIC_LOG_V(ERROR, TAG, "%s Invalid mutex !", __func__);
 151         return;
 152     }
 153 }
 154
 155 bool ca_mutex_trylock(ca_mutex mutex)
 156 {
 157     if (NULL == mutex)
 158     {
 159         OIC_LOG_V(ERROR, TAG, "%s Invalid mutex !", __func__);
 160         return false;
 161     }
 162
 163     bool bRet = false;
 164
 165     ca_mutex_internal *mutexInfo = (ca_mutex_internal*) mutex;
 166
 167     int result = pthread_mutex_trylock(&mutexInfo->mutex);
 168
 169     switch (result)
 170     {
 171         case 0:
 172             // Success
 173             bRet = true;
 174             break;
 175         case EINVAL:
 176             OIC_LOG_V(ERROR, TAG, "%s: Invalid mutex !", __func__);
 177             break;
 178         case EBUSY:
 179         default:
 180             break;
 181     }
 182
 183     return bRet;
 184 }
 185
 186 void ca_mutex_unlock(ca_mutex mutex)
 187 {
 188     ca_mutex_internal *mutexInfo = (ca_mutex_internal*) mutex;
 189     if (mutexInfo)
 190     {
 191         int ret = pthread_mutex_unlock(&mutexInfo->mutex);
 192         if(ret != 0)
 193         {
 194             OIC_LOG_V(ERROR, TAG, "Pthread Mutex unlock failed: %d", ret);
 195             exit(ret);
 196         }
 197         (void)ret;
 198     }
 199     else
 200     {
 201           OIC_LOG_V(ERROR, TAG, "%s: Invalid mutex !", __func__);
 202           return;
 203     }
 204 }
 205
 206 ca_cond ca_cond_new(void)
 207 {
 208     ca_cond retVal = NULL;
 209     ca_cond_internal *eventInfo = (ca_cond_internal*) OICMalloc(sizeof(ca_cond_internal));
 210     if (NULL != eventInfo)
 211     {
 212         int ret = pthread_condattr_init(&(eventInfo->condattr));
 213         if(0 != ret)
 214         {
 215             OIC_LOG_V(ERROR, TAG, "%s: Failed to initialize condition variable attribute %d!",
 216                     __func__, ret);
 217             OICFree(eventInfo);
 218             return retVal;
 219         }
 220
 221 #if defined(__ANDROID__) || _POSIX_TIMERS > 0
 222 #ifdef __ANDROID__
 223         if (camutex_condattr_setclock) {
 224             ret = camutex_condattr_setclock(&(eventInfo->condattr), CLOCK_MONOTONIC);
 225 #else
 226         {
 227             ret = pthread_condattr_setclock(&(eventInfo->condattr), CLOCK_MONOTONIC);
 228 #endif /*  __ANDROID__ */
 229             if(0 != ret)
 230             {
 231                 OIC_LOG_V(ERROR, TAG, "%s: Failed to set condition variable clock %d!",
 232                         __func__, ret);
 233                 pthread_condattr_destroy(&(eventInfo->condattr));
 234                 OICFree(eventInfo);
 235                 return retVal;
 236             }
 237         }
 238 #endif /* defined(__ANDROID__) || _POSIX_TIMERS > 0 */
 239         ret = pthread_cond_init(&(eventInfo->cond), &(eventInfo->condattr));
 240         if (0 == ret)
 241         {
 242             retVal = (ca_cond) eventInfo;
 243         }
 244         else
 245         {
 246             OIC_LOG_V(ERROR, TAG, "%s: Failed to initialize condition variable %d!", __func__, ret);
 247             pthread_condattr_destroy(&(eventInfo->condattr));
 248             OICFree(eventInfo);
 249         }
 250     }
 251
 252     return retVal;
 253 }
 254
 255 void ca_cond_free(ca_cond cond)
 256 {
 257     ca_cond_internal *eventInfo = (ca_cond_internal*) cond;
 258     if (eventInfo != NULL)
 259     {
 260         int ret = pthread_cond_destroy(&(eventInfo->cond));
 261         int ret2 = pthread_condattr_destroy(&(eventInfo->condattr));
 262         if (0 == ret && 0 == ret2)
 263         {
 264             OICFree(cond);
 265         }
 266         else
 267         {
 268             OIC_LOG_V(ERROR, TAG, "%s: Failed to destroy condition variable %d, %d",
 269                     __func__, ret, ret2);
 270         }
 271     }
 272     else
 273     {
 274         OIC_LOG_V(ERROR, TAG, "%s: Invalid parameter", __func__);
 275     }
 276 }
 277
 278 void ca_cond_signal(ca_cond cond)
 279 {
 280     ca_cond_internal *eventInfo = (ca_cond_internal*) cond;
 281     if (eventInfo != NULL)
 282     {
 283         int ret = pthread_cond_signal(&(eventInfo->cond));
 284         if (0 != ret)
 285         {
 286             OIC_LOG_V(ERROR, TAG, "%s: Failed to signal condition variable", __func__);
 287         }
 288     }
 289     else
 290     {
 291         OIC_LOG_V(ERROR, TAG, "%s: Invalid parameter", __func__);
 292     }
 293 }
 294
 295 void ca_cond_broadcast(ca_cond cond)
 296 {
 297     ca_cond_internal* eventInfo = (ca_cond_internal*) cond;
 298     if (eventInfo != NULL)
 299     {
 300         int ret = pthread_cond_broadcast(&(eventInfo->cond));
 301         if (0 != ret)
 302         {
 303             OIC_LOG_V(ERROR, TAG, "%s: failed to signal condition variable", __func__);
 304         }
 305     }
 306     else
 307     {
 308         OIC_LOG_V(ERROR, TAG, "%s: Invalid parameter", __func__);
 309     }
 310 }
 311
 312 void ca_cond_wait(ca_cond cond, ca_mutex mutex)
 313 {
 314     ca_cond_wait_for(cond, mutex, 0L);
 315 }
 316
 317 struct timespec ca_get_current_time()
 318 {
 319 #if defined(__ANDROID__) || _POSIX_TIMERS > 0
 320     struct timespec ts;
 321     clock_gettime(CLOCK_MONOTONIC, &ts);
 322     return ts;
 323 #else
 324     struct timeval tv;
 325     gettimeofday(&tv, NULL);
 326     struct timespec ts;
 327     TIMEVAL_TO_TIMESPEC(&tv, &ts);
 328     return ts;
 329 #endif
 330 }
 331
 332 void ca_add_microseconds_to_timespec(struct timespec* ts, uint64_t microseconds)
 333 {
 334     time_t secPart = microseconds/USECS_PER_SEC;
 335     uint64_t nsecPart = (microseconds % USECS_PER_SEC) * NANOSECS_PER_USECS;
 336     uint64_t totalNs = ts->tv_nsec + nsecPart;
 337     time_t secOfNs = totalNs/NANOSECS_PER_SEC;
 338
 339     ts->tv_nsec = (totalNs)% NANOSECS_PER_SEC;
 340     ts->tv_sec += secPart + secOfNs;
 341 }
 342
 343 CAWaitResult_t ca_cond_wait_for(ca_cond cond, ca_mutex mutex, uint64_t microseconds)
 344 {
 345     CAWaitResult_t retVal = CA_WAIT_INVAL;
 346
 347     ca_cond_internal *eventInfo = (ca_cond_internal*) cond;
 348     ca_mutex_internal *mutexInfo = (ca_mutex_internal*) mutex;
 349
 350     if (NULL == mutexInfo)
 351     {
 352         OIC_LOG_V(ERROR, TAG, "%s: Invalid mutex", __func__);
 353         return CA_WAIT_INVAL;
 354     }
 355
 356     if (NULL == eventInfo)
 357     {
 358         OIC_LOG_V(ERROR, TAG, "%s: Invalid condition", __func__);
 359         return CA_WAIT_INVAL;
 360     }
 361
 362     if (microseconds > 0)
 363     {
 364         int ret;
 365         struct timespec abstime;
 366
 367 #ifdef __ANDROID__
 368         if (camutex_cond_timedwait_relative) {
 369             abstime.tv_sec = microseconds / USECS_PER_SEC;
 370             abstime.tv_nsec = (microseconds % USECS_PER_SEC) * NANOSECS_PER_USECS;
 371             //Wait for the given time
 372             ret = camutex_cond_timedwait_relative(&(eventInfo->cond), &(mutexInfo->mutex), &abstime);
 373         } else
 374 #endif
 375         {
 376              abstime = ca_get_current_time();
 377             ca_add_microseconds_to_timespec(&abstime, microseconds);
 378
 379             //Wait for the given time
 380             ret = pthread_cond_timedwait(&(eventInfo->cond), &(mutexInfo->mutex), &abstime);
 381         }
 382
 383         switch (ret)
 384         {
 385             case 0:
 386                 // Success
 387                 retVal = CA_WAIT_SUCCESS;
 388                 break;
 389             case ETIMEDOUT:
 390                 retVal = CA_WAIT_TIMEDOUT;
 391                 break;
 392             case EINVAL:
 393                 OIC_LOG_V(ERROR, TAG, "%s: condition, mutex, or abstime is Invalid", __func__);
 394                 retVal = CA_WAIT_INVAL;
 395                 break;
 396             default:
 397                 OIC_LOG_V(ERROR, TAG, "%s: pthread_cond_timedwait returned %d", __func__, retVal);
 398                 retVal = CA_WAIT_INVAL;
 399                 break;
 400         }
 401     }
 402     else
 403     {
 404         // Wait forever
 405         int ret = pthread_cond_wait(&eventInfo->cond, &mutexInfo->mutex);
 406         retVal = ret == 0 ? CA_WAIT_SUCCESS : CA_WAIT_INVAL;
 407     }
 408
 409     return retVal;
 410 }
 411