Subversion Repositories HelenOS

Rev

Rev 1580 | Rev 1681 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (C) 2001-2004 Jakub Jermar
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  *
  9.  * - Redistributions of source code must retain the above copyright
  10.  *   notice, this list of conditions and the following disclaimer.
  11.  * - Redistributions in binary form must reproduce the above copyright
  12.  *   notice, this list of conditions and the following disclaimer in the
  13.  *   documentation and/or other materials provided with the distribution.
  14.  * - The name of the author may not be used to endorse or promote products
  15.  *   derived from this software without specific prior written permission.
  16.  *
  17.  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18.  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20.  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21.  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26.  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27.  */
  28.  
  29. /**
  30.  * @file    waitq.c
  31.  * @brief   Wait queue.
  32.  *
  33.  * Wait queue is the basic synchronization primitive upon which all
  34.  * other synchronization primitives build.
  35.  *
  36.  * It allows threads to wait for an event in first-come, first-served
  37.  * fashion. Conditional operation as well as timeouts and interruptions
  38.  * are supported.
  39.  */
  40.  
  41. #include <synch/waitq.h>
  42. #include <synch/synch.h>
  43. #include <synch/spinlock.h>
  44. #include <proc/thread.h>
  45. #include <proc/scheduler.h>
  46. #include <arch/asm.h>
  47. #include <arch/types.h>
  48. #include <typedefs.h>
  49. #include <time/timeout.h>
  50. #include <arch.h>
  51. #include <context.h>
  52. #include <adt/list.h>
  53.  
  54. static void waitq_timeouted_sleep(void *data);
  55.  
  56. /** Initialize wait queue
  57.  *
  58.  * Initialize wait queue.
  59.  *
  60.  * @param wq Pointer to wait queue to be initialized.
  61.  */
  62. void waitq_initialize(waitq_t *wq)
  63. {
  64.     spinlock_initialize(&wq->lock, "waitq_lock");
  65.     list_initialize(&wq->head);
  66.     wq->missed_wakeups = 0;
  67. }
  68.  
  69. /** Handle timeout during waitq_sleep_timeout() call
  70.  *
  71.  * This routine is called when waitq_sleep_timeout() timeouts.
  72.  * Interrupts are disabled.
  73.  *
  74.  * It is supposed to try to remove 'its' thread from the wait queue;
  75.  * it can eventually fail to achieve this goal when these two events
  76.  * overlap. In that case it behaves just as though there was no
  77.  * timeout at all.
  78.  *
  79.  * @param data Pointer to the thread that called waitq_sleep_timeout().
  80.  */
  81. void waitq_timeouted_sleep(void *data)
  82. {
  83.     thread_t *t = (thread_t *) data;
  84.     waitq_t *wq;
  85.     bool do_wakeup = false;
  86.  
  87.     spinlock_lock(&threads_lock);
  88.     if (!thread_exists(t))
  89.         goto out;
  90.  
  91. grab_locks:
  92.     spinlock_lock(&t->lock);
  93.     if ((wq = t->sleep_queue)) {        /* assignment */
  94.         if (!spinlock_trylock(&wq->lock)) {
  95.             spinlock_unlock(&t->lock);
  96.             goto grab_locks;    /* avoid deadlock */
  97.         }
  98.  
  99.         list_remove(&t->wq_link);
  100.         t->saved_context = t->sleep_timeout_context;
  101.         do_wakeup = true;
  102.        
  103.         spinlock_unlock(&wq->lock);
  104.         t->sleep_queue = NULL;
  105.     }
  106.    
  107.     t->timeout_pending = false;
  108.     spinlock_unlock(&t->lock);
  109.    
  110.     if (do_wakeup)
  111.         thread_ready(t);
  112.  
  113. out:
  114.     spinlock_unlock(&threads_lock);
  115. }
  116.  
  117. /** Interrupt sleeping thread.
  118.  *
  119.  * This routine attempts to interrupt a thread from its sleep in a waitqueue.
  120.  * If the thread is not found sleeping, no action is taken.
  121.  *
  122.  * @param t Thread to be interrupted.
  123.  */
  124. void waitq_interrupt_sleep(thread_t *t)
  125. {
  126.     waitq_t *wq;
  127.     bool do_wakeup = false;
  128.     ipl_t ipl;
  129.  
  130.     ipl = interrupts_disable();
  131.     spinlock_lock(&threads_lock);
  132.     if (!thread_exists(t))
  133.         goto out;
  134.  
  135. grab_locks:
  136.     spinlock_lock(&t->lock);
  137.     if ((wq = t->sleep_queue)) {        /* assignment */
  138.         if (!(t->sleep_interruptible)) {
  139.             /*
  140.              * The sleep cannot be interrupted.
  141.              */
  142.             spinlock_unlock(&t->lock);
  143.             goto out;
  144.         }
  145.            
  146.         if (!spinlock_trylock(&wq->lock)) {
  147.             spinlock_unlock(&t->lock);
  148.             goto grab_locks;    /* avoid deadlock */
  149.         }
  150.  
  151.         if (t->timeout_pending && timeout_unregister(&t->sleep_timeout))
  152.             t->timeout_pending = false;
  153.  
  154.         list_remove(&t->wq_link);
  155.         t->saved_context = t->sleep_interruption_context;
  156.         do_wakeup = true;
  157.        
  158.         spinlock_unlock(&wq->lock);
  159.         t->sleep_queue = NULL;
  160.     }
  161.     spinlock_unlock(&t->lock);
  162.  
  163.     if (do_wakeup)
  164.         thread_ready(t);
  165.  
  166. out:
  167.     spinlock_unlock(&threads_lock);
  168.     interrupts_restore(ipl);
  169. }
  170.  
  171. /** Sleep until either wakeup, timeout or interruption occurs
  172.  *
  173.  * This is a sleep implementation which allows itself to time out or to be
  174.  * interrupted from the sleep, restoring a failover context.
  175.  *
  176.  * Sleepers are organised in a FIFO fashion in a structure called wait queue.
  177.  *
  178.  * This function is really basic in that other functions as waitq_sleep()
  179.  * and all the *_timeout() functions use it.
  180.  *
  181.  * @param wq Pointer to wait queue.
  182.  * @param usec Timeout in microseconds.
  183.  * @param flags Specify mode of the sleep.
  184.  *
  185.  * The sleep can be interrupted only if the
  186.  * SYNCH_FLAGS_INTERRUPTIBLE bit is specified in flags.
  187.  
  188.  * If usec is greater than zero, regardless of the value of the
  189.  * SYNCH_FLAGS_NON_BLOCKING bit in flags, the call will not return until either timeout,
  190.  * interruption or wakeup comes.
  191.  *
  192.  * If usec is zero and the SYNCH_FLAGS_NON_BLOCKING bit is not set in flags, the call
  193.  * will not return until wakeup or interruption comes.
  194.  *
  195.  * If usec is zero and the SYNCH_FLAGS_NON_BLOCKING bit is set in flags, the call will
  196.  * immediately return, reporting either success or failure.
  197.  *
  198.  * @return  Returns one of: ESYNCH_WOULD_BLOCK, ESYNCH_TIMEOUT, ESYNCH_INTERRUPTED,
  199.  *          ESYNCH_OK_ATOMIC, ESYNCH_OK_BLOCKED.
  200.  *
  201.  * @li ESYNCH_WOULD_BLOCK means that the sleep failed because at the time
  202.  * of the call there was no pending wakeup.
  203.  *
  204.  * @li ESYNCH_TIMEOUT means that the sleep timed out.
  205.  *
  206.  * @li ESYNCH_INTERRUPTED means that somebody interrupted the sleeping thread.
  207.  *
  208.  * @li ESYNCH_OK_ATOMIC means that the sleep succeeded and that there was
  209.  * a pending wakeup at the time of the call. The caller was not put
  210.  * asleep at all.
  211.  *
  212.  * @li ESYNCH_OK_BLOCKED means that the sleep succeeded; the full sleep was
  213.  * attempted.
  214.  */
  215. int waitq_sleep_timeout(waitq_t *wq, __u32 usec, int flags)
  216. {
  217.     ipl_t ipl;
  218.     int rc;
  219.    
  220.     ipl = waitq_sleep_prepare(wq);
  221.     rc = waitq_sleep_timeout_unsafe(wq, usec, flags);
  222.     waitq_sleep_finish(wq, rc, ipl);
  223.     return rc;
  224. }
  225.  
  226. /** Prepare to sleep in a waitq.
  227.  *
  228.  * This function will return holding the lock of the wait queue
  229.  * and interrupts disabled.
  230.  *
  231.  * @param wq Wait queue.
  232.  *
  233.  * @return Interrupt level as it existed on entry to this function.
  234.  */
  235. ipl_t waitq_sleep_prepare(waitq_t *wq)
  236. {
  237.     ipl_t ipl;
  238.    
  239. restart:
  240.     ipl = interrupts_disable();
  241.  
  242.     if (THREAD) {   /* needed during system initiailzation */
  243.         /*
  244.          * Busy waiting for a delayed timeout.
  245.          * This is an important fix for the race condition between
  246.          * a delayed timeout and a next call to waitq_sleep_timeout().
  247.          * Simply, the thread is not allowed to go to sleep if
  248.          * there are timeouts in progress.
  249.          */
  250.         spinlock_lock(&THREAD->lock);
  251.         if (THREAD->timeout_pending) {
  252.             spinlock_unlock(&THREAD->lock);
  253.             interrupts_restore(ipl);
  254.             goto restart;
  255.         }
  256.         spinlock_unlock(&THREAD->lock);
  257.     }
  258.                                                    
  259.     spinlock_lock(&wq->lock);
  260.     return ipl;
  261. }
  262.  
  263. /** Finish waiting in a wait queue.
  264.  *
  265.  * This function restores interrupts to the state that existed prior
  266.  * to the call to waitq_sleep_prepare(). If necessary, the wait queue
  267.  * lock is released.
  268.  *
  269.  * @param wq Wait queue.
  270.  * @param rc Return code of waitq_sleep_timeout_unsafe().
  271.  * @param ipl Interrupt level returned by waitq_sleep_prepare().
  272.  */
  273. void waitq_sleep_finish(waitq_t *wq, int rc, ipl_t ipl)
  274. {
  275.     switch (rc) {
  276.     case ESYNCH_WOULD_BLOCK:
  277.     case ESYNCH_OK_ATOMIC:
  278.         spinlock_unlock(&wq->lock);
  279.         break;
  280.     default:
  281.         break;
  282.     }
  283.     interrupts_restore(ipl);
  284. }
  285.  
  286. /** Internal implementation of waitq_sleep_timeout().
  287.  *
  288.  * This function implements logic of sleeping in a wait queue.
  289.  * This call must be preceeded by a call to waitq_sleep_prepare()
  290.  * and followed by a call to waitq_slee_finish().
  291.  *
  292.  * @param wq See waitq_sleep_timeout().
  293.  * @param usec See waitq_sleep_timeout().
  294.  * @param flags See waitq_sleep_timeout().
  295.  *
  296.  * @return See waitq_sleep_timeout().
  297.  */
  298. int waitq_sleep_timeout_unsafe(waitq_t *wq, __u32 usec, int flags)
  299. {
  300.     /* checks whether to go to sleep at all */
  301.     if (wq->missed_wakeups) {
  302.         wq->missed_wakeups--;
  303.         return ESYNCH_OK_ATOMIC;
  304.     }
  305.     else {
  306.         if ((flags & SYNCH_FLAGS_NON_BLOCKING) && (usec == 0)) {
  307.             /* return immediatelly instead of going to sleep */
  308.             return ESYNCH_WOULD_BLOCK;
  309.         }
  310.     }
  311.    
  312.     /*
  313.      * Now we are firmly decided to go to sleep.
  314.      */
  315.     spinlock_lock(&THREAD->lock);
  316.  
  317.     if (flags & SYNCH_FLAGS_INTERRUPTIBLE) {
  318.  
  319.         /*
  320.          * If the thread was already interrupted,
  321.          * don't go to sleep at all.
  322.          */
  323.         if (THREAD->interrupted) {
  324.             spinlock_unlock(&THREAD->lock);
  325.             spinlock_unlock(&wq->lock);
  326.             return ESYNCH_INTERRUPTED;
  327.         }
  328.  
  329.         /*
  330.          * Set context that will be restored if the sleep
  331.          * of this thread is ever interrupted.
  332.          */
  333.         THREAD->sleep_interruptible = true;
  334.         if (!context_save(&THREAD->sleep_interruption_context)) {
  335.             /* Short emulation of scheduler() return code. */
  336.             spinlock_unlock(&THREAD->lock);
  337.             return ESYNCH_INTERRUPTED;
  338.         }
  339.  
  340.     } else {
  341.         THREAD->sleep_interruptible = false;
  342.     }
  343.  
  344.     if (usec) {
  345.         /* We use the timeout variant. */
  346.         if (!context_save(&THREAD->sleep_timeout_context)) {
  347.             /* Short emulation of scheduler() return code. */
  348.             spinlock_unlock(&THREAD->lock);
  349.             return ESYNCH_TIMEOUT;
  350.         }
  351.         THREAD->timeout_pending = true;
  352.         timeout_register(&THREAD->sleep_timeout, (__u64) usec, waitq_timeouted_sleep, THREAD);
  353.     }
  354.  
  355.     list_append(&THREAD->wq_link, &wq->head);
  356.  
  357.     /*
  358.      * Suspend execution.
  359.      */
  360.     THREAD->state = Sleeping;
  361.     THREAD->sleep_queue = wq;
  362.  
  363.     spinlock_unlock(&THREAD->lock);
  364.  
  365.     scheduler();    /* wq->lock is released in scheduler_separated_stack() */
  366.    
  367.     return ESYNCH_OK_BLOCKED;
  368. }
  369.  
  370.  
  371. /** Wake up first thread sleeping in a wait queue
  372.  *
  373.  * Wake up first thread sleeping in a wait queue.
  374.  * This is the SMP- and IRQ-safe wrapper meant for
  375.  * general use.
  376.  *
  377.  * Besides its 'normal' wakeup operation, it attempts
  378.  * to unregister possible timeout.
  379.  *
  380.  * @param wq Pointer to wait queue.
  381.  * @param all If this is non-zero, all sleeping threads
  382.  *        will be woken up and missed count will be zeroed.
  383.  */
  384. void waitq_wakeup(waitq_t *wq, bool all)
  385. {
  386.     ipl_t ipl;
  387.  
  388.     ipl = interrupts_disable();
  389.     spinlock_lock(&wq->lock);
  390.  
  391.     _waitq_wakeup_unsafe(wq, all);
  392.  
  393.     spinlock_unlock(&wq->lock);
  394.     interrupts_restore(ipl);   
  395. }
  396.  
  397. /** Internal SMP- and IRQ-unsafe version of waitq_wakeup()
  398.  *
  399.  * This is the internal SMP- and IRQ-unsafe version
  400.  * of waitq_wakeup(). It assumes wq->lock is already
  401.  * locked and interrupts are already disabled.
  402.  *
  403.  * @param wq Pointer to wait queue.
  404.  * @param all If this is non-zero, all sleeping threads
  405.  *        will be woken up and missed count will be zeroed.
  406.  */
  407. void _waitq_wakeup_unsafe(waitq_t *wq, bool all)
  408. {
  409.     thread_t *t;
  410.  
  411. loop:  
  412.     if (list_empty(&wq->head)) {
  413.         wq->missed_wakeups++;
  414.         if (all)
  415.             wq->missed_wakeups = 0;
  416.         return;
  417.     }
  418.  
  419.     t = list_get_instance(wq->head.next, thread_t, wq_link);
  420.    
  421.     list_remove(&t->wq_link);
  422.     spinlock_lock(&t->lock);
  423.     if (t->timeout_pending && timeout_unregister(&t->sleep_timeout))
  424.         t->timeout_pending = false;
  425.     t->sleep_queue = NULL;
  426.     spinlock_unlock(&t->lock);
  427.  
  428.     thread_ready(t);
  429.  
  430.     if (all)
  431.         goto loop;
  432. }
  433.