kprobes.c 26.2 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
/*
 *  Kernel Probes (KProbes)
 *  kernel/kprobes.c
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 * Copyright (C) IBM Corporation, 2002, 2004
 *
 * 2002-Oct	Created by Vamsi Krishna S <vamsi_krishna@in.ibm.com> Kernel
 *		Probes initial implementation (includes suggestions from
 *		Rusty Russell).
 * 2004-Aug	Updated by Prasanna S Panchamukhi <prasanna@in.ibm.com> with
 *		hlists and exceptions notifier as suggested by Andi Kleen.
 * 2004-July	Suparna Bhattacharya <suparna@in.ibm.com> added jumper probes
 *		interface to access function arguments.
 * 2004-Sep	Prasanna S Panchamukhi <prasanna@in.ibm.com> Changed Kprobes
 *		exceptions notifier to be first on the priority list.
30 31 32
 * 2005-May	Hien Nguyen <hien@us.ibm.com>, Jim Keniston
 *		<jkenisto@us.ibm.com> and Prasanna S Panchamukhi
 *		<prasanna@in.ibm.com> added function-return probes.
L
Linus Torvalds 已提交
33 34 35 36
 */
#include <linux/kprobes.h>
#include <linux/hash.h>
#include <linux/init.h>
T
Tim Schmielau 已提交
37
#include <linux/slab.h>
R
Randy Dunlap 已提交
38
#include <linux/stddef.h>
L
Linus Torvalds 已提交
39
#include <linux/module.h>
40
#include <linux/moduleloader.h>
41
#include <linux/kallsyms.h>
42
#include <linux/freezer.h>
43 44
#include <linux/seq_file.h>
#include <linux/debugfs.h>
45
#include <linux/kdebug.h>
46

47
#include <asm-generic/sections.h>
L
Linus Torvalds 已提交
48 49
#include <asm/cacheflush.h>
#include <asm/errno.h>
50
#include <asm/uaccess.h>
L
Linus Torvalds 已提交
51 52 53 54

#define KPROBE_HASH_BITS 6
#define KPROBE_TABLE_SIZE (1 << KPROBE_HASH_BITS)

55 56 57 58 59 60 61 62 63 64

/*
 * Some oddball architectures like 64bit powerpc have function descriptors
 * so this must be overridable.
 */
#ifndef kprobe_lookup_name
#define kprobe_lookup_name(name, addr) \
	addr = ((kprobe_opcode_t *)(kallsyms_lookup_name(name)))
#endif

L
Linus Torvalds 已提交
65
static struct hlist_head kprobe_table[KPROBE_TABLE_SIZE];
66
static struct hlist_head kretprobe_inst_table[KPROBE_TABLE_SIZE];
67
static atomic_t kprobe_count;
L
Linus Torvalds 已提交
68

69 70 71
/* NOTE: change this value only with kprobe_mutex held */
static bool kprobe_enabled;

I
Ingo Molnar 已提交
72
DEFINE_MUTEX(kprobe_mutex);		/* Protects kprobe_table */
73
DEFINE_SPINLOCK(kretprobe_lock);	/* Protects kretprobe_inst_table */
74
static DEFINE_PER_CPU(struct kprobe *, kprobe_instance) = NULL;
L
Linus Torvalds 已提交
75

76 77 78 79 80
static struct notifier_block kprobe_page_fault_nb = {
	.notifier_call = kprobe_exceptions_notify,
	.priority = 0x7fffffff /* we need to notified first */
};

81
#ifdef __ARCH_WANT_KPROBES_INSN_SLOT
82 83 84 85 86 87 88 89 90 91 92 93 94
/*
 * kprobe->ainsn.insn points to the copy of the instruction to be
 * single-stepped. x86_64, POWER4 and above have no-exec support and
 * stepping on the instruction on a vmalloced/kmalloced/data page
 * is a recipe for disaster
 */
#define INSNS_PER_PAGE	(PAGE_SIZE/(MAX_INSN_SIZE * sizeof(kprobe_opcode_t)))

struct kprobe_insn_page {
	struct hlist_node hlist;
	kprobe_opcode_t *insns;		/* Page of instruction slots */
	char slot_used[INSNS_PER_PAGE];
	int nused;
95
	int ngarbage;
96 97
};

98 99 100 101 102 103
enum kprobe_slot_state {
	SLOT_CLEAN = 0,
	SLOT_DIRTY = 1,
	SLOT_USED = 2,
};

104
static struct hlist_head kprobe_insn_pages;
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
static int kprobe_garbage_slots;
static int collect_garbage_slots(void);

static int __kprobes check_safety(void)
{
	int ret = 0;
#if defined(CONFIG_PREEMPT) && defined(CONFIG_PM)
	ret = freeze_processes();
	if (ret == 0) {
		struct task_struct *p, *q;
		do_each_thread(p, q) {
			if (p != current && p->state == TASK_RUNNING &&
			    p->pid != 0) {
				printk("Check failed: %s is running\n",p->comm);
				ret = -1;
				goto loop_end;
			}
		} while_each_thread(p, q);
	}
loop_end:
	thaw_processes();
#else
	synchronize_sched();
#endif
	return ret;
}
131 132 133 134 135

