trace_syscalls.c 15 KB
Newer Older
1
#include <trace/syscall.h>
2
#include <trace/events/syscalls.h>
3
#include <linux/kernel.h>
4
#include <linux/ftrace.h>
5
#include <linux/perf_event.h>
6 7 8 9 10
#include <asm/syscall.h>

#include "trace_output.h"
#include "trace.h"

11
static DEFINE_MUTEX(syscall_trace_lock);
12 13
static int sys_refcount_enter;
static int sys_refcount_exit;
14 15
static DECLARE_BITMAP(enabled_enter_syscalls, NR_syscalls);
static DECLARE_BITMAP(enabled_exit_syscalls, NR_syscalls);
16

17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
extern unsigned long __start_syscalls_metadata[];
extern unsigned long __stop_syscalls_metadata[];

static struct syscall_metadata **syscalls_metadata;

static struct syscall_metadata *find_syscall_meta(unsigned long syscall)
{
	struct syscall_metadata *start;
	struct syscall_metadata *stop;
	char str[KSYM_SYMBOL_LEN];


	start = (struct syscall_metadata *)__start_syscalls_metadata;
	stop = (struct syscall_metadata *)__stop_syscalls_metadata;
	kallsyms_lookup(syscall, NULL, NULL, NULL, str);

	for ( ; start < stop; start++) {
		/*
		 * Only compare after the "sys" prefix. Archs that use
		 * syscall wrappers may have syscalls symbols aliases prefixed
		 * with "SyS" instead of "sys", leading to an unwanted
		 * mismatch.
		 */
		if (start->name && !strcmp(start->name + 3, str + 3))
			return start;
	}
	return NULL;
}

static struct syscall_metadata *syscall_nr_to_meta(int nr)
{
	if (!syscalls_metadata || nr >= NR_syscalls || nr < 0)
		return NULL;

	return syscalls_metadata[nr];
}

54 55 56 57 58 59 60 61 62
enum print_line_t
print_syscall_enter(struct trace_iterator *iter, int flags)
{
	struct trace_seq *s = &iter->seq;
	struct trace_entry *ent = iter->ent;
	struct syscall_trace_enter *trace;
	struct syscall_metadata *entry;
	int i, ret, syscall;

63
	trace = (typeof(trace))ent;
64 65
	syscall = trace->nr;
	entry = syscall_nr_to_meta(syscall);
66

67 68 69
	if (!entry)
		goto end;

70
	if (entry->enter_event->id != ent->type) {
71 72 73 74
		WARN_ON_ONCE(1);
		goto end;
	}

75 76 77 78 79 80
	ret = trace_seq_printf(s, "%s(", entry->name);
	if (!ret)
		return TRACE_TYPE_PARTIAL_LINE;

	for (i = 0; i < entry->nb_args; i++) {
		/* parameter types */
81
		if (trace_flags & TRACE_ITER_VERBOSE) {
82 83 84 85 86
			ret = trace_seq_printf(s, "%s ", entry->types[i]);
			if (!ret)
				return TRACE_TYPE_PARTIAL_LINE;
		}
		/* parameter values */
87
		ret = trace_seq_printf(s, "%s: %lx%s", entry->args[i],
88
				       trace->args[i],
89
				       i == entry->nb_args - 1 ? "" : ", ");
90 91 92 93
		if (!ret)
			return TRACE_TYPE_PARTIAL_LINE;
	}

94 95 96 97
	ret = trace_seq_putc(s, ')');
	if (!ret)
		return TRACE_TYPE_PARTIAL_LINE;

98
end:
99 100 101 102
	ret =  trace_seq_putc(s, '\n');
	if (!ret)
		return TRACE_TYPE_PARTIAL_LINE;

103 104 105 106 107 108 109 110 111 112 113 114 115
	return TRACE_TYPE_HANDLED;
}

enum print_line_t
print_syscall_exit(struct trace_iterator *iter, int flags)
{
	struct trace_seq *s = &iter->seq;
	struct trace_entry *ent = iter->ent;
	struct syscall_trace_exit *trace;
	int syscall;
	struct syscall_metadata *entry;
	int ret;

116
	trace = (typeof(trace))ent;
117 118
	syscall = trace->nr;
	entry = syscall_nr_to_meta(syscall);
119

120 121 122 123 124
	if (!entry) {
		trace_seq_printf(s, "\n");
		return TRACE_TYPE_HANDLED;
	}

125
	if (entry->exit_event->id != ent->type) {
126 127 128 129
		WARN_ON_ONCE(1);
		return TRACE_TYPE_UNHANDLED;
	}

130 131 132 133 134 135 136 137
	ret = trace_seq_printf(s, "%s -> 0x%lx\n", entry->name,
				trace->ret);
	if (!ret)
		return TRACE_TYPE_PARTIAL_LINE;

	return TRACE_TYPE_HANDLED;
}

