Linux Audio

Check our new training course

Loading...
v5.4
   1// SPDX-License-Identifier: GPL-2.0
   2/*
   3 * uprobes-based tracing events
   4 *
   5 * Copyright (C) IBM Corporation, 2010-2012
   6 * Author:	Srikar Dronamraju <srikar@linux.vnet.ibm.com>
   7 */
   8#define pr_fmt(fmt)	"trace_uprobe: " fmt
   9
 
  10#include <linux/security.h>
  11#include <linux/ctype.h>
  12#include <linux/module.h>
  13#include <linux/uaccess.h>
  14#include <linux/uprobes.h>
  15#include <linux/namei.h>
  16#include <linux/string.h>
  17#include <linux/rculist.h>
 
 
  18
  19#include "trace_dynevent.h"
  20#include "trace_probe.h"
  21#include "trace_probe_tmpl.h"
  22
  23#define UPROBE_EVENT_SYSTEM	"uprobes"
  24
  25struct uprobe_trace_entry_head {
  26	struct trace_entry	ent;
  27	unsigned long		vaddr[];
  28};
  29
  30#define SIZEOF_TRACE_ENTRY(is_return)			\
  31	(sizeof(struct uprobe_trace_entry_head) +	\
  32	 sizeof(unsigned long) * (is_return ? 2 : 1))
  33
  34#define DATAOF_TRACE_ENTRY(entry, is_return)		\
  35	((void*)(entry) + SIZEOF_TRACE_ENTRY(is_return))
  36
  37struct trace_uprobe_filter {
  38	rwlock_t		rwlock;
  39	int			nr_systemwide;
  40	struct list_head	perf_events;
  41};
  42
  43static int trace_uprobe_create(int argc, const char **argv);
  44static int trace_uprobe_show(struct seq_file *m, struct dyn_event *ev);
  45static int trace_uprobe_release(struct dyn_event *ev);
  46static bool trace_uprobe_is_busy(struct dyn_event *ev);
  47static bool trace_uprobe_match(const char *system, const char *event,
  48			int argc, const char **argv, struct dyn_event *ev);
  49
  50static struct dyn_event_operations trace_uprobe_ops = {
  51	.create = trace_uprobe_create,
  52	.show = trace_uprobe_show,
  53	.is_busy = trace_uprobe_is_busy,
  54	.free = trace_uprobe_release,
  55	.match = trace_uprobe_match,
  56};
  57
  58/*
  59 * uprobe event core functions
  60 */
  61struct trace_uprobe {
  62	struct dyn_event		devent;
  63	struct trace_uprobe_filter	filter;
  64	struct uprobe_consumer		consumer;
  65	struct path			path;
  66	struct inode			*inode;
  67	char				*filename;
 
  68	unsigned long			offset;
  69	unsigned long			ref_ctr_offset;
  70	unsigned long			nhit;
  71	struct trace_probe		tp;
  72};
  73
  74static bool is_trace_uprobe(struct dyn_event *ev)
  75{
  76	return ev->ops == &trace_uprobe_ops;
  77}
  78
  79static struct trace_uprobe *to_trace_uprobe(struct dyn_event *ev)
  80{
  81	return container_of(ev, struct trace_uprobe, devent);
  82}
  83
  84/**
  85 * for_each_trace_uprobe - iterate over the trace_uprobe list
  86 * @pos:	the struct trace_uprobe * for each entry
  87 * @dpos:	the struct dyn_event * to use as a loop cursor
  88 */
  89#define for_each_trace_uprobe(pos, dpos)	\
  90	for_each_dyn_event(dpos)		\
  91		if (is_trace_uprobe(dpos) && (pos = to_trace_uprobe(dpos)))
  92
  93#define SIZEOF_TRACE_UPROBE(n)				\
  94	(offsetof(struct trace_uprobe, tp.args) +	\
  95	(sizeof(struct probe_arg) * (n)))
  96
  97static int register_uprobe_event(struct trace_uprobe *tu);
  98static int unregister_uprobe_event(struct trace_uprobe *tu);
  99
 100struct uprobe_dispatch_data {
 101	struct trace_uprobe	*tu;
 102	unsigned long		bp_addr;
 103};
 104
 105static int uprobe_dispatcher(struct uprobe_consumer *con, struct pt_regs *regs);
 106static int uretprobe_dispatcher(struct uprobe_consumer *con,
 107				unsigned long func, struct pt_regs *regs);
 
 108
 109#ifdef CONFIG_STACK_GROWSUP
 110static unsigned long adjust_stack_addr(unsigned long addr, unsigned int n)
 111{
 112	return addr - (n * sizeof(long));
 113}
 114#else
 115static unsigned long adjust_stack_addr(unsigned long addr, unsigned int n)
 116{
 117	return addr + (n * sizeof(long));
 118}
 119#endif
 120
 121static unsigned long get_user_stack_nth(struct pt_regs *regs, unsigned int n)
 122{
 123	unsigned long ret;
 124	unsigned long addr = user_stack_pointer(regs);
 125
 126	addr = adjust_stack_addr(addr, n);
 127
 128	if (copy_from_user(&ret, (void __force __user *) addr, sizeof(ret)))
 129		return 0;
 130
 131	return ret;
 132}
 133
 134/*
 135 * Uprobes-specific fetch functions
 136 */
 137static nokprobe_inline int
 138probe_mem_read(void *dest, void *src, size_t size)
 139{
 140	void __user *vaddr = (void __force __user *)src;
 141
 142	return copy_from_user(dest, vaddr, size) ? -EFAULT : 0;
 143}
 144
 145static nokprobe_inline int
 146probe_mem_read_user(void *dest, void *src, size_t size)
 147{
 148	return probe_mem_read(dest, src, size);
 149}
 150
 151/*
 152 * Fetch a null-terminated string. Caller MUST set *(u32 *)dest with max
 153 * length and relative data location.
 154 */
 155static nokprobe_inline int
 156fetch_store_string(unsigned long addr, void *dest, void *base)
 157{
 158	long ret;
 159	u32 loc = *(u32 *)dest;
 160	int maxlen  = get_loc_len(loc);
 161	u8 *dst = get_loc_data(dest, base);
 162	void __user *src = (void __force __user *) addr;
 163
 164	if (unlikely(!maxlen))
 165		return -ENOMEM;
 166
 167	if (addr == FETCH_TOKEN_COMM)
 168		ret = strlcpy(dst, current->comm, maxlen);
 169	else
 170		ret = strncpy_from_user(dst, src, maxlen);
 171	if (ret >= 0) {
 172		if (ret == maxlen)
 173			dst[ret - 1] = '\0';
 174		else
 175			/*
 176			 * Include the terminating null byte. In this case it
 177			 * was copied by strncpy_from_user but not accounted
 178			 * for in ret.
 179			 */
 180			ret++;
 181		*(u32 *)dest = make_data_loc(ret, (void *)dst - base);
 182	}
 
 183
 184	return ret;
 185}
 186
 187static nokprobe_inline int
 188fetch_store_string_user(unsigned long addr, void *dest, void *base)
 189{
 190	return fetch_store_string(addr, dest, base);
 191}
 192
 193/* Return the length of string -- including null terminal byte */
 194static nokprobe_inline int
 195fetch_store_strlen(unsigned long addr)
 196{
 197	int len;
 198	void __user *vaddr = (void __force __user *) addr;
 199
 200	if (addr == FETCH_TOKEN_COMM)
 201		len = strlen(current->comm) + 1;
 202	else
 203		len = strnlen_user(vaddr, MAX_STRING_SIZE);
 204
 205	return (len > MAX_STRING_SIZE) ? 0 : len;
 206}
 207
 208static nokprobe_inline int
 209fetch_store_strlen_user(unsigned long addr)
 210{
 211	return fetch_store_strlen(addr);
 212}
 213
 214static unsigned long translate_user_vaddr(unsigned long file_offset)
 215{
 216	unsigned long base_addr;
 217	struct uprobe_dispatch_data *udd;
 218
 219	udd = (void *) current->utask->vaddr;
 220
 221	base_addr = udd->bp_addr - udd->tu->offset;
 222	return base_addr + file_offset;
 223}
 224
 225/* Note that we don't verify it, since the code does not come from user space */
 226static int
 227process_fetch_insn(struct fetch_insn *code, struct pt_regs *regs, void *dest,
 228		   void *base)
 229{
 
 230	unsigned long val;
 
 231
 232	/* 1st stage: get value from context */
 233	switch (code->op) {
 234	case FETCH_OP_REG:
 235		val = regs_get_register(regs, code->param);
 236		break;
 237	case FETCH_OP_STACK:
 238		val = get_user_stack_nth(regs, code->param);
 239		break;
 240	case FETCH_OP_STACKP:
 241		val = user_stack_pointer(regs);
 242		break;
 243	case FETCH_OP_RETVAL:
 244		val = regs_return_value(regs);
 245		break;
 246	case FETCH_OP_IMM:
 247		val = code->immediate;
 248		break;
 249	case FETCH_OP_COMM:
 250		val = FETCH_TOKEN_COMM;
 251		break;
 252	case FETCH_OP_DATA:
 253		val = (unsigned long)code->data;
 254		break;
 255	case FETCH_OP_FOFFS:
 256		val = translate_user_vaddr(code->immediate);
 257		break;
 258	default:
 259		return -EILSEQ;
 
 
 260	}
 261	code++;
 262
 263	return process_fetch_insn_bottom(code, val, dest, base);
 264}
 265NOKPROBE_SYMBOL(process_fetch_insn)
 266
 267static inline void init_trace_uprobe_filter(struct trace_uprobe_filter *filter)
 268{
 269	rwlock_init(&filter->rwlock);
 270	filter->nr_systemwide = 0;
 271	INIT_LIST_HEAD(&filter->perf_events);
 272}
 273
 274static inline bool uprobe_filter_is_empty(struct trace_uprobe_filter *filter)
 275{
 276	return !filter->nr_systemwide && list_empty(&filter->perf_events);
 277}
 278
 279static inline bool is_ret_probe(struct trace_uprobe *tu)
 280{
 281	return tu->consumer.ret_handler != NULL;
 282}
 283
 284static bool trace_uprobe_is_busy(struct dyn_event *ev)
 285{
 286	struct trace_uprobe *tu = to_trace_uprobe(ev);
 287
 288	return trace_probe_is_enabled(&tu->tp);
 289}
 290
 291static bool trace_uprobe_match_command_head(struct trace_uprobe *tu,
 292					    int argc, const char **argv)
 293{
 294	char buf[MAX_ARGSTR_LEN + 1];
 295	int len;
 296
 297	if (!argc)
 298		return true;
 299
 300	len = strlen(tu->filename);
 301	if (strncmp(tu->filename, argv[0], len) || argv[0][len] != ':')
 302		return false;
 303
 304	if (tu->ref_ctr_offset == 0)
 305		snprintf(buf, sizeof(buf), "0x%0*lx",
 306				(int)(sizeof(void *) * 2), tu->offset);
 307	else
 308		snprintf(buf, sizeof(buf), "0x%0*lx(0x%lx)",
 309				(int)(sizeof(void *) * 2), tu->offset,
 310				tu->ref_ctr_offset);
 311	if (strcmp(buf, &argv[0][len + 1]))
 312		return false;
 313
 314	argc--; argv++;
 315
 316	return trace_probe_match_command_args(&tu->tp, argc, argv);
 317}
 318
 319static bool trace_uprobe_match(const char *system, const char *event,
 320			int argc, const char **argv, struct dyn_event *ev)
 321{
 322	struct trace_uprobe *tu = to_trace_uprobe(ev);
 323
 324	return strcmp(trace_probe_name(&tu->tp), event) == 0 &&
 
 325	   (!system || strcmp(trace_probe_group_name(&tu->tp), system) == 0) &&
 326	   trace_uprobe_match_command_head(tu, argc, argv);
 327}
 328
 329static nokprobe_inline struct trace_uprobe *
 330trace_uprobe_primary_from_call(struct trace_event_call *call)
 331{
 332	struct trace_probe *tp;
 333
 334	tp = trace_probe_primary_from_call(call);
 335	if (WARN_ON_ONCE(!tp))
 336		return NULL;
 337
 338	return container_of(tp, struct trace_uprobe, tp);
 339}
 340
 341/*
 342 * Allocate new trace_uprobe and initialize it (including uprobes).
 343 */
 344static struct trace_uprobe *
 345alloc_trace_uprobe(const char *group, const char *event, int nargs, bool is_ret)
 346{
 347	struct trace_uprobe *tu;
 348	int ret;
 349
 350	tu = kzalloc(SIZEOF_TRACE_UPROBE(nargs), GFP_KERNEL);
 351	if (!tu)
 352		return ERR_PTR(-ENOMEM);
 353
 354	ret = trace_probe_init(&tu->tp, event, group);
 
 
 
 
 
 
 355	if (ret < 0)
 356		goto error;
 357
 358	dyn_event_init(&tu->devent, &trace_uprobe_ops);
 359	tu->consumer.handler = uprobe_dispatcher;
 360	if (is_ret)
 361		tu->consumer.ret_handler = uretprobe_dispatcher;
 362	init_trace_uprobe_filter(&tu->filter);
 363	return tu;
 364
 365error:
 
 366	kfree(tu);
 367
 368	return ERR_PTR(ret);
 369}
 370
 371static void free_trace_uprobe(struct trace_uprobe *tu)
 372{
 373	if (!tu)
 374		return;
 375
 376	path_put(&tu->path);
 377	trace_probe_cleanup(&tu->tp);
 378	kfree(tu->filename);
 
 379	kfree(tu);
 380}
 381
 382static struct trace_uprobe *find_probe_event(const char *event, const char *group)
 383{
 384	struct dyn_event *pos;
 385	struct trace_uprobe *tu;
 386
 387	for_each_trace_uprobe(tu, pos)
 388		if (strcmp(trace_probe_name(&tu->tp), event) == 0 &&
 389		    strcmp(trace_probe_group_name(&tu->tp), group) == 0)
 390			return tu;
 391
 392	return NULL;
 393}
 394
 395/* Unregister a trace_uprobe and probe_event */
 396static int unregister_trace_uprobe(struct trace_uprobe *tu)
 397{
 398	int ret;
 399
 400	if (trace_probe_has_sibling(&tu->tp))
 401		goto unreg;
 402
 
 
 
 
 403	ret = unregister_uprobe_event(tu);
 404	if (ret)
 405		return ret;
 406
 407unreg:
 408	dyn_event_remove(&tu->devent);
 409	trace_probe_unlink(&tu->tp);
 410	free_trace_uprobe(tu);
 411	return 0;
 412}
 413
 414static bool trace_uprobe_has_same_uprobe(struct trace_uprobe *orig,
 415					 struct trace_uprobe *comp)
 416{
 417	struct trace_probe_event *tpe = orig->tp.event;
 418	struct trace_probe *pos;
 419	struct inode *comp_inode = d_real_inode(comp->path.dentry);
 420	int i;
 421
 422	list_for_each_entry(pos, &tpe->probes, list) {
 423		orig = container_of(pos, struct trace_uprobe, tp);
 424		if (comp_inode != d_real_inode(orig->path.dentry) ||
 425		    comp->offset != orig->offset)
 426			continue;
 427
 428		/*
 429		 * trace_probe_compare_arg_type() ensured that nr_args and
 430		 * each argument name and type are same. Let's compare comm.
 431		 */
 432		for (i = 0; i < orig->tp.nr_args; i++) {
 433			if (strcmp(orig->tp.args[i].comm,
 434				   comp->tp.args[i].comm))
 435				break;
 436		}
 437
 438		if (i == orig->tp.nr_args)
 439			return true;
 440	}
 441
 442	return false;
 443}
 444
 445static int append_trace_uprobe(struct trace_uprobe *tu, struct trace_uprobe *to)
 446{
 447	int ret;
 448
 449	ret = trace_probe_compare_arg_type(&tu->tp, &to->tp);
 450	if (ret) {
 451		/* Note that argument starts index = 2 */
 452		trace_probe_log_set_index(ret + 1);
 453		trace_probe_log_err(0, DIFF_ARG_TYPE);
 454		return -EEXIST;
 455	}
 456	if (trace_uprobe_has_same_uprobe(to, tu)) {
 457		trace_probe_log_set_index(0);
 458		trace_probe_log_err(0, SAME_PROBE);
 459		return -EEXIST;
 460	}
 461
 462	/* Append to existing event */
 463	ret = trace_probe_append(&tu->tp, &to->tp);
 464	if (!ret)
 465		dyn_event_add(&tu->devent);
 466
 467	return ret;
 468}
 469
 470/*
 471 * Uprobe with multiple reference counter is not allowed. i.e.
 472 * If inode and offset matches, reference counter offset *must*
 473 * match as well. Though, there is one exception: If user is
 474 * replacing old trace_uprobe with new one(same group/event),
 475 * then we allow same uprobe with new reference counter as far
 476 * as the new one does not conflict with any other existing
 477 * ones.
 478 */
 479static int validate_ref_ctr_offset(struct trace_uprobe *new)
 480{
 481	struct dyn_event *pos;
 482	struct trace_uprobe *tmp;
 483	struct inode *new_inode = d_real_inode(new->path.dentry);
 484
 485	for_each_trace_uprobe(tmp, pos) {
 486		if (new_inode == d_real_inode(tmp->path.dentry) &&
 487		    new->offset == tmp->offset &&
 488		    new->ref_ctr_offset != tmp->ref_ctr_offset) {
 489			pr_warn("Reference counter offset mismatch.");
 490			return -EINVAL;
 491		}
 492	}
 493	return 0;
 494}
 495
 496/* Register a trace_uprobe and probe_event */
 497static int register_trace_uprobe(struct trace_uprobe *tu)
 498{
 499	struct trace_uprobe *old_tu;
 500	int ret;
 501
 502	mutex_lock(&event_mutex);
 503
 504	ret = validate_ref_ctr_offset(tu);
 505	if (ret)
 506		goto end;
 507
 508	/* register as an event */
 509	old_tu = find_probe_event(trace_probe_name(&tu->tp),
 510				  trace_probe_group_name(&tu->tp));
 511	if (old_tu) {
 512		if (is_ret_probe(tu) != is_ret_probe(old_tu)) {
 513			trace_probe_log_set_index(0);
 514			trace_probe_log_err(0, DIFF_PROBE_TYPE);
 515			ret = -EEXIST;
 516		} else {
 517			ret = append_trace_uprobe(tu, old_tu);
 518		}
 519		goto end;
 520	}
 521
 522	ret = register_uprobe_event(tu);
 523	if (ret) {
 524		pr_warn("Failed to register probe event(%d)\n", ret);
 
 
 
 
 525		goto end;
 526	}
 527
 528	dyn_event_add(&tu->devent);
 529
 530end:
 531	mutex_unlock(&event_mutex);
 532
 533	return ret;
 534}
 535
 536/*
 537 * Argument syntax:
 538 *  - Add uprobe: p|r[:[GRP/]EVENT] PATH:OFFSET [FETCHARGS]
 539 */
 540static int trace_uprobe_create(int argc, const char **argv)
 541{
 542	struct trace_uprobe *tu;
 543	const char *event = NULL, *group = UPROBE_EVENT_SYSTEM;
 544	char *arg, *filename, *rctr, *rctr_end, *tmp;
 545	char buf[MAX_EVENT_NAME_LEN];
 
 
 546	struct path path;
 547	unsigned long offset, ref_ctr_offset;
 548	bool is_return = false;
 549	int i, ret;
 550
 551	ret = 0;
 552	ref_ctr_offset = 0;
 553
 554	switch (argv[0][0]) {
 555	case 'r':
 556		is_return = true;
 557		break;
 558	case 'p':
 559		break;
 560	default:
 561		return -ECANCELED;
 562	}
 563
 564	if (argc < 2)
 565		return -ECANCELED;
 
 
 566
 567	if (argv[0][1] == ':')
 568		event = &argv[0][2];
 569
 570	if (!strchr(argv[1], '/'))
 571		return -ECANCELED;
 572
 573	filename = kstrdup(argv[1], GFP_KERNEL);
 574	if (!filename)
 575		return -ENOMEM;
 576
 577	/* Find the last occurrence, in case the path contains ':' too. */
 578	arg = strrchr(filename, ':');
 579	if (!arg || !isdigit(arg[1])) {
 580		kfree(filename);
 581		return -ECANCELED;
 582	}
 583
 584	trace_probe_log_init("trace_uprobe", argc, argv);
 585	trace_probe_log_set_index(1);	/* filename is the 2nd argument */
 586
 587	*arg++ = '\0';
 588	ret = kern_path(filename, LOOKUP_FOLLOW, &path);
 589	if (ret) {
 590		trace_probe_log_err(0, FILE_NOT_FOUND);
 591		kfree(filename);
 592		trace_probe_log_clear();
 593		return ret;
 594	}
 595	if (!d_is_reg(path.dentry)) {
 596		trace_probe_log_err(0, NO_REGULAR_FILE);
 597		ret = -EINVAL;
 598		goto fail_address_parse;
 599	}
 600
 601	/* Parse reference counter offset if specified. */
 602	rctr = strchr(arg, '(');
 603	if (rctr) {
 604		rctr_end = strchr(rctr, ')');
 605		if (!rctr_end) {
 606			ret = -EINVAL;
 607			rctr_end = rctr + strlen(rctr);
 608			trace_probe_log_err(rctr_end - filename,
 609					    REFCNT_OPEN_BRACE);
 610			goto fail_address_parse;
 611		} else if (rctr_end[1] != '\0') {
 612			ret = -EINVAL;
 613			trace_probe_log_err(rctr_end + 1 - filename,
 614					    BAD_REFCNT_SUFFIX);
 615			goto fail_address_parse;
 616		}
 617
 618		*rctr++ = '\0';
 619		*rctr_end = '\0';
 620		ret = kstrtoul(rctr, 0, &ref_ctr_offset);
 621		if (ret) {
 622			trace_probe_log_err(rctr - filename, BAD_REFCNT);
 623			goto fail_address_parse;
 624		}
 625	}
 626
 
 
 
 
 
 
 
 
 
 
 
 
 
 627	/* Parse uprobe offset. */
 628	ret = kstrtoul(arg, 0, &offset);
 629	if (ret) {
 630		trace_probe_log_err(arg - filename, BAD_UPROBE_OFFS);
 631		goto fail_address_parse;
 632	}
 633
 634	/* setup a probe */
 635	trace_probe_log_set_index(0);
 636	if (event) {
 637		ret = traceprobe_parse_event_name(&event, &group, buf,
 638						  event - argv[0]);
 639		if (ret)
 640			goto fail_address_parse;
 641	} else {
 
 
 642		char *tail;
 643		char *ptr;
 644
 645		tail = kstrdup(kbasename(filename), GFP_KERNEL);
 646		if (!tail) {
 647			ret = -ENOMEM;
 648			goto fail_address_parse;
 649		}
 650
 651		ptr = strpbrk(tail, ".-_");
 652		if (ptr)
 653			*ptr = '\0';
 654
 655		snprintf(buf, MAX_EVENT_NAME_LEN, "%c_%s_0x%lx", 'p', tail, offset);
 656		event = buf;
 657		kfree(tail);
 658	}
 659
 660	argc -= 2;
 661	argv += 2;
 662
 663	tu = alloc_trace_uprobe(group, event, argc, is_return);
 664	if (IS_ERR(tu)) {
 665		ret = PTR_ERR(tu);
 666		/* This must return -ENOMEM otherwise there is a bug */
 667		WARN_ON_ONCE(ret != -ENOMEM);
 668		goto fail_address_parse;
 669	}
 670	tu->offset = offset;
 671	tu->ref_ctr_offset = ref_ctr_offset;
 672	tu->path = path;
 673	tu->filename = filename;
 674
 675	/* parse arguments */
 676	for (i = 0; i < argc && i < MAX_TRACE_ARGS; i++) {
 677		tmp = kstrdup(argv[i], GFP_KERNEL);
 678		if (!tmp) {
 679			ret = -ENOMEM;
 680			goto error;
 681		}
 682
 683		trace_probe_log_set_index(i + 2);
 684		ret = traceprobe_parse_probe_arg(&tu->tp, i, tmp,
 685					is_return ? TPARG_FL_RETURN : 0);
 686		kfree(tmp);
 687		if (ret)
 688			goto error;
 689	}
 690
 691	ret = traceprobe_set_print_fmt(&tu->tp, is_ret_probe(tu));
 
 692	if (ret < 0)
 693		goto error;
 694
 695	ret = register_trace_uprobe(tu);
 696	if (!ret)
 697		goto out;
 698
 699error:
 700	free_trace_uprobe(tu);
 701out:
 702	trace_probe_log_clear();
 703	return ret;
 704
 705fail_address_parse:
 706	trace_probe_log_clear();
 707	path_put(&path);
 708	kfree(filename);
 709
 710	return ret;
 711}
 712
 713static int create_or_delete_trace_uprobe(int argc, char **argv)
 
 
 
 
 
 714{
 715	int ret;
 716
 717	if (argv[0][0] == '-')
 718		return dyn_event_release(argc, argv, &trace_uprobe_ops);
 719
 720	ret = trace_uprobe_create(argc, (const char **)argv);
 721	return ret == -ECANCELED ? -EINVAL : ret;
 722}
 723
 724static int trace_uprobe_release(struct dyn_event *ev)
 725{
 726	struct trace_uprobe *tu = to_trace_uprobe(ev);
 727
 728	return unregister_trace_uprobe(tu);
 729}
 730
 731/* Probes listing interfaces */
 732static int trace_uprobe_show(struct seq_file *m, struct dyn_event *ev)
 733{
 734	struct trace_uprobe *tu = to_trace_uprobe(ev);
 735	char c = is_ret_probe(tu) ? 'r' : 'p';
 736	int i;
 737
 738	seq_printf(m, "%c:%s/%s %s:0x%0*lx", c, trace_probe_group_name(&tu->tp),
 739			trace_probe_name(&tu->tp), tu->filename,
 740			(int)(sizeof(void *) * 2), tu->offset);
 741
 742	if (tu->ref_ctr_offset)
 743		seq_printf(m, "(0x%lx)", tu->ref_ctr_offset);
 744
 745	for (i = 0; i < tu->tp.nr_args; i++)
 746		seq_printf(m, " %s=%s", tu->tp.args[i].name, tu->tp.args[i].comm);
 747
 748	seq_putc(m, '\n');
 749	return 0;
 750}
 751
 752static int probes_seq_show(struct seq_file *m, void *v)
 753{
 754	struct dyn_event *ev = v;
 755
 756	if (!is_trace_uprobe(ev))
 757		return 0;
 758
 759	return trace_uprobe_show(m, ev);
 760}
 761
 762static const struct seq_operations probes_seq_op = {
 763	.start  = dyn_event_seq_start,
 764	.next   = dyn_event_seq_next,
 765	.stop   = dyn_event_seq_stop,
 766	.show   = probes_seq_show
 767};
 768
 769static int probes_open(struct inode *inode, struct file *file)
 770{
 771	int ret;
 772
 773	ret = security_locked_down(LOCKDOWN_TRACEFS);
 774	if (ret)
 775		return ret;
 776
 777	if ((file->f_mode & FMODE_WRITE) && (file->f_flags & O_TRUNC)) {
 778		ret = dyn_events_release_all(&trace_uprobe_ops);
 779		if (ret)
 780			return ret;
 781	}
 782
 783	return seq_open(file, &probes_seq_op);
 784}
 785
 786static ssize_t probes_write(struct file *file, const char __user *buffer,
 787			    size_t count, loff_t *ppos)
 788{
 789	return trace_parse_run_command(file, buffer, count, ppos,
 790					create_or_delete_trace_uprobe);
 791}
 792
 793static const struct file_operations uprobe_events_ops = {
 794	.owner		= THIS_MODULE,
 795	.open		= probes_open,
 796	.read		= seq_read,
 797	.llseek		= seq_lseek,
 798	.release	= seq_release,
 799	.write		= probes_write,
 800};
 801
 802/* Probes profiling interfaces */
 803static int probes_profile_seq_show(struct seq_file *m, void *v)
 804{
 805	struct dyn_event *ev = v;
 806	struct trace_uprobe *tu;
 
 
 807
 808	if (!is_trace_uprobe(ev))
 809		return 0;
 810
 811	tu = to_trace_uprobe(ev);
 
 
 
 
 
 
 812	seq_printf(m, "  %s %-44s %15lu\n", tu->filename,
 813			trace_probe_name(&tu->tp), tu->nhit);
 814	return 0;
 815}
 816
 817static const struct seq_operations profile_seq_op = {
 818	.start  = dyn_event_seq_start,
 819	.next   = dyn_event_seq_next,
 820	.stop   = dyn_event_seq_stop,
 821	.show	= probes_profile_seq_show
 822};
 823
 824static int profile_open(struct inode *inode, struct file *file)
 825{
 826	int ret;
 827
 828	ret = security_locked_down(LOCKDOWN_TRACEFS);
 829	if (ret)
 830		return ret;
 831
 832	return seq_open(file, &profile_seq_op);
 833}
 834
 835static const struct file_operations uprobe_profile_ops = {
 836	.owner		= THIS_MODULE,
 837	.open		= profile_open,
 838	.read		= seq_read,
 839	.llseek		= seq_lseek,
 840	.release	= seq_release,
 841};
 842
 843struct uprobe_cpu_buffer {
 844	struct mutex mutex;
 845	void *buf;
 
 846};
 847static struct uprobe_cpu_buffer __percpu *uprobe_cpu_buffer;
 848static int uprobe_buffer_refcnt;
 
 849
 850static int uprobe_buffer_init(void)
 851{
 852	int cpu, err_cpu;
 853
 854	uprobe_cpu_buffer = alloc_percpu(struct uprobe_cpu_buffer);
 855	if (uprobe_cpu_buffer == NULL)
 856		return -ENOMEM;
 857
 858	for_each_possible_cpu(cpu) {
 859		struct page *p = alloc_pages_node(cpu_to_node(cpu),
 860						  GFP_KERNEL, 0);
 861		if (p == NULL) {
 862			err_cpu = cpu;
 863			goto err;
 864		}
 865		per_cpu_ptr(uprobe_cpu_buffer, cpu)->buf = page_address(p);
 866		mutex_init(&per_cpu_ptr(uprobe_cpu_buffer, cpu)->mutex);
 867	}
 868
 869	return 0;
 870
 871err:
 872	for_each_possible_cpu(cpu) {
 873		if (cpu == err_cpu)
 874			break;
 875		free_page((unsigned long)per_cpu_ptr(uprobe_cpu_buffer, cpu)->buf);
 876	}
 877
 878	free_percpu(uprobe_cpu_buffer);
 879	return -ENOMEM;
 880}
 881
 882static int uprobe_buffer_enable(void)
 883{
 884	int ret = 0;
 885
 886	BUG_ON(!mutex_is_locked(&event_mutex));
 887
 888	if (uprobe_buffer_refcnt++ == 0) {
 889		ret = uprobe_buffer_init();
 890		if (ret < 0)
 891			uprobe_buffer_refcnt--;
 892	}
 893
 894	return ret;
 895}
 896
 897static void uprobe_buffer_disable(void)
 898{
 899	int cpu;
 900
 901	BUG_ON(!mutex_is_locked(&event_mutex));
 902
 903	if (--uprobe_buffer_refcnt == 0) {
 904		for_each_possible_cpu(cpu)
 905			free_page((unsigned long)per_cpu_ptr(uprobe_cpu_buffer,
 906							     cpu)->buf);
 907
 908		free_percpu(uprobe_cpu_buffer);
 909		uprobe_cpu_buffer = NULL;
 910	}
 911}
 912
 913static struct uprobe_cpu_buffer *uprobe_buffer_get(void)
 914{
 915	struct uprobe_cpu_buffer *ucb;
 916	int cpu;
 917
 918	cpu = raw_smp_processor_id();
 919	ucb = per_cpu_ptr(uprobe_cpu_buffer, cpu);
 920
 921	/*
 922	 * Use per-cpu buffers for fastest access, but we might migrate
 923	 * so the mutex makes sure we have sole access to it.
 924	 */
 925	mutex_lock(&ucb->mutex);
 926
 927	return ucb;
 928}
 929
 930static void uprobe_buffer_put(struct uprobe_cpu_buffer *ucb)
 931{
 
 
 932	mutex_unlock(&ucb->mutex);
 933}
 934
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 935static void __uprobe_trace_func(struct trace_uprobe *tu,
 936				unsigned long func, struct pt_regs *regs,
 937				struct uprobe_cpu_buffer *ucb, int dsize,
 938				struct trace_event_file *trace_file)
 939{
 940	struct uprobe_trace_entry_head *entry;
 941	struct ring_buffer_event *event;
 942	struct ring_buffer *buffer;
 943	void *data;
 944	int size, esize;
 945	struct trace_event_call *call = trace_probe_event_call(&tu->tp);
 946
 947	WARN_ON(call != trace_file->event_call);
 948
 949	if (WARN_ON_ONCE(tu->tp.size + dsize > PAGE_SIZE))
 950		return;
 951
 952	if (trace_trigger_soft_disabled(trace_file))
 953		return;
 954
 955	esize = SIZEOF_TRACE_ENTRY(is_ret_probe(tu));
 956	size = esize + tu->tp.size + dsize;
 957	event = trace_event_buffer_lock_reserve(&buffer, trace_file,
 958						call->event.type, size, 0, 0);
 959	if (!event)
 960		return;
 961
 962	entry = ring_buffer_event_data(event);
 963	if (is_ret_probe(tu)) {
 964		entry->vaddr[0] = func;
 965		entry->vaddr[1] = instruction_pointer(regs);
 966		data = DATAOF_TRACE_ENTRY(entry, true);
 967	} else {
 968		entry->vaddr[0] = instruction_pointer(regs);
 969		data = DATAOF_TRACE_ENTRY(entry, false);
 970	}
 971
 972	memcpy(data, ucb->buf, tu->tp.size + dsize);
 973
 974	event_trigger_unlock_commit(trace_file, buffer, event, entry, 0, 0);
 975}
 976
 977/* uprobe handler */
 978static int uprobe_trace_func(struct trace_uprobe *tu, struct pt_regs *regs,
 979			     struct uprobe_cpu_buffer *ucb, int dsize)
 980{
 981	struct event_file_link *link;
 
 982
 983	if (is_ret_probe(tu))
 984		return 0;
 985
 
 
 986	rcu_read_lock();
 987	trace_probe_for_each_link_rcu(link, &tu->tp)
 988		__uprobe_trace_func(tu, 0, regs, ucb, dsize, link->file);
 989	rcu_read_unlock();
 990
 991	return 0;
 992}
 993
 994static void uretprobe_trace_func(struct trace_uprobe *tu, unsigned long func,
 995				 struct pt_regs *regs,
 996				 struct uprobe_cpu_buffer *ucb, int dsize)
 997{
 998	struct event_file_link *link;
 
 
 
 999
1000	rcu_read_lock();
1001	trace_probe_for_each_link_rcu(link, &tu->tp)
1002		__uprobe_trace_func(tu, func, regs, ucb, dsize, link->file);
1003	rcu_read_unlock();
1004}
1005
1006/* Event entry printers */
1007static enum print_line_t
1008print_uprobe_event(struct trace_iterator *iter, int flags, struct trace_event *event)
1009{
1010	struct uprobe_trace_entry_head *entry;
1011	struct trace_seq *s = &iter->seq;
1012	struct trace_uprobe *tu;
1013	u8 *data;
1014
1015	entry = (struct uprobe_trace_entry_head *)iter->ent;
1016	tu = trace_uprobe_primary_from_call(
1017		container_of(event, struct trace_event_call, event));
1018	if (unlikely(!tu))
1019		goto out;
1020
1021	if (is_ret_probe(tu)) {
1022		trace_seq_printf(s, "%s: (0x%lx <- 0x%lx)",
1023				 trace_probe_name(&tu->tp),
1024				 entry->vaddr[1], entry->vaddr[0]);
1025		data = DATAOF_TRACE_ENTRY(entry, true);
1026	} else {
1027		trace_seq_printf(s, "%s: (0x%lx)",
1028				 trace_probe_name(&tu->tp),
1029				 entry->vaddr[0]);
1030		data = DATAOF_TRACE_ENTRY(entry, false);
1031	}
1032
1033	if (print_probe_args(s, tu->tp.args, tu->tp.nr_args, data, entry) < 0)
1034		goto out;
1035
1036	trace_seq_putc(s, '\n');
1037
1038 out:
1039	return trace_handle_return(s);
1040}
1041
1042typedef bool (*filter_func_t)(struct uprobe_consumer *self,
1043				enum uprobe_filter_ctx ctx,
1044				struct mm_struct *mm);
1045
1046static int trace_uprobe_enable(struct trace_uprobe *tu, filter_func_t filter)
1047{
1048	int ret;
 
1049
1050	tu->consumer.filter = filter;
1051	tu->inode = d_real_inode(tu->path.dentry);
1052
1053	if (tu->ref_ctr_offset)
1054		ret = uprobe_register_refctr(tu->inode, tu->offset,
1055				tu->ref_ctr_offset, &tu->consumer);
1056	else
1057		ret = uprobe_register(tu->inode, tu->offset, &tu->consumer);
1058
1059	if (ret)
1060		tu->inode = NULL;
1061
1062	return ret;
 
1063}
1064
1065static void __probe_event_disable(struct trace_probe *tp)
1066{
1067	struct trace_probe *pos;
1068	struct trace_uprobe *tu;
 
1069
1070	list_for_each_entry(pos, trace_probe_probe_list(tp), list) {
1071		tu = container_of(pos, struct trace_uprobe, tp);
1072		if (!tu->inode)
1073			continue;
1074
1075		WARN_ON(!uprobe_filter_is_empty(&tu->filter));
 
 
1076
1077		uprobe_unregister(tu->inode, tu->offset, &tu->consumer);
1078		tu->inode = NULL;
 
1079	}
 
 
1080}
1081
1082static int probe_event_enable(struct trace_event_call *call,
1083			struct trace_event_file *file, filter_func_t filter)
1084{
1085	struct trace_probe *pos, *tp;
1086	struct trace_uprobe *tu;
1087	bool enabled;
1088	int ret;
1089
1090	tp = trace_probe_primary_from_call(call);
1091	if (WARN_ON_ONCE(!tp))
1092		return -ENODEV;
1093	enabled = trace_probe_is_enabled(tp);
1094
1095	/* This may also change "enabled" state */
1096	if (file) {
1097		if (trace_probe_test_flag(tp, TP_FLAG_PROFILE))
1098			return -EINTR;
1099
1100		ret = trace_probe_add_file(tp, file);
1101		if (ret < 0)
1102			return ret;
1103	} else {
1104		if (trace_probe_test_flag(tp, TP_FLAG_TRACE))
1105			return -EINTR;
1106
1107		trace_probe_set_flag(tp, TP_FLAG_PROFILE);
1108	}
1109
1110	tu = container_of(tp, struct trace_uprobe, tp);
1111	WARN_ON(!uprobe_filter_is_empty(&tu->filter));
1112
1113	if (enabled)
1114		return 0;
1115
1116	ret = uprobe_buffer_enable();
1117	if (ret)
1118		goto err_flags;
1119
1120	list_for_each_entry(pos, trace_probe_probe_list(tp), list) {
1121		tu = container_of(pos, struct trace_uprobe, tp);
1122		ret = trace_uprobe_enable(tu, filter);
1123		if (ret) {
1124			__probe_event_disable(tp);
1125			goto err_buffer;
1126		}
1127	}
1128
1129	return 0;
1130
1131 err_buffer:
1132	uprobe_buffer_disable();
1133
1134 err_flags:
1135	if (file)
1136		trace_probe_remove_file(tp, file);
1137	else
1138		trace_probe_clear_flag(tp, TP_FLAG_PROFILE);
1139
1140	return ret;
1141}
1142
1143static void probe_event_disable(struct trace_event_call *call,
1144				struct trace_event_file *file)
1145{
1146	struct trace_probe *tp;
1147
1148	tp = trace_probe_primary_from_call(call);
1149	if (WARN_ON_ONCE(!tp))
1150		return;
1151
1152	if (!trace_probe_is_enabled(tp))
1153		return;
1154
1155	if (file) {
1156		if (trace_probe_remove_file(tp, file) < 0)
1157			return;
1158
1159		if (trace_probe_is_enabled(tp))
1160			return;
1161	} else
1162		trace_probe_clear_flag(tp, TP_FLAG_PROFILE);
1163
1164	__probe_event_disable(tp);
1165	uprobe_buffer_disable();
1166}
1167
1168static int uprobe_event_define_fields(struct trace_event_call *event_call)
1169{
1170	int ret, size;
1171	struct uprobe_trace_entry_head field;
1172	struct trace_uprobe *tu;
1173
1174	tu = trace_uprobe_primary_from_call(event_call);
1175	if (unlikely(!tu))
1176		return -ENODEV;
1177
1178	if (is_ret_probe(tu)) {
1179		DEFINE_FIELD(unsigned long, vaddr[0], FIELD_STRING_FUNC, 0);
1180		DEFINE_FIELD(unsigned long, vaddr[1], FIELD_STRING_RETIP, 0);
1181		size = SIZEOF_TRACE_ENTRY(true);
1182	} else {
1183		DEFINE_FIELD(unsigned long, vaddr[0], FIELD_STRING_IP, 0);
1184		size = SIZEOF_TRACE_ENTRY(false);
1185	}
1186
1187	return traceprobe_define_arg_fields(event_call, size, &tu->tp);
1188}
1189
1190#ifdef CONFIG_PERF_EVENTS
1191static bool
1192__uprobe_perf_filter(struct trace_uprobe_filter *filter, struct mm_struct *mm)
1193{
1194	struct perf_event *event;
1195
1196	if (filter->nr_systemwide)
1197		return true;
1198
1199	list_for_each_entry(event, &filter->perf_events, hw.tp_list) {
1200		if (event->hw.target->mm == mm)
1201			return true;
1202	}
1203
1204	return false;
1205}
1206
1207static inline bool
1208uprobe_filter_event(struct trace_uprobe *tu, struct perf_event *event)
 