/**
 * get_insn_slot() - Find a slot on an executable page for an instruction.
 * We allocate an executable page if there's no room on existing ones.
 */
136
kprobe_opcode_t __kprobes *get_insn_slot(void)
137 138 139 140
{
	struct kprobe_insn_page *kip;
	struct hlist_node *pos;

141
 retry:
142
	hlist_for_each_entry(kip, pos, &kprobe_insn_pages, hlist) {
143 144 145
		if (kip->nused < INSNS_PER_PAGE) {
			int i;
			for (i = 0; i < INSNS_PER_PAGE; i++) {
146 147
				if (kip->slot_used[i] == SLOT_CLEAN) {
					kip->slot_used[i] = SLOT_USED;
148 149 150 151 152 153 154 155 156
					kip->nused++;
					return kip->insns + (i * MAX_INSN_SIZE);
				}
			}
			/* Surprise!  No unused slots.  Fix kip->nused. */
			kip->nused = INSNS_PER_PAGE;
		}
	}

157 158 159 160 161
	/* If there are any garbage slots, collect it and try again. */
	if (kprobe_garbage_slots && collect_garbage_slots() == 0) {
		goto retry;
	}
	/* All out of space.  Need to allocate a new page. Use slot 0. */
162
	kip = kmalloc(sizeof(struct kprobe_insn_page), GFP_KERNEL);
163
	if (!kip)
164 165 166 167 168 169 170 171 172 173 174 175 176 177
		return NULL;

	/*
	 * Use module_alloc so this page is within +/- 2GB of where the
	 * kernel image and loaded module images reside. This is required
	 * so x86_64 can correctly handle the %rip-relative fixups.
	 */
	kip->insns = module_alloc(PAGE_SIZE);
	if (!kip->insns) {
		kfree(kip);
		return NULL;
	}
	INIT_HLIST_NODE(&kip->hlist);
	hlist_add_head(&kip->hlist, &kprobe_insn_pages);
178 179
	memset(kip->slot_used, SLOT_CLEAN, INSNS_PER_PAGE);
	kip->slot_used[0] = SLOT_USED;
180
	kip->nused = 1;
181
	kip->ngarbage = 0;
182 183 184
	return kip->insns;
}

185 186 187
/* Return 1 if all garbages are collected, otherwise 0. */
static int __kprobes collect_one_slot(struct kprobe_insn_page *kip, int idx)
{
188
	kip->slot_used[idx] = SLOT_CLEAN;
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
	kip->nused--;
	if (kip->nused == 0) {
		/*
		 * Page is no longer in use.  Free it unless
		 * it's the last one.  We keep the last one
		 * so as not to have to set it up again the
		 * next time somebody inserts a probe.
		 */
		hlist_del(&kip->hlist);
		if (hlist_empty(&kprobe_insn_pages)) {
			INIT_HLIST_NODE(&kip->hlist);
			hlist_add_head(&kip->hlist,
				       &kprobe_insn_pages);
		} else {
			module_free(NULL, kip->insns);
			kfree(kip);
		}
		return 1;
	}
	return 0;
}

static int __kprobes collect_garbage_slots(void)
{
	struct kprobe_insn_page *kip;
	struct hlist_node *pos, *next;

	/* Ensure no-one is preepmted on the garbages */
	if (check_safety() != 0)
		return -EAGAIN;

220
	hlist_for_each_entry_safe(kip, pos, next, &kprobe_insn_pages, hlist) {
221 222 223 224 225
		int i;
		if (kip->ngarbage == 0)
			continue;
		kip->ngarbage = 0;	/* we will collect all garbages */
		for (i = 0; i < INSNS_PER_PAGE; i++) {
226
			if (kip->slot_used[i] == SLOT_DIRTY &&
227 228 229 230 231 232 233 234 235
			    collect_one_slot(kip, i))
				break;
		}
	}
	kprobe_garbage_slots = 0;
	return 0;
}

void __kprobes free_insn_slot(kprobe_opcode_t * slot, int dirty)
236 237 238 239
{
	struct kprobe_insn_page *kip;
	struct hlist_node *pos;

240
	hlist_for_each_entry(kip, pos, &kprobe_insn_pages, hlist) {
241 242 243
		if (kip->insns <= slot &&
		    slot < kip->insns + (INSNS_PER_PAGE * MAX_INSN_SIZE)) {
			int i = (slot - kip->insns) / MAX_INSN_SIZE;
244
			if (dirty) {
245
				kip->slot_used[i] = SLOT_DIRTY;
246 247 248
				kip->ngarbage++;
			} else {
				collect_one_slot(kip, i);
249
			}
250
			break;
251 252
		}
	}
253 254

	if (dirty && ++kprobe_garbage_slots > INSNS_PER_PAGE)
255
		collect_garbage_slots();
256
}
257
#endif
258

