sys/kern/lwkt_serialize.c

   1 /*
   2  * Copyright (c) 2005 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Matthew Dillon <dillon@backplane.com>
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  * 3. Neither the name of The DragonFly Project nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific, prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  */
  34 /*
  35  * This API provides a fast locked-bus-cycle-based serializer.  It's
  36  * basically a low level NON-RECURSIVE exclusive lock that can be held across
  37  * a blocking condition.  It is NOT a mutex.
  38  *
  39  * This serializer is primarily designed for low level situations and
  40  * interrupt/device interaction.  There are two primary facilities.  First,
  41  * the serializer facility itself.  Second, an integrated interrupt handler
  42  * disablement facility.
  43  */
  44
  45 #include <sys/param.h>
  46 #include <sys/systm.h>
  47 #include <sys/kernel.h>
  48 #include <sys/proc.h>
  49 #include <sys/rtprio.h>
  50 #include <sys/queue.h>
  51 #include <sys/thread2.h>
  52 #include <sys/serialize.h>
  53 #include <sys/sysctl.h>
  54 #include <sys/ktr.h>
  55 #include <sys/kthread.h>
  56 #include <machine/cpu.h>
  57 #include <machine/cpufunc.h>
  58 #include <machine/specialreg.h>
  59 #include <machine/clock.h>
  60 #include <sys/lock.h>
  61
  62 #ifndef SLZ_ADAPTIVE_SPINMAX
  63 #define SLZ_ADAPTIVE_SPINMAX    4096
  64 #endif
  65
  66 #define SLZ_KTR_STRING          "slz=%p"
  67 #define SLZ_KTR_ARGS            lwkt_serialize_t slz
  68
  69 #ifndef KTR_SERIALIZER
  70 #define KTR_SERIALIZER          KTR_ALL
  71 #endif
  72
  73 KTR_INFO_MASTER(slz);
  74 KTR_INFO(KTR_SERIALIZER, slz, enter_beg, 0, SLZ_KTR_STRING, SLZ_KTR_ARGS);
  75 KTR_INFO(KTR_SERIALIZER, slz, sleep_beg, 1, SLZ_KTR_STRING, SLZ_KTR_ARGS);
  76 KTR_INFO(KTR_SERIALIZER, slz, sleep_end, 2, SLZ_KTR_STRING, SLZ_KTR_ARGS);
  77 KTR_INFO(KTR_SERIALIZER, slz, exit_end, 3, SLZ_KTR_STRING, SLZ_KTR_ARGS);
  78 KTR_INFO(KTR_SERIALIZER, slz, wakeup_beg, 4, SLZ_KTR_STRING, SLZ_KTR_ARGS);
  79 KTR_INFO(KTR_SERIALIZER, slz, wakeup_end, 5, SLZ_KTR_STRING, SLZ_KTR_ARGS);
  80 KTR_INFO(KTR_SERIALIZER, slz, try, 6, SLZ_KTR_STRING, SLZ_KTR_ARGS);
  81 KTR_INFO(KTR_SERIALIZER, slz, tryfail, 7, SLZ_KTR_STRING, SLZ_KTR_ARGS);
  82 KTR_INFO(KTR_SERIALIZER, slz, tryok, 8, SLZ_KTR_STRING, SLZ_KTR_ARGS);
  83 KTR_INFO(KTR_SERIALIZER, slz, enter_end, 9, SLZ_KTR_STRING, SLZ_KTR_ARGS);
  84 KTR_INFO(KTR_SERIALIZER, slz, exit_beg, 10, SLZ_KTR_STRING, SLZ_KTR_ARGS);
  85 KTR_INFO(KTR_SERIALIZER, slz, adapt_beg, 11, SLZ_KTR_STRING, SLZ_KTR_ARGS);
  86 KTR_INFO(KTR_SERIALIZER, slz, adapt_end, 12, SLZ_KTR_STRING, SLZ_KTR_ARGS);
  87 KTR_INFO(KTR_SERIALIZER, slz, adapt_spinend, 13, "slz=%p try=%d",
  88     lwkt_serialize_t slz, int try);
  89 KTR_INFO(KTR_SERIALIZER, slz, adapt_sleepb, 14, SLZ_KTR_STRING, SLZ_KTR_ARGS);
  90 KTR_INFO(KTR_SERIALIZER, slz, adapt_sleepe, 15, SLZ_KTR_STRING, SLZ_KTR_ARGS);
  91
  92 #define logslz(name, slz)               KTR_LOG(slz_ ## name, slz)
  93 #define logslz_spinend(slz, try)        KTR_LOG(slz_adapt_spinend, slz, try)
  94
  95 static void lwkt_serialize_sleep(void *info);
  96 static void lwkt_serialize_wakeup(void *info);
  97
  98 void
  99 lwkt_serialize_init(lwkt_serialize_t s)
 100 {
 101     atomic_intr_init(&s->interlock);
 102 #ifdef INVARIANTS
 103     s->last_td = (void *)-4;
 104 #endif
 105 }
 106
 107 void
 108 lwkt_serialize_enter(lwkt_serialize_t s)
 109 {
 110     ASSERT_NOT_SERIALIZED(s);
 111
 112     logslz(enter_beg, s);
 113     atomic_intr_cond_enter(&s->interlock, lwkt_serialize_sleep, s);
 114     logslz(enter_end, s);
 115 #ifdef INVARIANTS
 116     s->last_td = curthread;
 117 #endif
 118 }
 119
 120 /*
 121  * Returns non-zero on success
 122  */
 123 int
 124 lwkt_serialize_try(lwkt_serialize_t s)
 125 {
 126     int error;
 127
 128     ASSERT_NOT_SERIALIZED(s);
 129
 130     logslz(try, s);
 131     if ((error = atomic_intr_cond_try(&s->interlock)) == 0) {
 132 #ifdef INVARIANTS
 133         s->last_td = curthread;
 134 #endif
 135         logslz(tryok, s);
 136         return(1);
 137     }
 138     logslz(tryfail, s);
 139     return (0);
 140 }
 141
 142 void
 143 lwkt_serialize_exit(lwkt_serialize_t s)
 144 {
 145     ASSERT_SERIALIZED(s);
 146 #ifdef INVARIANTS
 147     s->last_td = (void *)-2;
 148 #endif
 149     logslz(exit_beg, s);
 150     atomic_intr_cond_exit(&s->interlock, lwkt_serialize_wakeup, s);
 151     logslz(exit_end, s);
 152 }
 153
 154 /*
 155  * Interrupt handler disablement support, used by drivers.  Non-stackable
 156  * (uses bit 30).
 157  */
 158 void
 159 lwkt_serialize_handler_disable(lwkt_serialize_t s)
 160 {
 161     atomic_intr_handler_disable(&s->interlock);
 162 }
 163
 164 void
 165 lwkt_serialize_handler_enable(lwkt_serialize_t s)
 166 {
 167     atomic_intr_handler_enable(&s->interlock);
 168 }
 169
 170 void
 171 lwkt_serialize_handler_call(lwkt_serialize_t s, void (*func)(void *, void *),
 172                             void *arg, void *frame)
 173 {
 174     /*
 175      * note: a return value of 0 indicates that the interrupt handler is
 176      * enabled.
 177      */
 178     if (atomic_intr_handler_is_enabled(&s->interlock) == 0) {
 179         logslz(enter_beg, s);
 180         atomic_intr_cond_enter(&s->interlock, lwkt_serialize_sleep, s);
 181         logslz(enter_end, s);
 182 #ifdef INVARIANTS
 183         s->last_td = curthread;
 184 #endif
 185         if (atomic_intr_handler_is_enabled(&s->interlock) == 0)
 186             func(arg, frame);
 187
 188         ASSERT_SERIALIZED(s);
 189 #ifdef INVARIANTS
 190         s->last_td = (void *)-2;
 191 #endif
 192         logslz(exit_beg, s);
 193         atomic_intr_cond_exit(&s->interlock, lwkt_serialize_wakeup, s);
 194         logslz(exit_end, s);
 195     }
 196 }
 197
 198 /*
 199  * Similar to handler_call but does not block.  Returns 0 on success,
 200  * and 1 on failure.
 201  */
 202 int
 203 lwkt_serialize_handler_try(lwkt_serialize_t s, void (*func)(void *, void *),
 204                            void *arg, void *frame)
 205 {
 206     /*
 207      * note: a return value of 0 indicates that the interrupt handler is
 208      * enabled.
 209      */
 210     if (atomic_intr_handler_is_enabled(&s->interlock) == 0) {
 211         logslz(try, s);
 212         if (atomic_intr_cond_try(&s->interlock) == 0) {
 213 #ifdef INVARIANTS
 214             s->last_td = curthread;
 215 #endif
 216             logslz(tryok, s);
 217
 218             func(arg, frame);
 219
 220             ASSERT_SERIALIZED(s);
 221 #ifdef INVARIANTS
 222             s->last_td = (void *)-2;
 223 #endif
 224             logslz(exit_beg, s);
 225             atomic_intr_cond_exit(&s->interlock, lwkt_serialize_wakeup, s);
 226             logslz(exit_end, s);
 227             return(0);
 228         }
 229     }
 230     logslz(tryfail, s);
 231     return(1);
 232 }
 233
 234
 235 /*
 236  * Helper functions
 237  *
 238  * It is possible to race an interrupt which acquires and releases the
 239  * bit, then calls wakeup before we actually go to sleep, so we
 240  * need to check that the interlock is still acquired from within
 241  * a critical section prior to sleeping.
 242  */
 243 static void
 244 lwkt_serialize_sleep(void *info)
 245 {
 246     lwkt_serialize_t s = info;
 247
 248     tsleep_interlock(s, 0);
 249     if (atomic_intr_cond_test(&s->interlock) != 0) {
 250         logslz(sleep_beg, s);
 251         tsleep(s, PINTERLOCKED, "slize", 0);
 252         logslz(sleep_end, s);
 253     }
 254 }
 255
 256 void
 257 lwkt_serialize_adaptive_enter(lwkt_serialize_t s)
 258 {
 259     int try;
 260
 261     ASSERT_NOT_SERIALIZED(s);
 262     logslz(adapt_beg, s);
 263
 264     if (atomic_intr_cond_try(&s->interlock) == 0) {
 265 #ifdef INVARIANTS
 266         s->last_td = curthread;
 267 #endif
 268         logslz(adapt_end, s);
 269         return;
 270     }
 271
 272 restart:
 273     /*
 274      * Spinning a little bit, before going to sleep
 275      *
 276      * See the comment before kern/kern_spinlock.c
 277      * _spin_lock_contested() about why atomic_intr_cond_test()
 278      * is called first.  atomic_intr_cond_test() contains
 279      * _no_ MPLOCKED intruction.
 280      */
 281     for (try = SLZ_ADAPTIVE_SPINMAX; try; --try) {
 282         if (atomic_intr_cond_test(&s->interlock) == 0 &&
 283             atomic_intr_cond_try(&s->interlock) == 0) {
 284 #ifdef INVARIANTS
 285             s->last_td = curthread;
 286 #endif
 287             logslz_spinend(s, try);
 288             return;
 289         }
 290     }
 291
 292     atomic_intr_cond_inc(&s->interlock);
 293
 294     tsleep_interlock(s, 0);
 295     if (atomic_intr_cond_try(&s->interlock) == 0) {
 296         atomic_intr_cond_dec(&s->interlock);
 297 #ifdef INVARIANTS
 298         s->last_td = curthread;
 299 #endif
 300         logslz_spinend(s, 0);
 301         return;
 302     } else {
 303         logslz(adapt_sleepb, s);
 304         tsleep(s, PINTERLOCKED, "aslize", 0);
 305         logslz(adapt_sleepe, s);
 306
 307         atomic_intr_cond_dec(&s->interlock);
 308         goto restart;
 309     }
 310 }
 311
 312 static void
 313 lwkt_serialize_wakeup(void *info)
 314 {
 315     logslz(wakeup_beg, info);
 316     wakeup(info);
 317     logslz(wakeup_end, info);
 318 }