continue adding --ebpf option to the python tools/ scripts

Several python tools allow their eBPF code to be printed to stdout for debugging. There are other projects that would like to share these program definitions however, instead of duplicating code. We previously agreed on an --ebpf option and we now continue adding it to more tools. Signed-off-by: Nathan Scott <[email protected]>
rsanger · Feb 2, 2018 · cf0792f · cf0792f
1 parent 3f39bc1
commit cf0792f
Show file tree

Hide file tree

Showing 47 changed files with 249 additions and 42 deletions.
diff --git a/tools/btrfsdist.py b/tools/btrfsdist.py
@@ -40,6 +40,8 @@
     help="output interval, in seconds")
 parser.add_argument("count", nargs="?", default=99999999,
     help="number of outputs")
+parser.add_argument("--ebpf", action="store_true",
+    help=argparse.SUPPRESS)
 args = parser.parse_args()
 pid = args.pid
 countdown = int(args.count)
@@ -183,8 +185,10 @@
     bpf_text = bpf_text.replace('FILTER_PID', 'pid != %s' % pid)
 else:
     bpf_text = bpf_text.replace('FILTER_PID', '0')
-if debug:
+if debug or args.ebpf:
     print(bpf_text)
+    if args.ebpf:
+        exit()
 
 # load BPF program
 b = BPF(text=bpf_text)

diff --git a/tools/btrfsslower.py b/tools/btrfsslower.py
@@ -51,6 +51,8 @@
     help="trace this PID only")
 parser.add_argument("min_ms", nargs="?", default='10',
     help="minimum I/O duration to trace, in ms (default 10)")
+parser.add_argument("--ebpf", action="store_true",
+    help=argparse.SUPPRESS)
 args = parser.parse_args()
 min_ms = int(args.min_ms)
 pid = args.pid
@@ -280,8 +282,10 @@
     bpf_text = bpf_text.replace('FILTER_PID', 'pid != %s' % pid)
 else:
     bpf_text = bpf_text.replace('FILTER_PID', '0')
-if debug:
+if debug or args.ebpf:
     print(bpf_text)
+    if args.ebpf:
+        exit()
 
 # kernel->user event data: struct data_t
 DNAME_INLINE_LEN = 32   # linux/dcache.h

diff --git a/tools/cpudist.py b/tools/cpudist.py
@@ -44,6 +44,8 @@
     help="output interval, in seconds")
 parser.add_argument("count", nargs="?", default=99999999,
     help="number of outputs")
+parser.add_argument("--ebpf", action="store_true",
+    help=argparse.SUPPRESS)
 args = parser.parse_args()
 countdown = int(args.count)
 debug = 0
@@ -149,8 +151,10 @@
     bpf_text = bpf_text.replace('STORAGE', 'BPF_HISTOGRAM(dist);')
     bpf_text = bpf_text.replace('STORE',
         'dist.increment(bpf_log2l(delta));')
-if debug:
+if debug or args.ebpf:
     print(bpf_text)
+    if args.ebpf:
+        exit()
 
 b = BPF(text=bpf_text)
 b.attach_kprobe(event="finish_task_switch", fn_name="sched_switch")

diff --git a/tools/cpuunclaimed.py b/tools/cpuunclaimed.py
@@ -87,6 +87,8 @@
     help="output interval, in seconds")
 parser.add_argument("count", nargs="?", default=99999999,
     help="number of outputs")
+parser.add_argument("--ebpf", action="store_true",
+    help=argparse.SUPPRESS)
 args = parser.parse_args()
 countdown = int(args.count)
 frequency = 99
@@ -155,8 +157,10 @@
 """
 
 # code substitutions
-if debug:
+if debug or args.ebpf:
     print(bpf_text)
+    if args.ebpf:
+        exit()
 
 # initialize BPF & perf_events
 b = BPF(text=bpf_text)

diff --git a/tools/dbslower.py b/tools/dbslower.py
@@ -51,6 +51,8 @@
     dest="path", metavar="PATH", help="path to binary")
 parser.add_argument("-m", "--threshold", type=int, default=1,
     help="trace queries slower than this threshold (ms)")
+parser.add_argument("--ebpf", action="store_true",
+    help=argparse.SUPPRESS)
 args = parser.parse_args()
 
 threshold_ns = args.threshold * 1000000
@@ -196,8 +198,10 @@
 
     bpf = BPF(text=program, usdt_contexts=usdts)
 
-if args.verbose:
+if args.verbose or args.ebpf:
     print(program)
+    if args.ebpf:
+        exit()
 
 class Data(ct.Structure):
     _fields_ = [

diff --git a/tools/dcsnoop.py b/tools/dcsnoop.py
@@ -38,6 +38,8 @@
     epilog=examples)
 parser.add_argument("-a", "--all", action="store_true",
     help="trace all lookups (default is fails only)")
+parser.add_argument("--ebpf", action="store_true",
+    help=argparse.SUPPRESS)
 args = parser.parse_args()
 
 # define BPF program
@@ -132,6 +134,10 @@ class Data(ct.Structure):
         ("filename", ct.c_char * MAX_FILE_LEN),
     ]
 
+if args.ebpf:
+    print(bpf_text)
+    exit()
+
 # initialize BPF
 b = BPF(text=bpf_text)
 if args.all:

diff --git a/tools/execsnoop.py b/tools/execsnoop.py
@@ -46,6 +46,8 @@
     help="only print commands where arg contains this line (regex)")
 parser.add_argument("--max-args", default="20",
     help="maximum number of arguments parsed and displayed, defaults to 20")
+parser.add_argument("--ebpf", action="store_true",
+    help=argparse.SUPPRESS)
 args = parser.parse_args()
 
 # define BPF program
@@ -128,8 +130,13 @@
 }
 """
 
