d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add descriptions for callout_reset_on and callout_schedule_on and

Browse Source 
their curcpu variants.

Discussed with:	mav, davide
MFC after:	1 week
This commit is contained in:
jimharris 2012-11-01 21:00:13 +00:00
parent 91507a2ac1
commit fa2f4d5744
1 changed files with 35 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
share/man/man9/timeout.9
View File

@ -29,7 +29,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd August 2, 2008
.Dd November 1, 2012
.Dt TIMEOUT 9
.Os
.Sh NAME
@ -42,7 +42,11 @@
.Nm callout_stop ,
.Nm callout_drain ,
.Nm callout_reset ,
.Nm callout_reset_on ,
.Nm callout_reset_curcpu ,
.Nm callout_schedule ,
.Nm callout_schedule_on ,
.Nm callout_schedule_curcpu ,
.Nm callout_pending ,
.Nm callout_active ,
.Nm callout_deactivate
@ -75,8 +79,18 @@ struct callout_handle handle = CALLOUT_HANDLE_INITIALIZER(&handle)
.Ft int
.Fn callout_reset "struct callout *c" "int ticks" "timeout_t *func" "void *arg"
.Ft int
.Fn callout_reset_on "struct callout *c" "int ticks" "timeout_t *func" \
"void *arg" "int cpu"
.Ft int
.Fn callout_reset_curcpu "struct callout *c" "int ticks" "timeout_t *func" \
"void *arg"
.Ft int
.Fn callout_schedule "struct callout *c" "int ticks"
.Ft int
.Fn callout_schedule_on "struct callout *c" "int ticks" "int cpu"
.Ft int
.Fn callout_schedule_curcpu "struct callout *c" "int ticks"
.Ft int
.Fn callout_pending "struct callout *c"
.Ft int
.Fn callout_active "struct callout *c"
@ -302,6 +316,26 @@ and
parameters extracted from the callout structure (though possibly with
lower overhead).
.Pp
The functions
.Fn callout_reset_on
and
.Fn callout_schedule_on
are equivalent to
.Fn callout_reset
and
.Fn callout_schedule
but take an extra parameter specifying the target CPU for the callout.
.Pp
The functions
.Fn callout_reset_curcpu
and
.Fn callout_schedule_curcpu
are wrappers for
.Fn callout_reset_on
and
.Fn callout_schedule_on
using the current CPU as the target CPU.
.Pp
The macros
.Fn callout_pending ,
.Fn callout_active