lib/ovs-atomic-pthreads.h

   1 /*
   2  * Copyright (c) 2013, 2014 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 /* This header implements atomic operation primitives using pthreads. */
  18 #ifndef IN_OVS_ATOMIC_H
  19 #error "This header should only be included indirectly via ovs-atomic.h."
  20 #endif
  21
  22 #include "ovs-atomic-locked.h"
  23
  24 #define OVS_ATOMIC_PTHREADS_IMPL 1
  25
  26 #define ATOMIC(TYPE) TYPE
  27
  28 #define ATOMIC_BOOL_LOCK_FREE 0
  29 #define ATOMIC_CHAR_LOCK_FREE 0
  30 #define ATOMIC_SHORT_LOCK_FREE 0
  31 #define ATOMIC_INT_LOCK_FREE 0
  32 #define ATOMIC_LONG_LOCK_FREE 0
  33 #define ATOMIC_LLONG_LOCK_FREE 0
  34 #define ATOMIC_POINTER_LOCK_FREE 0
  35
  36 typedef enum {
  37     memory_order_relaxed,
  38     memory_order_consume,
  39     memory_order_acquire,
  40     memory_order_release,
  41     memory_order_acq_rel,
  42     memory_order_seq_cst
  43 } memory_order;
  44
  45 #define ATOMIC_VAR_INIT(VALUE) (VALUE)
  46 #define atomic_init(OBJECT, VALUE) (*(OBJECT) = (VALUE), (void) 0)
  47 #define atomic_destroy(OBJECT) ((void) (OBJECT))
  48
  49 static inline void
  50 atomic_thread_fence(memory_order order OVS_UNUSED)
  51 {
  52     /* Nothing to do. */
  53 }
  54
  55 static inline void
  56 atomic_signal_fence(memory_order order OVS_UNUSED)
  57 {
  58     /* Nothing to do. */
  59 }
  60
  61 #define atomic_is_lock_free(OBJ) false
  62
  63 #define atomic_store(DST, SRC) atomic_store_locked(DST, SRC)
  64 #define atomic_store_explicit(DST, SRC, ORDER) \
  65     ((void) (ORDER), atomic_store(DST, SRC))
  66
  67 #define atomic_read(SRC, DST) atomic_read_locked(SRC, DST)
  68 #define atomic_read_explicit(SRC, DST, ORDER)   \
  69     ((void) (ORDER), atomic_read(SRC, DST))
  70
  71 #define atomic_add(RMW, ARG, ORIG) atomic_op_locked(RMW, add, ARG, ORIG)
  72 #define atomic_sub(RMW, ARG, ORIG) atomic_op_locked(RMW, sub, ARG, ORIG)
  73 #define atomic_or( RMW, ARG, ORIG) atomic_op_locked(RMW, or, ARG, ORIG)
  74 #define atomic_xor(RMW, ARG, ORIG) atomic_op_locked(RMW, xor, ARG, ORIG)
  75 #define atomic_and(RMW, ARG, ORIG) atomic_op_locked(RMW, and, ARG, ORIG)
  76
  77 #define atomic_add_explicit(RMW, ARG, ORIG, ORDER)  \
  78     ((void) (ORDER), atomic_add(RMW, ARG, ORIG))
  79 #define atomic_sub_explicit(RMW, ARG, ORIG, ORDER)  \
  80     ((void) (ORDER), atomic_sub(RMW, ARG, ORIG))
  81 #define atomic_or_explicit(RMW, ARG, ORIG, ORDER)   \
  82     ((void) (ORDER), atomic_or(RMW, ARG, ORIG))
  83 #define atomic_xor_explicit(RMW, ARG, ORIG, ORDER)  \
  84     ((void) (ORDER), atomic_xor(RMW, ARG, ORIG))
  85 #define atomic_and_explicit(RMW, ARG, ORIG, ORDER)  \
  86     ((void) (ORDER), atomic_and(RMW, ARG, ORIG))
  87 \f
  88 /* atomic_flag */
  89
  90 typedef struct {
  91     bool b;
  92 } atomic_flag;
  93 #define ATOMIC_FLAG_INIT { false }
  94
  95 static inline void
  96 atomic_flag_init(volatile atomic_flag *flag OVS_UNUSED)
  97 {
  98     /* Nothing to do. */
  99 }
 100
 101 static inline void
 102 atomic_flag_destroy(volatile atomic_flag *flag OVS_UNUSED)
 103 {
 104     /* Nothing to do. */
 105 }
 106
 107 static inline bool
 108 atomic_flag_test_and_set(volatile atomic_flag *flag_)
 109 {
 110     atomic_flag *flag = CONST_CAST(atomic_flag *, flag_);
 111     bool old_value;
 112
 113     atomic_lock__(flag);
 114     old_value = flag->b;
 115     flag->b = true;
 116     atomic_unlock__(flag);
 117
 118     return old_value;
 119 }
 120
 121 static inline bool
 122 atomic_flag_test_and_set_explicit(volatile atomic_flag *flag,
 123                                   memory_order order OVS_UNUSED)
 124 {
 125     return atomic_flag_test_and_set(flag);
 126 }
 127
 128 static inline void
 129 atomic_flag_clear(volatile atomic_flag *flag_)
 130 {
 131     atomic_flag *flag = CONST_CAST(atomic_flag *, flag_);
 132
 133     atomic_lock__(flag);
 134     flag->b = false;
 135     atomic_unlock__(flag);
 136 }
 137
 138 static inline void
 139 atomic_flag_clear_explicit(volatile atomic_flag *flag,
 140                            memory_order order OVS_UNUSED)
 141 {
 142     atomic_flag_clear(flag);
 143 }