c5f4ba1b1b
Distribution packages reasonably expect to have a human-readable Markdown version of the README under /usr/share/doc/, but all we have right now is a heavily web-oriented version. Introduce a ugly hack to strip web-oriented parts from the current README and install it. It should probably work the other way around: a human-readable README could be used as a source for the web page. But cgit needs a file that's in the tree, not something that can be built, and https://passt.top/ is based on cgit. It should eventually be doable to work around this in cgit, instead. Reported-by: Benson Muite <benson_muite@emailplus.org> Signed-off-by: Stefano Brivio <sbrivio@redhat.com>
298 lines
10 KiB
Makefile
298 lines
10 KiB
Makefile
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
#
|
|
# PASST - Plug A Simple Socket Transport
|
|
# for qemu/UNIX domain socket mode
|
|
#
|
|
# PASTA - Pack A Subtle Tap Abstraction
|
|
# for network namespace/tap device mode
|
|
#
|
|
# Copyright (c) 2021 Red Hat GmbH
|
|
# Author: Stefano Brivio <sbrivio@redhat.com>
|
|
|
|
RLIMIT_STACK_VAL := $(shell /bin/sh -c 'ulimit -s')
|
|
ifeq ($(RLIMIT_STACK_VAL),unlimited)
|
|
RLIMIT_STACK_VAL := 1024
|
|
endif
|
|
|
|
# Get 'uname -m'-like architecture description for target
|
|
TARGET_ARCH := $(shell $(CC) -dumpmachine | cut -f1 -d- | tr [a-z] [A-Z])
|
|
TARGET_ARCH := $(shell echo $(TARGET_ARCH) | sed 's/POWERPC/PPC/')
|
|
|
|
AUDIT_ARCH := $(shell echo $(TARGET_ARCH) | sed 's/^ARM.*/ARM/')
|
|
AUDIT_ARCH := $(shell echo $(AUDIT_ARCH) | sed 's/I[456]86/I386/')
|
|
AUDIT_ARCH := $(shell echo $(AUDIT_ARCH) | sed 's/PPC64/PPC/')
|
|
AUDIT_ARCH := $(shell echo $(AUDIT_ARCH) | sed 's/PPCLE/PPC64LE/')
|
|
|
|
CFLAGS += -Wall -Wextra -pedantic -std=c99 -D_XOPEN_SOURCE=700 -D_GNU_SOURCE
|
|
CFLAGS += -D_FORTIFY_SOURCE=2 -O2 -pie -fPIE
|
|
CFLAGS += -DPAGE_SIZE=$(shell getconf PAGE_SIZE)
|
|
CFLAGS += -DNETNS_RUN_DIR=\"/run/netns\"
|
|
CFLAGS += -DPASST_AUDIT_ARCH=AUDIT_ARCH_$(AUDIT_ARCH)
|
|
CFLAGS += -DRLIMIT_STACK_VAL=$(RLIMIT_STACK_VAL)
|
|
CFLAGS += -DARCH=\"$(TARGET_ARCH)\"
|
|
|
|
PASST_SRCS = arch.c arp.c checksum.c conf.c dhcp.c dhcpv6.c icmp.c igmp.c \
|
|
lineread.c mld.c ndp.c netlink.c packet.c passt.c pasta.c pcap.c \
|
|
siphash.c tap.c tcp.c tcp_splice.c udp.c util.c
|
|
QRAP_SRCS = qrap.c
|
|
SRCS = $(PASST_SRCS) $(QRAP_SRCS)
|
|
|
|
MANPAGES = passt.1 pasta.1 qrap.1
|
|
|
|
PASST_HEADERS = arch.h arp.h checksum.h conf.h dhcp.h dhcpv6.h icmp.h \
|
|
lineread.h ndp.h netlink.h packet.h passt.h pasta.h pcap.h \
|
|
siphash.h tap.h tcp.h tcp_splice.h udp.h util.h
|
|
HEADERS = $(PASST_HEADERS)
|
|
|
|
# On gcc 11.2, with -O2 and -flto, tcp_hash() and siphash_20b(), if inlined,
|
|
# seem to be hitting something similar to:
|
|
# https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78993
|
|
# from the pointer arithmetic used from the tcp_tap_handler() path to get the
|
|
# remote connection address.
|
|
ifeq ($(shell $(CC) -dumpversion),11)
|
|
ifneq (,$(filter -flto%,$(CFLAGS)))
|
|
ifneq (,$(filter -O2,$(CFLAGS)))
|
|
CFLAGS += -DTCP_HASH_NOINLINE
|
|
CFLAGS += -DSIPHASH_20B_NOINLINE
|
|
endif
|
|
endif
|
|
endif
|
|
|
|
C := \#include <linux/tcp.h>\nstruct tcp_info x = { .tcpi_snd_wnd = 0 };
|
|
ifeq ($(shell printf "$(C)" | $(CC) -S -xc - -o - >/dev/null 2>&1; echo $$?),0)
|
|
CFLAGS += -DHAS_SND_WND
|
|
endif
|
|
|
|
C := \#include <linux/tcp.h>\nstruct tcp_info x = { .tcpi_bytes_acked = 0 };
|
|
ifeq ($(shell printf "$(C)" | $(CC) -S -xc - -o - >/dev/null 2>&1; echo $$?),0)
|
|
CFLAGS += -DHAS_BYTES_ACKED
|
|
endif
|
|
|
|
C := \#include <linux/tcp.h>\nstruct tcp_info x = { .tcpi_min_rtt = 0 };
|
|
ifeq ($(shell printf "$(C)" | $(CC) -S -xc - -o - >/dev/null 2>&1; echo $$?),0)
|
|
CFLAGS += -DHAS_MIN_RTT
|
|
endif
|
|
|
|
C := \#include <sys/random.h>\nint main(){int a=getrandom(0, 0, 0);}
|
|
ifeq ($(shell printf "$(C)" | $(CC) -S -xc - -o - >/dev/null 2>&1; echo $$?),0)
|
|
CFLAGS += -DHAS_GETRANDOM
|
|
endif
|
|
|
|
ifeq ($(shell :|$(CC) -fstack-protector-strong -S -xc - -o - >/dev/null 2>&1; echo $$?),0)
|
|
CFLAGS += -fstack-protector-strong
|
|
endif
|
|
|
|
prefix ?= /usr/local
|
|
|
|
ifeq ($(TARGET_ARCH),X86_64)
|
|
BIN := passt passt.avx2 pasta pasta.avx2 qrap
|
|
else
|
|
BIN := passt pasta qrap
|
|
endif
|
|
|
|
all: $(BIN) $(MANPAGES) docs
|
|
|
|
static: CFLAGS += -static -DGLIBC_NO_STATIC_NSS
|
|
static: clean all
|
|
|
|
seccomp.h: $(PASST_SRCS) $(PASST_HEADERS)
|
|
@ EXTRA_SYSCALLS=$(EXTRA_SYSCALLS) ./seccomp.sh $^
|
|
|
|
passt: $(PASST_SRCS) $(PASST_HEADERS) seccomp.h
|
|
$(CC) $(CFLAGS) $(PASST_SRCS) -o passt
|
|
|
|
passt.avx2: CFLAGS += -Ofast -mavx2 -ftree-vectorize -funroll-loops
|
|
passt.avx2: $(PASST_SRCS) $(PASST_HEADERS) seccomp.h
|
|
$(CC) $(filter-out -O2,$(CFLAGS)) $(PASST_SRCS) -o passt.avx2
|
|
|
|
passt.avx2: passt
|
|
|
|
pasta.avx2 pasta.1 pasta: pasta%: passt%
|
|
ln -s $< $@
|
|
|
|
qrap: $(QRAP_SRCS) passt.h
|
|
$(CC) $(CFLAGS) $(QRAP_SRCS) -o qrap
|
|
|
|
valgrind: EXTRA_SYSCALLS="rt_sigprocmask rt_sigtimedwait rt_sigaction \
|
|
getpid gettid kill clock_gettime mmap munmap open \
|
|
unlink gettimeofday futex"
|
|
valgrind: CFLAGS:=-g -O0 $(filter-out -O%,$(CFLAGS))
|
|
valgrind: all
|
|
|
|
.PHONY: clean
|
|
clean:
|
|
$(RM) $(BIN) *.o seccomp.h pasta.1 \
|
|
passt.tar passt.tar.gz *.deb *.rpm \
|
|
passt.pid README.plain.md
|
|
|
|
install: $(BIN) $(MANPAGES) docs
|
|
mkdir -p $(DESTDIR)$(prefix)/bin $(DESTDIR)$(prefix)/share/man/man1
|
|
cp -d $(BIN) $(DESTDIR)$(prefix)/bin
|
|
cp -d $(MANPAGES) $(DESTDIR)$(prefix)/share/man/man1
|
|
mkdir -p $(DESTDIR)$(prefix)/share/doc/passt
|
|
cp -d README.plain.md $(DESTDIR)$(prefix)/share/doc/passt/README.md
|
|
|
|
uninstall:
|
|
$(RM) $(BIN:%=$(DESTDIR)$(prefix)/bin/%)
|
|
$(RM) $(MANPAGES:%=$(DESTDIR)$(prefix)/share/man/man1/%)
|
|
|
|
pkgs: static
|
|
tar cf passt.tar -P --xform 's//\/usr\/bin\//' $(BIN)
|
|
tar rf passt.tar -P --xform 's//\/usr\/share\/man\/man1\//' \
|
|
$(MANPAGES)
|
|
gzip passt.tar
|
|
EMAIL="sbrivio@redhat.com" fakeroot alien --to-deb \
|
|
--description="User-mode networking for VMs and namespaces" \
|
|
-k --version=$(shell git rev-parse --short HEAD) \
|
|
passt.tar.gz
|
|
fakeroot alien --to-rpm --target=$(shell uname -m) \
|
|
--description="User-mode networking for VMs and namespaces" \
|
|
-k --version=g$(shell git rev-parse --short HEAD) passt.tar.gz
|
|
|
|
# TODO: This hack makes a "plain" Markdown version of README.md that can be
|
|
# reasonably shipped as documentation file, while the current README.md is
|
|
# definitely intended for web browser consumption. It should probably work the
|
|
# other way around: the web version should be obtained by adding HTML and
|
|
# JavaScript portions to a plain Markdown, instead. However, cgit needs to use
|
|
# a file in the git tree. Find a better way around this.
|
|
docs: README.md
|
|
@( \
|
|
skip=0; \
|
|
while read l; do \
|
|
case $$l in \
|
|
"## Demo") exit 0 ;; \
|
|
"<!"*) ;; \
|
|
"</"*) skip=1 ;; \
|
|
"<"*) skip=2 ;; \
|
|
esac; \
|
|
\
|
|
[ $$skip -eq 0 ] && echo "$$l"; \
|
|
[ $$skip -eq 1 ] && skip=0; \
|
|
done < README.md; \
|
|
) > README.plain.md
|
|
|
|
# Checkers currently disabled for clang-tidy:
|
|
# - llvmlibc-restrict-system-libc-headers
|
|
# TODO: this is Linux-only for the moment, nice to fix eventually
|
|
#
|
|
# - bugprone-macro-parentheses
|
|
# - google-readability-braces-around-statements
|
|
# - hicpp-braces-around-statements
|
|
# - readability-braces-around-statements
|
|
# Debatable whether that improves readability, right now it would look
|
|
# like a mess
|
|
#
|
|
# - readability-magic-numbers
|
|
# - cppcoreguidelines-avoid-magic-numbers
|
|
# TODO: in most cases they are justified, but probably not everywhere
|
|
#
|
|
# - clang-analyzer-valist.Uninitialized
|
|
# TODO: enable once https://bugs.llvm.org/show_bug.cgi?id=41311 is fixed
|
|
#
|
|
# - clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling
|
|
# Probably not doable to impement this without plain memcpy(), memset()
|
|
#
|
|
# - cppcoreguidelines-init-variables
|
|
# Dubious value, would kill readability
|
|
#
|
|
# - hicpp-signed-bitwise
|
|
# Those are needed for syscalls, epoll_wait flags, etc.
|
|
#
|
|
# - llvm-include-order
|
|
# TODO: not really important, but nice to fix eventually
|
|
#
|
|
# - readability-isolate-declaration
|
|
# Dubious value, would kill readability
|
|
#
|
|
# - bugprone-narrowing-conversions
|
|
# - cppcoreguidelines-narrowing-conversions
|
|
# TODO: nice to fix eventually
|
|
#
|
|
# - cppcoreguidelines-avoid-non-const-global-variables
|
|
# TODO: check, fix, and more in general constify wherever possible
|
|
#
|
|
# - altera-unroll-loops
|
|
# - altera-id-dependent-backward-branch
|
|
# TODO: check paths where it might make sense to improve performance
|
|
#
|
|
# - bugprone-easily-swappable-parameters
|
|
# Not much can be done about them other than being careful
|
|
#
|
|
# - readability-function-cognitive-complexity
|
|
# TODO: split reported functions
|
|
#
|
|
# - altera-struct-pack-align
|
|
# "Poor" alignment needed for structs reflecting message formats/headers
|
|
#
|
|
# - concurrency-mt-unsafe
|
|
# TODO: check again if multithreading is implemented
|
|
|
|
clang-tidy: $(SRCS) $(HEADERS)
|
|
clang-tidy -checks=*,-modernize-*,\
|
|
-clang-analyzer-valist.Uninitialized,\
|
|
-cppcoreguidelines-init-variables,\
|
|
-bugprone-macro-parentheses,\
|
|
-google-readability-braces-around-statements,\
|
|
-hicpp-braces-around-statements,\
|
|
-readability-braces-around-statements,\
|
|
-readability-magic-numbers,\
|
|
-llvmlibc-restrict-system-libc-headers,\
|
|
-hicpp-signed-bitwise,\
|
|
-clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling,\
|
|
-llvm-include-order,\
|
|
-cppcoreguidelines-avoid-magic-numbers,\
|
|
-readability-isolate-declaration,\
|
|
-bugprone-narrowing-conversions,\
|
|
-cppcoreguidelines-narrowing-conversions,\
|
|
-cppcoreguidelines-avoid-non-const-global-variables,\
|
|
-altera-unroll-loops,-altera-id-dependent-backward-branch,\
|
|
-bugprone-easily-swappable-parameters,\
|
|
-readability-function-cognitive-complexity,\
|
|
-altera-struct-pack-align,\
|
|
-concurrency-mt-unsafe \
|
|
-config='{CheckOptions: [{key: bugprone-suspicious-string-compare.WarnOnImplicitComparison, value: "false"}]}' \
|
|
--warnings-as-errors=* $(SRCS) -- $(filter-out -pie,$(CFLAGS))
|
|
|
|
ifeq ($(shell $(CC) -v 2>&1 | grep -c "gcc version"),1)
|
|
TARGET := $(shell ${CC} -v 2>&1 | sed -n 's/Target: \(.*\)/\1/p')
|
|
VER := $(shell $(CC) -dumpversion)
|
|
EXTRA_INCLUDES := /usr/lib/gcc/$(TARGET)/$(VER)/include
|
|
EXTRA_INCLUDES_OPT := -I$(EXTRA_INCLUDES)
|
|
else
|
|
EXTRA_INCLUDES_OPT :=
|
|
endif
|
|
cppcheck: $(SRCS) $(HEADERS)
|
|
cppcheck --std=c99 --error-exitcode=1 --enable=all --force \
|
|
--inconclusive --library=posix \
|
|
-I/usr/include $(EXTRA_INCLUDES_OPT) \
|
|
\
|
|
--suppress=syntaxError:/usr/include/stdlib.h \
|
|
--suppress=missingIncludeSystem \
|
|
--suppress="*:$(EXTRA_INCLUDES)/avx512fintrin.h" \
|
|
--suppress="*:$(EXTRA_INCLUDES)/xmmintrin.h" \
|
|
--suppress="*:$(EXTRA_INCLUDES)/emmintrin.h" \
|
|
--suppress="*:$(EXTRA_INCLUDES)/avxintrin.h" \
|
|
--suppress="*:$(EXTRA_INCLUDES)/bmiintrin.h" \
|
|
\
|
|
--suppress=objectIndex:tcp.c --suppress=objectIndex:udp.c \
|
|
--suppress=va_list_usedBeforeStarted:util.c \
|
|
--suppress=unusedFunction \
|
|
--suppress=knownConditionTrueFalse:conf.c \
|
|
--suppress=strtokCalled:conf.c --suppress=strtokCalled:qrap.c \
|
|
--suppress=getpwnamCalled:passt.c \
|
|
--suppress=localtimeCalled:pcap.c \
|
|
--suppress=unusedStructMember:pcap.c \
|
|
--suppress=funcArgNamesDifferent:util.h \
|
|
--suppress=unusedStructMember:dhcp.c \
|
|
\
|
|
--suppress=unmatchedSuppression:conf.c \
|
|
--suppress=unmatchedSuppression:dhcp.c \
|
|
--suppress=unmatchedSuppression:passt.c \
|
|
--suppress=unmatchedSuppression:pcap.c \
|
|
--suppress=unmatchedSuppression:qrap.c \
|
|
--suppress=unmatchedSuppression:tcp.c \
|
|
--suppress=unmatchedSuppression:udp.c \
|
|
--suppress=unmatchedSuppression:util.c \
|
|
--suppress=unmatchedSuppression:util.h \
|
|
$(filter -D%,$(CFLAGS)) \
|
|
.
|