+bpf_text.replace("MAXARG", args.max_args)
+if args.ebpf:
+    print(bpf_text)
+    exit()
+
 # initialize BPF
-b = BPF(text=bpf_text.replace("MAXARG", args.max_args))
+b = BPF(text=bpf_text)
 
 # header
 if args.timestamp:

diff --git a/tools/ext4dist.py b/tools/ext4dist.py
@@ -40,6 +40,8 @@
     help="output interval, in seconds")
 parser.add_argument("count", nargs="?", default=99999999,
     help="number of outputs")
+parser.add_argument("--ebpf", action="store_true",
+    help=argparse.SUPPRESS)
 args = parser.parse_args()
 pid = args.pid
 countdown = int(args.count)
@@ -163,8 +165,10 @@
     bpf_text = bpf_text.replace('FILTER_PID', 'pid != %s' % pid)
 else:
     bpf_text = bpf_text.replace('FILTER_PID', '0')
-if debug:
+if debug or args.ebpf:
     print(bpf_text)
+    if args.ebpf:
+        exit()
 
 # load BPF program
 b = BPF(text=bpf_text)

diff --git a/tools/ext4slower.py b/tools/ext4slower.py
@@ -51,6 +51,8 @@
     help="trace this PID only")
 parser.add_argument("min_ms", nargs="?", default='10',
     help="minimum I/O duration to trace, in ms (default 10)")
+parser.add_argument("--ebpf", action="store_true",
+    help=argparse.SUPPRESS)
 args = parser.parse_args()
 min_ms = int(args.min_ms)
 pid = args.pid
@@ -274,8 +276,10 @@
     bpf_text = bpf_text.replace('FILTER_PID', 'pid != %s' % pid)
 else:
     bpf_text = bpf_text.replace('FILTER_PID', '0')
-if debug:
+if debug or args.ebpf:
     print(bpf_text)
+    if args.ebpf:
+        exit()
 
 # kernel->user event data: struct data_t
 DNAME_INLINE_LEN = 32   # linux/dcache.h

diff --git a/tools/filelife.py b/tools/filelife.py
@@ -34,6 +34,8 @@
     epilog=examples)
 parser.add_argument("-p", "--pid",
     help="trace this PID only")
+parser.add_argument("--ebpf", action="store_true",
+    help=argparse.SUPPRESS)
 args = parser.parse_args()
 debug = 0
 
@@ -114,8 +116,10 @@ class Data(ct.Structure):
         'if (pid != %s) { return 0; }' % args.pid)
 else:
     bpf_text = bpf_text.replace('FILTER', '')
-if debug:
+if debug or args.ebpf:
     print(bpf_text)
+    if args.ebpf:
+        exit()
 
 # initialize BPF
 b = BPF(text=bpf_text)

diff --git a/tools/fileslower.py b/tools/fileslower.py
@@ -50,6 +50,8 @@
     help="include non-regular file types (sockets, FIFOs, etc)")
 parser.add_argument("min_ms", nargs="?", default='10',
     help="minimum I/O duration to trace, in ms (default 10)")
+parser.add_argument("--ebpf", action="store_true",
+    help=argparse.SUPPRESS)
 args = parser.parse_args()
 min_ms = int(args.min_ms)
 tgid = args.tgid
@@ -185,11 +187,13 @@
 else:
     bpf_text = bpf_text.replace('TYPE_FILTER', '!S_ISREG(mode)')
 
-if debug:
+if debug or args.ebpf:
     print(bpf_text)
+    if args.ebpf:
+        exit()
 
 # initialize BPF
-b = BPF(text=bpf_text,)
+b = BPF(text=bpf_text)
 
 # I'd rather trace these via new_sync_read/new_sync_write (which used to be
 # do_sync_read/do_sync_write), but those became static. So trace these from

diff --git a/tools/filetop.py b/tools/filetop.py
@@ -47,6 +47,8 @@
     help="output interval, in seconds")
 parser.add_argument("count", nargs="?", default=99999999,
     help="number of outputs")
+parser.add_argument("--ebpf", action="store_true",
+    help=argparse.SUPPRESS)
 args = parser.parse_args()
 interval = int(args.interval)
 countdown = int(args.count)
@@ -149,8 +151,10 @@ def signal_ignore(signal, frame):
 else:
     bpf_text = bpf_text.replace('TYPE_FILTER', '!S_ISREG(mode)')
 
