Whamcloud - gitweb
LUDOC-297 protocol: Update protocol document
[doc/protocol.git] / ost_statfs.txt
1 RPC 13: OST_STATFS
2 ~~~~~~~~~~~~~~~~~~
3 [[ost-statfs-rpc]]
4
5 OST_STATFS is an RPC that queries data about the underlying file
6 system for a given OST.
7
8 The OST_STATFS request message is a so-called "empty" message in that
9 it only has a buffer for the 'ptlrpc_body' with the 'pb_opc' value
10 OST_STATFS (13).
11
12 The reply message conveys 'statfs' data when it succeeds, and an error
13 code if it doesn't.
14
15 .OST_STATFS Request Packet Structure
16 image::ost-statfs-request.png["OST_STATFS Request Packet Structure",height=50]
17
18 //////////////////////////////////////////////////////////////////////
19 The ost-statfs-request.png diagram resembles this text art:
20
21        OST_STATFS:
22       --request------
23       | ptlrpc_body |
24       ---------------
25 //////////////////////////////////////////////////////////////////////
26
27 'ptlrpc_body'::
28 RPC descriptor. See <<struct-ptlrpc-body>>.
29
30 .OST_STATFS Reply Packet Structure
31 image::ost-statfs-reply.png["OST_STATFS Reply Packet Structure",height=50]
32
33 //////////////////////////////////////////////////////////////////////
34 The ost-statfs-reply.png diagram resembles this text art:
35
36        OST_STATFS:
37       --reply---------------------
38       | ptlrpc_body | obd_statfs |
39       ----------------------------
40 //////////////////////////////////////////////////////////////////////
41
42 'ptlrpc_body'::
43 RPC descriptor. See <<struct-ptlrpc-body>>.
44
45 include::struct_obd_statfs.txt[]
46