chore: rename project to bpf-go-socket

.github/workflows/verify-pr.yaml → .github/workflows/pr-created.yaml

@@ -1,30 +1,24 @@
 ---
-name: Verify Pull Request
-
+name: PR Created
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
-
 on:
   pull_request:
     branches:
       - main
-
 jobs:
   verify:
     runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
       with:
         submodules: recursive
-
     - name: Install Build Dependencies
       uses: ./.github/actions/install-dependencies
-
     - name: Compile App
       run: |
         make
-
     - name: Run App
       run: |
-        sudo timeout --preserve-status 5s ./socket-filter
+        sudo timeout --preserve-status 5s ./socket

.gitignore

@@ -2,5 +2,5 @@
 
 .output/
 
-socket-filter
-socket-filter.bpf.o
+socket
+socket.bpf.o

Makefile

@@ -25,11 +25,11 @@ CFLAGS := -g -Wall
 ALL_LDFLAGS := $(LDFLAGS) $(EXTRA_LDFLAGS)
 
 .PHONY: all
-all: socket-filter
+all: socket
 
 .PHONY: clean
 clean:
-	rm -rf $(OUTPUT) socket-filter.bpf.o socket-filter
+	rm -rf $(OUTPUT) socket.bpf.o socket
 
 $(OUTPUT) $(OUTPUT)/libbpf $(BPFTOOL_OUTPUT):
 	mkdir -p $@
@@ -45,13 +45,12 @@ $(LIBBPF_OBJ): $(wildcard $(LIBBPF_SRC)/*.[ch] $(LIBBPF_SRC)/Makefile) | $(OUTPU
 $(BPFTOOL): | $(BPFTOOL_OUTPUT)
 	$(MAKE) ARCH= CROSS_COMPILE= OUTPUT=$(BPFTOOL_OUTPUT)/ -C $(BPFTOOL_SRC) bootstrap
 
-# Build BPF code
-socket-filter.bpf.o: socket-filter.bpf.c $(LIBBPF_OBJ) | $(OUTPUT)
-	$(CLANG) -g -O2 -target bpf -D__TARGET_ARCH_$(ARCH) $(INCLUDES) $(CLANG_BPF_SYS_INCLUDES) -c socket-filter.bpf.c -o $@
+socket.bpf.o: socket.bpf.c $(LIBBPF_OBJ) | $(OUTPUT)
+	$(CLANG) -g -O2 -target bpf -D__TARGET_ARCH_$(ARCH) $(INCLUDES) $(CLANG_BPF_SYS_INCLUDES) -c socket.bpf.c -o $@
 	$(LLVM_STRIP) -g $@
 
 # Build application binary
-socket-filter: socket-filter.bpf.o main.go
+socket: socket.bpf.o main.go
 	$(GO) build -o $@ main.go
 
 .PHONY: $(VMLINUX)
@@ -61,8 +60,8 @@ $(VMLINUX): $(BPFTOOL)
 .PHONY: format
 format:
 	$(CLANG_FORMAT) --verbose -i \
-	socket-filter.bpf.c \
-	socket-filter.h
+	socket.bpf.c \
+	socket.h
 
 # delete failed targets
 .DELETE_ON_ERROR:

README.md

@@ -1,7 +1,7 @@
-# bpf-go-socket-filter
+# bpf-go-socket
 
-The `socket-filter` program demonstrates how to load an eBPF program from an ELF file,
-and attach it to a raw socket.
+The `socket-filter` program demonstrates how to load an eBPF program from an
+ELF file, and attach it to a raw socket.
 
 `BPF_PROG_TYPE_SOCKET_FILTER` was the first program type to be added to the
 Linux kernel. When you attach a BPF program to a raw socket, you get access to
@@ -17,12 +17,12 @@ packet.
 Clone and change current directory to the cloned repository:
 
 ```
-git clone --recurse-submodules https://github.com/danielpacak/bpf-go-socket-filter.git
+git clone --recurse-submodules https://github.com/danielpacak/bpf-go-socket.git
 ```
 or
 ```
-git clone https://github.com/danielpacak/bpf-go-socket-filter.git
-cd bpf-go-socket-filter
+git clone https://github.com/danielpacak/bpf-go-socket.git
+cd bpf-go-socket
 git submodule update --init --recursive
 ```
 
@@ -35,18 +35,18 @@ make
 Run the application as root with `sudo`:
 
 ``` console
-$ sudo ./socket-filter --index=0
+$ sudo ./socket --index=0
 Filtering as uid=0(root) on eth index: 0
         ICMP: 20 TCP: 121 UDP: 12_
 ```
 
 Run the application as non-root user:
 
 ```
-sudo setcap 'cap_net_raw=ep cap_bpf=ep' ./socket-filter
+sudo setcap 'cap_net_raw=ep cap_bpf=ep' ./socket
 ```
 ``` console
-$ ./socket-filter
+$ ./socket
 Filtering as uid=1000(dpacak) on eth index: 0
 	ICMP: 0 TCP: 6167 UDP: 0_
 ```

go.mod

@@ -1,4 +1,4 @@
-module github.com/danielpacak/bpf-go-socket-filter
+module danielpacak/bpf-go-socket
 
 go 1.21
 

main.go

@@ -43,7 +43,7 @@ func run(ctx context.Context) error {
 	if err != nil {
 		return err
 	}
-	bpfObjectFile := path.Join(filepath.Dir(executable), "socket-filter.bpf.o")
+	bpfObjectFile := path.Join(filepath.Dir(executable), "socket.bpf.o")
 
 	spec, err := ebpf.LoadCollectionSpec(bpfObjectFile)
 	if err != nil {

socket-filter.bpf.c → socket.bpf.c

@@ -1,15 +1,14 @@
 //+build ignore
 
-#include "socket-filter.h"
+#include "socket.h"
 #include "vmlinux.h"
 #include <bpf/bpf_core_read.h>
 #include <bpf/bpf_helpers.h>
 #include <bpf/bpf_tracing.h>
 
 char LICENSE[] SEC("license") = "GPL";
 
-#define ETH_HLEN                                                               \
-  14 /* Total octets in header (copied from linux/if_ether.h).	 */
+#define ETH_HLEN 14 // Total octets in header (copied from linux/if_ether.h).
 
 struct {
   __uint(type, BPF_MAP_TYPE_ARRAY);

socket.h

@@ -0,0 +1,6 @@
+//+build ignore
+
+#ifndef __SOCKET_H
+#define __SOCKET_H
+
+#endif /* __SOCKET_H */