Whamcloud - gitweb
LUDOC-276 protocol: Document RPCs for setattr 52/14852/9
authorAndrew C. Uselton <andrew.c.uselton@intel.com>
Mon, 18 May 2015 21:51:12 +0000 (14:51 -0700)
committerAndrew Uselton <andrew.c.uselton@intel.com>
Wed, 10 Jun 2015 23:48:39 +0000 (23:48 +0000)
commitf7539c5d000a6cce00dd20959e071892011561dc
tree45be24eb7775d2d21061bbd7373215d9afdc9542
parentbf7b5e539e54a7272a6ad235a662d3ff86fe6e22
LUDOC-276 protocol: Document RPCs for setattr

[2015-06-09]
After Jinshan's second pass:

Section 7.1, page 36-37
  Added description of lov_mds_md

Section 13.12, page 51
Command 101: LDLM_ENQUEUE - Enqueue a loack request
  Lock Value Block discussion

Section 13.13, page 51
Command 1034: LDLM_CANCEL - Cancel a lock request
  Added the new discussion of the LDLM_CANCEL.

Section 14.4, page 64-68
  Updated the discussion of the 'setattr' for a 'truncate' with the
  details about the LDLM_CANCEL. Updated figures.

[2015-06-04]
Updates addressing Doug's comments. In particular, clarify how the
MDS_REINT structs are organized, and the constraints placed on the
interpretation of their fields in order to accommodate swabbing
correctly. Also, break the 'mdt_body' struct out into its own section,
in 'mdt_structs.txt', so that it does not seem to be another variant
of the 'mds_rec_reint'. Fix a minor markup issue in
'ost_setattr_structs.txt'.

[2015-05-31]
First round update in response to review:
Especially addressing defects in 'setattr.txt'.

Figures and text discuss RPCs that implement 'setattr'. There is a new
top-level file called 'extract_setattr.txt' that include just the new
content. It can be compiled with

  asciidoc extract_setattr.txt

for the HTML, and

  a2x -f pdf --fop extract_setattr.txt

for the PDF. The extract_setattr.pdf that results is also organized in
a more top-down fashion than the 'protocol.pdf'. We are still
considering which oreder of presentation (versus bottom-up) is
preferable. The figures each involves one of two kinds of thing:
either a UML-style sequence diagram (files ending in '_rpcs.png'), or
an RPC packet structure diagram.

The previously existing files data_types.txt,
file_system_operations.txt, ldlm.txt, lustre_messages.txt,
lustre_operations.txt, and protocol.txt all had very minor edits that
simply bring in the new content in the other files. The one excetion
is that previous content on LDLM has been improved and extended.

The setattr.txt file has the new content discussing 'setattr' in terms
of the RPCs that are exchanged. The remaining new files each
introduces one small piece of the new content relating to one specfic
detail, each.

Signed-off-by: Andrew C. Uselton <andrew.c.uselton@intel.com>
Change-Id: Iace0fc22d77372cb81d2ed9e2baca38327a8dee6
Reviewed-on: http://review.whamcloud.com/14852
Tested-by: Jenkins
Reviewed-by: Jinshan Xiong <jinshan.xiong@intel.com>
70 files changed:
Makefile
data_types.txt
early_lock_cancellation.txt [new file with mode: 0644]
extract.txt [new file with mode: 0644]
extract_setattr.txt [new file with mode: 0644]
figures/chmod_rpcs.fig [new file with mode: 0644]
figures/ldlm-bl-callback-generic.fig [new file with mode: 0644]
figures/ldlm-bl-callback-reply.fig [new file with mode: 0644]
figures/ldlm-bl-callback-request.fig [new file with mode: 0644]
figures/ldlm-cancel-generic.fig [new file with mode: 0644]
figures/ldlm-cancel-reply.fig [new file with mode: 0644]
figures/ldlm-cancel-request.fig [new file with mode: 0644]
figures/ldlm-cp-callback-generic.fig [new file with mode: 0644]
figures/ldlm-cp-callback-reply.fig [new file with mode: 0644]
figures/ldlm-cp-callback-request.fig [new file with mode: 0644]
figures/ldlm-enqueue-extent-lvb-reply.fig [new file with mode: 0644]
figures/ldlm-enqueue-generic.fig [new file with mode: 0644]
figures/ldlm-enqueue-intent-layout-generic.fig [new file with mode: 0644]
figures/ldlm-enqueue-intent-layout-reply.fig [new file with mode: 0644]
figures/ldlm-enqueue-intent-layout-request.fig [new file with mode: 0644]
figures/ldlm-enqueue-reply.fig [new file with mode: 0644]
figures/ldlm-enqueue-request.fig [new file with mode: 0644]
figures/mds-getxattr-generic.fig [new file with mode: 0644]
figures/mds-getxattr-reply.fig [new file with mode: 0644]
figures/mds-getxattr-request.fig [new file with mode: 0644]
figures/mds-reint-setattr-gene.fig [new file with mode: 0644]
figures/mds-reint-setattr-generic.fig [new file with mode: 0644]
figures/mds-reint-setattr-reply.fig [new file with mode: 0644]
figures/mds-reint-setattr-request.fig [new file with mode: 0644]
figures/ost-punch-generic.fig [new file with mode: 0644]
figures/ost-punch-reply.fig [new file with mode: 0644]
figures/ost-punch-request.fig [new file with mode: 0644]
figures/ost-setattr-generic.fig [new file with mode: 0644]
figures/ost-setattr-reply.fig [new file with mode: 0644]
figures/ost-setattr-request.fig [new file with mode: 0644]
figures/setattr_rpcs.fig [new file with mode: 0644]
figures/touch_rpcs.fig [new file with mode: 0644]
figures/truncate_rpcs.fig [new file with mode: 0644]
file_system_operations.txt
layout_intent.txt [new file with mode: 0644]
ldlm.txt
ldlm_bl_callback.txt [new file with mode: 0644]
ldlm_cancel.txt [new file with mode: 0644]
ldlm_cp_callback.txt [new file with mode: 0644]
ldlm_enqueue.txt [new file with mode: 0644]
ldlm_intent.txt [new file with mode: 0644]
ldlm_lock_desc.txt [new file with mode: 0644]
ldlm_reply.txt [new file with mode: 0644]
ldlm_request.txt [new file with mode: 0644]
ldlm_resource_desc.txt [new file with mode: 0644]
ldlm_resource_id.txt [new file with mode: 0644]
lov_mds_md.txt [new file with mode: 0644]
lustre_file_ids.txt [new file with mode: 0644]
lustre_handle.txt [new file with mode: 0644]
lustre_messages.txt
lustre_operations.txt
mds_getxattr.txt [new file with mode: 0644]
mds_reint.txt [new file with mode: 0644]
mds_reint_structs.txt [new file with mode: 0644]
mdt_body.txt [new file with mode: 0644]
mdt_rec_reint.txt [new file with mode: 0644]
mdt_rec_setattr.txt [new file with mode: 0644]
mdt_structs.txt [new file with mode: 0644]
ost_lvb.txt [new file with mode: 0644]
ost_punch.txt [new file with mode: 0644]
ost_setattr.txt [new file with mode: 0644]
ost_setattr_structs.txt [new file with mode: 0644]
protocol.txt
setattr.txt [new file with mode: 0644]
setattr_terms.txt [new file with mode: 0644]