138 139 140 141 142
extern char *__bad_type_size(void);

#define SYSCALL_FIELD(type, name)					\
	sizeof(type) != sizeof(trace.name) ?				\
		__bad_type_size() :					\
143 144
		#type, #name, offsetof(typeof(trace), name),		\
		sizeof(trace.name), is_signed_type(type)
145

146
int syscall_enter_format(struct ftrace_event_call *call, struct trace_seq *s)
147 148
{
	int i;
149
	int ret;
150
	struct syscall_metadata *entry = call->data;
151 152
	struct syscall_trace_enter trace;
	int offset = offsetof(struct syscall_trace_enter, args);
153

154 155
	ret = trace_seq_printf(s, "\tfield:%s %s;\toffset:%zu;\tsize:%zu;"
			       "\tsigned:%u;\n",
156 157 158
			       SYSCALL_FIELD(int, nr));
	if (!ret)
		return 0;
159 160 161 162 163 164

	for (i = 0; i < entry->nb_args; i++) {
		ret = trace_seq_printf(s, "\tfield:%s %s;", entry->types[i],
				        entry->args[i]);
		if (!ret)
			return 0;
165 166 167 168
		ret = trace_seq_printf(s, "\toffset:%d;\tsize:%zu;"
				       "\tsigned:%u;\n", offset,
				       sizeof(unsigned long),
				       is_signed_type(unsigned long));
169 170 171 172 173
		if (!ret)
			return 0;
		offset += sizeof(unsigned long);
	}

174
	trace_seq_puts(s, "\nprint fmt: \"");
175
	for (i = 0; i < entry->nb_args; i++) {
176
		ret = trace_seq_printf(s, "%s: 0x%%0%zulx%s", entry->args[i],
177
				        sizeof(unsigned long),
178
					i == entry->nb_args - 1 ? "" : ", ");
179 180 181
		if (!ret)
			return 0;
	}
182
	trace_seq_putc(s, '"');
183 184

	for (i = 0; i < entry->nb_args; i++) {
185 186
		ret = trace_seq_printf(s, ", ((unsigned long)(REC->%s))",
				       entry->args[i]);
187 188 189 190
		if (!ret)
			return 0;
	}

191
	return trace_seq_putc(s, '\n');
192 193
}

194 195 196 197 198 199
int syscall_exit_format(struct ftrace_event_call *call, struct trace_seq *s)
{
	int ret;
	struct syscall_trace_exit trace;

	ret = trace_seq_printf(s,
200 201 202 203
			       "\tfield:%s %s;\toffset:%zu;\tsize:%zu;"
			       "\tsigned:%u;\n"
			       "\tfield:%s %s;\toffset:%zu;\tsize:%zu;"
			       "\tsigned:%u;\n",
204
			       SYSCALL_FIELD(int, nr),
205
			       SYSCALL_FIELD(long, ret));
206 207 208 209 210 211
	if (!ret)
		return 0;

	return trace_seq_printf(s, "\nprint fmt: \"0x%%lx\", REC->ret\n");
}

212 213 214
int syscall_enter_define_fields(struct ftrace_event_call *call)
{
	struct syscall_trace_enter trace;
215
	struct syscall_metadata *meta = call->data;
216 217 218 219
	int ret;
	int i;
	int offset = offsetof(typeof(trace), args);

220 221 222 223
	ret = trace_define_field(call, SYSCALL_FIELD(int, nr), FILTER_OTHER);
	if (ret)
		return ret;

224
	for (i = 0; i < meta->nb_args; i++) {
225 226
		ret = trace_define_field(call, meta->types[i],
					 meta->args[i], offset,
227 228
					 sizeof(unsigned long), 0,
					 FILTER_OTHER);
229 230 231 232 233 234 235 236 237 238 239
		offset += sizeof(unsigned long);
	}

	return ret;
}

int syscall_exit_define_fields(struct ftrace_event_call *call)
{
	struct syscall_trace_exit trace;
	int ret;

240 241 242 243
	ret = trace_define_field(call, SYSCALL_FIELD(int, nr), FILTER_OTHER);
	if (ret)
		return ret;

244
	ret = trace_define_field(call, SYSCALL_FIELD(long, ret),
245
				 FILTER_OTHER);
246 247 248 249

	return ret;
}

