basement/README

   1 ptlrpc.txt is a beginning effort to document the precise structure of
   2 PtlRPC messages including all fields and their meanings. For now it
   3 has some general discussion and details about the message header and
   4 the ptlrpc_body_v3 structures. It will eventually include all the
   5 structures.
   6
   7 request_message_pairs.txt lists the 94 named message pairs and the
   8 names of the message format for each of the two messages in the
   9 pair. The first in the pair is a request to be sent in a request-reply
  10 communication model. The second is the reply appropriate to the
  11 request.
  12
  13 message_formats.txt lists the 95 named message formats along with the
  14 list of structures that constitue each. There is also an initial
  15 discussion of what the message formats are and how they relate to
  16 PtlRPC request message pairs.
  17
  18 structures.txt lists the 69 symbols (RMF_*) used to denote the
  19 sequence of structures in the defnition of the message formats. The
  20 file just associates the symbolic name used in the message format
  21 defnition with the actual 'struct <name>' that defines its sequence of
  22 fields. In some cases there is no struct associated with the RMF_
  23 symbol. In those cases the associated bytes, if any, will have to have
  24 their sematics explained directly.
  25
  26 struct_defs.txt details the fields in each of the structures named in
  27 the structures.txt list along with the sematics for each field. The
  28 special structure for the message header is included here.
  29
  30
  31