History

Documentation/locking/locktypes: fix local_locks documentation

Fix issues with local_locks documentation: - fix function names, local_lock.h has local_unlock_irqrestore(), not local_lock_irqrestore() - fix mapping table, local_unlock_irqrestore() maps to local_irq_restore(), not _save()

Marta Rybczynska committed 6 years ago

Commit 94dea151 parent 9123e3a1 file · +12 −12Browse files

Showing the changes to Documentation (1 of 1 file). Show all

Unified · Split

Documentation/locking/locktypes.rst+12−12
@@ -164,14 +164,14 @@ by disabling preemption or interrupts. · 163 unmodified lines
164164 On non-PREEMPT_RT kernels local_lock operations map to the preemption and
165165 interrupt disabling and enabling primitives:
166166
167− =========================== ======================
168− local_lock(&llock) preempt_disable()
169− local_unlock(&llock) preempt_enable()
170− local_lock_irq(&llock) local_irq_disable()
171− local_unlock_irq(&llock) local_irq_enable()
172− local_lock_save(&llock) local_irq_save()
173− local_lock_restore(&llock) local_irq_save()
174− =========================== ======================
167+ =============================== ======================
168+ local_lock(&llock) preempt_disable()
169+ local_unlock(&llock) preempt_enable()
170+ local_lock_irq(&llock) local_irq_disable()
171+ local_unlock_irq(&llock) local_irq_enable()
172+ local_lock_irqsave(&llock) local_irq_save()
173+ local_unlock_irqrestore(&llock) local_irq_restore()
174+ =============================== ======================
175175
176176 The named scope of local_lock has two advantages over the regular
177177 primitives:
@@ -353,14 +353,14 @@ protection scope. So the following substitution is wrong:: · 175 unmodified lines
353353 {
354354 local_irq_save(flags); -> local_lock_irqsave(&local_lock_1, flags);
355355 func3();
356− local_irq_restore(flags); -> local_lock_irqrestore(&local_lock_1, flags);
356+ local_irq_restore(flags); -> local_unlock_irqrestore(&local_lock_1, flags);
357357 }
358358
359359 func2()
360360 {
361361 local_irq_save(flags); -> local_lock_irqsave(&local_lock_2, flags);
362362 func3();
363− local_irq_restore(flags); -> local_lock_irqrestore(&local_lock_2, flags);
363+ local_irq_restore(flags); -> local_unlock_irqrestore(&local_lock_2, flags);
364364 }
365365
366366 func3()
@@ -379,14 +379,14 @@ PREEMPT_RT-specific semantics of spinlock_t. The correct substitution is:: · 12 unmodified lines
379379 {
380380 local_irq_save(flags); -> local_lock_irqsave(&local_lock, flags);
381381 func3();
382− local_irq_restore(flags); -> local_lock_irqrestore(&local_lock, flags);
382+ local_irq_restore(flags); -> local_unlock_irqrestore(&local_lock, flags);
383383 }
384384
385385 func2()
386386 {
387387 local_irq_save(flags); -> local_lock_irqsave(&local_lock, flags);
388388 func3();
389− local_irq_restore(flags); -> local_lock_irqrestore(&local_lock, flags);
389+ local_irq_restore(flags); -> local_unlock_irqrestore(&local_lock, flags);
390390 }
391391
392392 func3()