250
void ftrace_syscall_enter(struct pt_regs *regs, long id)
251
{
252 253 254
	struct syscall_trace_enter *entry;
	struct syscall_metadata *sys_data;
	struct ring_buffer_event *event;
255
	struct ring_buffer *buffer;
256
	int size;
257 258 259
	int syscall_nr;

	syscall_nr = syscall_get_nr(current, regs);
260 261
	if (syscall_nr < 0)
		return;
262 263
	if (!test_bit(syscall_nr, enabled_enter_syscalls))
		return;
264

265 266 267 268 269 270
	sys_data = syscall_nr_to_meta(syscall_nr);
	if (!sys_data)
		return;

	size = sizeof(*entry) + sizeof(unsigned long) * sys_data->nb_args;

271 272
	event = trace_current_buffer_lock_reserve(&buffer,
			sys_data->enter_event->id, size, 0, 0);
273 274 275 276 277 278 279
	if (!event)
		return;

	entry = ring_buffer_event_data(event);
	entry->nr = syscall_nr;
	syscall_get_arguments(current, regs, 0, sys_data->nb_args, entry->args);

280 281 282
	if (!filter_current_check_discard(buffer, sys_data->enter_event,
					  entry, event))
		trace_current_buffer_unlock_commit(buffer, event, 0, 0);
283 284
}

285
void ftrace_syscall_exit(struct pt_regs *regs, long ret)
286
{
287 288 289
	struct syscall_trace_exit *entry;
	struct syscall_metadata *sys_data;
	struct ring_buffer_event *event;
290
	struct ring_buffer *buffer;
291 292 293
	int syscall_nr;

	syscall_nr = syscall_get_nr(current, regs);
294 295
	if (syscall_nr < 0)
		return;
296 297
	if (!test_bit(syscall_nr, enabled_exit_syscalls))
		return;
298

299 300 301 302
	sys_data = syscall_nr_to_meta(syscall_nr);
	if (!sys_data)
		return;

303 304
	event = trace_current_buffer_lock_reserve(&buffer,
			sys_data->exit_event->id, sizeof(*entry), 0, 0);
305 306 307 308 309 310 311
	if (!event)
		return;

	entry = ring_buffer_event_data(event);
	entry->nr = syscall_nr;
	entry->ret = syscall_get_return_value(current, regs);

312 313 314
	if (!filter_current_check_discard(buffer, sys_data->exit_event,
					  entry, event))
		trace_current_buffer_unlock_commit(buffer, event, 0, 0);
315 316
}

317
int reg_event_syscall_enter(struct ftrace_event_call *call)
318
{
319 320 321
	int ret = 0;
	int num;

322
	num = ((struct syscall_metadata *)call->data)->syscall_nr;
323
	if (num < 0 || num >= NR_syscalls)
324 325 326
		return -ENOSYS;
	mutex_lock(&syscall_trace_lock);
	if (!sys_refcount_enter)
327
		ret = register_trace_sys_enter(ftrace_syscall_enter);
328 329 330 331 332 333 334 335 336
	if (ret) {
		pr_info("event trace: Could not activate"
				"syscall entry trace point");
	} else {
		set_bit(num, enabled_enter_syscalls);
		sys_refcount_enter++;
	}
	mutex_unlock(&syscall_trace_lock);
	return ret;
337 338
}

339
void unreg_event_syscall_enter(struct ftrace_event_call *call)
340
{
341
	int num;
342

343
	num = ((struct syscall_metadata *)call->data)->syscall_nr;
344
	if (num < 0 || num >= NR_syscalls)
345 346 347 348 349
		return;
	mutex_lock(&syscall_trace_lock);
	sys_refcount_enter--;
	clear_bit(num, enabled_enter_syscalls);
	if (!sys_refcount_enter)
350
		unregister_trace_sys_enter(ftrace_syscall_enter);
351 352
	mutex_unlock(&syscall_trace_lock);
}
353

354
int reg_event_syscall_exit(struct ftrace_event_call *call)
355
{
356 357 358
	int ret = 0;
	int num;

359
	num = ((struct syscall_metadata *)call->data)->syscall_nr;
360
	if (num < 0 || num >= NR_syscalls)
361 362 363
		return -ENOSYS;
	mutex_lock(&syscall_trace_lock);
	if (!sys_refcount_exit)
364
		ret = register_trace_sys_exit(ftrace_syscall_exit);
365 366 367 368 369 370
	if (ret) {
		pr_info("event trace: Could not activate"
				"syscall exit trace point");
	} else {
		set_bit(num, enabled_exit_syscalls);
		sys_refcount_exit++;
371
	}
372 373 374
	mutex_unlock(&syscall_trace_lock);
	return ret;
}
375