259 260 261 262 263 264 265 266 267 268 269
/* We have preemption disabled.. so it is safe to use __ versions */
static inline void set_kprobe_instance(struct kprobe *kp)
{
	__get_cpu_var(kprobe_instance) = kp;
}

static inline void reset_kprobe_instance(void)
{
	__get_cpu_var(kprobe_instance) = NULL;
}

270 271
/*
 * This routine is called either:
272
 * 	- under the kprobe_mutex - during kprobe_[un]register()
273
 * 				OR
274
 * 	- with preemption disabled - from arch/xxx/kernel/kprobes.c
275
 */
276
struct kprobe __kprobes *get_kprobe(void *addr)
L
Linus Torvalds 已提交
277 278 279
{
	struct hlist_head *head;
	struct hlist_node *node;
280
	struct kprobe *p;
L
Linus Torvalds 已提交
281 282

	head = &kprobe_table[hash_ptr(addr, KPROBE_HASH_BITS)];
283
	hlist_for_each_entry_rcu(p, node, head, hlist) {
L
Linus Torvalds 已提交
284 285 286 287 288 289
		if (p->addr == addr)
			return p;
	}
	return NULL;
}

290 291 292 293
/*
 * Aggregate handlers for multiple kprobes support - these handlers
 * take care of invoking the individual kprobe handlers on p->list
 */
294
static int __kprobes aggr_pre_handler(struct kprobe *p, struct pt_regs *regs)
295 296 297
{
	struct kprobe *kp;

298
	list_for_each_entry_rcu(kp, &p->list, list) {
299
		if (kp->pre_handler) {
300
			set_kprobe_instance(kp);
301 302
			if (kp->pre_handler(kp, regs))
				return 1;
303
		}
304
		reset_kprobe_instance();
305 306 307 308
	}
	return 0;
}

309 310
static void __kprobes aggr_post_handler(struct kprobe *p, struct pt_regs *regs,
					unsigned long flags)
311 312 313
{
	struct kprobe *kp;

314
	list_for_each_entry_rcu(kp, &p->list, list) {
315
		if (kp->post_handler) {
316
			set_kprobe_instance(kp);
317
			kp->post_handler(kp, regs, flags);
318
			reset_kprobe_instance();
319 320 321 322
		}
	}
}

323 324
static int __kprobes aggr_fault_handler(struct kprobe *p, struct pt_regs *regs,
					int trapnr)
325
{
326 327
	struct kprobe *cur = __get_cpu_var(kprobe_instance);

328 329 330 331
	/*
	 * if we faulted "during" the execution of a user specified
	 * probe handler, invoke just that probe's fault handler
	 */
332 333
	if (cur && cur->fault_handler) {
		if (cur->fault_handler(cur, regs, trapnr))
334 335 336 337 338
			return 1;
	}
	return 0;
}

339
static int __kprobes aggr_break_handler(struct kprobe *p, struct pt_regs *regs)
340
{
341 342 343 344 345 346
	struct kprobe *cur = __get_cpu_var(kprobe_instance);
	int ret = 0;

	if (cur && cur->break_handler) {
		if (cur->break_handler(cur, regs))
			ret = 1;
347
	}
348 349
	reset_kprobe_instance();
	return ret;
350 351
}

352 353 354 355 356 357 358 359 360 361 362 363 364
/* Walks the list and increments nmissed count for multiprobe case */
void __kprobes kprobes_inc_nmissed_count(struct kprobe *p)
{
	struct kprobe *kp;
	if (p->pre_handler != aggr_pre_handler) {
		p->nmissed++;
	} else {
		list_for_each_entry_rcu(kp, &p->list, list)
			kp->nmissed++;
	}
	return;
}

365
/* Called with kretprobe_lock held */
366 367
void __kprobes recycle_rp_inst(struct kretprobe_instance *ri,
				struct hlist_head *head)
368 369 370 371 372 373 374 375 376 377 378
{
	/* remove rp inst off the rprobe_inst_table */
	hlist_del(&ri->hlist);
	if (ri->rp) {
		/* remove rp inst off the used list */
		hlist_del(&ri->uflist);
		/* put rp inst back onto the free list */
		INIT_HLIST_NODE(&ri->uflist);
		hlist_add_head(&ri->uflist, &ri->rp->free_instances);
	} else
		/* Unregistering */
379
		hlist_add_head(&ri->hlist, head);
380 381
}

382
struct hlist_head __kprobes *kretprobe_inst_table_head(struct task_struct *tsk)
383 384 385 386 387
{
	return &kretprobe_inst_table[hash_ptr(tsk, KPROBE_HASH_BITS)];
}

