xfrm: fix fragmentation on inter family tunnels
[linux-2.6.git] / Documentation / kprobes.txt
1 Title   : Kernel Probes (Kprobes)
2 Authors : Jim Keniston <jkenisto@us.ibm.com>
3         : Prasanna S Panchamukhi <prasanna@in.ibm.com>
4
5 CONTENTS
6
7 1. Concepts: Kprobes, Jprobes, Return Probes
8 2. Architectures Supported
9 3. Configuring Kprobes
10 4. API Reference
11 5. Kprobes Features and Limitations
12 6. Probe Overhead
13 7. TODO
14 8. Kprobes Example
15 9. Jprobes Example
16 10. Kretprobes Example
17 Appendix A: The kprobes debugfs interface
18
19 1. Concepts: Kprobes, Jprobes, Return Probes
20
21 Kprobes enables you to dynamically break into any kernel routine and
22 collect debugging and performance information non-disruptively. You
23 can trap at almost any kernel code address, specifying a handler
24 routine to be invoked when the breakpoint is hit.
25
26 There are currently three types of probes: kprobes, jprobes, and
27 kretprobes (also called return probes).  A kprobe can be inserted
28 on virtually any instruction in the kernel.  A jprobe is inserted at
29 the entry to a kernel function, and provides convenient access to the
30 function's arguments.  A return probe fires when a specified function
31 returns.
32
33 In the typical case, Kprobes-based instrumentation is packaged as
34 a kernel module.  The module's init function installs ("registers")
35 one or more probes, and the exit function unregisters them.  A
36 registration function such as register_kprobe() specifies where
37 the probe is to be inserted and what handler is to be called when
38 the probe is hit.
39
40 There are also register_/unregister_*probes() functions for batch
41 registration/unregistration of a group of *probes. These functions
42 can speed up unregistration process when you have to unregister
43 a lot of probes at once.
44
45 The next three subsections explain how the different types of
46 probes work.  They explain certain things that you'll need to
47 know in order to make the best use of Kprobes -- e.g., the
48 difference between a pre_handler and a post_handler, and how
49 to use the maxactive and nmissed fields of a kretprobe.  But
50 if you're in a hurry to start using Kprobes, you can skip ahead
51 to section 2.
52
53 1.1 How Does a Kprobe Work?
54
55 When a kprobe is registered, Kprobes makes a copy of the probed
56 instruction and replaces the first byte(s) of the probed instruction
57 with a breakpoint instruction (e.g., int3 on i386 and x86_64).
58
59 When a CPU hits the breakpoint instruction, a trap occurs, the CPU's
60 registers are saved, and control passes to Kprobes via the
61 notifier_call_chain mechanism.  Kprobes executes the "pre_handler"
62 associated with the kprobe, passing the handler the addresses of the
63 kprobe struct and the saved registers.
64
65 Next, Kprobes single-steps its copy of the probed instruction.
66 (It would be simpler to single-step the actual instruction in place,
67 but then Kprobes would have to temporarily remove the breakpoint
68 instruction.  This would open a small time window when another CPU
69 could sail right past the probepoint.)
70
71 After the instruction is single-stepped, Kprobes executes the
72 "post_handler," if any, that is associated with the kprobe.
73 Execution then continues with the instruction following the probepoint.
74
75 1.2 How Does a Jprobe Work?
76
77 A jprobe is implemented using a kprobe that is placed on a function's
78 entry point.  It employs a simple mirroring principle to allow
79 seamless access to the probed function's arguments.  The jprobe
80 handler routine should have the same signature (arg list and return
81 type) as the function being probed, and must always end by calling
82 the Kprobes function jprobe_return().
83
84 Here's how it works.  When the probe is hit, Kprobes makes a copy of
85 the saved registers and a generous portion of the stack (see below).
86 Kprobes then points the saved instruction pointer at the jprobe's
87 handler routine, and returns from the trap.  As a result, control
88 passes to the handler, which is presented with the same register and
89 stack contents as the probed function.  When it is done, the handler
90 calls jprobe_return(), which traps again to restore the original stack
91 contents and processor state and switch to the probed function.
92
93 By convention, the callee owns its arguments, so gcc may produce code
94 that unexpectedly modifies that portion of the stack.  This is why
95 Kprobes saves a copy of the stack and restores it after the jprobe
96 handler has run.  Up to MAX_STACK_SIZE bytes are copied -- e.g.,
97 64 bytes on i386.
98
99 Note that the probed function's args may be passed on the stack
100 or in registers.  The jprobe will work in either case, so long as the
101 handler's prototype matches that of the probed function.
102
103 1.3 Return Probes
104
105 1.3.1 How Does a Return Probe Work?
106
107 When you call register_kretprobe(), Kprobes establishes a kprobe at
108 the entry to the function.  When the probed function is called and this
109 probe is hit, Kprobes saves a copy of the return address, and replaces
110 the return address with the address of a "trampoline."  The trampoline
111 is an arbitrary piece of code -- typically just a nop instruction.
112 At boot time, Kprobes registers a kprobe at the trampoline.
113
114 When the probed function executes its return instruction, control
115 passes to the trampoline and that probe is hit.  Kprobes' trampoline
116 handler calls the user-specified return handler associated with the
117 kretprobe, then sets the saved instruction pointer to the saved return
118 address, and that's where execution resumes upon return from the trap.
119
120 While the probed function is executing, its return address is
121 stored in an object of type kretprobe_instance.  Before calling
122 register_kretprobe(), the user sets the maxactive field of the
123 kretprobe struct to specify how many instances of the specified
124 function can be probed simultaneously.  register_kretprobe()
125 pre-allocates the indicated number of kretprobe_instance objects.
126
127 For example, if the function is non-recursive and is called with a
128 spinlock held, maxactive = 1 should be enough.  If the function is
129 non-recursive and can never relinquish the CPU (e.g., via a semaphore
130 or preemption), NR_CPUS should be enough.  If maxactive <= 0, it is
131 set to a default value.  If CONFIG_PREEMPT is enabled, the default
132 is max(10, 2*NR_CPUS).  Otherwise, the default is NR_CPUS.
133
134 It's not a disaster if you set maxactive too low; you'll just miss
135 some probes.  In the kretprobe struct, the nmissed field is set to
136 zero when the return probe is registered, and is incremented every
137 time the probed function is entered but there is no kretprobe_instance
138 object available for establishing the return probe.
139
140 1.3.2 Kretprobe entry-handler
141
142 Kretprobes also provides an optional user-specified handler which runs
143 on function entry. This handler is specified by setting the entry_handler
144 field of the kretprobe struct. Whenever the kprobe placed by kretprobe at the
145 function entry is hit, the user-defined entry_handler, if any, is invoked.
146 If the entry_handler returns 0 (success) then a corresponding return handler
147 is guaranteed to be called upon function return. If the entry_handler
148 returns a non-zero error then Kprobes leaves the return address as is, and
149 the kretprobe has no further effect for that particular function instance.
150
151 Multiple entry and return handler invocations are matched using the unique
152 kretprobe_instance object associated with them. Additionally, a user
153 may also specify per return-instance private data to be part of each
154 kretprobe_instance object. This is especially useful when sharing private
155 data between corresponding user entry and return handlers. The size of each
156 private data object can be specified at kretprobe registration time by
157 setting the data_size field of the kretprobe struct. This data can be
158 accessed through the data field of each kretprobe_instance object.
159
160 In case probed function is entered but there is no kretprobe_instance
161 object available, then in addition to incrementing the nmissed count,
162 the user entry_handler invocation is also skipped.
163
164 2. Architectures Supported
165
166 Kprobes, jprobes, and return probes are implemented on the following
167 architectures:
168
169 - i386
170 - x86_64 (AMD-64, EM64T)
171 - ppc64
172 - ia64 (Does not support probes on instruction slot1.)
173 - sparc64 (Return probes not yet implemented.)
174 - arm
175 - ppc
176
177 3. Configuring Kprobes
178
179 When configuring the kernel using make menuconfig/xconfig/oldconfig,
180 ensure that CONFIG_KPROBES is set to "y".  Under "Instrumentation
181 Support", look for "Kprobes".
182
183 So that you can load and unload Kprobes-based instrumentation modules,
184 make sure "Loadable module support" (CONFIG_MODULES) and "Module
185 unloading" (CONFIG_MODULE_UNLOAD) are set to "y".
186
187 Also make sure that CONFIG_KALLSYMS and perhaps even CONFIG_KALLSYMS_ALL
188 are set to "y", since kallsyms_lookup_name() is used by the in-kernel
189 kprobe address resolution code.
190
191 If you need to insert a probe in the middle of a function, you may find
192 it useful to "Compile the kernel with debug info" (CONFIG_DEBUG_INFO),
193 so you can use "objdump -d -l vmlinux" to see the source-to-object
194 code mapping.
195
196 4. API Reference
197
198 The Kprobes API includes a "register" function and an "unregister"
199 function for each type of probe. The API also includes "register_*probes"
200 and "unregister_*probes" functions for (un)registering arrays of probes.
201 Here are terse, mini-man-page specifications for these functions and
202 the associated probe handlers that you'll write. See the files in the
203 samples/kprobes/ sub-directory for examples.
204
205 4.1 register_kprobe
206
207 #include <linux/kprobes.h>
208 int register_kprobe(struct kprobe *kp);
209
210 Sets a breakpoint at the address kp->addr.  When the breakpoint is
211 hit, Kprobes calls kp->pre_handler.  After the probed instruction
212 is single-stepped, Kprobe calls kp->post_handler.  If a fault
213 occurs during execution of kp->pre_handler or kp->post_handler,
214 or during single-stepping of the probed instruction, Kprobes calls
215 kp->fault_handler.  Any or all handlers can be NULL.
216
217 NOTE:
218 1. With the introduction of the "symbol_name" field to struct kprobe,
219 the probepoint address resolution will now be taken care of by the kernel.
220 The following will now work:
221
222         kp.symbol_name = "symbol_name";
223
224 (64-bit powerpc intricacies such as function descriptors are handled
225 transparently)
226
227 2. Use the "offset" field of struct kprobe if the offset into the symbol
228 to install a probepoint is known. This field is used to calculate the
229 probepoint.
230
231 3. Specify either the kprobe "symbol_name" OR the "addr". If both are
232 specified, kprobe registration will fail with -EINVAL.
233
234 4. With CISC architectures (such as i386 and x86_64), the kprobes code
235 does not validate if the kprobe.addr is at an instruction boundary.
236 Use "offset" with caution.
237
238 register_kprobe() returns 0 on success, or a negative errno otherwise.
239
240 User's pre-handler (kp->pre_handler):
241 #include <linux/kprobes.h>
242 #include <linux/ptrace.h>
243 int pre_handler(struct kprobe *p, struct pt_regs *regs);
244
245 Called with p pointing to the kprobe associated with the breakpoint,
246 and regs pointing to the struct containing the registers saved when
247 the breakpoint was hit.  Return 0 here unless you're a Kprobes geek.
248
249 User's post-handler (kp->post_handler):
250 #include <linux/kprobes.h>
251 #include <linux/ptrace.h>
252 void post_handler(struct kprobe *p, struct pt_regs *regs,
253         unsigned long flags);
254
255 p and regs are as described for the pre_handler.  flags always seems
256 to be zero.
257
258 User's fault-handler (kp->fault_handler):
259 #include <linux/kprobes.h>
260 #include <linux/ptrace.h>
261 int fault_handler(struct kprobe *p, struct pt_regs *regs, int trapnr);
262
263 p and regs are as described for the pre_handler.  trapnr is the
264 architecture-specific trap number associated with the fault (e.g.,
265 on i386, 13 for a general protection fault or 14 for a page fault).
266 Returns 1 if it successfully handled the exception.
267
268 4.2 register_jprobe
269
270 #include <linux/kprobes.h>
271 int register_jprobe(struct jprobe *jp)
272
273 Sets a breakpoint at the address jp->kp.addr, which must be the address
274 of the first instruction of a function.  When the breakpoint is hit,
275 Kprobes runs the handler whose address is jp->entry.
276
277 The handler should have the same arg list and return type as the probed
278 function; and just before it returns, it must call jprobe_return().
279 (The handler never actually returns, since jprobe_return() returns
280 control to Kprobes.)  If the probed function is declared asmlinkage
281 or anything else that affects how args are passed, the handler's
282 declaration must match.
283
284 register_jprobe() returns 0 on success, or a negative errno otherwise.
285
286 4.3 register_kretprobe
287
288 #include <linux/kprobes.h>
289 int register_kretprobe(struct kretprobe *rp);
290
291 Establishes a return probe for the function whose address is
292 rp->kp.addr.  When that function returns, Kprobes calls rp->handler.
293 You must set rp->maxactive appropriately before you call
294 register_kretprobe(); see "How Does a Return Probe Work?" for details.
295
296 register_kretprobe() returns 0 on success, or a negative errno
297 otherwise.
298
299 User's return-probe handler (rp->handler):
300 #include <linux/kprobes.h>
301 #include <linux/ptrace.h>
302 int kretprobe_handler(struct kretprobe_instance *ri, struct pt_regs *regs);
303
304 regs is as described for kprobe.pre_handler.  ri points to the
305 kretprobe_instance object, of which the following fields may be
306 of interest:
307 - ret_addr: the return address
308 - rp: points to the corresponding kretprobe object
309 - task: points to the corresponding task struct
310 - data: points to per return-instance private data; see "Kretprobe
311         entry-handler" for details.
312
313 The regs_return_value(regs) macro provides a simple abstraction to
314 extract the return value from the appropriate register as defined by
315 the architecture's ABI.
316
317 The handler's return value is currently ignored.
318
319 4.4 unregister_*probe
320
321 #include <linux/kprobes.h>
322 void unregister_kprobe(struct kprobe *kp);
323 void unregister_jprobe(struct jprobe *jp);
324 void unregister_kretprobe(struct kretprobe *rp);
325
326 Removes the specified probe.  The unregister function can be called
327 at any time after the probe has been registered.
328
329 NOTE:
330 If the functions find an incorrect probe (ex. an unregistered probe),
331 they clear the addr field of the probe.
332
333 4.5 register_*probes
334
335 #include <linux/kprobes.h>
336 int register_kprobes(struct kprobe **kps, int num);
337 int register_kretprobes(struct kretprobe **rps, int num);
338 int register_jprobes(struct jprobe **jps, int num);
339
340 Registers each of the num probes in the specified array.  If any
341 error occurs during registration, all probes in the array, up to
342 the bad probe, are safely unregistered before the register_*probes
343 function returns.
344 - kps/rps/jps: an array of pointers to *probe data structures
345 - num: the number of the array entries.
346
347 NOTE:
348 You have to allocate(or define) an array of pointers and set all
349 of the array entries before using these functions.
350
351 4.6 unregister_*probes
352
353 #include <linux/kprobes.h>
354 void unregister_kprobes(struct kprobe **kps, int num);
355 void unregister_kretprobes(struct kretprobe **rps, int num);
356 void unregister_jprobes(struct jprobe **jps, int num);
357
358 Removes each of the num probes in the specified array at once.
359
360 NOTE:
361 If the functions find some incorrect probes (ex. unregistered
362 probes) in the specified array, they clear the addr field of those
363 incorrect probes. However, other probes in the array are
364 unregistered correctly.
365
366 5. Kprobes Features and Limitations
367
368 Kprobes allows multiple probes at the same address.  Currently,
369 however, there cannot be multiple jprobes on the same function at
370 the same time.
371
372 In general, you can install a probe anywhere in the kernel.
373 In particular, you can probe interrupt handlers.  Known exceptions
374 are discussed in this section.
375
376 The register_*probe functions will return -EINVAL if you attempt
377 to install a probe in the code that implements Kprobes (mostly
378 kernel/kprobes.c and arch/*/kernel/kprobes.c, but also functions such
379 as do_page_fault and notifier_call_chain).
380
381 If you install a probe in an inline-able function, Kprobes makes
382 no attempt to chase down all inline instances of the function and
383 install probes there.  gcc may inline a function without being asked,
384 so keep this in mind if you're not seeing the probe hits you expect.
385
386 A probe handler can modify the environment of the probed function
387 -- e.g., by modifying kernel data structures, or by modifying the
388 contents of the pt_regs struct (which are restored to the registers
389 upon return from the breakpoint).  So Kprobes can be used, for example,
390 to install a bug fix or to inject faults for testing.  Kprobes, of
391 course, has no way to distinguish the deliberately injected faults
392 from the accidental ones.  Don't drink and probe.
393
394 Kprobes makes no attempt to prevent probe handlers from stepping on
395 each other -- e.g., probing printk() and then calling printk() from a
396 probe handler.  If a probe handler hits a probe, that second probe's
397 handlers won't be run in that instance, and the kprobe.nmissed member
398 of the second probe will be incremented.
399
400 As of Linux v2.6.15-rc1, multiple handlers (or multiple instances of
401 the same handler) may run concurrently on different CPUs.
402
403 Kprobes does not use mutexes or allocate memory except during
404 registration and unregistration.
405
406 Probe handlers are run with preemption disabled.  Depending on the
407 architecture, handlers may also run with interrupts disabled.  In any
408 case, your handler should not yield the CPU (e.g., by attempting to
409 acquire a semaphore).
410
411 Since a return probe is implemented by replacing the return
412 address with the trampoline's address, stack backtraces and calls
413 to __builtin_return_address() will typically yield the trampoline's
414 address instead of the real return address for kretprobed functions.
415 (As far as we can tell, __builtin_return_address() is used only
416 for instrumentation and error reporting.)
417
418 If the number of times a function is called does not match the number
419 of times it returns, registering a return probe on that function may
420 produce undesirable results. In such a case, a line:
421 kretprobe BUG!: Processing kretprobe d000000000041aa8 @ c00000000004f48c
422 gets printed. With this information, one will be able to correlate the
423 exact instance of the kretprobe that caused the problem. We have the
424 do_exit() case covered. do_execve() and do_fork() are not an issue.
425 We're unaware of other specific cases where this could be a problem.
426
427 If, upon entry to or exit from a function, the CPU is running on
428 a stack other than that of the current task, registering a return
429 probe on that function may produce undesirable results.  For this
430 reason, Kprobes doesn't support return probes (or kprobes or jprobes)
431 on the x86_64 version of __switch_to(); the registration functions
432 return -EINVAL.
433
434 6. Probe Overhead
435
436 On a typical CPU in use in 2005, a kprobe hit takes 0.5 to 1.0
437 microseconds to process.  Specifically, a benchmark that hits the same
438 probepoint repeatedly, firing a simple handler each time, reports 1-2
439 million hits per second, depending on the architecture.  A jprobe or
440 return-probe hit typically takes 50-75% longer than a kprobe hit.
441 When you have a return probe set on a function, adding a kprobe at
442 the entry to that function adds essentially no overhead.
443
444 Here are sample overhead figures (in usec) for different architectures.
445 k = kprobe; j = jprobe; r = return probe; kr = kprobe + return probe
446 on same function; jr = jprobe + return probe on same function
447
448 i386: Intel Pentium M, 1495 MHz, 2957.31 bogomips
449 k = 0.57 usec; j = 1.00; r = 0.92; kr = 0.99; jr = 1.40
450
451 x86_64: AMD Opteron 246, 1994 MHz, 3971.48 bogomips
452 k = 0.49 usec; j = 0.76; r = 0.80; kr = 0.82; jr = 1.07
453
454 ppc64: POWER5 (gr), 1656 MHz (SMT disabled, 1 virtual CPU per physical CPU)
455 k = 0.77 usec; j = 1.31; r = 1.26; kr = 1.45; jr = 1.99
456
457 7. TODO
458
459 a. SystemTap (http://sourceware.org/systemtap): Provides a simplified
460 programming interface for probe-based instrumentation.  Try it out.
461 b. Kernel return probes for sparc64.
462 c. Support for other architectures.
463 d. User-space probes.
464 e. Watchpoint probes (which fire on data references).
465
466 8. Kprobes Example
467
468 See samples/kprobes/kprobe_example.c
469
470 9. Jprobes Example
471
472 See samples/kprobes/jprobe_example.c
473
474 10. Kretprobes Example
475
476 See samples/kprobes/kretprobe_example.c
477
478 For additional information on Kprobes, refer to the following URLs:
479 http://www-106.ibm.com/developerworks/library/l-kprobes.html?ca=dgr-lnxw42Kprobe
480 http://www.redhat.com/magazine/005mar05/features/kprobes/
481 http://www-users.cs.umn.edu/~boutcher/kprobes/
482 http://www.linuxsymposium.org/2006/linuxsymposium_procv2.pdf (pages 101-115)
483
484
485 Appendix A: The kprobes debugfs interface
486
487 With recent kernels (> 2.6.20) the list of registered kprobes is visible
488 under the /debug/kprobes/ directory (assuming debugfs is mounted at /debug).
489
490 /debug/kprobes/list: Lists all registered probes on the system
491
492 c015d71a  k  vfs_read+0x0
493 c011a316  j  do_fork+0x0
494 c03dedc5  r  tcp_v4_rcv+0x0
495
496 The first column provides the kernel address where the probe is inserted.
497 The second column identifies the type of probe (k - kprobe, r - kretprobe
498 and j - jprobe), while the third column specifies the symbol+offset of
499 the probe. If the probed function belongs to a module, the module name
500 is also specified. Following columns show probe status. If the probe is on
501 a virtual address that is no longer valid (module init sections, module
502 virtual addresses that correspond to modules that've been unloaded),
503 such probes are marked with [GONE].
504
505 /debug/kprobes/enabled: Turn kprobes ON/OFF
506
507 Provides a knob to globally turn registered kprobes ON or OFF. By default,
508 all kprobes are enabled. By echoing "0" to this file, all registered probes
509 will be disarmed, till such time a "1" is echoed to this file.