remove final fastcall users
[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 The next three subsections explain how the different types of
41 probes work.  They explain certain things that you'll need to
42 know in order to make the best use of Kprobes -- e.g., the
43 difference between a pre_handler and a post_handler, and how
44 to use the maxactive and nmissed fields of a kretprobe.  But
45 if you're in a hurry to start using Kprobes, you can skip ahead
46 to section 2.
47
48 1.1 How Does a Kprobe Work?
49
50 When a kprobe is registered, Kprobes makes a copy of the probed
51 instruction and replaces the first byte(s) of the probed instruction
52 with a breakpoint instruction (e.g., int3 on i386 and x86_64).
53
54 When a CPU hits the breakpoint instruction, a trap occurs, the CPU's
55 registers are saved, and control passes to Kprobes via the
56 notifier_call_chain mechanism.  Kprobes executes the "pre_handler"
57 associated with the kprobe, passing the handler the addresses of the
58 kprobe struct and the saved registers.
59
60 Next, Kprobes single-steps its copy of the probed instruction.
61 (It would be simpler to single-step the actual instruction in place,
62 but then Kprobes would have to temporarily remove the breakpoint
63 instruction.  This would open a small time window when another CPU
64 could sail right past the probepoint.)
65
66 After the instruction is single-stepped, Kprobes executes the
67 "post_handler," if any, that is associated with the kprobe.
68 Execution then continues with the instruction following the probepoint.
69
70 1.2 How Does a Jprobe Work?
71
72 A jprobe is implemented using a kprobe that is placed on a function's
73 entry point.  It employs a simple mirroring principle to allow
74 seamless access to the probed function's arguments.  The jprobe
75 handler routine should have the same signature (arg list and return
76 type) as the function being probed, and must always end by calling
77 the Kprobes function jprobe_return().
78
79 Here's how it works.  When the probe is hit, Kprobes makes a copy of
80 the saved registers and a generous portion of the stack (see below).
81 Kprobes then points the saved instruction pointer at the jprobe's
82 handler routine, and returns from the trap.  As a result, control
83 passes to the handler, which is presented with the same register and
84 stack contents as the probed function.  When it is done, the handler
85 calls jprobe_return(), which traps again to restore the original stack
86 contents and processor state and switch to the probed function.
87
88 By convention, the callee owns its arguments, so gcc may produce code
89 that unexpectedly modifies that portion of the stack.  This is why
90 Kprobes saves a copy of the stack and restores it after the jprobe
91 handler has run.  Up to MAX_STACK_SIZE bytes are copied -- e.g.,
92 64 bytes on i386.
93
94 Note that the probed function's args may be passed on the stack
95 or in registers.  The jprobe will work in either case, so long as the
96 handler's prototype matches that of the probed function.
97
98 1.3 Return Probes
99
100 1.3.1 How Does a Return Probe Work?
101
102 When you call register_kretprobe(), Kprobes establishes a kprobe at
103 the entry to the function.  When the probed function is called and this
104 probe is hit, Kprobes saves a copy of the return address, and replaces
105 the return address with the address of a "trampoline."  The trampoline
106 is an arbitrary piece of code -- typically just a nop instruction.
107 At boot time, Kprobes registers a kprobe at the trampoline.
108
109 When the probed function executes its return instruction, control
110 passes to the trampoline and that probe is hit.  Kprobes' trampoline
111 handler calls the user-specified return handler associated with the
112 kretprobe, then sets the saved instruction pointer to the saved return
113 address, and that's where execution resumes upon return from the trap.
114
115 While the probed function is executing, its return address is
116 stored in an object of type kretprobe_instance.  Before calling
117 register_kretprobe(), the user sets the maxactive field of the
118 kretprobe struct to specify how many instances of the specified
119 function can be probed simultaneously.  register_kretprobe()
120 pre-allocates the indicated number of kretprobe_instance objects.
121
122 For example, if the function is non-recursive and is called with a
123 spinlock held, maxactive = 1 should be enough.  If the function is
124 non-recursive and can never relinquish the CPU (e.g., via a semaphore
125 or preemption), NR_CPUS should be enough.  If maxactive <= 0, it is
126 set to a default value.  If CONFIG_PREEMPT is enabled, the default
127 is max(10, 2*NR_CPUS).  Otherwise, the default is NR_CPUS.
128
129 It's not a disaster if you set maxactive too low; you'll just miss
130 some probes.  In the kretprobe struct, the nmissed field is set to
131 zero when the return probe is registered, and is incremented every
132 time the probed function is entered but there is no kretprobe_instance
133 object available for establishing the return probe.
134
135 1.3.2 Kretprobe entry-handler
136
137 Kretprobes also provides an optional user-specified handler which runs
138 on function entry. This handler is specified by setting the entry_handler
139 field of the kretprobe struct. Whenever the kprobe placed by kretprobe at the
140 function entry is hit, the user-defined entry_handler, if any, is invoked.
141 If the entry_handler returns 0 (success) then a corresponding return handler
142 is guaranteed to be called upon function return. If the entry_handler
143 returns a non-zero error then Kprobes leaves the return address as is, and
144 the kretprobe has no further effect for that particular function instance.
145
146 Multiple entry and return handler invocations are matched using the unique
147 kretprobe_instance object associated with them. Additionally, a user
148 may also specify per return-instance private data to be part of each
149 kretprobe_instance object. This is especially useful when sharing private
150 data between corresponding user entry and return handlers. The size of each
151 private data object can be specified at kretprobe registration time by
152 setting the data_size field of the kretprobe struct. This data can be
153 accessed through the data field of each kretprobe_instance object.
154
155 In case probed function is entered but there is no kretprobe_instance
156 object available, then in addition to incrementing the nmissed count,
157 the user entry_handler invocation is also skipped.
158
159 2. Architectures Supported
160
161 Kprobes, jprobes, and return probes are implemented on the following
162 architectures:
163
164 - i386
165 - x86_64 (AMD-64, EM64T)
166 - ppc64
167 - ia64 (Does not support probes on instruction slot1.)
168 - sparc64 (Return probes not yet implemented.)
169 - arm
170
171 3. Configuring Kprobes
172
173 When configuring the kernel using make menuconfig/xconfig/oldconfig,
174 ensure that CONFIG_KPROBES is set to "y".  Under "Instrumentation
175 Support", look for "Kprobes".
176
177 So that you can load and unload Kprobes-based instrumentation modules,
178 make sure "Loadable module support" (CONFIG_MODULES) and "Module
179 unloading" (CONFIG_MODULE_UNLOAD) are set to "y".
180
181 Also make sure that CONFIG_KALLSYMS and perhaps even CONFIG_KALLSYMS_ALL
182 are set to "y", since kallsyms_lookup_name() is used by the in-kernel
183 kprobe address resolution code.
184
185 If you need to insert a probe in the middle of a function, you may find
186 it useful to "Compile the kernel with debug info" (CONFIG_DEBUG_INFO),
187 so you can use "objdump -d -l vmlinux" to see the source-to-object
188 code mapping.
189
190 4. API Reference
191
192 The Kprobes API includes a "register" function and an "unregister"
193 function for each type of probe.  Here are terse, mini-man-page
194 specifications for these functions and the associated probe handlers
195 that you'll write.  See the latter half of this document for examples.
196
197 4.1 register_kprobe
198
199 #include <linux/kprobes.h>
200 int register_kprobe(struct kprobe *kp);
201
202 Sets a breakpoint at the address kp->addr.  When the breakpoint is
203 hit, Kprobes calls kp->pre_handler.  After the probed instruction
204 is single-stepped, Kprobe calls kp->post_handler.  If a fault
205 occurs during execution of kp->pre_handler or kp->post_handler,
206 or during single-stepping of the probed instruction, Kprobes calls
207 kp->fault_handler.  Any or all handlers can be NULL.
208
209 NOTE:
210 1. With the introduction of the "symbol_name" field to struct kprobe,
211 the probepoint address resolution will now be taken care of by the kernel.
212 The following will now work:
213
214         kp.symbol_name = "symbol_name";
215
216 (64-bit powerpc intricacies such as function descriptors are handled
217 transparently)
218
219 2. Use the "offset" field of struct kprobe if the offset into the symbol
220 to install a probepoint is known. This field is used to calculate the
221 probepoint.
222
223 3. Specify either the kprobe "symbol_name" OR the "addr". If both are
224 specified, kprobe registration will fail with -EINVAL.
225
226 4. With CISC architectures (such as i386 and x86_64), the kprobes code
227 does not validate if the kprobe.addr is at an instruction boundary.
228 Use "offset" with caution.
229
230 register_kprobe() returns 0 on success, or a negative errno otherwise.
231
232 User's pre-handler (kp->pre_handler):
233 #include <linux/kprobes.h>
234 #include <linux/ptrace.h>
235 int pre_handler(struct kprobe *p, struct pt_regs *regs);
236
237 Called with p pointing to the kprobe associated with the breakpoint,
238 and regs pointing to the struct containing the registers saved when
239 the breakpoint was hit.  Return 0 here unless you're a Kprobes geek.
240
241 User's post-handler (kp->post_handler):
242 #include <linux/kprobes.h>
243 #include <linux/ptrace.h>
244 void post_handler(struct kprobe *p, struct pt_regs *regs,
245         unsigned long flags);
246
247 p and regs are as described for the pre_handler.  flags always seems
248 to be zero.
249
250 User's fault-handler (kp->fault_handler):
251 #include <linux/kprobes.h>
252 #include <linux/ptrace.h>
253 int fault_handler(struct kprobe *p, struct pt_regs *regs, int trapnr);
254
255 p and regs are as described for the pre_handler.  trapnr is the
256 architecture-specific trap number associated with the fault (e.g.,
257 on i386, 13 for a general protection fault or 14 for a page fault).
258 Returns 1 if it successfully handled the exception.
259
260 4.2 register_jprobe
261
262 #include <linux/kprobes.h>
263 int register_jprobe(struct jprobe *jp)
264
265 Sets a breakpoint at the address jp->kp.addr, which must be the address
266 of the first instruction of a function.  When the breakpoint is hit,
267 Kprobes runs the handler whose address is jp->entry.
268
269 The handler should have the same arg list and return type as the probed
270 function; and just before it returns, it must call jprobe_return().
271 (The handler never actually returns, since jprobe_return() returns
272 control to Kprobes.)  If the probed function is declared asmlinkage
273 or anything else that affects how args are passed, the handler's
274 declaration must match.
275
276 register_jprobe() returns 0 on success, or a negative errno otherwise.
277
278 4.3 register_kretprobe
279
280 #include <linux/kprobes.h>
281 int register_kretprobe(struct kretprobe *rp);
282
283 Establishes a return probe for the function whose address is
284 rp->kp.addr.  When that function returns, Kprobes calls rp->handler.
285 You must set rp->maxactive appropriately before you call
286 register_kretprobe(); see "How Does a Return Probe Work?" for details.
287
288 register_kretprobe() returns 0 on success, or a negative errno
289 otherwise.
290
291 User's return-probe handler (rp->handler):
292 #include <linux/kprobes.h>
293 #include <linux/ptrace.h>
294 int kretprobe_handler(struct kretprobe_instance *ri, struct pt_regs *regs);
295
296 regs is as described for kprobe.pre_handler.  ri points to the
297 kretprobe_instance object, of which the following fields may be
298 of interest:
299 - ret_addr: the return address
300 - rp: points to the corresponding kretprobe object
301 - task: points to the corresponding task struct
302 - data: points to per return-instance private data; see "Kretprobe
303         entry-handler" for details.
304
305 The regs_return_value(regs) macro provides a simple abstraction to
306 extract the return value from the appropriate register as defined by
307 the architecture's ABI.
308
309 The handler's return value is currently ignored.
310
311 4.4 unregister_*probe
312
313 #include <linux/kprobes.h>
314 void unregister_kprobe(struct kprobe *kp);
315 void unregister_jprobe(struct jprobe *jp);
316 void unregister_kretprobe(struct kretprobe *rp);
317
318 Removes the specified probe.  The unregister function can be called
319 at any time after the probe has been registered.
320
321 5. Kprobes Features and Limitations
322
323 Kprobes allows multiple probes at the same address.  Currently,
324 however, there cannot be multiple jprobes on the same function at
325 the same time.
326
327 In general, you can install a probe anywhere in the kernel.
328 In particular, you can probe interrupt handlers.  Known exceptions
329 are discussed in this section.
330
331 The register_*probe functions will return -EINVAL if you attempt
332 to install a probe in the code that implements Kprobes (mostly
333 kernel/kprobes.c and arch/*/kernel/kprobes.c, but also functions such
334 as do_page_fault and notifier_call_chain).
335
336 If you install a probe in an inline-able function, Kprobes makes
337 no attempt to chase down all inline instances of the function and
338 install probes there.  gcc may inline a function without being asked,
339 so keep this in mind if you're not seeing the probe hits you expect.
340
341 A probe handler can modify the environment of the probed function
342 -- e.g., by modifying kernel data structures, or by modifying the
343 contents of the pt_regs struct (which are restored to the registers
344 upon return from the breakpoint).  So Kprobes can be used, for example,
345 to install a bug fix or to inject faults for testing.  Kprobes, of
346 course, has no way to distinguish the deliberately injected faults
347 from the accidental ones.  Don't drink and probe.
348
349 Kprobes makes no attempt to prevent probe handlers from stepping on
350 each other -- e.g., probing printk() and then calling printk() from a
351 probe handler.  If a probe handler hits a probe, that second probe's
352 handlers won't be run in that instance, and the kprobe.nmissed member
353 of the second probe will be incremented.
354
355 As of Linux v2.6.15-rc1, multiple handlers (or multiple instances of
356 the same handler) may run concurrently on different CPUs.
357
358 Kprobes does not use mutexes or allocate memory except during
359 registration and unregistration.
360
361 Probe handlers are run with preemption disabled.  Depending on the
362 architecture, handlers may also run with interrupts disabled.  In any
363 case, your handler should not yield the CPU (e.g., by attempting to
364 acquire a semaphore).
365
366 Since a return probe is implemented by replacing the return
367 address with the trampoline's address, stack backtraces and calls
368 to __builtin_return_address() will typically yield the trampoline's
369 address instead of the real return address for kretprobed functions.
370 (As far as we can tell, __builtin_return_address() is used only
371 for instrumentation and error reporting.)
372
373 If the number of times a function is called does not match the number
374 of times it returns, registering a return probe on that function may
375 produce undesirable results. In such a case, a line:
376 kretprobe BUG!: Processing kretprobe d000000000041aa8 @ c00000000004f48c
377 gets printed. With this information, one will be able to correlate the
378 exact instance of the kretprobe that caused the problem. We have the
379 do_exit() case covered. do_execve() and do_fork() are not an issue.
380 We're unaware of other specific cases where this could be a problem.
381
382 If, upon entry to or exit from a function, the CPU is running on
383 a stack other than that of the current task, registering a return
384 probe on that function may produce undesirable results.  For this
385 reason, Kprobes doesn't support return probes (or kprobes or jprobes)
386 on the x86_64 version of __switch_to(); the registration functions
387 return -EINVAL.
388
389 6. Probe Overhead
390
391 On a typical CPU in use in 2005, a kprobe hit takes 0.5 to 1.0
392 microseconds to process.  Specifically, a benchmark that hits the same
393 probepoint repeatedly, firing a simple handler each time, reports 1-2
394 million hits per second, depending on the architecture.  A jprobe or
395 return-probe hit typically takes 50-75% longer than a kprobe hit.
396 When you have a return probe set on a function, adding a kprobe at
397 the entry to that function adds essentially no overhead.
398
399 Here are sample overhead figures (in usec) for different architectures.
400 k = kprobe; j = jprobe; r = return probe; kr = kprobe + return probe
401 on same function; jr = jprobe + return probe on same function
402
403 i386: Intel Pentium M, 1495 MHz, 2957.31 bogomips
404 k = 0.57 usec; j = 1.00; r = 0.92; kr = 0.99; jr = 1.40
405
406 x86_64: AMD Opteron 246, 1994 MHz, 3971.48 bogomips
407 k = 0.49 usec; j = 0.76; r = 0.80; kr = 0.82; jr = 1.07
408
409 ppc64: POWER5 (gr), 1656 MHz (SMT disabled, 1 virtual CPU per physical CPU)
410 k = 0.77 usec; j = 1.31; r = 1.26; kr = 1.45; jr = 1.99
411
412 7. TODO
413
414 a. SystemTap (http://sourceware.org/systemtap): Provides a simplified
415 programming interface for probe-based instrumentation.  Try it out.
416 b. Kernel return probes for sparc64.
417 c. Support for other architectures.
418 d. User-space probes.
419 e. Watchpoint probes (which fire on data references).
420
421 8. Kprobes Example
422
423 Here's a sample kernel module showing the use of kprobes to dump a
424 stack trace and selected i386 registers when do_fork() is called.
425 ----- cut here -----
426 /*kprobe_example.c*/
427 #include <linux/kernel.h>
428 #include <linux/module.h>
429 #include <linux/kprobes.h>
430 #include <linux/sched.h>
431
432 /*For each probe you need to allocate a kprobe structure*/
433 static struct kprobe kp;
434
435 /*kprobe pre_handler: called just before the probed instruction is executed*/
436 int handler_pre(struct kprobe *p, struct pt_regs *regs)
437 {
438         printk("pre_handler: p->addr=0x%p, eip=%lx, eflags=0x%lx\n",
439                 p->addr, regs->eip, regs->eflags);
440         dump_stack();
441         return 0;
442 }
443
444 /*kprobe post_handler: called after the probed instruction is executed*/
445 void handler_post(struct kprobe *p, struct pt_regs *regs, unsigned long flags)
446 {
447         printk("post_handler: p->addr=0x%p, eflags=0x%lx\n",
448                 p->addr, regs->eflags);
449 }
450
451 /* fault_handler: this is called if an exception is generated for any
452  * instruction within the pre- or post-handler, or when Kprobes
453  * single-steps the probed instruction.
454  */
455 int handler_fault(struct kprobe *p, struct pt_regs *regs, int trapnr)
456 {
457         printk("fault_handler: p->addr=0x%p, trap #%dn",
458                 p->addr, trapnr);
459         /* Return 0 because we don't handle the fault. */
460         return 0;
461 }
462
463 static int __init kprobe_init(void)
464 {
465         int ret;
466         kp.pre_handler = handler_pre;
467         kp.post_handler = handler_post;
468         kp.fault_handler = handler_fault;
469         kp.symbol_name = "do_fork";
470
471         ret = register_kprobe(&kp);
472         if (ret < 0) {
473                 printk("register_kprobe failed, returned %d\n", ret);
474                 return ret;
475         }
476         printk("kprobe registered\n");
477         return 0;
478 }
479
480 static void __exit kprobe_exit(void)
481 {
482         unregister_kprobe(&kp);
483         printk("kprobe unregistered\n");
484 }
485
486 module_init(kprobe_init)
487 module_exit(kprobe_exit)
488 MODULE_LICENSE("GPL");
489 ----- cut here -----
490
491 You can build the kernel module, kprobe-example.ko, using the following
492 Makefile:
493 ----- cut here -----
494 obj-m := kprobe-example.o
495 KDIR := /lib/modules/$(shell uname -r)/build
496 PWD := $(shell pwd)
497 default:
498         $(MAKE) -C $(KDIR) SUBDIRS=$(PWD) modules
499 clean:
500         rm -f *.mod.c *.ko *.o
501 ----- cut here -----
502
503 $ make
504 $ su -
505 ...
506 # insmod kprobe-example.ko
507
508 You will see the trace data in /var/log/messages and on the console
509 whenever do_fork() is invoked to create a new process.
510
511 9. Jprobes Example
512
513 Here's a sample kernel module showing the use of jprobes to dump
514 the arguments of do_fork().
515 ----- cut here -----
516 /*jprobe-example.c */
517 #include <linux/kernel.h>
518 #include <linux/module.h>
519 #include <linux/fs.h>
520 #include <linux/uio.h>
521 #include <linux/kprobes.h>
522
523 /*
524  * Jumper probe for do_fork.
525  * Mirror principle enables access to arguments of the probed routine
526  * from the probe handler.
527  */
528
529 /* Proxy routine having the same arguments as actual do_fork() routine */
530 long jdo_fork(unsigned long clone_flags, unsigned long stack_start,
531               struct pt_regs *regs, unsigned long stack_size,
532               int __user * parent_tidptr, int __user * child_tidptr)
533 {
534         printk("jprobe: clone_flags=0x%lx, stack_size=0x%lx, regs=0x%p\n",
535                clone_flags, stack_size, regs);
536         /* Always end with a call to jprobe_return(). */
537         jprobe_return();
538         /*NOTREACHED*/
539         return 0;
540 }
541
542 static struct jprobe my_jprobe = {
543         .entry = jdo_fork
544 };
545
546 static int __init jprobe_init(void)
547 {
548         int ret;
549         my_jprobe.kp.symbol_name = "do_fork";
550
551         if ((ret = register_jprobe(&my_jprobe)) <0) {
552                 printk("register_jprobe failed, returned %d\n", ret);
553                 return -1;
554         }
555         printk("Planted jprobe at %p, handler addr %p\n",
556                my_jprobe.kp.addr, my_jprobe.entry);
557         return 0;
558 }
559
560 static void __exit jprobe_exit(void)
561 {
562         unregister_jprobe(&my_jprobe);
563         printk("jprobe unregistered\n");
564 }
565
566 module_init(jprobe_init)
567 module_exit(jprobe_exit)
568 MODULE_LICENSE("GPL");
569 ----- cut here -----
570
571 Build and insert the kernel module as shown in the above kprobe
572 example.  You will see the trace data in /var/log/messages and on
573 the console whenever do_fork() is invoked to create a new process.
574 (Some messages may be suppressed if syslogd is configured to
575 eliminate duplicate messages.)
576
577 10. Kretprobes Example
578
579 Here's a sample kernel module showing the use of return probes to
580 report failed calls to sys_open().
581 ----- cut here -----
582 /*kretprobe-example.c*/
583 #include <linux/kernel.h>
584 #include <linux/module.h>
585 #include <linux/kprobes.h>
586 #include <linux/ktime.h>
587
588 /* per-instance private data */
589 struct my_data {
590         ktime_t entry_stamp;
591 };
592
593 static const char *probed_func = "sys_open";
594
595 /* Timestamp function entry. */
596 static int entry_handler(struct kretprobe_instance *ri, struct pt_regs *regs)
597 {
598         struct my_data *data;
599
600         if(!current->mm)
601                 return 1; /* skip kernel threads */
602
603         data = (struct my_data *)ri->data;
604         data->entry_stamp = ktime_get();
605         return 0;
606 }
607
608 /* If the probed function failed, log the return value and duration.
609  * Duration may turn out to be zero consistently, depending upon the
610  * granularity of time accounting on the platform. */
611 static int return_handler(struct kretprobe_instance *ri, struct pt_regs *regs)
612 {
613         int retval = regs_return_value(regs);
614         struct my_data *data = (struct my_data *)ri->data;
615         s64 delta;
616         ktime_t now;
617
618         if (retval < 0) {
619                 now = ktime_get();
620                 delta = ktime_to_ns(ktime_sub(now, data->entry_stamp));
621                 printk("%s: return val = %d (duration = %lld ns)\n",
622                        probed_func, retval, delta);
623         }
624         return 0;
625 }
626
627 static struct kretprobe my_kretprobe = {
628         .handler = return_handler,
629         .entry_handler = entry_handler,
630         .data_size = sizeof(struct my_data),
631         .maxactive = 20, /* probe up to 20 instances concurrently */
632 };
633
634 static int __init kretprobe_init(void)
635 {
636         int ret;
637         my_kretprobe.kp.symbol_name = (char *)probed_func;
638
639         if ((ret = register_kretprobe(&my_kretprobe)) < 0) {
640                 printk("register_kretprobe failed, returned %d\n", ret);
641                 return -1;
642         }
643         printk("Kretprobe active on %s\n", my_kretprobe.kp.symbol_name);
644         return 0;
645 }
646
647 static void __exit kretprobe_exit(void)
648 {
649         unregister_kretprobe(&my_kretprobe);
650         printk("kretprobe unregistered\n");
651         /* nmissed > 0 suggests that maxactive was set too low. */
652         printk("Missed probing %d instances of %s\n",
653                my_kretprobe.nmissed, probed_func);
654 }
655
656 module_init(kretprobe_init)
657 module_exit(kretprobe_exit)
658 MODULE_LICENSE("GPL");
659 ----- cut here -----
660
661 Build and insert the kernel module as shown in the above kprobe
662 example.  You will see the trace data in /var/log/messages and on the
663 console whenever sys_open() returns a negative value.  (Some messages
664 may be suppressed if syslogd is configured to eliminate duplicate
665 messages.)
666
667 For additional information on Kprobes, refer to the following URLs:
668 http://www-106.ibm.com/developerworks/library/l-kprobes.html?ca=dgr-lnxw42Kprobe
669 http://www.redhat.com/magazine/005mar05/features/kprobes/
670 http://www-users.cs.umn.edu/~boutcher/kprobes/
671 http://www.linuxsymposium.org/2006/linuxsymposium_procv2.pdf (pages 101-115)
672
673
674 Appendix A: The kprobes debugfs interface
675
676 With recent kernels (> 2.6.20) the list of registered kprobes is visible
677 under the /debug/kprobes/ directory (assuming debugfs is mounted at /debug).
678
679 /debug/kprobes/list: Lists all registered probes on the system
680
681 c015d71a  k  vfs_read+0x0
682 c011a316  j  do_fork+0x0
683 c03dedc5  r  tcp_v4_rcv+0x0
684
685 The first column provides the kernel address where the probe is inserted.
686 The second column identifies the type of probe (k - kprobe, r - kretprobe
687 and j - jprobe), while the third column specifies the symbol+offset of
688 the probe. If the probed function belongs to a module, the module name
689 is also specified.
690
691 /debug/kprobes/enabled: Turn kprobes ON/OFF
692
693 Provides a knob to globally turn registered kprobes ON or OFF. By default,
694 all kprobes are enabled. By echoing "0" to this file, all registered probes
695 will be disarmed, till such time a "1" is echoed to this file.