mirror of
				https://kernel.googlesource.com/pub/scm/linux/kernel/git/torvalds/linux
				synced 2025-10-31 17:04:14 +10:00 
			
		
		
		
	- Some kernel-doc cleanups.  That script is still regex onslaught from
    hell, but it has gotten a little better.
 
  - Improvements to the checkpatch docs, which are also used by the tool
    itself.
 
  - A major update to the pathname lookup documentation.
 
  - Elimination of :doc: markup, since our automarkup magic can create
    references from filenames without all the extra noise.
 
  - The flurry of Chinese translation activity continues.
 
 Plus, of course, the usual collection of updates, typo fixes, and warning
 fixes.
 -----BEGIN PGP SIGNATURE-----
 
 iQFDBAABCAAtFiEEIw+MvkEiF49krdp9F0NaE2wMflgFAmDZ6pQPHGNvcmJldEBs
 d24ubmV0AAoJEBdDWhNsDH5Y9W0IAIpzBZDVsDQ7s5cIjbxEh9Oeh1uRmwuObnQh
 xsM5oLuAUSMczf5JX8cdyutWJfdoEF5WHjfbt1otfys+kW9m7z0b1K4xw684Y390
 sPk3eYVYLiUAZ4/LVdC47BpAzzgJ5U9iC6+FjOATAYsY40EwruxyZWjmY+SaDOU5
 dQPjbpRuNQTFjYE6nZIW0o6jyunrfFaJTS6g2bdDoBDOGKyNOSKEw4XZ442cJ3km
 uXoMfSJGslQj6qbGY0YhNeaNQm0ErcQw2K4lS3K4gc7Lht32Fbi1lhaqnTIkgI5f
 Rh3X37pb90Ya88uWxldVB2bXUrA+PZA/cJqwNTrgw+niBQl6sKU=
 =KDcM
 -----END PGP SIGNATURE-----
Merge tag 'docs-5.14' of git://git.lwn.net/linux
Pull documentation updates from Jonathan Corbet:
 "This was a reasonably active cycle for documentation; this includes:
   - Some kernel-doc cleanups. That script is still regex onslaught from
     hell, but it has gotten a little better.
   - Improvements to the checkpatch docs, which are also used by the
     tool itself.
   - A major update to the pathname lookup documentation.
   - Elimination of :doc: markup, since our automarkup magic can create
     references from filenames without all the extra noise.
   - The flurry of Chinese translation activity continues.
  Plus, of course, the usual collection of updates, typo fixes, and
  warning fixes"
* tag 'docs-5.14' of git://git.lwn.net/linux: (115 commits)
  docs: path-lookup: use bare function() rather than literals
  docs: path-lookup: update symlink description
  docs: path-lookup: update get_link() ->follow_link description
  docs: path-lookup: update WALK_GET, WALK_PUT desc
  docs: path-lookup: no get_link()
  docs: path-lookup: update i_op->put_link and cookie description
  docs: path-lookup: i_op->follow_link replaced with i_op->get_link
  docs: path-lookup: Add macro name to symlink limit description
  docs: path-lookup: remove filename_mountpoint
  docs: path-lookup: update do_last() part
  docs: path-lookup: update path_mountpoint() part
  docs: path-lookup: update path_to_nameidata() part
  docs: path-lookup: update follow_managed() part
  docs: Makefile: Use CONFIG_SHELL not SHELL
  docs: Take a little noise out of the build process
  docs: x86: avoid using ReST :doc:`foo` markup
  docs: virt: kvm: s390-pv-boot.rst: avoid using ReST :doc:`foo` markup
  docs: userspace-api: landlock.rst: avoid using ReST :doc:`foo` markup
  docs: trace: ftrace.rst: avoid using ReST :doc:`foo` markup
  docs: trace: coresight: coresight.rst: avoid using ReST :doc:`foo` markup
  ...
		
	
			
		
			
				
	
	
		
			122 lines
		
	
	
		
			3.4 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			122 lines
		
	
	
		
			3.4 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| // SPDX-License-Identifier: GPL-2.0-only
 | |
| /*
 | |
|  * Here's a sample kernel module showing the use of kprobes to dump a
 | |
|  * stack trace and selected registers when kernel_clone() is called.
 | |
|  *
 | |
|  * For more information on theory of operation of kprobes, see
 | |
|  * Documentation/trace/kprobes.rst
 | |
|  *
 | |
|  * You will see the trace data in /var/log/messages and on the console
 | |
|  * whenever kernel_clone() is invoked to create a new process.
 | |
|  */
 | |
| 
 | |
| #define pr_fmt(fmt) "%s: " fmt, __func__
 | |
| 
 | |
| #include <linux/kernel.h>
 | |
| #include <linux/module.h>
 | |
| #include <linux/kprobes.h>
 | |
| 
 | |
| #define MAX_SYMBOL_LEN	64
 | |
| static char symbol[MAX_SYMBOL_LEN] = "kernel_clone";
 | |
| module_param_string(symbol, symbol, sizeof(symbol), 0644);
 | |
| 
 | |
| /* For each probe you need to allocate a kprobe structure */
 | |
| static struct kprobe kp = {
 | |
| 	.symbol_name	= symbol,
 | |
| };
 | |
| 
 | |
| /* kprobe pre_handler: called just before the probed instruction is executed */
 | |
