bertos/kern/signal.c

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2004, 2008 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 1999, 2000, 2001 Bernie Innocenti <bernie@codewiz.org>
  31  * -->
  32  *
  33  * \brief IPC signals implementation.
  34  *
  35  * Signals are a low-level IPC primitive.  A process receives a signal
  36  * when some external event has happened.  Like interrupt requests,
  37  * signals do not carry any additional information.  If processing a
  38  * specific event requires additional data, the process must obtain it
  39  * through some other mechanism.
  40  *
  41  * Despite the name, one shouldn't confuse these signals with POSIX
  42  * signals.  POSIX signals are usually executed synchronously, like
  43  * software interrupts.
  44  *
  45  * Signals are very low overhead.  Using them exclusively to wait
  46  * for multiple asynchronous events results in very simple dispatch
  47  * logic with low processor and resource usage.
  48  *
  49  * The "event" module is a higher-level interface that can optionally
  50  * deliver signals to processes.  Messages provide even higher-level
  51  * IPC services built on signals.  Semaphore arbitration is also
  52  * implemented using signals.
  53  *
  54  * In this implementation, each process has a limited set of signal
  55  * bits (usually 32) and can wait for multiple signals at the same
  56  * time using sig_wait().  Signals can also be polled using sig_check(),
  57  * but a process spinning on its signals usually defeats their purpose
  58  * of providing a multitasking-friendly infrastructure for event-driven
  59  * applications.
  60  *
  61  * Signals are like flags: they are either active or inactive.  After an
  62  * external event has delivered a particular signal, it remains raised until
  63  * the process acknowledges it using either sig_wait() or sig_check().
  64  * Counting signals is not a reliable way to count how many times a
  65  * particular event has occurred, because the same signal may be
  66  * delivered twice before the process can notice.
  67  *
  68  * Signals can be delivered synchronously via sig_send() or asynchronously via
  69  * sig_post().
  70  *
  71  * In the synchronous case the process is awakened if it was waiting for any
  72  * signal and immediately dispatched for execution via a direct context switch,
  73  * if its priority is greater than the running process.
  74  *
  75  * <pre>
  76  * - Synchronous-signal delivery:
  77  *
  78  *     [P1]____sig_send()____proc_wakeup()____[P2]
  79  * </pre>
  80  *
  81  * In the asynchronous case, the process is scheduled for execution as a
  82  * consequence of the delivery, but it will be dispatched by the scheduler as
  83  * usual, according to the scheduling policy.
  84  *
  85  * <pre>
  86  * - Asynchronous-signal delivery:
  87  *
  88  *     [P1]____sig_post()____[P1]____proc_schedule()____[P2]
  89  * </pre>
  90  *
  91  * In this way, any execution context, including an interrupt handler, can
  92  * deliver a signal to a process. However, synchronous signal delivery from a
  93  * non-sleepable context (like an interrupt handler) is forbidden in order to
  94  * avoid potential deadlock conditions. Instead, sig_post() can be used from
  95  * any context, expecially from interrupt context or when the preemption is
  96  * disabled.
  97  *
  98  * Multiple independent signals may be delivered at once with a single
  99  * invocation of sig_send() or sig_post(), although this is rarely useful.
 100  *
 101  * \section signal_allocation Signal Allocation
 102  *
 103  * There's no hardcoded mapping of specific events to signal bits.
 104  * The meaning of a particular signal bit is defined by an agreement
 105  * between the delivering entity and the receiving process.
 106  * For instance, a terminal driver may be designed to deliver
 107  * a signal bit called SIG_INT when it reads the CTRL-C sequence
 108  * from the keyboard, and a process may react to it by quitting.
 109  *
 110  * \section sig_single SIG_SINGLE
 111  *
 112  * The SIG_SINGLE bit is reserved as a convenient shortcut in those
 113  * simple scenarios where a process needs to wait on just one event
 114  * synchronously.  By using SIG_SINGLE, there's no need to allocate
 115  * a specific signal from the free pool.  The constraints for safely
 116  * accessing SIG_SINGLE are:
 117  *  - The process MUST sig_wait() exclusively on SIG_SINGLE
 118  *  - SIG_SIGNAL MUST NOT be left pending after use (sig_wait() will reset
 119  *        it automatically)
 120  *  - Do not sleep between starting the asynchronous task that will fire
 121  *    SIG_SINGLE, and the call to  sig_wait().
 122  *  - Do not call system functions that may implicitly sleep, such as
 123  *    timer_delayTicks().
 124  *
 125  * \version $Id$
 126  * \author Bernie Innocenti <bernie@codewiz.org>
 127  */
 128
 129 #include "signal.h"
 130
 131 #include "cfg/cfg_timer.h"
 132 #include <cfg/debug.h>
 133 #include <cfg/depend.h>
 134
 135 #include <cpu/irq.h>
 136 #include <kern/proc.h>
 137 #include <kern/proc_p.h>
 138
 139
 140 #if CONFIG_KERN_SIGNALS
 141
 142 // Check config dependencies
 143 CONFIG_DEPEND(CONFIG_KERN_SIGNALS, CONFIG_KERN);
 144
 145 /**
 146  * Check if any of the signals in \a sigs has occurred and clear them.
 147  *
 148  * \return the signals that have occurred.
 149  */
 150 sigmask_t sig_check(sigmask_t sigs)
 151 {
 152         sigmask_t result;
 153         cpu_flags_t flags;
 154
 155         IRQ_SAVE_DISABLE(flags);
 156         result = current_process->sig_recv & sigs;
 157         current_process->sig_recv &= ~sigs;
 158         IRQ_RESTORE(flags);
 159
 160         return result;
 161 }
 162
 163
 164 /**
 165  * Sleep until any of the signals in \a sigs occurs.
 166  * \return the signal(s) that have awoken the process.
 167  */
 168 sigmask_t sig_wait(sigmask_t sigs)
 169 {
 170         sigmask_t result;
 171
 172         /* Sleeping with IRQs disabled or preemption forbidden is illegal */
 173         IRQ_ASSERT_ENABLED();
 174         ASSERT(proc_preemptAllowed());
 175
 176         /*
 177          * This is subtle: there's a race condition where a concurrent process
 178          * or an interrupt may call sig_send()/sig_post() to set a bit in
 179          * Process.sig_recv just after we have checked for it, but before we've
 180          * set Process.sig_wait to let them know we want to be awaken.
 181          *
 182          * In this case, we'd deadlock with the signal bit already set and the
 183          * process never being reinserted into the ready list.
 184          */
 185         IRQ_DISABLE;
 186
 187         /* Loop until we get at least one of the signals */
 188         while (!(result = current_process->sig_recv & sigs))
 189         {
 190                 /*
 191                  * Tell "them" that we want to be awaken when any of these
 192                  * signals arrives.
 193                  */
 194                 current_process->sig_wait = sigs;
 195
 196                 /* Go to sleep and proc_switch() to another process. */
 197                 proc_switch();
 198                 /*
 199                  * When we come back here, the wait mask must have been
 200                  * cleared by someone through sig_send()/sig_post(), and at
 201                  * least one of the signals we were expecting must have been
 202                  * delivered to us.
 203                  */
 204                 ASSERT(!current_process->sig_wait);
 205                 ASSERT(current_process->sig_recv & sigs);
 206         }
 207
 208         /* Signals found: clear them and return */
 209         current_process->sig_recv &= ~sigs;
 210
 211         IRQ_ENABLE;
 212         return result;
 213 }
 214
 215 #if CONFIG_TIMER_EVENTS
 216
 217 #include <drv/timer.h>
 218 /**
 219  * Sleep until any of the signals in \a sigs or \a timeout ticks elapse.
 220  * If the timeout elapse a SIG_TIMEOUT is added to the received signal(s).
 221  * \return the signal(s) that have awoken the process.
 222  * \note Caller must check return value to check which signal awoke the process.
 223  */
 224 sigmask_t sig_waitTimeout(sigmask_t sigs, ticks_t timeout)
 225 {
 226         Timer t;
 227         sigmask_t res;
 228         cpu_flags_t flags;
 229
 230         ASSERT(!sig_check(SIG_TIMEOUT));
 231         ASSERT(!(sigs & SIG_TIMEOUT));
 232         /* IRQ are needed to run timer */
 233         ASSERT(IRQ_ENABLED());
 234
 235         timer_set_event_signal(&t, proc_current(), SIG_TIMEOUT);
 236         timer_setDelay(&t, timeout);
 237         timer_add(&t);
 238         res = sig_wait(SIG_TIMEOUT | sigs);
 239
 240         IRQ_SAVE_DISABLE(flags);
 241         /* Remove timer if sigs occur before timer signal */
 242         if (!(res & SIG_TIMEOUT) && !sig_check(SIG_TIMEOUT))
 243                 timer_abort(&t);
 244         IRQ_RESTORE(flags);
 245         return res;
 246 }
 247
 248 #endif // CONFIG_TIMER_EVENTS
 249
 250 INLINE void __sig_signal(Process *proc, sigmask_t sigs, bool wakeup)
 251 {
 252         cpu_flags_t flags;
 253
 254         if (UNLIKELY(proc == current_process))
 255                 return;
 256
 257         IRQ_SAVE_DISABLE(flags);
 258
 259         /* Set the signals */
 260         proc->sig_recv |= sigs;
 261
 262         /* Check if process needs to be awoken */
 263         if (proc->sig_recv & proc->sig_wait)
 264         {
 265                 proc->sig_wait = 0;
 266                 if (wakeup)
 267                         proc_wakeup(proc);
 268                 else
 269                         SCHED_ENQUEUE_HEAD(proc);
 270         }
 271         IRQ_RESTORE(flags);
 272 }
 273
 274 /**
 275  * Send the signals \a sigs to the process \a proc and immeditaly dispatch it
 276  * for execution.
 277  *
 278  * The process will be awoken if it was waiting for any of them and immediately
 279  * dispatched for execution.
 280  *
 281  * \note This function can't be called from IRQ context, use sig_post()
 282  * instead.
 283  */
 284 void sig_send(Process *proc, sigmask_t sigs)
 285 {
 286         ASSERT_USER_CONTEXT();
 287         IRQ_ASSERT_ENABLED();
 288         ASSERT(proc_preemptAllowed());
 289
 290         __sig_signal(proc, sigs, true);
 291 }
 292
 293 /**
 294  * Send the signals \a sigs to the process \a proc.
 295  * The process will be awoken if it was waiting for any of them.
 296  *
 297  * \note This call is interrupt safe.
 298  */
 299 void sig_post(Process *proc, sigmask_t sigs)
 300 {
 301         __sig_signal(proc, sigs, false);
 302 }
 303
 304 #endif /* CONFIG_KERN_SIGNALS */