/*
388 389 390 391
 * This function is called from finish_task_switch when task tk becomes dead,
 * so that we can recycle any function-return probe instances associated
 * with this task. These left over instances represent probed functions
 * that have been called but will never return.
392
 */
393
void __kprobes kprobe_flush_task(struct task_struct *tk)
394
{
B
bibo,mao 已提交
395
	struct kretprobe_instance *ri;
396
	struct hlist_head *head, empty_rp;
397
	struct hlist_node *node, *tmp;
398
	unsigned long flags = 0;
399

400
	INIT_HLIST_HEAD(&empty_rp);
401
	spin_lock_irqsave(&kretprobe_lock, flags);
B
bibo,mao 已提交
402 403 404
	head = kretprobe_inst_table_head(tk);
	hlist_for_each_entry_safe(ri, node, tmp, head, hlist) {
		if (ri->task == tk)
405
			recycle_rp_inst(ri, &empty_rp);
B
bibo,mao 已提交
406
	}
407
	spin_unlock_irqrestore(&kretprobe_lock, flags);
408 409 410 411 412

	hlist_for_each_entry_safe(ri, node, tmp, &empty_rp, hlist) {
		hlist_del(&ri->hlist);
		kfree(ri);
	}
413 414 415 416 417
}

static inline void free_rp_inst(struct kretprobe *rp)
{
	struct kretprobe_instance *ri;
418 419 420
	struct hlist_node *pos, *next;

	hlist_for_each_entry_safe(ri, pos, next, &rp->free_instances, uflist) {
421 422 423 424 425
		hlist_del(&ri->uflist);
		kfree(ri);
	}
}

426 427 428 429 430 431 432 433 434 435 436 437 438
/*
 * Keep all fields in the kprobe consistent
 */
static inline void copy_kprobe(struct kprobe *old_p, struct kprobe *p)
{
	memcpy(&p->opcode, &old_p->opcode, sizeof(kprobe_opcode_t));
	memcpy(&p->ainsn, &old_p->ainsn, sizeof(struct arch_specific_insn));
}

/*
* Add the new probe to old_p->list. Fail if this is the
* second jprobe at the address - two jprobes can't coexist
*/
439
static int __kprobes add_new_kprobe(struct kprobe *old_p, struct kprobe *p)
440 441
{
	if (p->break_handler) {
442 443
		if (old_p->break_handler)
			return -EEXIST;
444
		list_add_tail_rcu(&p->list, &old_p->list);
445
		old_p->break_handler = aggr_break_handler;
446
	} else
447
		list_add_rcu(&p->list, &old_p->list);
448 449
	if (p->post_handler && !old_p->post_handler)
		old_p->post_handler = aggr_post_handler;
450 451 452
	return 0;
}

453 454 455 456 457 458
/*
 * Fill in the required fields of the "manager kprobe". Replace the
 * earlier kprobe in the hlist with the manager kprobe
 */
static inline void add_aggr_kprobe(struct kprobe *ap, struct kprobe *p)
{
459
	copy_kprobe(p, ap);
460
	flush_insn_slot(ap);
461 462 463
	ap->addr = p->addr;
	ap->pre_handler = aggr_pre_handler;
	ap->fault_handler = aggr_fault_handler;
464 465 466 467
	if (p->post_handler)
		ap->post_handler = aggr_post_handler;
	if (p->break_handler)
		ap->break_handler = aggr_break_handler;
468 469

	INIT_LIST_HEAD(&ap->list);
470
	list_add_rcu(&p->list, &ap->list);
471

472
	hlist_replace_rcu(&p->hlist, &ap->hlist);
473 474 475 476 477 478
}

/*
 * This is the second or subsequent kprobe at the address - handle
 * the intricacies
 */
479 480
static int __kprobes register_aggr_kprobe(struct kprobe *old_p,
					  struct kprobe *p)
481 482 483 484
{
	int ret = 0;
	struct kprobe *ap;

485 486 487
	if (old_p->pre_handler == aggr_pre_handler) {
		copy_kprobe(old_p, p);
		ret = add_new_kprobe(old_p, p);
488
	} else {
489
		ap = kzalloc(sizeof(struct kprobe), GFP_KERNEL);
490 491 492
		if (!ap)
			return -ENOMEM;
		add_aggr_kprobe(ap, old_p);
493 494
		copy_kprobe(ap, p);
		ret = add_new_kprobe(ap, p);
495 496 497 498
	}
	return ret;
}

499 500
static int __kprobes in_kprobes_functions(unsigned long addr)
{
501 502
	if (addr >= (unsigned long)__kprobes_text_start &&
	    addr < (unsigned long)__kprobes_text_end)
503 504 505 506
		return -EINVAL;
	return 0;
}

507 508
static int __kprobes __register_kprobe(struct kprobe *p,
	unsigned long called_from)
