Whamcloud - gitweb
2a8786f998a62755a29a595b78002bb3e88cf6d1
[fs/lustre-release.git] / lustre / include / lustre / lustre_idl.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  *   This file is part of Lustre, http://www.lustre.org
5  *
6  * Lustre wire protocol definitions.
7  *
8  *
9  * We assume all nodes are either little-endian or big-endian, and we
10  * always send messages in the sender's native format.  The receiver
11  * detects the message format by checking the 'magic' field of the message
12  * (see lustre_msg_swabbed() below).
13  * ALL structs passing over the wire should be declared here.  Structs
14  * that are used in interfaces with userspace should go in lustre_user.h.
15  *
16  * All structs being declared here should be built from simple fixed-size
17  * types (__u8, __u16, __u32, __u64) or be built from other types or
18  * structs also declared in this file.  Similarly, all flags and magic
19  * values in those structs should also be declared here.  This ensures
20  * that the Lustre wire protocol is not influenced by external dependencies.
21  *
22  * The only other acceptable items in this file are VERY SIMPLE accessor
23  * functions to avoid callers grubbing inside the structures, and the
24  * prototypes of the swabber functions for each struct.  Nothing that
25  * depends on external functions or definitions should be in here.
26  *
27  * Structs must be properly aligned to put 64-bit values on an 8-byte
28  * boundary.  Any structs being added here must also be added to
29  * utils/wirecheck.c and "make newwiretest" run to regenerate the
30  * utils/wiretest.c sources.  This allows us to verify that wire structs
31  * have the proper alignment/size on all architectures.
32  *
33  * DO NOT CHANGE any of the structs, flags, values declared here and used
34  * in released Lustre versions.  Some structs may have padding fields that
35  * can be used.  Some structs might allow addition at the end (verify this
36  * in the code to ensure that new/old clients that see this larger struct
37  * do not fail, otherwise you need to implement protocol compatibility).
38  *
39  * Each wire type has corresponding 'lustre_swab_xxxtypexxx()' routines,
40  * implemented either here, inline (trivial implementations) or in
41  * ptlrpc/pack_generic.c.  These 'swabbers' convert the type from "other"
42  * endian, in-place in the message buffer.
43  *
44  * A swabber takes a single pointer argument.  The caller must already have
45  * verified that the length of the message buffer >= sizeof (type).
46  *
47  * For variable length types, a second 'lustre_swab_v_xxxtypexxx()' routine
48  * may be defined that swabs just the variable part, after the caller has
49  * verified that the message buffer is large enough.
50  */
51
52 #ifndef _LUSTRE_IDL_H_
53 #define _LUSTRE_IDL_H_
54
55 #include <libcfs/kp30.h>
56
57 #if defined(__linux__)
58 #include <linux/lustre_types.h>
59 #elif defined(__APPLE__)
60 #include <darwin/lustre_types.h>
61 #elif defined(__WINNT__)
62 #include <winnt/lustre_types.h>
63 #else
64 #error Unsupported operating system.
65 #endif
66
67 /* Defn's shared with user-space. */
68 #include <lustre/lustre_user.h>
69
70 /*
71  *  GENERAL STUFF
72  */
73 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
74  * FOO_REPLY_PORTAL   is for incoming replies on the FOO
75  * FOO_BULK_PORTAL    is for incoming bulk on the FOO
76  */
77
78 #define CONNMGR_REQUEST_PORTAL          1
79 #define CONNMGR_REPLY_PORTAL            2
80 //#define OSC_REQUEST_PORTAL            3
81 #define OSC_REPLY_PORTAL                4
82 //#define OSC_BULK_PORTAL               5
83 #define OST_IO_PORTAL                   6
84 #define OST_CREATE_PORTAL               7
85 #define OST_BULK_PORTAL                 8
86 //#define MDC_REQUEST_PORTAL            9
87 #define MDC_REPLY_PORTAL               10
88 //#define MDC_BULK_PORTAL              11
89 #define MDS_REQUEST_PORTAL             12
90 //#define MDS_REPLY_PORTAL             13
91 #define MDS_BULK_PORTAL                14
92 #define LDLM_CB_REQUEST_PORTAL         15
93 #define LDLM_CB_REPLY_PORTAL           16
94 #define LDLM_CANCEL_REQUEST_PORTAL     17
95 #define LDLM_CANCEL_REPLY_PORTAL       18
96 //#define PTLBD_REQUEST_PORTAL           19
97 //#define PTLBD_REPLY_PORTAL             20
98 //#define PTLBD_BULK_PORTAL              21
99 #define MDS_SETATTR_PORTAL             22
100 #define MDS_READPAGE_PORTAL            23
101 #define MDS_MDS_PORTAL                 24
102
103 #define MGC_REPLY_PORTAL               25
104 #define MGS_REQUEST_PORTAL             26
105 #define MGS_REPLY_PORTAL               27
106 #define OST_REQUEST_PORTAL             28
107 #define FLD_REQUEST_PORTAL             29
108 #define SEQ_METADATA_PORTAL            30
109 #define SEQ_DATA_PORTAL                31
110 #define SEQ_CONTROLLER_PORTAL          32
111
112 #define SVC_KILLED               1
113 #define SVC_EVENT                2
114 #define SVC_SIGNAL               4
115 #define SVC_RUNNING              8
116 #define SVC_STOPPING            16
117 #define SVC_STOPPED             32
118
119 /* packet types */
120 #define PTL_RPC_MSG_REQUEST 4711
121 #define PTL_RPC_MSG_ERR     4712
122 #define PTL_RPC_MSG_REPLY   4713
123
124 /* DON'T use swabbed values of MAGIC as magic! */
125 #define LUSTRE_MSG_MAGIC_V1 0x0BD00BD0
126 #define LUSTRE_MSG_MAGIC_V2 0x0BD00BD3
127
128 #define LUSTRE_MSG_MAGIC_V1_SWABBED 0xD00BD00B
129 #define LUSTRE_MSG_MAGIC_V2_SWABBED 0xD30BD00B
130
131 #define LUSTRE_MSG_MAGIC LUSTRE_MSG_MAGIC_V2
132
133 #define PTLRPC_MSG_VERSION  0x00000003
134 #define LUSTRE_VERSION_MASK 0xffff0000
135 #define LUSTRE_OBD_VERSION  0x00010000
136 #define LUSTRE_MDS_VERSION  0x00020000
137 #define LUSTRE_OST_VERSION  0x00030000
138 #define LUSTRE_DLM_VERSION  0x00040000
139 #define LUSTRE_LOG_VERSION  0x00050000
140 #define LUSTRE_MGS_VERSION  0x00060000
141
142 typedef __u64 mdsno_t;
143 typedef __u64 seqno_t;
144
145 struct lu_range {
146         __u64 lr_start;
147         __u64 lr_end;
148 };
149
150 static inline __u64 range_space(struct lu_range *r)
151 {
152         return r->lr_end - r->lr_start;
153 }
154
155 static inline void range_zero(struct lu_range *r)
156 {
157         r->lr_start = r->lr_end = 0;
158 }
159
160 static inline int range_within(struct lu_range *r,
161                                __u64 s)
162 {
163         return s >= r->lr_start && s < r->lr_end;
164 }
165
166 static inline void range_alloc(struct lu_range *r,
167                                struct lu_range *s,
168                                __u64 w)
169 {
170         r->lr_start = s->lr_start;
171         r->lr_end = s->lr_start + w;
172         s->lr_start += w;
173 }
174
175 static inline int range_is_sane(struct lu_range *r)
176 {
177         return (r->lr_end >= r->lr_start);
178 }
179
180 static inline int range_is_zero(struct lu_range *r)
181 {
182         return (r->lr_start == 0 && r->lr_end == 0);
183 }
184
185 static inline int range_is_exhausted(struct lu_range *r)
186 {
187         return range_space(r) == 0;
188 }
189
190 #define DRANGE "[%#16.16"LPF64"x-%#16.16"LPF64"x]"
191
192 #define PRANGE(range)      \
193         (range)->lr_start, \
194         (range)->lr_end
195
196 struct lu_fid {
197         __u64 f_seq;  /* holds fid sequence. Lustre should support 2 ^ 64
198                        * objects, thus even if one sequence has one object we
199                        * reach this value. */
200         __u32 f_oid;  /* fid number within its sequence. */
201         __u32 f_ver;  /* holds fid version. */
202 };
203
204 /*
205  * fid constants
206  */
207 enum {
208         LUSTRE_ROOT_FID_SEQ  = 1ULL, /* XXX: should go into mkfs. */
209
210         /* initial fid id value */
211         LUSTRE_FID_INIT_OID  = 1UL
212 };
213
214 /* get object sequence */
215 static inline __u64 fid_seq(const struct lu_fid *fid)
216 {
217         return fid->f_seq;
218 }
219
220 /* get object id */
221 static inline __u32 fid_oid(const struct lu_fid *fid)
222 {
223         return fid->f_oid;
224 }
225
226 /* get object version */
227 static inline __u32 fid_ver(const struct lu_fid *fid)
228 {
229         return fid->f_ver;
230 }
231
232 static inline int fid_seq_is_sane(__u64 seq)
233 {
234         return seq != 0;
235 }
236
237 static inline void fid_zero(struct lu_fid *fid)
238 {
239         memset(fid, 0, sizeof(*fid));
240 }
241
242 static inline int fid_is_igif(const struct lu_fid *fid)
243 {
244         return fid_seq(fid) == LUSTRE_ROOT_FID_SEQ;
245 }
246
247 #define DFID "[0x%16.16"LPF64"x/0x%8.8x:0x%8.8x]"
248
249 #define PFID(fid)     \
250         fid_seq(fid), \
251         fid_oid(fid), \
252         fid_ver(fid)
253
254 static inline void fid_cpu_to_le(struct lu_fid *dst, const struct lu_fid *src)
255 {
256         /* check that all fields are converted */
257         CLASSERT(sizeof *src ==
258                  sizeof fid_seq(src) +
259                  sizeof fid_oid(src) + sizeof fid_ver(src));
260         LASSERTF(fid_is_igif(src) || fid_ver(src) == 0, DFID"\n", PFID(src));
261         dst->f_seq = cpu_to_le64(fid_seq(src));
262         dst->f_oid = cpu_to_le32(fid_oid(src));
263         dst->f_ver = cpu_to_le32(fid_ver(src));
264 }
265
266 static inline void fid_le_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
267 {
268         /* check that all fields are converted */
269         CLASSERT(sizeof *src ==
270                  sizeof fid_seq(src) +
271                  sizeof fid_oid(src) + sizeof fid_ver(src));
272         dst->f_seq = le64_to_cpu(fid_seq(src));
273         dst->f_oid = le32_to_cpu(fid_oid(src));
274         dst->f_ver = le32_to_cpu(fid_ver(src));
275         LASSERTF(fid_is_igif(dst) || fid_ver(dst) == 0, DFID"\n", PFID(dst));
276 }
277
278 static inline void fid_cpu_to_be(struct lu_fid *dst, const struct lu_fid *src)
279 {
280         /* check that all fields are converted */
281         CLASSERT(sizeof *src ==
282                  sizeof fid_seq(src) +
283                  sizeof fid_oid(src) + sizeof fid_ver(src));
284         LASSERTF(fid_is_igif(src) || fid_ver(src) == 0, DFID"\n", PFID(src));
285         dst->f_seq = cpu_to_be64(fid_seq(src));
286         dst->f_oid = cpu_to_be32(fid_oid(src));
287         dst->f_ver = cpu_to_be32(fid_ver(src));
288 }
289
290 static inline void fid_be_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
291 {
292         /* check that all fields are converted */
293         CLASSERT(sizeof *src ==
294                  sizeof fid_seq(src) +
295                  sizeof fid_oid(src) + sizeof fid_ver(src));
296         dst->f_seq = be64_to_cpu(fid_seq(src));
297         dst->f_oid = be32_to_cpu(fid_oid(src));
298         dst->f_ver = be32_to_cpu(fid_ver(src));
299         LASSERTF(fid_is_igif(dst) || fid_ver(dst) == 0, DFID"\n", PFID(dst));
300 }
301
302 #ifdef __KERNEL__
303 /*
304  * Storage representation for fids.
305  *
306  * Variable size, first byte contains the length of the whole record.
307  */
308
309 struct lu_fid_pack {
310         char fp_len;
311         char fp_area[sizeof(struct lu_fid)];
312 };
313
314 void fid_pack(struct lu_fid_pack *pack, const struct lu_fid *fid,
315               struct lu_fid *befider);
316 int  fid_unpack(const struct lu_fid_pack *pack, struct lu_fid *fid);
317
318 /* __KERNEL__ */
319 #endif
320
321 static inline int fid_is_sane(const struct lu_fid *fid)
322 {
323         return
324                 fid != NULL &&
325                 ((fid_seq_is_sane(fid_seq(fid)) && fid_oid(fid) != 0
326                                                 && fid_ver(fid) == 0) ||
327                 fid_is_igif(fid));
328 }
329
330 static inline int fid_is_zero(const struct lu_fid *fid)
331 {
332         return fid_seq(fid) == 0 && fid_oid(fid) == 0;
333 }
334
335 extern void lustre_swab_lu_fid(struct lu_fid *fid);
336 extern void lustre_swab_lu_range(struct lu_range *range);
337
338 static inline int lu_fid_eq(const struct lu_fid *f0,
339                             const struct lu_fid *f1)
340 {
341         /* Check that there is no alignment padding. */
342         CLASSERT(sizeof *f0 ==
343                  sizeof f0->f_seq + sizeof f0->f_oid + sizeof f0->f_ver);
344         LASSERTF(fid_is_igif(f0) || fid_ver(f0) == 0, DFID, PFID(f0));
345         LASSERTF(fid_is_igif(f1) || fid_ver(f1) == 0, DFID, PFID(f1));
346         return memcmp(f0, f1, sizeof *f0) == 0;
347 }
348
349 /*
350  * Layout of readdir pages, as transmitted on wire.
351  */
352 struct lu_dirent {
353         struct lu_fid lde_fid;
354         __u32         lde_hash;
355         __u16         lde_reclen;
356         __u16         lde_namelen;
357         char          lde_name[0];
358 };
359
360 struct lu_dirpage {
361         __u32            ldp_hash_start;
362         __u32            ldp_hash_end;
363         __u16            ldp_flags;
364         __u32            ldp_pad0;
365         struct lu_dirent ldp_entries[0];
366 };
367
368 enum lu_dirpage_flags {
369         LDF_EMPTY = 1 << 0
370 };
371
372 static inline struct lu_dirent *lu_dirent_start(struct lu_dirpage *dp)
373 {
374         if (le16_to_cpu(dp->ldp_flags) & LDF_EMPTY)
375                 return NULL;
376         else
377                 return dp->ldp_entries;
378 }
379
380 static inline struct lu_dirent *lu_dirent_next(struct lu_dirent *ent)
381 {
382         struct lu_dirent *next;
383
384         if (le16_to_cpu(ent->lde_reclen) != 0)
385                 next = ((void *)ent) + le16_to_cpu(ent->lde_reclen);
386         else
387                 next = NULL;
388
389         return next;
390 }
391
392 static inline int lu_dirent_size(struct lu_dirent *ent)
393 {
394         if (le16_to_cpu(ent->lde_reclen) == 0) {
395                 return (sizeof(*ent) +
396                         le16_to_cpu(ent->lde_namelen) + 3) & ~3;
397         }
398         return le16_to_cpu(ent->lde_reclen);
399 }
400
401 #define DIR_END_OFF              0xfffffffeUL
402
403 struct lustre_handle {
404         __u64 cookie;
405 };
406 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
407
408 static inline int lustre_handle_is_used(struct lustre_handle *lh)
409 {
410         return lh->cookie != 0ull;
411 }
412
413 static inline int lustre_handle_equal(struct lustre_handle *lh1,
414                                       struct lustre_handle *lh2)
415 {
416         return lh1->cookie == lh2->cookie;
417 }
418
419 static inline void lustre_handle_copy(struct lustre_handle *tgt,
420                                       struct lustre_handle *src)
421 {
422         tgt->cookie = src->cookie;
423 }
424
425 /* we depend on this structure to be 8-byte aligned */
426 /* this type is only endian-adjusted in lustre_unpack_msg() */
427 struct lustre_msg_v1 {
428         struct lustre_handle lm_handle;
429         __u32 lm_magic;
430         __u32 lm_type;
431         __u32 lm_version;
432         __u32 lm_opc;
433         __u64 lm_last_xid;
434         __u64 lm_last_committed;
435         __u64 lm_transno;
436         __u32 lm_status;
437         __u32 lm_flags;
438         __u32 lm_conn_cnt;
439         __u32 lm_bufcount;
440         __u32 lm_buflens[0];
441 };
442
443 #define lustre_msg lustre_msg_v2
444 /* we depend on this structure to be 8-byte aligned */
445 /* this type is only endian-adjusted in lustre_unpack_msg() */
446 struct lustre_msg_v2 {
447         __u32 lm_bufcount;
448         __u32 lm_secflvr;
449         __u32 lm_magic;
450         __u32 lm_repsize;
451         __u32 lm_timeout;
452         __u32 lm_padding_1;
453         __u32 lm_padding_2;
454         __u32 lm_padding_3;
455         __u32 lm_buflens[0];
456 };
457
458 /* without gss, ptlrpc_body is put at the first buffer. */
459 struct ptlrpc_body {
460         struct lustre_handle pb_handle;
461         __u32 pb_type;
462         __u32 pb_version;
463         __u32 pb_opc;
464         __u32 pb_status;
465         __u64 pb_last_xid;
466         __u64 pb_last_seen;
467         __u64 pb_last_committed;
468         __u64 pb_transno;
469         __u32 pb_flags;
470         __u32 pb_op_flags;
471         __u32 pb_conn_cnt;
472         __u32 pb_padding_1;
473         __u32 pb_padding_2;
474         __u32 pb_limit;
475         __u64 pb_slv;
476 };
477
478 extern void lustre_swab_ptlrpc_body(struct ptlrpc_body *pb);
479
480 /* message body offset for lustre_msg_v2 */
481 /* ptlrpc body offset in all request/reply messages */
482 #define MSG_PTLRPC_BODY_OFF             0
483
484 /* normal request/reply message record offset */
485 #define REQ_REC_OFF                     1
486 #define REPLY_REC_OFF                   1
487
488 /* ldlm request message body offset */
489 #define DLM_LOCKREQ_OFF                 1 /* lockreq offset */
490 #define DLM_REQ_REC_OFF                 2 /* normal dlm request record offset */
491
492 /* ldlm intent lock message body offset */
493 #define DLM_INTENT_IT_OFF               2 /* intent lock it offset */
494 #define DLM_INTENT_REC_OFF              3 /* intent lock record offset */
495
496 /* ldlm reply message body offset */
497 #define DLM_LOCKREPLY_OFF               1 /* lockrep offset */
498 #define DLM_REPLY_REC_OFF               2 /* reply record offset */
499
500 /* Flags that are operation-specific go in the top 16 bits. */
501 #define MSG_OP_FLAG_MASK   0xffff0000
502 #define MSG_OP_FLAG_SHIFT  16
503
504 /* Flags that apply to all requests are in the bottom 16 bits */
505 #define MSG_GEN_FLAG_MASK      0x0000ffff
506 #define MSG_LAST_REPLAY        1
507 #define MSG_RESENT             2
508 #define MSG_REPLAY             4
509 #define MSG_REQ_REPLAY_DONE    8
510 #define MSG_LOCK_REPLAY_DONE  16
511
512 /*
513  * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
514  */
515
516 #define MSG_CONNECT_RECOVERING  0x1
517 #define MSG_CONNECT_RECONNECT   0x2
518 #define MSG_CONNECT_REPLAYABLE  0x4
519 //#define MSG_CONNECT_PEER        0x8
520 #define MSG_CONNECT_LIBCLIENT   0x10
521 #define MSG_CONNECT_INITIAL     0x20
522 #define MSG_CONNECT_ASYNC       0x40
523 #define MSG_CONNECT_NEXT_VER    0x80  /* use next version of lustre_msg */
524 #define MSG_CONNECT_TRANSNO     0x100 /* report transno */
525
526 /* Connect flags */
527 #define OBD_CONNECT_RDONLY     0x00000001ULL /* client allowed read-only access */
528 #define OBD_CONNECT_INDEX      0x00000002ULL /* connect to specific LOV idx */
529 #define OBD_CONNECT_GRANT      0x00000008ULL /* OSC acquires grant at connect */
530 #define OBD_CONNECT_SRVLOCK    0x00000010ULL /* server takes locks for client */
531 #define OBD_CONNECT_VERSION    0x00000020ULL /* Server supports versions in ocd */
532 #define OBD_CONNECT_REQPORTAL  0x00000040ULL /* Separate portal for non-IO reqs */
533 #define OBD_CONNECT_ACL        0x00000080ULL /* client uses access control lists */
534 #define OBD_CONNECT_XATTR      0x00000100ULL /* client using extended attributes*/
535 #define OBD_CONNECT_TRUNCLOCK  0x00000400ULL /* locks on server for punch b=9528 */
536 #define OBD_CONNECT_IBITS      0x00001000ULL /* support for inodebits locks */
537 #define OBD_CONNECT_JOIN       0x00002000ULL /* files can be concatenated */
538 #define OBD_CONNECT_ATTRFID    0x00004000ULL /* Server supports GetAttr By Fid */
539 #define OBD_CONNECT_NODEVOH    0x00008000ULL /* No open handle for special nodes */
540 #define OBD_CONNECT_LCL_CLIENT 0x00010000ULL /* local 1.8 client */
541 #define OBD_CONNECT_RMT_CLIENT 0x00020000ULL /* Remote 1.8 client */
542 #define OBD_CONNECT_BRW_SIZE   0x00040000ULL /* Max bytes per rpc */
543 #define OBD_CONNECT_QUOTA64    0x00080000ULL /* 64bit qunit_data.qd_count b=10707*/
544 #define OBD_CONNECT_MDS_CAPA   0x00100000ULL /* MDS capability */
545 #define OBD_CONNECT_OSS_CAPA   0x00200000ULL /* OSS capability */
546 #define OBD_CONNECT_CANCELSET  0x00400000ULL /* Early batched cancels. */
547 #define OBD_CONNECT_SOM        0x00800000ULL /* SOM feature */
548 #define OBD_CONNECT_AT         0x01000000ULL /* client uses adaptive timeouts */
549 #define OBD_CONNECT_LRU_RESIZE 0x02000000ULL /* Lru resize feature. */
550 #define OBD_CONNECT_MDS_MDS    0x04000000ULL /* MDS-MDS connection*/
551 #define OBD_CONNECT_REAL       0x08000000ULL /* real connection */
552 #define OBD_CONNECT_CHANGE_QS  0x10000000ULL /*shrink/enlarge qunit size
553                                               *b=10600 */
554 #define OBD_CONNECT_CKSUM      0x20000000ULL /* support several cksum algos */
555 #define OBD_CONNECT_FID        0x40000000ULL /* FID is supported by server */
556
557 /* also update obd_connect_names[] for lprocfs_rd_connect_flags()
558  * and lustre/utils/wirecheck.c */
559
560 #ifdef HAVE_LRU_RESIZE_SUPPORT
561 #define LRU_RESIZE_CONNECT_FLAG OBD_CONNECT_LRU_RESIZE
562 #else
563 #define LRU_RESIZE_CONNECT_FLAG 0
564 #endif
565
566 #define MDT_CONNECT_SUPPORTED  (OBD_CONNECT_RDONLY | OBD_CONNECT_VERSION | \
567                                 OBD_CONNECT_ACL | OBD_CONNECT_XATTR | \
568                                 OBD_CONNECT_IBITS | OBD_CONNECT_JOIN | \
569                                 OBD_CONNECT_NODEVOH |/* OBD_CONNECT_ATTRFID |*/\
570                                 OBD_CONNECT_LCL_CLIENT | \
571                                 OBD_CONNECT_RMT_CLIENT | \
572                                 OBD_CONNECT_MDS_CAPA | OBD_CONNECT_OSS_CAPA | \
573                                 OBD_CONNECT_MDS_MDS | OBD_CONNECT_CANCELSET | \
574                                 OBD_CONNECT_FID | \
575                                 LRU_RESIZE_CONNECT_FLAG)
576 #define OST_CONNECT_SUPPORTED  (OBD_CONNECT_SRVLOCK | OBD_CONNECT_GRANT | \
577                                 OBD_CONNECT_REQPORTAL | OBD_CONNECT_VERSION | \
578                                 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_INDEX | \
579                                 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_QUOTA64 | \
580                                 OBD_CONNECT_OSS_CAPA | OBD_CONNECT_CANCELSET | \
581                                 OBD_CONNECT_FID | \
582                                 LRU_RESIZE_CONNECT_FLAG)
583 #define ECHO_CONNECT_SUPPORTED (0)
584 #define MGS_CONNECT_SUPPORTED  (OBD_CONNECT_VERSION | OBD_CONNECT_FID)
585
586 #define MAX_QUOTA_COUNT32 (0xffffffffULL)
587
588 #define OBD_OCD_VERSION(major,minor,patch,fix) (((major)<<24) + ((minor)<<16) +\
589                                                 ((patch)<<8) + (fix))
590 #define OBD_OCD_VERSION_MAJOR(version) ((int)((version)>>24)&255)
591 #define OBD_OCD_VERSION_MINOR(version) ((int)((version)>>16)&255)
592 #define OBD_OCD_VERSION_PATCH(version) ((int)((version)>>8)&255)
593 #define OBD_OCD_VERSION_FIX(version)   ((int)(version)&255)
594
595 /* This structure is used for both request and reply.
596  *
597  * If we eventually have separate connect data for different types, which we
598  * almost certainly will, then perhaps we stick a union in here. */
599 struct obd_connect_data {
600         __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
601         __u32 ocd_version;       /* lustre release version number */
602         __u32 ocd_grant;         /* initial cache grant amount (bytes) */
603         __u32 ocd_index;         /* LOV index to connect to */
604         __u32 ocd_brw_size;      /* Maximum BRW size in bytes */
605         __u64 ocd_ibits_known;   /* inode bits this client understands */
606         __u32 ocd_nllu;          /* non-local-lustre-user */
607         __u32 ocd_nllg;          /* non-local-lustre-group */
608         __u64 ocd_transno;       /* first transno from client to be replayed */
609         __u32 ocd_group;         /* MDS group on OST */
610         __u32 padding1;          /* also fix lustre_swab_connect */
611         __u64 padding2;          /* also fix lustre_swab_connect */
612         __u64 padding3;          /* also fix lustre_swab_connect */
613 };
614
615 extern void lustre_swab_connect(struct obd_connect_data *ocd);
616
617 /*
618  *   OST requests: OBDO & OBD request records
619  */
620
621 /* opcodes */
622 typedef enum {
623         OST_REPLY      =  0,       /* reply ? */
624         OST_GETATTR    =  1,
625         OST_SETATTR    =  2,
626         OST_READ       =  3,
627         OST_WRITE      =  4,
628         OST_CREATE     =  5,
629         OST_DESTROY    =  6,
630         OST_GET_INFO   =  7,
631         OST_CONNECT    =  8,
632         OST_DISCONNECT =  9,
633         OST_PUNCH      = 10,
634         OST_OPEN       = 11,
635         OST_CLOSE      = 12,
636         OST_STATFS     = 13,
637         OST_SYNC       = 16,
638         OST_SET_INFO   = 17,
639         OST_QUOTACHECK = 18,
640         OST_QUOTACTL   = 19,
641         OST_LAST_OPC
642 } ost_cmd_t;
643 #define OST_FIRST_OPC  OST_REPLY
644
645 typedef uint64_t        obd_id;
646 typedef uint64_t        obd_gr;
647 typedef uint64_t        obd_time;
648 typedef uint64_t        obd_size;
649 typedef uint64_t        obd_off;
650 typedef uint64_t        obd_blocks;
651 typedef uint32_t        obd_blksize;
652 typedef uint32_t        obd_mode;
653 typedef uint32_t        obd_uid;
654 typedef uint32_t        obd_gid;
655 typedef uint32_t        obd_flag;
656 typedef uint64_t        obd_valid;
657 typedef uint32_t        obd_count;
658
659 #define OBD_FL_INLINEDATA    (0x00000001)
660 #define OBD_FL_OBDMDEXISTS   (0x00000002)
661 #define OBD_FL_DELORPHAN     (0x00000004) /* if set in o_flags delete orphans */
662 #define OBD_FL_NORPC         (0x00000008) /* set in o_flags do in OSC not OST */
663 #define OBD_FL_IDONLY        (0x00000010) /* set in o_flags only adjust obj id*/
664 #define OBD_FL_RECREATE_OBJS (0x00000020) /* recreate missing obj */
665 #define OBD_FL_DEBUG_CHECK   (0x00000040) /* echo client/server debug check */
666 #define OBD_FL_NO_USRQUOTA   (0x00000100) /* the object's owner is over quota */
667 #define OBD_FL_NO_GRPQUOTA   (0x00000200) /* the object's group is over quota */
668
669 /*
670  * Set this to delegate DLM locking during obd_punch() to the OSTs. Only OSTs
671  * that declared OBD_CONNECT_TRUNCLOCK in their connect flags support this
672  * functionality.
673  */
674 #define OBD_FL_TRUNCLOCK     (0x00000800)
675
676 /*
677  * This should not be smaller than sizeof(struct lustre_handle) + sizeof(struct
678  * llog_cookie) + sizeof(struct ll_fid). Nevertheless struct ll_fid is not
679  * longer stored in o_inline, we keep this just for case.
680  */
681 #define OBD_INLINESZ    80
682
683 /* Note: 64-bit types are 64-bit aligned in structure */
684 struct obdo {
685         obd_valid               o_valid;        /* hot fields in this obdo */
686         obd_id                  o_id;
687         obd_gr                  o_gr;
688         obd_id                  o_fid;
689         obd_size                o_size;         /* o_size-o_blocks == ost_lvb */
690         obd_time                o_mtime;
691         obd_time                o_atime;
692         obd_time                o_ctime;
693         obd_blocks              o_blocks;       /* brw: cli sent cached bytes */
694         obd_size                o_grant;
695
696         /* 32-bit fields start here: keep an even number of them via padding */
697         obd_blksize             o_blksize;      /* optimal IO blocksize */
698         obd_mode                o_mode;         /* brw: cli sent cache remain */
699         obd_uid                 o_uid;
700         obd_gid                 o_gid;
701         obd_flag                o_flags;
702         obd_count               o_nlink;        /* brw: checksum */
703         obd_count               o_generation;
704         obd_count               o_misc;         /* brw: o_dropped */
705         __u32                   o_easize;       /* epoch in ost writes */
706         __u32                   o_mds;
707         __u32                   o_stripe_idx;   /* holds stripe idx */
708         __u32                   o_padding_1;
709         char                    o_inline[OBD_INLINESZ];
710                                 /* lustre_handle + llog_cookie */
711 };
712
713 #define o_dirty   o_blocks
714 #define o_undirty o_mode
715 #define o_dropped o_misc
716 #define o_cksum   o_nlink
717
718 extern void lustre_swab_obdo (struct obdo *o);
719
720
721 #define LOV_MAGIC_V1      0x0BD10BD0
722 #define LOV_MAGIC         LOV_MAGIC_V1
723 #define LOV_MAGIC_JOIN    0x0BD20BD0
724
725 #define LOV_PATTERN_RAID0 0x001   /* stripes are used round-robin */
726 #define LOV_PATTERN_RAID1 0x002   /* stripes are mirrors of each other */
727 #define LOV_PATTERN_FIRST 0x100   /* first stripe is not in round-robin */
728 #define LOV_PATTERN_CMOBD 0x200
729
730 #define LOV_OBJECT_GROUP_DEFAULT ~0ULL
731 #define LOV_OBJECT_GROUP_CLEAR 0ULL
732
733 #define lov_ost_data lov_ost_data_v1
734 struct lov_ost_data_v1 {          /* per-stripe data structure (little-endian)*/
735         __u64 l_object_id;        /* OST object ID */
736         __u64 l_object_gr;        /* OST object group (creating MDS number) */
737         __u32 l_ost_gen;          /* generation of this l_ost_idx */
738         __u32 l_ost_idx;          /* OST index in LOV (lov_tgt_desc->tgts) */
739 };
740
741 #define lov_mds_md lov_mds_md_v1
742 struct lov_mds_md_v1 {            /* LOV EA mds/wire data (little-endian) */
743         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V1 */
744         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
745         __u64 lmm_object_id;      /* LOV object ID */
746         __u64 lmm_object_gr;      /* LOV object group */
747         __u32 lmm_stripe_size;    /* size of stripe in bytes */
748         __u32 lmm_stripe_count;   /* num stripes in use for this object */
749         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
750 };
751
752 extern void lustre_swab_lov_mds_md(struct lov_mds_md *llm);
753
754 #define MAX_MD_SIZE (sizeof(struct lov_mds_md) + 4 * sizeof(struct lov_ost_data))
755 #define MIN_MD_SIZE (sizeof(struct lov_mds_md) + 1 * sizeof(struct lov_ost_data))
756
757 #define XATTR_NAME_ACL_ACCESS   "system.posix_acl_access"
758 #define XATTR_NAME_ACL_DEFAULT  "system.posix_acl_default"
759 #define XATTR_NAME_LOV          "trusted.lov"
760
761 #define OBD_MD_FLID        (0x00000001ULL) /* object ID */
762 #define OBD_MD_FLATIME     (0x00000002ULL) /* access time */
763 #define OBD_MD_FLMTIME     (0x00000004ULL) /* data modification time */
764 #define OBD_MD_FLCTIME     (0x00000008ULL) /* change time */
765 #define OBD_MD_FLSIZE      (0x00000010ULL) /* size */
766 #define OBD_MD_FLBLOCKS    (0x00000020ULL) /* allocated blocks count */
767 #define OBD_MD_FLBLKSZ     (0x00000040ULL) /* block size */
768 #define OBD_MD_FLMODE      (0x00000080ULL) /* access bits (mode & ~S_IFMT) */
769 #define OBD_MD_FLTYPE      (0x00000100ULL) /* object type (mode & S_IFMT) */
770 #define OBD_MD_FLUID       (0x00000200ULL) /* user ID */
771 #define OBD_MD_FLGID       (0x00000400ULL) /* group ID */
772 #define OBD_MD_FLFLAGS     (0x00000800ULL) /* flags word */
773 #define OBD_MD_FLNLINK     (0x00002000ULL) /* link count */
774 #define OBD_MD_FLGENER     (0x00004000ULL) /* generation number */
775 #define OBD_MD_FLINLINE    (0x00008000ULL) /* inline data */
776 #define OBD_MD_FLRDEV      (0x00010000ULL) /* device number */
777 #define OBD_MD_FLEASIZE    (0x00020000ULL) /* extended attribute data */
778 #define OBD_MD_LINKNAME    (0x00040000ULL) /* symbolic link target */
779 #define OBD_MD_FLHANDLE    (0x00080000ULL) /* file handle */
780 #define OBD_MD_FLCKSUM     (0x00100000ULL) /* bulk data checksum */
781 #define OBD_MD_FLQOS       (0x00200000ULL) /* quality of service stats */
782 #define OBD_MD_FLOSCOPQ    (0x00400000ULL) /* osc opaque data */
783 #define OBD_MD_FLCOOKIE    (0x00800000ULL) /* log cancellation cookie */
784 #define OBD_MD_FLGROUP     (0x01000000ULL) /* group */
785 #define OBD_MD_FLFID       (0x02000000ULL) /* ->ost write inline fid */
786 #define OBD_MD_FLEPOCH     (0x04000000ULL) /* ->ost write easize is epoch */
787                                            /* ->mds if epoch opens or closes */
788 #define OBD_MD_FLGRANT     (0x08000000ULL) /* ost preallocation space grant */
789 #define OBD_MD_FLDIREA     (0x10000000ULL) /* dir's extended attribute data */
790 #define OBD_MD_FLUSRQUOTA  (0x20000000ULL) /* over quota flags sent from ost */
791 #define OBD_MD_FLGRPQUOTA  (0x40000000ULL) /* over quota flags sent from ost */
792 #define OBD_MD_FLMODEASIZE (0x80000000ULL) /* EA size will be changed */
793
794 #define OBD_MD_MDS         (0x0000000100000000ULL) /* where an inode lives on */
795 #define OBD_MD_REINT       (0x0000000200000000ULL) /* reintegrate oa */
796 #define OBD_MD_MEA         (0x0000000400000000ULL) /* CMD split EA  */
797
798 #define OBD_MD_FLXATTR     (0x0000001000000000ULL) /* xattr */
799 #define OBD_MD_FLXATTRLS   (0x0000002000000000ULL) /* xattr list */
800 #define OBD_MD_FLXATTRRM   (0x0000004000000000ULL) /* xattr remove */
801 #define OBD_MD_FLACL       (0x0000008000000000ULL) /* ACL */
802 #define OBD_MD_FLRMTPERM   (0x0000010000000000ULL) /* remote permission */
803 #define OBD_MD_FLMDSCAPA   (0x0000020000000000ULL) /* MDS capability */
804 #define OBD_MD_FLOSSCAPA   (0x0000040000000000ULL) /* OSS capability */
805 #define OBD_MD_FLCKSPLIT   (0x0000080000000000ULL) /* Check split on server */
806 #define OBD_MD_FLCROSSREF  (0x0000100000000000ULL) /* Cross-ref case */
807
808 #define OBD_MD_FLRMTLSETFACL    (0x0001000000000000ULL) /* lfs lsetfacl case */
809 #define OBD_MD_FLRMTLGETFACL    (0x0002000000000000ULL) /* lfs lgetfacl case */
810 #define OBD_MD_FLRMTRSETFACL    (0x0004000000000000ULL) /* lfs rsetfacl case */
811 #define OBD_MD_FLRMTRGETFACL    (0x0008000000000000ULL) /* lfs rgetfacl case */
812
813 #define OBD_MD_FLGETATTR (OBD_MD_FLID    | OBD_MD_FLATIME | OBD_MD_FLMTIME | \
814                           OBD_MD_FLCTIME | OBD_MD_FLSIZE  | OBD_MD_FLBLKSZ | \
815                           OBD_MD_FLMODE  | OBD_MD_FLTYPE  | OBD_MD_FLUID   | \
816                           OBD_MD_FLGID   | OBD_MD_FLFLAGS | OBD_MD_FLNLINK | \
817                           OBD_MD_FLGENER | OBD_MD_FLRDEV  | OBD_MD_FLGROUP)
818
819 static inline struct lustre_handle *obdo_handle(struct obdo *oa)
820 {
821         return (struct lustre_handle *)oa->o_inline;
822 }
823
824 static inline struct llog_cookie *obdo_logcookie(struct obdo *oa)
825 {
826         return (struct llog_cookie *)(oa->o_inline +
827                                       sizeof(struct lustre_handle));
828 }
829 /* don't forget obdo_fid which is way down at the bottom so it can
830  * come after the definition of llog_cookie */
831
832 struct obd_statfs {
833         __u64           os_type;
834         __u64           os_blocks;
835         __u64           os_bfree;
836         __u64           os_bavail;
837         __u64           os_files;
838         __u64           os_ffree;
839         __u8            os_fsid[40];
840         __u32           os_bsize;
841         __u32           os_namelen;
842         __u64           os_maxbytes;
843         __u32           os_state;       /* positive error code on server */
844         __u32           os_spare1;
845         __u32           os_spare2;
846         __u32           os_spare3;
847         __u32           os_spare4;
848         __u32           os_spare5;
849         __u32           os_spare6;
850         __u32           os_spare7;
851         __u32           os_spare8;
852         __u32           os_spare9;
853 };
854
855 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
856
857 /* ost_body.data values for OST_BRW */
858
859 #define OBD_BRW_READ            0x01
860 #define OBD_BRW_WRITE           0x02
861 #define OBD_BRW_RWMASK          (OBD_BRW_READ | OBD_BRW_WRITE)
862 #define OBD_BRW_SYNC            0x08
863 #define OBD_BRW_CHECK           0x10
864 #define OBD_BRW_FROM_GRANT      0x20 /* the osc manages this under llite */
865 #define OBD_BRW_GRANTED         0x40 /* the ost manages this */
866 #define OBD_BRW_DROP            0x80 /* drop the page after IO */
867 #define OBD_BRW_NOQUOTA        0x100
868 #define OBD_BRW_SRVLOCK        0x200 /* Client holds no lock over this page */
869
870 #define OBD_OBJECT_EOF 0xffffffffffffffffULL
871
872 #define OST_MIN_PRECREATE 32
873 #define OST_MAX_PRECREATE 20000
874
875 struct obd_ioobj {
876         obd_id               ioo_id;
877         obd_gr               ioo_gr;
878         __u32                ioo_type;
879         __u32                ioo_bufcnt;
880 };
881
882 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
883
884 /* multiple of 8 bytes => can array */
885 struct niobuf_remote {
886         __u64 offset;
887         __u32 len;
888         __u32 flags;
889 };
890
891 extern void lustre_swab_niobuf_remote (struct niobuf_remote *nbr);
892
893 /* request structure for OST's */
894
895 struct ost_body {
896         struct  obdo oa;
897 };
898
899 extern void lustre_swab_ost_body (struct ost_body *b);
900 extern void lustre_swab_ost_last_id(obd_id *id);
901
902 /* lock value block communicated between the filter and llite */
903
904 /* OST_LVB_ERR_INIT is needed because the return code in rc is 
905  * negative, i.e. because ((MASK + rc) & MASK) != MASK. */
906 #define OST_LVB_ERR_INIT 0xffbadbad80000000ULL
907 #define OST_LVB_ERR_MASK 0xffbadbad00000000ULL
908 #define OST_LVB_IS_ERR(blocks)                                          \
909         ((blocks & OST_LVB_ERR_MASK) == OST_LVB_ERR_MASK)
910 #define OST_LVB_SET_ERR(blocks, rc)                                     \
911         do { blocks = OST_LVB_ERR_INIT + rc; } while (0)
912 #define OST_LVB_GET_ERR(blocks)    (int)(blocks - OST_LVB_ERR_INIT)
913
914 struct ost_lvb {
915         __u64 lvb_size;
916         __u64 lvb_mtime;
917         __u64 lvb_atime;
918         __u64 lvb_ctime;
919         __u64 lvb_blocks;
920 };
921
922 extern void lustre_swab_ost_lvb(struct ost_lvb *);
923
924 /*
925  *   MDS REQ RECORDS
926  */
927
928 /* opcodes */
929 typedef enum {
930         MDS_GETATTR      = 33,
931         MDS_GETATTR_NAME = 34,
932         MDS_CLOSE        = 35,
933         MDS_REINT        = 36,
934         MDS_READPAGE     = 37,
935         MDS_CONNECT      = 38,
936         MDS_DISCONNECT   = 39,
937         MDS_GETSTATUS    = 40,
938         MDS_STATFS       = 41,
939         MDS_PIN          = 42,
940         MDS_UNPIN        = 43,
941         MDS_SYNC         = 44,
942         MDS_DONE_WRITING = 45,
943         MDS_SET_INFO     = 46,
944         MDS_QUOTACHECK   = 47,
945         MDS_QUOTACTL     = 48,
946         MDS_GETXATTR     = 49,
947         MDS_SETXATTR     = 50, /* obsolete, now it's MDS_REINT op */
948         MDS_WRITEPAGE    = 51,
949         MDS_IS_SUBDIR    = 52,
950         MDS_LAST_OPC
951 } mds_cmd_t;
952
953 #define MDS_FIRST_OPC    MDS_GETATTR
954
955 /*
956  * Do not exceed 63
957  */
958
959 typedef enum {
960         REINT_SETATTR  = 1,
961         REINT_CREATE   = 2,
962         REINT_LINK     = 3,
963         REINT_UNLINK   = 4,
964         REINT_RENAME   = 5,
965         REINT_OPEN     = 6,
966         REINT_SETXATTR = 7,
967 //      REINT_CLOSE    = 8,
968 //      REINT_WRITE    = 9,
969         REINT_MAX
970 } mds_reint_t, mdt_reint_t;
971
972 extern void lustre_swab_generic_32s (__u32 *val);
973
974 /* the disposition of the intent outlines what was executed */
975 #define DISP_IT_EXECD        0x00000001
976 #define DISP_LOOKUP_EXECD    0x00000002
977 #define DISP_LOOKUP_NEG      0x00000004
978 #define DISP_LOOKUP_POS      0x00000008
979 #define DISP_OPEN_CREATE     0x00000010
980 #define DISP_OPEN_OPEN       0x00000020
981 #define DISP_ENQ_COMPLETE    0x00400000
982 #define DISP_ENQ_OPEN_REF    0x00800000
983 #define DISP_ENQ_CREATE_REF  0x01000000
984 #define DISP_OPEN_LOCK       0x02000000
985
986 /* INODE LOCK PARTS */
987 #define MDS_INODELOCK_LOOKUP 0x000001       /* dentry, mode, owner, group */
988 #define MDS_INODELOCK_UPDATE 0x000002       /* size, links, timestamps */
989 #define MDS_INODELOCK_OPEN   0x000004       /* For opened files */
990
991 /* Do not forget to increase MDS_INODELOCK_MAXSHIFT when adding new bits */
992 #define MDS_INODELOCK_MAXSHIFT 2
993 /* This FULL lock is useful to take on unlink sort of operations */
994 #define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
995
996 struct ll_fid {
997         __u64 id;         /* holds object id */
998         __u32 generation; /* holds object generation */
999
1000         __u32 f_type;     /* holds object type or stripe idx when passing it to
1001                            * OST for saving into EA. */
1002 };
1003
1004 extern void lustre_swab_ll_fid (struct ll_fid *fid);
1005
1006 #define MDS_STATUS_CONN 1
1007 #define MDS_STATUS_LOV 2
1008
1009 struct mds_status_req {
1010         __u32  flags;
1011         __u32  repbuf;
1012 };
1013
1014 extern void lustre_swab_mds_status_req (struct mds_status_req *r);
1015
1016 /* mdt_thread_info.mti_flags. */
1017 enum md_op_flags {
1018         /* The flag indicates Size-on-MDS attributes are changed. */
1019         MF_SOM_CHANGE           = (1 << 0),
1020         /* Flags indicates an epoch opens or closes. */
1021         MF_EPOCH_OPEN           = (1 << 1),
1022         MF_EPOCH_CLOSE          = (1 << 2),
1023         MF_MDC_CANCEL_FID1      = (1 << 3),
1024         MF_MDC_CANCEL_FID2      = (1 << 4),
1025         MF_MDC_CANCEL_FID3      = (1 << 5),
1026         MF_MDC_CANCEL_FID4      = (1 << 6),
1027 };
1028
1029 #define MF_SOM_LOCAL_FLAGS (MF_MDC_CANCEL_FID1 | MF_MDC_CANCEL_FID2 | \
1030                             MF_MDC_CANCEL_FID3 | MF_MDC_CANCEL_FID4)
1031
1032 #define MDS_BFLAG_UNCOMMITTED_WRITES   0x1
1033 #define MDS_BFLAG_EXT_FLAGS     0x80000000 /* == EXT3_RESERVED_FL */
1034
1035 /* these should be identical to their EXT3_*_FL counterparts, and are
1036  * redefined here only to avoid dragging in ext3_fs.h */
1037 #define MDS_SYNC_FL             0x00000008 /* Synchronous updates */
1038 #define MDS_IMMUTABLE_FL        0x00000010 /* Immutable file */
1039 #define MDS_APPEND_FL           0x00000020 /* writes to file may only append */
1040 #define MDS_NOATIME_FL          0x00000080 /* do not update atime */
1041 #define MDS_DIRSYNC_FL          0x00010000 /* dirsync behaviour (dir only) */
1042
1043 #ifdef __KERNEL__
1044 /* If MDS_BFLAG_IOC_FLAGS is set it means we requested EXT3_*_FL inode flags
1045  * and we need to decode these into local S_* flags in the inode.  Otherwise
1046  * we pass flags straight through (see bug 9486). */
1047 static inline int ll_ext_to_inode_flags(int flags)
1048 {
1049         return (flags & MDS_BFLAG_EXT_FLAGS) ?
1050                (((flags & MDS_SYNC_FL)      ? S_SYNC      : 0) |
1051                 ((flags & MDS_NOATIME_FL)   ? S_NOATIME   : 0) |
1052                 ((flags & MDS_APPEND_FL)    ? S_APPEND    : 0) |
1053 #if defined(S_DIRSYNC)
1054                 ((flags & MDS_DIRSYNC_FL)   ? S_DIRSYNC   : 0) |
1055 #endif
1056                 ((flags & MDS_IMMUTABLE_FL) ? S_IMMUTABLE : 0)) :
1057                (flags & ~MDS_BFLAG_EXT_FLAGS);
1058 }
1059
1060 /* If MDS_BFLAG_EXT_FLAGS is set it means we requested EXT3_*_FL inode flags
1061  * and we pass these straight through.  Otherwise we need to convert from
1062  * S_* flags to their EXT3_*_FL equivalents (see bug 9486). */
1063 static inline int ll_inode_to_ext_flags(int oflags, int iflags)
1064 {
1065         return (oflags & MDS_BFLAG_EXT_FLAGS) ? (oflags & ~MDS_BFLAG_EXT_FLAGS):
1066                (((iflags & S_SYNC)      ? MDS_SYNC_FL      : 0) |
1067                 ((iflags & S_NOATIME)   ? MDS_NOATIME_FL   : 0) |
1068                 ((iflags & S_APPEND)    ? MDS_APPEND_FL    : 0) |
1069 #if defined(S_DIRSYNC)
1070                 ((iflags & S_DIRSYNC)   ? MDS_DIRSYNC_FL   : 0) |
1071 #endif
1072                 ((iflags & S_IMMUTABLE) ? MDS_IMMUTABLE_FL : 0));
1073 }
1074 #endif
1075
1076 struct mdt_body {
1077         struct lu_fid  fid1;
1078         struct lu_fid  fid2;
1079         struct lustre_handle handle;
1080         __u64          valid;
1081         __u64          size;   /* Offset, in the case of MDS_READPAGE */
1082         __u64          mtime;
1083         __u64          atime;
1084         __u64          ctime;
1085         __u64          blocks; /* XID, in the case of MDS_READPAGE */
1086         __u64          ioepoch;
1087         __u64          ino;    /* for 1.6 compatibility */
1088         __u32          fsuid;
1089         __u32          fsgid;
1090         __u32          capability;
1091         __u32          mode;
1092         __u32          uid;
1093         __u32          gid;
1094         __u32          flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
1095         __u32          rdev;
1096         __u32          nlink; /* #bytes to read in the case of MDS_READPAGE */
1097         __u32          generation; /* for 1.6 compatibility */
1098         __u32          suppgid;
1099         __u32          eadatasize;
1100         __u32          aclsize;
1101         __u32          max_mdsize;
1102         __u32          max_cookiesize;
1103         __u32          padding_4; /* also fix lustre_swab_mdt_body */
1104 };
1105
1106 struct mds_body {
1107         struct ll_fid  fid1;
1108         struct ll_fid  fid2;
1109         struct lustre_handle handle;
1110         __u64          valid;
1111         __u64          size;   /* Offset, in the case of MDS_READPAGE */
1112         __u64          mtime;
1113         __u64          atime;
1114         __u64          ctime;
1115         __u64          blocks; /* XID, in the case of MDS_READPAGE */
1116         __u64          io_epoch;
1117         __u64          ino;
1118         __u32          fsuid;
1119         __u32          fsgid;
1120         __u32          capability;
1121         __u32          mode;
1122         __u32          uid;
1123         __u32          gid;
1124         __u32          flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
1125         __u32          rdev;
1126         __u32          nlink; /* #bytes to read in the case of MDS_READPAGE */
1127         __u32          generation;
1128         __u32          suppgid;
1129         __u32          eadatasize;
1130         __u32          aclsize;
1131         __u32          max_mdsize;
1132         __u32          max_cookiesize; /* also fix lustre_swab_mds_body */
1133         __u32          padding_4; /* also fix lustre_swab_mds_body */
1134 };
1135
1136 extern void lustre_swab_mds_body (struct mds_body *b);
1137 extern void lustre_swab_mdt_body (struct mdt_body *b);
1138
1139 struct mdt_epoch {
1140         struct lustre_handle handle;
1141         __u64  ioepoch;
1142         __u32  flags;
1143         __u32  padding;
1144 };
1145
1146 extern void lustre_swab_mdt_epoch (struct mdt_epoch *b);
1147
1148 #define Q_QUOTACHECK    0x800100
1149 #define Q_INITQUOTA     0x800101        /* init slave limits */
1150 #define Q_GETOINFO      0x800102        /* get obd quota info */
1151 #define Q_GETOQUOTA     0x800103        /* get obd quotas */
1152
1153 #define Q_TYPESET(oqc, type) \
1154         ((oqc)->qc_type == type || (oqc)->qc_type == UGQUOTA)
1155
1156 #define Q_GETOCMD(oqc) \
1157         ((oqc)->qc_cmd == Q_GETOINFO || (oqc)->qc_cmd == Q_GETOQUOTA)
1158
1159 struct obd_quotactl {
1160         __u32                   qc_cmd;
1161         __u32                   qc_type;
1162         __u32                   qc_id;
1163         __u32                   qc_stat;
1164         struct obd_dqinfo       qc_dqinfo;
1165         struct obd_dqblk        qc_dqblk;
1166 };
1167
1168 extern void lustre_swab_obd_quotactl(struct obd_quotactl *q);
1169
1170 /* inode access permission for remote user, the inode info are omitted,
1171  * for client knows them. */
1172 struct mds_remote_perm {
1173         __u32           rp_uid;
1174         __u32           rp_gid;
1175         __u32           rp_fsuid;
1176         __u32           rp_fsgid;
1177         __u32           rp_access_perm; /* MAY_READ/WRITE/EXEC */
1178 };
1179
1180 /* permissions for md_perm.mp_perm */
1181 enum {
1182         CFS_SETUID_PERM = 0x01,
1183         CFS_SETGID_PERM = 0x02,
1184         CFS_SETGRP_PERM = 0x04,
1185         CFS_RMTACL_PERM = 0x08
1186 };
1187
1188 extern void lustre_swab_mds_remote_perm(struct mds_remote_perm *p);
1189
1190 struct mdt_remote_perm {
1191         __u32           rp_uid;
1192         __u32           rp_gid;
1193         __u32           rp_fsuid;
1194         __u32           rp_fsgid;
1195         __u32           rp_access_perm; /* MAY_READ/WRITE/EXEC */
1196 };
1197
1198 extern void lustre_swab_mdt_remote_perm(struct mdt_remote_perm *p);
1199
1200 struct mds_rec_setattr {
1201         __u32           sa_opcode;
1202         __u32           sa_fsuid;
1203         __u32           sa_fsgid;
1204         __u32           sa_cap;
1205         __u32           sa_suppgid;
1206         __u32           sa_mode;
1207         struct ll_fid   sa_fid;
1208         __u64           sa_valid; /* MDS_ATTR_* attributes */
1209         __u64           sa_size;
1210         __u64           sa_mtime;
1211         __u64           sa_atime;
1212         __u64           sa_ctime;
1213         __u32           sa_uid;
1214         __u32           sa_gid;
1215         __u32           sa_attr_flags;
1216         __u32           sa_padding; /* also fix lustre_swab_mds_rec_setattr */
1217 };
1218
1219 extern void lustre_swab_mds_rec_setattr (struct mds_rec_setattr *sa);
1220
1221 struct mdt_rec_setattr {
1222         __u32           sa_opcode;
1223         __u32           sa_fsuid;
1224         __u32           sa_fsgid;
1225         __u32           sa_cap;
1226         __u32           sa_suppgid;
1227         __u32           sa_padding_1;
1228         struct lu_fid   sa_fid;
1229         __u64           sa_valid;
1230         __u32           sa_uid;
1231         __u32           sa_gid;
1232         __u64           sa_size;
1233         __u64           sa_blocks;
1234         __u64           sa_mtime;
1235         __u64           sa_atime;
1236         __u64           sa_ctime;
1237         __u32           sa_attr_flags;
1238         __u32           sa_mode;
1239         __u32           sa_padding_2;
1240         __u32           sa_padding_3;
1241         __u32           sa_padding_4;
1242         __u32           sa_padding_5;
1243 };
1244
1245 extern void lustre_swab_mdt_rec_setattr (struct mdt_rec_setattr *sa);
1246
1247 /*
1248  * Attribute flags used in mds_rec_setattr::sa_valid.
1249  * The kernel's #defines for ATTR_* should not be used over the network
1250  * since the client and MDS may run different kernels (see bug 13828)
1251  * Therefore, we should only use MDS_ATTR_* attributes for sa_valid.
1252  */
1253 #define MDS_ATTR_MODE          0x1ULL /* = 1 */
1254 #define MDS_ATTR_UID           0x2ULL /* = 2 */
1255 #define MDS_ATTR_GID           0x4ULL /* = 4 */
1256 #define MDS_ATTR_SIZE          0x8ULL /* = 8 */
1257 #define MDS_ATTR_ATIME        0x10ULL /* = 16 */
1258 #define MDS_ATTR_MTIME        0x20ULL /* = 32 */
1259 #define MDS_ATTR_CTIME        0x40ULL /* = 64 */
1260 #define MDS_ATTR_ATIME_SET    0x80ULL /* = 128 */
1261 #define MDS_ATTR_MTIME_SET   0x100ULL /* = 256 */
1262 #define MDS_ATTR_FORCE       0x200ULL /* = 512, Not a change, but a change it */
1263 #define MDS_ATTR_ATTR_FLAG   0x400ULL /* = 1024 */
1264 #define MDS_ATTR_KILL_SUID   0x800ULL /* = 2048 */
1265 #define MDS_ATTR_KILL_SGID  0x1000ULL /* = 4096 */
1266 #define MDS_ATTR_CTIME_SET  0x2000ULL /* = 8192 */
1267 #define MDS_ATTR_FROM_OPEN  0x4000ULL /* = 16384, called from open path, ie O_TRUNC */
1268 #define MDS_ATTR_BLOCKS     0x8000ULL /* = 32768 */
1269
1270 #ifndef FMODE_READ
1271 #define FMODE_READ               00000001
1272 #define FMODE_WRITE              00000002
1273 #endif
1274
1275 #define FMODE_EPOCH              01000000
1276 #define FMODE_EPOCHLCK           02000000
1277 #define FMODE_SOM                04000000
1278 #define FMODE_CLOSED             0
1279
1280 #define MDS_OPEN_CREATED         00000010
1281 #define MDS_OPEN_CROSS           00000020
1282
1283 #define MDS_FMODE_EXEC           00000004
1284 #define MDS_OPEN_CREAT           00000100
1285 #define MDS_OPEN_EXCL            00000200
1286 #define MDS_OPEN_TRUNC           00001000
1287 #define MDS_OPEN_APPEND          00002000
1288 #define MDS_OPEN_SYNC            00010000
1289 #define MDS_OPEN_DIRECTORY       00200000
1290
1291 #define MDS_OPEN_DELAY_CREATE  0100000000 /* delay initial object create */
1292 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
1293 #define MDS_OPEN_JOIN_FILE     0400000000 /* open for join file*/
1294 #define MDS_CREATE_RMT_ACL    01000000000 /* indicate create on remote server
1295                                            * with default ACL */
1296 #define MDS_CREATE_SLAVE_OBJ  02000000000 /* indicate create slave object
1297                                            * actually, this is for create, not
1298                                            * conflict with other open flags */
1299 #define MDS_OPEN_LOCK         04000000000 /* This open requires open lock */
1300 #define MDS_OPEN_HAS_EA      010000000000 /* specify object create pattern */
1301 #define MDS_OPEN_HAS_OBJS    020000000000 /* Just set the EA the obj exist */
1302
1303 /* permission for create non-directory file */
1304 #define MAY_CREATE      (1 << 7)
1305 /* permission for create directory file */
1306 #define MAY_LINK        (1 << 8)
1307 /* permission for delete from the directory */
1308 #define MAY_UNLINK      (1 << 9)
1309 /* source's permission for rename */
1310 #define MAY_RENAME_SRC  (1 << 10)
1311 /* target's permission for rename */
1312 #define MAY_RENAME_TAR  (1 << 11)
1313 /* part (parent's) VTX permission check */
1314 #define MAY_VTX_PART    (1 << 12)
1315 /* full VTX permission check */
1316 #define MAY_VTX_FULL    (1 << 13)
1317 /* lfs rgetfacl permission check */
1318 #define MAY_RGETFACL    (1 << 14)
1319
1320 enum {
1321         MDS_CHECK_SPLIT  = 1 << 0,
1322         MDS_CROSS_REF    = 1 << 1,
1323         MDS_VTX_BYPASS   = 1 << 2,
1324         MDS_PERM_BYPASS  = 1 << 3
1325 };
1326
1327 struct mds_rec_join {
1328         struct ll_fid  jr_fid;
1329         __u64          jr_headsize;
1330 };
1331
1332 extern void lustre_swab_mds_rec_join (struct mds_rec_join *jr);
1333
1334 struct mdt_rec_join {
1335         struct lu_fid  jr_fid;
1336         __u64          jr_headsize;
1337 };
1338
1339 extern void lustre_swab_mdt_rec_join (struct mdt_rec_join *jr);
1340
1341 struct mds_rec_create {
1342         __u32           cr_opcode;
1343         __u32           cr_fsuid;
1344         __u32           cr_fsgid;
1345         __u32           cr_cap;
1346         __u32           cr_flags; /* for use with open */
1347         __u32           cr_mode;
1348         struct ll_fid   cr_fid;
1349         struct ll_fid   cr_replayfid;
1350         __u64           cr_time;
1351         __u64           cr_rdev;
1352         __u32           cr_suppgid;
1353         __u32           cr_padding_1; /* also fix lustre_swab_mds_rec_create */
1354         __u32           cr_padding_2; /* also fix lustre_swab_mds_rec_create */
1355         __u32           cr_padding_3; /* also fix lustre_swab_mds_rec_create */
1356         __u32           cr_padding_4; /* also fix lustre_swab_mds_rec_create */
1357         __u32           cr_padding_5; /* also fix lustre_swab_mds_rec_create */
1358 };
1359
1360 extern void lustre_swab_mds_rec_create (struct mds_rec_create *cr);
1361
1362 struct mdt_rec_create {
1363         __u32           cr_opcode;
1364         __u32           cr_fsuid;
1365         __u32           cr_fsgid;
1366         __u32           cr_cap;
1367         __u32           cr_suppgid1;
1368         __u32           cr_suppgid2;
1369         struct lu_fid   cr_fid1;
1370         struct lu_fid   cr_fid2;
1371         struct lustre_handle cr_old_handle; /* u64 handle in case of open replay */
1372         __u64           cr_time;
1373         __u64           cr_rdev;
1374         __u64           cr_ioepoch;
1375         __u64           cr_padding_1; /* pad for 64 bits*/
1376         __u32           cr_mode;
1377         __u32           cr_bias;
1378         __u32           cr_flags;     /* for use with open */
1379         __u32           cr_padding_2;
1380         __u32           cr_padding_3;
1381         __u32           cr_padding_4;
1382 };
1383
1384 extern void lustre_swab_mdt_rec_create (struct mdt_rec_create *cr);
1385
1386 struct mds_rec_link {
1387         __u32           lk_opcode;
1388         __u32           lk_fsuid;
1389         __u32           lk_fsgid;
1390         __u32           lk_cap;
1391         __u32           lk_suppgid1;
1392         __u32           lk_suppgid2;
1393         struct ll_fid   lk_fid1;
1394         struct ll_fid   lk_fid2;
1395         __u64           lk_time;
1396         __u32           lk_padding_1;  /* also fix lustre_swab_mds_rec_link */
1397         __u32           lk_padding_2;  /* also fix lustre_swab_mds_rec_link */
1398         __u32           lk_padding_3;  /* also fix lustre_swab_mds_rec_link */
1399         __u32           lk_padding_4;  /* also fix lustre_swab_mds_rec_link */
1400 };
1401
1402 extern void lustre_swab_mds_rec_link (struct mds_rec_link *lk);
1403
1404 struct mdt_rec_link {
1405         __u32           lk_opcode;
1406         __u32           lk_fsuid;
1407         __u32           lk_fsgid;
1408         __u32           lk_cap;
1409         __u32           lk_suppgid1;
1410         __u32           lk_suppgid2;
1411         struct lu_fid   lk_fid1;
1412         struct lu_fid   lk_fid2;
1413         __u64           lk_time;
1414         __u64           lk_padding_1;
1415         __u64           lk_padding_2;
1416         __u64           lk_padding_3;
1417         __u64           lk_padding_4;
1418         __u32           lk_bias;
1419         __u32           lk_padding_5;
1420         __u32           lk_padding_6;
1421         __u32           lk_padding_7;
1422         __u32           lk_padding_8;
1423         __u32           lk_padding_9;
1424 };
1425
1426 struct mds_rec_unlink {
1427         __u32           ul_opcode;
1428         __u32           ul_fsuid;
1429         __u32           ul_fsgid;
1430         __u32           ul_cap;
1431         __u32           ul_suppgid;
1432         __u32           ul_mode;
1433         struct ll_fid   ul_fid1;
1434         struct ll_fid   ul_fid2;
1435         __u64           ul_time;
1436         __u32           ul_padding_1; /* also fix lustre_swab_mds_rec_unlink */
1437         __u32           ul_padding_2; /* also fix lustre_swab_mds_rec_unlink */
1438         __u32           ul_padding_3; /* also fix lustre_swab_mds_rec_unlink */
1439         __u32           ul_padding_4; /* also fix lustre_swab_mds_rec_unlink */
1440 };
1441
1442 extern void lustre_swab_mds_rec_unlink (struct mds_rec_unlink *ul);
1443
1444 struct mdt_rec_unlink {
1445         __u32           ul_opcode;
1446         __u32           ul_fsuid;
1447         __u32           ul_fsgid;
1448         __u32           ul_cap;
1449         __u32           ul_suppgid1;
1450         __u32           ul_suppgid2;
1451         struct lu_fid   ul_fid1;
1452         struct lu_fid   ul_fid2;
1453         __u64           ul_time;
1454         __u64           ul_padding_2;
1455         __u64           ul_padding_3;
1456         __u64           ul_padding_4;
1457         __u64           ul_padding_5;
1458         __u32           ul_bias;
1459         __u32           ul_mode;
1460         __u32           ul_padding_6;
1461         __u32           ul_padding_7;
1462         __u32           ul_padding_8;
1463         __u32           ul_padding_9;
1464 };
1465
1466 struct mds_rec_rename {
1467         __u32           rn_opcode;
1468         __u32           rn_fsuid;
1469         __u32           rn_fsgid;
1470         __u32           rn_cap;
1471         __u32           rn_suppgid1;
1472         __u32           rn_suppgid2;
1473         struct ll_fid   rn_fid1;
1474         struct ll_fid   rn_fid2;
1475         __u64           rn_time;
1476         __u32           rn_padding_1; /* also fix lustre_swab_mds_rec_rename */
1477         __u32           rn_padding_2; /* also fix lustre_swab_mds_rec_rename */
1478         __u32           rn_padding_3; /* also fix lustre_swab_mds_rec_rename */
1479         __u32           rn_padding_4; /* also fix lustre_swab_mds_rec_rename */
1480 };
1481
1482 extern void lustre_swab_mds_rec_rename (struct mds_rec_rename *rn);
1483
1484 struct mdt_rec_rename {
1485         __u32           rn_opcode;
1486         __u32           rn_fsuid;
1487         __u32           rn_fsgid;
1488         __u32           rn_cap;
1489         __u32           rn_suppgid1;
1490         __u32           rn_suppgid2;
1491         struct lu_fid   rn_fid1;
1492         struct lu_fid   rn_fid2;
1493         __u64           rn_time;
1494         __u64           rn_padding_1;
1495         __u64           rn_padding_2;
1496         __u64           rn_padding_3;
1497         __u64           rn_padding_4;
1498         __u32           rn_bias;      /* some operation flags */
1499         __u32           rn_mode;      /* cross-ref rename has mode */
1500         __u32           rn_padding_5;
1501         __u32           rn_padding_6;
1502         __u32           rn_padding_7;
1503         __u32           rn_padding_8;
1504 };
1505
1506 struct mdt_rec_setxattr {
1507         __u32           sx_opcode;
1508         __u32           sx_fsuid;
1509         __u32           sx_fsgid;
1510         __u32           sx_cap;
1511         __u32           sx_suppgid1;
1512         __u32           sx_suppgid2;
1513         struct lu_fid   sx_fid;
1514         __u64           sx_padding_1; /* These three members are lu_fid size */
1515         __u32           sx_padding_2;
1516         __u32           sx_padding_3;
1517         __u64           sx_valid;
1518         __u64           sx_padding_4;
1519         __u64           sx_padding_5;
1520         __u64           sx_padding_6;
1521         __u64           sx_padding_7;
1522         __u32           sx_size;
1523         __u32           sx_flags;
1524         __u32           sx_padding_8;
1525         __u32           sx_padding_9;
1526         __u32           sx_padding_10;
1527         __u32           sx_padding_11;
1528 };
1529
1530 struct mdt_rec_reint {
1531         __u32           rr_opcode;
1532         __u32           rr_fsuid;
1533         __u32           rr_fsgid;
1534         __u32           rr_cap;
1535         __u32           rr_suppgid1;
1536         __u32           rr_suppgid2;
1537         struct lu_fid   rr_fid1;
1538         struct lu_fid   rr_fid2;
1539         __u64           rr_mtime;
1540         __u64           rr_atime;
1541         __u64           rr_ctime;
1542         __u64           rr_size;
1543         __u64           rr_blocks;
1544         __u32           rr_bias;
1545         __u32           rr_mode;
1546         __u32           rr_padding_1; /* also fix lustre_swab_mdt_rec_reint */
1547         __u32           rr_padding_2; /* also fix lustre_swab_mdt_rec_reint */
1548         __u32           rr_padding_3; /* also fix lustre_swab_mdt_rec_reint */
1549         __u32           rr_padding_4; /* also fix lustre_swab_mdt_rec_reint */
1550 };
1551
1552 extern void lustre_swab_mdt_rec_reint(struct mdt_rec_reint *rr);
1553
1554 struct lmv_desc {
1555         __u32 ld_tgt_count;                /* how many MDS's */
1556         __u32 ld_active_tgt_count;         /* how many active */
1557         struct obd_uuid ld_uuid;
1558 };
1559
1560 extern void lustre_swab_lmv_desc (struct lmv_desc *ld);
1561
1562 struct md_fld {
1563         seqno_t mf_seq;
1564         mdsno_t mf_mds;
1565 };
1566
1567 extern void lustre_swab_md_fld (struct md_fld *mf);
1568
1569 enum fld_rpc_opc {
1570         FLD_QUERY                       = 600,
1571         FLD_LAST_OPC,
1572         FLD_FIRST_OPC                   = FLD_QUERY
1573 };
1574
1575 enum seq_rpc_opc {
1576         SEQ_QUERY                       = 700,
1577         SEQ_LAST_OPC,
1578         SEQ_FIRST_OPC                   = SEQ_QUERY
1579 };
1580
1581 enum seq_op {
1582         SEQ_ALLOC_SUPER = 0,
1583         SEQ_ALLOC_META = 1
1584 };
1585
1586 /*
1587  *  LOV data structures
1588  */
1589
1590 #define LOV_MIN_STRIPE_SIZE 65536   /* maximum PAGE_SIZE (ia64), power of 2 */
1591 #define LOV_MAX_STRIPE_COUNT  160   /* until bug 4424 is fixed */
1592 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
1593
1594 #define LOV_MAX_UUID_BUFFER_SIZE  8192
1595 /* The size of the buffer the lov/mdc reserves for the
1596  * array of UUIDs returned by the MDS.  With the current
1597  * protocol, this will limit the max number of OSTs per LOV */
1598
1599 #define LOV_DESC_MAGIC 0xB0CCDE5C
1600
1601 /* LOV settings descriptor (should only contain static info) */
1602 struct lov_desc {
1603         __u32 ld_tgt_count;                /* how many OBD's */
1604         __u32 ld_active_tgt_count;         /* how many active */
1605         __u32 ld_default_stripe_count;     /* how many objects are used */
1606         __u32 ld_pattern;                  /* default PATTERN_RAID0 */
1607         __u64 ld_default_stripe_size;      /* in bytes */
1608         __u64 ld_default_stripe_offset;    /* in bytes */
1609         __u32 ld_padding_0;                /* unused */
1610         __u32 ld_qos_maxage;               /* in second */
1611         __u32 ld_padding_1;                /* also fix lustre_swab_lov_desc */
1612         __u32 ld_padding_2;                /* also fix lustre_swab_lov_desc */
1613         struct obd_uuid ld_uuid;
1614 };
1615
1616 #define ld_magic ld_active_tgt_count       /* for swabbing from llogs */
1617
1618 extern void lustre_swab_lov_desc (struct lov_desc *ld);
1619
1620 /*
1621  *   LDLM requests:
1622  */
1623 /* opcodes -- MUST be distinct from OST/MDS opcodes */
1624 typedef enum {
1625         LDLM_ENQUEUE     = 101,
1626         LDLM_CONVERT     = 102,
1627         LDLM_CANCEL      = 103,
1628         LDLM_BL_CALLBACK = 104,
1629         LDLM_CP_CALLBACK = 105,
1630         LDLM_GL_CALLBACK = 106,
1631         LDLM_LAST_OPC
1632 } ldlm_cmd_t;
1633 #define LDLM_FIRST_OPC LDLM_ENQUEUE
1634
1635 #define RES_NAME_SIZE 4
1636 struct ldlm_res_id {
1637         __u64 name[RES_NAME_SIZE];
1638 };
1639
1640 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
1641
1642 /* lock types */
1643 typedef enum {
1644         LCK_MINMODE = 0,
1645         LCK_EX      = 1,
1646         LCK_PW      = 2,
1647         LCK_PR      = 4,
1648         LCK_CW      = 8,
1649         LCK_CR      = 16,
1650         LCK_NL      = 32,
1651         LCK_GROUP   = 64,
1652         LCK_MAXMODE
1653 } ldlm_mode_t;
1654
1655 #define LCK_MODE_NUM    7
1656
1657 typedef enum {
1658         LDLM_PLAIN     = 10,
1659         LDLM_EXTENT    = 11,
1660         LDLM_FLOCK     = 12,
1661         LDLM_IBITS     = 13,
1662         LDLM_MAX_TYPE
1663 } ldlm_type_t;
1664
1665 #define LDLM_MIN_TYPE LDLM_PLAIN
1666
1667 struct ldlm_extent {
1668         __u64 start;
1669         __u64 end;
1670         __u64 gid;
1671 };
1672
1673 static inline int ldlm_extent_overlap(struct ldlm_extent *ex1,
1674                                       struct ldlm_extent *ex2)
1675 {
1676         return (ex1->start <= ex2->end) && (ex2->start <= ex1->end);
1677 }
1678
1679 struct ldlm_inodebits {
1680         __u64 bits;
1681 };
1682
1683 struct ldlm_flock {
1684         __u64 start;
1685         __u64 end;
1686         __u64 blocking_export;  /* not actually used over the wire */
1687         __u32 blocking_pid;     /* not actually used over the wire */
1688         __u32 pid;
1689 };
1690
1691 /* it's important that the fields of the ldlm_extent structure match
1692  * the first fields of the ldlm_flock structure because there is only
1693  * one ldlm_swab routine to process the ldlm_policy_data_t union. if
1694  * this ever changes we will need to swab the union differently based
1695  * on the resource type. */
1696
1697 typedef union {
1698         struct ldlm_extent l_extent;
1699         struct ldlm_flock  l_flock;
1700         struct ldlm_inodebits l_inodebits;
1701 } ldlm_policy_data_t;
1702
1703 extern void lustre_swab_ldlm_policy_data (ldlm_policy_data_t *d);
1704
1705 struct ldlm_intent {
1706         __u64 opc;
1707 };
1708
1709 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
1710
1711 struct ldlm_resource_desc {
1712         ldlm_type_t lr_type;
1713         __u32 lr_padding;       /* also fix lustre_swab_ldlm_resource_desc */
1714         struct ldlm_res_id lr_name;
1715 };
1716
1717 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
1718
1719 struct ldlm_lock_desc {
1720         struct ldlm_resource_desc l_resource;
1721         ldlm_mode_t l_req_mode;
1722         ldlm_mode_t l_granted_mode;
1723         ldlm_policy_data_t l_policy_data;
1724 };
1725
1726 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
1727
1728 #define LDLM_LOCKREQ_HANDLES 2
1729 #define LDLM_ENQUEUE_CANCEL_OFF 1
1730
1731 struct ldlm_request {
1732         __u32 lock_flags;
1733         __u32 lock_count;
1734         struct ldlm_lock_desc lock_desc;
1735         struct lustre_handle lock_handle[LDLM_LOCKREQ_HANDLES];
1736 };
1737
1738 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
1739
1740 /* If LDLM_ENQUEUE, 1 slot is already occupied, 1 is available.
1741  * Otherwise, 2 are available. */
1742 #define ldlm_request_bufsize(count,type)                                \
1743 ({                                                                      \
1744         int _avail = LDLM_LOCKREQ_HANDLES;                              \
1745         _avail -= (type == LDLM_ENQUEUE ? LDLM_ENQUEUE_CANCEL_OFF : 0); \
1746         sizeof(struct ldlm_request) +                                   \
1747         (count > _avail ? count - _avail : 0) *                         \
1748         sizeof(struct lustre_handle);                                   \
1749 })
1750
1751 struct ldlm_reply {
1752         __u32 lock_flags;
1753         __u32 lock_padding;     /* also fix lustre_swab_ldlm_reply */
1754         struct ldlm_lock_desc lock_desc;
1755         struct lustre_handle lock_handle;
1756         __u64  lock_policy_res1;
1757         __u64  lock_policy_res2;
1758 };
1759
1760 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
1761
1762 /*
1763  * Opcodes for mountconf (mgs and mgc)
1764  */
1765 typedef enum {
1766         MGS_CONNECT = 250,
1767         MGS_DISCONNECT,
1768         MGS_EXCEPTION,         /* node died, etc. */
1769         MGS_TARGET_REG,        /* whenever target starts up */
1770         MGS_TARGET_DEL,
1771         MGS_SET_INFO,
1772         MGS_LAST_OPC
1773 } mgs_cmd_t;
1774 #define MGS_FIRST_OPC MGS_CONNECT
1775
1776 #define MGS_PARAM_MAXLEN 1024
1777 #define KEY_SET_INFO "set_info"
1778
1779 struct mgs_send_param {
1780         char             mgs_param[MGS_PARAM_MAXLEN];
1781 };
1782
1783 /* We pass this info to the MGS so it can write config logs */
1784 #define MTI_NAME_MAXLEN 64
1785 #define MTI_PARAM_MAXLEN 4096
1786 #define MTI_NIDS_MAX 32
1787 struct mgs_target_info {
1788         __u32            mti_lustre_ver;
1789         __u32            mti_stripe_index;
1790         __u32            mti_config_ver;
1791         __u32            mti_flags;
1792         __u32            mti_nid_count;
1793         __u32            padding;                    /* 64 bit align */
1794         char             mti_fsname[MTI_NAME_MAXLEN];
1795         char             mti_svname[MTI_NAME_MAXLEN];
1796         char             mti_uuid[sizeof(struct obd_uuid)];
1797         __u64            mti_nids[MTI_NIDS_MAX];     /* host nids (lnet_nid_t)*/
1798         char             mti_params[MTI_PARAM_MAXLEN];
1799 };
1800
1801 extern void lustre_swab_mgs_target_info(struct mgs_target_info *oinfo);
1802
1803 /* Config marker flags (in config log) */
1804 #define CM_START       0x01
1805 #define CM_END         0x02
1806 #define CM_SKIP        0x04
1807 #define CM_UPGRADE146  0x08
1808 #define CM_EXCLUDE     0x10
1809 #define CM_START_SKIP (CM_START | CM_SKIP)
1810
1811 struct cfg_marker {
1812         __u32             cm_step;       /* aka config version */
1813         __u32             cm_flags;
1814         __u32             cm_vers;       /* lustre release version number */
1815         __u32             padding;       /* 64 bit align */
1816         time_t            cm_createtime; /*when this record was first created */
1817         time_t            cm_canceltime; /*when this record is no longer valid*/
1818         char              cm_tgtname[MTI_NAME_MAXLEN];
1819         char              cm_comment[MTI_NAME_MAXLEN];
1820 };
1821
1822 /*
1823  * Opcodes for multiple servers.
1824  */
1825
1826 typedef enum {
1827         OBD_PING = 400,
1828         OBD_LOG_CANCEL,
1829         OBD_QC_CALLBACK,
1830         OBD_LAST_OPC
1831 } obd_cmd_t;
1832 #define OBD_FIRST_OPC OBD_PING
1833
1834 /* catalog of log objects */
1835
1836 /* Identifier for a single log object */
1837 struct llog_logid {
1838         __u64                   lgl_oid;
1839         __u64                   lgl_ogr;
1840         __u32                   lgl_ogen;
1841 } __attribute__((packed));
1842
1843 /* Records written to the CATALOGS list */
1844 #define CATLIST "CATALOGS"
1845 struct llog_catid {
1846         struct llog_logid       lci_logid;
1847         __u32                   lci_padding1;
1848         __u32                   lci_padding2;
1849         __u32                   lci_padding3;
1850 } __attribute__((packed));
1851
1852 /*join file lov mds md*/
1853 struct lov_mds_md_join {
1854         struct lov_mds_md lmmj_md;
1855         /*join private info*/
1856         struct llog_logid lmmj_array_id; /*array object id*/
1857         __u32  lmmj_extent_count;        /*array extent count*/
1858 };
1859
1860 /* Log data record types - there is no specific reason that these need to
1861  * be related to the RPC opcodes, but no reason not to (may be handy later?)
1862  */
1863 #define LLOG_OP_MAGIC 0x10600000
1864 #define LLOG_OP_MASK  0xfff00000
1865
1866 typedef enum {
1867         LLOG_PAD_MAGIC   = LLOG_OP_MAGIC | 0x00000,
1868         OST_SZ_REC       = LLOG_OP_MAGIC | 0x00f00,
1869         OST_RAID1_REC    = LLOG_OP_MAGIC | 0x01000,
1870         MDS_UNLINK_REC   = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) | REINT_UNLINK,
1871         MDS_SETATTR_REC  = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) | REINT_SETATTR,
1872         OBD_CFG_REC      = LLOG_OP_MAGIC | 0x20000,
1873         PTL_CFG_REC      = LLOG_OP_MAGIC | 0x30000, /* obsolete */
1874         LLOG_GEN_REC     = LLOG_OP_MAGIC | 0x40000,
1875         LLOG_JOIN_REC    = LLOG_OP_MAGIC | 0x50000,
1876         LLOG_HDR_MAGIC   = LLOG_OP_MAGIC | 0x45539,
1877         LLOG_LOGID_MAGIC = LLOG_OP_MAGIC | 0x4553b,
1878 } llog_op_type;
1879
1880 /*
1881  * for now, continue to support old pad records which have 0 for their
1882  * type but still need to be swabbed for their length
1883  */
1884 #define LLOG_REC_HDR_NEEDS_SWABBING(r)                                  \
1885         (((r)->lrh_type & __swab32(LLOG_OP_MASK)) ==                    \
1886          __swab32(LLOG_OP_MAGIC) ||                                     \
1887          (((r)->lrh_type == 0) && ((r)->lrh_len > LLOG_CHUNK_SIZE)))
1888
1889 /* Log record header - stored in little endian order.
1890  * Each record must start with this struct, end with a llog_rec_tail,
1891  * and be a multiple of 256 bits in size.
1892  */
1893 struct llog_rec_hdr {
1894         __u32                   lrh_len;
1895         __u32                   lrh_index;
1896         __u32                   lrh_type;
1897         __u32                   padding;
1898 };
1899
1900 struct llog_rec_tail {
1901         __u32 lrt_len;
1902         __u32 lrt_index;
1903 };
1904
1905 struct llog_logid_rec {
1906         struct llog_rec_hdr     lid_hdr;
1907         struct llog_logid       lid_id;
1908         __u32                   padding1;
1909         __u32                   padding2;
1910         __u32                   padding3;
1911         __u32                   padding4;
1912         __u32                   padding5;
1913         struct llog_rec_tail    lid_tail;
1914 } __attribute__((packed));
1915
1916 /* MDS extent description
1917  * It is for joined file extent info, each extent info for joined file
1918  * just like (start, end, lmm).
1919  */
1920 struct mds_extent_desc {
1921         __u64                   med_start; /* extent start */
1922         __u64                   med_len;   /* extent length */
1923         struct lov_mds_md       med_lmm;   /* extent's lmm  */
1924 };
1925 /*Joined file array extent log record*/
1926 struct llog_array_rec {
1927         struct llog_rec_hdr     lmr_hdr;
1928         struct mds_extent_desc  lmr_med;
1929         struct llog_rec_tail    lmr_tail;
1930 };
1931
1932 struct llog_create_rec {
1933         struct llog_rec_hdr     lcr_hdr;
1934         struct ll_fid           lcr_fid;
1935         obd_id                  lcr_oid;
1936         obd_count               lcr_ogen;
1937         __u32                   padding;
1938         struct llog_rec_tail    lcr_tail;
1939 } __attribute__((packed));
1940
1941 struct llog_orphan_rec {
1942         struct llog_rec_hdr     lor_hdr;
1943         obd_id                  lor_oid;
1944         obd_count               lor_ogen;
1945         __u32                   padding;
1946         struct llog_rec_tail    lor_tail;
1947 } __attribute__((packed));
1948
1949 struct llog_unlink_rec {
1950         struct llog_rec_hdr     lur_hdr;
1951         obd_id                  lur_oid;
1952         obd_count               lur_ogen;
1953         __u32                   padding;
1954         struct llog_rec_tail    lur_tail;
1955 } __attribute__((packed));
1956
1957 struct llog_setattr_rec {
1958         struct llog_rec_hdr     lsr_hdr;
1959         obd_id                  lsr_oid;
1960         obd_count               lsr_ogen;
1961         __u32                   lsr_uid;
1962         __u32                   lsr_gid;
1963         __u32                   padding;
1964         struct llog_rec_tail    lsr_tail;
1965 } __attribute__((packed));
1966
1967 struct llog_size_change_rec {
1968         struct llog_rec_hdr     lsc_hdr;
1969         struct ll_fid           lsc_fid;
1970         __u32                   lsc_ioepoch;
1971         __u32                   padding;
1972         struct llog_rec_tail    lsc_tail;
1973 } __attribute__((packed));
1974
1975 struct llog_gen {
1976         __u64 mnt_cnt;
1977         __u64 conn_cnt;
1978 } __attribute__((packed));
1979
1980 struct llog_gen_rec {
1981         struct llog_rec_hdr     lgr_hdr;
1982         struct llog_gen         lgr_gen;
1983         struct llog_rec_tail    lgr_tail;
1984 };
1985 /* On-disk header structure of each log object, stored in little endian order */
1986 #define LLOG_CHUNK_SIZE         8192
1987 #define LLOG_HEADER_SIZE        (96)
1988 #define LLOG_BITMAP_BYTES       (LLOG_CHUNK_SIZE - LLOG_HEADER_SIZE)
1989
1990 #define LLOG_MIN_REC_SIZE       (24) /* round(llog_rec_hdr + llog_rec_tail) */
1991
1992 /* flags for the logs */
1993 #define LLOG_F_ZAP_WHEN_EMPTY   0x1
1994 #define LLOG_F_IS_CAT           0x2
1995 #define LLOG_F_IS_PLAIN         0x4
1996
1997 struct llog_log_hdr {
1998         struct llog_rec_hdr     llh_hdr;
1999         __u64                   llh_timestamp;
2000         __u32                   llh_count;
2001         __u32                   llh_bitmap_offset;
2002         __u32                   llh_size;
2003         __u32                   llh_flags;
2004         __u32                   llh_cat_idx;
2005         /* for a catalog the first plain slot is next to it */
2006         struct obd_uuid         llh_tgtuuid;
2007         __u32                   llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32) - 23];
2008         __u32                   llh_bitmap[LLOG_BITMAP_BYTES/sizeof(__u32)];
2009         struct llog_rec_tail    llh_tail;
2010 } __attribute__((packed));
2011
2012 #define LLOG_BITMAP_SIZE(llh)  ((llh->llh_hdr.lrh_len -         \
2013                                  llh->llh_bitmap_offset -       \
2014                                  sizeof(llh->llh_tail)) * 8)
2015
2016 /* log cookies are used to reference a specific log file and a record therein */
2017 struct llog_cookie {
2018         struct llog_logid       lgc_lgl;
2019         __u32                   lgc_subsys;
2020         __u32                   lgc_index;
2021         __u32                   lgc_padding;
2022 } __attribute__((packed));
2023
2024 /* llog protocol */
2025 enum llogd_rpc_ops {
2026         LLOG_ORIGIN_HANDLE_CREATE       = 501,
2027         LLOG_ORIGIN_HANDLE_NEXT_BLOCK   = 502,
2028         LLOG_ORIGIN_HANDLE_READ_HEADER  = 503,
2029         LLOG_ORIGIN_HANDLE_WRITE_REC    = 504,
2030         LLOG_ORIGIN_HANDLE_CLOSE        = 505,
2031         LLOG_ORIGIN_CONNECT             = 506,
2032         LLOG_CATINFO                    = 507,  /* for lfs catinfo */
2033         LLOG_ORIGIN_HANDLE_PREV_BLOCK   = 508,
2034         LLOG_ORIGIN_HANDLE_DESTROY      = 509,  /* for destroy llog object*/
2035         LLOG_LAST_OPC,
2036         LLOG_FIRST_OPC                  = LLOG_ORIGIN_HANDLE_CREATE
2037 };
2038
2039 struct llogd_body {
2040         struct llog_logid  lgd_logid;
2041         __u32 lgd_ctxt_idx;
2042         __u32 lgd_llh_flags;
2043         __u32 lgd_index;
2044         __u32 lgd_saved_index;
2045         __u32 lgd_len;
2046         __u64 lgd_cur_offset;
2047 } __attribute__((packed));
2048
2049 struct llogd_conn_body {
2050         struct llog_gen         lgdc_gen;
2051         struct llog_logid       lgdc_logid;
2052         __u32                   lgdc_ctxt_idx;
2053 } __attribute__((packed));
2054
2055 struct lov_user_ost_data_join {   /* per-stripe data structure */
2056         __u64 l_extent_start;     /* extent start*/
2057         __u64 l_extent_end;       /* extent end*/
2058         __u64 l_object_id;        /* OST object ID */
2059         __u64 l_object_gr;        /* OST object group (creating MDS number) */
2060         __u32 l_ost_gen;          /* generation of this OST index */
2061         __u32 l_ost_idx;          /* OST index in LOV */
2062 } __attribute__((packed));
2063
2064 struct lov_user_md_join {         /* LOV EA user data (host-endian) */
2065         __u32 lmm_magic;          /* magic number = LOV_MAGIC_JOIN */
2066         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
2067         __u64 lmm_object_id;      /* LOV object ID */
2068         __u64 lmm_object_gr;      /* LOV object group */
2069         __u32 lmm_stripe_size;    /* size of stripe in bytes */
2070         __u32 lmm_stripe_count;   /* num stripes in use for this object */
2071         __u32 lmm_extent_count;   /* extent count of lmm*/
2072         __u64 lmm_tree_id;        /* mds tree object id */
2073         __u64 lmm_tree_gen;       /* mds tree object gen */
2074         struct llog_logid lmm_array_id; /* mds extent desc llog object id */
2075         struct lov_user_ost_data_join lmm_objects[0]; /* per-stripe data */
2076 } __attribute__((packed));
2077
2078 extern void lustre_swab_lov_user_md(struct lov_user_md *lum);
2079 extern void lustre_swab_lov_user_md_objects(struct lov_user_md *lum);
2080 extern void lustre_swab_lov_user_md_join(struct lov_user_md_join *lumj);
2081
2082 /* llog_swab.c */
2083 extern void lustre_swab_llogd_body (struct llogd_body *d);
2084 extern void lustre_swab_llog_hdr (struct llog_log_hdr *h);
2085 extern void lustre_swab_llogd_conn_body (struct llogd_conn_body *d);
2086 extern void lustre_swab_llog_rec(struct llog_rec_hdr  *rec,
2087                                  struct llog_rec_tail *tail);
2088
2089 struct lustre_cfg;
2090 extern void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg);
2091
2092 /* quota. fixed by tianzy for bug10707 */
2093 #define QUOTA_IS_GRP   0X1UL  /* 0 is user, 1 is group. Used by qd_flags*/
2094 #define QUOTA_IS_BLOCK 0x2UL  /* 0 is inode, 1 is block. Used by qd_flags*/
2095
2096 struct qunit_data {
2097         __u32 qd_id; /* ID appiles to (uid, gid) */
2098         __u32 qd_flags; /* Quota type (USRQUOTA, GRPQUOTA) occupy one bit;
2099                          * Block quota or file quota occupy one bit */
2100         __u64 qd_count; /* acquire/release count (bytes for block quota) */
2101 };
2102
2103 struct qunit_data_old {
2104         __u32 qd_id;    /* ID appiles to (uid, gid) */
2105         __u32 qd_type;  /* Quota type (USRQUOTA, GRPQUOTA) */
2106         __u32 qd_count; /* acquire/release count (bytes for block quota) */
2107         __u32 qd_isblk; /* Block quota or file quota */
2108 };
2109
2110 extern void lustre_swab_qdata(struct qunit_data *d);
2111 extern void lustre_swab_qdata_old(struct qunit_data_old *d);
2112 extern struct qunit_data *lustre_quota_old_to_new(struct qunit_data_old *d);
2113 extern struct qunit_data_old *lustre_quota_new_to_old(struct qunit_data *d);
2114
2115 typedef enum {
2116         QUOTA_DQACQ     = 601,
2117         QUOTA_DQREL     = 602,
2118 } quota_cmd_t;
2119
2120 #define JOIN_FILE_ALIGN 4096
2121
2122 /* security opcodes */
2123 typedef enum {
2124         SEC_CTX_INIT            = 801,
2125         SEC_CTX_INIT_CONT       = 802,
2126         SEC_CTX_FINI            = 803,
2127         SEC_LAST_OPC,
2128         SEC_FIRST_OPC           = SEC_CTX_INIT
2129 } sec_cmd_t;
2130
2131 /*
2132  * capa related definitions
2133  */
2134 #define CAPA_HMAC_MAX_LEN       64
2135 #define CAPA_HMAC_KEY_MAX_LEN   56
2136
2137 /* NB take care when changing the sequence of elements this struct,
2138  * because the offset info is used in find_capa() */
2139 struct lustre_capa {
2140         struct lu_fid   lc_fid;     /* fid */
2141         __u64           lc_opc;     /* operations allowed */
2142         __u32           lc_uid;     /* uid, it is obsolete, but maybe used in
2143                                      * future, reserve it for 64-bits aligned.*/
2144         __u32           lc_flags;   /* HMAC algorithm & flags */
2145         __u32           lc_keyid;   /* key used for the capability */
2146         __u32           lc_timeout; /* capa timeout value (sec) */
2147         __u64           lc_expiry;  /* expiry time (sec) */
2148         __u8            lc_hmac[CAPA_HMAC_MAX_LEN];   /* HMAC */
2149 } __attribute__((packed));
2150
2151 extern void lustre_swab_lustre_capa(struct lustre_capa *c);
2152
2153 /* lustre_capa.lc_opc */
2154 enum {
2155         CAPA_OPC_BODY_WRITE   = 1<<0,  /* write object data */
2156         CAPA_OPC_BODY_READ    = 1<<1,  /* read object data */
2157         CAPA_OPC_INDEX_LOOKUP = 1<<2,  /* lookup object fid */
2158         CAPA_OPC_INDEX_INSERT = 1<<3,  /* insert object fid */
2159         CAPA_OPC_INDEX_DELETE = 1<<4,  /* delete object fid */
2160         CAPA_OPC_OSS_WRITE    = 1<<5,  /* write oss object data */
2161         CAPA_OPC_OSS_READ     = 1<<6,  /* read oss object data */
2162         CAPA_OPC_OSS_TRUNC    = 1<<7,  /* truncate oss object */
2163         CAPA_OPC_META_WRITE   = 1<<8,  /* write object meta data */
2164         CAPA_OPC_META_READ    = 1<<9,  /* read object meta data */
2165
2166 };
2167
2168 #define CAPA_OPC_OSS_RW (CAPA_OPC_OSS_READ | CAPA_OPC_OSS_WRITE)
2169 #define CAPA_OPC_MDS_ONLY                                                   \
2170         (CAPA_OPC_BODY_WRITE | CAPA_OPC_BODY_READ | CAPA_OPC_INDEX_LOOKUP | \
2171          CAPA_OPC_INDEX_INSERT | CAPA_OPC_INDEX_DELETE)
2172 #define CAPA_OPC_OSS_ONLY                                                   \
2173         (CAPA_OPC_OSS_WRITE | CAPA_OPC_OSS_READ | CAPA_OPC_OSS_TRUNC)
2174 #define CAPA_OPC_MDS_DEFAULT ~CAPA_OPC_OSS_ONLY
2175 #define CAPA_OPC_OSS_DEFAULT ~(CAPA_OPC_MDS_ONLY | CAPA_OPC_OSS_ONLY)
2176
2177 /* MDS capability covers object capability for operations of body r/w
2178  * (dir readpage/sendpage), index lookup/insert/delete and meta data r/w,
2179  * while OSS capability only covers object capability for operations of
2180  * oss data(file content) r/w/truncate.
2181  */
2182 static inline int capa_for_mds(struct lustre_capa *c)
2183 {
2184         return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) != 0;
2185 }
2186
2187 static inline int capa_for_oss(struct lustre_capa *c)
2188 {
2189         return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) == 0;
2190 }
2191
2192 /* lustre_capa.lc_hmac_alg */
2193 enum {
2194         CAPA_HMAC_ALG_SHA1 = 1, /* sha1 algorithm */
2195         CAPA_HMAC_ALG_MAX,
2196 };
2197
2198 #define CAPA_FL_MASK            0x00ffffff
2199 #define CAPA_HMAC_ALG_MASK      0xff000000
2200
2201 struct lustre_capa_key {
2202         __u64   lk_mdsid;     /* mds# */
2203         __u32   lk_keyid;     /* key# */
2204         __u32   lk_padding;
2205         __u8    lk_key[CAPA_HMAC_KEY_MAX_LEN];    /* key */
2206 } __attribute__((packed));
2207
2208 extern void lustre_swab_lustre_capa_key(struct lustre_capa_key *k);
2209
2210 /* quota check function */
2211 #define QUOTA_RET_OK           0 /* return successfully */
2212 #define QUOTA_RET_NOQUOTA      1 /* not support quota */
2213 #define QUOTA_RET_NOLIMIT      2 /* quota limit isn't set */
2214 #define QUOTA_RET_ACQUOTA      3 /* need to acquire extra quota */
2215 #endif