376
void unreg_event_syscall_exit(struct ftrace_event_call *call)
377 378
{
	int num;
379

380
	num = ((struct syscall_metadata *)call->data)->syscall_nr;
381
	if (num < 0 || num >= NR_syscalls)
382 383 384 385 386
		return;
	mutex_lock(&syscall_trace_lock);
	sys_refcount_exit--;
	clear_bit(num, enabled_exit_syscalls);
	if (!sys_refcount_exit)
387
		unregister_trace_sys_exit(ftrace_syscall_exit);
388
	mutex_unlock(&syscall_trace_lock);
389
}
390

391 392 393 394 395 396 397 398 399 400 401 402
int init_syscall_trace(struct ftrace_event_call *call)
{
	int id;

	id = register_ftrace_event(call->event);
	if (!id)
		return -ENODEV;
	call->id = id;
	INIT_LIST_HEAD(&call->fields);
	return 0;
}

403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
int __init init_ftrace_syscalls(void)
{
	struct syscall_metadata *meta;
	unsigned long addr;
	int i;

	syscalls_metadata = kzalloc(sizeof(*syscalls_metadata) *
					NR_syscalls, GFP_KERNEL);
	if (!syscalls_metadata) {
		WARN_ON(1);
		return -ENOMEM;
	}

	for (i = 0; i < NR_syscalls; i++) {
		addr = arch_syscall_addr(i);
		meta = find_syscall_meta(addr);
419 420 421 422
		if (!meta)
			continue;

		meta->syscall_nr = i;
423 424 425 426 427 428 429
		syscalls_metadata[i] = meta;
	}

	return 0;
}
core_initcall(init_ftrace_syscalls);

430
#ifdef CONFIG_EVENT_PROFILE
431

432 433
static DECLARE_BITMAP(enabled_prof_enter_syscalls, NR_syscalls);
static DECLARE_BITMAP(enabled_prof_exit_syscalls, NR_syscalls);
434 435 436 437 438 439
static int sys_prof_refcount_enter;
static int sys_prof_refcount_exit;

static void prof_syscall_enter(struct pt_regs *regs, long id)
{
	struct syscall_metadata *sys_data;
440 441
	struct syscall_trace_enter *rec;
	unsigned long flags;
442
	char *trace_buf;
443
	char *raw_data;
444
	int syscall_nr;
445
	int rctx;
446
	int size;
447
	int cpu;
448 449 450 451 452 453 454 455 456

	syscall_nr = syscall_get_nr(current, regs);
	if (!test_bit(syscall_nr, enabled_prof_enter_syscalls))
		return;

	sys_data = syscall_nr_to_meta(syscall_nr);
	if (!sys_data)
		return;

457 458 459 460 461
	/* get the size after alignment with the u32 buffer size field */
	size = sizeof(unsigned long) * sys_data->nb_args + sizeof(*rec);
	size = ALIGN(size + sizeof(u32), sizeof(u64));
	size -= sizeof(u32);

462 463 464 465 466 467
	if (WARN_ONCE(size > FTRACE_MAX_PROFILE_SIZE,
		      "profile buffer not large enough"))
		return;

	/* Protect the per cpu buffer, begin the rcu read side */
	local_irq_save(flags);
468

469 470
	rctx = perf_swevent_get_recursion_context();
	if (rctx < 0)
471 472
		goto end_recursion;

473 474
	cpu = smp_processor_id();

475
	trace_buf = rcu_dereference(perf_trace_buf);
476

477
	if (!trace_buf)
478
		goto end;
479

480
	raw_data = per_cpu_ptr(trace_buf, cpu);
481 482 483 484 485 486

	/* zero the dead bytes from align to not leak stack to user */
	*(u64 *)(&raw_data[size - sizeof(u64)]) = 0ULL;

	rec = (struct syscall_trace_enter *) raw_data;
	tracing_generic_entry_update(&rec->ent, 0, 0);
487
	rec->ent.type = sys_data->enter_event->id;
488 489 490
	rec->nr = syscall_nr;
	syscall_get_arguments(current, regs, 0, sys_data->nb_args,
			       (unsigned long *)&rec->args);
491
	perf_tp_event(sys_data->enter_event->id, 0, 1, rec, size);
492 493

end:
494
	perf_swevent_put_recursion_context(rctx);
495
end_recursion:
496
	local_irq_restore(flags);
497 498
}