1209{
1210	return __uprobe_perf_filter(&tu->filter, event->hw.target->mm);
1211}
1212
1213static int uprobe_perf_close(struct trace_uprobe *tu, struct perf_event *event)
 
1214{
1215	bool done;
1216
1217	write_lock(&tu->filter.rwlock);
1218	if (event->hw.target) {
1219		list_del(&event->hw.tp_list);
1220		done = tu->filter.nr_systemwide ||
1221			(event->hw.target->flags & PF_EXITING) ||
1222			uprobe_filter_event(tu, event);
1223	} else {
1224		tu->filter.nr_systemwide--;
1225		done = tu->filter.nr_systemwide;
1226	}
1227	write_unlock(&tu->filter.rwlock);
1228
1229	if (!done)
1230		return uprobe_apply(tu->inode, tu->offset, &tu->consumer, false);
1231
1232	return 0;
1233}
1234
1235static int uprobe_perf_open(struct trace_uprobe *tu, struct perf_event *event)
 
 
1236{
1237	bool done;
1238	int err;
1239
1240	write_lock(&tu->filter.rwlock);
1241	if (event->hw.target) {
1242		/*
1243		 * event->parent != NULL means copy_process(), we can avoid
1244		 * uprobe_apply(). current->mm must be probed and we can rely
1245		 * on dup_mmap() which preserves the already installed bp's.
1246		 *
1247		 * attr.enable_on_exec means that exec/mmap will install the
1248		 * breakpoints we need.
1249		 */
1250		done = tu->filter.nr_systemwide ||
1251			event->parent || event->attr.enable_on_exec ||
1252			uprobe_filter_event(tu, event);
1253		list_add(&event->hw.tp_list, &tu->filter.perf_events);
1254	} else {
1255		done = tu->filter.nr_systemwide;
1256		tu->filter.nr_systemwide++;
1257	}
1258	write_unlock(&tu->filter.rwlock);
1259
1260	err = 0;
1261	if (!done) {
1262		err = uprobe_apply(tu->inode, tu->offset, &tu->consumer, true);
1263		if (err)
1264			uprobe_perf_close(tu, event);
1265	}
1266	return err;
1267}
1268
1269static int uprobe_perf_multi_call(struct trace_event_call *call,
1270				  struct perf_event *event,
1271		int (*op)(struct trace_uprobe *tu, struct perf_event *event))
1272{
1273	struct trace_probe *pos, *tp;
1274	struct trace_uprobe *tu;
1275	int ret = 0;
1276
1277	tp = trace_probe_primary_from_call(call);
1278	if (WARN_ON_ONCE(!tp))
1279		return -ENODEV;
1280
1281	list_for_each_entry(pos, trace_probe_probe_list(tp), list) {
1282		tu = container_of(pos, struct trace_uprobe, tp);
1283		ret = op(tu, event);
 
 
 
1284		if (ret)
1285			break;
1286	}
1287
1288	return ret;
1289}
1290static bool uprobe_perf_filter(struct uprobe_consumer *uc,
1291				enum uprobe_filter_ctx ctx, struct mm_struct *mm)
 
