freebsd-dev/tools/test/README

$FreeBSD$

This directory is for standalone test programs.  For the FreeBSD
Test Suite, which uses Kyua, please see /usr/src/tests/

A test program is one that exercises a particular bit of the system
and either tries to break it or measures its performance.

Please make a subdir per program, and add a brief description to this file.

auxinfo		Return information on page sizes, CPUs, and OS release date.
devrandom	Programs to test /dev/*random.
gpioevents	Test delivery of gpio pin-change events to userland.
hwpmc		Automatically trigger every event in hwpmc(4).
iconv		Character set conversion tests.
malloc		A program to test and benchmark malloc().
net		A set of generic test programs for networking.
netfibs		Programs to test multi-FIB network stacks.
posixshm	A program to test POSIX shared memory.
ppsapi		Test 1 Pulse Per Second (1PPS) input for time control.
pthread_vfork	Check that vfork and pthreads work together.
ptrace		Verify that ptrace works with syscalls, vfork etc.
sort		Tests for the sort command, including a full regression.
stress2		Kernel stress tool.
testfloat	Programs to test floating-point implementations
upsdl		Test of mmap functionality.
Add $FreeBSD$. Describe the other two directories in here. 2001-10-08 12:28:31 +00:00			$FreeBSD$

Fix spelling and grammer in tools/test/README. Reviewed by: gnn 2015-10-28 15:00:21 +00:00			`This directory is for standalone test programs. For the FreeBSD`
Update the README to describe all the current tests in this directory. 2015-10-28 03:39:18 +00:00			`Test Suite, which uses Kyua, please see /usr/src/tests/`
README reads: This directory is for test programs. A test program is one that will excercise a particular bit of the system and try to break it and/or measuring performance on it. Please make a subdir per program, and add a brief description to this file. 1995-10-15 11:27:49 +00:00
Update the README to describe all the current tests in this directory. 2015-10-28 03:39:18 +00:00			`A test program is one that exercises a particular bit of the system`
			`and either tries to break it or measures its performance.`
README reads: This directory is for test programs. A test program is one that will excercise a particular bit of the system and try to break it and/or measuring performance on it. Please make a subdir per program, and add a brief description to this file. 1995-10-15 11:27:49 +00:00
			`Please make a subdir per program, and add a brief description to this file.`
malloc.c A program to benchmark and test malloc. 1995-10-15 12:29:12 +00:00
Update the README to describe all the current tests in this directory. 2015-10-28 03:39:18 +00:00			`auxinfo Return information on page sizes, CPUs, and OS release date.`
Add $FreeBSD$. Describe the other two directories in here. 2001-10-08 12:28:31 +00:00			`devrandom Programs to test /dev/*random.`
Provide userland notification of gpio pin changes ("userland gpio interrupts"). This is an import of the Google Summer of Code 2018 project completed by Christian Kramer (and, sadly, ignored by us for two years now). The goals stated for that project were: FreeBSD already has support for interrupts implemented in the GPIO controller drivers of several SoCs, but there are no interfaces to take advantage of them out of user space yet. The goal of this work is to implement such an interface by providing descriptors which integrate with the common I/O system calls and multiplexing mechanisms. The initial imported code supports the following functionality: - A kernel driver that provides an interface to the user space; the existing gpioc(4) driver was enhanced with this functionality. - Implement support for the most common I/O system calls / multiplexing mechanisms: - read() Places the pin number on which the interrupt occurred in the buffer. Blocking and non-blocking behaviour supported. - poll()/select() - kqueue() - signal driven I/O. Posting SIGIO when the O_ASYNC was set. - Many-to-many relationship between pins and file descriptors. - A file descriptor can monitor several GPIO pins. - A GPIO pin can be monitored by multiple file descriptors. - Integration with gpioctl and libgpio. I added some fixes (mostly to locking) and feature enhancements on top of the original gsoc code. The feature ehancements allow the user to choose between detailed and summary event reporting. Detailed reporting provides a record describing each pin change event. Summary reporting provides the time of the first and last change of each pin, and a count of how many times it changed state since the last read(2) call. Another enhancement allows the recording of multiple state change events on multiple pins between each call to read(2) (the original code would track only a single event at a time). The phabricator review for these changes timed out without approval, but I cite it below anyway, because the review contains a series of diffs that show how I evolved the code from its original state in Christian's github repo for the gsoc project to what is being commited here. (In effect, the phab review extends the VC history back to the original code.) Submitted by: Christian Kramer Obtained from: https://github.com/ckraemer/freebsd/tree/gsoc2018 Differential Revision: https://reviews.freebsd.org/D27398 2020-12-12 18:34:15 +00:00			`gpioevents Test delivery of gpio pin-change events to userland.`
Update the README to describe all the current tests in this directory. 2015-10-28 03:39:18 +00:00			`hwpmc Automatically trigger every event in hwpmc(4).`
			`iconv Character set conversion tests.`
malloc.c A program to benchmark and test malloc. 1995-10-15 12:29:12 +00:00			`malloc A program to test and benchmark malloc().`
Update the README to describe all the current tests in this directory. 2015-10-28 03:39:18 +00:00			`net A set of generic test programs for networking.`
Add regression tests scripts for multi-IP FIBs exercising the send, receive and forward path tagging packets with both the ifconfig fib option or using ipfw, running ICMP6, TCP/v6 and UDP/v6 tests and testing both setfib(2) as well as the SO_SETFIB socket option. At 16 FIBs a total of over 64k return codes/replies/stati are checked, sometimes multiple times (in different ways, e.g. the reflected request as well as ipfw counter values). The scripts need two or three machines to run and are thus not added to the tools/regression framework but only to tools/test. Sponsored by: Cisco Systems, Inc. 2012-02-17 04:26:24 +00:00			`netfibs Programs to test multi-FIB network stacks.`
Add $FreeBSD$. Describe the other two directories in here. 2001-10-08 12:28:31 +00:00			`posixshm A program to test POSIX shared memory.`
Update the README to describe all the current tests in this directory. 2015-10-28 03:39:18 +00:00			`ppsapi Test 1 Pulse Per Second (1PPS) input for time control.`
Fix spelling and grammer in tools/test/README. Reviewed by: gnn 2015-10-28 15:00:21 +00:00			`pthread_vfork Check that vfork and pthreads work together.`
Update the README to describe all the current tests in this directory. 2015-10-28 03:39:18 +00:00			`ptrace Verify that ptrace works with syscalls, vfork etc.`
			`sort Tests for the sort command, including a full regression.`
stress2: Initial import Discussed with: kib 2021-03-03 12:56:56 +00:00			`stress2 Kernel stress tool.`
Add a TestFloat based test suite for floating-point implementations currently supporting sparc64. After a `make depend all` there are three programs; testsoftfloat for testing against the SoftFloat in src/lib/libc/softfloat for reference purposes, testemufloat for testing the emulator source in src/lib/libc/sparc64/fpu and testfloat for testing with the installed libc. Support for other architectures can be added as needed. PR: 144900 Submitted by: Peter Jeremy 2010-04-24 12:11:41 +00:00			`testfloat Programs to test floating-point implementations`
Fix spelling and grammer in tools/test/README. Reviewed by: gnn 2015-10-28 15:00:21 +00:00			`upsdl Test of mmap functionality.`