summaryrefslogtreecommitdiffstats
path: root/src/spdk/test/app/fuzz/iscsi_fuzz/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/spdk/test/app/fuzz/iscsi_fuzz/README.md')
-rw-r--r--src/spdk/test/app/fuzz/iscsi_fuzz/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/src/spdk/test/app/fuzz/iscsi_fuzz/README.md b/src/spdk/test/app/fuzz/iscsi_fuzz/README.md
new file mode 100644
index 000000000..c9ef02e6a
--- /dev/null
+++ b/src/spdk/test/app/fuzz/iscsi_fuzz/README.md
@@ -0,0 +1,27 @@
+# Overview
+
+This application is intended to fuzz test the iSCSI target by submitting
+randomized PDU commands through a simulated iSCSI initiator.
+
+# Input
+
+1. iSCSI initiator send a login request PDU to iSCSI Target. Once a session is connected,
+2. iSCSI initiator send huge amount and random PDUs continuously to iSCSI Target.
+3. iSCSI initiator send a logout request PDU to iSCSI Target in the end.
+Especially, iSCSI initiator need to build different bhs according to different bhs opcode.
+Then iSCSI initiator will receive all kinds of responsed opcodes from iSCSI Target.
+The application will terminate when run time expires (see the -t flag).
+
+# Output
+
+By default, the fuzzer will print commands that:
+1. Complete successfully back from the target, or
+2. Are outstanding at the time of a connection error occurs.
+Commands are dumped as named objects in json format which can then be supplied back to the
+script for targeted debugging on a subsequent run.
+
+At the end of each test run, a summary is printed in the following format:
+
+~~~
+device 0x11c3b90 stats: Sent 1543 valid opcode PDUs, 16215 invalid opcode PDUs.
+~~~