passt/doc/platform-requirements/Makefile

# SPDX-License-Identifier: GPL-2.0-or-later
#
# Copyright Red Hat
# Author: David Gibson <david@gibson.dropbear.id.au>

TARGETS = reuseaddr-priority recv-zero udp-close-dup
SRCS = reuseaddr-priority.c recv-zero.c udp-close-dup.c
CFLAGS = -Wall

all: cppcheck clang-tidy $(TARGETS:%=check-%)

$(TARGETS): %: %.c common.c common.h

check-%: %
	./$<

cppcheck:
	cppcheck --std=c11 --error-exitcode=1 --enable=all --force \
		--check-level=exhaustive --inline-suppr \
		--inconclusive --library=posix --quiet \
		--suppress=missingIncludeSystem \
		$(SRCS)

clang-tidy:
	clang-tidy --checks=*,\
	-altera-id-dependent-backward-branch,\
	-altera-unroll-loops,\
	-bugprone-easily-swappable-parameters,\
	-clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling,\
	-concurrency-mt-unsafe,\
	-cppcoreguidelines-avoid-non-const-global-variables,\
	-cppcoreguidelines-init-variables,\
	-cppcoreguidelines-macro-to-enum,\
	-google-readability-braces-around-statements,\
	-hicpp-braces-around-statements,\
	-llvmlibc-restrict-system-libc-headers,\
	-misc-include-cleaner,\
	-modernize-macro-to-enum,\
	-readability-braces-around-statements,\
	-readability-identifier-length,\
	-readability-isolate-declaration \
	$(SRCS)

clean:
	rm -f $(TARGETS) *.o *~
doc: Add program to document and test assumptions about SO_REUSEADDR For the approach we intend to use for handling UDP flows, we have some pretty specific requirements about how SO_REUSEADDR works with UDP sockets. Specifically SO_REUSEADDR allows multiple sockets with overlapping bind()s, and therefore there can be multiple sockets which are eligible to receive the same datagram. Which one will actually receive it is important to us. Add a test program which verifies things work the way we expect, which documents what those expectations are in the process. Signed-off-by: David Gibson <david@gibson.dropbear.id.au> Signed-off-by: Stefano Brivio <sbrivio@redhat.com> 2024-07-05 10:44:08 +00:00			`# SPDX-License-Identifier: GPL-2.0-or-later`
			`#`
			`# Copyright Red Hat`
			`# Author: David Gibson <david@gibson.dropbear.id.au>`

doc: Test behaviour of closing duplicate UDP sockets To simplify lifetime management of "listening" UDP sockets, UDP flow support needs to duplicate existing bound sockets. Those duplicates will be close()d when their corresponding flow expires, but we expect the original to still receive datagrams as always. That is, we expect the close() on the duplicate to remove the duplicated fd, but not to close the underlying UDP socket. Add a test program to doc/platform-requirements to verify this requirement. Signed-off-by: David Gibson <david@gibson.dropbear.id.au> Signed-off-by: Stefano Brivio <sbrivio@redhat.com> 2024-07-17 04:52:22 +00:00			`TARGETS = reuseaddr-priority recv-zero udp-close-dup`
			`SRCS = reuseaddr-priority.c recv-zero.c udp-close-dup.c`
doc: Add program to document and test assumptions about SO_REUSEADDR For the approach we intend to use for handling UDP flows, we have some pretty specific requirements about how SO_REUSEADDR works with UDP sockets. Specifically SO_REUSEADDR allows multiple sockets with overlapping bind()s, and therefore there can be multiple sockets which are eligible to receive the same datagram. Which one will actually receive it is important to us. Add a test program which verifies things work the way we expect, which documents what those expectations are in the process. Signed-off-by: David Gibson <david@gibson.dropbear.id.au> Signed-off-by: Stefano Brivio <sbrivio@redhat.com> 2024-07-05 10:44:08 +00:00			`CFLAGS = -Wall`

			`all: cppcheck clang-tidy $(TARGETS:%=check-%)`

			`$(TARGETS): %: %.c common.c common.h`

			`check-%: %`
			`./$<`

			`cppcheck:`
			`cppcheck --std=c11 --error-exitcode=1 --enable=all --force \`
doc: Test behaviour of zero length datagram recv()s Add a test program verifying that we're able to discard datagrams from a socket without needing a big discard buffer, by using a zero length recv(). Signed-off-by: David Gibson <david@gibson.dropbear.id.au> Signed-off-by: Stefano Brivio <sbrivio@redhat.com> 2024-07-05 10:44:09 +00:00			`--check-level=exhaustive --inline-suppr \`
doc: Add program to document and test assumptions about SO_REUSEADDR For the approach we intend to use for handling UDP flows, we have some pretty specific requirements about how SO_REUSEADDR works with UDP sockets. Specifically SO_REUSEADDR allows multiple sockets with overlapping bind()s, and therefore there can be multiple sockets which are eligible to receive the same datagram. Which one will actually receive it is important to us. Add a test program which verifies things work the way we expect, which documents what those expectations are in the process. Signed-off-by: David Gibson <david@gibson.dropbear.id.au> Signed-off-by: Stefano Brivio <sbrivio@redhat.com> 2024-07-05 10:44:08 +00:00			`--inconclusive --library=posix --quiet \`
			`--suppress=missingIncludeSystem \`
			`$(SRCS)`

			`clang-tidy:`
			`clang-tidy --checks=*,\`
			`-altera-id-dependent-backward-branch,\`
			`-altera-unroll-loops,\`
			`-bugprone-easily-swappable-parameters,\`
			`-clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling,\`
			`-concurrency-mt-unsafe,\`
			`-cppcoreguidelines-avoid-non-const-global-variables,\`
			`-cppcoreguidelines-init-variables,\`
			`-cppcoreguidelines-macro-to-enum,\`
			`-google-readability-braces-around-statements,\`
			`-hicpp-braces-around-statements,\`
			`-llvmlibc-restrict-system-libc-headers,\`
			`-misc-include-cleaner,\`
			`-modernize-macro-to-enum,\`
			`-readability-braces-around-statements,\`
			`-readability-identifier-length,\`
			`-readability-isolate-declaration \`
			`$(SRCS)`

			`clean:`
			`rm -f $(TARGETS) .o ~`