sysfs-class-rtrs-client 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134
  1. What: /sys/class/rtrs-client
  2. Date: Feb 2020
  3. KernelVersion: 5.7
  4. Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  5. Description: When a user of RTRS API creates a new session, a directory entry with
  6. the name of that session is created under /sys/class/rtrs-client/<session-name>/
  7. What: /sys/class/rtrs-client/<session-name>/add_path
  8. Date: Feb 2020
  9. KernelVersion: 5.7
  10. Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  11. Description: RW, adds a new path (connection) to an existing session. Expected format is the
  12. following::
  13. <[source addr,]destination addr>
  14. *addr ::= [ ip:<ipv4|ipv6> | gid:<gid> ]
  15. What: /sys/class/rtrs-client/<session-name>/max_reconnect_attempts
  16. Date: Feb 2020
  17. KernelVersion: 5.7
  18. Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  19. Description: Maximum number reconnect attempts the client should make before giving up
  20. after connection breaks unexpectedly.
  21. What: /sys/class/rtrs-client/<session-name>/mp_policy
  22. Date: Feb 2020
  23. KernelVersion: 5.7
  24. Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  25. Description: Multipath policy specifies which path should be selected on each IO:
  26. round-robin (0):
  27. select path in per CPU round-robin manner.
  28. min-inflight (1):
  29. select path with minimum inflights.
  30. What: /sys/class/rtrs-client/<session-name>/paths/
  31. Date: Feb 2020
  32. KernelVersion: 5.7
  33. Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  34. Description: Each path belonging to a given session is listed here by its source and
  35. destination address. When a new path is added to a session by writing to
  36. the "add_path" entry, a directory <src@dst> is created.
  37. What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/state
  38. Date: Feb 2020
  39. KernelVersion: 5.7
  40. Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  41. Description: RO, Contains "connected" if the session is connected to the peer and fully
  42. functional. Otherwise the file contains "disconnected"
  43. What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/reconnect
  44. Date: Feb 2020
  45. KernelVersion: 5.7
  46. Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  47. Description: Write "1" to the file in order to reconnect the path.
  48. Operation is blocking and returns 0 if reconnect was successful.
  49. What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/disconnect
  50. Date: Feb 2020
  51. KernelVersion: 5.7
  52. Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  53. Description: Write "1" to the file in order to disconnect the path.
  54. Operation blocks until RTRS path is disconnected.
  55. What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/remove_path
  56. Date: Feb 2020
  57. KernelVersion: 5.7
  58. Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  59. Description: Write "1" to the file in order to disconnected and remove the path
  60. from the session. Operation blocks until the path is disconnected
  61. and removed from the session.
  62. What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/hca_name
  63. Date: Feb 2020
  64. KernelVersion: 5.7
  65. Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  66. Description: RO, Contains the the name of HCA the connection established on.
  67. What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/hca_port
  68. Date: Feb 2020
  69. KernelVersion: 5.7
  70. Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  71. Description: RO, Contains the port number of active port traffic is going through.
  72. What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/src_addr
  73. Date: Feb 2020
  74. KernelVersion: 5.7
  75. Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  76. Description: RO, Contains the source address of the path
  77. What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/dst_addr
  78. Date: Feb 2020
  79. KernelVersion: 5.7
  80. Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  81. Description: RO, Contains the destination address of the path
  82. What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/stats/reset_all
  83. Date: Feb 2020
  84. KernelVersion: 5.7
  85. Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  86. Description: RW, Read will return usage help, write 0 will clear all the statistics.
  87. What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/stats/cpu_migration
  88. Date: Feb 2020
  89. KernelVersion: 5.7
  90. Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  91. Description: RTRS expects that each HCA IRQ is pinned to a separate CPU. If it's
  92. not the case, the processing of an I/O response could be processed on a
  93. different CPU than where it was originally submitted. This file shows
  94. how many interrupts where generated on a non expected CPU.
  95. "from:"
  96. is the CPU on which the IRQ was expected, but not generated.
  97. "to:"
  98. is the CPU on which the IRQ was generated, but not expected.
  99. What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/stats/reconnects
  100. Date: Feb 2020
  101. KernelVersion: 5.7
  102. Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  103. Description: Contains 2 unsigned int values, the first one records number of successful
  104. reconnects in the path lifetime, the second one records number of failed
  105. reconnects in the path lifetime.
  106. What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/stats/rdma
  107. Date: Feb 2020
  108. KernelVersion: 5.7
  109. Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  110. Description: Contains statistics regarding rdma operations and inflight operations.
  111. The output consists of 6 values::
  112. <read-count> <read-total-size> <write-count> \
  113. <write-total-size> <inflights> <failovered>