-if debug:
+if debug or args.ebpf:
     print(bpf_text)
+    if args.ebpf:
+        exit()
 
 # initialize BPF
 b = BPF(text=bpf_text)

diff --git a/tools/funclatency.py b/tools/funclatency.py
@@ -63,6 +63,8 @@
     help="print the BPF program (for debugging purposes)")
 parser.add_argument("pattern",
     help="search expression for functions")
+parser.add_argument("--ebpf", action="store_true",
+    help=argparse.SUPPRESS)
 args = parser.parse_args()
 
 def bail(error):
@@ -184,8 +186,10 @@ def bail(error):
     bpf_text = bpf_text.replace('ENTRYSTORE', '')
     bpf_text = bpf_text.replace('STORE',
         'dist.increment(bpf_log2l(delta));')
-if args.verbose:
+if args.verbose or args.ebpf:
     print(bpf_text)
+    if args.ebpf:
+        exit()
 
 # signal handler
 def signal_ignore(signal, frame):

diff --git a/tools/funcslower.py b/tools/funcslower.py
@@ -55,6 +55,8 @@
     help="print the BPF program for debugging purposes")
 parser.add_argument(metavar="function", nargs="+", dest="functions",
     help="function(s) to trace")
+parser.add_argument("--ebpf", action="store_true",
+    help=argparse.SUPPRESS)
 
 args = parser.parse_args()
 # fractions are allowed, but rounded to an integer nanosecond
@@ -165,8 +167,10 @@
 }
 """ % (i, i)
 
-if args.verbose:
+if args.verbose or args.ebpf:
     print(bpf_text)
+    if args.ebpf:
+        exit()
 
 b = BPF(text=bpf_text)
 

diff --git a/tools/gethostlatency.py b/tools/gethostlatency.py
@@ -31,6 +31,8 @@
     epilog=examples)
 parser.add_argument("-p", "--pid", help="trace this PID only", type=int,
     default=-1)
+parser.add_argument("--ebpf", action="store_true",
+    help=argparse.SUPPRESS)
 args = parser.parse_args()
 
 # load BPF program
@@ -94,6 +96,10 @@
     return 0;
 }
 """
+if args.ebpf:
+    print(bpf_text)
+    exit()
+
 b = BPF(text=bpf_text)
 b.attach_uprobe(name="c", sym="getaddrinfo", fn_name="do_entry", pid=args.pid)
 b.attach_uprobe(name="c", sym="gethostbyname", fn_name="do_entry",

diff --git a/tools/hardirqs.py b/tools/hardirqs.py
@@ -41,6 +41,8 @@
     help="output interval, in seconds")
 parser.add_argument("outputs", nargs="?", default=99999999,
     help="number of outputs")
+parser.add_argument("--ebpf", action="store_true",
+    help=argparse.SUPPRESS)
 args = parser.parse_args()
 countdown = int(args.outputs)
 if args.count and (args.dist or args.nanoseconds):
@@ -136,8 +138,10 @@
         'bpf_probe_read(&key.name, sizeof(key.name), name);' +
         'u64 zero = 0, *vp = dist.lookup_or_init(&key, &zero);' +
         '(*vp) += delta;')
-if debug:
+if debug or args.ebpf:
     print(bpf_text)
+    if args.ebpf:
+        exit()
 
 # load BPF program
 b = BPF(text=bpf_text)

diff --git a/tools/killsnoop.py b/tools/killsnoop.py
@@ -32,6 +32,8 @@
     help="only show failed kill syscalls")
 parser.add_argument("-p", "--pid",
     help="trace this PID only")
+parser.add_argument("--ebpf", action="store_true",
+    help=argparse.SUPPRESS)
 args = parser.parse_args()
 debug = 0
 
@@ -102,8 +104,10 @@
         'if (pid != %s) { return 0; }' % args.pid)
 else:
     bpf_text = bpf_text.replace('FILTER', '')
-if debug:
+if debug or args.ebpf:
     print(bpf_text)
+    if args.ebpf:
+        exit()
 
 # initialize BPF
 b = BPF(text=bpf_text)

diff --git a/tools/llcstat.py b/tools/llcstat.py
@@ -28,10 +28,12 @@
     help="Sample one in this many number of cache reference / miss events")
 parser.add_argument(
     "duration", nargs="?", default=10, help="Duration, in seconds, to run")
+parser.add_argument("--ebpf", action="store_true",
+    help=argparse.SUPPRESS)
 args = parser.parse_args()
 
 # load BPF program
-b = BPF(text="""
+bpf_text="""
 #include <linux/ptrace.h>
 #include <uapi/linux/bpf_perf_event.h>
 
@@ -71,8 +73,13 @@
 
     return 0;
 }
-""")
+"""
 
+if args.ebpf:
+    print(bpf_text)
+    exit()
+
+b = BPF(text=bpf_text)
 b.attach_perf_event(
     ev_type=PerfType.HARDWARE, ev_config=PerfHWConfig.CACHE_MISSES,
     fn_name="on_cache_miss", sample_period=args.sample_period)