17797b06916161acad916f232ae86edea30ce334
[xfstests-dev.git] / doc / auxiliary-programs.txt
1                         ==============================
2                         AUXILIARY PROGRAMS FOR TESTING
3                         ==============================
4
5 Not everything a test script can do is easily done within a test script;
6 sometimes it makes a lot more sense to write auxiliary program in C and have
7 the test script call them.  Auxiliary commands can be found in the src/
8 directory and in other packages.
9
10 Tests wanting to use an auxiliary program found in the src/ directory should
11 note the dependency with:
12
13         _require_test_program "<program-name>"
14
15
16 Contents:
17
18  - af_unix      -- Create an AF_UNIX socket
19  - stat_test    -- statx syscall exercise
20  - xfs_io       -- General I/O operation exercise
21
22
23 ==================
24 QUICK DESCRIPTIONS
25 ==================
26
27 af_unix
28
29         The af_unix program creates an AF_UNIX socket at the given location.
30
31 stat_test
32
33         The stat_test program is primarily designed to exercise the statx()
34         system call.  It can check statx() against fstatat() and it can
35         compare and check various file attributes.
36
37         See also:
38                 _require_statx
39
40
41 xfs_io
42
43         The xfs_io program can be found in the xfsprogs package and can be used
44         to perform sequences of I/O commands, though it is limited to what it
45         can do on open files.
46
47         xfs_io is a debugging tool that is aimed at examining regular file I/O
48         paths rather than a raw XFS volume itself.  These code paths include
49         not only the obvious read/write/mmap interfaces for manipulating files,
50         but also cover all of the XFS extensions (such as space preallocation,
51         additional inode flags, etc).
52
53         Most of its commands can also be used with other filesystems.
54
55         See also:
56                 _require_xfs_io_command