Add cargo-build-bpf (bp #13040) (#13075)

* Add cargo-build-bpf

(cherry picked from commit 07a853d6cc)

* Remove do.sh

(cherry picked from commit 61be155413)

Co-authored-by: Michael Vines <mvines@gmail.com>

sdk/bpf/env.sh

@@ -0,0 +1,39 @@
+#
+# Configures the BPF SDK environment
+#
+
+if [ -z "$bpf_sdk" ]; then
+  bpf_sdk=.
+fi
+
+# Ensure the sdk is installed
+"$bpf_sdk"/scripts/install.sh
+
+# Use the SDK's version of llvm to build the compiler-builtins for BPF
+export CC="$bpf_sdk/dependencies/llvm-native/bin/clang"
+export AR="$bpf_sdk/dependencies/llvm-native/bin/llvm-ar"
+export OBJDUMP="$bpf_sdk/dependencies/llvm-native/bin/llvm-objdump"
+export OBJCOPY="$bpf_sdk/dependencies/llvm-native/bin/llvm-objcopy"
+
+# Use the SDK's version of Rust to build for BPF
+export RUSTUP_TOOLCHAIN=bpf
+export RUSTFLAGS="
+    -C lto=no \
+    -C opt-level=2 \
+    -C link-arg=-z -C link-arg=notext \
+    -C link-arg=-T$bpf_sdk/rust/bpf.ld \
+    -C link-arg=--Bdynamic \
+    -C link-arg=-shared \
+    -C link-arg=--entry=entrypoint \
+    -C link-arg=-no-threads \
+    -C linker=$bpf_sdk/dependencies/llvm-native/bin/ld.lld"
+
+# CARGO may be set if run from within cargo, causing
+# incompatibilities between cargo and xargo versions
+unset CARGO
+
+export XARGO="$bpf_sdk"/dependencies/bin/xargo
+export XARGO_TARGET=bpfel-unknown-unknown
+export XARGO_HOME="$bpf_sdk/dependencies/xargo"
+export XARGO_RUST_SRC="$bpf_sdk/dependencies/rust-bpf-sysroot/src"
+export RUST_COMPILER_RT_ROOT="$bpf_sdk/dependencies/rust-bpf-sysroot/src/compiler-rt"

sdk/bpf/rust/build.sh

@@ -1,49 +1,21 @@
 #!/usr/bin/env bash
 
-if [ "$#" -ne 1 ]; then
+if [[ "$#" -ne 1 ]]; then
     echo "Error: Must provide the full path to the project to build"
     exit 1
 fi
-if [ ! -f "$1/Cargo.toml" ]; then
+if [[ ! -f "$1/Cargo.toml" ]]; then
       echo "Error: Cannot find project: $1"
     exit 1
 fi
+bpf_sdk=$(cd "$(dirname "$0")/.." && pwd)
 
 echo "Building $1"
 set -e
-
-bpf_sdk=$(cd "$(dirname "$0")/.." && pwd)
-
-# Ensure the sdk is installed
-"$bpf_sdk"/scripts/install.sh
-
-# Use the SDK's version of llvm to build the compiler-builtins for BPF
-export CC="$bpf_sdk/dependencies/llvm-native/bin/clang"
-export AR="$bpf_sdk/dependencies/llvm-native/bin/llvm-ar"
-
-# Use the SDK's version of Rust to build for BPF
-export RUSTUP_TOOLCHAIN=bpf
-export RUSTFLAGS="
-    -C lto=no \
-    -C opt-level=2 \
-    -C link-arg=-z -C link-arg=notext \
-    -C link-arg=-T$bpf_sdk/rust/bpf.ld \
-    -C link-arg=--Bdynamic \
-    -C link-arg=-shared \
-    -C link-arg=--entry=entrypoint \
-    -C link-arg=-no-threads \
-    -C linker=$bpf_sdk/dependencies/llvm-native/bin/ld.lld"
-
-# CARGO may be set if build.sh is run from within cargo, causing
-# incompatibilities between cargo and xargo versions
-unset CARGO
-
-# Setup xargo
-export XARGO_HOME="$bpf_sdk/dependencies/xargo"
-export XARGO_RUST_SRC="$bpf_sdk/dependencies/rust-bpf-sysroot/src"
-export RUST_COMPILER_RT_ROOT="$bpf_sdk/dependencies/rust-bpf-sysroot/src/compiler-rt"
+# shellcheck source=sdk/bpf/env.sh
+source "$bpf_sdk"/env.sh
 
 cd "$1"
-xargo build --target bpfel-unknown-unknown --release --no-default-features --features program
+"$XARGO" build --target "$XARGO_TARGET" --release --no-default-features --features program
 
 { { set +x; } 2>/dev/null; echo Success; }

sdk/bpf/rust/xargo-build.sh

@@ -0,0 +1,29 @@
+#!/usr/bin/env bash
+
+bpf_sdk=$(cd "$(dirname "$0")/.." && pwd)
+# shellcheck source=sdk/bpf/env.sh
+source "$bpf_sdk"/env.sh
+
+set -e
+(
+  while true; do
+    if [[ -r Xargo.toml ]]; then
+      break;
+    fi
+    if [[ $PWD = / ]]; then
+      cat <<EOF
+Error: Failed to find Xargo.toml
+
+Please create a Xargo.toml file in the same directory as your Cargo.toml with
+the following contents:
+
+  [target.bpfel-unknown-unknown.dependencies.std]
+  features = []
+
+EOF
+      exit 1
+    fi
+    cd ..
+  done
+)
+exec "$XARGO" build --target "$XARGO_TARGET" --release "$@"

sdk/bpf/scripts/bpf-trace.py

@@ -1,14 +1,13 @@
 #!/usr/bin/env python
 
-# 
+#
 # Prints a BPF program call trace with instruction counts for each call
 #
 # This script requires a dump file containing the instruction dump of the ELF
 # and a trace file that contains the trace output of the BPF VM
 #
-# You can create the dump file with do.sh:
-#  $ do.sh dump <project>
-# Or directly:
+# You can create the dump file by passing the --dump flag to `cargo build-bpf`,
+# or directly:
 #  $ llvm-objdump -print-imm-hex --source --disassemble <ELF file path>
 #
 # You can create the trace file by running the program and setting RUST_LOG:
@@ -53,7 +52,7 @@ if __name__ == '__main__':
         sys.exit('    Usage: ' + sys.argv[0] + ' dump_file trace_file')
     dumppath = sys.argv[1]
     tracepath = sys.argv[2]
-    
+
     # parse the dump file to create a map
     # of instruction numbers to symbols
     symbols = {}
@@ -76,7 +75,7 @@ if __name__ == '__main__':
             line = file_object.readline()
     if len(symbols) == 0:
         sys.exit("Error: No instruction dump in: " + dumppath)
-    
+
     # parse the trace file to build a call list
     calls = [] # all the calls made
     with open(tracepath, 'r') as file_object:

sdk/bpf/scripts/dump.sh

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+bpf_sdk=$(cd "$(dirname "$0")/.." && pwd)
+# shellcheck source=sdk/bpf/env.sh
+source "$bpf_sdk"/env.sh
+
+so=$1
+dump=$2
+if [[ -z $so ]] || [[ -z $dump ]]; then
+  echo "Usage: $0 bpf-program.so dump.txt"
+  exit 1
+fi
+
+if [[ ! -r $so ]]; then
+  echo "Error: File not found or readable: $so"
+  exit 1
+fi
+
+if ! command -v rustfilt > /dev/null; then
+  echo "Error: rustfilt not found.  It can be installed by running: cargo install rustfilt"
+  exit 1
+fi
+if ! command -v readelf > /dev/null; then
+  if [[ $(uname) = Darwin ]]; then
+      echo "Error: readelf not found.  It can be installed by running: brew install binutils"
+  else
+      echo "Error: readelf not found."
+  fi
+  exit 1
+fi
+
+dump_mangled=$dump.mangled
+
+(
+  set -ex
+  ls -la "$so" > "$dump_mangled"
+  readelf -aW "$so" >>"$dump_mangled"
+  "$OBJDUMP" -print-imm-hex --source --disassemble "$so" >> "$dump_mangled"
+  sed s/://g < "$dump_mangled" | rustfilt > "$dump"
+)
+rm -f "$dump_mangled"
+
+if [[ ! -f "$dump" ]]; then
+  echo "Error: Failed to create $dump"
+  exit 1
+fi
+
+echo "Wrote $dump"

sdk/bpf/scripts/install.sh

@@ -84,19 +84,24 @@ clone() {
 }
 
 # Install xargo
-(
-  set -ex
-  # shellcheck disable=SC2154
-  if [[ -n $rust_stable ]]; then
-    cargo +"$rust_stable" install xargo
-  else
-    cargo install xargo
+version=0.3.22
+if [[ ! -e xargo-$version.md ]] || [[ ! -x bin/xargo ]]; then
+  (
+    args=()
+    # shellcheck disable=SC2154
+    if [[ -n $rust_stable ]]; then
+      args+=(+"$rust_stable")
+    fi
+    args+=(install xargo --version "$version" --root .)
+    set -ex
+    cargo "${args[@]}"
+    ./bin/xargo --version >xargo-$version.md 2>&1
+  )
+  exitcode=$?
+  if [[ $exitcode -ne 0 ]]; then
+    rm -rf xargo-$version.md
+    exit 1
   fi
-  xargo --version >xargo.md 2>&1
-)
-# shellcheck disable=SC2181
-if [[ $? -ne 0 ]]; then
-  exit 1
 fi
 
 # Install Criterion

sdk/bpf/scripts/objcopy.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+bpf_sdk=$(cd "$(dirname "$0")/.." && pwd)
+# shellcheck source=sdk/bpf/env.sh
+source "$bpf_sdk"/env.sh
+exec "$bpf_sdk"/dependencies/llvm-native/bin/llvm-objcopy "$@"

sdk/bpf/scripts/strip.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+so=$1
+if [[ ! -r $so ]]; then
+  echo "Error: file not found: $so"
+  exit 1
+fi
+so_stripped=$2
+if [[ -z $so_stripped ]]; then
+  echo "Usage: $0 unstripped.so stripped.so"
+  exit 1
+fi
+
+bpf_sdk=$(cd "$(dirname "$0")/.." && pwd)
+# shellcheck source=sdk/bpf/env.sh
+source "$bpf_sdk"/env.sh
+"$bpf_sdk"/dependencies/llvm-native/bin/llvm-objcopy --strip-all "$so" "$so_stripped"