1292{
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1293	struct trace_uprobe *tu;
1294	int ret;
1295
1296	tu = container_of(uc, struct trace_uprobe, consumer);
1297	read_lock(&tu->filter.rwlock);
1298	ret = __uprobe_perf_filter(&tu->filter, mm);
1299	read_unlock(&tu->filter.rwlock);
 
 
 
 
 
 
 
 
 
1300
1301	return ret;
1302}
1303
1304static void __uprobe_perf_func(struct trace_uprobe *tu,
1305			       unsigned long func, struct pt_regs *regs,
1306			       struct uprobe_cpu_buffer *ucb, int dsize)
1307{
1308	struct trace_event_call *call = trace_probe_event_call(&tu->tp);
1309	struct uprobe_trace_entry_head *entry;
 
1310	struct hlist_head *head;
1311	void *data;
1312	int size, esize;
1313	int rctx;
1314
1315	if (bpf_prog_array_valid(call) && !trace_call_bpf(call, regs))
1316		return;
 
 
 
 
 
 
 
 
 
 
 
1317
1318	esize = SIZEOF_TRACE_ENTRY(is_ret_probe(tu));
1319
1320	size = esize + tu->tp.size + dsize;
 
1321	size = ALIGN(size + sizeof(u32), sizeof(u64)) - sizeof(u32);
1322	if (WARN_ONCE(size > PERF_MAX_TRACE_SIZE, "profile buffer not large enough"))
1323		return;
1324
1325	preempt_disable();
1326	head = this_cpu_ptr(call->perf_events);
1327	if (hlist_empty(head))
1328		goto out;
1329
1330	entry = perf_trace_buf_alloc(size, NULL, &rctx);
1331	if (!entry)
1332		goto out;
1333
1334	if (is_ret_probe(tu)) {
1335		entry->vaddr[0] = func;
1336		entry->vaddr[1] = instruction_pointer(regs);
1337		data = DATAOF_TRACE_ENTRY(entry, true);
1338	} else {
1339		entry->vaddr[0] = instruction_pointer(regs);
1340		data = DATAOF_TRACE_ENTRY(entry, false);
1341	}
1342
1343	memcpy(data, ucb->buf, tu->tp.size + dsize);
1344
1345	if (size - esize > tu->tp.size + dsize) {
1346		int len = tu->tp.size + dsize;
1347
1348		memset(data + len, 0, size - esize - len);
1349	}
1350
1351	perf_trace_buf_submit(entry, size, rctx, call->event.type, 1, regs,
1352			      head, NULL);
1353 out:
1354	preempt_enable();
1355}
1356
1357/* uprobe profile handler */
1358static int uprobe_perf_func(struct trace_uprobe *tu, struct pt_regs *regs,
1359			    struct uprobe_cpu_buffer *ucb, int dsize)
1360{
1361	if (!uprobe_perf_filter(&tu->consumer, 0, current->mm))
1362		return UPROBE_HANDLER_REMOVE;
1363
1364	if (!is_ret_probe(tu))
1365		__uprobe_perf_func(tu, 0, regs, ucb, dsize);
1366	return 0;
1367}
1368
1369static void uretprobe_perf_func(struct trace_uprobe *tu, unsigned long func,
1370				struct pt_regs *regs,
1371				struct uprobe_cpu_buffer *ucb, int dsize)
1372{
1373	__uprobe_perf_func(tu, func, regs, ucb, dsize);
1374}
1375
1376int bpf_get_uprobe_info(const struct perf_event *event, u32 *fd_type,
1377			const char **filename, u64 *probe_offset,
1378			bool perf_type_tracepoint)
1379{
1380	const char *pevent = trace_event_name(event->tp_event);
1381	const char *group = event->tp_event->class->system;
1382	struct trace_uprobe *tu;
1383
1384	if (perf_type_tracepoint)
1385		tu = find_probe_event(pevent, group);
1386	else
1387		tu = event->tp_event->data;
1388	if (!tu)
1389		return -EINVAL;
1390
1391	*fd_type = is_ret_probe(tu) ? BPF_FD_TYPE_URETPROBE
1392				    : BPF_FD_TYPE_UPROBE;
1393	*filename = tu->filename;
1394	*probe_offset = tu->offset;
 
1395	return 0;
1396}
1397#endif	/* CONFIG_PERF_EVENTS */
1398
1399static int
1400trace_uprobe_register(struct trace_event_call *event, enum trace_reg type,
1401		      void *data)
1402{
1403	struct trace_event_file *file = data;
1404
1405	switch (type) {
1406	case TRACE_REG_REGISTER:
1407		return probe_event_enable(event, file, NULL);
1408
1409	case TRACE_REG_UNREGISTER:
1410		probe_event_disable(event, file);
1411		return 0;
1412
1413#ifdef CONFIG_PERF_EVENTS
1414	case TRACE_REG_PERF_REGISTER:
1415		return probe_event_enable(event, NULL, uprobe_perf_filter);
1416
1417	case TRACE_REG_PERF_UNREGISTER:
1418		probe_event_disable(event, NULL);
1419		return 0;
1420
1421	case TRACE_REG_PERF_OPEN:
1422		return uprobe_perf_multi_call(event, data, uprobe_perf_open);
1423
1424	case TRACE_REG_PERF_CLOSE:
1425		return uprobe_perf_multi_call(event, data, uprobe_perf_close);
1426
1427#endif
1428	default:
1429		return 0;
1430	}
1431	return 0;
1432}
1433
1434static int uprobe_dispatcher(struct uprobe_consumer *con, struct pt_regs *regs)
 
