ipc: do not recompute msgmni anymore if explicitly set by user
[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
176 3. Configuring Kprobes
177
178 When configuring the kernel using make menuconfig/xconfig/oldconfig,
179 ensure that CONFIG_KPROBES is set to "y".  Under "Instrumentation
180 Support", look for "Kprobes".
181
182 So that you can load and unload Kprobes-based instrumentation modules,
183 make sure "Loadable module support" (CONFIG_MODULES) and "Module
184 unloading" (CONFIG_MODULE_UNLOAD) are set to "y".
185
186 Also make sure that CONFIG_KALLSYMS and perhaps even CONFIG_KALLSYMS_ALL
187 are set to "y", since kallsyms_lookup_name() is used by the in-kernel
188 kprobe address resolution code.
189
190 If you need to insert a probe in the middle of a function, you may find
191 it useful to "Compile the kernel with debug info" (CONFIG_DEBUG_INFO),
192 so you can use "objdump -d -l vmlinux" to see the source-to-object
193 code mapping.
194
195 4. API Reference
196
197 The Kprobes API includes a "register" function and an "unregister"
198 function for each type of probe. The API also includes "register_*probes"
199 and "unregister_*probes" functions for (un)registering arrays of probes.
200 Here are terse, mini-man-page specifications for these functions and
201 the associated probe handlers that you'll write. See the files in the
202 samples/kprobes/ sub-directory for examples.
203
204 4.1 register_kprobe
205
206 #include <linux/kprobes.h>
207 int register_kprobe(struct kprobe *kp);
208
209 Sets a breakpoint at the address kp->addr.  When the breakpoint is
210 hit, Kprobes calls kp->pre_handler.  After the probed instruction
211 is single-stepped, Kprobe calls kp->post_handler.  If a fault
212 occurs during execution of kp->pre_handler or kp->post_handler,
213 or during single-stepping of the probed instruction, Kprobes calls
214 kp->fault_handler.  Any or all handlers can be NULL.
215
216 NOTE:
217 1. With the introduction of the "symbol_name" field to struct kprobe,
218 the probepoint address resolution will now be taken care of by the kernel.
219 The following will now work:
220
221         kp.symbol_name = "symbol_name";
222
223 (64-bit powerpc intricacies such as function descriptors are handled
224 transparently)
225
226 2. Use the "offset" field of struct kprobe if the offset into the symbol
227 to install a probepoint is known. This field is used to calculate the
228 probepoint.
229
230 3. Specify either the kprobe "symbol_name" OR the "addr". If both are
231 specified, kprobe registration will fail with -EINVAL.
232
233 4. With CISC architectures (such as i386 and x86_64), the kprobes code
234 does not validate if the kprobe.addr is at an instruction boundary.
235 Use "offset" with caution.
236
237 register_kprobe() returns 0 on success, or a negative errno otherwise.
238
239 User's pre-handler (kp->pre_handler):
240 #include <linux/kprobes.h>
241 #include <linux/ptrace.h>
242 int pre_handler(struct kprobe *p, struct pt_regs *regs);
243
244 Called with p pointing to the kprobe associated with the breakpoint,
245 and regs pointing to the struct containing the registers saved when
246 the breakpoint was hit.  Return 0 here unless you're a Kprobes geek.
247
248 User's post-handler (kp->post_handler):
249 #include <linux/kprobes.h>
250 #include <linux/ptrace.h>
251 void post_handler(struct kprobe *p, struct pt_regs *regs,
252         unsigned long flags);
253
254 p and regs are as described for the pre_handler.  flags always seems
255 to be zero.
256
257 User's fault-handler (kp->fault_handler):
258 #include <linux/kprobes.h>
259 #include <linux/ptrace.h>
260 int fault_handler(struct kprobe *p, struct pt_regs *regs, int trapnr);
261
262 p and regs are as described for the pre_handler.  trapnr is the
263 architecture-specific trap number associated with the fault (e.g.,
264 on i386, 13 for a general protection fault or 14 for a page fault).
265 Returns 1 if it successfully handled the exception.
266
267 4.2 register_jprobe
268
269 #include <linux/kprobes.h>
270 int register_jprobe(struct jprobe *jp)
271
272 Sets a breakpoint at the address jp->kp.addr, which must be the address
273 of the first instruction of a function.  When the breakpoint is hit,
274 Kprobes runs the handler whose address is jp->entry.
275
276 The handler should have the same arg list and return type as the probed
277 function; and just before it returns, it must call jprobe_return().
278 (The handler never actually returns, since jprobe_return() returns
279 control to Kprobes.)  If the probed function is declared asmlinkage
280 or anything else that affects how args are passed, the handler's
281 declaration must match.
282
283 register_jprobe() returns 0 on success, or a negative errno otherwise.
284
285 4.3 register_kretprobe
286
287 #include <linux/kprobes.h>
288 int register_kretprobe(struct kretprobe *rp);
289
290 Establishes a return probe for the function whose address is
291 rp->kp.addr.  When that function returns, Kprobes calls rp->handler.
292 You must set rp->maxactive appropriately before you call
293 register_kretprobe(); see "How Does a Return Probe Work?" for details.
294
295 register_kretprobe() returns 0 on success, or a negative errno
296 otherwise.
297
298 User's return-probe handler (rp->handler):
299 #include <linux/kprobes.h>
300 #include <linux/ptrace.h>
301 int kretprobe_handler(struct kretprobe_instance *ri, struct pt_regs *regs);
302
303 regs is as described for kprobe.pre_handler.  ri points to the
304 kretprobe_instance object, of which the following fields may be
305 of interest:
306 - ret_addr: the return address
307 - rp: points to the corresponding kretprobe object
308 - task: points to the corresponding task struct
309 - data: points to per return-instance private data; see "Kretprobe
310         entry-handler" for details.
311
312 The regs_return_value(regs) macro provides a simple abstraction to
313 extract the return value from the appropriate register as defined by
314 the architecture's ABI.
315
316 The handler's return value is currently ignored.
317
318 4.4 unregister_*probe
319
320 #include <linux/kprobes.h>
321 void unregister_kprobe(struct kprobe *kp);
322 void unregister_jprobe(struct jprobe *jp);
323 void unregister_kretprobe(struct kretprobe *rp);
324
325 Removes the specified probe.  The unregister function can be called
326 at any time after the probe has been registered.
327
328 NOTE:
329 If the functions find an incorrect probe (ex. an unregistered probe),
330 they clear the addr field of the probe.
331
332 4.5 register_*probes
333
334 #include <linux/kprobes.h>
335 int register_kprobes(struct kprobe **kps, int num);
336 int register_kretprobes(struct kretprobe **rps, int num);
337 int register_jprobes(struct jprobe **jps, int num);
338
339 Registers each of the num probes in the specified array.  If any
340 error occurs during registration, all probes in the array, up to
341 the bad probe, are safely unregistered before the register_*probes
342 function returns.
343 - kps/rps/jps: an array of pointers to *probe data structures
344 - num: the number of the array entries.
345
346 NOTE:
347 You have to allocate(or define) an array of pointers and set all
348 of the array entries before using these functions.
349
350 4.6 unregister_*probes
351
352 #include <linux/kprobes.h>
353 void unregister_kprobes(struct kprobe **kps, int num);
354 void unregister_kretprobes(struct kretprobe **rps, int num);
355 void unregister_jprobes(struct jprobe **jps, int num);
356
357 Removes each of the num probes in the specified array at once.
358
359 NOTE:
360 If the functions find some incorrect probes (ex. unregistered
361 probes) in the specified array, they clear the addr field of those
362 incorrect probes. However, other probes in the array are
363 unregistered correctly.
364
365 5. Kprobes Features and Limitations
366
367 Kprobes allows multiple probes at the same address.  Currently,
368 however, there cannot be multiple jprobes on the same function at
369 the same time.
370
371 In general, you can install a probe anywhere in the kernel.
372 In particular, you can probe interrupt handlers.  Known exceptions
373 are discussed in this section.
374
375 The register_*probe functions will return -EINVAL if you attempt
376 to install a probe in the code that implements Kprobes (mostly
377 kernel/kprobes.c and arch/*/kernel/kprobes.c, but also functions such
378 as do_page_fault and notifier_call_chain).
379
380 If you install a probe in an inline-able function, Kprobes makes
381 no attempt to chase down all inline instances of the function and
382 install probes there.  gcc may inline a function without being asked,
383 so keep this in mind if you're not seeing the probe hits you expect.
384
385 A probe handler can modify the environment of the probed function
386 -- e.g., by modifying kernel data structures, or by modifying the
387 contents of the pt_regs struct (which are restored to the registers
388 upon return from the breakpoint).  So Kprobes can be used, for example,
389 to install a bug fix or to inject faults for testing.  Kprobes, of
390 course, has no way to distinguish the deliberately injected faults
391 from the accidental ones.  Don't drink and probe.
392
393 Kprobes makes no attempt to prevent probe handlers from stepping on
394 each other -- e.g., probing printk() and then calling printk() from a
395 probe handler.  If a probe handler hits a probe, that second probe's
396 handlers won't be run in that instance, and the kprobe.nmissed member
397 of the second probe will be incremented.
398
399 As of Linux v2.6.15-rc1, multiple handlers (or multiple instances of
400 the same handler) may run concurrently on different CPUs.
401
402 Kprobes does not use mutexes or allocate memory except during
403 registration and unregistration.
404
405 Probe handlers are run with preemption disabled.  Depending on the
406 architecture, handlers may also run with interrupts disabled.  In any
407 case, your handler should not yield the CPU (e.g., by attempting to
408 acquire a semaphore).
409
410 Since a return probe is implemented by replacing the return
411 address with the trampoline's address, stack backtraces and calls
412 to __builtin_return_address() will typically yield the trampoline's
413 address instead of the real return address for kretprobed functions.
414 (As far as we can tell, __builtin_return_address() is used only
415 for instrumentation and error reporting.)
416
417 If the number of times a function is called does not match the number
418 of times it returns, registering a return probe on that function may
419 produce undesirable results. In such a case, a line:
420 kretprobe BUG!: Processing kretprobe d000000000041aa8 @ c00000000004f48c
421 gets printed. With this information, one will be able to correlate the
422 exact instance of the kretprobe that caused the problem. We have the
423 do_exit() case covered. do_execve() and do_fork() are not an issue.
424 We're unaware of other specific cases where this could be a problem.
425
426 If, upon entry to or exit from a function, the CPU is running on
427 a stack other than that of the current task, registering a return
428 probe on that function may produce undesirable results.  For this
429 reason, Kprobes doesn't support return probes (or kprobes or jprobes)
430 on the x86_64 version of __switch_to(); the registration functions
431 return -EINVAL.
432
433 6. Probe Overhead
434
435 On a typical CPU in use in 2005, a kprobe hit takes 0.5 to 1.0
436 microseconds to process.  Specifically, a benchmark that hits the same
437 probepoint repeatedly, firing a simple handler each time, reports 1-2
438 million hits per second, depending on the architecture.  A jprobe or
439 return-probe hit typically takes 50-75% longer than a kprobe hit.
440 When you have a return probe set on a function, adding a kprobe at
441 the entry to that function adds essentially no overhead.
442
443 Here are sample overhead figures (in usec) for different architectures.
444 k = kprobe; j = jprobe; r = return probe; kr = kprobe + return probe
445 on same function; jr = jprobe + return probe on same function
446
447 i386: Intel Pentium M, 1495 MHz, 2957.31 bogomips
448 k = 0.57 usec; j = 1.00; r = 0.92; kr = 0.99; jr = 1.40
449
450 x86_64: AMD Opteron 246, 1994 MHz, 3971.48 bogomips
451 k = 0.49 usec; j = 0.76; r = 0.80; kr = 0.82; jr = 1.07
452
453 ppc64: POWER5 (gr), 1656 MHz (SMT disabled, 1 virtual CPU per physical CPU)
454 k = 0.77 usec; j = 1.31; r = 1.26; kr = 1.45; jr = 1.99
455
456 7. TODO
457
458 a. SystemTap (http://sourceware.org/systemtap): Provides a simplified
459 programming interface for probe-based instrumentation.  Try it out.
460 b. Kernel return probes for sparc64.
461 c. Support for other architectures.
462 d. User-space probes.
463 e. Watchpoint probes (which fire on data references).
464
465 8. Kprobes Example
466
467 See samples/kprobes/kprobe_example.c
468
469 9. Jprobes Example
470
471 See samples/kprobes/jprobe_example.c
472
473 10. Kretprobes Example
474
475 See samples/kprobes/kretprobe_example.c
476
477 For additional information on Kprobes, refer to the following URLs:
478 http://www-106.ibm.com/developerworks/library/l-kprobes.html?ca=dgr-lnxw42Kprobe
479 http://www.redhat.com/magazine/005mar05/features/kprobes/
480 http://www-users.cs.umn.edu/~boutcher/kprobes/
481 http://www.linuxsymposium.org/2006/linuxsymposium_procv2.pdf (pages 101-115)
482
483
484 Appendix A: The kprobes debugfs interface
485
486 With recent kernels (> 2.6.20) the list of registered kprobes is visible
487 under the /debug/kprobes/ directory (assuming debugfs is mounted at /debug).
488
489 /debug/kprobes/list: Lists all registered probes on the system
490
491 c015d71a  k  vfs_read+0x0
492 c011a316  j  do_fork+0x0
493 c03dedc5  r  tcp_v4_rcv+0x0
494
495 The first column provides the kernel address where the probe is inserted.
496 The second column identifies the type of probe (k - kprobe, r - kretprobe
497 and j - jprobe), while the third column specifies the symbol+offset of
498 the probe. If the probed function belongs to a module, the module name
499 is also specified.
500
501 /debug/kprobes/enabled: Turn kprobes ON/OFF
502
503 Provides a knob to globally turn registered kprobes ON or OFF. By default,
504 all kprobes are enabled. By echoing "0" to this file, all registered probes
505 will be disarmed, till such time a "1" is echoed to this file.