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