blob: da2ccf14235814df4dc4b21509500d0d777cacb4 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Kernel Probes (KProbes)
3 * kernel/kprobes.c
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 *
19 * Copyright (C) IBM Corporation, 2002, 2004
20 *
21 * 2002-Oct Created by Vamsi Krishna S <vamsi_krishna@in.ibm.com> Kernel
22 * Probes initial implementation (includes suggestions from
23 * Rusty Russell).
24 * 2004-Aug Updated by Prasanna S Panchamukhi <prasanna@in.ibm.com> with
25 * hlists and exceptions notifier as suggested by Andi Kleen.
26 * 2004-July Suparna Bhattacharya <suparna@in.ibm.com> added jumper probes
27 * interface to access function arguments.
28 * 2004-Sep Prasanna S Panchamukhi <prasanna@in.ibm.com> Changed Kprobes
29 * exceptions notifier to be first on the priority list.
Hien Nguyenb94cce92005-06-23 00:09:19 -070030 * 2005-May Hien Nguyen <hien@us.ibm.com>, Jim Keniston
31 * <jkenisto@us.ibm.com> and Prasanna S Panchamukhi
32 * <prasanna@in.ibm.com> added function-return probes.
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 */
34#include <linux/kprobes.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <linux/hash.h>
36#include <linux/init.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080037#include <linux/slab.h>
Randy Dunlape3869792007-05-08 00:27:01 -070038#include <linux/stddef.h>
Paul Gortmaker9984de12011-05-23 14:51:41 -040039#include <linux/export.h>
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070040#include <linux/moduleloader.h>
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -070041#include <linux/kallsyms.h>
Masami Hiramatsub4c6c342006-12-06 20:38:11 -080042#include <linux/freezer.h>
Srinivasa Ds346fd592007-02-20 13:57:54 -080043#include <linux/seq_file.h>
44#include <linux/debugfs.h>
Masami Hiramatsub2be84d2010-02-25 08:34:15 -050045#include <linux/sysctl.h>
Christoph Hellwig1eeb66a2007-05-08 00:27:03 -070046#include <linux/kdebug.h>
Mathieu Desnoyers4460fda2009-03-06 10:36:38 -050047#include <linux/memory.h>
Masami Hiramatsu4554dbc2010-02-02 16:49:18 -050048#include <linux/ftrace.h>
Masami Hiramatsuafd66252010-02-25 08:34:07 -050049#include <linux/cpu.h>
Jason Baronbf5438fc2010-09-17 11:09:00 -040050#include <linux/jump_label.h>
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -070051
Christoph Hellwigbfd45be2016-10-11 13:52:22 -070052#include <asm/sections.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070053#include <asm/cacheflush.h>
54#include <asm/errno.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080055#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
57#define KPROBE_HASH_BITS 6
58#define KPROBE_TABLE_SIZE (1 << KPROBE_HASH_BITS)
59
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -070060
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070061static int kprobes_initialized;
Linus Torvalds1da177e2005-04-16 15:20:36 -070062static struct hlist_head kprobe_table[KPROBE_TABLE_SIZE];
Hien Nguyenb94cce92005-06-23 00:09:19 -070063static struct hlist_head kretprobe_inst_table[KPROBE_TABLE_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -070065/* NOTE: change this value only with kprobe_mutex held */
Masami Hiramatsue579abe2009-04-06 19:01:01 -070066static bool kprobes_all_disarmed;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -070067
Masami Hiramatsu43948f52010-10-25 22:18:01 +090068/* This protects kprobe_table and optimizing_list */
69static DEFINE_MUTEX(kprobe_mutex);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -080070static DEFINE_PER_CPU(struct kprobe *, kprobe_instance) = NULL;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070071static struct {
Thomas Gleixnerec4846082009-07-25 16:09:17 +020072 raw_spinlock_t lock ____cacheline_aligned_in_smp;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070073} kretprobe_table_locks[KPROBE_TABLE_SIZE];
74
Naveen N. Rao290e3072017-04-19 18:21:01 +053075kprobe_opcode_t * __weak kprobe_lookup_name(const char *name,
76 unsigned int __unused)
Naveen N. Rao49e0b462017-04-19 18:21:00 +053077{
78 return ((kprobe_opcode_t *)(kallsyms_lookup_name(name)));
79}
80
Thomas Gleixnerec4846082009-07-25 16:09:17 +020081static raw_spinlock_t *kretprobe_table_lock_ptr(unsigned long hash)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070082{
83 return &(kretprobe_table_locks[hash].lock);
84}
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Masami Hiramatsu376e2422014-04-17 17:17:05 +090086/* Blacklist -- list of struct kprobe_blacklist_entry */
87static LIST_HEAD(kprobe_blacklist);
Srinivasa Ds3d8d9962008-04-28 02:14:26 -070088
Anil S Keshavamurthy2d14e392006-01-09 20:52:41 -080089#ifdef __ARCH_WANT_KPROBES_INSN_SLOT
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070090/*
91 * kprobe->ainsn.insn points to the copy of the instruction to be
92 * single-stepped. x86_64, POWER4 and above have no-exec support and
93 * stepping on the instruction on a vmalloced/kmalloced/data page
94 * is a recipe for disaster
95 */
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070096struct kprobe_insn_page {
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -040097 struct list_head list;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070098 kprobe_opcode_t *insns; /* Page of instruction slots */
Heiko Carstensaf963972013-09-11 14:24:13 -070099 struct kprobe_insn_cache *cache;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700100 int nused;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800101 int ngarbage;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500102 char slot_used[];
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700103};
104
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500105#define KPROBE_INSN_PAGE_SIZE(slots) \
106 (offsetof(struct kprobe_insn_page, slot_used) + \
107 (sizeof(char) * (slots)))
108
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500109static int slots_per_page(struct kprobe_insn_cache *c)
110{
111 return PAGE_SIZE/(c->insn_size * sizeof(kprobe_opcode_t));
112}
113
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800114enum kprobe_slot_state {
115 SLOT_CLEAN = 0,
116 SLOT_DIRTY = 1,
117 SLOT_USED = 2,
118};
119
Masami Hiramatsu63fef142017-08-18 17:24:00 +0900120void __weak *alloc_insn_page(void)
Heiko Carstensaf963972013-09-11 14:24:13 -0700121{
122 return module_alloc(PAGE_SIZE);
123}
124
Masami Hiramatsuc93f5cf2017-05-25 19:38:17 +0900125void __weak free_insn_page(void *page)
Heiko Carstensaf963972013-09-11 14:24:13 -0700126{
Rusty Russellbe1f2212015-01-20 09:07:05 +1030127 module_memfree(page);
Heiko Carstensaf963972013-09-11 14:24:13 -0700128}
129
Heiko Carstensc802d642013-09-11 14:24:11 -0700130struct kprobe_insn_cache kprobe_insn_slots = {
131 .mutex = __MUTEX_INITIALIZER(kprobe_insn_slots.mutex),
Heiko Carstensaf963972013-09-11 14:24:13 -0700132 .alloc = alloc_insn_page,
133 .free = free_insn_page,
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500134 .pages = LIST_HEAD_INIT(kprobe_insn_slots.pages),
135 .insn_size = MAX_INSN_SIZE,
136 .nr_garbage = 0,
137};
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900138static int collect_garbage_slots(struct kprobe_insn_cache *c);
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800139
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700140/**
Masami Hiramatsu12941562009-01-06 14:41:50 -0800141 * __get_insn_slot() - Find a slot on an executable page for an instruction.
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700142 * We allocate an executable page if there's no room on existing ones.
143 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900144kprobe_opcode_t *__get_insn_slot(struct kprobe_insn_cache *c)
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700145{
146 struct kprobe_insn_page *kip;
Heiko Carstensc802d642013-09-11 14:24:11 -0700147 kprobe_opcode_t *slot = NULL;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700148
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900149 /* Since the slot array is not protected by rcu, we need a mutex */
Heiko Carstensc802d642013-09-11 14:24:11 -0700150 mutex_lock(&c->mutex);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -0700151 retry:
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900152 rcu_read_lock();
153 list_for_each_entry_rcu(kip, &c->pages, list) {
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500154 if (kip->nused < slots_per_page(c)) {
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700155 int i;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500156 for (i = 0; i < slots_per_page(c); i++) {
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800157 if (kip->slot_used[i] == SLOT_CLEAN) {
158 kip->slot_used[i] = SLOT_USED;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700159 kip->nused++;
Heiko Carstensc802d642013-09-11 14:24:11 -0700160 slot = kip->insns + (i * c->insn_size);
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900161 rcu_read_unlock();
Heiko Carstensc802d642013-09-11 14:24:11 -0700162 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700163 }
164 }
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500165 /* kip->nused is broken. Fix it. */
166 kip->nused = slots_per_page(c);
167 WARN_ON(1);
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700168 }
169 }
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900170 rcu_read_unlock();
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700171
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800172 /* If there are any garbage slots, collect it and try again. */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500173 if (c->nr_garbage && collect_garbage_slots(c) == 0)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800174 goto retry;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500175
176 /* All out of space. Need to allocate a new page. */
177 kip = kmalloc(KPROBE_INSN_PAGE_SIZE(slots_per_page(c)), GFP_KERNEL);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -0700178 if (!kip)
Heiko Carstensc802d642013-09-11 14:24:11 -0700179 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700180
181 /*
182 * Use module_alloc so this page is within +/- 2GB of where the
183 * kernel image and loaded module images reside. This is required
184 * so x86_64 can correctly handle the %rip-relative fixups.
185 */
Heiko Carstensaf963972013-09-11 14:24:13 -0700186 kip->insns = c->alloc();
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700187 if (!kip->insns) {
188 kfree(kip);
Heiko Carstensc802d642013-09-11 14:24:11 -0700189 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700190 }
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400191 INIT_LIST_HEAD(&kip->list);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500192 memset(kip->slot_used, SLOT_CLEAN, slots_per_page(c));
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800193 kip->slot_used[0] = SLOT_USED;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700194 kip->nused = 1;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800195 kip->ngarbage = 0;
Heiko Carstensaf963972013-09-11 14:24:13 -0700196 kip->cache = c;
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900197 list_add_rcu(&kip->list, &c->pages);
Heiko Carstensc802d642013-09-11 14:24:11 -0700198 slot = kip->insns;
199out:
200 mutex_unlock(&c->mutex);
201 return slot;
Masami Hiramatsu12941562009-01-06 14:41:50 -0800202}
203
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800204/* Return 1 if all garbages are collected, otherwise 0. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900205static int collect_one_slot(struct kprobe_insn_page *kip, int idx)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800206{
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800207 kip->slot_used[idx] = SLOT_CLEAN;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800208 kip->nused--;
209 if (kip->nused == 0) {
210 /*
211 * Page is no longer in use. Free it unless
212 * it's the last one. We keep the last one
213 * so as not to have to set it up again the
214 * next time somebody inserts a probe.
215 */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500216 if (!list_is_singular(&kip->list)) {
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900217 list_del_rcu(&kip->list);
218 synchronize_rcu();
Heiko Carstensaf963972013-09-11 14:24:13 -0700219 kip->cache->free(kip->insns);
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800220 kfree(kip);
221 }
222 return 1;
223 }
224 return 0;
225}
226
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900227static int collect_garbage_slots(struct kprobe_insn_cache *c)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800228{
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400229 struct kprobe_insn_page *kip, *next;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800230
Masami Hiramatsu615d0eb2010-02-02 16:49:04 -0500231 /* Ensure no-one is interrupted on the garbages */
232 synchronize_sched();
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800233
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500234 list_for_each_entry_safe(kip, next, &c->pages, list) {
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800235 int i;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800236 if (kip->ngarbage == 0)
237 continue;
238 kip->ngarbage = 0; /* we will collect all garbages */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500239 for (i = 0; i < slots_per_page(c); i++) {
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900240 if (kip->slot_used[i] == SLOT_DIRTY && collect_one_slot(kip, i))
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800241 break;
242 }
243 }
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500244 c->nr_garbage = 0;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800245 return 0;
246}
247
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900248void __free_insn_slot(struct kprobe_insn_cache *c,
249 kprobe_opcode_t *slot, int dirty)
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500250{
251 struct kprobe_insn_page *kip;
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900252 long idx;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500253
Heiko Carstensc802d642013-09-11 14:24:11 -0700254 mutex_lock(&c->mutex);
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900255 rcu_read_lock();
256 list_for_each_entry_rcu(kip, &c->pages, list) {
257 idx = ((long)slot - (long)kip->insns) /
258 (c->insn_size * sizeof(kprobe_opcode_t));
259 if (idx >= 0 && idx < slots_per_page(c))
Heiko Carstensc802d642013-09-11 14:24:11 -0700260 goto out;
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900261 }
262 /* Could not find this slot. */
263 WARN_ON(1);
264 kip = NULL;
265out:
266 rcu_read_unlock();
267 /* Mark and sweep: this may sleep */
268 if (kip) {
269 /* Check double free */
270 WARN_ON(kip->slot_used[idx] != SLOT_USED);
271 if (dirty) {
272 kip->slot_used[idx] = SLOT_DIRTY;
273 kip->ngarbage++;
274 if (++c->nr_garbage > slots_per_page(c))
275 collect_garbage_slots(c);
276 } else {
277 collect_one_slot(kip, idx);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500278 }
279 }
Heiko Carstensc802d642013-09-11 14:24:11 -0700280 mutex_unlock(&c->mutex);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500281}
282
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900283/*
284 * Check given address is on the page of kprobe instruction slots.
285 * This will be used for checking whether the address on a stack
286 * is on a text area or not.
287 */
288bool __is_insn_slot_addr(struct kprobe_insn_cache *c, unsigned long addr)
289{
290 struct kprobe_insn_page *kip;
291 bool ret = false;
292
293 rcu_read_lock();
294 list_for_each_entry_rcu(kip, &c->pages, list) {
295 if (addr >= (unsigned long)kip->insns &&
296 addr < (unsigned long)kip->insns + PAGE_SIZE) {
297 ret = true;
298 break;
299 }
300 }
301 rcu_read_unlock();
302
303 return ret;
304}
305
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500306#ifdef CONFIG_OPTPROBES
307/* For optimized_kprobe buffer */
Heiko Carstensc802d642013-09-11 14:24:11 -0700308struct kprobe_insn_cache kprobe_optinsn_slots = {
309 .mutex = __MUTEX_INITIALIZER(kprobe_optinsn_slots.mutex),
Heiko Carstensaf963972013-09-11 14:24:13 -0700310 .alloc = alloc_insn_page,
311 .free = free_insn_page,
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500312 .pages = LIST_HEAD_INIT(kprobe_optinsn_slots.pages),
313 /* .insn_size is initialized later */
314 .nr_garbage = 0,
315};
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500316#endif
Anil S Keshavamurthy2d14e392006-01-09 20:52:41 -0800317#endif
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700318
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800319/* We have preemption disabled.. so it is safe to use __ versions */
320static inline void set_kprobe_instance(struct kprobe *kp)
321{
Christoph Lameterb76834b2010-12-06 11:16:25 -0600322 __this_cpu_write(kprobe_instance, kp);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800323}
324
325static inline void reset_kprobe_instance(void)
326{
Christoph Lameterb76834b2010-12-06 11:16:25 -0600327 __this_cpu_write(kprobe_instance, NULL);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800328}
329
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800330/*
331 * This routine is called either:
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -0800332 * - under the kprobe_mutex - during kprobe_[un]register()
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800333 * OR
Ananth N Mavinakayanahallid217d542005-11-07 01:00:14 -0800334 * - with preemption disabled - from arch/xxx/kernel/kprobes.c
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800335 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900336struct kprobe *get_kprobe(void *addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337{
338 struct hlist_head *head;
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800339 struct kprobe *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340
341 head = &kprobe_table[hash_ptr(addr, KPROBE_HASH_BITS)];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800342 hlist_for_each_entry_rcu(p, head, hlist) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 if (p->addr == addr)
344 return p;
345 }
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500346
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 return NULL;
348}
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900349NOKPROBE_SYMBOL(get_kprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900351static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500352
353/* Return true if the kprobe is an aggregator */
354static inline int kprobe_aggrprobe(struct kprobe *p)
355{
356 return p->pre_handler == aggr_pre_handler;
357}
358
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900359/* Return true(!0) if the kprobe is unused */
360static inline int kprobe_unused(struct kprobe *p)
361{
362 return kprobe_aggrprobe(p) && kprobe_disabled(p) &&
363 list_empty(&p->list);
364}
365
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500366/*
367 * Keep all fields in the kprobe consistent
368 */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900369static inline void copy_kprobe(struct kprobe *ap, struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500370{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900371 memcpy(&p->opcode, &ap->opcode, sizeof(kprobe_opcode_t));
372 memcpy(&p->ainsn, &ap->ainsn, sizeof(struct arch_specific_insn));
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500373}
374
375#ifdef CONFIG_OPTPROBES
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500376/* NOTE: change this value only with kprobe_mutex held */
377static bool kprobes_allow_optimization;
378
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500379/*
380 * Call all pre_handler on the list, but ignores its return value.
381 * This must be called from arch-dep optimized caller.
382 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900383void opt_pre_handler(struct kprobe *p, struct pt_regs *regs)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500384{
385 struct kprobe *kp;
386
387 list_for_each_entry_rcu(kp, &p->list, list) {
388 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
389 set_kprobe_instance(kp);
Naveen N. Rao4f3a8712017-10-17 13:48:34 +0530390 kp->pre_handler(kp, regs);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500391 }
392 reset_kprobe_instance();
393 }
394}
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900395NOKPROBE_SYMBOL(opt_pre_handler);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500396
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900397/* Free optimized instructions and optimized_kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900398static void free_aggr_kprobe(struct kprobe *p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900399{
400 struct optimized_kprobe *op;
401
402 op = container_of(p, struct optimized_kprobe, kp);
403 arch_remove_optimized_kprobe(op);
404 arch_remove_kprobe(p);
405 kfree(op);
406}
407
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500408/* Return true(!0) if the kprobe is ready for optimization. */
409static inline int kprobe_optready(struct kprobe *p)
410{
411 struct optimized_kprobe *op;
412
413 if (kprobe_aggrprobe(p)) {
414 op = container_of(p, struct optimized_kprobe, kp);
415 return arch_prepared_optinsn(&op->optinsn);
416 }
417
418 return 0;
419}
420
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900421/* Return true(!0) if the kprobe is disarmed. Note: p must be on hash list */
422static inline int kprobe_disarmed(struct kprobe *p)
423{
424 struct optimized_kprobe *op;
425
426 /* If kprobe is not aggr/opt probe, just return kprobe is disabled */
427 if (!kprobe_aggrprobe(p))
428 return kprobe_disabled(p);
429
430 op = container_of(p, struct optimized_kprobe, kp);
431
432 return kprobe_disabled(p) && list_empty(&op->list);
433}
434
435/* Return true(!0) if the probe is queued on (un)optimizing lists */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900436static int kprobe_queued(struct kprobe *p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900437{
438 struct optimized_kprobe *op;
439
440 if (kprobe_aggrprobe(p)) {
441 op = container_of(p, struct optimized_kprobe, kp);
442 if (!list_empty(&op->list))
443 return 1;
444 }
445 return 0;
446}
447
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500448/*
449 * Return an optimized kprobe whose optimizing code replaces
450 * instructions including addr (exclude breakpoint).
451 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900452static struct kprobe *get_optimized_kprobe(unsigned long addr)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500453{
454 int i;
455 struct kprobe *p = NULL;
456 struct optimized_kprobe *op;
457
458 /* Don't check i == 0, since that is a breakpoint case. */
459 for (i = 1; !p && i < MAX_OPTIMIZED_LENGTH; i++)
460 p = get_kprobe((void *)(addr - i));
461
462 if (p && kprobe_optready(p)) {
463 op = container_of(p, struct optimized_kprobe, kp);
464 if (arch_within_optimized_kprobe(op, addr))
465 return p;
466 }
467
468 return NULL;
469}
470
471/* Optimization staging list, protected by kprobe_mutex */
472static LIST_HEAD(optimizing_list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900473static LIST_HEAD(unoptimizing_list);
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900474static LIST_HEAD(freeing_list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500475
476static void kprobe_optimizer(struct work_struct *work);
477static DECLARE_DELAYED_WORK(optimizing_work, kprobe_optimizer);
478#define OPTIMIZE_DELAY 5
479
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900480/*
481 * Optimize (replace a breakpoint with a jump) kprobes listed on
482 * optimizing_list.
483 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900484static void do_optimize_kprobes(void)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500485{
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500486 /*
487 * The optimization/unoptimization refers online_cpus via
488 * stop_machine() and cpu-hotplug modifies online_cpus.
489 * And same time, text_mutex will be held in cpu-hotplug and here.
490 * This combination can cause a deadlock (cpu-hotplug try to lock
491 * text_mutex but stop_machine can not be done because online_cpus
492 * has been changed)
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200493 * To avoid this deadlock, caller must have locked cpu hotplug
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500494 * for preventing cpu-hotplug outside of text_mutex locking.
495 */
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200496 lockdep_assert_cpus_held();
497
498 /* Optimization never be done when disarmed */
499 if (kprobes_all_disarmed || !kprobes_allow_optimization ||
500 list_empty(&optimizing_list))
501 return;
502
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500503 mutex_lock(&text_mutex);
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900504 arch_optimize_kprobes(&optimizing_list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500505 mutex_unlock(&text_mutex);
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900506}
507
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900508/*
509 * Unoptimize (replace a jump with a breakpoint and remove the breakpoint
510 * if need) kprobes listed on unoptimizing_list.
511 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900512static void do_unoptimize_kprobes(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900513{
514 struct optimized_kprobe *op, *tmp;
515
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200516 /* See comment in do_optimize_kprobes() */
517 lockdep_assert_cpus_held();
518
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900519 /* Unoptimization must be done anytime */
520 if (list_empty(&unoptimizing_list))
521 return;
522
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900523 mutex_lock(&text_mutex);
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900524 arch_unoptimize_kprobes(&unoptimizing_list, &freeing_list);
Masami Hiramatsuf984ba42010-12-03 18:54:34 +0900525 /* Loop free_list for disarming */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900526 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900527 /* Disarm probes if marked disabled */
528 if (kprobe_disabled(&op->kp))
529 arch_disarm_kprobe(&op->kp);
530 if (kprobe_unused(&op->kp)) {
531 /*
532 * Remove unused probes from hash list. After waiting
533 * for synchronization, these probes are reclaimed.
534 * (reclaiming is done by do_free_cleaned_kprobes.)
535 */
536 hlist_del_rcu(&op->kp.hlist);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900537 } else
538 list_del_init(&op->list);
539 }
540 mutex_unlock(&text_mutex);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900541}
542
543/* Reclaim all kprobes on the free_list */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900544static void do_free_cleaned_kprobes(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900545{
546 struct optimized_kprobe *op, *tmp;
547
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900548 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900549 BUG_ON(!kprobe_unused(&op->kp));
550 list_del_init(&op->list);
551 free_aggr_kprobe(&op->kp);
552 }
553}
554
555/* Start optimizer after OPTIMIZE_DELAY passed */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900556static void kick_kprobe_optimizer(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900557{
Tejun Heoad72b3b2012-12-21 17:57:00 -0800558 schedule_delayed_work(&optimizing_work, OPTIMIZE_DELAY);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900559}
560
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900561/* Kprobe jump optimizer */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900562static void kprobe_optimizer(struct work_struct *work)
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900563{
Steven Rostedt72ef3792012-06-05 19:28:14 +0900564 mutex_lock(&kprobe_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200565 cpus_read_lock();
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900566 /* Lock modules while optimizing kprobes */
567 mutex_lock(&module_mutex);
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900568
569 /*
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900570 * Step 1: Unoptimize kprobes and collect cleaned (unused and disarmed)
571 * kprobes before waiting for quiesence period.
572 */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900573 do_unoptimize_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900574
575 /*
Masami Hiramatsua30b85d2017-10-20 08:43:39 +0900576 * Step 2: Wait for quiesence period to ensure all potentially
577 * preempted tasks to have normally scheduled. Because optprobe
578 * may modify multiple instructions, there is a chance that Nth
579 * instruction is preempted. In that case, such tasks can return
580 * to 2nd-Nth byte of jump instruction. This wait is for avoiding it.
581 * Note that on non-preemptive kernel, this is transparently converted
582 * to synchronoze_sched() to wait for all interrupts to have completed.
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900583 */
Masami Hiramatsua30b85d2017-10-20 08:43:39 +0900584 synchronize_rcu_tasks();
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900585
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900586 /* Step 3: Optimize kprobes after quiesence period */
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900587 do_optimize_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900588
589 /* Step 4: Free cleaned kprobes after quiesence period */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900590 do_free_cleaned_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900591
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500592 mutex_unlock(&module_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200593 cpus_read_unlock();
Steven Rostedt72ef3792012-06-05 19:28:14 +0900594 mutex_unlock(&kprobe_mutex);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900595
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900596 /* Step 5: Kick optimizer again if needed */
Masami Hiramatsuf984ba42010-12-03 18:54:34 +0900597 if (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list))
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900598 kick_kprobe_optimizer();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900599}
600
601/* Wait for completing optimization and unoptimization */
Thomas Gleixner30e7d8942017-05-17 10:19:49 +0200602void wait_for_kprobe_optimizer(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900603{
Tejun Heoad72b3b2012-12-21 17:57:00 -0800604 mutex_lock(&kprobe_mutex);
605
606 while (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list)) {
607 mutex_unlock(&kprobe_mutex);
608
609 /* this will also make optimizing_work execute immmediately */
610 flush_delayed_work(&optimizing_work);
611 /* @optimizing_work might not have been queued yet, relax */
612 cpu_relax();
613
614 mutex_lock(&kprobe_mutex);
615 }
616
617 mutex_unlock(&kprobe_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500618}
619
620/* Optimize kprobe if p is ready to be optimized */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900621static void optimize_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500622{
623 struct optimized_kprobe *op;
624
625 /* Check if the kprobe is disabled or not ready for optimization. */
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500626 if (!kprobe_optready(p) || !kprobes_allow_optimization ||
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500627 (kprobe_disabled(p) || kprobes_all_disarmed))
628 return;
629
630 /* Both of break_handler and post_handler are not supported. */
631 if (p->break_handler || p->post_handler)
632 return;
633
634 op = container_of(p, struct optimized_kprobe, kp);
635
636 /* Check there is no other kprobes at the optimized instructions */
637 if (arch_check_optimized_kprobe(op) < 0)
638 return;
639
640 /* Check if it is already optimized. */
641 if (op->kp.flags & KPROBE_FLAG_OPTIMIZED)
642 return;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500643 op->kp.flags |= KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900644
645 if (!list_empty(&op->list))
646 /* This is under unoptimizing. Just dequeue the probe */
647 list_del_init(&op->list);
648 else {
649 list_add(&op->list, &optimizing_list);
650 kick_kprobe_optimizer();
651 }
652}
653
654/* Short cut to direct unoptimizing */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900655static void force_unoptimize_kprobe(struct optimized_kprobe *op)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900656{
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200657 lockdep_assert_cpus_held();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900658 arch_unoptimize_kprobe(op);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900659 if (kprobe_disabled(&op->kp))
660 arch_disarm_kprobe(&op->kp);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500661}
662
663/* Unoptimize a kprobe if p is optimized */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900664static void unoptimize_kprobe(struct kprobe *p, bool force)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500665{
666 struct optimized_kprobe *op;
667
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900668 if (!kprobe_aggrprobe(p) || kprobe_disarmed(p))
669 return; /* This is not an optprobe nor optimized */
670
671 op = container_of(p, struct optimized_kprobe, kp);
672 if (!kprobe_optimized(p)) {
673 /* Unoptimized or unoptimizing case */
674 if (force && !list_empty(&op->list)) {
675 /*
676 * Only if this is unoptimizing kprobe and forced,
677 * forcibly unoptimize it. (No need to unoptimize
678 * unoptimized kprobe again :)
679 */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500680 list_del_init(&op->list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900681 force_unoptimize_kprobe(op);
682 }
683 return;
684 }
685
686 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
687 if (!list_empty(&op->list)) {
688 /* Dequeue from the optimization queue */
689 list_del_init(&op->list);
690 return;
691 }
692 /* Optimized kprobe case */
693 if (force)
694 /* Forcibly update the code: this is a special case */
695 force_unoptimize_kprobe(op);
696 else {
697 list_add(&op->list, &unoptimizing_list);
698 kick_kprobe_optimizer();
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500699 }
700}
701
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900702/* Cancel unoptimizing for reusing */
703static void reuse_unused_kprobe(struct kprobe *ap)
704{
705 struct optimized_kprobe *op;
706
707 BUG_ON(!kprobe_unused(ap));
708 /*
709 * Unused kprobe MUST be on the way of delayed unoptimizing (means
710 * there is still a relative jump) and disabled.
711 */
712 op = container_of(ap, struct optimized_kprobe, kp);
713 if (unlikely(list_empty(&op->list)))
714 printk(KERN_WARNING "Warning: found a stray unused "
715 "aggrprobe@%p\n", ap->addr);
716 /* Enable the probe again */
717 ap->flags &= ~KPROBE_FLAG_DISABLED;
718 /* Optimize it again (remove from op->list) */
719 BUG_ON(!kprobe_optready(ap));
720 optimize_kprobe(ap);
721}
722
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500723/* Remove optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900724static void kill_optimized_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500725{
726 struct optimized_kprobe *op;
727
728 op = container_of(p, struct optimized_kprobe, kp);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900729 if (!list_empty(&op->list))
730 /* Dequeue from the (un)optimization queue */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500731 list_del_init(&op->list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900732 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900733
734 if (kprobe_unused(p)) {
735 /* Enqueue if it is unused */
736 list_add(&op->list, &freeing_list);
737 /*
738 * Remove unused probes from the hash list. After waiting
739 * for synchronization, this probe is reclaimed.
740 * (reclaiming is done by do_free_cleaned_kprobes().)
741 */
742 hlist_del_rcu(&op->kp.hlist);
743 }
744
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900745 /* Don't touch the code, because it is already freed. */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500746 arch_remove_optimized_kprobe(op);
747}
748
Masami Hiramatsua4602462017-04-19 18:22:25 +0530749static inline
750void __prepare_optimized_kprobe(struct optimized_kprobe *op, struct kprobe *p)
751{
752 if (!kprobe_ftrace(p))
753 arch_prepare_optimized_kprobe(op, p);
754}
755
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500756/* Try to prepare optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900757static void prepare_optimized_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500758{
759 struct optimized_kprobe *op;
760
761 op = container_of(p, struct optimized_kprobe, kp);
Masami Hiramatsua4602462017-04-19 18:22:25 +0530762 __prepare_optimized_kprobe(op, p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500763}
764
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500765/* Allocate new optimized_kprobe and try to prepare optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900766static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500767{
768 struct optimized_kprobe *op;
769
770 op = kzalloc(sizeof(struct optimized_kprobe), GFP_KERNEL);
771 if (!op)
772 return NULL;
773
774 INIT_LIST_HEAD(&op->list);
775 op->kp.addr = p->addr;
Masami Hiramatsua4602462017-04-19 18:22:25 +0530776 __prepare_optimized_kprobe(op, p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500777
778 return &op->kp;
779}
780
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900781static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500782
783/*
784 * Prepare an optimized_kprobe and optimize it
785 * NOTE: p must be a normal registered kprobe
786 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900787static void try_to_optimize_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500788{
789 struct kprobe *ap;
790 struct optimized_kprobe *op;
791
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900792 /* Impossible to optimize ftrace-based kprobe */
793 if (kprobe_ftrace(p))
794 return;
795
Masami Hiramatsu25764282012-06-05 19:28:26 +0900796 /* For preparing optimization, jump_label_text_reserved() is called */
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200797 cpus_read_lock();
Masami Hiramatsu25764282012-06-05 19:28:26 +0900798 jump_label_lock();
799 mutex_lock(&text_mutex);
800
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500801 ap = alloc_aggr_kprobe(p);
802 if (!ap)
Masami Hiramatsu25764282012-06-05 19:28:26 +0900803 goto out;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500804
805 op = container_of(ap, struct optimized_kprobe, kp);
806 if (!arch_prepared_optinsn(&op->optinsn)) {
807 /* If failed to setup optimizing, fallback to kprobe */
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900808 arch_remove_optimized_kprobe(op);
809 kfree(op);
Masami Hiramatsu25764282012-06-05 19:28:26 +0900810 goto out;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500811 }
812
813 init_aggr_kprobe(ap, p);
Masami Hiramatsu25764282012-06-05 19:28:26 +0900814 optimize_kprobe(ap); /* This just kicks optimizer thread */
815
816out:
817 mutex_unlock(&text_mutex);
818 jump_label_unlock();
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200819 cpus_read_unlock();
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500820}
821
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500822#ifdef CONFIG_SYSCTL
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900823static void optimize_all_kprobes(void)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500824{
825 struct hlist_head *head;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500826 struct kprobe *p;
827 unsigned int i;
828
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900829 mutex_lock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500830 /* If optimization is already allowed, just return */
831 if (kprobes_allow_optimization)
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900832 goto out;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500833
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200834 cpus_read_lock();
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500835 kprobes_allow_optimization = true;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500836 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
837 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800838 hlist_for_each_entry_rcu(p, head, hlist)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500839 if (!kprobe_disabled(p))
840 optimize_kprobe(p);
841 }
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200842 cpus_read_unlock();
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500843 printk(KERN_INFO "Kprobes globally optimized\n");
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900844out:
845 mutex_unlock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500846}
847
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900848static void unoptimize_all_kprobes(void)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500849{
850 struct hlist_head *head;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500851 struct kprobe *p;
852 unsigned int i;
853
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900854 mutex_lock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500855 /* If optimization is already prohibited, just return */
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900856 if (!kprobes_allow_optimization) {
857 mutex_unlock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500858 return;
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900859 }
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500860
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200861 cpus_read_lock();
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500862 kprobes_allow_optimization = false;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500863 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
864 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800865 hlist_for_each_entry_rcu(p, head, hlist) {
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500866 if (!kprobe_disabled(p))
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900867 unoptimize_kprobe(p, false);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500868 }
869 }
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200870 cpus_read_unlock();
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900871 mutex_unlock(&kprobe_mutex);
872
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900873 /* Wait for unoptimizing completion */
874 wait_for_kprobe_optimizer();
875 printk(KERN_INFO "Kprobes globally unoptimized\n");
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500876}
877
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900878static DEFINE_MUTEX(kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500879int sysctl_kprobes_optimization;
880int proc_kprobes_optimization_handler(struct ctl_table *table, int write,
881 void __user *buffer, size_t *length,
882 loff_t *ppos)
883{
884 int ret;
885
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900886 mutex_lock(&kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500887 sysctl_kprobes_optimization = kprobes_allow_optimization ? 1 : 0;
888 ret = proc_dointvec_minmax(table, write, buffer, length, ppos);
889
890 if (sysctl_kprobes_optimization)
891 optimize_all_kprobes();
892 else
893 unoptimize_all_kprobes();
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900894 mutex_unlock(&kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500895
896 return ret;
897}
898#endif /* CONFIG_SYSCTL */
899
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900900/* Put a breakpoint for a probe. Must be called with text_mutex locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900901static void __arm_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500902{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900903 struct kprobe *_p;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500904
905 /* Check collision with other optimized kprobes */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900906 _p = get_optimized_kprobe((unsigned long)p->addr);
907 if (unlikely(_p))
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900908 /* Fallback to unoptimized kprobe */
909 unoptimize_kprobe(_p, true);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500910
911 arch_arm_kprobe(p);
912 optimize_kprobe(p); /* Try to optimize (add kprobe to a list) */
913}
914
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900915/* Remove the breakpoint of a probe. Must be called with text_mutex locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900916static void __disarm_kprobe(struct kprobe *p, bool reopt)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500917{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900918 struct kprobe *_p;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500919
Wang Nan69d54b92015-02-13 14:40:26 -0800920 /* Try to unoptimize */
921 unoptimize_kprobe(p, kprobes_all_disarmed);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500922
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900923 if (!kprobe_queued(p)) {
924 arch_disarm_kprobe(p);
925 /* If another kprobe was blocked, optimize it. */
926 _p = get_optimized_kprobe((unsigned long)p->addr);
927 if (unlikely(_p) && reopt)
928 optimize_kprobe(_p);
929 }
930 /* TODO: reoptimize others after unoptimized this probe */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500931}
932
933#else /* !CONFIG_OPTPROBES */
934
935#define optimize_kprobe(p) do {} while (0)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900936#define unoptimize_kprobe(p, f) do {} while (0)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500937#define kill_optimized_kprobe(p) do {} while (0)
938#define prepare_optimized_kprobe(p) do {} while (0)
939#define try_to_optimize_kprobe(p) do {} while (0)
940#define __arm_kprobe(p) arch_arm_kprobe(p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900941#define __disarm_kprobe(p, o) arch_disarm_kprobe(p)
942#define kprobe_disarmed(p) kprobe_disabled(p)
943#define wait_for_kprobe_optimizer() do {} while (0)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500944
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900945/* There should be no unused kprobes can be reused without optimization */
946static void reuse_unused_kprobe(struct kprobe *ap)
947{
948 printk(KERN_ERR "Error: There should be no unused kprobe here.\n");
949 BUG_ON(kprobe_unused(ap));
950}
951
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900952static void free_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500953{
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900954 arch_remove_kprobe(p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500955 kfree(p);
956}
957
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900958static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500959{
960 return kzalloc(sizeof(struct kprobe), GFP_KERNEL);
961}
962#endif /* CONFIG_OPTPROBES */
963
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +0900964#ifdef CONFIG_KPROBES_ON_FTRACE
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900965static struct ftrace_ops kprobe_ftrace_ops __read_mostly = {
Masami Hiramatsue5253892012-06-05 19:28:38 +0900966 .func = kprobe_ftrace_handler,
Masami Hiramatsu1d70be32014-11-21 05:25:23 -0500967 .flags = FTRACE_OPS_FL_SAVE_REGS | FTRACE_OPS_FL_IPMODIFY,
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900968};
969static int kprobe_ftrace_enabled;
970
971/* Must ensure p->addr is really on ftrace */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900972static int prepare_kprobe(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900973{
974 if (!kprobe_ftrace(p))
975 return arch_prepare_kprobe(p);
976
977 return arch_prepare_kprobe_ftrace(p);
978}
979
980/* Caller must lock kprobe_mutex */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900981static void arm_kprobe_ftrace(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900982{
983 int ret;
984
985 ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
986 (unsigned long)p->addr, 0, 0);
987 WARN(ret < 0, "Failed to arm kprobe-ftrace at %p (%d)\n", p->addr, ret);
988 kprobe_ftrace_enabled++;
989 if (kprobe_ftrace_enabled == 1) {
990 ret = register_ftrace_function(&kprobe_ftrace_ops);
991 WARN(ret < 0, "Failed to init kprobe-ftrace (%d)\n", ret);
992 }
993}
994
995/* Caller must lock kprobe_mutex */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900996static void disarm_kprobe_ftrace(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900997{
998 int ret;
999
1000 kprobe_ftrace_enabled--;
1001 if (kprobe_ftrace_enabled == 0) {
1002 ret = unregister_ftrace_function(&kprobe_ftrace_ops);
1003 WARN(ret < 0, "Failed to init kprobe-ftrace (%d)\n", ret);
1004 }
1005 ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
1006 (unsigned long)p->addr, 1, 0);
1007 WARN(ret < 0, "Failed to disarm kprobe-ftrace at %p (%d)\n", p->addr, ret);
1008}
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001009#else /* !CONFIG_KPROBES_ON_FTRACE */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001010#define prepare_kprobe(p) arch_prepare_kprobe(p)
1011#define arm_kprobe_ftrace(p) do {} while (0)
1012#define disarm_kprobe_ftrace(p) do {} while (0)
1013#endif
1014
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001015/* Arm a kprobe with text_mutex */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001016static void arm_kprobe(struct kprobe *kp)
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001017{
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001018 if (unlikely(kprobe_ftrace(kp))) {
1019 arm_kprobe_ftrace(kp);
1020 return;
1021 }
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001022 cpus_read_lock();
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001023 mutex_lock(&text_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001024 __arm_kprobe(kp);
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001025 mutex_unlock(&text_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001026 cpus_read_unlock();
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001027}
1028
1029/* Disarm a kprobe with text_mutex */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001030static void disarm_kprobe(struct kprobe *kp, bool reopt)
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001031{
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001032 if (unlikely(kprobe_ftrace(kp))) {
1033 disarm_kprobe_ftrace(kp);
1034 return;
1035 }
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001036
1037 cpus_read_lock();
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001038 mutex_lock(&text_mutex);
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001039 __disarm_kprobe(kp, reopt);
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001040 mutex_unlock(&text_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001041 cpus_read_unlock();
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001042}
1043
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001044/*
1045 * Aggregate handlers for multiple kprobes support - these handlers
1046 * take care of invoking the individual kprobe handlers on p->list
1047 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001048static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001049{
1050 struct kprobe *kp;
1051
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001052 list_for_each_entry_rcu(kp, &p->list, list) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001053 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001054 set_kprobe_instance(kp);
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001055 if (kp->pre_handler(kp, regs))
1056 return 1;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001057 }
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001058 reset_kprobe_instance();
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001059 }
1060 return 0;
1061}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001062NOKPROBE_SYMBOL(aggr_pre_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001063
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001064static void aggr_post_handler(struct kprobe *p, struct pt_regs *regs,
1065 unsigned long flags)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001066{
1067 struct kprobe *kp;
1068
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001069 list_for_each_entry_rcu(kp, &p->list, list) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001070 if (kp->post_handler && likely(!kprobe_disabled(kp))) {
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001071 set_kprobe_instance(kp);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001072 kp->post_handler(kp, regs, flags);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001073 reset_kprobe_instance();
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001074 }
1075 }
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001076}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001077NOKPROBE_SYMBOL(aggr_post_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001078
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001079static int aggr_fault_handler(struct kprobe *p, struct pt_regs *regs,
1080 int trapnr)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001081{
Christoph Lameterb76834b2010-12-06 11:16:25 -06001082 struct kprobe *cur = __this_cpu_read(kprobe_instance);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001083
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001084 /*
1085 * if we faulted "during" the execution of a user specified
1086 * probe handler, invoke just that probe's fault handler
1087 */
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001088 if (cur && cur->fault_handler) {
1089 if (cur->fault_handler(cur, regs, trapnr))
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001090 return 1;
1091 }
1092 return 0;
1093}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001094NOKPROBE_SYMBOL(aggr_fault_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001095
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001096static int aggr_break_handler(struct kprobe *p, struct pt_regs *regs)
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001097{
Christoph Lameterb76834b2010-12-06 11:16:25 -06001098 struct kprobe *cur = __this_cpu_read(kprobe_instance);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001099 int ret = 0;
1100
1101 if (cur && cur->break_handler) {
1102 if (cur->break_handler(cur, regs))
1103 ret = 1;
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001104 }
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001105 reset_kprobe_instance();
1106 return ret;
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001107}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001108NOKPROBE_SYMBOL(aggr_break_handler);
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001109
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001110/* Walks the list and increments nmissed count for multiprobe case */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001111void kprobes_inc_nmissed_count(struct kprobe *p)
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001112{
1113 struct kprobe *kp;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001114 if (!kprobe_aggrprobe(p)) {
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001115 p->nmissed++;
1116 } else {
1117 list_for_each_entry_rcu(kp, &p->list, list)
1118 kp->nmissed++;
1119 }
1120 return;
1121}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001122NOKPROBE_SYMBOL(kprobes_inc_nmissed_count);
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001123
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001124void recycle_rp_inst(struct kretprobe_instance *ri,
1125 struct hlist_head *head)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001126{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001127 struct kretprobe *rp = ri->rp;
1128
Hien Nguyenb94cce92005-06-23 00:09:19 -07001129 /* remove rp inst off the rprobe_inst_table */
1130 hlist_del(&ri->hlist);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001131 INIT_HLIST_NODE(&ri->hlist);
1132 if (likely(rp)) {
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001133 raw_spin_lock(&rp->lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001134 hlist_add_head(&ri->hlist, &rp->free_instances);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001135 raw_spin_unlock(&rp->lock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001136 } else
1137 /* Unregistering */
bibo,mao99219a32006-10-02 02:17:35 -07001138 hlist_add_head(&ri->hlist, head);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001139}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001140NOKPROBE_SYMBOL(recycle_rp_inst);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001141
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001142void kretprobe_hash_lock(struct task_struct *tsk,
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001143 struct hlist_head **head, unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001144__acquires(hlist_lock)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001145{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001146 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001147 raw_spinlock_t *hlist_lock;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001148
1149 *head = &kretprobe_inst_table[hash];
1150 hlist_lock = kretprobe_table_lock_ptr(hash);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001151 raw_spin_lock_irqsave(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001152}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001153NOKPROBE_SYMBOL(kretprobe_hash_lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001154
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001155static void kretprobe_table_lock(unsigned long hash,
1156 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001157__acquires(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001158{
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001159 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1160 raw_spin_lock_irqsave(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001161}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001162NOKPROBE_SYMBOL(kretprobe_table_lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001163
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001164void kretprobe_hash_unlock(struct task_struct *tsk,
1165 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001166__releases(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001167{
1168 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001169 raw_spinlock_t *hlist_lock;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001170
1171 hlist_lock = kretprobe_table_lock_ptr(hash);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001172 raw_spin_unlock_irqrestore(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001173}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001174NOKPROBE_SYMBOL(kretprobe_hash_unlock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001175
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001176static void kretprobe_table_unlock(unsigned long hash,
1177 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001178__releases(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001179{
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001180 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1181 raw_spin_unlock_irqrestore(hlist_lock, *flags);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001182}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001183NOKPROBE_SYMBOL(kretprobe_table_unlock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001184
Hien Nguyenb94cce92005-06-23 00:09:19 -07001185/*
bibo maoc6fd91f2006-03-26 01:38:20 -08001186 * This function is called from finish_task_switch when task tk becomes dead,
1187 * so that we can recycle any function-return probe instances associated
1188 * with this task. These left over instances represent probed functions
1189 * that have been called but will never return.
Hien Nguyenb94cce92005-06-23 00:09:19 -07001190 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001191void kprobe_flush_task(struct task_struct *tk)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001192{
bibo,mao62c27be2006-10-02 02:17:33 -07001193 struct kretprobe_instance *ri;
bibo,mao99219a32006-10-02 02:17:35 -07001194 struct hlist_head *head, empty_rp;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001195 struct hlist_node *tmp;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001196 unsigned long hash, flags = 0;
Rusty Lynch802eae72005-06-27 15:17:08 -07001197
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001198 if (unlikely(!kprobes_initialized))
1199 /* Early boot. kretprobe_table_locks not yet initialized. */
1200 return;
1201
Ananth N Mavinakayanahallid496aab2012-01-20 14:34:04 -08001202 INIT_HLIST_HEAD(&empty_rp);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001203 hash = hash_ptr(tk, KPROBE_HASH_BITS);
1204 head = &kretprobe_inst_table[hash];
1205 kretprobe_table_lock(hash, &flags);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001206 hlist_for_each_entry_safe(ri, tmp, head, hlist) {
bibo,mao62c27be2006-10-02 02:17:33 -07001207 if (ri->task == tk)
bibo,mao99219a32006-10-02 02:17:35 -07001208 recycle_rp_inst(ri, &empty_rp);
bibo,mao62c27be2006-10-02 02:17:33 -07001209 }
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001210 kretprobe_table_unlock(hash, &flags);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001211 hlist_for_each_entry_safe(ri, tmp, &empty_rp, hlist) {
bibo,mao99219a32006-10-02 02:17:35 -07001212 hlist_del(&ri->hlist);
1213 kfree(ri);
1214 }
Hien Nguyenb94cce92005-06-23 00:09:19 -07001215}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001216NOKPROBE_SYMBOL(kprobe_flush_task);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001217
Hien Nguyenb94cce92005-06-23 00:09:19 -07001218static inline void free_rp_inst(struct kretprobe *rp)
1219{
1220 struct kretprobe_instance *ri;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001221 struct hlist_node *next;
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001222
Sasha Levinb67bfe02013-02-27 17:06:00 -08001223 hlist_for_each_entry_safe(ri, next, &rp->free_instances, hlist) {
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001224 hlist_del(&ri->hlist);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001225 kfree(ri);
1226 }
1227}
1228
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001229static void cleanup_rp_inst(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001230{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001231 unsigned long flags, hash;
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001232 struct kretprobe_instance *ri;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001233 struct hlist_node *next;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001234 struct hlist_head *head;
1235
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001236 /* No race here */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001237 for (hash = 0; hash < KPROBE_TABLE_SIZE; hash++) {
1238 kretprobe_table_lock(hash, &flags);
1239 head = &kretprobe_inst_table[hash];
Sasha Levinb67bfe02013-02-27 17:06:00 -08001240 hlist_for_each_entry_safe(ri, next, head, hlist) {
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001241 if (ri->rp == rp)
1242 ri->rp = NULL;
1243 }
1244 kretprobe_table_unlock(hash, &flags);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001245 }
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001246 free_rp_inst(rp);
1247}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001248NOKPROBE_SYMBOL(cleanup_rp_inst);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001249
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001250/*
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001251* Add the new probe to ap->list. Fail if this is the
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001252* second jprobe at the address - two jprobes can't coexist
1253*/
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001254static int add_new_kprobe(struct kprobe *ap, struct kprobe *p)
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001255{
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001256 BUG_ON(kprobe_gone(ap) || kprobe_gone(p));
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001257
1258 if (p->break_handler || p->post_handler)
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001259 unoptimize_kprobe(ap, true); /* Fall back to normal kprobe */
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001260
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001261 if (p->break_handler) {
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001262 if (ap->break_handler)
mao, bibo36721652006-06-26 00:25:22 -07001263 return -EEXIST;
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001264 list_add_tail_rcu(&p->list, &ap->list);
1265 ap->break_handler = aggr_break_handler;
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001266 } else
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001267 list_add_rcu(&p->list, &ap->list);
1268 if (p->post_handler && !ap->post_handler)
1269 ap->post_handler = aggr_post_handler;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001270
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001271 return 0;
1272}
1273
1274/*
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001275 * Fill in the required fields of the "manager kprobe". Replace the
1276 * earlier kprobe in the hlist with the manager kprobe
1277 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001278static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001279{
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001280 /* Copy p's insn slot to ap */
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001281 copy_kprobe(p, ap);
bibo, maoa9ad9652006-07-30 03:03:26 -07001282 flush_insn_slot(ap);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001283 ap->addr = p->addr;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001284 ap->flags = p->flags & ~KPROBE_FLAG_OPTIMIZED;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001285 ap->pre_handler = aggr_pre_handler;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001286 ap->fault_handler = aggr_fault_handler;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001287 /* We don't care the kprobe which has gone. */
1288 if (p->post_handler && !kprobe_gone(p))
mao, bibo36721652006-06-26 00:25:22 -07001289 ap->post_handler = aggr_post_handler;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001290 if (p->break_handler && !kprobe_gone(p))
mao, bibo36721652006-06-26 00:25:22 -07001291 ap->break_handler = aggr_break_handler;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001292
1293 INIT_LIST_HEAD(&ap->list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001294 INIT_HLIST_NODE(&ap->hlist);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001295
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001296 list_add_rcu(&p->list, &ap->list);
Keshavamurthy Anil Sadad0f32005-12-12 00:37:12 -08001297 hlist_replace_rcu(&p->hlist, &ap->hlist);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001298}
1299
1300/*
1301 * This is the second or subsequent kprobe at the address - handle
1302 * the intricacies
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001303 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001304static int register_aggr_kprobe(struct kprobe *orig_p, struct kprobe *p)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001305{
1306 int ret = 0;
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001307 struct kprobe *ap = orig_p;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001308
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001309 cpus_read_lock();
1310
Masami Hiramatsu25764282012-06-05 19:28:26 +09001311 /* For preparing optimization, jump_label_text_reserved() is called */
1312 jump_label_lock();
Masami Hiramatsu25764282012-06-05 19:28:26 +09001313 mutex_lock(&text_mutex);
1314
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001315 if (!kprobe_aggrprobe(orig_p)) {
1316 /* If orig_p is not an aggr_kprobe, create new aggr_kprobe. */
1317 ap = alloc_aggr_kprobe(orig_p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001318 if (!ap) {
1319 ret = -ENOMEM;
1320 goto out;
1321 }
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001322 init_aggr_kprobe(ap, orig_p);
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001323 } else if (kprobe_unused(ap))
Masami Hiramatsu0490cd12010-12-03 18:54:16 +09001324 /* This probe is going to die. Rescue it */
1325 reuse_unused_kprobe(ap);
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001326
1327 if (kprobe_gone(ap)) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001328 /*
1329 * Attempting to insert new probe at the same location that
1330 * had a probe in the module vaddr area which already
1331 * freed. So, the instruction slot has already been
1332 * released. We need a new slot for the new probe.
1333 */
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001334 ret = arch_prepare_kprobe(ap);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001335 if (ret)
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001336 /*
1337 * Even if fail to allocate new slot, don't need to
1338 * free aggr_probe. It will be used next time, or
1339 * freed by unregister_kprobe.
1340 */
Masami Hiramatsu25764282012-06-05 19:28:26 +09001341 goto out;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001342
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001343 /* Prepare optimized instructions if possible. */
1344 prepare_optimized_kprobe(ap);
1345
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001346 /*
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001347 * Clear gone flag to prevent allocating new slot again, and
1348 * set disabled flag because it is not armed yet.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001349 */
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001350 ap->flags = (ap->flags & ~KPROBE_FLAG_GONE)
1351 | KPROBE_FLAG_DISABLED;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001352 }
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001353
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001354 /* Copy ap's insn slot to p */
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001355 copy_kprobe(ap, p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001356 ret = add_new_kprobe(ap, p);
1357
1358out:
1359 mutex_unlock(&text_mutex);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001360 jump_label_unlock();
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001361 cpus_read_unlock();
Masami Hiramatsu25764282012-06-05 19:28:26 +09001362
1363 if (ret == 0 && kprobe_disabled(ap) && !kprobe_disabled(p)) {
1364 ap->flags &= ~KPROBE_FLAG_DISABLED;
1365 if (!kprobes_all_disarmed)
1366 /* Arm the breakpoint again. */
1367 arm_kprobe(ap);
1368 }
1369 return ret;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001370}
1371
Masami Hiramatsube8f2742014-04-17 17:16:58 +09001372bool __weak arch_within_kprobe_blacklist(unsigned long addr)
1373{
1374 /* The __kprobes marked functions and entry code must not be probed */
1375 return addr >= (unsigned long)__kprobes_text_start &&
1376 addr < (unsigned long)__kprobes_text_end;
1377}
1378
Andy Lutomirskie5779e82015-07-30 20:32:40 -07001379bool within_kprobe_blacklist(unsigned long addr)
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001380{
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001381 struct kprobe_blacklist_entry *ent;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001382
Masami Hiramatsube8f2742014-04-17 17:16:58 +09001383 if (arch_within_kprobe_blacklist(addr))
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001384 return true;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001385 /*
1386 * If there exists a kprobe_blacklist, verify and
1387 * fail any probe registration in the prohibited area
1388 */
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001389 list_for_each_entry(ent, &kprobe_blacklist, list) {
1390 if (addr >= ent->start_addr && addr < ent->end_addr)
1391 return true;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001392 }
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001393
1394 return false;
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001395}
1396
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001397/*
1398 * If we have a symbol_name argument, look it up and add the offset field
1399 * to it. This way, we can specify a relative address to a symbol.
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001400 * This returns encoded errors if it fails to look up symbol or invalid
1401 * combination of parameters.
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001402 */
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301403static kprobe_opcode_t *_kprobe_addr(kprobe_opcode_t *addr,
1404 const char *symbol_name, unsigned int offset)
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001405{
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301406 if ((symbol_name && addr) || (!symbol_name && !addr))
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001407 goto invalid;
1408
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301409 if (symbol_name) {
Linus Torvalds7246f602017-05-05 11:36:44 -07001410 addr = kprobe_lookup_name(symbol_name, offset);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001411 if (!addr)
1412 return ERR_PTR(-ENOENT);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001413 }
1414
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301415 addr = (kprobe_opcode_t *)(((char *)addr) + offset);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001416 if (addr)
1417 return addr;
1418
1419invalid:
1420 return ERR_PTR(-EINVAL);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001421}
1422
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301423static kprobe_opcode_t *kprobe_addr(struct kprobe *p)
1424{
1425 return _kprobe_addr(p->addr, p->symbol_name, p->offset);
1426}
1427
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301428/* Check passed kprobe is valid and return kprobe in kprobe_table. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001429static struct kprobe *__get_valid_kprobe(struct kprobe *p)
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301430{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001431 struct kprobe *ap, *list_p;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301432
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001433 ap = get_kprobe(p->addr);
1434 if (unlikely(!ap))
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301435 return NULL;
1436
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001437 if (p != ap) {
1438 list_for_each_entry_rcu(list_p, &ap->list, list)
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301439 if (list_p == p)
1440 /* kprobe p is a valid probe */
1441 goto valid;
1442 return NULL;
1443 }
1444valid:
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001445 return ap;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301446}
1447
1448/* Return error if the kprobe is being re-registered */
1449static inline int check_kprobe_rereg(struct kprobe *p)
1450{
1451 int ret = 0;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301452
1453 mutex_lock(&kprobe_mutex);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001454 if (__get_valid_kprobe(p))
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301455 ret = -EINVAL;
1456 mutex_unlock(&kprobe_mutex);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001457
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301458 return ret;
1459}
1460
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001461int __weak arch_check_ftrace_location(struct kprobe *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462{
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001463 unsigned long ftrace_addr;
1464
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001465 ftrace_addr = ftrace_location((unsigned long)p->addr);
1466 if (ftrace_addr) {
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001467#ifdef CONFIG_KPROBES_ON_FTRACE
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001468 /* Given address is not on the instruction boundary */
1469 if ((unsigned long)p->addr != ftrace_addr)
1470 return -EILSEQ;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001471 p->flags |= KPROBE_FLAG_FTRACE;
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001472#else /* !CONFIG_KPROBES_ON_FTRACE */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001473 return -EINVAL;
1474#endif
1475 }
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001476 return 0;
1477}
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001478
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001479static int check_kprobe_address_safe(struct kprobe *p,
1480 struct module **probed_mod)
1481{
1482 int ret;
1483
1484 ret = arch_check_ftrace_location(p);
1485 if (ret)
1486 return ret;
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001487 jump_label_lock();
1488 preempt_disable();
1489
1490 /* Ensure it is not in reserved area nor out of text */
1491 if (!kernel_text_address((unsigned long) p->addr) ||
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001492 within_kprobe_blacklist((unsigned long) p->addr) ||
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001493 jump_label_text_reserved(p->addr, p->addr)) {
1494 ret = -EINVAL;
1495 goto out;
1496 }
1497
1498 /* Check if are we probing a module */
1499 *probed_mod = __module_text_address((unsigned long) p->addr);
1500 if (*probed_mod) {
1501 /*
1502 * We must hold a refcount of the probed module while updating
1503 * its code to prohibit unexpected unloading.
1504 */
1505 if (unlikely(!try_module_get(*probed_mod))) {
1506 ret = -ENOENT;
1507 goto out;
1508 }
1509
1510 /*
1511 * If the module freed .init.text, we couldn't insert
1512 * kprobes in there.
1513 */
1514 if (within_module_init((unsigned long)p->addr, *probed_mod) &&
1515 (*probed_mod)->state != MODULE_STATE_COMING) {
1516 module_put(*probed_mod);
1517 *probed_mod = NULL;
1518 ret = -ENOENT;
1519 }
1520 }
1521out:
1522 preempt_enable();
1523 jump_label_unlock();
1524
1525 return ret;
1526}
1527
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001528int register_kprobe(struct kprobe *p)
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001529{
1530 int ret;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001531 struct kprobe *old_p;
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001532 struct module *probed_mod;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001533 kprobe_opcode_t *addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001535 /* Adjust probe address from symbol */
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001536 addr = kprobe_addr(p);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001537 if (IS_ERR(addr))
1538 return PTR_ERR(addr);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001539 p->addr = addr;
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -07001540
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301541 ret = check_kprobe_rereg(p);
1542 if (ret)
1543 return ret;
1544
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001545 /* User can pass only KPROBE_FLAG_DISABLED to register_kprobe */
1546 p->flags &= KPROBE_FLAG_DISABLED;
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001547 p->nmissed = 0;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001548 INIT_LIST_HEAD(&p->list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001549
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001550 ret = check_kprobe_address_safe(p, &probed_mod);
1551 if (ret)
1552 return ret;
1553
1554 mutex_lock(&kprobe_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001555
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001556 old_p = get_kprobe(p->addr);
1557 if (old_p) {
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001558 /* Since this may unoptimize old_p, locking text_mutex. */
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001559 ret = register_aggr_kprobe(old_p, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560 goto out;
1561 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001563 cpus_read_lock();
1564 /* Prevent text modification */
1565 mutex_lock(&text_mutex);
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001566 ret = prepare_kprobe(p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001567 mutex_unlock(&text_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001568 cpus_read_unlock();
Christoph Hellwig6f716ac2007-05-08 00:34:13 -07001569 if (ret)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001570 goto out;
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001571
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001572 INIT_HLIST_NODE(&p->hlist);
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001573 hlist_add_head_rcu(&p->hlist,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574 &kprobe_table[hash_ptr(p->addr, KPROBE_HASH_BITS)]);
1575
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001576 if (!kprobes_all_disarmed && !kprobe_disabled(p))
Masami Hiramatsu25764282012-06-05 19:28:26 +09001577 arm_kprobe(p);
Christoph Hellwig74a0b572007-10-16 01:24:07 -07001578
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001579 /* Try to optimize kprobe */
1580 try_to_optimize_kprobe(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581out:
Ingo Molnar7a7d1cf2006-03-23 03:00:35 -08001582 mutex_unlock(&kprobe_mutex);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001583
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001584 if (probed_mod)
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001585 module_put(probed_mod);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001586
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587 return ret;
1588}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001589EXPORT_SYMBOL_GPL(register_kprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001591/* Check if all probes on the aggrprobe are disabled */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001592static int aggr_kprobe_disabled(struct kprobe *ap)
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001593{
1594 struct kprobe *kp;
1595
1596 list_for_each_entry_rcu(kp, &ap->list, list)
1597 if (!kprobe_disabled(kp))
1598 /*
1599 * There is an active probe on the list.
1600 * We can't disable this ap.
1601 */
1602 return 0;
1603
1604 return 1;
1605}
1606
1607/* Disable one kprobe: Make sure called under kprobe_mutex is locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001608static struct kprobe *__disable_kprobe(struct kprobe *p)
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001609{
1610 struct kprobe *orig_p;
1611
1612 /* Get an original kprobe for return */
1613 orig_p = __get_valid_kprobe(p);
1614 if (unlikely(orig_p == NULL))
1615 return NULL;
1616
1617 if (!kprobe_disabled(p)) {
1618 /* Disable probe if it is a child probe */
1619 if (p != orig_p)
1620 p->flags |= KPROBE_FLAG_DISABLED;
1621
1622 /* Try to disarm and disable this/parent probe */
1623 if (p == orig_p || aggr_kprobe_disabled(orig_p)) {
Wang Nan69d54b92015-02-13 14:40:26 -08001624 /*
1625 * If kprobes_all_disarmed is set, orig_p
1626 * should have already been disarmed, so
1627 * skip unneed disarming process.
1628 */
1629 if (!kprobes_all_disarmed)
1630 disarm_kprobe(orig_p, true);
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001631 orig_p->flags |= KPROBE_FLAG_DISABLED;
1632 }
1633 }
1634
1635 return orig_p;
1636}
1637
Masami Hiramatsu98616682008-04-28 02:14:28 -07001638/*
1639 * Unregister a kprobe without a scheduler synchronization.
1640 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001641static int __unregister_kprobe_top(struct kprobe *p)
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001642{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001643 struct kprobe *ap, *list_p;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001644
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001645 /* Disable kprobe. This will disarm it if needed. */
1646 ap = __disable_kprobe(p);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001647 if (ap == NULL)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001648 return -EINVAL;
1649
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001650 if (ap == p)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001651 /*
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001652 * This probe is an independent(and non-optimized) kprobe
1653 * (not an aggrprobe). Remove from the hash list.
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001654 */
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001655 goto disarmed;
1656
1657 /* Following process expects this probe is an aggrprobe */
1658 WARN_ON(!kprobe_aggrprobe(ap));
1659
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001660 if (list_is_singular(&ap->list) && kprobe_disarmed(ap))
1661 /*
1662 * !disarmed could be happen if the probe is under delayed
1663 * unoptimizing.
1664 */
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001665 goto disarmed;
1666 else {
1667 /* If disabling probe has special handlers, update aggrprobe */
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001668 if (p->break_handler && !kprobe_gone(p))
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001669 ap->break_handler = NULL;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001670 if (p->post_handler && !kprobe_gone(p)) {
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001671 list_for_each_entry_rcu(list_p, &ap->list, list) {
Masami Hiramatsu98616682008-04-28 02:14:28 -07001672 if ((list_p != p) && (list_p->post_handler))
1673 goto noclean;
1674 }
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001675 ap->post_handler = NULL;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001676 }
1677noclean:
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001678 /*
1679 * Remove from the aggrprobe: this path will do nothing in
1680 * __unregister_kprobe_bottom().
1681 */
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001682 list_del_rcu(&p->list);
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001683 if (!kprobe_disabled(ap) && !kprobes_all_disarmed)
1684 /*
1685 * Try to optimize this probe again, because post
1686 * handler may have been changed.
1687 */
1688 optimize_kprobe(ap);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001689 }
Masami Hiramatsu98616682008-04-28 02:14:28 -07001690 return 0;
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001691
1692disarmed:
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001693 BUG_ON(!kprobe_disarmed(ap));
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001694 hlist_del_rcu(&ap->hlist);
1695 return 0;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001696}
Mao, Bibob3e55c72005-12-12 00:37:00 -08001697
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001698static void __unregister_kprobe_bottom(struct kprobe *p)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001699{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001700 struct kprobe *ap;
Mao, Bibob3e55c72005-12-12 00:37:00 -08001701
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001702 if (list_empty(&p->list))
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001703 /* This is an independent kprobe */
Ananth N Mavinakayanahalli0498b632006-01-09 20:52:46 -08001704 arch_remove_kprobe(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001705 else if (list_is_singular(&p->list)) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001706 /* This is the last child of an aggrprobe */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001707 ap = list_entry(p->list.next, struct kprobe, list);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001708 list_del(&p->list);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001709 free_aggr_kprobe(ap);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001710 }
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001711 /* Otherwise, do nothing. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712}
1713
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001714int register_kprobes(struct kprobe **kps, int num)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001715{
1716 int i, ret = 0;
1717
1718 if (num <= 0)
1719 return -EINVAL;
1720 for (i = 0; i < num; i++) {
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001721 ret = register_kprobe(kps[i]);
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001722 if (ret < 0) {
1723 if (i > 0)
1724 unregister_kprobes(kps, i);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001725 break;
1726 }
1727 }
1728 return ret;
1729}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001730EXPORT_SYMBOL_GPL(register_kprobes);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001731
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001732void unregister_kprobe(struct kprobe *p)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001733{
1734 unregister_kprobes(&p, 1);
1735}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001736EXPORT_SYMBOL_GPL(unregister_kprobe);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001737
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001738void unregister_kprobes(struct kprobe **kps, int num)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001739{
1740 int i;
1741
1742 if (num <= 0)
1743 return;
1744 mutex_lock(&kprobe_mutex);
1745 for (i = 0; i < num; i++)
1746 if (__unregister_kprobe_top(kps[i]) < 0)
1747 kps[i]->addr = NULL;
1748 mutex_unlock(&kprobe_mutex);
1749
1750 synchronize_sched();
1751 for (i = 0; i < num; i++)
1752 if (kps[i]->addr)
1753 __unregister_kprobe_bottom(kps[i]);
1754}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001755EXPORT_SYMBOL_GPL(unregister_kprobes);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001756
Naveen N. Rao5f6bee32017-03-08 22:34:15 +05301757int __weak kprobe_exceptions_notify(struct notifier_block *self,
1758 unsigned long val, void *data)
Naveen N. Raofc62d022017-02-08 01:24:14 +05301759{
1760 return NOTIFY_DONE;
1761}
Naveen N. Rao5f6bee32017-03-08 22:34:15 +05301762NOKPROBE_SYMBOL(kprobe_exceptions_notify);
Naveen N. Raofc62d022017-02-08 01:24:14 +05301763
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764static struct notifier_block kprobe_exceptions_nb = {
1765 .notifier_call = kprobe_exceptions_notify,
Anil S Keshavamurthy3d5631e2006-06-26 00:25:28 -07001766 .priority = 0x7fffffff /* we need to be notified first */
1767};
1768
Michael Ellerman3d7e3382007-07-19 01:48:11 -07001769unsigned long __weak arch_deref_entry_point(void *entry)
1770{
1771 return (unsigned long)entry;
1772}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773
Masami Hiramatsu590c8452017-10-06 08:14:37 +09001774#if 0
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001775int register_jprobes(struct jprobe **jps, int num)
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001776{
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001777 int ret = 0, i;
1778
1779 if (num <= 0)
1780 return -EINVAL;
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001781
Naveen N. Rao0f73ff82017-07-07 22:37:25 +05301782 for (i = 0; i < num; i++) {
1783 ret = register_jprobe(jps[i]);
Namhyung Kimedbaadb2010-09-15 10:04:26 +09001784
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001785 if (ret < 0) {
1786 if (i > 0)
1787 unregister_jprobes(jps, i);
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001788 break;
1789 }
1790 }
Naveen N. Rao0f73ff82017-07-07 22:37:25 +05301791
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001792 return ret;
1793}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001794EXPORT_SYMBOL_GPL(register_jprobes);
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001795
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001796int register_jprobe(struct jprobe *jp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797{
Naveen N. Rao0f73ff82017-07-07 22:37:25 +05301798 unsigned long addr, offset;
1799 struct kprobe *kp = &jp->kp;
1800
Naveen N. Raodbf58062017-07-07 22:37:26 +05301801 /*
1802 * Verify probepoint as well as the jprobe handler are
1803 * valid function entry points.
1804 */
Naveen N. Rao0f73ff82017-07-07 22:37:25 +05301805 addr = arch_deref_entry_point(jp->entry);
1806
Naveen N. Raodbf58062017-07-07 22:37:26 +05301807 if (kallsyms_lookup_size_offset(addr, NULL, &offset) && offset == 0 &&
1808 kprobe_on_func_entry(kp->addr, kp->symbol_name, kp->offset)) {
Naveen N. Rao0f73ff82017-07-07 22:37:25 +05301809 kp->pre_handler = setjmp_pre_handler;
1810 kp->break_handler = longjmp_break_handler;
1811 return register_kprobe(kp);
1812 }
1813
1814 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001816EXPORT_SYMBOL_GPL(register_jprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001818void unregister_jprobe(struct jprobe *jp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819{
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001820 unregister_jprobes(&jp, 1);
1821}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001822EXPORT_SYMBOL_GPL(unregister_jprobe);
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001823
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001824void unregister_jprobes(struct jprobe **jps, int num)
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001825{
1826 int i;
1827
1828 if (num <= 0)
1829 return;
1830 mutex_lock(&kprobe_mutex);
1831 for (i = 0; i < num; i++)
1832 if (__unregister_kprobe_top(&jps[i]->kp) < 0)
1833 jps[i]->kp.addr = NULL;
1834 mutex_unlock(&kprobe_mutex);
1835
1836 synchronize_sched();
1837 for (i = 0; i < num; i++) {
1838 if (jps[i]->kp.addr)
1839 __unregister_kprobe_bottom(&jps[i]->kp);
1840 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001842EXPORT_SYMBOL_GPL(unregister_jprobes);
Masami Hiramatsu590c8452017-10-06 08:14:37 +09001843#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08001845#ifdef CONFIG_KRETPROBES
Adrian Bunke65cefe2006-02-03 03:03:42 -08001846/*
1847 * This kprobe pre_handler is registered with every kretprobe. When probe
1848 * hits it will set up the return probe.
1849 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001850static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
Adrian Bunke65cefe2006-02-03 03:03:42 -08001851{
1852 struct kretprobe *rp = container_of(p, struct kretprobe, kp);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001853 unsigned long hash, flags = 0;
1854 struct kretprobe_instance *ri;
Adrian Bunke65cefe2006-02-03 03:03:42 -08001855
Masami Hiramatsuf96f5672014-08-04 03:10:16 +00001856 /*
1857 * To avoid deadlocks, prohibit return probing in NMI contexts,
1858 * just skip the probe and increase the (inexact) 'nmissed'
1859 * statistical counter, so that the user is informed that
1860 * something happened:
1861 */
1862 if (unlikely(in_nmi())) {
1863 rp->nmissed++;
1864 return 0;
1865 }
1866
1867 /* TODO: consider to only swap the RA after the last pre_handler fired */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001868 hash = hash_ptr(current, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001869 raw_spin_lock_irqsave(&rp->lock, flags);
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001870 if (!hlist_empty(&rp->free_instances)) {
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001871 ri = hlist_entry(rp->free_instances.first,
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001872 struct kretprobe_instance, hlist);
1873 hlist_del(&ri->hlist);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001874 raw_spin_unlock_irqrestore(&rp->lock, flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001875
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001876 ri->rp = rp;
1877 ri->task = current;
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001878
Jiang Liu55ca6142012-02-03 15:37:16 -08001879 if (rp->entry_handler && rp->entry_handler(ri, regs)) {
1880 raw_spin_lock_irqsave(&rp->lock, flags);
1881 hlist_add_head(&ri->hlist, &rp->free_instances);
1882 raw_spin_unlock_irqrestore(&rp->lock, flags);
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001883 return 0;
Jiang Liu55ca6142012-02-03 15:37:16 -08001884 }
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001885
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001886 arch_prepare_kretprobe(ri, regs);
1887
1888 /* XXX(hch): why is there no hlist_move_head? */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001889 INIT_HLIST_NODE(&ri->hlist);
1890 kretprobe_table_lock(hash, &flags);
1891 hlist_add_head(&ri->hlist, &kretprobe_inst_table[hash]);
1892 kretprobe_table_unlock(hash, &flags);
1893 } else {
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001894 rp->nmissed++;
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001895 raw_spin_unlock_irqrestore(&rp->lock, flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001896 }
Adrian Bunke65cefe2006-02-03 03:03:42 -08001897 return 0;
1898}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001899NOKPROBE_SYMBOL(pre_handler_kretprobe);
Adrian Bunke65cefe2006-02-03 03:03:42 -08001900
Naveen N. Rao659b9572017-07-07 22:37:24 +05301901bool __weak arch_kprobe_on_func_entry(unsigned long offset)
Naveen N. Rao90ec5e82017-02-22 19:23:37 +05301902{
1903 return !offset;
1904}
1905
Naveen N. Rao659b9572017-07-07 22:37:24 +05301906bool kprobe_on_func_entry(kprobe_opcode_t *addr, const char *sym, unsigned long offset)
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301907{
1908 kprobe_opcode_t *kp_addr = _kprobe_addr(addr, sym, offset);
1909
1910 if (IS_ERR(kp_addr))
1911 return false;
1912
1913 if (!kallsyms_lookup_size_offset((unsigned long)kp_addr, NULL, &offset) ||
Naveen N. Rao659b9572017-07-07 22:37:24 +05301914 !arch_kprobe_on_func_entry(offset))
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301915 return false;
1916
1917 return true;
1918}
1919
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001920int register_kretprobe(struct kretprobe *rp)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001921{
1922 int ret = 0;
1923 struct kretprobe_instance *inst;
1924 int i;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001925 void *addr;
Naveen N. Rao90ec5e82017-02-22 19:23:37 +05301926
Naveen N. Rao659b9572017-07-07 22:37:24 +05301927 if (!kprobe_on_func_entry(rp->kp.addr, rp->kp.symbol_name, rp->kp.offset))
Naveen N. Rao90ec5e82017-02-22 19:23:37 +05301928 return -EINVAL;
Masami Hiramatsuf438d912007-10-16 01:27:49 -07001929
1930 if (kretprobe_blacklist_size) {
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001931 addr = kprobe_addr(&rp->kp);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001932 if (IS_ERR(addr))
1933 return PTR_ERR(addr);
Masami Hiramatsuf438d912007-10-16 01:27:49 -07001934
1935 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
1936 if (kretprobe_blacklist[i].addr == addr)
1937 return -EINVAL;
1938 }
1939 }
Hien Nguyenb94cce92005-06-23 00:09:19 -07001940
1941 rp->kp.pre_handler = pre_handler_kretprobe;
Ananth N Mavinakayanahalli7522a842006-04-20 02:43:11 -07001942 rp->kp.post_handler = NULL;
1943 rp->kp.fault_handler = NULL;
1944 rp->kp.break_handler = NULL;
Hien Nguyenb94cce92005-06-23 00:09:19 -07001945
1946 /* Pre-allocate memory for max kretprobe instances */
1947 if (rp->maxactive <= 0) {
1948#ifdef CONFIG_PREEMPT
Heiko Carstensc2ef6662009-12-21 13:02:24 +01001949 rp->maxactive = max_t(unsigned int, 10, 2*num_possible_cpus());
Hien Nguyenb94cce92005-06-23 00:09:19 -07001950#else
Ananth N Mavinakayanahalli4dae5602009-10-30 19:23:10 +05301951 rp->maxactive = num_possible_cpus();
Hien Nguyenb94cce92005-06-23 00:09:19 -07001952#endif
1953 }
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001954 raw_spin_lock_init(&rp->lock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001955 INIT_HLIST_HEAD(&rp->free_instances);
1956 for (i = 0; i < rp->maxactive; i++) {
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001957 inst = kmalloc(sizeof(struct kretprobe_instance) +
1958 rp->data_size, GFP_KERNEL);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001959 if (inst == NULL) {
1960 free_rp_inst(rp);
1961 return -ENOMEM;
1962 }
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001963 INIT_HLIST_NODE(&inst->hlist);
1964 hlist_add_head(&inst->hlist, &rp->free_instances);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001965 }
1966
1967 rp->nmissed = 0;
1968 /* Establish function entry probe point */
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001969 ret = register_kprobe(&rp->kp);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001970 if (ret != 0)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001971 free_rp_inst(rp);
1972 return ret;
1973}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001974EXPORT_SYMBOL_GPL(register_kretprobe);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001975
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001976int register_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001977{
1978 int ret = 0, i;
1979
1980 if (num <= 0)
1981 return -EINVAL;
1982 for (i = 0; i < num; i++) {
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001983 ret = register_kretprobe(rps[i]);
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001984 if (ret < 0) {
1985 if (i > 0)
1986 unregister_kretprobes(rps, i);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001987 break;
1988 }
1989 }
1990 return ret;
1991}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001992EXPORT_SYMBOL_GPL(register_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001993
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001994void unregister_kretprobe(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001995{
1996 unregister_kretprobes(&rp, 1);
1997}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001998EXPORT_SYMBOL_GPL(unregister_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001999
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002000void unregister_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002001{
2002 int i;
2003
2004 if (num <= 0)
2005 return;
2006 mutex_lock(&kprobe_mutex);
2007 for (i = 0; i < num; i++)
2008 if (__unregister_kprobe_top(&rps[i]->kp) < 0)
2009 rps[i]->kp.addr = NULL;
2010 mutex_unlock(&kprobe_mutex);
2011
2012 synchronize_sched();
2013 for (i = 0; i < num; i++) {
2014 if (rps[i]->kp.addr) {
2015 __unregister_kprobe_bottom(&rps[i]->kp);
2016 cleanup_rp_inst(rps[i]);
2017 }
2018 }
2019}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002020EXPORT_SYMBOL_GPL(unregister_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002021
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08002022#else /* CONFIG_KRETPROBES */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002023int register_kretprobe(struct kretprobe *rp)
Hien Nguyenb94cce92005-06-23 00:09:19 -07002024{
2025 return -ENOSYS;
2026}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002027EXPORT_SYMBOL_GPL(register_kretprobe);
Hien Nguyenb94cce92005-06-23 00:09:19 -07002028
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002029int register_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002030{
2031 return -ENOSYS;
2032}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002033EXPORT_SYMBOL_GPL(register_kretprobes);
2034
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002035void unregister_kretprobe(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002036{
2037}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002038EXPORT_SYMBOL_GPL(unregister_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002039
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002040void unregister_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002041{
2042}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002043EXPORT_SYMBOL_GPL(unregister_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002044
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002045static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002046{
2047 return 0;
2048}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002049NOKPROBE_SYMBOL(pre_handler_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002050
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08002051#endif /* CONFIG_KRETPROBES */
Hien Nguyenb94cce92005-06-23 00:09:19 -07002052
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002053/* Set the kprobe gone and remove its instruction buffer. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002054static void kill_kprobe(struct kprobe *p)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002055{
2056 struct kprobe *kp;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002057
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002058 p->flags |= KPROBE_FLAG_GONE;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002059 if (kprobe_aggrprobe(p)) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002060 /*
2061 * If this is an aggr_kprobe, we have to list all the
2062 * chained probes and mark them GONE.
2063 */
2064 list_for_each_entry_rcu(kp, &p->list, list)
2065 kp->flags |= KPROBE_FLAG_GONE;
2066 p->post_handler = NULL;
2067 p->break_handler = NULL;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002068 kill_optimized_kprobe(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002069 }
2070 /*
2071 * Here, we can remove insn_slot safely, because no thread calls
2072 * the original probed function (which will be freed soon) any more.
2073 */
2074 arch_remove_kprobe(p);
2075}
2076
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002077/* Disable one kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002078int disable_kprobe(struct kprobe *kp)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002079{
2080 int ret = 0;
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002081
2082 mutex_lock(&kprobe_mutex);
2083
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09002084 /* Disable this kprobe */
2085 if (__disable_kprobe(kp) == NULL)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002086 ret = -EINVAL;
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002087
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002088 mutex_unlock(&kprobe_mutex);
2089 return ret;
2090}
2091EXPORT_SYMBOL_GPL(disable_kprobe);
2092
2093/* Enable one kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002094int enable_kprobe(struct kprobe *kp)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002095{
2096 int ret = 0;
2097 struct kprobe *p;
2098
2099 mutex_lock(&kprobe_mutex);
2100
2101 /* Check whether specified probe is valid. */
2102 p = __get_valid_kprobe(kp);
2103 if (unlikely(p == NULL)) {
2104 ret = -EINVAL;
2105 goto out;
2106 }
2107
2108 if (kprobe_gone(kp)) {
2109 /* This kprobe has gone, we couldn't enable it. */
2110 ret = -EINVAL;
2111 goto out;
2112 }
2113
2114 if (p != kp)
2115 kp->flags &= ~KPROBE_FLAG_DISABLED;
2116
2117 if (!kprobes_all_disarmed && kprobe_disabled(p)) {
2118 p->flags &= ~KPROBE_FLAG_DISABLED;
2119 arm_kprobe(p);
2120 }
2121out:
2122 mutex_unlock(&kprobe_mutex);
2123 return ret;
2124}
2125EXPORT_SYMBOL_GPL(enable_kprobe);
2126
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002127void dump_kprobe(struct kprobe *kp)
Frederic Weisbecker24851d22009-08-26 23:38:30 +02002128{
2129 printk(KERN_WARNING "Dumping kprobe:\n");
2130 printk(KERN_WARNING "Name: %s\nAddress: %p\nOffset: %x\n",
2131 kp->symbol_name, kp->addr, kp->offset);
2132}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002133NOKPROBE_SYMBOL(dump_kprobe);
Frederic Weisbecker24851d22009-08-26 23:38:30 +02002134
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002135/*
2136 * Lookup and populate the kprobe_blacklist.
2137 *
2138 * Unlike the kretprobe blacklist, we'll need to determine
2139 * the range of addresses that belong to the said functions,
2140 * since a kprobe need not necessarily be at the beginning
2141 * of a function.
2142 */
2143static int __init populate_kprobe_blacklist(unsigned long *start,
2144 unsigned long *end)
2145{
2146 unsigned long *iter;
2147 struct kprobe_blacklist_entry *ent;
Masami Hiramatsud81b4252014-07-17 11:44:11 +00002148 unsigned long entry, offset = 0, size = 0;
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002149
2150 for (iter = start; iter < end; iter++) {
Masami Hiramatsud81b4252014-07-17 11:44:11 +00002151 entry = arch_deref_entry_point((void *)*iter);
2152
2153 if (!kernel_text_address(entry) ||
2154 !kallsyms_lookup_size_offset(entry, &size, &offset)) {
2155 pr_err("Failed to find blacklist at %p\n",
2156 (void *)entry);
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002157 continue;
2158 }
2159
2160 ent = kmalloc(sizeof(*ent), GFP_KERNEL);
2161 if (!ent)
2162 return -ENOMEM;
Masami Hiramatsud81b4252014-07-17 11:44:11 +00002163 ent->start_addr = entry;
2164 ent->end_addr = entry + size;
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002165 INIT_LIST_HEAD(&ent->list);
2166 list_add_tail(&ent->list, &kprobe_blacklist);
2167 }
2168 return 0;
2169}
2170
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002171/* Module notifier call back, checking kprobes on the module */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002172static int kprobes_module_callback(struct notifier_block *nb,
2173 unsigned long val, void *data)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002174{
2175 struct module *mod = data;
2176 struct hlist_head *head;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002177 struct kprobe *p;
2178 unsigned int i;
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002179 int checkcore = (val == MODULE_STATE_GOING);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002180
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002181 if (val != MODULE_STATE_GOING && val != MODULE_STATE_LIVE)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002182 return NOTIFY_DONE;
2183
2184 /*
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002185 * When MODULE_STATE_GOING was notified, both of module .text and
2186 * .init.text sections would be freed. When MODULE_STATE_LIVE was
2187 * notified, only .init.text section would be freed. We need to
2188 * disable kprobes which have been inserted in the sections.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002189 */
2190 mutex_lock(&kprobe_mutex);
2191 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2192 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -08002193 hlist_for_each_entry_rcu(p, head, hlist)
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002194 if (within_module_init((unsigned long)p->addr, mod) ||
2195 (checkcore &&
2196 within_module_core((unsigned long)p->addr, mod))) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002197 /*
2198 * The vaddr this probe is installed will soon
2199 * be vfreed buy not synced to disk. Hence,
2200 * disarming the breakpoint isn't needed.
Steven Rostedt (VMware)545a0282017-05-16 14:58:35 -04002201 *
2202 * Note, this will also move any optimized probes
2203 * that are pending to be removed from their
2204 * corresponding lists to the freeing_list and
2205 * will not be touched by the delayed
2206 * kprobe_optimizer work handler.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002207 */
2208 kill_kprobe(p);
2209 }
2210 }
2211 mutex_unlock(&kprobe_mutex);
2212 return NOTIFY_DONE;
2213}
2214
2215static struct notifier_block kprobe_module_nb = {
2216 .notifier_call = kprobes_module_callback,
2217 .priority = 0
2218};
2219
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002220/* Markers of _kprobe_blacklist section */
2221extern unsigned long __start_kprobe_blacklist[];
2222extern unsigned long __stop_kprobe_blacklist[];
2223
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224static int __init init_kprobes(void)
2225{
2226 int i, err = 0;
2227
2228 /* FIXME allocate the probe table, currently defined statically */
2229 /* initialize all list heads */
Hien Nguyenb94cce92005-06-23 00:09:19 -07002230 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002231 INIT_HLIST_HEAD(&kprobe_table[i]);
Hien Nguyenb94cce92005-06-23 00:09:19 -07002232 INIT_HLIST_HEAD(&kretprobe_inst_table[i]);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02002233 raw_spin_lock_init(&(kretprobe_table_locks[i].lock));
Hien Nguyenb94cce92005-06-23 00:09:19 -07002234 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002236 err = populate_kprobe_blacklist(__start_kprobe_blacklist,
2237 __stop_kprobe_blacklist);
2238 if (err) {
2239 pr_err("kprobes: failed to populate blacklist: %d\n", err);
2240 pr_err("Please take care of using kprobes.\n");
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07002241 }
2242
Masami Hiramatsuf438d912007-10-16 01:27:49 -07002243 if (kretprobe_blacklist_size) {
2244 /* lookup the function address from its name */
2245 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
Naveen N. Rao49e0b462017-04-19 18:21:00 +05302246 kretprobe_blacklist[i].addr =
Naveen N. Rao290e3072017-04-19 18:21:01 +05302247 kprobe_lookup_name(kretprobe_blacklist[i].name, 0);
Masami Hiramatsuf438d912007-10-16 01:27:49 -07002248 if (!kretprobe_blacklist[i].addr)
2249 printk("kretprobe: lookup failed: %s\n",
2250 kretprobe_blacklist[i].name);
2251 }
2252 }
2253
Masami Hiramatsub2be84d2010-02-25 08:34:15 -05002254#if defined(CONFIG_OPTPROBES)
2255#if defined(__ARCH_WANT_KPROBES_INSN_SLOT)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002256 /* Init kprobe_optinsn_slots */
2257 kprobe_optinsn_slots.insn_size = MAX_OPTINSN_SIZE;
2258#endif
Masami Hiramatsub2be84d2010-02-25 08:34:15 -05002259 /* By default, kprobes can be optimized */
2260 kprobes_allow_optimization = true;
2261#endif
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002262
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002263 /* By default, kprobes are armed */
2264 kprobes_all_disarmed = false;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002265
Rusty Lynch67729262005-07-05 18:54:50 -07002266 err = arch_init_kprobes();
Rusty Lynch802eae72005-06-27 15:17:08 -07002267 if (!err)
2268 err = register_die_notifier(&kprobe_exceptions_nb);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002269 if (!err)
2270 err = register_module_notifier(&kprobe_module_nb);
2271
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07002272 kprobes_initialized = (err == 0);
Rusty Lynch802eae72005-06-27 15:17:08 -07002273
Ananth N Mavinakayanahalli8c1c9352008-01-30 13:32:53 +01002274 if (!err)
2275 init_test_probes();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276 return err;
2277}
2278
Srinivasa Ds346fd592007-02-20 13:57:54 -08002279#ifdef CONFIG_DEBUG_FS
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002280static void report_probe(struct seq_file *pi, struct kprobe *p,
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002281 const char *sym, int offset, char *modname, struct kprobe *pp)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002282{
2283 char *kprobe_type;
2284
2285 if (p->pre_handler == pre_handler_kretprobe)
2286 kprobe_type = "r";
2287 else if (p->pre_handler == setjmp_pre_handler)
2288 kprobe_type = "j";
2289 else
2290 kprobe_type = "k";
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002291
Srinivasa Ds346fd592007-02-20 13:57:54 -08002292 if (sym)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002293 seq_printf(pi, "%p %s %s+0x%x %s ",
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002294 p->addr, kprobe_type, sym, offset,
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002295 (modname ? modname : " "));
Srinivasa Ds346fd592007-02-20 13:57:54 -08002296 else
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002297 seq_printf(pi, "%p %s %p ",
2298 p->addr, kprobe_type, p->addr);
2299
2300 if (!pp)
2301 pp = p;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002302 seq_printf(pi, "%s%s%s%s\n",
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002303 (kprobe_gone(p) ? "[GONE]" : ""),
2304 ((kprobe_disabled(p) && !kprobe_gone(p)) ? "[DISABLED]" : ""),
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002305 (kprobe_optimized(pp) ? "[OPTIMIZED]" : ""),
2306 (kprobe_ftrace(pp) ? "[FTRACE]" : ""));
Srinivasa Ds346fd592007-02-20 13:57:54 -08002307}
2308
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002309static void *kprobe_seq_start(struct seq_file *f, loff_t *pos)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002310{
2311 return (*pos < KPROBE_TABLE_SIZE) ? pos : NULL;
2312}
2313
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002314static void *kprobe_seq_next(struct seq_file *f, void *v, loff_t *pos)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002315{
2316 (*pos)++;
2317 if (*pos >= KPROBE_TABLE_SIZE)
2318 return NULL;
2319 return pos;
2320}
2321
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002322static void kprobe_seq_stop(struct seq_file *f, void *v)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002323{
2324 /* Nothing to do */
2325}
2326
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002327static int show_kprobe_addr(struct seq_file *pi, void *v)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002328{
2329 struct hlist_head *head;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002330 struct kprobe *p, *kp;
2331 const char *sym = NULL;
2332 unsigned int i = *(loff_t *) v;
Alexey Dobriyanffb45122007-05-08 00:28:41 -07002333 unsigned long offset = 0;
Joe Marioab767862013-11-12 15:10:23 -08002334 char *modname, namebuf[KSYM_NAME_LEN];
Srinivasa Ds346fd592007-02-20 13:57:54 -08002335
2336 head = &kprobe_table[i];
2337 preempt_disable();
Sasha Levinb67bfe02013-02-27 17:06:00 -08002338 hlist_for_each_entry_rcu(p, head, hlist) {
Alexey Dobriyanffb45122007-05-08 00:28:41 -07002339 sym = kallsyms_lookup((unsigned long)p->addr, NULL,
Srinivasa Ds346fd592007-02-20 13:57:54 -08002340 &offset, &modname, namebuf);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002341 if (kprobe_aggrprobe(p)) {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002342 list_for_each_entry_rcu(kp, &p->list, list)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002343 report_probe(pi, kp, sym, offset, modname, p);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002344 } else
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002345 report_probe(pi, p, sym, offset, modname, NULL);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002346 }
2347 preempt_enable();
2348 return 0;
2349}
2350
James Morris88e9d342009-09-22 16:43:43 -07002351static const struct seq_operations kprobes_seq_ops = {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002352 .start = kprobe_seq_start,
2353 .next = kprobe_seq_next,
2354 .stop = kprobe_seq_stop,
2355 .show = show_kprobe_addr
2356};
2357
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002358static int kprobes_open(struct inode *inode, struct file *filp)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002359{
2360 return seq_open(filp, &kprobes_seq_ops);
2361}
2362
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002363static const struct file_operations debugfs_kprobes_operations = {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002364 .open = kprobes_open,
2365 .read = seq_read,
2366 .llseek = seq_lseek,
2367 .release = seq_release,
2368};
2369
Masami Hiramatsu63724742014-04-17 17:18:49 +09002370/* kprobes/blacklist -- shows which functions can not be probed */
2371static void *kprobe_blacklist_seq_start(struct seq_file *m, loff_t *pos)
2372{
2373 return seq_list_start(&kprobe_blacklist, *pos);
2374}
2375
2376static void *kprobe_blacklist_seq_next(struct seq_file *m, void *v, loff_t *pos)
2377{
2378 return seq_list_next(v, &kprobe_blacklist, pos);
2379}
2380
2381static int kprobe_blacklist_seq_show(struct seq_file *m, void *v)
2382{
2383 struct kprobe_blacklist_entry *ent =
2384 list_entry(v, struct kprobe_blacklist_entry, list);
2385
2386 seq_printf(m, "0x%p-0x%p\t%ps\n", (void *)ent->start_addr,
2387 (void *)ent->end_addr, (void *)ent->start_addr);
2388 return 0;
2389}
2390
2391static const struct seq_operations kprobe_blacklist_seq_ops = {
2392 .start = kprobe_blacklist_seq_start,
2393 .next = kprobe_blacklist_seq_next,
2394 .stop = kprobe_seq_stop, /* Reuse void function */
2395 .show = kprobe_blacklist_seq_show,
2396};
2397
2398static int kprobe_blacklist_open(struct inode *inode, struct file *filp)
2399{
2400 return seq_open(filp, &kprobe_blacklist_seq_ops);
2401}
2402
2403static const struct file_operations debugfs_kprobe_blacklist_ops = {
2404 .open = kprobe_blacklist_open,
2405 .read = seq_read,
2406 .llseek = seq_lseek,
2407 .release = seq_release,
2408};
2409
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002410static void arm_all_kprobes(void)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002411{
2412 struct hlist_head *head;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002413 struct kprobe *p;
2414 unsigned int i;
2415
2416 mutex_lock(&kprobe_mutex);
2417
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002418 /* If kprobes are armed, just return */
2419 if (!kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002420 goto already_enabled;
2421
Wang Nan977ad482015-02-13 14:40:24 -08002422 /*
2423 * optimize_kprobe() called by arm_kprobe() checks
2424 * kprobes_all_disarmed, so set kprobes_all_disarmed before
2425 * arm_kprobe.
2426 */
2427 kprobes_all_disarmed = false;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002428 /* Arming kprobes doesn't optimize kprobe itself */
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002429 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2430 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -08002431 hlist_for_each_entry_rcu(p, head, hlist)
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002432 if (!kprobe_disabled(p))
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002433 arm_kprobe(p);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002434 }
2435
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002436 printk(KERN_INFO "Kprobes globally enabled\n");
2437
2438already_enabled:
2439 mutex_unlock(&kprobe_mutex);
2440 return;
2441}
2442
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002443static void disarm_all_kprobes(void)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002444{
2445 struct hlist_head *head;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002446 struct kprobe *p;
2447 unsigned int i;
2448
2449 mutex_lock(&kprobe_mutex);
2450
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002451 /* If kprobes are already disarmed, just return */
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002452 if (kprobes_all_disarmed) {
2453 mutex_unlock(&kprobe_mutex);
2454 return;
2455 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002456
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002457 kprobes_all_disarmed = true;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002458 printk(KERN_INFO "Kprobes globally disabled\n");
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002459
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002460 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2461 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -08002462 hlist_for_each_entry_rcu(p, head, hlist) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002463 if (!arch_trampoline_kprobe(p) && !kprobe_disabled(p))
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002464 disarm_kprobe(p, false);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002465 }
2466 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002467 mutex_unlock(&kprobe_mutex);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002468
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002469 /* Wait for disarming all kprobes by optimizer */
2470 wait_for_kprobe_optimizer();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002471}
2472
2473/*
2474 * XXX: The debugfs bool file interface doesn't allow for callbacks
2475 * when the bool state is switched. We can reuse that facility when
2476 * available
2477 */
2478static ssize_t read_enabled_file_bool(struct file *file,
2479 char __user *user_buf, size_t count, loff_t *ppos)
2480{
2481 char buf[3];
2482
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002483 if (!kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002484 buf[0] = '1';
2485 else
2486 buf[0] = '0';
2487 buf[1] = '\n';
2488 buf[2] = 0x00;
2489 return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
2490}
2491
2492static ssize_t write_enabled_file_bool(struct file *file,
2493 const char __user *user_buf, size_t count, loff_t *ppos)
2494{
2495 char buf[32];
Stephen Boydefeb1562012-01-12 17:17:11 -08002496 size_t buf_size;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002497
2498 buf_size = min(count, (sizeof(buf)-1));
2499 if (copy_from_user(buf, user_buf, buf_size))
2500 return -EFAULT;
2501
Mathias Krause10fb46d2013-07-03 15:05:39 -07002502 buf[buf_size] = '\0';
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002503 switch (buf[0]) {
2504 case 'y':
2505 case 'Y':
2506 case '1':
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002507 arm_all_kprobes();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002508 break;
2509 case 'n':
2510 case 'N':
2511 case '0':
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002512 disarm_all_kprobes();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002513 break;
Mathias Krause10fb46d2013-07-03 15:05:39 -07002514 default:
2515 return -EINVAL;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002516 }
2517
2518 return count;
2519}
2520
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002521static const struct file_operations fops_kp = {
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002522 .read = read_enabled_file_bool,
2523 .write = write_enabled_file_bool,
Arnd Bergmann6038f372010-08-15 18:52:59 +02002524 .llseek = default_llseek,
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002525};
2526
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002527static int __init debugfs_kprobe_init(void)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002528{
2529 struct dentry *dir, *file;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002530 unsigned int value = 1;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002531
2532 dir = debugfs_create_dir("kprobes", NULL);
2533 if (!dir)
2534 return -ENOMEM;
2535
Randy Dunlape3869792007-05-08 00:27:01 -07002536 file = debugfs_create_file("list", 0444, dir, NULL,
Srinivasa Ds346fd592007-02-20 13:57:54 -08002537 &debugfs_kprobes_operations);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002538 if (!file)
2539 goto error;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002540
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002541 file = debugfs_create_file("enabled", 0600, dir,
2542 &value, &fops_kp);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002543 if (!file)
2544 goto error;
2545
2546 file = debugfs_create_file("blacklist", 0444, dir, NULL,
2547 &debugfs_kprobe_blacklist_ops);
2548 if (!file)
2549 goto error;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002550
Srinivasa Ds346fd592007-02-20 13:57:54 -08002551 return 0;
Masami Hiramatsu63724742014-04-17 17:18:49 +09002552
2553error:
2554 debugfs_remove(dir);
2555 return -ENOMEM;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002556}
2557
2558late_initcall(debugfs_kprobe_init);
2559#endif /* CONFIG_DEBUG_FS */
2560
2561module_init(init_kprobes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002562
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002563/* defined in arch/.../kernel/kprobes.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002564EXPORT_SYMBOL_GPL(jprobe_return);