L
Linus Torvalds 已提交
509 510
{
	int ret = 0;
511
	struct kprobe *old_p;
512
	struct module *probed_mod;
513

514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
	/*
	 * If we have a symbol_name argument look it up,
	 * and add it to the address.  That way the addr
	 * field can either be global or relative to a symbol.
	 */
	if (p->symbol_name) {
		if (p->addr)
			return -EINVAL;
		kprobe_lookup_name(p->symbol_name, p->addr);
	}

	if (!p->addr)
		return -EINVAL;
	p->addr = (kprobe_opcode_t *)(((char *)p->addr)+ p->offset);

529 530
	if (!kernel_text_address((unsigned long) p->addr) ||
	    in_kprobes_functions((unsigned long) p->addr))
531 532
		return -EINVAL;

533
	p->mod_refcounted = 0;
534 535 536 537 538 539

	/*
	 * Check if are we probing a module.
	 */
	probed_mod = module_text_address((unsigned long) p->addr);
	if (probed_mod) {
540
		struct module *calling_mod = module_text_address(called_from);
541 542 543 544
		/*
		 * We must allow modules to probe themself and in this case
		 * avoid incrementing the module refcount, so as to allow
		 * unloading of self probing modules.
545
		 */
546
		if (calling_mod && calling_mod != probed_mod) {
547 548 549 550 551 552
			if (unlikely(!try_module_get(probed_mod)))
				return -EINVAL;
			p->mod_refcounted = 1;
		} else
			probed_mod = NULL;
	}
L
Linus Torvalds 已提交
553

554
	p->nmissed = 0;
I
Ingo Molnar 已提交
555
	mutex_lock(&kprobe_mutex);
556 557 558
	old_p = get_kprobe(p->addr);
	if (old_p) {
		ret = register_aggr_kprobe(old_p, p);
559 560
		if (!ret)
			atomic_inc(&kprobe_count);
L
Linus Torvalds 已提交
561 562 563
		goto out;
	}

564 565
	ret = arch_prepare_kprobe(p);
	if (ret)
566 567
		goto out;

568
	INIT_HLIST_NODE(&p->hlist);
569
	hlist_add_head_rcu(&p->hlist,
L
Linus Torvalds 已提交
570 571
		       &kprobe_table[hash_ptr(p->addr, KPROBE_HASH_BITS)]);

572 573
	if (kprobe_enabled) {
		if (atomic_add_return(1, &kprobe_count) == \
574
				(ARCH_INACTIVE_KPROBE_COUNT + 1))
575
			register_page_fault_notifier(&kprobe_page_fault_nb);
576

577 578
		arch_arm_kprobe(p);
	}
L
Linus Torvalds 已提交
579
out:
I
Ingo Molnar 已提交
580
	mutex_unlock(&kprobe_mutex);
581

582 583
	if (ret && probed_mod)
		module_put(probed_mod);
L
Linus Torvalds 已提交
584 585 586
	return ret;
}

587 588
int __kprobes register_kprobe(struct kprobe *p)
{
589
	return __register_kprobe(p, (unsigned long)__builtin_return_address(0));
590 591
}

592
void __kprobes unregister_kprobe(struct kprobe *p)
L
Linus Torvalds 已提交
593
{
594
	struct module *mod;
595 596
	struct kprobe *old_p, *list_p;
	int cleanup_p;
597

I
Ingo Molnar 已提交
598
	mutex_lock(&kprobe_mutex);
599
	old_p = get_kprobe(p->addr);
600
	if (unlikely(!old_p)) {
I
Ingo Molnar 已提交
601
		mutex_unlock(&kprobe_mutex);
602 603
		return;
	}
604 605 606 607 608
	if (p != old_p) {
		list_for_each_entry_rcu(list_p, &old_p->list, list)
			if (list_p == p)
			/* kprobe p is a valid probe */
				goto valid_p;
I
Ingo Molnar 已提交
609
		mutex_unlock(&kprobe_mutex);
610 611 612
		return;
	}
valid_p:
613 614 615
	if (old_p == p ||
	    (old_p->pre_handler == aggr_pre_handler &&
	     p->list.next == &old_p->list && p->list.prev == &old_p->list)) {
616 617 618 619 620 621 622
		/*
		 * Only probe on the hash list. Disarm only if kprobes are
		 * enabled - otherwise, the breakpoint would already have
		 * been removed. We save on flushing icache.
		 */
		if (kprobe_enabled)
			arch_disarm_kprobe(p);
623
		hlist_del_rcu(&old_p->hlist);
624
		cleanup_p = 1;
625 626
	} else {
		list_del_rcu(&p->list);
627
		cleanup_p = 0;
628
	}
629

I
Ingo Molnar 已提交
630
	mutex_unlock(&kprobe_mutex);
631

632
	synchronize_sched();
633 634 635 636 637
	if (p->mod_refcounted) {
		mod = module_text_address((unsigned long)p->addr);
		if (mod)
			module_put(mod);
	}
638

639
	if (cleanup_p) {
640
		if (p != old_p) {
641
			list_del_rcu(&p->list);
642
			kfree(old_p);
643
		}
644
		arch_remove_kprobe(p);
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
	} else {
		mutex_lock(&kprobe_mutex);
		if (p->break_handler)
			old_p->break_handler = NULL;
		if (p->post_handler){
			list_for_each_entry_rcu(list_p, &old_p->list, list){
				if (list_p->post_handler){
					cleanup_p = 2;
					break;
				}
			}
			if (cleanup_p == 0)
				old_p->post_handler = NULL;
		}
		mutex_unlock(&kprobe_mutex);
660
	}
661 662 663 664 665 666 667 668 669 670

	/* Call unregister_page_fault_notifier()
	 * if no probes are active
	 */
	mutex_lock(&kprobe_mutex);
	if (atomic_add_return(-1, &kprobe_count) == \
				ARCH_INACTIVE_KPROBE_COUNT)
		unregister_page_fault_notifier(&kprobe_page_fault_nb);
	mutex_unlock(&kprobe_mutex);
	return;
L
Linus Torvalds 已提交
671 672 673
}

