include/sparse/pthread.h

   1 /*
   2  * Copyright (c) 2013 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __CHECKER__
  18 #error "Use this header only with sparse.  It is not a correct implementation."
  19 #endif
  20
  21 /* Get actual <pthread.h> definitions for us to annotate and build on. */
  22 #include_next <pthread.h>
  23
  24 #include "compiler.h"
  25
  26 int pthread_mutex_lock(pthread_mutex_t *mutex) OVS_ACQUIRES(mutex);
  27 int pthread_mutex_unlock(pthread_mutex_t *mutex) OVS_RELEASES(mutex);
  28
  29 int pthread_rwlock_rdlock(pthread_rwlock_t *rwlock) OVS_ACQUIRES(rwlock);
  30 int pthread_rwlock_wrlock(pthread_rwlock_t *rwlock) OVS_ACQUIRES(rwlock);
  31 int pthread_rwlock_unlock(pthread_rwlock_t *rwlock) OVS_RELEASES(rwlock);
  32
  33 int pthread_cond_wait(pthread_cond_t *, pthread_mutex_t *mutex)
  34     OVS_MUST_HOLD(mutex);
  35
  36 #define pthread_mutex_trylock(MUTEX)                    \
  37     ({                                                  \
  38         int retval = pthread_mutex_trylock(mutex);      \
  39         if (!retval) {                                  \
  40             OVS_ACQUIRE(MUTEX);                         \
  41         }                                               \
  42         retval;                                         \
  43     })
  44
  45 #define pthread_rwlock_tryrdlock(RWLOCK)                \
  46     ({                                                  \
  47         int retval = pthread_rwlock_tryrdlock(rwlock);  \
  48         if (!retval) {                                  \
  49             OVS_ACQUIRE(RWLOCK);                        \
  50         }                                               \
  51         retval;                                         \
  52     })
  53 #define pthread_rwlock_trywrlock(RWLOCK)                \
  54     ({                                                  \
  55         int retval = pthread_rwlock_trywrlock(rwlock);  \
  56         if (!retval) {                                  \
  57             OVS_ACQUIRE(RWLOCK);                        \
  58         }                                               \
  59         retval;                                         \
  60     })