| static int __kprobes handler_pre(struct kprobe *p, struct pt_regs *regs)
 | |
| {
 | |
| #ifdef CONFIG_X86
 | |
| 	pr_info("<%s> p->addr = 0x%p, ip = %lx, flags = 0x%lx\n",
 | |
| 		p->symbol_name, p->addr, regs->ip, regs->flags);
 | |
| #endif
 | |
| #ifdef CONFIG_PPC
 | |
| 	pr_info("<%s> p->addr = 0x%p, nip = 0x%lx, msr = 0x%lx\n",
 | |
| 		p->symbol_name, p->addr, regs->nip, regs->msr);
 | |
| #endif
 | |
| #ifdef CONFIG_MIPS
 | |
| 	pr_info("<%s> p->addr = 0x%p, epc = 0x%lx, status = 0x%lx\n",
 | |
| 		p->symbol_name, p->addr, regs->cp0_epc, regs->cp0_status);
 | |
| #endif
 | |
| #ifdef CONFIG_ARM64
 | |
| 	pr_info("<%s> p->addr = 0x%p, pc = 0x%lx, pstate = 0x%lx\n",
 | |
| 		p->symbol_name, p->addr, (long)regs->pc, (long)regs->pstate);
 | |
| #endif
 | |
| #ifdef CONFIG_ARM
 | |
| 	pr_info("<%s> p->addr = 0x%p, pc = 0x%lx, cpsr = 0x%lx\n",
 | |
| 		p->symbol_name, p->addr, (long)regs->ARM_pc, (long)regs->ARM_cpsr);
 | |
| #endif
 | |
| #ifdef CONFIG_RISCV
 | |
| 	pr_info("<%s> p->addr = 0x%p, pc = 0x%lx, status = 0x%lx\n",
 | |
| 		p->symbol_name, p->addr, regs->epc, regs->status);
 | |
| #endif
 | |
| #ifdef CONFIG_S390
 | |
| 	pr_info("<%s> p->addr, 0x%p, ip = 0x%lx, flags = 0x%lx\n",
 | |
| 		p->symbol_name, p->addr, regs->psw.addr, regs->flags);
 | |
| #endif
 | |
| 
 | |
| 	/* A dump_stack() here will give a stack backtrace */
 | |
| 	return 0;
 | |
| }
 | |
| 
 | |
| /* kprobe post_handler: called after the probed instruction is executed */
 | |
| static void __kprobes handler_post(struct kprobe *p, struct pt_regs *regs,
 | |
| 				unsigned long flags)
 | |
| {
 | |
| #ifdef CONFIG_X86
 | |
| 	pr_info("<%s> p->addr = 0x%p, flags = 0x%lx\n",
 | |
| 		p->symbol_name, p->addr, regs->flags);
 | |
| #endif
 | |
| #ifdef CONFIG_PPC
 | |
| 	pr_info("<%s> p->addr = 0x%p, msr = 0x%lx\n",
 | |
| 		p->symbol_name, p->addr, regs->msr);
 | |
| #endif
 | |
| #ifdef CONFIG_MIPS
 | |
| 	pr_info("<%s> p->addr = 0x%p, status = 0x%lx\n",
 | |
| 		p->symbol_name, p->addr, regs->cp0_status);
 | |
| #endif
 | |
| #ifdef CONFIG_ARM64
 | |
| 	pr_info("<%s> p->addr = 0x%p, pstate = 0x%lx\n",
 | |
| 		p->symbol_name, p->addr, (long)regs->pstate);
 | |
| #endif
 | |
| #ifdef CONFIG_ARM
 | |
| 	pr_info("<%s> p->addr = 0x%p, cpsr = 0x%lx\n",
 | |
| 		p->symbol_name, p->addr, (long)regs->ARM_cpsr);
 | |
| #endif
 | |
| #ifdef CONFIG_RISCV
 | |
| 	pr_info("<%s> p->addr = 0x%p, status = 0x%lx\n",
 | |
| 		p->symbol_name, p->addr, regs->status);
 | |
| #endif
 | |
| #ifdef CONFIG_S390
 | |
| 	pr_info("<%s> p->addr, 0x%p, flags = 0x%lx\n",
 | |
| 		p->symbol_name, p->addr, regs->flags);
 | |
| #endif
 | |
| }
 | |
| 
 | |
| static int __init kprobe_init(void)
 | |
| {
 | |
| 	int ret;
 | |
| 	kp.pre_handler = handler_pre;
 | |
| 	kp.post_handler = handler_post;
 | |
| 
 | |
| 	ret = register_kprobe(&kp);
 | |
| 	if (ret < 0) {
 | |
| 		pr_err("register_kprobe failed, returned %d\n", ret);
 | |
| 		return ret;
 | |
| 	}
 | |
| 	pr_info("Planted kprobe at %p\n", kp.addr);
 | |
| 	return 0;
 | |
| }
 | |
| 
 | |
| static void __exit kprobe_exit(void)
 | |
| {
 | |
| 	unregister_kprobe(&kp);
 | |
| 	pr_info("kprobe at %p unregistered\n", kp.addr);
 | |
| }
 | |
| 
 | |
| module_init(kprobe_init)
 | |
| module_exit(kprobe_exit)
 | |
| MODULE_LICENSE("GPL");
 |