Documentation/admin-guide/nfs/fault_injection.rst

   1 ===================
   2 NFS Fault Injection
   3 ===================
   4
   5 Fault injection is a method for forcing errors that may not normally occur, or
   6 may be difficult to reproduce.  Forcing these errors in a controlled environment
   7 can help the developer find and fix bugs before their code is shipped in a
   8 production system.  Injecting an error on the Linux NFS server will allow us to
   9 observe how the client reacts and if it manages to recover its state correctly.
  10
  11 NFSD_FAULT_INJECTION must be selected when configuring the kernel to use this
  12 feature.
  13
  14
  15 Using Fault Injection
  16 =====================
  17 On the client, mount the fault injection server through NFS v4.0+ and do some
  18 work over NFS (open files, take locks, ...).
  19
  20 On the server, mount the debugfs filesystem to <debug_dir> and ls
  21 <debug_dir>/nfsd.  This will show a list of files that will be used for
  22 injecting faults on the NFS server.  As root, write a number n to the file
  23 corresponding to the action you want the server to take.  The server will then
  24 process the first n items it finds.  So if you want to forget 5 locks, echo '5'
  25 to <debug_dir>/nfsd/forget_locks.  A value of 0 will tell the server to forget
  26 all corresponding items.  A log message will be created containing the number
  27 of items forgotten (check dmesg).
  28
  29 Go back to work on the client and check if the client recovered from the error
  30 correctly.
  31
  32
  33 Available Faults
  34 ================
  35 forget_clients:
  36      The NFS server keeps a list of clients that have placed a mount call.  If
  37      this list is cleared, the server will have no knowledge of who the client
  38      is, forcing the client to reauthenticate with the server.
  39
  40 forget_openowners:
  41      The NFS server keeps a list of what files are currently opened and who
  42      they were opened by.  Clearing this list will force the client to reopen
  43      its files.
  44
  45 forget_locks:
  46      The NFS server keeps a list of what files are currently locked in the VFS.
  47      Clearing this list will force the client to reclaim its locks (files are
  48      unlocked through the VFS as they are cleared from this list).
  49
  50 forget_delegations:
  51      A delegation is used to assure the client that a file, or part of a file,
  52      has not changed since the delegation was awarded.  Clearing this list will
  53      force the client to reacquire its delegation before accessing the file
  54      again.
  55
  56 recall_delegations:
  57      Delegations can be recalled by the server when another client attempts to
  58      access a file.  This test will notify the client that its delegation has
  59      been revoked, forcing the client to reacquire the delegation before using
  60      the file again.
  61
  62
  63 tools/nfs/inject_faults.sh script
  64 =================================
  65 This script has been created to ease the fault injection process.  This script
  66 will detect the mounted debugfs directory and write to the files located there
  67 based on the arguments passed by the user.  For example, running
  68 `inject_faults.sh forget_locks 1` as root will instruct the server to forget
  69 one lock.  Running `inject_faults forget_locks` will instruct the server to
  70 forgetall locks.