usr/src/man/man9f/timeout.9f

   1 '\" te
   2 .\" Copyright (c) 2006 Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" Copyright 1989 AT&T
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH TIMEOUT 9F "Jan 16, 2006"
   8 .SH NAME
   9 timeout \- execute a function after a specified length of time
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/types.h>
  14 #include <sys/conf.h>
  15
  16
  17
  18 \fBtimeout_id_t\fR \fBtimeout\fR(\fBvoid (\fR\fI* func\fR)(void \fI*\fR), \fBvoid\fR \fI*arg\fR,
  19      \fBclock_t\fR  \fIticks\fR);
  20 .fi
  21
  22 .SH INTERFACE LEVEL
  23 .sp
  24 .LP
  25 Architecture independent level 1 (DDI/DKI).
  26 .SH PARAMETERS
  27 .sp
  28 .ne 2
  29 .na
  30 \fB\fIfunc\fR\fR
  31 .ad
  32 .RS 9n
  33 Kernel function to invoke when the time increment expires.
  34 .RE
  35
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fIarg\fR\fR
  40 .ad
  41 .RS 9n
  42 Argument to the function.
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fIticks\fR\fR
  49 .ad
  50 .RS 9n
  51 Number of clock ticks to wait before the function is called. Use
  52 \fBdrv_usectohz\fR(9F) to convert microseconds to clock ticks.
  53 .RE
  54
  55 .SH DESCRIPTION
  56 .sp
  57 .LP
  58 The \fBtimeout()\fR function schedules the specified function to be called
  59 after a specified time interval. The exact time interval over which the timeout
  60 takes effect cannot be guaranteed, but the value given is a close
  61 approximation.
  62 .sp
  63 .LP
  64 The function called by \fBtimeout()\fR must adhere to the same restrictions as
  65 a driver soft interrupt handler.
  66 .sp
  67 .LP
  68 The \fBdelay\fR(9F) function calls \fBtimeout()\fR. Because \fBtimeout()\fR is
  69 subject to priority inversion, drivers waiting on behalf of processes with
  70 real-time constraints should use \fBcv_timedwait\fR(9F) rather than
  71 \fBdelay()\fR.
  72 .SH RETURN VALUES
  73 .sp
  74 .LP
  75 The \fBtimeout()\fR function returns an opaque non-zero \fBtimeout\fR
  76 identifier that can be passed to \fBuntimeout\fR(9F) to cancel the request.
  77 .SH CONTEXT
  78 .sp
  79 .LP
  80 The \fBtimeout()\fR function can be called from user, interrupt, or kernel
  81 context.
  82 .SH EXAMPLES
  83 .LP
  84 \fBExample 1 \fRUsing \fBtimeout()\fR
  85 .sp
  86 .LP
  87 In the following example, the device driver has issued an IO request and is
  88 waiting for the device to respond. If the device does not respond within 5
  89 seconds, the device driver will print out an error message to the console.
  90
  91 .sp
  92 .in +2
  93 .nf
  94 static void
  95 xxtimeout_handler(void *arg)
  96 {
  97         struct xxstate *xsp = (struct xxstate *)arg;
  98         mutex_enter(&xsp->lock);
  99         cv_signal(&xsp->cv);
 100         xsp->flags |= TIMED_OUT;
 101         mutex_exit(&xsp->lock);
 102         xsp->timeout_id = 0;
 103 }
 104 static uint_t
 105 xxintr(caddr_t arg)
 106 {
 107         struct xxstate *xsp = (struct xxstate *)arg;
 108          .
 109          .
 110          .
 111         mutex_enter(&xsp->lock);
 112         /* Service interrupt */
 113         cv_signal(&xsp->cv);
 114         mutex_exit(&xsp->lock);
 115         if (xsp->timeout_id != 0) {
 116                 (void) untimeout(xsp->timeout_id);
 117                 xsp->timeout_id = 0;
 118         }
 119         return(DDI_INTR_CLAIMED);
 120 }
 121 static void
 122 xxcheckcond(struct xxstate *xsp)
 123 {
 124          .
 125          .
 126          .
 127         xsp->timeout_id = timeout(xxtimeout_handler,
 128             xsp, (5 * drv_usectohz(1000000)));
 129         mutex_enter(&xsp->lock);
 130         while (/* Waiting for interrupt  or timeout*/)
 131                 cv_wait(&xsp->cv, &xsp->lock);
 132         if (xsp->flags & TIMED_OUT)
 133                 cmn_err(CE_WARN, "Device not responding");
 134          .
 135          .
 136          .
 137         mutex_exit(&xsp->lock);
 138          .
 139          .
 140          .
 141 }
 142 .fi
 143 .in -2
 144
 145 .SH SEE ALSO
 146 .sp
 147 .LP
 148 \fBbufcall\fR(9F), \fBcv_timedwait\fR(9F), \fBddi_in_panic\fR(9F),
 149 \fBdelay\fR(9F), \fBdrv_usectohz\fR(9F), \fBuntimeout\fR(9F)
 150 .sp
 151 .LP
 152 \fIWriting Device Drivers\fR