499
int prof_sysenter_enable(struct ftrace_event_call *call)
500 501 502 503
{
	int ret = 0;
	int num;

504
	num = ((struct syscall_metadata *)call->data)->syscall_nr;
505 506 507

	mutex_lock(&syscall_trace_lock);
	if (!sys_prof_refcount_enter)
508
		ret = register_trace_sys_enter(prof_syscall_enter);
509 510 511 512 513 514 515 516 517 518 519
	if (ret) {
		pr_info("event trace: Could not activate"
				"syscall entry trace point");
	} else {
		set_bit(num, enabled_prof_enter_syscalls);
		sys_prof_refcount_enter++;
	}
	mutex_unlock(&syscall_trace_lock);
	return ret;
}

520
void prof_sysenter_disable(struct ftrace_event_call *call)
521 522 523
{
	int num;

524
	num = ((struct syscall_metadata *)call->data)->syscall_nr;
525 526 527 528 529

	mutex_lock(&syscall_trace_lock);
	sys_prof_refcount_enter--;
	clear_bit(num, enabled_prof_enter_syscalls);
	if (!sys_prof_refcount_enter)
530
		unregister_trace_sys_enter(prof_syscall_enter);
531 532 533 534 535 536
	mutex_unlock(&syscall_trace_lock);
}

static void prof_syscall_exit(struct pt_regs *regs, long ret)
{
	struct syscall_metadata *sys_data;
537 538
	struct syscall_trace_exit *rec;
	unsigned long flags;
539
	int syscall_nr;
540
	char *trace_buf;
541
	char *raw_data;
542
	int rctx;
543 544
	int size;
	int cpu;
545 546 547 548 549 550 551 552 553

	syscall_nr = syscall_get_nr(current, regs);
	if (!test_bit(syscall_nr, enabled_prof_exit_syscalls))
		return;

	sys_data = syscall_nr_to_meta(syscall_nr);
	if (!sys_data)
		return;

554 555 556
	/* We can probably do that at build time */
	size = ALIGN(sizeof(*rec) + sizeof(u32), sizeof(u64));
	size -= sizeof(u32);
557

558 559 560 561 562 563 564 565 566 567
	/*
	 * Impossible, but be paranoid with the future
	 * How to put this check outside runtime?
	 */
	if (WARN_ONCE(size > FTRACE_MAX_PROFILE_SIZE,
		"exit event has grown above profile buffer size"))
		return;

	/* Protect the per cpu buffer, begin the rcu read side */
	local_irq_save(flags);
568

569 570
	rctx = perf_swevent_get_recursion_context();
	if (rctx < 0)
571 572
		goto end_recursion;

573 574
	cpu = smp_processor_id();

575
	trace_buf = rcu_dereference(perf_trace_buf);
576

577
	if (!trace_buf)
578 579
		goto end;

580
	raw_data = per_cpu_ptr(trace_buf, cpu);
581 582 583 584 585 586 587

	/* zero the dead bytes from align to not leak stack to user */
	*(u64 *)(&raw_data[size - sizeof(u64)]) = 0ULL;

	rec = (struct syscall_trace_exit *)raw_data;

	tracing_generic_entry_update(&rec->ent, 0, 0);
588
	rec->ent.type = sys_data->exit_event->id;
589 590 591
	rec->nr = syscall_nr;
	rec->ret = syscall_get_return_value(current, regs);

592
	perf_tp_event(sys_data->exit_event->id, 0, 1, rec, size);
593 594

end:
595
	perf_swevent_put_recursion_context(rctx);
596
end_recursion:
597
	local_irq_restore(flags);
598 599
}

600
int prof_sysexit_enable(struct ftrace_event_call *call)
601 602 603 604
{
	int ret = 0;
	int num;

605
	num = ((struct syscall_metadata *)call->data)->syscall_nr;
606 607 608

	mutex_lock(&syscall_trace_lock);
	if (!sys_prof_refcount_exit)
609
		ret = register_trace_sys_exit(prof_syscall_exit);
610 611 612 613 614 615 616 617 618 619 620
	if (ret) {
		pr_info("event trace: Could not activate"
				"syscall entry trace point");
	} else {
		set_bit(num, enabled_prof_exit_syscalls);
		sys_prof_refcount_exit++;
	}
	mutex_unlock(&syscall_trace_lock);
	return ret;
}

621
void prof_sysexit_disable(struct ftrace_event_call *call)
622 623 624
{
	int num;

625
	num = ((struct syscall_metadata *)call->data)->syscall_nr;
626 627 628 629 630

	mutex_lock(&syscall_trace_lock);
	sys_prof_refcount_exit--;
	clear_bit(num, enabled_prof_exit_syscalls);
	if (!sys_prof_refcount_exit)
631
		unregister_trace_sys_exit(prof_syscall_exit);
632 633 634 635 636 637
	mutex_unlock(&syscall_trace_lock);
}

#endif