aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLinus Torvalds <torvalds@linux-foundation.org>2017-10-03 13:44:03 -0400
committerLinus Torvalds <torvalds@linux-foundation.org>2017-10-03 13:44:03 -0400
commitd81fa669e3de7eb8a631d7d95dac5fbcb2bf9d4e (patch)
treeff1f09b2d1f09db754a6b5cb4be690bb7a53a8ef
parent847d9fb477c3a16cc177751e24fcc1aafcd699d6 (diff)
parent47684e111f52fface17820d3ef84cc845b26070e (diff)
Merge branch 'for-4.14-fixes' of git://git.kernel.org/pub/scm/linux/kernel/git/tj/wq
Pull workqueue fixlet from Tejun Heo: "Minor documentation update" * 'for-4.14-fixes' of git://git.kernel.org/pub/scm/linux/kernel/git/tj/wq: Documentation: core-api: minor workqueue.rst cleanups
-rw-r--r--Documentation/core-api/workqueue.rst12
1 files changed, 6 insertions, 6 deletions
diff --git a/Documentation/core-api/workqueue.rst b/Documentation/core-api/workqueue.rst
index 3943b5bfa8cf..00a5ba51e63f 100644
--- a/Documentation/core-api/workqueue.rst
+++ b/Documentation/core-api/workqueue.rst
@@ -39,8 +39,8 @@ up.
39Although MT wq wasted a lot of resource, the level of concurrency 39Although MT wq wasted a lot of resource, the level of concurrency
40provided was unsatisfactory. The limitation was common to both ST and 40provided was unsatisfactory. The limitation was common to both ST and
41MT wq albeit less severe on MT. Each wq maintained its own separate 41MT wq albeit less severe on MT. Each wq maintained its own separate
42worker pool. A MT wq could provide only one execution context per CPU 42worker pool. An MT wq could provide only one execution context per CPU
43while a ST wq one for the whole system. Work items had to compete for 43while an ST wq one for the whole system. Work items had to compete for
44those very limited execution contexts leading to various problems 44those very limited execution contexts leading to various problems
45including proneness to deadlocks around the single execution context. 45including proneness to deadlocks around the single execution context.
46 46
@@ -151,7 +151,7 @@ Application Programming Interface (API)
151 151
152``alloc_workqueue()`` allocates a wq. The original 152``alloc_workqueue()`` allocates a wq. The original
153``create_*workqueue()`` functions are deprecated and scheduled for 153``create_*workqueue()`` functions are deprecated and scheduled for
154removal. ``alloc_workqueue()`` takes three arguments - @``name``, 154removal. ``alloc_workqueue()`` takes three arguments - ``@name``,
155``@flags`` and ``@max_active``. ``@name`` is the name of the wq and 155``@flags`` and ``@max_active``. ``@name`` is the name of the wq and
156also used as the name of the rescuer thread if there is one. 156also used as the name of the rescuer thread if there is one.
157 157
@@ -197,7 +197,7 @@ resources, scheduled and executed.
197 served by worker threads with elevated nice level. 197 served by worker threads with elevated nice level.
198 198
199 Note that normal and highpri worker-pools don't interact with 199 Note that normal and highpri worker-pools don't interact with
200 each other. Each maintain its separate pool of workers and 200 each other. Each maintains its separate pool of workers and
201 implements concurrency management among its workers. 201 implements concurrency management among its workers.
202 202
203``WQ_CPU_INTENSIVE`` 203``WQ_CPU_INTENSIVE``
@@ -249,8 +249,8 @@ unbound worker-pools and only one work item could be active at any given
249time thus achieving the same ordering property as ST wq. 249time thus achieving the same ordering property as ST wq.
250 250
251In the current implementation the above configuration only guarantees 251In the current implementation the above configuration only guarantees
252ST behavior within a given NUMA node. Instead alloc_ordered_queue should 252ST behavior within a given NUMA node. Instead ``alloc_ordered_queue()`` should
253be used to achieve system wide ST behavior. 253be used to achieve system-wide ST behavior.
254 254
255 255
256Example Execution Scenarios 256Example Execution Scenarios