blob: 1a5f1c7b527113e417fc8cf307ca9a4a55c04fb4 [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
Alban Crequy32ab8582020-03-22 16:06:44 +010019from bcc.containers import filter_by_containers
Brendan Gregg052f89c2015-10-13 15:35:58 -070020from bcc import BPF
Mark Drayton11de2982016-06-26 21:14:44 +010021from socket import inet_ntop, AF_INET, AF_INET6
22from struct import pack
Brendan Gregg052f89c2015-10-13 15:35:58 -070023import argparse
japrocaed9b1e2019-01-04 20:21:46 +030024from bcc.utils import printb
Xiaozhou Liu701bd732019-03-08 13:46:28 +080025from time import strftime
Brendan Gregg052f89c2015-10-13 15:35:58 -070026
27# arguments
28examples = """examples:
Brendan Gregg000a4e62015-10-13 15:41:46 -070029 ./tcpaccept # trace all TCP accept()s
Brendan Gregg052f89c2015-10-13 15:35:58 -070030 ./tcpaccept -t # include timestamps
Xiaozhou Liu701bd732019-03-08 13:46:28 +080031 ./tcpaccept -P 80,81 # only trace port 80 and 81
Brendan Gregg052f89c2015-10-13 15:35:58 -070032 ./tcpaccept -p 181 # only trace PID 181
Alban Crequy32ab8582020-03-22 16:06:44 +010033 ./tcpaccept --cgroupmap mappath # only trace cgroups in this BPF map
34 ./tcpaccept --mntnsmap mappath # only trace mount namespaces in the map
Brendan Gregg052f89c2015-10-13 15:35:58 -070035"""
36parser = argparse.ArgumentParser(
Alexei Starovoitovbdf07732016-01-14 10:09:20 -080037 description="Trace TCP accepts",
38 formatter_class=argparse.RawDescriptionHelpFormatter,
39 epilog=examples)
Xiaozhou Liu701bd732019-03-08 13:46:28 +080040parser.add_argument("-T", "--time", action="store_true",
41 help="include time column on output (HH:MM:SS)")
Brendan Gregg052f89c2015-10-13 15:35:58 -070042parser.add_argument("-t", "--timestamp", action="store_true",
Alexei Starovoitovbdf07732016-01-14 10:09:20 -080043 help="include timestamp on output")
Brendan Gregg052f89c2015-10-13 15:35:58 -070044parser.add_argument("-p", "--pid",
Alexei Starovoitovbdf07732016-01-14 10:09:20 -080045 help="trace this PID only")
Xiaozhou Liu701bd732019-03-08 13:46:28 +080046parser.add_argument("-P", "--port",
47 help="comma-separated list of local ports to trace")
Alban Crequy1ce868f2020-02-19 17:07:41 +010048parser.add_argument("--cgroupmap",
49 help="trace cgroups in this BPF map only")
Alban Crequy32ab8582020-03-22 16:06:44 +010050parser.add_argument("--mntnsmap",
51 help="trace mount namespaces in this BPF map only")
Nathan Scottcf0792f2018-02-02 16:56:50 +110052parser.add_argument("--ebpf", action="store_true",
53 help=argparse.SUPPRESS)
Brendan Gregg052f89c2015-10-13 15:35:58 -070054args = parser.parse_args()
55debug = 0
56
57# define BPF program
58bpf_text = """
59#include <uapi/linux/ptrace.h>
60#include <net/sock.h>
61#include <bcc/proto.h>
62
Brendan Gregg24825522016-02-14 16:32:29 -080063// separate data structs for ipv4 and ipv6
64struct ipv4_data_t {
Brendan Gregg24825522016-02-14 16:32:29 -080065 u64 ts_us;
Joe Yin36ce1122018-08-17 06:04:00 +080066 u32 pid;
Joe Yin365eade2018-06-21 13:41:03 +080067 u32 saddr;
68 u32 daddr;
Mark Drayton11de2982016-06-26 21:14:44 +010069 u64 ip;
Joe Yin36ce1122018-08-17 06:04:00 +080070 u16 lport;
Xiaozhou Liu701bd732019-03-08 13:46:28 +080071 u16 dport;
Brendan Gregg24825522016-02-14 16:32:29 -080072 char task[TASK_COMM_LEN];
73};
74BPF_PERF_OUTPUT(ipv4_events);
75
76struct ipv6_data_t {
Brendan Gregg24825522016-02-14 16:32:29 -080077 u64 ts_us;
Joe Yin36ce1122018-08-17 06:04:00 +080078 u32 pid;
Mark Drayton11de2982016-06-26 21:14:44 +010079 unsigned __int128 saddr;
80 unsigned __int128 daddr;
Brendan Gregg24825522016-02-14 16:32:29 -080081 u64 ip;
Joe Yin36ce1122018-08-17 06:04:00 +080082 u16 lport;
Xiaozhou Liu701bd732019-03-08 13:46:28 +080083 u16 dport;
Brendan Gregg24825522016-02-14 16:32:29 -080084 char task[TASK_COMM_LEN];
85};
86BPF_PERF_OUTPUT(ipv6_events);
Joe Yin365eade2018-06-21 13:41:03 +080087"""
Brendan Gregg24825522016-02-14 16:32:29 -080088
Joe Yin365eade2018-06-21 13:41:03 +080089#
Xiaozhou Liufd737452019-04-10 23:35:16 +080090# The following code uses kprobes to instrument inet_csk_accept().
91# On Linux 4.16 and later, we could use sock:inet_sock_set_state
Michael Prokopc14d02a2020-01-09 02:29:18 +010092# tracepoint for efficiency, but it may output wrong PIDs. This is
Xiaozhou Liufd737452019-04-10 23:35:16 +080093# because sock:inet_sock_set_state may run outside of process context.
94# Hence, we stick to kprobes until we find a proper solution.
Joe Yin365eade2018-06-21 13:41:03 +080095#
96bpf_text_kprobe = """
Brendan Gregg052f89c2015-10-13 15:35:58 -070097int kretprobe__inet_csk_accept(struct pt_regs *ctx)
98{
Alban Crequy32ab8582020-03-22 16:06:44 +010099 if (container_should_be_filtered()) {
Alban Crequy1ce868f2020-02-19 17:07:41 +0100100 return 0;
101 }
Alban Crequy1ce868f2020-02-19 17:07:41 +0100102
Naveen N. Rao4afa96a2016-05-03 14:54:21 +0530103 struct sock *newsk = (struct sock *)PT_REGS_RC(ctx);
Brendan Gregg8cd3efd2019-04-07 12:32:53 -0700104 u32 pid = bpf_get_current_pid_tgid() >> 32;
Brendan Gregg052f89c2015-10-13 15:35:58 -0700105
detailyang54044d52019-01-10 00:43:39 +0800106 ##FILTER_PID##
107
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800108 if (newsk == NULL)
109 return 0;
Brendan Gregg052f89c2015-10-13 15:35:58 -0700110
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800111 // check this is TCP
112 u8 protocol = 0;
113 // workaround for reading the sk_protocol bitfield:
Alban Crequy32ab8582020-03-22 16:06:44 +0100114
Joe Yin116bb402018-06-18 23:34:52 +0800115 // Following comments add by Joe Yin:
116 // Unfortunately,it can not work since Linux 4.10,
117 // because the sk_wmem_queued is not following the bitfield of sk_protocol.
118 // And the following member is sk_gso_max_segs.
119 // So, we can use this:
Sumanth Korikkar7f6066d2020-05-20 10:49:56 -0500120 // bpf_probe_read_kernel(&protocol, 1, (void *)((u64)&newsk->sk_gso_max_segs) - 3);
Alban Crequy32ab8582020-03-22 16:06:44 +0100121 // In order to diff the pre-4.10 and 4.10+ ,introduce the variables gso_max_segs_offset,sk_lingertime,
122 // sk_lingertime is closed to the gso_max_segs_offset,and
123 // the offset between the two members is 4
Joe Yin116bb402018-06-18 23:34:52 +0800124
125 int gso_max_segs_offset = offsetof(struct sock, sk_gso_max_segs);
126 int sk_lingertime_offset = offsetof(struct sock, sk_lingertime);
127
Alban Crequy32ab8582020-03-22 16:06:44 +0100128 if (sk_lingertime_offset - gso_max_segs_offset == 4)
Joe Yin116bb402018-06-18 23:34:52 +0800129 // 4.10+ with little endian
130#if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
Paul Chaignon8d78edd2018-06-29 07:47:44 +0200131 protocol = *(u8 *)((u64)&newsk->sk_gso_max_segs - 3);
Joe Yin116bb402018-06-18 23:34:52 +0800132 else
133 // pre-4.10 with little endian
Paul Chaignon8d78edd2018-06-29 07:47:44 +0200134 protocol = *(u8 *)((u64)&newsk->sk_wmem_queued - 3);
Joe Yin116bb402018-06-18 23:34:52 +0800135#elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
136 // 4.10+ with big endian
Paul Chaignon8d78edd2018-06-29 07:47:44 +0200137 protocol = *(u8 *)((u64)&newsk->sk_gso_max_segs - 1);
Joe Yin116bb402018-06-18 23:34:52 +0800138 else
139 // pre-4.10 with big endian
Paul Chaignon8d78edd2018-06-29 07:47:44 +0200140 protocol = *(u8 *)((u64)&newsk->sk_wmem_queued - 1);
Joe Yin116bb402018-06-18 23:34:52 +0800141#else
142# error "Fix your compiler's __BYTE_ORDER__?!"
143#endif
144
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800145 if (protocol != IPPROTO_TCP)
146 return 0;
Brendan Gregg10e1b142015-10-13 16:35:25 -0700147
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800148 // pull in details
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800149 u16 family = 0, lport = 0, dport;
Paul Chaignona9f96c02018-06-15 00:27:08 +0200150 family = newsk->__sk_common.skc_family;
151 lport = newsk->__sk_common.skc_num;
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800152 dport = newsk->__sk_common.skc_dport;
153 dport = ntohs(dport);
154
155 ##FILTER_PORT##
Brendan Gregg052f89c2015-10-13 15:35:58 -0700156
Brendan Gregg24825522016-02-14 16:32:29 -0800157 if (family == AF_INET) {
158 struct ipv4_data_t data4 = {.pid = pid, .ip = 4};
159 data4.ts_us = bpf_ktime_get_ns() / 1000;
Paul Chaignona9f96c02018-06-15 00:27:08 +0200160 data4.saddr = newsk->__sk_common.skc_rcv_saddr;
161 data4.daddr = newsk->__sk_common.skc_daddr;
Brendan Gregg24825522016-02-14 16:32:29 -0800162 data4.lport = lport;
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800163 data4.dport = dport;
Brendan Gregg24825522016-02-14 16:32:29 -0800164 bpf_get_current_comm(&data4.task, sizeof(data4.task));
165 ipv4_events.perf_submit(ctx, &data4, sizeof(data4));
166
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800167 } else if (family == AF_INET6) {
Brendan Gregg24825522016-02-14 16:32:29 -0800168 struct ipv6_data_t data6 = {.pid = pid, .ip = 6};
169 data6.ts_us = bpf_ktime_get_ns() / 1000;
Sumanth Korikkar7f6066d2020-05-20 10:49:56 -0500170 bpf_probe_read_kernel(&data6.saddr, sizeof(data6.saddr),
Mark Drayton11de2982016-06-26 21:14:44 +0100171 &newsk->__sk_common.skc_v6_rcv_saddr.in6_u.u6_addr32);
Sumanth Korikkar7f6066d2020-05-20 10:49:56 -0500172 bpf_probe_read_kernel(&data6.daddr, sizeof(data6.daddr),
Mark Drayton11de2982016-06-26 21:14:44 +0100173 &newsk->__sk_common.skc_v6_daddr.in6_u.u6_addr32);
Brendan Gregg24825522016-02-14 16:32:29 -0800174 data6.lport = lport;
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800175 data6.dport = dport;
Brendan Gregg24825522016-02-14 16:32:29 -0800176 bpf_get_current_comm(&data6.task, sizeof(data6.task));
177 ipv6_events.perf_submit(ctx, &data6, sizeof(data6));
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800178 }
179 // else drop
Brendan Gregg052f89c2015-10-13 15:35:58 -0700180
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800181 return 0;
Brendan Gregg052f89c2015-10-13 15:35:58 -0700182}
183"""
184
Xiaozhou Liufd737452019-04-10 23:35:16 +0800185bpf_text += bpf_text_kprobe
Joe Yin365eade2018-06-21 13:41:03 +0800186
Brendan Gregg052f89c2015-10-13 15:35:58 -0700187# code substitutions
188if args.pid:
detailyang54044d52019-01-10 00:43:39 +0800189 bpf_text = bpf_text.replace('##FILTER_PID##',
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800190 'if (pid != %s) { return 0; }' % args.pid)
Brendan Gregg052f89c2015-10-13 15:35:58 -0700191else:
detailyang54044d52019-01-10 00:43:39 +0800192 bpf_text = bpf_text.replace('##FILTER_PID##', '')
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800193if args.port:
194 lports = [int(lport) for lport in args.port.split(',')]
195 lports_if = ' && '.join(['lport != %d' % lport for lport in lports])
196 bpf_text = bpf_text.replace('##FILTER_PORT##',
197 'if (%s) { return 0; }' % lports_if)
Alban Crequy32ab8582020-03-22 16:06:44 +0100198bpf_text = filter_by_containers(args) + bpf_text
Nathan Scottcf0792f2018-02-02 16:56:50 +1100199if debug or args.ebpf:
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800200 print(bpf_text)
Nathan Scottcf0792f2018-02-02 16:56:50 +1100201 if args.ebpf:
202 exit()
Brendan Gregg052f89c2015-10-13 15:35:58 -0700203
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800204bpf_text = bpf_text.replace('##FILTER_PORT##', '')
205
Brendan Gregg24825522016-02-14 16:32:29 -0800206# process event
207def print_ipv4_event(cpu, data, size):
Xiaozhou Liu51d62d32019-02-15 13:03:05 +0800208 event = b["ipv4_events"].event(data)
Mark Drayton11de2982016-06-26 21:14:44 +0100209 global start_ts
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800210 if args.time:
Gary Lin6c793312019-04-18 15:17:56 +0800211 printb(b"%-9s" % strftime("%H:%M:%S").encode('ascii'), nl="")
Brendan Gregg24825522016-02-14 16:32:29 -0800212 if args.timestamp:
213 if start_ts == 0:
214 start_ts = event.ts_us
Gary Lin6c793312019-04-18 15:17:56 +0800215 printb(b"%-9.3f" % ((float(event.ts_us) - start_ts) / 1000000), nl="")
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800216 printb(b"%-7d %-12.12s %-2d %-16s %-5d %-16s %-5d" % (event.pid,
Yonghong Songebe19512019-01-10 14:54:16 -0800217 event.task, event.ip,
218 inet_ntop(AF_INET, pack("I", event.daddr)).encode(),
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800219 event.dport,
Yonghong Songebe19512019-01-10 14:54:16 -0800220 inet_ntop(AF_INET, pack("I", event.saddr)).encode(),
221 event.lport))
Mark Drayton11de2982016-06-26 21:14:44 +0100222
Brendan Gregg24825522016-02-14 16:32:29 -0800223def print_ipv6_event(cpu, data, size):
Xiaozhou Liu51d62d32019-02-15 13:03:05 +0800224 event = b["ipv6_events"].event(data)
Mark Drayton11de2982016-06-26 21:14:44 +0100225 global start_ts
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800226 if args.time:
Gary Lin6c793312019-04-18 15:17:56 +0800227 printb(b"%-9s" % strftime("%H:%M:%S").encode('ascii'), nl="")
Brendan Gregg24825522016-02-14 16:32:29 -0800228 if args.timestamp:
229 if start_ts == 0:
230 start_ts = event.ts_us
Gary Lin6c793312019-04-18 15:17:56 +0800231 printb(b"%-9.3f" % ((float(event.ts_us) - start_ts) / 1000000), nl="")
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800232 printb(b"%-7d %-12.12s %-2d %-16s %-5d %-16s %-5d" % (event.pid,
Yonghong Songebe19512019-01-10 14:54:16 -0800233 event.task, event.ip,
234 inet_ntop(AF_INET6, event.daddr).encode(),
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800235 event.dport,
Yonghong Songebe19512019-01-10 14:54:16 -0800236 inet_ntop(AF_INET6, event.saddr).encode(),
jeromemarchandb96ebcd2018-10-10 01:58:15 +0200237 event.lport))
Brendan Gregg24825522016-02-14 16:32:29 -0800238
Brendan Gregg052f89c2015-10-13 15:35:58 -0700239# initialize BPF
240b = BPF(text=bpf_text)
241
242# header
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800243if args.time:
244 print("%-9s" % ("TIME"), end="")
Brendan Gregg052f89c2015-10-13 15:35:58 -0700245if args.timestamp:
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800246 print("%-9s" % ("TIME(s)"), end="")
Xiaozhou Liu701bd732019-03-08 13:46:28 +0800247print("%-7s %-12s %-2s %-16s %-5s %-16s %-5s" % ("PID", "COMM", "IP", "RADDR",
248 "RPORT", "LADDR", "LPORT"))
Brendan Gregg052f89c2015-10-13 15:35:58 -0700249
250start_ts = 0
251
Brendan Gregg24825522016-02-14 16:32:29 -0800252# read events
253b["ipv4_events"].open_perf_buffer(print_ipv4_event)
254b["ipv6_events"].open_perf_buffer(print_ipv6_event)
Brendan Gregg052f89c2015-10-13 15:35:58 -0700255while 1:
Jerome Marchand51671272018-12-19 01:57:24 +0100256 try:
257 b.perf_buffer_poll()
258 except KeyboardInterrupt:
259 exit()