Eric Lee / smarc-fsl-linux-kernel

Download as
Browse Code ยป

Commit 066a9be6c0124edc9527088231f03c6236be375d

Authored by Naohiro Aota
Committed by Linus Torvalds
1 parent 66f1991bc2
Exists in master and in 39 other branches 8mp-imx_5.4.70_2.3.0, 8qm-imx_5.4.70_2.3.0, emb_imx_lf-5.15.y, emb_lf-6.1.y, imx_3.0.35_4.1.0, imx_3.10.17_1.0.1_ga, imx_3.10.53_1.1.0_ga, imx_3.14.28_1.0.0_ga, imx_4.1.15_1.0.0_ga, pitx_8mp_lf-5.10.y, rt-smarc-imx_4.1.15_1.0.0_ga, rt_linux_5.15.71, smarc-8m-android-11.0.0_2.0.0, smarc-imx6_4.14.98_2.0.0_ga, smarc-imx6_4.9.88_2.0.0_ga, smarc-imx7_4.14.98_2.0.0_ga, smarc-imx7_4.9.11_1.0.0_ga, smarc-imx7_4.9.88_2.0.0_ga, smarc-imx_3.10.53_1.1.0_ga, smarc-imx_3.14.28_1.0.0_ga, smarc-imx_4.1.15_1.0.0_ga, smarc-imx_4.9.11_1.0.0_ga, smarc-imx_4.9.51_imx8m_ga, smarc-imx_4.9.88_2.0.0_ga, smarc-m6.0.1_2.1.0-ga, smarc-n7.1.2_2.0.0-ga, smarc-rel_imx_4.1.15_1.2.0_ga, smarc_8m_00d0_imx_4.14.98_2.0.0_ga, smarc_8m_imx_4.14.78_1.0.0_ga, smarc_8m_imx_4.14.98_2.0.0_ga, smarc_8m_imx_4.19.35_1.1.0, smarc_8mm_imx_4.14.78_1.0.0_ga, smarc_8mm_imx_4.14.98_2.0.0_ga, smarc_8mm_imx_4.19.35_1.1.0, smarc_8mm_imx_5.4.24_2.1.0, smarc_8mp_lf-5.10.y, smarc_8mq_imx_5.4.24_2.1.0, smarc_8mq_lf-5.10.y, smarc_imx_lf-5.15.y

idr: fix idr_pre_get() locking description 

Despite the idr_pre_get() kernel-doc, there are some cases where you can
call idr_pre_get() from within locked regions.  Add a description for such
cases.

See also: http://lkml.org/lkml/2010/9/16/462

[akpm@linux-foundation.org: cleanups, grammatical fixes]
Signed-off-by: Naohiro Aota <naota@elisp.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

Showing 1 changed file with 13 additions and 11 deletions Side-by-side Diff

... ... @@ -110,9 +110,10 @@
110 110 * @idp: idr handle
111 111 * @gfp_mask: memory allocation flags
112 112 *
113   - * This function should be called prior to locking and calling the
114   - * idr_get_new* functions. It preallocates enough memory to satisfy
115   - * the worst possible allocation.
  113 + * This function should be called prior to calling the idr_get_new* functions.
  114 + * It preallocates enough memory to satisfy the worst possible allocation. The
  115 + * caller should pass in GFP_KERNEL if possible. This of course requires that
  116 + * no spinning locks be held.
116 117 *
117 118 * If the system is REALLY out of memory this function returns 0,
118 119 * otherwise 1.
119 120  
... ... @@ -290,10 +291,12 @@
290 291 * This is the allocate id function. It should be called with any
291 292 * required locks.
292 293 *
293   - * If memory is required, it will return -EAGAIN, you should unlock
294   - * and go back to the idr_pre_get() call. If the idr is full, it will
295   - * return -ENOSPC.
  294 + * If allocation from IDR's private freelist fails, idr_get_new_above() will
  295 + * return -EAGAIN. The caller should retry the idr_pre_get() call to refill
  296 + * IDR's preallocation and then retry the idr_get_new_above() call.
296 297 *
  298 + * If the idr is full idr_get_new_above() will return -ENOSPC.
  299 + *
297 300 * @id returns a value in the range @starting_id ... 0x7fffffff
298 301 */
299 302 int idr_get_new_above(struct idr *idp, void *ptr, int starting_id, int *id)
300 303  
... ... @@ -318,12 +321,11 @@
318 321 * @ptr: pointer you want associated with the id
319 322 * @id: pointer to the allocated handle
320 323 *
321   - * This is the allocate id function. It should be called with any
322   - * required locks.
  324 + * If allocation from IDR's private freelist fails, idr_get_new_above() will
  325 + * return -EAGAIN. The caller should retry the idr_pre_get() call to refill
  326 + * IDR's preallocation and then retry the idr_get_new_above() call.
323 327 *
324   - * If memory is required, it will return -EAGAIN, you should unlock
325   - * and go back to the idr_pre_get() call. If the idr is full, it will
326   - * return -ENOSPC.
  328 + * If the idr is full idr_get_new_above() will return -ENOSPC.
327 329 *
328 330 * @id returns a value in the range 0 ... 0x7fffffff
329 331 */