aboutsummaryrefslogtreecommitdiff
path: root/share/man/man9/taskqueue.9
diff options
context:
space:
mode:
authorAndriy Gapon <avg@FreeBSD.org>2019-10-17 06:58:07 +0000
committerAndriy Gapon <avg@FreeBSD.org>2019-10-17 06:58:07 +0000
commit337f6465a9118bd1887ae671d1c5fe5db027ecd0 (patch)
tree2f675e16c9d8299331815c804014a5ebe7e065b2 /share/man/man9/taskqueue.9
parent5fdc2c044eae307f854affc29224c3c941d7eb43 (diff)
downloadsrc-337f6465a9118bd1887ae671d1c5fe5db027ecd0.tar.gz
src-337f6465a9118bd1887ae671d1c5fe5db027ecd0.zip
document taskqueue_start_threads_in_proc
While here, fix taskqueue_start_threads_cpuset that was documented under old name of taskqueue_start_threads_pinned. MFC after: 4 weeks
Notes
Notes: svn path=/head/; revision=353679
Diffstat (limited to 'share/man/man9/taskqueue.9')
-rw-r--r--share/man/man9/taskqueue.927
1 files changed, 19 insertions, 8 deletions
diff --git a/share/man/man9/taskqueue.9 b/share/man/man9/taskqueue.9
index f20c41425f7f..eb1b07d1d722 100644
--- a/share/man/man9/taskqueue.9
+++ b/share/man/man9/taskqueue.9
@@ -28,7 +28,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd November 21, 2018
+.Dd October 17, 2019
.Dt TASKQUEUE 9
.Os
.Sh NAME
@@ -69,8 +69,13 @@ struct timeout_task;
.Ft int
.Fn taskqueue_start_threads "struct taskqueue **tqp" "int count" "int pri" "const char *name" "..."
.Ft int
-.Fo taskqueue_start_threads_pinned
-.Fa "struct taskqueue **tqp" "int count" "int pri" "int cpu_id"
+.Fo taskqueue_start_threads_cpuset
+.Fa "struct taskqueue **tqp" "int count" "int pri" "cpuset_t *mask"
+.Fa "const char *name" "..."
+.Fc
+.Ft int
+.Fo taskqueue_start_threads_in_proc
+.Fa "struct taskqueue **tqp" "int count" "int pri" "struct proc *proc"
.Fa "const char *name" "..."
.Fc
.Ft void
@@ -152,14 +157,20 @@ Any tasks that are on the queue will be executed at this time after
which the thread servicing the queue will be signaled that it should exit.
.Pp
Once a taskqueue has been created, its threads should be started using
-.Fn taskqueue_start_threads
+.Fn taskqueue_start_threads ,
+.Fn taskqueue_start_threads_cpuset
or
-.Fn taskqueue_start_threads_pinned .
-.Fn taskqueue_start_threads_pinned
+.Fn taskqueue_start_threads_in_proc .
+.Fn taskqueue_start_threads_cpuset
+takes a
+.Va cpuset
+argument which will cause the threads which are started for the taskqueue
+to be restricted to run on the given CPUs.
+.Fn taskqueue_start_threads_in_proc
takes a
-.Va cpu_id
+.Va proc
argument which will cause the threads which are started for the taskqueue
-to be pinned to run on the given CPU.
+to be assigned to the given kernel process.
Callbacks may optionally be registered using
.Fn taskqueue_set_callback .
Currently, callbacks may be registered for the following purposes: