lib/seq.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
  19 #include "seq.h"
  20
  21 #include <stdbool.h>
  22
  23 #include "hash.h"
  24 #include "hmap.h"
  25 #include "latch.h"
  26 #include "list.h"
  27 #include "ovs-thread.h"
  28 #include "poll-loop.h"
  29
  30 /* A sequence number object. */
  31 struct seq {
  32     uint64_t value OVS_GUARDED;
  33     struct hmap waiters OVS_GUARDED; /* Contains 'struct seq_waiter's. */
  34 };
  35
  36 /* A thread waiting on a particular seq. */
  37 struct seq_waiter {
  38     struct seq *seq OVS_GUARDED;            /* Seq being waited for. */
  39     struct hmap_node hmap_node OVS_GUARDED; /* In 'seq->waiters'. */
  40     unsigned int ovsthread_id OVS_GUARDED;  /* Key in 'waiters' hmap. */
  41
  42     struct seq_thread *thread OVS_GUARDED; /* Thread preparing to wait. */
  43     struct list list_node OVS_GUARDED;     /* In 'thread->waiters'. */
  44
  45     uint64_t value OVS_GUARDED; /* seq->value we're waiting to change. */
  46 };
  47
  48 /* A thread that might be waiting on one or more seqs. */
  49 struct seq_thread {
  50     struct list waiters OVS_GUARDED; /* Contains 'struct seq_waiter's. */
  51     struct latch latch OVS_GUARDED;  /* Wakeup latch for this thread. */
  52     bool waiting OVS_GUARDED;        /* True if latch_wait() already called. */
  53 };
  54
  55 static struct ovs_mutex seq_mutex = OVS_ADAPTIVE_MUTEX_INITIALIZER;
  56
  57 static uint64_t seq_next OVS_GUARDED_BY(seq_mutex) = 1;
  58
  59 static pthread_key_t seq_thread_key;
  60
  61 static void seq_init(void);
  62 static struct seq_thread *seq_thread_get(void) OVS_REQUIRES(seq_mutex);
  63 static void seq_thread_exit(void *thread_) OVS_EXCLUDED(seq_mutex);
  64 static void seq_thread_woke(struct seq_thread *) OVS_REQUIRES(seq_mutex);
  65 static void seq_waiter_destroy(struct seq_waiter *) OVS_REQUIRES(seq_mutex);
  66 static void seq_wake_waiters(struct seq *) OVS_REQUIRES(seq_mutex);
  67
  68 /* Creates and returns a new 'seq' object. */
  69 struct seq * OVS_EXCLUDED(seq_mutex)
  70 seq_create(void)
  71 {
  72     struct seq *seq;
  73
  74     seq_init();
  75
  76     seq = xmalloc(sizeof *seq);
  77     ovs_mutex_lock(&seq_mutex);
  78     seq->value = seq_next++;
  79     hmap_init(&seq->waiters);
  80     ovs_mutex_unlock(&seq_mutex);
  81
  82     return seq;
  83 }
  84
  85 /* Destroys 'seq', waking up threads that were waiting on it, if any. */
  86 void
  87 seq_destroy(struct seq *seq)
  88      OVS_EXCLUDED(seq_mutex)
  89 {
  90     ovs_mutex_lock(&seq_mutex);
  91     seq_wake_waiters(seq);
  92     hmap_destroy(&seq->waiters);
  93     free(seq);
  94     ovs_mutex_unlock(&seq_mutex);
  95 }
  96
  97 /* Increments 'seq''s sequence number, waking up any threads that are waiting
  98  * on 'seq'. */
  99 void
 100 seq_change(struct seq *seq)
 101     OVS_EXCLUDED(seq_mutex)
 102 {
 103     ovs_mutex_lock(&seq_mutex);
 104     seq->value = seq_next++;
 105     seq_wake_waiters(seq);
 106     ovs_mutex_unlock(&seq_mutex);
 107 }
 108
 109 /* Returns 'seq''s current sequence number (which could change immediately).
 110  *
 111  * seq_read() and seq_wait() can be used together to yield a race-free wakeup
 112  * when an object changes, even without an ability to lock the object.  See
 113  * Usage in seq.h for details. */
 114 uint64_t
 115 seq_read(const struct seq *seq)
 116     OVS_EXCLUDED(seq_mutex)
 117 {
 118     uint64_t value;
 119
 120     ovs_mutex_lock(&seq_mutex);
 121     value = seq->value;
 122     ovs_mutex_unlock(&seq_mutex);
 123
 124     return value;
 125 }
 126
 127 static void
 128 seq_wait__(struct seq *seq, uint64_t value)
 129     OVS_REQUIRES(seq_mutex)
 130 {
 131     unsigned int id = ovsthread_id_self();
 132     uint32_t hash = hash_int(id, 0);
 133     struct seq_waiter *waiter;
 134
 135     HMAP_FOR_EACH_IN_BUCKET (waiter, hmap_node, hash, &seq->waiters) {
 136         if (waiter->ovsthread_id == id) {
 137             if (waiter->value != value) {
 138                 /* The current value is different from the value we've already
 139                  * waited for, */
 140                 poll_immediate_wake();
 141             } else {
 142                 /* Already waiting on 'value', nothing more to do. */
 143             }
 144             return;
 145         }
 146     }
 147
 148     waiter = xmalloc(sizeof *waiter);
 149     waiter->seq = seq;
 150     hmap_insert(&seq->waiters, &waiter->hmap_node, hash);
 151     waiter->value = value;
 152     waiter->thread = seq_thread_get();
 153     list_push_back(&waiter->thread->waiters, &waiter->list_node);
 154
 155     if (!waiter->thread->waiting) {
 156         latch_wait(&waiter->thread->latch);
 157         waiter->thread->waiting = true;
 158     }
 159 }
 160
 161 /* Causes the following poll_block() to wake up when 'seq''s sequence number
 162  * changes from 'value'.  (If 'seq''s sequence number isn't 'value', then
 163  * poll_block() won't block at all.)
 164  *
 165  * seq_read() and seq_wait() can be used together to yield a race-free wakeup
 166  * when an object changes, even without an ability to lock the object.  See
 167  * Usage in seq.h for details. */
 168 void
 169 seq_wait(const struct seq *seq_, uint64_t value)
 170     OVS_EXCLUDED(seq_mutex)
 171 {
 172     struct seq *seq = CONST_CAST(struct seq *, seq_);
 173
 174     ovs_mutex_lock(&seq_mutex);
 175     if (value == seq->value) {
 176         seq_wait__(seq, value);
 177     } else {
 178         poll_immediate_wake();
 179     }
 180     ovs_mutex_unlock(&seq_mutex);
 181 }
 182
 183 /* Called by poll_block() just before it returns, this function destroys any
 184  * seq_waiter objects associated with the current thread. */
 185 void
 186 seq_woke(void)
 187     OVS_EXCLUDED(seq_mutex)
 188 {
 189     struct seq_thread *thread;
 190
 191     seq_init();
 192
 193     thread = pthread_getspecific(seq_thread_key);
 194     if (thread) {
 195         ovs_mutex_lock(&seq_mutex);
 196         seq_thread_woke(thread);
 197         thread->waiting = false;
 198         ovs_mutex_unlock(&seq_mutex);
 199     }
 200 }
 201 \f
 202 static void
 203 seq_init(void)
 204 {
 205     static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
 206
 207     if (ovsthread_once_start(&once)) {
 208         xpthread_key_create(&seq_thread_key, seq_thread_exit);
 209         ovsthread_once_done(&once);
 210     }
 211 }
 212
 213 static struct seq_thread *
 214 seq_thread_get(void)
 215     OVS_REQUIRES(seq_mutex)
 216 {
 217     struct seq_thread *thread = pthread_getspecific(seq_thread_key);
 218     if (!thread) {
 219         thread = xmalloc(sizeof *thread);
 220         list_init(&thread->waiters);
 221         latch_init(&thread->latch);
 222         thread->waiting = false;
 223
 224         xpthread_setspecific(seq_thread_key, thread);
 225     }
 226     return thread;
 227 }
 228
 229 static void
 230 seq_thread_exit(void *thread_)
 231     OVS_EXCLUDED(seq_mutex)
 232 {
 233     struct seq_thread *thread = thread_;
 234
 235     ovs_mutex_lock(&seq_mutex);
 236     seq_thread_woke(thread);
 237     latch_destroy(&thread->latch);
 238     free(thread);
 239     ovs_mutex_unlock(&seq_mutex);
 240 }
 241
 242 static void
 243 seq_thread_woke(struct seq_thread *thread)
 244     OVS_REQUIRES(seq_mutex)
 245 {
 246     struct seq_waiter *waiter, *next_waiter;
 247
 248     LIST_FOR_EACH_SAFE (waiter, next_waiter, list_node, &thread->waiters) {
 249         ovs_assert(waiter->thread == thread);
 250         seq_waiter_destroy(waiter);
 251     }
 252     latch_poll(&thread->latch);
 253 }
 254
 255 static void
 256 seq_waiter_destroy(struct seq_waiter *waiter)
 257     OVS_REQUIRES(seq_mutex)
 258 {
 259     hmap_remove(&waiter->seq->waiters, &waiter->hmap_node);
 260     list_remove(&waiter->list_node);
 261     free(waiter);
 262 }
 263
 264 static void
 265 seq_wake_waiters(struct seq *seq)
 266     OVS_REQUIRES(seq_mutex)
 267 {
 268     struct seq_waiter *waiter, *next_waiter;
 269
 270     HMAP_FOR_EACH_SAFE (waiter, next_waiter, hmap_node, &seq->waiters) {
 271         latch_set(&waiter->thread->latch);
 272         seq_waiter_destroy(waiter);
 273     }
 274 }