blob: 5f7b48c3351cae72a295201798f659aaaf69d720 [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#
7# USAGE: tcpaccept [-h] [-t] [-p PID]
8#
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
Brendan Gregg052f89c2015-10-13 15:35:58 -070024
25# arguments
26examples = """examples:
Brendan Gregg000a4e62015-10-13 15:41:46 -070027 ./tcpaccept # trace all TCP accept()s
Brendan Gregg052f89c2015-10-13 15:35:58 -070028 ./tcpaccept -t # include timestamps
29 ./tcpaccept -p 181 # only trace PID 181
30"""
31parser = argparse.ArgumentParser(
Alexei Starovoitovbdf07732016-01-14 10:09:20 -080032 description="Trace TCP accepts",
33 formatter_class=argparse.RawDescriptionHelpFormatter,
34 epilog=examples)
Brendan Gregg052f89c2015-10-13 15:35:58 -070035parser.add_argument("-t", "--timestamp", action="store_true",
Alexei Starovoitovbdf07732016-01-14 10:09:20 -080036 help="include timestamp on output")
Brendan Gregg052f89c2015-10-13 15:35:58 -070037parser.add_argument("-p", "--pid",
Alexei Starovoitovbdf07732016-01-14 10:09:20 -080038 help="trace this PID only")
Nathan Scottcf0792f2018-02-02 16:56:50 +110039parser.add_argument("--ebpf", action="store_true",
40 help=argparse.SUPPRESS)
Brendan Gregg052f89c2015-10-13 15:35:58 -070041args = parser.parse_args()
42debug = 0
43
44# define BPF program
45bpf_text = """
46#include <uapi/linux/ptrace.h>
47#include <net/sock.h>
48#include <bcc/proto.h>
49
Brendan Gregg24825522016-02-14 16:32:29 -080050// separate data structs for ipv4 and ipv6
51struct ipv4_data_t {
Brendan Gregg24825522016-02-14 16:32:29 -080052 u64 ts_us;
Joe Yin36ce1122018-08-17 06:04:00 +080053 u32 pid;
Joe Yin365eade2018-06-21 13:41:03 +080054 u32 saddr;
55 u32 daddr;
Mark Drayton11de2982016-06-26 21:14:44 +010056 u64 ip;
Joe Yin36ce1122018-08-17 06:04:00 +080057 u16 lport;
Brendan Gregg24825522016-02-14 16:32:29 -080058 char task[TASK_COMM_LEN];
59};
60BPF_PERF_OUTPUT(ipv4_events);
61
62struct ipv6_data_t {
Brendan Gregg24825522016-02-14 16:32:29 -080063 u64 ts_us;
Joe Yin36ce1122018-08-17 06:04:00 +080064 u32 pid;
Mark Drayton11de2982016-06-26 21:14:44 +010065 unsigned __int128 saddr;
66 unsigned __int128 daddr;
Brendan Gregg24825522016-02-14 16:32:29 -080067 u64 ip;
Joe Yin36ce1122018-08-17 06:04:00 +080068 u16 lport;
Brendan Gregg24825522016-02-14 16:32:29 -080069 char task[TASK_COMM_LEN];
70};
71BPF_PERF_OUTPUT(ipv6_events);
Joe Yin365eade2018-06-21 13:41:03 +080072"""
Brendan Gregg24825522016-02-14 16:32:29 -080073
Joe Yin365eade2018-06-21 13:41:03 +080074#
75# The following is the code for older kernels(Linux pre-4.16).
76# It uses kprobes to instrument inet_csk_accept(). On Linux 4.16 and
77# later, the sock:inet_sock_set_state tracepoint should be used instead, as
78# is done by the code that follows this.
79#
80bpf_text_kprobe = """
Brendan Gregg052f89c2015-10-13 15:35:58 -070081int kretprobe__inet_csk_accept(struct pt_regs *ctx)
82{
Naveen N. Rao4afa96a2016-05-03 14:54:21 +053083 struct sock *newsk = (struct sock *)PT_REGS_RC(ctx);
Alexei Starovoitovbdf07732016-01-14 10:09:20 -080084 u32 pid = bpf_get_current_pid_tgid();
Brendan Gregg052f89c2015-10-13 15:35:58 -070085
detailyang54044d52019-01-10 00:43:39 +080086 ##FILTER_PID##
87
Alexei Starovoitovbdf07732016-01-14 10:09:20 -080088 if (newsk == NULL)
89 return 0;
Brendan Gregg052f89c2015-10-13 15:35:58 -070090
Alexei Starovoitovbdf07732016-01-14 10:09:20 -080091 // check this is TCP
92 u8 protocol = 0;
93 // workaround for reading the sk_protocol bitfield:
Joe Yin116bb402018-06-18 23:34:52 +080094
95 // Following comments add by Joe Yin:
96 // Unfortunately,it can not work since Linux 4.10,
97 // because the sk_wmem_queued is not following the bitfield of sk_protocol.
98 // And the following member is sk_gso_max_segs.
99 // So, we can use this:
100 // bpf_probe_read(&protocol, 1, (void *)((u64)&newsk->sk_gso_max_segs) - 3);
101 // In order to diff the pre-4.10 and 4.10+ ,introduce the variables gso_max_segs_offset,sk_lingertime,
102 // sk_lingertime is closed to the gso_max_segs_offset,and
103 // the offset between the two members is 4
104
105 int gso_max_segs_offset = offsetof(struct sock, sk_gso_max_segs);
106 int sk_lingertime_offset = offsetof(struct sock, sk_lingertime);
107
108 if (sk_lingertime_offset - gso_max_segs_offset == 4)
109 // 4.10+ with little endian
110#if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
Paul Chaignon8d78edd2018-06-29 07:47:44 +0200111 protocol = *(u8 *)((u64)&newsk->sk_gso_max_segs - 3);
Joe Yin116bb402018-06-18 23:34:52 +0800112 else
113 // pre-4.10 with little endian
Paul Chaignon8d78edd2018-06-29 07:47:44 +0200114 protocol = *(u8 *)((u64)&newsk->sk_wmem_queued - 3);
Joe Yin116bb402018-06-18 23:34:52 +0800115#elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
116 // 4.10+ with big endian
Paul Chaignon8d78edd2018-06-29 07:47:44 +0200117 protocol = *(u8 *)((u64)&newsk->sk_gso_max_segs - 1);
Joe Yin116bb402018-06-18 23:34:52 +0800118 else
119 // pre-4.10 with big endian
Paul Chaignon8d78edd2018-06-29 07:47:44 +0200120 protocol = *(u8 *)((u64)&newsk->sk_wmem_queued - 1);
Joe Yin116bb402018-06-18 23:34:52 +0800121#else
122# error "Fix your compiler's __BYTE_ORDER__?!"
123#endif
124
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800125 if (protocol != IPPROTO_TCP)
126 return 0;
Brendan Gregg10e1b142015-10-13 16:35:25 -0700127
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800128 // pull in details
129 u16 family = 0, lport = 0;
Paul Chaignona9f96c02018-06-15 00:27:08 +0200130 family = newsk->__sk_common.skc_family;
131 lport = newsk->__sk_common.skc_num;
Brendan Gregg052f89c2015-10-13 15:35:58 -0700132
Brendan Gregg24825522016-02-14 16:32:29 -0800133 if (family == AF_INET) {
134 struct ipv4_data_t data4 = {.pid = pid, .ip = 4};
135 data4.ts_us = bpf_ktime_get_ns() / 1000;
Paul Chaignona9f96c02018-06-15 00:27:08 +0200136 data4.saddr = newsk->__sk_common.skc_rcv_saddr;
137 data4.daddr = newsk->__sk_common.skc_daddr;
Brendan Gregg24825522016-02-14 16:32:29 -0800138 data4.lport = lport;
139 bpf_get_current_comm(&data4.task, sizeof(data4.task));
140 ipv4_events.perf_submit(ctx, &data4, sizeof(data4));
141
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800142 } else if (family == AF_INET6) {
Brendan Gregg24825522016-02-14 16:32:29 -0800143 struct ipv6_data_t data6 = {.pid = pid, .ip = 6};
144 data6.ts_us = bpf_ktime_get_ns() / 1000;
Mark Drayton11de2982016-06-26 21:14:44 +0100145 bpf_probe_read(&data6.saddr, sizeof(data6.saddr),
146 &newsk->__sk_common.skc_v6_rcv_saddr.in6_u.u6_addr32);
147 bpf_probe_read(&data6.daddr, sizeof(data6.daddr),
148 &newsk->__sk_common.skc_v6_daddr.in6_u.u6_addr32);
Brendan Gregg24825522016-02-14 16:32:29 -0800149 data6.lport = lport;
150 bpf_get_current_comm(&data6.task, sizeof(data6.task));
151 ipv6_events.perf_submit(ctx, &data6, sizeof(data6));
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800152 }
153 // else drop
Brendan Gregg052f89c2015-10-13 15:35:58 -0700154
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800155 return 0;
Brendan Gregg052f89c2015-10-13 15:35:58 -0700156}
157"""
158
Joe Yin365eade2018-06-21 13:41:03 +0800159bpf_text_tracepoint = """
160TRACEPOINT_PROBE(sock, inet_sock_set_state)
161{
162 if (args->protocol != IPPROTO_TCP)
163 return 0;
164 u32 pid = bpf_get_current_pid_tgid();
detailyang54044d52019-01-10 00:43:39 +0800165
166 ##FILTER_PID##
167
Joe Yin365eade2018-06-21 13:41:03 +0800168 // pull in details
169 u16 family = 0, lport = 0;
170 family = args->family;
171 lport = args->sport;
172
173 if (family == AF_INET) {
174 struct ipv4_data_t data4 = {.pid = pid, .ip = 4};
175 data4.ts_us = bpf_ktime_get_ns() / 1000;
176 __builtin_memcpy(&data4.saddr, args->saddr, sizeof(data4.saddr));
177 __builtin_memcpy(&data4.daddr, args->daddr, sizeof(data4.daddr));
178 data4.lport = lport;
179 bpf_get_current_comm(&data4.task, sizeof(data4.task));
180 ipv4_events.perf_submit(args, &data4, sizeof(data4));
181 } else if (family == AF_INET6) {
182 struct ipv6_data_t data6 = {.pid = pid, .ip = 6};
183 data6.ts_us = bpf_ktime_get_ns() / 1000;
184 __builtin_memcpy(&data6.saddr, args->saddr, sizeof(data6.saddr));
185 __builtin_memcpy(&data6.daddr, args->daddr, sizeof(data6.daddr));
186 data6.lport = lport;
187 bpf_get_current_comm(&data6.task, sizeof(data6.task));
188 ipv6_events.perf_submit(args, &data6, sizeof(data6));
189 }
190 // else drop
191
192 return 0;
193}
194"""
195
196if (BPF.tracepoint_exists("sock", "inet_sock_set_state")):
197 bpf_text += bpf_text_tracepoint
198else:
199 bpf_text += bpf_text_kprobe
200
201
Brendan Gregg052f89c2015-10-13 15:35:58 -0700202# code substitutions
203if args.pid:
detailyang54044d52019-01-10 00:43:39 +0800204 bpf_text = bpf_text.replace('##FILTER_PID##',
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800205 'if (pid != %s) { return 0; }' % args.pid)
Brendan Gregg052f89c2015-10-13 15:35:58 -0700206else:
detailyang54044d52019-01-10 00:43:39 +0800207 bpf_text = bpf_text.replace('##FILTER_PID##', '')
Nathan Scottcf0792f2018-02-02 16:56:50 +1100208if debug or args.ebpf:
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800209 print(bpf_text)
Nathan Scottcf0792f2018-02-02 16:56:50 +1100210 if args.ebpf:
211 exit()
Brendan Gregg052f89c2015-10-13 15:35:58 -0700212
Brendan Gregg24825522016-02-14 16:32:29 -0800213# process event
214def print_ipv4_event(cpu, data, size):
Xiaozhou Liu51d62d32019-02-15 13:03:05 +0800215 event = b["ipv4_events"].event(data)
Mark Drayton11de2982016-06-26 21:14:44 +0100216 global start_ts
Brendan Gregg24825522016-02-14 16:32:29 -0800217 if args.timestamp:
218 if start_ts == 0:
219 start_ts = event.ts_us
Mark Drayton11de2982016-06-26 21:14:44 +0100220 print("%-9.3f" % ((float(event.ts_us) - start_ts) / 1000000), end="")
japrocaed9b1e2019-01-04 20:21:46 +0300221 printb(b"%-6d %-12.12s %-2d %-16s %-16s %-4d" % (event.pid,
Yonghong Songebe19512019-01-10 14:54:16 -0800222 event.task, event.ip,
223 inet_ntop(AF_INET, pack("I", event.daddr)).encode(),
224 inet_ntop(AF_INET, pack("I", event.saddr)).encode(),
225 event.lport))
Mark Drayton11de2982016-06-26 21:14:44 +0100226
Brendan Gregg24825522016-02-14 16:32:29 -0800227def print_ipv6_event(cpu, data, size):
Xiaozhou Liu51d62d32019-02-15 13:03:05 +0800228 event = b["ipv6_events"].event(data)
Mark Drayton11de2982016-06-26 21:14:44 +0100229 global start_ts
Brendan Gregg24825522016-02-14 16:32:29 -0800230 if args.timestamp:
231 if start_ts == 0:
232 start_ts = event.ts_us
Mark Drayton11de2982016-06-26 21:14:44 +0100233 print("%-9.3f" % ((float(event.ts_us) - start_ts) / 1000000), end="")
japrocaed9b1e2019-01-04 20:21:46 +0300234 printb(b"%-6d %-12.12s %-2d %-16s %-16s %-4d" % (event.pid,
Yonghong Songebe19512019-01-10 14:54:16 -0800235 event.task, event.ip,
236 inet_ntop(AF_INET6, event.daddr).encode(),
237 inet_ntop(AF_INET6, event.saddr).encode(),
jeromemarchandb96ebcd2018-10-10 01:58:15 +0200238 event.lport))
Brendan Gregg24825522016-02-14 16:32:29 -0800239
Brendan Gregg052f89c2015-10-13 15:35:58 -0700240# initialize BPF
241b = BPF(text=bpf_text)
242
243# header
244if args.timestamp:
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800245 print("%-9s" % ("TIME(s)"), end="")
Brendan Gregg052f89c2015-10-13 15:35:58 -0700246print("%-6s %-12s %-2s %-16s %-16s %-4s" % ("PID", "COMM", "IP", "RADDR",
247 "LADDR", "LPORT"))
248
249start_ts = 0
250
Brendan Gregg24825522016-02-14 16:32:29 -0800251# read events
252b["ipv4_events"].open_perf_buffer(print_ipv4_event)
253b["ipv6_events"].open_perf_buffer(print_ipv6_event)
Brendan Gregg052f89c2015-10-13 15:35:58 -0700254while 1:
Jerome Marchand51671272018-12-19 01:57:24 +0100255 try:
256 b.perf_buffer_poll()
257 except KeyboardInterrupt:
258 exit()