blob: 9f6056749a28bc7f8ae4a8c803e95f2c26edca9e [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
Heiko Carstensaf963972013-09-11 14:24:13 -0700120static void *alloc_insn_page(void)
121{
122 return module_alloc(PAGE_SIZE);
123}
124
125static void free_insn_page(void *page)
126{
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);
390 kp->pre_handler(kp, regs);
391 }
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 /*
576 * Step 2: Wait for quiesence period to ensure all running interrupts
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900577 * are done. Because optprobe may modify multiple instructions
578 * there is a chance that Nth instruction is interrupted. In that
579 * case, running interrupt can return to 2nd-Nth byte of jump
580 * instruction. This wait is for avoiding it.
581 */
582 synchronize_sched();
583
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900584 /* Step 3: Optimize kprobes after quiesence period */
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900585 do_optimize_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900586
587 /* Step 4: Free cleaned kprobes after quiesence period */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900588 do_free_cleaned_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900589
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500590 mutex_unlock(&module_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200591 cpus_read_unlock();
Steven Rostedt72ef3792012-06-05 19:28:14 +0900592 mutex_unlock(&kprobe_mutex);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900593
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900594 /* Step 5: Kick optimizer again if needed */
Masami Hiramatsuf984ba42010-12-03 18:54:34 +0900595 if (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list))
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900596 kick_kprobe_optimizer();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900597}
598
599/* Wait for completing optimization and unoptimization */
Thomas Gleixner30e7d8942017-05-17 10:19:49 +0200600void wait_for_kprobe_optimizer(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900601{
Tejun Heoad72b3b2012-12-21 17:57:00 -0800602 mutex_lock(&kprobe_mutex);
603
604 while (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list)) {
605 mutex_unlock(&kprobe_mutex);
606
607 /* this will also make optimizing_work execute immmediately */
608 flush_delayed_work(&optimizing_work);
609 /* @optimizing_work might not have been queued yet, relax */
610 cpu_relax();
611
612 mutex_lock(&kprobe_mutex);
613 }
614
615 mutex_unlock(&kprobe_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500616}
617
618/* Optimize kprobe if p is ready to be optimized */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900619static void optimize_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500620{
621 struct optimized_kprobe *op;
622
623 /* Check if the kprobe is disabled or not ready for optimization. */
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500624 if (!kprobe_optready(p) || !kprobes_allow_optimization ||
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500625 (kprobe_disabled(p) || kprobes_all_disarmed))
626 return;
627
628 /* Both of break_handler and post_handler are not supported. */
629 if (p->break_handler || p->post_handler)
630 return;
631
632 op = container_of(p, struct optimized_kprobe, kp);
633
634 /* Check there is no other kprobes at the optimized instructions */
635 if (arch_check_optimized_kprobe(op) < 0)
636 return;
637
638 /* Check if it is already optimized. */
639 if (op->kp.flags & KPROBE_FLAG_OPTIMIZED)
640 return;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500641 op->kp.flags |= KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900642
643 if (!list_empty(&op->list))
644 /* This is under unoptimizing. Just dequeue the probe */
645 list_del_init(&op->list);
646 else {
647 list_add(&op->list, &optimizing_list);
648 kick_kprobe_optimizer();
649 }
650}
651
652/* Short cut to direct unoptimizing */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900653static void force_unoptimize_kprobe(struct optimized_kprobe *op)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900654{
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200655 lockdep_assert_cpus_held();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900656 arch_unoptimize_kprobe(op);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900657 if (kprobe_disabled(&op->kp))
658 arch_disarm_kprobe(&op->kp);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500659}
660
661/* Unoptimize a kprobe if p is optimized */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900662static void unoptimize_kprobe(struct kprobe *p, bool force)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500663{
664 struct optimized_kprobe *op;
665
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900666 if (!kprobe_aggrprobe(p) || kprobe_disarmed(p))
667 return; /* This is not an optprobe nor optimized */
668
669 op = container_of(p, struct optimized_kprobe, kp);
670 if (!kprobe_optimized(p)) {
671 /* Unoptimized or unoptimizing case */
672 if (force && !list_empty(&op->list)) {
673 /*
674 * Only if this is unoptimizing kprobe and forced,
675 * forcibly unoptimize it. (No need to unoptimize
676 * unoptimized kprobe again :)
677 */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500678 list_del_init(&op->list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900679 force_unoptimize_kprobe(op);
680 }
681 return;
682 }
683
684 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
685 if (!list_empty(&op->list)) {
686 /* Dequeue from the optimization queue */
687 list_del_init(&op->list);
688 return;
689 }
690 /* Optimized kprobe case */
691 if (force)
692 /* Forcibly update the code: this is a special case */
693 force_unoptimize_kprobe(op);
694 else {
695 list_add(&op->list, &unoptimizing_list);
696 kick_kprobe_optimizer();
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500697 }
698}
699
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900700/* Cancel unoptimizing for reusing */
701static void reuse_unused_kprobe(struct kprobe *ap)
702{
703 struct optimized_kprobe *op;
704
705 BUG_ON(!kprobe_unused(ap));
706 /*
707 * Unused kprobe MUST be on the way of delayed unoptimizing (means
708 * there is still a relative jump) and disabled.
709 */
710 op = container_of(ap, struct optimized_kprobe, kp);
711 if (unlikely(list_empty(&op->list)))
712 printk(KERN_WARNING "Warning: found a stray unused "
713 "aggrprobe@%p\n", ap->addr);
714 /* Enable the probe again */
715 ap->flags &= ~KPROBE_FLAG_DISABLED;
716 /* Optimize it again (remove from op->list) */
717 BUG_ON(!kprobe_optready(ap));
718 optimize_kprobe(ap);
719}
720
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500721/* Remove optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900722static void kill_optimized_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500723{
724 struct optimized_kprobe *op;
725
726 op = container_of(p, struct optimized_kprobe, kp);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900727 if (!list_empty(&op->list))
728 /* Dequeue from the (un)optimization queue */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500729 list_del_init(&op->list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900730 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900731
732 if (kprobe_unused(p)) {
733 /* Enqueue if it is unused */
734 list_add(&op->list, &freeing_list);
735 /*
736 * Remove unused probes from the hash list. After waiting
737 * for synchronization, this probe is reclaimed.
738 * (reclaiming is done by do_free_cleaned_kprobes().)
739 */
740 hlist_del_rcu(&op->kp.hlist);
741 }
742
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900743 /* Don't touch the code, because it is already freed. */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500744 arch_remove_optimized_kprobe(op);
745}
746
Masami Hiramatsua4602462017-04-19 18:22:25 +0530747static inline
748void __prepare_optimized_kprobe(struct optimized_kprobe *op, struct kprobe *p)
749{
750 if (!kprobe_ftrace(p))
751 arch_prepare_optimized_kprobe(op, p);
752}
753
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500754/* Try to prepare optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900755static void prepare_optimized_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500756{
757 struct optimized_kprobe *op;
758
759 op = container_of(p, struct optimized_kprobe, kp);
Masami Hiramatsua4602462017-04-19 18:22:25 +0530760 __prepare_optimized_kprobe(op, p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500761}
762
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500763/* Allocate new optimized_kprobe and try to prepare optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900764static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500765{
766 struct optimized_kprobe *op;
767
768 op = kzalloc(sizeof(struct optimized_kprobe), GFP_KERNEL);
769 if (!op)
770 return NULL;
771
772 INIT_LIST_HEAD(&op->list);
773 op->kp.addr = p->addr;
Masami Hiramatsua4602462017-04-19 18:22:25 +0530774 __prepare_optimized_kprobe(op, p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500775
776 return &op->kp;
777}
778
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900779static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500780
781/*
782 * Prepare an optimized_kprobe and optimize it
783 * NOTE: p must be a normal registered kprobe
784 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900785static void try_to_optimize_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500786{
787 struct kprobe *ap;
788 struct optimized_kprobe *op;
789
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900790 /* Impossible to optimize ftrace-based kprobe */
791 if (kprobe_ftrace(p))
792 return;
793
Masami Hiramatsu25764282012-06-05 19:28:26 +0900794 /* For preparing optimization, jump_label_text_reserved() is called */
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200795 cpus_read_lock();
Masami Hiramatsu25764282012-06-05 19:28:26 +0900796 jump_label_lock();
797 mutex_lock(&text_mutex);
798
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500799 ap = alloc_aggr_kprobe(p);
800 if (!ap)
Masami Hiramatsu25764282012-06-05 19:28:26 +0900801 goto out;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500802
803 op = container_of(ap, struct optimized_kprobe, kp);
804 if (!arch_prepared_optinsn(&op->optinsn)) {
805 /* If failed to setup optimizing, fallback to kprobe */
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900806 arch_remove_optimized_kprobe(op);
807 kfree(op);
Masami Hiramatsu25764282012-06-05 19:28:26 +0900808 goto out;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500809 }
810
811 init_aggr_kprobe(ap, p);
Masami Hiramatsu25764282012-06-05 19:28:26 +0900812 optimize_kprobe(ap); /* This just kicks optimizer thread */
813
814out:
815 mutex_unlock(&text_mutex);
816 jump_label_unlock();
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200817 cpus_read_unlock();
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500818}
819
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500820#ifdef CONFIG_SYSCTL
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900821static void optimize_all_kprobes(void)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500822{
823 struct hlist_head *head;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500824 struct kprobe *p;
825 unsigned int i;
826
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900827 mutex_lock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500828 /* If optimization is already allowed, just return */
829 if (kprobes_allow_optimization)
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900830 goto out;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500831
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200832 cpus_read_lock();
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500833 kprobes_allow_optimization = true;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500834 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
835 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800836 hlist_for_each_entry_rcu(p, head, hlist)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500837 if (!kprobe_disabled(p))
838 optimize_kprobe(p);
839 }
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200840 cpus_read_unlock();
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500841 printk(KERN_INFO "Kprobes globally optimized\n");
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900842out:
843 mutex_unlock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500844}
845
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900846static void unoptimize_all_kprobes(void)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500847{
848 struct hlist_head *head;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500849 struct kprobe *p;
850 unsigned int i;
851
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900852 mutex_lock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500853 /* If optimization is already prohibited, just return */
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900854 if (!kprobes_allow_optimization) {
855 mutex_unlock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500856 return;
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900857 }
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500858
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200859 cpus_read_lock();
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500860 kprobes_allow_optimization = false;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500861 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
862 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800863 hlist_for_each_entry_rcu(p, head, hlist) {
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500864 if (!kprobe_disabled(p))
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900865 unoptimize_kprobe(p, false);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500866 }
867 }
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200868 cpus_read_unlock();
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900869 mutex_unlock(&kprobe_mutex);
870
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900871 /* Wait for unoptimizing completion */
872 wait_for_kprobe_optimizer();
873 printk(KERN_INFO "Kprobes globally unoptimized\n");
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500874}
875
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900876static DEFINE_MUTEX(kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500877int sysctl_kprobes_optimization;
878int proc_kprobes_optimization_handler(struct ctl_table *table, int write,
879 void __user *buffer, size_t *length,
880 loff_t *ppos)
881{
882 int ret;
883
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900884 mutex_lock(&kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500885 sysctl_kprobes_optimization = kprobes_allow_optimization ? 1 : 0;
886 ret = proc_dointvec_minmax(table, write, buffer, length, ppos);
887
888 if (sysctl_kprobes_optimization)
889 optimize_all_kprobes();
890 else
891 unoptimize_all_kprobes();
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900892 mutex_unlock(&kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500893
894 return ret;
895}
896#endif /* CONFIG_SYSCTL */
897
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900898/* Put a breakpoint for a probe. Must be called with text_mutex locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900899static void __arm_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500900{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900901 struct kprobe *_p;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500902
903 /* Check collision with other optimized kprobes */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900904 _p = get_optimized_kprobe((unsigned long)p->addr);
905 if (unlikely(_p))
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900906 /* Fallback to unoptimized kprobe */
907 unoptimize_kprobe(_p, true);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500908
909 arch_arm_kprobe(p);
910 optimize_kprobe(p); /* Try to optimize (add kprobe to a list) */
911}
912
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900913/* Remove the breakpoint of a probe. Must be called with text_mutex locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900914static void __disarm_kprobe(struct kprobe *p, bool reopt)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500915{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900916 struct kprobe *_p;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500917
Wang Nan69d54b92015-02-13 14:40:26 -0800918 /* Try to unoptimize */
919 unoptimize_kprobe(p, kprobes_all_disarmed);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500920
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900921 if (!kprobe_queued(p)) {
922 arch_disarm_kprobe(p);
923 /* If another kprobe was blocked, optimize it. */
924 _p = get_optimized_kprobe((unsigned long)p->addr);
925 if (unlikely(_p) && reopt)
926 optimize_kprobe(_p);
927 }
928 /* TODO: reoptimize others after unoptimized this probe */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500929}
930
931#else /* !CONFIG_OPTPROBES */
932
933#define optimize_kprobe(p) do {} while (0)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900934#define unoptimize_kprobe(p, f) do {} while (0)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500935#define kill_optimized_kprobe(p) do {} while (0)
936#define prepare_optimized_kprobe(p) do {} while (0)
937#define try_to_optimize_kprobe(p) do {} while (0)
938#define __arm_kprobe(p) arch_arm_kprobe(p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900939#define __disarm_kprobe(p, o) arch_disarm_kprobe(p)
940#define kprobe_disarmed(p) kprobe_disabled(p)
941#define wait_for_kprobe_optimizer() do {} while (0)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500942
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900943/* There should be no unused kprobes can be reused without optimization */
944static void reuse_unused_kprobe(struct kprobe *ap)
945{
946 printk(KERN_ERR "Error: There should be no unused kprobe here.\n");
947 BUG_ON(kprobe_unused(ap));
948}
949
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900950static void free_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500951{
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900952 arch_remove_kprobe(p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500953 kfree(p);
954}
955
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900956static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500957{
958 return kzalloc(sizeof(struct kprobe), GFP_KERNEL);
959}
960#endif /* CONFIG_OPTPROBES */
961
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +0900962#ifdef CONFIG_KPROBES_ON_FTRACE
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900963static struct ftrace_ops kprobe_ftrace_ops __read_mostly = {
Masami Hiramatsue5253892012-06-05 19:28:38 +0900964 .func = kprobe_ftrace_handler,
Masami Hiramatsu1d70be32014-11-21 05:25:23 -0500965 .flags = FTRACE_OPS_FL_SAVE_REGS | FTRACE_OPS_FL_IPMODIFY,
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900966};
967static int kprobe_ftrace_enabled;
968
969/* Must ensure p->addr is really on ftrace */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900970static int prepare_kprobe(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900971{
972 if (!kprobe_ftrace(p))
973 return arch_prepare_kprobe(p);
974
975 return arch_prepare_kprobe_ftrace(p);
976}
977
978/* Caller must lock kprobe_mutex */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900979static void arm_kprobe_ftrace(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900980{
981 int ret;
982
983 ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
984 (unsigned long)p->addr, 0, 0);
985 WARN(ret < 0, "Failed to arm kprobe-ftrace at %p (%d)\n", p->addr, ret);
986 kprobe_ftrace_enabled++;
987 if (kprobe_ftrace_enabled == 1) {
988 ret = register_ftrace_function(&kprobe_ftrace_ops);
989 WARN(ret < 0, "Failed to init kprobe-ftrace (%d)\n", ret);
990 }
991}
992
993/* Caller must lock kprobe_mutex */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900994static void disarm_kprobe_ftrace(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900995{
996 int ret;
997
998 kprobe_ftrace_enabled--;
999 if (kprobe_ftrace_enabled == 0) {
1000 ret = unregister_ftrace_function(&kprobe_ftrace_ops);
1001 WARN(ret < 0, "Failed to init kprobe-ftrace (%d)\n", ret);
1002 }
1003 ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
1004 (unsigned long)p->addr, 1, 0);
1005 WARN(ret < 0, "Failed to disarm kprobe-ftrace at %p (%d)\n", p->addr, ret);
1006}
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001007#else /* !CONFIG_KPROBES_ON_FTRACE */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001008#define prepare_kprobe(p) arch_prepare_kprobe(p)
1009#define arm_kprobe_ftrace(p) do {} while (0)
1010#define disarm_kprobe_ftrace(p) do {} while (0)
1011#endif
1012
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001013/* Arm a kprobe with text_mutex */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001014static void arm_kprobe(struct kprobe *kp)
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001015{
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001016 if (unlikely(kprobe_ftrace(kp))) {
1017 arm_kprobe_ftrace(kp);
1018 return;
1019 }
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001020 cpus_read_lock();
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001021 mutex_lock(&text_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001022 __arm_kprobe(kp);
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001023 mutex_unlock(&text_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001024 cpus_read_unlock();
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001025}
1026
1027/* Disarm a kprobe with text_mutex */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001028static void disarm_kprobe(struct kprobe *kp, bool reopt)
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001029{
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001030 if (unlikely(kprobe_ftrace(kp))) {
1031 disarm_kprobe_ftrace(kp);
1032 return;
1033 }
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001034
1035 cpus_read_lock();
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001036 mutex_lock(&text_mutex);
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001037 __disarm_kprobe(kp, reopt);
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001038 mutex_unlock(&text_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001039 cpus_read_unlock();
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001040}
1041
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001042/*
1043 * Aggregate handlers for multiple kprobes support - these handlers
1044 * take care of invoking the individual kprobe handlers on p->list
1045 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001046static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001047{
1048 struct kprobe *kp;
1049
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001050 list_for_each_entry_rcu(kp, &p->list, list) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001051 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001052 set_kprobe_instance(kp);
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001053 if (kp->pre_handler(kp, regs))
1054 return 1;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001055 }
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001056 reset_kprobe_instance();
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001057 }
1058 return 0;
1059}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001060NOKPROBE_SYMBOL(aggr_pre_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001061
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001062static void aggr_post_handler(struct kprobe *p, struct pt_regs *regs,
1063 unsigned long flags)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001064{
1065 struct kprobe *kp;
1066
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001067 list_for_each_entry_rcu(kp, &p->list, list) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001068 if (kp->post_handler && likely(!kprobe_disabled(kp))) {
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001069 set_kprobe_instance(kp);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001070 kp->post_handler(kp, regs, flags);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001071 reset_kprobe_instance();
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001072 }
1073 }
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001074}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001075NOKPROBE_SYMBOL(aggr_post_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001076
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001077static int aggr_fault_handler(struct kprobe *p, struct pt_regs *regs,
1078 int trapnr)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001079{
Christoph Lameterb76834b2010-12-06 11:16:25 -06001080 struct kprobe *cur = __this_cpu_read(kprobe_instance);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001081
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001082 /*
1083 * if we faulted "during" the execution of a user specified
1084 * probe handler, invoke just that probe's fault handler
1085 */
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001086 if (cur && cur->fault_handler) {
1087 if (cur->fault_handler(cur, regs, trapnr))
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001088 return 1;
1089 }
1090 return 0;
1091}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001092NOKPROBE_SYMBOL(aggr_fault_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001093
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001094static int aggr_break_handler(struct kprobe *p, struct pt_regs *regs)
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001095{
Christoph Lameterb76834b2010-12-06 11:16:25 -06001096 struct kprobe *cur = __this_cpu_read(kprobe_instance);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001097 int ret = 0;
1098
1099 if (cur && cur->break_handler) {
1100 if (cur->break_handler(cur, regs))
1101 ret = 1;
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001102 }
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001103 reset_kprobe_instance();
1104 return ret;
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001105}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001106NOKPROBE_SYMBOL(aggr_break_handler);
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001107
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001108/* Walks the list and increments nmissed count for multiprobe case */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001109void kprobes_inc_nmissed_count(struct kprobe *p)
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001110{
1111 struct kprobe *kp;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001112 if (!kprobe_aggrprobe(p)) {
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001113 p->nmissed++;
1114 } else {
1115 list_for_each_entry_rcu(kp, &p->list, list)
1116 kp->nmissed++;
1117 }
1118 return;
1119}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001120NOKPROBE_SYMBOL(kprobes_inc_nmissed_count);
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001121
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001122void recycle_rp_inst(struct kretprobe_instance *ri,
1123 struct hlist_head *head)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001124{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001125 struct kretprobe *rp = ri->rp;
1126
Hien Nguyenb94cce92005-06-23 00:09:19 -07001127 /* remove rp inst off the rprobe_inst_table */
1128 hlist_del(&ri->hlist);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001129 INIT_HLIST_NODE(&ri->hlist);
1130 if (likely(rp)) {
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001131 raw_spin_lock(&rp->lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001132 hlist_add_head(&ri->hlist, &rp->free_instances);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001133 raw_spin_unlock(&rp->lock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001134 } else
1135 /* Unregistering */
bibo,mao99219a32006-10-02 02:17:35 -07001136 hlist_add_head(&ri->hlist, head);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001137}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001138NOKPROBE_SYMBOL(recycle_rp_inst);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001139
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001140void kretprobe_hash_lock(struct task_struct *tsk,
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001141 struct hlist_head **head, unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001142__acquires(hlist_lock)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001143{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001144 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001145 raw_spinlock_t *hlist_lock;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001146
1147 *head = &kretprobe_inst_table[hash];
1148 hlist_lock = kretprobe_table_lock_ptr(hash);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001149 raw_spin_lock_irqsave(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001150}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001151NOKPROBE_SYMBOL(kretprobe_hash_lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001152
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001153static void kretprobe_table_lock(unsigned long hash,
1154 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001155__acquires(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001156{
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001157 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1158 raw_spin_lock_irqsave(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001159}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001160NOKPROBE_SYMBOL(kretprobe_table_lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001161
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001162void kretprobe_hash_unlock(struct task_struct *tsk,
1163 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001164__releases(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001165{
1166 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001167 raw_spinlock_t *hlist_lock;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001168
1169 hlist_lock = kretprobe_table_lock_ptr(hash);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001170 raw_spin_unlock_irqrestore(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001171}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001172NOKPROBE_SYMBOL(kretprobe_hash_unlock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001173
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001174static void kretprobe_table_unlock(unsigned long hash,
1175 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001176__releases(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001177{
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001178 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1179 raw_spin_unlock_irqrestore(hlist_lock, *flags);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001180}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001181NOKPROBE_SYMBOL(kretprobe_table_unlock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001182
Hien Nguyenb94cce92005-06-23 00:09:19 -07001183/*
bibo maoc6fd91f2006-03-26 01:38:20 -08001184 * This function is called from finish_task_switch when task tk becomes dead,
1185 * so that we can recycle any function-return probe instances associated
1186 * with this task. These left over instances represent probed functions
1187 * that have been called but will never return.
Hien Nguyenb94cce92005-06-23 00:09:19 -07001188 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001189void kprobe_flush_task(struct task_struct *tk)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001190{
bibo,mao62c27be2006-10-02 02:17:33 -07001191 struct kretprobe_instance *ri;
bibo,mao99219a32006-10-02 02:17:35 -07001192 struct hlist_head *head, empty_rp;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001193 struct hlist_node *tmp;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001194 unsigned long hash, flags = 0;
Rusty Lynch802eae72005-06-27 15:17:08 -07001195
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001196 if (unlikely(!kprobes_initialized))
1197 /* Early boot. kretprobe_table_locks not yet initialized. */
1198 return;
1199
Ananth N Mavinakayanahallid496aab2012-01-20 14:34:04 -08001200 INIT_HLIST_HEAD(&empty_rp);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001201 hash = hash_ptr(tk, KPROBE_HASH_BITS);
1202 head = &kretprobe_inst_table[hash];
1203 kretprobe_table_lock(hash, &flags);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001204 hlist_for_each_entry_safe(ri, tmp, head, hlist) {
bibo,mao62c27be2006-10-02 02:17:33 -07001205 if (ri->task == tk)
bibo,mao99219a32006-10-02 02:17:35 -07001206 recycle_rp_inst(ri, &empty_rp);
bibo,mao62c27be2006-10-02 02:17:33 -07001207 }
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001208 kretprobe_table_unlock(hash, &flags);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001209 hlist_for_each_entry_safe(ri, tmp, &empty_rp, hlist) {
bibo,mao99219a32006-10-02 02:17:35 -07001210 hlist_del(&ri->hlist);
1211 kfree(ri);
1212 }
Hien Nguyenb94cce92005-06-23 00:09:19 -07001213}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001214NOKPROBE_SYMBOL(kprobe_flush_task);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001215
Hien Nguyenb94cce92005-06-23 00:09:19 -07001216static inline void free_rp_inst(struct kretprobe *rp)
1217{
1218 struct kretprobe_instance *ri;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001219 struct hlist_node *next;
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001220
Sasha Levinb67bfe02013-02-27 17:06:00 -08001221 hlist_for_each_entry_safe(ri, next, &rp->free_instances, hlist) {
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001222 hlist_del(&ri->hlist);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001223 kfree(ri);
1224 }
1225}
1226
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001227static void cleanup_rp_inst(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001228{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001229 unsigned long flags, hash;
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001230 struct kretprobe_instance *ri;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001231 struct hlist_node *next;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001232 struct hlist_head *head;
1233
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001234 /* No race here */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001235 for (hash = 0; hash < KPROBE_TABLE_SIZE; hash++) {
1236 kretprobe_table_lock(hash, &flags);
1237 head = &kretprobe_inst_table[hash];
Sasha Levinb67bfe02013-02-27 17:06:00 -08001238 hlist_for_each_entry_safe(ri, next, head, hlist) {
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001239 if (ri->rp == rp)
1240 ri->rp = NULL;
1241 }
1242 kretprobe_table_unlock(hash, &flags);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001243 }
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001244 free_rp_inst(rp);
1245}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001246NOKPROBE_SYMBOL(cleanup_rp_inst);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001247
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001248/*
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001249* Add the new probe to ap->list. Fail if this is the
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001250* second jprobe at the address - two jprobes can't coexist
1251*/
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001252static int add_new_kprobe(struct kprobe *ap, struct kprobe *p)
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001253{
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001254 BUG_ON(kprobe_gone(ap) || kprobe_gone(p));
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001255
1256 if (p->break_handler || p->post_handler)
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001257 unoptimize_kprobe(ap, true); /* Fall back to normal kprobe */
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001258
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001259 if (p->break_handler) {
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001260 if (ap->break_handler)
mao, bibo36721652006-06-26 00:25:22 -07001261 return -EEXIST;
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001262 list_add_tail_rcu(&p->list, &ap->list);
1263 ap->break_handler = aggr_break_handler;
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001264 } else
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001265 list_add_rcu(&p->list, &ap->list);
1266 if (p->post_handler && !ap->post_handler)
1267 ap->post_handler = aggr_post_handler;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001268
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001269 return 0;
1270}
1271
1272/*
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001273 * Fill in the required fields of the "manager kprobe". Replace the
1274 * earlier kprobe in the hlist with the manager kprobe
1275 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001276static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001277{
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001278 /* Copy p's insn slot to ap */
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001279 copy_kprobe(p, ap);
bibo, maoa9ad9652006-07-30 03:03:26 -07001280 flush_insn_slot(ap);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001281 ap->addr = p->addr;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001282 ap->flags = p->flags & ~KPROBE_FLAG_OPTIMIZED;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001283 ap->pre_handler = aggr_pre_handler;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001284 ap->fault_handler = aggr_fault_handler;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001285 /* We don't care the kprobe which has gone. */
1286 if (p->post_handler && !kprobe_gone(p))
mao, bibo36721652006-06-26 00:25:22 -07001287 ap->post_handler = aggr_post_handler;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001288 if (p->break_handler && !kprobe_gone(p))
mao, bibo36721652006-06-26 00:25:22 -07001289 ap->break_handler = aggr_break_handler;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001290
1291 INIT_LIST_HEAD(&ap->list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001292 INIT_HLIST_NODE(&ap->hlist);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001293
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001294 list_add_rcu(&p->list, &ap->list);
Keshavamurthy Anil Sadad0f32005-12-12 00:37:12 -08001295 hlist_replace_rcu(&p->hlist, &ap->hlist);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001296}
1297
1298/*
1299 * This is the second or subsequent kprobe at the address - handle
1300 * the intricacies
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001301 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001302static int register_aggr_kprobe(struct kprobe *orig_p, struct kprobe *p)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001303{
1304 int ret = 0;
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001305 struct kprobe *ap = orig_p;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001306
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001307 cpus_read_lock();
1308
Masami Hiramatsu25764282012-06-05 19:28:26 +09001309 /* For preparing optimization, jump_label_text_reserved() is called */
1310 jump_label_lock();
Masami Hiramatsu25764282012-06-05 19:28:26 +09001311 mutex_lock(&text_mutex);
1312
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001313 if (!kprobe_aggrprobe(orig_p)) {
1314 /* If orig_p is not an aggr_kprobe, create new aggr_kprobe. */
1315 ap = alloc_aggr_kprobe(orig_p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001316 if (!ap) {
1317 ret = -ENOMEM;
1318 goto out;
1319 }
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001320 init_aggr_kprobe(ap, orig_p);
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001321 } else if (kprobe_unused(ap))
Masami Hiramatsu0490cd12010-12-03 18:54:16 +09001322 /* This probe is going to die. Rescue it */
1323 reuse_unused_kprobe(ap);
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001324
1325 if (kprobe_gone(ap)) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001326 /*
1327 * Attempting to insert new probe at the same location that
1328 * had a probe in the module vaddr area which already
1329 * freed. So, the instruction slot has already been
1330 * released. We need a new slot for the new probe.
1331 */
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001332 ret = arch_prepare_kprobe(ap);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001333 if (ret)
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001334 /*
1335 * Even if fail to allocate new slot, don't need to
1336 * free aggr_probe. It will be used next time, or
1337 * freed by unregister_kprobe.
1338 */
Masami Hiramatsu25764282012-06-05 19:28:26 +09001339 goto out;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001340
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001341 /* Prepare optimized instructions if possible. */
1342 prepare_optimized_kprobe(ap);
1343
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001344 /*
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001345 * Clear gone flag to prevent allocating new slot again, and
1346 * set disabled flag because it is not armed yet.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001347 */
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001348 ap->flags = (ap->flags & ~KPROBE_FLAG_GONE)
1349 | KPROBE_FLAG_DISABLED;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001350 }
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001351
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001352 /* Copy ap's insn slot to p */
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001353 copy_kprobe(ap, p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001354 ret = add_new_kprobe(ap, p);
1355
1356out:
1357 mutex_unlock(&text_mutex);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001358 jump_label_unlock();
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001359 cpus_read_unlock();
Masami Hiramatsu25764282012-06-05 19:28:26 +09001360
1361 if (ret == 0 && kprobe_disabled(ap) && !kprobe_disabled(p)) {
1362 ap->flags &= ~KPROBE_FLAG_DISABLED;
1363 if (!kprobes_all_disarmed)
1364 /* Arm the breakpoint again. */
1365 arm_kprobe(ap);
1366 }
1367 return ret;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001368}
1369
Masami Hiramatsube8f2742014-04-17 17:16:58 +09001370bool __weak arch_within_kprobe_blacklist(unsigned long addr)
1371{
1372 /* The __kprobes marked functions and entry code must not be probed */
1373 return addr >= (unsigned long)__kprobes_text_start &&
1374 addr < (unsigned long)__kprobes_text_end;
1375}
1376
Andy Lutomirskie5779e82015-07-30 20:32:40 -07001377bool within_kprobe_blacklist(unsigned long addr)
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001378{
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001379 struct kprobe_blacklist_entry *ent;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001380
Masami Hiramatsube8f2742014-04-17 17:16:58 +09001381 if (arch_within_kprobe_blacklist(addr))
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001382 return true;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001383 /*
1384 * If there exists a kprobe_blacklist, verify and
1385 * fail any probe registration in the prohibited area
1386 */
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001387 list_for_each_entry(ent, &kprobe_blacklist, list) {
1388 if (addr >= ent->start_addr && addr < ent->end_addr)
1389 return true;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001390 }
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001391
1392 return false;
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001393}
1394
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001395/*
1396 * If we have a symbol_name argument, look it up and add the offset field
1397 * to it. This way, we can specify a relative address to a symbol.
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001398 * This returns encoded errors if it fails to look up symbol or invalid
1399 * combination of parameters.
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001400 */
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301401static kprobe_opcode_t *_kprobe_addr(kprobe_opcode_t *addr,
1402 const char *symbol_name, unsigned int offset)
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001403{
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301404 if ((symbol_name && addr) || (!symbol_name && !addr))
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001405 goto invalid;
1406
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301407 if (symbol_name) {
Linus Torvalds7246f602017-05-05 11:36:44 -07001408 addr = kprobe_lookup_name(symbol_name, offset);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001409 if (!addr)
1410 return ERR_PTR(-ENOENT);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001411 }
1412
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301413 addr = (kprobe_opcode_t *)(((char *)addr) + offset);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001414 if (addr)
1415 return addr;
1416
1417invalid:
1418 return ERR_PTR(-EINVAL);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001419}
1420
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301421static kprobe_opcode_t *kprobe_addr(struct kprobe *p)
1422{
1423 return _kprobe_addr(p->addr, p->symbol_name, p->offset);
1424}
1425
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301426/* Check passed kprobe is valid and return kprobe in kprobe_table. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001427static struct kprobe *__get_valid_kprobe(struct kprobe *p)
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301428{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001429 struct kprobe *ap, *list_p;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301430
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001431 ap = get_kprobe(p->addr);
1432 if (unlikely(!ap))
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301433 return NULL;
1434
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001435 if (p != ap) {
1436 list_for_each_entry_rcu(list_p, &ap->list, list)
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301437 if (list_p == p)
1438 /* kprobe p is a valid probe */
1439 goto valid;
1440 return NULL;
1441 }
1442valid:
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001443 return ap;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301444}
1445
1446/* Return error if the kprobe is being re-registered */
1447static inline int check_kprobe_rereg(struct kprobe *p)
1448{
1449 int ret = 0;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301450
1451 mutex_lock(&kprobe_mutex);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001452 if (__get_valid_kprobe(p))
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301453 ret = -EINVAL;
1454 mutex_unlock(&kprobe_mutex);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001455
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301456 return ret;
1457}
1458
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001459int __weak arch_check_ftrace_location(struct kprobe *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460{
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001461 unsigned long ftrace_addr;
1462
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001463 ftrace_addr = ftrace_location((unsigned long)p->addr);
1464 if (ftrace_addr) {
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001465#ifdef CONFIG_KPROBES_ON_FTRACE
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001466 /* Given address is not on the instruction boundary */
1467 if ((unsigned long)p->addr != ftrace_addr)
1468 return -EILSEQ;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001469 p->flags |= KPROBE_FLAG_FTRACE;
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001470#else /* !CONFIG_KPROBES_ON_FTRACE */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001471 return -EINVAL;
1472#endif
1473 }
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001474 return 0;
1475}
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001476
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001477static int check_kprobe_address_safe(struct kprobe *p,
1478 struct module **probed_mod)
1479{
1480 int ret;
1481
1482 ret = arch_check_ftrace_location(p);
1483 if (ret)
1484 return ret;
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001485 jump_label_lock();
1486 preempt_disable();
1487
1488 /* Ensure it is not in reserved area nor out of text */
1489 if (!kernel_text_address((unsigned long) p->addr) ||
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001490 within_kprobe_blacklist((unsigned long) p->addr) ||
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001491 jump_label_text_reserved(p->addr, p->addr)) {
1492 ret = -EINVAL;
1493 goto out;
1494 }
1495
1496 /* Check if are we probing a module */
1497 *probed_mod = __module_text_address((unsigned long) p->addr);
1498 if (*probed_mod) {
1499 /*
1500 * We must hold a refcount of the probed module while updating
1501 * its code to prohibit unexpected unloading.
1502 */
1503 if (unlikely(!try_module_get(*probed_mod))) {
1504 ret = -ENOENT;
1505 goto out;
1506 }
1507
1508 /*
1509 * If the module freed .init.text, we couldn't insert
1510 * kprobes in there.
1511 */
1512 if (within_module_init((unsigned long)p->addr, *probed_mod) &&
1513 (*probed_mod)->state != MODULE_STATE_COMING) {
1514 module_put(*probed_mod);
1515 *probed_mod = NULL;
1516 ret = -ENOENT;
1517 }
1518 }
1519out:
1520 preempt_enable();
1521 jump_label_unlock();
1522
1523 return ret;
1524}
1525
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001526int register_kprobe(struct kprobe *p)
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001527{
1528 int ret;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001529 struct kprobe *old_p;
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001530 struct module *probed_mod;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001531 kprobe_opcode_t *addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001533 /* Adjust probe address from symbol */
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001534 addr = kprobe_addr(p);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001535 if (IS_ERR(addr))
1536 return PTR_ERR(addr);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001537 p->addr = addr;
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -07001538
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301539 ret = check_kprobe_rereg(p);
1540 if (ret)
1541 return ret;
1542
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001543 /* User can pass only KPROBE_FLAG_DISABLED to register_kprobe */
1544 p->flags &= KPROBE_FLAG_DISABLED;
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001545 p->nmissed = 0;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001546 INIT_LIST_HEAD(&p->list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001547
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001548 ret = check_kprobe_address_safe(p, &probed_mod);
1549 if (ret)
1550 return ret;
1551
1552 mutex_lock(&kprobe_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001553
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001554 old_p = get_kprobe(p->addr);
1555 if (old_p) {
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001556 /* Since this may unoptimize old_p, locking text_mutex. */
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001557 ret = register_aggr_kprobe(old_p, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558 goto out;
1559 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001561 cpus_read_lock();
1562 /* Prevent text modification */
1563 mutex_lock(&text_mutex);
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001564 ret = prepare_kprobe(p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001565 mutex_unlock(&text_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001566 cpus_read_unlock();
Christoph Hellwig6f716ac2007-05-08 00:34:13 -07001567 if (ret)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001568 goto out;
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001569
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001570 INIT_HLIST_NODE(&p->hlist);
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001571 hlist_add_head_rcu(&p->hlist,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 &kprobe_table[hash_ptr(p->addr, KPROBE_HASH_BITS)]);
1573
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001574 if (!kprobes_all_disarmed && !kprobe_disabled(p))
Masami Hiramatsu25764282012-06-05 19:28:26 +09001575 arm_kprobe(p);
Christoph Hellwig74a0b572007-10-16 01:24:07 -07001576
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001577 /* Try to optimize kprobe */
1578 try_to_optimize_kprobe(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579out:
Ingo Molnar7a7d1cf2006-03-23 03:00:35 -08001580 mutex_unlock(&kprobe_mutex);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001581
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001582 if (probed_mod)
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001583 module_put(probed_mod);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001584
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585 return ret;
1586}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001587EXPORT_SYMBOL_GPL(register_kprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001589/* Check if all probes on the aggrprobe are disabled */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001590static int aggr_kprobe_disabled(struct kprobe *ap)
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001591{
1592 struct kprobe *kp;
1593
1594 list_for_each_entry_rcu(kp, &ap->list, list)
1595 if (!kprobe_disabled(kp))
1596 /*
1597 * There is an active probe on the list.
1598 * We can't disable this ap.
1599 */
1600 return 0;
1601
1602 return 1;
1603}
1604
1605/* Disable one kprobe: Make sure called under kprobe_mutex is locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001606static struct kprobe *__disable_kprobe(struct kprobe *p)
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001607{
1608 struct kprobe *orig_p;
1609
1610 /* Get an original kprobe for return */
1611 orig_p = __get_valid_kprobe(p);
1612 if (unlikely(orig_p == NULL))
1613 return NULL;
1614
1615 if (!kprobe_disabled(p)) {
1616 /* Disable probe if it is a child probe */
1617 if (p != orig_p)
1618 p->flags |= KPROBE_FLAG_DISABLED;
1619
1620 /* Try to disarm and disable this/parent probe */
1621 if (p == orig_p || aggr_kprobe_disabled(orig_p)) {
Wang Nan69d54b92015-02-13 14:40:26 -08001622 /*
1623 * If kprobes_all_disarmed is set, orig_p
1624 * should have already been disarmed, so
1625 * skip unneed disarming process.
1626 */
1627 if (!kprobes_all_disarmed)
1628 disarm_kprobe(orig_p, true);
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001629 orig_p->flags |= KPROBE_FLAG_DISABLED;
1630 }
1631 }
1632
1633 return orig_p;
1634}
1635
Masami Hiramatsu98616682008-04-28 02:14:28 -07001636/*
1637 * Unregister a kprobe without a scheduler synchronization.
1638 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001639static int __unregister_kprobe_top(struct kprobe *p)
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001640{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001641 struct kprobe *ap, *list_p;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001642
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001643 /* Disable kprobe. This will disarm it if needed. */
1644 ap = __disable_kprobe(p);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001645 if (ap == NULL)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001646 return -EINVAL;
1647
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001648 if (ap == p)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001649 /*
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001650 * This probe is an independent(and non-optimized) kprobe
1651 * (not an aggrprobe). Remove from the hash list.
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001652 */
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001653 goto disarmed;
1654
1655 /* Following process expects this probe is an aggrprobe */
1656 WARN_ON(!kprobe_aggrprobe(ap));
1657
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001658 if (list_is_singular(&ap->list) && kprobe_disarmed(ap))
1659 /*
1660 * !disarmed could be happen if the probe is under delayed
1661 * unoptimizing.
1662 */
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001663 goto disarmed;
1664 else {
1665 /* If disabling probe has special handlers, update aggrprobe */
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001666 if (p->break_handler && !kprobe_gone(p))
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001667 ap->break_handler = NULL;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001668 if (p->post_handler && !kprobe_gone(p)) {
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001669 list_for_each_entry_rcu(list_p, &ap->list, list) {
Masami Hiramatsu98616682008-04-28 02:14:28 -07001670 if ((list_p != p) && (list_p->post_handler))
1671 goto noclean;
1672 }
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001673 ap->post_handler = NULL;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001674 }
1675noclean:
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001676 /*
1677 * Remove from the aggrprobe: this path will do nothing in
1678 * __unregister_kprobe_bottom().
1679 */
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001680 list_del_rcu(&p->list);
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001681 if (!kprobe_disabled(ap) && !kprobes_all_disarmed)
1682 /*
1683 * Try to optimize this probe again, because post
1684 * handler may have been changed.
1685 */
1686 optimize_kprobe(ap);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001687 }
Masami Hiramatsu98616682008-04-28 02:14:28 -07001688 return 0;
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001689
1690disarmed:
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001691 BUG_ON(!kprobe_disarmed(ap));
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001692 hlist_del_rcu(&ap->hlist);
1693 return 0;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001694}
Mao, Bibob3e55c72005-12-12 00:37:00 -08001695
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001696static void __unregister_kprobe_bottom(struct kprobe *p)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001697{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001698 struct kprobe *ap;
Mao, Bibob3e55c72005-12-12 00:37:00 -08001699
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001700 if (list_empty(&p->list))
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001701 /* This is an independent kprobe */
Ananth N Mavinakayanahalli0498b632006-01-09 20:52:46 -08001702 arch_remove_kprobe(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001703 else if (list_is_singular(&p->list)) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001704 /* This is the last child of an aggrprobe */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001705 ap = list_entry(p->list.next, struct kprobe, list);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001706 list_del(&p->list);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001707 free_aggr_kprobe(ap);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001708 }
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001709 /* Otherwise, do nothing. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710}
1711
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001712int register_kprobes(struct kprobe **kps, int num)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001713{
1714 int i, ret = 0;
1715
1716 if (num <= 0)
1717 return -EINVAL;
1718 for (i = 0; i < num; i++) {
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001719 ret = register_kprobe(kps[i]);
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001720 if (ret < 0) {
1721 if (i > 0)
1722 unregister_kprobes(kps, i);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001723 break;
1724 }
1725 }
1726 return ret;
1727}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001728EXPORT_SYMBOL_GPL(register_kprobes);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001729
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001730void unregister_kprobe(struct kprobe *p)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001731{
1732 unregister_kprobes(&p, 1);
1733}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001734EXPORT_SYMBOL_GPL(unregister_kprobe);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001735
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001736void unregister_kprobes(struct kprobe **kps, int num)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001737{
1738 int i;
1739
1740 if (num <= 0)
1741 return;
1742 mutex_lock(&kprobe_mutex);
1743 for (i = 0; i < num; i++)
1744 if (__unregister_kprobe_top(kps[i]) < 0)
1745 kps[i]->addr = NULL;
1746 mutex_unlock(&kprobe_mutex);
1747
1748 synchronize_sched();
1749 for (i = 0; i < num; i++)
1750 if (kps[i]->addr)
1751 __unregister_kprobe_bottom(kps[i]);
1752}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001753EXPORT_SYMBOL_GPL(unregister_kprobes);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001754
Naveen N. Rao5f6bee32017-03-08 22:34:15 +05301755int __weak kprobe_exceptions_notify(struct notifier_block *self,
1756 unsigned long val, void *data)
Naveen N. Raofc62d022017-02-08 01:24:14 +05301757{
1758 return NOTIFY_DONE;
1759}
Naveen N. Rao5f6bee32017-03-08 22:34:15 +05301760NOKPROBE_SYMBOL(kprobe_exceptions_notify);
Naveen N. Raofc62d022017-02-08 01:24:14 +05301761
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762static struct notifier_block kprobe_exceptions_nb = {
1763 .notifier_call = kprobe_exceptions_notify,
Anil S Keshavamurthy3d5631e2006-06-26 00:25:28 -07001764 .priority = 0x7fffffff /* we need to be notified first */
1765};
1766
Michael Ellerman3d7e3382007-07-19 01:48:11 -07001767unsigned long __weak arch_deref_entry_point(void *entry)
1768{
1769 return (unsigned long)entry;
1770}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001772int register_jprobes(struct jprobe **jps, int num)
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001773{
1774 struct jprobe *jp;
1775 int ret = 0, i;
1776
1777 if (num <= 0)
1778 return -EINVAL;
1779 for (i = 0; i < num; i++) {
Namhyung Kim05662bd2010-09-15 10:04:27 +09001780 unsigned long addr, offset;
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001781 jp = jps[i];
1782 addr = arch_deref_entry_point(jp->entry);
1783
Namhyung Kim05662bd2010-09-15 10:04:27 +09001784 /* Verify probepoint is a function entry point */
1785 if (kallsyms_lookup_size_offset(addr, NULL, &offset) &&
1786 offset == 0) {
1787 jp->kp.pre_handler = setjmp_pre_handler;
1788 jp->kp.break_handler = longjmp_break_handler;
1789 ret = register_kprobe(&jp->kp);
1790 } else
1791 ret = -EINVAL;
Namhyung Kimedbaadb2010-09-15 10:04:26 +09001792
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001793 if (ret < 0) {
1794 if (i > 0)
1795 unregister_jprobes(jps, i);
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001796 break;
1797 }
1798 }
1799 return ret;
1800}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001801EXPORT_SYMBOL_GPL(register_jprobes);
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001802
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001803int register_jprobe(struct jprobe *jp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804{
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001805 return register_jprobes(&jp, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001807EXPORT_SYMBOL_GPL(register_jprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001809void unregister_jprobe(struct jprobe *jp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810{
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001811 unregister_jprobes(&jp, 1);
1812}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001813EXPORT_SYMBOL_GPL(unregister_jprobe);
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001814
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001815void unregister_jprobes(struct jprobe **jps, int num)
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001816{
1817 int i;
1818
1819 if (num <= 0)
1820 return;
1821 mutex_lock(&kprobe_mutex);
1822 for (i = 0; i < num; i++)
1823 if (__unregister_kprobe_top(&jps[i]->kp) < 0)
1824 jps[i]->kp.addr = NULL;
1825 mutex_unlock(&kprobe_mutex);
1826
1827 synchronize_sched();
1828 for (i = 0; i < num; i++) {
1829 if (jps[i]->kp.addr)
1830 __unregister_kprobe_bottom(&jps[i]->kp);
1831 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001833EXPORT_SYMBOL_GPL(unregister_jprobes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08001835#ifdef CONFIG_KRETPROBES
Adrian Bunke65cefe2006-02-03 03:03:42 -08001836/*
1837 * This kprobe pre_handler is registered with every kretprobe. When probe
1838 * hits it will set up the return probe.
1839 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001840static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
Adrian Bunke65cefe2006-02-03 03:03:42 -08001841{
1842 struct kretprobe *rp = container_of(p, struct kretprobe, kp);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001843 unsigned long hash, flags = 0;
1844 struct kretprobe_instance *ri;
Adrian Bunke65cefe2006-02-03 03:03:42 -08001845
Masami Hiramatsuf96f5672014-08-04 03:10:16 +00001846 /*
1847 * To avoid deadlocks, prohibit return probing in NMI contexts,
1848 * just skip the probe and increase the (inexact) 'nmissed'
1849 * statistical counter, so that the user is informed that
1850 * something happened:
1851 */
1852 if (unlikely(in_nmi())) {
1853 rp->nmissed++;
1854 return 0;
1855 }
1856
1857 /* TODO: consider to only swap the RA after the last pre_handler fired */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001858 hash = hash_ptr(current, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001859 raw_spin_lock_irqsave(&rp->lock, flags);
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001860 if (!hlist_empty(&rp->free_instances)) {
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001861 ri = hlist_entry(rp->free_instances.first,
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001862 struct kretprobe_instance, hlist);
1863 hlist_del(&ri->hlist);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001864 raw_spin_unlock_irqrestore(&rp->lock, flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001865
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001866 ri->rp = rp;
1867 ri->task = current;
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001868
Jiang Liu55ca6142012-02-03 15:37:16 -08001869 if (rp->entry_handler && rp->entry_handler(ri, regs)) {
1870 raw_spin_lock_irqsave(&rp->lock, flags);
1871 hlist_add_head(&ri->hlist, &rp->free_instances);
1872 raw_spin_unlock_irqrestore(&rp->lock, flags);
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001873 return 0;
Jiang Liu55ca6142012-02-03 15:37:16 -08001874 }
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001875
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001876 arch_prepare_kretprobe(ri, regs);
1877
1878 /* XXX(hch): why is there no hlist_move_head? */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001879 INIT_HLIST_NODE(&ri->hlist);
1880 kretprobe_table_lock(hash, &flags);
1881 hlist_add_head(&ri->hlist, &kretprobe_inst_table[hash]);
1882 kretprobe_table_unlock(hash, &flags);
1883 } else {
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001884 rp->nmissed++;
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001885 raw_spin_unlock_irqrestore(&rp->lock, flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001886 }
Adrian Bunke65cefe2006-02-03 03:03:42 -08001887 return 0;
1888}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001889NOKPROBE_SYMBOL(pre_handler_kretprobe);
Adrian Bunke65cefe2006-02-03 03:03:42 -08001890
Naveen N. Rao90ec5e82017-02-22 19:23:37 +05301891bool __weak arch_function_offset_within_entry(unsigned long offset)
1892{
1893 return !offset;
1894}
1895
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301896bool function_offset_within_entry(kprobe_opcode_t *addr, const char *sym, unsigned long offset)
1897{
1898 kprobe_opcode_t *kp_addr = _kprobe_addr(addr, sym, offset);
1899
1900 if (IS_ERR(kp_addr))
1901 return false;
1902
1903 if (!kallsyms_lookup_size_offset((unsigned long)kp_addr, NULL, &offset) ||
1904 !arch_function_offset_within_entry(offset))
1905 return false;
1906
1907 return true;
1908}
1909
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001910int register_kretprobe(struct kretprobe *rp)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001911{
1912 int ret = 0;
1913 struct kretprobe_instance *inst;
1914 int i;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001915 void *addr;
Naveen N. Rao90ec5e82017-02-22 19:23:37 +05301916
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301917 if (!function_offset_within_entry(rp->kp.addr, rp->kp.symbol_name, rp->kp.offset))
Naveen N. Rao90ec5e82017-02-22 19:23:37 +05301918 return -EINVAL;
Masami Hiramatsuf438d912007-10-16 01:27:49 -07001919
1920 if (kretprobe_blacklist_size) {
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001921 addr = kprobe_addr(&rp->kp);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001922 if (IS_ERR(addr))
1923 return PTR_ERR(addr);
Masami Hiramatsuf438d912007-10-16 01:27:49 -07001924
1925 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
1926 if (kretprobe_blacklist[i].addr == addr)
1927 return -EINVAL;
1928 }
1929 }
Hien Nguyenb94cce92005-06-23 00:09:19 -07001930
1931 rp->kp.pre_handler = pre_handler_kretprobe;
Ananth N Mavinakayanahalli7522a842006-04-20 02:43:11 -07001932 rp->kp.post_handler = NULL;
1933 rp->kp.fault_handler = NULL;
1934 rp->kp.break_handler = NULL;
Hien Nguyenb94cce92005-06-23 00:09:19 -07001935
1936 /* Pre-allocate memory for max kretprobe instances */
1937 if (rp->maxactive <= 0) {
1938#ifdef CONFIG_PREEMPT
Heiko Carstensc2ef6662009-12-21 13:02:24 +01001939 rp->maxactive = max_t(unsigned int, 10, 2*num_possible_cpus());
Hien Nguyenb94cce92005-06-23 00:09:19 -07001940#else
Ananth N Mavinakayanahalli4dae5602009-10-30 19:23:10 +05301941 rp->maxactive = num_possible_cpus();
Hien Nguyenb94cce92005-06-23 00:09:19 -07001942#endif
1943 }
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001944 raw_spin_lock_init(&rp->lock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001945 INIT_HLIST_HEAD(&rp->free_instances);
1946 for (i = 0; i < rp->maxactive; i++) {
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001947 inst = kmalloc(sizeof(struct kretprobe_instance) +
1948 rp->data_size, GFP_KERNEL);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001949 if (inst == NULL) {
1950 free_rp_inst(rp);
1951 return -ENOMEM;
1952 }
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001953 INIT_HLIST_NODE(&inst->hlist);
1954 hlist_add_head(&inst->hlist, &rp->free_instances);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001955 }
1956
1957 rp->nmissed = 0;
1958 /* Establish function entry probe point */
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001959 ret = register_kprobe(&rp->kp);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001960 if (ret != 0)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001961 free_rp_inst(rp);
1962 return ret;
1963}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001964EXPORT_SYMBOL_GPL(register_kretprobe);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001965
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001966int register_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001967{
1968 int ret = 0, i;
1969
1970 if (num <= 0)
1971 return -EINVAL;
1972 for (i = 0; i < num; i++) {
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001973 ret = register_kretprobe(rps[i]);
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001974 if (ret < 0) {
1975 if (i > 0)
1976 unregister_kretprobes(rps, i);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001977 break;
1978 }
1979 }
1980 return ret;
1981}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001982EXPORT_SYMBOL_GPL(register_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001983
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001984void unregister_kretprobe(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001985{
1986 unregister_kretprobes(&rp, 1);
1987}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001988EXPORT_SYMBOL_GPL(unregister_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001989
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001990void unregister_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001991{
1992 int i;
1993
1994 if (num <= 0)
1995 return;
1996 mutex_lock(&kprobe_mutex);
1997 for (i = 0; i < num; i++)
1998 if (__unregister_kprobe_top(&rps[i]->kp) < 0)
1999 rps[i]->kp.addr = NULL;
2000 mutex_unlock(&kprobe_mutex);
2001
2002 synchronize_sched();
2003 for (i = 0; i < num; i++) {
2004 if (rps[i]->kp.addr) {
2005 __unregister_kprobe_bottom(&rps[i]->kp);
2006 cleanup_rp_inst(rps[i]);
2007 }
2008 }
2009}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002010EXPORT_SYMBOL_GPL(unregister_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002011
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08002012#else /* CONFIG_KRETPROBES */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002013int register_kretprobe(struct kretprobe *rp)
Hien Nguyenb94cce92005-06-23 00:09:19 -07002014{
2015 return -ENOSYS;
2016}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002017EXPORT_SYMBOL_GPL(register_kretprobe);
Hien Nguyenb94cce92005-06-23 00:09:19 -07002018
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002019int register_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002020{
2021 return -ENOSYS;
2022}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002023EXPORT_SYMBOL_GPL(register_kretprobes);
2024
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002025void unregister_kretprobe(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002026{
2027}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002028EXPORT_SYMBOL_GPL(unregister_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002029
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002030void unregister_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002031{
2032}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002033EXPORT_SYMBOL_GPL(unregister_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002034
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002035static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002036{
2037 return 0;
2038}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002039NOKPROBE_SYMBOL(pre_handler_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002040
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08002041#endif /* CONFIG_KRETPROBES */
Hien Nguyenb94cce92005-06-23 00:09:19 -07002042
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002043/* Set the kprobe gone and remove its instruction buffer. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002044static void kill_kprobe(struct kprobe *p)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002045{
2046 struct kprobe *kp;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002047
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002048 p->flags |= KPROBE_FLAG_GONE;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002049 if (kprobe_aggrprobe(p)) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002050 /*
2051 * If this is an aggr_kprobe, we have to list all the
2052 * chained probes and mark them GONE.
2053 */
2054 list_for_each_entry_rcu(kp, &p->list, list)
2055 kp->flags |= KPROBE_FLAG_GONE;
2056 p->post_handler = NULL;
2057 p->break_handler = NULL;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002058 kill_optimized_kprobe(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002059 }
2060 /*
2061 * Here, we can remove insn_slot safely, because no thread calls
2062 * the original probed function (which will be freed soon) any more.
2063 */
2064 arch_remove_kprobe(p);
2065}
2066
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002067/* Disable one kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002068int disable_kprobe(struct kprobe *kp)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002069{
2070 int ret = 0;
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002071
2072 mutex_lock(&kprobe_mutex);
2073
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09002074 /* Disable this kprobe */
2075 if (__disable_kprobe(kp) == NULL)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002076 ret = -EINVAL;
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002077
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002078 mutex_unlock(&kprobe_mutex);
2079 return ret;
2080}
2081EXPORT_SYMBOL_GPL(disable_kprobe);
2082
2083/* Enable one kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002084int enable_kprobe(struct kprobe *kp)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002085{
2086 int ret = 0;
2087 struct kprobe *p;
2088
2089 mutex_lock(&kprobe_mutex);
2090
2091 /* Check whether specified probe is valid. */
2092 p = __get_valid_kprobe(kp);
2093 if (unlikely(p == NULL)) {
2094 ret = -EINVAL;
2095 goto out;
2096 }
2097
2098 if (kprobe_gone(kp)) {
2099 /* This kprobe has gone, we couldn't enable it. */
2100 ret = -EINVAL;
2101 goto out;
2102 }
2103
2104 if (p != kp)
2105 kp->flags &= ~KPROBE_FLAG_DISABLED;
2106
2107 if (!kprobes_all_disarmed && kprobe_disabled(p)) {
2108 p->flags &= ~KPROBE_FLAG_DISABLED;
2109 arm_kprobe(p);
2110 }
2111out:
2112 mutex_unlock(&kprobe_mutex);
2113 return ret;
2114}
2115EXPORT_SYMBOL_GPL(enable_kprobe);
2116
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002117void dump_kprobe(struct kprobe *kp)
Frederic Weisbecker24851d22009-08-26 23:38:30 +02002118{
2119 printk(KERN_WARNING "Dumping kprobe:\n");
2120 printk(KERN_WARNING "Name: %s\nAddress: %p\nOffset: %x\n",
2121 kp->symbol_name, kp->addr, kp->offset);
2122}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002123NOKPROBE_SYMBOL(dump_kprobe);
Frederic Weisbecker24851d22009-08-26 23:38:30 +02002124
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002125/*
2126 * Lookup and populate the kprobe_blacklist.
2127 *
2128 * Unlike the kretprobe blacklist, we'll need to determine
2129 * the range of addresses that belong to the said functions,
2130 * since a kprobe need not necessarily be at the beginning
2131 * of a function.
2132 */
2133static int __init populate_kprobe_blacklist(unsigned long *start,
2134 unsigned long *end)
2135{
2136 unsigned long *iter;
2137 struct kprobe_blacklist_entry *ent;
Masami Hiramatsud81b4252014-07-17 11:44:11 +00002138 unsigned long entry, offset = 0, size = 0;
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002139
2140 for (iter = start; iter < end; iter++) {
Masami Hiramatsud81b4252014-07-17 11:44:11 +00002141 entry = arch_deref_entry_point((void *)*iter);
2142
2143 if (!kernel_text_address(entry) ||
2144 !kallsyms_lookup_size_offset(entry, &size, &offset)) {
2145 pr_err("Failed to find blacklist at %p\n",
2146 (void *)entry);
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002147 continue;
2148 }
2149
2150 ent = kmalloc(sizeof(*ent), GFP_KERNEL);
2151 if (!ent)
2152 return -ENOMEM;
Masami Hiramatsud81b4252014-07-17 11:44:11 +00002153 ent->start_addr = entry;
2154 ent->end_addr = entry + size;
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002155 INIT_LIST_HEAD(&ent->list);
2156 list_add_tail(&ent->list, &kprobe_blacklist);
2157 }
2158 return 0;
2159}
2160
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002161/* Module notifier call back, checking kprobes on the module */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002162static int kprobes_module_callback(struct notifier_block *nb,
2163 unsigned long val, void *data)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002164{
2165 struct module *mod = data;
2166 struct hlist_head *head;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002167 struct kprobe *p;
2168 unsigned int i;
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002169 int checkcore = (val == MODULE_STATE_GOING);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002170
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002171 if (val != MODULE_STATE_GOING && val != MODULE_STATE_LIVE)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002172 return NOTIFY_DONE;
2173
2174 /*
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002175 * When MODULE_STATE_GOING was notified, both of module .text and
2176 * .init.text sections would be freed. When MODULE_STATE_LIVE was
2177 * notified, only .init.text section would be freed. We need to
2178 * disable kprobes which have been inserted in the sections.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002179 */
2180 mutex_lock(&kprobe_mutex);
2181 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2182 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -08002183 hlist_for_each_entry_rcu(p, head, hlist)
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002184 if (within_module_init((unsigned long)p->addr, mod) ||
2185 (checkcore &&
2186 within_module_core((unsigned long)p->addr, mod))) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002187 /*
2188 * The vaddr this probe is installed will soon
2189 * be vfreed buy not synced to disk. Hence,
2190 * disarming the breakpoint isn't needed.
Steven Rostedt (VMware)545a0282017-05-16 14:58:35 -04002191 *
2192 * Note, this will also move any optimized probes
2193 * that are pending to be removed from their
2194 * corresponding lists to the freeing_list and
2195 * will not be touched by the delayed
2196 * kprobe_optimizer work handler.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002197 */
2198 kill_kprobe(p);
2199 }
2200 }
2201 mutex_unlock(&kprobe_mutex);
2202 return NOTIFY_DONE;
2203}
2204
2205static struct notifier_block kprobe_module_nb = {
2206 .notifier_call = kprobes_module_callback,
2207 .priority = 0
2208};
2209
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002210/* Markers of _kprobe_blacklist section */
2211extern unsigned long __start_kprobe_blacklist[];
2212extern unsigned long __stop_kprobe_blacklist[];
2213
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214static int __init init_kprobes(void)
2215{
2216 int i, err = 0;
2217
2218 /* FIXME allocate the probe table, currently defined statically */
2219 /* initialize all list heads */
Hien Nguyenb94cce92005-06-23 00:09:19 -07002220 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221 INIT_HLIST_HEAD(&kprobe_table[i]);
Hien Nguyenb94cce92005-06-23 00:09:19 -07002222 INIT_HLIST_HEAD(&kretprobe_inst_table[i]);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02002223 raw_spin_lock_init(&(kretprobe_table_locks[i].lock));
Hien Nguyenb94cce92005-06-23 00:09:19 -07002224 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002226 err = populate_kprobe_blacklist(__start_kprobe_blacklist,
2227 __stop_kprobe_blacklist);
2228 if (err) {
2229 pr_err("kprobes: failed to populate blacklist: %d\n", err);
2230 pr_err("Please take care of using kprobes.\n");
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07002231 }
2232
Masami Hiramatsuf438d912007-10-16 01:27:49 -07002233 if (kretprobe_blacklist_size) {
2234 /* lookup the function address from its name */
2235 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
Naveen N. Rao49e0b462017-04-19 18:21:00 +05302236 kretprobe_blacklist[i].addr =
Naveen N. Rao290e3072017-04-19 18:21:01 +05302237 kprobe_lookup_name(kretprobe_blacklist[i].name, 0);
Masami Hiramatsuf438d912007-10-16 01:27:49 -07002238 if (!kretprobe_blacklist[i].addr)
2239 printk("kretprobe: lookup failed: %s\n",
2240 kretprobe_blacklist[i].name);
2241 }
2242 }
2243
Masami Hiramatsub2be84d2010-02-25 08:34:15 -05002244#if defined(CONFIG_OPTPROBES)
2245#if defined(__ARCH_WANT_KPROBES_INSN_SLOT)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002246 /* Init kprobe_optinsn_slots */
2247 kprobe_optinsn_slots.insn_size = MAX_OPTINSN_SIZE;
2248#endif
Masami Hiramatsub2be84d2010-02-25 08:34:15 -05002249 /* By default, kprobes can be optimized */
2250 kprobes_allow_optimization = true;
2251#endif
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002252
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002253 /* By default, kprobes are armed */
2254 kprobes_all_disarmed = false;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002255
Rusty Lynch67729262005-07-05 18:54:50 -07002256 err = arch_init_kprobes();
Rusty Lynch802eae72005-06-27 15:17:08 -07002257 if (!err)
2258 err = register_die_notifier(&kprobe_exceptions_nb);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002259 if (!err)
2260 err = register_module_notifier(&kprobe_module_nb);
2261
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07002262 kprobes_initialized = (err == 0);
Rusty Lynch802eae72005-06-27 15:17:08 -07002263
Ananth N Mavinakayanahalli8c1c9352008-01-30 13:32:53 +01002264 if (!err)
2265 init_test_probes();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266 return err;
2267}
2268
Srinivasa Ds346fd592007-02-20 13:57:54 -08002269#ifdef CONFIG_DEBUG_FS
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002270static void report_probe(struct seq_file *pi, struct kprobe *p,
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002271 const char *sym, int offset, char *modname, struct kprobe *pp)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002272{
2273 char *kprobe_type;
2274
2275 if (p->pre_handler == pre_handler_kretprobe)
2276 kprobe_type = "r";
2277 else if (p->pre_handler == setjmp_pre_handler)
2278 kprobe_type = "j";
2279 else
2280 kprobe_type = "k";
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002281
Srinivasa Ds346fd592007-02-20 13:57:54 -08002282 if (sym)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002283 seq_printf(pi, "%p %s %s+0x%x %s ",
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002284 p->addr, kprobe_type, sym, offset,
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002285 (modname ? modname : " "));
Srinivasa Ds346fd592007-02-20 13:57:54 -08002286 else
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002287 seq_printf(pi, "%p %s %p ",
2288 p->addr, kprobe_type, p->addr);
2289
2290 if (!pp)
2291 pp = p;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002292 seq_printf(pi, "%s%s%s%s\n",
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002293 (kprobe_gone(p) ? "[GONE]" : ""),
2294 ((kprobe_disabled(p) && !kprobe_gone(p)) ? "[DISABLED]" : ""),
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002295 (kprobe_optimized(pp) ? "[OPTIMIZED]" : ""),
2296 (kprobe_ftrace(pp) ? "[FTRACE]" : ""));
Srinivasa Ds346fd592007-02-20 13:57:54 -08002297}
2298
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002299static void *kprobe_seq_start(struct seq_file *f, loff_t *pos)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002300{
2301 return (*pos < KPROBE_TABLE_SIZE) ? pos : NULL;
2302}
2303
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002304static void *kprobe_seq_next(struct seq_file *f, void *v, loff_t *pos)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002305{
2306 (*pos)++;
2307 if (*pos >= KPROBE_TABLE_SIZE)
2308 return NULL;
2309 return pos;
2310}
2311
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002312static void kprobe_seq_stop(struct seq_file *f, void *v)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002313{
2314 /* Nothing to do */
2315}
2316
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002317static int show_kprobe_addr(struct seq_file *pi, void *v)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002318{
2319 struct hlist_head *head;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002320 struct kprobe *p, *kp;
2321 const char *sym = NULL;
2322 unsigned int i = *(loff_t *) v;
Alexey Dobriyanffb45122007-05-08 00:28:41 -07002323 unsigned long offset = 0;
Joe Marioab767862013-11-12 15:10:23 -08002324 char *modname, namebuf[KSYM_NAME_LEN];
Srinivasa Ds346fd592007-02-20 13:57:54 -08002325
2326 head = &kprobe_table[i];
2327 preempt_disable();
Sasha Levinb67bfe02013-02-27 17:06:00 -08002328 hlist_for_each_entry_rcu(p, head, hlist) {
Alexey Dobriyanffb45122007-05-08 00:28:41 -07002329 sym = kallsyms_lookup((unsigned long)p->addr, NULL,
Srinivasa Ds346fd592007-02-20 13:57:54 -08002330 &offset, &modname, namebuf);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002331 if (kprobe_aggrprobe(p)) {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002332 list_for_each_entry_rcu(kp, &p->list, list)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002333 report_probe(pi, kp, sym, offset, modname, p);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002334 } else
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002335 report_probe(pi, p, sym, offset, modname, NULL);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002336 }
2337 preempt_enable();
2338 return 0;
2339}
2340
James Morris88e9d342009-09-22 16:43:43 -07002341static const struct seq_operations kprobes_seq_ops = {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002342 .start = kprobe_seq_start,
2343 .next = kprobe_seq_next,
2344 .stop = kprobe_seq_stop,
2345 .show = show_kprobe_addr
2346};
2347
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002348static int kprobes_open(struct inode *inode, struct file *filp)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002349{
2350 return seq_open(filp, &kprobes_seq_ops);
2351}
2352
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002353static const struct file_operations debugfs_kprobes_operations = {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002354 .open = kprobes_open,
2355 .read = seq_read,
2356 .llseek = seq_lseek,
2357 .release = seq_release,
2358};
2359
Masami Hiramatsu63724742014-04-17 17:18:49 +09002360/* kprobes/blacklist -- shows which functions can not be probed */
2361static void *kprobe_blacklist_seq_start(struct seq_file *m, loff_t *pos)
2362{
2363 return seq_list_start(&kprobe_blacklist, *pos);
2364}
2365
2366static void *kprobe_blacklist_seq_next(struct seq_file *m, void *v, loff_t *pos)
2367{
2368 return seq_list_next(v, &kprobe_blacklist, pos);
2369}
2370
2371static int kprobe_blacklist_seq_show(struct seq_file *m, void *v)
2372{
2373 struct kprobe_blacklist_entry *ent =
2374 list_entry(v, struct kprobe_blacklist_entry, list);
2375
2376 seq_printf(m, "0x%p-0x%p\t%ps\n", (void *)ent->start_addr,
2377 (void *)ent->end_addr, (void *)ent->start_addr);
2378 return 0;
2379}
2380
2381static const struct seq_operations kprobe_blacklist_seq_ops = {
2382 .start = kprobe_blacklist_seq_start,
2383 .next = kprobe_blacklist_seq_next,
2384 .stop = kprobe_seq_stop, /* Reuse void function */
2385 .show = kprobe_blacklist_seq_show,
2386};
2387
2388static int kprobe_blacklist_open(struct inode *inode, struct file *filp)
2389{
2390 return seq_open(filp, &kprobe_blacklist_seq_ops);
2391}
2392
2393static const struct file_operations debugfs_kprobe_blacklist_ops = {
2394 .open = kprobe_blacklist_open,
2395 .read = seq_read,
2396 .llseek = seq_lseek,
2397 .release = seq_release,
2398};
2399
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002400static void arm_all_kprobes(void)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002401{
2402 struct hlist_head *head;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002403 struct kprobe *p;
2404 unsigned int i;
2405
2406 mutex_lock(&kprobe_mutex);
2407
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002408 /* If kprobes are armed, just return */
2409 if (!kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002410 goto already_enabled;
2411
Wang Nan977ad482015-02-13 14:40:24 -08002412 /*
2413 * optimize_kprobe() called by arm_kprobe() checks
2414 * kprobes_all_disarmed, so set kprobes_all_disarmed before
2415 * arm_kprobe.
2416 */
2417 kprobes_all_disarmed = false;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002418 /* Arming kprobes doesn't optimize kprobe itself */
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002419 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2420 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -08002421 hlist_for_each_entry_rcu(p, head, hlist)
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002422 if (!kprobe_disabled(p))
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002423 arm_kprobe(p);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002424 }
2425
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002426 printk(KERN_INFO "Kprobes globally enabled\n");
2427
2428already_enabled:
2429 mutex_unlock(&kprobe_mutex);
2430 return;
2431}
2432
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002433static void disarm_all_kprobes(void)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002434{
2435 struct hlist_head *head;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002436 struct kprobe *p;
2437 unsigned int i;
2438
2439 mutex_lock(&kprobe_mutex);
2440
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002441 /* If kprobes are already disarmed, just return */
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002442 if (kprobes_all_disarmed) {
2443 mutex_unlock(&kprobe_mutex);
2444 return;
2445 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002446
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002447 kprobes_all_disarmed = true;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002448 printk(KERN_INFO "Kprobes globally disabled\n");
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002449
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002450 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2451 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -08002452 hlist_for_each_entry_rcu(p, head, hlist) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002453 if (!arch_trampoline_kprobe(p) && !kprobe_disabled(p))
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002454 disarm_kprobe(p, false);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002455 }
2456 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002457 mutex_unlock(&kprobe_mutex);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002458
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002459 /* Wait for disarming all kprobes by optimizer */
2460 wait_for_kprobe_optimizer();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002461}
2462
2463/*
2464 * XXX: The debugfs bool file interface doesn't allow for callbacks
2465 * when the bool state is switched. We can reuse that facility when
2466 * available
2467 */
2468static ssize_t read_enabled_file_bool(struct file *file,
2469 char __user *user_buf, size_t count, loff_t *ppos)
2470{
2471 char buf[3];
2472
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002473 if (!kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002474 buf[0] = '1';
2475 else
2476 buf[0] = '0';
2477 buf[1] = '\n';
2478 buf[2] = 0x00;
2479 return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
2480}
2481
2482static ssize_t write_enabled_file_bool(struct file *file,
2483 const char __user *user_buf, size_t count, loff_t *ppos)
2484{
2485 char buf[32];
Stephen Boydefeb1562012-01-12 17:17:11 -08002486 size_t buf_size;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002487
2488 buf_size = min(count, (sizeof(buf)-1));
2489 if (copy_from_user(buf, user_buf, buf_size))
2490 return -EFAULT;
2491
Mathias Krause10fb46d2013-07-03 15:05:39 -07002492 buf[buf_size] = '\0';
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002493 switch (buf[0]) {
2494 case 'y':
2495 case 'Y':
2496 case '1':
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002497 arm_all_kprobes();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002498 break;
2499 case 'n':
2500 case 'N':
2501 case '0':
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002502 disarm_all_kprobes();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002503 break;
Mathias Krause10fb46d2013-07-03 15:05:39 -07002504 default:
2505 return -EINVAL;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002506 }
2507
2508 return count;
2509}
2510
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002511static const struct file_operations fops_kp = {
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002512 .read = read_enabled_file_bool,
2513 .write = write_enabled_file_bool,
Arnd Bergmann6038f372010-08-15 18:52:59 +02002514 .llseek = default_llseek,
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002515};
2516
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002517static int __init debugfs_kprobe_init(void)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002518{
2519 struct dentry *dir, *file;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002520 unsigned int value = 1;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002521
2522 dir = debugfs_create_dir("kprobes", NULL);
2523 if (!dir)
2524 return -ENOMEM;
2525
Randy Dunlape3869792007-05-08 00:27:01 -07002526 file = debugfs_create_file("list", 0444, dir, NULL,
Srinivasa Ds346fd592007-02-20 13:57:54 -08002527 &debugfs_kprobes_operations);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002528 if (!file)
2529 goto error;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002530
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002531 file = debugfs_create_file("enabled", 0600, dir,
2532 &value, &fops_kp);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002533 if (!file)
2534 goto error;
2535
2536 file = debugfs_create_file("blacklist", 0444, dir, NULL,
2537 &debugfs_kprobe_blacklist_ops);
2538 if (!file)
2539 goto error;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002540
Srinivasa Ds346fd592007-02-20 13:57:54 -08002541 return 0;
Masami Hiramatsu63724742014-04-17 17:18:49 +09002542
2543error:
2544 debugfs_remove(dir);
2545 return -ENOMEM;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002546}
2547
2548late_initcall(debugfs_kprobe_init);
2549#endif /* CONFIG_DEBUG_FS */
2550
2551module_init(init_kprobes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002552
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002553/* defined in arch/.../kernel/kprobes.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002554EXPORT_SYMBOL_GPL(jprobe_return);