LUDOC-276 protocol: Document RPCs for setattr

[doc/protocol.git] / ldlm_cancel.txt

diff --git a/ldlm_cancel.txt b/ldlm_cancel.txt
new file mode 100644 (file)
index 0000000..5c5454f
--- /dev/null
+++ b/ldlm_cancel.txt
@@ -0,0 +1,30 @@
+Command 103: LDLM_CANCEL
+~~~~~~~~~~~~~~~~~~~~~~~~
+[[ldlm-cancel-rpc]]
+
+An RPC that notifies an entity that a requested lock is no longer needed.
+
+.LDLM_CANCEL Generic Packet Structure
+image::ldlm-cancel-generic.png["LDLM_CANCEL Generic Packet Structure",height=100]
+
+//////////////////////////////////////////////////////////////////////
+The ldlm-cancel-generic.png diagram resembles this text
+art:
+
+       LDLM_CANCEL:
+      --request---------------------
+      | ptlrpc_body | ldlm_request |
+      ------------------------------
+      --reply--------
+      | ptlrpc_body |
+      ---------------
+//////////////////////////////////////////////////////////////////////
+
+'ptlrpc_body'::
+RPC descriptor.
+
+'ldlm_request'::
+The request RPC identifies the lock being canceled. Only the first
+'lock_handle' field is used. The rest of the 'ldlm_request' sturcture
+is not used.
+