Whamcloud - gitweb
LUDOC-296 protocol: Reorganize the document ot be top-down
[doc/protocol.git] / ost_setattr_structs.txt
1 OST_SETATTR Structures
2 ~~~~~~~~~~~~~~~~~~~~~~
3 [[ost-setattr]]
4
5 OST Body
6 ^^^^^^^^
7 [[struct-ost-body]]
8
9 The 'ost_body' structure just hold a 'struct 'obdo', which is where
10 all the actual information is conveyed.
11
12 ----
13 struct ost_body {
14         struct  obdo oa;
15 };
16 ----
17
18 Obdo
19 ^^^^
20 [[struct-obdo]]
21
22 The 'obdo' structure conveys metadata about a resource on an OST.
23
24 ----
25 struct obdo {
26         __u64                   o_valid;
27         struct ost_id           o_oi; /* OBD_MD_FLID */
28         __u64                   o_parent_seq; /* OBD_MD_FLFID */
29         __u64                   o_size; /* OBD_MD_FLSIZE */
30         __s64                   o_mtime; /* OBD_MD_FLMTIME */
31         __s64                   o_atime; /* OBD_MD_FLMTIME */
32         __s64                   o_ctime; /* OBD_MD_FLCTIME */
33         __u64                   o_blocks; /* OBD_MD_FLBLOCKS */
34         __u64                   o_grant; /* OBD_MD_FLGRANT */
35         __u32                   o_blksize; /* OBD_MD_FLBLKSZ */
36         __u32                   o_mode; /* OBD_MD_FLMODE */
37         __u32                   o_uid; /* OBD_MD_FLUID */
38         __u32                   o_gid; /* OBD_MD_FLGID */
39         __u32                   o_flags; /* OBD_MD_FLFLAGS */
40         __u32                   o_nlink; /* OBD_MD_FLNLINK */
41         __u32                   o_parent_oid;
42         __u32                   o_misc;
43         __u64                   o_ioepoch; /* OBD_MD_ */
44         __u32                   o_stripe_idx;
45         __u32                   o_parent_ver; /* OBD_MD_FLFID */
46         struct lustre_handle    o_handle; /* OBD_MD_FLHANDLE */
47         struct llog_cookie      o_lcookie; /* OBD_MD_FLCOOKIE */
48         __u32                   o_uid_h;
49         __u32                   o_gid_h;
50         __u64                   o_data_version; /* OBD_MD_FLDATAVERSION */
51         __u64                   o_padding_4;
52         __u64                   o_padding_5;
53         __u64                   o_padding_6;
54 };
55 ----
56
57 The 'o_valid' field identifies which other fields in the structure are
58 to be interpreted. The flags are the same set (with additions) used
59 for the 'mdt_body' field 'mbo_valid' (see <<struct-mdt-body>>).
60
61 ----
62 #define OBD_MD_FLID        (0x00000001ULL)
63 #define OBD_MD_FLATIME     (0x00000002ULL)
64 #define OBD_MD_FLMTIME     (0x00000004ULL)
65 #define OBD_MD_FLCTIME     (0x00000008ULL)
66 #define OBD_MD_FLSIZE      (0x00000010ULL)
67 #define OBD_MD_FLBLOCKS    (0x00000020ULL)
68 #define OBD_MD_FLBLKSZ     (0x00000040ULL)
69 #define OBD_MD_FLMODE      (0x00000080ULL)
70 #define OBD_MD_FLTYPE      (0x00000100ULL)
71 #define OBD_MD_FLUID       (0x00000200ULL)
72 #define OBD_MD_FLGID       (0x00000400ULL)
73 #define OBD_MD_FLFLAGS     (0x00000800ULL)
74 #define OBD_MD_FLNLINK     (0x00002000ULL)
75 #define OBD_MD_FLGENER     (0x00004000ULL)
76 /*#define OBD_MD_FLINLINE    (0x00008000ULL)
77 #define OBD_MD_FLRDEV      (0x00010000ULL)
78 #define OBD_MD_FLEASIZE    (0x00020000ULL)
79 #define OBD_MD_LINKNAME    (0x00040000ULL)
80 #define OBD_MD_FLHANDLE    (0x00080000ULL)
81 #define OBD_MD_FLCKSUM     (0x00100000ULL)
82 #define OBD_MD_FLQOS       (0x00200000ULL)
83 /*#define OBD_MD_FLOSCOPQ    (0x00400000ULL)
84 #define OBD_MD_FLCOOKIE    (0x00800000ULL)
85 #define OBD_MD_FLGROUP     (0x01000000ULL)
86 #define OBD_MD_FLFID       (0x02000000ULL)
87 #define OBD_MD_FLEPOCH     (0x04000000ULL)
88 #define OBD_MD_FLGRANT     (0x08000000ULL)
89 #define OBD_MD_FLDIREA     (0x10000000ULL)
90 #define OBD_MD_FLUSRQUOTA  (0x20000000ULL)
91 #define OBD_MD_FLGRPQUOTA  (0x40000000ULL)
92 #define OBD_MD_FLMODEASIZE (0x80000000ULL)
93 #define OBD_MD_MDS         (0x0000000100000000ULL)
94 #define OBD_MD_REINT       (0x0000000200000000ULL)
95 #define OBD_MD_MEA         (0x0000000400000000ULL)
96 #define OBD_MD_TSTATE      (0x0000000800000000ULL)
97 #define OBD_MD_FLXATTR       (0x0000001000000000ULL)
98 #define OBD_MD_FLXATTRLS     (0x0000002000000000ULL)
99 #define OBD_MD_FLXATTRRM     (0x0000004000000000ULL)
100 #define OBD_MD_FLACL         (0x0000008000000000ULL)
101 #define OBD_MD_FLRMTPERM     (0x0000010000000000ULL)
102 #define OBD_MD_FLMDSCAPA     (0x0000020000000000ULL)
103 #define OBD_MD_FLOSSCAPA     (0x0000040000000000ULL)
104 #define OBD_MD_FLCKSPLIT     (0x0000080000000000ULL)
105 #define OBD_MD_FLCROSSREF    (0x0000100000000000ULL)
106 #define OBD_MD_FLGETATTRLOCK (0x0000200000000000ULL)
107 #define OBD_MD_FLOBJCOUNT    (0x0000400000000000ULL)
108 #define OBD_MD_FLRMTLSETFACL (0x0001000000000000ULL)
109 #define OBD_MD_FLRMTLGETFACL (0x0002000000000000ULL)
110 #define OBD_MD_FLRMTRSETFACL (0x0004000000000000ULL)
111 #define OBD_MD_FLRMTRGETFACL (0x0008000000000000ULL)
112 #define OBD_MD_FLDATAVERSION (0x0010000000000000ULL)
113 #define OBD_MD_FLRELEASED    (0x0020000000000000ULL)
114 #define OBD_MD_DEFAULT_MEA   (0x0040000000000000ULL)
115 ----
116
117 The two fields here that are specific to the 'ost_body' case are the
118 'o_oi' and the 'o_stripe_idx', which give the identity of the OST and
119 the stripe index assigned to it.
120
121 OST ID
122 ^^^^^^
123 [[struct-ost-id]]
124
125 The 'ost_id' identifies an object on a particular OST.
126
127 ----
128 struct ost_id {
129         union {
130                 struct {
131                         __u64   oi_id;
132                         __u64   oi_seq;
133                 } oi;
134                 struct lu_fid oi_fid;
135         };
136 };
137 ----
138