static struct notifier_block kprobe_exceptions_nb = {
674 675 676 677
	.notifier_call = kprobe_exceptions_notify,
	.priority = 0x7fffffff /* we need to be notified first */
};

678 679 680 681
unsigned long __weak arch_deref_entry_point(void *entry)
{
	return (unsigned long)entry;
}
L
Linus Torvalds 已提交
682

683
int __kprobes register_jprobe(struct jprobe *jp)
L
Linus Torvalds 已提交
684
{
685 686 687 688 689
	unsigned long addr = arch_deref_entry_point(jp->entry);

	if (!kernel_text_address(addr))
		return -EINVAL;

L
Linus Torvalds 已提交
690 691 692 693
	/* Todo: Verify probepoint is a function entry point */
	jp->kp.pre_handler = setjmp_pre_handler;
	jp->kp.break_handler = longjmp_break_handler;

694 695
	return __register_kprobe(&jp->kp,
		(unsigned long)__builtin_return_address(0));
L
Linus Torvalds 已提交
696 697
}

698
void __kprobes unregister_jprobe(struct jprobe *jp)
L
Linus Torvalds 已提交
699 700 701 702
{
	unregister_kprobe(&jp->kp);
}

703 704
#ifdef ARCH_SUPPORTS_KRETPROBES

705 706 707 708 709 710 711 712 713 714 715 716
/*
 * This kprobe pre_handler is registered with every kretprobe. When probe
 * hits it will set up the return probe.
 */
static int __kprobes pre_handler_kretprobe(struct kprobe *p,
					   struct pt_regs *regs)
{
	struct kretprobe *rp = container_of(p, struct kretprobe, kp);
	unsigned long flags = 0;

	/*TODO: consider to only swap the RA after the last pre_handler fired */
	spin_lock_irqsave(&kretprobe_lock, flags);
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
	if (!hlist_empty(&rp->free_instances)) {
		struct kretprobe_instance *ri;

		ri = hlist_entry(rp->free_instances.first,
				 struct kretprobe_instance, uflist);
		ri->rp = rp;
		ri->task = current;
		arch_prepare_kretprobe(ri, regs);

		/* XXX(hch): why is there no hlist_move_head? */
		hlist_del(&ri->uflist);
		hlist_add_head(&ri->uflist, &ri->rp->used_instances);
		hlist_add_head(&ri->hlist, kretprobe_inst_table_head(ri->task));
	} else
		rp->nmissed++;
732 733 734 735
	spin_unlock_irqrestore(&kretprobe_lock, flags);
	return 0;
}

736
int __kprobes register_kretprobe(struct kretprobe *rp)
737 738 739 740 741 742
{
	int ret = 0;
	struct kretprobe_instance *inst;
	int i;

	rp->kp.pre_handler = pre_handler_kretprobe;
743 744 745
	rp->kp.post_handler = NULL;
	rp->kp.fault_handler = NULL;
	rp->kp.break_handler = NULL;
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768

	/* Pre-allocate memory for max kretprobe instances */
	if (rp->maxactive <= 0) {
#ifdef CONFIG_PREEMPT
		rp->maxactive = max(10, 2 * NR_CPUS);
#else
		rp->maxactive = NR_CPUS;
#endif
	}
	INIT_HLIST_HEAD(&rp->used_instances);
	INIT_HLIST_HEAD(&rp->free_instances);
	for (i = 0; i < rp->maxactive; i++) {
		inst = kmalloc(sizeof(struct kretprobe_instance), GFP_KERNEL);
		if (inst == NULL) {
			free_rp_inst(rp);
			return -ENOMEM;
		}
		INIT_HLIST_NODE(&inst->uflist);
		hlist_add_head(&inst->uflist, &rp->free_instances);
	}

	rp->nmissed = 0;
	/* Establish function entry probe point */
769 770
	if ((ret = __register_kprobe(&rp->kp,
		(unsigned long)__builtin_return_address(0))) != 0)
771 772 773 774 775 776
		free_rp_inst(rp);
	return ret;
}

