blob: e2845dd53b30ba8f8d80ac3f33260fdeef56f902 [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>
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -070055#include <asm/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
61/*
62 * Some oddball architectures like 64bit powerpc have function descriptors
63 * so this must be overridable.
64 */
65#ifndef kprobe_lookup_name
66#define kprobe_lookup_name(name, addr) \
67 addr = ((kprobe_opcode_t *)(kallsyms_lookup_name(name)))
68#endif
69
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070070static int kprobes_initialized;
Linus Torvalds1da177e2005-04-16 15:20:36 -070071static struct hlist_head kprobe_table[KPROBE_TABLE_SIZE];
Hien Nguyenb94cce92005-06-23 00:09:19 -070072static struct hlist_head kretprobe_inst_table[KPROBE_TABLE_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -070074/* NOTE: change this value only with kprobe_mutex held */
Masami Hiramatsue579abe2009-04-06 19:01:01 -070075static bool kprobes_all_disarmed;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -070076
Masami Hiramatsu43948f52010-10-25 22:18:01 +090077/* This protects kprobe_table and optimizing_list */
78static DEFINE_MUTEX(kprobe_mutex);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -080079static DEFINE_PER_CPU(struct kprobe *, kprobe_instance) = NULL;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070080static struct {
Thomas Gleixnerec4846082009-07-25 16:09:17 +020081 raw_spinlock_t lock ____cacheline_aligned_in_smp;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070082} kretprobe_table_locks[KPROBE_TABLE_SIZE];
83
Thomas Gleixnerec4846082009-07-25 16:09:17 +020084static raw_spinlock_t *kretprobe_table_lock_ptr(unsigned long hash)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070085{
86 return &(kretprobe_table_locks[hash].lock);
87}
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Masami Hiramatsu376e2422014-04-17 17:17:05 +090089/* Blacklist -- list of struct kprobe_blacklist_entry */
90static LIST_HEAD(kprobe_blacklist);
Srinivasa Ds3d8d9962008-04-28 02:14:26 -070091
Anil S Keshavamurthy2d14e392006-01-09 20:52:41 -080092#ifdef __ARCH_WANT_KPROBES_INSN_SLOT
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070093/*
94 * kprobe->ainsn.insn points to the copy of the instruction to be
95 * single-stepped. x86_64, POWER4 and above have no-exec support and
96 * stepping on the instruction on a vmalloced/kmalloced/data page
97 * is a recipe for disaster
98 */
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070099struct kprobe_insn_page {
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400100 struct list_head list;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700101 kprobe_opcode_t *insns; /* Page of instruction slots */
Heiko Carstensaf963972013-09-11 14:24:13 -0700102 struct kprobe_insn_cache *cache;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700103 int nused;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800104 int ngarbage;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500105 char slot_used[];
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700106};
107
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500108#define KPROBE_INSN_PAGE_SIZE(slots) \
109 (offsetof(struct kprobe_insn_page, slot_used) + \
110 (sizeof(char) * (slots)))
111
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500112static int slots_per_page(struct kprobe_insn_cache *c)
113{
114 return PAGE_SIZE/(c->insn_size * sizeof(kprobe_opcode_t));
115}
116
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800117enum kprobe_slot_state {
118 SLOT_CLEAN = 0,
119 SLOT_DIRTY = 1,
120 SLOT_USED = 2,
121};
122
Heiko Carstensaf963972013-09-11 14:24:13 -0700123static void *alloc_insn_page(void)
124{
125 return module_alloc(PAGE_SIZE);
126}
127
Masami Hiramatsufd2f0702017-05-25 19:38:17 +0900128void __weak free_insn_page(void *page)
Heiko Carstensaf963972013-09-11 14:24:13 -0700129{
Rusty Russellbe1f2212015-01-20 09:07:05 +1030130 module_memfree(page);
Heiko Carstensaf963972013-09-11 14:24:13 -0700131}
132
Heiko Carstensc802d642013-09-11 14:24:11 -0700133struct kprobe_insn_cache kprobe_insn_slots = {
134 .mutex = __MUTEX_INITIALIZER(kprobe_insn_slots.mutex),
Heiko Carstensaf963972013-09-11 14:24:13 -0700135 .alloc = alloc_insn_page,
136 .free = free_insn_page,
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500137 .pages = LIST_HEAD_INIT(kprobe_insn_slots.pages),
138 .insn_size = MAX_INSN_SIZE,
139 .nr_garbage = 0,
140};
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900141static int collect_garbage_slots(struct kprobe_insn_cache *c);
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800142
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700143/**
Masami Hiramatsu12941562009-01-06 14:41:50 -0800144 * __get_insn_slot() - Find a slot on an executable page for an instruction.
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700145 * We allocate an executable page if there's no room on existing ones.
146 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900147kprobe_opcode_t *__get_insn_slot(struct kprobe_insn_cache *c)
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700148{
149 struct kprobe_insn_page *kip;
Heiko Carstensc802d642013-09-11 14:24:11 -0700150 kprobe_opcode_t *slot = NULL;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700151
Heiko Carstensc802d642013-09-11 14:24:11 -0700152 mutex_lock(&c->mutex);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -0700153 retry:
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500154 list_for_each_entry(kip, &c->pages, list) {
155 if (kip->nused < slots_per_page(c)) {
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700156 int i;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500157 for (i = 0; i < slots_per_page(c); i++) {
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800158 if (kip->slot_used[i] == SLOT_CLEAN) {
159 kip->slot_used[i] = SLOT_USED;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700160 kip->nused++;
Heiko Carstensc802d642013-09-11 14:24:11 -0700161 slot = kip->insns + (i * c->insn_size);
162 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 }
170
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800171 /* If there are any garbage slots, collect it and try again. */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500172 if (c->nr_garbage && collect_garbage_slots(c) == 0)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800173 goto retry;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500174
175 /* All out of space. Need to allocate a new page. */
176 kip = kmalloc(KPROBE_INSN_PAGE_SIZE(slots_per_page(c)), GFP_KERNEL);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -0700177 if (!kip)
Heiko Carstensc802d642013-09-11 14:24:11 -0700178 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700179
180 /*
181 * Use module_alloc so this page is within +/- 2GB of where the
182 * kernel image and loaded module images reside. This is required
183 * so x86_64 can correctly handle the %rip-relative fixups.
184 */
Heiko Carstensaf963972013-09-11 14:24:13 -0700185 kip->insns = c->alloc();
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700186 if (!kip->insns) {
187 kfree(kip);
Heiko Carstensc802d642013-09-11 14:24:11 -0700188 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700189 }
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400190 INIT_LIST_HEAD(&kip->list);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500191 memset(kip->slot_used, SLOT_CLEAN, slots_per_page(c));
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800192 kip->slot_used[0] = SLOT_USED;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700193 kip->nused = 1;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800194 kip->ngarbage = 0;
Heiko Carstensaf963972013-09-11 14:24:13 -0700195 kip->cache = c;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500196 list_add(&kip->list, &c->pages);
Heiko Carstensc802d642013-09-11 14:24:11 -0700197 slot = kip->insns;
198out:
199 mutex_unlock(&c->mutex);
200 return slot;
Masami Hiramatsu12941562009-01-06 14:41:50 -0800201}
202
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800203/* Return 1 if all garbages are collected, otherwise 0. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900204static int collect_one_slot(struct kprobe_insn_page *kip, int idx)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800205{
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800206 kip->slot_used[idx] = SLOT_CLEAN;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800207 kip->nused--;
208 if (kip->nused == 0) {
209 /*
210 * Page is no longer in use. Free it unless
211 * it's the last one. We keep the last one
212 * so as not to have to set it up again the
213 * next time somebody inserts a probe.
214 */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500215 if (!list_is_singular(&kip->list)) {
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400216 list_del(&kip->list);
Heiko Carstensaf963972013-09-11 14:24:13 -0700217 kip->cache->free(kip->insns);
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800218 kfree(kip);
219 }
220 return 1;
221 }
222 return 0;
223}
224
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900225static int collect_garbage_slots(struct kprobe_insn_cache *c)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800226{
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400227 struct kprobe_insn_page *kip, *next;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800228
Masami Hiramatsu615d0eb2010-02-02 16:49:04 -0500229 /* Ensure no-one is interrupted on the garbages */
230 synchronize_sched();
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800231
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500232 list_for_each_entry_safe(kip, next, &c->pages, list) {
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800233 int i;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800234 if (kip->ngarbage == 0)
235 continue;
236 kip->ngarbage = 0; /* we will collect all garbages */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500237 for (i = 0; i < slots_per_page(c); i++) {
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800238 if (kip->slot_used[i] == SLOT_DIRTY &&
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800239 collect_one_slot(kip, i))
240 break;
241 }
242 }
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500243 c->nr_garbage = 0;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800244 return 0;
245}
246
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900247void __free_insn_slot(struct kprobe_insn_cache *c,
248 kprobe_opcode_t *slot, int dirty)
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500249{
250 struct kprobe_insn_page *kip;
251
Heiko Carstensc802d642013-09-11 14:24:11 -0700252 mutex_lock(&c->mutex);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500253 list_for_each_entry(kip, &c->pages, list) {
Masami Hiramatsu83ff56f2010-03-09 10:22:19 -0500254 long idx = ((long)slot - (long)kip->insns) /
255 (c->insn_size * sizeof(kprobe_opcode_t));
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500256 if (idx >= 0 && idx < slots_per_page(c)) {
257 WARN_ON(kip->slot_used[idx] != SLOT_USED);
258 if (dirty) {
259 kip->slot_used[idx] = SLOT_DIRTY;
260 kip->ngarbage++;
261 if (++c->nr_garbage > slots_per_page(c))
262 collect_garbage_slots(c);
263 } else
264 collect_one_slot(kip, idx);
Heiko Carstensc802d642013-09-11 14:24:11 -0700265 goto out;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500266 }
267 }
268 /* Could not free this slot. */
269 WARN_ON(1);
Heiko Carstensc802d642013-09-11 14:24:11 -0700270out:
271 mutex_unlock(&c->mutex);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500272}
273
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500274#ifdef CONFIG_OPTPROBES
275/* For optimized_kprobe buffer */
Heiko Carstensc802d642013-09-11 14:24:11 -0700276struct kprobe_insn_cache kprobe_optinsn_slots = {
277 .mutex = __MUTEX_INITIALIZER(kprobe_optinsn_slots.mutex),
Heiko Carstensaf963972013-09-11 14:24:13 -0700278 .alloc = alloc_insn_page,
279 .free = free_insn_page,
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500280 .pages = LIST_HEAD_INIT(kprobe_optinsn_slots.pages),
281 /* .insn_size is initialized later */
282 .nr_garbage = 0,
283};
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500284#endif
Anil S Keshavamurthy2d14e392006-01-09 20:52:41 -0800285#endif
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700286
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800287/* We have preemption disabled.. so it is safe to use __ versions */
288static inline void set_kprobe_instance(struct kprobe *kp)
289{
Christoph Lameterb76834b2010-12-06 11:16:25 -0600290 __this_cpu_write(kprobe_instance, kp);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800291}
292
293static inline void reset_kprobe_instance(void)
294{
Christoph Lameterb76834b2010-12-06 11:16:25 -0600295 __this_cpu_write(kprobe_instance, NULL);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800296}
297
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800298/*
299 * This routine is called either:
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -0800300 * - under the kprobe_mutex - during kprobe_[un]register()
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800301 * OR
Ananth N Mavinakayanahallid217d542005-11-07 01:00:14 -0800302 * - with preemption disabled - from arch/xxx/kernel/kprobes.c
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800303 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900304struct kprobe *get_kprobe(void *addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305{
306 struct hlist_head *head;
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800307 struct kprobe *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308
309 head = &kprobe_table[hash_ptr(addr, KPROBE_HASH_BITS)];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800310 hlist_for_each_entry_rcu(p, head, hlist) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 if (p->addr == addr)
312 return p;
313 }
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500314
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 return NULL;
316}
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900317NOKPROBE_SYMBOL(get_kprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900319static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500320
321/* Return true if the kprobe is an aggregator */
322static inline int kprobe_aggrprobe(struct kprobe *p)
323{
324 return p->pre_handler == aggr_pre_handler;
325}
326
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900327/* Return true(!0) if the kprobe is unused */
328static inline int kprobe_unused(struct kprobe *p)
329{
330 return kprobe_aggrprobe(p) && kprobe_disabled(p) &&
331 list_empty(&p->list);
332}
333
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500334/*
335 * Keep all fields in the kprobe consistent
336 */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900337static inline void copy_kprobe(struct kprobe *ap, struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500338{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900339 memcpy(&p->opcode, &ap->opcode, sizeof(kprobe_opcode_t));
340 memcpy(&p->ainsn, &ap->ainsn, sizeof(struct arch_specific_insn));
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500341}
342
343#ifdef CONFIG_OPTPROBES
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500344/* NOTE: change this value only with kprobe_mutex held */
345static bool kprobes_allow_optimization;
346
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500347/*
348 * Call all pre_handler on the list, but ignores its return value.
349 * This must be called from arch-dep optimized caller.
350 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900351void opt_pre_handler(struct kprobe *p, struct pt_regs *regs)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500352{
353 struct kprobe *kp;
354
355 list_for_each_entry_rcu(kp, &p->list, list) {
356 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
357 set_kprobe_instance(kp);
358 kp->pre_handler(kp, regs);
359 }
360 reset_kprobe_instance();
361 }
362}
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900363NOKPROBE_SYMBOL(opt_pre_handler);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500364
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900365/* Free optimized instructions and optimized_kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900366static void free_aggr_kprobe(struct kprobe *p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900367{
368 struct optimized_kprobe *op;
369
370 op = container_of(p, struct optimized_kprobe, kp);
371 arch_remove_optimized_kprobe(op);
372 arch_remove_kprobe(p);
373 kfree(op);
374}
375
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500376/* Return true(!0) if the kprobe is ready for optimization. */
377static inline int kprobe_optready(struct kprobe *p)
378{
379 struct optimized_kprobe *op;
380
381 if (kprobe_aggrprobe(p)) {
382 op = container_of(p, struct optimized_kprobe, kp);
383 return arch_prepared_optinsn(&op->optinsn);
384 }
385
386 return 0;
387}
388
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900389/* Return true(!0) if the kprobe is disarmed. Note: p must be on hash list */
390static inline int kprobe_disarmed(struct kprobe *p)
391{
392 struct optimized_kprobe *op;
393
394 /* If kprobe is not aggr/opt probe, just return kprobe is disabled */
395 if (!kprobe_aggrprobe(p))
396 return kprobe_disabled(p);
397
398 op = container_of(p, struct optimized_kprobe, kp);
399
400 return kprobe_disabled(p) && list_empty(&op->list);
401}
402
403/* Return true(!0) if the probe is queued on (un)optimizing lists */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900404static int kprobe_queued(struct kprobe *p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900405{
406 struct optimized_kprobe *op;
407
408 if (kprobe_aggrprobe(p)) {
409 op = container_of(p, struct optimized_kprobe, kp);
410 if (!list_empty(&op->list))
411 return 1;
412 }
413 return 0;
414}
415
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500416/*
417 * Return an optimized kprobe whose optimizing code replaces
418 * instructions including addr (exclude breakpoint).
419 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900420static struct kprobe *get_optimized_kprobe(unsigned long addr)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500421{
422 int i;
423 struct kprobe *p = NULL;
424 struct optimized_kprobe *op;
425
426 /* Don't check i == 0, since that is a breakpoint case. */
427 for (i = 1; !p && i < MAX_OPTIMIZED_LENGTH; i++)
428 p = get_kprobe((void *)(addr - i));
429
430 if (p && kprobe_optready(p)) {
431 op = container_of(p, struct optimized_kprobe, kp);
432 if (arch_within_optimized_kprobe(op, addr))
433 return p;
434 }
435
436 return NULL;
437}
438
439/* Optimization staging list, protected by kprobe_mutex */
440static LIST_HEAD(optimizing_list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900441static LIST_HEAD(unoptimizing_list);
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900442static LIST_HEAD(freeing_list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500443
444static void kprobe_optimizer(struct work_struct *work);
445static DECLARE_DELAYED_WORK(optimizing_work, kprobe_optimizer);
446#define OPTIMIZE_DELAY 5
447
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900448/*
449 * Optimize (replace a breakpoint with a jump) kprobes listed on
450 * optimizing_list.
451 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900452static void do_optimize_kprobes(void)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500453{
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900454 /* Optimization never be done when disarmed */
455 if (kprobes_all_disarmed || !kprobes_allow_optimization ||
456 list_empty(&optimizing_list))
457 return;
458
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500459 /*
460 * The optimization/unoptimization refers online_cpus via
461 * stop_machine() and cpu-hotplug modifies online_cpus.
462 * And same time, text_mutex will be held in cpu-hotplug and here.
463 * This combination can cause a deadlock (cpu-hotplug try to lock
464 * text_mutex but stop_machine can not be done because online_cpus
465 * has been changed)
466 * To avoid this deadlock, we need to call get_online_cpus()
467 * for preventing cpu-hotplug outside of text_mutex locking.
468 */
469 get_online_cpus();
470 mutex_lock(&text_mutex);
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900471 arch_optimize_kprobes(&optimizing_list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500472 mutex_unlock(&text_mutex);
473 put_online_cpus();
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900474}
475
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900476/*
477 * Unoptimize (replace a jump with a breakpoint and remove the breakpoint
478 * if need) kprobes listed on unoptimizing_list.
479 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900480static void do_unoptimize_kprobes(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900481{
482 struct optimized_kprobe *op, *tmp;
483
484 /* Unoptimization must be done anytime */
485 if (list_empty(&unoptimizing_list))
486 return;
487
488 /* Ditto to do_optimize_kprobes */
489 get_online_cpus();
490 mutex_lock(&text_mutex);
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900491 arch_unoptimize_kprobes(&unoptimizing_list, &freeing_list);
Masami Hiramatsuf984ba42010-12-03 18:54:34 +0900492 /* Loop free_list for disarming */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900493 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900494 /* Disarm probes if marked disabled */
495 if (kprobe_disabled(&op->kp))
496 arch_disarm_kprobe(&op->kp);
497 if (kprobe_unused(&op->kp)) {
498 /*
499 * Remove unused probes from hash list. After waiting
500 * for synchronization, these probes are reclaimed.
501 * (reclaiming is done by do_free_cleaned_kprobes.)
502 */
503 hlist_del_rcu(&op->kp.hlist);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900504 } else
505 list_del_init(&op->list);
506 }
507 mutex_unlock(&text_mutex);
508 put_online_cpus();
509}
510
511/* Reclaim all kprobes on the free_list */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900512static void do_free_cleaned_kprobes(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900513{
514 struct optimized_kprobe *op, *tmp;
515
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900516 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900517 BUG_ON(!kprobe_unused(&op->kp));
518 list_del_init(&op->list);
519 free_aggr_kprobe(&op->kp);
520 }
521}
522
523/* Start optimizer after OPTIMIZE_DELAY passed */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900524static void kick_kprobe_optimizer(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900525{
Tejun Heoad72b3b2012-12-21 17:57:00 -0800526 schedule_delayed_work(&optimizing_work, OPTIMIZE_DELAY);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900527}
528
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900529/* Kprobe jump optimizer */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900530static void kprobe_optimizer(struct work_struct *work)
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900531{
Steven Rostedt72ef3792012-06-05 19:28:14 +0900532 mutex_lock(&kprobe_mutex);
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900533 /* Lock modules while optimizing kprobes */
534 mutex_lock(&module_mutex);
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900535
536 /*
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900537 * Step 1: Unoptimize kprobes and collect cleaned (unused and disarmed)
538 * kprobes before waiting for quiesence period.
539 */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900540 do_unoptimize_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900541
542 /*
543 * Step 2: Wait for quiesence period to ensure all running interrupts
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900544 * are done. Because optprobe may modify multiple instructions
545 * there is a chance that Nth instruction is interrupted. In that
546 * case, running interrupt can return to 2nd-Nth byte of jump
547 * instruction. This wait is for avoiding it.
548 */
549 synchronize_sched();
550
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900551 /* Step 3: Optimize kprobes after quiesence period */
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900552 do_optimize_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900553
554 /* Step 4: Free cleaned kprobes after quiesence period */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900555 do_free_cleaned_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900556
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500557 mutex_unlock(&module_mutex);
Steven Rostedt72ef3792012-06-05 19:28:14 +0900558 mutex_unlock(&kprobe_mutex);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900559
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900560 /* Step 5: Kick optimizer again if needed */
Masami Hiramatsuf984ba42010-12-03 18:54:34 +0900561 if (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list))
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900562 kick_kprobe_optimizer();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900563}
564
565/* Wait for completing optimization and unoptimization */
Thomas Gleixnerdd0023d2017-05-17 10:19:49 +0200566void wait_for_kprobe_optimizer(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900567{
Tejun Heoad72b3b2012-12-21 17:57:00 -0800568 mutex_lock(&kprobe_mutex);
569
570 while (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list)) {
571 mutex_unlock(&kprobe_mutex);
572
573 /* this will also make optimizing_work execute immmediately */
574 flush_delayed_work(&optimizing_work);
575 /* @optimizing_work might not have been queued yet, relax */
576 cpu_relax();
577
578 mutex_lock(&kprobe_mutex);
579 }
580
581 mutex_unlock(&kprobe_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500582}
583
584/* Optimize kprobe if p is ready to be optimized */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900585static void optimize_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500586{
587 struct optimized_kprobe *op;
588
589 /* Check if the kprobe is disabled or not ready for optimization. */
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500590 if (!kprobe_optready(p) || !kprobes_allow_optimization ||
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500591 (kprobe_disabled(p) || kprobes_all_disarmed))
592 return;
593
594 /* Both of break_handler and post_handler are not supported. */
595 if (p->break_handler || p->post_handler)
596 return;
597
598 op = container_of(p, struct optimized_kprobe, kp);
599
600 /* Check there is no other kprobes at the optimized instructions */
601 if (arch_check_optimized_kprobe(op) < 0)
602 return;
603
604 /* Check if it is already optimized. */
605 if (op->kp.flags & KPROBE_FLAG_OPTIMIZED)
606 return;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500607 op->kp.flags |= KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900608
609 if (!list_empty(&op->list))
610 /* This is under unoptimizing. Just dequeue the probe */
611 list_del_init(&op->list);
612 else {
613 list_add(&op->list, &optimizing_list);
614 kick_kprobe_optimizer();
615 }
616}
617
618/* Short cut to direct unoptimizing */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900619static void force_unoptimize_kprobe(struct optimized_kprobe *op)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900620{
621 get_online_cpus();
622 arch_unoptimize_kprobe(op);
623 put_online_cpus();
624 if (kprobe_disabled(&op->kp))
625 arch_disarm_kprobe(&op->kp);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500626}
627
628/* Unoptimize a kprobe if p is optimized */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900629static void unoptimize_kprobe(struct kprobe *p, bool force)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500630{
631 struct optimized_kprobe *op;
632
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900633 if (!kprobe_aggrprobe(p) || kprobe_disarmed(p))
634 return; /* This is not an optprobe nor optimized */
635
636 op = container_of(p, struct optimized_kprobe, kp);
637 if (!kprobe_optimized(p)) {
638 /* Unoptimized or unoptimizing case */
639 if (force && !list_empty(&op->list)) {
640 /*
641 * Only if this is unoptimizing kprobe and forced,
642 * forcibly unoptimize it. (No need to unoptimize
643 * unoptimized kprobe again :)
644 */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500645 list_del_init(&op->list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900646 force_unoptimize_kprobe(op);
647 }
648 return;
649 }
650
651 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
652 if (!list_empty(&op->list)) {
653 /* Dequeue from the optimization queue */
654 list_del_init(&op->list);
655 return;
656 }
657 /* Optimized kprobe case */
658 if (force)
659 /* Forcibly update the code: this is a special case */
660 force_unoptimize_kprobe(op);
661 else {
662 list_add(&op->list, &unoptimizing_list);
663 kick_kprobe_optimizer();
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500664 }
665}
666
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900667/* Cancel unoptimizing for reusing */
Masami Hiramatsu6c8b1db2018-09-11 19:20:40 +0900668static int reuse_unused_kprobe(struct kprobe *ap)
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900669{
670 struct optimized_kprobe *op;
671
672 BUG_ON(!kprobe_unused(ap));
673 /*
674 * Unused kprobe MUST be on the way of delayed unoptimizing (means
675 * there is still a relative jump) and disabled.
676 */
677 op = container_of(ap, struct optimized_kprobe, kp);
678 if (unlikely(list_empty(&op->list)))
679 printk(KERN_WARNING "Warning: found a stray unused "
680 "aggrprobe@%p\n", ap->addr);
681 /* Enable the probe again */
682 ap->flags &= ~KPROBE_FLAG_DISABLED;
683 /* Optimize it again (remove from op->list) */
Masami Hiramatsu8a779c42019-04-15 15:01:25 +0900684 if (!kprobe_optready(ap))
685 return -EINVAL;
Masami Hiramatsu6c8b1db2018-09-11 19:20:40 +0900686
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900687 optimize_kprobe(ap);
Masami Hiramatsu6c8b1db2018-09-11 19:20:40 +0900688 return 0;
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900689}
690
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500691/* Remove optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900692static void kill_optimized_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500693{
694 struct optimized_kprobe *op;
695
696 op = container_of(p, struct optimized_kprobe, kp);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900697 if (!list_empty(&op->list))
698 /* Dequeue from the (un)optimization queue */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500699 list_del_init(&op->list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900700 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900701
702 if (kprobe_unused(p)) {
703 /* Enqueue if it is unused */
704 list_add(&op->list, &freeing_list);
705 /*
706 * Remove unused probes from the hash list. After waiting
707 * for synchronization, this probe is reclaimed.
708 * (reclaiming is done by do_free_cleaned_kprobes().)
709 */
710 hlist_del_rcu(&op->kp.hlist);
711 }
712
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900713 /* Don't touch the code, because it is already freed. */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500714 arch_remove_optimized_kprobe(op);
715}
716
717/* Try to prepare optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900718static void prepare_optimized_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500719{
720 struct optimized_kprobe *op;
721
722 op = container_of(p, struct optimized_kprobe, kp);
Masami Hiramatsucbf6ab52015-01-05 19:29:32 +0800723 arch_prepare_optimized_kprobe(op, p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500724}
725
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500726/* Allocate new optimized_kprobe and try to prepare optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900727static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500728{
729 struct optimized_kprobe *op;
730
731 op = kzalloc(sizeof(struct optimized_kprobe), GFP_KERNEL);
732 if (!op)
733 return NULL;
734
735 INIT_LIST_HEAD(&op->list);
736 op->kp.addr = p->addr;
Masami Hiramatsucbf6ab52015-01-05 19:29:32 +0800737 arch_prepare_optimized_kprobe(op, p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500738
739 return &op->kp;
740}
741
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900742static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500743
744/*
745 * Prepare an optimized_kprobe and optimize it
746 * NOTE: p must be a normal registered kprobe
747 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900748static void try_to_optimize_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500749{
750 struct kprobe *ap;
751 struct optimized_kprobe *op;
752
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900753 /* Impossible to optimize ftrace-based kprobe */
754 if (kprobe_ftrace(p))
755 return;
756
Masami Hiramatsu25764282012-06-05 19:28:26 +0900757 /* For preparing optimization, jump_label_text_reserved() is called */
758 jump_label_lock();
759 mutex_lock(&text_mutex);
760
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500761 ap = alloc_aggr_kprobe(p);
762 if (!ap)
Masami Hiramatsu25764282012-06-05 19:28:26 +0900763 goto out;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500764
765 op = container_of(ap, struct optimized_kprobe, kp);
766 if (!arch_prepared_optinsn(&op->optinsn)) {
767 /* If failed to setup optimizing, fallback to kprobe */
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900768 arch_remove_optimized_kprobe(op);
769 kfree(op);
Masami Hiramatsu25764282012-06-05 19:28:26 +0900770 goto out;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500771 }
772
773 init_aggr_kprobe(ap, p);
Masami Hiramatsu25764282012-06-05 19:28:26 +0900774 optimize_kprobe(ap); /* This just kicks optimizer thread */
775
776out:
777 mutex_unlock(&text_mutex);
778 jump_label_unlock();
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500779}
780
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500781#ifdef CONFIG_SYSCTL
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900782static void optimize_all_kprobes(void)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500783{
784 struct hlist_head *head;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500785 struct kprobe *p;
786 unsigned int i;
787
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900788 mutex_lock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500789 /* If optimization is already allowed, just return */
790 if (kprobes_allow_optimization)
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900791 goto out;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500792
793 kprobes_allow_optimization = true;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500794 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
795 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800796 hlist_for_each_entry_rcu(p, head, hlist)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500797 if (!kprobe_disabled(p))
798 optimize_kprobe(p);
799 }
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500800 printk(KERN_INFO "Kprobes globally optimized\n");
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900801out:
802 mutex_unlock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500803}
804
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900805static void unoptimize_all_kprobes(void)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500806{
807 struct hlist_head *head;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500808 struct kprobe *p;
809 unsigned int i;
810
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900811 mutex_lock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500812 /* If optimization is already prohibited, just return */
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900813 if (!kprobes_allow_optimization) {
814 mutex_unlock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500815 return;
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900816 }
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500817
818 kprobes_allow_optimization = false;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500819 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
820 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800821 hlist_for_each_entry_rcu(p, head, hlist) {
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500822 if (!kprobe_disabled(p))
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900823 unoptimize_kprobe(p, false);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500824 }
825 }
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900826 mutex_unlock(&kprobe_mutex);
827
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900828 /* Wait for unoptimizing completion */
829 wait_for_kprobe_optimizer();
830 printk(KERN_INFO "Kprobes globally unoptimized\n");
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500831}
832
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900833static DEFINE_MUTEX(kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500834int sysctl_kprobes_optimization;
835int proc_kprobes_optimization_handler(struct ctl_table *table, int write,
836 void __user *buffer, size_t *length,
837 loff_t *ppos)
838{
839 int ret;
840
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900841 mutex_lock(&kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500842 sysctl_kprobes_optimization = kprobes_allow_optimization ? 1 : 0;
843 ret = proc_dointvec_minmax(table, write, buffer, length, ppos);
844
845 if (sysctl_kprobes_optimization)
846 optimize_all_kprobes();
847 else
848 unoptimize_all_kprobes();
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900849 mutex_unlock(&kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500850
851 return ret;
852}
853#endif /* CONFIG_SYSCTL */
854
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900855/* Put a breakpoint for a probe. Must be called with text_mutex locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900856static void __arm_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500857{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900858 struct kprobe *_p;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500859
860 /* Check collision with other optimized kprobes */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900861 _p = get_optimized_kprobe((unsigned long)p->addr);
862 if (unlikely(_p))
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900863 /* Fallback to unoptimized kprobe */
864 unoptimize_kprobe(_p, true);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500865
866 arch_arm_kprobe(p);
867 optimize_kprobe(p); /* Try to optimize (add kprobe to a list) */
868}
869
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900870/* Remove the breakpoint of a probe. Must be called with text_mutex locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900871static void __disarm_kprobe(struct kprobe *p, bool reopt)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500872{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900873 struct kprobe *_p;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500874
Wang Nan69d54b92015-02-13 14:40:26 -0800875 /* Try to unoptimize */
876 unoptimize_kprobe(p, kprobes_all_disarmed);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500877
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900878 if (!kprobe_queued(p)) {
879 arch_disarm_kprobe(p);
880 /* If another kprobe was blocked, optimize it. */
881 _p = get_optimized_kprobe((unsigned long)p->addr);
882 if (unlikely(_p) && reopt)
883 optimize_kprobe(_p);
884 }
885 /* TODO: reoptimize others after unoptimized this probe */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500886}
887
888#else /* !CONFIG_OPTPROBES */
889
890#define optimize_kprobe(p) do {} while (0)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900891#define unoptimize_kprobe(p, f) do {} while (0)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500892#define kill_optimized_kprobe(p) do {} while (0)
893#define prepare_optimized_kprobe(p) do {} while (0)
894#define try_to_optimize_kprobe(p) do {} while (0)
895#define __arm_kprobe(p) arch_arm_kprobe(p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900896#define __disarm_kprobe(p, o) arch_disarm_kprobe(p)
897#define kprobe_disarmed(p) kprobe_disabled(p)
898#define wait_for_kprobe_optimizer() do {} while (0)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500899
Masami Hiramatsu6c8b1db2018-09-11 19:20:40 +0900900static int reuse_unused_kprobe(struct kprobe *ap)
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900901{
Masami Hiramatsu6c8b1db2018-09-11 19:20:40 +0900902 /*
903 * If the optimized kprobe is NOT supported, the aggr kprobe is
904 * released at the same time that the last aggregated kprobe is
905 * unregistered.
906 * Thus there should be no chance to reuse unused kprobe.
907 */
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900908 printk(KERN_ERR "Error: There should be no unused kprobe here.\n");
Masami Hiramatsu6c8b1db2018-09-11 19:20:40 +0900909 return -EINVAL;
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900910}
911
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900912static void free_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500913{
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900914 arch_remove_kprobe(p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500915 kfree(p);
916}
917
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900918static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500919{
920 return kzalloc(sizeof(struct kprobe), GFP_KERNEL);
921}
922#endif /* CONFIG_OPTPROBES */
923
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +0900924#ifdef CONFIG_KPROBES_ON_FTRACE
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900925static struct ftrace_ops kprobe_ftrace_ops __read_mostly = {
Masami Hiramatsue5253892012-06-05 19:28:38 +0900926 .func = kprobe_ftrace_handler,
Masami Hiramatsu1d70be32014-11-21 05:25:23 -0500927 .flags = FTRACE_OPS_FL_SAVE_REGS | FTRACE_OPS_FL_IPMODIFY,
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900928};
929static int kprobe_ftrace_enabled;
930
931/* Must ensure p->addr is really on ftrace */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900932static int prepare_kprobe(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900933{
934 if (!kprobe_ftrace(p))
935 return arch_prepare_kprobe(p);
936
937 return arch_prepare_kprobe_ftrace(p);
938}
939
940/* Caller must lock kprobe_mutex */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900941static void arm_kprobe_ftrace(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900942{
943 int ret;
944
945 ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
946 (unsigned long)p->addr, 0, 0);
947 WARN(ret < 0, "Failed to arm kprobe-ftrace at %p (%d)\n", p->addr, ret);
948 kprobe_ftrace_enabled++;
949 if (kprobe_ftrace_enabled == 1) {
950 ret = register_ftrace_function(&kprobe_ftrace_ops);
951 WARN(ret < 0, "Failed to init kprobe-ftrace (%d)\n", ret);
952 }
953}
954
955/* Caller must lock kprobe_mutex */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900956static void disarm_kprobe_ftrace(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900957{
958 int ret;
959
960 kprobe_ftrace_enabled--;
961 if (kprobe_ftrace_enabled == 0) {
962 ret = unregister_ftrace_function(&kprobe_ftrace_ops);
963 WARN(ret < 0, "Failed to init kprobe-ftrace (%d)\n", ret);
964 }
965 ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
966 (unsigned long)p->addr, 1, 0);
967 WARN(ret < 0, "Failed to disarm kprobe-ftrace at %p (%d)\n", p->addr, ret);
968}
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +0900969#else /* !CONFIG_KPROBES_ON_FTRACE */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900970#define prepare_kprobe(p) arch_prepare_kprobe(p)
971#define arm_kprobe_ftrace(p) do {} while (0)
972#define disarm_kprobe_ftrace(p) do {} while (0)
973#endif
974
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400975/* Arm a kprobe with text_mutex */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900976static void arm_kprobe(struct kprobe *kp)
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400977{
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900978 if (unlikely(kprobe_ftrace(kp))) {
979 arm_kprobe_ftrace(kp);
980 return;
981 }
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500982 /*
983 * Here, since __arm_kprobe() doesn't use stop_machine(),
984 * this doesn't cause deadlock on text_mutex. So, we don't
985 * need get_online_cpus().
986 */
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400987 mutex_lock(&text_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500988 __arm_kprobe(kp);
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400989 mutex_unlock(&text_mutex);
990}
991
992/* Disarm a kprobe with text_mutex */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900993static void disarm_kprobe(struct kprobe *kp, bool reopt)
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400994{
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900995 if (unlikely(kprobe_ftrace(kp))) {
996 disarm_kprobe_ftrace(kp);
997 return;
998 }
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900999 /* Ditto */
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001000 mutex_lock(&text_mutex);
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001001 __disarm_kprobe(kp, reopt);
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001002 mutex_unlock(&text_mutex);
1003}
1004
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001005/*
1006 * Aggregate handlers for multiple kprobes support - these handlers
1007 * take care of invoking the individual kprobe handlers on p->list
1008 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001009static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001010{
1011 struct kprobe *kp;
1012
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001013 list_for_each_entry_rcu(kp, &p->list, list) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001014 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001015 set_kprobe_instance(kp);
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001016 if (kp->pre_handler(kp, regs))
1017 return 1;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001018 }
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001019 reset_kprobe_instance();
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001020 }
1021 return 0;
1022}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001023NOKPROBE_SYMBOL(aggr_pre_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001024
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001025static void aggr_post_handler(struct kprobe *p, struct pt_regs *regs,
1026 unsigned long flags)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001027{
1028 struct kprobe *kp;
1029
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001030 list_for_each_entry_rcu(kp, &p->list, list) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001031 if (kp->post_handler && likely(!kprobe_disabled(kp))) {
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001032 set_kprobe_instance(kp);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001033 kp->post_handler(kp, regs, flags);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001034 reset_kprobe_instance();
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001035 }
1036 }
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001037}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001038NOKPROBE_SYMBOL(aggr_post_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001039
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001040static int aggr_fault_handler(struct kprobe *p, struct pt_regs *regs,
1041 int trapnr)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001042{
Christoph Lameterb76834b2010-12-06 11:16:25 -06001043 struct kprobe *cur = __this_cpu_read(kprobe_instance);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001044
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001045 /*
1046 * if we faulted "during" the execution of a user specified
1047 * probe handler, invoke just that probe's fault handler
1048 */
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001049 if (cur && cur->fault_handler) {
1050 if (cur->fault_handler(cur, regs, trapnr))
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001051 return 1;
1052 }
1053 return 0;
1054}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001055NOKPROBE_SYMBOL(aggr_fault_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001056
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001057static int aggr_break_handler(struct kprobe *p, struct pt_regs *regs)
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001058{
Christoph Lameterb76834b2010-12-06 11:16:25 -06001059 struct kprobe *cur = __this_cpu_read(kprobe_instance);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001060 int ret = 0;
1061
1062 if (cur && cur->break_handler) {
1063 if (cur->break_handler(cur, regs))
1064 ret = 1;
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001065 }
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001066 reset_kprobe_instance();
1067 return ret;
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001068}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001069NOKPROBE_SYMBOL(aggr_break_handler);
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001070
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001071/* Walks the list and increments nmissed count for multiprobe case */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001072void kprobes_inc_nmissed_count(struct kprobe *p)
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001073{
1074 struct kprobe *kp;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001075 if (!kprobe_aggrprobe(p)) {
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001076 p->nmissed++;
1077 } else {
1078 list_for_each_entry_rcu(kp, &p->list, list)
1079 kp->nmissed++;
1080 }
1081 return;
1082}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001083NOKPROBE_SYMBOL(kprobes_inc_nmissed_count);
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001084
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001085void recycle_rp_inst(struct kretprobe_instance *ri,
1086 struct hlist_head *head)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001087{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001088 struct kretprobe *rp = ri->rp;
1089
Hien Nguyenb94cce92005-06-23 00:09:19 -07001090 /* remove rp inst off the rprobe_inst_table */
1091 hlist_del(&ri->hlist);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001092 INIT_HLIST_NODE(&ri->hlist);
1093 if (likely(rp)) {
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001094 raw_spin_lock(&rp->lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001095 hlist_add_head(&ri->hlist, &rp->free_instances);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001096 raw_spin_unlock(&rp->lock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001097 } else
1098 /* Unregistering */
bibo,mao99219a32006-10-02 02:17:35 -07001099 hlist_add_head(&ri->hlist, head);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001100}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001101NOKPROBE_SYMBOL(recycle_rp_inst);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001102
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001103void kretprobe_hash_lock(struct task_struct *tsk,
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001104 struct hlist_head **head, unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001105__acquires(hlist_lock)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001106{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001107 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001108 raw_spinlock_t *hlist_lock;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001109
1110 *head = &kretprobe_inst_table[hash];
1111 hlist_lock = kretprobe_table_lock_ptr(hash);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001112 raw_spin_lock_irqsave(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001113}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001114NOKPROBE_SYMBOL(kretprobe_hash_lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001115
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001116static void kretprobe_table_lock(unsigned long hash,
1117 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001118__acquires(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001119{
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001120 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1121 raw_spin_lock_irqsave(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001122}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001123NOKPROBE_SYMBOL(kretprobe_table_lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001124
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001125void kretprobe_hash_unlock(struct task_struct *tsk,
1126 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001127__releases(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001128{
1129 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001130 raw_spinlock_t *hlist_lock;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001131
1132 hlist_lock = kretprobe_table_lock_ptr(hash);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001133 raw_spin_unlock_irqrestore(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001134}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001135NOKPROBE_SYMBOL(kretprobe_hash_unlock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001136
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001137static void kretprobe_table_unlock(unsigned long hash,
1138 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001139__releases(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001140{
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001141 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1142 raw_spin_unlock_irqrestore(hlist_lock, *flags);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001143}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001144NOKPROBE_SYMBOL(kretprobe_table_unlock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001145
Hien Nguyenb94cce92005-06-23 00:09:19 -07001146/*
bibo maoc6fd91f2006-03-26 01:38:20 -08001147 * This function is called from finish_task_switch when task tk becomes dead,
1148 * so that we can recycle any function-return probe instances associated
1149 * with this task. These left over instances represent probed functions
1150 * that have been called but will never return.
Hien Nguyenb94cce92005-06-23 00:09:19 -07001151 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001152void kprobe_flush_task(struct task_struct *tk)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001153{
bibo,mao62c27be2006-10-02 02:17:33 -07001154 struct kretprobe_instance *ri;
bibo,mao99219a32006-10-02 02:17:35 -07001155 struct hlist_head *head, empty_rp;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001156 struct hlist_node *tmp;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001157 unsigned long hash, flags = 0;
Rusty Lynch802eae72005-06-27 15:17:08 -07001158
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001159 if (unlikely(!kprobes_initialized))
1160 /* Early boot. kretprobe_table_locks not yet initialized. */
1161 return;
1162
Ananth N Mavinakayanahallid496aab2012-01-20 14:34:04 -08001163 INIT_HLIST_HEAD(&empty_rp);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001164 hash = hash_ptr(tk, KPROBE_HASH_BITS);
1165 head = &kretprobe_inst_table[hash];
1166 kretprobe_table_lock(hash, &flags);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001167 hlist_for_each_entry_safe(ri, tmp, head, hlist) {
bibo,mao62c27be2006-10-02 02:17:33 -07001168 if (ri->task == tk)
bibo,mao99219a32006-10-02 02:17:35 -07001169 recycle_rp_inst(ri, &empty_rp);
bibo,mao62c27be2006-10-02 02:17:33 -07001170 }
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001171 kretprobe_table_unlock(hash, &flags);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001172 hlist_for_each_entry_safe(ri, tmp, &empty_rp, hlist) {
bibo,mao99219a32006-10-02 02:17:35 -07001173 hlist_del(&ri->hlist);
1174 kfree(ri);
1175 }
Hien Nguyenb94cce92005-06-23 00:09:19 -07001176}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001177NOKPROBE_SYMBOL(kprobe_flush_task);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001178
Hien Nguyenb94cce92005-06-23 00:09:19 -07001179static inline void free_rp_inst(struct kretprobe *rp)
1180{
1181 struct kretprobe_instance *ri;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001182 struct hlist_node *next;
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001183
Sasha Levinb67bfe02013-02-27 17:06:00 -08001184 hlist_for_each_entry_safe(ri, next, &rp->free_instances, hlist) {
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001185 hlist_del(&ri->hlist);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001186 kfree(ri);
1187 }
1188}
1189
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001190static void cleanup_rp_inst(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001191{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001192 unsigned long flags, hash;
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001193 struct kretprobe_instance *ri;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001194 struct hlist_node *next;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001195 struct hlist_head *head;
1196
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001197 /* No race here */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001198 for (hash = 0; hash < KPROBE_TABLE_SIZE; hash++) {
1199 kretprobe_table_lock(hash, &flags);
1200 head = &kretprobe_inst_table[hash];
Sasha Levinb67bfe02013-02-27 17:06:00 -08001201 hlist_for_each_entry_safe(ri, next, head, hlist) {
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001202 if (ri->rp == rp)
1203 ri->rp = NULL;
1204 }
1205 kretprobe_table_unlock(hash, &flags);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001206 }
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001207 free_rp_inst(rp);
1208}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001209NOKPROBE_SYMBOL(cleanup_rp_inst);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001210
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001211/*
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001212* Add the new probe to ap->list. Fail if this is the
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001213* second jprobe at the address - two jprobes can't coexist
1214*/
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001215static int add_new_kprobe(struct kprobe *ap, struct kprobe *p)
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001216{
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001217 BUG_ON(kprobe_gone(ap) || kprobe_gone(p));
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001218
1219 if (p->break_handler || p->post_handler)
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001220 unoptimize_kprobe(ap, true); /* Fall back to normal kprobe */
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001221
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001222 if (p->break_handler) {
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001223 if (ap->break_handler)
mao, bibo36721652006-06-26 00:25:22 -07001224 return -EEXIST;
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001225 list_add_tail_rcu(&p->list, &ap->list);
1226 ap->break_handler = aggr_break_handler;
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001227 } else
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001228 list_add_rcu(&p->list, &ap->list);
1229 if (p->post_handler && !ap->post_handler)
1230 ap->post_handler = aggr_post_handler;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001231
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001232 return 0;
1233}
1234
1235/*
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001236 * Fill in the required fields of the "manager kprobe". Replace the
1237 * earlier kprobe in the hlist with the manager kprobe
1238 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001239static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001240{
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001241 /* Copy p's insn slot to ap */
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001242 copy_kprobe(p, ap);
bibo, maoa9ad9652006-07-30 03:03:26 -07001243 flush_insn_slot(ap);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001244 ap->addr = p->addr;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001245 ap->flags = p->flags & ~KPROBE_FLAG_OPTIMIZED;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001246 ap->pre_handler = aggr_pre_handler;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001247 ap->fault_handler = aggr_fault_handler;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001248 /* We don't care the kprobe which has gone. */
1249 if (p->post_handler && !kprobe_gone(p))
mao, bibo36721652006-06-26 00:25:22 -07001250 ap->post_handler = aggr_post_handler;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001251 if (p->break_handler && !kprobe_gone(p))
mao, bibo36721652006-06-26 00:25:22 -07001252 ap->break_handler = aggr_break_handler;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001253
1254 INIT_LIST_HEAD(&ap->list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001255 INIT_HLIST_NODE(&ap->hlist);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001256
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001257 list_add_rcu(&p->list, &ap->list);
Keshavamurthy Anil Sadad0f32005-12-12 00:37:12 -08001258 hlist_replace_rcu(&p->hlist, &ap->hlist);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001259}
1260
1261/*
1262 * This is the second or subsequent kprobe at the address - handle
1263 * the intricacies
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001264 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001265static int register_aggr_kprobe(struct kprobe *orig_p, struct kprobe *p)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001266{
1267 int ret = 0;
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001268 struct kprobe *ap = orig_p;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001269
Masami Hiramatsu25764282012-06-05 19:28:26 +09001270 /* For preparing optimization, jump_label_text_reserved() is called */
1271 jump_label_lock();
1272 /*
1273 * Get online CPUs to avoid text_mutex deadlock.with stop machine,
1274 * which is invoked by unoptimize_kprobe() in add_new_kprobe()
1275 */
1276 get_online_cpus();
1277 mutex_lock(&text_mutex);
1278
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001279 if (!kprobe_aggrprobe(orig_p)) {
1280 /* If orig_p is not an aggr_kprobe, create new aggr_kprobe. */
1281 ap = alloc_aggr_kprobe(orig_p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001282 if (!ap) {
1283 ret = -ENOMEM;
1284 goto out;
1285 }
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001286 init_aggr_kprobe(ap, orig_p);
Masami Hiramatsu6c8b1db2018-09-11 19:20:40 +09001287 } else if (kprobe_unused(ap)) {
Masami Hiramatsu0490cd12010-12-03 18:54:16 +09001288 /* This probe is going to die. Rescue it */
Masami Hiramatsu6c8b1db2018-09-11 19:20:40 +09001289 ret = reuse_unused_kprobe(ap);
1290 if (ret)
1291 goto out;
1292 }
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001293
1294 if (kprobe_gone(ap)) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001295 /*
1296 * Attempting to insert new probe at the same location that
1297 * had a probe in the module vaddr area which already
1298 * freed. So, the instruction slot has already been
1299 * released. We need a new slot for the new probe.
1300 */
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001301 ret = arch_prepare_kprobe(ap);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001302 if (ret)
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001303 /*
1304 * Even if fail to allocate new slot, don't need to
1305 * free aggr_probe. It will be used next time, or
1306 * freed by unregister_kprobe.
1307 */
Masami Hiramatsu25764282012-06-05 19:28:26 +09001308 goto out;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001309
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001310 /* Prepare optimized instructions if possible. */
1311 prepare_optimized_kprobe(ap);
1312
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001313 /*
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001314 * Clear gone flag to prevent allocating new slot again, and
1315 * set disabled flag because it is not armed yet.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001316 */
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001317 ap->flags = (ap->flags & ~KPROBE_FLAG_GONE)
1318 | KPROBE_FLAG_DISABLED;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001319 }
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001320
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001321 /* Copy ap's insn slot to p */
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001322 copy_kprobe(ap, p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001323 ret = add_new_kprobe(ap, p);
1324
1325out:
1326 mutex_unlock(&text_mutex);
1327 put_online_cpus();
1328 jump_label_unlock();
1329
1330 if (ret == 0 && kprobe_disabled(ap) && !kprobe_disabled(p)) {
1331 ap->flags &= ~KPROBE_FLAG_DISABLED;
1332 if (!kprobes_all_disarmed)
1333 /* Arm the breakpoint again. */
1334 arm_kprobe(ap);
1335 }
1336 return ret;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001337}
1338
Masami Hiramatsube8f2742014-04-17 17:16:58 +09001339bool __weak arch_within_kprobe_blacklist(unsigned long addr)
1340{
1341 /* The __kprobes marked functions and entry code must not be probed */
1342 return addr >= (unsigned long)__kprobes_text_start &&
1343 addr < (unsigned long)__kprobes_text_end;
1344}
1345
Andy Lutomirskie5779e82015-07-30 20:32:40 -07001346bool within_kprobe_blacklist(unsigned long addr)
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001347{
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001348 struct kprobe_blacklist_entry *ent;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001349
Masami Hiramatsube8f2742014-04-17 17:16:58 +09001350 if (arch_within_kprobe_blacklist(addr))
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001351 return true;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001352 /*
1353 * If there exists a kprobe_blacklist, verify and
1354 * fail any probe registration in the prohibited area
1355 */
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001356 list_for_each_entry(ent, &kprobe_blacklist, list) {
1357 if (addr >= ent->start_addr && addr < ent->end_addr)
1358 return true;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001359 }
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001360
1361 return false;
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001362}
1363
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001364/*
1365 * If we have a symbol_name argument, look it up and add the offset field
1366 * to it. This way, we can specify a relative address to a symbol.
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001367 * This returns encoded errors if it fails to look up symbol or invalid
1368 * combination of parameters.
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001369 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001370static kprobe_opcode_t *kprobe_addr(struct kprobe *p)
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001371{
1372 kprobe_opcode_t *addr = p->addr;
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001373
1374 if ((p->symbol_name && p->addr) ||
1375 (!p->symbol_name && !p->addr))
1376 goto invalid;
1377
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001378 if (p->symbol_name) {
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001379 kprobe_lookup_name(p->symbol_name, addr);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001380 if (!addr)
1381 return ERR_PTR(-ENOENT);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001382 }
1383
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001384 addr = (kprobe_opcode_t *)(((char *)addr) + p->offset);
1385 if (addr)
1386 return addr;
1387
1388invalid:
1389 return ERR_PTR(-EINVAL);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001390}
1391
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301392/* Check passed kprobe is valid and return kprobe in kprobe_table. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001393static struct kprobe *__get_valid_kprobe(struct kprobe *p)
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301394{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001395 struct kprobe *ap, *list_p;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301396
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001397 ap = get_kprobe(p->addr);
1398 if (unlikely(!ap))
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301399 return NULL;
1400
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001401 if (p != ap) {
1402 list_for_each_entry_rcu(list_p, &ap->list, list)
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301403 if (list_p == p)
1404 /* kprobe p is a valid probe */
1405 goto valid;
1406 return NULL;
1407 }
1408valid:
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001409 return ap;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301410}
1411
1412/* Return error if the kprobe is being re-registered */
1413static inline int check_kprobe_rereg(struct kprobe *p)
1414{
1415 int ret = 0;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301416
1417 mutex_lock(&kprobe_mutex);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001418 if (__get_valid_kprobe(p))
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301419 ret = -EINVAL;
1420 mutex_unlock(&kprobe_mutex);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001421
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301422 return ret;
1423}
1424
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001425int __weak arch_check_ftrace_location(struct kprobe *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426{
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001427 unsigned long ftrace_addr;
1428
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001429 ftrace_addr = ftrace_location((unsigned long)p->addr);
1430 if (ftrace_addr) {
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001431#ifdef CONFIG_KPROBES_ON_FTRACE
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001432 /* Given address is not on the instruction boundary */
1433 if ((unsigned long)p->addr != ftrace_addr)
1434 return -EILSEQ;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001435 p->flags |= KPROBE_FLAG_FTRACE;
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001436#else /* !CONFIG_KPROBES_ON_FTRACE */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001437 return -EINVAL;
1438#endif
1439 }
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001440 return 0;
1441}
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001442
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001443static int check_kprobe_address_safe(struct kprobe *p,
1444 struct module **probed_mod)
1445{
1446 int ret;
1447
1448 ret = arch_check_ftrace_location(p);
1449 if (ret)
1450 return ret;
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001451 jump_label_lock();
1452 preempt_disable();
1453
1454 /* Ensure it is not in reserved area nor out of text */
1455 if (!kernel_text_address((unsigned long) p->addr) ||
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001456 within_kprobe_blacklist((unsigned long) p->addr) ||
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001457 jump_label_text_reserved(p->addr, p->addr)) {
1458 ret = -EINVAL;
1459 goto out;
1460 }
1461
1462 /* Check if are we probing a module */
1463 *probed_mod = __module_text_address((unsigned long) p->addr);
1464 if (*probed_mod) {
1465 /*
1466 * We must hold a refcount of the probed module while updating
1467 * its code to prohibit unexpected unloading.
1468 */
1469 if (unlikely(!try_module_get(*probed_mod))) {
1470 ret = -ENOENT;
1471 goto out;
1472 }
1473
1474 /*
1475 * If the module freed .init.text, we couldn't insert
1476 * kprobes in there.
1477 */
1478 if (within_module_init((unsigned long)p->addr, *probed_mod) &&
1479 (*probed_mod)->state != MODULE_STATE_COMING) {
1480 module_put(*probed_mod);
1481 *probed_mod = NULL;
1482 ret = -ENOENT;
1483 }
1484 }
1485out:
1486 preempt_enable();
1487 jump_label_unlock();
1488
1489 return ret;
1490}
1491
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001492int register_kprobe(struct kprobe *p)
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001493{
1494 int ret;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001495 struct kprobe *old_p;
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001496 struct module *probed_mod;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001497 kprobe_opcode_t *addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001499 /* Adjust probe address from symbol */
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001500 addr = kprobe_addr(p);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001501 if (IS_ERR(addr))
1502 return PTR_ERR(addr);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001503 p->addr = addr;
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -07001504
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301505 ret = check_kprobe_rereg(p);
1506 if (ret)
1507 return ret;
1508
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001509 /* User can pass only KPROBE_FLAG_DISABLED to register_kprobe */
1510 p->flags &= KPROBE_FLAG_DISABLED;
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001511 p->nmissed = 0;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001512 INIT_LIST_HEAD(&p->list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001513
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001514 ret = check_kprobe_address_safe(p, &probed_mod);
1515 if (ret)
1516 return ret;
1517
1518 mutex_lock(&kprobe_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001519
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001520 old_p = get_kprobe(p->addr);
1521 if (old_p) {
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001522 /* Since this may unoptimize old_p, locking text_mutex. */
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001523 ret = register_aggr_kprobe(old_p, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 goto out;
1525 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526
Masami Hiramatsu25764282012-06-05 19:28:26 +09001527 mutex_lock(&text_mutex); /* Avoiding text modification */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001528 ret = prepare_kprobe(p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001529 mutex_unlock(&text_mutex);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -07001530 if (ret)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001531 goto out;
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001532
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001533 INIT_HLIST_NODE(&p->hlist);
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001534 hlist_add_head_rcu(&p->hlist,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535 &kprobe_table[hash_ptr(p->addr, KPROBE_HASH_BITS)]);
1536
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001537 if (!kprobes_all_disarmed && !kprobe_disabled(p))
Masami Hiramatsu25764282012-06-05 19:28:26 +09001538 arm_kprobe(p);
Christoph Hellwig74a0b572007-10-16 01:24:07 -07001539
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001540 /* Try to optimize kprobe */
1541 try_to_optimize_kprobe(p);
1542
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543out:
Ingo Molnar7a7d1cf2006-03-23 03:00:35 -08001544 mutex_unlock(&kprobe_mutex);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001545
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001546 if (probed_mod)
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001547 module_put(probed_mod);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001548
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549 return ret;
1550}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001551EXPORT_SYMBOL_GPL(register_kprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001553/* Check if all probes on the aggrprobe are disabled */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001554static int aggr_kprobe_disabled(struct kprobe *ap)
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001555{
1556 struct kprobe *kp;
1557
1558 list_for_each_entry_rcu(kp, &ap->list, list)
1559 if (!kprobe_disabled(kp))
1560 /*
1561 * There is an active probe on the list.
1562 * We can't disable this ap.
1563 */
1564 return 0;
1565
1566 return 1;
1567}
1568
1569/* Disable one kprobe: Make sure called under kprobe_mutex is locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001570static struct kprobe *__disable_kprobe(struct kprobe *p)
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001571{
1572 struct kprobe *orig_p;
1573
1574 /* Get an original kprobe for return */
1575 orig_p = __get_valid_kprobe(p);
1576 if (unlikely(orig_p == NULL))
1577 return NULL;
1578
1579 if (!kprobe_disabled(p)) {
1580 /* Disable probe if it is a child probe */
1581 if (p != orig_p)
1582 p->flags |= KPROBE_FLAG_DISABLED;
1583
1584 /* Try to disarm and disable this/parent probe */
1585 if (p == orig_p || aggr_kprobe_disabled(orig_p)) {
Wang Nan69d54b92015-02-13 14:40:26 -08001586 /*
1587 * If kprobes_all_disarmed is set, orig_p
1588 * should have already been disarmed, so
1589 * skip unneed disarming process.
1590 */
1591 if (!kprobes_all_disarmed)
1592 disarm_kprobe(orig_p, true);
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001593 orig_p->flags |= KPROBE_FLAG_DISABLED;
1594 }
1595 }
1596
1597 return orig_p;
1598}
1599
Masami Hiramatsu98616682008-04-28 02:14:28 -07001600/*
1601 * Unregister a kprobe without a scheduler synchronization.
1602 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001603static int __unregister_kprobe_top(struct kprobe *p)
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001604{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001605 struct kprobe *ap, *list_p;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001606
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001607 /* Disable kprobe. This will disarm it if needed. */
1608 ap = __disable_kprobe(p);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001609 if (ap == NULL)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001610 return -EINVAL;
1611
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001612 if (ap == p)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001613 /*
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001614 * This probe is an independent(and non-optimized) kprobe
1615 * (not an aggrprobe). Remove from the hash list.
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001616 */
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001617 goto disarmed;
1618
1619 /* Following process expects this probe is an aggrprobe */
1620 WARN_ON(!kprobe_aggrprobe(ap));
1621
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001622 if (list_is_singular(&ap->list) && kprobe_disarmed(ap))
1623 /*
1624 * !disarmed could be happen if the probe is under delayed
1625 * unoptimizing.
1626 */
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001627 goto disarmed;
1628 else {
1629 /* If disabling probe has special handlers, update aggrprobe */
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001630 if (p->break_handler && !kprobe_gone(p))
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001631 ap->break_handler = NULL;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001632 if (p->post_handler && !kprobe_gone(p)) {
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001633 list_for_each_entry_rcu(list_p, &ap->list, list) {
Masami Hiramatsu98616682008-04-28 02:14:28 -07001634 if ((list_p != p) && (list_p->post_handler))
1635 goto noclean;
1636 }
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001637 ap->post_handler = NULL;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001638 }
1639noclean:
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001640 /*
1641 * Remove from the aggrprobe: this path will do nothing in
1642 * __unregister_kprobe_bottom().
1643 */
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001644 list_del_rcu(&p->list);
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001645 if (!kprobe_disabled(ap) && !kprobes_all_disarmed)
1646 /*
1647 * Try to optimize this probe again, because post
1648 * handler may have been changed.
1649 */
1650 optimize_kprobe(ap);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001651 }
Masami Hiramatsu98616682008-04-28 02:14:28 -07001652 return 0;
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001653
1654disarmed:
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001655 BUG_ON(!kprobe_disarmed(ap));
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001656 hlist_del_rcu(&ap->hlist);
1657 return 0;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001658}
Mao, Bibob3e55c72005-12-12 00:37:00 -08001659
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001660static void __unregister_kprobe_bottom(struct kprobe *p)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001661{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001662 struct kprobe *ap;
Mao, Bibob3e55c72005-12-12 00:37:00 -08001663
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001664 if (list_empty(&p->list))
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001665 /* This is an independent kprobe */
Ananth N Mavinakayanahalli0498b632006-01-09 20:52:46 -08001666 arch_remove_kprobe(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001667 else if (list_is_singular(&p->list)) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001668 /* This is the last child of an aggrprobe */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001669 ap = list_entry(p->list.next, struct kprobe, list);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001670 list_del(&p->list);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001671 free_aggr_kprobe(ap);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001672 }
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001673 /* Otherwise, do nothing. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674}
1675
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001676int register_kprobes(struct kprobe **kps, int num)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001677{
1678 int i, ret = 0;
1679
1680 if (num <= 0)
1681 return -EINVAL;
1682 for (i = 0; i < num; i++) {
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001683 ret = register_kprobe(kps[i]);
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001684 if (ret < 0) {
1685 if (i > 0)
1686 unregister_kprobes(kps, i);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001687 break;
1688 }
1689 }
1690 return ret;
1691}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001692EXPORT_SYMBOL_GPL(register_kprobes);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001693
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001694void unregister_kprobe(struct kprobe *p)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001695{
1696 unregister_kprobes(&p, 1);
1697}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001698EXPORT_SYMBOL_GPL(unregister_kprobe);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001699
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001700void unregister_kprobes(struct kprobe **kps, int num)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001701{
1702 int i;
1703
1704 if (num <= 0)
1705 return;
1706 mutex_lock(&kprobe_mutex);
1707 for (i = 0; i < num; i++)
1708 if (__unregister_kprobe_top(kps[i]) < 0)
1709 kps[i]->addr = NULL;
1710 mutex_unlock(&kprobe_mutex);
1711
1712 synchronize_sched();
1713 for (i = 0; i < num; i++)
1714 if (kps[i]->addr)
1715 __unregister_kprobe_bottom(kps[i]);
1716}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001717EXPORT_SYMBOL_GPL(unregister_kprobes);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001718
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719static struct notifier_block kprobe_exceptions_nb = {
1720 .notifier_call = kprobe_exceptions_notify,
Anil S Keshavamurthy3d5631e2006-06-26 00:25:28 -07001721 .priority = 0x7fffffff /* we need to be notified first */
1722};
1723
Michael Ellerman3d7e3382007-07-19 01:48:11 -07001724unsigned long __weak arch_deref_entry_point(void *entry)
1725{
1726 return (unsigned long)entry;
1727}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001728
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001729int register_jprobes(struct jprobe **jps, int num)
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001730{
1731 struct jprobe *jp;
1732 int ret = 0, i;
1733
1734 if (num <= 0)
1735 return -EINVAL;
1736 for (i = 0; i < num; i++) {
Namhyung Kim05662bd2010-09-15 10:04:27 +09001737 unsigned long addr, offset;
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001738 jp = jps[i];
1739 addr = arch_deref_entry_point(jp->entry);
1740
Namhyung Kim05662bd2010-09-15 10:04:27 +09001741 /* Verify probepoint is a function entry point */
1742 if (kallsyms_lookup_size_offset(addr, NULL, &offset) &&
1743 offset == 0) {
1744 jp->kp.pre_handler = setjmp_pre_handler;
1745 jp->kp.break_handler = longjmp_break_handler;
1746 ret = register_kprobe(&jp->kp);
1747 } else
1748 ret = -EINVAL;
Namhyung Kimedbaadb2010-09-15 10:04:26 +09001749
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001750 if (ret < 0) {
1751 if (i > 0)
1752 unregister_jprobes(jps, i);
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001753 break;
1754 }
1755 }
1756 return ret;
1757}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001758EXPORT_SYMBOL_GPL(register_jprobes);
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001759
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001760int register_jprobe(struct jprobe *jp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001761{
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001762 return register_jprobes(&jp, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001764EXPORT_SYMBOL_GPL(register_jprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001766void unregister_jprobe(struct jprobe *jp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767{
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001768 unregister_jprobes(&jp, 1);
1769}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001770EXPORT_SYMBOL_GPL(unregister_jprobe);
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001771
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001772void unregister_jprobes(struct jprobe **jps, int num)
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001773{
1774 int i;
1775
1776 if (num <= 0)
1777 return;
1778 mutex_lock(&kprobe_mutex);
1779 for (i = 0; i < num; i++)
1780 if (__unregister_kprobe_top(&jps[i]->kp) < 0)
1781 jps[i]->kp.addr = NULL;
1782 mutex_unlock(&kprobe_mutex);
1783
1784 synchronize_sched();
1785 for (i = 0; i < num; i++) {
1786 if (jps[i]->kp.addr)
1787 __unregister_kprobe_bottom(&jps[i]->kp);
1788 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001790EXPORT_SYMBOL_GPL(unregister_jprobes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08001792#ifdef CONFIG_KRETPROBES
Adrian Bunke65cefe2006-02-03 03:03:42 -08001793/*
1794 * This kprobe pre_handler is registered with every kretprobe. When probe
1795 * hits it will set up the return probe.
1796 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001797static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
Adrian Bunke65cefe2006-02-03 03:03:42 -08001798{
1799 struct kretprobe *rp = container_of(p, struct kretprobe, kp);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001800 unsigned long hash, flags = 0;
1801 struct kretprobe_instance *ri;
Adrian Bunke65cefe2006-02-03 03:03:42 -08001802
Masami Hiramatsuf96f5672014-08-04 03:10:16 +00001803 /*
1804 * To avoid deadlocks, prohibit return probing in NMI contexts,
1805 * just skip the probe and increase the (inexact) 'nmissed'
1806 * statistical counter, so that the user is informed that
1807 * something happened:
1808 */
1809 if (unlikely(in_nmi())) {
1810 rp->nmissed++;
1811 return 0;
1812 }
1813
1814 /* TODO: consider to only swap the RA after the last pre_handler fired */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001815 hash = hash_ptr(current, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001816 raw_spin_lock_irqsave(&rp->lock, flags);
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001817 if (!hlist_empty(&rp->free_instances)) {
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001818 ri = hlist_entry(rp->free_instances.first,
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001819 struct kretprobe_instance, hlist);
1820 hlist_del(&ri->hlist);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001821 raw_spin_unlock_irqrestore(&rp->lock, flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001822
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001823 ri->rp = rp;
1824 ri->task = current;
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001825
Jiang Liu55ca6142012-02-03 15:37:16 -08001826 if (rp->entry_handler && rp->entry_handler(ri, regs)) {
1827 raw_spin_lock_irqsave(&rp->lock, flags);
1828 hlist_add_head(&ri->hlist, &rp->free_instances);
1829 raw_spin_unlock_irqrestore(&rp->lock, flags);
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001830 return 0;
Jiang Liu55ca6142012-02-03 15:37:16 -08001831 }
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001832
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001833 arch_prepare_kretprobe(ri, regs);
1834
1835 /* XXX(hch): why is there no hlist_move_head? */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001836 INIT_HLIST_NODE(&ri->hlist);
1837 kretprobe_table_lock(hash, &flags);
1838 hlist_add_head(&ri->hlist, &kretprobe_inst_table[hash]);
1839 kretprobe_table_unlock(hash, &flags);
1840 } else {
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001841 rp->nmissed++;
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001842 raw_spin_unlock_irqrestore(&rp->lock, flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001843 }
Adrian Bunke65cefe2006-02-03 03:03:42 -08001844 return 0;
1845}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001846NOKPROBE_SYMBOL(pre_handler_kretprobe);
Adrian Bunke65cefe2006-02-03 03:03:42 -08001847
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001848int register_kretprobe(struct kretprobe *rp)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001849{
1850 int ret = 0;
1851 struct kretprobe_instance *inst;
1852 int i;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001853 void *addr;
Masami Hiramatsuf438d912007-10-16 01:27:49 -07001854
1855 if (kretprobe_blacklist_size) {
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001856 addr = kprobe_addr(&rp->kp);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001857 if (IS_ERR(addr))
1858 return PTR_ERR(addr);
Masami Hiramatsuf438d912007-10-16 01:27:49 -07001859
1860 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
1861 if (kretprobe_blacklist[i].addr == addr)
1862 return -EINVAL;
1863 }
1864 }
Hien Nguyenb94cce92005-06-23 00:09:19 -07001865
1866 rp->kp.pre_handler = pre_handler_kretprobe;
Ananth N Mavinakayanahalli7522a842006-04-20 02:43:11 -07001867 rp->kp.post_handler = NULL;
1868 rp->kp.fault_handler = NULL;
1869 rp->kp.break_handler = NULL;
Hien Nguyenb94cce92005-06-23 00:09:19 -07001870
1871 /* Pre-allocate memory for max kretprobe instances */
1872 if (rp->maxactive <= 0) {
1873#ifdef CONFIG_PREEMPT
Heiko Carstensc2ef6662009-12-21 13:02:24 +01001874 rp->maxactive = max_t(unsigned int, 10, 2*num_possible_cpus());
Hien Nguyenb94cce92005-06-23 00:09:19 -07001875#else
Ananth N Mavinakayanahalli4dae5602009-10-30 19:23:10 +05301876 rp->maxactive = num_possible_cpus();
Hien Nguyenb94cce92005-06-23 00:09:19 -07001877#endif
1878 }
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001879 raw_spin_lock_init(&rp->lock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001880 INIT_HLIST_HEAD(&rp->free_instances);
1881 for (i = 0; i < rp->maxactive; i++) {
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001882 inst = kmalloc(sizeof(struct kretprobe_instance) +
1883 rp->data_size, GFP_KERNEL);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001884 if (inst == NULL) {
1885 free_rp_inst(rp);
1886 return -ENOMEM;
1887 }
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001888 INIT_HLIST_NODE(&inst->hlist);
1889 hlist_add_head(&inst->hlist, &rp->free_instances);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001890 }
1891
1892 rp->nmissed = 0;
1893 /* Establish function entry probe point */
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001894 ret = register_kprobe(&rp->kp);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001895 if (ret != 0)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001896 free_rp_inst(rp);
1897 return ret;
1898}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001899EXPORT_SYMBOL_GPL(register_kretprobe);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001900
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001901int register_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001902{
1903 int ret = 0, i;
1904
1905 if (num <= 0)
1906 return -EINVAL;
1907 for (i = 0; i < num; i++) {
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001908 ret = register_kretprobe(rps[i]);
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001909 if (ret < 0) {
1910 if (i > 0)
1911 unregister_kretprobes(rps, i);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001912 break;
1913 }
1914 }
1915 return ret;
1916}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001917EXPORT_SYMBOL_GPL(register_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001918
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001919void unregister_kretprobe(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001920{
1921 unregister_kretprobes(&rp, 1);
1922}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001923EXPORT_SYMBOL_GPL(unregister_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001924
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001925void unregister_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001926{
1927 int i;
1928
1929 if (num <= 0)
1930 return;
1931 mutex_lock(&kprobe_mutex);
1932 for (i = 0; i < num; i++)
1933 if (__unregister_kprobe_top(&rps[i]->kp) < 0)
1934 rps[i]->kp.addr = NULL;
1935 mutex_unlock(&kprobe_mutex);
1936
1937 synchronize_sched();
1938 for (i = 0; i < num; i++) {
1939 if (rps[i]->kp.addr) {
1940 __unregister_kprobe_bottom(&rps[i]->kp);
1941 cleanup_rp_inst(rps[i]);
1942 }
1943 }
1944}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001945EXPORT_SYMBOL_GPL(unregister_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001946
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08001947#else /* CONFIG_KRETPROBES */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001948int register_kretprobe(struct kretprobe *rp)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001949{
1950 return -ENOSYS;
1951}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001952EXPORT_SYMBOL_GPL(register_kretprobe);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001953
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001954int register_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001955{
1956 return -ENOSYS;
1957}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001958EXPORT_SYMBOL_GPL(register_kretprobes);
1959
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001960void unregister_kretprobe(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001961{
1962}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001963EXPORT_SYMBOL_GPL(unregister_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001964
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001965void unregister_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001966{
1967}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001968EXPORT_SYMBOL_GPL(unregister_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001969
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001970static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
Srinivasa Ds346fd592007-02-20 13:57:54 -08001971{
1972 return 0;
1973}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001974NOKPROBE_SYMBOL(pre_handler_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001975
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08001976#endif /* CONFIG_KRETPROBES */
Hien Nguyenb94cce92005-06-23 00:09:19 -07001977
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001978/* Set the kprobe gone and remove its instruction buffer. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001979static void kill_kprobe(struct kprobe *p)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001980{
1981 struct kprobe *kp;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001982
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001983 p->flags |= KPROBE_FLAG_GONE;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001984 if (kprobe_aggrprobe(p)) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001985 /*
1986 * If this is an aggr_kprobe, we have to list all the
1987 * chained probes and mark them GONE.
1988 */
1989 list_for_each_entry_rcu(kp, &p->list, list)
1990 kp->flags |= KPROBE_FLAG_GONE;
1991 p->post_handler = NULL;
1992 p->break_handler = NULL;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001993 kill_optimized_kprobe(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001994 }
1995 /*
1996 * Here, we can remove insn_slot safely, because no thread calls
1997 * the original probed function (which will be freed soon) any more.
1998 */
1999 arch_remove_kprobe(p);
2000}
2001
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002002/* Disable one kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002003int disable_kprobe(struct kprobe *kp)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002004{
2005 int ret = 0;
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002006
2007 mutex_lock(&kprobe_mutex);
2008
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09002009 /* Disable this kprobe */
2010 if (__disable_kprobe(kp) == NULL)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002011 ret = -EINVAL;
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002012
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002013 mutex_unlock(&kprobe_mutex);
2014 return ret;
2015}
2016EXPORT_SYMBOL_GPL(disable_kprobe);
2017
2018/* Enable one kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002019int enable_kprobe(struct kprobe *kp)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002020{
2021 int ret = 0;
2022 struct kprobe *p;
2023
2024 mutex_lock(&kprobe_mutex);
2025
2026 /* Check whether specified probe is valid. */
2027 p = __get_valid_kprobe(kp);
2028 if (unlikely(p == NULL)) {
2029 ret = -EINVAL;
2030 goto out;
2031 }
2032
2033 if (kprobe_gone(kp)) {
2034 /* This kprobe has gone, we couldn't enable it. */
2035 ret = -EINVAL;
2036 goto out;
2037 }
2038
2039 if (p != kp)
2040 kp->flags &= ~KPROBE_FLAG_DISABLED;
2041
2042 if (!kprobes_all_disarmed && kprobe_disabled(p)) {
2043 p->flags &= ~KPROBE_FLAG_DISABLED;
2044 arm_kprobe(p);
2045 }
2046out:
2047 mutex_unlock(&kprobe_mutex);
2048 return ret;
2049}
2050EXPORT_SYMBOL_GPL(enable_kprobe);
2051
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002052void dump_kprobe(struct kprobe *kp)
Frederic Weisbecker24851d22009-08-26 23:38:30 +02002053{
2054 printk(KERN_WARNING "Dumping kprobe:\n");
2055 printk(KERN_WARNING "Name: %s\nAddress: %p\nOffset: %x\n",
2056 kp->symbol_name, kp->addr, kp->offset);
2057}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002058NOKPROBE_SYMBOL(dump_kprobe);
Frederic Weisbecker24851d22009-08-26 23:38:30 +02002059
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002060/*
2061 * Lookup and populate the kprobe_blacklist.
2062 *
2063 * Unlike the kretprobe blacklist, we'll need to determine
2064 * the range of addresses that belong to the said functions,
2065 * since a kprobe need not necessarily be at the beginning
2066 * of a function.
2067 */
2068static int __init populate_kprobe_blacklist(unsigned long *start,
2069 unsigned long *end)
2070{
2071 unsigned long *iter;
2072 struct kprobe_blacklist_entry *ent;
Masami Hiramatsud81b4252014-07-17 11:44:11 +00002073 unsigned long entry, offset = 0, size = 0;
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002074
2075 for (iter = start; iter < end; iter++) {
Masami Hiramatsud81b4252014-07-17 11:44:11 +00002076 entry = arch_deref_entry_point((void *)*iter);
2077
2078 if (!kernel_text_address(entry) ||
2079 !kallsyms_lookup_size_offset(entry, &size, &offset)) {
2080 pr_err("Failed to find blacklist at %p\n",
2081 (void *)entry);
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002082 continue;
2083 }
2084
2085 ent = kmalloc(sizeof(*ent), GFP_KERNEL);
2086 if (!ent)
2087 return -ENOMEM;
Masami Hiramatsud81b4252014-07-17 11:44:11 +00002088 ent->start_addr = entry;
2089 ent->end_addr = entry + size;
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002090 INIT_LIST_HEAD(&ent->list);
2091 list_add_tail(&ent->list, &kprobe_blacklist);
2092 }
2093 return 0;
2094}
2095
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002096/* Module notifier call back, checking kprobes on the module */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002097static int kprobes_module_callback(struct notifier_block *nb,
2098 unsigned long val, void *data)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002099{
2100 struct module *mod = data;
2101 struct hlist_head *head;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002102 struct kprobe *p;
2103 unsigned int i;
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002104 int checkcore = (val == MODULE_STATE_GOING);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002105
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002106 if (val != MODULE_STATE_GOING && val != MODULE_STATE_LIVE)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002107 return NOTIFY_DONE;
2108
2109 /*
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002110 * When MODULE_STATE_GOING was notified, both of module .text and
2111 * .init.text sections would be freed. When MODULE_STATE_LIVE was
2112 * notified, only .init.text section would be freed. We need to
2113 * disable kprobes which have been inserted in the sections.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002114 */
2115 mutex_lock(&kprobe_mutex);
2116 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2117 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -08002118 hlist_for_each_entry_rcu(p, head, hlist)
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002119 if (within_module_init((unsigned long)p->addr, mod) ||
2120 (checkcore &&
2121 within_module_core((unsigned long)p->addr, mod))) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002122 /*
2123 * The vaddr this probe is installed will soon
2124 * be vfreed buy not synced to disk. Hence,
2125 * disarming the breakpoint isn't needed.
2126 */
2127 kill_kprobe(p);
2128 }
2129 }
2130 mutex_unlock(&kprobe_mutex);
2131 return NOTIFY_DONE;
2132}
2133
2134static struct notifier_block kprobe_module_nb = {
2135 .notifier_call = kprobes_module_callback,
2136 .priority = 0
2137};
2138
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002139/* Markers of _kprobe_blacklist section */
2140extern unsigned long __start_kprobe_blacklist[];
2141extern unsigned long __stop_kprobe_blacklist[];
2142
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143static int __init init_kprobes(void)
2144{
2145 int i, err = 0;
2146
2147 /* FIXME allocate the probe table, currently defined statically */
2148 /* initialize all list heads */
Hien Nguyenb94cce92005-06-23 00:09:19 -07002149 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150 INIT_HLIST_HEAD(&kprobe_table[i]);
Hien Nguyenb94cce92005-06-23 00:09:19 -07002151 INIT_HLIST_HEAD(&kretprobe_inst_table[i]);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02002152 raw_spin_lock_init(&(kretprobe_table_locks[i].lock));
Hien Nguyenb94cce92005-06-23 00:09:19 -07002153 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002155 err = populate_kprobe_blacklist(__start_kprobe_blacklist,
2156 __stop_kprobe_blacklist);
2157 if (err) {
2158 pr_err("kprobes: failed to populate blacklist: %d\n", err);
2159 pr_err("Please take care of using kprobes.\n");
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07002160 }
2161
Masami Hiramatsuf438d912007-10-16 01:27:49 -07002162 if (kretprobe_blacklist_size) {
2163 /* lookup the function address from its name */
2164 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
2165 kprobe_lookup_name(kretprobe_blacklist[i].name,
2166 kretprobe_blacklist[i].addr);
2167 if (!kretprobe_blacklist[i].addr)
2168 printk("kretprobe: lookup failed: %s\n",
2169 kretprobe_blacklist[i].name);
2170 }
2171 }
2172
Masami Hiramatsub2be84d2010-02-25 08:34:15 -05002173#if defined(CONFIG_OPTPROBES)
2174#if defined(__ARCH_WANT_KPROBES_INSN_SLOT)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002175 /* Init kprobe_optinsn_slots */
2176 kprobe_optinsn_slots.insn_size = MAX_OPTINSN_SIZE;
2177#endif
Masami Hiramatsub2be84d2010-02-25 08:34:15 -05002178 /* By default, kprobes can be optimized */
2179 kprobes_allow_optimization = true;
2180#endif
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002181
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002182 /* By default, kprobes are armed */
2183 kprobes_all_disarmed = false;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002184
Rusty Lynch67729262005-07-05 18:54:50 -07002185 err = arch_init_kprobes();
Rusty Lynch802eae72005-06-27 15:17:08 -07002186 if (!err)
2187 err = register_die_notifier(&kprobe_exceptions_nb);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002188 if (!err)
2189 err = register_module_notifier(&kprobe_module_nb);
2190
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07002191 kprobes_initialized = (err == 0);
Rusty Lynch802eae72005-06-27 15:17:08 -07002192
Ananth N Mavinakayanahalli8c1c9352008-01-30 13:32:53 +01002193 if (!err)
2194 init_test_probes();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195 return err;
2196}
2197
Srinivasa Ds346fd592007-02-20 13:57:54 -08002198#ifdef CONFIG_DEBUG_FS
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002199static void report_probe(struct seq_file *pi, struct kprobe *p,
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002200 const char *sym, int offset, char *modname, struct kprobe *pp)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002201{
2202 char *kprobe_type;
2203
2204 if (p->pre_handler == pre_handler_kretprobe)
2205 kprobe_type = "r";
2206 else if (p->pre_handler == setjmp_pre_handler)
2207 kprobe_type = "j";
2208 else
2209 kprobe_type = "k";
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002210
Srinivasa Ds346fd592007-02-20 13:57:54 -08002211 if (sym)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002212 seq_printf(pi, "%p %s %s+0x%x %s ",
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002213 p->addr, kprobe_type, sym, offset,
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002214 (modname ? modname : " "));
Srinivasa Ds346fd592007-02-20 13:57:54 -08002215 else
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002216 seq_printf(pi, "%p %s %p ",
2217 p->addr, kprobe_type, p->addr);
2218
2219 if (!pp)
2220 pp = p;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002221 seq_printf(pi, "%s%s%s%s\n",
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002222 (kprobe_gone(p) ? "[GONE]" : ""),
2223 ((kprobe_disabled(p) && !kprobe_gone(p)) ? "[DISABLED]" : ""),
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002224 (kprobe_optimized(pp) ? "[OPTIMIZED]" : ""),
2225 (kprobe_ftrace(pp) ? "[FTRACE]" : ""));
Srinivasa Ds346fd592007-02-20 13:57:54 -08002226}
2227
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002228static void *kprobe_seq_start(struct seq_file *f, loff_t *pos)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002229{
2230 return (*pos < KPROBE_TABLE_SIZE) ? pos : NULL;
2231}
2232
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002233static void *kprobe_seq_next(struct seq_file *f, void *v, loff_t *pos)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002234{
2235 (*pos)++;
2236 if (*pos >= KPROBE_TABLE_SIZE)
2237 return NULL;
2238 return pos;
2239}
2240
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002241static void kprobe_seq_stop(struct seq_file *f, void *v)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002242{
2243 /* Nothing to do */
2244}
2245
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002246static int show_kprobe_addr(struct seq_file *pi, void *v)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002247{
2248 struct hlist_head *head;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002249 struct kprobe *p, *kp;
2250 const char *sym = NULL;
2251 unsigned int i = *(loff_t *) v;
Alexey Dobriyanffb45122007-05-08 00:28:41 -07002252 unsigned long offset = 0;
Joe Marioab767862013-11-12 15:10:23 -08002253 char *modname, namebuf[KSYM_NAME_LEN];
Srinivasa Ds346fd592007-02-20 13:57:54 -08002254
2255 head = &kprobe_table[i];
2256 preempt_disable();
Sasha Levinb67bfe02013-02-27 17:06:00 -08002257 hlist_for_each_entry_rcu(p, head, hlist) {
Alexey Dobriyanffb45122007-05-08 00:28:41 -07002258 sym = kallsyms_lookup((unsigned long)p->addr, NULL,
Srinivasa Ds346fd592007-02-20 13:57:54 -08002259 &offset, &modname, namebuf);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002260 if (kprobe_aggrprobe(p)) {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002261 list_for_each_entry_rcu(kp, &p->list, list)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002262 report_probe(pi, kp, sym, offset, modname, p);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002263 } else
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002264 report_probe(pi, p, sym, offset, modname, NULL);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002265 }
2266 preempt_enable();
2267 return 0;
2268}
2269
James Morris88e9d342009-09-22 16:43:43 -07002270static const struct seq_operations kprobes_seq_ops = {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002271 .start = kprobe_seq_start,
2272 .next = kprobe_seq_next,
2273 .stop = kprobe_seq_stop,
2274 .show = show_kprobe_addr
2275};
2276
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002277static int kprobes_open(struct inode *inode, struct file *filp)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002278{
2279 return seq_open(filp, &kprobes_seq_ops);
2280}
2281
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002282static const struct file_operations debugfs_kprobes_operations = {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002283 .open = kprobes_open,
2284 .read = seq_read,
2285 .llseek = seq_lseek,
2286 .release = seq_release,
2287};
2288
Masami Hiramatsu63724742014-04-17 17:18:49 +09002289/* kprobes/blacklist -- shows which functions can not be probed */
2290static void *kprobe_blacklist_seq_start(struct seq_file *m, loff_t *pos)
2291{
2292 return seq_list_start(&kprobe_blacklist, *pos);
2293}
2294
2295static void *kprobe_blacklist_seq_next(struct seq_file *m, void *v, loff_t *pos)
2296{
2297 return seq_list_next(v, &kprobe_blacklist, pos);
2298}
2299
2300static int kprobe_blacklist_seq_show(struct seq_file *m, void *v)
2301{
2302 struct kprobe_blacklist_entry *ent =
2303 list_entry(v, struct kprobe_blacklist_entry, list);
2304
2305 seq_printf(m, "0x%p-0x%p\t%ps\n", (void *)ent->start_addr,
2306 (void *)ent->end_addr, (void *)ent->start_addr);
2307 return 0;
2308}
2309
2310static const struct seq_operations kprobe_blacklist_seq_ops = {
2311 .start = kprobe_blacklist_seq_start,
2312 .next = kprobe_blacklist_seq_next,
2313 .stop = kprobe_seq_stop, /* Reuse void function */
2314 .show = kprobe_blacklist_seq_show,
2315};
2316
2317static int kprobe_blacklist_open(struct inode *inode, struct file *filp)
2318{
2319 return seq_open(filp, &kprobe_blacklist_seq_ops);
2320}
2321
2322static const struct file_operations debugfs_kprobe_blacklist_ops = {
2323 .open = kprobe_blacklist_open,
2324 .read = seq_read,
2325 .llseek = seq_lseek,
2326 .release = seq_release,
2327};
2328
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002329static void arm_all_kprobes(void)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002330{
2331 struct hlist_head *head;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002332 struct kprobe *p;
2333 unsigned int i;
2334
2335 mutex_lock(&kprobe_mutex);
2336
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002337 /* If kprobes are armed, just return */
2338 if (!kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002339 goto already_enabled;
2340
Wang Nan977ad482015-02-13 14:40:24 -08002341 /*
2342 * optimize_kprobe() called by arm_kprobe() checks
2343 * kprobes_all_disarmed, so set kprobes_all_disarmed before
2344 * arm_kprobe.
2345 */
2346 kprobes_all_disarmed = false;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002347 /* Arming kprobes doesn't optimize kprobe itself */
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002348 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2349 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -08002350 hlist_for_each_entry_rcu(p, head, hlist)
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002351 if (!kprobe_disabled(p))
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002352 arm_kprobe(p);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002353 }
2354
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002355 printk(KERN_INFO "Kprobes globally enabled\n");
2356
2357already_enabled:
2358 mutex_unlock(&kprobe_mutex);
2359 return;
2360}
2361
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002362static void disarm_all_kprobes(void)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002363{
2364 struct hlist_head *head;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002365 struct kprobe *p;
2366 unsigned int i;
2367
2368 mutex_lock(&kprobe_mutex);
2369
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002370 /* If kprobes are already disarmed, just return */
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002371 if (kprobes_all_disarmed) {
2372 mutex_unlock(&kprobe_mutex);
2373 return;
2374 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002375
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002376 kprobes_all_disarmed = true;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002377 printk(KERN_INFO "Kprobes globally disabled\n");
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002378
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002379 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2380 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -08002381 hlist_for_each_entry_rcu(p, head, hlist) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002382 if (!arch_trampoline_kprobe(p) && !kprobe_disabled(p))
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002383 disarm_kprobe(p, false);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002384 }
2385 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002386 mutex_unlock(&kprobe_mutex);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002387
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002388 /* Wait for disarming all kprobes by optimizer */
2389 wait_for_kprobe_optimizer();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002390}
2391
2392/*
2393 * XXX: The debugfs bool file interface doesn't allow for callbacks
2394 * when the bool state is switched. We can reuse that facility when
2395 * available
2396 */
2397static ssize_t read_enabled_file_bool(struct file *file,
2398 char __user *user_buf, size_t count, loff_t *ppos)
2399{
2400 char buf[3];
2401
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002402 if (!kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002403 buf[0] = '1';
2404 else
2405 buf[0] = '0';
2406 buf[1] = '\n';
2407 buf[2] = 0x00;
2408 return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
2409}
2410
2411static ssize_t write_enabled_file_bool(struct file *file,
2412 const char __user *user_buf, size_t count, loff_t *ppos)
2413{
2414 char buf[32];
Stephen Boydefeb1562012-01-12 17:17:11 -08002415 size_t buf_size;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002416
2417 buf_size = min(count, (sizeof(buf)-1));
2418 if (copy_from_user(buf, user_buf, buf_size))
2419 return -EFAULT;
2420
Mathias Krause10fb46d2013-07-03 15:05:39 -07002421 buf[buf_size] = '\0';
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002422 switch (buf[0]) {
2423 case 'y':
2424 case 'Y':
2425 case '1':
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002426 arm_all_kprobes();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002427 break;
2428 case 'n':
2429 case 'N':
2430 case '0':
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002431 disarm_all_kprobes();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002432 break;
Mathias Krause10fb46d2013-07-03 15:05:39 -07002433 default:
2434 return -EINVAL;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002435 }
2436
2437 return count;
2438}
2439
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002440static const struct file_operations fops_kp = {
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002441 .read = read_enabled_file_bool,
2442 .write = write_enabled_file_bool,
Arnd Bergmann6038f372010-08-15 18:52:59 +02002443 .llseek = default_llseek,
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002444};
2445
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002446static int __init debugfs_kprobe_init(void)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002447{
2448 struct dentry *dir, *file;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002449 unsigned int value = 1;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002450
2451 dir = debugfs_create_dir("kprobes", NULL);
2452 if (!dir)
2453 return -ENOMEM;
2454
Masami Hiramatsu5749cd62018-04-28 21:35:01 +09002455 file = debugfs_create_file("list", 0400, dir, NULL,
Srinivasa Ds346fd592007-02-20 13:57:54 -08002456 &debugfs_kprobes_operations);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002457 if (!file)
2458 goto error;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002459
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002460 file = debugfs_create_file("enabled", 0600, dir,
2461 &value, &fops_kp);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002462 if (!file)
2463 goto error;
2464
Masami Hiramatsu5749cd62018-04-28 21:35:01 +09002465 file = debugfs_create_file("blacklist", 0400, dir, NULL,
Masami Hiramatsu63724742014-04-17 17:18:49 +09002466 &debugfs_kprobe_blacklist_ops);
2467 if (!file)
2468 goto error;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002469
Srinivasa Ds346fd592007-02-20 13:57:54 -08002470 return 0;
Masami Hiramatsu63724742014-04-17 17:18:49 +09002471
2472error:
2473 debugfs_remove(dir);
2474 return -ENOMEM;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002475}
2476
2477late_initcall(debugfs_kprobe_init);
2478#endif /* CONFIG_DEBUG_FS */
2479
2480module_init(init_kprobes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002481
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002482/* defined in arch/.../kernel/kprobes.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002483EXPORT_SYMBOL_GPL(jprobe_return);