0001 .. include:: ../disclaimer-zh_CN.rst
0002
0003 :Original: Documentation/core-api/local_ops.rst
0004
0005 :翻译:
0006
0007 司延腾 Yanteng Si <siyanteng@loongson.cn>
0008
0009 .. _cn_local_ops:
0010
0011 ========================
0012 本地原子操作的语义和行为
0013 ========================
0014
0015 :作者: Mathieu Desnoyers
0016
0017
0018 本文解释了本地原子操作的目的,如何为任何给定的架构实现这些操作,并说明了
0019 如何正确使用这些操作。它还强调了在内存写入顺序很重要的情况下,跨CPU读取
0020 这些本地变量时必须采取的预防措施。
0021
0022 .. note::
0023
0024 注意,基于 ``local_t`` 的操作不建议用于一般内核操作。请使用 ``this_cpu``
0025 操作来代替使用,除非真的有特殊目的。大多数内核中使用的 ``local_t`` 已
0026 经被 ``this_cpu`` 操作所取代。 ``this_cpu`` 操作在一条指令中结合了重
0027 定位和类似 ``local_t`` 的语义,产生了更紧凑和更快的执行代码。
0028
0029
0030 本地原子操作的目的
0031 ==================
0032
0033 本地原子操作的目的是提供快速和高度可重入的每CPU计数器。它们通过移除LOCK前
0034 缀和通常需要在CPU间同步的内存屏障,将标准原子操作的性能成本降到最低。
0035
0036 在许多情况下,拥有快速的每CPU原子计数器是很有吸引力的:它不需要禁用中断来保护中
0037 断处理程序,它允许在NMI(Non Maskable Interrupt)处理程序中使用连贯的计数器。
0038 它对追踪目的和各种性能监测计数器特别有用。
0039
0040 本地原子操作只保证在拥有数据的CPU上的变量修改的原子性。因此,必须注意确保只
0041 有一个CPU写到 ``local_t`` 的数据。这是通过使用每CPU的数据来实现的,并确
0042 保我们在一个抢占式安全上下文中修改它。然而,从任何一个CPU读取 ``local_t``
0043 数据都是允许的:这样它就会显得与所有者CPU的其他内存写入顺序不一致。
0044
0045
0046 针对特定架构的实现
0047 ==================
0048
0049 这可以通过稍微修改标准的原子操作来实现:只有它们的UP变体必须被保留。这通常
0050 意味着删除LOCK前缀(在i386和x86_64上)和任何SMP同步屏障。如果架构在SMP和
0051 UP之间没有不同的行为,在你的架构的 ``local.h`` 中包括 ``asm-generic/local.h``
0052 就足够了。
0053
0054 通过在一个结构体中嵌入一个 ``atomic_long_t`` , ``local_t`` 类型被定义为
0055 一个不透明的 ``signed long`` 。这样做的目的是为了使从这个类型到
0056 ``long`` 的转换失败。该定义看起来像::
0057
0058 typedef struct { atomic_long_t a; } local_t;
0059
0060
0061 使用本地原子操作时应遵循的规则
0062 ==============================
0063
0064 * 被本地操作触及的变量必须是每cpu的变量。
0065
0066 * *只有* 这些变量的CPU所有者才可以写入这些变量。
0067
0068 * 这个CPU可以从任何上下文(进程、中断、软中断、nmi...)中使用本地操作来更新
0069 它的local_t变量。
0070
0071 * 当在进程上下文中使用本地操作时,必须禁用抢占(或中断),以确保进程在获得每
0072 CPU变量和进行实际的本地操作之间不会被迁移到不同的CPU。
0073
0074 * 当在中断上下文中使用本地操作时,在主线内核上不需要特别注意,因为它们将在局
0075 部CPU上运行,并且已经禁用了抢占。然而,我建议无论如何都要明确地禁用抢占,
0076 以确保它在-rt内核上仍能正确工作。
0077
0078 * 读取本地cpu变量将提供该变量的当前拷贝。
0079
0080 * 对这些变量的读取可以从任何CPU进行,因为对 “ ``long`` ”,对齐的变量的更新
0081 总是原子的。由于写入程序的CPU没有进行内存同步,所以在读取 *其他* cpu的变
0082 量时,可以读取该变量的过期副本。
0083
0084
0085 如何使用本地原子操作
0086 ====================
0087
0088 ::
0089
0090 #include <linux/percpu.h>
0091 #include <asm/local.h>
0092
0093 static DEFINE_PER_CPU(local_t, counters) = LOCAL_INIT(0);
0094
0095
0096 计数器
0097 ======
0098
0099 计数是在一个signed long的所有位上进行的。
0100
0101 在可抢占的上下文中,围绕本地原子操作使用 ``get_cpu_var()`` 和
0102 ``put_cpu_var()`` :它确保在对每个cpu变量进行写访问时,抢占被禁用。比如
0103 说::
0104
0105 local_inc(&get_cpu_var(counters));
0106 put_cpu_var(counters);
0107
0108 如果你已经在一个抢占安全上下文中,你可以使用 ``this_cpu_ptr()`` 代替::
0109
0110 local_inc(this_cpu_ptr(&counters));
0111
0112
0113
0114 读取计数器
0115 ==========
0116
0117 那些本地计数器可以从外部的CPU中读取,以求得计数的总和。请注意,local_read
0118 所看到的跨CPU的数据必须被认为是相对于拥有该数据的CPU上发生的其他内存写入来
0119 说不符合顺序的::
0120
0121 long sum = 0;
0122 for_each_online_cpu(cpu)
0123 sum += local_read(&per_cpu(counters, cpu));
0124
0125 如果你想使用远程local_read来同步CPU之间对资源的访问,必须在写入者和读取者
0126 的CPU上分别使用显式的 ``smp_wmb()`` 和 ``smp_rmb()`` 内存屏障。如果你使
0127 用 ``local_t`` 变量作为写在缓冲区中的字节的计数器,就会出现这种情况:在缓
0128 冲区写和计数器增量之间应该有一个 ``smp_wmb()`` ,在计数器读和缓冲区读之间
0129 也应有一个 ``smp_rmb()`` 。
0130
0131 下面是一个使用 ``local.h`` 实现每个cpu基本计数器的示例模块::
0132
0133 /* test-local.c
0134 *
0135 * Sample module for local.h usage.
0136 */
0137
0138
0139 #include <asm/local.h>
0140 #include <linux/module.h>
0141 #include <linux/timer.h>
0142
0143 static DEFINE_PER_CPU(local_t, counters) = LOCAL_INIT(0);
0144
0145 static struct timer_list test_timer;
0146
0147 /* IPI called on each CPU. */
0148 static void test_each(void *info)
0149 {
0150 /* Increment the counter from a non preemptible context */
0151 printk("Increment on cpu %d\n", smp_processor_id());
0152 local_inc(this_cpu_ptr(&counters));
0153
0154 /* This is what incrementing the variable would look like within a
0155 * preemptible context (it disables preemption) :
0156 *
0157 * local_inc(&get_cpu_var(counters));
0158 * put_cpu_var(counters);
0159 */
0160 }
0161
0162 static void do_test_timer(unsigned long data)
0163 {
0164 int cpu;
0165
0166 /* Increment the counters */
0167 on_each_cpu(test_each, NULL, 1);
0168 /* Read all the counters */
0169 printk("Counters read from CPU %d\n", smp_processor_id());
0170 for_each_online_cpu(cpu) {
0171 printk("Read : CPU %d, count %ld\n", cpu,
0172 local_read(&per_cpu(counters, cpu)));
0173 }
0174 mod_timer(&test_timer, jiffies + 1000);
0175 }
0176
0177 static int __init test_init(void)
0178 {
0179 /* initialize the timer that will increment the counter */
0180 timer_setup(&test_timer, do_test_timer, 0);
0181 mod_timer(&test_timer, jiffies + 1);
0182
0183 return 0;
0184 }
0185
0186 static void __exit test_exit(void)
0187 {
0188 del_timer_sync(&test_timer);
0189 }
0190
0191 module_init(test_init);
0192 module_exit(test_exit);
0193
0194 MODULE_LICENSE("GPL");
0195 MODULE_AUTHOR("Mathieu Desnoyers");
0196 MODULE_DESCRIPTION("Local Atomic Ops");