1435{
1436	struct trace_uprobe *tu;
1437	struct uprobe_dispatch_data udd;
1438	struct uprobe_cpu_buffer *ucb;
1439	int dsize, esize;
1440	int ret = 0;
1441
1442
1443	tu = container_of(con, struct trace_uprobe, consumer);
1444	tu->nhit++;
 
1445
1446	udd.tu = tu;
1447	udd.bp_addr = instruction_pointer(regs);
1448
1449	current->utask->vaddr = (unsigned long) &udd;
1450
1451	if (WARN_ON_ONCE(!uprobe_cpu_buffer))
1452		return 0;
1453
1454	dsize = __get_data_size(&tu->tp, regs);
1455	esize = SIZEOF_TRACE_ENTRY(is_ret_probe(tu));
1456
1457	ucb = uprobe_buffer_get();
1458	store_trace_args(ucb->buf, &tu->tp, regs, esize, dsize);
1459
1460	if (trace_probe_test_flag(&tu->tp, TP_FLAG_TRACE))
1461		ret |= uprobe_trace_func(tu, regs, ucb, dsize);
1462
1463#ifdef CONFIG_PERF_EVENTS
1464	if (trace_probe_test_flag(&tu->tp, TP_FLAG_PROFILE))
1465		ret |= uprobe_perf_func(tu, regs, ucb, dsize);
1466#endif
1467	uprobe_buffer_put(ucb);
1468	return ret;
1469}
1470
1471static int uretprobe_dispatcher(struct uprobe_consumer *con,
1472				unsigned long func, struct pt_regs *regs)
 
