lib/ovs-thread.c

   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 #include <config.h>
  18 #include "ovs-thread.h"
  19 #include <errno.h>
  20 #include <poll.h>
  21 #include <stdlib.h>
  22 #include <unistd.h>
  23 #include "compiler.h"
  24 #include "poll-loop.h"
  25 #include "socket-util.h"
  26 #include "util.h"
  27
  28 #ifdef __CHECKER__
  29 /* Omit the definitions in this file because they are somewhat difficult to
  30  * write without prompting "sparse" complaints, without ugliness or
  31  * cut-and-paste.  Since "sparse" is just a checker, not a compiler, it
  32  * doesn't matter that we don't define them. */
  33 #else
  34 #include "vlog.h"
  35
  36 VLOG_DEFINE_THIS_MODULE(ovs_thread);
  37
  38 /* If there is a reason that we cannot fork anymore (unless the fork will be
  39  * immediately followed by an exec), then this points to a string that
  40  * explains why. */
  41 static const char *must_not_fork;
  42
  43 /* True if we created any threads beyond the main initial thread. */
  44 static bool multithreaded;
  45
  46 #define LOCK_FUNCTION(TYPE, FUN) \
  47     void \
  48     ovs_##TYPE##_##FUN##_at(const struct ovs_##TYPE *l_, \
  49                             const char *where) \
  50     { \
  51         struct ovs_##TYPE *l = CONST_CAST(struct ovs_##TYPE *, l_); \
  52         int error = pthread_##TYPE##_##FUN(&l->lock); \
  53         if (OVS_UNLIKELY(error)) { \
  54             ovs_abort(error, "pthread_%s_%s failed", #TYPE, #FUN); \
  55         } \
  56         l->where = where; \
  57     }
  58 LOCK_FUNCTION(mutex, lock);
  59 LOCK_FUNCTION(rwlock, rdlock);
  60 LOCK_FUNCTION(rwlock, wrlock);
  61
  62 #define TRY_LOCK_FUNCTION(TYPE, FUN) \
  63     int \
  64     ovs_##TYPE##_##FUN##_at(const struct ovs_##TYPE *l_, \
  65                             const char *where) \
  66     { \
  67         struct ovs_##TYPE *l = CONST_CAST(struct ovs_##TYPE *, l_); \
  68         int error = pthread_##TYPE##_##FUN(&l->lock); \
  69         if (OVS_UNLIKELY(error) && error != EBUSY) { \
  70             ovs_abort(error, "pthread_%s_%s failed", #TYPE, #FUN); \
  71         } \
  72         if (!error) { \
  73             l->where = where; \
  74         } \
  75         return error; \
  76     }
  77 TRY_LOCK_FUNCTION(mutex, trylock);
  78 TRY_LOCK_FUNCTION(rwlock, tryrdlock);
  79 TRY_LOCK_FUNCTION(rwlock, trywrlock);
  80
  81 #define UNLOCK_FUNCTION(TYPE, FUN) \
  82     void \
  83     ovs_##TYPE##_##FUN(const struct ovs_##TYPE *l_) \
  84     { \
  85         struct ovs_##TYPE *l = CONST_CAST(struct ovs_##TYPE *, l_); \
  86         int error; \
  87         l->where = NULL; \
  88         error = pthread_##TYPE##_##FUN(&l->lock); \
  89         if (OVS_UNLIKELY(error)) { \
  90             ovs_abort(error, "pthread_%s_%sfailed", #TYPE, #FUN); \
  91         } \
  92     }
  93 UNLOCK_FUNCTION(mutex, unlock);
  94 UNLOCK_FUNCTION(mutex, destroy);
  95 UNLOCK_FUNCTION(rwlock, unlock);
  96 UNLOCK_FUNCTION(rwlock, destroy);
  97
  98 #define XPTHREAD_FUNC1(FUNCTION, PARAM1)                \
  99     void                                                \
 100     x##FUNCTION(PARAM1 arg1)                            \
 101     {                                                   \
 102         int error = FUNCTION(arg1);                     \
 103         if (OVS_UNLIKELY(error)) {                      \
 104             ovs_abort(error, "%s failed", #FUNCTION);   \
 105         }                                               \
 106     }
 107 #define XPTHREAD_FUNC2(FUNCTION, PARAM1, PARAM2)        \
 108     void                                                \
 109     x##FUNCTION(PARAM1 arg1, PARAM2 arg2)               \
 110     {                                                   \
 111         int error = FUNCTION(arg1, arg2);               \
 112         if (OVS_UNLIKELY(error)) {                      \
 113             ovs_abort(error, "%s failed", #FUNCTION);   \
 114         }                                               \
 115     }
 116
 117 XPTHREAD_FUNC1(pthread_mutex_lock, pthread_mutex_t *);
 118 XPTHREAD_FUNC1(pthread_mutex_unlock, pthread_mutex_t *);
 119 XPTHREAD_FUNC1(pthread_mutexattr_init, pthread_mutexattr_t *);
 120 XPTHREAD_FUNC1(pthread_mutexattr_destroy, pthread_mutexattr_t *);
 121 XPTHREAD_FUNC2(pthread_mutexattr_settype, pthread_mutexattr_t *, int);
 122 XPTHREAD_FUNC2(pthread_mutexattr_gettype, pthread_mutexattr_t *, int *);
 123
 124 XPTHREAD_FUNC2(pthread_cond_init, pthread_cond_t *, pthread_condattr_t *);
 125 XPTHREAD_FUNC1(pthread_cond_destroy, pthread_cond_t *);
 126 XPTHREAD_FUNC1(pthread_cond_signal, pthread_cond_t *);
 127 XPTHREAD_FUNC1(pthread_cond_broadcast, pthread_cond_t *);
 128
 129 typedef void destructor_func(void *);
 130 XPTHREAD_FUNC2(pthread_key_create, pthread_key_t *, destructor_func *);
 131
 132 void
 133 ovs_mutex_init(const struct ovs_mutex *l_, int type)
 134 {
 135     struct ovs_mutex *l = CONST_CAST(struct ovs_mutex *, l_);
 136     pthread_mutexattr_t attr;
 137     int error;
 138
 139     l->where = NULL;
 140     xpthread_mutexattr_init(&attr);
 141     xpthread_mutexattr_settype(&attr, type);
 142     error = pthread_mutex_init(&l->lock, &attr);
 143     if (OVS_UNLIKELY(error)) {
 144         ovs_abort(error, "pthread_mutex_init failed");
 145     }
 146     xpthread_mutexattr_destroy(&attr);
 147 }
 148
 149 void
 150 ovs_rwlock_init(const struct ovs_rwlock *l_)
 151 {
 152     struct ovs_rwlock *l = CONST_CAST(struct ovs_rwlock *, l_);
 153     int error;
 154
 155     l->where = NULL;
 156     error = pthread_rwlock_init(&l->lock, NULL);
 157     if (OVS_UNLIKELY(error)) {
 158         ovs_abort(error, "pthread_rwlock_init failed");
 159     }
 160 }
 161
 162 void
 163 ovs_mutex_cond_wait(pthread_cond_t *cond, const struct ovs_mutex *mutex_)
 164 {
 165     struct ovs_mutex *mutex = CONST_CAST(struct ovs_mutex *, mutex_);
 166     int error = pthread_cond_wait(cond, &mutex->lock);
 167     if (OVS_UNLIKELY(error)) {
 168         ovs_abort(error, "pthread_cond_wait failed");
 169     }
 170 }
 171
 172 void
 173 xpthread_create(pthread_t *threadp, pthread_attr_t *attr,
 174                 void *(*start)(void *), void *arg)
 175 {
 176     pthread_t thread;
 177     int error;
 178
 179     forbid_forking("multiple threads exist");
 180     multithreaded = true;
 181
 182     error = pthread_create(threadp ? threadp : &thread, attr, start, arg);
 183     if (error) {
 184         ovs_abort(error, "pthread_create failed");
 185     }
 186 }
 187 \f
 188 bool
 189 ovsthread_once_start__(struct ovsthread_once *once)
 190 {
 191     ovs_mutex_lock(&once->mutex);
 192     if (!ovsthread_once_is_done__(once)) {
 193         return false;
 194     }
 195     ovs_mutex_unlock(&once->mutex);
 196     return true;
 197 }
 198
 199 void
 200 ovsthread_once_done(struct ovsthread_once *once)
 201 {
 202     atomic_store(&once->done, true);
 203     ovs_mutex_unlock(&once->mutex);
 204 }
 205 \f
 206 /* Asserts that the process has not yet created any threads (beyond the initial
 207  * thread).
 208  *
 209  * ('where' is used in logging.  Commonly one would use
 210  * assert_single_threaded() to automatically provide the caller's source file
 211  * and line number for 'where'.) */
 212 void
 213 assert_single_threaded_at(const char *where)
 214 {
 215     if (multithreaded) {
 216         VLOG_FATAL("%s: attempted operation not allowed when multithreaded",
 217                    where);
 218     }
 219 }
 220
 221 /* Forks the current process (checking that this is allowed).  Aborts with
 222  * VLOG_FATAL if fork() returns an error, and otherwise returns the value
 223  * returned by fork().
 224  *
 225  * ('where' is used in logging.  Commonly one would use xfork() to
 226  * automatically provide the caller's source file and line number for
 227  * 'where'.) */
 228 pid_t
 229 xfork_at(const char *where)
 230 {
 231     pid_t pid;
 232
 233     if (must_not_fork) {
 234         VLOG_FATAL("%s: attempted to fork but forking not allowed (%s)",
 235                    where, must_not_fork);
 236     }
 237
 238     pid = fork();
 239     if (pid < 0) {
 240         VLOG_FATAL("%s: fork failed (%s)", where, ovs_strerror(errno));
 241     }
 242     return pid;
 243 }
 244
 245 /* Notes that the process must not call fork() from now on, for the specified
 246  * 'reason'.  (The process may still fork() if it execs itself immediately
 247  * afterward.) */
 248 void
 249 forbid_forking(const char *reason)
 250 {
 251     ovs_assert(reason != NULL);
 252     must_not_fork = reason;
 253 }
 254
 255 /* Returns true if the process is allowed to fork, false otherwise. */
 256 bool
 257 may_fork(void)
 258 {
 259     return !must_not_fork;
 260 }
 261 #endif