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