2 * Xen hypercall batching.
4 * Xen allows multiple hypercalls to be issued at once, using the
5 * multicall interface. This allows the cost of trapping into the
6 * hypervisor to be amortized over several calls.
8 * This file implements a simple interface for multicalls. There's a
9 * per-cpu buffer of outstanding multicalls. When you want to queue a
10 * multicall for issuing, you can allocate a multicall slot for the
11 * call and its arguments, along with storage for space which is
12 * pointed to by the arguments (for passing pointers to structures,
13 * etc). When the multicall is actually issued, all the space for the
14 * commands and allocated memory is freed for reuse.
16 * Multicalls are flushed whenever any of the buffers get full, or
17 * when explicitly requested. There's no way to get per-multicall
18 * return results back. It will BUG if any of the multicalls fail.
20 * Jeremy Fitzhardinge <jeremy@xensource.com>, XenSource Inc, 2007
22 #include <linux/percpu.h>
23 #include <linux/hardirq.h>
24 #include <linux/debugfs.h>
26 #include <asm/xen/hypercall.h>
28 #include "multicalls.h"
35 #define MC_ARGS (MC_BATCH * 16)
39 struct multicall_entry entries[MC_BATCH];
41 struct multicall_entry debug[MC_BATCH];
43 unsigned char args[MC_ARGS];
47 } callbacks[MC_BATCH];
48 unsigned mcidx, argidx, cbidx;
51 static DEFINE_PER_CPU(struct mc_buffer, mc_buffer);
52 DEFINE_PER_CPU(unsigned long, xen_mc_irq_flags);
54 /* flush reasons 0- slots, 1- args, 2- callbacks */
64 #ifdef CONFIG_XEN_DEBUG_FS
65 #define NHYPERCALLS 40 /* not really */
68 unsigned histo[MC_BATCH+1];
73 unsigned histo_hypercalls[NHYPERCALLS];
75 unsigned flush[FL_N_REASONS];
80 static inline void check_zero(void)
82 if (unlikely(zero_stats)) {
83 memset(&mc_stats, 0, sizeof(mc_stats));
88 static void mc_add_stats(const struct mc_buffer *mc)
95 mc_stats.hypercalls += mc->mcidx;
96 mc_stats.arg_total += mc->argidx;
98 mc_stats.histo[mc->mcidx]++;
99 for(i = 0; i < mc->mcidx; i++) {
100 unsigned op = mc->entries[i].op;
101 if (op < NHYPERCALLS)
102 mc_stats.histo_hypercalls[op]++;
106 static void mc_stats_flush(enum flush_reasons idx)
110 mc_stats.flush[idx]++;
113 #else /* !CONFIG_XEN_DEBUG_FS */
115 static inline void mc_add_stats(const struct mc_buffer *mc)
119 static inline void mc_stats_flush(enum flush_reasons idx)
122 #endif /* CONFIG_XEN_DEBUG_FS */
124 void xen_mc_flush(void)
126 struct mc_buffer *b = &__get_cpu_var(mc_buffer);
131 BUG_ON(preemptible());
133 /* Disable interrupts in case someone comes in and queues
134 something in the middle */
135 local_irq_save(flags);
141 memcpy(b->debug, b->entries,
142 b->mcidx * sizeof(struct multicall_entry));
145 if (HYPERVISOR_multicall(b->entries, b->mcidx) != 0)
147 for (i = 0; i < b->mcidx; i++)
148 if (b->entries[i].result < 0)
153 printk(KERN_ERR "%d multicall(s) failed: cpu %d\n",
154 ret, smp_processor_id());
156 for (i = 0; i < b->mcidx; i++) {
157 printk(KERN_DEBUG " call %2d/%d: op=%lu arg=[%lx] result=%ld\n",
161 b->entries[i].result);
169 BUG_ON(b->argidx != 0);
171 local_irq_restore(flags);
173 for (i = 0; i < b->cbidx; i++) {
174 struct callback *cb = &b->callbacks[i];
183 struct multicall_space __xen_mc_entry(size_t args)
185 struct mc_buffer *b = &__get_cpu_var(mc_buffer);
186 struct multicall_space ret;
187 unsigned argidx = roundup(b->argidx, sizeof(u64));
189 BUG_ON(preemptible());
190 BUG_ON(b->argidx > MC_ARGS);
192 if (b->mcidx == MC_BATCH ||
193 (argidx + args) > MC_ARGS) {
194 mc_stats_flush(b->mcidx == MC_BATCH ? FL_SLOTS : FL_ARGS);
196 argidx = roundup(b->argidx, sizeof(u64));
199 ret.mc = &b->entries[b->mcidx];
201 ret.args = &b->args[argidx];
202 b->argidx = argidx + args;
204 BUG_ON(b->argidx > MC_ARGS);
208 struct multicall_space xen_mc_extend_args(unsigned long op, size_t size)
210 struct mc_buffer *b = &__get_cpu_var(mc_buffer);
211 struct multicall_space ret = { NULL, NULL };
213 BUG_ON(preemptible());
214 BUG_ON(b->argidx > MC_ARGS);
219 if (b->entries[b->mcidx - 1].op != op)
222 if ((b->argidx + size) > MC_ARGS)
225 ret.mc = &b->entries[b->mcidx - 1];
226 ret.args = &b->args[b->argidx];
229 BUG_ON(b->argidx > MC_ARGS);
233 void xen_mc_callback(void (*fn)(void *), void *data)
235 struct mc_buffer *b = &__get_cpu_var(mc_buffer);
238 if (b->cbidx == MC_BATCH) {
239 mc_stats_flush(FL_CALLBACKS);
243 cb = &b->callbacks[b->cbidx++];
248 #ifdef CONFIG_XEN_DEBUG_FS
250 static struct dentry *d_mc_debug;
252 static int __init xen_mc_debugfs(void)
254 struct dentry *d_xen = xen_init_debugfs();
259 d_mc_debug = debugfs_create_dir("multicalls", d_xen);
261 debugfs_create_u8("zero_stats", 0644, d_mc_debug, &zero_stats);
263 debugfs_create_u32("batches", 0444, d_mc_debug, &mc_stats.issued);
264 debugfs_create_u32("hypercalls", 0444, d_mc_debug, &mc_stats.hypercalls);
265 debugfs_create_u32("arg_total", 0444, d_mc_debug, &mc_stats.arg_total);
267 xen_debugfs_create_u32_array("batch_histo", 0444, d_mc_debug,
268 mc_stats.histo, MC_BATCH);
269 xen_debugfs_create_u32_array("hypercall_histo", 0444, d_mc_debug,
270 mc_stats.histo_hypercalls, NHYPERCALLS);
271 xen_debugfs_create_u32_array("flush_reasons", 0444, d_mc_debug,
272 mc_stats.flush, FL_N_REASONS);
276 fs_initcall(xen_mc_debugfs);
278 #endif /* CONFIG_XEN_DEBUG_FS */