1473{
1474	struct trace_uprobe *tu;
1475	struct uprobe_dispatch_data udd;
1476	struct uprobe_cpu_buffer *ucb;
1477	int dsize, esize;
1478
1479	tu = container_of(con, struct trace_uprobe, consumer);
1480
1481	udd.tu = tu;
1482	udd.bp_addr = func;
1483
1484	current->utask->vaddr = (unsigned long) &udd;
1485
1486	if (WARN_ON_ONCE(!uprobe_cpu_buffer))
1487		return 0;
1488
1489	dsize = __get_data_size(&tu->tp, regs);
1490	esize = SIZEOF_TRACE_ENTRY(is_ret_probe(tu));
1491
1492	ucb = uprobe_buffer_get();
1493	store_trace_args(ucb->buf, &tu->tp, regs, esize, dsize);
1494
1495	if (trace_probe_test_flag(&tu->tp, TP_FLAG_TRACE))
1496		uretprobe_trace_func(tu, func, regs, ucb, dsize);
1497
1498#ifdef CONFIG_PERF_EVENTS
1499	if (trace_probe_test_flag(&tu->tp, TP_FLAG_PROFILE))
1500		uretprobe_perf_func(tu, func, regs, ucb, dsize);
1501#endif
1502	uprobe_buffer_put(ucb);
1503	return 0;
1504}
1505
1506static struct trace_event_functions uprobe_funcs = {
1507	.trace		= print_uprobe_event
1508};
1509
 
 
 
 
 
 
1510static inline void init_trace_event_call(struct trace_uprobe *tu)
1511{
1512	struct trace_event_call *call = trace_probe_event_call(&tu->tp);
1513
1514	call->event.funcs = &uprobe_funcs;
1515	call->class->define_fields = uprobe_event_define_fields;
1516
1517	call->flags = TRACE_EVENT_FL_UPROBE | TRACE_EVENT_FL_CAP_ANY;
1518	call->class->reg = trace_uprobe_register;
1519}
1520
1521static int register_uprobe_event(struct trace_uprobe *tu)
1522{
1523	init_trace_event_call(tu);
1524
1525	return trace_probe_register_event_call(&tu->tp);
1526}
1527
1528static int unregister_uprobe_event(struct trace_uprobe *tu)
1529{
1530	return trace_probe_unregister_event_call(&tu->tp);
1531}
1532
1533#ifdef CONFIG_PERF_EVENTS
1534struct trace_event_call *
1535create_local_trace_uprobe(char *name, unsigned long offs,
1536			  unsigned long ref_ctr_offset, bool is_return)
1537{
 
1538	struct trace_uprobe *tu;
1539	struct path path;
1540	int ret;
1541
1542	ret = kern_path(name, LOOKUP_FOLLOW, &path);
1543	if (ret)
1544		return ERR_PTR(ret);
1545
1546	if (!d_is_reg(path.dentry)) {
1547		path_put(&path);
1548		return ERR_PTR(-EINVAL);
1549	}
1550
1551	/*
1552	 * local trace_kprobes are not added to dyn_event, so they are never
1553	 * searched in find_trace_kprobe(). Therefore, there is no concern of
1554	 * duplicated name "DUMMY_EVENT" here.
1555	 */
1556	tu = alloc_trace_uprobe(UPROBE_EVENT_SYSTEM, "DUMMY_EVENT", 0,
1557				is_return);
1558
1559	if (IS_ERR(tu)) {
1560		pr_info("Failed to allocate trace_uprobe.(%d)\n",
1561			(int)PTR_ERR(tu));
1562		path_put(&path);
1563		return ERR_CAST(tu);
1564	}
1565
1566	tu->offset = offs;
1567	tu->path = path;
1568	tu->ref_ctr_offset = ref_ctr_offset;
1569	tu->filename = kstrdup(name, GFP_KERNEL);
 
 
 
 
 
1570	init_trace_event_call(tu);
1571
1572	if (traceprobe_set_print_fmt(&tu->tp, is_ret_probe(tu)) < 0) {
 
1573		ret = -ENOMEM;
1574		goto error;
1575	}
1576
1577	return trace_probe_event_call(&tu->tp);
1578error:
1579	free_trace_uprobe(tu);
1580	return ERR_PTR(ret);
1581}
1582
1583void destroy_local_trace_uprobe(struct trace_event_call *event_call)
1584{
1585	struct trace_uprobe *tu;
1586
1587	tu = trace_uprobe_primary_from_call(event_call);
1588
1589	free_trace_uprobe(tu);
1590}
1591#endif /* CONFIG_PERF_EVENTS */
1592
1593/* Make a trace interface for controling probe points */
1594static __init int init_uprobe_trace(void)
1595{
1596	struct dentry *d_tracer;
1597	int ret;
1598
1599	ret = dyn_event_register(&trace_uprobe_ops);
1600	if (ret)
1601		return ret;
1602
1603	d_tracer = tracing_init_dentry();
1604	if (IS_ERR(d_tracer))
1605		return 0;
1606
1607	trace_create_file("uprobe_events", 0644, d_tracer,
1608				    NULL, &uprobe_events_ops);
1609	/* Profile interface */
1610	trace_create_file("uprobe_profile", 0444, d_tracer,
1611				    NULL, &uprobe_profile_ops);
1612	return 0;
1613}
1614
1615fs_initcall(init_uprobe_trace);
v6.13.7
   1// SPDX-License-Identifier: GPL-2.0
   2/*
   3 * uprobes-based tracing events
   4 *
   5 * Copyright (C) IBM Corporation, 2010-2012
   6 * Author:	Srikar Dronamraju <srikar@linux.vnet.ibm.com>
   7 */
   8#define pr_fmt(fmt)	"trace_uprobe: " fmt
   9
  10#include <linux/bpf-cgroup.h>
  11#include <linux/security.h>
  12#include <linux/ctype.h>
  13#include <linux/module.h>
  14#include <linux/uaccess.h>
  15#include <linux/uprobes.h>
  16#include <linux/namei.h>
  17#include <linux/string.h>
  18#include <linux/rculist.h>
  19#include <linux/filter.h>
  20#include <linux/percpu.h>
  21
  22#include "trace_dynevent.h"
  23#include "trace_probe.h"
  24#include "trace_probe_tmpl.h"
  25
  26#define UPROBE_EVENT_SYSTEM	"uprobes"
  27
  28struct uprobe_trace_entry_head {
  29	struct trace_entry	ent;
  30	unsigned long		vaddr[];
  31};
  32
  33#define SIZEOF_TRACE_ENTRY(is_return)			\
  34	(sizeof(struct uprobe_trace_entry_head) +	\
  35	 sizeof(unsigned long) * (is_return ? 2 : 1))
  36
  37#define DATAOF_TRACE_ENTRY(entry, is_return)		\
  38	((void*)(entry) + SIZEOF_TRACE_ENTRY(is_return))
  39
  40static int trace_uprobe_create(const char *raw_command);
 
 
 
 
 
 
  41static int trace_uprobe_show(struct seq_file *m, struct dyn_event *ev);
  42static int trace_uprobe_release(struct dyn_event *ev);
  43static bool trace_uprobe_is_busy(struct dyn_event *ev);
  44static bool trace_uprobe_match(const char *system, const char *event,
  45			int argc, const char **argv, struct dyn_event *ev);
  46
  47static struct dyn_event_operations trace_uprobe_ops = {
  48	.create = trace_uprobe_create,
  49	.show = trace_uprobe_show,
  50	.is_busy = trace_uprobe_is_busy,
  51	.free = trace_uprobe_release,
  52	.match = trace_uprobe_match,
  53};
  54
  55/*
  56 * uprobe event core functions
  57 */
  58struct trace_uprobe {
  59	struct dyn_event		devent;
 
  60	struct uprobe_consumer		consumer;
  61	struct path			path;
 
  62	char				*filename;
  63	struct uprobe			*uprobe;
  64	unsigned long			offset;
  65	unsigned long			ref_ctr_offset;
  66	unsigned long __percpu		*nhits;
  67	struct trace_probe		tp;
  68};
  69
  70static bool is_trace_uprobe(struct dyn_event *ev)
  71{
  72	return ev->ops == &trace_uprobe_ops;
  73}
  74
  75static struct trace_uprobe *to_trace_uprobe(struct dyn_event *ev)
  76{
  77	return container_of(ev, struct trace_uprobe, devent);
  78}
  79
  80/**
  81 * for_each_trace_uprobe - iterate over the trace_uprobe list
  82 * @pos:	the struct trace_uprobe * for each entry
  83 * @dpos:	the struct dyn_event * to use as a loop cursor
  84 */
  85#define for_each_trace_uprobe(pos, dpos)	\
  86	for_each_dyn_event(dpos)		\
  87		if (is_trace_uprobe(dpos) && (pos = to_trace_uprobe(dpos)))
  88
 
 
 
 
  89static int register_uprobe_event(struct trace_uprobe *tu);
  90static int unregister_uprobe_event(struct trace_uprobe *tu);
  91
  92static int uprobe_dispatcher(struct uprobe_consumer *con, struct pt_regs *regs,
  93			     __u64 *data);
 
 
 
 
  94static int uretprobe_dispatcher(struct uprobe_consumer *con,
  95				unsigned long func, struct pt_regs *regs,
  96				__u64 *data);
  97
  98#ifdef CONFIG_STACK_GROWSUP
  99static unsigned long adjust_stack_addr(unsigned long addr, unsigned int n)
 100{
 101	return addr - (n * sizeof(long));
 102}
 103#else
 104static unsigned long adjust_stack_addr(unsigned long addr, unsigned int n)
 105{
 106	return addr + (n * sizeof(long));
 107}
 108#endif
 109
 110static unsigned long get_user_stack_nth(struct pt_regs *regs, unsigned int n)
 111{
 112	unsigned long ret;
 113	unsigned long addr = user_stack_pointer(regs);
 114
 115	addr = adjust_stack_addr(addr, n);
 116
 117	if (copy_from_user(&ret, (void __force __user *) addr, sizeof(ret)))
 118		return 0;
 119
 120	return ret;
 121}
 122
 123/*
 124 * Uprobes-specific fetch functions
 125 */
 126static nokprobe_inline int
 127probe_mem_read(void *dest, void *src, size_t size)
 128{
 129	void __user *vaddr = (void __force __user *)src;
 130
 131	return copy_from_user(dest, vaddr, size) ? -EFAULT : 0;
 132}
 133
 134static nokprobe_inline int
 135probe_mem_read_user(void *dest, void *src, size_t size)
 136{
 137	return probe_mem_read(dest, src, size);
 138}
 139
 140/*
 141 * Fetch a null-terminated string. Caller MUST set *(u32 *)dest with max
 142 * length and relative data location.
 143 */
 144static nokprobe_inline int
 145fetch_store_string(unsigned long addr, void *dest, void *base)
 146{
 147	long ret;
 148	u32 loc = *(u32 *)dest;
 149	int maxlen  = get_loc_len(loc);
 150	u8 *dst = get_loc_data(dest, base);
 151	void __user *src = (void __force __user *) addr;
 152
 153	if (unlikely(!maxlen))
 154		return -ENOMEM;
 155
 156	if (addr == FETCH_TOKEN_COMM)
 157		ret = strscpy(dst, current->comm, maxlen);
 158	else
 159		ret = strncpy_from_user(dst, src, maxlen);
 160	if (ret >= 0) {
 161		if (ret == maxlen)
 162			dst[ret - 1] = '\0';
 163		else
 164			/*
 165			 * Include the terminating null byte. In this case it
 166			 * was copied by strncpy_from_user but not accounted
 167			 * for in ret.
 168			 */
 169			ret++;
 170		*(u32 *)dest = make_data_loc(ret, (void *)dst - base);
 171	} else
 172		*(u32 *)dest = make_data_loc(0, (void *)dst - base);
 173
 174	return ret;
 175}
 176
 177static nokprobe_inline int
 178fetch_store_string_user(unsigned long addr, void *dest, void *base)
 179{
 180	return fetch_store_string(addr, dest, base);
 181}
 182
 183/* Return the length of string -- including null terminal byte */
 184static nokprobe_inline int
 185fetch_store_strlen(unsigned long addr)
 186{
 187	int len;
 188	void __user *vaddr = (void __force __user *) addr;
 189
 190	if (addr == FETCH_TOKEN_COMM)
 191		len = strlen(current->comm) + 1;
 192	else
 193		len = strnlen_user(vaddr, MAX_STRING_SIZE);
 194
 195	return (len > MAX_STRING_SIZE) ? 0 : len;
 196}
 197
 198static nokprobe_inline int
 199fetch_store_strlen_user(unsigned long addr)
 200{
 201	return fetch_store_strlen(addr);
 202}
 203
 204static unsigned long translate_user_vaddr(unsigned long file_offset)
 205{
 206	unsigned long base_addr;
 207	struct uprobe_dispatch_data *udd;
 208
 209	udd = (void *) current->utask->vaddr;
 210
 211	base_addr = udd->bp_addr - udd->tu->offset;
 212	return base_addr + file_offset;
 213}
 214
 215/* Note that we don't verify it, since the code does not come from user space */
 216static int
 217process_fetch_insn(struct fetch_insn *code, void *rec, void *edata,
 218		   void *dest, void *base)
 219{
 220	struct pt_regs *regs = rec;
 221	unsigned long val;
 222	int ret;
 223
 224	/* 1st stage: get value from context */
 225	switch (code->op) {
 226	case FETCH_OP_REG:
 227		val = regs_get_register(regs, code->param);
 228		break;
 229	case FETCH_OP_STACK:
 230		val = get_user_stack_nth(regs, code->param);
 231		break;
 232	case FETCH_OP_STACKP:
 233		val = user_stack_pointer(regs);
 234		break;
 235	case FETCH_OP_RETVAL:
 236		val = regs_return_value(regs);
 237		break;
 
 
 
 238	case FETCH_OP_COMM:
 239		val = FETCH_TOKEN_COMM;
 240		break;
 
 
 
 241	case FETCH_OP_FOFFS:
 242		val = translate_user_vaddr(code->immediate);
 243		break;
 244	default:
 245		ret = process_common_fetch_insn(code, &val);
 246		if (ret < 0)
 247			return ret;
 248	}
 249	code++;
 250
 251	return process_fetch_insn_bottom(code, val, dest, base);
 252}
 253NOKPROBE_SYMBOL(process_fetch_insn)
 254
 255static inline void init_trace_uprobe_filter(struct trace_uprobe_filter *filter)
 256{
 257	rwlock_init(&filter->rwlock);
 258	filter->nr_systemwide = 0;
 259	INIT_LIST_HEAD(&filter->perf_events);
 260}
 261
 262static inline bool uprobe_filter_is_empty(struct trace_uprobe_filter *filter)
 263{
 264	return !filter->nr_systemwide && list_empty(&filter->perf_events);
 265}
 266
 267static inline bool is_ret_probe(struct trace_uprobe *tu)
 268{
 269	return tu->consumer.ret_handler != NULL;
 270}
 271
 272static bool trace_uprobe_is_busy(struct dyn_event *ev)
 273{
 274	struct trace_uprobe *tu = to_trace_uprobe(ev);
 275
 276	return trace_probe_is_enabled(&tu->tp);
 277}
 278
 279static bool trace_uprobe_match_command_head(struct trace_uprobe *tu,
 280					    int argc, const char **argv)
 281{
 282	char buf[MAX_ARGSTR_LEN + 1];
 283	int len;
 284
 285	if (!argc)
 286		return true;
 287
 288	len = strlen(tu->filename);
 289	if (strncmp(tu->filename, argv[0], len) || argv[0][len] != ':')
 290		return false;
 291
 292	if (tu->ref_ctr_offset == 0)
 293		snprintf(buf, sizeof(buf), "0x%0*lx",
 294				(int)(sizeof(void *) * 2), tu->offset);
 295	else
 296		snprintf(buf, sizeof(buf), "0x%0*lx(0x%lx)",
 297				(int)(sizeof(void *) * 2), tu->offset,
 298				tu->ref_ctr_offset);
 299	if (strcmp(buf, &argv[0][len + 1]))
 300		return false;
 301
 302	argc--; argv++;
 303
 304	return trace_probe_match_command_args(&tu->tp, argc, argv);
 305}
 306
 307static bool trace_uprobe_match(const char *system, const char *event,
 308			int argc, const char **argv, struct dyn_event *ev)
 309{
 310	struct trace_uprobe *tu = to_trace_uprobe(ev);
 311
 312	return (event[0] == '\0' ||
 313		strcmp(trace_probe_name(&tu->tp), event) == 0) &&
 314	   (!system || strcmp(trace_probe_group_name(&tu->tp), system) == 0) &&
 315	   trace_uprobe_match_command_head(tu, argc, argv);
 316}
 317
 318static nokprobe_inline struct trace_uprobe *
 319trace_uprobe_primary_from_call(struct trace_event_call *call)
 320{
 321	struct trace_probe *tp;
 322
 323	tp = trace_probe_primary_from_call(call);
 324	if (WARN_ON_ONCE(!tp))
 325		return NULL;
 326
 327	return container_of(tp, struct trace_uprobe, tp);
 328}
 329
 330/*
 331 * Allocate new trace_uprobe and initialize it (including uprobes).
 332 */
 333static struct trace_uprobe *
 334alloc_trace_uprobe(const char *group, const char *event, int nargs, bool is_ret)
 335{
 336	struct trace_uprobe *tu;
 337	int ret;
 338
 339	tu = kzalloc(struct_size(tu, tp.args, nargs), GFP_KERNEL);
 340	if (!tu)
 341		return ERR_PTR(-ENOMEM);
 342
 343	tu->nhits = alloc_percpu(unsigned long);
 344	if (!tu->nhits) {
 345		ret = -ENOMEM;
 346		goto error;
 347	}
 348
 349	ret = trace_probe_init(&tu->tp, event, group, true, nargs);
 350	if (ret < 0)
 351		goto error;
 352
 353	dyn_event_init(&tu->devent, &trace_uprobe_ops);
 354	tu->consumer.handler = uprobe_dispatcher;
 355	if (is_ret)
 356		tu->consumer.ret_handler = uretprobe_dispatcher;
 357	init_trace_uprobe_filter(tu->tp.event->filter);
 358	return tu;
 359
 360error:
 361	free_percpu(tu->nhits);
 362	kfree(tu);
 363
 364	return ERR_PTR(ret);
 365}
 366
 367static void free_trace_uprobe(struct trace_uprobe *tu)
 368{
 369	if (!tu)
 370		return;
 371
 372	path_put(&tu->path);
 373	trace_probe_cleanup(&tu->tp);
 374	kfree(tu->filename);
 375	free_percpu(tu->nhits);
 376	kfree(tu);
 377}
 378
 379static struct trace_uprobe *find_probe_event(const char *event, const char *group)
 380{
 381	struct dyn_event *pos;
 382	struct trace_uprobe *tu;
 383
 384	for_each_trace_uprobe(tu, pos)
 385		if (strcmp(trace_probe_name(&tu->tp), event) == 0 &&
 386		    strcmp(trace_probe_group_name(&tu->tp), group) == 0)
 387			return tu;
 388
 389	return NULL;
 390}
 391
 392/* Unregister a trace_uprobe and probe_event */
 393static int unregister_trace_uprobe(struct trace_uprobe *tu)
 394{
 395	int ret;
 396
 397	if (trace_probe_has_sibling(&tu->tp))
 398		goto unreg;
 399
 400	/* If there's a reference to the dynamic event */
 401	if (trace_event_dyn_busy(trace_probe_event_call(&tu->tp)))
 402		return -EBUSY;
 403
 404	ret = unregister_uprobe_event(tu);
 405	if (ret)
 406		return ret;
 407
 408unreg:
 409	dyn_event_remove(&tu->devent);
 410	trace_probe_unlink(&tu->tp);
 411	free_trace_uprobe(tu);
 412	return 0;
 413}
 414
 415static bool trace_uprobe_has_same_uprobe(struct trace_uprobe *orig,
 416					 struct trace_uprobe *comp)
 417{
 418	struct trace_probe_event *tpe = orig->tp.event;
 
 419	struct inode *comp_inode = d_real_inode(comp->path.dentry);
 420	int i;
 421
 422	list_for_each_entry(orig, &tpe->probes, tp.list) {
 
 423		if (comp_inode != d_real_inode(orig->path.dentry) ||
 424		    comp->offset != orig->offset)
 425			continue;
 426
 427		/*
 428		 * trace_probe_compare_arg_type() ensured that nr_args and
 429		 * each argument name and type are same. Let's compare comm.
 430		 */
 431		for (i = 0; i < orig->tp.nr_args; i++) {
 432			if (strcmp(orig->tp.args[i].comm,
 433				   comp->tp.args[i].comm))
 434				break;
 435		}
 436
 437		if (i == orig->tp.nr_args)
 438			return true;
 439	}
 440
 441	return false;
 442}
 443
 444static int append_trace_uprobe(struct trace_uprobe *tu, struct trace_uprobe *to)
 445{
 446	int ret;
 447
 448	ret = trace_probe_compare_arg_type(&tu->tp, &to->tp);
 449	if (ret) {
 450		/* Note that argument starts index = 2 */
 451		trace_probe_log_set_index(ret + 1);
 452		trace_probe_log_err(0, DIFF_ARG_TYPE);
 453		return -EEXIST;
 454	}
 455	if (trace_uprobe_has_same_uprobe(to, tu)) {
 456		trace_probe_log_set_index(0);
 457		trace_probe_log_err(0, SAME_PROBE);
 458		return -EEXIST;
 459	}
 460
 461	/* Append to existing event */
 462	ret = trace_probe_append(&tu->tp, &to->tp);
 463	if (!ret)
 464		dyn_event_add(&tu->devent, trace_probe_event_call(&tu->tp));
 465
 466	return ret;
 467}
 468
 469/*
 470 * Uprobe with multiple reference counter is not allowed. i.e.
 471 * If inode and offset matches, reference counter offset *must*
 472 * match as well. Though, there is one exception: If user is
 473 * replacing old trace_uprobe with new one(same group/event),
 474 * then we allow same uprobe with new reference counter as far
 475 * as the new one does not conflict with any other existing
 476 * ones.
 477 */
 478static int validate_ref_ctr_offset(struct trace_uprobe *new)
 479{
 480	struct dyn_event *pos;
 481	struct trace_uprobe *tmp;
 482	struct inode *new_inode = d_real_inode(new->path.dentry);
 483
 484	for_each_trace_uprobe(tmp, pos) {
 485		if (new_inode == d_real_inode(tmp->path.dentry) &&
 486		    new->offset == tmp->offset &&
 487		    new->ref_ctr_offset != tmp->ref_ctr_offset) {
 488			pr_warn("Reference counter offset mismatch.");
 489			return -EINVAL;
 490		}
 491	}
 492	return 0;
 493}
 494
 495/* Register a trace_uprobe and probe_event */
 496static int register_trace_uprobe(struct trace_uprobe *tu)
 497{
 498	struct trace_uprobe *old_tu;
 499	int ret;
 500
 501	mutex_lock(&event_mutex);
 502
 503	ret = validate_ref_ctr_offset(tu);
 504	if (ret)
 505		goto end;
 506
 507	/* register as an event */
 508	old_tu = find_probe_event(trace_probe_name(&tu->tp),
 509				  trace_probe_group_name(&tu->tp));
 510	if (old_tu) {
 511		if (is_ret_probe(tu) != is_ret_probe(old_tu)) {
 512			trace_probe_log_set_index(0);
 513			trace_probe_log_err(0, DIFF_PROBE_TYPE);
 514			ret = -EEXIST;
 515		} else {
 516			ret = append_trace_uprobe(tu, old_tu);
 517		}
 518		goto end;
 519	}
 520
 521	ret = register_uprobe_event(tu);
 522	if (ret) {
 523		if (ret == -EEXIST) {
 524			trace_probe_log_set_index(0);
 525			trace_probe_log_err(0, EVENT_EXIST);
 526		} else
 527			pr_warn("Failed to register probe event(%d)\n", ret);
 528		goto end;
 529	}
 530
 531	dyn_event_add(&tu->devent, trace_probe_event_call(&tu->tp));
 532
 533end:
 534	mutex_unlock(&event_mutex);
 535
 536	return ret;
 537}
 538
 539/*
 540 * Argument syntax:
 541 *  - Add uprobe: p|r[:[GRP/][EVENT]] PATH:OFFSET[%return][(REF)] [FETCHARGS]
 542 */
 543static int __trace_uprobe_create(int argc, const char **argv)
 544{
 545	struct trace_uprobe *tu;
 546	const char *event = NULL, *group = UPROBE_EVENT_SYSTEM;
 547	char *arg, *filename, *rctr, *rctr_end, *tmp;
 548	char buf[MAX_EVENT_NAME_LEN];
 549	char gbuf[MAX_EVENT_NAME_LEN];
 550	enum probe_print_type ptype;
 551	struct path path;
 552	unsigned long offset, ref_ctr_offset;
 553	bool is_return = false;
 554	int i, ret;
 555
 
 556	ref_ctr_offset = 0;
 557
 558	switch (argv[0][0]) {
 559	case 'r':
 560		is_return = true;
 561		break;
 562	case 'p':
 563		break;
 564	default:
 565		return -ECANCELED;
 566	}
 567
 568	if (argc < 2)
 569		return -ECANCELED;
 570	if (argc - 2 > MAX_TRACE_ARGS)
 571		return -E2BIG;
 572
 573	if (argv[0][1] == ':')
 574		event = &argv[0][2];
 575
 576	if (!strchr(argv[1], '/'))
 577		return -ECANCELED;
 578
 579	filename = kstrdup(argv[1], GFP_KERNEL);
 580	if (!filename)
 581		return -ENOMEM;
 582
 583	/* Find the last occurrence, in case the path contains ':' too. */
 584	arg = strrchr(filename, ':');
 585	if (!arg || !isdigit(arg[1])) {
 586		kfree(filename);
 587		return -ECANCELED;
 588	}
 589
 590	trace_probe_log_init("trace_uprobe", argc, argv);
 591	trace_probe_log_set_index(1);	/* filename is the 2nd argument */
 592
 593	*arg++ = '\0';
 594	ret = kern_path(filename, LOOKUP_FOLLOW, &path);
 595	if (ret) {
 596		trace_probe_log_err(0, FILE_NOT_FOUND);
 597		kfree(filename);
 598		trace_probe_log_clear();
 599		return ret;
 600	}
 601	if (!d_is_reg(path.dentry)) {
 602		trace_probe_log_err(0, NO_REGULAR_FILE);
 603		ret = -EINVAL;
 604		goto fail_address_parse;
 605	}
 606
 607	/* Parse reference counter offset if specified. */
 608	rctr = strchr(arg, '(');
 609	if (rctr) {
 610		rctr_end = strchr(rctr, ')');
 611		if (!rctr_end) {
 612			ret = -EINVAL;
 613			rctr_end = rctr + strlen(rctr);
 614			trace_probe_log_err(rctr_end - filename,
 615					    REFCNT_OPEN_BRACE);
 616			goto fail_address_parse;
 617		} else if (rctr_end[1] != '\0') {
 618			ret = -EINVAL;
 619			trace_probe_log_err(rctr_end + 1 - filename,
 620					    BAD_REFCNT_SUFFIX);
 621			goto fail_address_parse;
 622		}
 623
 624		*rctr++ = '\0';
 625		*rctr_end = '\0';
 626		ret = kstrtoul(rctr, 0, &ref_ctr_offset);
 627		if (ret) {
 628			trace_probe_log_err(rctr - filename, BAD_REFCNT);
 629			goto fail_address_parse;
 630		}
 631	}
 632
 633	/* Check if there is %return suffix */
 634	tmp = strchr(arg, '%');
 635	if (tmp) {
 636		if (!strcmp(tmp, "%return")) {
 637			*tmp = '\0';
 638			is_return = true;
 639		} else {
 640			trace_probe_log_err(tmp - filename, BAD_ADDR_SUFFIX);
 641			ret = -EINVAL;
 642			goto fail_address_parse;
 643		}
 644	}
 645
 646	/* Parse uprobe offset. */
 647	ret = kstrtoul(arg, 0, &offset);
 648	if (ret) {
 649		trace_probe_log_err(arg - filename, BAD_UPROBE_OFFS);
 650		goto fail_address_parse;
 651	}
 652
 653	/* setup a probe */
 654	trace_probe_log_set_index(0);
 655	if (event) {
 656		ret = traceprobe_parse_event_name(&event, &group, gbuf,
 657						  event - argv[0]);
 658		if (ret)
 659			goto fail_address_parse;
 660	}
 661
 662	if (!event) {
 663		char *tail;
 664		char *ptr;
 665
 666		tail = kstrdup(kbasename(filename), GFP_KERNEL);
 667		if (!tail) {
 668			ret = -ENOMEM;
 669			goto fail_address_parse;
 670		}
 671
 672		ptr = strpbrk(tail, ".-_");
 673		if (ptr)
 674			*ptr = '\0';
 675
 676		snprintf(buf, MAX_EVENT_NAME_LEN, "%c_%s_0x%lx", 'p', tail, offset);
 677		event = buf;
 678		kfree(tail);
 679	}
 680
 681	argc -= 2;
 682	argv += 2;
 683
 684	tu = alloc_trace_uprobe(group, event, argc, is_return);
 685	if (IS_ERR(tu)) {
 686		ret = PTR_ERR(tu);
 687		/* This must return -ENOMEM otherwise there is a bug */
 688		WARN_ON_ONCE(ret != -ENOMEM);
 689		goto fail_address_parse;
 690	}
 691	tu->offset = offset;
 692	tu->ref_ctr_offset = ref_ctr_offset;
 693	tu->path = path;
 694	tu->filename = filename;
 695
 696	/* parse arguments */
 697	for (i = 0; i < argc; i++) {
 698		struct traceprobe_parse_context ctx = {
 699			.flags = (is_return ? TPARG_FL_RETURN : 0) | TPARG_FL_USER,
 700		};
 
 
 701
 702		trace_probe_log_set_index(i + 2);
 703		ret = traceprobe_parse_probe_arg(&tu->tp, i, argv[i], &ctx);
 704		traceprobe_finish_parse(&ctx);
 
 705		if (ret)
 706			goto error;
 707	}
 708
 709	ptype = is_ret_probe(tu) ? PROBE_PRINT_RETURN : PROBE_PRINT_NORMAL;
 710	ret = traceprobe_set_print_fmt(&tu->tp, ptype);
 711	if (ret < 0)
 712		goto error;
 713
 714	ret = register_trace_uprobe(tu);
 715	if (!ret)
 716		goto out;
 717
 718error:
 719	free_trace_uprobe(tu);
 720out:
 721	trace_probe_log_clear();
 722	return ret;
 723
 724fail_address_parse:
 725	trace_probe_log_clear();
 726	path_put(&path);
 727	kfree(filename);
 728
 729	return ret;
 730}
 731
 732int trace_uprobe_create(const char *raw_command)
 733{
 734	return trace_probe_create(raw_command, __trace_uprobe_create);
 735}
 736
 737static int create_or_delete_trace_uprobe(const char *raw_command)
 738{
 739	int ret;
 740
 741	if (raw_command[0] == '-')
 742		return dyn_event_release(raw_command, &trace_uprobe_ops);
 743
 744	ret = trace_uprobe_create(raw_command);
 745	return ret == -ECANCELED ? -EINVAL : ret;
 746}
 747
 748static int trace_uprobe_release(struct dyn_event *ev)
 749{
 750	struct trace_uprobe *tu = to_trace_uprobe(ev);
 751
 752	return unregister_trace_uprobe(tu);
 753}
 754
 755/* Probes listing interfaces */
 756static int trace_uprobe_show(struct seq_file *m, struct dyn_event *ev)
 757{
 758	struct trace_uprobe *tu = to_trace_uprobe(ev);
 759	char c = is_ret_probe(tu) ? 'r' : 'p';
 760	int i;
 761
 762	seq_printf(m, "%c:%s/%s %s:0x%0*lx", c, trace_probe_group_name(&tu->tp),
 763			trace_probe_name(&tu->tp), tu->filename,
 764			(int)(sizeof(void *) * 2), tu->offset);
 765
 766	if (tu->ref_ctr_offset)
 767		seq_printf(m, "(0x%lx)", tu->ref_ctr_offset);
 768
 769	for (i = 0; i < tu->tp.nr_args; i++)
 770		seq_printf(m, " %s=%s", tu->tp.args[i].name, tu->tp.args[i].comm);
 771
 772	seq_putc(m, '\n');
 773	return 0;
 774}
 775
 776static int probes_seq_show(struct seq_file *m, void *v)
 777{
 778	struct dyn_event *ev = v;
 779
 780	if (!is_trace_uprobe(ev))
 781		return 0;
 782
 783	return trace_uprobe_show(m, ev);
 784}
 785
 786static const struct seq_operations probes_seq_op = {
 787	.start  = dyn_event_seq_start,
 788	.next   = dyn_event_seq_next,
 789	.stop   = dyn_event_seq_stop,
 790	.show   = probes_seq_show
 791};
 792
 793static int probes_open(struct inode *inode, struct file *file)
 794{
 795	int ret;
 796
 797	ret = security_locked_down(LOCKDOWN_TRACEFS);
 798	if (ret)
 799		return ret;
 800
 801	if ((file->f_mode & FMODE_WRITE) && (file->f_flags & O_TRUNC)) {
 802		ret = dyn_events_release_all(&trace_uprobe_ops);
 803		if (ret)
 804			return ret;
 805	}
 806
 807	return seq_open(file, &probes_seq_op);
 808}
 809
 810static ssize_t probes_write(struct file *file, const char __user *buffer,
 811			    size_t count, loff_t *ppos)
 812{
 813	return trace_parse_run_command(file, buffer, count, ppos,
 814					create_or_delete_trace_uprobe);
 815}
 816
 817static const struct file_operations uprobe_events_ops = {
 818	.owner		= THIS_MODULE,
 819	.open		= probes_open,
 820	.read		= seq_read,
 821	.llseek		= seq_lseek,
 822	.release	= seq_release,
 823	.write		= probes_write,
 824};
 825
 826/* Probes profiling interfaces */
 827static int probes_profile_seq_show(struct seq_file *m, void *v)
 828{
 829	struct dyn_event *ev = v;
 830	struct trace_uprobe *tu;
 831	unsigned long nhits;
 832	int cpu;
 833
 834	if (!is_trace_uprobe(ev))
 835		return 0;
 836
 837	tu = to_trace_uprobe(ev);
 838
 839	nhits = 0;
 840	for_each_possible_cpu(cpu) {
 841		nhits += per_cpu(*tu->nhits, cpu);
 842	}
 843
 844	seq_printf(m, "  %s %-44s %15lu\n", tu->filename,
 845		   trace_probe_name(&tu->tp), nhits);
 846	return 0;
 847}
 848
 849static const struct seq_operations profile_seq_op = {
 850	.start  = dyn_event_seq_start,
 851	.next   = dyn_event_seq_next,
 852	.stop   = dyn_event_seq_stop,
 853	.show	= probes_profile_seq_show
 854};
 855
 856static int profile_open(struct inode *inode, struct file *file)
 857{
 858	int ret;
 859
 860	ret = security_locked_down(LOCKDOWN_TRACEFS);
 861	if (ret)
 862		return ret;
 863
 864	return seq_open(file, &profile_seq_op);
 865}
 866
 867static const struct file_operations uprobe_profile_ops = {
 868	.owner		= THIS_MODULE,
 869	.open		= profile_open,
 870	.read		= seq_read,
 871	.llseek		= seq_lseek,
 872	.release	= seq_release,
 873};
 874
 875struct uprobe_cpu_buffer {
 876	struct mutex mutex;
 877	void *buf;
 878	int dsize;
 879};
 880static struct uprobe_cpu_buffer __percpu *uprobe_cpu_buffer;
 881static int uprobe_buffer_refcnt;
 882#define MAX_UCB_BUFFER_SIZE PAGE_SIZE
 883
 884static int uprobe_buffer_init(void)
 885{
 886	int cpu, err_cpu;
 887
 888	uprobe_cpu_buffer = alloc_percpu(struct uprobe_cpu_buffer);
 889	if (uprobe_cpu_buffer == NULL)
 890		return -ENOMEM;
 891
 892	for_each_possible_cpu(cpu) {
 893		struct page *p = alloc_pages_node(cpu_to_node(cpu),
 894						  GFP_KERNEL, 0);
 895		if (p == NULL) {
 896			err_cpu = cpu;
 897			goto err;
 898		}
 899		per_cpu_ptr(uprobe_cpu_buffer, cpu)->buf = page_address(p);
 900		mutex_init(&per_cpu_ptr(uprobe_cpu_buffer, cpu)->mutex);
 901	}
 902
 903	return 0;
 904
 905err:
 906	for_each_possible_cpu(cpu) {
 907		if (cpu == err_cpu)
 908			break;
 909		free_page((unsigned long)per_cpu_ptr(uprobe_cpu_buffer, cpu)->buf);
 910	}
 911
 912	free_percpu(uprobe_cpu_buffer);
 913	return -ENOMEM;
 914}
 915
 916static int uprobe_buffer_enable(void)
 917{
 918	int ret = 0;
 919
 920	BUG_ON(!mutex_is_locked(&event_mutex));
 921
 922	if (uprobe_buffer_refcnt++ == 0) {
 923		ret = uprobe_buffer_init();
 924		if (ret < 0)
 925			uprobe_buffer_refcnt--;
 926	}
 927
 928	return ret;
 929}
 930
 931static void uprobe_buffer_disable(void)
 932{
 933	int cpu;
 934
 935	BUG_ON(!mutex_is_locked(&event_mutex));
 936
 937	if (--uprobe_buffer_refcnt == 0) {
 938		for_each_possible_cpu(cpu)
 939			free_page((unsigned long)per_cpu_ptr(uprobe_cpu_buffer,
 940							     cpu)->buf);
 941
 942		free_percpu(uprobe_cpu_buffer);
 943		uprobe_cpu_buffer = NULL;
 944	}
 945}
 946
 947static struct uprobe_cpu_buffer *uprobe_buffer_get(void)
 948{
 949	struct uprobe_cpu_buffer *ucb;
 950	int cpu;
 951
 952	cpu = raw_smp_processor_id();
 953	ucb = per_cpu_ptr(uprobe_cpu_buffer, cpu);
 954
 955	/*
 956	 * Use per-cpu buffers for fastest access, but we might migrate
 957	 * so the mutex makes sure we have sole access to it.
 958	 */
 959	mutex_lock(&ucb->mutex);
 960
 961	return ucb;
 962}
 963
 964static void uprobe_buffer_put(struct uprobe_cpu_buffer *ucb)
 965{
 966	if (!ucb)
 967		return;
 968	mutex_unlock(&ucb->mutex);
 969}
 970
 971static struct uprobe_cpu_buffer *prepare_uprobe_buffer(struct trace_uprobe *tu,
 972						       struct pt_regs *regs,
 973						       struct uprobe_cpu_buffer **ucbp)
 974{
 975	struct uprobe_cpu_buffer *ucb;
 976	int dsize, esize;
 977
 978	if (*ucbp)
 979		return *ucbp;
 980
 981	esize = SIZEOF_TRACE_ENTRY(is_ret_probe(tu));
 982	dsize = __get_data_size(&tu->tp, regs, NULL);
 983
 984	ucb = uprobe_buffer_get();
 985	ucb->dsize = tu->tp.size + dsize;
 986
 987	if (WARN_ON_ONCE(ucb->dsize > MAX_UCB_BUFFER_SIZE)) {
 988		ucb->dsize = MAX_UCB_BUFFER_SIZE;
 989		dsize = MAX_UCB_BUFFER_SIZE - tu->tp.size;
 990	}
 991
 992	store_trace_args(ucb->buf, &tu->tp, regs, NULL, esize, dsize);
 993
 994	*ucbp = ucb;
 995	return ucb;
 996}
 997
 998static void __uprobe_trace_func(struct trace_uprobe *tu,
 999				unsigned long func, struct pt_regs *regs,
1000				struct uprobe_cpu_buffer *ucb,
1001				struct trace_event_file *trace_file)
1002{
1003	struct uprobe_trace_entry_head *entry;
1004	struct trace_event_buffer fbuffer;
 
1005	void *data;
1006	int size, esize;
1007	struct trace_event_call *call = trace_probe_event_call(&tu->tp);
1008
1009	WARN_ON(call != trace_file->event_call);
1010
 
 
 
1011	if (trace_trigger_soft_disabled(trace_file))
1012		return;
1013
1014	esize = SIZEOF_TRACE_ENTRY(is_ret_probe(tu));
1015	size = esize + ucb->dsize;
1016	entry = trace_event_buffer_reserve(&fbuffer, trace_file, size);
1017	if (!entry)
 
1018		return;
1019
 
1020	if (is_ret_probe(tu)) {
1021		entry->vaddr[0] = func;
1022		entry->vaddr[1] = instruction_pointer(regs);
1023		data = DATAOF_TRACE_ENTRY(entry, true);
1024	} else {
1025		entry->vaddr[0] = instruction_pointer(regs);
1026		data = DATAOF_TRACE_ENTRY(entry, false);
1027	}
1028
1029	memcpy(data, ucb->buf, ucb->dsize);
1030
1031	trace_event_buffer_commit(&fbuffer);
1032}
1033
1034/* uprobe handler */
1035static int uprobe_trace_func(struct trace_uprobe *tu, struct pt_regs *regs,
1036			     struct uprobe_cpu_buffer **ucbp)
1037{
1038	struct event_file_link *link;
1039	struct uprobe_cpu_buffer *ucb;
1040
1041	if (is_ret_probe(tu))
1042		return 0;
1043
1044	ucb = prepare_uprobe_buffer(tu, regs, ucbp);
1045
1046	rcu_read_lock();
1047	trace_probe_for_each_link_rcu(link, &tu->tp)
1048		__uprobe_trace_func(tu, 0, regs, ucb, link->file);
1049	rcu_read_unlock();
1050
1051	return 0;
1052}
1053
1054static void uretprobe_trace_func(struct trace_uprobe *tu, unsigned long func,
1055				 struct pt_regs *regs,
1056				 struct uprobe_cpu_buffer **ucbp)
1057{
1058	struct event_file_link *link;
1059	struct uprobe_cpu_buffer *ucb;
1060
1061	ucb = prepare_uprobe_buffer(tu, regs, ucbp);
1062
1063	rcu_read_lock();
1064	trace_probe_for_each_link_rcu(link, &tu->tp)
1065		__uprobe_trace_func(tu, func, regs, ucb, link->file);
1066	rcu_read_unlock();
1067}
1068
1069/* Event entry printers */
1070static enum print_line_t
1071print_uprobe_event(struct trace_iterator *iter, int flags, struct trace_event *event)
1072{
1073	struct uprobe_trace_entry_head *entry;
1074	struct trace_seq *s = &iter->seq;
1075	struct trace_uprobe *tu;
1076	u8 *data;
1077
1078	entry = (struct uprobe_trace_entry_head *)iter->ent;
1079	tu = trace_uprobe_primary_from_call(
1080		container_of(event, struct trace_event_call, event));
1081	if (unlikely(!tu))
1082		goto out;
1083
1084	if (is_ret_probe(tu)) {
1085		trace_seq_printf(s, "%s: (0x%lx <- 0x%lx)",
1086				 trace_probe_name(&tu->tp),
1087				 entry->vaddr[1], entry->vaddr[0]);
1088		data = DATAOF_TRACE_ENTRY(entry, true);
1089	} else {
1090		trace_seq_printf(s, "%s: (0x%lx)",
1091				 trace_probe_name(&tu->tp),
1092				 entry->vaddr[0]);
1093		data = DATAOF_TRACE_ENTRY(entry, false);
1094	}
1095
1096	if (trace_probe_print_args(s, tu->tp.args, tu->tp.nr_args, data, entry) < 0)
1097		goto out;
1098
1099	trace_seq_putc(s, '\n');
1100
1101 out:
1102	return trace_handle_return(s);
1103}
1104
1105typedef bool (*filter_func_t)(struct uprobe_consumer *self, struct mm_struct *mm);
 
 
1106
1107static int trace_uprobe_enable(struct trace_uprobe *tu, filter_func_t filter)
1108{
1109	struct inode *inode = d_real_inode(tu->path.dentry);
1110	struct uprobe *uprobe;
1111
1112	tu->consumer.filter = filter;
1113	uprobe = uprobe_register(inode, tu->offset, tu->ref_ctr_offset, &tu->consumer);
1114	if (IS_ERR(uprobe))
1115		return PTR_ERR(uprobe);
 
 
 
 
 
 
 
1116
1117	tu->uprobe = uprobe;
1118	return 0;
1119}
1120
1121static void __probe_event_disable(struct trace_probe *tp)
1122{
 
1123	struct trace_uprobe *tu;
1124	bool sync = false;
1125
1126	tu = container_of(tp, struct trace_uprobe, tp);
1127	WARN_ON(!uprobe_filter_is_empty(tu->tp.event->filter));
 
 
1128
1129	list_for_each_entry(tu, trace_probe_probe_list(tp), tp.list) {
1130		if (!tu->uprobe)
1131			continue;
1132
1133		uprobe_unregister_nosync(tu->uprobe, &tu->consumer);
1134		sync = true;
1135		tu->uprobe = NULL;
1136	}
1137	if (sync)
1138		uprobe_unregister_sync();
1139}
1140
1141static int probe_event_enable(struct trace_event_call *call,
1142			struct trace_event_file *file, filter_func_t filter)
1143{
1144	struct trace_probe *tp;
1145	struct trace_uprobe *tu;
1146	bool enabled;
1147	int ret;
1148
1149	tp = trace_probe_primary_from_call(call);
1150	if (WARN_ON_ONCE(!tp))
1151		return -ENODEV;
1152	enabled = trace_probe_is_enabled(tp);
1153
1154	/* This may also change "enabled" state */
1155	if (file) {
1156		if (trace_probe_test_flag(tp, TP_FLAG_PROFILE))
1157			return -EINTR;
1158
1159		ret = trace_probe_add_file(tp, file);
1160		if (ret < 0)
1161			return ret;
1162	} else {
1163		if (trace_probe_test_flag(tp, TP_FLAG_TRACE))
1164			return -EINTR;
1165
1166		trace_probe_set_flag(tp, TP_FLAG_PROFILE);
1167	}
1168
1169	tu = container_of(tp, struct trace_uprobe, tp);
1170	WARN_ON(!uprobe_filter_is_empty(tu->tp.event->filter));
1171
1172	if (enabled)
1173		return 0;
1174
1175	ret = uprobe_buffer_enable();
1176	if (ret)
1177		goto err_flags;
1178
1179	list_for_each_entry(tu, trace_probe_probe_list(tp), tp.list) {
 
1180		ret = trace_uprobe_enable(tu, filter);
1181		if (ret) {
1182			__probe_event_disable(tp);
1183			goto err_buffer;
1184		}
1185	}
1186
1187	return 0;
1188
1189 err_buffer:
1190	uprobe_buffer_disable();
1191
1192 err_flags:
1193	if (file)
1194		trace_probe_remove_file(tp, file);
1195	else
1196		trace_probe_clear_flag(tp, TP_FLAG_PROFILE);
1197
1198	return ret;
1199}
1200
1201static void probe_event_disable(struct trace_event_call *call,
1202				struct trace_event_file *file)
1203{
1204	struct trace_probe *tp;
1205
1206	tp = trace_probe_primary_from_call(call);
1207	if (WARN_ON_ONCE(!tp))
1208		return;
1209
1210	if (!trace_probe_is_enabled(tp))
1211		return;
1212
1213	if (file) {
1214		if (trace_probe_remove_file(tp, file) < 0)
1215			return;
1216
1217		if (trace_probe_is_enabled(tp))
1218			return;
1219	} else
1220		trace_probe_clear_flag(tp, TP_FLAG_PROFILE);
1221
1222	__probe_event_disable(tp);
1223	uprobe_buffer_disable();
1224}
1225
1226static int uprobe_event_define_fields(struct trace_event_call *event_call)
1227{
1228	int ret, size;
1229	struct uprobe_trace_entry_head field;
1230	struct trace_uprobe *tu;
1231
1232	tu = trace_uprobe_primary_from_call(event_call);
1233	if (unlikely(!tu))
1234		return -ENODEV;
1235
1236	if (is_ret_probe(tu)) {
1237		DEFINE_FIELD(unsigned long, vaddr[0], FIELD_STRING_FUNC, 0);
1238		DEFINE_FIELD(unsigned long, vaddr[1], FIELD_STRING_RETIP, 0);
1239		size = SIZEOF_TRACE_ENTRY(true);
1240	} else {
1241		DEFINE_FIELD(unsigned long, vaddr[0], FIELD_STRING_IP, 0);
1242		size = SIZEOF_TRACE_ENTRY(false);
1243	}
1244
1245	return traceprobe_define_arg_fields(event_call, size, &tu->tp);
1246}
1247
1248#ifdef CONFIG_PERF_EVENTS
1249static bool
1250__uprobe_perf_filter(struct trace_uprobe_filter *filter, struct mm_struct *mm)
1251{
1252	struct perf_event *event;
1253
 
 
 
1254	list_for_each_entry(event, &filter->perf_events, hw.tp_list) {
1255		if (event->hw.target->mm == mm)
1256			return true;
1257	}
1258
1259	return false;
1260}
1261
1262static inline bool
1263trace_uprobe_filter_event(struct trace_uprobe_filter *filter,
1264			  struct perf_event *event)
1265{
1266	return __uprobe_perf_filter(filter, event->hw.target->mm);
1267}
1268
1269static bool trace_uprobe_filter_remove(struct trace_uprobe_filter *filter,
1270				       struct perf_event *event)
1271{
1272	bool done;
1273
1274	write_lock(&filter->rwlock);
1275	if (event->hw.target) {
1276		list_del(&event->hw.tp_list);
1277		done = filter->nr_systemwide ||
1278			(event->hw.target->flags & PF_EXITING) ||
1279			trace_uprobe_filter_event(filter, event);
1280	} else {
1281		filter->nr_systemwide--;
1282		done = filter->nr_systemwide;
1283	}
1284	write_unlock(&filter->rwlock);
1285
1286	return done;
 
 
 
1287}
1288
1289/* This returns true if the filter always covers target mm */
1290static bool trace_uprobe_filter_add(struct trace_uprobe_filter *filter,
1291				    struct perf_event *event)
1292{
1293	bool done;
 
1294
1295	write_lock(&filter->rwlock);
1296	if (event->hw.target) {
1297		/*
1298		 * event->parent != NULL means copy_process(), we can avoid
1299		 * uprobe_apply(). current->mm must be probed and we can rely
1300		 * on dup_mmap() which preserves the already installed bp's.
1301		 *
1302		 * attr.enable_on_exec means that exec/mmap will install the
1303		 * breakpoints we need.
1304		 */
1305		done = filter->nr_systemwide ||
1306			event->parent || event->attr.enable_on_exec ||
1307			trace_uprobe_filter_event(filter, event);
1308		list_add(&event->hw.tp_list, &filter->perf_events);
1309	} else {
1310		done = filter->nr_systemwide;
1311		filter->nr_systemwide++;
1312	}
1313	write_unlock(&filter->rwlock);
1314
1315	return done;
 
 
 
 
 
 
1316}
1317
1318static int uprobe_perf_close(struct trace_event_call *call,
1319			     struct perf_event *event)
 
