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