#else /* ARCH_SUPPORTS_KRETPROBES */

777
int __kprobes register_kretprobe(struct kretprobe *rp)
778 779 780 781
{
	return -ENOSYS;
}

782 783 784 785 786 787
static int __kprobes pre_handler_kretprobe(struct kprobe *p,
					   struct pt_regs *regs)
{
	return 0;
}

788 789
#endif /* ARCH_SUPPORTS_KRETPROBES */

790
void __kprobes unregister_kretprobe(struct kretprobe *rp)
791 792 793
{
	unsigned long flags;
	struct kretprobe_instance *ri;
794
	struct hlist_node *pos, *next;
795 796

	unregister_kprobe(&rp->kp);
797

798
	/* No race here */
799
	spin_lock_irqsave(&kretprobe_lock, flags);
800
	hlist_for_each_entry_safe(ri, pos, next, &rp->used_instances, uflist) {
801 802 803
		ri->rp = NULL;
		hlist_del(&ri->uflist);
	}
804
	spin_unlock_irqrestore(&kretprobe_lock, flags);
805
	free_rp_inst(rp);
806 807
}

L
Linus Torvalds 已提交
808 809 810 811 812 813
static int __init init_kprobes(void)
{
	int i, err = 0;

	/* FIXME allocate the probe table, currently defined statically */
	/* initialize all list heads */
814
	for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
L
Linus Torvalds 已提交
815
		INIT_HLIST_HEAD(&kprobe_table[i]);
816 817
		INIT_HLIST_HEAD(&kretprobe_inst_table[i]);
	}
818
	atomic_set(&kprobe_count, 0);
L
Linus Torvalds 已提交
819

820 821 822
	/* By default, kprobes are enabled */
	kprobe_enabled = true;

823
	err = arch_init_kprobes();
824 825 826
	if (!err)
		err = register_die_notifier(&kprobe_exceptions_nb);

L
Linus Torvalds 已提交
827 828 829
	return err;
}

830 831
#ifdef CONFIG_DEBUG_FS
static void __kprobes report_probe(struct seq_file *pi, struct kprobe *p,
832
		const char *sym, int offset,char *modname)
833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
{
	char *kprobe_type;

	if (p->pre_handler == pre_handler_kretprobe)
		kprobe_type = "r";
	else if (p->pre_handler == setjmp_pre_handler)
		kprobe_type = "j";
	else
		kprobe_type = "k";
	if (sym)
		seq_printf(pi, "%p  %s  %s+0x%x  %s\n", p->addr, kprobe_type,
			sym, offset, (modname ? modname : " "));
	else
		seq_printf(pi, "%p  %s  %p\n", p->addr, kprobe_type, p->addr);
}

static void __kprobes *kprobe_seq_start(struct seq_file *f, loff_t *pos)
{
	return (*pos < KPROBE_TABLE_SIZE) ? pos : NULL;
}

static void __kprobes *kprobe_seq_next(struct seq_file *f, void *v, loff_t *pos)
{
	(*pos)++;
	if (*pos >= KPROBE_TABLE_SIZE)
		return NULL;
	return pos;
}

static void __kprobes kprobe_seq_stop(struct seq_file *f, void *v)
{
	/* Nothing to do */
}

static int __kprobes show_kprobe_addr(struct seq_file *pi, void *v)
{
	struct hlist_head *head;
	struct hlist_node *node;
	struct kprobe *p, *kp;
	const char *sym = NULL;
	unsigned int i = *(loff_t *) v;
A
Alexey Dobriyan 已提交
874
	unsigned long offset = 0;
875 876 877 878 879
	char *modname, namebuf[128];

	head = &kprobe_table[i];
	preempt_disable();
	hlist_for_each_entry_rcu(p, node, head, hlist) {
A
Alexey Dobriyan 已提交
880
		sym = kallsyms_lookup((unsigned long)p->addr, NULL,
881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
					&offset, &modname, namebuf);
		if (p->pre_handler == aggr_pre_handler) {
			list_for_each_entry_rcu(kp, &p->list, list)
				report_probe(pi, kp, sym, offset, modname);
		} else
			report_probe(pi, p, sym, offset, modname);
	}
	preempt_enable();
	return 0;
}

static struct seq_operations kprobes_seq_ops = {
	.start = kprobe_seq_start,
	.next  = kprobe_seq_next,
	.stop  = kprobe_seq_stop,
	.show  = show_kprobe_addr
};

static int __kprobes kprobes_open(struct inode *inode, struct file *filp)
{
	return seq_open(filp, &kprobes_seq_ops);
}

static struct file_operations debugfs_kprobes_operations = {
	.open           = kprobes_open,
	.read           = seq_read,
	.llseek         = seq_lseek,
	.release        = seq_release,
};

