blob: f8a3f1a829b8a9d767bed39c5138c7015380196b [file] [log] [blame]
Ravikiran G Thirumalai3cbc56402006-06-23 02:05:40 -07001/*
2 * Fast batching percpu counters.
3 */
4
5#include <linux/percpu_counter.h>
Andrew Mortonc67ad912007-07-15 23:39:51 -07006#include <linux/notifier.h>
7#include <linux/mutex.h>
8#include <linux/init.h>
9#include <linux/cpu.h>
Ravikiran G Thirumalai3cbc56402006-06-23 02:05:40 -070010#include <linux/module.h>
Tejun Heoe2852ae2010-10-26 14:23:05 -070011#include <linux/debugobjects.h>
Ravikiran G Thirumalai3cbc56402006-06-23 02:05:40 -070012
Glauber Costa3a8495c2011-10-31 17:12:34 -070013#ifdef CONFIG_HOTPLUG_CPU
Andrew Mortonc67ad912007-07-15 23:39:51 -070014static LIST_HEAD(percpu_counters);
15static DEFINE_MUTEX(percpu_counters_lock);
Glauber Costa3a8495c2011-10-31 17:12:34 -070016#endif
Andrew Mortonc67ad912007-07-15 23:39:51 -070017
Tejun Heoe2852ae2010-10-26 14:23:05 -070018#ifdef CONFIG_DEBUG_OBJECTS_PERCPU_COUNTER
19
20static struct debug_obj_descr percpu_counter_debug_descr;
21
22static int percpu_counter_fixup_free(void *addr, enum debug_obj_state state)
23{
24 struct percpu_counter *fbc = addr;
25
26 switch (state) {
27 case ODEBUG_STATE_ACTIVE:
28 percpu_counter_destroy(fbc);
29 debug_object_free(fbc, &percpu_counter_debug_descr);
30 return 1;
31 default:
32 return 0;
33 }
34}
35
36static struct debug_obj_descr percpu_counter_debug_descr = {
37 .name = "percpu_counter",
38 .fixup_free = percpu_counter_fixup_free,
39};
40
41static inline void debug_percpu_counter_activate(struct percpu_counter *fbc)
42{
43 debug_object_init(fbc, &percpu_counter_debug_descr);
44 debug_object_activate(fbc, &percpu_counter_debug_descr);
45}
46
47static inline void debug_percpu_counter_deactivate(struct percpu_counter *fbc)
48{
49 debug_object_deactivate(fbc, &percpu_counter_debug_descr);
50 debug_object_free(fbc, &percpu_counter_debug_descr);
51}
52
53#else /* CONFIG_DEBUG_OBJECTS_PERCPU_COUNTER */
54static inline void debug_percpu_counter_activate(struct percpu_counter *fbc)
55{ }
56static inline void debug_percpu_counter_deactivate(struct percpu_counter *fbc)
57{ }
58#endif /* CONFIG_DEBUG_OBJECTS_PERCPU_COUNTER */
59
Peter Zijlstra3a587f42007-10-16 23:25:44 -070060void percpu_counter_set(struct percpu_counter *fbc, s64 amount)
61{
62 int cpu;
63
Thomas Gleixnerf032a452009-07-25 16:21:48 +020064 raw_spin_lock(&fbc->lock);
Peter Zijlstra3a587f42007-10-16 23:25:44 -070065 for_each_possible_cpu(cpu) {
66 s32 *pcount = per_cpu_ptr(fbc->counters, cpu);
67 *pcount = 0;
68 }
69 fbc->count = amount;
Thomas Gleixnerf032a452009-07-25 16:21:48 +020070 raw_spin_unlock(&fbc->lock);
Peter Zijlstra3a587f42007-10-16 23:25:44 -070071}
72EXPORT_SYMBOL(percpu_counter_set);
73
Peter Zijlstra20e89762007-10-16 23:25:43 -070074void __percpu_counter_add(struct percpu_counter *fbc, s64 amount, s32 batch)
Ravikiran G Thirumalai3cbc56402006-06-23 02:05:40 -070075{
Peter Zijlstra20e89762007-10-16 23:25:43 -070076 s64 count;
Ravikiran G Thirumalai3cbc56402006-06-23 02:05:40 -070077
Christoph Lameterea00c302010-10-26 14:23:09 -070078 preempt_disable();
Christoph Lameter819a72a2010-12-06 11:16:19 -060079 count = __this_cpu_read(*fbc->counters) + amount;
Peter Zijlstra252e0ba2007-10-16 23:25:43 -070080 if (count >= batch || count <= -batch) {
Thomas Gleixnerf032a452009-07-25 16:21:48 +020081 raw_spin_lock(&fbc->lock);
Ravikiran G Thirumalai3cbc56402006-06-23 02:05:40 -070082 fbc->count += count;
Christoph Lameter819a72a2010-12-06 11:16:19 -060083 __this_cpu_write(*fbc->counters, 0);
Thomas Gleixnerf032a452009-07-25 16:21:48 +020084 raw_spin_unlock(&fbc->lock);
Ravikiran G Thirumalai3cbc56402006-06-23 02:05:40 -070085 } else {
Christoph Lameter819a72a2010-12-06 11:16:19 -060086 __this_cpu_write(*fbc->counters, count);
Ravikiran G Thirumalai3cbc56402006-06-23 02:05:40 -070087 }
Christoph Lameterea00c302010-10-26 14:23:09 -070088 preempt_enable();
Ravikiran G Thirumalai3cbc56402006-06-23 02:05:40 -070089}
Peter Zijlstra252e0ba2007-10-16 23:25:43 -070090EXPORT_SYMBOL(__percpu_counter_add);
Ravikiran G Thirumalai3cbc56402006-06-23 02:05:40 -070091
92/*
93 * Add up all the per-cpu counts, return the result. This is a more accurate
94 * but much slower version of percpu_counter_read_positive()
95 */
Andrew Morton02d21162008-12-09 13:14:14 -080096s64 __percpu_counter_sum(struct percpu_counter *fbc)
Ravikiran G Thirumalai3cbc56402006-06-23 02:05:40 -070097{
Mingming Cao0216bfc2006-06-23 02:05:41 -070098 s64 ret;
Ravikiran G Thirumalai3cbc56402006-06-23 02:05:40 -070099 int cpu;
100
Thomas Gleixnerf032a452009-07-25 16:21:48 +0200101 raw_spin_lock(&fbc->lock);
Ravikiran G Thirumalai3cbc56402006-06-23 02:05:40 -0700102 ret = fbc->count;
Andrew Mortonb4ef0292007-07-15 23:39:51 -0700103 for_each_online_cpu(cpu) {
Mingming Cao0216bfc2006-06-23 02:05:41 -0700104 s32 *pcount = per_cpu_ptr(fbc->counters, cpu);
Ravikiran G Thirumalai3cbc56402006-06-23 02:05:40 -0700105 ret += *pcount;
106 }
Thomas Gleixnerf032a452009-07-25 16:21:48 +0200107 raw_spin_unlock(&fbc->lock);
Peter Zijlstrabf1d89c2007-10-16 23:25:45 -0700108 return ret;
Ravikiran G Thirumalai3cbc56402006-06-23 02:05:40 -0700109}
Peter Zijlstrabf1d89c2007-10-16 23:25:45 -0700110EXPORT_SYMBOL(__percpu_counter_sum);
Andrew Mortonc67ad912007-07-15 23:39:51 -0700111
Peter Zijlstraea319512008-12-26 15:08:55 +0100112int __percpu_counter_init(struct percpu_counter *fbc, s64 amount,
113 struct lock_class_key *key)
Andrew Mortonc67ad912007-07-15 23:39:51 -0700114{
Thomas Gleixnerf032a452009-07-25 16:21:48 +0200115 raw_spin_lock_init(&fbc->lock);
Peter Zijlstraea319512008-12-26 15:08:55 +0100116 lockdep_set_class(&fbc->lock, key);
Andrew Mortonc67ad912007-07-15 23:39:51 -0700117 fbc->count = amount;
118 fbc->counters = alloc_percpu(s32);
Peter Zijlstra833f4072007-10-16 23:25:45 -0700119 if (!fbc->counters)
120 return -ENOMEM;
Tejun Heoe2852ae2010-10-26 14:23:05 -0700121
122 debug_percpu_counter_activate(fbc);
123
Andrew Mortonc67ad912007-07-15 23:39:51 -0700124#ifdef CONFIG_HOTPLUG_CPU
Masanori ITOH8474b592010-10-26 14:21:20 -0700125 INIT_LIST_HEAD(&fbc->list);
Andrew Mortonc67ad912007-07-15 23:39:51 -0700126 mutex_lock(&percpu_counters_lock);
127 list_add(&fbc->list, &percpu_counters);
128 mutex_unlock(&percpu_counters_lock);
129#endif
Peter Zijlstra833f4072007-10-16 23:25:45 -0700130 return 0;
Andrew Mortonc67ad912007-07-15 23:39:51 -0700131}
Peter Zijlstraea319512008-12-26 15:08:55 +0100132EXPORT_SYMBOL(__percpu_counter_init);
Peter Zijlstradc62a302007-10-16 23:25:46 -0700133
Andrew Mortonc67ad912007-07-15 23:39:51 -0700134void percpu_counter_destroy(struct percpu_counter *fbc)
135{
Peter Zijlstra833f4072007-10-16 23:25:45 -0700136 if (!fbc->counters)
137 return;
138
Tejun Heoe2852ae2010-10-26 14:23:05 -0700139 debug_percpu_counter_deactivate(fbc);
140
Andrew Mortonc67ad912007-07-15 23:39:51 -0700141#ifdef CONFIG_HOTPLUG_CPU
142 mutex_lock(&percpu_counters_lock);
143 list_del(&fbc->list);
144 mutex_unlock(&percpu_counters_lock);
145#endif
Eric Dumazetfd3d6642008-12-09 13:14:11 -0800146 free_percpu(fbc->counters);
147 fbc->counters = NULL;
Andrew Mortonc67ad912007-07-15 23:39:51 -0700148}
149EXPORT_SYMBOL(percpu_counter_destroy);
150
Eric Dumazet179f7eb2009-01-06 14:41:04 -0800151int percpu_counter_batch __read_mostly = 32;
152EXPORT_SYMBOL(percpu_counter_batch);
153
154static void compute_batch_value(void)
155{
156 int nr = num_online_cpus();
157
158 percpu_counter_batch = max(32, nr*2);
159}
160
Andrew Mortonc67ad912007-07-15 23:39:51 -0700161static int __cpuinit percpu_counter_hotcpu_callback(struct notifier_block *nb,
162 unsigned long action, void *hcpu)
163{
Eric Dumazet179f7eb2009-01-06 14:41:04 -0800164#ifdef CONFIG_HOTPLUG_CPU
Andrew Mortonc67ad912007-07-15 23:39:51 -0700165 unsigned int cpu;
166 struct percpu_counter *fbc;
167
Eric Dumazet179f7eb2009-01-06 14:41:04 -0800168 compute_batch_value();
Andrew Mortonc67ad912007-07-15 23:39:51 -0700169 if (action != CPU_DEAD)
170 return NOTIFY_OK;
171
172 cpu = (unsigned long)hcpu;
173 mutex_lock(&percpu_counters_lock);
174 list_for_each_entry(fbc, &percpu_counters, list) {
175 s32 *pcount;
Gautham R Shenoyd2b20b12007-10-18 23:40:47 -0700176 unsigned long flags;
Andrew Mortonc67ad912007-07-15 23:39:51 -0700177
Thomas Gleixnerf032a452009-07-25 16:21:48 +0200178 raw_spin_lock_irqsave(&fbc->lock, flags);
Andrew Mortonc67ad912007-07-15 23:39:51 -0700179 pcount = per_cpu_ptr(fbc->counters, cpu);
180 fbc->count += *pcount;
181 *pcount = 0;
Thomas Gleixnerf032a452009-07-25 16:21:48 +0200182 raw_spin_unlock_irqrestore(&fbc->lock, flags);
Andrew Mortonc67ad912007-07-15 23:39:51 -0700183 }
184 mutex_unlock(&percpu_counters_lock);
Eric Dumazet179f7eb2009-01-06 14:41:04 -0800185#endif
Andrew Mortonc67ad912007-07-15 23:39:51 -0700186 return NOTIFY_OK;
187}
188
Tim Chen27f5e0f2010-08-09 17:19:04 -0700189/*
190 * Compare counter against given value.
191 * Return 1 if greater, 0 if equal and -1 if less
192 */
193int percpu_counter_compare(struct percpu_counter *fbc, s64 rhs)
194{
195 s64 count;
196
197 count = percpu_counter_read(fbc);
198 /* Check to see if rough count will be sufficient for comparison */
199 if (abs(count - rhs) > (percpu_counter_batch*num_online_cpus())) {
200 if (count > rhs)
201 return 1;
202 else
203 return -1;
204 }
205 /* Need to use precise count */
206 count = percpu_counter_sum(fbc);
207 if (count > rhs)
208 return 1;
209 else if (count < rhs)
210 return -1;
211 else
212 return 0;
213}
214EXPORT_SYMBOL(percpu_counter_compare);
215
Andrew Mortonc67ad912007-07-15 23:39:51 -0700216static int __init percpu_counter_startup(void)
217{
Eric Dumazet179f7eb2009-01-06 14:41:04 -0800218 compute_batch_value();
Andrew Mortonc67ad912007-07-15 23:39:51 -0700219 hotcpu_notifier(percpu_counter_hotcpu_callback, 0);
220 return 0;
221}
222module_init(percpu_counter_startup);