svn commit: r247007 - projects/calloutng/share/man/man9
Alexander Motin
mav at FreeBSD.org
Tue Feb 19 19:14:24 UTC 2013
Author: mav
Date: Tue Feb 19 19:14:22 2013
New Revision: 247007
URL: http://svnweb.freebsd.org/changeset/base/247007
Log:
Update man pages to reflect switch from struct bintime to sbintime_t.
Modified:
projects/calloutng/share/man/man9/Makefile
projects/calloutng/share/man/man9/condvar.9
projects/calloutng/share/man/man9/sleep.9
projects/calloutng/share/man/man9/sleepqueue.9
projects/calloutng/share/man/man9/timeout.9
Modified: projects/calloutng/share/man/man9/Makefile
==============================================================================
--- projects/calloutng/share/man/man9/Makefile Tue Feb 19 18:28:25 2013 (r247006)
+++ projects/calloutng/share/man/man9/Makefile Tue Feb 19 19:14:22 2013 (r247007)
@@ -1196,13 +1196,13 @@ MLINKS+=signal.9 cursig.9 \
signal.9 SIG_STOPSIGMASK.9 \
signal.9 trapsignal.9
MLINKS+=sleep.9 msleep.9 \
- sleep.9 msleep_bt.9 \
+ sleep.9 msleep_sbt.9 \
sleep.9 msleep_spin.9 \
- sleep.9 msleep_spin_bt.9 \
+ sleep.9 msleep_spin_sbt.9 \
sleep.9 pause.9 \
- sleep.9 pause_bt.9 \
+ sleep.9 pause_sbt.9 \
sleep.9 tsleep.9 \
- sleep.9 tsleep_bt.9 \
+ sleep.9 tsleep_sbt.9 \
sleep.9 wakeup.9 \
sleep.9 wakeup_one.9
MLINKS+=sleepqueue.9 init_sleepqueues.9 \
@@ -1217,7 +1217,7 @@ MLINKS+=sleepqueue.9 init_sleepqueues.9
sleepqueue.9 sleepq_release.9 \
sleepqueue.9 sleepq_remove.9 \
sleepqueue.9 sleepq_set_timeout.9 \
- sleepqueue.9 sleepq_set_timeout_bt.9 \
+ sleepqueue.9 sleepq_set_timeout_sbt.9 \
sleepqueue.9 sleepq_signal.9 \
sleepqueue.9 sleepq_timedwait.9 \
sleepqueue.9 sleepq_timedwait_sig.9 \
@@ -1340,9 +1340,9 @@ MLINKS+=timeout.9 callout.9 \
timeout.9 callout_init_rw.9 \
timeout.9 callout_pending.9 \
timeout.9 callout_reset.9 \
- timeout.9 callout_reset_bt.9 \
+ timeout.9 callout_reset_sbt.9 \
timeout.9 callout_reset_on.9 \
- timeout.9 callout_reset_bt_on.9 \
+ timeout.9 callout_reset_sbt_on.9 \
timeout.9 callout_schedule.9 \
timeout.9 callout_stop.9 \
timeout.9 untimeout.9
Modified: projects/calloutng/share/man/man9/condvar.9
==============================================================================
--- projects/calloutng/share/man/man9/condvar.9 Tue Feb 19 18:28:25 2013 (r247006)
+++ projects/calloutng/share/man/man9/condvar.9 Tue Feb 19 19:14:22 2013 (r247007)
@@ -26,7 +26,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd December 21, 2012
+.Dd February 19, 2013
.Dt CONDVAR 9
.Os
.Sh NAME
@@ -37,9 +37,9 @@
.Nm cv_wait_sig ,
.Nm cv_wait_unlock ,
.Nm cv_timedwait ,
-.Nm cv_timedwait_bt ,
+.Nm cv_timedwait_sbt ,
.Nm cv_timedwait_sig ,
-.Nm cv_timedwait_sig_bt ,
+.Nm cv_timedwait_sig_sbt ,
.Nm cv_signal ,
.Nm cv_broadcast ,
.Nm cv_broadcastpri ,
@@ -62,13 +62,13 @@
.Ft int
.Fn cv_timedwait "struct cv *cvp" "lock" "int timo"
.Ft int
-.Fn cv_timedwait_bt "struct cv *cvp" "lock" "struct bintime bt" \
-"struct bintime pr" "int flags"
+.Fn cv_timedwait_sbt "struct cv *cvp" "lock" "sbintime_t sbt" \
+"sbintime_t pr" "int flags"
.Ft int
.Fn cv_timedwait_sig "struct cv *cvp" "lock" "int timo"
.Ft int
-.Fn cv_timedwait_sig_bt "struct cv *cvp" "lock" "struct bintime bt" \
-"struct bintime pr" "int flags"
+.Fn cv_timedwait_sig_sbt "struct cv *cvp" "lock" "sbintime_t sbt" \
+"sbintime_t pr" "int flags"
.Ft void
.Fn cv_signal "struct cv *cvp"
.Ft void
@@ -200,22 +200,24 @@ if a signal is caught, or 0 if signaled
or
.Fn cv_broadcast .
.Pp
-.Fn cv_timedwait_bt
+.Fn cv_timedwait_sbt
and
-.Fn cv_timedwait_sig_bt
+.Fn cv_timedwait_sig_sbt
functions take
-.Fa bt
+.Fa sbt
argument instead of
.Fa timo .
-It allows to specify unblock time with higher resolution as absolute time
-since boot in form of
-.Vt struct bintime * ,
-as returned by
-.Fn binuptime
-function.
+It allows to specify relative or absolute unblock time with higher resolution
+in form of
+.Vt sbintime_t .
The parameter
.Fa pr
allows to specify wanted absolute event precision.
+The parameter
+.Fa flags
+allows to pass additional
+.Fn callout_reset_sbt
+flags.
.Sh RETURN VALUES
If successful,
.Fn cv_wait_sig ,
@@ -255,4 +257,5 @@ Timeout expired.
.Xr rwlock 9 ,
.Xr sema 9 ,
.Xr sleep 9 ,
-.Xr sx 9
+.Xr sx 9 ,
+.Xr timeout 9
Modified: projects/calloutng/share/man/man9/sleep.9
==============================================================================
--- projects/calloutng/share/man/man9/sleep.9 Tue Feb 19 18:28:25 2013 (r247006)
+++ projects/calloutng/share/man/man9/sleep.9 Tue Feb 19 19:14:22 2013 (r247007)
@@ -25,18 +25,18 @@
.\"
.\" $FreeBSD$
.\"
-.Dd December 21, 2012
+.Dd February 19, 2013
.Dt SLEEP 9
.Os
.Sh NAME
.Nm msleep ,
-.Nm msleep_bt ,
+.Nm msleep_sbt ,
.Nm msleep_spin ,
-.Nm msleep_spin_bt ,
+.Nm msleep_spin_sbt ,
.Nm pause ,
-.Nm pause_bt ,
+.Nm pause_sbt ,
.Nm tsleep ,
-.Nm tsleep_bt ,
+.Nm tsleep_sbt ,
.Nm wakeup
.Nd wait for events
.Sh SYNOPSIS
@@ -46,23 +46,23 @@
.Ft int
.Fn msleep "void *chan" "struct mtx *mtx" "int priority" "const char *wmesg" "int timo"
.Ft int
-.Fn msleep_bt "void *chan" "struct mtx *mtx" "int priority" \
-"const char *wmesg" "struct bintime bt" "struct bintime pr" "int flags"
+.Fn msleep_sbt "void *chan" "struct mtx *mtx" "int priority" \
+"const char *wmesg" "sbintime_t sbt" "sbintime_t pr" "int flags"
.Ft int
.Fn msleep_spin "void *chan" "struct mtx *mtx" "const char *wmesg" "int timo"
.Ft int
-.Fn msleep_spin_bt "void *chan" "struct mtx *mtx" "const char *wmesg" \
-"struct bintime bt" "struct bintime pr" "int flags"
+.Fn msleep_spin_sbt "void *chan" "struct mtx *mtx" "const char *wmesg" \
+"sbintime_t sbt" "sbintime_t pr" "int flags"
.Ft void
.Fn pause "const char *wmesg" "int timo"
.Ft void
-.Fn pause_bt "const char *wmesg" "struct bintime bt" "struct bintime pr" \
+.Fn pause_sbt "const char *wmesg" "sbintime_t sbt" "sbintime_t pr" \
"int flags"
.Ft int
.Fn tsleep "void *chan" "int priority" "const char *wmesg" "int timo"
.Ft int
-.Fn tsleep_bt "void *chan" "int priority" "const char *wmesg" \
-"struct bintime bt" "struct bintime pr" "int flags"
+.Fn tsleep_sbt "void *chan" "int priority" "const char *wmesg" \
+"sbintime_t sbt" "sbintime_t pr" "int flags"
.Ft void
.Fn wakeup "void *chan"
.Ft void
@@ -164,29 +164,26 @@ If the timeout expires,
then the sleep function will return
.Er EWOULDBLOCK .
.Pp
-The parameter
-.Fa flags
-allows to pass additional
-.Fn callout_reset_bt
-flags.
-.Pp
-.Fn msleep_bt ,
-.Fn pause_bt
+.Fn msleep_sbt ,
+.Fn msleep_spin_sbt ,
+.Fn pause_sbt
and
-.Fn tsleep_bt
+.Fn tsleep_sbt
functions take
-.Fa bt
+.Fa sbt
parameter instead of
.Fa timo .
-It allows to specify wakeup time with higher resolution as absolute time
-since boot in form of
-.Vt struct bintime * ,
-as returned by
-.Fn binuptime
-function.
+It allows to specify relative or absolite wakeup time with higher resolution
+in form of
+.Vt sbintime_t .
The parameter
.Fa pr
allows to specify wanted absolute event precision.
+The parameter
+.Fa flags
+allows to pass additional
+.Fn callout_reset_sbt
+flags.
.Pp
Several of the sleep functions including
.Fn msleep ,
@@ -341,7 +338,8 @@ A non-zero timeout was specified and the
.Xr mi_switch 9 ,
.Xr mtx_sleep 9 ,
.Xr rw_sleep 9 ,
-.Xr sx_sleep 9
+.Xr sx_sleep 9 ,
+.Xr timeout 9
.Sh HISTORY
The functions
.Fn sleep
Modified: projects/calloutng/share/man/man9/sleepqueue.9
==============================================================================
--- projects/calloutng/share/man/man9/sleepqueue.9 Tue Feb 19 18:28:25 2013 (r247006)
+++ projects/calloutng/share/man/man9/sleepqueue.9 Tue Feb 19 19:14:22 2013 (r247007)
@@ -23,7 +23,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd December 21, 2012
+.Dd February 19, 2013
.Dt SLEEPQUEUE 9
.Os
.Sh NAME
@@ -41,7 +41,7 @@
.Nm sleepq_remove ,
.Nm sleepq_signal ,
.Nm sleepq_set_timeout ,
-.Nm sleepq_set_timeout_bt ,
+.Nm sleepq_set_timeout_sbt ,
.Nm sleepq_sleepcnt ,
.Nm sleepq_timedwait ,
.Nm sleepq_timedwait_sig ,
@@ -81,8 +81,8 @@
.Ft void
.Fn sleepq_set_timeout "void *wchan" "int timo"
.Ft void
-.Fn sleepq_set_timeout_bt "void *wchan" "struct bintime bt" \
-"struct bintime pr" "int flags"
+.Fn sleepq_set_timeout_sbt "void *wchan" "sbintime_t sbt" \
+"sbintime_t pr" "int flags"
.Ft u_int
.Fn sleepq_sleepcnt "void *wchan" "int queue"
.Ft int
@@ -235,20 +235,22 @@ The
.Fa timo
parameter should specify the timeout value in ticks.
.Pp
-.Fn sleepq_set_timeout_bt
+.Fn sleepq_set_timeout_sbt
function takes
-.Fa bt
+.Fa sbt
argument instead of
.Fa timo .
-It allows to specify wakeup time with higher resolution as absolute time
-since boot in form of
-.Vt struct bintime * ,
-as returned by
-.Fn binuptime
-function.
+It allows to specify relative or absolute wakeup time with higher resolution
+in form of
+.Vt sbintime_t .
The parameter
.Fa pr
allows to specify wanted absolute event precision.
+The parameter
+.Fa flags
+allows to pass additional
+.Fn callout_reset_sbt
+flags.
.Pp
The current thread may be marked interruptible by calling
.Fn sleepq_catch_signals
@@ -419,4 +421,5 @@ than manipulating sleep queues directly.
.Xr condvar 9 ,
.Xr runqueue 9 ,
.Xr scheduler 9 ,
-.Xr sleep 9
+.Xr sleep 9 ,
+.Xr timeout 9
Modified: projects/calloutng/share/man/man9/timeout.9
==============================================================================
--- projects/calloutng/share/man/man9/timeout.9 Tue Feb 19 18:28:25 2013 (r247006)
+++ projects/calloutng/share/man/man9/timeout.9 Tue Feb 19 19:14:22 2013 (r247007)
@@ -29,7 +29,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd December 21, 2012
+.Dd February 19, 2013
.Dt TIMEOUT 9
.Os
.Sh NAME
@@ -44,9 +44,9 @@
.Nm callout_reset ,
.Nm callout_reset_on ,
.Nm callout_reset_curcpu ,
-.Nm callout_reset_bt ,
-.Nm callout_reset_bt_on ,
-.Nm callout_reset_bt_curcpu ,
+.Nm callout_reset_sbt ,
+.Nm callout_reset_sbt_on ,
+.Nm callout_reset_sbt_curcpu ,
.Nm callout_schedule ,
.Nm callout_schedule_on ,
.Nm callout_schedule_curcpu ,
@@ -85,8 +85,8 @@ struct callout_handle handle = CALLOUT_H
.Fn callout_reset_on "struct callout *c" "int ticks" "timeout_t *func" \
"void *arg" "int cpu"
.Ft int
-.Fn callout_reset_bt_on "struct callout *c" "struct bintime bt" \
-"struct bintime pr" "timeout_t *func" "void *arg" "int cpu" "int flags"
+.Fn callout_reset_sbt_on "struct callout *c" "sbintime_t sbt" \
+"sbintime_t pr" "timeout_t *func" "void *arg" "int cpu" "int flags"
.Ft int
.Fn callout_reset_curcpu "struct callout *c" "int ticks" "timeout_t *func" \
"void *arg"
@@ -333,13 +333,9 @@ and
but take an extra parameter specifying the target CPU for the callout.
.Pp
The function
-.Fn callout_reset_bt_on
-allows to get higher time resolution, taking absolute time since boot
-in form of struct bintime *, as returned by
-.Fn binuptime
-or
-.Fn getbinuptime
-functions, and precision, instead of relative ticks count.
+.Fn callout_reset_sbt_on
+allows to get higher time resolution, taking relative or absolute time
+and precision instead of relative ticks count.
If specified time is in past, it will be silently converted to present
to run handler as soon as possible.
.Pp
@@ -349,10 +345,8 @@ may be specified:
.Bl -tag -width ".Dv C_DIRECT_EXEC"
.It Dv C_ALSOLUTE
Handle the
-.Fa bt
-argument as absolute time of the event since boot, as returned by
-.Fn binuptime
-function.
+.Fa sbt
+argument as absolute time of the event since boot, or relative time otherwise.
.It Dv C_DIRECT_EXEC
Run handler directly from hardware interrupt context instead of softclock swi.
It is faster, but puts more constraints on handlers.
More information about the svn-src-projects
mailing list