diff --git a/.gitignore b/.gitignore index 8d853b8..f8d81b9 100644 --- a/.gitignore +++ b/.gitignore @@ -64,6 +64,6 @@ src/12-profile/profile /sockfilter /tc /ksyscall - +ecli-server ecc ecli diff --git a/src/30-openssl/.gitignore b/src/30-openssl/.gitignore new file mode 100644 index 0000000..7afe9c3 --- /dev/null +++ b/src/30-openssl/.gitignore @@ -0,0 +1,9 @@ +.vscode +package.json +*.o +*.skel.json +*.skel.yaml +package.yaml +ecli +bootstrap +openssl diff --git a/src/30-openssl/Makefile b/src/30-openssl/Makefile new file mode 100644 index 0000000..4fb616c --- /dev/null +++ b/src/30-openssl/Makefile @@ -0,0 +1,141 @@ +# SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) +OUTPUT := .output +CLANG ?= clang +LIBBPF_SRC := $(abspath ../../libbpf/src) +BPFTOOL_SRC := $(abspath ../../bpftool/src) +LIBBPF_OBJ := $(abspath $(OUTPUT)/libbpf.a) +BPFTOOL_OUTPUT ?= $(abspath $(OUTPUT)/bpftool) +BPFTOOL ?= $(BPFTOOL_OUTPUT)/bootstrap/bpftool +LIBBLAZESYM_SRC := $(abspath ../../blazesym/) +LIBBLAZESYM_OBJ := $(abspath $(OUTPUT)/libblazesym.a) +LIBBLAZESYM_HEADER := $(abspath $(OUTPUT)/blazesym.h) +ARCH ?= $(shell uname -m | sed 's/x86_64/x86/' \ + | sed 's/arm.*/arm/' \ + | sed 's/aarch64/arm64/' \ + | sed 's/ppc64le/powerpc/' \ + | sed 's/mips.*/mips/' \ + | sed 's/riscv64/riscv/' \ + | sed 's/loongarch64/loongarch/') +VMLINUX := ../../vmlinux/$(ARCH)/vmlinux.h +# Use our own libbpf API headers and Linux UAPI headers distributed with +# libbpf to avoid dependency on system-wide headers, which could be missing or +# outdated +INCLUDES := -I$(OUTPUT) -I../../libbpf/include/uapi -I$(dir $(VMLINUX)) +CFLAGS := -g -Wall +ALL_LDFLAGS := $(LDFLAGS) $(EXTRA_LDFLAGS) + +APPS = bootstrap # minimal minimal_legacy uprobe kprobe fentry usdt sockfilter tc ksyscall + +CARGO ?= $(shell which cargo) +ifeq ($(strip $(CARGO)),) +BZS_APPS := +else +BZS_APPS := # profile +APPS += $(BZS_APPS) +# Required by libblazesym +ALL_LDFLAGS += -lrt -ldl -lpthread -lm +endif + +# Get Clang's default includes on this system. We'll explicitly add these dirs +# to the includes list when compiling with `-target bpf` because otherwise some +# architecture-specific dirs will be "missing" on some architectures/distros - +# headers such as asm/types.h, asm/byteorder.h, asm/socket.h, asm/sockios.h, +# sys/cdefs.h etc. might be missing. +# +# Use '-idirafter': Don't interfere with include mechanics except where the +# build would have failed anyways. +CLANG_BPF_SYS_INCLUDES ?= $(shell $(CLANG) -v -E - &1 \ + | sed -n '/<...> search starts here:/,/End of search list./{ s| \(/.*\)|-idirafter \1|p }') + +ifeq ($(V),1) + Q = + msg = +else + Q = @ + msg = @printf ' %-8s %s%s\n' \ + "$(1)" \ + "$(patsubst $(abspath $(OUTPUT))/%,%,$(2))" \ + "$(if $(3), $(3))"; + MAKEFLAGS += --no-print-directory +endif + +define allow-override + $(if $(or $(findstring environment,$(origin $(1))),\ + $(findstring command line,$(origin $(1)))),,\ + $(eval $(1) = $(2))) +endef + +$(call allow-override,CC,$(CROSS_COMPILE)cc) +$(call allow-override,LD,$(CROSS_COMPILE)ld) + +.PHONY: all +all: $(APPS) + +.PHONY: clean +clean: + $(call msg,CLEAN) + $(Q)rm -rf $(OUTPUT) $(APPS) + +$(OUTPUT) $(OUTPUT)/libbpf $(BPFTOOL_OUTPUT): + $(call msg,MKDIR,$@) + $(Q)mkdir -p $@ + +# Build libbpf +$(LIBBPF_OBJ): $(wildcard $(LIBBPF_SRC)/*.[ch] $(LIBBPF_SRC)/Makefile) | $(OUTPUT)/libbpf + $(call msg,LIB,$@) + $(Q)$(MAKE) -C $(LIBBPF_SRC) BUILD_STATIC_ONLY=1 \ + OBJDIR=$(dir $@)/libbpf DESTDIR=$(dir $@) \ + INCLUDEDIR= LIBDIR= UAPIDIR= \ + install + +# Build bpftool +$(BPFTOOL): | $(BPFTOOL_OUTPUT) + $(call msg,BPFTOOL,$@) + $(Q)$(MAKE) ARCH= CROSS_COMPILE= OUTPUT=$(BPFTOOL_OUTPUT)/ -C $(BPFTOOL_SRC) bootstrap + + +$(LIBBLAZESYM_SRC)/target/release/libblazesym.a:: + $(Q)cd $(LIBBLAZESYM_SRC) && $(CARGO) build --features=cheader,dont-generate-test-files --release + +$(LIBBLAZESYM_OBJ): $(LIBBLAZESYM_SRC)/target/release/libblazesym.a | $(OUTPUT) + $(call msg,LIB, $@) + $(Q)cp $(LIBBLAZESYM_SRC)/target/release/libblazesym.a $@ + +$(LIBBLAZESYM_HEADER): $(LIBBLAZESYM_SRC)/target/release/libblazesym.a | $(OUTPUT) + $(call msg,LIB,$@) + $(Q)cp $(LIBBLAZESYM_SRC)/target/release/blazesym.h $@ + +# Build BPF code +$(OUTPUT)/%.bpf.o: %.bpf.c $(LIBBPF_OBJ) $(wildcard %.h) $(VMLINUX) | $(OUTPUT) $(BPFTOOL) + $(call msg,BPF,$@) + $(Q)$(CLANG) -g -O2 -target bpf -D__TARGET_ARCH_$(ARCH) \ + $(INCLUDES) $(CLANG_BPF_SYS_INCLUDES) \ + -c $(filter %.c,$^) -o $(patsubst %.bpf.o,%.tmp.bpf.o,$@) + $(Q)$(BPFTOOL) gen object $@ $(patsubst %.bpf.o,%.tmp.bpf.o,$@) + +# Generate BPF skeletons +$(OUTPUT)/%.skel.h: $(OUTPUT)/%.bpf.o | $(OUTPUT) $(BPFTOOL) + $(call msg,GEN-SKEL,$@) + $(Q)$(BPFTOOL) gen skeleton $< > $@ + +# Build user-space code +$(patsubst %,$(OUTPUT)/%.o,$(APPS)): %.o: %.skel.h + +$(OUTPUT)/%.o: %.c $(wildcard %.h) | $(OUTPUT) + $(call msg,CC,$@) + $(Q)$(CC) $(CFLAGS) $(INCLUDES) -c $(filter %.c,$^) -o $@ + +$(patsubst %,$(OUTPUT)/%.o,$(BZS_APPS)): $(LIBBLAZESYM_HEADER) + +$(BZS_APPS): $(LIBBLAZESYM_OBJ) + +# Build application binary +$(APPS): %: $(OUTPUT)/%.o $(LIBBPF_OBJ) | $(OUTPUT) + $(call msg,BINARY,$@) + $(Q)$(CC) $(CFLAGS) $^ $(ALL_LDFLAGS) -lelf -lz -o $@ + +# delete failed targets +.DELETE_ON_ERROR: + +# keep intermediate (.skel.h, .bpf.o, etc) targets +.SECONDARY: diff --git a/src/30-openssl/README.md b/src/30-openssl/README.md new file mode 100644 index 0000000..61d5d1d --- /dev/null +++ b/src/30-openssl/README.md @@ -0,0 +1,5 @@ +# eBPF openssl + +TODO: make it work + +from https://github.com/kiosk404/openssl_tracer diff --git a/src/30-openssl/common.h b/src/30-openssl/common.h new file mode 100644 index 0000000..472a2c4 --- /dev/null +++ b/src/30-openssl/common.h @@ -0,0 +1,41 @@ +#ifndef COMMON_H +#define COMMON_H + +#ifdef DEBUG_PRINT +#define debug_bpf_printk(fmt, ...) \ + do { \ + char s[] = fmt; \ + bpf_trace_printk(s, sizeof(s), ##__VA_ARGS__); \ + } while (0) +#else +#define debug_bpf_printk(fmt, ...) +#endif + +#define TASK_COMM_LEN 16 +#define MAX_DATA_SIZE_OPENSSL 1024 * 4 +#define MAX_DATA_SIZE_MYSQL 256 +#define MAX_DATA_SIZE_POSTGRES 256 +#define MAX_DATA_SIZE_BASH 256 + +// enum_server_command, via +// https://dev.mysql.com/doc/internals/en/com-query.html COM_QUERT command 03 +#define COM_QUERY 3 + +#define AF_INET 2 +#define AF_INET6 10 +#define SA_DATA_LEN 14 +#define BASH_ERRNO_DEFAULT 128 + +// Optional Target PID +// .rodata section bug via : https://github.com/ehids/ecapture/issues/39 +#ifndef KERNEL_LESS_5_2 +const volatile u64 target_pid = 0; +const volatile int target_errno = BASH_ERRNO_DEFAULT; +#else +// u64 target_pid = 0; +#endif + +char __license[] SEC("license") = "Dual MIT/GPL"; +__u32 _version SEC("version") = 0xFFFFFFFE; + +#endif \ No newline at end of file diff --git a/src/30-openssl/openssl.bpf.c b/src/30-openssl/openssl.bpf.c new file mode 100644 index 0000000..94cf442 --- /dev/null +++ b/src/30-openssl/openssl.bpf.c @@ -0,0 +1,248 @@ +#include "openssl_trace.bpf.h" + +enum ssl_data_event_type { kSSLRead, kSSLWrite }; +const u32 invalidFD = 0; + +struct ssl_data_event_t { + enum ssl_data_event_type type; + u64 timestamp_ns; + u32 pid; + u32 tid; + char data[MAX_DATA_SIZE_OPENSSL]; + s32 data_len; + char comm[TASK_COMM_LEN]; + u32 fd; +}; + +struct { + __uint(type, BPF_MAP_TYPE_PERF_EVENT_ARRAY); +} tls_events SEC(".maps"); + +struct active_ssl_buf { + u32 fd; + const char* buf; +}; + +// BPF programs are limited to a 512-byte stack. We store this value per CPU +// and use it as a heap allocated value. +struct { + __uint(type, BPF_MAP_TYPE_PERCPU_ARRAY); + __type(key, u32); + __type(value, struct ssl_data_event_t); + __uint(max_entries, 1); +} data_buffer_heap SEC(".maps"); + +struct { + __uint(type, BPF_MAP_TYPE_HASH); + __type(key, u64); + __type(value, struct active_ssl_buf); + __uint(max_entries, 1024); +} active_ssl_read_args_map SEC(".maps"); + +struct { + __uint(type, BPF_MAP_TYPE_HASH); + __type(key, u64); + __type(value, struct active_ssl_buf); + __uint(max_entries, 1024); +} active_ssl_write_args_map SEC(".maps"); + +// OPENSSL struct to offset , via kern/README.md +typedef long (*unused_fn)(); + +struct unused {}; + +struct BIO { + const struct unused* method; + unused_fn callback; + unused_fn callback_ex; + char* cb_arg; /* first argument for the callback */ + int init; + int shutdown; + int flags; /* extra storage */ + int retry_reason; + int num; +}; + +struct ssl_st { + int version; + struct unused* method; + struct BIO* rbio; // used by SSL_read + struct BIO* wbio; // used by SSL_write +}; + +/*********************************************************** + * General helper functions + ***********************************************************/ +static __inline struct ssl_data_event_t* create_ssl_data_event( + u64 current_pid_tgid) { + u32 kZero = 0; + struct ssl_data_event_t* event = + bpf_map_lookup_elem(&data_buffer_heap, &kZero); + if (event == NULL) { + return NULL; + } + + const u32 kMask32b = 0xffffffff; + event->timestamp_ns = bpf_ktime_get_ns(); + event->pid = current_pid_tgid >> 32; + event->tid = current_pid_tgid & kMask32b; + event->fd = invalidFD; + + return event; +} + +/*********************************************************** + * BPF syscall processing functions + ***********************************************************/ +static int process_SSL_data(struct pt_regs* ctx, u64 id, + enum ssl_data_event_type type, const char* buf, + u32 fd) { + int len = (int)PT_REGS_RC(ctx); + if (len < 0) { + return 0; + } + + struct ssl_data_event_t* event = create_ssl_data_event(id); + if (event == NULL) { + return 0; + } + + event->type = type; + event->fd = fd; + // This is a max function, but it is written in such a way to keep older BPF + // verifiers happy. + event->data_len = + (len < MAX_DATA_SIZE_OPENSSL ? (len & (MAX_DATA_SIZE_OPENSSL - 1)) + : MAX_DATA_SIZE_OPENSSL); + bpf_probe_read(event->data, event->data_len, buf); + bpf_get_current_comm(&event->comm, sizeof(event->comm)); + bpf_perf_event_output(ctx, &tls_events, BPF_F_CURRENT_CPU, event, + sizeof(struct ssl_data_event_t)); + return 0; +} + +/*********************************************************** + * BPF probe function entry-points + ***********************************************************/ + +// Function signature being probed: +// int SSL_write(SSL *ssl, const void *buf, int num); +SEC("uprobe/SSL_write") +int probe_entry_SSL_write(struct pt_regs* ctx) { + u64 current_pid_tgid = bpf_get_current_pid_tgid(); + u32 pid = current_pid_tgid >> 32; + +#ifndef KERNEL_LESS_5_2 + // if target_ppid is 0 then we target all pids + if (target_pid != 0 && target_pid != pid) { + return 0; + } +#endif + // debug_bpf_printk("openssl uprobe/SSL_write pid :%d\n", pid); + + void* ssl = (void*)PT_REGS_PARM1(ctx); + // https://github.com/openssl/openssl/blob/OpenSSL_1_1_1-stable/crypto/bio/bio_local.h + struct ssl_st ssl_info; + bpf_probe_read_user(&ssl_info, sizeof(ssl_info), ssl); + + struct BIO bio_w; + bpf_probe_read_user(&bio_w, sizeof(bio_w), ssl_info.wbio); + + // get fd ssl->wbio->num + u32 fd = bio_w.num; + // debug_bpf_printk("openssl uprobe SSL_write FD:%d\n", fd); + + const char* buf = (const char*)PT_REGS_PARM2(ctx); + struct active_ssl_buf active_ssl_buf_t; + __builtin_memset(&active_ssl_buf_t, 0, sizeof(active_ssl_buf_t)); + active_ssl_buf_t.fd = fd; + active_ssl_buf_t.buf = buf; + bpf_map_update_elem(&active_ssl_write_args_map, ¤t_pid_tgid, + &active_ssl_buf_t, BPF_ANY); + + return 0; +} + +SEC("uretprobe/SSL_write") +int probe_ret_SSL_write(struct pt_regs* ctx) { + u64 current_pid_tgid = bpf_get_current_pid_tgid(); + u32 pid = current_pid_tgid >> 32; + +#ifndef KERNEL_LESS_5_2 + // if target_ppid is 0 then we target all pids + if (target_pid != 0 && target_pid != pid) { + return 0; + } +#endif + // debug_bpf_printk("openssl uretprobe/SSL_write pid :%d\n", pid); + struct active_ssl_buf* active_ssl_buf_t = + bpf_map_lookup_elem(&active_ssl_write_args_map, ¤t_pid_tgid); + if (active_ssl_buf_t != NULL) { + const char* buf; + u32 fd = active_ssl_buf_t->fd; + bpf_probe_read(&buf, sizeof(const char*), &active_ssl_buf_t->buf); + process_SSL_data(ctx, current_pid_tgid, kSSLWrite, buf, fd); + } + bpf_map_delete_elem(&active_ssl_write_args_map, ¤t_pid_tgid); + return 0; +} + +// Function signature being probed: +// int SSL_read(SSL *s, void *buf, int num) +SEC("uprobe/SSL_read") +int probe_entry_SSL_read(struct pt_regs* ctx) { + u64 current_pid_tgid = bpf_get_current_pid_tgid(); + u32 pid = current_pid_tgid >> 32; + +#ifndef KERNEL_LESS_5_2 + // if target_ppid is 0 then we target all pids + if (target_pid != 0 && target_pid != pid) { + return 0; + } +#endif + + void* ssl = (void*)PT_REGS_PARM1(ctx); + // https://github.com/openssl/openssl/blob/OpenSSL_1_1_1-stable/crypto/bio/bio_local.h + struct ssl_st ssl_info; + bpf_probe_read_user(&ssl_info, sizeof(ssl_info), ssl); + + struct BIO bio_r; + bpf_probe_read_user(&bio_r, sizeof(bio_r), ssl_info.rbio); + + // get fd ssl->rbio->num + u32 fd = bio_r.num; + debug_bpf_printk("openssl uprobe PID:%d, SSL_read FD:%d\n", pid, fd); + + const char* buf = (const char*)PT_REGS_PARM2(ctx); + struct active_ssl_buf active_ssl_buf_t; + __builtin_memset(&active_ssl_buf_t, 0, sizeof(active_ssl_buf_t)); + active_ssl_buf_t.fd = fd; + active_ssl_buf_t.buf = buf; + bpf_map_update_elem(&active_ssl_read_args_map, ¤t_pid_tgid, + &active_ssl_buf_t, BPF_ANY); + return 0; +} + +SEC("uretprobe/SSL_read") +int probe_ret_SSL_read(struct pt_regs* ctx) { + u64 current_pid_tgid = bpf_get_current_pid_tgid(); + u32 pid = current_pid_tgid >> 32; + +#ifndef KERNEL_LESS_5_2 + // if target_ppid is 0 then we target all pids + if (target_pid != 0 && target_pid != pid) { + return 0; + } +#endif + + struct active_ssl_buf* active_ssl_buf_t = + bpf_map_lookup_elem(&active_ssl_read_args_map, ¤t_pid_tgid); + if (active_ssl_buf_t != NULL) { + const char* buf; + u32 fd = active_ssl_buf_t->fd; + bpf_probe_read(&buf, sizeof(const char*), &active_ssl_buf_t->buf); + process_SSL_data(ctx, current_pid_tgid, kSSLRead, buf, fd); + } + bpf_map_delete_elem(&active_ssl_read_args_map, ¤t_pid_tgid); + return 0; +} \ No newline at end of file diff --git a/src/30-openssl/openssl.bpf.h b/src/30-openssl/openssl.bpf.h new file mode 100644 index 0000000..c9e3a0a --- /dev/null +++ b/src/30-openssl/openssl.bpf.h @@ -0,0 +1,11 @@ +#ifndef OPENSS_TRACE_BPF_H +#define OPENSS_TRACE_BPF_H + +//CO:RE is enabled +#include "headers/vmlinux.h" +#include +#include +#include +#include "common.h" + +#endif \ No newline at end of file diff --git a/src/30-openssl/openssl.c b/src/30-openssl/openssl.c new file mode 100644 index 0000000..c93e4ed --- /dev/null +++ b/src/30-openssl/openssl.c @@ -0,0 +1,173 @@ +// SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) +/* Copyright (c) 2020 Facebook */ +#include +#include +#include +#include +#include +#include +#include "openssl.h" +#include "openssl.skel.h" + +static struct env { + bool verbose; + long min_duration_ms; +} env; + +const char *argp_program_version = "openssl 0.0"; +const char *argp_program_bug_address = ""; +const char argp_program_doc[] = +"BPF openssl demo application.\n" +"\n" +"It traces process start and exits and shows associated \n" +"information (filename, process duration, PID and PPID, etc).\n" +"\n" +"USAGE: ./openssl [-d ] [-v]\n"; + +static const struct argp_option opts[] = { + { "verbose", 'v', NULL, 0, "Verbose debug output" }, + { "duration", 'd', "DURATION-MS", 0, "Minimum process duration (ms) to report" }, + {}, +}; + +static error_t parse_arg(int key, char *arg, struct argp_state *state) +{ + switch (key) { + case 'v': + env.verbose = true; + break; + case 'd': + errno = 0; + env.min_duration_ms = strtol(arg, NULL, 10); + if (errno || env.min_duration_ms <= 0) { + fprintf(stderr, "Invalid duration: %s\n", arg); + argp_usage(state); + } + break; + case ARGP_KEY_ARG: + argp_usage(state); + break; + default: + return ARGP_ERR_UNKNOWN; + } + return 0; +} + +static const struct argp argp = { + .options = opts, + .parser = parse_arg, + .doc = argp_program_doc, +}; + +static int libbpf_print_fn(enum libbpf_print_level level, const char *format, va_list args) +{ + if (level == LIBBPF_DEBUG && !env.verbose) + return 0; + return vfprintf(stderr, format, args); +} + +static volatile bool exiting = false; + +static void sig_handler(int sig) +{ + exiting = true; +} + +static int handle_event(void *ctx, void *data, size_t data_sz) +{ + const struct event *e = data; + struct tm *tm; + char ts[32]; + time_t t; + + time(&t); + tm = localtime(&t); + strftime(ts, sizeof(ts), "%H:%M:%S", tm); + + if (e->exit_event) { + printf("%-8s %-5s %-16s %-7d %-7d [%u]", + ts, "EXIT", e->comm, e->pid, e->ppid, e->exit_code); + if (e->duration_ns) + printf(" (%llums)", e->duration_ns / 1000000); + printf("\n"); + } else { + printf("%-8s %-5s %-16s %-7d %-7d %s\n", + ts, "EXEC", e->comm, e->pid, e->ppid, e->filename); + } + + return 0; +} + +int main(int argc, char **argv) +{ + struct ring_buffer *rb = NULL; + struct openssl_bpf *skel; + int err; + + /* Parse command line arguments */ + err = argp_parse(&argp, argc, argv, 0, NULL, NULL); + if (err) + return err; + + /* Set up libbpf errors and debug info callback */ + libbpf_set_print(libbpf_print_fn); + + /* Cleaner handling of Ctrl-C */ + signal(SIGINT, sig_handler); + signal(SIGTERM, sig_handler); + + /* Load and verify BPF application */ + skel = openssl_bpf__open(); + if (!skel) { + fprintf(stderr, "Failed to open and load BPF skeleton\n"); + return 1; + } + + /* Parameterize BPF code with minimum duration parameter */ + skel->rodata->min_duration_ns = env.min_duration_ms * 1000000ULL; + + /* Load & verify BPF programs */ + err = openssl_bpf__load(skel); + if (err) { + fprintf(stderr, "Failed to load and verify BPF skeleton\n"); + goto cleanup; + } + + /* Attach tracepoints */ + err = openssl_bpf__attach(skel); + if (err) { + fprintf(stderr, "Failed to attach BPF skeleton\n"); + goto cleanup; + } + + /* Set up ring buffer polling */ + rb = ring_buffer__new(bpf_map__fd(skel->maps.rb), handle_event, NULL, NULL); + if (!rb) { + err = -1; + fprintf(stderr, "Failed to create ring buffer\n"); + goto cleanup; + } + + /* Process events */ + printf("%-8s %-5s %-16s %-7s %-7s %s\n", + "TIME", "EVENT", "COMM", "PID", "PPID", "FILENAME/EXIT CODE"); + while (!exiting) { + err = ring_buffer__poll(rb, 100 /* timeout, ms */); + /* Ctrl-C will cause -EINTR */ + if (err == -EINTR) { + err = 0; + break; + } + if (err < 0) { + printf("Error polling perf buffer: %d\n", err); + break; + } + } + +cleanup: + /* Clean up */ + ring_buffer__free(rb); + openssl_bpf__destroy(skel); + + return err < 0 ? -err : 0; +} diff --git a/src/30-openssl/ssl_client_server/Makefile b/src/30-openssl/ssl_client_server/Makefile new file mode 100644 index 0000000..5488d85 --- /dev/null +++ b/src/30-openssl/ssl_client_server/Makefile @@ -0,0 +1,9 @@ + +certs: + openssl req -x509 -nodes -newkey rsa:4096 -keyout client.key -out client.crt -days 365 -subj '/CN=example.com' + openssl req -x509 -nodes -newkey rsa:4096 -keyout server.key -out server.crt -days 365 -subj '/CN=example.com' + +clean: + rm -f client.key client.crt + rm -f server.key server.crt + diff --git a/src/30-openssl/ssl_client_server/README.md b/src/30-openssl/ssl_client_server/README.md new file mode 100644 index 0000000..7330ad5 --- /dev/null +++ b/src/30-openssl/ssl_client_server/README.md @@ -0,0 +1,62 @@ +# openssl_tracer + +> openssl_tracer: 基于eBPF技术实现TLS加密的明文捕获。 + +该样例项目是基于eBPF来追踪OpenSSL动态库的例子,使用 libbpf 进行追踪。在eBPF 程序中, +由于 libbpf 方法内核已经支持了 BTF,不再需要引入众多的内核头文件来获取内核数据结构的定义, +取而代之的是 bpftool 生成的 vmlinux.h 头文件,其中包含内核数据结构的定义。 + +这个样例是为了配合“使用eBPF跟踪 SSL/TLS 连接” [这个 Blog](https://kiosk007.top/post/%E4%BD%BF%E7%94%A8ebpf%E8%B7%9F%E8%B8%AA-ssltls-%E8%BF%9E%E6%8E%A5/) + +## OpenSSL Tracer using BPF + +![](https://ebpf.io/static/overview-bf463455a5666fc3fb841b9240d588ff.png) + + +This is a basic example of how to trace the OpenSSL library using eBPF. This tracer uses BCC to deploy the eBPF probes. This demo was created to accompany the "Debugging with eBPF Part 3: Tracing SSL/TLS connections" blog post. + + +eBPF 程序能够加载到 trace points、内核及用户空间应用程序中的 probe points, +这种能力使我们对应用程序的运行时行为(runtime behavior)和系统本身 (system itself)提供了史无前例的可观测性。 + +## Prerequisites +操作系统版本最好大于 5.x,本样例运行于 ubuntu 5.15.x 版本。 一些5.4版本以下的内核还会存在些许问题,详见 https://github.com/iovisor/bcc/issues/2948 +```bash +$ uname -r +5.15.0-30-generic +``` + +`CONFIG_DEBUG_INFO_BTF = y`,新的 BPF 二进制文件仅在设置了此内核配置选项后才可用,Ubuntu 20.10 已经将此配置选项设置为默认选项 + +需要安装 libbpf 工具,在Ubuntu 上执行以下命令, +``` bash +$ sudo apt install libbpf-dev +``` +其他操作系统有类似的命令。 + +## Build +执行以下命令 +```bash +make ebpf +make build +``` + +## Run Demo Application +该 Demo 包含一个 ssl_client_server 的 ssl 通信的小程序。运行该小程序可以稳定的运行 ssl 通信数据。 +``` bash +cd ssl_client_server; python3 ./server.py +cd ssl_client_server; python3 ./client.py +``` + +## Run Tracer +以下方式 +```bash +sudo ./openssl_tracer +``` +如果是追踪小程序,则可以 + +```bash +sudo ./openssl_tracer $(pgrep -f "./client.py") +``` + + diff --git a/src/30-openssl/ssl_client_server/client.crt b/src/30-openssl/ssl_client_server/client.crt new file mode 100644 index 0000000..d1f9b73 --- /dev/null +++ b/src/30-openssl/ssl_client_server/client.crt @@ -0,0 +1,30 @@ +-----BEGIN CERTIFICATE----- +MIIFDTCCAvWgAwIBAgIUelsm684mMQjCCN029zGerL7lN6gwDQYJKoZIhvcNAQEL +BQAwFjEUMBIGA1UEAwwLZXhhbXBsZS5jb20wHhcNMjIwNTA1MTUxNTQ1WhcNMjMw +NTA1MTUxNTQ1WjAWMRQwEgYDVQQDDAtleGFtcGxlLmNvbTCCAiIwDQYJKoZIhvcN +AQEBBQADggIPADCCAgoCggIBAL1PHUhs7Ua78Xf789ZKna+1aNnXJuJ8kzjuv3A1 +iLCvs8rJgmhThlnjXQVOsOXVUCHoajW/z6OWf9bMx/MH7z9btXdZFyWF847x37Gy +9qYroppu5grXwIZjQYPK4ZO5K8MDBfRD3M8oWvj9d5aU0/S2ia6jP+A7Az6wf8cl +BBQ32DQA7ySCocbKbaFcikqpaez1nADXg5TdBxf1YsKkYFKj4P9Il3QSByeNcRwY +ZE0x8gK7AGZEEjoUU2+IL2BqEx54yJQDYZ7NZ+5IBl7HkMYByR1PgHUhreWAMPTr +sO8/WrNj10nbJRBZEpsphAnvC5noaQ7SdqMRbr8i2y+LUA6jqtusd8OZsUwNDwD3 +g1VZZ9f1QyJ5IgV3SQqEDSFCbOS1ASqMODU7Iubpt170PiCxEUIZbP93VtP+0tuS +noI0lki/61ui+z3yhwNMzkohby+XDY79oZNw8phI5rYJmxjayzrfjGv2p1a37//p +pQiL0YKdcoL9HIe4qu8WKHH324h2RCpUw/SPhG1U4627hv97DQotA1Ee+t5+dh96 +GLVacGiRzAASprELHmfJ37/fdb170gncZh3kLaG+TV4hsMhijKjX9CW+bmwehPCe +BUuHvBYkiZVjIl937R34qznW5Cnhvktaj6sC6QU6sI6C3K3odkaCfcGR0Sb9NZ4a +zXq1AgMBAAGjUzBRMB0GA1UdDgQWBBTGX8kbOfG3OivNo2u0i4qb8fe4CjAfBgNV +HSMEGDAWgBTGX8kbOfG3OivNo2u0i4qb8fe4CjAPBgNVHRMBAf8EBTADAQH/MA0G +CSqGSIb3DQEBCwUAA4ICAQBToRKubwmK3lEKMm5mPP+lQbPO+Y0kW6OXpdAMSLCT +TP+hml/SD5+G86cj/XmxPT2BFUrEOaqfTV7Yk7QyV7Wi15Bd1dqnSINM7HzuD0WF +7MS6tQ3/qErSWmUPhgp+9smxJSsSJDyjkRZnKT0p9c/1f7J4jOhByF+OLbSMVy0c +MTV5iivgBKdZW/IQp03lc/2Tj0zbCePXR26WDiFBJ7fgkWOXZG/FmUkSp2rKNv7v +vGEo9K5nEcYzTuGnO/J5TyYxlMQrJjz2+dfSOfN/Xv9sSAifJG4M7UqcY6UWrKZ+ +r4Yd+pVAN5ahNljqC/daekKyLn8fYx1LyAGmgViV1rR53gnStutquMaHiz+UrE7N +3L2UL0lSDGR7vUMa3LuVrAHAk/GKgVRGi4qaprl2GhXpd1mDhiSW48C/C9MZGS3J +2Nwmu5hBuGdBtVhSU7rYNiU3rMxPwPcy6PgJIo4xlaKDzSvy2cSqiKND3yh9WfmV +s+xXlQG+6xr5+eiQDe3o0/li006jTv1Ypql/nf/ma5qQrhe2DsZl1WGOxo1sOpJo +IAVCIuTMnxSxvPfL9Ux47J7hA5/ovumRwiyApbOncw8/I66geHwTKG2kt3Mni53h +qP7Q2II7NqEU4BfWMUsgJAOLbXvLtwdP5+naY52GvEAK9KgipHVeSKUKASLDxzC8 +NA== +-----END CERTIFICATE----- diff --git a/src/30-openssl/ssl_client_server/client.key b/src/30-openssl/ssl_client_server/client.key new file mode 100644 index 0000000..57e7481 --- /dev/null +++ b/src/30-openssl/ssl_client_server/client.key @@ -0,0 +1,52 @@ +-----BEGIN PRIVATE KEY----- +MIIJQgIBADANBgkqhkiG9w0BAQEFAASCCSwwggkoAgEAAoICAQC9Tx1IbO1Gu/F3 ++/PWSp2vtWjZ1ybifJM47r9wNYiwr7PKyYJoU4ZZ410FTrDl1VAh6Go1v8+jln/W +zMfzB+8/W7V3WRclhfOO8d+xsvamK6KabuYK18CGY0GDyuGTuSvDAwX0Q9zPKFr4 +/XeWlNP0tomuoz/gOwM+sH/HJQQUN9g0AO8kgqHGym2hXIpKqWns9ZwA14OU3QcX +9WLCpGBSo+D/SJd0EgcnjXEcGGRNMfICuwBmRBI6FFNviC9gahMeeMiUA2GezWfu +SAZex5DGAckdT4B1Ia3lgDD067DvP1qzY9dJ2yUQWRKbKYQJ7wuZ6GkO0najEW6/ +Itsvi1AOo6rbrHfDmbFMDQ8A94NVWWfX9UMieSIFd0kKhA0hQmzktQEqjDg1OyLm +6bde9D4gsRFCGWz/d1bT/tLbkp6CNJZIv+tbovs98ocDTM5KIW8vlw2O/aGTcPKY +SOa2CZsY2ss634xr9qdWt+//6aUIi9GCnXKC/RyHuKrvFihx99uIdkQqVMP0j4Rt +VOOtu4b/ew0KLQNRHvrefnYfehi1WnBokcwAEqaxCx5nyd+/33W9e9IJ3GYd5C2h +vk1eIbDIYoyo1/Qlvm5sHoTwngVLh7wWJImVYyJfd+0d+Ks51uQp4b5LWo+rAukF +OrCOgtyt6HZGgn3BkdEm/TWeGs16tQIDAQABAoICAAH6LA+gF6BYAS8kIglYcSov +Jl+0GBNggrcjAzvcS0exJhsVnLeTO8F/lu6hwkY8QqCACW/zR2tpfH9VVzdKG20Z +e506AHxjWEZjb1cvS9UzenjLdLqjQz8EFWCXg2CkG/lm9C53cPx26vBT0WZwuoAB +UhHRYa7pXuDOPh9p2w+M/8SXR+glNyRY4+k+CrG58EHJ1O3LUnQBFPxikzv+NIVY +cdaovvA26f03RHmrJY0K2wC9TEVFK72QjciJ7xi+MuHsGAg3utLKSW4bMXnW8sOm +rB+Sv4A5sFPH0XsVZR0yl7Ns9Qgv8kSn8YJOXjMuXHwoicReXV/ZpEL5zblC5ryj +zpajbOYKRjo7Dspt2e9cStcoZg+Nax1/vg4cgQnD5VOAJtMakNPvTtEp3nDc8sKZ +yAENKJYj5f2IUIHp8m25QzXzv9qc4+KZSqYq4qefqziHD2RSkCfcG6AjkP7be75V +8gGTxpaw+2xTlzHkFaiJnlC/vPtcbNKArS4l6jxlMMQMdmffIVIuEKMGebQ8fmE6 +V6PIWSIwdRVQ+AIa8qyxwv8Gdf2gz1xK/f75GgG434MrgHJ5sfChPsM1kuB46V84 +G6BGAizEgHOFrX1P82axs8Dr8eVagmPsoN4D7XnLcVv48/4SifGqGJqfLuodlaLZ +fybPpZOD1ixTlAXFDcKnAoIBAQDfjYTHq6Sp/sD5A5aPmYpKZCnYHuipFwiL0uK4 +8U58iuC8iyGEFFum7q785NLhDBhgfYd77BkEExtj/mwVinWO/JTJJfwiet2Ay8D0 +z+FgPcVZWj0807VrdH1juBAcXfQ28i9pKnfRC25Q9BnSKQoWUwAyvECpwJacbqA7 +V8gWVtcpJqxY7qw46aeTlLGQV478IYOcYDkQXrRScfwhpiEGftoKy5rQvUakpFGu +qy1y1qbjSWc3W+Hpuf3qwdX/rNqNq1mEp1SSiv6x3L82kjO2Qln49GzxwhUnBrYx +zlMh4FkUqi+s3fQgs9othMW4j4bDI/aECA1srKRlk1rO/ouvAoIBAQDYyTX6GezB +mIx3tNcvfaEWC418nZsPL3vB7YPGMNp274SiIior4dbpAb1fOd7E+/jHSA60FCSK +B4iejgn3Py6b5qpxI9vDomoaH7E4dSY/2UP9B4MjLFR6vuamrLaT0PBlov50Q3xB +PetjnCmuL6c256bcgdzSEzoKNyM/pnkaHlC5l0osAawM/vgz2jge/K4fOgSbI+vk +Px/eGozUIq2YsAANErAhkL17f+VzSfSkohBrbGg/iCY3o+cFETfNjPMTNVD1Qm3P +PhzHuHctNqN3jJNUmngjrksOl//h+xyXySFHwyDnGKyVcC2P3nFGj4/QnG98KhiY +cyzactKCBsTbAoIBAC/IV/E1xuRvB2AyXCQldWGhNzByqtg5jCIW2U8ehOAp7w9d +zbQlhdGQguabIlfn9e3p5uOd+1rbmqcs4n1YMvh1FHhKHjJggKfe5Uduh4XCrkQC +/cPanJRzObnuxcLKckCsU2XvJd0QzGuRQVOiYf2TkB9IDao69/ZHzwfgI2xi82pg +UcZQfY9Mofzxc2Ke1Hkf0LnD926AT5qvsmyezcBNrN1R1612R3s5hBwJipVZPCKo +td8nTIpgrt1WwR79G1ncni20dmc8PmRWAqjvZw418HU+CWtDSLImxRqwNySuh1vb +ZIVWi6/RwXipQHnKc8uSDEb8UaJA5IKxlF9aGRECggEBAJLnjz9jcBAlCxNXpfbV +wGKLA58twlUBDXF2PbUBiBnO5+djFYbVLOiLOEQemDqOsaCB0QzxFW2/+zHO+Svm +UfRt1JSFAzjIh/QaA+NJZ9kepzcBbzlXogvn76+FHNiAX1fQo3QwAzTG/AttWMVk +H4FSa73D9tsZEly3zpgkfK5ZWsTZo/a8T1YjNhkVSLCe9HPOwi5Lol/y8up0vXhH +47GzmuVBA8BLMExPeDKvLCygclYJiX98CMHtvPCvIUyWtmYO3ETHdlhZM/GXrJMk +EpRB29kaME2ln9FM6aa+nzqwnm/d6B8SlmlSMl3rFIIHaSKpz9apRC+S5RNHeiWI +5r8CggEAUYVdEqAzlaLHVu5RoPhOiOhX4myi4nAt2+ewQxKDjAyBiHHtVeetzak9 +gSRyogW4nkb73831qQXkIOigBa6GQIGHg6t7W75F8f9DumWQgJPqc5CObnDohsOj +BMqBRCv6L3fXHOmNNGomEnGKDTkjrUzWgVVj4u3rPA33Di7QtF7CqMZJhVF7Hj3R +reWCh2ozYBZdYGZT5Ln/udcAptkJ6NBbQvIbGrwSnWManK6UnY/cBwFfboswDJWn +VXPi15ZP0PenKuvu6N43ez8tTIw8hz2VXKnwuyZ9oMMLerqozlfUDC9UiFPQCfmg +YJBwHSU2XT8UgdxJka4Kou0tlNpmhw== +-----END PRIVATE KEY----- diff --git a/src/30-openssl/ssl_client_server/client.py b/src/30-openssl/ssl_client_server/client.py new file mode 100755 index 0000000..e9cc31e --- /dev/null +++ b/src/30-openssl/ssl_client_server/client.py @@ -0,0 +1,50 @@ +#!/usr/bin/env python + +# Copyright 2018- The Pixie Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 + +import socket +import ssl +import time +import random + +host_addr = '127.0.0.1' +host_port = 8082 + +server_sni_hostname = 'example.com' +client_cert = 'client.crt' +client_key = 'client.key' +server_cert = 'server.crt' + +context = ssl.create_default_context(ssl.Purpose.SERVER_AUTH, cafile=server_cert) +context.load_cert_chain(certfile=client_cert, keyfile=client_key) + +s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) +conn = context.wrap_socket(s, server_side=False, server_hostname=server_sni_hostname) +conn.connect((host_addr, host_port)) +print("SSL established.") + +count = 0 +while True: + time.sleep(1) + secret = random.randint(0, 1024 * 1024 * 1024) + conn.send("Client secret {} is {}".format(count, secret).encode()) + data = conn.recv(1024) + print(data.decode()) + count += 1 + +print("Closing connection") +conn.close() diff --git a/src/30-openssl/ssl_client_server/server.crt b/src/30-openssl/ssl_client_server/server.crt new file mode 100644 index 0000000..cd8406d --- /dev/null +++ b/src/30-openssl/ssl_client_server/server.crt @@ -0,0 +1,30 @@ +-----BEGIN CERTIFICATE----- +MIIFDTCCAvWgAwIBAgIUYR+ByE3MsNfeQxOwoD6Qdn5NQlIwDQYJKoZIhvcNAQEL +BQAwFjEUMBIGA1UEAwwLZXhhbXBsZS5jb20wHhcNMjIwNTA1MTUxNTQ2WhcNMjMw +NTA1MTUxNTQ2WjAWMRQwEgYDVQQDDAtleGFtcGxlLmNvbTCCAiIwDQYJKoZIhvcN +AQEBBQADggIPADCCAgoCggIBAJbRQViOAWLIz8pue5lT09OYpvbHsp9wpjo+yUbE +zOzCJwraBDUEaiGVokjWiqMBkZP8fJKu5lt1guTwStPJRj66ZK/GmxGN27OhXGT9 +M1mBTH42cFyld/17Wny0MX4HOl1jZFT/HYxJDc58SNAXWRUQAL8ihq0NFQS4yqfR +OkxAna/PsvfVj2CkW0vxF6/iUJ3wHJ8pBHXdNu26awM72Ih3zgpF3AICKAyYid8v +2vXTOyzi9Ay5sQPnhmuiysdC/YoYd9ocDSw20HyXfn6lSrZ7LIaw8miRGIug+O+y +BoIxjqAv5u6pDckkzmcsjuWc8xIcXIu/BzBKpWDmdn/rZxA2OElp9y1P98BcTmNR +yYYWyeKWxMPwa3Wdb5rJpb4OlJ+5grDS7bAZwwwm4RfRAJif62RwnToxzd/+GcMP +aJ+E2/T/hIlv5Sp51QdTrLZl3etGxygEkw9Kcdt7YH/4MD77OVNYPla2PHIHPcLH +oqBfDia0b2gQJVRQFEzMsTka9EYNuhqwHyPjVFoGJC6R4PJxceFC6rJ2n3f9i9Tz +R4Wm0i4fi4Mt91Kn2AEclRo4mpVoUy9gbxYYOMw6AlGt+DrKjawMFJ6gOH1ueBaI +Tz92NGQzqwOcTf8YeL2YwoDNGNrIfems76/A5PFWCTH+DA+raQgtgTguopKTYkcu +1xdzAgMBAAGjUzBRMB0GA1UdDgQWBBTuryJv3wC6IefOQGPvCIRjamrAPDAfBgNV +HSMEGDAWgBTuryJv3wC6IefOQGPvCIRjamrAPDAPBgNVHRMBAf8EBTADAQH/MA0G +CSqGSIb3DQEBCwUAA4ICAQAbXdXeM1cqdJBipS0tRw0fl5GxFjY5wYtu81+Ga4Rm +oQhzG58c1qpx6uqXEq2OBc+tF/ypN+EF5XIyOB5i08TZ/feyiB6/bRPXkB6tleog +KOFS2OZb7/R+CdRAkx/nrWs7M4ZK9Ucxn+XqVDZG+LM1SGOuScE2J8x57BfQxUEC +Yu8sOOwO+0+2fjLeUa7FpOxrX6WUGRwOlm4mWeKaevDD20hZ3gTa4s3AiNPhA2Si +MpuPtVzQbC2WGiFpXSBrvKUhH5IkXepRKSmPaddPUNs6ROqENO9wklo+ttfOzuAL +b8xmSPui+UlivnqFfDEzWAdMv3FJ2rZR+vKPkxCg3WQd8jhs9lR5E1AoIS5CECd2 +qmIy8zKb10J0z4ZN9laSppPZ2ktkqbQqs4lSFVgaUUDvvBAlFtorN3fOce7D+PG+ +v51sPiHRrnMSvSHpcwyOAWSxw3B+3oOId0UtD4LLXKIXROL0ibT/Iy+xigpgDk32 +8aU7kcrviMRrWvnVhT32r6xIVjgfyB+GRO7xKd0kcsWRWSO1Xf28lJKHXLQJ11b+ +6HC8ix/8bDue9YDZ37Au7/DGInza+Y6YzlpM6qGAo290A0BjoV5I4P2QZeElSGaa +1GMPCz119ftHdueEXzXhXHnbI0QdinOI9rYC8SsBfIVoDX3OsKGm2FHGAW7ZxMeo +vA== +-----END CERTIFICATE----- diff --git a/src/30-openssl/ssl_client_server/server.key b/src/30-openssl/ssl_client_server/server.key new file mode 100644 index 0000000..23b645e --- /dev/null +++ b/src/30-openssl/ssl_client_server/server.key @@ -0,0 +1,52 @@ +-----BEGIN PRIVATE KEY----- +MIIJQQIBADANBgkqhkiG9w0BAQEFAASCCSswggknAgEAAoICAQCW0UFYjgFiyM/K +bnuZU9PTmKb2x7KfcKY6PslGxMzswicK2gQ1BGohlaJI1oqjAZGT/HySruZbdYLk +8ErTyUY+umSvxpsRjduzoVxk/TNZgUx+NnBcpXf9e1p8tDF+BzpdY2RU/x2MSQ3O +fEjQF1kVEAC/IoatDRUEuMqn0TpMQJ2vz7L31Y9gpFtL8Rev4lCd8ByfKQR13Tbt +umsDO9iId84KRdwCAigMmInfL9r10zss4vQMubED54ZrosrHQv2KGHfaHA0sNtB8 +l35+pUq2eyyGsPJokRiLoPjvsgaCMY6gL+buqQ3JJM5nLI7lnPMSHFyLvwcwSqVg +5nZ/62cQNjhJafctT/fAXE5jUcmGFsnilsTD8Gt1nW+ayaW+DpSfuYKw0u2wGcMM +JuEX0QCYn+tkcJ06Mc3f/hnDD2ifhNv0/4SJb+UqedUHU6y2Zd3rRscoBJMPSnHb +e2B/+DA++zlTWD5WtjxyBz3Cx6KgXw4mtG9oECVUUBRMzLE5GvRGDboasB8j41Ra +BiQukeDycXHhQuqydp93/YvU80eFptIuH4uDLfdSp9gBHJUaOJqVaFMvYG8WGDjM +OgJRrfg6yo2sDBSeoDh9bngWiE8/djRkM6sDnE3/GHi9mMKAzRjayH3prO+vwOTx +Vgkx/gwPq2kILYE4LqKSk2JHLtcXcwIDAQABAoICACRJ21hMauby/JRvuwuskOZz +75CngkI837JaEyIVDl3VZYGF7cc39bV5BKBUBu2r3fRmpy7AKKtO/hzJ+Kc24dEM +Flf5CKzTnk59f/bIucdKhjZEMQsJwXJbcO1aiiIR6Sg5VxXggKKVnV3Wp8pyI7we +qp9S1mbjI/CL6i8w978LOSXpat2ZJDOTuGfwbcujP9SQxsJBI1Kc1K+k0ETp7HMB +qLDuGD7fd/V36oyqPhwyJCXrwd8h+wa+eaiCdho18z18H7J6V20RD187MHOWoACC +aLdL8jfY2bgXFm7OPiSree7vN7irMqb4VTWcEhILjq0H5/i0ES28eEh1i4PCB30P +dvbGHsSmBt2/V+t9+n+1uwji3Riq78bujeBgkE7kz87gTBv59bwCiVCIYDSDiOEw +++mGtIaU40sflEz6JlSddxgmrlh8kZgWWHnGmVNUO6pefAbm8a4mTFGZQtaVtF3G +2HGdYLMdsIeHeFtjbm5ycax8BLq1Q9w8BOyY1GdKtgNnhcPB0uYoo3zCTiUk/G9t +ezpidYBm0h42j6WyGfUUZOULoPRwTg2TbtQrEa/6ZiGwZTEprhKF7MRaaR+EZJ9B +CtyNotFhwkSLSzL1giCINzsuo1mGZpj8BaIbx+FJ+XViVM3KCZphUJnEH3kewnTH +Im69kYe8UT+JJtjUv2XRAoIBAQDNmaZgIXucuQ/HXjR40f/yVi0BCL0utyK98/UC +Kzk5z31F60YrZmyR8SDmzek3HlSWuaYlYO+YAJnKIvho4YJDNWwtLRICGPEeazAM +18Y+QlCRmb6Op54z4x+MXPrajOy7JYjeUCARsahVCcPXXXP9rGAqchOAcO+/KkeP +JWvRF25j6cndPg0bAr8Wjq/yHWVKhiI7O/S9pWdIS2TND5f1xTXHb66WHOKD6K+6 +II/h0zX1rIpU2H7sriELHrdXIZQ9S4m2rofAjM8EcTQuB+QegCoqpBF06eo+/EOV +mEirQVKWHaNIL+wuoG6gK43BTKWXinLeK2phHFtC/jFHCajJAoIBAQC7ybw7mb6L +fqgrQf2gY+TArfsR2LyEKzn69GZoxbWIR0prOyLMxlW5krelbjGb01nO9buWxfRO +7k+e+WV0SyoeDaEH3+XGgEkCDN1Y3dXxf6vhmr6HffjGg7JH8EjkxQxsOzNWSntO +0Gnher9iZp5AGXgAh5IOqh/lhnHq2R/SgKU/MyVnSIjmx7yDDwSWjLBNAyiK1459 +05bXed8EmkooLdJEG6Jw4f0tQ1ZancqLaK0e7qKYkFZD2yd8qQfIde6OhdJjLP4j +rqGMI7Zcuo4quO2fRIlZRveJU7nneCB/Tq/DbV/JZVkPE++delT2BXkmVz09BLVO +wA/CtRAdy1hbAoIBAEMPWrUANtFniz37/CFsXY8tjIBJ2WrjUPGkIMYUUxYIF1Q2 +6Sw+vCrd+11MzESuH+kJpKeMdpmdmIvV3DBZXaOOSTpy+Oy2Ne82BvYpav/joWPc +QctF4NQLwL6HlUqzrINeOsZIXC1pRP53sOkOEkcrcjJmAvZh39D6eVy3V/NbMSZl +mvIOyzeELc+turW94Mvt9Dxd0fYJfSaXcMlxzJ7dNC1YwBk2UquzuZ18AXIm8fKv +1G7YLo4EPcLiweopibB0cvai9qRXSS6pvdtFt6I7K4W8/fSkV0M0BNdGVG2HYOiV +wixJdT/AFFUp35Ks7VYAUncksg36scmoH2qMPAECggEAaesmjaNxMzMUXZnSGXZe +n0NCmtVZt16+TEsvvCbP9nbnhcYMId44mfwkM14NAyxZun8l+Kvc2exW4n8e91Iy +BlN/oXZrHuRayZpB+w7czmNJqm1iy/+Eo0vC8gqYwthV4nIdya0nEdRB9FkMu87P +sa3r3riY7EaOySJk/KbM6SmAiz4o+bGS7kB4lp+Q4e2mvzlp064zg8sliJIH9Yul +CjaWI65GmE8PQ0l42pGnnaxEAW9uLIk07v8crZaVej7yeFcIzMGi8rNcETRPdswO +xhAajzvUEJQTqNSdxe4evk++mYcGgQz2B6gh/fvzEfUSWUrZkqImNa3k9di0p2l7 +gwKCAQBq22V0Si7MmVVxMFMrWd2T5wMknYqHxYD2oHTHHxJL92FMT8OB5VF8jder +VUb8YH76g9iWW/xhWtqAx2o1G4Ylb1c6SI7bCCrH8XmAMspJ6o3mVxXuTDz/UrHn +DnfrvRlzjKq8HYWv0yUVo1VYyV8RDnwekFjX9QYmq+LodMePAoATC7vEFI7eG6vd +FsLQsghYQTpg/XRlpdlw3yvmP7BlpexMbX8/vf6Nc8lBWNjZ6zDq4g71hJqI0tim +lrqmEmdhLgAS87hr4t1NsmVwXmhh7BXmbN/1g8Y8FyKOGvNZhJ2/86iNghecAxo9 +OldWF5Wk+mFkrEGSlxf7RYw3fFly +-----END PRIVATE KEY----- diff --git a/src/30-openssl/ssl_client_server/server.py b/src/30-openssl/ssl_client_server/server.py new file mode 100755 index 0000000..aaa6256 --- /dev/null +++ b/src/30-openssl/ssl_client_server/server.py @@ -0,0 +1,57 @@ +#!/usr/bin/env python + +# Copyright 2018- The Pixie Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 + +import socket +import ssl +import time +import random + +listen_addr = '127.0.0.1' +listen_port = 8082 +server_cert = 'server.crt' +server_key = 'server.key' +client_certs = 'client.crt' + +context = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH) +context.verify_mode = ssl.CERT_REQUIRED +context.load_cert_chain(certfile=server_cert, keyfile=server_key) +context.load_verify_locations(cafile=client_certs) + +bindsocket = socket.socket() +bindsocket.bind((listen_addr, listen_port)) +bindsocket.listen(5) + +while True: + print("Waiting for client") + newsocket, fromaddr = bindsocket.accept() + print("Client connected: {}:{}".format(fromaddr[0], fromaddr[1])) + conn = context.wrap_socket(newsocket, server_side=True) + print("SSL established.") + + count = 0 + while True: + time.sleep(1) + data = conn.recv(1024) + print(data.decode()) + secret = random.randint(0, 1024 * 1024 * 1024) + conn.send("Server secret {} is {}".format(count, secret).encode()) + count += 1 + +print("Closing connection") +conn.shutdown(socket.SHUT_RDWR) +conn.close() diff --git a/src/31-goroutine/.gitignore b/src/31-goroutine/.gitignore new file mode 100644 index 0000000..1220e4e --- /dev/null +++ b/src/31-goroutine/.gitignore @@ -0,0 +1,8 @@ +.vscode +package.json +*.o +*.skel.json +*.skel.yaml +package.yaml +ecli +goroutine diff --git a/src/31-goroutine/LICENSE b/src/31-goroutine/LICENSE new file mode 100644 index 0000000..ef1f26c --- /dev/null +++ b/src/31-goroutine/LICENSE @@ -0,0 +1,122 @@ +Copyright (C) 1989, 1991 Free Software Foundation, Inc. +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. + +Preamble + +The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software–to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation’s software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. + +To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. + +For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. + +We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. + +Also, for each author’s protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors’ reputations. + +Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone’s free use or not licensed at all. + +The precise terms and conditions for copying, distribution and modification follow. + +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The “Program”, below, refers to any such program or work, and a “work based on the Program” means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term “modification”.) Each licensee is addressed as “you”. + +Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. + +1. You may copy and distribute verbatim copies of the Program’s source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. + +You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. + +2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: + +a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. + +b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. + +c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. + +3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: + +a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, + +b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, + +c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. + +If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. + +4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. + +5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. + +6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients’ exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. + +7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. + +This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. + +8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. + +9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and “any later version”, you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. + +10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. + +NO WARRANTY + +11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +END OF TERMS AND CONDITIONS + +How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found. + +One line to give the program’s name and a brief idea of what it does. +Copyright (C) + +This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. + +This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this when it starts in an interactive mode: + +Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w’. This is free software, and you are welcome to redistribute it under certain conditions; type `show c’ for details. + +The hypothetical commands `show w’ and `show c’ should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w’ and `show c’; they could even be mouse-clicks or menu items–whatever suits your program. + +You should also get your employer (if you work as a programmer) or your school, if any, to sign a “copyright disclaimer” for the program, if necessary. Here is a sample; alter the names: + +Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision’ (which makes passes at compilers) written by James Hacker. + +signature of Ty Coon, 1 April 1989 +Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License. + diff --git a/src/31-goroutine/Makefile b/src/31-goroutine/Makefile new file mode 100644 index 0000000..de20e3f --- /dev/null +++ b/src/31-goroutine/Makefile @@ -0,0 +1,141 @@ +# SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) +OUTPUT := .output +CLANG ?= clang +LIBBPF_SRC := $(abspath ../../libbpf/src) +BPFTOOL_SRC := $(abspath ../../bpftool/src) +LIBBPF_OBJ := $(abspath $(OUTPUT)/libbpf.a) +BPFTOOL_OUTPUT ?= $(abspath $(OUTPUT)/bpftool) +BPFTOOL ?= $(BPFTOOL_OUTPUT)/goroutine/bpftool +LIBBLAZESYM_SRC := $(abspath ../../blazesym/) +LIBBLAZESYM_OBJ := $(abspath $(OUTPUT)/libblazesym.a) +LIBBLAZESYM_HEADER := $(abspath $(OUTPUT)/blazesym.h) +ARCH ?= $(shell uname -m | sed 's/x86_64/x86/' \ + | sed 's/arm.*/arm/' \ + | sed 's/aarch64/arm64/' \ + | sed 's/ppc64le/powerpc/' \ + | sed 's/mips.*/mips/' \ + | sed 's/riscv64/riscv/' \ + | sed 's/loongarch64/loongarch/') +VMLINUX := ../../vmlinux/$(ARCH)/vmlinux.h +# Use our own libbpf API headers and Linux UAPI headers distributed with +# libbpf to avoid dependency on system-wide headers, which could be missing or +# outdated +INCLUDES := -I$(OUTPUT) -I../../libbpf/include/uapi -I$(dir $(VMLINUX)) +CFLAGS := -g -Wall +ALL_LDFLAGS := $(LDFLAGS) $(EXTRA_LDFLAGS) + +APPS = goroutine # minimal minimal_legacy uprobe kprobe fentry usdt sockfilter tc ksyscall + +CARGO ?= $(shell which cargo) +ifeq ($(strip $(CARGO)),) +BZS_APPS := +else +BZS_APPS := # profile +APPS += $(BZS_APPS) +# Required by libblazesym +ALL_LDFLAGS += -lrt -ldl -lpthread -lm +endif + +# Get Clang's default includes on this system. We'll explicitly add these dirs +# to the includes list when compiling with `-target bpf` because otherwise some +# architecture-specific dirs will be "missing" on some architectures/distros - +# headers such as asm/types.h, asm/byteorder.h, asm/socket.h, asm/sockios.h, +# sys/cdefs.h etc. might be missing. +# +# Use '-idirafter': Don't interfere with include mechanics except where the +# build would have failed anyways. +CLANG_BPF_SYS_INCLUDES ?= $(shell $(CLANG) -v -E - &1 \ + | sed -n '/<...> search starts here:/,/End of search list./{ s| \(/.*\)|-idirafter \1|p }') + +ifeq ($(V),1) + Q = + msg = +else + Q = @ + msg = @printf ' %-8s %s%s\n' \ + "$(1)" \ + "$(patsubst $(abspath $(OUTPUT))/%,%,$(2))" \ + "$(if $(3), $(3))"; + MAKEFLAGS += --no-print-directory +endif + +define allow-override + $(if $(or $(findstring environment,$(origin $(1))),\ + $(findstring command line,$(origin $(1)))),,\ + $(eval $(1) = $(2))) +endef + +$(call allow-override,CC,$(CROSS_COMPILE)cc) +$(call allow-override,LD,$(CROSS_COMPILE)ld) + +.PHONY: all +all: $(APPS) + +.PHONY: clean +clean: + $(call msg,CLEAN) + $(Q)rm -rf $(OUTPUT) $(APPS) + +$(OUTPUT) $(OUTPUT)/libbpf $(BPFTOOL_OUTPUT): + $(call msg,MKDIR,$@) + $(Q)mkdir -p $@ + +# Build libbpf +$(LIBBPF_OBJ): $(wildcard $(LIBBPF_SRC)/*.[ch] $(LIBBPF_SRC)/Makefile) | $(OUTPUT)/libbpf + $(call msg,LIB,$@) + $(Q)$(MAKE) -C $(LIBBPF_SRC) BUILD_STATIC_ONLY=1 \ + OBJDIR=$(dir $@)/libbpf DESTDIR=$(dir $@) \ + INCLUDEDIR= LIBDIR= UAPIDIR= \ + install + +# Build bpftool +$(BPFTOOL): | $(BPFTOOL_OUTPUT) + $(call msg,BPFTOOL,$@) + $(Q)$(MAKE) ARCH= CROSS_COMPILE= OUTPUT=$(BPFTOOL_OUTPUT)/ -C $(BPFTOOL_SRC) goroutine + + +$(LIBBLAZESYM_SRC)/target/release/libblazesym.a:: + $(Q)cd $(LIBBLAZESYM_SRC) && $(CARGO) build --features=cheader,dont-generate-test-files --release + +$(LIBBLAZESYM_OBJ): $(LIBBLAZESYM_SRC)/target/release/libblazesym.a | $(OUTPUT) + $(call msg,LIB, $@) + $(Q)cp $(LIBBLAZESYM_SRC)/target/release/libblazesym.a $@ + +$(LIBBLAZESYM_HEADER): $(LIBBLAZESYM_SRC)/target/release/libblazesym.a | $(OUTPUT) + $(call msg,LIB,$@) + $(Q)cp $(LIBBLAZESYM_SRC)/target/release/blazesym.h $@ + +# Build BPF code +$(OUTPUT)/%.bpf.o: %.bpf.c $(LIBBPF_OBJ) $(wildcard %.h) $(VMLINUX) | $(OUTPUT) $(BPFTOOL) + $(call msg,BPF,$@) + $(Q)$(CLANG) -g -O2 -target bpf -D__TARGET_ARCH_$(ARCH) \ + $(INCLUDES) $(CLANG_BPF_SYS_INCLUDES) \ + -c $(filter %.c,$^) -o $(patsubst %.bpf.o,%.tmp.bpf.o,$@) + $(Q)$(BPFTOOL) gen object $@ $(patsubst %.bpf.o,%.tmp.bpf.o,$@) + +# Generate BPF skeletons +$(OUTPUT)/%.skel.h: $(OUTPUT)/%.bpf.o | $(OUTPUT) $(BPFTOOL) + $(call msg,GEN-SKEL,$@) + $(Q)$(BPFTOOL) gen skeleton $< > $@ + +# Build user-space code +$(patsubst %,$(OUTPUT)/%.o,$(APPS)): %.o: %.skel.h + +$(OUTPUT)/%.o: %.c $(wildcard %.h) | $(OUTPUT) + $(call msg,CC,$@) + $(Q)$(CC) $(CFLAGS) $(INCLUDES) -c $(filter %.c,$^) -o $@ + +$(patsubst %,$(OUTPUT)/%.o,$(BZS_APPS)): $(LIBBLAZESYM_HEADER) + +$(BZS_APPS): $(LIBBLAZESYM_OBJ) + +# Build application binary +$(APPS): %: $(OUTPUT)/%.o $(LIBBPF_OBJ) | $(OUTPUT) + $(call msg,BINARY,$@) + $(Q)$(CC) $(CFLAGS) $^ $(ALL_LDFLAGS) -lelf -lz -o $@ + +# delete failed targets +.DELETE_ON_ERROR: + +# keep intermediate (.skel.h, .bpf.o, etc) targets +.SECONDARY: diff --git a/src/31-goroutine/README.md b/src/31-goroutine/README.md new file mode 100644 index 0000000..1fac01d --- /dev/null +++ b/src/31-goroutine/README.md @@ -0,0 +1,7 @@ +# goroutine trace + +TODO: make this work and implement the documentation + +Modify from https://github.com/deepflowio/deepflow + +This example is provided as GPL license diff --git a/src/31-goroutine/goroutine.bpf.c b/src/31-goroutine/goroutine.bpf.c new file mode 100644 index 0000000..5f800b4 --- /dev/null +++ b/src/31-goroutine/goroutine.bpf.c @@ -0,0 +1,375 @@ +/* + * This code runs using bpf in the Linux kernel. + * Copyright 2022- The Yunshan Networks Authors. + * + * Modify from https://github.com/deepflowio/deepflow + * By Yusheng Zheng <1067852565@qq.com> + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * + * SPDX-License-Identifier: GPL-2.0 + */ +#include "vmlinux.h" +#include +#include +#include + +#define NAME(N) __##N + +#define HASH_ENTRIES_MAX 40960 +#define MAX_SYSTEM_THREADS 40960 + +struct sched_comm_fork_ctx { + __u64 __pad_0; + char parent_comm[16]; + __u32 parent_pid; + char child_comm[16]; + __u32 child_pid; +}; + +struct sched_comm_exit_ctx { + __u64 __pad_0; /* 0 8 */ + char comm[16]; /* offset:8; size:16 */ + pid_t pid; /* offset:24; size:4 */ + int prio; /* offset:28; size:4 */ +}; + +// struct ebpf_proc_info -> offsets[] arrays index. +enum offsets_index { + OFFSET_IDX_GOID_RUNTIME_G, + OFFSET_IDX_CONN_TLS_CONN, + OFFSET_IDX_SYSFD_POLL_FD, + OFFSET_IDX_CONN_HTTP2_SERVER_CONN, + OFFSET_IDX_TCONN_HTTP2_CLIENT_CONN, + OFFSET_IDX_CC_HTTP2_CLIENT_CONN_READ_LOOP, + OFFSET_IDX_CONN_GRPC_HTTP2_CLIENT, + OFFSET_IDX_CONN_GRPC_HTTP2_SERVER, + OFFSET_IDX_FRAMER_GRPC_TRANSPORT_LOOPY_WRITER, + OFFSET_IDX_WRITER_GRPC_TRANSPORT_FRAMER, + OFFSET_IDX_CONN_GRPC_TRANSPORT_BUFWRITER, + OFFSET_IDX_SIDE_GRPC_TRANSPORT_LOOPY_WRITER, + OFFSET_IDX_FIELDS_HTTP2_META_HEADERS_FRAME, + OFFSET_IDX_STREAM_HTTP2_CLIENT_CONN, + OFFSET_IDX_STREAM_ID_HTTP2_FRAME_HEADER, + OFFSET_IDX_MAX, +}; + +// Store the ebpf_proc_info to eBPF Map. +struct ebpf_proc_info { + __u32 version; + __u16 offsets[OFFSET_IDX_MAX]; + + // In golang, itab represents type, and in interface, struct is represented + // by the address of itab. We use itab to judge the structure type, and + // find the fd representing the connection after multiple jumps. These + // types are not available in Go ELF files without a symbol table. + // Go 用 itab 表示类型, 在 interface 中通过 itab 确定具体的 struct, 并根据 + // struct 找到表示连接的 fd. + __u64 net_TCPConn_itab; + __u64 crypto_tls_Conn_itab; // TLS_HTTP1,TLS_HTTP2 + __u64 credentials_syscallConn_itab; // gRPC +}; + +#define GO_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + ((c) > 255 ? 255 : (c))) + +// Go implements a new way of passing function arguments and results using +// registers instead of the stack. We need the go version and the computer +// architecture to determine the parameter locations +static __inline bool is_register_based_call(struct ebpf_proc_info *info) +{ +#if defined(__x86_64__) + // https://go.dev/doc/go1.17 + return info->version >= GO_VERSION(1, 17, 0); +#elif defined(__aarch64__) + // https://groups.google.com/g/golang-checkins/c/SO9OmZYkOXU + return info->version >= GO_VERSION(1, 18, 0); +#else +_Pragma("error \"Must specify a BPF target arch\""); +#endif +} + +struct bpf_map_def { + unsigned int type; + unsigned int key_size; + unsigned int value_size; + unsigned int max_entries; +}; + +// Process ID and coroutine ID, marking the coroutine in the system +struct go_key { + __u32 tgid; + __u64 goid; +} __attribute__((packed)); + +// The mapping of coroutines to ancestors, the map is updated when a new +// coroutine is created +// key : current gorouting (struct go_key) +// value : ancerstor goid +struct bpf_map_def SEC("maps") go_ancerstor_map = { + .type = BPF_MAP_TYPE_LRU_HASH, + .key_size = sizeof(struct go_key), + .value_size = sizeof(__u64), + .max_entries = HASH_ENTRIES_MAX, +}; + +// Used to determine the timeout, as a termination condition for finding +// ancestors. +// key : current gorouting (struct go_key) +// value: timestamp when the data was inserted into the map +struct bpf_map_def SEC("maps") go_rw_ts_map = { + .type = BPF_MAP_TYPE_LRU_HASH, + .key_size = sizeof(struct go_key), + .value_size = sizeof(__u64), + .max_entries = HASH_ENTRIES_MAX, +}; + +/* + * The binary executable file offset of the GO process + * key: pid + * value: struct ebpf_proc_info + */ +struct bpf_map_def SEC("maps") proc_info_map = { + .type = BPF_MAP_TYPE_HASH, + .key_size = sizeof(int), + .value_size = sizeof(struct ebpf_proc_info), + .max_entries = HASH_ENTRIES_MAX, +}; + +// Pass data between coroutine entry and exit functions +struct go_newproc_caller { + __u64 goid; + void *sp; // stack pointer +} __attribute__((packed)); + +struct bpf_map_def SEC("maps") pid_tgid_callerid_map = { + .type = BPF_MAP_TYPE_HASH, + .key_size = sizeof(__u64), + .value_size = sizeof(struct go_newproc_caller), + .max_entries = HASH_ENTRIES_MAX, +}; + +/* + * Goroutines Map + * key: {tgid, pid} + * value: goroutine ID + */ +struct bpf_map_def SEC("maps") goroutines_map = { + .type = BPF_MAP_TYPE_HASH, + .key_size = sizeof(__u64), + .value_size = sizeof(__u64), + .max_entries = MAX_SYSTEM_THREADS, +}; + +SEC("uprobe/runtime.execute") +int runtime_execute(struct pt_regs *ctx) +{ + __u64 pid_tgid = bpf_get_current_pid_tgid(); + __u32 tgid = pid_tgid >> 32; + + struct ebpf_proc_info *info = bpf_map_lookup_elem(&proc_info_map, &tgid); + if (!info) { + return 0; + } + int offset_g_goid = info->offsets[OFFSET_IDX_GOID_RUNTIME_G]; + if (offset_g_goid < 0) { + return 0; + } + + void *g_ptr; + + if (is_register_based_call(info)) { + g_ptr = (void *)PT_GO_REGS_PARM1(ctx); + } else { + bpf_probe_read(&g_ptr, sizeof(g_ptr), (void *)(PT_REGS_SP(ctx) + 8)); + } + + __s64 goid = 0; + bpf_probe_read(&goid, sizeof(goid), g_ptr + offset_g_goid); + bpf_map_update_elem(&goroutines_map, &pid_tgid, &goid, BPF_ANY); + + return 0; +} + +// This function creates a new go coroutine, and the parent and child +// coroutine numbers are in the parameters and return values ​​respectively. +// Pass the function parameters through pid_tgid_callerid_map +// +// go 1.15 ~ 1.17: func newproc1(fn *funcval, argp unsafe.Pointer, narg int32, callergp *g, callerpc uintptr) *g +// go1.18+ :func newproc1(fn *funcval, callergp *g, callerpc uintptr) *g +SEC("uprobe/enter_runtime.newproc1") +int enter_runtime_newproc1(struct pt_regs *ctx) +{ + __u64 pid_tgid = bpf_get_current_pid_tgid(); + __u32 tgid = pid_tgid >> 32; + + struct ebpf_proc_info *info = + bpf_map_lookup_elem(&proc_info_map, &tgid); + if (!info) { + return 0; + } + + // go less than 1.15 cannot get parent-child coroutine relationship + // ~ go1.14: func newproc1(fn *funcval, argp unsafe.Pointer, narg int32, callergp *g, callerpc uintptr) + if (info->version < GO_VERSION(1, 15, 0)) { + return 0; + } + + int offset_g_goid = info->offsets[OFFSET_IDX_GOID_RUNTIME_G]; + if (offset_g_goid < 0) { + return 0; + } + + void *g_ptr; + if (is_register_based_call(info)) { + // https://github.com/golang/go/commit/8e5304f7298a0eef48e4796017c51b4d9aeb52b5 + if (info->version >= GO_VERSION(1, 18, 0)) { + g_ptr = (void *)PT_GO_REGS_PARM2(ctx); + } else { + g_ptr = (void *)PT_GO_REGS_PARM4(ctx); + } + } else { + if (info->version >= GO_VERSION(1, 18, 0)) { + bpf_probe_read(&g_ptr, sizeof(g_ptr), + (void *)(PT_REGS_SP(ctx) + 16)); + } else { + bpf_probe_read(&g_ptr, sizeof(g_ptr), + (void *)(PT_REGS_SP(ctx) + 32)); + } + } + + __s64 goid = 0; + bpf_probe_read(&goid, sizeof(goid), g_ptr + offset_g_goid); + if (!goid) { + return 0; + } + + struct go_newproc_caller caller = { + .goid = goid, + .sp = (void *)PT_REGS_SP(ctx), + }; + bpf_map_update_elem(&pid_tgid_callerid_map, &pid_tgid, &caller, + BPF_ANY); + return 0; +} + +// The mapping relationship between parent and child coroutines is stored in go_ancerstor_map +// +// go 1.15 ~ 1.17: func newproc1(fn *funcval, argp unsafe.Pointer, narg int32, callergp *g, callerpc uintptr) *g +// go1.18+ :func newproc1(fn *funcval, callergp *g, callerpc uintptr) *g +SEC("uprobe/exit_runtime.newproc1") +int exit_runtime_newproc1(struct pt_regs *ctx) +{ + __u64 pid_tgid = bpf_get_current_pid_tgid(); + __u32 tgid = pid_tgid >> 32; + + struct ebpf_proc_info *info = + bpf_map_lookup_elem(&proc_info_map, &tgid); + if (!info) { + return 0; + } + + if(info->version < GO_VERSION(1, 15, 0)){ + return 0; + } + + int offset_g_goid = info->offsets[OFFSET_IDX_GOID_RUNTIME_G]; + if (offset_g_goid < 0) { + return 0; + } + + struct go_newproc_caller *caller = + bpf_map_lookup_elem(&pid_tgid_callerid_map, &pid_tgid); + if (!caller) { + return 0; + } + + void *g_ptr; + if (is_register_based_call(info)) { + g_ptr = (void *)PT_GO_REGS_PARM1(ctx); + } else { + if (info->version >= GO_VERSION(1, 18, 0)) { + bpf_probe_read(&g_ptr, sizeof(g_ptr), caller->sp + 32); + } else { + bpf_probe_read(&g_ptr, sizeof(g_ptr), caller->sp + 48); + } + } + + __s64 goid = 0; + bpf_probe_read(&goid, sizeof(goid), g_ptr + offset_g_goid); + if (!goid) { + bpf_map_delete_elem(&pid_tgid_callerid_map, &pid_tgid); + return 0; + } + + struct go_key key = { .tgid = tgid, .goid = goid }; + goid = caller->goid; + bpf_map_update_elem(&go_ancerstor_map, &key, &goid, BPF_ANY); + + bpf_map_delete_elem(&pid_tgid_callerid_map, &pid_tgid); + return 0; +} + +// /sys/kernel/debug/tracing/events/sched/sched_process_exit/format +SEC("tracepoint/sched/sched_process_exit") +int bpf_func_sched_process_exit(struct sched_comm_exit_ctx *ctx) +{ + pid_t pid, tid; + __u64 id; + + id = bpf_get_current_pid_tgid(); + pid = id >> 32; + tid = (__u32)id; + + // If is a process, clear proc_info_map element and submit event. + if (pid == tid) { + bpf_map_delete_elem(&proc_info_map, &pid); + struct process_event_t data; + data.pid = pid; + data.meta.event_type = EVENT_TYPE_PROC_EXIT; + bpf_get_current_comm(data.name, sizeof(data.name)); + // int ret = bpf_perf_event_output(ctx, &NAME(socket_data), + // BPF_F_CURRENT_CPU, &data, + // sizeof(data)); + + // if (ret) { + // bpf_debug + // ("bpf_func_sched_process_exit event output failed: %d\n", + // ret); + // } + } + + bpf_map_delete_elem(&goroutines_map, &id); + return 0; +} + +// /sys/kernel/debug/tracing/events/sched/sched_process_fork/format +SEC("tracepoint/sched/sched_process_fork") +int bpf_func_sched_process_fork(struct sched_comm_fork_ctx *ctx) +{ + struct process_event_t data; + + data.meta.event_type = EVENT_TYPE_PROC_EXEC; + data.pid = ctx->child_pid; + bpf_get_current_comm(data.name, sizeof(data.name)); + // int ret = bpf_perf_event_output(ctx, &NAME(socket_data), + // BPF_F_CURRENT_CPU, &data, sizeof(data)); + + // if (ret) { + // bpf_debug( + // "bpf_func_sys_exit_execve event output() failed: %d\n", + // ret); + // } + return 0; +} diff --git a/src/31-goroutine/goroutine.c b/src/31-goroutine/goroutine.c new file mode 100644 index 0000000..89c9ee9 --- /dev/null +++ b/src/31-goroutine/goroutine.c @@ -0,0 +1,172 @@ +// SPDX-License-Identifier: GPL-2.0 +#include +#include +#include +#include +#include +#include +#include "goroutine.h" +#include "goroutine.skel.h" + +static struct env { + bool verbose; + long min_duration_ms; +} env; + +const char *argp_program_version = "goroutine 0.0"; +const char *argp_program_bug_address = ""; +const char argp_program_doc[] = +"BPF goroutine demo application.\n" +"\n" +"It traces process start and exits and shows associated \n" +"information (filename, process duration, PID and PPID, etc).\n" +"\n" +"USAGE: ./goroutine [-d ] [-v]\n"; + +static const struct argp_option opts[] = { + { "verbose", 'v', NULL, 0, "Verbose debug output" }, + { "duration", 'd', "DURATION-MS", 0, "Minimum process duration (ms) to report" }, + {}, +}; + +static error_t parse_arg(int key, char *arg, struct argp_state *state) +{ + switch (key) { + case 'v': + env.verbose = true; + break; + case 'd': + errno = 0; + env.min_duration_ms = strtol(arg, NULL, 10); + if (errno || env.min_duration_ms <= 0) { + fprintf(stderr, "Invalid duration: %s\n", arg); + argp_usage(state); + } + break; + case ARGP_KEY_ARG: + argp_usage(state); + break; + default: + return ARGP_ERR_UNKNOWN; + } + return 0; +} + +static const struct argp argp = { + .options = opts, + .parser = parse_arg, + .doc = argp_program_doc, +}; + +static int libbpf_print_fn(enum libbpf_print_level level, const char *format, va_list args) +{ + if (level == LIBBPF_DEBUG && !env.verbose) + return 0; + return vfprintf(stderr, format, args); +} + +static volatile bool exiting = false; + +static void sig_handler(int sig) +{ + exiting = true; +} + +static int handle_event(void *ctx, void *data, size_t data_sz) +{ + const struct event *e = data; + struct tm *tm; + char ts[32]; + time_t t; + + time(&t); + tm = localtime(&t); + strftime(ts, sizeof(ts), "%H:%M:%S", tm); + + if (e->exit_event) { + printf("%-8s %-5s %-16s %-7d %-7d [%u]", + ts, "EXIT", e->comm, e->pid, e->ppid, e->exit_code); + if (e->duration_ns) + printf(" (%llums)", e->duration_ns / 1000000); + printf("\n"); + } else { + printf("%-8s %-5s %-16s %-7d %-7d %s\n", + ts, "EXEC", e->comm, e->pid, e->ppid, e->filename); + } + + return 0; +} + +int main(int argc, char **argv) +{ + struct ring_buffer *rb = NULL; + struct goroutine_bpf *skel; + int err; + + /* Parse command line arguments */ + err = argp_parse(&argp, argc, argv, 0, NULL, NULL); + if (err) + return err; + + /* Set up libbpf errors and debug info callback */ + libbpf_set_print(libbpf_print_fn); + + /* Cleaner handling of Ctrl-C */ + signal(SIGINT, sig_handler); + signal(SIGTERM, sig_handler); + + /* Load and verify BPF application */ + skel = goroutine_bpf__open(); + if (!skel) { + fprintf(stderr, "Failed to open and load BPF skeleton\n"); + return 1; + } + + /* Parameterize BPF code with minimum duration parameter */ + skel->rodata->min_duration_ns = env.min_duration_ms * 1000000ULL; + + /* Load & verify BPF programs */ + err = goroutine_bpf__load(skel); + if (err) { + fprintf(stderr, "Failed to load and verify BPF skeleton\n"); + goto cleanup; + } + + /* Attach tracepoints */ + err = goroutine_bpf__attach(skel); + if (err) { + fprintf(stderr, "Failed to attach BPF skeleton\n"); + goto cleanup; + } + + /* Set up ring buffer polling */ + rb = ring_buffer__new(bpf_map__fd(skel->maps.rb), handle_event, NULL, NULL); + if (!rb) { + err = -1; + fprintf(stderr, "Failed to create ring buffer\n"); + goto cleanup; + } + + /* Process events */ + printf("%-8s %-5s %-16s %-7s %-7s %s\n", + "TIME", "EVENT", "COMM", "PID", "PPID", "FILENAME/EXIT CODE"); + while (!exiting) { + err = ring_buffer__poll(rb, 100 /* timeout, ms */); + /* Ctrl-C will cause -EINTR */ + if (err == -EINTR) { + err = 0; + break; + } + if (err < 0) { + printf("Error polling perf buffer: %d\n", err); + break; + } + } + +cleanup: + /* Clean up */ + ring_buffer__free(rb); + goroutine_bpf__destroy(skel); + + return err < 0 ? -err : 0; +} diff --git a/src/31-goroutine/goroutine.h b/src/31-goroutine/goroutine.h new file mode 100644 index 0000000..76b9fbe --- /dev/null +++ b/src/31-goroutine/goroutine.h @@ -0,0 +1,33 @@ +#ifndef EBPF_EXAMPLE_GOROUTINE_H +#define EBPF_EXAMPLE_GOROUTINE_H + + +enum { + /* + * 0 ~ 16 for L7 socket event (struct socket_data_buffer), + * indicates the number of socket data in socket_data_buffer. + */ + + /* + * For event registrion + */ + EVENT_TYPE_MIN = 1 << 5, + EVENT_TYPE_PROC_EXEC = 1 << 5, + EVENT_TYPE_PROC_EXIT = 1 << 6 + // Add new event type here. +}; + +// Description Provides basic information about an event +struct event_meta { + __u32 event_type; +}; + +// Process execution or exit event data +struct process_event_t { + struct event_meta meta; + __u32 pid; // process ID + __u8 name[TASK_COMM_LEN]; // process name +}; + + +#endif diff --git a/src/32-funclatency/.gitignore b/src/32-funclatency/.gitignore new file mode 100644 index 0000000..8976ff6 --- /dev/null +++ b/src/32-funclatency/.gitignore @@ -0,0 +1,8 @@ +.vscode +package.json +*.o +*.skel.json +*.skel.yaml +package.yaml +ecli +funclatency diff --git a/src/32-funclatency/Makefile b/src/32-funclatency/Makefile new file mode 100644 index 0000000..ee5e1c7 --- /dev/null +++ b/src/32-funclatency/Makefile @@ -0,0 +1,141 @@ +# SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) +OUTPUT := .output +CLANG ?= clang +LIBBPF_SRC := $(abspath ../../libbpf/src) +BPFTOOL_SRC := $(abspath ../../bpftool/src) +LIBBPF_OBJ := $(abspath $(OUTPUT)/libbpf.a) +BPFTOOL_OUTPUT ?= $(abspath $(OUTPUT)/bpftool) +BPFTOOL ?= $(BPFTOOL_OUTPUT)/funclatency/bpftool +LIBBLAZESYM_SRC := $(abspath ../../blazesym/) +LIBBLAZESYM_OBJ := $(abspath $(OUTPUT)/libblazesym.a) +LIBBLAZESYM_HEADER := $(abspath $(OUTPUT)/blazesym.h) +ARCH ?= $(shell uname -m | sed 's/x86_64/x86/' \ + | sed 's/arm.*/arm/' \ + | sed 's/aarch64/arm64/' \ + | sed 's/ppc64le/powerpc/' \ + | sed 's/mips.*/mips/' \ + | sed 's/riscv64/riscv/' \ + | sed 's/loongarch64/loongarch/') +VMLINUX := ../../vmlinux/$(ARCH)/vmlinux.h +# Use our own libbpf API headers and Linux UAPI headers distributed with +# libbpf to avoid dependency on system-wide headers, which could be missing or +# outdated +INCLUDES := -I$(OUTPUT) -I../../libbpf/include/uapi -I$(dir $(VMLINUX)) +CFLAGS := -g -Wall +ALL_LDFLAGS := $(LDFLAGS) $(EXTRA_LDFLAGS) + +APPS = funclatency # minimal minimal_legacy uprobe kprobe fentry usdt sockfilter tc ksyscall + +CARGO ?= $(shell which cargo) +ifeq ($(strip $(CARGO)),) +BZS_APPS := +else +BZS_APPS := # profile +APPS += $(BZS_APPS) +# Required by libblazesym +ALL_LDFLAGS += -lrt -ldl -lpthread -lm +endif + +# Get Clang's default includes on this system. We'll explicitly add these dirs +# to the includes list when compiling with `-target bpf` because otherwise some +# architecture-specific dirs will be "missing" on some architectures/distros - +# headers such as asm/types.h, asm/byteorder.h, asm/socket.h, asm/sockios.h, +# sys/cdefs.h etc. might be missing. +# +# Use '-idirafter': Don't interfere with include mechanics except where the +# build would have failed anyways. +CLANG_BPF_SYS_INCLUDES ?= $(shell $(CLANG) -v -E - &1 \ + | sed -n '/<...> search starts here:/,/End of search list./{ s| \(/.*\)|-idirafter \1|p }') + +ifeq ($(V),1) + Q = + msg = +else + Q = @ + msg = @printf ' %-8s %s%s\n' \ + "$(1)" \ + "$(patsubst $(abspath $(OUTPUT))/%,%,$(2))" \ + "$(if $(3), $(3))"; + MAKEFLAGS += --no-print-directory +endif + +define allow-override + $(if $(or $(findstring environment,$(origin $(1))),\ + $(findstring command line,$(origin $(1)))),,\ + $(eval $(1) = $(2))) +endef + +$(call allow-override,CC,$(CROSS_COMPILE)cc) +$(call allow-override,LD,$(CROSS_COMPILE)ld) + +.PHONY: all +all: $(APPS) + +.PHONY: clean +clean: + $(call msg,CLEAN) + $(Q)rm -rf $(OUTPUT) $(APPS) + +$(OUTPUT) $(OUTPUT)/libbpf $(BPFTOOL_OUTPUT): + $(call msg,MKDIR,$@) + $(Q)mkdir -p $@ + +# Build libbpf +$(LIBBPF_OBJ): $(wildcard $(LIBBPF_SRC)/*.[ch] $(LIBBPF_SRC)/Makefile) | $(OUTPUT)/libbpf + $(call msg,LIB,$@) + $(Q)$(MAKE) -C $(LIBBPF_SRC) BUILD_STATIC_ONLY=1 \ + OBJDIR=$(dir $@)/libbpf DESTDIR=$(dir $@) \ + INCLUDEDIR= LIBDIR= UAPIDIR= \ + install + +# Build bpftool +$(BPFTOOL): | $(BPFTOOL_OUTPUT) + $(call msg,BPFTOOL,$@) + $(Q)$(MAKE) ARCH= CROSS_COMPILE= OUTPUT=$(BPFTOOL_OUTPUT)/ -C $(BPFTOOL_SRC) funclatency + + +$(LIBBLAZESYM_SRC)/target/release/libblazesym.a:: + $(Q)cd $(LIBBLAZESYM_SRC) && $(CARGO) build --features=cheader,dont-generate-test-files --release + +$(LIBBLAZESYM_OBJ): $(LIBBLAZESYM_SRC)/target/release/libblazesym.a | $(OUTPUT) + $(call msg,LIB, $@) + $(Q)cp $(LIBBLAZESYM_SRC)/target/release/libblazesym.a $@ + +$(LIBBLAZESYM_HEADER): $(LIBBLAZESYM_SRC)/target/release/libblazesym.a | $(OUTPUT) + $(call msg,LIB,$@) + $(Q)cp $(LIBBLAZESYM_SRC)/target/release/blazesym.h $@ + +# Build BPF code +$(OUTPUT)/%.bpf.o: %.bpf.c $(LIBBPF_OBJ) $(wildcard %.h) $(VMLINUX) | $(OUTPUT) $(BPFTOOL) + $(call msg,BPF,$@) + $(Q)$(CLANG) -g -O2 -target bpf -D__TARGET_ARCH_$(ARCH) \ + $(INCLUDES) $(CLANG_BPF_SYS_INCLUDES) \ + -c $(filter %.c,$^) -o $(patsubst %.bpf.o,%.tmp.bpf.o,$@) + $(Q)$(BPFTOOL) gen object $@ $(patsubst %.bpf.o,%.tmp.bpf.o,$@) + +# Generate BPF skeletons +$(OUTPUT)/%.skel.h: $(OUTPUT)/%.bpf.o | $(OUTPUT) $(BPFTOOL) + $(call msg,GEN-SKEL,$@) + $(Q)$(BPFTOOL) gen skeleton $< > $@ + +# Build user-space code +$(patsubst %,$(OUTPUT)/%.o,$(APPS)): %.o: %.skel.h + +$(OUTPUT)/%.o: %.c $(wildcard %.h) | $(OUTPUT) + $(call msg,CC,$@) + $(Q)$(CC) $(CFLAGS) $(INCLUDES) -c $(filter %.c,$^) -o $@ + +$(patsubst %,$(OUTPUT)/%.o,$(BZS_APPS)): $(LIBBLAZESYM_HEADER) + +$(BZS_APPS): $(LIBBLAZESYM_OBJ) + +# Build application binary +$(APPS): %: $(OUTPUT)/%.o $(LIBBPF_OBJ) | $(OUTPUT) + $(call msg,BINARY,$@) + $(Q)$(CC) $(CFLAGS) $^ $(ALL_LDFLAGS) -lelf -lz -o $@ + +# delete failed targets +.DELETE_ON_ERROR: + +# keep intermediate (.skel.h, .bpf.o, etc) targets +.SECONDARY: diff --git a/src/32-funclatency/README.md b/src/32-funclatency/README.md new file mode 100644 index 0000000..3e48935 --- /dev/null +++ b/src/32-funclatency/README.md @@ -0,0 +1,5 @@ +# func latency + +TODO: make it work + +from https://github.com/iovisor/bcc/blob/master/libbpf-tools/funclatency.c diff --git a/src/32-funclatency/funclatency.bpf.c b/src/32-funclatency/funclatency.bpf.c new file mode 100644 index 0000000..5e67572 --- /dev/null +++ b/src/32-funclatency/funclatency.bpf.c @@ -0,0 +1,93 @@ +// SPDX-License-Identifier: GPL-2.0 +/* Copyright (c) 2021 Google LLC. */ +#include "vmlinux.h" +#include +#include +#include +#include "funclatency.h" +#include "bits.bpf.h" + +const volatile pid_t targ_tgid = 0; +const volatile int units = 0; + +/* key: pid. value: start time */ +struct { + __uint(type, BPF_MAP_TYPE_HASH); + __uint(max_entries, MAX_PIDS); + __type(key, u32); + __type(value, u64); +} starts SEC(".maps"); + +__u32 hist[MAX_SLOTS] = {}; + +static void entry(void) +{ + u64 id = bpf_get_current_pid_tgid(); + u32 tgid = id >> 32; + u32 pid = id; + u64 nsec; + + if (targ_tgid && targ_tgid != tgid) + return; + nsec = bpf_ktime_get_ns(); + bpf_map_update_elem(&starts, &pid, &nsec, BPF_ANY); +} + +SEC("fentry/dummy_fentry") +int BPF_PROG(dummy_fentry) +{ + entry(); + return 0; +} + +SEC("kprobe/dummy_kprobe") +int BPF_KPROBE(dummy_kprobe) +{ + entry(); + return 0; +} + +static void exit(void) +{ + u64 *start; + u64 nsec = bpf_ktime_get_ns(); + u64 id = bpf_get_current_pid_tgid(); + u32 pid = id; + u64 slot, delta; + + start = bpf_map_lookup_elem(&starts, &pid); + if (!start) + return; + + delta = nsec - *start; + + switch (units) { + case USEC: + delta /= 1000; + break; + case MSEC: + delta /= 1000000; + break; + } + + slot = log2l(delta); + if (slot >= MAX_SLOTS) + slot = MAX_SLOTS - 1; + __sync_fetch_and_add(&hist[slot], 1); +} + +SEC("fexit/dummy_fexit") +int BPF_PROG(dummy_fexit) +{ + exit(); + return 0; +} + +SEC("kretprobe/dummy_kretprobe") +int BPF_KRETPROBE(dummy_kretprobe) +{ + exit(); + return 0; +} + +char LICENSE[] SEC("license") = "GPL"; diff --git a/src/32-funclatency/funclatency.c b/src/32-funclatency/funclatency.c new file mode 100644 index 0000000..2c94e96 --- /dev/null +++ b/src/32-funclatency/funclatency.c @@ -0,0 +1,447 @@ +// SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) +/* Copyright (c) 2021 Google LLC. + * + * Based on funclatency from BCC by Brendan Gregg and others + * 2021-02-26 Barret Rhoden Created this. + * + * TODO: + * - support uprobes on libraries without -p PID. (parse ld.so.cache) + * - support regexp pattern matching and per-function histograms + */ +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include "funclatency.h" +#include "funclatency.skel.h" +#include "trace_helpers.h" +#include "uprobe_helpers.h" + +#define warn(...) fprintf(stderr, __VA_ARGS__) + +static struct prog_env +{ + int units; + pid_t pid; + unsigned int duration; + unsigned int interval; + unsigned int iterations; + bool timestamp; + char *funcname; + bool verbose; + bool kprobes; + bool is_kernel_func; +} env = { + .interval = 99999999, + .iterations = 99999999, +}; + +const char *argp_program_version = "funclatency 0.1"; +const char *argp_program_bug_address = + "https://github.com/iovisor/bcc/tree/master/libbpf-tools"; +static const char args_doc[] = "FUNCTION"; +static const char program_doc[] = + "Time functions and print latency as a histogram\n" + "\n" + "Usage: funclatency [-h] [-m|-u] [-p PID] [-d DURATION] [ -i INTERVAL ]\n" + " [-T] FUNCTION\n" + " Choices for FUNCTION: FUNCTION (kprobe)\n" + " LIBRARY:FUNCTION (uprobe a library in -p PID)\n" + " :FUNCTION (uprobe the binary of -p PID)\n" + " PROGRAM:FUNCTION (uprobe the binary PROGRAM)\n" + "\v" + "Examples:\n" + " ./funclatency do_sys_open # time the do_sys_open() kernel function\n" + " ./funclatency -m do_nanosleep # time do_nanosleep(), in milliseconds\n" + " ./funclatency -u vfs_read # time vfs_read(), in microseconds\n" + " ./funclatency -p 181 vfs_read # time process 181 only\n" + " ./funclatency -p 181 c:read # time the read() C library function\n" + " ./funclatency -p 181 :foo # time foo() from pid 181's userspace\n" + " ./funclatency -i 2 -d 10 vfs_read # output every 2 seconds, for 10s\n" + " ./funclatency -mTi 5 vfs_read # output every 5 seconds, with timestamps\n"; + +static const struct argp_option opts[] = { + {"milliseconds", 'm', NULL, 0, "Output in milliseconds"}, + {"microseconds", 'u', NULL, 0, "Output in microseconds"}, + {0, 0, 0, 0, ""}, + {"pid", 'p', "PID", 0, "Process ID to trace"}, + {0, 0, 0, 0, ""}, + {"interval", 'i', "INTERVAL", 0, "Summary interval in seconds"}, + {"duration", 'd', "DURATION", 0, "Duration to trace"}, + {"timestamp", 'T', NULL, 0, "Print timestamp"}, + {"verbose", 'v', NULL, 0, "Verbose debug output"}, + {"kprobes", 'k', NULL, 0, "Use kprobes instead of fentry"}, + {NULL, 'h', NULL, OPTION_HIDDEN, "Show the full help"}, + {}, +}; + +static error_t parse_arg(int key, char *arg, struct argp_state *state) +{ + struct prog_env *env = state->input; + long duration, interval, pid; + + switch (key) + { + case 'p': + errno = 0; + pid = strtol(arg, NULL, 10); + if (errno || pid <= 0) + { + warn("Invalid PID: %s\n", arg); + argp_usage(state); + } + env->pid = pid; + break; + case 'm': + if (env->units != NSEC) + { + warn("only set one of -m or -u\n"); + argp_usage(state); + } + env->units = MSEC; + break; + case 'u': + if (env->units != NSEC) + { + warn("only set one of -m or -u\n"); + argp_usage(state); + } + env->units = USEC; + break; + case 'd': + errno = 0; + duration = strtol(arg, NULL, 10); + if (errno || duration <= 0) + { + warn("Invalid duration: %s\n", arg); + argp_usage(state); + } + env->duration = duration; + break; + case 'i': + errno = 0; + interval = strtol(arg, NULL, 10); + if (errno || interval <= 0) + { + warn("Invalid interval: %s\n", arg); + argp_usage(state); + } + env->interval = interval; + break; + case 'T': + env->timestamp = true; + break; + case 'k': + env->kprobes = true; + break; + case 'v': + env->verbose = true; + break; + case 'h': + argp_state_help(state, stderr, ARGP_HELP_STD_HELP); + break; + case ARGP_KEY_ARG: + if (env->funcname) + { + warn("Too many function names: %s\n", arg); + argp_usage(state); + } + env->funcname = arg; + break; + case ARGP_KEY_END: + if (!env->funcname) + { + warn("Need a function to trace\n"); + argp_usage(state); + } + if (env->duration) + { + if (env->interval > env->duration) + env->interval = env->duration; + env->iterations = env->duration / env->interval; + } + break; + default: + return ARGP_ERR_UNKNOWN; + } + return 0; +} + +static int libbpf_print_fn(enum libbpf_print_level level, const char *format, va_list args) +{ + if (level == LIBBPF_DEBUG && !env.verbose) + return 0; + return vfprintf(stderr, format, args); +} + +static const char *unit_str(void) +{ + switch (env.units) + { + case NSEC: + return "nsec"; + case USEC: + return "usec"; + case MSEC: + return "msec"; + }; + + return "bad units"; +} + +static int attach_kprobes(struct funclatency_bpf *obj) +{ + obj->links.dummy_kprobe = + bpf_program__attach_kprobe(obj->progs.dummy_kprobe, false, + env.funcname); + if (!obj->links.dummy_kprobe) + { + warn("failed to attach kprobe: %d\n", -errno); + return -1; + } + + obj->links.dummy_kretprobe = + bpf_program__attach_kprobe(obj->progs.dummy_kretprobe, true, + env.funcname); + if (!obj->links.dummy_kretprobe) + { + warn("failed to attach kretprobe: %d\n", -errno); + return -1; + } + + return 0; +} + +static int attach_uprobes(struct funclatency_bpf *obj) +{ + char *binary, *function; + char bin_path[PATH_MAX]; + off_t func_off; + int ret = -1; + long err; + + binary = strdup(env.funcname); + if (!binary) + { + warn("strdup failed"); + return -1; + } + function = strchr(binary, ':'); + if (!function) + { + warn("Binary should have contained ':' (internal bug!)\n"); + return -1; + } + *function = '\0'; + function++; + + if (resolve_binary_path(binary, env.pid, bin_path, sizeof(bin_path))) + goto out_binary; + + func_off = get_elf_func_offset(bin_path, function); + if (func_off < 0) + { + warn("Could not find %s in %s\n", function, bin_path); + goto out_binary; + } + + obj->links.dummy_kprobe = + bpf_program__attach_uprobe(obj->progs.dummy_kprobe, false, + env.pid ?: -1, bin_path, func_off); + if (!obj->links.dummy_kprobe) + { + err = -errno; + warn("Failed to attach uprobe: %ld\n", err); + goto out_binary; + } + + obj->links.dummy_kretprobe = + bpf_program__attach_uprobe(obj->progs.dummy_kretprobe, true, + env.pid ?: -1, bin_path, func_off); + if (!obj->links.dummy_kretprobe) + { + err = -errno; + warn("Failed to attach uretprobe: %ld\n", err); + goto out_binary; + } + + ret = 0; + +out_binary: + free(binary); + + return ret; +} + +static volatile bool exiting; + +static void sig_hand(int signr) +{ + exiting = true; +} + +static struct sigaction sigact = {.sa_handler = sig_hand}; + +static void print_stars(unsigned int val, unsigned int val_max, int width) +{ + int num_stars, num_spaces, i; + bool need_plus; + + num_stars = min(val, val_max) * width / val_max; + num_spaces = width - num_stars; + need_plus = val > val_max; + + for (i = 0; i < num_stars; i++) + printf("*"); + for (i = 0; i < num_spaces; i++) + printf(" "); + if (need_plus) + printf("+"); +} + +void print_log2_hist(unsigned int *vals, int vals_size, const char *val_type) +{ + int stars_max = 40, idx_max = -1; + unsigned int val, val_max = 0; + unsigned long long low, high; + int stars, width, i; + + for (i = 0; i < vals_size; i++) + { + val = vals[i]; + if (val > 0) + idx_max = i; + if (val > val_max) + val_max = val; + } + + if (idx_max < 0) + return; + + printf("%*s%-*s : count distribution\n", idx_max <= 32 ? 5 : 15, "", + idx_max <= 32 ? 19 : 29, val_type); + + if (idx_max <= 32) + stars = stars_max; + else + stars = stars_max / 2; + + for (i = 0; i <= idx_max; i++) + { + low = (1ULL << (i + 1)) >> 1; + high = (1ULL << (i + 1)) - 1; + if (low == high) + low -= 1; + val = vals[i]; + width = idx_max <= 32 ? 10 : 20; + printf("%*lld -> %-*lld : %-8d |", width, low, width, high, val); + print_stars(val, val_max, stars); + printf("|\n"); + } +} + +int main(int argc, char **argv) +{ + LIBBPF_OPTS(bpf_object_open_opts, open_opts); + static const struct argp argp = { + .options = opts, + .parser = parse_arg, + .args_doc = args_doc, + .doc = program_doc, + }; + struct funclatency_bpf *obj; + int i, err; + struct tm *tm; + char ts[32]; + time_t t; + int idx, cg_map_fd; + int cgfd = -1; + bool used_fentry = false; + + err = argp_parse(&argp, argc, argv, 0, NULL, &env); + if (err) + return err; + + env.is_kernel_func = !strchr(env.funcname, ':'); + + sigaction(SIGINT, &sigact, 0); + + libbpf_set_print(libbpf_print_fn); + + obj = funclatency_bpf__open_opts(&open_opts); + if (!obj) + { + warn("failed to open BPF object\n"); + return 1; + } + + obj->rodata->units = env.units; + obj->rodata->targ_tgid = env.pid; + + err = funclatency_bpf__load(obj); + if (err) + { + warn("failed to load BPF object\n"); + return 1; + } + + if (!obj->bss) + { + warn("Memory-mapping BPF maps is supported starting from Linux 5.7, please upgrade.\n"); + goto cleanup; + } + + if (env.is_kernel_func) + err = attach_kprobes(obj); + else + err = attach_uprobes(obj); + if (err) + goto cleanup; + + err = funclatency_bpf__attach(obj); + if (err) + { + fprintf(stderr, "failed to attach BPF programs: %s\n", + strerror(-err)); + goto cleanup; + } + + printf("Tracing %s. Hit Ctrl-C to exit\n", env.funcname); + + for (i = 0; i < env.iterations && !exiting; i++) + { + sleep(env.interval); + + printf("\n"); + if (env.timestamp) + { + time(&t); + tm = localtime(&t); + strftime(ts, sizeof(ts), "%H:%M:%S", tm); + printf("%-8s\n", ts); + } + + print_log2_hist(obj->bss->hist, MAX_SLOTS, unit_str()); + + /* Cleanup histograms for interval output */ + memset(obj->bss->hist, 0, sizeof(obj->bss->hist)); + } + + printf("Exiting trace of %s\n", env.funcname); + +cleanup: + funclatency_bpf__destroy(obj); + cleanup_core_btf(&open_opts); + if (cgfd > 0) + close(cgfd); + + return err != 0; +} \ No newline at end of file diff --git a/src/32-funclatency/funclatency.h b/src/32-funclatency/funclatency.h new file mode 100644 index 0000000..82808a1 --- /dev/null +++ b/src/32-funclatency/funclatency.h @@ -0,0 +1,18 @@ +/* SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) */ +/* Copyright (c) 2020 Facebook */ +#ifndef __BOOTSTRAP_H +#define __BOOTSTRAP_H + +/* SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) */ +#pragma once + +#define MAX_PIDS 102400 +#define MAX_SLOTS 25 + +enum units { + NSEC, + USEC, + MSEC, +}; + +#endif /* __BOOTSTRAP_H */