LUDOC-296 protocol: Reorganize the document ot be top-down

[doc/protocol.git] / lustre_rpcs.txt

diff --git a/lustre_rpcs.txt b/lustre_rpcs.txt
new file mode 100644 (file)
index 0000000..c13df8f
--- /dev/null
+++ b/lustre_rpcs.txt
@@ -0,0 +1,75 @@
+Lustre RPCs
+-----------
+[[lustre-rpcs]]
+
+Lustre operations are denoted by the 'pb_opc' op-code field of the
+RPC descriptor. Each operation is implemented as a pair of messages,
+with the 'pb_type' field set to PTLRPC_MSG_REQUEST for requests
+initiating the operation, and PTLRPC_MSG_REPLY for replies. Note that
+as a general matter, the receipt by a client of the reply message only
+assures the client hat the server has initiated the action, if
+any. See the discussion on <<transno,transaction numbers>>
+and <<recovery>> for how the client is given confirmation that a
+request has been completed.
+
+include::ost_setattr.txt[]
+
+include::ost_connect.txt[]
+
+include::ost_disconnect.txt[]
+
+include::ost_punch.txt[]
+
+include::ost_statfs.txt[]
+
+include::mds_getattr.txt[]
+
+include::mds_reint.txt[]
+
+include::mds_connect.txt[]
+
+include::mds_disconnect.txt[]
+
+include::mds_getstatus.txt[]
+
+include::mds_statfs.txt[]
+
+include::mds_getxattr.txt[]
+
+include::ldlm_enqueue.txt[]
+
+include::ldlm_cancel.txt[]
+
+include::ldlm_bl_callback.txt[]
+
+include::ldlm_cp_callback.txt[]
+
+include::ldlm_gl_callback.txt[]
+
+include::mgs_connect.txt[]
+
+include::mgs_disconnect.txt[]
+
+include::mgs_config_read.txt[]
+
+include::llog_origin_handle_create.txt[]
+
+include::llog_origin_handle_next_block.txt[]
+
+include::llog_origin_handle_read_header.txt[]
+
+#################################################################
+Fixme: Move the RPC message sturucture includes to where they
+first gets introduced. In the sections that have the relevant
+operations.
+#################################################################
+
+include::data_types.txt[]
+
+include::mdt_structs.txt[]
+
+include::mds_reint_structs.txt[]
+
+include::ost_setattr_structs.txt[]
+
+include::statfs_structs.txt[]