blob: 70202dd39dd84079ef0abf95a255c688938e2d17 [file] [log] [blame]
Alexey Ivanovcc01a9c2019-01-16 09:50:46 -08001#!/usr/bin/python
Alexei Starovoitovbdf07732016-01-14 10:09:20 -08002# @lint-avoid-python-3-compatibility-imports
Brendan Gregg052f89c2015-10-13 15:35:58 -07003#
Alexei Starovoitovbdf07732016-01-14 10:09:20 -08004# tcpaccept Trace TCP accept()s.
5# For Linux, uses BCC, eBPF. Embedded C.
Brendan Gregg052f89c2015-10-13 15:35:58 -07006#
Xiaozhou Liu701bd732019-03-08 13:46:28 +08007# USAGE: tcpaccept [-h] [-T] [-t] [-p PID] [-P PORTS]
Brendan Gregg052f89c2015-10-13 15:35:58 -07008#
9# This uses dynamic tracing of the kernel inet_csk_accept() socket function
10# (from tcp_prot.accept), and will need to be modified to match kernel changes.
Brendan Gregg052f89c2015-10-13 15:35:58 -070011#
Brendan Gregg052f89c2015-10-13 15:35:58 -070012# Copyright (c) 2015 Brendan Gregg.
13# Licensed under the Apache License, Version 2.0 (the "License")
14#
Alexei Starovoitovbdf07732016-01-14 10:09:20 -080015# 13-Oct-2015 Brendan Gregg Created this.
Brendan Gregg24825522016-02-14 16:32:29 -080016# 14-Feb-2016 " " Switch to bpf_perf_output.
Brendan Gregg052f89c2015-10-13 15:35:58 -070017
18from __future__ import print_function
19from bcc import BPF
Mark Drayton11de2982016-06-26 21:14:44 +010020from socket import inet_ntop, AF_INET, AF_INET6
21from struct import pack
Brendan Gregg052f89c2015-10-13 15:35:58 -070022import argparse
japrocaed9b1e2019-01-04 20:21:46 +030023from bcc.utils import printb
Xiaozhou Liu701bd732019-03-08 13:46:28 +080024from time import strftime
Brendan Gregg052f89c2015-10-13 15:35:58 -070025
26# arguments
27examples = """examples:
Brendan Gregg000a4e62015-10-13 15:41:46 -070028 ./tcpaccept # trace all TCP accept()s
Brendan Gregg052f89c2015-10-13 15:35:58 -070029 ./tcpaccept -t # include timestamps
Xiaozhou Liu701bd732019-03-08 13:46:28 +080030 ./tcpaccept -P 80,81 # only trace port 80 and 81
Brendan Gregg052f89c2015-10-13 15:35:58 -070031 ./tcpaccept -p 181 # only trace PID 181
32"""
33parser = argparse.ArgumentParser(
Alexei Starovoitovbdf07732016-01-14 10:09:20 -080034 description="Trace TCP accepts",
35 formatter_class=argparse.RawDescriptionHelpFormatter,
36 epilog=examples)
Xiaozhou Liu701bd732019-03-08 13:46:28 +080037parser.add_argument("-T", "--time", action="store_true",
38 help="include time column on output (HH:MM:SS)")
Brendan Gregg052f89c2015-10-13 15:35:58 -070039parser.add_argument("-t", "--timestamp", action="store_true",
Alexei Starovoitovbdf07732016-01-14 10:09:20 -080040 help="include timestamp on output")
Brendan Gregg052f89c2015-10-13 15:35:58 -070041parser.add_argument("-p", "--pid",
Alexei Starovoitovbdf07732016-01-14 10:09:20 -080042 help="trace this PID only")
Xiaozhou Liu701bd732019-03-08 13:46:28 +080043parser.add_argument("-P", "--port",
44 help="comma-separated list of local ports to trace")
Nathan Scottcf0792f2018-02-02 16:56:50 +110045parser.add_argument("--ebpf", action="store_true",
46 help=argparse.SUPPRESS)
Brendan Gregg052f89c2015-10-13 15:35:58 -070047args = parser.parse_args()
48debug = 0
49
50# define BPF program
51bpf_text = """
52#include <uapi/linux/ptrace.h>
53#include <net/sock.h>
54#include <bcc/proto.h>
55
Brendan Gregg24825522016-02-14 16:32:29 -080056// separate data structs for ipv4 and ipv6
57struct ipv4_data_t {
Brendan Gregg24825522016-02-14 16:32:29 -080058 u64 ts_us;
Joe Yin36ce1122018-08-17 06:04:00 +080059 u32 pid;
Joe Yin365eade2018-06-21 13:41:03 +080060 u32 saddr;
61 u32 daddr;
Mark Drayton11de2982016-06-26 21:14:44 +010062 u64 ip;
Joe Yin36ce1122018-08-17 06:04:00 +080063 u16 lport;
Xiaozhou Liu701bd732019-03-08 13:46:28 +080064 u16 dport;
Brendan Gregg24825522016-02-14 16:32:29 -080065 char task[TASK_COMM_LEN];
66};
67BPF_PERF_OUTPUT(ipv4_events);
68
69struct ipv6_data_t {
Brendan Gregg24825522016-02-14 16:32:29 -080070 u64 ts_us;
Joe Yin36ce1122018-08-17 06:04:00 +080071 u32 pid;
Mark Drayton11de2982016-06-26 21:14:44 +010072 unsigned __int128 saddr;
73 unsigned __int128 daddr;
Brendan Gregg24825522016-02-14 16:32:29 -080074 u64 ip;
Joe Yin36ce1122018-08-17 06:04:00 +080075 u16 lport;
Xiaozhou Liu701bd732019-03-08 13:46:28 +080076 u16 dport;
Brendan Gregg24825522016-02-14 16:32:29 -080077 char task[TASK_COMM_LEN];
78};
79BPF_PERF_OUTPUT(ipv6_events);
Joe Yin365eade2018-06-21 13:41:03 +080080"""
Brendan Gregg24825522016-02-14 16:32:29 -080081
Joe Yin365eade2018-06-21 13:41:03 +080082#
Xiaozhou Liufd737452019-04-10 23:35:16 +080083# The following code uses kprobes to instrument inet_csk_accept().
84# On Linux 4.16 and later, we could use sock:inet_sock_set_state
85# tracepoint for efficency, but it may output wrong PIDs. This is
86# because sock:inet_sock_set_state may run outside of process context.
87# Hence, we stick to kprobes until we find a proper solution.
Joe Yin365eade2018-06-21 13:41:03 +080088#
89bpf_text_kprobe = """
Brendan Gregg052f89c2015-10-13 15:35:58 -070090int kretprobe__inet_csk_accept(struct pt_regs *ctx)
91{
Naveen N. Rao4afa96a2016-05-03 14:54:21 +053092 struct sock *newsk = (struct sock *)PT_REGS_RC(ctx);
Brendan Gregg8cd3efd2019-04-07 12:32:53 -070093 u32 pid = bpf_get_current_pid_tgid() >> 32;
Brendan Gregg052f89c2015-10-13 15:35:58 -070094
detailyang54044d52019-01-10 00:43:39 +080095 ##FILTER_PID##
96
Alexei Starovoitovbdf07732016-01-14 10:09:20 -080097 if (newsk == NULL)
98 return 0;
Brendan Gregg052f89c2015-10-13 15:35:58 -070099
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800100 // check this is TCP
101 u8 protocol = 0;
102 // workaround for reading the sk_protocol bitfield:
Joe Yin116bb402018-06-18 23:34:52 +0800103
104 // Following comments add by Joe Yin:
105 // Unfortunately,it can not work since Linux 4.10,
106 // because the sk_wmem_queued is not following the bitfield of sk_protocol.
107 // And the following member is sk_gso_max_segs.
108 // So, we can use this:
109 // bpf_probe_read(&protocol, 1, (void *)((u64)&newsk->sk_gso_max_segs) - 3);
110 // In order to diff the pre-4.10 and 4.10+ ,introduce the variables gso_max_segs_offset,sk_lingertime,
111 // sk_lingertime is closed to the gso_max_segs_offset,and
112 // the offset between the two members is 4
113
114 int gso_max_segs_offset = offsetof(struct sock, sk_gso_max_segs);
115 int sk_lingertime_offset = offsetof(struct sock, sk_lingertime);
116
117 if (sk_lingertime_offset - gso_max_segs_offset == 4)
118 // 4.10+ with little endian
119#if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
Paul Chaignon8d78edd2018-06-29 07:47:44 +0200120 protocol = *(u8 *)((u64)&newsk->sk_gso_max_segs - 3);
Joe Yin116bb402018-06-18 23:34:52 +0800121 else
122 // pre-4.10 with little endian
Paul Chaignon8d78edd2018-06-29 07:47:44 +0200123 protocol = *(u8 *)((u64)&newsk->sk_wmem_queued - 3);
Joe Yin116bb402018-06-18 23:34:52 +0800124#elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
125 // 4.10+ with big endian
Paul Chaignon8d78edd2018-06-29 07:47:44 +0200126 protocol = *(u8 *)((u64)&newsk->sk_gso_max_segs - 1);
Joe Yin116bb402018-06-18 23:34:52 +0800127 else
128 // pre-4.10 with big endian
Paul Chaignon8d78edd2018-06-29 07:47:44 +0200129 protocol = *(u8 *)((u64)&newsk->sk_wmem_queued - 1);
Joe Yin116bb402018-06-18 23:34:52 +0800130#else
131# error "Fix your compiler's __BYTE_ORDER__?!"
132#endif
133
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800134 if (protocol != IPPROTO_TCP)
135 return 0;
Brendan Gregg10e1b142015-10-13 16:35:25 -0700136
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800137 // pull in details
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800138 u16 family = 0, lport = 0, dport;
Paul Chaignona9f96c02018-06-15 00:27:08 +0200139 family = newsk->__sk_common.skc_family;
140 lport = newsk->__sk_common.skc_num;
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800141 dport = newsk->__sk_common.skc_dport;
142 dport = ntohs(dport);
143
144 ##FILTER_PORT##
Brendan Gregg052f89c2015-10-13 15:35:58 -0700145
Brendan Gregg24825522016-02-14 16:32:29 -0800146 if (family == AF_INET) {
147 struct ipv4_data_t data4 = {.pid = pid, .ip = 4};
148 data4.ts_us = bpf_ktime_get_ns() / 1000;
Paul Chaignona9f96c02018-06-15 00:27:08 +0200149 data4.saddr = newsk->__sk_common.skc_rcv_saddr;
150 data4.daddr = newsk->__sk_common.skc_daddr;
Brendan Gregg24825522016-02-14 16:32:29 -0800151 data4.lport = lport;
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800152 data4.dport = dport;
Brendan Gregg24825522016-02-14 16:32:29 -0800153 bpf_get_current_comm(&data4.task, sizeof(data4.task));
154 ipv4_events.perf_submit(ctx, &data4, sizeof(data4));
155
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800156 } else if (family == AF_INET6) {
Brendan Gregg24825522016-02-14 16:32:29 -0800157 struct ipv6_data_t data6 = {.pid = pid, .ip = 6};
158 data6.ts_us = bpf_ktime_get_ns() / 1000;
Mark Drayton11de2982016-06-26 21:14:44 +0100159 bpf_probe_read(&data6.saddr, sizeof(data6.saddr),
160 &newsk->__sk_common.skc_v6_rcv_saddr.in6_u.u6_addr32);
161 bpf_probe_read(&data6.daddr, sizeof(data6.daddr),
162 &newsk->__sk_common.skc_v6_daddr.in6_u.u6_addr32);
Brendan Gregg24825522016-02-14 16:32:29 -0800163 data6.lport = lport;
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800164 data6.dport = dport;
Brendan Gregg24825522016-02-14 16:32:29 -0800165 bpf_get_current_comm(&data6.task, sizeof(data6.task));
166 ipv6_events.perf_submit(ctx, &data6, sizeof(data6));
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800167 }
168 // else drop
Brendan Gregg052f89c2015-10-13 15:35:58 -0700169
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800170 return 0;
Brendan Gregg052f89c2015-10-13 15:35:58 -0700171}
172"""
173
Xiaozhou Liufd737452019-04-10 23:35:16 +0800174bpf_text += bpf_text_kprobe
Joe Yin365eade2018-06-21 13:41:03 +0800175
Brendan Gregg052f89c2015-10-13 15:35:58 -0700176# code substitutions
177if args.pid:
detailyang54044d52019-01-10 00:43:39 +0800178 bpf_text = bpf_text.replace('##FILTER_PID##',
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800179 'if (pid != %s) { return 0; }' % args.pid)
Brendan Gregg052f89c2015-10-13 15:35:58 -0700180else:
detailyang54044d52019-01-10 00:43:39 +0800181 bpf_text = bpf_text.replace('##FILTER_PID##', '')
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800182if args.port:
183 lports = [int(lport) for lport in args.port.split(',')]
184 lports_if = ' && '.join(['lport != %d' % lport for lport in lports])
185 bpf_text = bpf_text.replace('##FILTER_PORT##',
186 'if (%s) { return 0; }' % lports_if)
Nathan Scottcf0792f2018-02-02 16:56:50 +1100187if debug or args.ebpf:
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800188 print(bpf_text)
Nathan Scottcf0792f2018-02-02 16:56:50 +1100189 if args.ebpf:
190 exit()
Brendan Gregg052f89c2015-10-13 15:35:58 -0700191
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800192bpf_text = bpf_text.replace('##FILTER_PORT##', '')
193
Brendan Gregg24825522016-02-14 16:32:29 -0800194# process event
195def print_ipv4_event(cpu, data, size):
Xiaozhou Liu51d62d32019-02-15 13:03:05 +0800196 event = b["ipv4_events"].event(data)
Mark Drayton11de2982016-06-26 21:14:44 +0100197 global start_ts
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800198 if args.time:
199 print("%-9s" % strftime("%H:%M:%S"), end="")
Brendan Gregg24825522016-02-14 16:32:29 -0800200 if args.timestamp:
201 if start_ts == 0:
202 start_ts = event.ts_us
Mark Drayton11de2982016-06-26 21:14:44 +0100203 print("%-9.3f" % ((float(event.ts_us) - start_ts) / 1000000), end="")
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800204 printb(b"%-7d %-12.12s %-2d %-16s %-5d %-16s %-5d" % (event.pid,
Yonghong Songebe19512019-01-10 14:54:16 -0800205 event.task, event.ip,
206 inet_ntop(AF_INET, pack("I", event.daddr)).encode(),
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800207 event.dport,
Yonghong Songebe19512019-01-10 14:54:16 -0800208 inet_ntop(AF_INET, pack("I", event.saddr)).encode(),
209 event.lport))
Mark Drayton11de2982016-06-26 21:14:44 +0100210
Brendan Gregg24825522016-02-14 16:32:29 -0800211def print_ipv6_event(cpu, data, size):
Xiaozhou Liu51d62d32019-02-15 13:03:05 +0800212 event = b["ipv6_events"].event(data)
Mark Drayton11de2982016-06-26 21:14:44 +0100213 global start_ts
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800214 if args.time:
215 print("%-9s" % strftime("%H:%M:%S"), end="")
Brendan Gregg24825522016-02-14 16:32:29 -0800216 if args.timestamp:
217 if start_ts == 0:
218 start_ts = event.ts_us
Mark Drayton11de2982016-06-26 21:14:44 +0100219 print("%-9.3f" % ((float(event.ts_us) - start_ts) / 1000000), end="")
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800220 printb(b"%-7d %-12.12s %-2d %-16s %-5d %-16s %-5d" % (event.pid,
Yonghong Songebe19512019-01-10 14:54:16 -0800221 event.task, event.ip,
222 inet_ntop(AF_INET6, event.daddr).encode(),
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800223 event.dport,
Yonghong Songebe19512019-01-10 14:54:16 -0800224 inet_ntop(AF_INET6, event.saddr).encode(),
jeromemarchandb96ebcd2018-10-10 01:58:15 +0200225 event.lport))
Brendan Gregg24825522016-02-14 16:32:29 -0800226
Brendan Gregg052f89c2015-10-13 15:35:58 -0700227# initialize BPF
228b = BPF(text=bpf_text)
229
230# header
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800231if args.time:
232 print("%-9s" % ("TIME"), end="")
Brendan Gregg052f89c2015-10-13 15:35:58 -0700233if args.timestamp:
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800234 print("%-9s" % ("TIME(s)"), end="")
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800235print("%-7s %-12s %-2s %-16s %-5s %-16s %-5s" % ("PID", "COMM", "IP", "RADDR",
236 "RPORT", "LADDR", "LPORT"))
Brendan Gregg052f89c2015-10-13 15:35:58 -0700237
238start_ts = 0
239
Brendan Gregg24825522016-02-14 16:32:29 -0800240# read events
241b["ipv4_events"].open_perf_buffer(print_ipv4_event)
242b["ipv6_events"].open_perf_buffer(print_ipv6_event)
Brendan Gregg052f89c2015-10-13 15:35:58 -0700243while 1:
Jerome Marchand51671272018-12-19 01:57:24 +0100244 try:
245 b.perf_buffer_poll()
246 except KeyboardInterrupt:
247 exit()