1320{
1321	struct trace_probe *tp;
1322	struct trace_uprobe *tu;
1323	int ret = 0;
1324
1325	tp = trace_probe_primary_from_call(call);
1326	if (WARN_ON_ONCE(!tp))
1327		return -ENODEV;
1328
1329	tu = container_of(tp, struct trace_uprobe, tp);
1330	if (trace_uprobe_filter_remove(tu->tp.event->filter, event))
1331		return 0;
1332
1333	list_for_each_entry(tu, trace_probe_probe_list(tp), tp.list) {
1334		ret = uprobe_apply(tu->uprobe, &tu->consumer, false);
1335		if (ret)
1336			break;
1337	}
1338
1339	return ret;
1340}
1341
1342static int uprobe_perf_open(struct trace_event_call *call,
1343			    struct perf_event *event)
1344{
1345	struct trace_probe *tp;
1346	struct trace_uprobe *tu;
1347	int err = 0;
1348
1349	tp = trace_probe_primary_from_call(call);
1350	if (WARN_ON_ONCE(!tp))
1351		return -ENODEV;
1352
1353	tu = container_of(tp, struct trace_uprobe, tp);
1354	if (trace_uprobe_filter_add(tu->tp.event->filter, event))
1355		return 0;
1356
1357	list_for_each_entry(tu, trace_probe_probe_list(tp), tp.list) {
1358		err = uprobe_apply(tu->uprobe, &tu->consumer, true);
1359		if (err) {
1360			uprobe_perf_close(call, event);
1361			break;
1362		}
1363	}
1364
1365	return err;
1366}
1367
1368static bool uprobe_perf_filter(struct uprobe_consumer *uc, struct mm_struct *mm)
1369{
1370	struct trace_uprobe_filter *filter;
1371	struct trace_uprobe *tu;
1372	int ret;
1373
1374	tu = container_of(uc, struct trace_uprobe, consumer);
1375	filter = tu->tp.event->filter;
1376
1377	/*
1378	 * speculative short-circuiting check to avoid unnecessarily taking
1379	 * filter->rwlock below, if the uprobe has system-wide consumer
1380	 */
1381	if (READ_ONCE(filter->nr_systemwide))
1382		return true;
1383
1384	read_lock(&filter->rwlock);
1385	ret = __uprobe_perf_filter(filter, mm);
1386	read_unlock(&filter->rwlock);
1387
1388	return ret;
1389}
1390
1391static void __uprobe_perf_func(struct trace_uprobe *tu,
1392			       unsigned long func, struct pt_regs *regs,
1393			       struct uprobe_cpu_buffer **ucbp)
1394{
1395	struct trace_event_call *call = trace_probe_event_call(&tu->tp);
1396	struct uprobe_trace_entry_head *entry;
1397	struct uprobe_cpu_buffer *ucb;
1398	struct hlist_head *head;
1399	void *data;
1400	int size, esize;
1401	int rctx;
1402
1403#ifdef CONFIG_BPF_EVENTS
1404	if (bpf_prog_array_valid(call)) {
1405		const struct bpf_prog_array *array;
1406		u32 ret;
1407
1408		rcu_read_lock_trace();
1409		array = rcu_dereference_check(call->prog_array, rcu_read_lock_trace_held());
1410		ret = bpf_prog_run_array_uprobe(array, regs, bpf_prog_run);
1411		rcu_read_unlock_trace();
1412		if (!ret)
1413			return;
1414	}
1415#endif /* CONFIG_BPF_EVENTS */
1416
1417	esize = SIZEOF_TRACE_ENTRY(is_ret_probe(tu));
1418
1419	ucb = prepare_uprobe_buffer(tu, regs, ucbp);
1420	size = esize + ucb->dsize;
1421	size = ALIGN(size + sizeof(u32), sizeof(u64)) - sizeof(u32);
1422	if (WARN_ONCE(size > PERF_MAX_TRACE_SIZE, "profile buffer not large enough"))
1423		return;
1424
1425	preempt_disable();
1426	head = this_cpu_ptr(call->perf_events);
1427	if (hlist_empty(head))
1428		goto out;
1429
1430	entry = perf_trace_buf_alloc(size, NULL, &rctx);
1431	if (!entry)
1432		goto out;
1433
1434	if (is_ret_probe(tu)) {
1435		entry->vaddr[0] = func;
1436		entry->vaddr[1] = instruction_pointer(regs);
1437		data = DATAOF_TRACE_ENTRY(entry, true);
1438	} else {
1439		entry->vaddr[0] = instruction_pointer(regs);
1440		data = DATAOF_TRACE_ENTRY(entry, false);
1441	}
1442
1443	memcpy(data, ucb->buf, ucb->dsize);
1444
1445	if (size - esize > ucb->dsize)
1446		memset(data + ucb->dsize, 0, size - esize - ucb->dsize);
 
 
 
1447
1448	perf_trace_buf_submit(entry, size, rctx, call->event.type, 1, regs,
1449			      head, NULL);
1450 out:
1451	preempt_enable();
1452}
1453
1454/* uprobe profile handler */
1455static int uprobe_perf_func(struct trace_uprobe *tu, struct pt_regs *regs,
1456			    struct uprobe_cpu_buffer **ucbp)
1457{
1458	if (!uprobe_perf_filter(&tu->consumer, current->mm))
1459		return UPROBE_HANDLER_REMOVE;
1460
1461	if (!is_ret_probe(tu))
1462		__uprobe_perf_func(tu, 0, regs, ucbp);
1463	return 0;
1464}
1465
1466static void uretprobe_perf_func(struct trace_uprobe *tu, unsigned long func,
1467				struct pt_regs *regs,
1468				struct uprobe_cpu_buffer **ucbp)
1469{
1470	__uprobe_perf_func(tu, func, regs, ucbp);
1471}
1472
1473int bpf_get_uprobe_info(const struct perf_event *event, u32 *fd_type,
1474			const char **filename, u64 *probe_offset,
1475			u64 *probe_addr, bool perf_type_tracepoint)
1476{
1477	const char *pevent = trace_event_name(event->tp_event);
1478	const char *group = event->tp_event->class->system;
1479	struct trace_uprobe *tu;
1480
1481	if (perf_type_tracepoint)
1482		tu = find_probe_event(pevent, group);
1483	else
1484		tu = trace_uprobe_primary_from_call(event->tp_event);
1485	if (!tu)
1486		return -EINVAL;
1487
1488	*fd_type = is_ret_probe(tu) ? BPF_FD_TYPE_URETPROBE
1489				    : BPF_FD_TYPE_UPROBE;
1490	*filename = tu->filename;
1491	*probe_offset = tu->offset;
1492	*probe_addr = 0;
1493	return 0;
1494}
1495#endif	/* CONFIG_PERF_EVENTS */
1496
1497static int
1498trace_uprobe_register(struct trace_event_call *event, enum trace_reg type,
1499		      void *data)
1500{
1501	struct trace_event_file *file = data;
1502
1503	switch (type) {
1504	case TRACE_REG_REGISTER:
1505		return probe_event_enable(event, file, NULL);
1506
1507	case TRACE_REG_UNREGISTER:
1508		probe_event_disable(event, file);
1509		return 0;
1510
1511#ifdef CONFIG_PERF_EVENTS
1512	case TRACE_REG_PERF_REGISTER:
1513		return probe_event_enable(event, NULL, uprobe_perf_filter);
1514
1515	case TRACE_REG_PERF_UNREGISTER:
1516		probe_event_disable(event, NULL);
1517		return 0;
1518
1519	case TRACE_REG_PERF_OPEN:
1520		return uprobe_perf_open(event, data);
1521
1522	case TRACE_REG_PERF_CLOSE:
1523		return uprobe_perf_close(event, data);
1524
1525#endif
1526	default:
1527		return 0;
1528	}
 
1529}
1530
1531static int uprobe_dispatcher(struct uprobe_consumer *con, struct pt_regs *regs,
1532			     __u64 *data)
1533{
1534	struct trace_uprobe *tu;
1535	struct uprobe_dispatch_data udd;
1536	struct uprobe_cpu_buffer *ucb = NULL;
 
1537	int ret = 0;
1538
 
1539	tu = container_of(con, struct trace_uprobe, consumer);
1540
1541	this_cpu_inc(*tu->nhits);
1542
1543	udd.tu = tu;
1544	udd.bp_addr = instruction_pointer(regs);
1545
1546	current->utask->vaddr = (unsigned long) &udd;
1547
1548	if (WARN_ON_ONCE(!uprobe_cpu_buffer))
1549		return 0;
1550
 
 
 
 
 
 
1551	if (trace_probe_test_flag(&tu->tp, TP_FLAG_TRACE))
1552		ret |= uprobe_trace_func(tu, regs, &ucb);
1553
1554#ifdef CONFIG_PERF_EVENTS
1555	if (trace_probe_test_flag(&tu->tp, TP_FLAG_PROFILE))
1556		ret |= uprobe_perf_func(tu, regs, &ucb);
1557#endif
1558	uprobe_buffer_put(ucb);
1559	return ret;
1560}
1561
1562static int uretprobe_dispatcher(struct uprobe_consumer *con,
1563				unsigned long func, struct pt_regs *regs,
1564				__u64 *data)
1565{
1566	struct trace_uprobe *tu;
1567	struct uprobe_dispatch_data udd;
1568	struct uprobe_cpu_buffer *ucb = NULL;
 
1569
1570	tu = container_of(con, struct trace_uprobe, consumer);
1571
1572	udd.tu = tu;
1573	udd.bp_addr = func;
1574
1575	current->utask->vaddr = (unsigned long) &udd;
1576
1577	if (WARN_ON_ONCE(!uprobe_cpu_buffer))
1578		return 0;
1579
 
 
 
 
 
 
1580	if (trace_probe_test_flag(&tu->tp, TP_FLAG_TRACE))
1581		uretprobe_trace_func(tu, func, regs, &ucb);
1582
1583#ifdef CONFIG_PERF_EVENTS
1584	if (trace_probe_test_flag(&tu->tp, TP_FLAG_PROFILE))
1585		uretprobe_perf_func(tu, func, regs, &ucb);
1586#endif
1587	uprobe_buffer_put(ucb);
1588	return 0;
1589}
1590
1591static struct trace_event_functions uprobe_funcs = {
1592	.trace		= print_uprobe_event
1593};
1594
1595static struct trace_event_fields uprobe_fields_array[] = {
1596	{ .type = TRACE_FUNCTION_TYPE,
1597	  .define_fields = uprobe_event_define_fields },
1598	{}
1599};
1600
1601static inline void init_trace_event_call(struct trace_uprobe *tu)
1602{
1603	struct trace_event_call *call = trace_probe_event_call(&tu->tp);
 
1604	call->event.funcs = &uprobe_funcs;
1605	call->class->fields_array = uprobe_fields_array;
1606
1607	call->flags = TRACE_EVENT_FL_UPROBE | TRACE_EVENT_FL_CAP_ANY;
1608	call->class->reg = trace_uprobe_register;
1609}
1610
1611static int register_uprobe_event(struct trace_uprobe *tu)
1612{
1613	init_trace_event_call(tu);
1614
1615	return trace_probe_register_event_call(&tu->tp);
1616}
1617
1618static int unregister_uprobe_event(struct trace_uprobe *tu)
1619{
1620	return trace_probe_unregister_event_call(&tu->tp);
1621}
1622
1623#ifdef CONFIG_PERF_EVENTS
1624struct trace_event_call *
1625create_local_trace_uprobe(char *name, unsigned long offs,
1626			  unsigned long ref_ctr_offset, bool is_return)
1627{
1628	enum probe_print_type ptype;
1629	struct trace_uprobe *tu;
1630	struct path path;
1631	int ret;
1632
1633	ret = kern_path(name, LOOKUP_FOLLOW, &path);
1634	if (ret)
1635		return ERR_PTR(ret);
1636
1637	if (!d_is_reg(path.dentry)) {
1638		path_put(&path);
1639		return ERR_PTR(-EINVAL);
1640	}
1641
1642	/*
1643	 * local trace_kprobes are not added to dyn_event, so they are never
1644	 * searched in find_trace_kprobe(). Therefore, there is no concern of
1645	 * duplicated name "DUMMY_EVENT" here.
1646	 */
1647	tu = alloc_trace_uprobe(UPROBE_EVENT_SYSTEM, "DUMMY_EVENT", 0,
1648				is_return);
1649
1650	if (IS_ERR(tu)) {
1651		pr_info("Failed to allocate trace_uprobe.(%d)\n",
1652			(int)PTR_ERR(tu));
1653		path_put(&path);
1654		return ERR_CAST(tu);
1655	}
1656
1657	tu->offset = offs;
1658	tu->path = path;
1659	tu->ref_ctr_offset = ref_ctr_offset;
1660	tu->filename = kstrdup(name, GFP_KERNEL);
1661	if (!tu->filename) {
1662		ret = -ENOMEM;
1663		goto error;
1664	}
1665
1666	init_trace_event_call(tu);
1667
1668	ptype = is_ret_probe(tu) ? PROBE_PRINT_RETURN : PROBE_PRINT_NORMAL;
1669	if (traceprobe_set_print_fmt(&tu->tp, ptype) < 0) {
1670		ret = -ENOMEM;
1671		goto error;
1672	}
1673
1674	return trace_probe_event_call(&tu->tp);
1675error:
1676	free_trace_uprobe(tu);
1677	return ERR_PTR(ret);
1678}
1679
1680void destroy_local_trace_uprobe(struct trace_event_call *event_call)
1681{
1682	struct trace_uprobe *tu;
1683
1684	tu = trace_uprobe_primary_from_call(event_call);
1685
1686	free_trace_uprobe(tu);
1687}
1688#endif /* CONFIG_PERF_EVENTS */
1689
1690/* Make a trace interface for controlling probe points */
1691static __init int init_uprobe_trace(void)
1692{
 
1693	int ret;
1694
1695	ret = dyn_event_register(&trace_uprobe_ops);
1696	if (ret)
1697		return ret;
1698
1699	ret = tracing_init_dentry();
1700	if (ret)
1701		return 0;
1702
1703	trace_create_file("uprobe_events", TRACE_MODE_WRITE, NULL,
1704				    NULL, &uprobe_events_ops);
1705	/* Profile interface */
1706	trace_create_file("uprobe_profile", TRACE_MODE_READ, NULL,
1707				    NULL, &uprobe_profile_ops);
1708	return 0;
1709}
1710
1711fs_initcall(init_uprobe_trace);