911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
static void __kprobes enable_all_kprobes(void)
{
	struct hlist_head *head;
	struct hlist_node *node;
	struct kprobe *p;
	unsigned int i;

	mutex_lock(&kprobe_mutex);

	/* If kprobes are already enabled, just return */
	if (kprobe_enabled)
		goto already_enabled;

	/*
	 * Re-register the page fault notifier only if there are any
	 * active probes at the time of enabling kprobes globally
	 */
	if (atomic_read(&kprobe_count) > ARCH_INACTIVE_KPROBE_COUNT)
		register_page_fault_notifier(&kprobe_page_fault_nb);

	for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
		head = &kprobe_table[i];
		hlist_for_each_entry_rcu(p, node, head, hlist)
			arch_arm_kprobe(p);
	}

	kprobe_enabled = true;
	printk(KERN_INFO "Kprobes globally enabled\n");

already_enabled:
	mutex_unlock(&kprobe_mutex);
	return;
}

static void __kprobes disable_all_kprobes(void)
{
	struct hlist_head *head;
	struct hlist_node *node;
	struct kprobe *p;
	unsigned int i;

	mutex_lock(&kprobe_mutex);

	/* If kprobes are already disabled, just return */
	if (!kprobe_enabled)
		goto already_disabled;

	kprobe_enabled = false;
	printk(KERN_INFO "Kprobes globally disabled\n");
	for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
		head = &kprobe_table[i];
		hlist_for_each_entry_rcu(p, node, head, hlist) {
			if (!arch_trampoline_kprobe(p))
				arch_disarm_kprobe(p);
		}
	}

	mutex_unlock(&kprobe_mutex);
	/* Allow all currently running kprobes to complete */
	synchronize_sched();

	mutex_lock(&kprobe_mutex);
	/* Unconditionally unregister the page_fault notifier */
	unregister_page_fault_notifier(&kprobe_page_fault_nb);

already_disabled:
	mutex_unlock(&kprobe_mutex);
	return;
}

/*
 * XXX: The debugfs bool file interface doesn't allow for callbacks
 * when the bool state is switched. We can reuse that facility when
 * available
 */
static ssize_t read_enabled_file_bool(struct file *file,
	       char __user *user_buf, size_t count, loff_t *ppos)
{
	char buf[3];

	if (kprobe_enabled)
		buf[0] = '1';
	else
		buf[0] = '0';
	buf[1] = '\n';
	buf[2] = 0x00;
	return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
}

static ssize_t write_enabled_file_bool(struct file *file,
	       const char __user *user_buf, size_t count, loff_t *ppos)
{
	char buf[32];
	int buf_size;

	buf_size = min(count, (sizeof(buf)-1));
	if (copy_from_user(buf, user_buf, buf_size))
		return -EFAULT;

	switch (buf[0]) {
	case 'y':
	case 'Y':
	case '1':
		enable_all_kprobes();
		break;
	case 'n':
	case 'N':
	case '0':
		disable_all_kprobes();
		break;
	}

	return count;
}

static struct file_operations fops_kp = {
	.read =         read_enabled_file_bool,
	.write =        write_enabled_file_bool,
};

1031 1032 1033
static int __kprobes debugfs_kprobe_init(void)
{
	struct dentry *dir, *file;
1034
	unsigned int value = 1;
1035 1036 1037 1038 1039

	dir = debugfs_create_dir("kprobes", NULL);
	if (!dir)
		return -ENOMEM;

R
Randy Dunlap 已提交
1040
	file = debugfs_create_file("list", 0444, dir, NULL,
1041 1042 1043 1044 1045 1046
				&debugfs_kprobes_operations);
	if (!file) {
		debugfs_remove(dir);
		return -ENOMEM;
	}

1047 1048 1049 1050 1051 1052 1053
	file = debugfs_create_file("enabled", 0600, dir,
					&value, &fops_kp);
	if (!file) {
		debugfs_remove(dir);
		return -ENOMEM;
	}

1054 1055 1056 1057 1058 1059 1060
	return 0;
}

late_initcall(debugfs_kprobe_init);
#endif /* CONFIG_DEBUG_FS */

module_init(init_kprobes);
L
Linus Torvalds 已提交
1061 1062 1063 1064 1065

EXPORT_SYMBOL_GPL(register_kprobe);
EXPORT_SYMBOL_GPL(unregister_kprobe);
EXPORT_SYMBOL_GPL(register_jprobe);
EXPORT_SYMBOL_GPL(unregister_jprobe);
P
Peter Chubb 已提交
1066
#ifdef CONFIG_KPROBES
L
Linus Torvalds 已提交
1067
EXPORT_SYMBOL_GPL(jprobe_return);
P
Peter Chubb 已提交
1068 1069 1070
#endif

#ifdef CONFIG_KPROBES
1071 1072
EXPORT_SYMBOL_GPL(register_kretprobe);
EXPORT_SYMBOL_GPL(unregister_kretprobe);
P
Peter Chubb 已提交
1073
#endif